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           <li><a href="#int_fabs">'<tt>llvm.fabs.*</tt>' Intrinsic</a></li>
 261         </ol>
 262       </li>
 263       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 264         <ol>
 265           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 266           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 267           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 268           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 269         </ol>
 270       </li>
 271       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 272         <ol>
 273           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 274           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 275           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 276           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 277           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 278           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 279         </ol>
 280       </li>
 281       <li><a href="#spec_arithmetic">Specialised Arithmetic Intrinsics</a>
 282         <ol>
 283           <li><a href="#fmuladd">'<tt>llvm.fmuladd</tt> Intrinsic</a></li>
 284         </ol>
 285       </li>
 286       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 287         <ol>
 288           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 289           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 290         </ol>
 291       </li>
 292       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 293       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 294       <li><a href="#int_trampoline">Trampoline Intrinsics</a>
 295         <ol>
 296           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 297           <li><a href="#int_at">'<tt>llvm.adjust.trampoline</tt>' Intrinsic</a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 301         <ol>
 302           <li><a href="#int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a></li>
 303           <li><a href="#int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a></li>
 304           <li><a href="#int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a></li>
 305           <li><a href="#int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a></li>
 306         </ol>
 307       </li>
 308       <li><a href="#int_general">General intrinsics</a>
 309         <ol>
 310           <li><a href="#int_var_annotation">
 311             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 312           <li><a href="#int_annotation">
 313             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 314           <li><a href="#int_trap">
 315             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 316           <li><a href="#int_debugtrap">
 317             '<tt>llvm.debugtrap</tt>' Intrinsic</a></li>
 318           <li><a href="#int_stackprotector">
 319             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 320           <li><a href="#int_objectsize">
 321             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 322           <li><a href="#int_expect">
 323             '<tt>llvm.expect</tt>' Intrinsic</a></li>
 324           <li><a href="#int_donothing">
 325             '<tt>llvm.donothing</tt>' Intrinsic</a></li>
 326         </ol>
 327       </li>
 328     </ol>
 329   </li>
 330 </ol>
 331
 332 <div class="doc_author">
 333   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 334             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 335 </div>
 336
 337 <!-- *********************************************************************** -->
 338 <h2><a name="abstract">Abstract</a></h2>
 339 <!-- *********************************************************************** -->
 340
 341 <div>
 342
 343 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 344    a Static Single Assignment (SSA) based representation that provides type
 345    safety, low-level operations, flexibility, and the capability of representing
 346    'all' high-level languages cleanly.  It is the common code representation
 347    used throughout all phases of the LLVM compilation strategy.</p>
 348
 349 </div>
 350
 351 <!-- *********************************************************************** -->
 352 <h2><a name="introduction">Introduction</a></h2>
 353 <!-- *********************************************************************** -->
 354
 355 <div>
 356
 357 <p>The LLVM code representation is designed to be used in three different forms:
 358    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 359    for fast loading by a Just-In-Time compiler), and as a human readable
 360    assembly language representation.  This allows LLVM to provide a powerful
 361    intermediate representation for efficient compiler transformations and
 362    analysis, while providing a natural means to debug and visualize the
 363    transformations.  The three different forms of LLVM are all equivalent.  This
 364    document describes the human readable representation and notation.</p>
 365
 366 <p>The LLVM representation aims to be light-weight and low-level while being
 367    expressive, typed, and extensible at the same time.  It aims to be a
 368    "universal IR" of sorts, by being at a low enough level that high-level ideas
 369    may be cleanly mapped to it (similar to how microprocessors are "universal
 370    IR's", allowing many source languages to be mapped to them).  By providing
 371    type information, LLVM can be used as the target of optimizations: for
 372    example, through pointer analysis, it can be proven that a C automatic
 373    variable is never accessed outside of the current function, allowing it to
 374    be promoted to a simple SSA value instead of a memory location.</p>
 375
 376 <!-- _______________________________________________________________________ -->
 377 <h4>
 378   <a name="wellformed">Well-Formedness</a>
 379 </h4>
 380
 381 <div>
 382
 383 <p>It is important to note that this document describes 'well formed' LLVM
 384    assembly language.  There is a difference between what the parser accepts and
 385    what is considered 'well formed'.  For example, the following instruction is
 386    syntactically okay, but not well formed:</p>
 387
 388 <pre class="doc_code">
 389 %x = <a href="#i_add">add</a> i32 1, %x
 390 </pre>
 391
 392 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 393    LLVM infrastructure provides a verification pass that may be used to verify
 394    that an LLVM module is well formed.  This pass is automatically run by the
 395    parser after parsing input assembly and by the optimizer before it outputs
 396    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 397    transformation passes or input to the parser.</p>
 398
 399 </div>
 400
 401 </div>
 402
 403 <!-- Describe the typesetting conventions here. -->
 404
 405 <!-- *********************************************************************** -->
 406 <h2><a name="identifiers">Identifiers</a></h2>
 407 <!-- *********************************************************************** -->
 408
 409 <div>
 410
 411 <p>LLVM identifiers come in two basic types: global and local. Global
 412    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 413    character. Local identifiers (register names, types) begin with
 414    the <tt>'%'</tt> character. Additionally, there are three different formats
 415    for identifiers, for different purposes:</p>
 416
 417 <ol>
 418   <li>Named values are represented as a string of characters with their prefix.
 419       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 420       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 421       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 422       other characters in their names can be surrounded with quotes. Special
 423       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 424       ASCII code for the character in hexadecimal.  In this way, any character
 425       can be used in a name value, even quotes themselves.</li>
 426
 427   <li>Unnamed values are represented as an unsigned numeric value with their
 428       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 429
 430   <li>Constants, which are described in a <a href="#constants">section about
 431       constants</a>, below.</li>
 432 </ol>
 433
 434 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 435    don't need to worry about name clashes with reserved words, and the set of
 436    reserved words may be expanded in the future without penalty.  Additionally,
 437    unnamed identifiers allow a compiler to quickly come up with a temporary
 438    variable without having to avoid symbol table conflicts.</p>
 439
 440 <p>Reserved words in LLVM are very similar to reserved words in other
 441    languages. There are keywords for different opcodes
 442    ('<tt><a href="#i_add">add</a></tt>',
 443    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 444    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 445    ('<tt><a href="#t_void">void</a></tt>',
 446    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 447    reserved words cannot conflict with variable names, because none of them
 448    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 449
 450 <p>Here is an example of LLVM code to multiply the integer variable
 451    '<tt>%X</tt>' by 8:</p>
 452
 453 <p>The easy way:</p>
 454
 455 <pre class="doc_code">
 456 %result = <a href="#i_mul">mul</a> i32 %X, 8
 457 </pre>
 458
 459 <p>After strength reduction:</p>
 460
 461 <pre class="doc_code">
 462 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 463 </pre>
 464
 465 <p>And the hard way:</p>
 466
 467 <pre class="doc_code">
 468 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 469 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 470 %result = <a href="#i_add">add</a> i32 %1, %1
 471 </pre>
 472
 473 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 474    lexical features of LLVM:</p>
 475
 476 <ol>
 477   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 478       line.</li>
 479
 480   <li>Unnamed temporaries are created when the result of a computation is not
 481       assigned to a named value.</li>
 482
 483   <li>Unnamed temporaries are numbered sequentially</li>
 484 </ol>
 485
 486 <p>It also shows a convention that we follow in this document.  When
 487    demonstrating instructions, we will follow an instruction with a comment that
 488    defines the type and name of value produced.  Comments are shown in italic
 489    text.</p>
 490
 491 </div>
 492
 493 <!-- *********************************************************************** -->
 494 <h2><a name="highlevel">High Level Structure</a></h2>
 495 <!-- *********************************************************************** -->
 496 <div>
 497 <!-- ======================================================================= -->
 498 <h3>
 499   <a name="modulestructure">Module Structure</a>
 500 </h3>
 501
 502 <div>
 503
 504 <p>LLVM programs are composed of <tt>Module</tt>s, each of which is a
 505    translation unit of the input programs.  Each module consists of functions,
 506    global variables, and symbol table entries.  Modules may be combined together
 507    with the LLVM linker, which merges function (and global variable)
 508    definitions, resolves forward declarations, and merges symbol table
 509    entries. Here is an example of the "hello world" module:</p>
 510
 511 <pre class="doc_code">
 512 <i>; Declare the string constant as a global constant.</i>&nbsp;
 513 <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;
 514
 515 <i>; External declaration of the puts function</i>&nbsp;
 516 <a href="#functionstructure">declare</a> i32 @puts(i8* <a href="#nocapture">nocapture</a>) <a href="#fnattrs">nounwind</a>&nbsp;
 517
 518 <i>; Definition of main function</i>
 519 define i32 @main() {   <i>; i32()* </i>&nbsp;
 520   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 521   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.str, i64 0, i64 0
 522
 523   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 524   <a href="#i_call">call</a> i32 @puts(i8* %cast210)
 525   <a href="#i_ret">ret</a> i32 0&nbsp;
 526 }
 527
 528 <i>; Named metadata</i>
 529 !1 = metadata !{i32 42}
 530 !foo = !{!1, null}
 531 </pre>
 532
 533 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 534    "<tt>.str</tt>", an external declaration of the "<tt>puts</tt>" function,
 535    a <a href="#functionstructure">function definition</a> for
 536    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 537    "<tt>foo</tt>".</p>
 538
 539 <p>In general, a module is made up of a list of global values (where both
 540    functions and global variables are global values). Global values are
 541    represented by a pointer to a memory location (in this case, a pointer to an
 542    array of char, and a pointer to a function), and have one of the
 543    following <a href="#linkage">linkage types</a>.</p>
 544
 545 </div>
 546
 547 <!-- ======================================================================= -->
 548 <h3>
 549   <a name="linkage">Linkage Types</a>
 550 </h3>
 551
 552 <div>
 553
 554 <p>All Global Variables and Functions have one of the following types of
 555    linkage:</p>
 556
 557 <dl>
 558   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 559   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 560       by objects in the current module. In particular, linking code into a
 561       module with an private global value may cause the private to be renamed as
 562       necessary to avoid collisions.  Because the symbol is private to the
 563       module, all references can be updated. This doesn't show up in any symbol
 564       table in the object file.</dd>
 565
 566   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 567   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 568       assembler and evaluated by the linker. Unlike normal strong symbols, they
 569       are removed by the linker from the final linked image (executable or
 570       dynamic library).</dd>
 571
 572   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 573   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 574       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 575       linker. The symbols are removed by the linker from the final linked image
 576       (executable or dynamic library).</dd>
 577
 578   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 579   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 580       of the object is not taken. For instance, functions that had an inline
 581       definition, but the compiler decided not to inline it. Note,
 582       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 583       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 584       visibility.  The symbols are removed by the linker from the final linked
 585       image (executable or dynamic library).</dd>
 586
 587   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 588   <dd>Similar to private, but the value shows as a local symbol
 589       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 590       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 591
 592   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 593   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 594       into the object file corresponding to the LLVM module.  They exist to
 595       allow inlining and other optimizations to take place given knowledge of
 596       the definition of the global, which is known to be somewhere outside the
 597       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 598       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 599       This linkage type is only allowed on definitions, not declarations.</dd>
 600
 601   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 602   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 603       the same name when linkage occurs.  This can be used to implement
 604       some forms of inline functions, templates, or other code which must be
 605       generated in each translation unit that uses it, but where the body may
 606       be overridden with a more definitive definition later.  Unreferenced
 607       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 608       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 609       inline the body of this function into callers because it doesn't know if
 610       this definition of the function is the definitive definition within the
 611       program or whether it will be overridden by a stronger definition.
 612       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 613       linkage.</dd>
 614
 615   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 616   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 617       <tt>linkonce</tt> linkage, except that unreferenced globals with
 618       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 619       are declared "weak" in C source code.</dd>
 620
 621   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 622   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 623       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 624       global scope.
 625       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 626       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 627       <tt>common</tt> symbols may not have an explicit section,
 628       must have a zero initializer, and may not be marked '<a
 629       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 630       have common linkage.</dd>
 631
 632
 633   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 634   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 635       pointer to array type.  When two global variables with appending linkage
 636       are linked together, the two global arrays are appended together.  This is
 637       the LLVM, typesafe, equivalent of having the system linker append together
 638       "sections" with identical names when .o files are linked.</dd>
 639
 640   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 641   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 642       is weak until linked, if not linked, the symbol becomes null instead of
 643       being an undefined reference.</dd>
 644
 645   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 646   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 647   <dd>Some languages allow differing globals to be merged, such as two functions
 648       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 649       that only equivalent globals are ever merged (the "one definition rule"
 650       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 651       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 652       be merged with equivalent globals.  These linkage types are otherwise the
 653       same as their non-<tt>odr</tt> versions.</dd>
 654
 655   <dt><tt><b><a name="linkage_external">external</a></b></tt></dt>
 656   <dd>If none of the above identifiers are used, the global is externally
 657       visible, meaning that it participates in linkage and can be used to
 658       resolve external symbol references.</dd>
 659 </dl>
 660
 661 <p>The next two types of linkage are targeted for Microsoft Windows platform
 662    only. They are designed to support importing (exporting) symbols from (to)
 663    DLLs (Dynamic Link Libraries).</p>
 664
 665 <dl>
 666   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 667   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 668       or variable via a global pointer to a pointer that is set up by the DLL
 669       exporting the symbol. On Microsoft Windows targets, the pointer name is
 670       formed by combining <code>__imp_</code> and the function or variable
 671       name.</dd>
 672
 673   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 674   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 675       pointer to a pointer in a DLL, so that it can be referenced with the
 676       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 677       name is formed by combining <code>__imp_</code> and the function or
 678       variable name.</dd>
 679 </dl>
 680
 681 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 682    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 683    one, one of the two would be renamed, preventing a collision.  Since
 684    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 685    declarations), they are accessible outside of the current module.</p>
 686
 687 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 688    other than <tt>external</tt>, <tt>dllimport</tt>
 689   or <tt>extern_weak</tt>.</p>
 690
 691 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 692    or <tt>weak_odr</tt> linkages.</p>
 693
 694 </div>
 695
 696 <!-- ======================================================================= -->
 697 <h3>
 698   <a name="callingconv">Calling Conventions</a>
 699 </h3>
 700
 701 <div>
 702
 703 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 704    and <a href="#i_invoke">invokes</a> can all have an optional calling
 705    convention specified for the call.  The calling convention of any pair of
 706    dynamic caller/callee must match, or the behavior of the program is
 707    undefined.  The following calling conventions are supported by LLVM, and more
 708    may be added in the future:</p>
 709
 710 <dl>
 711   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 712   <dd>This calling convention (the default if no other calling convention is
 713       specified) matches the target C calling conventions.  This calling
 714       convention supports varargs function calls and tolerates some mismatch in
 715       the declared prototype and implemented declaration of the function (as
 716       does normal C).</dd>
 717
 718   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 719   <dd>This calling convention attempts to make calls as fast as possible
 720       (e.g. by passing things in registers).  This calling convention allows the
 721       target to use whatever tricks it wants to produce fast code for the
 722       target, without having to conform to an externally specified ABI
 723       (Application Binary Interface).
 724       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 725       when this or the GHC convention is used.</a>  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>coldcc</tt>" - The cold calling convention</b>:</dt>
 730   <dd>This calling convention attempts to make code in the caller as efficient
 731       as possible under the assumption that the call is not commonly executed.
 732       As such, these calls often preserve all registers so that the call does
 733       not break any live ranges in the caller side.  This calling convention
 734       does not support varargs and requires the prototype of all callees to
 735       exactly match the prototype of the function definition.</dd>
 736
 737   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 738   <dd>This calling convention has been implemented specifically for use by the
 739       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 740       It passes everything in registers, going to extremes to achieve this by
 741       disabling callee save registers. This calling convention should not be
 742       used lightly but only for specific situations such as an alternative to
 743       the <em>register pinning</em> performance technique often used when
 744       implementing functional programming languages.At the moment only X86
 745       supports this convention and it has the following limitations:
 746       <ul>
 747         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 748             floating point types are supported.</li>
 749         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 750             6 floating point parameters.</li>
 751       </ul>
 752       This calling convention supports
 753       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 754       requires both the caller and callee are using it.
 755   </dd>
 756
 757   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 758   <dd>Any calling convention may be specified by number, allowing
 759       target-specific calling conventions to be used.  Target specific calling
 760       conventions start at 64.</dd>
 761 </dl>
 762
 763 <p>More calling conventions can be added/defined on an as-needed basis, to
 764    support Pascal conventions or any other well-known target-independent
 765    convention.</p>
 766
 767 </div>
 768
 769 <!-- ======================================================================= -->
 770 <h3>
 771   <a name="visibility">Visibility Styles</a>
 772 </h3>
 773
 774 <div>
 775
 776 <p>All Global Variables and Functions have one of the following visibility
 777    styles:</p>
 778
 779 <dl>
 780   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 781   <dd>On targets that use the ELF object file format, default visibility means
 782       that the declaration is visible to other modules and, in shared libraries,
 783       means that the declared entity may be overridden. On Darwin, default
 784       visibility means that the declaration is visible to other modules. Default
 785       visibility corresponds to "external linkage" in the language.</dd>
 786
 787   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 788   <dd>Two declarations of an object with hidden visibility refer to the same
 789       object if they are in the same shared object. Usually, hidden visibility
 790       indicates that the symbol will not be placed into the dynamic symbol
 791       table, so no other module (executable or shared library) can reference it
 792       directly.</dd>
 793
 794   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 795   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 796       the dynamic symbol table, but that references within the defining module
 797       will bind to the local symbol. That is, the symbol cannot be overridden by
 798       another module.</dd>
 799 </dl>
 800
 801 </div>
 802
 803 <!-- ======================================================================= -->
 804 <h3>
 805   <a name="namedtypes">Named Types</a>
 806 </h3>
 807
 808 <div>
 809
 810 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 811    it easier to read the IR and make the IR more condensed (particularly when
 812    recursive types are involved).  An example of a name specification is:</p>
 813
 814 <pre class="doc_code">
 815 %mytype = type { %mytype*, i32 }
 816 </pre>
 817
 818 <p>You may give a name to any <a href="#typesystem">type</a> except
 819    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 820    is expected with the syntax "%mytype".</p>
 821
 822 <p>Note that type names are aliases for the structural type that they indicate,
 823    and that you can therefore specify multiple names for the same type.  This
 824    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 825    uses structural typing, the name is not part of the type.  When printing out
 826    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 827    particular shape.  This means that if you have code where two different
 828    source types end up having the same LLVM type, that the dumper will sometimes
 829    print the "wrong" or unexpected type.  This is an important design point and
 830    isn't going to change.</p>
 831
 832 </div>
 833
 834 <!-- ======================================================================= -->
 835 <h3>
 836   <a name="globalvars">Global Variables</a>
 837 </h3>
 838
 839 <div>
 840
 841 <p>Global variables define regions of memory allocated at compilation time
 842    instead of run-time.  Global variables may optionally be initialized, may
 843    have an explicit section to be placed in, and may have an optional explicit
 844    alignment specified.</p>
 845
 846 <p>A variable may be defined as <tt>thread_local</tt>, which
 847    means that it will not be shared by threads (each thread will have a
 848    separated copy of the variable).  Not all targets support thread-local
 849    variables.  Optionally, a TLS model may be specified:</p>
 850
 851 <dl>
 852   <dt><b><tt>localdynamic</tt></b>:</dt>
 853   <dd>For variables that are only used within the current shared library.</dd>
 854
 855   <dt><b><tt>initialexec</tt></b>:</dt>
 856   <dd>For variables in modules that will not be loaded dynamically.</dd>
 857
 858   <dt><b><tt>localexec</tt></b>:</dt>
 859   <dd>For variables defined in the executable and only used within it.</dd>
 860 </dl>
 861
 862 <p>The models correspond to the ELF TLS models; see
 863    <a href="http://people.redhat.com/drepper/tls.pdf">ELF
 864    Handling For Thread-Local Storage</a> for more information on under which
 865    circumstances the different models may be used.  The target may choose a
 866    different TLS model if the specified model is not supported, or if a better
 867    choice of model can be made.</p>
 868
 869 <p>A variable may be defined as a global
 870    "constant," which indicates that the contents of the variable
 871    will <b>never</b> be modified (enabling better optimization, allowing the
 872    global data to be placed in the read-only section of an executable, etc).
 873    Note that variables that need runtime initialization cannot be marked
 874    "constant" as there is a store to the variable.</p>
 875
 876 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 877    constant, even if the final definition of the global is not.  This capability
 878    can be used to enable slightly better optimization of the program, but
 879    requires the language definition to guarantee that optimizations based on the
 880    'constantness' are valid for the translation units that do not include the
 881    definition.</p>
 882
 883 <p>As SSA values, global variables define pointer values that are in scope
 884    (i.e. they dominate) all basic blocks in the program.  Global variables
 885    always define a pointer to their "content" type because they describe a
 886    region of memory, and all memory objects in LLVM are accessed through
 887    pointers.</p>
 888
 889 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 890   that the address is not significant, only the content. Constants marked
 891   like this can be merged with other constants if they have the same
 892   initializer. Note that a constant with significant address <em>can</em>
 893   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 894   constant whose address is significant.</p>
 895
 896 <p>A global variable may be declared to reside in a target-specific numbered
 897    address space. For targets that support them, address spaces may affect how
 898    optimizations are performed and/or what target instructions are used to
 899    access the variable. The default address space is zero. The address space
 900    qualifier must precede any other attributes.</p>
 901
 902 <p>LLVM allows an explicit section to be specified for globals.  If the target
 903    supports it, it will emit globals to the section specified.</p>
 904
 905 <p>An explicit alignment may be specified for a global, which must be a power
 906    of 2.  If not present, or if the alignment is set to zero, the alignment of
 907    the global is set by the target to whatever it feels convenient.  If an
 908    explicit alignment is specified, the global is forced to have exactly that
 909    alignment.  Targets and optimizers are not allowed to over-align the global
 910    if the global has an assigned section.  In this case, the extra alignment
 911    could be observable: for example, code could assume that the globals are
 912    densely packed in their section and try to iterate over them as an array,
 913    alignment padding would break this iteration.</p>
 914
 915 <p>For example, the following defines a global in a numbered address space with
 916    an initializer, section, and alignment:</p>
 917
 918 <pre class="doc_code">
 919 @G = addrspace(5) constant float 1.0, section "foo", align 4
 920 </pre>
 921
 922 <p>The following example defines a thread-local global with
 923    the <tt>initialexec</tt> TLS model:</p>
 924
 925 <pre class="doc_code">
 926 @G = thread_local(initialexec) global i32 0, align 4
 927 </pre>
 928
 929 </div>
 930
 931
 932 <!-- ======================================================================= -->
 933 <h3>
 934   <a name="functionstructure">Functions</a>
 935 </h3>
 936
 937 <div>
 938
 939 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 940    optional <a href="#linkage">linkage type</a>, an optional
 941    <a href="#visibility">visibility style</a>, an optional
 942    <a href="#callingconv">calling convention</a>,
 943    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 944    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 945    name, a (possibly empty) argument list (each with optional
 946    <a href="#paramattrs">parameter attributes</a>), optional
 947    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 948    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 949    curly brace, a list of basic blocks, and a closing curly brace.</p>
 950
 951 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 952    optional <a href="#linkage">linkage type</a>, an optional
 953    <a href="#visibility">visibility style</a>, an optional
 954    <a href="#callingconv">calling convention</a>,
 955    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 956    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 957    name, a possibly empty list of arguments, an optional alignment, and an
 958    optional <a href="#gc">garbage collector name</a>.</p>
 959
 960 <p>A function definition contains a list of basic blocks, forming the CFG
 961    (Control Flow Graph) for the function.  Each basic block may optionally start
 962    with a label (giving the basic block a symbol table entry), contains a list
 963    of instructions, and ends with a <a href="#terminators">terminator</a>
 964    instruction (such as a branch or function return).</p>
 965
 966 <p>The first basic block in a function is special in two ways: it is immediately
 967    executed on entrance to the function, and it is not allowed to have
 968    predecessor basic blocks (i.e. there can not be any branches to the entry
 969    block of a function).  Because the block can have no predecessors, it also
 970    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 971
 972 <p>LLVM allows an explicit section to be specified for functions.  If the target
 973    supports it, it will emit functions to the section specified.</p>
 974
 975 <p>An explicit alignment may be specified for a function.  If not present, or if
 976    the alignment is set to zero, the alignment of the function is set by the
 977    target to whatever it feels convenient.  If an explicit alignment is
 978    specified, the function is forced to have at least that much alignment.  All
 979    alignments must be a power of 2.</p>
 980
 981 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 982    be significant and two identical functions can be merged.</p>
 983
 984 <h5>Syntax:</h5>
 985 <pre class="doc_code">
 986 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 987        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 988        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 989        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 990        [<a href="#gc">gc</a>] { ... }
 991 </pre>
 992
 993 </div>
 994
 995 <!-- ======================================================================= -->
 996 <h3>
 997   <a name="aliasstructure">Aliases</a>
 998 </h3>
 999
1000 <div>
1001
1002 <p>Aliases act as "second name" for the aliasee value (which can be either
1003    function, global variable, another alias or bitcast of global value). Aliases
1004    may have an optional <a href="#linkage">linkage type</a>, and an
1005    optional <a href="#visibility">visibility style</a>.</p>
1006
1007 <h5>Syntax:</h5>
1008 <pre class="doc_code">
1009 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
1010 </pre>
1011
1012 </div>
1013
1014 <!-- ======================================================================= -->
1015 <h3>
1016   <a name="namedmetadatastructure">Named Metadata</a>
1017 </h3>
1018
1019 <div>
1020
1021 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
1022    nodes</a> (but not metadata strings) are the only valid operands for
1023    a named metadata.</p>
1024
1025 <h5>Syntax:</h5>
1026 <pre class="doc_code">
1027 ; Some unnamed metadata nodes, which are referenced by the named metadata.
1028 !0 = metadata !{metadata !"zero"}
1029 !1 = metadata !{metadata !"one"}
1030 !2 = metadata !{metadata !"two"}
1031 ; A named metadata.
1032 !name = !{!0, !1, !2}
1033 </pre>
1034
1035 </div>
1036
1037 <!-- ======================================================================= -->
1038 <h3>
1039   <a name="paramattrs">Parameter Attributes</a>
1040 </h3>
1041
1042 <div>
1043
1044 <p>The return type and each parameter of a function type may have a set of
1045    <i>parameter attributes</i> associated with them. Parameter attributes are
1046    used to communicate additional information about the result or parameters of
1047    a function. Parameter attributes are considered to be part of the function,
1048    not of the function type, so functions with different parameter attributes
1049    can have the same function type.</p>
1050
1051 <p>Parameter attributes are simple keywords that follow the type specified. If
1052    multiple parameter attributes are needed, they are space separated. For
1053    example:</p>
1054
1055 <pre class="doc_code">
1056 declare i32 @printf(i8* noalias nocapture, ...)
1057 declare i32 @atoi(i8 zeroext)
1058 declare signext i8 @returns_signed_char()
1059 </pre>
1060
1061 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1062    <tt>readonly</tt>) come immediately after the argument list.</p>
1063
1064 <p>Currently, only the following parameter attributes are defined:</p>
1065
1066 <dl>
1067   <dt><tt><b>zeroext</b></tt></dt>
1068   <dd>This indicates to the code generator that the parameter or return value
1069       should be zero-extended to the extent required by the target's ABI (which
1070       is usually 32-bits, but is 8-bits for a i1 on x86-64) by the caller (for a
1071       parameter) or the callee (for a return value).</dd>
1072
1073   <dt><tt><b>signext</b></tt></dt>
1074   <dd>This indicates to the code generator that the parameter or return value
1075       should be sign-extended to the extent required by the target's ABI (which
1076       is usually 32-bits) by the caller (for a parameter) or the callee (for a
1077       return value).</dd>
1078
1079   <dt><tt><b>inreg</b></tt></dt>
1080   <dd>This indicates that this parameter or return value should be treated in a
1081       special target-dependent fashion during while emitting code for a function
1082       call or return (usually, by putting it in a register as opposed to memory,
1083       though some targets use it to distinguish between two different kinds of
1084       registers).  Use of this attribute is target-specific.</dd>
1085
1086   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1087   <dd><p>This indicates that the pointer parameter should really be passed by
1088       value to the function.  The attribute implies that a hidden copy of the
1089       pointee
1090       is made between the caller and the callee, so the callee is unable to
1091       modify the value in the caller.  This attribute is only valid on LLVM
1092       pointer arguments.  It is generally used to pass structs and arrays by
1093       value, but is also valid on pointers to scalars.  The copy is considered
1094       to belong to the caller not the callee (for example,
1095       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1096       <tt>byval</tt> parameters). This is not a valid attribute for return
1097       values.</p>
1098
1099       <p>The byval attribute also supports specifying an alignment with
1100       the align attribute.  It indicates the alignment of the stack slot to
1101       form and the known alignment of the pointer specified to the call site. If
1102       the alignment is not specified, then the code generator makes a
1103       target-specific assumption.</p></dd>
1104
1105   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1106   <dd>This indicates that the pointer parameter specifies the address of a
1107       structure that is the return value of the function in the source program.
1108       This pointer must be guaranteed by the caller to be valid: loads and
1109       stores to the structure may be assumed by the callee to not to trap.  This
1110       may only be applied to the first parameter. This is not a valid attribute
1111       for return values. </dd>
1112
1113   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1114   <dd>This indicates that pointer values
1115       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1116       value do not alias pointer values which are not <i>based</i> on it,
1117       ignoring certain "irrelevant" dependencies.
1118       For a call to the parent function, dependencies between memory
1119       references from before or after the call and from those during the call
1120       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1121       return value used in that call.
1122       The caller shares the responsibility with the callee for ensuring that
1123       these requirements are met.
1124       For further details, please see the discussion of the NoAlias response in
1125       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1126 <br>
1127       Note that this definition of <tt>noalias</tt> is intentionally
1128       similar to the definition of <tt>restrict</tt> in C99 for function
1129       arguments, though it is slightly weaker.
1130 <br>
1131       For function return values, C99's <tt>restrict</tt> is not meaningful,
1132       while LLVM's <tt>noalias</tt> is.
1133       </dd>
1134
1135   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1136   <dd>This indicates that the callee does not make any copies of the pointer
1137       that outlive the callee itself. This is not a valid attribute for return
1138       values.</dd>
1139
1140   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1141   <dd>This indicates that the pointer parameter can be excised using the
1142       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1143       attribute for return values.</dd>
1144 </dl>
1145
1146 </div>
1147
1148 <!-- ======================================================================= -->
1149 <h3>
1150   <a name="gc">Garbage Collector Names</a>
1151 </h3>
1152
1153 <div>
1154
1155 <p>Each function may specify a garbage collector name, which is simply a
1156    string:</p>
1157
1158 <pre class="doc_code">
1159 define void @f() gc "name" { ... }
1160 </pre>
1161
1162 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1163    collector which will cause the compiler to alter its output in order to
1164    support the named garbage collection algorithm.</p>
1165
1166 </div>
1167
1168 <!-- ======================================================================= -->
1169 <h3>
1170   <a name="fnattrs">Function Attributes</a>
1171 </h3>
1172
1173 <div>
1174
1175 <p>Function attributes are set to communicate additional information about a
1176    function. Function attributes are considered to be part of the function, not
1177    of the function type, so functions with different parameter attributes can
1178    have the same function type.</p>
1179
1180 <p>Function attributes are simple keywords that follow the type specified. If
1181    multiple attributes are needed, they are space separated. For example:</p>
1182
1183 <pre class="doc_code">
1184 define void @f() noinline { ... }
1185 define void @f() alwaysinline { ... }
1186 define void @f() alwaysinline optsize { ... }
1187 define void @f() optsize { ... }
1188 </pre>
1189
1190 <dl>
1191   <dt><tt><b>address_safety</b></tt></dt>
1192   <dd>This attribute indicates that the address safety analysis
1193   is enabled for this function.  </dd>
1194
1195   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1196   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1197       the backend should forcibly align the stack pointer. Specify the
1198       desired alignment, which must be a power of two, in parentheses.
1199
1200   <dt><tt><b>alwaysinline</b></tt></dt>
1201   <dd>This attribute indicates that the inliner should attempt to inline this
1202       function into callers whenever possible, ignoring any active inlining size
1203       threshold for this caller.</dd>
1204
1205   <dt><tt><b>nonlazybind</b></tt></dt>
1206   <dd>This attribute suppresses lazy symbol binding for the function. This
1207       may make calls to the function faster, at the cost of extra program
1208       startup time if the function is not called during program startup.</dd>
1209
1210   <dt><tt><b>inlinehint</b></tt></dt>
1211   <dd>This attribute indicates that the source code contained a hint that inlining
1212       this function is desirable (such as the "inline" keyword in C/C++).  It
1213       is just a hint; it imposes no requirements on the inliner.</dd>
1214
1215   <dt><tt><b>naked</b></tt></dt>
1216   <dd>This attribute disables prologue / epilogue emission for the function.
1217       This can have very system-specific consequences.</dd>
1218
1219   <dt><tt><b>noimplicitfloat</b></tt></dt>
1220   <dd>This attributes disables implicit floating point instructions.</dd>
1221
1222   <dt><tt><b>noinline</b></tt></dt>
1223   <dd>This attribute indicates that the inliner should never inline this
1224       function in any situation. This attribute may not be used together with
1225       the <tt>alwaysinline</tt> attribute.</dd>
1226
1227   <dt><tt><b>noredzone</b></tt></dt>
1228   <dd>This attribute indicates that the code generator should not use a red
1229       zone, even if the target-specific ABI normally permits it.</dd>
1230
1231   <dt><tt><b>noreturn</b></tt></dt>
1232   <dd>This function attribute indicates that the function never returns
1233       normally.  This produces undefined behavior at runtime if the function
1234       ever does dynamically return.</dd>
1235
1236   <dt><tt><b>nounwind</b></tt></dt>
1237   <dd>This function attribute indicates that the function never returns with an
1238       unwind or exceptional control flow.  If the function does unwind, its
1239       runtime behavior is undefined.</dd>
1240
1241   <dt><tt><b>optsize</b></tt></dt>
1242   <dd>This attribute suggests that optimization passes and code generator passes
1243       make choices that keep the code size of this function low, and otherwise
1244       do optimizations specifically to reduce code size.</dd>
1245
1246   <dt><tt><b>readnone</b></tt></dt>
1247   <dd>This attribute indicates that the function computes its result (or decides
1248       to unwind an exception) based strictly on its arguments, without
1249       dereferencing any pointer arguments or otherwise accessing any mutable
1250       state (e.g. memory, control registers, etc) visible to caller functions.
1251       It does not write through any pointer arguments
1252       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1253       changes any state visible to callers.  This means that it cannot unwind
1254       exceptions by calling the <tt>C++</tt> exception throwing methods.</dd>
1255
1256   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1257   <dd>This attribute indicates that the function does not write through any
1258       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1259       arguments) or otherwise modify any state (e.g. memory, control registers,
1260       etc) visible to caller functions.  It may dereference pointer arguments
1261       and read state that may be set in the caller.  A readonly function always
1262       returns the same value (or unwinds an exception identically) when called
1263       with the same set of arguments and global state.  It cannot unwind an
1264       exception by calling the <tt>C++</tt> exception throwing methods.</dd>
1265
1266   <dt><tt><b><a name="returns_twice">returns_twice</a></b></tt></dt>
1267   <dd>This attribute indicates that this function can return twice. The
1268       C <code>setjmp</code> is an example of such a function.  The compiler
1269       disables some optimizations (like tail calls) in the caller of these
1270       functions.</dd>
1271
1272   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1273   <dd>This attribute indicates that the function should emit a stack smashing
1274       protector. It is in the form of a "canary"&mdash;a random value placed on
1275       the stack before the local variables that's checked upon return from the
1276       function to see if it has been overwritten. A heuristic is used to
1277       determine if a function needs stack protectors or not.<br>
1278 <br>
1279       If a function that has an <tt>ssp</tt> attribute is inlined into a
1280       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1281       function will have an <tt>ssp</tt> attribute.</dd>
1282
1283   <dt><tt><b>sspreq</b></tt></dt>
1284   <dd>This attribute indicates that the function should <em>always</em> emit a
1285       stack smashing protector. This overrides
1286       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1287 <br>
1288       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1289       function that doesn't have an <tt>sspreq</tt> attribute or which has
1290       an <tt>ssp</tt> attribute, then the resulting function will have
1291       an <tt>sspreq</tt> attribute.</dd>
1292
1293   <dt><tt><b><a name="uwtable">uwtable</a></b></tt></dt>
1294   <dd>This attribute indicates that the ABI being targeted requires that
1295       an unwind table entry be produce for this function even if we can
1296       show that no exceptions passes by it. This is normally the case for
1297       the ELF x86-64 abi, but it can be disabled for some compilation
1298       units.</dd>
1299 </dl>
1300
1301 </div>
1302
1303 <!-- ======================================================================= -->
1304 <h3>
1305   <a name="moduleasm">Module-Level Inline Assembly</a>
1306 </h3>
1307
1308 <div>
1309
1310 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1311    the GCC "file scope inline asm" blocks.  These blocks are internally
1312    concatenated by LLVM and treated as a single unit, but may be separated in
1313    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1314
1315 <pre class="doc_code">
1316 module asm "inline asm code goes here"
1317 module asm "more can go here"
1318 </pre>
1319
1320 <p>The strings can contain any character by escaping non-printable characters.
1321    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1322    for the number.</p>
1323
1324 <p>The inline asm code is simply printed to the machine code .s file when
1325    assembly code is generated.</p>
1326
1327 </div>
1328
1329 <!-- ======================================================================= -->
1330 <h3>
1331   <a name="datalayout">Data Layout</a>
1332 </h3>
1333
1334 <div>
1335
1336 <p>A module may specify a target specific data layout string that specifies how
1337    data is to be laid out in memory. The syntax for the data layout is
1338    simply:</p>
1339
1340 <pre class="doc_code">
1341 target datalayout = "<i>layout specification</i>"
1342 </pre>
1343
1344 <p>The <i>layout specification</i> consists of a list of specifications
1345    separated by the minus sign character ('-').  Each specification starts with
1346    a letter and may include other information after the letter to define some
1347    aspect of the data layout.  The specifications accepted are as follows:</p>
1348
1349 <dl>
1350   <dt><tt>E</tt></dt>
1351   <dd>Specifies that the target lays out data in big-endian form. That is, the
1352       bits with the most significance have the lowest address location.</dd>
1353
1354   <dt><tt>e</tt></dt>
1355   <dd>Specifies that the target lays out data in little-endian form. That is,
1356       the bits with the least significance have the lowest address
1357       location.</dd>
1358
1359   <dt><tt>S<i>size</i></tt></dt>
1360   <dd>Specifies the natural alignment of the stack in bits. Alignment promotion
1361       of stack variables is limited to the natural stack alignment to avoid
1362       dynamic stack realignment. The stack alignment must be a multiple of
1363       8-bits. If omitted, the natural stack alignment defaults to "unspecified",
1364       which does not prevent any alignment promotions.</dd>
1365
1366   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1367   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1368       <i>preferred</i> alignments. All sizes are in bits. Specifying
1369       the <i>pref</i> alignment is optional. If omitted, the
1370       preceding <tt>:</tt> should be omitted too.</dd>
1371
1372   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1373   <dd>This specifies the alignment for an integer type of a given bit
1374       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1375
1376   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1377   <dd>This specifies the alignment for a vector type of a given bit
1378       <i>size</i>.</dd>
1379
1380   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1381   <dd>This specifies the alignment for a floating point type of a given bit
1382       <i>size</i>. Only values of <i>size</i> that are supported by the target
1383       will work.  32 (float) and 64 (double) are supported on all targets;
1384       80 or 128 (different flavors of long double) are also supported on some
1385       targets.
1386
1387   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1388   <dd>This specifies the alignment for an aggregate type of a given bit
1389       <i>size</i>.</dd>
1390
1391   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1392   <dd>This specifies the alignment for a stack object of a given bit
1393       <i>size</i>.</dd>
1394
1395   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1396   <dd>This specifies a set of native integer widths for the target CPU
1397       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1398       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1399       this set are considered to support most general arithmetic
1400       operations efficiently.</dd>
1401 </dl>
1402
1403 <p>When constructing the data layout for a given target, LLVM starts with a
1404    default set of specifications which are then (possibly) overridden by the
1405    specifications in the <tt>datalayout</tt> keyword. The default specifications
1406    are given in this list:</p>
1407
1408 <ul>
1409   <li><tt>E</tt> - big endian</li>
1410   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1411   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1412   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1413   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1414   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1415   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1416   alignment of 64-bits</li>
1417   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1418   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1419   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1420   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1421   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1422   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1423 </ul>
1424
1425 <p>When LLVM is determining the alignment for a given type, it uses the
1426    following rules:</p>
1427
1428 <ol>
1429   <li>If the type sought is an exact match for one of the specifications, that
1430       specification is used.</li>
1431
1432   <li>If no match is found, and the type sought is an integer type, then the
1433       smallest integer type that is larger than the bitwidth of the sought type
1434       is used. If none of the specifications are larger than the bitwidth then
1435       the the largest integer type is used. For example, given the default
1436       specifications above, the i7 type will use the alignment of i8 (next
1437       largest) while both i65 and i256 will use the alignment of i64 (largest
1438       specified).</li>
1439
1440   <li>If no match is found, and the type sought is a vector type, then the
1441       largest vector type that is smaller than the sought vector type will be
1442       used as a fall back.  This happens because &lt;128 x double&gt; can be
1443       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1444 </ol>
1445
1446 <p>The function of the data layout string may not be what you expect.  Notably,
1447    this is not a specification from the frontend of what alignment the code
1448    generator should use.</p>
1449
1450 <p>Instead, if specified, the target data layout is required to match what the
1451    ultimate <em>code generator</em> expects.  This string is used by the
1452    mid-level optimizers to
1453    improve code, and this only works if it matches what the ultimate code
1454    generator uses.  If you would like to generate IR that does not embed this
1455    target-specific detail into the IR, then you don't have to specify the
1456    string.  This will disable some optimizations that require precise layout
1457    information, but this also prevents those optimizations from introducing
1458    target specificity into the IR.</p>
1459
1460
1461
1462 </div>
1463
1464 <!-- ======================================================================= -->
1465 <h3>
1466   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1467 </h3>
1468
1469 <div>
1470
1471 <p>Any memory access must be done through a pointer value associated
1472 with an address range of the memory access, otherwise the behavior
1473 is undefined. Pointer values are associated with address ranges
1474 according to the following rules:</p>
1475
1476 <ul>
1477   <li>A pointer value is associated with the addresses associated with
1478       any value it is <i>based</i> on.
1479   <li>An address of a global variable is associated with the address
1480       range of the variable's storage.</li>
1481   <li>The result value of an allocation instruction is associated with
1482       the address range of the allocated storage.</li>
1483   <li>A null pointer in the default address-space is associated with
1484       no address.</li>
1485   <li>An integer constant other than zero or a pointer value returned
1486       from a function not defined within LLVM may be associated with address
1487       ranges allocated through mechanisms other than those provided by
1488       LLVM. Such ranges shall not overlap with any ranges of addresses
1489       allocated by mechanisms provided by LLVM.</li>
1490 </ul>
1491
1492 <p>A pointer value is <i>based</i> on another pointer value according
1493    to the following rules:</p>
1494
1495 <ul>
1496   <li>A pointer value formed from a
1497       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1498       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1499   <li>The result value of a
1500       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1501       of the <tt>bitcast</tt>.</li>
1502   <li>A pointer value formed by an
1503       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1504       pointer values that contribute (directly or indirectly) to the
1505       computation of the pointer's value.</li>
1506   <li>The "<i>based</i> on" relationship is transitive.</li>
1507 </ul>
1508
1509 <p>Note that this definition of <i>"based"</i> is intentionally
1510    similar to the definition of <i>"based"</i> in C99, though it is
1511    slightly weaker.</p>
1512
1513 <p>LLVM IR does not associate types with memory. The result type of a
1514 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1515 alignment of the memory from which to load, as well as the
1516 interpretation of the value. The first operand type of a
1517 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1518 and alignment of the store.</p>
1519
1520 <p>Consequently, type-based alias analysis, aka TBAA, aka
1521 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1522 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1523 additional information which specialized optimization passes may use
1524 to implement type-based alias analysis.</p>
1525
1526 </div>
1527
1528 <!-- ======================================================================= -->
1529 <h3>
1530   <a name="volatile">Volatile Memory Accesses</a>
1531 </h3>
1532
1533 <div>
1534
1535 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1536 href="#i_store"><tt>store</tt></a>s, and <a
1537 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1538 The optimizers must not change the number of volatile operations or change their
1539 order of execution relative to other volatile operations.  The optimizers
1540 <i>may</i> change the order of volatile operations relative to non-volatile
1541 operations.  This is not Java's "volatile" and has no cross-thread
1542 synchronization behavior.</p>
1543
1544 </div>
1545
1546 <!-- ======================================================================= -->
1547 <h3>
1548   <a name="memmodel">Memory Model for Concurrent Operations</a>
1549 </h3>
1550
1551 <div>
1552
1553 <p>The LLVM IR does not define any way to start parallel threads of execution
1554 or to register signal handlers. Nonetheless, there are platform-specific
1555 ways to create them, and we define LLVM IR's behavior in their presence. This
1556 model is inspired by the C++0x memory model.</p>
1557
1558 <p>For a more informal introduction to this model, see the
1559 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.
1560
1561 <p>We define a <i>happens-before</i> partial order as the least partial order
1562 that</p>
1563 <ul>
1564   <li>Is a superset of single-thread program order, and</li>
1565   <li>When a <i>synchronizes-with</i> <tt>b</tt>, includes an edge from
1566       <tt>a</tt> to <tt>b</tt>. <i>Synchronizes-with</i> pairs are introduced
1567       by platform-specific techniques, like pthread locks, thread
1568       creation, thread joining, etc., and by atomic instructions.
1569       (See also <a href="#ordering">Atomic Memory Ordering Constraints</a>).
1570       </li>
1571 </ul>
1572
1573 <p>Note that program order does not introduce <i>happens-before</i> edges
1574 between a thread and signals executing inside that thread.</p>
1575
1576 <p>Every (defined) read operation (load instructions, memcpy, atomic
1577 loads/read-modify-writes, etc.) <var>R</var> reads a series of bytes written by
1578 (defined) write operations (store instructions, atomic
1579 stores/read-modify-writes, memcpy, etc.). For the purposes of this section,
1580 initialized globals are considered to have a write of the initializer which is
1581 atomic and happens before any other read or write of the memory in question.
1582 For each byte of a read <var>R</var>, <var>R<sub>byte</sub></var> may see
1583 any write to the same byte, except:</p>
1584
1585 <ul>
1586   <li>If <var>write<sub>1</sub></var> happens before
1587       <var>write<sub>2</sub></var>, and <var>write<sub>2</sub></var> happens
1588       before <var>R<sub>byte</sub></var>, then <var>R<sub>byte</sub></var>
1589       does not see <var>write<sub>1</sub></var>.
1590   <li>If <var>R<sub>byte</sub></var> happens before
1591       <var>write<sub>3</sub></var>, then <var>R<sub>byte</sub></var> does not
1592       see <var>write<sub>3</sub></var>.
1593 </ul>
1594
1595 <p>Given that definition, <var>R<sub>byte</sub></var> is defined as follows:
1596 <ul>
1597   <li>If <var>R</var> is volatile, the result is target-dependent. (Volatile
1598       is supposed to give guarantees which can support
1599       <code>sig_atomic_t</code> in C/C++, and may be used for accesses to
1600       addresses which do not behave like normal memory.  It does not generally
1601       provide cross-thread synchronization.)
1602   <li>Otherwise, if there is no write to the same byte that happens before
1603     <var>R<sub>byte</sub></var>, <var>R<sub>byte</sub></var> returns
1604     <tt>undef</tt> for that byte.
1605   <li>Otherwise, if <var>R<sub>byte</sub></var> may see exactly one write,
1606       <var>R<sub>byte</sub></var> returns the value written by that
1607       write.</li>
1608   <li>Otherwise, if <var>R</var> is atomic, and all the writes
1609       <var>R<sub>byte</sub></var> may see are atomic, it chooses one of the
1610       values written.  See the <a href="#ordering">Atomic Memory Ordering
1611       Constraints</a> section for additional constraints on how the choice
1612       is made.
1613   <li>Otherwise <var>R<sub>byte</sub></var> returns <tt>undef</tt>.</li>
1614 </ul>
1615
1616 <p><var>R</var> returns the value composed of the series of bytes it read.
1617 This implies that some bytes within the value may be <tt>undef</tt>
1618 <b>without</b> the entire value being <tt>undef</tt>. Note that this only
1619 defines the semantics of the operation; it doesn't mean that targets will
1620 emit more than one instruction to read the series of bytes.</p>
1621
1622 <p>Note that in cases where none of the atomic intrinsics are used, this model
1623 places only one restriction on IR transformations on top of what is required
1624 for single-threaded execution: introducing a store to a byte which might not
1625 otherwise be stored is not allowed in general.  (Specifically, in the case
1626 where another thread might write to and read from an address, introducing a
1627 store can change a load that may see exactly one write into a load that may
1628 see multiple writes.)</p>
1629
1630 <!-- FIXME: This model assumes all targets where concurrency is relevant have
1631 a byte-size store which doesn't affect adjacent bytes.  As far as I can tell,
1632 none of the backends currently in the tree fall into this category; however,
1633 there might be targets which care.  If there are, we want a paragraph
1634 like the following:
1635
1636 Targets may specify that stores narrower than a certain width are not
1637 available; on such a target, for the purposes of this model, treat any
1638 non-atomic write with an alignment or width less than the minimum width
1639 as if it writes to the relevant surrounding bytes.
1640 -->
1641
1642 </div>
1643
1644 <!-- ======================================================================= -->
1645 <h3>
1646       <a name="ordering">Atomic Memory Ordering Constraints</a>
1647 </h3>
1648
1649 <div>
1650
1651 <p>Atomic instructions (<a href="#i_cmpxchg"><code>cmpxchg</code></a>,
1652 <a href="#i_atomicrmw"><code>atomicrmw</code></a>,
1653 <a href="#i_fence"><code>fence</code></a>,
1654 <a href="#i_load"><code>atomic load</code></a>, and
1655 <a href="#i_store"><code>atomic store</code></a>) take an ordering parameter
1656 that determines which other atomic instructions on the same address they
1657 <i>synchronize with</i>.  These semantics are borrowed from Java and C++0x,
1658 but are somewhat more colloquial. If these descriptions aren't precise enough,
1659 check those specs (see spec references in the
1660 <a href="Atomics.html#introduction">atomics guide</a>).
1661 <a href="#i_fence"><code>fence</code></a> instructions
1662 treat these orderings somewhat differently since they don't take an address.
1663 See that instruction's documentation for details.</p>
1664
1665 <p>For a simpler introduction to the ordering constraints, see the
1666 <a href="Atomics.html">LLVM Atomic Instructions and Concurrency Guide</a>.</p>
1667
1668 <dl>
1669 <dt><code>unordered</code></dt>
1670 <dd>The set of values that can be read is governed by the happens-before
1671 partial order. A value cannot be read unless some operation wrote it.
1672 This is intended to provide a guarantee strong enough to model Java's
1673 non-volatile shared variables.  This ordering cannot be specified for
1674 read-modify-write operations; it is not strong enough to make them atomic
1675 in any interesting way.</dd>
1676 <dt><code>monotonic</code></dt>
1677 <dd>In addition to the guarantees of <code>unordered</code>, there is a single
1678 total order for modifications by <code>monotonic</code> operations on each
1679 address. All modification orders must be compatible with the happens-before
1680 order. There is no guarantee that the modification orders can be combined to
1681 a global total order for the whole program (and this often will not be
1682 possible). The read in an atomic read-modify-write operation
1683 (<a href="#i_cmpxchg"><code>cmpxchg</code></a> and
1684 <a href="#i_atomicrmw"><code>atomicrmw</code></a>)
1685 reads the value in the modification order immediately before the value it
1686 writes. If one atomic read happens before another atomic read of the same
1687 address, the later read must see the same value or a later value in the
1688 address's modification order. This disallows reordering of
1689 <code>monotonic</code> (or stronger) operations on the same address. If an
1690 address is written <code>monotonic</code>ally by one thread, and other threads
1691 <code>monotonic</code>ally read that address repeatedly, the other threads must
1692 eventually see the write. This corresponds to the C++0x/C1x
1693 <code>memory_order_relaxed</code>.</dd>
1694 <dt><code>acquire</code></dt>
1695 <dd>In addition to the guarantees of <code>monotonic</code>,
1696 a <i>synchronizes-with</i> edge may be formed with a <code>release</code>
1697 operation. This is intended to model C++'s <code>memory_order_acquire</code>.</dd>
1698 <dt><code>release</code></dt>
1699 <dd>In addition to the guarantees of <code>monotonic</code>, if this operation
1700 writes a value which is subsequently read by an <code>acquire</code> operation,
1701 it <i>synchronizes-with</i> that operation.  (This isn't a complete
1702 description; see the C++0x definition of a release sequence.) This corresponds
1703 to the C++0x/C1x <code>memory_order_release</code>.</dd>
1704 <dt><code>acq_rel</code> (acquire+release)</dt><dd>Acts as both an
1705 <code>acquire</code> and <code>release</code> operation on its address.
1706 This corresponds to the C++0x/C1x <code>memory_order_acq_rel</code>.</dd>
1707 <dt><code>seq_cst</code> (sequentially consistent)</dt><dd>
1708 <dd>In addition to the guarantees of <code>acq_rel</code>
1709 (<code>acquire</code> for an operation which only reads, <code>release</code>
1710 for an operation which only writes), there is a global total order on all
1711 sequentially-consistent operations on all addresses, which is consistent with
1712 the <i>happens-before</i> partial order and with the modification orders of
1713 all the affected addresses. Each sequentially-consistent read sees the last
1714 preceding write to the same address in this global order. This corresponds
1715 to the C++0x/C1x <code>memory_order_seq_cst</code> and Java volatile.</dd>
1716 </dl>
1717
1718 <p id="singlethread">If an atomic operation is marked <code>singlethread</code>,
1719 it only <i>synchronizes with</i> or participates in modification and seq_cst
1720 total orderings with other operations running in the same thread (for example,
1721 in signal handlers).</p>
1722
1723 </div>
1724
1725 </div>
1726
1727 <!-- *********************************************************************** -->
1728 <h2><a name="typesystem">Type System</a></h2>
1729 <!-- *********************************************************************** -->
1730
1731 <div>
1732
1733 <p>The LLVM type system is one of the most important features of the
1734    intermediate representation.  Being typed enables a number of optimizations
1735    to be performed on the intermediate representation directly, without having
1736    to do extra analyses on the side before the transformation.  A strong type
1737    system makes it easier to read the generated code and enables novel analyses
1738    and transformations that are not feasible to perform on normal three address
1739    code representations.</p>
1740
1741 <!-- ======================================================================= -->
1742 <h3>
1743   <a name="t_classifications">Type Classifications</a>
1744 </h3>
1745
1746 <div>
1747
1748 <p>The types fall into a few useful classifications:</p>
1749
1750 <table border="1" cellspacing="0" cellpadding="4">
1751   <tbody>
1752     <tr><th>Classification</th><th>Types</th></tr>
1753     <tr>
1754       <td><a href="#t_integer">integer</a></td>
1755       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1756     </tr>
1757     <tr>
1758       <td><a href="#t_floating">floating point</a></td>
1759       <td><tt>half, float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1760     </tr>
1761     <tr>
1762       <td><a name="t_firstclass">first class</a></td>
1763       <td><a href="#t_integer">integer</a>,
1764           <a href="#t_floating">floating point</a>,
1765           <a href="#t_pointer">pointer</a>,
1766           <a href="#t_vector">vector</a>,
1767           <a href="#t_struct">structure</a>,
1768           <a href="#t_array">array</a>,
1769           <a href="#t_label">label</a>,
1770           <a href="#t_metadata">metadata</a>.
1771       </td>
1772     </tr>
1773     <tr>
1774       <td><a href="#t_primitive">primitive</a></td>
1775       <td><a href="#t_label">label</a>,
1776           <a href="#t_void">void</a>,
1777           <a href="#t_integer">integer</a>,
1778           <a href="#t_floating">floating point</a>,
1779           <a href="#t_x86mmx">x86mmx</a>,
1780           <a href="#t_metadata">metadata</a>.</td>
1781     </tr>
1782     <tr>
1783       <td><a href="#t_derived">derived</a></td>
1784       <td><a href="#t_array">array</a>,
1785           <a href="#t_function">function</a>,
1786           <a href="#t_pointer">pointer</a>,
1787           <a href="#t_struct">structure</a>,
1788           <a href="#t_vector">vector</a>,
1789           <a href="#t_opaque">opaque</a>.
1790       </td>
1791     </tr>
1792   </tbody>
1793 </table>
1794
1795 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1796    important.  Values of these types are the only ones which can be produced by
1797    instructions.</p>
1798
1799 </div>
1800
1801 <!-- ======================================================================= -->
1802 <h3>
1803   <a name="t_primitive">Primitive Types</a>
1804 </h3>
1805
1806 <div>
1807
1808 <p>The primitive types are the fundamental building blocks of the LLVM
1809    system.</p>
1810
1811 <!-- _______________________________________________________________________ -->
1812 <h4>
1813   <a name="t_integer">Integer Type</a>
1814 </h4>
1815
1816 <div>
1817
1818 <h5>Overview:</h5>
1819 <p>The integer type is a very simple type that simply specifies an arbitrary
1820    bit width for the integer type desired. Any bit width from 1 bit to
1821    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1822
1823 <h5>Syntax:</h5>
1824 <pre>
1825   iN
1826 </pre>
1827
1828 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1829    value.</p>
1830
1831 <h5>Examples:</h5>
1832 <table class="layout">
1833   <tr class="layout">
1834     <td class="left"><tt>i1</tt></td>
1835     <td class="left">a single-bit integer.</td>
1836   </tr>
1837   <tr class="layout">
1838     <td class="left"><tt>i32</tt></td>
1839     <td class="left">a 32-bit integer.</td>
1840   </tr>
1841   <tr class="layout">
1842     <td class="left"><tt>i1942652</tt></td>
1843     <td class="left">a really big integer of over 1 million bits.</td>
1844   </tr>
1845 </table>
1846
1847 </div>
1848
1849 <!-- _______________________________________________________________________ -->
1850 <h4>
1851   <a name="t_floating">Floating Point Types</a>
1852 </h4>
1853
1854 <div>
1855
1856 <table>
1857   <tbody>
1858     <tr><th>Type</th><th>Description</th></tr>
1859     <tr><td><tt>half</tt></td><td>16-bit floating point value</td></tr>
1860     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1861     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1862     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1863     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1864     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1865   </tbody>
1866 </table>
1867
1868 </div>
1869
1870 <!-- _______________________________________________________________________ -->
1871 <h4>
1872   <a name="t_x86mmx">X86mmx Type</a>
1873 </h4>
1874
1875 <div>
1876
1877 <h5>Overview:</h5>
1878 <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>
1879
1880 <h5>Syntax:</h5>
1881 <pre>
1882   x86mmx
1883 </pre>
1884
1885 </div>
1886
1887 <!-- _______________________________________________________________________ -->
1888 <h4>
1889   <a name="t_void">Void Type</a>
1890 </h4>
1891
1892 <div>
1893
1894 <h5>Overview:</h5>
1895 <p>The void type does not represent any value and has no size.</p>
1896
1897 <h5>Syntax:</h5>
1898 <pre>
1899   void
1900 </pre>
1901
1902 </div>
1903
1904 <!-- _______________________________________________________________________ -->
1905 <h4>
1906   <a name="t_label">Label Type</a>
1907 </h4>
1908
1909 <div>
1910
1911 <h5>Overview:</h5>
1912 <p>The label type represents code labels.</p>
1913
1914 <h5>Syntax:</h5>
1915 <pre>
1916   label
1917 </pre>
1918
1919 </div>
1920
1921 <!-- _______________________________________________________________________ -->
1922 <h4>
1923   <a name="t_metadata">Metadata Type</a>
1924 </h4>
1925
1926 <div>
1927
1928 <h5>Overview:</h5>
1929 <p>The metadata type represents embedded metadata. No derived types may be
1930    created from metadata except for <a href="#t_function">function</a>
1931    arguments.
1932
1933 <h5>Syntax:</h5>
1934 <pre>
1935   metadata
1936 </pre>
1937
1938 </div>
1939
1940 </div>
1941
1942 <!-- ======================================================================= -->
1943 <h3>
1944   <a name="t_derived">Derived Types</a>
1945 </h3>
1946
1947 <div>
1948
1949 <p>The real power in LLVM comes from the derived types in the system.  This is
1950    what allows a programmer to represent arrays, functions, pointers, and other
1951    useful types.  Each of these types contain one or more element types which
1952    may be a primitive type, or another derived type.  For example, it is
1953    possible to have a two dimensional array, using an array as the element type
1954    of another array.</p>
1955
1956 <!-- _______________________________________________________________________ -->
1957 <h4>
1958   <a name="t_aggregate">Aggregate Types</a>
1959 </h4>
1960
1961 <div>
1962
1963 <p>Aggregate Types are a subset of derived types that can contain multiple
1964   member types. <a href="#t_array">Arrays</a> and
1965   <a href="#t_struct">structs</a> are aggregate types.
1966   <a href="#t_vector">Vectors</a> are not considered to be aggregate types.</p>
1967
1968 </div>
1969
1970 <!-- _______________________________________________________________________ -->
1971 <h4>
1972   <a name="t_array">Array Type</a>
1973 </h4>
1974
1975 <div>
1976
1977 <h5>Overview:</h5>
1978 <p>The array type is a very simple derived type that arranges elements
1979    sequentially in memory.  The array type requires a size (number of elements)
1980    and an underlying data type.</p>
1981
1982 <h5>Syntax:</h5>
1983 <pre>
1984   [&lt;# elements&gt; x &lt;elementtype&gt;]
1985 </pre>
1986
1987 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1988    be any type with a size.</p>
1989
1990 <h5>Examples:</h5>
1991 <table class="layout">
1992   <tr class="layout">
1993     <td class="left"><tt>[40 x i32]</tt></td>
1994     <td class="left">Array of 40 32-bit integer values.</td>
1995   </tr>
1996   <tr class="layout">
1997     <td class="left"><tt>[41 x i32]</tt></td>
1998     <td class="left">Array of 41 32-bit integer values.</td>
1999   </tr>
2000   <tr class="layout">
2001     <td class="left"><tt>[4 x i8]</tt></td>
2002     <td class="left">Array of 4 8-bit integer values.</td>
2003   </tr>
2004 </table>
2005 <p>Here are some examples of multidimensional arrays:</p>
2006 <table class="layout">
2007   <tr class="layout">
2008     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
2009     <td class="left">3x4 array of 32-bit integer values.</td>
2010   </tr>
2011   <tr class="layout">
2012     <td class="left"><tt>[12 x [10 x float]]</tt></td>
2013     <td class="left">12x10 array of single precision floating point values.</td>
2014   </tr>
2015   <tr class="layout">
2016     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
2017     <td class="left">2x3x4 array of 16-bit integer  values.</td>
2018   </tr>
2019 </table>
2020
2021 <p>There is no restriction on indexing beyond the end of the array implied by
2022    a static type (though there are restrictions on indexing beyond the bounds
2023    of an allocated object in some cases). This means that single-dimension
2024    'variable sized array' addressing can be implemented in LLVM with a zero
2025    length array type. An implementation of 'pascal style arrays' in LLVM could
2026    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
2027
2028 </div>
2029
2030 <!-- _______________________________________________________________________ -->
2031 <h4>
2032   <a name="t_function">Function Type</a>
2033 </h4>
2034
2035 <div>
2036
2037 <h5>Overview:</h5>
2038 <p>The function type can be thought of as a function signature.  It consists of
2039    a return type and a list of formal parameter types. The return type of a
2040    function type is a first class type or a void type.</p>
2041
2042 <h5>Syntax:</h5>
2043 <pre>
2044   &lt;returntype&gt; (&lt;parameter list&gt;)
2045 </pre>
2046
2047 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
2048    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
2049    which indicates that the function takes a variable number of arguments.
2050    Variable argument functions can access their arguments with
2051    the <a href="#int_varargs">variable argument handling intrinsic</a>
2052    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
2053    <a href="#t_label">label</a>.</p>
2054
2055 <h5>Examples:</h5>
2056 <table class="layout">
2057   <tr class="layout">
2058     <td class="left"><tt>i32 (i32)</tt></td>
2059     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
2060     </td>
2061   </tr><tr class="layout">
2062     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
2063     </tt></td>
2064     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
2065       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
2066       returning <tt>float</tt>.
2067     </td>
2068   </tr><tr class="layout">
2069     <td class="left"><tt>i32 (i8*, ...)</tt></td>
2070     <td class="left">A vararg function that takes at least one
2071       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
2072       which returns an integer.  This is the signature for <tt>printf</tt> in
2073       LLVM.
2074     </td>
2075   </tr><tr class="layout">
2076     <td class="left"><tt>{i32, i32} (i32)</tt></td>
2077     <td class="left">A function taking an <tt>i32</tt>, returning a
2078         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
2079     </td>
2080   </tr>
2081 </table>
2082
2083 </div>
2084
2085 <!-- _______________________________________________________________________ -->
2086 <h4>
2087   <a name="t_struct">Structure Type</a>
2088 </h4>
2089
2090 <div>
2091
2092 <h5>Overview:</h5>
2093 <p>The structure type is used to represent a collection of data members together
2094   in memory.  The elements of a structure may be any type that has a size.</p>
2095
2096 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
2097    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
2098    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
2099    Structures in registers are accessed using the
2100    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
2101    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
2102
2103 <p>Structures may optionally be "packed" structures, which indicate that the
2104   alignment of the struct is one byte, and that there is no padding between
2105   the elements.  In non-packed structs, padding between field types is inserted
2106   as defined by the TargetData string in the module, which is required to match
2107   what the underlying code generator expects.</p>
2108
2109 <p>Structures can either be "literal" or "identified".  A literal structure is
2110   defined inline with other types (e.g. <tt>{i32, i32}*</tt>) whereas identified
2111   types are always defined at the top level with a name.  Literal types are
2112   uniqued by their contents and can never be recursive or opaque since there is
2113   no way to write one.  Identified types can be recursive, can be opaqued, and are
2114   never uniqued.
2115 </p>
2116
2117 <h5>Syntax:</h5>
2118 <pre>
2119   %T1 = type { &lt;type list&gt; }     <i>; Identified normal struct type</i>
2120   %T2 = type &lt;{ &lt;type list&gt; }&gt;   <i>; Identified packed struct type</i>
2121 </pre>
2122
2123 <h5>Examples:</h5>
2124 <table class="layout">
2125   <tr class="layout">
2126     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
2127     <td class="left">A triple of three <tt>i32</tt> values</td>
2128   </tr>
2129   <tr class="layout">
2130     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
2131     <td class="left">A pair, where the first element is a <tt>float</tt> and the
2132       second element is a <a href="#t_pointer">pointer</a> to a
2133       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
2134       an <tt>i32</tt>.</td>
2135   </tr>
2136   <tr class="layout">
2137     <td class="left"><tt>&lt;{ i8, i32 }&gt;</tt></td>
2138     <td class="left">A packed struct known to be 5 bytes in size.</td>
2139   </tr>
2140 </table>
2141
2142 </div>
2143
2144 <!-- _______________________________________________________________________ -->
2145 <h4>
2146   <a name="t_opaque">Opaque Structure Types</a>
2147 </h4>
2148
2149 <div>
2150
2151 <h5>Overview:</h5>
2152 <p>Opaque structure types are used to represent named structure types that do
2153    not have a body specified.  This corresponds (for example) to the C notion of
2154    a forward declared structure.</p>
2155
2156 <h5>Syntax:</h5>
2157 <pre>
2158   %X = type opaque
2159   %52 = type opaque
2160 </pre>
2161
2162 <h5>Examples:</h5>
2163 <table class="layout">
2164   <tr class="layout">
2165     <td class="left"><tt>opaque</tt></td>
2166     <td class="left">An opaque type.</td>
2167   </tr>
2168 </table>
2169
2170 </div>
2171
2172
2173
2174 <!-- _______________________________________________________________________ -->
2175 <h4>
2176   <a name="t_pointer">Pointer Type</a>
2177 </h4>
2178
2179 <div>
2180
2181 <h5>Overview:</h5>
2182 <p>The pointer type is used to specify memory locations.
2183    Pointers are commonly used to reference objects in memory.</p>
2184
2185 <p>Pointer types may have an optional address space attribute defining the
2186    numbered address space where the pointed-to object resides. The default
2187    address space is number zero. The semantics of non-zero address
2188    spaces are target-specific.</p>
2189
2190 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
2191    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
2192
2193 <h5>Syntax:</h5>
2194 <pre>
2195   &lt;type&gt; *
2196 </pre>
2197
2198 <h5>Examples:</h5>
2199 <table class="layout">
2200   <tr class="layout">
2201     <td class="left"><tt>[4 x i32]*</tt></td>
2202     <td class="left">A <a href="#t_pointer">pointer</a> to <a
2203                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
2204   </tr>
2205   <tr class="layout">
2206     <td class="left"><tt>i32 (i32*) *</tt></td>
2207     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
2208       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
2209       <tt>i32</tt>.</td>
2210   </tr>
2211   <tr class="layout">
2212     <td class="left"><tt>i32 addrspace(5)*</tt></td>
2213     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
2214      that resides in address space #5.</td>
2215   </tr>
2216 </table>
2217
2218 </div>
2219
2220 <!-- _______________________________________________________________________ -->
2221 <h4>
2222   <a name="t_vector">Vector Type</a>
2223 </h4>
2224
2225 <div>
2226
2227 <h5>Overview:</h5>
2228 <p>A vector type is a simple derived type that represents a vector of elements.
2229    Vector types are used when multiple primitive data are operated in parallel
2230    using a single instruction (SIMD).  A vector type requires a size (number of
2231    elements) and an underlying primitive data type.  Vector types are considered
2232    <a href="#t_firstclass">first class</a>.</p>
2233
2234 <h5>Syntax:</h5>
2235 <pre>
2236   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
2237 </pre>
2238
2239 <p>The number of elements is a constant integer value larger than 0; elementtype
2240    may be any integer or floating point type, or a pointer to these types.
2241    Vectors of size zero are not allowed. </p>
2242
2243 <h5>Examples:</h5>
2244 <table class="layout">
2245   <tr class="layout">
2246     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
2247     <td class="left">Vector of 4 32-bit integer values.</td>
2248   </tr>
2249   <tr class="layout">
2250     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
2251     <td class="left">Vector of 8 32-bit floating-point values.</td>
2252   </tr>
2253   <tr class="layout">
2254     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
2255     <td class="left">Vector of 2 64-bit integer values.</td>
2256   </tr>
2257   <tr class="layout">
2258     <td class="left"><tt>&lt;4 x i64*&gt;</tt></td>
2259     <td class="left">Vector of 4 pointers to 64-bit integer values.</td>
2260   </tr>
2261 </table>
2262
2263 </div>
2264
2265 </div>
2266
2267 </div>
2268
2269 <!-- *********************************************************************** -->
2270 <h2><a name="constants">Constants</a></h2>
2271 <!-- *********************************************************************** -->
2272
2273 <div>
2274
2275 <p>LLVM has several different basic types of constants.  This section describes
2276    them all and their syntax.</p>
2277
2278 <!-- ======================================================================= -->
2279 <h3>
2280   <a name="simpleconstants">Simple Constants</a>
2281 </h3>
2282
2283 <div>
2284
2285 <dl>
2286   <dt><b>Boolean constants</b></dt>
2287   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2288       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2289
2290   <dt><b>Integer constants</b></dt>
2291   <dd>Standard integers (such as '4') are constants of
2292       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2293       with integer types.</dd>
2294
2295   <dt><b>Floating point constants</b></dt>
2296   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2297       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2298       notation (see below).  The assembler requires the exact decimal value of a
2299       floating-point constant.  For example, the assembler accepts 1.25 but
2300       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2301       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2302
2303   <dt><b>Null pointer constants</b></dt>
2304   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2305       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2306 </dl>
2307
2308 <p>The one non-intuitive notation for constants is the hexadecimal form of
2309    floating point constants.  For example, the form '<tt>double
2310    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2311    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2312    constants are required (and the only time that they are generated by the
2313    disassembler) is when a floating point constant must be emitted but it cannot
2314    be represented as a decimal floating point number in a reasonable number of
2315    digits.  For example, NaN's, infinities, and other special values are
2316    represented in their IEEE hexadecimal format so that assembly and disassembly
2317    do not cause any bits to change in the constants.</p>
2318
2319 <p>When using the hexadecimal form, constants of types half, float, and double are
2320    represented using the 16-digit form shown above (which matches the IEEE754
2321    representation for double); half and float values must, however, be exactly
2322    representable as IEE754 half and single precision, respectively.
2323    Hexadecimal format is always used
2324    for long double, and there are three forms of long double.  The 80-bit format
2325    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2326    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2327    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2328    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2329    currently supported target uses this format.  Long doubles will only work if
2330    they match the long double format on your target. The IEEE 16-bit format
2331    (half precision) is represented by <tt>0xH</tt> followed by 4 hexadecimal
2332    digits. All hexadecimal formats are big-endian (sign bit at the left).</p>
2333
2334 <p>There are no constants of type x86mmx.</p>
2335 </div>
2336
2337 <!-- ======================================================================= -->
2338 <h3>
2339 <a name="aggregateconstants"></a> <!-- old anchor -->
2340 <a name="complexconstants">Complex Constants</a>
2341 </h3>
2342
2343 <div>
2344
2345 <p>Complex constants are a (potentially recursive) combination of simple
2346    constants and smaller complex constants.</p>
2347
2348 <dl>
2349   <dt><b>Structure constants</b></dt>
2350   <dd>Structure constants are represented with notation similar to structure
2351       type definitions (a comma separated list of elements, surrounded by braces
2352       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2353       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2354       Structure constants must have <a href="#t_struct">structure type</a>, and
2355       the number and types of elements must match those specified by the
2356       type.</dd>
2357
2358   <dt><b>Array constants</b></dt>
2359   <dd>Array constants are represented with notation similar to array type
2360      definitions (a comma separated list of elements, surrounded by square
2361      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2362      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2363      the number and types of elements must match those specified by the
2364      type.</dd>
2365
2366   <dt><b>Vector constants</b></dt>
2367   <dd>Vector constants are represented with notation similar to vector type
2368       definitions (a comma separated list of elements, surrounded by
2369       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2370       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2371       have <a href="#t_vector">vector type</a>, and the number and types of
2372       elements must match those specified by the type.</dd>
2373
2374   <dt><b>Zero initialization</b></dt>
2375   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2376       value to zero of <em>any</em> type, including scalar and
2377       <a href="#t_aggregate">aggregate</a> types.
2378       This is often used to avoid having to print large zero initializers
2379       (e.g. for large arrays) and is always exactly equivalent to using explicit
2380       zero initializers.</dd>
2381
2382   <dt><b>Metadata node</b></dt>
2383   <dd>A metadata node is a structure-like constant with
2384       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2385       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2386       be interpreted as part of the instruction stream, metadata is a place to
2387       attach additional information such as debug info.</dd>
2388 </dl>
2389
2390 </div>
2391
2392 <!-- ======================================================================= -->
2393 <h3>
2394   <a name="globalconstants">Global Variable and Function Addresses</a>
2395 </h3>
2396
2397 <div>
2398
2399 <p>The addresses of <a href="#globalvars">global variables</a>
2400    and <a href="#functionstructure">functions</a> are always implicitly valid
2401    (link-time) constants.  These constants are explicitly referenced when
2402    the <a href="#identifiers">identifier for the global</a> is used and always
2403    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2404    legal LLVM file:</p>
2405
2406 <pre class="doc_code">
2407 @X = global i32 17
2408 @Y = global i32 42
2409 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2410 </pre>
2411
2412 </div>
2413
2414 <!-- ======================================================================= -->
2415 <h3>
2416   <a name="undefvalues">Undefined Values</a>
2417 </h3>
2418
2419 <div>
2420
2421 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2422    indicates that the user of the value may receive an unspecified bit-pattern.
2423    Undefined values may be of any type (other than '<tt>label</tt>'
2424    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2425
2426 <p>Undefined values are useful because they indicate to the compiler that the
2427    program is well defined no matter what value is used.  This gives the
2428    compiler more freedom to optimize.  Here are some examples of (potentially
2429    surprising) transformations that are valid (in pseudo IR):</p>
2430
2431
2432 <pre class="doc_code">
2433   %A = add %X, undef
2434   %B = sub %X, undef
2435   %C = xor %X, undef
2436 Safe:
2437   %A = undef
2438   %B = undef
2439   %C = undef
2440 </pre>
2441
2442 <p>This is safe because all of the output bits are affected by the undef bits.
2443    Any output bit can have a zero or one depending on the input bits.</p>
2444
2445 <pre class="doc_code">
2446   %A = or %X, undef
2447   %B = and %X, undef
2448 Safe:
2449   %A = -1
2450   %B = 0
2451 Unsafe:
2452   %A = undef
2453   %B = undef
2454 </pre>
2455
2456 <p>These logical operations have bits that are not always affected by the input.
2457    For example, if <tt>%X</tt> has a zero bit, then the output of the
2458    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2459    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2460    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2461    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2462    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2463    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2464    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2465
2466 <pre class="doc_code">
2467   %A = select undef, %X, %Y
2468   %B = select undef, 42, %Y
2469   %C = select %X, %Y, undef
2470 Safe:
2471   %A = %X     (or %Y)
2472   %B = 42     (or %Y)
2473   %C = %Y
2474 Unsafe:
2475   %A = undef
2476   %B = undef
2477   %C = undef
2478 </pre>
2479
2480 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2481    branch) conditions can go <em>either way</em>, but they have to come from one
2482    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2483    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2484    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2485    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2486    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2487    eliminated.</p>
2488
2489 <pre class="doc_code">
2490   %A = xor undef, undef
2491
2492   %B = undef
2493   %C = xor %B, %B
2494
2495   %D = undef
2496   %E = icmp lt %D, 4
2497   %F = icmp gte %D, 4
2498
2499 Safe:
2500   %A = undef
2501   %B = undef
2502   %C = undef
2503   %D = undef
2504   %E = undef
2505   %F = undef
2506 </pre>
2507
2508 <p>This example points out that two '<tt>undef</tt>' operands are not
2509    necessarily the same. This can be surprising to people (and also matches C
2510    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2511    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2512    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2513    its value over its "live range".  This is true because the variable doesn't
2514    actually <em>have a live range</em>. Instead, the value is logically read
2515    from arbitrary registers that happen to be around when needed, so the value
2516    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2517    need to have the same semantics or the core LLVM "replace all uses with"
2518    concept would not hold.</p>
2519
2520 <pre class="doc_code">
2521   %A = fdiv undef, %X
2522   %B = fdiv %X, undef
2523 Safe:
2524   %A = undef
2525 b: unreachable
2526 </pre>
2527
2528 <p>These examples show the crucial difference between an <em>undefined
2529   value</em> and <em>undefined behavior</em>. An undefined value (like
2530   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2531   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2532   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2533   defined on SNaN's. However, in the second example, we can make a more
2534   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2535   arbitrary value, we are allowed to assume that it could be zero. Since a
2536   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2537   the operation does not execute at all. This allows us to delete the divide and
2538   all code after it. Because the undefined operation "can't happen", the
2539   optimizer can assume that it occurs in dead code.</p>
2540
2541 <pre class="doc_code">
2542 a:  store undef -> %X
2543 b:  store %X -> undef
2544 Safe:
2545 a: &lt;deleted&gt;
2546 b: unreachable
2547 </pre>
2548
2549 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2550    undefined value can be assumed to not have any effect; we can assume that the
2551    value is overwritten with bits that happen to match what was already there.
2552    However, a store <em>to</em> an undefined location could clobber arbitrary
2553    memory, therefore, it has undefined behavior.</p>
2554
2555 </div>
2556
2557 <!-- ======================================================================= -->
2558 <h3>
2559   <a name="poisonvalues">Poison Values</a>
2560 </h3>
2561
2562 <div>
2563
2564 <p>Poison values are similar to <a href="#undefvalues">undef values</a>, however
2565    they also represent the fact that an instruction or constant expression which
2566    cannot evoke side effects has nevertheless detected a condition which results
2567    in undefined behavior.</p>
2568
2569 <p>There is currently no way of representing a poison value in the IR; they
2570    only exist when produced by operations such as
2571    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2572
2573 <p>Poison value behavior is defined in terms of value <i>dependence</i>:</p>
2574
2575 <ul>
2576 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2577     their operands.</li>
2578
2579 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2580     to their dynamic predecessor basic block.</li>
2581
2582 <li>Function arguments depend on the corresponding actual argument values in
2583     the dynamic callers of their functions.</li>
2584
2585 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2586     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2587     control back to them.</li>
2588
2589 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2590     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_resume"><tt>resume</tt></a>,
2591     or exception-throwing call instructions that dynamically transfer control
2592     back to them.</li>
2593
2594 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2595     referenced memory addresses, following the order in the IR
2596     (including loads and stores implied by intrinsics such as
2597     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2598
2599 <!-- TODO: In the case of multiple threads, this only applies if the store
2600      "happens-before" the load or store. -->
2601
2602 <!-- TODO: floating-point exception state -->
2603
2604 <li>An instruction with externally visible side effects depends on the most
2605     recent preceding instruction with externally visible side effects, following
2606     the order in the IR. (This includes
2607     <a href="#volatile">volatile operations</a>.)</li>
2608
2609 <li>An instruction <i>control-depends</i> on a
2610     <a href="#terminators">terminator instruction</a>
2611     if the terminator instruction has multiple successors and the instruction
2612     is always executed when control transfers to one of the successors, and
2613     may not be executed when control is transferred to another.</li>
2614
2615 <li>Additionally, an instruction also <i>control-depends</i> on a terminator
2616     instruction if the set of instructions it otherwise depends on would be
2617     different if the terminator had transferred control to a different
2618     successor.</li>
2619
2620 <li>Dependence is transitive.</li>
2621
2622 </ul>
2623
2624 <p>Poison Values have the same behavior as <a href="#undefvalues">undef values</a>,
2625    with the additional affect that any instruction which has a <i>dependence</i>
2626    on a poison value has undefined behavior.</p>
2627
2628 <p>Here are some examples:</p>
2629
2630 <pre class="doc_code">
2631 entry:
2632   %poison = sub nuw i32 0, 1           ; Results in a poison value.
2633   %still_poison = and i32 %poison, 0   ; 0, but also poison.
2634   %poison_yet_again = getelementptr i32* @h, i32 %still_poison
2635   store i32 0, i32* %poison_yet_again  ; memory at @h[0] is poisoned
2636
2637   store i32 %poison, i32* @g           ; Poison value stored to memory.
2638   %poison2 = load i32* @g              ; Poison value loaded back from memory.
2639
2640   store volatile i32 %poison, i32* @g  ; External observation; undefined behavior.
2641
2642   %narrowaddr = bitcast i32* @g to i16*
2643   %wideaddr = bitcast i32* @g to i64*
2644   %poison3 = load i16* %narrowaddr     ; Returns a poison value.
2645   %poison4 = load i64* %wideaddr       ; Returns a poison value.
2646
2647   %cmp = icmp slt i32 %poison, 0       ; Returns a poison value.
2648   br i1 %cmp, label %true, label %end  ; Branch to either destination.
2649
2650 true:
2651   store volatile i32 0, i32* @g        ; This is control-dependent on %cmp, so
2652                                        ; it has undefined behavior.
2653   br label %end
2654
2655 end:
2656   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2657                                        ; Both edges into this PHI are
2658                                        ; control-dependent on %cmp, so this
2659                                        ; always results in a poison value.
2660
2661   store volatile i32 0, i32* @g        ; This would depend on the store in %true
2662                                        ; if %cmp is true, or the store in %entry
2663                                        ; otherwise, so this is undefined behavior.
2664
2665   br i1 %cmp, label %second_true, label %second_end
2666                                        ; The same branch again, but this time the
2667                                        ; true block doesn't have side effects.
2668
2669 second_true:
2670   ; No side effects!
2671   ret void
2672
2673 second_end:
2674   store volatile i32 0, i32* @g        ; This time, the instruction always depends
2675                                        ; on the store in %end. Also, it is
2676                                        ; control-equivalent to %end, so this is
2677                                        ; well-defined (ignoring earlier undefined
2678                                        ; behavior in this example).
2679 </pre>
2680
2681 </div>
2682
2683 <!-- ======================================================================= -->
2684 <h3>
2685   <a name="blockaddress">Addresses of Basic Blocks</a>
2686 </h3>
2687
2688 <div>
2689
2690 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2691
2692 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2693    basic block in the specified function, and always has an i8* type.  Taking
2694    the address of the entry block is illegal.</p>
2695
2696 <p>This value only has defined behavior when used as an operand to the
2697    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2698    comparisons against null. Pointer equality tests between labels addresses
2699    results in undefined behavior &mdash; though, again, comparison against null
2700    is ok, and no label is equal to the null pointer. This may be passed around
2701    as an opaque pointer sized value as long as the bits are not inspected. This
2702    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2703    long as the original value is reconstituted before the <tt>indirectbr</tt>
2704    instruction.</p>
2705
2706 <p>Finally, some targets may provide defined semantics when using the value as
2707    the operand to an inline assembly, but that is target specific.</p>
2708
2709 </div>
2710
2711
2712 <!-- ======================================================================= -->
2713 <h3>
2714   <a name="constantexprs">Constant Expressions</a>
2715 </h3>
2716
2717 <div>
2718
2719 <p>Constant expressions are used to allow expressions involving other constants
2720    to be used as constants.  Constant expressions may be of
2721    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2722    operation that does not have side effects (e.g. load and call are not
2723    supported). The following is the syntax for constant expressions:</p>
2724
2725 <dl>
2726   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2727   <dd>Truncate a constant to another type. The bit size of CST must be larger
2728       than the bit size of TYPE. Both types must be integers.</dd>
2729
2730   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2731   <dd>Zero extend a constant to another type. The bit size of CST must be
2732       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2733
2734   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2735   <dd>Sign extend a constant to another type. The bit size of CST must be
2736       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2737
2738   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2739   <dd>Truncate a floating point constant to another floating point type. The
2740       size of CST must be larger than the size of TYPE. Both types must be
2741       floating point.</dd>
2742
2743   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2744   <dd>Floating point extend a constant to another type. The size of CST must be
2745       smaller or equal to the size of TYPE. Both types must be floating
2746       point.</dd>
2747
2748   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2749   <dd>Convert a floating point constant to the corresponding unsigned integer
2750       constant. TYPE must be a scalar or vector integer type. CST must be of
2751       scalar or vector floating point type. Both CST and TYPE must be scalars,
2752       or vectors of the same number of elements. If the value won't fit in the
2753       integer type, the results are undefined.</dd>
2754
2755   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2756   <dd>Convert a floating point constant to the corresponding signed integer
2757       constant.  TYPE must be a scalar or vector integer type. CST must be of
2758       scalar or vector floating point type. Both CST and TYPE must be scalars,
2759       or vectors of the same number of elements. If the value won't fit in the
2760       integer type, the results are undefined.</dd>
2761
2762   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2763   <dd>Convert an unsigned integer constant to the corresponding floating point
2764       constant. TYPE must be a scalar or vector floating point type. CST must be
2765       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2766       vectors of the same number of elements. If the value won't fit in the
2767       floating point type, the results are undefined.</dd>
2768
2769   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2770   <dd>Convert a signed integer constant to the corresponding floating point
2771       constant. TYPE must be a scalar or vector floating point type. CST must be
2772       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2773       vectors of the same number of elements. If the value won't fit in the
2774       floating point type, the results are undefined.</dd>
2775
2776   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2777   <dd>Convert a pointer typed constant to the corresponding integer constant
2778       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2779       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2780       make it fit in <tt>TYPE</tt>.</dd>
2781
2782   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2783   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2784       type.  CST must be of integer type. The CST value is zero extended,
2785       truncated, or unchanged to make it fit in a pointer size. This one is
2786       <i>really</i> dangerous!</dd>
2787
2788   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2789   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2790       are the same as those for the <a href="#i_bitcast">bitcast
2791       instruction</a>.</dd>
2792
2793   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2794   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2795   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2796       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2797       instruction, the index list may have zero or more indexes, which are
2798       required to make sense for the type of "CSTPTR".</dd>
2799
2800   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2801   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2802
2803   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2804   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2805
2806   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2807   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2808
2809   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2810   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2811       constants.</dd>
2812
2813   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2814   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2815     constants.</dd>
2816
2817   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2818   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2819       constants.</dd>
2820
2821   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2822   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2823     constants. The index list is interpreted in a similar manner as indices in
2824     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2825     index value must be specified.</dd>
2826
2827   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2828   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2829     constants. The index list is interpreted in a similar manner as indices in
2830     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2831     index value must be specified.</dd>
2832
2833   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2834   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2835       be any of the <a href="#binaryops">binary</a>
2836       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2837       on operands are the same as those for the corresponding instruction
2838       (e.g. no bitwise operations on floating point values are allowed).</dd>
2839 </dl>
2840
2841 </div>
2842
2843 </div>
2844
2845 <!-- *********************************************************************** -->
2846 <h2><a name="othervalues">Other Values</a></h2>
2847 <!-- *********************************************************************** -->
2848 <div>
2849 <!-- ======================================================================= -->
2850 <h3>
2851 <a name="inlineasm">Inline Assembler Expressions</a>
2852 </h3>
2853
2854 <div>
2855
2856 <p>LLVM supports inline assembler expressions (as opposed
2857    to <a href="#moduleasm">Module-Level Inline Assembly</a>) through the use of
2858    a special value.  This value represents the inline assembler as a string
2859    (containing the instructions to emit), a list of operand constraints (stored
2860    as a string), a flag that indicates whether or not the inline asm
2861    expression has side effects, and a flag indicating whether the function
2862    containing the asm needs to align its stack conservatively.  An example
2863    inline assembler expression is:</p>
2864
2865 <pre class="doc_code">
2866 i32 (i32) asm "bswap $0", "=r,r"
2867 </pre>
2868
2869 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2870    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2871    have:</p>
2872
2873 <pre class="doc_code">
2874 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2875 </pre>
2876
2877 <p>Inline asms with side effects not visible in the constraint list must be
2878    marked as having side effects.  This is done through the use of the
2879    '<tt>sideeffect</tt>' keyword, like so:</p>
2880
2881 <pre class="doc_code">
2882 call void asm sideeffect "eieio", ""()
2883 </pre>
2884
2885 <p>In some cases inline asms will contain code that will not work unless the
2886    stack is aligned in some way, such as calls or SSE instructions on x86,
2887    yet will not contain code that does that alignment within the asm.
2888    The compiler should make conservative assumptions about what the asm might
2889    contain and should generate its usual stack alignment code in the prologue
2890    if the '<tt>alignstack</tt>' keyword is present:</p>
2891
2892 <pre class="doc_code">
2893 call void asm alignstack "eieio", ""()
2894 </pre>
2895
2896 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2897    first.</p>
2898
2899 <!--
2900 <p>TODO: The format of the asm and constraints string still need to be
2901    documented here.  Constraints on what can be done (e.g. duplication, moving,
2902    etc need to be documented).  This is probably best done by reference to
2903    another document that covers inline asm from a holistic perspective.</p>
2904   -->
2905
2906 <!-- _______________________________________________________________________ -->
2907 <h4>
2908   <a name="inlineasm_md">Inline Asm Metadata</a>
2909 </h4>
2910
2911 <div>
2912
2913 <p>The call instructions that wrap inline asm nodes may have a
2914    "<tt>!srcloc</tt>" MDNode attached to it that contains a list of constant
2915    integers.  If present, the code generator will use the integer as the
2916    location cookie value when report errors through the <tt>LLVMContext</tt>
2917    error reporting mechanisms.  This allows a front-end to correlate backend
2918    errors that occur with inline asm back to the source code that produced it.
2919    For example:</p>
2920
2921 <pre class="doc_code">
2922 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2923 ...
2924 !42 = !{ i32 1234567 }
2925 </pre>
2926
2927 <p>It is up to the front-end to make sense of the magic numbers it places in the
2928    IR. If the MDNode contains multiple constants, the code generator will use
2929    the one that corresponds to the line of the asm that the error occurs on.</p>
2930
2931 </div>
2932
2933 </div>
2934
2935 <!-- ======================================================================= -->
2936 <h3>
2937   <a name="metadata">Metadata Nodes and Metadata Strings</a>
2938 </h3>
2939
2940 <div>
2941
2942 <p>LLVM IR allows metadata to be attached to instructions in the program that
2943    can convey extra information about the code to the optimizers and code
2944    generator.  One example application of metadata is source-level debug
2945    information.  There are two metadata primitives: strings and nodes. All
2946    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2947    preceding exclamation point ('<tt>!</tt>').</p>
2948
2949 <p>A metadata string is a string surrounded by double quotes.  It can contain
2950    any character by escaping non-printable characters with "<tt>\xx</tt>" where
2951    "<tt>xx</tt>" is the two digit hex code.  For example:
2952    "<tt>!"test\00"</tt>".</p>
2953
2954 <p>Metadata nodes are represented with notation similar to structure constants
2955    (a comma separated list of elements, surrounded by braces and preceded by an
2956    exclamation point). Metadata nodes can have any values as their operand. For
2957    example:</p>
2958
2959 <div class="doc_code">
2960 <pre>
2961 !{ metadata !"test\00", i32 10}
2962 </pre>
2963 </div>
2964
2965 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2966    metadata nodes, which can be looked up in the module symbol table. For
2967    example:</p>
2968
2969 <div class="doc_code">
2970 <pre>
2971 !foo =  metadata !{!4, !3}
2972 </pre>
2973 </div>
2974
2975 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2976    function is using two metadata arguments:</p>
2977
2978 <div class="doc_code">
2979 <pre>
2980 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2981 </pre>
2982 </div>
2983
2984 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2985    attached to the <tt>add</tt> instruction using the <tt>!dbg</tt>
2986    identifier:</p>
2987
2988 <div class="doc_code">
2989 <pre>
2990 %indvar.next = add i64 %indvar, 1, !dbg !21
2991 </pre>
2992 </div>
2993
2994 <p>More information about specific metadata nodes recognized by the optimizers
2995    and code generator is found below.</p>
2996
2997 <!-- _______________________________________________________________________ -->
2998 <h4>
2999   <a name="tbaa">'<tt>tbaa</tt>' Metadata</a>
3000 </h4>
3001
3002 <div>
3003
3004 <p>In LLVM IR, memory does not have types, so LLVM's own type system is not
3005    suitable for doing TBAA. Instead, metadata is added to the IR to describe
3006    a type system of a higher level language. This can be used to implement
3007    typical C/C++ TBAA, but it can also be used to implement custom alias
3008    analysis behavior for other languages.</p>
3009
3010 <p>The current metadata format is very simple. TBAA metadata nodes have up to
3011    three fields, e.g.:</p>
3012
3013 <div class="doc_code">
3014 <pre>
3015 !0 = metadata !{ metadata !"an example type tree" }
3016 !1 = metadata !{ metadata !"int", metadata !0 }
3017 !2 = metadata !{ metadata !"float", metadata !0 }
3018 !3 = metadata !{ metadata !"const float", metadata !2, i64 1 }
3019 </pre>
3020 </div>
3021
3022 <p>The first field is an identity field. It can be any value, usually
3023    a metadata string, which uniquely identifies the type. The most important
3024    name in the tree is the name of the root node. Two trees with
3025    different root node names are entirely disjoint, even if they
3026    have leaves with common names.</p>
3027
3028 <p>The second field identifies the type's parent node in the tree, or
3029    is null or omitted for a root node. A type is considered to alias
3030    all of its descendants and all of its ancestors in the tree. Also,
3031    a type is considered to alias all types in other trees, so that
3032    bitcode produced from multiple front-ends is handled conservatively.</p>
3033
3034 <p>If the third field is present, it's an integer which if equal to 1
3035    indicates that the type is "constant" (meaning
3036    <tt>pointsToConstantMemory</tt> should return true; see
3037    <a href="AliasAnalysis.html#OtherItfs">other useful
3038    <tt>AliasAnalysis</tt> methods</a>).</p>
3039
3040 </div>
3041
3042 <!-- _______________________________________________________________________ -->
3043 <h4>
3044   <a name="fpmath">'<tt>fpmath</tt>' Metadata</a>
3045 </h4>
3046
3047 <div>
3048
3049 <p><tt>fpmath</tt> metadata may be attached to any instruction of floating point
3050   type.  It can be used to express the maximum acceptable error in the result of
3051   that instruction, in ULPs, thus potentially allowing the compiler to use a
3052   more efficient but less accurate method of computing it.  ULP is defined as
3053   follows:</p>
3054
3055 <blockquote>
3056
3057 <p>If <tt>x</tt> is a real number that lies between two finite consecutive
3058    floating-point numbers <tt>a</tt> and <tt>b</tt>, without being equal to one
3059    of them, then <tt>ulp(x) = |b - a|</tt>, otherwise <tt>ulp(x)</tt> is the
3060    distance between the two non-equal finite floating-point numbers nearest
3061    <tt>x</tt>. Moreover, <tt>ulp(NaN)</tt> is <tt>NaN</tt>.</p>
3062
3063 </blockquote>
3064
3065 <p>The metadata node shall consist of a single positive floating point number
3066    representing the maximum relative error, for example:</p>
3067
3068 <div class="doc_code">
3069 <pre>
3070 !0 = metadata !{ float 2.5 } ; maximum acceptable inaccuracy is 2.5 ULPs
3071 </pre>
3072 </div>
3073
3074 </div>
3075
3076 <!-- _______________________________________________________________________ -->
3077 <h4>
3078   <a name="range">'<tt>range</tt>' Metadata</a>
3079 </h4>
3080
3081 <div>
3082 <p><tt>range</tt> metadata may be attached only to loads of integer types. It
3083    expresses the possible ranges the loaded value is in. The ranges are
3084    represented with a flattened list of integers. The loaded value is known to
3085    be in the union of the ranges defined by each consecutive pair. Each pair
3086    has the following properties:</p>
3087 <ul>
3088    <li>The type must match the type loaded by the instruction.</li>
3089    <li>The pair <tt>a,b</tt> represents the range <tt>[a,b)</tt>.</li>
3090    <li>Both <tt>a</tt> and <tt>b</tt> are constants.</li>
3091    <li>The range is allowed to wrap.</li>
3092    <li>The range should not represent the full or empty set. That is,
3093        <tt>a!=b</tt>. </li>
3094 </ul>
3095 <p> In addition, the pairs must be in signed order of the lower bound and
3096   they must be non-contiguous.</p>
3097
3098 <p>Examples:</p>
3099 <div class="doc_code">
3100 <pre>
3101   %a = load i8* %x, align 1, !range !0 ; Can only be 0 or 1
3102   %b = load i8* %y, align 1, !range !1 ; Can only be 255 (-1), 0 or 1
3103   %c = load i8* %z, align 1, !range !2 ; Can only be 0, 1, 3, 4 or 5
3104   %d = load i8* %z, align 1, !range !3 ; Can only be -2, -1, 3, 4 or 5
3105 ...
3106 !0 = metadata !{ i8 0, i8 2 }
3107 !1 = metadata !{ i8 255, i8 2 }
3108 !2 = metadata !{ i8 0, i8 2, i8 3, i8 6 }
3109 !3 = metadata !{ i8 -2, i8 0, i8 3, i8 6 }
3110 </pre>
3111 </div>
3112 </div>
3113 </div>
3114
3115 </div>
3116
3117 <!-- *********************************************************************** -->
3118 <h2>
3119   <a name="module_flags">Module Flags Metadata</a>
3120 </h2>
3121 <!-- *********************************************************************** -->
3122
3123 <div>
3124
3125 <p>Information about the module as a whole is difficult to convey to LLVM's
3126    subsystems. The LLVM IR isn't sufficient to transmit this
3127    information. The <tt>llvm.module.flags</tt> named metadata exists in order to
3128    facilitate this. These flags are in the form of key / value pairs &mdash;
3129    much like a dictionary &mdash; making it easy for any subsystem who cares
3130    about a flag to look it up.</p>
3131
3132 <p>The <tt>llvm.module.flags</tt> metadata contains a list of metadata
3133    triplets. Each triplet has the following form:</p>
3134
3135 <ul>
3136   <li>The first element is a <i>behavior</i> flag, which specifies the behavior
3137       when two (or more) modules are merged together, and it encounters two (or
3138       more) metadata with the same ID. The supported behaviors are described
3139       below.</li>
3140
3141   <li>The second element is a metadata string that is a unique ID for the
3142       metadata. How each ID is interpreted is documented below.</li>
3143
3144   <li>The third element is the value of the flag.</li>
3145 </ul>
3146
3147 <p>When two (or more) modules are merged together, the resulting
3148    <tt>llvm.module.flags</tt> metadata is the union of the
3149    modules' <tt>llvm.module.flags</tt> metadata. The only exception being a flag
3150    with the <i>Override</i> behavior, which may override another flag's value
3151    (see below).</p>
3152
3153 <p>The following behaviors are supported:</p>
3154
3155 <table border="1" cellspacing="0" cellpadding="4">
3156   <tbody>
3157     <tr>
3158       <th>Value</th>
3159       <th>Behavior</th>
3160     </tr>
3161     <tr>
3162       <td>1</td>
3163       <td align="left">
3164         <dl>
3165           <dt><b>Error</b></dt>
3166           <dd>Emits an error if two values disagree. It is an error to have an ID
3167               with both an Error and a Warning behavior.</dd>
3168         </dl>
3169       </td>
3170     </tr>
3171     <tr>
3172       <td>2</td>
3173       <td align="left">
3174         <dl>
3175           <dt><b>Warning</b></dt>
3176           <dd>Emits a warning if two values disagree.</dd>
3177         </dl>
3178       </td>
3179     </tr>
3180     <tr>
3181       <td>3</td>
3182       <td align="left">
3183         <dl>
3184           <dt><b>Require</b></dt>
3185           <dd>Emits an error when the specified value is not present or doesn't
3186               have the specified value. It is an error for two (or more)
3187               <tt>llvm.module.flags</tt> with the same ID to have the Require
3188               behavior but different values. There may be multiple Require flags
3189               per ID.</dd>
3190         </dl>
3191       </td>
3192     </tr>
3193     <tr>
3194       <td>4</td>
3195       <td align="left">
3196         <dl>
3197           <dt><b>Override</b></dt>
3198           <dd>Uses the specified value if the two values disagree. It is an
3199               error for two (or more) <tt>llvm.module.flags</tt> with the same
3200               ID to have the Override behavior but different values.</dd>
3201         </dl>
3202       </td>
3203     </tr>
3204   </tbody>
3205 </table>
3206
3207 <p>An example of module flags:</p>
3208
3209 <pre class="doc_code">
3210 !0 = metadata !{ i32 1, metadata !"foo", i32 1 }
3211 !1 = metadata !{ i32 4, metadata !"bar", i32 37 }
3212 !2 = metadata !{ i32 2, metadata !"qux", i32 42 }
3213 !3 = metadata !{ i32 3, metadata !"qux",
3214   metadata !{
3215     metadata !"foo", i32 1
3216   }
3217 }
3218 !llvm.module.flags = !{ !0, !1, !2, !3 }
3219 </pre>
3220
3221 <ul>
3222   <li><p>Metadata <tt>!0</tt> has the ID <tt>!"foo"</tt> and the value '1'. The
3223          behavior if two or more <tt>!"foo"</tt> flags are seen is to emit an
3224          error if their values are not equal.</p></li>
3225
3226   <li><p>Metadata <tt>!1</tt> has the ID <tt>!"bar"</tt> and the value '37'. The
3227          behavior if two or more <tt>!"bar"</tt> flags are seen is to use the
3228          value '37' if their values are not equal.</p></li>
3229
3230   <li><p>Metadata <tt>!2</tt> has the ID <tt>!"qux"</tt> and the value '42'. The
3231          behavior if two or more <tt>!"qux"</tt> flags are seen is to emit a
3232          warning if their values are not equal.</p></li>
3233
3234   <li><p>Metadata <tt>!3</tt> has the ID <tt>!"qux"</tt> and the value:</p>
3235
3236 <pre class="doc_code">
3237 metadata !{ metadata !"foo", i32 1 }
3238 </pre>
3239
3240       <p>The behavior is to emit an error if the <tt>llvm.module.flags</tt> does
3241          not contain a flag with the ID <tt>!"foo"</tt> that has the value
3242          '1'. If two or more <tt>!"qux"</tt> flags exist, then they must have
3243          the same value or an error will be issued.</p></li>
3244 </ul>
3245
3246
3247 <!-- ======================================================================= -->
3248 <h3>
3249 <a name="objc_gc_flags">Objective-C Garbage Collection Module Flags Metadata</a>
3250 </h3>
3251
3252 <div>
3253
3254 <p>On the Mach-O platform, Objective-C stores metadata about garbage collection
3255    in a special section called "image info". The metadata consists of a version
3256    number and a bitmask specifying what types of garbage collection are
3257    supported (if any) by the file. If two or more modules are linked together
3258    their garbage collection metadata needs to be merged rather than appended
3259    together.</p>
3260
3261 <p>The Objective-C garbage collection module flags metadata consists of the
3262    following key-value pairs:</p>
3263
3264 <table border="1" cellspacing="0" cellpadding="4">
3265   <col width="30%">
3266   <tbody>
3267     <tr>
3268       <th>Key</th>
3269       <th>Value</th>
3270     </tr>
3271     <tr>
3272       <td><tt>Objective-C&nbsp;Version</tt></td>
3273       <td align="left"><b>[Required]</b> &mdash; The Objective-C ABI
3274          version. Valid values are 1 and 2.</td>
3275     </tr>
3276     <tr>
3277       <td><tt>Objective-C&nbsp;Image&nbsp;Info&nbsp;Version</tt></td>
3278       <td align="left"><b>[Required]</b> &mdash; The version of the image info
3279          section. Currently always 0.</td>
3280     </tr>
3281     <tr>
3282       <td><tt>Objective-C&nbsp;Image&nbsp;Info&nbsp;Section</tt></td>
3283       <td align="left"><b>[Required]</b> &mdash; The section to place the
3284          metadata. Valid values are <tt>"__OBJC, __image_info, regular"</tt> for
3285          Objective-C ABI version 1, and <tt>"__DATA,__objc_imageinfo, regular,
3286          no_dead_strip"</tt> for Objective-C ABI version 2.</td>
3287     </tr>
3288     <tr>
3289       <td><tt>Objective-C&nbsp;Garbage&nbsp;Collection</tt></td>
3290       <td align="left"><b>[Required]</b> &mdash; Specifies whether garbage
3291           collection is supported or not. Valid values are 0, for no garbage
3292           collection, and 2, for garbage collection supported.</td>
3293     </tr>
3294     <tr>
3295       <td><tt>Objective-C&nbsp;GC&nbsp;Only</tt></td>
3296       <td align="left"><b>[Optional]</b> &mdash; Specifies that only garbage
3297          collection is supported. If present, its value must be 6. This flag
3298          requires that the <tt>Objective-C Garbage Collection</tt> flag have the
3299          value 2.</td>
3300     </tr>
3301   </tbody>
3302 </table>
3303
3304 <p>Some important flag interactions:</p>
3305
3306 <ul>
3307   <li>If a module with <tt>Objective-C Garbage Collection</tt> set to 0 is
3308       merged with a module with <tt>Objective-C Garbage Collection</tt> set to
3309       2, then the resulting module has the <tt>Objective-C Garbage
3310       Collection</tt> flag set to 0.</li>
3311
3312   <li>A module with <tt>Objective-C Garbage Collection</tt> set to 0 cannot be
3313       merged with a module with <tt>Objective-C GC Only</tt> set to 6.</li>
3314 </ul>
3315
3316 </div>
3317
3318 </div>
3319
3320 <!-- *********************************************************************** -->
3321 <h2>
3322   <a name="intrinsic_globals">Intrinsic Global Variables</a>
3323 </h2>
3324 <!-- *********************************************************************** -->
3325 <div>
3326 <p>LLVM has a number of "magic" global variables that contain data that affect
3327 code generation or other IR semantics.  These are documented here.  All globals
3328 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
3329 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
3330 by LLVM.</p>
3331
3332 <!-- ======================================================================= -->
3333 <h3>
3334 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
3335 </h3>
3336
3337 <div>
3338
3339 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
3340 href="#linkage_appending">appending linkage</a>.  This array contains a list of
3341 pointers to global variables and functions which may optionally have a pointer
3342 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
3343
3344 <div class="doc_code">
3345 <pre>
3346 @X = global i8 4
3347 @Y = global i32 123
3348
3349 @llvm.used = appending global [2 x i8*] [
3350    i8* @X,
3351    i8* bitcast (i32* @Y to i8*)
3352 ], section "llvm.metadata"
3353 </pre>
3354 </div>
3355
3356 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
3357    compiler, assembler, and linker are required to treat the symbol as if there
3358    is a reference to the global that it cannot see.  For example, if a variable
3359    has internal linkage and no references other than that from
3360    the <tt>@llvm.used</tt> list, it cannot be deleted.  This is commonly used to
3361    represent references from inline asms and other things the compiler cannot
3362    "see", and corresponds to "<tt>attribute((used))</tt>" in GNU C.</p>
3363
3364 <p>On some targets, the code generator must emit a directive to the assembler or
3365    object file to prevent the assembler and linker from molesting the
3366    symbol.</p>
3367
3368 </div>
3369
3370 <!-- ======================================================================= -->
3371 <h3>
3372   <a name="intg_compiler_used">
3373     The '<tt>llvm.compiler.used</tt>' Global Variable
3374   </a>
3375 </h3>
3376
3377 <div>
3378
3379 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
3380    <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
3381    touching the symbol.  On targets that support it, this allows an intelligent
3382    linker to optimize references to the symbol without being impeded as it would
3383    be by <tt>@llvm.used</tt>.</p>
3384
3385 <p>This is a rare construct that should only be used in rare circumstances, and
3386    should not be exposed to source languages.</p>
3387
3388 </div>
3389
3390 <!-- ======================================================================= -->
3391 <h3>
3392 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
3393 </h3>
3394
3395 <div>
3396
3397 <div class="doc_code">
3398 <pre>
3399 %0 = type { i32, void ()* }
3400 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
3401 </pre>
3402 </div>
3403
3404 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor
3405    functions and associated priorities.  The functions referenced by this array
3406    will be called in ascending order of priority (i.e. lowest first) when the
3407    module is loaded.  The order of functions with the same priority is not
3408    defined.</p>
3409
3410 </div>
3411
3412 <!-- ======================================================================= -->
3413 <h3>
3414 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
3415 </h3>
3416
3417 <div>
3418
3419 <div class="doc_code">
3420 <pre>
3421 %0 = type { i32, void ()* }
3422 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
3423 </pre>
3424 </div>
3425
3426 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions
3427    and associated priorities.  The functions referenced by this array will be
3428    called in descending order of priority (i.e. highest first) when the module
3429    is loaded.  The order of functions with the same priority is not defined.</p>
3430
3431 </div>
3432
3433 </div>
3434
3435 <!-- *********************************************************************** -->
3436 <h2><a name="instref">Instruction Reference</a></h2>
3437 <!-- *********************************************************************** -->
3438
3439 <div>
3440
3441 <p>The LLVM instruction set consists of several different classifications of
3442    instructions: <a href="#terminators">terminator
3443    instructions</a>, <a href="#binaryops">binary instructions</a>,
3444    <a href="#bitwiseops">bitwise binary instructions</a>,
3445    <a href="#memoryops">memory instructions</a>, and
3446    <a href="#otherops">other instructions</a>.</p>
3447
3448 <!-- ======================================================================= -->
3449 <h3>
3450   <a name="terminators">Terminator Instructions</a>
3451 </h3>
3452
3453 <div>
3454
3455 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
3456    in a program ends with a "Terminator" instruction, which indicates which
3457    block should be executed after the current block is finished. These
3458    terminator instructions typically yield a '<tt>void</tt>' value: they produce
3459    control flow, not values (the one exception being the
3460    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
3461
3462 <p>The terminator instructions are:
3463    '<a href="#i_ret"><tt>ret</tt></a>',
3464    '<a href="#i_br"><tt>br</tt></a>',
3465    '<a href="#i_switch"><tt>switch</tt></a>',
3466    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>',
3467    '<a href="#i_invoke"><tt>invoke</tt></a>',
3468    '<a href="#i_resume"><tt>resume</tt></a>', and
3469    '<a href="#i_unreachable"><tt>unreachable</tt></a>'.</p>
3470
3471 <!-- _______________________________________________________________________ -->
3472 <h4>
3473   <a name="i_ret">'<tt>ret</tt>' Instruction</a>
3474 </h4>
3475
3476 <div>
3477
3478 <h5>Syntax:</h5>
3479 <pre>
3480   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
3481   ret void                 <i>; Return from void function</i>
3482 </pre>
3483
3484 <h5>Overview:</h5>
3485 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
3486    a value) from a function back to the caller.</p>
3487
3488 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
3489    value and then causes control flow, and one that just causes control flow to
3490    occur.</p>
3491
3492 <h5>Arguments:</h5>
3493 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
3494    return value. The type of the return value must be a
3495    '<a href="#t_firstclass">first class</a>' type.</p>
3496
3497 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
3498    non-void return type and contains a '<tt>ret</tt>' instruction with no return
3499    value or a return value with a type that does not match its type, or if it
3500    has a void return type and contains a '<tt>ret</tt>' instruction with a
3501    return value.</p>
3502
3503 <h5>Semantics:</h5>
3504 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
3505    the calling function's context.  If the caller is a
3506    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
3507    instruction after the call.  If the caller was an
3508    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
3509    the beginning of the "normal" destination block.  If the instruction returns
3510    a value, that value shall set the call or invoke instruction's return
3511    value.</p>
3512
3513 <h5>Example:</h5>
3514 <pre>
3515   ret i32 5                       <i>; Return an integer value of 5</i>
3516   ret void                        <i>; Return from a void function</i>
3517   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
3518 </pre>
3519
3520 </div>
3521 <!-- _______________________________________________________________________ -->
3522 <h4>
3523   <a name="i_br">'<tt>br</tt>' Instruction</a>
3524 </h4>
3525
3526 <div>
3527
3528 <h5>Syntax:</h5>
3529 <pre>
3530   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
3531   br label &lt;dest&gt;          <i>; Unconditional branch</i>
3532 </pre>
3533
3534 <h5>Overview:</h5>
3535 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
3536    different basic block in the current function.  There are two forms of this
3537    instruction, corresponding to a conditional branch and an unconditional
3538    branch.</p>
3539
3540 <h5>Arguments:</h5>
3541 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
3542    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
3543    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
3544    target.</p>
3545
3546 <h5>Semantics:</h5>
3547 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
3548    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
3549    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
3550    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
3551
3552 <h5>Example:</h5>
3553 <pre>
3554 Test:
3555   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
3556   br i1 %cond, label %IfEqual, label %IfUnequal
3557 IfEqual:
3558   <a href="#i_ret">ret</a> i32 1
3559 IfUnequal:
3560   <a href="#i_ret">ret</a> i32 0
3561 </pre>
3562
3563 </div>
3564
3565 <!-- _______________________________________________________________________ -->
3566 <h4>
3567    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
3568 </h4>
3569
3570 <div>
3571
3572 <h5>Syntax:</h5>
3573 <pre>
3574   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
3575 </pre>
3576
3577 <h5>Overview:</h5>
3578 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
3579    several different places.  It is a generalization of the '<tt>br</tt>'
3580    instruction, allowing a branch to occur to one of many possible
3581    destinations.</p>
3582
3583 <h5>Arguments:</h5>
3584 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
3585    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
3586    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
3587    The table is not allowed to contain duplicate constant entries.</p>
3588
3589 <h5>Semantics:</h5>
3590 <p>The <tt>switch</tt> instruction specifies a table of values and
3591    destinations. When the '<tt>switch</tt>' instruction is executed, this table
3592    is searched for the given value.  If the value is found, control flow is
3593    transferred to the corresponding destination; otherwise, control flow is
3594    transferred to the default destination.</p>
3595
3596 <h5>Implementation:</h5>
3597 <p>Depending on properties of the target machine and the particular
3598    <tt>switch</tt> instruction, this instruction may be code generated in
3599    different ways.  For example, it could be generated as a series of chained
3600    conditional branches or with a lookup table.</p>
3601
3602 <h5>Example:</h5>
3603 <pre>
3604  <i>; Emulate a conditional br instruction</i>
3605  %Val = <a href="#i_zext">zext</a> i1 %value to i32
3606  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
3607
3608  <i>; Emulate an unconditional br instruction</i>
3609  switch i32 0, label %dest [ ]
3610
3611  <i>; Implement a jump table:</i>
3612  switch i32 %val, label %otherwise [ i32 0, label %onzero
3613                                      i32 1, label %onone
3614                                      i32 2, label %ontwo ]
3615 </pre>
3616
3617 </div>
3618
3619
3620 <!-- _______________________________________________________________________ -->
3621 <h4>
3622    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
3623 </h4>
3624
3625 <div>
3626
3627 <h5>Syntax:</h5>
3628 <pre>
3629   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3630 </pre>
3631
3632 <h5>Overview:</h5>
3633
3634 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3635    within the current function, whose address is specified by
3636    "<tt>address</tt>".  Address must be derived from a <a
3637    href="#blockaddress">blockaddress</a> constant.</p>
3638
3639 <h5>Arguments:</h5>
3640
3641 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3642    rest of the arguments indicate the full set of possible destinations that the
3643    address may point to.  Blocks are allowed to occur multiple times in the
3644    destination list, though this isn't particularly useful.</p>
3645
3646 <p>This destination list is required so that dataflow analysis has an accurate
3647    understanding of the CFG.</p>
3648
3649 <h5>Semantics:</h5>
3650
3651 <p>Control transfers to the block specified in the address argument.  All
3652    possible destination blocks must be listed in the label list, otherwise this
3653    instruction has undefined behavior.  This implies that jumps to labels
3654    defined in other functions have undefined behavior as well.</p>
3655
3656 <h5>Implementation:</h5>
3657
3658 <p>This is typically implemented with a jump through a register.</p>
3659
3660 <h5>Example:</h5>
3661 <pre>
3662  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3663 </pre>
3664
3665 </div>
3666
3667
3668 <!-- _______________________________________________________________________ -->
3669 <h4>
3670   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3671 </h4>
3672
3673 <div>
3674
3675 <h5>Syntax:</h5>
3676 <pre>
3677   &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>]
3678                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3679 </pre>
3680
3681 <h5>Overview:</h5>
3682 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3683    function, with the possibility of control flow transfer to either the
3684    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3685    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3686    control flow will return to the "normal" label.  If the callee (or any
3687    indirect callees) returns via the "<a href="#i_resume"><tt>resume</tt></a>"
3688    instruction or other exception handling mechanism, control is interrupted and
3689    continued at the dynamically nearest "exception" label.</p>
3690
3691 <p>The '<tt>exception</tt>' label is a
3692    <i><a href="ExceptionHandling.html#overview">landing pad</a></i> for the
3693    exception. As such, '<tt>exception</tt>' label is required to have the
3694    "<a href="#i_landingpad"><tt>landingpad</tt></a>" instruction, which contains
3695    the information about the behavior of the program after unwinding
3696    happens, as its first non-PHI instruction. The restrictions on the
3697    "<tt>landingpad</tt>" instruction's tightly couples it to the
3698    "<tt>invoke</tt>" instruction, so that the important information contained
3699    within the "<tt>landingpad</tt>" instruction can't be lost through normal
3700    code motion.</p>
3701
3702 <h5>Arguments:</h5>
3703 <p>This instruction requires several arguments:</p>
3704
3705 <ol>
3706   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3707       convention</a> the call should use.  If none is specified, the call
3708       defaults to using C calling conventions.</li>
3709
3710   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3711       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3712       '<tt>inreg</tt>' attributes are valid here.</li>
3713
3714   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3715       function value being invoked.  In most cases, this is a direct function
3716       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3717       off an arbitrary pointer to function value.</li>
3718
3719   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3720       function to be invoked. </li>
3721
3722   <li>'<tt>function args</tt>': argument list whose types match the function
3723       signature argument types and parameter attributes. All arguments must be
3724       of <a href="#t_firstclass">first class</a> type. If the function
3725       signature indicates the function accepts a variable number of arguments,
3726       the extra arguments can be specified.</li>
3727
3728   <li>'<tt>normal label</tt>': the label reached when the called function
3729       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3730
3731   <li>'<tt>exception label</tt>': the label reached when a callee returns via
3732       the <a href="#i_resume"><tt>resume</tt></a> instruction or other exception
3733       handling mechanism.</li>
3734
3735   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3736       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3737       '<tt>readnone</tt>' attributes are valid here.</li>
3738 </ol>
3739
3740 <h5>Semantics:</h5>
3741 <p>This instruction is designed to operate as a standard
3742    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3743    primary difference is that it establishes an association with a label, which
3744    is used by the runtime library to unwind the stack.</p>
3745
3746 <p>This instruction is used in languages with destructors to ensure that proper
3747    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3748    exception.  Additionally, this is important for implementation of
3749    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3750
3751 <p>For the purposes of the SSA form, the definition of the value returned by the
3752    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3753    block to the "normal" label. If the callee unwinds then no return value is
3754    available.</p>
3755
3756 <h5>Example:</h5>
3757 <pre>
3758   %retval = invoke i32 @Test(i32 15) to label %Continue
3759               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3760   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3761               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3762 </pre>
3763
3764 </div>
3765
3766  <!-- _______________________________________________________________________ -->
3767
3768 <h4>
3769   <a name="i_resume">'<tt>resume</tt>' Instruction</a>
3770 </h4>
3771
3772 <div>
3773
3774 <h5>Syntax:</h5>
3775 <pre>
3776   resume &lt;type&gt; &lt;value&gt;
3777 </pre>
3778
3779 <h5>Overview:</h5>
3780 <p>The '<tt>resume</tt>' instruction is a terminator instruction that has no
3781    successors.</p>
3782
3783 <h5>Arguments:</h5>
3784 <p>The '<tt>resume</tt>' instruction requires one argument, which must have the
3785    same type as the result of any '<tt>landingpad</tt>' instruction in the same
3786    function.</p>
3787
3788 <h5>Semantics:</h5>
3789 <p>The '<tt>resume</tt>' instruction resumes propagation of an existing
3790    (in-flight) exception whose unwinding was interrupted with
3791    a <a href="#i_landingpad"><tt>landingpad</tt></a> instruction.</p>
3792
3793 <h5>Example:</h5>
3794 <pre>
3795   resume { i8*, i32 } %exn
3796 </pre>
3797
3798 </div>
3799
3800 <!-- _______________________________________________________________________ -->
3801
3802 <h4>
3803   <a name="i_unreachable">'<tt>unreachable</tt>' Instruction</a>
3804 </h4>
3805
3806 <div>
3807
3808 <h5>Syntax:</h5>
3809 <pre>
3810   unreachable
3811 </pre>
3812
3813 <h5>Overview:</h5>
3814 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3815    instruction is used to inform the optimizer that a particular portion of the
3816    code is not reachable.  This can be used to indicate that the code after a
3817    no-return function cannot be reached, and other facts.</p>
3818
3819 <h5>Semantics:</h5>
3820 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3821
3822 </div>
3823
3824 </div>
3825
3826 <!-- ======================================================================= -->
3827 <h3>
3828   <a name="binaryops">Binary Operations</a>
3829 </h3>
3830
3831 <div>
3832
3833 <p>Binary operators are used to do most of the computation in a program.  They
3834    require two operands of the same type, execute an operation on them, and
3835    produce a single value.  The operands might represent multiple data, as is
3836    the case with the <a href="#t_vector">vector</a> data type.  The result value
3837    has the same type as its operands.</p>
3838
3839 <p>There are several different binary operators:</p>
3840
3841 <!-- _______________________________________________________________________ -->
3842 <h4>
3843   <a name="i_add">'<tt>add</tt>' Instruction</a>
3844 </h4>
3845
3846 <div>
3847
3848 <h5>Syntax:</h5>
3849 <pre>
3850   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3851   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3852   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3853   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3854 </pre>
3855
3856 <h5>Overview:</h5>
3857 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3858
3859 <h5>Arguments:</h5>
3860 <p>The two arguments to the '<tt>add</tt>' instruction must
3861    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3862    integer values. Both arguments must have identical types.</p>
3863
3864 <h5>Semantics:</h5>
3865 <p>The value produced is the integer sum of the two operands.</p>
3866
3867 <p>If the sum has unsigned overflow, the result returned is the mathematical
3868    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3869
3870 <p>Because LLVM integers use a two's complement representation, this instruction
3871    is appropriate for both signed and unsigned integers.</p>
3872
3873 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3874    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3875    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3876    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
3877    respectively, occurs.</p>
3878
3879 <h5>Example:</h5>
3880 <pre>
3881   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3882 </pre>
3883
3884 </div>
3885
3886 <!-- _______________________________________________________________________ -->
3887 <h4>
3888   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3889 </h4>
3890
3891 <div>
3892
3893 <h5>Syntax:</h5>
3894 <pre>
3895   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3896 </pre>
3897
3898 <h5>Overview:</h5>
3899 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3900
3901 <h5>Arguments:</h5>
3902 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3903    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3904    floating point values. Both arguments must have identical types.</p>
3905
3906 <h5>Semantics:</h5>
3907 <p>The value produced is the floating point sum of the two operands.</p>
3908
3909 <h5>Example:</h5>
3910 <pre>
3911   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3912 </pre>
3913
3914 </div>
3915
3916 <!-- _______________________________________________________________________ -->
3917 <h4>
3918    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3919 </h4>
3920
3921 <div>
3922
3923 <h5>Syntax:</h5>
3924 <pre>
3925   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3926   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3927   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3928   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3929 </pre>
3930
3931 <h5>Overview:</h5>
3932 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3933    operands.</p>
3934
3935 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3936    '<tt>neg</tt>' instruction present in most other intermediate
3937    representations.</p>
3938
3939 <h5>Arguments:</h5>
3940 <p>The two arguments to the '<tt>sub</tt>' instruction must
3941    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3942    integer values.  Both arguments must have identical types.</p>
3943
3944 <h5>Semantics:</h5>
3945 <p>The value produced is the integer difference of the two operands.</p>
3946
3947 <p>If the difference has unsigned overflow, the result returned is the
3948    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3949    result.</p>
3950
3951 <p>Because LLVM integers use a two's complement representation, this instruction
3952    is appropriate for both signed and unsigned integers.</p>
3953
3954 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3955    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3956    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3957    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
3958    respectively, occurs.</p>
3959
3960 <h5>Example:</h5>
3961 <pre>
3962   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3963   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3964 </pre>
3965
3966 </div>
3967
3968 <!-- _______________________________________________________________________ -->
3969 <h4>
3970    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3971 </h4>
3972
3973 <div>
3974
3975 <h5>Syntax:</h5>
3976 <pre>
3977   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3978 </pre>
3979
3980 <h5>Overview:</h5>
3981 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3982    operands.</p>
3983
3984 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3985    '<tt>fneg</tt>' instruction present in most other intermediate
3986    representations.</p>
3987
3988 <h5>Arguments:</h5>
3989 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3990    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3991    floating point values.  Both arguments must have identical types.</p>
3992
3993 <h5>Semantics:</h5>
3994 <p>The value produced is the floating point difference of the two operands.</p>
3995
3996 <h5>Example:</h5>
3997 <pre>
3998   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3999   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
4000 </pre>
4001
4002 </div>
4003
4004 <!-- _______________________________________________________________________ -->
4005 <h4>
4006   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
4007 </h4>
4008
4009 <div>
4010
4011 <h5>Syntax:</h5>
4012 <pre>
4013   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
4014   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
4015   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
4016   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
4017 </pre>
4018
4019 <h5>Overview:</h5>
4020 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
4021
4022 <h5>Arguments:</h5>
4023 <p>The two arguments to the '<tt>mul</tt>' instruction must
4024    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
4025    integer values.  Both arguments must have identical types.</p>
4026
4027 <h5>Semantics:</h5>
4028 <p>The value produced is the integer product of the two operands.</p>
4029
4030 <p>If the result of the multiplication has unsigned overflow, the result
4031    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
4032    width of the result.</p>
4033
4034 <p>Because LLVM integers use a two's complement representation, and the result
4035    is the same width as the operands, this instruction returns the correct
4036    result for both signed and unsigned integers.  If a full product
4037    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
4038    be sign-extended or zero-extended as appropriate to the width of the full
4039    product.</p>
4040
4041 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
4042    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
4043    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
4044    is a <a href="#poisonvalues">poison value</a> if unsigned and/or signed overflow,
4045    respectively, occurs.</p>
4046
4047 <h5>Example:</h5>
4048 <pre>
4049   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
4050 </pre>
4051
4052 </div>
4053
4054 <!-- _______________________________________________________________________ -->
4055 <h4>
4056   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
4057 </h4>
4058
4059 <div>
4060
4061 <h5>Syntax:</h5>
4062 <pre>
4063   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4064 </pre>
4065
4066 <h5>Overview:</h5>
4067 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
4068
4069 <h5>Arguments:</h5>
4070 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
4071    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4072    floating point values.  Both arguments must have identical types.</p>
4073
4074 <h5>Semantics:</h5>
4075 <p>The value produced is the floating point product of the two operands.</p>
4076
4077 <h5>Example:</h5>
4078 <pre>
4079   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
4080 </pre>
4081
4082 </div>
4083
4084 <!-- _______________________________________________________________________ -->
4085 <h4>
4086   <a name="i_udiv">'<tt>udiv</tt>' Instruction</a>
4087 </h4>
4088
4089 <div>
4090
4091 <h5>Syntax:</h5>
4092 <pre>
4093   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4094   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4095 </pre>
4096
4097 <h5>Overview:</h5>
4098 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
4099
4100 <h5>Arguments:</h5>
4101 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
4102    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4103    values.  Both arguments must have identical types.</p>
4104
4105 <h5>Semantics:</h5>
4106 <p>The value produced is the unsigned integer quotient of the two operands.</p>
4107
4108 <p>Note that unsigned integer division and signed integer division are distinct
4109    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
4110
4111 <p>Division by zero leads to undefined behavior.</p>
4112
4113 <p>If the <tt>exact</tt> keyword is present, the result value of the
4114    <tt>udiv</tt> is a <a href="#poisonvalues">poison value</a> if %op1 is not a
4115   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
4116
4117
4118 <h5>Example:</h5>
4119 <pre>
4120   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
4121 </pre>
4122
4123 </div>
4124
4125 <!-- _______________________________________________________________________ -->
4126 <h4>
4127   <a name="i_sdiv">'<tt>sdiv</tt>' Instruction</a>
4128 </h4>
4129
4130 <div>
4131
4132 <h5>Syntax:</h5>
4133 <pre>
4134   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4135   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4136 </pre>
4137
4138 <h5>Overview:</h5>
4139 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
4140
4141 <h5>Arguments:</h5>
4142 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
4143    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4144    values.  Both arguments must have identical types.</p>
4145
4146 <h5>Semantics:</h5>
4147 <p>The value produced is the signed integer quotient of the two operands rounded
4148    towards zero.</p>
4149
4150 <p>Note that signed integer division and unsigned integer division are distinct
4151    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
4152
4153 <p>Division by zero leads to undefined behavior. Overflow also leads to
4154    undefined behavior; this is a rare case, but can occur, for example, by doing
4155    a 32-bit division of -2147483648 by -1.</p>
4156
4157 <p>If the <tt>exact</tt> keyword is present, the result value of the
4158    <tt>sdiv</tt> is a <a href="#poisonvalues">poison value</a> if the result would
4159    be rounded.</p>
4160
4161 <h5>Example:</h5>
4162 <pre>
4163   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
4164 </pre>
4165
4166 </div>
4167
4168 <!-- _______________________________________________________________________ -->
4169 <h4>
4170   <a name="i_fdiv">'<tt>fdiv</tt>' Instruction</a>
4171 </h4>
4172
4173 <div>
4174
4175 <h5>Syntax:</h5>
4176 <pre>
4177   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4178 </pre>
4179
4180 <h5>Overview:</h5>
4181 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
4182
4183 <h5>Arguments:</h5>
4184 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
4185    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4186    floating point values.  Both arguments must have identical types.</p>
4187
4188 <h5>Semantics:</h5>
4189 <p>The value produced is the floating point quotient of the two operands.</p>
4190
4191 <h5>Example:</h5>
4192 <pre>
4193   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
4194 </pre>
4195
4196 </div>
4197
4198 <!-- _______________________________________________________________________ -->
4199 <h4>
4200   <a name="i_urem">'<tt>urem</tt>' Instruction</a>
4201 </h4>
4202
4203 <div>
4204
4205 <h5>Syntax:</h5>
4206 <pre>
4207   &lt;result&gt; = urem &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>urem</tt>' instruction returns the remainder from the unsigned
4212    division of its two arguments.</p>
4213
4214 <h5>Arguments:</h5>
4215 <p>The two arguments to the '<tt>urem</tt>' instruction must be
4216    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4217    values.  Both arguments must have identical types.</p>
4218
4219 <h5>Semantics:</h5>
4220 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
4221    This instruction always performs an unsigned division to get the
4222    remainder.</p>
4223
4224 <p>Note that unsigned integer remainder and signed integer remainder are
4225    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
4226
4227 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
4228
4229 <h5>Example:</h5>
4230 <pre>
4231   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4232 </pre>
4233
4234 </div>
4235
4236 <!-- _______________________________________________________________________ -->
4237 <h4>
4238   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
4239 </h4>
4240
4241 <div>
4242
4243 <h5>Syntax:</h5>
4244 <pre>
4245   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4246 </pre>
4247
4248 <h5>Overview:</h5>
4249 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
4250    division of its two operands. This instruction can also take
4251    <a href="#t_vector">vector</a> versions of the values in which case the
4252    elements must be integers.</p>
4253
4254 <h5>Arguments:</h5>
4255 <p>The two arguments to the '<tt>srem</tt>' instruction must be
4256    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4257    values.  Both arguments must have identical types.</p>
4258
4259 <h5>Semantics:</h5>
4260 <p>This instruction returns the <i>remainder</i> of a division (where the result
4261    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
4262    <i>modulo</i> operator (where the result is either zero or has the same sign
4263    as the divisor, <tt>op2</tt>) of a value.
4264    For more information about the difference,
4265    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
4266    Math Forum</a>. For a table of how this is implemented in various languages,
4267    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
4268    Wikipedia: modulo operation</a>.</p>
4269
4270 <p>Note that signed integer remainder and unsigned integer remainder are
4271    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
4272
4273 <p>Taking the remainder of a division by zero leads to undefined behavior.
4274    Overflow also leads to undefined behavior; this is a rare case, but can
4275    occur, for example, by taking the remainder of a 32-bit division of
4276    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
4277    lets srem be implemented using instructions that return both the result of
4278    the division and the remainder.)</p>
4279
4280 <h5>Example:</h5>
4281 <pre>
4282   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
4283 </pre>
4284
4285 </div>
4286
4287 <!-- _______________________________________________________________________ -->
4288 <h4>
4289   <a name="i_frem">'<tt>frem</tt>' Instruction</a>
4290 </h4>
4291
4292 <div>
4293
4294 <h5>Syntax:</h5>
4295 <pre>
4296   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4297 </pre>
4298
4299 <h5>Overview:</h5>
4300 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
4301    its two operands.</p>
4302
4303 <h5>Arguments:</h5>
4304 <p>The two arguments to the '<tt>frem</tt>' instruction must be
4305    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
4306    floating point values.  Both arguments must have identical types.</p>
4307
4308 <h5>Semantics:</h5>
4309 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
4310    has the same sign as the dividend.</p>
4311
4312 <h5>Example:</h5>
4313 <pre>
4314   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
4315 </pre>
4316
4317 </div>
4318
4319 </div>
4320
4321 <!-- ======================================================================= -->
4322 <h3>
4323   <a name="bitwiseops">Bitwise Binary Operations</a>
4324 </h3>
4325
4326 <div>
4327
4328 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
4329    program.  They are generally very efficient instructions and can commonly be
4330    strength reduced from other instructions.  They require two operands of the
4331    same type, execute an operation on them, and produce a single value.  The
4332    resulting value is the same type as its operands.</p>
4333
4334 <!-- _______________________________________________________________________ -->
4335 <h4>
4336   <a name="i_shl">'<tt>shl</tt>' Instruction</a>
4337 </h4>
4338
4339 <div>
4340
4341 <h5>Syntax:</h5>
4342 <pre>
4343   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
4344   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4345   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
4346   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4347 </pre>
4348
4349 <h5>Overview:</h5>
4350 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
4351    a specified number of bits.</p>
4352
4353 <h5>Arguments:</h5>
4354 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
4355     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
4356     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4357
4358 <h5>Semantics:</h5>
4359 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
4360    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
4361    is (statically or dynamically) negative or equal to or larger than the number
4362    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
4363    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4364    shift amount in <tt>op2</tt>.</p>
4365
4366 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
4367    <a href="#poisonvalues">poison value</a> if it shifts out any non-zero bits.  If
4368    the <tt>nsw</tt> keyword is present, then the shift produces a
4369    <a href="#poisonvalues">poison value</a> if it shifts out any bits that disagree
4370    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
4371    they would if the shift were expressed as a mul instruction with the same
4372    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
4373
4374 <h5>Example:</h5>
4375 <pre>
4376   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
4377   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
4378   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
4379   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
4380   &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>
4381 </pre>
4382
4383 </div>
4384
4385 <!-- _______________________________________________________________________ -->
4386 <h4>
4387   <a name="i_lshr">'<tt>lshr</tt>' Instruction</a>
4388 </h4>
4389
4390 <div>
4391
4392 <h5>Syntax:</h5>
4393 <pre>
4394   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4395   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4396 </pre>
4397
4398 <h5>Overview:</h5>
4399 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
4400    operand shifted to the right a specified number of bits with zero fill.</p>
4401
4402 <h5>Arguments:</h5>
4403 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
4404    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4405    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
4406
4407 <h5>Semantics:</h5>
4408 <p>This instruction always performs a logical shift right operation. The most
4409    significant bits of the result will be filled with zero bits after the shift.
4410    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
4411    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
4412    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
4413    shift amount in <tt>op2</tt>.</p>
4414
4415 <p>If the <tt>exact</tt> keyword is present, the result value of the
4416    <tt>lshr</tt> is a <a href="#poisonvalues">poison value</a> if any of the bits
4417    shifted out are non-zero.</p>
4418
4419
4420 <h5>Example:</h5>
4421 <pre>
4422   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
4423   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
4424   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
4425   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
4426   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
4427   &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>
4428 </pre>
4429
4430 </div>
4431
4432 <!-- _______________________________________________________________________ -->
4433 <h4>
4434   <a name="i_ashr">'<tt>ashr</tt>' Instruction</a>
4435 </h4>
4436
4437 <div>
4438
4439 <h5>Syntax:</h5>
4440 <pre>
4441   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
4442   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4443 </pre>
4444
4445 <h5>Overview:</h5>
4446 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
4447    operand shifted to the right a specified number of bits with sign
4448    extension.</p>
4449
4450 <h5>Arguments:</h5>
4451 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
4452    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4453    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
4454
4455 <h5>Semantics:</h5>
4456 <p>This instruction always performs an arithmetic shift right operation, The
4457    most significant bits of the result will be filled with the sign bit
4458    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
4459    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
4460    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
4461    the corresponding shift amount in <tt>op2</tt>.</p>
4462
4463 <p>If the <tt>exact</tt> keyword is present, the result value of the
4464    <tt>ashr</tt> is a <a href="#poisonvalues">poison value</a> if any of the bits
4465    shifted out are non-zero.</p>
4466
4467 <h5>Example:</h5>
4468 <pre>
4469   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
4470   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
4471   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
4472   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
4473   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
4474   &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>
4475 </pre>
4476
4477 </div>
4478
4479 <!-- _______________________________________________________________________ -->
4480 <h4>
4481   <a name="i_and">'<tt>and</tt>' Instruction</a>
4482 </h4>
4483
4484 <div>
4485
4486 <h5>Syntax:</h5>
4487 <pre>
4488   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4489 </pre>
4490
4491 <h5>Overview:</h5>
4492 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
4493    operands.</p>
4494
4495 <h5>Arguments:</h5>
4496 <p>The two arguments to the '<tt>and</tt>' instruction must be
4497    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4498    values.  Both arguments must have identical types.</p>
4499
4500 <h5>Semantics:</h5>
4501 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
4502
4503 <table border="1" cellspacing="0" cellpadding="4">
4504   <tbody>
4505     <tr>
4506       <th>In0</th>
4507       <th>In1</th>
4508       <th>Out</th>
4509     </tr>
4510     <tr>
4511       <td>0</td>
4512       <td>0</td>
4513       <td>0</td>
4514     </tr>
4515     <tr>
4516       <td>0</td>
4517       <td>1</td>
4518       <td>0</td>
4519     </tr>
4520     <tr>
4521       <td>1</td>
4522       <td>0</td>
4523       <td>0</td>
4524     </tr>
4525     <tr>
4526       <td>1</td>
4527       <td>1</td>
4528       <td>1</td>
4529     </tr>
4530   </tbody>
4531 </table>
4532
4533 <h5>Example:</h5>
4534 <pre>
4535   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
4536   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
4537   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
4538 </pre>
4539 </div>
4540 <!-- _______________________________________________________________________ -->
4541 <h4>
4542   <a name="i_or">'<tt>or</tt>' Instruction</a>
4543 </h4>
4544
4545 <div>
4546
4547 <h5>Syntax:</h5>
4548 <pre>
4549   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4550 </pre>
4551
4552 <h5>Overview:</h5>
4553 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
4554    two operands.</p>
4555
4556 <h5>Arguments:</h5>
4557 <p>The two arguments to the '<tt>or</tt>' instruction must be
4558    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4559    values.  Both arguments must have identical types.</p>
4560
4561 <h5>Semantics:</h5>
4562 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
4563
4564 <table border="1" cellspacing="0" cellpadding="4">
4565   <tbody>
4566     <tr>
4567       <th>In0</th>
4568       <th>In1</th>
4569       <th>Out</th>
4570     </tr>
4571     <tr>
4572       <td>0</td>
4573       <td>0</td>
4574       <td>0</td>
4575     </tr>
4576     <tr>
4577       <td>0</td>
4578       <td>1</td>
4579       <td>1</td>
4580     </tr>
4581     <tr>
4582       <td>1</td>
4583       <td>0</td>
4584       <td>1</td>
4585     </tr>
4586     <tr>
4587       <td>1</td>
4588       <td>1</td>
4589       <td>1</td>
4590     </tr>
4591   </tbody>
4592 </table>
4593
4594 <h5>Example:</h5>
4595 <pre>
4596   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
4597   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
4598   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
4599 </pre>
4600
4601 </div>
4602
4603 <!-- _______________________________________________________________________ -->
4604 <h4>
4605   <a name="i_xor">'<tt>xor</tt>' Instruction</a>
4606 </h4>
4607
4608 <div>
4609
4610 <h5>Syntax:</h5>
4611 <pre>
4612   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4613 </pre>
4614
4615 <h5>Overview:</h5>
4616 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
4617    its two operands.  The <tt>xor</tt> is used to implement the "one's
4618    complement" operation, which is the "~" operator in C.</p>
4619
4620 <h5>Arguments:</h5>
4621 <p>The two arguments to the '<tt>xor</tt>' instruction must be
4622    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
4623    values.  Both arguments must have identical types.</p>
4624
4625 <h5>Semantics:</h5>
4626 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
4627
4628 <table border="1" cellspacing="0" cellpadding="4">
4629   <tbody>
4630     <tr>
4631       <th>In0</th>
4632       <th>In1</th>
4633       <th>Out</th>
4634     </tr>
4635     <tr>
4636       <td>0</td>
4637       <td>0</td>
4638       <td>0</td>
4639     </tr>
4640     <tr>
4641       <td>0</td>
4642       <td>1</td>
4643       <td>1</td>
4644     </tr>
4645     <tr>
4646       <td>1</td>
4647       <td>0</td>
4648       <td>1</td>
4649     </tr>
4650     <tr>
4651       <td>1</td>
4652       <td>1</td>
4653       <td>0</td>
4654     </tr>
4655   </tbody>
4656 </table>
4657
4658 <h5>Example:</h5>
4659 <pre>
4660   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4661   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4662   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4663   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4664 </pre>
4665
4666 </div>
4667
4668 </div>
4669
4670 <!-- ======================================================================= -->
4671 <h3>
4672   <a name="vectorops">Vector Operations</a>
4673 </h3>
4674
4675 <div>
4676
4677 <p>LLVM supports several instructions to represent vector operations in a
4678    target-independent manner.  These instructions cover the element-access and
4679    vector-specific operations needed to process vectors effectively.  While LLVM
4680    does directly support these vector operations, many sophisticated algorithms
4681    will want to use target-specific intrinsics to take full advantage of a
4682    specific target.</p>
4683
4684 <!-- _______________________________________________________________________ -->
4685 <h4>
4686    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4687 </h4>
4688
4689 <div>
4690
4691 <h5>Syntax:</h5>
4692 <pre>
4693   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4694 </pre>
4695
4696 <h5>Overview:</h5>
4697 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4698    from a vector at a specified index.</p>
4699
4700
4701 <h5>Arguments:</h5>
4702 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4703    of <a href="#t_vector">vector</a> type.  The second operand is an index
4704    indicating the position from which to extract the element.  The index may be
4705    a variable.</p>
4706
4707 <h5>Semantics:</h5>
4708 <p>The result is a scalar of the same type as the element type of
4709    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4710    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4711    results are undefined.</p>
4712
4713 <h5>Example:</h5>
4714 <pre>
4715   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4716 </pre>
4717
4718 </div>
4719
4720 <!-- _______________________________________________________________________ -->
4721 <h4>
4722    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4723 </h4>
4724
4725 <div>
4726
4727 <h5>Syntax:</h5>
4728 <pre>
4729   &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>
4730 </pre>
4731
4732 <h5>Overview:</h5>
4733 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4734    vector at a specified index.</p>
4735
4736 <h5>Arguments:</h5>
4737 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4738    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4739    whose type must equal the element type of the first operand.  The third
4740    operand is an index indicating the position at which to insert the value.
4741    The index may be a variable.</p>
4742
4743 <h5>Semantics:</h5>
4744 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4745    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4746    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4747    results are undefined.</p>
4748
4749 <h5>Example:</h5>
4750 <pre>
4751   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4752 </pre>
4753
4754 </div>
4755
4756 <!-- _______________________________________________________________________ -->
4757 <h4>
4758    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4759 </h4>
4760
4761 <div>
4762
4763 <h5>Syntax:</h5>
4764 <pre>
4765   &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>
4766 </pre>
4767
4768 <h5>Overview:</h5>
4769 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4770    from two input vectors, returning a vector with the same element type as the
4771    input and length that is the same as the shuffle mask.</p>
4772
4773 <h5>Arguments:</h5>
4774 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4775    with the same type.  The third argument is a shuffle mask whose
4776    element type is always 'i32'.  The result of the instruction is a vector
4777    whose length is the same as the shuffle mask and whose element type is the
4778    same as the element type of the first two operands.</p>
4779
4780 <p>The shuffle mask operand is required to be a constant vector with either
4781    constant integer or undef values.</p>
4782
4783 <h5>Semantics:</h5>
4784 <p>The elements of the two input vectors are numbered from left to right across
4785    both of the vectors.  The shuffle mask operand specifies, for each element of
4786    the result vector, which element of the two input vectors the result element
4787    gets.  The element selector may be undef (meaning "don't care") and the
4788    second operand may be undef if performing a shuffle from only one vector.</p>
4789
4790 <h5>Example:</h5>
4791 <pre>
4792   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4793                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4794   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4795                           &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.
4796   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4797                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4798   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4799                           &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>
4800 </pre>
4801
4802 </div>
4803
4804 </div>
4805
4806 <!-- ======================================================================= -->
4807 <h3>
4808   <a name="aggregateops">Aggregate Operations</a>
4809 </h3>
4810
4811 <div>
4812
4813 <p>LLVM supports several instructions for working with
4814   <a href="#t_aggregate">aggregate</a> values.</p>
4815
4816 <!-- _______________________________________________________________________ -->
4817 <h4>
4818    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4819 </h4>
4820
4821 <div>
4822
4823 <h5>Syntax:</h5>
4824 <pre>
4825   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4826 </pre>
4827
4828 <h5>Overview:</h5>
4829 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4830    from an <a href="#t_aggregate">aggregate</a> value.</p>
4831
4832 <h5>Arguments:</h5>
4833 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4834    of <a href="#t_struct">struct</a> or
4835    <a href="#t_array">array</a> type.  The operands are constant indices to
4836    specify which value to extract in a similar manner as indices in a
4837    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4838    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4839      <ul>
4840        <li>Since the value being indexed is not a pointer, the first index is
4841            omitted and assumed to be zero.</li>
4842        <li>At least one index must be specified.</li>
4843        <li>Not only struct indices but also array indices must be in
4844            bounds.</li>
4845      </ul>
4846
4847 <h5>Semantics:</h5>
4848 <p>The result is the value at the position in the aggregate specified by the
4849    index operands.</p>
4850
4851 <h5>Example:</h5>
4852 <pre>
4853   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4854 </pre>
4855
4856 </div>
4857
4858 <!-- _______________________________________________________________________ -->
4859 <h4>
4860    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4861 </h4>
4862
4863 <div>
4864
4865 <h5>Syntax:</h5>
4866 <pre>
4867   &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>
4868 </pre>
4869
4870 <h5>Overview:</h5>
4871 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4872    in an <a href="#t_aggregate">aggregate</a> value.</p>
4873
4874 <h5>Arguments:</h5>
4875 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4876    of <a href="#t_struct">struct</a> or
4877    <a href="#t_array">array</a> type.  The second operand is a first-class
4878    value to insert.  The following operands are constant indices indicating
4879    the position at which to insert the value in a similar manner as indices in a
4880    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4881    value to insert must have the same type as the value identified by the
4882    indices.</p>
4883
4884 <h5>Semantics:</h5>
4885 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4886    that of <tt>val</tt> except that the value at the position specified by the
4887    indices is that of <tt>elt</tt>.</p>
4888
4889 <h5>Example:</h5>
4890 <pre>
4891   %agg1 = insertvalue {i32, float} undef, i32 1, 0              <i>; yields {i32 1, float undef}</i>
4892   %agg2 = insertvalue {i32, float} %agg1, float %val, 1         <i>; yields {i32 1, float %val}</i>
4893   %agg3 = insertvalue {i32, {float}} %agg1, float %val, 1, 0    <i>; yields {i32 1, float %val}</i>
4894 </pre>
4895
4896 </div>
4897
4898 </div>
4899
4900 <!-- ======================================================================= -->
4901 <h3>
4902   <a name="memoryops">Memory Access and Addressing Operations</a>
4903 </h3>
4904
4905 <div>
4906
4907 <p>A key design point of an SSA-based representation is how it represents
4908    memory.  In LLVM, no memory locations are in SSA form, which makes things
4909    very simple.  This section describes how to read, write, and allocate
4910    memory in LLVM.</p>
4911
4912 <!-- _______________________________________________________________________ -->
4913 <h4>
4914   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4915 </h4>
4916
4917 <div>
4918
4919 <h5>Syntax:</h5>
4920 <pre>
4921   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4922 </pre>
4923
4924 <h5>Overview:</h5>
4925 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4926    currently executing function, to be automatically released when this function
4927    returns to its caller. The object is always allocated in the generic address
4928    space (address space zero).</p>
4929
4930 <h5>Arguments:</h5>
4931 <p>The '<tt>alloca</tt>' instruction
4932    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4933    runtime stack, returning a pointer of the appropriate type to the program.
4934    If "NumElements" is specified, it is the number of elements allocated,
4935    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4936    specified, the value result of the allocation is guaranteed to be aligned to
4937    at least that boundary.  If not specified, or if zero, the target can choose
4938    to align the allocation on any convenient boundary compatible with the
4939    type.</p>
4940
4941 <p>'<tt>type</tt>' may be any sized type.</p>
4942
4943 <h5>Semantics:</h5>
4944 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4945    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4946    memory is automatically released when the function returns.  The
4947    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4948    variables that must have an address available.  When the function returns
4949    (either with the <tt><a href="#i_ret">ret</a></tt>
4950    or <tt><a href="#i_resume">resume</a></tt> instructions), the memory is
4951    reclaimed.  Allocating zero bytes is legal, but the result is undefined.
4952    The order in which memory is allocated (ie., which way the stack grows) is
4953    not specified.</p>
4954
4955 <p>
4956
4957 <h5>Example:</h5>
4958 <pre>
4959   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4960   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4961   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4962   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4963 </pre>
4964
4965 </div>
4966
4967 <!-- _______________________________________________________________________ -->
4968 <h4>
4969   <a name="i_load">'<tt>load</tt>' Instruction</a>
4970 </h4>
4971
4972 <div>
4973
4974 <h5>Syntax:</h5>
4975 <pre>
4976   &lt;result&gt; = load [volatile] &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;][, !invariant.load !&lt;index&gt;]
4977   &lt;result&gt; = load atomic [volatile] &lt;ty&gt;* &lt;pointer&gt; [singlethread] &lt;ordering&gt;, align &lt;alignment&gt;
4978   !&lt;index&gt; = !{ i32 1 }
4979 </pre>
4980
4981 <h5>Overview:</h5>
4982 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4983
4984 <h5>Arguments:</h5>
4985 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4986    from which to load.  The pointer must point to
4987    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4988    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4989    number or order of execution of this <tt>load</tt> with other <a
4990    href="#volatile">volatile operations</a>.</p>
4991
4992 <p>If the <code>load</code> is marked as <code>atomic</code>, it takes an extra
4993    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
4994    argument.  The <code>release</code> and <code>acq_rel</code> orderings are
4995    not valid on <code>load</code> instructions.  Atomic loads produce <a
4996    href="#memorymodel">defined</a> results when they may see multiple atomic
4997    stores.  The type of the pointee must be an integer type whose bit width
4998    is a power of two greater than or equal to eight and less than or equal
4999    to a target-specific size limit. <code>align</code> must be explicitly
5000    specified on atomic loads, and the load has undefined behavior if the
5001    alignment is not set to a value which is at least the size in bytes of
5002    the pointee. <code>!nontemporal</code> does not have any defined semantics
5003    for atomic loads.</p>
5004
5005 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
5006    operation (that is, the alignment of the memory address). A value of 0 or an
5007    omitted <tt>align</tt> argument means that the operation has the preferential
5008    alignment for the target. It is the responsibility of the code emitter to
5009    ensure that the alignment information is correct. Overestimating the
5010    alignment results in undefined behavior. Underestimating the alignment may
5011    produce less efficient code. An alignment of 1 is always safe.</p>
5012
5013 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
5014    metatadata name &lt;index&gt; corresponding to a metadata node with
5015    one <tt>i32</tt> entry of value 1.  The existence of
5016    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
5017    and code generator that this load is not expected to be reused in the cache.
5018    The code generator may select special instructions to save cache bandwidth,
5019    such as the <tt>MOVNT</tt> instruction on x86.</p>
5020
5021 <p>The optional <tt>!invariant.load</tt> metadata must reference a single
5022    metatadata name &lt;index&gt; corresponding to a metadata node with no
5023    entries.  The existence of the <tt>!invariant.load</tt> metatadata on the
5024    instruction tells the optimizer and code generator that this load address
5025    points to memory which does not change value during program execution.
5026    The optimizer may then move this load around, for example, by hoisting it
5027    out of loops using loop invariant code motion.</p>
5028
5029 <h5>Semantics:</h5>
5030 <p>The location of memory pointed to is loaded.  If the value being loaded is of
5031    scalar type then the number of bytes read does not exceed the minimum number
5032    of bytes needed to hold all bits of the type.  For example, loading an
5033    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
5034    <tt>i20</tt> with a size that is not an integral number of bytes, the result
5035    is undefined if the value was not originally written using a store of the
5036    same type.</p>
5037
5038 <h5>Examples:</h5>
5039 <pre>
5040   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
5041   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
5042   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
5043 </pre>
5044
5045 </div>
5046
5047 <!-- _______________________________________________________________________ -->
5048 <h4>
5049   <a name="i_store">'<tt>store</tt>' Instruction</a>
5050 </h4>
5051
5052 <div>
5053
5054 <h5>Syntax:</h5>
5055 <pre>
5056   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>
5057   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>
5058 </pre>
5059
5060 <h5>Overview:</h5>
5061 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
5062
5063 <h5>Arguments:</h5>
5064 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
5065    and an address at which to store it.  The type of the
5066    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
5067    the <a href="#t_firstclass">first class</a> type of the
5068    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
5069    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
5070    order of execution of this <tt>store</tt> with other <a
5071    href="#volatile">volatile operations</a>.</p>
5072
5073 <p>If the <code>store</code> is marked as <code>atomic</code>, it takes an extra
5074    <a href="#ordering">ordering</a> and optional <code>singlethread</code>
5075    argument.  The <code>acquire</code> and <code>acq_rel</code> orderings aren't
5076    valid on <code>store</code> instructions.  Atomic loads produce <a
5077    href="#memorymodel">defined</a> results when they may see multiple atomic
5078    stores. The type of the pointee must be an integer type whose bit width
5079    is a power of two greater than or equal to eight and less than or equal
5080    to a target-specific size limit. <code>align</code> must be explicitly
5081    specified on atomic stores, and the store has undefined behavior if the
5082    alignment is not set to a value which is at least the size in bytes of
5083    the pointee. <code>!nontemporal</code> does not have any defined semantics
5084    for atomic stores.</p>
5085
5086 <p>The optional constant "align" argument specifies the alignment of the
5087    operation (that is, the alignment of the memory address). A value of 0 or an
5088    omitted "align" argument means that the operation has the preferential
5089    alignment for the target. It is the responsibility of the code emitter to
5090    ensure that the alignment information is correct. Overestimating the
5091    alignment results in an undefined behavior. Underestimating the alignment may
5092    produce less efficient code. An alignment of 1 is always safe.</p>
5093
5094 <p>The optional !nontemporal metadata must reference a single metatadata
5095    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
5096    value 1.  The existence of the !nontemporal metatadata on the
5097    instruction tells the optimizer and code generator that this load is
5098    not expected to be reused in the cache.  The code generator may
5099    select special instructions to save cache bandwidth, such as the
5100    MOVNT instruction on x86.</p>
5101
5102
5103 <h5>Semantics:</h5>
5104 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
5105    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
5106    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
5107    does not exceed the minimum number of bytes needed to hold all bits of the
5108    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
5109    writing a value of a type like <tt>i20</tt> with a size that is not an
5110    integral number of bytes, it is unspecified what happens to the extra bits
5111    that do not belong to the type, but they will typically be overwritten.</p>
5112
5113 <h5>Example:</h5>
5114 <pre>
5115   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
5116   store i32 3, i32* %ptr                          <i>; yields {void}</i>
5117   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
5118 </pre>
5119
5120 </div>
5121
5122 <!-- _______________________________________________________________________ -->
5123 <h4>
5124 <a name="i_fence">'<tt>fence</tt>' Instruction</a>
5125 </h4>
5126
5127 <div>
5128
5129 <h5>Syntax:</h5>
5130 <pre>
5131   fence [singlethread] &lt;ordering&gt;                   <i>; yields {void}</i>
5132 </pre>
5133
5134 <h5>Overview:</h5>
5135 <p>The '<tt>fence</tt>' instruction is used to introduce happens-before edges
5136 between operations.</p>
5137
5138 <h5>Arguments:</h5> <p>'<code>fence</code>' instructions take an <a
5139 href="#ordering">ordering</a> argument which defines what
5140 <i>synchronizes-with</i> edges they add.  They can only be given
5141 <code>acquire</code>, <code>release</code>, <code>acq_rel</code>, and
5142 <code>seq_cst</code> orderings.</p>
5143
5144 <h5>Semantics:</h5>
5145 <p>A fence <var>A</var> which has (at least) <code>release</code> ordering
5146 semantics <i>synchronizes with</i> a fence <var>B</var> with (at least)
5147 <code>acquire</code> ordering semantics if and only if there exist atomic
5148 operations <var>X</var> and <var>Y</var>, both operating on some atomic object
5149 <var>M</var>, such that <var>A</var> is sequenced before <var>X</var>,
5150 <var>X</var> modifies <var>M</var> (either directly or through some side effect
5151 of a sequence headed by <var>X</var>), <var>Y</var> is sequenced before
5152 <var>B</var>, and <var>Y</var> observes <var>M</var>. This provides a
5153 <i>happens-before</i> dependency between <var>A</var> and <var>B</var>. Rather
5154 than an explicit <code>fence</code>, one (but not both) of the atomic operations
5155 <var>X</var> or <var>Y</var> might provide a <code>release</code> or
5156 <code>acquire</code> (resp.) ordering constraint and still
5157 <i>synchronize-with</i> the explicit <code>fence</code> and establish the
5158 <i>happens-before</i> edge.</p>
5159
5160 <p>A <code>fence</code> which has <code>seq_cst</code> ordering, in addition to
5161 having both <code>acquire</code> and <code>release</code> semantics specified
5162 above, participates in the global program order of other <code>seq_cst</code>
5163 operations and/or fences.</p>
5164
5165 <p>The optional "<a href="#singlethread"><code>singlethread</code></a>" argument
5166 specifies that the fence only synchronizes with other fences in the same
5167 thread.  (This is useful for interacting with signal handlers.)</p>
5168
5169 <h5>Example:</h5>
5170 <pre>
5171   fence acquire                          <i>; yields {void}</i>
5172   fence singlethread seq_cst             <i>; yields {void}</i>
5173 </pre>
5174
5175 </div>
5176
5177 <!-- _______________________________________________________________________ -->
5178 <h4>
5179 <a name="i_cmpxchg">'<tt>cmpxchg</tt>' Instruction</a>
5180 </h4>
5181
5182 <div>
5183
5184 <h5>Syntax:</h5>
5185 <pre>
5186   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>
5187 </pre>
5188
5189 <h5>Overview:</h5>
5190 <p>The '<tt>cmpxchg</tt>' instruction is used to atomically modify memory.
5191 It loads a value in memory and compares it to a given value. If they are
5192 equal, it stores a new value into the memory.</p>
5193
5194 <h5>Arguments:</h5>
5195 <p>There are three arguments to the '<code>cmpxchg</code>' instruction: an
5196 address to operate on, a value to compare to the value currently be at that
5197 address, and a new value to place at that address if the compared values are
5198 equal.  The type of '<var>&lt;cmp&gt;</var>' must be an integer type whose
5199 bit width is a power of two greater than or equal to eight and less than
5200 or equal to a target-specific size limit. '<var>&lt;cmp&gt;</var>' and
5201 '<var>&lt;new&gt;</var>' must have the same type, and the type of
5202 '<var>&lt;pointer&gt;</var>' must be a pointer to that type. If the
5203 <code>cmpxchg</code> is marked as <code>volatile</code>, then the
5204 optimizer is not allowed to modify the number or order of execution
5205 of this <code>cmpxchg</code> with other <a href="#volatile">volatile
5206 operations</a>.</p>
5207
5208 <!-- FIXME: Extend allowed types. -->
5209
5210 <p>The <a href="#ordering"><var>ordering</var></a> argument specifies how this
5211 <code>cmpxchg</code> synchronizes with other atomic operations.</p>
5212
5213 <p>The optional "<code>singlethread</code>" argument declares that the
5214 <code>cmpxchg</code> is only atomic with respect to code (usually signal
5215 handlers) running in the same thread as the <code>cmpxchg</code>.  Otherwise the
5216 cmpxchg is atomic with respect to all other code in the system.</p>
5217
5218 <p>The pointer passed into cmpxchg must have alignment greater than or equal to
5219 the size in memory of the operand.
5220
5221 <h5>Semantics:</h5>
5222 <p>The contents of memory at the location specified by the
5223 '<tt>&lt;pointer&gt;</tt>' operand is read and compared to
5224 '<tt>&lt;cmp&gt;</tt>'; if the read value is the equal,
5225 '<tt>&lt;new&gt;</tt>' is written.  The original value at the location
5226 is returned.
5227
5228 <p>A successful <code>cmpxchg</code> is a read-modify-write instruction for the
5229 purpose of identifying <a href="#release_sequence">release sequences</a>.  A
5230 failed <code>cmpxchg</code> is equivalent to an atomic load with an ordering
5231 parameter determined by dropping any <code>release</code> part of the
5232 <code>cmpxchg</code>'s ordering.</p>
5233
5234 <!--
5235 FIXME: Is compare_exchange_weak() necessary?  (Consider after we've done
5236 optimization work on ARM.)
5237
5238 FIXME: Is a weaker ordering constraint on failure helpful in practice?
5239 -->
5240
5241 <h5>Example:</h5>
5242 <pre>
5243 entry:
5244   %orig = atomic <a href="#i_load">load</a> i32* %ptr unordered                   <i>; yields {i32}</i>
5245   <a href="#i_br">br</a> label %loop
5246
5247 loop:
5248   %cmp = <a href="#i_phi">phi</a> i32 [ %orig, %entry ], [%old, %loop]
5249   %squared = <a href="#i_mul">mul</a> i32 %cmp, %cmp
5250   %old = cmpxchg i32* %ptr, i32 %cmp, i32 %squared          <i>; yields {i32}</i>
5251   %success = <a href="#i_icmp">icmp</a> eq i32 %cmp, %old
5252   <a href="#i_br">br</a> i1 %success, label %done, label %loop
5253
5254 done:
5255   ...
5256 </pre>
5257
5258 </div>
5259
5260 <!-- _______________________________________________________________________ -->
5261 <h4>
5262 <a name="i_atomicrmw">'<tt>atomicrmw</tt>' Instruction</a>
5263 </h4>
5264
5265 <div>
5266
5267 <h5>Syntax:</h5>
5268 <pre>
5269   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>
5270 </pre>
5271
5272 <h5>Overview:</h5>
5273 <p>The '<tt>atomicrmw</tt>' instruction is used to atomically modify memory.</p>
5274
5275 <h5>Arguments:</h5>
5276 <p>There are three arguments to the '<code>atomicrmw</code>' instruction: an
5277 operation to apply, an address whose value to modify, an argument to the
5278 operation.  The operation must be one of the following keywords:</p>
5279 <ul>
5280   <li>xchg</li>
5281   <li>add</li>
5282   <li>sub</li>
5283   <li>and</li>
5284   <li>nand</li>
5285   <li>or</li>
5286   <li>xor</li>
5287   <li>max</li>
5288   <li>min</li>
5289   <li>umax</li>
5290   <li>umin</li>
5291 </ul>
5292
5293 <p>The type of '<var>&lt;value&gt;</var>' must be an integer type whose
5294 bit width is a power of two greater than or equal to eight and less than
5295 or equal to a target-specific size limit.  The type of the
5296 '<code>&lt;pointer&gt;</code>' operand must be a pointer to that type.
5297 If the <code>atomicrmw</code> is marked as <code>volatile</code>, then the
5298 optimizer is not allowed to modify the number or order of execution of this
5299 <code>atomicrmw</code> with other <a href="#volatile">volatile
5300   operations</a>.</p>
5301
5302 <!-- FIXME: Extend allowed types. -->
5303
5304 <h5>Semantics:</h5>
5305 <p>The contents of memory at the location specified by the
5306 '<tt>&lt;pointer&gt;</tt>' operand are atomically read, modified, and written
5307 back.  The original value at the location is returned.  The modification is
5308 specified by the <var>operation</var> argument:</p>
5309
5310 <ul>
5311   <li>xchg: <code>*ptr = val</code></li>
5312   <li>add: <code>*ptr = *ptr + val</code></li>
5313   <li>sub: <code>*ptr = *ptr - val</code></li>
5314   <li>and: <code>*ptr = *ptr &amp; val</code></li>
5315   <li>nand: <code>*ptr = ~(*ptr &amp; val)</code></li>
5316   <li>or: <code>*ptr = *ptr | val</code></li>
5317   <li>xor: <code>*ptr = *ptr ^ val</code></li>
5318   <li>max: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using a signed comparison)</li>
5319   <li>min: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using a signed comparison)</li>
5320   <li>umax: <code>*ptr = *ptr &gt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5321   <li>umin: <code>*ptr = *ptr &lt; val ? *ptr : val</code> (using an unsigned comparison)</li>
5322 </ul>
5323
5324 <h5>Example:</h5>
5325 <pre>
5326   %old = atomicrmw add i32* %ptr, i32 1 acquire                        <i>; yields {i32}</i>
5327 </pre>
5328
5329 </div>
5330
5331 <!-- _______________________________________________________________________ -->
5332 <h4>
5333    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
5334 </h4>
5335
5336 <div>
5337
5338 <h5>Syntax:</h5>
5339 <pre>
5340   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5341   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
5342   &lt;result&gt; = getelementptr &lt;ptr vector&gt; ptrval, &lt;vector index type&gt; idx
5343 </pre>
5344
5345 <h5>Overview:</h5>
5346 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
5347    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
5348    It performs address calculation only and does not access memory.</p>
5349
5350 <h5>Arguments:</h5>
5351 <p>The first argument is always a pointer or a vector of pointers,
5352    and forms the basis of the
5353    calculation. The remaining arguments are indices that indicate which of the
5354    elements of the aggregate object are indexed. The interpretation of each
5355    index is dependent on the type being indexed into. The first index always
5356    indexes the pointer value given as the first argument, the second index
5357    indexes a value of the type pointed to (not necessarily the value directly
5358    pointed to, since the first index can be non-zero), etc. The first type
5359    indexed into must be a pointer value, subsequent types can be arrays,
5360    vectors, and structs. Note that subsequent types being indexed into
5361    can never be pointers, since that would require loading the pointer before
5362    continuing calculation.</p>
5363
5364 <p>The type of each index argument depends on the type it is indexing into.
5365    When indexing into a (optionally packed) structure, only <tt>i32</tt>
5366    integer <b>constants</b> are allowed.  When indexing into an array, pointer
5367    or vector, integers of any width are allowed, and they are not required to be
5368    constant.  These integers are treated as signed values where relevant.</p>
5369
5370 <p>For example, let's consider a C code fragment and how it gets compiled to
5371    LLVM:</p>
5372
5373 <pre class="doc_code">
5374 struct RT {
5375   char A;
5376   int B[10][20];
5377   char C;
5378 };
5379 struct ST {
5380   int X;
5381   double Y;
5382   struct RT Z;
5383 };
5384
5385 int *foo(struct ST *s) {
5386   return &amp;s[1].Z.B[5][13];
5387 }
5388 </pre>
5389
5390 <p>The LLVM code generated by Clang is:</p>
5391
5392 <pre class="doc_code">
5393 %struct.RT = <a href="#namedtypes">type</a> { i8, [10 x [20 x i32]], i8 }
5394 %struct.ST = <a href="#namedtypes">type</a> { i32, double, %struct.RT }
5395
5396 define i32* @foo(%struct.ST* %s) nounwind uwtable readnone optsize ssp {
5397 entry:
5398   %arrayidx = getelementptr inbounds %struct.ST* %s, i64 1, i32 2, i32 1, i64 5, i64 13
5399   ret i32* %arrayidx
5400 }
5401 </pre>
5402
5403 <h5>Semantics:</h5>
5404 <p>In the example above, the first index is indexing into the
5405    '<tt>%struct.ST*</tt>' type, which is a pointer, yielding a
5406    '<tt>%struct.ST</tt>' = '<tt>{ i32, double, %struct.RT }</tt>' type, a
5407    structure. The second index indexes into the third element of the structure,
5408    yielding a '<tt>%struct.RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]], i8 }</tt>'
5409    type, another structure. The third index indexes into the second element of
5410    the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an array. The
5411    two dimensions of the array are subscripted into, yielding an '<tt>i32</tt>'
5412    type. The '<tt>getelementptr</tt>' instruction returns a pointer to this
5413    element, thus computing a value of '<tt>i32*</tt>' type.</p>
5414
5415 <p>Note that it is perfectly legal to index partially through a structure,
5416    returning a pointer to an inner element.  Because of this, the LLVM code for
5417    the given testcase is equivalent to:</p>
5418
5419 <pre class="doc_code">
5420 define i32* @foo(%struct.ST* %s) {
5421   %t1 = getelementptr %struct.ST* %s, i32 1                 <i>; yields %struct.ST*:%t1</i>
5422   %t2 = getelementptr %struct.ST* %t1, i32 0, i32 2         <i>; yields %struct.RT*:%t2</i>
5423   %t3 = getelementptr %struct.RT* %t2, i32 0, i32 1         <i>; yields [10 x [20 x i32]]*:%t3</i>
5424   %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
5425   %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
5426   ret i32* %t5
5427 }
5428 </pre>
5429
5430 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
5431    <tt>getelementptr</tt> is a <a href="#poisonvalues">poison value</a> if the
5432    base pointer is not an <i>in bounds</i> address of an allocated object,
5433    or if any of the addresses that would be formed by successive addition of
5434    the offsets implied by the indices to the base address with infinitely
5435    precise signed arithmetic are not an <i>in bounds</i> address of that
5436    allocated object. The <i>in bounds</i> addresses for an allocated object
5437    are all the addresses that point into the object, plus the address one
5438    byte past the end.
5439    In cases where the base is a vector of pointers the <tt>inbounds</tt> keyword
5440    applies to each of the computations element-wise. </p>
5441
5442 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
5443    the base address with silently-wrapping two's complement arithmetic. If the
5444    offsets have a different width from the pointer, they are sign-extended or
5445    truncated to the width of the pointer. The result value of the
5446    <tt>getelementptr</tt> may be outside the object pointed to by the base
5447    pointer. The result value may not necessarily be used to access memory
5448    though, even if it happens to point into allocated storage. See the
5449    <a href="#pointeraliasing">Pointer Aliasing Rules</a> section for more
5450    information.</p>
5451
5452 <p>The getelementptr instruction is often confusing.  For some more insight into
5453    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
5454
5455 <h5>Example:</h5>
5456 <pre>
5457     <i>; yields [12 x i8]*:aptr</i>
5458     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
5459     <i>; yields i8*:vptr</i>
5460     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
5461     <i>; yields i8*:eptr</i>
5462     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
5463     <i>; yields i32*:iptr</i>
5464     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
5465 </pre>
5466
5467 <p>In cases where the pointer argument is a vector of pointers, only a
5468    single index may be used, and the number of vector elements has to be
5469    the same.  For example: </p>
5470 <pre class="doc_code">
5471  %A = getelementptr <4 x i8*> %ptrs, <4 x i64> %offsets,
5472 </pre>
5473
5474 </div>
5475
5476 </div>
5477
5478 <!-- ======================================================================= -->
5479 <h3>
5480   <a name="convertops">Conversion Operations</a>
5481 </h3>
5482
5483 <div>
5484
5485 <p>The instructions in this category are the conversion instructions (casting)
5486    which all take a single operand and a type. They perform various bit
5487    conversions on the operand.</p>
5488
5489 <!-- _______________________________________________________________________ -->
5490 <h4>
5491    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
5492 </h4>
5493
5494 <div>
5495
5496 <h5>Syntax:</h5>
5497 <pre>
5498   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5499 </pre>
5500
5501 <h5>Overview:</h5>
5502 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
5503    type <tt>ty2</tt>.</p>
5504
5505 <h5>Arguments:</h5>
5506 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
5507    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5508    of the same number of integers.
5509    The bit size of the <tt>value</tt> must be larger than
5510    the bit size of the destination type, <tt>ty2</tt>.
5511    Equal sized types are not allowed.</p>
5512
5513 <h5>Semantics:</h5>
5514 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
5515    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
5516    source size must be larger than the destination size, <tt>trunc</tt> cannot
5517    be a <i>no-op cast</i>.  It will always truncate bits.</p>
5518
5519 <h5>Example:</h5>
5520 <pre>
5521   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
5522   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
5523   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
5524   %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>
5525 </pre>
5526
5527 </div>
5528
5529 <!-- _______________________________________________________________________ -->
5530 <h4>
5531    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
5532 </h4>
5533
5534 <div>
5535
5536 <h5>Syntax:</h5>
5537 <pre>
5538   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5539 </pre>
5540
5541 <h5>Overview:</h5>
5542 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
5543    <tt>ty2</tt>.</p>
5544
5545
5546 <h5>Arguments:</h5>
5547 <p>The '<tt>zext</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>zext</tt> fills the high order bits of the <tt>value</tt> with zero
5556    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
5557
5558 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
5559
5560 <h5>Example:</h5>
5561 <pre>
5562   %X = zext i32 257 to i64              <i>; yields i64:257</i>
5563   %Y = zext i1 true to i32              <i>; yields i32:1</i>
5564   %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>
5565 </pre>
5566
5567 </div>
5568
5569 <!-- _______________________________________________________________________ -->
5570 <h4>
5571    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
5572 </h4>
5573
5574 <div>
5575
5576 <h5>Syntax:</h5>
5577 <pre>
5578   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5579 </pre>
5580
5581 <h5>Overview:</h5>
5582 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
5583
5584 <h5>Arguments:</h5>
5585 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
5586    Both types must be of <a href="#t_integer">integer</a> types, or vectors
5587    of the same number of integers.
5588    The bit size of the <tt>value</tt> must be smaller than
5589    the bit size of the destination type,
5590    <tt>ty2</tt>.</p>
5591
5592 <h5>Semantics:</h5>
5593 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
5594    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
5595    of the type <tt>ty2</tt>.</p>
5596
5597 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
5598
5599 <h5>Example:</h5>
5600 <pre>
5601   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
5602   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
5603   %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>
5604 </pre>
5605
5606 </div>
5607
5608 <!-- _______________________________________________________________________ -->
5609 <h4>
5610    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
5611 </h4>
5612
5613 <div>
5614
5615 <h5>Syntax:</h5>
5616 <pre>
5617   &lt;result&gt; = fptrunc &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>fptrunc</tt>' instruction truncates <tt>value</tt> to type
5622    <tt>ty2</tt>.</p>
5623
5624 <h5>Arguments:</h5>
5625 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
5626    point</a> value to cast and a <a href="#t_floating">floating point</a> type
5627    to cast it to. The size of <tt>value</tt> must be larger than the size of
5628    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
5629    <i>no-op cast</i>.</p>
5630
5631 <h5>Semantics:</h5>
5632 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
5633    <a href="#t_floating">floating point</a> type to a smaller
5634    <a href="#t_floating">floating point</a> type.  If the value cannot fit
5635    within the destination type, <tt>ty2</tt>, then the results are
5636    undefined.</p>
5637
5638 <h5>Example:</h5>
5639 <pre>
5640   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
5641   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
5642 </pre>
5643
5644 </div>
5645
5646 <!-- _______________________________________________________________________ -->
5647 <h4>
5648    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
5649 </h4>
5650
5651 <div>
5652
5653 <h5>Syntax:</h5>
5654 <pre>
5655   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5656 </pre>
5657
5658 <h5>Overview:</h5>
5659 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
5660    floating point value.</p>
5661
5662 <h5>Arguments:</h5>
5663 <p>The '<tt>fpext</tt>' instruction takes a
5664    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
5665    a <a href="#t_floating">floating point</a> type to cast it to. The source
5666    type must be smaller than the destination type.</p>
5667
5668 <h5>Semantics:</h5>
5669 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
5670    <a href="#t_floating">floating point</a> type to a larger
5671    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
5672    used to make a <i>no-op cast</i> because it always changes bits. Use
5673    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
5674
5675 <h5>Example:</h5>
5676 <pre>
5677   %X = fpext float 3.125 to double         <i>; yields double:3.125000e+00</i>
5678   %Y = fpext double %X to fp128            <i>; yields fp128:0xL00000000000000004000900000000000</i>
5679 </pre>
5680
5681 </div>
5682
5683 <!-- _______________________________________________________________________ -->
5684 <h4>
5685    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
5686 </h4>
5687
5688 <div>
5689
5690 <h5>Syntax:</h5>
5691 <pre>
5692   &lt;result&gt; = fptoui &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>fptoui</tt>' converts a floating point <tt>value</tt> to its
5697    unsigned integer equivalent of type <tt>ty2</tt>.</p>
5698
5699 <h5>Arguments:</h5>
5700 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
5701    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5702    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5703    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5704    vector integer type with the same number of elements as <tt>ty</tt></p>
5705
5706 <h5>Semantics:</h5>
5707 <p>The '<tt>fptoui</tt>' instruction converts its
5708    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5709    towards zero) unsigned integer value. If the value cannot fit
5710    in <tt>ty2</tt>, the results are undefined.</p>
5711
5712 <h5>Example:</h5>
5713 <pre>
5714   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
5715   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
5716   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
5717 </pre>
5718
5719 </div>
5720
5721 <!-- _______________________________________________________________________ -->
5722 <h4>
5723    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
5724 </h4>
5725
5726 <div>
5727
5728 <h5>Syntax:</h5>
5729 <pre>
5730   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5731 </pre>
5732
5733 <h5>Overview:</h5>
5734 <p>The '<tt>fptosi</tt>' instruction converts
5735    <a href="#t_floating">floating point</a> <tt>value</tt> to
5736    type <tt>ty2</tt>.</p>
5737
5738 <h5>Arguments:</h5>
5739 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
5740    scalar or vector <a href="#t_floating">floating point</a> value, and a type
5741    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
5742    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
5743    vector integer type with the same number of elements as <tt>ty</tt></p>
5744
5745 <h5>Semantics:</h5>
5746 <p>The '<tt>fptosi</tt>' instruction converts its
5747    <a href="#t_floating">floating point</a> operand into the nearest (rounding
5748    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
5749    the results are undefined.</p>
5750
5751 <h5>Example:</h5>
5752 <pre>
5753   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
5754   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
5755   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
5756 </pre>
5757
5758 </div>
5759
5760 <!-- _______________________________________________________________________ -->
5761 <h4>
5762    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
5763 </h4>
5764
5765 <div>
5766
5767 <h5>Syntax:</h5>
5768 <pre>
5769   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5770 </pre>
5771
5772 <h5>Overview:</h5>
5773 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
5774    integer and converts that value to the <tt>ty2</tt> type.</p>
5775
5776 <h5>Arguments:</h5>
5777 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
5778    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5779    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5780    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5781    floating point type with the same number of elements as <tt>ty</tt></p>
5782
5783 <h5>Semantics:</h5>
5784 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
5785    integer quantity and converts it to the corresponding floating point
5786    value. If the value cannot fit in the floating point value, the results are
5787    undefined.</p>
5788
5789 <h5>Example:</h5>
5790 <pre>
5791   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
5792   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
5793 </pre>
5794
5795 </div>
5796
5797 <!-- _______________________________________________________________________ -->
5798 <h4>
5799    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
5800 </h4>
5801
5802 <div>
5803
5804 <h5>Syntax:</h5>
5805 <pre>
5806   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5807 </pre>
5808
5809 <h5>Overview:</h5>
5810 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
5811    and converts that value to the <tt>ty2</tt> type.</p>
5812
5813 <h5>Arguments:</h5>
5814 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
5815    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
5816    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
5817    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
5818    floating point type with the same number of elements as <tt>ty</tt></p>
5819
5820 <h5>Semantics:</h5>
5821 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
5822    quantity and converts it to the corresponding floating point value. If the
5823    value cannot fit in the floating point value, the results are undefined.</p>
5824
5825 <h5>Example:</h5>
5826 <pre>
5827   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
5828   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
5829 </pre>
5830
5831 </div>
5832
5833 <!-- _______________________________________________________________________ -->
5834 <h4>
5835    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
5836 </h4>
5837
5838 <div>
5839
5840 <h5>Syntax:</h5>
5841 <pre>
5842   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5843 </pre>
5844
5845 <h5>Overview:</h5>
5846 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer or a vector of
5847    pointers <tt>value</tt> to
5848    the integer (or vector of integers) type <tt>ty2</tt>.</p>
5849
5850 <h5>Arguments:</h5>
5851 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
5852    must be a a value of type <a href="#t_pointer">pointer</a> or a vector of
5853     pointers, and a type to cast it to
5854    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> or a vector
5855    of integers type.</p>
5856
5857 <h5>Semantics:</h5>
5858 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
5859    <tt>ty2</tt> by interpreting the pointer value as an integer and either
5860    truncating or zero extending that value to the size of the integer type. If
5861    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
5862    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
5863    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
5864    change.</p>
5865
5866 <h5>Example:</h5>
5867 <pre>
5868   %X = ptrtoint i32* %P to i8                         <i>; yields truncation on 32-bit architecture</i>
5869   %Y = ptrtoint i32* %P to i64                        <i>; yields zero extension on 32-bit architecture</i>
5870   %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>
5871 </pre>
5872
5873 </div>
5874
5875 <!-- _______________________________________________________________________ -->
5876 <h4>
5877    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
5878 </h4>
5879
5880 <div>
5881
5882 <h5>Syntax:</h5>
5883 <pre>
5884   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5885 </pre>
5886
5887 <h5>Overview:</h5>
5888 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
5889    pointer type, <tt>ty2</tt>.</p>
5890
5891 <h5>Arguments:</h5>
5892 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
5893    value to cast, and a type to cast it to, which must be a
5894    <a href="#t_pointer">pointer</a> type.</p>
5895
5896 <h5>Semantics:</h5>
5897 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
5898    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
5899    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
5900    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
5901    than the size of a pointer then a zero extension is done. If they are the
5902    same size, nothing is done (<i>no-op cast</i>).</p>
5903
5904 <h5>Example:</h5>
5905 <pre>
5906   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
5907   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
5908   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
5909   %Z = inttoptr &lt;4 x i32&gt; %G to &lt;4 x i8*&gt;<i>; yields truncation of vector G to four pointers</i>
5910 </pre>
5911
5912 </div>
5913
5914 <!-- _______________________________________________________________________ -->
5915 <h4>
5916    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
5917 </h4>
5918
5919 <div>
5920
5921 <h5>Syntax:</h5>
5922 <pre>
5923   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
5924 </pre>
5925
5926 <h5>Overview:</h5>
5927 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5928    <tt>ty2</tt> without changing any bits.</p>
5929
5930 <h5>Arguments:</h5>
5931 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
5932    non-aggregate first class value, and a type to cast it to, which must also be
5933    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
5934    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
5935    identical. If the source type is a pointer, the destination type must also be
5936    a pointer.  This instruction supports bitwise conversion of vectors to
5937    integers and to vectors of other types (as long as they have the same
5938    size).</p>
5939
5940 <h5>Semantics:</h5>
5941 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5942    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5943    this conversion.  The conversion is done as if the <tt>value</tt> had been
5944    stored to memory and read back as type <tt>ty2</tt>.
5945    Pointer (or vector of pointers) types may only be converted to other pointer
5946    (or vector of pointers) types with this instruction. To convert
5947    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5948    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5949
5950 <h5>Example:</h5>
5951 <pre>
5952   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5953   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5954   %Z = bitcast &lt;2 x int&gt; %V to i64;        <i>; yields i64: %V</i>
5955   %Z = bitcast &lt;2 x i32*&gt; %V to &lt;2 x i64*&gt; <i>; yields &lt;2 x i64*&gt;</i>
5956 </pre>
5957
5958 </div>
5959
5960 </div>
5961
5962 <!-- ======================================================================= -->
5963 <h3>
5964   <a name="otherops">Other Operations</a>
5965 </h3>
5966
5967 <div>
5968
5969 <p>The instructions in this category are the "miscellaneous" instructions, which
5970    defy better classification.</p>
5971
5972 <!-- _______________________________________________________________________ -->
5973 <h4>
5974   <a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5975 </h4>
5976
5977 <div>
5978
5979 <h5>Syntax:</h5>
5980 <pre>
5981   &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>
5982 </pre>
5983
5984 <h5>Overview:</h5>
5985 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5986    boolean values based on comparison of its two integer, integer vector,
5987    pointer, or pointer vector operands.</p>
5988
5989 <h5>Arguments:</h5>
5990 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5991    the condition code indicating the kind of comparison to perform. It is not a
5992    value, just a keyword. The possible condition code are:</p>
5993
5994 <ol>
5995   <li><tt>eq</tt>: equal</li>
5996   <li><tt>ne</tt>: not equal </li>
5997   <li><tt>ugt</tt>: unsigned greater than</li>
5998   <li><tt>uge</tt>: unsigned greater or equal</li>
5999   <li><tt>ult</tt>: unsigned less than</li>
6000   <li><tt>ule</tt>: unsigned less or equal</li>
6001   <li><tt>sgt</tt>: signed greater than</li>
6002   <li><tt>sge</tt>: signed greater or equal</li>
6003   <li><tt>slt</tt>: signed less than</li>
6004   <li><tt>sle</tt>: signed less or equal</li>
6005 </ol>
6006
6007 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
6008    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
6009    typed.  They must also be identical types.</p>
6010
6011 <h5>Semantics:</h5>
6012 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
6013    condition code given as <tt>cond</tt>. The comparison performed always yields
6014    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
6015    result, as follows:</p>
6016
6017 <ol>
6018   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
6019       <tt>false</tt> otherwise. No sign interpretation is necessary or
6020       performed.</li>
6021
6022   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
6023       <tt>false</tt> otherwise. No sign interpretation is necessary or
6024       performed.</li>
6025
6026   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
6027       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6028
6029   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
6030       <tt>true</tt> if <tt>op1</tt> is greater than or equal
6031       to <tt>op2</tt>.</li>
6032
6033   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
6034       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
6035
6036   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
6037       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6038
6039   <li><tt>sgt</tt>: interprets the operands as signed values and yields
6040       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6041
6042   <li><tt>sge</tt>: interprets the operands as signed values and yields
6043       <tt>true</tt> if <tt>op1</tt> is greater than or equal
6044       to <tt>op2</tt>.</li>
6045
6046   <li><tt>slt</tt>: interprets the operands as signed values and yields
6047       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
6048
6049   <li><tt>sle</tt>: interprets the operands as signed values and yields
6050       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6051 </ol>
6052
6053 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
6054    values are compared as if they were integers.</p>
6055
6056 <p>If the operands are integer vectors, then they are compared element by
6057    element. The result is an <tt>i1</tt> vector with the same number of elements
6058    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
6059
6060 <h5>Example:</h5>
6061 <pre>
6062   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
6063   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
6064   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
6065   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
6066   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
6067   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
6068 </pre>
6069
6070 <p>Note that the code generator does not yet support vector types with
6071    the <tt>icmp</tt> instruction.</p>
6072
6073 </div>
6074
6075 <!-- _______________________________________________________________________ -->
6076 <h4>
6077   <a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
6078 </h4>
6079
6080 <div>
6081
6082 <h5>Syntax:</h5>
6083 <pre>
6084   &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>
6085 </pre>
6086
6087 <h5>Overview:</h5>
6088 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
6089    values based on comparison of its operands.</p>
6090
6091 <p>If the operands are floating point scalars, then the result type is a boolean
6092 (<a href="#t_integer"><tt>i1</tt></a>).</p>
6093
6094 <p>If the operands are floating point vectors, then the result type is a vector
6095    of boolean with the same number of elements as the operands being
6096    compared.</p>
6097
6098 <h5>Arguments:</h5>
6099 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
6100    the condition code indicating the kind of comparison to perform. It is not a
6101    value, just a keyword. The possible condition code are:</p>
6102
6103 <ol>
6104   <li><tt>false</tt>: no comparison, always returns false</li>
6105   <li><tt>oeq</tt>: ordered and equal</li>
6106   <li><tt>ogt</tt>: ordered and greater than </li>
6107   <li><tt>oge</tt>: ordered and greater than or equal</li>
6108   <li><tt>olt</tt>: ordered and less than </li>
6109   <li><tt>ole</tt>: ordered and less than or equal</li>
6110   <li><tt>one</tt>: ordered and not equal</li>
6111   <li><tt>ord</tt>: ordered (no nans)</li>
6112   <li><tt>ueq</tt>: unordered or equal</li>
6113   <li><tt>ugt</tt>: unordered or greater than </li>
6114   <li><tt>uge</tt>: unordered or greater than or equal</li>
6115   <li><tt>ult</tt>: unordered or less than </li>
6116   <li><tt>ule</tt>: unordered or less than or equal</li>
6117   <li><tt>une</tt>: unordered or not equal</li>
6118   <li><tt>uno</tt>: unordered (either nans)</li>
6119   <li><tt>true</tt>: no comparison, always returns true</li>
6120 </ol>
6121
6122 <p><i>Ordered</i> means that neither operand is a QNAN while
6123    <i>unordered</i> means that either operand may be a QNAN.</p>
6124
6125 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
6126    a <a href="#t_floating">floating point</a> type or
6127    a <a href="#t_vector">vector</a> of floating point type.  They must have
6128    identical types.</p>
6129
6130 <h5>Semantics:</h5>
6131 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
6132    according to the condition code given as <tt>cond</tt>.  If the operands are
6133    vectors, then the vectors are compared element by element.  Each comparison
6134    performed always yields an <a href="#t_integer">i1</a> result, as
6135    follows:</p>
6136
6137 <ol>
6138   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
6139
6140   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6141       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
6142
6143   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6144       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6145
6146   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6147       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
6148
6149   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6150       <tt>op1</tt> is less than <tt>op2</tt>.</li>
6151
6152   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6153       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6154
6155   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
6156       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
6157
6158   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
6159
6160   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
6161       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
6162
6163   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
6164       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
6165
6166   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
6167       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
6168
6169   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
6170       <tt>op1</tt> is less than <tt>op2</tt>.</li>
6171
6172   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
6173       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
6174
6175   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
6176       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
6177
6178   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
6179
6180   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
6181 </ol>
6182
6183 <h5>Example:</h5>
6184 <pre>
6185   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
6186   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
6187   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
6188   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
6189 </pre>
6190
6191 <p>Note that the code generator does not yet support vector types with
6192    the <tt>fcmp</tt> instruction.</p>
6193
6194 </div>
6195
6196 <!-- _______________________________________________________________________ -->
6197 <h4>
6198   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
6199 </h4>
6200
6201 <div>
6202
6203 <h5>Syntax:</h5>
6204 <pre>
6205   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
6206 </pre>
6207
6208 <h5>Overview:</h5>
6209 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
6210    SSA graph representing the function.</p>
6211
6212 <h5>Arguments:</h5>
6213 <p>The type of the incoming values is specified with the first type field. After
6214    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
6215    one pair for each predecessor basic block of the current block.  Only values
6216    of <a href="#t_firstclass">first class</a> type may be used as the value
6217    arguments to the PHI node.  Only labels may be used as the label
6218    arguments.</p>
6219
6220 <p>There must be no non-phi instructions between the start of a basic block and
6221    the PHI instructions: i.e. PHI instructions must be first in a basic
6222    block.</p>
6223
6224 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
6225    occur on the edge from the corresponding predecessor block to the current
6226    block (but after any definition of an '<tt>invoke</tt>' instruction's return
6227    value on the same edge).</p>
6228
6229 <h5>Semantics:</h5>
6230 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
6231    specified by the pair corresponding to the predecessor basic block that
6232    executed just prior to the current block.</p>
6233
6234 <h5>Example:</h5>
6235 <pre>
6236 Loop:       ; Infinite loop that counts from 0 on up...
6237   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
6238   %nextindvar = add i32 %indvar, 1
6239   br label %Loop
6240 </pre>
6241
6242 </div>
6243
6244 <!-- _______________________________________________________________________ -->
6245 <h4>
6246    <a name="i_select">'<tt>select</tt>' Instruction</a>
6247 </h4>
6248
6249 <div>
6250
6251 <h5>Syntax:</h5>
6252 <pre>
6253   &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>
6254
6255   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
6256 </pre>
6257
6258 <h5>Overview:</h5>
6259 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
6260    condition, without branching.</p>
6261
6262
6263 <h5>Arguments:</h5>
6264 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
6265    values indicating the condition, and two values of the
6266    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
6267    vectors and the condition is a scalar, then entire vectors are selected, not
6268    individual elements.</p>
6269
6270 <h5>Semantics:</h5>
6271 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
6272    first value argument; otherwise, it returns the second value argument.</p>
6273
6274 <p>If the condition is a vector of i1, then the value arguments must be vectors
6275    of the same size, and the selection is done element by element.</p>
6276
6277 <h5>Example:</h5>
6278 <pre>
6279   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
6280 </pre>
6281
6282 </div>
6283
6284 <!-- _______________________________________________________________________ -->
6285 <h4>
6286   <a name="i_call">'<tt>call</tt>' Instruction</a>
6287 </h4>
6288
6289 <div>
6290
6291 <h5>Syntax:</h5>
6292 <pre>
6293   &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>]
6294 </pre>
6295
6296 <h5>Overview:</h5>
6297 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
6298
6299 <h5>Arguments:</h5>
6300 <p>This instruction requires several arguments:</p>
6301
6302 <ol>
6303   <li>The optional "tail" marker indicates that the callee function does not
6304       access any allocas or varargs in the caller.  Note that calls may be
6305       marked "tail" even if they do not occur before
6306       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
6307       present, the function call is eligible for tail call optimization,
6308       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
6309       optimized into a jump</a>.  The code generator may optimize calls marked
6310       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
6311       sibling call optimization</a> when the caller and callee have
6312       matching signatures, or 2) forced tail call optimization when the
6313       following extra requirements are met:
6314       <ul>
6315         <li>Caller and callee both have the calling
6316             convention <tt>fastcc</tt>.</li>
6317         <li>The call is in tail position (ret immediately follows call and ret
6318             uses value of call or is void).</li>
6319         <li>Option <tt>-tailcallopt</tt> is enabled,
6320             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
6321         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
6322             constraints are met.</a></li>
6323       </ul>
6324   </li>
6325
6326   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
6327       convention</a> the call should use.  If none is specified, the call
6328       defaults to using C calling conventions.  The calling convention of the
6329       call must match the calling convention of the target function, or else the
6330       behavior is undefined.</li>
6331
6332   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
6333       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
6334       '<tt>inreg</tt>' attributes are valid here.</li>
6335
6336   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
6337       type of the return value.  Functions that return no value are marked
6338       <tt><a href="#t_void">void</a></tt>.</li>
6339
6340   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
6341       being invoked.  The argument types must match the types implied by this
6342       signature.  This type can be omitted if the function is not varargs and if
6343       the function type does not return a pointer to a function.</li>
6344
6345   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
6346       be invoked. In most cases, this is a direct function invocation, but
6347       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
6348       to function value.</li>
6349
6350   <li>'<tt>function args</tt>': argument list whose types match the function
6351       signature argument types and parameter attributes. All arguments must be
6352       of <a href="#t_firstclass">first class</a> type. If the function
6353       signature indicates the function accepts a variable number of arguments,
6354       the extra arguments can be specified.</li>
6355
6356   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
6357       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
6358       '<tt>readnone</tt>' attributes are valid here.</li>
6359 </ol>
6360
6361 <h5>Semantics:</h5>
6362 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
6363    a specified function, with its incoming arguments bound to the specified
6364    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
6365    function, control flow continues with the instruction after the function
6366    call, and the return value of the function is bound to the result
6367    argument.</p>
6368
6369 <h5>Example:</h5>
6370 <pre>
6371   %retval = call i32 @test(i32 %argc)
6372   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
6373   %X = tail call i32 @foo()                                    <i>; yields i32</i>
6374   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
6375   call void %foo(i8 97 signext)
6376
6377   %struct.A = type { i32, i8 }
6378   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
6379   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
6380   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
6381   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
6382   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
6383 </pre>
6384
6385 <p>llvm treats calls to some functions with names and arguments that match the
6386 standard C99 library as being the C99 library functions, and may perform
6387 optimizations or generate code for them under that assumption.  This is
6388 something we'd like to change in the future to provide better support for
6389 freestanding environments and non-C-based languages.</p>
6390
6391 </div>
6392
6393 <!-- _______________________________________________________________________ -->
6394 <h4>
6395   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
6396 </h4>
6397
6398 <div>
6399
6400 <h5>Syntax:</h5>
6401 <pre>
6402   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
6403 </pre>
6404
6405 <h5>Overview:</h5>
6406 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
6407    the "variable argument" area of a function call.  It is used to implement the
6408    <tt>va_arg</tt> macro in C.</p>
6409
6410 <h5>Arguments:</h5>
6411 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
6412    argument. It returns a value of the specified argument type and increments
6413    the <tt>va_list</tt> to point to the next argument.  The actual type
6414    of <tt>va_list</tt> is target specific.</p>
6415
6416 <h5>Semantics:</h5>
6417 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
6418    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
6419    to the next argument.  For more information, see the variable argument
6420    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
6421
6422 <p>It is legal for this instruction to be called in a function which does not
6423    take a variable number of arguments, for example, the <tt>vfprintf</tt>
6424    function.</p>
6425
6426 <p><tt>va_arg</tt> is an LLVM instruction instead of
6427    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
6428    argument.</p>
6429
6430 <h5>Example:</h5>
6431 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
6432
6433 <p>Note that the code generator does not yet fully support va_arg on many
6434    targets. Also, it does not currently support va_arg with aggregate types on
6435    any target.</p>
6436
6437 </div>
6438
6439 <!-- _______________________________________________________________________ -->
6440 <h4>
6441   <a name="i_landingpad">'<tt>landingpad</tt>' Instruction</a>
6442 </h4>
6443
6444 <div>
6445
6446 <h5>Syntax:</h5>
6447 <pre>
6448   &lt;resultval&gt; = landingpad &lt;resultty&gt; personality &lt;type&gt; &lt;pers_fn&gt; &lt;clause&gt;+
6449   &lt;resultval&gt; = landingpad &lt;resultty&gt; personality &lt;type&gt; &lt;pers_fn&gt; cleanup &lt;clause&gt;*
6450
6451   &lt;clause&gt; := catch &lt;type&gt; &lt;value&gt;
6452   &lt;clause&gt; := filter &lt;array constant type&gt; &lt;array constant&gt;
6453 </pre>
6454
6455 <h5>Overview:</h5>
6456 <p>The '<tt>landingpad</tt>' instruction is used by
6457    <a href="ExceptionHandling.html#overview">LLVM's exception handling
6458    system</a> to specify that a basic block is a landing pad &mdash; one where
6459    the exception lands, and corresponds to the code found in the
6460    <i><tt>catch</tt></i> portion of a <i><tt>try/catch</tt></i> sequence. It
6461    defines values supplied by the personality function (<tt>pers_fn</tt>) upon
6462    re-entry to the function. The <tt>resultval</tt> has the
6463    type <tt>resultty</tt>.</p>
6464
6465 <h5>Arguments:</h5>
6466 <p>This instruction takes a <tt>pers_fn</tt> value. This is the personality
6467    function associated with the unwinding mechanism. The optional
6468    <tt>cleanup</tt> flag indicates that the landing pad block is a cleanup.</p>
6469
6470 <p>A <tt>clause</tt> begins with the clause type &mdash; <tt>catch</tt>
6471    or <tt>filter</tt> &mdash; and contains the global variable representing the
6472    "type" that may be caught or filtered respectively. Unlike the
6473    <tt>catch</tt> clause, the <tt>filter</tt> clause takes an array constant as
6474    its argument. Use "<tt>[0 x i8**] undef</tt>" for a filter which cannot
6475    throw. The '<tt>landingpad</tt>' instruction must contain <em>at least</em>
6476    one <tt>clause</tt> or the <tt>cleanup</tt> flag.</p>
6477
6478 <h5>Semantics:</h5>
6479 <p>The '<tt>landingpad</tt>' instruction defines the values which are set by the
6480    personality function (<tt>pers_fn</tt>) upon re-entry to the function, and
6481    therefore the "result type" of the <tt>landingpad</tt> instruction. As with
6482    calling conventions, how the personality function results are represented in
6483    LLVM IR is target specific.</p>
6484
6485 <p>The clauses are applied in order from top to bottom. If two
6486    <tt>landingpad</tt> instructions are merged together through inlining, the
6487    clauses from the calling function are appended to the list of clauses.
6488    When the call stack is being unwound due to an exception being thrown, the
6489    exception is compared against each <tt>clause</tt> in turn.  If it doesn't
6490    match any of the clauses, and the <tt>cleanup</tt> flag is not set, then
6491    unwinding continues further up the call stack.</p>
6492
6493 <p>The <tt>landingpad</tt> instruction has several restrictions:</p>
6494
6495 <ul>
6496   <li>A landing pad block is a basic block which is the unwind destination of an
6497       '<tt>invoke</tt>' instruction.</li>
6498   <li>A landing pad block must have a '<tt>landingpad</tt>' instruction as its
6499       first non-PHI instruction.</li>
6500   <li>There can be only one '<tt>landingpad</tt>' instruction within the landing
6501       pad block.</li>
6502   <li>A basic block that is not a landing pad block may not include a
6503       '<tt>landingpad</tt>' instruction.</li>
6504   <li>All '<tt>landingpad</tt>' instructions in a function must have the same
6505       personality function.</li>
6506 </ul>
6507
6508 <h5>Example:</h5>
6509 <pre>
6510   ;; A landing pad which can catch an integer.
6511   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6512            catch i8** @_ZTIi
6513   ;; A landing pad that is a cleanup.
6514   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6515            cleanup
6516   ;; A landing pad which can catch an integer and can only throw a double.
6517   %res = landingpad { i8*, i32 } personality i32 (...)* @__gxx_personality_v0
6518            catch i8** @_ZTIi
6519            filter [1 x i8**] [@_ZTId]
6520 </pre>
6521
6522 </div>
6523
6524 </div>
6525
6526 </div>
6527
6528 <!-- *********************************************************************** -->
6529 <h2><a name="intrinsics">Intrinsic Functions</a></h2>
6530 <!-- *********************************************************************** -->
6531
6532 <div>
6533
6534 <p>LLVM supports the notion of an "intrinsic function".  These functions have
6535    well known names and semantics and are required to follow certain
6536    restrictions.  Overall, these intrinsics represent an extension mechanism for
6537    the LLVM language that does not require changing all of the transformations
6538    in LLVM when adding to the language (or the bitcode reader/writer, the
6539    parser, etc...).</p>
6540
6541 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
6542    prefix is reserved in LLVM for intrinsic names; thus, function names may not
6543    begin with this prefix.  Intrinsic functions must always be external
6544    functions: you cannot define the body of intrinsic functions.  Intrinsic
6545    functions may only be used in call or invoke instructions: it is illegal to
6546    take the address of an intrinsic function.  Additionally, because intrinsic
6547    functions are part of the LLVM language, it is required if any are added that
6548    they be documented here.</p>
6549
6550 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
6551    family of functions that perform the same operation but on different data
6552    types. Because LLVM can represent over 8 million different integer types,
6553    overloading is used commonly to allow an intrinsic function to operate on any
6554    integer type. One or more of the argument types or the result type can be
6555    overloaded to accept any integer type. Argument types may also be defined as
6556    exactly matching a previous argument's type or the result type. This allows
6557    an intrinsic function which accepts multiple arguments, but needs all of them
6558    to be of the same type, to only be overloaded with respect to a single
6559    argument or the result.</p>
6560
6561 <p>Overloaded intrinsics will have the names of its overloaded argument types
6562    encoded into its function name, each preceded by a period. Only those types
6563    which are overloaded result in a name suffix. Arguments whose type is matched
6564    against another type do not. For example, the <tt>llvm.ctpop</tt> function
6565    can take an integer of any width and returns an integer of exactly the same
6566    integer width. This leads to a family of functions such as
6567    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
6568    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
6569    suffix is required. Because the argument's type is matched against the return
6570    type, it does not require its own name suffix.</p>
6571
6572 <p>To learn how to add an intrinsic function, please see the
6573    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
6574
6575 <!-- ======================================================================= -->
6576 <h3>
6577   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
6578 </h3>
6579
6580 <div>
6581
6582 <p>Variable argument support is defined in LLVM with
6583    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
6584    intrinsic functions.  These functions are related to the similarly named
6585    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
6586
6587 <p>All of these functions operate on arguments that use a target-specific value
6588    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
6589    not define what this type is, so all transformations should be prepared to
6590    handle these functions regardless of the type used.</p>
6591
6592 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
6593    instruction and the variable argument handling intrinsic functions are
6594    used.</p>
6595
6596 <pre class="doc_code">
6597 define i32 @test(i32 %X, ...) {
6598   ; Initialize variable argument processing
6599   %ap = alloca i8*
6600   %ap2 = bitcast i8** %ap to i8*
6601   call void @llvm.va_start(i8* %ap2)
6602
6603   ; Read a single integer argument
6604   %tmp = va_arg i8** %ap, i32
6605
6606   ; Demonstrate usage of llvm.va_copy and llvm.va_end
6607   %aq = alloca i8*
6608   %aq2 = bitcast i8** %aq to i8*
6609   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
6610   call void @llvm.va_end(i8* %aq2)
6611
6612   ; Stop processing of arguments.
6613   call void @llvm.va_end(i8* %ap2)
6614   ret i32 %tmp
6615 }
6616
6617 declare void @llvm.va_start(i8*)
6618 declare void @llvm.va_copy(i8*, i8*)
6619 declare void @llvm.va_end(i8*)
6620 </pre>
6621
6622 <!-- _______________________________________________________________________ -->
6623 <h4>
6624   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
6625 </h4>
6626
6627
6628 <div>
6629
6630 <h5>Syntax:</h5>
6631 <pre>
6632   declare void %llvm.va_start(i8* &lt;arglist&gt;)
6633 </pre>
6634
6635 <h5>Overview:</h5>
6636 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
6637    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
6638
6639 <h5>Arguments:</h5>
6640 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
6641
6642 <h5>Semantics:</h5>
6643 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
6644    macro available in C.  In a target-dependent way, it initializes
6645    the <tt>va_list</tt> element to which the argument points, so that the next
6646    call to <tt>va_arg</tt> will produce the first variable argument passed to
6647    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
6648    need to know the last argument of the function as the compiler can figure
6649    that out.</p>
6650
6651 </div>
6652
6653 <!-- _______________________________________________________________________ -->
6654 <h4>
6655  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
6656 </h4>
6657
6658 <div>
6659
6660 <h5>Syntax:</h5>
6661 <pre>
6662   declare void @llvm.va_end(i8* &lt;arglist&gt;)
6663 </pre>
6664
6665 <h5>Overview:</h5>
6666 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
6667    which has been initialized previously
6668    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
6669    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
6670
6671 <h5>Arguments:</h5>
6672 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
6673
6674 <h5>Semantics:</h5>
6675 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
6676    macro available in C.  In a target-dependent way, it destroys
6677    the <tt>va_list</tt> element to which the argument points.  Calls
6678    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
6679    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
6680    with calls to <tt>llvm.va_end</tt>.</p>
6681
6682 </div>
6683
6684 <!-- _______________________________________________________________________ -->
6685 <h4>
6686   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
6687 </h4>
6688
6689 <div>
6690
6691 <h5>Syntax:</h5>
6692 <pre>
6693   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
6694 </pre>
6695
6696 <h5>Overview:</h5>
6697 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
6698    from the source argument list to the destination argument list.</p>
6699
6700 <h5>Arguments:</h5>
6701 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
6702    The second argument is a pointer to a <tt>va_list</tt> element to copy
6703    from.</p>
6704
6705 <h5>Semantics:</h5>
6706 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
6707    macro available in C.  In a target-dependent way, it copies the
6708    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
6709    element.  This intrinsic is necessary because
6710    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
6711    arbitrarily complex and require, for example, memory allocation.</p>
6712
6713 </div>
6714
6715 </div>
6716
6717 <!-- ======================================================================= -->
6718 <h3>
6719   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
6720 </h3>
6721
6722 <div>
6723
6724 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
6725 Collection</a> (GC) requires the implementation and generation of these
6726 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
6727 roots on the stack</a>, as well as garbage collector implementations that
6728 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
6729 barriers.  Front-ends for type-safe garbage collected languages should generate
6730 these intrinsics to make use of the LLVM garbage collectors.  For more details,
6731 see <a href="GarbageCollection.html">Accurate Garbage Collection with
6732 LLVM</a>.</p>
6733
6734 <p>The garbage collection intrinsics only operate on objects in the generic
6735    address space (address space zero).</p>
6736
6737 <!-- _______________________________________________________________________ -->
6738 <h4>
6739   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
6740 </h4>
6741
6742 <div>
6743
6744 <h5>Syntax:</h5>
6745 <pre>
6746   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
6747 </pre>
6748
6749 <h5>Overview:</h5>
6750 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
6751    the code generator, and allows some metadata to be associated with it.</p>
6752
6753 <h5>Arguments:</h5>
6754 <p>The first argument specifies the address of a stack object that contains the
6755    root pointer.  The second pointer (which must be either a constant or a
6756    global value address) contains the meta-data to be associated with the
6757    root.</p>
6758
6759 <h5>Semantics:</h5>
6760 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
6761    location.  At compile-time, the code generator generates information to allow
6762    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
6763    intrinsic may only be used in a function which <a href="#gc">specifies a GC
6764    algorithm</a>.</p>
6765
6766 </div>
6767
6768 <!-- _______________________________________________________________________ -->
6769 <h4>
6770   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
6771 </h4>
6772
6773 <div>
6774
6775 <h5>Syntax:</h5>
6776 <pre>
6777   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
6778 </pre>
6779
6780 <h5>Overview:</h5>
6781 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
6782    locations, allowing garbage collector implementations that require read
6783    barriers.</p>
6784
6785 <h5>Arguments:</h5>
6786 <p>The second argument is the address to read from, which should be an address
6787    allocated from the garbage collector.  The first object is a pointer to the
6788    start of the referenced object, if needed by the language runtime (otherwise
6789    null).</p>
6790
6791 <h5>Semantics:</h5>
6792 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
6793    instruction, but may be replaced with substantially more complex code by the
6794    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
6795    may only be used in a function which <a href="#gc">specifies a GC
6796    algorithm</a>.</p>
6797
6798 </div>
6799
6800 <!-- _______________________________________________________________________ -->
6801 <h4>
6802   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
6803 </h4>
6804
6805 <div>
6806
6807 <h5>Syntax:</h5>
6808 <pre>
6809   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
6810 </pre>
6811
6812 <h5>Overview:</h5>
6813 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
6814    locations, allowing garbage collector implementations that require write
6815    barriers (such as generational or reference counting collectors).</p>
6816
6817 <h5>Arguments:</h5>
6818 <p>The first argument is the reference to store, the second is the start of the
6819    object to store it to, and the third is the address of the field of Obj to
6820    store to.  If the runtime does not require a pointer to the object, Obj may
6821    be null.</p>
6822
6823 <h5>Semantics:</h5>
6824 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
6825    instruction, but may be replaced with substantially more complex code by the
6826    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
6827    may only be used in a function which <a href="#gc">specifies a GC
6828    algorithm</a>.</p>
6829
6830 </div>
6831
6832 </div>
6833
6834 <!-- ======================================================================= -->
6835 <h3>
6836   <a name="int_codegen">Code Generator Intrinsics</a>
6837 </h3>
6838
6839 <div>
6840
6841 <p>These intrinsics are provided by LLVM to expose special features that may
6842    only be implemented with code generator support.</p>
6843
6844 <!-- _______________________________________________________________________ -->
6845 <h4>
6846   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
6847 </h4>
6848
6849 <div>
6850
6851 <h5>Syntax:</h5>
6852 <pre>
6853   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
6854 </pre>
6855
6856 <h5>Overview:</h5>
6857 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
6858    target-specific value indicating the return address of the current function
6859    or one of its callers.</p>
6860
6861 <h5>Arguments:</h5>
6862 <p>The argument to this intrinsic indicates which function to return the address
6863    for.  Zero indicates the calling function, one indicates its caller, etc.
6864    The argument is <b>required</b> to be a constant integer value.</p>
6865
6866 <h5>Semantics:</h5>
6867 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
6868    indicating the return address of the specified call frame, or zero if it
6869    cannot be identified.  The value returned by this intrinsic is likely to be
6870    incorrect or 0 for arguments other than zero, so it should only be used for
6871    debugging purposes.</p>
6872
6873 <p>Note that calling this intrinsic does not prevent function inlining or other
6874    aggressive transformations, so the value returned may not be that of the
6875    obvious source-language caller.</p>
6876
6877 </div>
6878
6879 <!-- _______________________________________________________________________ -->
6880 <h4>
6881   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
6882 </h4>
6883
6884 <div>
6885
6886 <h5>Syntax:</h5>
6887 <pre>
6888   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
6889 </pre>
6890
6891 <h5>Overview:</h5>
6892 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
6893    target-specific frame pointer value for the specified stack frame.</p>
6894
6895 <h5>Arguments:</h5>
6896 <p>The argument to this intrinsic indicates which function to return the frame
6897    pointer for.  Zero indicates the calling function, one indicates its caller,
6898    etc.  The argument is <b>required</b> to be a constant integer value.</p>
6899
6900 <h5>Semantics:</h5>
6901 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
6902    indicating the frame address of the specified call frame, or zero if it
6903    cannot be identified.  The value returned by this intrinsic is likely to be
6904    incorrect or 0 for arguments other than zero, so it should only be used for
6905    debugging purposes.</p>
6906
6907 <p>Note that calling this intrinsic does not prevent function inlining or other
6908    aggressive transformations, so the value returned may not be that of the
6909    obvious source-language caller.</p>
6910
6911 </div>
6912
6913 <!-- _______________________________________________________________________ -->
6914 <h4>
6915   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
6916 </h4>
6917
6918 <div>
6919
6920 <h5>Syntax:</h5>
6921 <pre>
6922   declare i8* @llvm.stacksave()
6923 </pre>
6924
6925 <h5>Overview:</h5>
6926 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
6927    of the function stack, for use
6928    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
6929    useful for implementing language features like scoped automatic variable
6930    sized arrays in C99.</p>
6931
6932 <h5>Semantics:</h5>
6933 <p>This intrinsic returns a opaque pointer value that can be passed
6934    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
6935    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
6936    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
6937    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
6938    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
6939    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
6940
6941 </div>
6942
6943 <!-- _______________________________________________________________________ -->
6944 <h4>
6945   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
6946 </h4>
6947
6948 <div>
6949
6950 <h5>Syntax:</h5>
6951 <pre>
6952   declare void @llvm.stackrestore(i8* %ptr)
6953 </pre>
6954
6955 <h5>Overview:</h5>
6956 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
6957    the function stack to the state it was in when the
6958    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
6959    executed.  This is useful for implementing language features like scoped
6960    automatic variable sized arrays in C99.</p>
6961
6962 <h5>Semantics:</h5>
6963 <p>See the description
6964    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
6965
6966 </div>
6967
6968 <!-- _______________________________________________________________________ -->
6969 <h4>
6970   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
6971 </h4>
6972
6973 <div>
6974
6975 <h5>Syntax:</h5>
6976 <pre>
6977   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;, i32 &lt;cache type&gt;)
6978 </pre>
6979
6980 <h5>Overview:</h5>
6981 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
6982    insert a prefetch instruction if supported; otherwise, it is a noop.
6983    Prefetches have no effect on the behavior of the program but can change its
6984    performance characteristics.</p>
6985
6986 <h5>Arguments:</h5>
6987 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
6988    specifier determining if the fetch should be for a read (0) or write (1),
6989    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
6990    locality, to (3) - extremely local keep in cache. The <tt>cache type</tt>
6991    specifies whether the prefetch is performed on the data (1) or instruction (0)
6992    cache. The <tt>rw</tt>, <tt>locality</tt> and <tt>cache type</tt> arguments
6993    must be constant integers.</p>
6994
6995 <h5>Semantics:</h5>
6996 <p>This intrinsic does not modify the behavior of the program.  In particular,
6997    prefetches cannot trap and do not produce a value.  On targets that support
6998    this intrinsic, the prefetch can provide hints to the processor cache for
6999    better performance.</p>
7000
7001 </div>
7002
7003 <!-- _______________________________________________________________________ -->
7004 <h4>
7005   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
7006 </h4>
7007
7008 <div>
7009
7010 <h5>Syntax:</h5>
7011 <pre>
7012   declare void @llvm.pcmarker(i32 &lt;id&gt;)
7013 </pre>
7014
7015 <h5>Overview:</h5>
7016 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
7017    Counter (PC) in a region of code to simulators and other tools.  The method
7018    is target specific, but it is expected that the marker will use exported
7019    symbols to transmit the PC of the marker.  The marker makes no guarantees
7020    that it will remain with any specific instruction after optimizations.  It is
7021    possible that the presence of a marker will inhibit optimizations.  The
7022    intended use is to be inserted after optimizations to allow correlations of
7023    simulation runs.</p>
7024
7025 <h5>Arguments:</h5>
7026 <p><tt>id</tt> is a numerical id identifying the marker.</p>
7027
7028 <h5>Semantics:</h5>
7029 <p>This intrinsic does not modify the behavior of the program.  Backends that do
7030    not support this intrinsic may ignore it.</p>
7031
7032 </div>
7033
7034 <!-- _______________________________________________________________________ -->
7035 <h4>
7036   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
7037 </h4>
7038
7039 <div>
7040
7041 <h5>Syntax:</h5>
7042 <pre>
7043   declare i64 @llvm.readcyclecounter()
7044 </pre>
7045
7046 <h5>Overview:</h5>
7047 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
7048    counter register (or similar low latency, high accuracy clocks) on those
7049    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
7050    should map to RPCC.  As the backing counters overflow quickly (on the order
7051    of 9 seconds on alpha), this should only be used for small timings.</p>
7052
7053 <h5>Semantics:</h5>
7054 <p>When directly supported, reading the cycle counter should not modify any
7055    memory.  Implementations are allowed to either return a application specific
7056    value or a system wide value.  On backends without support, this is lowered
7057    to a constant 0.</p>
7058
7059 </div>
7060
7061 </div>
7062
7063 <!-- ======================================================================= -->
7064 <h3>
7065   <a name="int_libc">Standard C Library Intrinsics</a>
7066 </h3>
7067
7068 <div>
7069
7070 <p>LLVM provides intrinsics for a few important standard C library functions.
7071    These intrinsics allow source-language front-ends to pass information about
7072    the alignment of the pointer arguments to the code generator, providing
7073    opportunity for more efficient code generation.</p>
7074
7075 <!-- _______________________________________________________________________ -->
7076 <h4>
7077   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
7078 </h4>
7079
7080 <div>
7081
7082 <h5>Syntax:</h5>
7083 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
7084    integer bit width and for different address spaces. Not all targets support
7085    all bit widths however.</p>
7086
7087 <pre>
7088   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7089                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7090   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7091                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7092 </pre>
7093
7094 <h5>Overview:</h5>
7095 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
7096    source location to the destination location.</p>
7097
7098 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
7099    intrinsics do not return a value, takes extra alignment/isvolatile arguments
7100    and the pointers can be in specified address spaces.</p>
7101
7102 <h5>Arguments:</h5>
7103
7104 <p>The first argument is a pointer to the destination, the second is a pointer
7105    to the source.  The third argument is an integer argument specifying the
7106    number of bytes to copy, the fourth argument is the alignment of the
7107    source and destination locations, and the fifth is a boolean indicating a
7108    volatile access.</p>
7109
7110 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7111    then the caller guarantees that both the source and destination pointers are
7112    aligned to that boundary.</p>
7113
7114 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7115    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
7116    The detailed access behavior is not very cleanly specified and it is unwise
7117    to depend on it.</p>
7118
7119 <h5>Semantics:</h5>
7120
7121 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
7122    source location to the destination location, which are not allowed to
7123    overlap.  It copies "len" bytes of memory over.  If the argument is known to
7124    be aligned to some boundary, this can be specified as the fourth argument,
7125    otherwise it should be set to 0 or 1.</p>
7126
7127 </div>
7128
7129 <!-- _______________________________________________________________________ -->
7130 <h4>
7131   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
7132 </h4>
7133
7134 <div>
7135
7136 <h5>Syntax:</h5>
7137 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
7138    width and for different address space. Not all targets support all bit
7139    widths however.</p>
7140
7141 <pre>
7142   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7143                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7144   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
7145                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7146 </pre>
7147
7148 <h5>Overview:</h5>
7149 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
7150    source location to the destination location. It is similar to the
7151    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
7152    overlap.</p>
7153
7154 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
7155    intrinsics do not return a value, takes extra alignment/isvolatile arguments
7156    and the pointers can be in specified address spaces.</p>
7157
7158 <h5>Arguments:</h5>
7159
7160 <p>The first argument is a pointer to the destination, the second is a pointer
7161    to the source.  The third argument is an integer argument specifying the
7162    number of bytes to copy, the fourth argument is the alignment of the
7163    source and destination locations, and the fifth is a boolean indicating a
7164    volatile access.</p>
7165
7166 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7167    then the caller guarantees that the source and destination pointers are
7168    aligned to that boundary.</p>
7169
7170 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7171    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
7172    The detailed access behavior is not very cleanly specified and it is unwise
7173    to depend on it.</p>
7174
7175 <h5>Semantics:</h5>
7176
7177 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
7178    source location to the destination location, which may overlap.  It copies
7179    "len" bytes of memory over.  If the argument is known to be aligned to some
7180    boundary, this can be specified as the fourth argument, otherwise it should
7181    be set to 0 or 1.</p>
7182
7183 </div>
7184
7185 <!-- _______________________________________________________________________ -->
7186 <h4>
7187   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
7188 </h4>
7189
7190 <div>
7191
7192 <h5>Syntax:</h5>
7193 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
7194    width and for different address spaces. However, not all targets support all
7195    bit widths.</p>
7196
7197 <pre>
7198   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
7199                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7200   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
7201                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
7202 </pre>
7203
7204 <h5>Overview:</h5>
7205 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
7206    particular byte value.</p>
7207
7208 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
7209    intrinsic does not return a value and takes extra alignment/volatile
7210    arguments.  Also, the destination can be in an arbitrary address space.</p>
7211
7212 <h5>Arguments:</h5>
7213 <p>The first argument is a pointer to the destination to fill, the second is the
7214    byte value with which to fill it, the third argument is an integer argument
7215    specifying the number of bytes to fill, and the fourth argument is the known
7216    alignment of the destination location.</p>
7217
7218 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
7219    then the caller guarantees that the destination pointer is aligned to that
7220    boundary.</p>
7221
7222 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
7223    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
7224    The detailed access behavior is not very cleanly specified and it is unwise
7225    to depend on it.</p>
7226
7227 <h5>Semantics:</h5>
7228 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
7229    at the destination location.  If the argument is known to be aligned to some
7230    boundary, this can be specified as the fourth argument, otherwise it should
7231    be set to 0 or 1.</p>
7232
7233 </div>
7234
7235 <!-- _______________________________________________________________________ -->
7236 <h4>
7237   <a name="int_sqrt">'<tt>llvm.sqrt.*</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.sqrt</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.sqrt.f32(float %Val)
7249   declare double    @llvm.sqrt.f64(double %Val)
7250   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
7251   declare fp128     @llvm.sqrt.f128(fp128 %Val)
7252   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
7253 </pre>
7254
7255 <h5>Overview:</h5>
7256 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
7257    returning the same value as the libm '<tt>sqrt</tt>' functions would.
7258    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
7259    behavior for negative numbers other than -0.0 (which allows for better
7260    optimization, because there is no need to worry about errno being
7261    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
7262
7263 <h5>Arguments:</h5>
7264 <p>The argument and return value are floating point numbers of the same
7265    type.</p>
7266
7267 <h5>Semantics:</h5>
7268 <p>This function returns the sqrt of the specified operand if it is a
7269    nonnegative floating point number.</p>
7270
7271 </div>
7272
7273 <!-- _______________________________________________________________________ -->
7274 <h4>
7275   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
7276 </h4>
7277
7278 <div>
7279
7280 <h5>Syntax:</h5>
7281 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
7282    floating point or vector of floating point type. Not all targets support all
7283    types however.</p>
7284
7285 <pre>
7286   declare float     @llvm.powi.f32(float  %Val, i32 %power)
7287   declare double    @llvm.powi.f64(double %Val, i32 %power)
7288   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
7289   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
7290   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
7291 </pre>
7292
7293 <h5>Overview:</h5>
7294 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
7295    specified (positive or negative) power.  The order of evaluation of
7296    multiplications is not defined.  When a vector of floating point type is
7297    used, the second argument remains a scalar integer value.</p>
7298
7299 <h5>Arguments:</h5>
7300 <p>The second argument is an integer power, and the first is a value to raise to
7301    that power.</p>
7302
7303 <h5>Semantics:</h5>
7304 <p>This function returns the first value raised to the second power with an
7305    unspecified sequence of rounding operations.</p>
7306
7307 </div>
7308
7309 <!-- _______________________________________________________________________ -->
7310 <h4>
7311   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
7312 </h4>
7313
7314 <div>
7315
7316 <h5>Syntax:</h5>
7317 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
7318    floating point or vector of floating point type. Not all targets support all
7319    types however.</p>
7320
7321 <pre>
7322   declare float     @llvm.sin.f32(float  %Val)
7323   declare double    @llvm.sin.f64(double %Val)
7324   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
7325   declare fp128     @llvm.sin.f128(fp128 %Val)
7326   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
7327 </pre>
7328
7329 <h5>Overview:</h5>
7330 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
7331
7332 <h5>Arguments:</h5>
7333 <p>The argument and return value are floating point numbers of the same
7334    type.</p>
7335
7336 <h5>Semantics:</h5>
7337 <p>This function returns the sine of the specified operand, returning the same
7338    values as the libm <tt>sin</tt> functions would, and handles error conditions
7339    in the same way.</p>
7340
7341 </div>
7342
7343 <!-- _______________________________________________________________________ -->
7344 <h4>
7345   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
7346 </h4>
7347
7348 <div>
7349
7350 <h5>Syntax:</h5>
7351 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
7352    floating point or vector of floating point type. Not all targets support all
7353    types however.</p>
7354
7355 <pre>
7356   declare float     @llvm.cos.f32(float  %Val)
7357   declare double    @llvm.cos.f64(double %Val)
7358   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
7359   declare fp128     @llvm.cos.f128(fp128 %Val)
7360   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
7361 </pre>
7362
7363 <h5>Overview:</h5>
7364 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
7365
7366 <h5>Arguments:</h5>
7367 <p>The argument and return value are floating point numbers of the same
7368    type.</p>
7369
7370 <h5>Semantics:</h5>
7371 <p>This function returns the cosine of the specified operand, returning the same
7372    values as the libm <tt>cos</tt> functions would, and handles error conditions
7373    in the same way.</p>
7374
7375 </div>
7376
7377 <!-- _______________________________________________________________________ -->
7378 <h4>
7379   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
7380 </h4>
7381
7382 <div>
7383
7384 <h5>Syntax:</h5>
7385 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
7386    floating point or vector of floating point type. Not all targets support all
7387    types however.</p>
7388
7389 <pre>
7390   declare float     @llvm.pow.f32(float  %Val, float %Power)
7391   declare double    @llvm.pow.f64(double %Val, double %Power)
7392   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
7393   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
7394   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
7395 </pre>
7396
7397 <h5>Overview:</h5>
7398 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
7399    specified (positive or negative) power.</p>
7400
7401 <h5>Arguments:</h5>
7402 <p>The second argument is a floating point power, and the first is a value to
7403    raise to that power.</p>
7404
7405 <h5>Semantics:</h5>
7406 <p>This function returns the first value raised to the second power, returning
7407    the same values as the libm <tt>pow</tt> functions would, and handles error
7408    conditions in the same way.</p>
7409
7410 </div>
7411
7412 <!-- _______________________________________________________________________ -->
7413 <h4>
7414   <a name="int_exp">'<tt>llvm.exp.*</tt>' Intrinsic</a>
7415 </h4>
7416
7417 <div>
7418
7419 <h5>Syntax:</h5>
7420 <p>This is an overloaded intrinsic. You can use <tt>llvm.exp</tt> on any
7421    floating point or vector of floating point type. Not all targets support all
7422    types however.</p>
7423
7424 <pre>
7425   declare float     @llvm.exp.f32(float  %Val)
7426   declare double    @llvm.exp.f64(double %Val)
7427   declare x86_fp80  @llvm.exp.f80(x86_fp80  %Val)
7428   declare fp128     @llvm.exp.f128(fp128 %Val)
7429   declare ppc_fp128 @llvm.exp.ppcf128(ppc_fp128  %Val)
7430 </pre>
7431
7432 <h5>Overview:</h5>
7433 <p>The '<tt>llvm.exp.*</tt>' intrinsics perform the exp function.</p>
7434
7435 <h5>Arguments:</h5>
7436 <p>The argument and return value are floating point numbers of the same
7437    type.</p>
7438
7439 <h5>Semantics:</h5>
7440 <p>This function returns the same values as the libm <tt>exp</tt> functions
7441    would, and handles error conditions in the same way.</p>
7442
7443 </div>
7444
7445 <!-- _______________________________________________________________________ -->
7446 <h4>
7447   <a name="int_log">'<tt>llvm.log.*</tt>' Intrinsic</a>
7448 </h4>
7449
7450 <div>
7451
7452 <h5>Syntax:</h5>
7453 <p>This is an overloaded intrinsic. You can use <tt>llvm.log</tt> on any
7454    floating point or vector of floating point type. Not all targets support all
7455    types however.</p>
7456
7457 <pre>
7458   declare float     @llvm.log.f32(float  %Val)
7459   declare double    @llvm.log.f64(double %Val)
7460   declare x86_fp80  @llvm.log.f80(x86_fp80  %Val)
7461   declare fp128     @llvm.log.f128(fp128 %Val)
7462   declare ppc_fp128 @llvm.log.ppcf128(ppc_fp128  %Val)
7463 </pre>
7464
7465 <h5>Overview:</h5>
7466 <p>The '<tt>llvm.log.*</tt>' intrinsics perform the log function.</p>
7467
7468 <h5>Arguments:</h5>
7469 <p>The argument and return value are floating point numbers of the same
7470    type.</p>
7471
7472 <h5>Semantics:</h5>
7473 <p>This function returns the same values as the libm <tt>log</tt> functions
7474    would, and handles error conditions in the same way.</p>
7475
7476 </div>
7477
7478 <!-- _______________________________________________________________________ -->
7479 <h4>
7480   <a name="int_fma">'<tt>llvm.fma.*</tt>' Intrinsic</a>
7481 </h4>
7482
7483 <div>
7484
7485 <h5>Syntax:</h5>
7486 <p>This is an overloaded intrinsic. You can use <tt>llvm.fma</tt> on any
7487    floating point or vector of floating point type. Not all targets support all
7488    types however.</p>
7489
7490 <pre>
7491   declare float     @llvm.fma.f32(float  %a, float  %b, float  %c)
7492   declare double    @llvm.fma.f64(double %a, double %b, double %c)
7493   declare x86_fp80  @llvm.fma.f80(x86_fp80 %a, x86_fp80 %b, x86_fp80 %c)
7494   declare fp128     @llvm.fma.f128(fp128 %a, fp128 %b, fp128 %c)
7495   declare ppc_fp128 @llvm.fma.ppcf128(ppc_fp128 %a, ppc_fp128 %b, ppc_fp128 %c)
7496 </pre>
7497
7498 <h5>Overview:</h5>
7499 <p>The '<tt>llvm.fma.*</tt>' intrinsics perform the fused multiply-add
7500    operation.</p>
7501
7502 <h5>Arguments:</h5>
7503 <p>The argument and return value are floating point numbers of the same
7504    type.</p>
7505
7506 <h5>Semantics:</h5>
7507 <p>This function returns the same values as the libm <tt>fma</tt> functions
7508    would.</p>
7509
7510 </div>
7511
7512 <!-- _______________________________________________________________________ -->
7513 <h4>
7514   <a name="int_fabs">'<tt>llvm.fabs.*</tt>' Intrinsic</a>
7515 </h4>
7516
7517 <div>
7518
7519 <h5>Syntax:</h5>
7520 <p>This is an overloaded intrinsic. You can use <tt>llvm.fabs</tt> on any
7521    floating point or vector of floating point type. Not all targets support all
7522    types however.</p>
7523
7524 <pre>
7525   declare float     @llvm.fabs.f32(float  %Val)
7526   declare double    @llvm.fabs.f64(double %Val)
7527   declare x86_fp80  @llvm.fabs.f80(x86_fp80  %Val)
7528   declare fp128     @llvm.fabs.f128(fp128 %Val)
7529   declare ppc_fp128 @llvm.fabs.ppcf128(ppc_fp128  %Val)
7530 </pre>
7531
7532 <h5>Overview:</h5>
7533 <p>The '<tt>llvm.fabs.*</tt>' intrinsics return the absolute value of
7534    the operand.</p>
7535
7536 <h5>Arguments:</h5>
7537 <p>The argument and return value are floating point numbers of the same
7538    type.</p>
7539
7540 <h5>Semantics:</h5>
7541 <p>This function returns the same values as the libm <tt>fabs</tt> functions
7542    would, and handles error conditions in the same way.</p>
7543
7544 </div>
7545
7546 </div>
7547
7548 <!-- ======================================================================= -->
7549 <h3>
7550   <a name="int_manip">Bit Manipulation Intrinsics</a>
7551 </h3>
7552
7553 <div>
7554
7555 <p>LLVM provides intrinsics for a few important bit manipulation operations.
7556    These allow efficient code generation for some algorithms.</p>
7557
7558 <!-- _______________________________________________________________________ -->
7559 <h4>
7560   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
7561 </h4>
7562
7563 <div>
7564
7565 <h5>Syntax:</h5>
7566 <p>This is an overloaded intrinsic function. You can use bswap on any integer
7567    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
7568
7569 <pre>
7570   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
7571   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
7572   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
7573 </pre>
7574
7575 <h5>Overview:</h5>
7576 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
7577    values with an even number of bytes (positive multiple of 16 bits).  These
7578    are useful for performing operations on data that is not in the target's
7579    native byte order.</p>
7580
7581 <h5>Semantics:</h5>
7582 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
7583    and low byte of the input i16 swapped.  Similarly,
7584    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
7585    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
7586    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
7587    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
7588    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
7589    more, respectively).</p>
7590
7591 </div>
7592
7593 <!-- _______________________________________________________________________ -->
7594 <h4>
7595   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
7596 </h4>
7597
7598 <div>
7599
7600 <h5>Syntax:</h5>
7601 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
7602    width, or on any vector with integer elements. Not all targets support all
7603   bit widths or vector types, however.</p>
7604
7605 <pre>
7606   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
7607   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
7608   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
7609   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
7610   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
7611   declare &lt;2 x i32&gt; @llvm.ctpop.v2i32(&lt;2 x i32&gt; &lt;src&gt;)
7612 </pre>
7613
7614 <h5>Overview:</h5>
7615 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
7616    in a value.</p>
7617
7618 <h5>Arguments:</h5>
7619 <p>The only argument is the value to be counted.  The argument may be of any
7620    integer type, or a vector with integer elements.
7621    The return type must match the argument type.</p>
7622
7623 <h5>Semantics:</h5>
7624 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable, or within each
7625    element of a vector.</p>
7626
7627 </div>
7628
7629 <!-- _______________________________________________________________________ -->
7630 <h4>
7631   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
7632 </h4>
7633
7634 <div>
7635
7636 <h5>Syntax:</h5>
7637 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
7638    integer bit width, or any vector whose elements are integers. Not all
7639    targets support all bit widths or vector types, however.</p>
7640
7641 <pre>
7642   declare i8   @llvm.ctlz.i8  (i8   &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7643   declare i16  @llvm.ctlz.i16 (i16  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7644   declare i32  @llvm.ctlz.i32 (i32  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7645   declare i64  @llvm.ctlz.i64 (i64  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7646   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7647   declase &lt;2 x i32&gt; @llvm.ctlz.v2i32(&lt;2 x i32&gt; &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7648 </pre>
7649
7650 <h5>Overview:</h5>
7651 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
7652    leading zeros in a variable.</p>
7653
7654 <h5>Arguments:</h5>
7655 <p>The first argument is the value to be counted. This argument may be of any
7656    integer type, or a vectory with integer element type. The return type
7657    must match the first argument type.</p>
7658
7659 <p>The second argument must be a constant and is a flag to indicate whether the
7660    intrinsic should ensure that a zero as the first argument produces a defined
7661    result. Historically some architectures did not provide a defined result for
7662    zero values as efficiently, and many algorithms are now predicated on
7663    avoiding zero-value inputs.</p>
7664
7665 <h5>Semantics:</h5>
7666 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
7667    zeros in a variable, or within each element of the vector.
7668    If <tt>src == 0</tt> then the result is the size in bits of the type of
7669    <tt>src</tt> if <tt>is_zero_undef == 0</tt> and <tt>undef</tt> otherwise.
7670    For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
7671
7672 </div>
7673
7674 <!-- _______________________________________________________________________ -->
7675 <h4>
7676   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
7677 </h4>
7678
7679 <div>
7680
7681 <h5>Syntax:</h5>
7682 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
7683    integer bit width, or any vector of integer elements. Not all targets
7684    support all bit widths or vector types, however.</p>
7685
7686 <pre>
7687   declare i8   @llvm.cttz.i8  (i8   &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7688   declare i16  @llvm.cttz.i16 (i16  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7689   declare i32  @llvm.cttz.i32 (i32  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7690   declare i64  @llvm.cttz.i64 (i64  &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7691   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7692   declase &lt;2 x i32&gt; @llvm.cttz.v2i32(&lt;2 x i32&gt; &lt;src&gt;, i1 &lt;is_zero_undef&gt;)
7693 </pre>
7694
7695 <h5>Overview:</h5>
7696 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
7697    trailing zeros.</p>
7698
7699 <h5>Arguments:</h5>
7700 <p>The first argument is the value to be counted. This argument may be of any
7701    integer type, or a vectory with integer element type. The return type
7702    must match the first argument type.</p>
7703
7704 <p>The second argument must be a constant and is a flag to indicate whether the
7705    intrinsic should ensure that a zero as the first argument produces a defined
7706    result. Historically some architectures did not provide a defined result for
7707    zero values as efficiently, and many algorithms are now predicated on
7708    avoiding zero-value inputs.</p>
7709
7710 <h5>Semantics:</h5>
7711 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
7712    zeros in a variable, or within each element of a vector.
7713    If <tt>src == 0</tt> then the result is the size in bits of the type of
7714    <tt>src</tt> if <tt>is_zero_undef == 0</tt> and <tt>undef</tt> otherwise.
7715    For example, <tt>llvm.cttz(2) = 1</tt>.</p>
7716
7717 </div>
7718
7719 </div>
7720
7721 <!-- ======================================================================= -->
7722 <h3>
7723   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
7724 </h3>
7725
7726 <div>
7727
7728 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
7729
7730 <!-- _______________________________________________________________________ -->
7731 <h4>
7732   <a name="int_sadd_overflow">
7733     '<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics
7734   </a>
7735 </h4>
7736
7737 <div>
7738
7739 <h5>Syntax:</h5>
7740 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
7741    on any integer bit width.</p>
7742
7743 <pre>
7744   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
7745   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7746   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
7747 </pre>
7748
7749 <h5>Overview:</h5>
7750 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7751    a signed addition of the two arguments, and indicate whether an overflow
7752    occurred during the signed summation.</p>
7753
7754 <h5>Arguments:</h5>
7755 <p>The arguments (%a and %b) and the first element of the result structure may
7756    be of integer types of any bit width, but they must have the same bit
7757    width. The second element of the result structure must be of
7758    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7759    undergo signed addition.</p>
7760
7761 <h5>Semantics:</h5>
7762 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
7763    a signed addition of the two variables. They return a structure &mdash; the
7764    first element of which is the signed summation, and the second element of
7765    which is a bit specifying if the signed summation resulted in an
7766    overflow.</p>
7767
7768 <h5>Examples:</h5>
7769 <pre>
7770   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
7771   %sum = extractvalue {i32, i1} %res, 0
7772   %obit = extractvalue {i32, i1} %res, 1
7773   br i1 %obit, label %overflow, label %normal
7774 </pre>
7775
7776 </div>
7777
7778 <!-- _______________________________________________________________________ -->
7779 <h4>
7780   <a name="int_uadd_overflow">
7781     '<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics
7782   </a>
7783 </h4>
7784
7785 <div>
7786
7787 <h5>Syntax:</h5>
7788 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
7789    on any integer bit width.</p>
7790
7791 <pre>
7792   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
7793   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7794   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
7795 </pre>
7796
7797 <h5>Overview:</h5>
7798 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7799    an unsigned addition of the two arguments, and indicate whether a carry
7800    occurred during the unsigned summation.</p>
7801
7802 <h5>Arguments:</h5>
7803 <p>The arguments (%a and %b) and the first element of the result structure may
7804    be of integer types of any bit width, but they must have the same bit
7805    width. The second element of the result structure must be of
7806    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7807    undergo unsigned addition.</p>
7808
7809 <h5>Semantics:</h5>
7810 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
7811    an unsigned addition of the two arguments. They return a structure &mdash;
7812    the first element of which is the sum, and the second element of which is a
7813    bit specifying if the unsigned summation resulted in a carry.</p>
7814
7815 <h5>Examples:</h5>
7816 <pre>
7817   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
7818   %sum = extractvalue {i32, i1} %res, 0
7819   %obit = extractvalue {i32, i1} %res, 1
7820   br i1 %obit, label %carry, label %normal
7821 </pre>
7822
7823 </div>
7824
7825 <!-- _______________________________________________________________________ -->
7826 <h4>
7827   <a name="int_ssub_overflow">
7828     '<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics
7829   </a>
7830 </h4>
7831
7832 <div>
7833
7834 <h5>Syntax:</h5>
7835 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
7836    on any integer bit width.</p>
7837
7838 <pre>
7839   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
7840   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7841   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
7842 </pre>
7843
7844 <h5>Overview:</h5>
7845 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7846    a signed subtraction of the two arguments, and indicate whether an overflow
7847    occurred during the signed subtraction.</p>
7848
7849 <h5>Arguments:</h5>
7850 <p>The arguments (%a and %b) and the first element of the result structure may
7851    be of integer types of any bit width, but they must have the same bit
7852    width. The second element of the result structure must be of
7853    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7854    undergo signed subtraction.</p>
7855
7856 <h5>Semantics:</h5>
7857 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
7858    a signed subtraction of the two arguments. They return a structure &mdash;
7859    the first element of which is the subtraction, and the second element of
7860    which is a bit specifying if the signed subtraction resulted in an
7861    overflow.</p>
7862
7863 <h5>Examples:</h5>
7864 <pre>
7865   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
7866   %sum = extractvalue {i32, i1} %res, 0
7867   %obit = extractvalue {i32, i1} %res, 1
7868   br i1 %obit, label %overflow, label %normal
7869 </pre>
7870
7871 </div>
7872
7873 <!-- _______________________________________________________________________ -->
7874 <h4>
7875   <a name="int_usub_overflow">
7876     '<tt>llvm.usub.with.overflow.*</tt>' Intrinsics
7877   </a>
7878 </h4>
7879
7880 <div>
7881
7882 <h5>Syntax:</h5>
7883 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
7884    on any integer bit width.</p>
7885
7886 <pre>
7887   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
7888   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7889   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
7890 </pre>
7891
7892 <h5>Overview:</h5>
7893 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7894    an unsigned subtraction of the two arguments, and indicate whether an
7895    overflow occurred during the unsigned subtraction.</p>
7896
7897 <h5>Arguments:</h5>
7898 <p>The arguments (%a and %b) and the first element of the result structure may
7899    be of integer types of any bit width, but they must have the same bit
7900    width. The second element of the result structure must be of
7901    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7902    undergo unsigned subtraction.</p>
7903
7904 <h5>Semantics:</h5>
7905 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
7906    an unsigned subtraction of the two arguments. They return a structure &mdash;
7907    the first element of which is the subtraction, and the second element of
7908    which is a bit specifying if the unsigned subtraction resulted in an
7909    overflow.</p>
7910
7911 <h5>Examples:</h5>
7912 <pre>
7913   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
7914   %sum = extractvalue {i32, i1} %res, 0
7915   %obit = extractvalue {i32, i1} %res, 1
7916   br i1 %obit, label %overflow, label %normal
7917 </pre>
7918
7919 </div>
7920
7921 <!-- _______________________________________________________________________ -->
7922 <h4>
7923   <a name="int_smul_overflow">
7924     '<tt>llvm.smul.with.overflow.*</tt>' Intrinsics
7925   </a>
7926 </h4>
7927
7928 <div>
7929
7930 <h5>Syntax:</h5>
7931 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
7932    on any integer bit width.</p>
7933
7934 <pre>
7935   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
7936   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7937   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
7938 </pre>
7939
7940 <h5>Overview:</h5>
7941
7942 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7943    a signed multiplication of the two arguments, and indicate whether an
7944    overflow occurred during the signed multiplication.</p>
7945
7946 <h5>Arguments:</h5>
7947 <p>The arguments (%a and %b) and the first element of the result structure may
7948    be of integer types of any bit width, but they must have the same bit
7949    width. The second element of the result structure must be of
7950    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7951    undergo signed multiplication.</p>
7952
7953 <h5>Semantics:</h5>
7954 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
7955    a signed multiplication of the two arguments. They return a structure &mdash;
7956    the first element of which is the multiplication, and the second element of
7957    which is a bit specifying if the signed multiplication resulted in an
7958    overflow.</p>
7959
7960 <h5>Examples:</h5>
7961 <pre>
7962   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
7963   %sum = extractvalue {i32, i1} %res, 0
7964   %obit = extractvalue {i32, i1} %res, 1
7965   br i1 %obit, label %overflow, label %normal
7966 </pre>
7967
7968 </div>
7969
7970 <!-- _______________________________________________________________________ -->
7971 <h4>
7972   <a name="int_umul_overflow">
7973     '<tt>llvm.umul.with.overflow.*</tt>' Intrinsics
7974   </a>
7975 </h4>
7976
7977 <div>
7978
7979 <h5>Syntax:</h5>
7980 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
7981    on any integer bit width.</p>
7982
7983 <pre>
7984   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
7985   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
7986   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
7987 </pre>
7988
7989 <h5>Overview:</h5>
7990 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
7991    a unsigned multiplication of the two arguments, and indicate whether an
7992    overflow occurred during the unsigned multiplication.</p>
7993
7994 <h5>Arguments:</h5>
7995 <p>The arguments (%a and %b) and the first element of the result structure may
7996    be of integer types of any bit width, but they must have the same bit
7997    width. The second element of the result structure must be of
7998    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
7999    undergo unsigned multiplication.</p>
8000
8001 <h5>Semantics:</h5>
8002 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
8003    an unsigned multiplication of the two arguments. They return a structure
8004    &mdash; the first element of which is the multiplication, and the second
8005    element of which is a bit specifying if the unsigned multiplication resulted
8006    in an overflow.</p>
8007
8008 <h5>Examples:</h5>
8009 <pre>
8010   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
8011   %sum = extractvalue {i32, i1} %res, 0
8012   %obit = extractvalue {i32, i1} %res, 1
8013   br i1 %obit, label %overflow, label %normal
8014 </pre>
8015
8016 </div>
8017
8018 </div>
8019
8020 <!-- ======================================================================= -->
8021 <h3>
8022   <a name="spec_arithmetic">Specialised Arithmetic Intrinsics</a>
8023 </h3>
8024
8025 <!-- _______________________________________________________________________ -->
8026
8027 <h4>
8028   <a name="fmuladd">'<tt>llvm.fmuladd.*</tt>' Intrinsic</a>
8029 </h4>
8030
8031 <div>
8032
8033 <h5>Syntax:</h5>
8034 <pre>
8035   declare float @llvm.fmuladd.f32(float %a, float %b, float %c)
8036   declare double @llvm.fmuladd.f64(double %a, double %b, double %c)
8037 </pre>
8038
8039 <h5>Overview:</h5>
8040 <p>The '<tt>llvm.fmuladd.*</tt>' intrinsic functions represent multiply-add
8041 expressions that can be fused if the code generator determines that the fused
8042 expression would be legal and efficient.</p>
8043
8044 <h5>Arguments:</h5>
8045 <p>The '<tt>llvm.fmuladd.*</tt>' intrinsics each take three arguments: two
8046 multiplicands, a and b, and an addend c.</p>
8047
8048 <h5>Semantics:</h5>
8049 <p>The expression:</p>
8050 <pre>
8051   %0 = call float @llvm.fmuladd.f32(%a, %b, %c)
8052 </pre>
8053 <p>is equivalent to the expression a * b + c, except that rounding will not be
8054 performed between the multiplication and addition steps if the code generator
8055 fuses the operations. Fusion is not guaranteed, even if the target platform
8056 supports it. If a fused multiply-add is required the corresponding llvm.fma.*
8057 intrinsic function should be used instead.</p>
8058
8059 <h5>Examples:</h5>
8060 <pre>
8061   %r2 = call float @llvm.fmuladd.f32(float %a, float %b, float %c) ; yields {float}:r2 = (a * b) + c
8062 </pre>
8063
8064 </div>
8065
8066 <!-- ======================================================================= -->
8067 <h3>
8068   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
8069 </h3>
8070
8071 <div>
8072
8073 <p>For most target platforms, half precision floating point is a storage-only
8074    format. This means that it is
8075    a dense encoding (in memory) but does not support computation in the
8076    format.</p>
8077
8078 <p>This means that code must first load the half-precision floating point
8079    value as an i16, then convert it to float with <a
8080    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
8081    Computation can then be performed on the float value (including extending to
8082    double etc).  To store the value back to memory, it is first converted to
8083    float if needed, then converted to i16 with
8084    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
8085    storing as an i16 value.</p>
8086
8087 <!-- _______________________________________________________________________ -->
8088 <h4>
8089   <a name="int_convert_to_fp16">
8090     '<tt>llvm.convert.to.fp16</tt>' Intrinsic
8091   </a>
8092 </h4>
8093
8094 <div>
8095
8096 <h5>Syntax:</h5>
8097 <pre>
8098   declare i16 @llvm.convert.to.fp16(f32 %a)
8099 </pre>
8100
8101 <h5>Overview:</h5>
8102 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
8103    a conversion from single precision floating point format to half precision
8104    floating point format.</p>
8105
8106 <h5>Arguments:</h5>
8107 <p>The intrinsic function contains single argument - the value to be
8108    converted.</p>
8109
8110 <h5>Semantics:</h5>
8111 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
8112    a conversion from single precision floating point format to half precision
8113    floating point format. The return value is an <tt>i16</tt> which
8114    contains the converted number.</p>
8115
8116 <h5>Examples:</h5>
8117 <pre>
8118   %res = call i16 @llvm.convert.to.fp16(f32 %a)
8119   store i16 %res, i16* @x, align 2
8120 </pre>
8121
8122 </div>
8123
8124 <!-- _______________________________________________________________________ -->
8125 <h4>
8126   <a name="int_convert_from_fp16">
8127     '<tt>llvm.convert.from.fp16</tt>' Intrinsic
8128   </a>
8129 </h4>
8130
8131 <div>
8132
8133 <h5>Syntax:</h5>
8134 <pre>
8135   declare f32 @llvm.convert.from.fp16(i16 %a)
8136 </pre>
8137
8138 <h5>Overview:</h5>
8139 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
8140    a conversion from half precision floating point format to single precision
8141    floating point format.</p>
8142
8143 <h5>Arguments:</h5>
8144 <p>The intrinsic function contains single argument - the value to be
8145    converted.</p>
8146
8147 <h5>Semantics:</h5>
8148 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
8149    conversion from half single precision floating point format to single
8150    precision floating point format. The input half-float value is represented by
8151    an <tt>i16</tt> value.</p>
8152
8153 <h5>Examples:</h5>
8154 <pre>
8155   %a = load i16* @x, align 2
8156   %res = call f32 @llvm.convert.from.fp16(i16 %a)
8157 </pre>
8158
8159 </div>
8160
8161 </div>
8162
8163 <!-- ======================================================================= -->
8164 <h3>
8165   <a name="int_debugger">Debugger Intrinsics</a>
8166 </h3>
8167
8168 <div>
8169
8170 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
8171    prefix), are described in
8172    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
8173    Level Debugging</a> document.</p>
8174
8175 </div>
8176
8177 <!-- ======================================================================= -->
8178 <h3>
8179   <a name="int_eh">Exception Handling Intrinsics</a>
8180 </h3>
8181
8182 <div>
8183
8184 <p>The LLVM exception handling intrinsics (which all start with
8185    <tt>llvm.eh.</tt> prefix), are described in
8186    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
8187    Handling</a> document.</p>
8188
8189 </div>
8190
8191 <!-- ======================================================================= -->
8192 <h3>
8193   <a name="int_trampoline">Trampoline Intrinsics</a>
8194 </h3>
8195
8196 <div>
8197
8198 <p>These intrinsics make it possible to excise one parameter, marked with
8199    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
8200    The result is a callable
8201    function pointer lacking the nest parameter - the caller does not need to
8202    provide a value for it.  Instead, the value to use is stored in advance in a
8203    "trampoline", a block of memory usually allocated on the stack, which also
8204    contains code to splice the nest value into the argument list.  This is used
8205    to implement the GCC nested function address extension.</p>
8206
8207 <p>For example, if the function is
8208    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
8209    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
8210    follows:</p>
8211
8212 <pre class="doc_code">
8213   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
8214   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
8215   call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8*, i32, i32)* @f to i8*), i8* %nval)
8216   %p = call i8* @llvm.adjust.trampoline(i8* %tramp1)
8217   %fp = bitcast i8* %p to i32 (i32, i32)*
8218 </pre>
8219
8220 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
8221    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
8222
8223 <!-- _______________________________________________________________________ -->
8224 <h4>
8225   <a name="int_it">
8226     '<tt>llvm.init.trampoline</tt>' Intrinsic
8227   </a>
8228 </h4>
8229
8230 <div>
8231
8232 <h5>Syntax:</h5>
8233 <pre>
8234   declare void @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
8235 </pre>
8236
8237 <h5>Overview:</h5>
8238 <p>This fills the memory pointed to by <tt>tramp</tt> with executable code,
8239    turning it into a trampoline.</p>
8240
8241 <h5>Arguments:</h5>
8242 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
8243    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
8244    sufficiently aligned block of memory; this memory is written to by the
8245    intrinsic.  Note that the size and the alignment are target-specific - LLVM
8246    currently provides no portable way of determining them, so a front-end that
8247    generates this intrinsic needs to have some target-specific knowledge.
8248    The <tt>func</tt> argument must hold a function bitcast to
8249    an <tt>i8*</tt>.</p>
8250
8251 <h5>Semantics:</h5>
8252 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
8253    dependent code, turning it into a function.  Then <tt>tramp</tt> needs to be
8254    passed to <a href="#int_at">llvm.adjust.trampoline</a> to get a pointer
8255    which can be <a href="#int_trampoline">bitcast (to a new function) and
8256    called</a>.  The new function's signature is the same as that of
8257    <tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
8258    removed.  At most one such <tt>nest</tt> argument is allowed, and it must be of
8259    pointer type.  Calling the new function is equivalent to calling <tt>func</tt>
8260    with the same argument list, but with <tt>nval</tt> used for the missing
8261    <tt>nest</tt> argument.  If, after calling <tt>llvm.init.trampoline</tt>, the
8262    memory pointed to by <tt>tramp</tt> is modified, then the effect of any later call
8263    to the returned function pointer is undefined.</p>
8264 </div>
8265
8266 <!-- _______________________________________________________________________ -->
8267 <h4>
8268   <a name="int_at">
8269     '<tt>llvm.adjust.trampoline</tt>' Intrinsic
8270   </a>
8271 </h4>
8272
8273 <div>
8274
8275 <h5>Syntax:</h5>
8276 <pre>
8277   declare i8* @llvm.adjust.trampoline(i8* &lt;tramp&gt;)
8278 </pre>
8279
8280 <h5>Overview:</h5>
8281 <p>This performs any required machine-specific adjustment to the address of a
8282    trampoline (passed as <tt>tramp</tt>).</p>
8283
8284 <h5>Arguments:</h5>
8285 <p><tt>tramp</tt> must point to a block of memory which already has trampoline code
8286    filled in by a previous call to <a href="#int_it"><tt>llvm.init.trampoline</tt>
8287    </a>.</p>
8288
8289 <h5>Semantics:</h5>
8290 <p>On some architectures the address of the code to be executed needs to be
8291    different to the address where the trampoline is actually stored.  This
8292    intrinsic returns the executable address corresponding to <tt>tramp</tt>
8293    after performing the required machine specific adjustments.
8294    The pointer returned can then be <a href="#int_trampoline"> bitcast and
8295    executed</a>.
8296 </p>
8297
8298 </div>
8299
8300 </div>
8301
8302 <!-- ======================================================================= -->
8303 <h3>
8304   <a name="int_memorymarkers">Memory Use Markers</a>
8305 </h3>
8306
8307 <div>
8308
8309 <p>This class of intrinsics exists to information about the lifetime of memory
8310    objects and ranges where variables are immutable.</p>
8311
8312 <!-- _______________________________________________________________________ -->
8313 <h4>
8314   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
8315 </h4>
8316
8317 <div>
8318
8319 <h5>Syntax:</h5>
8320 <pre>
8321   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8322 </pre>
8323
8324 <h5>Overview:</h5>
8325 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
8326    object's lifetime.</p>
8327
8328 <h5>Arguments:</h5>
8329 <p>The first argument is a constant integer representing the size of the
8330    object, or -1 if it is variable sized.  The second argument is a pointer to
8331    the object.</p>
8332
8333 <h5>Semantics:</h5>
8334 <p>This intrinsic indicates that before this point in the code, the value of the
8335    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8336    never be used and has an undefined value.  A load from the pointer that
8337    precedes this intrinsic can be replaced with
8338    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
8339
8340 </div>
8341
8342 <!-- _______________________________________________________________________ -->
8343 <h4>
8344   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
8345 </h4>
8346
8347 <div>
8348
8349 <h5>Syntax:</h5>
8350 <pre>
8351   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8352 </pre>
8353
8354 <h5>Overview:</h5>
8355 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
8356    object's lifetime.</p>
8357
8358 <h5>Arguments:</h5>
8359 <p>The first argument is a constant integer representing the size of the
8360    object, or -1 if it is variable sized.  The second argument is a pointer to
8361    the object.</p>
8362
8363 <h5>Semantics:</h5>
8364 <p>This intrinsic indicates that after this point in the code, the value of the
8365    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
8366    never be used and has an undefined value.  Any stores into the memory object
8367    following this intrinsic may be removed as dead.
8368
8369 </div>
8370
8371 <!-- _______________________________________________________________________ -->
8372 <h4>
8373   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
8374 </h4>
8375
8376 <div>
8377
8378 <h5>Syntax:</h5>
8379 <pre>
8380   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8381 </pre>
8382
8383 <h5>Overview:</h5>
8384 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
8385    a memory object will not change.</p>
8386
8387 <h5>Arguments:</h5>
8388 <p>The first argument is a constant integer representing the size of the
8389    object, or -1 if it is variable sized.  The second argument is a pointer to
8390    the object.</p>
8391
8392 <h5>Semantics:</h5>
8393 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
8394    the return value, the referenced memory location is constant and
8395    unchanging.</p>
8396
8397 </div>
8398
8399 <!-- _______________________________________________________________________ -->
8400 <h4>
8401   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
8402 </h4>
8403
8404 <div>
8405
8406 <h5>Syntax:</h5>
8407 <pre>
8408   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
8409 </pre>
8410
8411 <h5>Overview:</h5>
8412 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
8413    a memory object are mutable.</p>
8414
8415 <h5>Arguments:</h5>
8416 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
8417    The second argument is a constant integer representing the size of the
8418    object, or -1 if it is variable sized and the third argument is a pointer
8419    to the object.</p>
8420
8421 <h5>Semantics:</h5>
8422 <p>This intrinsic indicates that the memory is mutable again.</p>
8423
8424 </div>
8425
8426 </div>
8427
8428 <!-- ======================================================================= -->
8429 <h3>
8430   <a name="int_general">General Intrinsics</a>
8431 </h3>
8432
8433 <div>
8434
8435 <p>This class of intrinsics is designed to be generic and has no specific
8436    purpose.</p>
8437
8438 <!-- _______________________________________________________________________ -->
8439 <h4>
8440   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
8441 </h4>
8442
8443 <div>
8444
8445 <h5>Syntax:</h5>
8446 <pre>
8447   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8448 </pre>
8449
8450 <h5>Overview:</h5>
8451 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
8452
8453 <h5>Arguments:</h5>
8454 <p>The first argument is a pointer to a value, the second is a pointer to a
8455    global string, the third is a pointer to a global string which is the source
8456    file name, and the last argument is the line number.</p>
8457
8458 <h5>Semantics:</h5>
8459 <p>This intrinsic allows annotation of local variables with arbitrary strings.
8460    This can be useful for special purpose optimizations that want to look for
8461    these annotations.  These have no other defined use; they are ignored by code
8462    generation and optimization.</p>
8463
8464 </div>
8465
8466 <!-- _______________________________________________________________________ -->
8467 <h4>
8468   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
8469 </h4>
8470
8471 <div>
8472
8473 <h5>Syntax:</h5>
8474 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
8475    any integer bit width.</p>
8476
8477 <pre>
8478   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8479   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8480   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8481   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8482   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
8483 </pre>
8484
8485 <h5>Overview:</h5>
8486 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
8487
8488 <h5>Arguments:</h5>
8489 <p>The first argument is an integer value (result of some expression), the
8490    second is a pointer to a global string, the third is a pointer to a global
8491    string which is the source file name, and the last argument is the line
8492    number.  It returns the value of the first argument.</p>
8493
8494 <h5>Semantics:</h5>
8495 <p>This intrinsic allows annotations to be put on arbitrary expressions with
8496    arbitrary strings.  This can be useful for special purpose optimizations that
8497    want to look for these annotations.  These have no other defined use; they
8498    are ignored by code generation and optimization.</p>
8499
8500 </div>
8501
8502 <!-- _______________________________________________________________________ -->
8503 <h4>
8504   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
8505 </h4>
8506
8507 <div>
8508
8509 <h5>Syntax:</h5>
8510 <pre>
8511   declare void @llvm.trap() noreturn nounwind
8512 </pre>
8513
8514 <h5>Overview:</h5>
8515 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
8516
8517 <h5>Arguments:</h5>
8518 <p>None.</p>
8519
8520 <h5>Semantics:</h5>
8521 <p>This intrinsic is lowered to the target dependent trap instruction. If the
8522    target does not have a trap instruction, this intrinsic will be lowered to
8523    a call of the <tt>abort()</tt> function.</p>
8524
8525 </div>
8526
8527 <!-- _______________________________________________________________________ -->
8528 <h4>
8529   <a name="int_debugtrap">'<tt>llvm.debugtrap</tt>' Intrinsic</a>
8530 </h4>
8531
8532 <div>
8533
8534 <h5>Syntax:</h5>
8535 <pre>
8536   declare void @llvm.debugtrap() nounwind
8537 </pre>
8538
8539 <h5>Overview:</h5>
8540 <p>The '<tt>llvm.debugtrap</tt>' intrinsic.</p>
8541
8542 <h5>Arguments:</h5>
8543 <p>None.</p>
8544
8545 <h5>Semantics:</h5>
8546 <p>This intrinsic is lowered to code which is intended to cause an execution
8547    trap with the intention of requesting the attention of a debugger.</p>
8548
8549 </div>
8550
8551 <!-- _______________________________________________________________________ -->
8552 <h4>
8553   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
8554 </h4>
8555
8556 <div>
8557
8558 <h5>Syntax:</h5>
8559 <pre>
8560   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
8561 </pre>
8562
8563 <h5>Overview:</h5>
8564 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
8565    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
8566    ensure that it is placed on the stack before local variables.</p>
8567
8568 <h5>Arguments:</h5>
8569 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
8570    arguments. The first argument is the value loaded from the stack
8571    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
8572    that has enough space to hold the value of the guard.</p>
8573
8574 <h5>Semantics:</h5>
8575 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
8576    the <tt>AllocaInst</tt> stack slot to be before local variables on the
8577    stack. This is to ensure that if a local variable on the stack is
8578    overwritten, it will destroy the value of the guard. When the function exits,
8579    the guard on the stack is checked against the original guard. If they are
8580    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
8581    function.</p>
8582
8583 </div>
8584
8585 <!-- _______________________________________________________________________ -->
8586 <h4>
8587   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
8588 </h4>
8589
8590 <div>
8591
8592 <h5>Syntax:</h5>
8593 <pre>
8594   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;min&gt;)
8595   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;min&gt;)
8596 </pre>
8597
8598 <h5>Overview:</h5>
8599 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
8600    the optimizers to determine at compile time whether a) an operation (like
8601    memcpy) will overflow a buffer that corresponds to an object, or b) that a
8602    runtime check for overflow isn't necessary. An object in this context means
8603    an allocation of a specific class, structure, array, or other object.</p>
8604
8605 <h5>Arguments:</h5>
8606 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
8607    argument is a pointer to or into the <tt>object</tt>. The second argument
8608    is a boolean and determines whether <tt>llvm.objectsize</tt> returns 0 (if
8609    true) or -1 (if false) when the object size is unknown.
8610    The second argument only accepts constants.</p>
8611
8612 <h5>Semantics:</h5>
8613 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to a constant representing
8614    the size of the object concerned. If the size cannot be determined at compile
8615    time, <tt>llvm.objectsize</tt> returns <tt>i32/i64 -1 or 0</tt>
8616    (depending on the <tt>min</tt> argument).</p>
8617
8618 </div>
8619 <!-- _______________________________________________________________________ -->
8620 <h4>
8621   <a name="int_expect">'<tt>llvm.expect</tt>' Intrinsic</a>
8622 </h4>
8623
8624 <div>
8625
8626 <h5>Syntax:</h5>
8627 <pre>
8628   declare i32 @llvm.expect.i32(i32 &lt;val&gt;, i32 &lt;expected_val&gt;)
8629   declare i64 @llvm.expect.i64(i64 &lt;val&gt;, i64 &lt;expected_val&gt;)
8630 </pre>
8631
8632 <h5>Overview:</h5>
8633 <p>The <tt>llvm.expect</tt> intrinsic provides information about expected (the
8634    most probable) value of <tt>val</tt>, which can be used by optimizers.</p>
8635
8636 <h5>Arguments:</h5>
8637 <p>The <tt>llvm.expect</tt> intrinsic takes two arguments. The first
8638    argument is a value. The second argument is an expected value, this needs to
8639    be a constant value, variables are not allowed.</p>
8640
8641 <h5>Semantics:</h5>
8642 <p>This intrinsic is lowered to the <tt>val</tt>.</p>
8643 </div>
8644
8645 <!-- _______________________________________________________________________ -->
8646 <h4>
8647   <a name="int_donothing">'<tt>llvm.donothing</tt>' Intrinsic</a>
8648 </h4>
8649
8650 <div>
8651
8652 <h5>Syntax:</h5>
8653 <pre>
8654   declare void @llvm.donothing() nounwind readnone
8655 </pre>
8656
8657 <h5>Overview:</h5>
8658 <p>The <tt>llvm.donothing</tt> intrinsic doesn't perform any operation. It's the
8659 only intrinsic that can be called with an invoke instruction.</p>
8660
8661 <h5>Arguments:</h5>
8662 <p>None.</p>
8663
8664 <h5>Semantics:</h5>
8665 <p>This intrinsic does nothing, and it's removed by optimizers and ignored by
8666 codegen.</p>
8667 </div>
8668
8669 </div>
8670
8671 </div>
8672 <!-- *********************************************************************** -->
8673 <hr>
8674 <address>
8675   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
8676   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
8677   <a href="http://validator.w3.org/check/referer"><img
8678   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
8679
8680   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
8681   <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
8682   Last modified: $Date$
8683 </address>
8684
8685 </body>
8686 </html>