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