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