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>For a more informal introduction to this model, see the
1501 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.
1502
1503 <p>We define a <i>happens-before</i> partial order as the least partial order
1504 that</p>
1505 <ul>
1506   <li>Is a superset of single-thread program order, and</li>
1507   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1508       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1509       by platform-specific techniques, like pthread locks, thread
1510       creation, thread joining, etc., and by atomic instructions.
1511       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1512       </li>
1513 </ul>
1514
1515 <p>Note that program order does not introduce <i>happens-before</i> edges
1516 between a thread and signals executing inside that thread.</p>
1517
1518 <p>Every (defined) read operation (load instructions, memcpy, atomic
1519 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1520 (defined) write operations (store instructions, atomic
1521 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1522 initialized globals are considered to have a write of the initializer which is
1523 atomic and happens before any other read or write of the memory in question.
1524 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1525 any write to the same byte, except:</p>
1526
1527 <ul>
1528   <li>If <var>write<sub>1</sub></var> happens before
1529       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1530       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1531       does not see <var>write<sub>1</sub></var>.
1532   <li>If <var>R<sub>byte</sub></var> happens before
1533       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1534       see <var>write<sub>3</sub></var>.
1535 </ul>
1536
1537 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1538 <ul>
1539   <li>If <var>R</var> is volatile, the result is target-dependent. (Volatile
1540       is supposed to give guarantees which can support
1541       <code>sig_atomic_t</code> in C/C++, and may be used for accesses to
1542       addresses which do not behave like normal memory.  It does not generally
1543       provide cross-thread synchronization.)
1544   <li>Otherwise, if there is no write to the same byte that happens before
1545     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1546     <tt>undef</tt> for that byte.
1547   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1548       <var>R<sub>byte</sub></var> returns the value written by that
1549       write.</li>
1550   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1551       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1552       values written.  See the <a href="#ordering">Atomic Memory Ordering
1553       Constraints</a> section for additional constraints on how the choice
1554       is made.
1555   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1556 </ul>
1557
1558 <p><var>R</var> returns the value composed of the series of bytes it read.
1559 This implies that some bytes within the value may be <tt>undef</tt>
1560 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1561 defines the semantics of the operation; it doesn't mean that targets will
1562 emit more than one instruction to read the series of bytes.</p>
1563
1564 <p>Note that in cases where none of the atomic intrinsics are used, this model
1565 places only one restriction on IR transformations on top of what is required
1566 for single-threaded execution: introducing a store to a byte which might not
1567 otherwise be stored is not allowed in general.  (Specifically, in the case
1568 where another thread might write to and read from an address, introducing a
1569 store can change a load that may see exactly one write into a load that may
1570 see multiple writes.)</p>
1571
1572 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1573 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1574 none of the backends currently in the tree fall into this category; however,
1575 there might be targets which care.  If there are, we want a paragraph
1576 like the following:
1577
1578 Targets may specify that stores narrower than a certain width are not
1579 available; on such a target, for the purposes of this model, treat any
1580 non-atomic write with an alignment or width less than the minimum width
1581 as if it writes to the relevant surrounding bytes.
1582 -->
1583
1584 </div>
1585
1586 <!-- ======================================================================= -->
1587 <h3>
1588       <a name="ordering">Atomic Memory Ordering Constraints</a>
1589 </h3>
1590
1591 <div>
1592
1593 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1594 <a href="#i_atomicrmw"><code>atomicrmw</code></a>,
1595 <a href="#i_fence"><code>fence</code></a>,
1596 <a href="#i_load"><code>atomic load</code></a>, and
1597 <a href="#i_store"><code>atomic store</code></a>) take an ordering parameter
1598 that determines which other atomic instructions on the same address they
1599 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1600 but are somewhat more colloquial. If these descriptions aren't precise enough,
1601 check those specs (see spec references in the
1602 <a href="Atomic.html#introduction">atomics guide</a>).
1603 <a href="#i_fence"><code>fence</code></a> instructions
1604 treat these orderings somewhat differently since they don't take an address.
1605 See that instruction's documentation for details.</p>
1606
1607 <p>For a simpler introduction to the ordering constraints, see the
1608 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.</p>
1609
1610 <dl>
1611 <dt><code>unordered</code></dt>
1612 <dd>The set of values that can be read is governed by the happens-before
1613 partial order. A value cannot be read unless some operation wrote it.
1614 This is intended to provide a guarantee strong enough to model Java's
1615 non-volatile shared variables.  This ordering cannot be specified for
1616 read-modify-write operations; it is not strong enough to make them atomic
1617 in any interesting way.</dd>
1618 <dt><code>monotonic</code></dt>
1619 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1620 total order for modifications by <code>monotonic</code> operations on each
1621 address. All modification orders must be compatible with the happens-before
1622 order. There is no guarantee that the modification orders can be combined to
1623 a global total order for the whole program (and this often will not be
1624 possible). The read in an atomic read-modify-write operation
1625 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1626 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1627 reads the value in the modification order immediately before the value it
1628 writes. If one atomic read happens before another atomic read of the same
1629 address, the later read must see the same value or a later value in the
1630 address's modification order. This disallows reordering of
1631 <code>monotonic</code> (or stronger) operations on the same address. If an
1632 address is written <code>monotonic</code>ally by one thread, and other threads
1633 <code>monotonic</code>ally read that address repeatedly, the other threads must
1634 eventually see the write. This corresponds to the C++0x/C1x
1635 <code>memory_order_relaxed</code>.</dd>
1636 <dt><code>acquire</code></dt>
1637 <dd>In addition to the guarantees of <code>monotonic</code>,
1638 a <i>synchronizes-with</i> edge may be formed with a <code>release</code>
1639 operation. This is intended to model C++'s <code>memory_order_acquire</code>.</dd>
1640 <dt><code>release</code></dt>
1641 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1642 writes a value which is subsequently read by an <code>acquire</code> operation,
1643 it <i>synchronizes-with</i> that operation.  (This isn't a complete
1644 description; see the C++0x definition of a release sequence.) This corresponds
1645 to the C++0x/C1x <code>memory_order_release</code>.</dd>
1646 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1647 <code>acquire</code> and <code>release</code> operation on its address.
1648 This corresponds to the C++0x/C1x <code>memory_order_acq_rel</code>.</dd>
1649 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1650 <dd>In addition to the guarantees of <code>acq_rel</code>
1651 (<code>acquire</code> for an operation which only reads, <code>release</code>
1652 for an operation which only writes), there is a global total order on all
1653 sequentially-consistent operations on all addresses, which is consistent with
1654 the <i>happens-before</i> partial order and with the modification orders of
1655 all the affected addresses. Each sequentially-consistent read sees the last
1656 preceding write to the same address in this global order. This corresponds
1657 to the C++0x/C1x <code>memory_order_seq_cst</code> and Java volatile.</dd>
1658 </dl>
1659
1660 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1661 it only <i>synchronizes with</i> or participates in modification and seq_cst
1662 total orderings with other operations running in the same thread (for example,
1663 in signal handlers).</p>
1664
1665 </div>
1666
1667 </div>
1668
1669 <!-- *********************************************************************** -->
1670 <h2><a name="typesystem">Type System</a></h2>
1671 <!-- *********************************************************************** -->
1672
1673 <div>
1674
1675 <p>The LLVM type system is one of the most important features of the
1676    intermediate representation.  Being typed enables a number of optimizations
1677    to be performed on the intermediate representation directly, without having
1678    to do extra analyses on the side before the transformation.  A strong type
1679    system makes it easier to read the generated code and enables novel analyses
1680    and transformations that are not feasible to perform on normal three address
1681    code representations.</p>
1682
1683 <!-- ======================================================================= -->
1684 <h3>
1685   <a name="t_classifications">Type Classifications</a>
1686 </h3>
1687
1688 <div>
1689
1690 <p>The types fall into a few useful classifications:</p>
1691
1692 <table border="1" cellspacing="0" cellpadding="4">
1693   <tbody>
1694     <tr><th>Classification</th><th>Types</th></tr>
1695     <tr>
1696       <td><a href="#t_integer">integer</a></td>
1697       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1698     </tr>
1699     <tr>
1700       <td><a href="#t_floating">floating point</a></td>
1701       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1702     </tr>
1703     <tr>
1704       <td><a name="t_firstclass">first class</a></td>
1705       <td><a href="#t_integer">integer</a>,
1706           <a href="#t_floating">floating point</a>,
1707           <a href="#t_pointer">pointer</a>,
1708           <a href="#t_vector">vector</a>,
1709           <a href="#t_struct">structure</a>,
1710           <a href="#t_array">array</a>,
1711           <a href="#t_label">label</a>,
1712           <a href="#t_metadata">metadata</a>.
1713       </td>
1714     </tr>
1715     <tr>
1716       <td><a href="#t_primitive">primitive</a></td>
1717       <td><a href="#t_label">label</a>,
1718           <a href="#t_void">void</a>,
1719           <a href="#t_integer">integer</a>,
1720           <a href="#t_floating">floating point</a>,
1721           <a href="#t_x86mmx">x86mmx</a>,
1722           <a href="#t_metadata">metadata</a>.</td>
1723     </tr>
1724     <tr>
1725       <td><a href="#t_derived">derived</a></td>
1726       <td><a href="#t_array">array</a>,
1727           <a href="#t_function">function</a>,
1728           <a href="#t_pointer">pointer</a>,
1729           <a href="#t_struct">structure</a>,
1730           <a href="#t_vector">vector</a>,
1731           <a href="#t_opaque">opaque</a>.
1732       </td>
1733     </tr>
1734   </tbody>
1735 </table>
1736
1737 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1738    important.  Values of these types are the only ones which can be produced by
1739    instructions.</p>
1740
1741 </div>
1742
1743 <!-- ======================================================================= -->
1744 <h3>
1745   <a name="t_primitive">Primitive Types</a>
1746 </h3>
1747
1748 <div>
1749
1750 <p>The primitive types are the fundamental building blocks of the LLVM
1751    system.</p>
1752
1753 <!-- _______________________________________________________________________ -->
1754 <h4>
1755   <a name="t_integer">Integer Type</a>
1756 </h4>
1757
1758 <div>
1759
1760 <h5>Overview:</h5>
1761 <p>The integer type is a very simple type that simply specifies an arbitrary
1762    bit width for the integer type desired. Any bit width from 1 bit to
1763    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1764
1765 <h5>Syntax:</h5>
1766 <pre>
1767   iN
1768 </pre>
1769
1770 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1771    value.</p>
1772
1773 <h5>Examples:</h5>
1774 <table class="layout">
1775   <tr class="layout">
1776     <td class="left"><tt>i1</tt></td>
1777     <td class="left">a single-bit integer.</td>
1778   </tr>
1779   <tr class="layout">
1780     <td class="left"><tt>i32</tt></td>
1781     <td class="left">a 32-bit integer.</td>
1782   </tr>
1783   <tr class="layout">
1784     <td class="left"><tt>i1942652</tt></td>
1785     <td class="left">a really big integer of over 1 million bits.</td>
1786   </tr>
1787 </table>
1788
1789 </div>
1790
1791 <!-- _______________________________________________________________________ -->
1792 <h4>
1793   <a name="t_floating">Floating Point Types</a>
1794 </h4>
1795
1796 <div>
1797
1798 <table>
1799   <tbody>
1800     <tr><th>Type</th><th>Description</th></tr>
1801     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1802     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1803     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1804     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1805     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1806   </tbody>
1807 </table>
1808
1809 </div>
1810
1811 <!-- _______________________________________________________________________ -->
1812 <h4>
1813   <a name="t_x86mmx">X86mmx Type</a>
1814 </h4>
1815
1816 <div>
1817
1818 <h5>Overview:</h5>
1819 <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>
1820
1821 <h5>Syntax:</h5>
1822 <pre>
1823   x86mmx
1824 </pre>
1825
1826 </div>
1827
1828 <!-- _______________________________________________________________________ -->
1829 <h4>
1830   <a name="t_void">Void Type</a>
1831 </h4>
1832
1833 <div>
1834
1835 <h5>Overview:</h5>
1836 <p>The void type does not represent any value and has no size.</p>
1837
1838 <h5>Syntax:</h5>
1839 <pre>
1840   void
1841 </pre>
1842
1843 </div>
1844
1845 <!-- _______________________________________________________________________ -->
1846 <h4>
1847   <a name="t_label">Label Type</a>
1848 </h4>
1849
1850 <div>
1851
1852 <h5>Overview:</h5>
1853 <p>The label type represents code labels.</p>
1854
1855 <h5>Syntax:</h5>
1856 <pre>
1857   label
1858 </pre>
1859
1860 </div>
1861
1862 <!-- _______________________________________________________________________ -->
1863 <h4>
1864   <a name="t_metadata">Metadata Type</a>
1865 </h4>
1866
1867 <div>
1868
1869 <h5>Overview:</h5>
1870 <p>The metadata type represents embedded metadata. No derived types may be
1871    created from metadata except for <a href="#t_function">function</a>
1872    arguments.
1873
1874 <h5>Syntax:</h5>
1875 <pre>
1876   metadata
1877 </pre>
1878
1879 </div>
1880
1881 </div>
1882
1883 <!-- ======================================================================= -->
1884 <h3>
1885   <a name="t_derived">Derived Types</a>
1886 </h3>
1887
1888 <div>
1889
1890 <p>The real power in LLVM comes from the derived types in the system.  This is
1891    what allows a programmer to represent arrays, functions, pointers, and other
1892    useful types.  Each of these types contain one or more element types which
1893    may be a primitive type, or another derived type.  For example, it is
1894    possible to have a two dimensional array, using an array as the element type
1895    of another array.</p>
1896
1897 </div>
1898
1899
1900 <!-- _______________________________________________________________________ -->
1901 <h4>
1902   <a name="t_aggregate">Aggregate Types</a>
1903 </h4>
1904
1905 <div>
1906
1907 <p>Aggregate Types are a subset of derived types that can contain multiple
1908   member types. <a href="#t_array">Arrays</a>,
1909   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1910   aggregate types.</p>
1911
1912 </div>
1913
1914 <!-- _______________________________________________________________________ -->
1915 <h4>
1916   <a name="t_array">Array Type</a>
1917 </h4>
1918
1919 <div>
1920
1921 <h5>Overview:</h5>
1922 <p>The array type is a very simple derived type that arranges elements
1923    sequentially in memory.  The array type requires a size (number of elements)
1924    and an underlying data type.</p>
1925
1926 <h5>Syntax:</h5>
1927 <pre>
1928   [&lt;# elements&gt; x &lt;elementtype&gt;]
1929 </pre>
1930
1931 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1932    be any type with a size.</p>
1933
1934 <h5>Examples:</h5>
1935 <table class="layout">
1936   <tr class="layout">
1937     <td class="left"><tt>[40 x i32]</tt></td>
1938     <td class="left">Array of 40 32-bit integer values.</td>
1939   </tr>
1940   <tr class="layout">
1941     <td class="left"><tt>[41 x i32]</tt></td>
1942     <td class="left">Array of 41 32-bit integer values.</td>
1943   </tr>
1944   <tr class="layout">
1945     <td class="left"><tt>[4 x i8]</tt></td>
1946     <td class="left">Array of 4 8-bit integer values.</td>
1947   </tr>
1948 </table>
1949 <p>Here are some examples of multidimensional arrays:</p>
1950 <table class="layout">
1951   <tr class="layout">
1952     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1953     <td class="left">3x4 array of 32-bit integer values.</td>
1954   </tr>
1955   <tr class="layout">
1956     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1957     <td class="left">12x10 array of single precision floating point values.</td>
1958   </tr>
1959   <tr class="layout">
1960     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1961     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1962   </tr>
1963 </table>
1964
1965 <p>There is no restriction on indexing beyond the end of the array implied by
1966    a static type (though there are restrictions on indexing beyond the bounds
1967    of an allocated object in some cases). This means that single-dimension
1968    'variable sized array' addressing can be implemented in LLVM with a zero
1969    length array type. An implementation of 'pascal style arrays' in LLVM could
1970    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1971
1972 </div>
1973
1974 <!-- _______________________________________________________________________ -->
1975 <h4>
1976   <a name="t_function">Function Type</a>
1977 </h4>
1978
1979 <div>
1980
1981 <h5>Overview:</h5>
1982 <p>The function type can be thought of as a function signature.  It consists of
1983    a return type and a list of formal parameter types. The return type of a
1984    function type is a first class type or a void type.</p>
1985
1986 <h5>Syntax:</h5>
1987 <pre>
1988   &lt;returntype&gt; (&lt;parameter list&gt;)
1989 </pre>
1990
1991 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1992    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1993    which indicates that the function takes a variable number of arguments.
1994    Variable argument functions can access their arguments with
1995    the <a href="#int_varargs">variable argument handling intrinsic</a>
1996    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1997    <a href="#t_label">label</a>.</p>
1998
1999 <h5>Examples:</h5>
2000 <table class="layout">
2001   <tr class="layout">
2002     <td class="left"><tt>i32 (i32)</tt></td>
2003     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
2004     </td>
2005   </tr><tr class="layout">
2006     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
2007     </tt></td>
2008     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
2009       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
2010       returning <tt>float</tt>.
2011     </td>
2012   </tr><tr class="layout">
2013     <td class="left"><tt>i32 (i8*, ...)</tt></td>
2014     <td class="left">A vararg function that takes at least one
2015       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2016       which returns an integer.  This is the signature for <tt>printf</tt> in
2017       LLVM.
2018     </td>
2019   </tr><tr class="layout">
2020     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2021     <td class="left">A function taking an <tt>i32</tt>, returning a
2022         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2023     </td>
2024   </tr>
2025 </table>
2026
2027 </div>
2028
2029 <!-- _______________________________________________________________________ -->
2030 <h4>
2031   <a name="t_struct">Structure Type</a>
2032 </h4>
2033
2034 <div>
2035
2036 <h5>Overview:</h5>
2037 <p>The structure type is used to represent a collection of data members together
2038   in memory.  The elements of a structure may be any type that has a size.</p>
2039
2040 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2041    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2042    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2043    Structures in registers are accessed using the
2044    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2045    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2046
2047 <p>Structures may optionally be "packed" structures, which indicate that the
2048   alignment of the struct is one byte, and that there is no padding between
2049   the elements.  In non-packed structs, padding between field types is inserted
2050   as defined by the TargetData string in the module, which is required to match
2051   what the underlying processor expects.</p>
2052
2053 <p>Structures can either be "literal" or "identified".  A literal structure is
2054   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) whereas identified
2055   types are always defined at the top level with a name.  Literal types are
2056   uniqued by their contents and can never be recursive or opaque since there is
2057   no way to write one.  Identified types can be recursive, can be opaqued, and are
2058   never uniqued.
2059 </p>
2060
2061 <h5>Syntax:</h5>
2062 <pre>
2063   %T1 = type { &lt;type list&gt; }     <i>; Identified normal struct type</i>
2064   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Identified packed struct type</i>
2065 </pre>
2066
2067 <h5>Examples:</h5>
2068 <table class="layout">
2069   <tr class="layout">
2070     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2071     <td class="left">A triple of three <tt>i32</tt> values</td>
2072   </tr>
2073   <tr class="layout">
2074     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2075     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2076       second element is a <a href="#t_pointer">pointer</a> to a
2077       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2078       an <tt>i32</tt>.</td>
2079   </tr>
2080   <tr class="layout">
2081     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2082     <td class="left">A packed struct known to be 5 bytes in size.</td>
2083   </tr>
2084 </table>
2085
2086 </div>
2087
2088 <!-- _______________________________________________________________________ -->
2089 <h4>
2090   <a name="t_opaque">Opaque Structure Types</a>
2091 </h4>
2092
2093 <div>
2094
2095 <h5>Overview:</h5>
2096 <p>Opaque structure types are used to represent named structure types that do
2097    not have a body specified.  This corresponds (for example) to the C notion of
2098    a forward declared structure.</p>
2099
2100 <h5>Syntax:</h5>
2101 <pre>
2102   %X = type opaque
2103   %52 = type opaque
2104 </pre>
2105
2106 <h5>Examples:</h5>
2107 <table class="layout">
2108   <tr class="layout">
2109     <td class="left"><tt>opaque</tt></td>
2110     <td class="left">An opaque type.</td>
2111   </tr>
2112 </table>
2113
2114 </div>
2115
2116
2117
2118 <!-- _______________________________________________________________________ -->
2119 <h4>
2120   <a name="t_pointer">Pointer Type</a>
2121 </h4>
2122
2123 <div>
2124
2125 <h5>Overview:</h5>
2126 <p>The pointer type is used to specify memory locations.
2127    Pointers are commonly used to reference objects in memory.</p>
2128
2129 <p>Pointer types may have an optional address space attribute defining the
2130    numbered address space where the pointed-to object resides. The default
2131    address space is number zero. The semantics of non-zero address
2132    spaces are target-specific.</p>
2133
2134 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2135    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2136
2137 <h5>Syntax:</h5>
2138 <pre>
2139   &lt;type&gt; *
2140 </pre>
2141
2142 <h5>Examples:</h5>
2143 <table class="layout">
2144   <tr class="layout">
2145     <td class="left"><tt>[4 x i32]*</tt></td>
2146     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2147                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2148   </tr>
2149   <tr class="layout">
2150     <td class="left"><tt>i32 (i32*) *</tt></td>
2151     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2152       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2153       <tt>i32</tt>.</td>
2154   </tr>
2155   <tr class="layout">
2156     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2157     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2158      that resides in address space #5.</td>
2159   </tr>
2160 </table>
2161
2162 </div>
2163
2164 <!-- _______________________________________________________________________ -->
2165 <h4>
2166   <a name="t_vector">Vector Type</a>
2167 </h4>
2168
2169 <div>
2170
2171 <h5>Overview:</h5>
2172 <p>A vector type is a simple derived type that represents a vector of elements.
2173    Vector types are used when multiple primitive data are operated in parallel
2174    using a single instruction (SIMD).  A vector type requires a size (number of
2175    elements) and an underlying primitive data type.  Vector types are considered
2176    <a href="#t_firstclass">first class</a>.</p>
2177
2178 <h5>Syntax:</h5>
2179 <pre>
2180   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2181 </pre>
2182
2183 <p>The number of elements is a constant integer value larger than 0; elementtype
2184    may be any integer or floating point type.  Vectors of size zero are not
2185    allowed, and pointers are not allowed as the element type.</p>
2186
2187 <h5>Examples:</h5>
2188 <table class="layout">
2189   <tr class="layout">
2190     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2191     <td class="left">Vector of 4 32-bit integer values.</td>
2192   </tr>
2193   <tr class="layout">
2194     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2195     <td class="left">Vector of 8 32-bit floating-point values.</td>
2196   </tr>
2197   <tr class="layout">
2198     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2199     <td class="left">Vector of 2 64-bit integer values.</td>
2200   </tr>
2201 </table>
2202
2203 </div>
2204
2205 </div>
2206
2207 <!-- *********************************************************************** -->
2208 <h2><a name="constants">Constants</a></h2>
2209 <!-- *********************************************************************** -->
2210
2211 <div>
2212
2213 <p>LLVM has several different basic types of constants.  This section describes
2214    them all and their syntax.</p>
2215
2216 <!-- ======================================================================= -->
2217 <h3>
2218   <a name="simpleconstants">Simple Constants</a>
2219 </h3>
2220
2221 <div>
2222
2223 <dl>
2224   <dt><b>Boolean constants</b></dt>
2225   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2226       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2227
2228   <dt><b>Integer constants</b></dt>
2229   <dd>Standard integers (such as '4') are constants of
2230       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2231       with integer types.</dd>
2232
2233   <dt><b>Floating point constants</b></dt>
2234   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2235       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2236       notation (see below).  The assembler requires the exact decimal value of a
2237       floating-point constant.  For example, the assembler accepts 1.25 but
2238       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2239       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2240
2241   <dt><b>Null pointer constants</b></dt>
2242   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2243       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2244 </dl>
2245
2246 <p>The one non-intuitive notation for constants is the hexadecimal form of
2247    floating point constants.  For example, the form '<tt>double
2248    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2249    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2250    constants are required (and the only time that they are generated by the
2251    disassembler) is when a floating point constant must be emitted but it cannot
2252    be represented as a decimal floating point number in a reasonable number of
2253    digits.  For example, NaN's, infinities, and other special values are
2254    represented in their IEEE hexadecimal format so that assembly and disassembly
2255    do not cause any bits to change in the constants.</p>
2256
2257 <p>When using the hexadecimal form, constants of types float and double are
2258    represented using the 16-digit form shown above (which matches the IEEE754
2259    representation for double); float values must, however, be exactly
2260    representable as IEE754 single precision.  Hexadecimal format is always used
2261    for long double, and there are three forms of long double.  The 80-bit format
2262    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2263    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2264    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2265    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2266    currently supported target uses this format.  Long doubles will only work if
2267    they match the long double format on your target.  All hexadecimal formats
2268    are big-endian (sign bit at the left).</p>
2269
2270 <p>There are no constants of type x86mmx.</p>
2271 </div>
2272
2273 <!-- ======================================================================= -->
2274 <h3>
2275 <a name="aggregateconstants"></a> <!-- old anchor -->
2276 <a name="complexconstants">Complex Constants</a>
2277 </h3>
2278
2279 <div>
2280
2281 <p>Complex constants are a (potentially recursive) combination of simple
2282    constants and smaller complex constants.</p>
2283
2284 <dl>
2285   <dt><b>Structure constants</b></dt>
2286   <dd>Structure constants are represented with notation similar to structure
2287       type definitions (a comma separated list of elements, surrounded by braces
2288       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2289       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2290       Structure constants must have <a href="#t_struct">structure type</a>, and
2291       the number and types of elements must match those specified by the
2292       type.</dd>
2293
2294   <dt><b>Array constants</b></dt>
2295   <dd>Array constants are represented with notation similar to array type
2296      definitions (a comma separated list of elements, surrounded by square
2297      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2298      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2299      the number and types of elements must match those specified by the
2300      type.</dd>
2301
2302   <dt><b>Vector constants</b></dt>
2303   <dd>Vector constants are represented with notation similar to vector type
2304       definitions (a comma separated list of elements, surrounded by
2305       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2306       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2307       have <a href="#t_vector">vector type</a>, and the number and types of
2308       elements must match those specified by the type.</dd>
2309
2310   <dt><b>Zero initialization</b></dt>
2311   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2312       value to zero of <em>any</em> type, including scalar and
2313       <a href="#t_aggregate">aggregate</a> types.
2314       This is often used to avoid having to print large zero initializers
2315       (e.g. for large arrays) and is always exactly equivalent to using explicit
2316       zero initializers.</dd>
2317
2318   <dt><b>Metadata node</b></dt>
2319   <dd>A metadata node is a structure-like constant with
2320       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2321       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2322       be interpreted as part of the instruction stream, metadata is a place to
2323       attach additional information such as debug info.</dd>
2324 </dl>
2325
2326 </div>
2327
2328 <!-- ======================================================================= -->
2329 <h3>
2330   <a name="globalconstants">Global Variable and Function Addresses</a>
2331 </h3>
2332
2333 <div>
2334
2335 <p>The addresses of <a href="#globalvars">global variables</a>
2336    and <a href="#functionstructure">functions</a> are always implicitly valid
2337    (link-time) constants.  These constants are explicitly referenced when
2338    the <a href="#identifiers">identifier for the global</a> is used and always
2339    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2340    legal LLVM file:</p>
2341
2342 <pre class="doc_code">
2343 @X = global i32 17
2344 @Y = global i32 42
2345 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2346 </pre>
2347
2348 </div>
2349
2350 <!-- ======================================================================= -->
2351 <h3>
2352   <a name="undefvalues">Undefined Values</a>
2353 </h3>
2354
2355 <div>
2356
2357 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2358    indicates that the user of the value may receive an unspecified bit-pattern.
2359    Undefined values may be of any type (other than '<tt>label</tt>'
2360    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2361
2362 <p>Undefined values are useful because they indicate to the compiler that the
2363    program is well defined no matter what value is used.  This gives the
2364    compiler more freedom to optimize.  Here are some examples of (potentially
2365    surprising) transformations that are valid (in pseudo IR):</p>
2366
2367
2368 <pre class="doc_code">
2369   %A = add %X, undef
2370   %B = sub %X, undef
2371   %C = xor %X, undef
2372 Safe:
2373   %A = undef
2374   %B = undef
2375   %C = undef
2376 </pre>
2377
2378 <p>This is safe because all of the output bits are affected by the undef bits.
2379    Any output bit can have a zero or one depending on the input bits.</p>
2380
2381 <pre class="doc_code">
2382   %A = or %X, undef
2383   %B = and %X, undef
2384 Safe:
2385   %A = -1
2386   %B = 0
2387 Unsafe:
2388   %A = undef
2389   %B = undef
2390 </pre>
2391
2392 <p>These logical operations have bits that are not always affected by the input.
2393    For example, if <tt>%X</tt> has a zero bit, then the output of the
2394    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2395    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2396    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2397    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2398    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2399    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2400    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2401
2402 <pre class="doc_code">
2403   %A = select undef, %X, %Y
2404   %B = select undef, 42, %Y
2405   %C = select %X, %Y, undef
2406 Safe:
2407   %A = %X     (or %Y)
2408   %B = 42     (or %Y)
2409   %C = %Y
2410 Unsafe:
2411   %A = undef
2412   %B = undef
2413   %C = undef
2414 </pre>
2415
2416 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2417    branch) conditions can go <em>either way</em>, but they have to come from one
2418    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2419    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2420    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2421    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2422    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2423    eliminated.</p>
2424
2425 <pre class="doc_code">
2426   %A = xor undef, undef
2427
2428   %B = undef
2429   %C = xor %B, %B
2430
2431   %D = undef
2432   %E = icmp lt %D, 4
2433   %F = icmp gte %D, 4
2434
2435 Safe:
2436   %A = undef
2437   %B = undef
2438   %C = undef
2439   %D = undef
2440   %E = undef
2441   %F = undef
2442 </pre>
2443
2444 <p>This example points out that two '<tt>undef</tt>' operands are not
2445    necessarily the same. This can be surprising to people (and also matches C
2446    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2447    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2448    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2449    its value over its "live range".  This is true because the variable doesn't
2450    actually <em>have a live range</em>. Instead, the value is logically read
2451    from arbitrary registers that happen to be around when needed, so the value
2452    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2453    need to have the same semantics or the core LLVM "replace all uses with"
2454    concept would not hold.</p>
2455
2456 <pre class="doc_code">
2457   %A = fdiv undef, %X
2458   %B = fdiv %X, undef
2459 Safe:
2460   %A = undef
2461 b: unreachable
2462 </pre>
2463
2464 <p>These examples show the crucial difference between an <em>undefined
2465   value</em> and <em>undefined behavior</em>. An undefined value (like
2466   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2467   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2468   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2469   defined on SNaN's. However, in the second example, we can make a more
2470   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2471   arbitrary value, we are allowed to assume that it could be zero. Since a
2472   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2473   the operation does not execute at all. This allows us to delete the divide and
2474   all code after it. Because the undefined operation "can't happen", the
2475   optimizer can assume that it occurs in dead code.</p>
2476
2477 <pre class="doc_code">
2478 a:  store undef -> %X
2479 b:  store %X -> undef
2480 Safe:
2481 a: &lt;deleted&gt;
2482 b: unreachable
2483 </pre>
2484
2485 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2486    undefined value can be assumed to not have any effect; we can assume that the
2487    value is overwritten with bits that happen to match what was already there.
2488    However, a store <em>to</em> an undefined location could clobber arbitrary
2489    memory, therefore, it has undefined behavior.</p>
2490
2491 </div>
2492
2493 <!-- ======================================================================= -->
2494 <h3>
2495   <a name="trapvalues">Trap Values</a>
2496 </h3>
2497
2498 <div>
2499
2500 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2501    instead of representing an unspecified bit pattern, they represent the
2502    fact that an instruction or constant expression which cannot evoke side
2503    effects has nevertheless detected a condition which results in undefined
2504    behavior.</p>
2505
2506 <p>There is currently no way of representing a trap value in the IR; they
2507    only exist when produced by operations such as
2508    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2509
2510 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2511
2512 <ul>
2513 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2514     their operands.</li>
2515
2516 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2517     to their dynamic predecessor basic block.</li>
2518
2519 <li>Function arguments depend on the corresponding actual argument values in
2520     the dynamic callers of their functions.</li>
2521
2522 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2523     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2524     control back to them.</li>
2525
2526 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2527     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2528     or exception-throwing call instructions that dynamically transfer control
2529     back to them.</li>
2530
2531 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2532     referenced memory addresses, following the order in the IR
2533     (including loads and stores implied by intrinsics such as
2534     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2535
2536 <!-- TODO: In the case of multiple threads, this only applies if the store
2537      "happens-before" the load or store. -->
2538
2539 <!-- TODO: floating-point exception state -->
2540
2541 <li>An instruction with externally visible side effects depends on the most
2542     recent preceding instruction with externally visible side effects, following
2543     the order in the IR. (This includes
2544     <a href="#volatile">volatile operations</a>.)</li>
2545
2546 <li>An instruction <i>control-depends</i> on a
2547     <a href="#terminators">terminator instruction</a>
2548     if the terminator instruction has multiple successors and the instruction
2549     is always executed when control transfers to one of the successors, and
2550     may not be executed when control is transferred to another.</li>
2551
2552 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2553     instruction if the set of instructions it otherwise depends on would be
2554     different if the terminator had transferred control to a different
2555     successor.</li>
2556
2557 <li>Dependence is transitive.</li>
2558
2559 </ul>
2560
2561 <p>Whenever a trap value is generated, all values which depend on it evaluate
2562    to trap. If they have side effects, the evoke their side effects as if each
2563    operand with a trap value were undef. If they have externally-visible side
2564    effects, the behavior is undefined.</p>
2565
2566 <p>Here are some examples:</p>
2567
2568 <pre class="doc_code">
2569 entry:
2570   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2571   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2572   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2573   store i32 0, i32* %trap_yet_again  ; undefined behavior
2574
2575   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2576   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2577
2578   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2579
2580   %narrowaddr = bitcast i32* @g to i16*
2581   %wideaddr = bitcast i32* @g to i64*
2582   %trap3 = load i16* %narrowaddr     ; Returns a trap value.
2583   %trap4 = load i64* %wideaddr       ; Returns a trap value.
2584
2585   %cmp = icmp slt i32 %trap, 0       ; Returns a trap value.
2586   br i1 %cmp, label %true, label %end ; Branch to either destination.
2587
2588 true:
2589   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2590                                      ; it has undefined behavior.
2591   br label %end
2592
2593 end:
2594   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2595                                      ; Both edges into this PHI are
2596                                      ; control-dependent on %cmp, so this
2597                                      ; always results in a trap value.
2598
2599   volatile store i32 0, i32* @g      ; This would depend on the store in %true
2600                                      ; if %cmp is true, or the store in %entry
2601                                      ; otherwise, so this is undefined behavior.
2602
2603   br i1 %cmp, label %second_true, label %second_end
2604                                      ; The same branch again, but this time the
2605                                      ; true block doesn't have side effects.
2606
2607 second_true:
2608   ; No side effects!
2609   ret void
2610
2611 second_end:
2612   volatile store i32 0, i32* @g      ; This time, the instruction always depends
2613                                      ; on the store in %end. Also, it is
2614                                      ; control-equivalent to %end, so this is
2615                                      ; well-defined (again, ignoring earlier
2616                                      ; undefined behavior in this example).
2617 </pre>
2618
2619 </div>
2620
2621 <!-- ======================================================================= -->
2622 <h3>
2623   <a name="blockaddress">Addresses of Basic Blocks</a>
2624 </h3>
2625
2626 <div>
2627
2628 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2629
2630 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2631    basic block in the specified function, and always has an i8* type.  Taking
2632    the address of the entry block is illegal.</p>
2633
2634 <p>This value only has defined behavior when used as an operand to the
2635    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2636    comparisons against null. Pointer equality tests between labels addresses
2637    results in undefined behavior &mdash; though, again, comparison against null
2638    is ok, and no label is equal to the null pointer. This may be passed around
2639    as an opaque pointer sized value as long as the bits are not inspected. This
2640    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2641    long as the original value is reconstituted before the <tt>indirectbr</tt>
2642    instruction.</p>
2643
2644 <p>Finally, some targets may provide defined semantics when using the value as
2645    the operand to an inline assembly, but that is target specific.</p>
2646
2647 </div>
2648
2649
2650 <!-- ======================================================================= -->
2651 <h3>
2652   <a name="constantexprs">Constant Expressions</a>
2653 </h3>
2654
2655 <div>
2656
2657 <p>Constant expressions are used to allow expressions involving other constants
2658    to be used as constants.  Constant expressions may be of
2659    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2660    operation that does not have side effects (e.g. load and call are not
2661    supported). The following is the syntax for constant expressions:</p>
2662
2663 <dl>
2664   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2665   <dd>Truncate a constant to another type. The bit size of CST must be larger
2666       than the bit size of TYPE. Both types must be integers.</dd>
2667
2668   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2669   <dd>Zero extend a constant to another type. The bit size of CST must be
2670       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2671
2672   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2673   <dd>Sign extend a constant to another type. The bit size of CST must be
2674       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2675
2676   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2677   <dd>Truncate a floating point constant to another floating point type. The
2678       size of CST must be larger than the size of TYPE. Both types must be
2679       floating point.</dd>
2680
2681   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2682   <dd>Floating point extend a constant to another type. The size of CST must be
2683       smaller or equal to the size of TYPE. Both types must be floating
2684       point.</dd>
2685
2686   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2687   <dd>Convert a floating point constant to the corresponding unsigned integer
2688       constant. TYPE must be a scalar or vector integer type. CST must be of
2689       scalar or vector floating point type. Both CST and TYPE must be scalars,
2690       or vectors of the same number of elements. If the value won't fit in the
2691       integer type, the results are undefined.</dd>
2692
2693   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2694   <dd>Convert a floating point constant to the corresponding signed integer
2695       constant.  TYPE must be a scalar or vector integer type. CST must be of
2696       scalar or vector floating point type. Both CST and TYPE must be scalars,
2697       or vectors of the same number of elements. If the value won't fit in the
2698       integer type, the results are undefined.</dd>
2699
2700   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2701   <dd>Convert an unsigned integer constant to the corresponding floating point
2702       constant. TYPE must be a scalar or vector floating point type. CST must be
2703       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2704       vectors of the same number of elements. If the value won't fit in the
2705       floating point type, the results are undefined.</dd>
2706
2707   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2708   <dd>Convert a signed integer constant to the corresponding floating point
2709       constant. TYPE must be a scalar or vector floating point type. CST must be
2710       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2711       vectors of the same number of elements. If the value won't fit in the
2712       floating point type, the results are undefined.</dd>
2713
2714   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2715   <dd>Convert a pointer typed constant to the corresponding integer constant
2716       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2717       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2718       make it fit in <tt>TYPE</tt>.</dd>
2719
2720   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2721   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2722       type.  CST must be of integer type. The CST value is zero extended,
2723       truncated, or unchanged to make it fit in a pointer size. This one is
2724       <i>really</i> dangerous!</dd>
2725
2726   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2727   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2728       are the same as those for the <a href="#i_bitcast">bitcast
2729       instruction</a>.</dd>
2730
2731   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2732   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2733   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2734       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2735       instruction, the index list may have zero or more indexes, which are
2736       required to make sense for the type of "CSTPTR".</dd>
2737
2738   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2739   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2740
2741   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2742   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2743
2744   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2745   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2746
2747   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2748   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2749       constants.</dd>
2750
2751   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2752   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2753     constants.</dd>
2754
2755   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2756   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2757       constants.</dd>
2758
2759   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2760   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2761     constants. The index list is interpreted in a similar manner as indices in
2762     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2763     index value must be specified.</dd>
2764
2765   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2766   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2767     constants. The index list is interpreted in a similar manner as indices in
2768     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2769     index value must be specified.</dd>
2770
2771   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2772   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2773       be any of the <a href="#binaryops">binary</a>
2774       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2775       on operands are the same as those for the corresponding instruction
2776       (e.g. no bitwise operations on floating point values are allowed).</dd>
2777 </dl>
2778
2779 </div>
2780
2781 </div>
2782
2783 <!-- *********************************************************************** -->
2784 <h2><a name="othervalues">Other Values</a></h2>
2785 <!-- *********************************************************************** -->
2786 <div>
2787 <!-- ======================================================================= -->
2788 <h3>
2789 <a name="inlineasm">Inline Assembler Expressions</a>
2790 </h3>
2791
2792 <div>
2793
2794 <p>LLVM supports inline assembler expressions (as opposed
2795    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2796    a special value.  This value represents the inline assembler as a string
2797    (containing the instructions to emit), a list of operand constraints (stored
2798    as a string), a flag that indicates whether or not the inline asm
2799    expression has side effects, and a flag indicating whether the function
2800    containing the asm needs to align its stack conservatively.  An example
2801    inline assembler expression is:</p>
2802
2803 <pre class="doc_code">
2804 i32 (i32) asm "bswap $0", "=r,r"
2805 </pre>
2806
2807 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2808    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2809    have:</p>
2810
2811 <pre class="doc_code">
2812 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2813 </pre>
2814
2815 <p>Inline asms with side effects not visible in the constraint list must be
2816    marked as having side effects.  This is done through the use of the
2817    '<tt>sideeffect</tt>' keyword, like so:</p>
2818
2819 <pre class="doc_code">
2820 call void asm sideeffect "eieio", ""()
2821 </pre>
2822
2823 <p>In some cases inline asms will contain code that will not work unless the
2824    stack is aligned in some way, such as calls or SSE instructions on x86,
2825    yet will not contain code that does that alignment within the asm.
2826    The compiler should make conservative assumptions about what the asm might
2827    contain and should generate its usual stack alignment code in the prologue
2828    if the '<tt>alignstack</tt>' keyword is present:</p>
2829
2830 <pre class="doc_code">
2831 call void asm alignstack "eieio", ""()
2832 </pre>
2833
2834 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2835    first.</p>
2836
2837 <p>TODO: The format of the asm and constraints string still need to be
2838    documented here.  Constraints on what can be done (e.g. duplication, moving,
2839    etc need to be documented).  This is probably best done by reference to
2840    another document that covers inline asm from a holistic perspective.</p>
2841
2842 <h4>
2843 <a name="inlineasm_md">Inline Asm Metadata</a>
2844 </h4>
2845
2846 <div>
2847
2848 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2849    attached to it that contains a list of constant integers.  If present, the
2850   code generator will use the integer as the location cookie value when report
2851    errors through the LLVMContext error reporting mechanisms.  This allows a
2852    front-end to correlate backend errors that occur with inline asm back to the
2853    source code that produced it.  For example:</p>
2854
2855 <pre class="doc_code">
2856 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2857 ...
2858 !42 = !{ i32 1234567 }
2859 </pre>
2860
2861 <p>It is up to the front-end to make sense of the magic numbers it places in the
2862    IR.  If the MDNode contains multiple constants, the code generator will use
2863    the one that corresponds to the line of the asm that the error occurs on.</p>
2864
2865 </div>
2866
2867 </div>
2868
2869 <!-- ======================================================================= -->
2870 <h3>
2871   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2872 </h3>
2873
2874 <div>
2875
2876 <p>LLVM IR allows metadata to be attached to instructions in the program that
2877    can convey extra information about the code to the optimizers and code
2878    generator.  One example application of metadata is source-level debug
2879    information.  There are two metadata primitives: strings and nodes. All
2880    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2881    preceding exclamation point ('<tt>!</tt>').</p>
2882
2883 <p>A metadata string is a string surrounded by double quotes.  It can contain
2884    any character by escaping non-printable characters with "\xx" where "xx" is
2885    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2886
2887 <p>Metadata nodes are represented with notation similar to structure constants
2888    (a comma separated list of elements, surrounded by braces and preceded by an
2889    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2890    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2891
2892 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2893    metadata nodes, which can be looked up in the module symbol table. For
2894    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2895
2896 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2897    function is using two metadata arguments.</p>
2898
2899 <div class="doc_code">
2900 <pre>
2901 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2902 </pre>
2903 </div>
2904
2905 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2906    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2907
2908 <div class="doc_code">
2909 <pre>
2910 %indvar.next = add i64 %indvar, 1, !dbg !21
2911 </pre>
2912 </div>
2913
2914 </div>
2915
2916 </div>
2917
2918 <!-- *********************************************************************** -->
2919 <h2>
2920   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2921 </h2>
2922 <!-- *********************************************************************** -->
2923 <div>
2924 <p>LLVM has a number of "magic" global variables that contain data that affect
2925 code generation or other IR semantics.  These are documented here.  All globals
2926 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2927 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2928 by LLVM.</p>
2929
2930 <!-- ======================================================================= -->
2931 <h3>
2932 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2933 </h3>
2934
2935 <div>
2936
2937 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2938 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2939 pointers to global variables and functions which may optionally have a pointer
2940 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2941
2942 <pre>
2943   @X = global i8 4
2944   @Y = global i32 123
2945
2946   @llvm.used = appending global [2 x i8*] [
2947      i8* @X,
2948      i8* bitcast (i32* @Y to i8*)
2949   ], section "llvm.metadata"
2950 </pre>
2951
2952 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2953 compiler, assembler, and linker are required to treat the symbol as if there is
2954 a reference to the global that it cannot see.  For example, if a variable has
2955 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2956 list, it cannot be deleted.  This is commonly used to represent references from
2957 inline asms and other things the compiler cannot "see", and corresponds to
2958 "attribute((used))" in GNU C.</p>
2959
2960 <p>On some targets, the code generator must emit a directive to the assembler or
2961 object file to prevent the assembler and linker from molesting the symbol.</p>
2962
2963 </div>
2964
2965 <!-- ======================================================================= -->
2966 <h3>
2967   <a name="intg_compiler_used">
2968     The '<tt>llvm.compiler.used</tt>' Global Variable
2969   </a>
2970 </h3>
2971
2972 <div>
2973
2974 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2975 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2976 touching the symbol.  On targets that support it, this allows an intelligent
2977 linker to optimize references to the symbol without being impeded as it would be
2978 by <tt>@llvm.used</tt>.</p>
2979
2980 <p>This is a rare construct that should only be used in rare circumstances, and
2981 should not be exposed to source languages.</p>
2982
2983 </div>
2984
2985 <!-- ======================================================================= -->
2986 <h3>
2987 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2988 </h3>
2989
2990 <div>
2991 <pre>
2992 %0 = type { i32, void ()* }
2993 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2994 </pre>
2995 <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.
2996 </p>
2997
2998 </div>
2999
3000 <!-- ======================================================================= -->
3001 <h3>
3002 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
3003 </h3>
3004
3005 <div>
3006 <pre>
3007 %0 = type { i32, void ()* }
3008 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
3009 </pre>
3010
3011 <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.
3012 </p>
3013
3014 </div>
3015
3016 </div>
3017
3018 <!-- *********************************************************************** -->
3019 <h2><a name="instref">Instruction Reference</a></h2>
3020 <!-- *********************************************************************** -->
3021
3022 <div>
3023
3024 <p>The LLVM instruction set consists of several different classifications of
3025    instructions: <a href="#terminators">terminator
3026    instructions</a>, <a href="#binaryops">binary instructions</a>,
3027    <a href="#bitwiseops">bitwise binary instructions</a>,
3028    <a href="#memoryops">memory instructions</a>, and
3029    <a href="#otherops">other instructions</a>.</p>
3030
3031 <!-- ======================================================================= -->
3032 <h3>
3033   <a name="terminators">Terminator Instructions</a>
3034 </h3>
3035
3036 <div>
3037
3038 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3039    in a program ends with a "Terminator" instruction, which indicates which
3040    block should be executed after the current block is finished. These
3041    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3042    control flow, not values (the one exception being the
3043    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3044
3045 <p>The terminator instructions are:
3046    '<a href="#i_ret"><tt>ret</tt></a>',
3047    '<a href="#i_br"><tt>br</tt></a>',
3048    '<a href="#i_switch"><tt>switch</tt></a>',
3049    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3050    '<a href="#i_invoke"><tt>invoke</tt></a>',
3051    '<a href="#i_unwind"><tt>unwind</tt></a>',
3052    '<a href="#i_resume"><tt>resume</tt></a>', and
3053    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3054
3055 <!-- _______________________________________________________________________ -->
3056 <h4>
3057   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3058 </h4>
3059
3060 <div>
3061
3062 <h5>Syntax:</h5>
3063 <pre>
3064   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3065   ret void                 <i>; Return from void function</i>
3066 </pre>
3067
3068 <h5>Overview:</h5>
3069 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3070    a value) from a function back to the caller.</p>
3071
3072 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3073    value and then causes control flow, and one that just causes control flow to
3074    occur.</p>
3075
3076 <h5>Arguments:</h5>
3077 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3078    return value. The type of the return value must be a
3079    '<a href="#t_firstclass">first class</a>' type.</p>
3080
3081 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3082    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3083    value or a return value with a type that does not match its type, or if it
3084    has a void return type and contains a '<tt>ret</tt>' instruction with a
3085    return value.</p>
3086
3087 <h5>Semantics:</h5>
3088 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3089    the calling function's context.  If the caller is a
3090    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3091    instruction after the call.  If the caller was an
3092    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3093    the beginning of the "normal" destination block.  If the instruction returns
3094    a value, that value shall set the call or invoke instruction's return
3095    value.</p>
3096
3097 <h5>Example:</h5>
3098 <pre>
3099   ret i32 5                       <i>; Return an integer value of 5</i>
3100   ret void                        <i>; Return from a void function</i>
3101   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3102 </pre>
3103
3104 </div>
3105 <!-- _______________________________________________________________________ -->
3106 <h4>
3107   <a name="i_br">'<tt>br</tt>' Instruction</a>
3108 </h4>
3109
3110 <div>
3111
3112 <h5>Syntax:</h5>
3113 <pre>
3114   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3115   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3116 </pre>
3117
3118 <h5>Overview:</h5>
3119 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3120    different basic block in the current function.  There are two forms of this
3121    instruction, corresponding to a conditional branch and an unconditional
3122    branch.</p>
3123
3124 <h5>Arguments:</h5>
3125 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3126    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3127    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3128    target.</p>
3129
3130 <h5>Semantics:</h5>
3131 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3132    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3133    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3134    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3135
3136 <h5>Example:</h5>
3137 <pre>
3138 Test:
3139   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3140   br i1 %cond, label %IfEqual, label %IfUnequal
3141 IfEqual:
3142   <a href="#i_ret">ret</a> i32 1
3143 IfUnequal:
3144   <a href="#i_ret">ret</a> i32 0
3145 </pre>
3146
3147 </div>
3148
3149 <!-- _______________________________________________________________________ -->
3150 <h4>
3151    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3152 </h4>
3153
3154 <div>
3155
3156 <h5>Syntax:</h5>
3157 <pre>
3158   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3159 </pre>
3160
3161 <h5>Overview:</h5>
3162 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3163    several different places.  It is a generalization of the '<tt>br</tt>'
3164    instruction, allowing a branch to occur to one of many possible
3165    destinations.</p>
3166
3167 <h5>Arguments:</h5>
3168 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3169    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3170    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3171    The table is not allowed to contain duplicate constant entries.</p>
3172
3173 <h5>Semantics:</h5>
3174 <p>The <tt>switch</tt> instruction specifies a table of values and
3175    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3176    is searched for the given value.  If the value is found, control flow is
3177    transferred to the corresponding destination; otherwise, control flow is
3178    transferred to the default destination.</p>
3179
3180 <h5>Implementation:</h5>
3181 <p>Depending on properties of the target machine and the particular
3182    <tt>switch</tt> instruction, this instruction may be code generated in
3183    different ways.  For example, it could be generated as a series of chained
3184    conditional branches or with a lookup table.</p>
3185
3186 <h5>Example:</h5>
3187 <pre>
3188  <i>; Emulate a conditional br instruction</i>
3189  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3190  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3191
3192  <i>; Emulate an unconditional br instruction</i>
3193  switch i32 0, label %dest [ ]
3194
3195  <i>; Implement a jump table:</i>
3196  switch i32 %val, label %otherwise [ i32 0, label %onzero
3197                                      i32 1, label %onone
3198                                      i32 2, label %ontwo ]
3199 </pre>
3200
3201 </div>
3202
3203
3204 <!-- _______________________________________________________________________ -->
3205 <h4>
3206    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3207 </h4>
3208
3209 <div>
3210
3211 <h5>Syntax:</h5>
3212 <pre>
3213   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3214 </pre>
3215
3216 <h5>Overview:</h5>
3217
3218 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3219    within the current function, whose address is specified by
3220    "<tt>address</tt>".  Address must be derived from a <a
3221    href="#blockaddress">blockaddress</a> constant.</p>
3222
3223 <h5>Arguments:</h5>
3224
3225 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3226    rest of the arguments indicate the full set of possible destinations that the
3227    address may point to.  Blocks are allowed to occur multiple times in the
3228    destination list, though this isn't particularly useful.</p>
3229
3230 <p>This destination list is required so that dataflow analysis has an accurate
3231    understanding of the CFG.</p>
3232
3233 <h5>Semantics:</h5>
3234
3235 <p>Control transfers to the block specified in the address argument.  All
3236    possible destination blocks must be listed in the label list, otherwise this
3237    instruction has undefined behavior.  This implies that jumps to labels
3238    defined in other functions have undefined behavior as well.</p>
3239
3240 <h5>Implementation:</h5>
3241
3242 <p>This is typically implemented with a jump through a register.</p>
3243
3244 <h5>Example:</h5>
3245 <pre>
3246  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3247 </pre>
3248
3249 </div>
3250
3251
3252 <!-- _______________________________________________________________________ -->
3253 <h4>
3254   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3255 </h4>
3256
3257 <div>
3258
3259 <h5>Syntax:</h5>
3260 <pre>
3261   &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>]
3262                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3263 </pre>
3264
3265 <h5>Overview:</h5>
3266 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3267    function, with the possibility of control flow transfer to either the
3268    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3269    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3270    control flow will return to the "normal" label.  If the callee (or any
3271    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3272    instruction, control is interrupted and continued at the dynamically nearest
3273    "exception" label.</p>
3274
3275 <p>The '<tt>exception</tt>' label is a
3276    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3277    exception. As such, '<tt>exception</tt>' label is required to have the
3278    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3279    the information about about the behavior of the program after unwinding
3280    happens, as its first non-PHI instruction. The restrictions on the
3281    "<tt>landingpad</tt>" instruction's tightly couples it to the
3282    "<tt>invoke</tt>" instruction, so that the important information contained
3283    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3284    code motion.</p>
3285
3286 <h5>Arguments:</h5>
3287 <p>This instruction requires several arguments:</p>
3288
3289 <ol>
3290   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3291       convention</a> the call should use.  If none is specified, the call
3292       defaults to using C calling conventions.</li>
3293
3294   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3295       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3296       '<tt>inreg</tt>' attributes are valid here.</li>
3297
3298   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3299       function value being invoked.  In most cases, this is a direct function
3300       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3301       off an arbitrary pointer to function value.</li>
3302
3303   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3304       function to be invoked. </li>
3305
3306   <li>'<tt>function args</tt>': argument list whose types match the function
3307       signature argument types and parameter attributes. All arguments must be
3308       of <a href="#t_firstclass">first class</a> type. If the function
3309       signature indicates the function accepts a variable number of arguments,
3310       the extra arguments can be specified.</li>
3311
3312   <li>'<tt>normal label</tt>': the label reached when the called function
3313       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3314
3315   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3316       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3317
3318   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3319       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3320       '<tt>readnone</tt>' attributes are valid here.</li>
3321 </ol>
3322
3323 <h5>Semantics:</h5>
3324 <p>This instruction is designed to operate as a standard
3325    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3326    primary difference is that it establishes an association with a label, which
3327    is used by the runtime library to unwind the stack.</p>
3328
3329 <p>This instruction is used in languages with destructors to ensure that proper
3330    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3331    exception.  Additionally, this is important for implementation of
3332    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3333
3334 <p>For the purposes of the SSA form, the definition of the value returned by the
3335    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3336    block to the "normal" label. If the callee unwinds then no return value is
3337    available.</p>
3338
3339 <p>Note that the code generator does not yet completely support unwind, and
3340 that the invoke/unwind semantics are likely to change in future versions.</p>
3341
3342 <h5>Example:</h5>
3343 <pre>
3344   %retval = invoke i32 @Test(i32 15) to label %Continue
3345               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3346   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3347               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3348 </pre>
3349
3350 </div>
3351
3352 <!-- _______________________________________________________________________ -->
3353
3354 <h4>
3355   <a name="i_unwind">'<tt>unwind</tt>' Instruction</a>
3356 </h4>
3357
3358 <div>
3359
3360 <h5>Syntax:</h5>
3361 <pre>
3362   unwind
3363 </pre>
3364
3365 <h5>Overview:</h5>
3366 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3367    at the first callee in the dynamic call stack which used
3368    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3369    This is primarily used to implement exception handling.</p>
3370
3371 <h5>Semantics:</h5>
3372 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3373    immediately halt.  The dynamic call stack is then searched for the
3374    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3375    Once found, execution continues at the "exceptional" destination block
3376    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3377    instruction in the dynamic call chain, undefined behavior results.</p>
3378
3379 <p>Note that the code generator does not yet completely support unwind, and
3380 that the invoke/unwind semantics are likely to change in future versions.</p>
3381
3382 </div>
3383
3384  <!-- _______________________________________________________________________ -->
3385
3386 <h4>
3387   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3388 </h4>
3389
3390 <div>
3391
3392 <h5>Syntax:</h5>
3393 <pre>
3394   resume &lt;type&gt; &lt;value&gt;
3395 </pre>
3396
3397 <h5>Overview:</h5>
3398 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3399    successors.</p>
3400
3401 <h5>Arguments:</h5>
3402 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3403    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3404    function.</p>
3405
3406 <h5>Semantics:</h5>
3407 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3408    (in-flight) exception whose unwinding was interrupted with
3409    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3410
3411 <h5>Example:</h5>
3412 <pre>
3413   resume { i8*, i32 } %exn
3414 </pre>
3415
3416 </div>
3417
3418 <!-- _______________________________________________________________________ -->
3419
3420 <h4>
3421   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3422 </h4>
3423
3424 <div>
3425
3426 <h5>Syntax:</h5>
3427 <pre>
3428   unreachable
3429 </pre>
3430
3431 <h5>Overview:</h5>
3432 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3433    instruction is used to inform the optimizer that a particular portion of the
3434    code is not reachable.  This can be used to indicate that the code after a
3435    no-return function cannot be reached, and other facts.</p>
3436
3437 <h5>Semantics:</h5>
3438 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3439
3440 </div>
3441
3442 </div>
3443
3444 <!-- ======================================================================= -->
3445 <h3>
3446   <a name="binaryops">Binary Operations</a>
3447 </h3>
3448
3449 <div>
3450
3451 <p>Binary operators are used to do most of the computation in a program.  They
3452    require two operands of the same type, execute an operation on them, and
3453    produce a single value.  The operands might represent multiple data, as is
3454    the case with the <a href="#t_vector">vector</a> data type.  The result value
3455    has the same type as its operands.</p>
3456
3457 <p>There are several different binary operators:</p>
3458
3459 <!-- _______________________________________________________________________ -->
3460 <h4>
3461   <a name="i_add">'<tt>add</tt>' Instruction</a>
3462 </h4>
3463
3464 <div>
3465
3466 <h5>Syntax:</h5>
3467 <pre>
3468   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3469   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3470   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3471   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3472 </pre>
3473
3474 <h5>Overview:</h5>
3475 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3476
3477 <h5>Arguments:</h5>
3478 <p>The two arguments to the '<tt>add</tt>' instruction must
3479    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3480    integer values. Both arguments must have identical types.</p>
3481
3482 <h5>Semantics:</h5>
3483 <p>The value produced is the integer sum of the two operands.</p>
3484
3485 <p>If the sum has unsigned overflow, the result returned is the mathematical
3486    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3487
3488 <p>Because LLVM integers use a two's complement representation, this instruction
3489    is appropriate for both signed and unsigned integers.</p>
3490
3491 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3492    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3493    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3494    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3495    respectively, occurs.</p>
3496
3497 <h5>Example:</h5>
3498 <pre>
3499   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3500 </pre>
3501
3502 </div>
3503
3504 <!-- _______________________________________________________________________ -->
3505 <h4>
3506   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3507 </h4>
3508
3509 <div>
3510
3511 <h5>Syntax:</h5>
3512 <pre>
3513   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3514 </pre>
3515
3516 <h5>Overview:</h5>
3517 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3518
3519 <h5>Arguments:</h5>
3520 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3521    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3522    floating point values. Both arguments must have identical types.</p>
3523
3524 <h5>Semantics:</h5>
3525 <p>The value produced is the floating point sum of the two operands.</p>
3526
3527 <h5>Example:</h5>
3528 <pre>
3529   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3530 </pre>
3531
3532 </div>
3533
3534 <!-- _______________________________________________________________________ -->
3535 <h4>
3536    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3537 </h4>
3538
3539 <div>
3540
3541 <h5>Syntax:</h5>
3542 <pre>
3543   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3544   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3545   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3546   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3547 </pre>
3548
3549 <h5>Overview:</h5>
3550 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3551    operands.</p>
3552
3553 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3554    '<tt>neg</tt>' instruction present in most other intermediate
3555    representations.</p>
3556
3557 <h5>Arguments:</h5>
3558 <p>The two arguments to the '<tt>sub</tt>' instruction must
3559    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3560    integer values.  Both arguments must have identical types.</p>
3561
3562 <h5>Semantics:</h5>
3563 <p>The value produced is the integer difference of the two operands.</p>
3564
3565 <p>If the difference has unsigned overflow, the result returned is the
3566    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3567    result.</p>
3568
3569 <p>Because LLVM integers use a two's complement representation, this instruction
3570    is appropriate for both signed and unsigned integers.</p>
3571
3572 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3573    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3574    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3575    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3576    respectively, occurs.</p>
3577
3578 <h5>Example:</h5>
3579 <pre>
3580   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3581   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3582 </pre>
3583
3584 </div>
3585
3586 <!-- _______________________________________________________________________ -->
3587 <h4>
3588    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3589 </h4>
3590
3591 <div>
3592
3593 <h5>Syntax:</h5>
3594 <pre>
3595   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3596 </pre>
3597
3598 <h5>Overview:</h5>
3599 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3600    operands.</p>
3601
3602 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3603    '<tt>fneg</tt>' instruction present in most other intermediate
3604    representations.</p>
3605
3606 <h5>Arguments:</h5>
3607 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3608    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3609    floating point values.  Both arguments must have identical types.</p>
3610
3611 <h5>Semantics:</h5>
3612 <p>The value produced is the floating point difference of the two operands.</p>
3613
3614 <h5>Example:</h5>
3615 <pre>
3616   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3617   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3618 </pre>
3619
3620 </div>
3621
3622 <!-- _______________________________________________________________________ -->
3623 <h4>
3624   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3625 </h4>
3626
3627 <div>
3628
3629 <h5>Syntax:</h5>
3630 <pre>
3631   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3632   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3633   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3634   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3635 </pre>
3636
3637 <h5>Overview:</h5>
3638 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3639
3640 <h5>Arguments:</h5>
3641 <p>The two arguments to the '<tt>mul</tt>' instruction must
3642    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3643    integer values.  Both arguments must have identical types.</p>
3644
3645 <h5>Semantics:</h5>
3646 <p>The value produced is the integer product of the two operands.</p>
3647
3648 <p>If the result of the multiplication has unsigned overflow, the result
3649    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3650    width of the result.</p>
3651
3652 <p>Because LLVM integers use a two's complement representation, and the result
3653    is the same width as the operands, this instruction returns the correct
3654    result for both signed and unsigned integers.  If a full product
3655    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3656    be sign-extended or zero-extended as appropriate to the width of the full
3657    product.</p>
3658
3659 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3660    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3661    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3662    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3663    respectively, occurs.</p>
3664
3665 <h5>Example:</h5>
3666 <pre>
3667   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3668 </pre>
3669
3670 </div>
3671
3672 <!-- _______________________________________________________________________ -->
3673 <h4>
3674   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3675 </h4>
3676
3677 <div>
3678
3679 <h5>Syntax:</h5>
3680 <pre>
3681   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3682 </pre>
3683
3684 <h5>Overview:</h5>
3685 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3686
3687 <h5>Arguments:</h5>
3688 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3689    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3690    floating point values.  Both arguments must have identical types.</p>
3691
3692 <h5>Semantics:</h5>
3693 <p>The value produced is the floating point product of the two operands.</p>
3694
3695 <h5>Example:</h5>
3696 <pre>
3697   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3698 </pre>
3699
3700 </div>
3701
3702 <!-- _______________________________________________________________________ -->
3703 <h4>
3704   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
3705 </h4>
3706
3707 <div>
3708
3709 <h5>Syntax:</h5>
3710 <pre>
3711   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3712   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3713 </pre>
3714
3715 <h5>Overview:</h5>
3716 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3717
3718 <h5>Arguments:</h5>
3719 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3720    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3721    values.  Both arguments must have identical types.</p>
3722
3723 <h5>Semantics:</h5>
3724 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3725
3726 <p>Note that unsigned integer division and signed integer division are distinct
3727    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3728
3729 <p>Division by zero leads to undefined behavior.</p>
3730
3731 <p>If the <tt>exact</tt> keyword is present, the result value of the
3732    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3733   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3734
3735
3736 <h5>Example:</h5>
3737 <pre>
3738   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3739 </pre>
3740
3741 </div>
3742
3743 <!-- _______________________________________________________________________ -->
3744 <h4>
3745   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
3746 </h4>
3747
3748 <div>
3749
3750 <h5>Syntax:</h5>
3751 <pre>
3752   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3753   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3754 </pre>
3755
3756 <h5>Overview:</h5>
3757 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3758
3759 <h5>Arguments:</h5>
3760 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3761    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3762    values.  Both arguments must have identical types.</p>
3763
3764 <h5>Semantics:</h5>
3765 <p>The value produced is the signed integer quotient of the two operands rounded
3766    towards zero.</p>
3767
3768 <p>Note that signed integer division and unsigned integer division are distinct
3769    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3770
3771 <p>Division by zero leads to undefined behavior. Overflow also leads to
3772    undefined behavior; this is a rare case, but can occur, for example, by doing
3773    a 32-bit division of -2147483648 by -1.</p>
3774
3775 <p>If the <tt>exact</tt> keyword is present, the result value of the
3776    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3777    be rounded.</p>
3778
3779 <h5>Example:</h5>
3780 <pre>
3781   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3782 </pre>
3783
3784 </div>
3785
3786 <!-- _______________________________________________________________________ -->
3787 <h4>
3788   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
3789 </h4>
3790
3791 <div>
3792
3793 <h5>Syntax:</h5>
3794 <pre>
3795   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3796 </pre>
3797
3798 <h5>Overview:</h5>
3799 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3800
3801 <h5>Arguments:</h5>
3802 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3803    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3804    floating point values.  Both arguments must have identical types.</p>
3805
3806 <h5>Semantics:</h5>
3807 <p>The value produced is the floating point quotient of the two operands.</p>
3808
3809 <h5>Example:</h5>
3810 <pre>
3811   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3812 </pre>
3813
3814 </div>
3815
3816 <!-- _______________________________________________________________________ -->
3817 <h4>
3818   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3819 </h4>
3820
3821 <div>
3822
3823 <h5>Syntax:</h5>
3824 <pre>
3825   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3826 </pre>
3827
3828 <h5>Overview:</h5>
3829 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3830    division of its two arguments.</p>
3831
3832 <h5>Arguments:</h5>
3833 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3834    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3835    values.  Both arguments must have identical types.</p>
3836
3837 <h5>Semantics:</h5>
3838 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3839    This instruction always performs an unsigned division to get the
3840    remainder.</p>
3841
3842 <p>Note that unsigned integer remainder and signed integer remainder are
3843    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3844
3845 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3846
3847 <h5>Example:</h5>
3848 <pre>
3849   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3850 </pre>
3851
3852 </div>
3853
3854 <!-- _______________________________________________________________________ -->
3855 <h4>
3856   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3857 </h4>
3858
3859 <div>
3860
3861 <h5>Syntax:</h5>
3862 <pre>
3863   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3864 </pre>
3865
3866 <h5>Overview:</h5>
3867 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3868    division of its two operands. This instruction can also take
3869    <a href="#t_vector">vector</a> versions of the values in which case the
3870    elements must be integers.</p>
3871
3872 <h5>Arguments:</h5>
3873 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3874    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3875    values.  Both arguments must have identical types.</p>
3876
3877 <h5>Semantics:</h5>
3878 <p>This instruction returns the <i>remainder</i> of a division (where the result
3879    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3880    <i>modulo</i> operator (where the result is either zero or has the same sign
3881    as the divisor, <tt>op2</tt>) of a value.
3882    For more information about the difference,
3883    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3884    Math Forum</a>. For a table of how this is implemented in various languages,
3885    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3886    Wikipedia: modulo operation</a>.</p>
3887
3888 <p>Note that signed integer remainder and unsigned integer remainder are
3889    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3890
3891 <p>Taking the remainder of a division by zero leads to undefined behavior.
3892    Overflow also leads to undefined behavior; this is a rare case, but can
3893    occur, for example, by taking the remainder of a 32-bit division of
3894    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3895    lets srem be implemented using instructions that return both the result of
3896    the division and the remainder.)</p>
3897
3898 <h5>Example:</h5>
3899 <pre>
3900   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3901 </pre>
3902
3903 </div>
3904
3905 <!-- _______________________________________________________________________ -->
3906 <h4>
3907   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
3908 </h4>
3909
3910 <div>
3911
3912 <h5>Syntax:</h5>
3913 <pre>
3914   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3915 </pre>
3916
3917 <h5>Overview:</h5>
3918 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3919    its two operands.</p>
3920
3921 <h5>Arguments:</h5>
3922 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3923    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3924    floating point values.  Both arguments must have identical types.</p>
3925
3926 <h5>Semantics:</h5>
3927 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3928    has the same sign as the dividend.</p>
3929
3930 <h5>Example:</h5>
3931 <pre>
3932   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3933 </pre>
3934
3935 </div>
3936
3937 </div>
3938
3939 <!-- ======================================================================= -->
3940 <h3>
3941   <a name="bitwiseops">Bitwise Binary Operations</a>
3942 </h3>
3943
3944 <div>
3945
3946 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3947    program.  They are generally very efficient instructions and can commonly be
3948    strength reduced from other instructions.  They require two operands of the
3949    same type, execute an operation on them, and produce a single value.  The
3950    resulting value is the same type as its operands.</p>
3951
3952 <!-- _______________________________________________________________________ -->
3953 <h4>
3954   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
3955 </h4>
3956
3957 <div>
3958
3959 <h5>Syntax:</h5>
3960 <pre>
3961   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3962   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3963   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3964   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3965 </pre>
3966
3967 <h5>Overview:</h5>
3968 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3969    a specified number of bits.</p>
3970
3971 <h5>Arguments:</h5>
3972 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3973     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3974     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3975
3976 <h5>Semantics:</h5>
3977 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3978    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3979    is (statically or dynamically) negative or equal to or larger than the number
3980    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3981    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3982    shift amount in <tt>op2</tt>.</p>
3983
3984 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3985    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3986    the <tt>nsw</tt> keyword is present, then the shift produces a
3987    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3988    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3989    they would if the shift were expressed as a mul instruction with the same
3990    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3991
3992 <h5>Example:</h5>
3993 <pre>
3994   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3995   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3996   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3997   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3998   &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>
3999 </pre>
4000
4001 </div>
4002
4003 <!-- _______________________________________________________________________ -->
4004 <h4>
4005   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
4006 </h4>
4007
4008 <div>
4009
4010 <h5>Syntax:</h5>
4011 <pre>
4012   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4013   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4014 </pre>
4015
4016 <h5>Overview:</h5>
4017 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4018    operand shifted to the right a specified number of bits with zero fill.</p>
4019
4020 <h5>Arguments:</h5>
4021 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4022    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4023    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4024
4025 <h5>Semantics:</h5>
4026 <p>This instruction always performs a logical shift right operation. The most
4027    significant bits of the result will be filled with zero bits after the shift.
4028    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4029    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4030    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4031    shift amount in <tt>op2</tt>.</p>
4032
4033 <p>If the <tt>exact</tt> keyword is present, the result value of the
4034    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4035    shifted out are non-zero.</p>
4036
4037
4038 <h5>Example:</h5>
4039 <pre>
4040   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4041   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4042   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4043   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4044   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4045   &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>
4046 </pre>
4047
4048 </div>
4049
4050 <!-- _______________________________________________________________________ -->
4051 <h4>
4052   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4053 </h4>
4054
4055 <div>
4056
4057 <h5>Syntax:</h5>
4058 <pre>
4059   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4060   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4061 </pre>
4062
4063 <h5>Overview:</h5>
4064 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4065    operand shifted to the right a specified number of bits with sign
4066    extension.</p>
4067
4068 <h5>Arguments:</h5>
4069 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4070    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4071    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4072
4073 <h5>Semantics:</h5>
4074 <p>This instruction always performs an arithmetic shift right operation, The
4075    most significant bits of the result will be filled with the sign bit
4076    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4077    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4078    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4079    the corresponding shift amount in <tt>op2</tt>.</p>
4080
4081 <p>If the <tt>exact</tt> keyword is present, the result value of the
4082    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4083    shifted out are non-zero.</p>
4084
4085 <h5>Example:</h5>
4086 <pre>
4087   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4088   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4089   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4090   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4091   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4092   &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>
4093 </pre>
4094
4095 </div>
4096
4097 <!-- _______________________________________________________________________ -->
4098 <h4>
4099   <a name="i_and">'<tt>and</tt>' Instruction</a>
4100 </h4>
4101
4102 <div>
4103
4104 <h5>Syntax:</h5>
4105 <pre>
4106   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4107 </pre>
4108
4109 <h5>Overview:</h5>
4110 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4111    operands.</p>
4112
4113 <h5>Arguments:</h5>
4114 <p>The two arguments to the '<tt>and</tt>' instruction must be
4115    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4116    values.  Both arguments must have identical types.</p>
4117
4118 <h5>Semantics:</h5>
4119 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4120
4121 <table border="1" cellspacing="0" cellpadding="4">
4122   <tbody>
4123     <tr>
4124       <td>In0</td>
4125       <td>In1</td>
4126       <td>Out</td>
4127     </tr>
4128     <tr>
4129       <td>0</td>
4130       <td>0</td>
4131       <td>0</td>
4132     </tr>
4133     <tr>
4134       <td>0</td>
4135       <td>1</td>
4136       <td>0</td>
4137     </tr>
4138     <tr>
4139       <td>1</td>
4140       <td>0</td>
4141       <td>0</td>
4142     </tr>
4143     <tr>
4144       <td>1</td>
4145       <td>1</td>
4146       <td>1</td>
4147     </tr>
4148   </tbody>
4149 </table>
4150
4151 <h5>Example:</h5>
4152 <pre>
4153   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4154   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4155   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4156 </pre>
4157 </div>
4158 <!-- _______________________________________________________________________ -->
4159 <h4>
4160   <a name="i_or">'<tt>or</tt>' Instruction</a>
4161 </h4>
4162
4163 <div>
4164
4165 <h5>Syntax:</h5>
4166 <pre>
4167   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4168 </pre>
4169
4170 <h5>Overview:</h5>
4171 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4172    two operands.</p>
4173
4174 <h5>Arguments:</h5>
4175 <p>The two arguments to the '<tt>or</tt>' instruction must be
4176    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4177    values.  Both arguments must have identical types.</p>
4178
4179 <h5>Semantics:</h5>
4180 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4181
4182 <table border="1" cellspacing="0" cellpadding="4">
4183   <tbody>
4184     <tr>
4185       <td>In0</td>
4186       <td>In1</td>
4187       <td>Out</td>
4188     </tr>
4189     <tr>
4190       <td>0</td>
4191       <td>0</td>
4192       <td>0</td>
4193     </tr>
4194     <tr>
4195       <td>0</td>
4196       <td>1</td>
4197       <td>1</td>
4198     </tr>
4199     <tr>
4200       <td>1</td>
4201       <td>0</td>
4202       <td>1</td>
4203     </tr>
4204     <tr>
4205       <td>1</td>
4206       <td>1</td>
4207       <td>1</td>
4208     </tr>
4209   </tbody>
4210 </table>
4211
4212 <h5>Example:</h5>
4213 <pre>
4214   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4215   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4216   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4217 </pre>
4218
4219 </div>
4220
4221 <!-- _______________________________________________________________________ -->
4222 <h4>
4223   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4224 </h4>
4225
4226 <div>
4227
4228 <h5>Syntax:</h5>
4229 <pre>
4230   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4231 </pre>
4232
4233 <h5>Overview:</h5>
4234 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4235    its two operands.  The <tt>xor</tt> is used to implement the "one's
4236    complement" operation, which is the "~" operator in C.</p>
4237
4238 <h5>Arguments:</h5>
4239 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4240    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4241    values.  Both arguments must have identical types.</p>
4242
4243 <h5>Semantics:</h5>
4244 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4245
4246 <table border="1" cellspacing="0" cellpadding="4">
4247   <tbody>
4248     <tr>
4249       <td>In0</td>
4250       <td>In1</td>
4251       <td>Out</td>
4252     </tr>
4253     <tr>
4254       <td>0</td>
4255       <td>0</td>
4256       <td>0</td>
4257     </tr>
4258     <tr>
4259       <td>0</td>
4260       <td>1</td>
4261       <td>1</td>
4262     </tr>
4263     <tr>
4264       <td>1</td>
4265       <td>0</td>
4266       <td>1</td>
4267     </tr>
4268     <tr>
4269       <td>1</td>
4270       <td>1</td>
4271       <td>0</td>
4272     </tr>
4273   </tbody>
4274 </table>
4275
4276 <h5>Example:</h5>
4277 <pre>
4278   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4279   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4280   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4281   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4282 </pre>
4283
4284 </div>
4285
4286 </div>
4287
4288 <!-- ======================================================================= -->
4289 <h3>
4290   <a name="vectorops">Vector Operations</a>
4291 </h3>
4292
4293 <div>
4294
4295 <p>LLVM supports several instructions to represent vector operations in a
4296    target-independent manner.  These instructions cover the element-access and
4297    vector-specific operations needed to process vectors effectively.  While LLVM
4298    does directly support these vector operations, many sophisticated algorithms
4299    will want to use target-specific intrinsics to take full advantage of a
4300    specific target.</p>
4301
4302 <!-- _______________________________________________________________________ -->
4303 <h4>
4304    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4305 </h4>
4306
4307 <div>
4308
4309 <h5>Syntax:</h5>
4310 <pre>
4311   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4312 </pre>
4313
4314 <h5>Overview:</h5>
4315 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4316    from a vector at a specified index.</p>
4317
4318
4319 <h5>Arguments:</h5>
4320 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4321    of <a href="#t_vector">vector</a> type.  The second operand is an index
4322    indicating the position from which to extract the element.  The index may be
4323    a variable.</p>
4324
4325 <h5>Semantics:</h5>
4326 <p>The result is a scalar of the same type as the element type of
4327    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4328    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4329    results are undefined.</p>
4330
4331 <h5>Example:</h5>
4332 <pre>
4333   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4334 </pre>
4335
4336 </div>
4337
4338 <!-- _______________________________________________________________________ -->
4339 <h4>
4340    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4341 </h4>
4342
4343 <div>
4344
4345 <h5>Syntax:</h5>
4346 <pre>
4347   &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>
4348 </pre>
4349
4350 <h5>Overview:</h5>
4351 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4352    vector at a specified index.</p>
4353
4354 <h5>Arguments:</h5>
4355 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4356    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4357    whose type must equal the element type of the first operand.  The third
4358    operand is an index indicating the position at which to insert the value.
4359    The index may be a variable.</p>
4360
4361 <h5>Semantics:</h5>
4362 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4363    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4364    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4365    results are undefined.</p>
4366
4367 <h5>Example:</h5>
4368 <pre>
4369   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4370 </pre>
4371
4372 </div>
4373
4374 <!-- _______________________________________________________________________ -->
4375 <h4>
4376    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4377 </h4>
4378
4379 <div>
4380
4381 <h5>Syntax:</h5>
4382 <pre>
4383   &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>
4384 </pre>
4385
4386 <h5>Overview:</h5>
4387 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4388    from two input vectors, returning a vector with the same element type as the
4389    input and length that is the same as the shuffle mask.</p>
4390
4391 <h5>Arguments:</h5>
4392 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4393    with types that match each other. The third argument is a shuffle mask whose
4394    element type is always 'i32'.  The result of the instruction is a vector
4395    whose length is the same as the shuffle mask and whose element type is the
4396    same as the element type of the first two operands.</p>
4397
4398 <p>The shuffle mask operand is required to be a constant vector with either
4399    constant integer or undef values.</p>
4400
4401 <h5>Semantics:</h5>
4402 <p>The elements of the two input vectors are numbered from left to right across
4403    both of the vectors.  The shuffle mask operand specifies, for each element of
4404    the result vector, which element of the two input vectors the result element
4405    gets.  The element selector may be undef (meaning "don't care") and the
4406    second operand may be undef if performing a shuffle from only one vector.</p>
4407
4408 <h5>Example:</h5>
4409 <pre>
4410   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4411                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4412   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4413                           &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.
4414   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4415                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4416   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4417                           &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>
4418 </pre>
4419
4420 </div>
4421
4422 </div>
4423
4424 <!-- ======================================================================= -->
4425 <h3>
4426   <a name="aggregateops">Aggregate Operations</a>
4427 </h3>
4428
4429 <div>
4430
4431 <p>LLVM supports several instructions for working with
4432   <a href="#t_aggregate">aggregate</a> values.</p>
4433
4434 <!-- _______________________________________________________________________ -->
4435 <h4>
4436    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4437 </h4>
4438
4439 <div>
4440
4441 <h5>Syntax:</h5>
4442 <pre>
4443   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4444 </pre>
4445
4446 <h5>Overview:</h5>
4447 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4448    from an <a href="#t_aggregate">aggregate</a> value.</p>
4449
4450 <h5>Arguments:</h5>
4451 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4452    of <a href="#t_struct">struct</a> or
4453    <a href="#t_array">array</a> type.  The operands are constant indices to
4454    specify which value to extract in a similar manner as indices in a
4455    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4456    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4457      <ul>
4458        <li>Since the value being indexed is not a pointer, the first index is
4459            omitted and assumed to be zero.</li>
4460        <li>At least one index must be specified.</li>
4461        <li>Not only struct indices but also array indices must be in
4462            bounds.</li>
4463      </ul>
4464
4465 <h5>Semantics:</h5>
4466 <p>The result is the value at the position in the aggregate specified by the
4467    index operands.</p>
4468
4469 <h5>Example:</h5>
4470 <pre>
4471   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4472 </pre>
4473
4474 </div>
4475
4476 <!-- _______________________________________________________________________ -->
4477 <h4>
4478    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4479 </h4>
4480
4481 <div>
4482
4483 <h5>Syntax:</h5>
4484 <pre>
4485   &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>
4486 </pre>
4487
4488 <h5>Overview:</h5>
4489 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4490    in an <a href="#t_aggregate">aggregate</a> value.</p>
4491
4492 <h5>Arguments:</h5>
4493 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4494    of <a href="#t_struct">struct</a> or
4495    <a href="#t_array">array</a> type.  The second operand is a first-class
4496    value to insert.  The following operands are constant indices indicating
4497    the position at which to insert the value in a similar manner as indices in a
4498    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4499    value to insert must have the same type as the value identified by the
4500    indices.</p>
4501
4502 <h5>Semantics:</h5>
4503 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4504    that of <tt>val</tt> except that the value at the position specified by the
4505    indices is that of <tt>elt</tt>.</p>
4506
4507 <h5>Example:</h5>
4508 <pre>
4509   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4510   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4511   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4512 </pre>
4513
4514 </div>
4515
4516 </div>
4517
4518 <!-- ======================================================================= -->
4519 <h3>
4520   <a name="memoryops">Memory Access and Addressing Operations</a>
4521 </h3>
4522
4523 <div>
4524
4525 <p>A key design point of an SSA-based representation is how it represents
4526    memory.  In LLVM, no memory locations are in SSA form, which makes things
4527    very simple.  This section describes how to read, write, and allocate
4528    memory in LLVM.</p>
4529
4530 <!-- _______________________________________________________________________ -->
4531 <h4>
4532   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4533 </h4>
4534
4535 <div>
4536
4537 <h5>Syntax:</h5>
4538 <pre>
4539   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4540 </pre>
4541
4542 <h5>Overview:</h5>
4543 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4544    currently executing function, to be automatically released when this function
4545    returns to its caller. The object is always allocated in the generic address
4546    space (address space zero).</p>
4547
4548 <h5>Arguments:</h5>
4549 <p>The '<tt>alloca</tt>' instruction
4550    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4551    runtime stack, returning a pointer of the appropriate type to the program.
4552    If "NumElements" is specified, it is the number of elements allocated,
4553    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4554    specified, the value result of the allocation is guaranteed to be aligned to
4555    at least that boundary.  If not specified, or if zero, the target can choose
4556    to align the allocation on any convenient boundary compatible with the
4557    type.</p>
4558
4559 <p>'<tt>type</tt>' may be any sized type.</p>
4560
4561 <h5>Semantics:</h5>
4562 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4563    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4564    memory is automatically released when the function returns.  The
4565    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4566    variables that must have an address available.  When the function returns
4567    (either with the <tt><a href="#i_ret">ret</a></tt>
4568    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4569    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4570
4571 <h5>Example:</h5>
4572 <pre>
4573   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4574   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4575   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4576   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4577 </pre>
4578
4579 </div>
4580
4581 <!-- _______________________________________________________________________ -->
4582 <h4>
4583   <a name="i_load">'<tt>load</tt>' Instruction</a>
4584 </h4>
4585
4586 <div>
4587
4588 <h5>Syntax:</h5>
4589 <pre>
4590   &lt;result&gt; = load [volatile] &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4591   &lt;result&gt; = load atomic [volatile] &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4592   !&lt;index&gt; = !{ i32 1 }
4593 </pre>
4594
4595 <h5>Overview:</h5>
4596 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4597
4598 <h5>Arguments:</h5>
4599 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4600    from which to load.  The pointer must point to
4601    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4602    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4603    number or order of execution of this <tt>load</tt> with other <a
4604    href="#volatile">volatile operations</a>.</p>
4605
4606 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4607    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4608    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4609    not valid on <code>load</code> instructions.  Atomic loads produce <a
4610    href="#memorymodel">defined</a> results when they may see multiple atomic
4611    stores.  The type of the pointee must be an integer type whose bit width
4612    is a power of two greater than or equal to eight and less than or equal
4613    to a target-specific size limit. <code>align</code> must be explicitly
4614    specified on atomic loads, and the load has undefined behavior if the
4615    alignment is not set to a value which is at least the size in bytes of
4616    the pointee. <code>!nontemporal</code> does not have any defined semantics
4617    for atomic loads.</p>
4618
4619 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4620    operation (that is, the alignment of the memory address). A value of 0 or an
4621    omitted <tt>align</tt> argument means that the operation has the preferential
4622    alignment for the target. It is the responsibility of the code emitter to
4623    ensure that the alignment information is correct. Overestimating the
4624    alignment results in undefined behavior. Underestimating the alignment may
4625    produce less efficient code. An alignment of 1 is always safe.</p>
4626
4627 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4628    metatadata name &lt;index&gt; corresponding to a metadata node with
4629    one <tt>i32</tt> entry of value 1.  The existence of
4630    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4631    and code generator that this load is not expected to be reused in the cache.
4632    The code generator may select special instructions to save cache bandwidth,
4633    such as the <tt>MOVNT</tt> instruction on x86.</p>
4634
4635 <h5>Semantics:</h5>
4636 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4637    scalar type then the number of bytes read does not exceed the minimum number
4638    of bytes needed to hold all bits of the type.  For example, loading an
4639    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4640    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4641    is undefined if the value was not originally written using a store of the
4642    same type.</p>
4643
4644 <h5>Examples:</h5>
4645 <pre>
4646   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4647   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4648   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4649 </pre>
4650
4651 </div>
4652
4653 <!-- _______________________________________________________________________ -->
4654 <h4>
4655   <a name="i_store">'<tt>store</tt>' Instruction</a>
4656 </h4>
4657
4658 <div>
4659
4660 <h5>Syntax:</h5>
4661 <pre>
4662   store [volatile] &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]                   <i>; yields {void}</i>
4663   store atomic [volatile] &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;             <i>; yields {void}</i>
4664 </pre>
4665
4666 <h5>Overview:</h5>
4667 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4668
4669 <h5>Arguments:</h5>
4670 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4671    and an address at which to store it.  The type of the
4672    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4673    the <a href="#t_firstclass">first class</a> type of the
4674    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4675    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4676    order of execution of this <tt>store</tt> with other <a
4677    href="#volatile">volatile operations</a>.</p>
4678
4679 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
4680    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4681    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
4682    valid on <code>store</code> instructions.  Atomic loads produce <a
4683    href="#memorymodel">defined</a> results when they may see multiple atomic
4684    stores. The type of the pointee must be an integer type whose bit width
4685    is a power of two greater than or equal to eight and less than or equal
4686    to a target-specific size limit. <code>align</code> must be explicitly
4687    specified on atomic stores, and the store has undefined behavior if the
4688    alignment is not set to a value which is at least the size in bytes of
4689    the pointee. <code>!nontemporal</code> does not have any defined semantics
4690    for atomic stores.</p>
4691
4692 <p>The optional constant "align" argument specifies the alignment of the
4693    operation (that is, the alignment of the memory address). A value of 0 or an
4694    omitted "align" argument means that the operation has the preferential
4695    alignment for the target. It is the responsibility of the code emitter to
4696    ensure that the alignment information is correct. Overestimating the
4697    alignment results in an undefined behavior. Underestimating the alignment may
4698    produce less efficient code. An alignment of 1 is always safe.</p>
4699
4700 <p>The optional !nontemporal metadata must reference a single metatadata
4701    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4702    value 1.  The existence of the !nontemporal metatadata on the
4703    instruction tells the optimizer and code generator that this load is
4704    not expected to be reused in the cache.  The code generator may
4705    select special instructions to save cache bandwidth, such as the
4706    MOVNT instruction on x86.</p>
4707
4708
4709 <h5>Semantics:</h5>
4710 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4711    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4712    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4713    does not exceed the minimum number of bytes needed to hold all bits of the
4714    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4715    writing a value of a type like <tt>i20</tt> with a size that is not an
4716    integral number of bytes, it is unspecified what happens to the extra bits
4717    that do not belong to the type, but they will typically be overwritten.</p>
4718
4719 <h5>Example:</h5>
4720 <pre>
4721   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4722   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4723   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4724 </pre>
4725
4726 </div>
4727
4728 <!-- _______________________________________________________________________ -->
4729 <h4>
4730 <a name="i_fence">'<tt>fence</tt>' Instruction</a>
4731 </h4>
4732
4733 <div>
4734
4735 <h5>Syntax:</h5>
4736 <pre>
4737   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
4738 </pre>
4739
4740 <h5>Overview:</h5>
4741 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
4742 between operations.</p>
4743
4744 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
4745 href="#ordering">ordering</a> argument which defines what
4746 <i>synchronizes-with</i> edges they add.  They can only be given
4747 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
4748 <code>seq_cst</code> orderings.</p>
4749
4750 <h5>Semantics:</h5>
4751 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
4752 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
4753 <code>acquire</code> ordering semantics if and only if there exist atomic
4754 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
4755 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
4756 <var>X</var> modifies <var>M</var> (either directly or through some side effect
4757 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
4758 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
4759 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
4760 than an explicit <code>fence</code>, one (but not both) of the atomic operations
4761 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
4762 <code>acquire</code> (resp.) ordering constraint and still
4763 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
4764 <i>happens-before</i> edge.</p>
4765
4766 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
4767 having both <code>acquire</code> and <code>release</code> semantics specified
4768 above, participates in the global program order of other <code>seq_cst</code>
4769 operations and/or fences.</p>
4770
4771 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
4772 specifies that the fence only synchronizes with other fences in the same
4773 thread.  (This is useful for interacting with signal handlers.)</p>
4774
4775 <h5>Example:</h5>
4776 <pre>
4777   fence acquire                          <i>; yields {void}</i>
4778   fence singlethread seq_cst             <i>; yields {void}</i>
4779 </pre>
4780
4781 </div>
4782
4783 <!-- _______________________________________________________________________ -->
4784 <h4>
4785 <a name="i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a>
4786 </h4>
4787
4788 <div>
4789
4790 <h5>Syntax:</h5>
4791 <pre>
4792   cmpxchg [volatile] &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>
4793 </pre>
4794
4795 <h5>Overview:</h5>
4796 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
4797 It loads a value in memory and compares it to a given value. If they are
4798 equal, it stores a new value into the memory.</p>
4799
4800 <h5>Arguments:</h5>
4801 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
4802 address to operate on, a value to compare to the value currently be at that
4803 address, and a new value to place at that address if the compared values are
4804 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
4805 bit width is a power of two greater than or equal to eight and less than
4806 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
4807 '<var>&lt;new&gt;</var>' must have the same type, and the type of
4808 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
4809 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
4810 optimizer is not allowed to modify the number or order of execution
4811 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
4812 operations</a>.</p>
4813
4814 <!-- FIXME: Extend allowed types. -->
4815
4816 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
4817 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
4818
4819 <p>The optional "<code>singlethread</code>" argument declares that the
4820 <code>cmpxchg</code> is only atomic with respect to code (usually signal
4821 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
4822 cmpxchg is atomic with respect to all other code in the system.</p>
4823
4824 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
4825 the size in memory of the operand.
4826
4827 <h5>Semantics:</h5>
4828 <p>The contents of memory at the location specified by the
4829 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
4830 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
4831 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
4832 is returned.
4833
4834 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
4835 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
4836 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
4837 parameter determined by dropping any <code>release</code> part of the
4838 <code>cmpxchg</code>'s ordering.</p>
4839
4840 <!--
4841 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
4842 optimization work on ARM.)
4843
4844 FIXME: Is a weaker ordering constraint on failure helpful in practice?
4845 -->
4846
4847 <h5>Example:</h5>
4848 <pre>
4849 entry:
4850   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                       <i>; yields {i32}</i>
4851   <a href="#i_br">br</a> label %loop
4852
4853 loop:
4854   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
4855   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
4856   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared                       <i>; yields {i32}</i>
4857   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
4858   <a href="#i_br">br</a> i1 %success, label %done, label %loop
4859
4860 done:
4861   ...
4862 </pre>
4863
4864 </div>
4865
4866 <!-- _______________________________________________________________________ -->
4867 <h4>
4868 <a name="i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a>
4869 </h4>
4870
4871 <div>
4872
4873 <h5>Syntax:</h5>
4874 <pre>
4875   atomicrmw [volatile] &lt;operation&gt; &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;value&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4876 </pre>
4877
4878 <h5>Overview:</h5>
4879 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
4880
4881 <h5>Arguments:</h5>
4882 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
4883 operation to apply, an address whose value to modify, an argument to the
4884 operation.  The operation must be one of the following keywords:</p>
4885 <ul>
4886   <li>xchg</li>
4887   <li>add</li>
4888   <li>sub</li>
4889   <li>and</li>
4890   <li>nand</li>
4891   <li>or</li>
4892   <li>xor</li>
4893   <li>max</li>
4894   <li>min</li>
4895   <li>umax</li>
4896   <li>umin</li>
4897 </ul>
4898
4899 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
4900 bit width is a power of two greater than or equal to eight and less than
4901 or equal to a target-specific size limit.  The type of the
4902 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
4903 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
4904 optimizer is not allowed to modify the number or order of execution of this
4905 <code>atomicrmw</code> with other <a href="#volatile">volatile
4906   operations</a>.</p>
4907
4908 <!-- FIXME: Extend allowed types. -->
4909
4910 <h5>Semantics:</h5>
4911 <p>The contents of memory at the location specified by the
4912 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
4913 back.  The original value at the location is returned.  The modification is
4914 specified by the <var>operation</var> argument:</p>
4915
4916 <ul>
4917   <li>xchg: <code>*ptr = val</code></li>
4918   <li>add: <code>*ptr = *ptr + val</code></li>
4919   <li>sub: <code>*ptr = *ptr - val</code></li>
4920   <li>and: <code>*ptr = *ptr &amp; val</code></li>
4921   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
4922   <li>or: <code>*ptr = *ptr | val</code></li>
4923   <li>xor: <code>*ptr = *ptr ^ val</code></li>
4924   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
4925   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
4926   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4927   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4928 </ul>
4929
4930 <h5>Example:</h5>
4931 <pre>
4932   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
4933 </pre>
4934
4935 </div>
4936
4937 <!-- _______________________________________________________________________ -->
4938 <h4>
4939    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4940 </h4>
4941
4942 <div>
4943
4944 <h5>Syntax:</h5>
4945 <pre>
4946   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4947   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4948 </pre>
4949
4950 <h5>Overview:</h5>
4951 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4952    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4953    It performs address calculation only and does not access memory.</p>
4954
4955 <h5>Arguments:</h5>
4956 <p>The first argument is always a pointer, and forms the basis of the
4957    calculation. The remaining arguments are indices that indicate which of the
4958    elements of the aggregate object are indexed. The interpretation of each
4959    index is dependent on the type being indexed into. The first index always
4960    indexes the pointer value given as the first argument, the second index
4961    indexes a value of the type pointed to (not necessarily the value directly
4962    pointed to, since the first index can be non-zero), etc. The first type
4963    indexed into must be a pointer value, subsequent types can be arrays,
4964    vectors, and structs. Note that subsequent types being indexed into
4965    can never be pointers, since that would require loading the pointer before
4966    continuing calculation.</p>
4967
4968 <p>The type of each index argument depends on the type it is indexing into.
4969    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4970    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4971    or vector, integers of any width are allowed, and they are not required to be
4972    constant.  These integers are treated as signed values where relevant.</p>
4973
4974 <p>For example, let's consider a C code fragment and how it gets compiled to
4975    LLVM:</p>
4976
4977 <pre class="doc_code">
4978 struct RT {
4979   char A;
4980   int B[10][20];
4981   char C;
4982 };
4983 struct ST {
4984   int X;
4985   double Y;
4986   struct RT Z;
4987 };
4988
4989 int *foo(struct ST *s) {
4990   return &amp;s[1].Z.B[5][13];
4991 }
4992 </pre>
4993
4994 <p>The LLVM code generated by the GCC frontend is:</p>
4995
4996 <pre class="doc_code">
4997 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4998 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4999
5000 define i32* @foo(%ST* %s) {
5001 entry:
5002   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
5003   ret i32* %reg
5004 }
5005 </pre>
5006
5007 <h5>Semantics:</h5>
5008 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
5009    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
5010    }</tt>' type, a structure.  The second index indexes into the third element
5011    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
5012    i8 }</tt>' type, another structure.  The third index indexes into the second
5013    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
5014    array.  The two dimensions of the array are subscripted into, yielding an
5015    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
5016    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
5017
5018 <p>Note that it is perfectly legal to index partially through a structure,
5019    returning a pointer to an inner element.  Because of this, the LLVM code for
5020    the given testcase is equivalent to:</p>
5021
5022 <pre>
5023   define i32* @foo(%ST* %s) {
5024     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
5025     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
5026     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
5027     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5028     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5029     ret i32* %t5
5030   }
5031 </pre>
5032
5033 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5034    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
5035    base pointer is not an <i>in bounds</i> address of an allocated object,
5036    or if any of the addresses that would be formed by successive addition of
5037    the offsets implied by the indices to the base address with infinitely
5038    precise signed arithmetic are not an <i>in bounds</i> address of that
5039    allocated object. The <i>in bounds</i> addresses for an allocated object
5040    are all the addresses that point into the object, plus the address one
5041    byte past the end.</p>
5042
5043 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5044    the base address with silently-wrapping two's complement arithmetic. If the
5045    offsets have a different width from the pointer, they are sign-extended or
5046    truncated to the width of the pointer. The result value of the
5047    <tt>getelementptr</tt> may be outside the object pointed to by the base
5048    pointer. The result value may not necessarily be used to access memory
5049    though, even if it happens to point into allocated storage. See the
5050    <a href="#pointeraliasing">Pointer Aliasing Rules</a> section for more
5051    information.</p>
5052
5053 <p>The getelementptr instruction is often confusing.  For some more insight into
5054    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5055
5056 <h5>Example:</h5>
5057 <pre>
5058     <i>; yields [12 x i8]*:aptr</i>
5059     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5060     <i>; yields i8*:vptr</i>
5061     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5062     <i>; yields i8*:eptr</i>
5063     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5064     <i>; yields i32*:iptr</i>
5065     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5066 </pre>
5067
5068 </div>
5069
5070 </div>
5071
5072 <!-- ======================================================================= -->
5073 <h3>
5074   <a name="convertops">Conversion Operations</a>
5075 </h3>
5076
5077 <div>
5078
5079 <p>The instructions in this category are the conversion instructions (casting)
5080    which all take a single operand and a type. They perform various bit
5081    conversions on the operand.</p>
5082
5083 <!-- _______________________________________________________________________ -->
5084 <h4>
5085    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5086 </h4>
5087
5088 <div>
5089
5090 <h5>Syntax:</h5>
5091 <pre>
5092   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5093 </pre>
5094
5095 <h5>Overview:</h5>
5096 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5097    type <tt>ty2</tt>.</p>
5098
5099 <h5>Arguments:</h5>
5100 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5101    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5102    of the same number of integers.
5103    The bit size of the <tt>value</tt> must be larger than
5104    the bit size of the destination type, <tt>ty2</tt>.
5105    Equal sized types are not allowed.</p>
5106
5107 <h5>Semantics:</h5>
5108 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5109    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5110    source size must be larger than the destination size, <tt>trunc</tt> cannot
5111    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5112
5113 <h5>Example:</h5>
5114 <pre>
5115   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5116   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5117   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5118   %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>
5119 </pre>
5120
5121 </div>
5122
5123 <!-- _______________________________________________________________________ -->
5124 <h4>
5125    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5126 </h4>
5127
5128 <div>
5129
5130 <h5>Syntax:</h5>
5131 <pre>
5132   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5133 </pre>
5134
5135 <h5>Overview:</h5>
5136 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5137    <tt>ty2</tt>.</p>
5138
5139
5140 <h5>Arguments:</h5>
5141 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5142    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5143    of the same number of integers.
5144    The bit size of the <tt>value</tt> must be smaller than
5145    the bit size of the destination type,
5146    <tt>ty2</tt>.</p>
5147
5148 <h5>Semantics:</h5>
5149 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5150    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5151
5152 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5153
5154 <h5>Example:</h5>
5155 <pre>
5156   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5157   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5158   %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>
5159 </pre>
5160
5161 </div>
5162
5163 <!-- _______________________________________________________________________ -->
5164 <h4>
5165    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5166 </h4>
5167
5168 <div>
5169
5170 <h5>Syntax:</h5>
5171 <pre>
5172   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5173 </pre>
5174
5175 <h5>Overview:</h5>
5176 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5177
5178 <h5>Arguments:</h5>
5179 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5180    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5181    of the same number of integers.
5182    The bit size of the <tt>value</tt> must be smaller than
5183    the bit size of the destination type,
5184    <tt>ty2</tt>.</p>
5185
5186 <h5>Semantics:</h5>
5187 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5188    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5189    of the type <tt>ty2</tt>.</p>
5190
5191 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5192
5193 <h5>Example:</h5>
5194 <pre>
5195   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5196   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5197   %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>
5198 </pre>
5199
5200 </div>
5201
5202 <!-- _______________________________________________________________________ -->
5203 <h4>
5204    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5205 </h4>
5206
5207 <div>
5208
5209 <h5>Syntax:</h5>
5210 <pre>
5211   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5212 </pre>
5213
5214 <h5>Overview:</h5>
5215 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5216    <tt>ty2</tt>.</p>
5217
5218 <h5>Arguments:</h5>
5219 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5220    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5221    to cast it to. The size of <tt>value</tt> must be larger than the size of
5222    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5223    <i>no-op cast</i>.</p>
5224
5225 <h5>Semantics:</h5>
5226 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5227    <a href="#t_floating">floating point</a> type to a smaller
5228    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5229    within the destination type, <tt>ty2</tt>, then the results are
5230    undefined.</p>
5231
5232 <h5>Example:</h5>
5233 <pre>
5234   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5235   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5236 </pre>
5237
5238 </div>
5239
5240 <!-- _______________________________________________________________________ -->
5241 <h4>
5242    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5243 </h4>
5244
5245 <div>
5246
5247 <h5>Syntax:</h5>
5248 <pre>
5249   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5250 </pre>
5251
5252 <h5>Overview:</h5>
5253 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5254    floating point value.</p>
5255
5256 <h5>Arguments:</h5>
5257 <p>The '<tt>fpext</tt>' instruction takes a
5258    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5259    a <a href="#t_floating">floating point</a> type to cast it to. The source
5260    type must be smaller than the destination type.</p>
5261
5262 <h5>Semantics:</h5>
5263 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5264    <a href="#t_floating">floating point</a> type to a larger
5265    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5266    used to make a <i>no-op cast</i> because it always changes bits. Use
5267    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5268
5269 <h5>Example:</h5>
5270 <pre>
5271   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5272   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5273 </pre>
5274
5275 </div>
5276
5277 <!-- _______________________________________________________________________ -->
5278 <h4>
5279    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5280 </h4>
5281
5282 <div>
5283
5284 <h5>Syntax:</h5>
5285 <pre>
5286   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5287 </pre>
5288
5289 <h5>Overview:</h5>
5290 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5291    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5292
5293 <h5>Arguments:</h5>
5294 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5295    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5296    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5297    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5298    vector integer type with the same number of elements as <tt>ty</tt></p>
5299
5300 <h5>Semantics:</h5>
5301 <p>The '<tt>fptoui</tt>' instruction converts its
5302    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5303    towards zero) unsigned integer value. If the value cannot fit
5304    in <tt>ty2</tt>, the results are undefined.</p>
5305
5306 <h5>Example:</h5>
5307 <pre>
5308   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5309   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5310   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5311 </pre>
5312
5313 </div>
5314
5315 <!-- _______________________________________________________________________ -->
5316 <h4>
5317    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5318 </h4>
5319
5320 <div>
5321
5322 <h5>Syntax:</h5>
5323 <pre>
5324   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5325 </pre>
5326
5327 <h5>Overview:</h5>
5328 <p>The '<tt>fptosi</tt>' instruction converts
5329    <a href="#t_floating">floating point</a> <tt>value</tt> to
5330    type <tt>ty2</tt>.</p>
5331
5332 <h5>Arguments:</h5>
5333 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5334    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5335    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5336    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5337    vector integer type with the same number of elements as <tt>ty</tt></p>
5338
5339 <h5>Semantics:</h5>
5340 <p>The '<tt>fptosi</tt>' instruction converts its
5341    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5342    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5343    the results are undefined.</p>
5344
5345 <h5>Example:</h5>
5346 <pre>
5347   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5348   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5349   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5350 </pre>
5351
5352 </div>
5353
5354 <!-- _______________________________________________________________________ -->
5355 <h4>
5356    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5357 </h4>
5358
5359 <div>
5360
5361 <h5>Syntax:</h5>
5362 <pre>
5363   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5364 </pre>
5365
5366 <h5>Overview:</h5>
5367 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5368    integer and converts that value to the <tt>ty2</tt> type.</p>
5369
5370 <h5>Arguments:</h5>
5371 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5372    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5373    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5374    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5375    floating point type with the same number of elements as <tt>ty</tt></p>
5376
5377 <h5>Semantics:</h5>
5378 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5379    integer quantity and converts it to the corresponding floating point
5380    value. If the value cannot fit in the floating point value, the results are
5381    undefined.</p>
5382
5383 <h5>Example:</h5>
5384 <pre>
5385   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5386   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5387 </pre>
5388
5389 </div>
5390
5391 <!-- _______________________________________________________________________ -->
5392 <h4>
5393    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5394 </h4>
5395
5396 <div>
5397
5398 <h5>Syntax:</h5>
5399 <pre>
5400   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5401 </pre>
5402
5403 <h5>Overview:</h5>
5404 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5405    and converts that value to the <tt>ty2</tt> type.</p>
5406
5407 <h5>Arguments:</h5>
5408 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5409    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5410    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5411    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5412    floating point type with the same number of elements as <tt>ty</tt></p>
5413
5414 <h5>Semantics:</h5>
5415 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5416    quantity and converts it to the corresponding floating point value. If the
5417    value cannot fit in the floating point value, the results are undefined.</p>
5418
5419 <h5>Example:</h5>
5420 <pre>
5421   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5422   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5423 </pre>
5424
5425 </div>
5426
5427 <!-- _______________________________________________________________________ -->
5428 <h4>
5429    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5430 </h4>
5431
5432 <div>
5433
5434 <h5>Syntax:</h5>
5435 <pre>
5436   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5437 </pre>
5438
5439 <h5>Overview:</h5>
5440 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
5441    the integer type <tt>ty2</tt>.</p>
5442
5443 <h5>Arguments:</h5>
5444 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5445    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
5446    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
5447
5448 <h5>Semantics:</h5>
5449 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5450    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5451    truncating or zero extending that value to the size of the integer type. If
5452    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5453    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5454    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5455    change.</p>
5456
5457 <h5>Example:</h5>
5458 <pre>
5459   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
5460   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
5461 </pre>
5462
5463 </div>
5464
5465 <!-- _______________________________________________________________________ -->
5466 <h4>
5467    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5468 </h4>
5469
5470 <div>
5471
5472 <h5>Syntax:</h5>
5473 <pre>
5474   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5475 </pre>
5476
5477 <h5>Overview:</h5>
5478 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5479    pointer type, <tt>ty2</tt>.</p>
5480
5481 <h5>Arguments:</h5>
5482 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5483    value to cast, and a type to cast it to, which must be a
5484    <a href="#t_pointer">pointer</a> type.</p>
5485
5486 <h5>Semantics:</h5>
5487 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5488    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5489    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5490    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5491    than the size of a pointer then a zero extension is done. If they are the
5492    same size, nothing is done (<i>no-op cast</i>).</p>
5493
5494 <h5>Example:</h5>
5495 <pre>
5496   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5497   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5498   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5499 </pre>
5500
5501 </div>
5502
5503 <!-- _______________________________________________________________________ -->
5504 <h4>
5505    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5506 </h4>
5507
5508 <div>
5509
5510 <h5>Syntax:</h5>
5511 <pre>
5512   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5513 </pre>
5514
5515 <h5>Overview:</h5>
5516 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5517    <tt>ty2</tt> without changing any bits.</p>
5518
5519 <h5>Arguments:</h5>
5520 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5521    non-aggregate first class value, and a type to cast it to, which must also be
5522    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5523    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5524    identical. If the source type is a pointer, the destination type must also be
5525    a pointer.  This instruction supports bitwise conversion of vectors to
5526    integers and to vectors of other types (as long as they have the same
5527    size).</p>
5528
5529 <h5>Semantics:</h5>
5530 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5531    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5532    this conversion.  The conversion is done as if the <tt>value</tt> had been
5533    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5534    be converted to other pointer types with this instruction. To convert
5535    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5536    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5537
5538 <h5>Example:</h5>
5539 <pre>
5540   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5541   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5542   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5543 </pre>
5544
5545 </div>
5546
5547 </div>
5548
5549 <!-- ======================================================================= -->
5550 <h3>
5551   <a name="otherops">Other Operations</a>
5552 </h3>
5553
5554 <div>
5555
5556 <p>The instructions in this category are the "miscellaneous" instructions, which
5557    defy better classification.</p>
5558
5559 <!-- _______________________________________________________________________ -->
5560 <h4>
5561   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5562 </h4>
5563
5564 <div>
5565
5566 <h5>Syntax:</h5>
5567 <pre>
5568   &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>
5569 </pre>
5570
5571 <h5>Overview:</h5>
5572 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5573    boolean values based on comparison of its two integer, integer vector, or
5574    pointer operands.</p>
5575
5576 <h5>Arguments:</h5>
5577 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5578    the condition code indicating the kind of comparison to perform. It is not a
5579    value, just a keyword. The possible condition code are:</p>
5580
5581 <ol>
5582   <li><tt>eq</tt>: equal</li>
5583   <li><tt>ne</tt>: not equal </li>
5584   <li><tt>ugt</tt>: unsigned greater than</li>
5585   <li><tt>uge</tt>: unsigned greater or equal</li>
5586   <li><tt>ult</tt>: unsigned less than</li>
5587   <li><tt>ule</tt>: unsigned less or equal</li>
5588   <li><tt>sgt</tt>: signed greater than</li>
5589   <li><tt>sge</tt>: signed greater or equal</li>
5590   <li><tt>slt</tt>: signed less than</li>
5591   <li><tt>sle</tt>: signed less or equal</li>
5592 </ol>
5593
5594 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5595    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5596    typed.  They must also be identical types.</p>
5597
5598 <h5>Semantics:</h5>
5599 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5600    condition code given as <tt>cond</tt>. The comparison performed always yields
5601    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5602    result, as follows:</p>
5603
5604 <ol>
5605   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5606       <tt>false</tt> otherwise. No sign interpretation is necessary or
5607       performed.</li>
5608
5609   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5610       <tt>false</tt> otherwise. No sign interpretation is necessary or
5611       performed.</li>
5612
5613   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5614       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5615
5616   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5617       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5618       to <tt>op2</tt>.</li>
5619
5620   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5621       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5622
5623   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5624       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5625
5626   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5627       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5628
5629   <li><tt>sge</tt>: interprets the operands as signed values and yields
5630       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5631       to <tt>op2</tt>.</li>
5632
5633   <li><tt>slt</tt>: interprets the operands as signed values and yields
5634       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5635
5636   <li><tt>sle</tt>: interprets the operands as signed values and yields
5637       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5638 </ol>
5639
5640 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5641    values are compared as if they were integers.</p>
5642
5643 <p>If the operands are integer vectors, then they are compared element by
5644    element. The result is an <tt>i1</tt> vector with the same number of elements
5645    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5646
5647 <h5>Example:</h5>
5648 <pre>
5649   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5650   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5651   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5652   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5653   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5654   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5655 </pre>
5656
5657 <p>Note that the code generator does not yet support vector types with
5658    the <tt>icmp</tt> instruction.</p>
5659
5660 </div>
5661
5662 <!-- _______________________________________________________________________ -->
5663 <h4>
5664   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5665 </h4>
5666
5667 <div>
5668
5669 <h5>Syntax:</h5>
5670 <pre>
5671   &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>
5672 </pre>
5673
5674 <h5>Overview:</h5>
5675 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5676    values based on comparison of its operands.</p>
5677
5678 <p>If the operands are floating point scalars, then the result type is a boolean
5679 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5680
5681 <p>If the operands are floating point vectors, then the result type is a vector
5682    of boolean with the same number of elements as the operands being
5683    compared.</p>
5684
5685 <h5>Arguments:</h5>
5686 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5687    the condition code indicating the kind of comparison to perform. It is not a
5688    value, just a keyword. The possible condition code are:</p>
5689
5690 <ol>
5691   <li><tt>false</tt>: no comparison, always returns false</li>
5692   <li><tt>oeq</tt>: ordered and equal</li>
5693   <li><tt>ogt</tt>: ordered and greater than </li>
5694   <li><tt>oge</tt>: ordered and greater than or equal</li>
5695   <li><tt>olt</tt>: ordered and less than </li>
5696   <li><tt>ole</tt>: ordered and less than or equal</li>
5697   <li><tt>one</tt>: ordered and not equal</li>
5698   <li><tt>ord</tt>: ordered (no nans)</li>
5699   <li><tt>ueq</tt>: unordered or equal</li>
5700   <li><tt>ugt</tt>: unordered or greater than </li>
5701   <li><tt>uge</tt>: unordered or greater than or equal</li>
5702   <li><tt>ult</tt>: unordered or less than </li>
5703   <li><tt>ule</tt>: unordered or less than or equal</li>
5704   <li><tt>une</tt>: unordered or not equal</li>
5705   <li><tt>uno</tt>: unordered (either nans)</li>
5706   <li><tt>true</tt>: no comparison, always returns true</li>
5707 </ol>
5708
5709 <p><i>Ordered</i> means that neither operand is a QNAN while
5710    <i>unordered</i> means that either operand may be a QNAN.</p>
5711
5712 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5713    a <a href="#t_floating">floating point</a> type or
5714    a <a href="#t_vector">vector</a> of floating point type.  They must have
5715    identical types.</p>
5716
5717 <h5>Semantics:</h5>
5718 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5719    according to the condition code given as <tt>cond</tt>.  If the operands are
5720    vectors, then the vectors are compared element by element.  Each comparison
5721    performed always yields an <a href="#t_integer">i1</a> result, as
5722    follows:</p>
5723
5724 <ol>
5725   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5726
5727   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5728       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5729
5730   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5731       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5732
5733   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5734       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5735
5736   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5737       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5738
5739   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5740       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5741
5742   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5743       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5744
5745   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5746
5747   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5748       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5749
5750   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5751       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5752
5753   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5754       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5755
5756   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5757       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5758
5759   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5760       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5761
5762   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5763       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5764
5765   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5766
5767   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5768 </ol>
5769
5770 <h5>Example:</h5>
5771 <pre>
5772   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5773   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5774   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5775   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5776 </pre>
5777
5778 <p>Note that the code generator does not yet support vector types with
5779    the <tt>fcmp</tt> instruction.</p>
5780
5781 </div>
5782
5783 <!-- _______________________________________________________________________ -->
5784 <h4>
5785   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5786 </h4>
5787
5788 <div>
5789
5790 <h5>Syntax:</h5>
5791 <pre>
5792   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5793 </pre>
5794
5795 <h5>Overview:</h5>
5796 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5797    SSA graph representing the function.</p>
5798
5799 <h5>Arguments:</h5>
5800 <p>The type of the incoming values is specified with the first type field. After
5801    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5802    one pair for each predecessor basic block of the current block.  Only values
5803    of <a href="#t_firstclass">first class</a> type may be used as the value
5804    arguments to the PHI node.  Only labels may be used as the label
5805    arguments.</p>
5806
5807 <p>There must be no non-phi instructions between the start of a basic block and
5808    the PHI instructions: i.e. PHI instructions must be first in a basic
5809    block.</p>
5810
5811 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5812    occur on the edge from the corresponding predecessor block to the current
5813    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5814    value on the same edge).</p>
5815
5816 <h5>Semantics:</h5>
5817 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5818    specified by the pair corresponding to the predecessor basic block that
5819    executed just prior to the current block.</p>
5820
5821 <h5>Example:</h5>
5822 <pre>
5823 Loop:       ; Infinite loop that counts from 0 on up...
5824   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5825   %nextindvar = add i32 %indvar, 1
5826   br label %Loop
5827 </pre>
5828
5829 </div>
5830
5831 <!-- _______________________________________________________________________ -->
5832 <h4>
5833    <a name="i_select">'<tt>select</tt>' Instruction</a>
5834 </h4>
5835
5836 <div>
5837
5838 <h5>Syntax:</h5>
5839 <pre>
5840   &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>
5841
5842   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5843 </pre>
5844
5845 <h5>Overview:</h5>
5846 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5847    condition, without branching.</p>
5848
5849
5850 <h5>Arguments:</h5>
5851 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5852    values indicating the condition, and two values of the
5853    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5854    vectors and the condition is a scalar, then entire vectors are selected, not
5855    individual elements.</p>
5856
5857 <h5>Semantics:</h5>
5858 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5859    first value argument; otherwise, it returns the second value argument.</p>
5860
5861 <p>If the condition is a vector of i1, then the value arguments must be vectors
5862    of the same size, and the selection is done element by element.</p>
5863
5864 <h5>Example:</h5>
5865 <pre>
5866   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5867 </pre>
5868
5869 <p>Note that the code generator does not yet support conditions
5870    with vector type.</p>
5871
5872 </div>
5873
5874 <!-- _______________________________________________________________________ -->
5875 <h4>
5876   <a name="i_call">'<tt>call</tt>' Instruction</a>
5877 </h4>
5878
5879 <div>
5880
5881 <h5>Syntax:</h5>
5882 <pre>
5883   &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>]
5884 </pre>
5885
5886 <h5>Overview:</h5>
5887 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5888
5889 <h5>Arguments:</h5>
5890 <p>This instruction requires several arguments:</p>
5891
5892 <ol>
5893   <li>The optional "tail" marker indicates that the callee function does not
5894       access any allocas or varargs in the caller.  Note that calls may be
5895       marked "tail" even if they do not occur before
5896       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5897       present, the function call is eligible for tail call optimization,
5898       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5899       optimized into a jump</a>.  The code generator may optimize calls marked
5900       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5901       sibling call optimization</a> when the caller and callee have
5902       matching signatures, or 2) forced tail call optimization when the
5903       following extra requirements are met:
5904       <ul>
5905         <li>Caller and callee both have the calling
5906             convention <tt>fastcc</tt>.</li>
5907         <li>The call is in tail position (ret immediately follows call and ret
5908             uses value of call or is void).</li>
5909         <li>Option <tt>-tailcallopt</tt> is enabled,
5910             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5911         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5912             constraints are met.</a></li>
5913       </ul>
5914   </li>
5915
5916   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5917       convention</a> the call should use.  If none is specified, the call
5918       defaults to using C calling conventions.  The calling convention of the
5919       call must match the calling convention of the target function, or else the
5920       behavior is undefined.</li>
5921
5922   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5923       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5924       '<tt>inreg</tt>' attributes are valid here.</li>
5925
5926   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5927       type of the return value.  Functions that return no value are marked
5928       <tt><a href="#t_void">void</a></tt>.</li>
5929
5930   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5931       being invoked.  The argument types must match the types implied by this
5932       signature.  This type can be omitted if the function is not varargs and if
5933       the function type does not return a pointer to a function.</li>
5934
5935   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5936       be invoked. In most cases, this is a direct function invocation, but
5937       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5938       to function value.</li>
5939
5940   <li>'<tt>function args</tt>': argument list whose types match the function
5941       signature argument types and parameter attributes. All arguments must be
5942       of <a href="#t_firstclass">first class</a> type. If the function
5943       signature indicates the function accepts a variable number of arguments,
5944       the extra arguments can be specified.</li>
5945
5946   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5947       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5948       '<tt>readnone</tt>' attributes are valid here.</li>
5949 </ol>
5950
5951 <h5>Semantics:</h5>
5952 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5953    a specified function, with its incoming arguments bound to the specified
5954    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5955    function, control flow continues with the instruction after the function
5956    call, and the return value of the function is bound to the result
5957    argument.</p>
5958
5959 <h5>Example:</h5>
5960 <pre>
5961   %retval = call i32 @test(i32 %argc)
5962   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5963   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5964   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5965   call void %foo(i8 97 signext)
5966
5967   %struct.A = type { i32, i8 }
5968   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5969   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5970   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5971   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5972   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5973 </pre>
5974
5975 <p>llvm treats calls to some functions with names and arguments that match the
5976 standard C99 library as being the C99 library functions, and may perform
5977 optimizations or generate code for them under that assumption.  This is
5978 something we'd like to change in the future to provide better support for
5979 freestanding environments and non-C-based languages.</p>
5980
5981 </div>
5982
5983 <!-- _______________________________________________________________________ -->
5984 <h4>
5985   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5986 </h4>
5987
5988 <div>
5989
5990 <h5>Syntax:</h5>
5991 <pre>
5992   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5993 </pre>
5994
5995 <h5>Overview:</h5>
5996 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5997    the "variable argument" area of a function call.  It is used to implement the
5998    <tt>va_arg</tt> macro in C.</p>
5999
6000 <h5>Arguments:</h5>
6001 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
6002    argument. It returns a value of the specified argument type and increments
6003    the <tt>va_list</tt> to point to the next argument.  The actual type
6004    of <tt>va_list</tt> is target specific.</p>
6005
6006 <h5>Semantics:</h5>
6007 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
6008    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
6009    to the next argument.  For more information, see the variable argument
6010    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
6011
6012 <p>It is legal for this instruction to be called in a function which does not
6013    take a variable number of arguments, for example, the <tt>vfprintf</tt>
6014    function.</p>
6015
6016 <p><tt>va_arg</tt> is an LLVM instruction instead of
6017    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
6018    argument.</p>
6019
6020 <h5>Example:</h5>
6021 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6022
6023 <p>Note that the code generator does not yet fully support va_arg on many
6024    targets. Also, it does not currently support va_arg with aggregate types on
6025    any target.</p>
6026
6027 </div>
6028
6029 <!-- _______________________________________________________________________ -->
6030 <h4>
6031   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6032 </h4>
6033
6034 <div>
6035
6036 <h5>Syntax:</h5>
6037 <pre>
6038   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6039   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6040
6041   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6042   &lt;clause&gt; := filter &lt;array constant type&gt; &lt;array constant&gt;
6043 </pre>
6044
6045 <h5>Overview:</h5>
6046 <p>The '<tt>landingpad</tt>' instruction is used by
6047    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6048    system</a> to specify that a basic block is a landing pad &mdash; one where
6049    the exception lands, and corresponds to the code found in the
6050    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6051    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6052    re-entry to the function. The <tt>resultval</tt> has the
6053    type <tt>somety</tt>.</p>
6054
6055 <h5>Arguments:</h5>
6056 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6057    function associated with the unwinding mechanism. The optional
6058    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6059
6060 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6061    or <tt>filter</tt> &mdash; and contains the global variable representing the
6062    "type" that may be caught or filtered respectively. Unlike the
6063    <tt>catch</tt> clause, the <tt>filter</tt> clause takes an array constant as
6064    its argument. Use "<tt>[0 x i8**] undef</tt>" for a filter which cannot
6065    throw. The '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6066    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6067
6068 <h5>Semantics:</h5>
6069 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6070    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6071    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6072    calling conventions, how the personality function results are represented in
6073    LLVM IR is target specific.</p>
6074
6075 <p>The clauses are applied in order from top to bottom. If two
6076    <tt>landingpad</tt> instructions are merged together through inlining, the
6077    clauses from the calling function are appended to the list of clauses.</p>
6078
6079 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6080
6081 <ul>
6082   <li>A landing pad block is a basic block which is the unwind destination of an
6083       '<tt>invoke</tt>' instruction.</li>
6084   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6085       first non-PHI instruction.</li>
6086   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6087       pad block.</li>
6088   <li>A basic block that is not a landing pad block may not include a
6089       '<tt>landingpad</tt>' instruction.</li>
6090   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6091       personality function.</li>
6092 </ul>
6093
6094 <h5>Example:</h5>
6095 <pre>
6096   ;; A landing pad which can catch an integer.
6097   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6098            catch i8** @_ZTIi
6099   ;; A landing pad that is a cleanup.
6100   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6101            cleanup
6102   ;; A landing pad which can catch an integer and can only throw a double.
6103   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6104            catch i8** @_ZTIi
6105            filter [1 x i8**] [@_ZTId]
6106 </pre>
6107
6108 </div>
6109
6110 </div>
6111
6112 </div>
6113
6114 <!-- *********************************************************************** -->
6115 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6116 <!-- *********************************************************************** -->
6117
6118 <div>
6119
6120 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6121    well known names and semantics and are required to follow certain
6122    restrictions.  Overall, these intrinsics represent an extension mechanism for
6123    the LLVM language that does not require changing all of the transformations
6124    in LLVM when adding to the language (or the bitcode reader/writer, the
6125    parser, etc...).</p>
6126
6127 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6128    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6129    begin with this prefix.  Intrinsic functions must always be external
6130    functions: you cannot define the body of intrinsic functions.  Intrinsic
6131    functions may only be used in call or invoke instructions: it is illegal to
6132    take the address of an intrinsic function.  Additionally, because intrinsic
6133    functions are part of the LLVM language, it is required if any are added that
6134    they be documented here.</p>
6135
6136 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6137    family of functions that perform the same operation but on different data
6138    types. Because LLVM can represent over 8 million different integer types,
6139    overloading is used commonly to allow an intrinsic function to operate on any
6140    integer type. One or more of the argument types or the result type can be
6141    overloaded to accept any integer type. Argument types may also be defined as
6142    exactly matching a previous argument's type or the result type. This allows
6143    an intrinsic function which accepts multiple arguments, but needs all of them
6144    to be of the same type, to only be overloaded with respect to a single
6145    argument or the result.</p>
6146
6147 <p>Overloaded intrinsics will have the names of its overloaded argument types
6148    encoded into its function name, each preceded by a period. Only those types
6149    which are overloaded result in a name suffix. Arguments whose type is matched
6150    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6151    can take an integer of any width and returns an integer of exactly the same
6152    integer width. This leads to a family of functions such as
6153    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6154    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6155    suffix is required. Because the argument's type is matched against the return
6156    type, it does not require its own name suffix.</p>
6157
6158 <p>To learn how to add an intrinsic function, please see the
6159    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6160
6161 <!-- ======================================================================= -->
6162 <h3>
6163   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6164 </h3>
6165
6166 <div>
6167
6168 <p>Variable argument support is defined in LLVM with
6169    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6170    intrinsic functions.  These functions are related to the similarly named
6171    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6172
6173 <p>All of these functions operate on arguments that use a target-specific value
6174    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6175    not define what this type is, so all transformations should be prepared to
6176    handle these functions regardless of the type used.</p>
6177
6178 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6179    instruction and the variable argument handling intrinsic functions are
6180    used.</p>
6181
6182 <pre class="doc_code">
6183 define i32 @test(i32 %X, ...) {
6184   ; Initialize variable argument processing
6185   %ap = alloca i8*
6186   %ap2 = bitcast i8** %ap to i8*
6187   call void @llvm.va_start(i8* %ap2)
6188
6189   ; Read a single integer argument
6190   %tmp = va_arg i8** %ap, i32
6191
6192   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6193   %aq = alloca i8*
6194   %aq2 = bitcast i8** %aq to i8*
6195   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6196   call void @llvm.va_end(i8* %aq2)
6197
6198   ; Stop processing of arguments.
6199   call void @llvm.va_end(i8* %ap2)
6200   ret i32 %tmp
6201 }
6202
6203 declare void @llvm.va_start(i8*)
6204 declare void @llvm.va_copy(i8*, i8*)
6205 declare void @llvm.va_end(i8*)
6206 </pre>
6207
6208 <!-- _______________________________________________________________________ -->
6209 <h4>
6210   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6211 </h4>
6212
6213
6214 <div>
6215
6216 <h5>Syntax:</h5>
6217 <pre>
6218   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6219 </pre>
6220
6221 <h5>Overview:</h5>
6222 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6223    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6224
6225 <h5>Arguments:</h5>
6226 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6227
6228 <h5>Semantics:</h5>
6229 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6230    macro available in C.  In a target-dependent way, it initializes
6231    the <tt>va_list</tt> element to which the argument points, so that the next
6232    call to <tt>va_arg</tt> will produce the first variable argument passed to
6233    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6234    need to know the last argument of the function as the compiler can figure
6235    that out.</p>
6236
6237 </div>
6238
6239 <!-- _______________________________________________________________________ -->
6240 <h4>
6241  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6242 </h4>
6243
6244 <div>
6245
6246 <h5>Syntax:</h5>
6247 <pre>
6248   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6249 </pre>
6250
6251 <h5>Overview:</h5>
6252 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6253    which has been initialized previously
6254    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6255    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6256
6257 <h5>Arguments:</h5>
6258 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6259
6260 <h5>Semantics:</h5>
6261 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6262    macro available in C.  In a target-dependent way, it destroys
6263    the <tt>va_list</tt> element to which the argument points.  Calls
6264    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6265    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6266    with calls to <tt>llvm.va_end</tt>.</p>
6267
6268 </div>
6269
6270 <!-- _______________________________________________________________________ -->
6271 <h4>
6272   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6273 </h4>
6274
6275 <div>
6276
6277 <h5>Syntax:</h5>
6278 <pre>
6279   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6280 </pre>
6281
6282 <h5>Overview:</h5>
6283 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6284    from the source argument list to the destination argument list.</p>
6285
6286 <h5>Arguments:</h5>
6287 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6288    The second argument is a pointer to a <tt>va_list</tt> element to copy
6289    from.</p>
6290
6291 <h5>Semantics:</h5>
6292 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6293    macro available in C.  In a target-dependent way, it copies the
6294    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6295    element.  This intrinsic is necessary because
6296    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6297    arbitrarily complex and require, for example, memory allocation.</p>
6298
6299 </div>
6300
6301 </div>
6302
6303 </div>
6304
6305 <!-- ======================================================================= -->
6306 <h3>
6307   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6308 </h3>
6309
6310 <div>
6311
6312 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6313 Collection</a> (GC) requires the implementation and generation of these
6314 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6315 roots on the stack</a>, as well as garbage collector implementations that
6316 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6317 barriers.  Front-ends for type-safe garbage collected languages should generate
6318 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6319 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6320 LLVM</a>.</p>
6321
6322 <p>The garbage collection intrinsics only operate on objects in the generic
6323    address space (address space zero).</p>
6324
6325 <!-- _______________________________________________________________________ -->
6326 <h4>
6327   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6328 </h4>
6329
6330 <div>
6331
6332 <h5>Syntax:</h5>
6333 <pre>
6334   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6335 </pre>
6336
6337 <h5>Overview:</h5>
6338 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6339    the code generator, and allows some metadata to be associated with it.</p>
6340
6341 <h5>Arguments:</h5>
6342 <p>The first argument specifies the address of a stack object that contains the
6343    root pointer.  The second pointer (which must be either a constant or a
6344    global value address) contains the meta-data to be associated with the
6345    root.</p>
6346
6347 <h5>Semantics:</h5>
6348 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6349    location.  At compile-time, the code generator generates information to allow
6350    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6351    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6352    algorithm</a>.</p>
6353
6354 </div>
6355
6356 <!-- _______________________________________________________________________ -->
6357 <h4>
6358   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6359 </h4>
6360
6361 <div>
6362
6363 <h5>Syntax:</h5>
6364 <pre>
6365   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6366 </pre>
6367
6368 <h5>Overview:</h5>
6369 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6370    locations, allowing garbage collector implementations that require read
6371    barriers.</p>
6372
6373 <h5>Arguments:</h5>
6374 <p>The second argument is the address to read from, which should be an address
6375    allocated from the garbage collector.  The first object is a pointer to the
6376    start of the referenced object, if needed by the language runtime (otherwise
6377    null).</p>
6378
6379 <h5>Semantics:</h5>
6380 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6381    instruction, but may be replaced with substantially more complex code by the
6382    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6383    may only be used in a function which <a href="#gc">specifies a GC
6384    algorithm</a>.</p>
6385
6386 </div>
6387
6388 <!-- _______________________________________________________________________ -->
6389 <h4>
6390   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6391 </h4>
6392
6393 <div>
6394
6395 <h5>Syntax:</h5>
6396 <pre>
6397   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6398 </pre>
6399
6400 <h5>Overview:</h5>
6401 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6402    locations, allowing garbage collector implementations that require write
6403    barriers (such as generational or reference counting collectors).</p>
6404
6405 <h5>Arguments:</h5>
6406 <p>The first argument is the reference to store, the second is the start of the
6407    object to store it to, and the third is the address of the field of Obj to
6408    store to.  If the runtime does not require a pointer to the object, Obj may
6409    be null.</p>
6410
6411 <h5>Semantics:</h5>
6412 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6413    instruction, but may be replaced with substantially more complex code by the
6414    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6415    may only be used in a function which <a href="#gc">specifies a GC
6416    algorithm</a>.</p>
6417
6418 </div>
6419
6420 </div>
6421
6422 <!-- ======================================================================= -->
6423 <h3>
6424   <a name="int_codegen">Code Generator Intrinsics</a>
6425 </h3>
6426
6427 <div>
6428
6429 <p>These intrinsics are provided by LLVM to expose special features that may
6430    only be implemented with code generator support.</p>
6431
6432 <!-- _______________________________________________________________________ -->
6433 <h4>
6434   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6435 </h4>
6436
6437 <div>
6438
6439 <h5>Syntax:</h5>
6440 <pre>
6441   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6442 </pre>
6443
6444 <h5>Overview:</h5>
6445 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6446    target-specific value indicating the return address of the current function
6447    or one of its callers.</p>
6448
6449 <h5>Arguments:</h5>
6450 <p>The argument to this intrinsic indicates which function to return the address
6451    for.  Zero indicates the calling function, one indicates its caller, etc.
6452    The argument is <b>required</b> to be a constant integer value.</p>
6453
6454 <h5>Semantics:</h5>
6455 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6456    indicating the return address of the specified call frame, or zero if it
6457    cannot be identified.  The value returned by this intrinsic is likely to be
6458    incorrect or 0 for arguments other than zero, so it should only be used for
6459    debugging purposes.</p>
6460
6461 <p>Note that calling this intrinsic does not prevent function inlining or other
6462    aggressive transformations, so the value returned may not be that of the
6463    obvious source-language caller.</p>
6464
6465 </div>
6466
6467 <!-- _______________________________________________________________________ -->
6468 <h4>
6469   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6470 </h4>
6471
6472 <div>
6473
6474 <h5>Syntax:</h5>
6475 <pre>
6476   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6477 </pre>
6478
6479 <h5>Overview:</h5>
6480 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6481    target-specific frame pointer value for the specified stack frame.</p>
6482
6483 <h5>Arguments:</h5>
6484 <p>The argument to this intrinsic indicates which function to return the frame
6485    pointer for.  Zero indicates the calling function, one indicates its caller,
6486    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6487
6488 <h5>Semantics:</h5>
6489 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6490    indicating the frame address of the specified call frame, or zero if it
6491    cannot be identified.  The value returned by this intrinsic is likely to be
6492    incorrect or 0 for arguments other than zero, so it should only be used for
6493    debugging purposes.</p>
6494
6495 <p>Note that calling this intrinsic does not prevent function inlining or other
6496    aggressive transformations, so the value returned may not be that of the
6497    obvious source-language caller.</p>
6498
6499 </div>
6500
6501 <!-- _______________________________________________________________________ -->
6502 <h4>
6503   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6504 </h4>
6505
6506 <div>
6507
6508 <h5>Syntax:</h5>
6509 <pre>
6510   declare i8* @llvm.stacksave()
6511 </pre>
6512
6513 <h5>Overview:</h5>
6514 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6515    of the function stack, for use
6516    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6517    useful for implementing language features like scoped automatic variable
6518    sized arrays in C99.</p>
6519
6520 <h5>Semantics:</h5>
6521 <p>This intrinsic returns a opaque pointer value that can be passed
6522    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6523    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6524    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6525    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6526    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6527    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6528
6529 </div>
6530
6531 <!-- _______________________________________________________________________ -->
6532 <h4>
6533   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6534 </h4>
6535
6536 <div>
6537
6538 <h5>Syntax:</h5>
6539 <pre>
6540   declare void @llvm.stackrestore(i8* %ptr)
6541 </pre>
6542
6543 <h5>Overview:</h5>
6544 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6545    the function stack to the state it was in when the
6546    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6547    executed.  This is useful for implementing language features like scoped
6548    automatic variable sized arrays in C99.</p>
6549
6550 <h5>Semantics:</h5>
6551 <p>See the description
6552    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6553
6554 </div>
6555
6556 <!-- _______________________________________________________________________ -->
6557 <h4>
6558   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6559 </h4>
6560
6561 <div>
6562
6563 <h5>Syntax:</h5>
6564 <pre>
6565   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6566 </pre>
6567
6568 <h5>Overview:</h5>
6569 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6570    insert a prefetch instruction if supported; otherwise, it is a noop.
6571    Prefetches have no effect on the behavior of the program but can change its
6572    performance characteristics.</p>
6573
6574 <h5>Arguments:</h5>
6575 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6576    specifier determining if the fetch should be for a read (0) or write (1),
6577    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6578    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6579    specifies whether the prefetch is performed on the data (1) or instruction (0)
6580    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6581    must be constant integers.</p>
6582
6583 <h5>Semantics:</h5>
6584 <p>This intrinsic does not modify the behavior of the program.  In particular,
6585    prefetches cannot trap and do not produce a value.  On targets that support
6586    this intrinsic, the prefetch can provide hints to the processor cache for
6587    better performance.</p>
6588
6589 </div>
6590
6591 <!-- _______________________________________________________________________ -->
6592 <h4>
6593   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6594 </h4>
6595
6596 <div>
6597
6598 <h5>Syntax:</h5>
6599 <pre>
6600   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6601 </pre>
6602
6603 <h5>Overview:</h5>
6604 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6605    Counter (PC) in a region of code to simulators and other tools.  The method
6606    is target specific, but it is expected that the marker will use exported
6607    symbols to transmit the PC of the marker.  The marker makes no guarantees
6608    that it will remain with any specific instruction after optimizations.  It is
6609    possible that the presence of a marker will inhibit optimizations.  The
6610    intended use is to be inserted after optimizations to allow correlations of
6611    simulation runs.</p>
6612
6613 <h5>Arguments:</h5>
6614 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6615
6616 <h5>Semantics:</h5>
6617 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6618    not support this intrinsic may ignore it.</p>
6619
6620 </div>
6621
6622 <!-- _______________________________________________________________________ -->
6623 <h4>
6624   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6625 </h4>
6626
6627 <div>
6628
6629 <h5>Syntax:</h5>
6630 <pre>
6631   declare i64 @llvm.readcyclecounter()
6632 </pre>
6633
6634 <h5>Overview:</h5>
6635 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6636    counter register (or similar low latency, high accuracy clocks) on those
6637    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6638    should map to RPCC.  As the backing counters overflow quickly (on the order
6639    of 9 seconds on alpha), this should only be used for small timings.</p>
6640
6641 <h5>Semantics:</h5>
6642 <p>When directly supported, reading the cycle counter should not modify any
6643    memory.  Implementations are allowed to either return a application specific
6644    value or a system wide value.  On backends without support, this is lowered
6645    to a constant 0.</p>
6646
6647 </div>
6648
6649 </div>
6650
6651 <!-- ======================================================================= -->
6652 <h3>
6653   <a name="int_libc">Standard C Library Intrinsics</a>
6654 </h3>
6655
6656 <div>
6657
6658 <p>LLVM provides intrinsics for a few important standard C library functions.
6659    These intrinsics allow source-language front-ends to pass information about
6660    the alignment of the pointer arguments to the code generator, providing
6661    opportunity for more efficient code generation.</p>
6662
6663 <!-- _______________________________________________________________________ -->
6664 <h4>
6665   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6666 </h4>
6667
6668 <div>
6669
6670 <h5>Syntax:</h5>
6671 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6672    integer bit width and for different address spaces. Not all targets support
6673    all bit widths however.</p>
6674
6675 <pre>
6676   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6677                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6678   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6679                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6680 </pre>
6681
6682 <h5>Overview:</h5>
6683 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6684    source location to the destination location.</p>
6685
6686 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6687    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6688    and the pointers can be in specified address spaces.</p>
6689
6690 <h5>Arguments:</h5>
6691
6692 <p>The first argument is a pointer to the destination, the second is a pointer
6693    to the source.  The third argument is an integer argument specifying the
6694    number of bytes to copy, the fourth argument is the alignment of the
6695    source and destination locations, and the fifth is a boolean indicating a
6696    volatile access.</p>
6697
6698 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6699    then the caller guarantees that both the source and destination pointers are
6700    aligned to that boundary.</p>
6701
6702 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6703    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6704    The detailed access behavior is not very cleanly specified and it is unwise
6705    to depend on it.</p>
6706
6707 <h5>Semantics:</h5>
6708
6709 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6710    source location to the destination location, which are not allowed to
6711    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6712    be aligned to some boundary, this can be specified as the fourth argument,
6713    otherwise it should be set to 0 or 1.</p>
6714
6715 </div>
6716
6717 <!-- _______________________________________________________________________ -->
6718 <h4>
6719   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6720 </h4>
6721
6722 <div>
6723
6724 <h5>Syntax:</h5>
6725 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6726    width and for different address space. Not all targets support all bit
6727    widths however.</p>
6728
6729 <pre>
6730   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6731                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6732   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6733                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6734 </pre>
6735
6736 <h5>Overview:</h5>
6737 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6738    source location to the destination location. It is similar to the
6739    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6740    overlap.</p>
6741
6742 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6743    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6744    and the pointers can be in specified address spaces.</p>
6745
6746 <h5>Arguments:</h5>
6747
6748 <p>The first argument is a pointer to the destination, the second is a pointer
6749    to the source.  The third argument is an integer argument specifying the
6750    number of bytes to copy, the fourth argument is the alignment of the
6751    source and destination locations, and the fifth is a boolean indicating a
6752    volatile access.</p>
6753
6754 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6755    then the caller guarantees that the source and destination pointers are
6756    aligned to that boundary.</p>
6757
6758 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6759    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6760    The detailed access behavior is not very cleanly specified and it is unwise
6761    to depend on it.</p>
6762
6763 <h5>Semantics:</h5>
6764
6765 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6766    source location to the destination location, which may overlap.  It copies
6767    "len" bytes of memory over.  If the argument is known to be aligned to some
6768    boundary, this can be specified as the fourth argument, otherwise it should
6769    be set to 0 or 1.</p>
6770
6771 </div>
6772
6773 <!-- _______________________________________________________________________ -->
6774 <h4>
6775   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6776 </h4>
6777
6778 <div>
6779
6780 <h5>Syntax:</h5>
6781 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6782    width and for different address spaces. However, not all targets support all
6783    bit widths.</p>
6784
6785 <pre>
6786   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6787                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6788   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6789                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6790 </pre>
6791
6792 <h5>Overview:</h5>
6793 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6794    particular byte value.</p>
6795
6796 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6797    intrinsic does not return a value and takes extra alignment/volatile
6798    arguments.  Also, the destination can be in an arbitrary address space.</p>
6799
6800 <h5>Arguments:</h5>
6801 <p>The first argument is a pointer to the destination to fill, the second is the
6802    byte value with which to fill it, the third argument is an integer argument
6803    specifying the number of bytes to fill, and the fourth argument is the known
6804    alignment of the destination location.</p>
6805
6806 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6807    then the caller guarantees that the destination pointer is aligned to that
6808    boundary.</p>
6809
6810 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6811    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6812    The detailed access behavior is not very cleanly specified and it is unwise
6813    to depend on it.</p>
6814
6815 <h5>Semantics:</h5>
6816 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6817    at the destination location.  If the argument is known to be aligned to some
6818    boundary, this can be specified as the fourth argument, otherwise it should
6819    be set to 0 or 1.</p>
6820
6821 </div>
6822
6823 <!-- _______________________________________________________________________ -->
6824 <h4>
6825   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6826 </h4>
6827
6828 <div>
6829
6830 <h5>Syntax:</h5>
6831 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6832    floating point or vector of floating point type. Not all targets support all
6833    types however.</p>
6834
6835 <pre>
6836   declare float     @llvm.sqrt.f32(float %Val)
6837   declare double    @llvm.sqrt.f64(double %Val)
6838   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6839   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6840   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6841 </pre>
6842
6843 <h5>Overview:</h5>
6844 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6845    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6846    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6847    behavior for negative numbers other than -0.0 (which allows for better
6848    optimization, because there is no need to worry about errno being
6849    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6850
6851 <h5>Arguments:</h5>
6852 <p>The argument and return value are floating point numbers of the same
6853    type.</p>
6854
6855 <h5>Semantics:</h5>
6856 <p>This function returns the sqrt of the specified operand if it is a
6857    nonnegative floating point number.</p>
6858
6859 </div>
6860
6861 <!-- _______________________________________________________________________ -->
6862 <h4>
6863   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6864 </h4>
6865
6866 <div>
6867
6868 <h5>Syntax:</h5>
6869 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6870    floating point or vector of floating point type. Not all targets support all
6871    types however.</p>
6872
6873 <pre>
6874   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6875   declare double    @llvm.powi.f64(double %Val, i32 %power)
6876   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6877   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6878   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6879 </pre>
6880
6881 <h5>Overview:</h5>
6882 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6883    specified (positive or negative) power.  The order of evaluation of
6884    multiplications is not defined.  When a vector of floating point type is
6885    used, the second argument remains a scalar integer value.</p>
6886
6887 <h5>Arguments:</h5>
6888 <p>The second argument is an integer power, and the first is a value to raise to
6889    that power.</p>
6890
6891 <h5>Semantics:</h5>
6892 <p>This function returns the first value raised to the second power with an
6893    unspecified sequence of rounding operations.</p>
6894
6895 </div>
6896
6897 <!-- _______________________________________________________________________ -->
6898 <h4>
6899   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6900 </h4>
6901
6902 <div>
6903
6904 <h5>Syntax:</h5>
6905 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6906    floating point or vector of floating point type. Not all targets support all
6907    types however.</p>
6908
6909 <pre>
6910   declare float     @llvm.sin.f32(float  %Val)
6911   declare double    @llvm.sin.f64(double %Val)
6912   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6913   declare fp128     @llvm.sin.f128(fp128 %Val)
6914   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6915 </pre>
6916
6917 <h5>Overview:</h5>
6918 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6919
6920 <h5>Arguments:</h5>
6921 <p>The argument and return value are floating point numbers of the same
6922    type.</p>
6923
6924 <h5>Semantics:</h5>
6925 <p>This function returns the sine of the specified operand, returning the same
6926    values as the libm <tt>sin</tt> functions would, and handles error conditions
6927    in the same way.</p>
6928
6929 </div>
6930
6931 <!-- _______________________________________________________________________ -->
6932 <h4>
6933   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6934 </h4>
6935
6936 <div>
6937
6938 <h5>Syntax:</h5>
6939 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6940    floating point or vector of floating point type. Not all targets support all
6941    types however.</p>
6942
6943 <pre>
6944   declare float     @llvm.cos.f32(float  %Val)
6945   declare double    @llvm.cos.f64(double %Val)
6946   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6947   declare fp128     @llvm.cos.f128(fp128 %Val)
6948   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6949 </pre>
6950
6951 <h5>Overview:</h5>
6952 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6953
6954 <h5>Arguments:</h5>
6955 <p>The argument and return value are floating point numbers of the same
6956    type.</p>
6957
6958 <h5>Semantics:</h5>
6959 <p>This function returns the cosine of the specified operand, returning the same
6960    values as the libm <tt>cos</tt> functions would, and handles error conditions
6961    in the same way.</p>
6962
6963 </div>
6964
6965 <!-- _______________________________________________________________________ -->
6966 <h4>
6967   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6968 </h4>
6969
6970 <div>
6971
6972 <h5>Syntax:</h5>
6973 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6974    floating point or vector of floating point type. Not all targets support all
6975    types however.</p>
6976
6977 <pre>
6978   declare float     @llvm.pow.f32(float  %Val, float %Power)
6979   declare double    @llvm.pow.f64(double %Val, double %Power)
6980   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6981   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6982   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6983 </pre>
6984
6985 <h5>Overview:</h5>
6986 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6987    specified (positive or negative) power.</p>
6988
6989 <h5>Arguments:</h5>
6990 <p>The second argument is a floating point power, and the first is a value to
6991    raise to that power.</p>
6992
6993 <h5>Semantics:</h5>
6994 <p>This function returns the first value raised to the second power, returning
6995    the same values as the libm <tt>pow</tt> functions would, and handles error
6996    conditions in the same way.</p>
6997
6998 </div>
6999
7000 </div>
7001
7002 <!-- _______________________________________________________________________ -->
7003 <h4>
7004   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
7005 </h4>
7006
7007 <div>
7008
7009 <h5>Syntax:</h5>
7010 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
7011    floating point or vector of floating point type. Not all targets support all
7012    types however.</p>
7013
7014 <pre>
7015   declare float     @llvm.exp.f32(float  %Val)
7016   declare double    @llvm.exp.f64(double %Val)
7017   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
7018   declare fp128     @llvm.exp.f128(fp128 %Val)
7019   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
7020 </pre>
7021
7022 <h5>Overview:</h5>
7023 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7024
7025 <h5>Arguments:</h5>
7026 <p>The argument and return value are floating point numbers of the same
7027    type.</p>
7028
7029 <h5>Semantics:</h5>
7030 <p>This function returns the same values as the libm <tt>exp</tt> functions
7031    would, and handles error conditions in the same way.</p>
7032
7033 </div>
7034
7035 <!-- _______________________________________________________________________ -->
7036 <h4>
7037   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7038 </h4>
7039
7040 <div>
7041
7042 <h5>Syntax:</h5>
7043 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7044    floating point or vector of floating point type. Not all targets support all
7045    types however.</p>
7046
7047 <pre>
7048   declare float     @llvm.log.f32(float  %Val)
7049   declare double    @llvm.log.f64(double %Val)
7050   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7051   declare fp128     @llvm.log.f128(fp128 %Val)
7052   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7053 </pre>
7054
7055 <h5>Overview:</h5>
7056 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7057
7058 <h5>Arguments:</h5>
7059 <p>The argument and return value are floating point numbers of the same
7060    type.</p>
7061
7062 <h5>Semantics:</h5>
7063 <p>This function returns the same values as the libm <tt>log</tt> functions
7064    would, and handles error conditions in the same way.</p>
7065
7066 <h4>
7067   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7068 </h4>
7069
7070 <div>
7071
7072 <h5>Syntax:</h5>
7073 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7074    floating point or vector of floating point type. Not all targets support all
7075    types however.</p>
7076
7077 <pre>
7078   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7079   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7080   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7081   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7082   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7083 </pre>
7084
7085 <h5>Overview:</h5>
7086 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7087    operation.</p>
7088
7089 <h5>Arguments:</h5>
7090 <p>The argument and return value are floating point numbers of the same
7091    type.</p>
7092
7093 <h5>Semantics:</h5>
7094 <p>This function returns the same values as the libm <tt>fma</tt> functions
7095    would.</p>
7096
7097 </div>
7098
7099 <!-- ======================================================================= -->
7100 <h3>
7101   <a name="int_manip">Bit Manipulation Intrinsics</a>
7102 </h3>
7103
7104 <div>
7105
7106 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7107    These allow efficient code generation for some algorithms.</p>
7108
7109 <!-- _______________________________________________________________________ -->
7110 <h4>
7111   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7112 </h4>
7113
7114 <div>
7115
7116 <h5>Syntax:</h5>
7117 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7118    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7119
7120 <pre>
7121   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7122   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7123   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7124 </pre>
7125
7126 <h5>Overview:</h5>
7127 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7128    values with an even number of bytes (positive multiple of 16 bits).  These
7129    are useful for performing operations on data that is not in the target's
7130    native byte order.</p>
7131
7132 <h5>Semantics:</h5>
7133 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7134    and low byte of the input i16 swapped.  Similarly,
7135    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7136    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7137    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7138    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7139    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7140    more, respectively).</p>
7141
7142 </div>
7143
7144 <!-- _______________________________________________________________________ -->
7145 <h4>
7146   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7147 </h4>
7148
7149 <div>
7150
7151 <h5>Syntax:</h5>
7152 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7153    width, or on any vector with integer elements. Not all targets support all
7154   bit widths or vector types, however.</p>
7155
7156 <pre>
7157   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7158   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7159   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7160   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7161   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7162   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7163 </pre>
7164
7165 <h5>Overview:</h5>
7166 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7167    in a value.</p>
7168
7169 <h5>Arguments:</h5>
7170 <p>The only argument is the value to be counted.  The argument may be of any
7171    integer type, or a vector with integer elements.
7172    The return type must match the argument type.</p>
7173
7174 <h5>Semantics:</h5>
7175 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7176    element of a vector.</p>
7177
7178 </div>
7179
7180 <!-- _______________________________________________________________________ -->
7181 <h4>
7182   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7183 </h4>
7184
7185 <div>
7186
7187 <h5>Syntax:</h5>
7188 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7189    integer bit width, or any vector whose elements are integers. Not all
7190    targets support all bit widths or vector types, however.</p>
7191
7192 <pre>
7193   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
7194   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
7195   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
7196   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
7197   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
7198   declare &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src;gt)
7199 </pre>
7200
7201 <h5>Overview:</h5>
7202 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7203    leading zeros in a variable.</p>
7204
7205 <h5>Arguments:</h5>
7206 <p>The only argument is the value to be counted.  The argument may be of any
7207    integer type, or any vector type with integer element type.
7208    The return type must match the argument type.</p>
7209
7210 <h5>Semantics:</h5>
7211 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7212    zeros in a variable, or within each element of the vector if the operation
7213    is of vector type.  If the src == 0 then the result is the size in bits of
7214    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7215
7216 </div>
7217
7218 <!-- _______________________________________________________________________ -->
7219 <h4>
7220   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7221 </h4>
7222
7223 <div>
7224
7225 <h5>Syntax:</h5>
7226 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7227    integer bit width, or any vector of integer elements. Not all targets
7228    support all bit widths or vector types, however.</p>
7229
7230 <pre>
7231   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
7232   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
7233   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
7234   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
7235   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
7236   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7237 </pre>
7238
7239 <h5>Overview:</h5>
7240 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7241    trailing zeros.</p>
7242
7243 <h5>Arguments:</h5>
7244 <p>The only argument is the value to be counted.  The argument may be of any
7245    integer type, or a vectory with integer element type..  The return type
7246    must match the argument type.</p>
7247
7248 <h5>Semantics:</h5>
7249 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7250    zeros in a variable, or within each element of a vector.
7251    If the src == 0 then the result is the size in bits of
7252    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7253
7254 </div>
7255
7256 </div>
7257
7258 <!-- ======================================================================= -->
7259 <h3>
7260   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7261 </h3>
7262
7263 <div>
7264
7265 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7266
7267 <!-- _______________________________________________________________________ -->
7268 <h4>
7269   <a name="int_sadd_overflow">
7270     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7271   </a>
7272 </h4>
7273
7274 <div>
7275
7276 <h5>Syntax:</h5>
7277 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7278    on any integer bit width.</p>
7279
7280 <pre>
7281   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7282   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7283   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7284 </pre>
7285
7286 <h5>Overview:</h5>
7287 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7288    a signed addition of the two arguments, and indicate whether an overflow
7289    occurred during the signed summation.</p>
7290
7291 <h5>Arguments:</h5>
7292 <p>The arguments (%a and %b) and the first element of the result structure may
7293    be of integer types of any bit width, but they must have the same bit
7294    width. The second element of the result structure must be of
7295    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7296    undergo signed addition.</p>
7297
7298 <h5>Semantics:</h5>
7299 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7300    a signed addition of the two variables. They return a structure &mdash; the
7301    first element of which is the signed summation, and the second element of
7302    which is a bit specifying if the signed summation resulted in an
7303    overflow.</p>
7304
7305 <h5>Examples:</h5>
7306 <pre>
7307   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7308   %sum = extractvalue {i32, i1} %res, 0
7309   %obit = extractvalue {i32, i1} %res, 1
7310   br i1 %obit, label %overflow, label %normal
7311 </pre>
7312
7313 </div>
7314
7315 <!-- _______________________________________________________________________ -->
7316 <h4>
7317   <a name="int_uadd_overflow">
7318     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7319   </a>
7320 </h4>
7321
7322 <div>
7323
7324 <h5>Syntax:</h5>
7325 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7326    on any integer bit width.</p>
7327
7328 <pre>
7329   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7330   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7331   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7332 </pre>
7333
7334 <h5>Overview:</h5>
7335 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7336    an unsigned addition of the two arguments, and indicate whether a carry
7337    occurred during the unsigned summation.</p>
7338
7339 <h5>Arguments:</h5>
7340 <p>The arguments (%a and %b) and the first element of the result structure may
7341    be of integer types of any bit width, but they must have the same bit
7342    width. The second element of the result structure must be of
7343    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7344    undergo unsigned addition.</p>
7345
7346 <h5>Semantics:</h5>
7347 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7348    an unsigned addition of the two arguments. They return a structure &mdash;
7349    the first element of which is the sum, and the second element of which is a
7350    bit specifying if the unsigned summation resulted in a carry.</p>
7351
7352 <h5>Examples:</h5>
7353 <pre>
7354   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7355   %sum = extractvalue {i32, i1} %res, 0
7356   %obit = extractvalue {i32, i1} %res, 1
7357   br i1 %obit, label %carry, label %normal
7358 </pre>
7359
7360 </div>
7361
7362 <!-- _______________________________________________________________________ -->
7363 <h4>
7364   <a name="int_ssub_overflow">
7365     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7366   </a>
7367 </h4>
7368
7369 <div>
7370
7371 <h5>Syntax:</h5>
7372 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7373    on any integer bit width.</p>
7374
7375 <pre>
7376   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7377   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7378   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7379 </pre>
7380
7381 <h5>Overview:</h5>
7382 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7383    a signed subtraction of the two arguments, and indicate whether an overflow
7384    occurred during the signed subtraction.</p>
7385
7386 <h5>Arguments:</h5>
7387 <p>The arguments (%a and %b) and the first element of the result structure may
7388    be of integer types of any bit width, but they must have the same bit
7389    width. The second element of the result structure must be of
7390    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7391    undergo signed subtraction.</p>
7392
7393 <h5>Semantics:</h5>
7394 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7395    a signed subtraction of the two arguments. They return a structure &mdash;
7396    the first element of which is the subtraction, and the second element of
7397    which is a bit specifying if the signed subtraction resulted in an
7398    overflow.</p>
7399
7400 <h5>Examples:</h5>
7401 <pre>
7402   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7403   %sum = extractvalue {i32, i1} %res, 0
7404   %obit = extractvalue {i32, i1} %res, 1
7405   br i1 %obit, label %overflow, label %normal
7406 </pre>
7407
7408 </div>
7409
7410 <!-- _______________________________________________________________________ -->
7411 <h4>
7412   <a name="int_usub_overflow">
7413     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7414   </a>
7415 </h4>
7416
7417 <div>
7418
7419 <h5>Syntax:</h5>
7420 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7421    on any integer bit width.</p>
7422
7423 <pre>
7424   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7425   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7426   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7427 </pre>
7428
7429 <h5>Overview:</h5>
7430 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7431    an unsigned subtraction of the two arguments, and indicate whether an
7432    overflow occurred during the unsigned subtraction.</p>
7433
7434 <h5>Arguments:</h5>
7435 <p>The arguments (%a and %b) and the first element of the result structure may
7436    be of integer types of any bit width, but they must have the same bit
7437    width. The second element of the result structure must be of
7438    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7439    undergo unsigned subtraction.</p>
7440
7441 <h5>Semantics:</h5>
7442 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7443    an unsigned subtraction of the two arguments. They return a structure &mdash;
7444    the first element of which is the subtraction, and the second element of
7445    which is a bit specifying if the unsigned subtraction resulted in an
7446    overflow.</p>
7447
7448 <h5>Examples:</h5>
7449 <pre>
7450   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7451   %sum = extractvalue {i32, i1} %res, 0
7452   %obit = extractvalue {i32, i1} %res, 1
7453   br i1 %obit, label %overflow, label %normal
7454 </pre>
7455
7456 </div>
7457
7458 <!-- _______________________________________________________________________ -->
7459 <h4>
7460   <a name="int_smul_overflow">
7461     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7462   </a>
7463 </h4>
7464
7465 <div>
7466
7467 <h5>Syntax:</h5>
7468 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7469    on any integer bit width.</p>
7470
7471 <pre>
7472   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7473   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7474   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7475 </pre>
7476
7477 <h5>Overview:</h5>
7478
7479 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7480    a signed multiplication of the two arguments, and indicate whether an
7481    overflow occurred during the signed multiplication.</p>
7482
7483 <h5>Arguments:</h5>
7484 <p>The arguments (%a and %b) and the first element of the result structure may
7485    be of integer types of any bit width, but they must have the same bit
7486    width. The second element of the result structure must be of
7487    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7488    undergo signed multiplication.</p>
7489
7490 <h5>Semantics:</h5>
7491 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7492    a signed multiplication of the two arguments. They return a structure &mdash;
7493    the first element of which is the multiplication, and the second element of
7494    which is a bit specifying if the signed multiplication resulted in an
7495    overflow.</p>
7496
7497 <h5>Examples:</h5>
7498 <pre>
7499   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7500   %sum = extractvalue {i32, i1} %res, 0
7501   %obit = extractvalue {i32, i1} %res, 1
7502   br i1 %obit, label %overflow, label %normal
7503 </pre>
7504
7505 </div>
7506
7507 <!-- _______________________________________________________________________ -->
7508 <h4>
7509   <a name="int_umul_overflow">
7510     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7511   </a>
7512 </h4>
7513
7514 <div>
7515
7516 <h5>Syntax:</h5>
7517 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7518    on any integer bit width.</p>
7519
7520 <pre>
7521   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7522   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7523   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7524 </pre>
7525
7526 <h5>Overview:</h5>
7527 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7528    a unsigned multiplication of the two arguments, and indicate whether an
7529    overflow occurred during the unsigned multiplication.</p>
7530
7531 <h5>Arguments:</h5>
7532 <p>The arguments (%a and %b) and the first element of the result structure may
7533    be of integer types of any bit width, but they must have the same bit
7534    width. The second element of the result structure must be of
7535    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7536    undergo unsigned multiplication.</p>
7537
7538 <h5>Semantics:</h5>
7539 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7540    an unsigned multiplication of the two arguments. They return a structure
7541    &mdash; the first element of which is the multiplication, and the second
7542    element of which is a bit specifying if the unsigned multiplication resulted
7543    in an overflow.</p>
7544
7545 <h5>Examples:</h5>
7546 <pre>
7547   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7548   %sum = extractvalue {i32, i1} %res, 0
7549   %obit = extractvalue {i32, i1} %res, 1
7550   br i1 %obit, label %overflow, label %normal
7551 </pre>
7552
7553 </div>
7554
7555 </div>
7556
7557 <!-- ======================================================================= -->
7558 <h3>
7559   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7560 </h3>
7561
7562 <div>
7563
7564 <p>Half precision floating point is a storage-only format. This means that it is
7565    a dense encoding (in memory) but does not support computation in the
7566    format.</p>
7567
7568 <p>This means that code must first load the half-precision floating point
7569    value as an i16, then convert it to float with <a
7570    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7571    Computation can then be performed on the float value (including extending to
7572    double etc).  To store the value back to memory, it is first converted to
7573    float if needed, then converted to i16 with
7574    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7575    storing as an i16 value.</p>
7576
7577 <!-- _______________________________________________________________________ -->
7578 <h4>
7579   <a name="int_convert_to_fp16">
7580     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7581   </a>
7582 </h4>
7583
7584 <div>
7585
7586 <h5>Syntax:</h5>
7587 <pre>
7588   declare i16 @llvm.convert.to.fp16(f32 %a)
7589 </pre>
7590
7591 <h5>Overview:</h5>
7592 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7593    a conversion from single precision floating point format to half precision
7594    floating point format.</p>
7595
7596 <h5>Arguments:</h5>
7597 <p>The intrinsic function contains single argument - the value to be
7598    converted.</p>
7599
7600 <h5>Semantics:</h5>
7601 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7602    a conversion from single precision floating point format to half precision
7603    floating point format. The return value is an <tt>i16</tt> which
7604    contains the converted number.</p>
7605
7606 <h5>Examples:</h5>
7607 <pre>
7608   %res = call i16 @llvm.convert.to.fp16(f32 %a)
7609   store i16 %res, i16* @x, align 2
7610 </pre>
7611
7612 </div>
7613
7614 <!-- _______________________________________________________________________ -->
7615 <h4>
7616   <a name="int_convert_from_fp16">
7617     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
7618   </a>
7619 </h4>
7620
7621 <div>
7622
7623 <h5>Syntax:</h5>
7624 <pre>
7625   declare f32 @llvm.convert.from.fp16(i16 %a)
7626 </pre>
7627
7628 <h5>Overview:</h5>
7629 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
7630    a conversion from half precision floating point format to single precision
7631    floating point format.</p>
7632
7633 <h5>Arguments:</h5>
7634 <p>The intrinsic function contains single argument - the value to be
7635    converted.</p>
7636
7637 <h5>Semantics:</h5>
7638 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
7639    conversion from half single precision floating point format to single
7640    precision floating point format. The input half-float value is represented by
7641    an <tt>i16</tt> value.</p>
7642
7643 <h5>Examples:</h5>
7644 <pre>
7645   %a = load i16* @x, align 2
7646   %res = call f32 @llvm.convert.from.fp16(i16 %a)
7647 </pre>
7648
7649 </div>
7650
7651 </div>
7652
7653 <!-- ======================================================================= -->
7654 <h3>
7655   <a name="int_debugger">Debugger Intrinsics</a>
7656 </h3>
7657
7658 <div>
7659
7660 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
7661    prefix), are described in
7662    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
7663    Level Debugging</a> document.</p>
7664
7665 </div>
7666
7667 <!-- ======================================================================= -->
7668 <h3>
7669   <a name="int_eh">Exception Handling Intrinsics</a>
7670 </h3>
7671
7672 <div>
7673
7674 <p>The LLVM exception handling intrinsics (which all start with
7675    <tt>llvm.eh.</tt> prefix), are described in
7676    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
7677    Handling</a> document.</p>
7678
7679 </div>
7680
7681 <!-- ======================================================================= -->
7682 <h3>
7683   <a name="int_trampoline">Trampoline Intrinsic</a>
7684 </h3>
7685
7686 <div>
7687
7688 <p>This intrinsic makes it possible to excise one parameter, marked with
7689    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
7690    The result is a callable
7691    function pointer lacking the nest parameter - the caller does not need to
7692    provide a value for it.  Instead, the value to use is stored in advance in a
7693    "trampoline", a block of memory usually allocated on the stack, which also
7694    contains code to splice the nest value into the argument list.  This is used
7695    to implement the GCC nested function address extension.</p>
7696
7697 <p>For example, if the function is
7698    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
7699    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
7700    follows:</p>
7701
7702 <pre class="doc_code">
7703   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
7704   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
7705   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8*, i32, i32)* @f to i8*), i8* %nval)
7706   %fp = bitcast i8* %p to i32 (i32, i32)*
7707 </pre>
7708
7709 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
7710    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
7711
7712 <!-- _______________________________________________________________________ -->
7713 <h4>
7714   <a name="int_it">
7715     '<tt>llvm.init.trampoline</tt>' Intrinsic
7716   </a>
7717 </h4>
7718
7719 <div>
7720
7721 <h5>Syntax:</h5>
7722 <pre>
7723   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7724 </pre>
7725
7726 <h5>Overview:</h5>
7727 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
7728    function pointer suitable for executing it.</p>
7729
7730 <h5>Arguments:</h5>
7731 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7732    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7733    sufficiently aligned block of memory; this memory is written to by the
7734    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7735    currently provides no portable way of determining them, so a front-end that
7736    generates this intrinsic needs to have some target-specific knowledge.
7737    The <tt>func</tt> argument must hold a function bitcast to
7738    an <tt>i8*</tt>.</p>
7739
7740 <h5>Semantics:</h5>
7741 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7742    dependent code, turning it into a function.  A pointer to this function is
7743    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
7744    function pointer type</a> before being called.  The new function's signature
7745    is the same as that of <tt>func</tt> with any arguments marked with
7746    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
7747    is allowed, and it must be of pointer type.  Calling the new function is
7748    equivalent to calling <tt>func</tt> with the same argument list, but
7749    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7750    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7751    by <tt>tramp</tt> is modified, then the effect of any later call to the
7752    returned function pointer is undefined.</p>
7753
7754 </div>
7755
7756 </div>
7757
7758 <!-- ======================================================================= -->
7759 <h3>
7760   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7761 </h3>
7762
7763 <div>
7764
7765 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7766    hardware constructs for atomic operations and memory synchronization.  This
7767    provides an interface to the hardware, not an interface to the programmer. It
7768    is aimed at a low enough level to allow any programming models or APIs
7769    (Application Programming Interfaces) which need atomic behaviors to map
7770    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7771    hardware provides a "universal IR" for source languages, it also provides a
7772    starting point for developing a "universal" atomic operation and
7773    synchronization IR.</p>
7774
7775 <p>These do <em>not</em> form an API such as high-level threading libraries,
7776    software transaction memory systems, atomic primitives, and intrinsic
7777    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7778    application libraries.  The hardware interface provided by LLVM should allow
7779    a clean implementation of all of these APIs and parallel programming models.
7780    No one model or paradigm should be selected above others unless the hardware
7781    itself ubiquitously does so.</p>
7782
7783 <!-- _______________________________________________________________________ -->
7784 <h4>
7785   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7786 </h4>
7787
7788 <div>
7789 <h5>Syntax:</h5>
7790 <pre>
7791   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;)
7792 </pre>
7793
7794 <h5>Overview:</h5>
7795 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7796    specific pairs of memory access types.</p>
7797
7798 <h5>Arguments:</h5>
7799 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7800    The first four arguments enables a specific barrier as listed below.  The
7801    fifth argument specifies that the barrier applies to io or device or uncached
7802    memory.</p>
7803
7804 <ul>
7805   <li><tt>ll</tt>: load-load barrier</li>
7806   <li><tt>ls</tt>: load-store barrier</li>
7807   <li><tt>sl</tt>: store-load barrier</li>
7808   <li><tt>ss</tt>: store-store barrier</li>
7809   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7810 </ul>
7811
7812 <h5>Semantics:</h5>
7813 <p>This intrinsic causes the system to enforce some ordering constraints upon
7814    the loads and stores of the program. This barrier does not
7815    indicate <em>when</em> any events will occur, it only enforces
7816    an <em>order</em> in which they occur. For any of the specified pairs of load
7817    and store operations (f.ex.  load-load, or store-load), all of the first
7818    operations preceding the barrier will complete before any of the second
7819    operations succeeding the barrier begin. Specifically the semantics for each
7820    pairing is as follows:</p>
7821
7822 <ul>
7823   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7824       after the barrier begins.</li>
7825   <li><tt>ls</tt>: All loads before the barrier must complete before any
7826       store after the barrier begins.</li>
7827   <li><tt>ss</tt>: All stores before the barrier must complete before any
7828       store after the barrier begins.</li>
7829   <li><tt>sl</tt>: All stores before the barrier must complete before any
7830       load after the barrier begins.</li>
7831 </ul>
7832
7833 <p>These semantics are applied with a logical "and" behavior when more than one
7834    is enabled in a single memory barrier intrinsic.</p>
7835
7836 <p>Backends may implement stronger barriers than those requested when they do
7837    not support as fine grained a barrier as requested.  Some architectures do
7838    not need all types of barriers and on such architectures, these become
7839    noops.</p>
7840
7841 <h5>Example:</h5>
7842 <pre>
7843 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7844 %ptr      = bitcast i8* %mallocP to i32*
7845             store i32 4, %ptr
7846
7847 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7848             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false, i1 true)
7849                                 <i>; guarantee the above finishes</i>
7850             store i32 8, %ptr   <i>; before this begins</i>
7851 </pre>
7852
7853 </div>
7854
7855 <!-- _______________________________________________________________________ -->
7856 <h4>
7857   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7858 </h4>
7859
7860 <div>
7861
7862 <h5>Syntax:</h5>
7863 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7864    any integer bit width and for different address spaces. Not all targets
7865    support all bit widths however.</p>
7866
7867 <pre>
7868   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7869   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7870   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7871   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7872 </pre>
7873
7874 <h5>Overview:</h5>
7875 <p>This loads a value in memory and compares it to a given value. If they are
7876    equal, it stores a new value into the memory.</p>
7877
7878 <h5>Arguments:</h5>
7879 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7880    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7881    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7882    this integer type. While any bit width integer may be used, targets may only
7883    lower representations they support in hardware.</p>
7884
7885 <h5>Semantics:</h5>
7886 <p>This entire intrinsic must be executed atomically. It first loads the value
7887    in memory pointed to by <tt>ptr</tt> and compares it with the
7888    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7889    memory. The loaded value is yielded in all cases. This provides the
7890    equivalent of an atomic compare-and-swap operation within the SSA
7891    framework.</p>
7892
7893 <h5>Examples:</h5>
7894 <pre>
7895 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7896 %ptr      = bitcast i8* %mallocP to i32*
7897             store i32 4, %ptr
7898
7899 %val1     = add i32 4, 4
7900 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7901                                           <i>; yields {i32}:result1 = 4</i>
7902 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7903 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7904
7905 %val2     = add i32 1, 1
7906 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7907                                           <i>; yields {i32}:result2 = 8</i>
7908 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7909
7910 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7911 </pre>
7912
7913 </div>
7914
7915 <!-- _______________________________________________________________________ -->
7916 <h4>
7917   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7918 </h4>
7919
7920 <div>
7921 <h5>Syntax:</h5>
7922
7923 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7924    integer bit width. Not all targets support all bit widths however.</p>
7925
7926 <pre>
7927   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7928   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7929   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7930   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7931 </pre>
7932
7933 <h5>Overview:</h5>
7934 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7935    the value from memory. It then stores the value in <tt>val</tt> in the memory
7936    at <tt>ptr</tt>.</p>
7937
7938 <h5>Arguments:</h5>
7939 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7940   the <tt>val</tt> argument and the result must be integers of the same bit
7941   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7942   integer type. The targets may only lower integer representations they
7943   support.</p>
7944
7945 <h5>Semantics:</h5>
7946 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7947    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7948    equivalent of an atomic swap operation within the SSA framework.</p>
7949
7950 <h5>Examples:</h5>
7951 <pre>
7952 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7953 %ptr      = bitcast i8* %mallocP to i32*
7954             store i32 4, %ptr
7955
7956 %val1     = add i32 4, 4
7957 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7958                                         <i>; yields {i32}:result1 = 4</i>
7959 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7960 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7961
7962 %val2     = add i32 1, 1
7963 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7964                                         <i>; yields {i32}:result2 = 8</i>
7965
7966 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7967 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7968 </pre>
7969
7970 </div>
7971
7972 <!-- _______________________________________________________________________ -->
7973 <h4>
7974   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7975 </h4>
7976
7977 <div>
7978
7979 <h5>Syntax:</h5>
7980 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7981    any integer bit width. Not all targets support all bit widths however.</p>
7982
7983 <pre>
7984   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7985   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7986   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7987   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7988 </pre>
7989
7990 <h5>Overview:</h5>
7991 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7992    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7993
7994 <h5>Arguments:</h5>
7995 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7996    and the second an integer value. The result is also an integer value. These
7997    integer types can have any bit width, but they must all have the same bit
7998    width. The targets may only lower integer representations they support.</p>
7999
8000 <h5>Semantics:</h5>
8001 <p>This intrinsic does a series of operations atomically. It first loads the
8002    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
8003    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
8004
8005 <h5>Examples:</h5>
8006 <pre>
8007 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8008 %ptr      = bitcast i8* %mallocP to i32*
8009             store i32 4, %ptr
8010 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
8011                                 <i>; yields {i32}:result1 = 4</i>
8012 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
8013                                 <i>; yields {i32}:result2 = 8</i>
8014 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
8015                                 <i>; yields {i32}:result3 = 10</i>
8016 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
8017 </pre>
8018
8019 </div>
8020
8021 <!-- _______________________________________________________________________ -->
8022 <h4>
8023   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
8024 </h4>
8025
8026 <div>
8027
8028 <h5>Syntax:</h5>
8029 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
8030    any integer bit width and for different address spaces. Not all targets
8031    support all bit widths however.</p>
8032
8033 <pre>
8034   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8035   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8036   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8037   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8038 </pre>
8039
8040 <h5>Overview:</h5>
8041 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
8042    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
8043
8044 <h5>Arguments:</h5>
8045 <p>The intrinsic takes two arguments, the first a pointer to an integer value
8046    and the second an integer value. The result is also an integer value. These
8047    integer types can have any bit width, but they must all have the same bit
8048    width. The targets may only lower integer representations they support.</p>
8049
8050 <h5>Semantics:</h5>
8051 <p>This intrinsic does a series of operations atomically. It first loads the
8052    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
8053    result to <tt>ptr</tt>. It yields the original value stored
8054    at <tt>ptr</tt>.</p>
8055
8056 <h5>Examples:</h5>
8057 <pre>
8058 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8059 %ptr      = bitcast i8* %mallocP to i32*
8060             store i32 8, %ptr
8061 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
8062                                 <i>; yields {i32}:result1 = 8</i>
8063 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
8064                                 <i>; yields {i32}:result2 = 4</i>
8065 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
8066                                 <i>; yields {i32}:result3 = 2</i>
8067 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
8068 </pre>
8069
8070 </div>
8071
8072 <!-- _______________________________________________________________________ -->
8073 <h4>
8074   <a name="int_atomic_load_and">
8075     '<tt>llvm.atomic.load.and.*</tt>' Intrinsic
8076   </a>
8077   <br>
8078   <a name="int_atomic_load_nand">
8079     '<tt>llvm.atomic.load.nand.*</tt>' Intrinsic
8080   </a>
8081   <br>
8082   <a name="int_atomic_load_or">
8083     '<tt>llvm.atomic.load.or.*</tt>' Intrinsic
8084   </a>
8085   <br>
8086   <a name="int_atomic_load_xor">
8087     '<tt>llvm.atomic.load.xor.*</tt>' Intrinsic
8088   </a>
8089 </h4>
8090
8091 <div>
8092
8093 <h5>Syntax:</h5>
8094 <p>These are overloaded intrinsics. You can
8095   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
8096   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
8097   bit width and for different address spaces. Not all targets support all bit
8098   widths however.</p>
8099
8100 <pre>
8101   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8102   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8103   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8104   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8105 </pre>
8106
8107 <pre>
8108   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8109   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8110   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8111   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8112 </pre>
8113
8114 <pre>
8115   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8116   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8117   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8118   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8119 </pre>
8120
8121 <pre>
8122   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8123   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8124   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8125   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8126 </pre>
8127
8128 <h5>Overview:</h5>
8129 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
8130    the value stored in memory at <tt>ptr</tt>. It yields the original value
8131    at <tt>ptr</tt>.</p>
8132
8133 <h5>Arguments:</h5>
8134 <p>These intrinsics take two arguments, the first a pointer to an integer value
8135    and the second an integer value. The result is also an integer value. These
8136    integer types can have any bit width, but they must all have the same bit
8137    width. The targets may only lower integer representations they support.</p>
8138
8139 <h5>Semantics:</h5>
8140 <p>These intrinsics does a series of operations atomically. They first load the
8141    value stored at <tt>ptr</tt>. They then do the bitwise
8142    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
8143    original value stored at <tt>ptr</tt>.</p>
8144
8145 <h5>Examples:</h5>
8146 <pre>
8147 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8148 %ptr      = bitcast i8* %mallocP to i32*
8149             store i32 0x0F0F, %ptr
8150 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
8151                                 <i>; yields {i32}:result0 = 0x0F0F</i>
8152 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
8153                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
8154 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
8155                                 <i>; yields {i32}:result2 = 0xF0</i>
8156 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
8157                                 <i>; yields {i32}:result3 = FF</i>
8158 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
8159 </pre>
8160
8161 </div>
8162
8163 <!-- _______________________________________________________________________ -->
8164 <h4>
8165   <a name="int_atomic_load_max">
8166     '<tt>llvm.atomic.load.max.*</tt>' Intrinsic
8167   </a>
8168   <br>
8169   <a name="int_atomic_load_min">
8170     '<tt>llvm.atomic.load.min.*</tt>' Intrinsic
8171   </a>
8172   <br>
8173   <a name="int_atomic_load_umax">
8174     '<tt>llvm.atomic.load.umax.*</tt>' Intrinsic
8175   </a>
8176   <br>
8177   <a name="int_atomic_load_umin">
8178     '<tt>llvm.atomic.load.umin.*</tt>' Intrinsic
8179   </a>
8180 </h4>
8181
8182 <div>
8183
8184 <h5>Syntax:</h5>
8185 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
8186    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
8187    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
8188    address spaces. Not all targets support all bit widths however.</p>
8189
8190 <pre>
8191   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8192   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8193   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8194   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8195 </pre>
8196
8197 <pre>
8198   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8199   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8200   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8201   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8202 </pre>
8203
8204 <pre>
8205   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8206   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8207   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8208   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8209 </pre>
8210
8211 <pre>
8212   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8213   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8214   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8215   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8216 </pre>
8217
8218 <h5>Overview:</h5>
8219 <p>These intrinsics takes the signed or unsigned minimum or maximum of
8220    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
8221    original value at <tt>ptr</tt>.</p>
8222
8223 <h5>Arguments:</h5>
8224 <p>These intrinsics take two arguments, the first a pointer to an integer value
8225    and the second an integer value. The result is also an integer value. These
8226    integer types can have any bit width, but they must all have the same bit
8227    width. The targets may only lower integer representations they support.</p>
8228
8229 <h5>Semantics:</h5>
8230 <p>These intrinsics does a series of operations atomically. They first load the
8231    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
8232    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
8233    yield the original value stored at <tt>ptr</tt>.</p>
8234
8235 <h5>Examples:</h5>
8236 <pre>
8237 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8238 %ptr      = bitcast i8* %mallocP to i32*
8239             store i32 7, %ptr
8240 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
8241                                 <i>; yields {i32}:result0 = 7</i>
8242 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
8243                                 <i>; yields {i32}:result1 = -2</i>
8244 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
8245                                 <i>; yields {i32}:result2 = 8</i>
8246 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
8247                                 <i>; yields {i32}:result3 = 8</i>
8248 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
8249 </pre>
8250
8251 </div>
8252
8253 </div>
8254
8255 <!-- ======================================================================= -->
8256 <h3>
8257   <a name="int_memorymarkers">Memory Use Markers</a>
8258 </h3>
8259
8260 <div>
8261
8262 <p>This class of intrinsics exists to information about the lifetime of memory
8263    objects and ranges where variables are immutable.</p>
8264
8265 <!-- _______________________________________________________________________ -->
8266 <h4>
8267   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
8268 </h4>
8269
8270 <div>
8271
8272 <h5>Syntax:</h5>
8273 <pre>
8274   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8275 </pre>
8276
8277 <h5>Overview:</h5>
8278 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
8279    object's lifetime.</p>
8280
8281 <h5>Arguments:</h5>
8282 <p>The first argument is a constant integer representing the size of the
8283    object, or -1 if it is variable sized.  The second argument is a pointer to
8284    the object.</p>
8285
8286 <h5>Semantics:</h5>
8287 <p>This intrinsic indicates that before this point in the code, the value of the
8288    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8289    never be used and has an undefined value.  A load from the pointer that
8290    precedes this intrinsic can be replaced with
8291    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
8292
8293 </div>
8294
8295 <!-- _______________________________________________________________________ -->
8296 <h4>
8297   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
8298 </h4>
8299
8300 <div>
8301
8302 <h5>Syntax:</h5>
8303 <pre>
8304   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8305 </pre>
8306
8307 <h5>Overview:</h5>
8308 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
8309    object's lifetime.</p>
8310
8311 <h5>Arguments:</h5>
8312 <p>The first argument is a constant integer representing the size of the
8313    object, or -1 if it is variable sized.  The second argument is a pointer to
8314    the object.</p>
8315
8316 <h5>Semantics:</h5>
8317 <p>This intrinsic indicates that after this point in the code, the value of the
8318    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8319    never be used and has an undefined value.  Any stores into the memory object
8320    following this intrinsic may be removed as dead.
8321
8322 </div>
8323
8324 <!-- _______________________________________________________________________ -->
8325 <h4>
8326   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
8327 </h4>
8328
8329 <div>
8330
8331 <h5>Syntax:</h5>
8332 <pre>
8333   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8334 </pre>
8335
8336 <h5>Overview:</h5>
8337 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
8338    a memory object will not change.</p>
8339
8340 <h5>Arguments:</h5>
8341 <p>The first argument is a constant integer representing the size of the
8342    object, or -1 if it is variable sized.  The second argument is a pointer to
8343    the object.</p>
8344
8345 <h5>Semantics:</h5>
8346 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8347    the return value, the referenced memory location is constant and
8348    unchanging.</p>
8349
8350 </div>
8351
8352 <!-- _______________________________________________________________________ -->
8353 <h4>
8354   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8355 </h4>
8356
8357 <div>
8358
8359 <h5>Syntax:</h5>
8360 <pre>
8361   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8362 </pre>
8363
8364 <h5>Overview:</h5>
8365 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8366    a memory object are mutable.</p>
8367
8368 <h5>Arguments:</h5>
8369 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8370    The second argument is a constant integer representing the size of the
8371    object, or -1 if it is variable sized and the third argument is a pointer
8372    to the object.</p>
8373
8374 <h5>Semantics:</h5>
8375 <p>This intrinsic indicates that the memory is mutable again.</p>
8376
8377 </div>
8378
8379 </div>
8380
8381 <!-- ======================================================================= -->
8382 <h3>
8383   <a name="int_general">General Intrinsics</a>
8384 </h3>
8385
8386 <div>
8387
8388 <p>This class of intrinsics is designed to be generic and has no specific
8389    purpose.</p>
8390
8391 <!-- _______________________________________________________________________ -->
8392 <h4>
8393   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8394 </h4>
8395
8396 <div>
8397
8398 <h5>Syntax:</h5>
8399 <pre>
8400   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8401 </pre>
8402
8403 <h5>Overview:</h5>
8404 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8405
8406 <h5>Arguments:</h5>
8407 <p>The first argument is a pointer to a value, the second is a pointer to a
8408    global string, the third is a pointer to a global string which is the source
8409    file name, and the last argument is the line number.</p>
8410
8411 <h5>Semantics:</h5>
8412 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8413    This can be useful for special purpose optimizations that want to look for
8414    these annotations.  These have no other defined use; they are ignored by code
8415    generation and optimization.</p>
8416
8417 </div>
8418
8419 <!-- _______________________________________________________________________ -->
8420 <h4>
8421   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8422 </h4>
8423
8424 <div>
8425
8426 <h5>Syntax:</h5>
8427 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8428    any integer bit width.</p>
8429
8430 <pre>
8431   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8432   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8433   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8434   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8435   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8436 </pre>
8437
8438 <h5>Overview:</h5>
8439 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8440
8441 <h5>Arguments:</h5>
8442 <p>The first argument is an integer value (result of some expression), the
8443    second is a pointer to a global string, the third is a pointer to a global
8444    string which is the source file name, and the last argument is the line
8445    number.  It returns the value of the first argument.</p>
8446
8447 <h5>Semantics:</h5>
8448 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8449    arbitrary strings.  This can be useful for special purpose optimizations that
8450    want to look for these annotations.  These have no other defined use; they
8451    are ignored by code generation and optimization.</p>
8452
8453 </div>
8454
8455 <!-- _______________________________________________________________________ -->
8456 <h4>
8457   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8458 </h4>
8459
8460 <div>
8461
8462 <h5>Syntax:</h5>
8463 <pre>
8464   declare void @llvm.trap()
8465 </pre>
8466
8467 <h5>Overview:</h5>
8468 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8469
8470 <h5>Arguments:</h5>
8471 <p>None.</p>
8472
8473 <h5>Semantics:</h5>
8474 <p>This intrinsics is lowered to the target dependent trap instruction. If the
8475    target does not have a trap instruction, this intrinsic will be lowered to
8476    the call of the <tt>abort()</tt> function.</p>
8477
8478 </div>
8479
8480 <!-- _______________________________________________________________________ -->
8481 <h4>
8482   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8483 </h4>
8484
8485 <div>
8486
8487 <h5>Syntax:</h5>
8488 <pre>
8489   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8490 </pre>
8491
8492 <h5>Overview:</h5>
8493 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8494    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8495    ensure that it is placed on the stack before local variables.</p>
8496
8497 <h5>Arguments:</h5>
8498 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8499    arguments. The first argument is the value loaded from the stack
8500    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8501    that has enough space to hold the value of the guard.</p>
8502
8503 <h5>Semantics:</h5>
8504 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8505    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8506    stack. This is to ensure that if a local variable on the stack is
8507    overwritten, it will destroy the value of the guard. When the function exits,
8508    the guard on the stack is checked against the original guard. If they are
8509    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8510    function.</p>
8511
8512 </div>
8513
8514 <!-- _______________________________________________________________________ -->
8515 <h4>
8516   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8517 </h4>
8518
8519 <div>
8520
8521 <h5>Syntax:</h5>
8522 <pre>
8523   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
8524   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
8525 </pre>
8526
8527 <h5>Overview:</h5>
8528 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8529    the optimizers to determine at compile time whether a) an operation (like
8530    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8531    runtime check for overflow isn't necessary. An object in this context means
8532    an allocation of a specific class, structure, array, or other object.</p>
8533
8534 <h5>Arguments:</h5>
8535 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8536    argument is a pointer to or into the <tt>object</tt>. The second argument
8537    is a boolean 0 or 1. This argument determines whether you want the
8538    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
8539    1, variables are not allowed.</p>
8540
8541 <h5>Semantics:</h5>
8542 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
8543    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
8544    depending on the <tt>type</tt> argument, if the size cannot be determined at
8545    compile time.</p>
8546
8547 </div>
8548
8549 </div>
8550
8551 </div>
8552
8553 <!-- *********************************************************************** -->
8554 <hr>
8555 <address>
8556   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8557   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8558   <a href="http://validator.w3.org/check/referer"><img
8559   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8560
8561   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8562   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8563   Last modified: $Date$
8564 </address>
8565
8566 </body>
8567 </html>