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