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