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> <a href="#globalvars">constant</a> <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>A global variable may be declared to reside in a target-specific numbered
 850    address space. For targets that support them, address spaces may affect how
 851    optimizations are performed and/or what target instructions are used to
 852    access the variable. The default address space is zero. The address space
 853    qualifier must precede any other attributes.</p>
 854
 855 <p>LLVM allows an explicit section to be specified for globals.  If the target
 856    supports it, it will emit globals to the section specified.</p>
 857
 858 <p>An explicit alignment may be specified for a global, which must be a power
 859    of 2.  If not present, or if the alignment is set to zero, the alignment of
 860    the global is set by the target to whatever it feels convenient.  If an
 861    explicit alignment is specified, the global is forced to have exactly that
 862    alignment.  Targets and optimizers are not allowed to over-align the global
 863    if the global has an assigned section.  In this case, the extra alignment
 864    could be observable: for example, code could assume that the globals are
 865    densely packed in their section and try to iterate over them as an array,
 866    alignment padding would break this iteration.</p>
 867
 868 <p>For example, the following defines a global in a numbered address space with
 869    an initializer, section, and alignment:</p>
 870
 871 <pre class="doc_code">
 872 @G = addrspace(5) constant float 1.0, section "foo", align 4
 873 </pre>
 874
 875 </div>
 876
 877
 878 <!-- ======================================================================= -->
 879 <div class="doc_subsection">
 880   <a name="functionstructure">Functions</a>
 881 </div>
 882
 883 <div class="doc_text">
 884
 885 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 886    optional <a href="#linkage">linkage type</a>, an optional
 887    <a href="#visibility">visibility style</a>, an optional
 888    <a href="#callingconv">calling convention</a>, a return type, an optional
 889    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 890    name, a (possibly empty) argument list (each with optional
 891    <a href="#paramattrs">parameter attributes</a>), optional
 892    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 893    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 894    curly brace, a list of basic blocks, and a closing curly brace.</p>
 895
 896 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 897    optional <a href="#linkage">linkage type</a>, an optional
 898    <a href="#visibility">visibility style</a>, an optional
 899    <a href="#callingconv">calling convention</a>, a return type, an optional
 900    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 901    name, a possibly empty list of arguments, an optional alignment, and an
 902    optional <a href="#gc">garbage collector name</a>.</p>
 903
 904 <p>A function definition contains a list of basic blocks, forming the CFG
 905    (Control Flow Graph) for the function.  Each basic block may optionally start
 906    with a label (giving the basic block a symbol table entry), contains a list
 907    of instructions, and ends with a <a href="#terminators">terminator</a>
 908    instruction (such as a branch or function return).</p>
 909
 910 <p>The first basic block in a function is special in two ways: it is immediately
 911    executed on entrance to the function, and it is not allowed to have
 912    predecessor basic blocks (i.e. there can not be any branches to the entry
 913    block of a function).  Because the block can have no predecessors, it also
 914    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 915
 916 <p>LLVM allows an explicit section to be specified for functions.  If the target
 917    supports it, it will emit functions to the section specified.</p>
 918
 919 <p>An explicit alignment may be specified for a function.  If not present, or if
 920    the alignment is set to zero, the alignment of the function is set by the
 921    target to whatever it feels convenient.  If an explicit alignment is
 922    specified, the function is forced to have at least that much alignment.  All
 923    alignments must be a power of 2.</p>
 924
 925 <h5>Syntax:</h5>
 926 <pre class="doc_code">
 927 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 928        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 929        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 930        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 931        [<a href="#gc">gc</a>] { ... }
 932 </pre>
 933
 934 </div>
 935
 936 <!-- ======================================================================= -->
 937 <div class="doc_subsection">
 938   <a name="aliasstructure">Aliases</a>
 939 </div>
 940
 941 <div class="doc_text">
 942
 943 <p>Aliases act as "second name" for the aliasee value (which can be either
 944    function, global variable, another alias or bitcast of global value). Aliases
 945    may have an optional <a href="#linkage">linkage type</a>, and an
 946    optional <a href="#visibility">visibility style</a>.</p>
 947
 948 <h5>Syntax:</h5>
 949 <pre class="doc_code">
 950 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 951 </pre>
 952
 953 </div>
 954
 955 <!-- ======================================================================= -->
 956 <div class="doc_subsection">
 957   <a name="namedmetadatastructure">Named Metadata</a>
 958 </div>
 959
 960 <div class="doc_text">
 961
 962 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 963    nodes</a> (but not metadata strings) are the only valid operands for
 964    a named metadata.</p>
 965
 966 <h5>Syntax:</h5>
 967 <pre class="doc_code">
 968 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 969 !0 = metadata !{metadata !"zero"}
 970 !1 = metadata !{metadata !"one"}
 971 !2 = metadata !{metadata !"two"}
 972 ; A named metadata.
 973 !name = !{!0, !1, !2}
 974 </pre>
 975
 976 </div>
 977
 978 <!-- ======================================================================= -->
 979 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 980
 981 <div class="doc_text">
 982
 983 <p>The return type and each parameter of a function type may have a set of
 984    <i>parameter attributes</i> associated with them. Parameter attributes are
 985    used to communicate additional information about the result or parameters of
 986    a function. Parameter attributes are considered to be part of the function,
 987    not of the function type, so functions with different parameter attributes
 988    can have the same function type.</p>
 989
 990 <p>Parameter attributes are simple keywords that follow the type specified. If
 991    multiple parameter attributes are needed, they are space separated. For
 992    example:</p>
 993
 994 <pre class="doc_code">
 995 declare i32 @printf(i8* noalias nocapture, ...)
 996 declare i32 @atoi(i8 zeroext)
 997 declare signext i8 @returns_signed_char()
 998 </pre>
 999
