docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Assembly Language Reference Manual</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   7   <meta name="author" content="Chris Lattner">
   8   <meta name="description"
   9   content="LLVM Assembly Language Reference Manual.">
  10   <link rel="stylesheet" href="llvm.css" type="text/css">
  11 </head>
  12
  13 <body>
  14
  15 <h1>LLVM Language Reference Manual</h1>
  16 <ol>
  17   <li><a href="#abstract">Abstract</a></li>
  18   <li><a href="#introduction">Introduction</a></li>
  19   <li><a href="#identifiers">Identifiers</a></li>
  20   <li><a href="#highlevel">High Level Structure</a>
  21     <ol>
  22       <li><a href="#modulestructure">Module Structure</a></li>
  23       <li><a href="#linkage">Linkage Types</a>
  24         <ol>
  25           <li><a href="#linkage_private">'<tt>private</tt>' Linkage</a></li>
  26           <li><a href="#linkage_linker_private">'<tt>linker_private</tt>' Linkage</a></li>
  27           <li><a href="#linkage_linker_private_weak">'<tt>linker_private_weak</tt>' Linkage</a></li>
  28           <li><a href="#linkage_linker_private_weak_def_auto">'<tt>linker_private_weak_def_auto</tt>' Linkage</a></li>
  29           <li><a href="#linkage_internal">'<tt>internal</tt>' Linkage</a></li>
  30           <li><a href="#linkage_available_externally">'<tt>available_externally</tt>' Linkage</a></li>
  31           <li><a href="#linkage_linkonce">'<tt>linkonce</tt>' Linkage</a></li>
  32           <li><a href="#linkage_common">'<tt>common</tt>' Linkage</a></li>
  33           <li><a href="#linkage_weak">'<tt>weak</tt>' Linkage</a></li>
  34           <li><a href="#linkage_appending">'<tt>appending</tt>' Linkage</a></li>
  35           <li><a href="#linkage_externweak">'<tt>extern_weak</tt>' Linkage</a></li>
  36           <li><a href="#linkage_linkonce_odr">'<tt>linkonce_odr</tt>' Linkage</a></li>
  37           <li><a href="#linkage_weak">'<tt>weak_odr</tt>' Linkage</a></li>
  38           <li><a href="#linkage_external">'<tt>externally visible</tt>' Linkage</a></li>
  39           <li><a href="#linkage_dllimport">'<tt>dllimport</tt>' Linkage</a></li>
  40           <li><a href="#linkage_dllexport">'<tt>dllexport</tt>' Linkage</a></li>
  41         </ol>
  42       </li>
  43       <li><a href="#callingconv">Calling Conventions</a></li>
  44       <li><a href="#namedtypes">Named Types</a></li>
  45       <li><a href="#globalvars">Global Variables</a></li>
  46       <li><a href="#functionstructure">Functions</a></li>
  47       <li><a href="#aliasstructure">Aliases</a></li>
  48       <li><a href="#namedmetadatastructure">Named Metadata</a></li>
  49       <li><a href="#paramattrs">Parameter Attributes</a></li>
  50       <li><a href="#fnattrs">Function Attributes</a></li>
  51       <li><a href="#gc">Garbage Collector Names</a></li>
  52       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  53       <li><a href="#datalayout">Data Layout</a></li>
  54       <li><a href="#pointeraliasing">Pointer Aliasing Rules</a></li>
  55       <li><a href="#volatile">Volatile Memory Accesses</a></li>
  56       <li><a href="#memmodel">Memory Model for Concurrent Operations</a></li>
  57       <li><a href="#ordering">Atomic Memory Ordering Constraints</a></li>
  58     </ol>
  59   </li>
  60   <li><a href="#typesystem">Type System</a>
  61     <ol>
  62       <li><a href="#t_classifications">Type Classifications</a></li>
  63       <li><a href="#t_primitive">Primitive Types</a>
  64         <ol>
  65           <li><a href="#t_integer">Integer Type</a></li>
  66           <li><a href="#t_floating">Floating Point Types</a></li>
  67           <li><a href="#t_x86mmx">X86mmx Type</a></li>
  68           <li><a href="#t_void">Void Type</a></li>
  69           <li><a href="#t_label">Label Type</a></li>
  70           <li><a href="#t_metadata">Metadata Type</a></li>
  71         </ol>
  72       </li>
  73       <li><a href="#t_derived">Derived Types</a>
  74         <ol>
  75           <li><a href="#t_aggregate">Aggregate Types</a>
  76             <ol>
  77               <li><a href="#t_array">Array Type</a></li>
  78               <li><a href="#t_struct">Structure Type</a></li>
  79               <li><a href="#t_opaque">Opaque Structure Types</a></li>
  80               <li><a href="#t_vector">Vector Type</a></li>
  81             </ol>
  82           </li>
  83           <li><a href="#t_function">Function Type</a></li>
  84           <li><a href="#t_pointer">Pointer Type</a></li>
  85         </ol>
  86       </li>
  87     </ol>
  88   </li>
  89   <li><a href="#constants">Constants</a>
  90     <ol>
  91       <li><a href="#simpleconstants">Simple Constants</a></li>
  92       <li><a href="#complexconstants">Complex Constants</a></li>
  93       <li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
  94       <li><a href="#undefvalues">Undefined Values</a></li>
  95       <li><a href="#trapvalues">Trap Values</a></li>
  96       <li><a href="#blockaddress">Addresses of Basic Blocks</a></li>
  97       <li><a href="#constantexprs">Constant Expressions</a></li>
  98     </ol>
  99   </li>
 100   <li><a href="#othervalues">Other Values</a>
 101     <ol>
 102       <li><a href="#inlineasm">Inline Assembler Expressions</a></li>
 103       <li><a href="#metadata">Metadata Nodes and Metadata Strings</a></li>
 104     </ol>
 105   </li>
 106   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 107     <ol>
 108       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 109       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 110           Global Variable</a></li>
 111       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 112          Global Variable</a></li>
 113       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 114          Global Variable</a></li>
 115     </ol>
 116   </li>
 117   <li><a href="#instref">Instruction Reference</a>
 118     <ol>
 119       <li><a href="#terminators">Terminator Instructions</a>
 120         <ol>
 121           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 122           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 123           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 124           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 125           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 126           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
 127           <li><a href="#i_resume">'<tt>resume</tt>'  Instruction</a></li>
 128           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 129         </ol>
 130       </li>
 131       <li><a href="#binaryops">Binary Operations</a>
 132         <ol>
 133           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 134           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 135           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 136           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 137           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 138           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 139           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 140           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 141           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 142           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 143           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 144           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 145         </ol>
 146       </li>
 147       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 148         <ol>
 149           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 150           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 151           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 152           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 153           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 154           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 155         </ol>
 156       </li>
 157       <li><a href="#vectorops">Vector Operations</a>
 158         <ol>
 159           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 160           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 161           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 162         </ol>
 163       </li>
 164       <li><a href="#aggregateops">Aggregate Operations</a>
 165         <ol>
 166           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 167           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 168         </ol>
 169       </li>
 170       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 171         <ol>
 172           <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
 173          <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
 174          <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
 175          <li><a href="#i_fence">'<tt>fence</tt>' Instruction</a></li>
 176          <li><a href="#i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a></li>
 177          <li><a href="#i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a></li>
 178          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 179         </ol>
 180       </li>
 181       <li><a href="#convertops">Conversion Operations</a>
 182         <ol>
 183           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 184           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 185           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 186           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 187           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 188           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 191           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 192           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 193           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 194           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 195         </ol>
 196       </li>
 197       <li><a href="#otherops">Other Operations</a>
 198         <ol>
 199           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 200           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 201           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 202           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 203           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 204           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 205           <li><a href="#i_landingpad">'<tt>landingpad</tt>' Instruction</a></li>
 206         </ol>
 207       </li>
 208     </ol>
 209   </li>
 210   <li><a href="#intrinsics">Intrinsic Functions</a>
 211     <ol>
 212       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 213         <ol>
 214           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 215           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 216           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 217         </ol>
 218       </li>
 219       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 220         <ol>
 221           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 222           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 223           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 224         </ol>
 225       </li>
 226       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 227         <ol>
 228           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 229           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 230           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 231           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 232           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 233           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 234           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 235         </ol>
 236       </li>
 237       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 238         <ol>
 239           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 240           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 241           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 242           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 243           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 244           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 245           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 246           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 247           <li><a href="#int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a></li>
 248           <li><a href="#int_log">'<tt>llvm.log.*</tt>' Intrinsic</a></li>
 249           <li><a href="#int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a></li>
 250         </ol>
 251       </li>
 252       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 253         <ol>
 254           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 255           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 256           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 257           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 258         </ol>
 259       </li>
 260       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 261         <ol>
 262           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 263           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 264           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 265           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 266           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 267           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 268         </ol>
 269       </li>
 270       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 271         <ol>
 272           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 273           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 274         </ol>
 275       </li>
 276       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 277       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 278       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 279         <ol>
 280           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 281         </ol>
 282       </li>
 283       <li><a href="#int_atomics">Atomic intrinsics</a>
 284         <ol>
 285           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 286           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 287           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 288           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 289           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 290           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 291           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 292           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 293           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 294           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 295           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 296           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 297           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 301         <ol>
 302           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 303           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 304           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 305           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 306         </ol>
 307       </li>
 308       <li><a href="#int_general">General intrinsics</a>
 309         <ol>
 310           <li><a href="#int_var_annotation">
 311             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 312           <li><a href="#int_annotation">
 313             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 314           <li><a href="#int_trap">
 315             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 316           <li><a href="#int_stackprotector">
 317             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 318           <li><a href="#int_objectsize">
 319             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 320         </ol>
 321       </li>
 322     </ol>
 323   </li>
 324 </ol>
 325
 326 <div class="doc_author">
 327   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 328             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 329 </div>
 330
 331 <!-- *********************************************************************** -->
 332 <h2><a name="abstract">Abstract</a></h2>
 333 <!-- *********************************************************************** -->
 334
 335 <div>
 336
 337 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 338    a Static Single Assignment (SSA) based representation that provides type
 339    safety, low-level operations, flexibility, and the capability of representing
 340    'all' high-level languages cleanly.  It is the common code representation
 341    used throughout all phases of the LLVM compilation strategy.</p>
 342
 343 </div>
 344
 345 <!-- *********************************************************************** -->
 346 <h2><a name="introduction">Introduction</a></h2>
 347 <!-- *********************************************************************** -->
 348
 349 <div>
 350
 351 <p>The LLVM code representation is designed to be used in three different forms:
 352    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 353    for fast loading by a Just-In-Time compiler), and as a human readable
 354    assembly language representation.  This allows LLVM to provide a powerful
 355    intermediate representation for efficient compiler transformations and
 356    analysis, while providing a natural means to debug and visualize the
 357    transformations.  The three different forms of LLVM are all equivalent.  This
 358    document describes the human readable representation and notation.</p>
 359
 360 <p>The LLVM representation aims to be light-weight and low-level while being
 361    expressive, typed, and extensible at the same time.  It aims to be a
 362    "universal IR" of sorts, by being at a low enough level that high-level ideas
 363    may be cleanly mapped to it (similar to how microprocessors are "universal
 364    IR's", allowing many source languages to be mapped to them).  By providing
 365    type information, LLVM can be used as the target of optimizations: for
 366    example, through pointer analysis, it can be proven that a C automatic
 367    variable is never accessed outside of the current function, allowing it to
 368    be promoted to a simple SSA value instead of a memory location.</p>
 369
 370 <!-- _______________________________________________________________________ -->
 371 <h4>
 372   <a name="wellformed">Well-Formedness</a>
 373 </h4>
 374
 375 <div>
 376
 377 <p>It is important to note that this document describes 'well formed' LLVM
 378    assembly language.  There is a difference between what the parser accepts and
 379    what is considered 'well formed'.  For example, the following instruction is
 380    syntactically okay, but not well formed:</p>
 381
 382 <pre class="doc_code">
 383 %x = <a href="#i_add">add</a> i32 1, %x
 384 </pre>
 385
 386 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 387    LLVM infrastructure provides a verification pass that may be used to verify
 388    that an LLVM module is well formed.  This pass is automatically run by the
 389    parser after parsing input assembly and by the optimizer before it outputs
 390    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 391    transformation passes or input to the parser.</p>
 392
 393 </div>
 394
 395 </div>
 396
 397 <!-- Describe the typesetting conventions here. -->
 398
 399 <!-- *********************************************************************** -->
 400 <h2><a name="identifiers">Identifiers</a></h2>
 401 <!-- *********************************************************************** -->
 402
 403 <div>
 404
 405 <p>LLVM identifiers come in two basic types: global and local. Global
 406    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 407    character. Local identifiers (register names, types) begin with
 408    the <tt>'%'</tt> character. Additionally, there are three different formats
 409    for identifiers, for different purposes:</p>
 410
 411 <ol>
 412   <li>Named values are represented as a string of characters with their prefix.
 413       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 414       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 415       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 416       other characters in their names can be surrounded with quotes. Special
 417       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 418       ASCII code for the character in hexadecimal.  In this way, any character
 419       can be used in a name value, even quotes themselves.</li>
 420
 421   <li>Unnamed values are represented as an unsigned numeric value with their
 422       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 423
 424   <li>Constants, which are described in a <a href="#constants">section about
 425       constants</a>, below.</li>
 426 </ol>
 427
 428 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 429    don't need to worry about name clashes with reserved words, and the set of
 430    reserved words may be expanded in the future without penalty.  Additionally,
 431    unnamed identifiers allow a compiler to quickly come up with a temporary
 432    variable without having to avoid symbol table conflicts.</p>
 433
 434 <p>Reserved words in LLVM are very similar to reserved words in other
 435    languages. There are keywords for different opcodes
 436    ('<tt><a href="#i_add">add</a></tt>',
 437    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 438    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 439    ('<tt><a href="#t_void">void</a></tt>',
 440    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 441    reserved words cannot conflict with variable names, because none of them
 442    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 443
 444 <p>Here is an example of LLVM code to multiply the integer variable
 445    '<tt>%X</tt>' by 8:</p>
 446
 447 <p>The easy way:</p>
 448
 449 <pre class="doc_code">
 450 %result = <a href="#i_mul">mul</a> i32 %X, 8
 451 </pre>
 452
 453 <p>After strength reduction:</p>
 454
 455 <pre class="doc_code">
 456 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 457 </pre>
 458
 459 <p>And the hard way:</p>
 460
 461 <pre class="doc_code">
 462 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 463 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 464 %result = <a href="#i_add">add</a> i32 %1, %1
 465 </pre>
 466
 467 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 468    lexical features of LLVM:</p>
 469
 470 <ol>
 471   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 472       line.</li>
 473
 474   <li>Unnamed temporaries are created when the result of a computation is not
 475       assigned to a named value.</li>
 476
 477   <li>Unnamed temporaries are numbered sequentially</li>
 478 </ol>
 479
 480 <p>It also shows a convention that we follow in this document.  When
 481    demonstrating instructions, we will follow an instruction with a comment that
 482    defines the type and name of value produced.  Comments are shown in italic
 483    text.</p>
 484
 485 </div>
 486
 487 <!-- *********************************************************************** -->
 488 <h2><a name="highlevel">High Level Structure</a></h2>
 489 <!-- *********************************************************************** -->
 490 <div>
 491 <!-- ======================================================================= -->
 492 <h3>
 493   <a name="modulestructure">Module Structure</a>
 494 </h3>
 495
 496 <div>
 497
 498 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 499    of the input programs.  Each module consists of functions, global variables,
 500    and symbol table entries.  Modules may be combined together with the LLVM
 501    linker, which merges function (and global variable) definitions, resolves
 502    forward declarations, and merges symbol table entries. Here is an example of
 503    the "hello world" module:</p>
 504
 505 <pre class="doc_code">
 506 <i>; Declare the string constant as a global constant.</i>&nbsp;
 507 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"      <i>; [13 x i8]*</i>&nbsp;
 508
 509 <i>; External declaration of the puts function</i>&nbsp;
 510 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 511
 512 <i>; Definition of main function</i>
 513 define i32 @main() {   <i>; i32()* </i>&nbsp;
 514   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 515   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 516
 517   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 518   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 519   <a href="#i_ret">ret</a> i32 0&nbsp;
 520 }
 521
 522 <i>; Named metadata</i>
 523 !1 = metadata !{i32 41}
 524 !foo = !{!1, null}
 525 </pre>
 526
 527 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 528    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 529    a <a href="#functionstructure">function definition</a> for
 530    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 531    "<tt>foo"</tt>.</p>
 532
 533 <p>In general, a module is made up of a list of global values, where both
 534    functions and global variables are global values.  Global values are
 535    represented by a pointer to a memory location (in this case, a pointer to an
 536    array of char, and a pointer to a function), and have one of the
 537    following <a href="#linkage">linkage types</a>.</p>
 538
 539 </div>
 540
 541 <!-- ======================================================================= -->
 542 <h3>
 543   <a name="linkage">Linkage Types</a>
 544 </h3>
 545
 546 <div>
 547
 548 <p>All Global Variables and Functions have one of the following types of
 549    linkage:</p>
 550
 551 <dl>
 552   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 553   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 554       by objects in the current module. In particular, linking code into a
 555       module with an private global value may cause the private to be renamed as
 556       necessary to avoid collisions.  Because the symbol is private to the
 557       module, all references can be updated. This doesn't show up in any symbol
 558       table in the object file.</dd>
 559
 560   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 561   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 562       assembler and evaluated by the linker. Unlike normal strong symbols, they
 563       are removed by the linker from the final linked image (executable or
 564       dynamic library).</dd>
 565
 566   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 567   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 568       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 569       linker. The symbols are removed by the linker from the final linked image
 570       (executable or dynamic library).</dd>
 571
 572   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 573   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 574       of the object is not taken. For instance, functions that had an inline
 575       definition, but the compiler decided not to inline it. Note,
 576       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 577       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 578       visibility.  The symbols are removed by the linker from the final linked
 579       image (executable or dynamic library).</dd>
 580
 581   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 582   <dd>Similar to private, but the value shows as a local symbol
 583       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 584       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 585
 586   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 587   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 588       into the object file corresponding to the LLVM module.  They exist to
 589       allow inlining and other optimizations to take place given knowledge of
 590       the definition of the global, which is known to be somewhere outside the
 591       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 592       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 593       This linkage type is only allowed on definitions, not declarations.</dd>
 594
 595   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 596   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 597       the same name when linkage occurs.  This can be used to implement
 598       some forms of inline functions, templates, or other code which must be
 599       generated in each translation unit that uses it, but where the body may
 600       be overridden with a more definitive definition later.  Unreferenced
 601       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 602       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 603       inline the body of this function into callers because it doesn't know if
 604       this definition of the function is the definitive definition within the
 605       program or whether it will be overridden by a stronger definition.
 606       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 607       linkage.</dd>
 608
 609   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 610   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 611       <tt>linkonce</tt> linkage, except that unreferenced globals with
 612       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 613       are declared "weak" in C source code.</dd>
 614
 615   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 616   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 617       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 618       global scope.
 619       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 620       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 621       <tt>common</tt> symbols may not have an explicit section,
 622       must have a zero initializer, and may not be marked '<a
 623       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 624       have common linkage.</dd>
 625
 626
 627   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 628   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 629       pointer to array type.  When two global variables with appending linkage
 630       are linked together, the two global arrays are appended together.  This is
 631       the LLVM, typesafe, equivalent of having the system linker append together
 632       "sections" with identical names when .o files are linked.</dd>
 633
 634   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 635   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 636       is weak until linked, if not linked, the symbol becomes null instead of
 637       being an undefined reference.</dd>
 638
 639   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 640   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 641   <dd>Some languages allow differing globals to be merged, such as two functions
 642       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 643       that only equivalent globals are ever merged (the "one definition rule"
 644       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 645       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 646       be merged with equivalent globals.  These linkage types are otherwise the
 647       same as their non-<tt>odr</tt> versions.</dd>
 648
 649   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 650   <dd>If none of the above identifiers are used, the global is externally
 651       visible, meaning that it participates in linkage and can be used to
 652       resolve external symbol references.</dd>
 653 </dl>
 654
 655 <p>The next two types of linkage are targeted for Microsoft Windows platform
 656    only. They are designed to support importing (exporting) symbols from (to)
 657    DLLs (Dynamic Link Libraries).</p>
 658
 659 <dl>
 660   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 661   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 662       or variable via a global pointer to a pointer that is set up by the DLL
 663       exporting the symbol. On Microsoft Windows targets, the pointer name is
 664       formed by combining <code>__imp_</code> and the function or variable
 665       name.</dd>
 666
 667   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 668   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 669       pointer to a pointer in a DLL, so that it can be referenced with the
 670       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 671       name is formed by combining <code>__imp_</code> and the function or
 672       variable name.</dd>
 673 </dl>
 674
 675 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 676    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 677    one, one of the two would be renamed, preventing a collision.  Since
 678    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 679    declarations), they are accessible outside of the current module.</p>
 680
 681 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 682    other than "externally visible", <tt>dllimport</tt>
 683    or <tt>extern_weak</tt>.</p>
 684
 685 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 686    or <tt>weak_odr</tt> linkages.</p>
 687
 688 </div>
 689
 690 <!-- ======================================================================= -->
 691 <h3>
 692   <a name="callingconv">Calling Conventions</a>
 693 </h3>
 694
 695 <div>
 696
 697 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 698    and <a href="#i_invoke">invokes</a> can all have an optional calling
 699    convention specified for the call.  The calling convention of any pair of
 700    dynamic caller/callee must match, or the behavior of the program is
 701    undefined.  The following calling conventions are supported by LLVM, and more
 702    may be added in the future:</p>
 703
 704 <dl>
 705   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 706   <dd>This calling convention (the default if no other calling convention is
 707       specified) matches the target C calling conventions.  This calling
 708       convention supports varargs function calls and tolerates some mismatch in
 709       the declared prototype and implemented declaration of the function (as
 710       does normal C).</dd>
 711
 712   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make calls as fast as possible
 714       (e.g. by passing things in registers).  This calling convention allows the
 715       target to use whatever tricks it wants to produce fast code for the
 716       target, without having to conform to an externally specified ABI
 717       (Application Binary Interface).
 718       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 719       when this or the GHC convention is used.</a>  This calling convention
 720       does not support varargs and requires the prototype of all callees to
 721       exactly match the prototype of the function definition.</dd>
 722
 723   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 724   <dd>This calling convention attempts to make code in the caller as efficient
 725       as possible under the assumption that the call is not commonly executed.
 726       As such, these calls often preserve all registers so that the call does
 727       not break any live ranges in the caller side.  This calling convention
 728       does not support varargs and requires the prototype of all callees to
 729       exactly match the prototype of the function definition.</dd>
 730
 731   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 732   <dd>This calling convention has been implemented specifically for use by the
 733       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 734       It passes everything in registers, going to extremes to achieve this by
 735       disabling callee save registers. This calling convention should not be
 736       used lightly but only for specific situations such as an alternative to
 737       the <em>register pinning</em> performance technique often used when
 738       implementing functional programming languages.At the moment only X86
 739       supports this convention and it has the following limitations:
 740       <ul>
 741         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 742             floating point types are supported.</li>
 743         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 744             6 floating point parameters.</li>
 745       </ul>
 746       This calling convention supports
 747       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 748       requires both the caller and callee are using it.
 749   </dd>
 750
 751   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 752   <dd>Any calling convention may be specified by number, allowing
 753       target-specific calling conventions to be used.  Target specific calling
 754       conventions start at 64.</dd>
 755 </dl>
 756
 757 <p>More calling conventions can be added/defined on an as-needed basis, to
 758    support Pascal conventions or any other well-known target-independent
 759    convention.</p>
 760
 761 </div>
 762
 763 <!-- ======================================================================= -->
 764 <h3>
 765   <a name="visibility">Visibility Styles</a>
 766 </h3>
 767
 768 <div>
 769
 770 <p>All Global Variables and Functions have one of the following visibility
 771    styles:</p>
 772
 773 <dl>
 774   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 775   <dd>On targets that use the ELF object file format, default visibility means
 776       that the declaration is visible to other modules and, in shared libraries,
 777       means that the declared entity may be overridden. On Darwin, default
 778       visibility means that the declaration is visible to other modules. Default
 779       visibility corresponds to "external linkage" in the language.</dd>
 780
 781   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 782   <dd>Two declarations of an object with hidden visibility refer to the same
 783       object if they are in the same shared object. Usually, hidden visibility
 784       indicates that the symbol will not be placed into the dynamic symbol
 785       table, so no other module (executable or shared library) can reference it
 786       directly.</dd>
 787
 788   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 789   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 790       the dynamic symbol table, but that references within the defining module
 791       will bind to the local symbol. That is, the symbol cannot be overridden by
 792       another module.</dd>
 793 </dl>
 794
 795 </div>
 796
 797 <!-- ======================================================================= -->
 798 <h3>
 799   <a name="namedtypes">Named Types</a>
 800 </h3>
 801
 802 <div>
 803
 804 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 805    it easier to read the IR and make the IR more condensed (particularly when
 806    recursive types are involved).  An example of a name specification is:</p>
 807
 808 <pre class="doc_code">
 809 %mytype = type { %mytype*, i32 }
 810 </pre>
 811
 812 <p>You may give a name to any <a href="#typesystem">type</a> except
 813    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 814    is expected with the syntax "%mytype".</p>
 815
 816 <p>Note that type names are aliases for the structural type that they indicate,
 817    and that you can therefore specify multiple names for the same type.  This
 818    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 819    uses structural typing, the name is not part of the type.  When printing out
 820    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 821    particular shape.  This means that if you have code where two different
 822    source types end up having the same LLVM type, that the dumper will sometimes
 823    print the "wrong" or unexpected type.  This is an important design point and
 824    isn't going to change.</p>
 825
 826 </div>
 827
 828 <!-- ======================================================================= -->
 829 <h3>
 830   <a name="globalvars">Global Variables</a>
 831 </h3>
 832
 833 <div>
 834
 835 <p>Global variables define regions of memory allocated at compilation time
 836    instead of run-time.  Global variables may optionally be initialized, may
 837    have an explicit section to be placed in, and may have an optional explicit
 838    alignment specified.  A variable may be defined as "thread_local", which
 839    means that it will not be shared by threads (each thread will have a
 840    separated copy of the variable).  A variable may be defined as a global
 841    "constant," which indicates that the contents of the variable
 842    will <b>never</b> be modified (enabling better optimization, allowing the
 843    global data to be placed in the read-only section of an executable, etc).
 844    Note that variables that need runtime initialization cannot be marked
 845    "constant" as there is a store to the variable.</p>
 846
 847 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 848    constant, even if the final definition of the global is not.  This capability
 849    can be used to enable slightly better optimization of the program, but
 850    requires the language definition to guarantee that optimizations based on the
 851    'constantness' are valid for the translation units that do not include the
 852    definition.</p>
 853
 854 <p>As SSA values, global variables define pointer values that are in scope
 855    (i.e. they dominate) all basic blocks in the program.  Global variables
 856    always define a pointer to their "content" type because they describe a
 857    region of memory, and all memory objects in LLVM are accessed through
 858    pointers.</p>
 859
 860 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 861   that the address is not significant, only the content. Constants marked
 862   like this can be merged with other constants if they have the same
 863   initializer. Note that a constant with significant address <em>can</em>
 864   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 865   constant whose address is significant.</p>
 866
 867 <p>A global variable may be declared to reside in a target-specific numbered
 868    address space. For targets that support them, address spaces may affect how
 869    optimizations are performed and/or what target instructions are used to
 870    access the variable. The default address space is zero. The address space
 871    qualifier must precede any other attributes.</p>
 872
 873 <p>LLVM allows an explicit section to be specified for globals.  If the target
 874    supports it, it will emit globals to the section specified.</p>
 875
 876 <p>An explicit alignment may be specified for a global, which must be a power
 877    of 2.  If not present, or if the alignment is set to zero, the alignment of
 878    the global is set by the target to whatever it feels convenient.  If an
 879    explicit alignment is specified, the global is forced to have exactly that
 880    alignment.  Targets and optimizers are not allowed to over-align the global
 881    if the global has an assigned section.  In this case, the extra alignment
 882    could be observable: for example, code could assume that the globals are
 883    densely packed in their section and try to iterate over them as an array,
 884    alignment padding would break this iteration.</p>
 885
 886 <p>For example, the following defines a global in a numbered address space with
 887    an initializer, section, and alignment:</p>
 888
 889 <pre class="doc_code">
 890 @G = addrspace(5) constant float 1.0, section "foo", align 4
 891 </pre>
 892
 893 </div>
 894
 895
 896 <!-- ======================================================================= -->
 897 <h3>
 898   <a name="functionstructure">Functions</a>
 899 </h3>
 900
 901 <div>
 902
 903 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 904    optional <a href="#linkage">linkage type</a>, an optional
 905    <a href="#visibility">visibility style</a>, an optional
 906    <a href="#callingconv">calling convention</a>,
 907    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 908    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 909    name, a (possibly empty) argument list (each with optional
 910    <a href="#paramattrs">parameter attributes</a>), optional
 911    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 912    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 913    curly brace, a list of basic blocks, and a closing curly brace.</p>
 914
 915 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 916    optional <a href="#linkage">linkage type</a>, an optional
 917    <a href="#visibility">visibility style</a>, an optional
 918    <a href="#callingconv">calling convention</a>,
 919    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 920    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 921    name, a possibly empty list of arguments, an optional alignment, and an
 922    optional <a href="#gc">garbage collector name</a>.</p>
 923
 924 <p>A function definition contains a list of basic blocks, forming the CFG
 925    (Control Flow Graph) for the function.  Each basic block may optionally start
 926    with a label (giving the basic block a symbol table entry), contains a list
 927    of instructions, and ends with a <a href="#terminators">terminator</a>
 928    instruction (such as a branch or function return).</p>
 929
 930 <p>The first basic block in a function is special in two ways: it is immediately
 931    executed on entrance to the function, and it is not allowed to have
 932    predecessor basic blocks (i.e. there can not be any branches to the entry
 933    block of a function).  Because the block can have no predecessors, it also
 934    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 935
 936 <p>LLVM allows an explicit section to be specified for functions.  If the target
 937    supports it, it will emit functions to the section specified.</p>
 938
 939 <p>An explicit alignment may be specified for a function.  If not present, or if
 940    the alignment is set to zero, the alignment of the function is set by the
 941    target to whatever it feels convenient.  If an explicit alignment is
 942    specified, the function is forced to have at least that much alignment.  All
 943    alignments must be a power of 2.</p>
 944
 945 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 946   be significant and two identical functions can be merged</p>.
 947
 948 <h5>Syntax:</h5>
 949 <pre class="doc_code">
 950 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 951        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 952        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 953        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 954        [<a href="#gc">gc</a>] { ... }
 955 </pre>
 956
 957 </div>
 958
 959 <!-- ======================================================================= -->
 960 <h3>
 961   <a name="aliasstructure">Aliases</a>
 962 </h3>
 963
 964 <div>
 965
 966 <p>Aliases act as "second name" for the aliasee value (which can be either
 967    function, global variable, another alias or bitcast of global value). Aliases
 968    may have an optional <a href="#linkage">linkage type</a>, and an
 969    optional <a href="#visibility">visibility style</a>.</p>
 970
 971 <h5>Syntax:</h5>
 972 <pre class="doc_code">
 973 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 974 </pre>
 975
 976 </div>
 977
 978 <!-- ======================================================================= -->
 979 <h3>
 980   <a name="namedmetadatastructure">Named Metadata</a>
 981 </h3>
 982
 983 <div>
 984
 985 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 986    nodes</a> (but not metadata strings) are the only valid operands for
 987    a named metadata.</p>
 988
 989 <h5>Syntax:</h5>
 990 <pre class="doc_code">
 991 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 992 !0 = metadata !{metadata !"zero"}
 993 !1 = metadata !{metadata !"one"}
 994 !2 = metadata !{metadata !"two"}
 995 ; A named metadata.
 996 !name = !{!0, !1, !2}
 997 </pre>
 998
 999 </div>
1000
1001 <!-- ======================================================================= -->
1002 <h3>
1003   <a name="paramattrs">Parameter Attributes</a>
1004 </h3>
1005
1006 <div>
1007
1008 <p>The return type and each parameter of a function type may have a set of
1009    <i>parameter attributes</i> associated with them. Parameter attributes are
1010    used to communicate additional information about the result or parameters of
1011    a function. Parameter attributes are considered to be part of the function,
1012    not of the function type, so functions with different parameter attributes
1013    can have the same function type.</p>
1014
1015 <p>Parameter attributes are simple keywords that follow the type specified. If
1016    multiple parameter attributes are needed, they are space separated. For
1017    example:</p>
1018
1019 <pre class="doc_code">
1020 declare i32 @printf(i8* noalias nocapture, ...)
1021 declare i32 @atoi(i8 zeroext)
1022 declare signext i8 @returns_signed_char()
1023 </pre>
1024
1025 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1026    <tt>readonly</tt>) come immediately after the argument list.</p>
1027
1028 <p>Currently, only the following parameter attributes are defined:</p>
1029
1030 <dl>
1031   <dt><tt><b>zeroext</b></tt></dt>
1032   <dd>This indicates to the code generator that the parameter or return value
1033       should be zero-extended to the extent required by the target's ABI (which
1034       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1035       parameter) or the callee (for a return value).</dd>
1036
1037   <dt><tt><b>signext</b></tt></dt>
1038   <dd>This indicates to the code generator that the parameter or return value
1039       should be sign-extended to the extent required by the target's ABI (which
1040       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1041       return value).</dd>
1042
1043   <dt><tt><b>inreg</b></tt></dt>
1044   <dd>This indicates that this parameter or return value should be treated in a
1045       special target-dependent fashion during while emitting code for a function
1046       call or return (usually, by putting it in a register as opposed to memory,
1047       though some targets use it to distinguish between two different kinds of
1048       registers).  Use of this attribute is target-specific.</dd>
1049
1050   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1051   <dd><p>This indicates that the pointer parameter should really be passed by
1052       value to the function.  The attribute implies that a hidden copy of the
1053       pointee
1054       is made between the caller and the callee, so the callee is unable to
1055       modify the value in the callee.  This attribute is only valid on LLVM
1056       pointer arguments.  It is generally used to pass structs and arrays by
1057       value, but is also valid on pointers to scalars.  The copy is considered
1058       to belong to the caller not the callee (for example,
1059       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1060       <tt>byval</tt> parameters). This is not a valid attribute for return
1061       values.</p>
1062
1063       <p>The byval attribute also supports specifying an alignment with
1064       the align attribute.  It indicates the alignment of the stack slot to
1065       form and the known alignment of the pointer specified to the call site. If
1066       the alignment is not specified, then the code generator makes a
1067       target-specific assumption.</p></dd>
1068
1069   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1070   <dd>This indicates that the pointer parameter specifies the address of a
1071       structure that is the return value of the function in the source program.
1072       This pointer must be guaranteed by the caller to be valid: loads and
1073       stores to the structure may be assumed by the callee to not to trap.  This
1074       may only be applied to the first parameter. This is not a valid attribute
1075       for return values. </dd>
1076
1077   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1078   <dd>This indicates that pointer values
1079       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1080       value do not alias pointer values which are not <i>based</i> on it,
1081       ignoring certain "irrelevant" dependencies.
1082       For a call to the parent function, dependencies between memory
1083       references from before or after the call and from those during the call
1084       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1085       return value used in that call.
1086       The caller shares the responsibility with the callee for ensuring that
1087       these requirements are met.
1088       For further details, please see the discussion of the NoAlias response in
1089       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1090 <br>
1091       Note that this definition of <tt>noalias</tt> is intentionally
1092       similar to the definition of <tt>restrict</tt> in C99 for function
1093       arguments, though it is slightly weaker.
1094 <br>
1095       For function return values, C99's <tt>restrict</tt> is not meaningful,
1096       while LLVM's <tt>noalias</tt> is.
1097       </dd>
1098
1099   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1100   <dd>This indicates that the callee does not make any copies of the pointer
1101       that outlive the callee itself. This is not a valid attribute for return
1102       values.</dd>
1103
1104   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1105   <dd>This indicates that the pointer parameter can be excised using the
1106       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1107       attribute for return values.</dd>
1108 </dl>
1109
1110 </div>
1111
1112 <!-- ======================================================================= -->
1113 <h3>
1114   <a name="gc">Garbage Collector Names</a>
1115 </h3>
1116
1117 <div>
1118
1119 <p>Each function may specify a garbage collector name, which is simply a
1120    string:</p>
1121
1122 <pre class="doc_code">
1123 define void @f() gc "name" { ... }
1124 </pre>
1125
1126 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1127    collector which will cause the compiler to alter its output in order to
1128    support the named garbage collection algorithm.</p>
1129
1130 </div>
1131
1132 <!-- ======================================================================= -->
1133 <h3>
1134   <a name="fnattrs">Function Attributes</a>
1135 </h3>
1136
1137 <div>
1138
1139 <p>Function attributes are set to communicate additional information about a
1140    function. Function attributes are considered to be part of the function, not
1141    of the function type, so functions with different parameter attributes can
1142    have the same function type.</p>
1143
1144 <p>Function attributes are simple keywords that follow the type specified. If
1145    multiple attributes are needed, they are space separated. For example:</p>
1146
1147 <pre class="doc_code">
1148 define void @f() noinline { ... }
1149 define void @f() alwaysinline { ... }
1150 define void @f() alwaysinline optsize { ... }
1151 define void @f() optsize { ... }
1152 </pre>
1153
1154 <dl>
1155   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1156   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1157       the backend should forcibly align the stack pointer. Specify the
1158       desired alignment, which must be a power of two, in parentheses.
1159
1160   <dt><tt><b>alwaysinline</b></tt></dt>
1161   <dd>This attribute indicates that the inliner should attempt to inline this
1162       function into callers whenever possible, ignoring any active inlining size
1163       threshold for this caller.</dd>
1164
1165   <dt><tt><b>hotpatch</b></tt></dt>
1166   <dd>This attribute indicates that the function should be 'hotpatchable',
1167       meaning the function can be patched and/or hooked even while it is
1168       loaded into memory. On x86, the function prologue will be preceded
1169       by six bytes of padding and will begin with a two-byte instruction.
1170       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1171       higher were compiled in this fashion.</dd>
1172
1173   <dt><tt><b>nonlazybind</b></tt></dt>
1174   <dd>This attribute suppresses lazy symbol binding for the function. This
1175       may make calls to the function faster, at the cost of extra program
1176       startup time if the function is not called during program startup.</dd>
1177
1178   <dt><tt><b>inlinehint</b></tt></dt>
1179   <dd>This attribute indicates that the source code contained a hint that inlining
1180       this function is desirable (such as the "inline" keyword in C/C++).  It
1181       is just a hint; it imposes no requirements on the inliner.</dd>
1182
1183   <dt><tt><b>naked</b></tt></dt>
1184   <dd>This attribute disables prologue / epilogue emission for the function.
1185       This can have very system-specific consequences.</dd>
1186
1187   <dt><tt><b>noimplicitfloat</b></tt></dt>
1188   <dd>This attributes disables implicit floating point instructions.</dd>
1189
1190   <dt><tt><b>noinline</b></tt></dt>
1191   <dd>This attribute indicates that the inliner should never inline this
1192       function in any situation. This attribute may not be used together with
1193       the <tt>alwaysinline</tt> attribute.</dd>
1194
1195   <dt><tt><b>noredzone</b></tt></dt>
1196   <dd>This attribute indicates that the code generator should not use a red
1197       zone, even if the target-specific ABI normally permits it.</dd>
1198
1199   <dt><tt><b>noreturn</b></tt></dt>
1200   <dd>This function attribute indicates that the function never returns
1201       normally.  This produces undefined behavior at runtime if the function
1202       ever does dynamically return.</dd>
1203
1204   <dt><tt><b>nounwind</b></tt></dt>
1205   <dd>This function attribute indicates that the function never returns with an
1206       unwind or exceptional control flow.  If the function does unwind, its
1207       runtime behavior is undefined.</dd>
1208
1209   <dt><tt><b>optsize</b></tt></dt>
1210   <dd>This attribute suggests that optimization passes and code generator passes
1211       make choices that keep the code size of this function low, and otherwise
1212       do optimizations specifically to reduce code size.</dd>
1213
1214   <dt><tt><b>readnone</b></tt></dt>
1215   <dd>This attribute indicates that the function computes its result (or decides
1216       to unwind an exception) based strictly on its arguments, without
1217       dereferencing any pointer arguments or otherwise accessing any mutable
1218       state (e.g. memory, control registers, etc) visible to caller functions.
1219       It does not write through any pointer arguments
1220       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1221       changes any state visible to callers.  This means that it cannot unwind
1222       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1223       could use the <tt>unwind</tt> instruction.</dd>
1224
1225   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1226   <dd>This attribute indicates that the function does not write through any
1227       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1228       arguments) or otherwise modify any state (e.g. memory, control registers,
1229       etc) visible to caller functions.  It may dereference pointer arguments
1230       and read state that may be set in the caller.  A readonly function always
1231       returns the same value (or unwinds an exception identically) when called
1232       with the same set of arguments and global state.  It cannot unwind an
1233       exception by calling the <tt>C++</tt> exception throwing methods, but may
1234       use the <tt>unwind</tt> instruction.</dd>
1235
1236   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1237   <dd>This attribute indicates that the function should emit a stack smashing
1238       protector. It is in the form of a "canary"&mdash;a random value placed on
1239       the stack before the local variables that's checked upon return from the
1240       function to see if it has been overwritten. A heuristic is used to
1241       determine if a function needs stack protectors or not.<br>
1242 <br>
1243       If a function that has an <tt>ssp</tt> attribute is inlined into a
1244       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1245       function will have an <tt>ssp</tt> attribute.</dd>
1246
1247   <dt><tt><b>sspreq</b></tt></dt>
1248   <dd>This attribute indicates that the function should <em>always</em> emit a
1249       stack smashing protector. This overrides
1250       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1251 <br>
1252       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1253       function that doesn't have an <tt>sspreq</tt> attribute or which has
1254       an <tt>ssp</tt> attribute, then the resulting function will have
1255       an <tt>sspreq</tt> attribute.</dd>
1256
1257   <dt><tt><b><a name="uwtable">uwtable</a></b></tt></dt>
1258   <dd>This attribute indicates that the ABI being targeted requires that
1259       an unwind table entry be produce for this function even if we can
1260       show that no exceptions passes by it. This is normally the case for
1261       the ELF x86-64 abi, but it can be disabled for some compilation
1262       units.</dd>
1263
1264 </dl>
1265
1266 </div>
1267
1268 <!-- ======================================================================= -->
1269 <h3>
1270   <a name="moduleasm">Module-Level Inline Assembly</a>
1271 </h3>
1272
1273 <div>
1274
1275 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1276    the GCC "file scope inline asm" blocks.  These blocks are internally
1277    concatenated by LLVM and treated as a single unit, but may be separated in
1278    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1279
1280 <pre class="doc_code">
1281 module asm "inline asm code goes here"
1282 module asm "more can go here"
1283 </pre>
1284
1285 <p>The strings can contain any character by escaping non-printable characters.
1286    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1287    for the number.</p>
1288
1289 <p>The inline asm code is simply printed to the machine code .s file when
1290    assembly code is generated.</p>
1291
1292 </div>
1293
1294 <!-- ======================================================================= -->
1295 <h3>
1296   <a name="datalayout">Data Layout</a>
1297 </h3>
1298
1299 <div>
1300
1301 <p>A module may specify a target specific data layout string that specifies how
1302    data is to be laid out in memory. The syntax for the data layout is
1303    simply:</p>
1304
1305 <pre class="doc_code">
1306 target datalayout = "<i>layout specification</i>"
1307 </pre>
1308
1309 <p>The <i>layout specification</i> consists of a list of specifications
1310    separated by the minus sign character ('-').  Each specification starts with
1311    a letter and may include other information after the letter to define some
1312    aspect of the data layout.  The specifications accepted are as follows:</p>
1313
1314 <dl>
1315   <dt><tt>E</tt></dt>
1316   <dd>Specifies that the target lays out data in big-endian form. That is, the
1317       bits with the most significance have the lowest address location.</dd>
1318
1319   <dt><tt>e</tt></dt>
1320   <dd>Specifies that the target lays out data in little-endian form. That is,
1321       the bits with the least significance have the lowest address
1322       location.</dd>
1323
1324   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1325   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1326       <i>preferred</i> alignments. All sizes are in bits. Specifying
1327       the <i>pref</i> alignment is optional. If omitted, the
1328       preceding <tt>:</tt> should be omitted too.</dd>
1329
1330   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1331   <dd>This specifies the alignment for an integer type of a given bit
1332       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1333
1334   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1335   <dd>This specifies the alignment for a vector type of a given bit
1336       <i>size</i>.</dd>
1337
1338   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1339   <dd>This specifies the alignment for a floating point type of a given bit
1340       <i>size</i>. Only values of <i>size</i> that are supported by the target
1341       will work.  32 (float) and 64 (double) are supported on all targets;
1342       80 or 128 (different flavors of long double) are also supported on some
1343       targets.
1344
1345   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1346   <dd>This specifies the alignment for an aggregate type of a given bit
1347       <i>size</i>.</dd>
1348
1349   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1350   <dd>This specifies the alignment for a stack object of a given bit
1351       <i>size</i>.</dd>
1352
1353   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1354   <dd>This specifies a set of native integer widths for the target CPU
1355       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1356       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1357       this set are considered to support most general arithmetic
1358       operations efficiently.</dd>
1359 </dl>
1360
1361 <p>When constructing the data layout for a given target, LLVM starts with a
1362    default set of specifications which are then (possibly) overridden by the
1363    specifications in the <tt>datalayout</tt> keyword. The default specifications
1364    are given in this list:</p>
1365
1366 <ul>
1367   <li><tt>E</tt> - big endian</li>
1368   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1369   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1370   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1371   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1372   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1373   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1374   alignment of 64-bits</li>
1375   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1376   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1377   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1378   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1379   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1380   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1381 </ul>
1382
1383 <p>When LLVM is determining the alignment for a given type, it uses the
1384    following rules:</p>
1385
1386 <ol>
1387   <li>If the type sought is an exact match for one of the specifications, that
1388       specification is used.</li>
1389
1390   <li>If no match is found, and the type sought is an integer type, then the
1391       smallest integer type that is larger than the bitwidth of the sought type
1392       is used. If none of the specifications are larger than the bitwidth then
1393       the the largest integer type is used. For example, given the default
1394       specifications above, the i7 type will use the alignment of i8 (next
1395       largest) while both i65 and i256 will use the alignment of i64 (largest
1396       specified).</li>
1397
1398   <li>If no match is found, and the type sought is a vector type, then the
1399       largest vector type that is smaller than the sought vector type will be
1400       used as a fall back.  This happens because &lt;128 x double&gt; can be
1401       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1402 </ol>
1403
1404 </div>
1405
1406 <!-- ======================================================================= -->
1407 <h3>
1408   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1409 </h3>
1410
1411 <div>
1412
1413 <p>Any memory access must be done through a pointer value associated
1414 with an address range of the memory access, otherwise the behavior
1415 is undefined. Pointer values are associated with address ranges
1416 according to the following rules:</p>
1417
1418 <ul>
1419   <li>A pointer value is associated with the addresses associated with
1420       any value it is <i>based</i> on.
1421   <li>An address of a global variable is associated with the address
1422       range of the variable's storage.</li>
1423   <li>The result value of an allocation instruction is associated with
1424       the address range of the allocated storage.</li>
1425   <li>A null pointer in the default address-space is associated with
1426       no address.</li>
1427   <li>An integer constant other than zero or a pointer value returned
1428       from a function not defined within LLVM may be associated with address
1429       ranges allocated through mechanisms other than those provided by
1430       LLVM. Such ranges shall not overlap with any ranges of addresses
1431       allocated by mechanisms provided by LLVM.</li>
1432 </ul>
1433
1434 <p>A pointer value is <i>based</i> on another pointer value according
1435    to the following rules:</p>
1436
1437 <ul>
1438   <li>A pointer value formed from a
1439       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1440       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1441   <li>The result value of a
1442       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1443       of the <tt>bitcast</tt>.</li>
1444   <li>A pointer value formed by an
1445       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1446       pointer values that contribute (directly or indirectly) to the
1447       computation of the pointer's value.</li>
1448   <li>The "<i>based</i> on" relationship is transitive.</li>
1449 </ul>
1450
1451 <p>Note that this definition of <i>"based"</i> is intentionally
1452    similar to the definition of <i>"based"</i> in C99, though it is
1453    slightly weaker.</p>
1454
1455 <p>LLVM IR does not associate types with memory. The result type of a
1456 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1457 alignment of the memory from which to load, as well as the
1458 interpretation of the value. The first operand type of a
1459 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1460 and alignment of the store.</p>
1461
1462 <p>Consequently, type-based alias analysis, aka TBAA, aka
1463 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1464 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1465 additional information which specialized optimization passes may use
1466 to implement type-based alias analysis.</p>
1467
1468 </div>
1469
1470 <!-- ======================================================================= -->
1471 <h3>
1472   <a name="volatile">Volatile Memory Accesses</a>
1473 </h3>
1474
1475 <div>
1476
1477 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1478 href="#i_store"><tt>store</tt></a>s, and <a
1479 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1480 The optimizers must not change the number of volatile operations or change their
1481 order of execution relative to other volatile operations.  The optimizers
1482 <i>may</i> change the order of volatile operations relative to non-volatile
1483 operations.  This is not Java's "volatile" and has no cross-thread
1484 synchronization behavior.</p>
1485
1486 </div>
1487
1488 <!-- ======================================================================= -->
1489 <h3>
1490   <a name="memmodel">Memory Model for Concurrent Operations</a>
1491 </h3>
1492
1493 <div>
1494
1495 <p>The LLVM IR does not define any way to start parallel threads of execution
1496 or to register signal handlers. Nonetheless, there are platform-specific
1497 ways to create them, and we define LLVM IR's behavior in their presence. This
1498 model is inspired by the C++0x memory model.</p>
1499
1500 <p>We define a <i>happens-before</i> partial order as the least partial order
1501 that</p>
1502 <ul>
1503   <li>Is a superset of single-thread program order, and</li>
1504   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1505       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1506       by platform-specific techniques, like pthread locks, thread
1507       creation, thread joining, etc., and by atomic instructions.
1508       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1509       </li>
1510 </ul>
1511
1512 <p>Note that program order does not introduce <i>happens-before</i> edges
1513 between a thread and signals executing inside that thread.</p>
1514
1515 <p>Every (defined) read operation (load instructions, memcpy, atomic
1516 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1517 (defined) write operations (store instructions, atomic
1518 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1519 initialized globals are considered to have a write of the initializer which is
1520 atomic and happens before any other read or write of the memory in question.
1521 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1522 any write to the same byte, except:</p>
1523
1524 <ul>
1525   <li>If <var>write<sub>1</sub></var> happens before
1526       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1527       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1528       does not see <var>write<sub>1</sub></var>.
1529   <li>If <var>R<sub>byte</sub></var> happens before
1530       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1531       see <var>write<sub>3</sub></var>.
1532 </ul>
1533
1534 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1535 <ul>
1536   <li>If there is no write to the same byte that happens before
1537     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1538     <tt>undef</tt> for that byte.
1539   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1540       <var>R<sub>byte</sub></var> returns the value written by that
1541       write.</li>
1542   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1543       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1544       values written.  See the <a href="#ordering">Atomic Memory Ordering
1545       Constraints</a> section for additional constraints on how the choice
1546       is made.
1547   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1548 </ul>
1549
1550 <p><var>R</var> returns the value composed of the series of bytes it read.
1551 This implies that some bytes within the value may be <tt>undef</tt>
1552 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1553 defines the semantics of the operation; it doesn't mean that targets will
1554 emit more than one instruction to read the series of bytes.</p>
1555
1556 <p>Note that in cases where none of the atomic intrinsics are used, this model
1557 places only one restriction on IR transformations on top of what is required
1558 for single-threaded execution: introducing a store to a byte which might not
1559 otherwise be stored is not allowed in general.  (Specifically, in the case
1560 where another thread might write to and read from an address, introducing a
1561 store can change a load that may see exactly one write into a load that may
1562 see multiple writes.)</p>
1563
1564 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1565 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1566 none of the backends currently in the tree fall into this category; however,
1567 there might be targets which care.  If there are, we want a paragraph
1568 like the following:
1569
1570 Targets may specify that stores narrower than a certain width are not
1571 available; on such a target, for the purposes of this model, treat any
1572 non-atomic write with an alignment or width less than the minimum width
1573 as if it writes to the relevant surrounding bytes.
1574 -->
1575
1576 </div>
1577
1578 <!-- ======================================================================= -->
1579 <div class="doc_subsection">
1580       <a name="ordering">Atomic Memory Ordering Constraints</a>
1581 </div>
1582
1583 <div class="doc_text">
1584
1585 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1586 <a href="#i_atomicrmw"><code>atomicrmw</code></a>, and
1587 <a href="#i_fence"><code>fence</code></a>) take an ordering parameter
1588 that determines which other atomic instructions on the same address they
1589 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1590 but are somewhat more colloquial. If these descriptions aren't precise enough,
1591 check those specs.  <a href="#i_fence"><code>fence</code></a> instructions
1592 treat these orderings somewhat differently since they don't take an address.
1593 See that instruction's documentation for details.</p>
1594
1595 <!-- FIXME Note atomic load+store here once those get added. -->
1596
1597 <dl>
1598 <!-- FIXME: unordered is intended to be used for atomic load and store;
1599 it isn't allowed for any instruction yet. -->
1600 <dt><code>unordered</code></dt>
1601 <dd>The set of values that can be read is governed by the happens-before
1602 partial order. A value cannot be read unless some operation wrote it.
1603 This is intended to provide a guarantee strong enough to model Java's
1604 non-volatile shared variables.  This ordering cannot be specified for
1605 read-modify-write operations; it is not strong enough to make them atomic
1606 in any interesting way.</dd>
1607 <dt><code>monotonic</code></dt>
1608 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1609 total order for modifications by <code>monotonic</code> operations on each
1610 address. All modification orders must be compatible with the happens-before
1611 order. There is no guarantee that the modification orders can be combined to
1612 a global total order for the whole program (and this often will not be
1613 possible). The read in an atomic read-modify-write operation
1614 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1615 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1616 reads the value in the modification order immediately before the value it
1617 writes. If one atomic read happens before another atomic read of the same
1618 address, the later read must see the same value or a later value in the
1619 address's modification order. This disallows reordering of
1620 <code>monotonic</code> (or stronger) operations on the same address. If an
1621 address is written <code>monotonic</code>ally by one thread, and other threads
1622 <code>monotonic</code>ally read that address repeatedly, the other threads must
1623 eventually see the write. This is intended to model C++'s relaxed atomic
1624 variables.</dd>
1625 <dt><code>acquire</code></dt>
1626 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1627 reads a value written by a <code>release</code> atomic operation, it
1628 <i>synchronizes-with</i> that operation.</dd>
1629 <dt><code>release</code></dt>
1630 <dd>In addition to the guarantees of <code>monotonic</code>,
1631 a <i>synchronizes-with</i> edge may be formed by an <code>acquire</code>
1632 operation.</dd>
1633 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1634 <code>acquire</code> and <code>release</code> operation on its address.</dd>
1635 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1636 <dd>In addition to the guarantees of <code>acq_rel</code>
1637 (<code>acquire</code> for an operation which only reads, <code>release</code>
1638 for an operation which only writes), there is a global total order on all
1639 sequentially-consistent operations on all addresses, which is consistent with
1640 the <i>happens-before</i> partial order and with the modification orders of
1641 all the affected addresses. Each sequentially-consistent read sees the last
1642 preceding write to the same address in this global order. This is intended
1643 to model C++'s sequentially-consistent atomic variables and Java's volatile
1644 shared variables.</dd>
1645 </dl>
1646
1647 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1648 it only <i>synchronizes with</i> or participates in modification and seq_cst
1649 total orderings with other operations running in the same thread (for example,
1650 in signal handlers).</p>
1651
1652 </div>
1653
1654 </div>
1655
1656 <!-- *********************************************************************** -->
1657 <h2><a name="typesystem">Type System</a></h2>
1658 <!-- *********************************************************************** -->
1659
1660 <div>
1661
1662 <p>The LLVM type system is one of the most important features of the
1663    intermediate representation.  Being typed enables a number of optimizations
1664    to be performed on the intermediate representation directly, without having
1665    to do extra analyses on the side before the transformation.  A strong type
1666    system makes it easier to read the generated code and enables novel analyses
1667    and transformations that are not feasible to perform on normal three address
1668    code representations.</p>
1669
1670 <!-- ======================================================================= -->
1671 <h3>
1672   <a name="t_classifications">Type Classifications</a>
1673 </h3>
1674
1675 <div>
1676
1677 <p>The types fall into a few useful classifications:</p>
1678
1679 <table border="1" cellspacing="0" cellpadding="4">
1680   <tbody>
1681     <tr><th>Classification</th><th>Types</th></tr>
1682     <tr>
1683       <td><a href="#t_integer">integer</a></td>
1684       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1685     </tr>
1686     <tr>
1687       <td><a href="#t_floating">floating point</a></td>
1688       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1689     </tr>
1690     <tr>
1691       <td><a name="t_firstclass">first class</a></td>
1692       <td><a href="#t_integer">integer</a>,
1693           <a href="#t_floating">floating point</a>,
1694           <a href="#t_pointer">pointer</a>,
1695           <a href="#t_vector">vector</a>,
1696           <a href="#t_struct">structure</a>,
1697           <a href="#t_array">array</a>,
1698           <a href="#t_label">label</a>,
1699           <a href="#t_metadata">metadata</a>.
1700       </td>
1701     </tr>
1702     <tr>
1703       <td><a href="#t_primitive">primitive</a></td>
1704       <td><a href="#t_label">label</a>,
1705           <a href="#t_void">void</a>,
1706           <a href="#t_integer">integer</a>,
1707           <a href="#t_floating">floating point</a>,
1708           <a href="#t_x86mmx">x86mmx</a>,
1709           <a href="#t_metadata">metadata</a>.</td>
1710     </tr>
1711     <tr>
1712       <td><a href="#t_derived">derived</a></td>
1713       <td><a href="#t_array">array</a>,
1714           <a href="#t_function">function</a>,
1715           <a href="#t_pointer">pointer</a>,
1716           <a href="#t_struct">structure</a>,
1717           <a href="#t_vector">vector</a>,
1718           <a href="#t_opaque">opaque</a>.
1719       </td>
1720     </tr>
1721   </tbody>
1722 </table>
1723
1724 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1725    important.  Values of these types are the only ones which can be produced by
1726    instructions.</p>
1727
1728 </div>
1729
1730 <!-- ======================================================================= -->
1731 <h3>
1732   <a name="t_primitive">Primitive Types</a>
1733 </h3>
1734
1735 <div>
1736
1737 <p>The primitive types are the fundamental building blocks of the LLVM
1738    system.</p>
1739
1740 <!-- _______________________________________________________________________ -->
1741 <h4>
1742   <a name="t_integer">Integer Type</a>
1743 </h4>
1744
1745 <div>
1746
1747 <h5>Overview:</h5>
1748 <p>The integer type is a very simple type that simply specifies an arbitrary
1749    bit width for the integer type desired. Any bit width from 1 bit to
1750    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1751
1752 <h5>Syntax:</h5>
1753 <pre>
1754   iN
1755 </pre>
1756
1757 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1758    value.</p>
1759
1760 <h5>Examples:</h5>
1761 <table class="layout">
1762   <tr class="layout">
1763     <td class="left"><tt>i1</tt></td>
1764     <td class="left">a single-bit integer.</td>
1765   </tr>
1766   <tr class="layout">
1767     <td class="left"><tt>i32</tt></td>
1768     <td class="left">a 32-bit integer.</td>
1769   </tr>
1770   <tr class="layout">
1771     <td class="left"><tt>i1942652</tt></td>
1772     <td class="left">a really big integer of over 1 million bits.</td>
1773   </tr>
1774 </table>
1775
1776 </div>
1777
1778 <!-- _______________________________________________________________________ -->
1779 <h4>
1780   <a name="t_floating">Floating Point Types</a>
1781 </h4>
1782
1783 <div>
1784
1785 <table>
1786   <tbody>
1787     <tr><th>Type</th><th>Description</th></tr>
1788     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1789     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1790     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1791     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1792     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1793   </tbody>
1794 </table>
1795
1796 </div>
1797
1798 <!-- _______________________________________________________________________ -->
1799 <h4>
1800   <a name="t_x86mmx">X86mmx Type</a>
1801 </h4>
1802
1803 <div>
1804
1805 <h5>Overview:</h5>
1806 <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>
1807
1808 <h5>Syntax:</h5>
1809 <pre>
1810   x86mmx
1811 </pre>
1812
1813 </div>
1814
1815 <!-- _______________________________________________________________________ -->
1816 <h4>
1817   <a name="t_void">Void Type</a>
1818 </h4>
1819
1820 <div>
1821
1822 <h5>Overview:</h5>
1823 <p>The void type does not represent any value and has no size.</p>
1824
1825 <h5>Syntax:</h5>
1826 <pre>
1827   void
1828 </pre>
1829
1830 </div>
1831
1832 <!-- _______________________________________________________________________ -->
1833 <h4>
1834   <a name="t_label">Label Type</a>
1835 </h4>
1836
1837 <div>
1838
1839 <h5>Overview:</h5>
1840 <p>The label type represents code labels.</p>
1841
1842 <h5>Syntax:</h5>
1843 <pre>
1844   label
1845 </pre>
1846
1847 </div>
1848
1849 <!-- _______________________________________________________________________ -->
1850 <h4>
1851   <a name="t_metadata">Metadata Type</a>
1852 </h4>
1853
1854 <div>
1855
1856 <h5>Overview:</h5>
1857 <p>The metadata type represents embedded metadata. No derived types may be
1858    created from metadata except for <a href="#t_function">function</a>
1859    arguments.
1860
1861 <h5>Syntax:</h5>
1862 <pre>
1863   metadata
1864 </pre>
1865
1866 </div>
1867
1868 </div>
1869
1870 <!-- ======================================================================= -->
1871 <h3>
1872   <a name="t_derived">Derived Types</a>
1873 </h3>
1874
1875 <div>
1876
1877 <p>The real power in LLVM comes from the derived types in the system.  This is
1878    what allows a programmer to represent arrays, functions, pointers, and other
1879    useful types.  Each of these types contain one or more element types which
1880    may be a primitive type, or another derived type.  For example, it is
1881    possible to have a two dimensional array, using an array as the element type
1882    of another array.</p>
1883
1884 </div>
1885
1886
1887 <!-- _______________________________________________________________________ -->
1888 <h4>
1889   <a name="t_aggregate">Aggregate Types</a>
1890 </h4>
1891
1892 <div>
1893
1894 <p>Aggregate Types are a subset of derived types that can contain multiple
1895   member types. <a href="#t_array">Arrays</a>,
1896   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1897   aggregate types.</p>
1898
1899 </div>
1900
1901 <!-- _______________________________________________________________________ -->
1902 <h4>
1903   <a name="t_array">Array Type</a>
1904 </h4>
1905
1906 <div>
1907
1908 <h5>Overview:</h5>
1909 <p>The array type is a very simple derived type that arranges elements
1910    sequentially in memory.  The array type requires a size (number of elements)
1911    and an underlying data type.</p>
1912
1913 <h5>Syntax:</h5>
1914 <pre>
1915   [&lt;# elements&gt; x &lt;elementtype&gt;]
1916 </pre>
1917
1918 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1919    be any type with a size.</p>
1920
1921 <h5>Examples:</h5>
1922 <table class="layout">
1923   <tr class="layout">
1924     <td class="left"><tt>[40 x i32]</tt></td>
1925     <td class="left">Array of 40 32-bit integer values.</td>
1926   </tr>
1927   <tr class="layout">
1928     <td class="left"><tt>[41 x i32]</tt></td>
1929     <td class="left">Array of 41 32-bit integer values.</td>
1930   </tr>
1931   <tr class="layout">
1932     <td class="left"><tt>[4 x i8]</tt></td>
1933     <td class="left">Array of 4 8-bit integer values.</td>
1934   </tr>
1935 </table>
1936 <p>Here are some examples of multidimensional arrays:</p>
1937 <table class="layout">
1938   <tr class="layout">
1939     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1940     <td class="left">3x4 array of 32-bit integer values.</td>
1941   </tr>
1942   <tr class="layout">
1943     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1944     <td class="left">12x10 array of single precision floating point values.</td>
1945   </tr>
1946   <tr class="layout">
1947     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1948     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1949   </tr>
1950 </table>
1951
1952 <p>There is no restriction on indexing beyond the end of the array implied by
1953    a static type (though there are restrictions on indexing beyond the bounds
1954    of an allocated object in some cases). This means that single-dimension
1955    'variable sized array' addressing can be implemented in LLVM with a zero
1956    length array type. An implementation of 'pascal style arrays' in LLVM could
1957    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1958
1959 </div>
1960
1961 <!-- _______________________________________________________________________ -->
1962 <h4>
1963   <a name="t_function">Function Type</a>
1964 </h4>
1965
1966 <div>
1967
1968 <h5>Overview:</h5>
1969 <p>The function type can be thought of as a function signature.  It consists of
1970    a return type and a list of formal parameter types. The return type of a
1971    function type is a first class type or a void type.</p>
1972
1973 <h5>Syntax:</h5>
1974 <pre>
1975   &lt;returntype&gt; (&lt;parameter list&gt;)
1976 </pre>
1977
1978 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1979    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1980    which indicates that the function takes a variable number of arguments.
1981    Variable argument functions can access their arguments with
1982    the <a href="#int_varargs">variable argument handling intrinsic</a>
1983    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1984    <a href="#t_label">label</a>.</p>
1985
1986 <h5>Examples:</h5>
1987 <table class="layout">
1988   <tr class="layout">
1989     <td class="left"><tt>i32 (i32)</tt></td>
1990     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1991     </td>
1992   </tr><tr class="layout">
1993     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1994     </tt></td>
1995     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1996       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1997       returning <tt>float</tt>.
1998     </td>
1999   </tr><tr class="layout">
2000     <td class="left"><tt>i32 (i8*, ...)</tt></td>
2001     <td class="left">A vararg function that takes at least one
2002       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2003       which returns an integer.  This is the signature for <tt>printf</tt> in
2004       LLVM.
2005     </td>
2006   </tr><tr class="layout">
2007     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2008     <td class="left">A function taking an <tt>i32</tt>, returning a
2009         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2010     </td>
2011   </tr>
2012 </table>
2013
2014 </div>
2015
2016 <!-- _______________________________________________________________________ -->
2017 <h4>
2018   <a name="t_struct">Structure Type</a>
2019 </h4>
2020
2021 <div>
2022
2023 <h5>Overview:</h5>
2024 <p>The structure type is used to represent a collection of data members together
2025   in memory.  The elements of a structure may be any type that has a size.</p>
2026
2027 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2028    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2029    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2030    Structures in registers are accessed using the
2031    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2032    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2033
2034 <p>Structures may optionally be "packed" structures, which indicate that the
2035   alignment of the struct is one byte, and that there is no padding between
2036   the elements.  In non-packed structs, padding between field types is defined
2037   by the target data string to match the underlying processor.</p>
2038
2039 <p>Structures can either be "anonymous" or "named".  An anonymous structure is
2040   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) and a named types
2041   are always defined at the top level with a name.  Anonmyous types are uniqued
2042   by their contents and can never be recursive since there is no way to write
2043   one.  Named types can be recursive.
2044 </p>
2045
2046 <h5>Syntax:</h5>
2047 <pre>
2048   %T1 = type { &lt;type list&gt; }     <i>; Named normal struct type</i>
2049   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Named packed struct type</i>
2050 </pre>
2051
2052 <h5>Examples:</h5>
2053 <table class="layout">
2054   <tr class="layout">
2055     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2056     <td class="left">A triple of three <tt>i32</tt> values</td>
2057   </tr>
2058   <tr class="layout">
2059     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2060     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2061       second element is a <a href="#t_pointer">pointer</a> to a
2062       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2063       an <tt>i32</tt>.</td>
2064   </tr>
2065   <tr class="layout">
2066     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2067     <td class="left">A packed struct known to be 5 bytes in size.</td>
2068   </tr>
2069 </table>
2070
2071 </div>
2072
2073 <!-- _______________________________________________________________________ -->
2074 <h4>
2075   <a name="t_opaque">Opaque Structure Types</a>
2076 </h4>
2077
2078 <div>
2079
2080 <h5>Overview:</h5>
2081 <p>Opaque structure types are used to represent named structure types that do
2082    not have a body specified.  This corresponds (for example) to the C notion of
2083    a forward declared structure.</p>
2084
2085 <h5>Syntax:</h5>
2086 <pre>
2087   %X = type opaque
2088   %52 = type opaque
2089 </pre>
2090
2091 <h5>Examples:</h5>
2092 <table class="layout">
2093   <tr class="layout">
2094     <td class="left"><tt>opaque</tt></td>
2095     <td class="left">An opaque type.</td>
2096   </tr>
2097 </table>
2098
2099 </div>
2100
2101
2102
2103 <!-- _______________________________________________________________________ -->
2104 <h4>
2105   <a name="t_pointer">Pointer Type</a>
2106 </h4>
2107
2108 <div>
2109
2110 <h5>Overview:</h5>
2111 <p>The pointer type is used to specify memory locations.
2112    Pointers are commonly used to reference objects in memory.</p>
2113
2114 <p>Pointer types may have an optional address space attribute defining the
2115    numbered address space where the pointed-to object resides. The default
2116    address space is number zero. The semantics of non-zero address
2117    spaces are target-specific.</p>
2118
2119 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2120    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2121
2122 <h5>Syntax:</h5>
2123 <pre>
2124   &lt;type&gt; *
2125 </pre>
2126
2127 <h5>Examples:</h5>
2128 <table class="layout">
2129   <tr class="layout">
2130     <td class="left"><tt>[4 x i32]*</tt></td>
2131     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2132                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2133   </tr>
2134   <tr class="layout">
2135     <td class="left"><tt>i32 (i32*) *</tt></td>
2136     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2137       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2138       <tt>i32</tt>.</td>
2139   </tr>
2140   <tr class="layout">
2141     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2142     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2143      that resides in address space #5.</td>
2144   </tr>
2145 </table>
2146
2147 </div>
2148
2149 <!-- _______________________________________________________________________ -->
2150 <h4>
2151   <a name="t_vector">Vector Type</a>
2152 </h4>
2153
2154 <div>
2155
2156 <h5>Overview:</h5>
2157 <p>A vector type is a simple derived type that represents a vector of elements.
2158    Vector types are used when multiple primitive data are operated in parallel
2159    using a single instruction (SIMD).  A vector type requires a size (number of
2160    elements) and an underlying primitive data type.  Vector types are considered
2161    <a href="#t_firstclass">first class</a>.</p>
2162
2163 <h5>Syntax:</h5>
2164 <pre>
2165   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2166 </pre>
2167
2168 <p>The number of elements is a constant integer value larger than 0; elementtype
2169    may be any integer or floating point type.  Vectors of size zero are not
2170    allowed, and pointers are not allowed as the element type.</p>
2171
2172 <h5>Examples:</h5>
2173 <table class="layout">
2174   <tr class="layout">
2175     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2176     <td class="left">Vector of 4 32-bit integer values.</td>
2177   </tr>
2178   <tr class="layout">
2179     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2180     <td class="left">Vector of 8 32-bit floating-point values.</td>
2181   </tr>
2182   <tr class="layout">
2183     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2184     <td class="left">Vector of 2 64-bit integer values.</td>
2185   </tr>
2186 </table>
2187
2188 </div>
2189
2190 </div>
2191
2192 <!-- *********************************************************************** -->
2193 <h2><a name="constants">Constants</a></h2>
2194 <!-- *********************************************************************** -->
2195
2196 <div>
2197
2198 <p>LLVM has several different basic types of constants.  This section describes
2199    them all and their syntax.</p>
2200
2201 <!-- ======================================================================= -->
2202 <h3>
2203   <a name="simpleconstants">Simple Constants</a>
2204 </h3>
2205
2206 <div>
2207
2208 <dl>
2209   <dt><b>Boolean constants</b></dt>
2210   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2211       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2212
2213   <dt><b>Integer constants</b></dt>
2214   <dd>Standard integers (such as '4') are constants of
2215       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2216       with integer types.</dd>
2217
2218   <dt><b>Floating point constants</b></dt>
2219   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2220       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2221       notation (see below).  The assembler requires the exact decimal value of a
2222       floating-point constant.  For example, the assembler accepts 1.25 but
2223       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2224       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2225
2226   <dt><b>Null pointer constants</b></dt>
2227   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2228       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2229 </dl>
2230
2231 <p>The one non-intuitive notation for constants is the hexadecimal form of
2232    floating point constants.  For example, the form '<tt>double
2233    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2234    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2235    constants are required (and the only time that they are generated by the
2236    disassembler) is when a floating point constant must be emitted but it cannot
2237    be represented as a decimal floating point number in a reasonable number of
2238    digits.  For example, NaN's, infinities, and other special values are
2239    represented in their IEEE hexadecimal format so that assembly and disassembly
2240    do not cause any bits to change in the constants.</p>
2241
2242 <p>When using the hexadecimal form, constants of types float and double are
2243    represented using the 16-digit form shown above (which matches the IEEE754
2244    representation for double); float values must, however, be exactly
2245    representable as IEE754 single precision.  Hexadecimal format is always used
2246    for long double, and there are three forms of long double.  The 80-bit format
2247    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2248    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2249    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2250    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2251    currently supported target uses this format.  Long doubles will only work if
2252    they match the long double format on your target.  All hexadecimal formats
2253    are big-endian (sign bit at the left).</p>
2254
2255 <p>There are no constants of type x86mmx.</p>
2256 </div>
2257
2258 <!-- ======================================================================= -->
2259 <h3>
2260 <a name="aggregateconstants"></a> <!-- old anchor -->
2261 <a name="complexconstants">Complex Constants</a>
2262 </h3>
2263
2264 <div>
2265
2266 <p>Complex constants are a (potentially recursive) combination of simple
2267    constants and smaller complex constants.</p>
2268
2269 <dl>
2270   <dt><b>Structure constants</b></dt>
2271   <dd>Structure constants are represented with notation similar to structure
2272       type definitions (a comma separated list of elements, surrounded by braces
2273       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2274       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2275       Structure constants must have <a href="#t_struct">structure type</a>, and
2276       the number and types of elements must match those specified by the
2277       type.</dd>
2278
2279   <dt><b>Array constants</b></dt>
2280   <dd>Array constants are represented with notation similar to array type
2281      definitions (a comma separated list of elements, surrounded by square
2282      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2283      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2284      the number and types of elements must match those specified by the
2285      type.</dd>
2286
2287   <dt><b>Vector constants</b></dt>
2288   <dd>Vector constants are represented with notation similar to vector type
2289       definitions (a comma separated list of elements, surrounded by
2290       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2291       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2292       have <a href="#t_vector">vector type</a>, and the number and types of
2293       elements must match those specified by the type.</dd>
2294
2295   <dt><b>Zero initialization</b></dt>
2296   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2297       value to zero of <em>any</em> type, including scalar and
2298       <a href="#t_aggregate">aggregate</a> types.
2299       This is often used to avoid having to print large zero initializers
2300       (e.g. for large arrays) and is always exactly equivalent to using explicit
2301       zero initializers.</dd>
2302
2303   <dt><b>Metadata node</b></dt>
2304   <dd>A metadata node is a structure-like constant with
2305       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2306       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2307       be interpreted as part of the instruction stream, metadata is a place to
2308       attach additional information such as debug info.</dd>
2309 </dl>
2310
2311 </div>
2312
2313 <!-- ======================================================================= -->
2314 <h3>
2315   <a name="globalconstants">Global Variable and Function Addresses</a>
2316 </h3>
2317
2318 <div>
2319
2320 <p>The addresses of <a href="#globalvars">global variables</a>
2321    and <a href="#functionstructure">functions</a> are always implicitly valid
2322    (link-time) constants.  These constants are explicitly referenced when
2323    the <a href="#identifiers">identifier for the global</a> is used and always
2324    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2325    legal LLVM file:</p>
2326
2327 <pre class="doc_code">
2328 @X = global i32 17
2329 @Y = global i32 42
2330 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2331 </pre>
2332
2333 </div>
2334
2335 <!-- ======================================================================= -->
2336 <h3>
2337   <a name="undefvalues">Undefined Values</a>
2338 </h3>
2339
2340 <div>
2341
2342 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2343    indicates that the user of the value may receive an unspecified bit-pattern.
2344    Undefined values may be of any type (other than '<tt>label</tt>'
2345    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2346
2347 <p>Undefined values are useful because they indicate to the compiler that the
2348    program is well defined no matter what value is used.  This gives the
2349    compiler more freedom to optimize.  Here are some examples of (potentially
2350    surprising) transformations that are valid (in pseudo IR):</p>
2351
2352
2353 <pre class="doc_code">
2354   %A = add %X, undef
2355   %B = sub %X, undef
2356   %C = xor %X, undef
2357 Safe:
2358   %A = undef
2359   %B = undef
2360   %C = undef
2361 </pre>
2362
2363 <p>This is safe because all of the output bits are affected by the undef bits.
2364    Any output bit can have a zero or one depending on the input bits.</p>
2365
2366 <pre class="doc_code">
2367   %A = or %X, undef
2368   %B = and %X, undef
2369 Safe:
2370   %A = -1
2371   %B = 0
2372 Unsafe:
2373   %A = undef
2374   %B = undef
2375 </pre>
2376
2377 <p>These logical operations have bits that are not always affected by the input.
2378    For example, if <tt>%X</tt> has a zero bit, then the output of the
2379    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2380    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2381    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2382    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2383    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2384    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2385    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2386
2387 <pre class="doc_code">
2388   %A = select undef, %X, %Y
2389   %B = select undef, 42, %Y
2390   %C = select %X, %Y, undef
2391 Safe:
2392   %A = %X     (or %Y)
2393   %B = 42     (or %Y)
2394   %C = %Y
2395 Unsafe:
2396   %A = undef
2397   %B = undef
2398   %C = undef
2399 </pre>
2400
2401 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2402    branch) conditions can go <em>either way</em>, but they have to come from one
2403    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2404    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2405    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2406    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2407    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2408    eliminated.</p>
2409
2410 <pre class="doc_code">
2411   %A = xor undef, undef
2412
2413   %B = undef
2414   %C = xor %B, %B
2415
2416   %D = undef
2417   %E = icmp lt %D, 4
2418   %F = icmp gte %D, 4
2419
2420 Safe:
2421   %A = undef
2422   %B = undef
2423   %C = undef
2424   %D = undef
2425   %E = undef
2426   %F = undef
2427 </pre>
2428
2429 <p>This example points out that two '<tt>undef</tt>' operands are not
2430    necessarily the same. This can be surprising to people (and also matches C
2431    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2432    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2433    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2434    its value over its "live range".  This is true because the variable doesn't
2435    actually <em>have a live range</em>. Instead, the value is logically read
2436    from arbitrary registers that happen to be around when needed, so the value
2437    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2438    need to have the same semantics or the core LLVM "replace all uses with"
2439    concept would not hold.</p>
2440
2441 <pre class="doc_code">
2442   %A = fdiv undef, %X
2443   %B = fdiv %X, undef
2444 Safe:
2445   %A = undef
2446 b: unreachable
2447 </pre>
2448
2449 <p>These examples show the crucial difference between an <em>undefined
2450   value</em> and <em>undefined behavior</em>. An undefined value (like
2451   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2452   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2453   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2454   defined on SNaN's. However, in the second example, we can make a more
2455   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2456   arbitrary value, we are allowed to assume that it could be zero. Since a
2457   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2458   the operation does not execute at all. This allows us to delete the divide and
2459   all code after it. Because the undefined operation "can't happen", the
2460   optimizer can assume that it occurs in dead code.</p>
2461
2462 <pre class="doc_code">
2463 a:  store undef -> %X
2464 b:  store %X -> undef
2465 Safe:
2466 a: &lt;deleted&gt;
2467 b: unreachable
2468 </pre>
2469
2470 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2471    undefined value can be assumed to not have any effect; we can assume that the
2472    value is overwritten with bits that happen to match what was already there.
2473    However, a store <em>to</em> an undefined location could clobber arbitrary
2474    memory, therefore, it has undefined behavior.</p>
2475
2476 </div>
2477
2478 <!-- ======================================================================= -->
2479 <h3>
2480   <a name="trapvalues">Trap Values</a>
2481 </h3>
2482
2483 <div>
2484
2485 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2486    instead of representing an unspecified bit pattern, they represent the
2487    fact that an instruction or constant expression which cannot evoke side
2488    effects has nevertheless detected a condition which results in undefined
2489    behavior.</p>
2490
2491 <p>There is currently no way of representing a trap value in the IR; they
2492    only exist when produced by operations such as
2493    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2494
2495 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2496
2497 <ul>
2498 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2499     their operands.</li>
2500
2501 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2502     to their dynamic predecessor basic block.</li>
2503
2504 <li>Function arguments depend on the corresponding actual argument values in
2505     the dynamic callers of their functions.</li>
2506
2507 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2508     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2509     control back to them.</li>
2510
2511 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2512     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2513     or exception-throwing call instructions that dynamically transfer control
2514     back to them.</li>
2515
2516 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2517     referenced memory addresses, following the order in the IR
2518     (including loads and stores implied by intrinsics such as
2519     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2520
2521 <!-- TODO: In the case of multiple threads, this only applies if the store
2522      "happens-before" the load or store. -->
2523
2524 <!-- TODO: floating-point exception state -->
2525
2526 <li>An instruction with externally visible side effects depends on the most
2527     recent preceding instruction with externally visible side effects, following
2528     the order in the IR. (This includes
2529     <a href="#volatile">volatile operations</a>.)</li>
2530
2531 <li>An instruction <i>control-depends</i> on a
2532     <a href="#terminators">terminator instruction</a>
2533     if the terminator instruction has multiple successors and the instruction
2534     is always executed when control transfers to one of the successors, and
2535     may not be executed when control is transferred to another.</li>
2536
2537 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2538     instruction if the set of instructions it otherwise depends on would be
2539     different if the terminator had transferred control to a different
2540     successor.</li>
2541
2542 <li>Dependence is transitive.</li>
2543
2544 </ul>
2545
2546 <p>Whenever a trap value is generated, all values which depend on it evaluate
2547    to trap. If they have side effects, the evoke their side effects as if each
2548    operand with a trap value were undef. If they have externally-visible side
2549    effects, the behavior is undefined.</p>
2550
2551 <p>Here are some examples:</p>
2552
2553 <pre class="doc_code">
2554 entry:
2555   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2556   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2557   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2558   store i32 0, i32* %trap_yet_again  ; undefined behavior
2559
2560   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2561   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2562
2563   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2564
2565   %narrowaddr = bitcast i32* @g to i16*
2566   %wideaddr = bitcast i32* @g to i64*
2567   %trap3 = load i16* %narrowaddr     ; Returns a trap value.
2568   %trap4 = load i64* %wideaddr       ; Returns a trap value.
2569
2570   %cmp = icmp slt i32 %trap, 0       ; Returns a trap value.
2571   br i1 %cmp, label %true, label %end ; Branch to either destination.
2572
2573 true:
2574   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2575                                      ; it has undefined behavior.
2576   br label %end
2577
2578 end:
2579   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2580                                      ; Both edges into this PHI are
2581                                      ; control-dependent on %cmp, so this
2582                                      ; always results in a trap value.
2583
2584   volatile store i32 0, i32* @g      ; This would depend on the store in %true
2585                                      ; if %cmp is true, or the store in %entry
2586                                      ; otherwise, so this is undefined behavior.
2587
2588   br i1 %cmp, label %second_true, label %second_end
2589                                      ; The same branch again, but this time the
2590                                      ; true block doesn't have side effects.
2591
2592 second_true:
2593   ; No side effects!
2594   ret void
2595
2596 second_end:
2597   volatile store i32 0, i32* @g      ; This time, the instruction always depends
2598                                      ; on the store in %end. Also, it is
2599                                      ; control-equivalent to %end, so this is
2600                                      ; well-defined (again, ignoring earlier
2601                                      ; undefined behavior in this example).
2602 </pre>
2603
2604 </div>
2605
2606 <!-- ======================================================================= -->
2607 <h3>
2608   <a name="blockaddress">Addresses of Basic Blocks</a>
2609 </h3>
2610
2611 <div>
2612
2613 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2614
2615 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2616    basic block in the specified function, and always has an i8* type.  Taking
2617    the address of the entry block is illegal.</p>
2618
2619 <p>This value only has defined behavior when used as an operand to the
2620    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2621    comparisons against null. Pointer equality tests between labels addresses
2622    results in undefined behavior &mdash; though, again, comparison against null
2623    is ok, and no label is equal to the null pointer. This may be passed around
2624    as an opaque pointer sized value as long as the bits are not inspected. This
2625    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2626    long as the original value is reconstituted before the <tt>indirectbr</tt>
2627    instruction.</p>
2628
2629 <p>Finally, some targets may provide defined semantics when using the value as
2630    the operand to an inline assembly, but that is target specific.</p>
2631
2632 </div>
2633
2634
2635 <!-- ======================================================================= -->
2636 <h3>
2637   <a name="constantexprs">Constant Expressions</a>
2638 </h3>
2639
2640 <div>
2641
2642 <p>Constant expressions are used to allow expressions involving other constants
2643    to be used as constants.  Constant expressions may be of
2644    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2645    operation that does not have side effects (e.g. load and call are not
2646    supported). The following is the syntax for constant expressions:</p>
2647
2648 <dl>
2649   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2650   <dd>Truncate a constant to another type. The bit size of CST must be larger
2651       than the bit size of TYPE. Both types must be integers.</dd>
2652
2653   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2654   <dd>Zero extend a constant to another type. The bit size of CST must be
2655       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2656
2657   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2658   <dd>Sign extend a constant to another type. The bit size of CST must be
2659       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2660
2661   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2662   <dd>Truncate a floating point constant to another floating point type. The
2663       size of CST must be larger than the size of TYPE. Both types must be
2664       floating point.</dd>
2665
2666   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2667   <dd>Floating point extend a constant to another type. The size of CST must be
2668       smaller or equal to the size of TYPE. Both types must be floating
2669       point.</dd>
2670
2671   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2672   <dd>Convert a floating point constant to the corresponding unsigned integer
2673       constant. TYPE must be a scalar or vector integer type. CST must be of
2674       scalar or vector floating point type. Both CST and TYPE must be scalars,
2675       or vectors of the same number of elements. If the value won't fit in the
2676       integer type, the results are undefined.</dd>
2677
2678   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2679   <dd>Convert a floating point constant to the corresponding signed integer
2680       constant.  TYPE must be a scalar or vector integer type. CST must be of
2681       scalar or vector floating point type. Both CST and TYPE must be scalars,
2682       or vectors of the same number of elements. If the value won't fit in the
2683       integer type, the results are undefined.</dd>
2684
2685   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2686   <dd>Convert an unsigned integer constant to the corresponding floating point
2687       constant. TYPE must be a scalar or vector floating point type. CST must be
2688       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2689       vectors of the same number of elements. If the value won't fit in the
2690       floating point type, the results are undefined.</dd>
2691
2692   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2693   <dd>Convert a signed integer constant to the corresponding floating point
2694       constant. TYPE must be a scalar or vector floating point type. CST must be
2695       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2696       vectors of the same number of elements. If the value won't fit in the
2697       floating point type, the results are undefined.</dd>
2698
2699   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2700   <dd>Convert a pointer typed constant to the corresponding integer constant
2701       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2702       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2703       make it fit in <tt>TYPE</tt>.</dd>
2704
2705   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2706   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2707       type.  CST must be of integer type. The CST value is zero extended,
2708       truncated, or unchanged to make it fit in a pointer size. This one is
2709       <i>really</i> dangerous!</dd>
2710
2711   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2712   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2713       are the same as those for the <a href="#i_bitcast">bitcast
2714       instruction</a>.</dd>
2715
2716   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2717   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2718   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2719       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2720       instruction, the index list may have zero or more indexes, which are
2721       required to make sense for the type of "CSTPTR".</dd>
2722
2723   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2724   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2725
2726   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2727   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2728
2729   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2730   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2731
2732   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2733   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2734       constants.</dd>
2735
2736   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2737   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2738     constants.</dd>
2739
2740   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2741   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2742       constants.</dd>
2743
2744   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2745   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2746     constants. The index list is interpreted in a similar manner as indices in
2747     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2748     index value must be specified.</dd>
2749
2750   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2751   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2752     constants. The index list is interpreted in a similar manner as indices in
2753     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2754     index value must be specified.</dd>
2755
2756   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2757   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2758       be any of the <a href="#binaryops">binary</a>
2759       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2760       on operands are the same as those for the corresponding instruction
2761       (e.g. no bitwise operations on floating point values are allowed).</dd>
2762 </dl>
2763
2764 </div>
2765
2766 </div>
2767
2768 <!-- *********************************************************************** -->
2769 <h2><a name="othervalues">Other Values</a></h2>
2770 <!-- *********************************************************************** -->
2771 <div>
2772 <!-- ======================================================================= -->
2773 <h3>
2774 <a name="inlineasm">Inline Assembler Expressions</a>
2775 </h3>
2776
2777 <div>
2778
2779 <p>LLVM supports inline assembler expressions (as opposed
2780    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2781    a special value.  This value represents the inline assembler as a string
2782    (containing the instructions to emit), a list of operand constraints (stored
2783    as a string), a flag that indicates whether or not the inline asm
2784    expression has side effects, and a flag indicating whether the function
2785    containing the asm needs to align its stack conservatively.  An example
2786    inline assembler expression is:</p>
2787
2788 <pre class="doc_code">
2789 i32 (i32) asm "bswap $0", "=r,r"
2790 </pre>
2791
2792 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2793    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2794    have:</p>
2795
2796 <pre class="doc_code">
2797 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2798 </pre>
2799
2800 <p>Inline asms with side effects not visible in the constraint list must be
2801    marked as having side effects.  This is done through the use of the
2802    '<tt>sideeffect</tt>' keyword, like so:</p>
2803
2804 <pre class="doc_code">
2805 call void asm sideeffect "eieio", ""()
2806 </pre>
2807
2808 <p>In some cases inline asms will contain code that will not work unless the
2809    stack is aligned in some way, such as calls or SSE instructions on x86,
2810    yet will not contain code that does that alignment within the asm.
2811    The compiler should make conservative assumptions about what the asm might
2812    contain and should generate its usual stack alignment code in the prologue
2813    if the '<tt>alignstack</tt>' keyword is present:</p>
2814
2815 <pre class="doc_code">
2816 call void asm alignstack "eieio", ""()
2817 </pre>
2818
2819 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2820    first.</p>
2821
2822 <p>TODO: The format of the asm and constraints string still need to be
2823    documented here.  Constraints on what can be done (e.g. duplication, moving,
2824    etc need to be documented).  This is probably best done by reference to
2825    another document that covers inline asm from a holistic perspective.</p>
2826
2827 <h4>
2828 <a name="inlineasm_md">Inline Asm Metadata</a>
2829 </h4>
2830
2831 <div>
2832
2833 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2834    attached to it that contains a list of constant integers.  If present, the
2835   code generator will use the integer as the location cookie value when report
2836    errors through the LLVMContext error reporting mechanisms.  This allows a
2837    front-end to correlate backend errors that occur with inline asm back to the
2838    source code that produced it.  For example:</p>
2839
2840 <pre class="doc_code">
2841 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2842 ...
2843 !42 = !{ i32 1234567 }
2844 </pre>
2845
2846 <p>It is up to the front-end to make sense of the magic numbers it places in the
2847    IR.  If the MDNode contains multiple constants, the code generator will use
2848    the one that corresponds to the line of the asm that the error occurs on.</p>
2849
2850 </div>
2851
2852 </div>
2853
2854 <!-- ======================================================================= -->
2855 <h3>
2856   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2857 </h3>
2858
2859 <div>
2860
2861 <p>LLVM IR allows metadata to be attached to instructions in the program that
2862    can convey extra information about the code to the optimizers and code
2863    generator.  One example application of metadata is source-level debug
2864    information.  There are two metadata primitives: strings and nodes. All
2865    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2866    preceding exclamation point ('<tt>!</tt>').</p>
2867
2868 <p>A metadata string is a string surrounded by double quotes.  It can contain
2869    any character by escaping non-printable characters with "\xx" where "xx" is
2870    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2871
2872 <p>Metadata nodes are represented with notation similar to structure constants
2873    (a comma separated list of elements, surrounded by braces and preceded by an
2874    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2875    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2876
2877 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2878    metadata nodes, which can be looked up in the module symbol table. For
2879    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2880
2881 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2882    function is using two metadata arguments.</p>
2883
2884 <div class="doc_code">
2885 <pre>
2886 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2887 </pre>
2888 </div>
2889
2890 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2891    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2892
2893 <div class="doc_code">
2894 <pre>
2895 %indvar.next = add i64 %indvar, 1, !dbg !21
2896 </pre>
2897 </div>
2898
2899 </div>
2900
2901 </div>
2902
2903 <!-- *********************************************************************** -->
2904 <h2>
2905   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2906 </h2>
2907 <!-- *********************************************************************** -->
2908 <div>
2909 <p>LLVM has a number of "magic" global variables that contain data that affect
2910 code generation or other IR semantics.  These are documented here.  All globals
2911 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2912 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2913 by LLVM.</p>
2914
2915 <!-- ======================================================================= -->
2916 <h3>
2917 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2918 </h3>
2919
2920 <div>
2921
2922 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2923 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2924 pointers to global variables and functions which may optionally have a pointer
2925 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2926
2927 <pre>
2928   @X = global i8 4
2929   @Y = global i32 123
2930
2931   @llvm.used = appending global [2 x i8*] [
2932      i8* @X,
2933      i8* bitcast (i32* @Y to i8*)
2934   ], section "llvm.metadata"
2935 </pre>
2936
2937 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2938 compiler, assembler, and linker are required to treat the symbol as if there is
2939 a reference to the global that it cannot see.  For example, if a variable has
2940 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2941 list, it cannot be deleted.  This is commonly used to represent references from
2942 inline asms and other things the compiler cannot "see", and corresponds to
2943 "attribute((used))" in GNU C.</p>
2944
2945 <p>On some targets, the code generator must emit a directive to the assembler or
2946 object file to prevent the assembler and linker from molesting the symbol.</p>
2947
2948 </div>
2949
2950 <!-- ======================================================================= -->
2951 <h3>
2952   <a name="intg_compiler_used">
2953     The '<tt>llvm.compiler.used</tt>' Global Variable
2954   </a>
2955 </h3>
2956
2957 <div>
2958
2959 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2960 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2961 touching the symbol.  On targets that support it, this allows an intelligent
2962 linker to optimize references to the symbol without being impeded as it would be
2963 by <tt>@llvm.used</tt>.</p>
2964
2965 <p>This is a rare construct that should only be used in rare circumstances, and
2966 should not be exposed to source languages.</p>
2967
2968 </div>
2969
2970 <!-- ======================================================================= -->
2971 <h3>
2972 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2973 </h3>
2974
2975 <div>
2976 <pre>
2977 %0 = type { i32, void ()* }
2978 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2979 </pre>
2980 <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.
2981 </p>
2982
2983 </div>
2984
2985 <!-- ======================================================================= -->
2986 <h3>
2987 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2988 </h3>
2989
2990 <div>
2991 <pre>
2992 %0 = type { i32, void ()* }
2993 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2994 </pre>
2995
2996 <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.
2997 </p>
2998
2999 </div>
3000
3001 </div>
3002
3003 <!-- *********************************************************************** -->
3004 <h2><a name="instref">Instruction Reference</a></h2>
3005 <!-- *********************************************************************** -->
3006
3007 <div>
3008
3009 <p>The LLVM instruction set consists of several different classifications of
3010    instructions: <a href="#terminators">terminator
3011    instructions</a>, <a href="#binaryops">binary instructions</a>,
3012    <a href="#bitwiseops">bitwise binary instructions</a>,
3013    <a href="#memoryops">memory instructions</a>, and
3014    <a href="#otherops">other instructions</a>.</p>
3015
3016 <!-- ======================================================================= -->
3017 <h3>
3018   <a name="terminators">Terminator Instructions</a>
3019 </h3>
3020
3021 <div>
3022
3023 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3024    in a program ends with a "Terminator" instruction, which indicates which
3025    block should be executed after the current block is finished. These
3026    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3027    control flow, not values (the one exception being the
3028    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3029
3030 <p>The terminator instructions are:
3031    '<a href="#i_ret"><tt>ret</tt></a>',
3032    '<a href="#i_br"><tt>br</tt></a>',
3033    '<a href="#i_switch"><tt>switch</tt></a>',
3034    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3035    '<a href="#i_invoke"><tt>invoke</tt></a>',
3036    '<a href="#i_unwind"><tt>unwind</tt></a>',
3037    '<a href="#i_resume"><tt>resume</tt></a>', and
3038    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3039
3040 <!-- _______________________________________________________________________ -->
3041 <h4>
3042   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3043 </h4>
3044
3045 <div>
3046
3047 <h5>Syntax:</h5>
3048 <pre>
3049   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3050   ret void                 <i>; Return from void function</i>
3051 </pre>
3052
3053 <h5>Overview:</h5>
3054 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3055    a value) from a function back to the caller.</p>
3056
3057 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3058    value and then causes control flow, and one that just causes control flow to
3059    occur.</p>
3060
3061 <h5>Arguments:</h5>
3062 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3063    return value. The type of the return value must be a
3064    '<a href="#t_firstclass">first class</a>' type.</p>
3065
3066 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3067    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3068    value or a return value with a type that does not match its type, or if it
3069    has a void return type and contains a '<tt>ret</tt>' instruction with a
3070    return value.</p>
3071
3072 <h5>Semantics:</h5>
3073 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3074    the calling function's context.  If the caller is a
3075    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3076    instruction after the call.  If the caller was an
3077    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3078    the beginning of the "normal" destination block.  If the instruction returns
3079    a value, that value shall set the call or invoke instruction's return
3080    value.</p>
3081
3082 <h5>Example:</h5>
3083 <pre>
3084   ret i32 5                       <i>; Return an integer value of 5</i>
3085   ret void                        <i>; Return from a void function</i>
3086   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3087 </pre>
3088
3089 </div>
3090 <!-- _______________________________________________________________________ -->
3091 <h4>
3092   <a name="i_br">'<tt>br</tt>' Instruction</a>
3093 </h4>
3094
3095 <div>
3096
3097 <h5>Syntax:</h5>
3098 <pre>
3099   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3100   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3101 </pre>
3102
3103 <h5>Overview:</h5>
3104 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3105    different basic block in the current function.  There are two forms of this
3106    instruction, corresponding to a conditional branch and an unconditional
3107    branch.</p>
3108
3109 <h5>Arguments:</h5>
3110 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3111    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3112    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3113    target.</p>
3114
3115 <h5>Semantics:</h5>
3116 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3117    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3118    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3119    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3120
3121 <h5>Example:</h5>
3122 <pre>
3123 Test:
3124   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3125   br i1 %cond, label %IfEqual, label %IfUnequal
3126 IfEqual:
3127   <a href="#i_ret">ret</a> i32 1
3128 IfUnequal:
3129   <a href="#i_ret">ret</a> i32 0
3130 </pre>
3131
3132 </div>
3133
3134 <!-- _______________________________________________________________________ -->
3135 <h4>
3136    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3137 </h4>
3138
3139 <div>
3140
3141 <h5>Syntax:</h5>
3142 <pre>
3143   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3144 </pre>
3145
3146 <h5>Overview:</h5>
3147 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3148    several different places.  It is a generalization of the '<tt>br</tt>'
3149    instruction, allowing a branch to occur to one of many possible
3150    destinations.</p>
3151
3152 <h5>Arguments:</h5>
3153 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3154    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3155    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3156    The table is not allowed to contain duplicate constant entries.</p>
3157
3158 <h5>Semantics:</h5>
3159 <p>The <tt>switch</tt> instruction specifies a table of values and
3160    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3161    is searched for the given value.  If the value is found, control flow is
3162    transferred to the corresponding destination; otherwise, control flow is
3163    transferred to the default destination.</p>
3164
3165 <h5>Implementation:</h5>
3166 <p>Depending on properties of the target machine and the particular
3167    <tt>switch</tt> instruction, this instruction may be code generated in
3168    different ways.  For example, it could be generated as a series of chained
3169    conditional branches or with a lookup table.</p>
3170
3171 <h5>Example:</h5>
3172 <pre>
3173  <i>; Emulate a conditional br instruction</i>
3174  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3175  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3176
3177  <i>; Emulate an unconditional br instruction</i>
3178  switch i32 0, label %dest [ ]
3179
3180  <i>; Implement a jump table:</i>
3181  switch i32 %val, label %otherwise [ i32 0, label %onzero
3182                                      i32 1, label %onone
3183                                      i32 2, label %ontwo ]
3184 </pre>
3185
3186 </div>
3187
3188
3189 <!-- _______________________________________________________________________ -->
3190 <h4>
3191    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3192 </h4>
3193
3194 <div>
3195
3196 <h5>Syntax:</h5>
3197 <pre>
3198   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3199 </pre>
3200
3201 <h5>Overview:</h5>
3202
3203 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3204    within the current function, whose address is specified by
3205    "<tt>address</tt>".  Address must be derived from a <a
3206    href="#blockaddress">blockaddress</a> constant.</p>
3207
3208 <h5>Arguments:</h5>
3209
3210 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3211    rest of the arguments indicate the full set of possible destinations that the
3212    address may point to.  Blocks are allowed to occur multiple times in the
3213    destination list, though this isn't particularly useful.</p>
3214
3215 <p>This destination list is required so that dataflow analysis has an accurate
3216    understanding of the CFG.</p>
3217
3218 <h5>Semantics:</h5>
3219
3220 <p>Control transfers to the block specified in the address argument.  All
3221    possible destination blocks must be listed in the label list, otherwise this
3222    instruction has undefined behavior.  This implies that jumps to labels
3223    defined in other functions have undefined behavior as well.</p>
3224
3225 <h5>Implementation:</h5>
3226
3227 <p>This is typically implemented with a jump through a register.</p>
3228
3229 <h5>Example:</h5>
3230 <pre>
3231  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3232 </pre>
3233
3234 </div>
3235
3236
3237 <!-- _______________________________________________________________________ -->
3238 <h4>
3239   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3240 </h4>
3241
3242 <div>
3243
3244 <h5>Syntax:</h5>
3245 <pre>
3246   &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>]
3247                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3248 </pre>
3249
3250 <h5>Overview:</h5>
3251 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3252    function, with the possibility of control flow transfer to either the
3253    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3254    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3255    control flow will return to the "normal" label.  If the callee (or any
3256    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3257    instruction, control is interrupted and continued at the dynamically nearest
3258    "exception" label.</p>
3259
3260 <p>The '<tt>exception</tt>' label is a
3261    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3262    exception. As such, '<tt>exception</tt>' label is required to have the
3263    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3264    the information about about the behavior of the program after unwinding
3265    happens, as its first non-PHI instruction. The restrictions on the
3266    "<tt>landingpad</tt>" instruction's tightly couples it to the
3267    "<tt>invoke</tt>" instruction, so that the important information contained
3268    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3269    code motion.</p>
3270
3271 <h5>Arguments:</h5>
3272 <p>This instruction requires several arguments:</p>
3273
3274 <ol>
3275   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3276       convention</a> the call should use.  If none is specified, the call
3277       defaults to using C calling conventions.</li>
3278
3279   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3280       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3281       '<tt>inreg</tt>' attributes are valid here.</li>
3282
3283   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3284       function value being invoked.  In most cases, this is a direct function
3285       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3286       off an arbitrary pointer to function value.</li>
3287
3288   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3289       function to be invoked. </li>
3290
3291   <li>'<tt>function args</tt>': argument list whose types match the function
3292       signature argument types and parameter attributes. All arguments must be
3293       of <a href="#t_firstclass">first class</a> type. If the function
3294       signature indicates the function accepts a variable number of arguments,
3295       the extra arguments can be specified.</li>
3296
3297   <li>'<tt>normal label</tt>': the label reached when the called function
3298       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3299
3300   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3301       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3302
3303   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3304       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3305       '<tt>readnone</tt>' attributes are valid here.</li>
3306 </ol>
3307
3308 <h5>Semantics:</h5>
3309 <p>This instruction is designed to operate as a standard
3310    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3311    primary difference is that it establishes an association with a label, which
3312    is used by the runtime library to unwind the stack.</p>
3313
3314 <p>This instruction is used in languages with destructors to ensure that proper
3315    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3316    exception.  Additionally, this is important for implementation of
3317    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3318
3319 <p>For the purposes of the SSA form, the definition of the value returned by the
3320    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3321    block to the "normal" label. If the callee unwinds then no return value is
3322    available.</p>
3323
3324 <p>Note that the code generator does not yet completely support unwind, and
3325 that the invoke/unwind semantics are likely to change in future versions.</p>
3326
3327 <h5>Example:</h5>
3328 <pre>
3329   %retval = invoke i32 @Test(i32 15) to label %Continue
3330               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3331   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3332               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3333 </pre>
3334
3335 </div>
3336
3337 <!-- _______________________________________________________________________ -->
3338
3339 <h4>
3340   <a name="i_unwind">'<tt>unwind</tt>' Instruction</a>
3341 </h4>
3342
3343 <div>
3344
3345 <h5>Syntax:</h5>
3346 <pre>
3347   unwind
3348 </pre>
3349
3350 <h5>Overview:</h5>
3351 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3352    at the first callee in the dynamic call stack which used
3353    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3354    This is primarily used to implement exception handling.</p>
3355
3356 <h5>Semantics:</h5>
3357 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3358    immediately halt.  The dynamic call stack is then searched for the
3359    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3360    Once found, execution continues at the "exceptional" destination block
3361    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3362    instruction in the dynamic call chain, undefined behavior results.</p>
3363
3364 <p>Note that the code generator does not yet completely support unwind, and
3365 that the invoke/unwind semantics are likely to change in future versions.</p>
3366
3367 </div>
3368
3369  <!-- _______________________________________________________________________ -->
3370
3371 <h4>
3372   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3373 </h4>
3374
3375 <div>
3376
3377 <h5>Syntax:</h5>
3378 <pre>
3379   resume &lt;type&gt; &lt;value&gt;
3380 </pre>
3381
3382 <h5>Overview:</h5>
3383 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3384    successors.</p>
3385
3386 <h5>Arguments:</h5>
3387 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3388    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3389    function.</p>
3390
3391 <h5>Semantics:</h5>
3392 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3393    (in-flight) exception whose unwinding was interrupted with
3394    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3395
3396 <h5>Example:</h5>
3397 <pre>
3398   resume { i8*, i32 } %exn
3399 </pre>
3400
3401 </div>
3402
3403 <!-- _______________________________________________________________________ -->
3404
3405 <h4>
3406   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3407 </h4>
3408
3409 <div>
3410
3411 <h5>Syntax:</h5>
3412 <pre>
3413   unreachable
3414 </pre>
3415
3416 <h5>Overview:</h5>
3417 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3418    instruction is used to inform the optimizer that a particular portion of the
3419    code is not reachable.  This can be used to indicate that the code after a
3420    no-return function cannot be reached, and other facts.</p>
3421
3422 <h5>Semantics:</h5>
3423 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3424
3425 </div>
3426
3427 </div>
3428
3429 <!-- ======================================================================= -->
3430 <h3>
3431   <a name="binaryops">Binary Operations</a>
3432 </h3>
3433
3434 <div>
3435
3436 <p>Binary operators are used to do most of the computation in a program.  They
3437    require two operands of the same type, execute an operation on them, and
3438    produce a single value.  The operands might represent multiple data, as is
3439    the case with the <a href="#t_vector">vector</a> data type.  The result value
3440    has the same type as its operands.</p>
3441
3442 <p>There are several different binary operators:</p>
3443
3444 <!-- _______________________________________________________________________ -->
3445 <h4>
3446   <a name="i_add">'<tt>add</tt>' Instruction</a>
3447 </h4>
3448
3449 <div>
3450
3451 <h5>Syntax:</h5>
3452 <pre>
3453   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3454   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3455   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3456   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3457 </pre>
3458
3459 <h5>Overview:</h5>
3460 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3461
3462 <h5>Arguments:</h5>
3463 <p>The two arguments to the '<tt>add</tt>' instruction must
3464    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3465    integer values. Both arguments must have identical types.</p>
3466
3467 <h5>Semantics:</h5>
3468 <p>The value produced is the integer sum of the two operands.</p>
3469
3470 <p>If the sum has unsigned overflow, the result returned is the mathematical
3471    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3472
3473 <p>Because LLVM integers use a two's complement representation, this instruction
3474    is appropriate for both signed and unsigned integers.</p>
3475
3476 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3477    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3478    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3479    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3480    respectively, occurs.</p>
3481
3482 <h5>Example:</h5>
3483 <pre>
3484   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3485 </pre>
3486
3487 </div>
3488
3489 <!-- _______________________________________________________________________ -->
3490 <h4>
3491   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3492 </h4>
3493
3494 <div>
3495
3496 <h5>Syntax:</h5>
3497 <pre>
3498   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3499 </pre>
3500
3501 <h5>Overview:</h5>
3502 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3503
3504 <h5>Arguments:</h5>
3505 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3506    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3507    floating point values. Both arguments must have identical types.</p>
3508
3509 <h5>Semantics:</h5>
3510 <p>The value produced is the floating point sum of the two operands.</p>
3511
3512 <h5>Example:</h5>
3513 <pre>
3514   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3515 </pre>
3516
3517 </div>
3518
3519 <!-- _______________________________________________________________________ -->
3520 <h4>
3521    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3522 </h4>
3523
3524 <div>
3525
3526 <h5>Syntax:</h5>
3527 <pre>
3528   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3529   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3530   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3531   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3532 </pre>
3533
3534 <h5>Overview:</h5>
3535 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3536    operands.</p>
3537
3538 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3539    '<tt>neg</tt>' instruction present in most other intermediate
3540    representations.</p>
3541
3542 <h5>Arguments:</h5>
3543 <p>The two arguments to the '<tt>sub</tt>' instruction must
3544    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3545    integer values.  Both arguments must have identical types.</p>
3546
3547 <h5>Semantics:</h5>
3548 <p>The value produced is the integer difference of the two operands.</p>
3549
3550 <p>If the difference has unsigned overflow, the result returned is the
3551    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3552    result.</p>
3553
3554 <p>Because LLVM integers use a two's complement representation, this instruction
3555    is appropriate for both signed and unsigned integers.</p>
3556
3557 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3558    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3559    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3560    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3561    respectively, occurs.</p>
3562
3563 <h5>Example:</h5>
3564 <pre>
3565   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3566   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3567 </pre>
3568
3569 </div>
3570
3571 <!-- _______________________________________________________________________ -->
3572 <h4>
3573    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3574 </h4>
3575
3576 <div>
3577
3578 <h5>Syntax:</h5>
3579 <pre>
3580   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3581 </pre>
3582
3583 <h5>Overview:</h5>
3584 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3585    operands.</p>
3586
3587 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3588    '<tt>fneg</tt>' instruction present in most other intermediate
3589    representations.</p>
3590
3591 <h5>Arguments:</h5>
3592 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3593    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3594    floating point values.  Both arguments must have identical types.</p>
3595
3596 <h5>Semantics:</h5>
3597 <p>The value produced is the floating point difference of the two operands.</p>
3598
3599 <h5>Example:</h5>
3600 <pre>
3601   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3602   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3603 </pre>
3604
3605 </div>
3606
3607 <!-- _______________________________________________________________________ -->
3608 <h4>
3609   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3610 </h4>
3611
3612 <div>
3613
3614 <h5>Syntax:</h5>
3615 <pre>
3616   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3617   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3618   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3619   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3620 </pre>
3621
3622 <h5>Overview:</h5>
3623 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3624
3625 <h5>Arguments:</h5>
3626 <p>The two arguments to the '<tt>mul</tt>' instruction must
3627    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3628    integer values.  Both arguments must have identical types.</p>
3629
3630 <h5>Semantics:</h5>
3631 <p>The value produced is the integer product of the two operands.</p>
3632
3633 <p>If the result of the multiplication has unsigned overflow, the result
3634    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3635    width of the result.</p>
3636
3637 <p>Because LLVM integers use a two's complement representation, and the result
3638    is the same width as the operands, this instruction returns the correct
3639    result for both signed and unsigned integers.  If a full product
3640    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3641    be sign-extended or zero-extended as appropriate to the width of the full
3642    product.</p>
3643
3644 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3645    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3646    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3647    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3648    respectively, occurs.</p>
3649
3650 <h5>Example:</h5>
3651 <pre>
3652   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3653 </pre>
3654
3655 </div>
3656
3657 <!-- _______________________________________________________________________ -->
3658 <h4>
3659   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3660 </h4>
3661
3662 <div>
3663
3664 <h5>Syntax:</h5>
3665 <pre>
3666   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3667 </pre>
3668
3669 <h5>Overview:</h5>
3670 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3671
3672 <h5>Arguments:</h5>
3673 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3674    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3675    floating point values.  Both arguments must have identical types.</p>
3676
3677 <h5>Semantics:</h5>
3678 <p>The value produced is the floating point product of the two operands.</p>
3679
3680 <h5>Example:</h5>
3681 <pre>
3682   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3683 </pre>
3684
3685 </div>
3686
3687 <!-- _______________________________________________________________________ -->
3688 <h4>
3689   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
3690 </h4>
3691
3692 <div>
3693
3694 <h5>Syntax:</h5>
3695 <pre>
3696   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3697   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3698 </pre>
3699
3700 <h5>Overview:</h5>
3701 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3702
3703 <h5>Arguments:</h5>
3704 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3705    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3706    values.  Both arguments must have identical types.</p>
3707
3708 <h5>Semantics:</h5>
3709 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3710
3711 <p>Note that unsigned integer division and signed integer division are distinct
3712    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3713
3714 <p>Division by zero leads to undefined behavior.</p>
3715
3716 <p>If the <tt>exact</tt> keyword is present, the result value of the
3717    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3718   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3719
3720
3721 <h5>Example:</h5>
3722 <pre>
3723   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3724 </pre>
3725
3726 </div>
3727
3728 <!-- _______________________________________________________________________ -->
3729 <h4>
3730   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
3731 </h4>
3732
3733 <div>
3734
3735 <h5>Syntax:</h5>
3736 <pre>
3737   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3738   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3739 </pre>
3740
3741 <h5>Overview:</h5>
3742 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3743
3744 <h5>Arguments:</h5>
3745 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3746    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3747    values.  Both arguments must have identical types.</p>
3748
3749 <h5>Semantics:</h5>
3750 <p>The value produced is the signed integer quotient of the two operands rounded
3751    towards zero.</p>
3752
3753 <p>Note that signed integer division and unsigned integer division are distinct
3754    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3755
3756 <p>Division by zero leads to undefined behavior. Overflow also leads to
3757    undefined behavior; this is a rare case, but can occur, for example, by doing
3758    a 32-bit division of -2147483648 by -1.</p>
3759
3760 <p>If the <tt>exact</tt> keyword is present, the result value of the
3761    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3762    be rounded.</p>
3763
3764 <h5>Example:</h5>
3765 <pre>
3766   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3767 </pre>
3768
3769 </div>
3770
3771 <!-- _______________________________________________________________________ -->
3772 <h4>
3773   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
3774 </h4>
3775
3776 <div>
3777
3778 <h5>Syntax:</h5>
3779 <pre>
3780   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3781 </pre>
3782
3783 <h5>Overview:</h5>
3784 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3785
3786 <h5>Arguments:</h5>
3787 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3788    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3789    floating point values.  Both arguments must have identical types.</p>
3790
3791 <h5>Semantics:</h5>
3792 <p>The value produced is the floating point quotient of the two operands.</p>
3793
3794 <h5>Example:</h5>
3795 <pre>
3796   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3797 </pre>
3798
3799 </div>
3800
3801 <!-- _______________________________________________________________________ -->
3802 <h4>
3803   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3804 </h4>
3805
3806 <div>
3807
3808 <h5>Syntax:</h5>
3809 <pre>
3810   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3811 </pre>
3812
3813 <h5>Overview:</h5>
3814 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3815    division of its two arguments.</p>
3816
3817 <h5>Arguments:</h5>
3818 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3819    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3820    values.  Both arguments must have identical types.</p>
3821
3822 <h5>Semantics:</h5>
3823 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3824    This instruction always performs an unsigned division to get the
3825    remainder.</p>
3826
3827 <p>Note that unsigned integer remainder and signed integer remainder are
3828    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3829
3830 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3831
3832 <h5>Example:</h5>
3833 <pre>
3834   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3835 </pre>
3836
3837 </div>
3838
3839 <!-- _______________________________________________________________________ -->
3840 <h4>
3841   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3842 </h4>
3843
3844 <div>
3845
3846 <h5>Syntax:</h5>
3847 <pre>
3848   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3849 </pre>
3850
3851 <h5>Overview:</h5>
3852 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3853    division of its two operands. This instruction can also take
3854    <a href="#t_vector">vector</a> versions of the values in which case the
3855    elements must be integers.</p>
3856
3857 <h5>Arguments:</h5>
3858 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3859    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3860    values.  Both arguments must have identical types.</p>
3861
3862 <h5>Semantics:</h5>
3863 <p>This instruction returns the <i>remainder</i> of a division (where the result
3864    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3865    <i>modulo</i> operator (where the result is either zero or has the same sign
3866    as the divisor, <tt>op2</tt>) of a value.
3867    For more information about the difference,
3868    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3869    Math Forum</a>. For a table of how this is implemented in various languages,
3870    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3871    Wikipedia: modulo operation</a>.</p>
3872
3873 <p>Note that signed integer remainder and unsigned integer remainder are
3874    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3875
3876 <p>Taking the remainder of a division by zero leads to undefined behavior.
3877    Overflow also leads to undefined behavior; this is a rare case, but can
3878    occur, for example, by taking the remainder of a 32-bit division of
3879    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3880    lets srem be implemented using instructions that return both the result of
3881    the division and the remainder.)</p>
3882
3883 <h5>Example:</h5>
3884 <pre>
3885   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3886 </pre>
3887
3888 </div>
3889
3890 <!-- _______________________________________________________________________ -->
3891 <h4>
3892   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
3893 </h4>
3894
3895 <div>
3896
3897 <h5>Syntax:</h5>
3898 <pre>
3899   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3900 </pre>
3901
3902 <h5>Overview:</h5>
3903 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3904    its two operands.</p>
3905
3906 <h5>Arguments:</h5>
3907 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3908    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3909    floating point values.  Both arguments must have identical types.</p>
3910
3911 <h5>Semantics:</h5>
3912 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3913    has the same sign as the dividend.</p>
3914
3915 <h5>Example:</h5>
3916 <pre>
3917   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3918 </pre>
3919
3920 </div>
3921
3922 </div>
3923
3924 <!-- ======================================================================= -->
3925 <h3>
3926   <a name="bitwiseops">Bitwise Binary Operations</a>
3927 </h3>
3928
3929 <div>
3930
3931 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3932    program.  They are generally very efficient instructions and can commonly be
3933    strength reduced from other instructions.  They require two operands of the
3934    same type, execute an operation on them, and produce a single value.  The
3935    resulting value is the same type as its operands.</p>
3936
3937 <!-- _______________________________________________________________________ -->
3938 <h4>
3939   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
3940 </h4>
3941
3942 <div>
3943
3944 <h5>Syntax:</h5>
3945 <pre>
3946   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3947   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3948   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3949   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3950 </pre>
3951
3952 <h5>Overview:</h5>
3953 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3954    a specified number of bits.</p>
3955
3956 <h5>Arguments:</h5>
3957 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3958     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3959     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3960
3961 <h5>Semantics:</h5>
3962 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3963    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3964    is (statically or dynamically) negative or equal to or larger than the number
3965    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3966    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3967    shift amount in <tt>op2</tt>.</p>
3968
3969 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3970    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3971    the <tt>nsw</tt> keyword is present, then the shift produces a
3972    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3973    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3974    they would if the shift were expressed as a mul instruction with the same
3975    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3976
3977 <h5>Example:</h5>
3978 <pre>
3979   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3980   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3981   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3982   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3983   &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>
3984 </pre>
3985
3986 </div>
3987
3988 <!-- _______________________________________________________________________ -->
3989 <h4>
3990   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
3991 </h4>
3992
3993 <div>
3994
3995 <h5>Syntax:</h5>
3996 <pre>
3997   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3998   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3999 </pre>
4000
4001 <h5>Overview:</h5>
4002 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4003    operand shifted to the right a specified number of bits with zero fill.</p>
4004
4005 <h5>Arguments:</h5>
4006 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4007    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4008    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4009
4010 <h5>Semantics:</h5>
4011 <p>This instruction always performs a logical shift right operation. The most
4012    significant bits of the result will be filled with zero bits after the shift.
4013    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4014    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4015    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4016    shift amount in <tt>op2</tt>.</p>
4017
4018 <p>If the <tt>exact</tt> keyword is present, the result value of the
4019    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4020    shifted out are non-zero.</p>
4021
4022
4023 <h5>Example:</h5>
4024 <pre>
4025   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4026   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4027   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4028   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4029   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4030   &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>
4031 </pre>
4032
4033 </div>
4034
4035 <!-- _______________________________________________________________________ -->
4036 <h4>
4037   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4038 </h4>
4039
4040 <div>
4041
4042 <h5>Syntax:</h5>
4043 <pre>
4044   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4045   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4046 </pre>
4047
4048 <h5>Overview:</h5>
4049 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4050    operand shifted to the right a specified number of bits with sign
4051    extension.</p>
4052
4053 <h5>Arguments:</h5>
4054 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4055    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4056    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4057
4058 <h5>Semantics:</h5>
4059 <p>This instruction always performs an arithmetic shift right operation, The
4060    most significant bits of the result will be filled with the sign bit
4061    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4062    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4063    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4064    the corresponding shift amount in <tt>op2</tt>.</p>
4065
4066 <p>If the <tt>exact</tt> keyword is present, the result value of the
4067    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4068    shifted out are non-zero.</p>
4069
4070 <h5>Example:</h5>
4071 <pre>
4072   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4073   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4074   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4075   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4076   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4077   &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>
4078 </pre>
4079
4080 </div>
4081
4082 <!-- _______________________________________________________________________ -->
4083 <h4>
4084   <a name="i_and">'<tt>and</tt>' Instruction</a>
4085 </h4>
4086
4087 <div>
4088
4089 <h5>Syntax:</h5>
4090 <pre>
4091   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4092 </pre>
4093
4094 <h5>Overview:</h5>
4095 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4096    operands.</p>
4097
4098 <h5>Arguments:</h5>
4099 <p>The two arguments to the '<tt>and</tt>' instruction must be
4100    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4101    values.  Both arguments must have identical types.</p>
4102
4103 <h5>Semantics:</h5>
4104 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4105
4106 <table border="1" cellspacing="0" cellpadding="4">
4107   <tbody>
4108     <tr>
4109       <td>In0</td>
4110       <td>In1</td>
4111       <td>Out</td>
4112     </tr>
4113     <tr>
4114       <td>0</td>
4115       <td>0</td>
4116       <td>0</td>
4117     </tr>
4118     <tr>
4119       <td>0</td>
4120       <td>1</td>
4121       <td>0</td>
4122     </tr>
4123     <tr>
4124       <td>1</td>
4125       <td>0</td>
4126       <td>0</td>
4127     </tr>
4128     <tr>
4129       <td>1</td>
4130       <td>1</td>
4131       <td>1</td>
4132     </tr>
4133   </tbody>
4134 </table>
4135
4136 <h5>Example:</h5>
4137 <pre>
4138   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4139   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4140   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4141 </pre>
4142 </div>
4143 <!-- _______________________________________________________________________ -->
4144 <h4>
4145   <a name="i_or">'<tt>or</tt>' Instruction</a>
4146 </h4>
4147
4148 <div>
4149
4150 <h5>Syntax:</h5>
4151 <pre>
4152   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4153 </pre>
4154
4155 <h5>Overview:</h5>
4156 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4157    two operands.</p>
4158
4159 <h5>Arguments:</h5>
4160 <p>The two arguments to the '<tt>or</tt>' instruction must be
4161    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4162    values.  Both arguments must have identical types.</p>
4163
4164 <h5>Semantics:</h5>
4165 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4166
4167 <table border="1" cellspacing="0" cellpadding="4">
4168   <tbody>
4169     <tr>
4170       <td>In0</td>
4171       <td>In1</td>
4172       <td>Out</td>
4173     </tr>
4174     <tr>
4175       <td>0</td>
4176       <td>0</td>
4177       <td>0</td>
4178     </tr>
4179     <tr>
4180       <td>0</td>
4181       <td>1</td>
4182       <td>1</td>
4183     </tr>
4184     <tr>
4185       <td>1</td>
4186       <td>0</td>
4187       <td>1</td>
4188     </tr>
4189     <tr>
4190       <td>1</td>
4191       <td>1</td>
4192       <td>1</td>
4193     </tr>
4194   </tbody>
4195 </table>
4196
4197 <h5>Example:</h5>
4198 <pre>
4199   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4200   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4201   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4202 </pre>
4203
4204 </div>
4205
4206 <!-- _______________________________________________________________________ -->
4207 <h4>
4208   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4209 </h4>
4210
4211 <div>
4212
4213 <h5>Syntax:</h5>
4214 <pre>
4215   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4216 </pre>
4217
4218 <h5>Overview:</h5>
4219 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4220    its two operands.  The <tt>xor</tt> is used to implement the "one's
4221    complement" operation, which is the "~" operator in C.</p>
4222
4223 <h5>Arguments:</h5>
4224 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4225    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4226    values.  Both arguments must have identical types.</p>
4227
4228 <h5>Semantics:</h5>
4229 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4230
4231 <table border="1" cellspacing="0" cellpadding="4">
4232   <tbody>
4233     <tr>
4234       <td>In0</td>
4235       <td>In1</td>
4236       <td>Out</td>
4237     </tr>
4238     <tr>
4239       <td>0</td>
4240       <td>0</td>
4241       <td>0</td>
4242     </tr>
4243     <tr>
4244       <td>0</td>
4245       <td>1</td>
4246       <td>1</td>
4247     </tr>
4248     <tr>
4249       <td>1</td>
4250       <td>0</td>
4251       <td>1</td>
4252     </tr>
4253     <tr>
4254       <td>1</td>
4255       <td>1</td>
4256       <td>0</td>
4257     </tr>
4258   </tbody>
4259 </table>
4260
4261 <h5>Example:</h5>
4262 <pre>
4263   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4264   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4265   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4266   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4267 </pre>
4268
4269 </div>
4270
4271 </div>
4272
4273 <!-- ======================================================================= -->
4274 <h3>
4275   <a name="vectorops">Vector Operations</a>
4276 </h3>
4277
4278 <div>
4279
4280 <p>LLVM supports several instructions to represent vector operations in a
4281    target-independent manner.  These instructions cover the element-access and
4282    vector-specific operations needed to process vectors effectively.  While LLVM
4283    does directly support these vector operations, many sophisticated algorithms
4284    will want to use target-specific intrinsics to take full advantage of a
4285    specific target.</p>
4286
4287 <!-- _______________________________________________________________________ -->
4288 <h4>
4289    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4290 </h4>
4291
4292 <div>
4293
4294 <h5>Syntax:</h5>
4295 <pre>
4296   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4297 </pre>
4298
4299 <h5>Overview:</h5>
4300 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4301    from a vector at a specified index.</p>
4302
4303
4304 <h5>Arguments:</h5>
4305 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4306    of <a href="#t_vector">vector</a> type.  The second operand is an index
4307    indicating the position from which to extract the element.  The index may be
4308    a variable.</p>
4309
4310 <h5>Semantics:</h5>
4311 <p>The result is a scalar of the same type as the element type of
4312    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4313    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4314    results are undefined.</p>
4315
4316 <h5>Example:</h5>
4317 <pre>
4318   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4319 </pre>
4320
4321 </div>
4322
4323 <!-- _______________________________________________________________________ -->
4324 <h4>
4325    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4326 </h4>
4327
4328 <div>
4329
4330 <h5>Syntax:</h5>
4331 <pre>
4332   &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>
4333 </pre>
4334
4335 <h5>Overview:</h5>
4336 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4337    vector at a specified index.</p>
4338
4339 <h5>Arguments:</h5>
4340 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4341    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4342    whose type must equal the element type of the first operand.  The third
4343    operand is an index indicating the position at which to insert the value.
4344    The index may be a variable.</p>
4345
4346 <h5>Semantics:</h5>
4347 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4348    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4349    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4350    results are undefined.</p>
4351
4352 <h5>Example:</h5>
4353 <pre>
4354   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4355 </pre>
4356
4357 </div>
4358
4359 <!-- _______________________________________________________________________ -->
4360 <h4>
4361    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4362 </h4>
4363
4364 <div>
4365
4366 <h5>Syntax:</h5>
4367 <pre>
4368   &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>
4369 </pre>
4370
4371 <h5>Overview:</h5>
4372 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4373    from two input vectors, returning a vector with the same element type as the
4374    input and length that is the same as the shuffle mask.</p>
4375
4376 <h5>Arguments:</h5>
4377 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4378    with types that match each other. The third argument is a shuffle mask whose
4379    element type is always 'i32'.  The result of the instruction is a vector
4380    whose length is the same as the shuffle mask and whose element type is the
4381    same as the element type of the first two operands.</p>
4382
4383 <p>The shuffle mask operand is required to be a constant vector with either
4384    constant integer or undef values.</p>
4385
4386 <h5>Semantics:</h5>
4387 <p>The elements of the two input vectors are numbered from left to right across
4388    both of the vectors.  The shuffle mask operand specifies, for each element of
4389    the result vector, which element of the two input vectors the result element
4390    gets.  The element selector may be undef (meaning "don't care") and the
4391    second operand may be undef if performing a shuffle from only one vector.</p>
4392
4393 <h5>Example:</h5>
4394 <pre>
4395   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4396                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4397   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4398                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i> - Identity shuffle.
4399   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4400                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4401   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4402                           &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>
4403 </pre>
4404
4405 </div>
4406
4407 </div>
4408
4409 <!-- ======================================================================= -->
4410 <h3>
4411   <a name="aggregateops">Aggregate Operations</a>
4412 </h3>
4413
4414 <div>
4415
4416 <p>LLVM supports several instructions for working with
4417   <a href="#t_aggregate">aggregate</a> values.</p>
4418
4419 <!-- _______________________________________________________________________ -->
4420 <h4>
4421    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4422 </h4>
4423
4424 <div>
4425
4426 <h5>Syntax:</h5>
4427 <pre>
4428   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4429 </pre>
4430
4431 <h5>Overview:</h5>
4432 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4433    from an <a href="#t_aggregate">aggregate</a> value.</p>
4434
4435 <h5>Arguments:</h5>
4436 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4437    of <a href="#t_struct">struct</a> or
4438    <a href="#t_array">array</a> type.  The operands are constant indices to
4439    specify which value to extract in a similar manner as indices in a
4440    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4441    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4442      <ul>
4443        <li>Since the value being indexed is not a pointer, the first index is
4444            omitted and assumed to be zero.</li>
4445        <li>At least one index must be specified.</li>
4446        <li>Not only struct indices but also array indices must be in
4447            bounds.</li>
4448      </ul>
4449
4450 <h5>Semantics:</h5>
4451 <p>The result is the value at the position in the aggregate specified by the
4452    index operands.</p>
4453
4454 <h5>Example:</h5>
4455 <pre>
4456   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4457 </pre>
4458
4459 </div>
4460
4461 <!-- _______________________________________________________________________ -->
4462 <h4>
4463    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4464 </h4>
4465
4466 <div>
4467
4468 <h5>Syntax:</h5>
4469 <pre>
4470   &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>
4471 </pre>
4472
4473 <h5>Overview:</h5>
4474 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4475    in an <a href="#t_aggregate">aggregate</a> value.</p>
4476
4477 <h5>Arguments:</h5>
4478 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4479    of <a href="#t_struct">struct</a> or
4480    <a href="#t_array">array</a> type.  The second operand is a first-class
4481    value to insert.  The following operands are constant indices indicating
4482    the position at which to insert the value in a similar manner as indices in a
4483    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4484    value to insert must have the same type as the value identified by the
4485    indices.</p>
4486
4487 <h5>Semantics:</h5>
4488 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4489    that of <tt>val</tt> except that the value at the position specified by the
4490    indices is that of <tt>elt</tt>.</p>
4491
4492 <h5>Example:</h5>
4493 <pre>
4494   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4495   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4496   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4497 </pre>
4498
4499 </div>
4500
4501 </div>
4502
4503 <!-- ======================================================================= -->
4504 <h3>
4505   <a name="memoryops">Memory Access and Addressing Operations</a>
4506 </h3>
4507
4508 <div>
4509
4510 <p>A key design point of an SSA-based representation is how it represents
4511    memory.  In LLVM, no memory locations are in SSA form, which makes things
4512    very simple.  This section describes how to read, write, and allocate
4513    memory in LLVM.</p>
4514
4515 <!-- _______________________________________________________________________ -->
4516 <h4>
4517   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4518 </h4>
4519
4520 <div>
4521
4522 <h5>Syntax:</h5>
4523 <pre>
4524   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4525 </pre>
4526
4527 <h5>Overview:</h5>
4528 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4529    currently executing function, to be automatically released when this function
4530    returns to its caller. The object is always allocated in the generic address
4531    space (address space zero).</p>
4532
4533 <h5>Arguments:</h5>
4534 <p>The '<tt>alloca</tt>' instruction
4535    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4536    runtime stack, returning a pointer of the appropriate type to the program.
4537    If "NumElements" is specified, it is the number of elements allocated,
4538    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4539    specified, the value result of the allocation is guaranteed to be aligned to
4540    at least that boundary.  If not specified, or if zero, the target can choose
4541    to align the allocation on any convenient boundary compatible with the
4542    type.</p>
4543
4544 <p>'<tt>type</tt>' may be any sized type.</p>
4545
4546 <h5>Semantics:</h5>
4547 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4548    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4549    memory is automatically released when the function returns.  The
4550    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4551    variables that must have an address available.  When the function returns
4552    (either with the <tt><a href="#i_ret">ret</a></tt>
4553    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4554    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4555
4556 <h5>Example:</h5>
4557 <pre>
4558   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4559   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4560   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4561   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4562 </pre>
4563
4564 </div>
4565
4566 <!-- _______________________________________________________________________ -->
4567 <h4>
4568   <a name="i_load">'<tt>load</tt>' Instruction</a>
4569 </h4>
4570
4571 <div>
4572
4573 <h5>Syntax:</h5>
4574 <pre>
4575   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4576   &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4577   !&lt;index&gt; = !{ i32 1 }
4578 </pre>
4579
4580 <h5>Overview:</h5>
4581 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4582
4583 <h5>Arguments:</h5>
4584 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4585    from which to load.  The pointer must point to
4586    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4587    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4588    number or order of execution of this <tt>load</tt> with other <a
4589    href="#volatile">volatile operations</a>.</p>
4590
4591 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4592    operation (that is, the alignment of the memory address). A value of 0 or an
4593    omitted <tt>align</tt> argument means that the operation has the preferential
4594    alignment for the target. It is the responsibility of the code emitter to
4595    ensure that the alignment information is correct. Overestimating the
4596    alignment results in undefined behavior. Underestimating the alignment may
4597    produce less efficient code. An alignment of 1 is always safe.</p>
4598
4599 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4600    metatadata name &lt;index&gt; corresponding to a metadata node with
4601    one <tt>i32</tt> entry of value 1.  The existence of
4602    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4603    and code generator that this load is not expected to be reused in the cache.
4604    The code generator may select special instructions to save cache bandwidth,
4605    such as the <tt>MOVNT</tt> instruction on x86.</p>
4606
4607 <h5>Semantics:</h5>
4608 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4609    scalar type then the number of bytes read does not exceed the minimum number
4610    of bytes needed to hold all bits of the type.  For example, loading an
4611    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4612    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4613    is undefined if the value was not originally written using a store of the
4614    same type.</p>
4615
4616 <h5>Examples:</h5>
4617 <pre>
4618   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4619   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4620   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4621 </pre>
4622
4623 </div>
4624
4625 <!-- _______________________________________________________________________ -->
4626 <h4>
4627   <a name="i_store">'<tt>store</tt>' Instruction</a>
4628 </h4>
4629
4630 <div>
4631
4632 <h5>Syntax:</h5>
4633 <pre>
4634   store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]                   <i>; yields {void}</i>
4635   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]          <i>; yields {void}</i>
4636 </pre>
4637
4638 <h5>Overview:</h5>
4639 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4640
4641 <h5>Arguments:</h5>
4642 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4643    and an address at which to store it.  The type of the
4644    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4645    the <a href="#t_firstclass">first class</a> type of the
4646    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4647    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4648    order of execution of this <tt>store</tt> with other <a
4649    href="#volatile">volatile operations</a>.</p>
4650
4651 <p>The optional constant "align" argument specifies the alignment of the
4652    operation (that is, the alignment of the memory address). A value of 0 or an
4653    omitted "align" argument means that the operation has the preferential
4654    alignment for the target. It is the responsibility of the code emitter to
4655    ensure that the alignment information is correct. Overestimating the
4656    alignment results in an undefined behavior. Underestimating the alignment may
4657    produce less efficient code. An alignment of 1 is always safe.</p>
4658
4659 <p>The optional !nontemporal metadata must reference a single metatadata
4660    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4661    value 1.  The existence of the !nontemporal metatadata on the
4662    instruction tells the optimizer and code generator that this load is
4663    not expected to be reused in the cache.  The code generator may
4664    select special instructions to save cache bandwidth, such as the
4665    MOVNT instruction on x86.</p>
4666
4667
4668 <h5>Semantics:</h5>
4669 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4670    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4671    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4672    does not exceed the minimum number of bytes needed to hold all bits of the
4673    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4674    writing a value of a type like <tt>i20</tt> with a size that is not an
4675    integral number of bytes, it is unspecified what happens to the extra bits
4676    that do not belong to the type, but they will typically be overwritten.</p>
4677
4678 <h5>Example:</h5>
4679 <pre>
4680   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4681   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4682   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4683 </pre>
4684
4685 </div>
4686
4687 <!-- _______________________________________________________________________ -->
4688 <div class="doc_subsubsection"> <a name="i_fence">'<tt>fence</tt>'
4689 Instruction</a> </div>
4690
4691 <div class="doc_text">
4692
4693 <h5>Syntax:</h5>
4694 <pre>
4695   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
4696 </pre>
4697
4698 <h5>Overview:</h5>
4699 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
4700 between operations.</p>
4701
4702 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
4703 href="#ordering">ordering</a> argument which defines what
4704 <i>synchronizes-with</i> edges they add.  They can only be given
4705 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
4706 <code>seq_cst</code> orderings.</p>
4707
4708 <h5>Semantics:</h5>
4709 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
4710 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
4711 <code>acquire</code> ordering semantics if and only if there exist atomic
4712 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
4713 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
4714 <var>X</var> modifies <var>M</var> (either directly or through some side effect
4715 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
4716 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
4717 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
4718 than an explicit <code>fence</code>, one (but not both) of the atomic operations
4719 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
4720 <code>acquire</code> (resp.) ordering constraint and still
4721 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
4722 <i>happens-before</i> edge.</p>
4723
4724 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
4725 having both <code>acquire</code> and <code>release</code> semantics specified
4726 above, participates in the global program order of other <code>seq_cst</code>
4727 operations and/or fences.</p>
4728
4729 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
4730 specifies that the fence only synchronizes with other fences in the same
4731 thread.  (This is useful for interacting with signal handlers.)</p>
4732
4733 <p>FIXME: This instruction is a work in progress; until it is finished, use
4734    llvm.memory.barrier.
4735
4736 <h5>Example:</h5>
4737 <pre>
4738   fence acquire                          <i>; yields {void}</i>
4739   fence singlethread seq_cst             <i>; yields {void}</i>
4740 </pre>
4741
4742 </div>
4743
4744 <!-- _______________________________________________________________________ -->
4745 <div class="doc_subsubsection"> <a name="i_cmpxchg">'<tt>cmpxchg</tt>'
4746 Instruction</a> </div>
4747
4748 <div class="doc_text">
4749
4750 <h5>Syntax:</h5>
4751 <pre>
4752   [volatile] cmpxchg &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;cmp&gt;, &lt;ty&gt; &lt;new&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4753 </pre>
4754
4755 <h5>Overview:</h5>
4756 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
4757 It loads a value in memory and compares it to a given value. If they are
4758 equal, it stores a new value into the memory.</p>
4759
4760 <h5>Arguments:</h5>
4761 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
4762 address to operate on, a value to compare to the value currently be at that
4763 address, and a new value to place at that address if the compared values are
4764 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
4765 bit width is a power of two greater than or equal to eight and less than
4766 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
4767 '<var>&lt;new&gt;</var>' must have the same type, and the type of
4768 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
4769 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
4770 optimizer is not allowed to modify the number or order of execution
4771 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
4772 operations</a>.</p>
4773
4774 <!-- FIXME: Extend allowed types. -->
4775
4776 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
4777 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
4778
4779 <p>The optional "<code>singlethread</code>" argument declares that the
4780 <code>cmpxchg</code> is only atomic with respect to code (usually signal
4781 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
4782 cmpxchg is atomic with respect to all other code in the system.</p>
4783
4784 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
4785 the size in memory of the operand.
4786
4787 <h5>Semantics:</h5>
4788 <p>The contents of memory at the location specified by the
4789 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
4790 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
4791 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
4792 is returned.
4793
4794 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
4795 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
4796 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
4797 parameter determined by dropping any <code>release</code> part of the
4798 <code>cmpxchg</code>'s ordering.</p>
4799
4800 <!--
4801 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
4802 optimization work on ARM.)
4803
4804 FIXME: Is a weaker ordering constraint on failure helpful in practice?
4805 -->
4806
4807 <h5>Example:</h5>
4808 <pre>
4809 entry:
4810   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                       <i>; yields {i32}</i>
4811   <a href="#i_br">br</a> label %loop
4812
4813 loop:
4814   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
4815   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
4816   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared                       <i>; yields {i32}</i>
4817   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
4818   <a href="#i_br">br</a> i1 %success, label %done, label %loop
4819
4820 done:
4821   ...
4822 </pre>
4823
4824 </div>
4825
4826 <!-- _______________________________________________________________________ -->
4827 <div class="doc_subsubsection"> <a name="i_atomicrmw">'<tt>atomicrmw</tt>'
4828 Instruction</a> </div>
4829
4830 <div class="doc_text">
4831
4832 <h5>Syntax:</h5>
4833 <pre>
4834   [volatile] atomicrmw &lt;operation&gt; &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;value&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4835 </pre>
4836
4837 <h5>Overview:</h5>
4838 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
4839
4840 <h5>Arguments:</h5>
4841 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
4842 operation to apply, an address whose value to modify, an argument to the
4843 operation.  The operation must be one of the following keywords:</p>
4844 <ul>
4845   <li>xchg</li>
4846   <li>add</li>
4847   <li>sub</li>
4848   <li>and</li>
4849   <li>nand</li>
4850   <li>or</li>
4851   <li>xor</li>
4852   <li>max</li>
4853   <li>min</li>
4854   <li>umax</li>
4855   <li>umin</li>
4856 </ul>
4857
4858 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
4859 bit width is a power of two greater than or equal to eight and less than
4860 or equal to a target-specific size limit.  The type of the
4861 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
4862 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
4863 optimizer is not allowed to modify the number or order of execution of this
4864 <code>atomicrmw</code> with other <a href="#volatile">volatile
4865   operations</a>.</p>
4866
4867 <!-- FIXME: Extend allowed types. -->
4868
4869 <h5>Semantics:</h5>
4870 <p>The contents of memory at the location specified by the
4871 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
4872 back.  The original value at the location is returned.  The modification is
4873 specified by the <var>operation</var> argument:</p>
4874
4875 <ul>
4876   <li>xchg: <code>*ptr = val</code></li>
4877   <li>add: <code>*ptr = *ptr + val</code></li>
4878   <li>sub: <code>*ptr = *ptr - val</code></li>
4879   <li>and: <code>*ptr = *ptr &amp; val</code></li>
4880   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
4881   <li>or: <code>*ptr = *ptr | val</code></li>
4882   <li>xor: <code>*ptr = *ptr ^ val</code></li>
4883   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
4884   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
4885   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4886   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
4887 </ul>
4888
4889 <h5>Example:</h5>
4890 <pre>
4891   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
4892 </pre>
4893
4894 </div>
4895
4896 <!-- _______________________________________________________________________ -->
4897 <h4>
4898    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4899 </h4>
4900
4901 <div>
4902
4903 <h5>Syntax:</h5>
4904 <pre>
4905   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4906   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4907 </pre>
4908
4909 <h5>Overview:</h5>
4910 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4911    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4912    It performs address calculation only and does not access memory.</p>
4913
4914 <h5>Arguments:</h5>
4915 <p>The first argument is always a pointer, and forms the basis of the
4916    calculation. The remaining arguments are indices that indicate which of the
4917    elements of the aggregate object are indexed. The interpretation of each
4918    index is dependent on the type being indexed into. The first index always
4919    indexes the pointer value given as the first argument, the second index
4920    indexes a value of the type pointed to (not necessarily the value directly
4921    pointed to, since the first index can be non-zero), etc. The first type
4922    indexed into must be a pointer value, subsequent types can be arrays,
4923    vectors, and structs. Note that subsequent types being indexed into
4924    can never be pointers, since that would require loading the pointer before
4925    continuing calculation.</p>
4926
4927 <p>The type of each index argument depends on the type it is indexing into.
4928    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4929    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4930    or vector, integers of any width are allowed, and they are not required to be
4931    constant.</p>
4932
4933 <p>For example, let's consider a C code fragment and how it gets compiled to
4934    LLVM:</p>
4935
4936 <pre class="doc_code">
4937 struct RT {
4938   char A;
4939   int B[10][20];
4940   char C;
4941 };
4942 struct ST {
4943   int X;
4944   double Y;
4945   struct RT Z;
4946 };
4947
4948 int *foo(struct ST *s) {
4949   return &amp;s[1].Z.B[5][13];
4950 }
4951 </pre>
4952
4953 <p>The LLVM code generated by the GCC frontend is:</p>
4954
4955 <pre class="doc_code">
4956 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4957 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4958
4959 define i32* @foo(%ST* %s) {
4960 entry:
4961   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4962   ret i32* %reg
4963 }
4964 </pre>
4965
4966 <h5>Semantics:</h5>
4967 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4968    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4969    }</tt>' type, a structure.  The second index indexes into the third element
4970    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4971    i8 }</tt>' type, another structure.  The third index indexes into the second
4972    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4973    array.  The two dimensions of the array are subscripted into, yielding an
4974    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4975    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4976
4977 <p>Note that it is perfectly legal to index partially through a structure,
4978    returning a pointer to an inner element.  Because of this, the LLVM code for
4979    the given testcase is equivalent to:</p>
4980
4981 <pre>
4982   define i32* @foo(%ST* %s) {
4983     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
4984     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
4985     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
4986     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
4987     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
4988     ret i32* %t5
4989   }
4990 </pre>
4991
4992 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
4993    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
4994    base pointer is not an <i>in bounds</i> address of an allocated object,
4995    or if any of the addresses that would be formed by successive addition of
4996    the offsets implied by the indices to the base address with infinitely
4997    precise arithmetic are not an <i>in bounds</i> address of that allocated
4998    object. The <i>in bounds</i> addresses for an allocated object are all
4999    the addresses that point into the object, plus the address one byte past
5000    the end.</p>
5001
5002 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5003    the base address with silently-wrapping two's complement arithmetic, and
5004    the result value of the <tt>getelementptr</tt> may be outside the object
5005    pointed to by the base pointer. The result value may not necessarily be
5006    used to access memory though, even if it happens to point into allocated
5007    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
5008    section for more information.</p>
5009
5010 <p>The getelementptr instruction is often confusing.  For some more insight into
5011    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5012
5013 <h5>Example:</h5>
5014 <pre>
5015     <i>; yields [12 x i8]*:aptr</i>
5016     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5017     <i>; yields i8*:vptr</i>
5018     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5019     <i>; yields i8*:eptr</i>
5020     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5021     <i>; yields i32*:iptr</i>
5022     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5023 </pre>
5024
5025 </div>
5026
5027 </div>
5028
5029 <!-- ======================================================================= -->
5030 <h3>
5031   <a name="convertops">Conversion Operations</a>
5032 </h3>
5033
5034 <div>
5035
5036 <p>The instructions in this category are the conversion instructions (casting)
5037    which all take a single operand and a type. They perform various bit
5038    conversions on the operand.</p>
5039
5040 <!-- _______________________________________________________________________ -->
5041 <h4>
5042    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5043 </h4>
5044
5045 <div>
5046
5047 <h5>Syntax:</h5>
5048 <pre>
5049   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5050 </pre>
5051
5052 <h5>Overview:</h5>
5053 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5054    type <tt>ty2</tt>.</p>
5055
5056 <h5>Arguments:</h5>
5057 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5058    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5059    of the same number of integers.
5060    The bit size of the <tt>value</tt> must be larger than
5061    the bit size of the destination type, <tt>ty2</tt>.
5062    Equal sized types are not allowed.</p>
5063
5064 <h5>Semantics:</h5>
5065 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5066    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5067    source size must be larger than the destination size, <tt>trunc</tt> cannot
5068    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5069
5070 <h5>Example:</h5>
5071 <pre>
5072   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5073   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5074   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5075   %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>
5076 </pre>
5077
5078 </div>
5079
5080 <!-- _______________________________________________________________________ -->
5081 <h4>
5082    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5083 </h4>
5084
5085 <div>
5086
5087 <h5>Syntax:</h5>
5088 <pre>
5089   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5090 </pre>
5091
5092 <h5>Overview:</h5>
5093 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5094    <tt>ty2</tt>.</p>
5095
5096
5097 <h5>Arguments:</h5>
5098 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5099    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5100    of the same number of integers.
5101    The bit size of the <tt>value</tt> must be smaller than
5102    the bit size of the destination type,
5103    <tt>ty2</tt>.</p>
5104
5105 <h5>Semantics:</h5>
5106 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5107    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5108
5109 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5110
5111 <h5>Example:</h5>
5112 <pre>
5113   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5114   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5115   %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>
5116 </pre>
5117
5118 </div>
5119
5120 <!-- _______________________________________________________________________ -->
5121 <h4>
5122    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5123 </h4>
5124
5125 <div>
5126
5127 <h5>Syntax:</h5>
5128 <pre>
5129   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5130 </pre>
5131
5132 <h5>Overview:</h5>
5133 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5134
5135 <h5>Arguments:</h5>
5136 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5137    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5138    of the same number of integers.
5139    The bit size of the <tt>value</tt> must be smaller than
5140    the bit size of the destination type,
5141    <tt>ty2</tt>.</p>
5142
5143 <h5>Semantics:</h5>
5144 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5145    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5146    of the type <tt>ty2</tt>.</p>
5147
5148 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5149
5150 <h5>Example:</h5>
5151 <pre>
5152   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5153   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5154   %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>
5155 </pre>
5156
5157 </div>
5158
5159 <!-- _______________________________________________________________________ -->
5160 <h4>
5161    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5162 </h4>
5163
5164 <div>
5165
5166 <h5>Syntax:</h5>
5167 <pre>
5168   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5169 </pre>
5170
5171 <h5>Overview:</h5>
5172 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5173    <tt>ty2</tt>.</p>
5174
5175 <h5>Arguments:</h5>
5176 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5177    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5178    to cast it to. The size of <tt>value</tt> must be larger than the size of
5179    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5180    <i>no-op cast</i>.</p>
5181
5182 <h5>Semantics:</h5>
5183 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5184    <a href="#t_floating">floating point</a> type to a smaller
5185    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5186    within the destination type, <tt>ty2</tt>, then the results are
5187    undefined.</p>
5188
5189 <h5>Example:</h5>
5190 <pre>
5191   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5192   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5193 </pre>
5194
5195 </div>
5196
5197 <!-- _______________________________________________________________________ -->
5198 <h4>
5199    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5200 </h4>
5201
5202 <div>
5203
5204 <h5>Syntax:</h5>
5205 <pre>
5206   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5207 </pre>
5208
5209 <h5>Overview:</h5>
5210 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5211    floating point value.</p>
5212
5213 <h5>Arguments:</h5>
5214 <p>The '<tt>fpext</tt>' instruction takes a
5215    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5216    a <a href="#t_floating">floating point</a> type to cast it to. The source
5217    type must be smaller than the destination type.</p>
5218
5219 <h5>Semantics:</h5>
5220 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5221    <a href="#t_floating">floating point</a> type to a larger
5222    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5223    used to make a <i>no-op cast</i> because it always changes bits. Use
5224    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5225
5226 <h5>Example:</h5>
5227 <pre>
5228   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5229   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5230 </pre>
5231
5232 </div>
5233
5234 <!-- _______________________________________________________________________ -->
5235 <h4>
5236    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5237 </h4>
5238
5239 <div>
5240
5241 <h5>Syntax:</h5>
5242 <pre>
5243   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5244 </pre>
5245
5246 <h5>Overview:</h5>
5247 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5248    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5249
5250 <h5>Arguments:</h5>
5251 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5252    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5253    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5254    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5255    vector integer type with the same number of elements as <tt>ty</tt></p>
5256
5257 <h5>Semantics:</h5>
5258 <p>The '<tt>fptoui</tt>' instruction converts its
5259    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5260    towards zero) unsigned integer value. If the value cannot fit
5261    in <tt>ty2</tt>, the results are undefined.</p>
5262
5263 <h5>Example:</h5>
5264 <pre>
5265   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5266   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5267   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5268 </pre>
5269
5270 </div>
5271
5272 <!-- _______________________________________________________________________ -->
5273 <h4>
5274    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5275 </h4>
5276
5277 <div>
5278
5279 <h5>Syntax:</h5>
5280 <pre>
5281   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5282 </pre>
5283
5284 <h5>Overview:</h5>
5285 <p>The '<tt>fptosi</tt>' instruction converts
5286    <a href="#t_floating">floating point</a> <tt>value</tt> to
5287    type <tt>ty2</tt>.</p>
5288
5289 <h5>Arguments:</h5>
5290 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5291    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5292    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5293    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5294    vector integer type with the same number of elements as <tt>ty</tt></p>
5295
5296 <h5>Semantics:</h5>
5297 <p>The '<tt>fptosi</tt>' instruction converts its
5298    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5299    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5300    the results are undefined.</p>
5301
5302 <h5>Example:</h5>
5303 <pre>
5304   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5305   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5306   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5307 </pre>
5308
5309 </div>
5310
5311 <!-- _______________________________________________________________________ -->
5312 <h4>
5313    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5314 </h4>
5315
5316 <div>
5317
5318 <h5>Syntax:</h5>
5319 <pre>
5320   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5321 </pre>
5322
5323 <h5>Overview:</h5>
5324 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5325    integer and converts that value to the <tt>ty2</tt> type.</p>
5326
5327 <h5>Arguments:</h5>
5328 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5329    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5330    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5331    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5332    floating point type with the same number of elements as <tt>ty</tt></p>
5333
5334 <h5>Semantics:</h5>
5335 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5336    integer quantity and converts it to the corresponding floating point
5337    value. If the value cannot fit in the floating point value, the results are
5338    undefined.</p>
5339
5340 <h5>Example:</h5>
5341 <pre>
5342   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5343   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5344 </pre>
5345
5346 </div>
5347
5348 <!-- _______________________________________________________________________ -->
5349 <h4>
5350    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5351 </h4>
5352
5353 <div>
5354
5355 <h5>Syntax:</h5>
5356 <pre>
5357   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5358 </pre>
5359
5360 <h5>Overview:</h5>
5361 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5362    and converts that value to the <tt>ty2</tt> type.</p>
5363
5364 <h5>Arguments:</h5>
5365 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5366    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5367    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5368    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5369    floating point type with the same number of elements as <tt>ty</tt></p>
5370
5371 <h5>Semantics:</h5>
5372 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5373    quantity and converts it to the corresponding floating point value. If the
5374    value cannot fit in the floating point value, the results are undefined.</p>
5375
5376 <h5>Example:</h5>
5377 <pre>
5378   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5379   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5380 </pre>
5381
5382 </div>
5383
5384 <!-- _______________________________________________________________________ -->
5385 <h4>
5386    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5387 </h4>
5388
5389 <div>
5390
5391 <h5>Syntax:</h5>
5392 <pre>
5393   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5394 </pre>
5395
5396 <h5>Overview:</h5>
5397 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
5398    the integer type <tt>ty2</tt>.</p>
5399
5400 <h5>Arguments:</h5>
5401 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5402    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
5403    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
5404
5405 <h5>Semantics:</h5>
5406 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5407    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5408    truncating or zero extending that value to the size of the integer type. If
5409    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5410    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5411    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5412    change.</p>
5413
5414 <h5>Example:</h5>
5415 <pre>
5416   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
5417   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
5418 </pre>
5419
5420 </div>
5421
5422 <!-- _______________________________________________________________________ -->
5423 <h4>
5424    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5425 </h4>
5426
5427 <div>
5428
5429 <h5>Syntax:</h5>
5430 <pre>
5431   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5432 </pre>
5433
5434 <h5>Overview:</h5>
5435 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5436    pointer type, <tt>ty2</tt>.</p>
5437
5438 <h5>Arguments:</h5>
5439 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5440    value to cast, and a type to cast it to, which must be a
5441    <a href="#t_pointer">pointer</a> type.</p>
5442
5443 <h5>Semantics:</h5>
5444 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5445    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5446    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5447    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5448    than the size of a pointer then a zero extension is done. If they are the
5449    same size, nothing is done (<i>no-op cast</i>).</p>
5450
5451 <h5>Example:</h5>
5452 <pre>
5453   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5454   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5455   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5456 </pre>
5457
5458 </div>
5459
5460 <!-- _______________________________________________________________________ -->
5461 <h4>
5462    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5463 </h4>
5464
5465 <div>
5466
5467 <h5>Syntax:</h5>
5468 <pre>
5469   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5470 </pre>
5471
5472 <h5>Overview:</h5>
5473 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5474    <tt>ty2</tt> without changing any bits.</p>
5475
5476 <h5>Arguments:</h5>
5477 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5478    non-aggregate first class value, and a type to cast it to, which must also be
5479    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5480    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5481    identical. If the source type is a pointer, the destination type must also be
5482    a pointer.  This instruction supports bitwise conversion of vectors to
5483    integers and to vectors of other types (as long as they have the same
5484    size).</p>
5485
5486 <h5>Semantics:</h5>
5487 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5488    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5489    this conversion.  The conversion is done as if the <tt>value</tt> had been
5490    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5491    be converted to other pointer types with this instruction. To convert
5492    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5493    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5494
5495 <h5>Example:</h5>
5496 <pre>
5497   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5498   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5499   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5500 </pre>
5501
5502 </div>
5503
5504 </div>
5505
5506 <!-- ======================================================================= -->
5507 <h3>
5508   <a name="otherops">Other Operations</a>
5509 </h3>
5510
5511 <div>
5512
5513 <p>The instructions in this category are the "miscellaneous" instructions, which
5514    defy better classification.</p>
5515
5516 <!-- _______________________________________________________________________ -->
5517 <h4>
5518   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5519 </h4>
5520
5521 <div>
5522
5523 <h5>Syntax:</h5>
5524 <pre>
5525   &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>
5526 </pre>
5527
5528 <h5>Overview:</h5>
5529 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5530    boolean values based on comparison of its two integer, integer vector, or
5531    pointer operands.</p>
5532
5533 <h5>Arguments:</h5>
5534 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5535    the condition code indicating the kind of comparison to perform. It is not a
5536    value, just a keyword. The possible condition code are:</p>
5537
5538 <ol>
5539   <li><tt>eq</tt>: equal</li>
5540   <li><tt>ne</tt>: not equal </li>
5541   <li><tt>ugt</tt>: unsigned greater than</li>
5542   <li><tt>uge</tt>: unsigned greater or equal</li>
5543   <li><tt>ult</tt>: unsigned less than</li>
5544   <li><tt>ule</tt>: unsigned less or equal</li>
5545   <li><tt>sgt</tt>: signed greater than</li>
5546   <li><tt>sge</tt>: signed greater or equal</li>
5547   <li><tt>slt</tt>: signed less than</li>
5548   <li><tt>sle</tt>: signed less or equal</li>
5549 </ol>
5550
5551 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5552    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5553    typed.  They must also be identical types.</p>
5554
5555 <h5>Semantics:</h5>
5556 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5557    condition code given as <tt>cond</tt>. The comparison performed always yields
5558    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5559    result, as follows:</p>
5560
5561 <ol>
5562   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5563       <tt>false</tt> otherwise. No sign interpretation is necessary or
5564       performed.</li>
5565
5566   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5567       <tt>false</tt> otherwise. No sign interpretation is necessary or
5568       performed.</li>
5569
5570   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5571       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5572
5573   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5574       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5575       to <tt>op2</tt>.</li>
5576
5577   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5578       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5579
5580   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5581       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5582
5583   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5584       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5585
5586   <li><tt>sge</tt>: interprets the operands as signed values and yields
5587       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5588       to <tt>op2</tt>.</li>
5589
5590   <li><tt>slt</tt>: interprets the operands as signed values and yields
5591       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5592
5593   <li><tt>sle</tt>: interprets the operands as signed values and yields
5594       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5595 </ol>
5596
5597 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5598    values are compared as if they were integers.</p>
5599
5600 <p>If the operands are integer vectors, then they are compared element by
5601    element. The result is an <tt>i1</tt> vector with the same number of elements
5602    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5603
5604 <h5>Example:</h5>
5605 <pre>
5606   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5607   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5608   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5609   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5610   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5611   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5612 </pre>
5613
5614 <p>Note that the code generator does not yet support vector types with
5615    the <tt>icmp</tt> instruction.</p>
5616
5617 </div>
5618
5619 <!-- _______________________________________________________________________ -->
5620 <h4>
5621   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5622 </h4>
5623
5624 <div>
5625
5626 <h5>Syntax:</h5>
5627 <pre>
5628   &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>
5629 </pre>
5630
5631 <h5>Overview:</h5>
5632 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5633    values based on comparison of its operands.</p>
5634
5635 <p>If the operands are floating point scalars, then the result type is a boolean
5636 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5637
5638 <p>If the operands are floating point vectors, then the result type is a vector
5639    of boolean with the same number of elements as the operands being
5640    compared.</p>
5641
5642 <h5>Arguments:</h5>
5643 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5644    the condition code indicating the kind of comparison to perform. It is not a
5645    value, just a keyword. The possible condition code are:</p>
5646
5647 <ol>
5648   <li><tt>false</tt>: no comparison, always returns false</li>
5649   <li><tt>oeq</tt>: ordered and equal</li>
5650   <li><tt>ogt</tt>: ordered and greater than </li>
5651   <li><tt>oge</tt>: ordered and greater than or equal</li>
5652   <li><tt>olt</tt>: ordered and less than </li>
5653   <li><tt>ole</tt>: ordered and less than or equal</li>
5654   <li><tt>one</tt>: ordered and not equal</li>
5655   <li><tt>ord</tt>: ordered (no nans)</li>
5656   <li><tt>ueq</tt>: unordered or equal</li>
5657   <li><tt>ugt</tt>: unordered or greater than </li>
5658   <li><tt>uge</tt>: unordered or greater than or equal</li>
5659   <li><tt>ult</tt>: unordered or less than </li>
5660   <li><tt>ule</tt>: unordered or less than or equal</li>
5661   <li><tt>une</tt>: unordered or not equal</li>
5662   <li><tt>uno</tt>: unordered (either nans)</li>
5663   <li><tt>true</tt>: no comparison, always returns true</li>
5664 </ol>
5665
5666 <p><i>Ordered</i> means that neither operand is a QNAN while
5667    <i>unordered</i> means that either operand may be a QNAN.</p>
5668
5669 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5670    a <a href="#t_floating">floating point</a> type or
5671    a <a href="#t_vector">vector</a> of floating point type.  They must have
5672    identical types.</p>
5673
5674 <h5>Semantics:</h5>
5675 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5676    according to the condition code given as <tt>cond</tt>.  If the operands are
5677    vectors, then the vectors are compared element by element.  Each comparison
5678    performed always yields an <a href="#t_integer">i1</a> result, as
5679    follows:</p>
5680
5681 <ol>
5682   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5683
5684   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5685       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5686
5687   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5688       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5689
5690   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5691       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5692
5693   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5694       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5695
5696   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5697       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5698
5699   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5700       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5701
5702   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5703
5704   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5705       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5706
5707   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5708       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5709
5710   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5711       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5712
5713   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5714       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5715
5716   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5717       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5718
5719   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5720       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5721
5722   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5723
5724   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5725 </ol>
5726
5727 <h5>Example:</h5>
5728 <pre>
5729   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5730   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5731   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5732   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5733 </pre>
5734
5735 <p>Note that the code generator does not yet support vector types with
5736    the <tt>fcmp</tt> instruction.</p>
5737
5738 </div>
5739
5740 <!-- _______________________________________________________________________ -->
5741 <h4>
5742   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5743 </h4>
5744
5745 <div>
5746
5747 <h5>Syntax:</h5>
5748 <pre>
5749   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5750 </pre>
5751
5752 <h5>Overview:</h5>
5753 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5754    SSA graph representing the function.</p>
5755
5756 <h5>Arguments:</h5>
5757 <p>The type of the incoming values is specified with the first type field. After
5758    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5759    one pair for each predecessor basic block of the current block.  Only values
5760    of <a href="#t_firstclass">first class</a> type may be used as the value
5761    arguments to the PHI node.  Only labels may be used as the label
5762    arguments.</p>
5763
5764 <p>There must be no non-phi instructions between the start of a basic block and
5765    the PHI instructions: i.e. PHI instructions must be first in a basic
5766    block.</p>
5767
5768 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5769    occur on the edge from the corresponding predecessor block to the current
5770    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5771    value on the same edge).</p>
5772
5773 <h5>Semantics:</h5>
5774 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5775    specified by the pair corresponding to the predecessor basic block that
5776    executed just prior to the current block.</p>
5777
5778 <h5>Example:</h5>
5779 <pre>
5780 Loop:       ; Infinite loop that counts from 0 on up...
5781   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5782   %nextindvar = add i32 %indvar, 1
5783   br label %Loop
5784 </pre>
5785
5786 </div>
5787
5788 <!-- _______________________________________________________________________ -->
5789 <h4>
5790    <a name="i_select">'<tt>select</tt>' Instruction</a>
5791 </h4>
5792
5793 <div>
5794
5795 <h5>Syntax:</h5>
5796 <pre>
5797   &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>
5798
5799   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5800 </pre>
5801
5802 <h5>Overview:</h5>
5803 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5804    condition, without branching.</p>
5805
5806
5807 <h5>Arguments:</h5>
5808 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5809    values indicating the condition, and two values of the
5810    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5811    vectors and the condition is a scalar, then entire vectors are selected, not
5812    individual elements.</p>
5813
5814 <h5>Semantics:</h5>
5815 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5816    first value argument; otherwise, it returns the second value argument.</p>
5817
5818 <p>If the condition is a vector of i1, then the value arguments must be vectors
5819    of the same size, and the selection is done element by element.</p>
5820
5821 <h5>Example:</h5>
5822 <pre>
5823   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5824 </pre>
5825
5826 <p>Note that the code generator does not yet support conditions
5827    with vector type.</p>
5828
5829 </div>
5830
5831 <!-- _______________________________________________________________________ -->
5832 <h4>
5833   <a name="i_call">'<tt>call</tt>' Instruction</a>
5834 </h4>
5835
5836 <div>
5837
5838 <h5>Syntax:</h5>
5839 <pre>
5840   &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>]
5841 </pre>
5842
5843 <h5>Overview:</h5>
5844 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5845
5846 <h5>Arguments:</h5>
5847 <p>This instruction requires several arguments:</p>
5848
5849 <ol>
5850   <li>The optional "tail" marker indicates that the callee function does not
5851       access any allocas or varargs in the caller.  Note that calls may be
5852       marked "tail" even if they do not occur before
5853       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5854       present, the function call is eligible for tail call optimization,
5855       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5856       optimized into a jump</a>.  The code generator may optimize calls marked
5857       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5858       sibling call optimization</a> when the caller and callee have
5859       matching signatures, or 2) forced tail call optimization when the
5860       following extra requirements are met:
5861       <ul>
5862         <li>Caller and callee both have the calling
5863             convention <tt>fastcc</tt>.</li>
5864         <li>The call is in tail position (ret immediately follows call and ret
5865             uses value of call or is void).</li>
5866         <li>Option <tt>-tailcallopt</tt> is enabled,
5867             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5868         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5869             constraints are met.</a></li>
5870       </ul>
5871   </li>
5872
5873   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5874       convention</a> the call should use.  If none is specified, the call
5875       defaults to using C calling conventions.  The calling convention of the
5876       call must match the calling convention of the target function, or else the
5877       behavior is undefined.</li>
5878
5879   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5880       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5881       '<tt>inreg</tt>' attributes are valid here.</li>
5882
5883   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5884       type of the return value.  Functions that return no value are marked
5885       <tt><a href="#t_void">void</a></tt>.</li>
5886
5887   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5888       being invoked.  The argument types must match the types implied by this
5889       signature.  This type can be omitted if the function is not varargs and if
5890       the function type does not return a pointer to a function.</li>
5891
5892   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5893       be invoked. In most cases, this is a direct function invocation, but
5894       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5895       to function value.</li>
5896
5897   <li>'<tt>function args</tt>': argument list whose types match the function
5898       signature argument types and parameter attributes. All arguments must be
5899       of <a href="#t_firstclass">first class</a> type. If the function
5900       signature indicates the function accepts a variable number of arguments,
5901       the extra arguments can be specified.</li>
5902
5903   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5904       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5905       '<tt>readnone</tt>' attributes are valid here.</li>
5906 </ol>
5907
5908 <h5>Semantics:</h5>
5909 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5910    a specified function, with its incoming arguments bound to the specified
5911    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5912    function, control flow continues with the instruction after the function
5913    call, and the return value of the function is bound to the result
5914    argument.</p>
5915
5916 <h5>Example:</h5>
5917 <pre>
5918   %retval = call i32 @test(i32 %argc)
5919   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5920   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5921   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5922   call void %foo(i8 97 signext)
5923
5924   %struct.A = type { i32, i8 }
5925   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5926   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5927   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5928   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5929   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5930 </pre>
5931
5932 <p>llvm treats calls to some functions with names and arguments that match the
5933 standard C99 library as being the C99 library functions, and may perform
5934 optimizations or generate code for them under that assumption.  This is
5935 something we'd like to change in the future to provide better support for
5936 freestanding environments and non-C-based languages.</p>
5937
5938 </div>
5939
5940 <!-- _______________________________________________________________________ -->
5941 <h4>
5942   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5943 </h4>
5944
5945 <div>
5946
5947 <h5>Syntax:</h5>
5948 <pre>
5949   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5950 </pre>
5951
5952 <h5>Overview:</h5>
5953 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5954    the "variable argument" area of a function call.  It is used to implement the
5955    <tt>va_arg</tt> macro in C.</p>
5956
5957 <h5>Arguments:</h5>
5958 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5959    argument. It returns a value of the specified argument type and increments
5960    the <tt>va_list</tt> to point to the next argument.  The actual type
5961    of <tt>va_list</tt> is target specific.</p>
5962
5963 <h5>Semantics:</h5>
5964 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5965    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5966    to the next argument.  For more information, see the variable argument
5967    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5968
5969 <p>It is legal for this instruction to be called in a function which does not
5970    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5971    function.</p>
5972
5973 <p><tt>va_arg</tt> is an LLVM instruction instead of
5974    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5975    argument.</p>
5976
5977 <h5>Example:</h5>
5978 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
5979
5980 <p>Note that the code generator does not yet fully support va_arg on many
5981    targets. Also, it does not currently support va_arg with aggregate types on
5982    any target.</p>
5983
5984 </div>
5985
5986 <!-- _______________________________________________________________________ -->
5987 <h4>
5988   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
5989 </h4>
5990
5991 <div>
5992
5993 <h5>Syntax:</h5>
5994 <pre>
5995   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
5996   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
5997
5998   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
5999   &lt;clause&gt; := filter &lt;type&gt; &lt;value&gt; {, &lt;type&gt; &lt;value&gt;}*
6000 </pre>
6001
6002 <h5>Overview:</h5>
6003 <p>The '<tt>landingpad</tt>' instruction is used by
6004    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6005    system</a> to specify that a basic block is a landing pad &mdash; one where
6006    the exception lands, and corresponds to the code found in the
6007    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6008    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6009    re-entry to the function. The <tt>resultval</tt> has the
6010    type <tt>somety</tt>.</p>
6011
6012 <h5>Arguments:</h5>
6013 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6014    function associated with the unwinding mechanism. The optional
6015    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6016
6017 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6018    or <tt>filter</tt> &mdash; and contains a list of global variables
6019    representing the "types" that may be caught or filtered respectively. The
6020    '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6021    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6022
6023 <h5>Semantics:</h5>
6024 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6025    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6026    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6027    calling conventions, how the personality function results are represented in
6028    LLVM IR is target specific.</p>
6029
6030 <p>The clauses are applied in order from top to bottom. If two
6031    <tt>landingpad</tt> instructions are merged together through inlining, the
6032    clauses from the calling function are appended to the list of clauses.</p>
6033
6034 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6035
6036 <ul>
6037   <li>A landing pad block is a basic block which is the unwind destination of an
6038       '<tt>invoke</tt>' instruction.</li>
6039   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6040       first non-PHI instruction.</li>
6041   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6042       pad block.</li>
6043   <li>A basic block that is not a landing pad block may not include a
6044       '<tt>landingpad</tt>' instruction.</li>
6045   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6046       personality function.</li>
6047 </ul>
6048
6049 <h5>Example:</h5>
6050 <pre>
6051   ;; A landing pad which can catch an integer.
6052   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6053            catch i8** @_ZTIi
6054   ;; A landing pad that is a cleanup.
6055   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6056            cleanup
6057   ;; A landing pad which can catch an integer and can only throw a double.
6058   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6059            catch i8** @_ZTIi
6060            filter i8** @_ZTId
6061 </pre>
6062
6063 </div>
6064
6065 </div>
6066
6067 </div>
6068
6069 <!-- *********************************************************************** -->
6070 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6071 <!-- *********************************************************************** -->
6072
6073 <div>
6074
6075 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6076    well known names and semantics and are required to follow certain
6077    restrictions.  Overall, these intrinsics represent an extension mechanism for
6078    the LLVM language that does not require changing all of the transformations
6079    in LLVM when adding to the language (or the bitcode reader/writer, the
6080    parser, etc...).</p>
6081
6082 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6083    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6084    begin with this prefix.  Intrinsic functions must always be external
6085    functions: you cannot define the body of intrinsic functions.  Intrinsic
6086    functions may only be used in call or invoke instructions: it is illegal to
6087    take the address of an intrinsic function.  Additionally, because intrinsic
6088    functions are part of the LLVM language, it is required if any are added that
6089    they be documented here.</p>
6090
6091 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6092    family of functions that perform the same operation but on different data
6093    types. Because LLVM can represent over 8 million different integer types,
6094    overloading is used commonly to allow an intrinsic function to operate on any
6095    integer type. One or more of the argument types or the result type can be
6096    overloaded to accept any integer type. Argument types may also be defined as
6097    exactly matching a previous argument's type or the result type. This allows
6098    an intrinsic function which accepts multiple arguments, but needs all of them
6099    to be of the same type, to only be overloaded with respect to a single
6100    argument or the result.</p>
6101
6102 <p>Overloaded intrinsics will have the names of its overloaded argument types
6103    encoded into its function name, each preceded by a period. Only those types
6104    which are overloaded result in a name suffix. Arguments whose type is matched
6105    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6106    can take an integer of any width and returns an integer of exactly the same
6107    integer width. This leads to a family of functions such as
6108    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6109    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6110    suffix is required. Because the argument's type is matched against the return
6111    type, it does not require its own name suffix.</p>
6112
6113 <p>To learn how to add an intrinsic function, please see the
6114    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6115
6116 <!-- ======================================================================= -->
6117 <h3>
6118   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6119 </h3>
6120
6121 <div>
6122
6123 <p>Variable argument support is defined in LLVM with
6124    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6125    intrinsic functions.  These functions are related to the similarly named
6126    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6127
6128 <p>All of these functions operate on arguments that use a target-specific value
6129    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6130    not define what this type is, so all transformations should be prepared to
6131    handle these functions regardless of the type used.</p>
6132
6133 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6134    instruction and the variable argument handling intrinsic functions are
6135    used.</p>
6136
6137 <pre class="doc_code">
6138 define i32 @test(i32 %X, ...) {
6139   ; Initialize variable argument processing
6140   %ap = alloca i8*
6141   %ap2 = bitcast i8** %ap to i8*
6142   call void @llvm.va_start(i8* %ap2)
6143
6144   ; Read a single integer argument
6145   %tmp = va_arg i8** %ap, i32
6146
6147   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6148   %aq = alloca i8*
6149   %aq2 = bitcast i8** %aq to i8*
6150   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6151   call void @llvm.va_end(i8* %aq2)
6152
6153   ; Stop processing of arguments.
6154   call void @llvm.va_end(i8* %ap2)
6155   ret i32 %tmp
6156 }
6157
6158 declare void @llvm.va_start(i8*)
6159 declare void @llvm.va_copy(i8*, i8*)
6160 declare void @llvm.va_end(i8*)
6161 </pre>
6162
6163 <!-- _______________________________________________________________________ -->
6164 <h4>
6165   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6166 </h4>
6167
6168
6169 <div>
6170
6171 <h5>Syntax:</h5>
6172 <pre>
6173   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6174 </pre>
6175
6176 <h5>Overview:</h5>
6177 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6178    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6179
6180 <h5>Arguments:</h5>
6181 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6182
6183 <h5>Semantics:</h5>
6184 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6185    macro available in C.  In a target-dependent way, it initializes
6186    the <tt>va_list</tt> element to which the argument points, so that the next
6187    call to <tt>va_arg</tt> will produce the first variable argument passed to
6188    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6189    need to know the last argument of the function as the compiler can figure
6190    that out.</p>
6191
6192 </div>
6193
6194 <!-- _______________________________________________________________________ -->
6195 <h4>
6196  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6197 </h4>
6198
6199 <div>
6200
6201 <h5>Syntax:</h5>
6202 <pre>
6203   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6204 </pre>
6205
6206 <h5>Overview:</h5>
6207 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6208    which has been initialized previously
6209    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6210    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6211
6212 <h5>Arguments:</h5>
6213 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6214
6215 <h5>Semantics:</h5>
6216 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6217    macro available in C.  In a target-dependent way, it destroys
6218    the <tt>va_list</tt> element to which the argument points.  Calls
6219    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6220    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6221    with calls to <tt>llvm.va_end</tt>.</p>
6222
6223 </div>
6224
6225 <!-- _______________________________________________________________________ -->
6226 <h4>
6227   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6228 </h4>
6229
6230 <div>
6231
6232 <h5>Syntax:</h5>
6233 <pre>
6234   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6235 </pre>
6236
6237 <h5>Overview:</h5>
6238 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6239    from the source argument list to the destination argument list.</p>
6240
6241 <h5>Arguments:</h5>
6242 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6243    The second argument is a pointer to a <tt>va_list</tt> element to copy
6244    from.</p>
6245
6246 <h5>Semantics:</h5>
6247 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6248    macro available in C.  In a target-dependent way, it copies the
6249    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6250    element.  This intrinsic is necessary because
6251    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6252    arbitrarily complex and require, for example, memory allocation.</p>
6253
6254 </div>
6255
6256 </div>
6257
6258 </div>
6259
6260 <!-- ======================================================================= -->
6261 <h3>
6262   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6263 </h3>
6264
6265 <div>
6266
6267 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6268 Collection</a> (GC) requires the implementation and generation of these
6269 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6270 roots on the stack</a>, as well as garbage collector implementations that
6271 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6272 barriers.  Front-ends for type-safe garbage collected languages should generate
6273 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6274 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6275 LLVM</a>.</p>
6276
6277 <p>The garbage collection intrinsics only operate on objects in the generic
6278    address space (address space zero).</p>
6279
6280 <!-- _______________________________________________________________________ -->
6281 <h4>
6282   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6283 </h4>
6284
6285 <div>
6286
6287 <h5>Syntax:</h5>
6288 <pre>
6289   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6290 </pre>
6291
6292 <h5>Overview:</h5>
6293 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6294    the code generator, and allows some metadata to be associated with it.</p>
6295
6296 <h5>Arguments:</h5>
6297 <p>The first argument specifies the address of a stack object that contains the
6298    root pointer.  The second pointer (which must be either a constant or a
6299    global value address) contains the meta-data to be associated with the
6300    root.</p>
6301
6302 <h5>Semantics:</h5>
6303 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6304    location.  At compile-time, the code generator generates information to allow
6305    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6306    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6307    algorithm</a>.</p>
6308
6309 </div>
6310
6311 <!-- _______________________________________________________________________ -->
6312 <h4>
6313   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6314 </h4>
6315
6316 <div>
6317
6318 <h5>Syntax:</h5>
6319 <pre>
6320   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6321 </pre>
6322
6323 <h5>Overview:</h5>
6324 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6325    locations, allowing garbage collector implementations that require read
6326    barriers.</p>
6327
6328 <h5>Arguments:</h5>
6329 <p>The second argument is the address to read from, which should be an address
6330    allocated from the garbage collector.  The first object is a pointer to the
6331    start of the referenced object, if needed by the language runtime (otherwise
6332    null).</p>
6333
6334 <h5>Semantics:</h5>
6335 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6336    instruction, but may be replaced with substantially more complex code by the
6337    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6338    may only be used in a function which <a href="#gc">specifies a GC
6339    algorithm</a>.</p>
6340
6341 </div>
6342
6343 <!-- _______________________________________________________________________ -->
6344 <h4>
6345   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6346 </h4>
6347
6348 <div>
6349
6350 <h5>Syntax:</h5>
6351 <pre>
6352   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6353 </pre>
6354
6355 <h5>Overview:</h5>
6356 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6357    locations, allowing garbage collector implementations that require write
6358    barriers (such as generational or reference counting collectors).</p>
6359
6360 <h5>Arguments:</h5>
6361 <p>The first argument is the reference to store, the second is the start of the
6362    object to store it to, and the third is the address of the field of Obj to
6363    store to.  If the runtime does not require a pointer to the object, Obj may
6364    be null.</p>
6365
6366 <h5>Semantics:</h5>
6367 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6368    instruction, but may be replaced with substantially more complex code by the
6369    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6370    may only be used in a function which <a href="#gc">specifies a GC
6371    algorithm</a>.</p>
6372
6373 </div>
6374
6375 </div>
6376
6377 <!-- ======================================================================= -->
6378 <h3>
6379   <a name="int_codegen">Code Generator Intrinsics</a>
6380 </h3>
6381
6382 <div>
6383
6384 <p>These intrinsics are provided by LLVM to expose special features that may
6385    only be implemented with code generator support.</p>
6386
6387 <!-- _______________________________________________________________________ -->
6388 <h4>
6389   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6390 </h4>
6391
6392 <div>
6393
6394 <h5>Syntax:</h5>
6395 <pre>
6396   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6397 </pre>
6398
6399 <h5>Overview:</h5>
6400 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6401    target-specific value indicating the return address of the current function
6402    or one of its callers.</p>
6403
6404 <h5>Arguments:</h5>
6405 <p>The argument to this intrinsic indicates which function to return the address
6406    for.  Zero indicates the calling function, one indicates its caller, etc.
6407    The argument is <b>required</b> to be a constant integer value.</p>
6408
6409 <h5>Semantics:</h5>
6410 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6411    indicating the return address of the specified call frame, or zero if it
6412    cannot be identified.  The value returned by this intrinsic is likely to be
6413    incorrect or 0 for arguments other than zero, so it should only be used for
6414    debugging purposes.</p>
6415
6416 <p>Note that calling this intrinsic does not prevent function inlining or other
6417    aggressive transformations, so the value returned may not be that of the
6418    obvious source-language caller.</p>
6419
6420 </div>
6421
6422 <!-- _______________________________________________________________________ -->
6423 <h4>
6424   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6425 </h4>
6426
6427 <div>
6428
6429 <h5>Syntax:</h5>
6430 <pre>
6431   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6432 </pre>
6433
6434 <h5>Overview:</h5>
6435 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6436    target-specific frame pointer value for the specified stack frame.</p>
6437
6438 <h5>Arguments:</h5>
6439 <p>The argument to this intrinsic indicates which function to return the frame
6440    pointer for.  Zero indicates the calling function, one indicates its caller,
6441    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6442
6443 <h5>Semantics:</h5>
6444 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6445    indicating the frame address of the specified call frame, or zero if it
6446    cannot be identified.  The value returned by this intrinsic is likely to be
6447    incorrect or 0 for arguments other than zero, so it should only be used for
6448    debugging purposes.</p>
6449
6450 <p>Note that calling this intrinsic does not prevent function inlining or other
6451    aggressive transformations, so the value returned may not be that of the
6452    obvious source-language caller.</p>
6453
6454 </div>
6455
6456 <!-- _______________________________________________________________________ -->
6457 <h4>
6458   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6459 </h4>
6460
6461 <div>
6462
6463 <h5>Syntax:</h5>
6464 <pre>
6465   declare i8* @llvm.stacksave()
6466 </pre>
6467
6468 <h5>Overview:</h5>
6469 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6470    of the function stack, for use
6471    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6472    useful for implementing language features like scoped automatic variable
6473    sized arrays in C99.</p>
6474
6475 <h5>Semantics:</h5>
6476 <p>This intrinsic returns a opaque pointer value that can be passed
6477    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6478    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6479    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6480    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6481    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6482    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6483
6484 </div>
6485
6486 <!-- _______________________________________________________________________ -->
6487 <h4>
6488   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6489 </h4>
6490
6491 <div>
6492
6493 <h5>Syntax:</h5>
6494 <pre>
6495   declare void @llvm.stackrestore(i8* %ptr)
6496 </pre>
6497
6498 <h5>Overview:</h5>
6499 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6500    the function stack to the state it was in when the
6501    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6502    executed.  This is useful for implementing language features like scoped
6503    automatic variable sized arrays in C99.</p>
6504
6505 <h5>Semantics:</h5>
6506 <p>See the description
6507    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6508
6509 </div>
6510
6511 <!-- _______________________________________________________________________ -->
6512 <h4>
6513   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6514 </h4>
6515
6516 <div>
6517
6518 <h5>Syntax:</h5>
6519 <pre>
6520   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6521 </pre>
6522
6523 <h5>Overview:</h5>
6524 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6525    insert a prefetch instruction if supported; otherwise, it is a noop.
6526    Prefetches have no effect on the behavior of the program but can change its
6527    performance characteristics.</p>
6528
6529 <h5>Arguments:</h5>
6530 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6531    specifier determining if the fetch should be for a read (0) or write (1),
6532    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6533    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6534    specifies whether the prefetch is performed on the data (1) or instruction (0)
6535    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6536    must be constant integers.</p>
6537
6538 <h5>Semantics:</h5>
6539 <p>This intrinsic does not modify the behavior of the program.  In particular,
6540    prefetches cannot trap and do not produce a value.  On targets that support
6541    this intrinsic, the prefetch can provide hints to the processor cache for
6542    better performance.</p>
6543
6544 </div>
6545
6546 <!-- _______________________________________________________________________ -->
6547 <h4>
6548   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6549 </h4>
6550
6551 <div>
6552
6553 <h5>Syntax:</h5>
6554 <pre>
6555   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6556 </pre>
6557
6558 <h5>Overview:</h5>
6559 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6560    Counter (PC) in a region of code to simulators and other tools.  The method
6561    is target specific, but it is expected that the marker will use exported
6562    symbols to transmit the PC of the marker.  The marker makes no guarantees
6563    that it will remain with any specific instruction after optimizations.  It is
6564    possible that the presence of a marker will inhibit optimizations.  The
6565    intended use is to be inserted after optimizations to allow correlations of
6566    simulation runs.</p>
6567
6568 <h5>Arguments:</h5>
6569 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6570
6571 <h5>Semantics:</h5>
6572 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6573    not support this intrinsic may ignore it.</p>
6574
6575 </div>
6576
6577 <!-- _______________________________________________________________________ -->
6578 <h4>
6579   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6580 </h4>
6581
6582 <div>
6583
6584 <h5>Syntax:</h5>
6585 <pre>
6586   declare i64 @llvm.readcyclecounter()
6587 </pre>
6588
6589 <h5>Overview:</h5>
6590 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6591    counter register (or similar low latency, high accuracy clocks) on those
6592    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6593    should map to RPCC.  As the backing counters overflow quickly (on the order
6594    of 9 seconds on alpha), this should only be used for small timings.</p>
6595
6596 <h5>Semantics:</h5>
6597 <p>When directly supported, reading the cycle counter should not modify any
6598    memory.  Implementations are allowed to either return a application specific
6599    value or a system wide value.  On backends without support, this is lowered
6600    to a constant 0.</p>
6601
6602 </div>
6603
6604 </div>
6605
6606 <!-- ======================================================================= -->
6607 <h3>
6608   <a name="int_libc">Standard C Library Intrinsics</a>
6609 </h3>
6610
6611 <div>
6612
6613 <p>LLVM provides intrinsics for a few important standard C library functions.
6614    These intrinsics allow source-language front-ends to pass information about
6615    the alignment of the pointer arguments to the code generator, providing
6616    opportunity for more efficient code generation.</p>
6617
6618 <!-- _______________________________________________________________________ -->
6619 <h4>
6620   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6621 </h4>
6622
6623 <div>
6624
6625 <h5>Syntax:</h5>
6626 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6627    integer bit width and for different address spaces. Not all targets support
6628    all bit widths however.</p>
6629
6630 <pre>
6631   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6632                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6633   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6634                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6635 </pre>
6636
6637 <h5>Overview:</h5>
6638 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6639    source location to the destination location.</p>
6640
6641 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6642    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6643    and the pointers can be in specified address spaces.</p>
6644
6645 <h5>Arguments:</h5>
6646
6647 <p>The first argument is a pointer to the destination, the second is a pointer
6648    to the source.  The third argument is an integer argument specifying the
6649    number of bytes to copy, the fourth argument is the alignment of the
6650    source and destination locations, and the fifth is a boolean indicating a
6651    volatile access.</p>
6652
6653 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6654    then the caller guarantees that both the source and destination pointers are
6655    aligned to that boundary.</p>
6656
6657 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6658    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6659    The detailed access behavior is not very cleanly specified and it is unwise
6660    to depend on it.</p>
6661
6662 <h5>Semantics:</h5>
6663
6664 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6665    source location to the destination location, which are not allowed to
6666    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6667    be aligned to some boundary, this can be specified as the fourth argument,
6668    otherwise it should be set to 0 or 1.</p>
6669
6670 </div>
6671
6672 <!-- _______________________________________________________________________ -->
6673 <h4>
6674   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6675 </h4>
6676
6677 <div>
6678
6679 <h5>Syntax:</h5>
6680 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6681    width and for different address space. Not all targets support all bit
6682    widths however.</p>
6683
6684 <pre>
6685   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6686                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6687   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6688                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6689 </pre>
6690
6691 <h5>Overview:</h5>
6692 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6693    source location to the destination location. It is similar to the
6694    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6695    overlap.</p>
6696
6697 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6698    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6699    and the pointers can be in specified address spaces.</p>
6700
6701 <h5>Arguments:</h5>
6702
6703 <p>The first argument is a pointer to the destination, the second is a pointer
6704    to the source.  The third argument is an integer argument specifying the
6705    number of bytes to copy, the fourth argument is the alignment of the
6706    source and destination locations, and the fifth is a boolean indicating a
6707    volatile access.</p>
6708
6709 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6710    then the caller guarantees that the source and destination pointers are
6711    aligned to that boundary.</p>
6712
6713 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6714    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6715    The detailed access behavior is not very cleanly specified and it is unwise
6716    to depend on it.</p>
6717
6718 <h5>Semantics:</h5>
6719
6720 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6721    source location to the destination location, which may overlap.  It copies
6722    "len" bytes of memory over.  If the argument is known to be aligned to some
6723    boundary, this can be specified as the fourth argument, otherwise it should
6724    be set to 0 or 1.</p>
6725
6726 </div>
6727
6728 <!-- _______________________________________________________________________ -->
6729 <h4>
6730   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6731 </h4>
6732
6733 <div>
6734
6735 <h5>Syntax:</h5>
6736 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6737    width and for different address spaces. However, not all targets support all
6738    bit widths.</p>
6739
6740 <pre>
6741   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6742                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6743   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6744                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6745 </pre>
6746
6747 <h5>Overview:</h5>
6748 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6749    particular byte value.</p>
6750
6751 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6752    intrinsic does not return a value and takes extra alignment/volatile
6753    arguments.  Also, the destination can be in an arbitrary address space.</p>
6754
6755 <h5>Arguments:</h5>
6756 <p>The first argument is a pointer to the destination to fill, the second is the
6757    byte value with which to fill it, the third argument is an integer argument
6758    specifying the number of bytes to fill, and the fourth argument is the known
6759    alignment of the destination location.</p>
6760
6761 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6762    then the caller guarantees that the destination pointer is aligned to that
6763    boundary.</p>
6764
6765 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6766    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6767    The detailed access behavior is not very cleanly specified and it is unwise
6768    to depend on it.</p>
6769
6770 <h5>Semantics:</h5>
6771 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6772    at the destination location.  If the argument is known to be aligned to some
6773    boundary, this can be specified as the fourth argument, otherwise it should
6774    be set to 0 or 1.</p>
6775
6776 </div>
6777
6778 <!-- _______________________________________________________________________ -->
6779 <h4>
6780   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6781 </h4>
6782
6783 <div>
6784
6785 <h5>Syntax:</h5>
6786 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6787    floating point or vector of floating point type. Not all targets support all
6788    types however.</p>
6789
6790 <pre>
6791   declare float     @llvm.sqrt.f32(float %Val)
6792   declare double    @llvm.sqrt.f64(double %Val)
6793   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6794   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6795   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6796 </pre>
6797
6798 <h5>Overview:</h5>
6799 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6800    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6801    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6802    behavior for negative numbers other than -0.0 (which allows for better
6803    optimization, because there is no need to worry about errno being
6804    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6805
6806 <h5>Arguments:</h5>
6807 <p>The argument and return value are floating point numbers of the same
6808    type.</p>
6809
6810 <h5>Semantics:</h5>
6811 <p>This function returns the sqrt of the specified operand if it is a
6812    nonnegative floating point number.</p>
6813
6814 </div>
6815
6816 <!-- _______________________________________________________________________ -->
6817 <h4>
6818   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6819 </h4>
6820
6821 <div>
6822
6823 <h5>Syntax:</h5>
6824 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6825    floating point or vector of floating point type. Not all targets support all
6826    types however.</p>
6827
6828 <pre>
6829   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6830   declare double    @llvm.powi.f64(double %Val, i32 %power)
6831   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6832   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6833   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6834 </pre>
6835
6836 <h5>Overview:</h5>
6837 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6838    specified (positive or negative) power.  The order of evaluation of
6839    multiplications is not defined.  When a vector of floating point type is
6840    used, the second argument remains a scalar integer value.</p>
6841
6842 <h5>Arguments:</h5>
6843 <p>The second argument is an integer power, and the first is a value to raise to
6844    that power.</p>
6845
6846 <h5>Semantics:</h5>
6847 <p>This function returns the first value raised to the second power with an
6848    unspecified sequence of rounding operations.</p>
6849
6850 </div>
6851
6852 <!-- _______________________________________________________________________ -->
6853 <h4>
6854   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6855 </h4>
6856
6857 <div>
6858
6859 <h5>Syntax:</h5>
6860 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6861    floating point or vector of floating point type. Not all targets support all
6862    types however.</p>
6863
6864 <pre>
6865   declare float     @llvm.sin.f32(float  %Val)
6866   declare double    @llvm.sin.f64(double %Val)
6867   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6868   declare fp128     @llvm.sin.f128(fp128 %Val)
6869   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6870 </pre>
6871
6872 <h5>Overview:</h5>
6873 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6874
6875 <h5>Arguments:</h5>
6876 <p>The argument and return value are floating point numbers of the same
6877    type.</p>
6878
6879 <h5>Semantics:</h5>
6880 <p>This function returns the sine of the specified operand, returning the same
6881    values as the libm <tt>sin</tt> functions would, and handles error conditions
6882    in the same way.</p>
6883
6884 </div>
6885
6886 <!-- _______________________________________________________________________ -->
6887 <h4>
6888   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6889 </h4>
6890
6891 <div>
6892
6893 <h5>Syntax:</h5>
6894 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6895    floating point or vector of floating point type. Not all targets support all
6896    types however.</p>
6897
6898 <pre>
6899   declare float     @llvm.cos.f32(float  %Val)
6900   declare double    @llvm.cos.f64(double %Val)
6901   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6902   declare fp128     @llvm.cos.f128(fp128 %Val)
6903   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6904 </pre>
6905
6906 <h5>Overview:</h5>
6907 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6908
6909 <h5>Arguments:</h5>
6910 <p>The argument and return value are floating point numbers of the same
6911    type.</p>
6912
6913 <h5>Semantics:</h5>
6914 <p>This function returns the cosine of the specified operand, returning the same
6915    values as the libm <tt>cos</tt> functions would, and handles error conditions
6916    in the same way.</p>
6917
6918 </div>
6919
6920 <!-- _______________________________________________________________________ -->
6921 <h4>
6922   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6923 </h4>
6924
6925 <div>
6926
6927 <h5>Syntax:</h5>
6928 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6929    floating point or vector of floating point type. Not all targets support all
6930    types however.</p>
6931
6932 <pre>
6933   declare float     @llvm.pow.f32(float  %Val, float %Power)
6934   declare double    @llvm.pow.f64(double %Val, double %Power)
6935   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6936   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6937   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6938 </pre>
6939
6940 <h5>Overview:</h5>
6941 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6942    specified (positive or negative) power.</p>
6943
6944 <h5>Arguments:</h5>
6945 <p>The second argument is a floating point power, and the first is a value to
6946    raise to that power.</p>
6947
6948 <h5>Semantics:</h5>
6949 <p>This function returns the first value raised to the second power, returning
6950    the same values as the libm <tt>pow</tt> functions would, and handles error
6951    conditions in the same way.</p>
6952
6953 </div>
6954
6955 </div>
6956
6957 <!-- _______________________________________________________________________ -->
6958 <h4>
6959   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
6960 </h4>
6961
6962 <div>
6963
6964 <h5>Syntax:</h5>
6965 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
6966    floating point or vector of floating point type. Not all targets support all
6967    types however.</p>
6968
6969 <pre>
6970   declare float     @llvm.exp.f32(float  %Val)
6971   declare double    @llvm.exp.f64(double %Val)
6972   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
6973   declare fp128     @llvm.exp.f128(fp128 %Val)
6974   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
6975 </pre>
6976
6977 <h5>Overview:</h5>
6978 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
6979
6980 <h5>Arguments:</h5>
6981 <p>The argument and return value are floating point numbers of the same
6982    type.</p>
6983
6984 <h5>Semantics:</h5>
6985 <p>This function returns the same values as the libm <tt>exp</tt> functions
6986    would, and handles error conditions in the same way.</p>
6987
6988 </div>
6989
6990 <!-- _______________________________________________________________________ -->
6991 <h4>
6992   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
6993 </h4>
6994
6995 <div>
6996
6997 <h5>Syntax:</h5>
6998 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
6999    floating point or vector of floating point type. Not all targets support all
7000    types however.</p>
7001
7002 <pre>
7003   declare float     @llvm.log.f32(float  %Val)
7004   declare double    @llvm.log.f64(double %Val)
7005   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7006   declare fp128     @llvm.log.f128(fp128 %Val)
7007   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7008 </pre>
7009
7010 <h5>Overview:</h5>
7011 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7012
7013 <h5>Arguments:</h5>
7014 <p>The argument and return value are floating point numbers of the same
7015    type.</p>
7016
7017 <h5>Semantics:</h5>
7018 <p>This function returns the same values as the libm <tt>log</tt> functions
7019    would, and handles error conditions in the same way.</p>
7020
7021 <h4>
7022   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7023 </h4>
7024
7025 <div>
7026
7027 <h5>Syntax:</h5>
7028 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7029    floating point or vector of floating point type. Not all targets support all
7030    types however.</p>
7031
7032 <pre>
7033   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7034   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7035   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7036   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7037   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7038 </pre>
7039
7040 <h5>Overview:</h5>
7041 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7042    operation.</p>
7043
7044 <h5>Arguments:</h5>
7045 <p>The argument and return value are floating point numbers of the same
7046    type.</p>
7047
7048 <h5>Semantics:</h5>
7049 <p>This function returns the same values as the libm <tt>fma</tt> functions
7050    would.</p>
7051
7052 </div>
7053
7054 <!-- ======================================================================= -->
7055 <h3>
7056   <a name="int_manip">Bit Manipulation Intrinsics</a>
7057 </h3>
7058
7059 <div>
7060
7061 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7062    These allow efficient code generation for some algorithms.</p>
7063
7064 <!-- _______________________________________________________________________ -->
7065 <h4>
7066   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7067 </h4>
7068
7069 <div>
7070
7071 <h5>Syntax:</h5>
7072 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7073    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7074
7075 <pre>
7076   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7077   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7078   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7079 </pre>
7080
7081 <h5>Overview:</h5>
7082 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7083    values with an even number of bytes (positive multiple of 16 bits).  These
7084    are useful for performing operations on data that is not in the target's
7085    native byte order.</p>
7086
7087 <h5>Semantics:</h5>
7088 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7089    and low byte of the input i16 swapped.  Similarly,
7090    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7091    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7092    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7093    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7094    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7095    more, respectively).</p>
7096
7097 </div>
7098
7099 <!-- _______________________________________________________________________ -->
7100 <h4>
7101   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7102 </h4>
7103
7104 <div>
7105
7106 <h5>Syntax:</h5>
7107 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7108    width, or on any vector with integer elements. Not all targets support all
7109   bit widths or vector types, however.</p>
7110
7111 <pre>
7112   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7113   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7114   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7115   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7116   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7117   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7118 </pre>
7119
7120 <h5>Overview:</h5>
7121 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7122    in a value.</p>
7123
7124 <h5>Arguments:</h5>
7125 <p>The only argument is the value to be counted.  The argument may be of any
7126    integer type, or a vector with integer elements.
7127    The return type must match the argument type.</p>
7128
7129 <h5>Semantics:</h5>
7130 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7131    element of a vector.</p>
7132
7133 </div>
7134
7135 <!-- _______________________________________________________________________ -->
7136 <h4>
7137   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7138 </h4>
7139
7140 <div>
7141
7142 <h5>Syntax:</h5>
7143 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7144    integer bit width, or any vector whose elements are integers. Not all
7145    targets support all bit widths or vector types, however.</p>
7146
7147 <pre>
7148   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
7149   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
7150   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
7151   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
7152   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
7153   declare &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src;gt)
7154 </pre>
7155
7156 <h5>Overview:</h5>
7157 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7158    leading zeros in a variable.</p>
7159
7160 <h5>Arguments:</h5>
7161 <p>The only argument is the value to be counted.  The argument may be of any
7162    integer type, or any vector type with integer element type.
7163    The return type must match the argument type.</p>
7164
7165 <h5>Semantics:</h5>
7166 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7167    zeros in a variable, or within each element of the vector if the operation
7168    is of vector type.  If the src == 0 then the result is the size in bits of
7169    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7170
7171 </div>
7172
7173 <!-- _______________________________________________________________________ -->
7174 <h4>
7175   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7176 </h4>
7177
7178 <div>
7179
7180 <h5>Syntax:</h5>
7181 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7182    integer bit width, or any vector of integer elements. Not all targets
7183    support all bit widths or vector types, however.</p>
7184
7185 <pre>
7186   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
7187   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
7188   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
7189   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
7190   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
7191   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7192 </pre>
7193
7194 <h5>Overview:</h5>
7195 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7196    trailing zeros.</p>
7197
7198 <h5>Arguments:</h5>
7199 <p>The only argument is the value to be counted.  The argument may be of any
7200    integer type, or a vectory with integer element type..  The return type
7201    must match the argument type.</p>
7202
7203 <h5>Semantics:</h5>
7204 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7205    zeros in a variable, or within each element of a vector.
7206    If the src == 0 then the result is the size in bits of
7207    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7208
7209 </div>
7210
7211 </div>
7212
7213 <!-- ======================================================================= -->
7214 <h3>
7215   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7216 </h3>
7217
7218 <div>
7219
7220 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7221
7222 <!-- _______________________________________________________________________ -->
7223 <h4>
7224   <a name="int_sadd_overflow">
7225     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7226   </a>
7227 </h4>
7228
7229 <div>
7230
7231 <h5>Syntax:</h5>
7232 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7233    on any integer bit width.</p>
7234
7235 <pre>
7236   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7237   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7238   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7239 </pre>
7240
7241 <h5>Overview:</h5>
7242 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7243    a signed addition of the two arguments, and indicate whether an overflow
7244    occurred during the signed summation.</p>
7245
7246 <h5>Arguments:</h5>
7247 <p>The arguments (%a and %b) and the first element of the result structure may
7248    be of integer types of any bit width, but they must have the same bit
7249    width. The second element of the result structure must be of
7250    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7251    undergo signed addition.</p>
7252
7253 <h5>Semantics:</h5>
7254 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7255    a signed addition of the two variables. They return a structure &mdash; the
7256    first element of which is the signed summation, and the second element of
7257    which is a bit specifying if the signed summation resulted in an
7258    overflow.</p>
7259
7260 <h5>Examples:</h5>
7261 <pre>
7262   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7263   %sum = extractvalue {i32, i1} %res, 0
7264   %obit = extractvalue {i32, i1} %res, 1
7265   br i1 %obit, label %overflow, label %normal
7266 </pre>
7267
7268 </div>
7269
7270 <!-- _______________________________________________________________________ -->
7271 <h4>
7272   <a name="int_uadd_overflow">
7273     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7274   </a>
7275 </h4>
7276
7277 <div>
7278
7279 <h5>Syntax:</h5>
7280 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7281    on any integer bit width.</p>
7282
7283 <pre>
7284   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7285   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7286   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7287 </pre>
7288
7289 <h5>Overview:</h5>
7290 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7291    an unsigned addition of the two arguments, and indicate whether a carry
7292    occurred during the unsigned summation.</p>
7293
7294 <h5>Arguments:</h5>
7295 <p>The arguments (%a and %b) and the first element of the result structure may
7296    be of integer types of any bit width, but they must have the same bit
7297    width. The second element of the result structure must be of
7298    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7299    undergo unsigned addition.</p>
7300
7301 <h5>Semantics:</h5>
7302 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7303    an unsigned addition of the two arguments. They return a structure &mdash;
7304    the first element of which is the sum, and the second element of which is a
7305    bit specifying if the unsigned summation resulted in a carry.</p>
7306
7307 <h5>Examples:</h5>
7308 <pre>
7309   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7310   %sum = extractvalue {i32, i1} %res, 0
7311   %obit = extractvalue {i32, i1} %res, 1
7312   br i1 %obit, label %carry, label %normal
7313 </pre>
7314
7315 </div>
7316
7317 <!-- _______________________________________________________________________ -->
7318 <h4>
7319   <a name="int_ssub_overflow">
7320     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7321   </a>
7322 </h4>
7323
7324 <div>
7325
7326 <h5>Syntax:</h5>
7327 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7328    on any integer bit width.</p>
7329
7330 <pre>
7331   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7332   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7333   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7334 </pre>
7335
7336 <h5>Overview:</h5>
7337 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7338    a signed subtraction of the two arguments, and indicate whether an overflow
7339    occurred during the signed subtraction.</p>
7340
7341 <h5>Arguments:</h5>
7342 <p>The arguments (%a and %b) and the first element of the result structure may
7343    be of integer types of any bit width, but they must have the same bit
7344    width. The second element of the result structure must be of
7345    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7346    undergo signed subtraction.</p>
7347
7348 <h5>Semantics:</h5>
7349 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7350    a signed subtraction of the two arguments. They return a structure &mdash;
7351    the first element of which is the subtraction, and the second element of
7352    which is a bit specifying if the signed subtraction resulted in an
7353    overflow.</p>
7354
7355 <h5>Examples:</h5>
7356 <pre>
7357   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7358   %sum = extractvalue {i32, i1} %res, 0
7359   %obit = extractvalue {i32, i1} %res, 1
7360   br i1 %obit, label %overflow, label %normal
7361 </pre>
7362
7363 </div>
7364
7365 <!-- _______________________________________________________________________ -->
7366 <h4>
7367   <a name="int_usub_overflow">
7368     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7369   </a>
7370 </h4>
7371
7372 <div>
7373
7374 <h5>Syntax:</h5>
7375 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7376    on any integer bit width.</p>
7377
7378 <pre>
7379   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7380   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7381   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7382 </pre>
7383
7384 <h5>Overview:</h5>
7385 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7386    an unsigned subtraction of the two arguments, and indicate whether an
7387    overflow occurred during the unsigned subtraction.</p>
7388
7389 <h5>Arguments:</h5>
7390 <p>The arguments (%a and %b) and the first element of the result structure may
7391    be of integer types of any bit width, but they must have the same bit
7392    width. The second element of the result structure must be of
7393    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7394    undergo unsigned subtraction.</p>
7395
7396 <h5>Semantics:</h5>
7397 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7398    an unsigned subtraction of the two arguments. They return a structure &mdash;
7399    the first element of which is the subtraction, and the second element of
7400    which is a bit specifying if the unsigned subtraction resulted in an
7401    overflow.</p>
7402
7403 <h5>Examples:</h5>
7404 <pre>
7405   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7406   %sum = extractvalue {i32, i1} %res, 0
7407   %obit = extractvalue {i32, i1} %res, 1
7408   br i1 %obit, label %overflow, label %normal
7409 </pre>
7410
7411 </div>
7412
7413 <!-- _______________________________________________________________________ -->
7414 <h4>
7415   <a name="int_smul_overflow">
7416     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7417   </a>
7418 </h4>
7419
7420 <div>
7421
7422 <h5>Syntax:</h5>
7423 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7424    on any integer bit width.</p>
7425
7426 <pre>
7427   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7428   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7429   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7430 </pre>
7431
7432 <h5>Overview:</h5>
7433
7434 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7435    a signed multiplication of the two arguments, and indicate whether an
7436    overflow occurred during the signed multiplication.</p>
7437
7438 <h5>Arguments:</h5>
7439 <p>The arguments (%a and %b) and the first element of the result structure may
7440    be of integer types of any bit width, but they must have the same bit
7441    width. The second element of the result structure must be of
7442    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7443    undergo signed multiplication.</p>
7444
7445 <h5>Semantics:</h5>
7446 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7447    a signed multiplication of the two arguments. They return a structure &mdash;
7448    the first element of which is the multiplication, and the second element of
7449    which is a bit specifying if the signed multiplication resulted in an
7450    overflow.</p>
7451
7452 <h5>Examples:</h5>
7453 <pre>
7454   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7455   %sum = extractvalue {i32, i1} %res, 0
7456   %obit = extractvalue {i32, i1} %res, 1
7457   br i1 %obit, label %overflow, label %normal
7458 </pre>
7459
7460 </div>
7461
7462 <!-- _______________________________________________________________________ -->
7463 <h4>
7464   <a name="int_umul_overflow">
7465     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7466   </a>
7467 </h4>
7468
7469 <div>
7470
7471 <h5>Syntax:</h5>
7472 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7473    on any integer bit width.</p>
7474
7475 <pre>
7476   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7477   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7478   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7479 </pre>
7480
7481 <h5>Overview:</h5>
7482 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7483    a unsigned multiplication of the two arguments, and indicate whether an
7484    overflow occurred during the unsigned multiplication.</p>
7485
7486 <h5>Arguments:</h5>
7487 <p>The arguments (%a and %b) and the first element of the result structure may
7488    be of integer types of any bit width, but they must have the same bit
7489    width. The second element of the result structure must be of
7490    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7491    undergo unsigned multiplication.</p>
7492
7493 <h5>Semantics:</h5>
7494 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7495    an unsigned multiplication of the two arguments. They return a structure
7496    &mdash; the first element of which is the multiplication, and the second
7497    element of which is a bit specifying if the unsigned multiplication resulted
7498    in an overflow.</p>
7499
7500 <h5>Examples:</h5>
7501 <pre>
7502   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7503   %sum = extractvalue {i32, i1} %res, 0
7504   %obit = extractvalue {i32, i1} %res, 1
7505   br i1 %obit, label %overflow, label %normal
7506 </pre>
7507
7508 </div>
7509
7510 </div>
7511
7512 <!-- ======================================================================= -->
7513 <h3>
7514   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7515 </h3>
7516
7517 <div>
7518
7519 <p>Half precision floating point is a storage-only format. This means that it is
7520    a dense encoding (in memory) but does not support computation in the
7521    format.</p>
7522
7523 <p>This means that code must first load the half-precision floating point
7524    value as an i16, then convert it to float with <a
7525    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7526    Computation can then be performed on the float value (including extending to
7527    double etc).  To store the value back to memory, it is first converted to
7528    float if needed, then converted to i16 with
7529    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7530    storing as an i16 value.</p>
7531
7532 <!-- _______________________________________________________________________ -->
7533 <h4>
7534   <a name="int_convert_to_fp16">
7535     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7536   </a>
7537 </h4>
7538
7539 <div>
7540
7541 <h5>Syntax:</h5>
7542 <pre>
7543   declare i16 @llvm.convert.to.fp16(f32 %a)
7544 </pre>
7545
7546 <h5>Overview:</h5>
7547 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7548    a conversion from single precision floating point format to half precision
7549    floating point format.</p>
7550
7551 <h5>Arguments:</h5>
7552 <p>The intrinsic function contains single argument - the value to be
7553    converted.</p>
7554
7555 <h5>Semantics:</h5>
7556 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7557    a conversion from single precision floating point format to half precision
7558    floating point format. The return value is an <tt>i16</tt> which
7559    contains the converted number.</p>
7560
7561 <h5>Examples:</h5>
7562 <pre>
7563   %res = call i16 @llvm.convert.to.fp16(f32 %a)
7564   store i16 %res, i16* @x, align 2
7565 </pre>
7566
7567 </div>
7568
7569 <!-- _______________________________________________________________________ -->
7570 <h4>
7571   <a name="int_convert_from_fp16">
7572     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
7573   </a>
7574 </h4>
7575
7576 <div>
7577
7578 <h5>Syntax:</h5>
7579 <pre>
7580   declare f32 @llvm.convert.from.fp16(i16 %a)
7581 </pre>
7582
7583 <h5>Overview:</h5>
7584 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
7585    a conversion from half precision floating point format to single precision
7586    floating point format.</p>
7587
7588 <h5>Arguments:</h5>
7589 <p>The intrinsic function contains single argument - the value to be
7590    converted.</p>
7591
7592 <h5>Semantics:</h5>
7593 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
7594    conversion from half single precision floating point format to single
7595    precision floating point format. The input half-float value is represented by
7596    an <tt>i16</tt> value.</p>
7597
7598 <h5>Examples:</h5>
7599 <pre>
7600   %a = load i16* @x, align 2
7601   %res = call f32 @llvm.convert.from.fp16(i16 %a)
7602 </pre>
7603
7604 </div>
7605
7606 </div>
7607
7608 <!-- ======================================================================= -->
7609 <h3>
7610   <a name="int_debugger">Debugger Intrinsics</a>
7611 </h3>
7612
7613 <div>
7614
7615 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
7616    prefix), are described in
7617    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
7618    Level Debugging</a> document.</p>
7619
7620 </div>
7621
7622 <!-- ======================================================================= -->
7623 <h3>
7624   <a name="int_eh">Exception Handling Intrinsics</a>
7625 </h3>
7626
7627 <div>
7628
7629 <p>The LLVM exception handling intrinsics (which all start with
7630    <tt>llvm.eh.</tt> prefix), are described in
7631    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
7632    Handling</a> document.</p>
7633
7634 </div>
7635
7636 <!-- ======================================================================= -->
7637 <h3>
7638   <a name="int_trampoline">Trampoline Intrinsic</a>
7639 </h3>
7640
7641 <div>
7642
7643 <p>This intrinsic makes it possible to excise one parameter, marked with
7644    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
7645    The result is a callable
7646    function pointer lacking the nest parameter - the caller does not need to
7647    provide a value for it.  Instead, the value to use is stored in advance in a
7648    "trampoline", a block of memory usually allocated on the stack, which also
7649    contains code to splice the nest value into the argument list.  This is used
7650    to implement the GCC nested function address extension.</p>
7651
7652 <p>For example, if the function is
7653    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
7654    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
7655    follows:</p>
7656
7657 <pre class="doc_code">
7658   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
7659   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
7660   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
7661   %fp = bitcast i8* %p to i32 (i32, i32)*
7662 </pre>
7663
7664 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
7665    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
7666
7667 <!-- _______________________________________________________________________ -->
7668 <h4>
7669   <a name="int_it">
7670     '<tt>llvm.init.trampoline</tt>' Intrinsic
7671   </a>
7672 </h4>
7673
7674 <div>
7675
7676 <h5>Syntax:</h5>
7677 <pre>
7678   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7679 </pre>
7680
7681 <h5>Overview:</h5>
7682 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
7683    function pointer suitable for executing it.</p>
7684
7685 <h5>Arguments:</h5>
7686 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7687    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7688    sufficiently aligned block of memory; this memory is written to by the
7689    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7690    currently provides no portable way of determining them, so a front-end that
7691    generates this intrinsic needs to have some target-specific knowledge.
7692    The <tt>func</tt> argument must hold a function bitcast to
7693    an <tt>i8*</tt>.</p>
7694
7695 <h5>Semantics:</h5>
7696 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7697    dependent code, turning it into a function.  A pointer to this function is
7698    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
7699    function pointer type</a> before being called.  The new function's signature
7700    is the same as that of <tt>func</tt> with any arguments marked with
7701    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
7702    is allowed, and it must be of pointer type.  Calling the new function is
7703    equivalent to calling <tt>func</tt> with the same argument list, but
7704    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7705    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7706    by <tt>tramp</tt> is modified, then the effect of any later call to the
7707    returned function pointer is undefined.</p>
7708
7709 </div>
7710
7711 </div>
7712
7713 <!-- ======================================================================= -->
7714 <h3>
7715   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7716 </h3>
7717
7718 <div>
7719
7720 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7721    hardware constructs for atomic operations and memory synchronization.  This
7722    provides an interface to the hardware, not an interface to the programmer. It
7723    is aimed at a low enough level to allow any programming models or APIs
7724    (Application Programming Interfaces) which need atomic behaviors to map
7725    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7726    hardware provides a "universal IR" for source languages, it also provides a
7727    starting point for developing a "universal" atomic operation and
7728    synchronization IR.</p>
7729
7730 <p>These do <em>not</em> form an API such as high-level threading libraries,
7731    software transaction memory systems, atomic primitives, and intrinsic
7732    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7733    application libraries.  The hardware interface provided by LLVM should allow
7734    a clean implementation of all of these APIs and parallel programming models.
7735    No one model or paradigm should be selected above others unless the hardware
7736    itself ubiquitously does so.</p>
7737
7738 <!-- _______________________________________________________________________ -->
7739 <h4>
7740   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7741 </h4>
7742
7743 <div>
7744 <h5>Syntax:</h5>
7745 <pre>
7746   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;)
7747 </pre>
7748
7749 <h5>Overview:</h5>
7750 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7751    specific pairs of memory access types.</p>
7752
7753 <h5>Arguments:</h5>
7754 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7755    The first four arguments enables a specific barrier as listed below.  The
7756    fifth argument specifies that the barrier applies to io or device or uncached
7757    memory.</p>
7758
7759 <ul>
7760   <li><tt>ll</tt>: load-load barrier</li>
7761   <li><tt>ls</tt>: load-store barrier</li>
7762   <li><tt>sl</tt>: store-load barrier</li>
7763   <li><tt>ss</tt>: store-store barrier</li>
7764   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7765 </ul>
7766
7767 <h5>Semantics:</h5>
7768 <p>This intrinsic causes the system to enforce some ordering constraints upon
7769    the loads and stores of the program. This barrier does not
7770    indicate <em>when</em> any events will occur, it only enforces
7771    an <em>order</em> in which they occur. For any of the specified pairs of load
7772    and store operations (f.ex.  load-load, or store-load), all of the first
7773    operations preceding the barrier will complete before any of the second
7774    operations succeeding the barrier begin. Specifically the semantics for each
7775    pairing is as follows:</p>
7776
7777 <ul>
7778   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7779       after the barrier begins.</li>
7780   <li><tt>ls</tt>: All loads before the barrier must complete before any
7781       store after the barrier begins.</li>
7782   <li><tt>ss</tt>: All stores before the barrier must complete before any
7783       store after the barrier begins.</li>
7784   <li><tt>sl</tt>: All stores before the barrier must complete before any
7785       load after the barrier begins.</li>
7786 </ul>
7787
7788 <p>These semantics are applied with a logical "and" behavior when more than one
7789    is enabled in a single memory barrier intrinsic.</p>
7790
7791 <p>Backends may implement stronger barriers than those requested when they do
7792    not support as fine grained a barrier as requested.  Some architectures do
7793    not need all types of barriers and on such architectures, these become
7794    noops.</p>
7795
7796 <h5>Example:</h5>
7797 <pre>
7798 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7799 %ptr      = bitcast i8* %mallocP to i32*
7800             store i32 4, %ptr
7801
7802 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7803             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false, i1 true)
7804                                 <i>; guarantee the above finishes</i>
7805             store i32 8, %ptr   <i>; before this begins</i>
7806 </pre>
7807
7808 </div>
7809
7810 <!-- _______________________________________________________________________ -->
7811 <h4>
7812   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7813 </h4>
7814
7815 <div>
7816
7817 <h5>Syntax:</h5>
7818 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7819    any integer bit width and for different address spaces. Not all targets
7820    support all bit widths however.</p>
7821
7822 <pre>
7823   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7824   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7825   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7826   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7827 </pre>
7828
7829 <h5>Overview:</h5>
7830 <p>This loads a value in memory and compares it to a given value. If they are
7831    equal, it stores a new value into the memory.</p>
7832
7833 <h5>Arguments:</h5>
7834 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7835    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7836    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7837    this integer type. While any bit width integer may be used, targets may only
7838    lower representations they support in hardware.</p>
7839
7840 <h5>Semantics:</h5>
7841 <p>This entire intrinsic must be executed atomically. It first loads the value
7842    in memory pointed to by <tt>ptr</tt> and compares it with the
7843    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7844    memory. The loaded value is yielded in all cases. This provides the
7845    equivalent of an atomic compare-and-swap operation within the SSA
7846    framework.</p>
7847
7848 <h5>Examples:</h5>
7849 <pre>
7850 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7851 %ptr      = bitcast i8* %mallocP to i32*
7852             store i32 4, %ptr
7853
7854 %val1     = add i32 4, 4
7855 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7856                                           <i>; yields {i32}:result1 = 4</i>
7857 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7858 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7859
7860 %val2     = add i32 1, 1
7861 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7862                                           <i>; yields {i32}:result2 = 8</i>
7863 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7864
7865 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7866 </pre>
7867
7868 </div>
7869
7870 <!-- _______________________________________________________________________ -->
7871 <h4>
7872   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7873 </h4>
7874
7875 <div>
7876 <h5>Syntax:</h5>
7877
7878 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7879    integer bit width. Not all targets support all bit widths however.</p>
7880
7881 <pre>
7882   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7883   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7884   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7885   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7886 </pre>
7887
7888 <h5>Overview:</h5>
7889 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7890    the value from memory. It then stores the value in <tt>val</tt> in the memory
7891    at <tt>ptr</tt>.</p>
7892
7893 <h5>Arguments:</h5>
7894 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7895   the <tt>val</tt> argument and the result must be integers of the same bit
7896   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7897   integer type. The targets may only lower integer representations they
7898   support.</p>
7899
7900 <h5>Semantics:</h5>
7901 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7902    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7903    equivalent of an atomic swap operation within the SSA framework.</p>
7904
7905 <h5>Examples:</h5>
7906 <pre>
7907 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7908 %ptr      = bitcast i8* %mallocP to i32*
7909             store i32 4, %ptr
7910
7911 %val1     = add i32 4, 4
7912 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7913                                         <i>; yields {i32}:result1 = 4</i>
7914 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7915 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7916
7917 %val2     = add i32 1, 1
7918 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7919                                         <i>; yields {i32}:result2 = 8</i>
7920
7921 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7922 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7923 </pre>
7924
7925 </div>
7926
7927 <!-- _______________________________________________________________________ -->
7928 <h4>
7929   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7930 </h4>
7931
7932 <div>
7933
7934 <h5>Syntax:</h5>
7935 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7936    any integer bit width. Not all targets support all bit widths however.</p>
7937
7938 <pre>
7939   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7940   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7941   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7942   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7943 </pre>
7944
7945 <h5>Overview:</h5>
7946 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7947    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7948
7949 <h5>Arguments:</h5>
7950 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7951    and the second an integer value. The result is also an integer value. These
7952    integer types can have any bit width, but they must all have the same bit
7953    width. The targets may only lower integer representations they support.</p>
7954
7955 <h5>Semantics:</h5>
7956 <p>This intrinsic does a series of operations atomically. It first loads the
7957    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7958    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7959
7960 <h5>Examples:</h5>
7961 <pre>
7962 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7963 %ptr      = bitcast i8* %mallocP to i32*
7964             store i32 4, %ptr
7965 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7966                                 <i>; yields {i32}:result1 = 4</i>
7967 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7968                                 <i>; yields {i32}:result2 = 8</i>
7969 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7970                                 <i>; yields {i32}:result3 = 10</i>
7971 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7972 </pre>
7973
7974 </div>
7975
7976 <!-- _______________________________________________________________________ -->
7977 <h4>
7978   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
7979 </h4>
7980
7981 <div>
7982
7983 <h5>Syntax:</h5>
7984 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
7985    any integer bit width and for different address spaces. Not all targets
7986    support all bit widths however.</p>
7987
7988 <pre>
7989   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7990   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7991   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7992   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7993 </pre>
7994
7995 <h5>Overview:</h5>
7996 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
7997    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7998
7999 <h5>Arguments:</h5>
8000 <p>The intrinsic takes two arguments, the first a pointer to an integer value
8001    and the second an integer value. The result is also an integer value. These
8002    integer types can have any bit width, but they must all have the same bit
8003    width. The targets may only lower integer representations they support.</p>
8004
8005 <h5>Semantics:</h5>
8006 <p>This intrinsic does a series of operations atomically. It first loads the
8007    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
8008    result to <tt>ptr</tt>. It yields the original value stored
8009    at <tt>ptr</tt>.</p>
8010
8011 <h5>Examples:</h5>
8012 <pre>
8013 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8014 %ptr      = bitcast i8* %mallocP to i32*
8015             store i32 8, %ptr
8016 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
8017                                 <i>; yields {i32}:result1 = 8</i>
8018 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
8019                                 <i>; yields {i32}:result2 = 4</i>
8020 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
8021                                 <i>; yields {i32}:result3 = 2</i>
8022 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
8023 </pre>
8024
8025 </div>
8026
8027 <!-- _______________________________________________________________________ -->
8028 <h4>
8029   <a name="int_atomic_load_and">
8030     '<tt>llvm.atomic.load.and.*</tt>' Intrinsic
8031   </a>
8032   <br>
8033   <a name="int_atomic_load_nand">
8034     '<tt>llvm.atomic.load.nand.*</tt>' Intrinsic
8035   </a>
8036   <br>
8037   <a name="int_atomic_load_or">
8038     '<tt>llvm.atomic.load.or.*</tt>' Intrinsic
8039   </a>
8040   <br>
8041   <a name="int_atomic_load_xor">
8042     '<tt>llvm.atomic.load.xor.*</tt>' Intrinsic
8043   </a>
8044 </h4>
8045
8046 <div>
8047
8048 <h5>Syntax:</h5>
8049 <p>These are overloaded intrinsics. You can
8050   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
8051   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
8052   bit width and for different address spaces. Not all targets support all bit
8053   widths however.</p>
8054
8055 <pre>
8056   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8057   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8058   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8059   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8060 </pre>
8061
8062 <pre>
8063   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8064   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8065   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8066   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8067 </pre>
8068
8069 <pre>
8070   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8071   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8072   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8073   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8074 </pre>
8075
8076 <pre>
8077   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8078   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8079   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8080   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8081 </pre>
8082
8083 <h5>Overview:</h5>
8084 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
8085    the value stored in memory at <tt>ptr</tt>. It yields the original value
8086    at <tt>ptr</tt>.</p>
8087
8088 <h5>Arguments:</h5>
8089 <p>These intrinsics take two arguments, the first a pointer to an integer value
8090    and the second an integer value. The result is also an integer value. These
8091    integer types can have any bit width, but they must all have the same bit
8092    width. The targets may only lower integer representations they support.</p>
8093
8094 <h5>Semantics:</h5>
8095 <p>These intrinsics does a series of operations atomically. They first load the
8096    value stored at <tt>ptr</tt>. They then do the bitwise
8097    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
8098    original value stored at <tt>ptr</tt>.</p>
8099
8100 <h5>Examples:</h5>
8101 <pre>
8102 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8103 %ptr      = bitcast i8* %mallocP to i32*
8104             store i32 0x0F0F, %ptr
8105 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
8106                                 <i>; yields {i32}:result0 = 0x0F0F</i>
8107 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
8108                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
8109 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
8110                                 <i>; yields {i32}:result2 = 0xF0</i>
8111 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
8112                                 <i>; yields {i32}:result3 = FF</i>
8113 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
8114 </pre>
8115
8116 </div>
8117
8118 <!-- _______________________________________________________________________ -->
8119 <h4>
8120   <a name="int_atomic_load_max">
8121     '<tt>llvm.atomic.load.max.*</tt>' Intrinsic
8122   </a>
8123   <br>
8124   <a name="int_atomic_load_min">
8125     '<tt>llvm.atomic.load.min.*</tt>' Intrinsic
8126   </a>
8127   <br>
8128   <a name="int_atomic_load_umax">
8129     '<tt>llvm.atomic.load.umax.*</tt>' Intrinsic
8130   </a>
8131   <br>
8132   <a name="int_atomic_load_umin">
8133     '<tt>llvm.atomic.load.umin.*</tt>' Intrinsic
8134   </a>
8135 </h4>
8136
8137 <div>
8138
8139 <h5>Syntax:</h5>
8140 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
8141    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
8142    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
8143    address spaces. Not all targets support all bit widths however.</p>
8144
8145 <pre>
8146   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8147   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8148   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8149   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8150 </pre>
8151
8152 <pre>
8153   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8154   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8155   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8156   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8157 </pre>
8158
8159 <pre>
8160   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8161   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8162   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8163   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8164 </pre>
8165
8166 <pre>
8167   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
8168   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
8169   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
8170   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
8171 </pre>
8172
8173 <h5>Overview:</h5>
8174 <p>These intrinsics takes the signed or unsigned minimum or maximum of
8175    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
8176    original value at <tt>ptr</tt>.</p>
8177
8178 <h5>Arguments:</h5>
8179 <p>These intrinsics take two arguments, the first a pointer to an integer value
8180    and the second an integer value. The result is also an integer value. These
8181    integer types can have any bit width, but they must all have the same bit
8182    width. The targets may only lower integer representations they support.</p>
8183
8184 <h5>Semantics:</h5>
8185 <p>These intrinsics does a series of operations atomically. They first load the
8186    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
8187    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
8188    yield the original value stored at <tt>ptr</tt>.</p>
8189
8190 <h5>Examples:</h5>
8191 <pre>
8192 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
8193 %ptr      = bitcast i8* %mallocP to i32*
8194             store i32 7, %ptr
8195 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
8196                                 <i>; yields {i32}:result0 = 7</i>
8197 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
8198                                 <i>; yields {i32}:result1 = -2</i>
8199 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
8200                                 <i>; yields {i32}:result2 = 8</i>
8201 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
8202                                 <i>; yields {i32}:result3 = 8</i>
8203 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
8204 </pre>
8205
8206 </div>
8207
8208 </div>
8209
8210 <!-- ======================================================================= -->
8211 <h3>
8212   <a name="int_memorymarkers">Memory Use Markers</a>
8213 </h3>
8214
8215 <div>
8216
8217 <p>This class of intrinsics exists to information about the lifetime of memory
8218    objects and ranges where variables are immutable.</p>
8219
8220 <!-- _______________________________________________________________________ -->
8221 <h4>
8222   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
8223 </h4>
8224
8225 <div>
8226
8227 <h5>Syntax:</h5>
8228 <pre>
8229   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8230 </pre>
8231
8232 <h5>Overview:</h5>
8233 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
8234    object's lifetime.</p>
8235
8236 <h5>Arguments:</h5>
8237 <p>The first argument is a constant integer representing the size of the
8238    object, or -1 if it is variable sized.  The second argument is a pointer to
8239    the object.</p>
8240
8241 <h5>Semantics:</h5>
8242 <p>This intrinsic indicates that before this point in the code, the value of the
8243    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8244    never be used and has an undefined value.  A load from the pointer that
8245    precedes this intrinsic can be replaced with
8246    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
8247
8248 </div>
8249
8250 <!-- _______________________________________________________________________ -->
8251 <h4>
8252   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
8253 </h4>
8254
8255 <div>
8256
8257 <h5>Syntax:</h5>
8258 <pre>
8259   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8260 </pre>
8261
8262 <h5>Overview:</h5>
8263 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
8264    object's lifetime.</p>
8265
8266 <h5>Arguments:</h5>
8267 <p>The first argument is a constant integer representing the size of the
8268    object, or -1 if it is variable sized.  The second argument is a pointer to
8269    the object.</p>
8270
8271 <h5>Semantics:</h5>
8272 <p>This intrinsic indicates that after this point in the code, the value of the
8273    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8274    never be used and has an undefined value.  Any stores into the memory object
8275    following this intrinsic may be removed as dead.
8276
8277 </div>
8278
8279 <!-- _______________________________________________________________________ -->
8280 <h4>
8281   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
8282 </h4>
8283
8284 <div>
8285
8286 <h5>Syntax:</h5>
8287 <pre>
8288   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8289 </pre>
8290
8291 <h5>Overview:</h5>
8292 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
8293    a memory object will not change.</p>
8294
8295 <h5>Arguments:</h5>
8296 <p>The first argument is a constant integer representing the size of the
8297    object, or -1 if it is variable sized.  The second argument is a pointer to
8298    the object.</p>
8299
8300 <h5>Semantics:</h5>
8301 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8302    the return value, the referenced memory location is constant and
8303    unchanging.</p>
8304
8305 </div>
8306
8307 <!-- _______________________________________________________________________ -->
8308 <h4>
8309   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8310 </h4>
8311
8312 <div>
8313
8314 <h5>Syntax:</h5>
8315 <pre>
8316   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8317 </pre>
8318
8319 <h5>Overview:</h5>
8320 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8321    a memory object are mutable.</p>
8322
8323 <h5>Arguments:</h5>
8324 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8325    The second argument is a constant integer representing the size of the
8326    object, or -1 if it is variable sized and the third argument is a pointer
8327    to the object.</p>
8328
8329 <h5>Semantics:</h5>
8330 <p>This intrinsic indicates that the memory is mutable again.</p>
8331
8332 </div>
8333
8334 </div>
8335
8336 <!-- ======================================================================= -->
8337 <h3>
8338   <a name="int_general">General Intrinsics</a>
8339 </h3>
8340
8341 <div>
8342
8343 <p>This class of intrinsics is designed to be generic and has no specific
8344    purpose.</p>
8345
8346 <!-- _______________________________________________________________________ -->
8347 <h4>
8348   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8349 </h4>
8350
8351 <div>
8352
8353 <h5>Syntax:</h5>
8354 <pre>
8355   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8356 </pre>
8357
8358 <h5>Overview:</h5>
8359 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8360
8361 <h5>Arguments:</h5>
8362 <p>The first argument is a pointer to a value, the second is a pointer to a
8363    global string, the third is a pointer to a global string which is the source
8364    file name, and the last argument is the line number.</p>
8365
8366 <h5>Semantics:</h5>
8367 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8368    This can be useful for special purpose optimizations that want to look for
8369    these annotations.  These have no other defined use, they are ignored by code
8370    generation and optimization.</p>
8371
8372 </div>
8373
8374 <!-- _______________________________________________________________________ -->
8375 <h4>
8376   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8377 </h4>
8378
8379 <div>
8380
8381 <h5>Syntax:</h5>
8382 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8383    any integer bit width.</p>
8384
8385 <pre>
8386   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8387   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8388   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8389   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8390   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8391 </pre>
8392
8393 <h5>Overview:</h5>
8394 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8395
8396 <h5>Arguments:</h5>
8397 <p>The first argument is an integer value (result of some expression), the
8398    second is a pointer to a global string, the third is a pointer to a global
8399    string which is the source file name, and the last argument is the line
8400    number.  It returns the value of the first argument.</p>
8401
8402 <h5>Semantics:</h5>
8403 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8404    arbitrary strings.  This can be useful for special purpose optimizations that
8405    want to look for these annotations.  These have no other defined use, they
8406    are ignored by code generation and optimization.</p>
8407
8408 </div>
8409
8410 <!-- _______________________________________________________________________ -->
8411 <h4>
8412   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8413 </h4>
8414
8415 <div>
8416
8417 <h5>Syntax:</h5>
8418 <pre>
8419   declare void @llvm.trap()
8420 </pre>
8421
8422 <h5>Overview:</h5>
8423 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8424
8425 <h5>Arguments:</h5>
8426 <p>None.</p>
8427
8428 <h5>Semantics:</h5>
8429 <p>This intrinsics is lowered to the target dependent trap instruction. If the
8430    target does not have a trap instruction, this intrinsic will be lowered to
8431    the call of the <tt>abort()</tt> function.</p>
8432
8433 </div>
8434
8435 <!-- _______________________________________________________________________ -->
8436 <h4>
8437   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8438 </h4>
8439
8440 <div>
8441
8442 <h5>Syntax:</h5>
8443 <pre>
8444   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8445 </pre>
8446
8447 <h5>Overview:</h5>
8448 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8449    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8450    ensure that it is placed on the stack before local variables.</p>
8451
8452 <h5>Arguments:</h5>
8453 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8454    arguments. The first argument is the value loaded from the stack
8455    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8456    that has enough space to hold the value of the guard.</p>
8457
8458 <h5>Semantics:</h5>
8459 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8460    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8461    stack. This is to ensure that if a local variable on the stack is
8462    overwritten, it will destroy the value of the guard. When the function exits,
8463    the guard on the stack is checked against the original guard. If they are
8464    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8465    function.</p>
8466
8467 </div>
8468
8469 <!-- _______________________________________________________________________ -->
8470 <h4>
8471   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8472 </h4>
8473
8474 <div>
8475
8476 <h5>Syntax:</h5>
8477 <pre>
8478   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
8479   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
8480 </pre>
8481
8482 <h5>Overview:</h5>
8483 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8484    the optimizers to determine at compile time whether a) an operation (like
8485    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8486    runtime check for overflow isn't necessary. An object in this context means
8487    an allocation of a specific class, structure, array, or other object.</p>
8488
8489 <h5>Arguments:</h5>
8490 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8491    argument is a pointer to or into the <tt>object</tt>. The second argument
8492    is a boolean 0 or 1. This argument determines whether you want the
8493    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
8494    1, variables are not allowed.</p>
8495
8496 <h5>Semantics:</h5>
8497 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
8498    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
8499    depending on the <tt>type</tt> argument, if the size cannot be determined at
8500    compile time.</p>
8501
8502 </div>
8503
8504 </div>
8505
8506 </div>
8507
8508 <!-- *********************************************************************** -->
8509 <hr>
8510 <address>
8511   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8512   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8513   <a href="http://validator.w3.org/check/referer"><img
8514   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8515
8516   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8517   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8518   Last modified: $Date$
8519 </address>
8520
8521 </body>
8522 </html>