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="_static/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="#poisonvalues">Poison 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="#fpmath">'<tt>fpmath</tt>' Metadata</a></li>
 107           <li><a href="#range">'<tt>range</tt>' Metadata</a></li>
 108         </ol>
 109       </li>
 110     </ol>
 111   </li>
 112   <li><a href="#module_flags">Module Flags Metadata</a>
 113     <ol>
 114       <li><a href="#objc_gc_flags">Objective-C Garbage Collection Module Flags Metadata</a></li>
 115     </ol>
 116   </li>
 117   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 118     <ol>
 119       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 120       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 121           Global Variable</a></li>
 122       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 123          Global Variable</a></li>
 124       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 125          Global Variable</a></li>
 126     </ol>
 127   </li>
 128   <li><a href="#instref">Instruction Reference</a>
 129     <ol>
 130       <li><a href="#terminators">Terminator Instructions</a>
 131         <ol>
 132           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 133           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 134           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 135           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 136           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 137           <li><a href="#i_resume">'<tt>resume</tt>'  Instruction</a></li>
 138           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 139         </ol>
 140       </li>
 141       <li><a href="#binaryops">Binary Operations</a>
 142         <ol>
 143           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 144           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 145           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 146           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 147           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 148           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 149           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 150           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 151           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 152           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 153           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 154           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 155         </ol>
 156       </li>
 157       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 158         <ol>
 159           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 160           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 161           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 162           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 163           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 164           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 165         </ol>
 166       </li>
 167       <li><a href="#vectorops">Vector Operations</a>
 168         <ol>
 169           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 170           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 171           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 172         </ol>
 173       </li>
 174       <li><a href="#aggregateops">Aggregate Operations</a>
 175         <ol>
 176           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 177           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 178         </ol>
 179       </li>
 180       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 181         <ol>
 182           <li><a href="#i_alloca">'<tt>alloca</tt>' Instruction</a></li>
 183          <li><a href="#i_load">'<tt>load</tt>' Instruction</a></li>
 184          <li><a href="#i_store">'<tt>store</tt>' Instruction</a></li>
 185          <li><a href="#i_fence">'<tt>fence</tt>' Instruction</a></li>
 186          <li><a href="#i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a></li>
 187          <li><a href="#i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a></li>
 188          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 189         </ol>
 190       </li>
 191       <li><a href="#convertops">Conversion Operations</a>
 192         <ol>
 193           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 194           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 195           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 196           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 197           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 198           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 199           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 200           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 201           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 202           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 203           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 204           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 205         </ol>
 206       </li>
 207       <li><a href="#otherops">Other Operations</a>
 208         <ol>
 209           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 210           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 211           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 212           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 213           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 214           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 215           <li><a href="#i_landingpad">'<tt>landingpad</tt>' Instruction</a></li>
 216         </ol>
 217       </li>
 218     </ol>
 219   </li>
 220   <li><a href="#intrinsics">Intrinsic Functions</a>
 221     <ol>
 222       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 223         <ol>
 224           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 225           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 226           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 227         </ol>
 228       </li>
 229       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 230         <ol>
 231           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 232           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 233           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 234         </ol>
 235       </li>
 236       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 237         <ol>
 238           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 239           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 240           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 241           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 242           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 243           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 244           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 245         </ol>
 246       </li>
 247       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 248         <ol>
 249           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 250           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 251           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 252           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 253           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 254           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 255           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 256           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 257           <li><a href="#int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a></li>
 258           <li><a href="#int_log">'<tt>llvm.log.*</tt>' Intrinsic</a></li>
 259           <li><a href="#int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a></li>
 260         </ol>
 261       </li>
 262       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 263         <ol>
 264           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 265           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 266           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 267           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 268         </ol>
 269       </li>
 270       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 271         <ol>
 272           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 273           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 274           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 275           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 276           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 277           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 278         </ol>
 279       </li>
 280       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 281         <ol>
 282           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 283           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 284         </ol>
 285       </li>
 286       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 287       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 288       <li><a href="#int_trampoline">Trampoline Intrinsics</a>
 289         <ol>
 290           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 291           <li><a href="#int_at">'<tt>llvm.adjust.trampoline</tt>' Intrinsic</a></li>
 292         </ol>
 293       </li>
 294       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 295         <ol>
 296           <li><a href="#int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a></li>
 297           <li><a href="#int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a></li>
 298           <li><a href="#int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a></li>
 299           <li><a href="#int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a></li>
 300         </ol>
 301       </li>
 302       <li><a href="#int_general">General intrinsics</a>
 303         <ol>
 304           <li><a href="#int_var_annotation">
 305             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 306           <li><a href="#int_annotation">
 307             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 308           <li><a href="#int_trap">
 309             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 310           <li><a href="#int_debugtrap">
 311             '<tt>llvm.debugtrap</tt>' Intrinsic</a></li>
 312           <li><a href="#int_stackprotector">
 313             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 314           <li><a href="#int_objectsize">
 315             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 316           <li><a href="#int_expect">
 317             '<tt>llvm.expect</tt>' Intrinsic</a></li>
 318         </ol>
 319       </li>
 320     </ol>
 321   </li>
 322 </ol>
 323
 324 <div class="doc_author">
 325   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 326             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 327 </div>
 328
 329 <!-- *********************************************************************** -->
 330 <h2><a name="abstract">Abstract</a></h2>
 331 <!-- *********************************************************************** -->
 332
 333 <div>
 334
 335 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 336    a Static Single Assignment (SSA) based representation that provides type
 337    safety, low-level operations, flexibility, and the capability of representing
 338    'all' high-level languages cleanly.  It is the common code representation
 339    used throughout all phases of the LLVM compilation strategy.</p>
 340
 341 </div>
 342
 343 <!-- *********************************************************************** -->
 344 <h2><a name="introduction">Introduction</a></h2>
 345 <!-- *********************************************************************** -->
 346
 347 <div>
 348
 349 <p>The LLVM code representation is designed to be used in three different forms:
 350    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 351    for fast loading by a Just-In-Time compiler), and as a human readable
 352    assembly language representation.  This allows LLVM to provide a powerful
 353    intermediate representation for efficient compiler transformations and
 354    analysis, while providing a natural means to debug and visualize the
 355    transformations.  The three different forms of LLVM are all equivalent.  This
 356    document describes the human readable representation and notation.</p>
 357
 358 <p>The LLVM representation aims to be light-weight and low-level while being
 359    expressive, typed, and extensible at the same time.  It aims to be a
 360    "universal IR" of sorts, by being at a low enough level that high-level ideas
 361    may be cleanly mapped to it (similar to how microprocessors are "universal
 362    IR's", allowing many source languages to be mapped to them).  By providing
 363    type information, LLVM can be used as the target of optimizations: for
 364    example, through pointer analysis, it can be proven that a C automatic
 365    variable is never accessed outside of the current function, allowing it to
 366    be promoted to a simple SSA value instead of a memory location.</p>
 367
 368 <!-- _______________________________________________________________________ -->
 369 <h4>
 370   <a name="wellformed">Well-Formedness</a>
 371 </h4>
 372
 373 <div>
 374
 375 <p>It is important to note that this document describes 'well formed' LLVM
 376    assembly language.  There is a difference between what the parser accepts and
 377    what is considered 'well formed'.  For example, the following instruction is
 378    syntactically okay, but not well formed:</p>
 379
 380 <pre class="doc_code">
 381 %x = <a href="#i_add">add</a> i32 1, %x
 382 </pre>
 383
 384 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 385    LLVM infrastructure provides a verification pass that may be used to verify
 386    that an LLVM module is well formed.  This pass is automatically run by the
 387    parser after parsing input assembly and by the optimizer before it outputs
 388    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 389    transformation passes or input to the parser.</p>
 390
 391 </div>
 392
 393 </div>
 394
 395 <!-- Describe the typesetting conventions here. -->
 396
 397 <!-- *********************************************************************** -->
 398 <h2><a name="identifiers">Identifiers</a></h2>
 399 <!-- *********************************************************************** -->
 400
 401 <div>
 402
 403 <p>LLVM identifiers come in two basic types: global and local. Global
 404    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 405    character. Local identifiers (register names, types) begin with
 406    the <tt>'%'</tt> character. Additionally, there are three different formats
 407    for identifiers, for different purposes:</p>
 408
 409 <ol>
 410   <li>Named values are represented as a string of characters with their prefix.
 411       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 412       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 413       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 414       other characters in their names can be surrounded with quotes. Special
 415       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 416       ASCII code for the character in hexadecimal.  In this way, any character
 417       can be used in a name value, even quotes themselves.</li>
 418
 419   <li>Unnamed values are represented as an unsigned numeric value with their
 420       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 421
 422   <li>Constants, which are described in a <a href="#constants">section about
 423       constants</a>, below.</li>
 424 </ol>
 425
 426 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 427    don't need to worry about name clashes with reserved words, and the set of
 428    reserved words may be expanded in the future without penalty.  Additionally,
 429    unnamed identifiers allow a compiler to quickly come up with a temporary
 430    variable without having to avoid symbol table conflicts.</p>
 431
 432 <p>Reserved words in LLVM are very similar to reserved words in other
 433    languages. There are keywords for different opcodes
 434    ('<tt><a href="#i_add">add</a></tt>',
 435    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 436    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 437    ('<tt><a href="#t_void">void</a></tt>',
 438    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 439    reserved words cannot conflict with variable names, because none of them
 440    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 441
 442 <p>Here is an example of LLVM code to multiply the integer variable
 443    '<tt>%X</tt>' by 8:</p>
 444
 445 <p>The easy way:</p>
 446
 447 <pre class="doc_code">
 448 %result = <a href="#i_mul">mul</a> i32 %X, 8
 449 </pre>
 450
 451 <p>After strength reduction:</p>
 452
 453 <pre class="doc_code">
 454 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 455 </pre>
 456
 457 <p>And the hard way:</p>
 458
 459 <pre class="doc_code">
 460 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 461 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 462 %result = <a href="#i_add">add</a> i32 %1, %1
 463 </pre>
 464
 465 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 466    lexical features of LLVM:</p>
 467
 468 <ol>
 469   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 470       line.</li>
 471
 472   <li>Unnamed temporaries are created when the result of a computation is not
 473       assigned to a named value.</li>
 474
 475   <li>Unnamed temporaries are numbered sequentially</li>
 476 </ol>
 477
 478 <p>It also shows a convention that we follow in this document.  When
 479    demonstrating instructions, we will follow an instruction with a comment that
 480    defines the type and name of value produced.  Comments are shown in italic
 481    text.</p>
 482
 483 </div>
 484
 485 <!-- *********************************************************************** -->
 486 <h2><a name="highlevel">High Level Structure</a></h2>
 487 <!-- *********************************************************************** -->
 488 <div>
 489 <!-- ======================================================================= -->
 490 <h3>
 491   <a name="modulestructure">Module Structure</a>
 492 </h3>
 493
 494 <div>
 495
 496 <p>LLVM programs are composed of <tt>Module</tt>s, each of which is a
 497    translation unit of the input programs.  Each module consists of functions,
 498    global variables, and symbol table entries.  Modules may be combined together
 499    with the LLVM linker, which merges function (and global variable)
 500    definitions, resolves forward declarations, and merges symbol table
 501    entries. Here is an example of the "hello world" module:</p>
 502
 503 <pre class="doc_code">
 504 <i>; Declare the string constant as a global constant.</i>&nbsp;
 505 <a href="#identifiers">@.str</a> = <a href="#linkage_private">private</a>&nbsp;<a href="#globalvars">unnamed_addr</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"&nbsp;
 506
 507 <i>; External declaration of the puts function</i>&nbsp;
 508 <a href="#functionstructure">declare</a> i32 @puts(i8* <a href="#nocapture">nocapture</a>) <a href="#fnattrs">nounwind</a>&nbsp;
 509
 510 <i>; Definition of main function</i>
 511 define i32 @main() {   <i>; i32()* </i>&nbsp;
 512   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 513   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.str, i64 0, i64 0
 514
 515   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 516   <a href="#i_call">call</a> i32 @puts(i8* %cast210)
 517   <a href="#i_ret">ret</a> i32 0&nbsp;
 518 }
 519
 520 <i>; Named metadata</i>
 521 !1 = metadata !{i32 42}
 522 !foo = !{!1, null}
 523 </pre>
 524
 525 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 526    "<tt>.str</tt>", an external declaration of the "<tt>puts</tt>" function,
 527    a <a href="#functionstructure">function definition</a> for
 528    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 529    "<tt>foo</tt>".</p>
 530
 531 <p>In general, a module is made up of a list of global values (where both
 532    functions and global variables are global values). Global values are
 533    represented by a pointer to a memory location (in this case, a pointer to an
 534    array of char, and a pointer to a function), and have one of the
 535    following <a href="#linkage">linkage types</a>.</p>
 536
 537 </div>
 538
 539 <!-- ======================================================================= -->
 540 <h3>
 541   <a name="linkage">Linkage Types</a>
 542 </h3>
 543
 544 <div>
 545
 546 <p>All Global Variables and Functions have one of the following types of
 547    linkage:</p>
 548
 549 <dl>
 550   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 551   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 552       by objects in the current module. In particular, linking code into a
 553       module with an private global value may cause the private to be renamed as
 554       necessary to avoid collisions.  Because the symbol is private to the
 555       module, all references can be updated. This doesn't show up in any symbol
 556       table in the object file.</dd>
 557
 558   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 559   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 560       assembler and evaluated by the linker. Unlike normal strong symbols, they
 561       are removed by the linker from the final linked image (executable or
 562       dynamic library).</dd>
 563
 564   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 565   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 566       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 567       linker. The symbols are removed by the linker from the final linked image
 568       (executable or dynamic library).</dd>
 569
 570   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 571   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 572       of the object is not taken. For instance, functions that had an inline
 573       definition, but the compiler decided not to inline it. Note,
 574       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 575       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 576       visibility.  The symbols are removed by the linker from the final linked
 577       image (executable or dynamic library).</dd>
 578
 579   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 580   <dd>Similar to private, but the value shows as a local symbol
 581       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 582       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 583
 584   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 585   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 586       into the object file corresponding to the LLVM module.  They exist to
 587       allow inlining and other optimizations to take place given knowledge of
 588       the definition of the global, which is known to be somewhere outside the
 589       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 590       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 591       This linkage type is only allowed on definitions, not declarations.</dd>
 592
 593   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 594   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 595       the same name when linkage occurs.  This can be used to implement
 596       some forms of inline functions, templates, or other code which must be
 597       generated in each translation unit that uses it, but where the body may
 598       be overridden with a more definitive definition later.  Unreferenced
 599       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 600       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 601       inline the body of this function into callers because it doesn't know if
 602       this definition of the function is the definitive definition within the
 603       program or whether it will be overridden by a stronger definition.
 604       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 605       linkage.</dd>
 606
 607   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 608   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 609       <tt>linkonce</tt> linkage, except that unreferenced globals with
 610       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 611       are declared "weak" in C source code.</dd>
 612
 613   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 614   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 615       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 616       global scope.
 617       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 618       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 619       <tt>common</tt> symbols may not have an explicit section,
 620       must have a zero initializer, and may not be marked '<a
 621       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 622       have common linkage.</dd>
 623
 624
 625   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 626   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 627       pointer to array type.  When two global variables with appending linkage
 628       are linked together, the two global arrays are appended together.  This is
 629       the LLVM, typesafe, equivalent of having the system linker append together
 630       "sections" with identical names when .o files are linked.</dd>
 631
 632   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 633   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 634       is weak until linked, if not linked, the symbol becomes null instead of
 635       being an undefined reference.</dd>
 636
 637   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 638   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 639   <dd>Some languages allow differing globals to be merged, such as two functions
 640       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 641       that only equivalent globals are ever merged (the "one definition rule"
 642       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 643       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 644       be merged with equivalent globals.  These linkage types are otherwise the
 645       same as their non-<tt>odr</tt> versions.</dd>
 646
 647   <dt><tt><b><a name="linkage_external">external</a></b></tt></dt>
 648   <dd>If none of the above identifiers are used, the global is externally
 649       visible, meaning that it participates in linkage and can be used to
 650       resolve external symbol references.</dd>
 651 </dl>
 652
 653 <p>The next two types of linkage are targeted for Microsoft Windows platform
 654    only. They are designed to support importing (exporting) symbols from (to)
 655    DLLs (Dynamic Link Libraries).</p>
 656
 657 <dl>
 658   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 659   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 660       or variable via a global pointer to a pointer that is set up by the DLL
 661       exporting the symbol. On Microsoft Windows targets, the pointer name is
 662       formed by combining <code>__imp_</code> and the function or variable
 663       name.</dd>
 664
 665   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 666   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 667       pointer to a pointer in a DLL, so that it can be referenced with the
 668       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 669       name is formed by combining <code>__imp_</code> and the function or
 670       variable name.</dd>
 671 </dl>
 672
 673 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 674    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 675    one, one of the two would be renamed, preventing a collision.  Since
 676    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 677    declarations), they are accessible outside of the current module.</p>
 678
 679 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 680    other than <tt>external</tt>, <tt>dllimport</tt>
 681   or <tt>extern_weak</tt>.</p>
 682
 683 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 684    or <tt>weak_odr</tt> linkages.</p>
 685
 686 </div>
 687
 688 <!-- ======================================================================= -->
 689 <h3>
 690   <a name="callingconv">Calling Conventions</a>
 691 </h3>
 692
 693 <div>
 694
 695 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 696    and <a href="#i_invoke">invokes</a> can all have an optional calling
 697    convention specified for the call.  The calling convention of any pair of
 698    dynamic caller/callee must match, or the behavior of the program is
 699    undefined.  The following calling conventions are supported by LLVM, and more
 700    may be added in the future:</p>
 701
 702 <dl>
 703   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 704   <dd>This calling convention (the default if no other calling convention is
 705       specified) matches the target C calling conventions.  This calling
 706       convention supports varargs function calls and tolerates some mismatch in
 707       the declared prototype and implemented declaration of the function (as
 708       does normal C).</dd>
 709
 710   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 711   <dd>This calling convention attempts to make calls as fast as possible
 712       (e.g. by passing things in registers).  This calling convention allows the
 713       target to use whatever tricks it wants to produce fast code for the
 714       target, without having to conform to an externally specified ABI
 715       (Application Binary Interface).
 716       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 717       when this or the GHC convention is used.</a>  This calling convention
 718       does not support varargs and requires the prototype of all callees to
 719       exactly match the prototype of the function definition.</dd>
 720
 721   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 722   <dd>This calling convention attempts to make code in the caller as efficient
 723       as possible under the assumption that the call is not commonly executed.
 724       As such, these calls often preserve all registers so that the call does
 725       not break any live ranges in the caller side.  This calling convention
 726       does not support varargs and requires the prototype of all callees to
 727       exactly match the prototype of the function definition.</dd>
 728
 729   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 730   <dd>This calling convention has been implemented specifically for use by the
 731       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 732       It passes everything in registers, going to extremes to achieve this by
 733       disabling callee save registers. This calling convention should not be
 734       used lightly but only for specific situations such as an alternative to
 735       the <em>register pinning</em> performance technique often used when
 736       implementing functional programming languages.At the moment only X86
 737       supports this convention and it has the following limitations:
 738       <ul>
 739         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 740             floating point types are supported.</li>
 741         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 742             6 floating point parameters.</li>
 743       </ul>
 744       This calling convention supports
 745       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 746       requires both the caller and callee are using it.
 747   </dd>
 748
 749   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 750   <dd>Any calling convention may be specified by number, allowing
 751       target-specific calling conventions to be used.  Target specific calling
 752       conventions start at 64.</dd>
 753 </dl>
 754
 755 <p>More calling conventions can be added/defined on an as-needed basis, to
 756    support Pascal conventions or any other well-known target-independent
 757    convention.</p>
 758
 759 </div>
 760
 761 <!-- ======================================================================= -->
 762 <h3>
 763   <a name="visibility">Visibility Styles</a>
 764 </h3>
 765
 766 <div>
 767
 768 <p>All Global Variables and Functions have one of the following visibility
 769    styles:</p>
 770
 771 <dl>
 772   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 773   <dd>On targets that use the ELF object file format, default visibility means
 774       that the declaration is visible to other modules and, in shared libraries,
 775       means that the declared entity may be overridden. On Darwin, default
 776       visibility means that the declaration is visible to other modules. Default
 777       visibility corresponds to "external linkage" in the language.</dd>
 778
 779   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 780   <dd>Two declarations of an object with hidden visibility refer to the same
 781       object if they are in the same shared object. Usually, hidden visibility
 782       indicates that the symbol will not be placed into the dynamic symbol
 783       table, so no other module (executable or shared library) can reference it
 784       directly.</dd>
 785
 786   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 787   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 788       the dynamic symbol table, but that references within the defining module
 789       will bind to the local symbol. That is, the symbol cannot be overridden by
 790       another module.</dd>
 791 </dl>
 792
 793 </div>
 794
 795 <!-- ======================================================================= -->
 796 <h3>
 797   <a name="namedtypes">Named Types</a>
 798 </h3>
 799
 800 <div>
 801
 802 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 803    it easier to read the IR and make the IR more condensed (particularly when
 804    recursive types are involved).  An example of a name specification is:</p>
 805
 806 <pre class="doc_code">
 807 %mytype = type { %mytype*, i32 }
 808 </pre>
 809
 810 <p>You may give a name to any <a href="#typesystem">type</a> except
 811    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 812    is expected with the syntax "%mytype".</p>
 813
 814 <p>Note that type names are aliases for the structural type that they indicate,
 815    and that you can therefore specify multiple names for the same type.  This
 816    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 817    uses structural typing, the name is not part of the type.  When printing out
 818    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 819    particular shape.  This means that if you have code where two different
 820    source types end up having the same LLVM type, that the dumper will sometimes
 821    print the "wrong" or unexpected type.  This is an important design point and
 822    isn't going to change.</p>
 823
 824 </div>
 825
 826 <!-- ======================================================================= -->
 827 <h3>
 828   <a name="globalvars">Global Variables</a>
 829 </h3>
 830
 831 <div>
 832
 833 <p>Global variables define regions of memory allocated at compilation time
 834    instead of run-time.  Global variables may optionally be initialized, may
 835    have an explicit section to be placed in, and may have an optional explicit
 836    alignment specified.  A variable may be defined as "thread_local", which
 837    means that it will not be shared by threads (each thread will have a
 838    separated copy of the variable).  A variable may be defined as a global
 839    "constant," which indicates that the contents of the variable
 840    will <b>never</b> be modified (enabling better optimization, allowing the
 841    global data to be placed in the read-only section of an executable, etc).
 842    Note that variables that need runtime initialization cannot be marked
 843    "constant" as there is a store to the variable.</p>
 844
 845 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 846    constant, even if the final definition of the global is not.  This capability
 847    can be used to enable slightly better optimization of the program, but
 848    requires the language definition to guarantee that optimizations based on the
 849    'constantness' are valid for the translation units that do not include the
 850    definition.</p>
 851
 852 <p>As SSA values, global variables define pointer values that are in scope
 853    (i.e. they dominate) all basic blocks in the program.  Global variables
 854    always define a pointer to their "content" type because they describe a
 855    region of memory, and all memory objects in LLVM are accessed through
 856    pointers.</p>
 857
 858 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 859   that the address is not significant, only the content. Constants marked
 860   like this can be merged with other constants if they have the same
 861   initializer. Note that a constant with significant address <em>can</em>
 862   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 863   constant whose address is significant.</p>
 864
 865 <p>A global variable may be declared to reside in a target-specific numbered
 866    address space. For targets that support them, address spaces may affect how
 867    optimizations are performed and/or what target instructions are used to
 868    access the variable. The default address space is zero. The address space
 869    qualifier must precede any other attributes.</p>
 870
 871 <p>LLVM allows an explicit section to be specified for globals.  If the target
 872    supports it, it will emit globals to the section specified.</p>
 873
 874 <p>An explicit alignment may be specified for a global, which must be a power
 875    of 2.  If not present, or if the alignment is set to zero, the alignment of
 876    the global is set by the target to whatever it feels convenient.  If an
 877    explicit alignment is specified, the global is forced to have exactly that
 878    alignment.  Targets and optimizers are not allowed to over-align the global
 879    if the global has an assigned section.  In this case, the extra alignment
 880    could be observable: for example, code could assume that the globals are
 881    densely packed in their section and try to iterate over them as an array,
 882    alignment padding would break this iteration.</p>
 883
 884 <p>For example, the following defines a global in a numbered address space with
 885    an initializer, section, and alignment:</p>
 886
 887 <pre class="doc_code">
 888 @G = addrspace(5) constant float 1.0, section "foo", align 4
 889 </pre>
 890
 891 </div>
 892
 893
 894 <!-- ======================================================================= -->
 895 <h3>
 896   <a name="functionstructure">Functions</a>
 897 </h3>
 898
 899 <div>
 900
 901 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 902    optional <a href="#linkage">linkage type</a>, an optional
 903    <a href="#visibility">visibility style</a>, an optional
 904    <a href="#callingconv">calling convention</a>,
 905    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 906    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 907    name, a (possibly empty) argument list (each with optional
 908    <a href="#paramattrs">parameter attributes</a>), optional
 909    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 910    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 911    curly brace, a list of basic blocks, and a closing curly brace.</p>
 912
 913 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 914    optional <a href="#linkage">linkage type</a>, an optional
 915    <a href="#visibility">visibility style</a>, an optional
 916    <a href="#callingconv">calling convention</a>,
 917    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 918    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 919    name, a possibly empty list of arguments, an optional alignment, and an
 920    optional <a href="#gc">garbage collector name</a>.</p>
 921
 922 <p>A function definition contains a list of basic blocks, forming the CFG
 923    (Control Flow Graph) for the function.  Each basic block may optionally start
 924    with a label (giving the basic block a symbol table entry), contains a list
 925    of instructions, and ends with a <a href="#terminators">terminator</a>
 926    instruction (such as a branch or function return).</p>
 927
 928 <p>The first basic block in a function is special in two ways: it is immediately
 929    executed on entrance to the function, and it is not allowed to have
 930    predecessor basic blocks (i.e. there can not be any branches to the entry
 931    block of a function).  Because the block can have no predecessors, it also
 932    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 933
 934 <p>LLVM allows an explicit section to be specified for functions.  If the target
 935    supports it, it will emit functions to the section specified.</p>
 936
 937 <p>An explicit alignment may be specified for a function.  If not present, or if
 938    the alignment is set to zero, the alignment of the function is set by the
 939    target to whatever it feels convenient.  If an explicit alignment is
 940    specified, the function is forced to have at least that much alignment.  All
 941    alignments must be a power of 2.</p>
 942
 943 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 944    be significant and two identical functions can be merged.</p>
 945
 946 <h5>Syntax:</h5>
 947 <pre class="doc_code">
 948 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 949        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 950        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 951        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 952        [<a href="#gc">gc</a>] { ... }
 953 </pre>
 954
 955 </div>
 956
 957 <!-- ======================================================================= -->
 958 <h3>
 959   <a name="aliasstructure">Aliases</a>
 960 </h3>
 961
 962 <div>
 963
 964 <p>Aliases act as "second name" for the aliasee value (which can be either
 965    function, global variable, another alias or bitcast of global value). Aliases
 966    may have an optional <a href="#linkage">linkage type</a>, and an
 967    optional <a href="#visibility">visibility style</a>.</p>
 968
 969 <h5>Syntax:</h5>
 970 <pre class="doc_code">
 971 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 972 </pre>
 973
 974 </div>
 975
 976 <!-- ======================================================================= -->
 977 <h3>
 978   <a name="namedmetadatastructure">Named Metadata</a>
 979 </h3>
 980
 981 <div>
 982
 983 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 984    nodes</a> (but not metadata strings) are the only valid operands for
 985    a named metadata.</p>
 986
 987 <h5>Syntax:</h5>
 988 <pre class="doc_code">
 989 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 990 !0 = metadata !{metadata !"zero"}
 991 !1 = metadata !{metadata !"one"}
 992 !2 = metadata !{metadata !"two"}
 993 ; A named metadata.
 994 !name = !{!0, !1, !2}
 995 </pre>
 996
 997 </div>
 998
 999 <!-- ======================================================================= -->
1000 <h3>
1001   <a name="paramattrs">Parameter Attributes</a>
1002 </h3>
1003
1004 <div>
1005
1006 <p>The return type and each parameter of a function type may have a set of
1007    <i>parameter attributes</i> associated with them. Parameter attributes are
1008    used to communicate additional information about the result or parameters of
1009    a function. Parameter attributes are considered to be part of the function,
1010    not of the function type, so functions with different parameter attributes
1011    can have the same function type.</p>
1012
1013 <p>Parameter attributes are simple keywords that follow the type specified. If
1014    multiple parameter attributes are needed, they are space separated. For
1015    example:</p>
1016
1017 <pre class="doc_code">
1018 declare i32 @printf(i8* noalias nocapture, ...)
1019 declare i32 @atoi(i8 zeroext)
1020 declare signext i8 @returns_signed_char()
1021 </pre>
1022
1023 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1024    <tt>readonly</tt>) come immediately after the argument list.</p>
1025
1026 <p>Currently, only the following parameter attributes are defined:</p>
1027
1028 <dl>
1029   <dt><tt><b>zeroext</b></tt></dt>
1030   <dd>This indicates to the code generator that the parameter or return value
1031       should be zero-extended to the extent required by the target's ABI (which
1032       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1033       parameter) or the callee (for a return value).</dd>
1034
1035   <dt><tt><b>signext</b></tt></dt>
1036   <dd>This indicates to the code generator that the parameter or return value
1037       should be sign-extended to the extent required by the target's ABI (which
1038       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1039       return value).</dd>
1040
1041   <dt><tt><b>inreg</b></tt></dt>
1042   <dd>This indicates that this parameter or return value should be treated in a
1043       special target-dependent fashion during while emitting code for a function
1044       call or return (usually, by putting it in a register as opposed to memory,
1045       though some targets use it to distinguish between two different kinds of
1046       registers).  Use of this attribute is target-specific.</dd>
1047
1048   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1049   <dd><p>This indicates that the pointer parameter should really be passed by
1050       value to the function.  The attribute implies that a hidden copy of the
1051       pointee
1052       is made between the caller and the callee, so the callee is unable to
1053       modify the value in the caller.  This attribute is only valid on LLVM
1054       pointer arguments.  It is generally used to pass structs and arrays by
1055       value, but is also valid on pointers to scalars.  The copy is considered
1056       to belong to the caller not the callee (for example,
1057       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1058       <tt>byval</tt> parameters). This is not a valid attribute for return
1059       values.</p>
1060
1061       <p>The byval attribute also supports specifying an alignment with
1062       the align attribute.  It indicates the alignment of the stack slot to
1063       form and the known alignment of the pointer specified to the call site. If
1064       the alignment is not specified, then the code generator makes a
1065       target-specific assumption.</p></dd>
1066
1067   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1068   <dd>This indicates that the pointer parameter specifies the address of a
1069       structure that is the return value of the function in the source program.
1070       This pointer must be guaranteed by the caller to be valid: loads and
1071       stores to the structure may be assumed by the callee to not to trap.  This
1072       may only be applied to the first parameter. This is not a valid attribute
1073       for return values. </dd>
1074
1075   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1076   <dd>This indicates that pointer values
1077       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1078       value do not alias pointer values which are not <i>based</i> on it,
1079       ignoring certain "irrelevant" dependencies.
1080       For a call to the parent function, dependencies between memory
1081       references from before or after the call and from those during the call
1082       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1083       return value used in that call.
1084       The caller shares the responsibility with the callee for ensuring that
1085       these requirements are met.
1086       For further details, please see the discussion of the NoAlias response in
1087       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1088 <br>
1089       Note that this definition of <tt>noalias</tt> is intentionally
1090       similar to the definition of <tt>restrict</tt> in C99 for function
1091       arguments, though it is slightly weaker.
1092 <br>
1093       For function return values, C99's <tt>restrict</tt> is not meaningful,
1094       while LLVM's <tt>noalias</tt> is.
1095       </dd>
1096
1097   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1098   <dd>This indicates that the callee does not make any copies of the pointer
1099       that outlive the callee itself. This is not a valid attribute for return
1100       values.</dd>
1101
1102   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1103   <dd>This indicates that the pointer parameter can be excised using the
1104       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1105       attribute for return values.</dd>
1106 </dl>
1107
1108 </div>
1109
1110 <!-- ======================================================================= -->
1111 <h3>
1112   <a name="gc">Garbage Collector Names</a>
1113 </h3>
1114
1115 <div>
1116
1117 <p>Each function may specify a garbage collector name, which is simply a
1118    string:</p>
1119
1120 <pre class="doc_code">
1121 define void @f() gc "name" { ... }
1122 </pre>
1123
1124 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1125    collector which will cause the compiler to alter its output in order to
1126    support the named garbage collection algorithm.</p>
1127
1128 </div>
1129
1130 <!-- ======================================================================= -->
1131 <h3>
1132   <a name="fnattrs">Function Attributes</a>
1133 </h3>
1134
1135 <div>
1136
1137 <p>Function attributes are set to communicate additional information about a
1138    function. Function attributes are considered to be part of the function, not
1139    of the function type, so functions with different parameter attributes can
1140    have the same function type.</p>
1141
1142 <p>Function attributes are simple keywords that follow the type specified. If
1143    multiple attributes are needed, they are space separated. For example:</p>
1144
1145 <pre class="doc_code">
1146 define void @f() noinline { ... }
1147 define void @f() alwaysinline { ... }
1148 define void @f() alwaysinline optsize { ... }
1149 define void @f() optsize { ... }
1150 </pre>
1151
1152 <dl>
1153   <dt><tt><b>address_safety</b></tt></dt>
1154   <dd>This attribute indicates that the address safety analysis
1155   is enabled for this function.  </dd>
1156
1157   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1158   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1159       the backend should forcibly align the stack pointer. Specify the
1160       desired alignment, which must be a power of two, in parentheses.
1161
1162   <dt><tt><b>alwaysinline</b></tt></dt>
1163   <dd>This attribute indicates that the inliner should attempt to inline this
1164       function into callers whenever possible, ignoring any active inlining size
1165       threshold for this caller.</dd>
1166
1167   <dt><tt><b>nonlazybind</b></tt></dt>
1168   <dd>This attribute suppresses lazy symbol binding for the function. This
1169       may make calls to the function faster, at the cost of extra program
1170       startup time if the function is not called during program startup.</dd>
1171
1172   <dt><tt><b>inlinehint</b></tt></dt>
1173   <dd>This attribute indicates that the source code contained a hint that inlining
1174       this function is desirable (such as the "inline" keyword in C/C++).  It
1175       is just a hint; it imposes no requirements on the inliner.</dd>
1176
1177   <dt><tt><b>naked</b></tt></dt>
1178   <dd>This attribute disables prologue / epilogue emission for the function.
1179       This can have very system-specific consequences.</dd>
1180
1181   <dt><tt><b>noimplicitfloat</b></tt></dt>
1182   <dd>This attributes disables implicit floating point instructions.</dd>
1183
1184   <dt><tt><b>noinline</b></tt></dt>
1185   <dd>This attribute indicates that the inliner should never inline this
1186       function in any situation. This attribute may not be used together with
1187       the <tt>alwaysinline</tt> attribute.</dd>
1188
1189   <dt><tt><b>noredzone</b></tt></dt>
1190   <dd>This attribute indicates that the code generator should not use a red
1191       zone, even if the target-specific ABI normally permits it.</dd>
1192
1193   <dt><tt><b>noreturn</b></tt></dt>
1194   <dd>This function attribute indicates that the function never returns
1195       normally.  This produces undefined behavior at runtime if the function
1196       ever does dynamically return.</dd>
1197
1198   <dt><tt><b>nounwind</b></tt></dt>
1199   <dd>This function attribute indicates that the function never returns with an
1200       unwind or exceptional control flow.  If the function does unwind, its
1201       runtime behavior is undefined.</dd>
1202
1203   <dt><tt><b>optsize</b></tt></dt>
1204   <dd>This attribute suggests that optimization passes and code generator passes
1205       make choices that keep the code size of this function low, and otherwise
1206       do optimizations specifically to reduce code size.</dd>
1207
1208   <dt><tt><b>readnone</b></tt></dt>
1209   <dd>This attribute indicates that the function computes its result (or decides
1210       to unwind an exception) based strictly on its arguments, without
1211       dereferencing any pointer arguments or otherwise accessing any mutable
1212       state (e.g. memory, control registers, etc) visible to caller functions.
1213       It does not write through any pointer arguments
1214       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1215       changes any state visible to callers.  This means that it cannot unwind
1216       exceptions by calling the <tt>C++</tt> exception throwing methods.</dd>
1217
1218   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1219   <dd>This attribute indicates that the function does not write through any
1220       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1221       arguments) or otherwise modify any state (e.g. memory, control registers,
1222       etc) visible to caller functions.  It may dereference pointer arguments
1223       and read state that may be set in the caller.  A readonly function always
1224       returns the same value (or unwinds an exception identically) when called
1225       with the same set of arguments and global state.  It cannot unwind an
1226       exception by calling the <tt>C++</tt> exception throwing methods.</dd>
1227
1228   <dt><tt><b><a name="returns_twice">returns_twice</a></b></tt></dt>
1229   <dd>This attribute indicates that this function can return twice. The
1230       C <code>setjmp</code> is an example of such a function.  The compiler
1231       disables some optimizations (like tail calls) in the caller of these
1232       functions.</dd>
1233
1234   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1235   <dd>This attribute indicates that the function should emit a stack smashing
1236       protector. It is in the form of a "canary"&mdash;a random value placed on
1237       the stack before the local variables that's checked upon return from the
1238       function to see if it has been overwritten. A heuristic is used to
1239       determine if a function needs stack protectors or not.<br>
1240 <br>
1241       If a function that has an <tt>ssp</tt> attribute is inlined into a
1242       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1243       function will have an <tt>ssp</tt> attribute.</dd>
1244
1245   <dt><tt><b>sspreq</b></tt></dt>
1246   <dd>This attribute indicates that the function should <em>always</em> emit a
1247       stack smashing protector. This overrides
1248       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1249 <br>
1250       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1251       function that doesn't have an <tt>sspreq</tt> attribute or which has
1252       an <tt>ssp</tt> attribute, then the resulting function will have
1253       an <tt>sspreq</tt> attribute.</dd>
1254
1255   <dt><tt><b><a name="uwtable">uwtable</a></b></tt></dt>
1256   <dd>This attribute indicates that the ABI being targeted requires that
1257       an unwind table entry be produce for this function even if we can
1258       show that no exceptions passes by it. This is normally the case for
1259       the ELF x86-64 abi, but it can be disabled for some compilation
1260       units.</dd>
1261 </dl>
1262
1263 </div>
1264
1265 <!-- ======================================================================= -->
1266 <h3>
1267   <a name="moduleasm">Module-Level Inline Assembly</a>
1268 </h3>
1269
1270 <div>
1271
1272 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1273    the GCC "file scope inline asm" blocks.  These blocks are internally
1274    concatenated by LLVM and treated as a single unit, but may be separated in
1275    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1276
1277 <pre class="doc_code">
1278 module asm "inline asm code goes here"
1279 module asm "more can go here"
1280 </pre>
1281
1282 <p>The strings can contain any character by escaping non-printable characters.
1283    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1284    for the number.</p>
1285
1286 <p>The inline asm code is simply printed to the machine code .s file when
1287    assembly code is generated.</p>
1288
1289 </div>
1290
1291 <!-- ======================================================================= -->
1292 <h3>
1293   <a name="datalayout">Data Layout</a>
1294 </h3>
1295
1296 <div>
1297
1298 <p>A module may specify a target specific data layout string that specifies how
1299    data is to be laid out in memory. The syntax for the data layout is
1300    simply:</p>
1301
1302 <pre class="doc_code">
1303 target datalayout = "<i>layout specification</i>"
1304 </pre>
1305
1306 <p>The <i>layout specification</i> consists of a list of specifications
1307    separated by the minus sign character ('-').  Each specification starts with
1308    a letter and may include other information after the letter to define some
1309    aspect of the data layout.  The specifications accepted are as follows:</p>
1310
1311 <dl>
1312   <dt><tt>E</tt></dt>
1313   <dd>Specifies that the target lays out data in big-endian form. That is, the
1314       bits with the most significance have the lowest address location.</dd>
1315
1316   <dt><tt>e</tt></dt>
1317   <dd>Specifies that the target lays out data in little-endian form. That is,
1318       the bits with the least significance have the lowest address
1319       location.</dd>
1320
1321   <dt><tt>S<i>size</i></tt></dt>
1322   <dd>Specifies the natural alignment of the stack in bits. Alignment promotion
1323       of stack variables is limited to the natural stack alignment to avoid
1324       dynamic stack realignment. The stack alignment must be a multiple of
1325       8-bits. If omitted, the natural stack alignment defaults to "unspecified",
1326       which does not prevent any alignment promotions.</dd>
1327
1328   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1329   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1330       <i>preferred</i> alignments. All sizes are in bits. Specifying
1331       the <i>pref</i> alignment is optional. If omitted, the
1332       preceding <tt>:</tt> should be omitted too.</dd>
1333
1334   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1335   <dd>This specifies the alignment for an integer type of a given bit
1336       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1337
1338   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1339   <dd>This specifies the alignment for a vector type of a given bit
1340       <i>size</i>.</dd>
1341
1342   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1343   <dd>This specifies the alignment for a floating point type of a given bit
1344       <i>size</i>. Only values of <i>size</i> that are supported by the target
1345       will work.  32 (float) and 64 (double) are supported on all targets;
1346       80 or 128 (different flavors of long double) are also supported on some
1347       targets.
1348
1349   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1350   <dd>This specifies the alignment for an aggregate type of a given bit
1351       <i>size</i>.</dd>
1352
1353   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1354   <dd>This specifies the alignment for a stack object of a given bit
1355       <i>size</i>.</dd>
1356
1357   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1358   <dd>This specifies a set of native integer widths for the target CPU
1359       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1360       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1361       this set are considered to support most general arithmetic
1362       operations efficiently.</dd>
1363 </dl>
1364
1365 <p>When constructing the data layout for a given target, LLVM starts with a
1366    default set of specifications which are then (possibly) overridden by the
1367    specifications in the <tt>datalayout</tt> keyword. The default specifications
1368    are given in this list:</p>
1369
1370 <ul>
1371   <li><tt>E</tt> - big endian</li>
1372   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1373   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1374   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1375   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1376   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1377   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1378   alignment of 64-bits</li>
1379   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1380   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1381   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1382   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1383   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1384   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1385 </ul>
1386
1387 <p>When LLVM is determining the alignment for a given type, it uses the
1388    following rules:</p>
1389
1390 <ol>
1391   <li>If the type sought is an exact match for one of the specifications, that
1392       specification is used.</li>
1393
1394   <li>If no match is found, and the type sought is an integer type, then the
1395       smallest integer type that is larger than the bitwidth of the sought type
1396       is used. If none of the specifications are larger than the bitwidth then
1397       the the largest integer type is used. For example, given the default
1398       specifications above, the i7 type will use the alignment of i8 (next
1399       largest) while both i65 and i256 will use the alignment of i64 (largest
1400       specified).</li>
1401
1402   <li>If no match is found, and the type sought is a vector type, then the
1403       largest vector type that is smaller than the sought vector type will be
1404       used as a fall back.  This happens because &lt;128 x double&gt; can be
1405       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1406 </ol>
1407
1408 <p>The function of the data layout string may not be what you expect.  Notably,
1409    this is not a specification from the frontend of what alignment the code
1410    generator should use.</p>
1411
1412 <p>Instead, if specified, the target data layout is required to match what the
1413    ultimate <em>code generator</em> expects.  This string is used by the
1414    mid-level optimizers to
1415    improve code, and this only works if it matches what the ultimate code
1416    generator uses.  If you would like to generate IR that does not embed this
1417    target-specific detail into the IR, then you don't have to specify the
1418    string.  This will disable some optimizations that require precise layout
1419    information, but this also prevents those optimizations from introducing
1420    target specificity into the IR.</p>
1421
1422
1423
1424 </div>
1425
1426 <!-- ======================================================================= -->
1427 <h3>
1428   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1429 </h3>
1430
1431 <div>
1432
1433 <p>Any memory access must be done through a pointer value associated
1434 with an address range of the memory access, otherwise the behavior
1435 is undefined. Pointer values are associated with address ranges
1436 according to the following rules:</p>
1437
1438 <ul>
1439   <li>A pointer value is associated with the addresses associated with
1440       any value it is <i>based</i> on.
1441   <li>An address of a global variable is associated with the address
1442       range of the variable's storage.</li>
1443   <li>The result value of an allocation instruction is associated with
1444       the address range of the allocated storage.</li>
1445   <li>A null pointer in the default address-space is associated with
1446       no address.</li>
1447   <li>An integer constant other than zero or a pointer value returned
1448       from a function not defined within LLVM may be associated with address
1449       ranges allocated through mechanisms other than those provided by
1450       LLVM. Such ranges shall not overlap with any ranges of addresses
1451       allocated by mechanisms provided by LLVM.</li>
1452 </ul>
1453
1454 <p>A pointer value is <i>based</i> on another pointer value according
1455    to the following rules:</p>
1456
1457 <ul>
1458   <li>A pointer value formed from a
1459       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1460       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1461   <li>The result value of a
1462       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1463       of the <tt>bitcast</tt>.</li>
1464   <li>A pointer value formed by an
1465       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1466       pointer values that contribute (directly or indirectly) to the
1467       computation of the pointer's value.</li>
1468   <li>The "<i>based</i> on" relationship is transitive.</li>
1469 </ul>
1470
1471 <p>Note that this definition of <i>"based"</i> is intentionally
1472    similar to the definition of <i>"based"</i> in C99, though it is
1473    slightly weaker.</p>
1474
1475 <p>LLVM IR does not associate types with memory. The result type of a
1476 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1477 alignment of the memory from which to load, as well as the
1478 interpretation of the value. The first operand type of a
1479 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1480 and alignment of the store.</p>
1481
1482 <p>Consequently, type-based alias analysis, aka TBAA, aka
1483 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1484 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1485 additional information which specialized optimization passes may use
1486 to implement type-based alias analysis.</p>
1487
1488 </div>
1489
1490 <!-- ======================================================================= -->
1491 <h3>
1492   <a name="volatile">Volatile Memory Accesses</a>
1493 </h3>
1494
1495 <div>
1496
1497 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1498 href="#i_store"><tt>store</tt></a>s, and <a
1499 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1500 The optimizers must not change the number of volatile operations or change their
1501 order of execution relative to other volatile operations.  The optimizers
1502 <i>may</i> change the order of volatile operations relative to non-volatile
1503 operations.  This is not Java's "volatile" and has no cross-thread
1504 synchronization behavior.</p>
1505
1506 </div>
1507
1508 <!-- ======================================================================= -->
1509 <h3>
1510   <a name="memmodel">Memory Model for Concurrent Operations</a>
1511 </h3>
1512
1513 <div>
1514
1515 <p>The LLVM IR does not define any way to start parallel threads of execution
1516 or to register signal handlers. Nonetheless, there are platform-specific
1517 ways to create them, and we define LLVM IR's behavior in their presence. This
1518 model is inspired by the C++0x memory model.</p>
1519
1520 <p>For a more informal introduction to this model, see the
1521 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.
1522
1523 <p>We define a <i>happens-before</i> partial order as the least partial order
1524 that</p>
1525 <ul>
1526   <li>Is a superset of single-thread program order, and</li>
1527   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1528       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1529       by platform-specific techniques, like pthread locks, thread
1530       creation, thread joining, etc., and by atomic instructions.
1531       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1532       </li>
1533 </ul>
1534
1535 <p>Note that program order does not introduce <i>happens-before</i> edges
1536 between a thread and signals executing inside that thread.</p>
1537
1538 <p>Every (defined) read operation (load instructions, memcpy, atomic
1539 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1540 (defined) write operations (store instructions, atomic
1541 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1542 initialized globals are considered to have a write of the initializer which is
1543 atomic and happens before any other read or write of the memory in question.
1544 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1545 any write to the same byte, except:</p>
1546
1547 <ul>
1548   <li>If <var>write<sub>1</sub></var> happens before
1549       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1550       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1551       does not see <var>write<sub>1</sub></var>.
1552   <li>If <var>R<sub>byte</sub></var> happens before
1553       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1554       see <var>write<sub>3</sub></var>.
1555 </ul>
1556
1557 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1558 <ul>
1559   <li>If <var>R</var> is volatile, the result is target-dependent. (Volatile
1560       is supposed to give guarantees which can support
1561       <code>sig_atomic_t</code> in C/C++, and may be used for accesses to
1562       addresses which do not behave like normal memory.  It does not generally
1563       provide cross-thread synchronization.)
1564   <li>Otherwise, if there is no write to the same byte that happens before
1565     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1566     <tt>undef</tt> for that byte.
1567   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1568       <var>R<sub>byte</sub></var> returns the value written by that
1569       write.</li>
1570   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1571       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1572       values written.  See the <a href="#ordering">Atomic Memory Ordering
1573       Constraints</a> section for additional constraints on how the choice
1574       is made.
1575   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1576 </ul>
1577
1578 <p><var>R</var> returns the value composed of the series of bytes it read.
1579 This implies that some bytes within the value may be <tt>undef</tt>
1580 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1581 defines the semantics of the operation; it doesn't mean that targets will
1582 emit more than one instruction to read the series of bytes.</p>
1583
1584 <p>Note that in cases where none of the atomic intrinsics are used, this model
1585 places only one restriction on IR transformations on top of what is required
1586 for single-threaded execution: introducing a store to a byte which might not
1587 otherwise be stored is not allowed in general.  (Specifically, in the case
1588 where another thread might write to and read from an address, introducing a
1589 store can change a load that may see exactly one write into a load that may
1590 see multiple writes.)</p>
1591
1592 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1593 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1594 none of the backends currently in the tree fall into this category; however,
1595 there might be targets which care.  If there are, we want a paragraph
1596 like the following:
1597
1598 Targets may specify that stores narrower than a certain width are not
1599 available; on such a target, for the purposes of this model, treat any
1600 non-atomic write with an alignment or width less than the minimum width
1601 as if it writes to the relevant surrounding bytes.
1602 -->
1603
1604 </div>
1605
1606 <!-- ======================================================================= -->
1607 <h3>
1608       <a name="ordering">Atomic Memory Ordering Constraints</a>
1609 </h3>
1610
1611 <div>
1612
1613 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1614 <a href="#i_atomicrmw"><code>atomicrmw</code></a>,
1615 <a href="#i_fence"><code>fence</code></a>,
1616 <a href="#i_load"><code>atomic load</code></a>, and
1617 <a href="#i_store"><code>atomic store</code></a>) take an ordering parameter
1618 that determines which other atomic instructions on the same address they
1619 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1620 but are somewhat more colloquial. If these descriptions aren't precise enough,
1621 check those specs (see spec references in the
1622 <a href="Atomics.html#introduction">atomics guide</a>).
1623 <a href="#i_fence"><code>fence</code></a> instructions
1624 treat these orderings somewhat differently since they don't take an address.
1625 See that instruction's documentation for details.</p>
1626
1627 <p>For a simpler introduction to the ordering constraints, see the
1628 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.</p>
1629
1630 <dl>
1631 <dt><code>unordered</code></dt>
1632 <dd>The set of values that can be read is governed by the happens-before
1633 partial order. A value cannot be read unless some operation wrote it.
1634 This is intended to provide a guarantee strong enough to model Java's
1635 non-volatile shared variables.  This ordering cannot be specified for
1636 read-modify-write operations; it is not strong enough to make them atomic
1637 in any interesting way.</dd>
1638 <dt><code>monotonic</code></dt>
1639 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1640 total order for modifications by <code>monotonic</code> operations on each
1641 address. All modification orders must be compatible with the happens-before
1642 order. There is no guarantee that the modification orders can be combined to
1643 a global total order for the whole program (and this often will not be
1644 possible). The read in an atomic read-modify-write operation
1645 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1646 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1647 reads the value in the modification order immediately before the value it
1648 writes. If one atomic read happens before another atomic read of the same
1649 address, the later read must see the same value or a later value in the
1650 address's modification order. This disallows reordering of
1651 <code>monotonic</code> (or stronger) operations on the same address. If an
1652 address is written <code>monotonic</code>ally by one thread, and other threads
1653 <code>monotonic</code>ally read that address repeatedly, the other threads must
1654 eventually see the write. This corresponds to the C++0x/C1x
1655 <code>memory_order_relaxed</code>.</dd>
1656 <dt><code>acquire</code></dt>
1657 <dd>In addition to the guarantees of <code>monotonic</code>,
1658 a <i>synchronizes-with</i> edge may be formed with a <code>release</code>
1659 operation. This is intended to model C++'s <code>memory_order_acquire</code>.</dd>
1660 <dt><code>release</code></dt>
1661 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1662 writes a value which is subsequently read by an <code>acquire</code> operation,
1663 it <i>synchronizes-with</i> that operation.  (This isn't a complete
1664 description; see the C++0x definition of a release sequence.) This corresponds
1665 to the C++0x/C1x <code>memory_order_release</code>.</dd>
1666 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1667 <code>acquire</code> and <code>release</code> operation on its address.
1668 This corresponds to the C++0x/C1x <code>memory_order_acq_rel</code>.</dd>
1669 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1670 <dd>In addition to the guarantees of <code>acq_rel</code>
1671 (<code>acquire</code> for an operation which only reads, <code>release</code>
1672 for an operation which only writes), there is a global total order on all
1673 sequentially-consistent operations on all addresses, which is consistent with
1674 the <i>happens-before</i> partial order and with the modification orders of
1675 all the affected addresses. Each sequentially-consistent read sees the last
1676 preceding write to the same address in this global order. This corresponds
1677 to the C++0x/C1x <code>memory_order_seq_cst</code> and Java volatile.</dd>
1678 </dl>
1679
1680 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1681 it only <i>synchronizes with</i> or participates in modification and seq_cst
1682 total orderings with other operations running in the same thread (for example,
1683 in signal handlers).</p>
1684
1685 </div>
1686
1687 </div>
1688
1689 <!-- *********************************************************************** -->
1690 <h2><a name="typesystem">Type System</a></h2>
1691 <!-- *********************************************************************** -->
1692
1693 <div>
1694
1695 <p>The LLVM type system is one of the most important features of the
1696    intermediate representation.  Being typed enables a number of optimizations
1697    to be performed on the intermediate representation directly, without having
1698    to do extra analyses on the side before the transformation.  A strong type
1699    system makes it easier to read the generated code and enables novel analyses
1700    and transformations that are not feasible to perform on normal three address
1701    code representations.</p>
1702
1703 <!-- ======================================================================= -->
1704 <h3>
1705   <a name="t_classifications">Type Classifications</a>
1706 </h3>
1707
1708 <div>
1709
1710 <p>The types fall into a few useful classifications:</p>
1711
1712 <table border="1" cellspacing="0" cellpadding="4">
1713   <tbody>
1714     <tr><th>Classification</th><th>Types</th></tr>
1715     <tr>
1716       <td><a href="#t_integer">integer</a></td>
1717       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1718     </tr>
1719     <tr>
1720       <td><a href="#t_floating">floating point</a></td>
1721       <td><tt>half, float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1722     </tr>
1723     <tr>
1724       <td><a name="t_firstclass">first class</a></td>
1725       <td><a href="#t_integer">integer</a>,
1726           <a href="#t_floating">floating point</a>,
1727           <a href="#t_pointer">pointer</a>,
1728           <a href="#t_vector">vector</a>,
1729           <a href="#t_struct">structure</a>,
1730           <a href="#t_array">array</a>,
1731           <a href="#t_label">label</a>,
1732           <a href="#t_metadata">metadata</a>.
1733       </td>
1734     </tr>
1735     <tr>
1736       <td><a href="#t_primitive">primitive</a></td>
1737       <td><a href="#t_label">label</a>,
1738           <a href="#t_void">void</a>,
1739           <a href="#t_integer">integer</a>,
1740           <a href="#t_floating">floating point</a>,
1741           <a href="#t_x86mmx">x86mmx</a>,
1742           <a href="#t_metadata">metadata</a>.</td>
1743     </tr>
1744     <tr>
1745       <td><a href="#t_derived">derived</a></td>
1746       <td><a href="#t_array">array</a>,
1747           <a href="#t_function">function</a>,
1748           <a href="#t_pointer">pointer</a>,
1749           <a href="#t_struct">structure</a>,
1750           <a href="#t_vector">vector</a>,
1751           <a href="#t_opaque">opaque</a>.
1752       </td>
1753     </tr>
1754   </tbody>
1755 </table>
1756
1757 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1758    important.  Values of these types are the only ones which can be produced by
1759    instructions.</p>
1760
1761 </div>
1762
1763 <!-- ======================================================================= -->
1764 <h3>
1765   <a name="t_primitive">Primitive Types</a>
1766 </h3>
1767
1768 <div>
1769
1770 <p>The primitive types are the fundamental building blocks of the LLVM
1771    system.</p>
1772
1773 <!-- _______________________________________________________________________ -->
1774 <h4>
1775   <a name="t_integer">Integer Type</a>
1776 </h4>
1777
1778 <div>
1779
1780 <h5>Overview:</h5>
1781 <p>The integer type is a very simple type that simply specifies an arbitrary
1782    bit width for the integer type desired. Any bit width from 1 bit to
1783    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1784
1785 <h5>Syntax:</h5>
1786 <pre>
1787   iN
1788 </pre>
1789
1790 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1791    value.</p>
1792
1793 <h5>Examples:</h5>
1794 <table class="layout">
1795   <tr class="layout">
1796     <td class="left"><tt>i1</tt></td>
1797     <td class="left">a single-bit integer.</td>
1798   </tr>
1799   <tr class="layout">
1800     <td class="left"><tt>i32</tt></td>
1801     <td class="left">a 32-bit integer.</td>
1802   </tr>
1803   <tr class="layout">
1804     <td class="left"><tt>i1942652</tt></td>
1805     <td class="left">a really big integer of over 1 million bits.</td>
1806   </tr>
1807 </table>
1808
1809 </div>
1810
1811 <!-- _______________________________________________________________________ -->
1812 <h4>
1813   <a name="t_floating">Floating Point Types</a>
1814 </h4>
1815
1816 <div>
1817
1818 <table>
1819   <tbody>
1820     <tr><th>Type</th><th>Description</th></tr>
1821     <tr><td><tt>half</tt></td><td>16-bit floating point value</td></tr>
1822     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1823     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1824     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1825     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1826     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1827   </tbody>
1828 </table>
1829
1830 </div>
1831
1832 <!-- _______________________________________________________________________ -->
1833 <h4>
1834   <a name="t_x86mmx">X86mmx Type</a>
1835 </h4>
1836
1837 <div>
1838
1839 <h5>Overview:</h5>
1840 <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>
1841
1842 <h5>Syntax:</h5>
1843 <pre>
1844   x86mmx
1845 </pre>
1846
1847 </div>
1848
1849 <!-- _______________________________________________________________________ -->
1850 <h4>
1851   <a name="t_void">Void Type</a>
1852 </h4>
1853
1854 <div>
1855
1856 <h5>Overview:</h5>
1857 <p>The void type does not represent any value and has no size.</p>
1858
1859 <h5>Syntax:</h5>
1860 <pre>
1861   void
1862 </pre>
1863
1864 </div>
1865
1866 <!-- _______________________________________________________________________ -->
1867 <h4>
1868   <a name="t_label">Label Type</a>
1869 </h4>
1870
1871 <div>
1872
1873 <h5>Overview:</h5>
1874 <p>The label type represents code labels.</p>
1875
1876 <h5>Syntax:</h5>
1877 <pre>
1878   label
1879 </pre>
1880
1881 </div>
1882
1883 <!-- _______________________________________________________________________ -->
1884 <h4>
1885   <a name="t_metadata">Metadata Type</a>
1886 </h4>
1887
1888 <div>
1889
1890 <h5>Overview:</h5>
1891 <p>The metadata type represents embedded metadata. No derived types may be
1892    created from metadata except for <a href="#t_function">function</a>
1893    arguments.
1894
1895 <h5>Syntax:</h5>
1896 <pre>
1897   metadata
1898 </pre>
1899
1900 </div>
1901
1902 </div>
1903
1904 <!-- ======================================================================= -->
1905 <h3>
1906   <a name="t_derived">Derived Types</a>
1907 </h3>
1908
1909 <div>
1910
1911 <p>The real power in LLVM comes from the derived types in the system.  This is
1912    what allows a programmer to represent arrays, functions, pointers, and other
1913    useful types.  Each of these types contain one or more element types which
1914    may be a primitive type, or another derived type.  For example, it is
1915    possible to have a two dimensional array, using an array as the element type
1916    of another array.</p>
1917
1918 <!-- _______________________________________________________________________ -->
1919 <h4>
1920   <a name="t_aggregate">Aggregate Types</a>
1921 </h4>
1922
1923 <div>
1924
1925 <p>Aggregate Types are a subset of derived types that can contain multiple
1926   member types. <a href="#t_array">Arrays</a> and
1927   <a href="#t_struct">structs</a> are aggregate types.
1928   <a href="#t_vector">Vectors</a> are not considered to be aggregate types.</p>
1929
1930 </div>
1931
1932 <!-- _______________________________________________________________________ -->
1933 <h4>
1934   <a name="t_array">Array Type</a>
1935 </h4>
1936
1937 <div>
1938
1939 <h5>Overview:</h5>
1940 <p>The array type is a very simple derived type that arranges elements
1941    sequentially in memory.  The array type requires a size (number of elements)
1942    and an underlying data type.</p>
1943
1944 <h5>Syntax:</h5>
1945 <pre>
1946   [&lt;# elements&gt; x &lt;elementtype&gt;]
1947 </pre>
1948
1949 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1950    be any type with a size.</p>
1951
1952 <h5>Examples:</h5>
1953 <table class="layout">
1954   <tr class="layout">
1955     <td class="left"><tt>[40 x i32]</tt></td>
1956     <td class="left">Array of 40 32-bit integer values.</td>
1957   </tr>
1958   <tr class="layout">
1959     <td class="left"><tt>[41 x i32]</tt></td>
1960     <td class="left">Array of 41 32-bit integer values.</td>
1961   </tr>
1962   <tr class="layout">
1963     <td class="left"><tt>[4 x i8]</tt></td>
1964     <td class="left">Array of 4 8-bit integer values.</td>
1965   </tr>
1966 </table>
1967 <p>Here are some examples of multidimensional arrays:</p>
1968 <table class="layout">
1969   <tr class="layout">
1970     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1971     <td class="left">3x4 array of 32-bit integer values.</td>
1972   </tr>
1973   <tr class="layout">
1974     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1975     <td class="left">12x10 array of single precision floating point values.</td>
1976   </tr>
1977   <tr class="layout">
1978     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1979     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1980   </tr>
1981 </table>
1982
1983 <p>There is no restriction on indexing beyond the end of the array implied by
1984    a static type (though there are restrictions on indexing beyond the bounds
1985    of an allocated object in some cases). This means that single-dimension
1986    'variable sized array' addressing can be implemented in LLVM with a zero
1987    length array type. An implementation of 'pascal style arrays' in LLVM could
1988    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1989
1990 </div>
1991
1992 <!-- _______________________________________________________________________ -->
1993 <h4>
1994   <a name="t_function">Function Type</a>
1995 </h4>
1996
1997 <div>
1998
1999 <h5>Overview:</h5>
2000 <p>The function type can be thought of as a function signature.  It consists of
2001    a return type and a list of formal parameter types. The return type of a
2002    function type is a first class type or a void type.</p>
2003
2004 <h5>Syntax:</h5>
2005 <pre>
2006   &lt;returntype&gt; (&lt;parameter list&gt;)
2007 </pre>
2008
2009 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
2010    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
2011    which indicates that the function takes a variable number of arguments.
2012    Variable argument functions can access their arguments with
2013    the <a href="#int_varargs">variable argument handling intrinsic</a>
2014    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
2015    <a href="#t_label">label</a>.</p>
2016
2017 <h5>Examples:</h5>
2018 <table class="layout">
2019   <tr class="layout">
2020     <td class="left"><tt>i32 (i32)</tt></td>
2021     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
2022     </td>
2023   </tr><tr class="layout">
2024     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
2025     </tt></td>
2026     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
2027       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
2028       returning <tt>float</tt>.
2029     </td>
2030   </tr><tr class="layout">
2031     <td class="left"><tt>i32 (i8*, ...)</tt></td>
2032     <td class="left">A vararg function that takes at least one
2033       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2034       which returns an integer.  This is the signature for <tt>printf</tt> in
2035       LLVM.
2036     </td>
2037   </tr><tr class="layout">
2038     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2039     <td class="left">A function taking an <tt>i32</tt>, returning a
2040         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2041     </td>
2042   </tr>
2043 </table>
2044
2045 </div>
2046
2047 <!-- _______________________________________________________________________ -->
2048 <h4>
2049   <a name="t_struct">Structure Type</a>
2050 </h4>
2051
2052 <div>
2053
2054 <h5>Overview:</h5>
2055 <p>The structure type is used to represent a collection of data members together
2056   in memory.  The elements of a structure may be any type that has a size.</p>
2057
2058 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2059    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2060    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2061    Structures in registers are accessed using the
2062    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2063    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2064
2065 <p>Structures may optionally be "packed" structures, which indicate that the
2066   alignment of the struct is one byte, and that there is no padding between
2067   the elements.  In non-packed structs, padding between field types is inserted
2068   as defined by the TargetData string in the module, which is required to match
2069   what the underlying code generator expects.</p>
2070
2071 <p>Structures can either be "literal" or "identified".  A literal structure is
2072   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) whereas identified
2073   types are always defined at the top level with a name.  Literal types are
2074   uniqued by their contents and can never be recursive or opaque since there is
2075   no way to write one.  Identified types can be recursive, can be opaqued, and are
2076   never uniqued.
2077 </p>
2078
2079 <h5>Syntax:</h5>
2080 <pre>
2081   %T1 = type { &lt;type list&gt; }     <i>; Identified normal struct type</i>
2082   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Identified packed struct type</i>
2083 </pre>
2084
2085 <h5>Examples:</h5>
2086 <table class="layout">
2087   <tr class="layout">
2088     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2089     <td class="left">A triple of three <tt>i32</tt> values</td>
2090   </tr>
2091   <tr class="layout">
2092     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2093     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2094       second element is a <a href="#t_pointer">pointer</a> to a
2095       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2096       an <tt>i32</tt>.</td>
2097   </tr>
2098   <tr class="layout">
2099     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2100     <td class="left">A packed struct known to be 5 bytes in size.</td>
2101   </tr>
2102 </table>
2103
2104 </div>
2105
2106 <!-- _______________________________________________________________________ -->
2107 <h4>
2108   <a name="t_opaque">Opaque Structure Types</a>
2109 </h4>
2110
2111 <div>
2112
2113 <h5>Overview:</h5>
2114 <p>Opaque structure types are used to represent named structure types that do
2115    not have a body specified.  This corresponds (for example) to the C notion of
2116    a forward declared structure.</p>
2117
2118 <h5>Syntax:</h5>
2119 <pre>
2120   %X = type opaque
2121   %52 = type opaque
2122 </pre>
2123
2124 <h5>Examples:</h5>
2125 <table class="layout">
2126   <tr class="layout">
2127     <td class="left"><tt>opaque</tt></td>
2128     <td class="left">An opaque type.</td>
2129   </tr>
2130 </table>
2131
2132 </div>
2133
2134
2135
2136 <!-- _______________________________________________________________________ -->
2137 <h4>
2138   <a name="t_pointer">Pointer Type</a>
2139 </h4>
2140
2141 <div>
2142
2143 <h5>Overview:</h5>
2144 <p>The pointer type is used to specify memory locations.
2145    Pointers are commonly used to reference objects in memory.</p>
2146
2147 <p>Pointer types may have an optional address space attribute defining the
2148    numbered address space where the pointed-to object resides. The default
2149    address space is number zero. The semantics of non-zero address
2150    spaces are target-specific.</p>
2151
2152 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2153    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2154
2155 <h5>Syntax:</h5>
2156 <pre>
2157   &lt;type&gt; *
2158 </pre>
2159
2160 <h5>Examples:</h5>
2161 <table class="layout">
2162   <tr class="layout">
2163     <td class="left"><tt>[4 x i32]*</tt></td>
2164     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2165                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2166   </tr>
2167   <tr class="layout">
2168     <td class="left"><tt>i32 (i32*) *</tt></td>
2169     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2170       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2171       <tt>i32</tt>.</td>
2172   </tr>
2173   <tr class="layout">
2174     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2175     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2176      that resides in address space #5.</td>
2177   </tr>
2178 </table>
2179
2180 </div>
2181
2182 <!-- _______________________________________________________________________ -->
2183 <h4>
2184   <a name="t_vector">Vector Type</a>
2185 </h4>
2186
2187 <div>
2188
2189 <h5>Overview:</h5>
2190 <p>A vector type is a simple derived type that represents a vector of elements.
2191    Vector types are used when multiple primitive data are operated in parallel
2192    using a single instruction (SIMD).  A vector type requires a size (number of
2193    elements) and an underlying primitive data type.  Vector types are considered
2194    <a href="#t_firstclass">first class</a>.</p>
2195
2196 <h5>Syntax:</h5>
2197 <pre>
2198   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2199 </pre>
2200
2201 <p>The number of elements is a constant integer value larger than 0; elementtype
2202    may be any integer or floating point type, or a pointer to these types.
2203    Vectors of size zero are not allowed. </p>
2204
2205 <h5>Examples:</h5>
2206 <table class="layout">
2207   <tr class="layout">
2208     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2209     <td class="left">Vector of 4 32-bit integer values.</td>
2210   </tr>
2211   <tr class="layout">
2212     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2213     <td class="left">Vector of 8 32-bit floating-point values.</td>
2214   </tr>
2215   <tr class="layout">
2216     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2217     <td class="left">Vector of 2 64-bit integer values.</td>
2218   </tr>
2219   <tr class="layout">
2220     <td class="left"><tt>&lt;4 x i64*&gt;</tt></td>
2221     <td class="left">Vector of 4 pointers to 64-bit integer values.</td>
2222   </tr>
2223 </table>
2224
2225 </div>
2226
2227 </div>
2228
2229 </div>
2230
2231 <!-- *********************************************************************** -->
2232 <h2><a name="constants">Constants</a></h2>
2233 <!-- *********************************************************************** -->
2234
2235 <div>
2236
2237 <p>LLVM has several different basic types of constants.  This section describes
2238    them all and their syntax.</p>
2239
2240 <!-- ======================================================================= -->
2241 <h3>
2242   <a name="simpleconstants">Simple Constants</a>
2243 </h3>
2244
2245 <div>
2246
2247 <dl>
2248   <dt><b>Boolean constants</b></dt>
2249   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2250       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2251
2252   <dt><b>Integer constants</b></dt>
2253   <dd>Standard integers (such as '4') are constants of
2254       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2255       with integer types.</dd>
2256
2257   <dt><b>Floating point constants</b></dt>
2258   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2259       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2260       notation (see below).  The assembler requires the exact decimal value of a
2261       floating-point constant.  For example, the assembler accepts 1.25 but
2262       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2263       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2264
2265   <dt><b>Null pointer constants</b></dt>
2266   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2267       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2268 </dl>
2269
2270 <p>The one non-intuitive notation for constants is the hexadecimal form of
2271    floating point constants.  For example, the form '<tt>double
2272    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2273    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2274    constants are required (and the only time that they are generated by the
2275    disassembler) is when a floating point constant must be emitted but it cannot
2276    be represented as a decimal floating point number in a reasonable number of
2277    digits.  For example, NaN's, infinities, and other special values are
2278    represented in their IEEE hexadecimal format so that assembly and disassembly
2279    do not cause any bits to change in the constants.</p>
2280
2281 <p>When using the hexadecimal form, constants of types half, float, and double are
2282    represented using the 16-digit form shown above (which matches the IEEE754
2283    representation for double); half and float values must, however, be exactly
2284    representable as IEE754 half and single precision, respectively.
2285    Hexadecimal format is always used
2286    for long double, and there are three forms of long double.  The 80-bit format
2287    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2288    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2289    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2290    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2291    currently supported target uses this format.  Long doubles will only work if
2292    they match the long double format on your target. The IEEE 16-bit format
2293    (half precision) is represented by <tt>0xH</tt> followed by 4 hexadecimal
2294    digits. All hexadecimal formats are big-endian (sign bit at the left).</p>
2295
2296 <p>There are no constants of type x86mmx.</p>
2297 </div>
2298
2299 <!-- ======================================================================= -->
2300 <h3>
2301 <a name="aggregateconstants"></a> <!-- old anchor -->
2302 <a name="complexconstants">Complex Constants</a>
2303 </h3>
2304
2305 <div>
2306
2307 <p>Complex constants are a (potentially recursive) combination of simple
2308    constants and smaller complex constants.</p>
2309
2310 <dl>
2311   <dt><b>Structure constants</b></dt>
2312   <dd>Structure constants are represented with notation similar to structure
2313       type definitions (a comma separated list of elements, surrounded by braces
2314       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2315       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2316       Structure constants must have <a href="#t_struct">structure type</a>, and
2317       the number and types of elements must match those specified by the
2318       type.</dd>
2319
2320   <dt><b>Array constants</b></dt>
2321   <dd>Array constants are represented with notation similar to array type
2322      definitions (a comma separated list of elements, surrounded by square
2323      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2324      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2325      the number and types of elements must match those specified by the
2326      type.</dd>
2327
2328   <dt><b>Vector constants</b></dt>
2329   <dd>Vector constants are represented with notation similar to vector type
2330       definitions (a comma separated list of elements, surrounded by
2331       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2332       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2333       have <a href="#t_vector">vector type</a>, and the number and types of
2334       elements must match those specified by the type.</dd>
2335
2336   <dt><b>Zero initialization</b></dt>
2337   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2338       value to zero of <em>any</em> type, including scalar and
2339       <a href="#t_aggregate">aggregate</a> types.
2340       This is often used to avoid having to print large zero initializers
2341       (e.g. for large arrays) and is always exactly equivalent to using explicit
2342       zero initializers.</dd>
2343
2344   <dt><b>Metadata node</b></dt>
2345   <dd>A metadata node is a structure-like constant with
2346       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2347       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2348       be interpreted as part of the instruction stream, metadata is a place to
2349       attach additional information such as debug info.</dd>
2350 </dl>
2351
2352 </div>
2353
2354 <!-- ======================================================================= -->
2355 <h3>
2356   <a name="globalconstants">Global Variable and Function Addresses</a>
2357 </h3>
2358
2359 <div>
2360
2361 <p>The addresses of <a href="#globalvars">global variables</a>
2362    and <a href="#functionstructure">functions</a> are always implicitly valid
2363    (link-time) constants.  These constants are explicitly referenced when
2364    the <a href="#identifiers">identifier for the global</a> is used and always
2365    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2366    legal LLVM file:</p>
2367
2368 <pre class="doc_code">
2369 @X = global i32 17
2370 @Y = global i32 42
2371 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2372 </pre>
2373
2374 </div>
2375
2376 <!-- ======================================================================= -->
2377 <h3>
2378   <a name="undefvalues">Undefined Values</a>
2379 </h3>
2380
2381 <div>
2382
2383 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2384    indicates that the user of the value may receive an unspecified bit-pattern.
2385    Undefined values may be of any type (other than '<tt>label</tt>'
2386    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2387
2388 <p>Undefined values are useful because they indicate to the compiler that the
2389    program is well defined no matter what value is used.  This gives the
2390    compiler more freedom to optimize.  Here are some examples of (potentially
2391    surprising) transformations that are valid (in pseudo IR):</p>
2392
2393
2394 <pre class="doc_code">
2395   %A = add %X, undef
2396   %B = sub %X, undef
2397   %C = xor %X, undef
2398 Safe:
2399   %A = undef
2400   %B = undef
2401   %C = undef
2402 </pre>
2403
2404 <p>This is safe because all of the output bits are affected by the undef bits.
2405    Any output bit can have a zero or one depending on the input bits.</p>
2406
2407 <pre class="doc_code">
2408   %A = or %X, undef
2409   %B = and %X, undef
2410 Safe:
2411   %A = -1
2412   %B = 0
2413 Unsafe:
2414   %A = undef
2415   %B = undef
2416 </pre>
2417
2418 <p>These logical operations have bits that are not always affected by the input.
2419    For example, if <tt>%X</tt> has a zero bit, then the output of the
2420    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2421    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2422    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2423    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2424    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2425    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2426    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2427
2428 <pre class="doc_code">
2429   %A = select undef, %X, %Y
2430   %B = select undef, 42, %Y
2431   %C = select %X, %Y, undef
2432 Safe:
2433   %A = %X     (or %Y)
2434   %B = 42     (or %Y)
2435   %C = %Y
2436 Unsafe:
2437   %A = undef
2438   %B = undef
2439   %C = undef
2440 </pre>
2441
2442 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2443    branch) conditions can go <em>either way</em>, but they have to come from one
2444    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2445    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2446    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2447    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2448    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2449    eliminated.</p>
2450
2451 <pre class="doc_code">
2452   %A = xor undef, undef
2453
2454   %B = undef
2455   %C = xor %B, %B
2456
2457   %D = undef
2458   %E = icmp lt %D, 4
2459   %F = icmp gte %D, 4
2460
2461 Safe:
2462   %A = undef
2463   %B = undef
2464   %C = undef
2465   %D = undef
2466   %E = undef
2467   %F = undef
2468 </pre>
2469
2470 <p>This example points out that two '<tt>undef</tt>' operands are not
2471    necessarily the same. This can be surprising to people (and also matches C
2472    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2473    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2474    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2475    its value over its "live range".  This is true because the variable doesn't
2476    actually <em>have a live range</em>. Instead, the value is logically read
2477    from arbitrary registers that happen to be around when needed, so the value
2478    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2479    need to have the same semantics or the core LLVM "replace all uses with"
2480    concept would not hold.</p>
2481
2482 <pre class="doc_code">
2483   %A = fdiv undef, %X
2484   %B = fdiv %X, undef
2485 Safe:
2486   %A = undef
2487 b: unreachable
2488 </pre>
2489
2490 <p>These examples show the crucial difference between an <em>undefined
2491   value</em> and <em>undefined behavior</em>. An undefined value (like
2492   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2493   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2494   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2495   defined on SNaN's. However, in the second example, we can make a more
2496   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2497   arbitrary value, we are allowed to assume that it could be zero. Since a
2498   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2499   the operation does not execute at all. This allows us to delete the divide and
2500   all code after it. Because the undefined operation "can't happen", the
2501   optimizer can assume that it occurs in dead code.</p>
2502
2503 <pre class="doc_code">
2504 a:  store undef -> %X
2505 b:  store %X -> undef
2506 Safe:
2507 a: &lt;deleted&gt;
2508 b: unreachable
2509 </pre>
2510
2511 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2512    undefined value can be assumed to not have any effect; we can assume that the
2513    value is overwritten with bits that happen to match what was already there.
2514    However, a store <em>to</em> an undefined location could clobber arbitrary
2515    memory, therefore, it has undefined behavior.</p>
2516
2517 </div>
2518
2519 <!-- ======================================================================= -->
2520 <h3>
2521   <a name="poisonvalues">Poison Values</a>
2522 </h3>
2523
2524 <div>
2525
2526 <p>Poison values are similar to <a href="#undefvalues">undef values</a>, however
2527    they also represent the fact that an instruction or constant expression which
2528    cannot evoke side effects has nevertheless detected a condition which results
2529    in undefined behavior.</p>
2530
2531 <p>There is currently no way of representing a poison value in the IR; they
2532    only exist when produced by operations such as
2533    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2534
2535 <p>Poison value behavior is defined in terms of value <i>dependence</i>:</p>
2536
2537 <ul>
2538 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2539     their operands.</li>
2540
2541 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2542     to their dynamic predecessor basic block.</li>
2543
2544 <li>Function arguments depend on the corresponding actual argument values in
2545     the dynamic callers of their functions.</li>
2546
2547 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2548     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2549     control back to them.</li>
2550
2551 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2552     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_resume"><tt>resume</tt></a>,
2553     or exception-throwing call instructions that dynamically transfer control
2554     back to them.</li>
2555
2556 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2557     referenced memory addresses, following the order in the IR
2558     (including loads and stores implied by intrinsics such as
2559     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2560
2561 <!-- TODO: In the case of multiple threads, this only applies if the store
2562      "happens-before" the load or store. -->
2563
2564 <!-- TODO: floating-point exception state -->
2565
2566 <li>An instruction with externally visible side effects depends on the most
2567     recent preceding instruction with externally visible side effects, following
2568     the order in the IR. (This includes
2569     <a href="#volatile">volatile operations</a>.)</li>
2570
2571 <li>An instruction <i>control-depends</i> on a
2572     <a href="#terminators">terminator instruction</a>
2573     if the terminator instruction has multiple successors and the instruction
2574     is always executed when control transfers to one of the successors, and
2575     may not be executed when control is transferred to another.</li>
2576
2577 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2578     instruction if the set of instructions it otherwise depends on would be
2579     different if the terminator had transferred control to a different
2580     successor.</li>
2581
2582 <li>Dependence is transitive.</li>
2583
2584 </ul>
2585
2586 <p>Poison Values have the same behavior as <a href="#undefvalues">undef values</a>,
2587    with the additional affect that any instruction which has a <i>dependence</i>
2588    on a poison value has undefined behavior.</p>
2589
2590 <p>Here are some examples:</p>
2591
2592 <pre class="doc_code">
2593 entry:
2594   %poison = sub nuw i32 0, 1           ; Results in a poison value.
2595   %still_poison = and i32 %poison, 0   ; 0, but also poison.
2596   %poison_yet_again = getelementptr i32* @h, i32 %still_poison
2597   store i32 0, i32* %poison_yet_again  ; memory at @h[0] is poisoned
2598
2599   store i32 %poison, i32* @g           ; Poison value stored to memory.
2600   %poison2 = load i32* @g              ; Poison value loaded back from memory.
2601
2602   store volatile i32 %poison, i32* @g  ; External observation; undefined behavior.
2603
2604   %narrowaddr = bitcast i32* @g to i16*
2605   %wideaddr = bitcast i32* @g to i64*
2606   %poison3 = load i16* %narrowaddr     ; Returns a poison value.
2607   %poison4 = load i64* %wideaddr       ; Returns a poison value.
2608
2609   %cmp = icmp slt i32 %poison, 0       ; Returns a poison value.
2610   br i1 %cmp, label %true, label %end  ; Branch to either destination.
2611
2612 true:
2613   store volatile i32 0, i32* @g        ; This is control-dependent on %cmp, so
2614                                        ; it has undefined behavior.
2615   br label %end
2616
2617 end:
2618   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2619                                        ; Both edges into this PHI are
2620                                        ; control-dependent on %cmp, so this
2621                                        ; always results in a poison value.
2622
2623   store volatile i32 0, i32* @g        ; This would depend on the store in %true
2624                                        ; if %cmp is true, or the store in %entry
2625                                        ; otherwise, so this is undefined behavior.
2626
2627   br i1 %cmp, label %second_true, label %second_end
2628                                        ; The same branch again, but this time the
2629                                        ; true block doesn't have side effects.
2630
2631 second_true:
2632   ; No side effects!
2633   ret void
2634
2635 second_end:
2636   store volatile i32 0, i32* @g        ; This time, the instruction always depends
2637                                        ; on the store in %end. Also, it is
2638                                        ; control-equivalent to %end, so this is
2639                                        ; well-defined (ignoring earlier undefined
2640                                        ; behavior in this example).
2641 </pre>
2642
2643 </div>
2644
2645 <!-- ======================================================================= -->
2646 <h3>
2647   <a name="blockaddress">Addresses of Basic Blocks</a>
2648 </h3>
2649
2650 <div>
2651
2652 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2653
2654 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2655    basic block in the specified function, and always has an i8* type.  Taking
2656    the address of the entry block is illegal.</p>
2657
2658 <p>This value only has defined behavior when used as an operand to the
2659    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2660    comparisons against null. Pointer equality tests between labels addresses
2661    results in undefined behavior &mdash; though, again, comparison against null
2662    is ok, and no label is equal to the null pointer. This may be passed around
2663    as an opaque pointer sized value as long as the bits are not inspected. This
2664    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2665    long as the original value is reconstituted before the <tt>indirectbr</tt>
2666    instruction.</p>
2667
2668 <p>Finally, some targets may provide defined semantics when using the value as
2669    the operand to an inline assembly, but that is target specific.</p>
2670
2671 </div>
2672
2673
2674 <!-- ======================================================================= -->
2675 <h3>
2676   <a name="constantexprs">Constant Expressions</a>
2677 </h3>
2678
2679 <div>
2680
2681 <p>Constant expressions are used to allow expressions involving other constants
2682    to be used as constants.  Constant expressions may be of
2683    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2684    operation that does not have side effects (e.g. load and call are not
2685    supported). The following is the syntax for constant expressions:</p>
2686
2687 <dl>
2688   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2689   <dd>Truncate a constant to another type. The bit size of CST must be larger
2690       than the bit size of TYPE. Both types must be integers.</dd>
2691
2692   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2693   <dd>Zero extend a constant to another type. The bit size of CST must be
2694       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2695
2696   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2697   <dd>Sign extend a constant to another type. The bit size of CST must be
2698       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2699
2700   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2701   <dd>Truncate a floating point constant to another floating point type. The
2702       size of CST must be larger than the size of TYPE. Both types must be
2703       floating point.</dd>
2704
2705   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2706   <dd>Floating point extend a constant to another type. The size of CST must be
2707       smaller or equal to the size of TYPE. Both types must be floating
2708       point.</dd>
2709
2710   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2711   <dd>Convert a floating point constant to the corresponding unsigned integer
2712       constant. TYPE must be a scalar or vector integer type. CST must be of
2713       scalar or vector floating point type. Both CST and TYPE must be scalars,
2714       or vectors of the same number of elements. If the value won't fit in the
2715       integer type, the results are undefined.</dd>
2716
2717   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2718   <dd>Convert a floating point constant to the corresponding signed integer
2719       constant.  TYPE must be a scalar or vector integer type. CST must be of
2720       scalar or vector floating point type. Both CST and TYPE must be scalars,
2721       or vectors of the same number of elements. If the value won't fit in the
2722       integer type, the results are undefined.</dd>
2723
2724   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2725   <dd>Convert an unsigned integer constant to the corresponding floating point
2726       constant. TYPE must be a scalar or vector floating point type. CST must be
2727       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2728       vectors of the same number of elements. If the value won't fit in the
2729       floating point type, the results are undefined.</dd>
2730
2731   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2732   <dd>Convert a signed integer constant to the corresponding floating point
2733       constant. TYPE must be a scalar or vector floating point type. CST must be
2734       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2735       vectors of the same number of elements. If the value won't fit in the
2736       floating point type, the results are undefined.</dd>
2737
2738   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2739   <dd>Convert a pointer typed constant to the corresponding integer constant
2740       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2741       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2742       make it fit in <tt>TYPE</tt>.</dd>
2743
2744   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2745   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2746       type.  CST must be of integer type. The CST value is zero extended,
2747       truncated, or unchanged to make it fit in a pointer size. This one is
2748       <i>really</i> dangerous!</dd>
2749
2750   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2751   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2752       are the same as those for the <a href="#i_bitcast">bitcast
2753       instruction</a>.</dd>
2754
2755   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2756   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2757   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2758       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2759       instruction, the index list may have zero or more indexes, which are
2760       required to make sense for the type of "CSTPTR".</dd>
2761
2762   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2763   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2764
2765   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2766   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2767
2768   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2769   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2770
2771   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2772   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2773       constants.</dd>
2774
2775   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2776   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2777     constants.</dd>
2778
2779   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2780   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2781       constants.</dd>
2782
2783   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2784   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2785     constants. The index list is interpreted in a similar manner as indices in
2786     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2787     index value must be specified.</dd>
2788
2789   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2790   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2791     constants. The index list is interpreted in a similar manner as indices in
2792     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2793     index value must be specified.</dd>
2794
2795   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2796   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2797       be any of the <a href="#binaryops">binary</a>
2798       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2799       on operands are the same as those for the corresponding instruction
2800       (e.g. no bitwise operations on floating point values are allowed).</dd>
2801 </dl>
2802
2803 </div>
2804
2805 </div>
2806
2807 <!-- *********************************************************************** -->
2808 <h2><a name="othervalues">Other Values</a></h2>
2809 <!-- *********************************************************************** -->
2810 <div>
2811 <!-- ======================================================================= -->
2812 <h3>
2813 <a name="inlineasm">Inline Assembler Expressions</a>
2814 </h3>
2815
2816 <div>
2817
2818 <p>LLVM supports inline assembler expressions (as opposed
2819    to <a href="#moduleasm">Module-Level Inline Assembly</a>) through the use of
2820    a special value.  This value represents the inline assembler as a string
2821    (containing the instructions to emit), a list of operand constraints (stored
2822    as a string), a flag that indicates whether or not the inline asm
2823    expression has side effects, and a flag indicating whether the function
2824    containing the asm needs to align its stack conservatively.  An example
2825    inline assembler expression is:</p>
2826
2827 <pre class="doc_code">
2828 i32 (i32) asm "bswap $0", "=r,r"
2829 </pre>
2830
2831 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2832    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2833    have:</p>
2834
2835 <pre class="doc_code">
2836 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2837 </pre>
2838
2839 <p>Inline asms with side effects not visible in the constraint list must be
2840    marked as having side effects.  This is done through the use of the
2841    '<tt>sideeffect</tt>' keyword, like so:</p>
2842
2843 <pre class="doc_code">
2844 call void asm sideeffect "eieio", ""()
2845 </pre>
2846
2847 <p>In some cases inline asms will contain code that will not work unless the
2848    stack is aligned in some way, such as calls or SSE instructions on x86,
2849    yet will not contain code that does that alignment within the asm.
2850    The compiler should make conservative assumptions about what the asm might
2851    contain and should generate its usual stack alignment code in the prologue
2852    if the '<tt>alignstack</tt>' keyword is present:</p>
2853
2854 <pre class="doc_code">
2855 call void asm alignstack "eieio", ""()
2856 </pre>
2857
2858 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2859    first.</p>
2860
2861 <!--
2862 <p>TODO: The format of the asm and constraints string still need to be
2863    documented here.  Constraints on what can be done (e.g. duplication, moving,
2864    etc need to be documented).  This is probably best done by reference to
2865    another document that covers inline asm from a holistic perspective.</p>
2866   -->
2867
2868 <!-- _______________________________________________________________________ -->
2869 <h4>
2870   <a name="inlineasm_md">Inline Asm Metadata</a>
2871 </h4>
2872
2873 <div>
2874
2875 <p>The call instructions that wrap inline asm nodes may have a
2876    "<tt>!srcloc</tt>" MDNode attached to it that contains a list of constant
2877    integers.  If present, the code generator will use the integer as the
2878    location cookie value when report errors through the <tt>LLVMContext</tt>
2879    error reporting mechanisms.  This allows a front-end to correlate backend
2880    errors that occur with inline asm back to the source code that produced it.
2881    For example:</p>
2882
2883 <pre class="doc_code">
2884 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2885 ...
2886 !42 = !{ i32 1234567 }
2887 </pre>
2888
2889 <p>It is up to the front-end to make sense of the magic numbers it places in the
2890    IR. If the MDNode contains multiple constants, the code generator will use
2891    the one that corresponds to the line of the asm that the error occurs on.</p>
2892
2893 </div>
2894
2895 </div>
2896
2897 <!-- ======================================================================= -->
2898 <h3>
2899   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2900 </h3>
2901
2902 <div>
2903
2904 <p>LLVM IR allows metadata to be attached to instructions in the program that
2905    can convey extra information about the code to the optimizers and code
2906    generator.  One example application of metadata is source-level debug
2907    information.  There are two metadata primitives: strings and nodes. All
2908    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2909    preceding exclamation point ('<tt>!</tt>').</p>
2910
2911 <p>A metadata string is a string surrounded by double quotes.  It can contain
2912    any character by escaping non-printable characters with "<tt>\xx</tt>" where
2913    "<tt>xx</tt>" is the two digit hex code.  For example:
2914    "<tt>!"test\00"</tt>".</p>
2915
2916 <p>Metadata nodes are represented with notation similar to structure constants
2917    (a comma separated list of elements, surrounded by braces and preceded by an
2918    exclamation point). Metadata nodes can have any values as their operand. For
2919    example:</p>
2920
2921 <div class="doc_code">
2922 <pre>
2923 !{ metadata !"test\00", i32 10}
2924 </pre>
2925 </div>
2926
2927 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2928    metadata nodes, which can be looked up in the module symbol table. For
2929    example:</p>
2930
2931 <div class="doc_code">
2932 <pre>
2933 !foo =  metadata !{!4, !3}
2934 </pre>
2935 </div>
2936
2937 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2938    function is using two metadata arguments:</p>
2939
2940 <div class="doc_code">
2941 <pre>
2942 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2943 </pre>
2944 </div>
2945
2946 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2947    attached to the <tt>add</tt> instruction using the <tt>!dbg</tt>
2948    identifier:</p>
2949
2950 <div class="doc_code">
2951 <pre>
2952 %indvar.next = add i64 %indvar, 1, !dbg !21
2953 </pre>
2954 </div>
2955
2956 <p>More information about specific metadata nodes recognized by the optimizers
2957    and code generator is found below.</p>
2958
2959 <!-- _______________________________________________________________________ -->
2960 <h4>
2961   <a name="tbaa">'<tt>tbaa</tt>' Metadata</a>
2962 </h4>
2963
2964 <div>
2965
2966 <p>In LLVM IR, memory does not have types, so LLVM's own type system is not
2967    suitable for doing TBAA. Instead, metadata is added to the IR to describe
2968    a type system of a higher level language. This can be used to implement
2969    typical C/C++ TBAA, but it can also be used to implement custom alias
2970    analysis behavior for other languages.</p>
2971
2972 <p>The current metadata format is very simple. TBAA metadata nodes have up to
2973    three fields, e.g.:</p>
2974
2975 <div class="doc_code">
2976 <pre>
2977 !0 = metadata !{ metadata !"an example type tree" }
2978 !1 = metadata !{ metadata !"int", metadata !0 }
2979 !2 = metadata !{ metadata !"float", metadata !0 }
2980 !3 = metadata !{ metadata !"const float", metadata !2, i64 1 }
2981 </pre>
2982 </div>
2983
2984 <p>The first field is an identity field. It can be any value, usually
2985    a metadata string, which uniquely identifies the type. The most important
2986    name in the tree is the name of the root node. Two trees with
2987    different root node names are entirely disjoint, even if they
2988    have leaves with common names.</p>
2989
2990 <p>The second field identifies the type's parent node in the tree, or
2991    is null or omitted for a root node. A type is considered to alias
2992    all of its descendants and all of its ancestors in the tree. Also,
2993    a type is considered to alias all types in other trees, so that
2994    bitcode produced from multiple front-ends is handled conservatively.</p>
2995
2996 <p>If the third field is present, it's an integer which if equal to 1
2997    indicates that the type is "constant" (meaning
2998    <tt>pointsToConstantMemory</tt> should return true; see
2999    <a href="AliasAnalysis.html#OtherItfs">other useful
3000    <tt>AliasAnalysis</tt> methods</a>).</p>
3001
3002 </div>
3003
3004 <!-- _______________________________________________________________________ -->
3005 <h4>
3006   <a name="fpmath">'<tt>fpmath</tt>' Metadata</a>
3007 </h4>
3008
3009 <div>
3010
3011 <p><tt>fpmath</tt> metadata may be attached to any instruction of floating point
3012   type.  It can be used to express the maximum acceptable error in the result of
3013   that instruction, in ULPs, thus potentially allowing the compiler to use a
3014   more efficient but less accurate method of computing it.  ULP is defined as
3015   follows:</p>
3016
3017 <blockquote>
3018
3019 <p>If <tt>x</tt> is a real number that lies between two finite consecutive
3020    floating-point numbers <tt>a</tt> and <tt>b</tt>, without being equal to one
3021    of them, then <tt>ulp(x) = |b - a|</tt>, otherwise <tt>ulp(x)</tt> is the
3022    distance between the two non-equal finite floating-point numbers nearest
3023    <tt>x</tt>. Moreover, <tt>ulp(NaN)</tt> is <tt>NaN</tt>.</p>
3024
3025 </blockquote>
3026
3027 <p>The metadata node shall consist of a single positive floating point number
3028    representing the maximum relative error, for example:</p>
3029
3030 <div class="doc_code">
3031 <pre>
3032 !0 = metadata !{ float 2.5 } ; maximum acceptable inaccuracy is 2.5 ULPs
3033 </pre>
3034 </div>
3035
3036 </div>
3037
3038 <!-- _______________________________________________________________________ -->
3039 <h4>
3040   <a name="range">'<tt>range</tt>' Metadata</a>
3041 </h4>
3042
3043 <div>
3044 <p><tt>range</tt> metadata may be attached only to loads of integer types. It
3045    expresses the possible ranges the loaded value is in. The ranges are
3046    represented with a flattened list of integers. The loaded value is known to
3047    be in the union of the ranges defined by each consecutive pair. Each pair
3048    has the following properties:</p>
3049 <ul>
3050    <li>The type must match the type loaded by the instruction.</li>
3051    <li>The pair <tt>a,b</tt> represents the range <tt>[a,b)</tt>.</li>
3052    <li>Both <tt>a</tt> and <tt>b</tt> are constants.</li>
3053    <li>The range is allowed to wrap.</li>
3054    <li>The range should not represent the full or empty set. That is,
3055        <tt>a!=b</tt>. </li>
3056 </ul>
3057 <p> In addition, the pairs must be in signed order of the lower bound and
3058   they must be non-contiguous.</p>
3059
3060 <p>Examples:</p>
3061 <div class="doc_code">
3062 <pre>
3063   %a = load i8* %x, align 1, !range !0 ; Can only be 0 or 1
3064   %b = load i8* %y, align 1, !range !1 ; Can only be 255 (-1), 0 or 1
3065   %c = load i8* %z, align 1, !range !2 ; Can only be 0, 1, 3, 4 or 5
3066   %d = load i8* %z, align 1, !range !3 ; Can only be -2, -1, 3, 4 or 5
3067 ...
3068 !0 = metadata !{ i8 0, i8 2 }
3069 !1 = metadata !{ i8 255, i8 2 }
3070 !2 = metadata !{ i8 0, i8 2, i8 3, i8 6 }
3071 !3 = metadata !{ i8 -2, i8 0, i8 3, i8 6 }
3072 </pre>
3073 </div>
3074 </div>
3075 </div>
3076
3077 </div>
3078
3079 <!-- *********************************************************************** -->
3080 <h2>
3081   <a name="module_flags">Module Flags Metadata</a>
3082 </h2>
3083 <!-- *********************************************************************** -->
3084
3085 <div>
3086
3087 <p>Information about the module as a whole is difficult to convey to LLVM's
3088    subsystems. The LLVM IR isn't sufficient to transmit this
3089    information. The <tt>llvm.module.flags</tt> named metadata exists in order to
3090    facilitate this. These flags are in the form of key / value pairs &mdash;
3091    much like a dictionary &mdash; making it easy for any subsystem who cares
3092    about a flag to look it up.</p>
3093
3094 <p>The <tt>llvm.module.flags</tt> metadata contains a list of metadata
3095    triplets. Each triplet has the following form:</p>
3096
3097 <ul>
3098   <li>The first element is a <i>behavior</i> flag, which specifies the behavior
3099       when two (or more) modules are merged together, and it encounters two (or
3100       more) metadata with the same ID. The supported behaviors are described
3101       below.</li>
3102
3103   <li>The second element is a metadata string that is a unique ID for the
3104       metadata. How each ID is interpreted is documented below.</li>
3105
3106   <li>The third element is the value of the flag.</li>
3107 </ul>
3108
3109 <p>When two (or more) modules are merged together, the resulting
3110    <tt>llvm.module.flags</tt> metadata is the union of the
3111    modules' <tt>llvm.module.flags</tt> metadata. The only exception being a flag
3112    with the <i>Override</i> behavior, which may override another flag's value
3113    (see below).</p>
3114
3115 <p>The following behaviors are supported:</p>
3116
3117 <table border="1" cellspacing="0" cellpadding="4">
3118   <tbody>
3119     <tr>
3120       <th>Value</th>
3121       <th>Behavior</th>
3122     </tr>
3123     <tr>
3124       <td>1</td>
3125       <td align="left">
3126         <dl>
3127           <dt><b>Error</b></dt>
3128           <dd>Emits an error if two values disagree. It is an error to have an ID
3129               with both an Error and a Warning behavior.</dd>
3130         </dl>
3131       </td>
3132     </tr>
3133     <tr>
3134       <td>2</td>
3135       <td align="left">
3136         <dl>
3137           <dt><b>Warning</b></dt>
3138           <dd>Emits a warning if two values disagree.</dd>
3139         </dl>
3140       </td>
3141     </tr>
3142     <tr>
3143       <td>3</td>
3144       <td align="left">
3145         <dl>
3146           <dt><b>Require</b></dt>
3147           <dd>Emits an error when the specified value is not present or doesn't
3148               have the specified value. It is an error for two (or more)
3149               <tt>llvm.module.flags</tt> with the same ID to have the Require
3150               behavior but different values. There may be multiple Require flags
3151               per ID.</dd>
3152         </dl>
3153       </td>
3154     </tr>
3155     <tr>
3156       <td>4</td>
3157       <td align="left">
3158         <dl>
3159           <dt><b>Override</b></dt>
3160           <dd>Uses the specified value if the two values disagree. It is an
3161               error for two (or more) <tt>llvm.module.flags</tt> with the same
3162               ID to have the Override behavior but different values.</dd>
3163         </dl>
3164       </td>
3165     </tr>
3166   </tbody>
3167 </table>
3168
3169 <p>An example of module flags:</p>
3170
3171 <pre class="doc_code">
3172 !0 = metadata !{ i32 1, metadata !"foo", i32 1 }
3173 !1 = metadata !{ i32 4, metadata !"bar", i32 37 }
3174 !2 = metadata !{ i32 2, metadata !"qux", i32 42 }
3175 !3 = metadata !{ i32 3, metadata !"qux",
3176   metadata !{
3177     metadata !"foo", i32 1
3178   }
3179 }
3180 !llvm.module.flags = !{ !0, !1, !2, !3 }
3181 </pre>
3182
3183 <ul>
3184   <li><p>Metadata <tt>!0</tt> has the ID <tt>!"foo"</tt> and the value '1'. The
3185          behavior if two or more <tt>!"foo"</tt> flags are seen is to emit an
3186          error if their values are not equal.</p></li>
3187
3188   <li><p>Metadata <tt>!1</tt> has the ID <tt>!"bar"</tt> and the value '37'. The
3189          behavior if two or more <tt>!"bar"</tt> flags are seen is to use the
3190          value '37' if their values are not equal.</p></li>
3191
3192   <li><p>Metadata <tt>!2</tt> has the ID <tt>!"qux"</tt> and the value '42'. The
3193          behavior if two or more <tt>!"qux"</tt> flags are seen is to emit a
3194          warning if their values are not equal.</p></li>
3195
3196   <li><p>Metadata <tt>!3</tt> has the ID <tt>!"qux"</tt> and the value:</p>
3197
3198 <pre class="doc_code">
3199 metadata !{ metadata !"foo", i32 1 }
3200 </pre>
3201
3202       <p>The behavior is to emit an error if the <tt>llvm.module.flags</tt> does
3203          not contain a flag with the ID <tt>!"foo"</tt> that has the value
3204          '1'. If two or more <tt>!"qux"</tt> flags exist, then they must have
3205          the same value or an error will be issued.</p></li>
3206 </ul>
3207
3208
3209 <!-- ======================================================================= -->
3210 <h3>
3211 <a name="objc_gc_flags">Objective-C Garbage Collection Module Flags Metadata</a>
3212 </h3>
3213
3214 <div>
3215
3216 <p>On the Mach-O platform, Objective-C stores metadata about garbage collection
3217    in a special section called "image info". The metadata consists of a version
3218    number and a bitmask specifying what types of garbage collection are
3219    supported (if any) by the file. If two or more modules are linked together
3220    their garbage collection metadata needs to be merged rather than appended
3221    together.</p>
3222
3223 <p>The Objective-C garbage collection module flags metadata consists of the
3224    following key-value pairs:</p>
3225
3226 <table border="1" cellspacing="0" cellpadding="4">
3227   <col width="30%">
3228   <tbody>
3229     <tr>
3230       <th>Key</th>
3231       <th>Value</th>
3232     </tr>
3233     <tr>
3234       <td><tt>Objective-C&nbsp;Version</tt></td>
3235       <td align="left"><b>[Required]</b> &mdash; The Objective-C ABI
3236          version. Valid values are 1 and 2.</td>
3237     </tr>
3238     <tr>
3239       <td><tt>Objective-C&nbsp;Image&nbsp;Info&nbsp;Version</tt></td>
3240       <td align="left"><b>[Required]</b> &mdash; The version of the image info
3241          section. Currently always 0.</td>
3242     </tr>
3243     <tr>
3244       <td><tt>Objective-C&nbsp;Image&nbsp;Info&nbsp;Section</tt></td>
3245       <td align="left"><b>[Required]</b> &mdash; The section to place the
3246          metadata. Valid values are <tt>"__OBJC, __image_info, regular"</tt> for
3247          Objective-C ABI version 1, and <tt>"__DATA,__objc_imageinfo, regular,
3248          no_dead_strip"</tt> for Objective-C ABI version 2.</td>
3249     </tr>
3250     <tr>
3251       <td><tt>Objective-C&nbsp;Garbage&nbsp;Collection</tt></td>
3252       <td align="left"><b>[Required]</b> &mdash; Specifies whether garbage
3253           collection is supported or not. Valid values are 0, for no garbage
3254           collection, and 2, for garbage collection supported.</td>
3255     </tr>
3256     <tr>
3257       <td><tt>Objective-C&nbsp;GC&nbsp;Only</tt></td>
3258       <td align="left"><b>[Optional]</b> &mdash; Specifies that only garbage
3259          collection is supported. If present, its value must be 6. This flag
3260          requires that the <tt>Objective-C Garbage Collection</tt> flag have the
3261          value 2.</td>
3262     </tr>
3263   </tbody>
3264 </table>
3265
3266 <p>Some important flag interactions:</p>
3267
3268 <ul>
3269   <li>If a module with <tt>Objective-C Garbage Collection</tt> set to 0 is
3270       merged with a module with <tt>Objective-C Garbage Collection</tt> set to
3271       2, then the resulting module has the <tt>Objective-C Garbage
3272       Collection</tt> flag set to 0.</li>
3273
3274   <li>A module with <tt>Objective-C Garbage Collection</tt> set to 0 cannot be
3275       merged with a module with <tt>Objective-C GC Only</tt> set to 6.</li>
3276 </ul>
3277
3278 </div>
3279
3280 </div>
3281
3282 <!-- *********************************************************************** -->
3283 <h2>
3284   <a name="intrinsic_globals">Intrinsic Global Variables</a>
3285 </h2>
3286 <!-- *********************************************************************** -->
3287 <div>
3288 <p>LLVM has a number of "magic" global variables that contain data that affect
3289 code generation or other IR semantics.  These are documented here.  All globals
3290 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
3291 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
3292 by LLVM.</p>
3293
3294 <!-- ======================================================================= -->
3295 <h3>
3296 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
3297 </h3>
3298
3299 <div>
3300
3301 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
3302 href="#linkage_appending">appending linkage</a>.  This array contains a list of
3303 pointers to global variables and functions which may optionally have a pointer
3304 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
3305
3306 <div class="doc_code">
3307 <pre>
3308 @X = global i8 4
3309 @Y = global i32 123
3310
3311 @llvm.used = appending global [2 x i8*] [
3312    i8* @X,
3313    i8* bitcast (i32* @Y to i8*)
3314 ], section "llvm.metadata"
3315 </pre>
3316 </div>
3317
3318 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
3319    compiler, assembler, and linker are required to treat the symbol as if there
3320    is a reference to the global that it cannot see.  For example, if a variable
3321    has internal linkage and no references other than that from
3322    the <tt>@llvm.used</tt> list, it cannot be deleted.  This is commonly used to
3323    represent references from inline asms and other things the compiler cannot
3324    "see", and corresponds to "<tt>attribute((used))</tt>" in GNU C.</p>
3325
3326 <p>On some targets, the code generator must emit a directive to the assembler or
3327    object file to prevent the assembler and linker from molesting the
3328    symbol.</p>
3329
3330 </div>
3331
3332 <!-- ======================================================================= -->
3333 <h3>
3334   <a name="intg_compiler_used">
3335     The '<tt>llvm.compiler.used</tt>' Global Variable
3336   </a>
3337 </h3>
3338
3339 <div>
3340
3341 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
3342    <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
3343    touching the symbol.  On targets that support it, this allows an intelligent
3344    linker to optimize references to the symbol without being impeded as it would
3345    be by <tt>@llvm.used</tt>.</p>
3346
3347 <p>This is a rare construct that should only be used in rare circumstances, and
3348    should not be exposed to source languages.</p>
3349
3350 </div>
3351
3352 <!-- ======================================================================= -->
3353 <h3>
3354 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
3355 </h3>
3356
3357 <div>
3358
3359 <div class="doc_code">
3360 <pre>
3361 %0 = type { i32, void ()* }
3362 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
3363 </pre>
3364 </div>
3365
3366 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor
3367    functions and associated priorities.  The functions referenced by this array
3368    will be called in ascending order of priority (i.e. lowest first) when the
3369    module is loaded.  The order of functions with the same priority is not
3370    defined.</p>
3371
3372 </div>
3373
3374 <!-- ======================================================================= -->
3375 <h3>
3376 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
3377 </h3>
3378
3379 <div>
3380
3381 <div class="doc_code">
3382 <pre>
3383 %0 = type { i32, void ()* }
3384 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
3385 </pre>
3386 </div>
3387
3388 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions
3389    and associated priorities.  The functions referenced by this array will be
3390    called in descending order of priority (i.e. highest first) when the module
3391    is loaded.  The order of functions with the same priority is not defined.</p>
3392
3393 </div>
3394
3395 </div>
3396
3397 <!-- *********************************************************************** -->
3398 <h2><a name="instref">Instruction Reference</a></h2>
3399 <!-- *********************************************************************** -->
3400
3401 <div>
3402
3403 <p>The LLVM instruction set consists of several different classifications of
3404    instructions: <a href="#terminators">terminator
3405    instructions</a>, <a href="#binaryops">binary instructions</a>,
3406    <a href="#bitwiseops">bitwise binary instructions</a>,
3407    <a href="#memoryops">memory instructions</a>, and
3408    <a href="#otherops">other instructions</a>.</p>
3409
3410 <!-- ======================================================================= -->
3411 <h3>
3412   <a name="terminators">Terminator Instructions</a>
3413 </h3>
3414
3415 <div>
3416
3417 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3418    in a program ends with a "Terminator" instruction, which indicates which
3419    block should be executed after the current block is finished. These
3420    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3421    control flow, not values (the one exception being the
3422    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3423
3424 <p>The terminator instructions are:
3425    '<a href="#i_ret"><tt>ret</tt></a>',
3426    '<a href="#i_br"><tt>br</tt></a>',
3427    '<a href="#i_switch"><tt>switch</tt></a>',
3428    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3429    '<a href="#i_invoke"><tt>invoke</tt></a>',
3430    '<a href="#i_resume"><tt>resume</tt></a>', and
3431    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3432
3433 <!-- _______________________________________________________________________ -->
3434 <h4>
3435   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3436 </h4>
3437
3438 <div>
3439
3440 <h5>Syntax:</h5>
3441 <pre>
3442   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3443   ret void                 <i>; Return from void function</i>
3444 </pre>
3445
3446 <h5>Overview:</h5>
3447 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3448    a value) from a function back to the caller.</p>
3449
3450 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3451    value and then causes control flow, and one that just causes control flow to
3452    occur.</p>
3453
3454 <h5>Arguments:</h5>
3455 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3456    return value. The type of the return value must be a
3457    '<a href="#t_firstclass">first class</a>' type.</p>
3458
3459 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3460    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3461    value or a return value with a type that does not match its type, or if it
3462    has a void return type and contains a '<tt>ret</tt>' instruction with a
3463    return value.</p>
3464
3465 <h5>Semantics:</h5>
3466 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3467    the calling function's context.  If the caller is a
3468    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3469    instruction after the call.  If the caller was an
3470    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3471    the beginning of the "normal" destination block.  If the instruction returns
3472    a value, that value shall set the call or invoke instruction's return
3473    value.</p>
3474
3475 <h5>Example:</h5>
3476 <pre>
3477   ret i32 5                       <i>; Return an integer value of 5</i>
3478   ret void                        <i>; Return from a void function</i>
3479   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3480 </pre>
3481
3482 </div>
3483 <!-- _______________________________________________________________________ -->
3484 <h4>
3485   <a name="i_br">'<tt>br</tt>' Instruction</a>
3486 </h4>
3487
3488 <div>
3489
3490 <h5>Syntax:</h5>
3491 <pre>
3492   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3493   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3494 </pre>
3495
3496 <h5>Overview:</h5>
3497 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3498    different basic block in the current function.  There are two forms of this
3499    instruction, corresponding to a conditional branch and an unconditional
3500    branch.</p>
3501
3502 <h5>Arguments:</h5>
3503 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3504    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3505    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3506    target.</p>
3507
3508 <h5>Semantics:</h5>
3509 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3510    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3511    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3512    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3513
3514 <h5>Example:</h5>
3515 <pre>
3516 Test:
3517   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3518   br i1 %cond, label %IfEqual, label %IfUnequal
3519 IfEqual:
3520   <a href="#i_ret">ret</a> i32 1
3521 IfUnequal:
3522   <a href="#i_ret">ret</a> i32 0
3523 </pre>
3524
3525 </div>
3526
3527 <!-- _______________________________________________________________________ -->
3528 <h4>
3529    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3530 </h4>
3531
3532 <div>
3533
3534 <h5>Syntax:</h5>
3535 <pre>
3536   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3537 </pre>
3538
3539 <h5>Overview:</h5>
3540 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3541    several different places.  It is a generalization of the '<tt>br</tt>'
3542    instruction, allowing a branch to occur to one of many possible
3543    destinations.</p>
3544
3545 <h5>Arguments:</h5>
3546 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3547    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3548    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3549    The table is not allowed to contain duplicate constant entries.</p>
3550
3551 <h5>Semantics:</h5>
3552 <p>The <tt>switch</tt> instruction specifies a table of values and
3553    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3554    is searched for the given value.  If the value is found, control flow is
3555    transferred to the corresponding destination; otherwise, control flow is
3556    transferred to the default destination.</p>
3557
3558 <h5>Implementation:</h5>
3559 <p>Depending on properties of the target machine and the particular
3560    <tt>switch</tt> instruction, this instruction may be code generated in
3561    different ways.  For example, it could be generated as a series of chained
3562    conditional branches or with a lookup table.</p>
3563
3564 <h5>Example:</h5>
3565 <pre>
3566  <i>; Emulate a conditional br instruction</i>
3567  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3568  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3569
3570  <i>; Emulate an unconditional br instruction</i>
3571  switch i32 0, label %dest [ ]
3572
3573  <i>; Implement a jump table:</i>
3574  switch i32 %val, label %otherwise [ i32 0, label %onzero
3575                                      i32 1, label %onone
3576                                      i32 2, label %ontwo ]
3577 </pre>
3578
3579 </div>
3580
3581
3582 <!-- _______________________________________________________________________ -->
3583 <h4>
3584    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3585 </h4>
3586
3587 <div>
3588
3589 <h5>Syntax:</h5>
3590 <pre>
3591   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3592 </pre>
3593
3594 <h5>Overview:</h5>
3595
3596 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3597    within the current function, whose address is specified by
3598    "<tt>address</tt>".  Address must be derived from a <a
3599    href="#blockaddress">blockaddress</a> constant.</p>
3600
3601 <h5>Arguments:</h5>
3602
3603 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3604    rest of the arguments indicate the full set of possible destinations that the
3605    address may point to.  Blocks are allowed to occur multiple times in the
3606    destination list, though this isn't particularly useful.</p>
3607
3608 <p>This destination list is required so that dataflow analysis has an accurate
3609    understanding of the CFG.</p>
3610
3611 <h5>Semantics:</h5>
3612
3613 <p>Control transfers to the block specified in the address argument.  All
3614    possible destination blocks must be listed in the label list, otherwise this
3615    instruction has undefined behavior.  This implies that jumps to labels
3616    defined in other functions have undefined behavior as well.</p>
3617
3618 <h5>Implementation:</h5>
3619
3620 <p>This is typically implemented with a jump through a register.</p>
3621
3622 <h5>Example:</h5>
3623 <pre>
3624  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3625 </pre>
3626
3627 </div>
3628
3629
3630 <!-- _______________________________________________________________________ -->
3631 <h4>
3632   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3633 </h4>
3634
3635 <div>
3636
3637 <h5>Syntax:</h5>
3638 <pre>
3639   &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>]
3640                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3641 </pre>
3642
3643 <h5>Overview:</h5>
3644 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3645    function, with the possibility of control flow transfer to either the
3646    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3647    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3648    control flow will return to the "normal" label.  If the callee (or any
3649    indirect callees) returns via the "<a href="#i_resume"><tt>resume</tt></a>"
3650    instruction or other exception handling mechanism, control is interrupted and
3651    continued at the dynamically nearest "exception" label.</p>
3652
3653 <p>The '<tt>exception</tt>' label is a
3654    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3655    exception. As such, '<tt>exception</tt>' label is required to have the
3656    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3657    the information about the behavior of the program after unwinding
3658    happens, as its first non-PHI instruction. The restrictions on the
3659    "<tt>landingpad</tt>" instruction's tightly couples it to the
3660    "<tt>invoke</tt>" instruction, so that the important information contained
3661    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3662    code motion.</p>
3663
3664 <h5>Arguments:</h5>
3665 <p>This instruction requires several arguments:</p>
3666
3667 <ol>
3668   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3669       convention</a> the call should use.  If none is specified, the call
3670       defaults to using C calling conventions.</li>
3671
3672   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3673       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3674       '<tt>inreg</tt>' attributes are valid here.</li>
3675
3676   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3677       function value being invoked.  In most cases, this is a direct function
3678       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3679       off an arbitrary pointer to function value.</li>
3680
3681   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3682       function to be invoked. </li>
3683
3684   <li>'<tt>function args</tt>': argument list whose types match the function
3685       signature argument types and parameter attributes. All arguments must be
3686       of <a href="#t_firstclass">first class</a> type. If the function
3687       signature indicates the function accepts a variable number of arguments,
3688       the extra arguments can be specified.</li>
3689
3690   <li>'<tt>normal label</tt>': the label reached when the called function
3691       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3692
3693   <li>'<tt>exception label</tt>': the label reached when a callee returns via
3694       the <a href="#i_resume"><tt>resume</tt></a> instruction or other exception
3695       handling mechanism.</li>
3696
3697   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3698       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3699       '<tt>readnone</tt>' attributes are valid here.</li>
3700 </ol>
3701
3702 <h5>Semantics:</h5>
3703 <p>This instruction is designed to operate as a standard
3704    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3705    primary difference is that it establishes an association with a label, which
3706    is used by the runtime library to unwind the stack.</p>
3707
3708 <p>This instruction is used in languages with destructors to ensure that proper
3709    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3710    exception.  Additionally, this is important for implementation of
3711    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3712
3713 <p>For the purposes of the SSA form, the definition of the value returned by the
3714    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3715    block to the "normal" label. If the callee unwinds then no return value is
3716    available.</p>
3717
3718 <h5>Example:</h5>
3719 <pre>
3720   %retval = invoke i32 @Test(i32 15) to label %Continue
3721               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3722   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3723               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3724 </pre>
3725
3726 </div>
3727
3728  <!-- _______________________________________________________________________ -->
3729
3730 <h4>
3731   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3732 </h4>
3733
3734 <div>
3735
3736 <h5>Syntax:</h5>
3737 <pre>
3738   resume &lt;type&gt; &lt;value&gt;
3739 </pre>
3740
3741 <h5>Overview:</h5>
3742 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3743    successors.</p>
3744
3745 <h5>Arguments:</h5>
3746 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3747    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3748    function.</p>
3749
3750 <h5>Semantics:</h5>
3751 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3752    (in-flight) exception whose unwinding was interrupted with
3753    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3754
3755 <h5>Example:</h5>
3756 <pre>
3757   resume { i8*, i32 } %exn
3758 </pre>
3759
3760 </div>
3761
3762 <!-- _______________________________________________________________________ -->
3763
3764 <h4>
3765   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3766 </h4>
3767
3768 <div>
3769
3770 <h5>Syntax:</h5>
3771 <pre>
3772   unreachable
3773 </pre>
3774
3775 <h5>Overview:</h5>
3776 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3777    instruction is used to inform the optimizer that a particular portion of the
3778    code is not reachable.  This can be used to indicate that the code after a
3779    no-return function cannot be reached, and other facts.</p>
3780
3781 <h5>Semantics:</h5>
3782 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3783
3784 </div>
3785
3786 </div>
3787
3788 <!-- ======================================================================= -->
3789 <h3>
3790   <a name="binaryops">Binary Operations</a>
3791 </h3>
3792
3793 <div>
3794
3795 <p>Binary operators are used to do most of the computation in a program.  They
3796    require two operands of the same type, execute an operation on them, and
3797    produce a single value.  The operands might represent multiple data, as is
3798    the case with the <a href="#t_vector">vector</a> data type.  The result value
3799    has the same type as its operands.</p>
3800
3801 <p>There are several different binary operators:</p>
3802
3803 <!-- _______________________________________________________________________ -->
3804 <h4>
3805   <a name="i_add">'<tt>add</tt>' Instruction</a>
3806 </h4>
3807
3808 <div>
3809
3810 <h5>Syntax:</h5>
3811 <pre>
3812   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3813   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3814   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3815   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3816 </pre>
3817
3818 <h5>Overview:</h5>
3819 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3820
3821 <h5>Arguments:</h5>
3822 <p>The two arguments to the '<tt>add</tt>' instruction must
3823    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3824    integer values. Both arguments must have identical types.</p>
3825
3826 <h5>Semantics:</h5>
3827 <p>The value produced is the integer sum of the two operands.</p>
3828
3829 <p>If the sum has unsigned overflow, the result returned is the mathematical
3830    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3831
3832 <p>Because LLVM integers use a two's complement representation, this instruction
3833    is appropriate for both signed and unsigned integers.</p>
3834
3835 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3836    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3837    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3838    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
3839    respectively, occurs.</p>
3840
3841 <h5>Example:</h5>
3842 <pre>
3843   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3844 </pre>
3845
3846 </div>
3847
3848 <!-- _______________________________________________________________________ -->
3849 <h4>
3850   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3851 </h4>
3852
3853 <div>
3854
3855 <h5>Syntax:</h5>
3856 <pre>
3857   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3858 </pre>
3859
3860 <h5>Overview:</h5>
3861 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3862
3863 <h5>Arguments:</h5>
3864 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3865    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3866    floating point values. Both arguments must have identical types.</p>
3867
3868 <h5>Semantics:</h5>
3869 <p>The value produced is the floating point sum of the two operands.</p>
3870
3871 <h5>Example:</h5>
3872 <pre>
3873   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3874 </pre>
3875
3876 </div>
3877
3878 <!-- _______________________________________________________________________ -->
3879 <h4>
3880    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3881 </h4>
3882
3883 <div>
3884
3885 <h5>Syntax:</h5>
3886 <pre>
3887   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3888   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3889   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3890   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3891 </pre>
3892
3893 <h5>Overview:</h5>
3894 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3895    operands.</p>
3896
3897 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3898    '<tt>neg</tt>' instruction present in most other intermediate
3899    representations.</p>
3900
3901 <h5>Arguments:</h5>
3902 <p>The two arguments to the '<tt>sub</tt>' instruction must
3903    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3904    integer values.  Both arguments must have identical types.</p>
3905
3906 <h5>Semantics:</h5>
3907 <p>The value produced is the integer difference of the two operands.</p>
3908
3909 <p>If the difference has unsigned overflow, the result returned is the
3910    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3911    result.</p>
3912
3913 <p>Because LLVM integers use a two's complement representation, this instruction
3914    is appropriate for both signed and unsigned integers.</p>
3915
3916 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3917    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3918    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3919    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
3920    respectively, occurs.</p>
3921
3922 <h5>Example:</h5>
3923 <pre>
3924   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3925   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3926 </pre>
3927
3928 </div>
3929
3930 <!-- _______________________________________________________________________ -->
3931 <h4>
3932    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3933 </h4>
3934
3935 <div>
3936
3937 <h5>Syntax:</h5>
3938 <pre>
3939   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3940 </pre>
3941
3942 <h5>Overview:</h5>
3943 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3944    operands.</p>
3945
3946 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3947    '<tt>fneg</tt>' instruction present in most other intermediate
3948    representations.</p>
3949
3950 <h5>Arguments:</h5>
3951 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3952    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3953    floating point values.  Both arguments must have identical types.</p>
3954
3955 <h5>Semantics:</h5>
3956 <p>The value produced is the floating point difference of the two operands.</p>
3957
3958 <h5>Example:</h5>
3959 <pre>
3960   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3961   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3962 </pre>
3963
3964 </div>
3965
3966 <!-- _______________________________________________________________________ -->
3967 <h4>
3968   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3969 </h4>
3970
3971 <div>
3972
3973 <h5>Syntax:</h5>
3974 <pre>
3975   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3976   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3977   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3978   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3979 </pre>
3980
3981 <h5>Overview:</h5>
3982 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3983
3984 <h5>Arguments:</h5>
3985 <p>The two arguments to the '<tt>mul</tt>' instruction must
3986    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3987    integer values.  Both arguments must have identical types.</p>
3988
3989 <h5>Semantics:</h5>
3990 <p>The value produced is the integer product of the two operands.</p>
3991
3992 <p>If the result of the multiplication has unsigned overflow, the result
3993    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3994    width of the result.</p>
3995
3996 <p>Because LLVM integers use a two's complement representation, and the result
3997    is the same width as the operands, this instruction returns the correct
3998    result for both signed and unsigned integers.  If a full product
3999    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
4000    be sign-extended or zero-extended as appropriate to the width of the full
4001    product.</p>
4002
4003 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
4004    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
4005    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
4006    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
4007    respectively, occurs.</p>
4008
4009 <h5>Example:</h5>
4010 <pre>
4011   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
4012 </pre>
4013
4014 </div>
4015
4016 <!-- _______________________________________________________________________ -->
4017 <h4>
4018   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
4019 </h4>
4020
4021 <div>
4022
4023 <h5>Syntax:</h5>
4024 <pre>
4025   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4026 </pre>
4027
4028 <h5>Overview:</h5>
4029 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
4030
4031 <h5>Arguments:</h5>
4032 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
4033    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4034    floating point values.  Both arguments must have identical types.</p>
4035
4036 <h5>Semantics:</h5>
4037 <p>The value produced is the floating point product of the two operands.</p>
4038
4039 <h5>Example:</h5>
4040 <pre>
4041   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
4042 </pre>
4043
4044 </div>
4045
4046 <!-- _______________________________________________________________________ -->
4047 <h4>
4048   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
4049 </h4>
4050
4051 <div>
4052
4053 <h5>Syntax:</h5>
4054 <pre>
4055   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4056   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4057 </pre>
4058
4059 <h5>Overview:</h5>
4060 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
4061
4062 <h5>Arguments:</h5>
4063 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
4064    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4065    values.  Both arguments must have identical types.</p>
4066
4067 <h5>Semantics:</h5>
4068 <p>The value produced is the unsigned integer quotient of the two operands.</p>
4069
4070 <p>Note that unsigned integer division and signed integer division are distinct
4071    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
4072
4073 <p>Division by zero leads to undefined behavior.</p>
4074
4075 <p>If the <tt>exact</tt> keyword is present, the result value of the
4076    <tt>udiv</tt> is a <a href="#poisonvalues">poison value</a> if %op1 is not a
4077   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
4078
4079
4080 <h5>Example:</h5>
4081 <pre>
4082   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
4083 </pre>
4084
4085 </div>
4086
4087 <!-- _______________________________________________________________________ -->
4088 <h4>
4089   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
4090 </h4>
4091
4092 <div>
4093
4094 <h5>Syntax:</h5>
4095 <pre>
4096   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4097   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4098 </pre>
4099
4100 <h5>Overview:</h5>
4101 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
4102
4103 <h5>Arguments:</h5>
4104 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
4105    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4106    values.  Both arguments must have identical types.</p>
4107
4108 <h5>Semantics:</h5>
4109 <p>The value produced is the signed integer quotient of the two operands rounded
4110    towards zero.</p>
4111
4112 <p>Note that signed integer division and unsigned integer division are distinct
4113    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
4114
4115 <p>Division by zero leads to undefined behavior. Overflow also leads to
4116    undefined behavior; this is a rare case, but can occur, for example, by doing
4117    a 32-bit division of -2147483648 by -1.</p>
4118
4119 <p>If the <tt>exact</tt> keyword is present, the result value of the
4120    <tt>sdiv</tt> is a <a href="#poisonvalues">poison value</a> if the result would
4121    be rounded.</p>
4122
4123 <h5>Example:</h5>
4124 <pre>
4125   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
4126 </pre>
4127
4128 </div>
4129
4130 <!-- _______________________________________________________________________ -->
4131 <h4>
4132   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
4133 </h4>
4134
4135 <div>
4136
4137 <h5>Syntax:</h5>
4138 <pre>
4139   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4140 </pre>
4141
4142 <h5>Overview:</h5>
4143 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
4144
4145 <h5>Arguments:</h5>
4146 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
4147    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4148    floating point values.  Both arguments must have identical types.</p>
4149
4150 <h5>Semantics:</h5>
4151 <p>The value produced is the floating point quotient of the two operands.</p>
4152
4153 <h5>Example:</h5>
4154 <pre>
4155   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
4156 </pre>
4157
4158 </div>
4159
4160 <!-- _______________________________________________________________________ -->
4161 <h4>
4162   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
4163 </h4>
4164
4165 <div>
4166
4167 <h5>Syntax:</h5>
4168 <pre>
4169   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4170 </pre>
4171
4172 <h5>Overview:</h5>
4173 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
4174    division of its two arguments.</p>
4175
4176 <h5>Arguments:</h5>
4177 <p>The two arguments to the '<tt>urem</tt>' instruction must be
4178    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4179    values.  Both arguments must have identical types.</p>
4180
4181 <h5>Semantics:</h5>
4182 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
4183    This instruction always performs an unsigned division to get the
4184    remainder.</p>
4185
4186 <p>Note that unsigned integer remainder and signed integer remainder are
4187    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
4188
4189 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
4190
4191 <h5>Example:</h5>
4192 <pre>
4193   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4194 </pre>
4195
4196 </div>
4197
4198 <!-- _______________________________________________________________________ -->
4199 <h4>
4200   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
4201 </h4>
4202
4203 <div>
4204
4205 <h5>Syntax:</h5>
4206 <pre>
4207   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4208 </pre>
4209
4210 <h5>Overview:</h5>
4211 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
4212    division of its two operands. This instruction can also take
4213    <a href="#t_vector">vector</a> versions of the values in which case the
4214    elements must be integers.</p>
4215
4216 <h5>Arguments:</h5>
4217 <p>The two arguments to the '<tt>srem</tt>' instruction must be
4218    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4219    values.  Both arguments must have identical types.</p>
4220
4221 <h5>Semantics:</h5>
4222 <p>This instruction returns the <i>remainder</i> of a division (where the result
4223    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
4224    <i>modulo</i> operator (where the result is either zero or has the same sign
4225    as the divisor, <tt>op2</tt>) of a value.
4226    For more information about the difference,
4227    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
4228    Math Forum</a>. For a table of how this is implemented in various languages,
4229    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
4230    Wikipedia: modulo operation</a>.</p>
4231
4232 <p>Note that signed integer remainder and unsigned integer remainder are
4233    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
4234
4235 <p>Taking the remainder of a division by zero leads to undefined behavior.
4236    Overflow also leads to undefined behavior; this is a rare case, but can
4237    occur, for example, by taking the remainder of a 32-bit division of
4238    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
4239    lets srem be implemented using instructions that return both the result of
4240    the division and the remainder.)</p>
4241
4242 <h5>Example:</h5>
4243 <pre>
4244   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4245 </pre>
4246
4247 </div>
4248
4249 <!-- _______________________________________________________________________ -->
4250 <h4>
4251   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
4252 </h4>
4253
4254 <div>
4255
4256 <h5>Syntax:</h5>
4257 <pre>
4258   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4259 </pre>
4260
4261 <h5>Overview:</h5>
4262 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
4263    its two operands.</p>
4264
4265 <h5>Arguments:</h5>
4266 <p>The two arguments to the '<tt>frem</tt>' instruction must be
4267    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4268    floating point values.  Both arguments must have identical types.</p>
4269
4270 <h5>Semantics:</h5>
4271 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
4272    has the same sign as the dividend.</p>
4273
4274 <h5>Example:</h5>
4275 <pre>
4276   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
4277 </pre>
4278
4279 </div>
4280
4281 </div>
4282
4283 <!-- ======================================================================= -->
4284 <h3>
4285   <a name="bitwiseops">Bitwise Binary Operations</a>
4286 </h3>
4287
4288 <div>
4289
4290 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
4291    program.  They are generally very efficient instructions and can commonly be
4292    strength reduced from other instructions.  They require two operands of the
4293    same type, execute an operation on them, and produce a single value.  The
4294    resulting value is the same type as its operands.</p>
4295
4296 <!-- _______________________________________________________________________ -->
4297 <h4>
4298   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
4299 </h4>
4300
4301 <div>
4302
4303 <h5>Syntax:</h5>
4304 <pre>
4305   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
4306   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4307   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4308   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4309 </pre>
4310
4311 <h5>Overview:</h5>
4312 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
4313    a specified number of bits.</p>
4314
4315 <h5>Arguments:</h5>
4316 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
4317     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
4318     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4319
4320 <h5>Semantics:</h5>
4321 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
4322    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
4323    is (statically or dynamically) negative or equal to or larger than the number
4324    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
4325    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4326    shift amount in <tt>op2</tt>.</p>
4327
4328 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
4329    <a href="#poisonvalues">poison value</a> if it shifts out any non-zero bits.  If
4330    the <tt>nsw</tt> keyword is present, then the shift produces a
4331    <a href="#poisonvalues">poison value</a> if it shifts out any bits that disagree
4332    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
4333    they would if the shift were expressed as a mul instruction with the same
4334    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
4335
4336 <h5>Example:</h5>
4337 <pre>
4338   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
4339   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
4340   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
4341   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
4342   &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>
4343 </pre>
4344
4345 </div>
4346
4347 <!-- _______________________________________________________________________ -->
4348 <h4>
4349   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
4350 </h4>
4351
4352 <div>
4353
4354 <h5>Syntax:</h5>
4355 <pre>
4356   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4357   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4358 </pre>
4359
4360 <h5>Overview:</h5>
4361 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4362    operand shifted to the right a specified number of bits with zero fill.</p>
4363
4364 <h5>Arguments:</h5>
4365 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4366    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4367    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4368
4369 <h5>Semantics:</h5>
4370 <p>This instruction always performs a logical shift right operation. The most
4371    significant bits of the result will be filled with zero bits after the shift.
4372    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4373    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4374    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4375    shift amount in <tt>op2</tt>.</p>
4376
4377 <p>If the <tt>exact</tt> keyword is present, the result value of the
4378    <tt>lshr</tt> is a <a href="#poisonvalues">poison value</a> if any of the bits
4379    shifted out are non-zero.</p>
4380
4381
4382 <h5>Example:</h5>
4383 <pre>
4384   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4385   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4386   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4387   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4388   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4389   &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>
4390 </pre>
4391
4392 </div>
4393
4394 <!-- _______________________________________________________________________ -->
4395 <h4>
4396   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4397 </h4>
4398
4399 <div>
4400
4401 <h5>Syntax:</h5>
4402 <pre>
4403   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4404   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4405 </pre>
4406
4407 <h5>Overview:</h5>
4408 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4409    operand shifted to the right a specified number of bits with sign
4410    extension.</p>
4411
4412 <h5>Arguments:</h5>
4413 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4414    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4415    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4416
4417 <h5>Semantics:</h5>
4418 <p>This instruction always performs an arithmetic shift right operation, The
4419    most significant bits of the result will be filled with the sign bit
4420    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4421    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4422    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4423    the corresponding shift amount in <tt>op2</tt>.</p>
4424
4425 <p>If the <tt>exact</tt> keyword is present, the result value of the
4426    <tt>ashr</tt> is a <a href="#poisonvalues">poison value</a> if any of the bits
4427    shifted out are non-zero.</p>
4428
4429 <h5>Example:</h5>
4430 <pre>
4431   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4432   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4433   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4434   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4435   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4436   &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>
4437 </pre>
4438
4439 </div>
4440
4441 <!-- _______________________________________________________________________ -->
4442 <h4>
4443   <a name="i_and">'<tt>and</tt>' Instruction</a>
4444 </h4>
4445
4446 <div>
4447
4448 <h5>Syntax:</h5>
4449 <pre>
4450   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4451 </pre>
4452
4453 <h5>Overview:</h5>
4454 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4455    operands.</p>
4456
4457 <h5>Arguments:</h5>
4458 <p>The two arguments to the '<tt>and</tt>' instruction must be
4459    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4460    values.  Both arguments must have identical types.</p>
4461
4462 <h5>Semantics:</h5>
4463 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4464
4465 <table border="1" cellspacing="0" cellpadding="4">
4466   <tbody>
4467     <tr>
4468       <th>In0</th>
4469       <th>In1</th>
4470       <th>Out</th>
4471     </tr>
4472     <tr>
4473       <td>0</td>
4474       <td>0</td>
4475       <td>0</td>
4476     </tr>
4477     <tr>
4478       <td>0</td>
4479       <td>1</td>
4480       <td>0</td>
4481     </tr>
4482     <tr>
4483       <td>1</td>
4484       <td>0</td>
4485       <td>0</td>
4486     </tr>
4487     <tr>
4488       <td>1</td>
4489       <td>1</td>
4490       <td>1</td>
4491     </tr>
4492   </tbody>
4493 </table>
4494
4495 <h5>Example:</h5>
4496 <pre>
4497   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4498   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4499   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4500 </pre>
4501 </div>
4502 <!-- _______________________________________________________________________ -->
4503 <h4>
4504   <a name="i_or">'<tt>or</tt>' Instruction</a>
4505 </h4>
4506
4507 <div>
4508
4509 <h5>Syntax:</h5>
4510 <pre>
4511   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4512 </pre>
4513
4514 <h5>Overview:</h5>
4515 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4516    two operands.</p>
4517
4518 <h5>Arguments:</h5>
4519 <p>The two arguments to the '<tt>or</tt>' instruction must be
4520    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4521    values.  Both arguments must have identical types.</p>
4522
4523 <h5>Semantics:</h5>
4524 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4525
4526 <table border="1" cellspacing="0" cellpadding="4">
4527   <tbody>
4528     <tr>
4529       <th>In0</th>
4530       <th>In1</th>
4531       <th>Out</th>
4532     </tr>
4533     <tr>
4534       <td>0</td>
4535       <td>0</td>
4536       <td>0</td>
4537     </tr>
4538     <tr>
4539       <td>0</td>
4540       <td>1</td>
4541       <td>1</td>
4542     </tr>
4543     <tr>
4544       <td>1</td>
4545       <td>0</td>
4546       <td>1</td>
4547     </tr>
4548     <tr>
4549       <td>1</td>
4550       <td>1</td>
4551       <td>1</td>
4552     </tr>
4553   </tbody>
4554 </table>
4555
4556 <h5>Example:</h5>
4557 <pre>
4558   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4559   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4560   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4561 </pre>
4562
4563 </div>
4564
4565 <!-- _______________________________________________________________________ -->
4566 <h4>
4567   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4568 </h4>
4569
4570 <div>
4571
4572 <h5>Syntax:</h5>
4573 <pre>
4574   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4575 </pre>
4576
4577 <h5>Overview:</h5>
4578 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4579    its two operands.  The <tt>xor</tt> is used to implement the "one's
4580    complement" operation, which is the "~" operator in C.</p>
4581
4582 <h5>Arguments:</h5>
4583 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4584    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4585    values.  Both arguments must have identical types.</p>
4586
4587 <h5>Semantics:</h5>
4588 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4589
4590 <table border="1" cellspacing="0" cellpadding="4">
4591   <tbody>
4592     <tr>
4593       <th>In0</th>
4594       <th>In1</th>
4595       <th>Out</th>
4596     </tr>
4597     <tr>
4598       <td>0</td>
4599       <td>0</td>
4600       <td>0</td>
4601     </tr>
4602     <tr>
4603       <td>0</td>
4604       <td>1</td>
4605       <td>1</td>
4606     </tr>
4607     <tr>
4608       <td>1</td>
4609       <td>0</td>
4610       <td>1</td>
4611     </tr>
4612     <tr>
4613       <td>1</td>
4614       <td>1</td>
4615       <td>0</td>
4616     </tr>
4617   </tbody>
4618 </table>
4619
4620 <h5>Example:</h5>
4621 <pre>
4622   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4623   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4624   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4625   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4626 </pre>
4627
4628 </div>
4629
4630 </div>
4631
4632 <!-- ======================================================================= -->
4633 <h3>
4634   <a name="vectorops">Vector Operations</a>
4635 </h3>
4636
4637 <div>
4638
4639 <p>LLVM supports several instructions to represent vector operations in a
4640    target-independent manner.  These instructions cover the element-access and
4641    vector-specific operations needed to process vectors effectively.  While LLVM
4642    does directly support these vector operations, many sophisticated algorithms
4643    will want to use target-specific intrinsics to take full advantage of a
4644    specific target.</p>
4645
4646 <!-- _______________________________________________________________________ -->
4647 <h4>
4648    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4649 </h4>
4650
4651 <div>
4652
4653 <h5>Syntax:</h5>
4654 <pre>
4655   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4656 </pre>
4657
4658 <h5>Overview:</h5>
4659 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4660    from a vector at a specified index.</p>
4661
4662
4663 <h5>Arguments:</h5>
4664 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4665    of <a href="#t_vector">vector</a> type.  The second operand is an index
4666    indicating the position from which to extract the element.  The index may be
4667    a variable.</p>
4668
4669 <h5>Semantics:</h5>
4670 <p>The result is a scalar of the same type as the element type of
4671    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4672    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4673    results are undefined.</p>
4674
4675 <h5>Example:</h5>
4676 <pre>
4677   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4678 </pre>
4679
4680 </div>
4681
4682 <!-- _______________________________________________________________________ -->
4683 <h4>
4684    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4685 </h4>
4686
4687 <div>
4688
4689 <h5>Syntax:</h5>
4690 <pre>
4691   &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>
4692 </pre>
4693
4694 <h5>Overview:</h5>
4695 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4696    vector at a specified index.</p>
4697
4698 <h5>Arguments:</h5>
4699 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4700    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4701    whose type must equal the element type of the first operand.  The third
4702    operand is an index indicating the position at which to insert the value.
4703    The index may be a variable.</p>
4704
4705 <h5>Semantics:</h5>
4706 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4707    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4708    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4709    results are undefined.</p>
4710
4711 <h5>Example:</h5>
4712 <pre>
4713   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4714 </pre>
4715
4716 </div>
4717
4718 <!-- _______________________________________________________________________ -->
4719 <h4>
4720    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4721 </h4>
4722
4723 <div>
4724
4725 <h5>Syntax:</h5>
4726 <pre>
4727   &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>
4728 </pre>
4729
4730 <h5>Overview:</h5>
4731 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4732    from two input vectors, returning a vector with the same element type as the
4733    input and length that is the same as the shuffle mask.</p>
4734
4735 <h5>Arguments:</h5>
4736 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4737    with types that match each other. The third argument is a shuffle mask whose
4738    element type is always 'i32'.  The result of the instruction is a vector
4739    whose length is the same as the shuffle mask and whose element type is the
4740    same as the element type of the first two operands.</p>
4741
4742 <p>The shuffle mask operand is required to be a constant vector with either
4743    constant integer or undef values.</p>
4744
4745 <h5>Semantics:</h5>
4746 <p>The elements of the two input vectors are numbered from left to right across
4747    both of the vectors.  The shuffle mask operand specifies, for each element of
4748    the result vector, which element of the two input vectors the result element
4749    gets.  The element selector may be undef (meaning "don't care") and the
4750    second operand may be undef if performing a shuffle from only one vector.</p>
4751
4752 <h5>Example:</h5>
4753 <pre>
4754   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4755                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4756   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4757                           &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.
4758   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4759                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4760   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4761                           &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>
4762 </pre>
4763
4764 </div>
4765
4766 </div>
4767
4768 <!-- ======================================================================= -->
4769 <h3>
4770   <a name="aggregateops">Aggregate Operations</a>
4771 </h3>
4772
4773 <div>
4774
4775 <p>LLVM supports several instructions for working with
4776   <a href="#t_aggregate">aggregate</a> values.</p>
4777
4778 <!-- _______________________________________________________________________ -->
4779 <h4>
4780    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4781 </h4>
4782
4783 <div>
4784
4785 <h5>Syntax:</h5>
4786 <pre>
4787   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4788 </pre>
4789
4790 <h5>Overview:</h5>
4791 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4792    from an <a href="#t_aggregate">aggregate</a> value.</p>
4793
4794 <h5>Arguments:</h5>
4795 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4796    of <a href="#t_struct">struct</a> or
4797    <a href="#t_array">array</a> type.  The operands are constant indices to
4798    specify which value to extract in a similar manner as indices in a
4799    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4800    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4801      <ul>
4802        <li>Since the value being indexed is not a pointer, the first index is
4803            omitted and assumed to be zero.</li>
4804        <li>At least one index must be specified.</li>
4805        <li>Not only struct indices but also array indices must be in
4806            bounds.</li>
4807      </ul>
4808
4809 <h5>Semantics:</h5>
4810 <p>The result is the value at the position in the aggregate specified by the
4811    index operands.</p>
4812
4813 <h5>Example:</h5>
4814 <pre>
4815   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4816 </pre>
4817
4818 </div>
4819
4820 <!-- _______________________________________________________________________ -->
4821 <h4>
4822    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4823 </h4>
4824
4825 <div>
4826
4827 <h5>Syntax:</h5>
4828 <pre>
4829   &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>
4830 </pre>
4831
4832 <h5>Overview:</h5>
4833 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4834    in an <a href="#t_aggregate">aggregate</a> value.</p>
4835
4836 <h5>Arguments:</h5>
4837 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4838    of <a href="#t_struct">struct</a> or
4839    <a href="#t_array">array</a> type.  The second operand is a first-class
4840    value to insert.  The following operands are constant indices indicating
4841    the position at which to insert the value in a similar manner as indices in a
4842    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4843    value to insert must have the same type as the value identified by the
4844    indices.</p>
4845
4846 <h5>Semantics:</h5>
4847 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4848    that of <tt>val</tt> except that the value at the position specified by the
4849    indices is that of <tt>elt</tt>.</p>
4850
4851 <h5>Example:</h5>
4852 <pre>
4853   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4854   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4855   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4856 </pre>
4857
4858 </div>
4859
4860 </div>
4861
4862 <!-- ======================================================================= -->
4863 <h3>
4864   <a name="memoryops">Memory Access and Addressing Operations</a>
4865 </h3>
4866
4867 <div>
4868
4869 <p>A key design point of an SSA-based representation is how it represents
4870    memory.  In LLVM, no memory locations are in SSA form, which makes things
4871    very simple.  This section describes how to read, write, and allocate
4872    memory in LLVM.</p>
4873
4874 <!-- _______________________________________________________________________ -->
4875 <h4>
4876   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4877 </h4>
4878
4879 <div>
4880
4881 <h5>Syntax:</h5>
4882 <pre>
4883   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4884 </pre>
4885
4886 <h5>Overview:</h5>
4887 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4888    currently executing function, to be automatically released when this function
4889    returns to its caller. The object is always allocated in the generic address
4890    space (address space zero).</p>
4891
4892 <h5>Arguments:</h5>
4893 <p>The '<tt>alloca</tt>' instruction
4894    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4895    runtime stack, returning a pointer of the appropriate type to the program.
4896    If "NumElements" is specified, it is the number of elements allocated,
4897    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4898    specified, the value result of the allocation is guaranteed to be aligned to
4899    at least that boundary.  If not specified, or if zero, the target can choose
4900    to align the allocation on any convenient boundary compatible with the
4901    type.</p>
4902
4903 <p>'<tt>type</tt>' may be any sized type.</p>
4904
4905 <h5>Semantics:</h5>
4906 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4907    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4908    memory is automatically released when the function returns.  The
4909    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4910    variables that must have an address available.  When the function returns
4911    (either with the <tt><a href="#i_ret">ret</a></tt>
4912    or <tt><a href="#i_resume">resume</a></tt> instructions), the memory is
4913    reclaimed.  Allocating zero bytes is legal, but the result is undefined.
4914    The order in which memory is allocated (ie., which way the stack grows) is
4915    not specified.</p>
4916
4917 <p>
4918
4919 <h5>Example:</h5>
4920 <pre>
4921   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4922   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4923   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4924   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4925 </pre>
4926
4927 </div>
4928
4929 <!-- _______________________________________________________________________ -->
4930 <h4>
4931   <a name="i_load">'<tt>load</tt>' Instruction</a>
4932 </h4>
4933
4934 <div>
4935
4936 <h5>Syntax:</h5>
4937 <pre>
4938   &lt;result&gt; = load [volatile] &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;][, !invariant.load !&lt;index&gt;]
4939   &lt;result&gt; = load atomic [volatile] &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4940   !&lt;index&gt; = !{ i32 1 }
4941 </pre>
4942
4943 <h5>Overview:</h5>
4944 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4945
4946 <h5>Arguments:</h5>
4947 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4948    from which to load.  The pointer must point to
4949    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4950    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4951    number or order of execution of this <tt>load</tt> with other <a
4952    href="#volatile">volatile operations</a>.</p>
4953
4954 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4955    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4956    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4957    not valid on <code>load</code> instructions.  Atomic loads produce <a
4958    href="#memorymodel">defined</a> results when they may see multiple atomic
4959    stores.  The type of the pointee must be an integer type whose bit width
4960    is a power of two greater than or equal to eight and less than or equal
4961    to a target-specific size limit. <code>align</code> must be explicitly
4962    specified on atomic loads, and the load has undefined behavior if the
4963    alignment is not set to a value which is at least the size in bytes of
4964    the pointee. <code>!nontemporal</code> does not have any defined semantics
4965    for atomic loads.</p>
4966
4967 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4968    operation (that is, the alignment of the memory address). A value of 0 or an
4969    omitted <tt>align</tt> argument means that the operation has the preferential
4970    alignment for the target. It is the responsibility of the code emitter to
4971    ensure that the alignment information is correct. Overestimating the
4972    alignment results in undefined behavior. Underestimating the alignment may
4973    produce less efficient code. An alignment of 1 is always safe.</p>
4974
4975 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4976    metatadata name &lt;index&gt; corresponding to a metadata node with
4977    one <tt>i32</tt> entry of value 1.  The existence of
4978    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4979    and code generator that this load is not expected to be reused in the cache.
4980    The code generator may select special instructions to save cache bandwidth,
4981    such as the <tt>MOVNT</tt> instruction on x86.</p>
4982
4983 <p>The optional <tt>!invariant.load</tt> metadata must reference a single
4984    metatadata name &lt;index&gt; corresponding to a metadata node with no
4985    entries.  The existence of the <tt>!invariant.load</tt> metatadata on the
4986    instruction tells the optimizer and code generator that this load address
4987    points to memory which does not change value during program execution.
4988    The optimizer may then move this load around, for example, by hoisting it
4989    out of loops using loop invariant code motion.</p>
4990
4991 <h5>Semantics:</h5>
4992 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4993    scalar type then the number of bytes read does not exceed the minimum number
4994    of bytes needed to hold all bits of the type.  For example, loading an
4995    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4996    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4997    is undefined if the value was not originally written using a store of the
4998    same type.</p>
4999
5000 <h5>Examples:</h5>
5001 <pre>
5002   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
5003   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
5004   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
5005 </pre>
5006
5007 </div>
5008
5009 <!-- _______________________________________________________________________ -->
5010 <h4>
5011   <a name="i_store">'<tt>store</tt>' Instruction</a>
5012 </h4>
5013
5014 <div>
5015
5016 <h5>Syntax:</h5>
5017 <pre>
5018   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>
5019   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>
5020 </pre>
5021
5022 <h5>Overview:</h5>
5023 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
5024
5025 <h5>Arguments:</h5>
5026 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
5027    and an address at which to store it.  The type of the
5028    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
5029    the <a href="#t_firstclass">first class</a> type of the
5030    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
5031    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
5032    order of execution of this <tt>store</tt> with other <a
5033    href="#volatile">volatile operations</a>.</p>
5034
5035 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
5036    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
5037    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
5038    valid on <code>store</code> instructions.  Atomic loads produce <a
5039    href="#memorymodel">defined</a> results when they may see multiple atomic
5040    stores. The type of the pointee must be an integer type whose bit width
5041    is a power of two greater than or equal to eight and less than or equal
5042    to a target-specific size limit. <code>align</code> must be explicitly
5043    specified on atomic stores, and the store has undefined behavior if the
5044    alignment is not set to a value which is at least the size in bytes of
5045    the pointee. <code>!nontemporal</code> does not have any defined semantics
5046    for atomic stores.</p>
5047
5048 <p>The optional constant "align" argument specifies the alignment of the
5049    operation (that is, the alignment of the memory address). A value of 0 or an
5050    omitted "align" argument means that the operation has the preferential
5051    alignment for the target. It is the responsibility of the code emitter to
5052    ensure that the alignment information is correct. Overestimating the
5053    alignment results in an undefined behavior. Underestimating the alignment may
5054    produce less efficient code. An alignment of 1 is always safe.</p>
5055
5056 <p>The optional !nontemporal metadata must reference a single metatadata
5057    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
5058    value 1.  The existence of the !nontemporal metatadata on the
5059    instruction tells the optimizer and code generator that this load is
5060    not expected to be reused in the cache.  The code generator may
5061    select special instructions to save cache bandwidth, such as the
5062    MOVNT instruction on x86.</p>
5063
5064
5065 <h5>Semantics:</h5>
5066 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
5067    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
5068    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
5069    does not exceed the minimum number of bytes needed to hold all bits of the
5070    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
5071    writing a value of a type like <tt>i20</tt> with a size that is not an
5072    integral number of bytes, it is unspecified what happens to the extra bits
5073    that do not belong to the type, but they will typically be overwritten.</p>
5074
5075 <h5>Example:</h5>
5076 <pre>
5077   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
5078   store i32 3, i32* %ptr                          <i>; yields {void}</i>
5079   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
5080 </pre>
5081
5082 </div>
5083
5084 <!-- _______________________________________________________________________ -->
5085 <h4>
5086 <a name="i_fence">'<tt>fence</tt>' Instruction</a>
5087 </h4>
5088
5089 <div>
5090
5091 <h5>Syntax:</h5>
5092 <pre>
5093   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
5094 </pre>
5095
5096 <h5>Overview:</h5>
5097 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
5098 between operations.</p>
5099
5100 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
5101 href="#ordering">ordering</a> argument which defines what
5102 <i>synchronizes-with</i> edges they add.  They can only be given
5103 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
5104 <code>seq_cst</code> orderings.</p>
5105
5106 <h5>Semantics:</h5>
5107 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
5108 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
5109 <code>acquire</code> ordering semantics if and only if there exist atomic
5110 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
5111 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
5112 <var>X</var> modifies <var>M</var> (either directly or through some side effect
5113 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
5114 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
5115 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
5116 than an explicit <code>fence</code>, one (but not both) of the atomic operations
5117 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
5118 <code>acquire</code> (resp.) ordering constraint and still
5119 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
5120 <i>happens-before</i> edge.</p>
5121
5122 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
5123 having both <code>acquire</code> and <code>release</code> semantics specified
5124 above, participates in the global program order of other <code>seq_cst</code>
5125 operations and/or fences.</p>
5126
5127 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
5128 specifies that the fence only synchronizes with other fences in the same
5129 thread.  (This is useful for interacting with signal handlers.)</p>
5130
5131 <h5>Example:</h5>
5132 <pre>
5133   fence acquire                          <i>; yields {void}</i>
5134   fence singlethread seq_cst             <i>; yields {void}</i>
5135 </pre>
5136
5137 </div>
5138
5139 <!-- _______________________________________________________________________ -->
5140 <h4>
5141 <a name="i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a>
5142 </h4>
5143
5144 <div>
5145
5146 <h5>Syntax:</h5>
5147 <pre>
5148   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>
5149 </pre>
5150
5151 <h5>Overview:</h5>
5152 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
5153 It loads a value in memory and compares it to a given value. If they are
5154 equal, it stores a new value into the memory.</p>
5155
5156 <h5>Arguments:</h5>
5157 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
5158 address to operate on, a value to compare to the value currently be at that
5159 address, and a new value to place at that address if the compared values are
5160 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
5161 bit width is a power of two greater than or equal to eight and less than
5162 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
5163 '<var>&lt;new&gt;</var>' must have the same type, and the type of
5164 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
5165 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
5166 optimizer is not allowed to modify the number or order of execution
5167 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
5168 operations</a>.</p>
5169
5170 <!-- FIXME: Extend allowed types. -->
5171
5172 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
5173 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
5174
5175 <p>The optional "<code>singlethread</code>" argument declares that the
5176 <code>cmpxchg</code> is only atomic with respect to code (usually signal
5177 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
5178 cmpxchg is atomic with respect to all other code in the system.</p>
5179
5180 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
5181 the size in memory of the operand.
5182
5183 <h5>Semantics:</h5>
5184 <p>The contents of memory at the location specified by the
5185 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
5186 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
5187 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
5188 is returned.
5189
5190 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
5191 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
5192 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
5193 parameter determined by dropping any <code>release</code> part of the
5194 <code>cmpxchg</code>'s ordering.</p>
5195
5196 <!--
5197 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
5198 optimization work on ARM.)
5199
5200 FIXME: Is a weaker ordering constraint on failure helpful in practice?
5201 -->
5202
5203 <h5>Example:</h5>
5204 <pre>
5205 entry:
5206   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                   <i>; yields {i32}</i>
5207   <a href="#i_br">br</a> label %loop
5208
5209 loop:
5210   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
5211   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
5212   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared          <i>; yields {i32}</i>
5213   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
5214   <a href="#i_br">br</a> i1 %success, label %done, label %loop
5215
5216 done:
5217   ...
5218 </pre>
5219
5220 </div>
5221
5222 <!-- _______________________________________________________________________ -->
5223 <h4>
5224 <a name="i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a>
5225 </h4>
5226
5227 <div>
5228
5229 <h5>Syntax:</h5>
5230 <pre>
5231   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>
5232 </pre>
5233
5234 <h5>Overview:</h5>
5235 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
5236
5237 <h5>Arguments:</h5>
5238 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
5239 operation to apply, an address whose value to modify, an argument to the
5240 operation.  The operation must be one of the following keywords:</p>
5241 <ul>
5242   <li>xchg</li>
5243   <li>add</li>
5244   <li>sub</li>
5245   <li>and</li>
5246   <li>nand</li>
5247   <li>or</li>
5248   <li>xor</li>
5249   <li>max</li>
5250   <li>min</li>
5251   <li>umax</li>
5252   <li>umin</li>
5253 </ul>
5254
5255 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
5256 bit width is a power of two greater than or equal to eight and less than
5257 or equal to a target-specific size limit.  The type of the
5258 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
5259 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
5260 optimizer is not allowed to modify the number or order of execution of this
5261 <code>atomicrmw</code> with other <a href="#volatile">volatile
5262   operations</a>.</p>
5263
5264 <!-- FIXME: Extend allowed types. -->
5265
5266 <h5>Semantics:</h5>
5267 <p>The contents of memory at the location specified by the
5268 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
5269 back.  The original value at the location is returned.  The modification is
5270 specified by the <var>operation</var> argument:</p>
5271
5272 <ul>
5273   <li>xchg: <code>*ptr = val</code></li>
5274   <li>add: <code>*ptr = *ptr + val</code></li>
5275   <li>sub: <code>*ptr = *ptr - val</code></li>
5276   <li>and: <code>*ptr = *ptr &amp; val</code></li>
5277   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
5278   <li>or: <code>*ptr = *ptr | val</code></li>
5279   <li>xor: <code>*ptr = *ptr ^ val</code></li>
5280   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
5281   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
5282   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5283   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5284 </ul>
5285
5286 <h5>Example:</h5>
5287 <pre>
5288   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
5289 </pre>
5290
5291 </div>
5292
5293 <!-- _______________________________________________________________________ -->
5294 <h4>
5295    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
5296 </h4>
5297
5298 <div>
5299
5300 <h5>Syntax:</h5>
5301 <pre>
5302   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5303   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5304   &lt;result&gt; = getelementptr &lt;ptr vector&gt; ptrval, &lt;vector index type&gt; idx
5305 </pre>
5306
5307 <h5>Overview:</h5>
5308 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
5309    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
5310    It performs address calculation only and does not access memory.</p>
5311
5312 <h5>Arguments:</h5>
5313 <p>The first argument is always a pointer or a vector of pointers,
5314    and forms the basis of the
5315    calculation. The remaining arguments are indices that indicate which of the
5316    elements of the aggregate object are indexed. The interpretation of each
5317    index is dependent on the type being indexed into. The first index always
5318    indexes the pointer value given as the first argument, the second index
5319    indexes a value of the type pointed to (not necessarily the value directly
5320    pointed to, since the first index can be non-zero), etc. The first type
5321    indexed into must be a pointer value, subsequent types can be arrays,
5322    vectors, and structs. Note that subsequent types being indexed into
5323    can never be pointers, since that would require loading the pointer before
5324    continuing calculation.</p>
5325
5326 <p>The type of each index argument depends on the type it is indexing into.
5327    When indexing into a (optionally packed) structure, only <tt>i32</tt>
5328    integer <b>constants</b> are allowed.  When indexing into an array, pointer
5329    or vector, integers of any width are allowed, and they are not required to be
5330    constant.  These integers are treated as signed values where relevant.</p>
5331
5332 <p>For example, let's consider a C code fragment and how it gets compiled to
5333    LLVM:</p>
5334
5335 <pre class="doc_code">
5336 struct RT {
5337   char A;
5338   int B[10][20];
5339   char C;
5340 };
5341 struct ST {
5342   int X;
5343   double Y;
5344   struct RT Z;
5345 };
5346
5347 int *foo(struct ST *s) {
5348   return &amp;s[1].Z.B[5][13];
5349 }
5350 </pre>
5351
5352 <p>The LLVM code generated by Clang is:</p>
5353
5354 <pre class="doc_code">
5355 %struct.RT = <a href="#namedtypes">type</a> { i8, [10 x [20 x i32]], i8 }
5356 %struct.ST = <a href="#namedtypes">type</a> { i32, double, %struct.RT }
5357
5358 define i32* @foo(%struct.ST* %s) nounwind uwtable readnone optsize ssp {
5359 entry:
5360   %arrayidx = getelementptr inbounds %struct.ST* %s, i64 1, i32 2, i32 1, i64 5, i64 13
5361   ret i32* %arrayidx
5362 }
5363 </pre>
5364
5365 <h5>Semantics:</h5>
5366 <p>In the example above, the first index is indexing into the
5367    '<tt>%struct.ST*</tt>' type, which is a pointer, yielding a
5368    '<tt>%struct.ST</tt>' = '<tt>{ i32, double, %struct.RT }</tt>' type, a
5369    structure. The second index indexes into the third element of the structure,
5370    yielding a '<tt>%struct.RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]], i8 }</tt>'
5371    type, another structure. The third index indexes into the second element of
5372    the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an array. The
5373    two dimensions of the array are subscripted into, yielding an '<tt>i32</tt>'
5374    type. The '<tt>getelementptr</tt>' instruction returns a pointer to this
5375    element, thus computing a value of '<tt>i32*</tt>' type.</p>
5376
5377 <p>Note that it is perfectly legal to index partially through a structure,
5378    returning a pointer to an inner element.  Because of this, the LLVM code for
5379    the given testcase is equivalent to:</p>
5380
5381 <pre class="doc_code">
5382 define i32* @foo(%struct.ST* %s) {
5383   %t1 = getelementptr %struct.ST* %s, i32 1                 <i>; yields %struct.ST*:%t1</i>
5384   %t2 = getelementptr %struct.ST* %t1, i32 0, i32 2         <i>; yields %struct.RT*:%t2</i>
5385   %t3 = getelementptr %struct.RT* %t2, i32 0, i32 1         <i>; yields [10 x [20 x i32]]*:%t3</i>
5386   %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5387   %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5388   ret i32* %t5
5389 }
5390 </pre>
5391
5392 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5393    <tt>getelementptr</tt> is a <a href="#poisonvalues">poison value</a> if the
5394    base pointer is not an <i>in bounds</i> address of an allocated object,
5395    or if any of the addresses that would be formed by successive addition of
5396    the offsets implied by the indices to the base address with infinitely
5397    precise signed arithmetic are not an <i>in bounds</i> address of that
5398    allocated object. The <i>in bounds</i> addresses for an allocated object
5399    are all the addresses that point into the object, plus the address one
5400    byte past the end.
5401    In cases where the base is a vector of pointers the <tt>inbounds</tt> keyword
5402    applies to each of the computations element-wise. </p>
5403
5404 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5405    the base address with silently-wrapping two's complement arithmetic. If the
5406    offsets have a different width from the pointer, they are sign-extended or
5407    truncated to the width of the pointer. The result value of the
5408    <tt>getelementptr</tt> may be outside the object pointed to by the base
5409    pointer. The result value may not necessarily be used to access memory
5410    though, even if it happens to point into allocated storage. See the
5411    <a href="#pointeraliasing">Pointer Aliasing Rules</a> section for more
5412    information.</p>
5413
5414 <p>The getelementptr instruction is often confusing.  For some more insight into
5415    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5416
5417 <h5>Example:</h5>
5418 <pre>
5419     <i>; yields [12 x i8]*:aptr</i>
5420     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5421     <i>; yields i8*:vptr</i>
5422     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5423     <i>; yields i8*:eptr</i>
5424     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5425     <i>; yields i32*:iptr</i>
5426     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5427 </pre>
5428
5429 <p>In cases where the pointer argument is a vector of pointers, only a
5430    single index may be used, and the number of vector elements has to be
5431    the same.  For example: </p>
5432 <pre class="doc_code">
5433  %A = getelementptr <4 x i8*> %ptrs, <4 x i64> %offsets,
5434 </pre>
5435
5436 </div>
5437
5438 </div>
5439
5440 <!-- ======================================================================= -->
5441 <h3>
5442   <a name="convertops">Conversion Operations</a>
5443 </h3>
5444
5445 <div>
5446
5447 <p>The instructions in this category are the conversion instructions (casting)
5448    which all take a single operand and a type. They perform various bit
5449    conversions on the operand.</p>
5450
5451 <!-- _______________________________________________________________________ -->
5452 <h4>
5453    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5454 </h4>
5455
5456 <div>
5457
5458 <h5>Syntax:</h5>
5459 <pre>
5460   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5461 </pre>
5462
5463 <h5>Overview:</h5>
5464 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5465    type <tt>ty2</tt>.</p>
5466
5467 <h5>Arguments:</h5>
5468 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5469    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5470    of the same number of integers.
5471    The bit size of the <tt>value</tt> must be larger than
5472    the bit size of the destination type, <tt>ty2</tt>.
5473    Equal sized types are not allowed.</p>
5474
5475 <h5>Semantics:</h5>
5476 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5477    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5478    source size must be larger than the destination size, <tt>trunc</tt> cannot
5479    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5480
5481 <h5>Example:</h5>
5482 <pre>
5483   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5484   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5485   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5486   %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>
5487 </pre>
5488
5489 </div>
5490
5491 <!-- _______________________________________________________________________ -->
5492 <h4>
5493    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5494 </h4>
5495
5496 <div>
5497
5498 <h5>Syntax:</h5>
5499 <pre>
5500   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5501 </pre>
5502
5503 <h5>Overview:</h5>
5504 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5505    <tt>ty2</tt>.</p>
5506
5507
5508 <h5>Arguments:</h5>
5509 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
5510    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5511    of the same number of integers.
5512    The bit size of the <tt>value</tt> must be smaller than
5513    the bit size of the destination type,
5514    <tt>ty2</tt>.</p>
5515
5516 <h5>Semantics:</h5>
5517 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5518    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5519
5520 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5521
5522 <h5>Example:</h5>
5523 <pre>
5524   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5525   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5526   %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>
5527 </pre>
5528
5529 </div>
5530
5531 <!-- _______________________________________________________________________ -->
5532 <h4>
5533    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5534 </h4>
5535
5536 <div>
5537
5538 <h5>Syntax:</h5>
5539 <pre>
5540   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5541 </pre>
5542
5543 <h5>Overview:</h5>
5544 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5545
5546 <h5>Arguments:</h5>
5547 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5548    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5549    of the same number of integers.
5550    The bit size of the <tt>value</tt> must be smaller than
5551    the bit size of the destination type,
5552    <tt>ty2</tt>.</p>
5553
5554 <h5>Semantics:</h5>
5555 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5556    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5557    of the type <tt>ty2</tt>.</p>
5558
5559 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5560
5561 <h5>Example:</h5>
5562 <pre>
5563   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5564   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5565   %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>
5566 </pre>
5567
5568 </div>
5569
5570 <!-- _______________________________________________________________________ -->
5571 <h4>
5572    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5573 </h4>
5574
5575 <div>
5576
5577 <h5>Syntax:</h5>
5578 <pre>
5579   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5580 </pre>
5581
5582 <h5>Overview:</h5>
5583 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5584    <tt>ty2</tt>.</p>
5585
5586 <h5>Arguments:</h5>
5587 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5588    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5589    to cast it to. The size of <tt>value</tt> must be larger than the size of
5590    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5591    <i>no-op cast</i>.</p>
5592
5593 <h5>Semantics:</h5>
5594 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5595    <a href="#t_floating">floating point</a> type to a smaller
5596    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5597    within the destination type, <tt>ty2</tt>, then the results are
5598    undefined.</p>
5599
5600 <h5>Example:</h5>
5601 <pre>
5602   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5603   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5604 </pre>
5605
5606 </div>
5607
5608 <!-- _______________________________________________________________________ -->
5609 <h4>
5610    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5611 </h4>
5612
5613 <div>
5614
5615 <h5>Syntax:</h5>
5616 <pre>
5617   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5618 </pre>
5619
5620 <h5>Overview:</h5>
5621 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5622    floating point value.</p>
5623
5624 <h5>Arguments:</h5>
5625 <p>The '<tt>fpext</tt>' instruction takes a
5626    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5627    a <a href="#t_floating">floating point</a> type to cast it to. The source
5628    type must be smaller than the destination type.</p>
5629
5630 <h5>Semantics:</h5>
5631 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5632    <a href="#t_floating">floating point</a> type to a larger
5633    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5634    used to make a <i>no-op cast</i> because it always changes bits. Use
5635    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5636
5637 <h5>Example:</h5>
5638 <pre>
5639   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5640   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5641 </pre>
5642
5643 </div>
5644
5645 <!-- _______________________________________________________________________ -->
5646 <h4>
5647    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5648 </h4>
5649
5650 <div>
5651
5652 <h5>Syntax:</h5>
5653 <pre>
5654   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5655 </pre>
5656
5657 <h5>Overview:</h5>
5658 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
5659    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5660
5661 <h5>Arguments:</h5>
5662 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5663    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5664    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5665    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5666    vector integer type with the same number of elements as <tt>ty</tt></p>
5667
5668 <h5>Semantics:</h5>
5669 <p>The '<tt>fptoui</tt>' instruction converts its
5670    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5671    towards zero) unsigned integer value. If the value cannot fit
5672    in <tt>ty2</tt>, the results are undefined.</p>
5673
5674 <h5>Example:</h5>
5675 <pre>
5676   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5677   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5678   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5679 </pre>
5680
5681 </div>
5682
5683 <!-- _______________________________________________________________________ -->
5684 <h4>
5685    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5686 </h4>
5687
5688 <div>
5689
5690 <h5>Syntax:</h5>
5691 <pre>
5692   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5693 </pre>
5694
5695 <h5>Overview:</h5>
5696 <p>The '<tt>fptosi</tt>' instruction converts
5697    <a href="#t_floating">floating point</a> <tt>value</tt> to
5698    type <tt>ty2</tt>.</p>
5699
5700 <h5>Arguments:</h5>
5701 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5702    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5703    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5704    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5705    vector integer type with the same number of elements as <tt>ty</tt></p>
5706
5707 <h5>Semantics:</h5>
5708 <p>The '<tt>fptosi</tt>' instruction converts its
5709    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5710    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5711    the results are undefined.</p>
5712
5713 <h5>Example:</h5>
5714 <pre>
5715   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5716   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5717   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5718 </pre>
5719
5720 </div>
5721
5722 <!-- _______________________________________________________________________ -->
5723 <h4>
5724    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5725 </h4>
5726
5727 <div>
5728
5729 <h5>Syntax:</h5>
5730 <pre>
5731   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5732 </pre>
5733
5734 <h5>Overview:</h5>
5735 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5736    integer and converts that value to the <tt>ty2</tt> type.</p>
5737
5738 <h5>Arguments:</h5>
5739 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5740    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5741    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5742    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5743    floating point type with the same number of elements as <tt>ty</tt></p>
5744
5745 <h5>Semantics:</h5>
5746 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5747    integer quantity and converts it to the corresponding floating point
5748    value. If the value cannot fit in the floating point value, the results are
5749    undefined.</p>
5750
5751 <h5>Example:</h5>
5752 <pre>
5753   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5754   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5755 </pre>
5756
5757 </div>
5758
5759 <!-- _______________________________________________________________________ -->
5760 <h4>
5761    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5762 </h4>
5763
5764 <div>
5765
5766 <h5>Syntax:</h5>
5767 <pre>
5768   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5769 </pre>
5770
5771 <h5>Overview:</h5>
5772 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5773    and converts that value to the <tt>ty2</tt> type.</p>
5774
5775 <h5>Arguments:</h5>
5776 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5777    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5778    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5779    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5780    floating point type with the same number of elements as <tt>ty</tt></p>
5781
5782 <h5>Semantics:</h5>
5783 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5784    quantity and converts it to the corresponding floating point value. If the
5785    value cannot fit in the floating point value, the results are undefined.</p>
5786
5787 <h5>Example:</h5>
5788 <pre>
5789   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5790   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5791 </pre>
5792
5793 </div>
5794
5795 <!-- _______________________________________________________________________ -->
5796 <h4>
5797    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5798 </h4>
5799
5800 <div>
5801
5802 <h5>Syntax:</h5>
5803 <pre>
5804   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5805 </pre>
5806
5807 <h5>Overview:</h5>
5808 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer or a vector of
5809    pointers <tt>value</tt> to
5810    the integer (or vector of integers) type <tt>ty2</tt>.</p>
5811
5812 <h5>Arguments:</h5>
5813 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5814    must be a a value of type <a href="#t_pointer">pointer</a> or a vector of
5815     pointers, and a type to cast it to
5816    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> or a vector
5817    of integers type.</p>
5818
5819 <h5>Semantics:</h5>
5820 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5821    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5822    truncating or zero extending that value to the size of the integer type. If
5823    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5824    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5825    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5826    change.</p>
5827
5828 <h5>Example:</h5>
5829 <pre>
5830   %X = ptrtoint i32* %P to i8                         <i>; yields truncation on 32-bit architecture</i>
5831   %Y = ptrtoint i32* %P to i64                        <i>; yields zero extension on 32-bit architecture</i>
5832   %Z = ptrtoint &lt;4 x i32*&gt; %P to &lt;4 x i64&gt;<i>; yields vector zero extension for a vector of addresses on 32-bit architecture</i>
5833 </pre>
5834
5835 </div>
5836
5837 <!-- _______________________________________________________________________ -->
5838 <h4>
5839    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5840 </h4>
5841
5842 <div>
5843
5844 <h5>Syntax:</h5>
5845 <pre>
5846   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5847 </pre>
5848
5849 <h5>Overview:</h5>
5850 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5851    pointer type, <tt>ty2</tt>.</p>
5852
5853 <h5>Arguments:</h5>
5854 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5855    value to cast, and a type to cast it to, which must be a
5856    <a href="#t_pointer">pointer</a> type.</p>
5857
5858 <h5>Semantics:</h5>
5859 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5860    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5861    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5862    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5863    than the size of a pointer then a zero extension is done. If they are the
5864    same size, nothing is done (<i>no-op cast</i>).</p>
5865
5866 <h5>Example:</h5>
5867 <pre>
5868   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5869   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5870   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5871   %Z = inttoptr &lt;4 x i32&gt; %G to &lt;4 x i8*&gt;<i>; yields truncation of vector G to four pointers</i>
5872 </pre>
5873
5874 </div>
5875
5876 <!-- _______________________________________________________________________ -->
5877 <h4>
5878    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5879 </h4>
5880
5881 <div>
5882
5883 <h5>Syntax:</h5>
5884 <pre>
5885   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5886 </pre>
5887
5888 <h5>Overview:</h5>
5889 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5890    <tt>ty2</tt> without changing any bits.</p>
5891
5892 <h5>Arguments:</h5>
5893 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5894    non-aggregate first class value, and a type to cast it to, which must also be
5895    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5896    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5897    identical. If the source type is a pointer, the destination type must also be
5898    a pointer.  This instruction supports bitwise conversion of vectors to
5899    integers and to vectors of other types (as long as they have the same
5900    size).</p>
5901
5902 <h5>Semantics:</h5>
5903 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5904    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5905    this conversion.  The conversion is done as if the <tt>value</tt> had been
5906    stored to memory and read back as type <tt>ty2</tt>.
5907    Pointer (or vector of pointers) types may only be converted to other pointer
5908    (or vector of pointers) types with this instruction. To convert
5909    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5910    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5911
5912 <h5>Example:</h5>
5913 <pre>
5914   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5915   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5916   %Z = bitcast &lt;2 x int&gt; %V to i64;        <i>; yields i64: %V</i>
5917   %Z = bitcast &lt;2 x i32*&gt; %V to &lt;2 x i64*&gt; <i>; yields &lt;2 x i64*&gt;</i>
5918 </pre>
5919
5920 </div>
5921
5922 </div>
5923
5924 <!-- ======================================================================= -->
5925 <h3>
5926   <a name="otherops">Other Operations</a>
5927 </h3>
5928
5929 <div>
5930
5931 <p>The instructions in this category are the "miscellaneous" instructions, which
5932    defy better classification.</p>
5933
5934 <!-- _______________________________________________________________________ -->
5935 <h4>
5936   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5937 </h4>
5938
5939 <div>
5940
5941 <h5>Syntax:</h5>
5942 <pre>
5943   &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>
5944 </pre>
5945
5946 <h5>Overview:</h5>
5947 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5948    boolean values based on comparison of its two integer, integer vector,
5949    pointer, or pointer vector operands.</p>
5950
5951 <h5>Arguments:</h5>
5952 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5953    the condition code indicating the kind of comparison to perform. It is not a
5954    value, just a keyword. The possible condition code are:</p>
5955
5956 <ol>
5957   <li><tt>eq</tt>: equal</li>
5958   <li><tt>ne</tt>: not equal </li>
5959   <li><tt>ugt</tt>: unsigned greater than</li>
5960   <li><tt>uge</tt>: unsigned greater or equal</li>
5961   <li><tt>ult</tt>: unsigned less than</li>
5962   <li><tt>ule</tt>: unsigned less or equal</li>
5963   <li><tt>sgt</tt>: signed greater than</li>
5964   <li><tt>sge</tt>: signed greater or equal</li>
5965   <li><tt>slt</tt>: signed less than</li>
5966   <li><tt>sle</tt>: signed less or equal</li>
5967 </ol>
5968
5969 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5970    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5971    typed.  They must also be identical types.</p>
5972
5973 <h5>Semantics:</h5>
5974 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5975    condition code given as <tt>cond</tt>. The comparison performed always yields
5976    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5977    result, as follows:</p>
5978
5979 <ol>
5980   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5981       <tt>false</tt> otherwise. No sign interpretation is necessary or
5982       performed.</li>
5983
5984   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5985       <tt>false</tt> otherwise. No sign interpretation is necessary or
5986       performed.</li>
5987
5988   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5989       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5990
5991   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5992       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5993       to <tt>op2</tt>.</li>
5994
5995   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5996       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5997
5998   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5999       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6000
6001   <li><tt>sgt</tt>: interprets the operands as signed values and yields
6002       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6003
6004   <li><tt>sge</tt>: interprets the operands as signed values and yields
6005       <tt>true</tt> if <tt>op1</tt> is greater than or equal
6006       to <tt>op2</tt>.</li>
6007
6008   <li><tt>slt</tt>: interprets the operands as signed values and yields
6009       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
6010
6011   <li><tt>sle</tt>: interprets the operands as signed values and yields
6012       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6013 </ol>
6014
6015 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
6016    values are compared as if they were integers.</p>
6017
6018 <p>If the operands are integer vectors, then they are compared element by
6019    element. The result is an <tt>i1</tt> vector with the same number of elements
6020    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
6021
6022 <h5>Example:</h5>
6023 <pre>
6024   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
6025   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
6026   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
6027   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
6028   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
6029   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
6030 </pre>
6031
6032 <p>Note that the code generator does not yet support vector types with
6033    the <tt>icmp</tt> instruction.</p>
6034
6035 </div>
6036
6037 <!-- _______________________________________________________________________ -->
6038 <h4>
6039   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
6040 </h4>
6041
6042 <div>
6043
6044 <h5>Syntax:</h5>
6045 <pre>
6046   &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>
6047 </pre>
6048
6049 <h5>Overview:</h5>
6050 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
6051    values based on comparison of its operands.</p>
6052
6053 <p>If the operands are floating point scalars, then the result type is a boolean
6054 (<a href="#t_integer"><tt>i1</tt></a>).</p>
6055
6056 <p>If the operands are floating point vectors, then the result type is a vector
6057    of boolean with the same number of elements as the operands being
6058    compared.</p>
6059
6060 <h5>Arguments:</h5>
6061 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
6062    the condition code indicating the kind of comparison to perform. It is not a
6063    value, just a keyword. The possible condition code are:</p>
6064
6065 <ol>
6066   <li><tt>false</tt>: no comparison, always returns false</li>
6067   <li><tt>oeq</tt>: ordered and equal</li>
6068   <li><tt>ogt</tt>: ordered and greater than </li>
6069   <li><tt>oge</tt>: ordered and greater than or equal</li>
6070   <li><tt>olt</tt>: ordered and less than </li>
6071   <li><tt>ole</tt>: ordered and less than or equal</li>
6072   <li><tt>one</tt>: ordered and not equal</li>
6073   <li><tt>ord</tt>: ordered (no nans)</li>
6074   <li><tt>ueq</tt>: unordered or equal</li>
6075   <li><tt>ugt</tt>: unordered or greater than </li>
6076   <li><tt>uge</tt>: unordered or greater than or equal</li>
6077   <li><tt>ult</tt>: unordered or less than </li>
6078   <li><tt>ule</tt>: unordered or less than or equal</li>
6079   <li><tt>une</tt>: unordered or not equal</li>
6080   <li><tt>uno</tt>: unordered (either nans)</li>
6081   <li><tt>true</tt>: no comparison, always returns true</li>
6082 </ol>
6083
6084 <p><i>Ordered</i> means that neither operand is a QNAN while
6085    <i>unordered</i> means that either operand may be a QNAN.</p>
6086
6087 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
6088    a <a href="#t_floating">floating point</a> type or
6089    a <a href="#t_vector">vector</a> of floating point type.  They must have
6090    identical types.</p>
6091
6092 <h5>Semantics:</h5>
6093 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
6094    according to the condition code given as <tt>cond</tt>.  If the operands are
6095    vectors, then the vectors are compared element by element.  Each comparison
6096    performed always yields an <a href="#t_integer">i1</a> result, as
6097    follows:</p>
6098
6099 <ol>
6100   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
6101
6102   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6103       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
6104
6105   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6106       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6107
6108   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6109       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
6110
6111   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6112       <tt>op1</tt> is less than <tt>op2</tt>.</li>
6113
6114   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6115       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6116
6117   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6118       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
6119
6120   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
6121
6122   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
6123       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
6124
6125   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
6126       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6127
6128   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
6129       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
6130
6131   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
6132       <tt>op1</tt> is less than <tt>op2</tt>.</li>
6133
6134   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
6135       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6136
6137   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
6138       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
6139
6140   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
6141
6142   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
6143 </ol>
6144
6145 <h5>Example:</h5>
6146 <pre>
6147   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
6148   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
6149   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
6150   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
6151 </pre>
6152
6153 <p>Note that the code generator does not yet support vector types with
6154    the <tt>fcmp</tt> instruction.</p>
6155
6156 </div>
6157
6158 <!-- _______________________________________________________________________ -->
6159 <h4>
6160   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
6161 </h4>
6162
6163 <div>
6164
6165 <h5>Syntax:</h5>
6166 <pre>
6167   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
6168 </pre>
6169
6170 <h5>Overview:</h5>
6171 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
6172    SSA graph representing the function.</p>
6173
6174 <h5>Arguments:</h5>
6175 <p>The type of the incoming values is specified with the first type field. After
6176    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
6177    one pair for each predecessor basic block of the current block.  Only values
6178    of <a href="#t_firstclass">first class</a> type may be used as the value
6179    arguments to the PHI node.  Only labels may be used as the label
6180    arguments.</p>
6181
6182 <p>There must be no non-phi instructions between the start of a basic block and
6183    the PHI instructions: i.e. PHI instructions must be first in a basic
6184    block.</p>
6185
6186 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
6187    occur on the edge from the corresponding predecessor block to the current
6188    block (but after any definition of an '<tt>invoke</tt>' instruction's return
6189    value on the same edge).</p>
6190
6191 <h5>Semantics:</h5>
6192 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
6193    specified by the pair corresponding to the predecessor basic block that
6194    executed just prior to the current block.</p>
6195
6196 <h5>Example:</h5>
6197 <pre>
6198 Loop:       ; Infinite loop that counts from 0 on up...
6199   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
6200   %nextindvar = add i32 %indvar, 1
6201   br label %Loop
6202 </pre>
6203
6204 </div>
6205
6206 <!-- _______________________________________________________________________ -->
6207 <h4>
6208    <a name="i_select">'<tt>select</tt>' Instruction</a>
6209 </h4>
6210
6211 <div>
6212
6213 <h5>Syntax:</h5>
6214 <pre>
6215   &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>
6216
6217   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
6218 </pre>
6219
6220 <h5>Overview:</h5>
6221 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
6222    condition, without branching.</p>
6223
6224
6225 <h5>Arguments:</h5>
6226 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
6227    values indicating the condition, and two values of the
6228    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
6229    vectors and the condition is a scalar, then entire vectors are selected, not
6230    individual elements.</p>
6231
6232 <h5>Semantics:</h5>
6233 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
6234    first value argument; otherwise, it returns the second value argument.</p>
6235
6236 <p>If the condition is a vector of i1, then the value arguments must be vectors
6237    of the same size, and the selection is done element by element.</p>
6238
6239 <h5>Example:</h5>
6240 <pre>
6241   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
6242 </pre>
6243
6244 </div>
6245
6246 <!-- _______________________________________________________________________ -->
6247 <h4>
6248   <a name="i_call">'<tt>call</tt>' Instruction</a>
6249 </h4>
6250
6251 <div>
6252
6253 <h5>Syntax:</h5>
6254 <pre>
6255   &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>]
6256 </pre>
6257
6258 <h5>Overview:</h5>
6259 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
6260
6261 <h5>Arguments:</h5>
6262 <p>This instruction requires several arguments:</p>
6263
6264 <ol>
6265   <li>The optional "tail" marker indicates that the callee function does not
6266       access any allocas or varargs in the caller.  Note that calls may be
6267       marked "tail" even if they do not occur before
6268       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
6269       present, the function call is eligible for tail call optimization,
6270       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
6271       optimized into a jump</a>.  The code generator may optimize calls marked
6272       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
6273       sibling call optimization</a> when the caller and callee have
6274       matching signatures, or 2) forced tail call optimization when the
6275       following extra requirements are met:
6276       <ul>
6277         <li>Caller and callee both have the calling
6278             convention <tt>fastcc</tt>.</li>
6279         <li>The call is in tail position (ret immediately follows call and ret
6280             uses value of call or is void).</li>
6281         <li>Option <tt>-tailcallopt</tt> is enabled,
6282             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
6283         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
6284             constraints are met.</a></li>
6285       </ul>
6286   </li>
6287
6288   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
6289       convention</a> the call should use.  If none is specified, the call
6290       defaults to using C calling conventions.  The calling convention of the
6291       call must match the calling convention of the target function, or else the
6292       behavior is undefined.</li>
6293
6294   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
6295       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
6296       '<tt>inreg</tt>' attributes are valid here.</li>
6297
6298   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
6299       type of the return value.  Functions that return no value are marked
6300       <tt><a href="#t_void">void</a></tt>.</li>
6301
6302   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
6303       being invoked.  The argument types must match the types implied by this
6304       signature.  This type can be omitted if the function is not varargs and if
6305       the function type does not return a pointer to a function.</li>
6306
6307   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
6308       be invoked. In most cases, this is a direct function invocation, but
6309       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
6310       to function value.</li>
6311
6312   <li>'<tt>function args</tt>': argument list whose types match the function
6313       signature argument types and parameter attributes. All arguments must be
6314       of <a href="#t_firstclass">first class</a> type. If the function
6315       signature indicates the function accepts a variable number of arguments,
6316       the extra arguments can be specified.</li>
6317
6318   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
6319       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
6320       '<tt>readnone</tt>' attributes are valid here.</li>
6321 </ol>
6322
6323 <h5>Semantics:</h5>
6324 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
6325    a specified function, with its incoming arguments bound to the specified
6326    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
6327    function, control flow continues with the instruction after the function
6328    call, and the return value of the function is bound to the result
6329    argument.</p>
6330
6331 <h5>Example:</h5>
6332 <pre>
6333   %retval = call i32 @test(i32 %argc)
6334   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
6335   %X = tail call i32 @foo()                                    <i>; yields i32</i>
6336   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
6337   call void %foo(i8 97 signext)
6338
6339   %struct.A = type { i32, i8 }
6340   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
6341   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
6342   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
6343   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
6344   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
6345 </pre>
6346
6347 <p>llvm treats calls to some functions with names and arguments that match the
6348 standard C99 library as being the C99 library functions, and may perform
6349 optimizations or generate code for them under that assumption.  This is
6350 something we'd like to change in the future to provide better support for
6351 freestanding environments and non-C-based languages.</p>
6352
6353 </div>
6354
6355 <!-- _______________________________________________________________________ -->
6356 <h4>
6357   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
6358 </h4>
6359
6360 <div>
6361
6362 <h5>Syntax:</h5>
6363 <pre>
6364   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
6365 </pre>
6366
6367 <h5>Overview:</h5>
6368 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
6369    the "variable argument" area of a function call.  It is used to implement the
6370    <tt>va_arg</tt> macro in C.</p>
6371
6372 <h5>Arguments:</h5>
6373 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
6374    argument. It returns a value of the specified argument type and increments
6375    the <tt>va_list</tt> to point to the next argument.  The actual type
6376    of <tt>va_list</tt> is target specific.</p>
6377
6378 <h5>Semantics:</h5>
6379 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
6380    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
6381    to the next argument.  For more information, see the variable argument
6382    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
6383
6384 <p>It is legal for this instruction to be called in a function which does not
6385    take a variable number of arguments, for example, the <tt>vfprintf</tt>
6386    function.</p>
6387
6388 <p><tt>va_arg</tt> is an LLVM instruction instead of
6389    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
6390    argument.</p>
6391
6392 <h5>Example:</h5>
6393 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6394
6395 <p>Note that the code generator does not yet fully support va_arg on many
6396    targets. Also, it does not currently support va_arg with aggregate types on
6397    any target.</p>
6398
6399 </div>
6400
6401 <!-- _______________________________________________________________________ -->
6402 <h4>
6403   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6404 </h4>
6405
6406 <div>
6407
6408 <h5>Syntax:</h5>
6409 <pre>
6410   &lt;resultval&gt; = landingpad &lt;resultty&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6411   &lt;resultval&gt; = landingpad &lt;resultty&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6412
6413   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6414   &lt;clause&gt; := filter &lt;array constant type&gt; &lt;array constant&gt;
6415 </pre>
6416
6417 <h5>Overview:</h5>
6418 <p>The '<tt>landingpad</tt>' instruction is used by
6419    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6420    system</a> to specify that a basic block is a landing pad &mdash; one where
6421    the exception lands, and corresponds to the code found in the
6422    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6423    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6424    re-entry to the function. The <tt>resultval</tt> has the
6425    type <tt>resultty</tt>.</p>
6426
6427 <h5>Arguments:</h5>
6428 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6429    function associated with the unwinding mechanism. The optional
6430    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6431
6432 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6433    or <tt>filter</tt> &mdash; and contains the global variable representing the
6434    "type" that may be caught or filtered respectively. Unlike the
6435    <tt>catch</tt> clause, the <tt>filter</tt> clause takes an array constant as
6436    its argument. Use "<tt>[0 x i8**] undef</tt>" for a filter which cannot
6437    throw. The '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6438    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6439
6440 <h5>Semantics:</h5>
6441 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6442    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6443    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6444    calling conventions, how the personality function results are represented in
6445    LLVM IR is target specific.</p>
6446
6447 <p>The clauses are applied in order from top to bottom. If two
6448    <tt>landingpad</tt> instructions are merged together through inlining, the
6449    clauses from the calling function are appended to the list of clauses.
6450    When the call stack is being unwound due to an exception being thrown, the
6451    exception is compared against each <tt>clause</tt> in turn.  If it doesn't
6452    match any of the clauses, and the <tt>cleanup</tt> flag is not set, then
6453    unwinding continues further up the call stack.</p>
6454
6455 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6456
6457 <ul>
6458   <li>A landing pad block is a basic block which is the unwind destination of an
6459       '<tt>invoke</tt>' instruction.</li>
6460   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6461       first non-PHI instruction.</li>
6462   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6463       pad block.</li>
6464   <li>A basic block that is not a landing pad block may not include a
6465       '<tt>landingpad</tt>' instruction.</li>
6466   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6467       personality function.</li>
6468 </ul>
6469
6470 <h5>Example:</h5>
6471 <pre>
6472   ;; A landing pad which can catch an integer.
6473   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6474            catch i8** @_ZTIi
6475   ;; A landing pad that is a cleanup.
6476   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6477            cleanup
6478   ;; A landing pad which can catch an integer and can only throw a double.
6479   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6480            catch i8** @_ZTIi
6481            filter [1 x i8**] [@_ZTId]
6482 </pre>
6483
6484 </div>
6485
6486 </div>
6487
6488 </div>
6489
6490 <!-- *********************************************************************** -->
6491 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6492 <!-- *********************************************************************** -->
6493
6494 <div>
6495
6496 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6497    well known names and semantics and are required to follow certain
6498    restrictions.  Overall, these intrinsics represent an extension mechanism for
6499    the LLVM language that does not require changing all of the transformations
6500    in LLVM when adding to the language (or the bitcode reader/writer, the
6501    parser, etc...).</p>
6502
6503 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6504    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6505    begin with this prefix.  Intrinsic functions must always be external
6506    functions: you cannot define the body of intrinsic functions.  Intrinsic
6507    functions may only be used in call or invoke instructions: it is illegal to
6508    take the address of an intrinsic function.  Additionally, because intrinsic
6509    functions are part of the LLVM language, it is required if any are added that
6510    they be documented here.</p>
6511
6512 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6513    family of functions that perform the same operation but on different data
6514    types. Because LLVM can represent over 8 million different integer types,
6515    overloading is used commonly to allow an intrinsic function to operate on any
6516    integer type. One or more of the argument types or the result type can be
6517    overloaded to accept any integer type. Argument types may also be defined as
6518    exactly matching a previous argument's type or the result type. This allows
6519    an intrinsic function which accepts multiple arguments, but needs all of them
6520    to be of the same type, to only be overloaded with respect to a single
6521    argument or the result.</p>
6522
6523 <p>Overloaded intrinsics will have the names of its overloaded argument types
6524    encoded into its function name, each preceded by a period. Only those types
6525    which are overloaded result in a name suffix. Arguments whose type is matched
6526    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6527    can take an integer of any width and returns an integer of exactly the same
6528    integer width. This leads to a family of functions such as
6529    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6530    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6531    suffix is required. Because the argument's type is matched against the return
6532    type, it does not require its own name suffix.</p>
6533
6534 <p>To learn how to add an intrinsic function, please see the
6535    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6536
6537 <!-- ======================================================================= -->
6538 <h3>
6539   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6540 </h3>
6541
6542 <div>
6543
6544 <p>Variable argument support is defined in LLVM with
6545    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6546    intrinsic functions.  These functions are related to the similarly named
6547    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6548
6549 <p>All of these functions operate on arguments that use a target-specific value
6550    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6551    not define what this type is, so all transformations should be prepared to
6552    handle these functions regardless of the type used.</p>
6553
6554 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6555    instruction and the variable argument handling intrinsic functions are
6556    used.</p>
6557
6558 <pre class="doc_code">
6559 define i32 @test(i32 %X, ...) {
6560   ; Initialize variable argument processing
6561   %ap = alloca i8*
6562   %ap2 = bitcast i8** %ap to i8*
6563   call void @llvm.va_start(i8* %ap2)
6564
6565   ; Read a single integer argument
6566   %tmp = va_arg i8** %ap, i32
6567
6568   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6569   %aq = alloca i8*
6570   %aq2 = bitcast i8** %aq to i8*
6571   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6572   call void @llvm.va_end(i8* %aq2)
6573
6574   ; Stop processing of arguments.
6575   call void @llvm.va_end(i8* %ap2)
6576   ret i32 %tmp
6577 }
6578
6579 declare void @llvm.va_start(i8*)
6580 declare void @llvm.va_copy(i8*, i8*)
6581 declare void @llvm.va_end(i8*)
6582 </pre>
6583
6584 <!-- _______________________________________________________________________ -->
6585 <h4>
6586   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6587 </h4>
6588
6589
6590 <div>
6591
6592 <h5>Syntax:</h5>
6593 <pre>
6594   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6595 </pre>
6596
6597 <h5>Overview:</h5>
6598 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6599    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6600
6601 <h5>Arguments:</h5>
6602 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6603
6604 <h5>Semantics:</h5>
6605 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6606    macro available in C.  In a target-dependent way, it initializes
6607    the <tt>va_list</tt> element to which the argument points, so that the next
6608    call to <tt>va_arg</tt> will produce the first variable argument passed to
6609    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6610    need to know the last argument of the function as the compiler can figure
6611    that out.</p>
6612
6613 </div>
6614
6615 <!-- _______________________________________________________________________ -->
6616 <h4>
6617  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6618 </h4>
6619
6620 <div>
6621
6622 <h5>Syntax:</h5>
6623 <pre>
6624   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6625 </pre>
6626
6627 <h5>Overview:</h5>
6628 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6629    which has been initialized previously
6630    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6631    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6632
6633 <h5>Arguments:</h5>
6634 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6635
6636 <h5>Semantics:</h5>
6637 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6638    macro available in C.  In a target-dependent way, it destroys
6639    the <tt>va_list</tt> element to which the argument points.  Calls
6640    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6641    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6642    with calls to <tt>llvm.va_end</tt>.</p>
6643
6644 </div>
6645
6646 <!-- _______________________________________________________________________ -->
6647 <h4>
6648   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6649 </h4>
6650
6651 <div>
6652
6653 <h5>Syntax:</h5>
6654 <pre>
6655   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6656 </pre>
6657
6658 <h5>Overview:</h5>
6659 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6660    from the source argument list to the destination argument list.</p>
6661
6662 <h5>Arguments:</h5>
6663 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6664    The second argument is a pointer to a <tt>va_list</tt> element to copy
6665    from.</p>
6666
6667 <h5>Semantics:</h5>
6668 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6669    macro available in C.  In a target-dependent way, it copies the
6670    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6671    element.  This intrinsic is necessary because
6672    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6673    arbitrarily complex and require, for example, memory allocation.</p>
6674
6675 </div>
6676
6677 </div>
6678
6679 <!-- ======================================================================= -->
6680 <h3>
6681   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6682 </h3>
6683
6684 <div>
6685
6686 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6687 Collection</a> (GC) requires the implementation and generation of these
6688 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6689 roots on the stack</a>, as well as garbage collector implementations that
6690 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6691 barriers.  Front-ends for type-safe garbage collected languages should generate
6692 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6693 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6694 LLVM</a>.</p>
6695
6696 <p>The garbage collection intrinsics only operate on objects in the generic
6697    address space (address space zero).</p>
6698
6699 <!-- _______________________________________________________________________ -->
6700 <h4>
6701   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6702 </h4>
6703
6704 <div>
6705
6706 <h5>Syntax:</h5>
6707 <pre>
6708   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6709 </pre>
6710
6711 <h5>Overview:</h5>
6712 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6713    the code generator, and allows some metadata to be associated with it.</p>
6714
6715 <h5>Arguments:</h5>
6716 <p>The first argument specifies the address of a stack object that contains the
6717    root pointer.  The second pointer (which must be either a constant or a
6718    global value address) contains the meta-data to be associated with the
6719    root.</p>
6720
6721 <h5>Semantics:</h5>
6722 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6723    location.  At compile-time, the code generator generates information to allow
6724    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6725    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6726    algorithm</a>.</p>
6727
6728 </div>
6729
6730 <!-- _______________________________________________________________________ -->
6731 <h4>
6732   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6733 </h4>
6734
6735 <div>
6736
6737 <h5>Syntax:</h5>
6738 <pre>
6739   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6740 </pre>
6741
6742 <h5>Overview:</h5>
6743 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6744    locations, allowing garbage collector implementations that require read
6745    barriers.</p>
6746
6747 <h5>Arguments:</h5>
6748 <p>The second argument is the address to read from, which should be an address
6749    allocated from the garbage collector.  The first object is a pointer to the
6750    start of the referenced object, if needed by the language runtime (otherwise
6751    null).</p>
6752
6753 <h5>Semantics:</h5>
6754 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6755    instruction, but may be replaced with substantially more complex code by the
6756    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6757    may only be used in a function which <a href="#gc">specifies a GC
6758    algorithm</a>.</p>
6759
6760 </div>
6761
6762 <!-- _______________________________________________________________________ -->
6763 <h4>
6764   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6765 </h4>
6766
6767 <div>
6768
6769 <h5>Syntax:</h5>
6770 <pre>
6771   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6772 </pre>
6773
6774 <h5>Overview:</h5>
6775 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6776    locations, allowing garbage collector implementations that require write
6777    barriers (such as generational or reference counting collectors).</p>
6778
6779 <h5>Arguments:</h5>
6780 <p>The first argument is the reference to store, the second is the start of the
6781    object to store it to, and the third is the address of the field of Obj to
6782    store to.  If the runtime does not require a pointer to the object, Obj may
6783    be null.</p>
6784
6785 <h5>Semantics:</h5>
6786 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6787    instruction, but may be replaced with substantially more complex code by the
6788    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6789    may only be used in a function which <a href="#gc">specifies a GC
6790    algorithm</a>.</p>
6791
6792 </div>
6793
6794 </div>
6795
6796 <!-- ======================================================================= -->
6797 <h3>
6798   <a name="int_codegen">Code Generator Intrinsics</a>
6799 </h3>
6800
6801 <div>
6802
6803 <p>These intrinsics are provided by LLVM to expose special features that may
6804    only be implemented with code generator support.</p>
6805
6806 <!-- _______________________________________________________________________ -->
6807 <h4>
6808   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6809 </h4>
6810
6811 <div>
6812
6813 <h5>Syntax:</h5>
6814 <pre>
6815   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6816 </pre>
6817
6818 <h5>Overview:</h5>
6819 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6820    target-specific value indicating the return address of the current function
6821    or one of its callers.</p>
6822
6823 <h5>Arguments:</h5>
6824 <p>The argument to this intrinsic indicates which function to return the address
6825    for.  Zero indicates the calling function, one indicates its caller, etc.
6826    The argument is <b>required</b> to be a constant integer value.</p>
6827
6828 <h5>Semantics:</h5>
6829 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6830    indicating the return address of the specified call frame, or zero if it
6831    cannot be identified.  The value returned by this intrinsic is likely to be
6832    incorrect or 0 for arguments other than zero, so it should only be used for
6833    debugging purposes.</p>
6834
6835 <p>Note that calling this intrinsic does not prevent function inlining or other
6836    aggressive transformations, so the value returned may not be that of the
6837    obvious source-language caller.</p>
6838
6839 </div>
6840
6841 <!-- _______________________________________________________________________ -->
6842 <h4>
6843   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6844 </h4>
6845
6846 <div>
6847
6848 <h5>Syntax:</h5>
6849 <pre>
6850   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6851 </pre>
6852
6853 <h5>Overview:</h5>
6854 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6855    target-specific frame pointer value for the specified stack frame.</p>
6856
6857 <h5>Arguments:</h5>
6858 <p>The argument to this intrinsic indicates which function to return the frame
6859    pointer for.  Zero indicates the calling function, one indicates its caller,
6860    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6861
6862 <h5>Semantics:</h5>
6863 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6864    indicating the frame address of the specified call frame, or zero if it
6865    cannot be identified.  The value returned by this intrinsic is likely to be
6866    incorrect or 0 for arguments other than zero, so it should only be used for
6867    debugging purposes.</p>
6868
6869 <p>Note that calling this intrinsic does not prevent function inlining or other
6870    aggressive transformations, so the value returned may not be that of the
6871    obvious source-language caller.</p>
6872
6873 </div>
6874
6875 <!-- _______________________________________________________________________ -->
6876 <h4>
6877   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6878 </h4>
6879
6880 <div>
6881
6882 <h5>Syntax:</h5>
6883 <pre>
6884   declare i8* @llvm.stacksave()
6885 </pre>
6886
6887 <h5>Overview:</h5>
6888 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6889    of the function stack, for use
6890    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6891    useful for implementing language features like scoped automatic variable
6892    sized arrays in C99.</p>
6893
6894 <h5>Semantics:</h5>
6895 <p>This intrinsic returns a opaque pointer value that can be passed
6896    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6897    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6898    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6899    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6900    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6901    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6902
6903 </div>
6904
6905 <!-- _______________________________________________________________________ -->
6906 <h4>
6907   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6908 </h4>
6909
6910 <div>
6911
6912 <h5>Syntax:</h5>
6913 <pre>
6914   declare void @llvm.stackrestore(i8* %ptr)
6915 </pre>
6916
6917 <h5>Overview:</h5>
6918 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6919    the function stack to the state it was in when the
6920    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6921    executed.  This is useful for implementing language features like scoped
6922    automatic variable sized arrays in C99.</p>
6923
6924 <h5>Semantics:</h5>
6925 <p>See the description
6926    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6927
6928 </div>
6929
6930 <!-- _______________________________________________________________________ -->
6931 <h4>
6932   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6933 </h4>
6934
6935 <div>
6936
6937 <h5>Syntax:</h5>
6938 <pre>
6939   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6940 </pre>
6941
6942 <h5>Overview:</h5>
6943 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6944    insert a prefetch instruction if supported; otherwise, it is a noop.
6945    Prefetches have no effect on the behavior of the program but can change its
6946    performance characteristics.</p>
6947
6948 <h5>Arguments:</h5>
6949 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6950    specifier determining if the fetch should be for a read (0) or write (1),
6951    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6952    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6953    specifies whether the prefetch is performed on the data (1) or instruction (0)
6954    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6955    must be constant integers.</p>
6956
6957 <h5>Semantics:</h5>
6958 <p>This intrinsic does not modify the behavior of the program.  In particular,
6959    prefetches cannot trap and do not produce a value.  On targets that support
6960    this intrinsic, the prefetch can provide hints to the processor cache for
6961    better performance.</p>
6962
6963 </div>
6964
6965 <!-- _______________________________________________________________________ -->
6966 <h4>
6967   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
6968 </h4>
6969
6970 <div>
6971
6972 <h5>Syntax:</h5>
6973 <pre>
6974   declare void @llvm.pcmarker(i32 &lt;id&gt;)
6975 </pre>
6976
6977 <h5>Overview:</h5>
6978 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
6979    Counter (PC) in a region of code to simulators and other tools.  The method
6980    is target specific, but it is expected that the marker will use exported
6981    symbols to transmit the PC of the marker.  The marker makes no guarantees
6982    that it will remain with any specific instruction after optimizations.  It is
6983    possible that the presence of a marker will inhibit optimizations.  The
6984    intended use is to be inserted after optimizations to allow correlations of
6985    simulation runs.</p>
6986
6987 <h5>Arguments:</h5>
6988 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6989
6990 <h5>Semantics:</h5>
6991 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6992    not support this intrinsic may ignore it.</p>
6993
6994 </div>
6995
6996 <!-- _______________________________________________________________________ -->
6997 <h4>
6998   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6999 </h4>
7000
7001 <div>
7002
7003 <h5>Syntax:</h5>
7004 <pre>
7005   declare i64 @llvm.readcyclecounter()
7006 </pre>
7007
7008 <h5>Overview:</h5>
7009 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
7010    counter register (or similar low latency, high accuracy clocks) on those
7011    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
7012    should map to RPCC.  As the backing counters overflow quickly (on the order
7013    of 9 seconds on alpha), this should only be used for small timings.</p>
7014
7015 <h5>Semantics:</h5>
7016 <p>When directly supported, reading the cycle counter should not modify any
7017    memory.  Implementations are allowed to either return a application specific
7018    value or a system wide value.  On backends without support, this is lowered
7019    to a constant 0.</p>
7020
7021 </div>
7022
7023 </div>
7024
7025 <!-- ======================================================================= -->
7026 <h3>
7027   <a name="int_libc">Standard C Library Intrinsics</a>
7028 </h3>
7029
7030 <div>
7031
7032 <p>LLVM provides intrinsics for a few important standard C library functions.
7033    These intrinsics allow source-language front-ends to pass information about
7034    the alignment of the pointer arguments to the code generator, providing
7035    opportunity for more efficient code generation.</p>
7036
7037 <!-- _______________________________________________________________________ -->
7038 <h4>
7039   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
7040 </h4>
7041
7042 <div>
7043
7044 <h5>Syntax:</h5>
7045 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
7046    integer bit width and for different address spaces. Not all targets support
7047    all bit widths however.</p>
7048
7049 <pre>
7050   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7051                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7052   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7053                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7054 </pre>
7055
7056 <h5>Overview:</h5>
7057 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
7058    source location to the destination location.</p>
7059
7060 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
7061    intrinsics do not return a value, takes extra alignment/isvolatile arguments
7062    and the pointers can be in specified address spaces.</p>
7063
7064 <h5>Arguments:</h5>
7065
7066 <p>The first argument is a pointer to the destination, the second is a pointer
7067    to the source.  The third argument is an integer argument specifying the
7068    number of bytes to copy, the fourth argument is the alignment of the
7069    source and destination locations, and the fifth is a boolean indicating a
7070    volatile access.</p>
7071
7072 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7073    then the caller guarantees that both the source and destination pointers are
7074    aligned to that boundary.</p>
7075
7076 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7077    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
7078    The detailed access behavior is not very cleanly specified and it is unwise
7079    to depend on it.</p>
7080
7081 <h5>Semantics:</h5>
7082
7083 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
7084    source location to the destination location, which are not allowed to
7085    overlap.  It copies "len" bytes of memory over.  If the argument is known to
7086    be aligned to some boundary, this can be specified as the fourth argument,
7087    otherwise it should be set to 0 or 1.</p>
7088
7089 </div>
7090
7091 <!-- _______________________________________________________________________ -->
7092 <h4>
7093   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
7094 </h4>
7095
7096 <div>
7097
7098 <h5>Syntax:</h5>
7099 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
7100    width and for different address space. Not all targets support all bit
7101    widths however.</p>
7102
7103 <pre>
7104   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7105                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7106   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7107                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7108 </pre>
7109
7110 <h5>Overview:</h5>
7111 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
7112    source location to the destination location. It is similar to the
7113    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
7114    overlap.</p>
7115
7116 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
7117    intrinsics do not return a value, takes extra alignment/isvolatile arguments
7118    and the pointers can be in specified address spaces.</p>
7119
7120 <h5>Arguments:</h5>
7121
7122 <p>The first argument is a pointer to the destination, the second is a pointer
7123    to the source.  The third argument is an integer argument specifying the
7124    number of bytes to copy, the fourth argument is the alignment of the
7125    source and destination locations, and the fifth is a boolean indicating a
7126    volatile access.</p>
7127
7128 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7129    then the caller guarantees that the source and destination pointers are
7130    aligned to that boundary.</p>
7131
7132 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7133    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
7134    The detailed access behavior is not very cleanly specified and it is unwise
7135    to depend on it.</p>
7136
7137 <h5>Semantics:</h5>
7138
7139 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
7140    source location to the destination location, which may overlap.  It copies
7141    "len" bytes of memory over.  If the argument is known to be aligned to some
7142    boundary, this can be specified as the fourth argument, otherwise it should
7143    be set to 0 or 1.</p>
7144
7145 </div>
7146
7147 <!-- _______________________________________________________________________ -->
7148 <h4>
7149   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
7150 </h4>
7151
7152 <div>
7153
7154 <h5>Syntax:</h5>
7155 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
7156    width and for different address spaces. However, not all targets support all
7157    bit widths.</p>
7158
7159 <pre>
7160   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
7161                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7162   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
7163                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7164 </pre>
7165
7166 <h5>Overview:</h5>
7167 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
7168    particular byte value.</p>
7169
7170 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
7171    intrinsic does not return a value and takes extra alignment/volatile
7172    arguments.  Also, the destination can be in an arbitrary address space.</p>
7173
7174 <h5>Arguments:</h5>
7175 <p>The first argument is a pointer to the destination to fill, the second is the
7176    byte value with which to fill it, the third argument is an integer argument
7177    specifying the number of bytes to fill, and the fourth argument is the known
7178    alignment of the destination location.</p>
7179
7180 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7181    then the caller guarantees that the destination pointer is aligned to that
7182    boundary.</p>
7183
7184 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7185    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
7186    The detailed access behavior is not very cleanly specified and it is unwise
7187    to depend on it.</p>
7188
7189 <h5>Semantics:</h5>
7190 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
7191    at the destination location.  If the argument is known to be aligned to some
7192    boundary, this can be specified as the fourth argument, otherwise it should
7193    be set to 0 or 1.</p>
7194
7195 </div>
7196
7197 <!-- _______________________________________________________________________ -->
7198 <h4>
7199   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
7200 </h4>
7201
7202 <div>
7203
7204 <h5>Syntax:</h5>
7205 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
7206    floating point or vector of floating point type. Not all targets support all
7207    types however.</p>
7208
7209 <pre>
7210   declare float     @llvm.sqrt.f32(float %Val)
7211   declare double    @llvm.sqrt.f64(double %Val)
7212   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
7213   declare fp128     @llvm.sqrt.f128(fp128 %Val)
7214   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
7215 </pre>
7216
7217 <h5>Overview:</h5>
7218 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
7219    returning the same value as the libm '<tt>sqrt</tt>' functions would.
7220    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
7221    behavior for negative numbers other than -0.0 (which allows for better
7222    optimization, because there is no need to worry about errno being
7223    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
7224
7225 <h5>Arguments:</h5>
7226 <p>The argument and return value are floating point numbers of the same
7227    type.</p>
7228
7229 <h5>Semantics:</h5>
7230 <p>This function returns the sqrt of the specified operand if it is a
7231    nonnegative floating point number.</p>
7232
7233 </div>
7234
7235 <!-- _______________________________________________________________________ -->
7236 <h4>
7237   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
7238 </h4>
7239
7240 <div>
7241
7242 <h5>Syntax:</h5>
7243 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
7244    floating point or vector of floating point type. Not all targets support all
7245    types however.</p>
7246
7247 <pre>
7248   declare float     @llvm.powi.f32(float  %Val, i32 %power)
7249   declare double    @llvm.powi.f64(double %Val, i32 %power)
7250   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
7251   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
7252   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
7253 </pre>
7254
7255 <h5>Overview:</h5>
7256 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
7257    specified (positive or negative) power.  The order of evaluation of
7258    multiplications is not defined.  When a vector of floating point type is
7259    used, the second argument remains a scalar integer value.</p>
7260
7261 <h5>Arguments:</h5>
7262 <p>The second argument is an integer power, and the first is a value to raise to
7263    that power.</p>
7264
7265 <h5>Semantics:</h5>
7266 <p>This function returns the first value raised to the second power with an
7267    unspecified sequence of rounding operations.</p>
7268
7269 </div>
7270
7271 <!-- _______________________________________________________________________ -->
7272 <h4>
7273   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
7274 </h4>
7275
7276 <div>
7277
7278 <h5>Syntax:</h5>
7279 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
7280    floating point or vector of floating point type. Not all targets support all
7281    types however.</p>
7282
7283 <pre>
7284   declare float     @llvm.sin.f32(float  %Val)
7285   declare double    @llvm.sin.f64(double %Val)
7286   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
7287   declare fp128     @llvm.sin.f128(fp128 %Val)
7288   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
7289 </pre>
7290
7291 <h5>Overview:</h5>
7292 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
7293
7294 <h5>Arguments:</h5>
7295 <p>The argument and return value are floating point numbers of the same
7296    type.</p>
7297
7298 <h5>Semantics:</h5>
7299 <p>This function returns the sine of the specified operand, returning the same
7300    values as the libm <tt>sin</tt> functions would, and handles error conditions
7301    in the same way.</p>
7302
7303 </div>
7304
7305 <!-- _______________________________________________________________________ -->
7306 <h4>
7307   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
7308 </h4>
7309
7310 <div>
7311
7312 <h5>Syntax:</h5>
7313 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
7314    floating point or vector of floating point type. Not all targets support all
7315    types however.</p>
7316
7317 <pre>
7318   declare float     @llvm.cos.f32(float  %Val)
7319   declare double    @llvm.cos.f64(double %Val)
7320   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
7321   declare fp128     @llvm.cos.f128(fp128 %Val)
7322   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
7323 </pre>
7324
7325 <h5>Overview:</h5>
7326 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
7327
7328 <h5>Arguments:</h5>
7329 <p>The argument and return value are floating point numbers of the same
7330    type.</p>
7331
7332 <h5>Semantics:</h5>
7333 <p>This function returns the cosine of the specified operand, returning the same
7334    values as the libm <tt>cos</tt> functions would, and handles error conditions
7335    in the same way.</p>
7336
7337 </div>
7338
7339 <!-- _______________________________________________________________________ -->
7340 <h4>
7341   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
7342 </h4>
7343
7344 <div>
7345
7346 <h5>Syntax:</h5>
7347 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
7348    floating point or vector of floating point type. Not all targets support all
7349    types however.</p>
7350
7351 <pre>
7352   declare float     @llvm.pow.f32(float  %Val, float %Power)
7353   declare double    @llvm.pow.f64(double %Val, double %Power)
7354   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
7355   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
7356   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
7357 </pre>
7358
7359 <h5>Overview:</h5>
7360 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
7361    specified (positive or negative) power.</p>
7362
7363 <h5>Arguments:</h5>
7364 <p>The second argument is a floating point power, and the first is a value to
7365    raise to that power.</p>
7366
7367 <h5>Semantics:</h5>
7368 <p>This function returns the first value raised to the second power, returning
7369    the same values as the libm <tt>pow</tt> functions would, and handles error
7370    conditions in the same way.</p>
7371
7372 </div>
7373
7374 <!-- _______________________________________________________________________ -->
7375 <h4>
7376   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
7377 </h4>
7378
7379 <div>
7380
7381 <h5>Syntax:</h5>
7382 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
7383    floating point or vector of floating point type. Not all targets support all
7384    types however.</p>
7385
7386 <pre>
7387   declare float     @llvm.exp.f32(float  %Val)
7388   declare double    @llvm.exp.f64(double %Val)
7389   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
7390   declare fp128     @llvm.exp.f128(fp128 %Val)
7391   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
7392 </pre>
7393
7394 <h5>Overview:</h5>
7395 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7396
7397 <h5>Arguments:</h5>
7398 <p>The argument and return value are floating point numbers of the same
7399    type.</p>
7400
7401 <h5>Semantics:</h5>
7402 <p>This function returns the same values as the libm <tt>exp</tt> functions
7403    would, and handles error conditions in the same way.</p>
7404
7405 </div>
7406
7407 <!-- _______________________________________________________________________ -->
7408 <h4>
7409   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7410 </h4>
7411
7412 <div>
7413
7414 <h5>Syntax:</h5>
7415 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7416    floating point or vector of floating point type. Not all targets support all
7417    types however.</p>
7418
7419 <pre>
7420   declare float     @llvm.log.f32(float  %Val)
7421   declare double    @llvm.log.f64(double %Val)
7422   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7423   declare fp128     @llvm.log.f128(fp128 %Val)
7424   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7425 </pre>
7426
7427 <h5>Overview:</h5>
7428 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7429
7430 <h5>Arguments:</h5>
7431 <p>The argument and return value are floating point numbers of the same
7432    type.</p>
7433
7434 <h5>Semantics:</h5>
7435 <p>This function returns the same values as the libm <tt>log</tt> functions
7436    would, and handles error conditions in the same way.</p>
7437
7438 </div>
7439
7440 <!-- _______________________________________________________________________ -->
7441 <h4>
7442   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7443 </h4>
7444
7445 <div>
7446
7447 <h5>Syntax:</h5>
7448 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7449    floating point or vector of floating point type. Not all targets support all
7450    types however.</p>
7451
7452 <pre>
7453   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7454   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7455   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7456   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7457   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7458 </pre>
7459
7460 <h5>Overview:</h5>
7461 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7462    operation.</p>
7463
7464 <h5>Arguments:</h5>
7465 <p>The argument and return value are floating point numbers of the same
7466    type.</p>
7467
7468 <h5>Semantics:</h5>
7469 <p>This function returns the same values as the libm <tt>fma</tt> functions
7470    would.</p>
7471
7472 </div>
7473
7474 </div>
7475
7476 <!-- ======================================================================= -->
7477 <h3>
7478   <a name="int_manip">Bit Manipulation Intrinsics</a>
7479 </h3>
7480
7481 <div>
7482
7483 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7484    These allow efficient code generation for some algorithms.</p>
7485
7486 <!-- _______________________________________________________________________ -->
7487 <h4>
7488   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7489 </h4>
7490
7491 <div>
7492
7493 <h5>Syntax:</h5>
7494 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7495    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7496
7497 <pre>
7498   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7499   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7500   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7501 </pre>
7502
7503 <h5>Overview:</h5>
7504 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7505    values with an even number of bytes (positive multiple of 16 bits).  These
7506    are useful for performing operations on data that is not in the target's
7507    native byte order.</p>
7508
7509 <h5>Semantics:</h5>
7510 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7511    and low byte of the input i16 swapped.  Similarly,
7512    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7513    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7514    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7515    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7516    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7517    more, respectively).</p>
7518
7519 </div>
7520
7521 <!-- _______________________________________________________________________ -->
7522 <h4>
7523   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7524 </h4>
7525
7526 <div>
7527
7528 <h5>Syntax:</h5>
7529 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7530    width, or on any vector with integer elements. Not all targets support all
7531   bit widths or vector types, however.</p>
7532
7533 <pre>
7534   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7535   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7536   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7537   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7538   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7539   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7540 </pre>
7541
7542 <h5>Overview:</h5>
7543 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7544    in a value.</p>
7545
7546 <h5>Arguments:</h5>
7547 <p>The only argument is the value to be counted.  The argument may be of any
7548    integer type, or a vector with integer elements.
7549    The return type must match the argument type.</p>
7550
7551 <h5>Semantics:</h5>
7552 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7553    element of a vector.</p>
7554
7555 </div>
7556
7557 <!-- _______________________________________________________________________ -->
7558 <h4>
7559   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7560 </h4>
7561
7562 <div>
7563
7564 <h5>Syntax:</h5>
7565 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7566    integer bit width, or any vector whose elements are integers. Not all
7567    targets support all bit widths or vector types, however.</p>
7568
7569 <pre>
7570   declare i8   @llvm.ctlz.i8  (i8   &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7571   declare i16  @llvm.ctlz.i16 (i16  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7572   declare i32  @llvm.ctlz.i32 (i32  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7573   declare i64  @llvm.ctlz.i64 (i64  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7574   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7575   declase &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7576 </pre>
7577
7578 <h5>Overview:</h5>
7579 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7580    leading zeros in a variable.</p>
7581
7582 <h5>Arguments:</h5>
7583 <p>The first argument is the value to be counted. This argument may be of any
7584    integer type, or a vectory with integer element type. The return type
7585    must match the first argument type.</p>
7586
7587 <p>The second argument must be a constant and is a flag to indicate whether the
7588    intrinsic should ensure that a zero as the first argument produces a defined
7589    result. Historically some architectures did not provide a defined result for
7590    zero values as efficiently, and many algorithms are now predicated on
7591    avoiding zero-value inputs.</p>
7592
7593 <h5>Semantics:</h5>
7594 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7595    zeros in a variable, or within each element of the vector.
7596    If <tt>src == 0</tt> then the result is the size in bits of the type of
7597    <tt>src</tt> if <tt>is_zero_undef == 0</tt> and <tt>undef</tt> otherwise.
7598    For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7599
7600 </div>
7601
7602 <!-- _______________________________________________________________________ -->
7603 <h4>
7604   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7605 </h4>
7606
7607 <div>
7608
7609 <h5>Syntax:</h5>
7610 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7611    integer bit width, or any vector of integer elements. Not all targets
7612    support all bit widths or vector types, however.</p>
7613
7614 <pre>
7615   declare i8   @llvm.cttz.i8  (i8   &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7616   declare i16  @llvm.cttz.i16 (i16  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7617   declare i32  @llvm.cttz.i32 (i32  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7618   declare i64  @llvm.cttz.i64 (i64  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7619   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7620   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7621 </pre>
7622
7623 <h5>Overview:</h5>
7624 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7625    trailing zeros.</p>
7626
7627 <h5>Arguments:</h5>
7628 <p>The first argument is the value to be counted. This argument may be of any
7629    integer type, or a vectory with integer element type. The return type
7630    must match the first argument type.</p>
7631
7632 <p>The second argument must be a constant and is a flag to indicate whether the
7633    intrinsic should ensure that a zero as the first argument produces a defined
7634    result. Historically some architectures did not provide a defined result for
7635    zero values as efficiently, and many algorithms are now predicated on
7636    avoiding zero-value inputs.</p>
7637
7638 <h5>Semantics:</h5>
7639 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7640    zeros in a variable, or within each element of a vector.
7641    If <tt>src == 0</tt> then the result is the size in bits of the type of
7642    <tt>src</tt> if <tt>is_zero_undef == 0</tt> and <tt>undef</tt> otherwise.
7643    For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7644
7645 </div>
7646
7647 </div>
7648
7649 <!-- ======================================================================= -->
7650 <h3>
7651   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7652 </h3>
7653
7654 <div>
7655
7656 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7657
7658 <!-- _______________________________________________________________________ -->
7659 <h4>
7660   <a name="int_sadd_overflow">
7661     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7662   </a>
7663 </h4>
7664
7665 <div>
7666
7667 <h5>Syntax:</h5>
7668 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7669    on any integer bit width.</p>
7670
7671 <pre>
7672   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7673   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7674   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7675 </pre>
7676
7677 <h5>Overview:</h5>
7678 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7679    a signed addition of the two arguments, and indicate whether an overflow
7680    occurred during the signed summation.</p>
7681
7682 <h5>Arguments:</h5>
7683 <p>The arguments (%a and %b) and the first element of the result structure may
7684    be of integer types of any bit width, but they must have the same bit
7685    width. The second element of the result structure must be of
7686    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7687    undergo signed addition.</p>
7688
7689 <h5>Semantics:</h5>
7690 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7691    a signed addition of the two variables. They return a structure &mdash; the
7692    first element of which is the signed summation, and the second element of
7693    which is a bit specifying if the signed summation resulted in an
7694    overflow.</p>
7695
7696 <h5>Examples:</h5>
7697 <pre>
7698   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7699   %sum = extractvalue {i32, i1} %res, 0
7700   %obit = extractvalue {i32, i1} %res, 1
7701   br i1 %obit, label %overflow, label %normal
7702 </pre>
7703
7704 </div>
7705
7706 <!-- _______________________________________________________________________ -->
7707 <h4>
7708   <a name="int_uadd_overflow">
7709     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7710   </a>
7711 </h4>
7712
7713 <div>
7714
7715 <h5>Syntax:</h5>
7716 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7717    on any integer bit width.</p>
7718
7719 <pre>
7720   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7721   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7722   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7723 </pre>
7724
7725 <h5>Overview:</h5>
7726 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7727    an unsigned addition of the two arguments, and indicate whether a carry
7728    occurred during the unsigned summation.</p>
7729
7730 <h5>Arguments:</h5>
7731 <p>The arguments (%a and %b) and the first element of the result structure may
7732    be of integer types of any bit width, but they must have the same bit
7733    width. The second element of the result structure must be of
7734    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7735    undergo unsigned addition.</p>
7736
7737 <h5>Semantics:</h5>
7738 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7739    an unsigned addition of the two arguments. They return a structure &mdash;
7740    the first element of which is the sum, and the second element of which is a
7741    bit specifying if the unsigned summation resulted in a carry.</p>
7742
7743 <h5>Examples:</h5>
7744 <pre>
7745   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7746   %sum = extractvalue {i32, i1} %res, 0
7747   %obit = extractvalue {i32, i1} %res, 1
7748   br i1 %obit, label %carry, label %normal
7749 </pre>
7750
7751 </div>
7752
7753 <!-- _______________________________________________________________________ -->
7754 <h4>
7755   <a name="int_ssub_overflow">
7756     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7757   </a>
7758 </h4>
7759
7760 <div>
7761
7762 <h5>Syntax:</h5>
7763 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7764    on any integer bit width.</p>
7765
7766 <pre>
7767   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7768   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7769   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7770 </pre>
7771
7772 <h5>Overview:</h5>
7773 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7774    a signed subtraction of the two arguments, and indicate whether an overflow
7775    occurred during the signed subtraction.</p>
7776
7777 <h5>Arguments:</h5>
7778 <p>The arguments (%a and %b) and the first element of the result structure may
7779    be of integer types of any bit width, but they must have the same bit
7780    width. The second element of the result structure must be of
7781    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7782    undergo signed subtraction.</p>
7783
7784 <h5>Semantics:</h5>
7785 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7786    a signed subtraction of the two arguments. They return a structure &mdash;
7787    the first element of which is the subtraction, and the second element of
7788    which is a bit specifying if the signed subtraction resulted in an
7789    overflow.</p>
7790
7791 <h5>Examples:</h5>
7792 <pre>
7793   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7794   %sum = extractvalue {i32, i1} %res, 0
7795   %obit = extractvalue {i32, i1} %res, 1
7796   br i1 %obit, label %overflow, label %normal
7797 </pre>
7798
7799 </div>
7800
7801 <!-- _______________________________________________________________________ -->
7802 <h4>
7803   <a name="int_usub_overflow">
7804     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7805   </a>
7806 </h4>
7807
7808 <div>
7809
7810 <h5>Syntax:</h5>
7811 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7812    on any integer bit width.</p>
7813
7814 <pre>
7815   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7816   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7817   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7818 </pre>
7819
7820 <h5>Overview:</h5>
7821 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7822    an unsigned subtraction of the two arguments, and indicate whether an
7823    overflow occurred during the unsigned subtraction.</p>
7824
7825 <h5>Arguments:</h5>
7826 <p>The arguments (%a and %b) and the first element of the result structure may
7827    be of integer types of any bit width, but they must have the same bit
7828    width. The second element of the result structure must be of
7829    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7830    undergo unsigned subtraction.</p>
7831
7832 <h5>Semantics:</h5>
7833 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7834    an unsigned subtraction of the two arguments. They return a structure &mdash;
7835    the first element of which is the subtraction, and the second element of
7836    which is a bit specifying if the unsigned subtraction resulted in an
7837    overflow.</p>
7838
7839 <h5>Examples:</h5>
7840 <pre>
7841   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7842   %sum = extractvalue {i32, i1} %res, 0
7843   %obit = extractvalue {i32, i1} %res, 1
7844   br i1 %obit, label %overflow, label %normal
7845 </pre>
7846
7847 </div>
7848
7849 <!-- _______________________________________________________________________ -->
7850 <h4>
7851   <a name="int_smul_overflow">
7852     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7853   </a>
7854 </h4>
7855
7856 <div>
7857
7858 <h5>Syntax:</h5>
7859 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7860    on any integer bit width.</p>
7861
7862 <pre>
7863   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7864   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7865   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7866 </pre>
7867
7868 <h5>Overview:</h5>
7869
7870 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7871    a signed multiplication of the two arguments, and indicate whether an
7872    overflow occurred during the signed multiplication.</p>
7873
7874 <h5>Arguments:</h5>
7875 <p>The arguments (%a and %b) and the first element of the result structure may
7876    be of integer types of any bit width, but they must have the same bit
7877    width. The second element of the result structure must be of
7878    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7879    undergo signed multiplication.</p>
7880
7881 <h5>Semantics:</h5>
7882 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7883    a signed multiplication of the two arguments. They return a structure &mdash;
7884    the first element of which is the multiplication, and the second element of
7885    which is a bit specifying if the signed multiplication resulted in an
7886    overflow.</p>
7887
7888 <h5>Examples:</h5>
7889 <pre>
7890   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7891   %sum = extractvalue {i32, i1} %res, 0
7892   %obit = extractvalue {i32, i1} %res, 1
7893   br i1 %obit, label %overflow, label %normal
7894 </pre>
7895
7896 </div>
7897
7898 <!-- _______________________________________________________________________ -->
7899 <h4>
7900   <a name="int_umul_overflow">
7901     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7902   </a>
7903 </h4>
7904
7905 <div>
7906
7907 <h5>Syntax:</h5>
7908 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7909    on any integer bit width.</p>
7910
7911 <pre>
7912   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7913   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7914   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7915 </pre>
7916
7917 <h5>Overview:</h5>
7918 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7919    a unsigned multiplication of the two arguments, and indicate whether an
7920    overflow occurred during the unsigned multiplication.</p>
7921
7922 <h5>Arguments:</h5>
7923 <p>The arguments (%a and %b) and the first element of the result structure may
7924    be of integer types of any bit width, but they must have the same bit
7925    width. The second element of the result structure must be of
7926    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7927    undergo unsigned multiplication.</p>
7928
7929 <h5>Semantics:</h5>
7930 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7931    an unsigned multiplication of the two arguments. They return a structure
7932    &mdash; the first element of which is the multiplication, and the second
7933    element of which is a bit specifying if the unsigned multiplication resulted
7934    in an overflow.</p>
7935
7936 <h5>Examples:</h5>
7937 <pre>
7938   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7939   %sum = extractvalue {i32, i1} %res, 0
7940   %obit = extractvalue {i32, i1} %res, 1
7941   br i1 %obit, label %overflow, label %normal
7942 </pre>
7943
7944 </div>
7945
7946 </div>
7947
7948 <!-- ======================================================================= -->
7949 <h3>
7950   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
7951 </h3>
7952
7953 <div>
7954
7955 <p>For most target platforms, half precision floating point is a storage-only
7956    format. This means that it is
7957    a dense encoding (in memory) but does not support computation in the
7958    format.</p>
7959
7960 <p>This means that code must first load the half-precision floating point
7961    value as an i16, then convert it to float with <a
7962    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
7963    Computation can then be performed on the float value (including extending to
7964    double etc).  To store the value back to memory, it is first converted to
7965    float if needed, then converted to i16 with
7966    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
7967    storing as an i16 value.</p>
7968
7969 <!-- _______________________________________________________________________ -->
7970 <h4>
7971   <a name="int_convert_to_fp16">
7972     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
7973   </a>
7974 </h4>
7975
7976 <div>
7977
7978 <h5>Syntax:</h5>
7979 <pre>
7980   declare i16 @llvm.convert.to.fp16(f32 %a)
7981 </pre>
7982
7983 <h5>Overview:</h5>
7984 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7985    a conversion from single precision floating point format to half precision
7986    floating point format.</p>
7987
7988 <h5>Arguments:</h5>
7989 <p>The intrinsic function contains single argument - the value to be
7990    converted.</p>
7991
7992 <h5>Semantics:</h5>
7993 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
7994    a conversion from single precision floating point format to half precision
7995    floating point format. The return value is an <tt>i16</tt> which
7996    contains the converted number.</p>
7997
7998 <h5>Examples:</h5>
7999 <pre>
8000   %res = call i16 @llvm.convert.to.fp16(f32 %a)
8001   store i16 %res, i16* @x, align 2
8002 </pre>
8003
8004 </div>
8005
8006 <!-- _______________________________________________________________________ -->
8007 <h4>
8008   <a name="int_convert_from_fp16">
8009     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
8010   </a>
8011 </h4>
8012
8013 <div>
8014
8015 <h5>Syntax:</h5>
8016 <pre>
8017   declare f32 @llvm.convert.from.fp16(i16 %a)
8018 </pre>
8019
8020 <h5>Overview:</h5>
8021 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
8022    a conversion from half precision floating point format to single precision
8023    floating point format.</p>
8024
8025 <h5>Arguments:</h5>
8026 <p>The intrinsic function contains single argument - the value to be
8027    converted.</p>
8028
8029 <h5>Semantics:</h5>
8030 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
8031    conversion from half single precision floating point format to single
8032    precision floating point format. The input half-float value is represented by
8033    an <tt>i16</tt> value.</p>
8034
8035 <h5>Examples:</h5>
8036 <pre>
8037   %a = load i16* @x, align 2
8038   %res = call f32 @llvm.convert.from.fp16(i16 %a)
8039 </pre>
8040
8041 </div>
8042
8043 </div>
8044
8045 <!-- ======================================================================= -->
8046 <h3>
8047   <a name="int_debugger">Debugger Intrinsics</a>
8048 </h3>
8049
8050 <div>
8051
8052 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
8053    prefix), are described in
8054    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
8055    Level Debugging</a> document.</p>
8056
8057 </div>
8058
8059 <!-- ======================================================================= -->
8060 <h3>
8061   <a name="int_eh">Exception Handling Intrinsics</a>
8062 </h3>
8063
8064 <div>
8065
8066 <p>The LLVM exception handling intrinsics (which all start with
8067    <tt>llvm.eh.</tt> prefix), are described in
8068    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
8069    Handling</a> document.</p>
8070
8071 </div>
8072
8073 <!-- ======================================================================= -->
8074 <h3>
8075   <a name="int_trampoline">Trampoline Intrinsics</a>
8076 </h3>
8077
8078 <div>
8079
8080 <p>These intrinsics make it possible to excise one parameter, marked with
8081    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
8082    The result is a callable
8083    function pointer lacking the nest parameter - the caller does not need to
8084    provide a value for it.  Instead, the value to use is stored in advance in a
8085    "trampoline", a block of memory usually allocated on the stack, which also
8086    contains code to splice the nest value into the argument list.  This is used
8087    to implement the GCC nested function address extension.</p>
8088
8089 <p>For example, if the function is
8090    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
8091    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
8092    follows:</p>
8093
8094 <pre class="doc_code">
8095   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
8096   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
8097   call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8*, i32, i32)* @f to i8*), i8* %nval)
8098   %p = call i8* @llvm.adjust.trampoline(i8* %tramp1)
8099   %fp = bitcast i8* %p to i32 (i32, i32)*
8100 </pre>
8101
8102 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
8103    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
8104
8105 <!-- _______________________________________________________________________ -->
8106 <h4>
8107   <a name="int_it">
8108     '<tt>llvm.init.trampoline</tt>' Intrinsic
8109   </a>
8110 </h4>
8111
8112 <div>
8113
8114 <h5>Syntax:</h5>
8115 <pre>
8116   declare void @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
8117 </pre>
8118
8119 <h5>Overview:</h5>
8120 <p>This fills the memory pointed to by <tt>tramp</tt> with executable code,
8121    turning it into a trampoline.</p>
8122
8123 <h5>Arguments:</h5>
8124 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
8125    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
8126    sufficiently aligned block of memory; this memory is written to by the
8127    intrinsic.  Note that the size and the alignment are target-specific - LLVM
8128    currently provides no portable way of determining them, so a front-end that
8129    generates this intrinsic needs to have some target-specific knowledge.
8130    The <tt>func</tt> argument must hold a function bitcast to
8131    an <tt>i8*</tt>.</p>
8132
8133 <h5>Semantics:</h5>
8134 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
8135    dependent code, turning it into a function.  Then <tt>tramp</tt> needs to be
8136    passed to <a href="#int_at">llvm.adjust.trampoline</a> to get a pointer
8137    which can be <a href="#int_trampoline">bitcast (to a new function) and
8138    called</a>.  The new function's signature is the same as that of
8139    <tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
8140    removed.  At most one such <tt>nest</tt> argument is allowed, and it must be of
8141    pointer type.  Calling the new function is equivalent to calling <tt>func</tt>
8142    with the same argument list, but with <tt>nval</tt> used for the missing
8143    <tt>nest</tt> argument.  If, after calling <tt>llvm.init.trampoline</tt>, the
8144    memory pointed to by <tt>tramp</tt> is modified, then the effect of any later call
8145    to the returned function pointer is undefined.</p>
8146 </div>
8147
8148 <!-- _______________________________________________________________________ -->
8149 <h4>
8150   <a name="int_at">
8151     '<tt>llvm.adjust.trampoline</tt>' Intrinsic
8152   </a>
8153 </h4>
8154
8155 <div>
8156
8157 <h5>Syntax:</h5>
8158 <pre>
8159   declare i8* @llvm.adjust.trampoline(i8* &lt;tramp&gt;)
8160 </pre>
8161
8162 <h5>Overview:</h5>
8163 <p>This performs any required machine-specific adjustment to the address of a
8164    trampoline (passed as <tt>tramp</tt>).</p>
8165
8166 <h5>Arguments:</h5>
8167 <p><tt>tramp</tt> must point to a block of memory which already has trampoline code
8168    filled in by a previous call to <a href="#int_it"><tt>llvm.init.trampoline</tt>
8169    </a>.</p>
8170
8171 <h5>Semantics:</h5>
8172 <p>On some architectures the address of the code to be executed needs to be
8173    different to the address where the trampoline is actually stored.  This
8174    intrinsic returns the executable address corresponding to <tt>tramp</tt>
8175    after performing the required machine specific adjustments.
8176    The pointer returned can then be <a href="#int_trampoline"> bitcast and
8177    executed</a>.
8178 </p>
8179
8180 </div>
8181
8182 </div>
8183
8184 <!-- ======================================================================= -->
8185 <h3>
8186   <a name="int_memorymarkers">Memory Use Markers</a>
8187 </h3>
8188
8189 <div>
8190
8191 <p>This class of intrinsics exists to information about the lifetime of memory
8192    objects and ranges where variables are immutable.</p>
8193
8194 <!-- _______________________________________________________________________ -->
8195 <h4>
8196   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
8197 </h4>
8198
8199 <div>
8200
8201 <h5>Syntax:</h5>
8202 <pre>
8203   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8204 </pre>
8205
8206 <h5>Overview:</h5>
8207 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
8208    object's lifetime.</p>
8209
8210 <h5>Arguments:</h5>
8211 <p>The first argument is a constant integer representing the size of the
8212    object, or -1 if it is variable sized.  The second argument is a pointer to
8213    the object.</p>
8214
8215 <h5>Semantics:</h5>
8216 <p>This intrinsic indicates that before this point in the code, the value of the
8217    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8218    never be used and has an undefined value.  A load from the pointer that
8219    precedes this intrinsic can be replaced with
8220    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
8221
8222 </div>
8223
8224 <!-- _______________________________________________________________________ -->
8225 <h4>
8226   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
8227 </h4>
8228
8229 <div>
8230
8231 <h5>Syntax:</h5>
8232 <pre>
8233   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8234 </pre>
8235
8236 <h5>Overview:</h5>
8237 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
8238    object's lifetime.</p>
8239
8240 <h5>Arguments:</h5>
8241 <p>The first argument is a constant integer representing the size of the
8242    object, or -1 if it is variable sized.  The second argument is a pointer to
8243    the object.</p>
8244
8245 <h5>Semantics:</h5>
8246 <p>This intrinsic indicates that after this point in the code, the value of the
8247    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8248    never be used and has an undefined value.  Any stores into the memory object
8249    following this intrinsic may be removed as dead.
8250
8251 </div>
8252
8253 <!-- _______________________________________________________________________ -->
8254 <h4>
8255   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
8256 </h4>
8257
8258 <div>
8259
8260 <h5>Syntax:</h5>
8261 <pre>
8262   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8263 </pre>
8264
8265 <h5>Overview:</h5>
8266 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
8267    a memory object will not change.</p>
8268
8269 <h5>Arguments:</h5>
8270 <p>The first argument is a constant integer representing the size of the
8271    object, or -1 if it is variable sized.  The second argument is a pointer to
8272    the object.</p>
8273
8274 <h5>Semantics:</h5>
8275 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8276    the return value, the referenced memory location is constant and
8277    unchanging.</p>
8278
8279 </div>
8280
8281 <!-- _______________________________________________________________________ -->
8282 <h4>
8283   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8284 </h4>
8285
8286 <div>
8287
8288 <h5>Syntax:</h5>
8289 <pre>
8290   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8291 </pre>
8292
8293 <h5>Overview:</h5>
8294 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8295    a memory object are mutable.</p>
8296
8297 <h5>Arguments:</h5>
8298 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8299    The second argument is a constant integer representing the size of the
8300    object, or -1 if it is variable sized and the third argument is a pointer
8301    to the object.</p>
8302
8303 <h5>Semantics:</h5>
8304 <p>This intrinsic indicates that the memory is mutable again.</p>
8305
8306 </div>
8307
8308 </div>
8309
8310 <!-- ======================================================================= -->
8311 <h3>
8312   <a name="int_general">General Intrinsics</a>
8313 </h3>
8314
8315 <div>
8316
8317 <p>This class of intrinsics is designed to be generic and has no specific
8318    purpose.</p>
8319
8320 <!-- _______________________________________________________________________ -->
8321 <h4>
8322   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8323 </h4>
8324
8325 <div>
8326
8327 <h5>Syntax:</h5>
8328 <pre>
8329   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8330 </pre>
8331
8332 <h5>Overview:</h5>
8333 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8334
8335 <h5>Arguments:</h5>
8336 <p>The first argument is a pointer to a value, the second is a pointer to a
8337    global string, the third is a pointer to a global string which is the source
8338    file name, and the last argument is the line number.</p>
8339
8340 <h5>Semantics:</h5>
8341 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8342    This can be useful for special purpose optimizations that want to look for
8343    these annotations.  These have no other defined use; they are ignored by code
8344    generation and optimization.</p>
8345
8346 </div>
8347
8348 <!-- _______________________________________________________________________ -->
8349 <h4>
8350   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8351 </h4>
8352
8353 <div>
8354
8355 <h5>Syntax:</h5>
8356 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8357    any integer bit width.</p>
8358
8359 <pre>
8360   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8361   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8362   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8363   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8364   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8365 </pre>
8366
8367 <h5>Overview:</h5>
8368 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8369
8370 <h5>Arguments:</h5>
8371 <p>The first argument is an integer value (result of some expression), the
8372    second is a pointer to a global string, the third is a pointer to a global
8373    string which is the source file name, and the last argument is the line
8374    number.  It returns the value of the first argument.</p>
8375
8376 <h5>Semantics:</h5>
8377 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8378    arbitrary strings.  This can be useful for special purpose optimizations that
8379    want to look for these annotations.  These have no other defined use; they
8380    are ignored by code generation and optimization.</p>
8381
8382 </div>
8383
8384 <!-- _______________________________________________________________________ -->
8385 <h4>
8386   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8387 </h4>
8388
8389 <div>
8390
8391 <h5>Syntax:</h5>
8392 <pre>
8393   declare void @llvm.trap() noreturn nounwind
8394 </pre>
8395
8396 <h5>Overview:</h5>
8397 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8398
8399 <h5>Arguments:</h5>
8400 <p>None.</p>
8401
8402 <h5>Semantics:</h5>
8403 <p>This intrinsic is lowered to the target dependent trap instruction. If the
8404    target does not have a trap instruction, this intrinsic will be lowered to
8405    a call of the <tt>abort()</tt> function.</p>
8406
8407 </div>
8408
8409 <!-- _______________________________________________________________________ -->
8410 <h4>
8411   <a name="int_debugtrap">'<tt>llvm.debugtrap</tt>' Intrinsic</a>
8412 </h4>
8413
8414 <div>
8415
8416 <h5>Syntax:</h5>
8417 <pre>
8418   declare void @llvm.debugtrap() nounwind
8419 </pre>
8420
8421 <h5>Overview:</h5>
8422 <p>The '<tt>llvm.debugtrap</tt>' intrinsic.</p>
8423
8424 <h5>Arguments:</h5>
8425 <p>None.</p>
8426
8427 <h5>Semantics:</h5>
8428 <p>This intrinsic is lowered to code which is intended to cause an execution
8429    trap with the intention of requesting the attention of a debugger.</p>
8430
8431 </div>
8432
8433 <!-- _______________________________________________________________________ -->
8434 <h4>
8435   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8436 </h4>
8437
8438 <div>
8439
8440 <h5>Syntax:</h5>
8441 <pre>
8442   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8443 </pre>
8444
8445 <h5>Overview:</h5>
8446 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8447    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8448    ensure that it is placed on the stack before local variables.</p>
8449
8450 <h5>Arguments:</h5>
8451 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8452    arguments. The first argument is the value loaded from the stack
8453    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8454    that has enough space to hold the value of the guard.</p>
8455
8456 <h5>Semantics:</h5>
8457 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8458    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8459    stack. This is to ensure that if a local variable on the stack is
8460    overwritten, it will destroy the value of the guard. When the function exits,
8461    the guard on the stack is checked against the original guard. If they are
8462    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8463    function.</p>
8464
8465 </div>
8466
8467 <!-- _______________________________________________________________________ -->
8468 <h4>
8469   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8470 </h4>
8471
8472 <div>
8473
8474 <h5>Syntax:</h5>
8475 <pre>
8476   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;min&gt;)
8477   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;min&gt;)
8478 </pre>
8479
8480 <h5>Overview:</h5>
8481 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8482    the optimizers to determine at compile time whether a) an operation (like
8483    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8484    runtime check for overflow isn't necessary. An object in this context means
8485    an allocation of a specific class, structure, array, or other object.</p>
8486
8487 <h5>Arguments:</h5>
8488 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8489    argument is a pointer to or into the <tt>object</tt>. The second argument
8490    is a boolean and determines whether <tt>llvm.objectsize</tt> returns 0 (if
8491    true) or -1 (if false) when the object size is unknown.
8492    The second argument only accepts constants.</p>
8493
8494 <h5>Semantics:</h5>
8495 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to a constant representing
8496    the size of the object concerned. If the size cannot be determined at compile
8497    time, <tt>llvm.objectsize</tt> returns <tt>i32/i64 -1 or 0</tt>
8498    (depending on the <tt>min</tt> argument).</p>
8499
8500 </div>
8501 <!-- _______________________________________________________________________ -->
8502 <h4>
8503   <a name="int_expect">'<tt>llvm.expect</tt>' Intrinsic</a>
8504 </h4>
8505
8506 <div>
8507
8508 <h5>Syntax:</h5>
8509 <pre>
8510   declare i32 @llvm.expect.i32(i32 &lt;val&gt;, i32 &lt;expected_val&gt;)
8511   declare i64 @llvm.expect.i64(i64 &lt;val&gt;, i64 &lt;expected_val&gt;)
8512 </pre>
8513
8514 <h5>Overview:</h5>
8515 <p>The <tt>llvm.expect</tt> intrinsic provides information about expected (the
8516    most probable) value of <tt>val</tt>, which can be used by optimizers.</p>
8517
8518 <h5>Arguments:</h5>
8519 <p>The <tt>llvm.expect</tt> intrinsic takes two arguments. The first
8520    argument is a value. The second argument is an expected value, this needs to
8521    be a constant value, variables are not allowed.</p>
8522
8523 <h5>Semantics:</h5>
8524 <p>This intrinsic is lowered to the <tt>val</tt>.</p>
8525 </div>
8526
8527 </div>
8528
8529 </div>
8530 <!-- *********************************************************************** -->
8531 <hr>
8532 <address>
8533   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8534   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8535   <a href="http://validator.w3.org/check/referer"><img
8536   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8537
8538   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8539   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8540   Last modified: $Date$
8541 </address>
8542
8543 </body>
8544 </html>