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