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="#globalvars">Global Variables</a></li>
  25       <li><a href="#functionstructure">Function Structure</a></li>
  26     </ol>
  27   </li>
  28   <li><a href="#typesystem">Type System</a>
  29     <ol>
  30       <li><a href="#t_primitive">Primitive Types</a>
  31         <ol>
  32           <li><a href="#t_classifications">Type Classifications</a></li>
  33         </ol>
  34       </li>
  35       <li><a href="#t_derived">Derived Types</a>
  36         <ol>
  37           <li><a href="#t_array">Array Type</a></li>
  38           <li><a href="#t_function">Function Type</a></li>
  39           <li><a href="#t_pointer">Pointer Type</a></li>
  40           <li><a href="#t_struct">Structure Type</a></li>
  41           <li><a href="#t_packed">Packed Type</a></li>
  42           <li><a href="#t_opaque">Opaque Type</a></li>
  43         </ol>
  44       </li>
  45     </ol>
  46   </li>
  47   <li><a href="#constants">Constants</a>
  48     <ol>
  49       <li><a href="#simpleconstants">Simple Constants</a>
  50       <li><a href="#aggregateconstants">Aggregate Constants</a>
  51       <li><a href="#globalconstants">Global Variable and Function Addresses</a>
  52       <li><a href="#undefvalues">Undefined Values</a>
  53       <li><a href="#constantexprs">Constant Expressions</a>
  54     </ol>
  55   </li>
  56   <li><a href="#instref">Instruction Reference</a>
  57     <ol>
  58       <li><a href="#terminators">Terminator Instructions</a>
  59         <ol>
  60           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
  61           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
  62           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
  63           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
  64           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
  65           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
  66         </ol>
  67       </li>
  68       <li><a href="#binaryops">Binary Operations</a>
  69         <ol>
  70           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
  71           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
  72           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
  73           <li><a href="#i_div">'<tt>div</tt>' Instruction</a></li>
  74           <li><a href="#i_rem">'<tt>rem</tt>' Instruction</a></li>
  75           <li><a href="#i_setcc">'<tt>set<i>cc</i></tt>' Instructions</a></li>
  76         </ol>
  77       </li>
  78       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
  79         <ol>
  80           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
  81           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
  82           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
  83           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
  84           <li><a href="#i_shr">'<tt>shr</tt>' Instruction</a></li>
  85         </ol>
  86       </li>
  87       <li><a href="#memoryops">Memory Access Operations</a>
  88         <ol>
  89           <li><a href="#i_malloc">'<tt>malloc</tt>'   Instruction</a></li>
  90           <li><a href="#i_free">'<tt>free</tt>'     Instruction</a></li>
  91           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
  92          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
  93          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
  94          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
  95         </ol>
  96       </li>
  97       <li><a href="#otherops">Other Operations</a>
  98         <ol>
  99           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 100           <li><a href="#i_cast">'<tt>cast .. to</tt>' Instruction</a></li>
 101           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 102           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 103           <li><a href="#i_vanext">'<tt>vanext</tt>' Instruction</a></li>
 104           <li><a href="#i_vaarg">'<tt>vaarg</tt>'  Instruction</a></li>
 105         </ol>
 106       </li>
 107     </ol>
 108   </li>
 109   <li><a href="#intrinsics">Intrinsic Functions</a>
 110     <ol>
 111       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 112         <ol>
 113           <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 114           <li><a href="#i_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 115           <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 116         </ol>
 117       </li>
 118       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 119         <ol>
 120           <li><a href="#i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 121           <li><a href="#i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 122           <li><a href="#i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 123         </ol>
 124       </li>
 125       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 126         <ol>
 127           <li><a href="#i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 128           <li><a href="#i_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 129           <li><a href="#i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 130           <li><a href="#i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 131         </ol>
 132       </li>
 133       <li><a href="#int_os">Operating System Intrinsics</a>
 134         <ol>
 135           <li><a href="#i_readport">'<tt>llvm.readport</tt>' Intrinsic</a></li>
 136           <li><a href="#i_writeport">'<tt>llvm.writeport</tt>' Intrinsic</a></li>
 137           <li><a href="#i_readio">'<tt>llvm.readio</tt>'   Intrinsic</a></li>
 138           <li><a href="#i_writeio">'<tt>llvm.writeio</tt>'   Intrinsic</a></li>
 139         </ol>
 140       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 141         <ol>
 142           <li><a href="#i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a></li>
 143           <li><a href="#i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a></li>
 144           <li><a href="#i_memset">'<tt>llvm.memset</tt>' Intrinsic</a></li>
 145           <li><a href="#i_isunordered">'<tt>llvm.isunordered</tt>' Intrinsic</a></li>
 146         </ol>
 147       </li>
 148       <li><a href="#int_count">Bit counting Intrinsics</a>
 149         <ol>
 150           <li><a href="#int_ctpop">'<tt>llvm.ctpop</tt>' Intrinsic </a></li>
 151           <li><a href="#int_cttz">'<tt>llvm.cttz</tt>' Intrinsic </a></li>
 152           <li><a href="#int_ctlz">'<tt>llvm.ctlz</tt>' Intrinsic </a></li>
 153         </ol>
 154       </li>
 155       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 156     </ol>
 157   </li>
 158 </ol>
 159
 160 <div class="doc_author">
 161   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 162             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 163 </div>
 164
 165 <!-- *********************************************************************** -->
 166 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 167 <!-- *********************************************************************** -->
 168
 169 <div class="doc_text">
 170 <p>This document is a reference manual for the LLVM assembly language.
 171 LLVM is an SSA based representation that provides type safety,
 172 low-level operations, flexibility, and the capability of representing
 173 'all' high-level languages cleanly.  It is the common code
 174 representation used throughout all phases of the LLVM compilation
 175 strategy.</p>
 176 </div>
 177
 178 <!-- *********************************************************************** -->
 179 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 180 <!-- *********************************************************************** -->
 181
 182 <div class="doc_text">
 183
 184 <p>The LLVM code representation is designed to be used in three
 185 different forms: as an in-memory compiler IR, as an on-disk bytecode
 186 representation (suitable for fast loading by a Just-In-Time compiler),
 187 and as a human readable assembly language representation.  This allows
 188 LLVM to provide a powerful intermediate representation for efficient
 189 compiler transformations and analysis, while providing a natural means
 190 to debug and visualize the transformations.  The three different forms
 191 of LLVM are all equivalent.  This document describes the human readable
 192 representation and notation.</p>
 193
 194 <p>The LLVM representation aims to be a light-weight and low-level
 195 while being expressive, typed, and extensible at the same time.  It
 196 aims to be a "universal IR" of sorts, by being at a low enough level
 197 that high-level ideas may be cleanly mapped to it (similar to how
 198 microprocessors are "universal IR's", allowing many source languages to
 199 be mapped to them).  By providing type information, LLVM can be used as
 200 the target of optimizations: for example, through pointer analysis, it
 201 can be proven that a C automatic variable is never accessed outside of
 202 the current function... allowing it to be promoted to a simple SSA
 203 value instead of a memory location.</p>
 204
 205 </div>
 206
 207 <!-- _______________________________________________________________________ -->
 208 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 209
 210 <div class="doc_text">
 211
 212 <p>It is important to note that this document describes 'well formed'
 213 LLVM assembly language.  There is a difference between what the parser
 214 accepts and what is considered 'well formed'.  For example, the
 215 following instruction is syntactically okay, but not well formed:</p>
 216
 217 <pre>
 218   %x = <a href="#i_add">add</a> int 1, %x
 219 </pre>
 220
 221 <p>...because the definition of <tt>%x</tt> does not dominate all of
 222 its uses. The LLVM infrastructure provides a verification pass that may
 223 be used to verify that an LLVM module is well formed.  This pass is
 224 automatically run by the parser after parsing input assembly, and by
 225 the optimizer before it outputs bytecode.  The violations pointed out
 226 by the verifier pass indicate bugs in transformation passes or input to
 227 the parser.</p>
 228
 229 <!-- Describe the typesetting conventions here. --> </div>
 230
 231 <!-- *********************************************************************** -->
 232 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 233 <!-- *********************************************************************** -->
 234
 235 <div class="doc_text">
 236
 237 <p>LLVM uses three different forms of identifiers, for different
 238 purposes:</p>
 239
 240 <ol>
 241   <li>Named values are represented as a string of characters with a '%' prefix.
 242   For example, %foo, %DivisionByZero, %a.really.long.identifier.  The actual
 243   regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
 244   Identifiers which require other characters in their names can be surrounded
 245   with quotes.  In this way, anything except a <tt>"</tt> character can be used
 246   in a name.</li>
 247
 248   <li>Unnamed values are represented as an unsigned numeric value with a '%'
 249   prefix.  For example, %12, %2, %44.</li>
 250
 251   <li>Constants, which are described in a <a href="#constants">section about
 252   constants</a>, below.</li>
 253 </ol>
 254
 255 <p>LLVM requires that values start with a '%' sign for two reasons: Compilers
 256 don't need to worry about name clashes with reserved words, and the set of
 257 reserved words may be expanded in the future without penalty.  Additionally,
 258 unnamed identifiers allow a compiler to quickly come up with a temporary
 259 variable without having to avoid symbol table conflicts.</p>
 260
 261 <p>Reserved words in LLVM are very similar to reserved words in other
 262 languages. There are keywords for different opcodes ('<tt><a
 263 href="#i_add">add</a></tt>', '<tt><a href="#i_cast">cast</a></tt>', '<tt><a
 264 href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
 265 href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>', etc...),
 266 and others.  These reserved words cannot conflict with variable names, because
 267 none of them start with a '%' character.</p>
 268
 269 <p>Here is an example of LLVM code to multiply the integer variable
 270 '<tt>%X</tt>' by 8:</p>
 271
 272 <p>The easy way:</p>
 273
 274 <pre>
 275   %result = <a href="#i_mul">mul</a> uint %X, 8
 276 </pre>
 277
 278 <p>After strength reduction:</p>
 279
 280 <pre>
 281   %result = <a href="#i_shl">shl</a> uint %X, ubyte 3
 282 </pre>
 283
 284 <p>And the hard way:</p>
 285
 286 <pre>
 287   <a href="#i_add">add</a> uint %X, %X           <i>; yields {uint}:%0</i>
 288   <a href="#i_add">add</a> uint %0, %0           <i>; yields {uint}:%1</i>
 289   %result = <a href="#i_add">add</a> uint %1, %1
 290 </pre>
 291
 292 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
 293 important lexical features of LLVM:</p>
 294
 295 <ol>
 296
 297   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 298   line.</li>
 299
 300   <li>Unnamed temporaries are created when the result of a computation is not
 301   assigned to a named value.</li>
 302
 303   <li>Unnamed temporaries are numbered sequentially</li>
 304
 305 </ol>
 306
 307 <p>...and it also show a convention that we follow in this document.  When
 308 demonstrating instructions, we will follow an instruction with a comment that
 309 defines the type and name of value produced.  Comments are shown in italic
 310 text.</p>
 311
 312 </div>
 313
 314 <!-- *********************************************************************** -->
 315 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 316 <!-- *********************************************************************** -->
 317
 318 <!-- ======================================================================= -->
 319 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 320 </div>
 321
 322 <div class="doc_text">
 323
 324 <p>LLVM programs are composed of "Module"s, each of which is a
 325 translation unit of the input programs.  Each module consists of
 326 functions, global variables, and symbol table entries.  Modules may be
 327 combined together with the LLVM linker, which merges function (and
 328 global variable) definitions, resolves forward declarations, and merges
 329 symbol table entries. Here is an example of the "hello world" module:</p>
 330
 331 <pre><i>; Declare the string constant as a global constant...</i>
 332 <a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a
 333  href="#globalvars">constant</a> <a href="#t_array">[13 x sbyte]</a> c"hello world\0A\00"          <i>; [13 x sbyte]*</i>
 334
 335 <i>; External declaration of the puts function</i>
 336 <a href="#functionstructure">declare</a> int %puts(sbyte*)                                            <i>; int(sbyte*)* </i>
 337
 338 <i>; Definition of main function</i>
 339 int %main() {                                                        <i>; int()* </i>
 340         <i>; Convert [13x sbyte]* to sbyte *...</i>
 341         %cast210 = <a
 342  href="#i_getelementptr">getelementptr</a> [13 x sbyte]* %.LC0, long 0, long 0 <i>; sbyte*</i>
 343
 344         <i>; Call puts function to write out the string to stdout...</i>
 345         <a
 346  href="#i_call">call</a> int %puts(sbyte* %cast210)                              <i>; int</i>
 347         <a
 348  href="#i_ret">ret</a> int 0<br>}<br></pre>
 349
 350 <p>This example is made up of a <a href="#globalvars">global variable</a>
 351 named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
 352 function, and a <a href="#functionstructure">function definition</a>
 353 for "<tt>main</tt>".</p>
 354
 355 <p>In general, a module is made up of a list of global values,
 356 where both functions and global variables are global values.  Global values are
 357 represented by a pointer to a memory location (in this case, a pointer to an
 358 array of char, and a pointer to a function), and have one of the following <a
 359 href="#linkage">linkage types</a>.</p>
 360
 361 </div>
 362
 363 <!-- ======================================================================= -->
 364 <div class="doc_subsection">
 365   <a name="linkage">Linkage Types</a>
 366 </div>
 367
 368 <div class="doc_text">
 369
 370 <p>
 371 All Global Variables and Functions have one of the following types of linkage:
 372 </p>
 373
 374 <dl>
 375
 376   <dt><tt><b><a name="linkage_internal">internal</a></b></tt> </dt>
 377
 378   <dd>Global values with internal linkage are only directly accessible by
 379   objects in the current module.  In particular, linking code into a module with
 380   an internal global value may cause the internal to be renamed as necessary to
 381   avoid collisions.  Because the symbol is internal to the module, all
 382   references can be updated.  This corresponds to the notion of the
 383   '<tt>static</tt>' keyword in C, or the idea of "anonymous namespaces" in C++.
 384   </dd>
 385
 386   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
 387
 388   <dd>"<tt>linkonce</tt>" linkage is similar to <tt>internal</tt> linkage, with
 389   the twist that linking together two modules defining the same
 390   <tt>linkonce</tt> globals will cause one of the globals to be discarded.  This
 391   is typically used to implement inline functions.  Unreferenced
 392   <tt>linkonce</tt> globals are allowed to be discarded.
 393   </dd>
 394
 395   <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
 396
 397   <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt> linkage,
 398   except that unreferenced <tt>weak</tt> globals may not be discarded.  This is
 399   used to implement constructs in C such as "<tt>int X;</tt>" at global scope.
 400   </dd>
 401
 402   <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
 403
 404   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 405   pointer to array type.  When two global variables with appending linkage are
 406   linked together, the two global arrays are appended together.  This is the
 407   LLVM, typesafe, equivalent of having the system linker append together
 408   "sections" with identical names when .o files are linked.
 409   </dd>
 410
 411   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 412
 413   <dd>If none of the above identifiers are used, the global is externally
 414   visible, meaning that it participates in linkage and can be used to resolve
 415   external symbol references.
 416   </dd>
 417 </dl>
 418
 419 <p><a name="linkage_external">For example, since the "<tt>.LC0</tt>"
 420 variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
 421 variable and was linked with this one, one of the two would be renamed,
 422 preventing a collision.  Since "<tt>main</tt>" and "<tt>puts</tt>" are
 423 external (i.e., lacking any linkage declarations), they are accessible
 424 outside of the current module.  It is illegal for a function <i>declaration</i>
 425 to have any linkage type other than "externally visible".</a></p>
 426
 427 </div>
 428
 429 <!-- ======================================================================= -->
 430 <div class="doc_subsection">
 431   <a name="globalvars">Global Variables</a>
 432 </div>
 433
 434 <div class="doc_text">
 435
 436 <p>Global variables define regions of memory allocated at compilation time
 437 instead of run-time.  Global variables may optionally be initialized.  A
 438 variable may be defined as a global "constant", which indicates that the
 439 contents of the variable will <b>never</b> be modified (enabling better
 440 optimization, allowing the global data to be placed in the read-only section of
 441 an executable, etc).  Note that variables that need runtime initialization
 442 cannot be marked "constant", as there is a store to the variable.</p>
 443
 444 <p>
 445 LLVM explicitly allows <em>declarations</em> of global variables to be marked
 446 constant, even if the final definition of the global is not.  This capability
 447 can be used to enable slightly better optimization of the program, but requires
 448 the language definition to guarantee that optimizations based on the
 449 'constantness' are valid for the translation units that do not include the
 450 definition.
 451 </p>
 452
 453 <p>As SSA values, global variables define pointer values that are in
 454 scope (i.e. they dominate) all basic blocks in the program.  Global
 455 variables always define a pointer to their "content" type because they
 456 describe a region of memory, and all memory objects in LLVM are
 457 accessed through pointers.</p>
 458
 459 </div>
 460
 461
 462 <!-- ======================================================================= -->
 463 <div class="doc_subsection">
 464   <a name="functionstructure">Functions</a>
 465 </div>
 466
 467 <div class="doc_text">
 468
 469 <p>LLVM function definitions are composed of a (possibly empty) argument list,
 470 an opening curly brace, a list of basic blocks, and a closing curly brace.  LLVM
 471 function declarations are defined with the "<tt>declare</tt>" keyword, a
 472 function name, and a function signature.</p>
 473
 474 <p>A function definition contains a list of basic blocks, forming the CFG for
 475 the function.  Each basic block may optionally start with a label (giving the
 476 basic block a symbol table entry), contains a list of instructions, and ends
 477 with a <a href="#terminators">terminator</a> instruction (such as a branch or
 478 function return).</p>
 479
 480 <p>The first basic block in program is special in two ways: it is immediately
 481 executed on entrance to the function, and it is not allowed to have predecessor
 482 basic blocks (i.e. there can not be any branches to the entry block of a
 483 function).  Because the block can have no predecessors, it also cannot have any
 484 <a href="#i_phi">PHI nodes</a>.</p>
 485
 486 <p>LLVM functions are identified by their name and type signature.  Hence, two
 487 functions with the same name but different parameter lists or return values are
 488 considered different functions, and LLVM will resolve references to each
 489 appropriately.</p>
 490
 491 </div>
 492
 493
 494
 495 <!-- *********************************************************************** -->
 496 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
 497 <!-- *********************************************************************** -->
 498
 499 <div class="doc_text">
 500
 501 <p>The LLVM type system is one of the most important features of the
 502 intermediate representation.  Being typed enables a number of
 503 optimizations to be performed on the IR directly, without having to do
 504 extra analyses on the side before the transformation.  A strong type
 505 system makes it easier to read the generated code and enables novel
 506 analyses and transformations that are not feasible to perform on normal
 507 three address code representations.</p>
 508
 509 </div>
 510
 511 <!-- ======================================================================= -->
 512 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
 513 <div class="doc_text">
 514 <p>The primitive types are the fundamental building blocks of the LLVM
 515 system. The current set of primitive types is as follows:</p>
 516
 517 <table class="layout">
 518   <tr class="layout">
 519     <td class="left">
 520       <table>
 521         <tbody>
 522         <tr><th>Type</th><th>Description</th></tr>
 523         <tr><td><tt>void</tt></td><td>No value</td></tr>
 524         <tr><td><tt>ubyte</tt></td><td>Unsigned 8-bit value</td></tr>
 525         <tr><td><tt>ushort</tt></td><td>Unsigned 16-bit value</td></tr>
 526         <tr><td><tt>uint</tt></td><td>Unsigned 32-bit value</td></tr>
 527         <tr><td><tt>ulong</tt></td><td>Unsigned 64-bit value</td></tr>
 528         <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
 529         <tr><td><tt>label</tt></td><td>Branch destination</td></tr>
 530         </tbody>
 531       </table>
 532     </td>
 533     <td class="right">
 534       <table>
 535         <tbody>
 536           <tr><th>Type</th><th>Description</th></tr>
 537           <tr><td><tt>bool</tt></td><td>True or False value</td></tr>
 538           <tr><td><tt>sbyte</tt></td><td>Signed 8-bit value</td></tr>
 539           <tr><td><tt>short</tt></td><td>Signed 16-bit value</td></tr>
 540           <tr><td><tt>int</tt></td><td>Signed 32-bit value</td></tr>
 541           <tr><td><tt>long</tt></td><td>Signed 64-bit value</td></tr>
 542           <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
 543         </tbody>
 544       </table>
 545     </td>
 546   </tr>
 547 </table>
 548 </div>
 549
 550 <!-- _______________________________________________________________________ -->
 551 <div class="doc_subsubsection"> <a name="t_classifications">Type
 552 Classifications</a> </div>
 553 <div class="doc_text">
 554 <p>These different primitive types fall into a few useful
 555 classifications:</p>
 556
 557 <table border="1" cellspacing="0" cellpadding="4">
 558   <tbody>
 559     <tr><th>Classification</th><th>Types</th></tr>
 560     <tr>
 561       <td><a name="t_signed">signed</a></td>
 562       <td><tt>sbyte, short, int, long, float, double</tt></td>
 563     </tr>
 564     <tr>
 565       <td><a name="t_unsigned">unsigned</a></td>
 566       <td><tt>ubyte, ushort, uint, ulong</tt></td>
 567     </tr>
 568     <tr>
 569       <td><a name="t_integer">integer</a></td>
 570       <td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td>
 571     </tr>
 572     <tr>
 573       <td><a name="t_integral">integral</a></td>
 574       <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long</tt>
 575       </td>
 576     </tr>
 577     <tr>
 578       <td><a name="t_floating">floating point</a></td>
 579       <td><tt>float, double</tt></td>
 580     </tr>
 581     <tr>
 582       <td><a name="t_firstclass">first class</a></td>
 583       <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long,<br>
 584       float, double, <a href="#t_pointer">pointer</a>,
 585       <a href="#t_packed">packed</a></tt></td>
 586     </tr>
 587   </tbody>
 588 </table>
 589
 590 <p>The <a href="#t_firstclass">first class</a> types are perhaps the
 591 most important.  Values of these types are the only ones which can be
 592 produced by instructions, passed as arguments, or used as operands to
 593 instructions.  This means that all structures and arrays must be
 594 manipulated either by pointer or by component.</p>
 595 </div>
 596
 597 <!-- ======================================================================= -->
 598 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
 599
 600 <div class="doc_text">
 601
 602 <p>The real power in LLVM comes from the derived types in the system.
 603 This is what allows a programmer to represent arrays, functions,
 604 pointers, and other useful types.  Note that these derived types may be
 605 recursive: For example, it is possible to have a two dimensional array.</p>
 606
 607 </div>
 608
 609 <!-- _______________________________________________________________________ -->
 610 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
 611
 612 <div class="doc_text">
 613
 614 <h5>Overview:</h5>
 615
 616 <p>The array type is a very simple derived type that arranges elements
 617 sequentially in memory.  The array type requires a size (number of
 618 elements) and an underlying data type.</p>
 619
 620 <h5>Syntax:</h5>
 621
 622 <pre>
 623   [&lt;# elements&gt; x &lt;elementtype&gt;]
 624 </pre>
 625
 626 <p>The number of elements is a constant integer value, elementtype may
 627 be any type with a size.</p>
 628
 629 <h5>Examples:</h5>
 630 <table class="layout">
 631   <tr class="layout">
 632     <td class="left">
 633       <tt>[40 x int ]</tt><br/>
 634       <tt>[41 x int ]</tt><br/>
 635       <tt>[40 x uint]</tt><br/>
 636     </td>
 637     <td class="left">
 638       Array of 40 integer values.<br/>
 639       Array of 41 integer values.<br/>
 640       Array of 40 unsigned integer values.<br/>
 641     </td>
 642   </tr>
 643 </table>
 644 <p>Here are some examples of multidimensional arrays:</p>
 645 <table class="layout">
 646   <tr class="layout">
 647     <td class="left">
 648       <tt>[3 x [4 x int]]</tt><br/>
 649       <tt>[12 x [10 x float]]</tt><br/>
 650       <tt>[2 x [3 x [4 x uint]]]</tt><br/>
 651     </td>
 652     <td class="left">
 653       3x4 array integer values.<br/>
 654       12x10 array of single precision floating point values.<br/>
 655       2x3x4 array of unsigned integer values.<br/>
 656     </td>
 657   </tr>
 658 </table>
 659 </div>
 660
 661 <!-- _______________________________________________________________________ -->
 662 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
 663 <div class="doc_text">
 664 <h5>Overview:</h5>
 665 <p>The function type can be thought of as a function signature.  It
 666 consists of a return type and a list of formal parameter types.
 667 Function types are usually used to build virtual function tables
 668 (which are structures of pointers to functions), for indirect function
 669 calls, and when defining a function.</p>
 670 <p>
 671 The return type of a function type cannot be an aggregate type.
 672 </p>
 673 <h5>Syntax:</h5>
 674 <pre>  &lt;returntype&gt; (&lt;parameter list&gt;)<br></pre>
 675 <p>Where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
 676 specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
 677 which indicates that the function takes a variable number of arguments.
 678 Variable argument functions can access their arguments with the <a
 679  href="#int_varargs">variable argument handling intrinsic</a> functions.</p>
 680 <h5>Examples:</h5>
 681 <table class="layout">
 682   <tr class="layout">
 683     <td class="left">
 684       <tt>int (int)</tt> <br/>
 685       <tt>float (int, int *) *</tt><br/>
 686       <tt>int (sbyte *, ...)</tt><br/>
 687     </td>
 688     <td class="left">
 689       function taking an <tt>int</tt>, returning an <tt>int</tt><br/>
 690       <a href="#t_pointer">Pointer</a> to a function that takes an
 691       <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>,
 692       returning <tt>float</tt>.<br/>
 693       A vararg function that takes at least one <a href="#t_pointer">pointer</a>
 694       to <tt>sbyte</tt> (signed char in C), which returns an integer.  This is
 695       the signature for <tt>printf</tt> in LLVM.<br/>
 696     </td>
 697   </tr>
 698 </table>
 699
 700 </div>
 701 <!-- _______________________________________________________________________ -->
 702 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
 703 <div class="doc_text">
 704 <h5>Overview:</h5>
 705 <p>The structure type is used to represent a collection of data members
 706 together in memory.  The packing of the field types is defined to match
 707 the ABI of the underlying processor.  The elements of a structure may
 708 be any type that has a size.</p>
 709 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
 710 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
 711 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
 712 instruction.</p>
 713 <h5>Syntax:</h5>
 714 <pre>  { &lt;type list&gt; }<br></pre>
 715 <h5>Examples:</h5>
 716 <table class="layout">
 717   <tr class="layout">
 718     <td class="left">
 719       <tt>{ int, int, int }</tt><br/>
 720       <tt>{ float, int (int) * }</tt><br/>
 721     </td>
 722     <td class="left">
 723       a triple of three <tt>int</tt> values<br/>
 724       A pair, where the first element is a <tt>float</tt> and the second element
 725       is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a>
 726       that takes an <tt>int</tt>, returning an <tt>int</tt>.<br/>
 727     </td>
 728   </tr>
 729 </table>
 730 </div>
 731
 732 <!-- _______________________________________________________________________ -->
 733 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
 734 <div class="doc_text">
 735 <h5>Overview:</h5>
 736 <p>As in many languages, the pointer type represents a pointer or
 737 reference to another object, which must live in memory.</p>
 738 <h5>Syntax:</h5>
 739 <pre>  &lt;type&gt; *<br></pre>
 740 <h5>Examples:</h5>
 741 <table class="layout">
 742   <tr class="layout">
 743     <td class="left">
 744       <tt>[4x int]*</tt><br/>
 745       <tt>int (int *) *</tt><br/>
 746     </td>
 747     <td class="left">
 748       A <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a> of
 749       four <tt>int</tt> values<br/>
 750       A <a href="#t_pointer">pointer</a> to a <a
 751       href="#t_function">function</a> that takes an <tt>int*</tt>, returning an
 752       <tt>int</tt>.<br/>
 753     </td>
 754   </tr>
 755 </table>
 756 </div>
 757
 758 <!-- _______________________________________________________________________ -->
 759 <div class="doc_subsubsection"> <a name="t_packed">Packed Type</a> </div>
 760 <div class="doc_text">
 761
 762 <h5>Overview:</h5>
 763
 764 <p>A packed type is a simple derived type that represents a vector
 765 of elements.  Packed types are used when multiple primitive data
 766 are operated in parallel using a single instruction (SIMD).
 767 A packed type requires a size (number of
 768 elements) and an underlying primitive data type.  Packed types are
 769 considered <a href="#t_firstclass">first class</a>.</p>
 770
 771 <h5>Syntax:</h5>
 772
 773 <pre>
 774   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
 775 </pre>
 776
 777 <p>The number of elements is a constant integer value, elementtype may
 778 be any integral or floating point type.</p>
 779
 780 <h5>Examples:</h5>
 781
 782 <table class="layout">
 783   <tr class="layout">
 784     <td class="left">
 785       <tt>&lt;4 x int&gt;</tt><br/>
 786       <tt>&lt;8 x float&gt;</tt><br/>
 787       <tt>&lt;2 x uint&gt;</tt><br/>
 788     </td>
 789     <td class="left">
 790       Packed vector of 4 integer values.<br/>
 791       Packed vector of 8 floating-point values.<br/>
 792       Packed vector of 2 unsigned integer values.<br/>
 793     </td>
 794   </tr>
 795 </table>
 796 </div>
 797
 798 <!-- _______________________________________________________________________ -->
 799 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
 800 <div class="doc_text">
 801
 802 <h5>Overview:</h5>
 803
 804 <p>Opaque types are used to represent unknown types in the system.  This
 805 corresponds (for example) to the C notion of a foward declared structure type.
 806 In LLVM, opaque types can eventually be resolved to any type (not just a
 807 structure type).</p>
 808
 809 <h5>Syntax:</h5>
 810
 811 <pre>
 812   opaque
 813 </pre>
 814
 815 <h5>Examples:</h5>
 816
 817 <table class="layout">
 818   <tr class="layout">
 819     <td class="left">
 820       <tt>opaque</tt>
 821     </td>
 822     <td class="left">
 823       An opaque type.<br/>
 824     </td>
 825   </tr>
 826 </table>
 827 </div>
 828
 829
 830 <!-- *********************************************************************** -->
 831 <div class="doc_section"> <a name="constants">Constants</a> </div>
 832 <!-- *********************************************************************** -->
 833
 834 <div class="doc_text">
 835
 836 <p>LLVM has several different basic types of constants.  This section describes
 837 them all and their syntax.</p>
 838
 839 </div>
 840
 841 <!-- ======================================================================= -->
 842 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
 843
 844 <div class="doc_text">
 845
 846 <dl>
 847   <dt><b>Boolean constants</b></dt>
 848
 849   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
 850   constants of the <tt><a href="#t_primitive">bool</a></tt> type.
 851   </dd>
 852
 853   <dt><b>Integer constants</b></dt>
 854
 855   <dd>Standard integers (such as '4') are constants of the <a
 856   href="#t_integer">integer</a> type.  Negative numbers may be used with signed
 857   integer types.
 858   </dd>
 859
 860   <dt><b>Floating point constants</b></dt>
 861
 862   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
 863   exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
 864   notation.  Floating point constants have an optional hexadecimal
 865   notation (see below).  Floating point constants must have a <a
 866   href="#t_floating">floating point</a> type. </dd>
 867
 868   <dt><b>Null pointer constants</b></dt>
 869
 870   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
 871   and must be of <a href="#t_pointer">pointer type</a>.</dd>
 872
 873 </dl>
 874
 875 <p>The one non-intuitive notation for constants is the optional hexadecimal form
 876 of floating point constants.  For example, the form '<tt>double
 877 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
 878 4.5e+15</tt>'.  The only time hexadecimal floating point constants are required
 879 (and the only time that they are generated by the disassembler) is when a
 880 floating point constant must be emitted but it cannot be represented as a
 881 decimal floating point number.  For example, NaN's, infinities, and other
 882 special values are represented in their IEEE hexadecimal format so that
 883 assembly and disassembly do not cause any bits to change in the constants.</p>
 884
 885 </div>
 886
 887 <!-- ======================================================================= -->
 888 <div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a>
 889 </div>
 890
 891 <div class="doc_text">
 892 <p>Aggregate constants arise from aggregation of simple constants
 893 and smaller aggregate constants.</p>
 894
 895 <dl>
 896   <dt><b>Structure constants</b></dt>
 897
 898   <dd>Structure constants are represented with notation similar to structure
 899   type definitions (a comma separated list of elements, surrounded by braces
 900   (<tt>{}</tt>)).  For example: "<tt>{ int 4, float 17.0, int* %G }</tt>",
 901   where "<tt>%G</tt>" is declared as "<tt>%G = external global int</tt>".  Structure constants
 902   must have <a href="#t_struct">structure type</a>, and the number and
 903   types of elements must match those specified by the type.
 904   </dd>
 905
 906   <dt><b>Array constants</b></dt>
 907
 908   <dd>Array constants are represented with notation similar to array type
 909   definitions (a comma separated list of elements, surrounded by square brackets
 910   (<tt>[]</tt>)).  For example: "<tt>[ int 42, int 11, int 74 ]</tt>".  Array
 911   constants must have <a href="#t_array">array type</a>, and the number and
 912   types of elements must match those specified by the type.
 913   </dd>
 914
 915   <dt><b>Packed constants</b></dt>
 916
 917   <dd>Packed constants are represented with notation similar to packed type
 918   definitions (a comma separated list of elements, surrounded by
 919   less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; int 42,
 920   int 11, int 74, int 100 &gt;</tt>".  Packed constants must have <a
 921   href="#t_packed">packed type</a>, and the number and types of elements must
 922   match those specified by the type.
 923   </dd>
 924
 925   <dt><b>Zero initialization</b></dt>
 926
 927   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
 928   value to zero of <em>any</em> type, including scalar and aggregate types.
 929   This is often used to avoid having to print large zero initializers (e.g. for
 930   large arrays), and is always exactly equivalent to using explicit zero
 931   initializers.
 932   </dd>
 933 </dl>
 934
 935 </div>
 936
 937 <!-- ======================================================================= -->
 938 <div class="doc_subsection">
 939   <a name="globalconstants">Global Variable and Function Addresses</a>
 940 </div>
 941
 942 <div class="doc_text">
 943
 944 <p>The addresses of <a href="#globalvars">global variables</a> and <a
 945 href="#functionstructure">functions</a> are always implicitly valid (link-time)
 946 constants.  These constants are explicitly referenced when the <a
 947 href="#identifiers">identifier for the global</a> is used and always have <a
 948 href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
 949 file:</p>
 950
 951 <pre>
 952   %X = global int 17
 953   %Y = global int 42
 954   %Z = global [2 x int*] [ int* %X, int* %Y ]
 955 </pre>
 956
 957 </div>
 958
 959 <!-- ======================================================================= -->
 960 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
 961 <div class="doc_text">
 962   <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
 963   no specific value.  Undefined values may be of any type, and be used anywhere
 964   a constant is permitted.</p>
 965
 966   <p>Undefined values indicate to the compiler that the program is well defined
 967   no matter what value is used, giving the compiler more freedom to optimize.
 968   </p>
 969 </div>
 970
 971 <!-- ======================================================================= -->
 972 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
 973 </div>
 974
 975 <div class="doc_text">
 976
 977 <p>Constant expressions are used to allow expressions involving other constants
 978 to be used as constants.  Constant expressions may be of any <a
 979 href="#t_firstclass">first class</a> type, and may involve any LLVM operation
 980 that does not have side effects (e.g. load and call are not supported).  The
 981 following is the syntax for constant expressions:</p>
 982
 983 <dl>
 984   <dt><b><tt>cast ( CST to TYPE )</tt></b></dt>
 985
 986   <dd>Cast a constant to another type.</dd>
 987
 988   <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
 989
 990   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
 991   constants.  As with the <a href="#i_getelementptr">getelementptr</a>
 992   instruction, the index list may have zero or more indexes, which are required
 993   to make sense for the type of "CSTPTR".</dd>
 994
 995   <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
 996
 997   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
 998   be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
 999   binary</a> operations.  The constraints on operands are the same as those for
1000   the corresponding instruction (e.g. no bitwise operations on floating point
1001   are allowed).</dd>
1002 </dl>
1003 </div>
1004
1005 <!-- *********************************************************************** -->
1006 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
1007 <!-- *********************************************************************** -->
1008
1009 <div class="doc_text">
1010
1011 <p>The LLVM instruction set consists of several different
1012 classifications of instructions: <a href="#terminators">terminator
1013 instructions</a>, <a href="#binaryops">binary instructions</a>, <a
1014  href="#memoryops">memory instructions</a>, and <a href="#otherops">other
1015 instructions</a>.</p>
1016
1017 </div>
1018
1019 <!-- ======================================================================= -->
1020 <div class="doc_subsection"> <a name="terminators">Terminator
1021 Instructions</a> </div>
1022
1023 <div class="doc_text">
1024
1025 <p>As mentioned <a href="#functionstructure">previously</a>, every
1026 basic block in a program ends with a "Terminator" instruction, which
1027 indicates which block should be executed after the current block is
1028 finished. These terminator instructions typically yield a '<tt>void</tt>'
1029 value: they produce control flow, not values (the one exception being
1030 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
1031 <p>There are six different terminator instructions: the '<a
1032  href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
1033 instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
1034 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
1035  href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
1036  href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
1037
1038 </div>
1039
1040 <!-- _______________________________________________________________________ -->
1041 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
1042 Instruction</a> </div>
1043 <div class="doc_text">
1044 <h5>Syntax:</h5>
1045 <pre>  ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
1046   ret void                 <i>; Return from void function</i>
1047 </pre>
1048 <h5>Overview:</h5>
1049 <p>The '<tt>ret</tt>' instruction is used to return control flow (and a
1050 value) from a function, back to the caller.</p>
1051 <p>There are two forms of the '<tt>ret</tt>' instruction: one that
1052 returns a value and then causes control flow, and one that just causes
1053 control flow to occur.</p>
1054 <h5>Arguments:</h5>
1055 <p>The '<tt>ret</tt>' instruction may return any '<a
1056  href="#t_firstclass">first class</a>' type.  Notice that a function is
1057 not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>'
1058 instruction inside of the function that returns a value that does not
1059 match the return type of the function.</p>
1060 <h5>Semantics:</h5>
1061 <p>When the '<tt>ret</tt>' instruction is executed, control flow
1062 returns back to the calling function's context.  If the caller is a "<a
1063  href="#i_call"><tt>call</tt></a>" instruction, execution continues at
1064 the instruction after the call.  If the caller was an "<a
1065  href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
1066 at the beginning "normal" of the destination block.  If the instruction
1067 returns a value, that value shall set the call or invoke instruction's
1068 return value.</p>
1069 <h5>Example:</h5>
1070 <pre>  ret int 5                       <i>; Return an integer value of 5</i>
1071   ret void                        <i>; Return from a void function</i>
1072 </pre>
1073 </div>
1074 <!-- _______________________________________________________________________ -->
1075 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
1076 <div class="doc_text">
1077 <h5>Syntax:</h5>
1078 <pre>  br bool &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
1079 </pre>
1080 <h5>Overview:</h5>
1081 <p>The '<tt>br</tt>' instruction is used to cause control flow to
1082 transfer to a different basic block in the current function.  There are
1083 two forms of this instruction, corresponding to a conditional branch
1084 and an unconditional branch.</p>
1085 <h5>Arguments:</h5>
1086 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a
1087 single '<tt>bool</tt>' value and two '<tt>label</tt>' values.  The
1088 unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>'
1089 value as a target.</p>
1090 <h5>Semantics:</h5>
1091 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>'
1092 argument is evaluated.  If the value is <tt>true</tt>, control flows
1093 to the '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
1094 control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
1095 <h5>Example:</h5>
1096 <pre>Test:<br>  %cond = <a href="#i_setcc">seteq</a> int %a, %b<br>  br bool %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br>  <a
1097  href="#i_ret">ret</a> int 1<br>IfUnequal:<br>  <a href="#i_ret">ret</a> int 0<br></pre>
1098 </div>
1099 <!-- _______________________________________________________________________ -->
1100 <div class="doc_subsubsection">
1101    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
1102 </div>
1103
1104 <div class="doc_text">
1105 <h5>Syntax:</h5>
1106
1107 <pre>
1108   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
1109 </pre>
1110
1111 <h5>Overview:</h5>
1112
1113 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
1114 several different places.  It is a generalization of the '<tt>br</tt>'
1115 instruction, allowing a branch to occur to one of many possible
1116 destinations.</p>
1117
1118
1119 <h5>Arguments:</h5>
1120
1121 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
1122 comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
1123 an array of pairs of comparison value constants and '<tt>label</tt>'s.  The
1124 table is not allowed to contain duplicate constant entries.</p>
1125
1126 <h5>Semantics:</h5>
1127
1128 <p>The <tt>switch</tt> instruction specifies a table of values and
1129 destinations. When the '<tt>switch</tt>' instruction is executed, this
1130 table is searched for the given value.  If the value is found, control flow is
1131 transfered to the corresponding destination; otherwise, control flow is
1132 transfered to the default destination.</p>
1133
1134 <h5>Implementation:</h5>
1135
1136 <p>Depending on properties of the target machine and the particular
1137 <tt>switch</tt> instruction, this instruction may be code generated in different
1138 ways.  For example, it could be generated as a series of chained conditional
1139 branches or with a lookup table.</p>
1140
1141 <h5>Example:</h5>
1142
1143 <pre>
1144  <i>; Emulate a conditional br instruction</i>
1145  %Val = <a href="#i_cast">cast</a> bool %value to int
1146  switch int %Val, label %truedest [int 0, label %falsedest ]
1147
1148  <i>; Emulate an unconditional br instruction</i>
1149  switch uint 0, label %dest [ ]
1150
1151  <i>; Implement a jump table:</i>
1152  switch uint %val, label %otherwise [ uint 0, label %onzero
1153                                       uint 1, label %onone
1154                                       uint 2, label %ontwo ]
1155 </pre>
1156 </div>
1157 <!-- _______________________________________________________________________ -->
1158 <div class="doc_subsubsection"> <a name="i_invoke">'<tt>invoke</tt>'
1159 Instruction</a> </div>
1160 <div class="doc_text">
1161 <h5>Syntax:</h5>
1162 <pre>  &lt;result&gt; = invoke &lt;ptr to function ty&gt; %&lt;function ptr val&gt;(&lt;function args&gt;)<br>                 to label &lt;normal label&gt; except label &lt;exception label&gt;<br></pre>
1163 <h5>Overview:</h5>
1164 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a
1165 specified function, with the possibility of control flow transfer to
1166 either the '<tt>normal</tt>' <tt>label</tt> label or the '<tt>exception</tt>'<tt>label</tt>.
1167 If the callee function returns with the "<tt><a href="#i_ret">ret</a></tt>"
1168 instruction, control flow will return to the "normal" label.  If the
1169 callee (or any indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
1170 instruction, control is interrupted, and continued at the dynamically
1171 nearest "except" label.</p>
1172 <h5>Arguments:</h5>
1173 <p>This instruction requires several arguments:</p>
1174 <ol>
1175   <li>'<tt>ptr to function ty</tt>': shall be the signature of the
1176 pointer to function value being invoked.  In most cases, this is a
1177 direct function invocation, but indirect <tt>invoke</tt>s are just as
1178 possible, branching off an arbitrary pointer to function value. </li>
1179   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer
1180 to a function to be invoked. </li>
1181   <li>'<tt>function args</tt>': argument list whose types match the
1182 function signature argument types.  If the function signature indicates
1183 the function accepts a variable number of arguments, the extra
1184 arguments can be specified. </li>
1185   <li>'<tt>normal label</tt>': the label reached when the called
1186 function executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
1187   <li>'<tt>exception label</tt>': the label reached when a callee
1188 returns with the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
1189 </ol>
1190 <h5>Semantics:</h5>
1191 <p>This instruction is designed to operate as a standard '<tt><a
1192  href="#i_call">call</a></tt>' instruction in most regards.  The
1193 primary difference is that it establishes an association with a label,
1194 which is used by the runtime library to unwind the stack.</p>
1195 <p>This instruction is used in languages with destructors to ensure
1196 that proper cleanup is performed in the case of either a <tt>longjmp</tt>
1197 or a thrown exception.  Additionally, this is important for
1198 implementation of '<tt>catch</tt>' clauses in high-level languages that
1199 support them.</p>
1200 <h5>Example:</h5>
1201 <pre>  %retval = invoke int %Test(int 15)<br>              to label %Continue<br>              except label %TestCleanup     <i>; {int}:retval set</i>
1202 </pre>
1203 </div>
1204
1205
1206 <!-- _______________________________________________________________________ -->
1207
1208 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
1209 Instruction</a> </div>
1210
1211 <div class="doc_text">
1212
1213 <h5>Syntax:</h5>
1214 <pre>
1215   unwind
1216 </pre>
1217
1218 <h5>Overview:</h5>
1219
1220 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
1221 at the first callee in the dynamic call stack which used an <a
1222 href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.  This is
1223 primarily used to implement exception handling.</p>
1224
1225 <h5>Semantics:</h5>
1226
1227 <p>The '<tt>unwind</tt>' intrinsic causes execution of the current function to
1228 immediately halt.  The dynamic call stack is then searched for the first <a
1229 href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.  Once found,
1230 execution continues at the "exceptional" destination block specified by the
1231 <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt> instruction in the
1232 dynamic call chain, undefined behavior results.</p>
1233 </div>
1234
1235 <!-- _______________________________________________________________________ -->
1236
1237 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
1238 Instruction</a> </div>
1239
1240 <div class="doc_text">
1241
1242 <h5>Syntax:</h5>
1243 <pre>
1244   unreachable
1245 </pre>
1246
1247 <h5>Overview:</h5>
1248
1249 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
1250 instruction is used to inform the optimizer that a particular portion of the
1251 code is not reachable.  This can be used to indicate that the code after a
1252 no-return function cannot be reached, and other facts.</p>
1253
1254 <h5>Semantics:</h5>
1255
1256 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
1257 </div>
1258
1259
1260
1261 <!-- ======================================================================= -->
1262 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
1263 <div class="doc_text">
1264 <p>Binary operators are used to do most of the computation in a
1265 program.  They require two operands, execute an operation on them, and
1266 produce a single value.  The operands might represent
1267 multiple data, as is the case with the <a href="#t_packed">packed</a> data type.
1268 The result value of a binary operator is not
1269 necessarily the same type as its operands.</p>
1270 <p>There are several different binary operators:</p>
1271 </div>
1272 <!-- _______________________________________________________________________ -->
1273 <div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>'
1274 Instruction</a> </div>
1275 <div class="doc_text">
1276 <h5>Syntax:</h5>
1277 <pre>  &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1278 </pre>
1279 <h5>Overview:</h5>
1280 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
1281 <h5>Arguments:</h5>
1282 <p>The two arguments to the '<tt>add</tt>' instruction must be either <a
1283  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> values.
1284  This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1285 Both arguments must have identical types.</p>
1286 <h5>Semantics:</h5>
1287 <p>The value produced is the integer or floating point sum of the two
1288 operands.</p>
1289 <h5>Example:</h5>
1290 <pre>  &lt;result&gt; = add int 4, %var          <i>; yields {int}:result = 4 + %var</i>
1291 </pre>
1292 </div>
1293 <!-- _______________________________________________________________________ -->
1294 <div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>'
1295 Instruction</a> </div>
1296 <div class="doc_text">
1297 <h5>Syntax:</h5>
1298 <pre>  &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1299 </pre>
1300 <h5>Overview:</h5>
1301 <p>The '<tt>sub</tt>' instruction returns the difference of its two
1302 operands.</p>
1303 <p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>'
1304 instruction present in most other intermediate representations.</p>
1305 <h5>Arguments:</h5>
1306 <p>The two arguments to the '<tt>sub</tt>' instruction must be either <a
1307  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1308 values.
1309 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1310 Both arguments must have identical types.</p>
1311 <h5>Semantics:</h5>
1312 <p>The value produced is the integer or floating point difference of
1313 the two operands.</p>
1314 <h5>Example:</h5>
1315 <pre>  &lt;result&gt; = sub int 4, %var          <i>; yields {int}:result = 4 - %var</i>
1316   &lt;result&gt; = sub int 0, %val          <i>; yields {int}:result = -%var</i>
1317 </pre>
1318 </div>
1319 <!-- _______________________________________________________________________ -->
1320 <div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>'
1321 Instruction</a> </div>
1322 <div class="doc_text">
1323 <h5>Syntax:</h5>
1324 <pre>  &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1325 </pre>
1326 <h5>Overview:</h5>
1327 <p>The  '<tt>mul</tt>' instruction returns the product of its two
1328 operands.</p>
1329 <h5>Arguments:</h5>
1330 <p>The two arguments to the '<tt>mul</tt>' instruction must be either <a
1331  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1332 values.
1333 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1334 Both arguments must have identical types.</p>
1335 <h5>Semantics:</h5>
1336 <p>The value produced is the integer or floating point product of the
1337 two operands.</p>
1338 <p>There is no signed vs unsigned multiplication.  The appropriate
1339 action is taken based on the type of the operand.</p>
1340 <h5>Example:</h5>
1341 <pre>  &lt;result&gt; = mul int 4, %var          <i>; yields {int}:result = 4 * %var</i>
1342 </pre>
1343 </div>
1344 <!-- _______________________________________________________________________ -->
1345 <div class="doc_subsubsection"> <a name="i_div">'<tt>div</tt>'
1346 Instruction</a> </div>
1347 <div class="doc_text">
1348 <h5>Syntax:</h5>
1349 <pre>  &lt;result&gt; = div &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1350 </pre>
1351 <h5>Overview:</h5>
1352 <p>The '<tt>div</tt>' instruction returns the quotient of its two
1353 operands.</p>
1354 <h5>Arguments:</h5>
1355 <p>The two arguments to the '<tt>div</tt>' instruction must be either <a
1356  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1357 values.
1358 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1359 Both arguments must have identical types.</p>
1360 <h5>Semantics:</h5>
1361 <p>The value produced is the integer or floating point quotient of the
1362 two operands.</p>
1363 <h5>Example:</h5>
1364 <pre>  &lt;result&gt; = div int 4, %var          <i>; yields {int}:result = 4 / %var</i>
1365 </pre>
1366 </div>
1367 <!-- _______________________________________________________________________ -->
1368 <div class="doc_subsubsection"> <a name="i_rem">'<tt>rem</tt>'
1369 Instruction</a> </div>
1370 <div class="doc_text">
1371 <h5>Syntax:</h5>
1372 <pre>  &lt;result&gt; = rem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1373 </pre>
1374 <h5>Overview:</h5>
1375 <p>The '<tt>rem</tt>' instruction returns the remainder from the
1376 division of its two operands.</p>
1377 <h5>Arguments:</h5>
1378 <p>The two arguments to the '<tt>rem</tt>' instruction must be either <a
1379  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1380 values.
1381 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1382 Both arguments must have identical types.</p>
1383 <h5>Semantics:</h5>
1384 <p>This returns the <i>remainder</i> of a division (where the result
1385 has the same sign as the divisor), not the <i>modulus</i> (where the
1386 result has the same sign as the dividend) of a value.  For more
1387 information about the difference, see: <a
1388  href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
1389 Math Forum</a>.</p>
1390 <h5>Example:</h5>
1391 <pre>  &lt;result&gt; = rem int 4, %var          <i>; yields {int}:result = 4 % %var</i>
1392 </pre>
1393 </div>
1394 <!-- _______________________________________________________________________ -->
1395 <div class="doc_subsubsection"> <a name="i_setcc">'<tt>set<i>cc</i></tt>'
1396 Instructions</a> </div>
1397 <div class="doc_text">
1398 <h5>Syntax:</h5>
1399 <pre>  &lt;result&gt; = seteq &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1400   &lt;result&gt; = setne &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1401   &lt;result&gt; = setlt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1402   &lt;result&gt; = setgt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1403   &lt;result&gt; = setle &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1404   &lt;result&gt; = setge &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1405 </pre>
1406 <h5>Overview:</h5>
1407 <p>The '<tt>set<i>cc</i></tt>' family of instructions returns a boolean
1408 value based on a comparison of their two operands.</p>
1409 <h5>Arguments:</h5>
1410 <p>The two arguments to the '<tt>set<i>cc</i></tt>' instructions must
1411 be of <a href="#t_firstclass">first class</a> type (it is not possible
1412 to compare '<tt>label</tt>'s, '<tt>array</tt>'s, '<tt>structure</tt>'
1413 or '<tt>void</tt>' values, etc...).  Both arguments must have identical
1414 types.</p>
1415 <h5>Semantics:</h5>
1416 <p>The '<tt>seteq</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1417 value if both operands are equal.<br>
1418 The '<tt>setne</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1419 value if both operands are unequal.<br>
1420 The '<tt>setlt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1421 value if the first operand is less than the second operand.<br>
1422 The '<tt>setgt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1423 value if the first operand is greater than the second operand.<br>
1424 The '<tt>setle</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1425 value if the first operand is less than or equal to the second operand.<br>
1426 The '<tt>setge</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1427 value if the first operand is greater than or equal to the second
1428 operand.</p>
1429 <h5>Example:</h5>
1430 <pre>  &lt;result&gt; = seteq int   4, 5        <i>; yields {bool}:result = false</i>
1431   &lt;result&gt; = setne float 4, 5        <i>; yields {bool}:result = true</i>
1432   &lt;result&gt; = setlt uint  4, 5        <i>; yields {bool}:result = true</i>
1433   &lt;result&gt; = setgt sbyte 4, 5        <i>; yields {bool}:result = false</i>
1434   &lt;result&gt; = setle sbyte 4, 5        <i>; yields {bool}:result = true</i>
1435   &lt;result&gt; = setge sbyte 4, 5        <i>; yields {bool}:result = false</i>
1436 </pre>
1437 </div>
1438 <!-- ======================================================================= -->
1439 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
1440 Operations</a> </div>
1441 <div class="doc_text">
1442 <p>Bitwise binary operators are used to do various forms of
1443 bit-twiddling in a program.  They are generally very efficient
1444 instructions and can commonly be strength reduced from other
1445 instructions.  They require two operands, execute an operation on them,
1446 and produce a single value.  The resulting value of the bitwise binary
1447 operators is always the same type as its first operand.</p>
1448 </div>
1449 <!-- _______________________________________________________________________ -->
1450 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
1451 Instruction</a> </div>
1452 <div class="doc_text">
1453 <h5>Syntax:</h5>
1454 <pre>  &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1455 </pre>
1456 <h5>Overview:</h5>
1457 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of
1458 its two operands.</p>
1459 <h5>Arguments:</h5>
1460 <p>The two arguments to the '<tt>and</tt>' instruction must be <a
1461  href="#t_integral">integral</a> values.  Both arguments must have
1462 identical types.</p>
1463 <h5>Semantics:</h5>
1464 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
1465 <p> </p>
1466 <div style="align: center">
1467 <table border="1" cellspacing="0" cellpadding="4">
1468   <tbody>
1469     <tr>
1470       <td>In0</td>
1471       <td>In1</td>
1472       <td>Out</td>
1473     </tr>
1474     <tr>
1475       <td>0</td>
1476       <td>0</td>
1477       <td>0</td>
1478     </tr>
1479     <tr>
1480       <td>0</td>
1481       <td>1</td>
1482       <td>0</td>
1483     </tr>
1484     <tr>
1485       <td>1</td>
1486       <td>0</td>
1487       <td>0</td>
1488     </tr>
1489     <tr>
1490       <td>1</td>
1491       <td>1</td>
1492       <td>1</td>
1493     </tr>
1494   </tbody>
1495 </table>
1496 </div>
1497 <h5>Example:</h5>
1498 <pre>  &lt;result&gt; = and int 4, %var         <i>; yields {int}:result = 4 &amp; %var</i>
1499   &lt;result&gt; = and int 15, 40          <i>; yields {int}:result = 8</i>
1500   &lt;result&gt; = and int 4, 8            <i>; yields {int}:result = 0</i>
1501 </pre>
1502 </div>
1503 <!-- _______________________________________________________________________ -->
1504 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
1505 <div class="doc_text">
1506 <h5>Syntax:</h5>
1507 <pre>  &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1508 </pre>
1509 <h5>Overview:</h5>
1510 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
1511 or of its two operands.</p>
1512 <h5>Arguments:</h5>
1513 <p>The two arguments to the '<tt>or</tt>' instruction must be <a
1514  href="#t_integral">integral</a> values.  Both arguments must have
1515 identical types.</p>
1516 <h5>Semantics:</h5>
1517 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
1518 <p> </p>
1519 <div style="align: center">
1520 <table border="1" cellspacing="0" cellpadding="4">
1521   <tbody>
1522     <tr>
1523       <td>In0</td>
1524       <td>In1</td>
1525       <td>Out</td>
1526     </tr>
1527     <tr>
1528       <td>0</td>
1529       <td>0</td>
1530       <td>0</td>
1531     </tr>
1532     <tr>
1533       <td>0</td>
1534       <td>1</td>
1535       <td>1</td>
1536     </tr>
1537     <tr>
1538       <td>1</td>
1539       <td>0</td>
1540       <td>1</td>
1541     </tr>
1542     <tr>
1543       <td>1</td>
1544       <td>1</td>
1545       <td>1</td>
1546     </tr>
1547   </tbody>
1548 </table>
1549 </div>
1550 <h5>Example:</h5>
1551 <pre>  &lt;result&gt; = or int 4, %var         <i>; yields {int}:result = 4 | %var</i>
1552   &lt;result&gt; = or int 15, 40          <i>; yields {int}:result = 47</i>
1553   &lt;result&gt; = or int 4, 8            <i>; yields {int}:result = 12</i>
1554 </pre>
1555 </div>
1556 <!-- _______________________________________________________________________ -->
1557 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
1558 Instruction</a> </div>
1559 <div class="doc_text">
1560 <h5>Syntax:</h5>
1561 <pre>  &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1562 </pre>
1563 <h5>Overview:</h5>
1564 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
1565 or of its two operands.  The <tt>xor</tt> is used to implement the
1566 "one's complement" operation, which is the "~" operator in C.</p>
1567 <h5>Arguments:</h5>
1568 <p>The two arguments to the '<tt>xor</tt>' instruction must be <a
1569  href="#t_integral">integral</a> values.  Both arguments must have
1570 identical types.</p>
1571 <h5>Semantics:</h5>
1572 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
1573 <p> </p>
1574 <div style="align: center">
1575 <table border="1" cellspacing="0" cellpadding="4">
1576   <tbody>
1577     <tr>
1578       <td>In0</td>
1579       <td>In1</td>
1580       <td>Out</td>
1581     </tr>
1582     <tr>
1583       <td>0</td>
1584       <td>0</td>
1585       <td>0</td>
1586     </tr>
1587     <tr>
1588       <td>0</td>
1589       <td>1</td>
1590       <td>1</td>
1591     </tr>
1592     <tr>
1593       <td>1</td>
1594       <td>0</td>
1595       <td>1</td>
1596     </tr>
1597     <tr>
1598       <td>1</td>
1599       <td>1</td>
1600       <td>0</td>
1601     </tr>
1602   </tbody>
1603 </table>
1604 </div>
1605 <p> </p>
1606 <h5>Example:</h5>
1607 <pre>  &lt;result&gt; = xor int 4, %var         <i>; yields {int}:result = 4 ^ %var</i>
1608   &lt;result&gt; = xor int 15, 40          <i>; yields {int}:result = 39</i>
1609   &lt;result&gt; = xor int 4, 8            <i>; yields {int}:result = 12</i>
1610   &lt;result&gt; = xor int %V, -1          <i>; yields {int}:result = ~%V</i>
1611 </pre>
1612 </div>
1613 <!-- _______________________________________________________________________ -->
1614 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
1615 Instruction</a> </div>
1616 <div class="doc_text">
1617 <h5>Syntax:</h5>
1618 <pre>  &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1619 </pre>
1620 <h5>Overview:</h5>
1621 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to
1622 the left a specified number of bits.</p>
1623 <h5>Arguments:</h5>
1624 <p>The first argument to the '<tt>shl</tt>' instruction must be an <a
1625  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1626 type.</p>
1627 <h5>Semantics:</h5>
1628 <p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p>
1629 <h5>Example:</h5>
1630 <pre>  &lt;result&gt; = shl int 4, ubyte %var   <i>; yields {int}:result = 4 &lt;&lt; %var</i>
1631   &lt;result&gt; = shl int 4, ubyte 2      <i>; yields {int}:result = 16</i>
1632   &lt;result&gt; = shl int 1, ubyte 10     <i>; yields {int}:result = 1024</i>
1633 </pre>
1634 </div>
1635 <!-- _______________________________________________________________________ -->
1636 <div class="doc_subsubsection"> <a name="i_shr">'<tt>shr</tt>'
1637 Instruction</a> </div>
1638 <div class="doc_text">
1639 <h5>Syntax:</h5>
1640 <pre>  &lt;result&gt; = shr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1641 </pre>
1642 <h5>Overview:</h5>
1643 <p>The '<tt>shr</tt>' instruction returns the first operand shifted to
1644 the right a specified number of bits.</p>
1645 <h5>Arguments:</h5>
1646 <p>The first argument to the '<tt>shr</tt>' instruction must be an <a
1647  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1648 type.</p>
1649 <h5>Semantics:</h5>
1650 <p>If the first argument is a <a href="#t_signed">signed</a> type, the
1651 most significant bit is duplicated in the newly free'd bit positions.
1652 If the first argument is unsigned, zero bits shall fill the empty
1653 positions.</p>
1654 <h5>Example:</h5>
1655 <pre>  &lt;result&gt; = shr int 4, ubyte %var   <i>; yields {int}:result = 4 &gt;&gt; %var</i>
1656   &lt;result&gt; = shr uint 4, ubyte 1     <i>; yields {uint}:result = 2</i>
1657   &lt;result&gt; = shr int 4, ubyte 2      <i>; yields {int}:result = 1</i>
1658   &lt;result&gt; = shr sbyte 4, ubyte 3    <i>; yields {sbyte}:result = 0</i>
1659   &lt;result&gt; = shr sbyte -2, ubyte 1   <i>; yields {sbyte}:result = -1</i>
1660 </pre>
1661 </div>
1662 <!-- ======================================================================= -->
1663 <div class="doc_subsection"> <a name="memoryops">Memory Access
1664 Operations</a></div>
1665 <div class="doc_text">
1666 <p>A key design point of an SSA-based representation is how it
1667 represents memory.  In LLVM, no memory locations are in SSA form, which
1668 makes things very simple.  This section describes how to read, write,
1669 allocate, and free memory in LLVM.</p>
1670 </div>
1671 <!-- _______________________________________________________________________ -->
1672 <div class="doc_subsubsection"> <a name="i_malloc">'<tt>malloc</tt>'
1673 Instruction</a> </div>
1674 <div class="doc_text">
1675 <h5>Syntax:</h5>
1676 <pre>  &lt;result&gt; = malloc &lt;type&gt;, uint &lt;NumElements&gt;     <i>; yields {type*}:result</i>
1677   &lt;result&gt; = malloc &lt;type&gt;                         <i>; yields {type*}:result</i>
1678 </pre>
1679 <h5>Overview:</h5>
1680 <p>The '<tt>malloc</tt>' instruction allocates memory from the system
1681 heap and returns a pointer to it.</p>
1682 <h5>Arguments:</h5>
1683 <p>The '<tt>malloc</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
1684 bytes of memory from the operating system and returns a pointer of the
1685 appropriate type to the program.  The second form of the instruction is
1686 a shorter version of the first instruction that defaults to allocating
1687 one element.</p>
1688 <p>'<tt>type</tt>' must be a sized type.</p>
1689 <h5>Semantics:</h5>
1690 <p>Memory is allocated using the system "<tt>malloc</tt>" function, and
1691 a pointer is returned.</p>
1692 <h5>Example:</h5>
1693 <pre>  %array  = malloc [4 x ubyte ]                    <i>; yields {[%4 x ubyte]*}:array</i>
1694
1695   %size   = <a
1696  href="#i_add">add</a> uint 2, 2                          <i>; yields {uint}:size = uint 4</i>
1697   %array1 = malloc ubyte, uint 4                   <i>; yields {ubyte*}:array1</i>
1698   %array2 = malloc [12 x ubyte], uint %size        <i>; yields {[12 x ubyte]*}:array2</i>
1699 </pre>
1700 </div>
1701 <!-- _______________________________________________________________________ -->
1702 <div class="doc_subsubsection"> <a name="i_free">'<tt>free</tt>'
1703 Instruction</a> </div>
1704 <div class="doc_text">
1705 <h5>Syntax:</h5>
1706 <pre>  free &lt;type&gt; &lt;value&gt;                              <i>; yields {void}</i>
1707 </pre>
1708 <h5>Overview:</h5>
1709 <p>The '<tt>free</tt>' instruction returns memory back to the unused
1710 memory heap, to be reallocated in the future.</p>
1711 <p> </p>
1712 <h5>Arguments:</h5>
1713 <p>'<tt>value</tt>' shall be a pointer value that points to a value
1714 that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
1715 instruction.</p>
1716 <h5>Semantics:</h5>
1717 <p>Access to the memory pointed to by the pointer is no longer defined
1718 after this instruction executes.</p>
1719 <h5>Example:</h5>
1720 <pre>  %array  = <a href="#i_malloc">malloc</a> [4 x ubyte]                    <i>; yields {[4 x ubyte]*}:array</i>
1721             free   [4 x ubyte]* %array
1722 </pre>
1723 </div>
1724 <!-- _______________________________________________________________________ -->
1725 <div class="doc_subsubsection"> <a name="i_alloca">'<tt>alloca</tt>'
1726 Instruction</a> </div>
1727 <div class="doc_text">
1728 <h5>Syntax:</h5>
1729 <pre>  &lt;result&gt; = alloca &lt;type&gt;, uint &lt;NumElements&gt;  <i>; yields {type*}:result</i>
1730   &lt;result&gt; = alloca &lt;type&gt;                      <i>; yields {type*}:result</i>
1731 </pre>
1732 <h5>Overview:</h5>
1733 <p>The '<tt>alloca</tt>' instruction allocates memory on the current
1734 stack frame of the procedure that is live until the current function
1735 returns to its caller.</p>
1736 <h5>Arguments:</h5>
1737 <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
1738 bytes of memory on the runtime stack, returning a pointer of the
1739 appropriate type to the program.  The second form of the instruction is
1740 a shorter version of the first that defaults to allocating one element.</p>
1741 <p>'<tt>type</tt>' may be any sized type.</p>
1742 <h5>Semantics:</h5>
1743 <p>Memory is allocated, a pointer is returned.  '<tt>alloca</tt>'d
1744 memory is automatically released when the function returns.  The '<tt>alloca</tt>'
1745 instruction is commonly used to represent automatic variables that must
1746 have an address available.  When the function returns (either with the <tt><a
1747  href="#i_ret">ret</a></tt> or <tt><a href="#i_invoke">invoke</a></tt>
1748 instructions), the memory is reclaimed.</p>
1749 <h5>Example:</h5>
1750 <pre>  %ptr = alloca int                              <i>; yields {int*}:ptr</i>
1751   %ptr = alloca int, uint 4                      <i>; yields {int*}:ptr</i>
1752 </pre>
1753 </div>
1754 <!-- _______________________________________________________________________ -->
1755 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
1756 Instruction</a> </div>
1757 <div class="doc_text">
1758 <h5>Syntax:</h5>
1759 <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>
1760 <h5>Overview:</h5>
1761 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
1762 <h5>Arguments:</h5>
1763 <p>The argument to the '<tt>load</tt>' instruction specifies the memory
1764 address to load from.  The pointer must point to a <a
1765  href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
1766 marked as <tt>volatile</tt> then the optimizer is not allowed to modify
1767 the number or order of execution of this <tt>load</tt> with other
1768 volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
1769 instructions. </p>
1770 <h5>Semantics:</h5>
1771 <p>The location of memory pointed to is loaded.</p>
1772 <h5>Examples:</h5>
1773 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
1774   <a
1775  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
1776   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
1777 </pre>
1778 </div>
1779 <!-- _______________________________________________________________________ -->
1780 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
1781 Instruction</a> </div>
1782 <h5>Syntax:</h5>
1783 <pre>  store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
1784   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
1785 </pre>
1786 <h5>Overview:</h5>
1787 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
1788 <h5>Arguments:</h5>
1789 <p>There are two arguments to the '<tt>store</tt>' instruction: a value
1790 to store and an address to store it into.  The type of the '<tt>&lt;pointer&gt;</tt>'
1791 operand must be a pointer to the type of the '<tt>&lt;value&gt;</tt>'
1792 operand. If the <tt>store</tt> is marked as <tt>volatile</tt> then the
1793 optimizer is not allowed to modify the number or order of execution of
1794 this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
1795  href="#i_store">store</a></tt> instructions.</p>
1796 <h5>Semantics:</h5>
1797 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
1798 at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
1799 <h5>Example:</h5>
1800 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
1801   <a
1802  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
1803   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
1804 </pre>
1805 <!-- _______________________________________________________________________ -->
1806 <div class="doc_subsubsection">
1807    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
1808 </div>
1809
1810 <div class="doc_text">
1811 <h5>Syntax:</h5>
1812 <pre>
1813   &lt;result&gt; = getelementptr &lt;ty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
1814 </pre>
1815
1816 <h5>Overview:</h5>
1817
1818 <p>
1819 The '<tt>getelementptr</tt>' instruction is used to get the address of a
1820 subelement of an aggregate data structure.</p>
1821
1822 <h5>Arguments:</h5>
1823
1824 <p>This instruction takes a list of integer constants that indicate what
1825 elements of the aggregate object to index to.  The actual types of the arguments
1826 provided depend on the type of the first pointer argument.  The
1827 '<tt>getelementptr</tt>' instruction is used to index down through the type
1828 levels of a structure.  When indexing into a structure, only <tt>uint</tt>
1829 integer constants are allowed.  When indexing into an array or pointer
1830 <tt>int</tt> and <tt>long</tt> indexes are allowed of any sign.</p>
1831
1832 <p>For example, let's consider a C code fragment and how it gets
1833 compiled to LLVM:</p>
1834
1835 <pre>
1836   struct RT {
1837     char A;
1838     int B[10][20];
1839     char C;
1840   };
1841   struct ST {
1842     int X;
1843     double Y;
1844     struct RT Z;
1845   };
1846
1847   int *foo(struct ST *s) {
1848     return &amp;s[1].Z.B[5][13];
1849   }
1850 </pre>
1851
1852 <p>The LLVM code generated by the GCC frontend is:</p>
1853
1854 <pre>
1855   %RT = type { sbyte, [10 x [20 x int]], sbyte }
1856   %ST = type { int, double, %RT }
1857
1858   implementation
1859
1860   int* %foo(%ST* %s) {
1861   entry:
1862     %reg = getelementptr %ST* %s, int 1, uint 2, uint 1, int 5, int 13
1863     ret int* %reg
1864   }
1865 </pre>
1866
1867 <h5>Semantics:</h5>
1868
1869 <p>The index types specified for the '<tt>getelementptr</tt>' instruction depend
1870 on the pointer type that is being index into. <a href="#t_pointer">Pointer</a>
1871 and <a href="#t_array">array</a> types require <tt>uint</tt>, <tt>int</tt>,
1872 <tt>ulong</tt>, or <tt>long</tt> values, and <a href="#t_struct">structure</a>
1873 types require <tt>uint</tt> <b>constants</b>.</p>
1874
1875 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
1876 type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ int, double, %RT
1877 }</tt>' type, a structure.  The second index indexes into the third element of
1878 the structure, yielding a '<tt>%RT</tt>' = '<tt>{ sbyte, [10 x [20 x int]],
1879 sbyte }</tt>' type, another structure.  The third index indexes into the second
1880 element of the structure, yielding a '<tt>[10 x [20 x int]]</tt>' type, an
1881 array.  The two dimensions of the array are subscripted into, yielding an
1882 '<tt>int</tt>' type.  The '<tt>getelementptr</tt>' instruction return a pointer
1883 to this element, thus computing a value of '<tt>int*</tt>' type.</p>
1884
1885 <p>Note that it is perfectly legal to index partially through a
1886 structure, returning a pointer to an inner element.  Because of this,
1887 the LLVM code for the given testcase is equivalent to:</p>
1888
1889 <pre>
1890   int* %foo(%ST* %s) {
1891     %t1 = getelementptr %ST* %s, int 1                        <i>; yields %ST*:%t1</i>
1892     %t2 = getelementptr %ST* %t1, int 0, uint 2               <i>; yields %RT*:%t2</i>
1893     %t3 = getelementptr %RT* %t2, int 0, uint 1               <i>; yields [10 x [20 x int]]*:%t3</i>
1894     %t4 = getelementptr [10 x [20 x int]]* %t3, int 0, int 5  <i>; yields [20 x int]*:%t4</i>
1895     %t5 = getelementptr [20 x int]* %t4, int 0, int 13        <i>; yields int*:%t5</i>
1896     ret int* %t5
1897   }
1898 </pre>
1899 <h5>Example:</h5>
1900 <pre>
1901     <i>; yields [12 x ubyte]*:aptr</i>
1902     %aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, uint 1
1903 </pre>
1904
1905 </div>
1906 <!-- ======================================================================= -->
1907 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
1908 <div class="doc_text">
1909 <p>The instructions in this category are the "miscellaneous"
1910 instructions, which defy better classification.</p>
1911 </div>
1912 <!-- _______________________________________________________________________ -->
1913 <div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>'
1914 Instruction</a> </div>
1915 <div class="doc_text">
1916 <h5>Syntax:</h5>
1917 <pre>  &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
1918 <h5>Overview:</h5>
1919 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
1920 the SSA graph representing the function.</p>
1921 <h5>Arguments:</h5>
1922 <p>The type of the incoming values are specified with the first type
1923 field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
1924 as arguments, with one pair for each predecessor basic block of the
1925 current block.  Only values of <a href="#t_firstclass">first class</a>
1926 type may be used as the value arguments to the PHI node.  Only labels
1927 may be used as the label arguments.</p>
1928 <p>There must be no non-phi instructions between the start of a basic
1929 block and the PHI instructions: i.e. PHI instructions must be first in
1930 a basic block.</p>
1931 <h5>Semantics:</h5>
1932 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the
1933 value specified by the parameter, depending on which basic block we
1934 came from in the last <a href="#terminators">terminator</a> instruction.</p>
1935 <h5>Example:</h5>
1936 <pre>Loop:       ; Infinite loop that counts from 0 on up...<br>  %indvar = phi uint [ 0, %LoopHeader ], [ %nextindvar, %Loop ]<br>  %nextindvar = add uint %indvar, 1<br>  br label %Loop<br></pre>
1937 </div>
1938
1939 <!-- _______________________________________________________________________ -->
1940 <div class="doc_subsubsection">
1941    <a name="i_cast">'<tt>cast .. to</tt>' Instruction</a>
1942 </div>
1943
1944 <div class="doc_text">
1945
1946 <h5>Syntax:</h5>
1947
1948 <pre>
1949   &lt;result&gt; = cast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
1950 </pre>
1951
1952 <h5>Overview:</h5>
1953
1954 <p>
1955 The '<tt>cast</tt>' instruction is used as the primitive means to convert
1956 integers to floating point, change data type sizes, and break type safety (by
1957 casting pointers).
1958 </p>
1959
1960
1961 <h5>Arguments:</h5>
1962
1963 <p>
1964 The '<tt>cast</tt>' instruction takes a value to cast, which must be a first
1965 class value, and a type to cast it to, which must also be a <a
1966 href="#t_firstclass">first class</a> type.
1967 </p>
1968
1969 <h5>Semantics:</h5>
1970
1971 <p>
1972 This instruction follows the C rules for explicit casts when determining how the
1973 data being cast must change to fit in its new container.
1974 </p>
1975
1976 <p>
1977 When casting to bool, any value that would be considered true in the context of
1978 a C '<tt>if</tt>' condition is converted to the boolean '<tt>true</tt>' values,
1979 all else are '<tt>false</tt>'.
1980 </p>
1981
1982 <p>
1983 When extending an integral value from a type of one signness to another (for
1984 example '<tt>sbyte</tt>' to '<tt>ulong</tt>'), the value is sign-extended if the
1985 <b>source</b> value is signed, and zero-extended if the source value is
1986 unsigned. <tt>bool</tt> values are always zero extended into either zero or
1987 one.
1988 </p>
1989
1990 <h5>Example:</h5>
1991
1992 <pre>
1993   %X = cast int 257 to ubyte              <i>; yields ubyte:1</i>
1994   %Y = cast int 123 to bool               <i>; yields bool:true</i>
1995 </pre>
1996 </div>
1997
1998 <!-- _______________________________________________________________________ -->
1999 <div class="doc_subsubsection">
2000    <a name="i_select">'<tt>select</tt>' Instruction</a>
2001 </div>
2002
2003 <div class="doc_text">
2004
2005 <h5>Syntax:</h5>
2006
2007 <pre>
2008   &lt;result&gt; = select bool &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt;             <i>; yields ty</i>
2009 </pre>
2010
2011 <h5>Overview:</h5>
2012
2013 <p>
2014 The '<tt>select</tt>' instruction is used to choose one value based on a
2015 condition, without branching.
2016 </p>
2017
2018
2019 <h5>Arguments:</h5>
2020
2021 <p>
2022 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.
2023 </p>
2024
2025 <h5>Semantics:</h5>
2026
2027 <p>
2028 If the boolean condition evaluates to true, the instruction returns the first
2029 value argument, otherwise it returns the second value argument.
2030 </p>
2031
2032 <h5>Example:</h5>
2033
2034 <pre>
2035   %X = select bool true, ubyte 17, ubyte 42          <i>; yields ubyte:17</i>
2036 </pre>
2037 </div>
2038
2039
2040
2041
2042
2043 <!-- _______________________________________________________________________ -->
2044 <div class="doc_subsubsection"> <a name="i_call">'<tt>call</tt>'
2045 Instruction</a> </div>
2046 <div class="doc_text">
2047 <h5>Syntax:</h5>
2048 <pre>  &lt;result&gt; = call &lt;ty&gt;* &lt;fnptrval&gt;(&lt;param list&gt;)<br></pre>
2049 <h5>Overview:</h5>
2050 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
2051 <h5>Arguments:</h5>
2052 <p>This instruction requires several arguments:</p>
2053 <ol>
2054   <li>
2055     <p>'<tt>ty</tt>': shall be the signature of the pointer to function
2056 value   being invoked.  The argument types must match the types implied
2057 by this   signature.</p>
2058   </li>
2059   <li>
2060     <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a
2061 function   to be invoked. In most cases, this is a direct function
2062 invocation, but   indirect <tt>call</tt>s are just as possible,
2063 calling an arbitrary pointer to   function values.</p>
2064   </li>
2065   <li>
2066     <p>'<tt>function args</tt>': argument list whose types match the
2067     function signature argument types. All arguments must be of
2068     <a href="#t_firstclass">first class</a> type. If the function signature
2069     indicates the function accepts a variable number of arguments, the extra
2070     arguments can be specified.</p>
2071   </li>
2072 </ol>
2073 <h5>Semantics:</h5>
2074 <p>The '<tt>call</tt>' instruction is used to cause control flow to
2075 transfer to a specified function, with its incoming arguments bound to
2076 the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
2077 instruction in the called function, control flow continues with the
2078 instruction after the function call, and the return value of the
2079 function is bound to the result argument.  This is a simpler case of
2080 the <a href="#i_invoke">invoke</a> instruction.</p>
2081 <h5>Example:</h5>
2082 <pre>  %retval = call int %test(int %argc)<br>  call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42);<br></pre>
2083 </div>
2084
2085 <!-- _______________________________________________________________________ -->
2086 <div class="doc_subsubsection">
2087   <a name="i_vanext">'<tt>vanext</tt>' Instruction</a>
2088 </div>
2089
2090 <div class="doc_text">
2091
2092 <h5>Syntax:</h5>
2093
2094 <pre>
2095   &lt;resultarglist&gt; = vanext &lt;va_list&gt; &lt;arglist&gt;, &lt;argty&gt;
2096 </pre>
2097
2098 <h5>Overview:</h5>
2099
2100 <p>The '<tt>vanext</tt>' instruction is used to access arguments passed
2101 through the "variable argument" area of a function call.  It is used to
2102 implement the <tt>va_arg</tt> macro in C.</p>
2103
2104 <h5>Arguments:</h5>
2105
2106 <p>This instruction takes a <tt>va_list</tt> value and the type of the
2107 argument. It returns another <tt>va_list</tt>. The actual type of
2108 <tt>va_list</tt> may be defined differently for different targets.  Most targets
2109 use a <tt>va_list</tt> type of <tt>sbyte*</tt> or some other pointer type.</p>
2110
2111 <h5>Semantics:</h5>
2112
2113 <p>The '<tt>vanext</tt>' instruction advances the specified <tt>va_list</tt>
2114 past an argument of the specified type.  In conjunction with the <a
2115  href="#i_vaarg"><tt>vaarg</tt></a> instruction, it is used to implement
2116 the <tt>va_arg</tt> macro available in C.  For more information, see
2117 the variable argument handling <a href="#int_varargs">Intrinsic
2118 Functions</a>.</p>
2119
2120 <p>It is legal for this instruction to be called in a function which
2121 does not take a variable number of arguments, for example, the <tt>vfprintf</tt>
2122 function.</p>
2123
2124 <p><tt>vanext</tt> is an LLVM instruction instead of an <a
2125 href="#intrinsics">intrinsic function</a> because it takes a type as an
2126 argument.  The type refers to the current argument in the <tt>va_list</tt>, it
2127 tells the compiler how far on the stack it needs to advance to find the next
2128 argument</p>
2129
2130 <h5>Example:</h5>
2131
2132 <p>See the <a href="#int_varargs">variable argument processing</a>
2133 section.</p>
2134
2135 </div>
2136
2137 <!-- _______________________________________________________________________ -->
2138 <div class="doc_subsubsection">
2139   <a name="i_vaarg">'<tt>vaarg</tt>' Instruction</a>
2140 </div>
2141
2142 <div class="doc_text">
2143
2144 <h5>Syntax:</h5>
2145
2146 <pre>
2147   &lt;resultval&gt; = vaarg &lt;va_list&gt; &lt;arglist&gt;, &lt;argty&gt;
2148 </pre>
2149
2150 <h5>Overview:</h5>
2151
2152 <p>The '<tt>vaarg</tt>' instruction is used to access arguments passed through
2153 the "variable argument" area of a function call.  It is used to implement the
2154 <tt>va_arg</tt> macro in C.</p>
2155
2156 <h5>Arguments:</h5>
2157
2158 <p>This instruction takes a <tt>va_list</tt> value and the type of the
2159 argument. It returns a value of the specified argument type.  Again, the actual
2160 type of <tt>va_list</tt> is target specific.</p>
2161
2162 <h5>Semantics:</h5>
2163
2164 <p>The '<tt>vaarg</tt>' instruction loads an argument of the specified type from
2165 the specified <tt>va_list</tt>.  In conjunction with the <a
2166 href="#i_vanext"><tt>vanext</tt></a> instruction, it is used to implement the
2167 <tt>va_arg</tt> macro available in C.  For more information, see the variable
2168 argument handling <a href="#int_varargs">Intrinsic Functions</a>.</p>
2169
2170 <p>It is legal for this instruction to be called in a function which does not
2171 take a variable number of arguments, for example, the <tt>vfprintf</tt>
2172 function.</p>
2173
2174 <p><tt>vaarg</tt> is an LLVM instruction instead of an <a
2175 href="#intrinsics">intrinsic function</a> because it takes an type as an
2176 argument.</p>
2177
2178 <h5>Example:</h5>
2179
2180 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
2181
2182 </div>
2183
2184 <!-- *********************************************************************** -->
2185 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
2186 <!-- *********************************************************************** -->
2187
2188 <div class="doc_text">
2189
2190 <p>LLVM supports the notion of an "intrinsic function".  These functions have
2191 well known names and semantics, and are required to follow certain
2192 restrictions. Overall, these instructions represent an extension mechanism for
2193 the LLVM language that does not require changing all of the transformations in
2194 LLVM to add to the language (or the bytecode reader/writer, the parser,
2195 etc...).</p>
2196
2197 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix, this
2198 prefix is reserved in LLVM for intrinsic names, thus functions may not be named
2199 this.  Intrinsic functions must always be external functions: you cannot define
2200 the body of intrinsic functions.  Intrinsic functions may only be used in call
2201 or invoke instructions: it is illegal to take the address of an intrinsic
2202 function.  Additionally, because intrinsic functions are part of the LLVM
2203 language, it is required that they all be documented here if any are added.</p>
2204
2205
2206 <p>
2207 Adding an intrinsic to LLVM is straight-forward if it is possible to express the
2208 concept in LLVM directly (ie, code generator support is not _required_).  To do
2209 this, extend the default implementation of the IntrinsicLowering class to handle
2210 the intrinsic.  Code generators use this class to lower intrinsics they do not
2211 understand to raw LLVM instructions that they do.
2212 </p>
2213
2214 </div>
2215
2216 <!-- ======================================================================= -->
2217 <div class="doc_subsection">
2218   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
2219 </div>
2220
2221 <div class="doc_text">
2222
2223 <p>Variable argument support is defined in LLVM with the <a
2224  href="#i_vanext"><tt>vanext</tt></a> instruction and these three
2225 intrinsic functions.  These functions are related to the similarly
2226 named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
2227
2228 <p>All of these functions operate on arguments that use a
2229 target-specific value type "<tt>va_list</tt>".  The LLVM assembly
2230 language reference manual does not define what this type is, so all
2231 transformations should be prepared to handle intrinsics with any type
2232 used.</p>
2233
2234 <p>This example shows how the <a href="#i_vanext"><tt>vanext</tt></a>
2235 instruction and the variable argument handling intrinsic functions are
2236 used.</p>
2237
2238 <pre>
2239 int %test(int %X, ...) {
2240   ; Initialize variable argument processing
2241   %ap = call sbyte* %<a href="#i_va_start">llvm.va_start</a>()
2242
2243   ; Read a single integer argument
2244   %tmp = vaarg sbyte* %ap, int
2245
2246   ; Advance to the next argument
2247   %ap2 = vanext sbyte* %ap, int
2248
2249   ; Demonstrate usage of llvm.va_copy and llvm.va_end
2250   %aq = call sbyte* %<a href="#i_va_copy">llvm.va_copy</a>(sbyte* %ap2)
2251   call void %<a href="#i_va_end">llvm.va_end</a>(sbyte* %aq)
2252
2253   ; Stop processing of arguments.
2254   call void %<a href="#i_va_end">llvm.va_end</a>(sbyte* %ap2)
2255   ret int %tmp
2256 }
2257 </pre>
2258 </div>
2259
2260 <!-- _______________________________________________________________________ -->
2261 <div class="doc_subsubsection">
2262   <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
2263 </div>
2264
2265
2266 <div class="doc_text">
2267 <h5>Syntax:</h5>
2268 <pre>  declare &lt;va_list&gt; %llvm.va_start()<br></pre>
2269 <h5>Overview:</h5>
2270 <p>The '<tt>llvm.va_start</tt>' intrinsic returns a new <tt>&lt;arglist&gt;</tt>
2271 for subsequent use by the variable argument intrinsics.</p>
2272 <h5>Semantics:</h5>
2273 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
2274 macro available in C.  In a target-dependent way, it initializes and
2275 returns a <tt>va_list</tt> element, so that the next <tt>vaarg</tt>
2276 will produce the first variable argument passed to the function.  Unlike
2277 the C <tt>va_start</tt> macro, this intrinsic does not need to know the
2278 last argument of the function, the compiler can figure that out.</p>
2279 <p>Note that this intrinsic function is only legal to be called from
2280 within the body of a variable argument function.</p>
2281 </div>
2282
2283 <!-- _______________________________________________________________________ -->
2284 <div class="doc_subsubsection">
2285  <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
2286 </div>
2287
2288 <div class="doc_text">
2289 <h5>Syntax:</h5>
2290 <pre>  declare void %llvm.va_end(&lt;va_list&gt; &lt;arglist&gt;)<br></pre>
2291 <h5>Overview:</h5>
2292 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>&lt;arglist&gt;</tt>
2293 which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt>
2294 or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
2295 <h5>Arguments:</h5>
2296 <p>The argument is a <tt>va_list</tt> to destroy.</p>
2297 <h5>Semantics:</h5>
2298 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
2299 macro available in C.  In a target-dependent way, it destroys the <tt>va_list</tt>.
2300 Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a
2301  href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly
2302 with calls to <tt>llvm.va_end</tt>.</p>
2303 </div>
2304
2305 <!-- _______________________________________________________________________ -->
2306 <div class="doc_subsubsection">
2307   <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
2308 </div>
2309
2310 <div class="doc_text">
2311
2312 <h5>Syntax:</h5>
2313
2314 <pre>
2315   declare &lt;va_list&gt; %llvm.va_copy(&lt;va_list&gt; &lt;destarglist&gt;)
2316 </pre>
2317
2318 <h5>Overview:</h5>
2319
2320 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
2321 from the source argument list to the destination argument list.</p>
2322
2323 <h5>Arguments:</h5>
2324
2325 <p>The argument is the <tt>va_list</tt> to copy.</p>
2326
2327 <h5>Semantics:</h5>
2328
2329 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
2330 macro available in C.  In a target-dependent way, it copies the source
2331 <tt>va_list</tt> element into the returned list.  This intrinsic is necessary
2332 because the <tt><a href="#i_va_start">llvm.va_start</a></tt> intrinsic may be
2333 arbitrarily complex and require memory allocation, for example.</p>
2334
2335 </div>
2336
2337 <!-- ======================================================================= -->
2338 <div class="doc_subsection">
2339   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
2340 </div>
2341
2342 <div class="doc_text">
2343
2344 <p>
2345 LLVM support for <a href="GarbageCollection.html">Accurate Garbage
2346 Collection</a> requires the implementation and generation of these intrinsics.
2347 These intrinsics allow identification of <a href="#i_gcroot">GC roots on the
2348 stack</a>, as well as garbage collector implementations that require <a
2349 href="#i_gcread">read</a> and <a href="#i_gcwrite">write</a> barriers.
2350 Front-ends for type-safe garbage collected languages should generate these
2351 intrinsics to make use of the LLVM garbage collectors.  For more details, see <a
2352 href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
2353 </p>
2354 </div>
2355
2356 <!-- _______________________________________________________________________ -->
2357 <div class="doc_subsubsection">
2358   <a name="i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
2359 </div>
2360
2361 <div class="doc_text">
2362
2363 <h5>Syntax:</h5>
2364
2365 <pre>
2366   declare void %llvm.gcroot(&lt;ty&gt;** %ptrloc, &lt;ty2&gt;* %metadata)
2367 </pre>
2368
2369 <h5>Overview:</h5>
2370
2371 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
2372 the code generator, and allows some metadata to be associated with it.</p>
2373
2374 <h5>Arguments:</h5>
2375
2376 <p>The first argument specifies the address of a stack object that contains the
2377 root pointer.  The second pointer (which must be either a constant or a global
2378 value address) contains the meta-data to be associated with the root.</p>
2379
2380 <h5>Semantics:</h5>
2381
2382 <p>At runtime, a call to this intrinsics stores a null pointer into the "ptrloc"
2383 location.  At compile-time, the code generator generates information to allow
2384 the runtime to find the pointer at GC safe points.
2385 </p>
2386
2387 </div>
2388
2389
2390 <!-- _______________________________________________________________________ -->
2391 <div class="doc_subsubsection">
2392   <a name="i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
2393 </div>
2394
2395 <div class="doc_text">
2396
2397 <h5>Syntax:</h5>
2398
2399 <pre>
2400   declare sbyte* %llvm.gcread(sbyte** %Ptr)
2401 </pre>
2402
2403 <h5>Overview:</h5>
2404
2405 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
2406 locations, allowing garbage collector implementations that require read
2407 barriers.</p>
2408
2409 <h5>Arguments:</h5>
2410
2411 <p>The argument is the address to read from, which should be an address
2412 allocated from the garbage collector.</p>
2413
2414 <h5>Semantics:</h5>
2415
2416 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
2417 instruction, but may be replaced with substantially more complex code by the
2418 garbage collector runtime, as needed.</p>
2419
2420 </div>
2421
2422
2423 <!-- _______________________________________________________________________ -->
2424 <div class="doc_subsubsection">
2425   <a name="i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
2426 </div>
2427
2428 <div class="doc_text">
2429
2430 <h5>Syntax:</h5>
2431
2432 <pre>
2433   declare void %llvm.gcwrite(sbyte* %P1, sbyte** %P2)
2434 </pre>
2435
2436 <h5>Overview:</h5>
2437
2438 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
2439 locations, allowing garbage collector implementations that require write
2440 barriers (such as generational or reference counting collectors).</p>
2441
2442 <h5>Arguments:</h5>
2443
2444 <p>The first argument is the reference to store, and the second is the heap
2445 location to store to.</p>
2446
2447 <h5>Semantics:</h5>
2448
2449 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
2450 instruction, but may be replaced with substantially more complex code by the
2451 garbage collector runtime, as needed.</p>
2452
2453 </div>
2454
2455
2456
2457 <!-- ======================================================================= -->
2458 <div class="doc_subsection">
2459   <a name="int_codegen">Code Generator Intrinsics</a>
2460 </div>
2461
2462 <div class="doc_text">
2463 <p>
2464 These intrinsics are provided by LLVM to expose special features that may only
2465 be implemented with code generator support.
2466 </p>
2467
2468 </div>
2469
2470 <!-- _______________________________________________________________________ -->
2471 <div class="doc_subsubsection">
2472   <a name="i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
2473 </div>
2474
2475 <div class="doc_text">
2476
2477 <h5>Syntax:</h5>
2478 <pre>
2479   declare void* %llvm.returnaddress(uint &lt;level&gt;)
2480 </pre>
2481
2482 <h5>Overview:</h5>
2483
2484 <p>
2485 The '<tt>llvm.returnaddress</tt>' intrinsic returns a target-specific value
2486 indicating the return address of the current function or one of its callers.
2487 </p>
2488
2489 <h5>Arguments:</h5>
2490
2491 <p>
2492 The argument to this intrinsic indicates which function to return the address
2493 for.  Zero indicates the calling function, one indicates its caller, etc.  The
2494 argument is <b>required</b> to be a constant integer value.
2495 </p>
2496
2497 <h5>Semantics:</h5>
2498
2499 <p>
2500 The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
2501 the return address of the specified call frame, or zero if it cannot be
2502 identified.  The value returned by this intrinsic is likely to be incorrect or 0
2503 for arguments other than zero, so it should only be used for debugging purposes.
2504 </p>
2505
2506 <p>
2507 Note that calling this intrinsic does not prevent function inlining or other
2508 aggressive transformations, so the value returned may not be that of the obvious
2509 source-language caller.
2510 </p>
2511 </div>
2512
2513
2514 <!-- _______________________________________________________________________ -->
2515 <div class="doc_subsubsection">
2516   <a name="i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
2517 </div>
2518
2519 <div class="doc_text">
2520
2521 <h5>Syntax:</h5>
2522 <pre>
2523   declare void* %llvm.frameaddress(uint &lt;level&gt;)
2524 </pre>
2525
2526 <h5>Overview:</h5>
2527
2528 <p>
2529 The '<tt>llvm.frameaddress</tt>' intrinsic returns the target-specific frame
2530 pointer value for the specified stack frame.
2531 </p>
2532
2533 <h5>Arguments:</h5>
2534
2535 <p>
2536 The argument to this intrinsic indicates which function to return the frame
2537 pointer for.  Zero indicates the calling function, one indicates its caller,
2538 etc.  The argument is <b>required</b> to be a constant integer value.
2539 </p>
2540
2541 <h5>Semantics:</h5>
2542
2543 <p>
2544 The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
2545 the frame address of the specified call frame, or zero if it cannot be
2546 identified.  The value returned by this intrinsic is likely to be incorrect or 0
2547 for arguments other than zero, so it should only be used for debugging purposes.
2548 </p>
2549
2550 <p>
2551 Note that calling this intrinsic does not prevent function inlining or other
2552 aggressive transformations, so the value returned may not be that of the obvious
2553 source-language caller.
2554 </p>
2555 </div>
2556
2557 <!-- _______________________________________________________________________ -->
2558 <div class="doc_subsubsection">
2559   <a name="i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
2560 </div>
2561
2562 <div class="doc_text">
2563
2564 <h5>Syntax:</h5>
2565 <pre>
2566   declare void %llvm.prefetch(sbyte * &lt;address&gt;,
2567                                 uint &lt;rw&gt;, uint &lt;locality&gt;)
2568 </pre>
2569
2570 <h5>Overview:</h5>
2571
2572
2573 <p>
2574 The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
2575 a prefetch instruction if supported, otherwise it is a noop.  Prefetches have no
2576 effect on the behavior of the program, but can change its performance
2577 characteristics.
2578 </p>
2579
2580 <h5>Arguments:</h5>
2581
2582 <p>
2583 <tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
2584 determining if the fetch should be for a read (0) or write (1), and
2585 <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
2586 locality, to (3) - extremely local keep in cache.  The <tt>rw</tt> and
2587 <tt>locality</tt> arguments must be constant integers.
2588 </p>
2589
2590 <h5>Semantics:</h5>
2591
2592 <p>
2593 This intrinsic does not modify the behavior of the program.  In particular,
2594 prefetches cannot trap and do not produce a value.  On targets that support this
2595 intrinsic, the prefetch can provide hints to the processor cache for better
2596 performance.
2597 </p>
2598
2599 </div>
2600
2601 <!-- _______________________________________________________________________ -->
2602 <div class="doc_subsubsection">
2603   <a name="i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
2604 </div>
2605
2606 <div class="doc_text">
2607
2608 <h5>Syntax:</h5>
2609 <pre>
2610   declare void %llvm.pcmarker( uint &lt;id&gt; )
2611 </pre>
2612
2613 <h5>Overview:</h5>
2614
2615
2616 <p>
2617 The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a PC in a region of
2618 code to simulators and other tools.  The method is target specific, but it is
2619 expected that the marker will use exported symbols to transmit the PC of the marker.
2620 The marker makes no guaranties that it will remain with any specific instruction
2621 after optimizations.  It is possible that the presense of a marker will inhibit
2622 optimizations.  The intended use is to be inserted after optmizations to allow
2623 corrolations of simulation runs.
2624 </p>
2625
2626 <h5>Arguments:</h5>
2627
2628 <p>
2629 <tt>id</tt> is a numerical id identifying the marker.
2630 </p>
2631
2632 <h5>Semantics:</h5>
2633
2634 <p>
2635 This intrinsic does not modify the behavior of the program.  Backends that do not
2636 support this intrinisic may ignore it.
2637 </p>
2638
2639 </div>
2640
2641
2642 <!-- ======================================================================= -->
2643 <div class="doc_subsection">
2644   <a name="int_os">Operating System Intrinsics</a>
2645 </div>
2646
2647 <div class="doc_text">
2648 <p>
2649 These intrinsics are provided by LLVM to support the implementation of
2650 operating system level code.
2651 </p>
2652
2653 </div>
2654
2655 <!-- _______________________________________________________________________ -->
2656 <div class="doc_subsubsection">
2657   <a name="i_readport">'<tt>llvm.readport</tt>' Intrinsic</a>
2658 </div>
2659
2660 <div class="doc_text">
2661
2662 <h5>Syntax:</h5>
2663 <pre>
2664   declare &lt;integer type&gt; %llvm.readport (&lt;integer type&gt; &lt;address&gt;)
2665 </pre>
2666
2667 <h5>Overview:</h5>
2668
2669 <p>
2670 The '<tt>llvm.readport</tt>' intrinsic reads data from the specified hardware
2671 I/O port.
2672 </p>
2673
2674 <h5>Arguments:</h5>
2675
2676 <p>
2677 The argument to this intrinsic indicates the hardware I/O address from which
2678 to read the data.  The address is in the hardware I/O address namespace (as
2679 opposed to being a memory location for memory mapped I/O).
2680 </p>
2681
2682 <h5>Semantics:</h5>
2683
2684 <p>
2685 The '<tt>llvm.readport</tt>' intrinsic reads data from the hardware I/O port
2686 specified by <i>address</i> and returns the value.  The address and return
2687 value must be integers, but the size is dependent upon the platform upon which
2688 the program is code generated.  For example, on x86, the address must be an
2689 unsigned 16-bit value, and the return value must be 8, 16, or 32 bits.
2690 </p>
2691
2692 </div>
2693
2694 <!-- _______________________________________________________________________ -->
2695 <div class="doc_subsubsection">
2696   <a name="i_writeport">'<tt>llvm.writeport</tt>' Intrinsic</a>
2697 </div>
2698
2699 <div class="doc_text">
2700
2701 <h5>Syntax:</h5>
2702 <pre>
2703   call void (&lt;integer type&gt;, &lt;integer type&gt;)*
2704             %llvm.writeport (&lt;integer type&gt; &lt;value&gt;,
2705                              &lt;integer type&gt; &lt;address&gt;)
2706 </pre>
2707
2708 <h5>Overview:</h5>
2709
2710 <p>
2711 The '<tt>llvm.writeport</tt>' intrinsic writes data to the specified hardware
2712 I/O port.
2713 </p>
2714
2715 <h5>Arguments:</h5>
2716
2717 <p>
2718 The first argument is the value to write to the I/O port.
2719 </p>
2720
2721 <p>
2722 The second argument indicates the hardware I/O address to which data should be
2723 written.  The address is in the hardware I/O address namespace (as opposed to
2724 being a memory location for memory mapped I/O).
2725 </p>
2726
2727 <h5>Semantics:</h5>
2728
2729 <p>
2730 The '<tt>llvm.writeport</tt>' intrinsic writes <i>value</i> to the I/O port
2731 specified by <i>address</i>.  The address and value must be integers, but the
2732 size is dependent upon the platform upon which the program is code generated.
2733 For example, on x86, the address must be an unsigned 16-bit value, and the
2734 value written must be 8, 16, or 32 bits in length.
2735 </p>
2736
2737 </div>
2738
2739 <!-- _______________________________________________________________________ -->
2740 <div class="doc_subsubsection">
2741   <a name="i_readio">'<tt>llvm.readio</tt>' Intrinsic</a>
2742 </div>
2743
2744 <div class="doc_text">
2745
2746 <h5>Syntax:</h5>
2747 <pre>
2748   declare &lt;result&gt; %llvm.readio (&lt;ty&gt; * &lt;pointer&gt;)
2749 </pre>
2750
2751 <h5>Overview:</h5>
2752
2753 <p>
2754 The '<tt>llvm.readio</tt>' intrinsic reads data from a memory mapped I/O
2755 address.
2756 </p>
2757
2758 <h5>Arguments:</h5>
2759
2760 <p>
2761 The argument to this intrinsic is a pointer indicating the memory address from
2762 which to read the data.  The data must be a
2763 <a href="#t_firstclass">first class</a> type.
2764 </p>
2765
2766 <h5>Semantics:</h5>
2767
2768 <p>
2769 The '<tt>llvm.readio</tt>' intrinsic reads data from a memory mapped I/O
2770 location specified by <i>pointer</i> and returns the value.  The argument must
2771 be a pointer, and the return value must be a
2772 <a href="#t_firstclass">first class</a> type.  However, certain architectures
2773 may not support I/O on all first class types.  For example, 32-bit processors
2774 may only support I/O on data types that are 32 bits or less.
2775 </p>
2776
2777 <p>
2778 This intrinsic enforces an in-order memory model for llvm.readio and
2779 llvm.writeio calls on machines that use dynamic scheduling.  Dynamically
2780 scheduled processors may execute loads and stores out of order, re-ordering at
2781 run time accesses to memory mapped I/O registers.  Using these intrinsics
2782 ensures that accesses to memory mapped I/O registers occur in program order.
2783 </p>
2784
2785 </div>
2786
2787 <!-- _______________________________________________________________________ -->
2788 <div class="doc_subsubsection">
2789   <a name="i_writeio">'<tt>llvm.writeio</tt>' Intrinsic</a>
2790 </div>
2791
2792 <div class="doc_text">
2793
2794 <h5>Syntax:</h5>
2795 <pre>
2796   declare void %llvm.writeio (&lt;ty1&gt; &lt;value&gt;, &lt;ty2&gt; * &lt;pointer&gt;)
2797 </pre>
2798
2799 <h5>Overview:</h5>
2800
2801 <p>
2802 The '<tt>llvm.writeio</tt>' intrinsic writes data to the specified memory
2803 mapped I/O address.
2804 </p>
2805
2806 <h5>Arguments:</h5>
2807
2808 <p>
2809 The first argument is the value to write to the memory mapped I/O location.
2810 The second argument is a pointer indicating the memory address to which the
2811 data should be written.
2812 </p>
2813
2814 <h5>Semantics:</h5>
2815
2816 <p>
2817 The '<tt>llvm.writeio</tt>' intrinsic writes <i>value</i> to the memory mapped
2818 I/O address specified by <i>pointer</i>.  The value must be a
2819 <a href="#t_firstclass">first class</a> type.  However, certain architectures
2820 may not support I/O on all first class types.  For example, 32-bit processors
2821 may only support I/O on data types that are 32 bits or less.
2822 </p>
2823
2824 <p>
2825 This intrinsic enforces an in-order memory model for llvm.readio and
2826 llvm.writeio calls on machines that use dynamic scheduling.  Dynamically
2827 scheduled processors may execute loads and stores out of order, re-ordering at
2828 run time accesses to memory mapped I/O registers.  Using these intrinsics
2829 ensures that accesses to memory mapped I/O registers occur in program order.
2830 </p>
2831
2832 </div>
2833
2834 <!-- ======================================================================= -->
2835 <div class="doc_subsection">
2836   <a name="int_libc">Standard C Library Intrinsics</a>
2837 </div>
2838
2839 <div class="doc_text">
2840 <p>
2841 LLVM provides intrinsics for a few important standard C library functions.
2842 These intrinsics allow source-language front-ends to pass information about the
2843 alignment of the pointer arguments to the code generator, providing opportunity
2844 for more efficient code generation.
2845 </p>
2846
2847 </div>
2848
2849 <!-- _______________________________________________________________________ -->
2850 <div class="doc_subsubsection">
2851   <a name="i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
2852 </div>
2853
2854 <div class="doc_text">
2855
2856 <h5>Syntax:</h5>
2857 <pre>
2858   declare void %llvm.memcpy(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
2859                             uint &lt;len&gt;, uint &lt;align&gt;)
2860 </pre>
2861
2862 <h5>Overview:</h5>
2863
2864 <p>
2865 The '<tt>llvm.memcpy</tt>' intrinsic copies a block of memory from the source
2866 location to the destination location.
2867 </p>
2868
2869 <p>
2870 Note that, unlike the standard libc function, the <tt>llvm.memcpy</tt> intrinsic
2871 does not return a value, and takes an extra alignment argument.
2872 </p>
2873
2874 <h5>Arguments:</h5>
2875
2876 <p>
2877 The first argument is a pointer to the destination, the second is a pointer to
2878 the source.  The third argument is an (arbitrarily sized) integer argument
2879 specifying the number of bytes to copy, and the fourth argument is the alignment
2880 of the source and destination locations.
2881 </p>
2882
2883 <p>
2884 If the call to this intrinisic has an alignment value that is not 0 or 1, then
2885 the caller guarantees that the size of the copy is a multiple of the alignment
2886 and that both the source and destination pointers are aligned to that boundary.
2887 </p>
2888
2889 <h5>Semantics:</h5>
2890
2891 <p>
2892 The '<tt>llvm.memcpy</tt>' intrinsic copies a block of memory from the source
2893 location to the destination location, which are not allowed to overlap.  It
2894 copies "len" bytes of memory over.  If the argument is known to be aligned to
2895 some boundary, this can be specified as the fourth argument, otherwise it should
2896 be set to 0 or 1.
2897 </p>
2898 </div>
2899
2900
2901 <!-- _______________________________________________________________________ -->
2902 <div class="doc_subsubsection">
2903   <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
2904 </div>
2905
2906 <div class="doc_text">
2907
2908 <h5>Syntax:</h5>
2909 <pre>
2910   declare void %llvm.memmove(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
2911                              uint &lt;len&gt;, uint &lt;align&gt;)
2912 </pre>
2913
2914 <h5>Overview:</h5>
2915
2916 <p>
2917 The '<tt>llvm.memmove</tt>' intrinsic moves a block of memory from the source
2918 location to the destination location. It is similar to the '<tt>llvm.memcpy</tt>'
2919 intrinsic but allows the two memory locations to overlap.
2920 </p>
2921
2922 <p>
2923 Note that, unlike the standard libc function, the <tt>llvm.memmove</tt> intrinsic
2924 does not return a value, and takes an extra alignment argument.
2925 </p>
2926
2927 <h5>Arguments:</h5>
2928
2929 <p>
2930 The first argument is a pointer to the destination, the second is a pointer to
2931 the source.  The third argument is an (arbitrarily sized) integer argument
2932 specifying the number of bytes to copy, and the fourth argument is the alignment
2933 of the source and destination locations.
2934 </p>
2935
2936 <p>
2937 If the call to this intrinisic has an alignment value that is not 0 or 1, then
2938 the caller guarantees that the size of the copy is a multiple of the alignment
2939 and that both the source and destination pointers are aligned to that boundary.
2940 </p>
2941
2942 <h5>Semantics:</h5>
2943
2944 <p>
2945 The '<tt>llvm.memmove</tt>' intrinsic copies a block of memory from the source
2946 location to the destination location, which may overlap.  It
2947 copies "len" bytes of memory over.  If the argument is known to be aligned to
2948 some boundary, this can be specified as the fourth argument, otherwise it should
2949 be set to 0 or 1.
2950 </p>
2951 </div>
2952
2953
2954 <!-- _______________________________________________________________________ -->
2955 <div class="doc_subsubsection">
2956   <a name="i_memset">'<tt>llvm.memset</tt>' Intrinsic</a>
2957 </div>
2958
2959 <div class="doc_text">
2960
2961 <h5>Syntax:</h5>
2962 <pre>
2963   declare void %llvm.memset(sbyte* &lt;dest&gt;, ubyte &lt;val&gt;,
2964                             uint &lt;len&gt;, uint &lt;align&gt;)
2965 </pre>
2966
2967 <h5>Overview:</h5>
2968
2969 <p>
2970 The '<tt>llvm.memset</tt>' intrinsic fills a block of memory with a particular
2971 byte value.
2972 </p>
2973
2974 <p>
2975 Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
2976 does not return a value, and takes an extra alignment argument.
2977 </p>
2978
2979 <h5>Arguments:</h5>
2980
2981 <p>
2982 The first argument is a pointer to the destination to fill, the second is the
2983 byte value to fill it with, the third argument is an (arbitrarily sized) integer
2984 argument specifying the number of bytes to fill, and the fourth argument is the
2985 known alignment of destination location.
2986 </p>
2987
2988 <p>
2989 If the call to this intrinisic has an alignment value that is not 0 or 1, then
2990 the caller guarantees that the size of the copy is a multiple of the alignment
2991 and that the destination pointer is aligned to that boundary.
2992 </p>
2993
2994 <h5>Semantics:</h5>
2995
2996 <p>
2997 The '<tt>llvm.memset</tt>' intrinsic fills "len" bytes of memory starting at the
2998 destination location.  If the argument is known to be aligned to some boundary,
2999 this can be specified as the fourth argument, otherwise it should be set to 0 or
3000 1.
3001 </p>
3002 </div>
3003
3004
3005 <!-- _______________________________________________________________________ -->
3006 <div class="doc_subsubsection">
3007   <a name="i_isunordered">'<tt>llvm.isunordered</tt>' Intrinsic</a>
3008 </div>
3009
3010 <div class="doc_text">
3011
3012 <h5>Syntax:</h5>
3013 <pre>
3014   declare bool %llvm.isunordered(&lt;float or double&gt; Val1, &lt;float or double&gt; Val2)
3015 </pre>
3016
3017 <h5>Overview:</h5>
3018
3019 <p>
3020 The '<tt>llvm.isunordered</tt>' intrinsic returns true if either or both of the
3021 specified floating point values is a NAN.
3022 </p>
3023
3024 <h5>Arguments:</h5>
3025
3026 <p>
3027 The arguments are floating point numbers of the same type.
3028 </p>
3029
3030 <h5>Semantics:</h5>
3031
3032 <p>
3033 If either or both of the arguments is a SNAN or QNAN, it returns true, otherwise
3034 false.
3035 </p>
3036 </div>
3037
3038
3039 <!-- ======================================================================= -->
3040 <div class="doc_subsection">
3041   <a name="int_count">Bit Counting Intrinsics</a>
3042 </div>
3043
3044 <div class="doc_text">
3045 <p>
3046 LLVM provides intrinsics for a few important bit counting operations.
3047 These allow efficient code generation for some algorithms.
3048 </p>
3049
3050 </div>
3051
3052 <!-- _______________________________________________________________________ -->
3053 <div class="doc_subsubsection">
3054   <a name="int_ctpop">'<tt>llvm.ctpop</tt>' Intrinsic</a>
3055 </div>
3056
3057 <div class="doc_text">
3058
3059 <h5>Syntax:</h5>
3060 <pre>
3061   declare int %llvm.ctpop(int &lt;src&gt;)
3062
3063 </pre>
3064
3065 <h5>Overview:</h5>
3066
3067 <p>
3068 The '<tt>llvm.ctpop</tt>' intrinsic counts the number of ones in a variable.
3069 </p>
3070
3071 <h5>Arguments:</h5>
3072
3073 <p>
3074 The only argument is the value to be counted.  The argument may be of any integer type.
3075 </p>
3076
3077 <h5>Semantics:</h5>
3078
3079 <p>
3080 The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
3081 </p>
3082 </div>
3083
3084 <!-- _______________________________________________________________________ -->
3085 <div class="doc_subsubsection">
3086   <a name="int_cttz">'<tt>llvm.cttz</tt>' Intrinsic</a>
3087 </div>
3088
3089 <div class="doc_text">
3090
3091 <h5>Syntax:</h5>
3092 <pre>
3093   declare int %llvm.cttz(int &lt;src&gt;)
3094
3095 </pre>
3096
3097 <h5>Overview:</h5>
3098
3099 <p>
3100 The '<tt>llvm.cttz</tt>' intrinsic counts the number of trailing zeros.
3101 </p>
3102
3103 <h5>Arguments:</h5>
3104
3105 <p>
3106 The only argument is the value to be counted.  The argument may be of any integer type.
3107 </p>
3108
3109 <h5>Semantics:</h5>
3110
3111 <p>
3112 The '<tt>llvm.cttz</tt>' intrinsic counts the trailing zeros in a variable.  If the src == 0
3113 then the result is the size in bits of the type of src.
3114 </p>
3115 </div>
3116
3117 <!-- _______________________________________________________________________ -->
3118 <div class="doc_subsubsection">
3119   <a name="int_ctlz">'<tt>llvm.ctlz</tt>' Intrinsic</a>
3120 </div>
3121
3122 <div class="doc_text">
3123
3124 <h5>Syntax:</h5>
3125 <pre>
3126   declare int %llvm.ctlz(int &lt;src&gt;)
3127
3128 </pre>
3129
3130 <h5>Overview:</h5>
3131
3132 <p>
3133 The '<tt>llvm.ctlz</tt>' intrinsic counts the number of leading zeros in a variable.
3134 </p>
3135
3136 <h5>Arguments:</h5>
3137
3138 <p>
3139 The only argument is the value to be counted.  The argument may be of any integer type.
3140 </p>
3141
3142 <h5>Semantics:</h5>
3143
3144 <p>
3145 The '<tt>llvm.ctlz</tt>' intrinsic counts the leading zeros in a variable.  If the src == 0
3146 then the result is the size in bits of the type of src.
3147 </p>
3148 </div>
3149
3150
3151 <!-- ======================================================================= -->
3152 <div class="doc_subsection">
3153   <a name="int_debugger">Debugger Intrinsics</a>
3154 </div>
3155
3156 <div class="doc_text">
3157 <p>
3158 The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
3159 are described in the <a
3160 href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
3161 Debugging</a> document.
3162 </p>
3163 </div>
3164
3165
3166 <!-- *********************************************************************** -->
3167 <hr>
3168 <address>
3169   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
3170   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
3171   <a href="http://validator.w3.org/check/referer"><img
3172   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
3173
3174   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
3175   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
3176   Last modified: $Date$
3177 </address>
3178 </body>
3179 </html>