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 <h1>LLVM Language Reference Manual</h1>
  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       <li><a href="#memmodel">Memory Model for Concurrent Operations</a></li>
  57       <li><a href="#ordering">Atomic Memory Ordering Constraints</a></li>
  58     </ol>
  59   </li>
  60   <li><a href="#typesystem">Type System</a>
  61     <ol>
  62       <li><a href="#t_classifications">Type Classifications</a></li>
  63       <li><a href="#t_primitive">Primitive Types</a>
  64         <ol>
  65           <li><a href="#t_integer">Integer Type</a></li>
  66           <li><a href="#t_floating">Floating Point Types</a></li>
  67           <li><a href="#t_x86mmx">X86mmx Type</a></li>
  68           <li><a href="#t_void">Void Type</a></li>
  69           <li><a href="#t_label">Label Type</a></li>
  70           <li><a href="#t_metadata">Metadata Type</a></li>
  71         </ol>
  72       </li>
  73       <li><a href="#t_derived">Derived Types</a>
  74         <ol>
  75           <li><a href="#t_aggregate">Aggregate Types</a>
  76             <ol>
  77               <li><a href="#t_array">Array Type</a></li>
  78               <li><a href="#t_struct">Structure Type</a></li>
  79               <li><a href="#t_opaque">Opaque Structure Types</a></li>
  80               <li><a href="#t_vector">Vector Type</a></li>
  81             </ol>
  82           </li>
  83           <li><a href="#t_function">Function Type</a></li>
  84           <li><a href="#t_pointer">Pointer Type</a></li>
  85         </ol>
  86       </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_resume">'<tt>resume</tt>'  Instruction</a></li>
 128           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 129         </ol>
 130       </li>
 131       <li><a href="#binaryops">Binary Operations</a>
 132         <ol>
 133           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 134           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 135           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 136           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 137           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 138           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 139           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 140           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 141           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 142           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 143           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 144           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 145         </ol>
 146       </li>
 147       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 148         <ol>
 149           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 150           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 151           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 152           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 153           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 154           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 155         </ol>
 156       </li>
 157       <li><a href="#vectorops">Vector Operations</a>
 158         <ol>
 159           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 160           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 161           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 162         </ol>
 163       </li>
 164       <li><a href="#aggregateops">Aggregate Operations</a>
 165         <ol>
 166           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 167           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 168         </ol>
 169       </li>
 170       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 171         <ol>
 172           <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
 173          <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
 174          <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
 175          <li><a href="#i_fence">'<tt>fence</tt>' Instruction</a></li>
 176          <li><a href="#i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a></li>
 177          <li><a href="#i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a></li>
 178          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 179         </ol>
 180       </li>
 181       <li><a href="#convertops">Conversion Operations</a>
 182         <ol>
 183           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 184           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 185           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 186           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 187           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 188           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 191           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 192           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 193           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 194           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 195         </ol>
 196       </li>
 197       <li><a href="#otherops">Other Operations</a>
 198         <ol>
 199           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 200           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 201           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 202           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 203           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 204           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 205           <li><a href="#i_landingpad">'<tt>landingpad</tt>' Instruction</a></li>
 206         </ol>
 207       </li>
 208     </ol>
 209   </li>
 210   <li><a href="#intrinsics">Intrinsic Functions</a>
 211     <ol>
 212       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 213         <ol>
 214           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 215           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 216           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 217         </ol>
 218       </li>
 219       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 220         <ol>
 221           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 222           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 223           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 224         </ol>
 225       </li>
 226       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 227         <ol>
 228           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 229           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 230           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 231           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 232           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 233           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 234           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 235         </ol>
 236       </li>
 237       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 238         <ol>
 239           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 240           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 241           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 242           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 243           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 244           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 245           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 246           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 247           <li><a href="#int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a></li>
 248           <li><a href="#int_log">'<tt>llvm.log.*</tt>' Intrinsic</a></li>
 249           <li><a href="#int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a></li>
 250         </ol>
 251       </li>
 252       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 253         <ol>
 254           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 255           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 256           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 257           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 258         </ol>
 259       </li>
 260       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 261         <ol>
 262           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 263           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 264           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 265           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 266           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 267           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 268         </ol>
 269       </li>
 270       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 271         <ol>
 272           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 273           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 274         </ol>
 275       </li>
 276       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 277       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 278       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 279         <ol>
 280           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 281         </ol>
 282       </li>
 283       <li><a href="#int_atomics">Atomic intrinsics</a>
 284         <ol>
 285           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 286           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 287           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 288           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 289           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 290           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 291           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 292           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 293           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 294           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 295           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 296           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 297           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 301         <ol>
 302           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 303           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 304           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 305           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 306         </ol>
 307       </li>
 308       <li><a href="#int_general">General intrinsics</a>
 309         <ol>
 310           <li><a href="#int_var_annotation">
 311             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 312           <li><a href="#int_annotation">
 313             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 314           <li><a href="#int_trap">
 315             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 316           <li><a href="#int_stackprotector">
 317             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 318           <li><a href="#int_objectsize">
 319             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 320         </ol>
 321       </li>
 322     </ol>
 323   </li>
 324 </ol>
 325
 326 <div class="doc_author">
 327   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 328             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 329 </div>
 330
 331 <!-- *********************************************************************** -->
 332 <h2><a name="abstract">Abstract</a></h2>
 333 <!-- *********************************************************************** -->
 334
 335 <div>
 336
 337 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 338    a Static Single Assignment (SSA) based representation that provides type
 339    safety, low-level operations, flexibility, and the capability of representing
 340    'all' high-level languages cleanly.  It is the common code representation
 341    used throughout all phases of the LLVM compilation strategy.</p>
 342
 343 </div>
 344
 345 <!-- *********************************************************************** -->
 346 <h2><a name="introduction">Introduction</a></h2>
 347 <!-- *********************************************************************** -->
 348
 349 <div>
 350
 351 <p>The LLVM code representation is designed to be used in three different forms:
 352    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 353    for fast loading by a Just-In-Time compiler), and as a human readable
 354    assembly language representation.  This allows LLVM to provide a powerful
 355    intermediate representation for efficient compiler transformations and
 356    analysis, while providing a natural means to debug and visualize the
 357    transformations.  The three different forms of LLVM are all equivalent.  This
 358    document describes the human readable representation and notation.</p>
 359
 360 <p>The LLVM representation aims to be light-weight and low-level while being
 361    expressive, typed, and extensible at the same time.  It aims to be a
 362    "universal IR" of sorts, by being at a low enough level that high-level ideas
 363    may be cleanly mapped to it (similar to how microprocessors are "universal
 364    IR's", allowing many source languages to be mapped to them).  By providing
 365    type information, LLVM can be used as the target of optimizations: for
 366    example, through pointer analysis, it can be proven that a C automatic
 367    variable is never accessed outside of the current function, allowing it to
 368    be promoted to a simple SSA value instead of a memory location.</p>
 369
 370 <!-- _______________________________________________________________________ -->
 371 <h4>
 372   <a name="wellformed">Well-Formedness</a>
 373 </h4>
 374
 375 <div>
 376
 377 <p>It is important to note that this document describes 'well formed' LLVM
 378    assembly language.  There is a difference between what the parser accepts and
 379    what is considered 'well formed'.  For example, the following instruction is
 380    syntactically okay, but not well formed:</p>
 381
 382 <pre class="doc_code">
 383 %x = <a href="#i_add">add</a> i32 1, %x
 384 </pre>
 385
 386 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 387    LLVM infrastructure provides a verification pass that may be used to verify
 388    that an LLVM module is well formed.  This pass is automatically run by the
 389    parser after parsing input assembly and by the optimizer before it outputs
 390    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 391    transformation passes or input to the parser.</p>
 392
 393 </div>
 394
 395 </div>
 396
 397 <!-- Describe the typesetting conventions here. -->
 398
 399 <!-- *********************************************************************** -->
 400 <h2><a name="identifiers">Identifiers</a></h2>
 401 <!-- *********************************************************************** -->
 402
 403 <div>
 404
 405 <p>LLVM identifiers come in two basic types: global and local. Global
 406    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 407    character. Local identifiers (register names, types) begin with
 408    the <tt>'%'</tt> character. Additionally, there are three different formats
 409    for identifiers, for different purposes:</p>
 410
 411 <ol>
 412   <li>Named values are represented as a string of characters with their prefix.
 413       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 414       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 415       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 416       other characters in their names can be surrounded with quotes. Special
 417       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 418       ASCII code for the character in hexadecimal.  In this way, any character
 419       can be used in a name value, even quotes themselves.</li>
 420
 421   <li>Unnamed values are represented as an unsigned numeric value with their
 422       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 423
 424   <li>Constants, which are described in a <a href="#constants">section about
 425       constants</a>, below.</li>
 426 </ol>
 427
 428 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 429    don't need to worry about name clashes with reserved words, and the set of
 430    reserved words may be expanded in the future without penalty.  Additionally,
 431    unnamed identifiers allow a compiler to quickly come up with a temporary
 432    variable without having to avoid symbol table conflicts.</p>
 433
 434 <p>Reserved words in LLVM are very similar to reserved words in other
 435    languages. There are keywords for different opcodes
 436    ('<tt><a href="#i_add">add</a></tt>',
 437    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 438    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 439    ('<tt><a href="#t_void">void</a></tt>',
 440    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 441    reserved words cannot conflict with variable names, because none of them
 442    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 443
 444 <p>Here is an example of LLVM code to multiply the integer variable
 445    '<tt>%X</tt>' by 8:</p>
 446
 447 <p>The easy way:</p>
 448
 449 <pre class="doc_code">
 450 %result = <a href="#i_mul">mul</a> i32 %X, 8
 451 </pre>
 452
 453 <p>After strength reduction:</p>
 454
 455 <pre class="doc_code">
 456 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 457 </pre>
 458
 459 <p>And the hard way:</p>
 460
 461 <pre class="doc_code">
 462 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 463 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 464 %result = <a href="#i_add">add</a> i32 %1, %1
 465 </pre>
 466
 467 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 468    lexical features of LLVM:</p>
 469
 470 <ol>
 471   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 472       line.</li>
 473
 474   <li>Unnamed temporaries are created when the result of a computation is not
 475       assigned to a named value.</li>
 476
 477   <li>Unnamed temporaries are numbered sequentially</li>
 478 </ol>
 479
 480 <p>It also shows a convention that we follow in this document.  When
 481    demonstrating instructions, we will follow an instruction with a comment that
 482    defines the type and name of value produced.  Comments are shown in italic
 483    text.</p>
 484
 485 </div>
 486
 487 <!-- *********************************************************************** -->
 488 <h2><a name="highlevel">High Level Structure</a></h2>
 489 <!-- *********************************************************************** -->
 490 <div>
 491 <!-- ======================================================================= -->
 492 <h3>
 493   <a name="modulestructure">Module Structure</a>
 494 </h3>
 495
 496 <div>
 497
 498 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 499    of the input programs.  Each module consists of functions, global variables,
 500    and symbol table entries.  Modules may be combined together with the LLVM
 501    linker, which merges function (and global variable) definitions, resolves
 502    forward declarations, and merges symbol table entries. Here is an example of
 503    the "hello world" module:</p>
 504
 505 <pre class="doc_code">
 506 <i>; Declare the string constant as a global constant.</i>&nbsp;
 507 <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;
 508
 509 <i>; External declaration of the puts function</i>&nbsp;
 510 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 511
 512 <i>; Definition of main function</i>
 513 define i32 @main() {   <i>; i32()* </i>&nbsp;
 514   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 515   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 516
 517   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 518   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 519   <a href="#i_ret">ret</a> i32 0&nbsp;
 520 }
 521
 522 <i>; Named metadata</i>
 523 !1 = metadata !{i32 41}
 524 !foo = !{!1, null}
 525 </pre>
 526
 527 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 528    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 529    a <a href="#functionstructure">function definition</a> for
 530    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 531    "<tt>foo"</tt>.</p>
 532
 533 <p>In general, a module is made up of a list of global values, where both
 534    functions and global variables are global values.  Global values are
 535    represented by a pointer to a memory location (in this case, a pointer to an
 536    array of char, and a pointer to a function), and have one of the
 537    following <a href="#linkage">linkage types</a>.</p>
 538
 539 </div>
 540
 541 <!-- ======================================================================= -->
 542 <h3>
 543   <a name="linkage">Linkage Types</a>
 544 </h3>
 545
 546 <div>
 547
 548 <p>All Global Variables and Functions have one of the following types of
 549    linkage:</p>
 550
 551 <dl>
 552   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 553   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 554       by objects in the current module. In particular, linking code into a
 555       module with an private global value may cause the private to be renamed as
 556       necessary to avoid collisions.  Because the symbol is private to the
 557       module, all references can be updated. This doesn't show up in any symbol
 558       table in the object file.</dd>
 559
 560   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 561   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 562       assembler and evaluated by the linker. Unlike normal strong symbols, they
 563       are removed by the linker from the final linked image (executable or
 564       dynamic library).</dd>
 565
 566   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 567   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 568       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 569       linker. The symbols are removed by the linker from the final linked image
 570       (executable or dynamic library).</dd>
 571
 572   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 573   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 574       of the object is not taken. For instance, functions that had an inline
 575       definition, but the compiler decided not to inline it. Note,
 576       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 577       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 578       visibility.  The symbols are removed by the linker from the final linked
 579       image (executable or dynamic library).</dd>
 580
 581   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 582   <dd>Similar to private, but the value shows as a local symbol
 583       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 584       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 585
 586   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 587   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 588       into the object file corresponding to the LLVM module.  They exist to
 589       allow inlining and other optimizations to take place given knowledge of
 590       the definition of the global, which is known to be somewhere outside the
 591       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 592       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 593       This linkage type is only allowed on definitions, not declarations.</dd>
 594
 595   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 596   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 597       the same name when linkage occurs.  This can be used to implement
 598       some forms of inline functions, templates, or other code which must be
 599       generated in each translation unit that uses it, but where the body may
 600       be overridden with a more definitive definition later.  Unreferenced
 601       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 602       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 603       inline the body of this function into callers because it doesn't know if
 604       this definition of the function is the definitive definition within the
 605       program or whether it will be overridden by a stronger definition.
 606       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 607       linkage.</dd>
 608
 609   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 610   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 611       <tt>linkonce</tt> linkage, except that unreferenced globals with
 612       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 613       are declared "weak" in C source code.</dd>
 614
 615   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 616   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 617       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 618       global scope.
 619       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 620       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 621       <tt>common</tt> symbols may not have an explicit section,
 622       must have a zero initializer, and may not be marked '<a
 623       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 624       have common linkage.</dd>
 625
 626
 627   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 628   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 629       pointer to array type.  When two global variables with appending linkage
 630       are linked together, the two global arrays are appended together.  This is
 631       the LLVM, typesafe, equivalent of having the system linker append together
 632       "sections" with identical names when .o files are linked.</dd>
 633
 634   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 635   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 636       is weak until linked, if not linked, the symbol becomes null instead of
 637       being an undefined reference.</dd>
 638
 639   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 640   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 641   <dd>Some languages allow differing globals to be merged, such as two functions
 642       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 643       that only equivalent globals are ever merged (the "one definition rule"
 644       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 645       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 646       be merged with equivalent globals.  These linkage types are otherwise the
 647       same as their non-<tt>odr</tt> versions.</dd>
 648
 649   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 650   <dd>If none of the above identifiers are used, the global is externally
 651       visible, meaning that it participates in linkage and can be used to
 652       resolve external symbol references.</dd>
 653 </dl>
 654
 655 <p>The next two types of linkage are targeted for Microsoft Windows platform
 656    only. They are designed to support importing (exporting) symbols from (to)
 657    DLLs (Dynamic Link Libraries).</p>
 658
 659 <dl>
 660   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 661   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 662       or variable via a global pointer to a pointer that is set up by the DLL
 663       exporting the symbol. On Microsoft Windows targets, the pointer name is
 664       formed by combining <code>__imp_</code> and the function or variable
 665       name.</dd>
 666
 667   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 668   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 669       pointer to a pointer in a DLL, so that it can be referenced with the
 670       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 671       name is formed by combining <code>__imp_</code> and the function or
 672       variable name.</dd>
 673 </dl>
 674
 675 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 676    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 677    one, one of the two would be renamed, preventing a collision.  Since
 678    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 679    declarations), they are accessible outside of the current module.</p>
 680
 681 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 682    other than "externally visible", <tt>dllimport</tt>
 683    or <tt>extern_weak</tt>.</p>
 684
 685 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 686    or <tt>weak_odr</tt> linkages.</p>
 687
 688 </div>
 689
 690 <!-- ======================================================================= -->
 691 <h3>
 692   <a name="callingconv">Calling Conventions</a>
 693 </h3>
 694
 695 <div>
 696
 697 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 698    and <a href="#i_invoke">invokes</a> can all have an optional calling
 699    convention specified for the call.  The calling convention of any pair of
 700    dynamic caller/callee must match, or the behavior of the program is
 701    undefined.  The following calling conventions are supported by LLVM, and more
 702    may be added in the future:</p>
 703
 704 <dl>
 705   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 706   <dd>This calling convention (the default if no other calling convention is
 707       specified) matches the target C calling conventions.  This calling
 708       convention supports varargs function calls and tolerates some mismatch in
 709       the declared prototype and implemented declaration of the function (as
 710       does normal C).</dd>
 711
 712   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make calls as fast as possible
 714       (e.g. by passing things in registers).  This calling convention allows the
 715       target to use whatever tricks it wants to produce fast code for the
 716       target, without having to conform to an externally specified ABI
 717       (Application Binary Interface).
 718       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 719       when this or the GHC convention is used.</a>  This calling convention
 720       does not support varargs and requires the prototype of all callees to
 721       exactly match the prototype of the function definition.</dd>
 722
 723   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 724   <dd>This calling convention attempts to make code in the caller as efficient
 725       as possible under the assumption that the call is not commonly executed.
 726       As such, these calls often preserve all registers so that the call does
 727       not break any live ranges in the caller side.  This calling convention
 728       does not support varargs and requires the prototype of all callees to
 729       exactly match the prototype of the function definition.</dd>
 730
 731   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 732   <dd>This calling convention has been implemented specifically for use by the
 733       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 734       It passes everything in registers, going to extremes to achieve this by
 735       disabling callee save registers. This calling convention should not be
 736       used lightly but only for specific situations such as an alternative to
 737       the <em>register pinning</em> performance technique often used when
 738       implementing functional programming languages.At the moment only X86
 739       supports this convention and it has the following limitations:
 740       <ul>
 741         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 742             floating point types are supported.</li>
 743         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 744             6 floating point parameters.</li>
 745       </ul>
 746       This calling convention supports
 747       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 748       requires both the caller and callee are using it.
 749   </dd>
 750
 751   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 752   <dd>Any calling convention may be specified by number, allowing
 753       target-specific calling conventions to be used.  Target specific calling
 754       conventions start at 64.</dd>
 755 </dl>
 756
 757 <p>More calling conventions can be added/defined on an as-needed basis, to
 758    support Pascal conventions or any other well-known target-independent
 759    convention.</p>
 760
 761 </div>
 762
 763 <!-- ======================================================================= -->
 764 <h3>
 765   <a name="visibility">Visibility Styles</a>
 766 </h3>
 767
 768 <div>
 769
 770 <p>All Global Variables and Functions have one of the following visibility
 771    styles:</p>
 772
 773 <dl>
 774   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 775   <dd>On targets that use the ELF object file format, default visibility means
 776       that the declaration is visible to other modules and, in shared libraries,
 777       means that the declared entity may be overridden. On Darwin, default
 778       visibility means that the declaration is visible to other modules. Default
 779       visibility corresponds to "external linkage" in the language.</dd>
 780
 781   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 782   <dd>Two declarations of an object with hidden visibility refer to the same
 783       object if they are in the same shared object. Usually, hidden visibility
 784       indicates that the symbol will not be placed into the dynamic symbol
 785       table, so no other module (executable or shared library) can reference it
 786       directly.</dd>
 787
 788   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 789   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 790       the dynamic symbol table, but that references within the defining module
 791       will bind to the local symbol. That is, the symbol cannot be overridden by
 792       another module.</dd>
 793 </dl>
 794
 795 </div>
 796
 797 <!-- ======================================================================= -->
 798 <h3>
 799   <a name="namedtypes">Named Types</a>
 800 </h3>
 801
 802 <div>
 803
 804 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 805    it easier to read the IR and make the IR more condensed (particularly when
 806    recursive types are involved).  An example of a name specification is:</p>
 807
 808 <pre class="doc_code">
 809 %mytype = type { %mytype*, i32 }
 810 </pre>
 811
 812 <p>You may give a name to any <a href="#typesystem">type</a> except
 813    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 814    is expected with the syntax "%mytype".</p>
 815
 816 <p>Note that type names are aliases for the structural type that they indicate,
 817    and that you can therefore specify multiple names for the same type.  This
 818    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 819    uses structural typing, the name is not part of the type.  When printing out
 820    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 821    particular shape.  This means that if you have code where two different
 822    source types end up having the same LLVM type, that the dumper will sometimes
 823    print the "wrong" or unexpected type.  This is an important design point and
 824    isn't going to change.</p>
 825
 826 </div>
 827
 828 <!-- ======================================================================= -->
 829 <h3>
 830   <a name="globalvars">Global Variables</a>
 831 </h3>
 832
 833 <div>
 834
 835 <p>Global variables define regions of memory allocated at compilation time
 836    instead of run-time.  Global variables may optionally be initialized, may
 837    have an explicit section to be placed in, and may have an optional explicit
 838    alignment specified.  A variable may be defined as "thread_local", which
 839    means that it will not be shared by threads (each thread will have a
 840    separated copy of the variable).  A variable may be defined as a global
 841    "constant," which indicates that the contents of the variable
 842    will <b>never</b> be modified (enabling better optimization, allowing the
 843    global data to be placed in the read-only section of an executable, etc).
 844    Note that variables that need runtime initialization cannot be marked
 845    "constant" as there is a store to the variable.</p>
 846
 847 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 848    constant, even if the final definition of the global is not.  This capability
 849    can be used to enable slightly better optimization of the program, but
 850    requires the language definition to guarantee that optimizations based on the
 851    'constantness' are valid for the translation units that do not include the
 852    definition.</p>
 853
 854 <p>As SSA values, global variables define pointer values that are in scope
 855    (i.e. they dominate) all basic blocks in the program.  Global variables
 856    always define a pointer to their "content" type because they describe a
 857    region of memory, and all memory objects in LLVM are accessed through
 858    pointers.</p>
 859
 860 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 861   that the address is not significant, only the content. Constants marked
 862   like this can be merged with other constants if they have the same
 863   initializer. Note that a constant with significant address <em>can</em>
 864   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 865   constant whose address is significant.</p>
 866
 867 <p>A global variable may be declared to reside in a target-specific numbered
 868    address space. For targets that support them, address spaces may affect how
 869    optimizations are performed and/or what target instructions are used to
 870    access the variable. The default address space is zero. The address space
 871    qualifier must precede any other attributes.</p>
 872
 873 <p>LLVM allows an explicit section to be specified for globals.  If the target
 874    supports it, it will emit globals to the section specified.</p>
 875
 876 <p>An explicit alignment may be specified for a global, which must be a power
 877    of 2.  If not present, or if the alignment is set to zero, the alignment of
 878    the global is set by the target to whatever it feels convenient.  If an
 879    explicit alignment is specified, the global is forced to have exactly that
 880    alignment.  Targets and optimizers are not allowed to over-align the global
 881    if the global has an assigned section.  In this case, the extra alignment
 882    could be observable: for example, code could assume that the globals are
 883    densely packed in their section and try to iterate over them as an array,
 884    alignment padding would break this iteration.</p>
 885
 886 <p>For example, the following defines a global in a numbered address space with
 887    an initializer, section, and alignment:</p>
 888
 889 <pre class="doc_code">
 890 @G = addrspace(5) constant float 1.0, section "foo", align 4
 891 </pre>
 892
 893 </div>
 894
 895
 896 <!-- ======================================================================= -->
 897 <h3>
 898   <a name="functionstructure">Functions</a>
 899 </h3>
 900
 901 <div>
 902
 903 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 904    optional <a href="#linkage">linkage type</a>, an optional
 905    <a href="#visibility">visibility style</a>, an optional
 906    <a href="#callingconv">calling convention</a>,
 907    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 908    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 909    name, a (possibly empty) argument list (each with optional
 910    <a href="#paramattrs">parameter attributes</a>), optional
 911    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 912    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 913    curly brace, a list of basic blocks, and a closing curly brace.</p>
 914
 915 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 916    optional <a href="#linkage">linkage type</a>, an optional
 917    <a href="#visibility">visibility style</a>, an optional
 918    <a href="#callingconv">calling convention</a>,
 919    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 920    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 921    name, a possibly empty list of arguments, an optional alignment, and an
 922    optional <a href="#gc">garbage collector name</a>.</p>
 923
 924 <p>A function definition contains a list of basic blocks, forming the CFG
 925    (Control Flow Graph) for the function.  Each basic block may optionally start
 926    with a label (giving the basic block a symbol table entry), contains a list
 927    of instructions, and ends with a <a href="#terminators">terminator</a>
 928    instruction (such as a branch or function return).</p>
 929
 930 <p>The first basic block in a function is special in two ways: it is immediately
 931    executed on entrance to the function, and it is not allowed to have
 932    predecessor basic blocks (i.e. there can not be any branches to the entry
 933    block of a function).  Because the block can have no predecessors, it also
 934    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 935
 936 <p>LLVM allows an explicit section to be specified for functions.  If the target
 937    supports it, it will emit functions to the section specified.</p>
 938
 939 <p>An explicit alignment may be specified for a function.  If not present, or if
 940    the alignment is set to zero, the alignment of the function is set by the
 941    target to whatever it feels convenient.  If an explicit alignment is
 942    specified, the function is forced to have at least that much alignment.  All
 943    alignments must be a power of 2.</p>
 944
 945 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 946   be significant and two identical functions can be merged</p>.
 947
 948 <h5>Syntax:</h5>
 949 <pre class="doc_code">
 950 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 951        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 952        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 953        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 954        [<a href="#gc">gc</a>] { ... }
 955 </pre>
 956
 957 </div>
 958
 959 <!-- ======================================================================= -->
 960 <h3>
 961   <a name="aliasstructure">Aliases</a>
 962 </h3>
 963
 964 <div>
 965
 966 <p>Aliases act as "second name" for the aliasee value (which can be either
 967    function, global variable, another alias or bitcast of global value). Aliases
 968    may have an optional <a href="#linkage">linkage type</a>, and an
 969    optional <a href="#visibility">visibility style</a>.</p>
 970
 971 <h5>Syntax:</h5>
 972 <pre class="doc_code">
 973 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 974 </pre>
 975
 976 </div>
 977
 978 <!-- ======================================================================= -->
 979 <h3>
 980   <a name="namedmetadatastructure">Named Metadata</a>
 981 </h3>
 982
 983 <div>
 984
 985 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 986    nodes</a> (but not metadata strings) are the only valid operands for
 987    a named metadata.</p>
 988
 989 <h5>Syntax:</h5>
 990 <pre class="doc_code">
 991 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 992 !0 = metadata !{metadata !"zero"}
 993 !1 = metadata !{metadata !"one"}
 994 !2 = metadata !{metadata !"two"}
 995 ; A named metadata.
 996 !name = !{!0, !1, !2}
 997 </pre>
 998
 999 </div>
1000
1001 <!-- ======================================================================= -->
1002 <h3>
1003   <a name="paramattrs">Parameter Attributes</a>
1004 </h3>
1005
1006 <div>
1007
1008 <p>The return type and each parameter of a function type may have a set of
1009    <i>parameter attributes</i> associated with them. Parameter attributes are
1010    used to communicate additional information about the result or parameters of
1011    a function. Parameter attributes are considered to be part of the function,
1012    not of the function type, so functions with different parameter attributes
1013    can have the same function type.</p>
1014
1015 <p>Parameter attributes are simple keywords that follow the type specified. If
1016    multiple parameter attributes are needed, they are space separated. For
1017    example:</p>
1018
1019 <pre class="doc_code">
1020 declare i32 @printf(i8* noalias nocapture, ...)
1021 declare i32 @atoi(i8 zeroext)
1022 declare signext i8 @returns_signed_char()
1023 </pre>
1024
1025 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1026    <tt>readonly</tt>) come immediately after the argument list.</p>
1027
1028 <p>Currently, only the following parameter attributes are defined:</p>
1029
1030 <dl>
1031   <dt><tt><b>zeroext</b></tt></dt>
1032   <dd>This indicates to the code generator that the parameter or return value
1033       should be zero-extended to the extent required by the target's ABI (which
1034       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1035       parameter) or the callee (for a return value).</dd>
1036
1037   <dt><tt><b>signext</b></tt></dt>
1038   <dd>This indicates to the code generator that the parameter or return value
1039       should be sign-extended to the extent required by the target's ABI (which
1040       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1041       return value).</dd>
1042
1043   <dt><tt><b>inreg</b></tt></dt>
1044   <dd>This indicates that this parameter or return value should be treated in a
1045       special target-dependent fashion during while emitting code for a function
1046       call or return (usually, by putting it in a register as opposed to memory,
1047       though some targets use it to distinguish between two different kinds of
1048       registers).  Use of this attribute is target-specific.</dd>
1049
1050   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1051   <dd><p>This indicates that the pointer parameter should really be passed by
1052       value to the function.  The attribute implies that a hidden copy of the
1053       pointee
1054       is made between the caller and the callee, so the callee is unable to
1055       modify the value in the callee.  This attribute is only valid on LLVM
1056       pointer arguments.  It is generally used to pass structs and arrays by
1057       value, but is also valid on pointers to scalars.  The copy is considered
1058       to belong to the caller not the callee (for example,
1059       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1060       <tt>byval</tt> parameters). This is not a valid attribute for return
1061       values.</p>
1062
1063       <p>The byval attribute also supports specifying an alignment with
1064       the align attribute.  It indicates the alignment of the stack slot to
1065       form and the known alignment of the pointer specified to the call site. If
1066       the alignment is not specified, then the code generator makes a
1067       target-specific assumption.</p></dd>
1068
1069   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1070   <dd>This indicates that the pointer parameter specifies the address of a
1071       structure that is the return value of the function in the source program.
1072       This pointer must be guaranteed by the caller to be valid: loads and
1073       stores to the structure may be assumed by the callee to not to trap.  This
1074       may only be applied to the first parameter. This is not a valid attribute
1075       for return values. </dd>
1076
1077   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1078   <dd>This indicates that pointer values
1079       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1080       value do not alias pointer values which are not <i>based</i> on it,
1081       ignoring certain "irrelevant" dependencies.
1082       For a call to the parent function, dependencies between memory
1083       references from before or after the call and from those during the call
1084       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1085       return value used in that call.
1086       The caller shares the responsibility with the callee for ensuring that
1087       these requirements are met.
1088       For further details, please see the discussion of the NoAlias response in
1089       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1090 <br>
1091       Note that this definition of <tt>noalias</tt> is intentionally
1092       similar to the definition of <tt>restrict</tt> in C99 for function
1093       arguments, though it is slightly weaker.
1094 <br>
1095       For function return values, C99's <tt>restrict</tt> is not meaningful,
1096       while LLVM's <tt>noalias</tt> is.
1097       </dd>
1098
1099   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1100   <dd>This indicates that the callee does not make any copies of the pointer
1101       that outlive the callee itself. This is not a valid attribute for return
1102       values.</dd>
1103
1104   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1105   <dd>This indicates that the pointer parameter can be excised using the
1106       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1107       attribute for return values.</dd>
1108 </dl>
1109
1110 </div>
1111
1112 <!-- ======================================================================= -->
1113 <h3>
1114   <a name="gc">Garbage Collector Names</a>
1115 </h3>
1116
1117 <div>
1118
1119 <p>Each function may specify a garbage collector name, which is simply a
1120    string:</p>
1121
1122 <pre class="doc_code">
1123 define void @f() gc "name" { ... }
1124 </pre>
1125
1126 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1127    collector which will cause the compiler to alter its output in order to
1128    support the named garbage collection algorithm.</p>
1129
1130 </div>
1131
1132 <!-- ======================================================================= -->
1133 <h3>
1134   <a name="fnattrs">Function Attributes</a>
1135 </h3>
1136
1137 <div>
1138
1139 <p>Function attributes are set to communicate additional information about a
1140    function. Function attributes are considered to be part of the function, not
1141    of the function type, so functions with different parameter attributes can
1142    have the same function type.</p>
1143
1144 <p>Function attributes are simple keywords that follow the type specified. If
1145    multiple attributes are needed, they are space separated. For example:</p>
1146
1147 <pre class="doc_code">
1148 define void @f() noinline { ... }
1149 define void @f() alwaysinline { ... }
1150 define void @f() alwaysinline optsize { ... }
1151 define void @f() optsize { ... }
1152 </pre>
1153
1154 <dl>
1155   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1156   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1157       the backend should forcibly align the stack pointer. Specify the
1158       desired alignment, which must be a power of two, in parentheses.
1159
1160   <dt><tt><b>alwaysinline</b></tt></dt>
1161   <dd>This attribute indicates that the inliner should attempt to inline this
1162       function into callers whenever possible, ignoring any active inlining size
1163       threshold for this caller.</dd>
1164
1165   <dt><tt><b>hotpatch</b></tt></dt>
1166   <dd>This attribute indicates that the function should be 'hotpatchable',
1167       meaning the function can be patched and/or hooked even while it is
1168       loaded into memory. On x86, the function prologue will be preceded
1169       by six bytes of padding and will begin with a two-byte instruction.
1170       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1171       higher were compiled in this fashion.</dd>
1172
1173   <dt><tt><b>nonlazybind</b></tt></dt>
1174   <dd>This attribute suppresses lazy symbol binding for the function. This
1175       may make calls to the function faster, at the cost of extra program
1176       startup time if the function is not called during program startup.</dd>
1177
1178   <dt><tt><b>inlinehint</b></tt></dt>
1179   <dd>This attribute indicates that the source code contained a hint that inlining
1180       this function is desirable (such as the "inline" keyword in C/C++).  It
1181       is just a hint; it imposes no requirements on the inliner.</dd>
1182
1183   <dt><tt><b>naked</b></tt></dt>
1184   <dd>This attribute disables prologue / epilogue emission for the function.
1185       This can have very system-specific consequences.</dd>
1186
1187   <dt><tt><b>noimplicitfloat</b></tt></dt>
1188   <dd>This attributes disables implicit floating point instructions.</dd>
1189
1190   <dt><tt><b>noinline</b></tt></dt>
1191   <dd>This attribute indicates that the inliner should never inline this
1192       function in any situation. This attribute may not be used together with
1193       the <tt>alwaysinline</tt> attribute.</dd>
1194
1195   <dt><tt><b>noredzone</b></tt></dt>
1196   <dd>This attribute indicates that the code generator should not use a red
1197       zone, even if the target-specific ABI normally permits it.</dd>
1198
1199   <dt><tt><b>noreturn</b></tt></dt>
1200   <dd>This function attribute indicates that the function never returns
1201       normally.  This produces undefined behavior at runtime if the function
1202       ever does dynamically return.</dd>
1203
1204   <dt><tt><b>nounwind</b></tt></dt>
1205   <dd>This function attribute indicates that the function never returns with an
1206       unwind or exceptional control flow.  If the function does unwind, its
1207       runtime behavior is undefined.</dd>
1208
1209   <dt><tt><b>optsize</b></tt></dt>
1210   <dd>This attribute suggests that optimization passes and code generator passes
1211       make choices that keep the code size of this function low, and otherwise
1212       do optimizations specifically to reduce code size.</dd>
1213
1214   <dt><tt><b>readnone</b></tt></dt>
1215   <dd>This attribute indicates that the function computes its result (or decides
1216       to unwind an exception) based strictly on its arguments, without
1217       dereferencing any pointer arguments or otherwise accessing any mutable
1218       state (e.g. memory, control registers, etc) visible to caller functions.
1219       It does not write through any pointer arguments
1220       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1221       changes any state visible to callers.  This means that it cannot unwind
1222       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1223       could use the <tt>unwind</tt> instruction.</dd>
1224
1225   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1226   <dd>This attribute indicates that the function does not write through any
1227       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1228       arguments) or otherwise modify any state (e.g. memory, control registers,
1229       etc) visible to caller functions.  It may dereference pointer arguments
1230       and read state that may be set in the caller.  A readonly function always
1231       returns the same value (or unwinds an exception identically) when called
1232       with the same set of arguments and global state.  It cannot unwind an
1233       exception by calling the <tt>C++</tt> exception throwing methods, but may
1234       use the <tt>unwind</tt> instruction.</dd>
1235
1236   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1237   <dd>This attribute indicates that the function should emit a stack smashing
1238       protector. It is in the form of a "canary"&mdash;a random value placed on
1239       the stack before the local variables that's checked upon return from the
1240       function to see if it has been overwritten. A heuristic is used to
1241       determine if a function needs stack protectors or not.<br>
1242 <br>
1243       If a function that has an <tt>ssp</tt> attribute is inlined into a
1244       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1245       function will have an <tt>ssp</tt> attribute.</dd>
1246
1247   <dt><tt><b>sspreq</b></tt></dt>
1248   <dd>This attribute indicates that the function should <em>always</em> emit a
1249       stack smashing protector. This overrides
1250       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1251 <br>
1252       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1253       function that doesn't have an <tt>sspreq</tt> attribute or which has
1254       an <tt>ssp</tt> attribute, then the resulting function will have
1255       an <tt>sspreq</tt> attribute.</dd>
1256
1257   <dt><tt><b><a name="uwtable">uwtable</a></b></tt></dt>
1258   <dd>This attribute indicates that the ABI being targeted requires that
1259       an unwind table entry be produce for this function even if we can
1260       show that no exceptions passes by it. This is normally the case for
1261       the ELF x86-64 abi, but it can be disabled for some compilation
1262       units.</dd>
1263
1264 </dl>
1265
1266 </div>
1267
1268 <!-- ======================================================================= -->
1269 <h3>
1270   <a name="moduleasm">Module-Level Inline Assembly</a>
1271 </h3>
1272
1273 <div>
1274
1275 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1276    the GCC "file scope inline asm" blocks.  These blocks are internally
1277    concatenated by LLVM and treated as a single unit, but may be separated in
1278    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1279
1280 <pre class="doc_code">
1281 module asm "inline asm code goes here"
1282 module asm "more can go here"
1283 </pre>
1284
1285 <p>The strings can contain any character by escaping non-printable characters.
1286    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1287    for the number.</p>
1288
1289 <p>The inline asm code is simply printed to the machine code .s file when
1290    assembly code is generated.</p>
1291
1292 </div>
1293
1294 <!-- ======================================================================= -->
1295 <h3>
1296   <a name="datalayout">Data Layout</a>
1297 </h3>
1298
1299 <div>
1300
1301 <p>A module may specify a target specific data layout string that specifies how
1302    data is to be laid out in memory. The syntax for the data layout is
1303    simply:</p>
1304
1305 <pre class="doc_code">
1306 target datalayout = "<i>layout specification</i>"
1307 </pre>
1308
1309 <p>The <i>layout specification</i> consists of a list of specifications
1310    separated by the minus sign character ('-').  Each specification starts with
1311    a letter and may include other information after the letter to define some
1312    aspect of the data layout.  The specifications accepted are as follows:</p>
1313
1314 <dl>
1315   <dt><tt>E</tt></dt>
1316   <dd>Specifies that the target lays out data in big-endian form. That is, the
1317       bits with the most significance have the lowest address location.</dd>
1318
1319   <dt><tt>e</tt></dt>
1320   <dd>Specifies that the target lays out data in little-endian form. That is,
1321       the bits with the least significance have the lowest address
1322       location.</dd>
1323
1324   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1325   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1326       <i>preferred</i> alignments. All sizes are in bits. Specifying
1327       the <i>pref</i> alignment is optional. If omitted, the
1328       preceding <tt>:</tt> should be omitted too.</dd>
1329
1330   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1331   <dd>This specifies the alignment for an integer type of a given bit
1332       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1333
1334   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1335   <dd>This specifies the alignment for a vector type of a given bit
1336       <i>size</i>.</dd>
1337
1338   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1339   <dd>This specifies the alignment for a floating point type of a given bit
1340       <i>size</i>. Only values of <i>size</i> that are supported by the target
1341       will work.  32 (float) and 64 (double) are supported on all targets;
1342       80 or 128 (different flavors of long double) are also supported on some
1343       targets.
1344
1345   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1346   <dd>This specifies the alignment for an aggregate type of a given bit
1347       <i>size</i>.</dd>
1348
1349   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1350   <dd>This specifies the alignment for a stack object of a given bit
1351       <i>size</i>.</dd>
1352
1353   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1354   <dd>This specifies a set of native integer widths for the target CPU
1355       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1356       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1357       this set are considered to support most general arithmetic
1358       operations efficiently.</dd>
1359 </dl>
1360
1361 <p>When constructing the data layout for a given target, LLVM starts with a
1362    default set of specifications which are then (possibly) overridden by the
1363    specifications in the <tt>datalayout</tt> keyword. The default specifications
1364    are given in this list:</p>
1365
1366 <ul>
1367   <li><tt>E</tt> - big endian</li>
1368   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1369   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1370   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1371   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1372   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1373   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1374   alignment of 64-bits</li>
1375   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1376   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1377   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1378   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1379   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1380   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1381 </ul>
1382
1383 <p>When LLVM is determining the alignment for a given type, it uses the
1384    following rules:</p>
1385
1386 <ol>
1387   <li>If the type sought is an exact match for one of the specifications, that
1388       specification is used.</li>
1389
1390   <li>If no match is found, and the type sought is an integer type, then the
1391       smallest integer type that is larger than the bitwidth of the sought type
1392       is used. If none of the specifications are larger than the bitwidth then
1393       the the largest integer type is used. For example, given the default
1394       specifications above, the i7 type will use the alignment of i8 (next
1395       largest) while both i65 and i256 will use the alignment of i64 (largest
1396       specified).</li>
1397
1398   <li>If no match is found, and the type sought is a vector type, then the
1399       largest vector type that is smaller than the sought vector type will be
1400       used as a fall back.  This happens because &lt;128 x double&gt; can be
1401       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1402 </ol>
1403
1404 </div>
1405
1406 <!-- ======================================================================= -->
1407 <h3>
1408   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1409 </h3>
1410
1411 <div>
1412
1413 <p>Any memory access must be done through a pointer value associated
1414 with an address range of the memory access, otherwise the behavior
1415 is undefined. Pointer values are associated with address ranges
1416 according to the following rules:</p>
1417
1418 <ul>
1419   <li>A pointer value is associated with the addresses associated with
1420       any value it is <i>based</i> on.
1421   <li>An address of a global variable is associated with the address
1422       range of the variable's storage.</li>
1423   <li>The result value of an allocation instruction is associated with
1424       the address range of the allocated storage.</li>
1425   <li>A null pointer in the default address-space is associated with
1426       no address.</li>
1427   <li>An integer constant other than zero or a pointer value returned
1428       from a function not defined within LLVM may be associated with address
1429       ranges allocated through mechanisms other than those provided by
1430       LLVM. Such ranges shall not overlap with any ranges of addresses
1431       allocated by mechanisms provided by LLVM.</li>
1432 </ul>
1433
1434 <p>A pointer value is <i>based</i> on another pointer value according
1435    to the following rules:</p>
1436
1437 <ul>
1438   <li>A pointer value formed from a
1439       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1440       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1441   <li>The result value of a
1442       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1443       of the <tt>bitcast</tt>.</li>
1444   <li>A pointer value formed by an
1445       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1446       pointer values that contribute (directly or indirectly) to the
1447       computation of the pointer's value.</li>
1448   <li>The "<i>based</i> on" relationship is transitive.</li>
1449 </ul>
1450
1451 <p>Note that this definition of <i>"based"</i> is intentionally
1452    similar to the definition of <i>"based"</i> in C99, though it is
1453    slightly weaker.</p>
1454
1455 <p>LLVM IR does not associate types with memory. The result type of a
1456 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1457 alignment of the memory from which to load, as well as the
1458 interpretation of the value. The first operand type of a
1459 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1460 and alignment of the store.</p>
1461
1462 <p>Consequently, type-based alias analysis, aka TBAA, aka
1463 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1464 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1465 additional information which specialized optimization passes may use
1466 to implement type-based alias analysis.</p>
1467
1468 </div>
1469
1470 <!-- ======================================================================= -->
1471 <h3>
1472   <a name="volatile">Volatile Memory Accesses</a>
1473 </h3>
1474
1475 <div>
1476
1477 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1478 href="#i_store"><tt>store</tt></a>s, and <a
1479 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1480 The optimizers must not change the number of volatile operations or change their
1481 order of execution relative to other volatile operations.  The optimizers
1482 <i>may</i> change the order of volatile operations relative to non-volatile
1483 operations.  This is not Java's "volatile" and has no cross-thread
1484 synchronization behavior.</p>
1485
1486 </div>
1487
1488 <!-- ======================================================================= -->
1489 <h3>
1490   <a name="memmodel">Memory Model for Concurrent Operations</a>
1491 </h3>
1492
1493 <div>
1494
1495 <p>The LLVM IR does not define any way to start parallel threads of execution
1496 or to register signal handlers. Nonetheless, there are platform-specific
1497 ways to create them, and we define LLVM IR's behavior in their presence. This
1498 model is inspired by the C++0x memory model.</p>
1499
1500 <p>We define a <i>happens-before</i> partial order as the least partial order
1501 that</p>
1502 <ul>
1503   <li>Is a superset of single-thread program order, and</li>
1504   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1505       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1506       by platform-specific techniques, like pthread locks, thread
1507       creation, thread joining, etc., and by atomic instructions.
1508       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1509       </li>
1510 </ul>
1511
1512 <p>Note that program order does not introduce <i>happens-before</i> edges
1513 between a thread and signals executing inside that thread.</p>
1514
1515 <p>Every (defined) read operation (load instructions, memcpy, atomic
1516 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1517 (defined) write operations (store instructions, atomic
1518 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1519 initialized globals are considered to have a write of the initializer which is
1520 atomic and happens before any other read or write of the memory in question.
1521 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1522 any write to the same byte, except:</p>
1523
1524 <ul>
1525   <li>If <var>write<sub>1</sub></var> happens before
1526       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1527       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1528       does not see <var>write<sub>1</sub></var>.
1529   <li>If <var>R<sub>byte</sub></var> happens before
1530       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1531       see <var>write<sub>3</sub></var>.
1532 </ul>
1533
1534 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1535 <ul>
1536   <li>If there is no write to the same byte that happens before
1537     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1538     <tt>undef</tt> for that byte.
1539   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1540       <var>R<sub>byte</sub></var> returns the value written by that
1541       write.</li>
1542   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1543       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1544       values written.  See the <a href="#ordering">Atomic Memory Ordering
1545       Constraints</a> section for additional constraints on how the choice
1546       is made.
1547   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1548 </ul>
1549
1550 <p><var>R</var> returns the value composed of the series of bytes it read.
1551 This implies that some bytes within the value may be <tt>undef</tt>
1552 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1553 defines the semantics of the operation; it doesn't mean that targets will
1554 emit more than one instruction to read the series of bytes.</p>
1555
1556 <p>Note that in cases where none of the atomic intrinsics are used, this model
1557 places only one restriction on IR transformations on top of what is required
1558 for single-threaded execution: introducing a store to a byte which might not
1559 otherwise be stored is not allowed in general.  (Specifically, in the case
1560 where another thread might write to and read from an address, introducing a
1561 store can change a load that may see exactly one write into a load that may
1562 see multiple writes.)</p>
1563
1564 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1565 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1566 none of the backends currently in the tree fall into this category; however,
1567 there might be targets which care.  If there are, we want a paragraph
1568 like the following:
1569
1570 Targets may specify that stores narrower than a certain width are not
1571 available; on such a target, for the purposes of this model, treat any
1572 non-atomic write with an alignment or width less than the minimum width
1573 as if it writes to the relevant surrounding bytes.
1574 -->
1575
1576 </div>
1577
1578 <!-- ======================================================================= -->
1579 <div class="doc_subsection">
1580       <a name="ordering">Atomic Memory Ordering Constraints</a>
1581 </div>
1582
1583 <div class="doc_text">
1584
1585 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1586 <a href="#i_atomicrmw"><code>atomicrmw</code></a>,
1587 <a href="#i_fence"><code>fence</code></a>,
1588 <a href="#i_load"><code>atomic load</code></a>, and
1589 <a href="#i_store"><code>atomic store</code></a>) take an ordering parameter
1590 that determines which other atomic instructions on the same address they
1591 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1592 but are somewhat more colloquial. If these descriptions aren't precise enough,
1593 check those specs.  <a href="#i_fence"><code>fence</code></a> instructions
1594 treat these orderings somewhat differently since they don't take an address.
1595 See that instruction's documentation for details.</p>
1596
1597 <dl>
1598 <dt><code>unordered</code></dt>
1599 <dd>The set of values that can be read is governed by the happens-before
1600 partial order. A value cannot be read unless some operation wrote it.
1601 This is intended to provide a guarantee strong enough to model Java's
1602 non-volatile shared variables.  This ordering cannot be specified for
1603 read-modify-write operations; it is not strong enough to make them atomic
1604 in any interesting way.</dd>
1605 <dt><code>monotonic</code></dt>
1606 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1607 total order for modifications by <code>monotonic</code> operations on each
1608 address. All modification orders must be compatible with the happens-before
1609 order. There is no guarantee that the modification orders can be combined to
1610 a global total order for the whole program (and this often will not be
1611 possible). The read in an atomic read-modify-write operation
1612 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1613 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1614 reads the value in the modification order immediately before the value it
1615 writes. If one atomic read happens before another atomic read of the same
1616 address, the later read must see the same value or a later value in the
1617 address's modification order. This disallows reordering of
1618 <code>monotonic</code> (or stronger) operations on the same address. If an
1619 address is written <code>monotonic</code>ally by one thread, and other threads
1620 <code>monotonic</code>ally read that address repeatedly, the other threads must
1621 eventually see the write. This is intended to model C++'s relaxed atomic
1622 variables.</dd>
1623 <dt><code>acquire</code></dt>
1624 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1625 reads a value written by a <code>release</code> atomic operation, it
1626 <i>synchronizes-with</i> that operation.</dd>
1627 <dt><code>release</code></dt>
1628 <dd>In addition to the guarantees of <code>monotonic</code>,
1629 a <i>synchronizes-with</i> edge may be formed by an <code>acquire</code>
1630 operation.</dd>
1631 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1632 <code>acquire</code> and <code>release</code> operation on its address.</dd>
1633 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1634 <dd>In addition to the guarantees of <code>acq_rel</code>
1635 (<code>acquire</code> for an operation which only reads, <code>release</code>
1636 for an operation which only writes), there is a global total order on all
1637 sequentially-consistent operations on all addresses, which is consistent with
1638 the <i>happens-before</i> partial order and with the modification orders of
1639 all the affected addresses. Each sequentially-consistent read sees the last
1640 preceding write to the same address in this global order. This is intended
1641 to model C++'s sequentially-consistent atomic variables and Java's volatile
1642 shared variables.</dd>
1643 </dl>
1644
1645 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1646 it only <i>synchronizes with</i> or participates in modification and seq_cst
1647 total orderings with other operations running in the same thread (for example,
1648 in signal handlers).</p>
1649
1650 </div>
1651
1652 </div>
1653
1654 <!-- *********************************************************************** -->
1655 <h2><a name="typesystem">Type System</a></h2>
1656 <!-- *********************************************************************** -->
1657
1658 <div>
1659
1660 <p>The LLVM type system is one of the most important features of the
1661    intermediate representation.  Being typed enables a number of optimizations
1662    to be performed on the intermediate representation directly, without having
1663    to do extra analyses on the side before the transformation.  A strong type
1664    system makes it easier to read the generated code and enables novel analyses
1665    and transformations that are not feasible to perform on normal three address
1666    code representations.</p>
1667
1668 <!-- ======================================================================= -->
1669 <h3>
1670   <a name="t_classifications">Type Classifications</a>
1671 </h3>
1672
1673 <div>
1674
1675 <p>The types fall into a few useful classifications:</p>
1676
1677 <table border="1" cellspacing="0" cellpadding="4">
1678   <tbody>
1679     <tr><th>Classification</th><th>Types</th></tr>
1680     <tr>
1681       <td><a href="#t_integer">integer</a></td>
1682       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1683     </tr>
1684     <tr>
1685       <td><a href="#t_floating">floating point</a></td>
1686       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1687     </tr>
1688     <tr>
1689       <td><a name="t_firstclass">first class</a></td>
1690       <td><a href="#t_integer">integer</a>,
1691           <a href="#t_floating">floating point</a>,
1692           <a href="#t_pointer">pointer</a>,
1693           <a href="#t_vector">vector</a>,
1694           <a href="#t_struct">structure</a>,
1695           <a href="#t_array">array</a>,
1696           <a href="#t_label">label</a>,
1697           <a href="#t_metadata">metadata</a>.
1698       </td>
1699     </tr>
1700     <tr>
1701       <td><a href="#t_primitive">primitive</a></td>
1702       <td><a href="#t_label">label</a>,
1703           <a href="#t_void">void</a>,
1704           <a href="#t_integer">integer</a>,
1705           <a href="#t_floating">floating point</a>,
1706           <a href="#t_x86mmx">x86mmx</a>,
1707           <a href="#t_metadata">metadata</a>.</td>
1708     </tr>
1709     <tr>
1710       <td><a href="#t_derived">derived</a></td>
1711       <td><a href="#t_array">array</a>,
1712           <a href="#t_function">function</a>,
1713           <a href="#t_pointer">pointer</a>,
1714           <a href="#t_struct">structure</a>,
1715           <a href="#t_vector">vector</a>,
1716           <a href="#t_opaque">opaque</a>.
1717       </td>
1718     </tr>
1719   </tbody>
1720 </table>
1721
1722 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1723    important.  Values of these types are the only ones which can be produced by
1724    instructions.</p>
1725
1726 </div>
1727
1728 <!-- ======================================================================= -->
1729 <h3>
1730   <a name="t_primitive">Primitive Types</a>
1731 </h3>
1732
1733 <div>
1734
1735 <p>The primitive types are the fundamental building blocks of the LLVM
1736    system.</p>
1737
1738 <!-- _______________________________________________________________________ -->
1739 <h4>
1740   <a name="t_integer">Integer Type</a>
1741 </h4>
1742
1743 <div>
1744
1745 <h5>Overview:</h5>
1746 <p>The integer type is a very simple type that simply specifies an arbitrary
1747    bit width for the integer type desired. Any bit width from 1 bit to
1748    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1749
1750 <h5>Syntax:</h5>
1751 <pre>
1752   iN
1753 </pre>
1754
1755 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1756    value.</p>
1757
1758 <h5>Examples:</h5>
1759 <table class="layout">
1760   <tr class="layout">
1761     <td class="left"><tt>i1</tt></td>
1762     <td class="left">a single-bit integer.</td>
1763   </tr>
1764   <tr class="layout">
1765     <td class="left"><tt>i32</tt></td>
1766     <td class="left">a 32-bit integer.</td>
1767   </tr>
1768   <tr class="layout">
1769     <td class="left"><tt>i1942652</tt></td>
1770     <td class="left">a really big integer of over 1 million bits.</td>
1771   </tr>
1772 </table>
1773
1774 </div>
1775
1776 <!-- _______________________________________________________________________ -->
1777 <h4>
1778   <a name="t_floating">Floating Point Types</a>
1779 </h4>
1780
1781 <div>
1782
1783 <table>
1784   <tbody>
1785     <tr><th>Type</th><th>Description</th></tr>
1786     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1787     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1788     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1789     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1790     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1791   </tbody>
1792 </table>
1793
1794 </div>
1795
1796 <!-- _______________________________________________________________________ -->
1797 <h4>
1798   <a name="t_x86mmx">X86mmx Type</a>
1799 </h4>
1800
1801 <div>
1802
1803 <h5>Overview:</h5>
1804 <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>
1805
1806 <h5>Syntax:</h5>
1807 <pre>
1808   x86mmx
1809 </pre>
1810
1811 </div>
1812
1813 <!-- _______________________________________________________________________ -->
1814 <h4>
1815   <a name="t_void">Void Type</a>
1816 </h4>
1817
1818 <div>
1819
1820 <h5>Overview:</h5>
1821 <p>The void type does not represent any value and has no size.</p>
1822
1823 <h5>Syntax:</h5>
1824 <pre>
1825   void
1826 </pre>
1827
1828 </div>
1829
1830 <!-- _______________________________________________________________________ -->
1831 <h4>
1832   <a name="t_label">Label Type</a>
1833 </h4>
1834
1835 <div>
1836
1837 <h5>Overview:</h5>
1838 <p>The label type represents code labels.</p>
1839
1840 <h5>Syntax:</h5>
1841 <pre>
1842   label
1843 </pre>
1844
1845 </div>
1846
1847 <!-- _______________________________________________________________________ -->
1848 <h4>
1849   <a name="t_metadata">Metadata Type</a>
1850 </h4>
1851
1852 <div>
1853
1854 <h5>Overview:</h5>
1855 <p>The metadata type represents embedded metadata. No derived types may be
1856    created from metadata except for <a href="#t_function">function</a>
1857    arguments.
1858
1859 <h5>Syntax:</h5>
1860 <pre>
1861   metadata
1862 </pre>
1863
1864 </div>
1865
1866 </div>
1867
1868 <!-- ======================================================================= -->
1869 <h3>
1870   <a name="t_derived">Derived Types</a>
1871 </h3>
1872
1873 <div>
1874
1875 <p>The real power in LLVM comes from the derived types in the system.  This is
1876    what allows a programmer to represent arrays, functions, pointers, and other
1877    useful types.  Each of these types contain one or more element types which
1878    may be a primitive type, or another derived type.  For example, it is
1879    possible to have a two dimensional array, using an array as the element type
1880    of another array.</p>
1881
1882 </div>
1883
1884
1885 <!-- _______________________________________________________________________ -->
1886 <h4>
1887   <a name="t_aggregate">Aggregate Types</a>
1888 </h4>
1889
1890 <div>
1891
1892 <p>Aggregate Types are a subset of derived types that can contain multiple
1893   member types. <a href="#t_array">Arrays</a>,
1894   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1895   aggregate types.</p>
1896
1897 </div>
1898
1899 <!-- _______________________________________________________________________ -->
1900 <h4>
1901   <a name="t_array">Array Type</a>
1902 </h4>
1903
1904 <div>
1905
1906 <h5>Overview:</h5>
1907 <p>The array type is a very simple derived type that arranges elements
1908    sequentially in memory.  The array type requires a size (number of elements)
1909    and an underlying data type.</p>
1910
1911 <h5>Syntax:</h5>
1912 <pre>
1913   [&lt;# elements&gt; x &lt;elementtype&gt;]
1914 </pre>
1915
1916 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1917    be any type with a size.</p>
1918
1919 <h5>Examples:</h5>
1920 <table class="layout">
1921   <tr class="layout">
1922     <td class="left"><tt>[40 x i32]</tt></td>
1923     <td class="left">Array of 40 32-bit integer values.</td>
1924   </tr>
1925   <tr class="layout">
1926     <td class="left"><tt>[41 x i32]</tt></td>
1927     <td class="left">Array of 41 32-bit integer values.</td>
1928   </tr>
1929   <tr class="layout">
1930     <td class="left"><tt>[4 x i8]</tt></td>
1931     <td class="left">Array of 4 8-bit integer values.</td>
1932   </tr>
1933 </table>
1934 <p>Here are some examples of multidimensional arrays:</p>
1935 <table class="layout">
1936   <tr class="layout">
1937     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1938     <td class="left">3x4 array of 32-bit integer values.</td>
1939   </tr>
1940   <tr class="layout">
1941     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1942     <td class="left">12x10 array of single precision floating point values.</td>
1943   </tr>
1944   <tr class="layout">
1945     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1946     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1947   </tr>
1948 </table>
1949
1950 <p>There is no restriction on indexing beyond the end of the array implied by
1951    a static type (though there are restrictions on indexing beyond the bounds
1952    of an allocated object in some cases). This means that single-dimension
1953    'variable sized array' addressing can be implemented in LLVM with a zero
1954    length array type. An implementation of 'pascal style arrays' in LLVM could
1955    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1956
1957 </div>
1958
1959 <!-- _______________________________________________________________________ -->
1960 <h4>
1961   <a name="t_function">Function Type</a>
1962 </h4>
1963
1964 <div>
1965
1966 <h5>Overview:</h5>
1967 <p>The function type can be thought of as a function signature.  It consists of
1968    a return type and a list of formal parameter types. The return type of a
1969    function type is a first class type or a void type.</p>
1970
1971 <h5>Syntax:</h5>
1972 <pre>
1973   &lt;returntype&gt; (&lt;parameter list&gt;)
1974 </pre>
1975
1976 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1977    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1978    which indicates that the function takes a variable number of arguments.
1979    Variable argument functions can access their arguments with
1980    the <a href="#int_varargs">variable argument handling intrinsic</a>
1981    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1982    <a href="#t_label">label</a>.</p>
1983
1984 <h5>Examples:</h5>
1985 <table class="layout">
1986   <tr class="layout">
1987     <td class="left"><tt>i32 (i32)</tt></td>
1988     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1989     </td>
1990   </tr><tr class="layout">
1991     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1992     </tt></td>
1993     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1994       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1995       returning <tt>float</tt>.
1996     </td>
1997   </tr><tr class="layout">
1998     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1999     <td class="left">A vararg function that takes at least one
2000       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2001       which returns an integer.  This is the signature for <tt>printf</tt> in
2002       LLVM.
2003     </td>
2004   </tr><tr class="layout">
2005     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2006     <td class="left">A function taking an <tt>i32</tt>, returning a
2007         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2008     </td>
2009   </tr>
2010 </table>
2011
2012 </div>
2013
2014 <!-- _______________________________________________________________________ -->
2015 <h4>
2016   <a name="t_struct">Structure Type</a>
2017 </h4>
2018
2019 <div>
2020
2021 <h5>Overview:</h5>
2022 <p>The structure type is used to represent a collection of data members together
2023   in memory.  The elements of a structure may be any type that has a size.</p>
2024
2025 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2026    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2027    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2028    Structures in registers are accessed using the
2029    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2030    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2031
2032 <p>Structures may optionally be "packed" structures, which indicate that the
2033   alignment of the struct is one byte, and that there is no padding between
2034   the elements.  In non-packed structs, padding between field types is defined
2035   by the target data string to match the underlying processor.</p>
2036
2037 <p>Structures can either be "anonymous" or "named".  An anonymous structure is
2038   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) and a named types
2039   are always defined at the top level with a name.  Anonmyous types are uniqued
2040   by their contents and can never be recursive since there is no way to write
2041   one.  Named types can be recursive.
2042 </p>
2043
2044 <h5>Syntax:</h5>
2045 <pre>
2046   %T1 = type { &lt;type list&gt; }     <i>; Named normal struct type</i>
2047   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Named packed struct type</i>
2048 </pre>
2049
2050 <h5>Examples:</h5>
2051 <table class="layout">
2052   <tr class="layout">
2053     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2054     <td class="left">A triple of three <tt>i32</tt> values</td>
2055   </tr>
2056   <tr class="layout">
2057     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2058     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2059       second element is a <a href="#t_pointer">pointer</a> to a
2060       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2061       an <tt>i32</tt>.</td>
2062   </tr>
2063   <tr class="layout">
2064     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2065     <td class="left">A packed struct known to be 5 bytes in size.</td>
2066   </tr>
2067 </table>
2068
2069 </div>
2070
2071 <!-- _______________________________________________________________________ -->
2072 <h4>
2073   <a name="t_opaque">Opaque Structure Types</a>
2074 </h4>
2075
2076 <div>
2077
2078 <h5>Overview:</h5>
2079 <p>Opaque structure types are used to represent named structure types that do
2080    not have a body specified.  This corresponds (for example) to the C notion of
2081    a forward declared structure.</p>
2082
2083 <h5>Syntax:</h5>
2084 <pre>
2085   %X = type opaque
2086   %52 = type opaque
2087 </pre>
2088
2089 <h5>Examples:</h5>
2090 <table class="layout">
2091   <tr class="layout">
2092     <td class="left"><tt>opaque</tt></td>
2093     <td class="left">An opaque type.</td>
2094   </tr>
2095 </table>
2096
2097 </div>
2098
2099
2100
2101 <!-- _______________________________________________________________________ -->
2102 <h4>
2103   <a name="t_pointer">Pointer Type</a>
2104 </h4>
2105
2106 <div>
2107
2108 <h5>Overview:</h5>
2109 <p>The pointer type is used to specify memory locations.
2110    Pointers are commonly used to reference objects in memory.</p>
2111
2112 <p>Pointer types may have an optional address space attribute defining the
2113    numbered address space where the pointed-to object resides. The default
2114    address space is number zero. The semantics of non-zero address
2115    spaces are target-specific.</p>
2116
2117 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2118    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2119
2120 <h5>Syntax:</h5>
2121 <pre>
2122   &lt;type&gt; *
2123 </pre>
2124
2125 <h5>Examples:</h5>
2126 <table class="layout">
2127   <tr class="layout">
2128     <td class="left"><tt>[4 x i32]*</tt></td>
2129     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2130                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2131   </tr>
2132   <tr class="layout">
2133     <td class="left"><tt>i32 (i32*) *</tt></td>
2134     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2135       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2136       <tt>i32</tt>.</td>
2137   </tr>
2138   <tr class="layout">
2139     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2140     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2141      that resides in address space #5.</td>
2142   </tr>
2143 </table>
2144
2145 </div>
2146
2147 <!-- _______________________________________________________________________ -->
2148 <h4>
2149   <a name="t_vector">Vector Type</a>
2150 </h4>
2151
2152 <div>
2153
2154 <h5>Overview:</h5>
2155 <p>A vector type is a simple derived type that represents a vector of elements.
2156    Vector types are used when multiple primitive data are operated in parallel
2157    using a single instruction (SIMD).  A vector type requires a size (number of
2158    elements) and an underlying primitive data type.  Vector types are considered
2159    <a href="#t_firstclass">first class</a>.</p>
2160
2161 <h5>Syntax:</h5>
2162 <pre>
2163   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2164 </pre>
2165
2166 <p>The number of elements is a constant integer value larger than 0; elementtype
2167    may be any integer or floating point type.  Vectors of size zero are not
2168    allowed, and pointers are not allowed as the element type.</p>
2169
2170 <h5>Examples:</h5>
2171 <table class="layout">
2172   <tr class="layout">
2173     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2174     <td class="left">Vector of 4 32-bit integer values.</td>
2175   </tr>
2176   <tr class="layout">
2177     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2178     <td class="left">Vector of 8 32-bit floating-point values.</td>
2179   </tr>
2180   <tr class="layout">
2181     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2182     <td class="left">Vector of 2 64-bit integer values.</td>
2183   </tr>
2184 </table>
2185
2186 </div>
2187
2188 </div>
2189
2190 <!-- *********************************************************************** -->
2191 <h2><a name="constants">Constants</a></h2>
2192 <!-- *********************************************************************** -->
2193
2194 <div>
2195
2196 <p>LLVM has several different basic types of constants.  This section describes
2197    them all and their syntax.</p>
2198
2199 <!-- ======================================================================= -->
2200 <h3>
2201   <a name="simpleconstants">Simple Constants</a>
2202 </h3>
2203
2204 <div>
2205
2206 <dl>
2207   <dt><b>Boolean constants</b></dt>
2208   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2209       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2210
2211   <dt><b>Integer constants</b></dt>
2212   <dd>Standard integers (such as '4') are constants of
2213       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2214       with integer types.</dd>
2215
2216   <dt><b>Floating point constants</b></dt>
2217   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2218       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2219       notation (see below).  The assembler requires the exact decimal value of a
2220       floating-point constant.  For example, the assembler accepts 1.25 but
2221       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2222       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2223
2224   <dt><b>Null pointer constants</b></dt>
2225   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2226       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2227 </dl>
2228
2229 <p>The one non-intuitive notation for constants is the hexadecimal form of
2230    floating point constants.  For example, the form '<tt>double
2231    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2232    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2233    constants are required (and the only time that they are generated by the
2234    disassembler) is when a floating point constant must be emitted but it cannot
2235    be represented as a decimal floating point number in a reasonable number of
2236    digits.  For example, NaN's, infinities, and other special values are
2237    represented in their IEEE hexadecimal format so that assembly and disassembly
2238    do not cause any bits to change in the constants.</p>
2239
2240 <p>When using the hexadecimal form, constants of types float and double are
2241    represented using the 16-digit form shown above (which matches the IEEE754
2242    representation for double); float values must, however, be exactly
2243    representable as IEE754 single precision.  Hexadecimal format is always used
2244    for long double, and there are three forms of long double.  The 80-bit format
2245    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2246    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2247    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2248    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2249    currently supported target uses this format.  Long doubles will only work if
2250    they match the long double format on your target.  All hexadecimal formats
2251    are big-endian (sign bit at the left).</p>
2252
2253 <p>There are no constants of type x86mmx.</p>
2254 </div>
2255
2256 <!-- ======================================================================= -->
2257 <h3>
2258 <a name="aggregateconstants"></a> <!-- old anchor -->
2259 <a name="complexconstants">Complex Constants</a>
2260 </h3>
2261
2262 <div>
2263
2264 <p>Complex constants are a (potentially recursive) combination of simple
2265    constants and smaller complex constants.</p>
2266
2267 <dl>
2268   <dt><b>Structure constants</b></dt>
2269   <dd>Structure constants are represented with notation similar to structure
2270       type definitions (a comma separated list of elements, surrounded by braces
2271       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2272       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2273       Structure constants must have <a href="#t_struct">structure type</a>, and
2274       the number and types of elements must match those specified by the
2275       type.</dd>
2276
2277   <dt><b>Array constants</b></dt>
2278   <dd>Array constants are represented with notation similar to array type
2279      definitions (a comma separated list of elements, surrounded by square
2280      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2281      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2282      the number and types of elements must match those specified by the
2283      type.</dd>
2284
2285   <dt><b>Vector constants</b></dt>
2286   <dd>Vector constants are represented with notation similar to vector type
2287       definitions (a comma separated list of elements, surrounded by
2288       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2289       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2290       have <a href="#t_vector">vector type</a>, and the number and types of
2291       elements must match those specified by the type.</dd>
2292
2293   <dt><b>Zero initialization</b></dt>
2294   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2295       value to zero of <em>any</em> type, including scalar and
2296       <a href="#t_aggregate">aggregate</a> types.
2297       This is often used to avoid having to print large zero initializers
2298       (e.g. for large arrays) and is always exactly equivalent to using explicit
2299       zero initializers.</dd>
2300
2301   <dt><b>Metadata node</b></dt>
2302   <dd>A metadata node is a structure-like constant with
2303       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2304       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2305       be interpreted as part of the instruction stream, metadata is a place to
2306       attach additional information such as debug info.</dd>
2307 </dl>
2308
2309 </div>
2310
2311 <!-- ======================================================================= -->
2312 <h3>
2313   <a name="globalconstants">Global Variable and Function Addresses</a>
2314 </h3>
2315
2316 <div>
2317
2318 <p>The addresses of <a href="#globalvars">global variables</a>
2319    and <a href="#functionstructure">functions</a> are always implicitly valid
2320    (link-time) constants.  These constants are explicitly referenced when
2321    the <a href="#identifiers">identifier for the global</a> is used and always
2322    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2323    legal LLVM file:</p>
2324
2325 <pre class="doc_code">
2326 @X = global i32 17
2327 @Y = global i32 42
2328 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2329 </pre>
2330
2331 </div>
2332
2333 <!-- ======================================================================= -->
2334 <h3>
2335   <a name="undefvalues">Undefined Values</a>
2336 </h3>
2337
2338 <div>
2339
2340 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2341    indicates that the user of the value may receive an unspecified bit-pattern.
2342    Undefined values may be of any type (other than '<tt>label</tt>'
2343    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2344
2345 <p>Undefined values are useful because they indicate to the compiler that the
2346    program is well defined no matter what value is used.  This gives the
2347    compiler more freedom to optimize.  Here are some examples of (potentially
2348    surprising) transformations that are valid (in pseudo IR):</p>
2349
2350
2351 <pre class="doc_code">
2352   %A = add %X, undef
2353   %B = sub %X, undef
2354   %C = xor %X, undef
2355 Safe:
2356   %A = undef
2357   %B = undef
2358   %C = undef
2359 </pre>
2360
2361 <p>This is safe because all of the output bits are affected by the undef bits.
2362    Any output bit can have a zero or one depending on the input bits.</p>
2363
2364 <pre class="doc_code">
2365   %A = or %X, undef
2366   %B = and %X, undef
2367 Safe:
2368   %A = -1
2369   %B = 0
2370 Unsafe:
2371   %A = undef
2372   %B = undef
2373 </pre>
2374
2375 <p>These logical operations have bits that are not always affected by the input.
2376    For example, if <tt>%X</tt> has a zero bit, then the output of the
2377    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2378    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2379    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2380    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2381    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2382    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2383    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2384
2385 <pre class="doc_code">
2386   %A = select undef, %X, %Y
2387   %B = select undef, 42, %Y
2388   %C = select %X, %Y, undef
2389 Safe:
2390   %A = %X     (or %Y)
2391   %B = 42     (or %Y)
2392   %C = %Y
2393 Unsafe:
2394   %A = undef
2395   %B = undef
2396   %C = undef
2397 </pre>
2398
2399 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2400    branch) conditions can go <em>either way</em>, but they have to come from one
2401    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2402    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2403    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2404    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2405    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2406    eliminated.</p>
2407
2408 <pre class="doc_code">
2409   %A = xor undef, undef
2410
2411   %B = undef
2412   %C = xor %B, %B
2413
2414   %D = undef
2415   %E = icmp lt %D, 4
2416   %F = icmp gte %D, 4
2417
2418 Safe:
2419   %A = undef
2420   %B = undef
2421   %C = undef
2422   %D = undef
2423   %E = undef
2424   %F = undef
2425 </pre>
2426
2427 <p>This example points out that two '<tt>undef</tt>' operands are not
2428    necessarily the same. This can be surprising to people (and also matches C
2429    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2430    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2431    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2432    its value over its "live range".  This is true because the variable doesn't
2433    actually <em>have a live range</em>. Instead, the value is logically read
2434    from arbitrary registers that happen to be around when needed, so the value
2435    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2436    need to have the same semantics or the core LLVM "replace all uses with"
2437    concept would not hold.</p>
2438
2439 <pre class="doc_code">
2440   %A = fdiv undef, %X
2441   %B = fdiv %X, undef
2442 Safe:
2443   %A = undef
2444 b: unreachable
2445 </pre>
2446
2447 <p>These examples show the crucial difference between an <em>undefined
2448   value</em> and <em>undefined behavior</em>. An undefined value (like
2449   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2450   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2451   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2452   defined on SNaN's. However, in the second example, we can make a more
2453   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2454   arbitrary value, we are allowed to assume that it could be zero. Since a
2455   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2456   the operation does not execute at all. This allows us to delete the divide and
2457   all code after it. Because the undefined operation "can't happen", the
2458   optimizer can assume that it occurs in dead code.</p>
2459
2460 <pre class="doc_code">
2461 a:  store undef -> %X
2462 b:  store %X -> undef
2463 Safe:
2464 a: &lt;deleted&gt;
2465 b: unreachable
2466 </pre>
2467
2468 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2469    undefined value can be assumed to not have any effect; we can assume that the
2470    value is overwritten with bits that happen to match what was already there.
2471    However, a store <em>to</em> an undefined location could clobber arbitrary
2472    memory, therefore, it has undefined behavior.</p>
2473
2474 </div>
2475
2476 <!-- ======================================================================= -->
2477 <h3>
2478   <a name="trapvalues">Trap Values</a>
2479 </h3>
2480
2481 <div>
2482
2483 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2484    instead of representing an unspecified bit pattern, they represent the
2485    fact that an instruction or constant expression which cannot evoke side
2486    effects has nevertheless detected a condition which results in undefined
2487    behavior.</p>
2488
2489 <p>There is currently no way of representing a trap value in the IR; they
2490    only exist when produced by operations such as
2491    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2492
2493 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2494
2495 <ul>
2496 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2497     their operands.</li>
2498
2499 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2500     to their dynamic predecessor basic block.</li>
2501
2502 <li>Function arguments depend on the corresponding actual argument values in
2503     the dynamic callers of their functions.</li>
2504
2505 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2506     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2507     control back to them.</li>
2508
2509 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2510     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2511     or exception-throwing call instructions that dynamically transfer control
2512     back to them.</li>
2513
2514 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2515     referenced memory addresses, following the order in the IR
2516     (including loads and stores implied by intrinsics such as
2517     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2518
2519 <!-- TODO: In the case of multiple threads, this only applies if the store
2520      "happens-before" the load or store. -->
2521
2522 <!-- TODO: floating-point exception state -->
2523
2524 <li>An instruction with externally visible side effects depends on the most
2525     recent preceding instruction with externally visible side effects, following
2526     the order in the IR. (This includes
2527     <a href="#volatile">volatile operations</a>.)</li>
2528
2529 <li>An instruction <i>control-depends</i> on a
2530     <a href="#terminators">terminator instruction</a>
2531     if the terminator instruction has multiple successors and the instruction
2532     is always executed when control transfers to one of the successors, and
2533     may not be executed when control is transferred to another.</li>
2534
2535 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2536     instruction if the set of instructions it otherwise depends on would be
2537     different if the terminator had transferred control to a different
2538     successor.</li>
2539
2540 <li>Dependence is transitive.</li>
2541
2542 </ul>
2543
2544 <p>Whenever a trap value is generated, all values which depend on it evaluate
2545    to trap. If they have side effects, the evoke their side effects as if each
2546    operand with a trap value were undef. If they have externally-visible side
2547    effects, the behavior is undefined.</p>
2548
2549 <p>Here are some examples:</p>
2550
2551 <pre class="doc_code">
2552 entry:
2553   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2554   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2555   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2556   store i32 0, i32* %trap_yet_again  ; undefined behavior
2557
2558   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2559   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2560
2561   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2562
2563   %narrowaddr = bitcast i32* @g to i16*
2564   %wideaddr = bitcast i32* @g to i64*
2565   %trap3 = load i16* %narrowaddr     ; Returns a trap value.
2566   %trap4 = load i64* %wideaddr       ; Returns a trap value.
2567
2568   %cmp = icmp slt i32 %trap, 0       ; Returns a trap value.
2569   br i1 %cmp, label %true, label %end ; Branch to either destination.
2570
2571 true:
2572   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2573                                      ; it has undefined behavior.
2574   br label %end
2575
2576 end:
2577   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2578                                      ; Both edges into this PHI are
2579                                      ; control-dependent on %cmp, so this
2580                                      ; always results in a trap value.
2581
2582   volatile store i32 0, i32* @g      ; This would depend on the store in %true
2583                                      ; if %cmp is true, or the store in %entry
2584                                      ; otherwise, so this is undefined behavior.
2585
2586   br i1 %cmp, label %second_true, label %second_end
2587                                      ; The same branch again, but this time the
2588                                      ; true block doesn't have side effects.
2589
2590 second_true:
2591   ; No side effects!
2592   ret void
2593
2594 second_end:
2595   volatile store i32 0, i32* @g      ; This time, the instruction always depends
2596                                      ; on the store in %end. Also, it is
2597                                      ; control-equivalent to %end, so this is
2598                                      ; well-defined (again, ignoring earlier
2599                                      ; undefined behavior in this example).
2600 </pre>
2601
2602 </div>
2603
2604 <!-- ======================================================================= -->
2605 <h3>
2606   <a name="blockaddress">Addresses of Basic Blocks</a>
2607 </h3>
2608
2609 <div>
2610
2611 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2612
2613 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2614    basic block in the specified function, and always has an i8* type.  Taking
2615    the address of the entry block is illegal.</p>
2616
2617 <p>This value only has defined behavior when used as an operand to the
2618    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2619    comparisons against null. Pointer equality tests between labels addresses
2620    results in undefined behavior &mdash; though, again, comparison against null
2621    is ok, and no label is equal to the null pointer. This may be passed around
2622    as an opaque pointer sized value as long as the bits are not inspected. This
2623    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2624    long as the original value is reconstituted before the <tt>indirectbr</tt>
2625    instruction.</p>
2626
2627 <p>Finally, some targets may provide defined semantics when using the value as
2628    the operand to an inline assembly, but that is target specific.</p>
2629
2630 </div>
2631
2632
2633 <!-- ======================================================================= -->
2634 <h3>
2635   <a name="constantexprs">Constant Expressions</a>
2636 </h3>
2637
2638 <div>
2639
2640 <p>Constant expressions are used to allow expressions involving other constants
2641    to be used as constants.  Constant expressions may be of
2642    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2643    operation that does not have side effects (e.g. load and call are not
2644    supported). The following is the syntax for constant expressions:</p>
2645
2646 <dl>
2647   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2648   <dd>Truncate a constant to another type. The bit size of CST must be larger
2649       than the bit size of TYPE. Both types must be integers.</dd>
2650
2651   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2652   <dd>Zero extend a constant to another type. The bit size of CST must be
2653       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2654
2655   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2656   <dd>Sign extend a constant to another type. The bit size of CST must be
2657       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2658
2659   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2660   <dd>Truncate a floating point constant to another floating point type. The
2661       size of CST must be larger than the size of TYPE. Both types must be
2662       floating point.</dd>
2663
2664   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2665   <dd>Floating point extend a constant to another type. The size of CST must be
2666       smaller or equal to the size of TYPE. Both types must be floating
2667       point.</dd>
2668
2669   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2670   <dd>Convert a floating point constant to the corresponding unsigned integer
2671       constant. TYPE must be a scalar or vector integer type. CST must be of
2672       scalar or vector floating point type. Both CST and TYPE must be scalars,
2673       or vectors of the same number of elements. If the value won't fit in the
2674       integer type, the results are undefined.</dd>
2675
2676   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2677   <dd>Convert a floating point constant to the corresponding signed integer
2678       constant.  TYPE must be a scalar or vector integer type. CST must be of
2679       scalar or vector floating point type. Both CST and TYPE must be scalars,
2680       or vectors of the same number of elements. If the value won't fit in the
2681       integer type, the results are undefined.</dd>
2682
2683   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2684   <dd>Convert an unsigned integer constant to the corresponding floating point
2685       constant. TYPE must be a scalar or vector floating point type. CST must be
2686       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2687       vectors of the same number of elements. If the value won't fit in the
2688       floating point type, the results are undefined.</dd>
2689
2690   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2691   <dd>Convert a signed integer constant to the corresponding floating point
2692       constant. TYPE must be a scalar or vector floating point type. CST must be
2693       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2694       vectors of the same number of elements. If the value won't fit in the
2695       floating point type, the results are undefined.</dd>
2696
2697   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2698   <dd>Convert a pointer typed constant to the corresponding integer constant
2699       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2700       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2701       make it fit in <tt>TYPE</tt>.</dd>
2702
2703   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2704   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2705       type.  CST must be of integer type. The CST value is zero extended,
2706       truncated, or unchanged to make it fit in a pointer size. This one is
2707       <i>really</i> dangerous!</dd>
2708
2709   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2710   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2711       are the same as those for the <a href="#i_bitcast">bitcast
2712       instruction</a>.</dd>
2713
2714   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2715   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2716   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2717       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2718       instruction, the index list may have zero or more indexes, which are
2719       required to make sense for the type of "CSTPTR".</dd>
2720
2721   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2722   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2723
2724   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2725   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2726
2727   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2728   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2729
2730   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2731   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2732       constants.</dd>
2733
2734   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2735   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2736     constants.</dd>
2737
2738   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2739   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2740       constants.</dd>
2741
2742   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2743   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2744     constants. The index list is interpreted in a similar manner as indices in
2745     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2746     index value must be specified.</dd>
2747
2748   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2749   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2750     constants. The index list is interpreted in a similar manner as indices in
2751     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2752     index value must be specified.</dd>
2753
2754   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2755   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2756       be any of the <a href="#binaryops">binary</a>
2757       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2758       on operands are the same as those for the corresponding instruction
2759       (e.g. no bitwise operations on floating point values are allowed).</dd>
2760 </dl>
2761
2762 </div>
2763
2764 </div>
2765
2766 <!-- *********************************************************************** -->
2767 <h2><a name="othervalues">Other Values</a></h2>
2768 <!-- *********************************************************************** -->
2769 <div>
2770 <!-- ======================================================================= -->
2771 <h3>
2772 <a name="inlineasm">Inline Assembler Expressions</a>
2773 </h3>
2774
2775 <div>
2776
2777 <p>LLVM supports inline assembler expressions (as opposed
2778    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2779    a special value.  This value represents the inline assembler as a string
2780    (containing the instructions to emit), a list of operand constraints (stored
2781    as a string), a flag that indicates whether or not the inline asm
2782    expression has side effects, and a flag indicating whether the function
2783    containing the asm needs to align its stack conservatively.  An example
2784    inline assembler expression is:</p>
2785
2786 <pre class="doc_code">
2787 i32 (i32) asm "bswap $0", "=r,r"
2788 </pre>
2789
2790 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2791    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2792    have:</p>
2793
2794 <pre class="doc_code">
2795 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2796 </pre>
2797
2798 <p>Inline asms with side effects not visible in the constraint list must be
2799    marked as having side effects.  This is done through the use of the
2800    '<tt>sideeffect</tt>' keyword, like so:</p>
2801
2802 <pre class="doc_code">
2803 call void asm sideeffect "eieio", ""()
2804 </pre>
2805
2806 <p>In some cases inline asms will contain code that will not work unless the
2807    stack is aligned in some way, such as calls or SSE instructions on x86,
2808    yet will not contain code that does that alignment within the asm.
2809    The compiler should make conservative assumptions about what the asm might
2810    contain and should generate its usual stack alignment code in the prologue
2811    if the '<tt>alignstack</tt>' keyword is present:</p>
2812
2813 <pre class="doc_code">
2814 call void asm alignstack "eieio", ""()
2815 </pre>
2816
2817 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2818    first.</p>
2819
2820 <p>TODO: The format of the asm and constraints string still need to be
2821    documented here.  Constraints on what can be done (e.g. duplication, moving,
2822    etc need to be documented).  This is probably best done by reference to
2823    another document that covers inline asm from a holistic perspective.</p>
2824
2825 <h4>
2826 <a name="inlineasm_md">Inline Asm Metadata</a>
2827 </h4>
2828
2829 <div>
2830
2831 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2832    attached to it that contains a list of constant integers.  If present, the
2833   code generator will use the integer as the location cookie value when report
2834    errors through the LLVMContext error reporting mechanisms.  This allows a
2835    front-end to correlate backend errors that occur with inline asm back to the
2836    source code that produced it.  For example:</p>
2837
2838 <pre class="doc_code">
2839 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2840 ...
2841 !42 = !{ i32 1234567 }
2842 </pre>
2843
2844 <p>It is up to the front-end to make sense of the magic numbers it places in the
2845    IR.  If the MDNode contains multiple constants, the code generator will use
2846    the one that corresponds to the line of the asm that the error occurs on.</p>
2847
2848 </div>
2849
2850 </div>
2851
2852 <!-- ======================================================================= -->
2853 <h3>
2854   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2855 </h3>
2856
2857 <div>
2858
2859 <p>LLVM IR allows metadata to be attached to instructions in the program that
2860    can convey extra information about the code to the optimizers and code
2861    generator.  One example application of metadata is source-level debug
2862    information.  There are two metadata primitives: strings and nodes. All
2863    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2864    preceding exclamation point ('<tt>!</tt>').</p>
2865
2866 <p>A metadata string is a string surrounded by double quotes.  It can contain
2867    any character by escaping non-printable characters with "\xx" where "xx" is
2868    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2869
2870 <p>Metadata nodes are represented with notation similar to structure constants
2871    (a comma separated list of elements, surrounded by braces and preceded by an
2872    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2873    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2874
2875 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2876    metadata nodes, which can be looked up in the module symbol table. For
2877    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2878
2879 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2880    function is using two metadata arguments.</p>
2881
2882 <div class="doc_code">
2883 <pre>
2884 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2885 </pre>
2886 </div>
2887
2888 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2889    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2890
2891 <div class="doc_code">
2892 <pre>
2893 %indvar.next = add i64 %indvar, 1, !dbg !21
2894 </pre>
2895 </div>
2896
2897 </div>
2898
2899 </div>
2900
2901 <!-- *********************************************************************** -->
2902 <h2>
2903   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2904 </h2>
2905 <!-- *********************************************************************** -->
2906 <div>
2907 <p>LLVM has a number of "magic" global variables that contain data that affect
2908 code generation or other IR semantics.  These are documented here.  All globals
2909 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2910 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2911 by LLVM.</p>
2912
2913 <!-- ======================================================================= -->
2914 <h3>
2915 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2916 </h3>
2917
2918 <div>
2919
2920 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2921 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2922 pointers to global variables and functions which may optionally have a pointer
2923 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2924
2925 <pre>
2926   @X = global i8 4
2927   @Y = global i32 123
2928
2929   @llvm.used = appending global [2 x i8*] [
2930      i8* @X,
2931      i8* bitcast (i32* @Y to i8*)
2932   ], section "llvm.metadata"
2933 </pre>
2934
2935 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2936 compiler, assembler, and linker are required to treat the symbol as if there is
2937 a reference to the global that it cannot see.  For example, if a variable has
2938 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2939 list, it cannot be deleted.  This is commonly used to represent references from
2940 inline asms and other things the compiler cannot "see", and corresponds to
2941 "attribute((used))" in GNU C.</p>
2942
2943 <p>On some targets, the code generator must emit a directive to the assembler or
2944 object file to prevent the assembler and linker from molesting the symbol.</p>
2945
2946 </div>
2947
2948 <!-- ======================================================================= -->
2949 <h3>
2950   <a name="intg_compiler_used">
2951     The '<tt>llvm.compiler.used</tt>' Global Variable
2952   </a>
2953 </h3>
2954
2955 <div>
2956
2957 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2958 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2959 touching the symbol.  On targets that support it, this allows an intelligent
2960 linker to optimize references to the symbol without being impeded as it would be
2961 by <tt>@llvm.used</tt>.</p>
2962
2963 <p>This is a rare construct that should only be used in rare circumstances, and
2964 should not be exposed to source languages.</p>
2965
2966 </div>
2967
2968 <!-- ======================================================================= -->
2969 <h3>
2970 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2971 </h3>
2972
2973 <div>
2974 <pre>
2975 %0 = type { i32, void ()* }
2976 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2977 </pre>
2978 <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.
2979 </p>
2980
2981 </div>
2982
2983 <!-- ======================================================================= -->
2984 <h3>
2985 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2986 </h3>
2987
2988 <div>
2989 <pre>
2990 %0 = type { i32, void ()* }
2991 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2992 </pre>
2993
2994 <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.
2995 </p>
2996
2997 </div>
2998
2999 </div>
3000
3001 <!-- *********************************************************************** -->
3002 <h2><a name="instref">Instruction Reference</a></h2>
3003 <!-- *********************************************************************** -->
3004
3005 <div>
3006
3007 <p>The LLVM instruction set consists of several different classifications of
3008    instructions: <a href="#terminators">terminator
3009    instructions</a>, <a href="#binaryops">binary instructions</a>,
3010    <a href="#bitwiseops">bitwise binary instructions</a>,
3011    <a href="#memoryops">memory instructions</a>, and
3012    <a href="#otherops">other instructions</a>.</p>
3013
3014 <!-- ======================================================================= -->
3015 <h3>
3016   <a name="terminators">Terminator Instructions</a>
3017 </h3>
3018
3019 <div>
3020
3021 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3022    in a program ends with a "Terminator" instruction, which indicates which
3023    block should be executed after the current block is finished. These
3024    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3025    control flow, not values (the one exception being the
3026    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3027
3028 <p>The terminator instructions are:
3029    '<a href="#i_ret"><tt>ret</tt></a>',
3030    '<a href="#i_br"><tt>br</tt></a>',
3031    '<a href="#i_switch"><tt>switch</tt></a>',
3032    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3033    '<a href="#i_invoke"><tt>invoke</tt></a>',
3034    '<a href="#i_unwind"><tt>unwind</tt></a>',
3035    '<a href="#i_resume"><tt>resume</tt></a>', and
3036    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3037
3038 <!-- _______________________________________________________________________ -->
3039 <h4>
3040   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3041 </h4>
3042
3043 <div>
3044
3045 <h5>Syntax:</h5>
3046 <pre>
3047   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3048   ret void                 <i>; Return from void function</i>
3049 </pre>
3050
3051 <h5>Overview:</h5>
3052 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3053    a value) from a function back to the caller.</p>
3054
3055 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3056    value and then causes control flow, and one that just causes control flow to
3057    occur.</p>
3058
3059 <h5>Arguments:</h5>
3060 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3061    return value. The type of the return value must be a
3062    '<a href="#t_firstclass">first class</a>' type.</p>
3063
3064 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3065    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3066    value or a return value with a type that does not match its type, or if it
3067    has a void return type and contains a '<tt>ret</tt>' instruction with a
3068    return value.</p>
3069
3070 <h5>Semantics:</h5>
3071 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3072    the calling function's context.  If the caller is a
3073    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3074    instruction after the call.  If the caller was an
3075    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3076    the beginning of the "normal" destination block.  If the instruction returns
3077    a value, that value shall set the call or invoke instruction's return
3078    value.</p>
3079
3080 <h5>Example:</h5>
3081 <pre>
3082   ret i32 5                       <i>; Return an integer value of 5</i>
3083   ret void                        <i>; Return from a void function</i>
3084   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3085 </pre>
3086
3087 </div>
3088 <!-- _______________________________________________________________________ -->
3089 <h4>
3090   <a name="i_br">'<tt>br</tt>' Instruction</a>
3091 </h4>
3092
3093 <div>
3094
3095 <h5>Syntax:</h5>
3096 <pre>
3097   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3098   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3099 </pre>
3100
3101 <h5>Overview:</h5>
3102 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3103    different basic block in the current function.  There are two forms of this
3104    instruction, corresponding to a conditional branch and an unconditional
3105    branch.</p>
3106
3107 <h5>Arguments:</h5>
3108 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3109    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3110    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3111    target.</p>
3112
3113 <h5>Semantics:</h5>
3114 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3115    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3116    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3117    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3118
3119 <h5>Example:</h5>
3120 <pre>
3121 Test:
3122   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3123   br i1 %cond, label %IfEqual, label %IfUnequal
3124 IfEqual:
3125   <a href="#i_ret">ret</a> i32 1
3126 IfUnequal:
3127   <a href="#i_ret">ret</a> i32 0
3128 </pre>
3129
3130 </div>
3131
3132 <!-- _______________________________________________________________________ -->
3133 <h4>
3134    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3135 </h4>
3136
3137 <div>
3138
3139 <h5>Syntax:</h5>
3140 <pre>
3141   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3142 </pre>
3143
3144 <h5>Overview:</h5>
3145 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3146    several different places.  It is a generalization of the '<tt>br</tt>'
3147    instruction, allowing a branch to occur to one of many possible
3148    destinations.</p>
3149
3150 <h5>Arguments:</h5>
3151 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3152    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3153    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3154    The table is not allowed to contain duplicate constant entries.</p>
3155
3156 <h5>Semantics:</h5>
3157 <p>The <tt>switch</tt> instruction specifies a table of values and
3158    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3159    is searched for the given value.  If the value is found, control flow is
3160    transferred to the corresponding destination; otherwise, control flow is
3161    transferred to the default destination.</p>
3162
3163 <h5>Implementation:</h5>
3164 <p>Depending on properties of the target machine and the particular
3165    <tt>switch</tt> instruction, this instruction may be code generated in
3166    different ways.  For example, it could be generated as a series of chained
3167    conditional branches or with a lookup table.</p>
3168
3169 <h5>Example:</h5>
3170 <pre>
3171  <i>; Emulate a conditional br instruction</i>
3172  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3173  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3174
3175  <i>; Emulate an unconditional br instruction</i>
3176  switch i32 0, label %dest [ ]
3177
3178  <i>; Implement a jump table:</i>
3179  switch i32 %val, label %otherwise [ i32 0, label %onzero
3180                                      i32 1, label %onone
3181                                      i32 2, label %ontwo ]
3182 </pre>
3183
3184 </div>
3185
3186
3187 <!-- _______________________________________________________________________ -->
3188 <h4>
3189    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3190 </h4>
3191
3192 <div>
3193
3194 <h5>Syntax:</h5>
3195 <pre>
3196   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3197 </pre>
3198
3199 <h5>Overview:</h5>
3200
3201 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3202    within the current function, whose address is specified by
3203    "<tt>address</tt>".  Address must be derived from a <a
3204    href="#blockaddress">blockaddress</a> constant.</p>
3205
3206 <h5>Arguments:</h5>
3207
3208 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3209    rest of the arguments indicate the full set of possible destinations that the
3210    address may point to.  Blocks are allowed to occur multiple times in the
3211    destination list, though this isn't particularly useful.</p>
3212
3213 <p>This destination list is required so that dataflow analysis has an accurate
3214    understanding of the CFG.</p>
3215
3216 <h5>Semantics:</h5>
3217
3218 <p>Control transfers to the block specified in the address argument.  All
3219    possible destination blocks must be listed in the label list, otherwise this
3220    instruction has undefined behavior.  This implies that jumps to labels
3221    defined in other functions have undefined behavior as well.</p>
3222
3223 <h5>Implementation:</h5>
3224
3225 <p>This is typically implemented with a jump through a register.</p>
3226
3227 <h5>Example:</h5>
3228 <pre>
3229  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3230 </pre>
3231
3232 </div>
3233
3234
3235 <!-- _______________________________________________________________________ -->
3236 <h4>
3237   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3238 </h4>
3239
3240 <div>
3241
3242 <h5>Syntax:</h5>
3243 <pre>
3244   &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>]
3245                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3246 </pre>
3247
3248 <h5>Overview:</h5>
3249 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3250    function, with the possibility of control flow transfer to either the
3251    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3252    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3253    control flow will return to the "normal" label.  If the callee (or any
3254    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3255    instruction, control is interrupted and continued at the dynamically nearest
3256    "exception" label.</p>
3257
3258 <p>The '<tt>exception</tt>' label is a
3259    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3260    exception. As such, '<tt>exception</tt>' label is required to have the
3261    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3262    the information about about the behavior of the program after unwinding
3263    happens, as its first non-PHI instruction. The restrictions on the
3264    "<tt>landingpad</tt>" instruction's tightly couples it to the
3265    "<tt>invoke</tt>" instruction, so that the important information contained
3266    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3267    code motion.</p>
3268
3269 <h5>Arguments:</h5>
3270 <p>This instruction requires several arguments:</p>
3271
3272 <ol>
3273   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3274       convention</a> the call should use.  If none is specified, the call
3275       defaults to using C calling conventions.</li>
3276
3277   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3278       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3279       '<tt>inreg</tt>' attributes are valid here.</li>
3280
3281   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3282       function value being invoked.  In most cases, this is a direct function
3283       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3284       off an arbitrary pointer to function value.</li>
3285
3286   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3287       function to be invoked. </li>
3288
3289   <li>'<tt>function args</tt>': argument list whose types match the function
3290       signature argument types and parameter attributes. All arguments must be
3291       of <a href="#t_firstclass">first class</a> type. If the function
3292       signature indicates the function accepts a variable number of arguments,
3293       the extra arguments can be specified.</li>
3294
3295   <li>'<tt>normal label</tt>': the label reached when the called function
3296       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3297
3298   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3299       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3300
3301   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3302       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3303       '<tt>readnone</tt>' attributes are valid here.</li>
3304 </ol>
3305
3306 <h5>Semantics:</h5>
3307 <p>This instruction is designed to operate as a standard
3308    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3309    primary difference is that it establishes an association with a label, which
3310    is used by the runtime library to unwind the stack.</p>
3311
3312 <p>This instruction is used in languages with destructors to ensure that proper
3313    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3314    exception.  Additionally, this is important for implementation of
3315    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3316
3317 <p>For the purposes of the SSA form, the definition of the value returned by the
3318    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3319    block to the "normal" label. If the callee unwinds then no return value is
3320    available.</p>
3321
3322 <p>Note that the code generator does not yet completely support unwind, and
3323 that the invoke/unwind semantics are likely to change in future versions.</p>
3324
3325 <h5>Example:</h5>
3326 <pre>
3327   %retval = invoke i32 @Test(i32 15) to label %Continue
3328               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3329   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3330               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3331 </pre>
3332
3333 </div>
3334
3335 <!-- _______________________________________________________________________ -->
3336
3337 <h4>
3338   <a name="i_unwind">'<tt>unwind</tt>' Instruction</a>
3339 </h4>
3340
3341 <div>
3342
3343 <h5>Syntax:</h5>
3344 <pre>
3345   unwind
3346 </pre>
3347
3348 <h5>Overview:</h5>
3349 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3350    at the first callee in the dynamic call stack which used
3351    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3352    This is primarily used to implement exception handling.</p>
3353
3354 <h5>Semantics:</h5>
3355 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3356    immediately halt.  The dynamic call stack is then searched for the
3357    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3358    Once found, execution continues at the "exceptional" destination block
3359    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3360    instruction in the dynamic call chain, undefined behavior results.</p>
3361
3362 <p>Note that the code generator does not yet completely support unwind, and
3363 that the invoke/unwind semantics are likely to change in future versions.</p>
3364
3365 </div>
3366
3367  <!-- _______________________________________________________________________ -->
3368
3369 <h4>
3370   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3371 </h4>
3372
3373 <div>
3374
3375 <h5>Syntax:</h5>
3376 <pre>
3377   resume &lt;type&gt; &lt;value&gt;
3378 </pre>
3379
3380 <h5>Overview:</h5>
3381 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3382    successors.</p>
3383
3384 <h5>Arguments:</h5>
3385 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3386    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3387    function.</p>
3388
3389 <h5>Semantics:</h5>
3390 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3391    (in-flight) exception whose unwinding was interrupted with
3392    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3393
3394 <h5>Example:</h5>
3395 <pre>
3396   resume { i8*, i32 } %exn
3397 </pre>
3398
3399 </div>
3400
3401 <!-- _______________________________________________________________________ -->
3402
3403 <h4>
3404   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3405 </h4>
3406
3407 <div>
3408
3409 <h5>Syntax:</h5>
3410 <pre>
3411   unreachable
3412 </pre>
3413
3414 <h5>Overview:</h5>
3415 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3416    instruction is used to inform the optimizer that a particular portion of the
3417    code is not reachable.  This can be used to indicate that the code after a
3418    no-return function cannot be reached, and other facts.</p>
3419
3420 <h5>Semantics:</h5>
3421 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3422
3423 </div>
3424
3425 </div>
3426
3427 <!-- ======================================================================= -->
3428 <h3>
3429   <a name="binaryops">Binary Operations</a>
3430 </h3>
3431
3432 <div>
3433
3434 <p>Binary operators are used to do most of the computation in a program.  They
3435    require two operands of the same type, execute an operation on them, and
3436    produce a single value.  The operands might represent multiple data, as is
3437    the case with the <a href="#t_vector">vector</a> data type.  The result value
3438    has the same type as its operands.</p>
3439
3440 <p>There are several different binary operators:</p>
3441
3442 <!-- _______________________________________________________________________ -->
3443 <h4>
3444   <a name="i_add">'<tt>add</tt>' Instruction</a>
3445 </h4>
3446
3447 <div>
3448
3449 <h5>Syntax:</h5>
3450 <pre>
3451   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3452   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3453   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3454   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3455 </pre>
3456
3457 <h5>Overview:</h5>
3458 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3459
3460 <h5>Arguments:</h5>
3461 <p>The two arguments to the '<tt>add</tt>' instruction must
3462    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3463    integer values. Both arguments must have identical types.</p>
3464
3465 <h5>Semantics:</h5>
3466 <p>The value produced is the integer sum of the two operands.</p>
3467
3468 <p>If the sum has unsigned overflow, the result returned is the mathematical
3469    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3470
3471 <p>Because LLVM integers use a two's complement representation, this instruction
3472    is appropriate for both signed and unsigned integers.</p>
3473
3474 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3475    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3476    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3477    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3478    respectively, occurs.</p>
3479
3480 <h5>Example:</h5>
3481 <pre>
3482   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3483 </pre>
3484
3485 </div>
3486
3487 <!-- _______________________________________________________________________ -->
3488 <h4>
3489   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3490 </h4>
3491
3492 <div>
3493
3494 <h5>Syntax:</h5>
3495 <pre>
3496   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3497 </pre>
3498
3499 <h5>Overview:</h5>
3500 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3501
3502 <h5>Arguments:</h5>
3503 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3504    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3505    floating point values. Both arguments must have identical types.</p>
3506
3507 <h5>Semantics:</h5>
3508 <p>The value produced is the floating point sum of the two operands.</p>
3509
3510 <h5>Example:</h5>
3511 <pre>
3512   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3513 </pre>
3514
3515 </div>
3516
3517 <!-- _______________________________________________________________________ -->
3518 <h4>
3519    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3520 </h4>
3521
3522 <div>
3523
3524 <h5>Syntax:</h5>
3525 <pre>
3526   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3527   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3528   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3529   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3530 </pre>
3531
3532 <h5>Overview:</h5>
3533 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3534    operands.</p>
3535
3536 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3537    '<tt>neg</tt>' instruction present in most other intermediate
3538    representations.</p>
3539
3540 <h5>Arguments:</h5>
3541 <p>The two arguments to the '<tt>sub</tt>' instruction must
3542    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3543    integer values.  Both arguments must have identical types.</p>
3544
3545 <h5>Semantics:</h5>
3546 <p>The value produced is the integer difference of the two operands.</p>
3547
3548 <p>If the difference has unsigned overflow, the result returned is the
3549    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3550    result.</p>
3551
3552 <p>Because LLVM integers use a two's complement representation, this instruction
3553    is appropriate for both signed and unsigned integers.</p>
3554
3555 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3556    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3557    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3558    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3559    respectively, occurs.</p>
3560
3561 <h5>Example:</h5>
3562 <pre>
3563   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3564   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3565 </pre>
3566
3567 </div>
3568
3569 <!-- _______________________________________________________________________ -->
3570 <h4>
3571    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3572 </h4>
3573
3574 <div>
3575
3576 <h5>Syntax:</h5>
3577 <pre>
3578   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3579 </pre>
3580
3581 <h5>Overview:</h5>
3582 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3583    operands.</p>
3584
3585 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3586    '<tt>fneg</tt>' instruction present in most other intermediate
3587    representations.</p>
3588
3589 <h5>Arguments:</h5>
3590 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3591    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3592    floating point values.  Both arguments must have identical types.</p>
3593
3594 <h5>Semantics:</h5>
3595 <p>The value produced is the floating point difference of the two operands.</p>
3596
3597 <h5>Example:</h5>
3598 <pre>
3599   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3600   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3601 </pre>
3602
3603 </div>
3604
3605 <!-- _______________________________________________________________________ -->
3606 <h4>
3607   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3608 </h4>
3609
3610 <div>
3611
3612 <h5>Syntax:</h5>
3613 <pre>
3614   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3615   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3616   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3617   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3618 </pre>
3619
3620 <h5>Overview:</h5>
3621 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3622
3623 <h5>Arguments:</h5>
3624 <p>The two arguments to the '<tt>mul</tt>' instruction must
3625    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3626    integer values.  Both arguments must have identical types.</p>
3627
3628 <h5>Semantics:</h5>
3629 <p>The value produced is the integer product of the two operands.</p>
3630
3631 <p>If the result of the multiplication has unsigned overflow, the result
3632    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3633    width of the result.</p>
3634
3635 <p>Because LLVM integers use a two's complement representation, and the result
3636    is the same width as the operands, this instruction returns the correct
3637    result for both signed and unsigned integers.  If a full product
3638    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3639    be sign-extended or zero-extended as appropriate to the width of the full
3640    product.</p>
3641
3642 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3643    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3644    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3645    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3646    respectively, occurs.</p>
3647
3648 <h5>Example:</h5>
3649 <pre>
3650   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3651 </pre>
3652
3653 </div>
3654
3655 <!-- _______________________________________________________________________ -->
3656 <h4>
3657   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3658 </h4>
3659
3660 <div>
3661
3662 <h5>Syntax:</h5>
3663 <pre>
3664   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3665 </pre>
3666
3667 <h5>Overview:</h5>
3668 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3669
3670 <h5>Arguments:</h5>
3671 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3672    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3673    floating point values.  Both arguments must have identical types.</p>
3674
3675 <h5>Semantics:</h5>
3676 <p>The value produced is the floating point product of the two operands.</p>
3677
3678 <h5>Example:</h5>
3679 <pre>
3680   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3681 </pre>
3682
3683 </div>
3684
3685 <!-- _______________________________________________________________________ -->
3686 <h4>
3687   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
3688 </h4>
3689
3690 <div>
3691
3692 <h5>Syntax:</h5>
3693 <pre>
3694   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3695   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3696 </pre>
3697
3698 <h5>Overview:</h5>
3699 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3700
3701 <h5>Arguments:</h5>
3702 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3703    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3704    values.  Both arguments must have identical types.</p>
3705
3706 <h5>Semantics:</h5>
3707 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3708
3709 <p>Note that unsigned integer division and signed integer division are distinct
3710    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3711
3712 <p>Division by zero leads to undefined behavior.</p>
3713
3714 <p>If the <tt>exact</tt> keyword is present, the result value of the
3715    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3716   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3717
3718
3719 <h5>Example:</h5>
3720 <pre>
3721   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3722 </pre>
3723
3724 </div>
3725
3726 <!-- _______________________________________________________________________ -->
3727 <h4>
3728   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
3729 </h4>
3730
3731 <div>
3732
3733 <h5>Syntax:</h5>
3734 <pre>
3735   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3736   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3737 </pre>
3738
3739 <h5>Overview:</h5>
3740 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3741
3742 <h5>Arguments:</h5>
3743 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3744    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3745    values.  Both arguments must have identical types.</p>
3746
3747 <h5>Semantics:</h5>
3748 <p>The value produced is the signed integer quotient of the two operands rounded
3749    towards zero.</p>
3750
3751 <p>Note that signed integer division and unsigned integer division are distinct
3752    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3753
3754 <p>Division by zero leads to undefined behavior. Overflow also leads to
3755    undefined behavior; this is a rare case, but can occur, for example, by doing
3756    a 32-bit division of -2147483648 by -1.</p>
3757
3758 <p>If the <tt>exact</tt> keyword is present, the result value of the
3759    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3760    be rounded.</p>
3761
3762 <h5>Example:</h5>
3763 <pre>
3764   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3765 </pre>
3766
3767 </div>
3768
3769 <!-- _______________________________________________________________________ -->
3770 <h4>
3771   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
3772 </h4>
3773
3774 <div>
3775
3776 <h5>Syntax:</h5>
3777 <pre>
3778   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3779 </pre>
3780
3781 <h5>Overview:</h5>
3782 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3783
3784 <h5>Arguments:</h5>
3785 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3786    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3787    floating point values.  Both arguments must have identical types.</p>
3788
3789 <h5>Semantics:</h5>
3790 <p>The value produced is the floating point quotient of the two operands.</p>
3791
3792 <h5>Example:</h5>
3793 <pre>
3794   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3795 </pre>
3796
3797 </div>
3798
3799 <!-- _______________________________________________________________________ -->
3800 <h4>
3801   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3802 </h4>
3803
3804 <div>
3805
3806 <h5>Syntax:</h5>
3807 <pre>
3808   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3809 </pre>
3810
3811 <h5>Overview:</h5>
3812 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3813    division of its two arguments.</p>
3814
3815 <h5>Arguments:</h5>
3816 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3817    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3818    values.  Both arguments must have identical types.</p>
3819
3820 <h5>Semantics:</h5>
3821 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3822    This instruction always performs an unsigned division to get the
3823    remainder.</p>
3824
3825 <p>Note that unsigned integer remainder and signed integer remainder are
3826    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3827
3828 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3829
3830 <h5>Example:</h5>
3831 <pre>
3832   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3833 </pre>
3834
3835 </div>
3836
3837 <!-- _______________________________________________________________________ -->
3838 <h4>
3839   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3840 </h4>
3841
3842 <div>
3843
3844 <h5>Syntax:</h5>
3845 <pre>
3846   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3847 </pre>
3848
3849 <h5>Overview:</h5>
3850 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3851    division of its two operands. This instruction can also take
3852    <a href="#t_vector">vector</a> versions of the values in which case the
3853    elements must be integers.</p>
3854
3855 <h5>Arguments:</h5>
3856 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3857    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3858    values.  Both arguments must have identical types.</p>
3859
3860 <h5>Semantics:</h5>
3861 <p>This instruction returns the <i>remainder</i> of a division (where the result
3862    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3863    <i>modulo</i> operator (where the result is either zero or has the same sign
3864    as the divisor, <tt>op2</tt>) of a value.
3865    For more information about the difference,
3866    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3867    Math Forum</a>. For a table of how this is implemented in various languages,
3868    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3869    Wikipedia: modulo operation</a>.</p>
3870
3871 <p>Note that signed integer remainder and unsigned integer remainder are
3872    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3873
3874 <p>Taking the remainder of a division by zero leads to undefined behavior.
3875    Overflow also leads to undefined behavior; this is a rare case, but can
3876    occur, for example, by taking the remainder of a 32-bit division of
3877    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3878    lets srem be implemented using instructions that return both the result of
3879    the division and the remainder.)</p>
3880
3881 <h5>Example:</h5>
3882 <pre>
3883   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3884 </pre>
3885
3886 </div>
3887
3888 <!-- _______________________________________________________________________ -->
3889 <h4>
3890   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
3891 </h4>
3892
3893 <div>
3894
3895 <h5>Syntax:</h5>
3896 <pre>
3897   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3898 </pre>
3899
3900 <h5>Overview:</h5>
3901 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3902    its two operands.</p>
3903
3904 <h5>Arguments:</h5>
3905 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3906    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3907    floating point values.  Both arguments must have identical types.</p>
3908
3909 <h5>Semantics:</h5>
3910 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3911    has the same sign as the dividend.</p>
3912
3913 <h5>Example:</h5>
3914 <pre>
3915   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3916 </pre>
3917
3918 </div>
3919
3920 </div>
3921
3922 <!-- ======================================================================= -->
3923 <h3>
3924   <a name="bitwiseops">Bitwise Binary Operations</a>
3925 </h3>
3926
3927 <div>
3928
3929 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3930    program.  They are generally very efficient instructions and can commonly be
3931    strength reduced from other instructions.  They require two operands of the
3932    same type, execute an operation on them, and produce a single value.  The
3933    resulting value is the same type as its operands.</p>
3934
3935 <!-- _______________________________________________________________________ -->
3936 <h4>
3937   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
3938 </h4>
3939
3940 <div>
3941
3942 <h5>Syntax:</h5>
3943 <pre>
3944   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3945   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3946   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3947   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3948 </pre>
3949
3950 <h5>Overview:</h5>
3951 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3952    a specified number of bits.</p>
3953
3954 <h5>Arguments:</h5>
3955 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3956     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3957     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3958
3959 <h5>Semantics:</h5>
3960 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3961    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3962    is (statically or dynamically) negative or equal to or larger than the number
3963    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3964    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3965    shift amount in <tt>op2</tt>.</p>
3966
3967 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3968    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3969    the <tt>nsw</tt> keyword is present, then the shift produces a
3970    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3971    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3972    they would if the shift were expressed as a mul instruction with the same
3973    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3974
3975 <h5>Example:</h5>
3976 <pre>
3977   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3978   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3979   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3980   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3981   &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>
3982 </pre>
3983
3984 </div>
3985
3986 <!-- _______________________________________________________________________ -->
3987 <h4>
3988   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
3989 </h4>
3990
3991 <div>
3992
3993 <h5>Syntax:</h5>
3994 <pre>
3995   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3996   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3997 </pre>
3998
3999 <h5>Overview:</h5>
4000 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4001    operand shifted to the right a specified number of bits with zero fill.</p>
4002
4003 <h5>Arguments:</h5>
4004 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4005    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4006    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4007
4008 <h5>Semantics:</h5>
4009 <p>This instruction always performs a logical shift right operation. The most
4010    significant bits of the result will be filled with zero bits after the shift.
4011    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4012    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4013    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4014    shift amount in <tt>op2</tt>.</p>
4015
4016 <p>If the <tt>exact</tt> keyword is present, the result value of the
4017    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4018    shifted out are non-zero.</p>
4019
4020
4021 <h5>Example:</h5>
4022 <pre>
4023   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4024   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4025   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4026   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4027   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4028   &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>
4029 </pre>
4030
4031 </div>
4032
4033 <!-- _______________________________________________________________________ -->
4034 <h4>
4035   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4036 </h4>
4037
4038 <div>
4039
4040 <h5>Syntax:</h5>
4041 <pre>
4042   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4043   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4044 </pre>
4045
4046 <h5>Overview:</h5>
4047 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4048    operand shifted to the right a specified number of bits with sign
4049    extension.</p>
4050
4051 <h5>Arguments:</h5>
4052 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4053    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4054    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4055
4056 <h5>Semantics:</h5>
4057 <p>This instruction always performs an arithmetic shift right operation, The
4058    most significant bits of the result will be filled with the sign bit
4059    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4060    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4061    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4062    the corresponding shift amount in <tt>op2</tt>.</p>
4063
4064 <p>If the <tt>exact</tt> keyword is present, the result value of the
4065    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4066    shifted out are non-zero.</p>
4067
4068 <h5>Example:</h5>
4069 <pre>
4070   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4071   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4072   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4073   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4074   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4075   &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>
4076 </pre>
4077
4078 </div>
4079
4080 <!-- _______________________________________________________________________ -->
4081 <h4>
4082   <a name="i_and">'<tt>and</tt>' Instruction</a>
4083 </h4>
4084
4085 <div>
4086
4087 <h5>Syntax:</h5>
4088 <pre>
4089   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4090 </pre>
4091
4092 <h5>Overview:</h5>
4093 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4094    operands.</p>
4095
4096 <h5>Arguments:</h5>
4097 <p>The two arguments to the '<tt>and</tt>' instruction must be
4098    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4099    values.  Both arguments must have identical types.</p>
4100
4101 <h5>Semantics:</h5>
4102 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4103
4104 <table border="1" cellspacing="0" cellpadding="4">
4105   <tbody>
4106     <tr>
4107       <td>In0</td>
4108       <td>In1</td>
4109       <td>Out</td>
4110     </tr>
4111     <tr>
4112       <td>0</td>
4113       <td>0</td>
4114       <td>0</td>
4115     </tr>
4116     <tr>
4117       <td>0</td>
4118       <td>1</td>
4119       <td>0</td>
4120     </tr>
4121     <tr>
4122       <td>1</td>
4123       <td>0</td>
4124       <td>0</td>
4125     </tr>
4126     <tr>
4127       <td>1</td>
4128       <td>1</td>
4129       <td>1</td>
4130     </tr>
4131   </tbody>
4132 </table>
4133
4134 <h5>Example:</h5>
4135 <pre>
4136   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4137   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4138   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4139 </pre>
4140 </div>
4141 <!-- _______________________________________________________________________ -->
4142 <h4>
4143   <a name="i_or">'<tt>or</tt>' Instruction</a>
4144 </h4>
4145
4146 <div>
4147
4148 <h5>Syntax:</h5>
4149 <pre>
4150   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4151 </pre>
4152
4153 <h5>Overview:</h5>
4154 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4155    two operands.</p>
4156
4157 <h5>Arguments:</h5>
4158 <p>The two arguments to the '<tt>or</tt>' instruction must be
4159    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4160    values.  Both arguments must have identical types.</p>
4161
4162 <h5>Semantics:</h5>
4163 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4164
4165 <table border="1" cellspacing="0" cellpadding="4">
4166   <tbody>
4167     <tr>
4168       <td>In0</td>
4169       <td>In1</td>
4170       <td>Out</td>
4171     </tr>
4172     <tr>
4173       <td>0</td>
4174       <td>0</td>
4175       <td>0</td>
4176     </tr>
4177     <tr>
4178       <td>0</td>
4179       <td>1</td>
4180       <td>1</td>
4181     </tr>
4182     <tr>
4183       <td>1</td>
4184       <td>0</td>
4185       <td>1</td>
4186     </tr>
4187     <tr>
4188       <td>1</td>
4189       <td>1</td>
4190       <td>1</td>
4191     </tr>
4192   </tbody>
4193 </table>
4194
4195 <h5>Example:</h5>
4196 <pre>
4197   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4198   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4199   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4200 </pre>
4201
4202 </div>
4203
4204 <!-- _______________________________________________________________________ -->
4205 <h4>
4206   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4207 </h4>
4208
4209 <div>
4210
4211 <h5>Syntax:</h5>
4212 <pre>
4213   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4214 </pre>
4215
4216 <h5>Overview:</h5>
4217 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4218    its two operands.  The <tt>xor</tt> is used to implement the "one's
4219    complement" operation, which is the "~" operator in C.</p>
4220
4221 <h5>Arguments:</h5>
4222 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4223    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4224    values.  Both arguments must have identical types.</p>
4225
4226 <h5>Semantics:</h5>
4227 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4228
4229 <table border="1" cellspacing="0" cellpadding="4">
4230   <tbody>
4231     <tr>
4232       <td>In0</td>
4233       <td>In1</td>
4234       <td>Out</td>
4235     </tr>
4236     <tr>
4237       <td>0</td>
4238       <td>0</td>
4239       <td>0</td>
4240     </tr>
4241     <tr>
4242       <td>0</td>
4243       <td>1</td>
4244       <td>1</td>
4245     </tr>
4246     <tr>
4247       <td>1</td>
4248       <td>0</td>
4249       <td>1</td>
4250     </tr>
4251     <tr>
4252       <td>1</td>
4253       <td>1</td>
4254       <td>0</td>
4255     </tr>
4256   </tbody>
4257 </table>
4258
4259 <h5>Example:</h5>
4260 <pre>
4261   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4262   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4263   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4264   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4265 </pre>
4266
4267 </div>
4268
4269 </div>
4270
4271 <!-- ======================================================================= -->
4272 <h3>
4273   <a name="vectorops">Vector Operations</a>
4274 </h3>
4275
4276 <div>
4277
4278 <p>LLVM supports several instructions to represent vector operations in a
4279    target-independent manner.  These instructions cover the element-access and
4280    vector-specific operations needed to process vectors effectively.  While LLVM
4281    does directly support these vector operations, many sophisticated algorithms
4282    will want to use target-specific intrinsics to take full advantage of a
4283    specific target.</p>
4284
4285 <!-- _______________________________________________________________________ -->
4286 <h4>
4287    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4288 </h4>
4289
4290 <div>
4291
4292 <h5>Syntax:</h5>
4293 <pre>
4294   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4295 </pre>
4296
4297 <h5>Overview:</h5>
4298 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4299    from a vector at a specified index.</p>
4300
4301
4302 <h5>Arguments:</h5>
4303 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4304    of <a href="#t_vector">vector</a> type.  The second operand is an index
4305    indicating the position from which to extract the element.  The index may be
4306    a variable.</p>
4307
4308 <h5>Semantics:</h5>
4309 <p>The result is a scalar of the same type as the element type of
4310    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4311    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4312    results are undefined.</p>
4313
4314 <h5>Example:</h5>
4315 <pre>
4316   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4317 </pre>
4318
4319 </div>
4320
4321 <!-- _______________________________________________________________________ -->
4322 <h4>
4323    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4324 </h4>
4325
4326 <div>
4327
4328 <h5>Syntax:</h5>
4329 <pre>
4330   &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>
4331 </pre>
4332
4333 <h5>Overview:</h5>
4334 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4335    vector at a specified index.</p>
4336
4337 <h5>Arguments:</h5>
4338 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4339    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4340    whose type must equal the element type of the first operand.  The third
4341    operand is an index indicating the position at which to insert the value.
4342    The index may be a variable.</p>
4343
4344 <h5>Semantics:</h5>
4345 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4346    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4347    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4348    results are undefined.</p>
4349
4350 <h5>Example:</h5>
4351 <pre>
4352   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4353 </pre>
4354
4355 </div>
4356
4357 <!-- _______________________________________________________________________ -->
4358 <h4>
4359    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4360 </h4>
4361
4362 <div>
4363
4364 <h5>Syntax:</h5>
4365 <pre>
4366   &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>
4367 </pre>
4368
4369 <h5>Overview:</h5>
4370 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4371    from two input vectors, returning a vector with the same element type as the
4372    input and length that is the same as the shuffle mask.</p>
4373
4374 <h5>Arguments:</h5>
4375 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4376    with types that match each other. The third argument is a shuffle mask whose
4377    element type is always 'i32'.  The result of the instruction is a vector
4378    whose length is the same as the shuffle mask and whose element type is the
4379    same as the element type of the first two operands.</p>
4380
4381 <p>The shuffle mask operand is required to be a constant vector with either
4382    constant integer or undef values.</p>
4383
4384 <h5>Semantics:</h5>
4385 <p>The elements of the two input vectors are numbered from left to right across
4386    both of the vectors.  The shuffle mask operand specifies, for each element of
4387    the result vector, which element of the two input vectors the result element
4388    gets.  The element selector may be undef (meaning "don't care") and the
4389    second operand may be undef if performing a shuffle from only one vector.</p>
4390
4391 <h5>Example:</h5>
4392 <pre>
4393   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4394                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4395   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4396                           &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.
4397   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4398                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4399   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4400                           &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>
4401 </pre>
4402
4403 </div>
4404
4405 </div>
4406
4407 <!-- ======================================================================= -->
4408 <h3>
4409   <a name="aggregateops">Aggregate Operations</a>
4410 </h3>
4411
4412 <div>
4413
4414 <p>LLVM supports several instructions for working with
4415   <a href="#t_aggregate">aggregate</a> values.</p>
4416
4417 <!-- _______________________________________________________________________ -->
4418 <h4>
4419    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4420 </h4>
4421
4422 <div>
4423
4424 <h5>Syntax:</h5>
4425 <pre>
4426   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4427 </pre>
4428
4429 <h5>Overview:</h5>
4430 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4431    from an <a href="#t_aggregate">aggregate</a> value.</p>
4432
4433 <h5>Arguments:</h5>
4434 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4435    of <a href="#t_struct">struct</a> or
4436    <a href="#t_array">array</a> type.  The operands are constant indices to
4437    specify which value to extract in a similar manner as indices in a
4438    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4439    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4440      <ul>
4441        <li>Since the value being indexed is not a pointer, the first index is
4442            omitted and assumed to be zero.</li>
4443        <li>At least one index must be specified.</li>
4444        <li>Not only struct indices but also array indices must be in
4445            bounds.</li>
4446      </ul>
4447
4448 <h5>Semantics:</h5>
4449 <p>The result is the value at the position in the aggregate specified by the
4450    index operands.</p>
4451
4452 <h5>Example:</h5>
4453 <pre>
4454   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4455 </pre>
4456
4457 </div>
4458
4459 <!-- _______________________________________________________________________ -->
4460 <h4>
4461    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4462 </h4>
4463
4464 <div>
4465
4466 <h5>Syntax:</h5>
4467 <pre>
4468   &lt;result&gt; = insertvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt;, &lt;idx&gt;{, &lt;idx&gt;}*    <i>; yields &lt;aggregate type&gt;</i>
4469 </pre>
4470
4471 <h5>Overview:</h5>
4472 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4473    in an <a href="#t_aggregate">aggregate</a> value.</p>
4474
4475 <h5>Arguments:</h5>
4476 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4477    of <a href="#t_struct">struct</a> or
4478    <a href="#t_array">array</a> type.  The second operand is a first-class
4479    value to insert.  The following operands are constant indices indicating
4480    the position at which to insert the value in a similar manner as indices in a
4481    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4482    value to insert must have the same type as the value identified by the
4483    indices.</p>
4484
4485 <h5>Semantics:</h5>
4486 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4487    that of <tt>val</tt> except that the value at the position specified by the
4488    indices is that of <tt>elt</tt>.</p>
4489
4490 <h5>Example:</h5>
4491 <pre>
4492   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4493   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4494   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4495 </pre>
4496
4497 </div>
4498
4499 </div>
4500
4501 <!-- ======================================================================= -->
4502 <h3>
4503   <a name="memoryops">Memory Access and Addressing Operations</a>
4504 </h3>
4505
4506 <div>
4507
4508 <p>A key design point of an SSA-based representation is how it represents
4509    memory.  In LLVM, no memory locations are in SSA form, which makes things
4510    very simple.  This section describes how to read, write, and allocate
4511    memory in LLVM.</p>
4512
4513 <!-- _______________________________________________________________________ -->
4514 <h4>
4515   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4516 </h4>
4517
4518 <div>
4519
4520 <h5>Syntax:</h5>
4521 <pre>
4522   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4523 </pre>
4524
4525 <h5>Overview:</h5>
4526 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4527    currently executing function, to be automatically released when this function
4528    returns to its caller. The object is always allocated in the generic address
4529    space (address space zero).</p>
4530
4531 <h5>Arguments:</h5>
4532 <p>The '<tt>alloca</tt>' instruction
4533    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4534    runtime stack, returning a pointer of the appropriate type to the program.
4535    If "NumElements" is specified, it is the number of elements allocated,
4536    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4537    specified, the value result of the allocation is guaranteed to be aligned to
4538    at least that boundary.  If not specified, or if zero, the target can choose
4539    to align the allocation on any convenient boundary compatible with the
4540    type.</p>
4541
4542 <p>'<tt>type</tt>' may be any sized type.</p>
4543
4544 <h5>Semantics:</h5>
4545 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4546    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4547    memory is automatically released when the function returns.  The
4548    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4549    variables that must have an address available.  When the function returns
4550    (either with the <tt><a href="#i_ret">ret</a></tt>
4551    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4552    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4553
4554 <h5>Example:</h5>
4555 <pre>
4556   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4557   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4558   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4559   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4560 </pre>
4561
4562 </div>
4563
4564 <!-- _______________________________________________________________________ -->
4565 <h4>
4566   <a name="i_load">'<tt>load</tt>' Instruction</a>
4567 </h4>
4568
4569 <div>
4570
4571 <h5>Syntax:</h5>
4572 <pre>
4573   &lt;result&gt; = [volatile] load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4574   &lt;result&gt; = atomic [volatile] load &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4575   !&lt;index&gt; = !{ i32 1 }
4576 </pre>
4577
4578 <h5>Overview:</h5>
4579 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4580
4581 <h5>Arguments:</h5>
4582 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4583    from which to load.  The pointer must point to
4584    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4585    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4586    number or order of execution of this <tt>load</tt> with other <a
4587    href="#volatile">volatile operations</a>.</p>
4588
4589 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4590    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4591    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4592    not valid on <code>load</code> instructions.  Atomic loads produce <a
4593    href="#memorymodel">defined</a> results when they may see multiple atomic
4594    stores.  The type of the pointee must be an integer type whose bit width
4595    is a power of two greater than or equal to eight and less than or equal
4596    to a target-specific size limit. <code>align</code> must be explicitly
4597    specified on atomic loads, and the load has undefined behavior if the
4598    alignment is not set to a value which is at least the size in bytes of
4599    the pointee. <code>!nontemporal</code> does not have any defined semantics
4600    for atomic loads.</p>
4601
4602 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4603    operation (that is, the alignment of the memory address). A value of 0 or an
4604    omitted <tt>align</tt> argument means that the operation has the preferential
4605    alignment for the target. It is the responsibility of the code emitter to
4606    ensure that the alignment information is correct. Overestimating the
4607    alignment results in undefined behavior. Underestimating the alignment may
4608    produce less efficient code. An alignment of 1 is always safe.</p>
4609
4610 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4611    metatadata name &lt;index&gt; corresponding to a metadata node with
4612    one <tt>i32</tt> entry of value 1.  The existence of
4613    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4614    and code generator that this load is not expected to be reused in the cache.
4615    The code generator may select special instructions to save cache bandwidth,
4616    such as the <tt>MOVNT</tt> instruction on x86.</p>
4617
4618 <h5>Semantics:</h5>
4619 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4620    scalar type then the number of bytes read does not exceed the minimum number
4621    of bytes needed to hold all bits of the type.  For example, loading an
4622    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4623    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4624    is undefined if the value was not originally written using a store of the
4625    same type.</p>
4626
4627 <h5>Examples:</h5>
4628 <pre>
4629   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4630   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4631   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4632 </pre>
4633
4634 </div>
4635
4636 <!-- _______________________________________________________________________ -->
4637 <h4>
4638   <a name="i_store">'<tt>store</tt>' Instruction</a>
4639 </h4>
4640
4641 <div>
4642
4643 <h5>Syntax:</h5>
4644 <pre>
4645   [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>
4646   atomic [volatile] store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;             <i>; yields {void}</i>
4647 </pre>
4648
4649 <h5>Overview:</h5>
4650 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4651
4652 <h5>Arguments:</h5>
4653 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4654    and an address at which to store it.  The type of the
4655    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4656    the <a href="#t_firstclass">first class</a> type of the
4657    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4658    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4659    order of execution of this <tt>store</tt> with other <a
4660    href="#volatile">volatile operations</a>.</p>
4661
4662 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
4663    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4664    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
4665    valid on <code>store</code> instructions.  Atomic loads produce <a
4666    href="#memorymodel">defined</a> results when they may see multiple atomic
4667    stores. The type of the pointee must be an integer type whose bit width
4668    is a power of two greater than or equal to eight and less than or equal
4669    to a target-specific size limit. <code>align</code> must be explicitly
4670    specified on atomic stores, and the store has undefined behavior if the
4671    alignment is not set to a value which is at least the size in bytes of
4672    the pointee. <code>!nontemporal</code> does not have any defined semantics
4673    for atomic stores.</p>
4674
4675 <p>The optional constant "align" argument specifies the alignment of the
4676    operation (that is, the alignment of the memory address). A value of 0 or an
4677    omitted "align" argument means that the operation has the preferential
4678    alignment for the target. It is the responsibility of the code emitter to
4679    ensure that the alignment information is correct. Overestimating the
4680    alignment results in an undefined behavior. Underestimating the alignment may
4681    produce less efficient code. An alignment of 1 is always safe.</p>
4682
4683 <p>The optional !nontemporal metadata must reference a single metatadata
4684    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4685    value 1.  The existence of the !nontemporal metatadata on the
4686    instruction tells the optimizer and code generator that this load is
4687    not expected to be reused in the cache.  The code generator may
4688    select special instructions to save cache bandwidth, such as the
4689    MOVNT instruction on x86.</p>
4690
4691
4692 <h5>Semantics:</h5>
4693 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4694    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4695    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4696    does not exceed the minimum number of bytes needed to hold all bits of the
4697    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4698    writing a value of a type like <tt>i20</tt> with a size that is not an
4699    integral number of bytes, it is unspecified what happens to the extra bits
4700    that do not belong to the type, but they will typically be overwritten.</p>
4701
4702 <h5>Example:</h5>
4703 <pre>
4704   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4705   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4706   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4707 </pre>
4708
4709 </div>
4710
4711 <!-- _______________________________________________________________________ -->
4712 <div class="doc_subsubsection"> <a name="i_fence">'<tt>fence</tt>'
4713 Instruction</a> </div>
4714
4715 <div class="doc_text">
4716
4717 <h5>Syntax:</h5>
4718 <pre>
4719   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
4720 </pre>
4721
4722 <h5>Overview:</h5>
4723 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
4724 between operations.</p>
4725
4726 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
4727 href="#ordering">ordering</a> argument which defines what
4728 <i>synchronizes-with</i> edges they add.  They can only be given
4729 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
4730 <code>seq_cst</code> orderings.</p>
4731
4732 <h5>Semantics:</h5>
4733 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
4734 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
4735 <code>acquire</code> ordering semantics if and only if there exist atomic
4736 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
4737 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
4738 <var>X</var> modifies <var>M</var> (either directly or through some side effect
4739 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
4740 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
4741 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
4742 than an explicit <code>fence</code>, one (but not both) of the atomic operations
4743 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
4744 <code>acquire</code> (resp.) ordering constraint and still
4745 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
4746 <i>happens-before</i> edge.</p>
4747
4748 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
4749 having both <code>acquire</code> and <code>release</code> semantics specified
4750 above, participates in the global program order of other <code>seq_cst</code>
4751 operations and/or fences.</p>
4752
4753 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
4754 specifies that the fence only synchronizes with other fences in the same
4755 thread.  (This is useful for interacting with signal handlers.)</p>
4756
4757 <h5>Example:</h5>
4758 <pre>
4759   fence acquire                          <i>; yields {void}</i>
4760   fence singlethread seq_cst             <i>; yields {void}</i>
4761 </pre>
4762
4763 </div>
4764
4765 <!-- _______________________________________________________________________ -->
4766 <div class="doc_subsubsection"> <a name="i_cmpxchg">'<tt>cmpxchg</tt>'
4767 Instruction</a> </div>
4768
4769 <div class="doc_text">
4770
4771 <h5>Syntax:</h5>
4772 <pre>
4773   [volatile] cmpxchg &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;cmp&gt;, &lt;ty&gt; &lt;new&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4774 </pre>
4775
4776 <h5>Overview:</h5>
4777 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
4778 It loads a value in memory and compares it to a given value. If they are
4779 equal, it stores a new value into the memory.</p>
4780
4781 <h5>Arguments:</h5>
4782 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
4783 address to operate on, a value to compare to the value currently be at that
4784 address, and a new value to place at that address if the compared values are
4785 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
4786 bit width is a power of two greater than or equal to eight and less than
4787 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
4788 '<var>&lt;new&gt;</var>' must have the same type, and the type of
4789 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
4790 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
4791 optimizer is not allowed to modify the number or order of execution
4792 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
4793 operations</a>.</p>
4794
4795 <!-- FIXME: Extend allowed types. -->
4796
4797 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
4798 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
4799
4800 <p>The optional "<code>singlethread</code>" argument declares that the
4801 <code>cmpxchg</code> is only atomic with respect to code (usually signal
4802 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
4803 cmpxchg is atomic with respect to all other code in the system.</p>
4804
4805 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
4806 the size in memory of the operand.
4807
4808 <h5>Semantics:</h5>
4809 <p>The contents of memory at the location specified by the
4810 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
4811 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
4812 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
4813 is returned.
4814
4815 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
4816 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
4817 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
4818 parameter determined by dropping any <code>release</code> part of the
4819 <code>cmpxchg</code>'s ordering.</p>
4820
4821 <!--
4822 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
4823 optimization work on ARM.)
4824
4825 FIXME: Is a weaker ordering constraint on failure helpful in practice?
4826 -->
4827
4828 <h5>Example:</h5>
4829 <pre>
4830 entry:
4831   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                       <i>; yields {i32}</i>
4832   <a href="#i_br">br</a> label %loop
4833
4834 loop:
4835   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
4836   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
4837   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared                       <i>; yields {i32}</i>
4838   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
4839   <a href="#i_br">br</a> i1 %success, label %done, label %loop
4840
4841 done:
4842   ...
4843 </pre>
4844
4845 </div>
4846
4847 <!-- _______________________________________________________________________ -->
4848 <div class="doc_subsubsection"> <a name="i_atomicrmw">'<tt>atomicrmw</tt>'
4849 Instruction</a> </div>
4850
4851 <div class="doc_text">
4852
4853 <h5>Syntax:</h5>
4854 <pre>
4855   [volatile] atomicrmw &lt;operation&gt; &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;value&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4856 </pre>
4857
4858 <h5>Overview:</h5>
4859 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
4860
4861 <h5>Arguments:</h5>
4862 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
4863 operation to apply, an address whose value to modify, an argument to the
4864 operation.  The operation must be one of the following keywords:</p>
4865 <ul>
4866   <li>xchg</li>
4867   <li>add</li>
4868   <li>sub</li>
4869   <li>and</li>
4870   <li>nand</li>
4871   <li>or</li>
4872   <li>xor</li>
4873   <li>max</li>
4874   <li>min</li>
4875   <li>umax</li>
4876   <li>umin</li>
4877 </ul>
4878
4879 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
4880 bit width is a power of two greater than or equal to eight and less than
4881 or equal to a target-specific size limit.  The type of the
4882 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
4883 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
4884 optimizer is not allowed to modify the number or order of execution of this
4885 <code>atomicrmw</code> with other <a href="#volatile">volatile
4886   operations</a>.</p>
4887
4888 <!-- FIXME: Extend allowed types. -->
4889
4890 <h5>Semantics:</h5>
4891 <p>The contents of memory at the location specified by the
4892 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
4893 back.  The original value at the location is returned.  The modification is
4894 specified by the <var>operation</var> argument:</p>
4895
4896 <ul>
4897   <li>xchg: <code>*ptr = val</code></li>
4898   <li>add: <code>*ptr = *ptr + val</code></li>
4899   <li>sub: <code>*ptr = *ptr - val</code></li>
4900   <li>and: <code>*ptr = *ptr &amp; val</code></li>
4901   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
4902   <li>or: <code>*ptr = *ptr | val</code></li>
4903   <li>xor: <code>*ptr = *ptr ^ val</code></li>
4904   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
4905   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
4906   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4907   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4908 </ul>
4909
4910 <h5>Example:</h5>
4911 <pre>
4912   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
4913 </pre>
4914
4915 </div>
4916
4917 <!-- _______________________________________________________________________ -->
4918 <h4>
4919    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4920 </h4>
4921
4922 <div>
4923
4924 <h5>Syntax:</h5>
4925 <pre>
4926   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4927   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4928 </pre>
4929
4930 <h5>Overview:</h5>
4931 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4932    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4933    It performs address calculation only and does not access memory.</p>
4934
4935 <h5>Arguments:</h5>
4936 <p>The first argument is always a pointer, and forms the basis of the
4937    calculation. The remaining arguments are indices that indicate which of the
4938    elements of the aggregate object are indexed. The interpretation of each
4939    index is dependent on the type being indexed into. The first index always
4940    indexes the pointer value given as the first argument, the second index
4941    indexes a value of the type pointed to (not necessarily the value directly
4942    pointed to, since the first index can be non-zero), etc. The first type
4943    indexed into must be a pointer value, subsequent types can be arrays,
4944    vectors, and structs. Note that subsequent types being indexed into
4945    can never be pointers, since that would require loading the pointer before
4946    continuing calculation.</p>
4947
4948 <p>The type of each index argument depends on the type it is indexing into.
4949    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4950    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4951    or vector, integers of any width are allowed, and they are not required to be
4952    constant.</p>
4953
4954 <p>For example, let's consider a C code fragment and how it gets compiled to
4955    LLVM:</p>
4956
4957 <pre class="doc_code">
4958 struct RT {
4959   char A;
4960   int B[10][20];
4961   char C;
4962 };
4963 struct ST {
4964   int X;
4965   double Y;
4966   struct RT Z;
4967 };
4968
4969 int *foo(struct ST *s) {
4970   return &amp;s[1].Z.B[5][13];
4971 }
4972 </pre>
4973
4974 <p>The LLVM code generated by the GCC frontend is:</p>
4975
4976 <pre class="doc_code">
4977 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4978 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4979
4980 define i32* @foo(%ST* %s) {
4981 entry:
4982   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4983   ret i32* %reg
4984 }
4985 </pre>
4986
4987 <h5>Semantics:</h5>
4988 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4989    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4990    }</tt>' type, a structure.  The second index indexes into the third element
4991    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4992    i8 }</tt>' type, another structure.  The third index indexes into the second
4993    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4994    array.  The two dimensions of the array are subscripted into, yielding an
4995    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4996    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4997
4998 <p>Note that it is perfectly legal to index partially through a structure,
4999    returning a pointer to an inner element.  Because of this, the LLVM code for
5000    the given testcase is equivalent to:</p>
5001
5002 <pre>
5003   define i32* @foo(%ST* %s) {
5004     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
5005     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
5006     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
5007     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5008     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5009     ret i32* %t5
5010   }
5011 </pre>
5012
5013 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5014    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
5015    base pointer is not an <i>in bounds</i> address of an allocated object,
5016    or if any of the addresses that would be formed by successive addition of
5017    the offsets implied by the indices to the base address with infinitely
5018    precise arithmetic are not an <i>in bounds</i> address of that allocated
5019    object. The <i>in bounds</i> addresses for an allocated object are all
5020    the addresses that point into the object, plus the address one byte past
5021    the end.</p>
5022
5023 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5024    the base address with silently-wrapping two's complement arithmetic, and
5025    the result value of the <tt>getelementptr</tt> may be outside the object
5026    pointed to by the base pointer. The result value may not necessarily be
5027    used to access memory though, even if it happens to point into allocated
5028    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
5029    section for more information.</p>
5030
5031 <p>The getelementptr instruction is often confusing.  For some more insight into
5032    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5033
5034 <h5>Example:</h5>
5035 <pre>
5036     <i>; yields [12 x i8]*:aptr</i>
5037     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5038     <i>; yields i8*:vptr</i>
5039     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5040     <i>; yields i8*:eptr</i>
5041     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5042     <i>; yields i32*:iptr</i>
5043     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5044 </pre>
5045
5046 </div>
5047
5048 </div>
5049
5050 <!-- ======================================================================= -->
5051 <h3>
5052   <a name="convertops">Conversion Operations</a>
5053 </h3>
5054
5055 <div>
5056
5057 <p>The instructions in this category are the conversion instructions (casting)
5058    which all take a single operand and a type. They perform various bit
5059    conversions on the operand.</p>
5060
5061 <!-- _______________________________________________________________________ -->
5062 <h4>
5063    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5064 </h4>
5065
5066 <div>
5067
5068 <h5>Syntax:</h5>
5069 <pre>
5070   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5071 </pre>
5072
5073 <h5>Overview:</h5>
5074 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5075    type <tt>ty2</tt>.</p>
5076
5077 <h5>Arguments:</h5>
5078 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5079    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5080    of the same number of integers.
5081    The bit size of the <tt>value</tt> must be larger than
5082    the bit size of the destination type, <tt>ty2</tt>.
5083    Equal sized types are not allowed.</p>
5084
5085 <h5>Semantics:</h5>
5086 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5087    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5088    source size must be larger than the destination size, <tt>trunc</tt> cannot
5089    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5090
5091 <h5>Example:</h5>
5092 <pre>
5093   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5094   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5095   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5096   %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>
5097 </pre>
5098
5099 </div>
5100
5101 <!-- _______________________________________________________________________ -->
5102 <h4>
5103    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5104 </h4>
5105
5106 <div>
5107
5108 <h5>Syntax:</h5>
5109 <pre>
5110   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5111 </pre>
5112
5113 <h5>Overview:</h5>
5114 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5115    <tt>ty2</tt>.</p>
5116
5117
5118 <h5>Arguments:</h5>
5119 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5120    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5121    of the same number of integers.
5122    The bit size of the <tt>value</tt> must be smaller than
5123    the bit size of the destination type,
5124    <tt>ty2</tt>.</p>
5125
5126 <h5>Semantics:</h5>
5127 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5128    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5129
5130 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5131
5132 <h5>Example:</h5>
5133 <pre>
5134   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5135   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5136   %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>
5137 </pre>
5138
5139 </div>
5140
5141 <!-- _______________________________________________________________________ -->
5142 <h4>
5143    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5144 </h4>
5145
5146 <div>
5147
5148 <h5>Syntax:</h5>
5149 <pre>
5150   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5151 </pre>
5152
5153 <h5>Overview:</h5>
5154 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5155
5156 <h5>Arguments:</h5>
5157 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5158    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5159    of the same number of integers.
5160    The bit size of the <tt>value</tt> must be smaller than
5161    the bit size of the destination type,
5162    <tt>ty2</tt>.</p>
5163
5164 <h5>Semantics:</h5>
5165 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5166    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5167    of the type <tt>ty2</tt>.</p>
5168
5169 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5170
5171 <h5>Example:</h5>
5172 <pre>
5173   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5174   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5175   %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>
5176 </pre>
5177
5178 </div>
5179
5180 <!-- _______________________________________________________________________ -->
5181 <h4>
5182    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5183 </h4>
5184
5185 <div>
5186
5187 <h5>Syntax:</h5>
5188 <pre>
5189   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5190 </pre>
5191
5192 <h5>Overview:</h5>
5193 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5194    <tt>ty2</tt>.</p>
5195
5196 <h5>Arguments:</h5>
5197 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5198    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5199    to cast it to. The size of <tt>value</tt> must be larger than the size of
5200    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5201    <i>no-op cast</i>.</p>
5202
5203 <h5>Semantics:</h5>
5204 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5205    <a href="#t_floating">floating point</a> type to a smaller
5206    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5207    within the destination type, <tt>ty2</tt>, then the results are
5208    undefined.</p>
5209
5210 <h5>Example:</h5>
5211 <pre>
5212   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5213   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5214 </pre>
5215
5216 </div>
5217
5218 <!-- _______________________________________________________________________ -->
5219 <h4>
5220    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5221 </h4>
5222
5223 <div>
5224
5225 <h5>Syntax:</h5>
5226 <pre>
5227   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5228 </pre>
5229
5230 <h5>Overview:</h5>
5231 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5232    floating point value.</p>
5233
5234 <h5>Arguments:</h5>
5235 <p>The '<tt>fpext</tt>' instruction takes a
5236    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5237    a <a href="#t_floating">floating point</a> type to cast it to. The source
5238    type must be smaller than the destination type.</p>
5239
5240 <h5>Semantics:</h5>
5241 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5242    <a href="#t_floating">floating point</a> type to a larger
5243    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5244    used to make a <i>no-op cast</i> because it always changes bits. Use
5245    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5246
5247 <h5>Example:</h5>
5248 <pre>
5249   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5250   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5251 </pre>
5252
5253 </div>
5254
5255 <!-- _______________________________________________________________________ -->
5256 <h4>
5257    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5258 </h4>
5259
5260 <div>
5261
5262 <h5>Syntax:</h5>
5263 <pre>
5264   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5265 </pre>
5266
5267 <h5>Overview:</h5>
5268 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5269    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5270
5271 <h5>Arguments:</h5>
5272 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5273    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5274    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5275    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5276    vector integer type with the same number of elements as <tt>ty</tt></p>
5277
5278 <h5>Semantics:</h5>
5279 <p>The '<tt>fptoui</tt>' instruction converts its
5280    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5281    towards zero) unsigned integer value. If the value cannot fit
5282    in <tt>ty2</tt>, the results are undefined.</p>
5283
5284 <h5>Example:</h5>
5285 <pre>
5286   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5287   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5288   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5289 </pre>
5290
5291 </div>
5292
5293 <!-- _______________________________________________________________________ -->
5294 <h4>
5295    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5296 </h4>
5297
5298 <div>
5299
5300 <h5>Syntax:</h5>
5301 <pre>
5302   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5303 </pre>
5304
5305 <h5>Overview:</h5>
5306 <p>The '<tt>fptosi</tt>' instruction converts
5307    <a href="#t_floating">floating point</a> <tt>value</tt> to
5308    type <tt>ty2</tt>.</p>
5309
5310 <h5>Arguments:</h5>
5311 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5312    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5313    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5314    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5315    vector integer type with the same number of elements as <tt>ty</tt></p>
5316
5317 <h5>Semantics:</h5>
5318 <p>The '<tt>fptosi</tt>' instruction converts its
5319    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5320    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5321    the results are undefined.</p>
5322
5323 <h5>Example:</h5>
5324 <pre>
5325   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5326   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5327   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5328 </pre>
5329
5330 </div>
5331
5332 <!-- _______________________________________________________________________ -->
5333 <h4>
5334    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5335 </h4>
5336
5337 <div>
5338
5339 <h5>Syntax:</h5>
5340 <pre>
5341   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5342 </pre>
5343
5344 <h5>Overview:</h5>
5345 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5346    integer and converts that value to the <tt>ty2</tt> type.</p>
5347
5348 <h5>Arguments:</h5>
5349 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5350    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5351    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5352    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5353    floating point type with the same number of elements as <tt>ty</tt></p>
5354
5355 <h5>Semantics:</h5>
5356 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5357    integer quantity and converts it to the corresponding floating point
5358    value. If the value cannot fit in the floating point value, the results are
5359    undefined.</p>
5360
5361 <h5>Example:</h5>
5362 <pre>
5363   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5364   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5365 </pre>
5366
5367 </div>
5368
5369 <!-- _______________________________________________________________________ -->
5370 <h4>
5371    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5372 </h4>
5373
5374 <div>
5375
5376 <h5>Syntax:</h5>
5377 <pre>
5378   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5379 </pre>
5380
5381 <h5>Overview:</h5>
5382 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5383    and converts that value to the <tt>ty2</tt> type.</p>
5384
5385 <h5>Arguments:</h5>
5386 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5387    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5388    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5389    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5390    floating point type with the same number of elements as <tt>ty</tt></p>
5391
5392 <h5>Semantics:</h5>
5393 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5394    quantity and converts it to the corresponding floating point value. If the
5395    value cannot fit in the floating point value, the results are undefined.</p>
5396
5397 <h5>Example:</h5>
5398 <pre>
5399   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5400   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5401 </pre>
5402
5403 </div>
5404
5405 <!-- _______________________________________________________________________ -->
5406 <h4>
5407    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5408 </h4>
5409
5410 <div>
5411
5412 <h5>Syntax:</h5>
5413 <pre>
5414   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5415 </pre>
5416
5417 <h5>Overview:</h5>
5418 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
5419    the integer type <tt>ty2</tt>.</p>
5420
5421 <h5>Arguments:</h5>
5422 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5423    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
5424    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
5425
5426 <h5>Semantics:</h5>
5427 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5428    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5429    truncating or zero extending that value to the size of the integer type. If
5430    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5431    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5432    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5433    change.</p>
5434
5435 <h5>Example:</h5>
5436 <pre>
5437   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
5438   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
5439 </pre>
5440
5441 </div>
5442
5443 <!-- _______________________________________________________________________ -->
5444 <h4>
5445    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5446 </h4>
5447
5448 <div>
5449
5450 <h5>Syntax:</h5>
5451 <pre>
5452   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5453 </pre>
5454
5455 <h5>Overview:</h5>
5456 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5457    pointer type, <tt>ty2</tt>.</p>
5458
5459 <h5>Arguments:</h5>
5460 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5461    value to cast, and a type to cast it to, which must be a
5462    <a href="#t_pointer">pointer</a> type.</p>
5463
5464 <h5>Semantics:</h5>
5465 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5466    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5467    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5468    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5469    than the size of a pointer then a zero extension is done. If they are the
5470    same size, nothing is done (<i>no-op cast</i>).</p>
5471
5472 <h5>Example:</h5>
5473 <pre>
5474   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5475   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5476   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5477 </pre>
5478
5479 </div>
5480
5481 <!-- _______________________________________________________________________ -->
5482 <h4>
5483    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5484 </h4>
5485
5486 <div>
5487
5488 <h5>Syntax:</h5>
5489 <pre>
5490   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5491 </pre>
5492
5493 <h5>Overview:</h5>
5494 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5495    <tt>ty2</tt> without changing any bits.</p>
5496
5497 <h5>Arguments:</h5>
5498 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5499    non-aggregate first class value, and a type to cast it to, which must also be
5500    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5501    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5502    identical. If the source type is a pointer, the destination type must also be
5503    a pointer.  This instruction supports bitwise conversion of vectors to
5504    integers and to vectors of other types (as long as they have the same
5505    size).</p>
5506
5507 <h5>Semantics:</h5>
5508 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5509    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5510    this conversion.  The conversion is done as if the <tt>value</tt> had been
5511    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5512    be converted to other pointer types with this instruction. To convert
5513    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5514    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5515
5516 <h5>Example:</h5>
5517 <pre>
5518   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5519   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5520   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5521 </pre>
5522
5523 </div>
5524
5525 </div>
5526
5527 <!-- ======================================================================= -->
5528 <h3>
5529   <a name="otherops">Other Operations</a>
5530 </h3>
5531
5532 <div>
5533
5534 <p>The instructions in this category are the "miscellaneous" instructions, which
5535    defy better classification.</p>
5536
5537 <!-- _______________________________________________________________________ -->
5538 <h4>
5539   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5540 </h4>
5541
5542 <div>
5543
5544 <h5>Syntax:</h5>
5545 <pre>
5546   &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>
5547 </pre>
5548
5549 <h5>Overview:</h5>
5550 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5551    boolean values based on comparison of its two integer, integer vector, or
5552    pointer operands.</p>
5553
5554 <h5>Arguments:</h5>
5555 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5556    the condition code indicating the kind of comparison to perform. It is not a
5557    value, just a keyword. The possible condition code are:</p>
5558
5559 <ol>
5560   <li><tt>eq</tt>: equal</li>
5561   <li><tt>ne</tt>: not equal </li>
5562   <li><tt>ugt</tt>: unsigned greater than</li>
5563   <li><tt>uge</tt>: unsigned greater or equal</li>
5564   <li><tt>ult</tt>: unsigned less than</li>
5565   <li><tt>ule</tt>: unsigned less or equal</li>
5566   <li><tt>sgt</tt>: signed greater than</li>
5567   <li><tt>sge</tt>: signed greater or equal</li>
5568   <li><tt>slt</tt>: signed less than</li>
5569   <li><tt>sle</tt>: signed less or equal</li>
5570 </ol>
5571
5572 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5573    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5574    typed.  They must also be identical types.</p>
5575
5576 <h5>Semantics:</h5>
5577 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5578    condition code given as <tt>cond</tt>. The comparison performed always yields
5579    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5580    result, as follows:</p>
5581
5582 <ol>
5583   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5584       <tt>false</tt> otherwise. No sign interpretation is necessary or
5585       performed.</li>
5586
5587   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5588       <tt>false</tt> otherwise. No sign interpretation is necessary or
5589       performed.</li>
5590
5591   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5592       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5593
5594   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5595       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5596       to <tt>op2</tt>.</li>
5597
5598   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5599       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5600
5601   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5602       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5603
5604   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5605       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5606
5607   <li><tt>sge</tt>: interprets the operands as signed values and yields
5608       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5609       to <tt>op2</tt>.</li>
5610
5611   <li><tt>slt</tt>: interprets the operands as signed values and yields
5612       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5613
5614   <li><tt>sle</tt>: interprets the operands as signed values and yields
5615       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5616 </ol>
5617
5618 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5619    values are compared as if they were integers.</p>
5620
5621 <p>If the operands are integer vectors, then they are compared element by
5622    element. The result is an <tt>i1</tt> vector with the same number of elements
5623    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5624
5625 <h5>Example:</h5>
5626 <pre>
5627   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5628   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5629   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5630   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5631   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5632   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5633 </pre>
5634
5635 <p>Note that the code generator does not yet support vector types with
5636    the <tt>icmp</tt> instruction.</p>
5637
5638 </div>
5639
5640 <!-- _______________________________________________________________________ -->
5641 <h4>
5642   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5643 </h4>
5644
5645 <div>
5646
5647 <h5>Syntax:</h5>
5648 <pre>
5649   &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>
5650 </pre>
5651
5652 <h5>Overview:</h5>
5653 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5654    values based on comparison of its operands.</p>
5655
5656 <p>If the operands are floating point scalars, then the result type is a boolean
5657 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5658
5659 <p>If the operands are floating point vectors, then the result type is a vector
5660    of boolean with the same number of elements as the operands being
5661    compared.</p>
5662
5663 <h5>Arguments:</h5>
5664 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5665    the condition code indicating the kind of comparison to perform. It is not a
5666    value, just a keyword. The possible condition code are:</p>
5667
5668 <ol>
5669   <li><tt>false</tt>: no comparison, always returns false</li>
5670   <li><tt>oeq</tt>: ordered and equal</li>
5671   <li><tt>ogt</tt>: ordered and greater than </li>
5672   <li><tt>oge</tt>: ordered and greater than or equal</li>
5673   <li><tt>olt</tt>: ordered and less than </li>
5674   <li><tt>ole</tt>: ordered and less than or equal</li>
5675   <li><tt>one</tt>: ordered and not equal</li>
5676   <li><tt>ord</tt>: ordered (no nans)</li>
5677   <li><tt>ueq</tt>: unordered or equal</li>
5678   <li><tt>ugt</tt>: unordered or greater than </li>
5679   <li><tt>uge</tt>: unordered or greater than or equal</li>
5680   <li><tt>ult</tt>: unordered or less than </li>
5681   <li><tt>ule</tt>: unordered or less than or equal</li>
5682   <li><tt>une</tt>: unordered or not equal</li>
5683   <li><tt>uno</tt>: unordered (either nans)</li>
5684   <li><tt>true</tt>: no comparison, always returns true</li>
5685 </ol>
5686
5687 <p><i>Ordered</i> means that neither operand is a QNAN while
5688    <i>unordered</i> means that either operand may be a QNAN.</p>
5689
5690 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5691    a <a href="#t_floating">floating point</a> type or
5692    a <a href="#t_vector">vector</a> of floating point type.  They must have
5693    identical types.</p>
5694
5695 <h5>Semantics:</h5>
5696 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5697    according to the condition code given as <tt>cond</tt>.  If the operands are
5698    vectors, then the vectors are compared element by element.  Each comparison
5699    performed always yields an <a href="#t_integer">i1</a> result, as
5700    follows:</p>
5701
5702 <ol>
5703   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5704
5705   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5706       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5707
5708   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5709       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5710
5711   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5712       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5713
5714   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5715       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5716
5717   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5718       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5719
5720   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5721       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5722
5723   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5724
5725   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5726       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5727
5728   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5729       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5730
5731   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5732       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5733
5734   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5735       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5736
5737   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5738       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5739
5740   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5741       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5742
5743   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5744
5745   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5746 </ol>
5747
5748 <h5>Example:</h5>
5749 <pre>
5750   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5751   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5752   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5753   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5754 </pre>
5755
5756 <p>Note that the code generator does not yet support vector types with
5757    the <tt>fcmp</tt> instruction.</p>
5758
5759 </div>
5760
5761 <!-- _______________________________________________________________________ -->
5762 <h4>
5763   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5764 </h4>
5765
5766 <div>
5767
5768 <h5>Syntax:</h5>
5769 <pre>
5770   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5771 </pre>
5772
5773 <h5>Overview:</h5>
5774 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5775    SSA graph representing the function.</p>
5776
5777 <h5>Arguments:</h5>
5778 <p>The type of the incoming values is specified with the first type field. After
5779    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5780    one pair for each predecessor basic block of the current block.  Only values
5781    of <a href="#t_firstclass">first class</a> type may be used as the value
5782    arguments to the PHI node.  Only labels may be used as the label
5783    arguments.</p>
5784
5785 <p>There must be no non-phi instructions between the start of a basic block and
5786    the PHI instructions: i.e. PHI instructions must be first in a basic
5787    block.</p>
5788
5789 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5790    occur on the edge from the corresponding predecessor block to the current
5791    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5792    value on the same edge).</p>
5793
5794 <h5>Semantics:</h5>
5795 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5796    specified by the pair corresponding to the predecessor basic block that
5797    executed just prior to the current block.</p>
5798
5799 <h5>Example:</h5>
5800 <pre>
5801 Loop:       ; Infinite loop that counts from 0 on up...
5802   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5803   %nextindvar = add i32 %indvar, 1
5804   br label %Loop
5805 </pre>
5806
5807 </div>
5808
5809 <!-- _______________________________________________________________________ -->
5810 <h4>
5811    <a name="i_select">'<tt>select</tt>' Instruction</a>
5812 </h4>
5813
5814 <div>
5815
5816 <h5>Syntax:</h5>
5817 <pre>
5818   &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>
5819
5820   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5821 </pre>
5822
5823 <h5>Overview:</h5>
5824 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5825    condition, without branching.</p>
5826
5827
5828 <h5>Arguments:</h5>
5829 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5830    values indicating the condition, and two values of the
5831    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5832    vectors and the condition is a scalar, then entire vectors are selected, not
5833    individual elements.</p>
5834
5835 <h5>Semantics:</h5>
5836 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5837    first value argument; otherwise, it returns the second value argument.</p>
5838
5839 <p>If the condition is a vector of i1, then the value arguments must be vectors
5840    of the same size, and the selection is done element by element.</p>
5841
5842 <h5>Example:</h5>
5843 <pre>
5844   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5845 </pre>
5846
5847 <p>Note that the code generator does not yet support conditions
5848    with vector type.</p>
5849
5850 </div>
5851
5852 <!-- _______________________________________________________________________ -->
5853 <h4>
5854   <a name="i_call">'<tt>call</tt>' Instruction</a>
5855 </h4>
5856
5857 <div>
5858
5859 <h5>Syntax:</h5>
5860 <pre>
5861   &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>]
5862 </pre>
5863
5864 <h5>Overview:</h5>
5865 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5866
5867 <h5>Arguments:</h5>
5868 <p>This instruction requires several arguments:</p>
5869
5870 <ol>
5871   <li>The optional "tail" marker indicates that the callee function does not
5872       access any allocas or varargs in the caller.  Note that calls may be
5873       marked "tail" even if they do not occur before
5874       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5875       present, the function call is eligible for tail call optimization,
5876       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5877       optimized into a jump</a>.  The code generator may optimize calls marked
5878       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5879       sibling call optimization</a> when the caller and callee have
5880       matching signatures, or 2) forced tail call optimization when the
5881       following extra requirements are met:
5882       <ul>
5883         <li>Caller and callee both have the calling
5884             convention <tt>fastcc</tt>.</li>
5885         <li>The call is in tail position (ret immediately follows call and ret
5886             uses value of call or is void).</li>
5887         <li>Option <tt>-tailcallopt</tt> is enabled,
5888             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5889         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5890             constraints are met.</a></li>
5891       </ul>
5892   </li>
5893
5894   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5895       convention</a> the call should use.  If none is specified, the call
5896       defaults to using C calling conventions.  The calling convention of the
5897       call must match the calling convention of the target function, or else the
5898       behavior is undefined.</li>
5899
5900   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5901       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5902       '<tt>inreg</tt>' attributes are valid here.</li>
5903
5904   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5905       type of the return value.  Functions that return no value are marked
5906       <tt><a href="#t_void">void</a></tt>.</li>
5907
5908   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5909       being invoked.  The argument types must match the types implied by this
5910       signature.  This type can be omitted if the function is not varargs and if
5911       the function type does not return a pointer to a function.</li>
5912
5913   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5914       be invoked. In most cases, this is a direct function invocation, but
5915       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5916       to function value.</li>
5917
5918   <li>'<tt>function args</tt>': argument list whose types match the function
5919       signature argument types and parameter attributes. All arguments must be
5920       of <a href="#t_firstclass">first class</a> type. If the function
5921       signature indicates the function accepts a variable number of arguments,
5922       the extra arguments can be specified.</li>
5923
5924   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5925       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5926       '<tt>readnone</tt>' attributes are valid here.</li>
5927 </ol>
5928
5929 <h5>Semantics:</h5>
5930 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5931    a specified function, with its incoming arguments bound to the specified
5932    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5933    function, control flow continues with the instruction after the function
5934    call, and the return value of the function is bound to the result
5935    argument.</p>
5936
5937 <h5>Example:</h5>
5938 <pre>
5939   %retval = call i32 @test(i32 %argc)
5940   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5941   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5942   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5943   call void %foo(i8 97 signext)
5944
5945   %struct.A = type { i32, i8 }
5946   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5947   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5948   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5949   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5950   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5951 </pre>
5952
5953 <p>llvm treats calls to some functions with names and arguments that match the
5954 standard C99 library as being the C99 library functions, and may perform
5955 optimizations or generate code for them under that assumption.  This is
5956 something we'd like to change in the future to provide better support for
5957 freestanding environments and non-C-based languages.</p>
5958
5959 </div>
5960
5961 <!-- _______________________________________________________________________ -->
5962 <h4>
5963   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5964 </h4>
5965
5966 <div>
5967
5968 <h5>Syntax:</h5>
5969 <pre>
5970   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5971 </pre>
5972
5973 <h5>Overview:</h5>
5974 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5975    the "variable argument" area of a function call.  It is used to implement the
5976    <tt>va_arg</tt> macro in C.</p>
5977
5978 <h5>Arguments:</h5>
5979 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5980    argument. It returns a value of the specified argument type and increments
5981    the <tt>va_list</tt> to point to the next argument.  The actual type
5982    of <tt>va_list</tt> is target specific.</p>
5983
5984 <h5>Semantics:</h5>
5985 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5986    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5987    to the next argument.  For more information, see the variable argument
5988    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5989
5990 <p>It is legal for this instruction to be called in a function which does not
5991    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5992    function.</p>
5993
5994 <p><tt>va_arg</tt> is an LLVM instruction instead of
5995    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5996    argument.</p>
5997
5998 <h5>Example:</h5>
5999 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6000
6001 <p>Note that the code generator does not yet fully support va_arg on many
6002    targets. Also, it does not currently support va_arg with aggregate types on
6003    any target.</p>
6004
6005 </div>
6006
6007 <!-- _______________________________________________________________________ -->
6008 <h4>
6009   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6010 </h4>
6011
6012 <div>
6013
6014 <h5>Syntax:</h5>
6015 <pre>
6016   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6017   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6018
6019   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6020   &lt;clause&gt; := filter &lt;type&gt; &lt;value&gt; {, &lt;type&gt; &lt;value&gt;}*
6021 </pre>
6022
6023 <h5>Overview:</h5>
6024 <p>The '<tt>landingpad</tt>' instruction is used by
6025    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6026    system</a> to specify that a basic block is a landing pad &mdash; one where
6027    the exception lands, and corresponds to the code found in the
6028    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6029    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6030    re-entry to the function. The <tt>resultval</tt> has the
6031    type <tt>somety</tt>.</p>
6032
6033 <h5>Arguments:</h5>
6034 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6035    function associated with the unwinding mechanism. The optional
6036    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6037
6038 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6039    or <tt>filter</tt> &mdash; and contains a list of global variables
6040    representing the "types" that may be caught or filtered respectively. The
6041    '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6042    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6043
6044 <h5>Semantics:</h5>
6045 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6046    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6047    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6048    calling conventions, how the personality function results are represented in
6049    LLVM IR is target specific.</p>
6050
6051 <p>The clauses are applied in order from top to bottom. If two
6052    <tt>landingpad</tt> instructions are merged together through inlining, the
6053    clauses from the calling function are appended to the list of clauses.</p>
6054
6055 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6056
6057 <ul>
6058   <li>A landing pad block is a basic block which is the unwind destination of an
6059       '<tt>invoke</tt>' instruction.</li>
6060   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6061       first non-PHI instruction.</li>
6062   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6063       pad block.</li>
6064   <li>A basic block that is not a landing pad block may not include a
6065       '<tt>landingpad</tt>' instruction.</li>
6066   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6067       personality function.</li>
6068 </ul>
6069
6070 <h5>Example:</h5>
6071 <pre>
6072   ;; A landing pad which can catch an integer.
6073   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6074            catch i8** @_ZTIi
6075   ;; A landing pad that is a cleanup.
6076   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6077            cleanup
6078   ;; A landing pad which can catch an integer and can only throw a double.
6079   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6080            catch i8** @_ZTIi
6081            filter i8** @_ZTId
6082 </pre>
6083
6084 </div>
6085
6086 </div>
6087
6088 </div>
6089
6090 <!-- *********************************************************************** -->
6091 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6092 <!-- *********************************************************************** -->
6093
6094 <div>
6095
6096 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6097    well known names and semantics and are required to follow certain
6098    restrictions.  Overall, these intrinsics represent an extension mechanism for
6099    the LLVM language that does not require changing all of the transformations
6100    in LLVM when adding to the language (or the bitcode reader/writer, the
6101    parser, etc...).</p>
6102
6103 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6104    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6105    begin with this prefix.  Intrinsic functions must always be external
6106    functions: you cannot define the body of intrinsic functions.  Intrinsic
6107    functions may only be used in call or invoke instructions: it is illegal to
6108    take the address of an intrinsic function.  Additionally, because intrinsic
6109    functions are part of the LLVM language, it is required if any are added that
6110    they be documented here.</p>
6111
6112 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6113    family of functions that perform the same operation but on different data
6114    types. Because LLVM can represent over 8 million different integer types,
6115    overloading is used commonly to allow an intrinsic function to operate on any
6116    integer type. One or more of the argument types or the result type can be
6117    overloaded to accept any integer type. Argument types may also be defined as
6118    exactly matching a previous argument's type or the result type. This allows
6119    an intrinsic function which accepts multiple arguments, but needs all of them
6120    to be of the same type, to only be overloaded with respect to a single
6121    argument or the result.</p>
6122
6123 <p>Overloaded intrinsics will have the names of its overloaded argument types
6124    encoded into its function name, each preceded by a period. Only those types
6125    which are overloaded result in a name suffix. Arguments whose type is matched
6126    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6127    can take an integer of any width and returns an integer of exactly the same
6128    integer width. This leads to a family of functions such as
6129    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6130    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6131    suffix is required. Because the argument's type is matched against the return
6132    type, it does not require its own name suffix.</p>
6133
6134 <p>To learn how to add an intrinsic function, please see the
6135    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6136
6137 <!-- ======================================================================= -->
6138 <h3>
6139   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6140 </h3>
6141
6142 <div>
6143
6144 <p>Variable argument support is defined in LLVM with
6145    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6146    intrinsic functions.  These functions are related to the similarly named
6147    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6148
6149 <p>All of these functions operate on arguments that use a target-specific value
6150    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6151    not define what this type is, so all transformations should be prepared to
6152    handle these functions regardless of the type used.</p>
6153
6154 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6155    instruction and the variable argument handling intrinsic functions are
6156    used.</p>
6157
6158 <pre class="doc_code">
6159 define i32 @test(i32 %X, ...) {
6160   ; Initialize variable argument processing
6161   %ap = alloca i8*
6162   %ap2 = bitcast i8** %ap to i8*
6163   call void @llvm.va_start(i8* %ap2)
6164
6165   ; Read a single integer argument
6166   %tmp = va_arg i8** %ap, i32
6167
6168   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6169   %aq = alloca i8*
6170   %aq2 = bitcast i8** %aq to i8*
6171   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6172   call void @llvm.va_end(i8* %aq2)
6173
6174   ; Stop processing of arguments.
6175   call void @llvm.va_end(i8* %ap2)
6176   ret i32 %tmp
6177 }
6178
6179 declare void @llvm.va_start(i8*)
6180 declare void @llvm.va_copy(i8*, i8*)
6181 declare void @llvm.va_end(i8*)
6182 </pre>
6183
6184 <!-- _______________________________________________________________________ -->
6185 <h4>
6186   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6187 </h4>
6188
6189
6190 <div>
6191
6192 <h5>Syntax:</h5>
6193 <pre>
6194   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6195 </pre>
6196
6197 <h5>Overview:</h5>
6198 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6199    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6200
6201 <h5>Arguments:</h5>
6202 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6203
6204 <h5>Semantics:</h5>
6205 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6206    macro available in C.  In a target-dependent way, it initializes
6207    the <tt>va_list</tt> element to which the argument points, so that the next
6208    call to <tt>va_arg</tt> will produce the first variable argument passed to
6209    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6210    need to know the last argument of the function as the compiler can figure
6211    that out.</p>
6212
6213 </div>
6214
6215 <!-- _______________________________________________________________________ -->
6216 <h4>
6217  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6218 </h4>
6219
6220 <div>
6221
6222 <h5>Syntax:</h5>
6223 <pre>
6224   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6225 </pre>
6226
6227 <h5>Overview:</h5>
6228 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6229    which has been initialized previously
6230    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6231    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6232
6233 <h5>Arguments:</h5>
6234 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6235
6236 <h5>Semantics:</h5>
6237 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6238    macro available in C.  In a target-dependent way, it destroys
6239    the <tt>va_list</tt> element to which the argument points.  Calls
6240    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6241    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6242    with calls to <tt>llvm.va_end</tt>.</p>
6243
6244 </div>
6245
6246 <!-- _______________________________________________________________________ -->
6247 <h4>
6248   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6249 </h4>
6250
6251 <div>
6252
6253 <h5>Syntax:</h5>
6254 <pre>
6255   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6256 </pre>
6257
6258 <h5>Overview:</h5>
6259 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6260    from the source argument list to the destination argument list.</p>
6261
6262 <h5>Arguments:</h5>
6263 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6264    The second argument is a pointer to a <tt>va_list</tt> element to copy
6265    from.</p>
6266
6267 <h5>Semantics:</h5>
6268 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6269    macro available in C.  In a target-dependent way, it copies the
6270    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6271    element.  This intrinsic is necessary because
6272    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6273    arbitrarily complex and require, for example, memory allocation.</p>
6274
6275 </div>
6276
6277 </div>
6278
6279 </div>
6280
6281 <!-- ======================================================================= -->
6282 <h3>
6283   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6284 </h3>
6285
6286 <div>
6287
6288 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6289 Collection</a> (GC) requires the implementation and generation of these
6290 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6291 roots on the stack</a>, as well as garbage collector implementations that
6292 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6293 barriers.  Front-ends for type-safe garbage collected languages should generate
6294 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6295 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6296 LLVM</a>.</p>
6297
6298 <p>The garbage collection intrinsics only operate on objects in the generic
6299    address space (address space zero).</p>
6300
6301 <!-- _______________________________________________________________________ -->
6302 <h4>
6303   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6304 </h4>
6305
6306 <div>
6307
6308 <h5>Syntax:</h5>
6309 <pre>
6310   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6311 </pre>
6312
6313 <h5>Overview:</h5>
6314 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6315    the code generator, and allows some metadata to be associated with it.</p>
6316
6317 <h5>Arguments:</h5>
6318 <p>The first argument specifies the address of a stack object that contains the
6319    root pointer.  The second pointer (which must be either a constant or a
6320    global value address) contains the meta-data to be associated with the
6321    root.</p>
6322
6323 <h5>Semantics:</h5>
6324 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6325    location.  At compile-time, the code generator generates information to allow
6326    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6327    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6328    algorithm</a>.</p>
6329
6330 </div>
6331
6332 <!-- _______________________________________________________________________ -->
6333 <h4>
6334   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6335 </h4>
6336
6337 <div>
6338
6339 <h5>Syntax:</h5>
6340 <pre>
6341   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6342 </pre>
6343
6344 <h5>Overview:</h5>
6345 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6346    locations, allowing garbage collector implementations that require read
6347    barriers.</p>
6348
6349 <h5>Arguments:</h5>
6350 <p>The second argument is the address to read from, which should be an address
6351    allocated from the garbage collector.  The first object is a pointer to the
6352    start of the referenced object, if needed by the language runtime (otherwise
6353    null).</p>
6354
6355 <h5>Semantics:</h5>
6356 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6357    instruction, but may be replaced with substantially more complex code by the
6358    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6359    may only be used in a function which <a href="#gc">specifies a GC
6360    algorithm</a>.</p>
6361
6362 </div>
6363
6364 <!-- _______________________________________________________________________ -->
6365 <h4>
6366   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6367 </h4>
6368
6369 <div>
6370
6371 <h5>Syntax:</h5>
6372 <pre>
6373   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6374 </pre>
6375
6376 <h5>Overview:</h5>
6377 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6378    locations, allowing garbage collector implementations that require write
6379    barriers (such as generational or reference counting collectors).</p>
6380
6381 <h5>Arguments:</h5>
6382 <p>The first argument is the reference to store, the second is the start of the
6383    object to store it to, and the third is the address of the field of Obj to
6384    store to.  If the runtime does not require a pointer to the object, Obj may
6385    be null.</p>
6386
6387 <h5>Semantics:</h5>
6388 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6389    instruction, but may be replaced with substantially more complex code by the
6390    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6391    may only be used in a function which <a href="#gc">specifies a GC
6392    algorithm</a>.</p>
6393
6394 </div>
6395
6396 </div>
6397
6398 <!-- ======================================================================= -->
6399 <h3>
6400   <a name="int_codegen">Code Generator Intrinsics</a>
6401 </h3>
6402
6403 <div>
6404
6405 <p>These intrinsics are provided by LLVM to expose special features that may
6406    only be implemented with code generator support.</p>
6407
6408 <!-- _______________________________________________________________________ -->
6409 <h4>
6410   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6411 </h4>
6412
6413 <div>
6414
6415 <h5>Syntax:</h5>
6416 <pre>
6417   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6418 </pre>
6419
6420 <h5>Overview:</h5>
6421 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6422    target-specific value indicating the return address of the current function
6423    or one of its callers.</p>
6424
6425 <h5>Arguments:</h5>
6426 <p>The argument to this intrinsic indicates which function to return the address
6427    for.  Zero indicates the calling function, one indicates its caller, etc.
6428    The argument is <b>required</b> to be a constant integer value.</p>
6429
6430 <h5>Semantics:</h5>
6431 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6432    indicating the return address of the specified call frame, or zero if it
6433    cannot be identified.  The value returned by this intrinsic is likely to be
6434    incorrect or 0 for arguments other than zero, so it should only be used for
6435    debugging purposes.</p>
6436
6437 <p>Note that calling this intrinsic does not prevent function inlining or other
6438    aggressive transformations, so the value returned may not be that of the
6439    obvious source-language caller.</p>
6440
6441 </div>
6442
6443 <!-- _______________________________________________________________________ -->
6444 <h4>
6445   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6446 </h4>
6447
6448 <div>
6449
6450 <h5>Syntax:</h5>
6451 <pre>
6452   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6453 </pre>
6454
6455 <h5>Overview:</h5>
6456 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6457    target-specific frame pointer value for the specified stack frame.</p>
6458
6459 <h5>Arguments:</h5>
6460 <p>The argument to this intrinsic indicates which function to return the frame
6461    pointer for.  Zero indicates the calling function, one indicates its caller,
6462    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6463
6464 <h5>Semantics:</h5>
6465 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6466    indicating the frame address of the specified call frame, or zero if it
6467    cannot be identified.  The value returned by this intrinsic is likely to be
6468    incorrect or 0 for arguments other than zero, so it should only be used for
6469    debugging purposes.</p>
6470
6471 <p>Note that calling this intrinsic does not prevent function inlining or other
6472    aggressive transformations, so the value returned may not be that of the
6473    obvious source-language caller.</p>
6474
6475 </div>
6476
6477 <!-- _______________________________________________________________________ -->
6478 <h4>
6479   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6480 </h4>
6481
6482 <div>
6483
6484 <h5>Syntax:</h5>
6485 <pre>
6486   declare i8* @llvm.stacksave()
6487 </pre>
6488
6489 <h5>Overview:</h5>
6490 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6491    of the function stack, for use
6492    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6493    useful for implementing language features like scoped automatic variable
6494    sized arrays in C99.</p>
6495
6496 <h5>Semantics:</h5>
6497 <p>This intrinsic returns a opaque pointer value that can be passed
6498    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6499    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6500    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6501    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6502    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6503    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6504
6505 </div>
6506
6507 <!-- _______________________________________________________________________ -->
6508 <h4>
6509   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6510 </h4>
6511
6512 <div>
6513
6514 <h5>Syntax:</h5>
6515 <pre>
6516   declare void @llvm.stackrestore(i8* %ptr)
6517 </pre>
6518
6519 <h5>Overview:</h5>
6520 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6521    the function stack to the state it was in when the
6522    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6523    executed.  This is useful for implementing language features like scoped
6524    automatic variable sized arrays in C99.</p>
6525
6526 <h5>Semantics:</h5>
6527 <p>See the description
6528    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6529
6530 </div>
6531
6532 <!-- _______________________________________________________________________ -->
6533 <h4>
6534   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6535 </h4>
6536
6537 <div>
6538
6539 <h5>Syntax:</h5>
6540 <pre>
6541   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6542 </pre>
6543
6544 <h5>Overview:</h5>
6545 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6546    insert a prefetch instruction if supported; otherwise, it is a noop.
6547    Prefetches have no effect on the behavior of the program but can change its
6548    performance characteristics.</p>
6549
6550 <h5>Arguments:</h5>
6551 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6552    specifier determining if the fetch should be for a read (0) or write (1),
6553    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6554    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6555    specifies whether the prefetch is performed on the data (1) or instruction (0)
6556    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6557    must be constant integers.</p>
6558
6559 <h5>Semantics:</h5>
6560 <p>This intrinsic does not modify the behavior of the program.  In particular,
6561    prefetches cannot trap and do not produce a value.  On targets that support
6562    this intrinsic, the prefetch can provide hints to the processor cache for
6563    better performance.</p>
6564
6565 </div>
6566
6567 <!-- _______________________________________________________________________ -->
6568 <h4>
6569   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6570 </h4>
6571
6572 <div>
6573
6574 <h5>Syntax:</h5>
6575 <pre>
6576   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6577 </pre>
6578
6579 <h5>Overview:</h5>
6580 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6581    Counter (PC) in a region of code to simulators and other tools.  The method
6582    is target specific, but it is expected that the marker will use exported
6583    symbols to transmit the PC of the marker.  The marker makes no guarantees
6584    that it will remain with any specific instruction after optimizations.  It is
6585    possible that the presence of a marker will inhibit optimizations.  The
6586    intended use is to be inserted after optimizations to allow correlations of
6587    simulation runs.</p>
6588
6589 <h5>Arguments:</h5>
6590 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6591
6592 <h5>Semantics:</h5>
6593 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6594    not support this intrinsic may ignore it.</p>
6595
6596 </div>
6597
6598 <!-- _______________________________________________________________________ -->
6599 <h4>
6600   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6601 </h4>
6602
6603 <div>
6604
6605 <h5>Syntax:</h5>
6606 <pre>
6607   declare i64 @llvm.readcyclecounter()
6608 </pre>
6609
6610 <h5>Overview:</h5>
6611 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6612    counter register (or similar low latency, high accuracy clocks) on those
6613    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6614    should map to RPCC.  As the backing counters overflow quickly (on the order
6615    of 9 seconds on alpha), this should only be used for small timings.</p>
6616
6617 <h5>Semantics:</h5>
6618 <p>When directly supported, reading the cycle counter should not modify any
6619    memory.  Implementations are allowed to either return a application specific
6620    value or a system wide value.  On backends without support, this is lowered
6621    to a constant 0.</p>
6622
6623 </div>
6624
6625 </div>
6626
6627 <!-- ======================================================================= -->
6628 <h3>
6629   <a name="int_libc">Standard C Library Intrinsics</a>
6630 </h3>
6631
6632 <div>
6633
6634 <p>LLVM provides intrinsics for a few important standard C library functions.
6635    These intrinsics allow source-language front-ends to pass information about
6636    the alignment of the pointer arguments to the code generator, providing
6637    opportunity for more efficient code generation.</p>
6638
6639 <!-- _______________________________________________________________________ -->
6640 <h4>
6641   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6642 </h4>
6643
6644 <div>
6645
6646 <h5>Syntax:</h5>
6647 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6648    integer bit width and for different address spaces. Not all targets support
6649    all bit widths however.</p>
6650
6651 <pre>
6652   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6653                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6654   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6655                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6656 </pre>
6657
6658 <h5>Overview:</h5>
6659 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6660    source location to the destination location.</p>
6661
6662 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6663    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6664    and the pointers can be in specified address spaces.</p>
6665
6666 <h5>Arguments:</h5>
6667
6668 <p>The first argument is a pointer to the destination, the second is a pointer
6669    to the source.  The third argument is an integer argument specifying the
6670    number of bytes to copy, the fourth argument is the alignment of the
6671    source and destination locations, and the fifth is a boolean indicating a
6672    volatile access.</p>
6673
6674 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6675    then the caller guarantees that both the source and destination pointers are
6676    aligned to that boundary.</p>
6677
6678 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6679    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6680    The detailed access behavior is not very cleanly specified and it is unwise
6681    to depend on it.</p>
6682
6683 <h5>Semantics:</h5>
6684
6685 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6686    source location to the destination location, which are not allowed to
6687    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6688    be aligned to some boundary, this can be specified as the fourth argument,
6689    otherwise it should be set to 0 or 1.</p>
6690
6691 </div>
6692
6693 <!-- _______________________________________________________________________ -->
6694 <h4>
6695   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6696 </h4>
6697
6698 <div>
6699
6700 <h5>Syntax:</h5>
6701 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6702    width and for different address space. Not all targets support all bit
6703    widths however.</p>
6704
6705 <pre>
6706   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6707                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6708   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6709                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6710 </pre>
6711
6712 <h5>Overview:</h5>
6713 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6714    source location to the destination location. It is similar to the
6715    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6716    overlap.</p>
6717
6718 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6719    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6720    and the pointers can be in specified address spaces.</p>
6721
6722 <h5>Arguments:</h5>
6723
6724 <p>The first argument is a pointer to the destination, the second is a pointer
6725    to the source.  The third argument is an integer argument specifying the
6726    number of bytes to copy, the fourth argument is the alignment of the
6727    source and destination locations, and the fifth is a boolean indicating a
6728    volatile access.</p>
6729
6730 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6731    then the caller guarantees that the source and destination pointers are
6732    aligned to that boundary.</p>
6733
6734 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6735    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6736    The detailed access behavior is not very cleanly specified and it is unwise
6737    to depend on it.</p>
6738
6739 <h5>Semantics:</h5>
6740
6741 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6742    source location to the destination location, which may overlap.  It copies
6743    "len" bytes of memory over.  If the argument is known to be aligned to some
6744    boundary, this can be specified as the fourth argument, otherwise it should
6745    be set to 0 or 1.</p>
6746
6747 </div>
6748
6749 <!-- _______________________________________________________________________ -->
6750 <h4>
6751   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6752 </h4>
6753
6754 <div>
6755
6756 <h5>Syntax:</h5>
6757 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6758    width and for different address spaces. However, not all targets support all
6759    bit widths.</p>
6760
6761 <pre>
6762   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6763                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6764   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6765                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6766 </pre>
6767
6768 <h5>Overview:</h5>
6769 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6770    particular byte value.</p>
6771
6772 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6773    intrinsic does not return a value and takes extra alignment/volatile
6774    arguments.  Also, the destination can be in an arbitrary address space.</p>
6775
6776 <h5>Arguments:</h5>
6777 <p>The first argument is a pointer to the destination to fill, the second is the
6778    byte value with which to fill it, the third argument is an integer argument
6779    specifying the number of bytes to fill, and the fourth argument is the known
6780    alignment of the destination location.</p>
6781
6782 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6783    then the caller guarantees that the destination pointer is aligned to that
6784    boundary.</p>
6785
6786 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6787    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6788    The detailed access behavior is not very cleanly specified and it is unwise
6789    to depend on it.</p>
6790
6791 <h5>Semantics:</h5>
6792 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6793    at the destination location.  If the argument is known to be aligned to some
6794    boundary, this can be specified as the fourth argument, otherwise it should
6795    be set to 0 or 1.</p>
6796
6797 </div>
6798
6799 <!-- _______________________________________________________________________ -->
6800 <h4>
6801   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6802 </h4>
6803
6804 <div>
6805
6806 <h5>Syntax:</h5>
6807 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6808    floating point or vector of floating point type. Not all targets support all
6809    types however.</p>
6810
6811 <pre>
6812   declare float     @llvm.sqrt.f32(float %Val)
6813   declare double    @llvm.sqrt.f64(double %Val)
6814   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6815   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6816   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6817 </pre>
6818
6819 <h5>Overview:</h5>
6820 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6821    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6822    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6823    behavior for negative numbers other than -0.0 (which allows for better
6824    optimization, because there is no need to worry about errno being
6825    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6826
6827 <h5>Arguments:</h5>
6828 <p>The argument and return value are floating point numbers of the same
6829    type.</p>
6830
6831 <h5>Semantics:</h5>
6832 <p>This function returns the sqrt of the specified operand if it is a
6833    nonnegative floating point number.</p>
6834
6835 </div>
6836
6837 <!-- _______________________________________________________________________ -->
6838 <h4>
6839   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6840 </h4>
6841
6842 <div>
6843
6844 <h5>Syntax:</h5>
6845 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6846    floating point or vector of floating point type. Not all targets support all
6847    types however.</p>
6848
6849 <pre>
6850   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6851   declare double    @llvm.powi.f64(double %Val, i32 %power)
6852   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6853   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6854   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6855 </pre>
6856
6857 <h5>Overview:</h5>
6858 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6859    specified (positive or negative) power.  The order of evaluation of
6860    multiplications is not defined.  When a vector of floating point type is
6861    used, the second argument remains a scalar integer value.</p>
6862
6863 <h5>Arguments:</h5>
6864 <p>The second argument is an integer power, and the first is a value to raise to
6865    that power.</p>
6866
6867 <h5>Semantics:</h5>
6868 <p>This function returns the first value raised to the second power with an
6869    unspecified sequence of rounding operations.</p>
6870
6871 </div>
6872
6873 <!-- _______________________________________________________________________ -->
6874 <h4>
6875   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6876 </h4>
6877
6878 <div>
6879
6880 <h5>Syntax:</h5>
6881 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6882    floating point or vector of floating point type. Not all targets support all
6883    types however.</p>
6884
6885 <pre>
6886   declare float     @llvm.sin.f32(float  %Val)
6887   declare double    @llvm.sin.f64(double %Val)
6888   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6889   declare fp128     @llvm.sin.f128(fp128 %Val)
6890   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6891 </pre>
6892
6893 <h5>Overview:</h5>
6894 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6895
6896 <h5>Arguments:</h5>
6897 <p>The argument and return value are floating point numbers of the same
6898    type.</p>
6899
6900 <h5>Semantics:</h5>
6901 <p>This function returns the sine of the specified operand, returning the same
6902    values as the libm <tt>sin</tt> functions would, and handles error conditions
6903    in the same way.</p>
6904
6905 </div>
6906
6907 <!-- _______________________________________________________________________ -->
6908 <h4>
6909   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6910 </h4>
6911
6912 <div>
6913
6914 <h5>Syntax:</h5>
6915 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6916    floating point or vector of floating point type. Not all targets support all
6917    types however.</p>
6918
6919 <pre>
6920   declare float     @llvm.cos.f32(float  %Val)
6921   declare double    @llvm.cos.f64(double %Val)
6922   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6923   declare fp128     @llvm.cos.f128(fp128 %Val)
6924   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6925 </pre>
6926
6927 <h5>Overview:</h5>
6928 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6929
6930 <h5>Arguments:</h5>
6931 <p>The argument and return value are floating point numbers of the same
6932    type.</p>
6933
6934 <h5>Semantics:</h5>
6935 <p>This function returns the cosine of the specified operand, returning the same
6936    values as the libm <tt>cos</tt> functions would, and handles error conditions
6937    in the same way.</p>
6938
6939 </div>
6940
6941 <!-- _______________________________________________________________________ -->
6942 <h4>
6943   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6944 </h4>
6945
6946 <div>
6947
6948 <h5>Syntax:</h5>
6949 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6950    floating point or vector of floating point type. Not all targets support all
6951    types however.</p>
6952
6953 <pre>
6954   declare float     @llvm.pow.f32(float  %Val, float %Power)
6955   declare double    @llvm.pow.f64(double %Val, double %Power)
6956   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6957   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6958   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6959 </pre>
6960
6961 <h5>Overview:</h5>
6962 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6963    specified (positive or negative) power.</p>
6964
6965 <h5>Arguments:</h5>
6966 <p>The second argument is a floating point power, and the first is a value to
6967    raise to that power.</p>
6968
6969 <h5>Semantics:</h5>
6970 <p>This function returns the first value raised to the second power, returning
6971    the same values as the libm <tt>pow</tt> functions would, and handles error
6972    conditions in the same way.</p>
6973
6974 </div>
6975
6976 </div>
6977
6978 <!-- _______________________________________________________________________ -->
6979 <h4>
6980   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
6981 </h4>
6982
6983 <div>
6984
6985 <h5>Syntax:</h5>
6986 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
6987    floating point or vector of floating point type. Not all targets support all
6988    types however.</p>
6989
6990 <pre>
6991   declare float     @llvm.exp.f32(float  %Val)
6992   declare double    @llvm.exp.f64(double %Val)
6993   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
6994   declare fp128     @llvm.exp.f128(fp128 %Val)
6995   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
6996 </pre>
6997
6998 <h5>Overview:</h5>
6999 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7000
7001 <h5>Arguments:</h5>
7002 <p>The argument and return value are floating point numbers of the same
7003    type.</p>
7004
7005 <h5>Semantics:</h5>
7006 <p>This function returns the same values as the libm <tt>exp</tt> functions
7007    would, and handles error conditions in the same way.</p>
7008
7009 </div>
7010
7011 <!-- _______________________________________________________________________ -->
7012 <h4>
7013   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7014 </h4>
7015
7016 <div>
7017
7018 <h5>Syntax:</h5>
7019 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7020    floating point or vector of floating point type. Not all targets support all
7021    types however.</p>
7022
7023 <pre>
7024   declare float     @llvm.log.f32(float  %Val)
7025   declare double    @llvm.log.f64(double %Val)
7026   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7027   declare fp128     @llvm.log.f128(fp128 %Val)
7028   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7029 </pre>
7030
7031 <h5>Overview:</h5>
7032 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7033
7034 <h5>Arguments:</h5>
7035 <p>The argument and return value are floating point numbers of the same
7036    type.</p>
7037
7038 <h5>Semantics:</h5>
7039 <p>This function returns the same values as the libm <tt>log</tt> functions
7040    would, and handles error conditions in the same way.</p>
7041
7042 <h4>
7043   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7044 </h4>
7045
7046 <div>
7047
7048 <h5>Syntax:</h5>
7049 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7050    floating point or vector of floating point type. Not all targets support all
7051    types however.</p>
7052
7053 <pre>
7054   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7055   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7056   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7057   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7058   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7059 </pre>
7060
7061 <h5>Overview:</h5>
7062 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7063    operation.</p>
7064
7065 <h5>Arguments:</h5>
7066 <p>The argument and return value are floating point numbers of the same
7067    type.</p>
7068
7069 <h5>Semantics:</h5>
7070 <p>This function returns the same values as the libm <tt>fma</tt> functions
7071    would.</p>
7072
7073 </div>
7074
7075 <!-- ======================================================================= -->
7076 <h3>
7077   <a name="int_manip">Bit Manipulation Intrinsics</a>
7078 </h3>
7079
7080 <div>
7081
7082 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7083    These allow efficient code generation for some algorithms.</p>
7084
7085 <!-- _______________________________________________________________________ -->
7086 <h4>
7087   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7088 </h4>
7089
7090 <div>
7091
7092 <h5>Syntax:</h5>
7093 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7094    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7095
7096 <pre>
7097   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7098   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7099   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7100 </pre>
7101
7102 <h5>Overview:</h5>
7103 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7104    values with an even number of bytes (positive multiple of 16 bits).  These
7105    are useful for performing operations on data that is not in the target's
7106    native byte order.</p>
7107
7108 <h5>Semantics:</h5>
7109 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7110    and low byte of the input i16 swapped.  Similarly,
7111    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7112    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7113    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7114    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7115    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7116    more, respectively).</p>
7117
7118 </div>
7119
7120 <!-- _______________________________________________________________________ -->
7121 <h4>
7122   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7123 </h4>
7124
7125 <div>
7126
7127 <h5>Syntax:</h5>
7128 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7129    width, or on any vector with integer elements. Not all targets support all
7130   bit widths or vector types, however.</p>
7131
7132 <pre>
7133   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7134   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7135   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7136   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7137   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7138   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7139 </pre>
7140
7141 <h5>Overview:</h5>
7142 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7143    in a value.</p>
7144
7145 <h5>Arguments:</h5>
7146 <p>The only argument is the value to be counted.  The argument may be of any
7147    integer type, or a vector with integer elements.
7148    The return type must match the argument type.</p>
7149
7150 <h5>Semantics:</h5>
7151 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7152    element of a vector.</p>
7153
7154 </div>
7155
7156 <!-- _______________________________________________________________________ -->
7157 <h4>
7158   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7159 </h4>
7160
7161 <div>
7162
7163 <h5>Syntax:</h5>
7164 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7165    integer bit width, or any vector whose elements are integers. Not all
7166    targets support all bit widths or vector types, however.</p>
7167
7168 <pre>
7169   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
7170   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
7171   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
7172   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
7173   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
7174   declare &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src;gt)
7175 </pre>
7176
7177 <h5>Overview:</h5>
7178 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7179    leading zeros in a variable.</p>
7180
7181 <h5>Arguments:</h5>
7182 <p>The only argument is the value to be counted.  The argument may be of any
7183    integer type, or any vector type with integer element type.
7184    The return type must match the argument type.</p>
7185
7186 <h5>Semantics:</h5>
7187 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7188    zeros in a variable, or within each element of the vector if the operation
7189    is of vector type.  If the src == 0 then the result is the size in bits of
7190    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7191
7192 </div>
7193
7194 <!-- _______________________________________________________________________ -->
7195 <h4>
7196   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7197 </h4>
7198
7199 <div>
7200
7201 <h5>Syntax:</h5>
7202 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7203    integer bit width, or any vector of integer elements. Not all targets
7204    support all bit widths or vector types, however.</p>
7205
7206 <pre>
7207   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
7208   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
7209   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
7210   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
7211   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
7212   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7213 </pre>
7214
7215 <h5>Overview:</h5>
7216 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7217    trailing zeros.</p>
7218
7219 <h5>Arguments:</h5>
7220 <p>The only argument is the value to be counted.  The argument may be of any
7221    integer type, or a vectory with integer element type..  The return type
7222    must match the argument type.</p>
7223
7224 <h5>Semantics:</h5>
7225 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7226    zeros in a variable, or within each element of a vector.
7227    If the src == 0 then the result is the size in bits of
7228    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7229
7230 </div>
7231
7232 </div>
7233
7234 <!-- ======================================================================= -->
7235 <h3>
7236   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7237 </h3>
7238
7239 <div>
7240
7241 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7242
7243 <!-- _______________________________________________________________________ -->
7244 <h4>
7245   <a name="int_sadd_overflow">
7246     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7247   </a>
7248 </h4>
7249
7250 <div>
7251
7252 <h5>Syntax:</h5>
7253 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7254    on any integer bit width.</p>
7255
7256 <pre>
7257   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7258   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7259   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7260 </pre>
7261
7262 <h5>Overview:</h5>
7263 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7264    a signed addition of the two arguments, and indicate whether an overflow
7265    occurred during the signed summation.</p>
7266
7267 <h5>Arguments:</h5>
7268 <p>The arguments (%a and %b) and the first element of the result structure may
7269    be of integer types of any bit width, but they must have the same bit
7270    width. The second element of the result structure must be of
7271    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7272    undergo signed addition.</p>
7273
7274 <h5>Semantics:</h5>
7275 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7276    a signed addition of the two variables. They return a structure &mdash; the
7277    first element of which is the signed summation, and the second element of
7278    which is a bit specifying if the signed summation resulted in an
7279    overflow.</p>
7280
7281 <h5>Examples:</h5>
7282 <pre>
7283   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7284   %sum = extractvalue {i32, i1} %res, 0
7285   %obit = extractvalue {i32, i1} %res, 1
7286   br i1 %obit, label %overflow, label %normal
7287 </pre>
7288
7289 </div>
7290
7291 <!-- _______________________________________________________________________ -->
7292 <h4>
7293   <a name="int_uadd_overflow">
7294     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7295   </a>
7296 </h4>
7297
7298 <div>
7299
7300 <h5>Syntax:</h5>
7301 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7302    on any integer bit width.</p>
7303
7304 <pre>
7305   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7306   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7307   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7308 </pre>
7309
7310 <h5>Overview:</h5>
7311 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7312    an unsigned addition of the two arguments, and indicate whether a carry
7313    occurred during the unsigned summation.</p>
7314
7315 <h5>Arguments:</h5>
7316 <p>The arguments (%a and %b) and the first element of the result structure may
7317    be of integer types of any bit width, but they must have the same bit
7318    width. The second element of the result structure must be of
7319    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7320    undergo unsigned addition.</p>
7321
7322 <h5>Semantics:</h5>
7323 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7324    an unsigned addition of the two arguments. They return a structure &mdash;
7325    the first element of which is the sum, and the second element of which is a
7326    bit specifying if the unsigned summation resulted in a carry.</p>
7327
7328 <h5>Examples:</h5>
7329 <pre>
7330   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7331   %sum = extractvalue {i32, i1} %res, 0
7332   %obit = extractvalue {i32, i1} %res, 1
7333   br i1 %obit, label %carry, label %normal
7334 </pre>
7335
7336 </div>
7337
7338 <!-- _______________________________________________________________________ -->
7339 <h4>
7340   <a name="int_ssub_overflow">
7341     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7342   </a>
7343 </h4>
7344
7345 <div>
7346
7347 <h5>Syntax:</h5>
7348 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7349    on any integer bit width.</p>
7350
7351 <pre>
7352   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7353   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7354   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7355 </pre>
7356
7357 <h5>Overview:</h5>
7358 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7359    a signed subtraction of the two arguments, and indicate whether an overflow
7360    occurred during the signed subtraction.</p>
7361
7362 <h5>Arguments:</h5>
7363 <p>The arguments (%a and %b) and the first element of the result structure may
7364    be of integer types of any bit width, but they must have the same bit
7365    width. The second element of the result structure must be of
7366    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7367    undergo signed subtraction.</p>
7368
7369 <h5>Semantics:</h5>
7370 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7371    a signed subtraction of the two arguments. They return a structure &mdash;
7372    the first element of which is the subtraction, and the second element of
7373    which is a bit specifying if the signed subtraction resulted in an
7374    overflow.</p>
7375
7376 <h5>Examples:</h5>
7377 <pre>
7378   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7379   %sum = extractvalue {i32, i1} %res, 0
7380   %obit = extractvalue {i32, i1} %res, 1
7381   br i1 %obit, label %overflow, label %normal
7382 </pre>
7383
7384 </div>
7385
7386 <!-- _______________________________________________________________________ -->
7387 <h4>
7388   <a name="int_usub_overflow">
7389     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7390   </a>
7391 </h4>
7392
7393 <div>
7394
7395 <h5>Syntax:</h5>
7396 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7397    on any integer bit width.</p>
7398
7399 <pre>
7400   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7401   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7402   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7403 </pre>
7404
7405 <h5>Overview:</h5>
7406 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7407    an unsigned subtraction of the two arguments, and indicate whether an
7408    overflow occurred during the unsigned subtraction.</p>
7409
7410 <h5>Arguments:</h5>
7411 <p>The arguments (%a and %b) and the first element of the result structure may
7412    be of integer types of any bit width, but they must have the same bit
7413    width. The second element of the result structure must be of
7414    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7415    undergo unsigned subtraction.</p>
7416
7417 <h5>Semantics:</h5>
7418 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7419    an unsigned subtraction of the two arguments. They return a structure &mdash;
7420    the first element of which is the subtraction, and the second element of
7421    which is a bit specifying if the unsigned subtraction resulted in an
7422    overflow.</p>
7423
7424 <h5>Examples:</h5>
7425 <pre>
7426   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7427   %sum = extractvalue {i32, i1} %res, 0
7428   %obit = extractvalue {i32, i1} %res, 1
7429   br i1 %obit, label %overflow, label %normal
7430 </pre>
7431
7432 </div>
7433
7434 <!-- _______________________________________________________________________ -->
7435 <h4>
7436   <a name="int_smul_overflow">
7437     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7438   </a>
7439 </h4>
7440
7441 <div>
7442
7443 <h5>Syntax:</h5>
7444 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7445    on any integer bit width.</p>
7446
7447 <pre>
7448   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7449   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7450   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7451 </pre>
7452
7453 <h5>Overview:</h5>
7454
7455 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7456    a signed multiplication of the two arguments, and indicate whether an
7457    overflow occurred during the signed multiplication.</p>
7458
7459 <h5>Arguments:</h5>
7460 <p>The arguments (%a and %b) and the first element of the result structure may
7461    be of integer types of any bit width, but they must have the same bit
7462    width. The second element of the result structure must be of
7463    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7464    undergo signed multiplication.</p>
7465
7466 <h5>Semantics:</h5>
7467 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7468    a signed multiplication of the two arguments. They return a structure &mdash;
7469    the first element of which is the multiplication, and the second element of
7470    which is a bit specifying if the signed multiplication resulted in an
7471    overflow.</p>
7472
7473 <h5>Examples:</h5>
7474 <pre>
7475   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7476   %sum = extractvalue {i32, i1} %res, 0
7477   %obit = extractvalue {i32, i1} %res, 1
7478   br i1 %obit, label %overflow, label %normal
7479 </pre>
7480
7481 </div>
7482
7483 <!-- _______________________________________________________________________ -->
7484 <h4>
7485   <a name="int_umul_overflow">
7486     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7487   </a>
7488 </h4>
7489
7490 <div>
7491
7492 <h5>Syntax:</h5>
7493 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7494    on any integer bit width.</p>
7495
7496 <pre>
7497   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7498   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7499   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7500 </pre>
7501
7502 <h5>Overview:</h5>
7503 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7504    a unsigned multiplication of the two arguments, and indicate whether an
7505    overflow occurred during the unsigned multiplication.</p>
7506
7507 <h5>Arguments:</h5>
7508 <p>The arguments (%a and %b) and the first element of the result structure may
7509    be of integer types of any bit width, but they must have the same bit
7510    width. The second element of the result structure must be of
7511    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7512    undergo unsigned multiplication.</p>
7513
7514 <h5>Semantics:</h5>
7515 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7516    an unsigned multiplication of the two arguments. They return a structure
7517    &mdash; the first element of which is the multiplication, and the second
7518    element of which is a bit specifying if the unsigned multiplication resulted
7519    in an overflow.</p>
7520
7521 <h5>Examples:</h5>
7522 <pre>
7523   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7524   %sum = extractvalue {i32, i1} %res, 0
7525   %obit = extractvalue {i32, i1} %res, 1
7526   br i1 %obit, label %overflow, label %normal
7527 </pre>
7528
7529 </div>
7530
7531 </div>
7532
7533 <!-- ======================================================================= -->
7534 <h3>
7535   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7536 </h3>
7537
7538 <div>
7539
7540 <p>Half precision floating point is a storage-only format. This means that it is
7541    a dense encoding (in memory) but does not support computation in the
7542    format.</p>
7543
7544 <p>This means that code must first load the half-precision floating point
7545    value as an i16, then convert it to float with <a
7546    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7547    Computation can then be performed on the float value (including extending to
7548    double etc).  To store the value back to memory, it is first converted to
7549    float if needed, then converted to i16 with
7550    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7551    storing as an i16 value.</p>
7552
7553 <!-- _______________________________________________________________________ -->
7554 <h4>
7555   <a name="int_convert_to_fp16">
7556     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7557   </a>
7558 </h4>
7559
7560 <div>
7561
7562 <h5>Syntax:</h5>
7563 <pre>
7564   declare i16 @llvm.convert.to.fp16(f32 %a)
7565 </pre>
7566
7567 <h5>Overview:</h5>
7568 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7569    a conversion from single precision floating point format to half precision
7570    floating point format.</p>
7571
7572 <h5>Arguments:</h5>
7573 <p>The intrinsic function contains single argument - the value to be
7574    converted.</p>
7575
7576 <h5>Semantics:</h5>
7577 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7578    a conversion from single precision floating point format to half precision
7579    floating point format. The return value is an <tt>i16</tt> which
7580    contains the converted number.</p>
7581
7582 <h5>Examples:</h5>
7583 <pre>
7584   %res = call i16 @llvm.convert.to.fp16(f32 %a)
7585   store i16 %res, i16* @x, align 2
7586 </pre>
7587
7588 </div>
7589
7590 <!-- _______________________________________________________________________ -->
7591 <h4>
7592   <a name="int_convert_from_fp16">
7593     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
7594   </a>
7595 </h4>
7596
7597 <div>
7598
7599 <h5>Syntax:</h5>
7600 <pre>
7601   declare f32 @llvm.convert.from.fp16(i16 %a)
7602 </pre>
7603
7604 <h5>Overview:</h5>
7605 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
7606    a conversion from half precision floating point format to single precision
7607    floating point format.</p>
7608
7609 <h5>Arguments:</h5>
7610 <p>The intrinsic function contains single argument - the value to be
7611    converted.</p>
7612
7613 <h5>Semantics:</h5>
7614 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
7615    conversion from half single precision floating point format to single
7616    precision floating point format. The input half-float value is represented by
7617    an <tt>i16</tt> value.</p>
7618
7619 <h5>Examples:</h5>
7620 <pre>
7621   %a = load i16* @x, align 2
7622   %res = call f32 @llvm.convert.from.fp16(i16 %a)
7623 </pre>
7624
7625 </div>
7626
7627 </div>
7628
7629 <!-- ======================================================================= -->
7630 <h3>
7631   <a name="int_debugger">Debugger Intrinsics</a>
7632 </h3>
7633
7634 <div>
7635
7636 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
7637    prefix), are described in
7638    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
7639    Level Debugging</a> document.</p>
7640
7641 </div>
7642
7643 <!-- ======================================================================= -->
7644 <h3>
7645   <a name="int_eh">Exception Handling Intrinsics</a>
7646 </h3>
7647
7648 <div>
7649
7650 <p>The LLVM exception handling intrinsics (which all start with
7651    <tt>llvm.eh.</tt> prefix), are described in
7652    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
7653    Handling</a> document.</p>
7654
7655 </div>
7656
7657 <!-- ======================================================================= -->
7658 <h3>
7659   <a name="int_trampoline">Trampoline Intrinsic</a>
7660 </h3>
7661
7662 <div>
7663
7664 <p>This intrinsic makes it possible to excise one parameter, marked with
7665    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
7666    The result is a callable
7667    function pointer lacking the nest parameter - the caller does not need to
7668    provide a value for it.  Instead, the value to use is stored in advance in a
7669    "trampoline", a block of memory usually allocated on the stack, which also
7670    contains code to splice the nest value into the argument list.  This is used
7671    to implement the GCC nested function address extension.</p>
7672
7673 <p>For example, if the function is
7674    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
7675    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
7676    follows:</p>
7677
7678 <pre class="doc_code">
7679   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
7680   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
7681   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
7682   %fp = bitcast i8* %p to i32 (i32, i32)*
7683 </pre>
7684
7685 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
7686    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
7687
7688 <!-- _______________________________________________________________________ -->
7689 <h4>
7690   <a name="int_it">
7691     '<tt>llvm.init.trampoline</tt>' Intrinsic
7692   </a>
7693 </h4>
7694
7695 <div>
7696
7697 <h5>Syntax:</h5>
7698 <pre>
7699   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7700 </pre>
7701
7702 <h5>Overview:</h5>
7703 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
7704    function pointer suitable for executing it.</p>
7705
7706 <h5>Arguments:</h5>
7707 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7708    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7709    sufficiently aligned block of memory; this memory is written to by the
7710    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7711    currently provides no portable way of determining them, so a front-end that
7712    generates this intrinsic needs to have some target-specific knowledge.
7713    The <tt>func</tt> argument must hold a function bitcast to
7714    an <tt>i8*</tt>.</p>
7715
7716 <h5>Semantics:</h5>
7717 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7718    dependent code, turning it into a function.  A pointer to this function is
7719    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
7720    function pointer type</a> before being called.  The new function's signature
7721    is the same as that of <tt>func</tt> with any arguments marked with
7722    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
7723    is allowed, and it must be of pointer type.  Calling the new function is
7724    equivalent to calling <tt>func</tt> with the same argument list, but
7725    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7726    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7727    by <tt>tramp</tt> is modified, then the effect of any later call to the
7728    returned function pointer is undefined.</p>
7729
7730 </div>
7731
7732 </div>
7733
7734 <!-- ======================================================================= -->
7735 <h3>
7736   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7737 </h3>
7738
7739 <div>
7740
7741 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7742    hardware constructs for atomic operations and memory synchronization.  This
7743    provides an interface to the hardware, not an interface to the programmer. It
7744    is aimed at a low enough level to allow any programming models or APIs
7745    (Application Programming Interfaces) which need atomic behaviors to map
7746    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7747    hardware provides a "universal IR" for source languages, it also provides a
7748    starting point for developing a "universal" atomic operation and
7749    synchronization IR.</p>
7750
7751 <p>These do <em>not</em> form an API such as high-level threading libraries,
7752    software transaction memory systems, atomic primitives, and intrinsic
7753    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7754    application libraries.  The hardware interface provided by LLVM should allow
7755    a clean implementation of all of these APIs and parallel programming models.
7756    No one model or paradigm should be selected above others unless the hardware
7757    itself ubiquitously does so.</p>
7758
7759 <!-- _______________________________________________________________________ -->
7760 <h4>
7761   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7762 </h4>
7763
7764 <div>
7765 <h5>Syntax:</h5>
7766 <pre>
7767   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;)
7768 </pre>
7769
7770 <h5>Overview:</h5>
7771 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7772    specific pairs of memory access types.</p>
7773
7774 <h5>Arguments:</h5>
7775 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7776    The first four arguments enables a specific barrier as listed below.  The
7777    fifth argument specifies that the barrier applies to io or device or uncached
7778    memory.</p>
7779
7780 <ul>
7781   <li><tt>ll</tt>: load-load barrier</li>
7782   <li><tt>ls</tt>: load-store barrier</li>
7783   <li><tt>sl</tt>: store-load barrier</li>
7784   <li><tt>ss</tt>: store-store barrier</li>
7785   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7786 </ul>
7787
7788 <h5>Semantics:</h5>
7789 <p>This intrinsic causes the system to enforce some ordering constraints upon
7790    the loads and stores of the program. This barrier does not
7791    indicate <em>when</em> any events will occur, it only enforces
7792    an <em>order</em> in which they occur. For any of the specified pairs of load
7793    and store operations (f.ex.  load-load, or store-load), all of the first
7794    operations preceding the barrier will complete before any of the second
7795    operations succeeding the barrier begin. Specifically the semantics for each
7796    pairing is as follows:</p>
7797
7798 <ul>
7799   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7800       after the barrier begins.</li>
7801   <li><tt>ls</tt>: All loads before the barrier must complete before any
7802       store after the barrier begins.</li>
7803   <li><tt>ss</tt>: All stores before the barrier must complete before any
7804       store after the barrier begins.</li>
7805   <li><tt>sl</tt>: All stores before the barrier must complete before any
7806       load after the barrier begins.</li>
7807 </ul>
7808
7809 <p>These semantics are applied with a logical "and" behavior when more than one
7810    is enabled in a single memory barrier intrinsic.</p>
7811
7812 <p>Backends may implement stronger barriers than those requested when they do
7813    not support as fine grained a barrier as requested.  Some architectures do
7814    not need all types of barriers and on such architectures, these become
7815    noops.</p>
7816
7817 <h5>Example:</h5>
7818 <pre>
7819 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7820 %ptr      = bitcast i8* %mallocP to i32*
7821             store i32 4, %ptr
7822
7823 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7824             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false, i1 true)
7825                                 <i>; guarantee the above finishes</i>
7826             store i32 8, %ptr   <i>; before this begins</i>
7827 </pre>
7828
7829 </div>
7830
7831 <!-- _______________________________________________________________________ -->
7832 <h4>
7833   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7834 </h4>
7835
7836 <div>
7837
7838 <h5>Syntax:</h5>
7839 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7840    any integer bit width and for different address spaces. Not all targets
7841    support all bit widths however.</p>
7842
7843 <pre>
7844   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7845   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7846   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7847   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7848 </pre>
7849
7850 <h5>Overview:</h5>
7851 <p>This loads a value in memory and compares it to a given value. If they are
7852    equal, it stores a new value into the memory.</p>
7853
7854 <h5>Arguments:</h5>
7855 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7856    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7857    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7858    this integer type. While any bit width integer may be used, targets may only
7859    lower representations they support in hardware.</p>
7860
7861 <h5>Semantics:</h5>
7862 <p>This entire intrinsic must be executed atomically. It first loads the value
7863    in memory pointed to by <tt>ptr</tt> and compares it with the
7864    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7865    memory. The loaded value is yielded in all cases. This provides the
7866    equivalent of an atomic compare-and-swap operation within the SSA
7867    framework.</p>
7868
7869 <h5>Examples:</h5>
7870 <pre>
7871 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7872 %ptr      = bitcast i8* %mallocP to i32*
7873             store i32 4, %ptr
7874
7875 %val1     = add i32 4, 4
7876 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7877                                           <i>; yields {i32}:result1 = 4</i>
7878 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7879 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7880
7881 %val2     = add i32 1, 1
7882 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7883                                           <i>; yields {i32}:result2 = 8</i>
7884 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7885
7886 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7887 </pre>
7888
7889 </div>
7890
7891 <!-- _______________________________________________________________________ -->
7892 <h4>
7893   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7894 </h4>
7895
7896 <div>
7897 <h5>Syntax:</h5>
7898
7899 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7900    integer bit width. Not all targets support all bit widths however.</p>
7901
7902 <pre>
7903   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7904   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7905   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7906   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7907 </pre>
7908
7909 <h5>Overview:</h5>
7910 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7911    the value from memory. It then stores the value in <tt>val</tt> in the memory
7912    at <tt>ptr</tt>.</p>
7913
7914 <h5>Arguments:</h5>
7915 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7916   the <tt>val</tt> argument and the result must be integers of the same bit
7917   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7918   integer type. The targets may only lower integer representations they
7919   support.</p>
7920
7921 <h5>Semantics:</h5>
7922 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7923    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7924    equivalent of an atomic swap operation within the SSA framework.</p>
7925
7926 <h5>Examples:</h5>
7927 <pre>
7928 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7929 %ptr      = bitcast i8* %mallocP to i32*
7930             store i32 4, %ptr
7931
7932 %val1     = add i32 4, 4
7933 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7934                                         <i>; yields {i32}:result1 = 4</i>
7935 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7936 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7937
7938 %val2     = add i32 1, 1
7939 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7940                                         <i>; yields {i32}:result2 = 8</i>
7941
7942 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7943 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7944 </pre>
7945
7946 </div>
7947
7948 <!-- _______________________________________________________________________ -->
7949 <h4>
7950   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7951 </h4>
7952
7953 <div>
7954
7955 <h5>Syntax:</h5>
7956 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7957    any integer bit width. Not all targets support all bit widths however.</p>
7958
7959 <pre>
7960   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7961   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7962   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7963   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7964 </pre>
7965
7966 <h5>Overview:</h5>
7967 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7968    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7969
7970 <h5>Arguments:</h5>
7971 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7972    and the second an integer value. The result is also an integer value. These
7973    integer types can have any bit width, but they must all have the same bit
7974    width. The targets may only lower integer representations they support.</p>
7975
7976 <h5>Semantics:</h5>
7977 <p>This intrinsic does a series of operations atomically. It first loads the
7978    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7979    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7980
7981 <h5>Examples:</h5>
7982 <pre>
7983 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7984 %ptr      = bitcast i8* %mallocP to i32*
7985             store i32 4, %ptr
7986 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7987                                 <i>; yields {i32}:result1 = 4</i>
7988 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7989                                 <i>; yields {i32}:result2 = 8</i>
7990 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7991                                 <i>; yields {i32}:result3 = 10</i>
7992 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7993 </pre>
7994
7995 </div>
7996
7997 <!-- _______________________________________________________________________ -->
7998 <h4>
7999   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
8000 </h4>
8001
8002 <div>
8003
8004 <h5>Syntax:</h5>
8005 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
8006    any integer bit width and for different address spaces. Not all targets
8007    support all bit widths however.</p>
8008
8009 <pre>
8010   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8011   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8012   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8013   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8014 </pre>
8015
8016 <h5>Overview:</h5>
8017 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
8018    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
8019
8020 <h5>Arguments:</h5>
8021 <p>The intrinsic takes two arguments, the first a pointer to an integer value
8022    and the second an integer value. The result is also an integer value. These
8023    integer types can have any bit width, but they must all have the same bit
8024    width. The targets may only lower integer representations they support.</p>
8025
8026 <h5>Semantics:</h5>
8027 <p>This intrinsic does a series of operations atomically. It first loads the
8028    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
8029    result to <tt>ptr</tt>. It yields the original value stored
8030    at <tt>ptr</tt>.</p>
8031
8032 <h5>Examples:</h5>
8033 <pre>
8034 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8035 %ptr      = bitcast i8* %mallocP to i32*
8036             store i32 8, %ptr
8037 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
8038                                 <i>; yields {i32}:result1 = 8</i>
8039 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
8040                                 <i>; yields {i32}:result2 = 4</i>
8041 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
8042                                 <i>; yields {i32}:result3 = 2</i>
8043 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
8044 </pre>
8045
8046 </div>
8047
8048 <!-- _______________________________________________________________________ -->
8049 <h4>
8050   <a name="int_atomic_load_and">
8051     '<tt>llvm.atomic.load.and.*</tt>' Intrinsic
8052   </a>
8053   <br>
8054   <a name="int_atomic_load_nand">
8055     '<tt>llvm.atomic.load.nand.*</tt>' Intrinsic
8056   </a>
8057   <br>
8058   <a name="int_atomic_load_or">
8059     '<tt>llvm.atomic.load.or.*</tt>' Intrinsic
8060   </a>
8061   <br>
8062   <a name="int_atomic_load_xor">
8063     '<tt>llvm.atomic.load.xor.*</tt>' Intrinsic
8064   </a>
8065 </h4>
8066
8067 <div>
8068
8069 <h5>Syntax:</h5>
8070 <p>These are overloaded intrinsics. You can
8071   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
8072   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
8073   bit width and for different address spaces. Not all targets support all bit
8074   widths however.</p>
8075
8076 <pre>
8077   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8078   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8079   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8080   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8081 </pre>
8082
8083 <pre>
8084   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8085   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8086   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8087   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8088 </pre>
8089
8090 <pre>
8091   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8092   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8093   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8094   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8095 </pre>
8096
8097 <pre>
8098   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8099   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8100   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8101   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8102 </pre>
8103
8104 <h5>Overview:</h5>
8105 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
8106    the value stored in memory at <tt>ptr</tt>. It yields the original value
8107    at <tt>ptr</tt>.</p>
8108
8109 <h5>Arguments:</h5>
8110 <p>These intrinsics take two arguments, the first a pointer to an integer value
8111    and the second an integer value. The result is also an integer value. These
8112    integer types can have any bit width, but they must all have the same bit
8113    width. The targets may only lower integer representations they support.</p>
8114
8115 <h5>Semantics:</h5>
8116 <p>These intrinsics does a series of operations atomically. They first load the
8117    value stored at <tt>ptr</tt>. They then do the bitwise
8118    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
8119    original value stored at <tt>ptr</tt>.</p>
8120
8121 <h5>Examples:</h5>
8122 <pre>
8123 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8124 %ptr      = bitcast i8* %mallocP to i32*
8125             store i32 0x0F0F, %ptr
8126 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
8127                                 <i>; yields {i32}:result0 = 0x0F0F</i>
8128 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
8129                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
8130 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
8131                                 <i>; yields {i32}:result2 = 0xF0</i>
8132 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
8133                                 <i>; yields {i32}:result3 = FF</i>
8134 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
8135 </pre>
8136
8137 </div>
8138
8139 <!-- _______________________________________________________________________ -->
8140 <h4>
8141   <a name="int_atomic_load_max">
8142     '<tt>llvm.atomic.load.max.*</tt>' Intrinsic
8143   </a>
8144   <br>
8145   <a name="int_atomic_load_min">
8146     '<tt>llvm.atomic.load.min.*</tt>' Intrinsic
8147   </a>
8148   <br>
8149   <a name="int_atomic_load_umax">
8150     '<tt>llvm.atomic.load.umax.*</tt>' Intrinsic
8151   </a>
8152   <br>
8153   <a name="int_atomic_load_umin">
8154     '<tt>llvm.atomic.load.umin.*</tt>' Intrinsic
8155   </a>
8156 </h4>
8157
8158 <div>
8159
8160 <h5>Syntax:</h5>
8161 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
8162    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
8163    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
8164    address spaces. Not all targets support all bit widths however.</p>
8165
8166 <pre>
8167   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8168   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8169   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8170   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8171 </pre>
8172
8173 <pre>
8174   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8175   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8176   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8177   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8178 </pre>
8179
8180 <pre>
8181   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8182   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8183   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8184   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8185 </pre>
8186
8187 <pre>
8188   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8189   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8190   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8191   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8192 </pre>
8193
8194 <h5>Overview:</h5>
8195 <p>These intrinsics takes the signed or unsigned minimum or maximum of
8196    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
8197    original value at <tt>ptr</tt>.</p>
8198
8199 <h5>Arguments:</h5>
8200 <p>These intrinsics take two arguments, the first a pointer to an integer value
8201    and the second an integer value. The result is also an integer value. These
8202    integer types can have any bit width, but they must all have the same bit
8203    width. The targets may only lower integer representations they support.</p>
8204
8205 <h5>Semantics:</h5>
8206 <p>These intrinsics does a series of operations atomically. They first load the
8207    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
8208    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
8209    yield the original value stored at <tt>ptr</tt>.</p>
8210
8211 <h5>Examples:</h5>
8212 <pre>
8213 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8214 %ptr      = bitcast i8* %mallocP to i32*
8215             store i32 7, %ptr
8216 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
8217                                 <i>; yields {i32}:result0 = 7</i>
8218 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
8219                                 <i>; yields {i32}:result1 = -2</i>
8220 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
8221                                 <i>; yields {i32}:result2 = 8</i>
8222 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
8223                                 <i>; yields {i32}:result3 = 8</i>
8224 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
8225 </pre>
8226
8227 </div>
8228
8229 </div>
8230
8231 <!-- ======================================================================= -->
8232 <h3>
8233   <a name="int_memorymarkers">Memory Use Markers</a>
8234 </h3>
8235
8236 <div>
8237
8238 <p>This class of intrinsics exists to information about the lifetime of memory
8239    objects and ranges where variables are immutable.</p>
8240
8241 <!-- _______________________________________________________________________ -->
8242 <h4>
8243   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
8244 </h4>
8245
8246 <div>
8247
8248 <h5>Syntax:</h5>
8249 <pre>
8250   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8251 </pre>
8252
8253 <h5>Overview:</h5>
8254 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
8255    object's lifetime.</p>
8256
8257 <h5>Arguments:</h5>
8258 <p>The first argument is a constant integer representing the size of the
8259    object, or -1 if it is variable sized.  The second argument is a pointer to
8260    the object.</p>
8261
8262 <h5>Semantics:</h5>
8263 <p>This intrinsic indicates that before this point in the code, the value of the
8264    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8265    never be used and has an undefined value.  A load from the pointer that
8266    precedes this intrinsic can be replaced with
8267    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
8268
8269 </div>
8270
8271 <!-- _______________________________________________________________________ -->
8272 <h4>
8273   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
8274 </h4>
8275
8276 <div>
8277
8278 <h5>Syntax:</h5>
8279 <pre>
8280   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8281 </pre>
8282
8283 <h5>Overview:</h5>
8284 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
8285    object's lifetime.</p>
8286
8287 <h5>Arguments:</h5>
8288 <p>The first argument is a constant integer representing the size of the
8289    object, or -1 if it is variable sized.  The second argument is a pointer to
8290    the object.</p>
8291
8292 <h5>Semantics:</h5>
8293 <p>This intrinsic indicates that after this point in the code, the value of the
8294    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8295    never be used and has an undefined value.  Any stores into the memory object
8296    following this intrinsic may be removed as dead.
8297
8298 </div>
8299
8300 <!-- _______________________________________________________________________ -->
8301 <h4>
8302   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
8303 </h4>
8304
8305 <div>
8306
8307 <h5>Syntax:</h5>
8308 <pre>
8309   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8310 </pre>
8311
8312 <h5>Overview:</h5>
8313 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
8314    a memory object will not change.</p>
8315
8316 <h5>Arguments:</h5>
8317 <p>The first argument is a constant integer representing the size of the
8318    object, or -1 if it is variable sized.  The second argument is a pointer to
8319    the object.</p>
8320
8321 <h5>Semantics:</h5>
8322 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8323    the return value, the referenced memory location is constant and
8324    unchanging.</p>
8325
8326 </div>
8327
8328 <!-- _______________________________________________________________________ -->
8329 <h4>
8330   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8331 </h4>
8332
8333 <div>
8334
8335 <h5>Syntax:</h5>
8336 <pre>
8337   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8338 </pre>
8339
8340 <h5>Overview:</h5>
8341 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8342    a memory object are mutable.</p>
8343
8344 <h5>Arguments:</h5>
8345 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8346    The second argument is a constant integer representing the size of the
8347    object, or -1 if it is variable sized and the third argument is a pointer
8348    to the object.</p>
8349
8350 <h5>Semantics:</h5>
8351 <p>This intrinsic indicates that the memory is mutable again.</p>
8352
8353 </div>
8354
8355 </div>
8356
8357 <!-- ======================================================================= -->
8358 <h3>
8359   <a name="int_general">General Intrinsics</a>
8360 </h3>
8361
8362 <div>
8363
8364 <p>This class of intrinsics is designed to be generic and has no specific
8365    purpose.</p>
8366
8367 <!-- _______________________________________________________________________ -->
8368 <h4>
8369   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8370 </h4>
8371
8372 <div>
8373
8374 <h5>Syntax:</h5>
8375 <pre>
8376   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8377 </pre>
8378
8379 <h5>Overview:</h5>
8380 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8381
8382 <h5>Arguments:</h5>
8383 <p>The first argument is a pointer to a value, the second is a pointer to a
8384    global string, the third is a pointer to a global string which is the source
8385    file name, and the last argument is the line number.</p>
8386
8387 <h5>Semantics:</h5>
8388 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8389    This can be useful for special purpose optimizations that want to look for
8390    these annotations.  These have no other defined use, they are ignored by code
8391    generation and optimization.</p>
8392
8393 </div>
8394
8395 <!-- _______________________________________________________________________ -->
8396 <h4>
8397   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8398 </h4>
8399
8400 <div>
8401
8402 <h5>Syntax:</h5>
8403 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8404    any integer bit width.</p>
8405
8406 <pre>
8407   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8408   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8409   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8410   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8411   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8412 </pre>
8413
8414 <h5>Overview:</h5>
8415 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8416
8417 <h5>Arguments:</h5>
8418 <p>The first argument is an integer value (result of some expression), the
8419    second is a pointer to a global string, the third is a pointer to a global
8420    string which is the source file name, and the last argument is the line
8421    number.  It returns the value of the first argument.</p>
8422
8423 <h5>Semantics:</h5>
8424 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8425    arbitrary strings.  This can be useful for special purpose optimizations that
8426    want to look for these annotations.  These have no other defined use, they
8427    are ignored by code generation and optimization.</p>
8428
8429 </div>
8430
8431 <!-- _______________________________________________________________________ -->
8432 <h4>
8433   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8434 </h4>
8435
8436 <div>
8437
8438 <h5>Syntax:</h5>
8439 <pre>
8440   declare void @llvm.trap()
8441 </pre>
8442
8443 <h5>Overview:</h5>
8444 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8445
8446 <h5>Arguments:</h5>
8447 <p>None.</p>
8448
8449 <h5>Semantics:</h5>
8450 <p>This intrinsics is lowered to the target dependent trap instruction. If the
8451    target does not have a trap instruction, this intrinsic will be lowered to
8452    the call of the <tt>abort()</tt> function.</p>
8453
8454 </div>
8455
8456 <!-- _______________________________________________________________________ -->
8457 <h4>
8458   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8459 </h4>
8460
8461 <div>
8462
8463 <h5>Syntax:</h5>
8464 <pre>
8465   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8466 </pre>
8467
8468 <h5>Overview:</h5>
8469 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8470    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8471    ensure that it is placed on the stack before local variables.</p>
8472
8473 <h5>Arguments:</h5>
8474 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8475    arguments. The first argument is the value loaded from the stack
8476    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8477    that has enough space to hold the value of the guard.</p>
8478
8479 <h5>Semantics:</h5>
8480 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8481    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8482    stack. This is to ensure that if a local variable on the stack is
8483    overwritten, it will destroy the value of the guard. When the function exits,
8484    the guard on the stack is checked against the original guard. If they are
8485    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8486    function.</p>
8487
8488 </div>
8489
8490 <!-- _______________________________________________________________________ -->
8491 <h4>
8492   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8493 </h4>
8494
8495 <div>
8496
8497 <h5>Syntax:</h5>
8498 <pre>
8499   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
8500   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
8501 </pre>
8502
8503 <h5>Overview:</h5>
8504 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8505    the optimizers to determine at compile time whether a) an operation (like
8506    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8507    runtime check for overflow isn't necessary. An object in this context means
8508    an allocation of a specific class, structure, array, or other object.</p>
8509
8510 <h5>Arguments:</h5>
8511 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8512    argument is a pointer to or into the <tt>object</tt>. The second argument
8513    is a boolean 0 or 1. This argument determines whether you want the
8514    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
8515    1, variables are not allowed.</p>
8516
8517 <h5>Semantics:</h5>
8518 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
8519    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
8520    depending on the <tt>type</tt> argument, if the size cannot be determined at
8521    compile time.</p>
8522
8523 </div>
8524
8525 </div>
8526
8527 </div>
8528
8529 <!-- *********************************************************************** -->
8530 <hr>
8531 <address>
8532   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8533   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8534   <a href="http://validator.w3.org/check/referer"><img
8535   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8536
8537   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8538   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8539   Last modified: $Date$
8540 </address>
8541
8542 </body>
8543 </html>