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   volatile store 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   volatile store 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   volatile store 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   volatile store 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 "\xx" where "xx" is
2893    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2894
2895 <p>Metadata nodes are represented with notation similar to structure constants
2896    (a comma separated list of elements, surrounded by braces and preceded by an
2897    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2898    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2899
2900 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2901    metadata nodes, which can be looked up in the module symbol table. For
2902    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2903
2904 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2905    function is using two metadata arguments.</p>
2906
2907 <div class="doc_code">
2908 <pre>
2909 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2910 </pre>
2911 </div>
2912
2913 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2914    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2915
2916 <div class="doc_code">
2917 <pre>
2918 %indvar.next = add i64 %indvar, 1, !dbg !21
2919 </pre>
2920 </div>
2921
2922 <p>More information about specific metadata nodes recognized by the optimizers
2923    and code generator is found below.</p>
2924
2925 <h4>
2926   <a name="tbaa">'<tt>tbaa</tt>' Metadata</a>
2927 </h4>
2928
2929 <div>
2930
2931 <p>In LLVM IR, memory does not have types, so LLVM's own type system is not
2932    suitable for doing TBAA. Instead, metadata is added to the IR to describe
2933    a type system of a higher level language. This can be used to implement
2934    typical C/C++ TBAA, but it can also be used to implement custom alias
2935    analysis behavior for other languages.</p>
2936
2937 <p>The current metadata format is very simple. TBAA metadata nodes have up to
2938    three fields, e.g.:</p>
2939
2940 <div class="doc_code">
2941 <pre>
2942 !0 = metadata !{ metadata !"an example type tree" }
2943 !1 = metadata !{ metadata !"int", metadata !0 }
2944 !2 = metadata !{ metadata !"float", metadata !0 }
2945 !3 = metadata !{ metadata !"const float", metadata !2, i64 1 }
2946 </pre>
2947 </div>
2948
2949 <p>The first field is an identity field. It can be any value, usually
2950    a metadata string, which uniquely identifies the type. The most important
2951    name in the tree is the name of the root node. Two trees with
2952    different root node names are entirely disjoint, even if they
2953    have leaves with common names.</p>
2954
2955 <p>The second field identifies the type's parent node in the tree, or
2956    is null or omitted for a root node. A type is considered to alias
2957    all of its descendants and all of its ancestors in the tree. Also,
2958    a type is considered to alias all types in other trees, so that
2959    bitcode produced from multiple front-ends is handled conservatively.</p>
2960
2961 <p>If the third field is present, it's an integer which if equal to 1
2962    indicates that the type is "constant" (meaning
2963    <tt>pointsToConstantMemory</tt> should return true; see
2964    <a href="AliasAnalysis.html#OtherItfs">other useful
2965    <tt>AliasAnalysis</tt> methods</a>).</p>
2966
2967 </div>
2968
2969 <h4>
2970   <a name="fpaccuracy">'<tt>fpaccuracy</tt>' Metadata</a>
2971 </h4>
2972
2973 <div>
2974
2975 <p><tt>fpaccuracy</tt> metadata may be attached to any instruction of floating
2976    point type.  It expresses the maximum relative error of the result of
2977    that instruction, in ULPs. ULP is defined as follows:</p>
2978
2979 <blockquote>
2980
2981 <p>If <tt>x</tt> is a real number that lies between two finite consecutive
2982    floating-point numbers <tt>a</tt> and <tt>b</tt>, without being equal to one
2983    of them, then <tt>ulp(x) = |b - a|</tt>, otherwise <tt>ulp(x)</tt> is the
2984    distance between the two non-equal finite floating-point numbers nearest
2985    <tt>x</tt>. Moreover, <tt>ulp(NaN)</tt> is <tt>NaN</tt>.</p>
2986
2987 </blockquote>
2988
2989 <p>The maximum relative error may be any rational number.  The metadata node
2990    shall consist of a pair of unsigned integers respectively representing
2991    the numerator and denominator.  For example, 2.5 ULP:</p>
2992
2993 <div class="doc_code">
2994 <pre>
2995 !0 = metadata !{ i32 5, i32 2 }
2996 </pre>
2997 </div>
2998
2999 </div>
3000
3001 </div>
3002
3003 </div>
3004
3005 <!-- *********************************************************************** -->
3006 <h2>
3007   <a name="intrinsic_globals">Intrinsic Global Variables</a>
3008 </h2>
3009 <!-- *********************************************************************** -->
3010 <div>
3011 <p>LLVM has a number of "magic" global variables that contain data that affect
3012 code generation or other IR semantics.  These are documented here.  All globals
3013 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
3014 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
3015 by LLVM.</p>
3016
3017 <!-- ======================================================================= -->
3018 <h3>
3019 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
3020 </h3>
3021
3022 <div>
3023
3024 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
3025 href="#linkage_appending">appending linkage</a>.  This array contains a list of
3026 pointers to global variables and functions which may optionally have a pointer
3027 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
3028
3029 <div class="doc_code">
3030 <pre>
3031 @X = global i8 4
3032 @Y = global i32 123
3033
3034 @llvm.used = appending global [2 x i8*] [
3035    i8* @X,
3036    i8* bitcast (i32* @Y to i8*)
3037 ], section "llvm.metadata"
3038 </pre>
3039 </div>
3040
3041 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
3042    compiler, assembler, and linker are required to treat the symbol as if there
3043    is a reference to the global that it cannot see.  For example, if a variable
3044    has internal linkage and no references other than that from
3045    the <tt>@llvm.used</tt> list, it cannot be deleted.  This is commonly used to
3046    represent references from inline asms and other things the compiler cannot
3047    "see", and corresponds to "<tt>attribute((used))</tt>" in GNU C.</p>
3048
3049 <p>On some targets, the code generator must emit a directive to the assembler or
3050    object file to prevent the assembler and linker from molesting the
3051    symbol.</p>
3052
3053 </div>
3054
3055 <!-- ======================================================================= -->
3056 <h3>
3057   <a name="intg_compiler_used">
3058     The '<tt>llvm.compiler.used</tt>' Global Variable
3059   </a>
3060 </h3>
3061
3062 <div>
3063
3064 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
3065    <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
3066    touching the symbol.  On targets that support it, this allows an intelligent
3067    linker to optimize references to the symbol without being impeded as it would
3068    be by <tt>@llvm.used</tt>.</p>
3069
3070 <p>This is a rare construct that should only be used in rare circumstances, and
3071    should not be exposed to source languages.</p>
3072
3073 </div>
3074
3075 <!-- ======================================================================= -->
3076 <h3>
3077 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
3078 </h3>
3079
3080 <div>
3081
3082 <div class="doc_code">
3083 <pre>
3084 %0 = type { i32, void ()* }
3085 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
3086 </pre>
3087 </div>
3088
3089 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor
3090    functions and associated priorities.  The functions referenced by this array
3091    will be called in ascending order of priority (i.e. lowest first) when the
3092    module is loaded.  The order of functions with the same priority is not
3093    defined.</p>
3094
3095 </div>
3096
3097 <!-- ======================================================================= -->
3098 <h3>
3099 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
3100 </h3>
3101
3102 <div>
3103
3104 <div class="doc_code">
3105 <pre>
3106 %0 = type { i32, void ()* }
3107 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
3108 </pre>
3109 </div>
3110
3111 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions
3112    and associated priorities.  The functions referenced by this array will be
3113    called in descending order of priority (i.e. highest first) when the module
3114    is loaded.  The order of functions with the same priority is not defined.</p>
3115
3116 </div>
3117
3118 </div>
3119
3120 <!-- *********************************************************************** -->
3121 <h2><a name="instref">Instruction Reference</a></h2>
3122 <!-- *********************************************************************** -->
3123
3124 <div>
3125
3126 <p>The LLVM instruction set consists of several different classifications of
3127    instructions: <a href="#terminators">terminator
3128    instructions</a>, <a href="#binaryops">binary instructions</a>,
3129    <a href="#bitwiseops">bitwise binary instructions</a>,
3130    <a href="#memoryops">memory instructions</a>, and
3131    <a href="#otherops">other instructions</a>.</p>
3132
3133 <!-- ======================================================================= -->
3134 <h3>
3135   <a name="terminators">Terminator Instructions</a>
3136 </h3>
3137
3138 <div>
3139
3140 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3141    in a program ends with a "Terminator" instruction, which indicates which
3142    block should be executed after the current block is finished. These
3143    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3144    control flow, not values (the one exception being the
3145    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3146
3147 <p>The terminator instructions are:
3148    '<a href="#i_ret"><tt>ret</tt></a>',
3149    '<a href="#i_br"><tt>br</tt></a>',
3150    '<a href="#i_switch"><tt>switch</tt></a>',
3151    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3152    '<a href="#i_invoke"><tt>invoke</tt></a>',
3153    '<a href="#i_unwind"><tt>unwind</tt></a>',
3154    '<a href="#i_resume"><tt>resume</tt></a>', and
3155    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3156
3157 <!-- _______________________________________________________________________ -->
3158 <h4>
3159   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3160 </h4>
3161
3162 <div>
3163
3164 <h5>Syntax:</h5>
3165 <pre>
3166   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3167   ret void                 <i>; Return from void function</i>
3168 </pre>
3169
3170 <h5>Overview:</h5>
3171 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3172    a value) from a function back to the caller.</p>
3173
3174 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3175    value and then causes control flow, and one that just causes control flow to
3176    occur.</p>
3177
3178 <h5>Arguments:</h5>
3179 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3180    return value. The type of the return value must be a
3181    '<a href="#t_firstclass">first class</a>' type.</p>
3182
3183 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3184    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3185    value or a return value with a type that does not match its type, or if it
3186    has a void return type and contains a '<tt>ret</tt>' instruction with a
3187    return value.</p>
3188
3189 <h5>Semantics:</h5>
3190 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3191    the calling function's context.  If the caller is a
3192    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3193    instruction after the call.  If the caller was an
3194    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3195    the beginning of the "normal" destination block.  If the instruction returns
3196    a value, that value shall set the call or invoke instruction's return
3197    value.</p>
3198
3199 <h5>Example:</h5>
3200 <pre>
3201   ret i32 5                       <i>; Return an integer value of 5</i>
3202   ret void                        <i>; Return from a void function</i>
3203   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3204 </pre>
3205
3206 </div>
3207 <!-- _______________________________________________________________________ -->
3208 <h4>
3209   <a name="i_br">'<tt>br</tt>' Instruction</a>
3210 </h4>
3211
3212 <div>
3213
3214 <h5>Syntax:</h5>
3215 <pre>
3216   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3217   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3218 </pre>
3219
3220 <h5>Overview:</h5>
3221 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3222    different basic block in the current function.  There are two forms of this
3223    instruction, corresponding to a conditional branch and an unconditional
3224    branch.</p>
3225
3226 <h5>Arguments:</h5>
3227 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3228    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3229    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3230    target.</p>
3231
3232 <h5>Semantics:</h5>
3233 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3234    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3235    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3236    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3237
3238 <h5>Example:</h5>
3239 <pre>
3240 Test:
3241   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3242   br i1 %cond, label %IfEqual, label %IfUnequal
3243 IfEqual:
3244   <a href="#i_ret">ret</a> i32 1
3245 IfUnequal:
3246   <a href="#i_ret">ret</a> i32 0
3247 </pre>
3248
3249 </div>
3250
3251 <!-- _______________________________________________________________________ -->
3252 <h4>
3253    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3254 </h4>
3255
3256 <div>
3257
3258 <h5>Syntax:</h5>
3259 <pre>
3260   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3261 </pre>
3262
3263 <h5>Overview:</h5>
3264 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3265    several different places.  It is a generalization of the '<tt>br</tt>'
3266    instruction, allowing a branch to occur to one of many possible
3267    destinations.</p>
3268
3269 <h5>Arguments:</h5>
3270 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3271    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3272    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3273    The table is not allowed to contain duplicate constant entries.</p>
3274
3275 <h5>Semantics:</h5>
3276 <p>The <tt>switch</tt> instruction specifies a table of values and
3277    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3278    is searched for the given value.  If the value is found, control flow is
3279    transferred to the corresponding destination; otherwise, control flow is
3280    transferred to the default destination.</p>
3281
3282 <h5>Implementation:</h5>
3283 <p>Depending on properties of the target machine and the particular
3284    <tt>switch</tt> instruction, this instruction may be code generated in
3285    different ways.  For example, it could be generated as a series of chained
3286    conditional branches or with a lookup table.</p>
3287
3288 <h5>Example:</h5>
3289 <pre>
3290  <i>; Emulate a conditional br instruction</i>
3291  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3292  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3293
3294  <i>; Emulate an unconditional br instruction</i>
3295  switch i32 0, label %dest [ ]
3296
3297  <i>; Implement a jump table:</i>
3298  switch i32 %val, label %otherwise [ i32 0, label %onzero
3299                                      i32 1, label %onone
3300                                      i32 2, label %ontwo ]
3301 </pre>
3302
3303 </div>
3304
3305
3306 <!-- _______________________________________________________________________ -->
3307 <h4>
3308    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3309 </h4>
3310
3311 <div>
3312
3313 <h5>Syntax:</h5>
3314 <pre>
3315   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3316 </pre>
3317
3318 <h5>Overview:</h5>
3319
3320 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3321    within the current function, whose address is specified by
3322    "<tt>address</tt>".  Address must be derived from a <a
3323    href="#blockaddress">blockaddress</a> constant.</p>
3324
3325 <h5>Arguments:</h5>
3326
3327 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3328    rest of the arguments indicate the full set of possible destinations that the
3329    address may point to.  Blocks are allowed to occur multiple times in the
3330    destination list, though this isn't particularly useful.</p>
3331
3332 <p>This destination list is required so that dataflow analysis has an accurate
3333    understanding of the CFG.</p>
3334
3335 <h5>Semantics:</h5>
3336
3337 <p>Control transfers to the block specified in the address argument.  All
3338    possible destination blocks must be listed in the label list, otherwise this
3339    instruction has undefined behavior.  This implies that jumps to labels
3340    defined in other functions have undefined behavior as well.</p>
3341
3342 <h5>Implementation:</h5>
3343
3344 <p>This is typically implemented with a jump through a register.</p>
3345
3346 <h5>Example:</h5>
3347 <pre>
3348  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3349 </pre>
3350
3351 </div>
3352
3353
3354 <!-- _______________________________________________________________________ -->
3355 <h4>
3356   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3357 </h4>
3358
3359 <div>
3360
3361 <h5>Syntax:</h5>
3362 <pre>
3363   &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>]
3364                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3365 </pre>
3366
3367 <h5>Overview:</h5>
3368 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3369    function, with the possibility of control flow transfer to either the
3370    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3371    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3372    control flow will return to the "normal" label.  If the callee (or any
3373    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3374    instruction, control is interrupted and continued at the dynamically nearest
3375    "exception" label.</p>
3376
3377 <p>The '<tt>exception</tt>' label is a
3378    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3379    exception. As such, '<tt>exception</tt>' label is required to have the
3380    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3381    the information about about the behavior of the program after unwinding
3382    happens, as its first non-PHI instruction. The restrictions on the
3383    "<tt>landingpad</tt>" instruction's tightly couples it to the
3384    "<tt>invoke</tt>" instruction, so that the important information contained
3385    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3386    code motion.</p>
3387
3388 <h5>Arguments:</h5>
3389 <p>This instruction requires several arguments:</p>
3390
3391 <ol>
3392   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3393       convention</a> the call should use.  If none is specified, the call
3394       defaults to using C calling conventions.</li>
3395
3396   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3397       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3398       '<tt>inreg</tt>' attributes are valid here.</li>
3399
3400   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3401       function value being invoked.  In most cases, this is a direct function
3402       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3403       off an arbitrary pointer to function value.</li>
3404
3405   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3406       function to be invoked. </li>
3407
3408   <li>'<tt>function args</tt>': argument list whose types match the function
3409       signature argument types and parameter attributes. All arguments must be
3410       of <a href="#t_firstclass">first class</a> type. If the function
3411       signature indicates the function accepts a variable number of arguments,
3412       the extra arguments can be specified.</li>
3413
3414   <li>'<tt>normal label</tt>': the label reached when the called function
3415       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3416
3417   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3418       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3419
3420   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3421       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3422       '<tt>readnone</tt>' attributes are valid here.</li>
3423 </ol>
3424
3425 <h5>Semantics:</h5>
3426 <p>This instruction is designed to operate as a standard
3427    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3428    primary difference is that it establishes an association with a label, which
3429    is used by the runtime library to unwind the stack.</p>
3430
3431 <p>This instruction is used in languages with destructors to ensure that proper
3432    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3433    exception.  Additionally, this is important for implementation of
3434    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3435
3436 <p>For the purposes of the SSA form, the definition of the value returned by the
3437    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3438    block to the "normal" label. If the callee unwinds then no return value is
3439    available.</p>
3440
3441 <p>Note that the code generator does not yet completely support unwind, and
3442 that the invoke/unwind semantics are likely to change in future versions.</p>
3443
3444 <h5>Example:</h5>
3445 <pre>
3446   %retval = invoke i32 @Test(i32 15) to label %Continue
3447               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3448   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3449               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3450 </pre>
3451
3452 </div>
3453
3454 <!-- _______________________________________________________________________ -->
3455
3456 <h4>
3457   <a name="i_unwind">'<tt>unwind</tt>' Instruction</a>
3458 </h4>
3459
3460 <div>
3461
3462 <h5>Syntax:</h5>
3463 <pre>
3464   unwind
3465 </pre>
3466
3467 <h5>Overview:</h5>
3468 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3469    at the first callee in the dynamic call stack which used
3470    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3471    This is primarily used to implement exception handling.</p>
3472
3473 <h5>Semantics:</h5>
3474 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3475    immediately halt.  The dynamic call stack is then searched for the
3476    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3477    Once found, execution continues at the "exceptional" destination block
3478    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3479    instruction in the dynamic call chain, undefined behavior results.</p>
3480
3481 <p>Note that the code generator does not yet completely support unwind, and
3482 that the invoke/unwind semantics are likely to change in future versions.</p>
3483
3484 </div>
3485
3486  <!-- _______________________________________________________________________ -->
3487
3488 <h4>
3489   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3490 </h4>
3491
3492 <div>
3493
3494 <h5>Syntax:</h5>
3495 <pre>
3496   resume &lt;type&gt; &lt;value&gt;
3497 </pre>
3498
3499 <h5>Overview:</h5>
3500 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3501    successors.</p>
3502
3503 <h5>Arguments:</h5>
3504 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3505    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3506    function.</p>
3507
3508 <h5>Semantics:</h5>
3509 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3510    (in-flight) exception whose unwinding was interrupted with
3511    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3512
3513 <h5>Example:</h5>
3514 <pre>
3515   resume { i8*, i32 } %exn
3516 </pre>
3517
3518 </div>
3519
3520 <!-- _______________________________________________________________________ -->
3521
3522 <h4>
3523   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3524 </h4>
3525
3526 <div>
3527
3528 <h5>Syntax:</h5>
3529 <pre>
3530   unreachable
3531 </pre>
3532
3533 <h5>Overview:</h5>
3534 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3535    instruction is used to inform the optimizer that a particular portion of the
3536    code is not reachable.  This can be used to indicate that the code after a
3537    no-return function cannot be reached, and other facts.</p>
3538
3539 <h5>Semantics:</h5>
3540 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3541
3542 </div>
3543
3544 </div>
3545
3546 <!-- ======================================================================= -->
3547 <h3>
3548   <a name="binaryops">Binary Operations</a>
3549 </h3>
3550
3551 <div>
3552
3553 <p>Binary operators are used to do most of the computation in a program.  They
3554    require two operands of the same type, execute an operation on them, and
3555    produce a single value.  The operands might represent multiple data, as is
3556    the case with the <a href="#t_vector">vector</a> data type.  The result value
3557    has the same type as its operands.</p>
3558
3559 <p>There are several different binary operators:</p>
3560
3561 <!-- _______________________________________________________________________ -->
3562 <h4>
3563   <a name="i_add">'<tt>add</tt>' Instruction</a>
3564 </h4>
3565
3566 <div>
3567
3568 <h5>Syntax:</h5>
3569 <pre>
3570   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3571   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3572   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3573   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3574 </pre>
3575
3576 <h5>Overview:</h5>
3577 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3578
3579 <h5>Arguments:</h5>
3580 <p>The two arguments to the '<tt>add</tt>' instruction must
3581    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3582    integer values. Both arguments must have identical types.</p>
3583
3584 <h5>Semantics:</h5>
3585 <p>The value produced is the integer sum of the two operands.</p>
3586
3587 <p>If the sum has unsigned overflow, the result returned is the mathematical
3588    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3589
3590 <p>Because LLVM integers use a two's complement representation, this instruction
3591    is appropriate for both signed and unsigned integers.</p>
3592
3593 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3594    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3595    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3596    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3597    respectively, occurs.</p>
3598
3599 <h5>Example:</h5>
3600 <pre>
3601   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3602 </pre>
3603
3604 </div>
3605
3606 <!-- _______________________________________________________________________ -->
3607 <h4>
3608   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3609 </h4>
3610
3611 <div>
3612
3613 <h5>Syntax:</h5>
3614 <pre>
3615   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3616 </pre>
3617
3618 <h5>Overview:</h5>
3619 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3620
3621 <h5>Arguments:</h5>
3622 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3623    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3624    floating point values. Both arguments must have identical types.</p>
3625
3626 <h5>Semantics:</h5>
3627 <p>The value produced is the floating point sum of the two operands.</p>
3628
3629 <h5>Example:</h5>
3630 <pre>
3631   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3632 </pre>
3633
3634 </div>
3635
3636 <!-- _______________________________________________________________________ -->
3637 <h4>
3638    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3639 </h4>
3640
3641 <div>
3642
3643 <h5>Syntax:</h5>
3644 <pre>
3645   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3646   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3647   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3648   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3649 </pre>
3650
3651 <h5>Overview:</h5>
3652 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3653    operands.</p>
3654
3655 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3656    '<tt>neg</tt>' instruction present in most other intermediate
3657    representations.</p>
3658
3659 <h5>Arguments:</h5>
3660 <p>The two arguments to the '<tt>sub</tt>' instruction must
3661    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3662    integer values.  Both arguments must have identical types.</p>
3663
3664 <h5>Semantics:</h5>
3665 <p>The value produced is the integer difference of the two operands.</p>
3666
3667 <p>If the difference has unsigned overflow, the result returned is the
3668    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3669    result.</p>
3670
3671 <p>Because LLVM integers use a two's complement representation, this instruction
3672    is appropriate for both signed and unsigned integers.</p>
3673
3674 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3675    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3676    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3677    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3678    respectively, occurs.</p>
3679
3680 <h5>Example:</h5>
3681 <pre>
3682   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3683   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3684 </pre>
3685
3686 </div>
3687
3688 <!-- _______________________________________________________________________ -->
3689 <h4>
3690    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3691 </h4>
3692
3693 <div>
3694
3695 <h5>Syntax:</h5>
3696 <pre>
3697   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3698 </pre>
3699
3700 <h5>Overview:</h5>
3701 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3702    operands.</p>
3703
3704 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3705    '<tt>fneg</tt>' instruction present in most other intermediate
3706    representations.</p>
3707
3708 <h5>Arguments:</h5>
3709 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3710    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3711    floating point values.  Both arguments must have identical types.</p>
3712
3713 <h5>Semantics:</h5>
3714 <p>The value produced is the floating point difference of the two operands.</p>
3715
3716 <h5>Example:</h5>
3717 <pre>
3718   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3719   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3720 </pre>
3721
3722 </div>
3723
3724 <!-- _______________________________________________________________________ -->
3725 <h4>
3726   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3727 </h4>
3728
3729 <div>
3730
3731 <h5>Syntax:</h5>
3732 <pre>
3733   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3734   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3735   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3736   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3737 </pre>
3738
3739 <h5>Overview:</h5>
3740 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3741
3742 <h5>Arguments:</h5>
3743 <p>The two arguments to the '<tt>mul</tt>' instruction must
3744    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3745    integer values.  Both arguments must have identical types.</p>
3746
3747 <h5>Semantics:</h5>
3748 <p>The value produced is the integer product of the two operands.</p>
3749
3750 <p>If the result of the multiplication has unsigned overflow, the result
3751    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3752    width of the result.</p>
3753
3754 <p>Because LLVM integers use a two's complement representation, and the result
3755    is the same width as the operands, this instruction returns the correct
3756    result for both signed and unsigned integers.  If a full product
3757    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3758    be sign-extended or zero-extended as appropriate to the width of the full
3759    product.</p>
3760
3761 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3762    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3763    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3764    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3765    respectively, occurs.</p>
3766
3767 <h5>Example:</h5>
3768 <pre>
3769   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3770 </pre>
3771
3772 </div>
3773
3774 <!-- _______________________________________________________________________ -->
3775 <h4>
3776   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3777 </h4>
3778
3779 <div>
3780
3781 <h5>Syntax:</h5>
3782 <pre>
3783   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3784 </pre>
3785
3786 <h5>Overview:</h5>
3787 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3788
3789 <h5>Arguments:</h5>
3790 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3791    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3792    floating point values.  Both arguments must have identical types.</p>
3793
3794 <h5>Semantics:</h5>
3795 <p>The value produced is the floating point product of the two operands.</p>
3796
3797 <h5>Example:</h5>
3798 <pre>
3799   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3800 </pre>
3801
3802 </div>
3803
3804 <!-- _______________________________________________________________________ -->
3805 <h4>
3806   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
3807 </h4>
3808
3809 <div>
3810
3811 <h5>Syntax:</h5>
3812 <pre>
3813   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3814   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3815 </pre>
3816
3817 <h5>Overview:</h5>
3818 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3819
3820 <h5>Arguments:</h5>
3821 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3822    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3823    values.  Both arguments must have identical types.</p>
3824
3825 <h5>Semantics:</h5>
3826 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3827
3828 <p>Note that unsigned integer division and signed integer division are distinct
3829    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3830
3831 <p>Division by zero leads to undefined behavior.</p>
3832
3833 <p>If the <tt>exact</tt> keyword is present, the result value of the
3834    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3835   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3836
3837
3838 <h5>Example:</h5>
3839 <pre>
3840   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3841 </pre>
3842
3843 </div>
3844
3845 <!-- _______________________________________________________________________ -->
3846 <h4>
3847   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
3848 </h4>
3849
3850 <div>
3851
3852 <h5>Syntax:</h5>
3853 <pre>
3854   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3855   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3856 </pre>
3857
3858 <h5>Overview:</h5>
3859 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3860
3861 <h5>Arguments:</h5>
3862 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3863    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3864    values.  Both arguments must have identical types.</p>
3865
3866 <h5>Semantics:</h5>
3867 <p>The value produced is the signed integer quotient of the two operands rounded
3868    towards zero.</p>
3869
3870 <p>Note that signed integer division and unsigned integer division are distinct
3871    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3872
3873 <p>Division by zero leads to undefined behavior. Overflow also leads to
3874    undefined behavior; this is a rare case, but can occur, for example, by doing
3875    a 32-bit division of -2147483648 by -1.</p>
3876
3877 <p>If the <tt>exact</tt> keyword is present, the result value of the
3878    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3879    be rounded.</p>
3880
3881 <h5>Example:</h5>
3882 <pre>
3883   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3884 </pre>
3885
3886 </div>
3887
3888 <!-- _______________________________________________________________________ -->
3889 <h4>
3890   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
3891 </h4>
3892
3893 <div>
3894
3895 <h5>Syntax:</h5>
3896 <pre>
3897   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3898 </pre>
3899
3900 <h5>Overview:</h5>
3901 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3902
3903 <h5>Arguments:</h5>
3904 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3905    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3906    floating point values.  Both arguments must have identical types.</p>
3907
3908 <h5>Semantics:</h5>
3909 <p>The value produced is the floating point quotient of the two operands.</p>
3910
3911 <h5>Example:</h5>
3912 <pre>
3913   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3914 </pre>
3915
3916 </div>
3917
3918 <!-- _______________________________________________________________________ -->
3919 <h4>
3920   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3921 </h4>
3922
3923 <div>
3924
3925 <h5>Syntax:</h5>
3926 <pre>
3927   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3928 </pre>
3929
3930 <h5>Overview:</h5>
3931 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3932    division of its two arguments.</p>
3933
3934 <h5>Arguments:</h5>
3935 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3936    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3937    values.  Both arguments must have identical types.</p>
3938
3939 <h5>Semantics:</h5>
3940 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3941    This instruction always performs an unsigned division to get the
3942    remainder.</p>
3943
3944 <p>Note that unsigned integer remainder and signed integer remainder are
3945    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3946
3947 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3948
3949 <h5>Example:</h5>
3950 <pre>
3951   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3952 </pre>
3953
3954 </div>
3955
3956 <!-- _______________________________________________________________________ -->
3957 <h4>
3958   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3959 </h4>
3960
3961 <div>
3962
3963 <h5>Syntax:</h5>
3964 <pre>
3965   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3966 </pre>
3967
3968 <h5>Overview:</h5>
3969 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3970    division of its two operands. This instruction can also take
3971    <a href="#t_vector">vector</a> versions of the values in which case the
3972    elements must be integers.</p>
3973
3974 <h5>Arguments:</h5>
3975 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3976    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3977    values.  Both arguments must have identical types.</p>
3978
3979 <h5>Semantics:</h5>
3980 <p>This instruction returns the <i>remainder</i> of a division (where the result
3981    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3982    <i>modulo</i> operator (where the result is either zero or has the same sign
3983    as the divisor, <tt>op2</tt>) of a value.
3984    For more information about the difference,
3985    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3986    Math Forum</a>. For a table of how this is implemented in various languages,
3987    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3988    Wikipedia: modulo operation</a>.</p>
3989
3990 <p>Note that signed integer remainder and unsigned integer remainder are
3991    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3992
3993 <p>Taking the remainder of a division by zero leads to undefined behavior.
3994    Overflow also leads to undefined behavior; this is a rare case, but can
3995    occur, for example, by taking the remainder of a 32-bit division of
3996    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3997    lets srem be implemented using instructions that return both the result of
3998    the division and the remainder.)</p>
3999
4000 <h5>Example:</h5>
4001 <pre>
4002   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4003 </pre>
4004
4005 </div>
4006
4007 <!-- _______________________________________________________________________ -->
4008 <h4>
4009   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
4010 </h4>
4011
4012 <div>
4013
4014 <h5>Syntax:</h5>
4015 <pre>
4016   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4017 </pre>
4018
4019 <h5>Overview:</h5>
4020 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
4021    its two operands.</p>
4022
4023 <h5>Arguments:</h5>
4024 <p>The two arguments to the '<tt>frem</tt>' instruction must be
4025    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4026    floating point values.  Both arguments must have identical types.</p>
4027
4028 <h5>Semantics:</h5>
4029 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
4030    has the same sign as the dividend.</p>
4031
4032 <h5>Example:</h5>
4033 <pre>
4034   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
4035 </pre>
4036
4037 </div>
4038
4039 </div>
4040
4041 <!-- ======================================================================= -->
4042 <h3>
4043   <a name="bitwiseops">Bitwise Binary Operations</a>
4044 </h3>
4045
4046 <div>
4047
4048 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
4049    program.  They are generally very efficient instructions and can commonly be
4050    strength reduced from other instructions.  They require two operands of the
4051    same type, execute an operation on them, and produce a single value.  The
4052    resulting value is the same type as its operands.</p>
4053
4054 <!-- _______________________________________________________________________ -->
4055 <h4>
4056   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
4057 </h4>
4058
4059 <div>
4060
4061 <h5>Syntax:</h5>
4062 <pre>
4063   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
4064   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4065   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4066   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4067 </pre>
4068
4069 <h5>Overview:</h5>
4070 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
4071    a specified number of bits.</p>
4072
4073 <h5>Arguments:</h5>
4074 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
4075     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
4076     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4077
4078 <h5>Semantics:</h5>
4079 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
4080    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
4081    is (statically or dynamically) negative or equal to or larger than the number
4082    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
4083    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4084    shift amount in <tt>op2</tt>.</p>
4085
4086 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
4087    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
4088    the <tt>nsw</tt> keyword is present, then the shift produces a
4089    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
4090    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
4091    they would if the shift were expressed as a mul instruction with the same
4092    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
4093
4094 <h5>Example:</h5>
4095 <pre>
4096   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
4097   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
4098   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
4099   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
4100   &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>
4101 </pre>
4102
4103 </div>
4104
4105 <!-- _______________________________________________________________________ -->
4106 <h4>
4107   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
4108 </h4>
4109
4110 <div>
4111
4112 <h5>Syntax:</h5>
4113 <pre>
4114   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4115   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4116 </pre>
4117
4118 <h5>Overview:</h5>
4119 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4120    operand shifted to the right a specified number of bits with zero fill.</p>
4121
4122 <h5>Arguments:</h5>
4123 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4124    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4125    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4126
4127 <h5>Semantics:</h5>
4128 <p>This instruction always performs a logical shift right operation. The most
4129    significant bits of the result will be filled with zero bits after the shift.
4130    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4131    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4132    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4133    shift amount in <tt>op2</tt>.</p>
4134
4135 <p>If the <tt>exact</tt> keyword is present, the result value of the
4136    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4137    shifted out are non-zero.</p>
4138
4139
4140 <h5>Example:</h5>
4141 <pre>
4142   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4143   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4144   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4145   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4146   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4147   &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>
4148 </pre>
4149
4150 </div>
4151
4152 <!-- _______________________________________________________________________ -->
4153 <h4>
4154   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4155 </h4>
4156
4157 <div>
4158
4159 <h5>Syntax:</h5>
4160 <pre>
4161   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4162   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4163 </pre>
4164
4165 <h5>Overview:</h5>
4166 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4167    operand shifted to the right a specified number of bits with sign
4168    extension.</p>
4169
4170 <h5>Arguments:</h5>
4171 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4172    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4173    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4174
4175 <h5>Semantics:</h5>
4176 <p>This instruction always performs an arithmetic shift right operation, The
4177    most significant bits of the result will be filled with the sign bit
4178    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4179    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4180    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4181    the corresponding shift amount in <tt>op2</tt>.</p>
4182
4183 <p>If the <tt>exact</tt> keyword is present, the result value of the
4184    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
4185    shifted out are non-zero.</p>
4186
4187 <h5>Example:</h5>
4188 <pre>
4189   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4190   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4191   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4192   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4193   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4194   &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>
4195 </pre>
4196
4197 </div>
4198
4199 <!-- _______________________________________________________________________ -->
4200 <h4>
4201   <a name="i_and">'<tt>and</tt>' Instruction</a>
4202 </h4>
4203
4204 <div>
4205
4206 <h5>Syntax:</h5>
4207 <pre>
4208   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4209 </pre>
4210
4211 <h5>Overview:</h5>
4212 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4213    operands.</p>
4214
4215 <h5>Arguments:</h5>
4216 <p>The two arguments to the '<tt>and</tt>' instruction must be
4217    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4218    values.  Both arguments must have identical types.</p>
4219
4220 <h5>Semantics:</h5>
4221 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4222
4223 <table border="1" cellspacing="0" cellpadding="4">
4224   <tbody>
4225     <tr>
4226       <td>In0</td>
4227       <td>In1</td>
4228       <td>Out</td>
4229     </tr>
4230     <tr>
4231       <td>0</td>
4232       <td>0</td>
4233       <td>0</td>
4234     </tr>
4235     <tr>
4236       <td>0</td>
4237       <td>1</td>
4238       <td>0</td>
4239     </tr>
4240     <tr>
4241       <td>1</td>
4242       <td>0</td>
4243       <td>0</td>
4244     </tr>
4245     <tr>
4246       <td>1</td>
4247       <td>1</td>
4248       <td>1</td>
4249     </tr>
4250   </tbody>
4251 </table>
4252
4253 <h5>Example:</h5>
4254 <pre>
4255   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4256   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4257   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4258 </pre>
4259 </div>
4260 <!-- _______________________________________________________________________ -->
4261 <h4>
4262   <a name="i_or">'<tt>or</tt>' Instruction</a>
4263 </h4>
4264
4265 <div>
4266
4267 <h5>Syntax:</h5>
4268 <pre>
4269   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4270 </pre>
4271
4272 <h5>Overview:</h5>
4273 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4274    two operands.</p>
4275
4276 <h5>Arguments:</h5>
4277 <p>The two arguments to the '<tt>or</tt>' instruction must be
4278    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4279    values.  Both arguments must have identical types.</p>
4280
4281 <h5>Semantics:</h5>
4282 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4283
4284 <table border="1" cellspacing="0" cellpadding="4">
4285   <tbody>
4286     <tr>
4287       <td>In0</td>
4288       <td>In1</td>
4289       <td>Out</td>
4290     </tr>
4291     <tr>
4292       <td>0</td>
4293       <td>0</td>
4294       <td>0</td>
4295     </tr>
4296     <tr>
4297       <td>0</td>
4298       <td>1</td>
4299       <td>1</td>
4300     </tr>
4301     <tr>
4302       <td>1</td>
4303       <td>0</td>
4304       <td>1</td>
4305     </tr>
4306     <tr>
4307       <td>1</td>
4308       <td>1</td>
4309       <td>1</td>
4310     </tr>
4311   </tbody>
4312 </table>
4313
4314 <h5>Example:</h5>
4315 <pre>
4316   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4317   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4318   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4319 </pre>
4320
4321 </div>
4322
4323 <!-- _______________________________________________________________________ -->
4324 <h4>
4325   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4326 </h4>
4327
4328 <div>
4329
4330 <h5>Syntax:</h5>
4331 <pre>
4332   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4333 </pre>
4334
4335 <h5>Overview:</h5>
4336 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4337    its two operands.  The <tt>xor</tt> is used to implement the "one's
4338    complement" operation, which is the "~" operator in C.</p>
4339
4340 <h5>Arguments:</h5>
4341 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4342    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4343    values.  Both arguments must have identical types.</p>
4344
4345 <h5>Semantics:</h5>
4346 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4347
4348 <table border="1" cellspacing="0" cellpadding="4">
4349   <tbody>
4350     <tr>
4351       <td>In0</td>
4352       <td>In1</td>
4353       <td>Out</td>
4354     </tr>
4355     <tr>
4356       <td>0</td>
4357       <td>0</td>
4358       <td>0</td>
4359     </tr>
4360     <tr>
4361       <td>0</td>
4362       <td>1</td>
4363       <td>1</td>
4364     </tr>
4365     <tr>
4366       <td>1</td>
4367       <td>0</td>
4368       <td>1</td>
4369     </tr>
4370     <tr>
4371       <td>1</td>
4372       <td>1</td>
4373       <td>0</td>
4374     </tr>
4375   </tbody>
4376 </table>
4377
4378 <h5>Example:</h5>
4379 <pre>
4380   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4381   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4382   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4383   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4384 </pre>
4385
4386 </div>
4387
4388 </div>
4389
4390 <!-- ======================================================================= -->
4391 <h3>
4392   <a name="vectorops">Vector Operations</a>
4393 </h3>
4394
4395 <div>
4396
4397 <p>LLVM supports several instructions to represent vector operations in a
4398    target-independent manner.  These instructions cover the element-access and
4399    vector-specific operations needed to process vectors effectively.  While LLVM
4400    does directly support these vector operations, many sophisticated algorithms
4401    will want to use target-specific intrinsics to take full advantage of a
4402    specific target.</p>
4403
4404 <!-- _______________________________________________________________________ -->
4405 <h4>
4406    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4407 </h4>
4408
4409 <div>
4410
4411 <h5>Syntax:</h5>
4412 <pre>
4413   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4414 </pre>
4415
4416 <h5>Overview:</h5>
4417 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4418    from a vector at a specified index.</p>
4419
4420
4421 <h5>Arguments:</h5>
4422 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4423    of <a href="#t_vector">vector</a> type.  The second operand is an index
4424    indicating the position from which to extract the element.  The index may be
4425    a variable.</p>
4426
4427 <h5>Semantics:</h5>
4428 <p>The result is a scalar of the same type as the element type of
4429    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4430    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4431    results are undefined.</p>
4432
4433 <h5>Example:</h5>
4434 <pre>
4435   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4436 </pre>
4437
4438 </div>
4439
4440 <!-- _______________________________________________________________________ -->
4441 <h4>
4442    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4443 </h4>
4444
4445 <div>
4446
4447 <h5>Syntax:</h5>
4448 <pre>
4449   &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>
4450 </pre>
4451
4452 <h5>Overview:</h5>
4453 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4454    vector at a specified index.</p>
4455
4456 <h5>Arguments:</h5>
4457 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4458    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4459    whose type must equal the element type of the first operand.  The third
4460    operand is an index indicating the position at which to insert the value.
4461    The index may be a variable.</p>
4462
4463 <h5>Semantics:</h5>
4464 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4465    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4466    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4467    results are undefined.</p>
4468
4469 <h5>Example:</h5>
4470 <pre>
4471   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4472 </pre>
4473
4474 </div>
4475
4476 <!-- _______________________________________________________________________ -->
4477 <h4>
4478    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4479 </h4>
4480
4481 <div>
4482
4483 <h5>Syntax:</h5>
4484 <pre>
4485   &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>
4486 </pre>
4487
4488 <h5>Overview:</h5>
4489 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4490    from two input vectors, returning a vector with the same element type as the
4491    input and length that is the same as the shuffle mask.</p>
4492
4493 <h5>Arguments:</h5>
4494 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4495    with types that match each other. The third argument is a shuffle mask whose
4496    element type is always 'i32'.  The result of the instruction is a vector
4497    whose length is the same as the shuffle mask and whose element type is the
4498    same as the element type of the first two operands.</p>
4499
4500 <p>The shuffle mask operand is required to be a constant vector with either
4501    constant integer or undef values.</p>
4502
4503 <h5>Semantics:</h5>
4504 <p>The elements of the two input vectors are numbered from left to right across
4505    both of the vectors.  The shuffle mask operand specifies, for each element of
4506    the result vector, which element of the two input vectors the result element
4507    gets.  The element selector may be undef (meaning "don't care") and the
4508    second operand may be undef if performing a shuffle from only one vector.</p>
4509
4510 <h5>Example:</h5>
4511 <pre>
4512   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4513                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4514   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4515                           &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.
4516   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4517                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4518   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4519                           &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>
4520 </pre>
4521
4522 </div>
4523
4524 </div>
4525
4526 <!-- ======================================================================= -->
4527 <h3>
4528   <a name="aggregateops">Aggregate Operations</a>
4529 </h3>
4530
4531 <div>
4532
4533 <p>LLVM supports several instructions for working with
4534   <a href="#t_aggregate">aggregate</a> values.</p>
4535
4536 <!-- _______________________________________________________________________ -->
4537 <h4>
4538    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4539 </h4>
4540
4541 <div>
4542
4543 <h5>Syntax:</h5>
4544 <pre>
4545   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4546 </pre>
4547
4548 <h5>Overview:</h5>
4549 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4550    from an <a href="#t_aggregate">aggregate</a> value.</p>
4551
4552 <h5>Arguments:</h5>
4553 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4554    of <a href="#t_struct">struct</a> or
4555    <a href="#t_array">array</a> type.  The operands are constant indices to
4556    specify which value to extract in a similar manner as indices in a
4557    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4558    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4559      <ul>
4560        <li>Since the value being indexed is not a pointer, the first index is
4561            omitted and assumed to be zero.</li>
4562        <li>At least one index must be specified.</li>
4563        <li>Not only struct indices but also array indices must be in
4564            bounds.</li>
4565      </ul>
4566
4567 <h5>Semantics:</h5>
4568 <p>The result is the value at the position in the aggregate specified by the
4569    index operands.</p>
4570
4571 <h5>Example:</h5>
4572 <pre>
4573   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4574 </pre>
4575
4576 </div>
4577
4578 <!-- _______________________________________________________________________ -->
4579 <h4>
4580    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4581 </h4>
4582
4583 <div>
4584
4585 <h5>Syntax:</h5>
4586 <pre>
4587   &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>
4588 </pre>
4589
4590 <h5>Overview:</h5>
4591 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4592    in an <a href="#t_aggregate">aggregate</a> value.</p>
4593
4594 <h5>Arguments:</h5>
4595 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4596    of <a href="#t_struct">struct</a> or
4597    <a href="#t_array">array</a> type.  The second operand is a first-class
4598    value to insert.  The following operands are constant indices indicating
4599    the position at which to insert the value in a similar manner as indices in a
4600    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4601    value to insert must have the same type as the value identified by the
4602    indices.</p>
4603
4604 <h5>Semantics:</h5>
4605 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4606    that of <tt>val</tt> except that the value at the position specified by the
4607    indices is that of <tt>elt</tt>.</p>
4608
4609 <h5>Example:</h5>
4610 <pre>
4611   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4612   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4613   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4614 </pre>
4615
4616 </div>
4617
4618 </div>
4619
4620 <!-- ======================================================================= -->
4621 <h3>
4622   <a name="memoryops">Memory Access and Addressing Operations</a>
4623 </h3>
4624
4625 <div>
4626
4627 <p>A key design point of an SSA-based representation is how it represents
4628    memory.  In LLVM, no memory locations are in SSA form, which makes things
4629    very simple.  This section describes how to read, write, and allocate
4630    memory in LLVM.</p>
4631
4632 <!-- _______________________________________________________________________ -->
4633 <h4>
4634   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4635 </h4>
4636
4637 <div>
4638
4639 <h5>Syntax:</h5>
4640 <pre>
4641   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4642 </pre>
4643
4644 <h5>Overview:</h5>
4645 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4646    currently executing function, to be automatically released when this function
4647    returns to its caller. The object is always allocated in the generic address
4648    space (address space zero).</p>
4649
4650 <h5>Arguments:</h5>
4651 <p>The '<tt>alloca</tt>' instruction
4652    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4653    runtime stack, returning a pointer of the appropriate type to the program.
4654    If "NumElements" is specified, it is the number of elements allocated,
4655    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4656    specified, the value result of the allocation is guaranteed to be aligned to
4657    at least that boundary.  If not specified, or if zero, the target can choose
4658    to align the allocation on any convenient boundary compatible with the
4659    type.</p>
4660
4661 <p>'<tt>type</tt>' may be any sized type.</p>
4662
4663 <h5>Semantics:</h5>
4664 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4665    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4666    memory is automatically released when the function returns.  The
4667    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4668    variables that must have an address available.  When the function returns
4669    (either with the <tt><a href="#i_ret">ret</a></tt>
4670    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4671    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4672
4673 <h5>Example:</h5>
4674 <pre>
4675   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4676   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4677   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4678   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4679 </pre>
4680
4681 </div>
4682
4683 <!-- _______________________________________________________________________ -->
4684 <h4>
4685   <a name="i_load">'<tt>load</tt>' Instruction</a>
4686 </h4>
4687
4688 <div>
4689
4690 <h5>Syntax:</h5>
4691 <pre>
4692   &lt;result&gt; = load [volatile] &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4693   &lt;result&gt; = load atomic [volatile] &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4694   !&lt;index&gt; = !{ i32 1 }
4695 </pre>
4696
4697 <h5>Overview:</h5>
4698 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4699
4700 <h5>Arguments:</h5>
4701 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4702    from which to load.  The pointer must point to
4703    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4704    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4705    number or order of execution of this <tt>load</tt> with other <a
4706    href="#volatile">volatile operations</a>.</p>
4707
4708 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4709    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4710    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4711    not valid on <code>load</code> instructions.  Atomic loads produce <a
4712    href="#memorymodel">defined</a> results when they may see multiple atomic
4713    stores.  The type of the pointee must be an integer type whose bit width
4714    is a power of two greater than or equal to eight and less than or equal
4715    to a target-specific size limit. <code>align</code> must be explicitly
4716    specified on atomic loads, and the load has undefined behavior if the
4717    alignment is not set to a value which is at least the size in bytes of
4718    the pointee. <code>!nontemporal</code> does not have any defined semantics
4719    for atomic loads.</p>
4720
4721 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4722    operation (that is, the alignment of the memory address). A value of 0 or an
4723    omitted <tt>align</tt> argument means that the operation has the preferential
4724    alignment for the target. It is the responsibility of the code emitter to
4725    ensure that the alignment information is correct. Overestimating the
4726    alignment results in undefined behavior. Underestimating the alignment may
4727    produce less efficient code. An alignment of 1 is always safe.</p>
4728
4729 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4730    metatadata name &lt;index&gt; corresponding to a metadata node with
4731    one <tt>i32</tt> entry of value 1.  The existence of
4732    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4733    and code generator that this load is not expected to be reused in the cache.
4734    The code generator may select special instructions to save cache bandwidth,
4735    such as the <tt>MOVNT</tt> instruction on x86.</p>
4736
4737 <h5>Semantics:</h5>
4738 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4739    scalar type then the number of bytes read does not exceed the minimum number
4740    of bytes needed to hold all bits of the type.  For example, loading an
4741    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4742    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4743    is undefined if the value was not originally written using a store of the
4744    same type.</p>
4745
4746 <h5>Examples:</h5>
4747 <pre>
4748   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4749   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4750   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4751 </pre>
4752
4753 </div>
4754
4755 <!-- _______________________________________________________________________ -->
4756 <h4>
4757   <a name="i_store">'<tt>store</tt>' Instruction</a>
4758 </h4>
4759
4760 <div>
4761
4762 <h5>Syntax:</h5>
4763 <pre>
4764   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>
4765   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>
4766 </pre>
4767
4768 <h5>Overview:</h5>
4769 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4770
4771 <h5>Arguments:</h5>
4772 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4773    and an address at which to store it.  The type of the
4774    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4775    the <a href="#t_firstclass">first class</a> type of the
4776    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4777    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4778    order of execution of this <tt>store</tt> with other <a
4779    href="#volatile">volatile operations</a>.</p>
4780
4781 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
4782    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4783    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
4784    valid on <code>store</code> instructions.  Atomic loads produce <a
4785    href="#memorymodel">defined</a> results when they may see multiple atomic
4786    stores. The type of the pointee must be an integer type whose bit width
4787    is a power of two greater than or equal to eight and less than or equal
4788    to a target-specific size limit. <code>align</code> must be explicitly
4789    specified on atomic stores, and the store has undefined behavior if the
4790    alignment is not set to a value which is at least the size in bytes of
4791    the pointee. <code>!nontemporal</code> does not have any defined semantics
4792    for atomic stores.</p>
4793
4794 <p>The optional constant "align" argument specifies the alignment of the
4795    operation (that is, the alignment of the memory address). A value of 0 or an
4796    omitted "align" argument means that the operation has the preferential
4797    alignment for the target. It is the responsibility of the code emitter to
4798    ensure that the alignment information is correct. Overestimating the
4799    alignment results in an undefined behavior. Underestimating the alignment may
4800    produce less efficient code. An alignment of 1 is always safe.</p>
4801
4802 <p>The optional !nontemporal metadata must reference a single metatadata
4803    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4804    value 1.  The existence of the !nontemporal metatadata on the
4805    instruction tells the optimizer and code generator that this load is
4806    not expected to be reused in the cache.  The code generator may
4807    select special instructions to save cache bandwidth, such as the
4808    MOVNT instruction on x86.</p>
4809
4810
4811 <h5>Semantics:</h5>
4812 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4813    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4814    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4815    does not exceed the minimum number of bytes needed to hold all bits of the
4816    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4817    writing a value of a type like <tt>i20</tt> with a size that is not an
4818    integral number of bytes, it is unspecified what happens to the extra bits
4819    that do not belong to the type, but they will typically be overwritten.</p>
4820
4821 <h5>Example:</h5>
4822 <pre>
4823   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4824   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4825   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4826 </pre>
4827
4828 </div>
4829
4830 <!-- _______________________________________________________________________ -->
4831 <h4>
4832 <a name="i_fence">'<tt>fence</tt>' Instruction</a>
4833 </h4>
4834
4835 <div>
4836
4837 <h5>Syntax:</h5>
4838 <pre>
4839   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
4840 </pre>
4841
4842 <h5>Overview:</h5>
4843 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
4844 between operations.</p>
4845
4846 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
4847 href="#ordering">ordering</a> argument which defines what
4848 <i>synchronizes-with</i> edges they add.  They can only be given
4849 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
4850 <code>seq_cst</code> orderings.</p>
4851
4852 <h5>Semantics:</h5>
4853 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
4854 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
4855 <code>acquire</code> ordering semantics if and only if there exist atomic
4856 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
4857 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
4858 <var>X</var> modifies <var>M</var> (either directly or through some side effect
4859 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
4860 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
4861 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
4862 than an explicit <code>fence</code>, one (but not both) of the atomic operations
4863 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
4864 <code>acquire</code> (resp.) ordering constraint and still
4865 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
4866 <i>happens-before</i> edge.</p>
4867
4868 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
4869 having both <code>acquire</code> and <code>release</code> semantics specified
4870 above, participates in the global program order of other <code>seq_cst</code>
4871 operations and/or fences.</p>
4872
4873 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
4874 specifies that the fence only synchronizes with other fences in the same
4875 thread.  (This is useful for interacting with signal handlers.)</p>
4876
4877 <h5>Example:</h5>
4878 <pre>
4879   fence acquire                          <i>; yields {void}</i>
4880   fence singlethread seq_cst             <i>; yields {void}</i>
4881 </pre>
4882
4883 </div>
4884
4885 <!-- _______________________________________________________________________ -->
4886 <h4>
4887 <a name="i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a>
4888 </h4>
4889
4890 <div>
4891
4892 <h5>Syntax:</h5>
4893 <pre>
4894   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>
4895 </pre>
4896
4897 <h5>Overview:</h5>
4898 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
4899 It loads a value in memory and compares it to a given value. If they are
4900 equal, it stores a new value into the memory.</p>
4901
4902 <h5>Arguments:</h5>
4903 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
4904 address to operate on, a value to compare to the value currently be at that
4905 address, and a new value to place at that address if the compared values are
4906 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
4907 bit width is a power of two greater than or equal to eight and less than
4908 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
4909 '<var>&lt;new&gt;</var>' must have the same type, and the type of
4910 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
4911 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
4912 optimizer is not allowed to modify the number or order of execution
4913 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
4914 operations</a>.</p>
4915
4916 <!-- FIXME: Extend allowed types. -->
4917
4918 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
4919 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
4920
4921 <p>The optional "<code>singlethread</code>" argument declares that the
4922 <code>cmpxchg</code> is only atomic with respect to code (usually signal
4923 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
4924 cmpxchg is atomic with respect to all other code in the system.</p>
4925
4926 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
4927 the size in memory of the operand.
4928
4929 <h5>Semantics:</h5>
4930 <p>The contents of memory at the location specified by the
4931 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
4932 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
4933 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
4934 is returned.
4935
4936 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
4937 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
4938 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
4939 parameter determined by dropping any <code>release</code> part of the
4940 <code>cmpxchg</code>'s ordering.</p>
4941
4942 <!--
4943 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
4944 optimization work on ARM.)
4945
4946 FIXME: Is a weaker ordering constraint on failure helpful in practice?
4947 -->
4948
4949 <h5>Example:</h5>
4950 <pre>
4951 entry:
4952   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                       <i>; yields {i32}</i>
4953   <a href="#i_br">br</a> label %loop
4954
4955 loop:
4956   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
4957   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
4958   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared                       <i>; yields {i32}</i>
4959   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
4960   <a href="#i_br">br</a> i1 %success, label %done, label %loop
4961
4962 done:
4963   ...
4964 </pre>
4965
4966 </div>
4967
4968 <!-- _______________________________________________________________________ -->
4969 <h4>
4970 <a name="i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a>
4971 </h4>
4972
4973 <div>
4974
4975 <h5>Syntax:</h5>
4976 <pre>
4977   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>
4978 </pre>
4979
4980 <h5>Overview:</h5>
4981 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
4982
4983 <h5>Arguments:</h5>
4984 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
4985 operation to apply, an address whose value to modify, an argument to the
4986 operation.  The operation must be one of the following keywords:</p>
4987 <ul>
4988   <li>xchg</li>
4989   <li>add</li>
4990   <li>sub</li>
4991   <li>and</li>
4992   <li>nand</li>
4993   <li>or</li>
4994   <li>xor</li>
4995   <li>max</li>
4996   <li>min</li>
4997   <li>umax</li>
4998   <li>umin</li>
4999 </ul>
5000
5001 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
5002 bit width is a power of two greater than or equal to eight and less than
5003 or equal to a target-specific size limit.  The type of the
5004 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
5005 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
5006 optimizer is not allowed to modify the number or order of execution of this
5007 <code>atomicrmw</code> with other <a href="#volatile">volatile
5008   operations</a>.</p>
5009
5010 <!-- FIXME: Extend allowed types. -->
5011
5012 <h5>Semantics:</h5>
5013 <p>The contents of memory at the location specified by the
5014 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
5015 back.  The original value at the location is returned.  The modification is
5016 specified by the <var>operation</var> argument:</p>
5017
5018 <ul>
5019   <li>xchg: <code>*ptr = val</code></li>
5020   <li>add: <code>*ptr = *ptr + val</code></li>
5021   <li>sub: <code>*ptr = *ptr - val</code></li>
5022   <li>and: <code>*ptr = *ptr &amp; val</code></li>
5023   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
5024   <li>or: <code>*ptr = *ptr | val</code></li>
5025   <li>xor: <code>*ptr = *ptr ^ val</code></li>
5026   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
5027   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
5028   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5029   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5030 </ul>
5031
5032 <h5>Example:</h5>
5033 <pre>
5034   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
5035 </pre>
5036
5037 </div>
5038
5039 <!-- _______________________________________________________________________ -->
5040 <h4>
5041    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
5042 </h4>
5043
5044 <div>
5045
5046 <h5>Syntax:</h5>
5047 <pre>
5048   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5049   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5050 </pre>
5051
5052 <h5>Overview:</h5>
5053 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
5054    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
5055    It performs address calculation only and does not access memory.</p>
5056
5057 <h5>Arguments:</h5>
5058 <p>The first argument is always a pointer, and forms the basis of the
5059    calculation. The remaining arguments are indices that indicate which of the
5060    elements of the aggregate object are indexed. The interpretation of each
5061    index is dependent on the type being indexed into. The first index always
5062    indexes the pointer value given as the first argument, the second index
5063    indexes a value of the type pointed to (not necessarily the value directly
5064    pointed to, since the first index can be non-zero), etc. The first type
5065    indexed into must be a pointer value, subsequent types can be arrays,
5066    vectors, and structs. Note that subsequent types being indexed into
5067    can never be pointers, since that would require loading the pointer before
5068    continuing calculation.</p>
5069
5070 <p>The type of each index argument depends on the type it is indexing into.
5071    When indexing into a (optionally packed) structure, only <tt>i32</tt>
5072    integer <b>constants</b> are allowed.  When indexing into an array, pointer
5073    or vector, integers of any width are allowed, and they are not required to be
5074    constant.  These integers are treated as signed values where relevant.</p>
5075
5076 <p>For example, let's consider a C code fragment and how it gets compiled to
5077    LLVM:</p>
5078
5079 <pre class="doc_code">
5080 struct RT {
5081   char A;
5082   int B[10][20];
5083   char C;
5084 };
5085 struct ST {
5086   int X;
5087   double Y;
5088   struct RT Z;
5089 };
5090
5091 int *foo(struct ST *s) {
5092   return &amp;s[1].Z.B[5][13];
5093 }
5094 </pre>
5095
5096 <p>The LLVM code generated by the GCC frontend is:</p>
5097
5098 <pre class="doc_code">
5099 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
5100 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
5101
5102 define i32* @foo(%ST* %s) {
5103 entry:
5104   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
5105   ret i32* %reg
5106 }
5107 </pre>
5108
5109 <h5>Semantics:</h5>
5110 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
5111    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
5112    }</tt>' type, a structure.  The second index indexes into the third element
5113    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
5114    i8 }</tt>' type, another structure.  The third index indexes into the second
5115    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
5116    array.  The two dimensions of the array are subscripted into, yielding an
5117    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
5118    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
5119
5120 <p>Note that it is perfectly legal to index partially through a structure,
5121    returning a pointer to an inner element.  Because of this, the LLVM code for
5122    the given testcase is equivalent to:</p>
5123
5124 <pre>
5125   define i32* @foo(%ST* %s) {
5126     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
5127     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
5128     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
5129     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5130     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5131     ret i32* %t5
5132   }
5133 </pre>
5134
5135 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5136    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
5137    base pointer is not an <i>in bounds</i> address of an allocated object,
5138    or if any of the addresses that would be formed by successive addition of
5139    the offsets implied by the indices to the base address with infinitely
5140    precise signed arithmetic are not an <i>in bounds</i> address of that
5141    allocated object. The <i>in bounds</i> addresses for an allocated object
5142    are all the addresses that point into the object, plus the address one
5143    byte past the end.</p>
5144
5145 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5146    the base address with silently-wrapping two's complement arithmetic. If the
5147    offsets have a different width from the pointer, they are sign-extended or
5148    truncated to the width of the pointer. The result value of the
5149    <tt>getelementptr</tt> may be outside the object pointed to by the base
5150    pointer. The result value may not necessarily be used to access memory
5151    though, even if it happens to point into allocated storage. See the
5152    <a href="#pointeraliasing">Pointer Aliasing Rules</a> section for more
5153    information.</p>
5154
5155 <p>The getelementptr instruction is often confusing.  For some more insight into
5156    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5157
5158 <h5>Example:</h5>
5159 <pre>
5160     <i>; yields [12 x i8]*:aptr</i>
5161     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5162     <i>; yields i8*:vptr</i>
5163     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5164     <i>; yields i8*:eptr</i>
5165     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5166     <i>; yields i32*:iptr</i>
5167     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5168 </pre>
5169
5170 </div>
5171
5172 </div>
5173
5174 <!-- ======================================================================= -->
5175 <h3>
5176   <a name="convertops">Conversion Operations</a>
5177 </h3>
5178
5179 <div>
5180
5181 <p>The instructions in this category are the conversion instructions (casting)
5182    which all take a single operand and a type. They perform various bit
5183    conversions on the operand.</p>
5184
5185 <!-- _______________________________________________________________________ -->
5186 <h4>
5187    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5188 </h4>
5189
5190 <div>
5191
5192 <h5>Syntax:</h5>
5193 <pre>
5194   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5195 </pre>
5196
5197 <h5>Overview:</h5>
5198 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5199    type <tt>ty2</tt>.</p>
5200
5201 <h5>Arguments:</h5>
5202 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5203    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5204    of the same number of integers.
5205    The bit size of the <tt>value</tt> must be larger than
5206    the bit size of the destination type, <tt>ty2</tt>.
5207    Equal sized types are not allowed.</p>
5208
5209 <h5>Semantics:</h5>
5210 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5211    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5212    source size must be larger than the destination size, <tt>trunc</tt> cannot
5213    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5214
5215 <h5>Example:</h5>
5216 <pre>
5217   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5218   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5219   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5220   %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>
5221 </pre>
5222
5223 </div>
5224
5225 <!-- _______________________________________________________________________ -->
5226 <h4>
5227    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5228 </h4>
5229
5230 <div>
5231
5232 <h5>Syntax:</h5>
5233 <pre>
5234   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5235 </pre>
5236
5237 <h5>Overview:</h5>
5238 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5239    <tt>ty2</tt>.</p>
5240
5241
5242 <h5>Arguments:</h5>
5243 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5244    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5245    of the same number of integers.
5246    The bit size of the <tt>value</tt> must be smaller than
5247    the bit size of the destination type,
5248    <tt>ty2</tt>.</p>
5249
5250 <h5>Semantics:</h5>
5251 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5252    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5253
5254 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5255
5256 <h5>Example:</h5>
5257 <pre>
5258   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5259   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5260   %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>
5261 </pre>
5262
5263 </div>
5264
5265 <!-- _______________________________________________________________________ -->
5266 <h4>
5267    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5268 </h4>
5269
5270 <div>
5271
5272 <h5>Syntax:</h5>
5273 <pre>
5274   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5275 </pre>
5276
5277 <h5>Overview:</h5>
5278 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5279
5280 <h5>Arguments:</h5>
5281 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5282    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5283    of the same number of integers.
5284    The bit size of the <tt>value</tt> must be smaller than
5285    the bit size of the destination type,
5286    <tt>ty2</tt>.</p>
5287
5288 <h5>Semantics:</h5>
5289 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5290    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5291    of the type <tt>ty2</tt>.</p>
5292
5293 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5294
5295 <h5>Example:</h5>
5296 <pre>
5297   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5298   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5299   %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>
5300 </pre>
5301
5302 </div>
5303
5304 <!-- _______________________________________________________________________ -->
5305 <h4>
5306    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5307 </h4>
5308
5309 <div>
5310
5311 <h5>Syntax:</h5>
5312 <pre>
5313   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5314 </pre>
5315
5316 <h5>Overview:</h5>
5317 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5318    <tt>ty2</tt>.</p>
5319
5320 <h5>Arguments:</h5>
5321 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5322    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5323    to cast it to. The size of <tt>value</tt> must be larger than the size of
5324    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5325    <i>no-op cast</i>.</p>
5326
5327 <h5>Semantics:</h5>
5328 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5329    <a href="#t_floating">floating point</a> type to a smaller
5330    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5331    within the destination type, <tt>ty2</tt>, then the results are
5332    undefined.</p>
5333
5334 <h5>Example:</h5>
5335 <pre>
5336   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5337   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5338 </pre>
5339
5340 </div>
5341
5342 <!-- _______________________________________________________________________ -->
5343 <h4>
5344    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5345 </h4>
5346
5347 <div>
5348
5349 <h5>Syntax:</h5>
5350 <pre>
5351   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5352 </pre>
5353
5354 <h5>Overview:</h5>
5355 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5356    floating point value.</p>
5357
5358 <h5>Arguments:</h5>
5359 <p>The '<tt>fpext</tt>' instruction takes a
5360    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5361    a <a href="#t_floating">floating point</a> type to cast it to. The source
5362    type must be smaller than the destination type.</p>
5363
5364 <h5>Semantics:</h5>
5365 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5366    <a href="#t_floating">floating point</a> type to a larger
5367    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5368    used to make a <i>no-op cast</i> because it always changes bits. Use
5369    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5370
5371 <h5>Example:</h5>
5372 <pre>
5373   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5374   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5375 </pre>
5376
5377 </div>
5378
5379 <!-- _______________________________________________________________________ -->
5380 <h4>
5381    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5382 </h4>
5383
5384 <div>
5385
5386 <h5>Syntax:</h5>
5387 <pre>
5388   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5389 </pre>
5390
5391 <h5>Overview:</h5>
5392 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5393    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5394
5395 <h5>Arguments:</h5>
5396 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5397    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5398    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5399    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5400    vector integer type with the same number of elements as <tt>ty</tt></p>
5401
5402 <h5>Semantics:</h5>
5403 <p>The '<tt>fptoui</tt>' instruction converts its
5404    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5405    towards zero) unsigned integer value. If the value cannot fit
5406    in <tt>ty2</tt>, the results are undefined.</p>
5407
5408 <h5>Example:</h5>
5409 <pre>
5410   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5411   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5412   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5413 </pre>
5414
5415 </div>
5416
5417 <!-- _______________________________________________________________________ -->
5418 <h4>
5419    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5420 </h4>
5421
5422 <div>
5423
5424 <h5>Syntax:</h5>
5425 <pre>
5426   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5427 </pre>
5428
5429 <h5>Overview:</h5>
5430 <p>The '<tt>fptosi</tt>' instruction converts
5431    <a href="#t_floating">floating point</a> <tt>value</tt> to
5432    type <tt>ty2</tt>.</p>
5433
5434 <h5>Arguments:</h5>
5435 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5436    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5437    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5438    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5439    vector integer type with the same number of elements as <tt>ty</tt></p>
5440
5441 <h5>Semantics:</h5>
5442 <p>The '<tt>fptosi</tt>' instruction converts its
5443    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5444    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5445    the results are undefined.</p>
5446
5447 <h5>Example:</h5>
5448 <pre>
5449   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5450   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5451   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5452 </pre>
5453
5454 </div>
5455
5456 <!-- _______________________________________________________________________ -->
5457 <h4>
5458    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5459 </h4>
5460
5461 <div>
5462
5463 <h5>Syntax:</h5>
5464 <pre>
5465   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5466 </pre>
5467
5468 <h5>Overview:</h5>
5469 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5470    integer and converts that value to the <tt>ty2</tt> type.</p>
5471
5472 <h5>Arguments:</h5>
5473 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5474    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5475    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5476    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5477    floating point type with the same number of elements as <tt>ty</tt></p>
5478
5479 <h5>Semantics:</h5>
5480 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5481    integer quantity and converts it to the corresponding floating point
5482    value. If the value cannot fit in the floating point value, the results are
5483    undefined.</p>
5484
5485 <h5>Example:</h5>
5486 <pre>
5487   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5488   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5489 </pre>
5490
5491 </div>
5492
5493 <!-- _______________________________________________________________________ -->
5494 <h4>
5495    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5496 </h4>
5497
5498 <div>
5499
5500 <h5>Syntax:</h5>
5501 <pre>
5502   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5503 </pre>
5504
5505 <h5>Overview:</h5>
5506 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5507    and converts that value to the <tt>ty2</tt> type.</p>
5508
5509 <h5>Arguments:</h5>
5510 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5511    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5512    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5513    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5514    floating point type with the same number of elements as <tt>ty</tt></p>
5515
5516 <h5>Semantics:</h5>
5517 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5518    quantity and converts it to the corresponding floating point value. If the
5519    value cannot fit in the floating point value, the results are undefined.</p>
5520
5521 <h5>Example:</h5>
5522 <pre>
5523   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5524   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5525 </pre>
5526
5527 </div>
5528
5529 <!-- _______________________________________________________________________ -->
5530 <h4>
5531    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5532 </h4>
5533
5534 <div>
5535
5536 <h5>Syntax:</h5>
5537 <pre>
5538   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5539 </pre>
5540
5541 <h5>Overview:</h5>
5542 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
5543    the integer type <tt>ty2</tt>.</p>
5544
5545 <h5>Arguments:</h5>
5546 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5547    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
5548    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
5549
5550 <h5>Semantics:</h5>
5551 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5552    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5553    truncating or zero extending that value to the size of the integer type. If
5554    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5555    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5556    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5557    change.</p>
5558
5559 <h5>Example:</h5>
5560 <pre>
5561   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
5562   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
5563 </pre>
5564
5565 </div>
5566
5567 <!-- _______________________________________________________________________ -->
5568 <h4>
5569    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5570 </h4>
5571
5572 <div>
5573
5574 <h5>Syntax:</h5>
5575 <pre>
5576   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5577 </pre>
5578
5579 <h5>Overview:</h5>
5580 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5581    pointer type, <tt>ty2</tt>.</p>
5582
5583 <h5>Arguments:</h5>
5584 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5585    value to cast, and a type to cast it to, which must be a
5586    <a href="#t_pointer">pointer</a> type.</p>
5587
5588 <h5>Semantics:</h5>
5589 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5590    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5591    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5592    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5593    than the size of a pointer then a zero extension is done. If they are the
5594    same size, nothing is done (<i>no-op cast</i>).</p>
5595
5596 <h5>Example:</h5>
5597 <pre>
5598   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5599   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5600   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5601 </pre>
5602
5603 </div>
5604
5605 <!-- _______________________________________________________________________ -->
5606 <h4>
5607    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5608 </h4>
5609
5610 <div>
5611
5612 <h5>Syntax:</h5>
5613 <pre>
5614   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5615 </pre>
5616
5617 <h5>Overview:</h5>
5618 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5619    <tt>ty2</tt> without changing any bits.</p>
5620
5621 <h5>Arguments:</h5>
5622 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5623    non-aggregate first class value, and a type to cast it to, which must also be
5624    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5625    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5626    identical. If the source type is a pointer, the destination type must also be
5627    a pointer.  This instruction supports bitwise conversion of vectors to
5628    integers and to vectors of other types (as long as they have the same
5629    size).</p>
5630
5631 <h5>Semantics:</h5>
5632 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5633    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5634    this conversion.  The conversion is done as if the <tt>value</tt> had been
5635    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5636    be converted to other pointer types with this instruction. To convert
5637    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5638    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5639
5640 <h5>Example:</h5>
5641 <pre>
5642   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5643   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5644   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5645 </pre>
5646
5647 </div>
5648
5649 </div>
5650
5651 <!-- ======================================================================= -->
5652 <h3>
5653   <a name="otherops">Other Operations</a>
5654 </h3>
5655
5656 <div>
5657
5658 <p>The instructions in this category are the "miscellaneous" instructions, which
5659    defy better classification.</p>
5660
5661 <!-- _______________________________________________________________________ -->
5662 <h4>
5663   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5664 </h4>
5665
5666 <div>
5667
5668 <h5>Syntax:</h5>
5669 <pre>
5670   &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>
5671 </pre>
5672
5673 <h5>Overview:</h5>
5674 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5675    boolean values based on comparison of its two integer, integer vector, or
5676    pointer operands.</p>
5677
5678 <h5>Arguments:</h5>
5679 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5680    the condition code indicating the kind of comparison to perform. It is not a
5681    value, just a keyword. The possible condition code are:</p>
5682
5683 <ol>
5684   <li><tt>eq</tt>: equal</li>
5685   <li><tt>ne</tt>: not equal </li>
5686   <li><tt>ugt</tt>: unsigned greater than</li>
5687   <li><tt>uge</tt>: unsigned greater or equal</li>
5688   <li><tt>ult</tt>: unsigned less than</li>
5689   <li><tt>ule</tt>: unsigned less or equal</li>
5690   <li><tt>sgt</tt>: signed greater than</li>
5691   <li><tt>sge</tt>: signed greater or equal</li>
5692   <li><tt>slt</tt>: signed less than</li>
5693   <li><tt>sle</tt>: signed less or equal</li>
5694 </ol>
5695
5696 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5697    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5698    typed.  They must also be identical types.</p>
5699
5700 <h5>Semantics:</h5>
5701 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5702    condition code given as <tt>cond</tt>. The comparison performed always yields
5703    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5704    result, as follows:</p>
5705
5706 <ol>
5707   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5708       <tt>false</tt> otherwise. No sign interpretation is necessary or
5709       performed.</li>
5710
5711   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5712       <tt>false</tt> otherwise. No sign interpretation is necessary or
5713       performed.</li>
5714
5715   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5716       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5717
5718   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5719       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5720       to <tt>op2</tt>.</li>
5721
5722   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5723       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5724
5725   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5726       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5727
5728   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5729       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5730
5731   <li><tt>sge</tt>: interprets the operands as signed values and yields
5732       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5733       to <tt>op2</tt>.</li>
5734
5735   <li><tt>slt</tt>: interprets the operands as signed values and yields
5736       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5737
5738   <li><tt>sle</tt>: interprets the operands as signed values and yields
5739       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5740 </ol>
5741
5742 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5743    values are compared as if they were integers.</p>
5744
5745 <p>If the operands are integer vectors, then they are compared element by
5746    element. The result is an <tt>i1</tt> vector with the same number of elements
5747    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5748
5749 <h5>Example:</h5>
5750 <pre>
5751   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5752   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5753   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5754   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5755   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5756   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5757 </pre>
5758
5759 <p>Note that the code generator does not yet support vector types with
5760    the <tt>icmp</tt> instruction.</p>
5761
5762 </div>
5763
5764 <!-- _______________________________________________________________________ -->
5765 <h4>
5766   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5767 </h4>
5768
5769 <div>
5770
5771 <h5>Syntax:</h5>
5772 <pre>
5773   &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>
5774 </pre>
5775
5776 <h5>Overview:</h5>
5777 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5778    values based on comparison of its operands.</p>
5779
5780 <p>If the operands are floating point scalars, then the result type is a boolean
5781 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5782
5783 <p>If the operands are floating point vectors, then the result type is a vector
5784    of boolean with the same number of elements as the operands being
5785    compared.</p>
5786
5787 <h5>Arguments:</h5>
5788 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5789    the condition code indicating the kind of comparison to perform. It is not a
5790    value, just a keyword. The possible condition code are:</p>
5791
5792 <ol>
5793   <li><tt>false</tt>: no comparison, always returns false</li>
5794   <li><tt>oeq</tt>: ordered and equal</li>
5795   <li><tt>ogt</tt>: ordered and greater than </li>
5796   <li><tt>oge</tt>: ordered and greater than or equal</li>
5797   <li><tt>olt</tt>: ordered and less than </li>
5798   <li><tt>ole</tt>: ordered and less than or equal</li>
5799   <li><tt>one</tt>: ordered and not equal</li>
5800   <li><tt>ord</tt>: ordered (no nans)</li>
5801   <li><tt>ueq</tt>: unordered or equal</li>
5802   <li><tt>ugt</tt>: unordered or greater than </li>
5803   <li><tt>uge</tt>: unordered or greater than or equal</li>
5804   <li><tt>ult</tt>: unordered or less than </li>
5805   <li><tt>ule</tt>: unordered or less than or equal</li>
5806   <li><tt>une</tt>: unordered or not equal</li>
5807   <li><tt>uno</tt>: unordered (either nans)</li>
5808   <li><tt>true</tt>: no comparison, always returns true</li>
5809 </ol>
5810
5811 <p><i>Ordered</i> means that neither operand is a QNAN while
5812    <i>unordered</i> means that either operand may be a QNAN.</p>
5813
5814 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5815    a <a href="#t_floating">floating point</a> type or
5816    a <a href="#t_vector">vector</a> of floating point type.  They must have
5817    identical types.</p>
5818
5819 <h5>Semantics:</h5>
5820 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5821    according to the condition code given as <tt>cond</tt>.  If the operands are
5822    vectors, then the vectors are compared element by element.  Each comparison
5823    performed always yields an <a href="#t_integer">i1</a> result, as
5824    follows:</p>
5825
5826 <ol>
5827   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5828
5829   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5830       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5831
5832   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5833       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5834
5835   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5836       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5837
5838   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5839       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5840
5841   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5842       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5843
5844   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5845       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5846
5847   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5848
5849   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5850       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5851
5852   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5853       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5854
5855   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5856       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5857
5858   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5859       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5860
5861   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5862       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5863
5864   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5865       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5866
5867   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5868
5869   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5870 </ol>
5871
5872 <h5>Example:</h5>
5873 <pre>
5874   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5875   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5876   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5877   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5878 </pre>
5879
5880 <p>Note that the code generator does not yet support vector types with
5881    the <tt>fcmp</tt> instruction.</p>
5882
5883 </div>
5884
5885 <!-- _______________________________________________________________________ -->
5886 <h4>
5887   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5888 </h4>
5889
5890 <div>
5891
5892 <h5>Syntax:</h5>
5893 <pre>
5894   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5895 </pre>
5896
5897 <h5>Overview:</h5>
5898 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5899    SSA graph representing the function.</p>
5900
5901 <h5>Arguments:</h5>
5902 <p>The type of the incoming values is specified with the first type field. After
5903    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5904    one pair for each predecessor basic block of the current block.  Only values
5905    of <a href="#t_firstclass">first class</a> type may be used as the value
5906    arguments to the PHI node.  Only labels may be used as the label
5907    arguments.</p>
5908
5909 <p>There must be no non-phi instructions between the start of a basic block and
5910    the PHI instructions: i.e. PHI instructions must be first in a basic
5911    block.</p>
5912
5913 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5914    occur on the edge from the corresponding predecessor block to the current
5915    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5916    value on the same edge).</p>
5917
5918 <h5>Semantics:</h5>
5919 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5920    specified by the pair corresponding to the predecessor basic block that
5921    executed just prior to the current block.</p>
5922
5923 <h5>Example:</h5>
5924 <pre>
5925 Loop:       ; Infinite loop that counts from 0 on up...
5926   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5927   %nextindvar = add i32 %indvar, 1
5928   br label %Loop
5929 </pre>
5930
5931 </div>
5932
5933 <!-- _______________________________________________________________________ -->
5934 <h4>
5935    <a name="i_select">'<tt>select</tt>' Instruction</a>
5936 </h4>
5937
5938 <div>
5939
5940 <h5>Syntax:</h5>
5941 <pre>
5942   &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>
5943
5944   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5945 </pre>
5946
5947 <h5>Overview:</h5>
5948 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5949    condition, without branching.</p>
5950
5951
5952 <h5>Arguments:</h5>
5953 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5954    values indicating the condition, and two values of the
5955    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5956    vectors and the condition is a scalar, then entire vectors are selected, not
5957    individual elements.</p>
5958
5959 <h5>Semantics:</h5>
5960 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5961    first value argument; otherwise, it returns the second value argument.</p>
5962
5963 <p>If the condition is a vector of i1, then the value arguments must be vectors
5964    of the same size, and the selection is done element by element.</p>
5965
5966 <h5>Example:</h5>
5967 <pre>
5968   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5969 </pre>
5970
5971 <p>Note that the code generator does not yet support conditions
5972    with vector type.</p>
5973
5974 </div>
5975
5976 <!-- _______________________________________________________________________ -->
5977 <h4>
5978   <a name="i_call">'<tt>call</tt>' Instruction</a>
5979 </h4>
5980
5981 <div>
5982
5983 <h5>Syntax:</h5>
5984 <pre>
5985   &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>]
5986 </pre>
5987
5988 <h5>Overview:</h5>
5989 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5990
5991 <h5>Arguments:</h5>
5992 <p>This instruction requires several arguments:</p>
5993
5994 <ol>
5995   <li>The optional "tail" marker indicates that the callee function does not
5996       access any allocas or varargs in the caller.  Note that calls may be
5997       marked "tail" even if they do not occur before
5998       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5999       present, the function call is eligible for tail call optimization,
6000       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
6001       optimized into a jump</a>.  The code generator may optimize calls marked
6002       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
6003       sibling call optimization</a> when the caller and callee have
6004       matching signatures, or 2) forced tail call optimization when the
6005       following extra requirements are met:
6006       <ul>
6007         <li>Caller and callee both have the calling
6008             convention <tt>fastcc</tt>.</li>
6009         <li>The call is in tail position (ret immediately follows call and ret
6010             uses value of call or is void).</li>
6011         <li>Option <tt>-tailcallopt</tt> is enabled,
6012             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
6013         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
6014             constraints are met.</a></li>
6015       </ul>
6016   </li>
6017
6018   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
6019       convention</a> the call should use.  If none is specified, the call
6020       defaults to using C calling conventions.  The calling convention of the
6021       call must match the calling convention of the target function, or else the
6022       behavior is undefined.</li>
6023
6024   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
6025       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
6026       '<tt>inreg</tt>' attributes are valid here.</li>
6027
6028   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
6029       type of the return value.  Functions that return no value are marked
6030       <tt><a href="#t_void">void</a></tt>.</li>
6031
6032   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
6033       being invoked.  The argument types must match the types implied by this
6034       signature.  This type can be omitted if the function is not varargs and if
6035       the function type does not return a pointer to a function.</li>
6036
6037   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
6038       be invoked. In most cases, this is a direct function invocation, but
6039       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
6040       to function value.</li>
6041
6042   <li>'<tt>function args</tt>': argument list whose types match the function
6043       signature argument types and parameter attributes. All arguments must be
6044       of <a href="#t_firstclass">first class</a> type. If the function
6045       signature indicates the function accepts a variable number of arguments,
6046       the extra arguments can be specified.</li>
6047
6048   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
6049       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
6050       '<tt>readnone</tt>' attributes are valid here.</li>
6051 </ol>
6052
6053 <h5>Semantics:</h5>
6054 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
6055    a specified function, with its incoming arguments bound to the specified
6056    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
6057    function, control flow continues with the instruction after the function
6058    call, and the return value of the function is bound to the result
6059    argument.</p>
6060
6061 <h5>Example:</h5>
6062 <pre>
6063   %retval = call i32 @test(i32 %argc)
6064   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
6065   %X = tail call i32 @foo()                                    <i>; yields i32</i>
6066   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
6067   call void %foo(i8 97 signext)
6068
6069   %struct.A = type { i32, i8 }
6070   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
6071   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
6072   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
6073   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
6074   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
6075 </pre>
6076
6077 <p>llvm treats calls to some functions with names and arguments that match the
6078 standard C99 library as being the C99 library functions, and may perform
6079 optimizations or generate code for them under that assumption.  This is
6080 something we'd like to change in the future to provide better support for
6081 freestanding environments and non-C-based languages.</p>
6082
6083 </div>
6084
6085 <!-- _______________________________________________________________________ -->
6086 <h4>
6087   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
6088 </h4>
6089
6090 <div>
6091
6092 <h5>Syntax:</h5>
6093 <pre>
6094   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
6095 </pre>
6096
6097 <h5>Overview:</h5>
6098 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
6099    the "variable argument" area of a function call.  It is used to implement the
6100    <tt>va_arg</tt> macro in C.</p>
6101
6102 <h5>Arguments:</h5>
6103 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
6104    argument. It returns a value of the specified argument type and increments
6105    the <tt>va_list</tt> to point to the next argument.  The actual type
6106    of <tt>va_list</tt> is target specific.</p>
6107
6108 <h5>Semantics:</h5>
6109 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
6110    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
6111    to the next argument.  For more information, see the variable argument
6112    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
6113
6114 <p>It is legal for this instruction to be called in a function which does not
6115    take a variable number of arguments, for example, the <tt>vfprintf</tt>
6116    function.</p>
6117
6118 <p><tt>va_arg</tt> is an LLVM instruction instead of
6119    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
6120    argument.</p>
6121
6122 <h5>Example:</h5>
6123 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6124
6125 <p>Note that the code generator does not yet fully support va_arg on many
6126    targets. Also, it does not currently support va_arg with aggregate types on
6127    any target.</p>
6128
6129 </div>
6130
6131 <!-- _______________________________________________________________________ -->
6132 <h4>
6133   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6134 </h4>
6135
6136 <div>
6137
6138 <h5>Syntax:</h5>
6139 <pre>
6140   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6141   &lt;resultval&gt; = landingpad &lt;somety&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6142
6143   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6144   &lt;clause&gt; := filter &lt;array constant type&gt; &lt;array constant&gt;
6145 </pre>
6146
6147 <h5>Overview:</h5>
6148 <p>The '<tt>landingpad</tt>' instruction is used by
6149    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6150    system</a> to specify that a basic block is a landing pad &mdash; one where
6151    the exception lands, and corresponds to the code found in the
6152    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6153    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6154    re-entry to the function. The <tt>resultval</tt> has the
6155    type <tt>somety</tt>.</p>
6156
6157 <h5>Arguments:</h5>
6158 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6159    function associated with the unwinding mechanism. The optional
6160    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6161
6162 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6163    or <tt>filter</tt> &mdash; and contains the global variable representing the
6164    "type" that may be caught or filtered respectively. Unlike the
6165    <tt>catch</tt> clause, the <tt>filter</tt> clause takes an array constant as
6166    its argument. Use "<tt>[0 x i8**] undef</tt>" for a filter which cannot
6167    throw. The '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6168    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6169
6170 <h5>Semantics:</h5>
6171 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6172    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6173    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6174    calling conventions, how the personality function results are represented in
6175    LLVM IR is target specific.</p>
6176
6177 <p>The clauses are applied in order from top to bottom. If two
6178    <tt>landingpad</tt> instructions are merged together through inlining, the
6179    clauses from the calling function are appended to the list of clauses.</p>
6180
6181 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6182
6183 <ul>
6184   <li>A landing pad block is a basic block which is the unwind destination of an
6185       '<tt>invoke</tt>' instruction.</li>
6186   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6187       first non-PHI instruction.</li>
6188   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6189       pad block.</li>
6190   <li>A basic block that is not a landing pad block may not include a
6191       '<tt>landingpad</tt>' instruction.</li>
6192   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6193       personality function.</li>
6194 </ul>
6195
6196 <h5>Example:</h5>
6197 <pre>
6198   ;; A landing pad which can catch an integer.
6199   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6200            catch i8** @_ZTIi
6201   ;; A landing pad that is a cleanup.
6202   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6203            cleanup
6204   ;; A landing pad which can catch an integer and can only throw a double.
6205   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6206            catch i8** @_ZTIi
6207            filter [1 x i8**] [@_ZTId]
6208 </pre>
6209
6210 </div>
6211
6212 </div>
6213
6214 </div>
6215
6216 <!-- *********************************************************************** -->
6217 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6218 <!-- *********************************************************************** -->
6219
6220 <div>
6221
6222 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6223    well known names and semantics and are required to follow certain
6224    restrictions.  Overall, these intrinsics represent an extension mechanism for
6225    the LLVM language that does not require changing all of the transformations
6226    in LLVM when adding to the language (or the bitcode reader/writer, the
6227    parser, etc...).</p>
6228
6229 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6230    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6231    begin with this prefix.  Intrinsic functions must always be external
6232    functions: you cannot define the body of intrinsic functions.  Intrinsic
6233    functions may only be used in call or invoke instructions: it is illegal to
6234    take the address of an intrinsic function.  Additionally, because intrinsic
6235    functions are part of the LLVM language, it is required if any are added that
6236    they be documented here.</p>
6237
6238 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6239    family of functions that perform the same operation but on different data
6240    types. Because LLVM can represent over 8 million different integer types,
6241    overloading is used commonly to allow an intrinsic function to operate on any
6242    integer type. One or more of the argument types or the result type can be
6243    overloaded to accept any integer type. Argument types may also be defined as
6244    exactly matching a previous argument's type or the result type. This allows
6245    an intrinsic function which accepts multiple arguments, but needs all of them
6246    to be of the same type, to only be overloaded with respect to a single
6247    argument or the result.</p>
6248
6249 <p>Overloaded intrinsics will have the names of its overloaded argument types
6250    encoded into its function name, each preceded by a period. Only those types
6251    which are overloaded result in a name suffix. Arguments whose type is matched
6252    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6253    can take an integer of any width and returns an integer of exactly the same
6254    integer width. This leads to a family of functions such as
6255    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6256    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6257    suffix is required. Because the argument's type is matched against the return
6258    type, it does not require its own name suffix.</p>
6259
6260 <p>To learn how to add an intrinsic function, please see the
6261    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6262
6263 <!-- ======================================================================= -->
6264 <h3>
6265   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6266 </h3>
6267
6268 <div>
6269
6270 <p>Variable argument support is defined in LLVM with
6271    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6272    intrinsic functions.  These functions are related to the similarly named
6273    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6274
6275 <p>All of these functions operate on arguments that use a target-specific value
6276    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6277    not define what this type is, so all transformations should be prepared to
6278    handle these functions regardless of the type used.</p>
6279
6280 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6281    instruction and the variable argument handling intrinsic functions are
6282    used.</p>
6283
6284 <pre class="doc_code">
6285 define i32 @test(i32 %X, ...) {
6286   ; Initialize variable argument processing
6287   %ap = alloca i8*
6288   %ap2 = bitcast i8** %ap to i8*
6289   call void @llvm.va_start(i8* %ap2)
6290
6291   ; Read a single integer argument
6292   %tmp = va_arg i8** %ap, i32
6293
6294   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6295   %aq = alloca i8*
6296   %aq2 = bitcast i8** %aq to i8*
6297   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6298   call void @llvm.va_end(i8* %aq2)
6299
6300   ; Stop processing of arguments.
6301   call void @llvm.va_end(i8* %ap2)
6302   ret i32 %tmp
6303 }
6304
6305 declare void @llvm.va_start(i8*)
6306 declare void @llvm.va_copy(i8*, i8*)
6307 declare void @llvm.va_end(i8*)
6308 </pre>
6309
6310 <!-- _______________________________________________________________________ -->
6311 <h4>
6312   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6313 </h4>
6314
6315
6316 <div>
6317
6318 <h5>Syntax:</h5>
6319 <pre>
6320   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6321 </pre>
6322
6323 <h5>Overview:</h5>
6324 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6325    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6326
6327 <h5>Arguments:</h5>
6328 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6329
6330 <h5>Semantics:</h5>
6331 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6332    macro available in C.  In a target-dependent way, it initializes
6333    the <tt>va_list</tt> element to which the argument points, so that the next
6334    call to <tt>va_arg</tt> will produce the first variable argument passed to
6335    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6336    need to know the last argument of the function as the compiler can figure
6337    that out.</p>
6338
6339 </div>
6340
6341 <!-- _______________________________________________________________________ -->
6342 <h4>
6343  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6344 </h4>
6345
6346 <div>
6347
6348 <h5>Syntax:</h5>
6349 <pre>
6350   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6351 </pre>
6352
6353 <h5>Overview:</h5>
6354 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6355    which has been initialized previously
6356    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6357    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6358
6359 <h5>Arguments:</h5>
6360 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6361
6362 <h5>Semantics:</h5>
6363 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6364    macro available in C.  In a target-dependent way, it destroys
6365    the <tt>va_list</tt> element to which the argument points.  Calls
6366    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6367    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6368    with calls to <tt>llvm.va_end</tt>.</p>
6369
6370 </div>
6371
6372 <!-- _______________________________________________________________________ -->
6373 <h4>
6374   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6375 </h4>
6376
6377 <div>
6378
6379 <h5>Syntax:</h5>
6380 <pre>
6381   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6382 </pre>
6383
6384 <h5>Overview:</h5>
6385 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6386    from the source argument list to the destination argument list.</p>
6387
6388 <h5>Arguments:</h5>
6389 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6390    The second argument is a pointer to a <tt>va_list</tt> element to copy
6391    from.</p>
6392
6393 <h5>Semantics:</h5>
6394 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6395    macro available in C.  In a target-dependent way, it copies the
6396    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6397    element.  This intrinsic is necessary because
6398    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6399    arbitrarily complex and require, for example, memory allocation.</p>
6400
6401 </div>
6402
6403 </div>
6404
6405 <!-- ======================================================================= -->
6406 <h3>
6407   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6408 </h3>
6409
6410 <div>
6411
6412 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6413 Collection</a> (GC) requires the implementation and generation of these
6414 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6415 roots on the stack</a>, as well as garbage collector implementations that
6416 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6417 barriers.  Front-ends for type-safe garbage collected languages should generate
6418 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6419 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6420 LLVM</a>.</p>
6421
6422 <p>The garbage collection intrinsics only operate on objects in the generic
6423    address space (address space zero).</p>
6424
6425 <!-- _______________________________________________________________________ -->
6426 <h4>
6427   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6428 </h4>
6429
6430 <div>
6431
6432 <h5>Syntax:</h5>
6433 <pre>
6434   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6435 </pre>
6436
6437 <h5>Overview:</h5>
6438 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6439    the code generator, and allows some metadata to be associated with it.</p>
6440
6441 <h5>Arguments:</h5>
6442 <p>The first argument specifies the address of a stack object that contains the
6443    root pointer.  The second pointer (which must be either a constant or a
6444    global value address) contains the meta-data to be associated with the
6445    root.</p>
6446
6447 <h5>Semantics:</h5>
6448 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6449    location.  At compile-time, the code generator generates information to allow
6450    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6451    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6452    algorithm</a>.</p>
6453
6454 </div>
6455
6456 <!-- _______________________________________________________________________ -->
6457 <h4>
6458   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6459 </h4>
6460
6461 <div>
6462
6463 <h5>Syntax:</h5>
6464 <pre>
6465   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6466 </pre>
6467
6468 <h5>Overview:</h5>
6469 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6470    locations, allowing garbage collector implementations that require read
6471    barriers.</p>
6472
6473 <h5>Arguments:</h5>
6474 <p>The second argument is the address to read from, which should be an address
6475    allocated from the garbage collector.  The first object is a pointer to the
6476    start of the referenced object, if needed by the language runtime (otherwise
6477    null).</p>
6478
6479 <h5>Semantics:</h5>
6480 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6481    instruction, but may be replaced with substantially more complex code by the
6482    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6483    may only be used in a function which <a href="#gc">specifies a GC
6484    algorithm</a>.</p>
6485
6486 </div>
6487
6488 <!-- _______________________________________________________________________ -->
6489 <h4>
6490   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6491 </h4>
6492
6493 <div>
6494
6495 <h5>Syntax:</h5>
6496 <pre>
6497   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6498 </pre>
6499
6500 <h5>Overview:</h5>
6501 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6502    locations, allowing garbage collector implementations that require write
6503    barriers (such as generational or reference counting collectors).</p>
6504
6505 <h5>Arguments:</h5>
6506 <p>The first argument is the reference to store, the second is the start of the
6507    object to store it to, and the third is the address of the field of Obj to
6508    store to.  If the runtime does not require a pointer to the object, Obj may
6509    be null.</p>
6510
6511 <h5>Semantics:</h5>
6512 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6513    instruction, but may be replaced with substantially more complex code by the
6514    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6515    may only be used in a function which <a href="#gc">specifies a GC
6516    algorithm</a>.</p>
6517
6518 </div>
6519
6520 </div>
6521
6522 <!-- ======================================================================= -->
6523 <h3>
6524   <a name="int_codegen">Code Generator Intrinsics</a>
6525 </h3>
6526
6527 <div>
6528
6529 <p>These intrinsics are provided by LLVM to expose special features that may
6530    only be implemented with code generator support.</p>
6531
6532 <!-- _______________________________________________________________________ -->
6533 <h4>
6534   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6535 </h4>
6536
6537 <div>
6538
6539 <h5>Syntax:</h5>
6540 <pre>
6541   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6542 </pre>
6543
6544 <h5>Overview:</h5>
6545 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6546    target-specific value indicating the return address of the current function
6547    or one of its callers.</p>
6548
6549 <h5>Arguments:</h5>
6550 <p>The argument to this intrinsic indicates which function to return the address
6551    for.  Zero indicates the calling function, one indicates its caller, etc.
6552    The argument is <b>required</b> to be a constant integer value.</p>
6553
6554 <h5>Semantics:</h5>
6555 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6556    indicating the return address of the specified call frame, or zero if it
6557    cannot be identified.  The value returned by this intrinsic is likely to be
6558    incorrect or 0 for arguments other than zero, so it should only be used for
6559    debugging purposes.</p>
6560
6561 <p>Note that calling this intrinsic does not prevent function inlining or other
6562    aggressive transformations, so the value returned may not be that of the
6563    obvious source-language caller.</p>
6564
6565 </div>
6566
6567 <!-- _______________________________________________________________________ -->
6568 <h4>
6569   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6570 </h4>
6571
6572 <div>
6573
6574 <h5>Syntax:</h5>
6575 <pre>
6576   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6577 </pre>
6578
6579 <h5>Overview:</h5>
6580 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6581    target-specific frame pointer value for the specified stack frame.</p>
6582
6583 <h5>Arguments:</h5>
6584 <p>The argument to this intrinsic indicates which function to return the frame
6585    pointer for.  Zero indicates the calling function, one indicates its caller,
6586    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6587
6588 <h5>Semantics:</h5>
6589 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6590    indicating the frame address of the specified call frame, or zero if it
6591    cannot be identified.  The value returned by this intrinsic is likely to be
6592    incorrect or 0 for arguments other than zero, so it should only be used for
6593    debugging purposes.</p>
6594
6595 <p>Note that calling this intrinsic does not prevent function inlining or other
6596    aggressive transformations, so the value returned may not be that of the
6597    obvious source-language caller.</p>
6598
6599 </div>
6600
6601 <!-- _______________________________________________________________________ -->
6602 <h4>
6603   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6604 </h4>
6605
6606 <div>
6607
6608 <h5>Syntax:</h5>
6609 <pre>
6610   declare i8* @llvm.stacksave()
6611 </pre>
6612
6613 <h5>Overview:</h5>
6614 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6615    of the function stack, for use
6616    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6617    useful for implementing language features like scoped automatic variable
6618    sized arrays in C99.</p>
6619
6620 <h5>Semantics:</h5>
6621 <p>This intrinsic returns a opaque pointer value that can be passed
6622    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6623    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6624    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6625    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6626    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6627    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6628
6629 </div>
6630
6631 <!-- _______________________________________________________________________ -->
6632 <h4>
6633   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6634 </h4>
6635
6636 <div>
6637
6638 <h5>Syntax:</h5>
6639 <pre>
6640   declare void @llvm.stackrestore(i8* %ptr)
6641 </pre>
6642
6643 <h5>Overview:</h5>
6644 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6645    the function stack to the state it was in when the
6646    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6647    executed.  This is useful for implementing language features like scoped
6648    automatic variable sized arrays in C99.</p>
6649
6650 <h5>Semantics:</h5>
6651 <p>See the description
6652    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6653
6654 </div>
6655
6656 <!-- _______________________________________________________________________ -->
6657 <h4>
6658   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6659 </h4>
6660
6661 <div>
6662
6663 <h5>Syntax:</h5>
6664 <pre>
6665   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6666 </pre>
6667
6668 <h5>Overview:</h5>
6669 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6670    insert a prefetch instruction if supported; otherwise, it is a noop.
6671    Prefetches have no effect on the behavior of the program but can change its
6672    performance characteristics.</p>
6673
6674 <h5>Arguments:</h5>
6675 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6676    specifier determining if the fetch should be for a read (0) or write (1),
6677    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6678    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6679    specifies whether the prefetch is performed on the data (1) or instruction (0)
6680    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6681    must be constant integers.</p>
6682
6683 <h5>Semantics:</h5>
6684 <p>This intrinsic does not modify the behavior of the program.  In particular,
6685    prefetches cannot trap and do not produce a value.  On targets that support
6686    this intrinsic, the prefetch can provide hints to the processor cache for
6687    better performance.</p>
6688
6689 </div>
6690
6691 <!-- _______________________________________________________________________ -->
6692 <h4>
6693   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6694 </h4>
6695
6696 <div>
6697
6698 <h5>Syntax:</h5>
6699 <pre>
6700   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6701 </pre>
6702
6703 <h5>Overview:</h5>
6704 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6705    Counter (PC) in a region of code to simulators and other tools.  The method
6706    is target specific, but it is expected that the marker will use exported
6707    symbols to transmit the PC of the marker.  The marker makes no guarantees
6708    that it will remain with any specific instruction after optimizations.  It is
6709    possible that the presence of a marker will inhibit optimizations.  The
6710    intended use is to be inserted after optimizations to allow correlations of
6711    simulation runs.</p>
6712
6713 <h5>Arguments:</h5>
6714 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6715
6716 <h5>Semantics:</h5>
6717 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6718    not support this intrinsic may ignore it.</p>
6719
6720 </div>
6721
6722 <!-- _______________________________________________________________________ -->
6723 <h4>
6724   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6725 </h4>
6726
6727 <div>
6728
6729 <h5>Syntax:</h5>
6730 <pre>
6731   declare i64 @llvm.readcyclecounter()
6732 </pre>
6733
6734 <h5>Overview:</h5>
6735 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6736    counter register (or similar low latency, high accuracy clocks) on those
6737    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6738    should map to RPCC.  As the backing counters overflow quickly (on the order
6739    of 9 seconds on alpha), this should only be used for small timings.</p>
6740
6741 <h5>Semantics:</h5>
6742 <p>When directly supported, reading the cycle counter should not modify any
6743    memory.  Implementations are allowed to either return a application specific
6744    value or a system wide value.  On backends without support, this is lowered
6745    to a constant 0.</p>
6746
6747 </div>
6748
6749 </div>
6750
6751 <!-- ======================================================================= -->
6752 <h3>
6753   <a name="int_libc">Standard C Library Intrinsics</a>
6754 </h3>
6755
6756 <div>
6757
6758 <p>LLVM provides intrinsics for a few important standard C library functions.
6759    These intrinsics allow source-language front-ends to pass information about
6760    the alignment of the pointer arguments to the code generator, providing
6761    opportunity for more efficient code generation.</p>
6762
6763 <!-- _______________________________________________________________________ -->
6764 <h4>
6765   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6766 </h4>
6767
6768 <div>
6769
6770 <h5>Syntax:</h5>
6771 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6772    integer bit width and for different address spaces. Not all targets support
6773    all bit widths however.</p>
6774
6775 <pre>
6776   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6777                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6778   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6779                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6780 </pre>
6781
6782 <h5>Overview:</h5>
6783 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6784    source location to the destination location.</p>
6785
6786 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6787    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6788    and the pointers can be in specified address spaces.</p>
6789
6790 <h5>Arguments:</h5>
6791
6792 <p>The first argument is a pointer to the destination, the second is a pointer
6793    to the source.  The third argument is an integer argument specifying the
6794    number of bytes to copy, the fourth argument is the alignment of the
6795    source and destination locations, and the fifth is a boolean indicating a
6796    volatile access.</p>
6797
6798 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6799    then the caller guarantees that both the source and destination pointers are
6800    aligned to that boundary.</p>
6801
6802 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6803    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6804    The detailed access behavior is not very cleanly specified and it is unwise
6805    to depend on it.</p>
6806
6807 <h5>Semantics:</h5>
6808
6809 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6810    source location to the destination location, which are not allowed to
6811    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6812    be aligned to some boundary, this can be specified as the fourth argument,
6813    otherwise it should be set to 0 or 1.</p>
6814
6815 </div>
6816
6817 <!-- _______________________________________________________________________ -->
6818 <h4>
6819   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6820 </h4>
6821
6822 <div>
6823
6824 <h5>Syntax:</h5>
6825 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6826    width and for different address space. Not all targets support all bit
6827    widths however.</p>
6828
6829 <pre>
6830   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6831                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6832   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6833                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6834 </pre>
6835
6836 <h5>Overview:</h5>
6837 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6838    source location to the destination location. It is similar to the
6839    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6840    overlap.</p>
6841
6842 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6843    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6844    and the pointers can be in specified address spaces.</p>
6845
6846 <h5>Arguments:</h5>
6847
6848 <p>The first argument is a pointer to the destination, the second is a pointer
6849    to the source.  The third argument is an integer argument specifying the
6850    number of bytes to copy, the fourth argument is the alignment of the
6851    source and destination locations, and the fifth is a boolean indicating a
6852    volatile access.</p>
6853
6854 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6855    then the caller guarantees that the source and destination pointers are
6856    aligned to that boundary.</p>
6857
6858 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6859    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6860    The detailed access behavior is not very cleanly specified and it is unwise
6861    to depend on it.</p>
6862
6863 <h5>Semantics:</h5>
6864
6865 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6866    source location to the destination location, which may overlap.  It copies
6867    "len" bytes of memory over.  If the argument is known to be aligned to some
6868    boundary, this can be specified as the fourth argument, otherwise it should
6869    be set to 0 or 1.</p>
6870
6871 </div>
6872
6873 <!-- _______________________________________________________________________ -->
6874 <h4>
6875   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6876 </h4>
6877
6878 <div>
6879
6880 <h5>Syntax:</h5>
6881 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6882    width and for different address spaces. However, not all targets support all
6883    bit widths.</p>
6884
6885 <pre>
6886   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6887                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6888   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6889                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6890 </pre>
6891
6892 <h5>Overview:</h5>
6893 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6894    particular byte value.</p>
6895
6896 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6897    intrinsic does not return a value and takes extra alignment/volatile
6898    arguments.  Also, the destination can be in an arbitrary address space.</p>
6899
6900 <h5>Arguments:</h5>
6901 <p>The first argument is a pointer to the destination to fill, the second is the
6902    byte value with which to fill it, the third argument is an integer argument
6903    specifying the number of bytes to fill, and the fourth argument is the known
6904    alignment of the destination location.</p>
6905
6906 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6907    then the caller guarantees that the destination pointer is aligned to that
6908    boundary.</p>
6909
6910 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6911    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6912    The detailed access behavior is not very cleanly specified and it is unwise
6913    to depend on it.</p>
6914
6915 <h5>Semantics:</h5>
6916 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6917    at the destination location.  If the argument is known to be aligned to some
6918    boundary, this can be specified as the fourth argument, otherwise it should
6919    be set to 0 or 1.</p>
6920
6921 </div>
6922
6923 <!-- _______________________________________________________________________ -->
6924 <h4>
6925   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6926 </h4>
6927
6928 <div>
6929
6930 <h5>Syntax:</h5>
6931 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6932    floating point or vector of floating point type. Not all targets support all
6933    types however.</p>
6934
6935 <pre>
6936   declare float     @llvm.sqrt.f32(float %Val)
6937   declare double    @llvm.sqrt.f64(double %Val)
6938   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6939   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6940   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6941 </pre>
6942
6943 <h5>Overview:</h5>
6944 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6945    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6946    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6947    behavior for negative numbers other than -0.0 (which allows for better
6948    optimization, because there is no need to worry about errno being
6949    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6950
6951 <h5>Arguments:</h5>
6952 <p>The argument and return value are floating point numbers of the same
6953    type.</p>
6954
6955 <h5>Semantics:</h5>
6956 <p>This function returns the sqrt of the specified operand if it is a
6957    nonnegative floating point number.</p>
6958
6959 </div>
6960
6961 <!-- _______________________________________________________________________ -->
6962 <h4>
6963   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6964 </h4>
6965
6966 <div>
6967
6968 <h5>Syntax:</h5>
6969 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6970    floating point or vector of floating point type. Not all targets support all
6971    types however.</p>
6972
6973 <pre>
6974   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6975   declare double    @llvm.powi.f64(double %Val, i32 %power)
6976   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6977   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6978   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6979 </pre>
6980
6981 <h5>Overview:</h5>
6982 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6983    specified (positive or negative) power.  The order of evaluation of
6984    multiplications is not defined.  When a vector of floating point type is
6985    used, the second argument remains a scalar integer value.</p>
6986
6987 <h5>Arguments:</h5>
6988 <p>The second argument is an integer power, and the first is a value to raise to
6989    that power.</p>
6990
6991 <h5>Semantics:</h5>
6992 <p>This function returns the first value raised to the second power with an
6993    unspecified sequence of rounding operations.</p>
6994
6995 </div>
6996
6997 <!-- _______________________________________________________________________ -->
6998 <h4>
6999   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
7000 </h4>
7001
7002 <div>
7003
7004 <h5>Syntax:</h5>
7005 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
7006    floating point or vector of floating point type. Not all targets support all
7007    types however.</p>
7008
7009 <pre>
7010   declare float     @llvm.sin.f32(float  %Val)
7011   declare double    @llvm.sin.f64(double %Val)
7012   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
7013   declare fp128     @llvm.sin.f128(fp128 %Val)
7014   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
7015 </pre>
7016
7017 <h5>Overview:</h5>
7018 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
7019
7020 <h5>Arguments:</h5>
7021 <p>The argument and return value are floating point numbers of the same
7022    type.</p>
7023
7024 <h5>Semantics:</h5>
7025 <p>This function returns the sine of the specified operand, returning the same
7026    values as the libm <tt>sin</tt> functions would, and handles error conditions
7027    in the same way.</p>
7028
7029 </div>
7030
7031 <!-- _______________________________________________________________________ -->
7032 <h4>
7033   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
7034 </h4>
7035
7036 <div>
7037
7038 <h5>Syntax:</h5>
7039 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
7040    floating point or vector of floating point type. Not all targets support all
7041    types however.</p>
7042
7043 <pre>
7044   declare float     @llvm.cos.f32(float  %Val)
7045   declare double    @llvm.cos.f64(double %Val)
7046   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
7047   declare fp128     @llvm.cos.f128(fp128 %Val)
7048   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
7049 </pre>
7050
7051 <h5>Overview:</h5>
7052 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
7053
7054 <h5>Arguments:</h5>
7055 <p>The argument and return value are floating point numbers of the same
7056    type.</p>
7057
7058 <h5>Semantics:</h5>
7059 <p>This function returns the cosine of the specified operand, returning the same
7060    values as the libm <tt>cos</tt> functions would, and handles error conditions
7061    in the same way.</p>
7062
7063 </div>
7064
7065 <!-- _______________________________________________________________________ -->
7066 <h4>
7067   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
7068 </h4>
7069
7070 <div>
7071
7072 <h5>Syntax:</h5>
7073 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
7074    floating point or vector of floating point type. Not all targets support all
7075    types however.</p>
7076
7077 <pre>
7078   declare float     @llvm.pow.f32(float  %Val, float %Power)
7079   declare double    @llvm.pow.f64(double %Val, double %Power)
7080   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
7081   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
7082   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
7083 </pre>
7084
7085 <h5>Overview:</h5>
7086 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
7087    specified (positive or negative) power.</p>
7088
7089 <h5>Arguments:</h5>
7090 <p>The second argument is a floating point power, and the first is a value to
7091    raise to that power.</p>
7092
7093 <h5>Semantics:</h5>
7094 <p>This function returns the first value raised to the second power, returning
7095    the same values as the libm <tt>pow</tt> functions would, and handles error
7096    conditions in the same way.</p>
7097
7098 </div>
7099
7100 <!-- _______________________________________________________________________ -->
7101 <h4>
7102   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
7103 </h4>
7104
7105 <div>
7106
7107 <h5>Syntax:</h5>
7108 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
7109    floating point or vector of floating point type. Not all targets support all
7110    types however.</p>
7111
7112 <pre>
7113   declare float     @llvm.exp.f32(float  %Val)
7114   declare double    @llvm.exp.f64(double %Val)
7115   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
7116   declare fp128     @llvm.exp.f128(fp128 %Val)
7117   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
7118 </pre>
7119
7120 <h5>Overview:</h5>
7121 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7122
7123 <h5>Arguments:</h5>
7124 <p>The argument and return value are floating point numbers of the same
7125    type.</p>
7126
7127 <h5>Semantics:</h5>
7128 <p>This function returns the same values as the libm <tt>exp</tt> functions
7129    would, and handles error conditions in the same way.</p>
7130
7131 </div>
7132
7133 <!-- _______________________________________________________________________ -->
7134 <h4>
7135   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7136 </h4>
7137
7138 <div>
7139
7140 <h5>Syntax:</h5>
7141 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7142    floating point or vector of floating point type. Not all targets support all
7143    types however.</p>
7144
7145 <pre>
7146   declare float     @llvm.log.f32(float  %Val)
7147   declare double    @llvm.log.f64(double %Val)
7148   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7149   declare fp128     @llvm.log.f128(fp128 %Val)
7150   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7151 </pre>
7152
7153 <h5>Overview:</h5>
7154 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7155
7156 <h5>Arguments:</h5>
7157 <p>The argument and return value are floating point numbers of the same
7158    type.</p>
7159
7160 <h5>Semantics:</h5>
7161 <p>This function returns the same values as the libm <tt>log</tt> functions
7162    would, and handles error conditions in the same way.</p>
7163
7164 </div>
7165
7166 <!-- _______________________________________________________________________ -->
7167 <h4>
7168   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7169 </h4>
7170
7171 <div>
7172
7173 <h5>Syntax:</h5>
7174 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7175    floating point or vector of floating point type. Not all targets support all
7176    types however.</p>
7177
7178 <pre>
7179   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7180   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7181   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7182   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7183   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7184 </pre>
7185
7186 <h5>Overview:</h5>
7187 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7188    operation.</p>
7189
7190 <h5>Arguments:</h5>
7191 <p>The argument and return value are floating point numbers of the same
7192    type.</p>
7193
7194 <h5>Semantics:</h5>
7195 <p>This function returns the same values as the libm <tt>fma</tt> functions
7196    would.</p>
7197
7198 </div>
7199
7200 </div>
7201
7202 <!-- ======================================================================= -->
7203 <h3>
7204   <a name="int_manip">Bit Manipulation Intrinsics</a>
7205 </h3>
7206
7207 <div>
7208
7209 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7210    These allow efficient code generation for some algorithms.</p>
7211
7212 <!-- _______________________________________________________________________ -->
7213 <h4>
7214   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7215 </h4>
7216
7217 <div>
7218
7219 <h5>Syntax:</h5>
7220 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7221    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7222
7223 <pre>
7224   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7225   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7226   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7227 </pre>
7228
7229 <h5>Overview:</h5>
7230 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7231    values with an even number of bytes (positive multiple of 16 bits).  These
7232    are useful for performing operations on data that is not in the target's
7233    native byte order.</p>
7234
7235 <h5>Semantics:</h5>
7236 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7237    and low byte of the input i16 swapped.  Similarly,
7238    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7239    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7240    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7241    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7242    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7243    more, respectively).</p>
7244
7245 </div>
7246
7247 <!-- _______________________________________________________________________ -->
7248 <h4>
7249   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7250 </h4>
7251
7252 <div>
7253
7254 <h5>Syntax:</h5>
7255 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7256    width, or on any vector with integer elements. Not all targets support all
7257   bit widths or vector types, however.</p>
7258
7259 <pre>
7260   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7261   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7262   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7263   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7264   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7265   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7266 </pre>
7267
7268 <h5>Overview:</h5>
7269 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7270    in a value.</p>
7271
7272 <h5>Arguments:</h5>
7273 <p>The only argument is the value to be counted.  The argument may be of any
7274    integer type, or a vector with integer elements.
7275    The return type must match the argument type.</p>
7276
7277 <h5>Semantics:</h5>
7278 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7279    element of a vector.</p>
7280
7281 </div>
7282
7283 <!-- _______________________________________________________________________ -->
7284 <h4>
7285   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7286 </h4>
7287
7288 <div>
7289
7290 <h5>Syntax:</h5>
7291 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7292    integer bit width, or any vector whose elements are integers. Not all
7293    targets support all bit widths or vector types, however.</p>
7294
7295 <pre>
7296   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
7297   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
7298   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
7299   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
7300   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
7301   declare &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src;gt)
7302 </pre>
7303
7304 <h5>Overview:</h5>
7305 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7306    leading zeros in a variable.</p>
7307
7308 <h5>Arguments:</h5>
7309 <p>The only argument is the value to be counted.  The argument may be of any
7310    integer type, or any vector type with integer element type.
7311    The return type must match the argument type.</p>
7312
7313 <h5>Semantics:</h5>
7314 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7315    zeros in a variable, or within each element of the vector if the operation
7316    is of vector type.  If the src == 0 then the result is the size in bits of
7317    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7318
7319 </div>
7320
7321 <!-- _______________________________________________________________________ -->
7322 <h4>
7323   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7324 </h4>
7325
7326 <div>
7327
7328 <h5>Syntax:</h5>
7329 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7330    integer bit width, or any vector of integer elements. Not all targets
7331    support all bit widths or vector types, however.</p>
7332
7333 <pre>
7334   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
7335   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
7336   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
7337   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
7338   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
7339   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7340 </pre>
7341
7342 <h5>Overview:</h5>
7343 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7344    trailing zeros.</p>
7345
7346 <h5>Arguments:</h5>
7347 <p>The only argument is the value to be counted.  The argument may be of any
7348    integer type, or a vectory with integer element type..  The return type
7349    must match the argument type.</p>
7350
7351 <h5>Semantics:</h5>
7352 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7353    zeros in a variable, or within each element of a vector.
7354    If the src == 0 then the result is the size in bits of
7355    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7356
7357 </div>
7358
7359 </div>
7360
7361 <!-- ======================================================================= -->
7362 <h3>
7363   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7364 </h3>
7365
7366 <div>
7367
7368 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7369
7370 <!-- _______________________________________________________________________ -->
7371 <h4>
7372   <a name="int_sadd_overflow">
7373     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7374   </a>
7375 </h4>
7376
7377 <div>
7378
7379 <h5>Syntax:</h5>
7380 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7381    on any integer bit width.</p>
7382
7383 <pre>
7384   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7385   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7386   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7387 </pre>
7388
7389 <h5>Overview:</h5>
7390 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7391    a signed addition of the two arguments, and indicate whether an overflow
7392    occurred during the signed summation.</p>
7393
7394 <h5>Arguments:</h5>
7395 <p>The arguments (%a and %b) and the first element of the result structure may
7396    be of integer types of any bit width, but they must have the same bit
7397    width. The second element of the result structure must be of
7398    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7399    undergo signed addition.</p>
7400
7401 <h5>Semantics:</h5>
7402 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7403    a signed addition of the two variables. They return a structure &mdash; the
7404    first element of which is the signed summation, and the second element of
7405    which is a bit specifying if the signed summation resulted in an
7406    overflow.</p>
7407
7408 <h5>Examples:</h5>
7409 <pre>
7410   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7411   %sum = extractvalue {i32, i1} %res, 0
7412   %obit = extractvalue {i32, i1} %res, 1
7413   br i1 %obit, label %overflow, label %normal
7414 </pre>
7415
7416 </div>
7417
7418 <!-- _______________________________________________________________________ -->
7419 <h4>
7420   <a name="int_uadd_overflow">
7421     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7422   </a>
7423 </h4>
7424
7425 <div>
7426
7427 <h5>Syntax:</h5>
7428 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7429    on any integer bit width.</p>
7430
7431 <pre>
7432   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7433   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7434   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7435 </pre>
7436
7437 <h5>Overview:</h5>
7438 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7439    an unsigned addition of the two arguments, and indicate whether a carry
7440    occurred during the unsigned summation.</p>
7441
7442 <h5>Arguments:</h5>
7443 <p>The arguments (%a and %b) and the first element of the result structure may
7444    be of integer types of any bit width, but they must have the same bit
7445    width. The second element of the result structure must be of
7446    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7447    undergo unsigned addition.</p>
7448
7449 <h5>Semantics:</h5>
7450 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7451    an unsigned addition of the two arguments. They return a structure &mdash;
7452    the first element of which is the sum, and the second element of which is a
7453    bit specifying if the unsigned summation resulted in a carry.</p>
7454
7455 <h5>Examples:</h5>
7456 <pre>
7457   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7458   %sum = extractvalue {i32, i1} %res, 0
7459   %obit = extractvalue {i32, i1} %res, 1
7460   br i1 %obit, label %carry, label %normal
7461 </pre>
7462
7463 </div>
7464
7465 <!-- _______________________________________________________________________ -->
7466 <h4>
7467   <a name="int_ssub_overflow">
7468     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7469   </a>
7470 </h4>
7471
7472 <div>
7473
7474 <h5>Syntax:</h5>
7475 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7476    on any integer bit width.</p>
7477
7478 <pre>
7479   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7480   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7481   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7482 </pre>
7483
7484 <h5>Overview:</h5>
7485 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7486    a signed subtraction of the two arguments, and indicate whether an overflow
7487    occurred during the signed subtraction.</p>
7488
7489 <h5>Arguments:</h5>
7490 <p>The arguments (%a and %b) and the first element of the result structure may
7491    be of integer types of any bit width, but they must have the same bit
7492    width. The second element of the result structure must be of
7493    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7494    undergo signed subtraction.</p>
7495
7496 <h5>Semantics:</h5>
7497 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7498    a signed subtraction of the two arguments. They return a structure &mdash;
7499    the first element of which is the subtraction, and the second element of
7500    which is a bit specifying if the signed subtraction resulted in an
7501    overflow.</p>
7502
7503 <h5>Examples:</h5>
7504 <pre>
7505   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7506   %sum = extractvalue {i32, i1} %res, 0
7507   %obit = extractvalue {i32, i1} %res, 1
7508   br i1 %obit, label %overflow, label %normal
7509 </pre>
7510
7511 </div>
7512
7513 <!-- _______________________________________________________________________ -->
7514 <h4>
7515   <a name="int_usub_overflow">
7516     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7517   </a>
7518 </h4>
7519
7520 <div>
7521
7522 <h5>Syntax:</h5>
7523 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7524    on any integer bit width.</p>
7525
7526 <pre>
7527   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7528   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7529   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7530 </pre>
7531
7532 <h5>Overview:</h5>
7533 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7534    an unsigned subtraction of the two arguments, and indicate whether an
7535    overflow occurred during the unsigned subtraction.</p>
7536
7537 <h5>Arguments:</h5>
7538 <p>The arguments (%a and %b) and the first element of the result structure may
7539    be of integer types of any bit width, but they must have the same bit
7540    width. The second element of the result structure must be of
7541    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7542    undergo unsigned subtraction.</p>
7543
7544 <h5>Semantics:</h5>
7545 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7546    an unsigned subtraction of the two arguments. They return a structure &mdash;
7547    the first element of which is the subtraction, and the second element of
7548    which is a bit specifying if the unsigned subtraction resulted in an
7549    overflow.</p>
7550
7551 <h5>Examples:</h5>
7552 <pre>
7553   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7554   %sum = extractvalue {i32, i1} %res, 0
7555   %obit = extractvalue {i32, i1} %res, 1
7556   br i1 %obit, label %overflow, label %normal
7557 </pre>
7558
7559 </div>
7560
7561 <!-- _______________________________________________________________________ -->
7562 <h4>
7563   <a name="int_smul_overflow">
7564     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7565   </a>
7566 </h4>
7567
7568 <div>
7569
7570 <h5>Syntax:</h5>
7571 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7572    on any integer bit width.</p>
7573
7574 <pre>
7575   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7576   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7577   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7578 </pre>
7579
7580 <h5>Overview:</h5>
7581
7582 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7583    a signed multiplication of the two arguments, and indicate whether an
7584    overflow occurred during the signed multiplication.</p>
7585
7586 <h5>Arguments:</h5>
7587 <p>The arguments (%a and %b) and the first element of the result structure may
7588    be of integer types of any bit width, but they must have the same bit
7589    width. The second element of the result structure must be of
7590    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7591    undergo signed multiplication.</p>
7592
7593 <h5>Semantics:</h5>
7594 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7595    a signed multiplication of the two arguments. They return a structure &mdash;
7596    the first element of which is the multiplication, and the second element of
7597    which is a bit specifying if the signed multiplication resulted in an
7598    overflow.</p>
7599
7600 <h5>Examples:</h5>
7601 <pre>
7602   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7603   %sum = extractvalue {i32, i1} %res, 0
7604   %obit = extractvalue {i32, i1} %res, 1
7605   br i1 %obit, label %overflow, label %normal
7606 </pre>
7607
7608 </div>
7609
7610 <!-- _______________________________________________________________________ -->
7611 <h4>
7612   <a name="int_umul_overflow">
7613     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7614   </a>
7615 </h4>
7616
7617 <div>
7618
7619 <h5>Syntax:</h5>
7620 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7621    on any integer bit width.</p>
7622
7623 <pre>
7624   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7625   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7626   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7627 </pre>
7628
7629 <h5>Overview:</h5>
7630 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7631    a unsigned multiplication of the two arguments, and indicate whether an
7632    overflow occurred during the unsigned multiplication.</p>
7633
7634 <h5>Arguments:</h5>
7635 <p>The arguments (%a and %b) and the first element of the result structure may
7636    be of integer types of any bit width, but they must have the same bit
7637    width. The second element of the result structure must be of
7638    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7639    undergo unsigned multiplication.</p>
7640
7641 <h5>Semantics:</h5>
7642 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7643    an unsigned multiplication of the two arguments. They return a structure
7644    &mdash; the first element of which is the multiplication, and the second
7645    element of which is a bit specifying if the unsigned multiplication resulted
7646    in an overflow.</p>
7647
7648 <h5>Examples:</h5>
7649 <pre>
7650   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7651   %sum = extractvalue {i32, i1} %res, 0
7652   %obit = extractvalue {i32, i1} %res, 1
7653   br i1 %obit, label %overflow, label %normal
7654 </pre>
7655
7656 </div>
7657
7658 </div>
7659
7660 <!-- ======================================================================= -->
7661 <h3>
7662   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7663 </h3>
7664
7665 <div>
7666
7667 <p>Half precision floating point is a storage-only format. This means that it is
7668    a dense encoding (in memory) but does not support computation in the
7669    format.</p>
7670
7671 <p>This means that code must first load the half-precision floating point
7672    value as an i16, then convert it to float with <a
7673    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7674    Computation can then be performed on the float value (including extending to
7675    double etc).  To store the value back to memory, it is first converted to
7676    float if needed, then converted to i16 with
7677    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7678    storing as an i16 value.</p>
7679
7680 <!-- _______________________________________________________________________ -->
7681 <h4>
7682   <a name="int_convert_to_fp16">
7683     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7684   </a>
7685 </h4>
7686
7687 <div>
7688
7689 <h5>Syntax:</h5>
7690 <pre>
7691   declare i16 @llvm.convert.to.fp16(f32 %a)
7692 </pre>
7693
7694 <h5>Overview:</h5>
7695 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7696    a conversion from single precision floating point format to half precision
7697    floating point format.</p>
7698
7699 <h5>Arguments:</h5>
7700 <p>The intrinsic function contains single argument - the value to be
7701    converted.</p>
7702
7703 <h5>Semantics:</h5>
7704 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7705    a conversion from single precision floating point format to half precision
7706    floating point format. The return value is an <tt>i16</tt> which
7707    contains the converted number.</p>
7708
7709 <h5>Examples:</h5>
7710 <pre>
7711   %res = call i16 @llvm.convert.to.fp16(f32 %a)
7712   store i16 %res, i16* @x, align 2
7713 </pre>
7714
7715 </div>
7716
7717 <!-- _______________________________________________________________________ -->
7718 <h4>
7719   <a name="int_convert_from_fp16">
7720     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
7721   </a>
7722 </h4>
7723
7724 <div>
7725
7726 <h5>Syntax:</h5>
7727 <pre>
7728   declare f32 @llvm.convert.from.fp16(i16 %a)
7729 </pre>
7730
7731 <h5>Overview:</h5>
7732 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
7733    a conversion from half precision floating point format to single precision
7734    floating point format.</p>
7735
7736 <h5>Arguments:</h5>
7737 <p>The intrinsic function contains single argument - the value to be
7738    converted.</p>
7739
7740 <h5>Semantics:</h5>
7741 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
7742    conversion from half single precision floating point format to single
7743    precision floating point format. The input half-float value is represented by
7744    an <tt>i16</tt> value.</p>
7745
7746 <h5>Examples:</h5>
7747 <pre>
7748   %a = load i16* @x, align 2
7749   %res = call f32 @llvm.convert.from.fp16(i16 %a)
7750 </pre>
7751
7752 </div>
7753
7754 </div>
7755
7756 <!-- ======================================================================= -->
7757 <h3>
7758   <a name="int_debugger">Debugger Intrinsics</a>
7759 </h3>
7760
7761 <div>
7762
7763 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
7764    prefix), are described in
7765    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
7766    Level Debugging</a> document.</p>
7767
7768 </div>
7769
7770 <!-- ======================================================================= -->
7771 <h3>
7772   <a name="int_eh">Exception Handling Intrinsics</a>
7773 </h3>
7774
7775 <div>
7776
7777 <p>The LLVM exception handling intrinsics (which all start with
7778    <tt>llvm.eh.</tt> prefix), are described in
7779    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
7780    Handling</a> document.</p>
7781
7782 </div>
7783
7784 <!-- ======================================================================= -->
7785 <h3>
7786   <a name="int_trampoline">Trampoline Intrinsics</a>
7787 </h3>
7788
7789 <div>
7790
7791 <p>These intrinsics make it possible to excise one parameter, marked with
7792    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
7793    The result is a callable
7794    function pointer lacking the nest parameter - the caller does not need to
7795    provide a value for it.  Instead, the value to use is stored in advance in a
7796    "trampoline", a block of memory usually allocated on the stack, which also
7797    contains code to splice the nest value into the argument list.  This is used
7798    to implement the GCC nested function address extension.</p>
7799
7800 <p>For example, if the function is
7801    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
7802    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
7803    follows:</p>
7804
7805 <pre class="doc_code">
7806   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
7807   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
7808   call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8*, i32, i32)* @f to i8*), i8* %nval)
7809   %p = call i8* @llvm.adjust.trampoline(i8* %tramp1)
7810   %fp = bitcast i8* %p to i32 (i32, i32)*
7811 </pre>
7812
7813 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
7814    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
7815
7816 <!-- _______________________________________________________________________ -->
7817 <h4>
7818   <a name="int_it">
7819     '<tt>llvm.init.trampoline</tt>' Intrinsic
7820   </a>
7821 </h4>
7822
7823 <div>
7824
7825 <h5>Syntax:</h5>
7826 <pre>
7827   declare void @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
7828 </pre>
7829
7830 <h5>Overview:</h5>
7831 <p>This fills the memory pointed to by <tt>tramp</tt> with executable code,
7832    turning it into a trampoline.</p>
7833
7834 <h5>Arguments:</h5>
7835 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
7836    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
7837    sufficiently aligned block of memory; this memory is written to by the
7838    intrinsic.  Note that the size and the alignment are target-specific - LLVM
7839    currently provides no portable way of determining them, so a front-end that
7840    generates this intrinsic needs to have some target-specific knowledge.
7841    The <tt>func</tt> argument must hold a function bitcast to
7842    an <tt>i8*</tt>.</p>
7843
7844 <h5>Semantics:</h5>
7845 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
7846    dependent code, turning it into a function.  Then <tt>tramp</tt> needs to be
7847    passed to <a href="#int_at">llvm.adjust.trampoline</a> to get a pointer
7848    which can be <a href="#int_trampoline">bitcast (to a new function) and
7849    called</a>.  The new function's signature is the same as that of
7850    <tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
7851    removed.  At most one such <tt>nest</tt> argument is allowed, and it must be of
7852    pointer type.  Calling the new function is equivalent to calling <tt>func</tt>
7853    with the same argument list, but with <tt>nval</tt> used for the missing
7854    <tt>nest</tt> argument.  If, after calling <tt>llvm.init.trampoline</tt>, the
7855    memory pointed to by <tt>tramp</tt> is modified, then the effect of any later call
7856    to the returned function pointer is undefined.</p>
7857 </div>
7858
7859 <!-- _______________________________________________________________________ -->
7860 <h4>
7861   <a name="int_at">
7862     '<tt>llvm.adjust.trampoline</tt>' Intrinsic
7863   </a>
7864 </h4>
7865
7866 <div>
7867
7868 <h5>Syntax:</h5>
7869 <pre>
7870   declare i8* @llvm.adjust.trampoline(i8* &lt;tramp&gt;)
7871 </pre>
7872
7873 <h5>Overview:</h5>
7874 <p>This performs any required machine-specific adjustment to the address of a
7875    trampoline (passed as <tt>tramp</tt>).</p>
7876
7877 <h5>Arguments:</h5>
7878 <p><tt>tramp</tt> must point to a block of memory which already has trampoline code
7879    filled in by a previous call to <a href="#int_it"><tt>llvm.init.trampoline</tt>
7880    </a>.</p>
7881
7882 <h5>Semantics:</h5>
7883 <p>On some architectures the address of the code to be executed needs to be
7884    different to the address where the trampoline is actually stored.  This
7885    intrinsic returns the executable address corresponding to <tt>tramp</tt>
7886    after performing the required machine specific adjustments.
7887    The pointer returned can then be <a href="#int_trampoline"> bitcast and
7888    executed</a>.
7889 </p>
7890
7891 </div>
7892
7893 </div>
7894
7895 <!-- ======================================================================= -->
7896 <h3>
7897   <a name="int_memorymarkers">Memory Use Markers</a>
7898 </h3>
7899
7900 <div>
7901
7902 <p>This class of intrinsics exists to information about the lifetime of memory
7903    objects and ranges where variables are immutable.</p>
7904
7905 <!-- _______________________________________________________________________ -->
7906 <h4>
7907   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7908 </h4>
7909
7910 <div>
7911
7912 <h5>Syntax:</h5>
7913 <pre>
7914   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7915 </pre>
7916
7917 <h5>Overview:</h5>
7918 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7919    object's lifetime.</p>
7920
7921 <h5>Arguments:</h5>
7922 <p>The first argument is a constant integer representing the size of the
7923    object, or -1 if it is variable sized.  The second argument is a pointer to
7924    the object.</p>
7925
7926 <h5>Semantics:</h5>
7927 <p>This intrinsic indicates that before this point in the code, the value of the
7928    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7929    never be used and has an undefined value.  A load from the pointer that
7930    precedes this intrinsic can be replaced with
7931    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7932
7933 </div>
7934
7935 <!-- _______________________________________________________________________ -->
7936 <h4>
7937   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7938 </h4>
7939
7940 <div>
7941
7942 <h5>Syntax:</h5>
7943 <pre>
7944   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7945 </pre>
7946
7947 <h5>Overview:</h5>
7948 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7949    object's lifetime.</p>
7950
7951 <h5>Arguments:</h5>
7952 <p>The first argument is a constant integer representing the size of the
7953    object, or -1 if it is variable sized.  The second argument is a pointer to
7954    the object.</p>
7955
7956 <h5>Semantics:</h5>
7957 <p>This intrinsic indicates that after this point in the code, the value of the
7958    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7959    never be used and has an undefined value.  Any stores into the memory object
7960    following this intrinsic may be removed as dead.
7961
7962 </div>
7963
7964 <!-- _______________________________________________________________________ -->
7965 <h4>
7966   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7967 </h4>
7968
7969 <div>
7970
7971 <h5>Syntax:</h5>
7972 <pre>
7973   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7974 </pre>
7975
7976 <h5>Overview:</h5>
7977 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7978    a memory object will not change.</p>
7979
7980 <h5>Arguments:</h5>
7981 <p>The first argument is a constant integer representing the size of the
7982    object, or -1 if it is variable sized.  The second argument is a pointer to
7983    the object.</p>
7984
7985 <h5>Semantics:</h5>
7986 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
7987    the return value, the referenced memory location is constant and
7988    unchanging.</p>
7989
7990 </div>
7991
7992 <!-- _______________________________________________________________________ -->
7993 <h4>
7994   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
7995 </h4>
7996
7997 <div>
7998
7999 <h5>Syntax:</h5>
8000 <pre>
8001   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8002 </pre>
8003
8004 <h5>Overview:</h5>
8005 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8006    a memory object are mutable.</p>
8007
8008 <h5>Arguments:</h5>
8009 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8010    The second argument is a constant integer representing the size of the
8011    object, or -1 if it is variable sized and the third argument is a pointer
8012    to the object.</p>
8013
8014 <h5>Semantics:</h5>
8015 <p>This intrinsic indicates that the memory is mutable again.</p>
8016
8017 </div>
8018
8019 </div>
8020
8021 <!-- ======================================================================= -->
8022 <h3>
8023   <a name="int_general">General Intrinsics</a>
8024 </h3>
8025
8026 <div>
8027
8028 <p>This class of intrinsics is designed to be generic and has no specific
8029    purpose.</p>
8030
8031 <!-- _______________________________________________________________________ -->
8032 <h4>
8033   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8034 </h4>
8035
8036 <div>
8037
8038 <h5>Syntax:</h5>
8039 <pre>
8040   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8041 </pre>
8042
8043 <h5>Overview:</h5>
8044 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8045
8046 <h5>Arguments:</h5>
8047 <p>The first argument is a pointer to a value, the second is a pointer to a
8048    global string, the third is a pointer to a global string which is the source
8049    file name, and the last argument is the line number.</p>
8050
8051 <h5>Semantics:</h5>
8052 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8053    This can be useful for special purpose optimizations that want to look for
8054    these annotations.  These have no other defined use; they are ignored by code
8055    generation and optimization.</p>
8056
8057 </div>
8058
8059 <!-- _______________________________________________________________________ -->
8060 <h4>
8061   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8062 </h4>
8063
8064 <div>
8065
8066 <h5>Syntax:</h5>
8067 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8068    any integer bit width.</p>
8069
8070 <pre>
8071   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8072   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8073   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8074   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8075   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8076 </pre>
8077
8078 <h5>Overview:</h5>
8079 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8080
8081 <h5>Arguments:</h5>
8082 <p>The first argument is an integer value (result of some expression), the
8083    second is a pointer to a global string, the third is a pointer to a global
8084    string which is the source file name, and the last argument is the line
8085    number.  It returns the value of the first argument.</p>
8086
8087 <h5>Semantics:</h5>
8088 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8089    arbitrary strings.  This can be useful for special purpose optimizations that
8090    want to look for these annotations.  These have no other defined use; they
8091    are ignored by code generation and optimization.</p>
8092
8093 </div>
8094
8095 <!-- _______________________________________________________________________ -->
8096 <h4>
8097   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8098 </h4>
8099
8100 <div>
8101
8102 <h5>Syntax:</h5>
8103 <pre>
8104   declare void @llvm.trap()
8105 </pre>
8106
8107 <h5>Overview:</h5>
8108 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8109
8110 <h5>Arguments:</h5>
8111 <p>None.</p>
8112
8113 <h5>Semantics:</h5>
8114 <p>This intrinsics is lowered to the target dependent trap instruction. If the
8115    target does not have a trap instruction, this intrinsic will be lowered to
8116    the call of the <tt>abort()</tt> function.</p>
8117
8118 </div>
8119
8120 <!-- _______________________________________________________________________ -->
8121 <h4>
8122   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8123 </h4>
8124
8125 <div>
8126
8127 <h5>Syntax:</h5>
8128 <pre>
8129   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8130 </pre>
8131
8132 <h5>Overview:</h5>
8133 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8134    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8135    ensure that it is placed on the stack before local variables.</p>
8136
8137 <h5>Arguments:</h5>
8138 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8139    arguments. The first argument is the value loaded from the stack
8140    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8141    that has enough space to hold the value of the guard.</p>
8142
8143 <h5>Semantics:</h5>
8144 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8145    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8146    stack. This is to ensure that if a local variable on the stack is
8147    overwritten, it will destroy the value of the guard. When the function exits,
8148    the guard on the stack is checked against the original guard. If they are
8149    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8150    function.</p>
8151
8152 </div>
8153
8154 <!-- _______________________________________________________________________ -->
8155 <h4>
8156   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8157 </h4>
8158
8159 <div>
8160
8161 <h5>Syntax:</h5>
8162 <pre>
8163   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
8164   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
8165 </pre>
8166
8167 <h5>Overview:</h5>
8168 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8169    the optimizers to determine at compile time whether a) an operation (like
8170    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8171    runtime check for overflow isn't necessary. An object in this context means
8172    an allocation of a specific class, structure, array, or other object.</p>
8173
8174 <h5>Arguments:</h5>
8175 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8176    argument is a pointer to or into the <tt>object</tt>. The second argument
8177    is a boolean 0 or 1. This argument determines whether you want the
8178    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
8179    1, variables are not allowed.</p>
8180
8181 <h5>Semantics:</h5>
8182 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
8183    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
8184    depending on the <tt>type</tt> argument, if the size cannot be determined at
8185    compile time.</p>
8186
8187 </div>
8188
8189 </div>
8190
8191 </div>
8192
8193 <!-- *********************************************************************** -->
8194 <hr>
8195 <address>
8196   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8197   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8198   <a href="http://validator.w3.org/check/referer"><img
8199   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8200
8201   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8202   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8203   Last modified: $Date$
8204 </address>
8205
8206 </body>
8207 </html>