docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Assembly Language Reference Manual</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   7   <meta name="author" content="Chris Lattner">
   8   <meta name="description"
   9   content="LLVM Assembly Language Reference Manual.">
  10   <link rel="stylesheet" href="llvm.css" type="text/css">
  11 </head>
  12
  13 <body>
  14
  15 <div class="doc_title"> LLVM Language Reference Manual </div>
  16 <ol>
  17   <li><a href="#abstract">Abstract</a></li>
  18   <li><a href="#introduction">Introduction</a></li>
  19   <li><a href="#identifiers">Identifiers</a></li>
  20   <li><a href="#highlevel">High Level Structure</a>
  21     <ol>
  22       <li><a href="#modulestructure">Module Structure</a></li>
  23       <li><a href="#linkage">Linkage Types</a>
  24         <ol>
  25           <li><a href="#linkage_private">'<tt>private</tt>' Linkage</a></li>
  26           <li><a href="#linkage_linker_private">'<tt>linker_private</tt>' Linkage</a></li>
  27           <li><a href="#linkage_linker_private_weak">'<tt>linker_private_weak</tt>' Linkage</a></li>
  28           <li><a href="#linkage_linker_private_weak_def_auto">'<tt>linker_private_weak_def_auto</tt>' Linkage</a></li>
  29           <li><a href="#linkage_internal">'<tt>internal</tt>' Linkage</a></li>
  30           <li><a href="#linkage_available_externally">'<tt>available_externally</tt>' Linkage</a></li>
  31           <li><a href="#linkage_linkonce">'<tt>linkonce</tt>' Linkage</a></li>
  32           <li><a href="#linkage_common">'<tt>common</tt>' Linkage</a></li>
  33           <li><a href="#linkage_weak">'<tt>weak</tt>' Linkage</a></li>
  34           <li><a href="#linkage_appending">'<tt>appending</tt>' Linkage</a></li>
  35           <li><a href="#linkage_externweak">'<tt>extern_weak</tt>' Linkage</a></li>
  36           <li><a href="#linkage_linkonce_odr">'<tt>linkonce_odr</tt>' Linkage</a></li>
  37           <li><a href="#linkage_weak">'<tt>weak_odr</tt>' Linkage</a></li>
  38           <li><a href="#linkage_external">'<tt>externally visible</tt>' Linkage</a></li>
  39           <li><a href="#linkage_dllimport">'<tt>dllimport</tt>' Linkage</a></li>
  40           <li><a href="#linkage_dllexport">'<tt>dllexport</tt>' Linkage</a></li>
  41         </ol>
  42       </li>
  43       <li><a href="#callingconv">Calling Conventions</a></li>
  44       <li><a href="#namedtypes">Named Types</a></li>
  45       <li><a href="#globalvars">Global Variables</a></li>
  46       <li><a href="#functionstructure">Functions</a></li>
  47       <li><a href="#aliasstructure">Aliases</a></li>
  48       <li><a href="#namedmetadatastructure">Named Metadata</a></li>
  49       <li><a href="#paramattrs">Parameter Attributes</a></li>
  50       <li><a href="#fnattrs">Function Attributes</a></li>
  51       <li><a href="#gc">Garbage Collector Names</a></li>
  52       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  53       <li><a href="#datalayout">Data Layout</a></li>
  54       <li><a href="#pointeraliasing">Pointer Aliasing Rules</a></li>
  55       <li><a href="#volatile">Volatile Memory Accesses</a></li>
  56     </ol>
  57   </li>
  58   <li><a href="#typesystem">Type System</a>
  59     <ol>
  60       <li><a href="#t_classifications">Type Classifications</a></li>
  61       <li><a href="#t_primitive">Primitive Types</a>
  62         <ol>
  63           <li><a href="#t_integer">Integer Type</a></li>
  64           <li><a href="#t_floating">Floating Point Types</a></li>
  65           <li><a href="#t_x86mmx">X86mmx Type</a></li>
  66           <li><a href="#t_void">Void Type</a></li>
  67           <li><a href="#t_label">Label Type</a></li>
  68           <li><a href="#t_metadata">Metadata Type</a></li>
  69         </ol>
  70       </li>
  71       <li><a href="#t_derived">Derived Types</a>
  72         <ol>
  73           <li><a href="#t_aggregate">Aggregate Types</a>
  74             <ol>
  75               <li><a href="#t_array">Array Type</a></li>
  76               <li><a href="#t_struct">Structure Type</a></li>
  77               <li><a href="#t_pstruct">Packed Structure Type</a></li>
  78               <li><a href="#t_vector">Vector Type</a></li>
  79             </ol>
  80           </li>
  81           <li><a href="#t_function">Function Type</a></li>
  82           <li><a href="#t_pointer">Pointer Type</a></li>
  83           <li><a href="#t_opaque">Opaque Type</a></li>
  84         </ol>
  85       </li>
  86       <li><a href="#t_uprefs">Type Up-references</a></li>
  87     </ol>
  88   </li>
  89   <li><a href="#constants">Constants</a>
  90     <ol>
  91       <li><a href="#simpleconstants">Simple Constants</a></li>
  92       <li><a href="#complexconstants">Complex Constants</a></li>
  93       <li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
  94       <li><a href="#undefvalues">Undefined Values</a></li>
  95       <li><a href="#trapvalues">Trap Values</a></li>
  96       <li><a href="#blockaddress">Addresses of Basic Blocks</a></li>
  97       <li><a href="#constantexprs">Constant Expressions</a></li>
  98     </ol>
  99   </li>
 100   <li><a href="#othervalues">Other Values</a>
 101     <ol>
 102       <li><a href="#inlineasm">Inline Assembler Expressions</a></li>
 103       <li><a href="#metadata">Metadata Nodes and Metadata Strings</a></li>
 104     </ol>
 105   </li>
 106   <li><a href="#intrinsic_globals">Intrinsic Global Variables</a>
 107     <ol>
 108       <li><a href="#intg_used">The '<tt>llvm.used</tt>' Global Variable</a></li>
 109       <li><a href="#intg_compiler_used">The '<tt>llvm.compiler.used</tt>'
 110           Global Variable</a></li>
 111       <li><a href="#intg_global_ctors">The '<tt>llvm.global_ctors</tt>'
 112          Global Variable</a></li>
 113       <li><a href="#intg_global_dtors">The '<tt>llvm.global_dtors</tt>'
 114          Global Variable</a></li>
 115     </ol>
 116   </li>
 117   <li><a href="#instref">Instruction Reference</a>
 118     <ol>
 119       <li><a href="#terminators">Terminator Instructions</a>
 120         <ol>
 121           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
 122           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
 123           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
 124           <li><a href="#i_indirectbr">'<tt>indirectbr</tt>' Instruction</a></li>
 125           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
 126           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
 127           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
 128         </ol>
 129       </li>
 130       <li><a href="#binaryops">Binary Operations</a>
 131         <ol>
 132           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
 133           <li><a href="#i_fadd">'<tt>fadd</tt>' Instruction</a></li>
 134           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
 135           <li><a href="#i_fsub">'<tt>fsub</tt>' Instruction</a></li>
 136           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
 137           <li><a href="#i_fmul">'<tt>fmul</tt>' Instruction</a></li>
 138           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
 139           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
 140           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
 141           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
 142           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
 143           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
 144         </ol>
 145       </li>
 146       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 147         <ol>
 148           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 149           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 150           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 151           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 152           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 153           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 154         </ol>
 155       </li>
 156       <li><a href="#vectorops">Vector Operations</a>
 157         <ol>
 158           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 159           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 160           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 161         </ol>
 162       </li>
 163       <li><a href="#aggregateops">Aggregate Operations</a>
 164         <ol>
 165           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 166           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 167         </ol>
 168       </li>
 169       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 170         <ol>
 171           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
 172          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 173          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 174          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 175         </ol>
 176       </li>
 177       <li><a href="#convertops">Conversion Operations</a>
 178         <ol>
 179           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 180           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 181           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 182           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 183           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 184           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 185           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 186           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 187           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 188           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 189           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 190           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 191         </ol>
 192       </li>
 193       <li><a href="#otherops">Other Operations</a>
 194         <ol>
 195           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 196           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 197           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 198           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 199           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 200           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 201         </ol>
 202       </li>
 203     </ol>
 204   </li>
 205   <li><a href="#intrinsics">Intrinsic Functions</a>
 206     <ol>
 207       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 208         <ol>
 209           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 210           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 211           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 212         </ol>
 213       </li>
 214       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 215         <ol>
 216           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 217           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 218           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 219         </ol>
 220       </li>
 221       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 222         <ol>
 223           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 224           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 225           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 226           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 227           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 228           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 229           <li><a href="#int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 230         </ol>
 231       </li>
 232       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 233         <ol>
 234           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 235           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 236           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 237           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 238           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 239           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 240           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 241           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 242         </ol>
 243       </li>
 244       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 245         <ol>
 246           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 247           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 248           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 249           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 250         </ol>
 251       </li>
 252       <li><a href="#int_overflow">Arithmetic with Overflow Intrinsics</a>
 253         <ol>
 254           <li><a href="#int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt> Intrinsics</a></li>
 255           <li><a href="#int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt> Intrinsics</a></li>
 256           <li><a href="#int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt> Intrinsics</a></li>
 257           <li><a href="#int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt> Intrinsics</a></li>
 258           <li><a href="#int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt> Intrinsics</a></li>
 259           <li><a href="#int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt> Intrinsics</a></li>
 260         </ol>
 261       </li>
 262       <li><a href="#int_fp16">Half Precision Floating Point Intrinsics</a>
 263         <ol>
 264           <li><a href="#int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a></li>
 265           <li><a href="#int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a></li>
 266         </ol>
 267       </li>
 268       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 269       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 270       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 271         <ol>
 272           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 273         </ol>
 274       </li>
 275       <li><a href="#int_atomics">Atomic intrinsics</a>
 276         <ol>
 277           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 278           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 279           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 280           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 281           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 282           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 283           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 284           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 285           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 286           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 287           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 288           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 289           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 290         </ol>
 291       </li>
 292       <li><a href="#int_memorymarkers">Memory Use Markers</a>
 293         <ol>
 294           <li><a href="#int_lifetime_start"><tt>llvm.lifetime.start</tt></a></li>
 295           <li><a href="#int_lifetime_end"><tt>llvm.lifetime.end</tt></a></li>
 296           <li><a href="#int_invariant_start"><tt>llvm.invariant.start</tt></a></li>
 297           <li><a href="#int_invariant_end"><tt>llvm.invariant.end</tt></a></li>
 298         </ol>
 299       </li>
 300       <li><a href="#int_general">General intrinsics</a>
 301         <ol>
 302           <li><a href="#int_var_annotation">
 303             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 304           <li><a href="#int_annotation">
 305             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 306           <li><a href="#int_trap">
 307             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 308           <li><a href="#int_stackprotector">
 309             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 310           <li><a href="#int_objectsize">
 311             '<tt>llvm.objectsize</tt>' Intrinsic</a></li>
 312         </ol>
 313       </li>
 314     </ol>
 315   </li>
 316 </ol>
 317
 318 <div class="doc_author">
 319   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 320             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 321 </div>
 322
 323 <!-- *********************************************************************** -->
 324 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 325 <!-- *********************************************************************** -->
 326
 327 <div class="doc_text">
 328
 329 <p>This document is a reference manual for the LLVM assembly language. LLVM is
 330    a Static Single Assignment (SSA) based representation that provides type
 331    safety, low-level operations, flexibility, and the capability of representing
 332    'all' high-level languages cleanly.  It is the common code representation
 333    used throughout all phases of the LLVM compilation strategy.</p>
 334
 335 </div>
 336
 337 <!-- *********************************************************************** -->
 338 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 339 <!-- *********************************************************************** -->
 340
 341 <div class="doc_text">
 342
 343 <p>The LLVM code representation is designed to be used in three different forms:
 344    as an in-memory compiler IR, as an on-disk bitcode representation (suitable
 345    for fast loading by a Just-In-Time compiler), and as a human readable
 346    assembly language representation.  This allows LLVM to provide a powerful
 347    intermediate representation for efficient compiler transformations and
 348    analysis, while providing a natural means to debug and visualize the
 349    transformations.  The three different forms of LLVM are all equivalent.  This
 350    document describes the human readable representation and notation.</p>
 351
 352 <p>The LLVM representation aims to be light-weight and low-level while being
 353    expressive, typed, and extensible at the same time.  It aims to be a
 354    "universal IR" of sorts, by being at a low enough level that high-level ideas
 355    may be cleanly mapped to it (similar to how microprocessors are "universal
 356    IR's", allowing many source languages to be mapped to them).  By providing
 357    type information, LLVM can be used as the target of optimizations: for
 358    example, through pointer analysis, it can be proven that a C automatic
 359    variable is never accessed outside of the current function, allowing it to
 360    be promoted to a simple SSA value instead of a memory location.</p>
 361
 362 </div>
 363
 364 <!-- _______________________________________________________________________ -->
 365 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 366
 367 <div class="doc_text">
 368
 369 <p>It is important to note that this document describes 'well formed' LLVM
 370    assembly language.  There is a difference between what the parser accepts and
 371    what is considered 'well formed'.  For example, the following instruction is
 372    syntactically okay, but not well formed:</p>
 373
 374 <pre class="doc_code">
 375 %x = <a href="#i_add">add</a> i32 1, %x
 376 </pre>
 377
 378 <p>because the definition of <tt>%x</tt> does not dominate all of its uses. The
 379    LLVM infrastructure provides a verification pass that may be used to verify
 380    that an LLVM module is well formed.  This pass is automatically run by the
 381    parser after parsing input assembly and by the optimizer before it outputs
 382    bitcode.  The violations pointed out by the verifier pass indicate bugs in
 383    transformation passes or input to the parser.</p>
 384
 385 </div>
 386
 387 <!-- Describe the typesetting conventions here. -->
 388
 389 <!-- *********************************************************************** -->
 390 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 391 <!-- *********************************************************************** -->
 392
 393 <div class="doc_text">
 394
 395 <p>LLVM identifiers come in two basic types: global and local. Global
 396    identifiers (functions, global variables) begin with the <tt>'@'</tt>
 397    character. Local identifiers (register names, types) begin with
 398    the <tt>'%'</tt> character. Additionally, there are three different formats
 399    for identifiers, for different purposes:</p>
 400
 401 <ol>
 402   <li>Named values are represented as a string of characters with their prefix.
 403       For example, <tt>%foo</tt>, <tt>@DivisionByZero</tt>,
 404       <tt>%a.really.long.identifier</tt>. The actual regular expression used is
 405       '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.  Identifiers which require
 406       other characters in their names can be surrounded with quotes. Special
 407       characters may be escaped using <tt>"\xx"</tt> where <tt>xx</tt> is the
 408       ASCII code for the character in hexadecimal.  In this way, any character
 409       can be used in a name value, even quotes themselves.</li>
 410
 411   <li>Unnamed values are represented as an unsigned numeric value with their
 412       prefix.  For example, <tt>%12</tt>, <tt>@2</tt>, <tt>%44</tt>.</li>
 413
 414   <li>Constants, which are described in a <a href="#constants">section about
 415       constants</a>, below.</li>
 416 </ol>
 417
 418 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 419    don't need to worry about name clashes with reserved words, and the set of
 420    reserved words may be expanded in the future without penalty.  Additionally,
 421    unnamed identifiers allow a compiler to quickly come up with a temporary
 422    variable without having to avoid symbol table conflicts.</p>
 423
 424 <p>Reserved words in LLVM are very similar to reserved words in other
 425    languages. There are keywords for different opcodes
 426    ('<tt><a href="#i_add">add</a></tt>',
 427    '<tt><a href="#i_bitcast">bitcast</a></tt>',
 428    '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names
 429    ('<tt><a href="#t_void">void</a></tt>',
 430    '<tt><a href="#t_primitive">i32</a></tt>', etc...), and others.  These
 431    reserved words cannot conflict with variable names, because none of them
 432    start with a prefix character (<tt>'%'</tt> or <tt>'@'</tt>).</p>
 433
 434 <p>Here is an example of LLVM code to multiply the integer variable
 435    '<tt>%X</tt>' by 8:</p>
 436
 437 <p>The easy way:</p>
 438
 439 <pre class="doc_code">
 440 %result = <a href="#i_mul">mul</a> i32 %X, 8
 441 </pre>
 442
 443 <p>After strength reduction:</p>
 444
 445 <pre class="doc_code">
 446 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 447 </pre>
 448
 449 <p>And the hard way:</p>
 450
 451 <pre class="doc_code">
 452 %0 = <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 453 %1 = <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 454 %result = <a href="#i_add">add</a> i32 %1, %1
 455 </pre>
 456
 457 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several important
 458    lexical features of LLVM:</p>
 459
 460 <ol>
 461   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 462       line.</li>
 463
 464   <li>Unnamed temporaries are created when the result of a computation is not
 465       assigned to a named value.</li>
 466
 467   <li>Unnamed temporaries are numbered sequentially</li>
 468 </ol>
 469
 470 <p>It also shows a convention that we follow in this document.  When
 471    demonstrating instructions, we will follow an instruction with a comment that
 472    defines the type and name of value produced.  Comments are shown in italic
 473    text.</p>
 474
 475 </div>
 476
 477 <!-- *********************************************************************** -->
 478 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 479 <!-- *********************************************************************** -->
 480
 481 <!-- ======================================================================= -->
 482 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 483 </div>
 484
 485 <div class="doc_text">
 486
 487 <p>LLVM programs are composed of "Module"s, each of which is a translation unit
 488    of the input programs.  Each module consists of functions, global variables,
 489    and symbol table entries.  Modules may be combined together with the LLVM
 490    linker, which merges function (and global variable) definitions, resolves
 491    forward declarations, and merges symbol table entries. Here is an example of
 492    the "hello world" module:</p>
 493
 494 <pre class="doc_code">
 495 <i>; Declare the string constant as a global constant.</i>&nbsp;
 496 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a>&nbsp;<a href="#globalvars">constant</a>&nbsp;<a href="#t_array">[13 x i8]</a> c"hello world\0A\00"      <i>; [13 x i8]*</i>&nbsp;
 497
 498 <i>; External declaration of the puts function</i>&nbsp;
 499 <a href="#functionstructure">declare</a> i32 @puts(i8*)                                      <i>; i32 (i8*)* </i>&nbsp;
 500
 501 <i>; Definition of main function</i>
 502 define i32 @main() {   <i>; i32()* </i>&nbsp;
 503   <i>; Convert [13 x i8]* to i8  *...</i>&nbsp;
 504   %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0   <i>; i8*</i>&nbsp;
 505
 506   <i>; Call puts function to write out the string to stdout.</i>&nbsp;
 507   <a href="#i_call">call</a> i32 @puts(i8* %cast210)           <i>; i32</i>&nbsp;
 508   <a href="#i_ret">ret</a> i32 0&nbsp;
 509 }
 510
 511 <i>; Named metadata</i>
 512 !1 = metadata !{i32 41}
 513 !foo = !{!1, null}
 514 </pre>
 515
 516 <p>This example is made up of a <a href="#globalvars">global variable</a> named
 517    "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function,
 518    a <a href="#functionstructure">function definition</a> for
 519    "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a>
 520    "<tt>foo"</tt>.</p>
 521
 522 <p>In general, a module is made up of a list of global values, where both
 523    functions and global variables are global values.  Global values are
 524    represented by a pointer to a memory location (in this case, a pointer to an
 525    array of char, and a pointer to a function), and have one of the
 526    following <a href="#linkage">linkage types</a>.</p>
 527
 528 </div>
 529
 530 <!-- ======================================================================= -->
 531 <div class="doc_subsection">
 532   <a name="linkage">Linkage Types</a>
 533 </div>
 534
 535 <div class="doc_text">
 536
 537 <p>All Global Variables and Functions have one of the following types of
 538    linkage:</p>
 539
 540 <dl>
 541   <dt><tt><b><a name="linkage_private">private</a></b></tt></dt>
 542   <dd>Global values with "<tt>private</tt>" linkage are only directly accessible
 543       by objects in the current module. In particular, linking code into a
 544       module with an private global value may cause the private to be renamed as
 545       necessary to avoid collisions.  Because the symbol is private to the
 546       module, all references can be updated. This doesn't show up in any symbol
 547       table in the object file.</dd>
 548
 549   <dt><tt><b><a name="linkage_linker_private">linker_private</a></b></tt></dt>
 550   <dd>Similar to <tt>private</tt>, but the symbol is passed through the
 551       assembler and evaluated by the linker. Unlike normal strong symbols, they
 552       are removed by the linker from the final linked image (executable or
 553       dynamic library).</dd>
 554
 555   <dt><tt><b><a name="linkage_linker_private_weak">linker_private_weak</a></b></tt></dt>
 556   <dd>Similar to "<tt>linker_private</tt>", but the symbol is weak. Note that
 557       <tt>linker_private_weak</tt> symbols are subject to coalescing by the
 558       linker. The symbols are removed by the linker from the final linked image
 559       (executable or dynamic library).</dd>
 560
 561   <dt><tt><b><a name="linkage_linker_private_weak_def_auto">linker_private_weak_def_auto</a></b></tt></dt>
 562   <dd>Similar to "<tt>linker_private_weak</tt>", but it's known that the address
 563       of the object is not taken. For instance, functions that had an inline
 564       definition, but the compiler decided not to inline it. Note,
 565       unlike <tt>linker_private</tt> and <tt>linker_private_weak</tt>,
 566       <tt>linker_private_weak_def_auto</tt> may have only <tt>default</tt>
 567       visibility.  The symbols are removed by the linker from the final linked
 568       image (executable or dynamic library).</dd>
 569
 570   <dt><tt><b><a name="linkage_internal">internal</a></b></tt></dt>
 571   <dd>Similar to private, but the value shows as a local symbol
 572       (<tt>STB_LOCAL</tt> in the case of ELF) in the object file. This
 573       corresponds to the notion of the '<tt>static</tt>' keyword in C.</dd>
 574
 575   <dt><tt><b><a name="linkage_available_externally">available_externally</a></b></tt></dt>
 576   <dd>Globals with "<tt>available_externally</tt>" linkage are never emitted
 577       into the object file corresponding to the LLVM module.  They exist to
 578       allow inlining and other optimizations to take place given knowledge of
 579       the definition of the global, which is known to be somewhere outside the
 580       module.  Globals with <tt>available_externally</tt> linkage are allowed to
 581       be discarded at will, and are otherwise the same as <tt>linkonce_odr</tt>.
 582       This linkage type is only allowed on definitions, not declarations.</dd>
 583
 584   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt></dt>
 585   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 586       the same name when linkage occurs.  This can be used to implement
 587       some forms of inline functions, templates, or other code which must be
 588       generated in each translation unit that uses it, but where the body may
 589       be overridden with a more definitive definition later.  Unreferenced
 590       <tt>linkonce</tt> globals are allowed to be discarded.  Note that
 591       <tt>linkonce</tt> linkage does not actually allow the optimizer to
 592       inline the body of this function into callers because it doesn't know if
 593       this definition of the function is the definitive definition within the
 594       program or whether it will be overridden by a stronger definition.
 595       To enable inlining and other optimizations, use "<tt>linkonce_odr</tt>"
 596       linkage.</dd>
 597
 598   <dt><tt><b><a name="linkage_weak">weak</a></b></tt></dt>
 599   <dd>"<tt>weak</tt>" linkage has the same merging semantics as
 600       <tt>linkonce</tt> linkage, except that unreferenced globals with
 601       <tt>weak</tt> linkage may not be discarded.  This is used for globals that
 602       are declared "weak" in C source code.</dd>
 603
 604   <dt><tt><b><a name="linkage_common">common</a></b></tt></dt>
 605   <dd>"<tt>common</tt>" linkage is most similar to "<tt>weak</tt>" linkage, but
 606       they are used for tentative definitions in C, such as "<tt>int X;</tt>" at
 607       global scope.
 608       Symbols with "<tt>common</tt>" linkage are merged in the same way as
 609       <tt>weak symbols</tt>, and they may not be deleted if unreferenced.
 610       <tt>common</tt> symbols may not have an explicit section,
 611       must have a zero initializer, and may not be marked '<a
 612       href="#globalvars"><tt>constant</tt></a>'.  Functions and aliases may not
 613       have common linkage.</dd>
 614
 615
 616   <dt><tt><b><a name="linkage_appending">appending</a></b></tt></dt>
 617   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 618       pointer to array type.  When two global variables with appending linkage
 619       are linked together, the two global arrays are appended together.  This is
 620       the LLVM, typesafe, equivalent of having the system linker append together
 621       "sections" with identical names when .o files are linked.</dd>
 622
 623   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt></dt>
 624   <dd>The semantics of this linkage follow the ELF object file model: the symbol
 625       is weak until linked, if not linked, the symbol becomes null instead of
 626       being an undefined reference.</dd>
 627
 628   <dt><tt><b><a name="linkage_linkonce_odr">linkonce_odr</a></b></tt></dt>
 629   <dt><tt><b><a name="linkage_weak_odr">weak_odr</a></b></tt></dt>
 630   <dd>Some languages allow differing globals to be merged, such as two functions
 631       with different semantics.  Other languages, such as <tt>C++</tt>, ensure
 632       that only equivalent globals are ever merged (the "one definition rule"
 633       &mdash; "ODR").  Such languages can use the <tt>linkonce_odr</tt>
 634       and <tt>weak_odr</tt> linkage types to indicate that the global will only
 635       be merged with equivalent globals.  These linkage types are otherwise the
 636       same as their non-<tt>odr</tt> versions.</dd>
 637
 638   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 639   <dd>If none of the above identifiers are used, the global is externally
 640       visible, meaning that it participates in linkage and can be used to
 641       resolve external symbol references.</dd>
 642 </dl>
 643
 644 <p>The next two types of linkage are targeted for Microsoft Windows platform
 645    only. They are designed to support importing (exporting) symbols from (to)
 646    DLLs (Dynamic Link Libraries).</p>
 647
 648 <dl>
 649   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt></dt>
 650   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 651       or variable via a global pointer to a pointer that is set up by the DLL
 652       exporting the symbol. On Microsoft Windows targets, the pointer name is
 653       formed by combining <code>__imp_</code> and the function or variable
 654       name.</dd>
 655
 656   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt></dt>
 657   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 658       pointer to a pointer in a DLL, so that it can be referenced with the
 659       <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 660       name is formed by combining <code>__imp_</code> and the function or
 661       variable name.</dd>
 662 </dl>
 663
 664 <p>For example, since the "<tt>.LC0</tt>" variable is defined to be internal, if
 665    another module defined a "<tt>.LC0</tt>" variable and was linked with this
 666    one, one of the two would be renamed, preventing a collision.  Since
 667    "<tt>main</tt>" and "<tt>puts</tt>" are external (i.e., lacking any linkage
 668    declarations), they are accessible outside of the current module.</p>
 669
 670 <p>It is illegal for a function <i>declaration</i> to have any linkage type
 671    other than "externally visible", <tt>dllimport</tt>
 672    or <tt>extern_weak</tt>.</p>
 673
 674 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt>, <tt>weak</tt>
 675    or <tt>weak_odr</tt> linkages.</p>
 676
 677 </div>
 678
 679 <!-- ======================================================================= -->
 680 <div class="doc_subsection">
 681   <a name="callingconv">Calling Conventions</a>
 682 </div>
 683
 684 <div class="doc_text">
 685
 686 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 687    and <a href="#i_invoke">invokes</a> can all have an optional calling
 688    convention specified for the call.  The calling convention of any pair of
 689    dynamic caller/callee must match, or the behavior of the program is
 690    undefined.  The following calling conventions are supported by LLVM, and more
 691    may be added in the future:</p>
 692
 693 <dl>
 694   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 695   <dd>This calling convention (the default if no other calling convention is
 696       specified) matches the target C calling conventions.  This calling
 697       convention supports varargs function calls and tolerates some mismatch in
 698       the declared prototype and implemented declaration of the function (as
 699       does normal C).</dd>
 700
 701   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 702   <dd>This calling convention attempts to make calls as fast as possible
 703       (e.g. by passing things in registers).  This calling convention allows the
 704       target to use whatever tricks it wants to produce fast code for the
 705       target, without having to conform to an externally specified ABI
 706       (Application Binary Interface).
 707       <a href="CodeGenerator.html#tailcallopt">Tail calls can only be optimized
 708       when this or the GHC convention is used.</a>  This calling convention
 709       does not support varargs and requires the prototype of all callees to
 710       exactly match the prototype of the function definition.</dd>
 711
 712   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 713   <dd>This calling convention attempts to make code in the caller as efficient
 714       as possible under the assumption that the call is not commonly executed.
 715       As such, these calls often preserve all registers so that the call does
 716       not break any live ranges in the caller side.  This calling convention
 717       does not support varargs and requires the prototype of all callees to
 718       exactly match the prototype of the function definition.</dd>
 719
 720   <dt><b>"<tt>cc <em>10</em></tt>" - GHC convention</b>:</dt>
 721   <dd>This calling convention has been implemented specifically for use by the
 722       <a href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
 723       It passes everything in registers, going to extremes to achieve this by
 724       disabling callee save registers. This calling convention should not be
 725       used lightly but only for specific situations such as an alternative to
 726       the <em>register pinning</em> performance technique often used when
 727       implementing functional programming languages.At the moment only X86
 728       supports this convention and it has the following limitations:
 729       <ul>
 730         <li>On <em>X86-32</em> only supports up to 4 bit type parameters. No
 731             floating point types are supported.</li>
 732         <li>On <em>X86-64</em> only supports up to 10 bit type parameters and
 733             6 floating point parameters.</li>
 734       </ul>
 735       This calling convention supports
 736       <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> but
 737       requires both the caller and callee are using it.
 738   </dd>
 739
 740   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 741   <dd>Any calling convention may be specified by number, allowing
 742       target-specific calling conventions to be used.  Target specific calling
 743       conventions start at 64.</dd>
 744 </dl>
 745
 746 <p>More calling conventions can be added/defined on an as-needed basis, to
 747    support Pascal conventions or any other well-known target-independent
 748    convention.</p>
 749
 750 </div>
 751
 752 <!-- ======================================================================= -->
 753 <div class="doc_subsection">
 754   <a name="visibility">Visibility Styles</a>
 755 </div>
 756
 757 <div class="doc_text">
 758
 759 <p>All Global Variables and Functions have one of the following visibility
 760    styles:</p>
 761
 762 <dl>
 763   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 764   <dd>On targets that use the ELF object file format, default visibility means
 765       that the declaration is visible to other modules and, in shared libraries,
 766       means that the declared entity may be overridden. On Darwin, default
 767       visibility means that the declaration is visible to other modules. Default
 768       visibility corresponds to "external linkage" in the language.</dd>
 769
 770   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 771   <dd>Two declarations of an object with hidden visibility refer to the same
 772       object if they are in the same shared object. Usually, hidden visibility
 773       indicates that the symbol will not be placed into the dynamic symbol
 774       table, so no other module (executable or shared library) can reference it
 775       directly.</dd>
 776
 777   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 778   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 779       the dynamic symbol table, but that references within the defining module
 780       will bind to the local symbol. That is, the symbol cannot be overridden by
 781       another module.</dd>
 782 </dl>
 783
 784 </div>
 785
 786 <!-- ======================================================================= -->
 787 <div class="doc_subsection">
 788   <a name="namedtypes">Named Types</a>
 789 </div>
 790
 791 <div class="doc_text">
 792
 793 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 794    it easier to read the IR and make the IR more condensed (particularly when
 795    recursive types are involved).  An example of a name specification is:</p>
 796
 797 <pre class="doc_code">
 798 %mytype = type { %mytype*, i32 }
 799 </pre>
 800
 801 <p>You may give a name to any <a href="#typesystem">type</a> except
 802    "<a href="#t_void">void</a>".  Type name aliases may be used anywhere a type
 803    is expected with the syntax "%mytype".</p>
 804
 805 <p>Note that type names are aliases for the structural type that they indicate,
 806    and that you can therefore specify multiple names for the same type.  This
 807    often leads to confusing behavior when dumping out a .ll file.  Since LLVM IR
 808    uses structural typing, the name is not part of the type.  When printing out
 809    LLVM IR, the printer will pick <em>one name</em> to render all types of a
 810    particular shape.  This means that if you have code where two different
 811    source types end up having the same LLVM type, that the dumper will sometimes
 812    print the "wrong" or unexpected type.  This is an important design point and
 813    isn't going to change.</p>
 814
 815 </div>
 816
 817 <!-- ======================================================================= -->
 818 <div class="doc_subsection">
 819   <a name="globalvars">Global Variables</a>
 820 </div>
 821
 822 <div class="doc_text">
 823
 824 <p>Global variables define regions of memory allocated at compilation time
 825    instead of run-time.  Global variables may optionally be initialized, may
 826    have an explicit section to be placed in, and may have an optional explicit
 827    alignment specified.  A variable may be defined as "thread_local", which
 828    means that it will not be shared by threads (each thread will have a
 829    separated copy of the variable).  A variable may be defined as a global
 830    "constant," which indicates that the contents of the variable
 831    will <b>never</b> be modified (enabling better optimization, allowing the
 832    global data to be placed in the read-only section of an executable, etc).
 833    Note that variables that need runtime initialization cannot be marked
 834    "constant" as there is a store to the variable.</p>
 835
 836 <p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
 837    constant, even if the final definition of the global is not.  This capability
 838    can be used to enable slightly better optimization of the program, but
 839    requires the language definition to guarantee that optimizations based on the
 840    'constantness' are valid for the translation units that do not include the
 841    definition.</p>
 842
 843 <p>As SSA values, global variables define pointer values that are in scope
 844    (i.e. they dominate) all basic blocks in the program.  Global variables
 845    always define a pointer to their "content" type because they describe a
 846    region of memory, and all memory objects in LLVM are accessed through
 847    pointers.</p>
 848
 849 <p>Global variables can be marked with <tt>unnamed_addr</tt> which indicates
 850   that the address is not significant, only the content. Constants marked
 851   like this can be merged with other constants if they have the same
 852   initializer. Note that a constant with significant address <em>can</em>
 853   be merged with a <tt>unnamed_addr</tt> constant, the result being a
 854   constant whose address is significant.</p>
 855
 856 <p>A global variable may be declared to reside in a target-specific numbered
 857    address space. For targets that support them, address spaces may affect how
 858    optimizations are performed and/or what target instructions are used to
 859    access the variable. The default address space is zero. The address space
 860    qualifier must precede any other attributes.</p>
 861
 862 <p>LLVM allows an explicit section to be specified for globals.  If the target
 863    supports it, it will emit globals to the section specified.</p>
 864
 865 <p>An explicit alignment may be specified for a global, which must be a power
 866    of 2.  If not present, or if the alignment is set to zero, the alignment of
 867    the global is set by the target to whatever it feels convenient.  If an
 868    explicit alignment is specified, the global is forced to have exactly that
 869    alignment.  Targets and optimizers are not allowed to over-align the global
 870    if the global has an assigned section.  In this case, the extra alignment
 871    could be observable: for example, code could assume that the globals are
 872    densely packed in their section and try to iterate over them as an array,
 873    alignment padding would break this iteration.</p>
 874
 875 <p>For example, the following defines a global in a numbered address space with
 876    an initializer, section, and alignment:</p>
 877
 878 <pre class="doc_code">
 879 @G = addrspace(5) constant float 1.0, section "foo", align 4
 880 </pre>
 881
 882 </div>
 883
 884
 885 <!-- ======================================================================= -->
 886 <div class="doc_subsection">
 887   <a name="functionstructure">Functions</a>
 888 </div>
 889
 890 <div class="doc_text">
 891
 892 <p>LLVM function definitions consist of the "<tt>define</tt>" keyword, an
 893    optional <a href="#linkage">linkage type</a>, an optional
 894    <a href="#visibility">visibility style</a>, an optional
 895    <a href="#callingconv">calling convention</a>,
 896    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 897    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 898    name, a (possibly empty) argument list (each with optional
 899    <a href="#paramattrs">parameter attributes</a>), optional
 900    <a href="#fnattrs">function attributes</a>, an optional section, an optional
 901    alignment, an optional <a href="#gc">garbage collector name</a>, an opening
 902    curly brace, a list of basic blocks, and a closing curly brace.</p>
 903
 904 <p>LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 905    optional <a href="#linkage">linkage type</a>, an optional
 906    <a href="#visibility">visibility style</a>, an optional
 907    <a href="#callingconv">calling convention</a>,
 908    an optional <tt>unnamed_addr</tt> attribute, a return type, an optional
 909    <a href="#paramattrs">parameter attribute</a> for the return type, a function
 910    name, a possibly empty list of arguments, an optional alignment, and an
 911    optional <a href="#gc">garbage collector name</a>.</p>
 912
 913 <p>A function definition contains a list of basic blocks, forming the CFG
 914    (Control Flow Graph) for the function.  Each basic block may optionally start
 915    with a label (giving the basic block a symbol table entry), contains a list
 916    of instructions, and ends with a <a href="#terminators">terminator</a>
 917    instruction (such as a branch or function return).</p>
 918
 919 <p>The first basic block in a function is special in two ways: it is immediately
 920    executed on entrance to the function, and it is not allowed to have
 921    predecessor basic blocks (i.e. there can not be any branches to the entry
 922    block of a function).  Because the block can have no predecessors, it also
 923    cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 924
 925 <p>LLVM allows an explicit section to be specified for functions.  If the target
 926    supports it, it will emit functions to the section specified.</p>
 927
 928 <p>An explicit alignment may be specified for a function.  If not present, or if
 929    the alignment is set to zero, the alignment of the function is set by the
 930    target to whatever it feels convenient.  If an explicit alignment is
 931    specified, the function is forced to have at least that much alignment.  All
 932    alignments must be a power of 2.</p>
 933
 934 <p>If the <tt>unnamed_addr</tt> attribute is given, the address is know to not
 935   be significant and two identical functions can be merged</p>.
 936
 937 <h5>Syntax:</h5>
 938 <pre class="doc_code">
 939 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 940        [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 941        &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 942        [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 943        [<a href="#gc">gc</a>] { ... }
 944 </pre>
 945
 946 </div>
 947
 948 <!-- ======================================================================= -->
 949 <div class="doc_subsection">
 950   <a name="aliasstructure">Aliases</a>
 951 </div>
 952
 953 <div class="doc_text">
 954
 955 <p>Aliases act as "second name" for the aliasee value (which can be either
 956    function, global variable, another alias or bitcast of global value). Aliases
 957    may have an optional <a href="#linkage">linkage type</a>, and an
 958    optional <a href="#visibility">visibility style</a>.</p>
 959
 960 <h5>Syntax:</h5>
 961 <pre class="doc_code">
 962 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 963 </pre>
 964
 965 </div>
 966
 967 <!-- ======================================================================= -->
 968 <div class="doc_subsection">
 969   <a name="namedmetadatastructure">Named Metadata</a>
 970 </div>
 971
 972 <div class="doc_text">
 973
 974 <p>Named metadata is a collection of metadata. <a href="#metadata">Metadata
 975    nodes</a> (but not metadata strings) are the only valid operands for
 976    a named metadata.</p>
 977
 978 <h5>Syntax:</h5>
 979 <pre class="doc_code">
 980 ; Some unnamed metadata nodes, which are referenced by the named metadata.
 981 !0 = metadata !{metadata !"zero"}
 982 !1 = metadata !{metadata !"one"}
 983 !2 = metadata !{metadata !"two"}
 984 ; A named metadata.
 985 !name = !{!0, !1, !2}
 986 </pre>
 987
 988 </div>
 989
 990 <!-- ======================================================================= -->
 991 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 992
 993 <div class="doc_text">
 994
 995 <p>The return type and each parameter of a function type may have a set of
 996    <i>parameter attributes</i> associated with them. Parameter attributes are
 997    used to communicate additional information about the result or parameters of
 998    a function. Parameter attributes are considered to be part of the function,
 999    not of the function type, so functions with different parameter attributes
1000    can have the same function type.</p>
1001
1002 <p>Parameter attributes are simple keywords that follow the type specified. If
1003    multiple parameter attributes are needed, they are space separated. For
1004    example:</p>
1005
1006 <pre class="doc_code">
1007 declare i32 @printf(i8* noalias nocapture, ...)
1008 declare i32 @atoi(i8 zeroext)
1009 declare signext i8 @returns_signed_char()
1010 </pre>
1011
1012 <p>Note that any attributes for the function result (<tt>nounwind</tt>,
1013    <tt>readonly</tt>) come immediately after the argument list.</p>
1014
1015 <p>Currently, only the following parameter attributes are defined:</p>
1016
1017 <dl>
1018   <dt><tt><b>zeroext</b></tt></dt>
1019   <dd>This indicates to the code generator that the parameter or return value
1020       should be zero-extended to a 32-bit value by the caller (for a parameter)
1021       or the callee (for a return value).</dd>
1022
1023   <dt><tt><b>signext</b></tt></dt>
1024   <dd>This indicates to the code generator that the parameter or return value
1025       should be sign-extended to a 32-bit value by the caller (for a parameter)
1026       or the callee (for a return value).</dd>
1027
1028   <dt><tt><b>inreg</b></tt></dt>
1029   <dd>This indicates that this parameter or return value should be treated in a
1030       special target-dependent fashion during while emitting code for a function
1031       call or return (usually, by putting it in a register as opposed to memory,
1032       though some targets use it to distinguish between two different kinds of
1033       registers).  Use of this attribute is target-specific.</dd>
1034
1035   <dt><tt><b><a name="byval">byval</a></b></tt></dt>
1036   <dd><p>This indicates that the pointer parameter should really be passed by
1037       value to the function.  The attribute implies that a hidden copy of the
1038       pointee
1039       is made between the caller and the callee, so the callee is unable to
1040       modify the value in the callee.  This attribute is only valid on LLVM
1041       pointer arguments.  It is generally used to pass structs and arrays by
1042       value, but is also valid on pointers to scalars.  The copy is considered
1043       to belong to the caller not the callee (for example,
1044       <tt><a href="#readonly">readonly</a></tt> functions should not write to
1045       <tt>byval</tt> parameters). This is not a valid attribute for return
1046       values.</p>
1047
1048       <p>The byval attribute also supports specifying an alignment with
1049       the align attribute.  It indicates the alignment of the stack slot to
1050       form and the known alignment of the pointer specified to the call site. If
1051       the alignment is not specified, then the code generator makes a
1052       target-specific assumption.</p></dd>
1053
1054   <dt><tt><b><a name="sret">sret</a></b></tt></dt>
1055   <dd>This indicates that the pointer parameter specifies the address of a
1056       structure that is the return value of the function in the source program.
1057       This pointer must be guaranteed by the caller to be valid: loads and
1058       stores to the structure may be assumed by the callee to not to trap.  This
1059       may only be applied to the first parameter. This is not a valid attribute
1060       for return values. </dd>
1061
1062   <dt><tt><b><a name="noalias">noalias</a></b></tt></dt>
1063   <dd>This indicates that pointer values
1064       <a href="#pointeraliasing"><i>based</i></a> on the argument or return
1065       value do not alias pointer values which are not <i>based</i> on it,
1066       ignoring certain "irrelevant" dependencies.
1067       For a call to the parent function, dependencies between memory
1068       references from before or after the call and from those during the call
1069       are "irrelevant" to the <tt>noalias</tt> keyword for the arguments and
1070       return value used in that call.
1071       The caller shares the responsibility with the callee for ensuring that
1072       these requirements are met.
1073       For further details, please see the discussion of the NoAlias response in
1074       <a href="AliasAnalysis.html#MustMayNo">alias analysis</a>.<br>
1075 <br>
1076       Note that this definition of <tt>noalias</tt> is intentionally
1077       similar to the definition of <tt>restrict</tt> in C99 for function
1078       arguments, though it is slightly weaker.
1079 <br>
1080       For function return values, C99's <tt>restrict</tt> is not meaningful,
1081       while LLVM's <tt>noalias</tt> is.
1082       </dd>
1083
1084   <dt><tt><b><a name="nocapture">nocapture</a></b></tt></dt>
1085   <dd>This indicates that the callee does not make any copies of the pointer
1086       that outlive the callee itself. This is not a valid attribute for return
1087       values.</dd>
1088
1089   <dt><tt><b><a name="nest">nest</a></b></tt></dt>
1090   <dd>This indicates that the pointer parameter can be excised using the
1091       <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
1092       attribute for return values.</dd>
1093 </dl>
1094
1095 </div>
1096
1097 <!-- ======================================================================= -->
1098 <div class="doc_subsection">
1099   <a name="gc">Garbage Collector Names</a>
1100 </div>
1101
1102 <div class="doc_text">
1103
1104 <p>Each function may specify a garbage collector name, which is simply a
1105    string:</p>
1106
1107 <pre class="doc_code">
1108 define void @f() gc "name" { ... }
1109 </pre>
1110
1111 <p>The compiler declares the supported values of <i>name</i>. Specifying a
1112    collector which will cause the compiler to alter its output in order to
1113    support the named garbage collection algorithm.</p>
1114
1115 </div>
1116
1117 <!-- ======================================================================= -->
1118 <div class="doc_subsection">
1119   <a name="fnattrs">Function Attributes</a>
1120 </div>
1121
1122 <div class="doc_text">
1123
1124 <p>Function attributes are set to communicate additional information about a
1125    function. Function attributes are considered to be part of the function, not
1126    of the function type, so functions with different parameter attributes can
1127    have the same function type.</p>
1128
1129 <p>Function attributes are simple keywords that follow the type specified. If
1130    multiple attributes are needed, they are space separated. For example:</p>
1131
1132 <pre class="doc_code">
1133 define void @f() noinline { ... }
1134 define void @f() alwaysinline { ... }
1135 define void @f() alwaysinline optsize { ... }
1136 define void @f() optsize { ... }
1137 </pre>
1138
1139 <dl>
1140   <dt><tt><b>alignstack(&lt;<em>n</em>&gt;)</b></tt></dt>
1141   <dd>This attribute indicates that, when emitting the prologue and epilogue,
1142       the backend should forcibly align the stack pointer. Specify the
1143       desired alignment, which must be a power of two, in parentheses.
1144
1145   <dt><tt><b>alwaysinline</b></tt></dt>
1146   <dd>This attribute indicates that the inliner should attempt to inline this
1147       function into callers whenever possible, ignoring any active inlining size
1148       threshold for this caller.</dd>
1149
1150   <dt><tt><b>hotpatch</b></tt></dt>
1151   <dd>This attribute indicates that the function should be 'hotpatchable',
1152       meaning the function can be patched and/or hooked even while it is
1153       loaded into memory. On x86, the function prologue will be preceded
1154       by six bytes of padding and will begin with a two-byte instruction.
1155       Most of the functions in the Windows system DLLs in Windows XP SP2 or
1156       higher were compiled in this fashion.</dd>
1157
1158   <dt><tt><b>inlinehint</b></tt></dt>
1159   <dd>This attribute indicates that the source code contained a hint that inlining
1160       this function is desirable (such as the "inline" keyword in C/C++).  It
1161       is just a hint; it imposes no requirements on the inliner.</dd>
1162
1163   <dt><tt><b>naked</b></tt></dt>
1164   <dd>This attribute disables prologue / epilogue emission for the function.
1165       This can have very system-specific consequences.</dd>
1166
1167   <dt><tt><b>noimplicitfloat</b></tt></dt>
1168   <dd>This attributes disables implicit floating point instructions.</dd>
1169
1170   <dt><tt><b>noinline</b></tt></dt>
1171   <dd>This attribute indicates that the inliner should never inline this
1172       function in any situation. This attribute may not be used together with
1173       the <tt>alwaysinline</tt> attribute.</dd>
1174
1175   <dt><tt><b>noredzone</b></tt></dt>
1176   <dd>This attribute indicates that the code generator should not use a red
1177       zone, even if the target-specific ABI normally permits it.</dd>
1178
1179   <dt><tt><b>noreturn</b></tt></dt>
1180   <dd>This function attribute indicates that the function never returns
1181       normally.  This produces undefined behavior at runtime if the function
1182       ever does dynamically return.</dd>
1183
1184   <dt><tt><b>nounwind</b></tt></dt>
1185   <dd>This function attribute indicates that the function never returns with an
1186       unwind or exceptional control flow.  If the function does unwind, its
1187       runtime behavior is undefined.</dd>
1188
1189   <dt><tt><b>optsize</b></tt></dt>
1190   <dd>This attribute suggests that optimization passes and code generator passes
1191       make choices that keep the code size of this function low, and otherwise
1192       do optimizations specifically to reduce code size.</dd>
1193
1194   <dt><tt><b>readnone</b></tt></dt>
1195   <dd>This attribute indicates that the function computes its result (or decides
1196       to unwind an exception) based strictly on its arguments, without
1197       dereferencing any pointer arguments or otherwise accessing any mutable
1198       state (e.g. memory, control registers, etc) visible to caller functions.
1199       It does not write through any pointer arguments
1200       (including <tt><a href="#byval">byval</a></tt> arguments) and never
1201       changes any state visible to callers.  This means that it cannot unwind
1202       exceptions by calling the <tt>C++</tt> exception throwing methods, but
1203       could use the <tt>unwind</tt> instruction.</dd>
1204
1205   <dt><tt><b><a name="readonly">readonly</a></b></tt></dt>
1206   <dd>This attribute indicates that the function does not write through any
1207       pointer arguments (including <tt><a href="#byval">byval</a></tt>
1208       arguments) or otherwise modify any state (e.g. memory, control registers,
1209       etc) visible to caller functions.  It may dereference pointer arguments
1210       and read state that may be set in the caller.  A readonly function always
1211       returns the same value (or unwinds an exception identically) when called
1212       with the same set of arguments and global state.  It cannot unwind an
1213       exception by calling the <tt>C++</tt> exception throwing methods, but may
1214       use the <tt>unwind</tt> instruction.</dd>
1215
1216   <dt><tt><b><a name="ssp">ssp</a></b></tt></dt>
1217   <dd>This attribute indicates that the function should emit a stack smashing
1218       protector. It is in the form of a "canary"&mdash;a random value placed on
1219       the stack before the local variables that's checked upon return from the
1220       function to see if it has been overwritten. A heuristic is used to
1221       determine if a function needs stack protectors or not.<br>
1222 <br>
1223       If a function that has an <tt>ssp</tt> attribute is inlined into a
1224       function that doesn't have an <tt>ssp</tt> attribute, then the resulting
1225       function will have an <tt>ssp</tt> attribute.</dd>
1226
1227   <dt><tt><b>sspreq</b></tt></dt>
1228   <dd>This attribute indicates that the function should <em>always</em> emit a
1229       stack smashing protector. This overrides
1230       the <tt><a href="#ssp">ssp</a></tt> function attribute.<br>
1231 <br>
1232       If a function that has an <tt>sspreq</tt> attribute is inlined into a
1233       function that doesn't have an <tt>sspreq</tt> attribute or which has
1234       an <tt>ssp</tt> attribute, then the resulting function will have
1235       an <tt>sspreq</tt> attribute.</dd>
1236 </dl>
1237
1238 </div>
1239
1240 <!-- ======================================================================= -->
1241 <div class="doc_subsection">
1242   <a name="moduleasm">Module-Level Inline Assembly</a>
1243 </div>
1244
1245 <div class="doc_text">
1246
1247 <p>Modules may contain "module-level inline asm" blocks, which corresponds to
1248    the GCC "file scope inline asm" blocks.  These blocks are internally
1249    concatenated by LLVM and treated as a single unit, but may be separated in
1250    the <tt>.ll</tt> file if desired.  The syntax is very simple:</p>
1251
1252 <pre class="doc_code">
1253 module asm "inline asm code goes here"
1254 module asm "more can go here"
1255 </pre>
1256
1257 <p>The strings can contain any character by escaping non-printable characters.
1258    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1259    for the number.</p>
1260
1261 <p>The inline asm code is simply printed to the machine code .s file when
1262    assembly code is generated.</p>
1263
1264 </div>
1265
1266 <!-- ======================================================================= -->
1267 <div class="doc_subsection">
1268   <a name="datalayout">Data Layout</a>
1269 </div>
1270
1271 <div class="doc_text">
1272
1273 <p>A module may specify a target specific data layout string that specifies how
1274    data is to be laid out in memory. The syntax for the data layout is
1275    simply:</p>
1276
1277 <pre class="doc_code">
1278 target datalayout = "<i>layout specification</i>"
1279 </pre>
1280
1281 <p>The <i>layout specification</i> consists of a list of specifications
1282    separated by the minus sign character ('-').  Each specification starts with
1283    a letter and may include other information after the letter to define some
1284    aspect of the data layout.  The specifications accepted are as follows:</p>
1285
1286 <dl>
1287   <dt><tt>E</tt></dt>
1288   <dd>Specifies that the target lays out data in big-endian form. That is, the
1289       bits with the most significance have the lowest address location.</dd>
1290
1291   <dt><tt>e</tt></dt>
1292   <dd>Specifies that the target lays out data in little-endian form. That is,
1293       the bits with the least significance have the lowest address
1294       location.</dd>
1295
1296   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1297   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1298       <i>preferred</i> alignments. All sizes are in bits. Specifying
1299       the <i>pref</i> alignment is optional. If omitted, the
1300       preceding <tt>:</tt> should be omitted too.</dd>
1301
1302   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1303   <dd>This specifies the alignment for an integer type of a given bit
1304       <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1305
1306   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1307   <dd>This specifies the alignment for a vector type of a given bit
1308       <i>size</i>.</dd>
1309
1310   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1311   <dd>This specifies the alignment for a floating point type of a given bit
1312       <i>size</i>. Only values of <i>size</i> that are supported by the target
1313       will work.  32 (float) and 64 (double) are supported on all targets;
1314       80 or 128 (different flavors of long double) are also supported on some
1315       targets.
1316
1317   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1318   <dd>This specifies the alignment for an aggregate type of a given bit
1319       <i>size</i>.</dd>
1320
1321   <dt><tt>s<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1322   <dd>This specifies the alignment for a stack object of a given bit
1323       <i>size</i>.</dd>
1324
1325   <dt><tt>n<i>size1</i>:<i>size2</i>:<i>size3</i>...</tt></dt>
1326   <dd>This specifies a set of native integer widths for the target CPU
1327       in bits.  For example, it might contain "n32" for 32-bit PowerPC,
1328       "n32:64" for PowerPC 64, or "n8:16:32:64" for X86-64.  Elements of
1329       this set are considered to support most general arithmetic
1330       operations efficiently.</dd>
1331 </dl>
1332
1333 <p>When constructing the data layout for a given target, LLVM starts with a
1334    default set of specifications which are then (possibly) overridden by the
1335    specifications in the <tt>datalayout</tt> keyword. The default specifications
1336    are given in this list:</p>
1337
1338 <ul>
1339   <li><tt>E</tt> - big endian</li>
1340   <li><tt>p:64:64:64</tt> - 64-bit pointers with 64-bit alignment</li>
1341   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1342   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1343   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1344   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1345   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1346   alignment of 64-bits</li>
1347   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1348   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1349   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1350   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1351   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1352   <li><tt>s0:64:64</tt> - stack objects are 64-bit aligned</li>
1353 </ul>
1354
1355 <p>When LLVM is determining the alignment for a given type, it uses the
1356    following rules:</p>
1357
1358 <ol>
1359   <li>If the type sought is an exact match for one of the specifications, that
1360       specification is used.</li>
1361
1362   <li>If no match is found, and the type sought is an integer type, then the
1363       smallest integer type that is larger than the bitwidth of the sought type
1364       is used. If none of the specifications are larger than the bitwidth then
1365       the the largest integer type is used. For example, given the default
1366       specifications above, the i7 type will use the alignment of i8 (next
1367       largest) while both i65 and i256 will use the alignment of i64 (largest
1368       specified).</li>
1369
1370   <li>If no match is found, and the type sought is a vector type, then the
1371       largest vector type that is smaller than the sought vector type will be
1372       used as a fall back.  This happens because &lt;128 x double&gt; can be
1373       implemented in terms of 64 &lt;2 x double&gt;, for example.</li>
1374 </ol>
1375
1376 </div>
1377
1378 <!-- ======================================================================= -->
1379 <div class="doc_subsection">
1380   <a name="pointeraliasing">Pointer Aliasing Rules</a>
1381 </div>
1382
1383 <div class="doc_text">
1384
1385 <p>Any memory access must be done through a pointer value associated
1386 with an address range of the memory access, otherwise the behavior
1387 is undefined. Pointer values are associated with address ranges
1388 according to the following rules:</p>
1389
1390 <ul>
1391   <li>A pointer value is associated with the addresses associated with
1392       any value it is <i>based</i> on.
1393   <li>An address of a global variable is associated with the address
1394       range of the variable's storage.</li>
1395   <li>The result value of an allocation instruction is associated with
1396       the address range of the allocated storage.</li>
1397   <li>A null pointer in the default address-space is associated with
1398       no address.</li>
1399   <li>An integer constant other than zero or a pointer value returned
1400       from a function not defined within LLVM may be associated with address
1401       ranges allocated through mechanisms other than those provided by
1402       LLVM. Such ranges shall not overlap with any ranges of addresses
1403       allocated by mechanisms provided by LLVM.</li>
1404 </ul>
1405
1406 <p>A pointer value is <i>based</i> on another pointer value according
1407    to the following rules:</p>
1408
1409 <ul>
1410   <li>A pointer value formed from a
1411       <tt><a href="#i_getelementptr">getelementptr</a></tt> operation
1412       is <i>based</i> on the first operand of the <tt>getelementptr</tt>.</li>
1413   <li>The result value of a
1414       <tt><a href="#i_bitcast">bitcast</a></tt> is <i>based</i> on the operand
1415       of the <tt>bitcast</tt>.</li>
1416   <li>A pointer value formed by an
1417       <tt><a href="#i_inttoptr">inttoptr</a></tt> is <i>based</i> on all
1418       pointer values that contribute (directly or indirectly) to the
1419       computation of the pointer's value.</li>
1420   <li>The "<i>based</i> on" relationship is transitive.</li>
1421 </ul>
1422
1423 <p>Note that this definition of <i>"based"</i> is intentionally
1424    similar to the definition of <i>"based"</i> in C99, though it is
1425    slightly weaker.</p>
1426
1427 <p>LLVM IR does not associate types with memory. The result type of a
1428 <tt><a href="#i_load">load</a></tt> merely indicates the size and
1429 alignment of the memory from which to load, as well as the
1430 interpretation of the value. The first operand type of a
1431 <tt><a href="#i_store">store</a></tt> similarly only indicates the size
1432 and alignment of the store.</p>
1433
1434 <p>Consequently, type-based alias analysis, aka TBAA, aka
1435 <tt>-fstrict-aliasing</tt>, is not applicable to general unadorned
1436 LLVM IR. <a href="#metadata">Metadata</a> may be used to encode
1437 additional information which specialized optimization passes may use
1438 to implement type-based alias analysis.</p>
1439
1440 </div>
1441
1442 <!-- ======================================================================= -->
1443 <div class="doc_subsection">
1444   <a name="volatile">Volatile Memory Accesses</a>
1445 </div>
1446
1447 <div class="doc_text">
1448
1449 <p>Certain memory accesses, such as <a href="#i_load"><tt>load</tt></a>s, <a
1450 href="#i_store"><tt>store</tt></a>s, and <a
1451 href="#int_memcpy"><tt>llvm.memcpy</tt></a>s may be marked <tt>volatile</tt>.
1452 The optimizers must not change the number of volatile operations or change their
1453 order of execution relative to other volatile operations.  The optimizers
1454 <i>may</i> change the order of volatile operations relative to non-volatile
1455 operations.  This is not Java's "volatile" and has no cross-thread
1456 synchronization behavior.</p>
1457
1458 </div>
1459
1460 <!-- *********************************************************************** -->
1461 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
1462 <!-- *********************************************************************** -->
1463
1464 <div class="doc_text">
1465
1466 <p>The LLVM type system is one of the most important features of the
1467    intermediate representation.  Being typed enables a number of optimizations
1468    to be performed on the intermediate representation directly, without having
1469    to do extra analyses on the side before the transformation.  A strong type
1470    system makes it easier to read the generated code and enables novel analyses
1471    and transformations that are not feasible to perform on normal three address
1472    code representations.</p>
1473
1474 </div>
1475
1476 <!-- ======================================================================= -->
1477 <div class="doc_subsection"> <a name="t_classifications">Type
1478 Classifications</a> </div>
1479
1480 <div class="doc_text">
1481
1482 <p>The types fall into a few useful classifications:</p>
1483
1484 <table border="1" cellspacing="0" cellpadding="4">
1485   <tbody>
1486     <tr><th>Classification</th><th>Types</th></tr>
1487     <tr>
1488       <td><a href="#t_integer">integer</a></td>
1489       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1490     </tr>
1491     <tr>
1492       <td><a href="#t_floating">floating point</a></td>
1493       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1494     </tr>
1495     <tr>
1496       <td><a name="t_firstclass">first class</a></td>
1497       <td><a href="#t_integer">integer</a>,
1498           <a href="#t_floating">floating point</a>,
1499           <a href="#t_pointer">pointer</a>,
1500           <a href="#t_vector">vector</a>,
1501           <a href="#t_struct">structure</a>,
1502           <a href="#t_array">array</a>,
1503           <a href="#t_label">label</a>,
1504           <a href="#t_metadata">metadata</a>.
1505       </td>
1506     </tr>
1507     <tr>
1508       <td><a href="#t_primitive">primitive</a></td>
1509       <td><a href="#t_label">label</a>,
1510           <a href="#t_void">void</a>,
1511           <a href="#t_integer">integer</a>,
1512           <a href="#t_floating">floating point</a>,
1513           <a href="#t_x86mmx">x86mmx</a>,
1514           <a href="#t_metadata">metadata</a>.</td>
1515     </tr>
1516     <tr>
1517       <td><a href="#t_derived">derived</a></td>
1518       <td><a href="#t_array">array</a>,
1519           <a href="#t_function">function</a>,
1520           <a href="#t_pointer">pointer</a>,
1521           <a href="#t_struct">structure</a>,
1522           <a href="#t_pstruct">packed structure</a>,
1523           <a href="#t_vector">vector</a>,
1524           <a href="#t_opaque">opaque</a>.
1525       </td>
1526     </tr>
1527   </tbody>
1528 </table>
1529
1530 <p>The <a href="#t_firstclass">first class</a> types are perhaps the most
1531    important.  Values of these types are the only ones which can be produced by
1532    instructions.</p>
1533
1534 </div>
1535
1536 <!-- ======================================================================= -->
1537 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
1538
1539 <div class="doc_text">
1540
1541 <p>The primitive types are the fundamental building blocks of the LLVM
1542    system.</p>
1543
1544 </div>
1545
1546 <!-- _______________________________________________________________________ -->
1547 <div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
1548
1549 <div class="doc_text">
1550
1551 <h5>Overview:</h5>
1552 <p>The integer type is a very simple type that simply specifies an arbitrary
1553    bit width for the integer type desired. Any bit width from 1 bit to
1554    2<sup>23</sup>-1 (about 8 million) can be specified.</p>
1555
1556 <h5>Syntax:</h5>
1557 <pre>
1558   iN
1559 </pre>
1560
1561 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1562    value.</p>
1563
1564 <h5>Examples:</h5>
1565 <table class="layout">
1566   <tr class="layout">
1567     <td class="left"><tt>i1</tt></td>
1568     <td class="left">a single-bit integer.</td>
1569   </tr>
1570   <tr class="layout">
1571     <td class="left"><tt>i32</tt></td>
1572     <td class="left">a 32-bit integer.</td>
1573   </tr>
1574   <tr class="layout">
1575     <td class="left"><tt>i1942652</tt></td>
1576     <td class="left">a really big integer of over 1 million bits.</td>
1577   </tr>
1578 </table>
1579
1580 </div>
1581
1582 <!-- _______________________________________________________________________ -->
1583 <div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
1584
1585 <div class="doc_text">
1586
1587 <table>
1588   <tbody>
1589     <tr><th>Type</th><th>Description</th></tr>
1590     <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1591     <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1592     <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1593     <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1594     <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1595   </tbody>
1596 </table>
1597
1598 </div>
1599
1600 <!-- _______________________________________________________________________ -->
1601 <div class="doc_subsubsection"> <a name="t_x86mmx">X86mmx Type</a> </div>
1602
1603 <div class="doc_text">
1604
1605 <h5>Overview:</h5>
1606 <p>The x86mmx type represents a value held in an MMX register on an x86 machine.  The operations allowed on it are quite limited:  parameters and return values, load and store, and bitcast.  User-specified MMX instructions are represented as intrinsic or asm calls with arguments and/or results of this type.  There are no arrays, vectors or constants of this type.</p>
1607
1608 <h5>Syntax:</h5>
1609 <pre>
1610   x86mmx
1611 </pre>
1612
1613 </div>
1614
1615 <!-- _______________________________________________________________________ -->
1616 <div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
1617
1618 <div class="doc_text">
1619
1620 <h5>Overview:</h5>
1621 <p>The void type does not represent any value and has no size.</p>
1622
1623 <h5>Syntax:</h5>
1624 <pre>
1625   void
1626 </pre>
1627
1628 </div>
1629
1630 <!-- _______________________________________________________________________ -->
1631 <div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
1632
1633 <div class="doc_text">
1634
1635 <h5>Overview:</h5>
1636 <p>The label type represents code labels.</p>
1637
1638 <h5>Syntax:</h5>
1639 <pre>
1640   label
1641 </pre>
1642
1643 </div>
1644
1645 <!-- _______________________________________________________________________ -->
1646 <div class="doc_subsubsection"> <a name="t_metadata">Metadata Type</a> </div>
1647
1648 <div class="doc_text">
1649
1650 <h5>Overview:</h5>
1651 <p>The metadata type represents embedded metadata. No derived types may be
1652    created from metadata except for <a href="#t_function">function</a>
1653    arguments.
1654
1655 <h5>Syntax:</h5>
1656 <pre>
1657   metadata
1658 </pre>
1659
1660 </div>
1661
1662
1663 <!-- ======================================================================= -->
1664 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
1665
1666 <div class="doc_text">
1667
1668 <p>The real power in LLVM comes from the derived types in the system.  This is
1669    what allows a programmer to represent arrays, functions, pointers, and other
1670    useful types.  Each of these types contain one or more element types which
1671    may be a primitive type, or another derived type.  For example, it is
1672    possible to have a two dimensional array, using an array as the element type
1673    of another array.</p>
1674
1675
1676 </div>
1677
1678 <!-- _______________________________________________________________________ -->
1679 <div class="doc_subsubsection"> <a name="t_aggregate">Aggregate Types</a> </div>
1680
1681 <div class="doc_text">
1682
1683 <p>Aggregate Types are a subset of derived types that can contain multiple
1684   member types. <a href="#t_array">Arrays</a>,
1685   <a href="#t_struct">structs</a>, and <a href="#t_vector">vectors</a> are
1686   aggregate types.</p>
1687
1688 </div>
1689
1690 <!-- _______________________________________________________________________ -->
1691 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
1692
1693 <div class="doc_text">
1694
1695 <h5>Overview:</h5>
1696 <p>The array type is a very simple derived type that arranges elements
1697    sequentially in memory.  The array type requires a size (number of elements)
1698    and an underlying data type.</p>
1699
1700 <h5>Syntax:</h5>
1701 <pre>
1702   [&lt;# elements&gt; x &lt;elementtype&gt;]
1703 </pre>
1704
1705 <p>The number of elements is a constant integer value; <tt>elementtype</tt> may
1706    be any type with a size.</p>
1707
1708 <h5>Examples:</h5>
1709 <table class="layout">
1710   <tr class="layout">
1711     <td class="left"><tt>[40 x i32]</tt></td>
1712     <td class="left">Array of 40 32-bit integer values.</td>
1713   </tr>
1714   <tr class="layout">
1715     <td class="left"><tt>[41 x i32]</tt></td>
1716     <td class="left">Array of 41 32-bit integer values.</td>
1717   </tr>
1718   <tr class="layout">
1719     <td class="left"><tt>[4 x i8]</tt></td>
1720     <td class="left">Array of 4 8-bit integer values.</td>
1721   </tr>
1722 </table>
1723 <p>Here are some examples of multidimensional arrays:</p>
1724 <table class="layout">
1725   <tr class="layout">
1726     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1727     <td class="left">3x4 array of 32-bit integer values.</td>
1728   </tr>
1729   <tr class="layout">
1730     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1731     <td class="left">12x10 array of single precision floating point values.</td>
1732   </tr>
1733   <tr class="layout">
1734     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1735     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1736   </tr>
1737 </table>
1738
1739 <p>There is no restriction on indexing beyond the end of the array implied by
1740    a static type (though there are restrictions on indexing beyond the bounds
1741    of an allocated object in some cases). This means that single-dimension
1742    'variable sized array' addressing can be implemented in LLVM with a zero
1743    length array type. An implementation of 'pascal style arrays' in LLVM could
1744    use the type "<tt>{ i32, [0 x float]}</tt>", for example.</p>
1745
1746 </div>
1747
1748 <!-- _______________________________________________________________________ -->
1749 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
1750
1751 <div class="doc_text">
1752
1753 <h5>Overview:</h5>
1754 <p>The function type can be thought of as a function signature.  It consists of
1755    a return type and a list of formal parameter types. The return type of a
1756    function type is a first class type or a void type.</p>
1757
1758 <h5>Syntax:</h5>
1759 <pre>
1760   &lt;returntype&gt; (&lt;parameter list&gt;)
1761 </pre>
1762
1763 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1764    specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1765    which indicates that the function takes a variable number of arguments.
1766    Variable argument functions can access their arguments with
1767    the <a href="#int_varargs">variable argument handling intrinsic</a>
1768    functions.  '<tt>&lt;returntype&gt;</tt>' is any type except
1769    <a href="#t_label">label</a>.</p>
1770
1771 <h5>Examples:</h5>
1772 <table class="layout">
1773   <tr class="layout">
1774     <td class="left"><tt>i32 (i32)</tt></td>
1775     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1776     </td>
1777   </tr><tr class="layout">
1778     <td class="left"><tt>float&nbsp;(i16,&nbsp;i32&nbsp;*)&nbsp;*
1779     </tt></td>
1780     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1781       an <tt>i16</tt> and a <a href="#t_pointer">pointer</a> to <tt>i32</tt>,
1782       returning <tt>float</tt>.
1783     </td>
1784   </tr><tr class="layout">
1785     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1786     <td class="left">A vararg function that takes at least one
1787       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
1788       which returns an integer.  This is the signature for <tt>printf</tt> in
1789       LLVM.
1790     </td>
1791   </tr><tr class="layout">
1792     <td class="left"><tt>{i32, i32} (i32)</tt></td>
1793     <td class="left">A function taking an <tt>i32</tt>, returning a
1794         <a href="#t_struct">structure</a> containing two <tt>i32</tt> values
1795     </td>
1796   </tr>
1797 </table>
1798
1799 </div>
1800
1801 <!-- _______________________________________________________________________ -->
1802 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
1803
1804 <div class="doc_text">
1805
1806 <h5>Overview:</h5>
1807 <p>The structure type is used to represent a collection of data members together
1808    in memory.  The packing of the field types is defined to match the ABI of the
1809    underlying processor.  The elements of a structure may be any type that has a
1810    size.</p>
1811
1812 <p>Structures in memory are accessed using '<tt><a href="#i_load">load</a></tt>'
1813    and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field
1814    with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
1815    Structures in registers are accessed using the
1816    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' and
1817    '<tt><a href="#i_insertvalue">insertvalue</a></tt>' instructions.</p>
1818 <h5>Syntax:</h5>
1819 <pre>
1820   { &lt;type list&gt; }
1821 </pre>
1822
1823 <h5>Examples:</h5>
1824 <table class="layout">
1825   <tr class="layout">
1826     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
1827     <td class="left">A triple of three <tt>i32</tt> values</td>
1828   </tr><tr class="layout">
1829     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
1830     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1831       second element is a <a href="#t_pointer">pointer</a> to a
1832       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1833       an <tt>i32</tt>.</td>
1834   </tr>
1835 </table>
1836
1837 </div>
1838
1839 <!-- _______________________________________________________________________ -->
1840 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1841 </div>
1842
1843 <div class="doc_text">
1844
1845 <h5>Overview:</h5>
1846 <p>The packed structure type is used to represent a collection of data members
1847    together in memory.  There is no padding between fields.  Further, the
1848    alignment of a packed structure is 1 byte.  The elements of a packed
1849    structure may be any type that has a size.</p>
1850
1851 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt> and
1852    '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field with
1853    the '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
1854
1855 <h5>Syntax:</h5>
1856 <pre>
1857   &lt; { &lt;type list&gt; } &gt;
1858 </pre>
1859
1860 <h5>Examples:</h5>
1861 <table class="layout">
1862   <tr class="layout">
1863     <td class="left"><tt>&lt; { i32, i32, i32 } &gt;</tt></td>
1864     <td class="left">A triple of three <tt>i32</tt> values</td>
1865   </tr><tr class="layout">
1866   <td class="left">
1867 <tt>&lt;&nbsp;{&nbsp;float,&nbsp;i32&nbsp;(i32)*&nbsp;}&nbsp;&gt;</tt></td>
1868     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1869       second element is a <a href="#t_pointer">pointer</a> to a
1870       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1871       an <tt>i32</tt>.</td>
1872   </tr>
1873 </table>
1874
1875 </div>
1876
1877 <!-- _______________________________________________________________________ -->
1878 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1879
1880 <div class="doc_text">
1881
1882 <h5>Overview:</h5>
1883 <p>The pointer type is used to specify memory locations.
1884    Pointers are commonly used to reference objects in memory.</p>
1885
1886 <p>Pointer types may have an optional address space attribute defining the
1887    numbered address space where the pointed-to object resides. The default
1888    address space is number zero. The semantics of non-zero address
1889    spaces are target-specific.</p>
1890
1891 <p>Note that LLVM does not permit pointers to void (<tt>void*</tt>) nor does it
1892    permit pointers to labels (<tt>label*</tt>).  Use <tt>i8*</tt> instead.</p>
1893
1894 <h5>Syntax:</h5>
1895 <pre>
1896   &lt;type&gt; *
1897 </pre>
1898
1899 <h5>Examples:</h5>
1900 <table class="layout">
1901   <tr class="layout">
1902     <td class="left"><tt>[4 x i32]*</tt></td>
1903     <td class="left">A <a href="#t_pointer">pointer</a> to <a
1904                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
1905   </tr>
1906   <tr class="layout">
1907     <td class="left"><tt>i32 (i32*) *</tt></td>
1908     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
1909       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1910       <tt>i32</tt>.</td>
1911   </tr>
1912   <tr class="layout">
1913     <td class="left"><tt>i32 addrspace(5)*</tt></td>
1914     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
1915      that resides in address space #5.</td>
1916   </tr>
1917 </table>
1918
1919 </div>
1920
1921 <!-- _______________________________________________________________________ -->
1922 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1923
1924 <div class="doc_text">
1925
1926 <h5>Overview:</h5>
1927 <p>A vector type is a simple derived type that represents a vector of elements.
1928    Vector types are used when multiple primitive data are operated in parallel
1929    using a single instruction (SIMD).  A vector type requires a size (number of
1930    elements) and an underlying primitive data type.  Vector types are considered
1931    <a href="#t_firstclass">first class</a>.</p>
1932
1933 <h5>Syntax:</h5>
1934 <pre>
1935   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1936 </pre>
1937
1938 <p>The number of elements is a constant integer value larger than 0; elementtype
1939    may be any integer or floating point type.  Vectors of size zero are not
1940    allowed, and pointers are not allowed as the element type.</p>
1941
1942 <h5>Examples:</h5>
1943 <table class="layout">
1944   <tr class="layout">
1945     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
1946     <td class="left">Vector of 4 32-bit integer values.</td>
1947   </tr>
1948   <tr class="layout">
1949     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
1950     <td class="left">Vector of 8 32-bit floating-point values.</td>
1951   </tr>
1952   <tr class="layout">
1953     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
1954     <td class="left">Vector of 2 64-bit integer values.</td>
1955   </tr>
1956 </table>
1957
1958 </div>
1959
1960 <!-- _______________________________________________________________________ -->
1961 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1962 <div class="doc_text">
1963
1964 <h5>Overview:</h5>
1965 <p>Opaque types are used to represent unknown types in the system.  This
1966    corresponds (for example) to the C notion of a forward declared structure
1967    type.  In LLVM, opaque types can eventually be resolved to any type (not just
1968    a structure type).</p>
1969
1970 <h5>Syntax:</h5>
1971 <pre>
1972   opaque
1973 </pre>
1974
1975 <h5>Examples:</h5>
1976 <table class="layout">
1977   <tr class="layout">
1978     <td class="left"><tt>opaque</tt></td>
1979     <td class="left">An opaque type.</td>
1980   </tr>
1981 </table>
1982
1983 </div>
1984
1985 <!-- ======================================================================= -->
1986 <div class="doc_subsection">
1987   <a name="t_uprefs">Type Up-references</a>
1988 </div>
1989
1990 <div class="doc_text">
1991
1992 <h5>Overview:</h5>
1993 <p>An "up reference" allows you to refer to a lexically enclosing type without
1994    requiring it to have a name. For instance, a structure declaration may
1995    contain a pointer to any of the types it is lexically a member of.  Example
1996    of up references (with their equivalent as named type declarations)
1997    include:</p>
1998
1999 <pre>
2000    { \2 * }                %x = type { %x* }
2001    { \2 }*                 %y = type { %y }*
2002    \1*                     %z = type %z*
2003 </pre>
2004
2005 <p>An up reference is needed by the asmprinter for printing out cyclic types
2006    when there is no declared name for a type in the cycle.  Because the
2007    asmprinter does not want to print out an infinite type string, it needs a
2008    syntax to handle recursive types that have no names (all names are optional
2009    in llvm IR).</p>
2010
2011 <h5>Syntax:</h5>
2012 <pre>
2013    \&lt;level&gt;
2014 </pre>
2015
2016 <p>The level is the count of the lexical type that is being referred to.</p>
2017
2018 <h5>Examples:</h5>
2019 <table class="layout">
2020   <tr class="layout">
2021     <td class="left"><tt>\1*</tt></td>
2022     <td class="left">Self-referential pointer.</td>
2023   </tr>
2024   <tr class="layout">
2025     <td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
2026     <td class="left">Recursive structure where the upref refers to the out-most
2027                      structure.</td>
2028   </tr>
2029 </table>
2030
2031 </div>
2032
2033 <!-- *********************************************************************** -->
2034 <div class="doc_section"> <a name="constants">Constants</a> </div>
2035 <!-- *********************************************************************** -->
2036
2037 <div class="doc_text">
2038
2039 <p>LLVM has several different basic types of constants.  This section describes
2040    them all and their syntax.</p>
2041
2042 </div>
2043
2044 <!-- ======================================================================= -->
2045 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
2046
2047 <div class="doc_text">
2048
2049 <dl>
2050   <dt><b>Boolean constants</b></dt>
2051   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
2052       constants of the <tt><a href="#t_integer">i1</a></tt> type.</dd>
2053
2054   <dt><b>Integer constants</b></dt>
2055   <dd>Standard integers (such as '4') are constants of
2056       the <a href="#t_integer">integer</a> type.  Negative numbers may be used
2057       with integer types.</dd>
2058
2059   <dt><b>Floating point constants</b></dt>
2060   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
2061       exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
2062       notation (see below).  The assembler requires the exact decimal value of a
2063       floating-point constant.  For example, the assembler accepts 1.25 but
2064       rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
2065       constants must have a <a href="#t_floating">floating point</a> type. </dd>
2066
2067   <dt><b>Null pointer constants</b></dt>
2068   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
2069       and must be of <a href="#t_pointer">pointer type</a>.</dd>
2070 </dl>
2071
2072 <p>The one non-intuitive notation for constants is the hexadecimal form of
2073    floating point constants.  For example, the form '<tt>double
2074    0x432ff973cafa8000</tt>' is equivalent to (but harder to read than)
2075    '<tt>double 4.5e+15</tt>'.  The only time hexadecimal floating point
2076    constants are required (and the only time that they are generated by the
2077    disassembler) is when a floating point constant must be emitted but it cannot
2078    be represented as a decimal floating point number in a reasonable number of
2079    digits.  For example, NaN's, infinities, and other special values are
2080    represented in their IEEE hexadecimal format so that assembly and disassembly
2081    do not cause any bits to change in the constants.</p>
2082
2083 <p>When using the hexadecimal form, constants of types float and double are
2084    represented using the 16-digit form shown above (which matches the IEEE754
2085    representation for double); float values must, however, be exactly
2086    representable as IEE754 single precision.  Hexadecimal format is always used
2087    for long double, and there are three forms of long double.  The 80-bit format
2088    used by x86 is represented as <tt>0xK</tt> followed by 20 hexadecimal digits.
2089    The 128-bit format used by PowerPC (two adjacent doubles) is represented
2090    by <tt>0xM</tt> followed by 32 hexadecimal digits.  The IEEE 128-bit format
2091    is represented by <tt>0xL</tt> followed by 32 hexadecimal digits; no
2092    currently supported target uses this format.  Long doubles will only work if
2093    they match the long double format on your target.  All hexadecimal formats
2094    are big-endian (sign bit at the left).</p>
2095
2096 <p>There are no constants of type x86mmx.</p>
2097 </div>
2098
2099 <!-- ======================================================================= -->
2100 <div class="doc_subsection">
2101 <a name="aggregateconstants"></a> <!-- old anchor -->
2102 <a name="complexconstants">Complex Constants</a>
2103 </div>
2104
2105 <div class="doc_text">
2106
2107 <p>Complex constants are a (potentially recursive) combination of simple
2108    constants and smaller complex constants.</p>
2109
2110 <dl>
2111   <dt><b>Structure constants</b></dt>
2112   <dd>Structure constants are represented with notation similar to structure
2113       type definitions (a comma separated list of elements, surrounded by braces
2114       (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
2115       where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".
2116       Structure constants must have <a href="#t_struct">structure type</a>, and
2117       the number and types of elements must match those specified by the
2118       type.</dd>
2119
2120   <dt><b>Array constants</b></dt>
2121   <dd>Array constants are represented with notation similar to array type
2122      definitions (a comma separated list of elements, surrounded by square
2123      brackets (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74
2124      ]</tt>".  Array constants must have <a href="#t_array">array type</a>, and
2125      the number and types of elements must match those specified by the
2126      type.</dd>
2127
2128   <dt><b>Vector constants</b></dt>
2129   <dd>Vector constants are represented with notation similar to vector type
2130       definitions (a comma separated list of elements, surrounded by
2131       less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32
2132       42, i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must
2133       have <a href="#t_vector">vector type</a>, and the number and types of
2134       elements must match those specified by the type.</dd>
2135
2136   <dt><b>Zero initialization</b></dt>
2137   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
2138       value to zero of <em>any</em> type, including scalar and
2139       <a href="#t_aggregate">aggregate</a> types.
2140       This is often used to avoid having to print large zero initializers
2141       (e.g. for large arrays) and is always exactly equivalent to using explicit
2142       zero initializers.</dd>
2143
2144   <dt><b>Metadata node</b></dt>
2145   <dd>A metadata node is a structure-like constant with
2146       <a href="#t_metadata">metadata type</a>.  For example: "<tt>metadata !{
2147       i32 0, metadata !"test" }</tt>".  Unlike other constants that are meant to
2148       be interpreted as part of the instruction stream, metadata is a place to
2149       attach additional information such as debug info.</dd>
2150 </dl>
2151
2152 </div>
2153
2154 <!-- ======================================================================= -->
2155 <div class="doc_subsection">
2156   <a name="globalconstants">Global Variable and Function Addresses</a>
2157 </div>
2158
2159 <div class="doc_text">
2160
2161 <p>The addresses of <a href="#globalvars">global variables</a>
2162    and <a href="#functionstructure">functions</a> are always implicitly valid
2163    (link-time) constants.  These constants are explicitly referenced when
2164    the <a href="#identifiers">identifier for the global</a> is used and always
2165    have <a href="#t_pointer">pointer</a> type. For example, the following is a
2166    legal LLVM file:</p>
2167
2168 <pre class="doc_code">
2169 @X = global i32 17
2170 @Y = global i32 42
2171 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
2172 </pre>
2173
2174 </div>
2175
2176 <!-- ======================================================================= -->
2177 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
2178 <div class="doc_text">
2179
2180 <p>The string '<tt>undef</tt>' can be used anywhere a constant is expected, and
2181    indicates that the user of the value may receive an unspecified bit-pattern.
2182    Undefined values may be of any type (other than '<tt>label</tt>'
2183    or '<tt>void</tt>') and be used anywhere a constant is permitted.</p>
2184
2185 <p>Undefined values are useful because they indicate to the compiler that the
2186    program is well defined no matter what value is used.  This gives the
2187    compiler more freedom to optimize.  Here are some examples of (potentially
2188    surprising) transformations that are valid (in pseudo IR):</p>
2189
2190
2191 <pre class="doc_code">
2192   %A = add %X, undef
2193   %B = sub %X, undef
2194   %C = xor %X, undef
2195 Safe:
2196   %A = undef
2197   %B = undef
2198   %C = undef
2199 </pre>
2200
2201 <p>This is safe because all of the output bits are affected by the undef bits.
2202    Any output bit can have a zero or one depending on the input bits.</p>
2203
2204 <pre class="doc_code">
2205   %A = or %X, undef
2206   %B = and %X, undef
2207 Safe:
2208   %A = -1
2209   %B = 0
2210 Unsafe:
2211   %A = undef
2212   %B = undef
2213 </pre>
2214
2215 <p>These logical operations have bits that are not always affected by the input.
2216    For example, if <tt>%X</tt> has a zero bit, then the output of the
2217    '<tt>and</tt>' operation will always be a zero for that bit, no matter what
2218    the corresponding bit from the '<tt>undef</tt>' is. As such, it is unsafe to
2219    optimize or assume that the result of the '<tt>and</tt>' is '<tt>undef</tt>'.
2220    However, it is safe to assume that all bits of the '<tt>undef</tt>' could be
2221    0, and optimize the '<tt>and</tt>' to 0. Likewise, it is safe to assume that
2222    all the bits of the '<tt>undef</tt>' operand to the '<tt>or</tt>' could be
2223    set, allowing the '<tt>or</tt>' to be folded to -1.</p>
2224
2225 <pre class="doc_code">
2226   %A = select undef, %X, %Y
2227   %B = select undef, 42, %Y
2228   %C = select %X, %Y, undef
2229 Safe:
2230   %A = %X     (or %Y)
2231   %B = 42     (or %Y)
2232   %C = %Y
2233 Unsafe:
2234   %A = undef
2235   %B = undef
2236   %C = undef
2237 </pre>
2238
2239 <p>This set of examples shows that undefined '<tt>select</tt>' (and conditional
2240    branch) conditions can go <em>either way</em>, but they have to come from one
2241    of the two operands.  In the <tt>%A</tt> example, if <tt>%X</tt> and
2242    <tt>%Y</tt> were both known to have a clear low bit, then <tt>%A</tt> would
2243    have to have a cleared low bit. However, in the <tt>%C</tt> example, the
2244    optimizer is allowed to assume that the '<tt>undef</tt>' operand could be the
2245    same as <tt>%Y</tt>, allowing the whole '<tt>select</tt>' to be
2246    eliminated.</p>
2247
2248 <pre class="doc_code">
2249   %A = xor undef, undef
2250
2251   %B = undef
2252   %C = xor %B, %B
2253
2254   %D = undef
2255   %E = icmp lt %D, 4
2256   %F = icmp gte %D, 4
2257
2258 Safe:
2259   %A = undef
2260   %B = undef
2261   %C = undef
2262   %D = undef
2263   %E = undef
2264   %F = undef
2265 </pre>
2266
2267 <p>This example points out that two '<tt>undef</tt>' operands are not
2268    necessarily the same. This can be surprising to people (and also matches C
2269    semantics) where they assume that "<tt>X^X</tt>" is always zero, even
2270    if <tt>X</tt> is undefined. This isn't true for a number of reasons, but the
2271    short answer is that an '<tt>undef</tt>' "variable" can arbitrarily change
2272    its value over its "live range".  This is true because the variable doesn't
2273    actually <em>have a live range</em>. Instead, the value is logically read
2274    from arbitrary registers that happen to be around when needed, so the value
2275    is not necessarily consistent over time. In fact, <tt>%A</tt> and <tt>%C</tt>
2276    need to have the same semantics or the core LLVM "replace all uses with"
2277    concept would not hold.</p>
2278
2279 <pre class="doc_code">
2280   %A = fdiv undef, %X
2281   %B = fdiv %X, undef
2282 Safe:
2283   %A = undef
2284 b: unreachable
2285 </pre>
2286
2287 <p>These examples show the crucial difference between an <em>undefined
2288   value</em> and <em>undefined behavior</em>. An undefined value (like
2289   '<tt>undef</tt>') is allowed to have an arbitrary bit-pattern. This means that
2290   the <tt>%A</tt> operation can be constant folded to '<tt>undef</tt>', because
2291   the '<tt>undef</tt>' could be an SNaN, and <tt>fdiv</tt> is not (currently)
2292   defined on SNaN's. However, in the second example, we can make a more
2293   aggressive assumption: because the <tt>undef</tt> is allowed to be an
2294   arbitrary value, we are allowed to assume that it could be zero. Since a
2295   divide by zero has <em>undefined behavior</em>, we are allowed to assume that
2296   the operation does not execute at all. This allows us to delete the divide and
2297   all code after it. Because the undefined operation "can't happen", the
2298   optimizer can assume that it occurs in dead code.</p>
2299
2300 <pre class="doc_code">
2301 a:  store undef -> %X
2302 b:  store %X -> undef
2303 Safe:
2304 a: &lt;deleted&gt;
2305 b: unreachable
2306 </pre>
2307
2308 <p>These examples reiterate the <tt>fdiv</tt> example: a store <em>of</em> an
2309    undefined value can be assumed to not have any effect; we can assume that the
2310    value is overwritten with bits that happen to match what was already there.
2311    However, a store <em>to</em> an undefined location could clobber arbitrary
2312    memory, therefore, it has undefined behavior.</p>
2313
2314 </div>
2315
2316 <!-- ======================================================================= -->
2317 <div class="doc_subsection"><a name="trapvalues">Trap Values</a></div>
2318 <div class="doc_text">
2319
2320 <p>Trap values are similar to <a href="#undefvalues">undef values</a>, however
2321    instead of representing an unspecified bit pattern, they represent the
2322    fact that an instruction or constant expression which cannot evoke side
2323    effects has nevertheless detected a condition which results in undefined
2324    behavior.</p>
2325
2326 <p>There is currently no way of representing a trap value in the IR; they
2327    only exist when produced by operations such as
2328    <a href="#i_add"><tt>add</tt></a> with the <tt>nsw</tt> flag.</p>
2329
2330 <p>Trap value behavior is defined in terms of value <i>dependence</i>:</p>
2331
2332 <ul>
2333 <li>Values other than <a href="#i_phi"><tt>phi</tt></a> nodes depend on
2334     their operands.</li>
2335
2336 <li><a href="#i_phi"><tt>Phi</tt></a> nodes depend on the operand corresponding
2337     to their dynamic predecessor basic block.</li>
2338
2339 <li>Function arguments depend on the corresponding actual argument values in
2340     the dynamic callers of their functions.</li>
2341
2342 <li><a href="#i_call"><tt>Call</tt></a> instructions depend on the
2343     <a href="#i_ret"><tt>ret</tt></a> instructions that dynamically transfer
2344     control back to them.</li>
2345
2346 <li><a href="#i_invoke"><tt>Invoke</tt></a> instructions depend on the
2347     <a href="#i_ret"><tt>ret</tt></a>, <a href="#i_unwind"><tt>unwind</tt></a>,
2348     or exception-throwing call instructions that dynamically transfer control
2349     back to them.</li>
2350
2351 <li>Non-volatile loads and stores depend on the most recent stores to all of the
2352     referenced memory addresses, following the order in the IR
2353     (including loads and stores implied by intrinsics such as
2354     <a href="#int_memcpy"><tt>@llvm.memcpy</tt></a>.)</li>
2355
2356 <!-- TODO: In the case of multiple threads, this only applies if the store
2357      "happens-before" the load or store. -->
2358
2359 <!-- TODO: floating-point exception state -->
2360
2361 <li>An instruction with externally visible side effects depends on the most
2362     recent preceding instruction with externally visible side effects, following
2363     the order in the IR. (This includes
2364     <a href="#volatile">volatile operations</a>.)</li>
2365
2366 <li>An instruction <i>control-depends</i> on a
2367     <a href="#terminators">terminator instruction</a>
2368     if the terminator instruction has multiple successors and the instruction
2369     is always executed when control transfers to one of the successors, and
2370     may not be executed when control is transfered to another.</li>
2371
2372 <li>Dependence is transitive.</li>
2373
2374 </ul>
2375
2376 <p>Whenever a trap value is generated, all values which depend on it evaluate
2377    to trap. If they have side effects, the evoke their side effects as if each
2378    operand with a trap value were undef. If they have externally-visible side
2379    effects, the behavior is undefined.</p>
2380
2381 <p>Here are some examples:</p>
2382
2383 <pre class="doc_code">
2384 entry:
2385   %trap = sub nuw i32 0, 1           ; Results in a trap value.
2386   %still_trap = and i32 %trap, 0     ; Whereas (and i32 undef, 0) would return 0.
2387   %trap_yet_again = getelementptr i32* @h, i32 %still_trap
2388   store i32 0, i32* %trap_yet_again  ; undefined behavior
2389
2390   store i32 %trap, i32* @g           ; Trap value conceptually stored to memory.
2391   %trap2 = load i32* @g              ; Returns a trap value, not just undef.
2392
2393   volatile store i32 %trap, i32* @g  ; External observation; undefined behavior.
2394
2395   %narrowaddr = bitcast i32* @g to i16*
2396   %wideaddr = bitcast i32* @g to i64*
2397   %trap3 = load 16* %narrowaddr      ; Returns a trap value.
2398   %trap4 = load i64* %widaddr        ; Returns a trap value.
2399
2400   %cmp = icmp i32 slt %trap, 0       ; Returns a trap value.
2401   %br i1 %cmp, %true, %end           ; Branch to either destination.
2402
2403 true:
2404   volatile store i32 0, i32* @g      ; This is control-dependent on %cmp, so
2405                                      ; it has undefined behavior.
2406   br label %end
2407
2408 end:
2409   %p = phi i32 [ 0, %entry ], [ 1, %true ]
2410                                      ; Both edges into this PHI are
2411                                      ; control-dependent on %cmp, so this
2412                                      ; always results in a trap value.
2413
2414   volatile store i32 0, i32* @g      ; %end is control-equivalent to %entry
2415                                      ; so this is defined (ignoring earlier
2416                                      ; undefined behavior in this example).
2417 </pre>
2418
2419 </div>
2420
2421 <!-- ======================================================================= -->
2422 <div class="doc_subsection"><a name="blockaddress">Addresses of Basic
2423     Blocks</a></div>
2424 <div class="doc_text">
2425
2426 <p><b><tt>blockaddress(@function, %block)</tt></b></p>
2427
2428 <p>The '<tt>blockaddress</tt>' constant computes the address of the specified
2429    basic block in the specified function, and always has an i8* type.  Taking
2430    the address of the entry block is illegal.</p>
2431
2432 <p>This value only has defined behavior when used as an operand to the
2433    '<a href="#i_indirectbr"><tt>indirectbr</tt></a>' instruction, or for
2434    comparisons against null. Pointer equality tests between labels addresses
2435    results in undefined behavior &mdash; though, again, comparison against null
2436    is ok, and no label is equal to the null pointer. This may be passed around
2437    as an opaque pointer sized value as long as the bits are not inspected. This
2438    allows <tt>ptrtoint</tt> and arithmetic to be performed on these values so
2439    long as the original value is reconstituted before the <tt>indirectbr</tt>
2440    instruction.</p>
2441
2442 <p>Finally, some targets may provide defined semantics when using the value as
2443    the operand to an inline assembly, but that is target specific.</p>
2444
2445 </div>
2446
2447
2448 <!-- ======================================================================= -->
2449 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
2450 </div>
2451
2452 <div class="doc_text">
2453
2454 <p>Constant expressions are used to allow expressions involving other constants
2455    to be used as constants.  Constant expressions may be of
2456    any <a href="#t_firstclass">first class</a> type and may involve any LLVM
2457    operation that does not have side effects (e.g. load and call are not
2458    supported). The following is the syntax for constant expressions:</p>
2459
2460 <dl>
2461   <dt><b><tt>trunc (CST to TYPE)</tt></b></dt>
2462   <dd>Truncate a constant to another type. The bit size of CST must be larger
2463       than the bit size of TYPE. Both types must be integers.</dd>
2464
2465   <dt><b><tt>zext (CST to TYPE)</tt></b></dt>
2466   <dd>Zero extend a constant to another type. The bit size of CST must be
2467       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2468
2469   <dt><b><tt>sext (CST to TYPE)</tt></b></dt>
2470   <dd>Sign extend a constant to another type. The bit size of CST must be
2471       smaller than the bit size of TYPE.  Both types must be integers.</dd>
2472
2473   <dt><b><tt>fptrunc (CST to TYPE)</tt></b></dt>
2474   <dd>Truncate a floating point constant to another floating point type. The
2475       size of CST must be larger than the size of TYPE. Both types must be
2476       floating point.</dd>
2477
2478   <dt><b><tt>fpext (CST to TYPE)</tt></b></dt>
2479   <dd>Floating point extend a constant to another type. The size of CST must be
2480       smaller or equal to the size of TYPE. Both types must be floating
2481       point.</dd>
2482
2483   <dt><b><tt>fptoui (CST to TYPE)</tt></b></dt>
2484   <dd>Convert a floating point constant to the corresponding unsigned integer
2485       constant. TYPE must be a scalar or vector integer type. CST must be of
2486       scalar or vector floating point type. Both CST and TYPE must be scalars,
2487       or vectors of the same number of elements. If the value won't fit in the
2488       integer type, the results are undefined.</dd>
2489
2490   <dt><b><tt>fptosi (CST to TYPE)</tt></b></dt>
2491   <dd>Convert a floating point constant to the corresponding signed integer
2492       constant.  TYPE must be a scalar or vector integer type. CST must be of
2493       scalar or vector floating point type. Both CST and TYPE must be scalars,
2494       or vectors of the same number of elements. If the value won't fit in the
2495       integer type, the results are undefined.</dd>
2496
2497   <dt><b><tt>uitofp (CST to TYPE)</tt></b></dt>
2498   <dd>Convert an unsigned integer constant to the corresponding floating point
2499       constant. TYPE must be a scalar or vector floating point type. CST must be
2500       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2501       vectors of the same number of elements. If the value won't fit in the
2502       floating point type, the results are undefined.</dd>
2503
2504   <dt><b><tt>sitofp (CST to TYPE)</tt></b></dt>
2505   <dd>Convert a signed integer constant to the corresponding floating point
2506       constant. TYPE must be a scalar or vector floating point type. CST must be
2507       of scalar or vector integer type. Both CST and TYPE must be scalars, or
2508       vectors of the same number of elements. If the value won't fit in the
2509       floating point type, the results are undefined.</dd>
2510
2511   <dt><b><tt>ptrtoint (CST to TYPE)</tt></b></dt>
2512   <dd>Convert a pointer typed constant to the corresponding integer constant
2513       <tt>TYPE</tt> must be an integer type. <tt>CST</tt> must be of pointer
2514       type. The <tt>CST</tt> value is zero extended, truncated, or unchanged to
2515       make it fit in <tt>TYPE</tt>.</dd>
2516
2517   <dt><b><tt>inttoptr (CST to TYPE)</tt></b></dt>
2518   <dd>Convert a integer constant to a pointer constant.  TYPE must be a pointer
2519       type.  CST must be of integer type. The CST value is zero extended,
2520       truncated, or unchanged to make it fit in a pointer size. This one is
2521       <i>really</i> dangerous!</dd>
2522
2523   <dt><b><tt>bitcast (CST to TYPE)</tt></b></dt>
2524   <dd>Convert a constant, CST, to another TYPE. The constraints of the operands
2525       are the same as those for the <a href="#i_bitcast">bitcast
2526       instruction</a>.</dd>
2527
2528   <dt><b><tt>getelementptr (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2529   <dt><b><tt>getelementptr inbounds (CSTPTR, IDX0, IDX1, ...)</tt></b></dt>
2530   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
2531       constants.  As with the <a href="#i_getelementptr">getelementptr</a>
2532       instruction, the index list may have zero or more indexes, which are
2533       required to make sense for the type of "CSTPTR".</dd>
2534
2535   <dt><b><tt>select (COND, VAL1, VAL2)</tt></b></dt>
2536   <dd>Perform the <a href="#i_select">select operation</a> on constants.</dd>
2537
2538   <dt><b><tt>icmp COND (VAL1, VAL2)</tt></b></dt>
2539   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
2540
2541   <dt><b><tt>fcmp COND (VAL1, VAL2)</tt></b></dt>
2542   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
2543
2544   <dt><b><tt>extractelement (VAL, IDX)</tt></b></dt>
2545   <dd>Perform the <a href="#i_extractelement">extractelement operation</a> on
2546       constants.</dd>
2547
2548   <dt><b><tt>insertelement (VAL, ELT, IDX)</tt></b></dt>
2549   <dd>Perform the <a href="#i_insertelement">insertelement operation</a> on
2550     constants.</dd>
2551
2552   <dt><b><tt>shufflevector (VEC1, VEC2, IDXMASK)</tt></b></dt>
2553   <dd>Perform the <a href="#i_shufflevector">shufflevector operation</a> on
2554       constants.</dd>
2555
2556   <dt><b><tt>extractvalue (VAL, IDX0, IDX1, ...)</tt></b></dt>
2557   <dd>Perform the <a href="#i_extractvalue">extractvalue operation</a> on
2558     constants. The index list is interpreted in a similar manner as indices in
2559     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2560     index value must be specified.</dd>
2561
2562   <dt><b><tt>insertvalue (VAL, ELT, IDX0, IDX1, ...)</tt></b></dt>
2563   <dd>Perform the <a href="#i_insertvalue">insertvalue operation</a> on
2564     constants. The index list is interpreted in a similar manner as indices in
2565     a '<a href="#i_getelementptr">getelementptr</a>' operation. At least one
2566     index value must be specified.</dd>
2567
2568   <dt><b><tt>OPCODE (LHS, RHS)</tt></b></dt>
2569   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
2570       be any of the <a href="#binaryops">binary</a>
2571       or <a href="#bitwiseops">bitwise binary</a> operations.  The constraints
2572       on operands are the same as those for the corresponding instruction
2573       (e.g. no bitwise operations on floating point values are allowed).</dd>
2574 </dl>
2575
2576 </div>
2577
2578 <!-- *********************************************************************** -->
2579 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
2580 <!-- *********************************************************************** -->
2581
2582 <!-- ======================================================================= -->
2583 <div class="doc_subsection">
2584 <a name="inlineasm">Inline Assembler Expressions</a>
2585 </div>
2586
2587 <div class="doc_text">
2588
2589 <p>LLVM supports inline assembler expressions (as opposed
2590    to <a href="#moduleasm"> Module-Level Inline Assembly</a>) through the use of
2591    a special value.  This value represents the inline assembler as a string
2592    (containing the instructions to emit), a list of operand constraints (stored
2593    as a string), a flag that indicates whether or not the inline asm
2594    expression has side effects, and a flag indicating whether the function
2595    containing the asm needs to align its stack conservatively.  An example
2596    inline assembler expression is:</p>
2597
2598 <pre class="doc_code">
2599 i32 (i32) asm "bswap $0", "=r,r"
2600 </pre>
2601
2602 <p>Inline assembler expressions may <b>only</b> be used as the callee operand of
2603    a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we
2604    have:</p>
2605
2606 <pre class="doc_code">
2607 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2608 </pre>
2609
2610 <p>Inline asms with side effects not visible in the constraint list must be
2611    marked as having side effects.  This is done through the use of the
2612    '<tt>sideeffect</tt>' keyword, like so:</p>
2613
2614 <pre class="doc_code">
2615 call void asm sideeffect "eieio", ""()
2616 </pre>
2617
2618 <p>In some cases inline asms will contain code that will not work unless the
2619    stack is aligned in some way, such as calls or SSE instructions on x86,
2620    yet will not contain code that does that alignment within the asm.
2621    The compiler should make conservative assumptions about what the asm might
2622    contain and should generate its usual stack alignment code in the prologue
2623    if the '<tt>alignstack</tt>' keyword is present:</p>
2624
2625 <pre class="doc_code">
2626 call void asm alignstack "eieio", ""()
2627 </pre>
2628
2629 <p>If both keywords appear the '<tt>sideeffect</tt>' keyword must come
2630    first.</p>
2631
2632 <p>TODO: The format of the asm and constraints string still need to be
2633    documented here.  Constraints on what can be done (e.g. duplication, moving,
2634    etc need to be documented).  This is probably best done by reference to
2635    another document that covers inline asm from a holistic perspective.</p>
2636 </div>
2637
2638 <div class="doc_subsubsection">
2639 <a name="inlineasm_md">Inline Asm Metadata</a>
2640 </div>
2641
2642 <div class="doc_text">
2643
2644 <p>The call instructions that wrap inline asm nodes may have a "!srcloc" MDNode
2645    attached to it that contains a list of constant integers.  If present, the
2646   code generator will use the integer as the location cookie value when report
2647    errors through the LLVMContext error reporting mechanisms.  This allows a
2648    front-end to correlate backend errors that occur with inline asm back to the
2649    source code that produced it.  For example:</p>
2650
2651 <pre class="doc_code">
2652 call void asm sideeffect "something bad", ""()<b>, !srcloc !42</b>
2653 ...
2654 !42 = !{ i32 1234567 }
2655 </pre>
2656
2657 <p>It is up to the front-end to make sense of the magic numbers it places in the
2658    IR.  If the MDNode contains multiple constants, the code generator will use
2659    the one that corresponds to the line of the asm that the error occurs on.</p>
2660
2661 </div>
2662
2663 <!-- ======================================================================= -->
2664 <div class="doc_subsection"><a name="metadata">Metadata Nodes and Metadata
2665   Strings</a>
2666 </div>
2667
2668 <div class="doc_text">
2669
2670 <p>LLVM IR allows metadata to be attached to instructions in the program that
2671    can convey extra information about the code to the optimizers and code
2672    generator.  One example application of metadata is source-level debug
2673    information.  There are two metadata primitives: strings and nodes. All
2674    metadata has the <tt>metadata</tt> type and is identified in syntax by a
2675    preceding exclamation point ('<tt>!</tt>').</p>
2676
2677 <p>A metadata string is a string surrounded by double quotes.  It can contain
2678    any character by escaping non-printable characters with "\xx" where "xx" is
2679    the two digit hex code.  For example: "<tt>!"test\00"</tt>".</p>
2680
2681 <p>Metadata nodes are represented with notation similar to structure constants
2682    (a comma separated list of elements, surrounded by braces and preceded by an
2683    exclamation point).  For example: "<tt>!{ metadata !"test\00", i32
2684    10}</tt>".  Metadata nodes can have any values as their operand.</p>
2685
2686 <p>A <a href="#namedmetadatastructure">named metadata</a> is a collection of
2687    metadata nodes, which can be looked up in the module symbol table. For
2688    example: "<tt>!foo =  metadata !{!4, !3}</tt>".
2689
2690 <p>Metadata can be used as function arguments. Here <tt>llvm.dbg.value</tt>
2691    function is using two metadata arguments.</p>
2692
2693      <pre class="doc_code">
2694        call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
2695      </pre>
2696
2697 <p>Metadata can be attached with an instruction. Here metadata <tt>!21</tt> is
2698    attached with <tt>add</tt> instruction using <tt>!dbg</tt> identifier.</p>
2699
2700     <pre class="doc_code">
2701       %indvar.next = add i64 %indvar, 1, !dbg !21
2702     </pre>
2703 </div>
2704
2705
2706 <!-- *********************************************************************** -->
2707 <div class="doc_section">
2708   <a name="intrinsic_globals">Intrinsic Global Variables</a>
2709 </div>
2710 <!-- *********************************************************************** -->
2711
2712 <p>LLVM has a number of "magic" global variables that contain data that affect
2713 code generation or other IR semantics.  These are documented here.  All globals
2714 of this sort should have a section specified as "<tt>llvm.metadata</tt>".  This
2715 section and all globals that start with "<tt>llvm.</tt>" are reserved for use
2716 by LLVM.</p>
2717
2718 <!-- ======================================================================= -->
2719 <div class="doc_subsection">
2720 <a name="intg_used">The '<tt>llvm.used</tt>' Global Variable</a>
2721 </div>
2722
2723 <div class="doc_text">
2724
2725 <p>The <tt>@llvm.used</tt> global is an array with i8* element type which has <a
2726 href="#linkage_appending">appending linkage</a>.  This array contains a list of
2727 pointers to global variables and functions which may optionally have a pointer
2728 cast formed of bitcast or getelementptr.  For example, a legal use of it is:</p>
2729
2730 <pre>
2731   @X = global i8 4
2732   @Y = global i32 123
2733
2734   @llvm.used = appending global [2 x i8*] [
2735      i8* @X,
2736      i8* bitcast (i32* @Y to i8*)
2737   ], section "llvm.metadata"
2738 </pre>
2739
2740 <p>If a global variable appears in the <tt>@llvm.used</tt> list, then the
2741 compiler, assembler, and linker are required to treat the symbol as if there is
2742 a reference to the global that it cannot see.  For example, if a variable has
2743 internal linkage and no references other than that from the <tt>@llvm.used</tt>
2744 list, it cannot be deleted.  This is commonly used to represent references from
2745 inline asms and other things the compiler cannot "see", and corresponds to
2746 "attribute((used))" in GNU C.</p>
2747
2748 <p>On some targets, the code generator must emit a directive to the assembler or
2749 object file to prevent the assembler and linker from molesting the symbol.</p>
2750
2751 </div>
2752
2753 <!-- ======================================================================= -->
2754 <div class="doc_subsection">
2755 <a name="intg_compiler_used">The '<tt>llvm.compiler.used</tt>' Global Variable</a>
2756 </div>
2757
2758 <div class="doc_text">
2759
2760 <p>The <tt>@llvm.compiler.used</tt> directive is the same as the
2761 <tt>@llvm.used</tt> directive, except that it only prevents the compiler from
2762 touching the symbol.  On targets that support it, this allows an intelligent
2763 linker to optimize references to the symbol without being impeded as it would be
2764 by <tt>@llvm.used</tt>.</p>
2765
2766 <p>This is a rare construct that should only be used in rare circumstances, and
2767 should not be exposed to source languages.</p>
2768
2769 </div>
2770
2771 <!-- ======================================================================= -->
2772 <div class="doc_subsection">
2773 <a name="intg_global_ctors">The '<tt>llvm.global_ctors</tt>' Global Variable</a>
2774 </div>
2775
2776 <div class="doc_text">
2777 <pre>
2778 %0 = type { i32, void ()* }
2779 @llvm.global_ctors = appending global [1 x %0] [%0 { i32 65535, void ()* @ctor }]
2780 </pre>
2781 <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.
2782 </p>
2783
2784 </div>
2785
2786 <!-- ======================================================================= -->
2787 <div class="doc_subsection">
2788 <a name="intg_global_dtors">The '<tt>llvm.global_dtors</tt>' Global Variable</a>
2789 </div>
2790
2791 <div class="doc_text">
2792 <pre>
2793 %0 = type { i32, void ()* }
2794 @llvm.global_dtors = appending global [1 x %0] [%0 { i32 65535, void ()* @dtor }]
2795 </pre>
2796
2797 <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.
2798 </p>
2799
2800 </div>
2801
2802
2803 <!-- *********************************************************************** -->
2804 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
2805 <!-- *********************************************************************** -->
2806
2807 <div class="doc_text">
2808
2809 <p>The LLVM instruction set consists of several different classifications of
2810    instructions: <a href="#terminators">terminator
2811    instructions</a>, <a href="#binaryops">binary instructions</a>,
2812    <a href="#bitwiseops">bitwise binary instructions</a>,
2813    <a href="#memoryops">memory instructions</a>, and
2814    <a href="#otherops">other instructions</a>.</p>
2815
2816 </div>
2817
2818 <!-- ======================================================================= -->
2819 <div class="doc_subsection"> <a name="terminators">Terminator
2820 Instructions</a> </div>
2821
2822 <div class="doc_text">
2823
2824 <p>As mentioned <a href="#functionstructure">previously</a>, every basic block
2825    in a program ends with a "Terminator" instruction, which indicates which
2826    block should be executed after the current block is finished. These
2827    terminator instructions typically yield a '<tt>void</tt>' value: they produce
2828    control flow, not values (the one exception being the
2829    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
2830
2831 <p>There are seven different terminator instructions: the
2832    '<a href="#i_ret"><tt>ret</tt></a>' instruction, the
2833    '<a href="#i_br"><tt>br</tt></a>' instruction, the
2834    '<a href="#i_switch"><tt>switch</tt></a>' instruction, the
2835    '<a href="#i_indirectbr">'<tt>indirectbr</tt></a>' Instruction, the
2836    '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the
2837    '<a href="#i_unwind"><tt>unwind</tt></a>' instruction, and the
2838    '<a href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
2839
2840 </div>
2841
2842 <!-- _______________________________________________________________________ -->
2843 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
2844 Instruction</a> </div>
2845
2846 <div class="doc_text">
2847
2848 <h5>Syntax:</h5>
2849 <pre>
2850   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
2851   ret void                 <i>; Return from void function</i>
2852 </pre>
2853
2854 <h5>Overview:</h5>
2855 <p>The '<tt>ret</tt>' instruction is used to return control flow (and optionally
2856    a value) from a function back to the caller.</p>
2857
2858 <p>There are two forms of the '<tt>ret</tt>' instruction: one that returns a
2859    value and then causes control flow, and one that just causes control flow to
2860    occur.</p>
2861
2862 <h5>Arguments:</h5>
2863 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument, the
2864    return value. The type of the return value must be a
2865    '<a href="#t_firstclass">first class</a>' type.</p>
2866
2867 <p>A function is not <a href="#wellformed">well formed</a> if it it has a
2868    non-void return type and contains a '<tt>ret</tt>' instruction with no return
2869    value or a return value with a type that does not match its type, or if it
2870    has a void return type and contains a '<tt>ret</tt>' instruction with a
2871    return value.</p>
2872
2873 <h5>Semantics:</h5>
2874 <p>When the '<tt>ret</tt>' instruction is executed, control flow returns back to
2875    the calling function's context.  If the caller is a
2876    "<a href="#i_call"><tt>call</tt></a>" instruction, execution continues at the
2877    instruction after the call.  If the caller was an
2878    "<a href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues at
2879    the beginning of the "normal" destination block.  If the instruction returns
2880    a value, that value shall set the call or invoke instruction's return
2881    value.</p>
2882
2883 <h5>Example:</h5>
2884 <pre>
2885   ret i32 5                       <i>; Return an integer value of 5</i>
2886   ret void                        <i>; Return from a void function</i>
2887   ret { i32, i8 } { i32 4, i8 2 } <i>; Return a struct of values 4 and 2</i>
2888 </pre>
2889
2890 </div>
2891 <!-- _______________________________________________________________________ -->
2892 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
2893
2894 <div class="doc_text">
2895
2896 <h5>Syntax:</h5>
2897 <pre>
2898   br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
2899 </pre>
2900
2901 <h5>Overview:</h5>
2902 <p>The '<tt>br</tt>' instruction is used to cause control flow to transfer to a
2903    different basic block in the current function.  There are two forms of this
2904    instruction, corresponding to a conditional branch and an unconditional
2905    branch.</p>
2906
2907 <h5>Arguments:</h5>
2908 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a single
2909    '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The unconditional form
2910    of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a
2911    target.</p>
2912
2913 <h5>Semantics:</h5>
2914 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
2915    argument is evaluated.  If the value is <tt>true</tt>, control flows to the
2916    '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
2917    control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
2918
2919 <h5>Example:</h5>
2920 <pre>
2921 Test:
2922   %cond = <a href="#i_icmp">icmp</a> eq i32 %a, %b
2923   br i1 %cond, label %IfEqual, label %IfUnequal
2924 IfEqual:
2925   <a href="#i_ret">ret</a> i32 1
2926 IfUnequal:
2927   <a href="#i_ret">ret</a> i32 0
2928 </pre>
2929
2930 </div>
2931
2932 <!-- _______________________________________________________________________ -->
2933 <div class="doc_subsubsection">
2934    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
2935 </div>
2936
2937 <div class="doc_text">
2938
2939 <h5>Syntax:</h5>
2940 <pre>
2941   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
2942 </pre>
2943
2944 <h5>Overview:</h5>
2945 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
2946    several different places.  It is a generalization of the '<tt>br</tt>'
2947    instruction, allowing a branch to occur to one of many possible
2948    destinations.</p>
2949
2950 <h5>Arguments:</h5>
2951 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
2952    comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination,
2953    and an array of pairs of comparison value constants and '<tt>label</tt>'s.
2954    The table is not allowed to contain duplicate constant entries.</p>
2955
2956 <h5>Semantics:</h5>
2957 <p>The <tt>switch</tt> instruction specifies a table of values and
2958    destinations. When the '<tt>switch</tt>' instruction is executed, this table
2959    is searched for the given value.  If the value is found, control flow is
2960    transferred to the corresponding destination; otherwise, control flow is
2961    transferred to the default destination.</p>
2962
2963 <h5>Implementation:</h5>
2964 <p>Depending on properties of the target machine and the particular
2965    <tt>switch</tt> instruction, this instruction may be code generated in
2966    different ways.  For example, it could be generated as a series of chained
2967    conditional branches or with a lookup table.</p>
2968
2969 <h5>Example:</h5>
2970 <pre>
2971  <i>; Emulate a conditional br instruction</i>
2972  %Val = <a href="#i_zext">zext</a> i1 %value to i32
2973  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
2974
2975  <i>; Emulate an unconditional br instruction</i>
2976  switch i32 0, label %dest [ ]
2977
2978  <i>; Implement a jump table:</i>
2979  switch i32 %val, label %otherwise [ i32 0, label %onzero
2980                                      i32 1, label %onone
2981                                      i32 2, label %ontwo ]
2982 </pre>
2983
2984 </div>
2985
2986
2987 <!-- _______________________________________________________________________ -->
2988 <div class="doc_subsubsection">
2989    <a name="i_indirectbr">'<tt>indirectbr</tt>' Instruction</a>
2990 </div>
2991
2992 <div class="doc_text">
2993
2994 <h5>Syntax:</h5>
2995 <pre>
2996   indirectbr &lt;somety&gt;* &lt;address&gt;, [ label &lt;dest1&gt;, label &lt;dest2&gt;, ... ]
2997 </pre>
2998
2999 <h5>Overview:</h5>
3000
3001 <p>The '<tt>indirectbr</tt>' instruction implements an indirect branch to a label
3002    within the current function, whose address is specified by
3003    "<tt>address</tt>".  Address must be derived from a <a
3004    href="#blockaddress">blockaddress</a> constant.</p>
3005
3006 <h5>Arguments:</h5>
3007
3008 <p>The '<tt>address</tt>' argument is the address of the label to jump to.  The
3009    rest of the arguments indicate the full set of possible destinations that the
3010    address may point to.  Blocks are allowed to occur multiple times in the
3011    destination list, though this isn't particularly useful.</p>
3012
3013 <p>This destination list is required so that dataflow analysis has an accurate
3014    understanding of the CFG.</p>
3015
3016 <h5>Semantics:</h5>
3017
3018 <p>Control transfers to the block specified in the address argument.  All
3019    possible destination blocks must be listed in the label list, otherwise this
3020    instruction has undefined behavior.  This implies that jumps to labels
3021    defined in other functions have undefined behavior as well.</p>
3022
3023 <h5>Implementation:</h5>
3024
3025 <p>This is typically implemented with a jump through a register.</p>
3026
3027 <h5>Example:</h5>
3028 <pre>
3029  indirectbr i8* %Addr, [ label %bb1, label %bb2, label %bb3 ]
3030 </pre>
3031
3032 </div>
3033
3034
3035 <!-- _______________________________________________________________________ -->
3036 <div class="doc_subsubsection">
3037   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
3038 </div>
3039
3040 <div class="doc_text">
3041
3042 <h5>Syntax:</h5>
3043 <pre>
3044   &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>]
3045                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
3046 </pre>
3047
3048 <h5>Overview:</h5>
3049 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
3050    function, with the possibility of control flow transfer to either the
3051    '<tt>normal</tt>' label or the '<tt>exception</tt>' label.  If the callee
3052    function returns with the "<tt><a href="#i_ret">ret</a></tt>" instruction,
3053    control flow will return to the "normal" label.  If the callee (or any
3054    indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
3055    instruction, control is interrupted and continued at the dynamically nearest
3056    "exception" label.</p>
3057
3058 <h5>Arguments:</h5>
3059 <p>This instruction requires several arguments:</p>
3060
3061 <ol>
3062   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
3063       convention</a> the call should use.  If none is specified, the call
3064       defaults to using C calling conventions.</li>
3065
3066   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
3067       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
3068       '<tt>inreg</tt>' attributes are valid here.</li>
3069
3070   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
3071       function value being invoked.  In most cases, this is a direct function
3072       invocation, but indirect <tt>invoke</tt>s are just as possible, branching
3073       off an arbitrary pointer to function value.</li>
3074
3075   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
3076       function to be invoked. </li>
3077
3078   <li>'<tt>function args</tt>': argument list whose types match the function
3079       signature argument types and parameter attributes. All arguments must be
3080       of <a href="#t_firstclass">first class</a> type. If the function
3081       signature indicates the function accepts a variable number of arguments,
3082       the extra arguments can be specified.</li>
3083
3084   <li>'<tt>normal label</tt>': the label reached when the called function
3085       executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
3086
3087   <li>'<tt>exception label</tt>': the label reached when a callee returns with
3088       the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
3089
3090   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
3091       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
3092       '<tt>readnone</tt>' attributes are valid here.</li>
3093 </ol>
3094
3095 <h5>Semantics:</h5>
3096 <p>This instruction is designed to operate as a standard
3097    '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The
3098    primary difference is that it establishes an association with a label, which
3099    is used by the runtime library to unwind the stack.</p>
3100
3101 <p>This instruction is used in languages with destructors to ensure that proper
3102    cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
3103    exception.  Additionally, this is important for implementation of
3104    '<tt>catch</tt>' clauses in high-level languages that support them.</p>
3105
3106 <p>For the purposes of the SSA form, the definition of the value returned by the
3107    '<tt>invoke</tt>' instruction is deemed to occur on the edge from the current
3108    block to the "normal" label. If the callee unwinds then no return value is
3109    available.</p>
3110
3111 <p>Note that the code generator does not yet completely support unwind, and
3112 that the invoke/unwind semantics are likely to change in future versions.</p>
3113
3114 <h5>Example:</h5>
3115 <pre>
3116   %retval = invoke i32 @Test(i32 15) to label %Continue
3117               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3118   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
3119               unwind label %TestCleanup              <i>; {i32}:retval set</i>
3120 </pre>
3121
3122 </div>
3123
3124 <!-- _______________________________________________________________________ -->
3125
3126 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
3127 Instruction</a> </div>
3128
3129 <div class="doc_text">
3130
3131 <h5>Syntax:</h5>
3132 <pre>
3133   unwind
3134 </pre>
3135
3136 <h5>Overview:</h5>
3137 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
3138    at the first callee in the dynamic call stack which used
3139    an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.
3140    This is primarily used to implement exception handling.</p>
3141
3142 <h5>Semantics:</h5>
3143 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
3144    immediately halt.  The dynamic call stack is then searched for the
3145    first <a href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.
3146    Once found, execution continues at the "exceptional" destination block
3147    specified by the <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt>
3148    instruction in the dynamic call chain, undefined behavior results.</p>
3149
3150 <p>Note that the code generator does not yet completely support unwind, and
3151 that the invoke/unwind semantics are likely to change in future versions.</p>
3152
3153 </div>
3154
3155 <!-- _______________________________________________________________________ -->
3156
3157 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
3158 Instruction</a> </div>
3159
3160 <div class="doc_text">
3161
3162 <h5>Syntax:</h5>
3163 <pre>
3164   unreachable
3165 </pre>
3166
3167 <h5>Overview:</h5>
3168 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
3169    instruction is used to inform the optimizer that a particular portion of the
3170    code is not reachable.  This can be used to indicate that the code after a
3171    no-return function cannot be reached, and other facts.</p>
3172
3173 <h5>Semantics:</h5>
3174 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
3175
3176 </div>
3177
3178 <!-- ======================================================================= -->
3179 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
3180
3181 <div class="doc_text">
3182
3183 <p>Binary operators are used to do most of the computation in a program.  They
3184    require two operands of the same type, execute an operation on them, and
3185    produce a single value.  The operands might represent multiple data, as is
3186    the case with the <a href="#t_vector">vector</a> data type.  The result value
3187    has the same type as its operands.</p>
3188
3189 <p>There are several different binary operators:</p>
3190
3191 </div>
3192
3193 <!-- _______________________________________________________________________ -->
3194 <div class="doc_subsubsection">
3195   <a name="i_add">'<tt>add</tt>' Instruction</a>
3196 </div>
3197
3198 <div class="doc_text">
3199
3200 <h5>Syntax:</h5>
3201 <pre>
3202   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3203   &lt;result&gt; = add nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3204   &lt;result&gt; = add nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3205   &lt;result&gt; = add nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3206 </pre>
3207
3208 <h5>Overview:</h5>
3209 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
3210
3211 <h5>Arguments:</h5>
3212 <p>The two arguments to the '<tt>add</tt>' instruction must
3213    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3214    integer values. Both arguments must have identical types.</p>
3215
3216 <h5>Semantics:</h5>
3217 <p>The value produced is the integer sum of the two operands.</p>
3218
3219 <p>If the sum has unsigned overflow, the result returned is the mathematical
3220    result modulo 2<sup>n</sup>, where n is the bit width of the result.</p>
3221
3222 <p>Because LLVM integers use a two's complement representation, this instruction
3223    is appropriate for both signed and unsigned integers.</p>
3224
3225 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3226    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3227    <tt>nsw</tt> keywords are present, the result value of the <tt>add</tt>
3228    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3229    respectively, occurs.</p>
3230
3231 <h5>Example:</h5>
3232 <pre>
3233   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
3234 </pre>
3235
3236 </div>
3237
3238 <!-- _______________________________________________________________________ -->
3239 <div class="doc_subsubsection">
3240   <a name="i_fadd">'<tt>fadd</tt>' Instruction</a>
3241 </div>
3242
3243 <div class="doc_text">
3244
3245 <h5>Syntax:</h5>
3246 <pre>
3247   &lt;result&gt; = fadd &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3248 </pre>
3249
3250 <h5>Overview:</h5>
3251 <p>The '<tt>fadd</tt>' instruction returns the sum of its two operands.</p>
3252
3253 <h5>Arguments:</h5>
3254 <p>The two arguments to the '<tt>fadd</tt>' instruction must be
3255    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3256    floating point values. Both arguments must have identical types.</p>
3257
3258 <h5>Semantics:</h5>
3259 <p>The value produced is the floating point sum of the two operands.</p>
3260
3261 <h5>Example:</h5>
3262 <pre>
3263   &lt;result&gt; = fadd float 4.0, %var          <i>; yields {float}:result = 4.0 + %var</i>
3264 </pre>
3265
3266 </div>
3267
3268 <!-- _______________________________________________________________________ -->
3269 <div class="doc_subsubsection">
3270    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
3271 </div>
3272
3273 <div class="doc_text">
3274
3275 <h5>Syntax:</h5>
3276 <pre>
3277   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3278   &lt;result&gt; = sub nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3279   &lt;result&gt; = sub nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3280   &lt;result&gt; = sub nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3281 </pre>
3282
3283 <h5>Overview:</h5>
3284 <p>The '<tt>sub</tt>' instruction returns the difference of its two
3285    operands.</p>
3286
3287 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
3288    '<tt>neg</tt>' instruction present in most other intermediate
3289    representations.</p>
3290
3291 <h5>Arguments:</h5>
3292 <p>The two arguments to the '<tt>sub</tt>' instruction must
3293    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3294    integer values.  Both arguments must have identical types.</p>
3295
3296 <h5>Semantics:</h5>
3297 <p>The value produced is the integer difference of the two operands.</p>
3298
3299 <p>If the difference has unsigned overflow, the result returned is the
3300    mathematical result modulo 2<sup>n</sup>, where n is the bit width of the
3301    result.</p>
3302
3303 <p>Because LLVM integers use a two's complement representation, this instruction
3304    is appropriate for both signed and unsigned integers.</p>
3305
3306 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3307    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3308    <tt>nsw</tt> keywords are present, the result value of the <tt>sub</tt>
3309    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3310    respectively, occurs.</p>
3311
3312 <h5>Example:</h5>
3313 <pre>
3314   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
3315   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
3316 </pre>
3317
3318 </div>
3319
3320 <!-- _______________________________________________________________________ -->
3321 <div class="doc_subsubsection">
3322    <a name="i_fsub">'<tt>fsub</tt>' Instruction</a>
3323 </div>
3324
3325 <div class="doc_text">
3326
3327 <h5>Syntax:</h5>
3328 <pre>
3329   &lt;result&gt; = fsub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3330 </pre>
3331
3332 <h5>Overview:</h5>
3333 <p>The '<tt>fsub</tt>' instruction returns the difference of its two
3334    operands.</p>
3335
3336 <p>Note that the '<tt>fsub</tt>' instruction is used to represent the
3337    '<tt>fneg</tt>' instruction present in most other intermediate
3338    representations.</p>
3339
3340 <h5>Arguments:</h5>
3341 <p>The two arguments to the '<tt>fsub</tt>' instruction must be
3342    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3343    floating point values.  Both arguments must have identical types.</p>
3344
3345 <h5>Semantics:</h5>
3346 <p>The value produced is the floating point difference of the two operands.</p>
3347
3348 <h5>Example:</h5>
3349 <pre>
3350   &lt;result&gt; = fsub float 4.0, %var           <i>; yields {float}:result = 4.0 - %var</i>
3351   &lt;result&gt; = fsub float -0.0, %val          <i>; yields {float}:result = -%var</i>
3352 </pre>
3353
3354 </div>
3355
3356 <!-- _______________________________________________________________________ -->
3357 <div class="doc_subsubsection">
3358   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
3359 </div>
3360
3361 <div class="doc_text">
3362
3363 <h5>Syntax:</h5>
3364 <pre>
3365   &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;          <i>; yields {ty}:result</i>
3366   &lt;result&gt; = mul nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3367   &lt;result&gt; = mul nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;      <i>; yields {ty}:result</i>
3368   &lt;result&gt; = mul nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;  <i>; yields {ty}:result</i>
3369 </pre>
3370
3371 <h5>Overview:</h5>
3372 <p>The '<tt>mul</tt>' instruction returns the product of its two operands.</p>
3373
3374 <h5>Arguments:</h5>
3375 <p>The two arguments to the '<tt>mul</tt>' instruction must
3376    be <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3377    integer values.  Both arguments must have identical types.</p>
3378
3379 <h5>Semantics:</h5>
3380 <p>The value produced is the integer product of the two operands.</p>
3381
3382 <p>If the result of the multiplication has unsigned overflow, the result
3383    returned is the mathematical result modulo 2<sup>n</sup>, where n is the bit
3384    width of the result.</p>
3385
3386 <p>Because LLVM integers use a two's complement representation, and the result
3387    is the same width as the operands, this instruction returns the correct
3388    result for both signed and unsigned integers.  If a full product
3389    (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands should
3390    be sign-extended or zero-extended as appropriate to the width of the full
3391    product.</p>
3392
3393 <p><tt>nuw</tt> and <tt>nsw</tt> stand for &quot;No Unsigned Wrap&quot;
3394    and &quot;No Signed Wrap&quot;, respectively. If the <tt>nuw</tt> and/or
3395    <tt>nsw</tt> keywords are present, the result value of the <tt>mul</tt>
3396    is a <a href="#trapvalues">trap value</a> if unsigned and/or signed overflow,
3397    respectively, occurs.</p>
3398
3399 <h5>Example:</h5>
3400 <pre>
3401   &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
3402 </pre>
3403
3404 </div>
3405
3406 <!-- _______________________________________________________________________ -->
3407 <div class="doc_subsubsection">
3408   <a name="i_fmul">'<tt>fmul</tt>' Instruction</a>
3409 </div>
3410
3411 <div class="doc_text">
3412
3413 <h5>Syntax:</h5>
3414 <pre>
3415   &lt;result&gt; = fmul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3416 </pre>
3417
3418 <h5>Overview:</h5>
3419 <p>The '<tt>fmul</tt>' instruction returns the product of its two operands.</p>
3420
3421 <h5>Arguments:</h5>
3422 <p>The two arguments to the '<tt>fmul</tt>' instruction must be
3423    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3424    floating point values.  Both arguments must have identical types.</p>
3425
3426 <h5>Semantics:</h5>
3427 <p>The value produced is the floating point product of the two operands.</p>
3428
3429 <h5>Example:</h5>
3430 <pre>
3431   &lt;result&gt; = fmul float 4.0, %var          <i>; yields {float}:result = 4.0 * %var</i>
3432 </pre>
3433
3434 </div>
3435
3436 <!-- _______________________________________________________________________ -->
3437 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
3438 </a></div>
3439
3440 <div class="doc_text">
3441
3442 <h5>Syntax:</h5>
3443 <pre>
3444   &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3445   &lt;result&gt; = udiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3446 </pre>
3447
3448 <h5>Overview:</h5>
3449 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two operands.</p>
3450
3451 <h5>Arguments:</h5>
3452 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
3453    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3454    values.  Both arguments must have identical types.</p>
3455
3456 <h5>Semantics:</h5>
3457 <p>The value produced is the unsigned integer quotient of the two operands.</p>
3458
3459 <p>Note that unsigned integer division and signed integer division are distinct
3460    operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
3461
3462 <p>Division by zero leads to undefined behavior.</p>
3463
3464 <p>If the <tt>exact</tt> keyword is present, the result value of the
3465    <tt>udiv</tt> is a <a href="#trapvalues">trap value</a> if %op1 is not a
3466   multiple of %op2 (as such, "((a udiv exact b) mul b) == a").</p>
3467
3468
3469 <h5>Example:</h5>
3470 <pre>
3471   &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3472 </pre>
3473
3474 </div>
3475
3476 <!-- _______________________________________________________________________ -->
3477 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
3478 </a> </div>
3479
3480 <div class="doc_text">
3481
3482 <h5>Syntax:</h5>
3483 <pre>
3484   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3485   &lt;result&gt; = sdiv exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3486 </pre>
3487
3488 <h5>Overview:</h5>
3489 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two operands.</p>
3490
3491 <h5>Arguments:</h5>
3492 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
3493    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3494    values.  Both arguments must have identical types.</p>
3495
3496 <h5>Semantics:</h5>
3497 <p>The value produced is the signed integer quotient of the two operands rounded
3498    towards zero.</p>
3499
3500 <p>Note that signed integer division and unsigned integer division are distinct
3501    operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
3502
3503 <p>Division by zero leads to undefined behavior. Overflow also leads to
3504    undefined behavior; this is a rare case, but can occur, for example, by doing
3505    a 32-bit division of -2147483648 by -1.</p>
3506
3507 <p>If the <tt>exact</tt> keyword is present, the result value of the
3508    <tt>sdiv</tt> is a <a href="#trapvalues">trap value</a> if the result would
3509    be rounded.</p>
3510
3511 <h5>Example:</h5>
3512 <pre>
3513   &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
3514 </pre>
3515
3516 </div>
3517
3518 <!-- _______________________________________________________________________ -->
3519 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
3520 Instruction</a> </div>
3521
3522 <div class="doc_text">
3523
3524 <h5>Syntax:</h5>
3525 <pre>
3526   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3527 </pre>
3528
3529 <h5>Overview:</h5>
3530 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two operands.</p>
3531
3532 <h5>Arguments:</h5>
3533 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
3534    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3535    floating point values.  Both arguments must have identical types.</p>
3536
3537 <h5>Semantics:</h5>
3538 <p>The value produced is the floating point quotient of the two operands.</p>
3539
3540 <h5>Example:</h5>
3541 <pre>
3542   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
3543 </pre>
3544
3545 </div>
3546
3547 <!-- _______________________________________________________________________ -->
3548 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
3549 </div>
3550
3551 <div class="doc_text">
3552
3553 <h5>Syntax:</h5>
3554 <pre>
3555   &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3556 </pre>
3557
3558 <h5>Overview:</h5>
3559 <p>The '<tt>urem</tt>' instruction returns the remainder from the unsigned
3560    division of its two arguments.</p>
3561
3562 <h5>Arguments:</h5>
3563 <p>The two arguments to the '<tt>urem</tt>' instruction must be
3564    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3565    values.  Both arguments must have identical types.</p>
3566
3567 <h5>Semantics:</h5>
3568 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
3569    This instruction always performs an unsigned division to get the
3570    remainder.</p>
3571
3572 <p>Note that unsigned integer remainder and signed integer remainder are
3573    distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
3574
3575 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
3576
3577 <h5>Example:</h5>
3578 <pre>
3579   &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3580 </pre>
3581
3582 </div>
3583
3584 <!-- _______________________________________________________________________ -->
3585 <div class="doc_subsubsection">
3586   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
3587 </div>
3588
3589 <div class="doc_text">
3590
3591 <h5>Syntax:</h5>
3592 <pre>
3593   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3594 </pre>
3595
3596 <h5>Overview:</h5>
3597 <p>The '<tt>srem</tt>' instruction returns the remainder from the signed
3598    division of its two operands. This instruction can also take
3599    <a href="#t_vector">vector</a> versions of the values in which case the
3600    elements must be integers.</p>
3601
3602 <h5>Arguments:</h5>
3603 <p>The two arguments to the '<tt>srem</tt>' instruction must be
3604    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3605    values.  Both arguments must have identical types.</p>
3606
3607 <h5>Semantics:</h5>
3608 <p>This instruction returns the <i>remainder</i> of a division (where the result
3609    has the same sign as the dividend, <tt>op1</tt>), not the <i>modulo</i>
3610    operator (where the result has the same sign as the divisor, <tt>op2</tt>) of
3611    a value.  For more information about the difference,
3612    see <a href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
3613    Math Forum</a>. For a table of how this is implemented in various languages,
3614    please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
3615    Wikipedia: modulo operation</a>.</p>
3616
3617 <p>Note that signed integer remainder and unsigned integer remainder are
3618    distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
3619
3620 <p>Taking the remainder of a division by zero leads to undefined behavior.
3621    Overflow also leads to undefined behavior; this is a rare case, but can
3622    occur, for example, by taking the remainder of a 32-bit division of
3623    -2147483648 by -1.  (The remainder doesn't actually overflow, but this rule
3624    lets srem be implemented using instructions that return both the result of
3625    the division and the remainder.)</p>
3626
3627 <h5>Example:</h5>
3628 <pre>
3629   &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
3630 </pre>
3631
3632 </div>
3633
3634 <!-- _______________________________________________________________________ -->
3635 <div class="doc_subsubsection">
3636   <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
3637
3638 <div class="doc_text">
3639
3640 <h5>Syntax:</h5>
3641 <pre>
3642   &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3643 </pre>
3644
3645 <h5>Overview:</h5>
3646 <p>The '<tt>frem</tt>' instruction returns the remainder from the division of
3647    its two operands.</p>
3648
3649 <h5>Arguments:</h5>
3650 <p>The two arguments to the '<tt>frem</tt>' instruction must be
3651    <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a> of
3652    floating point values.  Both arguments must have identical types.</p>
3653
3654 <h5>Semantics:</h5>
3655 <p>This instruction returns the <i>remainder</i> of a division.  The remainder
3656    has the same sign as the dividend.</p>
3657
3658 <h5>Example:</h5>
3659 <pre>
3660   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
3661 </pre>
3662
3663 </div>
3664
3665 <!-- ======================================================================= -->
3666 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
3667 Operations</a> </div>
3668
3669 <div class="doc_text">
3670
3671 <p>Bitwise binary operators are used to do various forms of bit-twiddling in a
3672    program.  They are generally very efficient instructions and can commonly be
3673    strength reduced from other instructions.  They require two operands of the
3674    same type, execute an operation on them, and produce a single value.  The
3675    resulting value is the same type as its operands.</p>
3676
3677 </div>
3678
3679 <!-- _______________________________________________________________________ -->
3680 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
3681 Instruction</a> </div>
3682
3683 <div class="doc_text">
3684
3685 <h5>Syntax:</h5>
3686 <pre>
3687   &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;           <i>; yields {ty}:result</i>
3688   &lt;result&gt; = shl nuw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3689   &lt;result&gt; = shl nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;       <i>; yields {ty}:result</i>
3690   &lt;result&gt; = shl nuw nsw &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3691 </pre>
3692
3693 <h5>Overview:</h5>
3694 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to the left
3695    a specified number of bits.</p>
3696
3697 <h5>Arguments:</h5>
3698 <p>Both arguments to the '<tt>shl</tt>' instruction must be the
3699     same <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of
3700     integer type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3701
3702 <h5>Semantics:</h5>
3703 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod
3704    2<sup>n</sup>, where <tt>n</tt> is the width of the result.  If <tt>op2</tt>
3705    is (statically or dynamically) negative or equal to or larger than the number
3706    of bits in <tt>op1</tt>, the result is undefined.  If the arguments are
3707    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3708    shift amount in <tt>op2</tt>.</p>
3709
3710 <p>If the <tt>nuw</tt> keyword is present, then the shift produces a
3711    <a href="#trapvalues">trap value</a> if it shifts out any non-zero bits.  If
3712    the <tt>nsw</tt> keyword is present, then the shift produces a
3713    <a href="#trapvalues">trap value</a> if it shifts out any bits that disagree
3714    with the resultant sign bit.  As such, NUW/NSW have the same semantics as
3715    they would if the shift were expressed as a mul instruction with the same
3716    nsw/nuw bits in (mul %op1, (shl 1, %op2)).</p>
3717
3718 <h5>Example:</h5>
3719 <pre>
3720   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
3721   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
3722   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
3723   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
3724   &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>
3725 </pre>
3726
3727 </div>
3728
3729 <!-- _______________________________________________________________________ -->
3730 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
3731 Instruction</a> </div>
3732
3733 <div class="doc_text">
3734
3735 <h5>Syntax:</h5>
3736 <pre>
3737   &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3738   &lt;result&gt; = lshr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3739 </pre>
3740
3741 <h5>Overview:</h5>
3742 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
3743    operand shifted to the right a specified number of bits with zero fill.</p>
3744
3745 <h5>Arguments:</h5>
3746 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
3747    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3748    type. '<tt>op2</tt>' is treated as an unsigned value.</p>
3749
3750 <h5>Semantics:</h5>
3751 <p>This instruction always performs a logical shift right operation. The most
3752    significant bits of the result will be filled with zero bits after the shift.
3753    If <tt>op2</tt> is (statically or dynamically) equal to or larger than the
3754    number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
3755    vectors, each vector element of <tt>op1</tt> is shifted by the corresponding
3756    shift amount in <tt>op2</tt>.</p>
3757
3758 <p>If the <tt>exact</tt> keyword is present, the result value of the
3759    <tt>lshr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3760    shifted out are non-zero.</p>
3761
3762
3763 <h5>Example:</h5>
3764 <pre>
3765   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
3766   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
3767   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
3768   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
3769   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
3770   &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>
3771 </pre>
3772
3773 </div>
3774
3775 <!-- _______________________________________________________________________ -->
3776 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
3777 Instruction</a> </div>
3778 <div class="doc_text">
3779
3780 <h5>Syntax:</h5>
3781 <pre>
3782   &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;         <i>; yields {ty}:result</i>
3783   &lt;result&gt; = ashr exact &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3784 </pre>
3785
3786 <h5>Overview:</h5>
3787 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
3788    operand shifted to the right a specified number of bits with sign
3789    extension.</p>
3790
3791 <h5>Arguments:</h5>
3792 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
3793    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3794    type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
3795
3796 <h5>Semantics:</h5>
3797 <p>This instruction always performs an arithmetic shift right operation, The
3798    most significant bits of the result will be filled with the sign bit
3799    of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
3800    larger than the number of bits in <tt>op1</tt>, the result is undefined. If
3801    the arguments are vectors, each vector element of <tt>op1</tt> is shifted by
3802    the corresponding shift amount in <tt>op2</tt>.</p>
3803
3804 <p>If the <tt>exact</tt> keyword is present, the result value of the
3805    <tt>ashr</tt> is a <a href="#trapvalues">trap value</a> if any of the bits
3806    shifted out are non-zero.</p>
3807
3808 <h5>Example:</h5>
3809 <pre>
3810   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
3811   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
3812   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
3813   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
3814   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
3815   &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>
3816 </pre>
3817
3818 </div>
3819
3820 <!-- _______________________________________________________________________ -->
3821 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
3822 Instruction</a> </div>
3823
3824 <div class="doc_text">
3825
3826 <h5>Syntax:</h5>
3827 <pre>
3828   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3829 </pre>
3830
3831 <h5>Overview:</h5>
3832 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of its two
3833    operands.</p>
3834
3835 <h5>Arguments:</h5>
3836 <p>The two arguments to the '<tt>and</tt>' instruction must be
3837    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3838    values.  Both arguments must have identical types.</p>
3839
3840 <h5>Semantics:</h5>
3841 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
3842
3843 <table border="1" cellspacing="0" cellpadding="4">
3844   <tbody>
3845     <tr>
3846       <td>In0</td>
3847       <td>In1</td>
3848       <td>Out</td>
3849     </tr>
3850     <tr>
3851       <td>0</td>
3852       <td>0</td>
3853       <td>0</td>
3854     </tr>
3855     <tr>
3856       <td>0</td>
3857       <td>1</td>
3858       <td>0</td>
3859     </tr>
3860     <tr>
3861       <td>1</td>
3862       <td>0</td>
3863       <td>0</td>
3864     </tr>
3865     <tr>
3866       <td>1</td>
3867       <td>1</td>
3868       <td>1</td>
3869     </tr>
3870   </tbody>
3871 </table>
3872
3873 <h5>Example:</h5>
3874 <pre>
3875   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
3876   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
3877   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
3878 </pre>
3879 </div>
3880 <!-- _______________________________________________________________________ -->
3881 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
3882
3883 <div class="doc_text">
3884
3885 <h5>Syntax:</h5>
3886 <pre>
3887   &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3888 </pre>
3889
3890 <h5>Overview:</h5>
3891 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its
3892    two operands.</p>
3893
3894 <h5>Arguments:</h5>
3895 <p>The two arguments to the '<tt>or</tt>' instruction must be
3896    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3897    values.  Both arguments must have identical types.</p>
3898
3899 <h5>Semantics:</h5>
3900 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
3901
3902 <table border="1" cellspacing="0" cellpadding="4">
3903   <tbody>
3904     <tr>
3905       <td>In0</td>
3906       <td>In1</td>
3907       <td>Out</td>
3908     </tr>
3909     <tr>
3910       <td>0</td>
3911       <td>0</td>
3912       <td>0</td>
3913     </tr>
3914     <tr>
3915       <td>0</td>
3916       <td>1</td>
3917       <td>1</td>
3918     </tr>
3919     <tr>
3920       <td>1</td>
3921       <td>0</td>
3922       <td>1</td>
3923     </tr>
3924     <tr>
3925       <td>1</td>
3926       <td>1</td>
3927       <td>1</td>
3928     </tr>
3929   </tbody>
3930 </table>
3931
3932 <h5>Example:</h5>
3933 <pre>
3934   &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
3935   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
3936   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
3937 </pre>
3938
3939 </div>
3940
3941 <!-- _______________________________________________________________________ -->
3942 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
3943 Instruction</a> </div>
3944
3945 <div class="doc_text">
3946
3947 <h5>Syntax:</h5>
3948 <pre>
3949   &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
3950 </pre>
3951
3952 <h5>Overview:</h5>
3953 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of
3954    its two operands.  The <tt>xor</tt> is used to implement the "one's
3955    complement" operation, which is the "~" operator in C.</p>
3956
3957 <h5>Arguments:</h5>
3958 <p>The two arguments to the '<tt>xor</tt>' instruction must be
3959    <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
3960    values.  Both arguments must have identical types.</p>
3961
3962 <h5>Semantics:</h5>
3963 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
3964
3965 <table border="1" cellspacing="0" cellpadding="4">
3966   <tbody>
3967     <tr>
3968       <td>In0</td>
3969       <td>In1</td>
3970       <td>Out</td>
3971     </tr>
3972     <tr>
3973       <td>0</td>
3974       <td>0</td>
3975       <td>0</td>
3976     </tr>
3977     <tr>
3978       <td>0</td>
3979       <td>1</td>
3980       <td>1</td>
3981     </tr>
3982     <tr>
3983       <td>1</td>
3984       <td>0</td>
3985       <td>1</td>
3986     </tr>
3987     <tr>
3988       <td>1</td>
3989       <td>1</td>
3990       <td>0</td>
3991     </tr>
3992   </tbody>
3993 </table>
3994
3995 <h5>Example:</h5>
3996 <pre>
3997   &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
3998   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
3999   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
4000   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
4001 </pre>
4002
4003 </div>
4004
4005 <!-- ======================================================================= -->
4006 <div class="doc_subsection">
4007   <a name="vectorops">Vector Operations</a>
4008 </div>
4009
4010 <div class="doc_text">
4011
4012 <p>LLVM supports several instructions to represent vector operations in a
4013    target-independent manner.  These instructions cover the element-access and
4014    vector-specific operations needed to process vectors effectively.  While LLVM
4015    does directly support these vector operations, many sophisticated algorithms
4016    will want to use target-specific intrinsics to take full advantage of a
4017    specific target.</p>
4018
4019 </div>
4020
4021 <!-- _______________________________________________________________________ -->
4022 <div class="doc_subsubsection">
4023    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
4024 </div>
4025
4026 <div class="doc_text">
4027
4028 <h5>Syntax:</h5>
4029 <pre>
4030   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
4031 </pre>
4032
4033 <h5>Overview:</h5>
4034 <p>The '<tt>extractelement</tt>' instruction extracts a single scalar element
4035    from a vector at a specified index.</p>
4036
4037
4038 <h5>Arguments:</h5>
4039 <p>The first operand of an '<tt>extractelement</tt>' instruction is a value
4040    of <a href="#t_vector">vector</a> type.  The second operand is an index
4041    indicating the position from which to extract the element.  The index may be
4042    a variable.</p>
4043
4044 <h5>Semantics:</h5>
4045 <p>The result is a scalar of the same type as the element type of
4046    <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
4047    <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4048    results are undefined.</p>
4049
4050 <h5>Example:</h5>
4051 <pre>
4052   &lt;result&gt; = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
4053 </pre>
4054
4055 </div>
4056
4057 <!-- _______________________________________________________________________ -->
4058 <div class="doc_subsubsection">
4059    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
4060 </div>
4061
4062 <div class="doc_text">
4063
4064 <h5>Syntax:</h5>
4065 <pre>
4066   &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>
4067 </pre>
4068
4069 <h5>Overview:</h5>
4070 <p>The '<tt>insertelement</tt>' instruction inserts a scalar element into a
4071    vector at a specified index.</p>
4072
4073 <h5>Arguments:</h5>
4074 <p>The first operand of an '<tt>insertelement</tt>' instruction is a value
4075    of <a href="#t_vector">vector</a> type.  The second operand is a scalar value
4076    whose type must equal the element type of the first operand.  The third
4077    operand is an index indicating the position at which to insert the value.
4078    The index may be a variable.</p>
4079
4080 <h5>Semantics:</h5>
4081 <p>The result is a vector of the same type as <tt>val</tt>.  Its element values
4082    are those of <tt>val</tt> except at position <tt>idx</tt>, where it gets the
4083    value <tt>elt</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
4084    results are undefined.</p>
4085
4086 <h5>Example:</h5>
4087 <pre>
4088   &lt;result&gt; = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
4089 </pre>
4090
4091 </div>
4092
4093 <!-- _______________________________________________________________________ -->
4094 <div class="doc_subsubsection">
4095    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
4096 </div>
4097
4098 <div class="doc_text">
4099
4100 <h5>Syntax:</h5>
4101 <pre>
4102   &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>
4103 </pre>
4104
4105 <h5>Overview:</h5>
4106 <p>The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
4107    from two input vectors, returning a vector with the same element type as the
4108    input and length that is the same as the shuffle mask.</p>
4109
4110 <h5>Arguments:</h5>
4111 <p>The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
4112    with types that match each other. The third argument is a shuffle mask whose
4113    element type is always 'i32'.  The result of the instruction is a vector
4114    whose length is the same as the shuffle mask and whose element type is the
4115    same as the element type of the first two operands.</p>
4116
4117 <p>The shuffle mask operand is required to be a constant vector with either
4118    constant integer or undef values.</p>
4119
4120 <h5>Semantics:</h5>
4121 <p>The elements of the two input vectors are numbered from left to right across
4122    both of the vectors.  The shuffle mask operand specifies, for each element of
4123    the result vector, which element of the two input vectors the result element
4124    gets.  The element selector may be undef (meaning "don't care") and the
4125    second operand may be undef if performing a shuffle from only one vector.</p>
4126
4127 <h5>Example:</h5>
4128 <pre>
4129   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4130                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
4131   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
4132                           &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.
4133   &lt;result&gt; = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
4134                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
4135   &lt;result&gt; = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
4136                           &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>
4137 </pre>
4138
4139 </div>
4140
4141 <!-- ======================================================================= -->
4142 <div class="doc_subsection">
4143   <a name="aggregateops">Aggregate Operations</a>
4144 </div>
4145
4146 <div class="doc_text">
4147
4148 <p>LLVM supports several instructions for working with
4149   <a href="#t_aggregate">aggregate</a> values.</p>
4150
4151 </div>
4152
4153 <!-- _______________________________________________________________________ -->
4154 <div class="doc_subsubsection">
4155    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
4156 </div>
4157
4158 <div class="doc_text">
4159
4160 <h5>Syntax:</h5>
4161 <pre>
4162   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
4163 </pre>
4164
4165 <h5>Overview:</h5>
4166 <p>The '<tt>extractvalue</tt>' instruction extracts the value of a member field
4167    from an <a href="#t_aggregate">aggregate</a> value.</p>
4168
4169 <h5>Arguments:</h5>
4170 <p>The first operand of an '<tt>extractvalue</tt>' instruction is a value
4171    of <a href="#t_struct">struct</a> or
4172    <a href="#t_array">array</a> type.  The operands are constant indices to
4173    specify which value to extract in a similar manner as indices in a
4174    '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.</p>
4175    <p>The major differences to <tt>getelementptr</tt> indexing are:</p>
4176      <ul>
4177        <li>Since the value being indexed is not a pointer, the first index is
4178            omitted and assumed to be zero.</li>
4179        <li>At least one index must be specified.</li>
4180        <li>Not only struct indices but also array indices must be in
4181            bounds.</li>
4182      </ul>
4183
4184 <h5>Semantics:</h5>
4185 <p>The result is the value at the position in the aggregate specified by the
4186    index operands.</p>
4187
4188 <h5>Example:</h5>
4189 <pre>
4190   &lt;result&gt; = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
4191 </pre>
4192
4193 </div>
4194
4195 <!-- _______________________________________________________________________ -->
4196 <div class="doc_subsubsection">
4197    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
4198 </div>
4199
4200 <div class="doc_text">
4201
4202 <h5>Syntax:</h5>
4203 <pre>
4204   &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>
4205 </pre>
4206
4207 <h5>Overview:</h5>
4208 <p>The '<tt>insertvalue</tt>' instruction inserts a value into a member field
4209    in an <a href="#t_aggregate">aggregate</a> value.</p>
4210
4211 <h5>Arguments:</h5>
4212 <p>The first operand of an '<tt>insertvalue</tt>' instruction is a value
4213    of <a href="#t_struct">struct</a> or
4214    <a href="#t_array">array</a> type.  The second operand is a first-class
4215    value to insert.  The following operands are constant indices indicating
4216    the position at which to insert the value in a similar manner as indices in a
4217    '<tt><a href="#i_extractvalue">extractvalue</a></tt>' instruction.  The
4218    value to insert must have the same type as the value identified by the
4219    indices.</p>
4220
4221 <h5>Semantics:</h5>
4222 <p>The result is an aggregate of the same type as <tt>val</tt>.  Its value is
4223    that of <tt>val</tt> except that the value at the position specified by the
4224    indices is that of <tt>elt</tt>.</p>
4225
4226 <h5>Example:</h5>
4227 <pre>
4228   %agg1 = insertvalue {i32, float} undef, i32 1, 0         <i>; yields {i32 1, float undef}</i>
4229   %agg2 = insertvalue {i32, float} %agg1, float %val, 1    <i>; yields {i32 1, float %val}</i>
4230 </pre>
4231
4232 </div>
4233
4234
4235 <!-- ======================================================================= -->
4236 <div class="doc_subsection">
4237   <a name="memoryops">Memory Access and Addressing Operations</a>
4238 </div>
4239
4240 <div class="doc_text">
4241
4242 <p>A key design point of an SSA-based representation is how it represents
4243    memory.  In LLVM, no memory locations are in SSA form, which makes things
4244    very simple.  This section describes how to read, write, and allocate
4245    memory in LLVM.</p>
4246
4247 </div>
4248
4249 <!-- _______________________________________________________________________ -->
4250 <div class="doc_subsubsection">
4251   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
4252 </div>
4253
4254 <div class="doc_text">
4255
4256 <h5>Syntax:</h5>
4257 <pre>
4258   &lt;result&gt; = alloca &lt;type&gt;[, &lt;ty&gt; &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
4259 </pre>
4260
4261 <h5>Overview:</h5>
4262 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
4263    currently executing function, to be automatically released when this function
4264    returns to its caller. The object is always allocated in the generic address
4265    space (address space zero).</p>
4266
4267 <h5>Arguments:</h5>
4268 <p>The '<tt>alloca</tt>' instruction
4269    allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt> bytes of memory on the
4270    runtime stack, returning a pointer of the appropriate type to the program.
4271    If "NumElements" is specified, it is the number of elements allocated,
4272    otherwise "NumElements" is defaulted to be one.  If a constant alignment is
4273    specified, the value result of the allocation is guaranteed to be aligned to
4274    at least that boundary.  If not specified, or if zero, the target can choose
4275    to align the allocation on any convenient boundary compatible with the
4276    type.</p>
4277
4278 <p>'<tt>type</tt>' may be any sized type.</p>
4279
4280 <h5>Semantics:</h5>
4281 <p>Memory is allocated; a pointer is returned.  The operation is undefined if
4282    there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
4283    memory is automatically released when the function returns.  The
4284    '<tt>alloca</tt>' instruction is commonly used to represent automatic
4285    variables that must have an address available.  When the function returns
4286    (either with the <tt><a href="#i_ret">ret</a></tt>
4287    or <tt><a href="#i_unwind">unwind</a></tt> instructions), the memory is
4288    reclaimed.  Allocating zero bytes is legal, but the result is undefined.</p>
4289
4290 <h5>Example:</h5>
4291 <pre>
4292   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
4293   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
4294   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
4295   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
4296 </pre>
4297
4298 </div>
4299
4300 <!-- _______________________________________________________________________ -->
4301 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
4302 Instruction</a> </div>
4303
4304 <div class="doc_text">
4305
4306 <h5>Syntax:</h5>
4307 <pre>
4308   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4309   &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;][, !nontemporal !&lt;index&gt;]
4310   !&lt;index&gt; = !{ i32 1 }
4311 </pre>
4312
4313 <h5>Overview:</h5>
4314 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
4315
4316 <h5>Arguments:</h5>
4317 <p>The argument to the '<tt>load</tt>' instruction specifies the memory address
4318    from which to load.  The pointer must point to
4319    a <a href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
4320    marked as <tt>volatile</tt>, then the optimizer is not allowed to modify the
4321    number or order of execution of this <tt>load</tt> with other <a
4322    href="#volatile">volatile operations</a>.</p>
4323
4324 <p>The optional constant <tt>align</tt> argument specifies the alignment of the
4325    operation (that is, the alignment of the memory address). A value of 0 or an
4326    omitted <tt>align</tt> argument means that the operation has the preferential
4327    alignment for the target. It is the responsibility of the code emitter to
4328    ensure that the alignment information is correct. Overestimating the
4329    alignment results in undefined behavior. Underestimating the alignment may
4330    produce less efficient code. An alignment of 1 is always safe.</p>
4331
4332 <p>The optional <tt>!nontemporal</tt> metadata must reference a single
4333    metatadata name &lt;index&gt; corresponding to a metadata node with
4334    one <tt>i32</tt> entry of value 1.  The existence of
4335    the <tt>!nontemporal</tt> metatadata on the instruction tells the optimizer
4336    and code generator that this load is not expected to be reused in the cache.
4337    The code generator may select special instructions to save cache bandwidth,
4338    such as the <tt>MOVNT</tt> instruction on x86.</p>
4339
4340 <h5>Semantics:</h5>
4341 <p>The location of memory pointed to is loaded.  If the value being loaded is of
4342    scalar type then the number of bytes read does not exceed the minimum number
4343    of bytes needed to hold all bits of the type.  For example, loading an
4344    <tt>i24</tt> reads at most three bytes.  When loading a value of a type like
4345    <tt>i20</tt> with a size that is not an integral number of bytes, the result
4346    is undefined if the value was not originally written using a store of the
4347    same type.</p>
4348
4349 <h5>Examples:</h5>
4350 <pre>
4351   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4352   <a href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
4353   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4354 </pre>
4355
4356 </div>
4357
4358 <!-- _______________________________________________________________________ -->
4359 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
4360 Instruction</a> </div>
4361
4362 <div class="doc_text">
4363
4364 <h5>Syntax:</h5>
4365 <pre>
4366   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>
4367   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>
4368 </pre>
4369
4370 <h5>Overview:</h5>
4371 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
4372
4373 <h5>Arguments:</h5>
4374 <p>There are two arguments to the '<tt>store</tt>' instruction: a value to store
4375    and an address at which to store it.  The type of the
4376    '<tt>&lt;pointer&gt;</tt>' operand must be a pointer to
4377    the <a href="#t_firstclass">first class</a> type of the
4378    '<tt>&lt;value&gt;</tt>' operand. If the <tt>store</tt> is marked as
4379    <tt>volatile</tt>, then the optimizer is not allowed to modify the number or
4380    order of execution of this <tt>store</tt> with other <a
4381    href="#volatile">volatile operations</a>.</p>
4382
4383 <p>The optional constant "align" argument specifies the alignment of the
4384    operation (that is, the alignment of the memory address). A value of 0 or an
4385    omitted "align" argument means that the operation has the preferential
4386    alignment for the target. It is the responsibility of the code emitter to
4387    ensure that the alignment information is correct. Overestimating the
4388    alignment results in an undefined behavior. Underestimating the alignment may
4389    produce less efficient code. An alignment of 1 is always safe.</p>
4390
4391 <p>The optional !nontemporal metadata must reference a single metatadata
4392    name &lt;index&gt; corresponding to a metadata node with one i32 entry of
4393    value 1.  The existence of the !nontemporal metatadata on the
4394    instruction tells the optimizer and code generator that this load is
4395    not expected to be reused in the cache.  The code generator may
4396    select special instructions to save cache bandwidth, such as the
4397    MOVNT instruction on x86.</p>
4398
4399
4400 <h5>Semantics:</h5>
4401 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>' at the
4402    location specified by the '<tt>&lt;pointer&gt;</tt>' operand.  If
4403    '<tt>&lt;value&gt;</tt>' is of scalar type then the number of bytes written
4404    does not exceed the minimum number of bytes needed to hold all bits of the
4405    type.  For example, storing an <tt>i24</tt> writes at most three bytes.  When
4406    writing a value of a type like <tt>i20</tt> with a size that is not an
4407    integral number of bytes, it is unspecified what happens to the extra bits
4408    that do not belong to the type, but they will typically be overwritten.</p>
4409
4410 <h5>Example:</h5>
4411 <pre>
4412   %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
4413   store i32 3, i32* %ptr                          <i>; yields {void}</i>
4414   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
4415 </pre>
4416
4417 </div>
4418
4419 <!-- _______________________________________________________________________ -->
4420 <div class="doc_subsubsection">
4421    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
4422 </div>
4423
4424 <div class="doc_text">
4425
4426 <h5>Syntax:</h5>
4427 <pre>
4428   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4429   &lt;result&gt; = getelementptr inbounds &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
4430 </pre>
4431
4432 <h5>Overview:</h5>
4433 <p>The '<tt>getelementptr</tt>' instruction is used to get the address of a
4434    subelement of an <a href="#t_aggregate">aggregate</a> data structure.
4435    It performs address calculation only and does not access memory.</p>
4436
4437 <h5>Arguments:</h5>
4438 <p>The first argument is always a pointer, and forms the basis of the
4439    calculation. The remaining arguments are indices that indicate which of the
4440    elements of the aggregate object are indexed. The interpretation of each
4441    index is dependent on the type being indexed into. The first index always
4442    indexes the pointer value given as the first argument, the second index
4443    indexes a value of the type pointed to (not necessarily the value directly
4444    pointed to, since the first index can be non-zero), etc. The first type
4445    indexed into must be a pointer value, subsequent types can be arrays,
4446    vectors, and structs. Note that subsequent types being indexed into
4447    can never be pointers, since that would require loading the pointer before
4448    continuing calculation.</p>
4449
4450 <p>The type of each index argument depends on the type it is indexing into.
4451    When indexing into a (optionally packed) structure, only <tt>i32</tt>
4452    integer <b>constants</b> are allowed.  When indexing into an array, pointer
4453    or vector, integers of any width are allowed, and they are not required to be
4454    constant.</p>
4455
4456 <p>For example, let's consider a C code fragment and how it gets compiled to
4457    LLVM:</p>
4458
4459 <pre class="doc_code">
4460 struct RT {
4461   char A;
4462   int B[10][20];
4463   char C;
4464 };
4465 struct ST {
4466   int X;
4467   double Y;
4468   struct RT Z;
4469 };
4470
4471 int *foo(struct ST *s) {
4472   return &amp;s[1].Z.B[5][13];
4473 }
4474 </pre>
4475
4476 <p>The LLVM code generated by the GCC frontend is:</p>
4477
4478 <pre class="doc_code">
4479 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
4480 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
4481
4482 define i32* @foo(%ST* %s) {
4483 entry:
4484   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
4485   ret i32* %reg
4486 }
4487 </pre>
4488
4489 <h5>Semantics:</h5>
4490 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
4491    type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
4492    }</tt>' type, a structure.  The second index indexes into the third element
4493    of the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
4494    i8 }</tt>' type, another structure.  The third index indexes into the second
4495    element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
4496    array.  The two dimensions of the array are subscripted into, yielding an
4497    '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a
4498    pointer to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
4499
4500 <p>Note that it is perfectly legal to index partially through a structure,
4501    returning a pointer to an inner element.  Because of this, the LLVM code for
4502    the given testcase is equivalent to:</p>
4503
4504 <pre>
4505   define i32* @foo(%ST* %s) {
4506     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
4507     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
4508     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
4509     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
4510     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
4511     ret i32* %t5
4512   }
4513 </pre>
4514
4515 <p>If the <tt>inbounds</tt> keyword is present, the result value of the
4516    <tt>getelementptr</tt> is a <a href="#trapvalues">trap value</a> if the
4517    base pointer is not an <i>in bounds</i> address of an allocated object,
4518    or if any of the addresses that would be formed by successive addition of
4519    the offsets implied by the indices to the base address with infinitely
4520    precise arithmetic are not an <i>in bounds</i> address of that allocated
4521    object. The <i>in bounds</i> addresses for an allocated object are all
4522    the addresses that point into the object, plus the address one byte past
4523    the end.</p>
4524
4525 <p>If the <tt>inbounds</tt> keyword is not present, the offsets are added to
4526    the base address with silently-wrapping two's complement arithmetic, and
4527    the result value of the <tt>getelementptr</tt> may be outside the object
4528    pointed to by the base pointer. The result value may not necessarily be
4529    used to access memory though, even if it happens to point into allocated
4530    storage. See the <a href="#pointeraliasing">Pointer Aliasing Rules</a>
4531    section for more information.</p>
4532
4533 <p>The getelementptr instruction is often confusing.  For some more insight into
4534    how it works, see <a href="GetElementPtr.html">the getelementptr FAQ</a>.</p>
4535
4536 <h5>Example:</h5>
4537 <pre>
4538     <i>; yields [12 x i8]*:aptr</i>
4539     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
4540     <i>; yields i8*:vptr</i>
4541     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
4542     <i>; yields i8*:eptr</i>
4543     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
4544     <i>; yields i32*:iptr</i>
4545     %iptr = getelementptr [10 x i32]* @arr, i16 0, i16 0
4546 </pre>
4547
4548 </div>
4549
4550 <!-- ======================================================================= -->
4551 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
4552 </div>
4553
4554 <div class="doc_text">
4555
4556 <p>The instructions in this category are the conversion instructions (casting)
4557    which all take a single operand and a type. They perform various bit
4558    conversions on the operand.</p>
4559
4560 </div>
4561
4562 <!-- _______________________________________________________________________ -->
4563 <div class="doc_subsubsection">
4564    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
4565 </div>
4566 <div class="doc_text">
4567
4568 <h5>Syntax:</h5>
4569 <pre>
4570   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4571 </pre>
4572
4573 <h5>Overview:</h5>
4574 <p>The '<tt>trunc</tt>' instruction truncates its operand to the
4575    type <tt>ty2</tt>.</p>
4576
4577 <h5>Arguments:</h5>
4578 <p>The '<tt>trunc</tt>' instruction takes a value to trunc, and a type to trunc it to.
4579    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4580    of the same number of integers.
4581    The bit size of the <tt>value</tt> must be larger than
4582    the bit size of the destination type, <tt>ty2</tt>.
4583    Equal sized types are not allowed.</p>
4584
4585 <h5>Semantics:</h5>
4586 <p>The '<tt>trunc</tt>' instruction truncates the high order bits
4587    in <tt>value</tt> and converts the remaining bits to <tt>ty2</tt>. Since the
4588    source size must be larger than the destination size, <tt>trunc</tt> cannot
4589    be a <i>no-op cast</i>.  It will always truncate bits.</p>
4590
4591 <h5>Example:</h5>
4592 <pre>
4593   %X = trunc i32 257 to i8                        <i>; yields i8:1</i>
4594   %Y = trunc i32 123 to i1                        <i>; yields i1:true</i>
4595   %Z = trunc i32 122 to i1                        <i>; yields i1:false</i>
4596   %W = trunc &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i8&gt; <i>; yields &lt;i8 8, i8 7&gt;</i>
4597 </pre>
4598
4599 </div>
4600
4601 <!-- _______________________________________________________________________ -->
4602 <div class="doc_subsubsection">
4603    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
4604 </div>
4605 <div class="doc_text">
4606
4607 <h5>Syntax:</h5>
4608 <pre>
4609   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4610 </pre>
4611
4612 <h5>Overview:</h5>
4613 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
4614    <tt>ty2</tt>.</p>
4615
4616
4617 <h5>Arguments:</h5>
4618 <p>The '<tt>zext</tt>' instruction takes a value to cast, and a type to cast it to.
4619    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4620    of the same number of integers.
4621    The bit size of the <tt>value</tt> must be smaller than
4622    the bit size of the destination type,
4623    <tt>ty2</tt>.</p>
4624
4625 <h5>Semantics:</h5>
4626 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
4627    bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
4628
4629 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
4630
4631 <h5>Example:</h5>
4632 <pre>
4633   %X = zext i32 257 to i64              <i>; yields i64:257</i>
4634   %Y = zext i1 true to i32              <i>; yields i32:1</i>
4635   %Z = zext &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i32&gt; <i>; yields &lt;i32 8, i32 7&gt;</i>
4636 </pre>
4637
4638 </div>
4639
4640 <!-- _______________________________________________________________________ -->
4641 <div class="doc_subsubsection">
4642    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
4643 </div>
4644 <div class="doc_text">
4645
4646 <h5>Syntax:</h5>
4647 <pre>
4648   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4649 </pre>
4650
4651 <h5>Overview:</h5>
4652 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
4653
4654 <h5>Arguments:</h5>
4655 <p>The '<tt>sext</tt>' instruction takes a value to cast, and a type to cast it to.
4656    Both types must be of <a href="#t_integer">integer</a> types, or vectors
4657    of the same number of integers.
4658    The bit size of the <tt>value</tt> must be smaller than
4659    the bit size of the destination type,
4660    <tt>ty2</tt>.</p>
4661
4662 <h5>Semantics:</h5>
4663 <p>The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
4664    bit (highest order bit) of the <tt>value</tt> until it reaches the bit size
4665    of the type <tt>ty2</tt>.</p>
4666
4667 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
4668
4669 <h5>Example:</h5>
4670 <pre>
4671   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
4672   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
4673   %Z = sext &lt;2 x i16&gt; &lt;i16 8, i16 7&gt; to &lt;2 x i32&gt; <i>; yields &lt;i32 8, i32 7&gt;</i>
4674 </pre>
4675
4676 </div>
4677
4678 <!-- _______________________________________________________________________ -->
4679 <div class="doc_subsubsection">
4680    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
4681 </div>
4682
4683 <div class="doc_text">
4684
4685 <h5>Syntax:</h5>
4686 <pre>
4687   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4688 </pre>
4689
4690 <h5>Overview:</h5>
4691 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
4692    <tt>ty2</tt>.</p>
4693
4694 <h5>Arguments:</h5>
4695 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
4696    point</a> value to cast and a <a href="#t_floating">floating point</a> type
4697    to cast it to. The size of <tt>value</tt> must be larger than the size of
4698    <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
4699    <i>no-op cast</i>.</p>
4700
4701 <h5>Semantics:</h5>
4702 <p>The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
4703    <a href="#t_floating">floating point</a> type to a smaller
4704    <a href="#t_floating">floating point</a> type.  If the value cannot fit
4705    within the destination type, <tt>ty2</tt>, then the results are
4706    undefined.</p>
4707
4708 <h5>Example:</h5>
4709 <pre>
4710   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
4711   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
4712 </pre>
4713
4714 </div>
4715
4716 <!-- _______________________________________________________________________ -->
4717 <div class="doc_subsubsection">
4718    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
4719 </div>
4720 <div class="doc_text">
4721
4722 <h5>Syntax:</h5>
4723 <pre>
4724   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4725 </pre>
4726
4727 <h5>Overview:</h5>
4728 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
4729    floating point value.</p>
4730
4731 <h5>Arguments:</h5>
4732 <p>The '<tt>fpext</tt>' instruction takes a
4733    <a href="#t_floating">floating point</a> <tt>value</tt> to cast, and
4734    a <a href="#t_floating">floating point</a> type to cast it to. The source
4735    type must be smaller than the destination type.</p>
4736
4737 <h5>Semantics:</h5>
4738 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
4739    <a href="#t_floating">floating point</a> type to a larger
4740    <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
4741    used to make a <i>no-op cast</i> because it always changes bits. Use
4742    <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
4743
4744 <h5>Example:</h5>
4745 <pre>
4746   %X = fpext float 3.1415 to double        <i>; yields double:3.1415</i>
4747   %Y = fpext float 1.0 to float            <i>; yields float:1.0 (no-op)</i>
4748 </pre>
4749
4750 </div>
4751
4752 <!-- _______________________________________________________________________ -->
4753 <div class="doc_subsubsection">
4754    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
4755 </div>
4756 <div class="doc_text">
4757
4758 <h5>Syntax:</h5>
4759 <pre>
4760   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4761 </pre>
4762
4763 <h5>Overview:</h5>
4764 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
4765    unsigned integer equivalent of type <tt>ty2</tt>.</p>
4766
4767 <h5>Arguments:</h5>
4768 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
4769    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4770    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4771    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4772    vector integer type with the same number of elements as <tt>ty</tt></p>
4773
4774 <h5>Semantics:</h5>
4775 <p>The '<tt>fptoui</tt>' instruction converts its
4776    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4777    towards zero) unsigned integer value. If the value cannot fit
4778    in <tt>ty2</tt>, the results are undefined.</p>
4779
4780 <h5>Example:</h5>
4781 <pre>
4782   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
4783   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
4784   %Z = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
4785 </pre>
4786
4787 </div>
4788
4789 <!-- _______________________________________________________________________ -->
4790 <div class="doc_subsubsection">
4791    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
4792 </div>
4793 <div class="doc_text">
4794
4795 <h5>Syntax:</h5>
4796 <pre>
4797   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4798 </pre>
4799
4800 <h5>Overview:</h5>
4801 <p>The '<tt>fptosi</tt>' instruction converts
4802    <a href="#t_floating">floating point</a> <tt>value</tt> to
4803    type <tt>ty2</tt>.</p>
4804
4805 <h5>Arguments:</h5>
4806 <p>The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
4807    scalar or vector <a href="#t_floating">floating point</a> value, and a type
4808    to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
4809    type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
4810    vector integer type with the same number of elements as <tt>ty</tt></p>
4811
4812 <h5>Semantics:</h5>
4813 <p>The '<tt>fptosi</tt>' instruction converts its
4814    <a href="#t_floating">floating point</a> operand into the nearest (rounding
4815    towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
4816    the results are undefined.</p>
4817
4818 <h5>Example:</h5>
4819 <pre>
4820   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
4821   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
4822   %Z = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
4823 </pre>
4824
4825 </div>
4826
4827 <!-- _______________________________________________________________________ -->
4828 <div class="doc_subsubsection">
4829    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
4830 </div>
4831 <div class="doc_text">
4832
4833 <h5>Syntax:</h5>
4834 <pre>
4835   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4836 </pre>
4837
4838 <h5>Overview:</h5>
4839 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
4840    integer and converts that value to the <tt>ty2</tt> type.</p>
4841
4842 <h5>Arguments:</h5>
4843 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
4844    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4845    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4846    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4847    floating point type with the same number of elements as <tt>ty</tt></p>
4848
4849 <h5>Semantics:</h5>
4850 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
4851    integer quantity and converts it to the corresponding floating point
4852    value. If the value cannot fit in the floating point value, the results are
4853    undefined.</p>
4854
4855 <h5>Example:</h5>
4856 <pre>
4857   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
4858   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
4859 </pre>
4860
4861 </div>
4862
4863 <!-- _______________________________________________________________________ -->
4864 <div class="doc_subsubsection">
4865    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
4866 </div>
4867 <div class="doc_text">
4868
4869 <h5>Syntax:</h5>
4870 <pre>
4871   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4872 </pre>
4873
4874 <h5>Overview:</h5>
4875 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed integer
4876    and converts that value to the <tt>ty2</tt> type.</p>
4877
4878 <h5>Arguments:</h5>
4879 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
4880    scalar or vector <a href="#t_integer">integer</a> value, and a type to cast
4881    it to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
4882    type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
4883    floating point type with the same number of elements as <tt>ty</tt></p>
4884
4885 <h5>Semantics:</h5>
4886 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed integer
4887    quantity and converts it to the corresponding floating point value. If the
4888    value cannot fit in the floating point value, the results are undefined.</p>
4889
4890 <h5>Example:</h5>
4891 <pre>
4892   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
4893   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
4894 </pre>
4895
4896 </div>
4897
4898 <!-- _______________________________________________________________________ -->
4899 <div class="doc_subsubsection">
4900    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
4901 </div>
4902 <div class="doc_text">
4903
4904 <h5>Syntax:</h5>
4905 <pre>
4906   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4907 </pre>
4908
4909 <h5>Overview:</h5>
4910 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
4911    the integer type <tt>ty2</tt>.</p>
4912
4913 <h5>Arguments:</h5>
4914 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
4915    must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
4916    <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
4917
4918 <h5>Semantics:</h5>
4919 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
4920    <tt>ty2</tt> by interpreting the pointer value as an integer and either
4921    truncating or zero extending that value to the size of the integer type. If
4922    <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
4923    <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
4924    are the same size, then nothing is done (<i>no-op cast</i>) other than a type
4925    change.</p>
4926
4927 <h5>Example:</h5>
4928 <pre>
4929   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
4930   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
4931 </pre>
4932
4933 </div>
4934
4935 <!-- _______________________________________________________________________ -->
4936 <div class="doc_subsubsection">
4937    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
4938 </div>
4939 <div class="doc_text">
4940
4941 <h5>Syntax:</h5>
4942 <pre>
4943   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4944 </pre>
4945
4946 <h5>Overview:</h5>
4947 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to a
4948    pointer type, <tt>ty2</tt>.</p>
4949
4950 <h5>Arguments:</h5>
4951 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
4952    value to cast, and a type to cast it to, which must be a
4953    <a href="#t_pointer">pointer</a> type.</p>
4954
4955 <h5>Semantics:</h5>
4956 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
4957    <tt>ty2</tt> by applying either a zero extension or a truncation depending on
4958    the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
4959    size of a pointer then a truncation is done. If <tt>value</tt> is smaller
4960    than the size of a pointer then a zero extension is done. If they are the
4961    same size, nothing is done (<i>no-op cast</i>).</p>
4962
4963 <h5>Example:</h5>
4964 <pre>
4965   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
4966   %Y = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
4967   %Z = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
4968 </pre>
4969
4970 </div>
4971
4972 <!-- _______________________________________________________________________ -->
4973 <div class="doc_subsubsection">
4974    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
4975 </div>
4976 <div class="doc_text">
4977
4978 <h5>Syntax:</h5>
4979 <pre>
4980   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4981 </pre>
4982
4983 <h5>Overview:</h5>
4984 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4985    <tt>ty2</tt> without changing any bits.</p>
4986
4987 <h5>Arguments:</h5>
4988 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be a
4989    non-aggregate first class value, and a type to cast it to, which must also be
4990    a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes
4991    of <tt>value</tt> and the destination type, <tt>ty2</tt>, must be
4992    identical. If the source type is a pointer, the destination type must also be
4993    a pointer.  This instruction supports bitwise conversion of vectors to
4994    integers and to vectors of other types (as long as they have the same
4995    size).</p>
4996
4997 <h5>Semantics:</h5>
4998 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4999    <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
5000    this conversion.  The conversion is done as if the <tt>value</tt> had been
5001    stored to memory and read back as type <tt>ty2</tt>. Pointer types may only
5002    be converted to other pointer types with this instruction. To convert
5003    pointers to other types, use the <a href="#i_inttoptr">inttoptr</a> or
5004    <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
5005
5006 <h5>Example:</h5>
5007 <pre>
5008   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
5009   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
5010   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
5011 </pre>
5012
5013 </div>
5014
5015 <!-- ======================================================================= -->
5016 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
5017
5018 <div class="doc_text">
5019
5020 <p>The instructions in this category are the "miscellaneous" instructions, which
5021    defy better classification.</p>
5022
5023 </div>
5024
5025 <!-- _______________________________________________________________________ -->
5026 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
5027 </div>
5028
5029 <div class="doc_text">
5030
5031 <h5>Syntax:</h5>
5032 <pre>
5033   &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>
5034 </pre>
5035
5036 <h5>Overview:</h5>
5037 <p>The '<tt>icmp</tt>' instruction returns a boolean value or a vector of
5038    boolean values based on comparison of its two integer, integer vector, or
5039    pointer operands.</p>
5040
5041 <h5>Arguments:</h5>
5042 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
5043    the condition code indicating the kind of comparison to perform. It is not a
5044    value, just a keyword. The possible condition code are:</p>
5045
5046 <ol>
5047   <li><tt>eq</tt>: equal</li>
5048   <li><tt>ne</tt>: not equal </li>
5049   <li><tt>ugt</tt>: unsigned greater than</li>
5050   <li><tt>uge</tt>: unsigned greater or equal</li>
5051   <li><tt>ult</tt>: unsigned less than</li>
5052   <li><tt>ule</tt>: unsigned less or equal</li>
5053   <li><tt>sgt</tt>: signed greater than</li>
5054   <li><tt>sge</tt>: signed greater or equal</li>
5055   <li><tt>slt</tt>: signed less than</li>
5056   <li><tt>sle</tt>: signed less or equal</li>
5057 </ol>
5058
5059 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
5060    <a href="#t_pointer">pointer</a> or integer <a href="#t_vector">vector</a>
5061    typed.  They must also be identical types.</p>
5062
5063 <h5>Semantics:</h5>
5064 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to the
5065    condition code given as <tt>cond</tt>. The comparison performed always yields
5066    either an <a href="#t_integer"><tt>i1</tt></a> or vector of <tt>i1</tt>
5067    result, as follows:</p>
5068
5069 <ol>
5070   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
5071       <tt>false</tt> otherwise. No sign interpretation is necessary or
5072       performed.</li>
5073
5074   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
5075       <tt>false</tt> otherwise. No sign interpretation is necessary or
5076       performed.</li>
5077
5078   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
5079       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5080
5081   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
5082       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5083       to <tt>op2</tt>.</li>
5084
5085   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
5086       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5087
5088   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
5089       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5090
5091   <li><tt>sgt</tt>: interprets the operands as signed values and yields
5092       <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5093
5094   <li><tt>sge</tt>: interprets the operands as signed values and yields
5095       <tt>true</tt> if <tt>op1</tt> is greater than or equal
5096       to <tt>op2</tt>.</li>
5097
5098   <li><tt>slt</tt>: interprets the operands as signed values and yields
5099       <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
5100
5101   <li><tt>sle</tt>: interprets the operands as signed values and yields
5102       <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5103 </ol>
5104
5105 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
5106    values are compared as if they were integers.</p>
5107
5108 <p>If the operands are integer vectors, then they are compared element by
5109    element. The result is an <tt>i1</tt> vector with the same number of elements
5110    as the values being compared.  Otherwise, the result is an <tt>i1</tt>.</p>
5111
5112 <h5>Example:</h5>
5113 <pre>
5114   &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
5115   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
5116   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
5117   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
5118   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
5119   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
5120 </pre>
5121
5122 <p>Note that the code generator does not yet support vector types with
5123    the <tt>icmp</tt> instruction.</p>
5124
5125 </div>
5126
5127 <!-- _______________________________________________________________________ -->
5128 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
5129 </div>
5130
5131 <div class="doc_text">
5132
5133 <h5>Syntax:</h5>
5134 <pre>
5135   &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>
5136 </pre>
5137
5138 <h5>Overview:</h5>
5139 <p>The '<tt>fcmp</tt>' instruction returns a boolean value or vector of boolean
5140    values based on comparison of its operands.</p>
5141
5142 <p>If the operands are floating point scalars, then the result type is a boolean
5143 (<a href="#t_integer"><tt>i1</tt></a>).</p>
5144
5145 <p>If the operands are floating point vectors, then the result type is a vector
5146    of boolean with the same number of elements as the operands being
5147    compared.</p>
5148
5149 <h5>Arguments:</h5>
5150 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
5151    the condition code indicating the kind of comparison to perform. It is not a
5152    value, just a keyword. The possible condition code are:</p>
5153
5154 <ol>
5155   <li><tt>false</tt>: no comparison, always returns false</li>
5156   <li><tt>oeq</tt>: ordered and equal</li>
5157   <li><tt>ogt</tt>: ordered and greater than </li>
5158   <li><tt>oge</tt>: ordered and greater than or equal</li>
5159   <li><tt>olt</tt>: ordered and less than </li>
5160   <li><tt>ole</tt>: ordered and less than or equal</li>
5161   <li><tt>one</tt>: ordered and not equal</li>
5162   <li><tt>ord</tt>: ordered (no nans)</li>
5163   <li><tt>ueq</tt>: unordered or equal</li>
5164   <li><tt>ugt</tt>: unordered or greater than </li>
5165   <li><tt>uge</tt>: unordered or greater than or equal</li>
5166   <li><tt>ult</tt>: unordered or less than </li>
5167   <li><tt>ule</tt>: unordered or less than or equal</li>
5168   <li><tt>une</tt>: unordered or not equal</li>
5169   <li><tt>uno</tt>: unordered (either nans)</li>
5170   <li><tt>true</tt>: no comparison, always returns true</li>
5171 </ol>
5172
5173 <p><i>Ordered</i> means that neither operand is a QNAN while
5174    <i>unordered</i> means that either operand may be a QNAN.</p>
5175
5176 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be either
5177    a <a href="#t_floating">floating point</a> type or
5178    a <a href="#t_vector">vector</a> of floating point type.  They must have
5179    identical types.</p>
5180
5181 <h5>Semantics:</h5>
5182 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
5183    according to the condition code given as <tt>cond</tt>.  If the operands are
5184    vectors, then the vectors are compared element by element.  Each comparison
5185    performed always yields an <a href="#t_integer">i1</a> result, as
5186    follows:</p>
5187
5188 <ol>
5189   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
5190
5191   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5192       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5193
5194   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5195       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5196
5197   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5198       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5199
5200   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5201       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5202
5203   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5204       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5205
5206   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
5207       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5208
5209   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
5210
5211   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
5212       <tt>op1</tt> is equal to <tt>op2</tt>.</li>
5213
5214   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
5215       <tt>op1</tt> is greater than <tt>op2</tt>.</li>
5216
5217   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
5218       <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
5219
5220   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
5221       <tt>op1</tt> is less than <tt>op2</tt>.</li>
5222
5223   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
5224       <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
5225
5226   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
5227       <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
5228
5229   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
5230
5231   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
5232 </ol>
5233
5234 <h5>Example:</h5>
5235 <pre>
5236   &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
5237   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
5238   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
5239   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
5240 </pre>
5241
5242 <p>Note that the code generator does not yet support vector types with
5243    the <tt>fcmp</tt> instruction.</p>
5244
5245 </div>
5246
5247 <!-- _______________________________________________________________________ -->
5248 <div class="doc_subsubsection">
5249   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
5250 </div>
5251
5252 <div class="doc_text">
5253
5254 <h5>Syntax:</h5>
5255 <pre>
5256   &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...
5257 </pre>
5258
5259 <h5>Overview:</h5>
5260 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in the
5261    SSA graph representing the function.</p>
5262
5263 <h5>Arguments:</h5>
5264 <p>The type of the incoming values is specified with the first type field. After
5265    this, the '<tt>phi</tt>' instruction takes a list of pairs as arguments, with
5266    one pair for each predecessor basic block of the current block.  Only values
5267    of <a href="#t_firstclass">first class</a> type may be used as the value
5268    arguments to the PHI node.  Only labels may be used as the label
5269    arguments.</p>
5270
5271 <p>There must be no non-phi instructions between the start of a basic block and
5272    the PHI instructions: i.e. PHI instructions must be first in a basic
5273    block.</p>
5274
5275 <p>For the purposes of the SSA form, the use of each incoming value is deemed to
5276    occur on the edge from the corresponding predecessor block to the current
5277    block (but after any definition of an '<tt>invoke</tt>' instruction's return
5278    value on the same edge).</p>
5279
5280 <h5>Semantics:</h5>
5281 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
5282    specified by the pair corresponding to the predecessor basic block that
5283    executed just prior to the current block.</p>
5284
5285 <h5>Example:</h5>
5286 <pre>
5287 Loop:       ; Infinite loop that counts from 0 on up...
5288   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
5289   %nextindvar = add i32 %indvar, 1
5290   br label %Loop
5291 </pre>
5292
5293 </div>
5294
5295 <!-- _______________________________________________________________________ -->
5296 <div class="doc_subsubsection">
5297    <a name="i_select">'<tt>select</tt>' Instruction</a>
5298 </div>
5299
5300 <div class="doc_text">
5301
5302 <h5>Syntax:</h5>
5303 <pre>
5304   &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>
5305
5306   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
5307 </pre>
5308
5309 <h5>Overview:</h5>
5310 <p>The '<tt>select</tt>' instruction is used to choose one value based on a
5311    condition, without branching.</p>
5312
5313
5314 <h5>Arguments:</h5>
5315 <p>The '<tt>select</tt>' instruction requires an 'i1' value or a vector of 'i1'
5316    values indicating the condition, and two values of the
5317    same <a href="#t_firstclass">first class</a> type.  If the val1/val2 are
5318    vectors and the condition is a scalar, then entire vectors are selected, not
5319    individual elements.</p>
5320
5321 <h5>Semantics:</h5>
5322 <p>If the condition is an i1 and it evaluates to 1, the instruction returns the
5323    first value argument; otherwise, it returns the second value argument.</p>
5324
5325 <p>If the condition is a vector of i1, then the value arguments must be vectors
5326    of the same size, and the selection is done element by element.</p>
5327
5328 <h5>Example:</h5>
5329 <pre>
5330   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
5331 </pre>
5332
5333 <p>Note that the code generator does not yet support conditions
5334    with vector type.</p>
5335
5336 </div>
5337
5338 <!-- _______________________________________________________________________ -->
5339 <div class="doc_subsubsection">
5340   <a name="i_call">'<tt>call</tt>' Instruction</a>
5341 </div>
5342
5343 <div class="doc_text">
5344
5345 <h5>Syntax:</h5>
5346 <pre>
5347   &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>]
5348 </pre>
5349
5350 <h5>Overview:</h5>
5351 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
5352
5353 <h5>Arguments:</h5>
5354 <p>This instruction requires several arguments:</p>
5355
5356 <ol>
5357   <li>The optional "tail" marker indicates that the callee function does not
5358       access any allocas or varargs in the caller.  Note that calls may be
5359       marked "tail" even if they do not occur before
5360       a <a href="#i_ret"><tt>ret</tt></a> instruction.  If the "tail" marker is
5361       present, the function call is eligible for tail call optimization,
5362       but <a href="CodeGenerator.html#tailcallopt">might not in fact be
5363       optimized into a jump</a>.  The code generator may optimize calls marked
5364       "tail" with either 1) automatic <a href="CodeGenerator.html#sibcallopt">
5365       sibling call optimization</a> when the caller and callee have
5366       matching signatures, or 2) forced tail call optimization when the
5367       following extra requirements are met:
5368       <ul>
5369         <li>Caller and callee both have the calling
5370             convention <tt>fastcc</tt>.</li>
5371         <li>The call is in tail position (ret immediately follows call and ret
5372             uses value of call or is void).</li>
5373         <li>Option <tt>-tailcallopt</tt> is enabled,
5374             or <code>llvm::GuaranteedTailCallOpt</code> is <code>true</code>.</li>
5375         <li><a href="CodeGenerator.html#tailcallopt">Platform specific
5376             constraints are met.</a></li>
5377       </ul>
5378   </li>
5379
5380   <li>The optional "cconv" marker indicates which <a href="#callingconv">calling
5381       convention</a> the call should use.  If none is specified, the call
5382       defaults to using C calling conventions.  The calling convention of the
5383       call must match the calling convention of the target function, or else the
5384       behavior is undefined.</li>
5385
5386   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
5387       return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>', and
5388       '<tt>inreg</tt>' attributes are valid here.</li>
5389
5390   <li>'<tt>ty</tt>': the type of the call instruction itself which is also the
5391       type of the return value.  Functions that return no value are marked
5392       <tt><a href="#t_void">void</a></tt>.</li>
5393
5394   <li>'<tt>fnty</tt>': shall be the signature of the pointer to function value
5395       being invoked.  The argument types must match the types implied by this
5396       signature.  This type can be omitted if the function is not varargs and if
5397       the function type does not return a pointer to a function.</li>
5398
5399   <li>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
5400       be invoked. In most cases, this is a direct function invocation, but
5401       indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
5402       to function value.</li>
5403
5404   <li>'<tt>function args</tt>': argument list whose types match the function
5405       signature argument types and parameter attributes. All arguments must be
5406       of <a href="#t_firstclass">first class</a> type. If the function
5407       signature indicates the function accepts a variable number of arguments,
5408       the extra arguments can be specified.</li>
5409
5410   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
5411       '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
5412       '<tt>readnone</tt>' attributes are valid here.</li>
5413 </ol>
5414
5415 <h5>Semantics:</h5>
5416 <p>The '<tt>call</tt>' instruction is used to cause control flow to transfer to
5417    a specified function, with its incoming arguments bound to the specified
5418    values. Upon a '<tt><a href="#i_ret">ret</a></tt>' instruction in the called
5419    function, control flow continues with the instruction after the function
5420    call, and the return value of the function is bound to the result
5421    argument.</p>
5422
5423 <h5>Example:</h5>
5424 <pre>
5425   %retval = call i32 @test(i32 %argc)
5426   call i32 (i8*, ...)* @printf(i8* %msg, i32 12, i8 42)        <i>; yields i32</i>
5427   %X = tail call i32 @foo()                                    <i>; yields i32</i>
5428   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
5429   call void %foo(i8 97 signext)
5430
5431   %struct.A = type { i32, i8 }
5432   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
5433   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
5434   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
5435   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
5436   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
5437 </pre>
5438
5439 <p>llvm treats calls to some functions with names and arguments that match the
5440 standard C99 library as being the C99 library functions, and may perform
5441 optimizations or generate code for them under that assumption.  This is
5442 something we'd like to change in the future to provide better support for
5443 freestanding environments and non-C-based languages.</p>
5444
5445 </div>
5446
5447 <!-- _______________________________________________________________________ -->
5448 <div class="doc_subsubsection">
5449   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
5450 </div>
5451
5452 <div class="doc_text">
5453
5454 <h5>Syntax:</h5>
5455 <pre>
5456   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
5457 </pre>
5458
5459 <h5>Overview:</h5>
5460 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
5461    the "variable argument" area of a function call.  It is used to implement the
5462    <tt>va_arg</tt> macro in C.</p>
5463
5464 <h5>Arguments:</h5>
5465 <p>This instruction takes a <tt>va_list*</tt> value and the type of the
5466    argument. It returns a value of the specified argument type and increments
5467    the <tt>va_list</tt> to point to the next argument.  The actual type
5468    of <tt>va_list</tt> is target specific.</p>
5469
5470 <h5>Semantics:</h5>
5471 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified type
5472    from the specified <tt>va_list</tt> and causes the <tt>va_list</tt> to point
5473    to the next argument.  For more information, see the variable argument
5474    handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
5475
5476 <p>It is legal for this instruction to be called in a function which does not
5477    take a variable number of arguments, for example, the <tt>vfprintf</tt>
5478    function.</p>
5479
5480 <p><tt>va_arg</tt> is an LLVM instruction instead of
5481    an <a href="#intrinsics">intrinsic function</a> because it takes a type as an
5482    argument.</p>
5483
5484 <h5>Example:</h5>
5485 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
5486
5487 <p>Note that the code generator does not yet fully support va_arg on many
5488    targets. Also, it does not currently support va_arg with aggregate types on
5489    any target.</p>
5490
5491 </div>
5492
5493 <!-- *********************************************************************** -->
5494 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
5495 <!-- *********************************************************************** -->
5496
5497 <div class="doc_text">
5498
5499 <p>LLVM supports the notion of an "intrinsic function".  These functions have
5500    well known names and semantics and are required to follow certain
5501    restrictions.  Overall, these intrinsics represent an extension mechanism for
5502    the LLVM language that does not require changing all of the transformations
5503    in LLVM when adding to the language (or the bitcode reader/writer, the
5504    parser, etc...).</p>
5505
5506 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
5507    prefix is reserved in LLVM for intrinsic names; thus, function names may not
5508    begin with this prefix.  Intrinsic functions must always be external
5509    functions: you cannot define the body of intrinsic functions.  Intrinsic
5510    functions may only be used in call or invoke instructions: it is illegal to
5511    take the address of an intrinsic function.  Additionally, because intrinsic
5512    functions are part of the LLVM language, it is required if any are added that
5513    they be documented here.</p>
5514
5515 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents a
5516    family of functions that perform the same operation but on different data
5517    types. Because LLVM can represent over 8 million different integer types,
5518    overloading is used commonly to allow an intrinsic function to operate on any
5519    integer type. One or more of the argument types or the result type can be
5520    overloaded to accept any integer type. Argument types may also be defined as
5521    exactly matching a previous argument's type or the result type. This allows
5522    an intrinsic function which accepts multiple arguments, but needs all of them
5523    to be of the same type, to only be overloaded with respect to a single
5524    argument or the result.</p>
5525
5526 <p>Overloaded intrinsics will have the names of its overloaded argument types
5527    encoded into its function name, each preceded by a period. Only those types
5528    which are overloaded result in a name suffix. Arguments whose type is matched
5529    against another type do not. For example, the <tt>llvm.ctpop</tt> function
5530    can take an integer of any width and returns an integer of exactly the same
5531    integer width. This leads to a family of functions such as
5532    <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29
5533    %val)</tt>.  Only one type, the return type, is overloaded, and only one type
5534    suffix is required. Because the argument's type is matched against the return
5535    type, it does not require its own name suffix.</p>
5536
5537 <p>To learn how to add an intrinsic function, please see the
5538    <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.</p>
5539
5540 </div>
5541
5542 <!-- ======================================================================= -->
5543 <div class="doc_subsection">
5544   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
5545 </div>
5546
5547 <div class="doc_text">
5548
5549 <p>Variable argument support is defined in LLVM with
5550    the <a href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
5551    intrinsic functions.  These functions are related to the similarly named
5552    macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
5553
5554 <p>All of these functions operate on arguments that use a target-specific value
5555    type "<tt>va_list</tt>".  The LLVM assembly language reference manual does
5556    not define what this type is, so all transformations should be prepared to
5557    handle these functions regardless of the type used.</p>
5558
5559 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
5560    instruction and the variable argument handling intrinsic functions are
5561    used.</p>
5562
5563 <pre class="doc_code">
5564 define i32 @test(i32 %X, ...) {
5565   ; Initialize variable argument processing
5566   %ap = alloca i8*
5567   %ap2 = bitcast i8** %ap to i8*
5568   call void @llvm.va_start(i8* %ap2)
5569
5570   ; Read a single integer argument
5571   %tmp = va_arg i8** %ap, i32
5572
5573   ; Demonstrate usage of llvm.va_copy and llvm.va_end
5574   %aq = alloca i8*
5575   %aq2 = bitcast i8** %aq to i8*
5576   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
5577   call void @llvm.va_end(i8* %aq2)
5578
5579   ; Stop processing of arguments.
5580   call void @llvm.va_end(i8* %ap2)
5581   ret i32 %tmp
5582 }
5583
5584 declare void @llvm.va_start(i8*)
5585 declare void @llvm.va_copy(i8*, i8*)
5586 declare void @llvm.va_end(i8*)
5587 </pre>
5588
5589 </div>
5590
5591 <!-- _______________________________________________________________________ -->
5592 <div class="doc_subsubsection">
5593   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
5594 </div>
5595
5596
5597 <div class="doc_text">
5598
5599 <h5>Syntax:</h5>
5600 <pre>
5601   declare void %llvm.va_start(i8* &lt;arglist&gt;)
5602 </pre>
5603
5604 <h5>Overview:</h5>
5605 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes <tt>*&lt;arglist&gt;</tt>
5606    for subsequent use by <tt><a href="#i_va_arg">va_arg</a></tt>.</p>
5607
5608 <h5>Arguments:</h5>
5609 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
5610
5611 <h5>Semantics:</h5>
5612 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
5613    macro available in C.  In a target-dependent way, it initializes
5614    the <tt>va_list</tt> element to which the argument points, so that the next
5615    call to <tt>va_arg</tt> will produce the first variable argument passed to
5616    the function.  Unlike the C <tt>va_start</tt> macro, this intrinsic does not
5617    need to know the last argument of the function as the compiler can figure
5618    that out.</p>
5619
5620 </div>
5621
5622 <!-- _______________________________________________________________________ -->
5623 <div class="doc_subsubsection">
5624  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
5625 </div>
5626
5627 <div class="doc_text">
5628
5629 <h5>Syntax:</h5>
5630 <pre>
5631   declare void @llvm.va_end(i8* &lt;arglist&gt;)
5632 </pre>
5633
5634 <h5>Overview:</h5>
5635 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
5636    which has been initialized previously
5637    with <tt><a href="#int_va_start">llvm.va_start</a></tt>
5638    or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
5639
5640 <h5>Arguments:</h5>
5641 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
5642
5643 <h5>Semantics:</h5>
5644 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
5645    macro available in C.  In a target-dependent way, it destroys
5646    the <tt>va_list</tt> element to which the argument points.  Calls
5647    to <a href="#int_va_start"><tt>llvm.va_start</tt></a>
5648    and <a href="#int_va_copy"> <tt>llvm.va_copy</tt></a> must be matched exactly
5649    with calls to <tt>llvm.va_end</tt>.</p>
5650
5651 </div>
5652
5653 <!-- _______________________________________________________________________ -->
5654 <div class="doc_subsubsection">
5655   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
5656 </div>
5657
5658 <div class="doc_text">
5659
5660 <h5>Syntax:</h5>
5661 <pre>
5662   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
5663 </pre>
5664
5665 <h5>Overview:</h5>
5666 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
5667    from the source argument list to the destination argument list.</p>
5668
5669 <h5>Arguments:</h5>
5670 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
5671    The second argument is a pointer to a <tt>va_list</tt> element to copy
5672    from.</p>
5673
5674 <h5>Semantics:</h5>
5675 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
5676    macro available in C.  In a target-dependent way, it copies the
5677    source <tt>va_list</tt> element into the destination <tt>va_list</tt>
5678    element.  This intrinsic is necessary because
5679    the <tt><a href="#int_va_start"> llvm.va_start</a></tt> intrinsic may be
5680    arbitrarily complex and require, for example, memory allocation.</p>
5681
5682 </div>
5683
5684 <!-- ======================================================================= -->
5685 <div class="doc_subsection">
5686   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
5687 </div>
5688
5689 <div class="doc_text">
5690
5691 <p>LLVM support for <a href="GarbageCollection.html">Accurate Garbage
5692 Collection</a> (GC) requires the implementation and generation of these
5693 intrinsics. These intrinsics allow identification of <a href="#int_gcroot">GC
5694 roots on the stack</a>, as well as garbage collector implementations that
5695 require <a href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a>
5696 barriers.  Front-ends for type-safe garbage collected languages should generate
5697 these intrinsics to make use of the LLVM garbage collectors.  For more details,
5698 see <a href="GarbageCollection.html">Accurate Garbage Collection with
5699 LLVM</a>.</p>
5700
5701 <p>The garbage collection intrinsics only operate on objects in the generic
5702    address space (address space zero).</p>
5703
5704 </div>
5705
5706 <!-- _______________________________________________________________________ -->
5707 <div class="doc_subsubsection">
5708   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
5709 </div>
5710
5711 <div class="doc_text">
5712
5713 <h5>Syntax:</h5>
5714 <pre>
5715   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
5716 </pre>
5717
5718 <h5>Overview:</h5>
5719 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
5720    the code generator, and allows some metadata to be associated with it.</p>
5721
5722 <h5>Arguments:</h5>
5723 <p>The first argument specifies the address of a stack object that contains the
5724    root pointer.  The second pointer (which must be either a constant or a
5725    global value address) contains the meta-data to be associated with the
5726    root.</p>
5727
5728 <h5>Semantics:</h5>
5729 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
5730    location.  At compile-time, the code generator generates information to allow
5731    the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
5732    intrinsic may only be used in a function which <a href="#gc">specifies a GC
5733    algorithm</a>.</p>
5734
5735 </div>
5736
5737 <!-- _______________________________________________________________________ -->
5738 <div class="doc_subsubsection">
5739   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
5740 </div>
5741
5742 <div class="doc_text">
5743
5744 <h5>Syntax:</h5>
5745 <pre>
5746   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
5747 </pre>
5748
5749 <h5>Overview:</h5>
5750 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
5751    locations, allowing garbage collector implementations that require read
5752    barriers.</p>
5753
5754 <h5>Arguments:</h5>
5755 <p>The second argument is the address to read from, which should be an address
5756    allocated from the garbage collector.  The first object is a pointer to the
5757    start of the referenced object, if needed by the language runtime (otherwise
5758    null).</p>
5759
5760 <h5>Semantics:</h5>
5761 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
5762    instruction, but may be replaced with substantially more complex code by the
5763    garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
5764    may only be used in a function which <a href="#gc">specifies a GC
5765    algorithm</a>.</p>
5766
5767 </div>
5768
5769 <!-- _______________________________________________________________________ -->
5770 <div class="doc_subsubsection">
5771   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
5772 </div>
5773
5774 <div class="doc_text">
5775
5776 <h5>Syntax:</h5>
5777 <pre>
5778   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
5779 </pre>
5780
5781 <h5>Overview:</h5>
5782 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
5783    locations, allowing garbage collector implementations that require write
5784    barriers (such as generational or reference counting collectors).</p>
5785
5786 <h5>Arguments:</h5>
5787 <p>The first argument is the reference to store, the second is the start of the
5788    object to store it to, and the third is the address of the field of Obj to
5789    store to.  If the runtime does not require a pointer to the object, Obj may
5790    be null.</p>
5791
5792 <h5>Semantics:</h5>
5793 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
5794    instruction, but may be replaced with substantially more complex code by the
5795    garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
5796    may only be used in a function which <a href="#gc">specifies a GC
5797    algorithm</a>.</p>
5798
5799 </div>
5800
5801 <!-- ======================================================================= -->
5802 <div class="doc_subsection">
5803   <a name="int_codegen">Code Generator Intrinsics</a>
5804 </div>
5805
5806 <div class="doc_text">
5807
5808 <p>These intrinsics are provided by LLVM to expose special features that may
5809    only be implemented with code generator support.</p>
5810
5811 </div>
5812
5813 <!-- _______________________________________________________________________ -->
5814 <div class="doc_subsubsection">
5815   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
5816 </div>
5817
5818 <div class="doc_text">
5819
5820 <h5>Syntax:</h5>
5821 <pre>
5822   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
5823 </pre>
5824
5825 <h5>Overview:</h5>
5826 <p>The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
5827    target-specific value indicating the return address of the current function
5828    or one of its callers.</p>
5829
5830 <h5>Arguments:</h5>
5831 <p>The argument to this intrinsic indicates which function to return the address
5832    for.  Zero indicates the calling function, one indicates its caller, etc.
5833    The argument is <b>required</b> to be a constant integer value.</p>
5834
5835 <h5>Semantics:</h5>
5836 <p>The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer
5837    indicating the return address of the specified call frame, or zero if it
5838    cannot be identified.  The value returned by this intrinsic is likely to be
5839    incorrect or 0 for arguments other than zero, so it should only be used for
5840    debugging purposes.</p>
5841
5842 <p>Note that calling this intrinsic does not prevent function inlining or other
5843    aggressive transformations, so the value returned may not be that of the
5844    obvious source-language caller.</p>
5845
5846 </div>
5847
5848 <!-- _______________________________________________________________________ -->
5849 <div class="doc_subsubsection">
5850   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
5851 </div>
5852
5853 <div class="doc_text">
5854
5855 <h5>Syntax:</h5>
5856 <pre>
5857   declare i8* @llvm.frameaddress(i32 &lt;level&gt;)
5858 </pre>
5859
5860 <h5>Overview:</h5>
5861 <p>The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
5862    target-specific frame pointer value for the specified stack frame.</p>
5863
5864 <h5>Arguments:</h5>
5865 <p>The argument to this intrinsic indicates which function to return the frame
5866    pointer for.  Zero indicates the calling function, one indicates its caller,
5867    etc.  The argument is <b>required</b> to be a constant integer value.</p>
5868
5869 <h5>Semantics:</h5>
5870 <p>The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer
5871    indicating the frame address of the specified call frame, or zero if it
5872    cannot be identified.  The value returned by this intrinsic is likely to be
5873    incorrect or 0 for arguments other than zero, so it should only be used for
5874    debugging purposes.</p>
5875
5876 <p>Note that calling this intrinsic does not prevent function inlining or other
5877    aggressive transformations, so the value returned may not be that of the
5878    obvious source-language caller.</p>
5879
5880 </div>
5881
5882 <!-- _______________________________________________________________________ -->
5883 <div class="doc_subsubsection">
5884   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
5885 </div>
5886
5887 <div class="doc_text">
5888
5889 <h5>Syntax:</h5>
5890 <pre>
5891   declare i8* @llvm.stacksave()
5892 </pre>
5893
5894 <h5>Overview:</h5>
5895 <p>The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state
5896    of the function stack, for use
5897    with <a href="#int_stackrestore"> <tt>llvm.stackrestore</tt></a>.  This is
5898    useful for implementing language features like scoped automatic variable
5899    sized arrays in C99.</p>
5900
5901 <h5>Semantics:</h5>
5902 <p>This intrinsic returns a opaque pointer value that can be passed
5903    to <a href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When
5904    an <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved
5905    from <tt>llvm.stacksave</tt>, it effectively restores the state of the stack
5906    to the state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.
5907    In practice, this pops any <a href="#i_alloca">alloca</a> blocks from the
5908    stack that were allocated after the <tt>llvm.stacksave</tt> was executed.</p>
5909
5910 </div>
5911
5912 <!-- _______________________________________________________________________ -->
5913 <div class="doc_subsubsection">
5914   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
5915 </div>
5916
5917 <div class="doc_text">
5918
5919 <h5>Syntax:</h5>
5920 <pre>
5921   declare void @llvm.stackrestore(i8* %ptr)
5922 </pre>
5923
5924 <h5>Overview:</h5>
5925 <p>The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
5926    the function stack to the state it was in when the
5927    corresponding <a href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic
5928    executed.  This is useful for implementing language features like scoped
5929    automatic variable sized arrays in C99.</p>
5930
5931 <h5>Semantics:</h5>
5932 <p>See the description
5933    for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.</p>
5934
5935 </div>
5936
5937 <!-- _______________________________________________________________________ -->
5938 <div class="doc_subsubsection">
5939   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
5940 </div>
5941
5942 <div class="doc_text">
5943
5944 <h5>Syntax:</h5>
5945 <pre>
5946   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;)
5947 </pre>
5948
5949 <h5>Overview:</h5>
5950 <p>The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to
5951    insert a prefetch instruction if supported; otherwise, it is a noop.
5952    Prefetches have no effect on the behavior of the program but can change its
5953    performance characteristics.</p>
5954
5955 <h5>Arguments:</h5>
5956 <p><tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the
5957    specifier determining if the fetch should be for a read (0) or write (1),
5958    and <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
5959    locality, to (3) - extremely local keep in cache.  The <tt>rw</tt>
5960    and <tt>locality</tt> arguments must be constant integers.</p>
5961
5962 <h5>Semantics:</h5>
5963 <p>This intrinsic does not modify the behavior of the program.  In particular,
5964    prefetches cannot trap and do not produce a value.  On targets that support
5965    this intrinsic, the prefetch can provide hints to the processor cache for
5966    better performance.</p>
5967
5968 </div>
5969
5970 <!-- _______________________________________________________________________ -->
5971 <div class="doc_subsubsection">
5972   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
5973 </div>
5974
5975 <div class="doc_text">
5976
5977 <h5>Syntax:</h5>
5978 <pre>
5979   declare void @llvm.pcmarker(i32 &lt;id&gt;)
5980 </pre>
5981
5982 <h5>Overview:</h5>
5983 <p>The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program
5984    Counter (PC) in a region of code to simulators and other tools.  The method
5985    is target specific, but it is expected that the marker will use exported
5986    symbols to transmit the PC of the marker.  The marker makes no guarantees
5987    that it will remain with any specific instruction after optimizations.  It is
5988    possible that the presence of a marker will inhibit optimizations.  The
5989    intended use is to be inserted after optimizations to allow correlations of
5990    simulation runs.</p>
5991
5992 <h5>Arguments:</h5>
5993 <p><tt>id</tt> is a numerical id identifying the marker.</p>
5994
5995 <h5>Semantics:</h5>
5996 <p>This intrinsic does not modify the behavior of the program.  Backends that do
5997    not support this intrinsic may ignore it.</p>
5998
5999 </div>
6000
6001 <!-- _______________________________________________________________________ -->
6002 <div class="doc_subsubsection">
6003   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
6004 </div>
6005
6006 <div class="doc_text">
6007
6008 <h5>Syntax:</h5>
6009 <pre>
6010   declare i64 @llvm.readcyclecounter()
6011 </pre>
6012
6013 <h5>Overview:</h5>
6014 <p>The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
6015    counter register (or similar low latency, high accuracy clocks) on those
6016    targets that support it.  On X86, it should map to RDTSC.  On Alpha, it
6017    should map to RPCC.  As the backing counters overflow quickly (on the order
6018    of 9 seconds on alpha), this should only be used for small timings.</p>
6019
6020 <h5>Semantics:</h5>
6021 <p>When directly supported, reading the cycle counter should not modify any
6022    memory.  Implementations are allowed to either return a application specific
6023    value or a system wide value.  On backends without support, this is lowered
6024    to a constant 0.</p>
6025
6026 </div>
6027
6028 <!-- ======================================================================= -->
6029 <div class="doc_subsection">
6030   <a name="int_libc">Standard C Library Intrinsics</a>
6031 </div>
6032
6033 <div class="doc_text">
6034
6035 <p>LLVM provides intrinsics for a few important standard C library functions.
6036    These intrinsics allow source-language front-ends to pass information about
6037    the alignment of the pointer arguments to the code generator, providing
6038    opportunity for more efficient code generation.</p>
6039
6040 </div>
6041
6042 <!-- _______________________________________________________________________ -->
6043 <div class="doc_subsubsection">
6044   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
6045 </div>
6046
6047 <div class="doc_text">
6048
6049 <h5>Syntax:</h5>
6050 <p>This is an overloaded intrinsic. You can use <tt>llvm.memcpy</tt> on any
6051    integer bit width and for different address spaces. Not all targets support
6052    all bit widths however.</p>
6053
6054 <pre>
6055   declare void @llvm.memcpy.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6056                                           i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6057   declare void @llvm.memcpy.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6058                                           i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6059 </pre>
6060
6061 <h5>Overview:</h5>
6062 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6063    source location to the destination location.</p>
6064
6065 <p>Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
6066    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6067    and the pointers can be in specified address spaces.</p>
6068
6069 <h5>Arguments:</h5>
6070
6071 <p>The first argument is a pointer to the destination, the second is a pointer
6072    to the source.  The third argument is an integer argument specifying the
6073    number of bytes to copy, the fourth argument is the alignment of the
6074    source and destination locations, and the fifth is a boolean indicating a
6075    volatile access.</p>
6076
6077 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6078    then the caller guarantees that both the source and destination pointers are
6079    aligned to that boundary.</p>
6080
6081 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6082    <tt>llvm.memcpy</tt> call is a <a href="#volatile">volatile operation</a>.
6083    The detailed access behavior is not very cleanly specified and it is unwise
6084    to depend on it.</p>
6085
6086 <h5>Semantics:</h5>
6087
6088 <p>The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the
6089    source location to the destination location, which are not allowed to
6090    overlap.  It copies "len" bytes of memory over.  If the argument is known to
6091    be aligned to some boundary, this can be specified as the fourth argument,
6092    otherwise it should be set to 0 or 1.</p>
6093
6094 </div>
6095
6096 <!-- _______________________________________________________________________ -->
6097 <div class="doc_subsubsection">
6098   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
6099 </div>
6100
6101 <div class="doc_text">
6102
6103 <h5>Syntax:</h5>
6104 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
6105    width and for different address space. Not all targets support all bit
6106    widths however.</p>
6107
6108 <pre>
6109   declare void @llvm.memmove.p0i8.p0i8.i32(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6110                                            i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6111   declare void @llvm.memmove.p0i8.p0i8.i64(i8* &lt;dest&gt;, i8* &lt;src&gt;,
6112                                            i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6113 </pre>
6114
6115 <h5>Overview:</h5>
6116 <p>The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the
6117    source location to the destination location. It is similar to the
6118    '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to
6119    overlap.</p>
6120
6121 <p>Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
6122    intrinsics do not return a value, takes extra alignment/isvolatile arguments
6123    and the pointers can be in specified address spaces.</p>
6124
6125 <h5>Arguments:</h5>
6126
6127 <p>The first argument is a pointer to the destination, the second is a pointer
6128    to the source.  The third argument is an integer argument specifying the
6129    number of bytes to copy, the fourth argument is the alignment of the
6130    source and destination locations, and the fifth is a boolean indicating a
6131    volatile access.</p>
6132
6133 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6134    then the caller guarantees that the source and destination pointers are
6135    aligned to that boundary.</p>
6136
6137 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6138    <tt>llvm.memmove</tt> call is a <a href="#volatile">volatile operation</a>.
6139    The detailed access behavior is not very cleanly specified and it is unwise
6140    to depend on it.</p>
6141
6142 <h5>Semantics:</h5>
6143
6144 <p>The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the
6145    source location to the destination location, which may overlap.  It copies
6146    "len" bytes of memory over.  If the argument is known to be aligned to some
6147    boundary, this can be specified as the fourth argument, otherwise it should
6148    be set to 0 or 1.</p>
6149
6150 </div>
6151
6152 <!-- _______________________________________________________________________ -->
6153 <div class="doc_subsubsection">
6154   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
6155 </div>
6156
6157 <div class="doc_text">
6158
6159 <h5>Syntax:</h5>
6160 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
6161    width and for different address spaces. However, not all targets support all
6162    bit widths.</p>
6163
6164 <pre>
6165   declare void @llvm.memset.p0i8.i32(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6166                                      i32 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6167   declare void @llvm.memset.p0i8.i64(i8* &lt;dest&gt;, i8 &lt;val&gt;,
6168                                      i64 &lt;len&gt;, i32 &lt;align&gt;, i1 &lt;isvolatile&gt;)
6169 </pre>
6170
6171 <h5>Overview:</h5>
6172 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a
6173    particular byte value.</p>
6174
6175 <p>Note that, unlike the standard libc function, the <tt>llvm.memset</tt>
6176    intrinsic does not return a value and takes extra alignment/volatile
6177    arguments.  Also, the destination can be in an arbitrary address space.</p>
6178
6179 <h5>Arguments:</h5>
6180 <p>The first argument is a pointer to the destination to fill, the second is the
6181    byte value with which to fill it, the third argument is an integer argument
6182    specifying the number of bytes to fill, and the fourth argument is the known
6183    alignment of the destination location.</p>
6184
6185 <p>If the call to this intrinsic has an alignment value that is not 0 or 1,
6186    then the caller guarantees that the destination pointer is aligned to that
6187    boundary.</p>
6188
6189 <p>If the <tt>isvolatile</tt> parameter is <tt>true</tt>, the
6190    <tt>llvm.memset</tt> call is a <a href="#volatile">volatile operation</a>.
6191    The detailed access behavior is not very cleanly specified and it is unwise
6192    to depend on it.</p>
6193
6194 <h5>Semantics:</h5>
6195 <p>The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting
6196    at the destination location.  If the argument is known to be aligned to some
6197    boundary, this can be specified as the fourth argument, otherwise it should
6198    be set to 0 or 1.</p>
6199
6200 </div>
6201
6202 <!-- _______________________________________________________________________ -->
6203 <div class="doc_subsubsection">
6204   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
6205 </div>
6206
6207 <div class="doc_text">
6208
6209 <h5>Syntax:</h5>
6210 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
6211    floating point or vector of floating point type. Not all targets support all
6212    types however.</p>
6213
6214 <pre>
6215   declare float     @llvm.sqrt.f32(float %Val)
6216   declare double    @llvm.sqrt.f64(double %Val)
6217   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
6218   declare fp128     @llvm.sqrt.f128(fp128 %Val)
6219   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
6220 </pre>
6221
6222 <h5>Overview:</h5>
6223 <p>The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
6224    returning the same value as the libm '<tt>sqrt</tt>' functions would.
6225    Unlike <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined
6226    behavior for negative numbers other than -0.0 (which allows for better
6227    optimization, because there is no need to worry about errno being
6228    set).  <tt>llvm.sqrt(-0.0)</tt> is defined to return -0.0 like IEEE sqrt.</p>
6229
6230 <h5>Arguments:</h5>
6231 <p>The argument and return value are floating point numbers of the same
6232    type.</p>
6233
6234 <h5>Semantics:</h5>
6235 <p>This function returns the sqrt of the specified operand if it is a
6236    nonnegative floating point number.</p>
6237
6238 </div>
6239
6240 <!-- _______________________________________________________________________ -->
6241 <div class="doc_subsubsection">
6242   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
6243 </div>
6244
6245 <div class="doc_text">
6246
6247 <h5>Syntax:</h5>
6248 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
6249    floating point or vector of floating point type. Not all targets support all
6250    types however.</p>
6251
6252 <pre>
6253   declare float     @llvm.powi.f32(float  %Val, i32 %power)
6254   declare double    @llvm.powi.f64(double %Val, i32 %power)
6255   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
6256   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
6257   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
6258 </pre>
6259
6260 <h5>Overview:</h5>
6261 <p>The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
6262    specified (positive or negative) power.  The order of evaluation of
6263    multiplications is not defined.  When a vector of floating point type is
6264    used, the second argument remains a scalar integer value.</p>
6265
6266 <h5>Arguments:</h5>
6267 <p>The second argument is an integer power, and the first is a value to raise to
6268    that power.</p>
6269
6270 <h5>Semantics:</h5>
6271 <p>This function returns the first value raised to the second power with an
6272    unspecified sequence of rounding operations.</p>
6273
6274 </div>
6275
6276 <!-- _______________________________________________________________________ -->
6277 <div class="doc_subsubsection">
6278   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
6279 </div>
6280
6281 <div class="doc_text">
6282
6283 <h5>Syntax:</h5>
6284 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
6285    floating point or vector of floating point type. Not all targets support all
6286    types however.</p>
6287
6288 <pre>
6289   declare float     @llvm.sin.f32(float  %Val)
6290   declare double    @llvm.sin.f64(double %Val)
6291   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
6292   declare fp128     @llvm.sin.f128(fp128 %Val)
6293   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
6294 </pre>
6295
6296 <h5>Overview:</h5>
6297 <p>The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.</p>
6298
6299 <h5>Arguments:</h5>
6300 <p>The argument and return value are floating point numbers of the same
6301    type.</p>
6302
6303 <h5>Semantics:</h5>
6304 <p>This function returns the sine of the specified operand, returning the same
6305    values as the libm <tt>sin</tt> functions would, and handles error conditions
6306    in the same way.</p>
6307
6308 </div>
6309
6310 <!-- _______________________________________________________________________ -->
6311 <div class="doc_subsubsection">
6312   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
6313 </div>
6314
6315 <div class="doc_text">
6316
6317 <h5>Syntax:</h5>
6318 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
6319    floating point or vector of floating point type. Not all targets support all
6320    types however.</p>
6321
6322 <pre>
6323   declare float     @llvm.cos.f32(float  %Val)
6324   declare double    @llvm.cos.f64(double %Val)
6325   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
6326   declare fp128     @llvm.cos.f128(fp128 %Val)
6327   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
6328 </pre>
6329
6330 <h5>Overview:</h5>
6331 <p>The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.</p>
6332
6333 <h5>Arguments:</h5>
6334 <p>The argument and return value are floating point numbers of the same
6335    type.</p>
6336
6337 <h5>Semantics:</h5>
6338 <p>This function returns the cosine of the specified operand, returning the same
6339    values as the libm <tt>cos</tt> functions would, and handles error conditions
6340    in the same way.</p>
6341
6342 </div>
6343
6344 <!-- _______________________________________________________________________ -->
6345 <div class="doc_subsubsection">
6346   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
6347 </div>
6348
6349 <div class="doc_text">
6350
6351 <h5>Syntax:</h5>
6352 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
6353    floating point or vector of floating point type. Not all targets support all
6354    types however.</p>
6355
6356 <pre>
6357   declare float     @llvm.pow.f32(float  %Val, float %Power)
6358   declare double    @llvm.pow.f64(double %Val, double %Power)
6359   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
6360   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
6361   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
6362 </pre>
6363
6364 <h5>Overview:</h5>
6365 <p>The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
6366    specified (positive or negative) power.</p>
6367
6368 <h5>Arguments:</h5>
6369 <p>The second argument is a floating point power, and the first is a value to
6370    raise to that power.</p>
6371
6372 <h5>Semantics:</h5>
6373 <p>This function returns the first value raised to the second power, returning
6374    the same values as the libm <tt>pow</tt> functions would, and handles error
6375    conditions in the same way.</p>
6376
6377 </div>
6378
6379 <!-- ======================================================================= -->
6380 <div class="doc_subsection">
6381   <a name="int_manip">Bit Manipulation Intrinsics</a>
6382 </div>
6383
6384 <div class="doc_text">
6385
6386 <p>LLVM provides intrinsics for a few important bit manipulation operations.
6387    These allow efficient code generation for some algorithms.</p>
6388
6389 </div>
6390
6391 <!-- _______________________________________________________________________ -->
6392 <div class="doc_subsubsection">
6393   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
6394 </div>
6395
6396 <div class="doc_text">
6397
6398 <h5>Syntax:</h5>
6399 <p>This is an overloaded intrinsic function. You can use bswap on any integer
6400    type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
6401
6402 <pre>
6403   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
6404   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
6405   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
6406 </pre>
6407
6408 <h5>Overview:</h5>
6409 <p>The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
6410    values with an even number of bytes (positive multiple of 16 bits).  These
6411    are useful for performing operations on data that is not in the target's
6412    native byte order.</p>
6413
6414 <h5>Semantics:</h5>
6415 <p>The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
6416    and low byte of the input i16 swapped.  Similarly,
6417    the <tt>llvm.bswap.i32</tt> intrinsic returns an i32 value that has the four
6418    bytes of the input i32 swapped, so that if the input bytes are numbered 0, 1,
6419    2, 3 then the returned i32 will have its bytes in 3, 2, 1, 0 order.
6420    The <tt>llvm.bswap.i48</tt>, <tt>llvm.bswap.i64</tt> and other intrinsics
6421    extend this concept to additional even-byte lengths (6 bytes, 8 bytes and
6422    more, respectively).</p>
6423
6424 </div>
6425
6426 <!-- _______________________________________________________________________ -->
6427 <div class="doc_subsubsection">
6428   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
6429 </div>
6430
6431 <div class="doc_text">
6432
6433 <h5>Syntax:</h5>
6434 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
6435    width. Not all targets support all bit widths however.</p>
6436
6437 <pre>
6438   declare i8 @llvm.ctpop.i8(i8  &lt;src&gt;)
6439   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
6440   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
6441   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
6442   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
6443 </pre>
6444
6445 <h5>Overview:</h5>
6446 <p>The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set
6447    in a value.</p>
6448
6449 <h5>Arguments:</h5>
6450 <p>The only argument is the value to be counted.  The argument may be of any
6451    integer type.  The return type must match the argument type.</p>
6452
6453 <h5>Semantics:</h5>
6454 <p>The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.</p>
6455
6456 </div>
6457
6458 <!-- _______________________________________________________________________ -->
6459 <div class="doc_subsubsection">
6460   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
6461 </div>
6462
6463 <div class="doc_text">
6464
6465 <h5>Syntax:</h5>
6466 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
6467    integer bit width. Not all targets support all bit widths however.</p>
6468
6469 <pre>
6470   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
6471   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
6472   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
6473   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
6474   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
6475 </pre>
6476
6477 <h5>Overview:</h5>
6478 <p>The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
6479    leading zeros in a variable.</p>
6480
6481 <h5>Arguments:</h5>
6482 <p>The only argument is the value to be counted.  The argument may be of any
6483    integer type. The return type must match the argument type.</p>
6484
6485 <h5>Semantics:</h5>
6486 <p>The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant)
6487    zeros in a variable.  If the src == 0 then the result is the size in bits of
6488    the type of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.</p>
6489
6490 </div>
6491
6492 <!-- _______________________________________________________________________ -->
6493 <div class="doc_subsubsection">
6494   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
6495 </div>
6496
6497 <div class="doc_text">
6498
6499 <h5>Syntax:</h5>
6500 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
6501    integer bit width. Not all targets support all bit widths however.</p>
6502
6503 <pre>
6504   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
6505   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
6506   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
6507   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
6508   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
6509 </pre>
6510
6511 <h5>Overview:</h5>
6512 <p>The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
6513    trailing zeros.</p>
6514
6515 <h5>Arguments:</h5>
6516 <p>The only argument is the value to be counted.  The argument may be of any
6517    integer type.  The return type must match the argument type.</p>
6518
6519 <h5>Semantics:</h5>
6520 <p>The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant)
6521    zeros in a variable.  If the src == 0 then the result is the size in bits of
6522    the type of src.  For example, <tt>llvm.cttz(2) = 1</tt>.</p>
6523
6524 </div>
6525
6526 <!-- ======================================================================= -->
6527 <div class="doc_subsection">
6528   <a name="int_overflow">Arithmetic with Overflow Intrinsics</a>
6529 </div>
6530
6531 <div class="doc_text">
6532
6533 <p>LLVM provides intrinsics for some arithmetic with overflow operations.</p>
6534
6535 </div>
6536
6537 <!-- _______________________________________________________________________ -->
6538 <div class="doc_subsubsection">
6539   <a name="int_sadd_overflow">'<tt>llvm.sadd.with.overflow.*</tt>' Intrinsics</a>
6540 </div>
6541
6542 <div class="doc_text">
6543
6544 <h5>Syntax:</h5>
6545 <p>This is an overloaded intrinsic. You can use <tt>llvm.sadd.with.overflow</tt>
6546    on any integer bit width.</p>
6547
6548 <pre>
6549   declare {i16, i1} @llvm.sadd.with.overflow.i16(i16 %a, i16 %b)
6550   declare {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6551   declare {i64, i1} @llvm.sadd.with.overflow.i64(i64 %a, i64 %b)
6552 </pre>
6553
6554 <h5>Overview:</h5>
6555 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6556    a signed addition of the two arguments, and indicate whether an overflow
6557    occurred during the signed summation.</p>
6558
6559 <h5>Arguments:</h5>
6560 <p>The arguments (%a and %b) and the first element of the result structure may
6561    be of integer types of any bit width, but they must have the same bit
6562    width. The second element of the result structure must be of
6563    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6564    undergo signed addition.</p>
6565
6566 <h5>Semantics:</h5>
6567 <p>The '<tt>llvm.sadd.with.overflow</tt>' family of intrinsic functions perform
6568    a signed addition of the two variables. They return a structure &mdash; the
6569    first element of which is the signed summation, and the second element of
6570    which is a bit specifying if the signed summation resulted in an
6571    overflow.</p>
6572
6573 <h5>Examples:</h5>
6574 <pre>
6575   %res = call {i32, i1} @llvm.sadd.with.overflow.i32(i32 %a, i32 %b)
6576   %sum = extractvalue {i32, i1} %res, 0
6577   %obit = extractvalue {i32, i1} %res, 1
6578   br i1 %obit, label %overflow, label %normal
6579 </pre>
6580
6581 </div>
6582
6583 <!-- _______________________________________________________________________ -->
6584 <div class="doc_subsubsection">
6585   <a name="int_uadd_overflow">'<tt>llvm.uadd.with.overflow.*</tt>' Intrinsics</a>
6586 </div>
6587
6588 <div class="doc_text">
6589
6590 <h5>Syntax:</h5>
6591 <p>This is an overloaded intrinsic. You can use <tt>llvm.uadd.with.overflow</tt>
6592    on any integer bit width.</p>
6593
6594 <pre>
6595   declare {i16, i1} @llvm.uadd.with.overflow.i16(i16 %a, i16 %b)
6596   declare {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6597   declare {i64, i1} @llvm.uadd.with.overflow.i64(i64 %a, i64 %b)
6598 </pre>
6599
6600 <h5>Overview:</h5>
6601 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6602    an unsigned addition of the two arguments, and indicate whether a carry
6603    occurred during the unsigned summation.</p>
6604
6605 <h5>Arguments:</h5>
6606 <p>The arguments (%a and %b) and the first element of the result structure may
6607    be of integer types of any bit width, but they must have the same bit
6608    width. The second element of the result structure must be of
6609    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6610    undergo unsigned addition.</p>
6611
6612 <h5>Semantics:</h5>
6613 <p>The '<tt>llvm.uadd.with.overflow</tt>' family of intrinsic functions perform
6614    an unsigned addition of the two arguments. They return a structure &mdash;
6615    the first element of which is the sum, and the second element of which is a
6616    bit specifying if the unsigned summation resulted in a carry.</p>
6617
6618 <h5>Examples:</h5>
6619 <pre>
6620   %res = call {i32, i1} @llvm.uadd.with.overflow.i32(i32 %a, i32 %b)
6621   %sum = extractvalue {i32, i1} %res, 0
6622   %obit = extractvalue {i32, i1} %res, 1
6623   br i1 %obit, label %carry, label %normal
6624 </pre>
6625
6626 </div>
6627
6628 <!-- _______________________________________________________________________ -->
6629 <div class="doc_subsubsection">
6630   <a name="int_ssub_overflow">'<tt>llvm.ssub.with.overflow.*</tt>' Intrinsics</a>
6631 </div>
6632
6633 <div class="doc_text">
6634
6635 <h5>Syntax:</h5>
6636 <p>This is an overloaded intrinsic. You can use <tt>llvm.ssub.with.overflow</tt>
6637    on any integer bit width.</p>
6638
6639 <pre>
6640   declare {i16, i1} @llvm.ssub.with.overflow.i16(i16 %a, i16 %b)
6641   declare {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6642   declare {i64, i1} @llvm.ssub.with.overflow.i64(i64 %a, i64 %b)
6643 </pre>
6644
6645 <h5>Overview:</h5>
6646 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6647    a signed subtraction of the two arguments, and indicate whether an overflow
6648    occurred during the signed subtraction.</p>
6649
6650 <h5>Arguments:</h5>
6651 <p>The arguments (%a and %b) and the first element of the result structure may
6652    be of integer types of any bit width, but they must have the same bit
6653    width. The second element of the result structure must be of
6654    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6655    undergo signed subtraction.</p>
6656
6657 <h5>Semantics:</h5>
6658 <p>The '<tt>llvm.ssub.with.overflow</tt>' family of intrinsic functions perform
6659    a signed subtraction of the two arguments. They return a structure &mdash;
6660    the first element of which is the subtraction, and the second element of
6661    which is a bit specifying if the signed subtraction resulted in an
6662    overflow.</p>
6663
6664 <h5>Examples:</h5>
6665 <pre>
6666   %res = call {i32, i1} @llvm.ssub.with.overflow.i32(i32 %a, i32 %b)
6667   %sum = extractvalue {i32, i1} %res, 0
6668   %obit = extractvalue {i32, i1} %res, 1
6669   br i1 %obit, label %overflow, label %normal
6670 </pre>
6671
6672 </div>
6673
6674 <!-- _______________________________________________________________________ -->
6675 <div class="doc_subsubsection">
6676   <a name="int_usub_overflow">'<tt>llvm.usub.with.overflow.*</tt>' Intrinsics</a>
6677 </div>
6678
6679 <div class="doc_text">
6680
6681 <h5>Syntax:</h5>
6682 <p>This is an overloaded intrinsic. You can use <tt>llvm.usub.with.overflow</tt>
6683    on any integer bit width.</p>
6684
6685 <pre>
6686   declare {i16, i1} @llvm.usub.with.overflow.i16(i16 %a, i16 %b)
6687   declare {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6688   declare {i64, i1} @llvm.usub.with.overflow.i64(i64 %a, i64 %b)
6689 </pre>
6690
6691 <h5>Overview:</h5>
6692 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6693    an unsigned subtraction of the two arguments, and indicate whether an
6694    overflow occurred during the unsigned subtraction.</p>
6695
6696 <h5>Arguments:</h5>
6697 <p>The arguments (%a and %b) and the first element of the result structure may
6698    be of integer types of any bit width, but they must have the same bit
6699    width. The second element of the result structure must be of
6700    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6701    undergo unsigned subtraction.</p>
6702
6703 <h5>Semantics:</h5>
6704 <p>The '<tt>llvm.usub.with.overflow</tt>' family of intrinsic functions perform
6705    an unsigned subtraction of the two arguments. They return a structure &mdash;
6706    the first element of which is the subtraction, and the second element of
6707    which is a bit specifying if the unsigned subtraction resulted in an
6708    overflow.</p>
6709
6710 <h5>Examples:</h5>
6711 <pre>
6712   %res = call {i32, i1} @llvm.usub.with.overflow.i32(i32 %a, i32 %b)
6713   %sum = extractvalue {i32, i1} %res, 0
6714   %obit = extractvalue {i32, i1} %res, 1
6715   br i1 %obit, label %overflow, label %normal
6716 </pre>
6717
6718 </div>
6719
6720 <!-- _______________________________________________________________________ -->
6721 <div class="doc_subsubsection">
6722   <a name="int_smul_overflow">'<tt>llvm.smul.with.overflow.*</tt>' Intrinsics</a>
6723 </div>
6724
6725 <div class="doc_text">
6726
6727 <h5>Syntax:</h5>
6728 <p>This is an overloaded intrinsic. You can use <tt>llvm.smul.with.overflow</tt>
6729    on any integer bit width.</p>
6730
6731 <pre>
6732   declare {i16, i1} @llvm.smul.with.overflow.i16(i16 %a, i16 %b)
6733   declare {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6734   declare {i64, i1} @llvm.smul.with.overflow.i64(i64 %a, i64 %b)
6735 </pre>
6736
6737 <h5>Overview:</h5>
6738
6739 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6740    a signed multiplication of the two arguments, and indicate whether an
6741    overflow occurred during the signed multiplication.</p>
6742
6743 <h5>Arguments:</h5>
6744 <p>The arguments (%a and %b) and the first element of the result structure may
6745    be of integer types of any bit width, but they must have the same bit
6746    width. The second element of the result structure must be of
6747    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6748    undergo signed multiplication.</p>
6749
6750 <h5>Semantics:</h5>
6751 <p>The '<tt>llvm.smul.with.overflow</tt>' family of intrinsic functions perform
6752    a signed multiplication of the two arguments. They return a structure &mdash;
6753    the first element of which is the multiplication, and the second element of
6754    which is a bit specifying if the signed multiplication resulted in an
6755    overflow.</p>
6756
6757 <h5>Examples:</h5>
6758 <pre>
6759   %res = call {i32, i1} @llvm.smul.with.overflow.i32(i32 %a, i32 %b)
6760   %sum = extractvalue {i32, i1} %res, 0
6761   %obit = extractvalue {i32, i1} %res, 1
6762   br i1 %obit, label %overflow, label %normal
6763 </pre>
6764
6765 </div>
6766
6767 <!-- _______________________________________________________________________ -->
6768 <div class="doc_subsubsection">
6769   <a name="int_umul_overflow">'<tt>llvm.umul.with.overflow.*</tt>' Intrinsics</a>
6770 </div>
6771
6772 <div class="doc_text">
6773
6774 <h5>Syntax:</h5>
6775 <p>This is an overloaded intrinsic. You can use <tt>llvm.umul.with.overflow</tt>
6776    on any integer bit width.</p>
6777
6778 <pre>
6779   declare {i16, i1} @llvm.umul.with.overflow.i16(i16 %a, i16 %b)
6780   declare {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6781   declare {i64, i1} @llvm.umul.with.overflow.i64(i64 %a, i64 %b)
6782 </pre>
6783
6784 <h5>Overview:</h5>
6785 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6786    a unsigned multiplication of the two arguments, and indicate whether an
6787    overflow occurred during the unsigned multiplication.</p>
6788
6789 <h5>Arguments:</h5>
6790 <p>The arguments (%a and %b) and the first element of the result structure may
6791    be of integer types of any bit width, but they must have the same bit
6792    width. The second element of the result structure must be of
6793    type <tt>i1</tt>. <tt>%a</tt> and <tt>%b</tt> are the two values that will
6794    undergo unsigned multiplication.</p>
6795
6796 <h5>Semantics:</h5>
6797 <p>The '<tt>llvm.umul.with.overflow</tt>' family of intrinsic functions perform
6798    an unsigned multiplication of the two arguments. They return a structure
6799    &mdash; the first element of which is the multiplication, and the second
6800    element of which is a bit specifying if the unsigned multiplication resulted
6801    in an overflow.</p>
6802
6803 <h5>Examples:</h5>
6804 <pre>
6805   %res = call {i32, i1} @llvm.umul.with.overflow.i32(i32 %a, i32 %b)
6806   %sum = extractvalue {i32, i1} %res, 0
6807   %obit = extractvalue {i32, i1} %res, 1
6808   br i1 %obit, label %overflow, label %normal
6809 </pre>
6810
6811 </div>
6812
6813 <!-- ======================================================================= -->
6814 <div class="doc_subsection">
6815   <a name="int_fp16">Half Precision Floating Point Intrinsics</a>
6816 </div>
6817
6818 <div class="doc_text">
6819
6820 <p>Half precision floating point is a storage-only format. This means that it is
6821    a dense encoding (in memory) but does not support computation in the
6822    format.</p>
6823
6824 <p>This means that code must first load the half-precision floating point
6825    value as an i16, then convert it to float with <a
6826    href="#int_convert_from_fp16"><tt>llvm.convert.from.fp16</tt></a>.
6827    Computation can then be performed on the float value (including extending to
6828    double etc).  To store the value back to memory, it is first converted to
6829    float if needed, then converted to i16 with
6830    <a href="#int_convert_to_fp16"><tt>llvm.convert.to.fp16</tt></a>, then
6831    storing as an i16 value.</p>
6832 </div>
6833
6834 <!-- _______________________________________________________________________ -->
6835 <div class="doc_subsubsection">
6836   <a name="int_convert_to_fp16">'<tt>llvm.convert.to.fp16</tt>' Intrinsic</a>
6837 </div>
6838
6839 <div class="doc_text">
6840
6841 <h5>Syntax:</h5>
6842 <pre>
6843   declare i16 @llvm.convert.to.fp16(f32 %a)
6844 </pre>
6845
6846 <h5>Overview:</h5>
6847 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6848    a conversion from single precision floating point format to half precision
6849    floating point format.</p>
6850
6851 <h5>Arguments:</h5>
6852 <p>The intrinsic function contains single argument - the value to be
6853    converted.</p>
6854
6855 <h5>Semantics:</h5>
6856 <p>The '<tt>llvm.convert.to.fp16</tt>' intrinsic function performs
6857    a conversion from single precision floating point format to half precision
6858    floating point format. The return value is an <tt>i16</tt> which
6859    contains the converted number.</p>
6860
6861 <h5>Examples:</h5>
6862 <pre>
6863   %res = call i16 @llvm.convert.to.fp16(f32 %a)
6864   store i16 %res, i16* @x, align 2
6865 </pre>
6866
6867 </div>
6868
6869 <!-- _______________________________________________________________________ -->
6870 <div class="doc_subsubsection">
6871  <a name="int_convert_from_fp16">'<tt>llvm.convert.from.fp16</tt>' Intrinsic</a>
6872 </div>
6873
6874 <div class="doc_text">
6875
6876 <h5>Syntax:</h5>
6877 <pre>
6878   declare f32 @llvm.convert.from.fp16(i16 %a)
6879 </pre>
6880
6881 <h5>Overview:</h5>
6882 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs
6883    a conversion from half precision floating point format to single precision
6884    floating point format.</p>
6885
6886 <h5>Arguments:</h5>
6887 <p>The intrinsic function contains single argument - the value to be
6888    converted.</p>
6889
6890 <h5>Semantics:</h5>
6891 <p>The '<tt>llvm.convert.from.fp16</tt>' intrinsic function performs a
6892    conversion from half single precision floating point format to single
6893    precision floating point format. The input half-float value is represented by
6894    an <tt>i16</tt> value.</p>
6895
6896 <h5>Examples:</h5>
6897 <pre>
6898   %a = load i16* @x, align 2
6899   %res = call f32 @llvm.convert.from.fp16(i16 %a)
6900 </pre>
6901
6902 </div>
6903
6904 <!-- ======================================================================= -->
6905 <div class="doc_subsection">
6906   <a name="int_debugger">Debugger Intrinsics</a>
6907 </div>
6908
6909 <div class="doc_text">
6910
6911 <p>The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt>
6912    prefix), are described in
6913    the <a href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source
6914    Level Debugging</a> document.</p>
6915
6916 </div>
6917
6918 <!-- ======================================================================= -->
6919 <div class="doc_subsection">
6920   <a name="int_eh">Exception Handling Intrinsics</a>
6921 </div>
6922
6923 <div class="doc_text">
6924
6925 <p>The LLVM exception handling intrinsics (which all start with
6926    <tt>llvm.eh.</tt> prefix), are described in
6927    the <a href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
6928    Handling</a> document.</p>
6929
6930 </div>
6931
6932 <!-- ======================================================================= -->
6933 <div class="doc_subsection">
6934   <a name="int_trampoline">Trampoline Intrinsic</a>
6935 </div>
6936
6937 <div class="doc_text">
6938
6939 <p>This intrinsic makes it possible to excise one parameter, marked with
6940    the <a href="#nest"><tt>nest</tt></a> attribute, from a function.
6941    The result is a callable
6942    function pointer lacking the nest parameter - the caller does not need to
6943    provide a value for it.  Instead, the value to use is stored in advance in a
6944    "trampoline", a block of memory usually allocated on the stack, which also
6945    contains code to splice the nest value into the argument list.  This is used
6946    to implement the GCC nested function address extension.</p>
6947
6948 <p>For example, if the function is
6949    <tt>i32 f(i8* nest %c, i32 %x, i32 %y)</tt> then the resulting function
6950    pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as
6951    follows:</p>
6952
6953 <pre class="doc_code">
6954   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
6955   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
6956   %p = call i8* @llvm.init.trampoline(i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval)
6957   %fp = bitcast i8* %p to i32 (i32, i32)*
6958 </pre>
6959
6960 <p>The call <tt>%val = call i32 %fp(i32 %x, i32 %y)</tt> is then equivalent
6961    to <tt>%val = call i32 %f(i8* %nval, i32 %x, i32 %y)</tt>.</p>
6962
6963 </div>
6964
6965 <!-- _______________________________________________________________________ -->
6966 <div class="doc_subsubsection">
6967   <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
6968 </div>
6969
6970 <div class="doc_text">
6971
6972 <h5>Syntax:</h5>
6973 <pre>
6974   declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
6975 </pre>
6976
6977 <h5>Overview:</h5>
6978 <p>This fills the memory pointed to by <tt>tramp</tt> with code and returns a
6979    function pointer suitable for executing it.</p>
6980
6981 <h5>Arguments:</h5>
6982 <p>The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
6983    pointers.  The <tt>tramp</tt> argument must point to a sufficiently large and
6984    sufficiently aligned block of memory; this memory is written to by the
6985    intrinsic.  Note that the size and the alignment are target-specific - LLVM
6986    currently provides no portable way of determining them, so a front-end that
6987    generates this intrinsic needs to have some target-specific knowledge.
6988    The <tt>func</tt> argument must hold a function bitcast to
6989    an <tt>i8*</tt>.</p>
6990
6991 <h5>Semantics:</h5>
6992 <p>The block of memory pointed to by <tt>tramp</tt> is filled with target
6993    dependent code, turning it into a function.  A pointer to this function is
6994    returned, but needs to be bitcast to an <a href="#int_trampoline">appropriate
6995    function pointer type</a> before being called.  The new function's signature
6996    is the same as that of <tt>func</tt> with any arguments marked with
6997    the <tt>nest</tt> attribute removed.  At most one such <tt>nest</tt> argument
6998    is allowed, and it must be of pointer type.  Calling the new function is
6999    equivalent to calling <tt>func</tt> with the same argument list, but
7000    with <tt>nval</tt> used for the missing <tt>nest</tt> argument.  If, after
7001    calling <tt>llvm.init.trampoline</tt>, the memory pointed to
7002    by <tt>tramp</tt> is modified, then the effect of any later call to the
7003    returned function pointer is undefined.</p>
7004
7005 </div>
7006
7007 <!-- ======================================================================= -->
7008 <div class="doc_subsection">
7009   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
7010 </div>
7011
7012 <div class="doc_text">
7013
7014 <p>These intrinsic functions expand the "universal IR" of LLVM to represent
7015    hardware constructs for atomic operations and memory synchronization.  This
7016    provides an interface to the hardware, not an interface to the programmer. It
7017    is aimed at a low enough level to allow any programming models or APIs
7018    (Application Programming Interfaces) which need atomic behaviors to map
7019    cleanly onto it. It is also modeled primarily on hardware behavior. Just as
7020    hardware provides a "universal IR" for source languages, it also provides a
7021    starting point for developing a "universal" atomic operation and
7022    synchronization IR.</p>
7023
7024 <p>These do <em>not</em> form an API such as high-level threading libraries,
7025    software transaction memory systems, atomic primitives, and intrinsic
7026    functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
7027    application libraries.  The hardware interface provided by LLVM should allow
7028    a clean implementation of all of these APIs and parallel programming models.
7029    No one model or paradigm should be selected above others unless the hardware
7030    itself ubiquitously does so.</p>
7031
7032 </div>
7033
7034 <!-- _______________________________________________________________________ -->
7035 <div class="doc_subsubsection">
7036   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
7037 </div>
7038 <div class="doc_text">
7039 <h5>Syntax:</h5>
7040 <pre>
7041   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;)
7042 </pre>
7043
7044 <h5>Overview:</h5>
7045 <p>The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
7046    specific pairs of memory access types.</p>
7047
7048 <h5>Arguments:</h5>
7049 <p>The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
7050    The first four arguments enables a specific barrier as listed below.  The
7051    fifth argument specifies that the barrier applies to io or device or uncached
7052    memory.</p>
7053
7054 <ul>
7055   <li><tt>ll</tt>: load-load barrier</li>
7056   <li><tt>ls</tt>: load-store barrier</li>
7057   <li><tt>sl</tt>: store-load barrier</li>
7058   <li><tt>ss</tt>: store-store barrier</li>
7059   <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
7060 </ul>
7061
7062 <h5>Semantics:</h5>
7063 <p>This intrinsic causes the system to enforce some ordering constraints upon
7064    the loads and stores of the program. This barrier does not
7065    indicate <em>when</em> any events will occur, it only enforces
7066    an <em>order</em> in which they occur. For any of the specified pairs of load
7067    and store operations (f.ex.  load-load, or store-load), all of the first
7068    operations preceding the barrier will complete before any of the second
7069    operations succeeding the barrier begin. Specifically the semantics for each
7070    pairing is as follows:</p>
7071
7072 <ul>
7073   <li><tt>ll</tt>: All loads before the barrier must complete before any load
7074       after the barrier begins.</li>
7075   <li><tt>ls</tt>: All loads before the barrier must complete before any
7076       store after the barrier begins.</li>
7077   <li><tt>ss</tt>: All stores before the barrier must complete before any
7078       store after the barrier begins.</li>
7079   <li><tt>sl</tt>: All stores before the barrier must complete before any
7080       load after the barrier begins.</li>
7081 </ul>
7082
7083 <p>These semantics are applied with a logical "and" behavior when more than one
7084    is enabled in a single memory barrier intrinsic.</p>
7085
7086 <p>Backends may implement stronger barriers than those requested when they do
7087    not support as fine grained a barrier as requested.  Some architectures do
7088    not need all types of barriers and on such architectures, these become
7089    noops.</p>
7090
7091 <h5>Example:</h5>
7092 <pre>
7093 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7094 %ptr      = bitcast i8* %mallocP to i32*
7095             store i32 4, %ptr
7096
7097 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
7098             call void @llvm.memory.barrier(i1 false, i1 true, i1 false, i1 false)
7099                                 <i>; guarantee the above finishes</i>
7100             store i32 8, %ptr   <i>; before this begins</i>
7101 </pre>
7102
7103 </div>
7104
7105 <!-- _______________________________________________________________________ -->
7106 <div class="doc_subsubsection">
7107   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
7108 </div>
7109
7110 <div class="doc_text">
7111
7112 <h5>Syntax:</h5>
7113 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
7114    any integer bit width and for different address spaces. Not all targets
7115    support all bit widths however.</p>
7116
7117 <pre>
7118   declare i8 @llvm.atomic.cmp.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt;)
7119   declare i16 @llvm.atomic.cmp.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt;)
7120   declare i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt;)
7121   declare i64 @llvm.atomic.cmp.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt;)
7122 </pre>
7123
7124 <h5>Overview:</h5>
7125 <p>This loads a value in memory and compares it to a given value. If they are
7126    equal, it stores a new value into the memory.</p>
7127
7128 <h5>Arguments:</h5>
7129 <p>The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result
7130    as well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
7131    same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
7132    this integer type. While any bit width integer may be used, targets may only
7133    lower representations they support in hardware.</p>
7134
7135 <h5>Semantics:</h5>
7136 <p>This entire intrinsic must be executed atomically. It first loads the value
7137    in memory pointed to by <tt>ptr</tt> and compares it with the
7138    value <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the
7139    memory. The loaded value is yielded in all cases. This provides the
7140    equivalent of an atomic compare-and-swap operation within the SSA
7141    framework.</p>
7142
7143 <h5>Examples:</h5>
7144 <pre>
7145 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7146 %ptr      = bitcast i8* %mallocP to i32*
7147             store i32 4, %ptr
7148
7149 %val1     = add i32 4, 4
7150 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 4, %val1)
7151                                           <i>; yields {i32}:result1 = 4</i>
7152 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
7153 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
7154
7155 %val2     = add i32 1, 1
7156 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32(i32* %ptr, i32 5, %val2)
7157                                           <i>; yields {i32}:result2 = 8</i>
7158 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
7159
7160 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
7161 </pre>
7162
7163 </div>
7164
7165 <!-- _______________________________________________________________________ -->
7166 <div class="doc_subsubsection">
7167   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
7168 </div>
7169 <div class="doc_text">
7170 <h5>Syntax:</h5>
7171
7172 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
7173    integer bit width. Not all targets support all bit widths however.</p>
7174
7175 <pre>
7176   declare i8 @llvm.atomic.swap.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;val&gt;)
7177   declare i16 @llvm.atomic.swap.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;val&gt;)
7178   declare i32 @llvm.atomic.swap.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;val&gt;)
7179   declare i64 @llvm.atomic.swap.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;val&gt;)
7180 </pre>
7181
7182 <h5>Overview:</h5>
7183 <p>This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
7184    the value from memory. It then stores the value in <tt>val</tt> in the memory
7185    at <tt>ptr</tt>.</p>
7186
7187 <h5>Arguments:</h5>
7188 <p>The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both
7189   the <tt>val</tt> argument and the result must be integers of the same bit
7190   width.  The first argument, <tt>ptr</tt>, must be a pointer to a value of this
7191   integer type. The targets may only lower integer representations they
7192   support.</p>
7193
7194 <h5>Semantics:</h5>
7195 <p>This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
7196    stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
7197    equivalent of an atomic swap operation within the SSA framework.</p>
7198
7199 <h5>Examples:</h5>
7200 <pre>
7201 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7202 %ptr      = bitcast i8* %mallocP to i32*
7203             store i32 4, %ptr
7204
7205 %val1     = add i32 4, 4
7206 %result1  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val1)
7207                                         <i>; yields {i32}:result1 = 4</i>
7208 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
7209 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
7210
7211 %val2     = add i32 1, 1
7212 %result2  = call i32 @llvm.atomic.swap.i32.p0i32(i32* %ptr, i32 %val2)
7213                                         <i>; yields {i32}:result2 = 8</i>
7214
7215 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
7216 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
7217 </pre>
7218
7219 </div>
7220
7221 <!-- _______________________________________________________________________ -->
7222 <div class="doc_subsubsection">
7223   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
7224
7225 </div>
7226
7227 <div class="doc_text">
7228
7229 <h5>Syntax:</h5>
7230 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on
7231    any integer bit width. Not all targets support all bit widths however.</p>
7232
7233 <pre>
7234   declare i8 @llvm.atomic.load.add.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7235   declare i16 @llvm.atomic.load.add.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7236   declare i32 @llvm.atomic.load.add.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7237   declare i64 @llvm.atomic.load.add.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7238 </pre>
7239
7240 <h5>Overview:</h5>
7241 <p>This intrinsic adds <tt>delta</tt> to the value stored in memory
7242    at <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7243
7244 <h5>Arguments:</h5>
7245 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7246    and the second an integer value. The result is also an integer value. These
7247    integer types can have any bit width, but they must all have the same bit
7248    width. The targets may only lower integer representations they support.</p>
7249
7250 <h5>Semantics:</h5>
7251 <p>This intrinsic does a series of operations atomically. It first loads the
7252    value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
7253    to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.</p>
7254
7255 <h5>Examples:</h5>
7256 <pre>
7257 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7258 %ptr      = bitcast i8* %mallocP to i32*
7259             store i32 4, %ptr
7260 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 4)
7261                                 <i>; yields {i32}:result1 = 4</i>
7262 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 2)
7263                                 <i>; yields {i32}:result2 = 8</i>
7264 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32(i32* %ptr, i32 5)
7265                                 <i>; yields {i32}:result3 = 10</i>
7266 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
7267 </pre>
7268
7269 </div>
7270
7271 <!-- _______________________________________________________________________ -->
7272 <div class="doc_subsubsection">
7273   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
7274
7275 </div>
7276
7277 <div class="doc_text">
7278
7279 <h5>Syntax:</h5>
7280 <p>This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
7281    any integer bit width and for different address spaces. Not all targets
7282    support all bit widths however.</p>
7283
7284 <pre>
7285   declare i8 @llvm.atomic.load.sub.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7286   declare i16 @llvm.atomic.load.sub.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7287   declare i32 @llvm.atomic.load.sub.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7288   declare i64 @llvm.atomic.load.sub.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7289 </pre>
7290
7291 <h5>Overview:</h5>
7292 <p>This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
7293    <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.</p>
7294
7295 <h5>Arguments:</h5>
7296 <p>The intrinsic takes two arguments, the first a pointer to an integer value
7297    and the second an integer value. The result is also an integer value. These
7298    integer types can have any bit width, but they must all have the same bit
7299    width. The targets may only lower integer representations they support.</p>
7300
7301 <h5>Semantics:</h5>
7302 <p>This intrinsic does a series of operations atomically. It first loads the
7303    value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
7304    result to <tt>ptr</tt>. It yields the original value stored
7305    at <tt>ptr</tt>.</p>
7306
7307 <h5>Examples:</h5>
7308 <pre>
7309 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7310 %ptr      = bitcast i8* %mallocP to i32*
7311             store i32 8, %ptr
7312 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 4)
7313                                 <i>; yields {i32}:result1 = 8</i>
7314 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 2)
7315                                 <i>; yields {i32}:result2 = 4</i>
7316 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32(i32* %ptr, i32 5)
7317                                 <i>; yields {i32}:result3 = 2</i>
7318 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
7319 </pre>
7320
7321 </div>
7322
7323 <!-- _______________________________________________________________________ -->
7324 <div class="doc_subsubsection">
7325   <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
7326   <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
7327   <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
7328   <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
7329 </div>
7330
7331 <div class="doc_text">
7332
7333 <h5>Syntax:</h5>
7334 <p>These are overloaded intrinsics. You can
7335   use <tt>llvm.atomic.load_and</tt>, <tt>llvm.atomic.load_nand</tt>,
7336   <tt>llvm.atomic.load_or</tt>, and <tt>llvm.atomic.load_xor</tt> on any integer
7337   bit width and for different address spaces. Not all targets support all bit
7338   widths however.</p>
7339
7340 <pre>
7341   declare i8 @llvm.atomic.load.and.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7342   declare i16 @llvm.atomic.load.and.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7343   declare i32 @llvm.atomic.load.and.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7344   declare i64 @llvm.atomic.load.and.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7345 </pre>
7346
7347 <pre>
7348   declare i8 @llvm.atomic.load.or.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7349   declare i16 @llvm.atomic.load.or.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7350   declare i32 @llvm.atomic.load.or.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7351   declare i64 @llvm.atomic.load.or.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7352 </pre>
7353
7354 <pre>
7355   declare i8 @llvm.atomic.load.nand.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7356   declare i16 @llvm.atomic.load.nand.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7357   declare i32 @llvm.atomic.load.nand.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7358   declare i64 @llvm.atomic.load.nand.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7359 </pre>
7360
7361 <pre>
7362   declare i8 @llvm.atomic.load.xor.i8.p0i32(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7363   declare i16 @llvm.atomic.load.xor.i16.p0i32(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7364   declare i32 @llvm.atomic.load.xor.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7365   declare i64 @llvm.atomic.load.xor.i64.p0i32(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7366 </pre>
7367
7368 <h5>Overview:</h5>
7369 <p>These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
7370    the value stored in memory at <tt>ptr</tt>. It yields the original value
7371    at <tt>ptr</tt>.</p>
7372
7373 <h5>Arguments:</h5>
7374 <p>These intrinsics take two arguments, the first a pointer to an integer value
7375    and the second an integer value. The result is also an integer value. These
7376    integer types can have any bit width, but they must all have the same bit
7377    width. The targets may only lower integer representations they support.</p>
7378
7379 <h5>Semantics:</h5>
7380 <p>These intrinsics does a series of operations atomically. They first load the
7381    value stored at <tt>ptr</tt>. They then do the bitwise
7382    operation <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the
7383    original value stored at <tt>ptr</tt>.</p>
7384
7385 <h5>Examples:</h5>
7386 <pre>
7387 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7388 %ptr      = bitcast i8* %mallocP to i32*
7389             store i32 0x0F0F, %ptr
7390 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32(i32* %ptr, i32 0xFF)
7391                                 <i>; yields {i32}:result0 = 0x0F0F</i>
7392 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32(i32* %ptr, i32 0xFF)
7393                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
7394 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32(i32* %ptr, i32 0F)
7395                                 <i>; yields {i32}:result2 = 0xF0</i>
7396 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32(i32* %ptr, i32 0F)
7397                                 <i>; yields {i32}:result3 = FF</i>
7398 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
7399 </pre>
7400
7401 </div>
7402
7403 <!-- _______________________________________________________________________ -->
7404 <div class="doc_subsubsection">
7405   <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
7406   <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
7407   <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
7408   <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
7409 </div>
7410
7411 <div class="doc_text">
7412
7413 <h5>Syntax:</h5>
7414 <p>These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
7415    <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
7416    <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
7417    address spaces. Not all targets support all bit widths however.</p>
7418
7419 <pre>
7420   declare i8 @llvm.atomic.load.max.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7421   declare i16 @llvm.atomic.load.max.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7422   declare i32 @llvm.atomic.load.max.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7423   declare i64 @llvm.atomic.load.max.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7424 </pre>
7425
7426 <pre>
7427   declare i8 @llvm.atomic.load.min.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7428   declare i16 @llvm.atomic.load.min.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7429   declare i32 @llvm.atomic.load.min.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7430   declare i64 @llvm.atomic.load.min.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7431 </pre>
7432
7433 <pre>
7434   declare i8 @llvm.atomic.load.umax.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7435   declare i16 @llvm.atomic.load.umax.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7436   declare i32 @llvm.atomic.load.umax.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7437   declare i64 @llvm.atomic.load.umax.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7438 </pre>
7439
7440 <pre>
7441   declare i8 @llvm.atomic.load.umin.i8.p0i8(i8* &lt;ptr&gt;, i8 &lt;delta&gt;)
7442   declare i16 @llvm.atomic.load.umin.i16.p0i16(i16* &lt;ptr&gt;, i16 &lt;delta&gt;)
7443   declare i32 @llvm.atomic.load.umin.i32.p0i32(i32* &lt;ptr&gt;, i32 &lt;delta&gt;)
7444   declare i64 @llvm.atomic.load.umin.i64.p0i64(i64* &lt;ptr&gt;, i64 &lt;delta&gt;)
7445 </pre>
7446
7447 <h5>Overview:</h5>
7448 <p>These intrinsics takes the signed or unsigned minimum or maximum of
7449    <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
7450    original value at <tt>ptr</tt>.</p>
7451
7452 <h5>Arguments:</h5>
7453 <p>These intrinsics take two arguments, the first a pointer to an integer value
7454    and the second an integer value. The result is also an integer value. These
7455    integer types can have any bit width, but they must all have the same bit
7456    width. The targets may only lower integer representations they support.</p>
7457
7458 <h5>Semantics:</h5>
7459 <p>These intrinsics does a series of operations atomically. They first load the
7460    value stored at <tt>ptr</tt>. They then do the signed or unsigned min or
7461    max <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They
7462    yield the original value stored at <tt>ptr</tt>.</p>
7463
7464 <h5>Examples:</h5>
7465 <pre>
7466 %mallocP  = tail call i8* @malloc(i32 ptrtoint (i32* getelementptr (i32* null, i32 1) to i32))
7467 %ptr      = bitcast i8* %mallocP to i32*
7468             store i32 7, %ptr
7469 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32(i32* %ptr, i32 -2)
7470                                 <i>; yields {i32}:result0 = 7</i>
7471 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32(i32* %ptr, i32 8)
7472                                 <i>; yields {i32}:result1 = -2</i>
7473 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32(i32* %ptr, i32 10)
7474                                 <i>; yields {i32}:result2 = 8</i>
7475 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32(i32* %ptr, i32 30)
7476                                 <i>; yields {i32}:result3 = 8</i>
7477 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
7478 </pre>
7479
7480 </div>
7481
7482
7483 <!-- ======================================================================= -->
7484 <div class="doc_subsection">
7485   <a name="int_memorymarkers">Memory Use Markers</a>
7486 </div>
7487
7488 <div class="doc_text">
7489
7490 <p>This class of intrinsics exists to information about the lifetime of memory
7491    objects and ranges where variables are immutable.</p>
7492
7493 </div>
7494
7495 <!-- _______________________________________________________________________ -->
7496 <div class="doc_subsubsection">
7497   <a name="int_lifetime_start">'<tt>llvm.lifetime.start</tt>' Intrinsic</a>
7498 </div>
7499
7500 <div class="doc_text">
7501
7502 <h5>Syntax:</h5>
7503 <pre>
7504   declare void @llvm.lifetime.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7505 </pre>
7506
7507 <h5>Overview:</h5>
7508 <p>The '<tt>llvm.lifetime.start</tt>' intrinsic specifies the start of a memory
7509    object's lifetime.</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 before this point in the code, the value of the
7518    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7519    never be used and has an undefined value.  A load from the pointer that
7520    precedes this intrinsic can be replaced with
7521    <tt>'<a href="#undefvalues">undef</a>'</tt>.</p>
7522
7523 </div>
7524
7525 <!-- _______________________________________________________________________ -->
7526 <div class="doc_subsubsection">
7527   <a name="int_lifetime_end">'<tt>llvm.lifetime.end</tt>' Intrinsic</a>
7528 </div>
7529
7530 <div class="doc_text">
7531
7532 <h5>Syntax:</h5>
7533 <pre>
7534   declare void @llvm.lifetime.end(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7535 </pre>
7536
7537 <h5>Overview:</h5>
7538 <p>The '<tt>llvm.lifetime.end</tt>' intrinsic specifies the end of a memory
7539    object's lifetime.</p>
7540
7541 <h5>Arguments:</h5>
7542 <p>The first argument is a constant integer representing the size of the
7543    object, or -1 if it is variable sized.  The second argument is a pointer to
7544    the object.</p>
7545
7546 <h5>Semantics:</h5>
7547 <p>This intrinsic indicates that after this point in the code, the value of the
7548    memory pointed to by <tt>ptr</tt> is dead.  This means that it is known to
7549    never be used and has an undefined value.  Any stores into the memory object
7550    following this intrinsic may be removed as dead.
7551
7552 </div>
7553
7554 <!-- _______________________________________________________________________ -->
7555 <div class="doc_subsubsection">
7556   <a name="int_invariant_start">'<tt>llvm.invariant.start</tt>' Intrinsic</a>
7557 </div>
7558
7559 <div class="doc_text">
7560
7561 <h5>Syntax:</h5>
7562 <pre>
7563   declare {}* @llvm.invariant.start(i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7564 </pre>
7565
7566 <h5>Overview:</h5>
7567 <p>The '<tt>llvm.invariant.start</tt>' intrinsic specifies that the contents of
7568    a memory object will not change.</p>
7569
7570 <h5>Arguments:</h5>
7571 <p>The first argument is a constant integer representing the size of the
7572    object, or -1 if it is variable sized.  The second argument is a pointer to
7573    the object.</p>
7574
7575 <h5>Semantics:</h5>
7576 <p>This intrinsic indicates that until an <tt>llvm.invariant.end</tt> that uses
7577    the return value, the referenced memory location is constant and
7578    unchanging.</p>
7579
7580 </div>
7581
7582 <!-- _______________________________________________________________________ -->
7583 <div class="doc_subsubsection">
7584   <a name="int_invariant_end">'<tt>llvm.invariant.end</tt>' Intrinsic</a>
7585 </div>
7586
7587 <div class="doc_text">
7588
7589 <h5>Syntax:</h5>
7590 <pre>
7591   declare void @llvm.invariant.end({}* &lt;start&gt;, i64 &lt;size&gt;, i8* nocapture &lt;ptr&gt;)
7592 </pre>
7593
7594 <h5>Overview:</h5>
7595 <p>The '<tt>llvm.invariant.end</tt>' intrinsic specifies that the contents of
7596    a memory object are mutable.</p>
7597
7598 <h5>Arguments:</h5>
7599 <p>The first argument is the matching <tt>llvm.invariant.start</tt> intrinsic.
7600    The second argument is a constant integer representing the size of the
7601    object, or -1 if it is variable sized and the third argument is a pointer
7602    to the object.</p>
7603
7604 <h5>Semantics:</h5>
7605 <p>This intrinsic indicates that the memory is mutable again.</p>
7606
7607 </div>
7608
7609 <!-- ======================================================================= -->
7610 <div class="doc_subsection">
7611   <a name="int_general">General Intrinsics</a>
7612 </div>
7613
7614 <div class="doc_text">
7615
7616 <p>This class of intrinsics is designed to be generic and has no specific
7617    purpose.</p>
7618
7619 </div>
7620
7621 <!-- _______________________________________________________________________ -->
7622 <div class="doc_subsubsection">
7623   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
7624 </div>
7625
7626 <div class="doc_text">
7627
7628 <h5>Syntax:</h5>
7629 <pre>
7630   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7631 </pre>
7632
7633 <h5>Overview:</h5>
7634 <p>The '<tt>llvm.var.annotation</tt>' intrinsic.</p>
7635
7636 <h5>Arguments:</h5>
7637 <p>The first argument is a pointer to a value, the second is a pointer to a
7638    global string, the third is a pointer to a global string which is the source
7639    file name, and the last argument is the line number.</p>
7640
7641 <h5>Semantics:</h5>
7642 <p>This intrinsic allows annotation of local variables with arbitrary strings.
7643    This can be useful for special purpose optimizations that want to look for
7644    these annotations.  These have no other defined use, they are ignored by code
7645    generation and optimization.</p>
7646
7647 </div>
7648
7649 <!-- _______________________________________________________________________ -->
7650 <div class="doc_subsubsection">
7651   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
7652 </div>
7653
7654 <div class="doc_text">
7655
7656 <h5>Syntax:</h5>
7657 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
7658    any integer bit width.</p>
7659
7660 <pre>
7661   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7662   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7663   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7664   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7665   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt;)
7666 </pre>
7667
7668 <h5>Overview:</h5>
7669 <p>The '<tt>llvm.annotation</tt>' intrinsic.</p>
7670
7671 <h5>Arguments:</h5>
7672 <p>The first argument is an integer value (result of some expression), the
7673    second is a pointer to a global string, the third is a pointer to a global
7674    string which is the source file name, and the last argument is the line
7675    number.  It returns the value of the first argument.</p>
7676
7677 <h5>Semantics:</h5>
7678 <p>This intrinsic allows annotations to be put on arbitrary expressions with
7679    arbitrary strings.  This can be useful for special purpose optimizations that
7680    want to look for these annotations.  These have no other defined use, they
7681    are ignored by code generation and optimization.</p>
7682
7683 </div>
7684
7685 <!-- _______________________________________________________________________ -->
7686 <div class="doc_subsubsection">
7687   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
7688 </div>
7689
7690 <div class="doc_text">
7691
7692 <h5>Syntax:</h5>
7693 <pre>
7694   declare void @llvm.trap()
7695 </pre>
7696
7697 <h5>Overview:</h5>
7698 <p>The '<tt>llvm.trap</tt>' intrinsic.</p>
7699
7700 <h5>Arguments:</h5>
7701 <p>None.</p>
7702
7703 <h5>Semantics:</h5>
7704 <p>This intrinsics is lowered to the target dependent trap instruction. If the
7705    target does not have a trap instruction, this intrinsic will be lowered to
7706    the call of the <tt>abort()</tt> function.</p>
7707
7708 </div>
7709
7710 <!-- _______________________________________________________________________ -->
7711 <div class="doc_subsubsection">
7712   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
7713 </div>
7714
7715 <div class="doc_text">
7716
7717 <h5>Syntax:</h5>
7718 <pre>
7719   declare void @llvm.stackprotector(i8* &lt;guard&gt;, i8** &lt;slot&gt;)
7720 </pre>
7721
7722 <h5>Overview:</h5>
7723 <p>The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and
7724    stores it onto the stack at <tt>slot</tt>. The stack slot is adjusted to
7725    ensure that it is placed on the stack before local variables.</p>
7726
7727 <h5>Arguments:</h5>
7728 <p>The <tt>llvm.stackprotector</tt> intrinsic requires two pointer
7729    arguments. The first argument is the value loaded from the stack
7730    guard <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt>
7731    that has enough space to hold the value of the guard.</p>
7732
7733 <h5>Semantics:</h5>
7734 <p>This intrinsic causes the prologue/epilogue inserter to force the position of
7735    the <tt>AllocaInst</tt> stack slot to be before local variables on the
7736    stack. This is to ensure that if a local variable on the stack is
7737    overwritten, it will destroy the value of the guard. When the function exits,
7738    the guard on the stack is checked against the original guard. If they are
7739    different, then the program aborts by calling the <tt>__stack_chk_fail()</tt>
7740    function.</p>
7741
7742 </div>
7743
7744 <!-- _______________________________________________________________________ -->
7745 <div class="doc_subsubsection">
7746   <a name="int_objectsize">'<tt>llvm.objectsize</tt>' Intrinsic</a>
7747 </div>
7748
7749 <div class="doc_text">
7750
7751 <h5>Syntax:</h5>
7752 <pre>
7753   declare i32 @llvm.objectsize.i32(i8* &lt;object&gt;, i1 &lt;type&gt;)
7754   declare i64 @llvm.objectsize.i64(i8* &lt;object&gt;, i1 &lt;type&gt;)
7755 </pre>
7756
7757 <h5>Overview:</h5>
7758 <p>The <tt>llvm.objectsize</tt> intrinsic is designed to provide information to
7759    the optimizers to determine at compile time whether a) an operation (like
7760    memcpy) will overflow a buffer that corresponds to an object, or b) that a
7761    runtime check for overflow isn't necessary. An object in this context means
7762    an allocation of a specific class, structure, array, or other object.</p>
7763
7764 <h5>Arguments:</h5>
7765 <p>The <tt>llvm.objectsize</tt> intrinsic takes two arguments. The first
7766    argument is a pointer to or into the <tt>object</tt>. The second argument
7767    is a boolean 0 or 1. This argument determines whether you want the
7768    maximum (0) or minimum (1) bytes remaining. This needs to be a literal 0 or
7769    1, variables are not allowed.</p>
7770
7771 <h5>Semantics:</h5>
7772 <p>The <tt>llvm.objectsize</tt> intrinsic is lowered to either a constant
7773    representing the size of the object concerned, or <tt>i32/i64 -1 or 0</tt>,
7774    depending on the <tt>type</tt> argument, if the size cannot be determined at
7775    compile time.</p>
7776
7777 </div>
7778
7779 <!-- *********************************************************************** -->
7780 <hr>
7781 <address>
7782   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
7783   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
7784   <a href="http://validator.w3.org/check/referer"><img
7785   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
7786
7787   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
7788   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
7789   Last modified: $Date$
7790 </address>
7791
7792 </body>
7793 </html>