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></li>
  24       <li><a href="#callingconv">Calling Conventions</a></li>
  25       <li><a href="#globalvars">Global Variables</a></li>
  26       <li><a href="#functionstructure">Functions</a></li>
  27       <li><a href="#paramattrs">Parameter Attributes</a></li>
  28       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  29     </ol>
  30   </li>
  31   <li><a href="#typesystem">Type System</a>
  32     <ol>
  33       <li><a href="#t_primitive">Primitive Types</a>
  34         <ol>
  35           <li><a href="#t_classifications">Type Classifications</a></li>
  36         </ol>
  37       </li>
  38       <li><a href="#t_derived">Derived Types</a>
  39         <ol>
  40           <li><a href="#t_array">Array Type</a></li>
  41           <li><a href="#t_function">Function Type</a></li>
  42           <li><a href="#t_pointer">Pointer Type</a></li>
  43           <li><a href="#t_struct">Structure Type</a></li>
  44           <li><a href="#t_pstruct">Packed Structure Type</a></li>
  45           <li><a href="#t_vector">Vector Type</a></li>
  46           <li><a href="#t_opaque">Opaque Type</a></li>
  47         </ol>
  48       </li>
  49     </ol>
  50   </li>
  51   <li><a href="#constants">Constants</a>
  52     <ol>
  53       <li><a href="#simpleconstants">Simple Constants</a>
  54       <li><a href="#aggregateconstants">Aggregate Constants</a>
  55       <li><a href="#globalconstants">Global Variable and Function Addresses</a>
  56       <li><a href="#undefvalues">Undefined Values</a>
  57       <li><a href="#constantexprs">Constant Expressions</a>
  58     </ol>
  59   </li>
  60   <li><a href="#othervalues">Other Values</a>
  61     <ol>
  62       <li><a href="#inlineasm">Inline Assembler Expressions</a>
  63     </ol>
  64   </li>
  65   <li><a href="#instref">Instruction Reference</a>
  66     <ol>
  67       <li><a href="#terminators">Terminator Instructions</a>
  68         <ol>
  69           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
  70           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
  71           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
  72           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
  73           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
  74           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
  75         </ol>
  76       </li>
  77       <li><a href="#binaryops">Binary Operations</a>
  78         <ol>
  79           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
  80           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
  81           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
  82           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
  83           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
  84           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
  85           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
  86           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
  87           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
  88         </ol>
  89       </li>
  90       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
  91         <ol>
  92           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
  93           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
  94           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
  95           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
  96           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
  97           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
  98         </ol>
  99       </li>
 100       <li><a href="#vectorops">Vector Operations</a>
 101         <ol>
 102           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 103           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 104           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 105         </ol>
 106       </li>
 107       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 108         <ol>
 109           <li><a href="#i_malloc">'<tt>malloc</tt>'   Instruction</a></li>
 110           <li><a href="#i_free">'<tt>free</tt>'     Instruction</a></li>
 111           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
 112          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 113          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 114          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 115         </ol>
 116       </li>
 117       <li><a href="#convertops">Conversion Operations</a>
 118         <ol>
 119           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 120           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 121           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 122           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 123           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 124           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 125           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 126           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 127           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 128           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 129           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 130           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 131         </ol>
 132       <li><a href="#otherops">Other Operations</a>
 133         <ol>
 134           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 135           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 136           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 137           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 138           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 139           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 140         </ol>
 141       </li>
 142     </ol>
 143   </li>
 144   <li><a href="#intrinsics">Intrinsic Functions</a>
 145     <ol>
 146       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 147         <ol>
 148           <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 149           <li><a href="#i_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 150           <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 151         </ol>
 152       </li>
 153       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 154         <ol>
 155           <li><a href="#i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 156           <li><a href="#i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 157           <li><a href="#i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 158         </ol>
 159       </li>
 160       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 161         <ol>
 162           <li><a href="#i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 163           <li><a href="#i_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 164           <li><a href="#i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 165           <li><a href="#i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 166           <li><a href="#i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 167           <li><a href="#i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 168           <li><a href="#i_readcyclecounter"><tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 169         </ol>
 170       </li>
 171       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 172         <ol>
 173           <li><a href="#i_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 174           <li><a href="#i_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 175           <li><a href="#i_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 176           <li><a href="#i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 177           <li><a href="#i_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 178         </ol>
 179       </li>
 180       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 181         <ol>
 182           <li><a href="#i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 183           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 184           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 185           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 186         </ol>
 187       </li>
 188       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 189     </ol>
 190   </li>
 191 </ol>
 192
 193 <div class="doc_author">
 194   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 195             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 196 </div>
 197
 198 <!-- *********************************************************************** -->
 199 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 200 <!-- *********************************************************************** -->
 201
 202 <div class="doc_text">
 203 <p>This document is a reference manual for the LLVM assembly language.
 204 LLVM is an SSA based representation that provides type safety,
 205 low-level operations, flexibility, and the capability of representing
 206 'all' high-level languages cleanly.  It is the common code
 207 representation used throughout all phases of the LLVM compilation
 208 strategy.</p>
 209 </div>
 210
 211 <!-- *********************************************************************** -->
 212 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 213 <!-- *********************************************************************** -->
 214
 215 <div class="doc_text">
 216
 217 <p>The LLVM code representation is designed to be used in three
 218 different forms: as an in-memory compiler IR, as an on-disk bytecode
 219 representation (suitable for fast loading by a Just-In-Time compiler),
 220 and as a human readable assembly language representation.  This allows
 221 LLVM to provide a powerful intermediate representation for efficient
 222 compiler transformations and analysis, while providing a natural means
 223 to debug and visualize the transformations.  The three different forms
 224 of LLVM are all equivalent.  This document describes the human readable
 225 representation and notation.</p>
 226
 227 <p>The LLVM representation aims to be light-weight and low-level
 228 while being expressive, typed, and extensible at the same time.  It
 229 aims to be a "universal IR" of sorts, by being at a low enough level
 230 that high-level ideas may be cleanly mapped to it (similar to how
 231 microprocessors are "universal IR's", allowing many source languages to
 232 be mapped to them).  By providing type information, LLVM can be used as
 233 the target of optimizations: for example, through pointer analysis, it
 234 can be proven that a C automatic variable is never accessed outside of
 235 the current function... allowing it to be promoted to a simple SSA
 236 value instead of a memory location.</p>
 237
 238 </div>
 239
 240 <!-- _______________________________________________________________________ -->
 241 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 242
 243 <div class="doc_text">
 244
 245 <p>It is important to note that this document describes 'well formed'
 246 LLVM assembly language.  There is a difference between what the parser
 247 accepts and what is considered 'well formed'.  For example, the
 248 following instruction is syntactically okay, but not well formed:</p>
 249
 250 <pre>
 251   %x = <a href="#i_add">add</a> i32 1, %x
 252 </pre>
 253
 254 <p>...because the definition of <tt>%x</tt> does not dominate all of
 255 its uses. The LLVM infrastructure provides a verification pass that may
 256 be used to verify that an LLVM module is well formed.  This pass is
 257 automatically run by the parser after parsing input assembly and by
 258 the optimizer before it outputs bytecode.  The violations pointed out
 259 by the verifier pass indicate bugs in transformation passes or input to
 260 the parser.</p>
 261
 262 <!-- Describe the typesetting conventions here. --> </div>
 263
 264 <!-- *********************************************************************** -->
 265 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 266 <!-- *********************************************************************** -->
 267
 268 <div class="doc_text">
 269
 270 <p>LLVM uses three different forms of identifiers, for different
 271 purposes:</p>
 272
 273 <ol>
 274   <li>Named values are represented as a string of characters with a '%' prefix.
 275   For example, %foo, %DivisionByZero, %a.really.long.identifier.  The actual
 276   regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
 277   Identifiers which require other characters in their names can be surrounded
 278   with quotes.  In this way, anything except a <tt>&quot;</tt> character can be used
 279   in a name.</li>
 280
 281   <li>Unnamed values are represented as an unsigned numeric value with a '%'
 282   prefix.  For example, %12, %2, %44.</li>
 283
 284   <li>Constants, which are described in a <a href="#constants">section about
 285   constants</a>, below.</li>
 286 </ol>
 287
 288 <p>LLVM requires that values start with a '%' sign for two reasons: Compilers
 289 don't need to worry about name clashes with reserved words, and the set of
 290 reserved words may be expanded in the future without penalty.  Additionally,
 291 unnamed identifiers allow a compiler to quickly come up with a temporary
 292 variable without having to avoid symbol table conflicts.</p>
 293
 294 <p>Reserved words in LLVM are very similar to reserved words in other
 295 languages. There are keywords for different opcodes
 296 ('<tt><a href="#i_add">add</a></tt>',
 297  '<tt><a href="#i_bitcast">bitcast</a></tt>',
 298  '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
 299 href="#t_void">void</a></tt>', '<tt><a href="#t_primitive">i32</a></tt>', etc...),
 300 and others.  These reserved words cannot conflict with variable names, because
 301 none of them start with a '%' character.</p>
 302
 303 <p>Here is an example of LLVM code to multiply the integer variable
 304 '<tt>%X</tt>' by 8:</p>
 305
 306 <p>The easy way:</p>
 307
 308 <pre>
 309   %result = <a href="#i_mul">mul</a> i32 %X, 8
 310 </pre>
 311
 312 <p>After strength reduction:</p>
 313
 314 <pre>
 315   %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 316 </pre>
 317
 318 <p>And the hard way:</p>
 319
 320 <pre>
 321   <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 322   <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 323   %result = <a href="#i_add">add</a> i32 %1, %1
 324 </pre>
 325
 326 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
 327 important lexical features of LLVM:</p>
 328
 329 <ol>
 330
 331   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 332   line.</li>
 333
 334   <li>Unnamed temporaries are created when the result of a computation is not
 335   assigned to a named value.</li>
 336
 337   <li>Unnamed temporaries are numbered sequentially</li>
 338
 339 </ol>
 340
 341 <p>...and it also shows a convention that we follow in this document.  When
 342 demonstrating instructions, we will follow an instruction with a comment that
 343 defines the type and name of value produced.  Comments are shown in italic
 344 text.</p>
 345
 346 </div>
 347
 348 <!-- *********************************************************************** -->
 349 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 350 <!-- *********************************************************************** -->
 351
 352 <!-- ======================================================================= -->
 353 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 354 </div>
 355
 356 <div class="doc_text">
 357
 358 <p>LLVM programs are composed of "Module"s, each of which is a
 359 translation unit of the input programs.  Each module consists of
 360 functions, global variables, and symbol table entries.  Modules may be
 361 combined together with the LLVM linker, which merges function (and
 362 global variable) definitions, resolves forward declarations, and merges
 363 symbol table entries. Here is an example of the "hello world" module:</p>
 364
 365 <pre><i>; Declare the string constant as a global constant...</i>
 366 <a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a
 367  href="#globalvars">constant</a> <a href="#t_array">[13 x i8 ]</a> c"hello world\0A\00"          <i>; [13 x i8 ]*</i>
 368
 369 <i>; External declaration of the puts function</i>
 370 <a href="#functionstructure">declare</a> i32 %puts(i8 *)                                            <i>; i32(i8 *)* </i>
 371
 372 <i>; Global variable / Function body section separator</i>
 373 implementation
 374
 375 <i>; Definition of main function</i>
 376 define i32 %main() {                                                 <i>; i32()* </i>
 377         <i>; Convert [13x i8 ]* to i8  *...</i>
 378         %cast210 = <a
 379  href="#i_getelementptr">getelementptr</a> [13 x i8 ]* %.LC0, i64 0, i64 0 <i>; i8 *</i>
 380
 381         <i>; Call puts function to write out the string to stdout...</i>
 382         <a
 383  href="#i_call">call</a> i32 %puts(i8 * %cast210)                              <i>; i32</i>
 384         <a
 385  href="#i_ret">ret</a> i32 0<br>}<br></pre>
 386
 387 <p>This example is made up of a <a href="#globalvars">global variable</a>
 388 named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
 389 function, and a <a href="#functionstructure">function definition</a>
 390 for "<tt>main</tt>".</p>
 391
 392 <p>In general, a module is made up of a list of global values,
 393 where both functions and global variables are global values.  Global values are
 394 represented by a pointer to a memory location (in this case, a pointer to an
 395 array of char, and a pointer to a function), and have one of the following <a
 396 href="#linkage">linkage types</a>.</p>
 397
 398 <p>Due to a limitation in the current LLVM assembly parser (it is limited by
 399 one-token lookahead), modules are split into two pieces by the "implementation"
 400 keyword.  Global variable prototypes and definitions must occur before the
 401 keyword, and function definitions must occur after it.  Function prototypes may
 402 occur either before or after it.  In the future, the implementation keyword may
 403 become a noop, if the parser gets smarter.</p>
 404
 405 </div>
 406
 407 <!-- ======================================================================= -->
 408 <div class="doc_subsection">
 409   <a name="linkage">Linkage Types</a>
 410 </div>
 411
 412 <div class="doc_text">
 413
 414 <p>
 415 All Global Variables and Functions have one of the following types of linkage:
 416 </p>
 417
 418 <dl>
 419
 420   <dt><tt><b><a name="linkage_internal">internal</a></b></tt> </dt>
 421
 422   <dd>Global values with internal linkage are only directly accessible by
 423   objects in the current module.  In particular, linking code into a module with
 424   an internal global value may cause the internal to be renamed as necessary to
 425   avoid collisions.  Because the symbol is internal to the module, all
 426   references can be updated.  This corresponds to the notion of the
 427   '<tt>static</tt>' keyword in C.
 428   </dd>
 429
 430   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
 431
 432   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 433   the same name when linkage occurs.  This is typically used to implement
 434   inline functions, templates, or other code which must be generated in each
 435   translation unit that uses it.  Unreferenced <tt>linkonce</tt> globals are
 436   allowed to be discarded.
 437   </dd>
 438
 439   <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
 440
 441   <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt> linkage,
 442   except that unreferenced <tt>weak</tt> globals may not be discarded.  This is
 443   used for globals that may be emitted in multiple translation units, but that
 444   are not guaranteed to be emitted into every translation unit that uses them.
 445   One example of this are common globals in C, such as "<tt>int X;</tt>" at
 446   global scope.
 447   </dd>
 448
 449   <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
 450
 451   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 452   pointer to array type.  When two global variables with appending linkage are
 453   linked together, the two global arrays are appended together.  This is the
 454   LLVM, typesafe, equivalent of having the system linker append together
 455   "sections" with identical names when .o files are linked.
 456   </dd>
 457
 458   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt>: </dt>
 459   <dd>The semantics of this linkage follow the ELF model: the symbol is weak
 460     until linked, if not linked, the symbol becomes null instead of being an
 461     undefined reference.
 462   </dd>
 463 </dl>
 464
 465   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 466
 467   <dd>If none of the above identifiers are used, the global is externally
 468   visible, meaning that it participates in linkage and can be used to resolve
 469   external symbol references.
 470   </dd>
 471
 472   <p>
 473   The next two types of linkage are targeted for Microsoft Windows platform
 474   only. They are designed to support importing (exporting) symbols from (to)
 475   DLLs.
 476   </p>
 477
 478   <dl>
 479   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt>: </dt>
 480
 481   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 482     or variable via a global pointer to a pointer that is set up by the DLL
 483     exporting the symbol. On Microsoft Windows targets, the pointer name is
 484     formed by combining <code>_imp__</code> and the function or variable name.
 485   </dd>
 486
 487   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt>: </dt>
 488
 489   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 490     pointer to a pointer in a DLL, so that it can be referenced with the
 491     <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 492     name is formed by combining <code>_imp__</code> and the function or variable
 493     name.
 494   </dd>
 495
 496 </dl>
 497
 498 <p><a name="linkage_external"></a>For example, since the "<tt>.LC0</tt>"
 499 variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
 500 variable and was linked with this one, one of the two would be renamed,
 501 preventing a collision.  Since "<tt>main</tt>" and "<tt>puts</tt>" are
 502 external (i.e., lacking any linkage declarations), they are accessible
 503 outside of the current module.</p>
 504 <p>It is illegal for a function <i>declaration</i>
 505 to have any linkage type other than "externally visible", <tt>dllimport</tt>,
 506 or <tt>extern_weak</tt>.</p>
 507
 508 </div>
 509
 510 <!-- ======================================================================= -->
 511 <div class="doc_subsection">
 512   <a name="callingconv">Calling Conventions</a>
 513 </div>
 514
 515 <div class="doc_text">
 516
 517 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 518 and <a href="#i_invoke">invokes</a> can all have an optional calling convention
 519 specified for the call.  The calling convention of any pair of dynamic
 520 caller/callee must match, or the behavior of the program is undefined.  The
 521 following calling conventions are supported by LLVM, and more may be added in
 522 the future:</p>
 523
 524 <dl>
 525   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 526
 527   <dd>This calling convention (the default if no other calling convention is
 528   specified) matches the target C calling conventions.  This calling convention
 529   supports varargs function calls and tolerates some mismatch in the declared
 530   prototype and implemented declaration of the function (as does normal C).
 531   </dd>
 532
 533   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 534
 535   <dd>This calling convention attempts to make calls as fast as possible
 536   (e.g. by passing things in registers).  This calling convention allows the
 537   target to use whatever tricks it wants to produce fast code for the target,
 538   without having to conform to an externally specified ABI.  Implementations of
 539   this convention should allow arbitrary tail call optimization to be supported.
 540   This calling convention does not support varargs and requires the prototype of
 541   all callees to exactly match the prototype of the function definition.
 542   </dd>
 543
 544   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 545
 546   <dd>This calling convention attempts to make code in the caller as efficient
 547   as possible under the assumption that the call is not commonly executed.  As
 548   such, these calls often preserve all registers so that the call does not break
 549   any live ranges in the caller side.  This calling convention does not support
 550   varargs and requires the prototype of all callees to exactly match the
 551   prototype of the function definition.
 552   </dd>
 553
 554   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 555
 556   <dd>Any calling convention may be specified by number, allowing
 557   target-specific calling conventions to be used.  Target specific calling
 558   conventions start at 64.
 559   </dd>
 560 </dl>
 561
 562 <p>More calling conventions can be added/defined on an as-needed basis, to
 563 support pascal conventions or any other well-known target-independent
 564 convention.</p>
 565
 566 </div>
 567
 568 <!-- ======================================================================= -->
 569 <div class="doc_subsection">
 570   <a name="visibility">Visibility Styles</a>
 571 </div>
 572
 573 <div class="doc_text">
 574
 575 <p>
 576 All Global Variables and Functions have one of the following visibility styles:
 577 </p>
 578
 579 <dl>
 580   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 581
 582   <dd>On ELF, default visibility means that the declaration is visible to other
 583     modules and, in shared libraries, means that the declared entity may be
 584     overridden. On Darwin, default visibility means that the declaration is
 585     visible to other modules. Default visibility corresponds to "external
 586     linkage" in the language.
 587   </dd>
 588
 589   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 590
 591   <dd>Two declarations of an object with hidden visibility refer to the same
 592     object if they are in the same shared object. Usually, hidden visibility
 593     indicates that the symbol will not be placed into the dynamic symbol table,
 594     so no other module (executable or shared library) can reference it
 595     directly.
 596   </dd>
 597
 598 </dl>
 599
 600 </div>
 601
 602 <!-- ======================================================================= -->
 603 <div class="doc_subsection">
 604   <a name="globalvars">Global Variables</a>
 605 </div>
 606
 607 <div class="doc_text">
 608
 609 <p>Global variables define regions of memory allocated at compilation time
 610 instead of run-time.  Global variables may optionally be initialized, may have
 611 an explicit section to be placed in, and may
 612 have an optional explicit alignment specified.  A
 613 variable may be defined as a global "constant," which indicates that the
 614 contents of the variable will <b>never</b> be modified (enabling better
 615 optimization, allowing the global data to be placed in the read-only section of
 616 an executable, etc).  Note that variables that need runtime initialization
 617 cannot be marked "constant" as there is a store to the variable.</p>
 618
 619 <p>
 620 LLVM explicitly allows <em>declarations</em> of global variables to be marked
 621 constant, even if the final definition of the global is not.  This capability
 622 can be used to enable slightly better optimization of the program, but requires
 623 the language definition to guarantee that optimizations based on the
 624 'constantness' are valid for the translation units that do not include the
 625 definition.
 626 </p>
 627
 628 <p>As SSA values, global variables define pointer values that are in
 629 scope (i.e. they dominate) all basic blocks in the program.  Global
 630 variables always define a pointer to their "content" type because they
 631 describe a region of memory, and all memory objects in LLVM are
 632 accessed through pointers.</p>
 633
 634 <p>LLVM allows an explicit section to be specified for globals.  If the target
 635 supports it, it will emit globals to the section specified.</p>
 636
 637 <p>An explicit alignment may be specified for a global.  If not present, or if
 638 the alignment is set to zero, the alignment of the global is set by the target
 639 to whatever it feels convenient.  If an explicit alignment is specified, the
 640 global is forced to have at least that much alignment.  All alignments must be
 641 a power of 2.</p>
 642
 643 <p>For example, the following defines a global with an initializer, section,
 644    and alignment:</p>
 645
 646 <pre>
 647   %G = constant float 1.0, section "foo", align 4
 648 </pre>
 649
 650 </div>
 651
 652
 653 <!-- ======================================================================= -->
 654 <div class="doc_subsection">
 655   <a name="functionstructure">Functions</a>
 656 </div>
 657
 658 <div class="doc_text">
 659
 660 <p>LLVM function definitions consist of the "<tt>define</tt>" keyord,
 661 an optional <a href="#linkage">linkage type</a>, an optional
 662 <a href="#visibility">visibility style</a>, an optional
 663 <a href="#callingconv">calling convention</a>, a return type, an optional
 664 <a href="#paramattrs">parameter attribute</a> for the return type, a function
 665 name, a (possibly empty) argument list (each with optional
 666 <a href="#paramattrs">parameter attributes</a>), an optional section, an
 667 optional alignment, an opening curly brace, a list of basic blocks, and a
 668 closing curly brace.
 669
 670 LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 671 optional <a href="#linkage">linkage type</a>, an optional
 672 <a href="#visibility">visibility style</a>, an optional
 673 <a href="#callingconv">calling convention</a>, a return type, an optional
 674 <a href="#paramattrs">parameter attribute</a> for the return type, a function
 675 name, a possibly empty list of arguments, and an optional alignment.</p>
 676
 677 <p>A function definition contains a list of basic blocks, forming the CFG for
 678 the function.  Each basic block may optionally start with a label (giving the
 679 basic block a symbol table entry), contains a list of instructions, and ends
 680 with a <a href="#terminators">terminator</a> instruction (such as a branch or
 681 function return).</p>
 682
 683 <p>The first basic block in a program is special in two ways: it is immediately
 684 executed on entrance to the function, and it is not allowed to have predecessor
 685 basic blocks (i.e. there can not be any branches to the entry block of a
 686 function).  Because the block can have no predecessors, it also cannot have any
 687 <a href="#i_phi">PHI nodes</a>.</p>
 688
 689 <p>LLVM functions are identified by their name and type signature.  Hence, two
 690 functions with the same name but different parameter lists or return values are
 691 considered different functions, and LLVM will resolve references to each
 692 appropriately.</p>
 693
 694 <p>LLVM allows an explicit section to be specified for functions.  If the target
 695 supports it, it will emit functions to the section specified.</p>
 696
 697 <p>An explicit alignment may be specified for a function.  If not present, or if
 698 the alignment is set to zero, the alignment of the function is set by the target
 699 to whatever it feels convenient.  If an explicit alignment is specified, the
 700 function is forced to have at least that much alignment.  All alignments must be
 701 a power of 2.</p>
 702
 703 </div>
 704
 705 <!-- ======================================================================= -->
 706 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 707 <div class="doc_text">
 708   <p>The return type and each parameter of a function type may have a set of
 709   <i>parameter attributes</i> associated with them. Parameter attributes are
 710   used to communicate additional information about the result or parameters of
 711   a function. Parameter attributes are considered to be part of the function
 712   type so two functions types that differ only by the parameter attributes
 713   are different function types.</p>
 714
 715   <p>Parameter attributes are simple keywords that follow the type specified. If
 716   multiple parameter attributes are needed, they are space separated. For
 717   example:</p><pre>
 718     %someFunc = i16 (i8 sext %someParam) zext
 719     %someFunc = i16 (i8 zext %someParam) zext</pre>
 720   <p>Note that the two function types above are unique because the parameter has
 721   a different attribute (sext in the first one, zext in the second). Also note
 722   that the attribute for the function result (zext) comes immediately after the
 723   argument list.</p>
 724
 725   <p>Currently, only the following parameter attributes are defined:</p>
 726   <dl>
 727     <dt><tt>zext</tt></dt>
 728     <dd>This indicates that the parameter should be zero extended just before
 729     a call to this function.</dd>
 730     <dt><tt>sext</tt></dt>
 731     <dd>This indicates that the parameter should be sign extended just before
 732     a call to this function.</dd>
 733     <dt><tt>inreg</tt></dt>
 734     <dd>This indicates that the parameter should be placed in register (if
 735     possible) during assembling function call. Support for this attribute is
 736     target-specific</dd>
 737     <dt><tt>sret</tt></dt>
 738     <dd>This indicates that the parameter specifies the address of a structure
 739     that is the return value of the function in the source program.
 740     </dd>
 741   </dl>
 742
 743 </div>
 744
 745 <!-- ======================================================================= -->
 746 <div class="doc_subsection">
 747   <a name="moduleasm">Module-Level Inline Assembly</a>
 748 </div>
 749
 750 <div class="doc_text">
 751 <p>
 752 Modules may contain "module-level inline asm" blocks, which corresponds to the
 753 GCC "file scope inline asm" blocks.  These blocks are internally concatenated by
 754 LLVM and treated as a single unit, but may be separated in the .ll file if
 755 desired.  The syntax is very simple:
 756 </p>
 757
 758 <div class="doc_code"><pre>
 759   module asm "inline asm code goes here"
 760   module asm "more can go here"
 761 </pre></div>
 762
 763 <p>The strings can contain any character by escaping non-printable characters.
 764    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
 765    for the number.
 766 </p>
 767
 768 <p>
 769   The inline asm code is simply printed to the machine code .s file when
 770   assembly code is generated.
 771 </p>
 772 </div>
 773
 774
 775 <!-- *********************************************************************** -->
 776 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
 777 <!-- *********************************************************************** -->
 778
 779 <div class="doc_text">
 780
 781 <p>The LLVM type system is one of the most important features of the
 782 intermediate representation.  Being typed enables a number of
 783 optimizations to be performed on the IR directly, without having to do
 784 extra analyses on the side before the transformation.  A strong type
 785 system makes it easier to read the generated code and enables novel
 786 analyses and transformations that are not feasible to perform on normal
 787 three address code representations.</p>
 788
 789 </div>
 790
 791 <!-- ======================================================================= -->
 792 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
 793 <div class="doc_text">
 794 <p>The primitive types are the fundamental building blocks of the LLVM
 795 system. The current set of primitive types is as follows:</p>
 796
 797 <table class="layout">
 798   <tr class="layout">
 799     <td class="left">
 800       <table>
 801         <tbody>
 802         <tr><th>Type</th><th>Description</th></tr>
 803         <tr><td><tt>void</tt></td><td>No value</td></tr>
 804         <tr><td><tt>i8</tt></td><td>8-bit value</td></tr>
 805         <tr><td><tt>i32</tt></td><td>32-bit value</td></tr>
 806         <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
 807         <tr><td><tt>label</tt></td><td>Branch destination</td></tr>
 808         </tbody>
 809       </table>
 810     </td>
 811     <td class="right">
 812       <table>
 813         <tbody>
 814           <tr><th>Type</th><th>Description</th></tr>
 815           <tr><td><tt>i1</tt></td><td>True or False value</td></tr>
 816           <tr><td><tt>i16</tt></td><td>16-bit value</td></tr>
 817           <tr><td><tt>i64</tt></td><td>64-bit value</td></tr>
 818          <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
 819         </tbody>
 820       </table>
 821     </td>
 822   </tr>
 823 </table>
 824 </div>
 825
 826 <!-- _______________________________________________________________________ -->
 827 <div class="doc_subsubsection"> <a name="t_classifications">Type
 828 Classifications</a> </div>
 829 <div class="doc_text">
 830 <p>These different primitive types fall into a few useful
 831 classifications:</p>
 832
 833 <table border="1" cellspacing="0" cellpadding="4">
 834   <tbody>
 835     <tr><th>Classification</th><th>Types</th></tr>
 836     <tr>
 837       <td><a name="t_integer">integer</a></td>
 838       <td><tt>i1, i8, i16, i32, i64</tt></td>
 839     </tr>
 840     <tr>
 841       <td><a name="t_floating">floating point</a></td>
 842       <td><tt>float, double</tt></td>
 843     </tr>
 844     <tr>
 845       <td><a name="t_firstclass">first class</a></td>
 846       <td><tt>i1, i8, i16, i32, i64, float, double, <br/>
 847           <a href="#t_pointer">pointer</a>,<a href="#t_vector">vector</a></tt>
 848       </td>
 849     </tr>
 850   </tbody>
 851 </table>
 852
 853 <p>The <a href="#t_firstclass">first class</a> types are perhaps the
 854 most important.  Values of these types are the only ones which can be
 855 produced by instructions, passed as arguments, or used as operands to
 856 instructions.  This means that all structures and arrays must be
 857 manipulated either by pointer or by component.</p>
 858 </div>
 859
 860 <!-- ======================================================================= -->
 861 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
 862
 863 <div class="doc_text">
 864
 865 <p>The real power in LLVM comes from the derived types in the system.
 866 This is what allows a programmer to represent arrays, functions,
 867 pointers, and other useful types.  Note that these derived types may be
 868 recursive: For example, it is possible to have a two dimensional array.</p>
 869
 870 </div>
 871
 872 <!-- _______________________________________________________________________ -->
 873 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
 874
 875 <div class="doc_text">
 876
 877 <h5>Overview:</h5>
 878
 879 <p>The array type is a very simple derived type that arranges elements
 880 sequentially in memory.  The array type requires a size (number of
 881 elements) and an underlying data type.</p>
 882
 883 <h5>Syntax:</h5>
 884
 885 <pre>
 886   [&lt;# elements&gt; x &lt;elementtype&gt;]
 887 </pre>
 888
 889 <p>The number of elements is a constant integer value; elementtype may
 890 be any type with a size.</p>
 891
 892 <h5>Examples:</h5>
 893 <table class="layout">
 894   <tr class="layout">
 895     <td class="left">
 896       <tt>[40 x i32 ]</tt><br/>
 897       <tt>[41 x i32 ]</tt><br/>
 898       <tt>[40 x i8]</tt><br/>
 899     </td>
 900     <td class="left">
 901       Array of 40 32-bit integer values.<br/>
 902       Array of 41 32-bit integer values.<br/>
 903       Array of 40 8-bit integer values.<br/>
 904     </td>
 905   </tr>
 906 </table>
 907 <p>Here are some examples of multidimensional arrays:</p>
 908 <table class="layout">
 909   <tr class="layout">
 910     <td class="left">
 911       <tt>[3 x [4 x i32]]</tt><br/>
 912       <tt>[12 x [10 x float]]</tt><br/>
 913       <tt>[2 x [3 x [4 x i16]]]</tt><br/>
 914     </td>
 915     <td class="left">
 916       3x4 array of 32-bit integer values.<br/>
 917       12x10 array of single precision floating point values.<br/>
 918       2x3x4 array of 16-bit integer  values.<br/>
 919     </td>
 920   </tr>
 921 </table>
 922
 923 <p>Note that 'variable sized arrays' can be implemented in LLVM with a zero
 924 length array.  Normally, accesses past the end of an array are undefined in
 925 LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
 926 As a special case, however, zero length arrays are recognized to be variable
 927 length.  This allows implementation of 'pascal style arrays' with the  LLVM
 928 type "{ i32, [0 x float]}", for example.</p>
 929
 930 </div>
 931
 932 <!-- _______________________________________________________________________ -->
 933 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
 934 <div class="doc_text">
 935 <h5>Overview:</h5>
 936 <p>The function type can be thought of as a function signature.  It
 937 consists of a return type and a list of formal parameter types.
 938 Function types are usually used to build virtual function tables
 939 (which are structures of pointers to functions), for indirect function
 940 calls, and when defining a function.</p>
 941 <p>
 942 The return type of a function type cannot be an aggregate type.
 943 </p>
 944 <h5>Syntax:</h5>
 945 <pre>  &lt;returntype&gt; (&lt;parameter list&gt;)<br></pre>
 946 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
 947 specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
 948 which indicates that the function takes a variable number of arguments.
 949 Variable argument functions can access their arguments with the <a
 950  href="#int_varargs">variable argument handling intrinsic</a> functions.</p>
 951 <h5>Examples:</h5>
 952 <table class="layout">
 953   <tr class="layout">
 954     <td class="left"><tt>i32 (i32)</tt></td>
 955     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
 956     </td>
 957   </tr><tr class="layout">
 958     <td class="left"><tt>float&nbsp;(i16&nbsp;sext,&nbsp;i32&nbsp;*)&nbsp;*
 959     </tt></td>
 960     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
 961       an <tt>i16</tt> that should be sign extended and a
 962       <a href="#t_pointer">pointer</a> to <tt>i32</tt>, returning
 963       <tt>float</tt>.
 964     </td>
 965   </tr><tr class="layout">
 966     <td class="left"><tt>i32 (i8*, ...)</tt></td>
 967     <td class="left">A vararg function that takes at least one
 968       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
 969       which returns an integer.  This is the signature for <tt>printf</tt> in
 970       LLVM.
 971     </td>
 972   </tr>
 973 </table>
 974
 975 </div>
 976 <!-- _______________________________________________________________________ -->
 977 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
 978 <div class="doc_text">
 979 <h5>Overview:</h5>
 980 <p>The structure type is used to represent a collection of data members
 981 together in memory.  The packing of the field types is defined to match
 982 the ABI of the underlying processor.  The elements of a structure may
 983 be any type that has a size.</p>
 984 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
 985 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
 986 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
 987 instruction.</p>
 988 <h5>Syntax:</h5>
 989 <pre>  { &lt;type list&gt; }<br></pre>
 990 <h5>Examples:</h5>
 991 <table class="layout">
 992   <tr class="layout">
 993     <td class="left">
 994       <tt>{ i32, i32, i32 }</tt><br/>
 995       <tt>{ float, i32 (i32) * }</tt><br/>
 996     </td>
 997     <td class="left">
 998       a triple of three <tt>i32</tt> values<br/>
 999       A pair, where the first element is a <tt>float</tt> and the second element
1000       is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a>
1001       that takes an <tt>i32</tt>, returning an <tt>i32</tt>.<br/>
1002     </td>
1003   </tr>
1004 </table>
1005 </div>
1006
1007 <!-- _______________________________________________________________________ -->
1008 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1009 </div>
1010 <div class="doc_text">
1011 <h5>Overview:</h5>
1012 <p>The packed structure type is used to represent a collection of data members
1013 together in memory.  There is no padding between fields.  Further, the alignment
1014 of a packed structure is 1 byte.  The elements of a packed structure may
1015 be any type that has a size.</p>
1016 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
1017 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
1018 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
1019 instruction.</p>
1020 <h5>Syntax:</h5>
1021 <pre>  &lt; { &lt;type list&gt; } &gt; <br></pre>
1022 <h5>Examples:</h5>
1023 <table class="layout">
1024   <tr class="layout">
1025     <td class="left">
1026       <tt> &lt; { i32, i32, i32 } &gt; </tt><br/>
1027       <tt> &lt; { float, i32 (i32) * } &gt; </tt><br/>
1028     </td>
1029     <td class="left">
1030       a triple of three <tt>i32</tt> values<br/>
1031       A pair, where the first element is a <tt>float</tt> and the second element
1032       is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a>
1033       that takes an <tt>i32</tt>, returning an <tt>i32</tt>.<br/>
1034     </td>
1035   </tr>
1036 </table>
1037 </div>
1038
1039 <!-- _______________________________________________________________________ -->
1040 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1041 <div class="doc_text">
1042 <h5>Overview:</h5>
1043 <p>As in many languages, the pointer type represents a pointer or
1044 reference to another object, which must live in memory.</p>
1045 <h5>Syntax:</h5>
1046 <pre>  &lt;type&gt; *<br></pre>
1047 <h5>Examples:</h5>
1048 <table class="layout">
1049   <tr class="layout">
1050     <td class="left">
1051       <tt>[4x i32]*</tt><br/>
1052       <tt>i32 (i32 *) *</tt><br/>
1053     </td>
1054     <td class="left">
1055       A <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a> of
1056       four <tt>i32</tt> values<br/>
1057       A <a href="#t_pointer">pointer</a> to a <a
1058       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1059       <tt>i32</tt>.<br/>
1060     </td>
1061   </tr>
1062 </table>
1063 </div>
1064
1065 <!-- _______________________________________________________________________ -->
1066 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1067 <div class="doc_text">
1068
1069 <h5>Overview:</h5>
1070
1071 <p>A vector type is a simple derived type that represents a vector
1072 of elements.  Vector types are used when multiple primitive data
1073 are operated in parallel using a single instruction (SIMD).
1074 A vector type requires a size (number of
1075 elements) and an underlying primitive data type.  Vectors must have a power
1076 of two length (1, 2, 4, 8, 16 ...).  Vector types are
1077 considered <a href="#t_firstclass">first class</a>.</p>
1078
1079 <h5>Syntax:</h5>
1080
1081 <pre>
1082   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1083 </pre>
1084
1085 <p>The number of elements is a constant integer value; elementtype may
1086 be any integer or floating point type.</p>
1087
1088 <h5>Examples:</h5>
1089
1090 <table class="layout">
1091   <tr class="layout">
1092     <td class="left">
1093       <tt>&lt;4 x i32&gt;</tt><br/>
1094       <tt>&lt;8 x float&gt;</tt><br/>
1095       <tt>&lt;2 x i64&gt;</tt><br/>
1096     </td>
1097     <td class="left">
1098       Vector of 4 32-bit integer values.<br/>
1099       Vector of 8 floating-point values.<br/>
1100       Vector of 2 64-bit integer values.<br/>
1101     </td>
1102   </tr>
1103 </table>
1104 </div>
1105
1106 <!-- _______________________________________________________________________ -->
1107 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1108 <div class="doc_text">
1109
1110 <h5>Overview:</h5>
1111
1112 <p>Opaque types are used to represent unknown types in the system.  This
1113 corresponds (for example) to the C notion of a foward declared structure type.
1114 In LLVM, opaque types can eventually be resolved to any type (not just a
1115 structure type).</p>
1116
1117 <h5>Syntax:</h5>
1118
1119 <pre>
1120   opaque
1121 </pre>
1122
1123 <h5>Examples:</h5>
1124
1125 <table class="layout">
1126   <tr class="layout">
1127     <td class="left">
1128       <tt>opaque</tt>
1129     </td>
1130     <td class="left">
1131       An opaque type.<br/>
1132     </td>
1133   </tr>
1134 </table>
1135 </div>
1136
1137
1138 <!-- *********************************************************************** -->
1139 <div class="doc_section"> <a name="constants">Constants</a> </div>
1140 <!-- *********************************************************************** -->
1141
1142 <div class="doc_text">
1143
1144 <p>LLVM has several different basic types of constants.  This section describes
1145 them all and their syntax.</p>
1146
1147 </div>
1148
1149 <!-- ======================================================================= -->
1150 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
1151
1152 <div class="doc_text">
1153
1154 <dl>
1155   <dt><b>Boolean constants</b></dt>
1156
1157   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
1158   constants of the <tt><a href="#t_primitive">i1</a></tt> type.
1159   </dd>
1160
1161   <dt><b>Integer constants</b></dt>
1162
1163   <dd>Standard integers (such as '4') are constants of the <a
1164   href="#t_integer">integer</a> type.  Negative numbers may be used with
1165   integer types.
1166   </dd>
1167
1168   <dt><b>Floating point constants</b></dt>
1169
1170   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
1171   exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
1172   notation (see below).  Floating point constants must have a <a
1173   href="#t_floating">floating point</a> type. </dd>
1174
1175   <dt><b>Null pointer constants</b></dt>
1176
1177   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
1178   and must be of <a href="#t_pointer">pointer type</a>.</dd>
1179
1180 </dl>
1181
1182 <p>The one non-intuitive notation for constants is the optional hexadecimal form
1183 of floating point constants.  For example, the form '<tt>double
1184 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
1185 4.5e+15</tt>'.  The only time hexadecimal floating point constants are required
1186 (and the only time that they are generated by the disassembler) is when a
1187 floating point constant must be emitted but it cannot be represented as a
1188 decimal floating point number.  For example, NaN's, infinities, and other
1189 special values are represented in their IEEE hexadecimal format so that
1190 assembly and disassembly do not cause any bits to change in the constants.</p>
1191
1192 </div>
1193
1194 <!-- ======================================================================= -->
1195 <div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a>
1196 </div>
1197
1198 <div class="doc_text">
1199 <p>Aggregate constants arise from aggregation of simple constants
1200 and smaller aggregate constants.</p>
1201
1202 <dl>
1203   <dt><b>Structure constants</b></dt>
1204
1205   <dd>Structure constants are represented with notation similar to structure
1206   type definitions (a comma separated list of elements, surrounded by braces
1207   (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* %G }</tt>",
1208   where "<tt>%G</tt>" is declared as "<tt>%G = external global i32</tt>".  Structure constants
1209   must have <a href="#t_struct">structure type</a>, and the number and
1210   types of elements must match those specified by the type.
1211   </dd>
1212
1213   <dt><b>Array constants</b></dt>
1214
1215   <dd>Array constants are represented with notation similar to array type
1216   definitions (a comma separated list of elements, surrounded by square brackets
1217   (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74 ]</tt>".  Array
1218   constants must have <a href="#t_array">array type</a>, and the number and
1219   types of elements must match those specified by the type.
1220   </dd>
1221
1222   <dt><b>Vector constants</b></dt>
1223
1224   <dd>Vector constants are represented with notation similar to vector type
1225   definitions (a comma separated list of elements, surrounded by
1226   less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32 42,
1227   i32 11, i32 74, i32 100 &gt;</tt>".  VEctor constants must have <a
1228   href="#t_vector">vector type</a>, and the number and types of elements must
1229   match those specified by the type.
1230   </dd>
1231
1232   <dt><b>Zero initialization</b></dt>
1233
1234   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
1235   value to zero of <em>any</em> type, including scalar and aggregate types.
1236   This is often used to avoid having to print large zero initializers (e.g. for
1237   large arrays) and is always exactly equivalent to using explicit zero
1238   initializers.
1239   </dd>
1240 </dl>
1241
1242 </div>
1243
1244 <!-- ======================================================================= -->
1245 <div class="doc_subsection">
1246   <a name="globalconstants">Global Variable and Function Addresses</a>
1247 </div>
1248
1249 <div class="doc_text">
1250
1251 <p>The addresses of <a href="#globalvars">global variables</a> and <a
1252 href="#functionstructure">functions</a> are always implicitly valid (link-time)
1253 constants.  These constants are explicitly referenced when the <a
1254 href="#identifiers">identifier for the global</a> is used and always have <a
1255 href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
1256 file:</p>
1257
1258 <pre>
1259   %X = global i32 17
1260   %Y = global i32 42
1261   %Z = global [2 x i32*] [ i32* %X, i32* %Y ]
1262 </pre>
1263
1264 </div>
1265
1266 <!-- ======================================================================= -->
1267 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
1268 <div class="doc_text">
1269   <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
1270   no specific value.  Undefined values may be of any type and be used anywhere
1271   a constant is permitted.</p>
1272
1273   <p>Undefined values indicate to the compiler that the program is well defined
1274   no matter what value is used, giving the compiler more freedom to optimize.
1275   </p>
1276 </div>
1277
1278 <!-- ======================================================================= -->
1279 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
1280 </div>
1281
1282 <div class="doc_text">
1283
1284 <p>Constant expressions are used to allow expressions involving other constants
1285 to be used as constants.  Constant expressions may be of any <a
1286 href="#t_firstclass">first class</a> type and may involve any LLVM operation
1287 that does not have side effects (e.g. load and call are not supported).  The
1288 following is the syntax for constant expressions:</p>
1289
1290 <dl>
1291   <dt><b><tt>trunc ( CST to TYPE )</tt></b></dt>
1292   <dd>Truncate a constant to another type. The bit size of CST must be larger
1293   than the bit size of TYPE. Both types must be integers.</dd>
1294
1295   <dt><b><tt>zext ( CST to TYPE )</tt></b></dt>
1296   <dd>Zero extend a constant to another type. The bit size of CST must be
1297   smaller or equal to the bit size of TYPE.  Both types must be integers.</dd>
1298
1299   <dt><b><tt>sext ( CST to TYPE )</tt></b></dt>
1300   <dd>Sign extend a constant to another type. The bit size of CST must be
1301   smaller or equal to the bit size of TYPE.  Both types must be integers.</dd>
1302
1303   <dt><b><tt>fptrunc ( CST to TYPE )</tt></b></dt>
1304   <dd>Truncate a floating point constant to another floating point type. The
1305   size of CST must be larger than the size of TYPE. Both types must be
1306   floating point.</dd>
1307
1308   <dt><b><tt>fpext ( CST to TYPE )</tt></b></dt>
1309   <dd>Floating point extend a constant to another type. The size of CST must be
1310   smaller or equal to the size of TYPE. Both types must be floating point.</dd>
1311
1312   <dt><b><tt>fp2uint ( CST to TYPE )</tt></b></dt>
1313   <dd>Convert a floating point constant to the corresponding unsigned integer
1314   constant. TYPE must be an integer type. CST must be floating point. If the
1315   value won't fit in the integer type, the results are undefined.</dd>
1316
1317   <dt><b><tt>fptosi ( CST to TYPE )</tt></b></dt>
1318   <dd>Convert a floating point constant to the corresponding signed integer
1319   constant. TYPE must be an integer type. CST must be floating point. If the
1320   value won't fit in the integer type, the results are undefined.</dd>
1321
1322   <dt><b><tt>uitofp ( CST to TYPE )</tt></b></dt>
1323   <dd>Convert an unsigned integer constant to the corresponding floating point
1324   constant. TYPE must be floating point. CST must be of integer type. If the
1325   value won't fit in the floating point type, the results are undefined.</dd>
1326
1327   <dt><b><tt>sitofp ( CST to TYPE )</tt></b></dt>
1328   <dd>Convert a signed integer constant to the corresponding floating point
1329   constant. TYPE must be floating point. CST must be of integer type. If the
1330   value won't fit in the floating point type, the results are undefined.</dd>
1331
1332   <dt><b><tt>ptrtoint ( CST to TYPE )</tt></b></dt>
1333   <dd>Convert a pointer typed constant to the corresponding integer constant
1334   TYPE must be an integer type. CST must be of pointer type. The CST value is
1335   zero extended, truncated, or unchanged to make it fit in TYPE.</dd>
1336
1337   <dt><b><tt>inttoptr ( CST to TYPE )</tt></b></dt>
1338   <dd>Convert a integer constant to a pointer constant.  TYPE must be a
1339   pointer type.  CST must be of integer type. The CST value is zero extended,
1340   truncated, or unchanged to make it fit in a pointer size. This one is
1341   <i>really</i> dangerous!</dd>
1342
1343   <dt><b><tt>bitcast ( CST to TYPE )</tt></b></dt>
1344   <dd>Convert a constant, CST, to another TYPE. The size of CST and TYPE must be
1345   identical (same number of bits). The conversion is done as if the CST value
1346   was stored to memory and read back as TYPE. In other words, no bits change
1347   with this operator, just the type.  This can be used for conversion of
1348   vector types to any other type, as long as they have the same bit width. For
1349   pointers it is only valid to cast to another pointer type.
1350   </dd>
1351
1352   <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
1353
1354   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
1355   constants.  As with the <a href="#i_getelementptr">getelementptr</a>
1356   instruction, the index list may have zero or more indexes, which are required
1357   to make sense for the type of "CSTPTR".</dd>
1358
1359   <dt><b><tt>select ( COND, VAL1, VAL2 )</tt></b></dt>
1360
1361   <dd>Perform the <a href="#i_select">select operation</a> on
1362   constants.</dd>
1363
1364   <dt><b><tt>icmp COND ( VAL1, VAL2 )</tt></b></dt>
1365   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
1366
1367   <dt><b><tt>fcmp COND ( VAL1, VAL2 )</tt></b></dt>
1368   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
1369
1370   <dt><b><tt>extractelement ( VAL, IDX )</tt></b></dt>
1371
1372   <dd>Perform the <a href="#i_extractelement">extractelement
1373   operation</a> on constants.
1374
1375   <dt><b><tt>insertelement ( VAL, ELT, IDX )</tt></b></dt>
1376
1377   <dd>Perform the <a href="#i_insertelement">insertelement
1378     operation</a> on constants.</dd>
1379
1380
1381   <dt><b><tt>shufflevector ( VEC1, VEC2, IDXMASK )</tt></b></dt>
1382
1383   <dd>Perform the <a href="#i_shufflevector">shufflevector
1384     operation</a> on constants.</dd>
1385
1386   <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
1387
1388   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
1389   be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
1390   binary</a> operations.  The constraints on operands are the same as those for
1391   the corresponding instruction (e.g. no bitwise operations on floating point
1392   values are allowed).</dd>
1393 </dl>
1394 </div>
1395
1396 <!-- *********************************************************************** -->
1397 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
1398 <!-- *********************************************************************** -->
1399
1400 <!-- ======================================================================= -->
1401 <div class="doc_subsection">
1402 <a name="inlineasm">Inline Assembler Expressions</a>
1403 </div>
1404
1405 <div class="doc_text">
1406
1407 <p>
1408 LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm">
1409 Module-Level Inline Assembly</a>) through the use of a special value.  This
1410 value represents the inline assembler as a string (containing the instructions
1411 to emit), a list of operand constraints (stored as a string), and a flag that
1412 indicates whether or not the inline asm expression has side effects.  An example
1413 inline assembler expression is:
1414 </p>
1415
1416 <pre>
1417   i32 (i32) asm "bswap $0", "=r,r"
1418 </pre>
1419
1420 <p>
1421 Inline assembler expressions may <b>only</b> be used as the callee operand of
1422 a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we have:
1423 </p>
1424
1425 <pre>
1426   %X = call i32 asm "<a href="#i_bswap">bswap</a> $0", "=r,r"(i32 %Y)
1427 </pre>
1428
1429 <p>
1430 Inline asms with side effects not visible in the constraint list must be marked
1431 as having side effects.  This is done through the use of the
1432 '<tt>sideeffect</tt>' keyword, like so:
1433 </p>
1434
1435 <pre>
1436   call void asm sideeffect "eieio", ""()
1437 </pre>
1438
1439 <p>TODO: The format of the asm and constraints string still need to be
1440 documented here.  Constraints on what can be done (e.g. duplication, moving, etc
1441 need to be documented).
1442 </p>
1443
1444 </div>
1445
1446 <!-- *********************************************************************** -->
1447 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
1448 <!-- *********************************************************************** -->
1449
1450 <div class="doc_text">
1451
1452 <p>The LLVM instruction set consists of several different
1453 classifications of instructions: <a href="#terminators">terminator
1454 instructions</a>, <a href="#binaryops">binary instructions</a>,
1455 <a href="#bitwiseops">bitwise binary instructions</a>, <a
1456  href="#memoryops">memory instructions</a>, and <a href="#otherops">other
1457 instructions</a>.</p>
1458
1459 </div>
1460
1461 <!-- ======================================================================= -->
1462 <div class="doc_subsection"> <a name="terminators">Terminator
1463 Instructions</a> </div>
1464
1465 <div class="doc_text">
1466
1467 <p>As mentioned <a href="#functionstructure">previously</a>, every
1468 basic block in a program ends with a "Terminator" instruction, which
1469 indicates which block should be executed after the current block is
1470 finished. These terminator instructions typically yield a '<tt>void</tt>'
1471 value: they produce control flow, not values (the one exception being
1472 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
1473 <p>There are six different terminator instructions: the '<a
1474  href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
1475 instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
1476 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
1477  href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
1478  href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
1479
1480 </div>
1481
1482 <!-- _______________________________________________________________________ -->
1483 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
1484 Instruction</a> </div>
1485 <div class="doc_text">
1486 <h5>Syntax:</h5>
1487 <pre>  ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
1488   ret void                 <i>; Return from void function</i>
1489 </pre>
1490 <h5>Overview:</h5>
1491 <p>The '<tt>ret</tt>' instruction is used to return control flow (and a
1492 value) from a function back to the caller.</p>
1493 <p>There are two forms of the '<tt>ret</tt>' instruction: one that
1494 returns a value and then causes control flow, and one that just causes
1495 control flow to occur.</p>
1496 <h5>Arguments:</h5>
1497 <p>The '<tt>ret</tt>' instruction may return any '<a
1498  href="#t_firstclass">first class</a>' type.  Notice that a function is
1499 not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>'
1500 instruction inside of the function that returns a value that does not
1501 match the return type of the function.</p>
1502 <h5>Semantics:</h5>
1503 <p>When the '<tt>ret</tt>' instruction is executed, control flow
1504 returns back to the calling function's context.  If the caller is a "<a
1505  href="#i_call"><tt>call</tt></a>" instruction, execution continues at
1506 the instruction after the call.  If the caller was an "<a
1507  href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
1508 at the beginning of the "normal" destination block.  If the instruction
1509 returns a value, that value shall set the call or invoke instruction's
1510 return value.</p>
1511 <h5>Example:</h5>
1512 <pre>  ret i32 5                       <i>; Return an integer value of 5</i>
1513   ret void                        <i>; Return from a void function</i>
1514 </pre>
1515 </div>
1516 <!-- _______________________________________________________________________ -->
1517 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
1518 <div class="doc_text">
1519 <h5>Syntax:</h5>
1520 <pre>  br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
1521 </pre>
1522 <h5>Overview:</h5>
1523 <p>The '<tt>br</tt>' instruction is used to cause control flow to
1524 transfer to a different basic block in the current function.  There are
1525 two forms of this instruction, corresponding to a conditional branch
1526 and an unconditional branch.</p>
1527 <h5>Arguments:</h5>
1528 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a
1529 single '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The
1530 unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>'
1531 value as a target.</p>
1532 <h5>Semantics:</h5>
1533 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
1534 argument is evaluated.  If the value is <tt>true</tt>, control flows
1535 to the '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
1536 control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
1537 <h5>Example:</h5>
1538 <pre>Test:<br>  %cond = <a href="#i_icmp">icmp</a> eq, i32 %a, %b<br>  br i1 %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br>  <a
1539  href="#i_ret">ret</a> i32 1<br>IfUnequal:<br>  <a href="#i_ret">ret</a> i32 0<br></pre>
1540 </div>
1541 <!-- _______________________________________________________________________ -->
1542 <div class="doc_subsubsection">
1543    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
1544 </div>
1545
1546 <div class="doc_text">
1547 <h5>Syntax:</h5>
1548
1549 <pre>
1550   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
1551 </pre>
1552
1553 <h5>Overview:</h5>
1554
1555 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
1556 several different places.  It is a generalization of the '<tt>br</tt>'
1557 instruction, allowing a branch to occur to one of many possible
1558 destinations.</p>
1559
1560
1561 <h5>Arguments:</h5>
1562
1563 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
1564 comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
1565 an array of pairs of comparison value constants and '<tt>label</tt>'s.  The
1566 table is not allowed to contain duplicate constant entries.</p>
1567
1568 <h5>Semantics:</h5>
1569
1570 <p>The <tt>switch</tt> instruction specifies a table of values and
1571 destinations. When the '<tt>switch</tt>' instruction is executed, this
1572 table is searched for the given value.  If the value is found, control flow is
1573 transfered to the corresponding destination; otherwise, control flow is
1574 transfered to the default destination.</p>
1575
1576 <h5>Implementation:</h5>
1577
1578 <p>Depending on properties of the target machine and the particular
1579 <tt>switch</tt> instruction, this instruction may be code generated in different
1580 ways.  For example, it could be generated as a series of chained conditional
1581 branches or with a lookup table.</p>
1582
1583 <h5>Example:</h5>
1584
1585 <pre>
1586  <i>; Emulate a conditional br instruction</i>
1587  %Val = <a href="#i_zext">zext</a> i1 %value to i32
1588  switch i32 %Val, label %truedest [i32 0, label %falsedest ]
1589
1590  <i>; Emulate an unconditional br instruction</i>
1591  switch i32 0, label %dest [ ]
1592
1593  <i>; Implement a jump table:</i>
1594  switch i32 %val, label %otherwise [ i32 0, label %onzero
1595                                       i32 1, label %onone
1596                                       i32 2, label %ontwo ]
1597 </pre>
1598 </div>
1599
1600 <!-- _______________________________________________________________________ -->
1601 <div class="doc_subsubsection">
1602   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
1603 </div>
1604
1605 <div class="doc_text">
1606
1607 <h5>Syntax:</h5>
1608
1609 <pre>
1610   &lt;result&gt; = invoke [<a href="#callingconv">cconv</a>] &lt;ptr to function ty&gt; %&lt;function ptr val&gt;(&lt;function args&gt;)
1611                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
1612 </pre>
1613
1614 <h5>Overview:</h5>
1615
1616 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
1617 function, with the possibility of control flow transfer to either the
1618 '<tt>normal</tt>' label or the
1619 '<tt>exception</tt>' label.  If the callee function returns with the
1620 "<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the
1621 "normal" label.  If the callee (or any indirect callees) returns with the "<a
1622 href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and
1623 continued at the dynamically nearest "exception" label.</p>
1624
1625 <h5>Arguments:</h5>
1626
1627 <p>This instruction requires several arguments:</p>
1628
1629 <ol>
1630   <li>
1631     The optional "cconv" marker indicates which <a href="callingconv">calling
1632     convention</a> the call should use.  If none is specified, the call defaults
1633     to using C calling conventions.
1634   </li>
1635   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
1636   function value being invoked.  In most cases, this is a direct function
1637   invocation, but indirect <tt>invoke</tt>s are just as possible, branching off
1638   an arbitrary pointer to function value.
1639   </li>
1640
1641   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
1642   function to be invoked. </li>
1643
1644   <li>'<tt>function args</tt>': argument list whose types match the function
1645   signature argument types.  If the function signature indicates the function
1646   accepts a variable number of arguments, the extra arguments can be
1647   specified. </li>
1648
1649   <li>'<tt>normal label</tt>': the label reached when the called function
1650   executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
1651
1652   <li>'<tt>exception label</tt>': the label reached when a callee returns with
1653   the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
1654
1655 </ol>
1656
1657 <h5>Semantics:</h5>
1658
1659 <p>This instruction is designed to operate as a standard '<tt><a
1660 href="#i_call">call</a></tt>' instruction in most regards.  The primary
1661 difference is that it establishes an association with a label, which is used by
1662 the runtime library to unwind the stack.</p>
1663
1664 <p>This instruction is used in languages with destructors to ensure that proper
1665 cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
1666 exception.  Additionally, this is important for implementation of
1667 '<tt>catch</tt>' clauses in high-level languages that support them.</p>
1668
1669 <h5>Example:</h5>
1670 <pre>
1671   %retval = invoke i32 %Test(i32 15)             to label %Continue
1672               unwind label %TestCleanup     <i>; {i32}:retval set</i>
1673   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Test(i32 15)             to label %Continue
1674               unwind label %TestCleanup     <i>; {i32}:retval set</i>
1675 </pre>
1676 </div>
1677
1678
1679 <!-- _______________________________________________________________________ -->
1680
1681 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
1682 Instruction</a> </div>
1683
1684 <div class="doc_text">
1685
1686 <h5>Syntax:</h5>
1687 <pre>
1688   unwind
1689 </pre>
1690
1691 <h5>Overview:</h5>
1692
1693 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
1694 at the first callee in the dynamic call stack which used an <a
1695 href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.  This is
1696 primarily used to implement exception handling.</p>
1697
1698 <h5>Semantics:</h5>
1699
1700 <p>The '<tt>unwind</tt>' intrinsic causes execution of the current function to
1701 immediately halt.  The dynamic call stack is then searched for the first <a
1702 href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.  Once found,
1703 execution continues at the "exceptional" destination block specified by the
1704 <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt> instruction in the
1705 dynamic call chain, undefined behavior results.</p>
1706 </div>
1707
1708 <!-- _______________________________________________________________________ -->
1709
1710 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
1711 Instruction</a> </div>
1712
1713 <div class="doc_text">
1714
1715 <h5>Syntax:</h5>
1716 <pre>
1717   unreachable
1718 </pre>
1719
1720 <h5>Overview:</h5>
1721
1722 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
1723 instruction is used to inform the optimizer that a particular portion of the
1724 code is not reachable.  This can be used to indicate that the code after a
1725 no-return function cannot be reached, and other facts.</p>
1726
1727 <h5>Semantics:</h5>
1728
1729 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
1730 </div>
1731
1732
1733
1734 <!-- ======================================================================= -->
1735 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
1736 <div class="doc_text">
1737 <p>Binary operators are used to do most of the computation in a
1738 program.  They require two operands, execute an operation on them, and
1739 produce a single value.  The operands might represent
1740 multiple data, as is the case with the <a href="#t_vector">vector</a> data type.
1741 The result value of a binary operator is not
1742 necessarily the same type as its operands.</p>
1743 <p>There are several different binary operators:</p>
1744 </div>
1745 <!-- _______________________________________________________________________ -->
1746 <div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>'
1747 Instruction</a> </div>
1748 <div class="doc_text">
1749 <h5>Syntax:</h5>
1750 <pre>  &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1751 </pre>
1752 <h5>Overview:</h5>
1753 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
1754 <h5>Arguments:</h5>
1755 <p>The two arguments to the '<tt>add</tt>' instruction must be either <a
1756  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> values.
1757  This instruction can also take <a href="#t_vector">vector</a> versions of the values.
1758 Both arguments must have identical types.</p>
1759 <h5>Semantics:</h5>
1760 <p>The value produced is the integer or floating point sum of the two
1761 operands.</p>
1762 <h5>Example:</h5>
1763 <pre>  &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
1764 </pre>
1765 </div>
1766 <!-- _______________________________________________________________________ -->
1767 <div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>'
1768 Instruction</a> </div>
1769 <div class="doc_text">
1770 <h5>Syntax:</h5>
1771 <pre>  &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1772 </pre>
1773 <h5>Overview:</h5>
1774 <p>The '<tt>sub</tt>' instruction returns the difference of its two
1775 operands.</p>
1776 <p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>'
1777 instruction present in most other intermediate representations.</p>
1778 <h5>Arguments:</h5>
1779 <p>The two arguments to the '<tt>sub</tt>' instruction must be either <a
1780  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1781 values.
1782 This instruction can also take <a href="#t_vector">vector</a> versions of the values.
1783 Both arguments must have identical types.</p>
1784 <h5>Semantics:</h5>
1785 <p>The value produced is the integer or floating point difference of
1786 the two operands.</p>
1787 <h5>Example:</h5>
1788 <pre>  &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
1789   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
1790 </pre>
1791 </div>
1792 <!-- _______________________________________________________________________ -->
1793 <div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>'
1794 Instruction</a> </div>
1795 <div class="doc_text">
1796 <h5>Syntax:</h5>
1797 <pre>  &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1798 </pre>
1799 <h5>Overview:</h5>
1800 <p>The  '<tt>mul</tt>' instruction returns the product of its two
1801 operands.</p>
1802 <h5>Arguments:</h5>
1803 <p>The two arguments to the '<tt>mul</tt>' instruction must be either <a
1804  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1805 values.
1806 This instruction can also take <a href="#t_vector">vector</a> versions of the values.
1807 Both arguments must have identical types.</p>
1808 <h5>Semantics:</h5>
1809 <p>The value produced is the integer or floating point product of the
1810 two operands.</p>
1811 <p>Because the operands are the same width, the result of an integer
1812 multiplication is the same whether the operands should be deemed unsigned or
1813 signed.</p>
1814 <h5>Example:</h5>
1815 <pre>  &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
1816 </pre>
1817 </div>
1818 <!-- _______________________________________________________________________ -->
1819 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
1820 </a></div>
1821 <div class="doc_text">
1822 <h5>Syntax:</h5>
1823 <pre>  &lt;result&gt; = udiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1824 </pre>
1825 <h5>Overview:</h5>
1826 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two
1827 operands.</p>
1828 <h5>Arguments:</h5>
1829 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
1830 <a href="#t_integer">integer</a> values. Both arguments must have identical
1831 types. This instruction can also take <a href="#t_vector">vector</a> versions
1832 of the values in which case the elements must be integers.</p>
1833 <h5>Semantics:</h5>
1834 <p>The value produced is the unsigned integer quotient of the two operands. This
1835 instruction always performs an unsigned division operation, regardless of
1836 whether the arguments are unsigned or not.</p>
1837 <h5>Example:</h5>
1838 <pre>  &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
1839 </pre>
1840 </div>
1841 <!-- _______________________________________________________________________ -->
1842 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
1843 </a> </div>
1844 <div class="doc_text">
1845 <h5>Syntax:</h5>
1846 <pre>  &lt;result&gt; = sdiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1847 </pre>
1848 <h5>Overview:</h5>
1849 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two
1850 operands.</p>
1851 <h5>Arguments:</h5>
1852 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
1853 <a href="#t_integer">integer</a> values.  Both arguments must have identical
1854 types. This instruction can also take <a href="#t_vector">vector</a> versions
1855 of the values in which case the elements must be integers.</p>
1856 <h5>Semantics:</h5>
1857 <p>The value produced is the signed integer quotient of the two operands. This
1858 instruction always performs a signed division operation, regardless of whether
1859 the arguments are signed or not.</p>
1860 <h5>Example:</h5>
1861 <pre>  &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
1862 </pre>
1863 </div>
1864 <!-- _______________________________________________________________________ -->
1865 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
1866 Instruction</a> </div>
1867 <div class="doc_text">
1868 <h5>Syntax:</h5>
1869 <pre>  &lt;result&gt; = fdiv &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1870 </pre>
1871 <h5>Overview:</h5>
1872 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two
1873 operands.</p>
1874 <h5>Arguments:</h5>
1875 <p>The two arguments to the '<tt>div</tt>' instruction must be
1876 <a href="#t_floating">floating point</a> values.  Both arguments must have
1877 identical types.  This instruction can also take <a href="#t_vector">vector</a>
1878 versions of the values in which case the elements must be floating point.</p>
1879 <h5>Semantics:</h5>
1880 <p>The value produced is the floating point quotient of the two operands.</p>
1881 <h5>Example:</h5>
1882 <pre>  &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
1883 </pre>
1884 </div>
1885 <!-- _______________________________________________________________________ -->
1886 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
1887 </div>
1888 <div class="doc_text">
1889 <h5>Syntax:</h5>
1890 <pre>  &lt;result&gt; = urem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1891 </pre>
1892 <h5>Overview:</h5>
1893 <p>The '<tt>urem</tt>' instruction returns the remainder from the
1894 unsigned division of its two arguments.</p>
1895 <h5>Arguments:</h5>
1896 <p>The two arguments to the '<tt>urem</tt>' instruction must be
1897 <a href="#t_integer">integer</a> values. Both arguments must have identical
1898 types.</p>
1899 <h5>Semantics:</h5>
1900 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
1901 This instruction always performs an unsigned division to get the remainder,
1902 regardless of whether the arguments are unsigned or not.</p>
1903 <h5>Example:</h5>
1904 <pre>  &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
1905 </pre>
1906
1907 </div>
1908 <!-- _______________________________________________________________________ -->
1909 <div class="doc_subsubsection"> <a name="i_srem">'<tt>srem</tt>'
1910 Instruction</a> </div>
1911 <div class="doc_text">
1912 <h5>Syntax:</h5>
1913 <pre>  &lt;result&gt; = srem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1914 </pre>
1915 <h5>Overview:</h5>
1916 <p>The '<tt>srem</tt>' instruction returns the remainder from the
1917 signed division of its two operands.</p>
1918 <h5>Arguments:</h5>
1919 <p>The two arguments to the '<tt>srem</tt>' instruction must be
1920 <a href="#t_integer">integer</a> values.  Both arguments must have identical
1921 types.</p>
1922 <h5>Semantics:</h5>
1923 <p>This instruction returns the <i>remainder</i> of a division (where the result
1924 has the same sign as the divisor), not the <i>modulus</i> (where the
1925 result has the same sign as the dividend) of a value.  For more
1926 information about the difference, see <a
1927  href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
1928 Math Forum</a>.</p>
1929 <h5>Example:</h5>
1930 <pre>  &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
1931 </pre>
1932
1933 </div>
1934 <!-- _______________________________________________________________________ -->
1935 <div class="doc_subsubsection"> <a name="i_frem">'<tt>frem</tt>'
1936 Instruction</a> </div>
1937 <div class="doc_text">
1938 <h5>Syntax:</h5>
1939 <pre>  &lt;result&gt; = frem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1940 </pre>
1941 <h5>Overview:</h5>
1942 <p>The '<tt>frem</tt>' instruction returns the remainder from the
1943 division of its two operands.</p>
1944 <h5>Arguments:</h5>
1945 <p>The two arguments to the '<tt>frem</tt>' instruction must be
1946 <a href="#t_floating">floating point</a> values.  Both arguments must have
1947 identical types.</p>
1948 <h5>Semantics:</h5>
1949 <p>This instruction returns the <i>remainder</i> of a division.</p>
1950 <h5>Example:</h5>
1951 <pre>  &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
1952 </pre>
1953 </div>
1954
1955 <!-- ======================================================================= -->
1956 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
1957 Operations</a> </div>
1958 <div class="doc_text">
1959 <p>Bitwise binary operators are used to do various forms of
1960 bit-twiddling in a program.  They are generally very efficient
1961 instructions and can commonly be strength reduced from other
1962 instructions.  They require two operands, execute an operation on them,
1963 and produce a single value.  The resulting value of the bitwise binary
1964 operators is always the same type as its first operand.</p>
1965 </div>
1966
1967 <!-- _______________________________________________________________________ -->
1968 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
1969 Instruction</a> </div>
1970 <div class="doc_text">
1971 <h5>Syntax:</h5>
1972 <pre>  &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1973 </pre>
1974 <h5>Overview:</h5>
1975 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to
1976 the left a specified number of bits.</p>
1977 <h5>Arguments:</h5>
1978 <p>Both arguments to the '<tt>shl</tt>' instruction must be the same <a
1979  href="#t_integer">integer</a> type.</p>
1980 <h5>Semantics:</h5>
1981 <p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p>
1982 <h5>Example:</h5><pre>
1983   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
1984   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
1985   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
1986 </pre>
1987 </div>
1988 <!-- _______________________________________________________________________ -->
1989 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
1990 Instruction</a> </div>
1991 <div class="doc_text">
1992 <h5>Syntax:</h5>
1993 <pre>  &lt;result&gt; = lshr &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1994 </pre>
1995
1996 <h5>Overview:</h5>
1997 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
1998 operand shifted to the right a specified number of bits.</p>
1999
2000 <h5>Arguments:</h5>
2001 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
2002 <a href="#t_integer">integer</a> type.</p>
2003
2004 <h5>Semantics:</h5>
2005 <p>This instruction always performs a logical shift right operation. The most
2006 significant bits of the result will be filled with zero bits after the
2007 shift.</p>
2008
2009 <h5>Example:</h5>
2010 <pre>
2011   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
2012   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
2013   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
2014   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
2015 </pre>
2016 </div>
2017
2018 <!-- _______________________________________________________________________ -->
2019 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
2020 Instruction</a> </div>
2021 <div class="doc_text">
2022
2023 <h5>Syntax:</h5>
2024 <pre>  &lt;result&gt; = ashr &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
2025 </pre>
2026
2027 <h5>Overview:</h5>
2028 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
2029 operand shifted to the right a specified number of bits.</p>
2030
2031 <h5>Arguments:</h5>
2032 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
2033 <a href="#t_integer">integer</a> type.</p>
2034
2035 <h5>Semantics:</h5>
2036 <p>This instruction always performs an arithmetic shift right operation,
2037 The most significant bits of the result will be filled with the sign bit
2038 of <tt>var1</tt>.</p>
2039
2040 <h5>Example:</h5>
2041 <pre>
2042   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
2043   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
2044   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
2045   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
2046 </pre>
2047 </div>
2048
2049 <!-- _______________________________________________________________________ -->
2050 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
2051 Instruction</a> </div>
2052 <div class="doc_text">
2053 <h5>Syntax:</h5>
2054 <pre>  &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
2055 </pre>
2056 <h5>Overview:</h5>
2057 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of
2058 its two operands.</p>
2059 <h5>Arguments:</h5>
2060 <p>The two arguments to the '<tt>and</tt>' instruction must be <a
2061  href="#t_integer">integer</a> values.  Both arguments must have
2062 identical types.</p>
2063 <h5>Semantics:</h5>
2064 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
2065 <p> </p>
2066 <div style="align: center">
2067 <table border="1" cellspacing="0" cellpadding="4">
2068   <tbody>
2069     <tr>
2070       <td>In0</td>
2071       <td>In1</td>
2072       <td>Out</td>
2073     </tr>
2074     <tr>
2075       <td>0</td>
2076       <td>0</td>
2077       <td>0</td>
2078     </tr>
2079     <tr>
2080       <td>0</td>
2081       <td>1</td>
2082       <td>0</td>
2083     </tr>
2084     <tr>
2085       <td>1</td>
2086       <td>0</td>
2087       <td>0</td>
2088     </tr>
2089     <tr>
2090       <td>1</td>
2091       <td>1</td>
2092       <td>1</td>
2093     </tr>
2094   </tbody>
2095 </table>
2096 </div>
2097 <h5>Example:</h5>
2098 <pre>  &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
2099   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
2100   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
2101 </pre>
2102 </div>
2103 <!-- _______________________________________________________________________ -->
2104 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
2105 <div class="doc_text">
2106 <h5>Syntax:</h5>
2107 <pre>  &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
2108 </pre>
2109 <h5>Overview:</h5>
2110 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
2111 or of its two operands.</p>
2112 <h5>Arguments:</h5>
2113 <p>The two arguments to the '<tt>or</tt>' instruction must be <a
2114  href="#t_integer">integer</a> values.  Both arguments must have
2115 identical types.</p>
2116 <h5>Semantics:</h5>
2117 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
2118 <p> </p>
2119 <div style="align: center">
2120 <table border="1" cellspacing="0" cellpadding="4">
2121   <tbody>
2122     <tr>
2123       <td>In0</td>
2124       <td>In1</td>
2125       <td>Out</td>
2126     </tr>
2127     <tr>
2128       <td>0</td>
2129       <td>0</td>
2130       <td>0</td>
2131     </tr>
2132     <tr>
2133       <td>0</td>
2134       <td>1</td>
2135       <td>1</td>
2136     </tr>
2137     <tr>
2138       <td>1</td>
2139       <td>0</td>
2140       <td>1</td>
2141     </tr>
2142     <tr>
2143       <td>1</td>
2144       <td>1</td>
2145       <td>1</td>
2146     </tr>
2147   </tbody>
2148 </table>
2149 </div>
2150 <h5>Example:</h5>
2151 <pre>  &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
2152   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
2153   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
2154 </pre>
2155 </div>
2156 <!-- _______________________________________________________________________ -->
2157 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
2158 Instruction</a> </div>
2159 <div class="doc_text">
2160 <h5>Syntax:</h5>
2161 <pre>  &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
2162 </pre>
2163 <h5>Overview:</h5>
2164 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
2165 or of its two operands.  The <tt>xor</tt> is used to implement the
2166 "one's complement" operation, which is the "~" operator in C.</p>
2167 <h5>Arguments:</h5>
2168 <p>The two arguments to the '<tt>xor</tt>' instruction must be <a
2169  href="#t_integer">integer</a> values.  Both arguments must have
2170 identical types.</p>
2171 <h5>Semantics:</h5>
2172 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
2173 <p> </p>
2174 <div style="align: center">
2175 <table border="1" cellspacing="0" cellpadding="4">
2176   <tbody>
2177     <tr>
2178       <td>In0</td>
2179       <td>In1</td>
2180       <td>Out</td>
2181     </tr>
2182     <tr>
2183       <td>0</td>
2184       <td>0</td>
2185       <td>0</td>
2186     </tr>
2187     <tr>
2188       <td>0</td>
2189       <td>1</td>
2190       <td>1</td>
2191     </tr>
2192     <tr>
2193       <td>1</td>
2194       <td>0</td>
2195       <td>1</td>
2196     </tr>
2197     <tr>
2198       <td>1</td>
2199       <td>1</td>
2200       <td>0</td>
2201     </tr>
2202   </tbody>
2203 </table>
2204 </div>
2205 <p> </p>
2206 <h5>Example:</h5>
2207 <pre>  &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
2208   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
2209   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
2210   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
2211 </pre>
2212 </div>
2213
2214 <!-- ======================================================================= -->
2215 <div class="doc_subsection">
2216   <a name="vectorops">Vector Operations</a>
2217 </div>
2218
2219 <div class="doc_text">
2220
2221 <p>LLVM supports several instructions to represent vector operations in a
2222 target-independent manner.  This instructions cover the element-access and
2223 vector-specific operations needed to process vectors effectively.  While LLVM
2224 does directly support these vector operations, many sophisticated algorithms
2225 will want to use target-specific intrinsics to take full advantage of a specific
2226 target.</p>
2227
2228 </div>
2229
2230 <!-- _______________________________________________________________________ -->
2231 <div class="doc_subsubsection">
2232    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
2233 </div>
2234
2235 <div class="doc_text">
2236
2237 <h5>Syntax:</h5>
2238
2239 <pre>
2240   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
2241 </pre>
2242
2243 <h5>Overview:</h5>
2244
2245 <p>
2246 The '<tt>extractelement</tt>' instruction extracts a single scalar
2247 element from a vector at a specified index.
2248 </p>
2249
2250
2251 <h5>Arguments:</h5>
2252
2253 <p>
2254 The first operand of an '<tt>extractelement</tt>' instruction is a
2255 value of <a href="#t_vector">vector</a> type.  The second operand is
2256 an index indicating the position from which to extract the element.
2257 The index may be a variable.</p>
2258
2259 <h5>Semantics:</h5>
2260
2261 <p>
2262 The result is a scalar of the same type as the element type of
2263 <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
2264 <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
2265 results are undefined.
2266 </p>
2267
2268 <h5>Example:</h5>
2269
2270 <pre>
2271   %result = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
2272 </pre>
2273 </div>
2274
2275
2276 <!-- _______________________________________________________________________ -->
2277 <div class="doc_subsubsection">
2278    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
2279 </div>
2280
2281 <div class="doc_text">
2282
2283 <h5>Syntax:</h5>
2284
2285 <pre>
2286   &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>
2287 </pre>
2288
2289 <h5>Overview:</h5>
2290
2291 <p>
2292 The '<tt>insertelement</tt>' instruction inserts a scalar
2293 element into a vector at a specified index.
2294 </p>
2295
2296
2297 <h5>Arguments:</h5>
2298
2299 <p>
2300 The first operand of an '<tt>insertelement</tt>' instruction is a
2301 value of <a href="#t_vector">vector</a> type.  The second operand is a
2302 scalar value whose type must equal the element type of the first
2303 operand.  The third operand is an index indicating the position at
2304 which to insert the value.  The index may be a variable.</p>
2305
2306 <h5>Semantics:</h5>
2307
2308 <p>
2309 The result is a vector of the same type as <tt>val</tt>.  Its
2310 element values are those of <tt>val</tt> except at position
2311 <tt>idx</tt>, where it gets the value <tt>elt</tt>.  If <tt>idx</tt>
2312 exceeds the length of <tt>val</tt>, the results are undefined.
2313 </p>
2314
2315 <h5>Example:</h5>
2316
2317 <pre>
2318   %result = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
2319 </pre>
2320 </div>
2321
2322 <!-- _______________________________________________________________________ -->
2323 <div class="doc_subsubsection">
2324    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
2325 </div>
2326
2327 <div class="doc_text">
2328
2329 <h5>Syntax:</h5>
2330
2331 <pre>
2332   &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;n x i32&gt; &lt;mask&gt;    <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
2333 </pre>
2334
2335 <h5>Overview:</h5>
2336
2337 <p>
2338 The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
2339 from two input vectors, returning a vector of the same type.
2340 </p>
2341
2342 <h5>Arguments:</h5>
2343
2344 <p>
2345 The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
2346 with types that match each other and types that match the result of the
2347 instruction.  The third argument is a shuffle mask, which has the same number
2348 of elements as the other vector type, but whose element type is always 'i32'.
2349 </p>
2350
2351 <p>
2352 The shuffle mask operand is required to be a constant vector with either
2353 constant integer or undef values.
2354 </p>
2355
2356 <h5>Semantics:</h5>
2357
2358 <p>
2359 The elements of the two input vectors are numbered from left to right across
2360 both of the vectors.  The shuffle mask operand specifies, for each element of
2361 the result vector, which element of the two input registers the result element
2362 gets.  The element selector may be undef (meaning "don't care") and the second
2363 operand may be undef if performing a shuffle from only one vector.
2364 </p>
2365
2366 <h5>Example:</h5>
2367
2368 <pre>
2369   %result = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
2370                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;    <i>; yields &lt;4 x i32&gt;</i>
2371   %result = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
2372                           &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.
2373 </pre>
2374 </div>
2375
2376
2377 <!-- ======================================================================= -->
2378 <div class="doc_subsection">
2379   <a name="memoryops">Memory Access and Addressing Operations</a>
2380 </div>
2381
2382 <div class="doc_text">
2383
2384 <p>A key design point of an SSA-based representation is how it
2385 represents memory.  In LLVM, no memory locations are in SSA form, which
2386 makes things very simple.  This section describes how to read, write,
2387 allocate, and free memory in LLVM.</p>
2388
2389 </div>
2390
2391 <!-- _______________________________________________________________________ -->
2392 <div class="doc_subsubsection">
2393   <a name="i_malloc">'<tt>malloc</tt>' Instruction</a>
2394 </div>
2395
2396 <div class="doc_text">
2397
2398 <h5>Syntax:</h5>
2399
2400 <pre>
2401   &lt;result&gt; = malloc &lt;type&gt;[, i32 &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
2402 </pre>
2403
2404 <h5>Overview:</h5>
2405
2406 <p>The '<tt>malloc</tt>' instruction allocates memory from the system
2407 heap and returns a pointer to it.</p>
2408
2409 <h5>Arguments:</h5>
2410
2411 <p>The '<tt>malloc</tt>' instruction allocates
2412 <tt>sizeof(&lt;type&gt;)*NumElements</tt>
2413 bytes of memory from the operating system and returns a pointer of the
2414 appropriate type to the program.  If "NumElements" is specified, it is the
2415 number of elements allocated.  If an alignment is specified, the value result
2416 of the allocation is guaranteed to be aligned to at least that boundary.  If
2417 not specified, or if zero, the target can choose to align the allocation on any
2418 convenient boundary.</p>
2419
2420 <p>'<tt>type</tt>' must be a sized type.</p>
2421
2422 <h5>Semantics:</h5>
2423
2424 <p>Memory is allocated using the system "<tt>malloc</tt>" function, and
2425 a pointer is returned.</p>
2426
2427 <h5>Example:</h5>
2428
2429 <pre>
2430   %array  = malloc [4 x i8 ]                    <i>; yields {[%4 x i8]*}:array</i>
2431
2432   %size   = <a href="#i_add">add</a> i32 2, 2                          <i>; yields {i32}:size = i32 4</i>
2433   %array1 = malloc i8, i32 4                   <i>; yields {i8*}:array1</i>
2434   %array2 = malloc [12 x i8], i32 %size        <i>; yields {[12 x i8]*}:array2</i>
2435   %array3 = malloc i32, i32 4, align 1024         <i>; yields {i32*}:array3</i>
2436   %array4 = malloc i32, align 1024                 <i>; yields {i32*}:array4</i>
2437 </pre>
2438 </div>
2439
2440 <!-- _______________________________________________________________________ -->
2441 <div class="doc_subsubsection">
2442   <a name="i_free">'<tt>free</tt>' Instruction</a>
2443 </div>
2444
2445 <div class="doc_text">
2446
2447 <h5>Syntax:</h5>
2448
2449 <pre>
2450   free &lt;type&gt; &lt;value&gt;                              <i>; yields {void}</i>
2451 </pre>
2452
2453 <h5>Overview:</h5>
2454
2455 <p>The '<tt>free</tt>' instruction returns memory back to the unused
2456 memory heap to be reallocated in the future.</p>
2457
2458 <h5>Arguments:</h5>
2459
2460 <p>'<tt>value</tt>' shall be a pointer value that points to a value
2461 that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
2462 instruction.</p>
2463
2464 <h5>Semantics:</h5>
2465
2466 <p>Access to the memory pointed to by the pointer is no longer defined
2467 after this instruction executes.</p>
2468
2469 <h5>Example:</h5>
2470
2471 <pre>
2472   %array  = <a href="#i_malloc">malloc</a> [4 x i8]                    <i>; yields {[4 x i8]*}:array</i>
2473             free   [4 x i8]* %array
2474 </pre>
2475 </div>
2476
2477 <!-- _______________________________________________________________________ -->
2478 <div class="doc_subsubsection">
2479   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
2480 </div>
2481
2482 <div class="doc_text">
2483
2484 <h5>Syntax:</h5>
2485
2486 <pre>
2487   &lt;result&gt; = alloca &lt;type&gt;[, i32 &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
2488 </pre>
2489
2490 <h5>Overview:</h5>
2491
2492 <p>The '<tt>alloca</tt>' instruction allocates memory on the current
2493 stack frame of the procedure that is live until the current function
2494 returns to its caller.</p>
2495
2496 <h5>Arguments:</h5>
2497
2498 <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
2499 bytes of memory on the runtime stack, returning a pointer of the
2500 appropriate type to the program.    If "NumElements" is specified, it is the
2501 number of elements allocated.  If an alignment is specified, the value result
2502 of the allocation is guaranteed to be aligned to at least that boundary.  If
2503 not specified, or if zero, the target can choose to align the allocation on any
2504 convenient boundary.</p>
2505
2506 <p>'<tt>type</tt>' may be any sized type.</p>
2507
2508 <h5>Semantics:</h5>
2509
2510 <p>Memory is allocated; a pointer is returned.  '<tt>alloca</tt>'d
2511 memory is automatically released when the function returns.  The '<tt>alloca</tt>'
2512 instruction is commonly used to represent automatic variables that must
2513 have an address available.  When the function returns (either with the <tt><a
2514  href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt>
2515 instructions), the memory is reclaimed.</p>
2516
2517 <h5>Example:</h5>
2518
2519 <pre>
2520   %ptr = alloca i32                              <i>; yields {i32*}:ptr</i>
2521   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
2522   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
2523   %ptr = alloca i32, align 1024                  <i>; yields {i32*}:ptr</i>
2524 </pre>
2525 </div>
2526
2527 <!-- _______________________________________________________________________ -->
2528 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
2529 Instruction</a> </div>
2530 <div class="doc_text">
2531 <h5>Syntax:</h5>
2532 <pre>  &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;<br>  &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;<br></pre>
2533 <h5>Overview:</h5>
2534 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
2535 <h5>Arguments:</h5>
2536 <p>The argument to the '<tt>load</tt>' instruction specifies the memory
2537 address from which to load.  The pointer must point to a <a
2538  href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
2539 marked as <tt>volatile</tt>, then the optimizer is not allowed to modify
2540 the number or order of execution of this <tt>load</tt> with other
2541 volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
2542 instructions. </p>
2543 <h5>Semantics:</h5>
2544 <p>The location of memory pointed to is loaded.</p>
2545 <h5>Examples:</h5>
2546 <pre>  %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
2547   <a
2548  href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
2549   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
2550 </pre>
2551 </div>
2552 <!-- _______________________________________________________________________ -->
2553 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
2554 Instruction</a> </div>
2555 <div class="doc_text">
2556 <h5>Syntax:</h5>
2557 <pre>  store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
2558   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
2559 </pre>
2560 <h5>Overview:</h5>
2561 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
2562 <h5>Arguments:</h5>
2563 <p>There are two arguments to the '<tt>store</tt>' instruction: a value
2564 to store and an address in which to store it.  The type of the '<tt>&lt;pointer&gt;</tt>'
2565 operand must be a pointer to the type of the '<tt>&lt;value&gt;</tt>'
2566 operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the
2567 optimizer is not allowed to modify the number or order of execution of
2568 this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
2569  href="#i_store">store</a></tt> instructions.</p>
2570 <h5>Semantics:</h5>
2571 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
2572 at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
2573 <h5>Example:</h5>
2574 <pre>  %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
2575   <a
2576  href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
2577   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
2578 </pre>
2579 </div>
2580
2581 <!-- _______________________________________________________________________ -->
2582 <div class="doc_subsubsection">
2583    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
2584 </div>
2585
2586 <div class="doc_text">
2587 <h5>Syntax:</h5>
2588 <pre>
2589   &lt;result&gt; = getelementptr &lt;ty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
2590 </pre>
2591
2592 <h5>Overview:</h5>
2593
2594 <p>
2595 The '<tt>getelementptr</tt>' instruction is used to get the address of a
2596 subelement of an aggregate data structure.</p>
2597
2598 <h5>Arguments:</h5>
2599
2600 <p>This instruction takes a list of integer operands that indicate what
2601 elements of the aggregate object to index to.  The actual types of the arguments
2602 provided depend on the type of the first pointer argument.  The
2603 '<tt>getelementptr</tt>' instruction is used to index down through the type
2604 levels of a structure or to a specific index in an array.  When indexing into a
2605 structure, only <tt>i32</tt> integer constants are allowed.  When indexing
2606 into an array or pointer, only integers of 32 or 64 bits are allowed, and will
2607 be sign extended to 64-bit values.</p>
2608
2609 <p>For example, let's consider a C code fragment and how it gets
2610 compiled to LLVM:</p>
2611
2612 <pre>
2613   struct RT {
2614     char A;
2615     i32 B[10][20];
2616     char C;
2617   };
2618   struct ST {
2619     i32 X;
2620     double Y;
2621     struct RT Z;
2622   };
2623
2624   define i32 *foo(struct ST *s) {
2625     return &amp;s[1].Z.B[5][13];
2626   }
2627 </pre>
2628
2629 <p>The LLVM code generated by the GCC frontend is:</p>
2630
2631 <pre>
2632   %RT = type { i8 , [10 x [20 x i32]], i8  }
2633   %ST = type { i32, double, %RT }
2634
2635   implementation
2636
2637   define i32* %foo(%ST* %s) {
2638   entry:
2639     %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
2640     ret i32* %reg
2641   }
2642 </pre>
2643
2644 <h5>Semantics:</h5>
2645
2646 <p>The index types specified for the '<tt>getelementptr</tt>' instruction depend
2647 on the pointer type that is being indexed into. <a href="#t_pointer">Pointer</a>
2648 and <a href="#t_array">array</a> types can use a 32-bit or 64-bit
2649 <a href="#t_integer">integer</a> type but the value will always be sign extended
2650 to 64-bits.  <a href="#t_struct">Structure</a> types, require <tt>i32</tt>
2651 <b>constants</b>.</p>
2652
2653 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
2654 type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
2655 }</tt>' type, a structure.  The second index indexes into the third element of
2656 the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
2657 i8  }</tt>' type, another structure.  The third index indexes into the second
2658 element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
2659 array.  The two dimensions of the array are subscripted into, yielding an
2660 '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a pointer
2661 to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
2662
2663 <p>Note that it is perfectly legal to index partially through a
2664 structure, returning a pointer to an inner element.  Because of this,
2665 the LLVM code for the given testcase is equivalent to:</p>
2666
2667 <pre>
2668   define i32* %foo(%ST* %s) {
2669     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
2670     %t2 = getelementptr %ST* %t1, i32 0, i32 2               <i>; yields %RT*:%t2</i>
2671     %t3 = getelementptr %RT* %t2, i32 0, i32 1               <i>; yields [10 x [20 x i32]]*:%t3</i>
2672     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
2673     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
2674     ret i32* %t5
2675   }
2676 </pre>
2677
2678 <p>Note that it is undefined to access an array out of bounds: array and
2679 pointer indexes must always be within the defined bounds of the array type.
2680 The one exception for this rules is zero length arrays.  These arrays are
2681 defined to be accessible as variable length arrays, which requires access
2682 beyond the zero'th element.</p>
2683
2684 <p>The getelementptr instruction is often confusing.  For some more insight
2685 into how it works, see <a href="GetElementPtr.html">the getelementptr
2686 FAQ</a>.</p>
2687
2688 <h5>Example:</h5>
2689
2690 <pre>
2691     <i>; yields [12 x i8]*:aptr</i>
2692     %aptr = getelementptr {i32, [12 x i8]}* %sptr, i64 0, i32 1
2693 </pre>
2694 </div>
2695
2696 <!-- ======================================================================= -->
2697 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
2698 </div>
2699 <div class="doc_text">
2700 <p>The instructions in this category are the conversion instructions (casting)
2701 which all take a single operand and a type. They perform various bit conversions
2702 on the operand.</p>
2703 </div>
2704
2705 <!-- _______________________________________________________________________ -->
2706 <div class="doc_subsubsection">
2707    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
2708 </div>
2709 <div class="doc_text">
2710
2711 <h5>Syntax:</h5>
2712 <pre>
2713   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2714 </pre>
2715
2716 <h5>Overview:</h5>
2717 <p>
2718 The '<tt>trunc</tt>' instruction truncates its operand to the type <tt>ty2</tt>.
2719 </p>
2720
2721 <h5>Arguments:</h5>
2722 <p>
2723 The '<tt>trunc</tt>' instruction takes a <tt>value</tt> to trunc, which must
2724 be an <a href="#t_integer">integer</a> type, and a type that specifies the size
2725 and type of the result, which must be an <a href="#t_integer">integer</a>
2726 type. The bit size of <tt>value</tt> must be larger than the bit size of
2727 <tt>ty2</tt>. Equal sized types are not allowed.</p>
2728
2729 <h5>Semantics:</h5>
2730 <p>
2731 The '<tt>trunc</tt>' instruction truncates the high order bits in <tt>value</tt>
2732 and converts the remaining bits to <tt>ty2</tt>. Since the source size must be
2733 larger than the destination size, <tt>trunc</tt> cannot be a <i>no-op cast</i>.
2734 It will always truncate bits.</p>
2735
2736 <h5>Example:</h5>
2737 <pre>
2738   %X = trunc i32 257 to i8              <i>; yields i8:1</i>
2739   %Y = trunc i32 123 to i1              <i>; yields i1:true</i>
2740   %Y = trunc i32 122 to i1              <i>; yields i1:false</i>
2741 </pre>
2742 </div>
2743
2744 <!-- _______________________________________________________________________ -->
2745 <div class="doc_subsubsection">
2746    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
2747 </div>
2748 <div class="doc_text">
2749
2750 <h5>Syntax:</h5>
2751 <pre>
2752   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2753 </pre>
2754
2755 <h5>Overview:</h5>
2756 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
2757 <tt>ty2</tt>.</p>
2758
2759
2760 <h5>Arguments:</h5>
2761 <p>The '<tt>zext</tt>' instruction takes a value to cast, which must be of
2762 <a href="#t_integer">integer</a> type, and a type to cast it to, which must
2763 also be of <a href="#t_integer">integer</a> type. The bit size of the
2764 <tt>value</tt> must be smaller than the bit size of the destination type,
2765 <tt>ty2</tt>.</p>
2766
2767 <h5>Semantics:</h5>
2768 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
2769 bits until it reaches the size of the destination type, <tt>ty2</tt>. When the
2770 the operand and the type are the same size, no bit filling is done and the
2771 cast is considered a <i>no-op cast</i> because no bits change (only the type
2772 changes).</p>
2773
2774 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
2775
2776 <h5>Example:</h5>
2777 <pre>
2778   %X = zext i32 257 to i64              <i>; yields i64:257</i>
2779   %Y = zext i1 true to i32              <i>; yields i32:1</i>
2780 </pre>
2781 </div>
2782
2783 <!-- _______________________________________________________________________ -->
2784 <div class="doc_subsubsection">
2785    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
2786 </div>
2787 <div class="doc_text">
2788
2789 <h5>Syntax:</h5>
2790 <pre>
2791   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2792 </pre>
2793
2794 <h5>Overview:</h5>
2795 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
2796
2797 <h5>Arguments:</h5>
2798 <p>
2799 The '<tt>sext</tt>' instruction takes a value to cast, which must be of
2800 <a href="#t_integer">integer</a> type, and a type to cast it to, which must
2801 also be of <a href="#t_integer">integer</a> type.  The bit size of the
2802 <tt>value</tt> must be smaller than the bit size of the destination type,
2803 <tt>ty2</tt>.</p>
2804
2805 <h5>Semantics:</h5>
2806 <p>
2807 The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
2808 bit (highest order bit) of the <tt>value</tt> until it reaches the bit size of
2809 the type <tt>ty2</tt>.  When the the operand and the type are the same size,
2810 no bit filling is done and the cast is considered a <i>no-op cast</i> because
2811 no bits change (only the type changes).</p>
2812
2813 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
2814
2815 <h5>Example:</h5>
2816 <pre>
2817   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
2818   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
2819 </pre>
2820 </div>
2821
2822 <!-- _______________________________________________________________________ -->
2823 <div class="doc_subsubsection">
2824    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
2825 </div>
2826
2827 <div class="doc_text">
2828
2829 <h5>Syntax:</h5>
2830
2831 <pre>
2832   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2833 </pre>
2834
2835 <h5>Overview:</h5>
2836 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
2837 <tt>ty2</tt>.</p>
2838
2839
2840 <h5>Arguments:</h5>
2841 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
2842   point</a> value to cast and a <a href="#t_floating">floating point</a> type to
2843 cast it to. The size of <tt>value</tt> must be larger than the size of
2844 <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
2845 <i>no-op cast</i>.</p>
2846
2847 <h5>Semantics:</h5>
2848 <p> The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
2849 <a href="#t_floating">floating point</a> type to a smaller
2850 <a href="#t_floating">floating point</a> type.  If the value cannot fit within
2851 the destination type, <tt>ty2</tt>, then the results are undefined.</p>
2852
2853 <h5>Example:</h5>
2854 <pre>
2855   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
2856   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
2857 </pre>
2858 </div>
2859
2860 <!-- _______________________________________________________________________ -->
2861 <div class="doc_subsubsection">
2862    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
2863 </div>
2864 <div class="doc_text">
2865
2866 <h5>Syntax:</h5>
2867 <pre>
2868   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2869 </pre>
2870
2871 <h5>Overview:</h5>
2872 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
2873 floating point value.</p>
2874
2875 <h5>Arguments:</h5>
2876 <p>The '<tt>fpext</tt>' instruction takes a
2877 <a href="#t_floating">floating point</a> <tt>value</tt> to cast,
2878 and a <a href="#t_floating">floating point</a> type to cast it to. The source
2879 type must be smaller than the destination type.</p>
2880
2881 <h5>Semantics:</h5>
2882 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
2883 <a href="t_floating">floating point</a> type to a larger
2884 <a href="t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
2885 used to make a <i>no-op cast</i> because it always changes bits. Use
2886 <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
2887
2888 <h5>Example:</h5>
2889 <pre>
2890   %X = fpext float 3.1415 to double        <i>; yields double:3.1415</i>
2891   %Y = fpext float 1.0 to float            <i>; yields float:1.0 (no-op)</i>
2892 </pre>
2893 </div>
2894
2895 <!-- _______________________________________________________________________ -->
2896 <div class="doc_subsubsection">
2897    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
2898 </div>
2899 <div class="doc_text">
2900
2901 <h5>Syntax:</h5>
2902 <pre>
2903   &lt;result&gt; = fp2uint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2904 </pre>
2905
2906 <h5>Overview:</h5>
2907 <p>The '<tt>fp2uint</tt>' converts a floating point <tt>value</tt> to its
2908 unsigned integer equivalent of type <tt>ty2</tt>.
2909 </p>
2910
2911 <h5>Arguments:</h5>
2912 <p>The '<tt>fp2uint</tt>' instruction takes a value to cast, which must be a
2913 <a href="#t_floating">floating point</a> value, and a type to cast it to, which
2914 must be an <a href="#t_integer">integer</a> type.</p>
2915
2916 <h5>Semantics:</h5>
2917 <p> The '<tt>fp2uint</tt>' instruction converts its
2918 <a href="#t_floating">floating point</a> operand into the nearest (rounding
2919 towards zero) unsigned integer value. If the value cannot fit in <tt>ty2</tt>,
2920 the results are undefined.</p>
2921
2922 <p>When converting to i1, the conversion is done as a comparison against
2923 zero. If the <tt>value</tt> was zero, the i1 result will be <tt>false</tt>.
2924 If the <tt>value</tt> was non-zero, the i1 result will be <tt>true</tt>.</p>
2925
2926 <h5>Example:</h5>
2927 <pre>
2928   %X = fp2uint double 123.0 to i32      <i>; yields i32:123</i>
2929   %Y = fp2uint float 1.0E+300 to i1     <i>; yields i1:true</i>
2930   %X = fp2uint float 1.04E+17 to i8     <i>; yields undefined:1</i>
2931 </pre>
2932 </div>
2933
2934 <!-- _______________________________________________________________________ -->
2935 <div class="doc_subsubsection">
2936    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
2937 </div>
2938 <div class="doc_text">
2939
2940 <h5>Syntax:</h5>
2941 <pre>
2942   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2943 </pre>
2944
2945 <h5>Overview:</h5>
2946 <p>The '<tt>fptosi</tt>' instruction converts
2947 <a href="#t_floating">floating point</a> <tt>value</tt> to type <tt>ty2</tt>.
2948 </p>
2949
2950
2951 <h5>Arguments:</h5>
2952 <p> The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
2953 <a href="#t_floating">floating point</a> value, and a type to cast it to, which
2954 must also be an <a href="#t_integer">integer</a> type.</p>
2955
2956 <h5>Semantics:</h5>
2957 <p>The '<tt>fptosi</tt>' instruction converts its
2958 <a href="#t_floating">floating point</a> operand into the nearest (rounding
2959 towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
2960 the results are undefined.</p>
2961
2962 <p>When converting to i1, the conversion is done as a comparison against
2963 zero. If the <tt>value</tt> was zero, the i1 result will be <tt>false</tt>.
2964 If the <tt>value</tt> was non-zero, the i1 result will be <tt>true</tt>.</p>
2965
2966 <h5>Example:</h5>
2967 <pre>
2968   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
2969   %Y = fptosi float 1.0E-247 to i1      <i>; yields i1:true</i>
2970   %X = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
2971 </pre>
2972 </div>
2973
2974 <!-- _______________________________________________________________________ -->
2975 <div class="doc_subsubsection">
2976    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
2977 </div>
2978 <div class="doc_text">
2979
2980 <h5>Syntax:</h5>
2981 <pre>
2982   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2983 </pre>
2984
2985 <h5>Overview:</h5>
2986 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
2987 integer and converts that value to the <tt>ty2</tt> type.</p>
2988
2989
2990 <h5>Arguments:</h5>
2991 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be an
2992 <a href="#t_integer">integer</a> value, and a type to cast it to, which must
2993 be a <a href="#t_floating">floating point</a> type.</p>
2994
2995 <h5>Semantics:</h5>
2996 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
2997 integer quantity and converts it to the corresponding floating point value. If
2998 the value cannot fit in the floating point value, the results are undefined.</p>
2999
3000
3001 <h5>Example:</h5>
3002 <pre>
3003   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
3004   %Y = uitofp i8  -1 to double       <i>; yields double:255.0</i>
3005 </pre>
3006 </div>
3007
3008 <!-- _______________________________________________________________________ -->
3009 <div class="doc_subsubsection">
3010    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
3011 </div>
3012 <div class="doc_text">
3013
3014 <h5>Syntax:</h5>
3015 <pre>
3016   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3017 </pre>
3018
3019 <h5>Overview:</h5>
3020 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed
3021 integer and converts that value to the <tt>ty2</tt> type.</p>
3022
3023 <h5>Arguments:</h5>
3024 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be an
3025 <a href="#t_integer">integer</a> value, and a type to cast it to, which must be
3026 a <a href="#t_floating">floating point</a> type.</p>
3027
3028 <h5>Semantics:</h5>
3029 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed
3030 integer quantity and converts it to the corresponding floating point value. If
3031 the value cannot fit in the floating point value, the results are undefined.</p>
3032
3033 <h5>Example:</h5>
3034 <pre>
3035   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
3036   %Y = sitofp i8  -1 to double       <i>; yields double:-1.0</i>
3037 </pre>
3038 </div>
3039
3040 <!-- _______________________________________________________________________ -->
3041 <div class="doc_subsubsection">
3042    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
3043 </div>
3044 <div class="doc_text">
3045
3046 <h5>Syntax:</h5>
3047 <pre>
3048   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3049 </pre>
3050
3051 <h5>Overview:</h5>
3052 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
3053 the integer type <tt>ty2</tt>.</p>
3054
3055 <h5>Arguments:</h5>
3056 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
3057 must be a <a href="t_pointer">pointer</a> value, and a type to cast it to
3058 <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.
3059
3060 <h5>Semantics:</h5>
3061 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
3062 <tt>ty2</tt> by interpreting the pointer value as an integer and either
3063 truncating or zero extending that value to the size of the integer type. If
3064 <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
3065 <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
3066 are the same size, then nothing is done (<i>no-op cast</i>).</p>
3067
3068 <h5>Example:</h5>
3069 <pre>
3070   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit</i>
3071   %Y = ptrtoint i32* %x to i64          <i>; yields zero extend on 32-bit</i>
3072 </pre>
3073 </div>
3074
3075 <!-- _______________________________________________________________________ -->
3076 <div class="doc_subsubsection">
3077    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
3078 </div>
3079 <div class="doc_text">
3080
3081 <h5>Syntax:</h5>
3082 <pre>
3083   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3084 </pre>
3085
3086 <h5>Overview:</h5>
3087 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to
3088 a pointer type, <tt>ty2</tt>.</p>
3089
3090 <h5>Arguments:</h5>
3091 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="i_integer">integer</a>
3092 value to cast, and a type to cast it to, which must be a
3093 <a href="#t_pointer">pointer</a> type.
3094
3095 <h5>Semantics:</h5>
3096 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
3097 <tt>ty2</tt> by applying either a zero extension or a truncation depending on
3098 the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
3099 size of a pointer then a truncation is done. If <tt>value</tt> is smaller than
3100 the size of a pointer then a zero extension is done. If they are the same size,
3101 nothing is done (<i>no-op cast</i>).</p>
3102
3103 <h5>Example:</h5>
3104 <pre>
3105   %X = inttoptr i32 255 to i32*            <i>; yields zero extend on 64-bit</i>
3106   %X = inttoptr i32 255 to i32*            <i>; yields no-op on 32-bit </i>
3107   %Y = inttoptr i16 0 to i32*            <i>; yields zero extend on 32-bit</i>
3108 </pre>
3109 </div>
3110
3111 <!-- _______________________________________________________________________ -->
3112 <div class="doc_subsubsection">
3113    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
3114 </div>
3115 <div class="doc_text">
3116
3117 <h5>Syntax:</h5>
3118 <pre>
3119   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3120 </pre>
3121
3122 <h5>Overview:</h5>
3123 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
3124 <tt>ty2</tt> without changing any bits.</p>
3125
3126 <h5>Arguments:</h5>
3127 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be
3128 a first class value, and a type to cast it to, which must also be a <a
3129   href="#t_firstclass">first class</a> type. The bit sizes of <tt>value</tt>
3130 and the destination type, <tt>ty2</tt>, must be identical. If the source
3131 type is a pointer, the destination type must also be a pointer.</p>
3132
3133 <h5>Semantics:</h5>
3134 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
3135 <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
3136 this conversion.  The conversion is done as if the <tt>value</tt> had been
3137 stored to memory and read back as type <tt>ty2</tt>. Pointer types may only be
3138 converted to other pointer types with this instruction. To convert pointers to
3139 other types, use the <a href="#i_inttoptr">inttoptr</a> or
3140 <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
3141
3142 <h5>Example:</h5>
3143 <pre>
3144   %X = bitcast i8 255 to i8          <i>; yields i8 :-1</i>
3145   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
3146   %Z = bitcast <2xint> %V to i64;        <i>; yields i64: %V</i>
3147 </pre>
3148 </div>
3149
3150 <!-- ======================================================================= -->
3151 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
3152 <div class="doc_text">
3153 <p>The instructions in this category are the "miscellaneous"
3154 instructions, which defy better classification.</p>
3155 </div>
3156
3157 <!-- _______________________________________________________________________ -->
3158 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
3159 </div>
3160 <div class="doc_text">
3161 <h5>Syntax:</h5>
3162 <pre>  &lt;result&gt; = icmp &lt;cond&gt; &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;
3163 <i>; yields {i1}:result</i>
3164 </pre>
3165 <h5>Overview:</h5>
3166 <p>The '<tt>icmp</tt>' instruction returns a boolean value based on comparison
3167 of its two integer operands.</p>
3168 <h5>Arguments:</h5>
3169 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
3170 the condition code which indicates the kind of comparison to perform. It is not
3171 a value, just a keyword. The possibilities for the condition code are:
3172 <ol>
3173   <li><tt>eq</tt>: equal</li>
3174   <li><tt>ne</tt>: not equal </li>
3175   <li><tt>ugt</tt>: unsigned greater than</li>
3176   <li><tt>uge</tt>: unsigned greater or equal</li>
3177   <li><tt>ult</tt>: unsigned less than</li>
3178   <li><tt>ule</tt>: unsigned less or equal</li>
3179   <li><tt>sgt</tt>: signed greater than</li>
3180   <li><tt>sge</tt>: signed greater or equal</li>
3181   <li><tt>slt</tt>: signed less than</li>
3182   <li><tt>sle</tt>: signed less or equal</li>
3183 </ol>
3184 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
3185 <a href="#t_pointer">pointer</a> typed. They must also be identical types.</p>
3186 <h5>Semantics:</h5>
3187 <p>The '<tt>icmp</tt>' compares <tt>var1</tt> and <tt>var2</tt> according to
3188 the condition code given as <tt>cond</tt>. The comparison performed always
3189 yields a <a href="#t_primitive">i1</a> result, as follows:
3190 <ol>
3191   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
3192   <tt>false</tt> otherwise. No sign interpretation is necessary or performed.
3193   </li>
3194   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
3195   <tt>false</tt> otherwise. No sign interpretation is necessary or performed.
3196   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
3197   <tt>true</tt> if <tt>var1</tt> is greater than <tt>var2</tt>.</li>
3198   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
3199   <tt>true</tt> if <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3200   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
3201   <tt>true</tt> if <tt>var1</tt> is less than <tt>var2</tt>.</li>
3202   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
3203   <tt>true</tt> if <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3204   <li><tt>sgt</tt>: interprets the operands as signed values and yields
3205   <tt>true</tt> if <tt>var1</tt> is greater than <tt>var2</tt>.</li>
3206   <li><tt>sge</tt>: interprets the operands as signed values and yields
3207   <tt>true</tt> if <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3208   <li><tt>slt</tt>: interprets the operands as signed values and yields
3209   <tt>true</tt> if <tt>var1</tt> is less than <tt>var2</tt>.</li>
3210   <li><tt>sle</tt>: interprets the operands as signed values and yields
3211   <tt>true</tt> if <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3212 </ol>
3213 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
3214 values are treated as integers and then compared.</p>
3215
3216 <h5>Example:</h5>
3217 <pre>  &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
3218   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
3219   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
3220   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
3221   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
3222   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
3223 </pre>
3224 </div>
3225
3226 <!-- _______________________________________________________________________ -->
3227 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
3228 </div>
3229 <div class="doc_text">
3230 <h5>Syntax:</h5>
3231 <pre>  &lt;result&gt; = fcmp &lt;cond&gt; &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;
3232 <i>; yields {i1}:result</i>
3233 </pre>
3234 <h5>Overview:</h5>
3235 <p>The '<tt>fcmp</tt>' instruction returns a boolean value based on comparison
3236 of its floating point operands.</p>
3237 <h5>Arguments:</h5>
3238 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
3239 the condition code which indicates the kind of comparison to perform. It is not
3240 a value, just a keyword. The possibilities for the condition code are:
3241 <ol>
3242   <li><tt>false</tt>: no comparison, always returns false</li>
3243   <li><tt>oeq</tt>: ordered and equal</li>
3244   <li><tt>ogt</tt>: ordered and greater than </li>
3245   <li><tt>oge</tt>: ordered and greater than or equal</li>
3246   <li><tt>olt</tt>: ordered and less than </li>
3247   <li><tt>ole</tt>: ordered and less than or equal</li>
3248   <li><tt>one</tt>: ordered and not equal</li>
3249   <li><tt>ord</tt>: ordered (no nans)</li>
3250   <li><tt>ueq</tt>: unordered or equal</li>
3251   <li><tt>ugt</tt>: unordered or greater than </li>
3252   <li><tt>uge</tt>: unordered or greater than or equal</li>
3253   <li><tt>ult</tt>: unordered or less than </li>
3254   <li><tt>ule</tt>: unordered or less than or equal</li>
3255   <li><tt>une</tt>: unordered or not equal</li>
3256   <li><tt>uno</tt>: unordered (either nans)</li>
3257   <li><tt>true</tt>: no comparison, always returns true</li>
3258 </ol>
3259 <p>In the preceding, <i>ordered</i> means that neither operand is a QNAN while
3260 <i>unordered</i> means that either operand may be a QNAN.</p>
3261 <p>The <tt>val1</tt> and <tt>val2</tt> arguments must be
3262 <a href="#t_floating">floating point</a> typed.  They must have identical
3263 types.</p>
3264 <p>In the foregoing, <i>ordered</i> means that neither operand is a QNAN and
3265 <i>unordered</i> means that either operand is a QNAN.</p>
3266 <h5>Semantics:</h5>
3267 <p>The '<tt>fcmp</tt>' compares <tt>var1</tt> and <tt>var2</tt> according to
3268 the condition code given as <tt>cond</tt>. The comparison performed always
3269 yields a <a href="#t_primitive">i1</a> result, as follows:
3270 <ol>
3271   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
3272   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3273   <tt>var1</tt> is equal to <tt>var2</tt>.</li>
3274   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3275   <tt>var1</tt> is greather than <tt>var2</tt>.</li>
3276   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3277   <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3278   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3279   <tt>var1</tt> is less than <tt>var2</tt>.</li>
3280   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3281   <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3282   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
3283   <tt>var1</tt> is not equal to <tt>var2</tt>.</li>
3284   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
3285   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
3286   <tt>var1</tt> is equal to <tt>var2</tt>.</li>
3287   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
3288   <tt>var1</tt> is greater than <tt>var2</tt>.</li>
3289   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
3290   <tt>var1</tt> is greater than or equal to <tt>var2</tt>.</li>
3291   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
3292   <tt>var1</tt> is less than <tt>var2</tt>.</li>
3293   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
3294   <tt>var1</tt> is less than or equal to <tt>var2</tt>.</li>
3295   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
3296   <tt>var1</tt> is not equal to <tt>var2</tt>.</li>
3297   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
3298   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
3299 </ol>
3300
3301 <h5>Example:</h5>
3302 <pre>  &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
3303   &lt;result&gt; = icmp one float 4.0, 5.0    <i>; yields: result=true</i>
3304   &lt;result&gt; = icmp olt float 4.0, 5.0    <i>; yields: result=true</i>
3305   &lt;result&gt; = icmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
3306 </pre>
3307 </div>
3308
3309 <!-- _______________________________________________________________________ -->
3310 <div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>'
3311 Instruction</a> </div>
3312 <div class="doc_text">
3313 <h5>Syntax:</h5>
3314 <pre>  &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
3315 <h5>Overview:</h5>
3316 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
3317 the SSA graph representing the function.</p>
3318 <h5>Arguments:</h5>
3319 <p>The type of the incoming values are specified with the first type
3320 field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
3321 as arguments, with one pair for each predecessor basic block of the
3322 current block.  Only values of <a href="#t_firstclass">first class</a>
3323 type may be used as the value arguments to the PHI node.  Only labels
3324 may be used as the label arguments.</p>
3325 <p>There must be no non-phi instructions between the start of a basic
3326 block and the PHI instructions: i.e. PHI instructions must be first in
3327 a basic block.</p>
3328 <h5>Semantics:</h5>
3329 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the
3330 value specified by the parameter, depending on which basic block we
3331 came from in the last <a href="#terminators">terminator</a> instruction.</p>
3332 <h5>Example:</h5>
3333 <pre>Loop:       ; Infinite loop that counts from 0 on up...<br>  %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]<br>  %nextindvar = add i32 %indvar, 1<br>  br label %Loop<br></pre>
3334 </div>
3335
3336 <!-- _______________________________________________________________________ -->
3337 <div class="doc_subsubsection">
3338    <a name="i_select">'<tt>select</tt>' Instruction</a>
3339 </div>
3340
3341 <div class="doc_text">
3342
3343 <h5>Syntax:</h5>
3344
3345 <pre>
3346   &lt;result&gt; = select i1 &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt;             <i>; yields ty</i>
3347 </pre>
3348
3349 <h5>Overview:</h5>
3350
3351 <p>
3352 The '<tt>select</tt>' instruction is used to choose one value based on a
3353 condition, without branching.
3354 </p>
3355
3356
3357 <h5>Arguments:</h5>
3358
3359 <p>
3360 The '<tt>select</tt>' instruction requires a boolean value indicating the condition, and two values of the same <a href="#t_firstclass">first class</a> type.
3361 </p>
3362
3363 <h5>Semantics:</h5>
3364
3365 <p>
3366 If the boolean condition evaluates to true, the instruction returns the first
3367 value argument; otherwise, it returns the second value argument.
3368 </p>
3369
3370 <h5>Example:</h5>
3371
3372 <pre>
3373   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
3374 </pre>
3375 </div>
3376
3377
3378 <!-- _______________________________________________________________________ -->
3379 <div class="doc_subsubsection">
3380   <a name="i_call">'<tt>call</tt>' Instruction</a>
3381 </div>
3382
3383 <div class="doc_text">
3384
3385 <h5>Syntax:</h5>
3386 <pre>
3387   &lt;result&gt; = [tail] call [<a href="#callingconv">cconv</a>] &lt;ty&gt;* &lt;fnptrval&gt;(&lt;param list&gt;)
3388 </pre>
3389
3390 <h5>Overview:</h5>
3391
3392 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
3393
3394 <h5>Arguments:</h5>
3395
3396 <p>This instruction requires several arguments:</p>
3397
3398 <ol>
3399   <li>
3400     <p>The optional "tail" marker indicates whether the callee function accesses
3401     any allocas or varargs in the caller.  If the "tail" marker is present, the
3402     function call is eligible for tail call optimization.  Note that calls may
3403     be marked "tail" even if they do not occur before a <a
3404     href="#i_ret"><tt>ret</tt></a> instruction.
3405   </li>
3406   <li>
3407     <p>The optional "cconv" marker indicates which <a href="callingconv">calling
3408     convention</a> the call should use.  If none is specified, the call defaults
3409     to using C calling conventions.
3410   </li>
3411   <li>
3412     <p>'<tt>ty</tt>': shall be the signature of the pointer to function value
3413     being invoked.  The argument types must match the types implied by this
3414     signature.  This type can be omitted if the function is not varargs and
3415     if the function type does not return a pointer to a function.</p>
3416   </li>
3417   <li>
3418     <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
3419     be invoked. In most cases, this is a direct function invocation, but
3420     indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
3421     to function value.</p>
3422   </li>
3423   <li>
3424     <p>'<tt>function args</tt>': argument list whose types match the
3425     function signature argument types. All arguments must be of
3426     <a href="#t_firstclass">first class</a> type. If the function signature
3427     indicates the function accepts a variable number of arguments, the extra
3428     arguments can be specified.</p>
3429   </li>
3430 </ol>
3431
3432 <h5>Semantics:</h5>
3433
3434 <p>The '<tt>call</tt>' instruction is used to cause control flow to
3435 transfer to a specified function, with its incoming arguments bound to
3436 the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
3437 instruction in the called function, control flow continues with the
3438 instruction after the function call, and the return value of the
3439 function is bound to the result argument.  This is a simpler case of
3440 the <a href="#i_invoke">invoke</a> instruction.</p>
3441
3442 <h5>Example:</h5>
3443
3444 <pre>
3445   %retval = call i32 %test(i32 %argc)
3446   call i32(i8 *, ...) *%printf(i8 * %msg, i32 12, i8  42);
3447   %X = tail call i32 %foo()
3448   %Y = tail call <a href="#callingconv">fastcc</a> i32 %foo()
3449 </pre>
3450
3451 </div>
3452
3453 <!-- _______________________________________________________________________ -->
3454 <div class="doc_subsubsection">
3455   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
3456 </div>
3457
3458 <div class="doc_text">
3459
3460 <h5>Syntax:</h5>
3461
3462 <pre>
3463   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
3464 </pre>
3465
3466 <h5>Overview:</h5>
3467
3468 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
3469 the "variable argument" area of a function call.  It is used to implement the
3470 <tt>va_arg</tt> macro in C.</p>
3471
3472 <h5>Arguments:</h5>
3473
3474 <p>This instruction takes a <tt>va_list*</tt> value and the type of
3475 the argument. It returns a value of the specified argument type and
3476 increments the <tt>va_list</tt> to point to the next argument.  Again, the
3477 actual type of <tt>va_list</tt> is target specific.</p>
3478
3479 <h5>Semantics:</h5>
3480
3481 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified
3482 type from the specified <tt>va_list</tt> and causes the
3483 <tt>va_list</tt> to point to the next argument.  For more information,
3484 see the variable argument handling <a href="#int_varargs">Intrinsic
3485 Functions</a>.</p>
3486
3487 <p>It is legal for this instruction to be called in a function which does not
3488 take a variable number of arguments, for example, the <tt>vfprintf</tt>
3489 function.</p>
3490
3491 <p><tt>va_arg</tt> is an LLVM instruction instead of an <a
3492 href="#intrinsics">intrinsic function</a> because it takes a type as an
3493 argument.</p>
3494
3495 <h5>Example:</h5>
3496
3497 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
3498
3499 </div>
3500
3501 <!-- *********************************************************************** -->
3502 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
3503 <!-- *********************************************************************** -->
3504
3505 <div class="doc_text">
3506
3507 <p>LLVM supports the notion of an "intrinsic function".  These functions have
3508 well known names and semantics and are required to follow certain
3509 restrictions. Overall, these instructions represent an extension mechanism for
3510 the LLVM language that does not require changing all of the transformations in
3511 LLVM to add to the language (or the bytecode reader/writer, the parser,
3512 etc...).</p>
3513
3514 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
3515 prefix is reserved in LLVM for intrinsic names; thus, functions may not be named
3516 this.  Intrinsic functions must always be external functions: you cannot define
3517 the body of intrinsic functions.  Intrinsic functions may only be used in call
3518 or invoke instructions: it is illegal to take the address of an intrinsic
3519 function.  Additionally, because intrinsic functions are part of the LLVM
3520 language, it is required that they all be documented here if any are added.</p>
3521
3522
3523 <p>To learn how to add an intrinsic function, please see the <a
3524 href="ExtendingLLVM.html">Extending LLVM Guide</a>.
3525 </p>
3526
3527 </div>
3528
3529 <!-- ======================================================================= -->
3530 <div class="doc_subsection">
3531   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
3532 </div>
3533
3534 <div class="doc_text">
3535
3536 <p>Variable argument support is defined in LLVM with the <a
3537  href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
3538 intrinsic functions.  These functions are related to the similarly
3539 named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
3540
3541 <p>All of these functions operate on arguments that use a
3542 target-specific value type "<tt>va_list</tt>".  The LLVM assembly
3543 language reference manual does not define what this type is, so all
3544 transformations should be prepared to handle intrinsics with any type
3545 used.</p>
3546
3547 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
3548 instruction and the variable argument handling intrinsic functions are
3549 used.</p>
3550
3551 <pre>
3552 define i32 %test(i32 %X, ...) {
3553   ; Initialize variable argument processing
3554   %ap = alloca i8 *
3555   %ap2 = bitcast i8** %ap to i8*
3556   call void %<a href="#i_va_start">llvm.va_start</a>(i8* %ap2)
3557
3558   ; Read a single integer argument
3559   %tmp = va_arg i8 ** %ap, i32
3560
3561   ; Demonstrate usage of llvm.va_copy and llvm.va_end
3562   %aq = alloca i8 *
3563   %aq2 = bitcast i8** %aq to i8*
3564   call void %<a href="#i_va_copy">llvm.va_copy</a>(i8 *%aq2, i8* %ap2)
3565   call void %<a href="#i_va_end">llvm.va_end</a>(i8* %aq2)
3566
3567   ; Stop processing of arguments.
3568   call void %<a href="#i_va_end">llvm.va_end</a>(i8* %ap2)
3569   ret i32 %tmp
3570 }
3571 </pre>
3572 </div>
3573
3574 <!-- _______________________________________________________________________ -->
3575 <div class="doc_subsubsection">
3576   <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
3577 </div>
3578
3579
3580 <div class="doc_text">
3581 <h5>Syntax:</h5>
3582 <pre>  declare void %llvm.va_start(i8* &lt;arglist&gt;)<br></pre>
3583 <h5>Overview:</h5>
3584 <P>The '<tt>llvm.va_start</tt>' intrinsic initializes
3585 <tt>*&lt;arglist&gt;</tt> for subsequent use by <tt><a
3586 href="#i_va_arg">va_arg</a></tt>.</p>
3587
3588 <h5>Arguments:</h5>
3589
3590 <P>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
3591
3592 <h5>Semantics:</h5>
3593
3594 <P>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
3595 macro available in C.  In a target-dependent way, it initializes the
3596 <tt>va_list</tt> element the argument points to, so that the next call to
3597 <tt>va_arg</tt> will produce the first variable argument passed to the function.
3598 Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the
3599 last argument of the function, the compiler can figure that out.</p>
3600
3601 </div>
3602
3603 <!-- _______________________________________________________________________ -->
3604 <div class="doc_subsubsection">
3605  <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
3606 </div>
3607
3608 <div class="doc_text">
3609 <h5>Syntax:</h5>
3610 <pre>  declare void %llvm.va_end(i8* &lt;arglist&gt;)<br></pre>
3611 <h5>Overview:</h5>
3612
3613 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>&lt;arglist&gt;</tt>
3614 which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt>
3615 or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
3616
3617 <h5>Arguments:</h5>
3618
3619 <p>The argument is a <tt>va_list</tt> to destroy.</p>
3620
3621 <h5>Semantics:</h5>
3622
3623 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
3624 macro available in C.  In a target-dependent way, it destroys the <tt>va_list</tt>.
3625 Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a
3626  href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly
3627 with calls to <tt>llvm.va_end</tt>.</p>
3628
3629 </div>
3630
3631 <!-- _______________________________________________________________________ -->
3632 <div class="doc_subsubsection">
3633   <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
3634 </div>
3635
3636 <div class="doc_text">
3637
3638 <h5>Syntax:</h5>
3639
3640 <pre>
3641   declare void %llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
3642 </pre>
3643
3644 <h5>Overview:</h5>
3645
3646 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position from
3647 the source argument list to the destination argument list.</p>
3648
3649 <h5>Arguments:</h5>
3650
3651 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
3652 The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p>
3653
3654
3655 <h5>Semantics:</h5>
3656
3657 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt> macro
3658 available in C.  In a target-dependent way, it copies the source
3659 <tt>va_list</tt> element into the destination list.  This intrinsic is necessary
3660 because the <tt><a href="i_va_begin">llvm.va_begin</a></tt> intrinsic may be
3661 arbitrarily complex and require memory allocation, for example.</p>
3662
3663 </div>
3664
3665 <!-- ======================================================================= -->
3666 <div class="doc_subsection">
3667   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
3668 </div>
3669
3670 <div class="doc_text">
3671
3672 <p>
3673 LLVM support for <a href="GarbageCollection.html">Accurate Garbage
3674 Collection</a> requires the implementation and generation of these intrinsics.
3675 These intrinsics allow identification of <a href="#i_gcroot">GC roots on the
3676 stack</a>, as well as garbage collector implementations that require <a
3677 href="#i_gcread">read</a> and <a href="#i_gcwrite">write</a> barriers.
3678 Front-ends for type-safe garbage collected languages should generate these
3679 intrinsics to make use of the LLVM garbage collectors.  For more details, see <a
3680 href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
3681 </p>
3682 </div>
3683
3684 <!-- _______________________________________________________________________ -->
3685 <div class="doc_subsubsection">
3686   <a name="i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
3687 </div>
3688
3689 <div class="doc_text">
3690
3691 <h5>Syntax:</h5>
3692
3693 <pre>
3694   declare void %llvm.gcroot(&lt;ty&gt;** %ptrloc, &lt;ty2&gt;* %metadata)
3695 </pre>
3696
3697 <h5>Overview:</h5>
3698
3699 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
3700 the code generator, and allows some metadata to be associated with it.</p>
3701
3702 <h5>Arguments:</h5>
3703
3704 <p>The first argument specifies the address of a stack object that contains the
3705 root pointer.  The second pointer (which must be either a constant or a global
3706 value address) contains the meta-data to be associated with the root.</p>
3707
3708 <h5>Semantics:</h5>
3709
3710 <p>At runtime, a call to this intrinsics stores a null pointer into the "ptrloc"
3711 location.  At compile-time, the code generator generates information to allow
3712 the runtime to find the pointer at GC safe points.
3713 </p>
3714
3715 </div>
3716
3717
3718 <!-- _______________________________________________________________________ -->
3719 <div class="doc_subsubsection">
3720   <a name="i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
3721 </div>
3722
3723 <div class="doc_text">
3724
3725 <h5>Syntax:</h5>
3726
3727 <pre>
3728   declare i8 * %llvm.gcread(i8 * %ObjPtr, i8 ** %Ptr)
3729 </pre>
3730
3731 <h5>Overview:</h5>
3732
3733 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
3734 locations, allowing garbage collector implementations that require read
3735 barriers.</p>
3736
3737 <h5>Arguments:</h5>
3738
3739 <p>The second argument is the address to read from, which should be an address
3740 allocated from the garbage collector.  The first object is a pointer to the
3741 start of the referenced object, if needed by the language runtime (otherwise
3742 null).</p>
3743
3744 <h5>Semantics:</h5>
3745
3746 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
3747 instruction, but may be replaced with substantially more complex code by the
3748 garbage collector runtime, as needed.</p>
3749
3750 </div>
3751
3752
3753 <!-- _______________________________________________________________________ -->
3754 <div class="doc_subsubsection">
3755   <a name="i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
3756 </div>
3757
3758 <div class="doc_text">
3759
3760 <h5>Syntax:</h5>
3761
3762 <pre>
3763   declare void %llvm.gcwrite(i8 * %P1, i8 * %Obj, i8 ** %P2)
3764 </pre>
3765
3766 <h5>Overview:</h5>
3767
3768 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
3769 locations, allowing garbage collector implementations that require write
3770 barriers (such as generational or reference counting collectors).</p>
3771
3772 <h5>Arguments:</h5>
3773
3774 <p>The first argument is the reference to store, the second is the start of the
3775 object to store it to, and the third is the address of the field of Obj to
3776 store to.  If the runtime does not require a pointer to the object, Obj may be
3777 null.</p>
3778
3779 <h5>Semantics:</h5>
3780
3781 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
3782 instruction, but may be replaced with substantially more complex code by the
3783 garbage collector runtime, as needed.</p>
3784
3785 </div>
3786
3787
3788
3789 <!-- ======================================================================= -->
3790 <div class="doc_subsection">
3791   <a name="int_codegen">Code Generator Intrinsics</a>
3792 </div>
3793
3794 <div class="doc_text">
3795 <p>
3796 These intrinsics are provided by LLVM to expose special features that may only
3797 be implemented with code generator support.
3798 </p>
3799
3800 </div>
3801
3802 <!-- _______________________________________________________________________ -->
3803 <div class="doc_subsubsection">
3804   <a name="i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
3805 </div>
3806
3807 <div class="doc_text">
3808
3809 <h5>Syntax:</h5>
3810 <pre>
3811   declare i8  *%llvm.returnaddress(i32 &lt;level&gt;)
3812 </pre>
3813
3814 <h5>Overview:</h5>
3815
3816 <p>
3817 The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
3818 target-specific value indicating the return address of the current function
3819 or one of its callers.
3820 </p>
3821
3822 <h5>Arguments:</h5>
3823
3824 <p>
3825 The argument to this intrinsic indicates which function to return the address
3826 for.  Zero indicates the calling function, one indicates its caller, etc.  The
3827 argument is <b>required</b> to be a constant integer value.
3828 </p>
3829
3830 <h5>Semantics:</h5>
3831
3832 <p>
3833 The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
3834 the return address of the specified call frame, or zero if it cannot be
3835 identified.  The value returned by this intrinsic is likely to be incorrect or 0
3836 for arguments other than zero, so it should only be used for debugging purposes.
3837 </p>
3838
3839 <p>
3840 Note that calling this intrinsic does not prevent function inlining or other
3841 aggressive transformations, so the value returned may not be that of the obvious
3842 source-language caller.
3843 </p>
3844 </div>
3845
3846
3847 <!-- _______________________________________________________________________ -->
3848 <div class="doc_subsubsection">
3849   <a name="i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
3850 </div>
3851
3852 <div class="doc_text">
3853
3854 <h5>Syntax:</h5>
3855 <pre>
3856   declare i8  *%llvm.frameaddress(i32 &lt;level&gt;)
3857 </pre>
3858
3859 <h5>Overview:</h5>
3860
3861 <p>
3862 The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
3863 target-specific frame pointer value for the specified stack frame.
3864 </p>
3865
3866 <h5>Arguments:</h5>
3867
3868 <p>
3869 The argument to this intrinsic indicates which function to return the frame
3870 pointer for.  Zero indicates the calling function, one indicates its caller,
3871 etc.  The argument is <b>required</b> to be a constant integer value.
3872 </p>
3873
3874 <h5>Semantics:</h5>
3875
3876 <p>
3877 The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
3878 the frame address of the specified call frame, or zero if it cannot be
3879 identified.  The value returned by this intrinsic is likely to be incorrect or 0
3880 for arguments other than zero, so it should only be used for debugging purposes.
3881 </p>
3882
3883 <p>
3884 Note that calling this intrinsic does not prevent function inlining or other
3885 aggressive transformations, so the value returned may not be that of the obvious
3886 source-language caller.
3887 </p>
3888 </div>
3889
3890 <!-- _______________________________________________________________________ -->
3891 <div class="doc_subsubsection">
3892   <a name="i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
3893 </div>
3894
3895 <div class="doc_text">
3896
3897 <h5>Syntax:</h5>
3898 <pre>
3899   declare i8  *%llvm.stacksave()
3900 </pre>
3901
3902 <h5>Overview:</h5>
3903
3904 <p>
3905 The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state of
3906 the function stack, for use with <a href="#i_stackrestore">
3907 <tt>llvm.stackrestore</tt></a>.  This is useful for implementing language
3908 features like scoped automatic variable sized arrays in C99.
3909 </p>
3910
3911 <h5>Semantics:</h5>
3912
3913 <p>
3914 This intrinsic returns a opaque pointer value that can be passed to <a
3915 href="#i_stackrestore"><tt>llvm.stackrestore</tt></a>.  When an
3916 <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved from
3917 <tt>llvm.stacksave</tt>, it effectively restores the state of the stack to the
3918 state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.  In
3919 practice, this pops any <a href="#i_alloca">alloca</a> blocks from the stack
3920 that were allocated after the <tt>llvm.stacksave</tt> was executed.
3921 </p>
3922
3923 </div>
3924
3925 <!-- _______________________________________________________________________ -->
3926 <div class="doc_subsubsection">
3927   <a name="i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
3928 </div>
3929
3930 <div class="doc_text">
3931
3932 <h5>Syntax:</h5>
3933 <pre>
3934   declare void %llvm.stackrestore(i8 * %ptr)
3935 </pre>
3936
3937 <h5>Overview:</h5>
3938
3939 <p>
3940 The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
3941 the function stack to the state it was in when the corresponding <a
3942 href="#llvm.stacksave"><tt>llvm.stacksave</tt></a> intrinsic executed.  This is
3943 useful for implementing language features like scoped automatic variable sized
3944 arrays in C99.
3945 </p>
3946
3947 <h5>Semantics:</h5>
3948
3949 <p>
3950 See the description for <a href="#i_stacksave"><tt>llvm.stacksave</tt></a>.
3951 </p>
3952
3953 </div>
3954
3955
3956 <!-- _______________________________________________________________________ -->
3957 <div class="doc_subsubsection">
3958   <a name="i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
3959 </div>
3960
3961 <div class="doc_text">
3962
3963 <h5>Syntax:</h5>
3964 <pre>
3965   declare void %llvm.prefetch(i8  * &lt;address&gt;,
3966                                 i32 &lt;rw&gt;, i32 &lt;locality&gt;)
3967 </pre>
3968
3969 <h5>Overview:</h5>
3970
3971
3972 <p>
3973 The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
3974 a prefetch instruction if supported; otherwise, it is a noop.  Prefetches have
3975 no
3976 effect on the behavior of the program but can change its performance
3977 characteristics.
3978 </p>
3979
3980 <h5>Arguments:</h5>
3981
3982 <p>
3983 <tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
3984 determining if the fetch should be for a read (0) or write (1), and
3985 <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
3986 locality, to (3) - extremely local keep in cache.  The <tt>rw</tt> and
3987 <tt>locality</tt> arguments must be constant integers.
3988 </p>
3989
3990 <h5>Semantics:</h5>
3991
3992 <p>
3993 This intrinsic does not modify the behavior of the program.  In particular,
3994 prefetches cannot trap and do not produce a value.  On targets that support this
3995 intrinsic, the prefetch can provide hints to the processor cache for better
3996 performance.
3997 </p>
3998
3999 </div>
4000
4001 <!-- _______________________________________________________________________ -->
4002 <div class="doc_subsubsection">
4003   <a name="i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
4004 </div>
4005
4006 <div class="doc_text">
4007
4008 <h5>Syntax:</h5>
4009 <pre>
4010   declare void %llvm.pcmarker( i32 &lt;id&gt; )
4011 </pre>
4012
4013 <h5>Overview:</h5>
4014
4015
4016 <p>
4017 The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter
4018 (PC) in a region of
4019 code to simulators and other tools.  The method is target specific, but it is
4020 expected that the marker will use exported symbols to transmit the PC of the marker.
4021 The marker makes no guarantees that it will remain with any specific instruction
4022 after optimizations.  It is possible that the presence of a marker will inhibit
4023 optimizations.  The intended use is to be inserted after optimizations to allow
4024 correlations of simulation runs.
4025 </p>
4026
4027 <h5>Arguments:</h5>
4028
4029 <p>
4030 <tt>id</tt> is a numerical id identifying the marker.
4031 </p>
4032
4033 <h5>Semantics:</h5>
4034
4035 <p>
4036 This intrinsic does not modify the behavior of the program.  Backends that do not
4037 support this intrinisic may ignore it.
4038 </p>
4039
4040 </div>
4041
4042 <!-- _______________________________________________________________________ -->
4043 <div class="doc_subsubsection">
4044   <a name="i_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
4045 </div>
4046
4047 <div class="doc_text">
4048
4049 <h5>Syntax:</h5>
4050 <pre>
4051   declare i64 %llvm.readcyclecounter( )
4052 </pre>
4053
4054 <h5>Overview:</h5>
4055
4056
4057 <p>
4058 The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
4059 counter register (or similar low latency, high accuracy clocks) on those targets
4060 that support it.  On X86, it should map to RDTSC.  On Alpha, it should map to RPCC.
4061 As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
4062 should only be used for small timings.
4063 </p>
4064
4065 <h5>Semantics:</h5>
4066
4067 <p>
4068 When directly supported, reading the cycle counter should not modify any memory.
4069 Implementations are allowed to either return a application specific value or a
4070 system wide value.  On backends without support, this is lowered to a constant 0.
4071 </p>
4072
4073 </div>
4074
4075 <!-- ======================================================================= -->
4076 <div class="doc_subsection">
4077   <a name="int_libc">Standard C Library Intrinsics</a>
4078 </div>
4079
4080 <div class="doc_text">
4081 <p>
4082 LLVM provides intrinsics for a few important standard C library functions.
4083 These intrinsics allow source-language front-ends to pass information about the
4084 alignment of the pointer arguments to the code generator, providing opportunity
4085 for more efficient code generation.
4086 </p>
4087
4088 </div>
4089
4090 <!-- _______________________________________________________________________ -->
4091 <div class="doc_subsubsection">
4092   <a name="i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
4093 </div>
4094
4095 <div class="doc_text">
4096
4097 <h5>Syntax:</h5>
4098 <pre>
4099   declare void %llvm.memcpy.i32(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
4100                                 i32 &lt;len&gt;, i32 &lt;align&gt;)
4101   declare void %llvm.memcpy.i64(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
4102                                 i64 &lt;len&gt;, i32 &lt;align&gt;)
4103 </pre>
4104
4105 <h5>Overview:</h5>
4106
4107 <p>
4108 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
4109 location to the destination location.
4110 </p>
4111
4112 <p>
4113 Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
4114 intrinsics do not return a value, and takes an extra alignment argument.
4115 </p>
4116
4117 <h5>Arguments:</h5>
4118
4119 <p>
4120 The first argument is a pointer to the destination, the second is a pointer to
4121 the source.  The third argument is an integer argument
4122 specifying the number of bytes to copy, and the fourth argument is the alignment
4123 of the source and destination locations.
4124 </p>
4125
4126 <p>
4127 If the call to this intrinisic has an alignment value that is not 0 or 1, then
4128 the caller guarantees that both the source and destination pointers are aligned
4129 to that boundary.
4130 </p>
4131
4132 <h5>Semantics:</h5>
4133
4134 <p>
4135 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
4136 location to the destination location, which are not allowed to overlap.  It
4137 copies "len" bytes of memory over.  If the argument is known to be aligned to
4138 some boundary, this can be specified as the fourth argument, otherwise it should
4139 be set to 0 or 1.
4140 </p>
4141 </div>
4142
4143
4144 <!-- _______________________________________________________________________ -->
4145 <div class="doc_subsubsection">
4146   <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
4147 </div>
4148
4149 <div class="doc_text">
4150
4151 <h5>Syntax:</h5>
4152 <pre>
4153   declare void %llvm.memmove.i32(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
4154                                  i32 &lt;len&gt;, i32 &lt;align&gt;)
4155   declare void %llvm.memmove.i64(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
4156                                  i64 &lt;len&gt;, i32 &lt;align&gt;)
4157 </pre>
4158
4159 <h5>Overview:</h5>
4160
4161 <p>
4162 The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the source
4163 location to the destination location. It is similar to the
4164 '<tt>llvm.memcmp</tt>' intrinsic but allows the two memory locations to overlap.
4165 </p>
4166
4167 <p>
4168 Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
4169 intrinsics do not return a value, and takes an extra alignment argument.
4170 </p>
4171
4172 <h5>Arguments:</h5>
4173
4174 <p>
4175 The first argument is a pointer to the destination, the second is a pointer to
4176 the source.  The third argument is an integer argument
4177 specifying the number of bytes to copy, and the fourth argument is the alignment
4178 of the source and destination locations.
4179 </p>
4180
4181 <p>
4182 If the call to this intrinisic has an alignment value that is not 0 or 1, then
4183 the caller guarantees that the source and destination pointers are aligned to
4184 that boundary.
4185 </p>
4186
4187 <h5>Semantics:</h5>
4188
4189 <p>
4190 The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the source
4191 location to the destination location, which may overlap.  It
4192 copies "len" bytes of memory over.  If the argument is known to be aligned to
4193 some boundary, this can be specified as the fourth argument, otherwise it should
4194 be set to 0 or 1.
4195 </p>
4196 </div>
4197
4198
4199 <!-- _______________________________________________________________________ -->
4200 <div class="doc_subsubsection">
4201   <a name="i_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
4202 </div>
4203
4204 <div class="doc_text">
4205
4206 <h5>Syntax:</h5>
4207 <pre>
4208   declare void %llvm.memset.i32(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
4209                                 i32 &lt;len&gt;, i32 &lt;align&gt;)
4210   declare void %llvm.memset.i64(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
4211                                 i64 &lt;len&gt;, i32 &lt;align&gt;)
4212 </pre>
4213
4214 <h5>Overview:</h5>
4215
4216 <p>
4217 The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a particular
4218 byte value.
4219 </p>
4220
4221 <p>
4222 Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
4223 does not return a value, and takes an extra alignment argument.
4224 </p>
4225
4226 <h5>Arguments:</h5>
4227
4228 <p>
4229 The first argument is a pointer to the destination to fill, the second is the
4230 byte value to fill it with, the third argument is an integer
4231 argument specifying the number of bytes to fill, and the fourth argument is the
4232 known alignment of destination location.
4233 </p>
4234
4235 <p>
4236 If the call to this intrinisic has an alignment value that is not 0 or 1, then
4237 the caller guarantees that the destination pointer is aligned to that boundary.
4238 </p>
4239
4240 <h5>Semantics:</h5>
4241
4242 <p>
4243 The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting at
4244 the
4245 destination location.  If the argument is known to be aligned to some boundary,
4246 this can be specified as the fourth argument, otherwise it should be set to 0 or
4247 1.
4248 </p>
4249 </div>
4250
4251
4252 <!-- _______________________________________________________________________ -->
4253 <div class="doc_subsubsection">
4254   <a name="i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
4255 </div>
4256
4257 <div class="doc_text">
4258
4259 <h5>Syntax:</h5>
4260 <pre>
4261   declare float %llvm.sqrt.f32(float %Val)
4262   declare double %llvm.sqrt.f64(double %Val)
4263 </pre>
4264
4265 <h5>Overview:</h5>
4266
4267 <p>
4268 The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
4269 returning the same value as the libm '<tt>sqrt</tt>' function would.  Unlike
4270 <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for
4271 negative numbers (which allows for better optimization).
4272 </p>
4273
4274 <h5>Arguments:</h5>
4275
4276 <p>
4277 The argument and return value are floating point numbers of the same type.
4278 </p>
4279
4280 <h5>Semantics:</h5>
4281
4282 <p>
4283 This function returns the sqrt of the specified operand if it is a positive
4284 floating point number.
4285 </p>
4286 </div>
4287
4288 <!-- _______________________________________________________________________ -->
4289 <div class="doc_subsubsection">
4290   <a name="i_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
4291 </div>
4292
4293 <div class="doc_text">
4294
4295 <h5>Syntax:</h5>
4296 <pre>
4297   declare float  %llvm.powi.f32(float  %Val, i32 %power)
4298   declare double %llvm.powi.f64(double %Val, i32 %power)
4299 </pre>
4300
4301 <h5>Overview:</h5>
4302
4303 <p>
4304 The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
4305 specified (positive or negative) power.  The order of evaluation of
4306 multiplications is not defined.
4307 </p>
4308
4309 <h5>Arguments:</h5>
4310
4311 <p>
4312 The second argument is an integer power, and the first is a value to raise to
4313 that power.
4314 </p>
4315
4316 <h5>Semantics:</h5>
4317
4318 <p>
4319 This function returns the first value raised to the second power with an
4320 unspecified sequence of rounding operations.</p>
4321 </div>
4322
4323
4324 <!-- ======================================================================= -->
4325 <div class="doc_subsection">
4326   <a name="int_manip">Bit Manipulation Intrinsics</a>
4327 </div>
4328
4329 <div class="doc_text">
4330 <p>
4331 LLVM provides intrinsics for a few important bit manipulation operations.
4332 These allow efficient code generation for some algorithms.
4333 </p>
4334
4335 </div>
4336
4337 <!-- _______________________________________________________________________ -->
4338 <div class="doc_subsubsection">
4339   <a name="i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
4340 </div>
4341
4342 <div class="doc_text">
4343
4344 <h5>Syntax:</h5>
4345 <pre>
4346   declare i16 %llvm.bswap.i16(i16 &lt;id&gt;)
4347   declare i32 %llvm.bswap.i32(i32 &lt;id&gt;)
4348   declare i64 %llvm.bswap.i64(i64 &lt;id&gt;)
4349 </pre>
4350
4351 <h5>Overview:</h5>
4352
4353 <p>
4354 The '<tt>llvm.bwsap</tt>' family of intrinsics is used to byteswap a 16, 32 or
4355 64 bit quantity.  These are useful for performing operations on data that is not
4356 in the target's  native byte order.
4357 </p>
4358
4359 <h5>Semantics:</h5>
4360
4361 <p>
4362 The <tt>llvm.bswap.16</tt> intrinsic returns an i16 value that has the high
4363 and low byte of the input i16 swapped.  Similarly, the <tt>llvm.bswap.i32</tt>
4364 intrinsic returns an i32 value that has the four bytes of the input i32
4365 swapped, so that if the input bytes are numbered 0, 1, 2, 3 then the returned
4366 i32 will have its bytes in 3, 2, 1, 0 order.  The <tt>llvm.bswap.i64</tt>
4367 intrinsic extends this concept to 64 bits.
4368 </p>
4369
4370 </div>
4371
4372 <!-- _______________________________________________________________________ -->
4373 <div class="doc_subsubsection">
4374   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
4375 </div>
4376
4377 <div class="doc_text">
4378
4379 <h5>Syntax:</h5>
4380 <pre>
4381   declare i8  %llvm.ctpop.i8 (i8  &lt;src&gt;)
4382   declare i16 %llvm.ctpop.i16(i16 &lt;src&gt;)
4383   declare i32 %llvm.ctpop.i32(i32 &lt;src&gt;)
4384   declare i64 %llvm.ctpop.i64(i64 &lt;src&gt;)
4385 </pre>
4386
4387 <h5>Overview:</h5>
4388
4389 <p>
4390 The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set in a
4391 value.
4392 </p>
4393
4394 <h5>Arguments:</h5>
4395
4396 <p>
4397 The only argument is the value to be counted.  The argument may be of any
4398 integer type.  The return type must match the argument type.
4399 </p>
4400
4401 <h5>Semantics:</h5>
4402
4403 <p>
4404 The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
4405 </p>
4406 </div>
4407
4408 <!-- _______________________________________________________________________ -->
4409 <div class="doc_subsubsection">
4410   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
4411 </div>
4412
4413 <div class="doc_text">
4414
4415 <h5>Syntax:</h5>
4416 <pre>
4417   declare i8  %llvm.ctlz.i8 (i8  &lt;src&gt;)
4418   declare i16 %llvm.ctlz.i16(i16 &lt;src&gt;)
4419   declare i32 %llvm.ctlz.i32(i32 &lt;src&gt;)
4420   declare i64 %llvm.ctlz.i64(i64 &lt;src&gt;)
4421 </pre>
4422
4423 <h5>Overview:</h5>
4424
4425 <p>
4426 The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
4427 leading zeros in a variable.
4428 </p>
4429
4430 <h5>Arguments:</h5>
4431
4432 <p>
4433 The only argument is the value to be counted.  The argument may be of any
4434 integer type. The return type must match the argument type.
4435 </p>
4436
4437 <h5>Semantics:</h5>
4438
4439 <p>
4440 The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros
4441 in a variable.  If the src == 0 then the result is the size in bits of the type
4442 of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.
4443 </p>
4444 </div>
4445
4446
4447
4448 <!-- _______________________________________________________________________ -->
4449 <div class="doc_subsubsection">
4450   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
4451 </div>
4452
4453 <div class="doc_text">
4454
4455 <h5>Syntax:</h5>
4456 <pre>
4457   declare i8  %llvm.cttz.i8 (i8  &lt;src&gt;)
4458   declare i16 %llvm.cttz.i16(i16 &lt;src&gt;)
4459   declare i32 %llvm.cttz.i32(i32 &lt;src&gt;)
4460   declare i64 %llvm.cttz.i64(i64 &lt;src&gt;)
4461 </pre>
4462
4463 <h5>Overview:</h5>
4464
4465 <p>
4466 The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
4467 trailing zeros.
4468 </p>
4469
4470 <h5>Arguments:</h5>
4471
4472 <p>
4473 The only argument is the value to be counted.  The argument may be of any
4474 integer type.  The return type must match the argument type.
4475 </p>
4476
4477 <h5>Semantics:</h5>
4478
4479 <p>
4480 The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros
4481 in a variable.  If the src == 0 then the result is the size in bits of the type
4482 of src.  For example, <tt>llvm.cttz(2) = 1</tt>.
4483 </p>
4484 </div>
4485
4486 <!-- ======================================================================= -->
4487 <div class="doc_subsection">
4488   <a name="int_debugger">Debugger Intrinsics</a>
4489 </div>
4490
4491 <div class="doc_text">
4492 <p>
4493 The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
4494 are described in the <a
4495 href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
4496 Debugging</a> document.
4497 </p>
4498 </div>
4499
4500
4501 <!-- *********************************************************************** -->
4502 <hr>
4503 <address>
4504   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
4505   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
4506   <a href="http://validator.w3.org/check/referer"><img
4507   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
4508
4509   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
4510   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
4511   Last modified: $Date$
4512 </address>
4513 </body>
4514 </html>