docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4   <title>LLVM Assembly Language Reference Manual</title>
   5   <link rel="stylesheet" href="llvm.css" type="text/css">
   6 </head>
   7 <body>
   8 <div class="doc_title"> LLVM Language Reference Manual </div>
   9 <ol>
  10   <li><a href="#abstract">Abstract</a></li>
  11   <li><a href="#introduction">Introduction</a></li>
  12   <li><a href="#identifiers">Identifiers</a></li>
  13   <li><a href="#typesystem">Type System</a>
  14     <ol>
  15       <li><a href="#t_primitive">Primitive Types</a>
  16         <ol>
  17           <li><a href="#t_classifications">Type Classifications</a></li>
  18         </ol>
  19       </li>
  20       <li><a href="#t_derived">Derived Types</a>
  21         <ol>
  22           <li><a href="#t_array">Array Type</a></li>
  23           <li><a href="#t_function">Function Type</a></li>
  24           <li><a href="#t_pointer">Pointer Type</a></li>
  25           <li><a href="#t_struct">Structure Type</a></li>
  26 <!-- <li><a href="#t_packed" >Packed Type</a> -->
  27         </ol>
  28       </li>
  29     </ol>
  30   </li>
  31   <li><a href="#highlevel">High Level Structure</a>
  32     <ol>
  33       <li><a href="#modulestructure">Module Structure</a></li>
  34       <li><a href="#globalvars">Global Variables</a></li>
  35       <li><a href="#functionstructure">Function Structure</a></li>
  36     </ol>
  37   </li>
  38   <li><a href="#instref">Instruction Reference</a>
  39     <ol>
  40       <li><a href="#terminators">Terminator Instructions</a>
  41         <ol>
  42           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
  43           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
  44           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
  45           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
  46           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
  47         </ol>
  48       </li>
  49       <li><a href="#binaryops">Binary Operations</a>
  50         <ol>
  51           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
  52           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
  53           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
  54           <li><a href="#i_div">'<tt>div</tt>' Instruction</a></li>
  55           <li><a href="#i_rem">'<tt>rem</tt>' Instruction</a></li>
  56           <li><a href="#i_setcc">'<tt>set<i>cc</i></tt>' Instructions</a></li>
  57         </ol>
  58       </li>
  59       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
  60         <ol>
  61           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
  62           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
  63           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
  64           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
  65           <li><a href="#i_shr">'<tt>shr</tt>' Instruction</a></li>
  66         </ol>
  67       </li>
  68       <li><a href="#memoryops">Memory Access Operations</a>
  69         <ol>
  70           <li><a href="#i_malloc">'<tt>malloc</tt>'   Instruction</a></li>
  71           <li><a href="#i_free">'<tt>free</tt>'     Instruction</a></li>
  72           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
  73          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
  74          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
  75          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
  76         </ol>
  77       </li>
  78       <li><a href="#otherops">Other Operations</a>
  79         <ol>
  80           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
  81           <li><a href="#i_cast">'<tt>cast .. to</tt>' Instruction</a></li>
  82           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
  83           <li><a href="#i_vanext">'<tt>vanext</tt>' Instruction</a></li>
  84           <li><a href="#i_vaarg">'<tt>vaarg</tt>'  Instruction</a></li>
  85         </ol>
  86       </li>
  87     </ol>
  88   </li>
  89   <li><a href="#intrinsics">Intrinsic Functions</a>
  90     <ol>
  91       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
  92         <ol>
  93           <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
  94           <li><a href="#i_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
  95           <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
  96         </ol>
  97       </li>
  98       <li><a href="#int_debugger">Debugger intrinsics</a>
  99     </ol>
 100   </li>
 101 </ol>
 102 <div class="doc_text">
 103 <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 104 and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></b></p>
 105 <p> </p>
 106 </div>
 107 <!-- *********************************************************************** -->
 108 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 109 <!-- *********************************************************************** -->
 110 <div class="doc_text">
 111 <p>This document is a reference manual for the LLVM assembly language.
 112 LLVM is an SSA based representation that provides type safety,
 113 low-level operations, flexibility, and the capability of representing
 114 'all' high-level languages cleanly.  It is the common code
 115 representation used throughout all phases of the LLVM compilation
 116 strategy.</p>
 117 </div>
 118 <!-- *********************************************************************** -->
 119 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 120 <!-- *********************************************************************** -->
 121 <div class="doc_text">
 122 <p>The LLVM code representation is designed to be used in three
 123 different forms: as an in-memory compiler IR, as an on-disk bytecode
 124 representation (suitable for fast loading by a Just-In-Time compiler),
 125 and as a human readable assembly language representation.  This allows
 126 LLVM to provide a powerful intermediate representation for efficient
 127 compiler transformations and analysis, while providing a natural means
 128 to debug and visualize the transformations.  The three different forms
 129 of LLVM are all equivalent.  This document describes the human readable
 130 representation and notation.</p>
 131 <p>The LLVM representation aims to be a light-weight and low-level
 132 while being expressive, typed, and extensible at the same time.  It
 133 aims to be a "universal IR" of sorts, by being at a low enough level
 134 that high-level ideas may be cleanly mapped to it (similar to how
 135 microprocessors are "universal IR's", allowing many source languages to
 136 be mapped to them).  By providing type information, LLVM can be used as
 137 the target of optimizations: for example, through pointer analysis, it
 138 can be proven that a C automatic variable is never accessed outside of
 139 the current function... allowing it to be promoted to a simple SSA
 140 value instead of a memory location.</p>
 141 </div>
 142 <!-- _______________________________________________________________________ -->
 143 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 144 <div class="doc_text">
 145 <p>It is important to note that this document describes 'well formed'
 146 LLVM assembly language.  There is a difference between what the parser
 147 accepts and what is considered 'well formed'.  For example, the
 148 following instruction is syntactically okay, but not well formed:</p>
 149 <pre>  %x = <a href="#i_add">add</a> int 1, %x<br></pre>
 150 <p>...because the definition of <tt>%x</tt> does not dominate all of
 151 its uses. The LLVM infrastructure provides a verification pass that may
 152 be used to verify that an LLVM module is well formed.  This pass is
 153 automatically run by the parser after parsing input assembly, and by
 154 the optimizer before it outputs bytecode.  The violations pointed out
 155 by the verifier pass indicate bugs in transformation passes or input to
 156 the parser.</p>
 157 <!-- Describe the typesetting conventions here. --> </div>
 158 <!-- *********************************************************************** -->
 159 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 160 <!-- *********************************************************************** -->
 161 <div class="doc_text">
 162 <p>LLVM uses three different forms of identifiers, for different
 163 purposes:</p>
 164 <ol>
 165   <li>Numeric constants are represented as you would expect: 12, -3
 166 123.421,   etc.  Floating point constants have an optional hexidecimal
 167 notation.</li>
 168   <li>Named values are represented as a string of characters with a '%'
 169 prefix.   For example, %foo, %DivisionByZero,
 170 %a.really.long.identifier.  The actual   regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
 171 Identifiers which require other characters in their names can be
 172 surrounded   with quotes.  In this way, anything except a <tt>"</tt>
 173 character can be used   in a name.</li>
 174   <li>Unnamed values are represented as an unsigned numeric value with
 175 a '%'   prefix.  For example, %12, %2, %44.</li>
 176 </ol>
 177 <p>LLVM requires the values start with a '%' sign for two reasons:
 178 Compilers don't need to worry about name clashes with reserved words,
 179 and the set of reserved words may be expanded in the future without
 180 penalty.  Additionally, unnamed identifiers allow a compiler to quickly
 181 come up with a temporary variable without having to avoid symbol table
 182 conflicts.</p>
 183 <p>Reserved words in LLVM are very similar to reserved words in other
 184 languages. There are keywords for different opcodes ('<tt><a
 185  href="#i_add">add</a></tt>', '<tt><a href="#i_cast">cast</a></tt>', '<tt><a
 186  href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
 187  href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>',
 188 etc...), and others.  These reserved words cannot conflict with
 189 variable names, because none of them start with a '%' character.</p>
 190 <p>Here is an example of LLVM code to multiply the integer variable '<tt>%X</tt>'
 191 by 8:</p>
 192 <p>The easy way:</p>
 193 <pre>  %result = <a href="#i_mul">mul</a> uint %X, 8<br></pre>
 194 <p>After strength reduction:</p>
 195 <pre>  %result = <a href="#i_shl">shl</a> uint %X, ubyte 3<br></pre>
 196 <p>And the hard way:</p>
 197 <pre>  <a href="#i_add">add</a> uint %X, %X           <i>; yields {uint}:%0</i>
 198   <a
 199  href="#i_add">add</a> uint %0, %0           <i>; yields {uint}:%1</i>
 200   %result = <a
 201  href="#i_add">add</a> uint %1, %1<br></pre>
 202 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
 203 important lexical features of LLVM:</p>
 204 <ol>
 205   <li>Comments are delimited with a '<tt>;</tt>' and go until the end
 206 of   line.</li>
 207   <li>Unnamed temporaries are created when the result of a computation
 208 is not   assigned to a named value.</li>
 209   <li>Unnamed temporaries are numbered sequentially</li>
 210 </ol>
 211 <p>...and it also show a convention that we follow in this document.
 212 When demonstrating instructions, we will follow an instruction with a
 213 comment that defines the type and name of value produced.  Comments are
 214 shown in italic text.</p>
 215 <p>The one non-intuitive notation for constants is the optional
 216 hexidecimal form of floating point constants.  For example, the form '<tt>double
 217 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
 218 4.5e+15</tt>' which is also supported by the parser.  The only time
 219 hexadecimal floating point constants are useful (and the only time that
 220 they are generated by the disassembler) is when an FP constant has to
 221 be emitted that is not representable as a decimal floating point number
 222 exactly.  For example, NaN's, infinities, and other special cases are
 223 represented in their IEEE hexadecimal format so that assembly and
 224 disassembly do not cause any bits to change in the constants.</p>
 225 </div>
 226 <!-- *********************************************************************** -->
 227 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
 228 <!-- *********************************************************************** -->
 229 <div class="doc_text">
 230 <p>The LLVM type system is one of the most important features of the
 231 intermediate representation.  Being typed enables a number of
 232 optimizations to be performed on the IR directly, without having to do
 233 extra analyses on the side before the transformation.  A strong type
 234 system makes it easier to read the generated code and enables novel
 235 analyses and transformations that are not feasible to perform on normal
 236 three address code representations.</p>
 237 <!-- The written form for the type system was heavily influenced by the
 238 syntactic problems with types in the C language<sup><a
 239 href="#rw_stroustrup">1</a></sup>.<p> --> </div>
 240 <!-- ======================================================================= -->
 241 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
 242 <div class="doc_text">
 243 <p>The primitive types are the fundemental building blocks of the LLVM
 244 system. The current set of primitive types are as follows:</p>
 245 <p>
 246 <table border="0" align="center">
 247   <tbody>
 248     <tr>
 249       <td>
 250       <table border="1" cellspacing="0" cellpadding="4" align="center">
 251         <tbody>
 252           <tr>
 253             <td><tt>void</tt></td>
 254             <td>No value</td>
 255           </tr>
 256           <tr>
 257             <td><tt>ubyte</tt></td>
 258             <td>Unsigned 8 bit value</td>
 259           </tr>
 260           <tr>
 261             <td><tt>ushort</tt></td>
 262             <td>Unsigned 16 bit value</td>
 263           </tr>
 264           <tr>
 265             <td><tt>uint</tt></td>
 266             <td>Unsigned 32 bit value</td>
 267           </tr>
 268           <tr>
 269             <td><tt>ulong</tt></td>
 270             <td>Unsigned 64 bit value</td>
 271           </tr>
 272           <tr>
 273             <td><tt>float</tt></td>
 274             <td>32 bit floating point value</td>
 275           </tr>
 276           <tr>
 277             <td><tt>label</tt></td>
 278             <td>Branch destination</td>
 279           </tr>
 280         </tbody>
 281       </table>
 282       </td>
 283       <td valign="top">
 284       <table border="1" cellspacing="0" cellpadding="4" align="center&quot;">
 285         <tbody>
 286           <tr>
 287             <td><tt>bool</tt></td>
 288             <td>True or False value</td>
 289           </tr>
 290           <tr>
 291             <td><tt>sbyte</tt></td>
 292             <td>Signed 8 bit value</td>
 293           </tr>
 294           <tr>
 295             <td><tt>short</tt></td>
 296             <td>Signed 16 bit value</td>
 297           </tr>
 298           <tr>
 299             <td><tt>int</tt></td>
 300             <td>Signed 32 bit value</td>
 301           </tr>
 302           <tr>
 303             <td><tt>long</tt></td>
 304             <td>Signed 64 bit value</td>
 305           </tr>
 306           <tr>
 307             <td><tt>double</tt></td>
 308             <td>64 bit floating point value</td>
 309           </tr>
 310         </tbody>
 311       </table>
 312       </td>
 313     </tr>
 314   </tbody>
 315 </table>
 316 </p>
 317 </div>
 318 <!-- _______________________________________________________________________ -->
 319 <div class="doc_subsubsection"> <a name="t_classifications">Type
 320 Classifications</a> </div>
 321 <div class="doc_text">
 322 <p>These different primitive types fall into a few useful
 323 classifications:</p>
 324 <p>
 325 <table border="1" cellspacing="0" cellpadding="4" align="center">
 326   <tbody>
 327     <tr>
 328       <td><a name="t_signed">signed</a></td>
 329       <td><tt>sbyte, short, int, long, float, double</tt></td>
 330     </tr>
 331     <tr>
 332       <td><a name="t_unsigned">unsigned</a></td>
 333       <td><tt>ubyte, ushort, uint, ulong</tt></td>
 334     </tr>
 335     <tr>
 336       <td><a name="t_integer">integer</a></td>
 337       <td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td>
 338     </tr>
 339     <tr>
 340       <td><a name="t_integral">integral</a></td>
 341       <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td>
 342     </tr>
 343     <tr>
 344       <td><a name="t_floating">floating point</a></td>
 345       <td><tt>float, double</tt></td>
 346     </tr>
 347     <tr>
 348       <td><a name="t_firstclass">first class</a></td>
 349       <td><tt>bool, ubyte, sbyte, ushort, short,<br>
 350 uint, int, ulong, long, float, double, <a href="#t_pointer">pointer</a></tt></td>
 351     </tr>
 352   </tbody>
 353 </table>
 354 </p>
 355 <p>The <a href="#t_firstclass">first class</a> types are perhaps the
 356 most important.  Values of these types are the only ones which can be
 357 produced by instructions, passed as arguments, or used as operands to
 358 instructions.  This means that all structures and arrays must be
 359 manipulated either by pointer or by component.</p>
 360 </div>
 361 <!-- ======================================================================= -->
 362 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
 363 <div class="doc_text">
 364 <p>The real power in LLVM comes from the derived types in the system.
 365 This is what allows a programmer to represent arrays, functions,
 366 pointers, and other useful types.  Note that these derived types may be
 367 recursive: For example, it is possible to have a two dimensional array.</p>
 368 </div>
 369 <!-- _______________________________________________________________________ -->
 370 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
 371 <div class="doc_text">
 372 <h5>Overview:</h5>
 373 <p>The array type is a very simple derived type that arranges elements
 374 sequentially in memory.  The array type requires a size (number of
 375 elements) and an underlying data type.</p>
 376 <h5>Syntax:</h5>
 377 <pre>  [&lt;# elements&gt; x &lt;elementtype&gt;]<br></pre>
 378 <p>The number of elements is a constant integer value, elementtype may
 379 be any type with a size.</p>
 380 <h5>Examples:</h5>
 381 <p> <tt>[40 x int ]</tt>: Array of 40 integer values.<br>
 382 <tt>[41 x int ]</tt>: Array of 41 integer values.<br>
 383 <tt>[40 x uint]</tt>: Array of 40 unsigned integer values.</p>
 384 <p> </p>
 385 <p>Here are some examples of multidimensional arrays:</p>
 386 <p>
 387 <table border="0" cellpadding="0" cellspacing="0">
 388   <tbody>
 389     <tr>
 390       <td><tt>[3 x [4 x int]]</tt></td>
 391       <td>: 3x4 array integer values.</td>
 392     </tr>
 393     <tr>
 394       <td><tt>[12 x [10 x float]]</tt></td>
 395       <td>: 12x10 array of single precision floating point values.</td>
 396     </tr>
 397     <tr>
 398       <td><tt>[2 x [3 x [4 x uint]]]</tt></td>
 399       <td>: 2x3x4 array of unsigned integer values.</td>
 400     </tr>
 401   </tbody>
 402 </table>
 403 </p>
 404 </div>
 405 <!-- _______________________________________________________________________ -->
 406 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
 407 <div class="doc_text">
 408 <h5>Overview:</h5>
 409 <p>The function type can be thought of as a function signature.  It
 410 consists of a return type and a list of formal parameter types.
 411 Function types are usually used to build virtual function tables
 412 (which are structures of pointers to functions), for indirect function
 413 calls, and when defining a function.</p>
 414 <p>
 415 The return type of a function type cannot be an aggregate type.
 416 </p>
 417 <h5>Syntax:</h5>
 418 <pre>  &lt;returntype&gt; (&lt;parameter list&gt;)<br></pre>
 419 <p>Where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of
 420 type specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
 421 which indicates that the function takes a variable number of arguments.
 422 Variable argument functions can access their arguments with the <a
 423  href="#int_varargs">variable argument handling intrinsic</a> functions.</p>
 424 <h5>Examples:</h5>
 425 <p>
 426 <table border="0" cellpadding="0" cellspacing="0">
 427   <tbody>
 428     <tr>
 429       <td><tt>int (int)</tt></td>
 430       <td>: function taking an <tt>int</tt>, returning an <tt>int</tt></td>
 431     </tr>
 432     <tr>
 433       <td><tt>float (int, int *) *</tt></td>
 434       <td>: <a href="#t_pointer">Pointer</a> to a function that takes
 435 an <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>,
 436 returning <tt>float</tt>.</td>
 437     </tr>
 438     <tr>
 439       <td><tt>int (sbyte *, ...)</tt></td>
 440       <td>: A vararg function that takes at least one <a
 441  href="#t_pointer">pointer</a> to <tt>sbyte</tt> (signed char in C),
 442 which       returns an integer.  This is the signature for <tt>printf</tt>
 443 in LLVM.</td>
 444     </tr>
 445   </tbody>
 446 </table>
 447 </p>
 448 </div>
 449 <!-- _______________________________________________________________________ -->
 450 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
 451 <div class="doc_text">
 452 <h5>Overview:</h5>
 453 <p>The structure type is used to represent a collection of data members
 454 together in memory.  The packing of the field types is defined to match
 455 the ABI of the underlying processor.  The elements of a structure may
 456 be any type that has a size.</p>
 457 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
 458 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
 459 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
 460 instruction.</p>
 461 <h5>Syntax:</h5>
 462 <pre>  { &lt;type list&gt; }<br></pre>
 463 <h5>Examples:</h5>
 464 <p>
 465 <table border="0" cellpadding="0" cellspacing="0">
 466   <tbody>
 467     <tr>
 468       <td><tt>{ int, int, int }</tt></td>
 469       <td>: a triple of three <tt>int</tt> values</td>
 470     </tr>
 471     <tr>
 472       <td><tt>{ float, int (int) * }</tt></td>
 473       <td>: A pair, where the first element is a <tt>float</tt> and the
 474 second       element is a <a href="#t_pointer">pointer</a> to a <a
 475  href="t_function">function</a> that takes an <tt>int</tt>, returning
 476 an <tt>int</tt>.</td>
 477     </tr>
 478   </tbody>
 479 </table>
 480 </p>
 481 </div>
 482 <!-- _______________________________________________________________________ -->
 483 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
 484 <div class="doc_text">
 485 <h5>Overview:</h5>
 486 <p>As in many languages, the pointer type represents a pointer or
 487 reference to another object, which must live in memory.</p>
 488 <h5>Syntax:</h5>
 489 <pre>  &lt;type&gt; *<br></pre>
 490 <h5>Examples:</h5>
 491 <p>
 492 <table border="0" cellpadding="0" cellspacing="0">
 493   <tbody>
 494     <tr>
 495       <td><tt>[4x int]*</tt></td>
 496       <td>: <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a>
 497 of four <tt>int</tt> values</td>
 498     </tr>
 499     <tr>
 500       <td><tt>int (int *) *</tt></td>
 501       <td>: A <a href="#t_pointer">pointer</a> to a <a
 502  href="t_function">function</a> that takes an <tt>int</tt>, returning
 503 an <tt>int</tt>.</td>
 504     </tr>
 505   </tbody>
 506 </table>
 507 </p>
 508 </div>
 509 <!-- _______________________________________________________________________ --><!--
 510 <div class="doc_subsubsection">
 511   <a name="t_packed">Packed Type</a>
 512 </div>
 513
 514 <div class="doc_text">
 515
 516 Mention/decide that packed types work with saturation or not. Maybe have a packed+saturated type in addition to just a packed type.<p>
 517
 518 Packed types should be 'nonsaturated' because standard data types are not saturated.  Maybe have a saturated packed type?<p>
 519
 520 </div>
 521
 522 --><!-- *********************************************************************** -->
 523 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 524 <!-- *********************************************************************** --><!-- ======================================================================= -->
 525 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a> </div>
 526 <div class="doc_text">
 527 <p>LLVM programs are composed of "Module"s, each of which is a
 528 translation unit of the input programs.  Each module consists of
 529 functions, global variables, and symbol table entries.  Modules may be
 530 combined together with the LLVM linker, which merges function (and
 531 global variable) definitions, resolves forward declarations, and merges
 532 symbol table entries. Here is an example of the "hello world" module:</p>
 533 <pre><i>; Declare the string constant as a global constant...</i>
 534 <a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a
 535  href="#globalvars">constant</a> <a href="#t_array">[13 x sbyte]</a> c"hello world\0A\00"          <i>; [13 x sbyte]*</i>
 536
 537 <i>; External declaration of the puts function</i>
 538 <a href="#functionstructure">declare</a> int %puts(sbyte*)                                            <i>; int(sbyte*)* </i>
 539
 540 <i>; Definition of main function</i>
 541 int %main() {                                                        <i>; int()* </i>
 542         <i>; Convert [13x sbyte]* to sbyte *...</i>
 543         %cast210 = <a
 544  href="#i_getelementptr">getelementptr</a> [13 x sbyte]* %.LC0, long 0, long 0 <i>; sbyte*</i>
 545
 546         <i>; Call puts function to write out the string to stdout...</i>
 547         <a
 548  href="#i_call">call</a> int %puts(sbyte* %cast210)                              <i>; int</i>
 549         <a
 550  href="#i_ret">ret</a> int 0<br>}<br></pre>
 551 <p>This example is made up of a <a href="#globalvars">global variable</a>
 552 named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
 553 function, and a <a href="#functionstructure">function definition</a>
 554 for "<tt>main</tt>".</p>
 555 <a name="linkage"> In general, a module is made up of a list of global
 556 values, where both functions and global variables are global values.
 557 Global values are represented by a pointer to a memory location (in
 558 this case, a pointer to an array of char, and a pointer to a function),
 559 and have one of the following linkage types:</a>
 560 <p> </p>
 561 <dl>
 562   <a name="linkage_internal"> <dt><tt><b>internal</b></tt> </dt>
 563   <dd>Global values with internal linkage are only directly accessible
 564 by objects in the current module.  In particular, linking code into a
 565 module with an internal global value may cause the internal to be
 566 renamed as necessary to avoid collisions.  Because the symbol is
 567 internal to the module, all references can be updated.  This
 568 corresponds to the notion of the '<tt>static</tt>' keyword in C, or the
 569 idea of "anonymous namespaces" in C++.
 570     <p> </p>
 571   </dd>
 572   </a><a name="linkage_linkonce"> <dt><tt><b>linkonce</b></tt>: </dt>
 573   <dd>"<tt>linkonce</tt>" linkage is similar to <tt>internal</tt>
 574 linkage, with the twist that linking together two modules defining the
 575 same <tt>linkonce</tt> globals will cause one of the globals to be
 576 discarded.  This is typically used to implement inline functions.
 577 Unreferenced <tt>linkonce</tt> globals are allowed to be discarded.
 578     <p> </p>
 579   </dd>
 580   </a><a name="linkage_weak"> <dt><tt><b>weak</b></tt>: </dt>
 581   <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt>
 582 linkage, except that unreferenced <tt>weak</tt> globals may not be
 583 discarded.  This is used to implement constructs in C such as "<tt>int
 584 X;</tt>" at global scope.
 585     <p> </p>
 586   </dd>
 587   </a><a name="linkage_appending"> <dt><tt><b>appending</b></tt>: </dt>
 588   <dd>"<tt>appending</tt>" linkage may only be applied to global
 589 variables of pointer to array type.  When two global variables with
 590 appending linkage are linked together, the two global arrays are
 591 appended together.  This is the LLVM, typesafe, equivalent of having
 592 the system linker append together "sections" with identical names when
 593 .o files are linked.
 594     <p> </p>
 595   </dd>
 596   </a><a name="linkage_external"> <dt><tt><b>externally visible</b></tt>:</dt>
 597   <dd>If none of the above identifiers are used, the global is
 598 externally visible, meaning that it participates in linkage and can be
 599 used to resolve external symbol references.
 600     <p> </p>
 601   </dd>
 602   </a>
 603 </dl>
 604 <p> </p>
 605 <p><a name="linkage_external">For example, since the "<tt>.LC0</tt>"
 606 variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
 607 variable and was linked with this one, one of the two would be renamed,
 608 preventing a collision.  Since "<tt>main</tt>" and "<tt>puts</tt>" are
 609 external (i.e., lacking any linkage declarations), they are accessible
 610 outside of the current module.  It is illegal for a function <i>declaration</i>
 611 to have any linkage type other than "externally visible".</a></p>
 612 </div>
 613 <!-- ======================================================================= -->
 614 <div class="doc_subsection"> <a name="globalvars">Global Variables</a> </div>
 615 <div class="doc_text">
 616 <p>Global variables define regions of memory allocated at compilation
 617 time instead of run-time.  Global variables may optionally be
 618 initialized.  A variable may be defined as a global "constant", which
 619 indicates that the contents of the variable will never be modified
 620 (opening options for optimization).  Constants must always have an
 621 initial value.</p>
 622 <p>As SSA values, global variables define pointer values that are in
 623 scope (i.e. they dominate) for all basic blocks in the program.  Global
 624 variables always define a pointer to their "content" type because they
 625 describe a region of memory, and all memory objects in LLVM are
 626 accessed through pointers.</p>
 627 </div>
 628 <!-- ======================================================================= -->
 629 <div class="doc_subsection"> <a name="functionstructure">Functions</a> </div>
 630 <div class="doc_text">
 631 <p>LLVM function definitions are composed of a (possibly empty)
 632 argument list, an opening curly brace, a list of basic blocks, and a
 633 closing curly brace.  LLVM function declarations are defined with the "<tt>declare</tt>"
 634 keyword, a function name, and a function signature.</p>
 635 <p>A function definition contains a list of basic blocks, forming the
 636 CFG for the function.  Each basic block may optionally start with a
 637 label (giving the basic block a symbol table entry), contains a list of
 638 instructions, and ends with a <a href="#terminators">terminator</a>
 639 instruction (such as a branch or function return).</p>
 640 <p>The first basic block in program is special in two ways: it is
 641 immediately executed on entrance to the function, and it is not allowed
 642 to have predecessor basic blocks (i.e. there can not be any branches to
 643 the entry block of a function).  Because the block can have no
 644 predecessors, it also cannot have any <a href="#i_phi">PHI nodes</a>.</p>
 645 <p>
 646 LLVM functions are identified by their name and type signature.  Hence, two
 647 functions with the same name but different parameter lists or return values
 648 are considered different functions, and LLVM will resolves references to each
 649 appropriately.
 650 </p>
 651 </div>
 652 <!-- *********************************************************************** -->
 653 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
 654 <!-- *********************************************************************** -->
 655 <div class="doc_text">
 656 <p>The LLVM instruction set consists of several different
 657 classifications of instructions: <a href="#terminators">terminator
 658 instructions</a>, <a href="#binaryops">binary instructions</a>, <a
 659  href="#memoryops">memory instructions</a>, and <a href="#otherops">other
 660 instructions</a>.</p>
 661 </div>
 662 <!-- ======================================================================= -->
 663 <div class="doc_subsection"> <a name="terminators">Terminator
 664 Instructions</a> </div>
 665 <div class="doc_text">
 666 <p>As mentioned <a href="#functionstructure">previously</a>, every
 667 basic block in a program ends with a "Terminator" instruction, which
 668 indicates which block should be executed after the current block is
 669 finished. These terminator instructions typically yield a '<tt>void</tt>'
 670 value: they produce control flow, not values (the one exception being
 671 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
 672 <p>There are five different terminator instructions: the '<a
 673  href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
 674 instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
 675 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, and the '<a
 676  href="#i_unwind"><tt>unwind</tt></a>' instruction.</p>
 677 </div>
 678 <!-- _______________________________________________________________________ -->
 679 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
 680 Instruction</a> </div>
 681 <div class="doc_text">
 682 <h5>Syntax:</h5>
 683 <pre>  ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
 684   ret void                 <i>; Return from void function</i>
 685 </pre>
 686 <h5>Overview:</h5>
 687 <p>The '<tt>ret</tt>' instruction is used to return control flow (and a
 688 value) from a function, back to the caller.</p>
 689 <p>There are two forms of the '<tt>ret</tt>' instructruction: one that
 690 returns a value and then causes control flow, and one that just causes
 691 control flow to occur.</p>
 692 <h5>Arguments:</h5>
 693 <p>The '<tt>ret</tt>' instruction may return any '<a
 694  href="#t_firstclass">first class</a>' type.  Notice that a function is
 695 not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>'
 696 instruction inside of the function that returns a value that does not
 697 match the return type of the function.</p>
 698 <h5>Semantics:</h5>
 699 <p>When the '<tt>ret</tt>' instruction is executed, control flow
 700 returns back to the calling function's context.  If the caller is a "<a
 701  href="#i_call"><tt>call</tt></a> instruction, execution continues at
 702 the instruction after the call.  If the caller was an "<a
 703  href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
 704 at the beginning "normal" of the destination block.  If the instruction
 705 returns a value, that value shall set the call or invoke instruction's
 706 return value.</p>
 707 <h5>Example:</h5>
 708 <pre>  ret int 5                       <i>; Return an integer value of 5</i>
 709   ret void                        <i>; Return from a void function</i>
 710 </pre>
 711 </div>
 712 <!-- _______________________________________________________________________ -->
 713 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
 714 <div class="doc_text">
 715 <h5>Syntax:</h5>
 716 <pre>  br bool &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
 717 </pre>
 718 <h5>Overview:</h5>
 719 <p>The '<tt>br</tt>' instruction is used to cause control flow to
 720 transfer to a different basic block in the current function.  There are
 721 two forms of this instruction, corresponding to a conditional branch
 722 and an unconditional branch.</p>
 723 <h5>Arguments:</h5>
 724 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a
 725 single '<tt>bool</tt>' value and two '<tt>label</tt>' values.  The
 726 unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>'
 727 value as a target.</p>
 728 <h5>Semantics:</h5>
 729 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>'
 730 argument is evaluated.  If the value is <tt>true</tt>, control flows
 731 to the '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
 732 control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
 733 <h5>Example:</h5>
 734 <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
 735  href="#i_ret">ret</a> int 1<br>IfUnequal:<br>  <a href="#i_ret">ret</a> int 0<br></pre>
 736 </div>
 737 <!-- _______________________________________________________________________ -->
 738 <div class="doc_subsubsection"> <a name="i_switch">'<tt>switch</tt>'
 739 Instruction</a> </div>
 740 <div class="doc_text">
 741 <h5>Syntax:</h5>
 742 <pre>  switch uint &lt;value&gt;, label &lt;defaultdest&gt; [ int &lt;val&gt;, label &amp;dest&gt;, ... ]<br></pre>
 743 <h5>Overview:</h5>
 744 <p>The '<tt>switch</tt>' instruction is used to transfer control flow
 745 to one of several different places.  It is a generalization of the '<tt>br</tt>'
 746 instruction, allowing a branch to occur to one of many possible
 747 destinations.</p>
 748 <h5>Arguments:</h5>
 749 <p>The '<tt>switch</tt>' instruction uses three parameters: a '<tt>uint</tt>'
 750 comparison value '<tt>value</tt>', a default '<tt>label</tt>'
 751 destination, and an array of pairs of comparison value constants and '<tt>label</tt>'s.</p>
 752 <h5>Semantics:</h5>
 753 <p>The <tt>switch</tt> instruction specifies a table of values and
 754 destinations. When the '<tt>switch</tt>' instruction is executed, this
 755 table is searched for the given value.  If the value is found, the
 756 corresponding destination is branched to, otherwise the default value
 757 it transfered to.</p>
 758 <h5>Implementation:</h5>
 759 <p>Depending on properties of the target machine and the particular <tt>switch</tt>
 760 instruction, this instruction may be code generated as a series of
 761 chained conditional branches, or with a lookup table.</p>
 762 <h5>Example:</h5>
 763 <pre>  <i>; Emulate a conditional br instruction</i>
 764   %Val = <a
 765  href="#i_cast">cast</a> bool %value to uint<br>  switch uint %Val, label %truedest [int 0, label %falsedest ]<br><br>  <i>; Emulate an unconditional br instruction</i>
 766   switch uint 0, label %dest [ ]
 767
 768   <i>; Implement a jump table:</i>
 769   switch uint %val, label %otherwise [ int 0, label %onzero,
 770                                        int 1, label %onone,
 771                                        int 2, label %ontwo ]
 772 </pre>
 773 </div>
 774 <!-- _______________________________________________________________________ -->
 775 <div class="doc_subsubsection"> <a name="i_invoke">'<tt>invoke</tt>'
 776 Instruction</a> </div>
 777 <div class="doc_text">
 778 <h5>Syntax:</h5>
 779 <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>
 780 <h5>Overview:</h5>
 781 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a
 782 specified function, with the possibility of control flow transfer to
 783 either the '<tt>normal</tt>' <tt>label</tt> label or the '<tt>exception</tt>'<tt>label</tt>.
 784 If the callee function returns with the "<tt><a href="#i_ret">ret</a></tt>"
 785 instruction, control flow will return to the "normal" label.  If the
 786 callee (or any indirect callees) returns with the "<a href="#i_unwind"><tt>unwind</tt></a>"
 787 instruction, control is interrupted, and continued at the dynamically
 788 nearest "except" label.</p>
 789 <h5>Arguments:</h5>
 790 <p>This instruction requires several arguments:</p>
 791 <ol>
 792   <li>'<tt>ptr to function ty</tt>': shall be the signature of the
 793 pointer to function value being invoked.  In most cases, this is a
 794 direct function invocation, but indirect <tt>invoke</tt>s are just as
 795 possible, branching off an arbitrary pointer to function value. </li>
 796   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer
 797 to a function to be invoked. </li>
 798   <li>'<tt>function args</tt>': argument list whose types match the
 799 function signature argument types.  If the function signature indicates
 800 the function accepts a variable number of arguments, the extra
 801 arguments can be specified. </li>
 802   <li>'<tt>normal label</tt>': the label reached when the called
 803 function executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
 804   <li>'<tt>exception label</tt>': the label reached when a callee
 805 returns with the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
 806 </ol>
 807 <h5>Semantics:</h5>
 808 <p>This instruction is designed to operate as a standard '<tt><a
 809  href="#i_call">call</a></tt>' instruction in most regards.  The
 810 primary difference is that it establishes an association with a label,
 811 which is used by the runtime library to unwind the stack.</p>
 812 <p>This instruction is used in languages with destructors to ensure
 813 that proper cleanup is performed in the case of either a <tt>longjmp</tt>
 814 or a thrown exception.  Additionally, this is important for
 815 implementation of '<tt>catch</tt>' clauses in high-level languages that
 816 support them.</p>
 817 <h5>Example:</h5>
 818 <pre>  %retval = invoke int %Test(int 15)<br>              to label %Continue<br>              except label %TestCleanup     <i>; {int}:retval set</i>
 819 </pre>
 820 </div>
 821 <!-- _______________________________________________________________________ -->
 822 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
 823 Instruction</a> </div>
 824 <div class="doc_text">
 825 <h5>Syntax:</h5>
 826 <pre>  unwind<br></pre>
 827 <h5>Overview:</h5>
 828 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing
 829 control flow at the first callee in the dynamic call stack which used
 830 an <a href="#i_invoke"><tt>invoke</tt></a> instruction to perform the
 831 call.  This is primarily used to implement exception handling.</p>
 832 <h5>Semantics:</h5>
 833 <p>The '<tt>unwind</tt>' intrinsic causes execution of the current
 834 function to immediately halt.  The dynamic call stack is then searched
 835 for the first <a href="#i_invoke"><tt>invoke</tt></a> instruction on
 836 the call stack.  Once found, execution continues at the "exceptional"
 837 destination block specified by the <tt>invoke</tt> instruction.  If
 838 there is no <tt>invoke</tt> instruction in the dynamic call chain,
 839 undefined behavior results.</p>
 840 </div>
 841 <!-- ======================================================================= -->
 842 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
 843 <div class="doc_text">
 844 <p>Binary operators are used to do most of the computation in a
 845 program.  They require two operands, execute an operation on them, and
 846 produce a single value. The result value of a binary operator is not
 847 necessarily the same type as its operands.</p>
 848 <p>There are several different binary operators:</p>
 849 </div>
 850 <!-- _______________________________________________________________________ -->
 851 <div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>'
 852 Instruction</a> </div>
 853 <div class="doc_text">
 854 <h5>Syntax:</h5>
 855 <pre>  &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
 856 </pre>
 857 <h5>Overview:</h5>
 858 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
 859 <h5>Arguments:</h5>
 860 <p>The two arguments to the '<tt>add</tt>' instruction must be either <a
 861  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
 862 values. Both arguments must have identical types.</p>
 863 <h5>Semantics:</h5>
 864 <p>The value produced is the integer or floating point sum of the two
 865 operands.</p>
 866 <h5>Example:</h5>
 867 <pre>  &lt;result&gt; = add int 4, %var          <i>; yields {int}:result = 4 + %var</i>
 868 </pre>
 869 </div>
 870 <!-- _______________________________________________________________________ -->
 871 <div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>'
 872 Instruction</a> </div>
 873 <div class="doc_text">
 874 <h5>Syntax:</h5>
 875 <pre>  &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
 876 </pre>
 877 <h5>Overview:</h5>
 878 <p>The '<tt>sub</tt>' instruction returns the difference of its two
 879 operands.</p>
 880 <p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>'
 881 instruction present in most other intermediate representations.</p>
 882 <h5>Arguments:</h5>
 883 <p>The two arguments to the '<tt>sub</tt>' instruction must be either <a
 884  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
 885 values. Both arguments must have identical types.</p>
 886 <h5>Semantics:</h5>
 887 <p>The value produced is the integer or floating point difference of
 888 the two operands.</p>
 889 <h5>Example:</h5>
 890 <pre>  &lt;result&gt; = sub int 4, %var          <i>; yields {int}:result = 4 - %var</i>
 891   &lt;result&gt; = sub int 0, %val          <i>; yields {int}:result = -%var</i>
 892 </pre>
 893 </div>
 894 <!-- _______________________________________________________________________ -->
 895 <div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>'
 896 Instruction</a> </div>
 897 <div class="doc_text">
 898 <h5>Syntax:</h5>
 899 <pre>  &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
 900 </pre>
 901 <h5>Overview:</h5>
 902 <p>The  '<tt>mul</tt>' instruction returns the product of its two
 903 operands.</p>
 904 <h5>Arguments:</h5>
 905 <p>The two arguments to the '<tt>mul</tt>' instruction must be either <a
 906  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
 907 values. Both arguments must have identical types.</p>
 908 <h5>Semantics:</h5>
 909 <p>The value produced is the integer or floating point product of the
 910 two operands.</p>
 911 <p>There is no signed vs unsigned multiplication.  The appropriate
 912 action is taken based on the type of the operand.</p>
 913 <h5>Example:</h5>
 914 <pre>  &lt;result&gt; = mul int 4, %var          <i>; yields {int}:result = 4 * %var</i>
 915 </pre>
 916 </div>
 917 <!-- _______________________________________________________________________ -->
 918 <div class="doc_subsubsection"> <a name="i_div">'<tt>div</tt>'
 919 Instruction</a> </div>
 920 <div class="doc_text">
 921 <h5>Syntax:</h5>
 922 <pre>  &lt;result&gt; = div &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
 923 </pre>
 924 <h5>Overview:</h5>
 925 <p>The '<tt>div</tt>' instruction returns the quotient of its two
 926 operands.</p>
 927 <h5>Arguments:</h5>
 928 <p>The two arguments to the '<tt>div</tt>' instruction must be either <a
 929  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
 930 values. Both arguments must have identical types.</p>
 931 <h5>Semantics:</h5>
 932 <p>The value produced is the integer or floating point quotient of the
 933 two operands.</p>
 934 <h5>Example:</h5>
 935 <pre>  &lt;result&gt; = div int 4, %var          <i>; yields {int}:result = 4 / %var</i>
 936 </pre>
 937 </div>
 938 <!-- _______________________________________________________________________ -->
 939 <div class="doc_subsubsection"> <a name="i_rem">'<tt>rem</tt>'
 940 Instruction</a> </div>
 941 <div class="doc_text">
 942 <h5>Syntax:</h5>
 943 <pre>  &lt;result&gt; = rem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
 944 </pre>
 945 <h5>Overview:</h5>
 946 <p>The '<tt>rem</tt>' instruction returns the remainder from the
 947 division of its two operands.</p>
 948 <h5>Arguments:</h5>
 949 <p>The two arguments to the '<tt>rem</tt>' instruction must be either <a
 950  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
 951 values. Both arguments must have identical types.</p>
 952 <h5>Semantics:</h5>
 953 <p>This returns the <i>remainder</i> of a division (where the result
 954 has the same sign as the divisor), not the <i>modulus</i> (where the
 955 result has the same sign as the dividend) of a value.  For more
 956 information about the difference, see: <a
 957  href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
 958 Math Forum</a>.</p>
 959 <h5>Example:</h5>
 960 <pre>  &lt;result&gt; = rem int 4, %var          <i>; yields {int}:result = 4 % %var</i>
 961 </pre>
 962 </div>
 963 <!-- _______________________________________________________________________ -->
 964 <div class="doc_subsubsection"> <a name="i_setcc">'<tt>set<i>cc</i></tt>'
 965 Instructions</a> </div>
 966 <div class="doc_text">
 967 <h5>Syntax:</h5>
 968 <pre>  &lt;result&gt; = seteq &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 969   &lt;result&gt; = setne &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 970   &lt;result&gt; = setlt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 971   &lt;result&gt; = setgt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 972   &lt;result&gt; = setle &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 973   &lt;result&gt; = setge &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
 974 </pre>
 975 <h5>Overview:</h5>
 976 <p>The '<tt>set<i>cc</i></tt>' family of instructions returns a boolean
 977 value based on a comparison of their two operands.</p>
 978 <h5>Arguments:</h5>
 979 <p>The two arguments to the '<tt>set<i>cc</i></tt>' instructions must
 980 be of <a href="#t_firstclass">first class</a> type (it is not possible
 981 to compare '<tt>label</tt>'s, '<tt>array</tt>'s, '<tt>structure</tt>'
 982 or '<tt>void</tt>' values, etc...).  Both arguments must have identical
 983 types.</p>
 984 <h5>Semantics:</h5>
 985 <p>The '<tt>seteq</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 986 value if both operands are equal.<br>
 987 The '<tt>setne</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 988 value if both operands are unequal.<br>
 989 The '<tt>setlt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 990 value if the first operand is less than the second operand.<br>
 991 The '<tt>setgt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 992 value if the first operand is greater than the second operand.<br>
 993 The '<tt>setle</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 994 value if the first operand is less than or equal to the second operand.<br>
 995 The '<tt>setge</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
 996 value if the first operand is greater than or equal to the second
 997 operand.</p>
 998 <h5>Example:</h5>
 999 <pre>  &lt;result&gt; = seteq int   4, 5        <i>; yields {bool}:result = false</i>
1000   &lt;result&gt; = setne float 4, 5        <i>; yields {bool}:result = true</i>
1001   &lt;result&gt; = setlt uint  4, 5        <i>; yields {bool}:result = true</i>
1002   &lt;result&gt; = setgt sbyte 4, 5        <i>; yields {bool}:result = false</i>
1003   &lt;result&gt; = setle sbyte 4, 5        <i>; yields {bool}:result = true</i>
1004   &lt;result&gt; = setge sbyte 4, 5        <i>; yields {bool}:result = false</i>
1005 </pre>
1006 </div>
1007 <!-- ======================================================================= -->
1008 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
1009 Operations</a> </div>
1010 <div class="doc_text">
1011 <p>Bitwise binary operators are used to do various forms of
1012 bit-twiddling in a program.  They are generally very efficient
1013 instructions, and can commonly be strength reduced from other
1014 instructions.  They require two operands, execute an operation on them,
1015 and produce a single value.  The resulting value of the bitwise binary
1016 operators is always the same type as its first operand.</p>
1017 </div>
1018 <!-- _______________________________________________________________________ -->
1019 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
1020 Instruction</a> </div>
1021 <div class="doc_text">
1022 <h5>Syntax:</h5>
1023 <pre>  &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1024 </pre>
1025 <h5>Overview:</h5>
1026 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of
1027 its two operands.</p>
1028 <h5>Arguments:</h5>
1029 <p>The two arguments to the '<tt>and</tt>' instruction must be <a
1030  href="#t_integral">integral</a> values.  Both arguments must have
1031 identical types.</p>
1032 <h5>Semantics:</h5>
1033 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
1034 <p> </p>
1035 <center>
1036 <table border="1" cellspacing="0" cellpadding="4">
1037   <tbody>
1038     <tr>
1039       <td>In0</td>
1040       <td>In1</td>
1041       <td>Out</td>
1042     </tr>
1043     <tr>
1044       <td>0</td>
1045       <td>0</td>
1046       <td>0</td>
1047     </tr>
1048     <tr>
1049       <td>0</td>
1050       <td>1</td>
1051       <td>0</td>
1052     </tr>
1053     <tr>
1054       <td>1</td>
1055       <td>0</td>
1056       <td>0</td>
1057     </tr>
1058     <tr>
1059       <td>1</td>
1060       <td>1</td>
1061       <td>1</td>
1062     </tr>
1063   </tbody>
1064 </table>
1065 </center>
1066 <h5>Example:</h5>
1067 <pre>  &lt;result&gt; = and int 4, %var         <i>; yields {int}:result = 4 &amp; %var</i>
1068   &lt;result&gt; = and int 15, 40          <i>; yields {int}:result = 8</i>
1069   &lt;result&gt; = and int 4, 8            <i>; yields {int}:result = 0</i>
1070 </pre>
1071 </div>
1072 <!-- _______________________________________________________________________ -->
1073 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
1074 <div class="doc_text">
1075 <h5>Syntax:</h5>
1076 <pre>  &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1077 </pre>
1078 <h5>Overview:</h5>
1079 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
1080 or of its two operands.</p>
1081 <h5>Arguments:</h5>
1082 <p>The two arguments to the '<tt>or</tt>' instruction must be <a
1083  href="#t_integral">integral</a> values.  Both arguments must have
1084 identical types.</p>
1085 <h5>Semantics:</h5>
1086 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
1087 <p> </p>
1088 <center>
1089 <table border="1" cellspacing="0" cellpadding="4">
1090   <tbody>
1091     <tr>
1092       <td>In0</td>
1093       <td>In1</td>
1094       <td>Out</td>
1095     </tr>
1096     <tr>
1097       <td>0</td>
1098       <td>0</td>
1099       <td>0</td>
1100     </tr>
1101     <tr>
1102       <td>0</td>
1103       <td>1</td>
1104       <td>1</td>
1105     </tr>
1106     <tr>
1107       <td>1</td>
1108       <td>0</td>
1109       <td>1</td>
1110     </tr>
1111     <tr>
1112       <td>1</td>
1113       <td>1</td>
1114       <td>1</td>
1115     </tr>
1116   </tbody>
1117 </table>
1118 </center>
1119 <h5>Example:</h5>
1120 <pre>  &lt;result&gt; = or int 4, %var         <i>; yields {int}:result = 4 | %var</i>
1121   &lt;result&gt; = or int 15, 40          <i>; yields {int}:result = 47</i>
1122   &lt;result&gt; = or int 4, 8            <i>; yields {int}:result = 12</i>
1123 </pre>
1124 </div>
1125 <!-- _______________________________________________________________________ -->
1126 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
1127 Instruction</a> </div>
1128 <div class="doc_text">
1129 <h5>Syntax:</h5>
1130 <pre>  &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1131 </pre>
1132 <h5>Overview:</h5>
1133 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
1134 or of its two operands.  The <tt>xor</tt> is used to implement the
1135 "one's complement" operation, which is the "~" operator in C.</p>
1136 <h5>Arguments:</h5>
1137 <p>The two arguments to the '<tt>xor</tt>' instruction must be <a
1138  href="#t_integral">integral</a> values.  Both arguments must have
1139 identical types.</p>
1140 <h5>Semantics:</h5>
1141 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
1142 <p> </p>
1143 <center>
1144 <table border="1" cellspacing="0" cellpadding="4">
1145   <tbody>
1146     <tr>
1147       <td>In0</td>
1148       <td>In1</td>
1149       <td>Out</td>
1150     </tr>
1151     <tr>
1152       <td>0</td>
1153       <td>0</td>
1154       <td>0</td>
1155     </tr>
1156     <tr>
1157       <td>0</td>
1158       <td>1</td>
1159       <td>1</td>
1160     </tr>
1161     <tr>
1162       <td>1</td>
1163       <td>0</td>
1164       <td>1</td>
1165     </tr>
1166     <tr>
1167       <td>1</td>
1168       <td>1</td>
1169       <td>0</td>
1170     </tr>
1171   </tbody>
1172 </table>
1173 </center>
1174 <p> </p>
1175 <h5>Example:</h5>
1176 <pre>  &lt;result&gt; = xor int 4, %var         <i>; yields {int}:result = 4 ^ %var</i>
1177   &lt;result&gt; = xor int 15, 40          <i>; yields {int}:result = 39</i>
1178   &lt;result&gt; = xor int 4, 8            <i>; yields {int}:result = 12</i>
1179   &lt;result&gt; = xor int %V, -1          <i>; yields {int}:result = ~%V</i>
1180 </pre>
1181 </div>
1182 <!-- _______________________________________________________________________ -->
1183 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
1184 Instruction</a> </div>
1185 <div class="doc_text">
1186 <h5>Syntax:</h5>
1187 <pre>  &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1188 </pre>
1189 <h5>Overview:</h5>
1190 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to
1191 the left a specified number of bits.</p>
1192 <h5>Arguments:</h5>
1193 <p>The first argument to the '<tt>shl</tt>' instruction must be an <a
1194  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1195 type.</p>
1196 <h5>Semantics:</h5>
1197 <p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p>
1198 <h5>Example:</h5>
1199 <pre>  &lt;result&gt; = shl int 4, ubyte %var   <i>; yields {int}:result = 4 &lt;&lt; %var</i>
1200   &lt;result&gt; = shl int 4, ubyte 2      <i>; yields {int}:result = 16</i>
1201   &lt;result&gt; = shl int 1, ubyte 10     <i>; yields {int}:result = 1024</i>
1202 </pre>
1203 </div>
1204 <!-- _______________________________________________________________________ -->
1205 <div class="doc_subsubsection"> <a name="i_shr">'<tt>shr</tt>'
1206 Instruction</a> </div>
1207 <div class="doc_text">
1208 <h5>Syntax:</h5>
1209 <pre>  &lt;result&gt; = shr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1210 </pre>
1211 <h5>Overview:</h5>
1212 <p>The '<tt>shr</tt>' instruction returns the first operand shifted to
1213 the right a specified number of bits.</p>
1214 <h5>Arguments:</h5>
1215 <p>The first argument to the '<tt>shr</tt>' instruction must be an <a
1216  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1217 type.</p>
1218 <h5>Semantics:</h5>
1219 <p>If the first argument is a <a href="#t_signed">signed</a> type, the
1220 most significant bit is duplicated in the newly free'd bit positions.
1221 If the first argument is unsigned, zero bits shall fill the empty
1222 positions.</p>
1223 <h5>Example:</h5>
1224 <pre>  &lt;result&gt; = shr int 4, ubyte %var   <i>; yields {int}:result = 4 &gt;&gt; %var</i>
1225   &lt;result&gt; = shr uint 4, ubyte 1     <i>; yields {uint}:result = 2</i>
1226   &lt;result&gt; = shr int 4, ubyte 2      <i>; yields {int}:result = 1</i>
1227   &lt;result&gt; = shr sbyte 4, ubyte 3    <i>; yields {sbyte}:result = 0</i>
1228   &lt;result&gt; = shr sbyte -2, ubyte 1   <i>; yields {sbyte}:result = -1</i>
1229 </pre>
1230 </div>
1231 <!-- ======================================================================= -->
1232 <div class="doc_subsection"> <a name="memoryops">Memory Access
1233 Operations</a></div>
1234 <div class="doc_text">
1235 <p>A key design point of an SSA-based representation is how it
1236 represents memory.  In LLVM, no memory locations are in SSA form, which
1237 makes things very simple.  This section describes how to read, write,
1238 allocate and free memory in LLVM.</p>
1239 </div>
1240 <!-- _______________________________________________________________________ -->
1241 <div class="doc_subsubsection"> <a name="i_malloc">'<tt>malloc</tt>'
1242 Instruction</a> </div>
1243 <div class="doc_text">
1244 <h5>Syntax:</h5>
1245 <pre>  &lt;result&gt; = malloc &lt;type&gt;, uint &lt;NumElements&gt;     <i>; yields {type*}:result</i>
1246   &lt;result&gt; = malloc &lt;type&gt;                         <i>; yields {type*}:result</i>
1247 </pre>
1248 <h5>Overview:</h5>
1249 <p>The '<tt>malloc</tt>' instruction allocates memory from the system
1250 heap and returns a pointer to it.</p>
1251 <h5>Arguments:</h5>
1252 <p>The the '<tt>malloc</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
1253 bytes of memory from the operating system, and returns a pointer of the
1254 appropriate type to the program.  The second form of the instruction is
1255 a shorter version of the first instruction that defaults to allocating
1256 one element.</p>
1257 <p>'<tt>type</tt>' must be a sized type.</p>
1258 <h5>Semantics:</h5>
1259 <p>Memory is allocated using the system "<tt>malloc</tt>" function, and
1260 a pointer is returned.</p>
1261 <h5>Example:</h5>
1262 <pre>  %array  = malloc [4 x ubyte ]                    <i>; yields {[%4 x ubyte]*}:array</i>
1263
1264   %size   = <a
1265  href="#i_add">add</a> uint 2, 2                          <i>; yields {uint}:size = uint 4</i>
1266   %array1 = malloc ubyte, uint 4                   <i>; yields {ubyte*}:array1</i>
1267   %array2 = malloc [12 x ubyte], uint %size        <i>; yields {[12 x ubyte]*}:array2</i>
1268 </pre>
1269 </div>
1270 <!-- _______________________________________________________________________ -->
1271 <div class="doc_subsubsection"> <a name="i_free">'<tt>free</tt>'
1272 Instruction</a> </div>
1273 <div class="doc_text">
1274 <h5>Syntax:</h5>
1275 <pre>  free &lt;type&gt; &lt;value&gt;                              <i>; yields {void}</i>
1276 </pre>
1277 <h5>Overview:</h5>
1278 <p>The '<tt>free</tt>' instruction returns memory back to the unused
1279 memory heap, to be reallocated in the future.</p>
1280 <p> </p>
1281 <h5>Arguments:</h5>
1282 <p>'<tt>value</tt>' shall be a pointer value that points to a value
1283 that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
1284 instruction.</p>
1285 <h5>Semantics:</h5>
1286 <p>Access to the memory pointed to by the pointer is not longer defined
1287 after this instruction executes.</p>
1288 <h5>Example:</h5>
1289 <pre>  %array  = <a href="#i_malloc">malloc</a> [4 x ubyte]                    <i>; yields {[4 x ubyte]*}:array</i>
1290             free   [4 x ubyte]* %array
1291 </pre>
1292 </div>
1293 <!-- _______________________________________________________________________ -->
1294 <div class="doc_subsubsection"> <a name="i_alloca">'<tt>alloca</tt>'
1295 Instruction</a> </div>
1296 <div class="doc_text">
1297 <h5>Syntax:</h5>
1298 <pre>  &lt;result&gt; = alloca &lt;type&gt;, uint &lt;NumElements&gt;  <i>; yields {type*}:result</i>
1299   &lt;result&gt; = alloca &lt;type&gt;                      <i>; yields {type*}:result</i>
1300 </pre>
1301 <h5>Overview:</h5>
1302 <p>The '<tt>alloca</tt>' instruction allocates memory on the current
1303 stack frame of the procedure that is live until the current function
1304 returns to its caller.</p>
1305 <h5>Arguments:</h5>
1306 <p>The the '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
1307 bytes of memory on the runtime stack, returning a pointer of the
1308 appropriate type to the program.  The second form of the instruction is
1309 a shorter version of the first that defaults to allocating one element.</p>
1310 <p>'<tt>type</tt>' may be any sized type.</p>
1311 <h5>Semantics:</h5>
1312 <p>Memory is allocated, a pointer is returned.  '<tt>alloca</tt>'d
1313 memory is automatically released when the function returns.  The '<tt>alloca</tt>'
1314 instruction is commonly used to represent automatic variables that must
1315 have an address available.  When the function returns (either with the <tt><a
1316  href="#i_ret">ret</a></tt> or <tt><a href="#i_invoke">invoke</a></tt>
1317 instructions), the memory is reclaimed.</p>
1318 <h5>Example:</h5>
1319 <pre>  %ptr = alloca int                              <i>; yields {int*}:ptr</i>
1320   %ptr = alloca int, uint 4                      <i>; yields {int*}:ptr</i>
1321 </pre>
1322 </div>
1323 <!-- _______________________________________________________________________ -->
1324 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
1325 Instruction</a> </div>
1326 <div class="doc_text">
1327 <h5>Syntax:</h5>
1328 <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>
1329 <h5>Overview:</h5>
1330 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
1331 <h5>Arguments:</h5>
1332 <p>The argument to the '<tt>load</tt>' instruction specifies the memory
1333 address to load from.  The pointer must point to a <a
1334  href="t_firstclass">first class</a> type.  If the <tt>load</tt> is
1335 marked as <tt>volatile</tt> then the optimizer is not allowed to modify
1336 the number or order of execution of this <tt>load</tt> with other
1337 volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
1338 instructions. </p>
1339 <h5>Semantics:</h5>
1340 <p>The location of memory pointed to is loaded.</p>
1341 <h5>Examples:</h5>
1342 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
1343   <a
1344  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
1345   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
1346 </pre>
1347 </div>
1348 <!-- _______________________________________________________________________ -->
1349 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
1350 Instruction</a> </div>
1351 <h5>Syntax:</h5>
1352 <pre>  store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
1353   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
1354 </pre>
1355 <h5>Overview:</h5>
1356 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
1357 <h5>Arguments:</h5>
1358 <p>There are two arguments to the '<tt>store</tt>' instruction: a value
1359 to store and an address to store it into.  The type of the '<tt>&lt;pointer&gt;</tt>'
1360 operand must be a pointer to the type of the '<tt>&lt;value&gt;</tt>'
1361 operand. If the <tt>store</tt> is marked as <tt>volatile</tt> then the
1362 optimizer is not allowed to modify the number or order of execution of
1363 this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
1364  href="#i_store">store</a></tt> instructions.</p>
1365 <h5>Semantics:</h5>
1366 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
1367 at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
1368 <h5>Example:</h5>
1369 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
1370   <a
1371  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
1372   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
1373 </pre>
1374 <!-- _______________________________________________________________________ -->
1375 <div class="doc_subsubsection"> <a name="i_getelementptr">'<tt>getelementptr</tt>'
1376 Instruction</a> </div>
1377 <div class="doc_text">
1378 <h5>Syntax:</h5>
1379 <pre>  &lt;result&gt; = getelementptr &lt;ty&gt;* &lt;ptrval&gt;{, long &lt;aidx&gt;|, ubyte &lt;sidx&gt;}*<br></pre>
1380 <h5>Overview:</h5>
1381 <p>The '<tt>getelementptr</tt>' instruction is used to get the address
1382 of a subelement of an aggregate data structure.</p>
1383 <h5>Arguments:</h5>
1384 <p>This instruction takes a list of <tt>long</tt> values and <tt>ubyte</tt>
1385 constants that indicate what form of addressing to perform.  The actual
1386 types of the arguments provided depend on the type of the first pointer
1387 argument.  The '<tt>getelementptr</tt>' instruction is used to index
1388 down through the type levels of a structure.</p>
1389 <p>For example, let's consider a C code fragment and how it gets
1390 compiled to LLVM:</p>
1391 <pre>struct RT {<br>  char A;<br>  int B[10][20];<br>  char C;<br>};<br>struct ST {<br>  int X;<br>  double Y;<br>  struct RT Z;<br>};<br><br>int *foo(struct ST *s) {<br>  return &amp;s[1].Z.B[5][13];<br>}<br></pre>
1392 <p>The LLVM code generated by the GCC frontend is:</p>
1393 <pre>%RT = type { sbyte, [10 x [20 x int]], sbyte }<br>%ST = type { int, double, %RT }<br><br>int* "foo"(%ST* %s) {<br>  %reg = getelementptr %ST* %s, long 1, ubyte 2, ubyte 1, long 5, long 13<br>  ret int* %reg<br>}<br></pre>
1394 <h5>Semantics:</h5>
1395 <p>The index types specified for the '<tt>getelementptr</tt>'
1396 instruction depend on the pointer type that is being index into. <a
1397  href="t_pointer">Pointer</a> and <a href="t_array">array</a> types
1398 require '<tt>long</tt>' values, and <a href="t_struct">structure</a>
1399 types require '<tt>ubyte</tt>' <b>constants</b>.</p>
1400 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
1401 type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ int,
1402 double, %RT }</tt>' type, a structure.  The second index indexes into
1403 the third element of the structure, yielding a '<tt>%RT</tt>' = '<tt>{
1404 sbyte, [10 x [20 x int]], sbyte }</tt>' type, another structure.  The
1405 third index indexes into the second element of the structure, yielding
1406 a '<tt>[10 x [20 x int]]</tt>' type, an array.  The two dimensions of
1407 the array are subscripted into, yielding an '<tt>int</tt>' type.  The '<tt>getelementptr</tt>'
1408 instruction return a pointer to this element, thus yielding a '<tt>int*</tt>'
1409 type.</p>
1410 <p>Note that it is perfectly legal to index partially through a
1411 structure, returning a pointer to an inner element.  Because of this,
1412 the LLVM code for the given testcase is equivalent to:</p>
1413 <pre>int* "foo"(%ST* %s) {<br>  %t1 = getelementptr %ST* %s , long 1                        <i>; yields %ST*:%t1</i>
1414   %t2 = getelementptr %ST* %t1, long 0, ubyte 2               <i>; yields %RT*:%t2</i>
1415   %t3 = getelementptr %RT* %t2, long 0, ubyte 1               <i>; yields [10 x [20 x int]]*:%t3</i>
1416   %t4 = getelementptr [10 x [20 x int]]* %t3, long 0, long 5  <i>; yields [20 x int]*:%t4</i>
1417   %t5 = getelementptr [20 x int]* %t4, long 0, long 13        <i>; yields int*:%t5</i>
1418   ret int* %t5
1419 }
1420 </pre>
1421 <h5>Example:</h5>
1422 <pre>  <i>; yields [12 x ubyte]*:aptr</i>
1423   %aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, ubyte 1<br></pre>
1424 <h5>&nbsp;Note To The Novice:</h5>
1425 When using indexing into global arrays with the  '<tt>getelementptr</tt>'
1426 instruction, you must remember that the&nbsp; </div>
1427 <!-- ======================================================================= -->
1428 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
1429 <div class="doc_text">
1430 <p>The instructions in this catagory are the "miscellaneous"
1431 instructions, which defy better classification.</p>
1432 </div>
1433 <!-- _______________________________________________________________________ -->
1434 <div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>'
1435 Instruction</a> </div>
1436 <div class="doc_text">
1437 <h5>Syntax:</h5>
1438 <pre>  &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
1439 <h5>Overview:</h5>
1440 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
1441 the SSA graph representing the function.</p>
1442 <h5>Arguments:</h5>
1443 <p>The type of the incoming values are specified with the first type
1444 field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
1445 as arguments, with one pair for each predecessor basic block of the
1446 current block.  Only values of <a href="#t_firstclass">first class</a>
1447 type may be used as the value arguments to the PHI node.  Only labels
1448 may be used as the label arguments.</p>
1449 <p>There must be no non-phi instructions between the start of a basic
1450 block and the PHI instructions: i.e. PHI instructions must be first in
1451 a basic block.</p>
1452 <h5>Semantics:</h5>
1453 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the
1454 value specified by the parameter, depending on which basic block we
1455 came from in the last <a href="#terminators">terminator</a> instruction.</p>
1456 <h5>Example:</h5>
1457 <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>
1458 </div>
1459 <!-- _______________________________________________________________________ -->
1460 <div class="doc_subsubsection"> <a name="i_cast">'<tt>cast .. to</tt>'
1461 Instruction</a> </div>
1462 <div class="doc_text">
1463 <h5>Syntax:</h5>
1464 <pre>  &lt;result&gt; = cast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
1465 </pre>
1466 <h5>Overview:</h5>
1467 <p>The '<tt>cast</tt>' instruction is used as the primitive means to
1468 convert integers to floating point, change data type sizes, and break
1469 type safety (by casting pointers).</p>
1470 <h5>Arguments:</h5>
1471 <p>The '<tt>cast</tt>' instruction takes a value to cast, which must be
1472 a first class value, and a type to cast it to, which must also be a <a
1473  href="#t_firstclass">first class</a> type.</p>
1474 <h5>Semantics:</h5>
1475 <p>This instruction follows the C rules for explicit casts when
1476 determining how the data being cast must change to fit in its new
1477 container.</p>
1478 <p>When casting to bool, any value that would be considered true in the
1479 context of a C '<tt>if</tt>' condition is converted to the boolean '<tt>true</tt>'
1480 values, all else are '<tt>false</tt>'.</p>
1481 <p>When extending an integral value from a type of one signness to
1482 another (for example '<tt>sbyte</tt>' to '<tt>ulong</tt>'), the value
1483 is sign-extended if the <b>source</b> value is signed, and
1484 zero-extended if the source value is unsigned. <tt>bool</tt> values
1485 are always zero extended into either zero or one.</p>
1486 <h5>Example:</h5>
1487 <pre>  %X = cast int 257 to ubyte              <i>; yields ubyte:1</i>
1488   %Y = cast int 123 to bool               <i>; yields bool:true</i>
1489 </pre>
1490 </div>
1491 <!-- _______________________________________________________________________ -->
1492 <div class="doc_subsubsection"> <a name="i_call">'<tt>call</tt>'
1493 Instruction</a> </div>
1494 <div class="doc_text">
1495 <h5>Syntax:</h5>
1496 <pre>  &lt;result&gt; = call &lt;ty&gt;* &lt;fnptrval&gt;(&lt;param list&gt;)<br></pre>
1497 <h5>Overview:</h5>
1498 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
1499 <h5>Arguments:</h5>
1500 <p>This instruction requires several arguments:</p>
1501 <ol>
1502   <li>
1503     <p>'<tt>ty</tt>': shall be the signature of the pointer to function
1504 value   being invoked.  The argument types must match the types implied
1505 by this   signature.</p>
1506   </li>
1507   <li>
1508     <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a
1509 function   to be invoked. In most cases, this is a direct function
1510 invocation, but   indirect <tt>call</tt>s are just as possible,
1511 calling an arbitrary pointer to   function values.</p>
1512   </li>
1513   <li>
1514     <p>'<tt>function args</tt>': argument list whose types match the
1515 function   signature argument types.  If the function signature
1516 indicates the function   accepts a variable number of arguments, the
1517 extra arguments can be   specified.</p>
1518   </li>
1519 </ol>
1520 <h5>Semantics:</h5>
1521 <p>The '<tt>call</tt>' instruction is used to cause control flow to
1522 transfer to a specified function, with its incoming arguments bound to
1523 the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
1524 instruction in the called function, control flow continues with the
1525 instruction after the function call, and the return value of the
1526 function is bound to the result argument.  This is a simpler case of
1527 the <a href="#i_invoke">invoke</a> instruction.</p>
1528 <h5>Example:</h5>
1529 <pre>  %retval = call int %test(int %argc)<br>  call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42);<br></pre>
1530 </div>
1531 <!-- _______________________________________________________________________ -->
1532 <div class="doc_subsubsection"> <a name="i_vanext">'<tt>vanext</tt>'
1533 Instruction</a> </div>
1534 <div class="doc_text">
1535 <h5>Syntax:</h5>
1536 <pre>  &lt;resultarglist&gt; = vanext &lt;va_list&gt; &lt;arglist&gt;, &lt;argty&gt;<br></pre>
1537 <h5>Overview:</h5>
1538 <p>The '<tt>vanext</tt>' instruction is used to access arguments passed
1539 through the "variable argument" area of a function call.  It is used to
1540 implement the <tt>va_arg</tt> macro in C.</p>
1541 <h5>Arguments:</h5>
1542 <p>This instruction takes a <tt>valist</tt> value and the type of the
1543 argument. It returns another <tt>valist</tt>.</p>
1544 <h5>Semantics:</h5>
1545 <p>The '<tt>vanext</tt>' instruction advances the specified <tt>valist</tt>
1546 past an argument of the specified type.  In conjunction with the <a
1547  href="#i_vaarg"><tt>vaarg</tt></a> instruction, it is used to implement
1548 the <tt>va_arg</tt> macro available in C.  For more information, see
1549 the variable argument handling <a href="#int_varargs">Intrinsic
1550 Functions</a>.</p>
1551 <p>It is legal for this instruction to be called in a function which
1552 does not take a variable number of arguments, for example, the <tt>vfprintf</tt>
1553 function.</p>
1554 <p><tt>vanext</tt> is an LLVM instruction instead of an <a
1555  href="#intrinsics">intrinsic function</a> because it takes an type as
1556 an argument.</p>
1557 <h5>Example:</h5>
1558 <p>See the <a href="#int_varargs">variable argument processing</a>
1559 section.</p>
1560 </div>
1561 <!-- _______________________________________________________________________ -->
1562 <div class="doc_subsubsection"> <a name="i_vaarg">'<tt>vaarg</tt>'
1563 Instruction</a> </div>
1564 <div class="doc_text">
1565 <h5>Syntax:</h5>
1566 <pre>  &lt;resultval&gt; = vaarg &lt;va_list&gt; &lt;arglist&gt;, &lt;argty&gt;<br></pre>
1567 <h5>Overview:</h5>
1568 <p>The '<tt>vaarg</tt>' instruction is used to access arguments passed
1569 through the "variable argument" area of a function call.  It is used to
1570 implement the <tt>va_arg</tt> macro in C.</p>
1571 <h5>Arguments:</h5>
1572 <p>This instruction takes a <tt>valist</tt> value and the type of the
1573 argument. It returns a value of the specified argument type.</p>
1574 <h5>Semantics:</h5>
1575 <p>The '<tt>vaarg</tt>' instruction loads an argument of the specified
1576 type from the specified <tt>va_list</tt>.  In conjunction with the <a
1577  href="#i_vanext"><tt>vanext</tt></a> instruction, it is used to
1578 implement the <tt>va_arg</tt> macro available in C.  For more
1579 information, see the variable argument handling <a href="#int_varargs">Intrinsic
1580 Functions</a>.</p>
1581 <p>It is legal for this instruction to be called in a function which
1582 does not take a variable number of arguments, for example, the <tt>vfprintf</tt>
1583 function.</p>
1584 <p><tt>vaarg</tt> is an LLVM instruction instead of an <a
1585  href="#intrinsics">intrinsic function</a> because it takes an type as
1586 an argument.</p>
1587 <h5>Example:</h5>
1588 <p>See the <a href="#int_varargs">variable argument processing</a>
1589 section.</p>
1590 </div>
1591
1592 <!-- *********************************************************************** -->
1593 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
1594 <!-- *********************************************************************** -->
1595
1596 <div class="doc_text">
1597 <p>LLVM supports the notion of an "intrinsic function".  These
1598 functions have well known names and semantics, and are required to
1599 follow certain restrictions. Overall, these instructions represent an
1600 extension mechanism for the LLVM language that does not require
1601 changing all of the transformations in LLVM to add to the language (or
1602 the bytecode reader/writer, the parser, etc...).</p>
1603 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>"
1604 prefix, this prefix is reserved in LLVM for intrinsic names, thus
1605 functions may not be named this.  Intrinsic functions must always be
1606 external functions: you cannot define the body of intrinsic functions.
1607 Intrinsic functions may only be used in call or invoke instructions: it
1608 is illegal to take the address of an intrinsic function.  Additionally,
1609 because intrinsic functions are part of the LLVM language, it is
1610 required that they all be documented here if any are added.</p>
1611 <p>Unless an intrinsic function is target-specific, there must be a
1612 lowering pass to eliminate the intrinsic or all backends must support
1613 the intrinsic function.</p>
1614 </div>
1615
1616 <!-- ======================================================================= -->
1617 <div class="doc_subsection">
1618   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
1619 </div>
1620
1621 <div class="doc_text">
1622 <p>Variable argument support is defined in LLVM with the <a
1623  href="#i_vanext"><tt>vanext</tt></a> instruction and these three
1624 intrinsic functions.  These functions are related to the similarly
1625 named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
1626 <p>All of these functions operate on arguments that use a
1627 target-specific value type "<tt>va_list</tt>".  The LLVM assembly
1628 language reference manual does not define what this type is, so all
1629 transformations should be prepared to handle intrinsics with any type
1630 used.</p>
1631 <p>This example shows how the <a href="#i_vanext"><tt>vanext</tt></a>
1632 instruction and the variable argument handling intrinsic functions are
1633 used.</p>
1634 <pre>int %test(int %X, ...) {<br>  ; Initialize variable argument processing<br>  %ap = call sbyte*()* %<a
1635  href="#i_va_start">llvm.va_start</a>()<br><br>  ; Read a single integer argument<br>  %tmp = vaarg sbyte* %ap, int<br><br>  ; Advance to the next argument<br>  %ap2 = vanext sbyte* %ap, int<br><br>  ; Demonstrate usage of llvm.va_copy and llvm.va_end<br>  %aq = call sbyte* (sbyte*)* %<a
1636  href="#i_va_copy">llvm.va_copy</a>(sbyte* %ap2)<br>  call void %<a
1637  href="#i_va_end">llvm.va_end</a>(sbyte* %aq)<br><br>  ; Stop processing of arguments.<br>  call void %<a
1638  href="#i_va_end">llvm.va_end</a>(sbyte* %ap2)<br>  ret int %tmp<br>}<br></pre>
1639 </div>
1640
1641 <!-- _______________________________________________________________________ -->
1642 <div class="doc_subsubsection">
1643   <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
1644 </div>
1645
1646
1647 <div class="doc_text">
1648 <h5>Syntax:</h5>
1649 <pre>  call va_list ()* %llvm.va_start()<br></pre>
1650 <h5>Overview:</h5>
1651 <p>The '<tt>llvm.va_start</tt>' intrinsic returns a new <tt>&lt;arglist&gt;</tt>
1652 for subsequent use by the variable argument intrinsics.</p>
1653 <h5>Semantics:</h5>
1654 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
1655 macro available in C.  In a target-dependent way, it initializes and
1656 returns a <tt>va_list</tt> element, so that the next <tt>vaarg</tt>
1657 will produce the first variable argument passed to the function.  Unlike
1658 the C <tt>va_start</tt> macro, this intrinsic does not need to know the
1659 last argument of the function, the compiler can figure that out.</p>
1660 <p>Note that this intrinsic function is only legal to be called from
1661 within the body of a variable argument function.</p>
1662 </div>
1663
1664 <!-- _______________________________________________________________________ -->
1665 <div class="doc_subsubsection">
1666  <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
1667 </div>
1668
1669 <div class="doc_text">
1670 <h5>Syntax:</h5>
1671 <pre>  call void (va_list)* %llvm.va_end(va_list &lt;arglist&gt;)<br></pre>
1672 <h5>Overview:</h5>
1673 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>&lt;arglist&gt;</tt>
1674 which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt>
1675 or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
1676 <h5>Arguments:</h5>
1677 <p>The argument is a <tt>va_list</tt> to destroy.</p>
1678 <h5>Semantics:</h5>
1679 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
1680 macro available in C.  In a target-dependent way, it destroys the <tt>va_list</tt>.
1681 Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a
1682  href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly
1683 with calls to <tt>llvm.va_end</tt>.</p>
1684 </div>
1685
1686 <!-- _______________________________________________________________________ -->
1687 <div class="doc_subsubsection">
1688   <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
1689 </div>
1690
1691 <div class="doc_text">
1692 <h5>Syntax:</h5>
1693 <pre>  call va_list (va_list)* %llvm.va_copy(va_list &lt;destarglist&gt;)<br></pre>
1694 <h5>Overview:</h5>
1695 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument
1696 position from the source argument list to the destination argument list.</p>
1697 <h5>Arguments:</h5>
1698 <p>The argument is the <tt>va_list</tt> to copy.</p>
1699 <h5>Semantics:</h5>
1700 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
1701 macro available in C.  In a target-dependent way, it copies the source <tt>va_list</tt>
1702 element into the returned list.  This intrinsic is necessary because the <tt><a
1703  href="i_va_start">llvm.va_start</a></tt> intrinsic may be arbitrarily
1704 complex and require memory allocation, for example.</p>
1705 </div>
1706
1707
1708 <!-- ======================================================================= -->
1709 <div class="doc_subsection">
1710   <a name="int_debugger">Debugger Intrinsics</a>
1711 </div>
1712
1713 <div class="doc_text">
1714 <p>
1715 The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
1716 are described in the <a
1717 href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
1718 Debugging</a> document.
1719 </p>
1720 </div>
1721
1722
1723 <!-- *********************************************************************** -->
1724 <hr>
1725 <div class="doc_footer">
1726 <address><a href="mailto:sabre@nondot.org">Chris Lattner</a></address>
1727 <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a> <br>
1728 Last modified: $Date$ </div>
1729 </body>
1730 </html>