docs/LangRef.html

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