docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Assembly Language Reference Manual</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   7   <meta name="author" content="Chris Lattner">
   8   <meta name="description"
   9   content="LLVM Assembly Language Reference Manual.">
  10   <link rel="stylesheet" href="llvm.css" type="text/css">
  11 </head>
  12
  13 <body>
  14
  15 <div class="doc_title"> LLVM Language Reference Manual </div>
  16 <ol>
  17   <li><a href="#abstract">Abstract</a></li>
  18   <li><a href="#introduction">Introduction</a></li>
  19   <li><a href="#identifiers">Identifiers</a></li>
  20   <li><a href="#highlevel">High Level Structure</a>
  21     <ol>
  22       <li><a href="#modulestructure">Module Structure</a></li>
  23       <li><a href="#linkage">Linkage Types</a>
  24         <ol>
  25           <li><a href="#linkage_private">'<tt>private</tt>' Linkage</a></li>
  26           <li><a href="#linkage_linker_private">'<tt>linker_private</tt>' Linkage</a></li>
  27           <li><a href="#linkage_linker_private_weak">'<tt>linker_private_weak</tt>' Linkage</a></li>
  28           <li><a href="#linkage_linker_private_weak_def_auto">'<tt>linker_private_weak_def_auto</tt>' Linkage</a></li>
  29           <li><a href="#linkage_internal">'<tt>internal</tt>' Linkage</a></li>
  30           <li><a href="#linkage_available_externally">'<tt>available_externally</tt>' Linkage</a></li>
  31           <li><a href="#linkage_linkonce">'<tt>linkonce</tt>' Linkage</a></li>
  32           <li><a href="#linkage_common">'<tt>common</tt>' Linkage</a></li>
  33           <li><a href="#linkage_weak">'<tt>weak</tt>' Linkage</a></li>
  34           <li><a href="#linkage_appending">'<tt>appending</tt>' Linkage</a></li>
  35           <li><a href="#linkage_externweak">'<tt>extern_weak</tt>' Linkage</a></li>
  36           <li><a href="#linkage_linkonce_odr">'<tt>linkonce_odr</tt>' Linkage</a></li>
  37           <li><a href="#linkage_weak">'<tt>weak_odr</tt>' Linkage</a></li>
  38           <li><a href="#linkage_external">'<tt>externally visible</tt>' Linkage</a></li>
  39           <li><a href="#linkage_dllimport">'<tt>dllimport</tt>' Linkage</a></li>
  40           <li><a href="#linkage_dllexport">'<tt>dllexport</tt>' Linkage</a></li>
  41         </ol>
  42       </li>
  43       <li><a href="#callingconv">Calling Conventions</a></li>
  44       <li><a href="#namedtypes">Named Types</a></li>
  45       <li><a href="#globalvars">Global Variables</a></li>
  46       <li><a href="#functionstructure">Functions</a></li>
  47       <li><a href="#aliasstructure">Aliases</a></li>
  48       <li><a href="#namedmetadatastructure">Named Metadata</a></li>
  49       <li><a href="#paramattrs">Parameter Attributes</a></li>
  50       <li><a href="#fnattrs">Function Attributes</a></li>
  51       <li><a href="#gc">Garbage Collector Names</a></li>
  52       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  53       <li><a href="#datalayout">Data Layout</a></li>
  54       <li><a href="#pointeraliasing">Pointer Aliasing Rules</a></li>
  55       <li><a href="#volatile">Volatile Memory Accesses</a></li>
  56     </ol>
  57   </li>
  58   <li><a href="#typesystem">Type System</a>
  59     <ol>
  60       <li><a href="#t_classifications">Type Classifications</a></li>
  61       <li><a href="#t_primitive">Primitive Types</a>
  62         <ol>
  63           <li><a href="#t_integer">Integer Type</a></li>
  64           <li><a href="#t_floating">Floating Point Types</a></li>
  65           <li><a href="#t_x86mmx">X86mmx Type</a></li>
  66           <li><a href="#t_void">Void Type</a></li>
  67           <li><a href="#t_label">Label Type</a></li>
  68           <li><a href="#t_metadata">Metadata Type</a></li>
  69         </ol>
  70       </li>
  71       <li><a href="#t_derived">Derived Types</a>
  72         <ol>
  73           <li><a href="#t_aggregate">Aggregate Types</a>
  74             <ol>
  75               <li><a href="#t_array">Array Type</a></li>
  76               <li><a href="#t_struct">Structure Type</a></li>
  77               <li><a href="#t_pstruct">Packed Structure Type</a></li>
  78               <li><a href="#t_vector">Vector Type</a></li>
  79             </ol>
  80           </li>
  81           <li><a href="#t_function">Function Type</a></li>
  82           <li><a href="#t_pointer">Pointer Type</a></li>
  83           <li><a href="#t_opaque">Opaque Type</a></li>
  84         </ol>
  85       </li>
  86       <li><a href="#t_uprefs">Type Up-references</a></li>
  87     </ol>
  88   </li>
  89   <li><a href="#constants">Constants</a>
  90     <ol>
  91       <li><a href="#simpleconstants">Simple Constants</a></li>
  92       <li><a href="#complexconstants">Complex Constants</a></li>
  93       <li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
  94       <li><a href="#undefvalues">Undefined Values</a></li>
  95       <li><a href="#trapvalues">Trap Values</a></li>
  96       <li><a href="#blockaddress">Addresses of Basic Blocks</a></li>
  97       <li><a href="#constantexprs">Constant Expressions</a></li>
  98     </ol>
  99   </li>
 100   <li><a href="#othervalues">Other Values</a>
 101     <ol>
 102       <li><a href="#inlineasm">Inline Assembler Expressions</a></li>
 103       <li><a href="#metadata">Metadata Nodes and Metadata Strings</a></li>
 104     </ol>
 105   </li>
 106   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 107     <ol>
 108       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 109       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 110           Global Variable</a></li>
 111       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 112          Global Variable</a></li>
 113       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 114          Global Variable</a></li>
 115     </ol>
 116   </li>
 117   <li><a href="#instref">Instruction Reference</a>
 118     <ol>
 119       <li><a href="#terminators">Terminator Instructions</a>
 120         <ol>
 121           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 122           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 123           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 124           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 125           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 126           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
 127           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 128         </ol>
 129       </li>
 130       <li><a href="#binaryops">Binary Operations</a>
 131         <ol>
 132           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 133           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 134           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 135           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 136           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 137           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 138           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 139           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 140           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 141           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 142           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 143           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 144         </ol>
 145       </li>
 146       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 147         <ol>
 148           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 149           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 150           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 151           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 152           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 153           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 154         </ol>
 155       </li>
 156       <li><a href="#vectorops">Vector Operations</a>
 157         <ol>
 158           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 159           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 160           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 161         </ol>
 162       </li>
 163       <li><a href="#aggregateops">Aggregate Operations</a>
 164         <ol>
 165           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 166           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 167         </ol>
 168       </li>
 169       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 170         <ol>
 171           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
 172          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 173          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 174          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 175         </ol>
 176       </li>
 177       <li><a href="#convertops">Conversion Operations</a>
 178         <ol>
 179           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 180           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 181           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 182           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 183           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 184           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 185           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 186           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 187           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 188           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 191         </ol>
 192       </li>
 193       <li><a href="#otherops">Other Operations</a>
 194         <ol>
 195           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 196           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 197           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 198           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 199           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 200           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 201         </ol>
 202       </li>
 203     </ol>
 204   </li>
 205   <li><a href="#intrinsics">Intrinsic Functions</a>
 206     <ol>
 207       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 208         <ol>
 209           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 210           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 211           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 212         </ol>
 213       </li>
 214       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 215         <ol>
 216           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 217           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 218           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 219         </ol>
 220       </li>
 221       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 222         <ol>
 223           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 224           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 225           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 226           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 227           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 228           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 229           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 230         </ol>
 231       </li>
 232       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 233         <ol>
 234           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 235           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 236           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 237           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 238           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 239           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 240           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 241           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 242         </ol>
 243       </li>
 244       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 245         <ol>
 246           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 247           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 248           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 249           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 250         </ol>
 251       </li>
 252       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 253         <ol>
 254           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 255           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 256           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 257           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 258           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 259           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 260         </ol>
 261       </li>
 262       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 263         <ol>
 264           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 265           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 266         </ol>
 267       </li>
 268       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 269       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 270       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 271         <ol>
 272           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 273         </ol>
 274       </li>
 275       <li><a href="#int_atomics">Atomic intrinsics</a>
 276         <ol>
 277           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 278           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 279           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 280           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 281           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 282           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 283           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 284           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 285           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 286           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 287           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 288           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 289           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 290         </ol>
 291       </li>
 292       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 293         <ol>
 294           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 295           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 296           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 297           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_general">General intrinsics</a>
 301         <ol>
 302           <li><a href="#int_var_annotation">
 303             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 304           <li><a href="#int_annotation">
 305             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 306           <li><a href="#int_trap">
 307             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 308           <li><a href="#int_stackprotector">
 309             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 310           <li><a href="#int_objectsize">
 311             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 312         </ol>
 313       </li>
 314     </ol>
 315   </li>
 316 </ol>
 317
 318 <div class="doc_author">
 319   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 320             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 321 </div>
 322
 323 <!-- *********************************************************************** -->
 324 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 325 <!-- *********************************************************************** -->
 326
 327 <div class="doc_text">
 328
 329 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 330    a Static Single Assignment (SSA) based representation that provides type
 331    safety, low-level operations, flexibility, and the capability of representing
 332    'all' high-level languages cleanly.  It is the common code representation
 333    used throughout all phases of the LLVM compilation strategy.</p>
 334
 335 </div>
 336
 337 <!-- *********************************************************************** -->
 338 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 339 <!-- *********************************************************************** -->
 340
 341 <div class="doc_text">
 342
 343 <p>The LLVM code representation is designed to be used in three different forms:
 344    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 345    for fast loading by a Just-In-Time compiler), and as a human readable
 346    assembly language representation.  This allows LLVM to provide a powerful
 347    intermediate representation for efficient compiler transformations and
 348    analysis, while providing a natural means to debug and visualize the
 349    transformations.  The three different forms of LLVM are all equivalent.  This
 350    document describes the human readable representation and notation.</p>
 351
 352 <p>The LLVM representation aims to be light-weight and low-level while being
 353    expressive, typed, and extensible at the same time.  It aims to be a
 354    "universal IR" of sorts, by being at a low enough level that high-level ideas
 355    may be cleanly mapped to it (similar to how microprocessors are "universal
 356    IR's", allowing many source languages to be mapped to them).  By providing
 357    type information, LLVM can be used as the target of optimizations: for
 358    example, through pointer analysis, it can be proven that a C automatic
 359    variable is never accessed outside of the current function, allowing it to
 360    be promoted to a simple SSA value instead of a memory location.</p>
 361
 362 </div>
 363
 364 <!-- _______________________________________________________________________ -->
 365 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 366
 367 <div class="doc_text">
 368
 369 <p>It is important to note that this document describes 'well formed' LLVM
 370    assembly language.  There is a difference between what the parser accepts and
 371    what is considered 'well formed'.  For example, the following instruction is
 372    syntactically okay, but not well formed:</p>
 373
 374 <pre class="doc_code">
 375 %x = <a href="#i_add">add</a> i32 1, %x
 376 </pre>
 377
 378 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 379    LLVM infrastructure provides a verification pass that may be used to verify
 380    that an LLVM module is well formed.  This pass is automatically run by the
 381    parser after parsing input assembly and by the optimizer before it outputs
 382    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 383    transformation passes or input to the parser.</p>
 384
 385 </div>
 386
 387 <!-- Describe the typesetting conventions here. -->
 388
 389 <!-- *********************************************************************** -->
 390 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 391 <!-- *********************************************************************** -->
 392
 393 <div class="doc_text">
 394
 395 <p>LLVM identifiers come in two basic types: global and local. Global
 396    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 397    character. Local identifiers (register names, types) begin with
 398    the <tt>'%'</tt> character. Additionally, there are three different formats
 399    for identifiers, for different purposes:</p>
 400
 401 <ol>
 402   <li>Named values are represented as a string of characters with their prefix.
 403       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 404       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 405       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 406       other characters in their names can be surrounded with quotes. Special
 407       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 408       ASCII code for the character in hexadecimal.  In this way, any character
 409       can be used in a name value, even quotes themselves.</li>
 410
 411   <li>Unnamed values are represented as an unsigned numeric value with their
 412       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 413
 414   <li>Constants, which are described in a <a href="#constants">section about
 415       constants</a>, below.</li>
 416 </ol>
 417
 418 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 419    don't need to worry about name clashes with reserved words, and the set of
 420    reserved words may be expanded in the future without penalty.  Additionally,
 421    unnamed identifiers allow a compiler to quickly come up with a temporary
 422    variable without having to avoid symbol table conflicts.</p>
 423
 424 <p>Reserved words in LLVM are very similar to reserved words in other
 425    languages. There are keywords for different opcodes
 426    ('<tt><a href="#i_add">add</a></tt>',
 427    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 428    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 429    ('<tt><a href="#t_void">void</a></tt>',
 430    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 431    reserved words cannot conflict with variable names, because none of them
 432    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 433
 434 <p>Here is an example of LLVM code to multiply the integer variable
 435    '<tt>%X</tt>' by 8:</p>
 436
 437 <p>The easy way:</p>
 438
 439 <pre class="doc_code">
 440 %result = <a href="#i_mul">mul</a> i32 %X, 8
 441 </pre>
 442
 443 <p>After strength reduction:</p>
 444
 445 <pre class="doc_code">
 446 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 447 </pre>
 448
 449 <p>And the hard way:</p>
 450
 451 <pre class="doc_code">
 452 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 453 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 454 %result = <a href="#i_add">add</a> i32 %1, %1
 455 </pre>
 456
 457 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 458    lexical features of LLVM:</p>
 459
 460 <ol>
 461   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 462       line.</li>
 463
 464   <li>Unnamed temporaries are created when the result of a computation is not
 465       assigned to a named value.</li>
 466
 467   <li>Unnamed temporaries are numbered sequentially</li>
 468 </ol>
 469
 470 <p>It also shows a convention that we follow in this document.  When
 471    demonstrating instructions, we will follow an instruction with a comment that
 472    defines the type and name of value produced.  Comments are shown in italic
 473    text.</p>
 474
 475 </div>
 476
 477 <!-- *********************************************************************** -->
 478 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 479 <!-- *********************************************************************** -->
 480
 481 <!-- ======================================================================= -->
 482 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 483 </div>
 484
 485 <div class="doc_text">
 486
 487 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 488    of the input programs.  Each module consists of functions, global variables,
 489    and symbol table entries.  Modules may be combined together with the LLVM
 490    linker, which merges function (and global variable) definitions, resolves
 491    forward declarations, and merges symbol table entries. Here is an example of
 492    the "hello world" module:</p>
 493
 494 <pre class="doc_code">
 495 <i>; Declare the string constant as a global constant.</i>&nbsp;
 496 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"      <i>; [13 x i8]*</i>&nbsp;
 497
 498 <i>; External declaration of the puts function</i>&nbsp;
 499 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 500
 501 <i>; Definition of main function</i>
 502 define i32 @main() {   <i>; i32()* </i>&nbsp;
 503   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 504   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 505
 506   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 507   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 508   <a href="#i_ret">ret</a> i32 0&nbsp;
 509 }
 510
 511 <i>; Named metadata</i>
 512 !1 = metadata !{i32 41}
 513 !foo = !{!1, null}
 514 </pre>
 515
 516 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 517    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 518    a <a href="#functionstructure">function definition</a> for
 519    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 520    "<tt>foo"</tt>.</p>
 521
 522 <p>In general, a module is made up of a list of global values, where both
 523    functions and global variables are global values.  Global values are
 524    represented by a pointer to a memory location (in this case, a pointer to an
 525    array of char, and a pointer to a function), and have one of the
 526    following <a href="#linkage">linkage types</a>.</p>
 527
 528 </div>
 529
 530 <!-- ======================================================================= -->
 531 <div class="doc_subsection">
 532   <a name="linkage">Linkage Types</a>
 533 </div>
 534
 535 <div class="doc_text">
 536
 537 <p>All Global Variables and Functions have one of the following types of
 538    linkage:</p>
 539
 540 <dl>
 541   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 542   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 543       by objects in the current module. In particular, linking code into a
 544       module with an private global value may cause the private to be renamed as
 545       necessary to avoid collisions.  Because the symbol is private to the
 546       module, all references can be updated. This doesn't show up in any symbol
 547       table in the object file.</dd>
 548
 549   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 550   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 551       assembler and evaluated by the linker. Unlike normal strong symbols, they
 552       are removed by the linker from the final linked image (executable or
 553       dynamic library).</dd>
 554
 555   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 556   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 557       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 558       linker. The symbols are removed by the linker from the final linked image
 559       (executable or dynamic library).</dd>
 560
 561   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 562   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 563       of the object is not taken. For instance, functions that had an inline
 564       definition, but the compiler decided not to inline it. Note,
 565       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 566       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 567       visibility.  The symbols are removed by the linker from the final linked
 568       image (executable or dynamic library).</dd>
 569
 570   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 571   <dd>Similar to private, but the value shows as a local symbol
 572       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 573       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 574
 575   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 576   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 577       into the object file corresponding to the LLVM module.  They exist to
 578       allow inlining and other optimizations to take place given knowledge of
 579       the definition of the global, which is known to be somewhere outside the
 580       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 581       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 582       This linkage type is only allowed on definitions, not declarations.</dd>
 583
 584   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 585   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 586       the same name when linkage occurs.  This can be used to implement
 587       some forms of inline functions, templates, or other code which must be
 588       generated in each translation unit that uses it, but where the body may
 589       be overridden with a more definitive definition later.  Unreferenced
 590       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 591       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 592       inline the body of this function into callers because it doesn't know if
 593       this definition of the function is the definitive definition within the
 594       program or whether it will be overridden by a stronger definition.
 595       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 596       linkage.</dd>
 597
 598   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 599   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 600       <tt>linkonce</tt> linkage, except that unreferenced globals with
 601       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 602       are declared "weak" in C source code.</dd>
 603
 604   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 605   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 606       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 607       global scope.
 608       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 609       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 610       <tt>common</tt> symbols may not have an explicit section,
 611       must have a zero initializer, and may not be marked '<a
 612       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 613       have common linkage.</dd>
 614
 615
 616   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 617   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 618       pointer to array type.  When two global variables with appending linkage
 619       are linked together, the two global arrays are appended together.  This is
 620       the LLVM, typesafe, equivalent of having the system linker append together
 621       "sections" with identical names when .o files are linked.</dd>
 622
 623   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 624   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 625       is weak until linked, if not linked, the symbol becomes null instead of
 626       being an undefined reference.</dd>
 627
 628   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 629   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 630   <dd>Some languages allow differing globals to be merged, such as two functions
 631       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 632       that only equivalent globals are ever merged (the "one definition rule"
 633       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 634       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 635       be merged with equivalent globals.  These linkage types are otherwise the
 636       same as their non-<tt>odr</tt> versions.</dd>
 637
 638   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 639   <dd>If none of the above identifiers are used, the global is externally
 640       visible, meaning that it participates in linkage and can be used to
 641       resolve external symbol references.</dd>
 642 </dl>
 643
 644 <p>The next two types of linkage are targeted for Microsoft Windows platform
 645    only. They are designed to support importing (exporting) symbols from (to)
 646    DLLs (Dynamic Link Libraries).</p>
 647
 648 <dl>
 649   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 650   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 651       or variable via a global pointer to a pointer that is set up by the DLL
 652       exporting the symbol. On Microsoft Windows targets, the pointer name is
 653       formed by combining <code>__imp_</code> and the function or variable
 654       name.</dd>
 655
 656   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 657   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 658       pointer to a pointer in a DLL, so that it can be referenced with the
 659       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 660       name is formed by combining <code>__imp_</code> and the function or
 661       variable name.</dd>
 662 </dl>
 663
 664 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 665    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 666    one, one of the two would be renamed, preventing a collision.  Since
 667    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 668    declarations), they are accessible outside of the current module.</p>
 669
 670 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 671    other than "externally visible", <tt>dllimport</tt>
 672    or <tt>extern_weak</tt>.</p>
 673
 674 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 675    or <tt>weak_odr</tt> linkages.</p>
 676
 677 </div>
 678
 679 <!-- ======================================================================= -->
 680 <div class="doc_subsection">
 681   <a name="callingconv">Calling Conventions</a>
 682 </div>
 683
 684 <div class="doc_text">
 685
 686 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 687    and <a href="#i_invoke">invokes</a> can all have an optional calling
 688    convention specified for the call.  The calling convention of any pair of
 689    dynamic caller/callee must match, or the behavior of the program is
 690    undefined.  The following calling conventions are supported by LLVM, and more
 691    may be added in the future:</p>
 692
 693 <dl>
 694   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 695   <dd>This calling convention (the default if no other calling convention is
 696       specified) matches the target C calling conventions.  This calling
 697       convention supports varargs function calls and tolerates some mismatch in
 698       the declared prototype and implemented declaration of the function (as
 699       does normal C).</dd>
 700
 701   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 702   <dd>This calling convention attempts to make calls as fast as possible
 703       (e.g. by passing things in registers).  This calling convention allows the
 704       target to use whatever tricks it wants to produce fast code for the
 705       target, without having to conform to an externally specified ABI
 706       (Application Binary Interface).
 707       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 708       when this or the GHC convention is used.</a>  This calling convention
 709       does not support varargs and requires the prototype of all callees to
 710       exactly match the prototype of the function definition.</dd>
 711
 712   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make code in the caller as efficient
 714       as possible under the assumption that the call is not commonly executed.
 715       As such, these calls often preserve all registers so that the call does
 716       not break any live ranges in the caller side.  This calling convention
 717       does not support varargs and requires the prototype of all callees to
 718       exactly match the prototype of the function definition.</dd>
 719
 720   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 721   <dd>This calling convention has been implemented specifically for use by the
 722       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 723       It passes everything in registers, going to extremes to achieve this by
 724       disabling callee save registers. This calling convention should not be
 725       used lightly but only for specific situations such as an alternative to
 726       the <em>register pinning</em> performance technique often used when
 727       implementing functional programming languages.At the moment only X86
 728       supports this convention and it has the following limitations:
 729       <ul>
 730         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 731             floating point types are supported.</li>
 732         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 733             6 floating point parameters.</li>
 734       </ul>
 735       This calling convention supports
 736       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 737       requires both the caller and callee are using it.
 738   </dd>
 739
 740   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 741   <dd>Any calling convention may be specified by number, allowing
 742       target-specific calling conventions to be used.  Target specific calling
 743       conventions start at 64.</dd>
 744 </dl>
 745
 746 <p>More calling conventions can be added/defined on an as-needed basis, to
 747    support Pascal conventions or any other well-known target-independent
 748    convention.</p>
 749
 750 </div>
 751
 752 <!-- ======================================================================= -->
 753 <div class="doc_subsection">
 754   <a name="visibility">Visibility Styles</a>
 755 </div>
 756
 757 <div class="doc_text">
 758
 759 <p>All Global Variables and Functions have one of the following visibility
 760    styles:</p>
 761
 762 <dl>
 763   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 764   <dd>On targets that use the ELF object file format, default visibility means
 765       that the declaration is visible to other modules and, in shared libraries,
 766       means that the declared entity may be overridden. On Darwin, default
 767       visibility means that the declaration is visible to other modules. Default
 768       visibility corresponds to "external linkage" in the language.</dd>
 769
 770   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 771   <dd>Two declarations of an object with hidden visibility refer to the same
 772       object if they are in the same shared object. Usually, hidden visibility
 773       indicates that the symbol will not be placed into the dynamic symbol
 774       table, so no other module (executable or shared library) can reference it
 775       directly.</dd>
 776
 777   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 778   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 779       the dynamic symbol table, but that references within the defining module
 780       will bind to the local symbol. That is, the symbol cannot be overridden by
 781       another module.</dd>
 782 </dl>
 783
 784 </div>
 785
 786 <!-- ======================================================================= -->
 787 <div class="doc_subsection">
 788   <a name="namedtypes">Named Types</a>
 789 </div>
 790
 791 <div class="doc_text">
 792
 793 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 794    it easier to read the IR and make the IR more condensed (particularly when
 795    recursive types are involved).  An example of a name specification is:</p>
 796
 797 <pre class="doc_code">
 798 %mytype = type { %mytype*, i32 }
 799 </pre>
 800
 801 <p>You may give a name to any <a href="#typesystem">type</a> except
 802    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 803    is expected with the syntax "%mytype".</p>
 804
 805 <p>Note that type names are aliases for the structural type that they indicate,
 806    and that you can therefore specify multiple names for the same type.  This
 807    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 808    uses structural typing, the name is not part of the type.  When printing out
 809    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 810    particular shape.  This means that if you have code where two different
 811    source types end up having the same LLVM type, that the dumper will sometimes
 812    print the "wrong" or unexpected type.  This is an important design point and
 813    isn't going to change.</p>
 814
 815 </div>
 816
 817 <!-- ======================================================================= -->
 818 <div class="doc_subsection">
 819   <a name="globalvars">Global Variables</a>
 820 </div>
 821
 822 <div class="doc_text">
 823
 824 <p>Global variables define regions of memory allocated at compilation time
 825    instead of run-time.  Global variables may optionally be initialized, may
 826    have an explicit section to be placed in, and may have an optional explicit
 827    alignment specified.  A variable may be defined as "thread_local", which
 828    means that it will not be shared by threads (each thread will have a
 829    separated copy of the variable).  A variable may be defined as a global
 830    "constant," which indicates that the contents of the variable
 831    will <b>never</b> be modified (enabling better optimization, allowing the
 832    global data to be placed in the read-only section of an executable, etc).
 833    Note that variables that need runtime initialization cannot be marked
 834    "constant" as there is a store to the variable.</p>
 835
 836 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 837    constant, even if the final definition of the global is not.  This capability
 838    can be used to enable slightly better optimization of the program, but
 839    requires the language definition to guarantee that optimizations based on the
 840    'constantness' are valid for the translation units that do not include the
 841    definition.</p>
 842
 843 <p>As SSA values, global variables define pointer values that are in scope
 844    (i.e. they dominate) all basic blocks in the program.  Global variables
 845    always define a pointer to their "content" type because they describe a
 846    region of memory, and all memory objects in LLVM are accessed through
 847    pointers.</p>
 848
 849 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 850   that the address is not significant, only the content. Constants marked
 851   like this can be merged with other constants if they have the same
 852   initializer. Note that a constant with significant address <em>can</em>
 853   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 854   constant whose address is significant.</p>
 855
 856 <p>A global variable may be declared to reside in a target-specific numbered
 857    address space. For targets that support them, address spaces may affect how
 858    optimizations are performed and/or what target instructions are used to
 859    access the variable. The default address space is zero. The address space
 860    qualifier must precede any other attributes.</p>
 861
 862 <p>LLVM allows an explicit section to be specified for globals.  If the target
 863    supports it, it will emit globals to the section specified.</p>
 864
 865 <p>An explicit alignment may be specified for a global, which must be a power
 866    of 2.  If not present, or if the alignment is set to zero, the alignment of
 867    the global is set by the target to whatever it feels convenient.  If an
 868    explicit alignment is specified, the global is forced to have exactly that
 869    alignment.  Targets and optimizers are not allowed to over-align the global
 870    if the global has an assigned section.  In this case, the extra alignment
 871    could be observable: for example, code could assume that the globals are
 872    densely packed in their section and try to iterate over them as an array,
 873    alignment padding would break this iteration.</p>
 874
 875 <p>For example, the following defines a global in a numbered address space with
 876    an initializer, section, and alignment:</p>
 877
 878 <pre class="doc_code">
 879 @G = addrspace(5) constant float 1.0, section "foo", align 4
 880 </pre>
 881
 882 </div>
 883
 884
 885 <!-- ======================================================================= -->
 886 <div class="doc_subsection">
 887   <a name="functionstructure">Functions</a>
 888 </div>
 889
 890 <div class="doc_text">
 891
 892 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 893    optional <a href="#linkage">linkage type</a>, an optional
 894    <a href="#visibility">visibility style</a>, an optional
 895    <a href="#callingconv">calling convention</a>,
 896    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 897    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 898    name, a (possibly empty) argument list (each with optional
 899    <a href="#paramattrs">parameter attributes</a>), optional
 900    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 901    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 902    curly brace, a list of basic blocks, and a closing curly brace.</p>
 903
 904 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 905    optional <a href="#linkage">linkage type</a>, an optional
 906    <a href="#visibility">visibility style</a>, an optional
 907    <a href="#callingconv">calling convention</a>,
 908    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 909    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 910    name, a possibly empty list of arguments, an optional alignment, and an
 911    optional <a href="#gc">garbage collector name</a>.</p>
 912
 913 <p>A function definition contains a list of basic blocks, forming the CFG
 914    (Control Flow Graph) for the function.  Each basic block may optionally start
 915    with a label (giving the basic block a symbol table entry), contains a list
 916    of instructions, and ends with a <a href="#terminators">terminator</a>
 917    instruction (such as a branch or function return).</p>
 918
 919 <p>The first basic block in a function is special in two ways: it is immediately
 920    executed on entrance to the function, and it is not allowed to have
 921    predecessor basic blocks (i.e. there can not be any branches to the entry
 922    block of a function).  Because the block can have no predecessors, it also
 923    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 924
 925 <p>LLVM allows an explicit section to be specified for functions.  If the target
 926    supports it, it will emit functions to the section specified.</p>
 927
 928 <p>An explicit alignment may be specified for a function.  If not present, or if
 929    the alignment is set to zero, the alignment of the function is set by the
 930    target to whatever it feels convenient.  If an explicit alignment is
 931    specified, the function is forced to have at least that much alignment.  All
 932    alignments must be a power of 2.</p>
 933
 934 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 935   be significant and two identical functions can be merged</p>.
 936
 937 <h5>Syntax:</h5>
 938 <pre class="doc_code">
 939 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 940        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 941        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 942        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 943        [<a href="#gc">gc</a>] { ... }
 944 </pre>
 945
 946 </div>
 947
 948 <!-- ======================================================================= -->
 949 <div class="doc_subsection">
 950   <a name="aliasstructure">Aliases</a>
 951 </div>
 952
 953 <div class="doc_text">
 954
 955 <p>Aliases act as "second name" for the aliasee value (which can be either
 956    function, global variable, another alias or bitcast of global value). Aliases
 957    may have an optional <a href="#linkage">linkage type</a>, and an
 958    optional <a href="#visibility">visibility style</a>.</p>
 959
 960 <h5>Syntax:</h5>
 961 <pre class="doc_code">
 962 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 963 </pre>
 964
 965 </div>
 966
 967 <!-- ======================================================================= -->
 968 <div class="doc_subsection">
 969   <a name="namedmetadatastructure">Named Metadata</a>
 970 </div>
 971
 972 <div class="doc_text">
 973
 974 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 975    nodes</a> (but not metadata strings) are the only valid operands for
 976    a named metadata.</p>
 977
 978 <h5>Syntax:</h5>
 979 <pre class="doc_code">
 980 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 981 !0 = metadata !{metadata !"zero"}
 982 !1 = metadata !{metadata !"one"}
 983 !2 = metadata !{metadata !"two"}
 984 ; A named metadata.
 985 !name = !{!0, !1, !2}
 986 </pre>
 987
 988 </div>
 989
 990 <!-- ======================================================================= -->
 991 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 992
 993 <div class="doc_text">
 994
 995 <p>The return type and each parameter of a function type may have a set of
 996    <i>parameter attributes</i> associated with them. Parameter attributes are
 997    used to communicate additional information about the result or parameters of
 998    a function. Parameter attributes are considered to be part of the function,
 999    not of the function type, so functions with different parameter attributes
1000    can have the same function type.</p>
1001
1002 <p>Parameter attributes are simple keywords that follow the type specified. If
1003    multiple parameter attributes are needed, they are space separated. For
1004    example:</p>
1005
1006 <pre class="doc_code">
1007 declare i32 @printf(i8* noalias nocapture, ...)
1008 declare i32 @atoi(i8 zeroext)
1009 declare signext i8 @returns_signed_char()
1010 </pre>
1011
1012 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1013    <tt>readonly</tt>) come immediately after the argument list.</p>
1014
1015 <p>Currently, only the following parameter attributes are defined:</p>
1016
1017 <dl>
1018   <dt><tt><b>zeroext</b></tt></dt>
1019   <dd>This indicates to the code generator that the parameter or return value
1020       should be zero-extended to a 32-bit value by the caller (for a parameter)
1021       or the callee (for a return value).</dd>
1022
1023   <dt><tt><b>signext</b></tt></dt>
1024   <dd>This indicates to the code generator that the parameter or return value
1025       should be sign-extended to a 32-bit value by the caller (for a parameter)
1026       or the callee (for a return value).</dd>
1027
1028   <dt><tt><b>inreg</b></tt></dt>
1029   <dd>This indicates that this parameter or return value should be treated in a
1030       special target-dependent fashion during while emitting code for a function
1031       call or return (usually, by putting it in a register as opposed to memory,
1032       though some targets use it to distinguish between two different kinds of
1033       registers).  Use of this attribute is target-specific.</dd>
1034
1035   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1036   <dd><p>This indicates that the pointer parameter should really be passed by
1037       value to the function.  The attribute implies that a hidden copy of the
1038       pointee
1039       is made between the caller and the callee, so the callee is unable to
1040       modify the value in the callee.  This attribute is only valid on LLVM
1041       pointer arguments.  It is generally used to pass structs and arrays by
1042       value, but is also valid on pointers to scalars.  The copy is considered
1043       to belong to the caller not the callee (for example,
1044       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1045       <tt>byval</tt> parameters). This is not a valid attribute for return
1046       values.</p>
1047
1048       <p>The byval attribute also supports specifying an alignment with
1049       the align attribute.  It indicates the alignment of the stack slot to
1050       form and the known alignment of the pointer specified to the call site. If
1051       the alignment is not specified, then the code generator makes a
1052       target-specific assumption.</p></dd>
1053
1054   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1055   <dd>This indicates that the pointer parameter specifies the address of a
1056       structure that is the return value of the function in the source program.
1057       This pointer must be guaranteed by the caller to be valid: loads and
1058       stores to the structure may be assumed by the callee to not to trap.  This
1059       may only be applied to the first parameter. This is not a valid attribute
1060       for return values. </dd>
1061
1062   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1063   <dd>This indicates that pointer values
1064       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1065       value do not alias pointer values which are not <i>based</i> on it,
1066       ignoring certain "irrelevant" dependencies.
1067       For a call to the parent function, dependencies between memory
1068       references from before or after the call and from those during the call
1069       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1070       return value used in that call.
1071       The caller shares the responsibility with the callee for ensuring that
1072       these requirements are met.
1073       For further details, please see the discussion of the NoAlias response in
1074       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1075 <br>
1076       Note that this definition of <tt>noalias</tt> is intentionally
1077       similar to the definition of <tt>restrict</tt> in C99 for function
1078       arguments, though it is slightly weaker.
1079 <br>
1080       For function return values, C99's <tt>restrict</tt> is not meaningful,
1081       while LLVM's <tt>noalias</tt> is.
1082       </dd>
1083
1084   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1085   <dd>This indicates that the callee does not make any copies of the pointer
1086       that outlive the callee itself. This is not a valid attribute for return
1087       values.</dd>
1088
1089   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1090   <dd>This indicates that the pointer parameter can be excised using the
1091       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1092       attribute for return values.</dd>
1093 </dl>
1094
1095 </div>
1096
1097 <!-- ======================================================================= -->
1098 <div class="doc_subsection">
1099   <a name="gc">Garbage Collector Names</a>
1100 </div>
1101
1102 <div class="doc_text">
1103
1104 <p>Each function may specify a garbage collector name, which is simply a
1105    string:</p>
1106
1107 <pre class="doc_code">
1108 define void @f() gc "name" { ... }
1109 </pre>
1110
1111 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1112    collector which will cause the compiler to alter its output in order to
1113    support the named garbage collection algorithm.</p>
1114
1115 </div>
1116
1117 <!-- ======================================================================= -->
1118 <div class="doc_subsection">
1119   <a name="fnattrs">Function Attributes</a>
1120 </div>
1121
1122 <div class="doc_text">
1123
1124 <p>Function attributes are set to communicate additional information about a
1125    function. Function attributes are considered to be part of the function, not
1126    of the function type, so functions with different parameter attributes can
1127    have the same function type.</p>
1128
1129 <p>Function attributes are simple keywords that follow the type specified. If
1130    multiple attributes are needed, they are space separated. For example:</p>
1131
1132 <pre class="doc_code">
1133 define void @f() noinline { ... }
1134 define void @f() alwaysinline { ... }
1135 define void @f() alwaysinline optsize { ... }
1136 define void @f() optsize { ... }
1137 </pre>
1138
1139 <dl>
1140   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1141   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1142       the backend should forcibly align the stack pointer. Specify the
1143       desired alignment, which must be a power of two, in parentheses.
1144
1145   <dt><tt><b>alwaysinline</b></tt></dt>
1146   <dd>This attribute indicates that the inliner should attempt to inline this
1147       function into callers whenever possible, ignoring any active inlining size
1148       threshold for this caller.</dd>
1149
1150   <dt><tt><b>hotpatch</b></tt></dt>
1151   <dd>This attribute indicates that the function should be 'hotpatchable',
1152       meaning the function can be patched and/or hooked even while it is
1153       loaded into memory. On x86, the function prologue will be preceded
1154       by six bytes of padding and will begin with a two-byte instruction.
1155       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1156       higher were compiled in this fashion.</dd>
1157
1158   <dt><tt><b>inlinehint</b></tt></dt>
1159   <dd>This attribute indicates that the source code contained a hint that inlining
1160       this function is desirable (such as the "inline" keyword in C/C++).  It
1161       is just a hint; it imposes no requirements on the inliner.</dd>
1162
1163   <dt><tt><b>naked</b></tt></dt>
1164   <dd>This attribute disables prologue / epilogue emission for the function.
1165       This can have very system-specific consequences.</dd>
1166
1167   <dt><tt><b>noimplicitfloat</b></tt></dt>
1168   <dd>This attributes disables implicit floating point instructions.</dd>
1169
1170   <dt><tt><b>noinline</b></tt></dt>
1171   <dd>This attribute indicates that the inliner should never inline this
1172       function in any situation. This attribute may not be used together with
1173       the <tt>alwaysinline</tt> attribute.</dd>
1174
1175   <dt><tt><b>noredzone</b></tt></dt>
1176   <dd>This attribute indicates that the code generator should not use a red
1177       zone, even if the target-specific ABI normally permits it.</dd>
1178
1179   <dt><tt><b>noreturn</b></tt></dt>
1180   <dd>This function attribute indicates that the function never returns
1181       normally.  This produces undefined behavior at runtime if the function
1182       ever does dynamically return.</dd>
1183
1184   <dt><tt><b>nounwind</b></tt></dt>
1185   <dd>This function attribute indicates that the function never returns with an
1186       unwind or exceptional control flow.  If the function does unwind, its
1187       runtime behavior is undefined.</dd>
1188
1189   <dt><tt><b>optsize</b></tt></dt>
1190   <dd>This attribute suggests that optimization passes and code generator passes
1191       make choices that keep the code size of this function low, and otherwise
1192       do optimizations specifically to reduce code size.</dd>
1193
1194   <dt><tt><b>readnone</b></tt></dt>
1195   <dd>This attribute indicates that the function computes its result (or decides
1196       to unwind an exception) based strictly on its arguments, without
1197       dereferencing any pointer arguments or otherwise accessing any mutable
1198       state (e.g. memory, control registers, etc) visible to caller functions.
1199       It does not write through any pointer arguments
1200       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1201       changes any state visible to callers.  This means that it cannot unwind
1202       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1203       could use the <tt>unwind</tt> instruction.</dd>
1204
1205   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1206   <dd>This attribute indicates that the function does not write through any
1207       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1208       arguments) or otherwise modify any state (e.g. memory, control registers,
1209       etc) visible to caller functions.  It may dereference pointer arguments
1210       and read state that may be set in the caller.  A readonly function always
1211       returns the same value (or unwinds an exception identically) when called
1212       with the same set of arguments and global state.  It cannot unwind an
1213       exception by calling the <tt>C++</tt> exception throwing methods, but may
1214       use the <tt>unwind</tt> instruction.</dd>
1215
1216   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1217   <dd>This attribute indicates that the function should emit a stack smashing
1218       protector. It is in the form of a "canary"&mdash;a random value placed on
1219       the stack before the local variables that's checked upon return from the
1220       function to see if it has been overwritten. A heuristic is used to
1221       determine if a function needs stack protectors or not.<br>
1222 <br>
1223       If a function that has an <tt>ssp</tt> attribute is inlined into a
1224       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1225       function will have an <tt>ssp</tt> attribute.</dd>
1226
1227   <dt><tt><b>sspreq</b></tt></dt>
1228   <dd>This attribute indicates that the function should <em>always</em> emit a
1229       stack smashing protector. This overrides
1230       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1231 <br>
1232       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1233       function that doesn't have an <tt>sspreq</tt> attribute or which has
1234       an <tt>ssp</tt> attribute, then the resulting function will have
1235       an <tt>sspreq</tt> attribute.</dd>
1236 </dl>
1237
1238 </div>
1239
1240 <!-- ======================================================================= -->
1241 <div class="doc_subsection">
1242   <a name="moduleasm">Module-Level Inline Assembly</a>
1243 </div>
1244
1245 <div class="doc_text">
1246
1247 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1248    the GCC "file scope inline asm" blocks.  These blocks are internally
1249    concatenated by LLVM and treated as a single unit, but may be separated in
1250    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1251
1252 <pre class="doc_code">
1253 module asm "inline asm code goes here"
1254 module asm "more can go here"
1255 </pre>
1256
1257 <p>The strings can contain any character by escaping non-printable characters.
1258    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1259    for the number.</p>
1260
1261 <p>The inline asm code is simply printed to the machine code .s file when
1262    assembly code is generated.</p>
1263
1264 </div>
1265
1266 <!-- ======================================================================= -->
1267 <div class="doc_subsection">
1268   <a name="datalayout">Data Layout</a>
1269 </div>
1270
1271 <div class="doc_text">
1272
1273 <p>A module may specify a target specific data layout string that specifies how
1274    data is to be laid out in memory. The syntax for the data layout is
1275    simply:</p>
1276
1277 <pre class="doc_code">
1278 target datalayout = "<i>layout specification</i>"
1279 </pre>
1280
1281 <p>The <i>layout specification</i> consists of a list of specifications
1282    separated by the minus sign character ('-').  Each specification starts with
1283    a letter and may include other information after the letter to define some
1284    aspect of the data layout.  The specifications accepted are as follows:</p>
1285
1286 <dl>
1287   <dt><tt>E</tt></dt>
1288   <dd>Specifies that the target lays out data in big-endian form. That is, the
1289       bits with the most significance have the lowest address location.</dd>
1290
1291   <dt><tt>e</tt></dt>
1292   <dd>Specifies that the target lays out data in little-endian form. That is,
1293       the bits with the least significance have the lowest address
1294       location.</dd>
1295
1296   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1297   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1298       <i>preferred</i> alignments. All sizes are in bits. Specifying
1299       the <i>pref</i> alignment is optional. If omitted, the
1300       preceding <tt>:</tt> should be omitted too.</dd>
1301
1302   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1303   <dd>This specifies the alignment for an integer type of a given bit
1304       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1305
1306   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1307   <dd>This specifies the alignment for a vector type of a given bit
1308       <i>size</i>.</dd>
1309
1310   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1311   <dd>This specifies the alignment for a floating point type of a given bit
1312       <i>size</i>. Only values of <i>size</i> that are supported by the target
1313       will work.  32 (float) and 64 (double) are supported on all targets;
1314       80 or 128 (different flavors of long double) are also supported on some
1315       targets.
1316
1317   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1318   <dd>This specifies the alignment for an aggregate type of a given bit
1319       <i>size</i>.</dd>
1320
1321   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1322   <dd>This specifies the alignment for a stack object of a given bit
1323       <i>size</i>.</dd>
1324
1325   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1326   <dd>This specifies a set of native integer widths for the target CPU
1327       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1328       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1329       this set are considered to support most general arithmetic
1330       operations efficiently.</dd>
1331 </dl>
1332
1333 <p>When constructing the data layout for a given target, LLVM starts with a
1334    default set of specifications which are then (possibly) overridden by the
1335    specifications in the <tt>datalayout</tt> keyword. The default specifications
1336    are given in this list:</p>
1337
1338 <ul>
1339   <li><tt>E</tt> - big endian</li>
1340   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1341   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1342   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1343   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1344   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1345   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1346   alignment of 64-bits</li>
1347   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1348   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1349   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1350   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1351   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1352   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1353 </ul>
1354
1355 <p>When LLVM is determining the alignment for a given type, it uses the
1356    following rules:</p>
1357
1358 <ol>
1359   <li>If the type sought is an exact match for one of the specifications, that
1360       specification is used.</li>
1361
1362   <li>If no match is found, and the type sought is an integer type, then the
1363       smallest integer type that is larger than the bitwidth of the sought type
1364       is used. If none of the specifications are larger than the bitwidth then
1365       the the largest integer type is used. For example, given the default
1366       specifications above, the i7 type will use the alignment of i8 (next
1367       largest) while both i65 and i256 will use the alignment of i64 (largest
1368       specified).</li>
1369
1370   <li>If no match is found, and the type sought is a vector type, then the
1371       largest vector type that is smaller than the sought vector type will be
1372       used as a fall back.  This happens because &lt;128 x double&gt; can be
1373       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1374 </ol>
1375
1376 </div>
1377
1378 <!-- ======================================================================= -->
1379 <div class="doc_subsection">
1380   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1381 </div>
1382
1383 <div class="doc_text">
1384
1385 <p>Any memory access must be done through a pointer value associated
1386 with an address range of the memory access, otherwise the behavior
1387 is undefined. Pointer values are associated with address ranges
1388 according to the following rules:</p>
1389
1390 <ul>
1391   <li>A pointer value is associated with the addresses associated with
1392       any value it is <i>based</i> on.
1393   <li>An address of a global variable is associated with the address
1394       range of the variable's storage.</li>
1395   <li>The result value of an allocation instruction is associated with
1396       the address range of the allocated storage.</li>
1397   <li>A null pointer in the default address-space is associated with
1398       no address.</li>
1399   <li>An integer constant other than zero or a pointer value returned
1400       from a function not defined within LLVM may be associated with address
1401       ranges allocated through mechanisms other than those provided by
1402       LLVM. Such ranges shall not overlap with any ranges of addresses
1403       allocated by mechanisms provided by LLVM.</li>
1404 </ul>
1405
1406 <p>A pointer value is <i>based</i> on another pointer value according
1407    to the following rules:</p>
1408
1409 <ul>
1410   <li>A pointer value formed from a
1411       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1412       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1413   <li>The result value of a
1414       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1415       of the <tt>bitcast</tt>.</li>
1416   <li>A pointer value formed by an
1417       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1418       pointer values that contribute (directly or indirectly) to the
1419       computation of the pointer's value.</li>
1420   <li>The "<i>based</i> on" relationship is transitive.</li>
1421 </ul>
1422
1423 <p>Note that this definition of <i>"based"</i> is intentionally
1424    similar to the definition of <i>"based"</i> in C99, though it is
1425    slightly weaker.</p>
1426
1427 <p>LLVM IR does not associate types with memory. The result type of a
1428 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1429 alignment of the memory from which to load, as well as the
1430 interpretation of the value. The first operand type of a
1431 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1432 and alignment of the store.</p>
1433
1434 <p>Consequently, type-based alias analysis, aka TBAA, aka
1435 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1436 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1437 additional information which specialized optimization passes may use
1438 to implement type-based alias analysis.</p>
1439
1440 </div>
1441
1442 <!-- ======================================================================= -->
1443 <div class="doc_subsection">
1444   <a name="volatile">Volatile Memory Accesses</a>
1445 </div>
1446
1447 <div class="doc_text">
1448
1449 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1450 href="#i_store"><tt>store</tt></a>s, and <a
1451 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1452 The optimizers must not change the number of volatile operations or change their
1453 order of execution relative to other volatile operations.  The optimizers
1454 <i>may</i> change the order of volatile operations relative to non-volatile
1455 operations.  This is not Java's "volatile" and has no cross-thread
1456 synchronization behavior.</p>
1457
1458 </div>
1459
1460 <!-- *********************************************************************** -->
1461 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
1462 <!-- *********************************************************************** -->
1463
1464 <div class="doc_text">
1465
1466 <p>The LLVM type system is one of the most important features of the
1467    intermediate representation.  Being typed enables a number of optimizations
1468    to be performed on the intermediate representation directly, without having
1469    to do extra analyses on the side before the transformation.  A strong type
1470    system makes it easier to read the generated code and enables novel analyses
1471    and transformations that are not feasible to perform on normal three address
1472    code representations.</p>
1473
1474 </div>
1475
1476 <!-- ======================================================================= -->
1477 <div class="doc_subsection"> <a name="t_classifications">Type
1478 Classifications</a> </div>
1479
1480 <div class="doc_text">
1481
1482 <p>The types fall into a few useful classifications:</p>
1483
1484 <table border="1" cellspacing="0" cellpadding="4">
1485   <tbody>
1486     <tr><th>Classification</th><th>Types</th></tr>
1487     <tr>
1488       <td><a href="#t_integer">integer</a></td>
1489       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1490     </tr>
1491     <tr>
1492       <td><a href="#t_floating">floating point</a></td>
1493       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1494     </tr>
1495     <tr>
1496       <td><a name="t_firstclass">first class</a></td>
1497       <td><a href="#t_integer">integer</a>,
1498           <a href="#t_floating">floating point</a>,
1499           <a href="#t_pointer">pointer</a>,
1500           <a href="#t_vector">vector</a>,
1501           <a href="#t_struct">structure</a>,
1502           <a href="#t_array">array</a>,
1503           <a href="#t_label">label</a>,
1504           <a href="#t_metadata">metadata</a>.
1505       </td>
1506     </tr>
1507     <tr>
1508       <td><a href="#t_primitive">primitive</a></td>
1509       <td><a href="#t_label">label</a>,
1510           <a href="#t_void">void</a>,
1511           <a href="#t_integer">integer</a>,
1512           <a href="#t_floating">floating point</a>,
1513           <a href="#t_x86mmx">x86mmx</a>,
1514           <a href="#t_metadata">metadata</a>.</td>
1515     </tr>
1516     <tr>
1517       <td><a href="#t_derived">derived</a></td>
1518       <td><a href="#t_array">array</a>,
1519           <a href="#t_function">function</a>,
1520           <a href="#t_pointer">pointer</a>,
1521           <a href="#t_struct">structure</a>,
1522           <a href="#t_pstruct">packed structure</a>,
1523           <a href="#t_vector">vector</a>,
1524           <a href="#t_opaque">opaque</a>.
1525       </td>
1526     </tr>
1527   </tbody>
1528 </table>
1529
1530 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1531    important.  Values of these types are the only ones which can be produced by
1532    instructions.</p>
1533
1534 </div>
1535
1536 <!-- ======================================================================= -->
1537 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
1538
1539 <div class="doc_text">
1540
1541 <p>The primitive types are the fundamental building blocks of the LLVM
1542    system.</p>
1543
1544 </div>
1545
1546 <!-- _______________________________________________________________________ -->
1547 <div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
1548
1549 <div class="doc_text">
1550
1551 <h5>Overview:</h5>
1552 <p>The integer type is a very simple type that simply specifies an arbitrary
1553    bit width for the integer type desired. Any bit width from 1 bit to
1554    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1555
1556 <h5>Syntax:</h5>
1557 <pre>
1558   iN
1559 </pre>
1560
1561 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1562    value.</p>
1563
1564 <h5>Examples:</h5>
1565 <table class="layout">
1566   <tr class="layout">
1567     <td class="left"><tt>i1</tt></td>
1568     <td class="left">a single-bit integer.</td>
1569   </tr>
1570   <tr class="layout">
1571     <td class="left"><tt>i32</tt></td>
1572     <td class="left">a 32-bit integer.</td>
1573   </tr>
1574   <tr class="layout">
1575     <td class="left"><tt>i1942652</tt></td>
1576     <td class="left">a really big integer of over 1 million bits.</td>
1577   </tr>
1578 </table>
1579
1580 </div>
1581
1582 <!-- _______________________________________________________________________ -->
1583 <div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
1584
1585 <div class="doc_text">
1586
1587 <table>
1588   <tbody>
1589     <tr><th>Type</th><th>Description</th></tr>
1590     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1591     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1592     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1593     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1594     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1595   </tbody>
1596 </table>
1597
1598 </div>
1599
1600 <!-- _______________________________________________________________________ -->
1601 <div class="doc_subsubsection"> <a name="t_x86mmx">X86mmx Type</a> </div>
1602
1603 <div class="doc_text">
1604
1605 <h5>Overview:</h5>
1606 <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>
1607
1608 <h5>Syntax:</h5>
1609 <pre>
1610   x86mmx
1611 </pre>
1612
1613 </div>
1614
1615 <!-- _______________________________________________________________________ -->
1616 <div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
1617
1618 <div class="doc_text">
1619
1620 <h5>Overview:</h5>
1621 <p>The void type does not represent any value and has no size.</p>
1622
1623 <h5>Syntax:</h5>
1624 <pre>
1625   void
1626 </pre>
1627
1628 </div>
1629
1630 <!-- _______________________________________________________________________ -->
1631 <div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
1632
1633 <div class="doc_text">
1634
1635 <h5>Overview:</h5>
1636 <p>The label type represents code labels.</p>
1637
1638 <h5>Syntax:</h5>
1639 <pre>
1640   label
1641 </pre>
1642
1643 </div>
1644
1645 <!-- _______________________________________________________________________ -->
1646 <div class="doc_subsubsection"> <a name="t_metadata">Metadata Type</a> </div>
1647
1648 <div class="doc_text">
1649
1650 <h5>Overview:</h5>
1651 <p>The metadata type represents embedded metadata. No derived types may be
1652    created from metadata except for <a href="#t_function">function</a>
1653    arguments.
1654
1655 <h5>Syntax:</h5>
1656 <pre>
1657   metadata
1658 </pre>
1659
1660 </div>
1661
1662
1663 <!-- ======================================================================= -->
1664 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
1665
1666 <div class="doc_text">
1667
1668 <p>The real power in LLVM comes from the derived types in the system.  This is
1669    what allows a programmer to represent arrays, functions, pointers, and other
1670    useful types.  Each of these types contain one or more element types which
1671    may be a primitive type, or another derived type.  For example, it is
1672    possible to have a two dimensional array, using an array as the element type
1673    of another array.</p>
1674
1675
1676 </div>
1677
1678 <!-- _______________________________________________________________________ -->
1679 <div class="doc_subsubsection"> <a name="t_aggregate">Aggregate Types</a> </div>
1680
1681 <div class="doc_text">
1682
1683 <p>Aggregate Types are a subset of derived types that can contain multiple
1684   member types. <a href="#t_array">Arrays</a>,
1685   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1686   aggregate types.</p>
1687
1688 </div>
1689
1690 <!-- _______________________________________________________________________ -->
1691 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
1692
1693 <div class="doc_text">
1694
1695 <h5>Overview:</h5>
1696 <p>The array type is a very simple derived type that arranges elements
1697    sequentially in memory.  The array type requires a size (number of elements)
1698    and an underlying data type.</p>
1699
1700 <h5>Syntax:</h5>
1701 <pre>
1702   [&lt;# elements&gt; x &lt;elementtype&gt;]
1703 </pre>
1704
1705 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1706    be any type with a size.</p>
1707
1708 <h5>Examples:</h5>
1709 <table class="layout">
1710   <tr class="layout">
1711     <td class="left"><tt>[40 x i32]</tt></td>
1712     <td class="left">Array of 40 32-bit integer values.</td>
1713   </tr>
1714   <tr class="layout">
1715     <td class="left"><tt>[41 x i32]</tt></td>
1716     <td class="left">Array of 41 32-bit integer values.</td>
1717   </tr>
1718   <tr class="layout">
1719     <td class="left"><tt>[4 x i8]</tt></td>
1720     <td class="left">Array of 4 8-bit integer values.</td>
1721   </tr>
1722 </table>
1723 <p>Here are some examples of multidimensional arrays:</p>
1724 <table class="layout">
1725   <tr class="layout">
1726     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1727     <td class="left">3x4 array of 32-bit integer values.</td>
1728   </tr>
1729   <tr class="layout">
1730     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1731     <td class="left">12x10 array of single precision floating point values.</td>
1732   </tr>
1733   <tr class="layout">
1734     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1735     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1736   </tr>
1737 </table>
1738
1739 <p>There is no restriction on indexing beyond the end of the array implied by
1740    a static type (though there are restrictions on indexing beyond the bounds
1741    of an allocated object in some cases). This means that single-dimension
1742    'variable sized array' addressing can be implemented in LLVM with a zero
1743    length array type. An implementation of 'pascal style arrays' in LLVM could
1744    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1745
1746 </div>
1747
1748 <!-- _______________________________________________________________________ -->
1749 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
1750
1751 <div class="doc_text">
1752
1753 <h5>Overview:</h5>
1754 <p>The function type can be thought of as a function signature.  It consists of
1755    a return type and a list of formal parameter types. The return type of a
1756    function type is a first class type or a void type.</p>
1757
1758 <h5>Syntax:</h5>
1759 <pre>
1760   &lt;returntype&gt; (&lt;parameter list&gt;)
1761 </pre>
1762
1763 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1764    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1765    which indicates that the function takes a variable number of arguments.
1766    Variable argument functions can access their arguments with
1767    the <a href="#int_varargs">variable argument handling intrinsic</a>
1768    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1769    <a href="#t_label">label</a>.</p>
1770
1771 <h5>Examples:</h5>
1772 <table class="layout">
1773   <tr class="layout">
1774     <td class="left"><tt>i32 (i32)</tt></td>
1775     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1776     </td>
1777   </tr><tr class="layout">
1778     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1779     </tt></td>
1780     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1781       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1782       returning <tt>float</tt>.
1783     </td>
1784   </tr><tr class="layout">
1785     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1786     <td class="left">A vararg function that takes at least one
1787       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
1788       which returns an integer.  This is the signature for <tt>printf</tt> in
1789       LLVM.
1790     </td>
1791   </tr><tr class="layout">
1792     <td class="left"><tt>{i32, i32} (i32)</tt></td>
1793     <td class="left">A function taking an <tt>i32</tt>, returning a
1794         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
1795     </td>
1796   </tr>
1797 </table>
1798
1799 </div>
1800
1801 <!-- _______________________________________________________________________ -->
1802 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
1803
1804 <div class="doc_text">
1805
1806 <h5>Overview:</h5>
1807 <p>The structure type is used to represent a collection of data members together
1808    in memory.  The packing of the field types is defined to match the ABI of the
1809    underlying processor.  The elements of a structure may be any type that has a
1810    size.</p>
1811
1812 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
1813    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
1814    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
1815    Structures in registers are accessed using the
1816    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
1817    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
1818 <h5>Syntax:</h5>
1819 <pre>
1820   { &lt;type list&gt; }
1821 </pre>
1822
1823 <h5>Examples:</h5>
1824 <table class="layout">
1825   <tr class="layout">
1826     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
1827     <td class="left">A triple of three <tt>i32</tt> values</td>
1828   </tr><tr class="layout">
1829     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
1830     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1831       second element is a <a href="#t_pointer">pointer</a> to a
1832       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1833       an <tt>i32</tt>.</td>
1834   </tr>
1835 </table>
1836
1837 </div>
1838
1839 <!-- _______________________________________________________________________ -->
1840 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1841 </div>
1842
1843 <div class="doc_text">
1844
1845 <h5>Overview:</h5>
1846 <p>The packed structure type is used to represent a collection of data members
1847    together in memory.  There is no padding between fields.  Further, the
1848    alignment of a packed structure is 1 byte.  The elements of a packed
1849    structure may be any type that has a size.</p>
1850
1851 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt> and
1852    '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field with
1853    the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
1854
1855 <h5>Syntax:</h5>
1856 <pre>
1857   &lt; { &lt;type list&gt; } &gt;
1858 </pre>
1859
1860 <h5>Examples:</h5>
1861 <table class="layout">
1862   <tr class="layout">
1863     <td class="left"><tt>&lt; { i32, i32, i32 } &gt;</tt></td>
1864     <td class="left">A triple of three <tt>i32</tt> values</td>
1865   </tr><tr class="layout">
1866   <td class="left">
1867 <tt>&lt;&nbsp;{&nbsp;float,&nbsp;i32&nbsp;(i32)*&nbsp;}&nbsp;&gt;</tt></td>
1868     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1869       second element is a <a href="#t_pointer">pointer</a> to a
1870       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1871       an <tt>i32</tt>.</td>
1872   </tr>
1873 </table>
1874
1875 </div>
1876
1877 <!-- _______________________________________________________________________ -->
1878 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1879
1880 <div class="doc_text">
1881
1882 <h5>Overview:</h5>
1883 <p>The pointer type is used to specify memory locations.
1884    Pointers are commonly used to reference objects in memory.</p>
1885
1886 <p>Pointer types may have an optional address space attribute defining the
1887    numbered address space where the pointed-to object resides. The default
1888    address space is number zero. The semantics of non-zero address
1889    spaces are target-specific.</p>
1890
1891 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
1892    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
1893
1894 <h5>Syntax:</h5>
1895 <pre>
1896   &lt;type&gt; *
1897 </pre>
1898
1899 <h5>Examples:</h5>
1900 <table class="layout">
1901   <tr class="layout">
1902     <td class="left"><tt>[4 x i32]*</tt></td>
1903     <td class="left">A <a href="#t_pointer">pointer</a> to <a
1904                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
1905   </tr>
1906   <tr class="layout">
1907     <td class="left"><tt>i32 (i32*) *</tt></td>
1908     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
1909       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1910       <tt>i32</tt>.</td>
1911   </tr>
1912   <tr class="layout">
1913     <td class="left"><tt>i32 addrspace(5)*</tt></td>
1914     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
1915      that resides in address space #5.</td>
1916   </tr>
1917 </table>
1918
1919 </div>
1920
1921 <!-- _______________________________________________________________________ -->
1922 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1923
1924 <div class="doc_text">
1925
1926 <h5>Overview:</h5>
1927 <p>A vector type is a simple derived type that represents a vector of elements.
1928    Vector types are used when multiple primitive data are operated in parallel
1929    using a single instruction (SIMD).  A vector type requires a size (number of
1930    elements) and an underlying primitive data type.  Vector types are considered
1931    <a href="#t_firstclass">first class</a>.</p>
1932
1933 <h5>Syntax:</h5>
1934 <pre>
1935   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1936 </pre>
1937
1938 <p>The number of elements is a constant integer value larger than 0; elementtype
1939    may be any integer or floating point type.  Vectors of size zero are not
1940    allowed, and pointers are not allowed as the element type.</p>
1941
1942 <h5>Examples:</h5>
1943 <table class="layout">
1944   <tr class="layout">
1945     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
1946     <td class="left">Vector of 4 32-bit integer values.</td>
1947   </tr>
1948   <tr class="layout">
1949     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
1950     <td class="left">Vector of 8 32-bit floating-point values.</td>
1951   </tr>
1952   <tr class="layout">
1953     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
1954     <td class="left">Vector of 2 64-bit integer values.</td>
1955   </tr>
1956 </table>
1957
1958 </div>
1959
1960 <!-- _______________________________________________________________________ -->
1961 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1962 <div class="doc_text">
1963
1964 <h5>Overview:</h5>
1965 <p>Opaque types are used to represent unknown types in the system.  This
1966    corresponds (for example) to the C notion of a forward declared structure
1967    type.  In LLVM, opaque types can eventually be resolved to any type (not just
1968    a structure type).</p>
1969
1970 <h5>Syntax:</h5>
1971 <pre>
1972   opaque
1973 </pre>
1974
1975 <h5>Examples:</h5>
1976 <table class="layout">
1977   <tr class="layout">
1978     <td class="left"><tt>opaque</tt></td>
1979     <td class="left">An opaque type.</td>
1980   </tr>
1981 </table>
1982
1983 </div>
1984
1985 <!-- ======================================================================= -->
1986 <div class="doc_subsection">
1987   <a name="t_uprefs">Type Up-references</a>
1988 </div>
1989
1990 <div class="doc_text">
1991
1992 <h5>Overview:</h5>
1993 <p>An "up reference" allows you to refer to a lexically enclosing type without
1994    requiring it to have a name. For instance, a structure declaration may
1995    contain a pointer to any of the types it is lexically a member of.  Example
1996    of up references (with their equivalent as named type declarations)
1997    include:</p>
1998
1999 <pre>
2000    { \2 * }                %x = type { %x* }
2001    { \2 }*                 %y = type { %y }*
2002    \1*                     %z = type %z*
2003 </pre>
2004
2005 <p>An up reference is needed by the asmprinter for printing out cyclic types
2006    when there is no declared name for a type in the cycle.  Because the
2007    asmprinter does not want to print out an infinite type string, it needs a
2008    syntax to handle recursive types that have no names (all names are optional
2009    in llvm IR).</p>
2010
2011 <h5>Syntax:</h5>
2012 <pre>
2013    \&lt;level&gt;
2014 </pre>
2015
2016 <p>The level is the count of the lexical type that is being referred to.</p>
2017
2018 <h5>Examples:</h5>
2019 <table class="layout">
2020   <tr class="layout">
2021     <td class="left"><tt>\1*</tt></td>
2022     <td class="left">Self-referential pointer.</td>
2023   </tr>
2024   <tr class="layout">
2025     <td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
2026     <td class="left">Recursive structure where the upref refers to the out-most
2027                      structure.</td>
2028   </tr>
2029 </table>
2030
2031 </div>
2032
2033 <!-- *********************************************************************** -->
2034 <div class="doc_section"> <a name="constants">Constants</a> </div>
2035 <!-- *********************************************************************** -->
2036
2037 <div class="doc_text">
2038
2039 <p>LLVM has several different basic types of constants.  This section describes
2040    them all and their syntax.</p>
2041
2042 </div>
2043
2044 <!-- ======================================================================= -->
2045 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
2046
2047 <div class="doc_text">
2048
2049 <dl>
2050   <dt><b>Boolean constants</b></dt>
2051   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2052       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2053
2054   <dt><b>Integer constants</b></dt>
2055   <dd>Standard integers (such as '4') are constants of
2056       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2057       with integer types.</dd>
2058
2059   <dt><b>Floating point constants</b></dt>
2060   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2061       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2062       notation (see below).  The assembler requires the exact decimal value of a
2063       floating-point constant.  For example, the assembler accepts 1.25 but
2064       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2065       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2066
2067   <dt><b>Null pointer constants</b></dt>
2068   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2069       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2070 </dl>
2071
2072 <p>The one non-intuitive notation for constants is the hexadecimal form of
2073    floating point constants.  For example, the form '<tt>double
2074    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2075    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2076    constants are required (and the only time that they are generated by the
2077    disassembler) is when a floating point constant must be emitted but it cannot
2078    be represented as a decimal floating point number in a reasonable number of
2079    digits.  For example, NaN's, infinities, and other special values are
2080    represented in their IEEE hexadecimal format so that assembly and disassembly
2081    do not cause any bits to change in the constants.</p>
2082
2083 <p>When using the hexadecimal form, constants of types float and double are
2084    represented using the 16-digit form shown above (which matches the IEEE754
2085    representation for double); float values must, however, be exactly
2086    representable as IEE754 single precision.  Hexadecimal format is always used
2087    for long double, and there are three forms of long double.  The 80-bit format
2088    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2089    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2090    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2091    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2092    currently supported target uses this format.  Long doubles will only work if
2093    they match the long double format on your target.  All hexadecimal formats
2094    are big-endian (sign bit at the left).</p>
2095
2096 <p>There are no constants of type x86mmx.</p>
2097 </div>
2098
2099 <!-- ======================================================================= -->
2100 <div class="doc_subsection">
2101 <a name="aggregateconstants"></a> <!-- old anchor -->
2102 <a name="complexconstants">Complex Constants</a>
2103 </div>
2104
2105 <div class="doc_text">
2106
2107 <p>Complex constants are a (potentially recursive) combination of simple
2108    constants and smaller complex constants.</p>
2109
2110 <dl>
2111   <dt><b>Structure constants</b></dt>
2112   <dd>Structure constants are represented with notation similar to structure
2113       type definitions (a comma separated list of elements, surrounded by braces
2114       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2115       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2116       Structure constants must have <a href="#t_struct">structure type</a>, and
2117       the number and types of elements must match those specified by the
2118       type.</dd>
2119
2120   <dt><b>Array constants</b></dt>
2121   <dd>Array constants are represented with notation similar to array type
2122      definitions (a comma separated list of elements, surrounded by square
2123      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2124      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2125      the number and types of elements must match those specified by the
2126      type.</dd>
2127
2128   <dt><b>Vector constants</b></dt>
2129   <dd>Vector constants are represented with notation similar to vector type
2130       definitions (a comma separated list of elements, surrounded by
2131       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2132       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2133       have <a href="#t_vector">vector type</a>, and the number and types of
2134       elements must match those specified by the type.</dd>
2135
2136   <dt><b>Zero initialization</b></dt>
2137   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2138       value to zero of <em>any</em> type, including scalar and
2139       <a href="#t_aggregate">aggregate</a> types.
2140       This is often used to avoid having to print large zero initializers
2141       (e.g. for large arrays) and is always exactly equivalent to using explicit
2142       zero initializers.</dd>
2143
2144   <dt><b>Metadata node</b></dt>
2145   <dd>A metadata node is a structure-like constant with
2146       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2147       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2148       be interpreted as part of the instruction stream, metadata is a place to
2149       attach additional information such as debug info.</dd>
2150 </dl>
2151
2152 </div>
2153
2154 <!-- ======================================================================= -->
2155 <div class="doc_subsection">
2156   <a name="globalconstants">Global Variable and Function Addresses</a>
2157 </div>
2158
2159 <div class="doc_text">
2160
2161 <p>The addresses of <a href="#globalvars">global variables</a>
2162    and <a href="#functionstructure">functions</a> are always implicitly valid
2163    (link-time) constants.  These constants are explicitly referenced when
2164    the <a href="#identifiers">identifier for the global</a> is used and always
2165    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2166    legal LLVM file:</p>
2167
2168 <pre class="doc_code">
2169 @X = global i32 17
2170 @Y = global i32 42
2171 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2172 </pre>
2173
2174 </div>
2175
2176 <!-- ======================================================================= -->
2177 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
2178 <div class="doc_text">
2179
2180 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2181    indicates that the user of the value may receive an unspecified bit-pattern.
2182    Undefined values may be of any type (other than '<tt>label</tt>'
2183    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2184
2185 <p>Undefined values are useful because they indicate to the compiler that the
2186    program is well defined no matter what value is used.  This gives the
2187    compiler more freedom to optimize.  Here are some examples of (potentially
2188    surprising) transformations that are valid (in pseudo IR):</p>
2189
2190
2191 <pre class="doc_code">
2192   %A = add %X, undef
2193   %B = sub %X, undef
2194   %C = xor %X, undef
2195 Safe:
2196   %A = undef
2197   %B = undef
2198   %C = undef
2199 </pre>
2200
2201 <p>This is safe because all of the output bits are affected by the undef bits.
2202    Any output bit can have a zero or one depending on the input bits.</p>
2203
2204 <pre class="doc_code">
2205   %A = or %X, undef
2206   %B = and %X, undef
2207 Safe:
2208   %A = -1
2209   %B = 0
2210 Unsafe:
2211   %A = undef
2212   %B = undef
2213 </pre>
2214
2215 <p>These logical operations have bits that are not always affected by the input.
2216    For example, if <tt>%X</tt> has a zero bit, then the output of the
2217    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2218    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2219    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2220    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2221    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2222    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2223    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2224
2225 <pre class="doc_code">
2226   %A = select undef, %X, %Y
2227   %B = select undef, 42, %Y
2228   %C = select %X, %Y, undef
2229 Safe:
2230   %A = %X     (or %Y)
2231   %B = 42     (or %Y)
2232   %C = %Y
2233 Unsafe:
2234   %A = undef
2235   %B = undef
2236   %C = undef
2237 </pre>
2238
2239 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2240    branch) conditions can go <em>either way</em>, but they have to come from one
2241    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2242    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2243    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2244    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2245    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2246    eliminated.</p>
2247
2248 <pre class="doc_code">
2249   %A = xor undef, undef
2250
2251   %B = undef
2252   %C = xor %B, %B
2253
2254   %D = undef
2255   %E = icmp lt %D, 4
2256   %F = icmp gte %D, 4
2257
2258 Safe:
2259   %A = undef
2260   %B = undef
2261   %C = undef
2262   %D = undef
2263   %E = undef
2264   %F = undef
2265 </pre>
2266
2267 <p>This example points out that two '<tt>undef</tt>' operands are not
2268    necessarily the same. This can be surprising to people (and also matches C
2269    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2270    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2271    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2272    its value over its "live range".  This is true because the variable doesn't
2273    actually <em>have a live range</em>. Instead, the value is logically read
2274    from arbitrary registers that happen to be around when needed, so the value
2275    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2276    need to have the same semantics or the core LLVM "replace all uses with"
2277    concept would not hold.</p>
2278
2279 <pre class="doc_code">
2280   %A = fdiv undef, %X
2281   %B = fdiv %X, undef
2282 Safe:
2283   %A = undef
2284 b: unreachable
2285 </pre>
2286
2287 <p>These examples show the crucial difference between an <em>undefined
2288   value</em> and <em>undefined behavior</em>. An undefined value (like
2289   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2290   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2291   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2292   defined on SNaN's. However, in the second example, we can make a more
2293   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2294   arbitrary value, we are allowed to assume that it could be zero. Since a
2295   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2296   the operation does not execute at all. This allows us to delete the divide and
2297   all code after it. Because the undefined operation "can't happen", the
2298   optimizer can assume that it occurs in dead code.</p>
2299
2300 <pre class="doc_code">
2301 a:  store undef -> %X
2302 b:  store %X -> undef
2303 Safe:
2304 a: &lt;deleted&gt;
2305 b: unreachable
2306 </pre>
2307
2308 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2309    undefined value can be assumed to not have any effect; we can assume that the
2310    value is overwritten with bits that happen to match what was already there.
2311    However, a store <em>to</em> an undefined location could clobber arbitrary
2312    memory, therefore, it has undefined behavior.</p>
2313
2314 </div>
2315
2316 <!-- ======================================================================= -->
2317 <div class="doc_subsection"><a name="trapvalues">Trap Values</a></div>
2318 <div class="doc_text">
2319
2320 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2321    instead of representing an unspecified bit pattern, they represent the
2322    fact that an instruction or constant expression which cannot evoke side
2323    effects has nevertheless detected a condition which results in undefined
2324    behavior.</p>
2325
2326 <p>There is currently no way of representing a trap value in the IR; they
2327    only exist when produced by operations such as
2328    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2329
2330 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2331
2332 <ul>
2333 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2334     their operands.</li>
2335
2336 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2337     to their dynamic predecessor basic block.</li>
2338
2339 <li>Function arguments depend on the corresponding actual argument values in
2340     the dynamic callers of their functions.</li>
2341
2342 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2343     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2344     control back to them.</li>
2345
2346 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2347     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2348     or exception-throwing call instructions that dynamically transfer control
2349     back to them.</li>
2350
2351 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2352     referenced memory addresses, following the order in the IR
2353     (including loads and stores implied by intrinsics such as
2354     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2355
2356 <!-- TODO: In the case of multiple threads, this only applies if the store
2357      "happens-before" the load or store. -->
2358
2359 <!-- TODO: floating-point exception state -->
2360
2361 <li>An instruction with externally visible side effects depends on the most
2362     recent preceding instruction with externally visible side effects, following
2363     the order in the IR. (This includes
2364     <a href="#volatile">volatile operations</a>.)</li>
2365
2366 <li>An instruction <i>control-depends</i> on a
2367     <a href="#terminators">terminator instruction</a>
2368     if the terminator instruction has multiple successors and the instruction
2369     is always executed when control transfers to one of the successors, and
2370     may not be executed when control is transfered to another.</li>
2371
2372 <li>Dependence is transitive.</li>
2373
2374 </ul>
2375
2376 <p>Whenever a trap value is generated, all values which depend on it evaluate
2377    to trap. If they have side effects, the evoke their side effects as if each
2378    operand with a trap value were undef. If they have externally-visible side
2379    effects, the behavior is undefined.</p>
2380
2381 <p>Here are some examples:</p>
2382
2383 <pre class="doc_code">
2384 entry:
2385   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2386   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2387   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2388   store i32 0, i32* %trap_yet_again  ; undefined behavior
2389
2390   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2391   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2392
2393   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2394
2395   %narrowaddr = bitcast i32* @g to i16*
2396   %wideaddr = bitcast i32* @g to i64*
2397   %trap3 = load 16* %narrowaddr      ; Returns a trap value.
2398   %trap4 = load i64* %widaddr        ; Returns a trap value.
2399
2400   %cmp = icmp i32 slt %trap, 0       ; Returns a trap value.
2401   %br i1 %cmp, %true, %end           ; Branch to either destination.
2402
2403 true:
2404   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2405                                      ; it has undefined behavior.
2406   br label %end
2407
2408 end:
2409   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2410                                      ; Both edges into this PHI are
2411                                      ; control-dependent on %cmp, so this
2412                                      ; always results in a trap value.
2413
2414   volatile store i32 0, i32* @g      ; %end is control-equivalent to %entry
2415                                      ; so this is defined (ignoring earlier
2416                                      ; undefined behavior in this example).
2417 </pre>
2418
2419 </div>
2420
2421 <!-- ======================================================================= -->
2422 <div class="doc_subsection"><a name="blockaddress">Addresses of Basic
2423     Blocks</a></div>
2424 <div class="doc_text">
2425
2426 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2427
2428 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2429    basic block in the specified function, and always has an i8* type.  Taking
2430    the address of the entry block is illegal.</p>
2431
2432 <p>This value only has defined behavior when used as an operand to the
2433    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2434    comparisons against null. Pointer equality tests between labels addresses
2435    results in undefined behavior &mdash; though, again, comparison against null
2436    is ok, and no label is equal to the null pointer. This may be passed around
2437    as an opaque pointer sized value as long as the bits are not inspected. This
2438    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2439    long as the original value is reconstituted before the <tt>indirectbr</tt>
2440    instruction.</p>
2441
2442 <p>Finally, some targets may provide defined semantics when using the value as
2443    the operand to an inline assembly, but that is target specific.</p>
2444
2445 </div>
2446
2447
2448 <!-- ======================================================================= -->
2449 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
2450 </div>
2451
2452 <div class="doc_text">
2453
2454 <p>Constant expressions are used to allow expressions involving other constants
2455    to be used as constants.  Constant expressions may be of
2456    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2457    operation that does not have side effects (e.g. load and call are not
2458    supported). The following is the syntax for constant expressions:</p>
2459
2460 <dl>
2461   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2462   <dd>Truncate a constant to another type. The bit size of CST must be larger
2463       than the bit size of TYPE. Both types must be integers.</dd>
2464
2465   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2466   <dd>Zero extend a constant to another type. The bit size of CST must be
2467       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2468
2469   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2470   <dd>Sign extend a constant to another type. The bit size of CST must be
2471       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2472
2473   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2474   <dd>Truncate a floating point constant to another floating point type. The
2475       size of CST must be larger than the size of TYPE. Both types must be
2476       floating point.</dd>
2477
2478   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2479   <dd>Floating point extend a constant to another type. The size of CST must be
2480       smaller or equal to the size of TYPE. Both types must be floating
2481       point.</dd>
2482
2483   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2484   <dd>Convert a floating point constant to the corresponding unsigned integer
2485       constant. TYPE must be a scalar or vector integer type. CST must be of
2486       scalar or vector floating point type. Both CST and TYPE must be scalars,
2487       or vectors of the same number of elements. If the value won't fit in the
2488       integer type, the results are undefined.</dd>
2489
2490   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2491   <dd>Convert a floating point constant to the corresponding signed integer
2492       constant.  TYPE must be a scalar or vector integer type. CST must be of
2493       scalar or vector floating point type. Both CST and TYPE must be scalars,
2494       or vectors of the same number of elements. If the value won't fit in the
2495       integer type, the results are undefined.</dd>
2496
2497   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2498   <dd>Convert an unsigned integer constant to the corresponding floating point
2499       constant. TYPE must be a scalar or vector floating point type. CST must be
2500       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2501       vectors of the same number of elements. If the value won't fit in the
2502       floating point type, the results are undefined.</dd>
2503
2504   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2505   <dd>Convert a signed integer constant to the corresponding floating point
2506       constant. TYPE must be a scalar or vector floating point type. CST must be
2507       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2508       vectors of the same number of elements. If the value won't fit in the
2509       floating point type, the results are undefined.</dd>
2510
2511   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2512   <dd>Convert a pointer typed constant to the corresponding integer constant
2513       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2514       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2515       make it fit in <tt>TYPE</tt>.</dd>
2516
2517   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2518   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2519       type.  CST must be of integer type. The CST value is zero extended,
2520       truncated, or unchanged to make it fit in a pointer size. This one is
2521       <i>really</i> dangerous!</dd>
2522
2523   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2524   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2525       are the same as those for the <a href="#i_bitcast">bitcast
2526       instruction</a>.</dd>
2527
2528   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2529   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2530   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2531       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2532       instruction, the index list may have zero or more indexes, which are
2533       required to make sense for the type of "CSTPTR".</dd>
2534
2535   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2536   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2537
2538   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2539   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2540
2541   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2542   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2543
2544   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2545   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2546       constants.</dd>
2547
2548   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2549   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2550     constants.</dd>
2551
2552   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2553   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2554       constants.</dd>
2555
2556   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2557   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2558     constants. The index list is interpreted in a similar manner as indices in
2559     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2560     index value must be specified.</dd>
2561
2562   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2563   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2564     constants. The index list is interpreted in a similar manner as indices in
2565     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2566     index value must be specified.</dd>
2567
2568   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2569   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2570       be any of the <a href="#binaryops">binary</a>
2571       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2572       on operands are the same as those for the corresponding instruction
2573       (e.g. no bitwise operations on floating point values are allowed).</dd>
2574 </dl>
2575
2576 </div>
2577
2578 <!-- *********************************************************************** -->
2579 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
2580 <!-- *********************************************************************** -->
2581
2582 <!-- ======================================================================= -->
2583 <div class="doc_subsection">
2584 <a name="inlineasm">Inline Assembler Expressions</a>
2585 </div>
2586
2587 <div class="doc_text">
2588
2589 <p>LLVM supports inline assembler expressions (as opposed
2590    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2591    a special value.  This value represents the inline assembler as a string
2592    (containing the instructions to emit), a list of operand constraints (stored
2593    as a string), a flag that indicates whether or not the inline asm
2594    expression has side effects, and a flag indicating whether the function
2595    containing the asm needs to align its stack conservatively.  An example
2596    inline assembler expression is:</p>
2597
2598 <pre class="doc_code">
2599 i32 (i32) asm "bswap $0", "=r,r"
2600 </pre>
2601
2602 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2603    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2604    have:</p>
2605
2606 <pre class="doc_code">
2607 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2608 </pre>
2609
2610 <p>Inline asms with side effects not visible in the constraint list must be
2611    marked as having side effects.  This is done through the use of the
2612    '<tt>sideeffect</tt>' keyword, like so:</p>
2613
2614 <pre class="doc_code">
2615 call void asm sideeffect "eieio", ""()
2616 </pre>
2617
2618 <p>In some cases inline asms will contain code that will not work unless the
2619    stack is aligned in some way, such as calls or SSE instructions on x86,
2620    yet will not contain code that does that alignment within the asm.
2621    The compiler should make conservative assumptions about what the asm might
2622    contain and should generate its usual stack alignment code in the prologue
2623    if the '<tt>alignstack</tt>' keyword is present:</p>
2624
2625 <pre class="doc_code">
2626 call void asm alignstack "eieio", ""()
2627 </pre>
2628
2629 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2630    first.</p>
2631
2632 <p>TODO: The format of the asm and constraints string still need to be
2633    documented here.  Constraints on what can be done (e.g. duplication, moving,
2634    etc need to be documented).  This is probably best done by reference to
2635    another document that covers inline asm from a holistic perspective.</p>
2636 </div>
2637
2638 <div class="doc_subsubsection">
2639 <a name="inlineasm_md">Inline Asm Metadata</a>
2640 </div>
2641
2642 <div class="doc_text">
2643
2644 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2645    attached to it that contains a list of constant integers.  If present, the
2646   code generator will use the integer as the location cookie value when report
2647    errors through the LLVMContext error reporting mechanisms.  This allows a
2648    front-end to correlate backend errors that occur with inline asm back to the
2649    source code that produced it.  For example:</p>
2650
2651 <pre class="doc_code">
2652 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2653 ...
2654 !42 = !{ i32 1234567 }
2655 </pre>
2656
2657 <p>It is up to the front-end to make sense of the magic numbers it places in the
2658    IR.  If the MDNode contains multiple constants, the code generator will use
2659    the one that corresponds to the line of the asm that the error occurs on.</p>
2660
2661 </div>
2662
2663 <!-- ======================================================================= -->
2664 <div class="doc_subsection"><a name="metadata">Metadata Nodes and Metadata
2665   Strings</a>
2666 </div>
2667
2668 <div class="doc_text">
2669
2670 <p>LLVM IR allows metadata to be attached to instructions in the program that
2671    can convey extra information about the code to the optimizers and code
2672    generator.  One example application of metadata is source-level debug
2673    information.  There are two metadata primitives: strings and nodes. All
2674    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2675    preceding exclamation point ('<tt>!</tt>').</p>
2676
2677 <p>A metadata string is a string surrounded by double quotes.  It can contain
2678    any character by escaping non-printable characters with "\xx" where "xx" is
2679    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2680
2681 <p>Metadata nodes are represented with notation similar to structure constants
2682    (a comma separated list of elements, surrounded by braces and preceded by an
2683    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2684    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2685
2686 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2687    metadata nodes, which can be looked up in the module symbol table. For
2688    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2689
2690 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2691    function is using two metadata arguments.</p>
2692
2693 <div class="doc_code">
2694 <pre>
2695 call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2696 </pre>
2697 </div>
2698
2699 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2700    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2701
2702 <div class="doc_code">
2703 <pre>
2704 %indvar.next = add i64 %indvar, 1, !dbg !21
2705 </pre>
2706 </div>
2707
2708 </div>
2709
2710
2711 <!-- *********************************************************************** -->
2712 <div class="doc_section">
2713   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2714 </div>
2715 <!-- *********************************************************************** -->
2716
2717 <p>LLVM has a number of "magic" global variables that contain data that affect
2718 code generation or other IR semantics.  These are documented here.  All globals
2719 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2720 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2721 by LLVM.</p>
2722
2723 <!-- ======================================================================= -->
2724 <div class="doc_subsection">
2725 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2726 </div>
2727
2728 <div class="doc_text">
2729
2730 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2731 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2732 pointers to global variables and functions which may optionally have a pointer
2733 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2734
2735 <pre>
2736   @X = global i8 4
2737   @Y = global i32 123
2738
2739   @llvm.used = appending global [2 x i8*] [
2740      i8* @X,
2741      i8* bitcast (i32* @Y to i8*)
2742   ], section "llvm.metadata"
2743 </pre>
2744
2745 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2746 compiler, assembler, and linker are required to treat the symbol as if there is
2747 a reference to the global that it cannot see.  For example, if a variable has
2748 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2749 list, it cannot be deleted.  This is commonly used to represent references from
2750 inline asms and other things the compiler cannot "see", and corresponds to
2751 "attribute((used))" in GNU C.</p>
2752
2753 <p>On some targets, the code generator must emit a directive to the assembler or
2754 object file to prevent the assembler and linker from molesting the symbol.</p>
2755
2756 </div>
2757
2758 <!-- ======================================================================= -->
2759 <div class="doc_subsection">
2760 <a name="intg_compiler_used">The '<tt>llvm.compiler.used</tt>' Global Variable</a>
2761 </div>
2762
2763 <div class="doc_text">
2764
2765 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2766 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2767 touching the symbol.  On targets that support it, this allows an intelligent
2768 linker to optimize references to the symbol without being impeded as it would be
2769 by <tt>@llvm.used</tt>.</p>
2770
2771 <p>This is a rare construct that should only be used in rare circumstances, and
2772 should not be exposed to source languages.</p>
2773
2774 </div>
2775
2776 <!-- ======================================================================= -->
2777 <div class="doc_subsection">
2778 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2779 </div>
2780
2781 <div class="doc_text">
2782 <pre>
2783 %0 = type { i32, void ()* }
2784 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2785 </pre>
2786 <p>The <tt>@llvm.global_ctors</tt> array contains a list of constructor functions and associated priorities.  The functions referenced by this array will be called in ascending order of priority (i.e. lowest first) when the module is loaded.  The order of functions with the same priority is not defined.
2787 </p>
2788
2789 </div>
2790
2791 <!-- ======================================================================= -->
2792 <div class="doc_subsection">
2793 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2794 </div>
2795
2796 <div class="doc_text">
2797 <pre>
2798 %0 = type { i32, void ()* }
2799 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2800 </pre>
2801
2802 <p>The <tt>@llvm.global_dtors</tt> array contains a list of destructor functions and associated priorities.  The functions referenced by this array will be called in descending order of priority (i.e. highest first) when the module is loaded.  The order of functions with the same priority is not defined.
2803 </p>
2804
2805 </div>
2806
2807
2808 <!-- *********************************************************************** -->
2809 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
2810 <!-- *********************************************************************** -->
2811
2812 <div class="doc_text">
2813
2814 <p>The LLVM instruction set consists of several different classifications of
2815    instructions: <a href="#terminators">terminator
2816    instructions</a>, <a href="#binaryops">binary instructions</a>,
2817    <a href="#bitwiseops">bitwise binary instructions</a>,
2818    <a href="#memoryops">memory instructions</a>, and
2819    <a href="#otherops">other instructions</a>.</p>
2820
2821 </div>
2822
2823 <!-- ======================================================================= -->
2824 <div class="doc_subsection"> <a name="terminators">Terminator
2825 Instructions</a> </div>
2826
2827 <div class="doc_text">
2828
2829 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
2830    in a program ends with a "Terminator" instruction, which indicates which
2831    block should be executed after the current block is finished. These
2832    terminator instructions typically yield a '<tt>void</tt>' value: they produce
2833    control flow, not values (the one exception being the
2834    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
2835
2836 <p>There are seven different terminator instructions: the
2837    '<a href="#i_ret"><tt>ret</tt></a>' instruction, the
2838    '<a href="#i_br"><tt>br</tt></a>' instruction, the
2839    '<a href="#i_switch"><tt>switch</tt></a>' instruction, the
2840    '<a href="#i_indirectbr">'<tt>indirectbr</tt></a>' Instruction, the
2841    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the
2842    '<a href="#i_unwind"><tt>unwind</tt></a>' instruction, and the
2843    '<a href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
2844
2845 </div>
2846
2847 <!-- _______________________________________________________________________ -->
2848 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
2849 Instruction</a> </div>
2850
2851 <div class="doc_text">
2852
2853 <h5>Syntax:</h5>
2854 <pre>
2855   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
2856   ret void                 <i>; Return from void function</i>
2857 </pre>
2858
2859 <h5>Overview:</h5>
2860 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
2861    a value) from a function back to the caller.</p>
2862
2863 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
2864    value and then causes control flow, and one that just causes control flow to
2865    occur.</p>
2866
2867 <h5>Arguments:</h5>
2868 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
2869    return value. The type of the return value must be a
2870    '<a href="#t_firstclass">first class</a>' type.</p>
2871
2872 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
2873    non-void return type and contains a '<tt>ret</tt>' instruction with no return
2874    value or a return value with a type that does not match its type, or if it
2875    has a void return type and contains a '<tt>ret</tt>' instruction with a
2876    return value.</p>
2877
2878 <h5>Semantics:</h5>
2879 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
2880    the calling function's context.  If the caller is a
2881    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
2882    instruction after the call.  If the caller was an
2883    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
2884    the beginning of the "normal" destination block.  If the instruction returns
2885    a value, that value shall set the call or invoke instruction's return
2886    value.</p>
2887
2888 <h5>Example:</h5>
2889 <pre>
2890   ret i32 5                       <i>; Return an integer value of 5</i>
2891   ret void                        <i>; Return from a void function</i>
2892   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
2893 </pre>
2894
2895 </div>
2896 <!-- _______________________________________________________________________ -->
2897 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
2898
2899 <div class="doc_text">
2900
2901 <h5>Syntax:</h5>
2902 <pre>
2903   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
2904 </pre>
2905
2906 <h5>Overview:</h5>
2907 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
2908    different basic block in the current function.  There are two forms of this
2909    instruction, corresponding to a conditional branch and an unconditional
2910    branch.</p>
2911
2912 <h5>Arguments:</h5>
2913 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
2914    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
2915    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
2916    target.</p>
2917
2918 <h5>Semantics:</h5>
2919 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
2920    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
2921    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
2922    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
2923
2924 <h5>Example:</h5>
2925 <pre>
2926 Test:
2927   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
2928   br i1 %cond, label %IfEqual, label %IfUnequal
2929 IfEqual:
2930   <a href="#i_ret">ret</a> i32 1
2931 IfUnequal:
2932   <a href="#i_ret">ret</a> i32 0
2933 </pre>
2934
2935 </div>
2936
2937 <!-- _______________________________________________________________________ -->
2938 <div class="doc_subsubsection">
2939    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
2940 </div>
2941
2942 <div class="doc_text">
2943
2944 <h5>Syntax:</h5>
2945 <pre>
2946   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
2947 </pre>
2948
2949 <h5>Overview:</h5>
2950 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
2951    several different places.  It is a generalization of the '<tt>br</tt>'
2952    instruction, allowing a branch to occur to one of many possible
2953    destinations.</p>
2954
2955 <h5>Arguments:</h5>
2956 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
2957    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
2958    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
2959    The table is not allowed to contain duplicate constant entries.</p>
2960
2961 <h5>Semantics:</h5>
2962 <p>The <tt>switch</tt> instruction specifies a table of values and
2963    destinations. When the '<tt>switch</tt>' instruction is executed, this table
2964    is searched for the given value.  If the value is found, control flow is
2965    transferred to the corresponding destination; otherwise, control flow is
2966    transferred to the default destination.</p>
2967
2968 <h5>Implementation:</h5>
2969 <p>Depending on properties of the target machine and the particular
2970    <tt>switch</tt> instruction, this instruction may be code generated in
2971    different ways.  For example, it could be generated as a series of chained
2972    conditional branches or with a lookup table.</p>
2973
2974 <h5>Example:</h5>
2975 <pre>
2976  <i>; Emulate a conditional br instruction</i>
2977  %Val = <a href="#i_zext">zext</a> i1 %value to i32
2978  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
2979
2980  <i>; Emulate an unconditional br instruction</i>
2981  switch i32 0, label %dest [ ]
2982
2983  <i>; Implement a jump table:</i>
2984  switch i32 %val, label %otherwise [ i32 0, label %onzero
2985                                      i32 1, label %onone
2986                                      i32 2, label %ontwo ]
2987 </pre>
2988
2989 </div>
2990
2991
2992 <!-- _______________________________________________________________________ -->
2993 <div class="doc_subsubsection">
2994    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
2995 </div>
2996
2997 <div class="doc_text">
2998
2999 <h5>Syntax:</h5>
3000 <pre>
3001   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
3002 </pre>
3003
3004 <h5>Overview:</h5>
3005
3006 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3007    within the current function, whose address is specified by
3008    "<tt>address</tt>".  Address must be derived from a <a
3009    href="#blockaddress">blockaddress</a> constant.</p>
3010
3011 <h5>Arguments:</h5>
3012
3013 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3014    rest of the arguments indicate the full set of possible destinations that the
3015    address may point to.  Blocks are allowed to occur multiple times in the
3016    destination list, though this isn't particularly useful.</p>
3017
3018 <p>This destination list is required so that dataflow analysis has an accurate
3019    understanding of the CFG.</p>
3020
3021 <h5>Semantics:</h5>
3022
3023 <p>Control transfers to the block specified in the address argument.  All
3024    possible destination blocks must be listed in the label list, otherwise this
3025    instruction has undefined behavior.  This implies that jumps to labels
3026    defined in other functions have undefined behavior as well.</p>
3027
3028 <h5>Implementation:</h5>
3029
3030 <p>This is typically implemented with a jump through a register.</p>
3031
3032 <h5>Example:</h5>
3033 <pre>
3034  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3035 </pre>
3036
3037 </div>
3038
3039
3040 <!-- _______________________________________________________________________ -->
3041 <div class="doc_subsubsection">
3042   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3043 </div>
3044
3045 <div class="doc_text">
3046
3047 <h5>Syntax:</h5>
3048 <pre>
3049   &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>]
3050                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3051 </pre>
3052
3053 <h5>Overview:</h5>
3054 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3055    function, with the possibility of control flow transfer to either the
3056    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3057    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3058    control flow will return to the "normal" label.  If the callee (or any
3059    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3060    instruction, control is interrupted and continued at the dynamically nearest
3061    "exception" label.</p>
3062
3063 <h5>Arguments:</h5>
3064 <p>This instruction requires several arguments:</p>
3065
3066 <ol>
3067   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3068       convention</a> the call should use.  If none is specified, the call
3069       defaults to using C calling conventions.</li>
3070
3071   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3072       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3073       '<tt>inreg</tt>' attributes are valid here.</li>
3074
3075   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3076       function value being invoked.  In most cases, this is a direct function
3077       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3078       off an arbitrary pointer to function value.</li>
3079
3080   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3081       function to be invoked. </li>
3082
3083   <li>'<tt>function args</tt>': argument list whose types match the function
3084       signature argument types and parameter attributes. All arguments must be
3085       of <a href="#t_firstclass">first class</a> type. If the function
3086       signature indicates the function accepts a variable number of arguments,
3087       the extra arguments can be specified.</li>
3088
3089   <li>'<tt>normal label</tt>': the label reached when the called function
3090       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3091
3092   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3093       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3094
3095   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3096       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3097       '<tt>readnone</tt>' attributes are valid here.</li>
3098 </ol>
3099
3100 <h5>Semantics:</h5>
3101 <p>This instruction is designed to operate as a standard
3102    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3103    primary difference is that it establishes an association with a label, which
3104    is used by the runtime library to unwind the stack.</p>
3105
3106 <p>This instruction is used in languages with destructors to ensure that proper
3107    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3108    exception.  Additionally, this is important for implementation of
3109    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3110
3111 <p>For the purposes of the SSA form, the definition of the value returned by the
3112    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3113    block to the "normal" label. If the callee unwinds then no return value is
3114    available.</p>
3115
3116 <p>Note that the code generator does not yet completely support unwind, and
3117 that the invoke/unwind semantics are likely to change in future versions.</p>
3118
3119 <h5>Example:</h5>
3120 <pre>
3121   %retval = invoke i32 @Test(i32 15) to label %Continue
3122               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3123   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3124               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3125 </pre>
3126
3127 </div>
3128
3129 <!-- _______________________________________________________________________ -->
3130
3131 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
3132 Instruction</a> </div>
3133
3134 <div class="doc_text">
3135
3136 <h5>Syntax:</h5>
3137 <pre>
3138   unwind
3139 </pre>
3140
3141 <h5>Overview:</h5>
3142 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3143    at the first callee in the dynamic call stack which used
3144    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3145    This is primarily used to implement exception handling.</p>
3146
3147 <h5>Semantics:</h5>
3148 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3149    immediately halt.  The dynamic call stack is then searched for the
3150    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3151    Once found, execution continues at the "exceptional" destination block
3152    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3153    instruction in the dynamic call chain, undefined behavior results.</p>
3154
3155 <p>Note that the code generator does not yet completely support unwind, and
3156 that the invoke/unwind semantics are likely to change in future versions.</p>
3157
3158 </div>
3159
3160 <!-- _______________________________________________________________________ -->
3161
3162 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
3163 Instruction</a> </div>
3164
3165 <div class="doc_text">
3166
3167 <h5>Syntax:</h5>
3168 <pre>
3169   unreachable
3170 </pre>
3171
3172 <h5>Overview:</h5>
3173 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3174    instruction is used to inform the optimizer that a particular portion of the
3175    code is not reachable.  This can be used to indicate that the code after a
3176    no-return function cannot be reached, and other facts.</p>
3177
3178 <h5>Semantics:</h5>
3179 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3180
3181 </div>
3182
3183 <!-- ======================================================================= -->
3184 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
3185
3186 <div class="doc_text">
3187
3188 <p>Binary operators are used to do most of the computation in a program.  They
3189    require two operands of the same type, execute an operation on them, and
3190    produce a single value.  The operands might represent multiple data, as is
3191    the case with the <a href="#t_vector">vector</a> data type.  The result value
3192    has the same type as its operands.</p>
3193
3194 <p>There are several different binary operators:</p>
3195
3196 </div>
3197
3198 <!-- _______________________________________________________________________ -->
3199 <div class="doc_subsubsection">
3200   <a name="i_add">'<tt>add</tt>' Instruction</a>
3201 </div>
3202
3203 <div class="doc_text">
3204
3205 <h5>Syntax:</h5>
3206 <pre>
3207   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3208   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3209   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3210   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3211 </pre>
3212
3213 <h5>Overview:</h5>
3214 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3215
3216 <h5>Arguments:</h5>
3217 <p>The two arguments to the '<tt>add</tt>' instruction must
3218    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3219    integer values. Both arguments must have identical types.</p>
3220
3221 <h5>Semantics:</h5>
3222 <p>The value produced is the integer sum of the two operands.</p>
3223
3224 <p>If the sum has unsigned overflow, the result returned is the mathematical
3225    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3226
3227 <p>Because LLVM integers use a two's complement representation, this instruction
3228    is appropriate for both signed and unsigned integers.</p>
3229
3230 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3231    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3232    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3233    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3234    respectively, occurs.</p>
3235
3236 <h5>Example:</h5>
3237 <pre>
3238   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3239 </pre>
3240
3241 </div>
3242
3243 <!-- _______________________________________________________________________ -->
3244 <div class="doc_subsubsection">
3245   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3246 </div>
3247
3248 <div class="doc_text">
3249
3250 <h5>Syntax:</h5>
3251 <pre>
3252   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3253 </pre>
3254
3255 <h5>Overview:</h5>
3256 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3257
3258 <h5>Arguments:</h5>
3259 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3260    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3261    floating point values. Both arguments must have identical types.</p>
3262
3263 <h5>Semantics:</h5>
3264 <p>The value produced is the floating point sum of the two operands.</p>
3265
3266 <h5>Example:</h5>
3267 <pre>
3268   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3269 </pre>
3270
3271 </div>
3272
3273 <!-- _______________________________________________________________________ -->
3274 <div class="doc_subsubsection">
3275    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3276 </div>
3277
3278 <div class="doc_text">
3279
3280 <h5>Syntax:</h5>
3281 <pre>
3282   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3283   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3284   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3285   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3286 </pre>
3287
3288 <h5>Overview:</h5>
3289 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3290    operands.</p>
3291
3292 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3293    '<tt>neg</tt>' instruction present in most other intermediate
3294    representations.</p>
3295
3296 <h5>Arguments:</h5>
3297 <p>The two arguments to the '<tt>sub</tt>' instruction must
3298    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3299    integer values.  Both arguments must have identical types.</p>
3300
3301 <h5>Semantics:</h5>
3302 <p>The value produced is the integer difference of the two operands.</p>
3303
3304 <p>If the difference has unsigned overflow, the result returned is the
3305    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3306    result.</p>
3307
3308 <p>Because LLVM integers use a two's complement representation, this instruction
3309    is appropriate for both signed and unsigned integers.</p>
3310
3311 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3312    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3313    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3314    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3315    respectively, occurs.</p>
3316
3317 <h5>Example:</h5>
3318 <pre>
3319   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3320   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3321 </pre>
3322
3323 </div>
3324
3325 <!-- _______________________________________________________________________ -->
3326 <div class="doc_subsubsection">
3327    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3328 </div>
3329
3330 <div class="doc_text">
3331
3332 <h5>Syntax:</h5>
3333 <pre>
3334   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3335 </pre>
3336
3337 <h5>Overview:</h5>
3338 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3339    operands.</p>
3340
3341 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3342    '<tt>fneg</tt>' instruction present in most other intermediate
3343    representations.</p>
3344
3345 <h5>Arguments:</h5>
3346 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3347    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3348    floating point values.  Both arguments must have identical types.</p>
3349
3350 <h5>Semantics:</h5>
3351 <p>The value produced is the floating point difference of the two operands.</p>
3352
3353 <h5>Example:</h5>
3354 <pre>
3355   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3356   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3357 </pre>
3358
3359 </div>
3360
3361 <!-- _______________________________________________________________________ -->
3362 <div class="doc_subsubsection">
3363   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3364 </div>
3365
3366 <div class="doc_text">
3367
3368 <h5>Syntax:</h5>
3369 <pre>
3370   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3371   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3372   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3373   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3374 </pre>
3375
3376 <h5>Overview:</h5>
3377 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3378
3379 <h5>Arguments:</h5>
3380 <p>The two arguments to the '<tt>mul</tt>' instruction must
3381    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3382    integer values.  Both arguments must have identical types.</p>
3383
3384 <h5>Semantics:</h5>
3385 <p>The value produced is the integer product of the two operands.</p>
3386
3387 <p>If the result of the multiplication has unsigned overflow, the result
3388    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3389    width of the result.</p>
3390
3391 <p>Because LLVM integers use a two's complement representation, and the result
3392    is the same width as the operands, this instruction returns the correct
3393    result for both signed and unsigned integers.  If a full product
3394    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3395    be sign-extended or zero-extended as appropriate to the width of the full
3396    product.</p>
3397
3398 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3399    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3400    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3401    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3402    respectively, occurs.</p>
3403
3404 <h5>Example:</h5>
3405 <pre>
3406   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3407 </pre>
3408
3409 </div>
3410
3411 <!-- _______________________________________________________________________ -->
3412 <div class="doc_subsubsection">
3413   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3414 </div>
3415
3416 <div class="doc_text">
3417
3418 <h5>Syntax:</h5>
3419 <pre>
3420   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3421 </pre>
3422
3423 <h5>Overview:</h5>
3424 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3425
3426 <h5>Arguments:</h5>
3427 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3428    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3429    floating point values.  Both arguments must have identical types.</p>
3430
3431 <h5>Semantics:</h5>
3432 <p>The value produced is the floating point product of the two operands.</p>
3433
3434 <h5>Example:</h5>
3435 <pre>
3436   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3437 </pre>
3438
3439 </div>
3440
3441 <!-- _______________________________________________________________________ -->
3442 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
3443 </a></div>
3444
3445 <div class="doc_text">
3446
3447 <h5>Syntax:</h5>
3448 <pre>
3449   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3450   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3451 </pre>
3452
3453 <h5>Overview:</h5>
3454 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3455
3456 <h5>Arguments:</h5>
3457 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3458    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3459    values.  Both arguments must have identical types.</p>
3460
3461 <h5>Semantics:</h5>
3462 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3463
3464 <p>Note that unsigned integer division and signed integer division are distinct
3465    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3466
3467 <p>Division by zero leads to undefined behavior.</p>
3468
3469 <p>If the <tt>exact</tt> keyword is present, the result value of the
3470    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3471   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3472
3473
3474 <h5>Example:</h5>
3475 <pre>
3476   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3477 </pre>
3478
3479 </div>
3480
3481 <!-- _______________________________________________________________________ -->
3482 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
3483 </a> </div>
3484
3485 <div class="doc_text">
3486
3487 <h5>Syntax:</h5>
3488 <pre>
3489   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3490   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3491 </pre>
3492
3493 <h5>Overview:</h5>
3494 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3495
3496 <h5>Arguments:</h5>
3497 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3498    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3499    values.  Both arguments must have identical types.</p>
3500
3501 <h5>Semantics:</h5>
3502 <p>The value produced is the signed integer quotient of the two operands rounded
3503    towards zero.</p>
3504
3505 <p>Note that signed integer division and unsigned integer division are distinct
3506    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3507
3508 <p>Division by zero leads to undefined behavior. Overflow also leads to
3509    undefined behavior; this is a rare case, but can occur, for example, by doing
3510    a 32-bit division of -2147483648 by -1.</p>
3511
3512 <p>If the <tt>exact</tt> keyword is present, the result value of the
3513    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3514    be rounded.</p>
3515
3516 <h5>Example:</h5>
3517 <pre>
3518   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3519 </pre>
3520
3521 </div>
3522
3523 <!-- _______________________________________________________________________ -->
3524 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
3525 Instruction</a> </div>
3526
3527 <div class="doc_text">
3528
3529 <h5>Syntax:</h5>
3530 <pre>
3531   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3532 </pre>
3533
3534 <h5>Overview:</h5>
3535 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3536
3537 <h5>Arguments:</h5>
3538 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3539    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3540    floating point values.  Both arguments must have identical types.</p>
3541
3542 <h5>Semantics:</h5>
3543 <p>The value produced is the floating point quotient of the two operands.</p>
3544
3545 <h5>Example:</h5>
3546 <pre>
3547   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3548 </pre>
3549
3550 </div>
3551
3552 <!-- _______________________________________________________________________ -->
3553 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3554 </div>
3555
3556 <div class="doc_text">
3557
3558 <h5>Syntax:</h5>
3559 <pre>
3560   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3561 </pre>
3562
3563 <h5>Overview:</h5>
3564 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3565    division of its two arguments.</p>
3566
3567 <h5>Arguments:</h5>
3568 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3569    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3570    values.  Both arguments must have identical types.</p>
3571
3572 <h5>Semantics:</h5>
3573 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3574    This instruction always performs an unsigned division to get the
3575    remainder.</p>
3576
3577 <p>Note that unsigned integer remainder and signed integer remainder are
3578    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3579
3580 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3581
3582 <h5>Example:</h5>
3583 <pre>
3584   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3585 </pre>
3586
3587 </div>
3588
3589 <!-- _______________________________________________________________________ -->
3590 <div class="doc_subsubsection">
3591   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3592 </div>
3593
3594 <div class="doc_text">
3595
3596 <h5>Syntax:</h5>
3597 <pre>
3598   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3599 </pre>
3600
3601 <h5>Overview:</h5>
3602 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3603    division of its two operands. This instruction can also take
3604    <a href="#t_vector">vector</a> versions of the values in which case the
3605    elements must be integers.</p>
3606
3607 <h5>Arguments:</h5>
3608 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3609    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3610    values.  Both arguments must have identical types.</p>
3611
3612 <h5>Semantics:</h5>
3613 <p>This instruction returns the <i>remainder</i> of a division (where the result
3614    is either zero or has the same sign as the dividend, <tt>op1</tt>), not the
3615    <i>modulo</i> operator (where the result is either zero or has the same sign
3616    as the divisor, <tt>op2</tt>) of a value.
3617    For more information about the difference,
3618    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3619    Math Forum</a>. For a table of how this is implemented in various languages,
3620    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3621    Wikipedia: modulo operation</a>.</p>
3622
3623 <p>Note that signed integer remainder and unsigned integer remainder are
3624    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3625
3626 <p>Taking the remainder of a division by zero leads to undefined behavior.
3627    Overflow also leads to undefined behavior; this is a rare case, but can
3628    occur, for example, by taking the remainder of a 32-bit division of
3629    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3630    lets srem be implemented using instructions that return both the result of
3631    the division and the remainder.)</p>
3632
3633 <h5>Example:</h5>
3634 <pre>
3635   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3636 </pre>
3637
3638 </div>
3639
3640 <!-- _______________________________________________________________________ -->
3641 <div class="doc_subsubsection">
3642   <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
3643
3644 <div class="doc_text">
3645
3646 <h5>Syntax:</h5>
3647 <pre>
3648   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3649 </pre>
3650
3651 <h5>Overview:</h5>
3652 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3653    its two operands.</p>
3654
3655 <h5>Arguments:</h5>
3656 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3657    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3658    floating point values.  Both arguments must have identical types.</p>
3659
3660 <h5>Semantics:</h5>
3661 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3662    has the same sign as the dividend.</p>
3663
3664 <h5>Example:</h5>
3665 <pre>
3666   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3667 </pre>
3668
3669 </div>
3670
3671 <!-- ======================================================================= -->
3672 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
3673 Operations</a> </div>
3674
3675 <div class="doc_text">
3676
3677 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3678    program.  They are generally very efficient instructions and can commonly be
3679    strength reduced from other instructions.  They require two operands of the
3680    same type, execute an operation on them, and produce a single value.  The
3681    resulting value is the same type as its operands.</p>
3682
3683 </div>
3684
3685 <!-- _______________________________________________________________________ -->
3686 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
3687 Instruction</a> </div>
3688
3689 <div class="doc_text">
3690
3691 <h5>Syntax:</h5>
3692 <pre>
3693   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3694   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3695   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3696   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3697 </pre>
3698
3699 <h5>Overview:</h5>
3700 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3701    a specified number of bits.</p>
3702
3703 <h5>Arguments:</h5>
3704 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3705     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3706     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3707
3708 <h5>Semantics:</h5>
3709 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3710    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3711    is (statically or dynamically) negative or equal to or larger than the number
3712    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3713    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3714    shift amount in <tt>op2</tt>.</p>
3715
3716 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3717    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3718    the <tt>nsw</tt> keyword is present, then the shift produces a
3719    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3720    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3721    they would if the shift were expressed as a mul instruction with the same
3722    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3723
3724 <h5>Example:</h5>
3725 <pre>
3726   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3727   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3728   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3729   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3730   &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>
3731 </pre>
3732
3733 </div>
3734
3735 <!-- _______________________________________________________________________ -->
3736 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
3737 Instruction</a> </div>
3738
3739 <div class="doc_text">
3740
3741 <h5>Syntax:</h5>
3742 <pre>
3743   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3744   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3745 </pre>
3746
3747 <h5>Overview:</h5>
3748 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
3749    operand shifted to the right a specified number of bits with zero fill.</p>
3750
3751 <h5>Arguments:</h5>
3752 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
3753    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3754    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
3755
3756 <h5>Semantics:</h5>
3757 <p>This instruction always performs a logical shift right operation. The most
3758    significant bits of the result will be filled with zero bits after the shift.
3759    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
3760    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
3761    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3762    shift amount in <tt>op2</tt>.</p>
3763
3764 <p>If the <tt>exact</tt> keyword is present, the result value of the
3765    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3766    shifted out are non-zero.</p>
3767
3768
3769 <h5>Example:</h5>
3770 <pre>
3771   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
3772   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
3773   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
3774   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
3775   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
3776   &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>
3777 </pre>
3778
3779 </div>
3780
3781 <!-- _______________________________________________________________________ -->
3782 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
3783 Instruction</a> </div>
3784 <div class="doc_text">
3785
3786 <h5>Syntax:</h5>
3787 <pre>
3788   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3789   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3790 </pre>
3791
3792 <h5>Overview:</h5>
3793 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
3794    operand shifted to the right a specified number of bits with sign
3795    extension.</p>
3796
3797 <h5>Arguments:</h5>
3798 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
3799    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3800    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3801
3802 <h5>Semantics:</h5>
3803 <p>This instruction always performs an arithmetic shift right operation, The
3804    most significant bits of the result will be filled with the sign bit
3805    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
3806    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
3807    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
3808    the corresponding shift amount in <tt>op2</tt>.</p>
3809
3810 <p>If the <tt>exact</tt> keyword is present, the result value of the
3811    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3812    shifted out are non-zero.</p>
3813
3814 <h5>Example:</h5>
3815 <pre>
3816   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
3817   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
3818   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
3819   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
3820   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
3821   &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>
3822 </pre>
3823
3824 </div>
3825
3826 <!-- _______________________________________________________________________ -->
3827 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
3828 Instruction</a> </div>
3829
3830 <div class="doc_text">
3831
3832 <h5>Syntax:</h5>
3833 <pre>
3834   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3835 </pre>
3836
3837 <h5>Overview:</h5>
3838 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
3839    operands.</p>
3840
3841 <h5>Arguments:</h5>
3842 <p>The two arguments to the '<tt>and</tt>' instruction must be
3843    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3844    values.  Both arguments must have identical types.</p>
3845
3846 <h5>Semantics:</h5>
3847 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
3848
3849 <table border="1" cellspacing="0" cellpadding="4">
3850   <tbody>
3851     <tr>
3852       <td>In0</td>
3853       <td>In1</td>
3854       <td>Out</td>
3855     </tr>
3856     <tr>
3857       <td>0</td>
3858       <td>0</td>
3859       <td>0</td>
3860     </tr>
3861     <tr>
3862       <td>0</td>
3863       <td>1</td>
3864       <td>0</td>
3865     </tr>
3866     <tr>
3867       <td>1</td>
3868       <td>0</td>
3869       <td>0</td>
3870     </tr>
3871     <tr>
3872       <td>1</td>
3873       <td>1</td>
3874       <td>1</td>
3875     </tr>
3876   </tbody>
3877 </table>
3878
3879 <h5>Example:</h5>
3880 <pre>
3881   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
3882   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
3883   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
3884 </pre>
3885 </div>
3886 <!-- _______________________________________________________________________ -->
3887 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
3888
3889 <div class="doc_text">
3890
3891 <h5>Syntax:</h5>
3892 <pre>
3893   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3894 </pre>
3895
3896 <h5>Overview:</h5>
3897 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
3898    two operands.</p>
3899
3900 <h5>Arguments:</h5>
3901 <p>The two arguments to the '<tt>or</tt>' instruction must be
3902    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3903    values.  Both arguments must have identical types.</p>
3904
3905 <h5>Semantics:</h5>
3906 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
3907
3908 <table border="1" cellspacing="0" cellpadding="4">
3909   <tbody>
3910     <tr>
3911       <td>In0</td>
3912       <td>In1</td>
3913       <td>Out</td>
3914     </tr>
3915     <tr>
3916       <td>0</td>
3917       <td>0</td>
3918       <td>0</td>
3919     </tr>
3920     <tr>
3921       <td>0</td>
3922       <td>1</td>
3923       <td>1</td>
3924     </tr>
3925     <tr>
3926       <td>1</td>
3927       <td>0</td>
3928       <td>1</td>
3929     </tr>
3930     <tr>
3931       <td>1</td>
3932       <td>1</td>
3933       <td>1</td>
3934     </tr>
3935   </tbody>
3936 </table>
3937
3938 <h5>Example:</h5>
3939 <pre>
3940   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
3941   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
3942   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
3943 </pre>
3944
3945 </div>
3946
3947 <!-- _______________________________________________________________________ -->
3948 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
3949 Instruction</a> </div>
3950
3951 <div class="doc_text">
3952
3953 <h5>Syntax:</h5>
3954 <pre>
3955   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3956 </pre>
3957
3958 <h5>Overview:</h5>
3959 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
3960    its two operands.  The <tt>xor</tt> is used to implement the "one's
3961    complement" operation, which is the "~" operator in C.</p>
3962
3963 <h5>Arguments:</h5>
3964 <p>The two arguments to the '<tt>xor</tt>' instruction must be
3965    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3966    values.  Both arguments must have identical types.</p>
3967
3968 <h5>Semantics:</h5>
3969 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
3970
3971 <table border="1" cellspacing="0" cellpadding="4">
3972   <tbody>
3973     <tr>
3974       <td>In0</td>
3975       <td>In1</td>
3976       <td>Out</td>
3977     </tr>
3978     <tr>
3979       <td>0</td>
3980       <td>0</td>
3981       <td>0</td>
3982     </tr>
3983     <tr>
3984       <td>0</td>
3985       <td>1</td>
3986       <td>1</td>
3987     </tr>
3988     <tr>
3989       <td>1</td>
3990       <td>0</td>
3991       <td>1</td>
3992     </tr>
3993     <tr>
3994       <td>1</td>
3995       <td>1</td>
3996       <td>0</td>
3997     </tr>
3998   </tbody>
3999 </table>
4000
4001 <h5>Example:</h5>
4002 <pre>
4003   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
4004   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
4005   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4006   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4007 </pre>
4008
4009 </div>
4010
4011 <!-- ======================================================================= -->
4012 <div class="doc_subsection">
4013   <a name="vectorops">Vector Operations</a>
4014 </div>
4015
4016 <div class="doc_text">
4017
4018 <p>LLVM supports several instructions to represent vector operations in a
4019    target-independent manner.  These instructions cover the element-access and
4020    vector-specific operations needed to process vectors effectively.  While LLVM
4021    does directly support these vector operations, many sophisticated algorithms
4022    will want to use target-specific intrinsics to take full advantage of a
4023    specific target.</p>
4024
4025 </div>
4026
4027 <!-- _______________________________________________________________________ -->
4028 <div class="doc_subsubsection">
4029    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4030 </div>
4031
4032 <div class="doc_text">
4033
4034 <h5>Syntax:</h5>
4035 <pre>
4036   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4037 </pre>
4038
4039 <h5>Overview:</h5>
4040 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4041    from a vector at a specified index.</p>
4042
4043
4044 <h5>Arguments:</h5>
4045 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4046    of <a href="#t_vector">vector</a> type.  The second operand is an index
4047    indicating the position from which to extract the element.  The index may be
4048    a variable.</p>
4049
4050 <h5>Semantics:</h5>
4051 <p>The result is a scalar of the same type as the element type of
4052    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4053    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4054    results are undefined.</p>
4055
4056 <h5>Example:</h5>
4057 <pre>
4058   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4059 </pre>
4060
4061 </div>
4062
4063 <!-- _______________________________________________________________________ -->
4064 <div class="doc_subsubsection">
4065    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4066 </div>
4067
4068 <div class="doc_text">
4069
4070 <h5>Syntax:</h5>
4071 <pre>
4072   &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>
4073 </pre>
4074
4075 <h5>Overview:</h5>
4076 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4077    vector at a specified index.</p>
4078
4079 <h5>Arguments:</h5>
4080 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4081    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4082    whose type must equal the element type of the first operand.  The third
4083    operand is an index indicating the position at which to insert the value.
4084    The index may be a variable.</p>
4085
4086 <h5>Semantics:</h5>
4087 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4088    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4089    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4090    results are undefined.</p>
4091
4092 <h5>Example:</h5>
4093 <pre>
4094   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4095 </pre>
4096
4097 </div>
4098
4099 <!-- _______________________________________________________________________ -->
4100 <div class="doc_subsubsection">
4101    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4102 </div>
4103
4104 <div class="doc_text">
4105
4106 <h5>Syntax:</h5>
4107 <pre>
4108   &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>
4109 </pre>
4110
4111 <h5>Overview:</h5>
4112 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4113    from two input vectors, returning a vector with the same element type as the
4114    input and length that is the same as the shuffle mask.</p>
4115
4116 <h5>Arguments:</h5>
4117 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4118    with types that match each other. The third argument is a shuffle mask whose
4119    element type is always 'i32'.  The result of the instruction is a vector
4120    whose length is the same as the shuffle mask and whose element type is the
4121    same as the element type of the first two operands.</p>
4122
4123 <p>The shuffle mask operand is required to be a constant vector with either
4124    constant integer or undef values.</p>
4125
4126 <h5>Semantics:</h5>
4127 <p>The elements of the two input vectors are numbered from left to right across
4128    both of the vectors.  The shuffle mask operand specifies, for each element of
4129    the result vector, which element of the two input vectors the result element
4130    gets.  The element selector may be undef (meaning "don't care") and the
4131    second operand may be undef if performing a shuffle from only one vector.</p>
4132
4133 <h5>Example:</h5>
4134 <pre>
4135   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4136                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4137   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4138                           &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.
4139   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4140                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4141   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4142                           &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>
4143 </pre>
4144
4145 </div>
4146
4147 <!-- ======================================================================= -->
4148 <div class="doc_subsection">
4149   <a name="aggregateops">Aggregate Operations</a>
4150 </div>
4151
4152 <div class="doc_text">
4153
4154 <p>LLVM supports several instructions for working with
4155   <a href="#t_aggregate">aggregate</a> values.</p>
4156
4157 </div>
4158
4159 <!-- _______________________________________________________________________ -->
4160 <div class="doc_subsubsection">
4161    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4162 </div>
4163
4164 <div class="doc_text">
4165
4166 <h5>Syntax:</h5>
4167 <pre>
4168   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4169 </pre>
4170
4171 <h5>Overview:</h5>
4172 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4173    from an <a href="#t_aggregate">aggregate</a> value.</p>
4174
4175 <h5>Arguments:</h5>
4176 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4177    of <a href="#t_struct">struct</a> or
4178    <a href="#t_array">array</a> type.  The operands are constant indices to
4179    specify which value to extract in a similar manner as indices in a
4180    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4181    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4182      <ul>
4183        <li>Since the value being indexed is not a pointer, the first index is
4184            omitted and assumed to be zero.</li>
4185        <li>At least one index must be specified.</li>
4186        <li>Not only struct indices but also array indices must be in
4187            bounds.</li>
4188      </ul>
4189
4190 <h5>Semantics:</h5>
4191 <p>The result is the value at the position in the aggregate specified by the
4192    index operands.</p>
4193
4194 <h5>Example:</h5>
4195 <pre>
4196   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4197 </pre>
4198
4199 </div>
4200
4201 <!-- _______________________________________________________________________ -->
4202 <div class="doc_subsubsection">
4203    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4204 </div>
4205
4206 <div class="doc_text">
4207
4208 <h5>Syntax:</h5>
4209 <pre>
4210   &lt;result&gt; = insertvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt;, &lt;idx&gt;    <i>; yields &lt;aggregate type&gt;</i>
4211 </pre>
4212
4213 <h5>Overview:</h5>
4214 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4215    in an <a href="#t_aggregate">aggregate</a> value.</p>
4216
4217 <h5>Arguments:</h5>
4218 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4219    of <a href="#t_struct">struct</a> or
4220    <a href="#t_array">array</a> type.  The second operand is a first-class
4221    value to insert.  The following operands are constant indices indicating
4222    the position at which to insert the value in a similar manner as indices in a
4223    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4224    value to insert must have the same type as the value identified by the
4225    indices.</p>
4226
4227 <h5>Semantics:</h5>
4228 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4229    that of <tt>val</tt> except that the value at the position specified by the
4230    indices is that of <tt>elt</tt>.</p>
4231
4232 <h5>Example:</h5>
4233 <pre>
4234   %agg1 = insertvalue {i32, float} undef, i32 1, 0         <i>; yields {i32 1, float undef}</i>
4235   %agg2 = insertvalue {i32, float} %agg1, float %val, 1    <i>; yields {i32 1, float %val}</i>
4236 </pre>
4237
4238 </div>
4239
4240
4241 <!-- ======================================================================= -->
4242 <div class="doc_subsection">
4243   <a name="memoryops">Memory Access and Addressing Operations</a>
4244 </div>
4245
4246 <div class="doc_text">
4247
4248 <p>A key design point of an SSA-based representation is how it represents
4249    memory.  In LLVM, no memory locations are in SSA form, which makes things
4250    very simple.  This section describes how to read, write, and allocate
4251    memory in LLVM.</p>
4252
4253 </div>
4254
4255 <!-- _______________________________________________________________________ -->
4256 <div class="doc_subsubsection">
4257   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4258 </div>
4259
4260 <div class="doc_text">
4261
4262 <h5>Syntax:</h5>
4263 <pre>
4264   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4265 </pre>
4266
4267 <h5>Overview:</h5>
4268 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4269    currently executing function, to be automatically released when this function
4270    returns to its caller. The object is always allocated in the generic address
4271    space (address space zero).</p>
4272
4273 <h5>Arguments:</h5>
4274 <p>The '<tt>alloca</tt>' instruction
4275    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4276    runtime stack, returning a pointer of the appropriate type to the program.
4277    If "NumElements" is specified, it is the number of elements allocated,
4278    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4279    specified, the value result of the allocation is guaranteed to be aligned to
4280    at least that boundary.  If not specified, or if zero, the target can choose
4281    to align the allocation on any convenient boundary compatible with the
4282    type.</p>
4283
4284 <p>'<tt>type</tt>' may be any sized type.</p>
4285
4286 <h5>Semantics:</h5>
4287 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4288    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4289    memory is automatically released when the function returns.  The
4290    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4291    variables that must have an address available.  When the function returns
4292    (either with the <tt><a href="#i_ret">ret</a></tt>
4293    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4294    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4295
4296 <h5>Example:</h5>
4297 <pre>
4298   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4299   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4300   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4301   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4302 </pre>
4303
4304 </div>
4305
4306 <!-- _______________________________________________________________________ -->
4307 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
4308 Instruction</a> </div>
4309
4310 <div class="doc_text">
4311
4312 <h5>Syntax:</h5>
4313 <pre>
4314   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4315   &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4316   !&lt;index&gt; = !{ i32 1 }
4317 </pre>
4318
4319 <h5>Overview:</h5>
4320 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4321
4322 <h5>Arguments:</h5>
4323 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4324    from which to load.  The pointer must point to
4325    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4326    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4327    number or order of execution of this <tt>load</tt> with other <a
4328    href="#volatile">volatile operations</a>.</p>
4329
4330 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4331    operation (that is, the alignment of the memory address). A value of 0 or an
4332    omitted <tt>align</tt> argument means that the operation has the preferential
4333    alignment for the target. It is the responsibility of the code emitter to
4334    ensure that the alignment information is correct. Overestimating the
4335    alignment results in undefined behavior. Underestimating the alignment may
4336    produce less efficient code. An alignment of 1 is always safe.</p>
4337
4338 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4339    metatadata name &lt;index&gt; corresponding to a metadata node with
4340    one <tt>i32</tt> entry of value 1.  The existence of
4341    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4342    and code generator that this load is not expected to be reused in the cache.
4343    The code generator may select special instructions to save cache bandwidth,
4344    such as the <tt>MOVNT</tt> instruction on x86.</p>
4345
4346 <h5>Semantics:</h5>
4347 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4348    scalar type then the number of bytes read does not exceed the minimum number
4349    of bytes needed to hold all bits of the type.  For example, loading an
4350    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4351    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4352    is undefined if the value was not originally written using a store of the
4353    same type.</p>
4354
4355 <h5>Examples:</h5>
4356 <pre>
4357   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4358   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4359   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4360 </pre>
4361
4362 </div>
4363
4364 <!-- _______________________________________________________________________ -->
4365 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
4366 Instruction</a> </div>
4367
4368 <div class="doc_text">
4369
4370 <h5>Syntax:</h5>
4371 <pre>
4372   store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]                   <i>; yields {void}</i>
4373   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]          <i>; yields {void}</i>
4374 </pre>
4375
4376 <h5>Overview:</h5>
4377 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4378
4379 <h5>Arguments:</h5>
4380 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4381    and an address at which to store it.  The type of the
4382    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4383    the <a href="#t_firstclass">first class</a> type of the
4384    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4385    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4386    order of execution of this <tt>store</tt> with other <a
4387    href="#volatile">volatile operations</a>.</p>
4388
4389 <p>The optional constant "align" argument specifies the alignment of the
4390    operation (that is, the alignment of the memory address). A value of 0 or an
4391    omitted "align" argument means that the operation has the preferential
4392    alignment for the target. It is the responsibility of the code emitter to
4393    ensure that the alignment information is correct. Overestimating the
4394    alignment results in an undefined behavior. Underestimating the alignment may
4395    produce less efficient code. An alignment of 1 is always safe.</p>
4396
4397 <p>The optional !nontemporal metadata must reference a single metatadata
4398    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4399    value 1.  The existence of the !nontemporal metatadata on the
4400    instruction tells the optimizer and code generator that this load is
4401    not expected to be reused in the cache.  The code generator may
4402    select special instructions to save cache bandwidth, such as the
4403    MOVNT instruction on x86.</p>
4404
4405
4406 <h5>Semantics:</h5>
4407 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4408    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4409    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4410    does not exceed the minimum number of bytes needed to hold all bits of the
4411    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4412    writing a value of a type like <tt>i20</tt> with a size that is not an
4413    integral number of bytes, it is unspecified what happens to the extra bits
4414    that do not belong to the type, but they will typically be overwritten.</p>
4415
4416 <h5>Example:</h5>
4417 <pre>
4418   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4419   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4420   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4421 </pre>
4422
4423 </div>
4424
4425 <!-- _______________________________________________________________________ -->
4426 <div class="doc_subsubsection">
4427    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4428 </div>
4429
4430 <div class="doc_text">
4431
4432 <h5>Syntax:</h5>
4433 <pre>
4434   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4435   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4436 </pre>
4437
4438 <h5>Overview:</h5>
4439 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4440    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4441    It performs address calculation only and does not access memory.</p>
4442
4443 <h5>Arguments:</h5>
4444 <p>The first argument is always a pointer, and forms the basis of the
4445    calculation. The remaining arguments are indices that indicate which of the
4446    elements of the aggregate object are indexed. The interpretation of each
4447    index is dependent on the type being indexed into. The first index always
4448    indexes the pointer value given as the first argument, the second index
4449    indexes a value of the type pointed to (not necessarily the value directly
4450    pointed to, since the first index can be non-zero), etc. The first type
4451    indexed into must be a pointer value, subsequent types can be arrays,
4452    vectors, and structs. Note that subsequent types being indexed into
4453    can never be pointers, since that would require loading the pointer before
4454    continuing calculation.</p>
4455
4456 <p>The type of each index argument depends on the type it is indexing into.
4457    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4458    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4459    or vector, integers of any width are allowed, and they are not required to be
4460    constant.</p>
4461
4462 <p>For example, let's consider a C code fragment and how it gets compiled to
4463    LLVM:</p>
4464
4465 <pre class="doc_code">
4466 struct RT {
4467   char A;
4468   int B[10][20];
4469   char C;
4470 };
4471 struct ST {
4472   int X;
4473   double Y;
4474   struct RT Z;
4475 };
4476
4477 int *foo(struct ST *s) {
4478   return &amp;s[1].Z.B[5][13];
4479 }
4480 </pre>
4481
4482 <p>The LLVM code generated by the GCC frontend is:</p>
4483
4484 <pre class="doc_code">
4485 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4486 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4487
4488 define i32* @foo(%ST* %s) {
4489 entry:
4490   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4491   ret i32* %reg
4492 }
4493 </pre>
4494
4495 <h5>Semantics:</h5>
4496 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4497    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4498    }</tt>' type, a structure.  The second index indexes into the third element
4499    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4500    i8 }</tt>' type, another structure.  The third index indexes into the second
4501    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4502    array.  The two dimensions of the array are subscripted into, yielding an
4503    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4504    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4505
4506 <p>Note that it is perfectly legal to index partially through a structure,
4507    returning a pointer to an inner element.  Because of this, the LLVM code for
4508    the given testcase is equivalent to:</p>
4509
4510 <pre>
4511   define i32* @foo(%ST* %s) {
4512     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
4513     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
4514     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
4515     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
4516     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
4517     ret i32* %t5
4518   }
4519 </pre>
4520
4521 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
4522    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
4523    base pointer is not an <i>in bounds</i> address of an allocated object,
4524    or if any of the addresses that would be formed by successive addition of
4525    the offsets implied by the indices to the base address with infinitely
4526    precise arithmetic are not an <i>in bounds</i> address of that allocated
4527    object. The <i>in bounds</i> addresses for an allocated object are all
4528    the addresses that point into the object, plus the address one byte past
4529    the end.</p>
4530
4531 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
4532    the base address with silently-wrapping two's complement arithmetic, and
4533    the result value of the <tt>getelementptr</tt> may be outside the object
4534    pointed to by the base pointer. The result value may not necessarily be
4535    used to access memory though, even if it happens to point into allocated
4536    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
4537    section for more information.</p>
4538
4539 <p>The getelementptr instruction is often confusing.  For some more insight into
4540    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
4541
4542 <h5>Example:</h5>
4543 <pre>
4544     <i>; yields [12 x i8]*:aptr</i>
4545     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
4546     <i>; yields i8*:vptr</i>
4547     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
4548     <i>; yields i8*:eptr</i>
4549     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
4550     <i>; yields i32*:iptr</i>
4551     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
4552 </pre>
4553
4554 </div>
4555
4556 <!-- ======================================================================= -->
4557 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
4558 </div>
4559
4560 <div class="doc_text">
4561
4562 <p>The instructions in this category are the conversion instructions (casting)
4563    which all take a single operand and a type. They perform various bit
4564    conversions on the operand.</p>
4565
4566 </div>
4567
4568 <!-- _______________________________________________________________________ -->
4569 <div class="doc_subsubsection">
4570    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
4571 </div>
4572 <div class="doc_text">
4573
4574 <h5>Syntax:</h5>
4575 <pre>
4576   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4577 </pre>
4578
4579 <h5>Overview:</h5>
4580 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
4581    type <tt>ty2</tt>.</p>
4582
4583 <h5>Arguments:</h5>
4584 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
4585    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4586    of the same number of integers.
4587    The bit size of the <tt>value</tt> must be larger than
4588    the bit size of the destination type, <tt>ty2</tt>.
4589    Equal sized types are not allowed.</p>
4590
4591 <h5>Semantics:</h5>
4592 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
4593    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
4594    source size must be larger than the destination size, <tt>trunc</tt> cannot
4595    be a <i>no-op cast</i>.  It will always truncate bits.</p>
4596
4597 <h5>Example:</h5>
4598 <pre>
4599   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
4600   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
4601   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
4602   %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>
4603 </pre>
4604
4605 </div>
4606
4607 <!-- _______________________________________________________________________ -->
4608 <div class="doc_subsubsection">
4609    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
4610 </div>
4611 <div class="doc_text">
4612
4613 <h5>Syntax:</h5>
4614 <pre>
4615   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4616 </pre>
4617
4618 <h5>Overview:</h5>
4619 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
4620    <tt>ty2</tt>.</p>
4621
4622
4623 <h5>Arguments:</h5>
4624 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
4625    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4626    of the same number of integers.
4627    The bit size of the <tt>value</tt> must be smaller than
4628    the bit size of the destination type,
4629    <tt>ty2</tt>.</p>
4630
4631 <h5>Semantics:</h5>
4632 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
4633    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
4634
4635 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
4636
4637 <h5>Example:</h5>
4638 <pre>
4639   %X = zext i32 257 to i64              <i>; yields i64:257</i>
4640   %Y = zext i1 true to i32              <i>; yields i32:1</i>
4641   %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>
4642 </pre>
4643
4644 </div>
4645
4646 <!-- _______________________________________________________________________ -->
4647 <div class="doc_subsubsection">
4648    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
4649 </div>
4650 <div class="doc_text">
4651
4652 <h5>Syntax:</h5>
4653 <pre>
4654   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4655 </pre>
4656
4657 <h5>Overview:</h5>
4658 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
4659
4660 <h5>Arguments:</h5>
4661 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
4662    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4663    of the same number of integers.
4664    The bit size of the <tt>value</tt> must be smaller than
4665    the bit size of the destination type,
4666    <tt>ty2</tt>.</p>
4667
4668 <h5>Semantics:</h5>
4669 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
4670    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
4671    of the type <tt>ty2</tt>.</p>
4672
4673 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
4674
4675 <h5>Example:</h5>
4676 <pre>
4677   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
4678   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
4679   %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>
4680 </pre>
4681
4682 </div>
4683
4684 <!-- _______________________________________________________________________ -->
4685 <div class="doc_subsubsection">
4686    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
4687 </div>
4688
4689 <div class="doc_text">
4690
4691 <h5>Syntax:</h5>
4692 <pre>
4693   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4694 </pre>
4695
4696 <h5>Overview:</h5>
4697 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
4698    <tt>ty2</tt>.</p>
4699
4700 <h5>Arguments:</h5>
4701 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
4702    point</a> value to cast and a <a href="#t_floating">floating point</a> type
4703    to cast it to. The size of <tt>value</tt> must be larger than the size of
4704    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
4705    <i>no-op cast</i>.</p>
4706
4707 <h5>Semantics:</h5>
4708 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
4709    <a href="#t_floating">floating point</a> type to a smaller
4710    <a href="#t_floating">floating point</a> type.  If the value cannot fit
4711    within the destination type, <tt>ty2</tt>, then the results are
4712    undefined.</p>
4713
4714 <h5>Example:</h5>
4715 <pre>
4716   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
4717   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
4718 </pre>
4719
4720 </div>
4721
4722 <!-- _______________________________________________________________________ -->
4723 <div class="doc_subsubsection">
4724    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
4725 </div>
4726 <div class="doc_text">
4727
4728 <h5>Syntax:</h5>
4729 <pre>
4730   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4731 </pre>
4732
4733 <h5>Overview:</h5>
4734 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
4735    floating point value.</p>
4736
4737 <h5>Arguments:</h5>
4738 <p>The '<tt>fpext</tt>' instruction takes a
4739    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
4740    a <a href="#t_floating">floating point</a> type to cast it to. The source
4741    type must be smaller than the destination type.</p>
4742
4743 <h5>Semantics:</h5>
4744 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
4745    <a href="#t_floating">floating point</a> type to a larger
4746    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
4747    used to make a <i>no-op cast</i> because it always changes bits. Use
4748    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
4749
4750 <h5>Example:</h5>
4751 <pre>
4752   %X = fpext float 3.1415 to double        <i>; yields double:3.1415</i>
4753   %Y = fpext float 1.0 to float            <i>; yields float:1.0 (no-op)</i>
4754 </pre>
4755
4756 </div>
4757
4758 <!-- _______________________________________________________________________ -->
4759 <div class="doc_subsubsection">
4760    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
4761 </div>
4762 <div class="doc_text">
4763
4764 <h5>Syntax:</h5>
4765 <pre>
4766   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4767 </pre>
4768
4769 <h5>Overview:</h5>
4770 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
4771    unsigned integer equivalent of type <tt>ty2</tt>.</p>
4772
4773 <h5>Arguments:</h5>
4774 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
4775    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4776    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4777    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4778    vector integer type with the same number of elements as <tt>ty</tt></p>
4779
4780 <h5>Semantics:</h5>
4781 <p>The '<tt>fptoui</tt>' instruction converts its
4782    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4783    towards zero) unsigned integer value. If the value cannot fit
4784    in <tt>ty2</tt>, the results are undefined.</p>
4785
4786 <h5>Example:</h5>
4787 <pre>
4788   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
4789   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
4790   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
4791 </pre>
4792
4793 </div>
4794
4795 <!-- _______________________________________________________________________ -->
4796 <div class="doc_subsubsection">
4797    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
4798 </div>
4799 <div class="doc_text">
4800
4801 <h5>Syntax:</h5>
4802 <pre>
4803   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4804 </pre>
4805
4806 <h5>Overview:</h5>
4807 <p>The '<tt>fptosi</tt>' instruction converts
4808    <a href="#t_floating">floating point</a> <tt>value</tt> to
4809    type <tt>ty2</tt>.</p>
4810
4811 <h5>Arguments:</h5>
4812 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
4813    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4814    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4815    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4816    vector integer type with the same number of elements as <tt>ty</tt></p>
4817
4818 <h5>Semantics:</h5>
4819 <p>The '<tt>fptosi</tt>' instruction converts its
4820    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4821    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
4822    the results are undefined.</p>
4823
4824 <h5>Example:</h5>
4825 <pre>
4826   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
4827   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
4828   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
4829 </pre>
4830
4831 </div>
4832
4833 <!-- _______________________________________________________________________ -->
4834 <div class="doc_subsubsection">
4835    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
4836 </div>
4837 <div class="doc_text">
4838
4839 <h5>Syntax:</h5>
4840 <pre>
4841   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4842 </pre>
4843
4844 <h5>Overview:</h5>
4845 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
4846    integer and converts that value to the <tt>ty2</tt> type.</p>
4847
4848 <h5>Arguments:</h5>
4849 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
4850    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4851    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4852    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4853    floating point type with the same number of elements as <tt>ty</tt></p>
4854
4855 <h5>Semantics:</h5>
4856 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
4857    integer quantity and converts it to the corresponding floating point
4858    value. If the value cannot fit in the floating point value, the results are
4859    undefined.</p>
4860
4861 <h5>Example:</h5>
4862 <pre>
4863   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
4864   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
4865 </pre>
4866
4867 </div>
4868
4869 <!-- _______________________________________________________________________ -->
4870 <div class="doc_subsubsection">
4871    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
4872 </div>
4873 <div class="doc_text">
4874
4875 <h5>Syntax:</h5>
4876 <pre>
4877   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4878 </pre>
4879
4880 <h5>Overview:</h5>
4881 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
4882    and converts that value to the <tt>ty2</tt> type.</p>
4883
4884 <h5>Arguments:</h5>
4885 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
4886    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4887    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4888    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4889    floating point type with the same number of elements as <tt>ty</tt></p>
4890
4891 <h5>Semantics:</h5>
4892 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
4893    quantity and converts it to the corresponding floating point value. If the
4894    value cannot fit in the floating point value, the results are undefined.</p>
4895
4896 <h5>Example:</h5>
4897 <pre>
4898   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
4899   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
4900 </pre>
4901
4902 </div>
4903
4904 <!-- _______________________________________________________________________ -->
4905 <div class="doc_subsubsection">
4906    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
4907 </div>
4908 <div class="doc_text">
4909
4910 <h5>Syntax:</h5>
4911 <pre>
4912   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4913 </pre>
4914
4915 <h5>Overview:</h5>
4916 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
4917    the integer type <tt>ty2</tt>.</p>
4918
4919 <h5>Arguments:</h5>
4920 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
4921    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
4922    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
4923
4924 <h5>Semantics:</h5>
4925 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
4926    <tt>ty2</tt> by interpreting the pointer value as an integer and either
4927    truncating or zero extending that value to the size of the integer type. If
4928    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
4929    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
4930    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
4931    change.</p>
4932
4933 <h5>Example:</h5>
4934 <pre>
4935   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
4936   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
4937 </pre>
4938
4939 </div>
4940
4941 <!-- _______________________________________________________________________ -->
4942 <div class="doc_subsubsection">
4943    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
4944 </div>
4945 <div class="doc_text">
4946
4947 <h5>Syntax:</h5>
4948 <pre>
4949   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4950 </pre>
4951
4952 <h5>Overview:</h5>
4953 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
4954    pointer type, <tt>ty2</tt>.</p>
4955
4956 <h5>Arguments:</h5>
4957 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
4958    value to cast, and a type to cast it to, which must be a
4959    <a href="#t_pointer">pointer</a> type.</p>
4960
4961 <h5>Semantics:</h5>
4962 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
4963    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
4964    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
4965    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
4966    than the size of a pointer then a zero extension is done. If they are the
4967    same size, nothing is done (<i>no-op cast</i>).</p>
4968
4969 <h5>Example:</h5>
4970 <pre>
4971   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
4972   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
4973   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
4974 </pre>
4975
4976 </div>
4977
4978 <!-- _______________________________________________________________________ -->
4979 <div class="doc_subsubsection">
4980    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
4981 </div>
4982 <div class="doc_text">
4983
4984 <h5>Syntax:</h5>
4985 <pre>
4986   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4987 </pre>
4988
4989 <h5>Overview:</h5>
4990 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4991    <tt>ty2</tt> without changing any bits.</p>
4992
4993 <h5>Arguments:</h5>
4994 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
4995    non-aggregate first class value, and a type to cast it to, which must also be
4996    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
4997    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
4998    identical. If the source type is a pointer, the destination type must also be
4999    a pointer.  This instruction supports bitwise conversion of vectors to
5000    integers and to vectors of other types (as long as they have the same
5001    size).</p>
5002
5003 <h5>Semantics:</h5>
5004 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
5005    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5006    this conversion.  The conversion is done as if the <tt>value</tt> had been
5007    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5008    be converted to other pointer types with this instruction. To convert
5009    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5010    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5011
5012 <h5>Example:</h5>
5013 <pre>
5014   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5015   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5016   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5017 </pre>
5018
5019 </div>
5020
5021 <!-- ======================================================================= -->
5022 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
5023
5024 <div class="doc_text">
5025
5026 <p>The instructions in this category are the "miscellaneous" instructions, which
5027    defy better classification.</p>
5028
5029 </div>
5030
5031 <!-- _______________________________________________________________________ -->
5032 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5033 </div>
5034
5035 <div class="doc_text">
5036
5037 <h5>Syntax:</h5>
5038 <pre>
5039   &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>
5040 </pre>
5041
5042 <h5>Overview:</h5>
5043 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5044    boolean values based on comparison of its two integer, integer vector, or
5045    pointer operands.</p>
5046
5047 <h5>Arguments:</h5>
5048 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5049    the condition code indicating the kind of comparison to perform. It is not a
5050    value, just a keyword. The possible condition code are:</p>
5051
5052 <ol>
5053   <li><tt>eq</tt>: equal</li>
5054   <li><tt>ne</tt>: not equal </li>
5055   <li><tt>ugt</tt>: unsigned greater than</li>
5056   <li><tt>uge</tt>: unsigned greater or equal</li>
5057   <li><tt>ult</tt>: unsigned less than</li>
5058   <li><tt>ule</tt>: unsigned less or equal</li>
5059   <li><tt>sgt</tt>: signed greater than</li>
5060   <li><tt>sge</tt>: signed greater or equal</li>
5061   <li><tt>slt</tt>: signed less than</li>
5062   <li><tt>sle</tt>: signed less or equal</li>
5063 </ol>
5064
5065 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5066    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5067    typed.  They must also be identical types.</p>
5068
5069 <h5>Semantics:</h5>
5070 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5071    condition code given as <tt>cond</tt>. The comparison performed always yields
5072    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5073    result, as follows:</p>
5074
5075 <ol>
5076   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5077       <tt>false</tt> otherwise. No sign interpretation is necessary or
5078       performed.</li>
5079
5080   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5081       <tt>false</tt> otherwise. No sign interpretation is necessary or
5082       performed.</li>
5083
5084   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5085       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5086
5087   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5088       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5089       to <tt>op2</tt>.</li>
5090
5091   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5092       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5093
5094   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5095       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5096
5097   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5098       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5099
5100   <li><tt>sge</tt>: interprets the operands as signed values and yields
5101       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5102       to <tt>op2</tt>.</li>
5103
5104   <li><tt>slt</tt>: interprets the operands as signed values and yields
5105       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5106
5107   <li><tt>sle</tt>: interprets the operands as signed values and yields
5108       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5109 </ol>
5110
5111 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5112    values are compared as if they were integers.</p>
5113
5114 <p>If the operands are integer vectors, then they are compared element by
5115    element. The result is an <tt>i1</tt> vector with the same number of elements
5116    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5117
5118 <h5>Example:</h5>
5119 <pre>
5120   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5121   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5122   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5123   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5124   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5125   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5126 </pre>
5127
5128 <p>Note that the code generator does not yet support vector types with
5129    the <tt>icmp</tt> instruction.</p>
5130
5131 </div>
5132
5133 <!-- _______________________________________________________________________ -->
5134 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5135 </div>
5136
5137 <div class="doc_text">
5138
5139 <h5>Syntax:</h5>
5140 <pre>
5141   &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>
5142 </pre>
5143
5144 <h5>Overview:</h5>
5145 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5146    values based on comparison of its operands.</p>
5147
5148 <p>If the operands are floating point scalars, then the result type is a boolean
5149 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5150
5151 <p>If the operands are floating point vectors, then the result type is a vector
5152    of boolean with the same number of elements as the operands being
5153    compared.</p>
5154
5155 <h5>Arguments:</h5>
5156 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5157    the condition code indicating the kind of comparison to perform. It is not a
5158    value, just a keyword. The possible condition code are:</p>
5159
5160 <ol>
5161   <li><tt>false</tt>: no comparison, always returns false</li>
5162   <li><tt>oeq</tt>: ordered and equal</li>
5163   <li><tt>ogt</tt>: ordered and greater than </li>
5164   <li><tt>oge</tt>: ordered and greater than or equal</li>
5165   <li><tt>olt</tt>: ordered and less than </li>
5166   <li><tt>ole</tt>: ordered and less than or equal</li>
5167   <li><tt>one</tt>: ordered and not equal</li>
5168   <li><tt>ord</tt>: ordered (no nans)</li>
5169   <li><tt>ueq</tt>: unordered or equal</li>
5170   <li><tt>ugt</tt>: unordered or greater than </li>
5171   <li><tt>uge</tt>: unordered or greater than or equal</li>
5172   <li><tt>ult</tt>: unordered or less than </li>
5173   <li><tt>ule</tt>: unordered or less than or equal</li>
5174   <li><tt>une</tt>: unordered or not equal</li>
5175   <li><tt>uno</tt>: unordered (either nans)</li>
5176   <li><tt>true</tt>: no comparison, always returns true</li>
5177 </ol>
5178
5179 <p><i>Ordered</i> means that neither operand is a QNAN while
5180    <i>unordered</i> means that either operand may be a QNAN.</p>
5181
5182 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5183    a <a href="#t_floating">floating point</a> type or
5184    a <a href="#t_vector">vector</a> of floating point type.  They must have
5185    identical types.</p>
5186
5187 <h5>Semantics:</h5>
5188 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5189    according to the condition code given as <tt>cond</tt>.  If the operands are
5190    vectors, then the vectors are compared element by element.  Each comparison
5191    performed always yields an <a href="#t_integer">i1</a> result, as
5192    follows:</p>
5193
5194 <ol>
5195   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5196
5197   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5198       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5199
5200   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5201       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5202
5203   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5204       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5205
5206   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5207       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5208
5209   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5210       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5211
5212   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5213       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5214
5215   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5216
5217   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5218       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5219
5220   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5221       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5222
5223   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5224       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5225
5226   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5227       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5228
5229   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5230       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5231
5232   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5233       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5234
5235   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5236
5237   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5238 </ol>
5239
5240 <h5>Example:</h5>
5241 <pre>
5242   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5243   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5244   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5245   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5246 </pre>
5247
5248 <p>Note that the code generator does not yet support vector types with
5249    the <tt>fcmp</tt> instruction.</p>
5250
5251 </div>
5252
5253 <!-- _______________________________________________________________________ -->
5254 <div class="doc_subsubsection">
5255   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5256 </div>
5257
5258 <div class="doc_text">
5259
5260 <h5>Syntax:</h5>
5261 <pre>
5262   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5263 </pre>
5264
5265 <h5>Overview:</h5>
5266 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5267    SSA graph representing the function.</p>
5268
5269 <h5>Arguments:</h5>
5270 <p>The type of the incoming values is specified with the first type field. After
5271    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5272    one pair for each predecessor basic block of the current block.  Only values
5273    of <a href="#t_firstclass">first class</a> type may be used as the value
5274    arguments to the PHI node.  Only labels may be used as the label
5275    arguments.</p>
5276
5277 <p>There must be no non-phi instructions between the start of a basic block and
5278    the PHI instructions: i.e. PHI instructions must be first in a basic
5279    block.</p>
5280
5281 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5282    occur on the edge from the corresponding predecessor block to the current
5283    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5284    value on the same edge).</p>
5285
5286 <h5>Semantics:</h5>
5287 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5288    specified by the pair corresponding to the predecessor basic block that
5289    executed just prior to the current block.</p>
5290
5291 <h5>Example:</h5>
5292 <pre>
5293 Loop:       ; Infinite loop that counts from 0 on up...
5294   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5295   %nextindvar = add i32 %indvar, 1
5296   br label %Loop
5297 </pre>
5298
5299 </div>
5300
5301 <!-- _______________________________________________________________________ -->
5302 <div class="doc_subsubsection">
5303    <a name="i_select">'<tt>select</tt>' Instruction</a>
5304 </div>
5305
5306 <div class="doc_text">
5307
5308 <h5>Syntax:</h5>
5309 <pre>
5310   &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>
5311
5312   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5313 </pre>
5314
5315 <h5>Overview:</h5>
5316 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5317    condition, without branching.</p>
5318
5319
5320 <h5>Arguments:</h5>
5321 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5322    values indicating the condition, and two values of the
5323    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5324    vectors and the condition is a scalar, then entire vectors are selected, not
5325    individual elements.</p>
5326
5327 <h5>Semantics:</h5>
5328 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5329    first value argument; otherwise, it returns the second value argument.</p>
5330
5331 <p>If the condition is a vector of i1, then the value arguments must be vectors
5332    of the same size, and the selection is done element by element.</p>
5333
5334 <h5>Example:</h5>
5335 <pre>
5336   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5337 </pre>
5338
5339 <p>Note that the code generator does not yet support conditions
5340    with vector type.</p>
5341
5342 </div>
5343
5344 <!-- _______________________________________________________________________ -->
5345 <div class="doc_subsubsection">
5346   <a name="i_call">'<tt>call</tt>' Instruction</a>
5347 </div>
5348
5349 <div class="doc_text">
5350
5351 <h5>Syntax:</h5>
5352 <pre>
5353   &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>]
5354 </pre>
5355
5356 <h5>Overview:</h5>
5357 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5358
5359 <h5>Arguments:</h5>
5360 <p>This instruction requires several arguments:</p>
5361
5362 <ol>
5363   <li>The optional "tail" marker indicates that the callee function does not
5364       access any allocas or varargs in the caller.  Note that calls may be
5365       marked "tail" even if they do not occur before
5366       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5367       present, the function call is eligible for tail call optimization,
5368       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5369       optimized into a jump</a>.  The code generator may optimize calls marked
5370       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5371       sibling call optimization</a> when the caller and callee have
5372       matching signatures, or 2) forced tail call optimization when the
5373       following extra requirements are met:
5374       <ul>
5375         <li>Caller and callee both have the calling
5376             convention <tt>fastcc</tt>.</li>
5377         <li>The call is in tail position (ret immediately follows call and ret
5378             uses value of call or is void).</li>
5379         <li>Option <tt>-tailcallopt</tt> is enabled,
5380             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5381         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5382             constraints are met.</a></li>
5383       </ul>
5384   </li>
5385
5386   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5387       convention</a> the call should use.  If none is specified, the call
5388       defaults to using C calling conventions.  The calling convention of the
5389       call must match the calling convention of the target function, or else the
5390       behavior is undefined.</li>
5391
5392   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5393       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5394       '<tt>inreg</tt>' attributes are valid here.</li>
5395
5396   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5397       type of the return value.  Functions that return no value are marked
5398       <tt><a href="#t_void">void</a></tt>.</li>
5399
5400   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5401       being invoked.  The argument types must match the types implied by this
5402       signature.  This type can be omitted if the function is not varargs and if
5403       the function type does not return a pointer to a function.</li>
5404
5405   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5406       be invoked. In most cases, this is a direct function invocation, but
5407       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5408       to function value.</li>
5409
5410   <li>'<tt>function args</tt>': argument list whose types match the function
5411       signature argument types and parameter attributes. All arguments must be
5412       of <a href="#t_firstclass">first class</a> type. If the function
5413       signature indicates the function accepts a variable number of arguments,
5414       the extra arguments can be specified.</li>
5415
5416   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5417       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5418       '<tt>readnone</tt>' attributes are valid here.</li>
5419 </ol>
5420
5421 <h5>Semantics:</h5>
5422 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5423    a specified function, with its incoming arguments bound to the specified
5424    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5425    function, control flow continues with the instruction after the function
5426    call, and the return value of the function is bound to the result
5427    argument.</p>
5428
5429 <h5>Example:</h5>
5430 <pre>
5431   %retval = call i32 @test(i32 %argc)
5432   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5433   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5434   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5435   call void %foo(i8 97 signext)
5436
5437   %struct.A = type { i32, i8 }
5438   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5439   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5440   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5441   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5442   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5443 </pre>
5444
5445 <p>llvm treats calls to some functions with names and arguments that match the
5446 standard C99 library as being the C99 library functions, and may perform
5447 optimizations or generate code for them under that assumption.  This is
5448 something we'd like to change in the future to provide better support for
5449 freestanding environments and non-C-based languages.</p>
5450
5451 </div>
5452
5453 <!-- _______________________________________________________________________ -->
5454 <div class="doc_subsubsection">
5455   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5456 </div>
5457
5458 <div class="doc_text">
5459
5460 <h5>Syntax:</h5>
5461 <pre>
5462   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5463 </pre>
5464
5465 <h5>Overview:</h5>
5466 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5467    the "variable argument" area of a function call.  It is used to implement the
5468    <tt>va_arg</tt> macro in C.</p>
5469
5470 <h5>Arguments:</h5>
5471 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5472    argument. It returns a value of the specified argument type and increments
5473    the <tt>va_list</tt> to point to the next argument.  The actual type
5474    of <tt>va_list</tt> is target specific.</p>
5475
5476 <h5>Semantics:</h5>
5477 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5478    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5479    to the next argument.  For more information, see the variable argument
5480    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5481
5482 <p>It is legal for this instruction to be called in a function which does not
5483    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5484    function.</p>
5485
5486 <p><tt>va_arg</tt> is an LLVM instruction instead of
5487    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5488    argument.</p>
5489
5490 <h5>Example:</h5>
5491 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
5492
5493 <p>Note that the code generator does not yet fully support va_arg on many
5494    targets. Also, it does not currently support va_arg with aggregate types on
5495    any target.</p>
5496
5497 </div>
5498
5499 <!-- *********************************************************************** -->
5500 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
5501 <!-- *********************************************************************** -->
5502
5503 <div class="doc_text">
5504
5505 <p>LLVM supports the notion of an "intrinsic function".  These functions have
5506    well known names and semantics and are required to follow certain
5507    restrictions.  Overall, these intrinsics represent an extension mechanism for
5508    the LLVM language that does not require changing all of the transformations
5509    in LLVM when adding to the language (or the bitcode reader/writer, the
5510    parser, etc...).</p>
5511
5512 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
5513    prefix is reserved in LLVM for intrinsic names; thus, function names may not
5514    begin with this prefix.  Intrinsic functions must always be external
5515    functions: you cannot define the body of intrinsic functions.  Intrinsic
5516    functions may only be used in call or invoke instructions: it is illegal to
5517    take the address of an intrinsic function.  Additionally, because intrinsic
5518    functions are part of the LLVM language, it is required if any are added that
5519    they be documented here.</p>
5520
5521 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
5522    family of functions that perform the same operation but on different data
5523    types. Because LLVM can represent over 8 million different integer types,
5524    overloading is used commonly to allow an intrinsic function to operate on any
5525    integer type. One or more of the argument types or the result type can be
5526    overloaded to accept any integer type. Argument types may also be defined as
5527    exactly matching a previous argument's type or the result type. This allows
5528    an intrinsic function which accepts multiple arguments, but needs all of them
5529    to be of the same type, to only be overloaded with respect to a single
5530    argument or the result.</p>
5531
5532 <p>Overloaded intrinsics will have the names of its overloaded argument types
5533    encoded into its function name, each preceded by a period. Only those types
5534    which are overloaded result in a name suffix. Arguments whose type is matched
5535    against another type do not. For example, the <tt>llvm.ctpop</tt> function
5536    can take an integer of any width and returns an integer of exactly the same
5537    integer width. This leads to a family of functions such as
5538    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
5539    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
5540    suffix is required. Because the argument's type is matched against the return
5541    type, it does not require its own name suffix.</p>
5542
5543 <p>To learn how to add an intrinsic function, please see the
5544    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
5545
5546 </div>
5547
5548 <!-- ======================================================================= -->
5549 <div class="doc_subsection">
5550   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
5551 </div>
5552
5553 <div class="doc_text">
5554
5555 <p>Variable argument support is defined in LLVM with
5556    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
5557    intrinsic functions.  These functions are related to the similarly named
5558    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
5559
5560 <p>All of these functions operate on arguments that use a target-specific value
5561    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
5562    not define what this type is, so all transformations should be prepared to
5563    handle these functions regardless of the type used.</p>
5564
5565 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
5566    instruction and the variable argument handling intrinsic functions are
5567    used.</p>
5568
5569 <pre class="doc_code">
5570 define i32 @test(i32 %X, ...) {
5571   ; Initialize variable argument processing
5572   %ap = alloca i8*
5573   %ap2 = bitcast i8** %ap to i8*
5574   call void @llvm.va_start(i8* %ap2)
5575
5576   ; Read a single integer argument
5577   %tmp = va_arg i8** %ap, i32
5578
5579   ; Demonstrate usage of llvm.va_copy and llvm.va_end
5580   %aq = alloca i8*
5581   %aq2 = bitcast i8** %aq to i8*
5582   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
5583   call void @llvm.va_end(i8* %aq2)
5584
5585   ; Stop processing of arguments.
5586   call void @llvm.va_end(i8* %ap2)
5587   ret i32 %tmp
5588 }
5589
5590 declare void @llvm.va_start(i8*)
5591 declare void @llvm.va_copy(i8*, i8*)
5592 declare void @llvm.va_end(i8*)
5593 </pre>
5594
5595 </div>
5596
5597 <!-- _______________________________________________________________________ -->
5598 <div class="doc_subsubsection">
5599   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
5600 </div>
5601
5602
5603 <div class="doc_text">
5604
5605 <h5>Syntax:</h5>
5606 <pre>
5607   declare void %llvm.va_start(i8* &lt;arglist&gt;)
5608 </pre>
5609
5610 <h5>Overview:</h5>
5611 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
5612    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
5613
5614 <h5>Arguments:</h5>
5615 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
5616
5617 <h5>Semantics:</h5>
5618 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
5619    macro available in C.  In a target-dependent way, it initializes
5620    the <tt>va_list</tt> element to which the argument points, so that the next
5621    call to <tt>va_arg</tt> will produce the first variable argument passed to
5622    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
5623    need to know the last argument of the function as the compiler can figure
5624    that out.</p>
5625
5626 </div>
5627
5628 <!-- _______________________________________________________________________ -->
5629 <div class="doc_subsubsection">
5630  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
5631 </div>
5632
5633 <div class="doc_text">
5634
5635 <h5>Syntax:</h5>
5636 <pre>
5637   declare void @llvm.va_end(i8* &lt;arglist&gt;)
5638 </pre>
5639
5640 <h5>Overview:</h5>
5641 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
5642    which has been initialized previously
5643    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
5644    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
5645
5646 <h5>Arguments:</h5>
5647 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
5648
5649 <h5>Semantics:</h5>
5650 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
5651    macro available in C.  In a target-dependent way, it destroys
5652    the <tt>va_list</tt> element to which the argument points.  Calls
5653    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
5654    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
5655    with calls to <tt>llvm.va_end</tt>.</p>
5656
5657 </div>
5658
5659 <!-- _______________________________________________________________________ -->
5660 <div class="doc_subsubsection">
5661   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
5662 </div>
5663
5664 <div class="doc_text">
5665
5666 <h5>Syntax:</h5>
5667 <pre>
5668   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
5669 </pre>
5670
5671 <h5>Overview:</h5>
5672 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
5673    from the source argument list to the destination argument list.</p>
5674
5675 <h5>Arguments:</h5>
5676 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
5677    The second argument is a pointer to a <tt>va_list</tt> element to copy
5678    from.</p>
5679
5680 <h5>Semantics:</h5>
5681 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
5682    macro available in C.  In a target-dependent way, it copies the
5683    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
5684    element.  This intrinsic is necessary because
5685    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
5686    arbitrarily complex and require, for example, memory allocation.</p>
5687
5688 </div>
5689
5690 <!-- ======================================================================= -->
5691 <div class="doc_subsection">
5692   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
5693 </div>
5694
5695 <div class="doc_text">
5696
5697 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
5698 Collection</a> (GC) requires the implementation and generation of these
5699 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
5700 roots on the stack</a>, as well as garbage collector implementations that
5701 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
5702 barriers.  Front-ends for type-safe garbage collected languages should generate
5703 these intrinsics to make use of the LLVM garbage collectors.  For more details,
5704 see <a href="GarbageCollection.html">Accurate Garbage Collection with
5705 LLVM</a>.</p>
5706
5707 <p>The garbage collection intrinsics only operate on objects in the generic
5708    address space (address space zero).</p>
5709
5710 </div>
5711
5712 <!-- _______________________________________________________________________ -->
5713 <div class="doc_subsubsection">
5714   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
5715 </div>
5716
5717 <div class="doc_text">
5718
5719 <h5>Syntax:</h5>
5720 <pre>
5721   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
5722 </pre>
5723
5724 <h5>Overview:</h5>
5725 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
5726    the code generator, and allows some metadata to be associated with it.</p>
5727
5728 <h5>Arguments:</h5>
5729 <p>The first argument specifies the address of a stack object that contains the
5730    root pointer.  The second pointer (which must be either a constant or a
5731    global value address) contains the meta-data to be associated with the
5732    root.</p>
5733
5734 <h5>Semantics:</h5>
5735 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
5736    location.  At compile-time, the code generator generates information to allow
5737    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
5738    intrinsic may only be used in a function which <a href="#gc">specifies a GC
5739    algorithm</a>.</p>
5740
5741 </div>
5742
5743 <!-- _______________________________________________________________________ -->
5744 <div class="doc_subsubsection">
5745   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
5746 </div>
5747
5748 <div class="doc_text">
5749
5750 <h5>Syntax:</h5>
5751 <pre>
5752   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
5753 </pre>
5754
5755 <h5>Overview:</h5>
5756 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
5757    locations, allowing garbage collector implementations that require read
5758    barriers.</p>
5759
5760 <h5>Arguments:</h5>
5761 <p>The second argument is the address to read from, which should be an address
5762    allocated from the garbage collector.  The first object is a pointer to the
5763    start of the referenced object, if needed by the language runtime (otherwise
5764    null).</p>
5765
5766 <h5>Semantics:</h5>
5767 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
5768    instruction, but may be replaced with substantially more complex code by the
5769    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
5770    may only be used in a function which <a href="#gc">specifies a GC
5771    algorithm</a>.</p>
5772
5773 </div>
5774
5775 <!-- _______________________________________________________________________ -->
5776 <div class="doc_subsubsection">
5777   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
5778 </div>
5779
5780 <div class="doc_text">
5781
5782 <h5>Syntax:</h5>
5783 <pre>
5784   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
5785 </pre>
5786
5787 <h5>Overview:</h5>
5788 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
5789    locations, allowing garbage collector implementations that require write
5790    barriers (such as generational or reference counting collectors).</p>
5791
5792 <h5>Arguments:</h5>
5793 <p>The first argument is the reference to store, the second is the start of the
5794    object to store it to, and the third is the address of the field of Obj to
5795    store to.  If the runtime does not require a pointer to the object, Obj may
5796    be null.</p>
5797
5798 <h5>Semantics:</h5>
5799 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
5800    instruction, but may be replaced with substantially more complex code by the
5801    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
5802    may only be used in a function which <a href="#gc">specifies a GC
5803    algorithm</a>.</p>
5804
5805 </div>
5806
5807 <!-- ======================================================================= -->
5808 <div class="doc_subsection">
5809   <a name="int_codegen">Code Generator Intrinsics</a>
5810 </div>
5811
5812 <div class="doc_text">
5813
5814 <p>These intrinsics are provided by LLVM to expose special features that may
5815    only be implemented with code generator support.</p>
5816
5817 </div>
5818
5819 <!-- _______________________________________________________________________ -->
5820 <div class="doc_subsubsection">
5821   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
5822 </div>
5823
5824 <div class="doc_text">
5825
5826 <h5>Syntax:</h5>
5827 <pre>
5828   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
5829 </pre>
5830
5831 <h5>Overview:</h5>
5832 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
5833    target-specific value indicating the return address of the current function
5834    or one of its callers.</p>
5835
5836 <h5>Arguments:</h5>
5837 <p>The argument to this intrinsic indicates which function to return the address
5838    for.  Zero indicates the calling function, one indicates its caller, etc.
5839    The argument is <b>required</b> to be a constant integer value.</p>
5840
5841 <h5>Semantics:</h5>
5842 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
5843    indicating the return address of the specified call frame, or zero if it
5844    cannot be identified.  The value returned by this intrinsic is likely to be
5845    incorrect or 0 for arguments other than zero, so it should only be used for
5846    debugging purposes.</p>
5847
5848 <p>Note that calling this intrinsic does not prevent function inlining or other
5849    aggressive transformations, so the value returned may not be that of the
5850    obvious source-language caller.</p>
5851
5852 </div>
5853
5854 <!-- _______________________________________________________________________ -->
5855 <div class="doc_subsubsection">
5856   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
5857 </div>
5858
5859 <div class="doc_text">
5860
5861 <h5>Syntax:</h5>
5862 <pre>
5863   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
5864 </pre>
5865
5866 <h5>Overview:</h5>
5867 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
5868    target-specific frame pointer value for the specified stack frame.</p>
5869
5870 <h5>Arguments:</h5>
5871 <p>The argument to this intrinsic indicates which function to return the frame
5872    pointer for.  Zero indicates the calling function, one indicates its caller,
5873    etc.  The argument is <b>required</b> to be a constant integer value.</p>
5874
5875 <h5>Semantics:</h5>
5876 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
5877    indicating the frame address of the specified call frame, or zero if it
5878    cannot be identified.  The value returned by this intrinsic is likely to be
5879    incorrect or 0 for arguments other than zero, so it should only be used for
5880    debugging purposes.</p>
5881
5882 <p>Note that calling this intrinsic does not prevent function inlining or other
5883    aggressive transformations, so the value returned may not be that of the
5884    obvious source-language caller.</p>
5885
5886 </div>
5887
5888 <!-- _______________________________________________________________________ -->
5889 <div class="doc_subsubsection">
5890   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
5891 </div>
5892
5893 <div class="doc_text">
5894
5895 <h5>Syntax:</h5>
5896 <pre>
5897   declare i8* @llvm.stacksave()
5898 </pre>
5899
5900 <h5>Overview:</h5>
5901 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
5902    of the function stack, for use
5903    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
5904    useful for implementing language features like scoped automatic variable
5905    sized arrays in C99.</p>
5906
5907 <h5>Semantics:</h5>
5908 <p>This intrinsic returns a opaque pointer value that can be passed
5909    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
5910    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
5911    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
5912    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
5913    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
5914    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
5915
5916 </div>
5917
5918 <!-- _______________________________________________________________________ -->
5919 <div class="doc_subsubsection">
5920   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
5921 </div>
5922
5923 <div class="doc_text">
5924
5925 <h5>Syntax:</h5>
5926 <pre>
5927   declare void @llvm.stackrestore(i8* %ptr)
5928 </pre>
5929
5930 <h5>Overview:</h5>
5931 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
5932    the function stack to the state it was in when the
5933    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
5934    executed.  This is useful for implementing language features like scoped
5935    automatic variable sized arrays in C99.</p>
5936
5937 <h5>Semantics:</h5>
5938 <p>See the description
5939    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
5940
5941 </div>
5942
5943 <!-- _______________________________________________________________________ -->
5944 <div class="doc_subsubsection">
5945   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
5946 </div>
5947
5948 <div class="doc_text">
5949
5950 <h5>Syntax:</h5>
5951 <pre>
5952   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;)
5953 </pre>
5954
5955 <h5>Overview:</h5>
5956 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
5957    insert a prefetch instruction if supported; otherwise, it is a noop.
5958    Prefetches have no effect on the behavior of the program but can change its
5959    performance characteristics.</p>
5960
5961 <h5>Arguments:</h5>
5962 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
5963    specifier determining if the fetch should be for a read (0) or write (1),
5964    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
5965    locality, to (3) - extremely local keep in cache.  The <tt>rw</tt>
5966    and <tt>locality</tt> arguments must be constant integers.</p>
5967
5968 <h5>Semantics:</h5>
5969 <p>This intrinsic does not modify the behavior of the program.  In particular,
5970    prefetches cannot trap and do not produce a value.  On targets that support
5971    this intrinsic, the prefetch can provide hints to the processor cache for
5972    better performance.</p>
5973
5974 </div>
5975
5976 <!-- _______________________________________________________________________ -->
5977 <div class="doc_subsubsection">
5978   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
5979 </div>
5980
5981 <div class="doc_text">
5982
5983 <h5>Syntax:</h5>
5984 <pre>
5985   declare void @llvm.pcmarker(i32 &lt;id&gt;)
5986 </pre>
5987
5988 <h5>Overview:</h5>
5989 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
5990    Counter (PC) in a region of code to simulators and other tools.  The method
5991    is target specific, but it is expected that the marker will use exported
5992    symbols to transmit the PC of the marker.  The marker makes no guarantees
5993    that it will remain with any specific instruction after optimizations.  It is
5994    possible that the presence of a marker will inhibit optimizations.  The
5995    intended use is to be inserted after optimizations to allow correlations of
5996    simulation runs.</p>
5997
5998 <h5>Arguments:</h5>
5999 <p><tt>id</tt> is a numerical id identifying the marker.</p>
6000
6001 <h5>Semantics:</h5>
6002 <p>This intrinsic does not modify the behavior of the program.  Backends that do
6003    not support this intrinsic may ignore it.</p>
6004
6005 </div>
6006
6007 <!-- _______________________________________________________________________ -->
6008 <div class="doc_subsubsection">
6009   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6010 </div>
6011
6012 <div class="doc_text">
6013
6014 <h5>Syntax:</h5>
6015 <pre>
6016   declare i64 @llvm.readcyclecounter()
6017 </pre>
6018
6019 <h5>Overview:</h5>
6020 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6021    counter register (or similar low latency, high accuracy clocks) on those
6022    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6023    should map to RPCC.  As the backing counters overflow quickly (on the order
6024    of 9 seconds on alpha), this should only be used for small timings.</p>
6025
6026 <h5>Semantics:</h5>
6027 <p>When directly supported, reading the cycle counter should not modify any
6028    memory.  Implementations are allowed to either return a application specific
6029    value or a system wide value.  On backends without support, this is lowered
6030    to a constant 0.</p>
6031
6032 </div>
6033
6034 <!-- ======================================================================= -->
6035 <div class="doc_subsection">
6036   <a name="int_libc">Standard C Library Intrinsics</a>
6037 </div>
6038
6039 <div class="doc_text">
6040
6041 <p>LLVM provides intrinsics for a few important standard C library functions.
6042    These intrinsics allow source-language front-ends to pass information about
6043    the alignment of the pointer arguments to the code generator, providing
6044    opportunity for more efficient code generation.</p>
6045
6046 </div>
6047
6048 <!-- _______________________________________________________________________ -->
6049 <div class="doc_subsubsection">
6050   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6051 </div>
6052
6053 <div class="doc_text">
6054
6055 <h5>Syntax:</h5>
6056 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6057    integer bit width and for different address spaces. Not all targets support
6058    all bit widths however.</p>
6059
6060 <pre>
6061   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6062                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6063   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6064                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6065 </pre>
6066
6067 <h5>Overview:</h5>
6068 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6069    source location to the destination location.</p>
6070
6071 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6072    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6073    and the pointers can be in specified address spaces.</p>
6074
6075 <h5>Arguments:</h5>
6076
6077 <p>The first argument is a pointer to the destination, the second is a pointer
6078    to the source.  The third argument is an integer argument specifying the
6079    number of bytes to copy, the fourth argument is the alignment of the
6080    source and destination locations, and the fifth is a boolean indicating a
6081    volatile access.</p>
6082
6083 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6084    then the caller guarantees that both the source and destination pointers are
6085    aligned to that boundary.</p>
6086
6087 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6088    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6089    The detailed access behavior is not very cleanly specified and it is unwise
6090    to depend on it.</p>
6091
6092 <h5>Semantics:</h5>
6093
6094 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6095    source location to the destination location, which are not allowed to
6096    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6097    be aligned to some boundary, this can be specified as the fourth argument,
6098    otherwise it should be set to 0 or 1.</p>
6099
6100 </div>
6101
6102 <!-- _______________________________________________________________________ -->
6103 <div class="doc_subsubsection">
6104   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6105 </div>
6106
6107 <div class="doc_text">
6108
6109 <h5>Syntax:</h5>
6110 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6111    width and for different address space. Not all targets support all bit
6112    widths however.</p>
6113
6114 <pre>
6115   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6116                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6117   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6118                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6119 </pre>
6120
6121 <h5>Overview:</h5>
6122 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6123    source location to the destination location. It is similar to the
6124    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6125    overlap.</p>
6126
6127 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6128    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6129    and the pointers can be in specified address spaces.</p>
6130
6131 <h5>Arguments:</h5>
6132
6133 <p>The first argument is a pointer to the destination, the second is a pointer
6134    to the source.  The third argument is an integer argument specifying the
6135    number of bytes to copy, the fourth argument is the alignment of the
6136    source and destination locations, and the fifth is a boolean indicating a
6137    volatile access.</p>
6138
6139 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6140    then the caller guarantees that the source and destination pointers are
6141    aligned to that boundary.</p>
6142
6143 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6144    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6145    The detailed access behavior is not very cleanly specified and it is unwise
6146    to depend on it.</p>
6147
6148 <h5>Semantics:</h5>
6149
6150 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6151    source location to the destination location, which may overlap.  It copies
6152    "len" bytes of memory over.  If the argument is known to be aligned to some
6153    boundary, this can be specified as the fourth argument, otherwise it should
6154    be set to 0 or 1.</p>
6155
6156 </div>
6157
6158 <!-- _______________________________________________________________________ -->
6159 <div class="doc_subsubsection">
6160   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6161 </div>
6162
6163 <div class="doc_text">
6164
6165 <h5>Syntax:</h5>
6166 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6167    width and for different address spaces. However, not all targets support all
6168    bit widths.</p>
6169
6170 <pre>
6171   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6172                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6173   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6174                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6175 </pre>
6176
6177 <h5>Overview:</h5>
6178 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6179    particular byte value.</p>
6180
6181 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6182    intrinsic does not return a value and takes extra alignment/volatile
6183    arguments.  Also, the destination can be in an arbitrary address space.</p>
6184
6185 <h5>Arguments:</h5>
6186 <p>The first argument is a pointer to the destination to fill, the second is the
6187    byte value with which to fill it, the third argument is an integer argument
6188    specifying the number of bytes to fill, and the fourth argument is the known
6189    alignment of the destination location.</p>
6190
6191 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6192    then the caller guarantees that the destination pointer is aligned to that
6193    boundary.</p>
6194
6195 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6196    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6197    The detailed access behavior is not very cleanly specified and it is unwise
6198    to depend on it.</p>
6199
6200 <h5>Semantics:</h5>
6201 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6202    at the destination location.  If the argument is known to be aligned to some
6203    boundary, this can be specified as the fourth argument, otherwise it should
6204    be set to 0 or 1.</p>
6205
6206 </div>
6207
6208 <!-- _______________________________________________________________________ -->
6209 <div class="doc_subsubsection">
6210   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6211 </div>
6212
6213 <div class="doc_text">
6214
6215 <h5>Syntax:</h5>
6216 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6217    floating point or vector of floating point type. Not all targets support all
6218    types however.</p>
6219
6220 <pre>
6221   declare float     @llvm.sqrt.f32(float %Val)
6222   declare double    @llvm.sqrt.f64(double %Val)
6223   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6224   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6225   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6226 </pre>
6227
6228 <h5>Overview:</h5>
6229 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6230    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6231    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6232    behavior for negative numbers other than -0.0 (which allows for better
6233    optimization, because there is no need to worry about errno being
6234    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6235
6236 <h5>Arguments:</h5>
6237 <p>The argument and return value are floating point numbers of the same
6238    type.</p>
6239
6240 <h5>Semantics:</h5>
6241 <p>This function returns the sqrt of the specified operand if it is a
6242    nonnegative floating point number.</p>
6243
6244 </div>
6245
6246 <!-- _______________________________________________________________________ -->
6247 <div class="doc_subsubsection">
6248   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6249 </div>
6250
6251 <div class="doc_text">
6252
6253 <h5>Syntax:</h5>
6254 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6255    floating point or vector of floating point type. Not all targets support all
6256    types however.</p>
6257
6258 <pre>
6259   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6260   declare double    @llvm.powi.f64(double %Val, i32 %power)
6261   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6262   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6263   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6264 </pre>
6265
6266 <h5>Overview:</h5>
6267 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6268    specified (positive or negative) power.  The order of evaluation of
6269    multiplications is not defined.  When a vector of floating point type is
6270    used, the second argument remains a scalar integer value.</p>
6271
6272 <h5>Arguments:</h5>
6273 <p>The second argument is an integer power, and the first is a value to raise to
6274    that power.</p>
6275
6276 <h5>Semantics:</h5>
6277 <p>This function returns the first value raised to the second power with an
6278    unspecified sequence of rounding operations.</p>
6279
6280 </div>
6281
6282 <!-- _______________________________________________________________________ -->
6283 <div class="doc_subsubsection">
6284   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6285 </div>
6286
6287 <div class="doc_text">
6288
6289 <h5>Syntax:</h5>
6290 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6291    floating point or vector of floating point type. Not all targets support all
6292    types however.</p>
6293
6294 <pre>
6295   declare float     @llvm.sin.f32(float  %Val)
6296   declare double    @llvm.sin.f64(double %Val)
6297   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6298   declare fp128     @llvm.sin.f128(fp128 %Val)
6299   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6300 </pre>
6301
6302 <h5>Overview:</h5>
6303 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6304
6305 <h5>Arguments:</h5>
6306 <p>The argument and return value are floating point numbers of the same
6307    type.</p>
6308
6309 <h5>Semantics:</h5>
6310 <p>This function returns the sine of the specified operand, returning the same
6311    values as the libm <tt>sin</tt> functions would, and handles error conditions
6312    in the same way.</p>
6313
6314 </div>
6315
6316 <!-- _______________________________________________________________________ -->
6317 <div class="doc_subsubsection">
6318   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6319 </div>
6320
6321 <div class="doc_text">
6322
6323 <h5>Syntax:</h5>
6324 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6325    floating point or vector of floating point type. Not all targets support all
6326    types however.</p>
6327
6328 <pre>
6329   declare float     @llvm.cos.f32(float  %Val)
6330   declare double    @llvm.cos.f64(double %Val)
6331   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6332   declare fp128     @llvm.cos.f128(fp128 %Val)
6333   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6334 </pre>
6335
6336 <h5>Overview:</h5>
6337 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6338
6339 <h5>Arguments:</h5>
6340 <p>The argument and return value are floating point numbers of the same
6341    type.</p>
6342
6343 <h5>Semantics:</h5>
6344 <p>This function returns the cosine of the specified operand, returning the same
6345    values as the libm <tt>cos</tt> functions would, and handles error conditions
6346    in the same way.</p>
6347
6348 </div>
6349
6350 <!-- _______________________________________________________________________ -->
6351 <div class="doc_subsubsection">
6352   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6353 </div>
6354
6355 <div class="doc_text">
6356
6357 <h5>Syntax:</h5>
6358 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6359    floating point or vector of floating point type. Not all targets support all
6360    types however.</p>
6361
6362 <pre>
6363   declare float     @llvm.pow.f32(float  %Val, float %Power)
6364   declare double    @llvm.pow.f64(double %Val, double %Power)
6365   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6366   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6367   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6368 </pre>
6369
6370 <h5>Overview:</h5>
6371 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6372    specified (positive or negative) power.</p>
6373
6374 <h5>Arguments:</h5>
6375 <p>The second argument is a floating point power, and the first is a value to
6376    raise to that power.</p>
6377
6378 <h5>Semantics:</h5>
6379 <p>This function returns the first value raised to the second power, returning
6380    the same values as the libm <tt>pow</tt> functions would, and handles error
6381    conditions in the same way.</p>
6382
6383 </div>
6384
6385 <!-- ======================================================================= -->
6386 <div class="doc_subsection">
6387   <a name="int_manip">Bit Manipulation Intrinsics</a>
6388 </div>
6389
6390 <div class="doc_text">
6391
6392 <p>LLVM provides intrinsics for a few important bit manipulation operations.
6393    These allow efficient code generation for some algorithms.</p>
6394
6395 </div>
6396
6397 <!-- _______________________________________________________________________ -->
6398 <div class="doc_subsubsection">
6399   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
6400 </div>
6401
6402 <div class="doc_text">
6403
6404 <h5>Syntax:</h5>
6405 <p>This is an overloaded intrinsic function. You can use bswap on any integer
6406    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
6407
6408 <pre>
6409   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
6410   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
6411   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
6412 </pre>
6413
6414 <h5>Overview:</h5>
6415 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
6416    values with an even number of bytes (positive multiple of 16 bits).  These
6417    are useful for performing operations on data that is not in the target's
6418    native byte order.</p>
6419
6420 <h5>Semantics:</h5>
6421 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
6422    and low byte of the input i16 swapped.  Similarly,
6423    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
6424    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
6425    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
6426    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
6427    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
6428    more, respectively).</p>
6429
6430 </div>
6431
6432 <!-- _______________________________________________________________________ -->
6433 <div class="doc_subsubsection">
6434   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
6435 </div>
6436
6437 <div class="doc_text">
6438
6439 <h5>Syntax:</h5>
6440 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
6441    width. Not all targets support all bit widths however.</p>
6442
6443 <pre>
6444   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
6445   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
6446   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
6447   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
6448   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
6449 </pre>
6450
6451 <h5>Overview:</h5>
6452 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
6453    in a value.</p>
6454
6455 <h5>Arguments:</h5>
6456 <p>The only argument is the value to be counted.  The argument may be of any
6457    integer type.  The return type must match the argument type.</p>
6458
6459 <h5>Semantics:</h5>
6460 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.</p>
6461
6462 </div>
6463
6464 <!-- _______________________________________________________________________ -->
6465 <div class="doc_subsubsection">
6466   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
6467 </div>
6468
6469 <div class="doc_text">
6470
6471 <h5>Syntax:</h5>
6472 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
6473    integer bit width. Not all targets support all bit widths however.</p>
6474
6475 <pre>
6476   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
6477   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
6478   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
6479   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
6480   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
6481 </pre>
6482
6483 <h5>Overview:</h5>
6484 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
6485    leading zeros in a variable.</p>
6486
6487 <h5>Arguments:</h5>
6488 <p>The only argument is the value to be counted.  The argument may be of any
6489    integer type. The return type must match the argument type.</p>
6490
6491 <h5>Semantics:</h5>
6492 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
6493    zeros in a variable.  If the src == 0 then the result is the size in bits of
6494    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
6495
6496 </div>
6497
6498 <!-- _______________________________________________________________________ -->
6499 <div class="doc_subsubsection">
6500   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
6501 </div>
6502
6503 <div class="doc_text">
6504
6505 <h5>Syntax:</h5>
6506 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
6507    integer bit width. Not all targets support all bit widths however.</p>
6508
6509 <pre>
6510   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
6511   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
6512   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
6513   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
6514   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
6515 </pre>
6516
6517 <h5>Overview:</h5>
6518 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
6519    trailing zeros.</p>
6520
6521 <h5>Arguments:</h5>
6522 <p>The only argument is the value to be counted.  The argument may be of any
6523    integer type.  The return type must match the argument type.</p>
6524
6525 <h5>Semantics:</h5>
6526 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
6527    zeros in a variable.  If the src == 0 then the result is the size in bits of
6528    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
6529
6530 </div>
6531
6532 <!-- ======================================================================= -->
6533 <div class="doc_subsection">
6534   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
6535 </div>
6536
6537 <div class="doc_text">
6538
6539 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
6540
6541 </div>
6542
6543 <!-- _______________________________________________________________________ -->
6544 <div class="doc_subsubsection">
6545   <a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a>
6546 </div>
6547
6548 <div class="doc_text">
6549
6550 <h5>Syntax:</h5>
6551 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
6552    on any integer bit width.</p>
6553
6554 <pre>
6555   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
6556   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6557   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
6558 </pre>
6559
6560 <h5>Overview:</h5>
6561 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6562    a signed addition of the two arguments, and indicate whether an overflow
6563    occurred during the signed summation.</p>
6564
6565 <h5>Arguments:</h5>
6566 <p>The arguments (%a and %b) and the first element of the result structure may
6567    be of integer types of any bit width, but they must have the same bit
6568    width. The second element of the result structure must be of
6569    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6570    undergo signed addition.</p>
6571
6572 <h5>Semantics:</h5>
6573 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6574    a signed addition of the two variables. They return a structure &mdash; the
6575    first element of which is the signed summation, and the second element of
6576    which is a bit specifying if the signed summation resulted in an
6577    overflow.</p>
6578
6579 <h5>Examples:</h5>
6580 <pre>
6581   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6582   %sum = extractvalue {i32, i1} %res, 0
6583   %obit = extractvalue {i32, i1} %res, 1
6584   br i1 %obit, label %overflow, label %normal
6585 </pre>
6586
6587 </div>
6588
6589 <!-- _______________________________________________________________________ -->
6590 <div class="doc_subsubsection">
6591   <a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a>
6592 </div>
6593
6594 <div class="doc_text">
6595
6596 <h5>Syntax:</h5>
6597 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
6598    on any integer bit width.</p>
6599
6600 <pre>
6601   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
6602   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6603   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
6604 </pre>
6605
6606 <h5>Overview:</h5>
6607 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6608    an unsigned addition of the two arguments, and indicate whether a carry
6609    occurred during the unsigned summation.</p>
6610
6611 <h5>Arguments:</h5>
6612 <p>The arguments (%a and %b) and the first element of the result structure may
6613    be of integer types of any bit width, but they must have the same bit
6614    width. The second element of the result structure must be of
6615    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6616    undergo unsigned addition.</p>
6617
6618 <h5>Semantics:</h5>
6619 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6620    an unsigned addition of the two arguments. They return a structure &mdash;
6621    the first element of which is the sum, and the second element of which is a
6622    bit specifying if the unsigned summation resulted in a carry.</p>
6623
6624 <h5>Examples:</h5>
6625 <pre>
6626   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6627   %sum = extractvalue {i32, i1} %res, 0
6628   %obit = extractvalue {i32, i1} %res, 1
6629   br i1 %obit, label %carry, label %normal
6630 </pre>
6631
6632 </div>
6633
6634 <!-- _______________________________________________________________________ -->
6635 <div class="doc_subsubsection">
6636   <a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a>
6637 </div>
6638
6639 <div class="doc_text">
6640
6641 <h5>Syntax:</h5>
6642 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
6643    on any integer bit width.</p>
6644
6645 <pre>
6646   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
6647   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6648   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
6649 </pre>
6650
6651 <h5>Overview:</h5>
6652 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6653    a signed subtraction of the two arguments, and indicate whether an overflow
6654    occurred during the signed subtraction.</p>
6655
6656 <h5>Arguments:</h5>
6657 <p>The arguments (%a and %b) and the first element of the result structure may
6658    be of integer types of any bit width, but they must have the same bit
6659    width. The second element of the result structure must be of
6660    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6661    undergo signed subtraction.</p>
6662
6663 <h5>Semantics:</h5>
6664 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6665    a signed subtraction of the two arguments. They return a structure &mdash;
6666    the first element of which is the subtraction, and the second element of
6667    which is a bit specifying if the signed subtraction resulted in an
6668    overflow.</p>
6669
6670 <h5>Examples:</h5>
6671 <pre>
6672   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6673   %sum = extractvalue {i32, i1} %res, 0
6674   %obit = extractvalue {i32, i1} %res, 1
6675   br i1 %obit, label %overflow, label %normal
6676 </pre>
6677
6678 </div>
6679
6680 <!-- _______________________________________________________________________ -->
6681 <div class="doc_subsubsection">
6682   <a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a>
6683 </div>
6684
6685 <div class="doc_text">
6686
6687 <h5>Syntax:</h5>
6688 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
6689    on any integer bit width.</p>
6690
6691 <pre>
6692   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
6693   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6694   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
6695 </pre>
6696
6697 <h5>Overview:</h5>
6698 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6699    an unsigned subtraction of the two arguments, and indicate whether an
6700    overflow occurred during the unsigned subtraction.</p>
6701
6702 <h5>Arguments:</h5>
6703 <p>The arguments (%a and %b) and the first element of the result structure may
6704    be of integer types of any bit width, but they must have the same bit
6705    width. The second element of the result structure must be of
6706    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6707    undergo unsigned subtraction.</p>
6708
6709 <h5>Semantics:</h5>
6710 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6711    an unsigned subtraction of the two arguments. They return a structure &mdash;
6712    the first element of which is the subtraction, and the second element of
6713    which is a bit specifying if the unsigned subtraction resulted in an
6714    overflow.</p>
6715
6716 <h5>Examples:</h5>
6717 <pre>
6718   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6719   %sum = extractvalue {i32, i1} %res, 0
6720   %obit = extractvalue {i32, i1} %res, 1
6721   br i1 %obit, label %overflow, label %normal
6722 </pre>
6723
6724 </div>
6725
6726 <!-- _______________________________________________________________________ -->
6727 <div class="doc_subsubsection">
6728   <a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a>
6729 </div>
6730
6731 <div class="doc_text">
6732
6733 <h5>Syntax:</h5>
6734 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
6735    on any integer bit width.</p>
6736
6737 <pre>
6738   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
6739   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6740   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
6741 </pre>
6742
6743 <h5>Overview:</h5>
6744
6745 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6746    a signed multiplication of the two arguments, and indicate whether an
6747    overflow occurred during the signed multiplication.</p>
6748
6749 <h5>Arguments:</h5>
6750 <p>The arguments (%a and %b) and the first element of the result structure may
6751    be of integer types of any bit width, but they must have the same bit
6752    width. The second element of the result structure must be of
6753    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6754    undergo signed multiplication.</p>
6755
6756 <h5>Semantics:</h5>
6757 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6758    a signed multiplication of the two arguments. They return a structure &mdash;
6759    the first element of which is the multiplication, and the second element of
6760    which is a bit specifying if the signed multiplication resulted in an
6761    overflow.</p>
6762
6763 <h5>Examples:</h5>
6764 <pre>
6765   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6766   %sum = extractvalue {i32, i1} %res, 0
6767   %obit = extractvalue {i32, i1} %res, 1
6768   br i1 %obit, label %overflow, label %normal
6769 </pre>
6770
6771 </div>
6772
6773 <!-- _______________________________________________________________________ -->
6774 <div class="doc_subsubsection">
6775   <a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a>
6776 </div>
6777
6778 <div class="doc_text">
6779
6780 <h5>Syntax:</h5>
6781 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
6782    on any integer bit width.</p>
6783
6784 <pre>
6785   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
6786   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6787   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
6788 </pre>
6789
6790 <h5>Overview:</h5>
6791 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6792    a unsigned multiplication of the two arguments, and indicate whether an
6793    overflow occurred during the unsigned multiplication.</p>
6794
6795 <h5>Arguments:</h5>
6796 <p>The arguments (%a and %b) and the first element of the result structure may
6797    be of integer types of any bit width, but they must have the same bit
6798    width. The second element of the result structure must be of
6799    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6800    undergo unsigned multiplication.</p>
6801
6802 <h5>Semantics:</h5>
6803 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6804    an unsigned multiplication of the two arguments. They return a structure
6805    &mdash; the first element of which is the multiplication, and the second
6806    element of which is a bit specifying if the unsigned multiplication resulted
6807    in an overflow.</p>
6808
6809 <h5>Examples:</h5>
6810 <pre>
6811   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6812   %sum = extractvalue {i32, i1} %res, 0
6813   %obit = extractvalue {i32, i1} %res, 1
6814   br i1 %obit, label %overflow, label %normal
6815 </pre>
6816
6817 </div>
6818
6819 <!-- ======================================================================= -->
6820 <div class="doc_subsection">
6821   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
6822 </div>
6823
6824 <div class="doc_text">
6825
6826 <p>Half precision floating point is a storage-only format. This means that it is
6827    a dense encoding (in memory) but does not support computation in the
6828    format.</p>
6829
6830 <p>This means that code must first load the half-precision floating point
6831    value as an i16, then convert it to float with <a
6832    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
6833    Computation can then be performed on the float value (including extending to
6834    double etc).  To store the value back to memory, it is first converted to
6835    float if needed, then converted to i16 with
6836    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
6837    storing as an i16 value.</p>
6838 </div>
6839
6840 <!-- _______________________________________________________________________ -->
6841 <div class="doc_subsubsection">
6842   <a name="int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a>
6843 </div>
6844
6845 <div class="doc_text">
6846
6847 <h5>Syntax:</h5>
6848 <pre>
6849   declare i16 @llvm.convert.to.fp16(f32 %a)
6850 </pre>
6851
6852 <h5>Overview:</h5>
6853 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6854    a conversion from single precision floating point format to half precision
6855    floating point format.</p>
6856
6857 <h5>Arguments:</h5>
6858 <p>The intrinsic function contains single argument - the value to be
6859    converted.</p>
6860
6861 <h5>Semantics:</h5>
6862 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6863    a conversion from single precision floating point format to half precision
6864    floating point format. The return value is an <tt>i16</tt> which
6865    contains the converted number.</p>
6866
6867 <h5>Examples:</h5>
6868 <pre>
6869   %res = call i16 @llvm.convert.to.fp16(f32 %a)
6870   store i16 %res, i16* @x, align 2
6871 </pre>
6872
6873 </div>
6874
6875 <!-- _______________________________________________________________________ -->
6876 <div class="doc_subsubsection">
6877  <a name="int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a>
6878 </div>
6879
6880 <div class="doc_text">
6881
6882 <h5>Syntax:</h5>
6883 <pre>
6884   declare f32 @llvm.convert.from.fp16(i16 %a)
6885 </pre>
6886
6887 <h5>Overview:</h5>
6888 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
6889    a conversion from half precision floating point format to single precision
6890    floating point format.</p>
6891
6892 <h5>Arguments:</h5>
6893 <p>The intrinsic function contains single argument - the value to be
6894    converted.</p>
6895
6896 <h5>Semantics:</h5>
6897 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
6898    conversion from half single precision floating point format to single
6899    precision floating point format. The input half-float value is represented by
6900    an <tt>i16</tt> value.</p>
6901
6902 <h5>Examples:</h5>
6903 <pre>
6904   %a = load i16* @x, align 2
6905   %res = call f32 @llvm.convert.from.fp16(i16 %a)
6906 </pre>
6907
6908 </div>
6909
6910 <!-- ======================================================================= -->
6911 <div class="doc_subsection">
6912   <a name="int_debugger">Debugger Intrinsics</a>
6913 </div>
6914
6915 <div class="doc_text">
6916
6917 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
6918    prefix), are described in
6919    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
6920    Level Debugging</a> document.</p>
6921
6922 </div>
6923
6924 <!-- ======================================================================= -->
6925 <div class="doc_subsection">
6926   <a name="int_eh">Exception Handling Intrinsics</a>
6927 </div>
6928
6929 <div class="doc_text">
6930
6931 <p>The LLVM exception handling intrinsics (which all start with
6932    <tt>llvm.eh.</tt> prefix), are described in
6933    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
6934    Handling</a> document.</p>
6935
6936 </div>
6937
6938 <!-- ======================================================================= -->
6939 <div class="doc_subsection">
6940   <a name="int_trampoline">Trampoline Intrinsic</a>
6941 </div>
6942
6943 <div class="doc_text">
6944
6945 <p>This intrinsic makes it possible to excise one parameter, marked with
6946    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
6947    The result is a callable
6948    function pointer lacking the nest parameter - the caller does not need to
6949    provide a value for it.  Instead, the value to use is stored in advance in a
6950    "trampoline", a block of memory usually allocated on the stack, which also
6951    contains code to splice the nest value into the argument list.  This is used
6952    to implement the GCC nested function address extension.</p>
6953
6954 <p>For example, if the function is
6955    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
6956    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
6957    follows:</p>
6958
6959 <pre class="doc_code">
6960   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
6961   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
6962   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
6963   %fp = bitcast i8* %p to i32 (i32, i32)*
6964 </pre>
6965
6966 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
6967    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
6968
6969 </div>
6970
6971 <!-- _______________________________________________________________________ -->
6972 <div class="doc_subsubsection">
6973   <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
6974 </div>
6975
6976 <div class="doc_text">
6977
6978 <h5>Syntax:</h5>
6979 <pre>
6980   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
6981 </pre>
6982
6983 <h5>Overview:</h5>
6984 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
6985    function pointer suitable for executing it.</p>
6986
6987 <h5>Arguments:</h5>
6988 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
6989    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
6990    sufficiently aligned block of memory; this memory is written to by the
6991    intrinsic.  Note that the size and the alignment are target-specific - LLVM
6992    currently provides no portable way of determining them, so a front-end that
6993    generates this intrinsic needs to have some target-specific knowledge.
6994    The <tt>func</tt> argument must hold a function bitcast to
6995    an <tt>i8*</tt>.</p>
6996
6997 <h5>Semantics:</h5>
6998 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
6999    dependent code, turning it into a function.  A pointer to this function is
7000    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
7001    function pointer type</a> before being called.  The new function's signature
7002    is the same as that of <tt>func</tt> with any arguments marked with
7003    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
7004    is allowed, and it must be of pointer type.  Calling the new function is
7005    equivalent to calling <tt>func</tt> with the same argument list, but
7006    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7007    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7008    by <tt>tramp</tt> is modified, then the effect of any later call to the
7009    returned function pointer is undefined.</p>
7010
7011 </div>
7012
7013 <!-- ======================================================================= -->
7014 <div class="doc_subsection">
7015   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7016 </div>
7017
7018 <div class="doc_text">
7019
7020 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7021    hardware constructs for atomic operations and memory synchronization.  This
7022    provides an interface to the hardware, not an interface to the programmer. It
7023    is aimed at a low enough level to allow any programming models or APIs
7024    (Application Programming Interfaces) which need atomic behaviors to map
7025    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7026    hardware provides a "universal IR" for source languages, it also provides a
7027    starting point for developing a "universal" atomic operation and
7028    synchronization IR.</p>
7029
7030 <p>These do <em>not</em> form an API such as high-level threading libraries,
7031    software transaction memory systems, atomic primitives, and intrinsic
7032    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7033    application libraries.  The hardware interface provided by LLVM should allow
7034    a clean implementation of all of these APIs and parallel programming models.
7035    No one model or paradigm should be selected above others unless the hardware
7036    itself ubiquitously does so.</p>
7037
7038 </div>
7039
7040 <!-- _______________________________________________________________________ -->
7041 <div class="doc_subsubsection">
7042   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7043 </div>
7044 <div class="doc_text">
7045 <h5>Syntax:</h5>
7046 <pre>
7047   declare void @llvm.memory.barrier(i1 &lt;ll&gt;, i1 &lt;ls&gt;, i1 &lt;sl&gt;, i1 &lt;ss&gt;, i1 &lt;device&gt;)
7048 </pre>
7049
7050 <h5>Overview:</h5>
7051 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7052    specific pairs of memory access types.</p>
7053
7054 <h5>Arguments:</h5>
7055 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7056    The first four arguments enables a specific barrier as listed below.  The
7057    fifth argument specifies that the barrier applies to io or device or uncached
7058    memory.</p>
7059
7060 <ul>
7061   <li><tt>ll</tt>: load-load barrier</li>
7062   <li><tt>ls</tt>: load-store barrier</li>
7063   <li><tt>sl</tt>: store-load barrier</li>
7064   <li><tt>ss</tt>: store-store barrier</li>
7065   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7066 </ul>
7067
7068 <h5>Semantics:</h5>
7069 <p>This intrinsic causes the system to enforce some ordering constraints upon
7070    the loads and stores of the program. This barrier does not
7071    indicate <em>when</em> any events will occur, it only enforces
7072    an <em>order</em> in which they occur. For any of the specified pairs of load
7073    and store operations (f.ex.  load-load, or store-load), all of the first
7074    operations preceding the barrier will complete before any of the second
7075    operations succeeding the barrier begin. Specifically the semantics for each
7076    pairing is as follows:</p>
7077
7078 <ul>
7079   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7080       after the barrier begins.</li>
7081   <li><tt>ls</tt>: All loads before the barrier must complete before any
7082       store after the barrier begins.</li>
7083   <li><tt>ss</tt>: All stores before the barrier must complete before any
7084       store after the barrier begins.</li>
7085   <li><tt>sl</tt>: All stores before the barrier must complete before any
7086       load after the barrier begins.</li>
7087 </ul>
7088
7089 <p>These semantics are applied with a logical "and" behavior when more than one
7090    is enabled in a single memory barrier intrinsic.</p>
7091
7092 <p>Backends may implement stronger barriers than those requested when they do
7093    not support as fine grained a barrier as requested.  Some architectures do
7094    not need all types of barriers and on such architectures, these become
7095    noops.</p>
7096
7097 <h5>Example:</h5>
7098 <pre>
7099 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7100 %ptr      = bitcast i8* %mallocP to i32*
7101             store i32 4, %ptr
7102
7103 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7104             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false)
7105                                 <i>; guarantee the above finishes</i>
7106             store i32 8, %ptr   <i>; before this begins</i>
7107 </pre>
7108
7109 </div>
7110
7111 <!-- _______________________________________________________________________ -->
7112 <div class="doc_subsubsection">
7113   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7114 </div>
7115
7116 <div class="doc_text">
7117
7118 <h5>Syntax:</h5>
7119 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7120    any integer bit width and for different address spaces. Not all targets
7121    support all bit widths however.</p>
7122
7123 <pre>
7124   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7125   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7126   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7127   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7128 </pre>
7129
7130 <h5>Overview:</h5>
7131 <p>This loads a value in memory and compares it to a given value. If they are
7132    equal, it stores a new value into the memory.</p>
7133
7134 <h5>Arguments:</h5>
7135 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7136    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7137    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7138    this integer type. While any bit width integer may be used, targets may only
7139    lower representations they support in hardware.</p>
7140
7141 <h5>Semantics:</h5>
7142 <p>This entire intrinsic must be executed atomically. It first loads the value
7143    in memory pointed to by <tt>ptr</tt> and compares it with the
7144    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7145    memory. The loaded value is yielded in all cases. This provides the
7146    equivalent of an atomic compare-and-swap operation within the SSA
7147    framework.</p>
7148
7149 <h5>Examples:</h5>
7150 <pre>
7151 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7152 %ptr      = bitcast i8* %mallocP to i32*
7153             store i32 4, %ptr
7154
7155 %val1     = add i32 4, 4
7156 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7157                                           <i>; yields {i32}:result1 = 4</i>
7158 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7159 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7160
7161 %val2     = add i32 1, 1
7162 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7163                                           <i>; yields {i32}:result2 = 8</i>
7164 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7165
7166 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7167 </pre>
7168
7169 </div>
7170
7171 <!-- _______________________________________________________________________ -->
7172 <div class="doc_subsubsection">
7173   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7174 </div>
7175 <div class="doc_text">
7176 <h5>Syntax:</h5>
7177
7178 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7179    integer bit width. Not all targets support all bit widths however.</p>
7180
7181 <pre>
7182   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7183   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7184   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7185   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7186 </pre>
7187
7188 <h5>Overview:</h5>
7189 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7190    the value from memory. It then stores the value in <tt>val</tt> in the memory
7191    at <tt>ptr</tt>.</p>
7192
7193 <h5>Arguments:</h5>
7194 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7195   the <tt>val</tt> argument and the result must be integers of the same bit
7196   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7197   integer type. The targets may only lower integer representations they
7198   support.</p>
7199
7200 <h5>Semantics:</h5>
7201 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7202    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7203    equivalent of an atomic swap operation within the SSA framework.</p>
7204
7205 <h5>Examples:</h5>
7206 <pre>
7207 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7208 %ptr      = bitcast i8* %mallocP to i32*
7209             store i32 4, %ptr
7210
7211 %val1     = add i32 4, 4
7212 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7213                                         <i>; yields {i32}:result1 = 4</i>
7214 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7215 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7216
7217 %val2     = add i32 1, 1
7218 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7219                                         <i>; yields {i32}:result2 = 8</i>
7220
7221 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7222 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7223 </pre>
7224
7225 </div>
7226
7227 <!-- _______________________________________________________________________ -->
7228 <div class="doc_subsubsection">
7229   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7230
7231 </div>
7232
7233 <div class="doc_text">
7234
7235 <h5>Syntax:</h5>
7236 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7237    any integer bit width. Not all targets support all bit widths however.</p>
7238
7239 <pre>
7240   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7241   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7242   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7243   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7244 </pre>
7245
7246 <h5>Overview:</h5>
7247 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7248    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7249
7250 <h5>Arguments:</h5>
7251 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7252    and the second an integer value. The result is also an integer value. These
7253    integer types can have any bit width, but they must all have the same bit
7254    width. The targets may only lower integer representations they support.</p>
7255
7256 <h5>Semantics:</h5>
7257 <p>This intrinsic does a series of operations atomically. It first loads the
7258    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7259    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7260
7261 <h5>Examples:</h5>
7262 <pre>
7263 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7264 %ptr      = bitcast i8* %mallocP to i32*
7265             store i32 4, %ptr
7266 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7267                                 <i>; yields {i32}:result1 = 4</i>
7268 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7269                                 <i>; yields {i32}:result2 = 8</i>
7270 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7271                                 <i>; yields {i32}:result3 = 10</i>
7272 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7273 </pre>
7274
7275 </div>
7276
7277 <!-- _______________________________________________________________________ -->
7278 <div class="doc_subsubsection">
7279   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
7280
7281 </div>
7282
7283 <div class="doc_text">
7284
7285 <h5>Syntax:</h5>
7286 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
7287    any integer bit width and for different address spaces. Not all targets
7288    support all bit widths however.</p>
7289
7290 <pre>
7291   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7292   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7293   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7294   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7295 </pre>
7296
7297 <h5>Overview:</h5>
7298 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
7299    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7300
7301 <h5>Arguments:</h5>
7302 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7303    and the second an integer value. The result is also an integer value. These
7304    integer types can have any bit width, but they must all have the same bit
7305    width. The targets may only lower integer representations they support.</p>
7306
7307 <h5>Semantics:</h5>
7308 <p>This intrinsic does a series of operations atomically. It first loads the
7309    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
7310    result to <tt>ptr</tt>. It yields the original value stored
7311    at <tt>ptr</tt>.</p>
7312
7313 <h5>Examples:</h5>
7314 <pre>
7315 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7316 %ptr      = bitcast i8* %mallocP to i32*
7317             store i32 8, %ptr
7318 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
7319                                 <i>; yields {i32}:result1 = 8</i>
7320 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
7321                                 <i>; yields {i32}:result2 = 4</i>
7322 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
7323                                 <i>; yields {i32}:result3 = 2</i>
7324 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
7325 </pre>
7326
7327 </div>
7328
7329 <!-- _______________________________________________________________________ -->
7330 <div class="doc_subsubsection">
7331   <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
7332   <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
7333   <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
7334   <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
7335 </div>
7336
7337 <div class="doc_text">
7338
7339 <h5>Syntax:</h5>
7340 <p>These are overloaded intrinsics. You can
7341   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
7342   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
7343   bit width and for different address spaces. Not all targets support all bit
7344   widths however.</p>
7345
7346 <pre>
7347   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7348   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7349   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7350   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7351 </pre>
7352
7353 <pre>
7354   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7355   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7356   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7357   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7358 </pre>
7359
7360 <pre>
7361   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7362   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7363   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7364   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7365 </pre>
7366
7367 <pre>
7368   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7369   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7370   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7371   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7372 </pre>
7373
7374 <h5>Overview:</h5>
7375 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
7376    the value stored in memory at <tt>ptr</tt>. It yields the original value
7377    at <tt>ptr</tt>.</p>
7378
7379 <h5>Arguments:</h5>
7380 <p>These intrinsics take two arguments, the first a pointer to an integer value
7381    and the second an integer value. The result is also an integer value. These
7382    integer types can have any bit width, but they must all have the same bit
7383    width. The targets may only lower integer representations they support.</p>
7384
7385 <h5>Semantics:</h5>
7386 <p>These intrinsics does a series of operations atomically. They first load the
7387    value stored at <tt>ptr</tt>. They then do the bitwise
7388    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
7389    original value stored at <tt>ptr</tt>.</p>
7390
7391 <h5>Examples:</h5>
7392 <pre>
7393 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7394 %ptr      = bitcast i8* %mallocP to i32*
7395             store i32 0x0F0F, %ptr
7396 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
7397                                 <i>; yields {i32}:result0 = 0x0F0F</i>
7398 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
7399                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
7400 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
7401                                 <i>; yields {i32}:result2 = 0xF0</i>
7402 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
7403                                 <i>; yields {i32}:result3 = FF</i>
7404 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
7405 </pre>
7406
7407 </div>
7408
7409 <!-- _______________________________________________________________________ -->
7410 <div class="doc_subsubsection">
7411   <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
7412   <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
7413   <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
7414   <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
7415 </div>
7416
7417 <div class="doc_text">
7418
7419 <h5>Syntax:</h5>
7420 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
7421    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
7422    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
7423    address spaces. Not all targets support all bit widths however.</p>
7424
7425 <pre>
7426   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7427   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7428   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7429   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7430 </pre>
7431
7432 <pre>
7433   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7434   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7435   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7436   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7437 </pre>
7438
7439 <pre>
7440   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7441   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7442   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7443   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7444 </pre>
7445
7446 <pre>
7447   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7448   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7449   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7450   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7451 </pre>
7452
7453 <h5>Overview:</h5>
7454 <p>These intrinsics takes the signed or unsigned minimum or maximum of
7455    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
7456    original value at <tt>ptr</tt>.</p>
7457
7458 <h5>Arguments:</h5>
7459 <p>These intrinsics take two arguments, the first a pointer to an integer value
7460    and the second an integer value. The result is also an integer value. These
7461    integer types can have any bit width, but they must all have the same bit
7462    width. The targets may only lower integer representations they support.</p>
7463
7464 <h5>Semantics:</h5>
7465 <p>These intrinsics does a series of operations atomically. They first load the
7466    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
7467    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
7468    yield the original value stored at <tt>ptr</tt>.</p>
7469
7470 <h5>Examples:</h5>
7471 <pre>
7472 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7473 %ptr      = bitcast i8* %mallocP to i32*
7474             store i32 7, %ptr
7475 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
7476                                 <i>; yields {i32}:result0 = 7</i>
7477 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
7478                                 <i>; yields {i32}:result1 = -2</i>
7479 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
7480                                 <i>; yields {i32}:result2 = 8</i>
7481 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
7482                                 <i>; yields {i32}:result3 = 8</i>
7483 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
7484 </pre>
7485
7486 </div>
7487
7488
7489 <!-- ======================================================================= -->
7490 <div class="doc_subsection">
7491   <a name="int_memorymarkers">Memory Use Markers</a>
7492 </div>
7493
7494 <div class="doc_text">
7495
7496 <p>This class of intrinsics exists to information about the lifetime of memory
7497    objects and ranges where variables are immutable.</p>
7498
7499 </div>
7500
7501 <!-- _______________________________________________________________________ -->
7502 <div class="doc_subsubsection">
7503   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7504 </div>
7505
7506 <div class="doc_text">
7507
7508 <h5>Syntax:</h5>
7509 <pre>
7510   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7511 </pre>
7512
7513 <h5>Overview:</h5>
7514 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7515    object's lifetime.</p>
7516
7517 <h5>Arguments:</h5>
7518 <p>The first argument is a constant integer representing the size of the
7519    object, or -1 if it is variable sized.  The second argument is a pointer to
7520    the object.</p>
7521
7522 <h5>Semantics:</h5>
7523 <p>This intrinsic indicates that before this point in the code, the value of the
7524    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7525    never be used and has an undefined value.  A load from the pointer that
7526    precedes this intrinsic can be replaced with
7527    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7528
7529 </div>
7530
7531 <!-- _______________________________________________________________________ -->
7532 <div class="doc_subsubsection">
7533   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7534 </div>
7535
7536 <div class="doc_text">
7537
7538 <h5>Syntax:</h5>
7539 <pre>
7540   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7541 </pre>
7542
7543 <h5>Overview:</h5>
7544 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7545    object's lifetime.</p>
7546
7547 <h5>Arguments:</h5>
7548 <p>The first argument is a constant integer representing the size of the
7549    object, or -1 if it is variable sized.  The second argument is a pointer to
7550    the object.</p>
7551
7552 <h5>Semantics:</h5>
7553 <p>This intrinsic indicates that after this point in the code, the value of the
7554    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7555    never be used and has an undefined value.  Any stores into the memory object
7556    following this intrinsic may be removed as dead.
7557
7558 </div>
7559
7560 <!-- _______________________________________________________________________ -->
7561 <div class="doc_subsubsection">
7562   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7563 </div>
7564
7565 <div class="doc_text">
7566
7567 <h5>Syntax:</h5>
7568 <pre>
7569   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7570 </pre>
7571
7572 <h5>Overview:</h5>
7573 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7574    a memory object will not change.</p>
7575
7576 <h5>Arguments:</h5>
7577 <p>The first argument is a constant integer representing the size of the
7578    object, or -1 if it is variable sized.  The second argument is a pointer to
7579    the object.</p>
7580
7581 <h5>Semantics:</h5>
7582 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
7583    the return value, the referenced memory location is constant and
7584    unchanging.</p>
7585
7586 </div>
7587
7588 <!-- _______________________________________________________________________ -->
7589 <div class="doc_subsubsection">
7590   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
7591 </div>
7592
7593 <div class="doc_text">
7594
7595 <h5>Syntax:</h5>
7596 <pre>
7597   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7598 </pre>
7599
7600 <h5>Overview:</h5>
7601 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
7602    a memory object are mutable.</p>
7603
7604 <h5>Arguments:</h5>
7605 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
7606    The second argument is a constant integer representing the size of the
7607    object, or -1 if it is variable sized and the third argument is a pointer
7608    to the object.</p>
7609
7610 <h5>Semantics:</h5>
7611 <p>This intrinsic indicates that the memory is mutable again.</p>
7612
7613 </div>
7614
7615 <!-- ======================================================================= -->
7616 <div class="doc_subsection">
7617   <a name="int_general">General Intrinsics</a>
7618 </div>
7619
7620 <div class="doc_text">
7621
7622 <p>This class of intrinsics is designed to be generic and has no specific
7623    purpose.</p>
7624
7625 </div>
7626
7627 <!-- _______________________________________________________________________ -->
7628 <div class="doc_subsubsection">
7629   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
7630 </div>
7631
7632 <div class="doc_text">
7633
7634 <h5>Syntax:</h5>
7635 <pre>
7636   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7637 </pre>
7638
7639 <h5>Overview:</h5>
7640 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
7641
7642 <h5>Arguments:</h5>
7643 <p>The first argument is a pointer to a value, the second is a pointer to a
7644    global string, the third is a pointer to a global string which is the source
7645    file name, and the last argument is the line number.</p>
7646
7647 <h5>Semantics:</h5>
7648 <p>This intrinsic allows annotation of local variables with arbitrary strings.
7649    This can be useful for special purpose optimizations that want to look for
7650    these annotations.  These have no other defined use, they are ignored by code
7651    generation and optimization.</p>
7652
7653 </div>
7654
7655 <!-- _______________________________________________________________________ -->
7656 <div class="doc_subsubsection">
7657   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
7658 </div>
7659
7660 <div class="doc_text">
7661
7662 <h5>Syntax:</h5>
7663 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
7664    any integer bit width.</p>
7665
7666 <pre>
7667   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7668   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7669   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7670   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7671   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7672 </pre>
7673
7674 <h5>Overview:</h5>
7675 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
7676
7677 <h5>Arguments:</h5>
7678 <p>The first argument is an integer value (result of some expression), the
7679    second is a pointer to a global string, the third is a pointer to a global
7680    string which is the source file name, and the last argument is the line
7681    number.  It returns the value of the first argument.</p>
7682
7683 <h5>Semantics:</h5>
7684 <p>This intrinsic allows annotations to be put on arbitrary expressions with
7685    arbitrary strings.  This can be useful for special purpose optimizations that
7686    want to look for these annotations.  These have no other defined use, they
7687    are ignored by code generation and optimization.</p>
7688
7689 </div>
7690
7691 <!-- _______________________________________________________________________ -->
7692 <div class="doc_subsubsection">
7693   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
7694 </div>
7695
7696 <div class="doc_text">
7697
7698 <h5>Syntax:</h5>
7699 <pre>
7700   declare void @llvm.trap()
7701 </pre>
7702
7703 <h5>Overview:</h5>
7704 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
7705
7706 <h5>Arguments:</h5>
7707 <p>None.</p>
7708
7709 <h5>Semantics:</h5>
7710 <p>This intrinsics is lowered to the target dependent trap instruction. If the
7711    target does not have a trap instruction, this intrinsic will be lowered to
7712    the call of the <tt>abort()</tt> function.</p>
7713
7714 </div>
7715
7716 <!-- _______________________________________________________________________ -->
7717 <div class="doc_subsubsection">
7718   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
7719 </div>
7720
7721 <div class="doc_text">
7722
7723 <h5>Syntax:</h5>
7724 <pre>
7725   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
7726 </pre>
7727
7728 <h5>Overview:</h5>
7729 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
7730    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
7731    ensure that it is placed on the stack before local variables.</p>
7732
7733 <h5>Arguments:</h5>
7734 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
7735    arguments. The first argument is the value loaded from the stack
7736    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
7737    that has enough space to hold the value of the guard.</p>
7738
7739 <h5>Semantics:</h5>
7740 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
7741    the <tt>AllocaInst</tt> stack slot to be before local variables on the
7742    stack. This is to ensure that if a local variable on the stack is
7743    overwritten, it will destroy the value of the guard. When the function exits,
7744    the guard on the stack is checked against the original guard. If they are
7745    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
7746    function.</p>
7747
7748 </div>
7749
7750 <!-- _______________________________________________________________________ -->
7751 <div class="doc_subsubsection">
7752   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
7753 </div>
7754
7755 <div class="doc_text">
7756
7757 <h5>Syntax:</h5>
7758 <pre>
7759   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
7760   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
7761 </pre>
7762
7763 <h5>Overview:</h5>
7764 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
7765    the optimizers to determine at compile time whether a) an operation (like
7766    memcpy) will overflow a buffer that corresponds to an object, or b) that a
7767    runtime check for overflow isn't necessary. An object in this context means
7768    an allocation of a specific class, structure, array, or other object.</p>
7769
7770 <h5>Arguments:</h5>
7771 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
7772    argument is a pointer to or into the <tt>object</tt>. The second argument
7773    is a boolean 0 or 1. This argument determines whether you want the
7774    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
7775    1, variables are not allowed.</p>
7776
7777 <h5>Semantics:</h5>
7778 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
7779    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
7780    depending on the <tt>type</tt> argument, if the size cannot be determined at
7781    compile time.</p>
7782
7783 </div>
7784
7785 <!-- *********************************************************************** -->
7786 <hr>
7787 <address>
7788   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
7789   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
7790   <a href="http://validator.w3.org/check/referer"><img
7791   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
7792
7793   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
7794   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
7795   Last modified: $Date$
7796 </address>
7797
7798 </body>
7799 </html>