1000 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1001    <tt>readonly</tt>) come immediately after the argument list.</p>
1002
1003 <p>Currently, only the following parameter attributes are defined:</p>
1004
1005 <dl>
1006   <dt><tt><b>zeroext</b></tt></dt>
1007   <dd>This indicates to the code generator that the parameter or return value
1008       should be zero-extended to a 32-bit value by the caller (for a parameter)
1009       or the callee (for a return value).</dd>
1010
1011   <dt><tt><b>signext</b></tt></dt>
1012   <dd>This indicates to the code generator that the parameter or return value
1013       should be sign-extended to a 32-bit value by the caller (for a parameter)
1014       or the callee (for a return value).</dd>
1015
1016   <dt><tt><b>inreg</b></tt></dt>
1017   <dd>This indicates that this parameter or return value should be treated in a
1018       special target-dependent fashion during while emitting code for a function
1019       call or return (usually, by putting it in a register as opposed to memory,
1020       though some targets use it to distinguish between two different kinds of
1021       registers).  Use of this attribute is target-specific.</dd>
1022
1023   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1024   <dd>This indicates that the pointer parameter should really be passed by value
1025       to the function.  The attribute implies that a hidden copy of the pointee
1026       is made between the caller and the callee, so the callee is unable to
1027       modify the value in the callee.  This attribute is only valid on LLVM
1028       pointer arguments.  It is generally used to pass structs and arrays by
1029       value, but is also valid on pointers to scalars.  The copy is considered
1030       to belong to the caller not the callee (for example,
1031       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1032       <tt>byval</tt> parameters). This is not a valid attribute for return
1033       values.  The byval attribute also supports specifying an alignment with
1034       the align attribute.  This has a target-specific effect on the code
1035       generator that usually indicates a desired alignment for the synthesized
1036       stack slot.</dd>
1037
1038   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1039   <dd>This indicates that the pointer parameter specifies the address of a
1040       structure that is the return value of the function in the source program.
1041       This pointer must be guaranteed by the caller to be valid: loads and
1042       stores to the structure may be assumed by the callee to not to trap.  This
1043       may only be applied to the first parameter. This is not a valid attribute
1044       for return values. </dd>
1045
1046   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1047   <dd>This indicates that pointer values
1048       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1049       value do not alias pointer values which are not <i>based</i> on it,
1050       ignoring certain "irrelevant" dependencies.
1051       For a call to the parent function, dependencies between memory
1052       references from before or after the call and from those during the call
1053       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1054       return value used in that call.
1055       The caller shares the responsibility with the callee for ensuring that
1056       these requirements are met.
1057       For further details, please see the discussion of the NoAlias response in
1058       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1059 <br>
1060       Note that this definition of <tt>noalias</tt> is intentionally
1061       similar to the definition of <tt>restrict</tt> in C99 for function
1062       arguments, though it is slightly weaker.
1063 <br>
1064       For function return values, C99's <tt>restrict</tt> is not meaningful,
1065       while LLVM's <tt>noalias</tt> is.
1066       </dd>
1067
1068   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1069   <dd>This indicates that the callee does not make any copies of the pointer
1070       that outlive the callee itself. This is not a valid attribute for return
1071       values.</dd>
1072
1073   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1074   <dd>This indicates that the pointer parameter can be excised using the
1075       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1076       attribute for return values.</dd>
1077 </dl>
1078
1079 </div>
1080
1081 <!-- ======================================================================= -->
1082 <div class="doc_subsection">
1083   <a name="gc">Garbage Collector Names</a>
1084 </div>
1085
1086 <div class="doc_text">
1087
1088 <p>Each function may specify a garbage collector name, which is simply a
1089    string:</p>
1090
1091 <pre class="doc_code">
1092 define void @f() gc "name" { ... }
1093 </pre>
1094
1095 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1096    collector which will cause the compiler to alter its output in order to
1097    support the named garbage collection algorithm.</p>
1098
1099 </div>
1100
1101 <!-- ======================================================================= -->
1102 <div class="doc_subsection">
1103   <a name="fnattrs">Function Attributes</a>
1104 </div>
1105
1106 <div class="doc_text">
1107
1108 <p>Function attributes are set to communicate additional information about a
1109    function. Function attributes are considered to be part of the function, not
1110    of the function type, so functions with different parameter attributes can
1111    have the same function type.</p>
1112
1113 <p>Function attributes are simple keywords that follow the type specified. If
1114    multiple attributes are needed, they are space separated. For example:</p>
1115
1116 <pre class="doc_code">
1117 define void @f() noinline { ... }
1118 define void @f() alwaysinline { ... }
1119 define void @f() alwaysinline optsize { ... }
1120 define void @f() optsize { ... }
1121 </pre>
1122
1123 <dl>
1124   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1125   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1126       the backend should forcibly align the stack pointer. Specify the
1127       desired alignment, which must be a power of two, in parentheses.
1128
1129   <dt><tt><b>alwaysinline</b></tt></dt>
1130   <dd>This attribute indicates that the inliner should attempt to inline this
1131       function into callers whenever possible, ignoring any active inlining size
1132       threshold for this caller.</dd>
1133
1134   <dt><tt><b>hotpatch</b></tt></dt>
1135   <dd>This attribute indicates that the function should be 'hotpatchable',
1136       meaning the function can be patched and/or hooked even while it is
1137       loaded into memory. On x86, the function prologue will be preceded
1138       by six bytes of padding and will begin with a two-byte instruction.
1139       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1140       higher were compiled in this fashion.</dd>
1141
1142   <dt><tt><b>inlinehint</b></tt></dt>
1143   <dd>This attribute indicates that the source code contained a hint that inlining
1144       this function is desirable (such as the "inline" keyword in C/C++).  It
1145       is just a hint; it imposes no requirements on the inliner.</dd>
1146
1147   <dt><tt><b>naked</b></tt></dt>
1148   <dd>This attribute disables prologue / epilogue emission for the function.
1149       This can have very system-specific consequences.</dd>
1150
1151   <dt><tt><b>noimplicitfloat</b></tt></dt>
1152   <dd>This attributes disables implicit floating point instructions.</dd>
1153
1154   <dt><tt><b>noinline</b></tt></dt>
1155   <dd>This attribute indicates that the inliner should never inline this
1156       function in any situation. This attribute may not be used together with
1157       the <tt>alwaysinline</tt> attribute.</dd>
1158
1159   <dt><tt><b>noredzone</b></tt></dt>
1160   <dd>This attribute indicates that the code generator should not use a red
1161       zone, even if the target-specific ABI normally permits it.</dd>
1162
1163   <dt><tt><b>noreturn</b></tt></dt>
1164   <dd>This function attribute indicates that the function never returns
1165       normally.  This produces undefined behavior at runtime if the function
1166       ever does dynamically return.</dd>
1167
1168   <dt><tt><b>nounwind</b></tt></dt>
1169   <dd>This function attribute indicates that the function never returns with an
1170       unwind or exceptional control flow.  If the function does unwind, its
1171       runtime behavior is undefined.</dd>
1172
1173   <dt><tt><b>optsize</b></tt></dt>
1174   <dd>This attribute suggests that optimization passes and code generator passes
1175       make choices that keep the code size of this function low, and otherwise
1176       do optimizations specifically to reduce code size.</dd>
1177
1178   <dt><tt><b>readnone</b></tt></dt>
1179   <dd>This attribute indicates that the function computes its result (or decides
1180       to unwind an exception) based strictly on its arguments, without
1181       dereferencing any pointer arguments or otherwise accessing any mutable
1182       state (e.g. memory, control registers, etc) visible to caller functions.
1183       It does not write through any pointer arguments
1184       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1185       changes any state visible to callers.  This means that it cannot unwind
1186       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1187       could use the <tt>unwind</tt> instruction.</dd>
1188
1189   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1190   <dd>This attribute indicates that the function does not write through any
1191       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1192       arguments) or otherwise modify any state (e.g. memory, control registers,
1193       etc) visible to caller functions.  It may dereference pointer arguments
1194       and read state that may be set in the caller.  A readonly function always
1195       returns the same value (or unwinds an exception identically) when called
1196       with the same set of arguments and global state.  It cannot unwind an
1197       exception by calling the <tt>C++</tt> exception throwing methods, but may
1198       use the <tt>unwind</tt> instruction.</dd>
1199
1200   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1201   <dd>This attribute indicates that the function should emit a stack smashing
1202       protector. It is in the form of a "canary"&mdash;a random value placed on
1203       the stack before the local variables that's checked upon return from the
1204       function to see if it has been overwritten. A heuristic is used to
1205       determine if a function needs stack protectors or not.<br>
1206 <br>
1207       If a function that has an <tt>ssp</tt> attribute is inlined into a
1208       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1209       function will have an <tt>ssp</tt> attribute.</dd>
1210
1211   <dt><tt><b>sspreq</b></tt></dt>
1212   <dd>This attribute indicates that the function should <em>always</em> emit a
1213       stack smashing protector. This overrides
1214       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1215 <br>
1216       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1217       function that doesn't have an <tt>sspreq</tt> attribute or which has
1218       an <tt>ssp</tt> attribute, then the resulting function will have
1219       an <tt>sspreq</tt> attribute.</dd>
1220 </dl>
1221
1222 </div>
1223
1224 <!-- ======================================================================= -->
1225 <div class="doc_subsection">
1226   <a name="moduleasm">Module-Level Inline Assembly</a>
1227 </div>
1228
1229 <div class="doc_text">
1230
1231 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1232    the GCC "file scope inline asm" blocks.  These blocks are internally
1233    concatenated by LLVM and treated as a single unit, but may be separated in
1234    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1235
1236 <pre class="doc_code">
1237 module asm "inline asm code goes here"
1238 module asm "more can go here"
1239 </pre>
1240
1241 <p>The strings can contain any character by escaping non-printable characters.
1242    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1243    for the number.</p>
1244
1245 <p>The inline asm code is simply printed to the machine code .s file when
1246    assembly code is generated.</p>
1247
1248 </div>
1249
1250 <!-- ======================================================================= -->
1251 <div class="doc_subsection">
1252   <a name="datalayout">Data Layout</a>
1253 </div>
1254
1255 <div class="doc_text">
1256
1257 <p>A module may specify a target specific data layout string that specifies how
1258    data is to be laid out in memory. The syntax for the data layout is
1259    simply:</p>
1260
1261 <pre class="doc_code">
1262 target datalayout = "<i>layout specification</i>"
1263 </pre>
1264
1265 <p>The <i>layout specification</i> consists of a list of specifications
1266    separated by the minus sign character ('-').  Each specification starts with
1267    a letter and may include other information after the letter to define some
1268    aspect of the data layout.  The specifications accepted are as follows:</p>
1269
1270 <dl>
1271   <dt><tt>E</tt></dt>
1272   <dd>Specifies that the target lays out data in big-endian form. That is, the
1273       bits with the most significance have the lowest address location.</dd>
1274
1275   <dt><tt>e</tt></dt>
1276   <dd>Specifies that the target lays out data in little-endian form. That is,
1277       the bits with the least significance have the lowest address
1278       location.</dd>
1279
1280   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1281   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1282       <i>preferred</i> alignments. All sizes are in bits. Specifying
1283       the <i>pref</i> alignment is optional. If omitted, the
1284       preceding <tt>:</tt> should be omitted too.</dd>
1285
1286   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1287   <dd>This specifies the alignment for an integer type of a given bit
1288       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1289
1290   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1291   <dd>This specifies the alignment for a vector type of a given bit
1292       <i>size</i>.</dd>
1293
1294   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1295   <dd>This specifies the alignment for a floating point type of a given bit
1296       <i>size</i>. Only values of <i>size</i> that are supported by the target
1297       will work.  32 (float) and 64 (double) are supported on all targets;
1298       80 or 128 (different flavors of long double) are also supported on some
1299       targets.
1300
1301   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1302   <dd>This specifies the alignment for an aggregate type of a given bit
1303       <i>size</i>.</dd>
1304
1305   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1306   <dd>This specifies the alignment for a stack object of a given bit
1307       <i>size</i>.</dd>
1308
1309   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1310   <dd>This specifies a set of native integer widths for the target CPU
1311       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1312       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1313       this set are considered to support most general arithmetic
1314       operations efficiently.</dd>
1315 </dl>
1316
1317 <p>When constructing the data layout for a given target, LLVM starts with a
1318    default set of specifications which are then (possibly) overridden by the
1319    specifications in the <tt>datalayout</tt> keyword. The default specifications
1320    are given in this list:</p>
1321
1322 <ul>
1323   <li><tt>E</tt> - big endian</li>
1324   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1325   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1326   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1327   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1328   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1329   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1330   alignment of 64-bits</li>
1331   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1332   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1333   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1334   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1335   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1336   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1337 </ul>
1338
1339 <p>When LLVM is determining the alignment for a given type, it uses the
1340    following rules:</p>
1341
1342 <ol>
1343   <li>If the type sought is an exact match for one of the specifications, that
1344       specification is used.</li>
1345
1346   <li>If no match is found, and the type sought is an integer type, then the
1347       smallest integer type that is larger than the bitwidth of the sought type
1348       is used. If none of the specifications are larger than the bitwidth then
1349       the the largest integer type is used. For example, given the default
1350       specifications above, the i7 type will use the alignment of i8 (next
1351       largest) while both i65 and i256 will use the alignment of i64 (largest
1352       specified).</li>
1353
1354   <li>If no match is found, and the type sought is a vector type, then the
1355       largest vector type that is smaller than the sought vector type will be
1356       used as a fall back.  This happens because &lt;128 x double&gt; can be
1357       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1358 </ol>
1359
1360 </div>
1361
1362 <!-- ======================================================================= -->
1363 <div class="doc_subsection">
1364   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1365 </div>
1366
1367 <div class="doc_text">
1368
1369 <p>Any memory access must be done through a pointer value associated
1370 with an address range of the memory access, otherwise the behavior
1371 is undefined. Pointer values are associated with address ranges
1372 according to the following rules:</p>
1373
1374 <ul>
1375   <li>A pointer value is associated with the addresses associated with
1376       any value it is <i>based</i> on.
1377   <li>An address of a global variable is associated with the address
1378       range of the variable's storage.</li>
1379   <li>The result value of an allocation instruction is associated with
1380       the address range of the allocated storage.</li>
1381   <li>A null pointer in the default address-space is associated with
1382       no address.</li>
1383   <li>An integer constant other than zero or a pointer value returned
1384       from a function not defined within LLVM may be associated with address
1385       ranges allocated through mechanisms other than those provided by
1386       LLVM. Such ranges shall not overlap with any ranges of addresses
1387       allocated by mechanisms provided by LLVM.</li>
1388 </ul>
1389
1390 <p>A pointer value is <i>based</i> on another pointer value according
1391    to the following rules:</p>
1392
1393 <ul>
1394   <li>A pointer value formed from a
1395       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1396       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1397   <li>The result value of a
1398       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1399       of the <tt>bitcast</tt>.</li>
1400   <li>A pointer value formed by an
1401       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1402       pointer values that contribute (directly or indirectly) to the
1403       computation of the pointer's value.</li>
1404   <li>The "<i>based</i> on" relationship is transitive.</li>
1405 </ul>
1406
1407 <p>Note that this definition of <i>"based"</i> is intentionally
1408    similar to the definition of <i>"based"</i> in C99, though it is
1409    slightly weaker.</p>
1410
1411 <p>LLVM IR does not associate types with memory. The result type of a
1412 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1413 alignment of the memory from which to load, as well as the
1414 interpretation of the value. The first operand type of a
1415 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1416 and alignment of the store.</p>
1417
1418 <p>Consequently, type-based alias analysis, aka TBAA, aka
1419 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1420 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1421 additional information which specialized optimization passes may use
1422 to implement type-based alias analysis.</p>
1423
1424 </div>
1425
1426 <!-- ======================================================================= -->
1427 <div class="doc_subsection">
1428   <a name="volatile">Volatile Memory Accesses</a>
1429 </div>
1430
1431 <div class="doc_text">
1432
1433 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1434 href="#i_store"><tt>store</tt></a>s, and <a
1435 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1436 The optimizers must not change the number of volatile operations or change their
1437 order of execution relative to other volatile operations.  The optimizers
1438 <i>may</i> change the order of volatile operations relative to non-volatile
1439 operations.  This is not Java's "volatile" and has no cross-thread
1440 synchronization behavior.</p>
1441
1442 </div>
1443
1444 <!-- *********************************************************************** -->
1445 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
1446 <!-- *********************************************************************** -->
1447
1448 <div class="doc_text">
1449
1450 <p>The LLVM type system is one of the most important features of the
1451    intermediate representation.  Being typed enables a number of optimizations
1452    to be performed on the intermediate representation directly, without having
1453    to do extra analyses on the side before the transformation.  A strong type
1454    system makes it easier to read the generated code and enables novel analyses
1455    and transformations that are not feasible to perform on normal three address
1456    code representations.</p>
1457
1458 </div>
1459
1460 <!-- ======================================================================= -->
1461 <div class="doc_subsection"> <a name="t_classifications">Type
1462 Classifications</a> </div>
1463
1464 <div class="doc_text">
1465
1466 <p>The types fall into a few useful classifications:</p>
1467
1468 <table border="1" cellspacing="0" cellpadding="4">
1469   <tbody>
1470     <tr><th>Classification</th><th>Types</th></tr>
1471     <tr>
1472       <td><a href="#t_integer">integer</a></td>
1473       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1474     </tr>
1475     <tr>
1476       <td><a href="#t_floating">floating point</a></td>
1477       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1478     </tr>
1479     <tr>
1480       <td><a name="t_firstclass">first class</a></td>
1481       <td><a href="#t_integer">integer</a>,
1482           <a href="#t_floating">floating point</a>,
1483           <a href="#t_pointer">pointer</a>,
1484           <a href="#t_vector">vector</a>,
1485           <a href="#t_struct">structure</a>,
1486           <a href="#t_array">array</a>,
1487           <a href="#t_label">label</a>,
1488           <a href="#t_metadata">metadata</a>.
1489       </td>
1490     </tr>
1491     <tr>
1492       <td><a href="#t_primitive">primitive</a></td>
1493       <td><a href="#t_label">label</a>,
1494           <a href="#t_void">void</a>,
1495           <a href="#t_floating">floating point</a>,
1496           <a href="#t_x86mmx">x86mmx</a>,
1497           <a href="#t_metadata">metadata</a>.</td>
1498     </tr>
1499     <tr>
1500       <td><a href="#t_derived">derived</a></td>
1501       <td><a href="#t_array">array</a>,
1502           <a href="#t_function">function</a>,
1503           <a href="#t_pointer">pointer</a>,
1504           <a href="#t_struct">structure</a>,
1505           <a href="#t_pstruct">packed structure</a>,
1506           <a href="#t_vector">vector</a>,
1507           <a href="#t_opaque">opaque</a>.
1508       </td>
1509     </tr>
1510   </tbody>
1511 </table>
1512
1513 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1514    important.  Values of these types are the only ones which can be produced by
1515    instructions.</p>
1516
1517 </div>
1518
1519 <!-- ======================================================================= -->
1520 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
1521
1522 <div class="doc_text">
1523
1524 <p>The primitive types are the fundamental building blocks of the LLVM
1525    system.</p>
1526
1527 </div>
1528
1529 <!-- _______________________________________________________________________ -->
1530 <div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
1531
1532 <div class="doc_text">
1533
1534 <h5>Overview:</h5>
1535 <p>The integer type is a very simple type that simply specifies an arbitrary
1536    bit width for the integer type desired. Any bit width from 1 bit to
1537    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1538
1539 <h5>Syntax:</h5>
1540 <pre>
1541   iN
1542 </pre>
1543
1544 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1545    value.</p>
1546
1547 <h5>Examples:</h5>
1548 <table class="layout">
1549   <tr class="layout">
1550     <td class="left"><tt>i1</tt></td>
1551     <td class="left">a single-bit integer.</td>
1552   </tr>
1553   <tr class="layout">
1554     <td class="left"><tt>i32</tt></td>
1555     <td class="left">a 32-bit integer.</td>
1556   </tr>
1557   <tr class="layout">
1558     <td class="left"><tt>i1942652</tt></td>
1559     <td class="left">a really big integer of over 1 million bits.</td>
1560   </tr>
1561 </table>
1562
1563 </div>
1564
1565 <!-- _______________________________________________________________________ -->
1566 <div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
1567
1568 <div class="doc_text">
1569
1570 <table>
1571   <tbody>
1572     <tr><th>Type</th><th>Description</th></tr>
1573     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1574     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1575     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1576     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1577     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1578   </tbody>
1579 </table>
1580
1581 </div>
1582
1583 <!-- _______________________________________________________________________ -->
1584 <div class="doc_subsubsection"> <a name="t_x86mmx">X86mmx Type</a> </div>
1585
1586 <div class="doc_text">
1587
1588 <h5>Overview:</h5>
1589 <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>
1590
1591 <h5>Syntax:</h5>
1592 <pre>
1593   x86mmx
1594 </pre>
1595
1596 </div>
1597
1598 <!-- _______________________________________________________________________ -->
1599 <div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
1600
1601 <div class="doc_text">
1602
1603 <h5>Overview:</h5>
1604 <p>The void type does not represent any value and has no size.</p>
1605
1606 <h5>Syntax:</h5>
1607 <pre>
1608   void
1609 </pre>
1610
1611 </div>
1612
1613 <!-- _______________________________________________________________________ -->
1614 <div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
1615
1616 <div class="doc_text">
1617
1618 <h5>Overview:</h5>
1619 <p>The label type represents code labels.</p>
1620
1621 <h5>Syntax:</h5>
1622 <pre>
1623   label
1624 </pre>
1625
1626 </div>
1627
1628 <!-- _______________________________________________________________________ -->
1629 <div class="doc_subsubsection"> <a name="t_metadata">Metadata Type</a> </div>
1630
1631 <div class="doc_text">
1632
1633 <h5>Overview:</h5>
1634 <p>The metadata type represents embedded metadata. No derived types may be
1635    created from metadata except for <a href="#t_function">function</a>
1636    arguments.
1637
1638 <h5>Syntax:</h5>
1639 <pre>
1640   metadata
1641 </pre>
1642
1643 </div>
1644
1645
1646 <!-- ======================================================================= -->
1647 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
1648
1649 <div class="doc_text">
1650
1651 <p>The real power in LLVM comes from the derived types in the system.  This is
1652    what allows a programmer to represent arrays, functions, pointers, and other
1653    useful types.  Each of these types contain one or more element types which
1654    may be a primitive type, or another derived type.  For example, it is
1655    possible to have a two dimensional array, using an array as the element type
1656    of another array.</p>
1657
1658
1659 </div>
1660
1661 <!-- _______________________________________________________________________ -->
1662 <div class="doc_subsubsection"> <a name="t_aggregate">Aggregate Types</a> </div>
1663
1664 <div class="doc_text">
1665
1666 <p>Aggregate Types are a subset of derived types that can contain multiple
1667   member types. <a href="#t_array">Arrays</a>,
1668   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1669   aggregate types.</p>
1670
1671 </div>
1672
1673 <!-- _______________________________________________________________________ -->
1674 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
1675
1676 <div class="doc_text">
1677
1678 <h5>Overview:</h5>
1679 <p>The array type is a very simple derived type that arranges elements
1680    sequentially in memory.  The array type requires a size (number of elements)
1681    and an underlying data type.</p>
1682
1683 <h5>Syntax:</h5>
1684 <pre>
1685   [&lt;# elements&gt; x &lt;elementtype&gt;]
1686 </pre>
1687
1688 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1689    be any type with a size.</p>
1690
1691 <h5>Examples:</h5>
1692 <table class="layout">
1693   <tr class="layout">
1694     <td class="left"><tt>[40 x i32]</tt></td>
1695     <td class="left">Array of 40 32-bit integer values.</td>
1696   </tr>
1697   <tr class="layout">
1698     <td class="left"><tt>[41 x i32]</tt></td>
1699     <td class="left">Array of 41 32-bit integer values.</td>
1700   </tr>
1701   <tr class="layout">
1702     <td class="left"><tt>[4 x i8]</tt></td>
1703     <td class="left">Array of 4 8-bit integer values.</td>
1704   </tr>
1705 </table>
1706 <p>Here are some examples of multidimensional arrays:</p>
1707 <table class="layout">
1708   <tr class="layout">
1709     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1710     <td class="left">3x4 array of 32-bit integer values.</td>
1711   </tr>
1712   <tr class="layout">
1713     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1714     <td class="left">12x10 array of single precision floating point values.</td>
1715   </tr>
1716   <tr class="layout">
1717     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1718     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1719   </tr>
1720 </table>
1721
1722 <p>There is no restriction on indexing beyond the end of the array implied by
1723    a static type (though there are restrictions on indexing beyond the bounds
1724    of an allocated object in some cases). This means that single-dimension
1725    'variable sized array' addressing can be implemented in LLVM with a zero
1726    length array type. An implementation of 'pascal style arrays' in LLVM could
1727    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1728
1729 </div>
1730
1731 <!-- _______________________________________________________________________ -->
1732 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
1733
1734 <div class="doc_text">
1735
1736 <h5>Overview:</h5>
1737 <p>The function type can be thought of as a function signature.  It consists of
1738    a return type and a list of formal parameter types. The return type of a
1739    function type is a first class type or a void type.</p>
1740
1741 <h5>Syntax:</h5>
1742 <pre>
1743   &lt;returntype&gt; (&lt;parameter list&gt;)
1744 </pre>
1745
1746 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1747    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1748    which indicates that the function takes a variable number of arguments.
1749    Variable argument functions can access their arguments with
1750    the <a href="#int_varargs">variable argument handling intrinsic</a>
1751    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1752    <a href="#t_label">label</a>.</p>
1753
1754 <h5>Examples:</h5>
1755 <table class="layout">
1756   <tr class="layout">
1757     <td class="left"><tt>i32 (i32)</tt></td>
1758     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1759     </td>
1760   </tr><tr class="layout">
1761     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1762     </tt></td>
1763     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1764       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1765       returning <tt>float</tt>.
1766     </td>
1767   </tr><tr class="layout">
1768     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1769     <td class="left">A vararg function that takes at least one
1770       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
1771       which returns an integer.  This is the signature for <tt>printf</tt> in
1772       LLVM.
1773     </td>
1774   </tr><tr class="layout">
1775     <td class="left"><tt>{i32, i32} (i32)</tt></td>
1776     <td class="left">A function taking an <tt>i32</tt>, returning a
1777         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
1778     </td>
1779   </tr>
1780 </table>
1781
1782 </div>
1783
1784 <!-- _______________________________________________________________________ -->
1785 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
1786
1787 <div class="doc_text">
1788
1789 <h5>Overview:</h5>
1790 <p>The structure type is used to represent a collection of data members together
1791    in memory.  The packing of the field types is defined to match the ABI of the
1792    underlying processor.  The elements of a structure may be any type that has a
1793    size.</p>
1794
1795 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
1796    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
1797    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
1798    Structures in registers are accessed using the
1799    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
1800    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
1801 <h5>Syntax:</h5>
1802 <pre>
1803   { &lt;type list&gt; }
1804 </pre>
1805
1806 <h5>Examples:</h5>
1807 <table class="layout">
1808   <tr class="layout">
1809     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
1810     <td class="left">A triple of three <tt>i32</tt> values</td>
1811   </tr><tr class="layout">
1812     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
1813     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1814       second element is a <a href="#t_pointer">pointer</a> to a
1815       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1816       an <tt>i32</tt>.</td>
1817   </tr>
1818 </table>
1819
1820 </div>
1821
1822 <!-- _______________________________________________________________________ -->
1823 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1824 </div>
1825
1826 <div class="doc_text">
1827
1828 <h5>Overview:</h5>
1829 <p>The packed structure type is used to represent a collection of data members
1830    together in memory.  There is no padding between fields.  Further, the
1831    alignment of a packed structure is 1 byte.  The elements of a packed
1832    structure may be any type that has a size.</p>
1833
1834 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt> and
1835    '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field with
1836    the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
1837
1838 <h5>Syntax:</h5>
1839 <pre>
1840   &lt; { &lt;type list&gt; } &gt;
1841 </pre>
1842
1843 <h5>Examples:</h5>
1844 <table class="layout">
1845   <tr class="layout">
1846     <td class="left"><tt>&lt; { i32, i32, i32 } &gt;</tt></td>
1847     <td class="left">A triple of three <tt>i32</tt> values</td>
1848   </tr><tr class="layout">
1849   <td class="left">
1850 <tt>&lt;&nbsp;{&nbsp;float,&nbsp;i32&nbsp;(i32)*&nbsp;}&nbsp;&gt;</tt></td>
1851     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1852       second element is a <a href="#t_pointer">pointer</a> to a
1853       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1854       an <tt>i32</tt>.</td>
1855   </tr>
1856 </table>
1857
1858 </div>
1859
1860 <!-- _______________________________________________________________________ -->
1861 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1862
1863 <div class="doc_text">
1864
1865 <h5>Overview:</h5>
1866 <p>The pointer type is used to specify memory locations.
1867    Pointers are commonly used to reference objects in memory.</p>
1868
1869 <p>Pointer types may have an optional address space attribute defining the
1870    numbered address space where the pointed-to object resides. The default
1871    address space is number zero. The semantics of non-zero address
1872    spaces are target-specific.</p>
1873
1874 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
1875    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
1876
1877 <h5>Syntax:</h5>
1878 <pre>
1879   &lt;type&gt; *
1880 </pre>
1881
1882 <h5>Examples:</h5>
1883 <table class="layout">
1884   <tr class="layout">
1885     <td class="left"><tt>[4 x i32]*</tt></td>
1886     <td class="left">A <a href="#t_pointer">pointer</a> to <a
1887                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
1888   </tr>
1889   <tr class="layout">
1890     <td class="left"><tt>i32 (i32*) *</tt></td>
1891     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
1892       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1893       <tt>i32</tt>.</td>
1894   </tr>
1895   <tr class="layout">
1896     <td class="left"><tt>i32 addrspace(5)*</tt></td>
1897     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
1898      that resides in address space #5.</td>
1899   </tr>
1900 </table>
1901
1902 </div>
1903
1904 <!-- _______________________________________________________________________ -->
1905 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1906
1907 <div class="doc_text">
1908
1909 <h5>Overview:</h5>
1910 <p>A vector type is a simple derived type that represents a vector of elements.
1911    Vector types are used when multiple primitive data are operated in parallel
1912    using a single instruction (SIMD).  A vector type requires a size (number of
1913    elements) and an underlying primitive data type.  Vector types are considered
1914    <a href="#t_firstclass">first class</a>.</p>
1915
1916 <h5>Syntax:</h5>
1917 <pre>
1918   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1919 </pre>
1920
1921 <p>The number of elements is a constant integer value larger than 0; elementtype
1922    may be any integer or floating point type.  Vectors of size zero are not
1923    allowed, and pointers are not allowed as the element type.</p>
1924
1925 <h5>Examples:</h5>
1926 <table class="layout">
1927   <tr class="layout">
1928     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
1929     <td class="left">Vector of 4 32-bit integer values.</td>
1930   </tr>
1931   <tr class="layout">
1932     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
1933     <td class="left">Vector of 8 32-bit floating-point values.</td>
1934   </tr>
1935   <tr class="layout">
1936     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
1937     <td class="left">Vector of 2 64-bit integer values.</td>
1938   </tr>
1939 </table>
1940
1941 </div>
1942
1943 <!-- _______________________________________________________________________ -->
1944 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1945 <div class="doc_text">
1946
1947 <h5>Overview:</h5>
1948 <p>Opaque types are used to represent unknown types in the system.  This
1949    corresponds (for example) to the C notion of a forward declared structure
1950    type.  In LLVM, opaque types can eventually be resolved to any type (not just
1951    a structure type).</p>
1952
1953 <h5>Syntax:</h5>
1954 <pre>
1955   opaque
1956 </pre>
1957
1958 <h5>Examples:</h5>
1959 <table class="layout">
1960   <tr class="layout">
1961     <td class="left"><tt>opaque</tt></td>
1962     <td class="left">An opaque type.</td>
1963   </tr>
1964 </table>
1965
1966 </div>
1967
1968 <!-- ======================================================================= -->
1969 <div class="doc_subsection">
1970   <a name="t_uprefs">Type Up-references</a>
1971 </div>
1972
1973 <div class="doc_text">
1974
1975 <h5>Overview:</h5>
1976 <p>An "up reference" allows you to refer to a lexically enclosing type without
1977    requiring it to have a name. For instance, a structure declaration may
1978    contain a pointer to any of the types it is lexically a member of.  Example
1979    of up references (with their equivalent as named type declarations)
1980    include:</p>
1981
1982 <pre>
1983    { \2 * }                %x = type { %x* }
1984    { \2 }*                 %y = type { %y }*
1985    \1*                     %z = type %z*
1986 </pre>
1987
1988 <p>An up reference is needed by the asmprinter for printing out cyclic types
1989    when there is no declared name for a type in the cycle.  Because the
1990    asmprinter does not want to print out an infinite type string, it needs a
1991    syntax to handle recursive types that have no names (all names are optional
1992    in llvm IR).</p>
1993
1994 <h5>Syntax:</h5>
1995 <pre>
1996    \&lt;level&gt;
1997 </pre>
1998
1999 <p>The level is the count of the lexical type that is being referred to.</p>
2000
2001 <h5>Examples:</h5>
2002 <table class="layout">
2003   <tr class="layout">
2004     <td class="left"><tt>\1*</tt></td>
2005     <td class="left">Self-referential pointer.</td>
2006   </tr>
2007   <tr class="layout">
2008     <td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
2009     <td class="left">Recursive structure where the upref refers to the out-most
2010                      structure.</td>
2011   </tr>
2012 </table>
2013
2014 </div>
2015
2016 <!-- *********************************************************************** -->
2017 <div class="doc_section"> <a name="constants">Constants</a> </div>
2018 <!-- *********************************************************************** -->
2019
2020 <div class="doc_text">
2021
2022 <p>LLVM has several different basic types of constants.  This section describes
2023    them all and their syntax.</p>
2024
2025 </div>
2026
2027 <!-- ======================================================================= -->
2028 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
2029
2030 <div class="doc_text">
2031
2032 <dl>
2033   <dt><b>Boolean constants</b></dt>
2034   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2035       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2036
2037   <dt><b>Integer constants</b></dt>
2038   <dd>Standard integers (such as '4') are constants of
2039       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2040       with integer types.</dd>
2041
2042   <dt><b>Floating point constants</b></dt>
2043   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2044       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2045       notation (see below).  The assembler requires the exact decimal value of a
2046       floating-point constant.  For example, the assembler accepts 1.25 but
2047       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2048       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2049
2050   <dt><b>Null pointer constants</b></dt>
2051   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2052       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2053 </dl>
2054
2055 <p>The one non-intuitive notation for constants is the hexadecimal form of
2056    floating point constants.  For example, the form '<tt>double
2057    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2058    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2059    constants are required (and the only time that they are generated by the
2060    disassembler) is when a floating point constant must be emitted but it cannot
2061    be represented as a decimal floating point number in a reasonable number of
2062    digits.  For example, NaN's, infinities, and other special values are
2063    represented in their IEEE hexadecimal format so that assembly and disassembly
2064    do not cause any bits to change in the constants.</p>
2065
2066 <p>When using the hexadecimal form, constants of types float and double are
2067    represented using the 16-digit form shown above (which matches the IEEE754
2068    representation for double); float values must, however, be exactly
2069    representable as IEE754 single precision.  Hexadecimal format is always used
2070    for long double, and there are three forms of long double.  The 80-bit format
2071    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2072    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2073    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2074    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2075    currently supported target uses this format.  Long doubles will only work if
2076    they match the long double format on your target.  All hexadecimal formats
2077    are big-endian (sign bit at the left).</p>
2078
2079 <p>There are no constants of type x86mmx.</p>
2080 </div>
2081
2082 <!-- ======================================================================= -->
2083 <div class="doc_subsection">
2084 <a name="aggregateconstants"></a> <!-- old anchor -->
2085 <a name="complexconstants">Complex Constants</a>
2086 </div>
2087
2088 <div class="doc_text">
2089
2090 <p>Complex constants are a (potentially recursive) combination of simple
2091    constants and smaller complex constants.</p>
2092
2093 <dl>
2094   <dt><b>Structure constants</b></dt>
2095   <dd>Structure constants are represented with notation similar to structure
2096       type definitions (a comma separated list of elements, surrounded by braces
2097       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2098       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2099       Structure constants must have <a href="#t_struct">structure type</a>, and
2100       the number and types of elements must match those specified by the
2101       type.</dd>
2102
2103   <dt><b>Array constants</b></dt>
2104   <dd>Array constants are represented with notation similar to array type
2105      definitions (a comma separated list of elements, surrounded by square
2106      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2107      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2108      the number and types of elements must match those specified by the
2109      type.</dd>
2110
2111   <dt><b>Vector constants</b></dt>
2112   <dd>Vector constants are represented with notation similar to vector type
2113       definitions (a comma separated list of elements, surrounded by
2114       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2115       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2116       have <a href="#t_vector">vector type</a>, and the number and types of
2117       elements must match those specified by the type.</dd>
2118
2119   <dt><b>Zero initialization</b></dt>
2120   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2121       value to zero of <em>any</em> type, including scalar and
2122       <a href="#t_aggregate">aggregate</a> types.
2123       This is often used to avoid having to print large zero initializers
2124       (e.g. for large arrays) and is always exactly equivalent to using explicit
2125       zero initializers.</dd>
2126
2127   <dt><b>Metadata node</b></dt>
2128   <dd>A metadata node is a structure-like constant with
2129       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2130       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2131       be interpreted as part of the instruction stream, metadata is a place to
2132       attach additional information such as debug info.</dd>
2133 </dl>
2134
2135 </div>
2136
2137 <!-- ======================================================================= -->
2138 <div class="doc_subsection">
2139   <a name="globalconstants">Global Variable and Function Addresses</a>
2140 </div>
2141
2142 <div class="doc_text">
2143
2144 <p>The addresses of <a href="#globalvars">global variables</a>
2145    and <a href="#functionstructure">functions</a> are always implicitly valid
2146    (link-time) constants.  These constants are explicitly referenced when
2147    the <a href="#identifiers">identifier for the global</a> is used and always
2148    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2149    legal LLVM file:</p>
2150
2151 <pre class="doc_code">
2152 @X = global i32 17
2153 @Y = global i32 42
2154 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2155 </pre>
2156
2157 </div>
2158
2159 <!-- ======================================================================= -->
2160 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
2161 <div class="doc_text">
2162
2163 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2164    indicates that the user of the value may receive an unspecified bit-pattern.
2165    Undefined values may be of any type (other than '<tt>label</tt>'
2166    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2167
2168 <p>Undefined values are useful because they indicate to the compiler that the
2169    program is well defined no matter what value is used.  This gives the
2170    compiler more freedom to optimize.  Here are some examples of (potentially
2171    surprising) transformations that are valid (in pseudo IR):</p>
2172
2173
2174 <pre class="doc_code">
2175   %A = add %X, undef
2176   %B = sub %X, undef
2177   %C = xor %X, undef
2178 Safe:
2179   %A = undef
2180   %B = undef
2181   %C = undef
2182 </pre>
2183
2184 <p>This is safe because all of the output bits are affected by the undef bits.
2185    Any output bit can have a zero or one depending on the input bits.</p>
2186
2187 <pre class="doc_code">
2188   %A = or %X, undef
2189   %B = and %X, undef
2190 Safe:
2191   %A = -1
2192   %B = 0
2193 Unsafe:
2194   %A = undef
2195   %B = undef
2196 </pre>
2197
2198 <p>These logical operations have bits that are not always affected by the input.
2199    For example, if <tt>%X</tt> has a zero bit, then the output of the
2200    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2201    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2202    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2203    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2204    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2205    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2206    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2207
2208 <pre class="doc_code">
2209   %A = select undef, %X, %Y
2210   %B = select undef, 42, %Y
2211   %C = select %X, %Y, undef
2212 Safe:
2213   %A = %X     (or %Y)
2214   %B = 42     (or %Y)
2215   %C = %Y
2216 Unsafe:
2217   %A = undef
2218   %B = undef
2219   %C = undef
2220 </pre>
2221
2222 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2223    branch) conditions can go <em>either way</em>, but they have to come from one
2224    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2225    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2226    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2227    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2228    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2229    eliminated.</p>
2230
2231 <pre class="doc_code">
2232   %A = xor undef, undef
2233
2234   %B = undef
2235   %C = xor %B, %B
2236
2237   %D = undef
2238   %E = icmp lt %D, 4
2239   %F = icmp gte %D, 4
2240
2241 Safe:
2242   %A = undef
2243   %B = undef
2244   %C = undef
2245   %D = undef
2246   %E = undef
2247   %F = undef
2248 </pre>
2249
2250 <p>This example points out that two '<tt>undef</tt>' operands are not
2251    necessarily the same. This can be surprising to people (and also matches C
2252    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2253    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2254    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2255    its value over its "live range".  This is true because the variable doesn't
2256    actually <em>have a live range</em>. Instead, the value is logically read
2257    from arbitrary registers that happen to be around when needed, so the value
2258    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2259    need to have the same semantics or the core LLVM "replace all uses with"
2260    concept would not hold.</p>
2261
2262 <pre class="doc_code">
2263   %A = fdiv undef, %X
2264   %B = fdiv %X, undef
2265 Safe:
2266   %A = undef
2267 b: unreachable
2268 </pre>
2269
2270 <p>These examples show the crucial difference between an <em>undefined
2271   value</em> and <em>undefined behavior</em>. An undefined value (like
2272   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2273   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2274   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2275   defined on SNaN's. However, in the second example, we can make a more
2276   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2277   arbitrary value, we are allowed to assume that it could be zero. Since a
2278   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2279   the operation does not execute at all. This allows us to delete the divide and
2280   all code after it. Because the undefined operation "can't happen", the
2281   optimizer can assume that it occurs in dead code.</p>
2282
2283 <pre class="doc_code">
2284 a:  store undef -> %X
2285 b:  store %X -> undef
2286 Safe:
2287 a: &lt;deleted&gt;
2288 b: unreachable
2289 </pre>
2290
2291 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2292    undefined value can be assumed to not have any effect; we can assume that the
2293    value is overwritten with bits that happen to match what was already there.
2294    However, a store <em>to</em> an undefined location could clobber arbitrary
2295    memory, therefore, it has undefined behavior.</p>
2296
2297 </div>
2298
2299 <!-- ======================================================================= -->
2300 <div class="doc_subsection"><a name="trapvalues">Trap Values</a></div>
2301 <div class="doc_text">
2302
2303 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2304    instead of representing an unspecified bit pattern, they represent the
2305    fact that an instruction or constant expression which cannot evoke side
2306    effects has nevertheless detected a condition which results in undefined
2307    behavior.</p>
2308
2309 <p>There is currently no way of representing a trap value in the IR; they
2310    only exist when produced by operations such as
2311    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2312
2313 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2314
2315 <ul>
2316 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2317     their operands.</li>
2318
2319 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2320     to their dynamic predecessor basic block.</li>
2321
2322 <li>Function arguments depend on the corresponding actual argument values in
2323     the dynamic callers of their functions.</li>
2324
2325 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2326     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2327     control back to them.</li>
2328
2329 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2330     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2331     or exception-throwing call instructions that dynamically transfer control
2332     back to them.</li>
2333
2334 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2335     referenced memory addresses, following the order in the IR
2336     (including loads and stores implied by intrinsics such as
2337     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2338
2339 <!-- TODO: In the case of multiple threads, this only applies if the store
2340      "happens-before" the load or store. -->
2341
2342 <!-- TODO: floating-point exception state -->
2343
2344 <li>An instruction with externally visible side effects depends on the most
2345     recent preceding instruction with externally visible side effects, following
2346     the order in the IR. (This includes
2347     <a href="#volatile">volatile operations</a>.)</li>
2348
2349 <li>An instruction <i>control-depends</i> on a
2350     <a href="#terminators">terminator instruction</a>
2351     if the terminator instruction has multiple successors and the instruction
2352     is always executed when control transfers to one of the successors, and
2353     may not be executed when control is transfered to another.</li>
2354
2355 <li>Dependence is transitive.</li>
2356
2357 </ul>
2358
2359 <p>Whenever a trap value is generated, all values which depend on it evaluate
2360    to trap. If they have side effects, the evoke their side effects as if each
2361    operand with a trap value were undef. If they have externally-visible side
2362    effects, the behavior is undefined.</p>
2363
2364 <p>Here are some examples:</p>
2365
2366 <pre class="doc_code">
2367 entry:
2368   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2369   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2370   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2371   store i32 0, i32* %trap_yet_again  ; undefined behavior
2372
2373   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2374   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2375
2376   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2377
2378   %narrowaddr = bitcast i32* @g to i16*
2379   %wideaddr = bitcast i32* @g to i64*
2380   %trap3 = load 16* %narrowaddr      ; Returns a trap value.
2381   %trap4 = load i64* %widaddr        ; Returns a trap value.
2382
2383   %cmp = icmp i32 slt %trap, 0       ; Returns a trap value.
2384   %br i1 %cmp, %true, %end           ; Branch to either destination.
2385
2386 true:
2387   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2388                                      ; it has undefined behavior.
2389   br label %end
2390
2391 end:
2392   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2393                                      ; Both edges into this PHI are
2394                                      ; control-dependent on %cmp, so this
2395                                      ; always results in a trap value.
2396
2397   volatile store i32 0, i32* @g      ; %end is control-equivalent to %entry
2398                                      ; so this is defined (ignoring earlier
2399                                      ; undefined behavior in this example).
2400 </pre>
2401
2402 </div>
2403
2404 <!-- ======================================================================= -->
2405 <div class="doc_subsection"><a name="blockaddress">Addresses of Basic
2406     Blocks</a></div>
2407 <div class="doc_text">
2408
2409 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2410
2411 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2412    basic block in the specified function, and always has an i8* type.  Taking
2413    the address of the entry block is illegal.</p>
2414
2415 <p>This value only has defined behavior when used as an operand to the
2416    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2417    comparisons against null. Pointer equality tests between labels addresses
2418    results in undefined behavior &mdash; though, again, comparison against null
2419    is ok, and no label is equal to the null pointer. This may be passed around
2420    as an opaque pointer sized value as long as the bits are not inspected. This
2421    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2422    long as the original value is reconstituted before the <tt>indirectbr</tt>
2423    instruction.</p>
2424
2425 <p>Finally, some targets may provide defined semantics when using the value as
2426    the operand to an inline assembly, but that is target specific.</p>
2427
2428 </div>
2429
2430
2431 <!-- ======================================================================= -->
2432 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
2433 </div>
2434
2435 <div class="doc_text">
2436
2437 <p>Constant expressions are used to allow expressions involving other constants
2438    to be used as constants.  Constant expressions may be of
2439    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2440    operation that does not have side effects (e.g. load and call are not
2441    supported). The following is the syntax for constant expressions:</p>
2442
2443 <dl>
2444   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2445   <dd>Truncate a constant to another type. The bit size of CST must be larger
2446       than the bit size of TYPE. Both types must be integers.</dd>
2447
2448   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2449   <dd>Zero extend a constant to another type. The bit size of CST must be
2450       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2451
2452   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2453   <dd>Sign extend a constant to another type. The bit size of CST must be
2454       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2455
2456   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2457   <dd>Truncate a floating point constant to another floating point type. The
2458       size of CST must be larger than the size of TYPE. Both types must be
2459       floating point.</dd>
2460
2461   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2462   <dd>Floating point extend a constant to another type. The size of CST must be
2463       smaller or equal to the size of TYPE. Both types must be floating
2464       point.</dd>
2465
2466   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2467   <dd>Convert a floating point constant to the corresponding unsigned integer
2468       constant. TYPE must be a scalar or vector integer type. CST must be of
2469       scalar or vector floating point type. Both CST and TYPE must be scalars,
2470       or vectors of the same number of elements. If the value won't fit in the
2471       integer type, the results are undefined.</dd>
2472
2473   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2474   <dd>Convert a floating point constant to the corresponding signed integer
2475       constant.  TYPE must be a scalar or vector integer type. CST must be of
2476       scalar or vector floating point type. Both CST and TYPE must be scalars,
2477       or vectors of the same number of elements. If the value won't fit in the
2478       integer type, the results are undefined.</dd>
2479
2480   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2481   <dd>Convert an unsigned integer constant to the corresponding floating point
2482       constant. TYPE must be a scalar or vector floating point type. CST must be
2483       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2484       vectors of the same number of elements. If the value won't fit in the
2485       floating point type, the results are undefined.</dd>
2486
2487   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2488   <dd>Convert a signed integer constant to the corresponding floating point
2489       constant. TYPE must be a scalar or vector floating point type. CST must be
2490       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2491       vectors of the same number of elements. If the value won't fit in the
2492       floating point type, the results are undefined.</dd>
2493
2494   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2495   <dd>Convert a pointer typed constant to the corresponding integer constant
2496       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2497       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2498       make it fit in <tt>TYPE</tt>.</dd>
2499
2500   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2501   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2502       type.  CST must be of integer type. The CST value is zero extended,
2503       truncated, or unchanged to make it fit in a pointer size. This one is
2504       <i>really</i> dangerous!</dd>
2505
2506   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2507   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2508       are the same as those for the <a href="#i_bitcast">bitcast
2509       instruction</a>.</dd>
2510
2511   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2512   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2513   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2514       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2515       instruction, the index list may have zero or more indexes, which are
2516       required to make sense for the type of "CSTPTR".</dd>
2517
2518   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2519   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2520
2521   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2522   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2523
2524   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2525   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2526
2527   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2528   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2529       constants.</dd>
2530
2531   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2532   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2533     constants.</dd>
2534
2535   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2536   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2537       constants.</dd>
2538
2539   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2540   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2541     constants. The index list is interpreted in a similar manner as indices in
2542     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2543     index value must be specified.</dd>
2544
2545   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2546   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2547     constants. The index list is interpreted in a similar manner as indices in
2548     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2549     index value must be specified.</dd>
2550
2551   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2552   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2553       be any of the <a href="#binaryops">binary</a>
2554       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2555       on operands are the same as those for the corresponding instruction
2556       (e.g. no bitwise operations on floating point values are allowed).</dd>
2557 </dl>
2558
2559 </div>
2560
2561 <!-- *********************************************************************** -->
2562 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
2563 <!-- *********************************************************************** -->
2564
2565 <!-- ======================================================================= -->
2566 <div class="doc_subsection">
2567 <a name="inlineasm">Inline Assembler Expressions</a>
2568 </div>
2569
2570 <div class="doc_text">
2571
2572 <p>LLVM supports inline assembler expressions (as opposed
2573    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2574    a special value.  This value represents the inline assembler as a string
2575    (containing the instructions to emit), a list of operand constraints (stored
2576    as a string), a flag that indicates whether or not the inline asm
2577    expression has side effects, and a flag indicating whether the function
2578    containing the asm needs to align its stack conservatively.  An example
2579    inline assembler expression is:</p>
2580
2581 <pre class="doc_code">
2582 i32 (i32) asm "bswap $0", "=r,r"
2583 </pre>
2584
2585 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2586    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2587    have:</p>
2588
2589 <pre class="doc_code">
2590 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2591 </pre>
2592
2593 <p>Inline asms with side effects not visible in the constraint list must be
2594    marked as having side effects.  This is done through the use of the
2595    '<tt>sideeffect</tt>' keyword, like so:</p>
2596
2597 <pre class="doc_code">
2598 call void asm sideeffect "eieio", ""()
2599 </pre>
2600
2601 <p>In some cases inline asms will contain code that will not work unless the
2602    stack is aligned in some way, such as calls or SSE instructions on x86,
2603    yet will not contain code that does that alignment within the asm.
2604    The compiler should make conservative assumptions about what the asm might
2605    contain and should generate its usual stack alignment code in the prologue
2606    if the '<tt>alignstack</tt>' keyword is present:</p>
2607
2608 <pre class="doc_code">
2609 call void asm alignstack "eieio", ""()
2610 </pre>
2611
2612 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2613    first.</p>
2614
2615 <p>TODO: The format of the asm and constraints string still need to be
2616    documented here.  Constraints on what can be done (e.g. duplication, moving,
2617    etc need to be documented).  This is probably best done by reference to
2618    another document that covers inline asm from a holistic perspective.</p>
2619 </div>
2620
2621 <div class="doc_subsubsection">
2622 <a name="inlineasm_md">Inline Asm Metadata</a>
2623 </div>
2624
2625 <div class="doc_text">
2626
2627 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2628    attached to it that contains a list of constant integers.  If present, the
2629   code generator will use the integer as the location cookie value when report
2630    errors through the LLVMContext error reporting mechanisms.  This allows a
2631    front-end to correlate backend errors that occur with inline asm back to the
2632    source code that produced it.  For example:</p>
2633
2634 <pre class="doc_code">
2635 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2636 ...
2637 !42 = !{ i32 1234567 }
2638 </pre>
2639
2640 <p>It is up to the front-end to make sense of the magic numbers it places in the
2641    IR.  If the MDNode contains multiple constants, the code generator will use
2642    the one that corresponds to the line of the asm that the error occurs on.</p>
2643
2644 </div>
2645
2646 <!-- ======================================================================= -->
2647 <div class="doc_subsection"><a name="metadata">Metadata Nodes and Metadata
2648   Strings</a>
2649 </div>
2650
2651 <div class="doc_text">
2652
2653 <p>LLVM IR allows metadata to be attached to instructions in the program that
2654    can convey extra information about the code to the optimizers and code
2655    generator.  One example application of metadata is source-level debug
2656    information.  There are two metadata primitives: strings and nodes. All
2657    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2658    preceding exclamation point ('<tt>!</tt>').</p>
2659
2660 <p>A metadata string is a string surrounded by double quotes.  It can contain
2661    any character by escaping non-printable characters with "\xx" where "xx" is
2662    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2663
2664 <p>Metadata nodes are represented with notation similar to structure constants
2665    (a comma separated list of elements, surrounded by braces and preceded by an
2666    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2667    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2668
2669 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2670    metadata nodes, which can be looked up in the module symbol table. For
2671    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2672
2673 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2674    function is using two metadata arguments.</p>
2675
2676      <pre class="doc_code">
2677        call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2678      </pre>
2679
2680 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2681    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2682
2683     <pre class="doc_code">
2684       %indvar.next = add i64 %indvar, 1, !dbg !21
2685     </pre>
2686 </div>
2687
2688
2689 <!-- *********************************************************************** -->
2690 <div class="doc_section">
2691   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2692 </div>
2693 <!-- *********************************************************************** -->
2694
2695 <p>LLVM has a number of "magic" global variables that contain data that affect
2696 code generation or other IR semantics.  These are documented here.  All globals
2697 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2698 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2699 by LLVM.</p>
2700
2701 <!-- ======================================================================= -->
2702 <div class="doc_subsection">
2703 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2704 </div>
2705
2706 <div class="doc_text">
2707
2708 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2709 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2710 pointers to global variables and functions which may optionally have a pointer
2711 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2712
2713 <pre>
2714   @X = global i8 4
2715   @Y = global i32 123
2716
2717   @llvm.used = appending global [2 x i8*] [
2718      i8* @X,
2719      i8* bitcast (i32* @Y to i8*)
2720   ], section "llvm.metadata"
2721 </pre>
2722
2723 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2724 compiler, assembler, and linker are required to treat the symbol as if there is
2725 a reference to the global that it cannot see.  For example, if a variable has
2726 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2727 list, it cannot be deleted.  This is commonly used to represent references from
2728 inline asms and other things the compiler cannot "see", and corresponds to
2729 "attribute((used))" in GNU C.</p>
2730
2731 <p>On some targets, the code generator must emit a directive to the assembler or
2732 object file to prevent the assembler and linker from molesting the symbol.</p>
2733
2734 </div>
2735
2736 <!-- ======================================================================= -->
2737 <div class="doc_subsection">
2738 <a name="intg_compiler_used">The '<tt>llvm.compiler.used</tt>' Global Variable</a>
2739 </div>
2740
2741 <div class="doc_text">
2742
2743 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2744 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2745 touching the symbol.  On targets that support it, this allows an intelligent
2746 linker to optimize references to the symbol without being impeded as it would be
2747 by <tt>@llvm.used</tt>.</p>
2748
2749 <p>This is a rare construct that should only be used in rare circumstances, and
2750 should not be exposed to source languages.</p>
2751
2752 </div>
2753
2754 <!-- ======================================================================= -->
2755 <div class="doc_subsection">
2756 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2757 </div>
2758
2759 <div class="doc_text">
2760 <pre>
2761 %0 = type { i32, void ()* }
2762 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2763 </pre>
2764 <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.
2765 </p>
2766
2767 </div>
2768
2769 <!-- ======================================================================= -->
2770 <div class="doc_subsection">
2771 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2772 </div>
2773
2774 <div class="doc_text">
2775 <pre>
2776 %0 = type { i32, void ()* }
2777 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2778 </pre>
2779
2780 <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.
2781 </p>
2782
2783 </div>
2784
2785
2786 <!-- *********************************************************************** -->
2787 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
2788 <!-- *********************************************************************** -->
2789
2790 <div class="doc_text">
2791
2792 <p>The LLVM instruction set consists of several different classifications of
2793    instructions: <a href="#terminators">terminator
2794    instructions</a>, <a href="#binaryops">binary instructions</a>,
2795    <a href="#bitwiseops">bitwise binary instructions</a>,
2796    <a href="#memoryops">memory instructions</a>, and
2797    <a href="#otherops">other instructions</a>.</p>
2798
2799 </div>
2800
2801 <!-- ======================================================================= -->
2802 <div class="doc_subsection"> <a name="terminators">Terminator
2803 Instructions</a> </div>
2804
2805 <div class="doc_text">
2806
2807 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
2808    in a program ends with a "Terminator" instruction, which indicates which
2809    block should be executed after the current block is finished. These
2810    terminator instructions typically yield a '<tt>void</tt>' value: they produce
2811    control flow, not values (the one exception being the
2812    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
2813
2814 <p>There are seven different terminator instructions: the
2815    '<a href="#i_ret"><tt>ret</tt></a>' instruction, the
2816    '<a href="#i_br"><tt>br</tt></a>' instruction, the
2817    '<a href="#i_switch"><tt>switch</tt></a>' instruction, the
2818    '<a href="#i_indirectbr">'<tt>indirectbr</tt></a>' Instruction, the
2819    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the
2820    '<a href="#i_unwind"><tt>unwind</tt></a>' instruction, and the
2821    '<a href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
2822
2823 </div>
2824
2825 <!-- _______________________________________________________________________ -->
2826 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
2827 Instruction</a> </div>
2828
2829 <div class="doc_text">
2830
2831 <h5>Syntax:</h5>
2832 <pre>
2833   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
2834   ret void                 <i>; Return from void function</i>
2835 </pre>
2836
2837 <h5>Overview:</h5>
2838 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
2839    a value) from a function back to the caller.</p>
2840
2841 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
2842    value and then causes control flow, and one that just causes control flow to
2843    occur.</p>
2844
2845 <h5>Arguments:</h5>
2846 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
2847    return value. The type of the return value must be a
2848    '<a href="#t_firstclass">first class</a>' type.</p>
2849
2850 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
2851    non-void return type and contains a '<tt>ret</tt>' instruction with no return
2852    value or a return value with a type that does not match its type, or if it
2853    has a void return type and contains a '<tt>ret</tt>' instruction with a
2854    return value.</p>
2855
2856 <h5>Semantics:</h5>
2857 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
2858    the calling function's context.  If the caller is a
2859    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
2860    instruction after the call.  If the caller was an
2861    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
2862    the beginning of the "normal" destination block.  If the instruction returns
2863    a value, that value shall set the call or invoke instruction's return
2864    value.</p>
2865
2866 <h5>Example:</h5>
2867 <pre>
2868   ret i32 5                       <i>; Return an integer value of 5</i>
2869   ret void                        <i>; Return from a void function</i>
2870   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
2871 </pre>
2872
2873 </div>
2874 <!-- _______________________________________________________________________ -->
2875 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
2876
2877 <div class="doc_text">
2878
2879 <h5>Syntax:</h5>
2880 <pre>
2881   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
2882 </pre>
2883
2884 <h5>Overview:</h5>
2885 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
2886    different basic block in the current function.  There are two forms of this
2887    instruction, corresponding to a conditional branch and an unconditional
2888    branch.</p>
2889
2890 <h5>Arguments:</h5>
2891 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
2892    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
2893    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
2894    target.</p>
2895
2896 <h5>Semantics:</h5>
2897 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
2898    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
2899    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
2900    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
2901
2902 <h5>Example:</h5>
2903 <pre>
2904 Test:
2905   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
2906   br i1 %cond, label %IfEqual, label %IfUnequal
2907 IfEqual:
2908   <a href="#i_ret">ret</a> i32 1
2909 IfUnequal:
2910   <a href="#i_ret">ret</a> i32 0
2911 </pre>
2912
2913 </div>
2914
2915 <!-- _______________________________________________________________________ -->
2916 <div class="doc_subsubsection">
2917    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
2918 </div>
2919
2920 <div class="doc_text">
2921
2922 <h5>Syntax:</h5>
2923 <pre>
2924   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
2925 </pre>
2926
2927 <h5>Overview:</h5>
2928 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
2929    several different places.  It is a generalization of the '<tt>br</tt>'
2930    instruction, allowing a branch to occur to one of many possible
2931    destinations.</p>
2932
2933 <h5>Arguments:</h5>
2934 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
2935    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
2936    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
2937    The table is not allowed to contain duplicate constant entries.</p>
2938
2939 <h5>Semantics:</h5>
2940 <p>The <tt>switch</tt> instruction specifies a table of values and
2941    destinations. When the '<tt>switch</tt>' instruction is executed, this table
2942    is searched for the given value.  If the value is found, control flow is
2943    transferred to the corresponding destination; otherwise, control flow is
2944    transferred to the default destination.</p>
2945
2946 <h5>Implementation:</h5>
2947 <p>Depending on properties of the target machine and the particular
2948    <tt>switch</tt> instruction, this instruction may be code generated in
2949    different ways.  For example, it could be generated as a series of chained
2950    conditional branches or with a lookup table.</p>
2951
2952 <h5>Example:</h5>
2953 <pre>
2954  <i>; Emulate a conditional br instruction</i>
2955  %Val = <a href="#i_zext">zext</a> i1 %value to i32
2956  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
2957
2958  <i>; Emulate an unconditional br instruction</i>
2959  switch i32 0, label %dest [ ]
2960
2961  <i>; Implement a jump table:</i>
2962  switch i32 %val, label %otherwise [ i32 0, label %onzero
2963                                      i32 1, label %onone
2964                                      i32 2, label %ontwo ]
2965 </pre>
2966
2967 </div>
2968
2969
2970 <!-- _______________________________________________________________________ -->
2971 <div class="doc_subsubsection">
2972    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
2973 </div>
2974
2975 <div class="doc_text">
2976
2977 <h5>Syntax:</h5>
2978 <pre>
2979   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
2980 </pre>
2981
2982 <h5>Overview:</h5>
2983
2984 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
2985    within the current function, whose address is specified by
2986    "<tt>address</tt>".  Address must be derived from a <a
2987    href="#blockaddress">blockaddress</a> constant.</p>
2988
2989 <h5>Arguments:</h5>
2990
2991 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
2992    rest of the arguments indicate the full set of possible destinations that the
2993    address may point to.  Blocks are allowed to occur multiple times in the
2994    destination list, though this isn't particularly useful.</p>
2995
2996 <p>This destination list is required so that dataflow analysis has an accurate
2997    understanding of the CFG.</p>
2998
2999 <h5>Semantics:</h5>
3000
3001 <p>Control transfers to the block specified in the address argument.  All
3002    possible destination blocks must be listed in the label list, otherwise this
3003    instruction has undefined behavior.  This implies that jumps to labels
3004    defined in other functions have undefined behavior as well.</p>
3005
3006 <h5>Implementation:</h5>
3007
3008 <p>This is typically implemented with a jump through a register.</p>
3009
3010 <h5>Example:</h5>
3011 <pre>
3012  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3013 </pre>
3014
3015 </div>
3016
3017
3018 <!-- _______________________________________________________________________ -->
3019 <div class="doc_subsubsection">
3020   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3021 </div>
3022
3023 <div class="doc_text">
3024
3025 <h5>Syntax:</h5>
3026 <pre>
3027   &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>]
3028                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3029 </pre>
3030
3031 <h5>Overview:</h5>
3032 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3033    function, with the possibility of control flow transfer to either the
3034    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3035    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3036    control flow will return to the "normal" label.  If the callee (or any
3037    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3038    instruction, control is interrupted and continued at the dynamically nearest
3039    "exception" label.</p>
3040
3041 <h5>Arguments:</h5>
3042 <p>This instruction requires several arguments:</p>
3043
3044 <ol>
3045   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3046       convention</a> the call should use.  If none is specified, the call
3047       defaults to using C calling conventions.</li>
3048
3049   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3050       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3051       '<tt>inreg</tt>' attributes are valid here.</li>
3052
3053   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3054       function value being invoked.  In most cases, this is a direct function
3055       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3056       off an arbitrary pointer to function value.</li>
3057
3058   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3059       function to be invoked. </li>
3060
3061   <li>'<tt>function args</tt>': argument list whose types match the function
3062       signature argument types and parameter attributes. All arguments must be
3063       of <a href="#t_firstclass">first class</a> type. If the function
3064       signature indicates the function accepts a variable number of arguments,
3065       the extra arguments can be specified.</li>
3066
3067   <li>'<tt>normal label</tt>': the label reached when the called function
3068       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3069
3070   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3071       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3072
3073   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3074       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3075       '<tt>readnone</tt>' attributes are valid here.</li>
3076 </ol>
3077
3078 <h5>Semantics:</h5>
3079 <p>This instruction is designed to operate as a standard
3080    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3081    primary difference is that it establishes an association with a label, which
3082    is used by the runtime library to unwind the stack.</p>
3083
3084 <p>This instruction is used in languages with destructors to ensure that proper
3085    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3086    exception.  Additionally, this is important for implementation of
3087    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3088
3089 <p>For the purposes of the SSA form, the definition of the value returned by the
3090    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3091    block to the "normal" label. If the callee unwinds then no return value is
3092    available.</p>
3093
3094 <p>Note that the code generator does not yet completely support unwind, and
3095 that the invoke/unwind semantics are likely to change in future versions.</p>
3096
3097 <h5>Example:</h5>
3098 <pre>
3099   %retval = invoke i32 @Test(i32 15) to label %Continue
3100               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3101   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3102               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3103 </pre>
3104
3105 </div>
3106
3107 <!-- _______________________________________________________________________ -->
3108
3109 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
3110 Instruction</a> </div>
3111
3112 <div class="doc_text">
3113
3114 <h5>Syntax:</h5>
3115 <pre>
3116   unwind
3117 </pre>
3118
3119 <h5>Overview:</h5>
3120 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3121    at the first callee in the dynamic call stack which used
3122    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3123    This is primarily used to implement exception handling.</p>
3124
3125 <h5>Semantics:</h5>
3126 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3127    immediately halt.  The dynamic call stack is then searched for the
3128    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3129    Once found, execution continues at the "exceptional" destination block
3130    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3131    instruction in the dynamic call chain, undefined behavior results.</p>
3132
3133 <p>Note that the code generator does not yet completely support unwind, and
3134 that the invoke/unwind semantics are likely to change in future versions.</p>
3135
3136 </div>
3137
3138 <!-- _______________________________________________________________________ -->
3139
3140 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
3141 Instruction</a> </div>
3142
3143 <div class="doc_text">
3144
3145 <h5>Syntax:</h5>
3146 <pre>
3147   unreachable
3148 </pre>
3149
3150 <h5>Overview:</h5>
3151 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3152    instruction is used to inform the optimizer that a particular portion of the
3153    code is not reachable.  This can be used to indicate that the code after a
3154    no-return function cannot be reached, and other facts.</p>
3155
3156 <h5>Semantics:</h5>
3157 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3158
3159 </div>
3160
3161 <!-- ======================================================================= -->
3162 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
3163
3164 <div class="doc_text">
3165
3166 <p>Binary operators are used to do most of the computation in a program.  They
3167    require two operands of the same type, execute an operation on them, and
3168    produce a single value.  The operands might represent multiple data, as is
3169    the case with the <a href="#t_vector">vector</a> data type.  The result value
3170    has the same type as its operands.</p>
3171
3172 <p>There are several different binary operators:</p>
3173
3174 </div>
3175
3176 <!-- _______________________________________________________________________ -->
3177 <div class="doc_subsubsection">
3178   <a name="i_add">'<tt>add</tt>' Instruction</a>
3179 </div>
3180
3181 <div class="doc_text">
3182
3183 <h5>Syntax:</h5>
3184 <pre>
3185   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3186   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3187   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3188   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3189 </pre>
3190
3191 <h5>Overview:</h5>
3192 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3193
3194 <h5>Arguments:</h5>
3195 <p>The two arguments to the '<tt>add</tt>' instruction must
3196    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3197    integer values. Both arguments must have identical types.</p>
3198
3199 <h5>Semantics:</h5>
3200 <p>The value produced is the integer sum of the two operands.</p>
3201
3202 <p>If the sum has unsigned overflow, the result returned is the mathematical
3203    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3204
3205 <p>Because LLVM integers use a two's complement representation, this instruction
3206    is appropriate for both signed and unsigned integers.</p>
3207
3208 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3209    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3210    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3211    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3212    respectively, occurs.</p>
3213
3214 <h5>Example:</h5>
3215 <pre>
3216   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3217 </pre>
3218
3219 </div>
3220
3221 <!-- _______________________________________________________________________ -->
3222 <div class="doc_subsubsection">
3223   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3224 </div>
3225
3226 <div class="doc_text">
3227
3228 <h5>Syntax:</h5>
3229 <pre>
3230   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3231 </pre>
3232
3233 <h5>Overview:</h5>
3234 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3235
3236 <h5>Arguments:</h5>
3237 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3238    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3239    floating point values. Both arguments must have identical types.</p>
3240
3241 <h5>Semantics:</h5>
3242 <p>The value produced is the floating point sum of the two operands.</p>
3243
3244 <h5>Example:</h5>
3245 <pre>
3246   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3247 </pre>
3248
3249 </div>
3250
3251 <!-- _______________________________________________________________________ -->
3252 <div class="doc_subsubsection">
3253    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3254 </div>
3255
3256 <div class="doc_text">
3257
3258 <h5>Syntax:</h5>
3259 <pre>
3260   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3261   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3262   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3263   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3264 </pre>
3265
3266 <h5>Overview:</h5>
3267 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3268    operands.</p>
3269
3270 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3271    '<tt>neg</tt>' instruction present in most other intermediate
3272    representations.</p>
3273
3274 <h5>Arguments:</h5>
3275 <p>The two arguments to the '<tt>sub</tt>' instruction must
3276    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3277    integer values.  Both arguments must have identical types.</p>
3278
3279 <h5>Semantics:</h5>
3280 <p>The value produced is the integer difference of the two operands.</p>
3281
3282 <p>If the difference has unsigned overflow, the result returned is the
3283    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3284    result.</p>
3285
3286 <p>Because LLVM integers use a two's complement representation, this instruction
3287    is appropriate for both signed and unsigned integers.</p>
3288
3289 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3290    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3291    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3292    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3293    respectively, occurs.</p>
3294
3295 <h5>Example:</h5>
3296 <pre>
3297   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3298   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3299 </pre>
3300
3301 </div>
3302
3303 <!-- _______________________________________________________________________ -->
3304 <div class="doc_subsubsection">
3305    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3306 </div>
3307
3308 <div class="doc_text">
3309
3310 <h5>Syntax:</h5>
3311 <pre>
3312   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3313 </pre>
3314
3315 <h5>Overview:</h5>
3316 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3317    operands.</p>
3318
3319 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3320    '<tt>fneg</tt>' instruction present in most other intermediate
3321    representations.</p>
3322
3323 <h5>Arguments:</h5>
3324 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3325    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3326    floating point values.  Both arguments must have identical types.</p>
3327
3328 <h5>Semantics:</h5>
3329 <p>The value produced is the floating point difference of the two operands.</p>
3330
3331 <h5>Example:</h5>
3332 <pre>
3333   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3334   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3335 </pre>
3336
3337 </div>
3338
3339 <!-- _______________________________________________________________________ -->
3340 <div class="doc_subsubsection">
3341   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3342 </div>
3343
3344 <div class="doc_text">
3345
3346 <h5>Syntax:</h5>
3347 <pre>
3348   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3349   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3350   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3351   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3352 </pre>
3353
3354 <h5>Overview:</h5>
3355 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3356
3357 <h5>Arguments:</h5>
3358 <p>The two arguments to the '<tt>mul</tt>' instruction must
3359    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3360    integer values.  Both arguments must have identical types.</p>
3361
3362 <h5>Semantics:</h5>
3363 <p>The value produced is the integer product of the two operands.</p>
3364
3365 <p>If the result of the multiplication has unsigned overflow, the result
3366    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3367    width of the result.</p>
3368
3369 <p>Because LLVM integers use a two's complement representation, and the result
3370    is the same width as the operands, this instruction returns the correct
3371    result for both signed and unsigned integers.  If a full product
3372    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3373    be sign-extended or zero-extended as appropriate to the width of the full
3374    product.</p>
3375
3376 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3377    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3378    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3379    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3380    respectively, occurs.</p>
3381
3382 <h5>Example:</h5>
3383 <pre>
3384   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3385 </pre>
3386
3387 </div>
3388
3389 <!-- _______________________________________________________________________ -->
3390 <div class="doc_subsubsection">
3391   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3392 </div>
3393
3394 <div class="doc_text">
3395
3396 <h5>Syntax:</h5>
3397 <pre>
3398   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3399 </pre>
3400
3401 <h5>Overview:</h5>
3402 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3403
3404 <h5>Arguments:</h5>
3405 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3406    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3407    floating point values.  Both arguments must have identical types.</p>
3408
3409 <h5>Semantics:</h5>
3410 <p>The value produced is the floating point product of the two operands.</p>
3411
3412 <h5>Example:</h5>
3413 <pre>
3414   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3415 </pre>
3416
3417 </div>
3418
3419 <!-- _______________________________________________________________________ -->
3420 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
3421 </a></div>
3422
3423 <div class="doc_text">
3424
3425 <h5>Syntax:</h5>
3426 <pre>
3427   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3428 </pre>
3429
3430 <h5>Overview:</h5>
3431 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3432
3433 <h5>Arguments:</h5>
3434 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3435    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3436    values.  Both arguments must have identical types.</p>
3437
3438 <h5>Semantics:</h5>
3439 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3440
3441 <p>Note that unsigned integer division and signed integer division are distinct
3442    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3443
3444 <p>Division by zero leads to undefined behavior.</p>
3445
3446 <h5>Example:</h5>
3447 <pre>
3448   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3449 </pre>
3450
3451 </div>
3452
3453 <!-- _______________________________________________________________________ -->
3454 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
3455 </a> </div>
3456
3457 <div class="doc_text">
3458
3459 <h5>Syntax:</h5>
3460 <pre>
3461   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3462   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3463 </pre>
3464
3465 <h5>Overview:</h5>
3466 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3467
3468 <h5>Arguments:</h5>
3469 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3470    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3471    values.  Both arguments must have identical types.</p>
3472
3473 <h5>Semantics:</h5>
3474 <p>The value produced is the signed integer quotient of the two operands rounded
3475    towards zero.</p>
3476
3477 <p>Note that signed integer division and unsigned integer division are distinct
3478    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3479
3480 <p>Division by zero leads to undefined behavior. Overflow also leads to
3481    undefined behavior; this is a rare case, but can occur, for example, by doing
3482    a 32-bit division of -2147483648 by -1.</p>
3483
3484 <p>If the <tt>exact</tt> keyword is present, the result value of the
3485    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3486    be rounded.</p>
3487
3488 <h5>Example:</h5>
3489 <pre>
3490   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3491 </pre>
3492
3493 </div>
3494
3495 <!-- _______________________________________________________________________ -->
3496 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
3497 Instruction</a> </div>
3498
3499 <div class="doc_text">
3500
3501 <h5>Syntax:</h5>
3502 <pre>
3503   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3504 </pre>
3505
3506 <h5>Overview:</h5>
3507 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3508
3509 <h5>Arguments:</h5>
3510 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3511    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3512    floating point values.  Both arguments must have identical types.</p>
3513
3514 <h5>Semantics:</h5>
3515 <p>The value produced is the floating point quotient of the two operands.</p>
3516
3517 <h5>Example:</h5>
3518 <pre>
3519   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3520 </pre>
3521
3522 </div>
3523
3524 <!-- _______________________________________________________________________ -->
3525 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3526 </div>
3527
3528 <div class="doc_text">
3529
3530 <h5>Syntax:</h5>
3531 <pre>
3532   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3533 </pre>
3534
3535 <h5>Overview:</h5>
3536 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3537    division of its two arguments.</p>
3538
3539 <h5>Arguments:</h5>
3540 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3541    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3542    values.  Both arguments must have identical types.</p>
3543
3544 <h5>Semantics:</h5>
3545 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3546    This instruction always performs an unsigned division to get the
3547    remainder.</p>
3548
3549 <p>Note that unsigned integer remainder and signed integer remainder are
3550    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3551
3552 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3553
3554 <h5>Example:</h5>
3555 <pre>
3556   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3557 </pre>
3558
3559 </div>
3560
3561 <!-- _______________________________________________________________________ -->
3562 <div class="doc_subsubsection">
3563   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3564 </div>
3565
3566 <div class="doc_text">
3567
3568 <h5>Syntax:</h5>
3569 <pre>
3570   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3571 </pre>
3572
3573 <h5>Overview:</h5>
3574 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3575    division of its two operands. This instruction can also take
3576    <a href="#t_vector">vector</a> versions of the values in which case the
3577    elements must be integers.</p>
3578
3579 <h5>Arguments:</h5>
3580 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3581    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3582    values.  Both arguments must have identical types.</p>
3583
3584 <h5>Semantics:</h5>
3585 <p>This instruction returns the <i>remainder</i> of a division (where the result
3586    has the same sign as the dividend, <tt>op1</tt>), not the <i>modulo</i>
3587    operator (where the result has the same sign as the divisor, <tt>op2</tt>) of
3588    a value.  For more information about the difference,
3589    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3590    Math Forum</a>. For a table of how this is implemented in various languages,
3591    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3592    Wikipedia: modulo operation</a>.</p>
3593
3594 <p>Note that signed integer remainder and unsigned integer remainder are
3595    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3596
3597 <p>Taking the remainder of a division by zero leads to undefined behavior.
3598    Overflow also leads to undefined behavior; this is a rare case, but can
3599    occur, for example, by taking the remainder of a 32-bit division of
3600    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3601    lets srem be implemented using instructions that return both the result of
3602    the division and the remainder.)</p>
3603
3604 <h5>Example:</h5>
3605 <pre>
3606   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3607 </pre>
3608
3609 </div>
3610
3611 <!-- _______________________________________________________________________ -->
3612 <div class="doc_subsubsection">
3613   <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
3614
3615 <div class="doc_text">
3616
3617 <h5>Syntax:</h5>
3618 <pre>
3619   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3620 </pre>
3621
3622 <h5>Overview:</h5>
3623 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3624    its two operands.</p>
3625
3626 <h5>Arguments:</h5>
3627 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3628    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3629    floating point values.  Both arguments must have identical types.</p>
3630
3631 <h5>Semantics:</h5>
3632 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3633    has the same sign as the dividend.</p>
3634
3635 <h5>Example:</h5>
3636 <pre>
3637   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3638 </pre>
3639
3640 </div>
3641
3642 <!-- ======================================================================= -->
3643 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
3644 Operations</a> </div>
3645
3646 <div class="doc_text">
3647
3648 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3649    program.  They are generally very efficient instructions and can commonly be
3650    strength reduced from other instructions.  They require two operands of the
3651    same type, execute an operation on them, and produce a single value.  The
3652    resulting value is the same type as its operands.</p>
3653
3654 </div>
3655
3656 <!-- _______________________________________________________________________ -->
3657 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
3658 Instruction</a> </div>
3659
3660 <div class="doc_text">
3661
3662 <h5>Syntax:</h5>
3663 <pre>
3664   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3665 </pre>
3666
3667 <h5>Overview:</h5>
3668 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3669    a specified number of bits.</p>
3670
3671 <h5>Arguments:</h5>
3672 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3673     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3674     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3675
3676 <h5>Semantics:</h5>
3677 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3678    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3679    is (statically or dynamically) negative or equal to or larger than the number
3680    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3681    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3682    shift amount in <tt>op2</tt>.</p>
3683
3684 <h5>Example:</h5>
3685 <pre>
3686   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3687   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3688   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3689   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3690   &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>
3691 </pre>
3692
3693 </div>
3694
3695 <!-- _______________________________________________________________________ -->
3696 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
3697 Instruction</a> </div>
3698
3699 <div class="doc_text">
3700
3701 <h5>Syntax:</h5>
3702 <pre>
3703   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3704 </pre>
3705
3706 <h5>Overview:</h5>
3707 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
3708    operand shifted to the right a specified number of bits with zero fill.</p>
3709
3710 <h5>Arguments:</h5>
3711 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
3712    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3713    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
3714
3715 <h5>Semantics:</h5>
3716 <p>This instruction always performs a logical shift right operation. The most
3717    significant bits of the result will be filled with zero bits after the shift.
3718    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
3719    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
3720    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3721    shift amount in <tt>op2</tt>.</p>
3722
3723 <h5>Example:</h5>
3724 <pre>
3725   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
3726   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
3727   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
3728   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
3729   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
3730   &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>
3731 </pre>
3732
3733 </div>
3734
3735 <!-- _______________________________________________________________________ -->
3736 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
3737 Instruction</a> </div>
3738 <div class="doc_text">
3739
3740 <h5>Syntax:</h5>
3741 <pre>
3742   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3743 </pre>
3744
3745 <h5>Overview:</h5>
3746 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
3747    operand shifted to the right a specified number of bits with sign
3748    extension.</p>
3749
3750 <h5>Arguments:</h5>
3751 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
3752    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3753    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3754
3755 <h5>Semantics:</h5>
3756 <p>This instruction always performs an arithmetic shift right operation, The
3757    most significant bits of the result will be filled with the sign bit
3758    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
3759    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
3760    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
3761    the corresponding shift amount in <tt>op2</tt>.</p>
3762
3763 <h5>Example:</h5>
3764 <pre>
3765   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
3766   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
3767   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
3768   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
3769   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
3770   &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>
3771 </pre>
3772
3773 </div>
3774
3775 <!-- _______________________________________________________________________ -->
3776 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
3777 Instruction</a> </div>
3778
3779 <div class="doc_text">
3780
3781 <h5>Syntax:</h5>
3782 <pre>
3783   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3784 </pre>
3785
3786 <h5>Overview:</h5>
3787 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
3788    operands.</p>
3789
3790 <h5>Arguments:</h5>
3791 <p>The two arguments to the '<tt>and</tt>' instruction must be
3792    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3793    values.  Both arguments must have identical types.</p>
3794
3795 <h5>Semantics:</h5>
3796 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
3797
3798 <table border="1" cellspacing="0" cellpadding="4">
3799   <tbody>
3800     <tr>
3801       <td>In0</td>
3802       <td>In1</td>
3803       <td>Out</td>
3804     </tr>
3805     <tr>
3806       <td>0</td>
3807       <td>0</td>
3808       <td>0</td>
3809     </tr>
3810     <tr>
3811       <td>0</td>
3812       <td>1</td>
3813       <td>0</td>
3814     </tr>
3815     <tr>
3816       <td>1</td>
3817       <td>0</td>
3818       <td>0</td>
3819     </tr>
3820     <tr>
3821       <td>1</td>
3822       <td>1</td>
3823       <td>1</td>
3824     </tr>
3825   </tbody>
3826 </table>
3827
3828 <h5>Example:</h5>
3829 <pre>
3830   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
3831   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
3832   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
3833 </pre>
3834 </div>
3835 <!-- _______________________________________________________________________ -->
3836 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
3837
3838 <div class="doc_text">
3839
3840 <h5>Syntax:</h5>
3841 <pre>
3842   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3843 </pre>
3844
3845 <h5>Overview:</h5>
3846 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
3847    two operands.</p>
3848
3849 <h5>Arguments:</h5>
3850 <p>The two arguments to the '<tt>or</tt>' instruction must be
3851    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3852    values.  Both arguments must have identical types.</p>
3853
3854 <h5>Semantics:</h5>
3855 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
3856
3857 <table border="1" cellspacing="0" cellpadding="4">
3858   <tbody>
3859     <tr>
3860       <td>In0</td>
3861       <td>In1</td>
3862       <td>Out</td>
3863     </tr>
3864     <tr>
3865       <td>0</td>
3866       <td>0</td>
3867       <td>0</td>
3868     </tr>
3869     <tr>
3870       <td>0</td>
3871       <td>1</td>
3872       <td>1</td>
3873     </tr>
3874     <tr>
3875       <td>1</td>
3876       <td>0</td>
3877       <td>1</td>
3878     </tr>
3879     <tr>
3880       <td>1</td>
3881       <td>1</td>
3882       <td>1</td>
3883     </tr>
3884   </tbody>
3885 </table>
3886
3887 <h5>Example:</h5>
3888 <pre>
3889   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
3890   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
3891   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
3892 </pre>
3893
3894 </div>
3895
3896 <!-- _______________________________________________________________________ -->
3897 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
3898 Instruction</a> </div>
3899
3900 <div class="doc_text">
3901
3902 <h5>Syntax:</h5>
3903 <pre>
3904   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3905 </pre>
3906
3907 <h5>Overview:</h5>
3908 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
3909    its two operands.  The <tt>xor</tt> is used to implement the "one's
3910    complement" operation, which is the "~" operator in C.</p>
3911
3912 <h5>Arguments:</h5>
3913 <p>The two arguments to the '<tt>xor</tt>' instruction must be
3914    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3915    values.  Both arguments must have identical types.</p>
3916
3917 <h5>Semantics:</h5>
3918 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
3919
3920 <table border="1" cellspacing="0" cellpadding="4">
3921   <tbody>
3922     <tr>
3923       <td>In0</td>
3924       <td>In1</td>
3925       <td>Out</td>
3926     </tr>
3927     <tr>
3928       <td>0</td>
3929       <td>0</td>
3930       <td>0</td>
3931     </tr>
3932     <tr>
3933       <td>0</td>
3934       <td>1</td>
3935       <td>1</td>
3936     </tr>
3937     <tr>
3938       <td>1</td>
3939       <td>0</td>
3940       <td>1</td>
3941     </tr>
3942     <tr>
3943       <td>1</td>
3944       <td>1</td>
3945       <td>0</td>
3946     </tr>
3947   </tbody>
3948 </table>
3949
3950 <h5>Example:</h5>
3951 <pre>
3952   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
3953   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
3954   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
3955   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
3956 </pre>
3957
3958 </div>
3959
3960 <!-- ======================================================================= -->
3961 <div class="doc_subsection">
3962   <a name="vectorops">Vector Operations</a>
3963 </div>
3964
3965 <div class="doc_text">
3966
3967 <p>LLVM supports several instructions to represent vector operations in a
3968    target-independent manner.  These instructions cover the element-access and
3969    vector-specific operations needed to process vectors effectively.  While LLVM
3970    does directly support these vector operations, many sophisticated algorithms
3971    will want to use target-specific intrinsics to take full advantage of a
3972    specific target.</p>
3973
3974 </div>
3975
3976 <!-- _______________________________________________________________________ -->
3977 <div class="doc_subsubsection">
3978    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
3979 </div>
3980
3981 <div class="doc_text">
3982
3983 <h5>Syntax:</h5>
3984 <pre>
3985   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
3986 </pre>
3987
3988 <h5>Overview:</h5>
3989 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
3990    from a vector at a specified index.</p>
3991
3992
3993 <h5>Arguments:</h5>
3994 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
3995    of <a href="#t_vector">vector</a> type.  The second operand is an index
3996    indicating the position from which to extract the element.  The index may be
3997    a variable.</p>
3998
3999 <h5>Semantics:</h5>
4000 <p>The result is a scalar of the same type as the element type of
4001    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4002    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4003    results are undefined.</p>
4004
4005 <h5>Example:</h5>
4006 <pre>
4007   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4008 </pre>
4009
4010 </div>
4011
4012 <!-- _______________________________________________________________________ -->
4013 <div class="doc_subsubsection">
4014    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4015 </div>
4016
4017 <div class="doc_text">
4018
4019 <h5>Syntax:</h5>
4020 <pre>
4021   &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>
4022 </pre>
4023
4024 <h5>Overview:</h5>
4025 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4026    vector at a specified index.</p>
4027
4028 <h5>Arguments:</h5>
4029 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4030    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4031    whose type must equal the element type of the first operand.  The third
4032    operand is an index indicating the position at which to insert the value.
4033    The index may be a variable.</p>
4034
4035 <h5>Semantics:</h5>
4036 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4037    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4038    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4039    results are undefined.</p>
4040
4041 <h5>Example:</h5>
4042 <pre>
4043   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4044 </pre>
4045
4046 </div>
4047
4048 <!-- _______________________________________________________________________ -->
4049 <div class="doc_subsubsection">
4050    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4051 </div>
4052
4053 <div class="doc_text">
4054
4055 <h5>Syntax:</h5>
4056 <pre>
4057   &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>
4058 </pre>
4059
4060 <h5>Overview:</h5>
4061 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4062    from two input vectors, returning a vector with the same element type as the
4063    input and length that is the same as the shuffle mask.</p>
4064
4065 <h5>Arguments:</h5>
4066 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4067    with types that match each other. The third argument is a shuffle mask whose
4068    element type is always 'i32'.  The result of the instruction is a vector
4069    whose length is the same as the shuffle mask and whose element type is the
4070    same as the element type of the first two operands.</p>
4071
4072 <p>The shuffle mask operand is required to be a constant vector with either
4073    constant integer or undef values.</p>
4074
4075 <h5>Semantics:</h5>
4076 <p>The elements of the two input vectors are numbered from left to right across
4077    both of the vectors.  The shuffle mask operand specifies, for each element of
4078    the result vector, which element of the two input vectors the result element
4079    gets.  The element selector may be undef (meaning "don't care") and the
4080    second operand may be undef if performing a shuffle from only one vector.</p>
4081
4082 <h5>Example:</h5>
4083 <pre>
4084   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4085                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4086   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4087                           &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.
4088   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4089                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4090   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4091                           &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>
4092 </pre>
4093
4094 </div>
4095
4096 <!-- ======================================================================= -->
4097 <div class="doc_subsection">
4098   <a name="aggregateops">Aggregate Operations</a>
4099 </div>
4100
4101 <div class="doc_text">
4102
4103 <p>LLVM supports several instructions for working with
4104   <a href="#t_aggregate">aggregate</a> values.</p>
4105
4106 </div>
4107
4108 <!-- _______________________________________________________________________ -->
4109 <div class="doc_subsubsection">
4110    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4111 </div>
4112
4113 <div class="doc_text">
4114
4115 <h5>Syntax:</h5>
4116 <pre>
4117   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4118 </pre>
4119
4120 <h5>Overview:</h5>
4121 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4122    from an <a href="#t_aggregate">aggregate</a> value.</p>
4123
4124 <h5>Arguments:</h5>
4125 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4126    of <a href="#t_struct">struct</a> or
4127    <a href="#t_array">array</a> type.  The operands are constant indices to
4128    specify which value to extract in a similar manner as indices in a
4129    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4130
4131 <h5>Semantics:</h5>
4132 <p>The result is the value at the position in the aggregate specified by the
4133    index operands.</p>
4134
4135 <h5>Example:</h5>
4136 <pre>
4137   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4138 </pre>
4139
4140 </div>
4141
4142 <!-- _______________________________________________________________________ -->
4143 <div class="doc_subsubsection">
4144    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4145 </div>
4146
4147 <div class="doc_text">
4148
4149 <h5>Syntax:</h5>
4150 <pre>
4151   &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>
4152 </pre>
4153
4154 <h5>Overview:</h5>
4155 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4156    in an <a href="#t_aggregate">aggregate</a> value.</p>
4157
4158 <h5>Arguments:</h5>
4159 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4160    of <a href="#t_struct">struct</a> or
4161    <a href="#t_array">array</a> type.  The second operand is a first-class
4162    value to insert.  The following operands are constant indices indicating
4163    the position at which to insert the value in a similar manner as indices in a
4164    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.  The
4165    value to insert must have the same type as the value identified by the
4166    indices.</p>
4167
4168 <h5>Semantics:</h5>
4169 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4170    that of <tt>val</tt> except that the value at the position specified by the
4171    indices is that of <tt>elt</tt>.</p>
4172
4173 <h5>Example:</h5>
4174 <pre>
4175   %agg1 = insertvalue {i32, float} undef, i32 1, 0         <i>; yields {i32 1, float undef}</i>
4176   %agg2 = insertvalue {i32, float} %agg1, float %val, 1    <i>; yields {i32 1, float %val}</i>
4177 </pre>
4178
4179 </div>
4180
4181
4182 <!-- ======================================================================= -->
4183 <div class="doc_subsection">
4184   <a name="memoryops">Memory Access and Addressing Operations</a>
4185 </div>
4186
4187 <div class="doc_text">
4188
4189 <p>A key design point of an SSA-based representation is how it represents
4190    memory.  In LLVM, no memory locations are in SSA form, which makes things
4191    very simple.  This section describes how to read, write, and allocate
4192    memory in LLVM.</p>
4193
4194 </div>
4195
4196 <!-- _______________________________________________________________________ -->
4197 <div class="doc_subsubsection">
4198   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4199 </div>
4200
4201 <div class="doc_text">
4202
4203 <h5>Syntax:</h5>
4204 <pre>
4205   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4206 </pre>
4207
4208 <h5>Overview:</h5>
4209 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4210    currently executing function, to be automatically released when this function
4211    returns to its caller. The object is always allocated in the generic address
4212    space (address space zero).</p>
4213
4214 <h5>Arguments:</h5>
4215 <p>The '<tt>alloca</tt>' instruction
4216    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4217    runtime stack, returning a pointer of the appropriate type to the program.
4218    If "NumElements" is specified, it is the number of elements allocated,
4219    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4220    specified, the value result of the allocation is guaranteed to be aligned to
4221    at least that boundary.  If not specified, or if zero, the target can choose
4222    to align the allocation on any convenient boundary compatible with the
4223    type.</p>
4224
4225 <p>'<tt>type</tt>' may be any sized type.</p>
4226
4227 <h5>Semantics:</h5>
4228 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4229    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4230    memory is automatically released when the function returns.  The
4231    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4232    variables that must have an address available.  When the function returns
4233    (either with the <tt><a href="#i_ret">ret</a></tt>
4234    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4235    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4236
4237 <h5>Example:</h5>
4238 <pre>
4239   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4240   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4241   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4242   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4243 </pre>
4244
4245 </div>
4246
4247 <!-- _______________________________________________________________________ -->
4248 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
4249 Instruction</a> </div>
4250
4251 <div class="doc_text">
4252
4253 <h5>Syntax:</h5>
4254 <pre>
4255   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4256   &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4257   !&lt;index&gt; = !{ i32 1 }
4258 </pre>
4259
4260 <h5>Overview:</h5>
4261 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4262
4263 <h5>Arguments:</h5>
4264 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4265    from which to load.  The pointer must point to
4266    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4267    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4268    number or order of execution of this <tt>load</tt> with other <a
4269    href="#volatile">volatile operations</a>.</p>
4270
4271 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4272    operation (that is, the alignment of the memory address). A value of 0 or an
4273    omitted <tt>align</tt> argument means that the operation has the preferential
4274    alignment for the target. It is the responsibility of the code emitter to
4275    ensure that the alignment information is correct. Overestimating the
4276    alignment results in undefined behavior. Underestimating the alignment may
4277    produce less efficient code. An alignment of 1 is always safe.</p>
4278
4279 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4280    metatadata name &lt;index&gt; corresponding to a metadata node with
4281    one <tt>i32</tt> entry of value 1.  The existence of
4282    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4283    and code generator that this load is not expected to be reused in the cache.
4284    The code generator may select special instructions to save cache bandwidth,
4285    such as the <tt>MOVNT</tt> instruction on x86.</p>
4286
4287 <h5>Semantics:</h5>
4288 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4289    scalar type then the number of bytes read does not exceed the minimum number
4290    of bytes needed to hold all bits of the type.  For example, loading an
4291    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4292    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4293    is undefined if the value was not originally written using a store of the
4294    same type.</p>
4295
4296 <h5>Examples:</h5>
4297 <pre>
4298   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4299   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4300   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4301 </pre>
4302
4303 </div>
4304
4305 <!-- _______________________________________________________________________ -->
4306 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
4307 Instruction</a> </div>
4308
4309 <div class="doc_text">
4310
4311 <h5>Syntax:</h5>
4312 <pre>
4313   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>
4314   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>
4315 </pre>
4316
4317 <h5>Overview:</h5>
4318 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4319
4320 <h5>Arguments:</h5>
4321 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4322    and an address at which to store it.  The type of the
4323    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4324    the <a href="#t_firstclass">first class</a> type of the
4325    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4326    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4327    order of execution of this <tt>store</tt> with other <a
4328    href="#volatile">volatile operations</a>.</p>
4329
4330 <p>The optional constant "align" argument specifies the alignment of the
4331    operation (that is, the alignment of the memory address). A value of 0 or an
4332    omitted "align" 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 an undefined behavior. Underestimating the alignment may
4336    produce less efficient code. An alignment of 1 is always safe.</p>
4337
4338 <p>The optional !nontemporal metadata must reference a single metatadata
4339    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4340    value 1.  The existence of the !nontemporal metatadata on the
4341    instruction tells the optimizer and code generator that this load is
4342    not expected to be reused in the cache.  The code generator may
4343    select special instructions to save cache bandwidth, such as the
4344    MOVNT instruction on x86.</p>
4345
4346
4347 <h5>Semantics:</h5>
4348 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4349    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4350    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4351    does not exceed the minimum number of bytes needed to hold all bits of the
4352    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4353    writing a value of a type like <tt>i20</tt> with a size that is not an
4354    integral number of bytes, it is unspecified what happens to the extra bits
4355    that do not belong to the type, but they will typically be overwritten.</p>
4356
4357 <h5>Example:</h5>
4358 <pre>
4359   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4360   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4361   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4362 </pre>
4363
4364 </div>
4365
4366 <!-- _______________________________________________________________________ -->
4367 <div class="doc_subsubsection">
4368    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4369 </div>
4370
4371 <div class="doc_text">
4372
4373 <h5>Syntax:</h5>
4374 <pre>
4375   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4376   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4377 </pre>
4378
4379 <h5>Overview:</h5>
4380 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4381    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4382    It performs address calculation only and does not access memory.</p>
4383
4384 <h5>Arguments:</h5>
4385 <p>The first argument is always a pointer, and forms the basis of the
4386    calculation. The remaining arguments are indices that indicate which of the
4387    elements of the aggregate object are indexed. The interpretation of each
4388    index is dependent on the type being indexed into. The first index always
4389    indexes the pointer value given as the first argument, the second index
4390    indexes a value of the type pointed to (not necessarily the value directly
4391    pointed to, since the first index can be non-zero), etc. The first type
4392    indexed into must be a pointer value, subsequent types can be arrays,
4393    vectors, and structs. Note that subsequent types being indexed into
4394    can never be pointers, since that would require loading the pointer before
4395    continuing calculation.</p>
4396
4397 <p>The type of each index argument depends on the type it is indexing into.
4398    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4399    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4400    or vector, integers of any width are allowed, and they are not required to be
4401    constant.</p>
4402
4403 <p>For example, let's consider a C code fragment and how it gets compiled to
4404    LLVM:</p>
4405
4406 <pre class="doc_code">
4407 struct RT {
4408   char A;
4409   int B[10][20];
4410   char C;
4411 };
4412 struct ST {
4413   int X;
4414   double Y;
4415   struct RT Z;
4416 };
4417
4418 int *foo(struct ST *s) {
4419   return &amp;s[1].Z.B[5][13];
4420 }
4421 </pre>
4422
4423 <p>The LLVM code generated by the GCC frontend is:</p>
4424
4425 <pre class="doc_code">
4426 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4427 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4428
4429 define i32* @foo(%ST* %s) {
4430 entry:
4431   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4432   ret i32* %reg
4433 }
4434 </pre>
4435
4436 <h5>Semantics:</h5>
4437 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4438    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4439    }</tt>' type, a structure.  The second index indexes into the third element
4440    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4441    i8 }</tt>' type, another structure.  The third index indexes into the second
4442    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4443    array.  The two dimensions of the array are subscripted into, yielding an
4444    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4445    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4446
4447 <p>Note that it is perfectly legal to index partially through a structure,
4448    returning a pointer to an inner element.  Because of this, the LLVM code for
4449    the given testcase is equivalent to:</p>
4450
4451 <pre>
4452   define i32* @foo(%ST* %s) {
4453     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
4454     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
4455     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
4456     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
4457     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
4458     ret i32* %t5
4459   }
4460 </pre>
4461
4462 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
4463    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
4464    base pointer is not an <i>in bounds</i> address of an allocated object,
4465    or if any of the addresses that would be formed by successive addition of
4466    the offsets implied by the indices to the base address with infinitely
4467    precise arithmetic are not an <i>in bounds</i> address of that allocated
4468    object. The <i>in bounds</i> addresses for an allocated object are all
4469    the addresses that point into the object, plus the address one byte past
4470    the end.</p>
4471
4472 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
4473    the base address with silently-wrapping two's complement arithmetic, and
4474    the result value of the <tt>getelementptr</tt> may be outside the object
4475    pointed to by the base pointer. The result value may not necessarily be
4476    used to access memory though, even if it happens to point into allocated
4477    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
4478    section for more information.</p>
4479
4480 <p>The getelementptr instruction is often confusing.  For some more insight into
4481    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
4482
4483 <h5>Example:</h5>
4484 <pre>
4485     <i>; yields [12 x i8]*:aptr</i>
4486     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
4487     <i>; yields i8*:vptr</i>
4488     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
4489     <i>; yields i8*:eptr</i>
4490     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
4491     <i>; yields i32*:iptr</i>
4492     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
4493 </pre>
4494
4495 </div>
4496
4497 <!-- ======================================================================= -->
4498 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
4499 </div>
4500
4501 <div class="doc_text">
4502
4503 <p>The instructions in this category are the conversion instructions (casting)
4504    which all take a single operand and a type. They perform various bit
4505    conversions on the operand.</p>
4506
4507 </div>
4508
4509 <!-- _______________________________________________________________________ -->
4510 <div class="doc_subsubsection">
4511    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
4512 </div>
4513 <div class="doc_text">
4514
4515 <h5>Syntax:</h5>
4516 <pre>
4517   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4518 </pre>
4519
4520 <h5>Overview:</h5>
4521 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
4522    type <tt>ty2</tt>.</p>
4523
4524 <h5>Arguments:</h5>
4525 <p>The '<tt>trunc</tt>' instruction takes a <tt>value</tt> to trunc, which must
4526    be an <a href="#t_integer">integer</a> type, and a type that specifies the
4527    size and type of the result, which must be
4528    an <a href="#t_integer">integer</a> type. The bit size of <tt>value</tt> must
4529    be larger than the bit size of <tt>ty2</tt>. Equal sized types are not
4530    allowed.</p>
4531
4532 <h5>Semantics:</h5>
4533 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
4534    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
4535    source size must be larger than the destination size, <tt>trunc</tt> cannot
4536    be a <i>no-op cast</i>.  It will always truncate bits.</p>
4537
4538 <h5>Example:</h5>
4539 <pre>
4540   %X = trunc i32 257 to i8              <i>; yields i8:1</i>
4541   %Y = trunc i32 123 to i1              <i>; yields i1:true</i>
4542   %Z = trunc i32 122 to i1              <i>; yields i1:false</i>
4543 </pre>
4544
4545 </div>
4546
4547 <!-- _______________________________________________________________________ -->
4548 <div class="doc_subsubsection">
4549    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
4550 </div>
4551 <div class="doc_text">
4552
4553 <h5>Syntax:</h5>
4554 <pre>
4555   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4556 </pre>
4557
4558 <h5>Overview:</h5>
4559 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
4560    <tt>ty2</tt>.</p>
4561
4562
4563 <h5>Arguments:</h5>
4564 <p>The '<tt>zext</tt>' instruction takes a value to cast, which must be of
4565    <a href="#t_integer">integer</a> type, and a type to cast it to, which must
4566    also be of <a href="#t_integer">integer</a> type. The bit size of the
4567    <tt>value</tt> must be smaller than the bit size of the destination type,
4568    <tt>ty2</tt>.</p>
4569
4570 <h5>Semantics:</h5>
4571 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
4572    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
4573
4574 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
4575
4576 <h5>Example:</h5>
4577 <pre>
4578   %X = zext i32 257 to i64              <i>; yields i64:257</i>
4579   %Y = zext i1 true to i32              <i>; yields i32:1</i>
4580 </pre>
4581
4582 </div>
4583
4584 <!-- _______________________________________________________________________ -->
4585 <div class="doc_subsubsection">
4586    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
4587 </div>
4588 <div class="doc_text">
4589
4590 <h5>Syntax:</h5>
4591 <pre>
4592   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4593 </pre>
4594
4595 <h5>Overview:</h5>
4596 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
4597
4598 <h5>Arguments:</h5>
4599 <p>The '<tt>sext</tt>' instruction takes a value to cast, which must be of
4600    <a href="#t_integer">integer</a> type, and a type to cast it to, which must
4601    also be of <a href="#t_integer">integer</a> type.  The bit size of the
4602    <tt>value</tt> must be smaller than the bit size of the destination type,
4603    <tt>ty2</tt>.</p>
4604
4605 <h5>Semantics:</h5>
4606 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
4607    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
4608    of the type <tt>ty2</tt>.</p>
4609
4610 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
4611
4612 <h5>Example:</h5>
4613 <pre>
4614   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
4615   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
4616 </pre>
4617
4618 </div>
4619
4620 <!-- _______________________________________________________________________ -->
4621 <div class="doc_subsubsection">
4622    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
4623 </div>
4624
4625 <div class="doc_text">
4626
4627 <h5>Syntax:</h5>
4628 <pre>
4629   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4630 </pre>
4631
4632 <h5>Overview:</h5>
4633 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
4634    <tt>ty2</tt>.</p>
4635
4636 <h5>Arguments:</h5>
4637 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
4638    point</a> value to cast and a <a href="#t_floating">floating point</a> type
4639    to cast it to. The size of <tt>value</tt> must be larger than the size of
4640    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
4641    <i>no-op cast</i>.</p>
4642
4643 <h5>Semantics:</h5>
4644 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
4645    <a href="#t_floating">floating point</a> type to a smaller
4646    <a href="#t_floating">floating point</a> type.  If the value cannot fit
4647    within the destination type, <tt>ty2</tt>, then the results are
4648    undefined.</p>
4649
4650 <h5>Example:</h5>
4651 <pre>
4652   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
4653   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
4654 </pre>
4655
4656 </div>
4657
4658 <!-- _______________________________________________________________________ -->
4659 <div class="doc_subsubsection">
4660    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
4661 </div>
4662 <div class="doc_text">
4663
4664 <h5>Syntax:</h5>
4665 <pre>
4666   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4667 </pre>
4668
4669 <h5>Overview:</h5>
4670 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
4671    floating point value.</p>
4672
4673 <h5>Arguments:</h5>
4674 <p>The '<tt>fpext</tt>' instruction takes a
4675    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
4676    a <a href="#t_floating">floating point</a> type to cast it to. The source
4677    type must be smaller than the destination type.</p>
4678
4679 <h5>Semantics:</h5>
4680 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
4681    <a href="#t_floating">floating point</a> type to a larger
4682    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
4683    used to make a <i>no-op cast</i> because it always changes bits. Use
4684    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
4685
4686 <h5>Example:</h5>
4687 <pre>
4688   %X = fpext float 3.1415 to double        <i>; yields double:3.1415</i>
4689   %Y = fpext float 1.0 to float            <i>; yields float:1.0 (no-op)</i>
4690 </pre>
4691
4692 </div>
4693
4694 <!-- _______________________________________________________________________ -->
4695 <div class="doc_subsubsection">
4696    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
4697 </div>
4698 <div class="doc_text">
4699
4700 <h5>Syntax:</h5>
4701 <pre>
4702   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4703 </pre>
4704
4705 <h5>Overview:</h5>
4706 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
4707    unsigned integer equivalent of type <tt>ty2</tt>.</p>
4708
4709 <h5>Arguments:</h5>
4710 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
4711    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4712    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4713    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4714    vector integer type with the same number of elements as <tt>ty</tt></p>
4715
4716 <h5>Semantics:</h5>
4717 <p>The '<tt>fptoui</tt>' instruction converts its
4718    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4719    towards zero) unsigned integer value. If the value cannot fit
4720    in <tt>ty2</tt>, the results are undefined.</p>
4721
4722 <h5>Example:</h5>
4723 <pre>
4724   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
4725   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
4726   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
4727 </pre>
4728
4729 </div>
4730
4731 <!-- _______________________________________________________________________ -->
4732 <div class="doc_subsubsection">
4733    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
4734 </div>
4735 <div class="doc_text">
4736
4737 <h5>Syntax:</h5>
4738 <pre>
4739   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4740 </pre>
4741
4742 <h5>Overview:</h5>
4743 <p>The '<tt>fptosi</tt>' instruction converts
4744    <a href="#t_floating">floating point</a> <tt>value</tt> to
4745    type <tt>ty2</tt>.</p>
4746
4747 <h5>Arguments:</h5>
4748 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
4749    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4750    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4751    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4752    vector integer type with the same number of elements as <tt>ty</tt></p>
4753
4754 <h5>Semantics:</h5>
4755 <p>The '<tt>fptosi</tt>' instruction converts its
4756    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4757    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
4758    the results are undefined.</p>
4759
4760 <h5>Example:</h5>
4761 <pre>
4762   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
4763   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
4764   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
4765 </pre>
4766
4767 </div>
4768
4769 <!-- _______________________________________________________________________ -->
4770 <div class="doc_subsubsection">
4771    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
4772 </div>
4773 <div class="doc_text">
4774
4775 <h5>Syntax:</h5>
4776 <pre>
4777   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4778 </pre>
4779
4780 <h5>Overview:</h5>
4781 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
4782    integer and converts that value to the <tt>ty2</tt> type.</p>
4783
4784 <h5>Arguments:</h5>
4785 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
4786    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4787    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4788    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4789    floating point type with the same number of elements as <tt>ty</tt></p>
4790
4791 <h5>Semantics:</h5>
4792 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
4793    integer quantity and converts it to the corresponding floating point
4794    value. If the value cannot fit in the floating point value, the results are
4795    undefined.</p>
4796
4797 <h5>Example:</h5>
4798 <pre>
4799   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
4800   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
4801 </pre>
4802
4803 </div>
4804
4805 <!-- _______________________________________________________________________ -->
4806 <div class="doc_subsubsection">
4807    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
4808 </div>
4809 <div class="doc_text">
4810
4811 <h5>Syntax:</h5>
4812 <pre>
4813   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4814 </pre>
4815
4816 <h5>Overview:</h5>
4817 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
4818    and converts that value to the <tt>ty2</tt> type.</p>
4819
4820 <h5>Arguments:</h5>
4821 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
4822    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4823    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4824    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4825    floating point type with the same number of elements as <tt>ty</tt></p>
4826
4827 <h5>Semantics:</h5>
4828 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
4829    quantity and converts it to the corresponding floating point value. If the
4830    value cannot fit in the floating point value, the results are undefined.</p>
4831
4832 <h5>Example:</h5>
4833 <pre>
4834   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
4835   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
4836 </pre>
4837
4838 </div>
4839
4840 <!-- _______________________________________________________________________ -->
4841 <div class="doc_subsubsection">
4842    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
4843 </div>
4844 <div class="doc_text">
4845
4846 <h5>Syntax:</h5>
4847 <pre>
4848   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4849 </pre>
4850
4851 <h5>Overview:</h5>
4852 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
4853    the integer type <tt>ty2</tt>.</p>
4854
4855 <h5>Arguments:</h5>
4856 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
4857    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
4858    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
4859
4860 <h5>Semantics:</h5>
4861 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
4862    <tt>ty2</tt> by interpreting the pointer value as an integer and either
4863    truncating or zero extending that value to the size of the integer type. If
4864    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
4865    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
4866    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
4867    change.</p>
4868
4869 <h5>Example:</h5>
4870 <pre>
4871   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
4872   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
4873 </pre>
4874
4875 </div>
4876
4877 <!-- _______________________________________________________________________ -->
4878 <div class="doc_subsubsection">
4879    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
4880 </div>
4881 <div class="doc_text">
4882
4883 <h5>Syntax:</h5>
4884 <pre>
4885   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4886 </pre>
4887
4888 <h5>Overview:</h5>
4889 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
4890    pointer type, <tt>ty2</tt>.</p>
4891
4892 <h5>Arguments:</h5>
4893 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
4894    value to cast, and a type to cast it to, which must be a
4895    <a href="#t_pointer">pointer</a> type.</p>
4896
4897 <h5>Semantics:</h5>
4898 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
4899    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
4900    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
4901    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
4902    than the size of a pointer then a zero extension is done. If they are the
4903    same size, nothing is done (<i>no-op cast</i>).</p>
4904
4905 <h5>Example:</h5>
4906 <pre>
4907   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
4908   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
4909   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
4910 </pre>
4911
4912 </div>
4913
4914 <!-- _______________________________________________________________________ -->
4915 <div class="doc_subsubsection">
4916    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
4917 </div>
4918 <div class="doc_text">
4919
4920 <h5>Syntax:</h5>
4921 <pre>
4922   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4923 </pre>
4924
4925 <h5>Overview:</h5>
4926 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4927    <tt>ty2</tt> without changing any bits.</p>
4928
4929 <h5>Arguments:</h5>
4930 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
4931    non-aggregate first class value, and a type to cast it to, which must also be
4932    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
4933    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
4934    identical. If the source type is a pointer, the destination type must also be
4935    a pointer.  This instruction supports bitwise conversion of vectors to
4936    integers and to vectors of other types (as long as they have the same
4937    size).</p>
4938
4939 <h5>Semantics:</h5>
4940 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4941    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
4942    this conversion.  The conversion is done as if the <tt>value</tt> had been
4943    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
4944    be converted to other pointer types with this instruction. To convert
4945    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
4946    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
4947
4948 <h5>Example:</h5>
4949 <pre>
4950   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
4951   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
4952   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
4953 </pre>
4954
4955 </div>
4956
4957 <!-- ======================================================================= -->
4958 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
4959
4960 <div class="doc_text">
4961
4962 <p>The instructions in this category are the "miscellaneous" instructions, which
4963    defy better classification.</p>
4964
4965 </div>
4966
4967 <!-- _______________________________________________________________________ -->
4968 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
4969 </div>
4970
4971 <div class="doc_text">
4972
4973 <h5>Syntax:</h5>
4974 <pre>
4975   &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>
4976 </pre>
4977
4978 <h5>Overview:</h5>
4979 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
4980    boolean values based on comparison of its two integer, integer vector, or
4981    pointer operands.</p>
4982
4983 <h5>Arguments:</h5>
4984 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
4985    the condition code indicating the kind of comparison to perform. It is not a
4986    value, just a keyword. The possible condition code are:</p>
4987
4988 <ol>
4989   <li><tt>eq</tt>: equal</li>
4990   <li><tt>ne</tt>: not equal </li>
4991   <li><tt>ugt</tt>: unsigned greater than</li>
4992   <li><tt>uge</tt>: unsigned greater or equal</li>
4993   <li><tt>ult</tt>: unsigned less than</li>
4994   <li><tt>ule</tt>: unsigned less or equal</li>
4995   <li><tt>sgt</tt>: signed greater than</li>
4996   <li><tt>sge</tt>: signed greater or equal</li>
4997   <li><tt>slt</tt>: signed less than</li>
4998   <li><tt>sle</tt>: signed less or equal</li>
4999 </ol>
5000
5001 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5002    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5003    typed.  They must also be identical types.</p>
5004
5005 <h5>Semantics:</h5>
5006 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5007    condition code given as <tt>cond</tt>. The comparison performed always yields
5008    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5009    result, as follows:</p>
5010
5011 <ol>
5012   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5013       <tt>false</tt> otherwise. No sign interpretation is necessary or
5014       performed.</li>
5015
5016   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5017       <tt>false</tt> otherwise. No sign interpretation is necessary or
5018       performed.</li>
5019
5020   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5021       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5022
5023   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5024       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5025       to <tt>op2</tt>.</li>
5026
5027   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5028       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5029
5030   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5031       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5032
5033   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5034       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5035
5036   <li><tt>sge</tt>: interprets the operands as signed values and yields
5037       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5038       to <tt>op2</tt>.</li>
5039
5040   <li><tt>slt</tt>: interprets the operands as signed values and yields
5041       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5042
5043   <li><tt>sle</tt>: interprets the operands as signed values and yields
5044       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5045 </ol>
5046
5047 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5048    values are compared as if they were integers.</p>
5049
5050 <p>If the operands are integer vectors, then they are compared element by
5051    element. The result is an <tt>i1</tt> vector with the same number of elements
5052    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5053
5054 <h5>Example:</h5>
5055 <pre>
5056   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5057   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5058   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5059   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5060   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5061   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5062 </pre>
5063
5064 <p>Note that the code generator does not yet support vector types with
5065    the <tt>icmp</tt> instruction.</p>
5066
5067 </div>
5068
5069 <!-- _______________________________________________________________________ -->
5070 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5071 </div>
5072
5073 <div class="doc_text">
5074
5075 <h5>Syntax:</h5>
5076 <pre>
5077   &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>
5078 </pre>
5079
5080 <h5>Overview:</h5>
5081 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5082    values based on comparison of its operands.</p>
5083
5084 <p>If the operands are floating point scalars, then the result type is a boolean
5085 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5086
5087 <p>If the operands are floating point vectors, then the result type is a vector
5088    of boolean with the same number of elements as the operands being
5089    compared.</p>
5090
5091 <h5>Arguments:</h5>
5092 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5093    the condition code indicating the kind of comparison to perform. It is not a
5094    value, just a keyword. The possible condition code are:</p>
5095
5096 <ol>
5097   <li><tt>false</tt>: no comparison, always returns false</li>
5098   <li><tt>oeq</tt>: ordered and equal</li>
5099   <li><tt>ogt</tt>: ordered and greater than </li>
5100   <li><tt>oge</tt>: ordered and greater than or equal</li>
5101   <li><tt>olt</tt>: ordered and less than </li>
5102   <li><tt>ole</tt>: ordered and less than or equal</li>
5103   <li><tt>one</tt>: ordered and not equal</li>
5104   <li><tt>ord</tt>: ordered (no nans)</li>
5105   <li><tt>ueq</tt>: unordered or equal</li>
5106   <li><tt>ugt</tt>: unordered or greater than </li>
5107   <li><tt>uge</tt>: unordered or greater than or equal</li>
5108   <li><tt>ult</tt>: unordered or less than </li>
5109   <li><tt>ule</tt>: unordered or less than or equal</li>
5110   <li><tt>une</tt>: unordered or not equal</li>
5111   <li><tt>uno</tt>: unordered (either nans)</li>
5112   <li><tt>true</tt>: no comparison, always returns true</li>
5113 </ol>
5114
5115 <p><i>Ordered</i> means that neither operand is a QNAN while
5116    <i>unordered</i> means that either operand may be a QNAN.</p>
5117
5118 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5119    a <a href="#t_floating">floating point</a> type or
5120    a <a href="#t_vector">vector</a> of floating point type.  They must have
5121    identical types.</p>
5122
5123 <h5>Semantics:</h5>
5124 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5125    according to the condition code given as <tt>cond</tt>.  If the operands are
5126    vectors, then the vectors are compared element by element.  Each comparison
5127    performed always yields an <a href="#t_integer">i1</a> result, as
5128    follows:</p>
5129
5130 <ol>
5131   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5132
5133   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5134       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5135
5136   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5137       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5138
5139   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5140       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5141
5142   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5143       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5144
5145   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5146       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5147
5148   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5149       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5150
5151   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5152
5153   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5154       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5155
5156   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5157       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5158
5159   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5160       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5161
5162   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5163       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5164
5165   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5166       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5167
5168   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5169       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5170
5171   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5172
5173   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5174 </ol>
5175
5176 <h5>Example:</h5>
5177 <pre>
5178   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5179   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5180   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5181   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5182 </pre>
5183
5184 <p>Note that the code generator does not yet support vector types with
5185    the <tt>fcmp</tt> instruction.</p>
5186
5187 </div>
5188
5189 <!-- _______________________________________________________________________ -->
5190 <div class="doc_subsubsection">
5191   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5192 </div>
5193
5194 <div class="doc_text">
5195
5196 <h5>Syntax:</h5>
5197 <pre>
5198   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5199 </pre>
5200
5201 <h5>Overview:</h5>
5202 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5203    SSA graph representing the function.</p>
5204
5205 <h5>Arguments:</h5>
5206 <p>The type of the incoming values is specified with the first type field. After
5207    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5208    one pair for each predecessor basic block of the current block.  Only values
5209    of <a href="#t_firstclass">first class</a> type may be used as the value
5210    arguments to the PHI node.  Only labels may be used as the label
5211    arguments.</p>
5212
5213 <p>There must be no non-phi instructions between the start of a basic block and
5214    the PHI instructions: i.e. PHI instructions must be first in a basic
5215    block.</p>
5216
5217 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5218    occur on the edge from the corresponding predecessor block to the current
5219    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5220    value on the same edge).</p>
5221
5222 <h5>Semantics:</h5>
5223 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5224    specified by the pair corresponding to the predecessor basic block that
5225    executed just prior to the current block.</p>
5226
5227 <h5>Example:</h5>
5228 <pre>
5229 Loop:       ; Infinite loop that counts from 0 on up...
5230   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5231   %nextindvar = add i32 %indvar, 1
5232   br label %Loop
5233 </pre>
5234
5235 </div>
5236
5237 <!-- _______________________________________________________________________ -->
5238 <div class="doc_subsubsection">
5239    <a name="i_select">'<tt>select</tt>' Instruction</a>
5240 </div>
5241
5242 <div class="doc_text">
5243
5244 <h5>Syntax:</h5>
5245 <pre>
5246   &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>
5247
5248   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5249 </pre>
5250
5251 <h5>Overview:</h5>
5252 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5253    condition, without branching.</p>
5254
5255
5256 <h5>Arguments:</h5>
5257 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5258    values indicating the condition, and two values of the
5259    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5260    vectors and the condition is a scalar, then entire vectors are selected, not
5261    individual elements.</p>
5262
5263 <h5>Semantics:</h5>
5264 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5265    first value argument; otherwise, it returns the second value argument.</p>
5266
5267 <p>If the condition is a vector of i1, then the value arguments must be vectors
5268    of the same size, and the selection is done element by element.</p>
5269
5270 <h5>Example:</h5>
5271 <pre>
5272   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5273 </pre>
5274
5275 <p>Note that the code generator does not yet support conditions
5276    with vector type.</p>
5277
5278 </div>
5279
5280 <!-- _______________________________________________________________________ -->
5281 <div class="doc_subsubsection">
5282   <a name="i_call">'<tt>call</tt>' Instruction</a>
5283 </div>
5284
5285 <div class="doc_text">
5286
5287 <h5>Syntax:</h5>
5288 <pre>
5289   &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>]
5290 </pre>
5291
5292 <h5>Overview:</h5>
5293 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5294
5295 <h5>Arguments:</h5>
5296 <p>This instruction requires several arguments:</p>
5297
5298 <ol>
5299   <li>The optional "tail" marker indicates that the callee function does not
5300       access any allocas or varargs in the caller.  Note that calls may be
5301       marked "tail" even if they do not occur before
5302       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5303       present, the function call is eligible for tail call optimization,
5304       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5305       optimized into a jump</a>.  The code generator may optimize calls marked
5306       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5307       sibling call optimization</a> when the caller and callee have
5308       matching signatures, or 2) forced tail call optimization when the
5309       following extra requirements are met:
5310       <ul>
5311         <li>Caller and callee both have the calling
5312             convention <tt>fastcc</tt>.</li>
5313         <li>The call is in tail position (ret immediately follows call and ret
5314             uses value of call or is void).</li>
5315         <li>Option <tt>-tailcallopt</tt> is enabled,
5316             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5317         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5318             constraints are met.</a></li>
5319       </ul>
5320   </li>
5321
5322   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5323       convention</a> the call should use.  If none is specified, the call
5324       defaults to using C calling conventions.  The calling convention of the
5325       call must match the calling convention of the target function, or else the
5326       behavior is undefined.</li>
5327
5328   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5329       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5330       '<tt>inreg</tt>' attributes are valid here.</li>
5331
5332   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5333       type of the return value.  Functions that return no value are marked
5334       <tt><a href="#t_void">void</a></tt>.</li>
5335
5336   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5337       being invoked.  The argument types must match the types implied by this
5338       signature.  This type can be omitted if the function is not varargs and if
5339       the function type does not return a pointer to a function.</li>
5340
5341   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5342       be invoked. In most cases, this is a direct function invocation, but
5343       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5344       to function value.</li>
5345
5346   <li>'<tt>function args</tt>': argument list whose types match the function
5347       signature argument types and parameter attributes. All arguments must be
5348       of <a href="#t_firstclass">first class</a> type. If the function
5349       signature indicates the function accepts a variable number of arguments,
5350       the extra arguments can be specified.</li>
5351
5352   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5353       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5354       '<tt>readnone</tt>' attributes are valid here.</li>
5355 </ol>
5356
5357 <h5>Semantics:</h5>
5358 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5359    a specified function, with its incoming arguments bound to the specified
5360    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5361    function, control flow continues with the instruction after the function
5362    call, and the return value of the function is bound to the result
5363    argument.</p>
5364
5365 <h5>Example:</h5>
5366 <pre>
5367   %retval = call i32 @test(i32 %argc)
5368   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5369   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5370   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5371   call void %foo(i8 97 signext)
5372
5373   %struct.A = type { i32, i8 }
5374   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5375   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5376   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5377   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5378   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5379 </pre>
5380
5381 <p>llvm treats calls to some functions with names and arguments that match the
5382 standard C99 library as being the C99 library functions, and may perform
5383 optimizations or generate code for them under that assumption.  This is
5384 something we'd like to change in the future to provide better support for
5385 freestanding environments and non-C-based languages.</p>
5386
5387 </div>
5388
5389 <!-- _______________________________________________________________________ -->
5390 <div class="doc_subsubsection">
5391   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5392 </div>
5393
5394 <div class="doc_text">
5395
5396 <h5>Syntax:</h5>
5397 <pre>
5398   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5399 </pre>
5400
5401 <h5>Overview:</h5>
5402 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5403    the "variable argument" area of a function call.  It is used to implement the
5404    <tt>va_arg</tt> macro in C.</p>
5405
5406 <h5>Arguments:</h5>
5407 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5408    argument. It returns a value of the specified argument type and increments
5409    the <tt>va_list</tt> to point to the next argument.  The actual type
5410    of <tt>va_list</tt> is target specific.</p>
5411
5412 <h5>Semantics:</h5>
5413 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5414    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5415    to the next argument.  For more information, see the variable argument
5416    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5417
5418 <p>It is legal for this instruction to be called in a function which does not
5419    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5420    function.</p>
5421
5422 <p><tt>va_arg</tt> is an LLVM instruction instead of
5423    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5424    argument.</p>
5425
5426 <h5>Example:</h5>
5427 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
5428
5429 <p>Note that the code generator does not yet fully support va_arg on many
5430    targets. Also, it does not currently support va_arg with aggregate types on
5431    any target.</p>
5432
5433 </div>
5434
5435 <!-- *********************************************************************** -->
5436 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
5437 <!-- *********************************************************************** -->
5438
5439 <div class="doc_text">
5440
5441 <p>LLVM supports the notion of an "intrinsic function".  These functions have
5442    well known names and semantics and are required to follow certain
5443    restrictions.  Overall, these intrinsics represent an extension mechanism for
5444    the LLVM language that does not require changing all of the transformations
5445    in LLVM when adding to the language (or the bitcode reader/writer, the
5446    parser, etc...).</p>
5447
5448 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
5449    prefix is reserved in LLVM for intrinsic names; thus, function names may not
5450    begin with this prefix.  Intrinsic functions must always be external
5451    functions: you cannot define the body of intrinsic functions.  Intrinsic
5452    functions may only be used in call or invoke instructions: it is illegal to
5453    take the address of an intrinsic function.  Additionally, because intrinsic
5454    functions are part of the LLVM language, it is required if any are added that
5455    they be documented here.</p>
5456
5457 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
5458    family of functions that perform the same operation but on different data
5459    types. Because LLVM can represent over 8 million different integer types,
5460    overloading is used commonly to allow an intrinsic function to operate on any
5461    integer type. One or more of the argument types or the result type can be
5462    overloaded to accept any integer type. Argument types may also be defined as
5463    exactly matching a previous argument's type or the result type. This allows
5464    an intrinsic function which accepts multiple arguments, but needs all of them
5465    to be of the same type, to only be overloaded with respect to a single
5466    argument or the result.</p>
5467
5468 <p>Overloaded intrinsics will have the names of its overloaded argument types
5469    encoded into its function name, each preceded by a period. Only those types
5470    which are overloaded result in a name suffix. Arguments whose type is matched
5471    against another type do not. For example, the <tt>llvm.ctpop</tt> function
5472    can take an integer of any width and returns an integer of exactly the same
5473    integer width. This leads to a family of functions such as
5474    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
5475    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
5476    suffix is required. Because the argument's type is matched against the return
5477    type, it does not require its own name suffix.</p>
5478
5479 <p>To learn how to add an intrinsic function, please see the
5480    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
5481
5482 </div>
5483
5484 <!-- ======================================================================= -->
5485 <div class="doc_subsection">
5486   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
5487 </div>
5488
5489 <div class="doc_text">
5490
5491 <p>Variable argument support is defined in LLVM with
5492    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
5493    intrinsic functions.  These functions are related to the similarly named
5494    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
5495
5496 <p>All of these functions operate on arguments that use a target-specific value
5497    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
5498    not define what this type is, so all transformations should be prepared to
5499    handle these functions regardless of the type used.</p>
5500
5501 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
5502    instruction and the variable argument handling intrinsic functions are
5503    used.</p>
5504
5505 <pre class="doc_code">
5506 define i32 @test(i32 %X, ...) {
5507   ; Initialize variable argument processing
5508   %ap = alloca i8*
5509   %ap2 = bitcast i8** %ap to i8*
5510   call void @llvm.va_start(i8* %ap2)
5511
5512   ; Read a single integer argument
5513   %tmp = va_arg i8** %ap, i32
5514
5515   ; Demonstrate usage of llvm.va_copy and llvm.va_end
5516   %aq = alloca i8*
5517   %aq2 = bitcast i8** %aq to i8*
5518   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
5519   call void @llvm.va_end(i8* %aq2)
5520
5521   ; Stop processing of arguments.
5522   call void @llvm.va_end(i8* %ap2)
5523   ret i32 %tmp
5524 }
5525
5526 declare void @llvm.va_start(i8*)
5527 declare void @llvm.va_copy(i8*, i8*)
5528 declare void @llvm.va_end(i8*)
5529 </pre>
5530
5531 </div>
5532
5533 <!-- _______________________________________________________________________ -->
5534 <div class="doc_subsubsection">
5535   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
5536 </div>
5537
5538
5539 <div class="doc_text">
5540
5541 <h5>Syntax:</h5>
5542 <pre>
5543   declare void %llvm.va_start(i8* &lt;arglist&gt;)
5544 </pre>
5545
5546 <h5>Overview:</h5>
5547 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
5548    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
5549
5550 <h5>Arguments:</h5>
5551 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
5552
5553 <h5>Semantics:</h5>
5554 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
5555    macro available in C.  In a target-dependent way, it initializes
5556    the <tt>va_list</tt> element to which the argument points, so that the next
5557    call to <tt>va_arg</tt> will produce the first variable argument passed to
5558    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
5559    need to know the last argument of the function as the compiler can figure
5560    that out.</p>
5561
5562 </div>
5563
5564 <!-- _______________________________________________________________________ -->
5565 <div class="doc_subsubsection">
5566  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
5567 </div>
5568
5569 <div class="doc_text">
5570
5571 <h5>Syntax:</h5>
5572 <pre>
5573   declare void @llvm.va_end(i8* &lt;arglist&gt;)
5574 </pre>
5575
5576 <h5>Overview:</h5>
5577 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
5578    which has been initialized previously
5579    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
5580    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
5581
5582 <h5>Arguments:</h5>
5583 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
5584
5585 <h5>Semantics:</h5>
5586 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
5587    macro available in C.  In a target-dependent way, it destroys
5588    the <tt>va_list</tt> element to which the argument points.  Calls
5589    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
5590    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
5591    with calls to <tt>llvm.va_end</tt>.</p>
5592
5593 </div>
5594
5595 <!-- _______________________________________________________________________ -->
5596 <div class="doc_subsubsection">
5597   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
5598 </div>
5599
5600 <div class="doc_text">
5601
5602 <h5>Syntax:</h5>
5603 <pre>
5604   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
5605 </pre>
5606
5607 <h5>Overview:</h5>
5608 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
5609    from the source argument list to the destination argument list.</p>
5610
5611 <h5>Arguments:</h5>
5612 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
5613    The second argument is a pointer to a <tt>va_list</tt> element to copy
5614    from.</p>
5615
5616 <h5>Semantics:</h5>
5617 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
5618    macro available in C.  In a target-dependent way, it copies the
5619    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
5620    element.  This intrinsic is necessary because
5621    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
5622    arbitrarily complex and require, for example, memory allocation.</p>
5623
5624 </div>
5625
5626 <!-- ======================================================================= -->
5627 <div class="doc_subsection">
5628   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
5629 </div>
5630
5631 <div class="doc_text">
5632
5633 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
5634 Collection</a> (GC) requires the implementation and generation of these
5635 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
5636 roots on the stack</a>, as well as garbage collector implementations that
5637 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
5638 barriers.  Front-ends for type-safe garbage collected languages should generate
5639 these intrinsics to make use of the LLVM garbage collectors.  For more details,
5640 see <a href="GarbageCollection.html">Accurate Garbage Collection with
5641 LLVM</a>.</p>
5642
5643 <p>The garbage collection intrinsics only operate on objects in the generic
5644    address space (address space zero).</p>
5645
5646 </div>
5647
5648 <!-- _______________________________________________________________________ -->
5649 <div class="doc_subsubsection">
5650   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
5651 </div>
5652
5653 <div class="doc_text">
5654
5655 <h5>Syntax:</h5>
5656 <pre>
5657   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
5658 </pre>
5659
5660 <h5>Overview:</h5>
5661 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
5662    the code generator, and allows some metadata to be associated with it.</p>
5663
5664 <h5>Arguments:</h5>
5665 <p>The first argument specifies the address of a stack object that contains the
5666    root pointer.  The second pointer (which must be either a constant or a
5667    global value address) contains the meta-data to be associated with the
5668    root.</p>
5669
5670 <h5>Semantics:</h5>
5671 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
5672    location.  At compile-time, the code generator generates information to allow
5673    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
5674    intrinsic may only be used in a function which <a href="#gc">specifies a GC
5675    algorithm</a>.</p>
5676
5677 </div>
5678
5679 <!-- _______________________________________________________________________ -->
5680 <div class="doc_subsubsection">
5681   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
5682 </div>
5683
5684 <div class="doc_text">
5685
5686 <h5>Syntax:</h5>
5687 <pre>
5688   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
5689 </pre>
5690
5691 <h5>Overview:</h5>
5692 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
5693    locations, allowing garbage collector implementations that require read
5694    barriers.</p>
5695
5696 <h5>Arguments:</h5>
5697 <p>The second argument is the address to read from, which should be an address
5698    allocated from the garbage collector.  The first object is a pointer to the
5699    start of the referenced object, if needed by the language runtime (otherwise
5700    null).</p>
5701
5702 <h5>Semantics:</h5>
5703 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
5704    instruction, but may be replaced with substantially more complex code by the
5705    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
5706    may only be used in a function which <a href="#gc">specifies a GC
5707    algorithm</a>.</p>
5708
5709 </div>
5710
5711 <!-- _______________________________________________________________________ -->
5712 <div class="doc_subsubsection">
5713   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
5714 </div>
5715
5716 <div class="doc_text">
5717
5718 <h5>Syntax:</h5>
5719 <pre>
5720   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
5721 </pre>
5722
5723 <h5>Overview:</h5>
5724 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
5725    locations, allowing garbage collector implementations that require write
5726    barriers (such as generational or reference counting collectors).</p>
5727
5728 <h5>Arguments:</h5>
5729 <p>The first argument is the reference to store, the second is the start of the
5730    object to store it to, and the third is the address of the field of Obj to
5731    store to.  If the runtime does not require a pointer to the object, Obj may
5732    be null.</p>
5733
5734 <h5>Semantics:</h5>
5735 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
5736    instruction, but may be replaced with substantially more complex code by the
5737    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
5738    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_subsection">
5745   <a name="int_codegen">Code Generator Intrinsics</a>
5746 </div>
5747
5748 <div class="doc_text">
5749
5750 <p>These intrinsics are provided by LLVM to expose special features that may
5751    only be implemented with code generator support.</p>
5752
5753 </div>
5754
5755 <!-- _______________________________________________________________________ -->
5756 <div class="doc_subsubsection">
5757   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
5758 </div>
5759
5760 <div class="doc_text">
5761
5762 <h5>Syntax:</h5>
5763 <pre>
5764   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
5765 </pre>
5766
5767 <h5>Overview:</h5>
5768 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
5769    target-specific value indicating the return address of the current function
5770    or one of its callers.</p>
5771
5772 <h5>Arguments:</h5>
5773 <p>The argument to this intrinsic indicates which function to return the address
5774    for.  Zero indicates the calling function, one indicates its caller, etc.
5775    The argument is <b>required</b> to be a constant integer value.</p>
5776
5777 <h5>Semantics:</h5>
5778 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
5779    indicating the return address of the specified call frame, or zero if it
5780    cannot be identified.  The value returned by this intrinsic is likely to be
5781    incorrect or 0 for arguments other than zero, so it should only be used for
5782    debugging purposes.</p>
5783
5784 <p>Note that calling this intrinsic does not prevent function inlining or other
5785    aggressive transformations, so the value returned may not be that of the
5786    obvious source-language caller.</p>
5787
5788 </div>
5789
5790 <!-- _______________________________________________________________________ -->
5791 <div class="doc_subsubsection">
5792   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
5793 </div>
5794
5795 <div class="doc_text">
5796
5797 <h5>Syntax:</h5>
5798 <pre>
5799   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
5800 </pre>
5801
5802 <h5>Overview:</h5>
5803 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
5804    target-specific frame pointer value for the specified stack frame.</p>
5805
5806 <h5>Arguments:</h5>
5807 <p>The argument to this intrinsic indicates which function to return the frame
5808    pointer for.  Zero indicates the calling function, one indicates its caller,
5809    etc.  The argument is <b>required</b> to be a constant integer value.</p>
5810
5811 <h5>Semantics:</h5>
5812 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
5813    indicating the frame address of the specified call frame, or zero if it
5814    cannot be identified.  The value returned by this intrinsic is likely to be
5815    incorrect or 0 for arguments other than zero, so it should only be used for
5816    debugging purposes.</p>
5817
5818 <p>Note that calling this intrinsic does not prevent function inlining or other
5819    aggressive transformations, so the value returned may not be that of the
5820    obvious source-language caller.</p>
5821
5822 </div>
5823
5824 <!-- _______________________________________________________________________ -->
5825 <div class="doc_subsubsection">
5826   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
5827 </div>
5828
5829 <div class="doc_text">
5830
5831 <h5>Syntax:</h5>
5832 <pre>
5833   declare i8* @llvm.stacksave()
5834 </pre>
5835
5836 <h5>Overview:</h5>
5837 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
5838    of the function stack, for use
5839    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
5840    useful for implementing language features like scoped automatic variable
5841    sized arrays in C99.</p>
5842
5843 <h5>Semantics:</h5>
5844 <p>This intrinsic returns a opaque pointer value that can be passed
5845    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
5846    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
5847    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
5848    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
5849    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
5850    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
5851
5852 </div>
5853
5854 <!-- _______________________________________________________________________ -->
5855 <div class="doc_subsubsection">
5856   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
5857 </div>
5858
5859 <div class="doc_text">
5860
5861 <h5>Syntax:</h5>
5862 <pre>
5863   declare void @llvm.stackrestore(i8* %ptr)
5864 </pre>
5865
5866 <h5>Overview:</h5>
5867 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
5868    the function stack to the state it was in when the
5869    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
5870    executed.  This is useful for implementing language features like scoped
5871    automatic variable sized arrays in C99.</p>
5872
5873 <h5>Semantics:</h5>
5874 <p>See the description
5875    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
5876
5877 </div>
5878
5879 <!-- _______________________________________________________________________ -->
5880 <div class="doc_subsubsection">
5881   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
5882 </div>
5883
5884 <div class="doc_text">
5885
5886 <h5>Syntax:</h5>
5887 <pre>
5888   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;)
5889 </pre>
5890
5891 <h5>Overview:</h5>
5892 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
5893    insert a prefetch instruction if supported; otherwise, it is a noop.
5894    Prefetches have no effect on the behavior of the program but can change its
5895    performance characteristics.</p>
5896
5897 <h5>Arguments:</h5>
5898 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
5899    specifier determining if the fetch should be for a read (0) or write (1),
5900    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
5901    locality, to (3) - extremely local keep in cache.  The <tt>rw</tt>
5902    and <tt>locality</tt> arguments must be constant integers.</p>
5903
5904 <h5>Semantics:</h5>
5905 <p>This intrinsic does not modify the behavior of the program.  In particular,
5906    prefetches cannot trap and do not produce a value.  On targets that support
5907    this intrinsic, the prefetch can provide hints to the processor cache for
5908    better performance.</p>
5909
5910 </div>
5911
5912 <!-- _______________________________________________________________________ -->
5913 <div class="doc_subsubsection">
5914   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
5915 </div>
5916
5917 <div class="doc_text">
5918
5919 <h5>Syntax:</h5>
5920 <pre>
5921   declare void @llvm.pcmarker(i32 &lt;id&gt;)
5922 </pre>
5923
5924 <h5>Overview:</h5>
5925 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
5926    Counter (PC) in a region of code to simulators and other tools.  The method
5927    is target specific, but it is expected that the marker will use exported
5928    symbols to transmit the PC of the marker.  The marker makes no guarantees
5929    that it will remain with any specific instruction after optimizations.  It is
5930    possible that the presence of a marker will inhibit optimizations.  The
5931    intended use is to be inserted after optimizations to allow correlations of
5932    simulation runs.</p>
5933
5934 <h5>Arguments:</h5>
5935 <p><tt>id</tt> is a numerical id identifying the marker.</p>
5936
5937 <h5>Semantics:</h5>
5938 <p>This intrinsic does not modify the behavior of the program.  Backends that do
5939    not support this intrinsic may ignore it.</p>
5940
5941 </div>
5942
5943 <!-- _______________________________________________________________________ -->
5944 <div class="doc_subsubsection">
5945   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
5946 </div>
5947
5948 <div class="doc_text">
5949
5950 <h5>Syntax:</h5>
5951 <pre>
5952   declare i64 @llvm.readcyclecounter()
5953 </pre>
5954
5955 <h5>Overview:</h5>
5956 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
5957    counter register (or similar low latency, high accuracy clocks) on those
5958    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
5959    should map to RPCC.  As the backing counters overflow quickly (on the order
5960    of 9 seconds on alpha), this should only be used for small timings.</p>
5961
5962 <h5>Semantics:</h5>
5963 <p>When directly supported, reading the cycle counter should not modify any
5964    memory.  Implementations are allowed to either return a application specific
5965    value or a system wide value.  On backends without support, this is lowered
5966    to a constant 0.</p>
5967
5968 </div>
5969
5970 <!-- ======================================================================= -->
5971 <div class="doc_subsection">
5972   <a name="int_libc">Standard C Library Intrinsics</a>
5973 </div>
5974
5975 <div class="doc_text">
5976
5977 <p>LLVM provides intrinsics for a few important standard C library functions.
5978    These intrinsics allow source-language front-ends to pass information about
5979    the alignment of the pointer arguments to the code generator, providing
5980    opportunity for more efficient code generation.</p>
5981
5982 </div>
5983
5984 <!-- _______________________________________________________________________ -->
5985 <div class="doc_subsubsection">
5986   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
5987 </div>
5988
5989 <div class="doc_text">
5990
5991 <h5>Syntax:</h5>
5992 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
5993    integer bit width and for different address spaces. Not all targets support
5994    all bit widths however.</p>
5995
5996 <pre>
5997   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
5998                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
5999   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6000                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6001 </pre>
6002
6003 <h5>Overview:</h5>
6004 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6005    source location to the destination location.</p>
6006
6007 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6008    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6009    and the pointers can be in specified address spaces.</p>
6010
6011 <h5>Arguments:</h5>
6012
6013 <p>The first argument is a pointer to the destination, the second is a pointer
6014    to the source.  The third argument is an integer argument specifying the
6015    number of bytes to copy, the fourth argument is the alignment of the
6016    source and destination locations, and the fifth is a boolean indicating a
6017    volatile access.</p>
6018
6019 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6020    then the caller guarantees that both the source and destination pointers are
6021    aligned to that boundary.</p>
6022
6023 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6024    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6025    The detailed access behavior is not very cleanly specified and it is unwise
6026    to depend on it.</p>
6027
6028 <h5>Semantics:</h5>
6029
6030 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6031    source location to the destination location, which are not allowed to
6032    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6033    be aligned to some boundary, this can be specified as the fourth argument,
6034    otherwise it should be set to 0 or 1.</p>
6035
6036 </div>
6037
6038 <!-- _______________________________________________________________________ -->
6039 <div class="doc_subsubsection">
6040   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6041 </div>
6042
6043 <div class="doc_text">
6044
6045 <h5>Syntax:</h5>
6046 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6047    width and for different address space. Not all targets support all bit
6048    widths however.</p>
6049
6050 <pre>
6051   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6052                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6053   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6054                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6055 </pre>
6056
6057 <h5>Overview:</h5>
6058 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6059    source location to the destination location. It is similar to the
6060    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6061    overlap.</p>
6062
6063 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6064    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6065    and the pointers can be in specified address spaces.</p>
6066
6067 <h5>Arguments:</h5>
6068
6069 <p>The first argument is a pointer to the destination, the second is a pointer
6070    to the source.  The third argument is an integer argument specifying the
6071    number of bytes to copy, the fourth argument is the alignment of the
6072    source and destination locations, and the fifth is a boolean indicating a
6073    volatile access.</p>
6074
6075 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6076    then the caller guarantees that the source and destination pointers are
6077    aligned to that boundary.</p>
6078
6079 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6080    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6081    The detailed access behavior is not very cleanly specified and it is unwise
6082    to depend on it.</p>
6083
6084 <h5>Semantics:</h5>
6085
6086 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6087    source location to the destination location, which may overlap.  It copies
6088    "len" bytes of memory over.  If the argument is known to be aligned to some
6089    boundary, this can be specified as the fourth argument, otherwise it should
6090    be set to 0 or 1.</p>
6091
6092 </div>
6093
6094 <!-- _______________________________________________________________________ -->
6095 <div class="doc_subsubsection">
6096   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6097 </div>
6098
6099 <div class="doc_text">
6100
6101 <h5>Syntax:</h5>
6102 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6103    width and for different address spaces. However, not all targets support all
6104    bit widths.</p>
6105
6106 <pre>
6107   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6108                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6109   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6110                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6111 </pre>
6112
6113 <h5>Overview:</h5>
6114 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6115    particular byte value.</p>
6116
6117 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6118    intrinsic does not return a value and takes extra alignment/volatile
6119    arguments.  Also, the destination can be in an arbitrary address space.</p>
6120
6121 <h5>Arguments:</h5>
6122 <p>The first argument is a pointer to the destination to fill, the second is the
6123    byte value with which to fill it, the third argument is an integer argument
6124    specifying the number of bytes to fill, and the fourth argument is the known
6125    alignment of the destination location.</p>
6126
6127 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6128    then the caller guarantees that the destination pointer is aligned to that
6129    boundary.</p>
6130
6131 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6132    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6133    The detailed access behavior is not very cleanly specified and it is unwise
6134    to depend on it.</p>
6135
6136 <h5>Semantics:</h5>
6137 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6138    at the destination location.  If the argument is known to be aligned to some
6139    boundary, this can be specified as the fourth argument, otherwise it should
6140    be set to 0 or 1.</p>
6141
6142 </div>
6143
6144 <!-- _______________________________________________________________________ -->
6145 <div class="doc_subsubsection">
6146   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6147 </div>
6148
6149 <div class="doc_text">
6150
6151 <h5>Syntax:</h5>
6152 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6153    floating point or vector of floating point type. Not all targets support all
6154    types however.</p>
6155
6156 <pre>
6157   declare float     @llvm.sqrt.f32(float %Val)
6158   declare double    @llvm.sqrt.f64(double %Val)
6159   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6160   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6161   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6162 </pre>
6163
6164 <h5>Overview:</h5>
6165 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6166    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6167    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6168    behavior for negative numbers other than -0.0 (which allows for better
6169    optimization, because there is no need to worry about errno being
6170    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6171
6172 <h5>Arguments:</h5>
6173 <p>The argument and return value are floating point numbers of the same
6174    type.</p>
6175
6176 <h5>Semantics:</h5>
6177 <p>This function returns the sqrt of the specified operand if it is a
6178    nonnegative floating point number.</p>
6179
6180 </div>
6181
6182 <!-- _______________________________________________________________________ -->
6183 <div class="doc_subsubsection">
6184   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6185 </div>
6186
6187 <div class="doc_text">
6188
6189 <h5>Syntax:</h5>
6190 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6191    floating point or vector of floating point type. Not all targets support all
6192    types however.</p>
6193
6194 <pre>
6195   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6196   declare double    @llvm.powi.f64(double %Val, i32 %power)
6197   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6198   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6199   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6200 </pre>
6201
6202 <h5>Overview:</h5>
6203 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6204    specified (positive or negative) power.  The order of evaluation of
6205    multiplications is not defined.  When a vector of floating point type is
6206    used, the second argument remains a scalar integer value.</p>
6207
6208 <h5>Arguments:</h5>
6209 <p>The second argument is an integer power, and the first is a value to raise to
6210    that power.</p>
6211
6212 <h5>Semantics:</h5>
6213 <p>This function returns the first value raised to the second power with an
6214    unspecified sequence of rounding operations.</p>
6215
6216 </div>
6217
6218 <!-- _______________________________________________________________________ -->
6219 <div class="doc_subsubsection">
6220   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6221 </div>
6222
6223 <div class="doc_text">
6224
6225 <h5>Syntax:</h5>
6226 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6227    floating point or vector of floating point type. Not all targets support all
6228    types however.</p>
6229
6230 <pre>
6231   declare float     @llvm.sin.f32(float  %Val)
6232   declare double    @llvm.sin.f64(double %Val)
6233   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6234   declare fp128     @llvm.sin.f128(fp128 %Val)
6235   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6236 </pre>
6237
6238 <h5>Overview:</h5>
6239 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6240
6241 <h5>Arguments:</h5>
6242 <p>The argument and return value are floating point numbers of the same
6243    type.</p>
6244
6245 <h5>Semantics:</h5>
6246 <p>This function returns the sine of the specified operand, returning the same
6247    values as the libm <tt>sin</tt> functions would, and handles error conditions
6248    in the same way.</p>
6249
6250 </div>
6251
6252 <!-- _______________________________________________________________________ -->
6253 <div class="doc_subsubsection">
6254   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6255 </div>
6256
6257 <div class="doc_text">
6258
6259 <h5>Syntax:</h5>
6260 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6261    floating point or vector of floating point type. Not all targets support all
6262    types however.</p>
6263
6264 <pre>
6265   declare float     @llvm.cos.f32(float  %Val)
6266   declare double    @llvm.cos.f64(double %Val)
6267   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6268   declare fp128     @llvm.cos.f128(fp128 %Val)
6269   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6270 </pre>
6271
6272 <h5>Overview:</h5>
6273 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6274
6275 <h5>Arguments:</h5>
6276 <p>The argument and return value are floating point numbers of the same
6277    type.</p>
6278
6279 <h5>Semantics:</h5>
6280 <p>This function returns the cosine of the specified operand, returning the same
6281    values as the libm <tt>cos</tt> functions would, and handles error conditions
6282    in the same way.</p>
6283
6284 </div>
6285
6286 <!-- _______________________________________________________________________ -->
6287 <div class="doc_subsubsection">
6288   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6289 </div>
6290
6291 <div class="doc_text">
6292
6293 <h5>Syntax:</h5>
6294 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6295    floating point or vector of floating point type. Not all targets support all
6296    types however.</p>
6297
6298 <pre>
6299   declare float     @llvm.pow.f32(float  %Val, float %Power)
6300   declare double    @llvm.pow.f64(double %Val, double %Power)
6301   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6302   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6303   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6304 </pre>
6305
6306 <h5>Overview:</h5>
6307 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6308    specified (positive or negative) power.</p>
6309
6310 <h5>Arguments:</h5>
6311 <p>The second argument is a floating point power, and the first is a value to
6312    raise to that power.</p>
6313
6314 <h5>Semantics:</h5>
6315 <p>This function returns the first value raised to the second power, returning
6316    the same values as the libm <tt>pow</tt> functions would, and handles error
6317    conditions in the same way.</p>
6318
6319 </div>
6320
6321 <!-- ======================================================================= -->
6322 <div class="doc_subsection">
6323   <a name="int_manip">Bit Manipulation Intrinsics</a>
6324 </div>
6325
6326 <div class="doc_text">
6327
6328 <p>LLVM provides intrinsics for a few important bit manipulation operations.
6329    These allow efficient code generation for some algorithms.</p>
6330
6331 </div>
6332
6333 <!-- _______________________________________________________________________ -->
6334 <div class="doc_subsubsection">
6335   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
6336 </div>
6337
6338 <div class="doc_text">
6339
6340 <h5>Syntax:</h5>
6341 <p>This is an overloaded intrinsic function. You can use bswap on any integer
6342    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
6343
6344 <pre>
6345   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
6346   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
6347   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
6348 </pre>
6349
6350 <h5>Overview:</h5>
6351 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
6352    values with an even number of bytes (positive multiple of 16 bits).  These
6353    are useful for performing operations on data that is not in the target's
6354    native byte order.</p>
6355
6356 <h5>Semantics:</h5>
6357 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
6358    and low byte of the input i16 swapped.  Similarly,
6359    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
6360    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
6361    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
6362    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
6363    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
6364    more, respectively).</p>
6365
6366 </div>
6367
6368 <!-- _______________________________________________________________________ -->
6369 <div class="doc_subsubsection">
6370   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
6371 </div>
6372
6373 <div class="doc_text">
6374
6375 <h5>Syntax:</h5>
6376 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
6377    width. Not all targets support all bit widths however.</p>
6378
6379 <pre>
6380   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
6381   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
6382   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
6383   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
6384   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
6385 </pre>
6386
6387 <h5>Overview:</h5>
6388 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
6389    in a value.</p>
6390
6391 <h5>Arguments:</h5>
6392 <p>The only argument is the value to be counted.  The argument may be of any
6393    integer type.  The return type must match the argument type.</p>
6394
6395 <h5>Semantics:</h5>
6396 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.</p>
6397
6398 </div>
6399
6400 <!-- _______________________________________________________________________ -->
6401 <div class="doc_subsubsection">
6402   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
6403 </div>
6404
6405 <div class="doc_text">
6406
6407 <h5>Syntax:</h5>
6408 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
6409    integer bit width. Not all targets support all bit widths however.</p>
6410
6411 <pre>
6412   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
6413   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
6414   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
6415   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
6416   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
6417 </pre>
6418
6419 <h5>Overview:</h5>
6420 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
6421    leading zeros in a variable.</p>
6422
6423 <h5>Arguments:</h5>
6424 <p>The only argument is the value to be counted.  The argument may be of any
6425    integer type. The return type must match the argument type.</p>
6426
6427 <h5>Semantics:</h5>
6428 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
6429    zeros in a variable.  If the src == 0 then the result is the size in bits of
6430    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
6431
6432 </div>
6433
6434 <!-- _______________________________________________________________________ -->
6435 <div class="doc_subsubsection">
6436   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
6437 </div>
6438
6439 <div class="doc_text">
6440
6441 <h5>Syntax:</h5>
6442 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
6443    integer bit width. Not all targets support all bit widths however.</p>
6444
6445 <pre>
6446   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
6447   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
6448   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
6449   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
6450   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
6451 </pre>
6452
6453 <h5>Overview:</h5>
6454 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
6455    trailing zeros.</p>
6456
6457 <h5>Arguments:</h5>
6458 <p>The only argument is the value to be counted.  The argument may be of any
6459    integer type.  The return type must match the argument type.</p>
6460
6461 <h5>Semantics:</h5>
6462 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
6463    zeros in a variable.  If the src == 0 then the result is the size in bits of
6464    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
6465
6466 </div>
6467
6468 <!-- ======================================================================= -->
6469 <div class="doc_subsection">
6470   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
6471 </div>
6472
6473 <div class="doc_text">
6474
6475 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
6476
6477 </div>
6478
6479 <!-- _______________________________________________________________________ -->
6480 <div class="doc_subsubsection">
6481   <a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a>
6482 </div>
6483
6484 <div class="doc_text">
6485
6486 <h5>Syntax:</h5>
6487 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
6488    on any integer bit width.</p>
6489
6490 <pre>
6491   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
6492   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6493   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
6494 </pre>
6495
6496 <h5>Overview:</h5>
6497 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6498    a signed addition of the two arguments, and indicate whether an overflow
6499    occurred during the signed summation.</p>
6500
6501 <h5>Arguments:</h5>
6502 <p>The arguments (%a and %b) and the first element of the result structure may
6503    be of integer types of any bit width, but they must have the same bit
6504    width. The second element of the result structure must be of
6505    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6506    undergo signed addition.</p>
6507
6508 <h5>Semantics:</h5>
6509 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6510    a signed addition of the two variables. They return a structure &mdash; the
6511    first element of which is the signed summation, and the second element of
6512    which is a bit specifying if the signed summation resulted in an
6513    overflow.</p>
6514
6515 <h5>Examples:</h5>
6516 <pre>
6517   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6518   %sum = extractvalue {i32, i1} %res, 0
6519   %obit = extractvalue {i32, i1} %res, 1
6520   br i1 %obit, label %overflow, label %normal
6521 </pre>
6522
6523 </div>
6524
6525 <!-- _______________________________________________________________________ -->
6526 <div class="doc_subsubsection">
6527   <a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a>
6528 </div>
6529
6530 <div class="doc_text">
6531
6532 <h5>Syntax:</h5>
6533 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
6534    on any integer bit width.</p>
6535
6536 <pre>
6537   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
6538   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6539   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
6540 </pre>
6541
6542 <h5>Overview:</h5>
6543 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6544    an unsigned addition of the two arguments, and indicate whether a carry
6545    occurred during the unsigned summation.</p>
6546
6547 <h5>Arguments:</h5>
6548 <p>The arguments (%a and %b) and the first element of the result structure may
6549    be of integer types of any bit width, but they must have the same bit
6550    width. The second element of the result structure must be of
6551    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6552    undergo unsigned addition.</p>
6553
6554 <h5>Semantics:</h5>
6555 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6556    an unsigned addition of the two arguments. They return a structure &mdash;
6557    the first element of which is the sum, and the second element of which is a
6558    bit specifying if the unsigned summation resulted in a carry.</p>
6559
6560 <h5>Examples:</h5>
6561 <pre>
6562   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6563   %sum = extractvalue {i32, i1} %res, 0
6564   %obit = extractvalue {i32, i1} %res, 1
6565   br i1 %obit, label %carry, label %normal
6566 </pre>
6567
6568 </div>
6569
6570 <!-- _______________________________________________________________________ -->
6571 <div class="doc_subsubsection">
6572   <a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a>
6573 </div>
6574
6575 <div class="doc_text">
6576
6577 <h5>Syntax:</h5>
6578 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
6579    on any integer bit width.</p>
6580
6581 <pre>
6582   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
6583   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6584   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
6585 </pre>
6586
6587 <h5>Overview:</h5>
6588 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6589    a signed subtraction of the two arguments, and indicate whether an overflow
6590    occurred during the signed subtraction.</p>
6591
6592 <h5>Arguments:</h5>
6593 <p>The arguments (%a and %b) and the first element of the result structure may
6594    be of integer types of any bit width, but they must have the same bit
6595    width. The second element of the result structure must be of
6596    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6597    undergo signed subtraction.</p>
6598
6599 <h5>Semantics:</h5>
6600 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6601    a signed subtraction of the two arguments. They return a structure &mdash;
6602    the first element of which is the subtraction, and the second element of
6603    which is a bit specifying if the signed subtraction resulted in an
6604    overflow.</p>
6605
6606 <h5>Examples:</h5>
6607 <pre>
6608   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6609   %sum = extractvalue {i32, i1} %res, 0
6610   %obit = extractvalue {i32, i1} %res, 1
6611   br i1 %obit, label %overflow, label %normal
6612 </pre>
6613
6614 </div>
6615
6616 <!-- _______________________________________________________________________ -->
6617 <div class="doc_subsubsection">
6618   <a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a>
6619 </div>
6620
6621 <div class="doc_text">
6622
6623 <h5>Syntax:</h5>
6624 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
6625    on any integer bit width.</p>
6626
6627 <pre>
6628   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
6629   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6630   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
6631 </pre>
6632
6633 <h5>Overview:</h5>
6634 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6635    an unsigned subtraction of the two arguments, and indicate whether an
6636    overflow occurred during the unsigned subtraction.</p>
6637
6638 <h5>Arguments:</h5>
6639 <p>The arguments (%a and %b) and the first element of the result structure may
6640    be of integer types of any bit width, but they must have the same bit
6641    width. The second element of the result structure must be of
6642    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6643    undergo unsigned subtraction.</p>
6644
6645 <h5>Semantics:</h5>
6646 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6647    an unsigned subtraction of the two arguments. They return a structure &mdash;
6648    the first element of which is the subtraction, and the second element of
6649    which is a bit specifying if the unsigned subtraction resulted in an
6650    overflow.</p>
6651
6652 <h5>Examples:</h5>
6653 <pre>
6654   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6655   %sum = extractvalue {i32, i1} %res, 0
6656   %obit = extractvalue {i32, i1} %res, 1
6657   br i1 %obit, label %overflow, label %normal
6658 </pre>
6659
6660 </div>
6661
6662 <!-- _______________________________________________________________________ -->
6663 <div class="doc_subsubsection">
6664   <a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a>
6665 </div>
6666
6667 <div class="doc_text">
6668
6669 <h5>Syntax:</h5>
6670 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
6671    on any integer bit width.</p>
6672
6673 <pre>
6674   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
6675   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6676   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
6677 </pre>
6678
6679 <h5>Overview:</h5>
6680
6681 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6682    a signed multiplication of the two arguments, and indicate whether an
6683    overflow occurred during the signed multiplication.</p>
6684
6685 <h5>Arguments:</h5>
6686 <p>The arguments (%a and %b) and the first element of the result structure may
6687    be of integer types of any bit width, but they must have the same bit
6688    width. The second element of the result structure must be of
6689    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6690    undergo signed multiplication.</p>
6691
6692 <h5>Semantics:</h5>
6693 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6694    a signed multiplication of the two arguments. They return a structure &mdash;
6695    the first element of which is the multiplication, and the second element of
6696    which is a bit specifying if the signed multiplication resulted in an
6697    overflow.</p>
6698
6699 <h5>Examples:</h5>
6700 <pre>
6701   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6702   %sum = extractvalue {i32, i1} %res, 0
6703   %obit = extractvalue {i32, i1} %res, 1
6704   br i1 %obit, label %overflow, label %normal
6705 </pre>
6706
6707 </div>
6708
6709 <!-- _______________________________________________________________________ -->
6710 <div class="doc_subsubsection">
6711   <a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a>
6712 </div>
6713
6714 <div class="doc_text">
6715
6716 <h5>Syntax:</h5>
6717 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
6718    on any integer bit width.</p>
6719
6720 <pre>
6721   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
6722   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6723   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
6724 </pre>
6725
6726 <h5>Overview:</h5>
6727 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6728    a unsigned multiplication of the two arguments, and indicate whether an
6729    overflow occurred during the unsigned multiplication.</p>
6730
6731 <h5>Arguments:</h5>
6732 <p>The arguments (%a and %b) and the first element of the result structure may
6733    be of integer types of any bit width, but they must have the same bit
6734    width. The second element of the result structure must be of
6735    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6736    undergo unsigned multiplication.</p>
6737
6738 <h5>Semantics:</h5>
6739 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6740    an unsigned multiplication of the two arguments. They return a structure
6741    &mdash; the first element of which is the multiplication, and the second
6742    element of which is a bit specifying if the unsigned multiplication resulted
6743    in an overflow.</p>
6744
6745 <h5>Examples:</h5>
6746 <pre>
6747   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6748   %sum = extractvalue {i32, i1} %res, 0
6749   %obit = extractvalue {i32, i1} %res, 1
6750   br i1 %obit, label %overflow, label %normal
6751 </pre>
6752
6753 </div>
6754
6755 <!-- ======================================================================= -->
6756 <div class="doc_subsection">
6757   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
6758 </div>
6759
6760 <div class="doc_text">
6761
6762 <p>Half precision floating point is a storage-only format. This means that it is
6763    a dense encoding (in memory) but does not support computation in the
6764    format.</p>
6765
6766 <p>This means that code must first load the half-precision floating point
6767    value as an i16, then convert it to float with <a
6768    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
6769    Computation can then be performed on the float value (including extending to
6770    double etc).  To store the value back to memory, it is first converted to
6771    float if needed, then converted to i16 with
6772    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
6773    storing as an i16 value.</p>
6774 </div>
6775
6776 <!-- _______________________________________________________________________ -->
6777 <div class="doc_subsubsection">
6778   <a name="int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a>
6779 </div>
6780
6781 <div class="doc_text">
6782
6783 <h5>Syntax:</h5>
6784 <pre>
6785   declare i16 @llvm.convert.to.fp16(f32 %a)
6786 </pre>
6787
6788 <h5>Overview:</h5>
6789 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6790    a conversion from single precision floating point format to half precision
6791    floating point format.</p>
6792
6793 <h5>Arguments:</h5>
6794 <p>The intrinsic function contains single argument - the value to be
6795    converted.</p>
6796
6797 <h5>Semantics:</h5>
6798 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6799    a conversion from single precision floating point format to half precision
6800    floating point format. The return value is an <tt>i16</tt> which
6801    contains the converted number.</p>
6802
6803 <h5>Examples:</h5>
6804 <pre>
6805   %res = call i16 @llvm.convert.to.fp16(f32 %a)
6806   store i16 %res, i16* @x, align 2
6807 </pre>
6808
6809 </div>
6810
6811 <!-- _______________________________________________________________________ -->
6812 <div class="doc_subsubsection">
6813  <a name="int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a>
6814 </div>
6815
6816 <div class="doc_text">
6817
6818 <h5>Syntax:</h5>
6819 <pre>
6820   declare f32 @llvm.convert.from.fp16(i16 %a)
6821 </pre>
6822
6823 <h5>Overview:</h5>
6824 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
6825    a conversion from half precision floating point format to single precision
6826    floating point format.</p>
6827
6828 <h5>Arguments:</h5>
6829 <p>The intrinsic function contains single argument - the value to be
6830    converted.</p>
6831
6832 <h5>Semantics:</h5>
6833 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
6834    conversion from half single precision floating point format to single
6835    precision floating point format. The input half-float value is represented by
6836    an <tt>i16</tt> value.</p>
6837
6838 <h5>Examples:</h5>
6839 <pre>
6840   %a = load i16* @x, align 2
6841   %res = call f32 @llvm.convert.from.fp16(i16 %a)
6842 </pre>
6843
6844 </div>
6845
6846 <!-- ======================================================================= -->
6847 <div class="doc_subsection">
6848   <a name="int_debugger">Debugger Intrinsics</a>
6849 </div>
6850
6851 <div class="doc_text">
6852
6853 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
6854    prefix), are described in
6855    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
6856    Level Debugging</a> document.</p>
6857
6858 </div>
6859
6860 <!-- ======================================================================= -->
6861 <div class="doc_subsection">
6862   <a name="int_eh">Exception Handling Intrinsics</a>
6863 </div>
6864
6865 <div class="doc_text">
6866
6867 <p>The LLVM exception handling intrinsics (which all start with
6868    <tt>llvm.eh.</tt> prefix), are described in
6869    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
6870    Handling</a> document.</p>
6871
6872 </div>
6873
6874 <!-- ======================================================================= -->
6875 <div class="doc_subsection">
6876   <a name="int_trampoline">Trampoline Intrinsic</a>
6877 </div>
6878
6879 <div class="doc_text">
6880
6881 <p>This intrinsic makes it possible to excise one parameter, marked with
6882    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
6883    The result is a callable
6884    function pointer lacking the nest parameter - the caller does not need to
6885    provide a value for it.  Instead, the value to use is stored in advance in a
6886    "trampoline", a block of memory usually allocated on the stack, which also
6887    contains code to splice the nest value into the argument list.  This is used
6888    to implement the GCC nested function address extension.</p>
6889
6890 <p>For example, if the function is
6891    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
6892    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
6893    follows:</p>
6894
6895 <pre class="doc_code">
6896   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
6897   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
6898   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
6899   %fp = bitcast i8* %p to i32 (i32, i32)*
6900 </pre>
6901
6902 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
6903    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
6904
6905 </div>
6906
6907 <!-- _______________________________________________________________________ -->
6908 <div class="doc_subsubsection">
6909   <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
6910 </div>
6911
6912 <div class="doc_text">
6913
6914 <h5>Syntax:</h5>
6915 <pre>
6916   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
6917 </pre>
6918
6919 <h5>Overview:</h5>
6920 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
6921    function pointer suitable for executing it.</p>
6922
6923 <h5>Arguments:</h5>
6924 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
6925    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
6926    sufficiently aligned block of memory; this memory is written to by the
6927    intrinsic.  Note that the size and the alignment are target-specific - LLVM
6928    currently provides no portable way of determining them, so a front-end that
6929    generates this intrinsic needs to have some target-specific knowledge.
6930    The <tt>func</tt> argument must hold a function bitcast to
6931    an <tt>i8*</tt>.</p>
6932
6933 <h5>Semantics:</h5>
6934 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
6935    dependent code, turning it into a function.  A pointer to this function is
6936    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
6937    function pointer type</a> before being called.  The new function's signature
6938    is the same as that of <tt>func</tt> with any arguments marked with
6939    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
6940    is allowed, and it must be of pointer type.  Calling the new function is
6941    equivalent to calling <tt>func</tt> with the same argument list, but
6942    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
6943    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
6944    by <tt>tramp</tt> is modified, then the effect of any later call to the
6945    returned function pointer is undefined.</p>
6946
6947 </div>
6948
6949 <!-- ======================================================================= -->
6950 <div class="doc_subsection">
6951   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
6952 </div>
6953
6954 <div class="doc_text">
6955
6956 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
6957    hardware constructs for atomic operations and memory synchronization.  This
6958    provides an interface to the hardware, not an interface to the programmer. It
6959    is aimed at a low enough level to allow any programming models or APIs
6960    (Application Programming Interfaces) which need atomic behaviors to map
6961    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
6962    hardware provides a "universal IR" for source languages, it also provides a
6963    starting point for developing a "universal" atomic operation and
6964    synchronization IR.</p>
6965
6966 <p>These do <em>not</em> form an API such as high-level threading libraries,
6967    software transaction memory systems, atomic primitives, and intrinsic
6968    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
6969    application libraries.  The hardware interface provided by LLVM should allow
6970    a clean implementation of all of these APIs and parallel programming models.
6971    No one model or paradigm should be selected above others unless the hardware
6972    itself ubiquitously does so.</p>
6973
6974 </div>
6975
6976 <!-- _______________________________________________________________________ -->
6977 <div class="doc_subsubsection">
6978   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
6979 </div>
6980 <div class="doc_text">
6981 <h5>Syntax:</h5>
6982 <pre>
6983   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;)
6984 </pre>
6985
6986 <h5>Overview:</h5>
6987 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
6988    specific pairs of memory access types.</p>
6989
6990 <h5>Arguments:</h5>
6991 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
6992    The first four arguments enables a specific barrier as listed below.  The
6993    fifth argument specifies that the barrier applies to io or device or uncached
6994    memory.</p>
6995
6996 <ul>
6997   <li><tt>ll</tt>: load-load barrier</li>
6998   <li><tt>ls</tt>: load-store barrier</li>
6999   <li><tt>sl</tt>: store-load barrier</li>
7000   <li><tt>ss</tt>: store-store barrier</li>
7001   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7002 </ul>
7003
7004 <h5>Semantics:</h5>
7005 <p>This intrinsic causes the system to enforce some ordering constraints upon
7006    the loads and stores of the program. This barrier does not
7007    indicate <em>when</em> any events will occur, it only enforces
7008    an <em>order</em> in which they occur. For any of the specified pairs of load
7009    and store operations (f.ex.  load-load, or store-load), all of the first
7010    operations preceding the barrier will complete before any of the second
7011    operations succeeding the barrier begin. Specifically the semantics for each
7012    pairing is as follows:</p>
7013
7014 <ul>
7015   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7016       after the barrier begins.</li>
7017   <li><tt>ls</tt>: All loads before the barrier must complete before any
7018       store after the barrier begins.</li>
7019   <li><tt>ss</tt>: All stores before the barrier must complete before any
7020       store after the barrier begins.</li>
7021   <li><tt>sl</tt>: All stores before the barrier must complete before any
7022       load after the barrier begins.</li>
7023 </ul>
7024
7025 <p>These semantics are applied with a logical "and" behavior when more than one
7026    is enabled in a single memory barrier intrinsic.</p>
7027
7028 <p>Backends may implement stronger barriers than those requested when they do
7029    not support as fine grained a barrier as requested.  Some architectures do
7030    not need all types of barriers and on such architectures, these become
7031    noops.</p>
7032
7033 <h5>Example:</h5>
7034 <pre>
7035 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7036 %ptr      = bitcast i8* %mallocP to i32*
7037             store i32 4, %ptr
7038
7039 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7040             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false)
7041                                 <i>; guarantee the above finishes</i>
7042             store i32 8, %ptr   <i>; before this begins</i>
7043 </pre>
7044
7045 </div>
7046
7047 <!-- _______________________________________________________________________ -->
7048 <div class="doc_subsubsection">
7049   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7050 </div>
7051
7052 <div class="doc_text">
7053
7054 <h5>Syntax:</h5>
7055 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7056    any integer bit width and for different address spaces. Not all targets
7057    support all bit widths however.</p>
7058
7059 <pre>
7060   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7061   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7062   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7063   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7064 </pre>
7065
7066 <h5>Overview:</h5>
7067 <p>This loads a value in memory and compares it to a given value. If they are
7068    equal, it stores a new value into the memory.</p>
7069
7070 <h5>Arguments:</h5>
7071 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7072    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7073    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7074    this integer type. While any bit width integer may be used, targets may only
7075    lower representations they support in hardware.</p>
7076
7077 <h5>Semantics:</h5>
7078 <p>This entire intrinsic must be executed atomically. It first loads the value
7079    in memory pointed to by <tt>ptr</tt> and compares it with the
7080    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7081    memory. The loaded value is yielded in all cases. This provides the
7082    equivalent of an atomic compare-and-swap operation within the SSA
7083    framework.</p>
7084
7085 <h5>Examples:</h5>
7086 <pre>
7087 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7088 %ptr      = bitcast i8* %mallocP to i32*
7089             store i32 4, %ptr
7090
7091 %val1     = add i32 4, 4
7092 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7093                                           <i>; yields {i32}:result1 = 4</i>
7094 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7095 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7096
7097 %val2     = add i32 1, 1
7098 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7099                                           <i>; yields {i32}:result2 = 8</i>
7100 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7101
7102 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7103 </pre>
7104
7105 </div>
7106
7107 <!-- _______________________________________________________________________ -->
7108 <div class="doc_subsubsection">
7109   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7110 </div>
7111 <div class="doc_text">
7112 <h5>Syntax:</h5>
7113
7114 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7115    integer bit width. Not all targets support all bit widths however.</p>
7116
7117 <pre>
7118   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7119   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7120   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7121   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7122 </pre>
7123
7124 <h5>Overview:</h5>
7125 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7126    the value from memory. It then stores the value in <tt>val</tt> in the memory
7127    at <tt>ptr</tt>.</p>
7128
7129 <h5>Arguments:</h5>
7130 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7131   the <tt>val</tt> argument and the result must be integers of the same bit
7132   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7133   integer type. The targets may only lower integer representations they
7134   support.</p>
7135
7136 <h5>Semantics:</h5>
7137 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7138    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7139    equivalent of an atomic swap operation within the SSA framework.</p>
7140
7141 <h5>Examples:</h5>
7142 <pre>
7143 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7144 %ptr      = bitcast i8* %mallocP to i32*
7145             store i32 4, %ptr
7146
7147 %val1     = add i32 4, 4
7148 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7149                                         <i>; yields {i32}:result1 = 4</i>
7150 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7151 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7152
7153 %val2     = add i32 1, 1
7154 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7155                                         <i>; yields {i32}:result2 = 8</i>
7156
7157 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7158 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7159 </pre>
7160
7161 </div>
7162
7163 <!-- _______________________________________________________________________ -->
7164 <div class="doc_subsubsection">
7165   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7166
7167 </div>
7168
7169 <div class="doc_text">
7170
7171 <h5>Syntax:</h5>
7172 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7173    any integer bit width. Not all targets support all bit widths however.</p>
7174
7175 <pre>
7176   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7177   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7178   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7179   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7180 </pre>
7181
7182 <h5>Overview:</h5>
7183 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7184    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7185
7186 <h5>Arguments:</h5>
7187 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7188    and the second an integer value. The result is also an integer value. These
7189    integer types can have any bit width, but they must all have the same bit
7190    width. The targets may only lower integer representations they support.</p>
7191
7192 <h5>Semantics:</h5>
7193 <p>This intrinsic does a series of operations atomically. It first loads the
7194    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7195    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7196
7197 <h5>Examples:</h5>
7198 <pre>
7199 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7200 %ptr      = bitcast i8* %mallocP to i32*
7201             store i32 4, %ptr
7202 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7203                                 <i>; yields {i32}:result1 = 4</i>
7204 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7205                                 <i>; yields {i32}:result2 = 8</i>
7206 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7207                                 <i>; yields {i32}:result3 = 10</i>
7208 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7209 </pre>
7210
7211 </div>
7212
7213 <!-- _______________________________________________________________________ -->
7214 <div class="doc_subsubsection">
7215   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
7216
7217 </div>
7218
7219 <div class="doc_text">
7220
7221 <h5>Syntax:</h5>
7222 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
7223    any integer bit width and for different address spaces. Not all targets
7224    support all bit widths however.</p>
7225
7226 <pre>
7227   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7228   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7229   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7230   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7231 </pre>
7232
7233 <h5>Overview:</h5>
7234 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
7235    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7236
7237 <h5>Arguments:</h5>
7238 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7239    and the second an integer value. The result is also an integer value. These
7240    integer types can have any bit width, but they must all have the same bit
7241    width. The targets may only lower integer representations they support.</p>
7242
7243 <h5>Semantics:</h5>
7244 <p>This intrinsic does a series of operations atomically. It first loads the
7245    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
7246    result to <tt>ptr</tt>. It yields the original value stored
7247    at <tt>ptr</tt>.</p>
7248
7249 <h5>Examples:</h5>
7250 <pre>
7251 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7252 %ptr      = bitcast i8* %mallocP to i32*
7253             store i32 8, %ptr
7254 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
7255                                 <i>; yields {i32}:result1 = 8</i>
7256 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
7257                                 <i>; yields {i32}:result2 = 4</i>
7258 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
7259                                 <i>; yields {i32}:result3 = 2</i>
7260 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
7261 </pre>
7262
7263 </div>
7264
7265 <!-- _______________________________________________________________________ -->
7266 <div class="doc_subsubsection">
7267   <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
7268   <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
7269   <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
7270   <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
7271 </div>
7272
7273 <div class="doc_text">
7274
7275 <h5>Syntax:</h5>
7276 <p>These are overloaded intrinsics. You can
7277   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
7278   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
7279   bit width and for different address spaces. Not all targets support all bit
7280   widths however.</p>
7281
7282 <pre>
7283   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7284   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7285   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7286   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7287 </pre>
7288
7289 <pre>
7290   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7291   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7292   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7293   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7294 </pre>
7295
7296 <pre>
7297   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7298   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7299   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7300   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7301 </pre>
7302
7303 <pre>
7304   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7305   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7306   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7307   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7308 </pre>
7309
7310 <h5>Overview:</h5>
7311 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
7312    the value stored in memory at <tt>ptr</tt>. It yields the original value
7313    at <tt>ptr</tt>.</p>
7314
7315 <h5>Arguments:</h5>
7316 <p>These intrinsics take two arguments, the first a pointer to an integer value
7317    and the second an integer value. The result is also an integer value. These
7318    integer types can have any bit width, but they must all have the same bit
7319    width. The targets may only lower integer representations they support.</p>
7320
7321 <h5>Semantics:</h5>
7322 <p>These intrinsics does a series of operations atomically. They first load the
7323    value stored at <tt>ptr</tt>. They then do the bitwise
7324    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
7325    original value stored at <tt>ptr</tt>.</p>
7326
7327 <h5>Examples:</h5>
7328 <pre>
7329 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7330 %ptr      = bitcast i8* %mallocP to i32*
7331             store i32 0x0F0F, %ptr
7332 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
7333                                 <i>; yields {i32}:result0 = 0x0F0F</i>
7334 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
7335                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
7336 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
7337                                 <i>; yields {i32}:result2 = 0xF0</i>
7338 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
7339                                 <i>; yields {i32}:result3 = FF</i>
7340 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
7341 </pre>
7342
7343 </div>
7344
7345 <!-- _______________________________________________________________________ -->
7346 <div class="doc_subsubsection">
7347   <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
7348   <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
7349   <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
7350   <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
7351 </div>
7352
7353 <div class="doc_text">
7354
7355 <h5>Syntax:</h5>
7356 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
7357    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
7358    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
7359    address spaces. Not all targets support all bit widths however.</p>
7360
7361 <pre>
7362   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7363   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7364   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7365   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7366 </pre>
7367
7368 <pre>
7369   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7370   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7371   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7372   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7373 </pre>
7374
7375 <pre>
7376   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7377   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7378   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7379   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7380 </pre>
7381
7382 <pre>
7383   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7384   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7385   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7386   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7387 </pre>
7388
7389 <h5>Overview:</h5>
7390 <p>These intrinsics takes the signed or unsigned minimum or maximum of
7391    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
7392    original value at <tt>ptr</tt>.</p>
7393
7394 <h5>Arguments:</h5>
7395 <p>These intrinsics take two arguments, the first a pointer to an integer value
7396    and the second an integer value. The result is also an integer value. These
7397    integer types can have any bit width, but they must all have the same bit
7398    width. The targets may only lower integer representations they support.</p>
7399
7400 <h5>Semantics:</h5>
7401 <p>These intrinsics does a series of operations atomically. They first load the
7402    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
7403    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
7404    yield the original value stored at <tt>ptr</tt>.</p>
7405
7406 <h5>Examples:</h5>
7407 <pre>
7408 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7409 %ptr      = bitcast i8* %mallocP to i32*
7410             store i32 7, %ptr
7411 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
7412                                 <i>; yields {i32}:result0 = 7</i>
7413 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
7414                                 <i>; yields {i32}:result1 = -2</i>
7415 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
7416                                 <i>; yields {i32}:result2 = 8</i>
7417 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
7418                                 <i>; yields {i32}:result3 = 8</i>
7419 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
7420 </pre>
7421
7422 </div>
7423
7424
7425 <!-- ======================================================================= -->
7426 <div class="doc_subsection">
7427   <a name="int_memorymarkers">Memory Use Markers</a>
7428 </div>
7429
7430 <div class="doc_text">
7431
7432 <p>This class of intrinsics exists to information about the lifetime of memory
7433    objects and ranges where variables are immutable.</p>
7434
7435 </div>
7436
7437 <!-- _______________________________________________________________________ -->
7438 <div class="doc_subsubsection">
7439   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7440 </div>
7441
7442 <div class="doc_text">
7443
7444 <h5>Syntax:</h5>
7445 <pre>
7446   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7447 </pre>
7448
7449 <h5>Overview:</h5>
7450 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7451    object's lifetime.</p>
7452
7453 <h5>Arguments:</h5>
7454 <p>The first argument is a constant integer representing the size of the
7455    object, or -1 if it is variable sized.  The second argument is a pointer to
7456    the object.</p>
7457
7458 <h5>Semantics:</h5>
7459 <p>This intrinsic indicates that before this point in the code, the value of the
7460    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7461    never be used and has an undefined value.  A load from the pointer that
7462    precedes this intrinsic can be replaced with
7463    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7464
7465 </div>
7466
7467 <!-- _______________________________________________________________________ -->
7468 <div class="doc_subsubsection">
7469   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7470 </div>
7471
7472 <div class="doc_text">
7473
7474 <h5>Syntax:</h5>
7475 <pre>
7476   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7477 </pre>
7478
7479 <h5>Overview:</h5>
7480 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7481    object's lifetime.</p>
7482
7483 <h5>Arguments:</h5>
7484 <p>The first argument is a constant integer representing the size of the
7485    object, or -1 if it is variable sized.  The second argument is a pointer to
7486    the object.</p>
7487
7488 <h5>Semantics:</h5>
7489 <p>This intrinsic indicates that after this point in the code, the value of the
7490    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7491    never be used and has an undefined value.  Any stores into the memory object
7492    following this intrinsic may be removed as dead.
7493
7494 </div>
7495
7496 <!-- _______________________________________________________________________ -->
7497 <div class="doc_subsubsection">
7498   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7499 </div>
7500
7501 <div class="doc_text">
7502
7503 <h5>Syntax:</h5>
7504 <pre>
7505   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;) readonly
7506 </pre>
7507
7508 <h5>Overview:</h5>
7509 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7510    a memory object will not change.</p>
7511
7512 <h5>Arguments:</h5>
7513 <p>The first argument is a constant integer representing the size of the
7514    object, or -1 if it is variable sized.  The second argument is a pointer to
7515    the object.</p>
7516
7517 <h5>Semantics:</h5>
7518 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
7519    the return value, the referenced memory location is constant and
7520    unchanging.</p>
7521
7522 </div>
7523
7524 <!-- _______________________________________________________________________ -->
7525 <div class="doc_subsubsection">
7526   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
7527 </div>
7528
7529 <div class="doc_text">
7530
7531 <h5>Syntax:</h5>
7532 <pre>
7533   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7534 </pre>
7535
7536 <h5>Overview:</h5>
7537 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
7538    a memory object are mutable.</p>
7539
7540 <h5>Arguments:</h5>
7541 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
7542    The second argument is a constant integer representing the size of the
7543    object, or -1 if it is variable sized and the third argument is a pointer
7544    to the object.</p>
7545
7546 <h5>Semantics:</h5>
7547 <p>This intrinsic indicates that the memory is mutable again.</p>
7548
7549 </div>
7550
7551 <!-- ======================================================================= -->
7552 <div class="doc_subsection">
7553   <a name="int_general">General Intrinsics</a>
7554 </div>
7555
7556 <div class="doc_text">
7557
7558 <p>This class of intrinsics is designed to be generic and has no specific
7559    purpose.</p>
7560
7561 </div>
7562
7563 <!-- _______________________________________________________________________ -->
7564 <div class="doc_subsubsection">
7565   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
7566 </div>
7567
7568 <div class="doc_text">
7569
7570 <h5>Syntax:</h5>
7571 <pre>
7572   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7573 </pre>
7574
7575 <h5>Overview:</h5>
7576 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
7577
7578 <h5>Arguments:</h5>
7579 <p>The first argument is a pointer to a value, the second is a pointer to a
7580    global string, the third is a pointer to a global string which is the source
7581    file name, and the last argument is the line number.</p>
7582
7583 <h5>Semantics:</h5>
7584 <p>This intrinsic allows annotation of local variables with arbitrary strings.
7585    This can be useful for special purpose optimizations that want to look for
7586    these annotations.  These have no other defined use, they are ignored by code
7587    generation and optimization.</p>
7588
7589 </div>
7590
7591 <!-- _______________________________________________________________________ -->
7592 <div class="doc_subsubsection">
7593   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
7594 </div>
7595
7596 <div class="doc_text">
7597
7598 <h5>Syntax:</h5>
7599 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
7600    any integer bit width.</p>
7601
7602 <pre>
7603   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7604   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7605   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7606   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7607   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7608 </pre>
7609
7610 <h5>Overview:</h5>
7611 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
7612
7613 <h5>Arguments:</h5>
7614 <p>The first argument is an integer value (result of some expression), the
7615    second is a pointer to a global string, the third is a pointer to a global
7616    string which is the source file name, and the last argument is the line
7617    number.  It returns the value of the first argument.</p>
7618
7619 <h5>Semantics:</h5>
7620 <p>This intrinsic allows annotations to be put on arbitrary expressions with
7621    arbitrary strings.  This can be useful for special purpose optimizations that
7622    want to look for these annotations.  These have no other defined use, they
7623    are ignored by code generation and optimization.</p>
7624
7625 </div>
7626
7627 <!-- _______________________________________________________________________ -->
7628 <div class="doc_subsubsection">
7629   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
7630 </div>
7631
7632 <div class="doc_text">
7633
7634 <h5>Syntax:</h5>
7635 <pre>
7636   declare void @llvm.trap()
7637 </pre>
7638
7639 <h5>Overview:</h5>
7640 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
7641
7642 <h5>Arguments:</h5>
7643 <p>None.</p>
7644
7645 <h5>Semantics:</h5>
7646 <p>This intrinsics is lowered to the target dependent trap instruction. If the
7647    target does not have a trap instruction, this intrinsic will be lowered to
7648    the call of the <tt>abort()</tt> function.</p>
7649
7650 </div>
7651
7652 <!-- _______________________________________________________________________ -->
7653 <div class="doc_subsubsection">
7654   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
7655 </div>
7656
7657 <div class="doc_text">
7658
7659 <h5>Syntax:</h5>
7660 <pre>
7661   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
7662 </pre>
7663
7664 <h5>Overview:</h5>
7665 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
7666    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
7667    ensure that it is placed on the stack before local variables.</p>
7668
7669 <h5>Arguments:</h5>
7670 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
7671    arguments. The first argument is the value loaded from the stack
7672    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
7673    that has enough space to hold the value of the guard.</p>
7674
7675 <h5>Semantics:</h5>
7676 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
7677    the <tt>AllocaInst</tt> stack slot to be before local variables on the
7678    stack. This is to ensure that if a local variable on the stack is
7679    overwritten, it will destroy the value of the guard. When the function exits,
7680    the guard on the stack is checked against the original guard. If they are
7681    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
7682    function.</p>
7683
7684 </div>
7685
7686 <!-- _______________________________________________________________________ -->
7687 <div class="doc_subsubsection">
7688   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
7689 </div>
7690
7691 <div class="doc_text">
7692
7693 <h5>Syntax:</h5>
7694 <pre>
7695   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
7696   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
7697 </pre>
7698
7699 <h5>Overview:</h5>
7700 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
7701    the optimizers to determine at compile time whether a) an operation (like
7702    memcpy) will overflow a buffer that corresponds to an object, or b) that a
7703    runtime check for overflow isn't necessary. An object in this context means
7704    an allocation of a specific class, structure, array, or other object.</p>
7705
7706 <h5>Arguments:</h5>
7707 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
7708    argument is a pointer to or into the <tt>object</tt>. The second argument
7709    is a boolean 0 or 1. This argument determines whether you want the
7710    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
7711    1, variables are not allowed.</p>
7712
7713 <h5>Semantics:</h5>
7714 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
7715    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
7716    depending on the <tt>type</tt> argument, if the size cannot be determined at
7717    compile time.</p>
7718
7719 </div>
7720
7721 <!-- *********************************************************************** -->
7722 <hr>
7723 <address>
7724   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
7725   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
7726   <a href="http://validator.w3.org/check/referer"><img
7727   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
7728
7729   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
7730   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
7731   Last modified: $Date$
7732 </address>
7733
7734 </body>
7735 </html>