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