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