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