docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Assembly Language Reference Manual</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   7   <meta name="author" content="Chris Lattner">
   8   <meta name="description"
   9   content="LLVM Assembly Language Reference Manual.">
  10   <link rel="stylesheet" href="llvm.css" type="text/css">
  11 </head>
  12
  13 <body>
  14
  15 <div class="doc_title"> LLVM Language Reference Manual </div>
  16 <ol>
  17   <li><a href="#abstract">Abstract</a></li>
  18   <li><a href="#introduction">Introduction</a></li>
  19   <li><a href="#identifiers">Identifiers</a></li>
  20   <li><a href="#highlevel">High Level Structure</a>
  21     <ol>
  22       <li><a href="#modulestructure">Module Structure</a></li>
  23       <li><a href="#linkage">Linkage Types</a>
  24         <ol>
  25           <li><a href="#linkage_private">'<tt>private</tt>' Linkage</a></li>
  26           <li><a href="#linkage_linker_private">'<tt>linker_private</tt>' Linkage</a></li>
  27           <li><a href="#linkage_linker_private_weak">'<tt>linker_private_weak</tt>' Linkage</a></li>
  28           <li><a href="#linkage_linker_private_weak_def_auto">'<tt>linker_private_weak_def_auto</tt>' Linkage</a></li>
  29           <li><a href="#linkage_internal">'<tt>internal</tt>' Linkage</a></li>
  30           <li><a href="#linkage_available_externally">'<tt>available_externally</tt>' Linkage</a></li>
  31           <li><a href="#linkage_linkonce">'<tt>linkonce</tt>' Linkage</a></li>
  32           <li><a href="#linkage_common">'<tt>common</tt>' Linkage</a></li>
  33           <li><a href="#linkage_weak">'<tt>weak</tt>' Linkage</a></li>
  34           <li><a href="#linkage_appending">'<tt>appending</tt>' Linkage</a></li>
  35           <li><a href="#linkage_externweak">'<tt>extern_weak</tt>' Linkage</a></li>
  36           <li><a href="#linkage_linkonce_odr">'<tt>linkonce_odr</tt>' Linkage</a></li>
  37           <li><a href="#linkage_weak">'<tt>weak_odr</tt>' Linkage</a></li>
  38           <li><a href="#linkage_external">'<tt>externally visible</tt>' Linkage</a></li>
  39           <li><a href="#linkage_dllimport">'<tt>dllimport</tt>' Linkage</a></li>
  40           <li><a href="#linkage_dllexport">'<tt>dllexport</tt>' Linkage</a></li>
  41         </ol>
  42       </li>
  43       <li><a href="#callingconv">Calling Conventions</a></li>
  44       <li><a href="#namedtypes">Named Types</a></li>
  45       <li><a href="#globalvars">Global Variables</a></li>
  46       <li><a href="#functionstructure">Functions</a></li>
  47       <li><a href="#aliasstructure">Aliases</a></li>
  48       <li><a href="#namedmetadatastructure">Named Metadata</a></li>
  49       <li><a href="#paramattrs">Parameter Attributes</a></li>
  50       <li><a href="#fnattrs">Function Attributes</a></li>
  51       <li><a href="#gc">Garbage Collector Names</a></li>
  52       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  53       <li><a href="#datalayout">Data Layout</a></li>
  54       <li><a href="#pointeraliasing">Pointer Aliasing Rules</a></li>
  55       <li><a href="#volatile">Volatile Memory Accesses</a></li>
  56     </ol>
  57   </li>
  58   <li><a href="#typesystem">Type System</a>
  59     <ol>
  60       <li><a href="#t_classifications">Type Classifications</a></li>
  61       <li><a href="#t_primitive">Primitive Types</a>
  62         <ol>
  63           <li><a href="#t_integer">Integer Type</a></li>
  64           <li><a href="#t_floating">Floating Point Types</a></li>
  65           <li><a href="#t_x86mmx">X86mmx Type</a></li>
  66           <li><a href="#t_void">Void Type</a></li>
  67           <li><a href="#t_label">Label Type</a></li>
  68           <li><a href="#t_metadata">Metadata Type</a></li>
  69         </ol>
  70       </li>
  71       <li><a href="#t_derived">Derived Types</a>
  72         <ol>
  73           <li><a href="#t_aggregate">Aggregate Types</a>
  74             <ol>
  75               <li><a href="#t_array">Array Type</a></li>
  76               <li><a href="#t_struct">Structure Type</a></li>
  77               <li><a href="#t_pstruct">Packed Structure Type</a></li>
  78               <li><a href="#t_vector">Vector Type</a></li>
  79             </ol>
  80           </li>
  81           <li><a href="#t_function">Function Type</a></li>
  82           <li><a href="#t_pointer">Pointer Type</a></li>
  83           <li><a href="#t_opaque">Opaque Type</a></li>
  84         </ol>
  85       </li>
  86       <li><a href="#t_uprefs">Type Up-references</a></li>
  87     </ol>
  88   </li>
  89   <li><a href="#constants">Constants</a>
  90     <ol>
  91       <li><a href="#simpleconstants">Simple Constants</a></li>
  92       <li><a href="#complexconstants">Complex Constants</a></li>
  93       <li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
  94       <li><a href="#undefvalues">Undefined Values</a></li>
  95       <li><a href="#trapvalues">Trap Values</a></li>
  96       <li><a href="#blockaddress">Addresses of Basic Blocks</a></li>
  97       <li><a href="#constantexprs">Constant Expressions</a></li>
  98     </ol>
  99   </li>
 100   <li><a href="#othervalues">Other Values</a>
 101     <ol>
 102       <li><a href="#inlineasm">Inline Assembler Expressions</a></li>
 103       <li><a href="#metadata">Metadata Nodes and Metadata Strings</a></li>
 104     </ol>
 105   </li>
 106   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 107     <ol>
 108       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 109       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 110           Global Variable</a></li>
 111       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 112          Global Variable</a></li>
 113       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 114          Global Variable</a></li>
 115     </ol>
 116   </li>
 117   <li><a href="#instref">Instruction Reference</a>
 118     <ol>
 119       <li><a href="#terminators">Terminator Instructions</a>
 120         <ol>
 121           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 122           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 123           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 124           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 125           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 126           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
 127           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 128         </ol>
 129       </li>
 130       <li><a href="#binaryops">Binary Operations</a>
 131         <ol>
 132           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 133           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 134           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 135           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 136           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 137           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 138           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 139           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 140           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 141           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 142           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 143           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 144         </ol>
 145       </li>
 146       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 147         <ol>
 148           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 149           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 150           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 151           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 152           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 153           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 154         </ol>
 155       </li>
 156       <li><a href="#vectorops">Vector Operations</a>
 157         <ol>
 158           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 159           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 160           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 161         </ol>
 162       </li>
 163       <li><a href="#aggregateops">Aggregate Operations</a>
 164         <ol>
 165           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 166           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 167         </ol>
 168       </li>
 169       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 170         <ol>
 171           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
 172          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 173          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 174          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 175         </ol>
 176       </li>
 177       <li><a href="#convertops">Conversion Operations</a>
 178         <ol>
 179           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 180           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 181           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 182           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 183           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 184           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 185           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 186           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 187           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 188           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 191         </ol>
 192       </li>
 193       <li><a href="#otherops">Other Operations</a>
 194         <ol>
 195           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 196           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 197           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 198           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 199           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 200           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 201         </ol>
 202       </li>
 203     </ol>
 204   </li>
 205   <li><a href="#intrinsics">Intrinsic Functions</a>
 206     <ol>
 207       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 208         <ol>
 209           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 210           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 211           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 212         </ol>
 213       </li>
 214       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 215         <ol>
 216           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 217           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 218           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 219         </ol>
 220       </li>
 221       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 222         <ol>
 223           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 224           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 225           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 226           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 227           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 228           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 229           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 230         </ol>
 231       </li>
 232       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 233         <ol>
 234           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 235           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 236           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 237           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 238           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 239           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 240           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 241           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 242         </ol>
 243       </li>
 244       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 245         <ol>
 246           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 247           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 248           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 249           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 250         </ol>
 251       </li>
 252       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 253         <ol>
 254           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 255           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 256           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 257           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 258           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 259           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 260         </ol>
 261       </li>
 262       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 263         <ol>
 264           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 265           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 266         </ol>
 267       </li>
 268       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 269       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 270       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 271         <ol>
 272           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 273         </ol>
 274       </li>
 275       <li><a href="#int_atomics">Atomic intrinsics</a>
 276         <ol>
 277           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 278           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 279           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 280           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 281           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 282           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 283           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 284           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 285           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 286           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 287           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 288           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 289           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 290         </ol>
 291       </li>
 292       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 293         <ol>
 294           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 295           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 296           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 297           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_general">General intrinsics</a>
 301         <ol>
 302           <li><a href="#int_var_annotation">
 303             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 304           <li><a href="#int_annotation">
 305             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 306           <li><a href="#int_trap">
 307             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 308           <li><a href="#int_stackprotector">
 309             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 310           <li><a href="#int_objectsize">
 311             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 312         </ol>
 313       </li>
 314     </ol>
 315   </li>
 316 </ol>
 317
 318 <div class="doc_author">
 319   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 320             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 321 </div>
 322
 323 <!-- *********************************************************************** -->
 324 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 325 <!-- *********************************************************************** -->
 326
 327 <div class="doc_text">
 328
 329 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 330    a Static Single Assignment (SSA) based representation that provides type
 331    safety, low-level operations, flexibility, and the capability of representing
 332    'all' high-level languages cleanly.  It is the common code representation
 333    used throughout all phases of the LLVM compilation strategy.</p>
 334
 335 </div>
 336
 337 <!-- *********************************************************************** -->
 338 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 339 <!-- *********************************************************************** -->
 340
 341 <div class="doc_text">
 342
 343 <p>The LLVM code representation is designed to be used in three different forms:
 344    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 345    for fast loading by a Just-In-Time compiler), and as a human readable
 346    assembly language representation.  This allows LLVM to provide a powerful
 347    intermediate representation for efficient compiler transformations and
 348    analysis, while providing a natural means to debug and visualize the
 349    transformations.  The three different forms of LLVM are all equivalent.  This
 350    document describes the human readable representation and notation.</p>
 351
 352 <p>The LLVM representation aims to be light-weight and low-level while being
 353    expressive, typed, and extensible at the same time.  It aims to be a
 354    "universal IR" of sorts, by being at a low enough level that high-level ideas
 355    may be cleanly mapped to it (similar to how microprocessors are "universal
 356    IR's", allowing many source languages to be mapped to them).  By providing
 357    type information, LLVM can be used as the target of optimizations: for
 358    example, through pointer analysis, it can be proven that a C automatic
 359    variable is never accessed outside of the current function, allowing it to
 360    be promoted to a simple SSA value instead of a memory location.</p>
 361
 362 </div>
 363
 364 <!-- _______________________________________________________________________ -->
 365 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 366
 367 <div class="doc_text">
 368
 369 <p>It is important to note that this document describes 'well formed' LLVM
 370    assembly language.  There is a difference between what the parser accepts and
 371    what is considered 'well formed'.  For example, the following instruction is
 372    syntactically okay, but not well formed:</p>
 373
 374 <pre class="doc_code">
 375 %x = <a href="#i_add">add</a> i32 1, %x
 376 </pre>
 377
 378 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 379    LLVM infrastructure provides a verification pass that may be used to verify
 380    that an LLVM module is well formed.  This pass is automatically run by the
 381    parser after parsing input assembly and by the optimizer before it outputs
 382    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 383    transformation passes or input to the parser.</p>
 384
 385 </div>
 386
 387 <!-- Describe the typesetting conventions here. -->
 388
 389 <!-- *********************************************************************** -->
 390 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 391 <!-- *********************************************************************** -->
 392
 393 <div class="doc_text">
 394
 395 <p>LLVM identifiers come in two basic types: global and local. Global
 396    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 397    character. Local identifiers (register names, types) begin with
 398    the <tt>'%'</tt> character. Additionally, there are three different formats
 399    for identifiers, for different purposes:</p>
 400
 401 <ol>
 402   <li>Named values are represented as a string of characters with their prefix.
 403       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 404       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 405       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 406       other characters in their names can be surrounded with quotes. Special
 407       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 408       ASCII code for the character in hexadecimal.  In this way, any character
 409       can be used in a name value, even quotes themselves.</li>
 410
 411   <li>Unnamed values are represented as an unsigned numeric value with their
 412       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 413
 414   <li>Constants, which are described in a <a href="#constants">section about
 415       constants</a>, below.</li>
 416 </ol>
 417
 418 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 419    don't need to worry about name clashes with reserved words, and the set of
 420    reserved words may be expanded in the future without penalty.  Additionally,
 421    unnamed identifiers allow a compiler to quickly come up with a temporary
 422    variable without having to avoid symbol table conflicts.</p>
 423
 424 <p>Reserved words in LLVM are very similar to reserved words in other
 425    languages. There are keywords for different opcodes
 426    ('<tt><a href="#i_add">add</a></tt>',
 427    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 428    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 429    ('<tt><a href="#t_void">void</a></tt>',
 430    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 431    reserved words cannot conflict with variable names, because none of them
 432    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 433
 434 <p>Here is an example of LLVM code to multiply the integer variable
 435    '<tt>%X</tt>' by 8:</p>
 436
 437 <p>The easy way:</p>
 438
 439 <pre class="doc_code">
 440 %result = <a href="#i_mul">mul</a> i32 %X, 8
 441 </pre>
 442
 443 <p>After strength reduction:</p>
 444
 445 <pre class="doc_code">
 446 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 447 </pre>
 448
 449 <p>And the hard way:</p>
 450
 451 <pre class="doc_code">
 452 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 453 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 454 %result = <a href="#i_add">add</a> i32 %1, %1
 455 </pre>
 456
 457 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 458    lexical features of LLVM:</p>
 459
 460 <ol>
 461   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 462       line.</li>
 463
 464   <li>Unnamed temporaries are created when the result of a computation is not
 465       assigned to a named value.</li>
 466
 467   <li>Unnamed temporaries are numbered sequentially</li>
 468 </ol>
 469
 470 <p>It also shows a convention that we follow in this document.  When
 471    demonstrating instructions, we will follow an instruction with a comment that
 472    defines the type and name of value produced.  Comments are shown in italic
 473    text.</p>
 474
 475 </div>
 476
 477 <!-- *********************************************************************** -->
 478 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 479 <!-- *********************************************************************** -->
 480
 481 <!-- ======================================================================= -->
 482 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 483 </div>
 484
 485 <div class="doc_text">
 486
 487 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 488    of the input programs.  Each module consists of functions, global variables,
 489    and symbol table entries.  Modules may be combined together with the LLVM
 490    linker, which merges function (and global variable) definitions, resolves
 491    forward declarations, and merges symbol table entries. Here is an example of
 492    the "hello world" module:</p>
 493
 494 <pre class="doc_code">
 495 <i>; Declare the string constant as a global constant.</i>&nbsp;
 496 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"      <i>; [13 x i8]*</i>&nbsp;
 497
 498 <i>; External declaration of the puts function</i>&nbsp;
 499 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 500
 501 <i>; Definition of main function</i>
 502 define i32 @main() {   <i>; i32()* </i>&nbsp;
 503   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 504   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 505
 506   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 507   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 508   <a href="#i_ret">ret</a> i32 0&nbsp;
 509 }
 510
 511 <i>; Named metadata</i>
 512 !1 = metadata !{i32 41}
 513 !foo = !{!1, null}
 514 </pre>
 515
 516 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 517    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 518    a <a href="#functionstructure">function definition</a> for
 519    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 520    "<tt>foo"</tt>.</p>
 521
 522 <p>In general, a module is made up of a list of global values, where both
 523    functions and global variables are global values.  Global values are
 524    represented by a pointer to a memory location (in this case, a pointer to an
 525    array of char, and a pointer to a function), and have one of the
 526    following <a href="#linkage">linkage types</a>.</p>
 527
 528 </div>
 529
 530 <!-- ======================================================================= -->
 531 <div class="doc_subsection">
 532   <a name="linkage">Linkage Types</a>
 533 </div>
 534
 535 <div class="doc_text">
 536
 537 <p>All Global Variables and Functions have one of the following types of
 538    linkage:</p>
 539
 540 <dl>
 541   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 542   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 543       by objects in the current module. In particular, linking code into a
 544       module with an private global value may cause the private to be renamed as
 545       necessary to avoid collisions.  Because the symbol is private to the
 546       module, all references can be updated. This doesn't show up in any symbol
 547       table in the object file.</dd>
 548
 549   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 550   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 551       assembler and evaluated by the linker. Unlike normal strong symbols, they
 552       are removed by the linker from the final linked image (executable or
 553       dynamic library).</dd>
 554
 555   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 556   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 557       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 558       linker. The symbols are removed by the linker from the final linked image
 559       (executable or dynamic library).</dd>
 560
 561   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 562   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 563       of the object is not taken. For instance, functions that had an inline
 564       definition, but the compiler decided not to inline it. Note,
 565       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 566       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 567       visibility.  The symbols are removed by the linker from the final linked
 568       image (executable or dynamic library).</dd>
 569
 570   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 571   <dd>Similar to private, but the value shows as a local symbol
 572       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 573       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 574
 575   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 576   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 577       into the object file corresponding to the LLVM module.  They exist to
 578       allow inlining and other optimizations to take place given knowledge of
 579       the definition of the global, which is known to be somewhere outside the
 580       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 581       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 582       This linkage type is only allowed on definitions, not declarations.</dd>
 583
 584   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 585   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 586       the same name when linkage occurs.  This can be used to implement
 587       some forms of inline functions, templates, or other code which must be
 588       generated in each translation unit that uses it, but where the body may
 589       be overridden with a more definitive definition later.  Unreferenced
 590       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 591       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 592       inline the body of this function into callers because it doesn't know if
 593       this definition of the function is the definitive definition within the
 594       program or whether it will be overridden by a stronger definition.
 595       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 596       linkage.</dd>
 597
 598   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 599   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 600       <tt>linkonce</tt> linkage, except that unreferenced globals with
 601       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 602       are declared "weak" in C source code.</dd>
 603
 604   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 605   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 606       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 607       global scope.
 608       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 609       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 610       <tt>common</tt> symbols may not have an explicit section,
 611       must have a zero initializer, and may not be marked '<a
 612       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 613       have common linkage.</dd>
 614
 615
 616   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 617   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 618       pointer to array type.  When two global variables with appending linkage
 619       are linked together, the two global arrays are appended together.  This is
 620       the LLVM, typesafe, equivalent of having the system linker append together
 621       "sections" with identical names when .o files are linked.</dd>
 622
 623   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 624   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 625       is weak until linked, if not linked, the symbol becomes null instead of
 626       being an undefined reference.</dd>
 627
 628   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 629   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 630   <dd>Some languages allow differing globals to be merged, such as two functions
 631       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 632       that only equivalent globals are ever merged (the "one definition rule"
 633       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 634       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 635       be merged with equivalent globals.  These linkage types are otherwise the
 636       same as their non-<tt>odr</tt> versions.</dd>
 637
 638   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 639   <dd>If none of the above identifiers are used, the global is externally
 640       visible, meaning that it participates in linkage and can be used to
 641       resolve external symbol references.</dd>
 642 </dl>
 643
 644 <p>The next two types of linkage are targeted for Microsoft Windows platform
 645    only. They are designed to support importing (exporting) symbols from (to)
 646    DLLs (Dynamic Link Libraries).</p>
 647
 648 <dl>
 649   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 650   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 651       or variable via a global pointer to a pointer that is set up by the DLL
 652       exporting the symbol. On Microsoft Windows targets, the pointer name is
 653       formed by combining <code>__imp_</code> and the function or variable
 654       name.</dd>
 655
 656   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 657   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 658       pointer to a pointer in a DLL, so that it can be referenced with the
 659       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 660       name is formed by combining <code>__imp_</code> and the function or
 661       variable name.</dd>
 662 </dl>
 663
 664 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 665    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 666    one, one of the two would be renamed, preventing a collision.  Since
 667    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 668    declarations), they are accessible outside of the current module.</p>
 669
 670 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 671    other than "externally visible", <tt>dllimport</tt>
 672    or <tt>extern_weak</tt>.</p>
 673
 674 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 675    or <tt>weak_odr</tt> linkages.</p>
 676
 677 </div>
 678
 679 <!-- ======================================================================= -->
 680 <div class="doc_subsection">
 681   <a name="callingconv">Calling Conventions</a>
 682 </div>
 683
 684 <div class="doc_text">
 685
 686 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 687    and <a href="#i_invoke">invokes</a> can all have an optional calling
 688    convention specified for the call.  The calling convention of any pair of
 689    dynamic caller/callee must match, or the behavior of the program is
 690    undefined.  The following calling conventions are supported by LLVM, and more
 691    may be added in the future:</p>
 692
 693 <dl>
 694   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 695   <dd>This calling convention (the default if no other calling convention is
 696       specified) matches the target C calling conventions.  This calling
 697       convention supports varargs function calls and tolerates some mismatch in
 698       the declared prototype and implemented declaration of the function (as
 699       does normal C).</dd>
 700
 701   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 702   <dd>This calling convention attempts to make calls as fast as possible
 703       (e.g. by passing things in registers).  This calling convention allows the
 704       target to use whatever tricks it wants to produce fast code for the
 705       target, without having to conform to an externally specified ABI
 706       (Application Binary Interface).
 707       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 708       when this or the GHC convention is used.</a>  This calling convention
 709       does not support varargs and requires the prototype of all callees to
 710       exactly match the prototype of the function definition.</dd>
 711
 712   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make code in the caller as efficient
 714       as possible under the assumption that the call is not commonly executed.
 715       As such, these calls often preserve all registers so that the call does
 716       not break any live ranges in the caller side.  This calling convention
 717       does not support varargs and requires the prototype of all callees to
 718       exactly match the prototype of the function definition.</dd>
 719
 720   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 721   <dd>This calling convention has been implemented specifically for use by the
 722       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 723       It passes everything in registers, going to extremes to achieve this by
 724       disabling callee save registers. This calling convention should not be
 725       used lightly but only for specific situations such as an alternative to
 726       the <em>register pinning</em> performance technique often used when
 727       implementing functional programming languages.At the moment only X86
 728       supports this convention and it has the following limitations:
 729       <ul>
 730         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 731             floating point types are supported.</li>
 732         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 733             6 floating point parameters.</li>
 734       </ul>
 735       This calling convention supports
 736       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 737       requires both the caller and callee are using it.
 738   </dd>
 739
 740   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 741   <dd>Any calling convention may be specified by number, allowing
 742       target-specific calling conventions to be used.  Target specific calling
 743       conventions start at 64.</dd>
 744 </dl>
 745
 746 <p>More calling conventions can be added/defined on an as-needed basis, to
 747    support Pascal conventions or any other well-known target-independent
 748    convention.</p>
 749
 750 </div>
 751
 752 <!-- ======================================================================= -->
 753 <div class="doc_subsection">
 754   <a name="visibility">Visibility Styles</a>
 755 </div>
 756
 757 <div class="doc_text">
 758
 759 <p>All Global Variables and Functions have one of the following visibility
 760    styles:</p>
 761
 762 <dl>
 763   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 764   <dd>On targets that use the ELF object file format, default visibility means
 765       that the declaration is visible to other modules and, in shared libraries,
 766       means that the declared entity may be overridden. On Darwin, default
 767       visibility means that the declaration is visible to other modules. Default
 768       visibility corresponds to "external linkage" in the language.</dd>
 769
 770   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 771   <dd>Two declarations of an object with hidden visibility refer to the same
 772       object if they are in the same shared object. Usually, hidden visibility
 773       indicates that the symbol will not be placed into the dynamic symbol
 774       table, so no other module (executable or shared library) can reference it
 775       directly.</dd>
 776
 777   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 778   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 779       the dynamic symbol table, but that references within the defining module
 780       will bind to the local symbol. That is, the symbol cannot be overridden by
 781       another module.</dd>
 782 </dl>
 783
 784 </div>
 785
 786 <!-- ======================================================================= -->
 787 <div class="doc_subsection">
 788   <a name="namedtypes">Named Types</a>
 789 </div>
 790
 791 <div class="doc_text">
 792
 793 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 794    it easier to read the IR and make the IR more condensed (particularly when
 795    recursive types are involved).  An example of a name specification is:</p>
 796
 797 <pre class="doc_code">
 798 %mytype = type { %mytype*, i32 }
 799 </pre>
 800
 801 <p>You may give a name to any <a href="#typesystem">type</a> except
 802    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 803    is expected with the syntax "%mytype".</p>
 804
 805 <p>Note that type names are aliases for the structural type that they indicate,
 806    and that you can therefore specify multiple names for the same type.  This
 807    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 808    uses structural typing, the name is not part of the type.  When printing out
 809    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 810    particular shape.  This means that if you have code where two different
 811    source types end up having the same LLVM type, that the dumper will sometimes
 812    print the "wrong" or unexpected type.  This is an important design point and
 813    isn't going to change.</p>
 814
 815 </div>
 816
 817 <!-- ======================================================================= -->
 818 <div class="doc_subsection">
 819   <a name="globalvars">Global Variables</a>
 820 </div>
 821
 822 <div class="doc_text">
 823
 824 <p>Global variables define regions of memory allocated at compilation time
 825    instead of run-time.  Global variables may optionally be initialized, may
 826    have an explicit section to be placed in, and may have an optional explicit
 827    alignment specified.  A variable may be defined as "thread_local", which
 828    means that it will not be shared by threads (each thread will have a
 829    separated copy of the variable).  A variable may be defined as a global
 830    "constant," which indicates that the contents of the variable
 831    will <b>never</b> be modified (enabling better optimization, allowing the
 832    global data to be placed in the read-only section of an executable, etc).
 833    Note that variables that need runtime initialization cannot be marked
 834    "constant" as there is a store to the variable.</p>
 835
 836 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 837    constant, even if the final definition of the global is not.  This capability
 838    can be used to enable slightly better optimization of the program, but
 839    requires the language definition to guarantee that optimizations based on the
 840    'constantness' are valid for the translation units that do not include the
 841    definition.</p>
 842
 843 <p>As SSA values, global variables define pointer values that are in scope
 844    (i.e. they dominate) all basic blocks in the program.  Global variables
 845    always define a pointer to their "content" type because they describe a
 846    region of memory, and all memory objects in LLVM are accessed through
 847    pointers.</p>
 848
 849 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 850   that the address is not significant, only the content. Constants marked
 851   like this can be merged with other constants if they have the same
 852   initializer. Note that a constant with significant address <em>can</em>
 853   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 854   constant whose address is significant.</p>
 855
 856 <p>A global variable may be declared to reside in a target-specific numbered
 857    address space. For targets that support them, address spaces may affect how
 858    optimizations are performed and/or what target instructions are used to
 859    access the variable. The default address space is zero. The address space
 860    qualifier must precede any other attributes.</p>
 861
 862 <p>LLVM allows an explicit section to be specified for globals.  If the target
 863    supports it, it will emit globals to the section specified.</p>
 864
 865 <p>An explicit alignment may be specified for a global, which must be a power
 866    of 2.  If not present, or if the alignment is set to zero, the alignment of
 867    the global is set by the target to whatever it feels convenient.  If an
 868    explicit alignment is specified, the global is forced to have exactly that
 869    alignment.  Targets and optimizers are not allowed to over-align the global
 870    if the global has an assigned section.  In this case, the extra alignment
 871    could be observable: for example, code could assume that the globals are
 872    densely packed in their section and try to iterate over them as an array,
 873    alignment padding would break this iteration.</p>
 874
 875 <p>For example, the following defines a global in a numbered address space with
 876    an initializer, section, and alignment:</p>
 877
 878 <pre class="doc_code">
 879 @G = addrspace(5) constant float 1.0, section "foo", align 4
 880 </pre>
 881
 882 </div>
 883
 884
 885 <!-- ======================================================================= -->
 886 <div class="doc_subsection">
 887   <a name="functionstructure">Functions</a>
 888 </div>
 889
 890 <div class="doc_text">
 891
 892 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 893    optional <a href="#linkage">linkage type</a>, an optional
 894    <a href="#visibility">visibility style</a>, an optional
 895    <a href="#callingconv">calling convention</a>,
 896    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 897    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 898    name, a (possibly empty) argument list (each with optional
 899    <a href="#paramattrs">parameter attributes</a>), optional
 900    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 901    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 902    curly brace, a list of basic blocks, and a closing curly brace.</p>
 903
 904 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 905    optional <a href="#linkage">linkage type</a>, an optional
 906    <a href="#visibility">visibility style</a>, an optional
 907    <a href="#callingconv">calling convention</a>,
 908    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 909    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 910    name, a possibly empty list of arguments, an optional alignment, and an
 911    optional <a href="#gc">garbage collector name</a>.</p>
 912
 913 <p>A function definition contains a list of basic blocks, forming the CFG
 914    (Control Flow Graph) for the function.  Each basic block may optionally start
 915    with a label (giving the basic block a symbol table entry), contains a list
 916    of instructions, and ends with a <a href="#terminators">terminator</a>
 917    instruction (such as a branch or function return).</p>
 918
 919 <p>The first basic block in a function is special in two ways: it is immediately
 920    executed on entrance to the function, and it is not allowed to have
 921    predecessor basic blocks (i.e. there can not be any branches to the entry
 922    block of a function).  Because the block can have no predecessors, it also
 923    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 924
 925 <p>LLVM allows an explicit section to be specified for functions.  If the target
 926    supports it, it will emit functions to the section specified.</p>
 927
 928 <p>An explicit alignment may be specified for a function.  If not present, or if
 929    the alignment is set to zero, the alignment of the function is set by the
 930    target to whatever it feels convenient.  If an explicit alignment is
 931    specified, the function is forced to have at least that much alignment.  All
 932    alignments must be a power of 2.</p>
 933
 934 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 935   be significant and two identical functions can be merged</p>.
 936
 937 <h5>Syntax:</h5>
 938 <pre class="doc_code">
 939 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 940        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 941        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 942        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 943        [<a href="#gc">gc</a>] { ... }
 944 </pre>
 945
 946 </div>
 947
 948 <!-- ======================================================================= -->
 949 <div class="doc_subsection">
 950   <a name="aliasstructure">Aliases</a>
 951 </div>
 952
 953 <div class="doc_text">
 954
 955 <p>Aliases act as "second name" for the aliasee value (which can be either
 956    function, global variable, another alias or bitcast of global value). Aliases
 957    may have an optional <a href="#linkage">linkage type</a>, and an
 958    optional <a href="#visibility">visibility style</a>.</p>
 959
 960 <h5>Syntax:</h5>
 961 <pre class="doc_code">
 962 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 963 </pre>
 964
 965 </div>
 966
 967 <!-- ======================================================================= -->
 968 <div class="doc_subsection">
 969   <a name="namedmetadatastructure">Named Metadata</a>
 970 </div>
 971
 972 <div class="doc_text">
 973
 974 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 975    nodes</a> (but not metadata strings) are the only valid operands for
 976    a named metadata.</p>
 977
 978 <h5>Syntax:</h5>
 979 <pre class="doc_code">
 980 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 981 !0 = metadata !{metadata !"zero"}
 982 !1 = metadata !{metadata !"one"}
 983 !2 = metadata !{metadata !"two"}
 984 ; A named metadata.
 985 !name = !{!0, !1, !2}
 986 </pre>
 987
 988 </div>
 989
 990 <!-- ======================================================================= -->
 991 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 992
 993 <div class="doc_text">
 994
 995 <p>The return type and each parameter of a function type may have a set of
 996    <i>parameter attributes</i> associated with them. Parameter attributes are
 997    used to communicate additional information about the result or parameters of
 998    a function. Parameter attributes are considered to be part of the function,
 999    not of the function type, so functions with different parameter attributes
1000    can have the same function type.</p>
1001
1002 <p>Parameter attributes are simple keywords that follow the type specified. If
1003    multiple parameter attributes are needed, they are space separated. For
1004    example:</p>
1005
1006 <pre class="doc_code">
1007 declare i32 @printf(i8* noalias nocapture, ...)
1008 declare i32 @atoi(i8 zeroext)
1009 declare signext i8 @returns_signed_char()
1010 </pre>
1011
1012 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1013    <tt>readonly</tt>) come immediately after the argument list.</p>
1014
1015 <p>Currently, only the following parameter attributes are defined:</p>
1016
1017 <dl>
1018   <dt><tt><b>zeroext</b></tt></dt>
1019   <dd>This indicates to the code generator that the parameter or return value
1020       should be zero-extended to the extent required by the target's ABI (which
1021       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1022       parameter) or the callee (for a return value).</dd>
1023
1024   <dt><tt><b>signext</b></tt></dt>
1025   <dd>This indicates to the code generator that the parameter or return value
1026       should be sign-extended to the extent required by the target's ABI (which
1027       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1028       return value).</dd>
1029
1030   <dt><tt><b>inreg</b></tt></dt>
1031   <dd>This indicates that this parameter or return value should be treated in a
1032       special target-dependent fashion during while emitting code for a function
1033       call or return (usually, by putting it in a register as opposed to memory,
1034       though some targets use it to distinguish between two different kinds of
1035       registers).  Use of this attribute is target-specific.</dd>
1036
1037   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1038   <dd><p>This indicates that the pointer parameter should really be passed by
1039       value to the function.  The attribute implies that a hidden copy of the
1040       pointee
1041       is made between the caller and the callee, so the callee is unable to
1042       modify the value in the callee.  This attribute is only valid on LLVM
1043       pointer arguments.  It is generally used to pass structs and arrays by
1044       value, but is also valid on pointers to scalars.  The copy is considered
1045       to belong to the caller not the callee (for example,
1046       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1047       <tt>byval</tt> parameters). This is not a valid attribute for return
1048       values.</p>
1049
1050       <p>The byval attribute also supports specifying an alignment with
1051       the align attribute.  It indicates the alignment of the stack slot to
1052       form and the known alignment of the pointer specified to the call site. If
1053       the alignment is not specified, then the code generator makes a
1054       target-specific assumption.</p></dd>
1055
1056   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1057   <dd>This indicates that the pointer parameter specifies the address of a
1058       structure that is the return value of the function in the source program.
1059       This pointer must be guaranteed by the caller to be valid: loads and
1060       stores to the structure may be assumed by the callee to not to trap.  This
1061       may only be applied to the first parameter. This is not a valid attribute
1062       for return values. </dd>
1063
1064   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1065   <dd>This indicates that pointer values
1066       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1067       value do not alias pointer values which are not <i>based</i> on it,
1068       ignoring certain "irrelevant" dependencies.
1069       For a call to the parent function, dependencies between memory
1070       references from before or after the call and from those during the call
1071       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1072       return value used in that call.
1073       The caller shares the responsibility with the callee for ensuring that
1074       these requirements are met.
1075       For further details, please see the discussion of the NoAlias response in
1076       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1077 <br>
1078       Note that this definition of <tt>noalias</tt> is intentionally
1079       similar to the definition of <tt>restrict</tt> in C99 for function
1080       arguments, though it is slightly weaker.
1081 <br>
1082       For function return values, C99's <tt>restrict</tt> is not meaningful,
1083       while LLVM's <tt>noalias</tt> is.
1084       </dd>
1085
1086   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1087   <dd>This indicates that the callee does not make any copies of the pointer
1088       that outlive the callee itself. This is not a valid attribute for return
1089       values.</dd>
1090
1091   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1092   <dd>This indicates that the pointer parameter can be excised using the
1093       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1094       attribute for return values.</dd>
1095 </dl>
1096
1097 </div>
1098
1099 <!-- ======================================================================= -->
1100 <div class="doc_subsection">
1101   <a name="gc">Garbage Collector Names</a>
1102 </div>
1103
1104 <div class="doc_text">
1105
1106 <p>Each function may specify a garbage collector name, which is simply a
1107    string:</p>
1108
1109 <pre class="doc_code">
1110 define void @f() gc "name" { ... }
1111 </pre>
1112
1113 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1114    collector which will cause the compiler to alter its output in order to
1115    support the named garbage collection algorithm.</p>
1116
1117 </div>
1118
1119 <!-- ======================================================================= -->
1120 <div class="doc_subsection">
1121   <a name="fnattrs">Function Attributes</a>
1122 </div>
1123
1124 <div class="doc_text">
1125
1126 <p>Function attributes are set to communicate additional information about a
1127    function. Function attributes are considered to be part of the function, not
1128    of the function type, so functions with different parameter attributes can
1129    have the same function type.</p>
1130
1131 <p>Function attributes are simple keywords that follow the type specified. If
1132    multiple attributes are needed, they are space separated. For example:</p>
1133
1134 <pre class="doc_code">
1135 define void @f() noinline { ... }
1136 define void @f() alwaysinline { ... }
1137 define void @f() alwaysinline optsize { ... }
1138 define void @f() optsize { ... }
1139 </pre>
1140
1141 <dl>
1142   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1143   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1144       the backend should forcibly align the stack pointer. Specify the
1145       desired alignment, which must be a power of two, in parentheses.
1146
1147   <dt><tt><b>alwaysinline</b></tt></dt>
1148   <dd>This attribute indicates that the inliner should attempt to inline this
1149       function into callers whenever possible, ignoring any active inlining size
1150       threshold for this caller.</dd>
1151
1152   <dt><tt><b>hotpatch</b></tt></dt>
1153   <dd>This attribute indicates that the function should be 'hotpatchable',
1154       meaning the function can be patched and/or hooked even while it is
1155       loaded into memory. On x86, the function prologue will be preceded
1156       by six bytes of padding and will begin with a two-byte instruction.
1157       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1158       higher were compiled in this fashion.</dd>
1159
1160   <dt><tt><b>inlinehint</b></tt></dt>
1161   <dd>This attribute indicates that the source code contained a hint that inlining
1162       this function is desirable (such as the "inline" keyword in C/C++).  It
1163       is just a hint; it imposes no requirements on the inliner.</dd>
1164
1165   <dt><tt><b>naked</b></tt></dt>
1166   <dd>This attribute disables prologue / epilogue emission for the function.
1167       This can have very system-specific consequences.</dd>
1168
1169   <dt><tt><b>noimplicitfloat</b></tt></dt>
1170   <dd>This attributes disables implicit floating point instructions.</dd>
1171
1172   <dt><tt><b>noinline</b></tt></dt>
1173   <dd>This attribute indicates that the inliner should never inline this
1174       function in any situation. This attribute may not be used together with
1175       the <tt>alwaysinline</tt> attribute.</dd>
1176
1177   <dt><tt><b>noredzone</b></tt></dt>
1178   <dd>This attribute indicates that the code generator should not use a red
1179       zone, even if the target-specific ABI normally permits it.</dd>
1180
1181   <dt><tt><b>noreturn</b></tt></dt>
1182   <dd>This function attribute indicates that the function never returns
1183       normally.  This produces undefined behavior at runtime if the function
1184       ever does dynamically return.</dd>
1185
1186   <dt><tt><b>nounwind</b></tt></dt>
1187   <dd>This function attribute indicates that the function never returns with an
1188       unwind or exceptional control flow.  If the function does unwind, its
1189       runtime behavior is undefined.</dd>
1190
1191   <dt><tt><b>optsize</b></tt></dt>
1192   <dd>This attribute suggests that optimization passes and code generator passes
1193       make choices that keep the code size of this function low, and otherwise
1194       do optimizations specifically to reduce code size.</dd>
1195
1196   <dt><tt><b>readnone</b></tt></dt>
1197   <dd>This attribute indicates that the function computes its result (or decides
1198       to unwind an exception) based strictly on its arguments, without
1199       dereferencing any pointer arguments or otherwise accessing any mutable
1200       state (e.g. memory, control registers, etc) visible to caller functions.
1201       It does not write through any pointer arguments
1202       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1203       changes any state visible to callers.  This means that it cannot unwind
1204       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1205       could use the <tt>unwind</tt> instruction.</dd>
1206
1207   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1208   <dd>This attribute indicates that the function does not write through any
1209       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1210       arguments) or otherwise modify any state (e.g. memory, control registers,
1211       etc) visible to caller functions.  It may dereference pointer arguments
1212       and read state that may be set in the caller.  A readonly function always
1213       returns the same value (or unwinds an exception identically) when called
1214       with the same set of arguments and global state.  It cannot unwind an
1215       exception by calling the <tt>C++</tt> exception throwing methods, but may
1216       use the <tt>unwind</tt> instruction.</dd>
1217
1218   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1219   <dd>This attribute indicates that the function should emit a stack smashing
1220       protector. It is in the form of a "canary"&mdash;a random value placed on
1221       the stack before the local variables that's checked upon return from the
1222       function to see if it has been overwritten. A heuristic is used to
1223       determine if a function needs stack protectors or not.<br>
1224 <br>
1225       If a function that has an <tt>ssp</tt> attribute is inlined into a
1226       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1227       function will have an <tt>ssp</tt> attribute.</dd>
1228
1229   <dt><tt><b>sspreq</b></tt></dt>
1230   <dd>This attribute indicates that the function should <em>always</em> emit a
1231       stack smashing protector. This overrides
1232       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1233 <br>
1234       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1235       function that doesn't have an <tt>sspreq</tt> attribute or which has
1236       an <tt>ssp</tt> attribute, then the resulting function will have
1237       an <tt>sspreq</tt> attribute.</dd>
1238 </dl>
1239
1240 </div>
1241
1242 <!-- ======================================================================= -->
1243 <div class="doc_subsection">
1244   <a name="moduleasm">Module-Level Inline Assembly</a>
1245 </div>
1246
1247 <div class="doc_text">
1248
1249 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1250    the GCC "file scope inline asm" blocks.  These blocks are internally
1251    concatenated by LLVM and treated as a single unit, but may be separated in
1252    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1253
1254 <pre class="doc_code">
1255 module asm "inline asm code goes here"
1256 module asm "more can go here"
1257 </pre>
1258
1259 <p>The strings can contain any character by escaping non-printable characters.
1260    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1261    for the number.</p>
1262
1263 <p>The inline asm code is simply printed to the machine code .s file when
1264    assembly code is generated.</p>
1265
1266 </div>
1267
1268 <!-- ======================================================================= -->
1269 <div class="doc_subsection">
1270   <a name="datalayout">Data Layout</a>
1271 </div>
1272
1273 <div class="doc_text">
1274
1275 <p>A module may specify a target specific data layout string that specifies how
1276    data is to be laid out in memory. The syntax for the data layout is
1277    simply:</p>
1278
1279 <pre class="doc_code">
1280 target datalayout = "<i>layout specification</i>"
1281 </pre>
1282
1283 <p>The <i>layout specification</i> consists of a list of specifications
1284    separated by the minus sign character ('-').  Each specification starts with
1285    a letter and may include other information after the letter to define some
1286    aspect of the data layout.  The specifications accepted are as follows:</p>
1287
1288 <dl>
1289   <dt><tt>E</tt></dt>
1290   <dd>Specifies that the target lays out data in big-endian form. That is, the
1291       bits with the most significance have the lowest address location.</dd>
1292
1293   <dt><tt>e</tt></dt>
1294   <dd>Specifies that the target lays out data in little-endian form. That is,
1295       the bits with the least significance have the lowest address
1296       location.</dd>
1297
1298   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1299   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1300       <i>preferred</i> alignments. All sizes are in bits. Specifying
1301       the <i>pref</i> alignment is optional. If omitted, the
1302       preceding <tt>:</tt> should be omitted too.</dd>
1303
1304   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1305   <dd>This specifies the alignment for an integer type of a given bit
1306       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1307
1308   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1309   <dd>This specifies the alignment for a vector type of a given bit
1310       <i>size</i>.</dd>
1311
1312   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1313   <dd>This specifies the alignment for a floating point type of a given bit
1314       <i>size</i>. Only values of <i>size</i> that are supported by the target
1315       will work.  32 (float) and 64 (double) are supported on all targets;
1316       80 or 128 (different flavors of long double) are also supported on some
1317       targets.
1318
1319   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1320   <dd>This specifies the alignment for an aggregate type of a given bit
1321       <i>size</i>.</dd>
1322
1323   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1324   <dd>This specifies the alignment for a stack object of a given bit
1325       <i>size</i>.</dd>
1326
1327   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1328   <dd>This specifies a set of native integer widths for the target CPU
1329       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1330       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1331       this set are considered to support most general arithmetic
1332       operations efficiently.</dd>
1333 </dl>
1334
1335 <p>When constructing the data layout for a given target, LLVM starts with a
1336    default set of specifications which are then (possibly) overridden by the
1337    specifications in the <tt>datalayout</tt> keyword. The default specifications
1338    are given in this list:</p>
1339
1340 <ul>
1341   <li><tt>E</tt> - big endian</li>
1342   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1343   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1344   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1345   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1346   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1347   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1348   alignment of 64-bits</li>
1349   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1350   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1351   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1352   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1353   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1354   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1355 </ul>
1356
1357 <p>When LLVM is determining the alignment for a given type, it uses the
1358    following rules:</p>
1359
1360 <ol>
1361   <li>If the type sought is an exact match for one of the specifications, that
1362       specification is used.</li>
1363
1364   <li>If no match is found, and the type sought is an integer type, then the
1365       smallest integer type that is larger than the bitwidth of the sought type
1366       is used. If none of the specifications are larger than the bitwidth then
1367       the the largest integer type is used. For example, given the default
1368       specifications above, the i7 type will use the alignment of i8 (next
1369       largest) while both i65 and i256 will use the alignment of i64 (largest
1370       specified).</li>
1371
1372   <li>If no match is found, and the type sought is a vector type, then the
1373       largest vector type that is smaller than the sought vector type will be
1374       used as a fall back.  This happens because &lt;128 x double&gt; can be
1375       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1376 </ol>
1377
1378 </div>
1379
1380 <!-- ======================================================================= -->
1381 <div class="doc_subsection">
1382   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1383 </div>
1384
1385 <div class="doc_text">
1386
1387 <p>Any memory access must be done through a pointer value associated
1388 with an address range of the memory access, otherwise the behavior
1389 is undefined. Pointer values are associated with address ranges
1390 according to the following rules:</p>
1391
1392 <ul>
1393   <li>A pointer value is associated with the addresses associated with
1394       any value it is <i>based</i> on.
1395   <li>An address of a global variable is associated with the address
1396       range of the variable's storage.</li>
1397   <li>The result value of an allocation instruction is associated with
1398       the address range of the allocated storage.</li>
1399   <li>A null pointer in the default address-space is associated with
1400       no address.</li>
1401   <li>An integer constant other than zero or a pointer value returned
1402       from a function not defined within LLVM may be associated with address
1403       ranges allocated through mechanisms other than those provided by
1404       LLVM. Such ranges shall not overlap with any ranges of addresses
1405       allocated by mechanisms provided by LLVM.</li>
1406 </ul>
1407
1408 <p>A pointer value is <i>based</i> on another pointer value according
1409    to the following rules:</p>
1410
1411 <ul>
1412   <li>A pointer value formed from a
1413       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1414       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1415   <li>The result value of a
1416       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1417       of the <tt>bitcast</tt>.</li>
1418   <li>A pointer value formed by an
1419       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1420       pointer values that contribute (directly or indirectly) to the
1421       computation of the pointer's value.</li>
1422   <li>The "<i>based</i> on" relationship is transitive.</li>
1423 </ul>
1424
1425 <p>Note that this definition of <i>"based"</i> is intentionally
1426    similar to the definition of <i>"based"</i> in C99, though it is
1427    slightly weaker.</p>
1428
1429 <p>LLVM IR does not associate types with memory. The result type of a
1430 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1431 alignment of the memory from which to load, as well as the
1432 interpretation of the value. The first operand type of a
1433 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1434 and alignment of the store.</p>
1435
1436 <p>Consequently, type-based alias analysis, aka TBAA, aka
1437 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1438 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1439 additional information which specialized optimization passes may use
1440 to implement type-based alias analysis.</p>
1441
1442 </div>
1443
1444 <!-- ======================================================================= -->
1445 <div class="doc_subsection">
1446   <a name="volatile">Volatile Memory Accesses</a>
1447 </div>
1448
1449 <div class="doc_text">
1450
1451 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1452 href="#i_store"><tt>store</tt></a>s, and <a
1453 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1454 The optimizers must not change the number of volatile operations or change their
1455 order of execution relative to other volatile operations.  The optimizers
1456 <i>may</i> change the order of volatile operations relative to non-volatile
1457 operations.  This is not Java's "volatile" and has no cross-thread
1458 synchronization behavior.</p>
1459
1460 </div>
1461
1462 <!-- *********************************************************************** -->
1463 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
1464 <!-- *********************************************************************** -->
1465
1466 <div class="doc_text">
1467
1468 <p>The LLVM type system is one of the most important features of the
1469    intermediate representation.  Being typed enables a number of optimizations
1470    to be performed on the intermediate representation directly, without having
1471    to do extra analyses on the side before the transformation.  A strong type
1472    system makes it easier to read the generated code and enables novel analyses
1473    and transformations that are not feasible to perform on normal three address
1474    code representations.</p>
1475
1476 </div>
1477
1478 <!-- ======================================================================= -->
1479 <div class="doc_subsection"> <a name="t_classifications">Type
1480 Classifications</a> </div>
1481
1482 <div class="doc_text">
1483
1484 <p>The types fall into a few useful classifications:</p>
1485
1486 <table border="1" cellspacing="0" cellpadding="4">
1487   <tbody>
1488     <tr><th>Classification</th><th>Types</th></tr>
1489     <tr>
1490       <td><a href="#t_integer">integer</a></td>
1491       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1492     </tr>
1493     <tr>
1494       <td><a href="#t_floating">floating point</a></td>
1495       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1496     </tr>
1497     <tr>
1498       <td><a name="t_firstclass">first class</a></td>
1499       <td><a href="#t_integer">integer</a>,
1500           <a href="#t_floating">floating point</a>,
1501           <a href="#t_pointer">pointer</a>,
1502           <a href="#t_vector">vector</a>,
1503           <a href="#t_struct">structure</a>,
1504           <a href="#t_array">array</a>,
1505           <a href="#t_label">label</a>,
1506           <a href="#t_metadata">metadata</a>.
1507       </td>
1508     </tr>
1509     <tr>
1510       <td><a href="#t_primitive">primitive</a></td>
1511       <td><a href="#t_label">label</a>,
1512           <a href="#t_void">void</a>,
1513           <a href="#t_integer">integer</a>,
1514           <a href="#t_floating">floating point</a>,
1515           <a href="#t_x86mmx">x86mmx</a>,
1516           <a href="#t_metadata">metadata</a>.</td>
1517     </tr>
1518     <tr>
1519       <td><a href="#t_derived">derived</a></td>
1520       <td><a href="#t_array">array</a>,
1521           <a href="#t_function">function</a>,
1522           <a href="#t_pointer">pointer</a>,
1523           <a href="#t_struct">structure</a>,
1524           <a href="#t_pstruct">packed structure</a>,
1525           <a href="#t_vector">vector</a>,
1526           <a href="#t_opaque">opaque</a>.
1527       </td>
1528     </tr>
1529   </tbody>
1530 </table>
1531
1532 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1533    important.  Values of these types are the only ones which can be produced by
1534    instructions.</p>
1535
1536 </div>
1537
1538 <!-- ======================================================================= -->
1539 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
1540
1541 <div class="doc_text">
1542
1543 <p>The primitive types are the fundamental building blocks of the LLVM
1544    system.</p>
1545
1546 </div>
1547
1548 <!-- _______________________________________________________________________ -->
1549 <div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
1550
1551 <div class="doc_text">
1552
1553 <h5>Overview:</h5>
1554 <p>The integer type is a very simple type that simply specifies an arbitrary
1555    bit width for the integer type desired. Any bit width from 1 bit to
1556    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1557
1558 <h5>Syntax:</h5>
1559 <pre>
1560   iN
1561 </pre>
1562
1563 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1564    value.</p>
1565
1566 <h5>Examples:</h5>
1567 <table class="layout">
1568   <tr class="layout">
1569     <td class="left"><tt>i1</tt></td>
1570     <td class="left">a single-bit integer.</td>
1571   </tr>
1572   <tr class="layout">
1573     <td class="left"><tt>i32</tt></td>
1574     <td class="left">a 32-bit integer.</td>
1575   </tr>
1576   <tr class="layout">
1577     <td class="left"><tt>i1942652</tt></td>
1578     <td class="left">a really big integer of over 1 million bits.</td>
1579   </tr>
1580 </table>
1581
1582 </div>
1583
1584 <!-- _______________________________________________________________________ -->
1585 <div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
1586
1587 <div class="doc_text">
1588
1589 <table>
1590   <tbody>
1591     <tr><th>Type</th><th>Description</th></tr>
1592     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1593     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1594     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1595     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1596     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1597   </tbody>
1598 </table>
1599
1600 </div>
1601
1602 <!-- _______________________________________________________________________ -->
1603 <div class="doc_subsubsection"> <a name="t_x86mmx">X86mmx Type</a> </div>
1604
1605 <div class="doc_text">
1606
1607 <h5>Overview:</h5>
1608 <p>The x86mmx type represents a value held in an MMX register on an x86 machine.  The operations allowed on it are quite limited:  parameters and return values, load and store, and bitcast.  User-specified MMX instructions are represented as intrinsic or asm calls with arguments and/or results of this type.  There are no arrays, vectors or constants of this type.</p>
1609
1610 <h5>Syntax:</h5>
1611 <pre>
1612   x86mmx
1613 </pre>
1614
1615 </div>
1616
1617 <!-- _______________________________________________________________________ -->
1618 <div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
1619
1620 <div class="doc_text">
1621
1622 <h5>Overview:</h5>
1623 <p>The void type does not represent any value and has no size.</p>
1624
1625 <h5>Syntax:</h5>
1626 <pre>
1627   void
1628 </pre>
1629
1630 </div>
1631
1632 <!-- _______________________________________________________________________ -->
1633 <div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
1634
1635 <div class="doc_text">
1636
1637 <h5>Overview:</h5>
1638 <p>The label type represents code labels.</p>
1639
1640 <h5>Syntax:</h5>
1641 <pre>
1642   label
1643 </pre>
1644
1645 </div>
1646
1647 <!-- _______________________________________________________________________ -->
1648 <div class="doc_subsubsection"> <a name="t_metadata">Metadata Type</a> </div>
1649
1650 <div class="doc_text">
1651
1652 <h5>Overview:</h5>
1653 <p>The metadata type represents embedded metadata. No derived types may be
1654    created from metadata except for <a href="#t_function">function</a>
1655    arguments.
1656
1657 <h5>Syntax:</h5>
1658 <pre>
1659   metadata
1660 </pre>
1661
1662 </div>
1663
1664
1665 <!-- ======================================================================= -->
1666 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
1667
1668 <div class="doc_text">
1669
1670 <p>The real power in LLVM comes from the derived types in the system.  This is
1671    what allows a programmer to represent arrays, functions, pointers, and other
1672    useful types.  Each of these types contain one or more element types which
1673    may be a primitive type, or another derived type.  For example, it is
1674    possible to have a two dimensional array, using an array as the element type
1675    of another array.</p>
1676
1677
1678 </div>
1679
1680 <!-- _______________________________________________________________________ -->
1681 <div class="doc_subsubsection"> <a name="t_aggregate">Aggregate Types</a> </div>
1682
1683 <div class="doc_text">
1684
1685 <p>Aggregate Types are a subset of derived types that can contain multiple
1686   member types. <a href="#t_array">Arrays</a>,
1687   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1688   aggregate types.</p>
1689
1690 </div>
1691
1692 <!-- _______________________________________________________________________ -->
1693 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
1694
1695 <div class="doc_text">
1696
1697 <h5>Overview:</h5>
1698 <p>The array type is a very simple derived type that arranges elements
1699    sequentially in memory.  The array type requires a size (number of elements)
1700    and an underlying data type.</p>
1701
1702 <h5>Syntax:</h5>
1703 <pre>
1704   [&lt;# elements&gt; x &lt;elementtype&gt;]
1705 </pre>
1706
1707 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1708    be any type with a size.</p>
1709
1710 <h5>Examples:</h5>
1711 <table class="layout">
1712   <tr class="layout">
1713     <td class="left"><tt>[40 x i32]</tt></td>
1714     <td class="left">Array of 40 32-bit integer values.</td>
1715   </tr>
1716   <tr class="layout">
1717     <td class="left"><tt>[41 x i32]</tt></td>
1718     <td class="left">Array of 41 32-bit integer values.</td>
1719   </tr>
1720   <tr class="layout">
1721     <td class="left"><tt>[4 x i8]</tt></td>
1722     <td class="left">Array of 4 8-bit integer values.</td>
1723   </tr>
1724 </table>
1725 <p>Here are some examples of multidimensional arrays:</p>
1726 <table class="layout">
1727   <tr class="layout">
1728     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1729     <td class="left">3x4 array of 32-bit integer values.</td>
1730   </tr>
1731   <tr class="layout">
1732     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1733     <td class="left">12x10 array of single precision floating point values.</td>
1734   </tr>
1735   <tr class="layout">
1736     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1737     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1738   </tr>
1739 </table>
1740
1741 <p>There is no restriction on indexing beyond the end of the array implied by
1742    a static type (though there are restrictions on indexing beyond the bounds
1743    of an allocated object in some cases). This means that single-dimension
1744    'variable sized array' addressing can be implemented in LLVM with a zero
1745    length array type. An implementation of 'pascal style arrays' in LLVM could
1746    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1747
1748 </div>
1749
1750 <!-- _______________________________________________________________________ -->
1751 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
1752
1753 <div class="doc_text">
1754
1755 <h5>Overview:</h5>
1756 <p>The function type can be thought of as a function signature.  It consists of
1757    a return type and a list of formal parameter types. The return type of a
1758    function type is a first class type or a void type.</p>
1759
1760 <h5>Syntax:</h5>
1761 <pre>
1762   &lt;returntype&gt; (&lt;parameter list&gt;)
1763 </pre>
1764
1765 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1766    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1767    which indicates that the function takes a variable number of arguments.
1768    Variable argument functions can access their arguments with
1769    the <a href="#int_varargs">variable argument handling intrinsic</a>
1770    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1771    <a href="#t_label">label</a>.</p>
1772
1773 <h5>Examples:</h5>
1774 <table class="layout">
1775   <tr class="layout">
1776     <td class="left"><tt>i32 (i32)</tt></td>
1777     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1778     </td>
1779   </tr><tr class="layout">
1780     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1781     </tt></td>
1782     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1783       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1784       returning <tt>float</tt>.
1785     </td>
1786   </tr><tr class="layout">
1787     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1788     <td class="left">A vararg function that takes at least one
1789       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
1790       which returns an integer.  This is the signature for <tt>printf</tt> in
1791       LLVM.
1792     </td>
1793   </tr><tr class="layout">
1794     <td class="left"><tt>{i32, i32} (i32)</tt></td>
1795     <td class="left">A function taking an <tt>i32</tt>, returning a
1796         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
1797     </td>
1798   </tr>
1799 </table>
1800
1801 </div>
1802
1803 <!-- _______________________________________________________________________ -->
1804 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
1805
1806 <div class="doc_text">
1807
1808 <h5>Overview:</h5>
1809 <p>The structure type is used to represent a collection of data members together
1810    in memory.  The packing of the field types is defined to match the ABI of the
1811    underlying processor.  The elements of a structure may be any type that has a
1812    size.</p>
1813
1814 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
1815    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
1816    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
1817    Structures in registers are accessed using the
1818    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
1819    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
1820 <h5>Syntax:</h5>
1821 <pre>
1822   { &lt;type list&gt; }
1823 </pre>
1824
1825 <h5>Examples:</h5>
1826 <table class="layout">
1827   <tr class="layout">
1828     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
1829     <td class="left">A triple of three <tt>i32</tt> values</td>
1830   </tr><tr class="layout">
1831     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
1832     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1833       second element is a <a href="#t_pointer">pointer</a> to a
1834       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1835       an <tt>i32</tt>.</td>
1836   </tr>
1837 </table>
1838
1839 </div>
1840
1841 <!-- _______________________________________________________________________ -->
1842 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1843 </div>
1844
1845 <div class="doc_text">
1846
1847 <h5>Overview:</h5>
1848 <p>The packed structure type is used to represent a collection of data members
1849    together in memory.  There is no padding between fields.  Further, the
1850    alignment of a packed structure is 1 byte.  The elements of a packed
1851    structure may be any type that has a size.</p>
1852
1853 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt> and
1854    '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field with
1855    the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
1856
1857 <h5>Syntax:</h5>
1858 <pre>
1859   &lt; { &lt;type list&gt; } &gt;
1860 </pre>
1861
1862 <h5>Examples:</h5>
1863 <table class="layout">
1864   <tr class="layout">
1865     <td class="left"><tt>&lt; { i32, i32, i32 } &gt;</tt></td>
1866     <td class="left">A triple of three <tt>i32</tt> values</td>
1867   </tr><tr class="layout">
1868   <td class="left">
1869 <tt>&lt;&nbsp;{&nbsp;float,&nbsp;i32&nbsp;(i32)*&nbsp;}&nbsp;&gt;</tt></td>
1870     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1871       second element is a <a href="#t_pointer">pointer</a> to a
1872       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1873       an <tt>i32</tt>.</td>
1874   </tr>
1875 </table>
1876
1877 </div>
1878
1879 <!-- _______________________________________________________________________ -->
1880 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1881
1882 <div class="doc_text">
1883
1884 <h5>Overview:</h5>
1885 <p>The pointer type is used to specify memory locations.
1886    Pointers are commonly used to reference objects in memory.</p>
1887
1888 <p>Pointer types may have an optional address space attribute defining the
1889    numbered address space where the pointed-to object resides. The default
1890    address space is number zero. The semantics of non-zero address
1891    spaces are target-specific.</p>
1892
1893 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
1894    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
1895
1896 <h5>Syntax:</h5>
1897 <pre>
1898   &lt;type&gt; *
1899 </pre>
1900
1901 <h5>Examples:</h5>
1902 <table class="layout">
1903   <tr class="layout">
1904     <td class="left"><tt>[4 x i32]*</tt></td>
1905     <td class="left">A <a href="#t_pointer">pointer</a> to <a
1906                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
1907   </tr>
1908   <tr class="layout">
1909     <td class="left"><tt>i32 (i32*) *</tt></td>
1910     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
1911       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1912       <tt>i32</tt>.</td>
1913   </tr>
1914   <tr class="layout">
1915     <td class="left"><tt>i32 addrspace(5)*</tt></td>
1916     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
1917      that resides in address space #5.</td>
1918   </tr>
1919 </table>
1920
1921 </div>
1922
1923 <!-- _______________________________________________________________________ -->
1924 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1925
1926 <div class="doc_text">
1927
1928 <h5>Overview:</h5>
1929 <p>A vector type is a simple derived type that represents a vector of elements.
1930    Vector types are used when multiple primitive data are operated in parallel
1931    using a single instruction (SIMD).  A vector type requires a size (number of
1932    elements) and an underlying primitive data type.  Vector types are considered
1933    <a href="#t_firstclass">first class</a>.</p>
1934
1935 <h5>Syntax:</h5>
1936 <pre>
1937   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1938 </pre>
1939
1940 <p>The number of elements is a constant integer value larger than 0; elementtype
1941    may be any integer or floating point type.  Vectors of size zero are not
1942    allowed, and pointers are not allowed as the element type.</p>
1943
1944 <h5>Examples:</h5>
1945 <table class="layout">
1946   <tr class="layout">
1947     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
1948     <td class="left">Vector of 4 32-bit integer values.</td>
1949   </tr>
1950   <tr class="layout">
1951     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
1952     <td class="left">Vector of 8 32-bit floating-point values.</td>
1953   </tr>
1954   <tr class="layout">
1955     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
1956     <td class="left">Vector of 2 64-bit integer values.</td>
1957   </tr>
1958 </table>
1959
1960 </div>
1961
1962 <!-- _______________________________________________________________________ -->
1963 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1964 <div class="doc_text">
1965
1966 <h5>Overview:</h5>
1967 <p>Opaque types are used to represent unknown types in the system.  This
1968    corresponds (for example) to the C notion of a forward declared structure
1969    type.  In LLVM, opaque types can eventually be resolved to any type (not just
1970    a structure type).</p>
1971
1972 <h5>Syntax:</h5>
1973 <pre>
1974   opaque
1975 </pre>
1976
1977 <h5>Examples:</h5>
1978 <table class="layout">
1979   <tr class="layout">
1980     <td class="left"><tt>opaque</tt></td>
1981     <td class="left">An opaque type.</td>
1982   </tr>
1983 </table>
1984
1985 </div>
1986
1987 <!-- ======================================================================= -->
1988 <div class="doc_subsection">
1989   <a name="t_uprefs">Type Up-references</a>
1990 </div>
1991
1992 <div class="doc_text">
1993
1994 <h5>Overview:</h5>
1995 <p>An "up reference" allows you to refer to a lexically enclosing type without
1996    requiring it to have a name. For instance, a structure declaration may
1997    contain a pointer to any of the types it is lexically a member of.  Example
1998    of up references (with their equivalent as named type declarations)
1999    include:</p>
2000
2001 <pre>
2002    { \2 * }                %x = type { %x* }
2003    { \2 }*                 %y = type { %y }*
2004    \1*                     %z = type %z*
2005 </pre>
2006
2007 <p>An up reference is needed by the asmprinter for printing out cyclic types
2008    when there is no declared name for a type in the cycle.  Because the
2009    asmprinter does not want to print out an infinite type string, it needs a
2010    syntax to handle recursive types that have no names (all names are optional
2011    in llvm IR).</p>
2012
2013 <h5>Syntax:</h5>
2014 <pre>
2015    \&lt;level&gt;
2016 </pre>
2017
2018 <p>The level is the count of the lexical type that is being referred to.</p>
2019
2020 <h5>Examples:</h5>
2021 <table class="layout">
2022   <tr class="layout">
2023     <td class="left"><tt>\1*</tt></td>
2024     <td class="left">Self-referential pointer.</td>
2025   </tr>
2026   <tr class="layout">
2027     <td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
2028     <td class="left">Recursive structure where the upref refers to the out-most
2029                      structure.</td>
2030   </tr>
2031 </table>
2032
2033 </div>
2034
2035 <!-- *********************************************************************** -->
2036 <div class="doc_section"> <a name="constants">Constants</a> </div>
2037 <!-- *********************************************************************** -->
2038
2039 <div class="doc_text">
2040
2041 <p>LLVM has several different basic types of constants.  This section describes
2042    them all and their syntax.</p>
2043
2044 </div>
2045
2046 <!-- ======================================================================= -->
2047 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
2048
2049 <div class="doc_text">
2050
2051 <dl>
2052   <dt><b>Boolean constants</b></dt>
2053   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2054       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2055
2056   <dt><b>Integer constants</b></dt>
2057   <dd>Standard integers (such as '4') are constants of
2058       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2059       with integer types.</dd>
2060
2061   <dt><b>Floating point constants</b></dt>
2062   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2063       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2064       notation (see below).  The assembler requires the exact decimal value of a
2065       floating-point constant.  For example, the assembler accepts 1.25 but
2066       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2067       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2068
2069   <dt><b>Null pointer constants</b></dt>
2070   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2071       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2072 </dl>
2073
2074 <p>The one non-intuitive notation for constants is the hexadecimal form of
2075    floating point constants.  For example, the form '<tt>double
2076    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2077    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2078    constants are required (and the only time that they are generated by the
2079    disassembler) is when a floating point constant must be emitted but it cannot
2080    be represented as a decimal floating point number in a reasonable number of
2081    digits.  For example, NaN's, infinities, and other special values are
2082    represented in their IEEE hexadecimal format so that assembly and disassembly
2083    do not cause any bits to change in the constants.</p>
2084
2085 <p>When using the hexadecimal form, constants of types float and double are
2086    represented using the 16-digit form shown above (which matches the IEEE754
2087    representation for double); float values must, however, be exactly
2088    representable as IEE754 single precision.  Hexadecimal format is always used
2089    for long double, and there are three forms of long double.  The 80-bit format
2090    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2091    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2092    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2093    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2094    currently supported target uses this format.  Long doubles will only work if
2095    they match the long double format on your target.  All hexadecimal formats
2096    are big-endian (sign bit at the left).</p>
2097
2098 <p>There are no constants of type x86mmx.</p>
2099 </div>
2100
2101 <!-- ======================================================================= -->
2102 <div class="doc_subsection">
2103 <a name="aggregateconstants"></a> <!-- old anchor -->
2104 <a name="complexconstants">Complex Constants</a>
2105 </div>
2106
2107 <div class="doc_text">
2108
2109 <p>Complex constants are a (potentially recursive) combination of simple
2110    constants and smaller complex constants.</p>
2111
2112 <dl>
2113   <dt><b>Structure constants</b></dt>
2114   <dd>Structure constants are represented with notation similar to structure
2115       type definitions (a comma separated list of elements, surrounded by braces
2116       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2117       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2118       Structure constants must have <a href="#t_struct">structure type</a>, and
2119       the number and types of elements must match those specified by the
2120       type.</dd>
2121
2122   <dt><b>Array constants</b></dt>
2123   <dd>Array constants are represented with notation similar to array type
2124      definitions (a comma separated list of elements, surrounded by square
2125      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2126      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2127      the number and types of elements must match those specified by the
2128      type.</dd>
2129
2130   <dt><b>Vector constants</b></dt>
2131   <dd>Vector constants are represented with notation similar to vector type
2132       definitions (a comma separated list of elements, surrounded by
2133       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2134       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2135       have <a href="#t_vector">vector type</a>, and the number and types of
2136       elements must match those specified by the type.</dd>
2137
2138   <dt><b>Zero initialization</b></dt>
2139   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2140       value to zero of <em>any</em> type, including scalar and
2141       <a href="#t_aggregate">aggregate</a> types.
2142       This is often used to avoid having to print large zero initializers
2143       (e.g. for large arrays) and is always exactly equivalent to using explicit
2144       zero initializers.</dd>
2145
2146   <dt><b>Metadata node</b></dt>
2147   <dd>A metadata node is a structure-like constant with
2148       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2149       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2150       be interpreted as part of the instruction stream, metadata is a place to
2151       attach additional information such as debug info.</dd>
2152 </dl>
2153
2154 </div>
2155
2156 <!-- ======================================================================= -->
2157 <div class="doc_subsection">
2158   <a name="globalconstants">Global Variable and Function Addresses</a>
2159 </div>
2160
2161 <div class="doc_text">
2162
2163 <p>The addresses of <a href="#globalvars">global variables</a>
2164    and <a href="#functionstructure">functions</a> are always implicitly valid
2165    (link-time) constants.  These constants are explicitly referenced when
2166    the <a href="#identifiers">identifier for the global</a> is used and always
2167    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2168    legal LLVM file:</p>
2169
2170 <pre class="doc_code">
2171 @X = global i32 17
2172 @Y = global i32 42
2173 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2174 </pre>
2175
2176 </div>
2177
2178 <!-- ======================================================================= -->
2179 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
2180 <div class="doc_text">
2181
2182 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2183    indicates that the user of the value may receive an unspecified bit-pattern.
2184    Undefined values may be of any type (other than '<tt>label</tt>'
2185    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2186
2187 <p>Undefined values are useful because they indicate to the compiler that the
2188    program is well defined no matter what value is used.  This gives the
2189    compiler more freedom to optimize.  Here are some examples of (potentially
2190    surprising) transformations that are valid (in pseudo IR):</p>
2191
2192
2193 <pre class="doc_code">
2194   %A = add %X, undef
2195   %B = sub %X, undef
2196   %C = xor %X, undef
2197 Safe:
2198   %A = undef
2199   %B = undef
2200   %C = undef
2201 </pre>
2202
2203 <p>This is safe because all of the output bits are affected by the undef bits.
2204    Any output bit can have a zero or one depending on the input bits.</p>
2205
2206 <pre class="doc_code">
2207   %A = or %X, undef
2208   %B = and %X, undef
2209 Safe:
2210   %A = -1
2211   %B = 0
2212 Unsafe:
2213   %A = undef
2214   %B = undef
2215 </pre>
2216
2217 <p>These logical operations have bits that are not always affected by the input.
2218    For example, if <tt>%X</tt> has a zero bit, then the output of the
2219    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2220    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2221    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2222    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2223    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2224    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2225    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2226
2227 <pre class="doc_code">
2228   %A = select undef, %X, %Y
2229   %B = select undef, 42, %Y
2230   %C = select %X, %Y, undef
2231 Safe:
2232   %A = %X     (or %Y)
2233   %B = 42     (or %Y)
2234   %C = %Y
2235 Unsafe:
2236   %A = undef
2237   %B = undef
2238   %C = undef
2239 </pre>
2240
2241 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2242    branch) conditions can go <em>either way</em>, but they have to come from one
2243    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2244    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2245    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2246    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2247    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2248    eliminated.</p>
2249
2250 <pre class="doc_code">
2251   %A = xor undef, undef
2252
2253   %B = undef
2254   %C = xor %B, %B
2255
2256   %D = undef
2257   %E = icmp lt %D, 4
2258   %F = icmp gte %D, 4
2259
2260 Safe:
2261   %A = undef
2262   %B = undef
2263   %C = undef
2264   %D = undef
2265   %E = undef
2266   %F = undef
2267 </pre>
2268
2269 <p>This example points out that two '<tt>undef</tt>' operands are not
2270    necessarily the same. This can be surprising to people (and also matches C
2271    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2272    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2273    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2274    its value over its "live range".  This is true because the variable doesn't
2275    actually <em>have a live range</em>. Instead, the value is logically read
2276    from arbitrary registers that happen to be around when needed, so the value
2277    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2278    need to have the same semantics or the core LLVM "replace all uses with"
2279    concept would not hold.</p>
2280
2281 <pre class="doc_code">
2282   %A = fdiv undef, %X
2283   %B = fdiv %X, undef
2284 Safe:
2285   %A = undef
2286 b: unreachable
2287 </pre>
2288
2289 <p>These examples show the crucial difference between an <em>undefined
2290   value</em> and <em>undefined behavior</em>. An undefined value (like
2291   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2292   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2293   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2294   defined on SNaN's. However, in the second example, we can make a more
2295   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2296   arbitrary value, we are allowed to assume that it could be zero. Since a
2297   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2298   the operation does not execute at all. This allows us to delete the divide and
2299   all code after it. Because the undefined operation "can't happen", the
2300   optimizer can assume that it occurs in dead code.</p>
2301
2302 <pre class="doc_code">
2303 a:  store undef -> %X
2304 b:  store %X -> undef
2305 Safe:
2306 a: &lt;deleted&gt;
2307 b: unreachable
2308 </pre>
2309
2310 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2311    undefined value can be assumed to not have any effect; we can assume that the
2312    value is overwritten with bits that happen to match what was already there.
2313    However, a store <em>to</em> an undefined location could clobber arbitrary
2314    memory, therefore, it has undefined behavior.</p>
2315
2316 </div>
2317
2318 <!-- ======================================================================= -->
2319 <div class="doc_subsection"><a name="trapvalues">Trap Values</a></div>
2320 <div class="doc_text">
2321
2322 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2323    instead of representing an unspecified bit pattern, they represent the
2324    fact that an instruction or constant expression which cannot evoke side
2325    effects has nevertheless detected a condition which results in undefined
2326    behavior.</p>
2327
2328 <p>There is currently no way of representing a trap value in the IR; they
2329    only exist when produced by operations such as
2330    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2331
2332 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2333
2334 <ul>
2335 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2336     their operands.</li>
2337
2338 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2339     to their dynamic predecessor basic block.</li>
2340
2341 <li>Function arguments depend on the corresponding actual argument values in
2342     the dynamic callers of their functions.</li>
2343
2344 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2345     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2346     control back to them.</li>
2347
2348 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2349     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2350     or exception-throwing call instructions that dynamically transfer control
2351     back to them.</li>
2352
2353 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2354     referenced memory addresses, following the order in the IR
2355     (including loads and stores implied by intrinsics such as
2356     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2357
2358 <!-- TODO: In the case of multiple threads, this only applies if the store
2359      "happens-before" the load or store. -->
2360
2361 <!-- TODO: floating-point exception state -->
2362
2363 <li>An instruction with externally visible side effects depends on the most
2364     recent preceding instruction with externally visible side effects, following
2365     the order in the IR. (This includes
2366     <a href="#volatile">volatile operations</a>.)</li>
2367
2368 <li>An instruction <i>control-depends</i> on a
2369     <a href="#terminators">terminator instruction</a>
2370     if the terminator instruction has multiple successors and the instruction
2371     is always executed when control transfers to one of the successors, and
2372     may not be executed when control is transfered to another.</li>
2373
2374 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2375     instruction if the set of instructions it otherwise depends on would be
2376     different if the terminator had transfered control to a different
2377     successor.</li>
2378
2379 <li>Dependence is transitive.</li>
2380
2381 </ul>
2382
2383 <p>Whenever a trap value is generated, all values which depend on it evaluate
2384    to trap. If they have side effects, the evoke their side effects as if each
2385    operand with a trap value were undef. If they have externally-visible side
2386    effects, the behavior is undefined.</p>
2387
2388 <p>Here are some examples:</p>
2389
2390 <pre class="doc_code">
2391 entry:
2392   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2393   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2394   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2395   store i32 0, i32* %trap_yet_again  ; undefined behavior
2396
2397   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2398   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2399
2400   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2401
2402   %narrowaddr = bitcast i32* @g to i16*
2403   %wideaddr = bitcast i32* @g to i64*
2404   %trap3 = load 16* %narrowaddr      ; Returns a trap value.
2405   %trap4 = load i64* %widaddr        ; Returns a trap value.
2406
2407   %cmp = icmp i32 slt %trap, 0       ; Returns a trap value.
2408   %br i1 %cmp, %true, %end           ; Branch to either destination.
2409
2410 true:
2411   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2412                                      ; it has undefined behavior.
2413   br label %end
2414
2415 end:
2416   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2417                                      ; Both edges into this PHI are
2418                                      ; control-dependent on %cmp, so this
2419                                      ; always results in a trap value.
2420
2421   volatile store i32 0, i32* @g      ; This would depend on the store in %true
2422                                      ; if %cmp is true, or the store in %entry
2423                                      ; otherwise, so this is undefined behavior.
2424
2425   %br i1 %cmp, %second_true, %second_end
2426                                      ; The same branch again, but this time the
2427                                      ; true block doesn't have side effects.
2428
2429 second_true:
2430   ; No side effects!
2431   br label %end
2432
2433 second_end:
2434   volatile store i32 0, i32* @g      ; This time, the instruction always depends
2435                                      ; on the store in %end. Also, it is
2436                                      ; control-equivalent to %end, so this is
2437                                      ; well- defined (again, ignoring earlier
2438                                      ; undefined behavior in this example).
2439 </pre>
2440
2441 </div>
2442
2443 <!-- ======================================================================= -->
2444 <div class="doc_subsection"><a name="blockaddress">Addresses of Basic
2445     Blocks</a></div>
2446 <div class="doc_text">
2447
2448 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2449
2450 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2451    basic block in the specified function, and always has an i8* type.  Taking
2452    the address of the entry block is illegal.</p>
2453
2454 <p>This value only has defined behavior when used as an operand to the
2455    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2456    comparisons against null. Pointer equality tests between labels addresses
2457    results in undefined behavior &mdash; though, again, comparison against null
2458    is ok, and no label is equal to the null pointer. This may be passed around
2459    as an opaque pointer sized value as long as the bits are not inspected. This
2460    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2461    long as the original value is reconstituted before the <tt>indirectbr</tt>
2462    instruction.</p>
2463
2464 <p>Finally, some targets may provide defined semantics when using the value as
2465    the operand to an inline assembly, but that is target specific.</p>
2466
2467 </div>
2468
2469
2470 <!-- ======================================================================= -->
2471 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
2472 </div>
2473
2474 <div class="doc_text">
2475
2476 <p>Constant expressions are used to allow expressions involving other constants
2477    to be used as constants.  Constant expressions may be of
2478    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2479    operation that does not have side effects (e.g. load and call are not
2480    supported). The following is the syntax for constant expressions:</p>
2481
2482 <dl>
2483   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2484   <dd>Truncate a constant to another type. The bit size of CST must be larger
2485       than the bit size of TYPE. Both types must be integers.</dd>
2486
2487   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2488   <dd>Zero extend a constant to another type. The bit size of CST must be
2489       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2490
2491   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2492   <dd>Sign extend a constant to another type. The bit size of CST must be
2493       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2494
2495   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2496   <dd>Truncate a floating point constant to another floating point type. The
2497       size of CST must be larger than the size of TYPE. Both types must be
2498       floating point.</dd>
2499
2500   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2501   <dd>Floating point extend a constant to another type. The size of CST must be
2502       smaller or equal to the size of TYPE. Both types must be floating
2503       point.</dd>
2504
2505   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2506   <dd>Convert a floating point constant to the corresponding unsigned integer
2507       constant. TYPE must be a scalar or vector integer type. CST must be of
2508       scalar or vector floating point type. Both CST and TYPE must be scalars,
2509       or vectors of the same number of elements. If the value won't fit in the
2510       integer type, the results are undefined.</dd>
2511
2512   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2513   <dd>Convert a floating point constant to the corresponding signed integer
2514       constant.  TYPE must be a scalar or vector integer type. CST must be of
2515       scalar or vector floating point type. Both CST and TYPE must be scalars,
2516       or vectors of the same number of elements. If the value won't fit in the
2517       integer type, the results are undefined.</dd>
2518
2519   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2520   <dd>Convert an unsigned integer constant to the corresponding floating point
2521       constant. TYPE must be a scalar or vector floating point type. CST must be
2522       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2523       vectors of the same number of elements. If the value won't fit in the
2524       floating point type, the results are undefined.</dd>
2525
2526   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2527   <dd>Convert a signed integer constant to the corresponding floating point
2528       constant. TYPE must be a scalar or vector floating point type. CST must be
2529       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2530       vectors of the same number of elements. If the value won't fit in the
2531       floating point type, the results are undefined.</dd>
2532
2533   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2534   <dd>Convert a pointer typed constant to the corresponding integer constant
2535       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2536       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2537       make it fit in <tt>TYPE</tt>.</dd>
2538
2539   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2540   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2541       type.  CST must be of integer type. The CST value is zero extended,
2542       truncated, or unchanged to make it fit in a pointer size. This one is
2543       <i>really</i> dangerous!</dd>
2544
2545   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2546   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2547       are the same as those for the <a href="#i_bitcast">bitcast
2548       instruction</a>.</dd>
2549
2550   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2551   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2552   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2553       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2554       instruction, the index list may have zero or more indexes, which are
2555       required to make sense for the type of "CSTPTR".</dd>
2556
2557   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2558   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2559
2560   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2561   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2562
2563   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2564   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2565
2566   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2567   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2568       constants.</dd>
2569
2570   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2571   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2572     constants.</dd>
2573
2574   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2575   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2576       constants.</dd>
2577
2578   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2579   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2580     constants. The index list is interpreted in a similar manner as indices in
2581     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2582     index value must be specified.</dd>
2583
2584   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2585   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2586     constants. The index list is interpreted in a similar manner as indices in
2587     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2588     index value must be specified.</dd>
2589
2590   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2591   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2592       be any of the <a href="#binaryops">binary</a>
2593       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2594       on operands are the same as those for the corresponding instruction
2595       (e.g. no bitwise operations on floating point values are allowed).</dd>
2596 </dl>
2597
2598 </div>
2599
2600 <!-- *********************************************************************** -->
2601 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
2602 <!-- *********************************************************************** -->
2603
2604 <!-- ======================================================================= -->
2605 <div class="doc_subsection">
2606 <a name="inlineasm">Inline Assembler Expressions</a>
2607 </div>
2608
2609 <div class="doc_text">
2610
2611 <p>LLVM supports inline assembler expressions (as opposed
2612    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2613    a special value.  This value represents the inline assembler as a string
2614    (containing the instructions to emit), a list of operand constraints (stored
2615    as a string), a flag that indicates whether or not the inline asm
2616    expression has side effects, and a flag indicating whether the function
2617    containing the asm needs to align its stack conservatively.  An example
2618    inline assembler expression is:</p>
2619
2620 <pre class="doc_code">
2621 i32 (i32) asm "bswap $0", "=r,r"
2622 </pre>
2623
2624 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2625    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2626    have:</p>
2627
2628 <pre class="doc_code">
2629 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2630 </pre>
2631
2632 <p>Inline asms with side effects not visible in the constraint list must be
2633    marked as having side effects.  This is done through the use of the
2634    '<tt>sideeffect</tt>' keyword, like so:</p>
2635
2636 <pre class="doc_code">
2637 call void asm sideeffect "eieio", ""()
2638 </pre>
2639
2640 <p>In some cases inline asms will contain code that will not work unless the
2641    stack is aligned in some way, such as calls or SSE instructions on x86,
2642    yet will not contain code that does that alignment within the asm.
2643    The compiler should make conservative assumptions about what the asm might
2644    contain and should generate its usual stack alignment code in the prologue
2645    if the '<tt>alignstack</tt>' keyword is present:</p>
2646
2647 <pre class="doc_code">
2648 call void asm alignstack "eieio", ""()
2649 </pre>
2650
2651 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2652    first.</p>
2653
2654 <p>TODO: The format of the asm and constraints string still need to be
2655    documented here.  Constraints on what can be done (e.g. duplication, moving,
2656    etc need to be documented).  This is probably best done by reference to
2657    another document that covers inline asm from a holistic perspective.</p>
2658 </div>
2659
2660 <div class="doc_subsubsection">
2661 <a name="inlineasm_md">Inline Asm Metadata</a>
2662 </div>
2663
2664 <div class="doc_text">
2665
2666 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2667    attached to it that contains a list of constant integers.  If present, the
2668   code generator will use the integer as the location cookie value when report
2669    errors through the LLVMContext error reporting mechanisms.  This allows a
2670    front-end to correlate backend errors that occur with inline asm back to the
2671    source code that produced it.  For example:</p>
2672
2673 <pre class="doc_code">
2674 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2675 ...
2676 !42 = !{ i32 1234567 }
2677 </pre>
2678
2679 <p>It is up to the front-end to make sense of the magic numbers it places in the
2680    IR.  If the MDNode contains multiple constants, the code generator will use
2681    the one that corresponds to the line of the asm that the error occurs on.</p>
2682
2683 </div>
2684
2685 <!-- ======================================================================= -->
2686 <div class="doc_subsection"><a name="metadata">Metadata Nodes and Metadata
2687   Strings</a>
2688 </div>
2689
2690 <div class="doc_text">
2691
2692 <p>LLVM IR allows metadata to be attached to instructions in the program that
2693    can convey extra information about the code to the optimizers and code
2694    generator.  One example application of metadata is source-level debug
2695    information.  There are two metadata primitives: strings and nodes. All
2696    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2697    preceding exclamation point ('<tt>!</tt>').</p>
2698
2699 <p>A metadata string is a string surrounded by double quotes.  It can contain
2700    any character by escaping non-printable characters with "\xx" where "xx" is
2701    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2702
2703 <p>Metadata nodes are represented with notation similar to structure constants
2704    (a comma separated list of elements, surrounded by braces and preceded by an
2705    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2706    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2707
2708 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2709    metadata nodes, which can be looked up in the module symbol table. For
2710    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2711
2712 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2713    function is using two metadata arguments.</p>
2714
2715 <div class="doc_code">
2716 <pre>
2717 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2718 </pre>
2719 </div>
2720
2721 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2722    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2723
2724 <div class="doc_code">
2725 <pre>
2726 %indvar.next = add i64 %indvar, 1, !dbg !21
2727 </pre>
2728 </div>
2729
2730 </div>
2731
2732
2733 <!-- *********************************************************************** -->
2734 <div class="doc_section">
2735   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2736 </div>
2737 <!-- *********************************************************************** -->
2738
2739 <p>LLVM has a number of "magic" global variables that contain data that affect
2740 code generation or other IR semantics.  These are documented here.  All globals
2741 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2742 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2743 by LLVM.</p>
2744
2745 <!-- ======================================================================= -->
2746 <div class="doc_subsection">
2747 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2748 </div>
2749
2750 <div class="doc_text">
2751
2752 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2753 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2754 pointers to global variables and functions which may optionally have a pointer
2755 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2756
2757 <pre>
2758   @X = global i8 4
2759   @Y = global i32 123
2760
2761   @llvm.used = appending global [2 x i8*] [
2762      i8* @X,
2763      i8* bitcast (i32* @Y to i8*)
2764   ], section "llvm.metadata"
2765 </pre>
2766
2767 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2768 compiler, assembler, and linker are required to treat the symbol as if there is
2769 a reference to the global that it cannot see.  For example, if a variable has
2770 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2771 list, it cannot be deleted.  This is commonly used to represent references from
2772 inline asms and other things the compiler cannot "see", and corresponds to
2773 "attribute((used))" in GNU C.</p>
2774
2775 <p>On some targets, the code generator must emit a directive to the assembler or
2776 object file to prevent the assembler and linker from molesting the symbol.</p>
2777
2778 </div>
2779
2780 <!-- ======================================================================= -->
2781 <div class="doc_subsection">
2782 <a name="intg_compiler_used">The '<tt>llvm.compiler.used</tt>' Global Variable</a>
2783 </div>
2784
2785 <div class="doc_text">
2786
2787 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2788 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2789 touching the symbol.  On targets that support it, this allows an intelligent
2790 linker to optimize references to the symbol without being impeded as it would be
2791 by <tt>@llvm.used</tt>.</p>
2792
2793 <p>This is a rare construct that should only be used in rare circumstances, and
2794 should not be exposed to source languages.</p>
2795
2796 </div>
2797
2798 <!-- ======================================================================= -->
2799 <div class="doc_subsection">
2800 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2801 </div>
2802
2803 <div class="doc_text">
2804 <pre>
2805 %0 = type { i32, void ()* }
2806 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2807 </pre>
2808 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor functions and associated priorities.  The functions referenced by this array will be called in ascending order of priority (i.e. lowest first) when the module is loaded.  The order of functions with the same priority is not defined.
2809 </p>
2810
2811 </div>
2812
2813 <!-- ======================================================================= -->
2814 <div class="doc_subsection">
2815 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2816 </div>
2817
2818 <div class="doc_text">
2819 <pre>
2820 %0 = type { i32, void ()* }
2821 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2822 </pre>
2823
2824 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions and associated priorities.  The functions referenced by this array will be called in descending order of priority (i.e. highest first) when the module is loaded.  The order of functions with the same priority is not defined.
2825 </p>
2826
2827 </div>
2828
2829
2830 <!-- *********************************************************************** -->
2831 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
2832 <!-- *********************************************************************** -->
2833
2834 <div class="doc_text">
2835
2836 <p>The LLVM instruction set consists of several different classifications of
2837    instructions: <a href="#terminators">terminator
2838    instructions</a>, <a href="#binaryops">binary instructions</a>,
2839    <a href="#bitwiseops">bitwise binary instructions</a>,
2840    <a href="#memoryops">memory instructions</a>, and
2841    <a href="#otherops">other instructions</a>.</p>
2842
2843 </div>
2844
2845 <!-- ======================================================================= -->
2846 <div class="doc_subsection"> <a name="terminators">Terminator
2847 Instructions</a> </div>
2848
2849 <div class="doc_text">
2850
2851 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
2852    in a program ends with a "Terminator" instruction, which indicates which
2853    block should be executed after the current block is finished. These
2854    terminator instructions typically yield a '<tt>void</tt>' value: they produce
2855    control flow, not values (the one exception being the
2856    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
2857
2858 <p>There are seven different terminator instructions: the
2859    '<a href="#i_ret"><tt>ret</tt></a>' instruction, the
2860    '<a href="#i_br"><tt>br</tt></a>' instruction, the
2861    '<a href="#i_switch"><tt>switch</tt></a>' instruction, the
2862    '<a href="#i_indirectbr">'<tt>indirectbr</tt></a>' Instruction, the
2863    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the
2864    '<a href="#i_unwind"><tt>unwind</tt></a>' instruction, and the
2865    '<a href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
2866
2867 </div>
2868
2869 <!-- _______________________________________________________________________ -->
2870 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
2871 Instruction</a> </div>
2872
2873 <div class="doc_text">
2874
2875 <h5>Syntax:</h5>
2876 <pre>
2877   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
2878   ret void                 <i>; Return from void function</i>
2879 </pre>
2880
2881 <h5>Overview:</h5>
2882 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
2883    a value) from a function back to the caller.</p>
2884
2885 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
2886    value and then causes control flow, and one that just causes control flow to
2887    occur.</p>
2888
2889 <h5>Arguments:</h5>
2890 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
2891    return value. The type of the return value must be a
2892    '<a href="#t_firstclass">first class</a>' type.</p>
2893
2894 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
2895    non-void return type and contains a '<tt>ret</tt>' instruction with no return
2896    value or a return value with a type that does not match its type, or if it
2897    has a void return type and contains a '<tt>ret</tt>' instruction with a
2898    return value.</p>
2899
2900 <h5>Semantics:</h5>
2901 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
2902    the calling function's context.  If the caller is a
2903    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
2904    instruction after the call.  If the caller was an
2905    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
2906    the beginning of the "normal" destination block.  If the instruction returns
2907    a value, that value shall set the call or invoke instruction's return
2908    value.</p>
2909
2910 <h5>Example:</h5>
2911 <pre>
2912   ret i32 5                       <i>; Return an integer value of 5</i>
2913   ret void                        <i>; Return from a void function</i>
2914   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
2915 </pre>
2916
2917 </div>
2918 <!-- _______________________________________________________________________ -->
2919 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
2920
2921 <div class="doc_text">
2922
2923 <h5>Syntax:</h5>
2924 <pre>
2925   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
2926 </pre>
2927
2928 <h5>Overview:</h5>
2929 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
2930    different basic block in the current function.  There are two forms of this
2931    instruction, corresponding to a conditional branch and an unconditional
2932    branch.</p>
2933
2934 <h5>Arguments:</h5>
2935 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
2936    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
2937    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
2938    target.</p>
2939
2940 <h5>Semantics:</h5>
2941 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
2942    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
2943    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
2944    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
2945
2946 <h5>Example:</h5>
2947 <pre>
2948 Test:
2949   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
2950   br i1 %cond, label %IfEqual, label %IfUnequal
2951 IfEqual:
2952   <a href="#i_ret">ret</a> i32 1
2953 IfUnequal:
2954   <a href="#i_ret">ret</a> i32 0
2955 </pre>
2956
2957 </div>
2958
2959 <!-- _______________________________________________________________________ -->
2960 <div class="doc_subsubsection">
2961    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
2962 </div>
2963
2964 <div class="doc_text">
2965
2966 <h5>Syntax:</h5>
2967 <pre>
2968   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
2969 </pre>
2970
2971 <h5>Overview:</h5>
2972 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
2973    several different places.  It is a generalization of the '<tt>br</tt>'
2974    instruction, allowing a branch to occur to one of many possible
2975    destinations.</p>
2976
2977 <h5>Arguments:</h5>
2978 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
2979    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
2980    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
2981    The table is not allowed to contain duplicate constant entries.</p>
2982
2983 <h5>Semantics:</h5>
2984 <p>The <tt>switch</tt> instruction specifies a table of values and
2985    destinations. When the '<tt>switch</tt>' instruction is executed, this table
2986    is searched for the given value.  If the value is found, control flow is
2987    transferred to the corresponding destination; otherwise, control flow is
2988    transferred to the default destination.</p>
2989
2990 <h5>Implementation:</h5>
2991 <p>Depending on properties of the target machine and the particular
2992    <tt>switch</tt> instruction, this instruction may be code generated in
2993    different ways.  For example, it could be generated as a series of chained
2994    conditional branches or with a lookup table.</p>
2995
2996 <h5>Example:</h5>
2997 <pre>
2998  <i>; Emulate a conditional br instruction</i>
2999  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3000  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3001
3002  <i>; Emulate an unconditional br instruction</i>
3003  switch i32 0, label %dest [ ]
3004
3005  <i>; Implement a jump table:</i>
3006  switch i32 %val, label %otherwise [ i32 0, label %onzero
3007                                      i32 1, label %onone
3008                                      i32 2, label %ontwo ]
3009 </pre>
3010
3011 </div>
3012
3013
3014 <!-- _______________________________________________________________________ -->
3015 <div class="doc_subsubsection">
3016    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3017 </div>
3018
3019 <div class="doc_text">
3020
3021 <h5>Syntax:</h5>
3022 <pre>
3023   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3024 </pre>
3025
3026 <h5>Overview:</h5>
3027
3028 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3029    within the current function, whose address is specified by
3030    "<tt>address</tt>".  Address must be derived from a <a
3031    href="#blockaddress">blockaddress</a> constant.</p>
3032
3033 <h5>Arguments:</h5>
3034
3035 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3036    rest of the arguments indicate the full set of possible destinations that the
3037    address may point to.  Blocks are allowed to occur multiple times in the
3038    destination list, though this isn't particularly useful.</p>
3039
3040 <p>This destination list is required so that dataflow analysis has an accurate
3041    understanding of the CFG.</p>
3042
3043 <h5>Semantics:</h5>
3044
3045 <p>Control transfers to the block specified in the address argument.  All
3046    possible destination blocks must be listed in the label list, otherwise this
3047    instruction has undefined behavior.  This implies that jumps to labels
3048    defined in other functions have undefined behavior as well.</p>
3049
3050 <h5>Implementation:</h5>
3051
3052 <p>This is typically implemented with a jump through a register.</p>
3053
3054 <h5>Example:</h5>
3055 <pre>
3056  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3057 </pre>
3058
3059 </div>
3060
3061
3062 <!-- _______________________________________________________________________ -->
3063 <div class="doc_subsubsection">
3064   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3065 </div>
3066
3067 <div class="doc_text">
3068
3069 <h5>Syntax:</h5>
3070 <pre>
3071   &lt;result&gt; = invoke [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] &lt;ptr to function ty&gt; &lt;function ptr val&gt;(&lt;function args&gt;) [<a href="#fnattrs">fn attrs</a>]
3072                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3073 </pre>
3074
3075 <h5>Overview:</h5>
3076 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3077    function, with the possibility of control flow transfer to either the
3078    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3079    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3080    control flow will return to the "normal" label.  If the callee (or any
3081    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3082    instruction, control is interrupted and continued at the dynamically nearest
3083    "exception" label.</p>
3084
3085 <h5>Arguments:</h5>
3086 <p>This instruction requires several arguments:</p>
3087
3088 <ol>
3089   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3090       convention</a> the call should use.  If none is specified, the call
3091       defaults to using C calling conventions.</li>
3092
3093   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3094       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3095       '<tt>inreg</tt>' attributes are valid here.</li>
3096
3097   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3098       function value being invoked.  In most cases, this is a direct function
3099       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3100       off an arbitrary pointer to function value.</li>
3101
3102   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3103       function to be invoked. </li>
3104
3105   <li>'<tt>function args</tt>': argument list whose types match the function
3106       signature argument types and parameter attributes. All arguments must be
3107       of <a href="#t_firstclass">first class</a> type. If the function
3108       signature indicates the function accepts a variable number of arguments,
3109       the extra arguments can be specified.</li>
3110
3111   <li>'<tt>normal label</tt>': the label reached when the called function
3112       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3113
3114   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3115       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3116
3117   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3118       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3119       '<tt>readnone</tt>' attributes are valid here.</li>
3120 </ol>
3121
3122 <h5>Semantics:</h5>
3123 <p>This instruction is designed to operate as a standard
3124    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3125    primary difference is that it establishes an association with a label, which
3126    is used by the runtime library to unwind the stack.</p>
3127
3128 <p>This instruction is used in languages with destructors to ensure that proper
3129    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3130    exception.  Additionally, this is important for implementation of
3131    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3132
3133 <p>For the purposes of the SSA form, the definition of the value returned by the
3134    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3135    block to the "normal" label. If the callee unwinds then no return value is
3136    available.</p>
3137
3138 <p>Note that the code generator does not yet completely support unwind, and
3139 that the invoke/unwind semantics are likely to change in future versions.</p>
3140
3141 <h5>Example:</h5>
3142 <pre>
3143   %retval = invoke i32 @Test(i32 15) to label %Continue
3144               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3145   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3146               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3147 </pre>
3148
3149 </div>
3150
3151 <!-- _______________________________________________________________________ -->
3152
3153 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
3154 Instruction</a> </div>
3155
3156 <div class="doc_text">
3157
3158 <h5>Syntax:</h5>
3159 <pre>
3160   unwind
3161 </pre>
3162
3163 <h5>Overview:</h5>
3164 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3165    at the first callee in the dynamic call stack which used
3166    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3167    This is primarily used to implement exception handling.</p>
3168
3169 <h5>Semantics:</h5>
3170 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3171    immediately halt.  The dynamic call stack is then searched for the
3172    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3173    Once found, execution continues at the "exceptional" destination block
3174    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3175    instruction in the dynamic call chain, undefined behavior results.</p>
3176
3177 <p>Note that the code generator does not yet completely support unwind, and
3178 that the invoke/unwind semantics are likely to change in future versions.</p>
3179
3180 </div>
3181
3182 <!-- _______________________________________________________________________ -->
3183
3184 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
3185 Instruction</a> </div>
3186
3187 <div class="doc_text">
3188
3189 <h5>Syntax:</h5>
3190 <pre>
3191   unreachable
3192 </pre>
3193
3194 <h5>Overview:</h5>
3195 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3196    instruction is used to inform the optimizer that a particular portion of the
3197    code is not reachable.  This can be used to indicate that the code after a
3198    no-return function cannot be reached, and other facts.</p>
3199
3200 <h5>Semantics:</h5>
3201 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3202
3203 </div>
3204
3205 <!-- ======================================================================= -->
3206 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
3207
3208 <div class="doc_text">
3209
3210 <p>Binary operators are used to do most of the computation in a program.  They
3211    require two operands of the same type, execute an operation on them, and
3212    produce a single value.  The operands might represent multiple data, as is
3213    the case with the <a href="#t_vector">vector</a> data type.  The result value
3214    has the same type as its operands.</p>
3215
3216 <p>There are several different binary operators:</p>
3217
3218 </div>
3219
3220 <!-- _______________________________________________________________________ -->
3221 <div class="doc_subsubsection">
3222   <a name="i_add">'<tt>add</tt>' Instruction</a>
3223 </div>
3224
3225 <div class="doc_text">
3226
3227 <h5>Syntax:</h5>
3228 <pre>
3229   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3230   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3231   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3232   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3233 </pre>
3234
3235 <h5>Overview:</h5>
3236 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3237
3238 <h5>Arguments:</h5>
3239 <p>The two arguments to the '<tt>add</tt>' instruction must
3240    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3241    integer values. Both arguments must have identical types.</p>
3242
3243 <h5>Semantics:</h5>
3244 <p>The value produced is the integer sum of the two operands.</p>
3245
3246 <p>If the sum has unsigned overflow, the result returned is the mathematical
3247    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3248
3249 <p>Because LLVM integers use a two's complement representation, this instruction
3250    is appropriate for both signed and unsigned integers.</p>
3251
3252 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3253    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3254    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3255    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3256    respectively, occurs.</p>
3257
3258 <h5>Example:</h5>
3259 <pre>
3260   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3261 </pre>
3262
3263 </div>
3264
3265 <!-- _______________________________________________________________________ -->
3266 <div class="doc_subsubsection">
3267   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3268 </div>
3269
3270 <div class="doc_text">
3271
3272 <h5>Syntax:</h5>
3273 <pre>
3274   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3275 </pre>
3276
3277 <h5>Overview:</h5>
3278 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3279
3280 <h5>Arguments:</h5>
3281 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3282    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3283    floating point values. Both arguments must have identical types.</p>
3284
3285 <h5>Semantics:</h5>
3286 <p>The value produced is the floating point sum of the two operands.</p>
3287
3288 <h5>Example:</h5>
3289 <pre>
3290   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3291 </pre>
3292
3293 </div>
3294
3295 <!-- _______________________________________________________________________ -->
3296 <div class="doc_subsubsection">
3297    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3298 </div>
3299
3300 <div class="doc_text">
3301
3302 <h5>Syntax:</h5>
3303 <pre>
3304   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3305   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3306   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3307   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3308 </pre>
3309
3310 <h5>Overview:</h5>
3311 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3312    operands.</p>
3313
3314 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3315    '<tt>neg</tt>' instruction present in most other intermediate
3316    representations.</p>
3317
3318 <h5>Arguments:</h5>
3319 <p>The two arguments to the '<tt>sub</tt>' instruction must
3320    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3321    integer values.  Both arguments must have identical types.</p>
3322
3323 <h5>Semantics:</h5>
3324 <p>The value produced is the integer difference of the two operands.</p>
3325
3326 <p>If the difference has unsigned overflow, the result returned is the
3327    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3328    result.</p>
3329
3330 <p>Because LLVM integers use a two's complement representation, this instruction
3331    is appropriate for both signed and unsigned integers.</p>
3332
3333 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3334    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3335    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3336    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3337    respectively, occurs.</p>
3338
3339 <h5>Example:</h5>
3340 <pre>
3341   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3342   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3343 </pre>
3344
3345 </div>
3346
3347 <!-- _______________________________________________________________________ -->
3348 <div class="doc_subsubsection">
3349    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3350 </div>
3351
3352 <div class="doc_text">
3353
3354 <h5>Syntax:</h5>
3355 <pre>
3356   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3357 </pre>
3358
3359 <h5>Overview:</h5>
3360 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3361    operands.</p>
3362
3363 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3364    '<tt>fneg</tt>' instruction present in most other intermediate
3365    representations.</p>
3366
3367 <h5>Arguments:</h5>
3368 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3369    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3370    floating point values.  Both arguments must have identical types.</p>
3371
3372 <h5>Semantics:</h5>
3373 <p>The value produced is the floating point difference of the two operands.</p>
3374
3375 <h5>Example:</h5>
3376 <pre>
3377   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3378   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3379 </pre>
3380
3381 </div>
3382
3383 <!-- _______________________________________________________________________ -->
3384 <div class="doc_subsubsection">
3385   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3386 </div>
3387
3388 <div class="doc_text">
3389
3390 <h5>Syntax:</h5>
3391 <pre>
3392   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3393   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3394   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3395   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3396 </pre>
3397
3398 <h5>Overview:</h5>
3399 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3400
3401 <h5>Arguments:</h5>
3402 <p>The two arguments to the '<tt>mul</tt>' instruction must
3403    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3404    integer values.  Both arguments must have identical types.</p>
3405
3406 <h5>Semantics:</h5>
3407 <p>The value produced is the integer product of the two operands.</p>
3408
3409 <p>If the result of the multiplication has unsigned overflow, the result
3410    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3411    width of the result.</p>
3412
3413 <p>Because LLVM integers use a two's complement representation, and the result
3414    is the same width as the operands, this instruction returns the correct
3415    result for both signed and unsigned integers.  If a full product
3416    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3417    be sign-extended or zero-extended as appropriate to the width of the full
3418    product.</p>
3419
3420 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3421    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3422    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3423    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3424    respectively, occurs.</p>
3425
3426 <h5>Example:</h5>
3427 <pre>
3428   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3429 </pre>
3430
3431 </div>
3432
3433 <!-- _______________________________________________________________________ -->
3434 <div class="doc_subsubsection">
3435   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3436 </div>
3437
3438 <div class="doc_text">
3439
3440 <h5>Syntax:</h5>
3441 <pre>
3442   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3443 </pre>
3444
3445 <h5>Overview:</h5>
3446 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3447
3448 <h5>Arguments:</h5>
3449 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3450    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3451    floating point values.  Both arguments must have identical types.</p>
3452
3453 <h5>Semantics:</h5>
3454 <p>The value produced is the floating point product of the two operands.</p>
3455
3456 <h5>Example:</h5>
3457 <pre>
3458   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3459 </pre>
3460
3461 </div>
3462
3463 <!-- _______________________________________________________________________ -->
3464 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
3465 </a></div>
3466
3467 <div class="doc_text">
3468
3469 <h5>Syntax:</h5>
3470 <pre>
3471   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3472   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3473 </pre>
3474
3475 <h5>Overview:</h5>
3476 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3477
3478 <h5>Arguments:</h5>
3479 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3480    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3481    values.  Both arguments must have identical types.</p>
3482
3483 <h5>Semantics:</h5>
3484 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3485
3486 <p>Note that unsigned integer division and signed integer division are distinct
3487    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3488
3489 <p>Division by zero leads to undefined behavior.</p>
3490
3491 <p>If the <tt>exact</tt> keyword is present, the result value of the
3492    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3493   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3494
3495
3496 <h5>Example:</h5>
3497 <pre>
3498   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3499 </pre>
3500
3501 </div>
3502
3503 <!-- _______________________________________________________________________ -->
3504 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
3505 </a> </div>
3506
3507 <div class="doc_text">
3508
3509 <h5>Syntax:</h5>
3510 <pre>
3511   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3512   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3513 </pre>
3514
3515 <h5>Overview:</h5>
3516 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3517
3518 <h5>Arguments:</h5>
3519 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3520    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3521    values.  Both arguments must have identical types.</p>
3522
3523 <h5>Semantics:</h5>
3524 <p>The value produced is the signed integer quotient of the two operands rounded
3525    towards zero.</p>
3526
3527 <p>Note that signed integer division and unsigned integer division are distinct
3528    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3529
3530 <p>Division by zero leads to undefined behavior. Overflow also leads to
3531    undefined behavior; this is a rare case, but can occur, for example, by doing
3532    a 32-bit division of -2147483648 by -1.</p>
3533
3534 <p>If the <tt>exact</tt> keyword is present, the result value of the
3535    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3536    be rounded.</p>
3537
3538 <h5>Example:</h5>
3539 <pre>
3540   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3541 </pre>
3542
3543 </div>
3544
3545 <!-- _______________________________________________________________________ -->
3546 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
3547 Instruction</a> </div>
3548
3549 <div class="doc_text">
3550
3551 <h5>Syntax:</h5>
3552 <pre>
3553   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3554 </pre>
3555
3556 <h5>Overview:</h5>
3557 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3558
3559 <h5>Arguments:</h5>
3560 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3561    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3562    floating point values.  Both arguments must have identical types.</p>
3563
3564 <h5>Semantics:</h5>
3565 <p>The value produced is the floating point quotient of the two operands.</p>
3566
3567 <h5>Example:</h5>
3568 <pre>
3569   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3570 </pre>
3571
3572 </div>
3573
3574 <!-- _______________________________________________________________________ -->
3575 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3576 </div>
3577
3578 <div class="doc_text">
3579
3580 <h5>Syntax:</h5>
3581 <pre>
3582   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3583 </pre>
3584
3585 <h5>Overview:</h5>
3586 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3587    division of its two arguments.</p>
3588
3589 <h5>Arguments:</h5>
3590 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3591    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3592    values.  Both arguments must have identical types.</p>
3593
3594 <h5>Semantics:</h5>
3595 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3596    This instruction always performs an unsigned division to get the
3597    remainder.</p>
3598
3599 <p>Note that unsigned integer remainder and signed integer remainder are
3600    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3601
3602 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3603
3604 <h5>Example:</h5>
3605 <pre>
3606   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3607 </pre>
3608
3609 </div>
3610
3611 <!-- _______________________________________________________________________ -->
3612 <div class="doc_subsubsection">
3613   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3614 </div>
3615
3616 <div class="doc_text">
3617
3618 <h5>Syntax:</h5>
3619 <pre>
3620   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3621 </pre>
3622
3623 <h5>Overview:</h5>
3624 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3625    division of its two operands. This instruction can also take
3626    <a href="#t_vector">vector</a> versions of the values in which case the
3627    elements must be integers.</p>
3628
3629 <h5>Arguments:</h5>
3630 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3631    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3632    values.  Both arguments must have identical types.</p>
3633
3634 <h5>Semantics:</h5>
3635 <p>This instruction returns the <i>remainder</i> of a division (where the result
3636    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3637    <i>modulo</i> operator (where the result is either zero or has the same sign
3638    as the divisor, <tt>op2</tt>) of a value.
3639    For more information about the difference,
3640    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3641    Math Forum</a>. For a table of how this is implemented in various languages,
3642    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3643    Wikipedia: modulo operation</a>.</p>
3644
3645 <p>Note that signed integer remainder and unsigned integer remainder are
3646    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3647
3648 <p>Taking the remainder of a division by zero leads to undefined behavior.
3649    Overflow also leads to undefined behavior; this is a rare case, but can
3650    occur, for example, by taking the remainder of a 32-bit division of
3651    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3652    lets srem be implemented using instructions that return both the result of
3653    the division and the remainder.)</p>
3654
3655 <h5>Example:</h5>
3656 <pre>
3657   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3658 </pre>
3659
3660 </div>
3661
3662 <!-- _______________________________________________________________________ -->
3663 <div class="doc_subsubsection">
3664   <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
3665
3666 <div class="doc_text">
3667
3668 <h5>Syntax:</h5>
3669 <pre>
3670   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3671 </pre>
3672
3673 <h5>Overview:</h5>
3674 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3675    its two operands.</p>
3676
3677 <h5>Arguments:</h5>
3678 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3679    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3680    floating point values.  Both arguments must have identical types.</p>
3681
3682 <h5>Semantics:</h5>
3683 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3684    has the same sign as the dividend.</p>
3685
3686 <h5>Example:</h5>
3687 <pre>
3688   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3689 </pre>
3690
3691 </div>
3692
3693 <!-- ======================================================================= -->
3694 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
3695 Operations</a> </div>
3696
3697 <div class="doc_text">
3698
3699 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3700    program.  They are generally very efficient instructions and can commonly be
3701    strength reduced from other instructions.  They require two operands of the
3702    same type, execute an operation on them, and produce a single value.  The
3703    resulting value is the same type as its operands.</p>
3704
3705 </div>
3706
3707 <!-- _______________________________________________________________________ -->
3708 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
3709 Instruction</a> </div>
3710
3711 <div class="doc_text">
3712
3713 <h5>Syntax:</h5>
3714 <pre>
3715   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3716   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3717   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3718   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3719 </pre>
3720
3721 <h5>Overview:</h5>
3722 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3723    a specified number of bits.</p>
3724
3725 <h5>Arguments:</h5>
3726 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3727     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3728     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3729
3730 <h5>Semantics:</h5>
3731 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3732    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3733    is (statically or dynamically) negative or equal to or larger than the number
3734    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3735    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3736    shift amount in <tt>op2</tt>.</p>
3737
3738 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3739    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3740    the <tt>nsw</tt> keyword is present, then the shift produces a
3741    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3742    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3743    they would if the shift were expressed as a mul instruction with the same
3744    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3745
3746 <h5>Example:</h5>
3747 <pre>
3748   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3749   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3750   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3751   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3752   &lt;result&gt; = shl &lt;2 x i32&gt; &lt; i32 1, i32 1&gt;, &lt; i32 1, i32 2&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 2, i32 4&gt;</i>
3753 </pre>
3754
3755 </div>
3756
3757 <!-- _______________________________________________________________________ -->
3758 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
3759 Instruction</a> </div>
3760
3761 <div class="doc_text">
3762
3763 <h5>Syntax:</h5>
3764 <pre>
3765   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3766   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3767 </pre>
3768
3769 <h5>Overview:</h5>
3770 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
3771    operand shifted to the right a specified number of bits with zero fill.</p>
3772
3773 <h5>Arguments:</h5>
3774 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
3775    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3776    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
3777
3778 <h5>Semantics:</h5>
3779 <p>This instruction always performs a logical shift right operation. The most
3780    significant bits of the result will be filled with zero bits after the shift.
3781    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
3782    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
3783    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3784    shift amount in <tt>op2</tt>.</p>
3785
3786 <p>If the <tt>exact</tt> keyword is present, the result value of the
3787    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3788    shifted out are non-zero.</p>
3789
3790
3791 <h5>Example:</h5>
3792 <pre>
3793   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
3794   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
3795   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
3796   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
3797   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
3798   &lt;result&gt; = lshr &lt;2 x i32&gt; &lt; i32 -2, i32 4&gt;, &lt; i32 1, i32 2&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 0x7FFFFFFF, i32 1&gt;</i>
3799 </pre>
3800
3801 </div>
3802
3803 <!-- _______________________________________________________________________ -->
3804 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
3805 Instruction</a> </div>
3806 <div class="doc_text">
3807
3808 <h5>Syntax:</h5>
3809 <pre>
3810   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3811   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3812 </pre>
3813
3814 <h5>Overview:</h5>
3815 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
3816    operand shifted to the right a specified number of bits with sign
3817    extension.</p>
3818
3819 <h5>Arguments:</h5>
3820 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
3821    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3822    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3823
3824 <h5>Semantics:</h5>
3825 <p>This instruction always performs an arithmetic shift right operation, The
3826    most significant bits of the result will be filled with the sign bit
3827    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
3828    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
3829    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
3830    the corresponding shift amount in <tt>op2</tt>.</p>
3831
3832 <p>If the <tt>exact</tt> keyword is present, the result value of the
3833    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3834    shifted out are non-zero.</p>
3835
3836 <h5>Example:</h5>
3837 <pre>
3838   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
3839   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
3840   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
3841   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
3842   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
3843   &lt;result&gt; = ashr &lt;2 x i32&gt; &lt; i32 -2, i32 4&gt;, &lt; i32 1, i32 3&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 -1, i32 0&gt;</i>
3844 </pre>
3845
3846 </div>
3847
3848 <!-- _______________________________________________________________________ -->
3849 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
3850 Instruction</a> </div>
3851
3852 <div class="doc_text">
3853
3854 <h5>Syntax:</h5>
3855 <pre>
3856   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3857 </pre>
3858
3859 <h5>Overview:</h5>
3860 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
3861    operands.</p>
3862
3863 <h5>Arguments:</h5>
3864 <p>The two arguments to the '<tt>and</tt>' instruction must be
3865    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3866    values.  Both arguments must have identical types.</p>
3867
3868 <h5>Semantics:</h5>
3869 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
3870
3871 <table border="1" cellspacing="0" cellpadding="4">
3872   <tbody>
3873     <tr>
3874       <td>In0</td>
3875       <td>In1</td>
3876       <td>Out</td>
3877     </tr>
3878     <tr>
3879       <td>0</td>
3880       <td>0</td>
3881       <td>0</td>
3882     </tr>
3883     <tr>
3884       <td>0</td>
3885       <td>1</td>
3886       <td>0</td>
3887     </tr>
3888     <tr>
3889       <td>1</td>
3890       <td>0</td>
3891       <td>0</td>
3892     </tr>
3893     <tr>
3894       <td>1</td>
3895       <td>1</td>
3896       <td>1</td>
3897     </tr>
3898   </tbody>
3899 </table>
3900
3901 <h5>Example:</h5>
3902 <pre>
3903   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
3904   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
3905   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
3906 </pre>
3907 </div>
3908 <!-- _______________________________________________________________________ -->
3909 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
3910
3911 <div class="doc_text">
3912
3913 <h5>Syntax:</h5>
3914 <pre>
3915   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3916 </pre>
3917
3918 <h5>Overview:</h5>
3919 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
3920    two operands.</p>
3921
3922 <h5>Arguments:</h5>
3923 <p>The two arguments to the '<tt>or</tt>' instruction must be
3924    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3925    values.  Both arguments must have identical types.</p>
3926
3927 <h5>Semantics:</h5>
3928 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
3929
3930 <table border="1" cellspacing="0" cellpadding="4">
3931   <tbody>
3932     <tr>
3933       <td>In0</td>
3934       <td>In1</td>
3935       <td>Out</td>
3936     </tr>
3937     <tr>
3938       <td>0</td>
3939       <td>0</td>
3940       <td>0</td>
3941     </tr>
3942     <tr>
3943       <td>0</td>
3944       <td>1</td>
3945       <td>1</td>
3946     </tr>
3947     <tr>
3948       <td>1</td>
3949       <td>0</td>
3950       <td>1</td>
3951     </tr>
3952     <tr>
3953       <td>1</td>
3954       <td>1</td>
3955       <td>1</td>
3956     </tr>
3957   </tbody>
3958 </table>
3959
3960 <h5>Example:</h5>
3961 <pre>
3962   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
3963   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
3964   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
3965 </pre>
3966
3967 </div>
3968
3969 <!-- _______________________________________________________________________ -->
3970 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
3971 Instruction</a> </div>
3972
3973 <div class="doc_text">
3974
3975 <h5>Syntax:</h5>
3976 <pre>
3977   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3978 </pre>
3979
3980 <h5>Overview:</h5>
3981 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
3982    its two operands.  The <tt>xor</tt> is used to implement the "one's
3983    complement" operation, which is the "~" operator in C.</p>
3984
3985 <h5>Arguments:</h5>
3986 <p>The two arguments to the '<tt>xor</tt>' instruction must be
3987    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3988    values.  Both arguments must have identical types.</p>
3989
3990 <h5>Semantics:</h5>
3991 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
3992
3993 <table border="1" cellspacing="0" cellpadding="4">
3994   <tbody>
3995     <tr>
3996       <td>In0</td>
3997       <td>In1</td>
3998       <td>Out</td>
3999     </tr>
4000     <tr>
4001       <td>0</td>
4002       <td>0</td>
4003       <td>0</td>
4004     </tr>
4005     <tr>
4006       <td>0</td>
4007       <td>1</td>
4008       <td>1</td>
4009     </tr>
4010     <tr>
4011       <td>1</td>
4012       <td>0</td>
4013       <td>1</td>
4014     </tr>
4015     <tr>
4016       <td>1</td>
4017       <td>1</td>
4018       <td>0</td>
4019     </tr>
4020   </tbody>
4021 </table>
4022
4023 <h5>Example:</h5>
4024 <pre>
4025   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4026   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4027   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4028   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4029 </pre>
4030
4031 </div>
4032
4033 <!-- ======================================================================= -->
4034 <div class="doc_subsection">
4035   <a name="vectorops">Vector Operations</a>
4036 </div>
4037
4038 <div class="doc_text">
4039
4040 <p>LLVM supports several instructions to represent vector operations in a
4041    target-independent manner.  These instructions cover the element-access and
4042    vector-specific operations needed to process vectors effectively.  While LLVM
4043    does directly support these vector operations, many sophisticated algorithms
4044    will want to use target-specific intrinsics to take full advantage of a
4045    specific target.</p>
4046
4047 </div>
4048
4049 <!-- _______________________________________________________________________ -->
4050 <div class="doc_subsubsection">
4051    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4052 </div>
4053
4054 <div class="doc_text">
4055
4056 <h5>Syntax:</h5>
4057 <pre>
4058   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4059 </pre>
4060
4061 <h5>Overview:</h5>
4062 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4063    from a vector at a specified index.</p>
4064
4065
4066 <h5>Arguments:</h5>
4067 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4068    of <a href="#t_vector">vector</a> type.  The second operand is an index
4069    indicating the position from which to extract the element.  The index may be
4070    a variable.</p>
4071
4072 <h5>Semantics:</h5>
4073 <p>The result is a scalar of the same type as the element type of
4074    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4075    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4076    results are undefined.</p>
4077
4078 <h5>Example:</h5>
4079 <pre>
4080   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4081 </pre>
4082
4083 </div>
4084
4085 <!-- _______________________________________________________________________ -->
4086 <div class="doc_subsubsection">
4087    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4088 </div>
4089
4090 <div class="doc_text">
4091
4092 <h5>Syntax:</h5>
4093 <pre>
4094   &lt;result&gt; = insertelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt;, i32 &lt;idx&gt;    <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
4095 </pre>
4096
4097 <h5>Overview:</h5>
4098 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4099    vector at a specified index.</p>
4100
4101 <h5>Arguments:</h5>
4102 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4103    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4104    whose type must equal the element type of the first operand.  The third
4105    operand is an index indicating the position at which to insert the value.
4106    The index may be a variable.</p>
4107
4108 <h5>Semantics:</h5>
4109 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4110    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4111    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4112    results are undefined.</p>
4113
4114 <h5>Example:</h5>
4115 <pre>
4116   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4117 </pre>
4118
4119 </div>
4120
4121 <!-- _______________________________________________________________________ -->
4122 <div class="doc_subsubsection">
4123    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4124 </div>
4125
4126 <div class="doc_text">
4127
4128 <h5>Syntax:</h5>
4129 <pre>
4130   &lt;result&gt; = shufflevector &lt;n x &lt;ty&gt;&gt; &lt;v1&gt;, &lt;n x &lt;ty&gt;&gt; &lt;v2&gt;, &lt;m x i32&gt; &lt;mask&gt;    <i>; yields &lt;m x &lt;ty&gt;&gt;</i>
4131 </pre>
4132
4133 <h5>Overview:</h5>
4134 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4135    from two input vectors, returning a vector with the same element type as the
4136    input and length that is the same as the shuffle mask.</p>
4137
4138 <h5>Arguments:</h5>
4139 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4140    with types that match each other. The third argument is a shuffle mask whose
4141    element type is always 'i32'.  The result of the instruction is a vector
4142    whose length is the same as the shuffle mask and whose element type is the
4143    same as the element type of the first two operands.</p>
4144
4145 <p>The shuffle mask operand is required to be a constant vector with either
4146    constant integer or undef values.</p>
4147
4148 <h5>Semantics:</h5>
4149 <p>The elements of the two input vectors are numbered from left to right across
4150    both of the vectors.  The shuffle mask operand specifies, for each element of
4151    the result vector, which element of the two input vectors the result element
4152    gets.  The element selector may be undef (meaning "don't care") and the
4153    second operand may be undef if performing a shuffle from only one vector.</p>
4154
4155 <h5>Example:</h5>
4156 <pre>
4157   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4158                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4159   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4160                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i> - Identity shuffle.
4161   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4162                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4163   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4164                           &lt;8 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3, i32 4, i32 5, i32 6, i32 7 &gt;  <i>; yields &lt;8 x i32&gt;</i>
4165 </pre>
4166
4167 </div>
4168
4169 <!-- ======================================================================= -->
4170 <div class="doc_subsection">
4171   <a name="aggregateops">Aggregate Operations</a>
4172 </div>
4173
4174 <div class="doc_text">
4175
4176 <p>LLVM supports several instructions for working with
4177   <a href="#t_aggregate">aggregate</a> values.</p>
4178
4179 </div>
4180
4181 <!-- _______________________________________________________________________ -->
4182 <div class="doc_subsubsection">
4183    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4184 </div>
4185
4186 <div class="doc_text">
4187
4188 <h5>Syntax:</h5>
4189 <pre>
4190   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4191 </pre>
4192
4193 <h5>Overview:</h5>
4194 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4195    from an <a href="#t_aggregate">aggregate</a> value.</p>
4196
4197 <h5>Arguments:</h5>
4198 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4199    of <a href="#t_struct">struct</a> or
4200    <a href="#t_array">array</a> type.  The operands are constant indices to
4201    specify which value to extract in a similar manner as indices in a
4202    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4203    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4204      <ul>
4205        <li>Since the value being indexed is not a pointer, the first index is
4206            omitted and assumed to be zero.</li>
4207        <li>At least one index must be specified.</li>
4208        <li>Not only struct indices but also array indices must be in
4209            bounds.</li>
4210      </ul>
4211
4212 <h5>Semantics:</h5>
4213 <p>The result is the value at the position in the aggregate specified by the
4214    index operands.</p>
4215
4216 <h5>Example:</h5>
4217 <pre>
4218   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4219 </pre>
4220
4221 </div>
4222
4223 <!-- _______________________________________________________________________ -->
4224 <div class="doc_subsubsection">
4225    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4226 </div>
4227
4228 <div class="doc_text">
4229
4230 <h5>Syntax:</h5>
4231 <pre>
4232   &lt;result&gt; = insertvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt;, &lt;idx&gt;    <i>; yields &lt;aggregate type&gt;</i>
4233 </pre>
4234
4235 <h5>Overview:</h5>
4236 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4237    in an <a href="#t_aggregate">aggregate</a> value.</p>
4238
4239 <h5>Arguments:</h5>
4240 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4241    of <a href="#t_struct">struct</a> or
4242    <a href="#t_array">array</a> type.  The second operand is a first-class
4243    value to insert.  The following operands are constant indices indicating
4244    the position at which to insert the value in a similar manner as indices in a
4245    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4246    value to insert must have the same type as the value identified by the
4247    indices.</p>
4248
4249 <h5>Semantics:</h5>
4250 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4251    that of <tt>val</tt> except that the value at the position specified by the
4252    indices is that of <tt>elt</tt>.</p>
4253
4254 <h5>Example:</h5>
4255 <pre>
4256   %agg1 = insertvalue {i32, float} undef, i32 1, 0         <i>; yields {i32 1, float undef}</i>
4257   %agg2 = insertvalue {i32, float} %agg1, float %val, 1    <i>; yields {i32 1, float %val}</i>
4258 </pre>
4259
4260 </div>
4261
4262
4263 <!-- ======================================================================= -->
4264 <div class="doc_subsection">
4265   <a name="memoryops">Memory Access and Addressing Operations</a>
4266 </div>
4267
4268 <div class="doc_text">
4269
4270 <p>A key design point of an SSA-based representation is how it represents
4271    memory.  In LLVM, no memory locations are in SSA form, which makes things
4272    very simple.  This section describes how to read, write, and allocate
4273    memory in LLVM.</p>
4274
4275 </div>
4276
4277 <!-- _______________________________________________________________________ -->
4278 <div class="doc_subsubsection">
4279   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4280 </div>
4281
4282 <div class="doc_text">
4283
4284 <h5>Syntax:</h5>
4285 <pre>
4286   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4287 </pre>
4288
4289 <h5>Overview:</h5>
4290 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4291    currently executing function, to be automatically released when this function
4292    returns to its caller. The object is always allocated in the generic address
4293    space (address space zero).</p>
4294
4295 <h5>Arguments:</h5>
4296 <p>The '<tt>alloca</tt>' instruction
4297    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4298    runtime stack, returning a pointer of the appropriate type to the program.
4299    If "NumElements" is specified, it is the number of elements allocated,
4300    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4301    specified, the value result of the allocation is guaranteed to be aligned to
4302    at least that boundary.  If not specified, or if zero, the target can choose
4303    to align the allocation on any convenient boundary compatible with the
4304    type.</p>
4305
4306 <p>'<tt>type</tt>' may be any sized type.</p>
4307
4308 <h5>Semantics:</h5>
4309 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4310    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4311    memory is automatically released when the function returns.  The
4312    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4313    variables that must have an address available.  When the function returns
4314    (either with the <tt><a href="#i_ret">ret</a></tt>
4315    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4316    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4317
4318 <h5>Example:</h5>
4319 <pre>
4320   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4321   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4322   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4323   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4324 </pre>
4325
4326 </div>
4327
4328 <!-- _______________________________________________________________________ -->
4329 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
4330 Instruction</a> </div>
4331
4332 <div class="doc_text">
4333
4334 <h5>Syntax:</h5>
4335 <pre>
4336   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4337   &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4338   !&lt;index&gt; = !{ i32 1 }
4339 </pre>
4340
4341 <h5>Overview:</h5>
4342 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4343
4344 <h5>Arguments:</h5>
4345 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4346    from which to load.  The pointer must point to
4347    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4348    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4349    number or order of execution of this <tt>load</tt> with other <a
4350    href="#volatile">volatile operations</a>.</p>
4351
4352 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4353    operation (that is, the alignment of the memory address). A value of 0 or an
4354    omitted <tt>align</tt> argument means that the operation has the preferential
4355    alignment for the target. It is the responsibility of the code emitter to
4356    ensure that the alignment information is correct. Overestimating the
4357    alignment results in undefined behavior. Underestimating the alignment may
4358    produce less efficient code. An alignment of 1 is always safe.</p>
4359
4360 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4361    metatadata name &lt;index&gt; corresponding to a metadata node with
4362    one <tt>i32</tt> entry of value 1.  The existence of
4363    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4364    and code generator that this load is not expected to be reused in the cache.
4365    The code generator may select special instructions to save cache bandwidth,
4366    such as the <tt>MOVNT</tt> instruction on x86.</p>
4367
4368 <h5>Semantics:</h5>
4369 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4370    scalar type then the number of bytes read does not exceed the minimum number
4371    of bytes needed to hold all bits of the type.  For example, loading an
4372    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4373    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4374    is undefined if the value was not originally written using a store of the
4375    same type.</p>
4376
4377 <h5>Examples:</h5>
4378 <pre>
4379   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4380   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4381   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4382 </pre>
4383
4384 </div>
4385
4386 <!-- _______________________________________________________________________ -->
4387 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
4388 Instruction</a> </div>
4389
4390 <div class="doc_text">
4391
4392 <h5>Syntax:</h5>
4393 <pre>
4394   store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]                   <i>; yields {void}</i>
4395   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]          <i>; yields {void}</i>
4396 </pre>
4397
4398 <h5>Overview:</h5>
4399 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4400
4401 <h5>Arguments:</h5>
4402 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4403    and an address at which to store it.  The type of the
4404    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4405    the <a href="#t_firstclass">first class</a> type of the
4406    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4407    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4408    order of execution of this <tt>store</tt> with other <a
4409    href="#volatile">volatile operations</a>.</p>
4410
4411 <p>The optional constant "align" argument specifies the alignment of the
4412    operation (that is, the alignment of the memory address). A value of 0 or an
4413    omitted "align" argument means that the operation has the preferential
4414    alignment for the target. It is the responsibility of the code emitter to
4415    ensure that the alignment information is correct. Overestimating the
4416    alignment results in an undefined behavior. Underestimating the alignment may
4417    produce less efficient code. An alignment of 1 is always safe.</p>
4418
4419 <p>The optional !nontemporal metadata must reference a single metatadata
4420    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4421    value 1.  The existence of the !nontemporal metatadata on the
4422    instruction tells the optimizer and code generator that this load is
4423    not expected to be reused in the cache.  The code generator may
4424    select special instructions to save cache bandwidth, such as the
4425    MOVNT instruction on x86.</p>
4426
4427
4428 <h5>Semantics:</h5>
4429 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4430    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4431    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4432    does not exceed the minimum number of bytes needed to hold all bits of the
4433    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4434    writing a value of a type like <tt>i20</tt> with a size that is not an
4435    integral number of bytes, it is unspecified what happens to the extra bits
4436    that do not belong to the type, but they will typically be overwritten.</p>
4437
4438 <h5>Example:</h5>
4439 <pre>
4440   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4441   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4442   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4443 </pre>
4444
4445 </div>
4446
4447 <!-- _______________________________________________________________________ -->
4448 <div class="doc_subsubsection">
4449    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4450 </div>
4451
4452 <div class="doc_text">
4453
4454 <h5>Syntax:</h5>
4455 <pre>
4456   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4457   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4458 </pre>
4459
4460 <h5>Overview:</h5>
4461 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4462    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4463    It performs address calculation only and does not access memory.</p>
4464
4465 <h5>Arguments:</h5>
4466 <p>The first argument is always a pointer, and forms the basis of the
4467    calculation. The remaining arguments are indices that indicate which of the
4468    elements of the aggregate object are indexed. The interpretation of each
4469    index is dependent on the type being indexed into. The first index always
4470    indexes the pointer value given as the first argument, the second index
4471    indexes a value of the type pointed to (not necessarily the value directly
4472    pointed to, since the first index can be non-zero), etc. The first type
4473    indexed into must be a pointer value, subsequent types can be arrays,
4474    vectors, and structs. Note that subsequent types being indexed into
4475    can never be pointers, since that would require loading the pointer before
4476    continuing calculation.</p>
4477
4478 <p>The type of each index argument depends on the type it is indexing into.
4479    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4480    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4481    or vector, integers of any width are allowed, and they are not required to be
4482    constant.</p>
4483
4484 <p>For example, let's consider a C code fragment and how it gets compiled to
4485    LLVM:</p>
4486
4487 <pre class="doc_code">
4488 struct RT {
4489   char A;
4490   int B[10][20];
4491   char C;
4492 };
4493 struct ST {
4494   int X;
4495   double Y;
4496   struct RT Z;
4497 };
4498
4499 int *foo(struct ST *s) {
4500   return &amp;s[1].Z.B[5][13];
4501 }
4502 </pre>
4503
4504 <p>The LLVM code generated by the GCC frontend is:</p>
4505
4506 <pre class="doc_code">
4507 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4508 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4509
4510 define i32* @foo(%ST* %s) {
4511 entry:
4512   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4513   ret i32* %reg
4514 }
4515 </pre>
4516
4517 <h5>Semantics:</h5>
4518 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4519    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4520    }</tt>' type, a structure.  The second index indexes into the third element
4521    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4522    i8 }</tt>' type, another structure.  The third index indexes into the second
4523    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4524    array.  The two dimensions of the array are subscripted into, yielding an
4525    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4526    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4527
4528 <p>Note that it is perfectly legal to index partially through a structure,
4529    returning a pointer to an inner element.  Because of this, the LLVM code for
4530    the given testcase is equivalent to:</p>
4531
4532 <pre>
4533   define i32* @foo(%ST* %s) {
4534     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
4535     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
4536     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
4537     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
4538     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
4539     ret i32* %t5
4540   }
4541 </pre>
4542
4543 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
4544    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
4545    base pointer is not an <i>in bounds</i> address of an allocated object,
4546    or if any of the addresses that would be formed by successive addition of
4547    the offsets implied by the indices to the base address with infinitely
4548    precise arithmetic are not an <i>in bounds</i> address of that allocated
4549    object. The <i>in bounds</i> addresses for an allocated object are all
4550    the addresses that point into the object, plus the address one byte past
4551    the end.</p>
4552
4553 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
4554    the base address with silently-wrapping two's complement arithmetic, and
4555    the result value of the <tt>getelementptr</tt> may be outside the object
4556    pointed to by the base pointer. The result value may not necessarily be
4557    used to access memory though, even if it happens to point into allocated
4558    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
4559    section for more information.</p>
4560
4561 <p>The getelementptr instruction is often confusing.  For some more insight into
4562    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
4563
4564 <h5>Example:</h5>
4565 <pre>
4566     <i>; yields [12 x i8]*:aptr</i>
4567     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
4568     <i>; yields i8*:vptr</i>
4569     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
4570     <i>; yields i8*:eptr</i>
4571     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
4572     <i>; yields i32*:iptr</i>
4573     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
4574 </pre>
4575
4576 </div>
4577
4578 <!-- ======================================================================= -->
4579 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
4580 </div>
4581
4582 <div class="doc_text">
4583
4584 <p>The instructions in this category are the conversion instructions (casting)
4585    which all take a single operand and a type. They perform various bit
4586    conversions on the operand.</p>
4587
4588 </div>
4589
4590 <!-- _______________________________________________________________________ -->
4591 <div class="doc_subsubsection">
4592    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
4593 </div>
4594 <div class="doc_text">
4595
4596 <h5>Syntax:</h5>
4597 <pre>
4598   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4599 </pre>
4600
4601 <h5>Overview:</h5>
4602 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
4603    type <tt>ty2</tt>.</p>
4604
4605 <h5>Arguments:</h5>
4606 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
4607    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4608    of the same number of integers.
4609    The bit size of the <tt>value</tt> must be larger than
4610    the bit size of the destination type, <tt>ty2</tt>.
4611    Equal sized types are not allowed.</p>
4612
4613 <h5>Semantics:</h5>
4614 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
4615    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
4616    source size must be larger than the destination size, <tt>trunc</tt> cannot
4617    be a <i>no-op cast</i>.  It will always truncate bits.</p>
4618
4619 <h5>Example:</h5>
4620 <pre>
4621   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
4622   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
4623   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
4624   %W = trunc &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i8&gt; <i>; yields &lt;i8 8, i8 7&gt;</i>
4625 </pre>
4626
4627 </div>
4628
4629 <!-- _______________________________________________________________________ -->
4630 <div class="doc_subsubsection">
4631    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
4632 </div>
4633 <div class="doc_text">
4634
4635 <h5>Syntax:</h5>
4636 <pre>
4637   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4638 </pre>
4639
4640 <h5>Overview:</h5>
4641 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
4642    <tt>ty2</tt>.</p>
4643
4644
4645 <h5>Arguments:</h5>
4646 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
4647    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4648    of the same number of integers.
4649    The bit size of the <tt>value</tt> must be smaller than
4650    the bit size of the destination type,
4651    <tt>ty2</tt>.</p>
4652
4653 <h5>Semantics:</h5>
4654 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
4655    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
4656
4657 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
4658
4659 <h5>Example:</h5>
4660 <pre>
4661   %X = zext i32 257 to i64              <i>; yields i64:257</i>
4662   %Y = zext i1 true to i32              <i>; yields i32:1</i>
4663   %Z = zext &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i32&gt; <i>; yields &lt;i32 8, i32 7&gt;</i>
4664 </pre>
4665
4666 </div>
4667
4668 <!-- _______________________________________________________________________ -->
4669 <div class="doc_subsubsection">
4670    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
4671 </div>
4672 <div class="doc_text">
4673
4674 <h5>Syntax:</h5>
4675 <pre>
4676   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4677 </pre>
4678
4679 <h5>Overview:</h5>
4680 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
4681
4682 <h5>Arguments:</h5>
4683 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
4684    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4685    of the same number of integers.
4686    The bit size of the <tt>value</tt> must be smaller than
4687    the bit size of the destination type,
4688    <tt>ty2</tt>.</p>
4689
4690 <h5>Semantics:</h5>
4691 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
4692    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
4693    of the type <tt>ty2</tt>.</p>
4694
4695 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
4696
4697 <h5>Example:</h5>
4698 <pre>
4699   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
4700   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
4701   %Z = sext &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i32&gt; <i>; yields &lt;i32 8, i32 7&gt;</i>
4702 </pre>
4703
4704 </div>
4705
4706 <!-- _______________________________________________________________________ -->
4707 <div class="doc_subsubsection">
4708    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
4709 </div>
4710
4711 <div class="doc_text">
4712
4713 <h5>Syntax:</h5>
4714 <pre>
4715   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4716 </pre>
4717
4718 <h5>Overview:</h5>
4719 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
4720    <tt>ty2</tt>.</p>
4721
4722 <h5>Arguments:</h5>
4723 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
4724    point</a> value to cast and a <a href="#t_floating">floating point</a> type
4725    to cast it to. The size of <tt>value</tt> must be larger than the size of
4726    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
4727    <i>no-op cast</i>.</p>
4728
4729 <h5>Semantics:</h5>
4730 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
4731    <a href="#t_floating">floating point</a> type to a smaller
4732    <a href="#t_floating">floating point</a> type.  If the value cannot fit
4733    within the destination type, <tt>ty2</tt>, then the results are
4734    undefined.</p>
4735
4736 <h5>Example:</h5>
4737 <pre>
4738   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
4739   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
4740 </pre>
4741
4742 </div>
4743
4744 <!-- _______________________________________________________________________ -->
4745 <div class="doc_subsubsection">
4746    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
4747 </div>
4748 <div class="doc_text">
4749
4750 <h5>Syntax:</h5>
4751 <pre>
4752   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4753 </pre>
4754
4755 <h5>Overview:</h5>
4756 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
4757    floating point value.</p>
4758
4759 <h5>Arguments:</h5>
4760 <p>The '<tt>fpext</tt>' instruction takes a
4761    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
4762    a <a href="#t_floating">floating point</a> type to cast it to. The source
4763    type must be smaller than the destination type.</p>
4764
4765 <h5>Semantics:</h5>
4766 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
4767    <a href="#t_floating">floating point</a> type to a larger
4768    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
4769    used to make a <i>no-op cast</i> because it always changes bits. Use
4770    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
4771
4772 <h5>Example:</h5>
4773 <pre>
4774   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
4775   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
4776 </pre>
4777
4778 </div>
4779
4780 <!-- _______________________________________________________________________ -->
4781 <div class="doc_subsubsection">
4782    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
4783 </div>
4784 <div class="doc_text">
4785
4786 <h5>Syntax:</h5>
4787 <pre>
4788   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4789 </pre>
4790
4791 <h5>Overview:</h5>
4792 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
4793    unsigned integer equivalent of type <tt>ty2</tt>.</p>
4794
4795 <h5>Arguments:</h5>
4796 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
4797    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4798    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4799    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4800    vector integer type with the same number of elements as <tt>ty</tt></p>
4801
4802 <h5>Semantics:</h5>
4803 <p>The '<tt>fptoui</tt>' instruction converts its
4804    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4805    towards zero) unsigned integer value. If the value cannot fit
4806    in <tt>ty2</tt>, the results are undefined.</p>
4807
4808 <h5>Example:</h5>
4809 <pre>
4810   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
4811   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
4812   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
4813 </pre>
4814
4815 </div>
4816
4817 <!-- _______________________________________________________________________ -->
4818 <div class="doc_subsubsection">
4819    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
4820 </div>
4821 <div class="doc_text">
4822
4823 <h5>Syntax:</h5>
4824 <pre>
4825   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4826 </pre>
4827
4828 <h5>Overview:</h5>
4829 <p>The '<tt>fptosi</tt>' instruction converts
4830    <a href="#t_floating">floating point</a> <tt>value</tt> to
4831    type <tt>ty2</tt>.</p>
4832
4833 <h5>Arguments:</h5>
4834 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
4835    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4836    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4837    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4838    vector integer type with the same number of elements as <tt>ty</tt></p>
4839
4840 <h5>Semantics:</h5>
4841 <p>The '<tt>fptosi</tt>' instruction converts its
4842    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4843    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
4844    the results are undefined.</p>
4845
4846 <h5>Example:</h5>
4847 <pre>
4848   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
4849   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
4850   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
4851 </pre>
4852
4853 </div>
4854
4855 <!-- _______________________________________________________________________ -->
4856 <div class="doc_subsubsection">
4857    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
4858 </div>
4859 <div class="doc_text">
4860
4861 <h5>Syntax:</h5>
4862 <pre>
4863   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4864 </pre>
4865
4866 <h5>Overview:</h5>
4867 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
4868    integer and converts that value to the <tt>ty2</tt> type.</p>
4869
4870 <h5>Arguments:</h5>
4871 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
4872    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4873    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4874    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4875    floating point type with the same number of elements as <tt>ty</tt></p>
4876
4877 <h5>Semantics:</h5>
4878 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
4879    integer quantity and converts it to the corresponding floating point
4880    value. If the value cannot fit in the floating point value, the results are
4881    undefined.</p>
4882
4883 <h5>Example:</h5>
4884 <pre>
4885   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
4886   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
4887 </pre>
4888
4889 </div>
4890
4891 <!-- _______________________________________________________________________ -->
4892 <div class="doc_subsubsection">
4893    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
4894 </div>
4895 <div class="doc_text">
4896
4897 <h5>Syntax:</h5>
4898 <pre>
4899   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4900 </pre>
4901
4902 <h5>Overview:</h5>
4903 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
4904    and converts that value to the <tt>ty2</tt> type.</p>
4905
4906 <h5>Arguments:</h5>
4907 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
4908    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4909    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4910    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4911    floating point type with the same number of elements as <tt>ty</tt></p>
4912
4913 <h5>Semantics:</h5>
4914 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
4915    quantity and converts it to the corresponding floating point value. If the
4916    value cannot fit in the floating point value, the results are undefined.</p>
4917
4918 <h5>Example:</h5>
4919 <pre>
4920   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
4921   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
4922 </pre>
4923
4924 </div>
4925
4926 <!-- _______________________________________________________________________ -->
4927 <div class="doc_subsubsection">
4928    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
4929 </div>
4930 <div class="doc_text">
4931
4932 <h5>Syntax:</h5>
4933 <pre>
4934   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4935 </pre>
4936
4937 <h5>Overview:</h5>
4938 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
4939    the integer type <tt>ty2</tt>.</p>
4940
4941 <h5>Arguments:</h5>
4942 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
4943    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
4944    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
4945
4946 <h5>Semantics:</h5>
4947 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
4948    <tt>ty2</tt> by interpreting the pointer value as an integer and either
4949    truncating or zero extending that value to the size of the integer type. If
4950    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
4951    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
4952    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
4953    change.</p>
4954
4955 <h5>Example:</h5>
4956 <pre>
4957   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
4958   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
4959 </pre>
4960
4961 </div>
4962
4963 <!-- _______________________________________________________________________ -->
4964 <div class="doc_subsubsection">
4965    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
4966 </div>
4967 <div class="doc_text">
4968
4969 <h5>Syntax:</h5>
4970 <pre>
4971   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4972 </pre>
4973
4974 <h5>Overview:</h5>
4975 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
4976    pointer type, <tt>ty2</tt>.</p>
4977
4978 <h5>Arguments:</h5>
4979 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
4980    value to cast, and a type to cast it to, which must be a
4981    <a href="#t_pointer">pointer</a> type.</p>
4982
4983 <h5>Semantics:</h5>
4984 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
4985    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
4986    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
4987    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
4988    than the size of a pointer then a zero extension is done. If they are the
4989    same size, nothing is done (<i>no-op cast</i>).</p>
4990
4991 <h5>Example:</h5>
4992 <pre>
4993   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
4994   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
4995   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
4996 </pre>
4997
4998 </div>
4999
5000 <!-- _______________________________________________________________________ -->
5001 <div class="doc_subsubsection">
5002    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5003 </div>
5004 <div class="doc_text">
5005
5006 <h5>Syntax:</h5>
5007 <pre>
5008   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5009 </pre>
5010
5011 <h5>Overview:</h5>
5012 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5013    <tt>ty2</tt> without changing any bits.</p>
5014
5015 <h5>Arguments:</h5>
5016 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5017    non-aggregate first class value, and a type to cast it to, which must also be
5018    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5019    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5020    identical. If the source type is a pointer, the destination type must also be
5021    a pointer.  This instruction supports bitwise conversion of vectors to
5022    integers and to vectors of other types (as long as they have the same
5023    size).</p>
5024
5025 <h5>Semantics:</h5>
5026 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5027    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5028    this conversion.  The conversion is done as if the <tt>value</tt> had been
5029    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5030    be converted to other pointer types with this instruction. To convert
5031    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5032    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5033
5034 <h5>Example:</h5>
5035 <pre>
5036   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5037   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5038   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5039 </pre>
5040
5041 </div>
5042
5043 <!-- ======================================================================= -->
5044 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
5045
5046 <div class="doc_text">
5047
5048 <p>The instructions in this category are the "miscellaneous" instructions, which
5049    defy better classification.</p>
5050
5051 </div>
5052
5053 <!-- _______________________________________________________________________ -->
5054 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5055 </div>
5056
5057 <div class="doc_text">
5058
5059 <h5>Syntax:</h5>
5060 <pre>
5061   &lt;result&gt; = icmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {i1} or {&lt;N x i1&gt;}:result</i>
5062 </pre>
5063
5064 <h5>Overview:</h5>
5065 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5066    boolean values based on comparison of its two integer, integer vector, or
5067    pointer operands.</p>
5068
5069 <h5>Arguments:</h5>
5070 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5071    the condition code indicating the kind of comparison to perform. It is not a
5072    value, just a keyword. The possible condition code are:</p>
5073
5074 <ol>
5075   <li><tt>eq</tt>: equal</li>
5076   <li><tt>ne</tt>: not equal </li>
5077   <li><tt>ugt</tt>: unsigned greater than</li>
5078   <li><tt>uge</tt>: unsigned greater or equal</li>
5079   <li><tt>ult</tt>: unsigned less than</li>
5080   <li><tt>ule</tt>: unsigned less or equal</li>
5081   <li><tt>sgt</tt>: signed greater than</li>
5082   <li><tt>sge</tt>: signed greater or equal</li>
5083   <li><tt>slt</tt>: signed less than</li>
5084   <li><tt>sle</tt>: signed less or equal</li>
5085 </ol>
5086
5087 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5088    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5089    typed.  They must also be identical types.</p>
5090
5091 <h5>Semantics:</h5>
5092 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5093    condition code given as <tt>cond</tt>. The comparison performed always yields
5094    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5095    result, as follows:</p>
5096
5097 <ol>
5098   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5099       <tt>false</tt> otherwise. No sign interpretation is necessary or
5100       performed.</li>
5101
5102   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5103       <tt>false</tt> otherwise. No sign interpretation is necessary or
5104       performed.</li>
5105
5106   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5107       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5108
5109   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5110       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5111       to <tt>op2</tt>.</li>
5112
5113   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5114       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5115
5116   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5117       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5118
5119   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5120       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5121
5122   <li><tt>sge</tt>: interprets the operands as signed values and yields
5123       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5124       to <tt>op2</tt>.</li>
5125
5126   <li><tt>slt</tt>: interprets the operands as signed values and yields
5127       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5128
5129   <li><tt>sle</tt>: interprets the operands as signed values and yields
5130       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5131 </ol>
5132
5133 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5134    values are compared as if they were integers.</p>
5135
5136 <p>If the operands are integer vectors, then they are compared element by
5137    element. The result is an <tt>i1</tt> vector with the same number of elements
5138    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5139
5140 <h5>Example:</h5>
5141 <pre>
5142   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5143   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5144   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5145   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5146   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5147   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5148 </pre>
5149
5150 <p>Note that the code generator does not yet support vector types with
5151    the <tt>icmp</tt> instruction.</p>
5152
5153 </div>
5154
5155 <!-- _______________________________________________________________________ -->
5156 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5157 </div>
5158
5159 <div class="doc_text">
5160
5161 <h5>Syntax:</h5>
5162 <pre>
5163   &lt;result&gt; = fcmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;     <i>; yields {i1} or {&lt;N x i1&gt;}:result</i>
5164 </pre>
5165
5166 <h5>Overview:</h5>
5167 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5168    values based on comparison of its operands.</p>
5169
5170 <p>If the operands are floating point scalars, then the result type is a boolean
5171 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5172
5173 <p>If the operands are floating point vectors, then the result type is a vector
5174    of boolean with the same number of elements as the operands being
5175    compared.</p>
5176
5177 <h5>Arguments:</h5>
5178 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5179    the condition code indicating the kind of comparison to perform. It is not a
5180    value, just a keyword. The possible condition code are:</p>
5181
5182 <ol>
5183   <li><tt>false</tt>: no comparison, always returns false</li>
5184   <li><tt>oeq</tt>: ordered and equal</li>
5185   <li><tt>ogt</tt>: ordered and greater than </li>
5186   <li><tt>oge</tt>: ordered and greater than or equal</li>
5187   <li><tt>olt</tt>: ordered and less than </li>
5188   <li><tt>ole</tt>: ordered and less than or equal</li>
5189   <li><tt>one</tt>: ordered and not equal</li>
5190   <li><tt>ord</tt>: ordered (no nans)</li>
5191   <li><tt>ueq</tt>: unordered or equal</li>
5192   <li><tt>ugt</tt>: unordered or greater than </li>
5193   <li><tt>uge</tt>: unordered or greater than or equal</li>
5194   <li><tt>ult</tt>: unordered or less than </li>
5195   <li><tt>ule</tt>: unordered or less than or equal</li>
5196   <li><tt>une</tt>: unordered or not equal</li>
5197   <li><tt>uno</tt>: unordered (either nans)</li>
5198   <li><tt>true</tt>: no comparison, always returns true</li>
5199 </ol>
5200
5201 <p><i>Ordered</i> means that neither operand is a QNAN while
5202    <i>unordered</i> means that either operand may be a QNAN.</p>
5203
5204 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5205    a <a href="#t_floating">floating point</a> type or
5206    a <a href="#t_vector">vector</a> of floating point type.  They must have
5207    identical types.</p>
5208
5209 <h5>Semantics:</h5>
5210 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5211    according to the condition code given as <tt>cond</tt>.  If the operands are
5212    vectors, then the vectors are compared element by element.  Each comparison
5213    performed always yields an <a href="#t_integer">i1</a> result, as
5214    follows:</p>
5215
5216 <ol>
5217   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5218
5219   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5220       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5221
5222   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5223       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5224
5225   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5226       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5227
5228   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5229       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5230
5231   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5232       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5233
5234   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5235       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5236
5237   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5238
5239   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5240       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5241
5242   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5243       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5244
5245   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5246       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5247
5248   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5249       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5250
5251   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5252       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5253
5254   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5255       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5256
5257   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5258
5259   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5260 </ol>
5261
5262 <h5>Example:</h5>
5263 <pre>
5264   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5265   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5266   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5267   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5268 </pre>
5269
5270 <p>Note that the code generator does not yet support vector types with
5271    the <tt>fcmp</tt> instruction.</p>
5272
5273 </div>
5274
5275 <!-- _______________________________________________________________________ -->
5276 <div class="doc_subsubsection">
5277   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5278 </div>
5279
5280 <div class="doc_text">
5281
5282 <h5>Syntax:</h5>
5283 <pre>
5284   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5285 </pre>
5286
5287 <h5>Overview:</h5>
5288 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5289    SSA graph representing the function.</p>
5290
5291 <h5>Arguments:</h5>
5292 <p>The type of the incoming values is specified with the first type field. After
5293    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5294    one pair for each predecessor basic block of the current block.  Only values
5295    of <a href="#t_firstclass">first class</a> type may be used as the value
5296    arguments to the PHI node.  Only labels may be used as the label
5297    arguments.</p>
5298
5299 <p>There must be no non-phi instructions between the start of a basic block and
5300    the PHI instructions: i.e. PHI instructions must be first in a basic
5301    block.</p>
5302
5303 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5304    occur on the edge from the corresponding predecessor block to the current
5305    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5306    value on the same edge).</p>
5307
5308 <h5>Semantics:</h5>
5309 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5310    specified by the pair corresponding to the predecessor basic block that
5311    executed just prior to the current block.</p>
5312
5313 <h5>Example:</h5>
5314 <pre>
5315 Loop:       ; Infinite loop that counts from 0 on up...
5316   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5317   %nextindvar = add i32 %indvar, 1
5318   br label %Loop
5319 </pre>
5320
5321 </div>
5322
5323 <!-- _______________________________________________________________________ -->
5324 <div class="doc_subsubsection">
5325    <a name="i_select">'<tt>select</tt>' Instruction</a>
5326 </div>
5327
5328 <div class="doc_text">
5329
5330 <h5>Syntax:</h5>
5331 <pre>
5332   &lt;result&gt; = select <i>selty</i> &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt;             <i>; yields ty</i>
5333
5334   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5335 </pre>
5336
5337 <h5>Overview:</h5>
5338 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5339    condition, without branching.</p>
5340
5341
5342 <h5>Arguments:</h5>
5343 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5344    values indicating the condition, and two values of the
5345    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5346    vectors and the condition is a scalar, then entire vectors are selected, not
5347    individual elements.</p>
5348
5349 <h5>Semantics:</h5>
5350 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5351    first value argument; otherwise, it returns the second value argument.</p>
5352
5353 <p>If the condition is a vector of i1, then the value arguments must be vectors
5354    of the same size, and the selection is done element by element.</p>
5355
5356 <h5>Example:</h5>
5357 <pre>
5358   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5359 </pre>
5360
5361 <p>Note that the code generator does not yet support conditions
5362    with vector type.</p>
5363
5364 </div>
5365
5366 <!-- _______________________________________________________________________ -->
5367 <div class="doc_subsubsection">
5368   <a name="i_call">'<tt>call</tt>' Instruction</a>
5369 </div>
5370
5371 <div class="doc_text">
5372
5373 <h5>Syntax:</h5>
5374 <pre>
5375   &lt;result&gt; = [tail] call [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] &lt;ty&gt; [&lt;fnty&gt;*] &lt;fnptrval&gt;(&lt;function args&gt;) [<a href="#fnattrs">fn attrs</a>]
5376 </pre>
5377
5378 <h5>Overview:</h5>
5379 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5380
5381 <h5>Arguments:</h5>
5382 <p>This instruction requires several arguments:</p>
5383
5384 <ol>
5385   <li>The optional "tail" marker indicates that the callee function does not
5386       access any allocas or varargs in the caller.  Note that calls may be
5387       marked "tail" even if they do not occur before
5388       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5389       present, the function call is eligible for tail call optimization,
5390       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5391       optimized into a jump</a>.  The code generator may optimize calls marked
5392       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5393       sibling call optimization</a> when the caller and callee have
5394       matching signatures, or 2) forced tail call optimization when the
5395       following extra requirements are met:
5396       <ul>
5397         <li>Caller and callee both have the calling
5398             convention <tt>fastcc</tt>.</li>
5399         <li>The call is in tail position (ret immediately follows call and ret
5400             uses value of call or is void).</li>
5401         <li>Option <tt>-tailcallopt</tt> is enabled,
5402             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5403         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5404             constraints are met.</a></li>
5405       </ul>
5406   </li>
5407
5408   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5409       convention</a> the call should use.  If none is specified, the call
5410       defaults to using C calling conventions.  The calling convention of the
5411       call must match the calling convention of the target function, or else the
5412       behavior is undefined.</li>
5413
5414   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5415       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5416       '<tt>inreg</tt>' attributes are valid here.</li>
5417
5418   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5419       type of the return value.  Functions that return no value are marked
5420       <tt><a href="#t_void">void</a></tt>.</li>
5421
5422   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5423       being invoked.  The argument types must match the types implied by this
5424       signature.  This type can be omitted if the function is not varargs and if
5425       the function type does not return a pointer to a function.</li>
5426
5427   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5428       be invoked. In most cases, this is a direct function invocation, but
5429       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5430       to function value.</li>
5431
5432   <li>'<tt>function args</tt>': argument list whose types match the function
5433       signature argument types and parameter attributes. All arguments must be
5434       of <a href="#t_firstclass">first class</a> type. If the function
5435       signature indicates the function accepts a variable number of arguments,
5436       the extra arguments can be specified.</li>
5437
5438   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5439       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5440       '<tt>readnone</tt>' attributes are valid here.</li>
5441 </ol>
5442
5443 <h5>Semantics:</h5>
5444 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5445    a specified function, with its incoming arguments bound to the specified
5446    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5447    function, control flow continues with the instruction after the function
5448    call, and the return value of the function is bound to the result
5449    argument.</p>
5450
5451 <h5>Example:</h5>
5452 <pre>
5453   %retval = call i32 @test(i32 %argc)
5454   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5455   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5456   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5457   call void %foo(i8 97 signext)
5458
5459   %struct.A = type { i32, i8 }
5460   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5461   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5462   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5463   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5464   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5465 </pre>
5466
5467 <p>llvm treats calls to some functions with names and arguments that match the
5468 standard C99 library as being the C99 library functions, and may perform
5469 optimizations or generate code for them under that assumption.  This is
5470 something we'd like to change in the future to provide better support for
5471 freestanding environments and non-C-based languages.</p>
5472
5473 </div>
5474
5475 <!-- _______________________________________________________________________ -->
5476 <div class="doc_subsubsection">
5477   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5478 </div>
5479
5480 <div class="doc_text">
5481
5482 <h5>Syntax:</h5>
5483 <pre>
5484   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5485 </pre>
5486
5487 <h5>Overview:</h5>
5488 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5489    the "variable argument" area of a function call.  It is used to implement the
5490    <tt>va_arg</tt> macro in C.</p>
5491
5492 <h5>Arguments:</h5>
5493 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5494    argument. It returns a value of the specified argument type and increments
5495    the <tt>va_list</tt> to point to the next argument.  The actual type
5496    of <tt>va_list</tt> is target specific.</p>
5497
5498 <h5>Semantics:</h5>
5499 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5500    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5501    to the next argument.  For more information, see the variable argument
5502    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5503
5504 <p>It is legal for this instruction to be called in a function which does not
5505    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5506    function.</p>
5507
5508 <p><tt>va_arg</tt> is an LLVM instruction instead of
5509    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5510    argument.</p>
5511
5512 <h5>Example:</h5>
5513 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
5514
5515 <p>Note that the code generator does not yet fully support va_arg on many
5516    targets. Also, it does not currently support va_arg with aggregate types on
5517    any target.</p>
5518
5519 </div>
5520
5521 <!-- *********************************************************************** -->
5522 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
5523 <!-- *********************************************************************** -->
5524
5525 <div class="doc_text">
5526
5527 <p>LLVM supports the notion of an "intrinsic function".  These functions have
5528    well known names and semantics and are required to follow certain
5529    restrictions.  Overall, these intrinsics represent an extension mechanism for
5530    the LLVM language that does not require changing all of the transformations
5531    in LLVM when adding to the language (or the bitcode reader/writer, the
5532    parser, etc...).</p>
5533
5534 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
5535    prefix is reserved in LLVM for intrinsic names; thus, function names may not
5536    begin with this prefix.  Intrinsic functions must always be external
5537    functions: you cannot define the body of intrinsic functions.  Intrinsic
5538    functions may only be used in call or invoke instructions: it is illegal to
5539    take the address of an intrinsic function.  Additionally, because intrinsic
5540    functions are part of the LLVM language, it is required if any are added that
5541    they be documented here.</p>
5542
5543 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
5544    family of functions that perform the same operation but on different data
5545    types. Because LLVM can represent over 8 million different integer types,
5546    overloading is used commonly to allow an intrinsic function to operate on any
5547    integer type. One or more of the argument types or the result type can be
5548    overloaded to accept any integer type. Argument types may also be defined as
5549    exactly matching a previous argument's type or the result type. This allows
5550    an intrinsic function which accepts multiple arguments, but needs all of them
5551    to be of the same type, to only be overloaded with respect to a single
5552    argument or the result.</p>
5553
5554 <p>Overloaded intrinsics will have the names of its overloaded argument types
5555    encoded into its function name, each preceded by a period. Only those types
5556    which are overloaded result in a name suffix. Arguments whose type is matched
5557    against another type do not. For example, the <tt>llvm.ctpop</tt> function
5558    can take an integer of any width and returns an integer of exactly the same
5559    integer width. This leads to a family of functions such as
5560    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
5561    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
5562    suffix is required. Because the argument's type is matched against the return
5563    type, it does not require its own name suffix.</p>
5564
5565 <p>To learn how to add an intrinsic function, please see the
5566    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
5567
5568 </div>
5569
5570 <!-- ======================================================================= -->
5571 <div class="doc_subsection">
5572   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
5573 </div>
5574
5575 <div class="doc_text">
5576
5577 <p>Variable argument support is defined in LLVM with
5578    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
5579    intrinsic functions.  These functions are related to the similarly named
5580    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
5581
5582 <p>All of these functions operate on arguments that use a target-specific value
5583    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
5584    not define what this type is, so all transformations should be prepared to
5585    handle these functions regardless of the type used.</p>
5586
5587 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
5588    instruction and the variable argument handling intrinsic functions are
5589    used.</p>
5590
5591 <pre class="doc_code">
5592 define i32 @test(i32 %X, ...) {
5593   ; Initialize variable argument processing
5594   %ap = alloca i8*
5595   %ap2 = bitcast i8** %ap to i8*
5596   call void @llvm.va_start(i8* %ap2)
5597
5598   ; Read a single integer argument
5599   %tmp = va_arg i8** %ap, i32
5600
5601   ; Demonstrate usage of llvm.va_copy and llvm.va_end
5602   %aq = alloca i8*
5603   %aq2 = bitcast i8** %aq to i8*
5604   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
5605   call void @llvm.va_end(i8* %aq2)
5606
5607   ; Stop processing of arguments.
5608   call void @llvm.va_end(i8* %ap2)
5609   ret i32 %tmp
5610 }
5611
5612 declare void @llvm.va_start(i8*)
5613 declare void @llvm.va_copy(i8*, i8*)
5614 declare void @llvm.va_end(i8*)
5615 </pre>
5616
5617 </div>
5618
5619 <!-- _______________________________________________________________________ -->
5620 <div class="doc_subsubsection">
5621   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
5622 </div>
5623
5624
5625 <div class="doc_text">
5626
5627 <h5>Syntax:</h5>
5628 <pre>
5629   declare void %llvm.va_start(i8* &lt;arglist&gt;)
5630 </pre>
5631
5632 <h5>Overview:</h5>
5633 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
5634    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
5635
5636 <h5>Arguments:</h5>
5637 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
5638
5639 <h5>Semantics:</h5>
5640 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
5641    macro available in C.  In a target-dependent way, it initializes
5642    the <tt>va_list</tt> element to which the argument points, so that the next
5643    call to <tt>va_arg</tt> will produce the first variable argument passed to
5644    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
5645    need to know the last argument of the function as the compiler can figure
5646    that out.</p>
5647
5648 </div>
5649
5650 <!-- _______________________________________________________________________ -->
5651 <div class="doc_subsubsection">
5652  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
5653 </div>
5654
5655 <div class="doc_text">
5656
5657 <h5>Syntax:</h5>
5658 <pre>
5659   declare void @llvm.va_end(i8* &lt;arglist&gt;)
5660 </pre>
5661
5662 <h5>Overview:</h5>
5663 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
5664    which has been initialized previously
5665    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
5666    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
5667
5668 <h5>Arguments:</h5>
5669 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
5670
5671 <h5>Semantics:</h5>
5672 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
5673    macro available in C.  In a target-dependent way, it destroys
5674    the <tt>va_list</tt> element to which the argument points.  Calls
5675    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
5676    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
5677    with calls to <tt>llvm.va_end</tt>.</p>
5678
5679 </div>
5680
5681 <!-- _______________________________________________________________________ -->
5682 <div class="doc_subsubsection">
5683   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
5684 </div>
5685
5686 <div class="doc_text">
5687
5688 <h5>Syntax:</h5>
5689 <pre>
5690   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
5691 </pre>
5692
5693 <h5>Overview:</h5>
5694 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
5695    from the source argument list to the destination argument list.</p>
5696
5697 <h5>Arguments:</h5>
5698 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
5699    The second argument is a pointer to a <tt>va_list</tt> element to copy
5700    from.</p>
5701
5702 <h5>Semantics:</h5>
5703 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
5704    macro available in C.  In a target-dependent way, it copies the
5705    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
5706    element.  This intrinsic is necessary because
5707    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
5708    arbitrarily complex and require, for example, memory allocation.</p>
5709
5710 </div>
5711
5712 <!-- ======================================================================= -->
5713 <div class="doc_subsection">
5714   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
5715 </div>
5716
5717 <div class="doc_text">
5718
5719 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
5720 Collection</a> (GC) requires the implementation and generation of these
5721 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
5722 roots on the stack</a>, as well as garbage collector implementations that
5723 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
5724 barriers.  Front-ends for type-safe garbage collected languages should generate
5725 these intrinsics to make use of the LLVM garbage collectors.  For more details,
5726 see <a href="GarbageCollection.html">Accurate Garbage Collection with
5727 LLVM</a>.</p>
5728
5729 <p>The garbage collection intrinsics only operate on objects in the generic
5730    address space (address space zero).</p>
5731
5732 </div>
5733
5734 <!-- _______________________________________________________________________ -->
5735 <div class="doc_subsubsection">
5736   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
5737 </div>
5738
5739 <div class="doc_text">
5740
5741 <h5>Syntax:</h5>
5742 <pre>
5743   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
5744 </pre>
5745
5746 <h5>Overview:</h5>
5747 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
5748    the code generator, and allows some metadata to be associated with it.</p>
5749
5750 <h5>Arguments:</h5>
5751 <p>The first argument specifies the address of a stack object that contains the
5752    root pointer.  The second pointer (which must be either a constant or a
5753    global value address) contains the meta-data to be associated with the
5754    root.</p>
5755
5756 <h5>Semantics:</h5>
5757 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
5758    location.  At compile-time, the code generator generates information to allow
5759    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
5760    intrinsic may only be used in a function which <a href="#gc">specifies a GC
5761    algorithm</a>.</p>
5762
5763 </div>
5764
5765 <!-- _______________________________________________________________________ -->
5766 <div class="doc_subsubsection">
5767   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
5768 </div>
5769
5770 <div class="doc_text">
5771
5772 <h5>Syntax:</h5>
5773 <pre>
5774   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
5775 </pre>
5776
5777 <h5>Overview:</h5>
5778 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
5779    locations, allowing garbage collector implementations that require read
5780    barriers.</p>
5781
5782 <h5>Arguments:</h5>
5783 <p>The second argument is the address to read from, which should be an address
5784    allocated from the garbage collector.  The first object is a pointer to the
5785    start of the referenced object, if needed by the language runtime (otherwise
5786    null).</p>
5787
5788 <h5>Semantics:</h5>
5789 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
5790    instruction, but may be replaced with substantially more complex code by the
5791    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
5792    may only be used in a function which <a href="#gc">specifies a GC
5793    algorithm</a>.</p>
5794
5795 </div>
5796
5797 <!-- _______________________________________________________________________ -->
5798 <div class="doc_subsubsection">
5799   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
5800 </div>
5801
5802 <div class="doc_text">
5803
5804 <h5>Syntax:</h5>
5805 <pre>
5806   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
5807 </pre>
5808
5809 <h5>Overview:</h5>
5810 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
5811    locations, allowing garbage collector implementations that require write
5812    barriers (such as generational or reference counting collectors).</p>
5813
5814 <h5>Arguments:</h5>
5815 <p>The first argument is the reference to store, the second is the start of the
5816    object to store it to, and the third is the address of the field of Obj to
5817    store to.  If the runtime does not require a pointer to the object, Obj may
5818    be null.</p>
5819
5820 <h5>Semantics:</h5>
5821 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
5822    instruction, but may be replaced with substantially more complex code by the
5823    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
5824    may only be used in a function which <a href="#gc">specifies a GC
5825    algorithm</a>.</p>
5826
5827 </div>
5828
5829 <!-- ======================================================================= -->
5830 <div class="doc_subsection">
5831   <a name="int_codegen">Code Generator Intrinsics</a>
5832 </div>
5833
5834 <div class="doc_text">
5835
5836 <p>These intrinsics are provided by LLVM to expose special features that may
5837    only be implemented with code generator support.</p>
5838
5839 </div>
5840
5841 <!-- _______________________________________________________________________ -->
5842 <div class="doc_subsubsection">
5843   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
5844 </div>
5845
5846 <div class="doc_text">
5847
5848 <h5>Syntax:</h5>
5849 <pre>
5850   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
5851 </pre>
5852
5853 <h5>Overview:</h5>
5854 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
5855    target-specific value indicating the return address of the current function
5856    or one of its callers.</p>
5857
5858 <h5>Arguments:</h5>
5859 <p>The argument to this intrinsic indicates which function to return the address
5860    for.  Zero indicates the calling function, one indicates its caller, etc.
5861    The argument is <b>required</b> to be a constant integer value.</p>
5862
5863 <h5>Semantics:</h5>
5864 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
5865    indicating the return address of the specified call frame, or zero if it
5866    cannot be identified.  The value returned by this intrinsic is likely to be
5867    incorrect or 0 for arguments other than zero, so it should only be used for
5868    debugging purposes.</p>
5869
5870 <p>Note that calling this intrinsic does not prevent function inlining or other
5871    aggressive transformations, so the value returned may not be that of the
5872    obvious source-language caller.</p>
5873
5874 </div>
5875
5876 <!-- _______________________________________________________________________ -->
5877 <div class="doc_subsubsection">
5878   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
5879 </div>
5880
5881 <div class="doc_text">
5882
5883 <h5>Syntax:</h5>
5884 <pre>
5885   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
5886 </pre>
5887
5888 <h5>Overview:</h5>
5889 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
5890    target-specific frame pointer value for the specified stack frame.</p>
5891
5892 <h5>Arguments:</h5>
5893 <p>The argument to this intrinsic indicates which function to return the frame
5894    pointer for.  Zero indicates the calling function, one indicates its caller,
5895    etc.  The argument is <b>required</b> to be a constant integer value.</p>
5896
5897 <h5>Semantics:</h5>
5898 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
5899    indicating the frame address of the specified call frame, or zero if it
5900    cannot be identified.  The value returned by this intrinsic is likely to be
5901    incorrect or 0 for arguments other than zero, so it should only be used for
5902    debugging purposes.</p>
5903
5904 <p>Note that calling this intrinsic does not prevent function inlining or other
5905    aggressive transformations, so the value returned may not be that of the
5906    obvious source-language caller.</p>
5907
5908 </div>
5909
5910 <!-- _______________________________________________________________________ -->
5911 <div class="doc_subsubsection">
5912   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
5913 </div>
5914
5915 <div class="doc_text">
5916
5917 <h5>Syntax:</h5>
5918 <pre>
5919   declare i8* @llvm.stacksave()
5920 </pre>
5921
5922 <h5>Overview:</h5>
5923 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
5924    of the function stack, for use
5925    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
5926    useful for implementing language features like scoped automatic variable
5927    sized arrays in C99.</p>
5928
5929 <h5>Semantics:</h5>
5930 <p>This intrinsic returns a opaque pointer value that can be passed
5931    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
5932    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
5933    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
5934    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
5935    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
5936    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
5937
5938 </div>
5939
5940 <!-- _______________________________________________________________________ -->
5941 <div class="doc_subsubsection">
5942   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
5943 </div>
5944
5945 <div class="doc_text">
5946
5947 <h5>Syntax:</h5>
5948 <pre>
5949   declare void @llvm.stackrestore(i8* %ptr)
5950 </pre>
5951
5952 <h5>Overview:</h5>
5953 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
5954    the function stack to the state it was in when the
5955    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
5956    executed.  This is useful for implementing language features like scoped
5957    automatic variable sized arrays in C99.</p>
5958
5959 <h5>Semantics:</h5>
5960 <p>See the description
5961    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
5962
5963 </div>
5964
5965 <!-- _______________________________________________________________________ -->
5966 <div class="doc_subsubsection">
5967   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
5968 </div>
5969
5970 <div class="doc_text">
5971
5972 <h5>Syntax:</h5>
5973 <pre>
5974   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;)
5975 </pre>
5976
5977 <h5>Overview:</h5>
5978 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
5979    insert a prefetch instruction if supported; otherwise, it is a noop.
5980    Prefetches have no effect on the behavior of the program but can change its
5981    performance characteristics.</p>
5982
5983 <h5>Arguments:</h5>
5984 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
5985    specifier determining if the fetch should be for a read (0) or write (1),
5986    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
5987    locality, to (3) - extremely local keep in cache.  The <tt>rw</tt>
5988    and <tt>locality</tt> arguments must be constant integers.</p>
5989
5990 <h5>Semantics:</h5>
5991 <p>This intrinsic does not modify the behavior of the program.  In particular,
5992    prefetches cannot trap and do not produce a value.  On targets that support
5993    this intrinsic, the prefetch can provide hints to the processor cache for
5994    better performance.</p>
5995
5996 </div>
5997
5998 <!-- _______________________________________________________________________ -->
5999 <div class="doc_subsubsection">
6000   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6001 </div>
6002
6003 <div class="doc_text">
6004
6005 <h5>Syntax:</h5>
6006 <pre>
6007   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6008 </pre>
6009
6010 <h5>Overview:</h5>
6011 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6012    Counter (PC) in a region of code to simulators and other tools.  The method
6013    is target specific, but it is expected that the marker will use exported
6014    symbols to transmit the PC of the marker.  The marker makes no guarantees
6015    that it will remain with any specific instruction after optimizations.  It is
6016    possible that the presence of a marker will inhibit optimizations.  The
6017    intended use is to be inserted after optimizations to allow correlations of
6018    simulation runs.</p>
6019
6020 <h5>Arguments:</h5>
6021 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6022
6023 <h5>Semantics:</h5>
6024 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6025    not support this intrinsic may ignore it.</p>
6026
6027 </div>
6028
6029 <!-- _______________________________________________________________________ -->
6030 <div class="doc_subsubsection">
6031   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6032 </div>
6033
6034 <div class="doc_text">
6035
6036 <h5>Syntax:</h5>
6037 <pre>
6038   declare i64 @llvm.readcyclecounter()
6039 </pre>
6040
6041 <h5>Overview:</h5>
6042 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6043    counter register (or similar low latency, high accuracy clocks) on those
6044    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6045    should map to RPCC.  As the backing counters overflow quickly (on the order
6046    of 9 seconds on alpha), this should only be used for small timings.</p>
6047
6048 <h5>Semantics:</h5>
6049 <p>When directly supported, reading the cycle counter should not modify any
6050    memory.  Implementations are allowed to either return a application specific
6051    value or a system wide value.  On backends without support, this is lowered
6052    to a constant 0.</p>
6053
6054 </div>
6055
6056 <!-- ======================================================================= -->
6057 <div class="doc_subsection">
6058   <a name="int_libc">Standard C Library Intrinsics</a>
6059 </div>
6060
6061 <div class="doc_text">
6062
6063 <p>LLVM provides intrinsics for a few important standard C library functions.
6064    These intrinsics allow source-language front-ends to pass information about
6065    the alignment of the pointer arguments to the code generator, providing
6066    opportunity for more efficient code generation.</p>
6067
6068 </div>
6069
6070 <!-- _______________________________________________________________________ -->
6071 <div class="doc_subsubsection">
6072   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6073 </div>
6074
6075 <div class="doc_text">
6076
6077 <h5>Syntax:</h5>
6078 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6079    integer bit width and for different address spaces. Not all targets support
6080    all bit widths however.</p>
6081
6082 <pre>
6083   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6084                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6085   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6086                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6087 </pre>
6088
6089 <h5>Overview:</h5>
6090 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6091    source location to the destination location.</p>
6092
6093 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6094    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6095    and the pointers can be in specified address spaces.</p>
6096
6097 <h5>Arguments:</h5>
6098
6099 <p>The first argument is a pointer to the destination, the second is a pointer
6100    to the source.  The third argument is an integer argument specifying the
6101    number of bytes to copy, the fourth argument is the alignment of the
6102    source and destination locations, and the fifth is a boolean indicating a
6103    volatile access.</p>
6104
6105 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6106    then the caller guarantees that both the source and destination pointers are
6107    aligned to that boundary.</p>
6108
6109 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6110    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6111    The detailed access behavior is not very cleanly specified and it is unwise
6112    to depend on it.</p>
6113
6114 <h5>Semantics:</h5>
6115
6116 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6117    source location to the destination location, which are not allowed to
6118    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6119    be aligned to some boundary, this can be specified as the fourth argument,
6120    otherwise it should be set to 0 or 1.</p>
6121
6122 </div>
6123
6124 <!-- _______________________________________________________________________ -->
6125 <div class="doc_subsubsection">
6126   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6127 </div>
6128
6129 <div class="doc_text">
6130
6131 <h5>Syntax:</h5>
6132 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6133    width and for different address space. Not all targets support all bit
6134    widths however.</p>
6135
6136 <pre>
6137   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6138                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6139   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6140                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6141 </pre>
6142
6143 <h5>Overview:</h5>
6144 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6145    source location to the destination location. It is similar to the
6146    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6147    overlap.</p>
6148
6149 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6150    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6151    and the pointers can be in specified address spaces.</p>
6152
6153 <h5>Arguments:</h5>
6154
6155 <p>The first argument is a pointer to the destination, the second is a pointer
6156    to the source.  The third argument is an integer argument specifying the
6157    number of bytes to copy, the fourth argument is the alignment of the
6158    source and destination locations, and the fifth is a boolean indicating a
6159    volatile access.</p>
6160
6161 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6162    then the caller guarantees that the source and destination pointers are
6163    aligned to that boundary.</p>
6164
6165 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6166    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6167    The detailed access behavior is not very cleanly specified and it is unwise
6168    to depend on it.</p>
6169
6170 <h5>Semantics:</h5>
6171
6172 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6173    source location to the destination location, which may overlap.  It copies
6174    "len" bytes of memory over.  If the argument is known to be aligned to some
6175    boundary, this can be specified as the fourth argument, otherwise it should
6176    be set to 0 or 1.</p>
6177
6178 </div>
6179
6180 <!-- _______________________________________________________________________ -->
6181 <div class="doc_subsubsection">
6182   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6183 </div>
6184
6185 <div class="doc_text">
6186
6187 <h5>Syntax:</h5>
6188 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6189    width and for different address spaces. However, not all targets support all
6190    bit widths.</p>
6191
6192 <pre>
6193   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6194                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6195   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6196                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6197 </pre>
6198
6199 <h5>Overview:</h5>
6200 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6201    particular byte value.</p>
6202
6203 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6204    intrinsic does not return a value and takes extra alignment/volatile
6205    arguments.  Also, the destination can be in an arbitrary address space.</p>
6206
6207 <h5>Arguments:</h5>
6208 <p>The first argument is a pointer to the destination to fill, the second is the
6209    byte value with which to fill it, the third argument is an integer argument
6210    specifying the number of bytes to fill, and the fourth argument is the known
6211    alignment of the destination location.</p>
6212
6213 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6214    then the caller guarantees that the destination pointer is aligned to that
6215    boundary.</p>
6216
6217 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6218    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6219    The detailed access behavior is not very cleanly specified and it is unwise
6220    to depend on it.</p>
6221
6222 <h5>Semantics:</h5>
6223 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6224    at the destination location.  If the argument is known to be aligned to some
6225    boundary, this can be specified as the fourth argument, otherwise it should
6226    be set to 0 or 1.</p>
6227
6228 </div>
6229
6230 <!-- _______________________________________________________________________ -->
6231 <div class="doc_subsubsection">
6232   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6233 </div>
6234
6235 <div class="doc_text">
6236
6237 <h5>Syntax:</h5>
6238 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6239    floating point or vector of floating point type. Not all targets support all
6240    types however.</p>
6241
6242 <pre>
6243   declare float     @llvm.sqrt.f32(float %Val)
6244   declare double    @llvm.sqrt.f64(double %Val)
6245   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6246   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6247   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6248 </pre>
6249
6250 <h5>Overview:</h5>
6251 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6252    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6253    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6254    behavior for negative numbers other than -0.0 (which allows for better
6255    optimization, because there is no need to worry about errno being
6256    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6257
6258 <h5>Arguments:</h5>
6259 <p>The argument and return value are floating point numbers of the same
6260    type.</p>
6261
6262 <h5>Semantics:</h5>
6263 <p>This function returns the sqrt of the specified operand if it is a
6264    nonnegative floating point number.</p>
6265
6266 </div>
6267
6268 <!-- _______________________________________________________________________ -->
6269 <div class="doc_subsubsection">
6270   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6271 </div>
6272
6273 <div class="doc_text">
6274
6275 <h5>Syntax:</h5>
6276 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6277    floating point or vector of floating point type. Not all targets support all
6278    types however.</p>
6279
6280 <pre>
6281   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6282   declare double    @llvm.powi.f64(double %Val, i32 %power)
6283   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6284   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6285   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6286 </pre>
6287
6288 <h5>Overview:</h5>
6289 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6290    specified (positive or negative) power.  The order of evaluation of
6291    multiplications is not defined.  When a vector of floating point type is
6292    used, the second argument remains a scalar integer value.</p>
6293
6294 <h5>Arguments:</h5>
6295 <p>The second argument is an integer power, and the first is a value to raise to
6296    that power.</p>
6297
6298 <h5>Semantics:</h5>
6299 <p>This function returns the first value raised to the second power with an
6300    unspecified sequence of rounding operations.</p>
6301
6302 </div>
6303
6304 <!-- _______________________________________________________________________ -->
6305 <div class="doc_subsubsection">
6306   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6307 </div>
6308
6309 <div class="doc_text">
6310
6311 <h5>Syntax:</h5>
6312 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6313    floating point or vector of floating point type. Not all targets support all
6314    types however.</p>
6315
6316 <pre>
6317   declare float     @llvm.sin.f32(float  %Val)
6318   declare double    @llvm.sin.f64(double %Val)
6319   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6320   declare fp128     @llvm.sin.f128(fp128 %Val)
6321   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6322 </pre>
6323
6324 <h5>Overview:</h5>
6325 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6326
6327 <h5>Arguments:</h5>
6328 <p>The argument and return value are floating point numbers of the same
6329    type.</p>
6330
6331 <h5>Semantics:</h5>
6332 <p>This function returns the sine of the specified operand, returning the same
6333    values as the libm <tt>sin</tt> functions would, and handles error conditions
6334    in the same way.</p>
6335
6336 </div>
6337
6338 <!-- _______________________________________________________________________ -->
6339 <div class="doc_subsubsection">
6340   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6341 </div>
6342
6343 <div class="doc_text">
6344
6345 <h5>Syntax:</h5>
6346 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6347    floating point or vector of floating point type. Not all targets support all
6348    types however.</p>
6349
6350 <pre>
6351   declare float     @llvm.cos.f32(float  %Val)
6352   declare double    @llvm.cos.f64(double %Val)
6353   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6354   declare fp128     @llvm.cos.f128(fp128 %Val)
6355   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6356 </pre>
6357
6358 <h5>Overview:</h5>
6359 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6360
6361 <h5>Arguments:</h5>
6362 <p>The argument and return value are floating point numbers of the same
6363    type.</p>
6364
6365 <h5>Semantics:</h5>
6366 <p>This function returns the cosine of the specified operand, returning the same
6367    values as the libm <tt>cos</tt> functions would, and handles error conditions
6368    in the same way.</p>
6369
6370 </div>
6371
6372 <!-- _______________________________________________________________________ -->
6373 <div class="doc_subsubsection">
6374   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6375 </div>
6376
6377 <div class="doc_text">
6378
6379 <h5>Syntax:</h5>
6380 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6381    floating point or vector of floating point type. Not all targets support all
6382    types however.</p>
6383
6384 <pre>
6385   declare float     @llvm.pow.f32(float  %Val, float %Power)
6386   declare double    @llvm.pow.f64(double %Val, double %Power)
6387   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6388   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6389   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6390 </pre>
6391
6392 <h5>Overview:</h5>
6393 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6394    specified (positive or negative) power.</p>
6395
6396 <h5>Arguments:</h5>
6397 <p>The second argument is a floating point power, and the first is a value to
6398    raise to that power.</p>
6399
6400 <h5>Semantics:</h5>
6401 <p>This function returns the first value raised to the second power, returning
6402    the same values as the libm <tt>pow</tt> functions would, and handles error
6403    conditions in the same way.</p>
6404
6405 </div>
6406
6407 <!-- ======================================================================= -->
6408 <div class="doc_subsection">
6409   <a name="int_manip">Bit Manipulation Intrinsics</a>
6410 </div>
6411
6412 <div class="doc_text">
6413
6414 <p>LLVM provides intrinsics for a few important bit manipulation operations.
6415    These allow efficient code generation for some algorithms.</p>
6416
6417 </div>
6418
6419 <!-- _______________________________________________________________________ -->
6420 <div class="doc_subsubsection">
6421   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
6422 </div>
6423
6424 <div class="doc_text">
6425
6426 <h5>Syntax:</h5>
6427 <p>This is an overloaded intrinsic function. You can use bswap on any integer
6428    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
6429
6430 <pre>
6431   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
6432   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
6433   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
6434 </pre>
6435
6436 <h5>Overview:</h5>
6437 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
6438    values with an even number of bytes (positive multiple of 16 bits).  These
6439    are useful for performing operations on data that is not in the target's
6440    native byte order.</p>
6441
6442 <h5>Semantics:</h5>
6443 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
6444    and low byte of the input i16 swapped.  Similarly,
6445    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
6446    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
6447    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
6448    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
6449    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
6450    more, respectively).</p>
6451
6452 </div>
6453
6454 <!-- _______________________________________________________________________ -->
6455 <div class="doc_subsubsection">
6456   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
6457 </div>
6458
6459 <div class="doc_text">
6460
6461 <h5>Syntax:</h5>
6462 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
6463    width. Not all targets support all bit widths however.</p>
6464
6465 <pre>
6466   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
6467   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
6468   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
6469   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
6470   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
6471 </pre>
6472
6473 <h5>Overview:</h5>
6474 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
6475    in a value.</p>
6476
6477 <h5>Arguments:</h5>
6478 <p>The only argument is the value to be counted.  The argument may be of any
6479    integer type.  The return type must match the argument type.</p>
6480
6481 <h5>Semantics:</h5>
6482 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.</p>
6483
6484 </div>
6485
6486 <!-- _______________________________________________________________________ -->
6487 <div class="doc_subsubsection">
6488   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
6489 </div>
6490
6491 <div class="doc_text">
6492
6493 <h5>Syntax:</h5>
6494 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
6495    integer bit width. Not all targets support all bit widths however.</p>
6496
6497 <pre>
6498   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
6499   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
6500   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
6501   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
6502   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
6503 </pre>
6504
6505 <h5>Overview:</h5>
6506 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
6507    leading zeros in a variable.</p>
6508
6509 <h5>Arguments:</h5>
6510 <p>The only argument is the value to be counted.  The argument may be of any
6511    integer type. The return type must match the argument type.</p>
6512
6513 <h5>Semantics:</h5>
6514 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
6515    zeros in a variable.  If the src == 0 then the result is the size in bits of
6516    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
6517
6518 </div>
6519
6520 <!-- _______________________________________________________________________ -->
6521 <div class="doc_subsubsection">
6522   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
6523 </div>
6524
6525 <div class="doc_text">
6526
6527 <h5>Syntax:</h5>
6528 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
6529    integer bit width. Not all targets support all bit widths however.</p>
6530
6531 <pre>
6532   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
6533   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
6534   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
6535   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
6536   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
6537 </pre>
6538
6539 <h5>Overview:</h5>
6540 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
6541    trailing zeros.</p>
6542
6543 <h5>Arguments:</h5>
6544 <p>The only argument is the value to be counted.  The argument may be of any
6545    integer type.  The return type must match the argument type.</p>
6546
6547 <h5>Semantics:</h5>
6548 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
6549    zeros in a variable.  If the src == 0 then the result is the size in bits of
6550    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
6551
6552 </div>
6553
6554 <!-- ======================================================================= -->
6555 <div class="doc_subsection">
6556   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
6557 </div>
6558
6559 <div class="doc_text">
6560
6561 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
6562
6563 </div>
6564
6565 <!-- _______________________________________________________________________ -->
6566 <div class="doc_subsubsection">
6567   <a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a>
6568 </div>
6569
6570 <div class="doc_text">
6571
6572 <h5>Syntax:</h5>
6573 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
6574    on any integer bit width.</p>
6575
6576 <pre>
6577   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
6578   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6579   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
6580 </pre>
6581
6582 <h5>Overview:</h5>
6583 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6584    a signed addition of the two arguments, and indicate whether an overflow
6585    occurred during the signed summation.</p>
6586
6587 <h5>Arguments:</h5>
6588 <p>The arguments (%a and %b) and the first element of the result structure may
6589    be of integer types of any bit width, but they must have the same bit
6590    width. The second element of the result structure must be of
6591    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6592    undergo signed addition.</p>
6593
6594 <h5>Semantics:</h5>
6595 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6596    a signed addition of the two variables. They return a structure &mdash; the
6597    first element of which is the signed summation, and the second element of
6598    which is a bit specifying if the signed summation resulted in an
6599    overflow.</p>
6600
6601 <h5>Examples:</h5>
6602 <pre>
6603   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6604   %sum = extractvalue {i32, i1} %res, 0
6605   %obit = extractvalue {i32, i1} %res, 1
6606   br i1 %obit, label %overflow, label %normal
6607 </pre>
6608
6609 </div>
6610
6611 <!-- _______________________________________________________________________ -->
6612 <div class="doc_subsubsection">
6613   <a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a>
6614 </div>
6615
6616 <div class="doc_text">
6617
6618 <h5>Syntax:</h5>
6619 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
6620    on any integer bit width.</p>
6621
6622 <pre>
6623   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
6624   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6625   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
6626 </pre>
6627
6628 <h5>Overview:</h5>
6629 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6630    an unsigned addition of the two arguments, and indicate whether a carry
6631    occurred during the unsigned summation.</p>
6632
6633 <h5>Arguments:</h5>
6634 <p>The arguments (%a and %b) and the first element of the result structure may
6635    be of integer types of any bit width, but they must have the same bit
6636    width. The second element of the result structure must be of
6637    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6638    undergo unsigned addition.</p>
6639
6640 <h5>Semantics:</h5>
6641 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6642    an unsigned addition of the two arguments. They return a structure &mdash;
6643    the first element of which is the sum, and the second element of which is a
6644    bit specifying if the unsigned summation resulted in a carry.</p>
6645
6646 <h5>Examples:</h5>
6647 <pre>
6648   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6649   %sum = extractvalue {i32, i1} %res, 0
6650   %obit = extractvalue {i32, i1} %res, 1
6651   br i1 %obit, label %carry, label %normal
6652 </pre>
6653
6654 </div>
6655
6656 <!-- _______________________________________________________________________ -->
6657 <div class="doc_subsubsection">
6658   <a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a>
6659 </div>
6660
6661 <div class="doc_text">
6662
6663 <h5>Syntax:</h5>
6664 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
6665    on any integer bit width.</p>
6666
6667 <pre>
6668   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
6669   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6670   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
6671 </pre>
6672
6673 <h5>Overview:</h5>
6674 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6675    a signed subtraction of the two arguments, and indicate whether an overflow
6676    occurred during the signed subtraction.</p>
6677
6678 <h5>Arguments:</h5>
6679 <p>The arguments (%a and %b) and the first element of the result structure may
6680    be of integer types of any bit width, but they must have the same bit
6681    width. The second element of the result structure must be of
6682    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6683    undergo signed subtraction.</p>
6684
6685 <h5>Semantics:</h5>
6686 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6687    a signed subtraction of the two arguments. They return a structure &mdash;
6688    the first element of which is the subtraction, and the second element of
6689    which is a bit specifying if the signed subtraction resulted in an
6690    overflow.</p>
6691
6692 <h5>Examples:</h5>
6693 <pre>
6694   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6695   %sum = extractvalue {i32, i1} %res, 0
6696   %obit = extractvalue {i32, i1} %res, 1
6697   br i1 %obit, label %overflow, label %normal
6698 </pre>
6699
6700 </div>
6701
6702 <!-- _______________________________________________________________________ -->
6703 <div class="doc_subsubsection">
6704   <a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a>
6705 </div>
6706
6707 <div class="doc_text">
6708
6709 <h5>Syntax:</h5>
6710 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
6711    on any integer bit width.</p>
6712
6713 <pre>
6714   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
6715   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6716   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
6717 </pre>
6718
6719 <h5>Overview:</h5>
6720 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6721    an unsigned subtraction of the two arguments, and indicate whether an
6722    overflow occurred during the unsigned subtraction.</p>
6723
6724 <h5>Arguments:</h5>
6725 <p>The arguments (%a and %b) and the first element of the result structure may
6726    be of integer types of any bit width, but they must have the same bit
6727    width. The second element of the result structure must be of
6728    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6729    undergo unsigned subtraction.</p>
6730
6731 <h5>Semantics:</h5>
6732 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6733    an unsigned subtraction of the two arguments. They return a structure &mdash;
6734    the first element of which is the subtraction, and the second element of
6735    which is a bit specifying if the unsigned subtraction resulted in an
6736    overflow.</p>
6737
6738 <h5>Examples:</h5>
6739 <pre>
6740   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6741   %sum = extractvalue {i32, i1} %res, 0
6742   %obit = extractvalue {i32, i1} %res, 1
6743   br i1 %obit, label %overflow, label %normal
6744 </pre>
6745
6746 </div>
6747
6748 <!-- _______________________________________________________________________ -->
6749 <div class="doc_subsubsection">
6750   <a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a>
6751 </div>
6752
6753 <div class="doc_text">
6754
6755 <h5>Syntax:</h5>
6756 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
6757    on any integer bit width.</p>
6758
6759 <pre>
6760   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
6761   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6762   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
6763 </pre>
6764
6765 <h5>Overview:</h5>
6766
6767 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6768    a signed multiplication of the two arguments, and indicate whether an
6769    overflow occurred during the signed multiplication.</p>
6770
6771 <h5>Arguments:</h5>
6772 <p>The arguments (%a and %b) and the first element of the result structure may
6773    be of integer types of any bit width, but they must have the same bit
6774    width. The second element of the result structure must be of
6775    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6776    undergo signed multiplication.</p>
6777
6778 <h5>Semantics:</h5>
6779 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6780    a signed multiplication of the two arguments. They return a structure &mdash;
6781    the first element of which is the multiplication, and the second element of
6782    which is a bit specifying if the signed multiplication resulted in an
6783    overflow.</p>
6784
6785 <h5>Examples:</h5>
6786 <pre>
6787   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6788   %sum = extractvalue {i32, i1} %res, 0
6789   %obit = extractvalue {i32, i1} %res, 1
6790   br i1 %obit, label %overflow, label %normal
6791 </pre>
6792
6793 </div>
6794
6795 <!-- _______________________________________________________________________ -->
6796 <div class="doc_subsubsection">
6797   <a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a>
6798 </div>
6799
6800 <div class="doc_text">
6801
6802 <h5>Syntax:</h5>
6803 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
6804    on any integer bit width.</p>
6805
6806 <pre>
6807   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
6808   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6809   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
6810 </pre>
6811
6812 <h5>Overview:</h5>
6813 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6814    a unsigned multiplication of the two arguments, and indicate whether an
6815    overflow occurred during the unsigned multiplication.</p>
6816
6817 <h5>Arguments:</h5>
6818 <p>The arguments (%a and %b) and the first element of the result structure may
6819    be of integer types of any bit width, but they must have the same bit
6820    width. The second element of the result structure must be of
6821    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6822    undergo unsigned multiplication.</p>
6823
6824 <h5>Semantics:</h5>
6825 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6826    an unsigned multiplication of the two arguments. They return a structure
6827    &mdash; the first element of which is the multiplication, and the second
6828    element of which is a bit specifying if the unsigned multiplication resulted
6829    in an overflow.</p>
6830
6831 <h5>Examples:</h5>
6832 <pre>
6833   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6834   %sum = extractvalue {i32, i1} %res, 0
6835   %obit = extractvalue {i32, i1} %res, 1
6836   br i1 %obit, label %overflow, label %normal
6837 </pre>
6838
6839 </div>
6840
6841 <!-- ======================================================================= -->
6842 <div class="doc_subsection">
6843   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
6844 </div>
6845
6846 <div class="doc_text">
6847
6848 <p>Half precision floating point is a storage-only format. This means that it is
6849    a dense encoding (in memory) but does not support computation in the
6850    format.</p>
6851
6852 <p>This means that code must first load the half-precision floating point
6853    value as an i16, then convert it to float with <a
6854    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
6855    Computation can then be performed on the float value (including extending to
6856    double etc).  To store the value back to memory, it is first converted to
6857    float if needed, then converted to i16 with
6858    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
6859    storing as an i16 value.</p>
6860 </div>
6861
6862 <!-- _______________________________________________________________________ -->
6863 <div class="doc_subsubsection">
6864   <a name="int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a>
6865 </div>
6866
6867 <div class="doc_text">
6868
6869 <h5>Syntax:</h5>
6870 <pre>
6871   declare i16 @llvm.convert.to.fp16(f32 %a)
6872 </pre>
6873
6874 <h5>Overview:</h5>
6875 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6876    a conversion from single precision floating point format to half precision
6877    floating point format.</p>
6878
6879 <h5>Arguments:</h5>
6880 <p>The intrinsic function contains single argument - the value to be
6881    converted.</p>
6882
6883 <h5>Semantics:</h5>
6884 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6885    a conversion from single precision floating point format to half precision
6886    floating point format. The return value is an <tt>i16</tt> which
6887    contains the converted number.</p>
6888
6889 <h5>Examples:</h5>
6890 <pre>
6891   %res = call i16 @llvm.convert.to.fp16(f32 %a)
6892   store i16 %res, i16* @x, align 2
6893 </pre>
6894
6895 </div>
6896
6897 <!-- _______________________________________________________________________ -->
6898 <div class="doc_subsubsection">
6899  <a name="int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a>
6900 </div>
6901
6902 <div class="doc_text">
6903
6904 <h5>Syntax:</h5>
6905 <pre>
6906   declare f32 @llvm.convert.from.fp16(i16 %a)
6907 </pre>
6908
6909 <h5>Overview:</h5>
6910 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
6911    a conversion from half precision floating point format to single precision
6912    floating point format.</p>
6913
6914 <h5>Arguments:</h5>
6915 <p>The intrinsic function contains single argument - the value to be
6916    converted.</p>
6917
6918 <h5>Semantics:</h5>
6919 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
6920    conversion from half single precision floating point format to single
6921    precision floating point format. The input half-float value is represented by
6922    an <tt>i16</tt> value.</p>
6923
6924 <h5>Examples:</h5>
6925 <pre>
6926   %a = load i16* @x, align 2
6927   %res = call f32 @llvm.convert.from.fp16(i16 %a)
6928 </pre>
6929
6930 </div>
6931
6932 <!-- ======================================================================= -->
6933 <div class="doc_subsection">
6934   <a name="int_debugger">Debugger Intrinsics</a>
6935 </div>
6936
6937 <div class="doc_text">
6938
6939 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
6940    prefix), are described in
6941    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
6942    Level Debugging</a> document.</p>
6943
6944 </div>
6945
6946 <!-- ======================================================================= -->
6947 <div class="doc_subsection">
6948   <a name="int_eh">Exception Handling Intrinsics</a>
6949 </div>
6950
6951 <div class="doc_text">
6952
6953 <p>The LLVM exception handling intrinsics (which all start with
6954    <tt>llvm.eh.</tt> prefix), are described in
6955    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
6956    Handling</a> document.</p>
6957
6958 </div>
6959
6960 <!-- ======================================================================= -->
6961 <div class="doc_subsection">
6962   <a name="int_trampoline">Trampoline Intrinsic</a>
6963 </div>
6964
6965 <div class="doc_text">
6966
6967 <p>This intrinsic makes it possible to excise one parameter, marked with
6968    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
6969    The result is a callable
6970    function pointer lacking the nest parameter - the caller does not need to
6971    provide a value for it.  Instead, the value to use is stored in advance in a
6972    "trampoline", a block of memory usually allocated on the stack, which also
6973    contains code to splice the nest value into the argument list.  This is used
6974    to implement the GCC nested function address extension.</p>
6975
6976 <p>For example, if the function is
6977    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
6978    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
6979    follows:</p>
6980
6981 <pre class="doc_code">
6982   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
6983   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
6984   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
6985   %fp = bitcast i8* %p to i32 (i32, i32)*
6986 </pre>
6987
6988 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
6989    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
6990
6991 </div>
6992
6993 <!-- _______________________________________________________________________ -->
6994 <div class="doc_subsubsection">
6995   <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
6996 </div>
6997
6998 <div class="doc_text">
6999
7000 <h5>Syntax:</h5>
7001 <pre>
7002   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7003 </pre>
7004
7005 <h5>Overview:</h5>
7006 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
7007    function pointer suitable for executing it.</p>
7008
7009 <h5>Arguments:</h5>
7010 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7011    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7012    sufficiently aligned block of memory; this memory is written to by the
7013    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7014    currently provides no portable way of determining them, so a front-end that
7015    generates this intrinsic needs to have some target-specific knowledge.
7016    The <tt>func</tt> argument must hold a function bitcast to
7017    an <tt>i8*</tt>.</p>
7018
7019 <h5>Semantics:</h5>
7020 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7021    dependent code, turning it into a function.  A pointer to this function is
7022    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
7023    function pointer type</a> before being called.  The new function's signature
7024    is the same as that of <tt>func</tt> with any arguments marked with
7025    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
7026    is allowed, and it must be of pointer type.  Calling the new function is
7027    equivalent to calling <tt>func</tt> with the same argument list, but
7028    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7029    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7030    by <tt>tramp</tt> is modified, then the effect of any later call to the
7031    returned function pointer is undefined.</p>
7032
7033 </div>
7034
7035 <!-- ======================================================================= -->
7036 <div class="doc_subsection">
7037   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7038 </div>
7039
7040 <div class="doc_text">
7041
7042 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7043    hardware constructs for atomic operations and memory synchronization.  This
7044    provides an interface to the hardware, not an interface to the programmer. It
7045    is aimed at a low enough level to allow any programming models or APIs
7046    (Application Programming Interfaces) which need atomic behaviors to map
7047    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7048    hardware provides a "universal IR" for source languages, it also provides a
7049    starting point for developing a "universal" atomic operation and
7050    synchronization IR.</p>
7051
7052 <p>These do <em>not</em> form an API such as high-level threading libraries,
7053    software transaction memory systems, atomic primitives, and intrinsic
7054    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7055    application libraries.  The hardware interface provided by LLVM should allow
7056    a clean implementation of all of these APIs and parallel programming models.
7057    No one model or paradigm should be selected above others unless the hardware
7058    itself ubiquitously does so.</p>
7059
7060 </div>
7061
7062 <!-- _______________________________________________________________________ -->
7063 <div class="doc_subsubsection">
7064   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7065 </div>
7066 <div class="doc_text">
7067 <h5>Syntax:</h5>
7068 <pre>
7069   declare void @llvm.memory.barrier(i1 &lt;ll&gt;, i1 &lt;ls&gt;, i1 &lt;sl&gt;, i1 &lt;ss&gt;, i1 &lt;device&gt;)
7070 </pre>
7071
7072 <h5>Overview:</h5>
7073 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7074    specific pairs of memory access types.</p>
7075
7076 <h5>Arguments:</h5>
7077 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7078    The first four arguments enables a specific barrier as listed below.  The
7079    fifth argument specifies that the barrier applies to io or device or uncached
7080    memory.</p>
7081
7082 <ul>
7083   <li><tt>ll</tt>: load-load barrier</li>
7084   <li><tt>ls</tt>: load-store barrier</li>
7085   <li><tt>sl</tt>: store-load barrier</li>
7086   <li><tt>ss</tt>: store-store barrier</li>
7087   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7088 </ul>
7089
7090 <h5>Semantics:</h5>
7091 <p>This intrinsic causes the system to enforce some ordering constraints upon
7092    the loads and stores of the program. This barrier does not
7093    indicate <em>when</em> any events will occur, it only enforces
7094    an <em>order</em> in which they occur. For any of the specified pairs of load
7095    and store operations (f.ex.  load-load, or store-load), all of the first
7096    operations preceding the barrier will complete before any of the second
7097    operations succeeding the barrier begin. Specifically the semantics for each
7098    pairing is as follows:</p>
7099
7100 <ul>
7101   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7102       after the barrier begins.</li>
7103   <li><tt>ls</tt>: All loads before the barrier must complete before any
7104       store after the barrier begins.</li>
7105   <li><tt>ss</tt>: All stores before the barrier must complete before any
7106       store after the barrier begins.</li>
7107   <li><tt>sl</tt>: All stores before the barrier must complete before any
7108       load after the barrier begins.</li>
7109 </ul>
7110
7111 <p>These semantics are applied with a logical "and" behavior when more than one
7112    is enabled in a single memory barrier intrinsic.</p>
7113
7114 <p>Backends may implement stronger barriers than those requested when they do
7115    not support as fine grained a barrier as requested.  Some architectures do
7116    not need all types of barriers and on such architectures, these become
7117    noops.</p>
7118
7119 <h5>Example:</h5>
7120 <pre>
7121 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7122 %ptr      = bitcast i8* %mallocP to i32*
7123             store i32 4, %ptr
7124
7125 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7126             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false)
7127                                 <i>; guarantee the above finishes</i>
7128             store i32 8, %ptr   <i>; before this begins</i>
7129 </pre>
7130
7131 </div>
7132
7133 <!-- _______________________________________________________________________ -->
7134 <div class="doc_subsubsection">
7135   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7136 </div>
7137
7138 <div class="doc_text">
7139
7140 <h5>Syntax:</h5>
7141 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7142    any integer bit width and for different address spaces. Not all targets
7143    support all bit widths however.</p>
7144
7145 <pre>
7146   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7147   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7148   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7149   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7150 </pre>
7151
7152 <h5>Overview:</h5>
7153 <p>This loads a value in memory and compares it to a given value. If they are
7154    equal, it stores a new value into the memory.</p>
7155
7156 <h5>Arguments:</h5>
7157 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7158    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7159    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7160    this integer type. While any bit width integer may be used, targets may only
7161    lower representations they support in hardware.</p>
7162
7163 <h5>Semantics:</h5>
7164 <p>This entire intrinsic must be executed atomically. It first loads the value
7165    in memory pointed to by <tt>ptr</tt> and compares it with the
7166    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7167    memory. The loaded value is yielded in all cases. This provides the
7168    equivalent of an atomic compare-and-swap operation within the SSA
7169    framework.</p>
7170
7171 <h5>Examples:</h5>
7172 <pre>
7173 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7174 %ptr      = bitcast i8* %mallocP to i32*
7175             store i32 4, %ptr
7176
7177 %val1     = add i32 4, 4
7178 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7179                                           <i>; yields {i32}:result1 = 4</i>
7180 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7181 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7182
7183 %val2     = add i32 1, 1
7184 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7185                                           <i>; yields {i32}:result2 = 8</i>
7186 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7187
7188 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7189 </pre>
7190
7191 </div>
7192
7193 <!-- _______________________________________________________________________ -->
7194 <div class="doc_subsubsection">
7195   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7196 </div>
7197 <div class="doc_text">
7198 <h5>Syntax:</h5>
7199
7200 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7201    integer bit width. Not all targets support all bit widths however.</p>
7202
7203 <pre>
7204   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7205   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7206   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7207   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7208 </pre>
7209
7210 <h5>Overview:</h5>
7211 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7212    the value from memory. It then stores the value in <tt>val</tt> in the memory
7213    at <tt>ptr</tt>.</p>
7214
7215 <h5>Arguments:</h5>
7216 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7217   the <tt>val</tt> argument and the result must be integers of the same bit
7218   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7219   integer type. The targets may only lower integer representations they
7220   support.</p>
7221
7222 <h5>Semantics:</h5>
7223 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7224    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7225    equivalent of an atomic swap operation within the SSA framework.</p>
7226
7227 <h5>Examples:</h5>
7228 <pre>
7229 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7230 %ptr      = bitcast i8* %mallocP to i32*
7231             store i32 4, %ptr
7232
7233 %val1     = add i32 4, 4
7234 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7235                                         <i>; yields {i32}:result1 = 4</i>
7236 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7237 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7238
7239 %val2     = add i32 1, 1
7240 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7241                                         <i>; yields {i32}:result2 = 8</i>
7242
7243 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7244 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7245 </pre>
7246
7247 </div>
7248
7249 <!-- _______________________________________________________________________ -->
7250 <div class="doc_subsubsection">
7251   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7252
7253 </div>
7254
7255 <div class="doc_text">
7256
7257 <h5>Syntax:</h5>
7258 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7259    any integer bit width. Not all targets support all bit widths however.</p>
7260
7261 <pre>
7262   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7263   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7264   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7265   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7266 </pre>
7267
7268 <h5>Overview:</h5>
7269 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7270    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7271
7272 <h5>Arguments:</h5>
7273 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7274    and the second an integer value. The result is also an integer value. These
7275    integer types can have any bit width, but they must all have the same bit
7276    width. The targets may only lower integer representations they support.</p>
7277
7278 <h5>Semantics:</h5>
7279 <p>This intrinsic does a series of operations atomically. It first loads the
7280    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7281    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7282
7283 <h5>Examples:</h5>
7284 <pre>
7285 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7286 %ptr      = bitcast i8* %mallocP to i32*
7287             store i32 4, %ptr
7288 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7289                                 <i>; yields {i32}:result1 = 4</i>
7290 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7291                                 <i>; yields {i32}:result2 = 8</i>
7292 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7293                                 <i>; yields {i32}:result3 = 10</i>
7294 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7295 </pre>
7296
7297 </div>
7298
7299 <!-- _______________________________________________________________________ -->
7300 <div class="doc_subsubsection">
7301   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
7302
7303 </div>
7304
7305 <div class="doc_text">
7306
7307 <h5>Syntax:</h5>
7308 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
7309    any integer bit width and for different address spaces. Not all targets
7310    support all bit widths however.</p>
7311
7312 <pre>
7313   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7314   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7315   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7316   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7317 </pre>
7318
7319 <h5>Overview:</h5>
7320 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
7321    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7322
7323 <h5>Arguments:</h5>
7324 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7325    and the second an integer value. The result is also an integer value. These
7326    integer types can have any bit width, but they must all have the same bit
7327    width. The targets may only lower integer representations they support.</p>
7328
7329 <h5>Semantics:</h5>
7330 <p>This intrinsic does a series of operations atomically. It first loads the
7331    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
7332    result to <tt>ptr</tt>. It yields the original value stored
7333    at <tt>ptr</tt>.</p>
7334
7335 <h5>Examples:</h5>
7336 <pre>
7337 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7338 %ptr      = bitcast i8* %mallocP to i32*
7339             store i32 8, %ptr
7340 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
7341                                 <i>; yields {i32}:result1 = 8</i>
7342 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
7343                                 <i>; yields {i32}:result2 = 4</i>
7344 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
7345                                 <i>; yields {i32}:result3 = 2</i>
7346 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
7347 </pre>
7348
7349 </div>
7350
7351 <!-- _______________________________________________________________________ -->
7352 <div class="doc_subsubsection">
7353   <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
7354   <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
7355   <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
7356   <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
7357 </div>
7358
7359 <div class="doc_text">
7360
7361 <h5>Syntax:</h5>
7362 <p>These are overloaded intrinsics. You can
7363   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
7364   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
7365   bit width and for different address spaces. Not all targets support all bit
7366   widths however.</p>
7367
7368 <pre>
7369   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7370   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7371   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7372   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7373 </pre>
7374
7375 <pre>
7376   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7377   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7378   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7379   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7380 </pre>
7381
7382 <pre>
7383   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7384   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7385   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7386   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7387 </pre>
7388
7389 <pre>
7390   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7391   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7392   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7393   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7394 </pre>
7395
7396 <h5>Overview:</h5>
7397 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
7398    the value stored in memory at <tt>ptr</tt>. It yields the original value
7399    at <tt>ptr</tt>.</p>
7400
7401 <h5>Arguments:</h5>
7402 <p>These intrinsics take two arguments, the first a pointer to an integer value
7403    and the second an integer value. The result is also an integer value. These
7404    integer types can have any bit width, but they must all have the same bit
7405    width. The targets may only lower integer representations they support.</p>
7406
7407 <h5>Semantics:</h5>
7408 <p>These intrinsics does a series of operations atomically. They first load the
7409    value stored at <tt>ptr</tt>. They then do the bitwise
7410    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
7411    original value stored at <tt>ptr</tt>.</p>
7412
7413 <h5>Examples:</h5>
7414 <pre>
7415 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7416 %ptr      = bitcast i8* %mallocP to i32*
7417             store i32 0x0F0F, %ptr
7418 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
7419                                 <i>; yields {i32}:result0 = 0x0F0F</i>
7420 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
7421                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
7422 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
7423                                 <i>; yields {i32}:result2 = 0xF0</i>
7424 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
7425                                 <i>; yields {i32}:result3 = FF</i>
7426 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
7427 </pre>
7428
7429 </div>
7430
7431 <!-- _______________________________________________________________________ -->
7432 <div class="doc_subsubsection">
7433   <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
7434   <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
7435   <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
7436   <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
7437 </div>
7438
7439 <div class="doc_text">
7440
7441 <h5>Syntax:</h5>
7442 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
7443    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
7444    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
7445    address spaces. Not all targets support all bit widths however.</p>
7446
7447 <pre>
7448   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7449   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7450   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7451   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7452 </pre>
7453
7454 <pre>
7455   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7456   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7457   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7458   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7459 </pre>
7460
7461 <pre>
7462   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7463   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7464   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7465   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7466 </pre>
7467
7468 <pre>
7469   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7470   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7471   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7472   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7473 </pre>
7474
7475 <h5>Overview:</h5>
7476 <p>These intrinsics takes the signed or unsigned minimum or maximum of
7477    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
7478    original value at <tt>ptr</tt>.</p>
7479
7480 <h5>Arguments:</h5>
7481 <p>These intrinsics take two arguments, the first a pointer to an integer value
7482    and the second an integer value. The result is also an integer value. These
7483    integer types can have any bit width, but they must all have the same bit
7484    width. The targets may only lower integer representations they support.</p>
7485
7486 <h5>Semantics:</h5>
7487 <p>These intrinsics does a series of operations atomically. They first load the
7488    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
7489    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
7490    yield the original value stored at <tt>ptr</tt>.</p>
7491
7492 <h5>Examples:</h5>
7493 <pre>
7494 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7495 %ptr      = bitcast i8* %mallocP to i32*
7496             store i32 7, %ptr
7497 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
7498                                 <i>; yields {i32}:result0 = 7</i>
7499 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
7500                                 <i>; yields {i32}:result1 = -2</i>
7501 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
7502                                 <i>; yields {i32}:result2 = 8</i>
7503 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
7504                                 <i>; yields {i32}:result3 = 8</i>
7505 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
7506 </pre>
7507
7508 </div>
7509
7510
7511 <!-- ======================================================================= -->
7512 <div class="doc_subsection">
7513   <a name="int_memorymarkers">Memory Use Markers</a>
7514 </div>
7515
7516 <div class="doc_text">
7517
7518 <p>This class of intrinsics exists to information about the lifetime of memory
7519    objects and ranges where variables are immutable.</p>
7520
7521 </div>
7522
7523 <!-- _______________________________________________________________________ -->
7524 <div class="doc_subsubsection">
7525   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7526 </div>
7527
7528 <div class="doc_text">
7529
7530 <h5>Syntax:</h5>
7531 <pre>
7532   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7533 </pre>
7534
7535 <h5>Overview:</h5>
7536 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7537    object's lifetime.</p>
7538
7539 <h5>Arguments:</h5>
7540 <p>The first argument is a constant integer representing the size of the
7541    object, or -1 if it is variable sized.  The second argument is a pointer to
7542    the object.</p>
7543
7544 <h5>Semantics:</h5>
7545 <p>This intrinsic indicates that before this point in the code, the value of the
7546    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7547    never be used and has an undefined value.  A load from the pointer that
7548    precedes this intrinsic can be replaced with
7549    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7550
7551 </div>
7552
7553 <!-- _______________________________________________________________________ -->
7554 <div class="doc_subsubsection">
7555   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7556 </div>
7557
7558 <div class="doc_text">
7559
7560 <h5>Syntax:</h5>
7561 <pre>
7562   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7563 </pre>
7564
7565 <h5>Overview:</h5>
7566 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7567    object's lifetime.</p>
7568
7569 <h5>Arguments:</h5>
7570 <p>The first argument is a constant integer representing the size of the
7571    object, or -1 if it is variable sized.  The second argument is a pointer to
7572    the object.</p>
7573
7574 <h5>Semantics:</h5>
7575 <p>This intrinsic indicates that after this point in the code, the value of the
7576    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7577    never be used and has an undefined value.  Any stores into the memory object
7578    following this intrinsic may be removed as dead.
7579
7580 </div>
7581
7582 <!-- _______________________________________________________________________ -->
7583 <div class="doc_subsubsection">
7584   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7585 </div>
7586
7587 <div class="doc_text">
7588
7589 <h5>Syntax:</h5>
7590 <pre>
7591   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7592 </pre>
7593
7594 <h5>Overview:</h5>
7595 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7596    a memory object will not change.</p>
7597
7598 <h5>Arguments:</h5>
7599 <p>The first argument is a constant integer representing the size of the
7600    object, or -1 if it is variable sized.  The second argument is a pointer to
7601    the object.</p>
7602
7603 <h5>Semantics:</h5>
7604 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
7605    the return value, the referenced memory location is constant and
7606    unchanging.</p>
7607
7608 </div>
7609
7610 <!-- _______________________________________________________________________ -->
7611 <div class="doc_subsubsection">
7612   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
7613 </div>
7614
7615 <div class="doc_text">
7616
7617 <h5>Syntax:</h5>
7618 <pre>
7619   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7620 </pre>
7621
7622 <h5>Overview:</h5>
7623 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
7624    a memory object are mutable.</p>
7625
7626 <h5>Arguments:</h5>
7627 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
7628    The second argument is a constant integer representing the size of the
7629    object, or -1 if it is variable sized and the third argument is a pointer
7630    to the object.</p>
7631
7632 <h5>Semantics:</h5>
7633 <p>This intrinsic indicates that the memory is mutable again.</p>
7634
7635 </div>
7636
7637 <!-- ======================================================================= -->
7638 <div class="doc_subsection">
7639   <a name="int_general">General Intrinsics</a>
7640 </div>
7641
7642 <div class="doc_text">
7643
7644 <p>This class of intrinsics is designed to be generic and has no specific
7645    purpose.</p>
7646
7647 </div>
7648
7649 <!-- _______________________________________________________________________ -->
7650 <div class="doc_subsubsection">
7651   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
7652 </div>
7653
7654 <div class="doc_text">
7655
7656 <h5>Syntax:</h5>
7657 <pre>
7658   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7659 </pre>
7660
7661 <h5>Overview:</h5>
7662 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
7663
7664 <h5>Arguments:</h5>
7665 <p>The first argument is a pointer to a value, the second is a pointer to a
7666    global string, the third is a pointer to a global string which is the source
7667    file name, and the last argument is the line number.</p>
7668
7669 <h5>Semantics:</h5>
7670 <p>This intrinsic allows annotation of local variables with arbitrary strings.
7671    This can be useful for special purpose optimizations that want to look for
7672    these annotations.  These have no other defined use, they are ignored by code
7673    generation and optimization.</p>
7674
7675 </div>
7676
7677 <!-- _______________________________________________________________________ -->
7678 <div class="doc_subsubsection">
7679   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
7680 </div>
7681
7682 <div class="doc_text">
7683
7684 <h5>Syntax:</h5>
7685 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
7686    any integer bit width.</p>
7687
7688 <pre>
7689   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7690   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7691   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7692   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7693   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7694 </pre>
7695
7696 <h5>Overview:</h5>
7697 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
7698
7699 <h5>Arguments:</h5>
7700 <p>The first argument is an integer value (result of some expression), the
7701    second is a pointer to a global string, the third is a pointer to a global
7702    string which is the source file name, and the last argument is the line
7703    number.  It returns the value of the first argument.</p>
7704
7705 <h5>Semantics:</h5>
7706 <p>This intrinsic allows annotations to be put on arbitrary expressions with
7707    arbitrary strings.  This can be useful for special purpose optimizations that
7708    want to look for these annotations.  These have no other defined use, they
7709    are ignored by code generation and optimization.</p>
7710
7711 </div>
7712
7713 <!-- _______________________________________________________________________ -->
7714 <div class="doc_subsubsection">
7715   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
7716 </div>
7717
7718 <div class="doc_text">
7719
7720 <h5>Syntax:</h5>
7721 <pre>
7722   declare void @llvm.trap()
7723 </pre>
7724
7725 <h5>Overview:</h5>
7726 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
7727
7728 <h5>Arguments:</h5>
7729 <p>None.</p>
7730
7731 <h5>Semantics:</h5>
7732 <p>This intrinsics is lowered to the target dependent trap instruction. If the
7733    target does not have a trap instruction, this intrinsic will be lowered to
7734    the call of the <tt>abort()</tt> function.</p>
7735
7736 </div>
7737
7738 <!-- _______________________________________________________________________ -->
7739 <div class="doc_subsubsection">
7740   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
7741 </div>
7742
7743 <div class="doc_text">
7744
7745 <h5>Syntax:</h5>
7746 <pre>
7747   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
7748 </pre>
7749
7750 <h5>Overview:</h5>
7751 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
7752    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
7753    ensure that it is placed on the stack before local variables.</p>
7754
7755 <h5>Arguments:</h5>
7756 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
7757    arguments. The first argument is the value loaded from the stack
7758    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
7759    that has enough space to hold the value of the guard.</p>
7760
7761 <h5>Semantics:</h5>
7762 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
7763    the <tt>AllocaInst</tt> stack slot to be before local variables on the
7764    stack. This is to ensure that if a local variable on the stack is
7765    overwritten, it will destroy the value of the guard. When the function exits,
7766    the guard on the stack is checked against the original guard. If they are
7767    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
7768    function.</p>
7769
7770 </div>
7771
7772 <!-- _______________________________________________________________________ -->
7773 <div class="doc_subsubsection">
7774   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
7775 </div>
7776
7777 <div class="doc_text">
7778
7779 <h5>Syntax:</h5>
7780 <pre>
7781   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
7782   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
7783 </pre>
7784
7785 <h5>Overview:</h5>
7786 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
7787    the optimizers to determine at compile time whether a) an operation (like
7788    memcpy) will overflow a buffer that corresponds to an object, or b) that a
7789    runtime check for overflow isn't necessary. An object in this context means
7790    an allocation of a specific class, structure, array, or other object.</p>
7791
7792 <h5>Arguments:</h5>
7793 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
7794    argument is a pointer to or into the <tt>object</tt>. The second argument
7795    is a boolean 0 or 1. This argument determines whether you want the
7796    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
7797    1, variables are not allowed.</p>
7798
7799 <h5>Semantics:</h5>
7800 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
7801    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
7802    depending on the <tt>type</tt> argument, if the size cannot be determined at
7803    compile time.</p>
7804
7805 </div>
7806
7807 <!-- *********************************************************************** -->
7808 <hr>
7809 <address>
7810   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
7811   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
7812   <a href="http://validator.w3.org/check/referer"><img
7813   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
7814
7815   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
7816   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
7817   Last modified: $Date$
7818 </address>
7819
7820 </body>
7821 </html>