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>external</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>
 104         <ol>
 105           <li><a href="#tbaa">'<tt>tbaa</tt>' Metadata</a></li>
 106           <li><a href="#fpaccuracy">'<tt>fpaccuracy</tt>' Metadata</a></li>
 107         </ol>
 108       </li>
 109     </ol>
 110   </li>
 111   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 112     <ol>
 113       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 114       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 115           Global Variable</a></li>
 116       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 117          Global Variable</a></li>
 118       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 119          Global Variable</a></li>
 120     </ol>
 121   </li>
 122   <li><a href="#instref">Instruction Reference</a>
 123     <ol>
 124       <li><a href="#terminators">Terminator Instructions</a>
 125         <ol>
 126           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 127           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 128           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 129           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 130           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 131           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
 132           <li><a href="#i_resume">'<tt>resume</tt>'  Instruction</a></li>
 133           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 134         </ol>
 135       </li>
 136       <li><a href="#binaryops">Binary Operations</a>
 137         <ol>
 138           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 139           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 140           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 141           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 142           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 143           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 144           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 145           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 146           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 147           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 148           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 149           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 150         </ol>
 151       </li>
 152       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 153         <ol>
 154           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 155           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 156           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 157           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 158           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 159           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 160         </ol>
 161       </li>
 162       <li><a href="#vectorops">Vector Operations</a>
 163         <ol>
 164           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 165           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 166           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 167         </ol>
 168       </li>
 169       <li><a href="#aggregateops">Aggregate Operations</a>
 170         <ol>
 171           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 172           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 173         </ol>
 174       </li>
 175       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 176         <ol>
 177           <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
 178          <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
 179          <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
 180          <li><a href="#i_fence">'<tt>fence</tt>' Instruction</a></li>
 181          <li><a href="#i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a></li>
 182          <li><a href="#i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a></li>
 183          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 184         </ol>
 185       </li>
 186       <li><a href="#convertops">Conversion Operations</a>
 187         <ol>
 188           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 191           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 192           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 193           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 194           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 195           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 196           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 197           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 198           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 199           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 200         </ol>
 201       </li>
 202       <li><a href="#otherops">Other Operations</a>
 203         <ol>
 204           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 205           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 206           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 207           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 208           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 209           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 210           <li><a href="#i_landingpad">'<tt>landingpad</tt>' Instruction</a></li>
 211         </ol>
 212       </li>
 213     </ol>
 214   </li>
 215   <li><a href="#intrinsics">Intrinsic Functions</a>
 216     <ol>
 217       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 218         <ol>
 219           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 220           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 221           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 222         </ol>
 223       </li>
 224       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 225         <ol>
 226           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 227           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 228           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 229         </ol>
 230       </li>
 231       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 232         <ol>
 233           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 234           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 235           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 236           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 237           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 238           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 239           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 240         </ol>
 241       </li>
 242       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 243         <ol>
 244           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 245           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 246           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 247           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 248           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 249           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 250           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 251           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 252           <li><a href="#int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a></li>
 253           <li><a href="#int_log">'<tt>llvm.log.*</tt>' Intrinsic</a></li>
 254           <li><a href="#int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a></li>
 255         </ol>
 256       </li>
 257       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 258         <ol>
 259           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 260           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 261           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 262           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 263         </ol>
 264       </li>
 265       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 266         <ol>
 267           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 268           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 269           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 270           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 271           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 272           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 273         </ol>
 274       </li>
 275       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 276         <ol>
 277           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 278           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 279         </ol>
 280       </li>
 281       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 282       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 283       <li><a href="#int_trampoline">Trampoline Intrinsics</a>
 284         <ol>
 285           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 286           <li><a href="#int_at">'<tt>llvm.adjust.trampoline</tt>' Intrinsic</a></li>
 287         </ol>
 288       </li>
 289       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 290         <ol>
 291           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 292           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 293           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 294           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 295         </ol>
 296       </li>
 297       <li><a href="#int_general">General intrinsics</a>
 298         <ol>
 299           <li><a href="#int_var_annotation">
 300             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 301           <li><a href="#int_annotation">
 302             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 303           <li><a href="#int_trap">
 304             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 305           <li><a href="#int_stackprotector">
 306             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 307           <li><a href="#int_objectsize">
 308             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 309         </ol>
 310       </li>
 311     </ol>
 312   </li>
 313 </ol>
 314
 315 <div class="doc_author">
 316   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 317             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 318 </div>
 319
 320 <!-- *********************************************************************** -->
 321 <h2><a name="abstract">Abstract</a></h2>
 322 <!-- *********************************************************************** -->
 323
 324 <div>
 325
 326 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 327    a Static Single Assignment (SSA) based representation that provides type
 328    safety, low-level operations, flexibility, and the capability of representing
 329    'all' high-level languages cleanly.  It is the common code representation
 330    used throughout all phases of the LLVM compilation strategy.</p>
 331
 332 </div>
 333
 334 <!-- *********************************************************************** -->
 335 <h2><a name="introduction">Introduction</a></h2>
 336 <!-- *********************************************************************** -->
 337
 338 <div>
 339
 340 <p>The LLVM code representation is designed to be used in three different forms:
 341    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 342    for fast loading by a Just-In-Time compiler), and as a human readable
 343    assembly language representation.  This allows LLVM to provide a powerful
 344    intermediate representation for efficient compiler transformations and
 345    analysis, while providing a natural means to debug and visualize the
 346    transformations.  The three different forms of LLVM are all equivalent.  This
 347    document describes the human readable representation and notation.</p>
 348
 349 <p>The LLVM representation aims to be light-weight and low-level while being
 350    expressive, typed, and extensible at the same time.  It aims to be a
 351    "universal IR" of sorts, by being at a low enough level that high-level ideas
 352    may be cleanly mapped to it (similar to how microprocessors are "universal
 353    IR's", allowing many source languages to be mapped to them).  By providing
 354    type information, LLVM can be used as the target of optimizations: for
 355    example, through pointer analysis, it can be proven that a C automatic
 356    variable is never accessed outside of the current function, allowing it to
 357    be promoted to a simple SSA value instead of a memory location.</p>
 358
 359 <!-- _______________________________________________________________________ -->
 360 <h4>
 361   <a name="wellformed">Well-Formedness</a>
 362 </h4>
 363
 364 <div>
 365
 366 <p>It is important to note that this document describes 'well formed' LLVM
 367    assembly language.  There is a difference between what the parser accepts and
 368    what is considered 'well formed'.  For example, the following instruction is
 369    syntactically okay, but not well formed:</p>
 370
 371 <pre class="doc_code">
 372 %x = <a href="#i_add">add</a> i32 1, %x
 373 </pre>
 374
 375 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 376    LLVM infrastructure provides a verification pass that may be used to verify
 377    that an LLVM module is well formed.  This pass is automatically run by the
 378    parser after parsing input assembly and by the optimizer before it outputs
 379    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 380    transformation passes or input to the parser.</p>
 381
 382 </div>
 383
 384 </div>
 385
 386 <!-- Describe the typesetting conventions here. -->
 387
 388 <!-- *********************************************************************** -->
 389 <h2><a name="identifiers">Identifiers</a></h2>
 390 <!-- *********************************************************************** -->
 391
 392 <div>
 393
 394 <p>LLVM identifiers come in two basic types: global and local. Global
 395    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 396    character. Local identifiers (register names, types) begin with
 397    the <tt>'%'</tt> character. Additionally, there are three different formats
 398    for identifiers, for different purposes:</p>
 399
 400 <ol>
 401   <li>Named values are represented as a string of characters with their prefix.
 402       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 403       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 404       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 405       other characters in their names can be surrounded with quotes. Special
 406       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 407       ASCII code for the character in hexadecimal.  In this way, any character
 408       can be used in a name value, even quotes themselves.</li>
 409
 410   <li>Unnamed values are represented as an unsigned numeric value with their
 411       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 412
 413   <li>Constants, which are described in a <a href="#constants">section about
 414       constants</a>, below.</li>
 415 </ol>
 416
 417 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 418    don't need to worry about name clashes with reserved words, and the set of
 419    reserved words may be expanded in the future without penalty.  Additionally,
 420    unnamed identifiers allow a compiler to quickly come up with a temporary
 421    variable without having to avoid symbol table conflicts.</p>
 422
 423 <p>Reserved words in LLVM are very similar to reserved words in other
 424    languages. There are keywords for different opcodes
 425    ('<tt><a href="#i_add">add</a></tt>',
 426    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 427    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 428    ('<tt><a href="#t_void">void</a></tt>',
 429    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 430    reserved words cannot conflict with variable names, because none of them
 431    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 432
 433 <p>Here is an example of LLVM code to multiply the integer variable
 434    '<tt>%X</tt>' by 8:</p>
 435
 436 <p>The easy way:</p>
 437
 438 <pre class="doc_code">
 439 %result = <a href="#i_mul">mul</a> i32 %X, 8
 440 </pre>
 441
 442 <p>After strength reduction:</p>
 443
 444 <pre class="doc_code">
 445 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 446 </pre>
 447
 448 <p>And the hard way:</p>
 449
 450 <pre class="doc_code">
 451 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 452 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 453 %result = <a href="#i_add">add</a> i32 %1, %1
 454 </pre>
 455
 456 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 457    lexical features of LLVM:</p>
 458
 459 <ol>
 460   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 461       line.</li>
 462
 463   <li>Unnamed temporaries are created when the result of a computation is not
 464       assigned to a named value.</li>
 465
 466   <li>Unnamed temporaries are numbered sequentially</li>
 467 </ol>
 468
 469 <p>It also shows a convention that we follow in this document.  When
 470    demonstrating instructions, we will follow an instruction with a comment that
 471    defines the type and name of value produced.  Comments are shown in italic
 472    text.</p>
 473
 474 </div>
 475
 476 <!-- *********************************************************************** -->
 477 <h2><a name="highlevel">High Level Structure</a></h2>
 478 <!-- *********************************************************************** -->
 479 <div>
 480 <!-- ======================================================================= -->
 481 <h3>
 482   <a name="modulestructure">Module Structure</a>
 483 </h3>
 484
 485 <div>
 486
 487 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 488    of the input programs.  Each module consists of functions, global variables,
 489    and symbol table entries.  Modules may be combined together with the LLVM
 490    linker, which merges function (and global variable) definitions, resolves
 491    forward declarations, and merges symbol table entries. Here is an example of
 492    the "hello world" module:</p>
 493
 494 <pre class="doc_code">
 495 <i>; Declare the string constant as a global constant.</i>&nbsp;
 496 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"      <i>; [13 x i8]*</i>&nbsp;
 497
 498 <i>; External declaration of the puts function</i>&nbsp;
 499 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 500
 501 <i>; Definition of main function</i>
 502 define i32 @main() {   <i>; i32()* </i>&nbsp;
 503   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 504   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 505
 506   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 507   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 508   <a href="#i_ret">ret</a> i32 0&nbsp;
 509 }
 510
 511 <i>; Named metadata</i>
 512 !1 = metadata !{i32 41}
 513 !foo = !{!1, null}
 514 </pre>
 515
 516 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 517    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 518    a <a href="#functionstructure">function definition</a> for
 519    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 520    "<tt>foo"</tt>.</p>
 521
 522 <p>In general, a module is made up of a list of global values, where both
 523    functions and global variables are global values.  Global values are
 524    represented by a pointer to a memory location (in this case, a pointer to an
 525    array of char, and a pointer to a function), and have one of the
 526    following <a href="#linkage">linkage types</a>.</p>
 527
 528 </div>
 529
 530 <!-- ======================================================================= -->
 531 <h3>
 532   <a name="linkage">Linkage Types</a>
 533 </h3>
 534
 535 <div>
 536
 537 <p>All Global Variables and Functions have one of the following types of
 538    linkage:</p>
 539
 540 <dl>
 541   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 542   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 543       by objects in the current module. In particular, linking code into a
 544       module with an private global value may cause the private to be renamed as
 545       necessary to avoid collisions.  Because the symbol is private to the
 546       module, all references can be updated. This doesn't show up in any symbol
 547       table in the object file.</dd>
 548
 549   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 550   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 551       assembler and evaluated by the linker. Unlike normal strong symbols, they
 552       are removed by the linker from the final linked image (executable or
 553       dynamic library).</dd>
 554
 555   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 556   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 557       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 558       linker. The symbols are removed by the linker from the final linked image
 559       (executable or dynamic library).</dd>
 560
 561   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 562   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 563       of the object is not taken. For instance, functions that had an inline
 564       definition, but the compiler decided not to inline it. Note,
 565       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 566       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 567       visibility.  The symbols are removed by the linker from the final linked
 568       image (executable or dynamic library).</dd>
 569
 570   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 571   <dd>Similar to private, but the value shows as a local symbol
 572       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 573       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 574
 575   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 576   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 577       into the object file corresponding to the LLVM module.  They exist to
 578       allow inlining and other optimizations to take place given knowledge of
 579       the definition of the global, which is known to be somewhere outside the
 580       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 581       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 582       This linkage type is only allowed on definitions, not declarations.</dd>
 583
 584   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 585   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 586       the same name when linkage occurs.  This can be used to implement
 587       some forms of inline functions, templates, or other code which must be
 588       generated in each translation unit that uses it, but where the body may
 589       be overridden with a more definitive definition later.  Unreferenced
 590       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 591       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 592       inline the body of this function into callers because it doesn't know if
 593       this definition of the function is the definitive definition within the
 594       program or whether it will be overridden by a stronger definition.
 595       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 596       linkage.</dd>
 597
 598   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 599   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 600       <tt>linkonce</tt> linkage, except that unreferenced globals with
 601       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 602       are declared "weak" in C source code.</dd>
 603
 604   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 605   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 606       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 607       global scope.
 608       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 609       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 610       <tt>common</tt> symbols may not have an explicit section,
 611       must have a zero initializer, and may not be marked '<a
 612       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 613       have common linkage.</dd>
 614
 615
 616   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 617   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 618       pointer to array type.  When two global variables with appending linkage
 619       are linked together, the two global arrays are appended together.  This is
 620       the LLVM, typesafe, equivalent of having the system linker append together
 621       "sections" with identical names when .o files are linked.</dd>
 622
 623   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 624   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 625       is weak until linked, if not linked, the symbol becomes null instead of
 626       being an undefined reference.</dd>
 627
 628   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 629   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 630   <dd>Some languages allow differing globals to be merged, such as two functions
 631       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 632       that only equivalent globals are ever merged (the "one definition rule"
 633       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 634       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 635       be merged with equivalent globals.  These linkage types are otherwise the
 636       same as their non-<tt>odr</tt> versions.</dd>
 637
 638   <dt><tt><b><a name="linkage_external">external</a></b></tt></dt>
 639   <dd>If none of the above identifiers are used, the global is externally
 640       visible, meaning that it participates in linkage and can be used to
 641       resolve external symbol references.</dd>
 642 </dl>
 643
 644 <p>The next two types of linkage are targeted for Microsoft Windows platform
 645    only. They are designed to support importing (exporting) symbols from (to)
 646    DLLs (Dynamic Link Libraries).</p>
 647
 648 <dl>
 649   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 650   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 651       or variable via a global pointer to a pointer that is set up by the DLL
 652       exporting the symbol. On Microsoft Windows targets, the pointer name is
 653       formed by combining <code>__imp_</code> and the function or variable
 654       name.</dd>
 655
 656   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 657   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 658       pointer to a pointer in a DLL, so that it can be referenced with the
 659       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 660       name is formed by combining <code>__imp_</code> and the function or
 661       variable name.</dd>
 662 </dl>
 663
 664 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 665    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 666    one, one of the two would be renamed, preventing a collision.  Since
 667    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 668    declarations), they are accessible outside of the current module.</p>
 669
 670 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 671    other than <tt>external</tt>, <tt>dllimport</tt>
 672   or <tt>extern_weak</tt>.</p>
 673
 674 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 675    or <tt>weak_odr</tt> linkages.</p>
 676
 677 </div>
 678
 679 <!-- ======================================================================= -->
 680 <h3>
 681   <a name="callingconv">Calling Conventions</a>
 682 </h3>
 683
 684 <div>
 685
 686 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 687    and <a href="#i_invoke">invokes</a> can all have an optional calling
 688    convention specified for the call.  The calling convention of any pair of
 689    dynamic caller/callee must match, or the behavior of the program is
 690    undefined.  The following calling conventions are supported by LLVM, and more
 691    may be added in the future:</p>
 692
 693 <dl>
 694   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 695   <dd>This calling convention (the default if no other calling convention is
 696       specified) matches the target C calling conventions.  This calling
 697       convention supports varargs function calls and tolerates some mismatch in
 698       the declared prototype and implemented declaration of the function (as
 699       does normal C).</dd>
 700
 701   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 702   <dd>This calling convention attempts to make calls as fast as possible
 703       (e.g. by passing things in registers).  This calling convention allows the
 704       target to use whatever tricks it wants to produce fast code for the
 705       target, without having to conform to an externally specified ABI
 706       (Application Binary Interface).
 707       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 708       when this or the GHC convention is used.</a>  This calling convention
 709       does not support varargs and requires the prototype of all callees to
 710       exactly match the prototype of the function definition.</dd>
 711
 712   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make code in the caller as efficient
 714       as possible under the assumption that the call is not commonly executed.
 715       As such, these calls often preserve all registers so that the call does
 716       not break any live ranges in the caller side.  This calling convention
 717       does not support varargs and requires the prototype of all callees to
 718       exactly match the prototype of the function definition.</dd>
 719
 720   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 721   <dd>This calling convention has been implemented specifically for use by the
 722       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 723       It passes everything in registers, going to extremes to achieve this by
 724       disabling callee save registers. This calling convention should not be
 725       used lightly but only for specific situations such as an alternative to
 726       the <em>register pinning</em> performance technique often used when
 727       implementing functional programming languages.At the moment only X86
 728       supports this convention and it has the following limitations:
 729       <ul>
 730         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 731             floating point types are supported.</li>
 732         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 733             6 floating point parameters.</li>
 734       </ul>
 735       This calling convention supports
 736       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 737       requires both the caller and callee are using it.
 738   </dd>
 739
 740   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 741   <dd>Any calling convention may be specified by number, allowing
 742       target-specific calling conventions to be used.  Target specific calling
 743       conventions start at 64.</dd>
 744 </dl>
 745
 746 <p>More calling conventions can be added/defined on an as-needed basis, to
 747    support Pascal conventions or any other well-known target-independent
 748    convention.</p>
 749
 750 </div>
 751
 752 <!-- ======================================================================= -->
 753 <h3>
 754   <a name="visibility">Visibility Styles</a>
 755 </h3>
 756
 757 <div>
 758
 759 <p>All Global Variables and Functions have one of the following visibility
 760    styles:</p>
 761
 762 <dl>
 763   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 764   <dd>On targets that use the ELF object file format, default visibility means
 765       that the declaration is visible to other modules and, in shared libraries,
 766       means that the declared entity may be overridden. On Darwin, default
 767       visibility means that the declaration is visible to other modules. Default
 768       visibility corresponds to "external linkage" in the language.</dd>
 769
 770   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 771   <dd>Two declarations of an object with hidden visibility refer to the same
 772       object if they are in the same shared object. Usually, hidden visibility
 773       indicates that the symbol will not be placed into the dynamic symbol
 774       table, so no other module (executable or shared library) can reference it
 775       directly.</dd>
 776
 777   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 778   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 779       the dynamic symbol table, but that references within the defining module
 780       will bind to the local symbol. That is, the symbol cannot be overridden by
 781       another module.</dd>
 782 </dl>
 783
 784 </div>
 785
 786 <!-- ======================================================================= -->
 787 <h3>
 788   <a name="namedtypes">Named Types</a>
 789 </h3>
 790
 791 <div>
 792
 793 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 794    it easier to read the IR and make the IR more condensed (particularly when
 795    recursive types are involved).  An example of a name specification is:</p>
 796
 797 <pre class="doc_code">
 798 %mytype = type { %mytype*, i32 }
 799 </pre>
 800
 801 <p>You may give a name to any <a href="#typesystem">type</a> except
 802    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 803    is expected with the syntax "%mytype".</p>
 804
 805 <p>Note that type names are aliases for the structural type that they indicate,
 806    and that you can therefore specify multiple names for the same type.  This
 807    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 808    uses structural typing, the name is not part of the type.  When printing out
 809    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 810    particular shape.  This means that if you have code where two different
 811    source types end up having the same LLVM type, that the dumper will sometimes
 812    print the "wrong" or unexpected type.  This is an important design point and
 813    isn't going to change.</p>
 814
 815 </div>
 816
 817 <!-- ======================================================================= -->
 818 <h3>
 819   <a name="globalvars">Global Variables</a>
 820 </h3>
 821
 822 <div>
 823
 824 <p>Global variables define regions of memory allocated at compilation time
 825    instead of run-time.  Global variables may optionally be initialized, may
 826    have an explicit section to be placed in, and may have an optional explicit
 827    alignment specified.  A variable may be defined as "thread_local", which
 828    means that it will not be shared by threads (each thread will have a
 829    separated copy of the variable).  A variable may be defined as a global
 830    "constant," which indicates that the contents of the variable
 831    will <b>never</b> be modified (enabling better optimization, allowing the
 832    global data to be placed in the read-only section of an executable, etc).
 833    Note that variables that need runtime initialization cannot be marked
 834    "constant" as there is a store to the variable.</p>
 835
 836 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 837    constant, even if the final definition of the global is not.  This capability
 838    can be used to enable slightly better optimization of the program, but
 839    requires the language definition to guarantee that optimizations based on the
 840    'constantness' are valid for the translation units that do not include the
 841    definition.</p>
 842
 843 <p>As SSA values, global variables define pointer values that are in scope
 844    (i.e. they dominate) all basic blocks in the program.  Global variables
 845    always define a pointer to their "content" type because they describe a
 846    region of memory, and all memory objects in LLVM are accessed through
 847    pointers.</p>
 848
 849 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 850   that the address is not significant, only the content. Constants marked
 851   like this can be merged with other constants if they have the same
 852   initializer. Note that a constant with significant address <em>can</em>
 853   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 854   constant whose address is significant.</p>
 855
 856 <p>A global variable may be declared to reside in a target-specific numbered
 857    address space. For targets that support them, address spaces may affect how
 858    optimizations are performed and/or what target instructions are used to
 859    access the variable. The default address space is zero. The address space
 860    qualifier must precede any other attributes.</p>
 861
 862 <p>LLVM allows an explicit section to be specified for globals.  If the target
 863    supports it, it will emit globals to the section specified.</p>
 864
 865 <p>An explicit alignment may be specified for a global, which must be a power
 866    of 2.  If not present, or if the alignment is set to zero, the alignment of
 867    the global is set by the target to whatever it feels convenient.  If an
 868    explicit alignment is specified, the global is forced to have exactly that
 869    alignment.  Targets and optimizers are not allowed to over-align the global
 870    if the global has an assigned section.  In this case, the extra alignment
 871    could be observable: for example, code could assume that the globals are
 872    densely packed in their section and try to iterate over them as an array,
 873    alignment padding would break this iteration.</p>
 874
 875 <p>For example, the following defines a global in a numbered address space with
 876    an initializer, section, and alignment:</p>
 877
 878 <pre class="doc_code">
 879 @G = addrspace(5) constant float 1.0, section "foo", align 4
 880 </pre>
 881
 882 </div>
 883
 884
 885 <!-- ======================================================================= -->
 886 <h3>
 887   <a name="functionstructure">Functions</a>
 888 </h3>
 889
 890 <div>
 891
 892 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 893    optional <a href="#linkage">linkage type</a>, an optional
 894    <a href="#visibility">visibility style</a>, an optional
 895    <a href="#callingconv">calling convention</a>,
 896    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 897    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 898    name, a (possibly empty) argument list (each with optional
 899    <a href="#paramattrs">parameter attributes</a>), optional
 900    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 901    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 902    curly brace, a list of basic blocks, and a closing curly brace.</p>
 903
 904 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 905    optional <a href="#linkage">linkage type</a>, an optional
 906    <a href="#visibility">visibility style</a>, an optional
 907    <a href="#callingconv">calling convention</a>,
 908    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 909    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 910    name, a possibly empty list of arguments, an optional alignment, and an
 911    optional <a href="#gc">garbage collector name</a>.</p>
 912
 913 <p>A function definition contains a list of basic blocks, forming the CFG
 914    (Control Flow Graph) for the function.  Each basic block may optionally start
 915    with a label (giving the basic block a symbol table entry), contains a list
 916    of instructions, and ends with a <a href="#terminators">terminator</a>
 917    instruction (such as a branch or function return).</p>
 918
 919 <p>The first basic block in a function is special in two ways: it is immediately
 920    executed on entrance to the function, and it is not allowed to have
 921    predecessor basic blocks (i.e. there can not be any branches to the entry
 922    block of a function).  Because the block can have no predecessors, it also
 923    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 924
 925 <p>LLVM allows an explicit section to be specified for functions.  If the target
 926    supports it, it will emit functions to the section specified.</p>
 927
 928 <p>An explicit alignment may be specified for a function.  If not present, or if
 929    the alignment is set to zero, the alignment of the function is set by the
 930    target to whatever it feels convenient.  If an explicit alignment is
 931    specified, the function is forced to have at least that much alignment.  All
 932    alignments must be a power of 2.</p>
 933
 934 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 935    be significant and two identical functions can be merged.</p>
 936
 937 <h5>Syntax:</h5>
 938 <pre class="doc_code">
 939 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 940        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 941        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 942        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 943        [<a href="#gc">gc</a>] { ... }
 944 </pre>
 945
 946 </div>
 947
 948 <!-- ======================================================================= -->
 949 <h3>
 950   <a name="aliasstructure">Aliases</a>
 951 </h3>
 952
 953 <div>
 954
 955 <p>Aliases act as "second name" for the aliasee value (which can be either
 956    function, global variable, another alias or bitcast of global value). Aliases
 957    may have an optional <a href="#linkage">linkage type</a>, and an
 958    optional <a href="#visibility">visibility style</a>.</p>
 959
 960 <h5>Syntax:</h5>
 961 <pre class="doc_code">
 962 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 963 </pre>
 964
 965 </div>
 966
 967 <!-- ======================================================================= -->
 968 <h3>
 969   <a name="namedmetadatastructure">Named Metadata</a>
 970 </h3>
 971
 972 <div>
 973
 974 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 975    nodes</a> (but not metadata strings) are the only valid operands for
 976    a named metadata.</p>
 977
 978 <h5>Syntax:</h5>
 979 <pre class="doc_code">
 980 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 981 !0 = metadata !{metadata !"zero"}
 982 !1 = metadata !{metadata !"one"}
 983 !2 = metadata !{metadata !"two"}
 984 ; A named metadata.
 985 !name = !{!0, !1, !2}
 986 </pre>
 987
 988 </div>
 989
 990 <!-- ======================================================================= -->
 991 <h3>
 992   <a name="paramattrs">Parameter Attributes</a>
 993 </h3>
 994
 995 <div>
 996
 997 <p>The return type and each parameter of a function type may have a set of
 998    <i>parameter attributes</i> associated with them. Parameter attributes are
 999    used to communicate additional information about the result or parameters of
1000    a function. Parameter attributes are considered to be part of the function,
1001    not of the function type, so functions with different parameter attributes
1002    can have the same function type.</p>
1003
1004 <p>Parameter attributes are simple keywords that follow the type specified. If
1005    multiple parameter attributes are needed, they are space separated. For
1006    example:</p>
1007
1008 <pre class="doc_code">
1009 declare i32 @printf(i8* noalias nocapture, ...)
1010 declare i32 @atoi(i8 zeroext)
1011 declare signext i8 @returns_signed_char()
1012 </pre>
1013
1014 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1015    <tt>readonly</tt>) come immediately after the argument list.</p>
1016
1017 <p>Currently, only the following parameter attributes are defined:</p>
1018
1019 <dl>
1020   <dt><tt><b>zeroext</b></tt></dt>
1021   <dd>This indicates to the code generator that the parameter or return value
1022       should be zero-extended to the extent required by the target's ABI (which
1023       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1024       parameter) or the callee (for a return value).</dd>
1025
1026   <dt><tt><b>signext</b></tt></dt>
1027   <dd>This indicates to the code generator that the parameter or return value
1028       should be sign-extended to the extent required by the target's ABI (which
1029       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1030       return value).</dd>
1031
1032   <dt><tt><b>inreg</b></tt></dt>
1033   <dd>This indicates that this parameter or return value should be treated in a
1034       special target-dependent fashion during while emitting code for a function
1035       call or return (usually, by putting it in a register as opposed to memory,
1036       though some targets use it to distinguish between two different kinds of
1037       registers).  Use of this attribute is target-specific.</dd>
1038
1039   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1040   <dd><p>This indicates that the pointer parameter should really be passed by
1041       value to the function.  The attribute implies that a hidden copy of the
1042       pointee
1043       is made between the caller and the callee, so the callee is unable to
1044       modify the value in the callee.  This attribute is only valid on LLVM
1045       pointer arguments.  It is generally used to pass structs and arrays by
1046       value, but is also valid on pointers to scalars.  The copy is considered
1047       to belong to the caller not the callee (for example,
1048       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1049       <tt>byval</tt> parameters). This is not a valid attribute for return
1050       values.</p>
1051
1052       <p>The byval attribute also supports specifying an alignment with
1053       the align attribute.  It indicates the alignment of the stack slot to
1054       form and the known alignment of the pointer specified to the call site. If
1055       the alignment is not specified, then the code generator makes a
1056       target-specific assumption.</p></dd>
1057
1058   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1059   <dd>This indicates that the pointer parameter specifies the address of a
1060       structure that is the return value of the function in the source program.
1061       This pointer must be guaranteed by the caller to be valid: loads and
1062       stores to the structure may be assumed by the callee to not to trap.  This
1063       may only be applied to the first parameter. This is not a valid attribute
1064       for return values. </dd>
1065
1066   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1067   <dd>This indicates that pointer values
1068       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1069       value do not alias pointer values which are not <i>based</i> on it,
1070       ignoring certain "irrelevant" dependencies.
1071       For a call to the parent function, dependencies between memory
1072       references from before or after the call and from those during the call
1073       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1074       return value used in that call.
1075       The caller shares the responsibility with the callee for ensuring that
1076       these requirements are met.
1077       For further details, please see the discussion of the NoAlias response in
1078       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1079 <br>
1080       Note that this definition of <tt>noalias</tt> is intentionally
1081       similar to the definition of <tt>restrict</tt> in C99 for function
1082       arguments, though it is slightly weaker.
1083 <br>
1084       For function return values, C99's <tt>restrict</tt> is not meaningful,
1085       while LLVM's <tt>noalias</tt> is.
1086       </dd>
1087
1088   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1089   <dd>This indicates that the callee does not make any copies of the pointer
1090       that outlive the callee itself. This is not a valid attribute for return
1091       values.</dd>
1092
1093   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1094   <dd>This indicates that the pointer parameter can be excised using the
1095       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1096       attribute for return values.</dd>
1097 </dl>
1098
1099 </div>
1100
1101 <!-- ======================================================================= -->
1102 <h3>
1103   <a name="gc">Garbage Collector Names</a>
1104 </h3>
1105
1106 <div>
1107
1108 <p>Each function may specify a garbage collector name, which is simply a
1109    string:</p>
1110
1111 <pre class="doc_code">
1112 define void @f() gc "name" { ... }
1113 </pre>
1114
1115 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1116    collector which will cause the compiler to alter its output in order to
1117    support the named garbage collection algorithm.</p>
1118
1119 </div>
1120
1121 <!-- ======================================================================= -->
1122 <h3>
1123   <a name="fnattrs">Function Attributes</a>
1124 </h3>
1125
1126 <div>
1127
1128 <p>Function attributes are set to communicate additional information about a
1129    function. Function attributes are considered to be part of the function, not
1130    of the function type, so functions with different parameter attributes can
1131    have the same function type.</p>
1132
1133 <p>Function attributes are simple keywords that follow the type specified. If
1134    multiple attributes are needed, they are space separated. For example:</p>
1135
1136 <pre class="doc_code">
1137 define void @f() noinline { ... }
1138 define void @f() alwaysinline { ... }
1139 define void @f() alwaysinline optsize { ... }
1140 define void @f() optsize { ... }
1141 </pre>
1142
1143 <dl>
1144   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1145   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1146       the backend should forcibly align the stack pointer. Specify the
1147       desired alignment, which must be a power of two, in parentheses.
1148
1149   <dt><tt><b>alwaysinline</b></tt></dt>
1150   <dd>This attribute indicates that the inliner should attempt to inline this
1151       function into callers whenever possible, ignoring any active inlining size
1152       threshold for this caller.</dd>
1153
1154   <dt><tt><b>nonlazybind</b></tt></dt>
1155   <dd>This attribute suppresses lazy symbol binding for the function. This
1156       may make calls to the function faster, at the cost of extra program
1157       startup time if the function is not called during program startup.</dd>
1158
1159   <dt><tt><b>inlinehint</b></tt></dt>
1160   <dd>This attribute indicates that the source code contained a hint that inlining
1161       this function is desirable (such as the "inline" keyword in C/C++).  It
1162       is just a hint; it imposes no requirements on the inliner.</dd>
1163
1164   <dt><tt><b>naked</b></tt></dt>
1165   <dd>This attribute disables prologue / epilogue emission for the function.
1166       This can have very system-specific consequences.</dd>
1167
1168   <dt><tt><b>noimplicitfloat</b></tt></dt>
1169   <dd>This attributes disables implicit floating point instructions.</dd>
1170
1171   <dt><tt><b>noinline</b></tt></dt>
1172   <dd>This attribute indicates that the inliner should never inline this
1173       function in any situation. This attribute may not be used together with
1174       the <tt>alwaysinline</tt> attribute.</dd>
1175
1176   <dt><tt><b>noredzone</b></tt></dt>
1177   <dd>This attribute indicates that the code generator should not use a red
1178       zone, even if the target-specific ABI normally permits it.</dd>
1179
1180   <dt><tt><b>noreturn</b></tt></dt>
1181   <dd>This function attribute indicates that the function never returns
1182       normally.  This produces undefined behavior at runtime if the function
1183       ever does dynamically return.</dd>
1184
1185   <dt><tt><b>nounwind</b></tt></dt>
1186   <dd>This function attribute indicates that the function never returns with an
1187       unwind or exceptional control flow.  If the function does unwind, its
1188       runtime behavior is undefined.</dd>
1189
1190   <dt><tt><b>optsize</b></tt></dt>
1191   <dd>This attribute suggests that optimization passes and code generator passes
1192       make choices that keep the code size of this function low, and otherwise
1193       do optimizations specifically to reduce code size.</dd>
1194
1195   <dt><tt><b>readnone</b></tt></dt>
1196   <dd>This attribute indicates that the function computes its result (or decides
1197       to unwind an exception) based strictly on its arguments, without
1198       dereferencing any pointer arguments or otherwise accessing any mutable
1199       state (e.g. memory, control registers, etc) visible to caller functions.
1200       It does not write through any pointer arguments
1201       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1202       changes any state visible to callers.  This means that it cannot unwind
1203       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1204       could use the <tt>unwind</tt> instruction.</dd>
1205
1206   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1207   <dd>This attribute indicates that the function does not write through any
1208       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1209       arguments) or otherwise modify any state (e.g. memory, control registers,
1210       etc) visible to caller functions.  It may dereference pointer arguments
1211       and read state that may be set in the caller.  A readonly function always
1212       returns the same value (or unwinds an exception identically) when called
1213       with the same set of arguments and global state.  It cannot unwind an
1214       exception by calling the <tt>C++</tt> exception throwing methods, but may
1215       use the <tt>unwind</tt> instruction.</dd>
1216
1217   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1218   <dd>This attribute indicates that the function should emit a stack smashing
1219       protector. It is in the form of a "canary"&mdash;a random value placed on
1220       the stack before the local variables that's checked upon return from the
1221       function to see if it has been overwritten. A heuristic is used to
1222       determine if a function needs stack protectors or not.<br>
1223 <br>
1224       If a function that has an <tt>ssp</tt> attribute is inlined into a
1225       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1226       function will have an <tt>ssp</tt> attribute.</dd>
1227
1228   <dt><tt><b>sspreq</b></tt></dt>
1229   <dd>This attribute indicates that the function should <em>always</em> emit a
1230       stack smashing protector. This overrides
1231       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1232 <br>
1233       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1234       function that doesn't have an <tt>sspreq</tt> attribute or which has
1235       an <tt>ssp</tt> attribute, then the resulting function will have
1236       an <tt>sspreq</tt> attribute.</dd>
1237
1238   <dt><tt><b><a name="uwtable">uwtable</a></b></tt></dt>
1239   <dd>This attribute indicates that the ABI being targeted requires that
1240       an unwind table entry be produce for this function even if we can
1241       show that no exceptions passes by it. This is normally the case for
1242       the ELF x86-64 abi, but it can be disabled for some compilation
1243       units.</dd>
1244
1245   <dt><tt><b><a name="returns_twice">returns_twice</a></b></tt></dt>
1246   <dd>This attribute indicates that this function can return
1247   twice. The C <code>setjmp</code> is an example of such a function.
1248   The compiler disables some optimizations (like tail calls) in the caller of
1249   these functions.</dd>
1250 </dl>
1251
1252 </div>
1253
1254 <!-- ======================================================================= -->
1255 <h3>
1256   <a name="moduleasm">Module-Level Inline Assembly</a>
1257 </h3>
1258
1259 <div>
1260
1261 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1262    the GCC "file scope inline asm" blocks.  These blocks are internally
1263    concatenated by LLVM and treated as a single unit, but may be separated in
1264    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1265
1266 <pre class="doc_code">
1267 module asm "inline asm code goes here"
1268 module asm "more can go here"
1269 </pre>
1270
1271 <p>The strings can contain any character by escaping non-printable characters.
1272    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1273    for the number.</p>
1274
1275 <p>The inline asm code is simply printed to the machine code .s file when
1276    assembly code is generated.</p>
1277
1278 </div>
1279
1280 <!-- ======================================================================= -->
1281 <h3>
1282   <a name="datalayout">Data Layout</a>
1283 </h3>
1284
1285 <div>
1286
1287 <p>A module may specify a target specific data layout string that specifies how
1288    data is to be laid out in memory. The syntax for the data layout is
1289    simply:</p>
1290
1291 <pre class="doc_code">
1292 target datalayout = "<i>layout specification</i>"
1293 </pre>
1294
1295 <p>The <i>layout specification</i> consists of a list of specifications
1296    separated by the minus sign character ('-').  Each specification starts with
1297    a letter and may include other information after the letter to define some
1298    aspect of the data layout.  The specifications accepted are as follows:</p>
1299
1300 <dl>
1301   <dt><tt>E</tt></dt>
1302   <dd>Specifies that the target lays out data in big-endian form. That is, the
1303       bits with the most significance have the lowest address location.</dd>
1304
1305   <dt><tt>e</tt></dt>
1306   <dd>Specifies that the target lays out data in little-endian form. That is,
1307       the bits with the least significance have the lowest address
1308       location.</dd>
1309
1310   <dt><tt>S<i>size</i></tt></dt>
1311   <dd>Specifies the natural alignment of the stack in bits. Alignment promotion
1312       of stack variables is limited to the natural stack alignment to avoid
1313       dynamic stack realignment. The stack alignment must be a multiple of
1314       8-bits. If omitted, the natural stack alignment defaults to "unspecified",
1315       which does not prevent any alignment promotions.</dd>
1316
1317   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1318   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1319       <i>preferred</i> alignments. All sizes are in bits. Specifying
1320       the <i>pref</i> alignment is optional. If omitted, the
1321       preceding <tt>:</tt> should be omitted too.</dd>
1322
1323   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1324   <dd>This specifies the alignment for an integer type of a given bit
1325       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1326
1327   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1328   <dd>This specifies the alignment for a vector type of a given bit
1329       <i>size</i>.</dd>
1330
1331   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1332   <dd>This specifies the alignment for a floating point type of a given bit
1333       <i>size</i>. Only values of <i>size</i> that are supported by the target
1334       will work.  32 (float) and 64 (double) are supported on all targets;
1335       80 or 128 (different flavors of long double) are also supported on some
1336       targets.
1337
1338   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1339   <dd>This specifies the alignment for an aggregate type of a given bit
1340       <i>size</i>.</dd>
1341
1342   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1343   <dd>This specifies the alignment for a stack object of a given bit
1344       <i>size</i>.</dd>
1345
1346   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1347   <dd>This specifies a set of native integer widths for the target CPU
1348       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1349       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1350       this set are considered to support most general arithmetic
1351       operations efficiently.</dd>
1352 </dl>
1353
1354 <p>When constructing the data layout for a given target, LLVM starts with a
1355    default set of specifications which are then (possibly) overridden by the
1356    specifications in the <tt>datalayout</tt> keyword. The default specifications
1357    are given in this list:</p>
1358
1359 <ul>
1360   <li><tt>E</tt> - big endian</li>
1361   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1362   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1363   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1364   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1365   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1366   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1367   alignment of 64-bits</li>
1368   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1369   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1370   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1371   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1372   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1373   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1374 </ul>
1375
1376 <p>When LLVM is determining the alignment for a given type, it uses the
1377    following rules:</p>
1378
1379 <ol>
1380   <li>If the type sought is an exact match for one of the specifications, that
1381       specification is used.</li>
1382
1383   <li>If no match is found, and the type sought is an integer type, then the
1384       smallest integer type that is larger than the bitwidth of the sought type
1385       is used. If none of the specifications are larger than the bitwidth then
1386       the the largest integer type is used. For example, given the default
1387       specifications above, the i7 type will use the alignment of i8 (next
1388       largest) while both i65 and i256 will use the alignment of i64 (largest
1389       specified).</li>
1390
1391   <li>If no match is found, and the type sought is a vector type, then the
1392       largest vector type that is smaller than the sought vector type will be
1393       used as a fall back.  This happens because &lt;128 x double&gt; can be
1394       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1395 </ol>
1396
1397 <p>The function of the data layout string may not be what you expect.  Notably,
1398    this is not a specification from the frontend of what alignment the code
1399    generator should use.</p>
1400
1401 <p>Instead, if specified, the target data layout is required to match what the
1402    ultimate <em>code generator</em> expects.  This string is used by the
1403    mid-level optimizers to
1404    improve code, and this only works if it matches what the ultimate code
1405    generator uses.  If you would like to generate IR that does not embed this
1406    target-specific detail into the IR, then you don't have to specify the
1407    string.  This will disable some optimizations that require precise layout
1408    information, but this also prevents those optimizations from introducing
1409    target specificity into the IR.</p>
1410
1411
1412
1413 </div>
1414
1415 <!-- ======================================================================= -->
1416 <h3>
1417   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1418 </h3>
1419
1420 <div>
1421
1422 <p>Any memory access must be done through a pointer value associated
1423 with an address range of the memory access, otherwise the behavior
1424 is undefined. Pointer values are associated with address ranges
1425 according to the following rules:</p>
1426
1427 <ul>
1428   <li>A pointer value is associated with the addresses associated with
1429       any value it is <i>based</i> on.
1430   <li>An address of a global variable is associated with the address
1431       range of the variable's storage.</li>
1432   <li>The result value of an allocation instruction is associated with
1433       the address range of the allocated storage.</li>
1434   <li>A null pointer in the default address-space is associated with
1435       no address.</li>
1436   <li>An integer constant other than zero or a pointer value returned
1437       from a function not defined within LLVM may be associated with address
1438       ranges allocated through mechanisms other than those provided by
1439       LLVM. Such ranges shall not overlap with any ranges of addresses
1440       allocated by mechanisms provided by LLVM.</li>
1441 </ul>
1442
1443 <p>A pointer value is <i>based</i> on another pointer value according
1444    to the following rules:</p>
1445
1446 <ul>
1447   <li>A pointer value formed from a
1448       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1449       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1450   <li>The result value of a
1451       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1452       of the <tt>bitcast</tt>.</li>
1453   <li>A pointer value formed by an
1454       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1455       pointer values that contribute (directly or indirectly) to the
1456       computation of the pointer's value.</li>
1457   <li>The "<i>based</i> on" relationship is transitive.</li>
1458 </ul>
1459
1460 <p>Note that this definition of <i>"based"</i> is intentionally
1461    similar to the definition of <i>"based"</i> in C99, though it is
1462    slightly weaker.</p>
1463
1464 <p>LLVM IR does not associate types with memory. The result type of a
1465 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1466 alignment of the memory from which to load, as well as the
1467 interpretation of the value. The first operand type of a
1468 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1469 and alignment of the store.</p>
1470
1471 <p>Consequently, type-based alias analysis, aka TBAA, aka
1472 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1473 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1474 additional information which specialized optimization passes may use
1475 to implement type-based alias analysis.</p>
1476
1477 </div>
1478
1479 <!-- ======================================================================= -->
1480 <h3>
1481   <a name="volatile">Volatile Memory Accesses</a>
1482 </h3>
1483
1484 <div>
1485
1486 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1487 href="#i_store"><tt>store</tt></a>s, and <a
1488 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1489 The optimizers must not change the number of volatile operations or change their
1490 order of execution relative to other volatile operations.  The optimizers
1491 <i>may</i> change the order of volatile operations relative to non-volatile
1492 operations.  This is not Java's "volatile" and has no cross-thread
1493 synchronization behavior.</p>
1494
1495 </div>
1496
1497 <!-- ======================================================================= -->
1498 <h3>
1499   <a name="memmodel">Memory Model for Concurrent Operations</a>
1500 </h3>
1501
1502 <div>
1503
1504 <p>The LLVM IR does not define any way to start parallel threads of execution
1505 or to register signal handlers. Nonetheless, there are platform-specific
1506 ways to create them, and we define LLVM IR's behavior in their presence. This
1507 model is inspired by the C++0x memory model.</p>
1508
1509 <p>For a more informal introduction to this model, see the
1510 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.
1511
1512 <p>We define a <i>happens-before</i> partial order as the least partial order
1513 that</p>
1514 <ul>
1515   <li>Is a superset of single-thread program order, and</li>
1516   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1517       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1518       by platform-specific techniques, like pthread locks, thread
1519       creation, thread joining, etc., and by atomic instructions.
1520       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1521       </li>
1522 </ul>
1523
1524 <p>Note that program order does not introduce <i>happens-before</i> edges
1525 between a thread and signals executing inside that thread.</p>
1526
1527 <p>Every (defined) read operation (load instructions, memcpy, atomic
1528 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1529 (defined) write operations (store instructions, atomic
1530 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1531 initialized globals are considered to have a write of the initializer which is
1532 atomic and happens before any other read or write of the memory in question.
1533 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1534 any write to the same byte, except:</p>
1535
1536 <ul>
1537   <li>If <var>write<sub>1</sub></var> happens before
1538       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1539       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1540       does not see <var>write<sub>1</sub></var>.
1541   <li>If <var>R<sub>byte</sub></var> happens before
1542       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1543       see <var>write<sub>3</sub></var>.
1544 </ul>
1545
1546 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1547 <ul>
1548   <li>If <var>R</var> is volatile, the result is target-dependent. (Volatile
1549       is supposed to give guarantees which can support
1550       <code>sig_atomic_t</code> in C/C++, and may be used for accesses to
1551       addresses which do not behave like normal memory.  It does not generally
1552       provide cross-thread synchronization.)
1553   <li>Otherwise, if there is no write to the same byte that happens before
1554     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1555     <tt>undef</tt> for that byte.
1556   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1557       <var>R<sub>byte</sub></var> returns the value written by that
1558       write.</li>
1559   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1560       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1561       values written.  See the <a href="#ordering">Atomic Memory Ordering
1562       Constraints</a> section for additional constraints on how the choice
1563       is made.
1564   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1565 </ul>
1566
1567 <p><var>R</var> returns the value composed of the series of bytes it read.
1568 This implies that some bytes within the value may be <tt>undef</tt>
1569 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1570 defines the semantics of the operation; it doesn't mean that targets will
1571 emit more than one instruction to read the series of bytes.</p>
1572
1573 <p>Note that in cases where none of the atomic intrinsics are used, this model
1574 places only one restriction on IR transformations on top of what is required
1575 for single-threaded execution: introducing a store to a byte which might not
1576 otherwise be stored is not allowed in general.  (Specifically, in the case
1577 where another thread might write to and read from an address, introducing a
1578 store can change a load that may see exactly one write into a load that may
1579 see multiple writes.)</p>
1580
1581 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1582 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1583 none of the backends currently in the tree fall into this category; however,
1584 there might be targets which care.  If there are, we want a paragraph
1585 like the following:
1586
1587 Targets may specify that stores narrower than a certain width are not
1588 available; on such a target, for the purposes of this model, treat any
1589 non-atomic write with an alignment or width less than the minimum width
1590 as if it writes to the relevant surrounding bytes.
1591 -->
1592
1593 </div>
1594
1595 <!-- ======================================================================= -->
1596 <h3>
1597       <a name="ordering">Atomic Memory Ordering Constraints</a>
1598 </h3>
1599
1600 <div>
1601
1602 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1603 <a href="#i_atomicrmw"><code>atomicrmw</code></a>,
1604 <a href="#i_fence"><code>fence</code></a>,
1605 <a href="#i_load"><code>atomic load</code></a>, and
1606 <a href="#i_store"><code>atomic store</code></a>) take an ordering parameter
1607 that determines which other atomic instructions on the same address they
1608 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1609 but are somewhat more colloquial. If these descriptions aren't precise enough,
1610 check those specs (see spec references in the
1611 <a href="Atomic.html#introduction">atomics guide</a>).
1612 <a href="#i_fence"><code>fence</code></a> instructions
1613 treat these orderings somewhat differently since they don't take an address.
1614 See that instruction's documentation for details.</p>
1615
1616 <p>For a simpler introduction to the ordering constraints, see the
1617 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.</p>
1618
1619 <dl>
1620 <dt><code>unordered</code></dt>
1621 <dd>The set of values that can be read is governed by the happens-before
1622 partial order. A value cannot be read unless some operation wrote it.
1623 This is intended to provide a guarantee strong enough to model Java's
1624 non-volatile shared variables.  This ordering cannot be specified for
1625 read-modify-write operations; it is not strong enough to make them atomic
1626 in any interesting way.</dd>
1627 <dt><code>monotonic</code></dt>
1628 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1629 total order for modifications by <code>monotonic</code> operations on each
1630 address. All modification orders must be compatible with the happens-before
1631 order. There is no guarantee that the modification orders can be combined to
1632 a global total order for the whole program (and this often will not be
1633 possible). The read in an atomic read-modify-write operation
1634 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1635 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1636 reads the value in the modification order immediately before the value it
1637 writes. If one atomic read happens before another atomic read of the same
1638 address, the later read must see the same value or a later value in the
1639 address's modification order. This disallows reordering of
1640 <code>monotonic</code> (or stronger) operations on the same address. If an
1641 address is written <code>monotonic</code>ally by one thread, and other threads
1642 <code>monotonic</code>ally read that address repeatedly, the other threads must
1643 eventually see the write. This corresponds to the C++0x/C1x
1644 <code>memory_order_relaxed</code>.</dd>
1645 <dt><code>acquire</code></dt>
1646 <dd>In addition to the guarantees of <code>monotonic</code>,
1647 a <i>synchronizes-with</i> edge may be formed with a <code>release</code>
1648 operation. This is intended to model C++'s <code>memory_order_acquire</code>.</dd>
1649 <dt><code>release</code></dt>
1650 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1651 writes a value which is subsequently read by an <code>acquire</code> operation,
1652 it <i>synchronizes-with</i> that operation.  (This isn't a complete
1653 description; see the C++0x definition of a release sequence.) This corresponds
1654 to the C++0x/C1x <code>memory_order_release</code>.</dd>
1655 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1656 <code>acquire</code> and <code>release</code> operation on its address.
1657 This corresponds to the C++0x/C1x <code>memory_order_acq_rel</code>.</dd>
1658 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1659 <dd>In addition to the guarantees of <code>acq_rel</code>
1660 (<code>acquire</code> for an operation which only reads, <code>release</code>
1661 for an operation which only writes), there is a global total order on all
1662 sequentially-consistent operations on all addresses, which is consistent with
1663 the <i>happens-before</i> partial order and with the modification orders of
1664 all the affected addresses. Each sequentially-consistent read sees the last
1665 preceding write to the same address in this global order. This corresponds
1666 to the C++0x/C1x <code>memory_order_seq_cst</code> and Java volatile.</dd>
1667 </dl>
1668
1669 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1670 it only <i>synchronizes with</i> or participates in modification and seq_cst
1671 total orderings with other operations running in the same thread (for example,
1672 in signal handlers).</p>
1673
1674 </div>
1675
1676 </div>
1677
1678 <!-- *********************************************************************** -->
1679 <h2><a name="typesystem">Type System</a></h2>
1680 <!-- *********************************************************************** -->
1681
1682 <div>
1683
1684 <p>The LLVM type system is one of the most important features of the
1685    intermediate representation.  Being typed enables a number of optimizations
1686    to be performed on the intermediate representation directly, without having
1687    to do extra analyses on the side before the transformation.  A strong type
1688    system makes it easier to read the generated code and enables novel analyses
1689    and transformations that are not feasible to perform on normal three address
1690    code representations.</p>
1691
1692 <!-- ======================================================================= -->
1693 <h3>
1694   <a name="t_classifications">Type Classifications</a>
1695 </h3>
1696
1697 <div>
1698
1699 <p>The types fall into a few useful classifications:</p>
1700
1701 <table border="1" cellspacing="0" cellpadding="4">
1702   <tbody>
1703     <tr><th>Classification</th><th>Types</th></tr>
1704     <tr>
1705       <td><a href="#t_integer">integer</a></td>
1706       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1707     </tr>
1708     <tr>
1709       <td><a href="#t_floating">floating point</a></td>
1710       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1711     </tr>
1712     <tr>
1713       <td><a name="t_firstclass">first class</a></td>
1714       <td><a href="#t_integer">integer</a>,
1715           <a href="#t_floating">floating point</a>,
1716           <a href="#t_pointer">pointer</a>,
1717           <a href="#t_vector">vector</a>,
1718           <a href="#t_struct">structure</a>,
1719           <a href="#t_array">array</a>,
1720           <a href="#t_label">label</a>,
1721           <a href="#t_metadata">metadata</a>.
1722       </td>
1723     </tr>
1724     <tr>
1725       <td><a href="#t_primitive">primitive</a></td>
1726       <td><a href="#t_label">label</a>,
1727           <a href="#t_void">void</a>,
1728           <a href="#t_integer">integer</a>,
1729           <a href="#t_floating">floating point</a>,
1730           <a href="#t_x86mmx">x86mmx</a>,
1731           <a href="#t_metadata">metadata</a>.</td>
1732     </tr>
1733     <tr>
1734       <td><a href="#t_derived">derived</a></td>
1735       <td><a href="#t_array">array</a>,
1736           <a href="#t_function">function</a>,
1737           <a href="#t_pointer">pointer</a>,
1738           <a href="#t_struct">structure</a>,
1739           <a href="#t_vector">vector</a>,
1740           <a href="#t_opaque">opaque</a>.
1741       </td>
1742     </tr>
1743   </tbody>
1744 </table>
1745
1746 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1747    important.  Values of these types are the only ones which can be produced by
1748    instructions.</p>
1749
1750 </div>
1751
1752 <!-- ======================================================================= -->
1753 <h3>
1754   <a name="t_primitive">Primitive Types</a>
1755 </h3>
1756
1757 <div>
1758
1759 <p>The primitive types are the fundamental building blocks of the LLVM
1760    system.</p>
1761
1762 <!-- _______________________________________________________________________ -->
1763 <h4>
1764   <a name="t_integer">Integer Type</a>
1765 </h4>
1766
1767 <div>
1768
1769 <h5>Overview:</h5>
1770 <p>The integer type is a very simple type that simply specifies an arbitrary
1771    bit width for the integer type desired. Any bit width from 1 bit to
1772    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1773
1774 <h5>Syntax:</h5>
1775 <pre>
1776   iN
1777 </pre>
1778
1779 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1780    value.</p>
1781
1782 <h5>Examples:</h5>
1783 <table class="layout">
1784   <tr class="layout">
1785     <td class="left"><tt>i1</tt></td>
1786     <td class="left">a single-bit integer.</td>
1787   </tr>
1788   <tr class="layout">
1789     <td class="left"><tt>i32</tt></td>
1790     <td class="left">a 32-bit integer.</td>
1791   </tr>
1792   <tr class="layout">
1793     <td class="left"><tt>i1942652</tt></td>
1794     <td class="left">a really big integer of over 1 million bits.</td>
1795   </tr>
1796 </table>
1797
1798 </div>
1799
1800 <!-- _______________________________________________________________________ -->
1801 <h4>
1802   <a name="t_floating">Floating Point Types</a>
1803 </h4>
1804
1805 <div>
1806
1807 <table>
1808   <tbody>
1809     <tr><th>Type</th><th>Description</th></tr>
1810     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1811     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1812     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1813     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1814     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1815   </tbody>
1816 </table>
1817
1818 </div>
1819
1820 <!-- _______________________________________________________________________ -->
1821 <h4>
1822   <a name="t_x86mmx">X86mmx Type</a>
1823 </h4>
1824
1825 <div>
1826
1827 <h5>Overview:</h5>
1828 <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>
1829
1830 <h5>Syntax:</h5>
1831 <pre>
1832   x86mmx
1833 </pre>
1834
1835 </div>
1836
1837 <!-- _______________________________________________________________________ -->
1838 <h4>
1839   <a name="t_void">Void Type</a>
1840 </h4>
1841
1842 <div>
1843
1844 <h5>Overview:</h5>
1845 <p>The void type does not represent any value and has no size.</p>
1846
1847 <h5>Syntax:</h5>
1848 <pre>
1849   void
1850 </pre>
1851
1852 </div>
1853
1854 <!-- _______________________________________________________________________ -->
1855 <h4>
1856   <a name="t_label">Label Type</a>
1857 </h4>
1858
1859 <div>
1860
1861 <h5>Overview:</h5>
1862 <p>The label type represents code labels.</p>
1863
1864 <h5>Syntax:</h5>
1865 <pre>
1866   label
1867 </pre>
1868
1869 </div>
1870
1871 <!-- _______________________________________________________________________ -->
1872 <h4>
1873   <a name="t_metadata">Metadata Type</a>
1874 </h4>
1875
1876 <div>
1877
1878 <h5>Overview:</h5>
1879 <p>The metadata type represents embedded metadata. No derived types may be
1880    created from metadata except for <a href="#t_function">function</a>
1881    arguments.
1882
1883 <h5>Syntax:</h5>
1884 <pre>
1885   metadata
1886 </pre>
1887
1888 </div>
1889
1890 </div>
1891
1892 <!-- ======================================================================= -->
1893 <h3>
1894   <a name="t_derived">Derived Types</a>
1895 </h3>
1896
1897 <div>
1898
1899 <p>The real power in LLVM comes from the derived types in the system.  This is
1900    what allows a programmer to represent arrays, functions, pointers, and other
1901    useful types.  Each of these types contain one or more element types which
1902    may be a primitive type, or another derived type.  For example, it is
1903    possible to have a two dimensional array, using an array as the element type
1904    of another array.</p>
1905
1906 <!-- _______________________________________________________________________ -->
1907 <h4>
1908   <a name="t_aggregate">Aggregate Types</a>
1909 </h4>
1910
1911 <div>
1912
1913 <p>Aggregate Types are a subset of derived types that can contain multiple
1914   member types. <a href="#t_array">Arrays</a>,
1915   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1916   aggregate types.</p>
1917
1918 </div>
1919
1920 <!-- _______________________________________________________________________ -->
1921 <h4>
1922   <a name="t_array">Array Type</a>
1923 </h4>
1924
1925 <div>
1926
1927 <h5>Overview:</h5>
1928 <p>The array type is a very simple derived type that arranges elements
1929    sequentially in memory.  The array type requires a size (number of elements)
1930    and an underlying data type.</p>
1931
1932 <h5>Syntax:</h5>
1933 <pre>
1934   [&lt;# elements&gt; x &lt;elementtype&gt;]
1935 </pre>
1936
1937 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1938    be any type with a size.</p>
1939
1940 <h5>Examples:</h5>
1941 <table class="layout">
1942   <tr class="layout">
1943     <td class="left"><tt>[40 x i32]</tt></td>
1944     <td class="left">Array of 40 32-bit integer values.</td>
1945   </tr>
1946   <tr class="layout">
1947     <td class="left"><tt>[41 x i32]</tt></td>
1948     <td class="left">Array of 41 32-bit integer values.</td>
1949   </tr>
1950   <tr class="layout">
1951     <td class="left"><tt>[4 x i8]</tt></td>
1952     <td class="left">Array of 4 8-bit integer values.</td>
1953   </tr>
1954 </table>
1955 <p>Here are some examples of multidimensional arrays:</p>
1956 <table class="layout">
1957   <tr class="layout">
1958     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1959     <td class="left">3x4 array of 32-bit integer values.</td>
1960   </tr>
1961   <tr class="layout">
1962     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1963     <td class="left">12x10 array of single precision floating point values.</td>
1964   </tr>
1965   <tr class="layout">
1966     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1967     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1968   </tr>
1969 </table>
1970
1971 <p>There is no restriction on indexing beyond the end of the array implied by
1972    a static type (though there are restrictions on indexing beyond the bounds
1973    of an allocated object in some cases). This means that single-dimension
1974    'variable sized array' addressing can be implemented in LLVM with a zero
1975    length array type. An implementation of 'pascal style arrays' in LLVM could
1976    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1977
1978 </div>
1979
1980 <!-- _______________________________________________________________________ -->
1981 <h4>
1982   <a name="t_function">Function Type</a>
1983 </h4>
1984
1985 <div>
1986
1987 <h5>Overview:</h5>
1988 <p>The function type can be thought of as a function signature.  It consists of
1989    a return type and a list of formal parameter types. The return type of a
1990    function type is a first class type or a void type.</p>
1991
1992 <h5>Syntax:</h5>
1993 <pre>
1994   &lt;returntype&gt; (&lt;parameter list&gt;)
1995 </pre>
1996
1997 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1998    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1999    which indicates that the function takes a variable number of arguments.
2000    Variable argument functions can access their arguments with
2001    the <a href="#int_varargs">variable argument handling intrinsic</a>
2002    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
2003    <a href="#t_label">label</a>.</p>
2004
2005 <h5>Examples:</h5>
2006 <table class="layout">
2007   <tr class="layout">
2008     <td class="left"><tt>i32 (i32)</tt></td>
2009     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
2010     </td>
2011   </tr><tr class="layout">
2012     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
2013     </tt></td>
2014     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
2015       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
2016       returning <tt>float</tt>.
2017     </td>
2018   </tr><tr class="layout">
2019     <td class="left"><tt>i32 (i8*, ...)</tt></td>
2020     <td class="left">A vararg function that takes at least one
2021       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2022       which returns an integer.  This is the signature for <tt>printf</tt> in
2023       LLVM.
2024     </td>
2025   </tr><tr class="layout">
2026     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2027     <td class="left">A function taking an <tt>i32</tt>, returning a
2028         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2029     </td>
2030   </tr>
2031 </table>
2032
2033 </div>
2034
2035 <!-- _______________________________________________________________________ -->
2036 <h4>
2037   <a name="t_struct">Structure Type</a>
2038 </h4>
2039
2040 <div>
2041
2042 <h5>Overview:</h5>
2043 <p>The structure type is used to represent a collection of data members together
2044   in memory.  The elements of a structure may be any type that has a size.</p>
2045
2046 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2047    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2048    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2049    Structures in registers are accessed using the
2050    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2051    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2052
2053 <p>Structures may optionally be "packed" structures, which indicate that the
2054   alignment of the struct is one byte, and that there is no padding between
2055   the elements.  In non-packed structs, padding between field types is inserted
2056   as defined by the TargetData string in the module, which is required to match
2057   what the underlying code generator expects.</p>
2058
2059 <p>Structures can either be "literal" or "identified".  A literal structure is
2060   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) whereas identified
2061   types are always defined at the top level with a name.  Literal types are
2062   uniqued by their contents and can never be recursive or opaque since there is
2063   no way to write one.  Identified types can be recursive, can be opaqued, and are
2064   never uniqued.
2065 </p>
2066
2067 <h5>Syntax:</h5>
2068 <pre>
2069   %T1 = type { &lt;type list&gt; }     <i>; Identified normal struct type</i>
2070   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Identified packed struct type</i>
2071 </pre>
2072
2073 <h5>Examples:</h5>
2074 <table class="layout">
2075   <tr class="layout">
2076     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2077     <td class="left">A triple of three <tt>i32</tt> values</td>
2078   </tr>
2079   <tr class="layout">
2080     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2081     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2082       second element is a <a href="#t_pointer">pointer</a> to a
2083       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2084       an <tt>i32</tt>.</td>
2085   </tr>
2086   <tr class="layout">
2087     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2088     <td class="left">A packed struct known to be 5 bytes in size.</td>
2089   </tr>
2090 </table>
2091
2092 </div>
2093
2094 <!-- _______________________________________________________________________ -->
2095 <h4>
2096   <a name="t_opaque">Opaque Structure Types</a>
2097 </h4>
2098
2099 <div>
2100
2101 <h5>Overview:</h5>
2102 <p>Opaque structure types are used to represent named structure types that do
2103    not have a body specified.  This corresponds (for example) to the C notion of
2104    a forward declared structure.</p>
2105
2106 <h5>Syntax:</h5>
2107 <pre>
2108   %X = type opaque
2109   %52 = type opaque
2110 </pre>
2111
2112 <h5>Examples:</h5>
2113 <table class="layout">
2114   <tr class="layout">
2115     <td class="left"><tt>opaque</tt></td>
2116     <td class="left">An opaque type.</td>
2117   </tr>
2118 </table>
2119
2120 </div>
2121
2122
2123
2124 <!-- _______________________________________________________________________ -->
2125 <h4>
2126   <a name="t_pointer">Pointer Type</a>
2127 </h4>
2128
2129 <div>
2130
2131 <h5>Overview:</h5>
2132 <p>The pointer type is used to specify memory locations.
2133    Pointers are commonly used to reference objects in memory.</p>
2134
2135 <p>Pointer types may have an optional address space attribute defining the
2136    numbered address space where the pointed-to object resides. The default
2137    address space is number zero. The semantics of non-zero address
2138    spaces are target-specific.</p>
2139
2140 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2141    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2142
2143 <h5>Syntax:</h5>
2144 <pre>
2145   &lt;type&gt; *
2146 </pre>
2147
2148 <h5>Examples:</h5>
2149 <table class="layout">
2150   <tr class="layout">
2151     <td class="left"><tt>[4 x i32]*</tt></td>
2152     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2153                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2154   </tr>
2155   <tr class="layout">
2156     <td class="left"><tt>i32 (i32*) *</tt></td>
2157     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2158       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2159       <tt>i32</tt>.</td>
2160   </tr>
2161   <tr class="layout">
2162     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2163     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2164      that resides in address space #5.</td>
2165   </tr>
2166 </table>
2167
2168 </div>
2169
2170 <!-- _______________________________________________________________________ -->
2171 <h4>
2172   <a name="t_vector">Vector Type</a>
2173 </h4>
2174
2175 <div>
2176
2177 <h5>Overview:</h5>
2178 <p>A vector type is a simple derived type that represents a vector of elements.
2179    Vector types are used when multiple primitive data are operated in parallel
2180    using a single instruction (SIMD).  A vector type requires a size (number of
2181    elements) and an underlying primitive data type.  Vector types are considered
2182    <a href="#t_firstclass">first class</a>.</p>
2183
2184 <h5>Syntax:</h5>
2185 <pre>
2186   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2187 </pre>
2188
2189 <p>The number of elements is a constant integer value larger than 0; elementtype
2190    may be any integer or floating point type.  Vectors of size zero are not
2191    allowed, and pointers are not allowed as the element type.</p>
2192
2193 <h5>Examples:</h5>
2194 <table class="layout">
2195   <tr class="layout">
2196     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2197     <td class="left">Vector of 4 32-bit integer values.</td>
2198   </tr>
2199   <tr class="layout">
2200     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2201     <td class="left">Vector of 8 32-bit floating-point values.</td>
2202   </tr>
2203   <tr class="layout">
2204     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2205     <td class="left">Vector of 2 64-bit integer values.</td>
2206   </tr>
2207 </table>
2208
2209 </div>
2210
2211 </div>
2212
2213 </div>
2214
2215 <!-- *********************************************************************** -->
2216 <h2><a name="constants">Constants</a></h2>
2217 <!-- *********************************************************************** -->
2218
2219 <div>
2220
2221 <p>LLVM has several different basic types of constants.  This section describes
2222    them all and their syntax.</p>
2223
2224 <!-- ======================================================================= -->
2225 <h3>
2226   <a name="simpleconstants">Simple Constants</a>
2227 </h3>
2228
2229 <div>
2230
2231 <dl>
2232   <dt><b>Boolean constants</b></dt>
2233   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2234       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2235
2236   <dt><b>Integer constants</b></dt>
2237   <dd>Standard integers (such as '4') are constants of
2238       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2239       with integer types.</dd>
2240
2241   <dt><b>Floating point constants</b></dt>
2242   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2243       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2244       notation (see below).  The assembler requires the exact decimal value of a
2245       floating-point constant.  For example, the assembler accepts 1.25 but
2246       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2247       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2248
2249   <dt><b>Null pointer constants</b></dt>
2250   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2251       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2252 </dl>
2253
2254 <p>The one non-intuitive notation for constants is the hexadecimal form of
2255    floating point constants.  For example, the form '<tt>double
2256    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2257    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2258    constants are required (and the only time that they are generated by the
2259    disassembler) is when a floating point constant must be emitted but it cannot
2260    be represented as a decimal floating point number in a reasonable number of
2261    digits.  For example, NaN's, infinities, and other special values are
2262    represented in their IEEE hexadecimal format so that assembly and disassembly
2263    do not cause any bits to change in the constants.</p>
2264
2265 <p>When using the hexadecimal form, constants of types float and double are
2266    represented using the 16-digit form shown above (which matches the IEEE754
2267    representation for double); float values must, however, be exactly
2268    representable as IEE754 single precision.  Hexadecimal format is always used
2269    for long double, and there are three forms of long double.  The 80-bit format
2270    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2271    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2272    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2273    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2274    currently supported target uses this format.  Long doubles will only work if
2275    they match the long double format on your target.  All hexadecimal formats
2276    are big-endian (sign bit at the left).</p>
2277
2278 <p>There are no constants of type x86mmx.</p>
2279 </div>
2280
2281 <!-- ======================================================================= -->
2282 <h3>
2283 <a name="aggregateconstants"></a> <!-- old anchor -->
2284 <a name="complexconstants">Complex Constants</a>
2285 </h3>
2286
2287 <div>
2288
2289 <p>Complex constants are a (potentially recursive) combination of simple
2290    constants and smaller complex constants.</p>
2291
2292 <dl>
2293   <dt><b>Structure constants</b></dt>
2294   <dd>Structure constants are represented with notation similar to structure
2295       type definitions (a comma separated list of elements, surrounded by braces
2296       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2297       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2298       Structure constants must have <a href="#t_struct">structure type</a>, and
2299       the number and types of elements must match those specified by the
2300       type.</dd>
2301
2302   <dt><b>Array constants</b></dt>
2303   <dd>Array constants are represented with notation similar to array type
2304      definitions (a comma separated list of elements, surrounded by square
2305      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2306      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2307      the number and types of elements must match those specified by the
2308      type.</dd>
2309
2310   <dt><b>Vector constants</b></dt>
2311   <dd>Vector constants are represented with notation similar to vector type
2312       definitions (a comma separated list of elements, surrounded by
2313       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2314       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2315       have <a href="#t_vector">vector type</a>, and the number and types of
2316       elements must match those specified by the type.</dd>
2317
2318   <dt><b>Zero initialization</b></dt>
2319   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2320       value to zero of <em>any</em> type, including scalar and
2321       <a href="#t_aggregate">aggregate</a> types.
2322       This is often used to avoid having to print large zero initializers
2323       (e.g. for large arrays) and is always exactly equivalent to using explicit
2324       zero initializers.</dd>
2325
2326   <dt><b>Metadata node</b></dt>
2327   <dd>A metadata node is a structure-like constant with
2328       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2329       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2330       be interpreted as part of the instruction stream, metadata is a place to
2331       attach additional information such as debug info.</dd>
2332 </dl>
2333
2334 </div>
2335
2336 <!-- ======================================================================= -->
2337 <h3>
2338   <a name="globalconstants">Global Variable and Function Addresses</a>
2339 </h3>
2340
2341 <div>
2342
2343 <p>The addresses of <a href="#globalvars">global variables</a>
2344    and <a href="#functionstructure">functions</a> are always implicitly valid
2345    (link-time) constants.  These constants are explicitly referenced when
2346    the <a href="#identifiers">identifier for the global</a> is used and always
2347    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2348    legal LLVM file:</p>
2349
2350 <pre class="doc_code">
2351 @X = global i32 17
2352 @Y = global i32 42
2353 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2354 </pre>
2355
2356 </div>
2357
2358 <!-- ======================================================================= -->
2359 <h3>
2360   <a name="undefvalues">Undefined Values</a>
2361 </h3>
2362
2363 <div>
2364
2365 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2366    indicates that the user of the value may receive an unspecified bit-pattern.
2367    Undefined values may be of any type (other than '<tt>label</tt>'
2368    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2369
2370 <p>Undefined values are useful because they indicate to the compiler that the
2371    program is well defined no matter what value is used.  This gives the
2372    compiler more freedom to optimize.  Here are some examples of (potentially
2373    surprising) transformations that are valid (in pseudo IR):</p>
2374
2375
2376 <pre class="doc_code">
2377   %A = add %X, undef
2378   %B = sub %X, undef
2379   %C = xor %X, undef
2380 Safe:
2381   %A = undef
2382   %B = undef
2383   %C = undef
2384 </pre>
2385
2386 <p>This is safe because all of the output bits are affected by the undef bits.
2387    Any output bit can have a zero or one depending on the input bits.</p>
2388
2389 <pre class="doc_code">
2390   %A = or %X, undef
2391   %B = and %X, undef
2392 Safe:
2393   %A = -1
2394   %B = 0
2395 Unsafe:
2396   %A = undef
2397   %B = undef
2398 </pre>
2399
2400 <p>These logical operations have bits that are not always affected by the input.
2401    For example, if <tt>%X</tt> has a zero bit, then the output of the
2402    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2403    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2404    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2405    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2406    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2407    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2408    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2409
2410 <pre class="doc_code">
2411   %A = select undef, %X, %Y
2412   %B = select undef, 42, %Y
2413   %C = select %X, %Y, undef
2414 Safe:
2415   %A = %X     (or %Y)
2416   %B = 42     (or %Y)
2417   %C = %Y
2418 Unsafe:
2419   %A = undef
2420   %B = undef
2421   %C = undef
2422 </pre>
2423
2424 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2425    branch) conditions can go <em>either way</em>, but they have to come from one
2426    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2427    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2428    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2429    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2430    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2431    eliminated.</p>
2432
2433 <pre class="doc_code">
2434   %A = xor undef, undef
2435
2436   %B = undef
2437   %C = xor %B, %B
2438
2439   %D = undef
2440   %E = icmp lt %D, 4
2441   %F = icmp gte %D, 4
2442
2443 Safe:
2444   %A = undef
2445   %B = undef
2446   %C = undef
2447   %D = undef
2448   %E = undef
2449   %F = undef
2450 </pre>
2451
2452 <p>This example points out that two '<tt>undef</tt>' operands are not
2453    necessarily the same. This can be surprising to people (and also matches C
2454    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2455    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2456    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2457    its value over its "live range".  This is true because the variable doesn't
2458    actually <em>have a live range</em>. Instead, the value is logically read
2459    from arbitrary registers that happen to be around when needed, so the value
2460    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2461    need to have the same semantics or the core LLVM "replace all uses with"
2462    concept would not hold.</p>
2463
2464 <pre class="doc_code">
2465   %A = fdiv undef, %X
2466   %B = fdiv %X, undef
2467 Safe:
2468   %A = undef
2469 b: unreachable
2470 </pre>
2471
2472 <p>These examples show the crucial difference between an <em>undefined
2473   value</em> and <em>undefined behavior</em>. An undefined value (like
2474   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2475   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2476   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2477   defined on SNaN's. However, in the second example, we can make a more
2478   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2479   arbitrary value, we are allowed to assume that it could be zero. Since a
2480   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2481   the operation does not execute at all. This allows us to delete the divide and
2482   all code after it. Because the undefined operation "can't happen", the
2483   optimizer can assume that it occurs in dead code.</p>
2484
2485 <pre class="doc_code">
2486 a:  store undef -> %X
2487 b:  store %X -> undef
2488 Safe:
2489 a: &lt;deleted&gt;
2490 b: unreachable
2491 </pre>
2492
2493 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2494    undefined value can be assumed to not have any effect; we can assume that the
2495    value is overwritten with bits that happen to match what was already there.
2496    However, a store <em>to</em> an undefined location could clobber arbitrary
2497    memory, therefore, it has undefined behavior.</p>
2498
2499 </div>
2500
2501 <!-- ======================================================================= -->
2502 <h3>
2503   <a name="trapvalues">Trap Values</a>
2504 </h3>
2505
2506 <div>
2507
2508 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2509    instead of representing an unspecified bit pattern, they represent the
2510    fact that an instruction or constant expression which cannot evoke side
2511    effects has nevertheless detected a condition which results in undefined
2512    behavior.</p>
2513
2514 <p>There is currently no way of representing a trap value in the IR; they
2515    only exist when produced by operations such as
2516    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2517
2518 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2519
2520 <ul>
2521 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2522     their operands.</li>
2523
2524 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2525     to their dynamic predecessor basic block.</li>
2526
2527 <li>Function arguments depend on the corresponding actual argument values in
2528     the dynamic callers of their functions.</li>
2529
2530 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2531     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2532     control back to them.</li>
2533
2534 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2535     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2536     or exception-throwing call instructions that dynamically transfer control
2537     back to them.</li>
2538
2539 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2540     referenced memory addresses, following the order in the IR
2541     (including loads and stores implied by intrinsics such as
2542     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2543
2544 <!-- TODO: In the case of multiple threads, this only applies if the store
2545      "happens-before" the load or store. -->
2546
2547 <!-- TODO: floating-point exception state -->
2548
2549 <li>An instruction with externally visible side effects depends on the most
2550     recent preceding instruction with externally visible side effects, following
2551     the order in the IR. (This includes
2552     <a href="#volatile">volatile operations</a>.)</li>
2553
2554 <li>An instruction <i>control-depends</i> on a
2555     <a href="#terminators">terminator instruction</a>
2556     if the terminator instruction has multiple successors and the instruction
2557     is always executed when control transfers to one of the successors, and
2558     may not be executed when control is transferred to another.</li>
2559
2560 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2561     instruction if the set of instructions it otherwise depends on would be
2562     different if the terminator had transferred control to a different
2563     successor.</li>
2564
2565 <li>Dependence is transitive.</li>
2566
2567 </ul>
2568
2569 <p>Whenever a trap value is generated, all values which depend on it evaluate
2570    to trap. If they have side effects, they evoke their side effects as if each
2571    operand with a trap value were undef. If they have externally-visible side
2572    effects, the behavior is undefined.</p>
2573
2574 <p>Here are some examples:</p>
2575
2576 <pre class="doc_code">
2577 entry:
2578   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2579   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2580   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2581   store i32 0, i32* %trap_yet_again  ; undefined behavior
2582
2583   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2584   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2585
2586   store volatile i32 %trap, i32* @g  ; External observation; undefined behavior.
2587
2588   %narrowaddr = bitcast i32* @g to i16*
2589   %wideaddr = bitcast i32* @g to i64*
2590   %trap3 = load i16* %narrowaddr     ; Returns a trap value.
2591   %trap4 = load i64* %wideaddr       ; Returns a trap value.
2592
2593   %cmp = icmp slt i32 %trap, 0       ; Returns a trap value.
2594   br i1 %cmp, label %true, label %end ; Branch to either destination.
2595
2596 true:
2597   store volatile i32 0, i32* @g      ; This is control-dependent on %cmp, so
2598                                      ; it has undefined behavior.
2599   br label %end
2600
2601 end:
2602   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2603                                      ; Both edges into this PHI are
2604                                      ; control-dependent on %cmp, so this
2605                                      ; always results in a trap value.
2606
2607   store volatile i32 0, i32* @g      ; This would depend on the store in %true
2608                                      ; if %cmp is true, or the store in %entry
2609                                      ; otherwise, so this is undefined behavior.
2610
2611   br i1 %cmp, label %second_true, label %second_end
2612                                      ; The same branch again, but this time the
2613                                      ; true block doesn't have side effects.
2614
2615 second_true:
2616   ; No side effects!
2617   ret void
2618
2619 second_end:
2620   store volatile i32 0, i32* @g      ; This time, the instruction always depends
2621                                      ; on the store in %end. Also, it is
2622                                      ; control-equivalent to %end, so this is
2623                                      ; well-defined (again, ignoring earlier
2624                                      ; undefined behavior in this example).
2625 </pre>
2626
2627 </div>
2628
2629 <!-- ======================================================================= -->
2630 <h3>
2631   <a name="blockaddress">Addresses of Basic Blocks</a>
2632 </h3>
2633
2634 <div>
2635
2636 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2637
2638 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2639    basic block in the specified function, and always has an i8* type.  Taking
2640    the address of the entry block is illegal.</p>
2641
2642 <p>This value only has defined behavior when used as an operand to the
2643    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2644    comparisons against null. Pointer equality tests between labels addresses
2645    results in undefined behavior &mdash; though, again, comparison against null
2646    is ok, and no label is equal to the null pointer. This may be passed around
2647    as an opaque pointer sized value as long as the bits are not inspected. This
2648    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2649    long as the original value is reconstituted before the <tt>indirectbr</tt>
2650    instruction.</p>
2651
2652 <p>Finally, some targets may provide defined semantics when using the value as
2653    the operand to an inline assembly, but that is target specific.</p>
2654
2655 </div>
2656
2657
2658 <!-- ======================================================================= -->
2659 <h3>
2660   <a name="constantexprs">Constant Expressions</a>
2661 </h3>
2662
2663 <div>
2664
2665 <p>Constant expressions are used to allow expressions involving other constants
2666    to be used as constants.  Constant expressions may be of
2667    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2668    operation that does not have side effects (e.g. load and call are not
2669    supported). The following is the syntax for constant expressions:</p>
2670
2671 <dl>
2672   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2673   <dd>Truncate a constant to another type. The bit size of CST must be larger
2674       than the bit size of TYPE. Both types must be integers.</dd>
2675
2676   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2677   <dd>Zero extend a constant to another type. The bit size of CST must be
2678       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2679
2680   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2681   <dd>Sign extend a constant to another type. The bit size of CST must be
2682       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2683
2684   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2685   <dd>Truncate a floating point constant to another floating point type. The
2686       size of CST must be larger than the size of TYPE. Both types must be
2687       floating point.</dd>
2688
2689   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2690   <dd>Floating point extend a constant to another type. The size of CST must be
2691       smaller or equal to the size of TYPE. Both types must be floating
2692       point.</dd>
2693
2694   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2695   <dd>Convert a floating point constant to the corresponding unsigned integer
2696       constant. TYPE must be a scalar or vector integer type. CST must be of
2697       scalar or vector floating point type. Both CST and TYPE must be scalars,
2698       or vectors of the same number of elements. If the value won't fit in the
2699       integer type, the results are undefined.</dd>
2700
2701   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2702   <dd>Convert a floating point constant to the corresponding signed integer
2703       constant.  TYPE must be a scalar or vector integer type. CST must be of
2704       scalar or vector floating point type. Both CST and TYPE must be scalars,
2705       or vectors of the same number of elements. If the value won't fit in the
2706       integer type, the results are undefined.</dd>
2707
2708   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2709   <dd>Convert an unsigned integer constant to the corresponding floating point
2710       constant. TYPE must be a scalar or vector floating point type. CST must be
2711       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2712       vectors of the same number of elements. If the value won't fit in the
2713       floating point type, the results are undefined.</dd>
2714
2715   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2716   <dd>Convert a signed integer constant to the corresponding floating point
2717       constant. TYPE must be a scalar or vector floating point type. CST must be
2718       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2719       vectors of the same number of elements. If the value won't fit in the
2720       floating point type, the results are undefined.</dd>
2721
2722   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2723   <dd>Convert a pointer typed constant to the corresponding integer constant
2724       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2725       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2726       make it fit in <tt>TYPE</tt>.</dd>
2727
2728   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2729   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2730       type.  CST must be of integer type. The CST value is zero extended,
2731       truncated, or unchanged to make it fit in a pointer size. This one is
2732       <i>really</i> dangerous!</dd>
2733
2734   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2735   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2736       are the same as those for the <a href="#i_bitcast">bitcast
2737       instruction</a>.</dd>
2738
2739   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2740   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2741   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2742       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2743       instruction, the index list may have zero or more indexes, which are
2744       required to make sense for the type of "CSTPTR".</dd>
2745
2746   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2747   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2748
2749   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2750   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2751
2752   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2753   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2754
2755   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2756   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2757       constants.</dd>
2758
2759   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2760   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2761     constants.</dd>
2762
2763   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2764   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2765       constants.</dd>
2766
2767   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2768   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2769     constants. The index list is interpreted in a similar manner as indices in
2770     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2771     index value must be specified.</dd>
2772
2773   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2774   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2775     constants. The index list is interpreted in a similar manner as indices in
2776     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2777     index value must be specified.</dd>
2778
2779   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2780   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2781       be any of the <a href="#binaryops">binary</a>
2782       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2783       on operands are the same as those for the corresponding instruction
2784       (e.g. no bitwise operations on floating point values are allowed).</dd>
2785 </dl>
2786
2787 </div>
2788
2789 </div>
2790
2791 <!-- *********************************************************************** -->
2792 <h2><a name="othervalues">Other Values</a></h2>
2793 <!-- *********************************************************************** -->
2794 <div>
2795 <!-- ======================================================================= -->
2796 <h3>
2797 <a name="inlineasm">Inline Assembler Expressions</a>
2798 </h3>
2799
2800 <div>
2801
2802 <p>LLVM supports inline assembler expressions (as opposed
2803    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2804    a special value.  This value represents the inline assembler as a string
2805    (containing the instructions to emit), a list of operand constraints (stored
2806    as a string), a flag that indicates whether or not the inline asm
2807    expression has side effects, and a flag indicating whether the function
2808    containing the asm needs to align its stack conservatively.  An example
2809    inline assembler expression is:</p>
2810
2811 <pre class="doc_code">
2812 i32 (i32) asm "bswap $0", "=r,r"
2813 </pre>
2814
2815 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2816    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2817    have:</p>
2818
2819 <pre class="doc_code">
2820 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2821 </pre>
2822
2823 <p>Inline asms with side effects not visible in the constraint list must be
2824    marked as having side effects.  This is done through the use of the
2825    '<tt>sideeffect</tt>' keyword, like so:</p>
2826
2827 <pre class="doc_code">
2828 call void asm sideeffect "eieio", ""()
2829 </pre>
2830
2831 <p>In some cases inline asms will contain code that will not work unless the
2832    stack is aligned in some way, such as calls or SSE instructions on x86,
2833    yet will not contain code that does that alignment within the asm.
2834    The compiler should make conservative assumptions about what the asm might
2835    contain and should generate its usual stack alignment code in the prologue
2836    if the '<tt>alignstack</tt>' keyword is present:</p>
2837
2838 <pre class="doc_code">
2839 call void asm alignstack "eieio", ""()
2840 </pre>
2841
2842 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2843    first.</p>
2844
2845 <p>TODO: The format of the asm and constraints string still need to be
2846    documented here.  Constraints on what can be done (e.g. duplication, moving,
2847    etc need to be documented).  This is probably best done by reference to
2848    another document that covers inline asm from a holistic perspective.</p>
2849
2850 <h4>
2851 <a name="inlineasm_md">Inline Asm Metadata</a>
2852 </h4>
2853
2854 <div>
2855
2856 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2857    attached to it that contains a list of constant integers.  If present, the
2858   code generator will use the integer as the location cookie value when report
2859    errors through the LLVMContext error reporting mechanisms.  This allows a
2860    front-end to correlate backend errors that occur with inline asm back to the
2861    source code that produced it.  For example:</p>
2862
2863 <pre class="doc_code">
2864 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2865 ...
2866 !42 = !{ i32 1234567 }
2867 </pre>
2868
2869 <p>It is up to the front-end to make sense of the magic numbers it places in the
2870    IR.  If the MDNode contains multiple constants, the code generator will use
2871    the one that corresponds to the line of the asm that the error occurs on.</p>
2872
2873 </div>
2874
2875 </div>
2876
2877 <!-- ======================================================================= -->
2878 <h3>
2879   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2880 </h3>
2881
2882 <div>
2883
2884 <p>LLVM IR allows metadata to be attached to instructions in the program that
2885    can convey extra information about the code to the optimizers and code
2886    generator.  One example application of metadata is source-level debug
2887    information.  There are two metadata primitives: strings and nodes. All
2888    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2889    preceding exclamation point ('<tt>!</tt>').</p>
2890
2891 <p>A metadata string is a string surrounded by double quotes.  It can contain
2892    any character by escaping non-printable characters with "<tt>\xx</tt>" where
2893    "<tt>xx</tt>" is the two digit hex code.  For example:
2894    "<tt>!"test\00"</tt>".</p>
2895
2896 <p>Metadata nodes are represented with notation similar to structure constants
2897    (a comma separated list of elements, surrounded by braces and preceded by an
2898    exclamation point). Metadata nodes can have any values as their operand. For
2899    example:</p>
2900
2901 <div class="doc_code">
2902 <pre>
2903 !{ metadata !"test\00", i32 10}
2904 </pre>
2905 </div>
2906
2907 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2908    metadata nodes, which can be looked up in the module symbol table. For
2909    example:</p>
2910
2911 <div class="doc_code">
2912 <pre>
2913 !foo =  metadata !{!4, !3}
2914 </pre>
2915 </div>
2916
2917 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2918    function is using two metadata arguments:</p>
2919
2920 <div class="doc_code">
2921 <pre>
2922 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2923 </pre>
2924 </div>
2925
2926 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2927    attached to the <tt>add</tt> instruction using the <tt>!dbg</tt>
2928    identifier:</p>
2929
2930 <div class="doc_code">
2931 <pre>
2932 %indvar.next = add i64 %indvar, 1, !dbg !21
2933 </pre>
2934 </div>
2935
2936 <p>More information about specific metadata nodes recognized by the optimizers
2937    and code generator is found below.</p>
2938
2939 <!-- _______________________________________________________________________ -->
2940 <h4>
2941   <a name="tbaa">'<tt>tbaa</tt>' Metadata</a>
2942 </h4>
2943
2944 <div>
2945
2946 <p>In LLVM IR, memory does not have types, so LLVM's own type system is not
2947    suitable for doing TBAA. Instead, metadata is added to the IR to describe
2948    a type system of a higher level language. This can be used to implement
2949    typical C/C++ TBAA, but it can also be used to implement custom alias
2950    analysis behavior for other languages.</p>
2951
2952 <p>The current metadata format is very simple. TBAA metadata nodes have up to
2953    three fields, e.g.:</p>
2954
2955 <div class="doc_code">
2956 <pre>
2957 !0 = metadata !{ metadata !"an example type tree" }
2958 !1 = metadata !{ metadata !"int", metadata !0 }
2959 !2 = metadata !{ metadata !"float", metadata !0 }
2960 !3 = metadata !{ metadata !"const float", metadata !2, i64 1 }
2961 </pre>
2962 </div>
2963
2964 <p>The first field is an identity field. It can be any value, usually
2965    a metadata string, which uniquely identifies the type. The most important
2966    name in the tree is the name of the root node. Two trees with
2967    different root node names are entirely disjoint, even if they
2968    have leaves with common names.</p>
2969
2970 <p>The second field identifies the type's parent node in the tree, or
2971    is null or omitted for a root node. A type is considered to alias
2972    all of its descendants and all of its ancestors in the tree. Also,
2973    a type is considered to alias all types in other trees, so that
2974    bitcode produced from multiple front-ends is handled conservatively.</p>
2975
2976 <p>If the third field is present, it's an integer which if equal to 1
2977    indicates that the type is "constant" (meaning
2978    <tt>pointsToConstantMemory</tt> should return true; see
2979    <a href="AliasAnalysis.html#OtherItfs">other useful
2980    <tt>AliasAnalysis</tt> methods</a>).</p>
2981
2982 </div>
2983
2984 <!-- _______________________________________________________________________ -->
2985 <h4>
2986   <a name="fpaccuracy">'<tt>fpaccuracy</tt>' Metadata</a>
2987 </h4>
2988
2989 <div>
2990
2991 <p><tt>fpaccuracy</tt> metadata may be attached to any instruction of floating
2992    point type.  It expresses the maximum relative error of the result of
2993    that instruction, in ULPs. ULP is defined as follows:</p>
2994
2995 <blockquote>
2996
2997 <p>If <tt>x</tt> is a real number that lies between two finite consecutive
2998    floating-point numbers <tt>a</tt> and <tt>b</tt>, without being equal to one
2999    of them, then <tt>ulp(x) = |b - a|</tt>, otherwise <tt>ulp(x)</tt> is the
3000    distance between the two non-equal finite floating-point numbers nearest
3001    <tt>x</tt>. Moreover, <tt>ulp(NaN)</tt> is <tt>NaN</tt>.</p>
3002
3003 </blockquote>
3004
3005 <p>The maximum relative error may be any rational number.  The metadata node
3006    shall consist of a pair of unsigned integers respectively representing
3007    the numerator and denominator.  For example, 2.5 ULP:</p>
3008
3009 <div class="doc_code">
3010 <pre>
3011 !0 = metadata !{ i32 5, i32 2 }
3012 </pre>
3013 </div>
3014
3015 </div>
3016
3017 </div>
3018
3019 </div>
3020
3021 <!-- *********************************************************************** -->
3022 <h2>
3023   <a name="intrinsic_globals">Intrinsic Global Variables</a>
3024 </h2>
3025 <!-- *********************************************************************** -->
3026 <div>
3027 <p>LLVM has a number of "magic" global variables that contain data that affect
3028 code generation or other IR semantics.  These are documented here.  All globals
3029 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
3030 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
3031 by LLVM.</p>
3032
3033 <!-- ======================================================================= -->
3034 <h3>
3035 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
3036 </h3>
3037
3038 <div>
3039
3040 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
3041 href="#linkage_appending">appending linkage</a>.  This array contains a list of
3042 pointers to global variables and functions which may optionally have a pointer
3043 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
3044
3045 <div class="doc_code">
3046 <pre>
3047 @X = global i8 4
3048 @Y = global i32 123
3049
3050 @llvm.used = appending global [2 x i8*] [
3051    i8* @X,
3052    i8* bitcast (i32* @Y to i8*)
3053 ], section "llvm.metadata"
3054 </pre>
3055 </div>
3056
3057 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
3058    compiler, assembler, and linker are required to treat the symbol as if there
3059    is a reference to the global that it cannot see.  For example, if a variable
3060    has internal linkage and no references other than that from
3061    the <tt>@llvm.used</tt> list, it cannot be deleted.  This is commonly used to
3062    represent references from inline asms and other things the compiler cannot
3063    "see", and corresponds to "<tt>attribute((used))</tt>" in GNU C.</p>
3064
3065 <p>On some targets, the code generator must emit a directive to the assembler or
3066    object file to prevent the assembler and linker from molesting the
3067    symbol.</p>
3068
3069 </div>
3070
3071 <!-- ======================================================================= -->
3072 <h3>
3073   <a name="intg_compiler_used">
3074     The '<tt>llvm.compiler.used</tt>' Global Variable
3075   </a>
3076 </h3>
3077
3078 <div>
3079
3080 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
3081    <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
3082    touching the symbol.  On targets that support it, this allows an intelligent
3083    linker to optimize references to the symbol without being impeded as it would
3084    be by <tt>@llvm.used</tt>.</p>
3085
3086 <p>This is a rare construct that should only be used in rare circumstances, and
3087    should not be exposed to source languages.</p>
3088
3089 </div>
3090
3091 <!-- ======================================================================= -->
3092 <h3>
3093 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
3094 </h3>
3095
3096 <div>
3097
3098 <div class="doc_code">
3099 <pre>
3100 %0 = type { i32, void ()* }
3101 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
3102 </pre>
3103 </div>
3104
3105 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor
3106    functions and associated priorities.  The functions referenced by this array
3107    will be called in ascending order of priority (i.e. lowest first) when the
3108    module is loaded.  The order of functions with the same priority is not
3109    defined.</p>
3110
3111 </div>
3112
3113 <!-- ======================================================================= -->
3114 <h3>
3115 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
3116 </h3>
3117
3118 <div>
3119
3120 <div class="doc_code">
3121 <pre>
3122 %0 = type { i32, void ()* }
3123 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
3124 </pre>
3125 </div>
3126
3127 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions
3128    and associated priorities.  The functions referenced by this array will be
3129    called in descending order of priority (i.e. highest first) when the module
3130    is loaded.  The order of functions with the same priority is not defined.</p>
3131
3132 </div>
3133
3134 </div>
3135
3136 <!-- *********************************************************************** -->
3137 <h2><a name="instref">Instruction Reference</a></h2>
3138 <!-- *********************************************************************** -->
3139
3140 <div>
3141
3142 <p>The LLVM instruction set consists of several different classifications of
3143    instructions: <a href="#terminators">terminator
3144    instructions</a>, <a href="#binaryops">binary instructions</a>,
3145    <a href="#bitwiseops">bitwise binary instructions</a>,
3146    <a href="#memoryops">memory instructions</a>, and
3147    <a href="#otherops">other instructions</a>.</p>
3148
3149 <!-- ======================================================================= -->
3150 <h3>
3151   <a name="terminators">Terminator Instructions</a>
3152 </h3>
3153
3154 <div>
3155
3156 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3157    in a program ends with a "Terminator" instruction, which indicates which
3158    block should be executed after the current block is finished. These
3159    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3160    control flow, not values (the one exception being the
3161    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3162
3163 <p>The terminator instructions are:
3164    '<a href="#i_ret"><tt>ret</tt></a>',
3165    '<a href="#i_br"><tt>br</tt></a>',
3166    '<a href="#i_switch"><tt>switch</tt></a>',
3167    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3168    '<a href="#i_invoke"><tt>invoke</tt></a>',
3169    '<a href="#i_unwind"><tt>unwind</tt></a>',
3170    '<a href="#i_resume"><tt>resume</tt></a>', and
3171    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3172
3173 <!-- _______________________________________________________________________ -->
3174 <h4>
3175   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3176 </h4>
3177
3178 <div>
3179
3180 <h5>Syntax:</h5>
3181 <pre>
3182   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3183   ret void                 <i>; Return from void function</i>
3184 </pre>
3185
3186 <h5>Overview:</h5>
3187 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3188    a value) from a function back to the caller.</p>
3189
3190 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3191    value and then causes control flow, and one that just causes control flow to
3192    occur.</p>
3193
3194 <h5>Arguments:</h5>
3195 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3196    return value. The type of the return value must be a
3197    '<a href="#t_firstclass">first class</a>' type.</p>
3198
3199 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3200    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3201    value or a return value with a type that does not match its type, or if it
3202    has a void return type and contains a '<tt>ret</tt>' instruction with a
3203    return value.</p>
3204
3205 <h5>Semantics:</h5>
3206 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3207    the calling function's context.  If the caller is a
3208    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3209    instruction after the call.  If the caller was an
3210    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3211    the beginning of the "normal" destination block.  If the instruction returns
3212    a value, that value shall set the call or invoke instruction's return
3213    value.</p>
3214
3215 <h5>Example:</h5>
3216 <pre>
3217   ret i32 5                       <i>; Return an integer value of 5</i>
3218   ret void                        <i>; Return from a void function</i>
3219   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3220 </pre>
3221
3222 </div>
3223 <!-- _______________________________________________________________________ -->
3224 <h4>
3225   <a name="i_br">'<tt>br</tt>' Instruction</a>
3226 </h4>
3227
3228 <div>
3229
3230 <h5>Syntax:</h5>
3231 <pre>
3232   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3233   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3234 </pre>
3235
3236 <h5>Overview:</h5>
3237 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3238    different basic block in the current function.  There are two forms of this
3239    instruction, corresponding to a conditional branch and an unconditional
3240    branch.</p>
3241
3242 <h5>Arguments:</h5>
3243 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3244    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3245    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3246    target.</p>
3247
3248 <h5>Semantics:</h5>
3249 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3250    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3251    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3252    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3253
3254 <h5>Example:</h5>
3255 <pre>
3256 Test:
3257   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3258   br i1 %cond, label %IfEqual, label %IfUnequal
3259 IfEqual:
3260   <a href="#i_ret">ret</a> i32 1
3261 IfUnequal:
3262   <a href="#i_ret">ret</a> i32 0
3263 </pre>
3264
3265 </div>
3266
3267 <!-- _______________________________________________________________________ -->
3268 <h4>
3269    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3270 </h4>
3271
3272 <div>
3273
3274 <h5>Syntax:</h5>
3275 <pre>
3276   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3277 </pre>
3278
3279 <h5>Overview:</h5>
3280 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3281    several different places.  It is a generalization of the '<tt>br</tt>'
3282    instruction, allowing a branch to occur to one of many possible
3283    destinations.</p>
3284
3285 <h5>Arguments:</h5>
3286 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3287    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3288    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3289    The table is not allowed to contain duplicate constant entries.</p>
3290
3291 <h5>Semantics:</h5>
3292 <p>The <tt>switch</tt> instruction specifies a table of values and
3293    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3294    is searched for the given value.  If the value is found, control flow is
3295    transferred to the corresponding destination; otherwise, control flow is
3296    transferred to the default destination.</p>
3297
3298 <h5>Implementation:</h5>
3299 <p>Depending on properties of the target machine and the particular
3300    <tt>switch</tt> instruction, this instruction may be code generated in
3301    different ways.  For example, it could be generated as a series of chained
3302    conditional branches or with a lookup table.</p>
3303
3304 <h5>Example:</h5>
3305 <pre>
3306  <i>; Emulate a conditional br instruction</i>
3307  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3308  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3309
3310  <i>; Emulate an unconditional br instruction</i>
3311  switch i32 0, label %dest [ ]
3312
3313  <i>; Implement a jump table:</i>
3314  switch i32 %val, label %otherwise [ i32 0, label %onzero
3315                                      i32 1, label %onone
3316                                      i32 2, label %ontwo ]
3317 </pre>
3318
3319 </div>
3320
3321
3322 <!-- _______________________________________________________________________ -->
3323 <h4>
3324    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3325 </h4>
3326
3327 <div>
3328
3329 <h5>Syntax:</h5>
3330 <pre>
3331   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3332 </pre>
3333
3334 <h5>Overview:</h5>
3335
3336 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3337    within the current function, whose address is specified by
3338    "<tt>address</tt>".  Address must be derived from a <a
3339    href="#blockaddress">blockaddress</a> constant.</p>
3340
3341 <h5>Arguments:</h5>
3342
3343 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3344    rest of the arguments indicate the full set of possible destinations that the
3345    address may point to.  Blocks are allowed to occur multiple times in the
3346    destination list, though this isn't particularly useful.</p>
3347
3348 <p>This destination list is required so that dataflow analysis has an accurate
3349    understanding of the CFG.</p>
3350
3351 <h5>Semantics:</h5>
3352
3353 <p>Control transfers to the block specified in the address argument.  All
3354    possible destination blocks must be listed in the label list, otherwise this
3355    instruction has undefined behavior.  This implies that jumps to labels
3356    defined in other functions have undefined behavior as well.</p>
3357
3358 <h5>Implementation:</h5>
3359
3360 <p>This is typically implemented with a jump through a register.</p>
3361
3362 <h5>Example:</h5>
3363 <pre>
3364  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3365 </pre>
3366
3367 </div>
3368
3369
3370 <!-- _______________________________________________________________________ -->
3371 <h4>
3372   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3373 </h4>
3374
3375 <div>
3376
3377 <h5>Syntax:</h5>
3378 <pre>
3379   &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>]
3380                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3381 </pre>
3382
3383 <h5>Overview:</h5>
3384 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3385    function, with the possibility of control flow transfer to either the
3386    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3387    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3388    control flow will return to the "normal" label.  If the callee (or any
3389    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3390    instruction, control is interrupted and continued at the dynamically nearest
3391    "exception" label.</p>
3392
3393 <p>The '<tt>exception</tt>' label is a
3394    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3395    exception. As such, '<tt>exception</tt>' label is required to have the
3396    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3397    the information about about the behavior of the program after unwinding
3398    happens, as its first non-PHI instruction. The restrictions on the
3399    "<tt>landingpad</tt>" instruction's tightly couples it to the
3400    "<tt>invoke</tt>" instruction, so that the important information contained
3401    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3402    code motion.</p>
3403
3404 <h5>Arguments:</h5>
3405 <p>This instruction requires several arguments:</p>
3406
3407 <ol>
3408   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3409       convention</a> the call should use.  If none is specified, the call
3410       defaults to using C calling conventions.</li>
3411
3412   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3413       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3414       '<tt>inreg</tt>' attributes are valid here.</li>
3415
3416   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3417       function value being invoked.  In most cases, this is a direct function
3418       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3419       off an arbitrary pointer to function value.</li>
3420
3421   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3422       function to be invoked. </li>
3423
3424   <li>'<tt>function args</tt>': argument list whose types match the function
3425       signature argument types and parameter attributes. All arguments must be
3426       of <a href="#t_firstclass">first class</a> type. If the function
3427       signature indicates the function accepts a variable number of arguments,
3428       the extra arguments can be specified.</li>
3429
3430   <li>'<tt>normal label</tt>': the label reached when the called function
3431       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3432
3433   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3434       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3435
3436   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3437       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3438       '<tt>readnone</tt>' attributes are valid here.</li>
3439 </ol>
3440
3441 <h5>Semantics:</h5>
3442 <p>This instruction is designed to operate as a standard
3443    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3444    primary difference is that it establishes an association with a label, which
3445    is used by the runtime library to unwind the stack.</p>
3446
3447 <p>This instruction is used in languages with destructors to ensure that proper
3448    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3449    exception.  Additionally, this is important for implementation of
3450    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3451
3452 <p>For the purposes of the SSA form, the definition of the value returned by the
3453    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3454    block to the "normal" label. If the callee unwinds then no return value is
3455    available.</p>
3456
3457 <p>Note that the code generator does not yet completely support unwind, and
3458 that the invoke/unwind semantics are likely to change in future versions.</p>
3459
3460 <h5>Example:</h5>
3461 <pre>
3462   %retval = invoke i32 @Test(i32 15) to label %Continue
3463               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3464   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3465               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3466 </pre>
3467
3468 </div>
3469
3470 <!-- _______________________________________________________________________ -->
3471
3472 <h4>
3473   <a name="i_unwind">'<tt>unwind</tt>' Instruction</a>
3474 </h4>
3475
3476 <div>
3477
3478 <h5>Syntax:</h5>
3479 <pre>
3480   unwind
3481 </pre>
3482
3483 <h5>Overview:</h5>
3484 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3485    at the first callee in the dynamic call stack which used
3486    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3487    This is primarily used to implement exception handling.</p>
3488
3489 <h5>Semantics:</h5>
3490 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3491    immediately halt.  The dynamic call stack is then searched for the
3492    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3493    Once found, execution continues at the "exceptional" destination block
3494    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3495    instruction in the dynamic call chain, undefined behavior results.</p>
3496
3497 <p>Note that the code generator does not yet completely support unwind, and
3498 that the invoke/unwind semantics are likely to change in future versions.</p>
3499
3500 </div>
3501
3502  <!-- _______________________________________________________________________ -->
3503
3504 <h4>
3505   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3506 </h4>
3507
3508 <div>
3509
3510 <h5>Syntax:</h5>
3511 <pre>
3512   resume &lt;type&gt; &lt;value&gt;
3513 </pre>
3514
3515 <h5>Overview:</h5>
3516 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3517    successors.</p>
3518
3519 <h5>Arguments:</h5>
3520 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3521    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3522    function.</p>
3523
3524 <h5>Semantics:</h5>
3525 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3526    (in-flight) exception whose unwinding was interrupted with
3527    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3528
3529 <h5>Example:</h5>
3530 <pre>
3531   resume { i8*, i32 } %exn
3532 </pre>
3533
3534 </div>
3535
3536 <!-- _______________________________________________________________________ -->
3537
3538 <h4>
3539   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3540 </h4>
3541
3542 <div>
3543
3544 <h5>Syntax:</h5>
3545 <pre>
3546   unreachable
3547 </pre>
3548
3549 <h5>Overview:</h5>
3550 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3551    instruction is used to inform the optimizer that a particular portion of the
3552    code is not reachable.  This can be used to indicate that the code after a
3553    no-return function cannot be reached, and other facts.</p>
3554
3555 <h5>Semantics:</h5>
3556 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3557
3558 </div>
3559
3560 </div>
3561
3562 <!-- ======================================================================= -->
3563 <h3>
3564   <a name="binaryops">Binary Operations</a>
3565 </h3>
3566
3567 <div>
3568
3569 <p>Binary operators are used to do most of the computation in a program.  They
3570    require two operands of the same type, execute an operation on them, and
3571    produce a single value.  The operands might represent multiple data, as is
3572    the case with the <a href="#t_vector">vector</a> data type.  The result value
3573    has the same type as its operands.</p>
3574
3575 <p>There are several different binary operators:</p>
3576
3577 <!-- _______________________________________________________________________ -->
3578 <h4>
3579   <a name="i_add">'<tt>add</tt>' Instruction</a>
3580 </h4>
3581
3582 <div>
3583
3584 <h5>Syntax:</h5>
3585 <pre>
3586   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3587   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3588   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3589   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3590 </pre>
3591
3592 <h5>Overview:</h5>
3593 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3594
3595 <h5>Arguments:</h5>
3596 <p>The two arguments to the '<tt>add</tt>' instruction must
3597    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3598    integer values. Both arguments must have identical types.</p>
3599
3600 <h5>Semantics:</h5>
3601 <p>The value produced is the integer sum of the two operands.</p>
3602
3603 <p>If the sum has unsigned overflow, the result returned is the mathematical
3604    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3605
3606 <p>Because LLVM integers use a two's complement representation, this instruction
3607    is appropriate for both signed and unsigned integers.</p>
3608
3609 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3610    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3611    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3612    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3613    respectively, occurs.</p>
3614
3615 <h5>Example:</h5>
3616 <pre>
3617   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3618 </pre>
3619
3620 </div>
3621
3622 <!-- _______________________________________________________________________ -->
3623 <h4>
3624   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3625 </h4>
3626
3627 <div>
3628
3629 <h5>Syntax:</h5>
3630 <pre>
3631   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3632 </pre>
3633
3634 <h5>Overview:</h5>
3635 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3636
3637 <h5>Arguments:</h5>
3638 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3639    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3640    floating point values. Both arguments must have identical types.</p>
3641
3642 <h5>Semantics:</h5>
3643 <p>The value produced is the floating point sum of the two operands.</p>
3644
3645 <h5>Example:</h5>
3646 <pre>
3647   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3648 </pre>
3649
3650 </div>
3651
3652 <!-- _______________________________________________________________________ -->
3653 <h4>
3654    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3655 </h4>
3656
3657 <div>
3658
3659 <h5>Syntax:</h5>
3660 <pre>
3661   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3662   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3663   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3664   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3665 </pre>
3666
3667 <h5>Overview:</h5>
3668 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3669    operands.</p>
3670
3671 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3672    '<tt>neg</tt>' instruction present in most other intermediate
3673    representations.</p>
3674
3675 <h5>Arguments:</h5>
3676 <p>The two arguments to the '<tt>sub</tt>' instruction must
3677    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3678    integer values.  Both arguments must have identical types.</p>
3679
3680 <h5>Semantics:</h5>
3681 <p>The value produced is the integer difference of the two operands.</p>
3682
3683 <p>If the difference has unsigned overflow, the result returned is the
3684    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3685    result.</p>
3686
3687 <p>Because LLVM integers use a two's complement representation, this instruction
3688    is appropriate for both signed and unsigned integers.</p>
3689
3690 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3691    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3692    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3693    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3694    respectively, occurs.</p>
3695
3696 <h5>Example:</h5>
3697 <pre>
3698   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3699   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3700 </pre>
3701
3702 </div>
3703
3704 <!-- _______________________________________________________________________ -->
3705 <h4>
3706    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3707 </h4>
3708
3709 <div>
3710
3711 <h5>Syntax:</h5>
3712 <pre>
3713   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3714 </pre>
3715
3716 <h5>Overview:</h5>
3717 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3718    operands.</p>
3719
3720 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3721    '<tt>fneg</tt>' instruction present in most other intermediate
3722    representations.</p>
3723
3724 <h5>Arguments:</h5>
3725 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3726    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3727    floating point values.  Both arguments must have identical types.</p>
3728
3729 <h5>Semantics:</h5>
3730 <p>The value produced is the floating point difference of the two operands.</p>
3731
3732 <h5>Example:</h5>
3733 <pre>
3734   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3735   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3736 </pre>
3737
3738 </div>
3739
3740 <!-- _______________________________________________________________________ -->
3741 <h4>
3742   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3743 </h4>
3744
3745 <div>
3746
3747 <h5>Syntax:</h5>
3748 <pre>
3749   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3750   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3751   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3752   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3753 </pre>
3754
3755 <h5>Overview:</h5>
3756 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3757
3758 <h5>Arguments:</h5>
3759 <p>The two arguments to the '<tt>mul</tt>' instruction must
3760    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3761    integer values.  Both arguments must have identical types.</p>
3762
3763 <h5>Semantics:</h5>
3764 <p>The value produced is the integer product of the two operands.</p>
3765
3766 <p>If the result of the multiplication has unsigned overflow, the result
3767    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3768    width of the result.</p>
3769
3770 <p>Because LLVM integers use a two's complement representation, and the result
3771    is the same width as the operands, this instruction returns the correct
3772    result for both signed and unsigned integers.  If a full product
3773    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3774    be sign-extended or zero-extended as appropriate to the width of the full
3775    product.</p>
3776
3777 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3778    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3779    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3780    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3781    respectively, occurs.</p>
3782
3783 <h5>Example:</h5>
3784 <pre>
3785   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3786 </pre>
3787
3788 </div>
3789
3790 <!-- _______________________________________________________________________ -->
3791 <h4>
3792   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3793 </h4>
3794
3795 <div>
3796
3797 <h5>Syntax:</h5>
3798 <pre>
3799   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3800 </pre>
3801
3802 <h5>Overview:</h5>
3803 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3804
3805 <h5>Arguments:</h5>
3806 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3807    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3808    floating point values.  Both arguments must have identical types.</p>
3809
3810 <h5>Semantics:</h5>
3811 <p>The value produced is the floating point product of the two operands.</p>
3812
3813 <h5>Example:</h5>
3814 <pre>
3815   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3816 </pre>
3817
3818 </div>
3819
3820 <!-- _______________________________________________________________________ -->
3821 <h4>
3822   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
3823 </h4>
3824
3825 <div>
3826
3827 <h5>Syntax:</h5>
3828 <pre>
3829   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3830   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3831 </pre>
3832
3833 <h5>Overview:</h5>
3834 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3835
3836 <h5>Arguments:</h5>
3837 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3838    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3839    values.  Both arguments must have identical types.</p>
3840
3841 <h5>Semantics:</h5>
3842 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3843
3844 <p>Note that unsigned integer division and signed integer division are distinct
3845    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3846
3847 <p>Division by zero leads to undefined behavior.</p>
3848
3849 <p>If the <tt>exact</tt> keyword is present, the result value of the
3850    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3851   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3852
3853
3854 <h5>Example:</h5>
3855 <pre>
3856   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3857 </pre>
3858
3859 </div>
3860
3861 <!-- _______________________________________________________________________ -->
3862 <h4>
3863   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
3864 </h4>
3865
3866 <div>
3867
3868 <h5>Syntax:</h5>
3869 <pre>
3870   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3871   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3872 </pre>
3873
3874 <h5>Overview:</h5>
3875 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3876
3877 <h5>Arguments:</h5>
3878 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3879    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3880    values.  Both arguments must have identical types.</p>
3881
3882 <h5>Semantics:</h5>
3883 <p>The value produced is the signed integer quotient of the two operands rounded
3884    towards zero.</p>
3885
3886 <p>Note that signed integer division and unsigned integer division are distinct
3887    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3888
3889 <p>Division by zero leads to undefined behavior. Overflow also leads to
3890    undefined behavior; this is a rare case, but can occur, for example, by doing
3891    a 32-bit division of -2147483648 by -1.</p>
3892
3893 <p>If the <tt>exact</tt> keyword is present, the result value of the
3894    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3895    be rounded.</p>
3896
3897 <h5>Example:</h5>
3898 <pre>
3899   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3900 </pre>
3901
3902 </div>
3903
3904 <!-- _______________________________________________________________________ -->
3905 <h4>
3906   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
3907 </h4>
3908
3909 <div>
3910
3911 <h5>Syntax:</h5>
3912 <pre>
3913   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3914 </pre>
3915
3916 <h5>Overview:</h5>
3917 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3918
3919 <h5>Arguments:</h5>
3920 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3921    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3922    floating point values.  Both arguments must have identical types.</p>
3923
3924 <h5>Semantics:</h5>
3925 <p>The value produced is the floating point quotient of the two operands.</p>
3926
3927 <h5>Example:</h5>
3928 <pre>
3929   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3930 </pre>
3931
3932 </div>
3933
3934 <!-- _______________________________________________________________________ -->
3935 <h4>
3936   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3937 </h4>
3938
3939 <div>
3940
3941 <h5>Syntax:</h5>
3942 <pre>
3943   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3944 </pre>
3945
3946 <h5>Overview:</h5>
3947 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3948    division of its two arguments.</p>
3949
3950 <h5>Arguments:</h5>
3951 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3952    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3953    values.  Both arguments must have identical types.</p>
3954
3955 <h5>Semantics:</h5>
3956 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3957    This instruction always performs an unsigned division to get the
3958    remainder.</p>
3959
3960 <p>Note that unsigned integer remainder and signed integer remainder are
3961    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3962
3963 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3964
3965 <h5>Example:</h5>
3966 <pre>
3967   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3968 </pre>
3969
3970 </div>
3971
3972 <!-- _______________________________________________________________________ -->
3973 <h4>
3974   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3975 </h4>
3976
3977 <div>
3978
3979 <h5>Syntax:</h5>
3980 <pre>
3981   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3982 </pre>
3983
3984 <h5>Overview:</h5>
3985 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3986    division of its two operands. This instruction can also take
3987    <a href="#t_vector">vector</a> versions of the values in which case the
3988    elements must be integers.</p>
3989
3990 <h5>Arguments:</h5>
3991 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3992    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3993    values.  Both arguments must have identical types.</p>
3994
3995 <h5>Semantics:</h5>
3996 <p>This instruction returns the <i>remainder</i> of a division (where the result
3997    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3998    <i>modulo</i> operator (where the result is either zero or has the same sign
3999    as the divisor, <tt>op2</tt>) of a value.
4000    For more information about the difference,
4001    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
4002    Math Forum</a>. For a table of how this is implemented in various languages,
4003    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
4004    Wikipedia: modulo operation</a>.</p>
4005
4006 <p>Note that signed integer remainder and unsigned integer remainder are
4007    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
4008
4009 <p>Taking the remainder of a division by zero leads to undefined behavior.
4010    Overflow also leads to undefined behavior; this is a rare case, but can
4011    occur, for example, by taking the remainder of a 32-bit division of
4012    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
4013    lets srem be implemented using instructions that return both the result of
4014    the division and the remainder.)</p>
4015
4016 <h5>Example:</h5>
4017 <pre>
4018   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4019 </pre>
4020
4021 </div>
4022
4023 <!-- _______________________________________________________________________ -->
4024 <h4>
4025   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
4026 </h4>
4027
4028 <div>
4029
4030 <h5>Syntax:</h5>
4031 <pre>
4032   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4033 </pre>
4034
4035 <h5>Overview:</h5>
4036 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
4037    its two operands.</p>
4038
4039 <h5>Arguments:</h5>
4040 <p>The two arguments to the '<tt>frem</tt>' instruction must be
4041    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4042    floating point values.  Both arguments must have identical types.</p>
4043
4044 <h5>Semantics:</h5>
4045 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
4046    has the same sign as the dividend.</p>
4047
4048 <h5>Example:</h5>
4049 <pre>
4050   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
4051 </pre>
4052
4053 </div>
4054
4055 </div>
4056
4057 <!-- ======================================================================= -->
4058 <h3>
4059   <a name="bitwiseops">Bitwise Binary Operations</a>
4060 </h3>
4061
4062 <div>
4063
4064 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
4065    program.  They are generally very efficient instructions and can commonly be
4066    strength reduced from other instructions.  They require two operands of the
4067    same type, execute an operation on them, and produce a single value.  The
4068    resulting value is the same type as its operands.</p>
4069
4070 <!-- _______________________________________________________________________ -->
4071 <h4>
4072   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
4073 </h4>
4074
4075 <div>
4076
4077 <h5>Syntax:</h5>
4078 <pre>
4079   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
4080   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4081   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4082   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4083 </pre>
4084
4085 <h5>Overview:</h5>
4086 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
4087    a specified number of bits.</p>
4088
4089 <h5>Arguments:</h5>
4090 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
4091     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
4092     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4093
4094 <h5>Semantics:</h5>
4095 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
4096    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
4097    is (statically or dynamically) negative or equal to or larger than the number
4098    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
4099    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4100    shift amount in <tt>op2</tt>.</p>
4101
4102 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
4103    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
4104    the <tt>nsw</tt> keyword is present, then the shift produces a
4105    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
4106    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
4107    they would if the shift were expressed as a mul instruction with the same
4108    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
4109
4110 <h5>Example:</h5>
4111 <pre>
4112   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
4113   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
4114   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
4115   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
4116   &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>
4117 </pre>
4118
4119 </div>
4120
4121 <!-- _______________________________________________________________________ -->
4122 <h4>
4123   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
4124 </h4>
4125
4126 <div>
4127
4128 <h5>Syntax:</h5>
4129 <pre>
4130   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4131   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4132 </pre>
4133
4134 <h5>Overview:</h5>
4135 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4136    operand shifted to the right a specified number of bits with zero fill.</p>
4137
4138 <h5>Arguments:</h5>
4139 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4140    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4141    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4142
4143 <h5>Semantics:</h5>
4144 <p>This instruction always performs a logical shift right operation. The most
4145    significant bits of the result will be filled with zero bits after the shift.
4146    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4147    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4148    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4149    shift amount in <tt>op2</tt>.</p>
4150
4151 <p>If the <tt>exact</tt> keyword is present, the result value of the
4152    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4153    shifted out are non-zero.</p>
4154
4155
4156 <h5>Example:</h5>
4157 <pre>
4158   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4159   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4160   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4161   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4162   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4163   &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>
4164 </pre>
4165
4166 </div>
4167
4168 <!-- _______________________________________________________________________ -->
4169 <h4>
4170   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4171 </h4>
4172
4173 <div>
4174
4175 <h5>Syntax:</h5>
4176 <pre>
4177   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4178   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4179 </pre>
4180
4181 <h5>Overview:</h5>
4182 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4183    operand shifted to the right a specified number of bits with sign
4184    extension.</p>
4185
4186 <h5>Arguments:</h5>
4187 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4188    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4189    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4190
4191 <h5>Semantics:</h5>
4192 <p>This instruction always performs an arithmetic shift right operation, The
4193    most significant bits of the result will be filled with the sign bit
4194    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4195    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4196    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4197    the corresponding shift amount in <tt>op2</tt>.</p>
4198
4199 <p>If the <tt>exact</tt> keyword is present, the result value of the
4200    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4201    shifted out are non-zero.</p>
4202
4203 <h5>Example:</h5>
4204 <pre>
4205   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4206   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4207   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4208   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4209   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4210   &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>
4211 </pre>
4212
4213 </div>
4214
4215 <!-- _______________________________________________________________________ -->
4216 <h4>
4217   <a name="i_and">'<tt>and</tt>' Instruction</a>
4218 </h4>
4219
4220 <div>
4221
4222 <h5>Syntax:</h5>
4223 <pre>
4224   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4225 </pre>
4226
4227 <h5>Overview:</h5>
4228 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4229    operands.</p>
4230
4231 <h5>Arguments:</h5>
4232 <p>The two arguments to the '<tt>and</tt>' instruction must be
4233    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4234    values.  Both arguments must have identical types.</p>
4235
4236 <h5>Semantics:</h5>
4237 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4238
4239 <table border="1" cellspacing="0" cellpadding="4">
4240   <tbody>
4241     <tr>
4242       <td>In0</td>
4243       <td>In1</td>
4244       <td>Out</td>
4245     </tr>
4246     <tr>
4247       <td>0</td>
4248       <td>0</td>
4249       <td>0</td>
4250     </tr>
4251     <tr>
4252       <td>0</td>
4253       <td>1</td>
4254       <td>0</td>
4255     </tr>
4256     <tr>
4257       <td>1</td>
4258       <td>0</td>
4259       <td>0</td>
4260     </tr>
4261     <tr>
4262       <td>1</td>
4263       <td>1</td>
4264       <td>1</td>
4265     </tr>
4266   </tbody>
4267 </table>
4268
4269 <h5>Example:</h5>
4270 <pre>
4271   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4272   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4273   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4274 </pre>
4275 </div>
4276 <!-- _______________________________________________________________________ -->
4277 <h4>
4278   <a name="i_or">'<tt>or</tt>' Instruction</a>
4279 </h4>
4280
4281 <div>
4282
4283 <h5>Syntax:</h5>
4284 <pre>
4285   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4286 </pre>
4287
4288 <h5>Overview:</h5>
4289 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4290    two operands.</p>
4291
4292 <h5>Arguments:</h5>
4293 <p>The two arguments to the '<tt>or</tt>' instruction must be
4294    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4295    values.  Both arguments must have identical types.</p>
4296
4297 <h5>Semantics:</h5>
4298 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4299
4300 <table border="1" cellspacing="0" cellpadding="4">
4301   <tbody>
4302     <tr>
4303       <td>In0</td>
4304       <td>In1</td>
4305       <td>Out</td>
4306     </tr>
4307     <tr>
4308       <td>0</td>
4309       <td>0</td>
4310       <td>0</td>
4311     </tr>
4312     <tr>
4313       <td>0</td>
4314       <td>1</td>
4315       <td>1</td>
4316     </tr>
4317     <tr>
4318       <td>1</td>
4319       <td>0</td>
4320       <td>1</td>
4321     </tr>
4322     <tr>
4323       <td>1</td>
4324       <td>1</td>
4325       <td>1</td>
4326     </tr>
4327   </tbody>
4328 </table>
4329
4330 <h5>Example:</h5>
4331 <pre>
4332   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4333   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4334   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4335 </pre>
4336
4337 </div>
4338
4339 <!-- _______________________________________________________________________ -->
4340 <h4>
4341   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4342 </h4>
4343
4344 <div>
4345
4346 <h5>Syntax:</h5>
4347 <pre>
4348   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4349 </pre>
4350
4351 <h5>Overview:</h5>
4352 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4353    its two operands.  The <tt>xor</tt> is used to implement the "one's
4354    complement" operation, which is the "~" operator in C.</p>
4355
4356 <h5>Arguments:</h5>
4357 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4358    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4359    values.  Both arguments must have identical types.</p>
4360
4361 <h5>Semantics:</h5>
4362 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4363
4364 <table border="1" cellspacing="0" cellpadding="4">
4365   <tbody>
4366     <tr>
4367       <td>In0</td>
4368       <td>In1</td>
4369       <td>Out</td>
4370     </tr>
4371     <tr>
4372       <td>0</td>
4373       <td>0</td>
4374       <td>0</td>
4375     </tr>
4376     <tr>
4377       <td>0</td>
4378       <td>1</td>
4379       <td>1</td>
4380     </tr>
4381     <tr>
4382       <td>1</td>
4383       <td>0</td>
4384       <td>1</td>
4385     </tr>
4386     <tr>
4387       <td>1</td>
4388       <td>1</td>
4389       <td>0</td>
4390     </tr>
4391   </tbody>
4392 </table>
4393
4394 <h5>Example:</h5>
4395 <pre>
4396   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4397   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4398   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4399   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4400 </pre>
4401
4402 </div>
4403
4404 </div>
4405
4406 <!-- ======================================================================= -->
4407 <h3>
4408   <a name="vectorops">Vector Operations</a>
4409 </h3>
4410
4411 <div>
4412
4413 <p>LLVM supports several instructions to represent vector operations in a
4414    target-independent manner.  These instructions cover the element-access and
4415    vector-specific operations needed to process vectors effectively.  While LLVM
4416    does directly support these vector operations, many sophisticated algorithms
4417    will want to use target-specific intrinsics to take full advantage of a
4418    specific target.</p>
4419
4420 <!-- _______________________________________________________________________ -->
4421 <h4>
4422    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4423 </h4>
4424
4425 <div>
4426
4427 <h5>Syntax:</h5>
4428 <pre>
4429   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4430 </pre>
4431
4432 <h5>Overview:</h5>
4433 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4434    from a vector at a specified index.</p>
4435
4436
4437 <h5>Arguments:</h5>
4438 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4439    of <a href="#t_vector">vector</a> type.  The second operand is an index
4440    indicating the position from which to extract the element.  The index may be
4441    a variable.</p>
4442
4443 <h5>Semantics:</h5>
4444 <p>The result is a scalar of the same type as the element type of
4445    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4446    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4447    results are undefined.</p>
4448
4449 <h5>Example:</h5>
4450 <pre>
4451   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4452 </pre>
4453
4454 </div>
4455
4456 <!-- _______________________________________________________________________ -->
4457 <h4>
4458    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4459 </h4>
4460
4461 <div>
4462
4463 <h5>Syntax:</h5>
4464 <pre>
4465   &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>
4466 </pre>
4467
4468 <h5>Overview:</h5>
4469 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4470    vector at a specified index.</p>
4471
4472 <h5>Arguments:</h5>
4473 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4474    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4475    whose type must equal the element type of the first operand.  The third
4476    operand is an index indicating the position at which to insert the value.
4477    The index may be a variable.</p>
4478
4479 <h5>Semantics:</h5>
4480 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4481    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4482    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4483    results are undefined.</p>
4484
4485 <h5>Example:</h5>
4486 <pre>
4487   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4488 </pre>
4489
4490 </div>
4491
4492 <!-- _______________________________________________________________________ -->
4493 <h4>
4494    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4495 </h4>
4496
4497 <div>
4498
4499 <h5>Syntax:</h5>
4500 <pre>
4501   &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>
4502 </pre>
4503
4504 <h5>Overview:</h5>
4505 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4506    from two input vectors, returning a vector with the same element type as the
4507    input and length that is the same as the shuffle mask.</p>
4508
4509 <h5>Arguments:</h5>
4510 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4511    with types that match each other. The third argument is a shuffle mask whose
4512    element type is always 'i32'.  The result of the instruction is a vector
4513    whose length is the same as the shuffle mask and whose element type is the
4514    same as the element type of the first two operands.</p>
4515
4516 <p>The shuffle mask operand is required to be a constant vector with either
4517    constant integer or undef values.</p>
4518
4519 <h5>Semantics:</h5>
4520 <p>The elements of the two input vectors are numbered from left to right across
4521    both of the vectors.  The shuffle mask operand specifies, for each element of
4522    the result vector, which element of the two input vectors the result element
4523    gets.  The element selector may be undef (meaning "don't care") and the
4524    second operand may be undef if performing a shuffle from only one vector.</p>
4525
4526 <h5>Example:</h5>
4527 <pre>
4528   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4529                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4530   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4531                           &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.
4532   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4533                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4534   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4535                           &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>
4536 </pre>
4537
4538 </div>
4539
4540 </div>
4541
4542 <!-- ======================================================================= -->
4543 <h3>
4544   <a name="aggregateops">Aggregate Operations</a>
4545 </h3>
4546
4547 <div>
4548
4549 <p>LLVM supports several instructions for working with
4550   <a href="#t_aggregate">aggregate</a> values.</p>
4551
4552 <!-- _______________________________________________________________________ -->
4553 <h4>
4554    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4555 </h4>
4556
4557 <div>
4558
4559 <h5>Syntax:</h5>
4560 <pre>
4561   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4562 </pre>
4563
4564 <h5>Overview:</h5>
4565 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4566    from an <a href="#t_aggregate">aggregate</a> value.</p>
4567
4568 <h5>Arguments:</h5>
4569 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4570    of <a href="#t_struct">struct</a> or
4571    <a href="#t_array">array</a> type.  The operands are constant indices to
4572    specify which value to extract in a similar manner as indices in a
4573    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4574    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4575      <ul>
4576        <li>Since the value being indexed is not a pointer, the first index is
4577            omitted and assumed to be zero.</li>
4578        <li>At least one index must be specified.</li>
4579        <li>Not only struct indices but also array indices must be in
4580            bounds.</li>
4581      </ul>
4582
4583 <h5>Semantics:</h5>
4584 <p>The result is the value at the position in the aggregate specified by the
4585    index operands.</p>
4586
4587 <h5>Example:</h5>
4588 <pre>
4589   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4590 </pre>
4591
4592 </div>
4593
4594 <!-- _______________________________________________________________________ -->
4595 <h4>
4596    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4597 </h4>
4598
4599 <div>
4600
4601 <h5>Syntax:</h5>
4602 <pre>
4603   &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>
4604 </pre>
4605
4606 <h5>Overview:</h5>
4607 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4608    in an <a href="#t_aggregate">aggregate</a> value.</p>
4609
4610 <h5>Arguments:</h5>
4611 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4612    of <a href="#t_struct">struct</a> or
4613    <a href="#t_array">array</a> type.  The second operand is a first-class
4614    value to insert.  The following operands are constant indices indicating
4615    the position at which to insert the value in a similar manner as indices in a
4616    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4617    value to insert must have the same type as the value identified by the
4618    indices.</p>
4619
4620 <h5>Semantics:</h5>
4621 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4622    that of <tt>val</tt> except that the value at the position specified by the
4623    indices is that of <tt>elt</tt>.</p>
4624
4625 <h5>Example:</h5>
4626 <pre>
4627   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4628   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4629   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4630 </pre>
4631
4632 </div>
4633
4634 </div>
4635
4636 <!-- ======================================================================= -->
4637 <h3>
4638   <a name="memoryops">Memory Access and Addressing Operations</a>
4639 </h3>
4640
4641 <div>
4642
4643 <p>A key design point of an SSA-based representation is how it represents
4644    memory.  In LLVM, no memory locations are in SSA form, which makes things
4645    very simple.  This section describes how to read, write, and allocate
4646    memory in LLVM.</p>
4647
4648 <!-- _______________________________________________________________________ -->
4649 <h4>
4650   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4651 </h4>
4652
4653 <div>
4654
4655 <h5>Syntax:</h5>
4656 <pre>
4657   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4658 </pre>
4659
4660 <h5>Overview:</h5>
4661 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4662    currently executing function, to be automatically released when this function
4663    returns to its caller. The object is always allocated in the generic address
4664    space (address space zero).</p>
4665
4666 <h5>Arguments:</h5>
4667 <p>The '<tt>alloca</tt>' instruction
4668    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4669    runtime stack, returning a pointer of the appropriate type to the program.
4670    If "NumElements" is specified, it is the number of elements allocated,
4671    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4672    specified, the value result of the allocation is guaranteed to be aligned to
4673    at least that boundary.  If not specified, or if zero, the target can choose
4674    to align the allocation on any convenient boundary compatible with the
4675    type.</p>
4676
4677 <p>'<tt>type</tt>' may be any sized type.</p>
4678
4679 <h5>Semantics:</h5>
4680 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4681    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4682    memory is automatically released when the function returns.  The
4683    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4684    variables that must have an address available.  When the function returns
4685    (either with the <tt><a href="#i_ret">ret</a></tt>
4686    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4687    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4688
4689 <h5>Example:</h5>
4690 <pre>
4691   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4692   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4693   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4694   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4695 </pre>
4696
4697 </div>
4698
4699 <!-- _______________________________________________________________________ -->
4700 <h4>
4701   <a name="i_load">'<tt>load</tt>' Instruction</a>
4702 </h4>
4703
4704 <div>
4705
4706 <h5>Syntax:</h5>
4707 <pre>
4708   &lt;result&gt; = load [volatile] &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4709   &lt;result&gt; = load atomic [volatile] &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4710   !&lt;index&gt; = !{ i32 1 }
4711 </pre>
4712
4713 <h5>Overview:</h5>
4714 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4715
4716 <h5>Arguments:</h5>
4717 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4718    from which to load.  The pointer must point to
4719    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4720    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4721    number or order of execution of this <tt>load</tt> with other <a
4722    href="#volatile">volatile operations</a>.</p>
4723
4724 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4725    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4726    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4727    not valid on <code>load</code> instructions.  Atomic loads produce <a
4728    href="#memorymodel">defined</a> results when they may see multiple atomic
4729    stores.  The type of the pointee must be an integer type whose bit width
4730    is a power of two greater than or equal to eight and less than or equal
4731    to a target-specific size limit. <code>align</code> must be explicitly
4732    specified on atomic loads, and the load has undefined behavior if the
4733    alignment is not set to a value which is at least the size in bytes of
4734    the pointee. <code>!nontemporal</code> does not have any defined semantics
4735    for atomic loads.</p>
4736
4737 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4738    operation (that is, the alignment of the memory address). A value of 0 or an
4739    omitted <tt>align</tt> argument means that the operation has the preferential
4740    alignment for the target. It is the responsibility of the code emitter to
4741    ensure that the alignment information is correct. Overestimating the
4742    alignment results in undefined behavior. Underestimating the alignment may
4743    produce less efficient code. An alignment of 1 is always safe.</p>
4744
4745 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4746    metatadata name &lt;index&gt; corresponding to a metadata node with
4747    one <tt>i32</tt> entry of value 1.  The existence of
4748    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4749    and code generator that this load is not expected to be reused in the cache.
4750    The code generator may select special instructions to save cache bandwidth,
4751    such as the <tt>MOVNT</tt> instruction on x86.</p>
4752
4753 <h5>Semantics:</h5>
4754 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4755    scalar type then the number of bytes read does not exceed the minimum number
4756    of bytes needed to hold all bits of the type.  For example, loading an
4757    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4758    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4759    is undefined if the value was not originally written using a store of the
4760    same type.</p>
4761
4762 <h5>Examples:</h5>
4763 <pre>
4764   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4765   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4766   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4767 </pre>
4768
4769 </div>
4770
4771 <!-- _______________________________________________________________________ -->
4772 <h4>
4773   <a name="i_store">'<tt>store</tt>' Instruction</a>
4774 </h4>
4775
4776 <div>
4777
4778 <h5>Syntax:</h5>
4779 <pre>
4780   store [volatile] &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]                   <i>; yields {void}</i>
4781   store atomic [volatile] &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;             <i>; yields {void}</i>
4782 </pre>
4783
4784 <h5>Overview:</h5>
4785 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4786
4787 <h5>Arguments:</h5>
4788 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4789    and an address at which to store it.  The type of the
4790    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4791    the <a href="#t_firstclass">first class</a> type of the
4792    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4793    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4794    order of execution of this <tt>store</tt> with other <a
4795    href="#volatile">volatile operations</a>.</p>
4796
4797 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
4798    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4799    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
4800    valid on <code>store</code> instructions.  Atomic loads produce <a
4801    href="#memorymodel">defined</a> results when they may see multiple atomic
4802    stores. The type of the pointee must be an integer type whose bit width
4803    is a power of two greater than or equal to eight and less than or equal
4804    to a target-specific size limit. <code>align</code> must be explicitly
4805    specified on atomic stores, and the store has undefined behavior if the
4806    alignment is not set to a value which is at least the size in bytes of
4807    the pointee. <code>!nontemporal</code> does not have any defined semantics
4808    for atomic stores.</p>
4809
4810 <p>The optional constant "align" argument specifies the alignment of the
4811    operation (that is, the alignment of the memory address). A value of 0 or an
4812    omitted "align" argument means that the operation has the preferential
4813    alignment for the target. It is the responsibility of the code emitter to
4814    ensure that the alignment information is correct. Overestimating the
4815    alignment results in an undefined behavior. Underestimating the alignment may
4816    produce less efficient code. An alignment of 1 is always safe.</p>
4817
4818 <p>The optional !nontemporal metadata must reference a single metatadata
4819    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4820    value 1.  The existence of the !nontemporal metatadata on the
4821    instruction tells the optimizer and code generator that this load is
4822    not expected to be reused in the cache.  The code generator may
4823    select special instructions to save cache bandwidth, such as the
4824    MOVNT instruction on x86.</p>
4825
4826
4827 <h5>Semantics:</h5>
4828 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4829    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4830    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4831    does not exceed the minimum number of bytes needed to hold all bits of the
4832    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4833    writing a value of a type like <tt>i20</tt> with a size that is not an
4834    integral number of bytes, it is unspecified what happens to the extra bits
4835    that do not belong to the type, but they will typically be overwritten.</p>
4836
4837 <h5>Example:</h5>
4838 <pre>
4839   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4840   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4841   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4842 </pre>
4843
4844 </div>
4845
4846 <!-- _______________________________________________________________________ -->
4847 <h4>
4848 <a name="i_fence">'<tt>fence</tt>' Instruction</a>
4849 </h4>
4850
4851 <div>
4852
4853 <h5>Syntax:</h5>
4854 <pre>
4855   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
4856 </pre>
4857
4858 <h5>Overview:</h5>
4859 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
4860 between operations.</p>
4861
4862 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
4863 href="#ordering">ordering</a> argument which defines what
4864 <i>synchronizes-with</i> edges they add.  They can only be given
4865 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
4866 <code>seq_cst</code> orderings.</p>
4867
4868 <h5>Semantics:</h5>
4869 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
4870 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
4871 <code>acquire</code> ordering semantics if and only if there exist atomic
4872 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
4873 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
4874 <var>X</var> modifies <var>M</var> (either directly or through some side effect
4875 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
4876 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
4877 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
4878 than an explicit <code>fence</code>, one (but not both) of the atomic operations
4879 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
4880 <code>acquire</code> (resp.) ordering constraint and still
4881 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
4882 <i>happens-before</i> edge.</p>
4883
4884 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
4885 having both <code>acquire</code> and <code>release</code> semantics specified
4886 above, participates in the global program order of other <code>seq_cst</code>
4887 operations and/or fences.</p>
4888
4889 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
4890 specifies that the fence only synchronizes with other fences in the same
4891 thread.  (This is useful for interacting with signal handlers.)</p>
4892
4893 <h5>Example:</h5>
4894 <pre>
4895   fence acquire                          <i>; yields {void}</i>
4896   fence singlethread seq_cst             <i>; yields {void}</i>
4897 </pre>
4898
4899 </div>
4900
4901 <!-- _______________________________________________________________________ -->
4902 <h4>
4903 <a name="i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a>
4904 </h4>
4905
4906 <div>
4907
4908 <h5>Syntax:</h5>
4909 <pre>
4910   cmpxchg [volatile] &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;cmp&gt;, &lt;ty&gt; &lt;new&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4911 </pre>
4912
4913 <h5>Overview:</h5>
4914 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
4915 It loads a value in memory and compares it to a given value. If they are
4916 equal, it stores a new value into the memory.</p>
4917
4918 <h5>Arguments:</h5>
4919 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
4920 address to operate on, a value to compare to the value currently be at that
4921 address, and a new value to place at that address if the compared values are
4922 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
4923 bit width is a power of two greater than or equal to eight and less than
4924 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
4925 '<var>&lt;new&gt;</var>' must have the same type, and the type of
4926 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
4927 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
4928 optimizer is not allowed to modify the number or order of execution
4929 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
4930 operations</a>.</p>
4931
4932 <!-- FIXME: Extend allowed types. -->
4933
4934 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
4935 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
4936
4937 <p>The optional "<code>singlethread</code>" argument declares that the
4938 <code>cmpxchg</code> is only atomic with respect to code (usually signal
4939 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
4940 cmpxchg is atomic with respect to all other code in the system.</p>
4941
4942 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
4943 the size in memory of the operand.
4944
4945 <h5>Semantics:</h5>
4946 <p>The contents of memory at the location specified by the
4947 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
4948 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
4949 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
4950 is returned.
4951
4952 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
4953 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
4954 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
4955 parameter determined by dropping any <code>release</code> part of the
4956 <code>cmpxchg</code>'s ordering.</p>
4957
4958 <!--
4959 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
4960 optimization work on ARM.)
4961
4962 FIXME: Is a weaker ordering constraint on failure helpful in practice?
4963 -->
4964
4965 <h5>Example:</h5>
4966 <pre>
4967 entry:
4968   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                       <i>; yields {i32}</i>
4969   <a href="#i_br">br</a> label %loop
4970
4971 loop:
4972   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
4973   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
4974   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared                       <i>; yields {i32}</i>
4975   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
4976   <a href="#i_br">br</a> i1 %success, label %done, label %loop
4977
4978 done:
4979   ...
4980 </pre>
4981
4982 </div>
4983
4984 <!-- _______________________________________________________________________ -->
4985 <h4>
4986 <a name="i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a>
4987 </h4>
4988
4989 <div>
4990
4991 <h5>Syntax:</h5>
4992 <pre>
4993   atomicrmw [volatile] &lt;operation&gt; &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;value&gt; [singlethread] &lt;ordering&gt;                   <i>; yields {ty}</i>
4994 </pre>
4995
4996 <h5>Overview:</h5>
4997 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
4998
4999 <h5>Arguments:</h5>
5000 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
5001 operation to apply, an address whose value to modify, an argument to the
5002 operation.  The operation must be one of the following keywords:</p>
5003 <ul>
5004   <li>xchg</li>
5005   <li>add</li>
5006   <li>sub</li>
5007   <li>and</li>
5008   <li>nand</li>
5009   <li>or</li>
5010   <li>xor</li>
5011   <li>max</li>
5012   <li>min</li>
5013   <li>umax</li>
5014   <li>umin</li>
5015 </ul>
5016
5017 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
5018 bit width is a power of two greater than or equal to eight and less than
5019 or equal to a target-specific size limit.  The type of the
5020 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
5021 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
5022 optimizer is not allowed to modify the number or order of execution of this
5023 <code>atomicrmw</code> with other <a href="#volatile">volatile
5024   operations</a>.</p>
5025
5026 <!-- FIXME: Extend allowed types. -->
5027
5028 <h5>Semantics:</h5>
5029 <p>The contents of memory at the location specified by the
5030 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
5031 back.  The original value at the location is returned.  The modification is
5032 specified by the <var>operation</var> argument:</p>
5033
5034 <ul>
5035   <li>xchg: <code>*ptr = val</code></li>
5036   <li>add: <code>*ptr = *ptr + val</code></li>
5037   <li>sub: <code>*ptr = *ptr - val</code></li>
5038   <li>and: <code>*ptr = *ptr &amp; val</code></li>
5039   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
5040   <li>or: <code>*ptr = *ptr | val</code></li>
5041   <li>xor: <code>*ptr = *ptr ^ val</code></li>
5042   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
5043   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
5044   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5045   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5046 </ul>
5047
5048 <h5>Example:</h5>
5049 <pre>
5050   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
5051 </pre>
5052
5053 </div>
5054
5055 <!-- _______________________________________________________________________ -->
5056 <h4>
5057    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
5058 </h4>
5059
5060 <div>
5061
5062 <h5>Syntax:</h5>
5063 <pre>
5064   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5065   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5066 </pre>
5067
5068 <h5>Overview:</h5>
5069 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
5070    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
5071    It performs address calculation only and does not access memory.</p>
5072
5073 <h5>Arguments:</h5>
5074 <p>The first argument is always a pointer, and forms the basis of the
5075    calculation. The remaining arguments are indices that indicate which of the
5076    elements of the aggregate object are indexed. The interpretation of each
5077    index is dependent on the type being indexed into. The first index always
5078    indexes the pointer value given as the first argument, the second index
5079    indexes a value of the type pointed to (not necessarily the value directly
5080    pointed to, since the first index can be non-zero), etc. The first type
5081    indexed into must be a pointer value, subsequent types can be arrays,
5082    vectors, and structs. Note that subsequent types being indexed into
5083    can never be pointers, since that would require loading the pointer before
5084    continuing calculation.</p>
5085
5086 <p>The type of each index argument depends on the type it is indexing into.
5087    When indexing into a (optionally packed) structure, only <tt>i32</tt>
5088    integer <b>constants</b> are allowed.  When indexing into an array, pointer
5089    or vector, integers of any width are allowed, and they are not required to be
5090    constant.  These integers are treated as signed values where relevant.</p>
5091
5092 <p>For example, let's consider a C code fragment and how it gets compiled to
5093    LLVM:</p>
5094
5095 <pre class="doc_code">
5096 struct RT {
5097   char A;
5098   int B[10][20];
5099   char C;
5100 };
5101 struct ST {
5102   int X;
5103   double Y;
5104   struct RT Z;
5105 };
5106
5107 int *foo(struct ST *s) {
5108   return &amp;s[1].Z.B[5][13];
5109 }
5110 </pre>
5111
5112 <p>The LLVM code generated by the GCC frontend is:</p>
5113
5114 <pre class="doc_code">
5115 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
5116 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
5117
5118 define i32* @foo(%ST* %s) {
5119 entry:
5120   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
5121   ret i32* %reg
5122 }
5123 </pre>
5124
5125 <h5>Semantics:</h5>
5126 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
5127    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
5128    }</tt>' type, a structure.  The second index indexes into the third element
5129    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
5130    i8 }</tt>' type, another structure.  The third index indexes into the second
5131    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
5132    array.  The two dimensions of the array are subscripted into, yielding an
5133    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
5134    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
5135
5136 <p>Note that it is perfectly legal to index partially through a structure,
5137    returning a pointer to an inner element.  Because of this, the LLVM code for
5138    the given testcase is equivalent to:</p>
5139
5140 <pre>
5141   define i32* @foo(%ST* %s) {
5142     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
5143     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
5144     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
5145     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5146     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5147     ret i32* %t5
5148   }
5149 </pre>
5150
5151 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5152    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
5153    base pointer is not an <i>in bounds</i> address of an allocated object,
5154    or if any of the addresses that would be formed by successive addition of
5155    the offsets implied by the indices to the base address with infinitely
5156    precise signed arithmetic are not an <i>in bounds</i> address of that
5157    allocated object. The <i>in bounds</i> addresses for an allocated object
5158    are all the addresses that point into the object, plus the address one
5159    byte past the end.</p>
5160
5161 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5162    the base address with silently-wrapping two's complement arithmetic. If the
5163    offsets have a different width from the pointer, they are sign-extended or
5164    truncated to the width of the pointer. The result value of the
5165    <tt>getelementptr</tt> may be outside the object pointed to by the base
5166    pointer. The result value may not necessarily be used to access memory
5167    though, even if it happens to point into allocated storage. See the
5168    <a href="#pointeraliasing">Pointer Aliasing Rules</a> section for more
5169    information.</p>
5170
5171 <p>The getelementptr instruction is often confusing.  For some more insight into
5172    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5173
5174 <h5>Example:</h5>
5175 <pre>
5176     <i>; yields [12 x i8]*:aptr</i>
5177     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5178     <i>; yields i8*:vptr</i>
5179     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5180     <i>; yields i8*:eptr</i>
5181     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5182     <i>; yields i32*:iptr</i>
5183     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5184 </pre>
5185
5186 </div>
5187
5188 </div>
5189
5190 <!-- ======================================================================= -->
5191 <h3>
5192   <a name="convertops">Conversion Operations</a>
5193 </h3>
5194
5195 <div>
5196
5197 <p>The instructions in this category are the conversion instructions (casting)
5198    which all take a single operand and a type. They perform various bit
5199    conversions on the operand.</p>
5200
5201 <!-- _______________________________________________________________________ -->
5202 <h4>
5203    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5204 </h4>
5205
5206 <div>
5207
5208 <h5>Syntax:</h5>
5209 <pre>
5210   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5211 </pre>
5212
5213 <h5>Overview:</h5>
5214 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5215    type <tt>ty2</tt>.</p>
5216
5217 <h5>Arguments:</h5>
5218 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5219    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5220    of the same number of integers.
5221    The bit size of the <tt>value</tt> must be larger than
5222    the bit size of the destination type, <tt>ty2</tt>.
5223    Equal sized types are not allowed.</p>
5224
5225 <h5>Semantics:</h5>
5226 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5227    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5228    source size must be larger than the destination size, <tt>trunc</tt> cannot
5229    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5230
5231 <h5>Example:</h5>
5232 <pre>
5233   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5234   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5235   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5236   %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>
5237 </pre>
5238
5239 </div>
5240
5241 <!-- _______________________________________________________________________ -->
5242 <h4>
5243    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5244 </h4>
5245
5246 <div>
5247
5248 <h5>Syntax:</h5>
5249 <pre>
5250   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5251 </pre>
5252
5253 <h5>Overview:</h5>
5254 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5255    <tt>ty2</tt>.</p>
5256
5257
5258 <h5>Arguments:</h5>
5259 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5260    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5261    of the same number of integers.
5262    The bit size of the <tt>value</tt> must be smaller than
5263    the bit size of the destination type,
5264    <tt>ty2</tt>.</p>
5265
5266 <h5>Semantics:</h5>
5267 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5268    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5269
5270 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5271
5272 <h5>Example:</h5>
5273 <pre>
5274   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5275   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5276   %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>
5277 </pre>
5278
5279 </div>
5280
5281 <!-- _______________________________________________________________________ -->
5282 <h4>
5283    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5284 </h4>
5285
5286 <div>
5287
5288 <h5>Syntax:</h5>
5289 <pre>
5290   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5291 </pre>
5292
5293 <h5>Overview:</h5>
5294 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5295
5296 <h5>Arguments:</h5>
5297 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5298    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5299    of the same number of integers.
5300    The bit size of the <tt>value</tt> must be smaller than
5301    the bit size of the destination type,
5302    <tt>ty2</tt>.</p>
5303
5304 <h5>Semantics:</h5>
5305 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5306    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5307    of the type <tt>ty2</tt>.</p>
5308
5309 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5310
5311 <h5>Example:</h5>
5312 <pre>
5313   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5314   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5315   %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>
5316 </pre>
5317
5318 </div>
5319
5320 <!-- _______________________________________________________________________ -->
5321 <h4>
5322    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5323 </h4>
5324
5325 <div>
5326
5327 <h5>Syntax:</h5>
5328 <pre>
5329   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5330 </pre>
5331
5332 <h5>Overview:</h5>
5333 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5334    <tt>ty2</tt>.</p>
5335
5336 <h5>Arguments:</h5>
5337 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5338    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5339    to cast it to. The size of <tt>value</tt> must be larger than the size of
5340    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5341    <i>no-op cast</i>.</p>
5342
5343 <h5>Semantics:</h5>
5344 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5345    <a href="#t_floating">floating point</a> type to a smaller
5346    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5347    within the destination type, <tt>ty2</tt>, then the results are
5348    undefined.</p>
5349
5350 <h5>Example:</h5>
5351 <pre>
5352   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5353   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5354 </pre>
5355
5356 </div>
5357
5358 <!-- _______________________________________________________________________ -->
5359 <h4>
5360    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5361 </h4>
5362
5363 <div>
5364
5365 <h5>Syntax:</h5>
5366 <pre>
5367   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5368 </pre>
5369
5370 <h5>Overview:</h5>
5371 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5372    floating point value.</p>
5373
5374 <h5>Arguments:</h5>
5375 <p>The '<tt>fpext</tt>' instruction takes a
5376    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5377    a <a href="#t_floating">floating point</a> type to cast it to. The source
5378    type must be smaller than the destination type.</p>
5379
5380 <h5>Semantics:</h5>
5381 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5382    <a href="#t_floating">floating point</a> type to a larger
5383    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5384    used to make a <i>no-op cast</i> because it always changes bits. Use
5385    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5386
5387 <h5>Example:</h5>
5388 <pre>
5389   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5390   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5391 </pre>
5392
5393 </div>
5394
5395 <!-- _______________________________________________________________________ -->
5396 <h4>
5397    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5398 </h4>
5399
5400 <div>
5401
5402 <h5>Syntax:</h5>
5403 <pre>
5404   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5405 </pre>
5406
5407 <h5>Overview:</h5>
5408 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5409    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5410
5411 <h5>Arguments:</h5>
5412 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5413    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5414    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5415    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5416    vector integer type with the same number of elements as <tt>ty</tt></p>
5417
5418 <h5>Semantics:</h5>
5419 <p>The '<tt>fptoui</tt>' instruction converts its
5420    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5421    towards zero) unsigned integer value. If the value cannot fit
5422    in <tt>ty2</tt>, the results are undefined.</p>
5423
5424 <h5>Example:</h5>
5425 <pre>
5426   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5427   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5428   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5429 </pre>
5430
5431 </div>
5432
5433 <!-- _______________________________________________________________________ -->
5434 <h4>
5435    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5436 </h4>
5437
5438 <div>
5439
5440 <h5>Syntax:</h5>
5441 <pre>
5442   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5443 </pre>
5444
5445 <h5>Overview:</h5>
5446 <p>The '<tt>fptosi</tt>' instruction converts
5447    <a href="#t_floating">floating point</a> <tt>value</tt> to
5448    type <tt>ty2</tt>.</p>
5449
5450 <h5>Arguments:</h5>
5451 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5452    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5453    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5454    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5455    vector integer type with the same number of elements as <tt>ty</tt></p>
5456
5457 <h5>Semantics:</h5>
5458 <p>The '<tt>fptosi</tt>' instruction converts its
5459    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5460    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5461    the results are undefined.</p>
5462
5463 <h5>Example:</h5>
5464 <pre>
5465   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5466   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5467   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5468 </pre>
5469
5470 </div>
5471
5472 <!-- _______________________________________________________________________ -->
5473 <h4>
5474    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5475 </h4>
5476
5477 <div>
5478
5479 <h5>Syntax:</h5>
5480 <pre>
5481   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5482 </pre>
5483
5484 <h5>Overview:</h5>
5485 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5486    integer and converts that value to the <tt>ty2</tt> type.</p>
5487
5488 <h5>Arguments:</h5>
5489 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5490    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5491    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5492    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5493    floating point type with the same number of elements as <tt>ty</tt></p>
5494
5495 <h5>Semantics:</h5>
5496 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5497    integer quantity and converts it to the corresponding floating point
5498    value. If the value cannot fit in the floating point value, the results are
5499    undefined.</p>
5500
5501 <h5>Example:</h5>
5502 <pre>
5503   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5504   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5505 </pre>
5506
5507 </div>
5508
5509 <!-- _______________________________________________________________________ -->
5510 <h4>
5511    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5512 </h4>
5513
5514 <div>
5515
5516 <h5>Syntax:</h5>
5517 <pre>
5518   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5519 </pre>
5520
5521 <h5>Overview:</h5>
5522 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5523    and converts that value to the <tt>ty2</tt> type.</p>
5524
5525 <h5>Arguments:</h5>
5526 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5527    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5528    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5529    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5530    floating point type with the same number of elements as <tt>ty</tt></p>
5531
5532 <h5>Semantics:</h5>
5533 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5534    quantity and converts it to the corresponding floating point value. If the
5535    value cannot fit in the floating point value, the results are undefined.</p>
5536
5537 <h5>Example:</h5>
5538 <pre>
5539   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5540   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5541 </pre>
5542
5543 </div>
5544
5545 <!-- _______________________________________________________________________ -->
5546 <h4>
5547    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5548 </h4>
5549
5550 <div>
5551
5552 <h5>Syntax:</h5>
5553 <pre>
5554   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5555 </pre>
5556
5557 <h5>Overview:</h5>
5558 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
5559    the integer type <tt>ty2</tt>.</p>
5560
5561 <h5>Arguments:</h5>
5562 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5563    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
5564    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
5565
5566 <h5>Semantics:</h5>
5567 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5568    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5569    truncating or zero extending that value to the size of the integer type. If
5570    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5571    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5572    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5573    change.</p>
5574
5575 <h5>Example:</h5>
5576 <pre>
5577   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
5578   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
5579 </pre>
5580
5581 </div>
5582
5583 <!-- _______________________________________________________________________ -->
5584 <h4>
5585    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5586 </h4>
5587
5588 <div>
5589
5590 <h5>Syntax:</h5>
5591 <pre>
5592   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5593 </pre>
5594
5595 <h5>Overview:</h5>
5596 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5597    pointer type, <tt>ty2</tt>.</p>
5598
5599 <h5>Arguments:</h5>
5600 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5601    value to cast, and a type to cast it to, which must be a
5602    <a href="#t_pointer">pointer</a> type.</p>
5603
5604 <h5>Semantics:</h5>
5605 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5606    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5607    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5608    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5609    than the size of a pointer then a zero extension is done. If they are the
5610    same size, nothing is done (<i>no-op cast</i>).</p>
5611
5612 <h5>Example:</h5>
5613 <pre>
5614   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5615   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5616   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5617 </pre>
5618
5619 </div>
5620
5621 <!-- _______________________________________________________________________ -->
5622 <h4>
5623    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5624 </h4>
5625
5626 <div>
5627
5628 <h5>Syntax:</h5>
5629 <pre>
5630   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5631 </pre>
5632
5633 <h5>Overview:</h5>
5634 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5635    <tt>ty2</tt> without changing any bits.</p>
5636
5637 <h5>Arguments:</h5>
5638 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5639    non-aggregate first class value, and a type to cast it to, which must also be
5640    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5641    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5642    identical. If the source type is a pointer, the destination type must also be
5643    a pointer.  This instruction supports bitwise conversion of vectors to
5644    integers and to vectors of other types (as long as they have the same
5645    size).</p>
5646
5647 <h5>Semantics:</h5>
5648 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5649    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5650    this conversion.  The conversion is done as if the <tt>value</tt> had been
5651    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5652    be converted to other pointer types with this instruction. To convert
5653    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5654    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5655
5656 <h5>Example:</h5>
5657 <pre>
5658   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5659   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5660   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5661 </pre>
5662
5663 </div>
5664
5665 </div>
5666
5667 <!-- ======================================================================= -->
5668 <h3>
5669   <a name="otherops">Other Operations</a>
5670 </h3>
5671
5672 <div>
5673
5674 <p>The instructions in this category are the "miscellaneous" instructions, which
5675    defy better classification.</p>
5676
5677 <!-- _______________________________________________________________________ -->
5678 <h4>
5679   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5680 </h4>
5681
5682 <div>
5683
5684 <h5>Syntax:</h5>
5685 <pre>
5686   &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>
5687 </pre>
5688
5689 <h5>Overview:</h5>
5690 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5691    boolean values based on comparison of its two integer, integer vector, or
5692    pointer operands.</p>
5693
5694 <h5>Arguments:</h5>
5695 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5696    the condition code indicating the kind of comparison to perform. It is not a
5697    value, just a keyword. The possible condition code are:</p>
5698
5699 <ol>
5700   <li><tt>eq</tt>: equal</li>
5701   <li><tt>ne</tt>: not equal </li>
5702   <li><tt>ugt</tt>: unsigned greater than</li>
5703   <li><tt>uge</tt>: unsigned greater or equal</li>
5704   <li><tt>ult</tt>: unsigned less than</li>
5705   <li><tt>ule</tt>: unsigned less or equal</li>
5706   <li><tt>sgt</tt>: signed greater than</li>
5707   <li><tt>sge</tt>: signed greater or equal</li>
5708   <li><tt>slt</tt>: signed less than</li>
5709   <li><tt>sle</tt>: signed less or equal</li>
5710 </ol>
5711
5712 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5713    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5714    typed.  They must also be identical types.</p>
5715
5716 <h5>Semantics:</h5>
5717 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5718    condition code given as <tt>cond</tt>. The comparison performed always yields
5719    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5720    result, as follows:</p>
5721
5722 <ol>
5723   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5724       <tt>false</tt> otherwise. No sign interpretation is necessary or
5725       performed.</li>
5726
5727   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5728       <tt>false</tt> otherwise. No sign interpretation is necessary or
5729       performed.</li>
5730
5731   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5732       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5733
5734   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5735       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5736       to <tt>op2</tt>.</li>
5737
5738   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5739       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5740
5741   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5742       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5743
5744   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5745       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5746
5747   <li><tt>sge</tt>: interprets the operands as signed values and yields
5748       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5749       to <tt>op2</tt>.</li>
5750
5751   <li><tt>slt</tt>: interprets the operands as signed values and yields
5752       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5753
5754   <li><tt>sle</tt>: interprets the operands as signed values and yields
5755       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5756 </ol>
5757
5758 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5759    values are compared as if they were integers.</p>
5760
5761 <p>If the operands are integer vectors, then they are compared element by
5762    element. The result is an <tt>i1</tt> vector with the same number of elements
5763    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5764
5765 <h5>Example:</h5>
5766 <pre>
5767   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5768   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5769   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5770   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5771   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5772   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5773 </pre>
5774
5775 <p>Note that the code generator does not yet support vector types with
5776    the <tt>icmp</tt> instruction.</p>
5777
5778 </div>
5779
5780 <!-- _______________________________________________________________________ -->
5781 <h4>
5782   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5783 </h4>
5784
5785 <div>
5786
5787 <h5>Syntax:</h5>
5788 <pre>
5789   &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>
5790 </pre>
5791
5792 <h5>Overview:</h5>
5793 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5794    values based on comparison of its operands.</p>
5795
5796 <p>If the operands are floating point scalars, then the result type is a boolean
5797 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5798
5799 <p>If the operands are floating point vectors, then the result type is a vector
5800    of boolean with the same number of elements as the operands being
5801    compared.</p>
5802
5803 <h5>Arguments:</h5>
5804 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5805    the condition code indicating the kind of comparison to perform. It is not a
5806    value, just a keyword. The possible condition code are:</p>
5807
5808 <ol>
5809   <li><tt>false</tt>: no comparison, always returns false</li>
5810   <li><tt>oeq</tt>: ordered and equal</li>
5811   <li><tt>ogt</tt>: ordered and greater than </li>
5812   <li><tt>oge</tt>: ordered and greater than or equal</li>
5813   <li><tt>olt</tt>: ordered and less than </li>
5814   <li><tt>ole</tt>: ordered and less than or equal</li>
5815   <li><tt>one</tt>: ordered and not equal</li>
5816   <li><tt>ord</tt>: ordered (no nans)</li>
5817   <li><tt>ueq</tt>: unordered or equal</li>
5818   <li><tt>ugt</tt>: unordered or greater than </li>
5819   <li><tt>uge</tt>: unordered or greater than or equal</li>
5820   <li><tt>ult</tt>: unordered or less than </li>
5821   <li><tt>ule</tt>: unordered or less than or equal</li>
5822   <li><tt>une</tt>: unordered or not equal</li>
5823   <li><tt>uno</tt>: unordered (either nans)</li>
5824   <li><tt>true</tt>: no comparison, always returns true</li>
5825 </ol>
5826
5827 <p><i>Ordered</i> means that neither operand is a QNAN while
5828    <i>unordered</i> means that either operand may be a QNAN.</p>
5829
5830 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5831    a <a href="#t_floating">floating point</a> type or
5832    a <a href="#t_vector">vector</a> of floating point type.  They must have
5833    identical types.</p>
5834
5835 <h5>Semantics:</h5>
5836 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5837    according to the condition code given as <tt>cond</tt>.  If the operands are
5838    vectors, then the vectors are compared element by element.  Each comparison
5839    performed always yields an <a href="#t_integer">i1</a> result, as
5840    follows:</p>
5841
5842 <ol>
5843   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5844
5845   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5846       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5847
5848   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5849       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5850
5851   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5852       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5853
5854   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5855       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5856
5857   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5858       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5859
5860   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5861       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5862
5863   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5864
5865   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5866       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5867
5868   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5869       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5870
5871   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5872       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5873
5874   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5875       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5876
5877   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5878       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5879
5880   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5881       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5882
5883   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5884
5885   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5886 </ol>
5887
5888 <h5>Example:</h5>
5889 <pre>
5890   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5891   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5892   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5893   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5894 </pre>
5895
5896 <p>Note that the code generator does not yet support vector types with
5897    the <tt>fcmp</tt> instruction.</p>
5898
5899 </div>
5900
5901 <!-- _______________________________________________________________________ -->
5902 <h4>
5903   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5904 </h4>
5905
5906 <div>
5907
5908 <h5>Syntax:</h5>
5909 <pre>
5910   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5911 </pre>
5912
5913 <h5>Overview:</h5>
5914 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5915    SSA graph representing the function.</p>
5916
5917 <h5>Arguments:</h5>
5918 <p>The type of the incoming values is specified with the first type field. After
5919    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5920    one pair for each predecessor basic block of the current block.  Only values
5921    of <a href="#t_firstclass">first class</a> type may be used as the value
5922    arguments to the PHI node.  Only labels may be used as the label
5923    arguments.</p>
5924
5925 <p>There must be no non-phi instructions between the start of a basic block and
5926    the PHI instructions: i.e. PHI instructions must be first in a basic
5927    block.</p>
5928
5929 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5930    occur on the edge from the corresponding predecessor block to the current
5931    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5932    value on the same edge).</p>
5933
5934 <h5>Semantics:</h5>
5935 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5936    specified by the pair corresponding to the predecessor basic block that
5937    executed just prior to the current block.</p>
5938
5939 <h5>Example:</h5>
5940 <pre>
5941 Loop:       ; Infinite loop that counts from 0 on up...
5942   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5943   %nextindvar = add i32 %indvar, 1
5944   br label %Loop
5945 </pre>
5946
5947 </div>
5948
5949 <!-- _______________________________________________________________________ -->
5950 <h4>
5951    <a name="i_select">'<tt>select</tt>' Instruction</a>
5952 </h4>
5953
5954 <div>
5955
5956 <h5>Syntax:</h5>
5957 <pre>
5958   &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>
5959
5960   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5961 </pre>
5962
5963 <h5>Overview:</h5>
5964 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5965    condition, without branching.</p>
5966
5967
5968 <h5>Arguments:</h5>
5969 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5970    values indicating the condition, and two values of the
5971    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5972    vectors and the condition is a scalar, then entire vectors are selected, not
5973    individual elements.</p>
5974
5975 <h5>Semantics:</h5>
5976 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5977    first value argument; otherwise, it returns the second value argument.</p>
5978
5979 <p>If the condition is a vector of i1, then the value arguments must be vectors
5980    of the same size, and the selection is done element by element.</p>
5981
5982 <h5>Example:</h5>
5983 <pre>
5984   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5985 </pre>
5986
5987 <p>Note that the code generator does not yet support conditions
5988    with vector type.</p>
5989
5990 </div>
5991
5992 <!-- _______________________________________________________________________ -->
5993 <h4>
5994   <a name="i_call">'<tt>call</tt>' Instruction</a>
5995 </h4>
5996
5997 <div>
5998
5999 <h5>Syntax:</h5>
6000 <pre>
6001   &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>]
6002 </pre>
6003
6004 <h5>Overview:</h5>
6005 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
6006
6007 <h5>Arguments:</h5>
6008 <p>This instruction requires several arguments:</p>
6009
6010 <ol>
6011   <li>The optional "tail" marker indicates that the callee function does not
6012       access any allocas or varargs in the caller.  Note that calls may be
6013       marked "tail" even if they do not occur before
6014       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
6015       present, the function call is eligible for tail call optimization,
6016       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
6017       optimized into a jump</a>.  The code generator may optimize calls marked
6018       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
6019       sibling call optimization</a> when the caller and callee have
6020       matching signatures, or 2) forced tail call optimization when the
6021       following extra requirements are met:
6022       <ul>
6023         <li>Caller and callee both have the calling
6024             convention <tt>fastcc</tt>.</li>
6025         <li>The call is in tail position (ret immediately follows call and ret
6026             uses value of call or is void).</li>
6027         <li>Option <tt>-tailcallopt</tt> is enabled,
6028             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
6029         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
6030             constraints are met.</a></li>
6031       </ul>
6032   </li>
6033
6034   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
6035       convention</a> the call should use.  If none is specified, the call
6036       defaults to using C calling conventions.  The calling convention of the
6037       call must match the calling convention of the target function, or else the
6038       behavior is undefined.</li>
6039
6040   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
6041       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
6042       '<tt>inreg</tt>' attributes are valid here.</li>
6043
6044   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
6045       type of the return value.  Functions that return no value are marked
6046       <tt><a href="#t_void">void</a></tt>.</li>
6047
6048   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
6049       being invoked.  The argument types must match the types implied by this
6050       signature.  This type can be omitted if the function is not varargs and if
6051       the function type does not return a pointer to a function.</li>
6052
6053   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
6054       be invoked. In most cases, this is a direct function invocation, but
6055       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
6056       to function value.</li>
6057
6058   <li>'<tt>function args</tt>': argument list whose types match the function
6059       signature argument types and parameter attributes. All arguments must be
6060       of <a href="#t_firstclass">first class</a> type. If the function
6061       signature indicates the function accepts a variable number of arguments,
6062       the extra arguments can be specified.</li>
6063
6064   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
6065       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
6066       '<tt>readnone</tt>' attributes are valid here.</li>
6067 </ol>
6068
6069 <h5>Semantics:</h5>
6070 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
6071    a specified function, with its incoming arguments bound to the specified
6072    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
6073    function, control flow continues with the instruction after the function
6074    call, and the return value of the function is bound to the result
6075    argument.</p>
6076
6077 <h5>Example:</h5>
6078 <pre>
6079   %retval = call i32 @test(i32 %argc)
6080   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
6081   %X = tail call i32 @foo()                                    <i>; yields i32</i>
6082   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
6083   call void %foo(i8 97 signext)
6084
6085   %struct.A = type { i32, i8 }
6086   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
6087   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
6088   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
6089   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
6090   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
6091 </pre>
6092
6093 <p>llvm treats calls to some functions with names and arguments that match the
6094 standard C99 library as being the C99 library functions, and may perform
6095 optimizations or generate code for them under that assumption.  This is
6096 something we'd like to change in the future to provide better support for
6097 freestanding environments and non-C-based languages.</p>
6098
6099 </div>
6100
6101 <!-- _______________________________________________________________________ -->
6102 <h4>
6103   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
6104 </h4>
6105
6106 <div>
6107
6108 <h5>Syntax:</h5>
6109 <pre>
6110   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
6111 </pre>
6112
6113 <h5>Overview:</h5>
6114 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
6115    the "variable argument" area of a function call.  It is used to implement the
6116    <tt>va_arg</tt> macro in C.</p>
6117
6118 <h5>Arguments:</h5>
6119 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
6120    argument. It returns a value of the specified argument type and increments
6121    the <tt>va_list</tt> to point to the next argument.  The actual type
6122    of <tt>va_list</tt> is target specific.</p>
6123
6124 <h5>Semantics:</h5>
6125 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
6126    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
6127    to the next argument.  For more information, see the variable argument
6128    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
6129
6130 <p>It is legal for this instruction to be called in a function which does not
6131    take a variable number of arguments, for example, the <tt>vfprintf</tt>
6132    function.</p>
6133
6134 <p><tt>va_arg</tt> is an LLVM instruction instead of
6135    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
6136    argument.</p>
6137
6138 <h5>Example:</h5>
6139 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6140
6141 <p>Note that the code generator does not yet fully support va_arg on many
6142    targets. Also, it does not currently support va_arg with aggregate types on
6143    any target.</p>
6144
6145 </div>
6146
6147 <!-- _______________________________________________________________________ -->
6148 <h4>
6149   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6150 </h4>
6151
6152 <div>
6153
6154 <h5>Syntax:</h5>
6155 <pre>
6156   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6157   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6158
6159   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6160   &lt;clause&gt; := filter &lt;array constant type&gt; &lt;array constant&gt;
6161 </pre>
6162
6163 <h5>Overview:</h5>
6164 <p>The '<tt>landingpad</tt>' instruction is used by
6165    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6166    system</a> to specify that a basic block is a landing pad &mdash; one where
6167    the exception lands, and corresponds to the code found in the
6168    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6169    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6170    re-entry to the function. The <tt>resultval</tt> has the
6171    type <tt>somety</tt>.</p>
6172
6173 <h5>Arguments:</h5>
6174 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6175    function associated with the unwinding mechanism. The optional
6176    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6177
6178 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6179    or <tt>filter</tt> &mdash; and contains the global variable representing the
6180    "type" that may be caught or filtered respectively. Unlike the
6181    <tt>catch</tt> clause, the <tt>filter</tt> clause takes an array constant as
6182    its argument. Use "<tt>[0 x i8**] undef</tt>" for a filter which cannot
6183    throw. The '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6184    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6185
6186 <h5>Semantics:</h5>
6187 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6188    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6189    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6190    calling conventions, how the personality function results are represented in
6191    LLVM IR is target specific.</p>
6192
6193 <p>The clauses are applied in order from top to bottom. If two
6194    <tt>landingpad</tt> instructions are merged together through inlining, the
6195    clauses from the calling function are appended to the list of clauses.</p>
6196
6197 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6198
6199 <ul>
6200   <li>A landing pad block is a basic block which is the unwind destination of an
6201       '<tt>invoke</tt>' instruction.</li>
6202   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6203       first non-PHI instruction.</li>
6204   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6205       pad block.</li>
6206   <li>A basic block that is not a landing pad block may not include a
6207       '<tt>landingpad</tt>' instruction.</li>
6208   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6209       personality function.</li>
6210 </ul>
6211
6212 <h5>Example:</h5>
6213 <pre>
6214   ;; A landing pad which can catch an integer.
6215   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6216            catch i8** @_ZTIi
6217   ;; A landing pad that is a cleanup.
6218   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6219            cleanup
6220   ;; A landing pad which can catch an integer and can only throw a double.
6221   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6222            catch i8** @_ZTIi
6223            filter [1 x i8**] [@_ZTId]
6224 </pre>
6225
6226 </div>
6227
6228 </div>
6229
6230 </div>
6231
6232 <!-- *********************************************************************** -->
6233 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6234 <!-- *********************************************************************** -->
6235
6236 <div>
6237
6238 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6239    well known names and semantics and are required to follow certain
6240    restrictions.  Overall, these intrinsics represent an extension mechanism for
6241    the LLVM language that does not require changing all of the transformations
6242    in LLVM when adding to the language (or the bitcode reader/writer, the
6243    parser, etc...).</p>
6244
6245 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6246    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6247    begin with this prefix.  Intrinsic functions must always be external
6248    functions: you cannot define the body of intrinsic functions.  Intrinsic
6249    functions may only be used in call or invoke instructions: it is illegal to
6250    take the address of an intrinsic function.  Additionally, because intrinsic
6251    functions are part of the LLVM language, it is required if any are added that
6252    they be documented here.</p>
6253
6254 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6255    family of functions that perform the same operation but on different data
6256    types. Because LLVM can represent over 8 million different integer types,
6257    overloading is used commonly to allow an intrinsic function to operate on any
6258    integer type. One or more of the argument types or the result type can be
6259    overloaded to accept any integer type. Argument types may also be defined as
6260    exactly matching a previous argument's type or the result type. This allows
6261    an intrinsic function which accepts multiple arguments, but needs all of them
6262    to be of the same type, to only be overloaded with respect to a single
6263    argument or the result.</p>
6264
6265 <p>Overloaded intrinsics will have the names of its overloaded argument types
6266    encoded into its function name, each preceded by a period. Only those types
6267    which are overloaded result in a name suffix. Arguments whose type is matched
6268    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6269    can take an integer of any width and returns an integer of exactly the same
6270    integer width. This leads to a family of functions such as
6271    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6272    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6273    suffix is required. Because the argument's type is matched against the return
6274    type, it does not require its own name suffix.</p>
6275
6276 <p>To learn how to add an intrinsic function, please see the
6277    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6278
6279 <!-- ======================================================================= -->
6280 <h3>
6281   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6282 </h3>
6283
6284 <div>
6285
6286 <p>Variable argument support is defined in LLVM with
6287    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6288    intrinsic functions.  These functions are related to the similarly named
6289    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6290
6291 <p>All of these functions operate on arguments that use a target-specific value
6292    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6293    not define what this type is, so all transformations should be prepared to
6294    handle these functions regardless of the type used.</p>
6295
6296 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6297    instruction and the variable argument handling intrinsic functions are
6298    used.</p>
6299
6300 <pre class="doc_code">
6301 define i32 @test(i32 %X, ...) {
6302   ; Initialize variable argument processing
6303   %ap = alloca i8*
6304   %ap2 = bitcast i8** %ap to i8*
6305   call void @llvm.va_start(i8* %ap2)
6306
6307   ; Read a single integer argument
6308   %tmp = va_arg i8** %ap, i32
6309
6310   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6311   %aq = alloca i8*
6312   %aq2 = bitcast i8** %aq to i8*
6313   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6314   call void @llvm.va_end(i8* %aq2)
6315
6316   ; Stop processing of arguments.
6317   call void @llvm.va_end(i8* %ap2)
6318   ret i32 %tmp
6319 }
6320
6321 declare void @llvm.va_start(i8*)
6322 declare void @llvm.va_copy(i8*, i8*)
6323 declare void @llvm.va_end(i8*)
6324 </pre>
6325
6326 <!-- _______________________________________________________________________ -->
6327 <h4>
6328   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6329 </h4>
6330
6331
6332 <div>
6333
6334 <h5>Syntax:</h5>
6335 <pre>
6336   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6337 </pre>
6338
6339 <h5>Overview:</h5>
6340 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6341    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6342
6343 <h5>Arguments:</h5>
6344 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6345
6346 <h5>Semantics:</h5>
6347 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6348    macro available in C.  In a target-dependent way, it initializes
6349    the <tt>va_list</tt> element to which the argument points, so that the next
6350    call to <tt>va_arg</tt> will produce the first variable argument passed to
6351    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6352    need to know the last argument of the function as the compiler can figure
6353    that out.</p>
6354
6355 </div>
6356
6357 <!-- _______________________________________________________________________ -->
6358 <h4>
6359  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6360 </h4>
6361
6362 <div>
6363
6364 <h5>Syntax:</h5>
6365 <pre>
6366   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6367 </pre>
6368
6369 <h5>Overview:</h5>
6370 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6371    which has been initialized previously
6372    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6373    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6374
6375 <h5>Arguments:</h5>
6376 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6377
6378 <h5>Semantics:</h5>
6379 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6380    macro available in C.  In a target-dependent way, it destroys
6381    the <tt>va_list</tt> element to which the argument points.  Calls
6382    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6383    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6384    with calls to <tt>llvm.va_end</tt>.</p>
6385
6386 </div>
6387
6388 <!-- _______________________________________________________________________ -->
6389 <h4>
6390   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6391 </h4>
6392
6393 <div>
6394
6395 <h5>Syntax:</h5>
6396 <pre>
6397   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6398 </pre>
6399
6400 <h5>Overview:</h5>
6401 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6402    from the source argument list to the destination argument list.</p>
6403
6404 <h5>Arguments:</h5>
6405 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6406    The second argument is a pointer to a <tt>va_list</tt> element to copy
6407    from.</p>
6408
6409 <h5>Semantics:</h5>
6410 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6411    macro available in C.  In a target-dependent way, it copies the
6412    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6413    element.  This intrinsic is necessary because
6414    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6415    arbitrarily complex and require, for example, memory allocation.</p>
6416
6417 </div>
6418
6419 </div>
6420
6421 <!-- ======================================================================= -->
6422 <h3>
6423   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6424 </h3>
6425
6426 <div>
6427
6428 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6429 Collection</a> (GC) requires the implementation and generation of these
6430 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6431 roots on the stack</a>, as well as garbage collector implementations that
6432 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6433 barriers.  Front-ends for type-safe garbage collected languages should generate
6434 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6435 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6436 LLVM</a>.</p>
6437
6438 <p>The garbage collection intrinsics only operate on objects in the generic
6439    address space (address space zero).</p>
6440
6441 <!-- _______________________________________________________________________ -->
6442 <h4>
6443   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6444 </h4>
6445
6446 <div>
6447
6448 <h5>Syntax:</h5>
6449 <pre>
6450   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6451 </pre>
6452
6453 <h5>Overview:</h5>
6454 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6455    the code generator, and allows some metadata to be associated with it.</p>
6456
6457 <h5>Arguments:</h5>
6458 <p>The first argument specifies the address of a stack object that contains the
6459    root pointer.  The second pointer (which must be either a constant or a
6460    global value address) contains the meta-data to be associated with the
6461    root.</p>
6462
6463 <h5>Semantics:</h5>
6464 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6465    location.  At compile-time, the code generator generates information to allow
6466    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6467    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6468    algorithm</a>.</p>
6469
6470 </div>
6471
6472 <!-- _______________________________________________________________________ -->
6473 <h4>
6474   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6475 </h4>
6476
6477 <div>
6478
6479 <h5>Syntax:</h5>
6480 <pre>
6481   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6482 </pre>
6483
6484 <h5>Overview:</h5>
6485 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6486    locations, allowing garbage collector implementations that require read
6487    barriers.</p>
6488
6489 <h5>Arguments:</h5>
6490 <p>The second argument is the address to read from, which should be an address
6491    allocated from the garbage collector.  The first object is a pointer to the
6492    start of the referenced object, if needed by the language runtime (otherwise
6493    null).</p>
6494
6495 <h5>Semantics:</h5>
6496 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6497    instruction, but may be replaced with substantially more complex code by the
6498    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6499    may only be used in a function which <a href="#gc">specifies a GC
6500    algorithm</a>.</p>
6501
6502 </div>
6503
6504 <!-- _______________________________________________________________________ -->
6505 <h4>
6506   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6507 </h4>
6508
6509 <div>
6510
6511 <h5>Syntax:</h5>
6512 <pre>
6513   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6514 </pre>
6515
6516 <h5>Overview:</h5>
6517 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6518    locations, allowing garbage collector implementations that require write
6519    barriers (such as generational or reference counting collectors).</p>
6520
6521 <h5>Arguments:</h5>
6522 <p>The first argument is the reference to store, the second is the start of the
6523    object to store it to, and the third is the address of the field of Obj to
6524    store to.  If the runtime does not require a pointer to the object, Obj may
6525    be null.</p>
6526
6527 <h5>Semantics:</h5>
6528 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6529    instruction, but may be replaced with substantially more complex code by the
6530    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6531    may only be used in a function which <a href="#gc">specifies a GC
6532    algorithm</a>.</p>
6533
6534 </div>
6535
6536 </div>
6537
6538 <!-- ======================================================================= -->
6539 <h3>
6540   <a name="int_codegen">Code Generator Intrinsics</a>
6541 </h3>
6542
6543 <div>
6544
6545 <p>These intrinsics are provided by LLVM to expose special features that may
6546    only be implemented with code generator support.</p>
6547
6548 <!-- _______________________________________________________________________ -->
6549 <h4>
6550   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6551 </h4>
6552
6553 <div>
6554
6555 <h5>Syntax:</h5>
6556 <pre>
6557   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6558 </pre>
6559
6560 <h5>Overview:</h5>
6561 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6562    target-specific value indicating the return address of the current function
6563    or one of its callers.</p>
6564
6565 <h5>Arguments:</h5>
6566 <p>The argument to this intrinsic indicates which function to return the address
6567    for.  Zero indicates the calling function, one indicates its caller, etc.
6568    The argument is <b>required</b> to be a constant integer value.</p>
6569
6570 <h5>Semantics:</h5>
6571 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6572    indicating the return address of the specified call frame, or zero if it
6573    cannot be identified.  The value returned by this intrinsic is likely to be
6574    incorrect or 0 for arguments other than zero, so it should only be used for
6575    debugging purposes.</p>
6576
6577 <p>Note that calling this intrinsic does not prevent function inlining or other
6578    aggressive transformations, so the value returned may not be that of the
6579    obvious source-language caller.</p>
6580
6581 </div>
6582
6583 <!-- _______________________________________________________________________ -->
6584 <h4>
6585   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6586 </h4>
6587
6588 <div>
6589
6590 <h5>Syntax:</h5>
6591 <pre>
6592   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6593 </pre>
6594
6595 <h5>Overview:</h5>
6596 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6597    target-specific frame pointer value for the specified stack frame.</p>
6598
6599 <h5>Arguments:</h5>
6600 <p>The argument to this intrinsic indicates which function to return the frame
6601    pointer for.  Zero indicates the calling function, one indicates its caller,
6602    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6603
6604 <h5>Semantics:</h5>
6605 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6606    indicating the frame address of the specified call frame, or zero if it
6607    cannot be identified.  The value returned by this intrinsic is likely to be
6608    incorrect or 0 for arguments other than zero, so it should only be used for
6609    debugging purposes.</p>
6610
6611 <p>Note that calling this intrinsic does not prevent function inlining or other
6612    aggressive transformations, so the value returned may not be that of the
6613    obvious source-language caller.</p>
6614
6615 </div>
6616
6617 <!-- _______________________________________________________________________ -->
6618 <h4>
6619   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6620 </h4>
6621
6622 <div>
6623
6624 <h5>Syntax:</h5>
6625 <pre>
6626   declare i8* @llvm.stacksave()
6627 </pre>
6628
6629 <h5>Overview:</h5>
6630 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6631    of the function stack, for use
6632    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6633    useful for implementing language features like scoped automatic variable
6634    sized arrays in C99.</p>
6635
6636 <h5>Semantics:</h5>
6637 <p>This intrinsic returns a opaque pointer value that can be passed
6638    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6639    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6640    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6641    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6642    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6643    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6644
6645 </div>
6646
6647 <!-- _______________________________________________________________________ -->
6648 <h4>
6649   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6650 </h4>
6651
6652 <div>
6653
6654 <h5>Syntax:</h5>
6655 <pre>
6656   declare void @llvm.stackrestore(i8* %ptr)
6657 </pre>
6658
6659 <h5>Overview:</h5>
6660 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6661    the function stack to the state it was in when the
6662    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6663    executed.  This is useful for implementing language features like scoped
6664    automatic variable sized arrays in C99.</p>
6665
6666 <h5>Semantics:</h5>
6667 <p>See the description
6668    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6669
6670 </div>
6671
6672 <!-- _______________________________________________________________________ -->
6673 <h4>
6674   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6675 </h4>
6676
6677 <div>
6678
6679 <h5>Syntax:</h5>
6680 <pre>
6681   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6682 </pre>
6683
6684 <h5>Overview:</h5>
6685 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6686    insert a prefetch instruction if supported; otherwise, it is a noop.
6687    Prefetches have no effect on the behavior of the program but can change its
6688    performance characteristics.</p>
6689
6690 <h5>Arguments:</h5>
6691 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6692    specifier determining if the fetch should be for a read (0) or write (1),
6693    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6694    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6695    specifies whether the prefetch is performed on the data (1) or instruction (0)
6696    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6697    must be constant integers.</p>
6698
6699 <h5>Semantics:</h5>
6700 <p>This intrinsic does not modify the behavior of the program.  In particular,
6701    prefetches cannot trap and do not produce a value.  On targets that support
6702    this intrinsic, the prefetch can provide hints to the processor cache for
6703    better performance.</p>
6704
6705 </div>
6706
6707 <!-- _______________________________________________________________________ -->
6708 <h4>
6709   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6710 </h4>
6711
6712 <div>
6713
6714 <h5>Syntax:</h5>
6715 <pre>
6716   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6717 </pre>
6718
6719 <h5>Overview:</h5>
6720 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6721    Counter (PC) in a region of code to simulators and other tools.  The method
6722    is target specific, but it is expected that the marker will use exported
6723    symbols to transmit the PC of the marker.  The marker makes no guarantees
6724    that it will remain with any specific instruction after optimizations.  It is
6725    possible that the presence of a marker will inhibit optimizations.  The
6726    intended use is to be inserted after optimizations to allow correlations of
6727    simulation runs.</p>
6728
6729 <h5>Arguments:</h5>
6730 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6731
6732 <h5>Semantics:</h5>
6733 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6734    not support this intrinsic may ignore it.</p>
6735
6736 </div>
6737
6738 <!-- _______________________________________________________________________ -->
6739 <h4>
6740   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6741 </h4>
6742
6743 <div>
6744
6745 <h5>Syntax:</h5>
6746 <pre>
6747   declare i64 @llvm.readcyclecounter()
6748 </pre>
6749
6750 <h5>Overview:</h5>
6751 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6752    counter register (or similar low latency, high accuracy clocks) on those
6753    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6754    should map to RPCC.  As the backing counters overflow quickly (on the order
6755    of 9 seconds on alpha), this should only be used for small timings.</p>
6756
6757 <h5>Semantics:</h5>
6758 <p>When directly supported, reading the cycle counter should not modify any
6759    memory.  Implementations are allowed to either return a application specific
6760    value or a system wide value.  On backends without support, this is lowered
6761    to a constant 0.</p>
6762
6763 </div>
6764
6765 </div>
6766
6767 <!-- ======================================================================= -->
6768 <h3>
6769   <a name="int_libc">Standard C Library Intrinsics</a>
6770 </h3>
6771
6772 <div>
6773
6774 <p>LLVM provides intrinsics for a few important standard C library functions.
6775    These intrinsics allow source-language front-ends to pass information about
6776    the alignment of the pointer arguments to the code generator, providing
6777    opportunity for more efficient code generation.</p>
6778
6779 <!-- _______________________________________________________________________ -->
6780 <h4>
6781   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6782 </h4>
6783
6784 <div>
6785
6786 <h5>Syntax:</h5>
6787 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6788    integer bit width and for different address spaces. Not all targets support
6789    all bit widths however.</p>
6790
6791 <pre>
6792   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6793                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6794   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6795                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6796 </pre>
6797
6798 <h5>Overview:</h5>
6799 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6800    source location to the destination location.</p>
6801
6802 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6803    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6804    and the pointers can be in specified address spaces.</p>
6805
6806 <h5>Arguments:</h5>
6807
6808 <p>The first argument is a pointer to the destination, the second is a pointer
6809    to the source.  The third argument is an integer argument specifying the
6810    number of bytes to copy, the fourth argument is the alignment of the
6811    source and destination locations, and the fifth is a boolean indicating a
6812    volatile access.</p>
6813
6814 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6815    then the caller guarantees that both the source and destination pointers are
6816    aligned to that boundary.</p>
6817
6818 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6819    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6820    The detailed access behavior is not very cleanly specified and it is unwise
6821    to depend on it.</p>
6822
6823 <h5>Semantics:</h5>
6824
6825 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6826    source location to the destination location, which are not allowed to
6827    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6828    be aligned to some boundary, this can be specified as the fourth argument,
6829    otherwise it should be set to 0 or 1.</p>
6830
6831 </div>
6832
6833 <!-- _______________________________________________________________________ -->
6834 <h4>
6835   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6836 </h4>
6837
6838 <div>
6839
6840 <h5>Syntax:</h5>
6841 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6842    width and for different address space. Not all targets support all bit
6843    widths however.</p>
6844
6845 <pre>
6846   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6847                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6848   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6849                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6850 </pre>
6851
6852 <h5>Overview:</h5>
6853 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6854    source location to the destination location. It is similar to the
6855    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6856    overlap.</p>
6857
6858 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6859    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6860    and the pointers can be in specified address spaces.</p>
6861
6862 <h5>Arguments:</h5>
6863
6864 <p>The first argument is a pointer to the destination, the second is a pointer
6865    to the source.  The third argument is an integer argument specifying the
6866    number of bytes to copy, the fourth argument is the alignment of the
6867    source and destination locations, and the fifth is a boolean indicating a
6868    volatile access.</p>
6869
6870 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6871    then the caller guarantees that the source and destination pointers are
6872    aligned to that boundary.</p>
6873
6874 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6875    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6876    The detailed access behavior is not very cleanly specified and it is unwise
6877    to depend on it.</p>
6878
6879 <h5>Semantics:</h5>
6880
6881 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6882    source location to the destination location, which may overlap.  It copies
6883    "len" bytes of memory over.  If the argument is known to be aligned to some
6884    boundary, this can be specified as the fourth argument, otherwise it should
6885    be set to 0 or 1.</p>
6886
6887 </div>
6888
6889 <!-- _______________________________________________________________________ -->
6890 <h4>
6891   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6892 </h4>
6893
6894 <div>
6895
6896 <h5>Syntax:</h5>
6897 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6898    width and for different address spaces. However, not all targets support all
6899    bit widths.</p>
6900
6901 <pre>
6902   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6903                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6904   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6905                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6906 </pre>
6907
6908 <h5>Overview:</h5>
6909 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6910    particular byte value.</p>
6911
6912 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6913    intrinsic does not return a value and takes extra alignment/volatile
6914    arguments.  Also, the destination can be in an arbitrary address space.</p>
6915
6916 <h5>Arguments:</h5>
6917 <p>The first argument is a pointer to the destination to fill, the second is the
6918    byte value with which to fill it, the third argument is an integer argument
6919    specifying the number of bytes to fill, and the fourth argument is the known
6920    alignment of the destination location.</p>
6921
6922 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6923    then the caller guarantees that the destination pointer is aligned to that
6924    boundary.</p>
6925
6926 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6927    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6928    The detailed access behavior is not very cleanly specified and it is unwise
6929    to depend on it.</p>
6930
6931 <h5>Semantics:</h5>
6932 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6933    at the destination location.  If the argument is known to be aligned to some
6934    boundary, this can be specified as the fourth argument, otherwise it should
6935    be set to 0 or 1.</p>
6936
6937 </div>
6938
6939 <!-- _______________________________________________________________________ -->
6940 <h4>
6941   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6942 </h4>
6943
6944 <div>
6945
6946 <h5>Syntax:</h5>
6947 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6948    floating point or vector of floating point type. Not all targets support all
6949    types however.</p>
6950
6951 <pre>
6952   declare float     @llvm.sqrt.f32(float %Val)
6953   declare double    @llvm.sqrt.f64(double %Val)
6954   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6955   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6956   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6957 </pre>
6958
6959 <h5>Overview:</h5>
6960 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6961    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6962    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6963    behavior for negative numbers other than -0.0 (which allows for better
6964    optimization, because there is no need to worry about errno being
6965    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6966
6967 <h5>Arguments:</h5>
6968 <p>The argument and return value are floating point numbers of the same
6969    type.</p>
6970
6971 <h5>Semantics:</h5>
6972 <p>This function returns the sqrt of the specified operand if it is a
6973    nonnegative floating point number.</p>
6974
6975 </div>
6976
6977 <!-- _______________________________________________________________________ -->
6978 <h4>
6979   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6980 </h4>
6981
6982 <div>
6983
6984 <h5>Syntax:</h5>
6985 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6986    floating point or vector of floating point type. Not all targets support all
6987    types however.</p>
6988
6989 <pre>
6990   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6991   declare double    @llvm.powi.f64(double %Val, i32 %power)
6992   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6993   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6994   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6995 </pre>
6996
6997 <h5>Overview:</h5>
6998 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6999    specified (positive or negative) power.  The order of evaluation of
7000    multiplications is not defined.  When a vector of floating point type is
7001    used, the second argument remains a scalar integer value.</p>
7002
7003 <h5>Arguments:</h5>
7004 <p>The second argument is an integer power, and the first is a value to raise to
7005    that power.</p>
7006
7007 <h5>Semantics:</h5>
7008 <p>This function returns the first value raised to the second power with an
7009    unspecified sequence of rounding operations.</p>
7010
7011 </div>
7012
7013 <!-- _______________________________________________________________________ -->
7014 <h4>
7015   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
7016 </h4>
7017
7018 <div>
7019
7020 <h5>Syntax:</h5>
7021 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
7022    floating point or vector of floating point type. Not all targets support all
7023    types however.</p>
7024
7025 <pre>
7026   declare float     @llvm.sin.f32(float  %Val)
7027   declare double    @llvm.sin.f64(double %Val)
7028   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
7029   declare fp128     @llvm.sin.f128(fp128 %Val)
7030   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
7031 </pre>
7032
7033 <h5>Overview:</h5>
7034 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
7035
7036 <h5>Arguments:</h5>
7037 <p>The argument and return value are floating point numbers of the same
7038    type.</p>
7039
7040 <h5>Semantics:</h5>
7041 <p>This function returns the sine of the specified operand, returning the same
7042    values as the libm <tt>sin</tt> functions would, and handles error conditions
7043    in the same way.</p>
7044
7045 </div>
7046
7047 <!-- _______________________________________________________________________ -->
7048 <h4>
7049   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
7050 </h4>
7051
7052 <div>
7053
7054 <h5>Syntax:</h5>
7055 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
7056    floating point or vector of floating point type. Not all targets support all
7057    types however.</p>
7058
7059 <pre>
7060   declare float     @llvm.cos.f32(float  %Val)
7061   declare double    @llvm.cos.f64(double %Val)
7062   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
7063   declare fp128     @llvm.cos.f128(fp128 %Val)
7064   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
7065 </pre>
7066
7067 <h5>Overview:</h5>
7068 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
7069
7070 <h5>Arguments:</h5>
7071 <p>The argument and return value are floating point numbers of the same
7072    type.</p>
7073
7074 <h5>Semantics:</h5>
7075 <p>This function returns the cosine of the specified operand, returning the same
7076    values as the libm <tt>cos</tt> functions would, and handles error conditions
7077    in the same way.</p>
7078
7079 </div>
7080
7081 <!-- _______________________________________________________________________ -->
7082 <h4>
7083   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
7084 </h4>
7085
7086 <div>
7087
7088 <h5>Syntax:</h5>
7089 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
7090    floating point or vector of floating point type. Not all targets support all
7091    types however.</p>
7092
7093 <pre>
7094   declare float     @llvm.pow.f32(float  %Val, float %Power)
7095   declare double    @llvm.pow.f64(double %Val, double %Power)
7096   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
7097   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
7098   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
7099 </pre>
7100
7101 <h5>Overview:</h5>
7102 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
7103    specified (positive or negative) power.</p>
7104
7105 <h5>Arguments:</h5>
7106 <p>The second argument is a floating point power, and the first is a value to
7107    raise to that power.</p>
7108
7109 <h5>Semantics:</h5>
7110 <p>This function returns the first value raised to the second power, returning
7111    the same values as the libm <tt>pow</tt> functions would, and handles error
7112    conditions in the same way.</p>
7113
7114 </div>
7115
7116 <!-- _______________________________________________________________________ -->
7117 <h4>
7118   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
7119 </h4>
7120
7121 <div>
7122
7123 <h5>Syntax:</h5>
7124 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
7125    floating point or vector of floating point type. Not all targets support all
7126    types however.</p>
7127
7128 <pre>
7129   declare float     @llvm.exp.f32(float  %Val)
7130   declare double    @llvm.exp.f64(double %Val)
7131   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
7132   declare fp128     @llvm.exp.f128(fp128 %Val)
7133   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
7134 </pre>
7135
7136 <h5>Overview:</h5>
7137 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7138
7139 <h5>Arguments:</h5>
7140 <p>The argument and return value are floating point numbers of the same
7141    type.</p>
7142
7143 <h5>Semantics:</h5>
7144 <p>This function returns the same values as the libm <tt>exp</tt> functions
7145    would, and handles error conditions in the same way.</p>
7146
7147 </div>
7148
7149 <!-- _______________________________________________________________________ -->
7150 <h4>
7151   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7152 </h4>
7153
7154 <div>
7155
7156 <h5>Syntax:</h5>
7157 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7158    floating point or vector of floating point type. Not all targets support all
7159    types however.</p>
7160
7161 <pre>
7162   declare float     @llvm.log.f32(float  %Val)
7163   declare double    @llvm.log.f64(double %Val)
7164   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7165   declare fp128     @llvm.log.f128(fp128 %Val)
7166   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7167 </pre>
7168
7169 <h5>Overview:</h5>
7170 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7171
7172 <h5>Arguments:</h5>
7173 <p>The argument and return value are floating point numbers of the same
7174    type.</p>
7175
7176 <h5>Semantics:</h5>
7177 <p>This function returns the same values as the libm <tt>log</tt> functions
7178    would, and handles error conditions in the same way.</p>
7179
7180 </div>
7181
7182 <!-- _______________________________________________________________________ -->
7183 <h4>
7184   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7185 </h4>
7186
7187 <div>
7188
7189 <h5>Syntax:</h5>
7190 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7191    floating point or vector of floating point type. Not all targets support all
7192    types however.</p>
7193
7194 <pre>
7195   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7196   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7197   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7198   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7199   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7200 </pre>
7201
7202 <h5>Overview:</h5>
7203 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7204    operation.</p>
7205
7206 <h5>Arguments:</h5>
7207 <p>The argument and return value are floating point numbers of the same
7208    type.</p>
7209
7210 <h5>Semantics:</h5>
7211 <p>This function returns the same values as the libm <tt>fma</tt> functions
7212    would.</p>
7213
7214 </div>
7215
7216 </div>
7217
7218 <!-- ======================================================================= -->
7219 <h3>
7220   <a name="int_manip">Bit Manipulation Intrinsics</a>
7221 </h3>
7222
7223 <div>
7224
7225 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7226    These allow efficient code generation for some algorithms.</p>
7227
7228 <!-- _______________________________________________________________________ -->
7229 <h4>
7230   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7231 </h4>
7232
7233 <div>
7234
7235 <h5>Syntax:</h5>
7236 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7237    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7238
7239 <pre>
7240   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7241   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7242   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7243 </pre>
7244
7245 <h5>Overview:</h5>
7246 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7247    values with an even number of bytes (positive multiple of 16 bits).  These
7248    are useful for performing operations on data that is not in the target's
7249    native byte order.</p>
7250
7251 <h5>Semantics:</h5>
7252 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7253    and low byte of the input i16 swapped.  Similarly,
7254    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7255    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7256    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7257    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7258    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7259    more, respectively).</p>
7260
7261 </div>
7262
7263 <!-- _______________________________________________________________________ -->
7264 <h4>
7265   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7266 </h4>
7267
7268 <div>
7269
7270 <h5>Syntax:</h5>
7271 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7272    width, or on any vector with integer elements. Not all targets support all
7273   bit widths or vector types, however.</p>
7274
7275 <pre>
7276   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7277   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7278   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7279   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7280   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7281   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7282 </pre>
7283
7284 <h5>Overview:</h5>
7285 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7286    in a value.</p>
7287
7288 <h5>Arguments:</h5>
7289 <p>The only argument is the value to be counted.  The argument may be of any
7290    integer type, or a vector with integer elements.
7291    The return type must match the argument type.</p>
7292
7293 <h5>Semantics:</h5>
7294 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7295    element of a vector.</p>
7296
7297 </div>
7298
7299 <!-- _______________________________________________________________________ -->
7300 <h4>
7301   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7302 </h4>
7303
7304 <div>
7305
7306 <h5>Syntax:</h5>
7307 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7308    integer bit width, or any vector whose elements are integers. Not all
7309    targets support all bit widths or vector types, however.</p>
7310
7311 <pre>
7312   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
7313   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
7314   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
7315   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
7316   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
7317   declare &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src;gt)
7318 </pre>
7319
7320 <h5>Overview:</h5>
7321 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7322    leading zeros in a variable.</p>
7323
7324 <h5>Arguments:</h5>
7325 <p>The only argument is the value to be counted.  The argument may be of any
7326    integer type, or any vector type with integer element type.
7327    The return type must match the argument type.</p>
7328
7329 <h5>Semantics:</h5>
7330 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7331    zeros in a variable, or within each element of the vector if the operation
7332    is of vector type.  If the src == 0 then the result is the size in bits of
7333    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7334
7335 </div>
7336
7337 <!-- _______________________________________________________________________ -->
7338 <h4>
7339   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7340 </h4>
7341
7342 <div>
7343
7344 <h5>Syntax:</h5>
7345 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7346    integer bit width, or any vector of integer elements. Not all targets
7347    support all bit widths or vector types, however.</p>
7348
7349 <pre>
7350   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
7351   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
7352   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
7353   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
7354   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
7355   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7356 </pre>
7357
7358 <h5>Overview:</h5>
7359 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7360    trailing zeros.</p>
7361
7362 <h5>Arguments:</h5>
7363 <p>The only argument is the value to be counted.  The argument may be of any
7364    integer type, or a vectory with integer element type..  The return type
7365    must match the argument type.</p>
7366
7367 <h5>Semantics:</h5>
7368 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7369    zeros in a variable, or within each element of a vector.
7370    If the src == 0 then the result is the size in bits of
7371    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7372
7373 </div>
7374
7375 </div>
7376
7377 <!-- ======================================================================= -->
7378 <h3>
7379   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7380 </h3>
7381
7382 <div>
7383
7384 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7385
7386 <!-- _______________________________________________________________________ -->
7387 <h4>
7388   <a name="int_sadd_overflow">
7389     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7390   </a>
7391 </h4>
7392
7393 <div>
7394
7395 <h5>Syntax:</h5>
7396 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7397    on any integer bit width.</p>
7398
7399 <pre>
7400   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7401   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7402   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7403 </pre>
7404
7405 <h5>Overview:</h5>
7406 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7407    a signed addition of the two arguments, and indicate whether an overflow
7408    occurred during the signed summation.</p>
7409
7410 <h5>Arguments:</h5>
7411 <p>The arguments (%a and %b) and the first element of the result structure may
7412    be of integer types of any bit width, but they must have the same bit
7413    width. The second element of the result structure must be of
7414    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7415    undergo signed addition.</p>
7416
7417 <h5>Semantics:</h5>
7418 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7419    a signed addition of the two variables. They return a structure &mdash; the
7420    first element of which is the signed summation, and the second element of
7421    which is a bit specifying if the signed summation resulted in an
7422    overflow.</p>
7423
7424 <h5>Examples:</h5>
7425 <pre>
7426   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7427   %sum = extractvalue {i32, i1} %res, 0
7428   %obit = extractvalue {i32, i1} %res, 1
7429   br i1 %obit, label %overflow, label %normal
7430 </pre>
7431
7432 </div>
7433
7434 <!-- _______________________________________________________________________ -->
7435 <h4>
7436   <a name="int_uadd_overflow">
7437     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7438   </a>
7439 </h4>
7440
7441 <div>
7442
7443 <h5>Syntax:</h5>
7444 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7445    on any integer bit width.</p>
7446
7447 <pre>
7448   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7449   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7450   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7451 </pre>
7452
7453 <h5>Overview:</h5>
7454 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7455    an unsigned addition of the two arguments, and indicate whether a carry
7456    occurred during the unsigned summation.</p>
7457
7458 <h5>Arguments:</h5>
7459 <p>The arguments (%a and %b) and the first element of the result structure may
7460    be of integer types of any bit width, but they must have the same bit
7461    width. The second element of the result structure must be of
7462    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7463    undergo unsigned addition.</p>
7464
7465 <h5>Semantics:</h5>
7466 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7467    an unsigned addition of the two arguments. They return a structure &mdash;
7468    the first element of which is the sum, and the second element of which is a
7469    bit specifying if the unsigned summation resulted in a carry.</p>
7470
7471 <h5>Examples:</h5>
7472 <pre>
7473   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7474   %sum = extractvalue {i32, i1} %res, 0
7475   %obit = extractvalue {i32, i1} %res, 1
7476   br i1 %obit, label %carry, label %normal
7477 </pre>
7478
7479 </div>
7480
7481 <!-- _______________________________________________________________________ -->
7482 <h4>
7483   <a name="int_ssub_overflow">
7484     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7485   </a>
7486 </h4>
7487
7488 <div>
7489
7490 <h5>Syntax:</h5>
7491 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7492    on any integer bit width.</p>
7493
7494 <pre>
7495   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7496   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7497   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7498 </pre>
7499
7500 <h5>Overview:</h5>
7501 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7502    a signed subtraction of the two arguments, and indicate whether an overflow
7503    occurred during the signed subtraction.</p>
7504
7505 <h5>Arguments:</h5>
7506 <p>The arguments (%a and %b) and the first element of the result structure may
7507    be of integer types of any bit width, but they must have the same bit
7508    width. The second element of the result structure must be of
7509    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7510    undergo signed subtraction.</p>
7511
7512 <h5>Semantics:</h5>
7513 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7514    a signed subtraction of the two arguments. They return a structure &mdash;
7515    the first element of which is the subtraction, and the second element of
7516    which is a bit specifying if the signed subtraction resulted in an
7517    overflow.</p>
7518
7519 <h5>Examples:</h5>
7520 <pre>
7521   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7522   %sum = extractvalue {i32, i1} %res, 0
7523   %obit = extractvalue {i32, i1} %res, 1
7524   br i1 %obit, label %overflow, label %normal
7525 </pre>
7526
7527 </div>
7528
7529 <!-- _______________________________________________________________________ -->
7530 <h4>
7531   <a name="int_usub_overflow">
7532     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7533   </a>
7534 </h4>
7535
7536 <div>
7537
7538 <h5>Syntax:</h5>
7539 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7540    on any integer bit width.</p>
7541
7542 <pre>
7543   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7544   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7545   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7546 </pre>
7547
7548 <h5>Overview:</h5>
7549 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7550    an unsigned subtraction of the two arguments, and indicate whether an
7551    overflow occurred during the unsigned subtraction.</p>
7552
7553 <h5>Arguments:</h5>
7554 <p>The arguments (%a and %b) and the first element of the result structure may
7555    be of integer types of any bit width, but they must have the same bit
7556    width. The second element of the result structure must be of
7557    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7558    undergo unsigned subtraction.</p>
7559
7560 <h5>Semantics:</h5>
7561 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7562    an unsigned subtraction of the two arguments. They return a structure &mdash;
7563    the first element of which is the subtraction, and the second element of
7564    which is a bit specifying if the unsigned subtraction resulted in an
7565    overflow.</p>
7566
7567 <h5>Examples:</h5>
7568 <pre>
7569   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7570   %sum = extractvalue {i32, i1} %res, 0
7571   %obit = extractvalue {i32, i1} %res, 1
7572   br i1 %obit, label %overflow, label %normal
7573 </pre>
7574
7575 </div>
7576
7577 <!-- _______________________________________________________________________ -->
7578 <h4>
7579   <a name="int_smul_overflow">
7580     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7581   </a>
7582 </h4>
7583
7584 <div>
7585
7586 <h5>Syntax:</h5>
7587 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7588    on any integer bit width.</p>
7589
7590 <pre>
7591   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7592   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7593   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7594 </pre>
7595
7596 <h5>Overview:</h5>
7597
7598 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7599    a signed multiplication of the two arguments, and indicate whether an
7600    overflow occurred during the signed multiplication.</p>
7601
7602 <h5>Arguments:</h5>
7603 <p>The arguments (%a and %b) and the first element of the result structure may
7604    be of integer types of any bit width, but they must have the same bit
7605    width. The second element of the result structure must be of
7606    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7607    undergo signed multiplication.</p>
7608
7609 <h5>Semantics:</h5>
7610 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7611    a signed multiplication of the two arguments. They return a structure &mdash;
7612    the first element of which is the multiplication, and the second element of
7613    which is a bit specifying if the signed multiplication resulted in an
7614    overflow.</p>
7615
7616 <h5>Examples:</h5>
7617 <pre>
7618   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7619   %sum = extractvalue {i32, i1} %res, 0
7620   %obit = extractvalue {i32, i1} %res, 1
7621   br i1 %obit, label %overflow, label %normal
7622 </pre>
7623
7624 </div>
7625
7626 <!-- _______________________________________________________________________ -->
7627 <h4>
7628   <a name="int_umul_overflow">
7629     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7630   </a>
7631 </h4>
7632
7633 <div>
7634
7635 <h5>Syntax:</h5>
7636 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7637    on any integer bit width.</p>
7638
7639 <pre>
7640   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7641   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7642   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7643 </pre>
7644
7645 <h5>Overview:</h5>
7646 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7647    a unsigned multiplication of the two arguments, and indicate whether an
7648    overflow occurred during the unsigned multiplication.</p>
7649
7650 <h5>Arguments:</h5>
7651 <p>The arguments (%a and %b) and the first element of the result structure may
7652    be of integer types of any bit width, but they must have the same bit
7653    width. The second element of the result structure must be of
7654    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7655    undergo unsigned multiplication.</p>
7656
7657 <h5>Semantics:</h5>
7658 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7659    an unsigned multiplication of the two arguments. They return a structure
7660    &mdash; the first element of which is the multiplication, and the second
7661    element of which is a bit specifying if the unsigned multiplication resulted
7662    in an overflow.</p>
7663
7664 <h5>Examples:</h5>
7665 <pre>
7666   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7667   %sum = extractvalue {i32, i1} %res, 0
7668   %obit = extractvalue {i32, i1} %res, 1
7669   br i1 %obit, label %overflow, label %normal
7670 </pre>
7671
7672 </div>
7673
7674 </div>
7675
7676 <!-- ======================================================================= -->
7677 <h3>
7678   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7679 </h3>
7680
7681 <div>
7682
7683 <p>Half precision floating point is a storage-only format. This means that it is
7684    a dense encoding (in memory) but does not support computation in the
7685    format.</p>
7686
7687 <p>This means that code must first load the half-precision floating point
7688    value as an i16, then convert it to float with <a
7689    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7690    Computation can then be performed on the float value (including extending to
7691    double etc).  To store the value back to memory, it is first converted to
7692    float if needed, then converted to i16 with
7693    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7694    storing as an i16 value.</p>
7695
7696 <!-- _______________________________________________________________________ -->
7697 <h4>
7698   <a name="int_convert_to_fp16">
7699     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7700   </a>
7701 </h4>
7702
7703 <div>
7704
7705 <h5>Syntax:</h5>
7706 <pre>
7707   declare i16 @llvm.convert.to.fp16(f32 %a)
7708 </pre>
7709
7710 <h5>Overview:</h5>
7711 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7712    a conversion from single precision floating point format to half precision
7713    floating point format.</p>
7714
7715 <h5>Arguments:</h5>
7716 <p>The intrinsic function contains single argument - the value to be
7717    converted.</p>
7718
7719 <h5>Semantics:</h5>
7720 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7721    a conversion from single precision floating point format to half precision
7722    floating point format. The return value is an <tt>i16</tt> which
7723    contains the converted number.</p>
7724
7725 <h5>Examples:</h5>
7726 <pre>
7727   %res = call i16 @llvm.convert.to.fp16(f32 %a)
7728   store i16 %res, i16* @x, align 2
7729 </pre>
7730
7731 </div>
7732
7733 <!-- _______________________________________________________________________ -->
7734 <h4>
7735   <a name="int_convert_from_fp16">
7736     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
7737   </a>
7738 </h4>
7739
7740 <div>
7741
7742 <h5>Syntax:</h5>
7743 <pre>
7744   declare f32 @llvm.convert.from.fp16(i16 %a)
7745 </pre>
7746
7747 <h5>Overview:</h5>
7748 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
7749    a conversion from half precision floating point format to single precision
7750    floating point format.</p>
7751
7752 <h5>Arguments:</h5>
7753 <p>The intrinsic function contains single argument - the value to be
7754    converted.</p>
7755
7756 <h5>Semantics:</h5>
7757 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
7758    conversion from half single precision floating point format to single
7759    precision floating point format. The input half-float value is represented by
7760    an <tt>i16</tt> value.</p>
7761
7762 <h5>Examples:</h5>
7763 <pre>
7764   %a = load i16* @x, align 2
7765   %res = call f32 @llvm.convert.from.fp16(i16 %a)
7766 </pre>
7767
7768 </div>
7769
7770 </div>
7771
7772 <!-- ======================================================================= -->
7773 <h3>
7774   <a name="int_debugger">Debugger Intrinsics</a>
7775 </h3>
7776
7777 <div>
7778
7779 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
7780    prefix), are described in
7781    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
7782    Level Debugging</a> document.</p>
7783
7784 </div>
7785
7786 <!-- ======================================================================= -->
7787 <h3>
7788   <a name="int_eh">Exception Handling Intrinsics</a>
7789 </h3>
7790
7791 <div>
7792
7793 <p>The LLVM exception handling intrinsics (which all start with
7794    <tt>llvm.eh.</tt> prefix), are described in
7795    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
7796    Handling</a> document.</p>
7797
7798 </div>
7799
7800 <!-- ======================================================================= -->
7801 <h3>
7802   <a name="int_trampoline">Trampoline Intrinsics</a>
7803 </h3>
7804
7805 <div>
7806
7807 <p>These intrinsics make it possible to excise one parameter, marked with
7808    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
7809    The result is a callable
7810    function pointer lacking the nest parameter - the caller does not need to
7811    provide a value for it.  Instead, the value to use is stored in advance in a
7812    "trampoline", a block of memory usually allocated on the stack, which also
7813    contains code to splice the nest value into the argument list.  This is used
7814    to implement the GCC nested function address extension.</p>
7815
7816 <p>For example, if the function is
7817    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
7818    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
7819    follows:</p>
7820
7821 <pre class="doc_code">
7822   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
7823   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
7824   call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8*, i32, i32)* @f to i8*), i8* %nval)
7825   %p = call i8* @llvm.adjust.trampoline(i8* %tramp1)
7826   %fp = bitcast i8* %p to i32 (i32, i32)*
7827 </pre>
7828
7829 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
7830    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
7831
7832 <!-- _______________________________________________________________________ -->
7833 <h4>
7834   <a name="int_it">
7835     '<tt>llvm.init.trampoline</tt>' Intrinsic
7836   </a>
7837 </h4>
7838
7839 <div>
7840
7841 <h5>Syntax:</h5>
7842 <pre>
7843   declare void @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7844 </pre>
7845
7846 <h5>Overview:</h5>
7847 <p>This fills the memory pointed to by <tt>tramp</tt> with executable code,
7848    turning it into a trampoline.</p>
7849
7850 <h5>Arguments:</h5>
7851 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7852    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7853    sufficiently aligned block of memory; this memory is written to by the
7854    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7855    currently provides no portable way of determining them, so a front-end that
7856    generates this intrinsic needs to have some target-specific knowledge.
7857    The <tt>func</tt> argument must hold a function bitcast to
7858    an <tt>i8*</tt>.</p>
7859
7860 <h5>Semantics:</h5>
7861 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7862    dependent code, turning it into a function.  Then <tt>tramp</tt> needs to be
7863    passed to <a href="#int_at">llvm.adjust.trampoline</a> to get a pointer
7864    which can be <a href="#int_trampoline">bitcast (to a new function) and
7865    called</a>.  The new function's signature is the same as that of
7866    <tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
7867    removed.  At most one such <tt>nest</tt> argument is allowed, and it must be of
7868    pointer type.  Calling the new function is equivalent to calling <tt>func</tt>
7869    with the same argument list, but with <tt>nval</tt> used for the missing
7870    <tt>nest</tt> argument.  If, after calling <tt>llvm.init.trampoline</tt>, the
7871    memory pointed to by <tt>tramp</tt> is modified, then the effect of any later call
7872    to the returned function pointer is undefined.</p>
7873 </div>
7874
7875 <!-- _______________________________________________________________________ -->
7876 <h4>
7877   <a name="int_at">
7878     '<tt>llvm.adjust.trampoline</tt>' Intrinsic
7879   </a>
7880 </h4>
7881
7882 <div>
7883
7884 <h5>Syntax:</h5>
7885 <pre>
7886   declare i8* @llvm.adjust.trampoline(i8* &lt;tramp&gt;)
7887 </pre>
7888
7889 <h5>Overview:</h5>
7890 <p>This performs any required machine-specific adjustment to the address of a
7891    trampoline (passed as <tt>tramp</tt>).</p>
7892
7893 <h5>Arguments:</h5>
7894 <p><tt>tramp</tt> must point to a block of memory which already has trampoline code
7895    filled in by a previous call to <a href="#int_it"><tt>llvm.init.trampoline</tt>
7896    </a>.</p>
7897
7898 <h5>Semantics:</h5>
7899 <p>On some architectures the address of the code to be executed needs to be
7900    different to the address where the trampoline is actually stored.  This
7901    intrinsic returns the executable address corresponding to <tt>tramp</tt>
7902    after performing the required machine specific adjustments.
7903    The pointer returned can then be <a href="#int_trampoline"> bitcast and
7904    executed</a>.
7905 </p>
7906
7907 </div>
7908
7909 </div>
7910
7911 <!-- ======================================================================= -->
7912 <h3>
7913   <a name="int_memorymarkers">Memory Use Markers</a>
7914 </h3>
7915
7916 <div>
7917
7918 <p>This class of intrinsics exists to information about the lifetime of memory
7919    objects and ranges where variables are immutable.</p>
7920
7921 <!-- _______________________________________________________________________ -->
7922 <h4>
7923   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7924 </h4>
7925
7926 <div>
7927
7928 <h5>Syntax:</h5>
7929 <pre>
7930   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7931 </pre>
7932
7933 <h5>Overview:</h5>
7934 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7935    object's lifetime.</p>
7936
7937 <h5>Arguments:</h5>
7938 <p>The first argument is a constant integer representing the size of the
7939    object, or -1 if it is variable sized.  The second argument is a pointer to
7940    the object.</p>
7941
7942 <h5>Semantics:</h5>
7943 <p>This intrinsic indicates that before this point in the code, the value of the
7944    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7945    never be used and has an undefined value.  A load from the pointer that
7946    precedes this intrinsic can be replaced with
7947    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7948
7949 </div>
7950
7951 <!-- _______________________________________________________________________ -->
7952 <h4>
7953   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7954 </h4>
7955
7956 <div>
7957
7958 <h5>Syntax:</h5>
7959 <pre>
7960   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7961 </pre>
7962
7963 <h5>Overview:</h5>
7964 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7965    object's lifetime.</p>
7966
7967 <h5>Arguments:</h5>
7968 <p>The first argument is a constant integer representing the size of the
7969    object, or -1 if it is variable sized.  The second argument is a pointer to
7970    the object.</p>
7971
7972 <h5>Semantics:</h5>
7973 <p>This intrinsic indicates that after this point in the code, the value of the
7974    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7975    never be used and has an undefined value.  Any stores into the memory object
7976    following this intrinsic may be removed as dead.
7977
7978 </div>
7979
7980 <!-- _______________________________________________________________________ -->
7981 <h4>
7982   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7983 </h4>
7984
7985 <div>
7986
7987 <h5>Syntax:</h5>
7988 <pre>
7989   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7990 </pre>
7991
7992 <h5>Overview:</h5>
7993 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7994    a memory object will not change.</p>
7995
7996 <h5>Arguments:</h5>
7997 <p>The first argument is a constant integer representing the size of the
7998    object, or -1 if it is variable sized.  The second argument is a pointer to
7999    the object.</p>
8000
8001 <h5>Semantics:</h5>
8002 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8003    the return value, the referenced memory location is constant and
8004    unchanging.</p>
8005
8006 </div>
8007
8008 <!-- _______________________________________________________________________ -->
8009 <h4>
8010   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8011 </h4>
8012
8013 <div>
8014
8015 <h5>Syntax:</h5>
8016 <pre>
8017   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8018 </pre>
8019
8020 <h5>Overview:</h5>
8021 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8022    a memory object are mutable.</p>
8023
8024 <h5>Arguments:</h5>
8025 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8026    The second argument is a constant integer representing the size of the
8027    object, or -1 if it is variable sized and the third argument is a pointer
8028    to the object.</p>
8029
8030 <h5>Semantics:</h5>
8031 <p>This intrinsic indicates that the memory is mutable again.</p>
8032
8033 </div>
8034
8035 </div>
8036
8037 <!-- ======================================================================= -->
8038 <h3>
8039   <a name="int_general">General Intrinsics</a>
8040 </h3>
8041
8042 <div>
8043
8044 <p>This class of intrinsics is designed to be generic and has no specific
8045    purpose.</p>
8046
8047 <!-- _______________________________________________________________________ -->
8048 <h4>
8049   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8050 </h4>
8051
8052 <div>
8053
8054 <h5>Syntax:</h5>
8055 <pre>
8056   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8057 </pre>
8058
8059 <h5>Overview:</h5>
8060 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8061
8062 <h5>Arguments:</h5>
8063 <p>The first argument is a pointer to a value, the second is a pointer to a
8064    global string, the third is a pointer to a global string which is the source
8065    file name, and the last argument is the line number.</p>
8066
8067 <h5>Semantics:</h5>
8068 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8069    This can be useful for special purpose optimizations that want to look for
8070    these annotations.  These have no other defined use; they are ignored by code
8071    generation and optimization.</p>
8072
8073 </div>
8074
8075 <!-- _______________________________________________________________________ -->
8076 <h4>
8077   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8078 </h4>
8079
8080 <div>
8081
8082 <h5>Syntax:</h5>
8083 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8084    any integer bit width.</p>
8085
8086 <pre>
8087   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8088   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8089   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8090   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8091   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8092 </pre>
8093
8094 <h5>Overview:</h5>
8095 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8096
8097 <h5>Arguments:</h5>
8098 <p>The first argument is an integer value (result of some expression), the
8099    second is a pointer to a global string, the third is a pointer to a global
8100    string which is the source file name, and the last argument is the line
8101    number.  It returns the value of the first argument.</p>
8102
8103 <h5>Semantics:</h5>
8104 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8105    arbitrary strings.  This can be useful for special purpose optimizations that
8106    want to look for these annotations.  These have no other defined use; they
8107    are ignored by code generation and optimization.</p>
8108
8109 </div>
8110
8111 <!-- _______________________________________________________________________ -->
8112 <h4>
8113   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8114 </h4>
8115
8116 <div>
8117
8118 <h5>Syntax:</h5>
8119 <pre>
8120   declare void @llvm.trap()
8121 </pre>
8122
8123 <h5>Overview:</h5>
8124 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8125
8126 <h5>Arguments:</h5>
8127 <p>None.</p>
8128
8129 <h5>Semantics:</h5>
8130 <p>This intrinsics is lowered to the target dependent trap instruction. If the
8131    target does not have a trap instruction, this intrinsic will be lowered to
8132    the call of the <tt>abort()</tt> function.</p>
8133
8134 </div>
8135
8136 <!-- _______________________________________________________________________ -->
8137 <h4>
8138   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8139 </h4>
8140
8141 <div>
8142
8143 <h5>Syntax:</h5>
8144 <pre>
8145   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8146 </pre>
8147
8148 <h5>Overview:</h5>
8149 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8150    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8151    ensure that it is placed on the stack before local variables.</p>
8152
8153 <h5>Arguments:</h5>
8154 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8155    arguments. The first argument is the value loaded from the stack
8156    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8157    that has enough space to hold the value of the guard.</p>
8158
8159 <h5>Semantics:</h5>
8160 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8161    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8162    stack. This is to ensure that if a local variable on the stack is
8163    overwritten, it will destroy the value of the guard. When the function exits,
8164    the guard on the stack is checked against the original guard. If they are
8165    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8166    function.</p>
8167
8168 </div>
8169
8170 <!-- _______________________________________________________________________ -->
8171 <h4>
8172   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8173 </h4>
8174
8175 <div>
8176
8177 <h5>Syntax:</h5>
8178 <pre>
8179   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
8180   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
8181 </pre>
8182
8183 <h5>Overview:</h5>
8184 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8185    the optimizers to determine at compile time whether a) an operation (like
8186    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8187    runtime check for overflow isn't necessary. An object in this context means
8188    an allocation of a specific class, structure, array, or other object.</p>
8189
8190 <h5>Arguments:</h5>
8191 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8192    argument is a pointer to or into the <tt>object</tt>. The second argument
8193    is a boolean 0 or 1. This argument determines whether you want the
8194    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
8195    1, variables are not allowed.</p>
8196
8197 <h5>Semantics:</h5>
8198 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
8199    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
8200    depending on the <tt>type</tt> argument, if the size cannot be determined at
8201    compile time.</p>
8202
8203 </div>
8204
8205 </div>
8206
8207 </div>
8208
8209 <!-- *********************************************************************** -->
8210 <hr>
8211 <address>
8212   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8213   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8214   <a href="http://validator.w3.org/check/referer"><img
8215   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8216
8217   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8218   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8219   Last modified: $Date$
8220 </address>
8221
8222 </body>
8223 </html>