docs/LangRef.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>LLVM Assembly Language Reference Manual</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   7   <meta name="author" content="Chris Lattner">
   8   <meta name="description"
   9   content="LLVM Assembly Language Reference Manual.">
  10   <link rel="stylesheet" href="llvm.css" type="text/css">
  11 </head>
  12
  13 <body>
  14
  15 <div class="doc_title"> LLVM Language Reference Manual </div>
  16 <ol>
  17   <li><a href="#abstract">Abstract</a></li>
  18   <li><a href="#introduction">Introduction</a></li>
  19   <li><a href="#identifiers">Identifiers</a></li>
  20   <li><a href="#highlevel">High Level Structure</a>
  21     <ol>
  22       <li><a href="#modulestructure">Module Structure</a></li>
  23       <li><a href="#linkage">Linkage Types</a></li>
  24       <li><a href="#callingconv">Calling Conventions</a></li>
  25       <li><a href="#globalvars">Global Variables</a></li>
  26       <li><a href="#functionstructure">Functions</a></li>
  27       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  28     </ol>
  29   </li>
  30   <li><a href="#typesystem">Type System</a>
  31     <ol>
  32       <li><a href="#t_primitive">Primitive Types</a>
  33         <ol>
  34           <li><a href="#t_classifications">Type Classifications</a></li>
  35         </ol>
  36       </li>
  37       <li><a href="#t_derived">Derived Types</a>
  38         <ol>
  39           <li><a href="#t_array">Array Type</a></li>
  40           <li><a href="#t_function">Function Type</a></li>
  41           <li><a href="#t_pointer">Pointer Type</a></li>
  42           <li><a href="#t_struct">Structure Type</a></li>
  43           <li><a href="#t_packed">Packed Type</a></li>
  44           <li><a href="#t_opaque">Opaque Type</a></li>
  45         </ol>
  46       </li>
  47     </ol>
  48   </li>
  49   <li><a href="#constants">Constants</a>
  50     <ol>
  51       <li><a href="#simpleconstants">Simple Constants</a>
  52       <li><a href="#aggregateconstants">Aggregate Constants</a>
  53       <li><a href="#globalconstants">Global Variable and Function Addresses</a>
  54       <li><a href="#undefvalues">Undefined Values</a>
  55       <li><a href="#constantexprs">Constant Expressions</a>
  56     </ol>
  57   </li>
  58   <li><a href="#othervalues">Other Values</a>
  59     <ol>
  60       <li><a href="#inlineasm">Inline Assembler Expressions</a>
  61     </ol>
  62   </li>
  63   <li><a href="#instref">Instruction Reference</a>
  64     <ol>
  65       <li><a href="#terminators">Terminator Instructions</a>
  66         <ol>
  67           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
  68           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
  69           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
  70           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
  71           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
  72           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
  73         </ol>
  74       </li>
  75       <li><a href="#binaryops">Binary Operations</a>
  76         <ol>
  77           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
  78           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
  79           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
  80           <li><a href="#i_div">'<tt>div</tt>' Instruction</a></li>
  81           <li><a href="#i_rem">'<tt>rem</tt>' Instruction</a></li>
  82           <li><a href="#i_setcc">'<tt>set<i>cc</i></tt>' Instructions</a></li>
  83         </ol>
  84       </li>
  85       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
  86         <ol>
  87           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
  88           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
  89           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
  90           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
  91           <li><a href="#i_shr">'<tt>shr</tt>' Instruction</a></li>
  92         </ol>
  93       </li>
  94       <li><a href="#memoryops">Memory Access Operations</a>
  95         <ol>
  96           <li><a href="#i_malloc">'<tt>malloc</tt>'   Instruction</a></li>
  97           <li><a href="#i_free">'<tt>free</tt>'     Instruction</a></li>
  98           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
  99          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 100          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 101          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 102         </ol>
 103       </li>
 104       <li><a href="#otherops">Other Operations</a>
 105         <ol>
 106           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 107           <li><a href="#i_cast">'<tt>cast .. to</tt>' Instruction</a></li>
 108           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 109           <li><a href="#i_vset">'<tt>vset</tt>' Instruction</a></li>
 110           <li><a href="#i_vselect">'<tt>vselect</tt>' Instruction</a></li>
 111           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 112           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 113           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 114           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 115         </ol>
 116       </li>
 117     </ol>
 118   </li>
 119   <li><a href="#intrinsics">Intrinsic Functions</a>
 120     <ol>
 121       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 122         <ol>
 123           <li><a href="#i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 124           <li><a href="#i_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 125           <li><a href="#i_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 126         </ol>
 127       </li>
 128       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 129         <ol>
 130           <li><a href="#i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 131           <li><a href="#i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 132           <li><a href="#i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 133         </ol>
 134       </li>
 135       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 136         <ol>
 137           <li><a href="#i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 138           <li><a href="#i_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 139           <li><a href="#i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 140           <li><a href="#i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 141           <li><a href="#i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 142           <li><a href="#i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 143           <li><a href="#i_readcyclecounter"><tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 144         </ol>
 145       </li>
 146       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 147         <ol>
 148           <li><a href="#i_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 149           <li><a href="#i_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 150           <li><a href="#i_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 151           <li><a href="#i_isunordered">'<tt>llvm.isunordered.*</tt>' Intrinsic</a></li>
 152           <li><a href="#i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 153
 154         </ol>
 155       </li>
 156       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 157         <ol>
 158           <li><a href="#i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 159           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 160           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 161           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 162         </ol>
 163       </li>
 164       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 165     </ol>
 166   </li>
 167 </ol>
 168
 169 <div class="doc_author">
 170   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 171             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 172 </div>
 173
 174 <!-- *********************************************************************** -->
 175 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 176 <!-- *********************************************************************** -->
 177
 178 <div class="doc_text">
 179 <p>This document is a reference manual for the LLVM assembly language.
 180 LLVM is an SSA based representation that provides type safety,
 181 low-level operations, flexibility, and the capability of representing
 182 'all' high-level languages cleanly.  It is the common code
 183 representation used throughout all phases of the LLVM compilation
 184 strategy.</p>
 185 </div>
 186
 187 <!-- *********************************************************************** -->
 188 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 189 <!-- *********************************************************************** -->
 190
 191 <div class="doc_text">
 192
 193 <p>The LLVM code representation is designed to be used in three
 194 different forms: as an in-memory compiler IR, as an on-disk bytecode
 195 representation (suitable for fast loading by a Just-In-Time compiler),
 196 and as a human readable assembly language representation.  This allows
 197 LLVM to provide a powerful intermediate representation for efficient
 198 compiler transformations and analysis, while providing a natural means
 199 to debug and visualize the transformations.  The three different forms
 200 of LLVM are all equivalent.  This document describes the human readable
 201 representation and notation.</p>
 202
 203 <p>The LLVM representation aims to be light-weight and low-level
 204 while being expressive, typed, and extensible at the same time.  It
 205 aims to be a "universal IR" of sorts, by being at a low enough level
 206 that high-level ideas may be cleanly mapped to it (similar to how
 207 microprocessors are "universal IR's", allowing many source languages to
 208 be mapped to them).  By providing type information, LLVM can be used as
 209 the target of optimizations: for example, through pointer analysis, it
 210 can be proven that a C automatic variable is never accessed outside of
 211 the current function... allowing it to be promoted to a simple SSA
 212 value instead of a memory location.</p>
 213
 214 </div>
 215
 216 <!-- _______________________________________________________________________ -->
 217 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 218
 219 <div class="doc_text">
 220
 221 <p>It is important to note that this document describes 'well formed'
 222 LLVM assembly language.  There is a difference between what the parser
 223 accepts and what is considered 'well formed'.  For example, the
 224 following instruction is syntactically okay, but not well formed:</p>
 225
 226 <pre>
 227   %x = <a href="#i_add">add</a> int 1, %x
 228 </pre>
 229
 230 <p>...because the definition of <tt>%x</tt> does not dominate all of
 231 its uses. The LLVM infrastructure provides a verification pass that may
 232 be used to verify that an LLVM module is well formed.  This pass is
 233 automatically run by the parser after parsing input assembly and by
 234 the optimizer before it outputs bytecode.  The violations pointed out
 235 by the verifier pass indicate bugs in transformation passes or input to
 236 the parser.</p>
 237
 238 <!-- Describe the typesetting conventions here. --> </div>
 239
 240 <!-- *********************************************************************** -->
 241 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 242 <!-- *********************************************************************** -->
 243
 244 <div class="doc_text">
 245
 246 <p>LLVM uses three different forms of identifiers, for different
 247 purposes:</p>
 248
 249 <ol>
 250   <li>Named values are represented as a string of characters with a '%' prefix.
 251   For example, %foo, %DivisionByZero, %a.really.long.identifier.  The actual
 252   regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
 253   Identifiers which require other characters in their names can be surrounded
 254   with quotes.  In this way, anything except a <tt>"</tt> character can be used
 255   in a name.</li>
 256
 257   <li>Unnamed values are represented as an unsigned numeric value with a '%'
 258   prefix.  For example, %12, %2, %44.</li>
 259
 260   <li>Constants, which are described in a <a href="#constants">section about
 261   constants</a>, below.</li>
 262 </ol>
 263
 264 <p>LLVM requires that values start with a '%' sign for two reasons: Compilers
 265 don't need to worry about name clashes with reserved words, and the set of
 266 reserved words may be expanded in the future without penalty.  Additionally,
 267 unnamed identifiers allow a compiler to quickly come up with a temporary
 268 variable without having to avoid symbol table conflicts.</p>
 269
 270 <p>Reserved words in LLVM are very similar to reserved words in other
 271 languages. There are keywords for different opcodes ('<tt><a
 272 href="#i_add">add</a></tt>', '<tt><a href="#i_cast">cast</a></tt>', '<tt><a
 273 href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
 274 href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>', etc...),
 275 and others.  These reserved words cannot conflict with variable names, because
 276 none of them start with a '%' character.</p>
 277
 278 <p>Here is an example of LLVM code to multiply the integer variable
 279 '<tt>%X</tt>' by 8:</p>
 280
 281 <p>The easy way:</p>
 282
 283 <pre>
 284   %result = <a href="#i_mul">mul</a> uint %X, 8
 285 </pre>
 286
 287 <p>After strength reduction:</p>
 288
 289 <pre>
 290   %result = <a href="#i_shl">shl</a> uint %X, ubyte 3
 291 </pre>
 292
 293 <p>And the hard way:</p>
 294
 295 <pre>
 296   <a href="#i_add">add</a> uint %X, %X           <i>; yields {uint}:%0</i>
 297   <a href="#i_add">add</a> uint %0, %0           <i>; yields {uint}:%1</i>
 298   %result = <a href="#i_add">add</a> uint %1, %1
 299 </pre>
 300
 301 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
 302 important lexical features of LLVM:</p>
 303
 304 <ol>
 305
 306   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 307   line.</li>
 308
 309   <li>Unnamed temporaries are created when the result of a computation is not
 310   assigned to a named value.</li>
 311
 312   <li>Unnamed temporaries are numbered sequentially</li>
 313
 314 </ol>
 315
 316 <p>...and it also shows a convention that we follow in this document.  When
 317 demonstrating instructions, we will follow an instruction with a comment that
 318 defines the type and name of value produced.  Comments are shown in italic
 319 text.</p>
 320
 321 </div>
 322
 323 <!-- *********************************************************************** -->
 324 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 325 <!-- *********************************************************************** -->
 326
 327 <!-- ======================================================================= -->
 328 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 329 </div>
 330
 331 <div class="doc_text">
 332
 333 <p>LLVM programs are composed of "Module"s, each of which is a
 334 translation unit of the input programs.  Each module consists of
 335 functions, global variables, and symbol table entries.  Modules may be
 336 combined together with the LLVM linker, which merges function (and
 337 global variable) definitions, resolves forward declarations, and merges
 338 symbol table entries. Here is an example of the "hello world" module:</p>
 339
 340 <pre><i>; Declare the string constant as a global constant...</i>
 341 <a href="#identifiers">%.LC0</a> = <a href="#linkage_internal">internal</a> <a
 342  href="#globalvars">constant</a> <a href="#t_array">[13 x sbyte]</a> c"hello world\0A\00"          <i>; [13 x sbyte]*</i>
 343
 344 <i>; External declaration of the puts function</i>
 345 <a href="#functionstructure">declare</a> int %puts(sbyte*)                                            <i>; int(sbyte*)* </i>
 346
 347 <i>; Definition of main function</i>
 348 int %main() {                                                        <i>; int()* </i>
 349         <i>; Convert [13x sbyte]* to sbyte *...</i>
 350         %cast210 = <a
 351  href="#i_getelementptr">getelementptr</a> [13 x sbyte]* %.LC0, long 0, long 0 <i>; sbyte*</i>
 352
 353         <i>; Call puts function to write out the string to stdout...</i>
 354         <a
 355  href="#i_call">call</a> int %puts(sbyte* %cast210)                              <i>; int</i>
 356         <a
 357  href="#i_ret">ret</a> int 0<br>}<br></pre>
 358
 359 <p>This example is made up of a <a href="#globalvars">global variable</a>
 360 named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
 361 function, and a <a href="#functionstructure">function definition</a>
 362 for "<tt>main</tt>".</p>
 363
 364 <p>In general, a module is made up of a list of global values,
 365 where both functions and global variables are global values.  Global values are
 366 represented by a pointer to a memory location (in this case, a pointer to an
 367 array of char, and a pointer to a function), and have one of the following <a
 368 href="#linkage">linkage types</a>.</p>
 369
 370 </div>
 371
 372 <!-- ======================================================================= -->
 373 <div class="doc_subsection">
 374   <a name="linkage">Linkage Types</a>
 375 </div>
 376
 377 <div class="doc_text">
 378
 379 <p>
 380 All Global Variables and Functions have one of the following types of linkage:
 381 </p>
 382
 383 <dl>
 384
 385   <dt><tt><b><a name="linkage_internal">internal</a></b></tt> </dt>
 386
 387   <dd>Global values with internal linkage are only directly accessible by
 388   objects in the current module.  In particular, linking code into a module with
 389   an internal global value may cause the internal to be renamed as necessary to
 390   avoid collisions.  Because the symbol is internal to the module, all
 391   references can be updated.  This corresponds to the notion of the
 392   '<tt>static</tt>' keyword in C, or the idea of "anonymous namespaces" in C++.
 393   </dd>
 394
 395   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
 396
 397   <dd>"<tt>linkonce</tt>" linkage is similar to <tt>internal</tt> linkage, with
 398   the twist that linking together two modules defining the same
 399   <tt>linkonce</tt> globals will cause one of the globals to be discarded.  This
 400   is typically used to implement inline functions.  Unreferenced
 401   <tt>linkonce</tt> globals are allowed to be discarded.
 402   </dd>
 403
 404   <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
 405
 406   <dd>"<tt>weak</tt>" linkage is exactly the same as <tt>linkonce</tt> linkage,
 407   except that unreferenced <tt>weak</tt> globals may not be discarded.  This is
 408   used to implement constructs in C such as "<tt>int X;</tt>" at global scope.
 409   </dd>
 410
 411   <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
 412
 413   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 414   pointer to array type.  When two global variables with appending linkage are
 415   linked together, the two global arrays are appended together.  This is the
 416   LLVM, typesafe, equivalent of having the system linker append together
 417   "sections" with identical names when .o files are linked.
 418   </dd>
 419
 420   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 421
 422   <dd>If none of the above identifiers are used, the global is externally
 423   visible, meaning that it participates in linkage and can be used to resolve
 424   external symbol references.
 425   </dd>
 426 </dl>
 427
 428 <p><a name="linkage_external">For example, since the "<tt>.LC0</tt>"
 429 variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
 430 variable and was linked with this one, one of the two would be renamed,
 431 preventing a collision.  Since "<tt>main</tt>" and "<tt>puts</tt>" are
 432 external (i.e., lacking any linkage declarations), they are accessible
 433 outside of the current module.  It is illegal for a function <i>declaration</i>
 434 to have any linkage type other than "externally visible".</a></p>
 435
 436 </div>
 437
 438 <!-- ======================================================================= -->
 439 <div class="doc_subsection">
 440   <a name="callingconv">Calling Conventions</a>
 441 </div>
 442
 443 <div class="doc_text">
 444
 445 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 446 and <a href="#i_invoke">invokes</a> can all have an optional calling convention
 447 specified for the call.  The calling convention of any pair of dynamic
 448 caller/callee must match, or the behavior of the program is undefined.  The
 449 following calling conventions are supported by LLVM, and more may be added in
 450 the future:</p>
 451
 452 <dl>
 453   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 454
 455   <dd>This calling convention (the default if no other calling convention is
 456   specified) matches the target C calling conventions.  This calling convention
 457   supports varargs function calls and tolerates some mismatch in the declared
 458   prototype and implemented declaration of the function (as does normal C).
 459   </dd>
 460
 461   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 462
 463   <dd>This calling convention attempts to make calls as fast as possible
 464   (e.g. by passing things in registers).  This calling convention allows the
 465   target to use whatever tricks it wants to produce fast code for the target,
 466   without having to conform to an externally specified ABI.  Implementations of
 467   this convention should allow arbitrary tail call optimization to be supported.
 468   This calling convention does not support varargs and requires the prototype of
 469   all callees to exactly match the prototype of the function definition.
 470   </dd>
 471
 472   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 473
 474   <dd>This calling convention attempts to make code in the caller as efficient
 475   as possible under the assumption that the call is not commonly executed.  As
 476   such, these calls often preserve all registers so that the call does not break
 477   any live ranges in the caller side.  This calling convention does not support
 478   varargs and requires the prototype of all callees to exactly match the
 479   prototype of the function definition.
 480   </dd>
 481
 482   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 483
 484   <dd>Any calling convention may be specified by number, allowing
 485   target-specific calling conventions to be used.  Target specific calling
 486   conventions start at 64.
 487   </dd>
 488 </dl>
 489
 490 <p>More calling conventions can be added/defined on an as-needed basis, to
 491 support pascal conventions or any other well-known target-independent
 492 convention.</p>
 493
 494 </div>
 495
 496 <!-- ======================================================================= -->
 497 <div class="doc_subsection">
 498   <a name="globalvars">Global Variables</a>
 499 </div>
 500
 501 <div class="doc_text">
 502
 503 <p>Global variables define regions of memory allocated at compilation time
 504 instead of run-time.  Global variables may optionally be initialized, may have
 505 an explicit section to be placed in, and may
 506 have an optional explicit alignment specified.  A
 507 variable may be defined as a global "constant," which indicates that the
 508 contents of the variable will <b>never</b> be modified (enabling better
 509 optimization, allowing the global data to be placed in the read-only section of
 510 an executable, etc).  Note that variables that need runtime initialization
 511 cannot be marked "constant" as there is a store to the variable.</p>
 512
 513 <p>
 514 LLVM explicitly allows <em>declarations</em> of global variables to be marked
 515 constant, even if the final definition of the global is not.  This capability
 516 can be used to enable slightly better optimization of the program, but requires
 517 the language definition to guarantee that optimizations based on the
 518 'constantness' are valid for the translation units that do not include the
 519 definition.
 520 </p>
 521
 522 <p>As SSA values, global variables define pointer values that are in
 523 scope (i.e. they dominate) all basic blocks in the program.  Global
 524 variables always define a pointer to their "content" type because they
 525 describe a region of memory, and all memory objects in LLVM are
 526 accessed through pointers.</p>
 527
 528 <p>LLVM allows an explicit section to be specified for globals.  If the target
 529 supports it, it will emit globals to the section specified.</p>
 530
 531 <p>An explicit alignment may be specified for a global.  If not present, or if
 532 the alignment is set to zero, the alignment of the global is set by the target
 533 to whatever it feels convenient.  If an explicit alignment is specified, the
 534 global is forced to have at least that much alignment.  All alignments must be
 535 a power of 2.</p>
 536
 537 </div>
 538
 539
 540 <!-- ======================================================================= -->
 541 <div class="doc_subsection">
 542   <a name="functionstructure">Functions</a>
 543 </div>
 544
 545 <div class="doc_text">
 546
 547 <p>LLVM function definitions consist of an optional <a href="#linkage">linkage
 548 type</a>, an optional <a href="#callingconv">calling convention</a>, a return
 549 type, a function name, a (possibly empty) argument list, an optional section,
 550 an optional alignment, an opening curly brace,
 551 a list of basic blocks, and a closing curly brace.  LLVM function declarations
 552 are defined with the "<tt>declare</tt>" keyword, an optional <a
 553 href="#callingconv">calling convention</a>, a return type, a function name,
 554 a possibly empty list of arguments, and an optional alignment.</p>
 555
 556 <p>A function definition contains a list of basic blocks, forming the CFG for
 557 the function.  Each basic block may optionally start with a label (giving the
 558 basic block a symbol table entry), contains a list of instructions, and ends
 559 with a <a href="#terminators">terminator</a> instruction (such as a branch or
 560 function return).</p>
 561
 562 <p>The first basic block in a program is special in two ways: it is immediately
 563 executed on entrance to the function, and it is not allowed to have predecessor
 564 basic blocks (i.e. there can not be any branches to the entry block of a
 565 function).  Because the block can have no predecessors, it also cannot have any
 566 <a href="#i_phi">PHI nodes</a>.</p>
 567
 568 <p>LLVM functions are identified by their name and type signature.  Hence, two
 569 functions with the same name but different parameter lists or return values are
 570 considered different functions, and LLVM will resolve references to each
 571 appropriately.</p>
 572
 573 <p>LLVM allows an explicit section to be specified for functions.  If the target
 574 supports it, it will emit functions to the section specified.</p>
 575
 576 <p>An explicit alignment may be specified for a function.  If not present, or if
 577 the alignment is set to zero, the alignment of the function is set by the target
 578 to whatever it feels convenient.  If an explicit alignment is specified, the
 579 function is forced to have at least that much alignment.  All alignments must be
 580 a power of 2.</p>
 581
 582 </div>
 583
 584 <!-- ======================================================================= -->
 585 <div class="doc_subsection">
 586   <a name="moduleasm">Module-Level Inline Assembly</a></li>
 587 </div>
 588
 589 <div class="doc_text">
 590 <p>
 591 Modules may contain "module-level inline asm" blocks, which corresponds to the
 592 GCC "file scope inline asm" blocks.  These blocks are internally concatenated by
 593 LLVM and treated as a single unit, but may be separated in the .ll file if
 594 desired.  The syntax is very simple:
 595 </p>
 596
 597 <div class="doc_code"><pre>
 598   module asm "inline asm code goes here"
 599   module asm "more can go here"
 600 </pre></div>
 601
 602 <p>The strings can contain any character by escaping non-printable characters.
 603    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
 604    for the number.
 605 </p>
 606
 607 <p>
 608   The inline asm code is simply printed to the machine code .s file when
 609   assembly code is generated.
 610 </p>
 611 </div>
 612
 613
 614 <!-- *********************************************************************** -->
 615 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
 616 <!-- *********************************************************************** -->
 617
 618 <div class="doc_text">
 619
 620 <p>The LLVM type system is one of the most important features of the
 621 intermediate representation.  Being typed enables a number of
 622 optimizations to be performed on the IR directly, without having to do
 623 extra analyses on the side before the transformation.  A strong type
 624 system makes it easier to read the generated code and enables novel
 625 analyses and transformations that are not feasible to perform on normal
 626 three address code representations.</p>
 627
 628 </div>
 629
 630 <!-- ======================================================================= -->
 631 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
 632 <div class="doc_text">
 633 <p>The primitive types are the fundamental building blocks of the LLVM
 634 system. The current set of primitive types is as follows:</p>
 635
 636 <table class="layout">
 637   <tr class="layout">
 638     <td class="left">
 639       <table>
 640         <tbody>
 641         <tr><th>Type</th><th>Description</th></tr>
 642         <tr><td><tt>void</tt></td><td>No value</td></tr>
 643         <tr><td><tt>ubyte</tt></td><td>Unsigned 8-bit value</td></tr>
 644         <tr><td><tt>ushort</tt></td><td>Unsigned 16-bit value</td></tr>
 645         <tr><td><tt>uint</tt></td><td>Unsigned 32-bit value</td></tr>
 646         <tr><td><tt>ulong</tt></td><td>Unsigned 64-bit value</td></tr>
 647         <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
 648         <tr><td><tt>label</tt></td><td>Branch destination</td></tr>
 649         </tbody>
 650       </table>
 651     </td>
 652     <td class="right">
 653       <table>
 654         <tbody>
 655           <tr><th>Type</th><th>Description</th></tr>
 656           <tr><td><tt>bool</tt></td><td>True or False value</td></tr>
 657           <tr><td><tt>sbyte</tt></td><td>Signed 8-bit value</td></tr>
 658           <tr><td><tt>short</tt></td><td>Signed 16-bit value</td></tr>
 659           <tr><td><tt>int</tt></td><td>Signed 32-bit value</td></tr>
 660           <tr><td><tt>long</tt></td><td>Signed 64-bit value</td></tr>
 661           <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
 662         </tbody>
 663       </table>
 664     </td>
 665   </tr>
 666 </table>
 667 </div>
 668
 669 <!-- _______________________________________________________________________ -->
 670 <div class="doc_subsubsection"> <a name="t_classifications">Type
 671 Classifications</a> </div>
 672 <div class="doc_text">
 673 <p>These different primitive types fall into a few useful
 674 classifications:</p>
 675
 676 <table border="1" cellspacing="0" cellpadding="4">
 677   <tbody>
 678     <tr><th>Classification</th><th>Types</th></tr>
 679     <tr>
 680       <td><a name="t_signed">signed</a></td>
 681       <td><tt>sbyte, short, int, long, float, double</tt></td>
 682     </tr>
 683     <tr>
 684       <td><a name="t_unsigned">unsigned</a></td>
 685       <td><tt>ubyte, ushort, uint, ulong</tt></td>
 686     </tr>
 687     <tr>
 688       <td><a name="t_integer">integer</a></td>
 689       <td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td>
 690     </tr>
 691     <tr>
 692       <td><a name="t_integral">integral</a></td>
 693       <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long</tt>
 694       </td>
 695     </tr>
 696     <tr>
 697       <td><a name="t_floating">floating point</a></td>
 698       <td><tt>float, double</tt></td>
 699     </tr>
 700     <tr>
 701       <td><a name="t_firstclass">first class</a></td>
 702       <td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long,<br>
 703       float, double, <a href="#t_pointer">pointer</a>,
 704       <a href="#t_packed">packed</a></tt></td>
 705     </tr>
 706   </tbody>
 707 </table>
 708
 709 <p>The <a href="#t_firstclass">first class</a> types are perhaps the
 710 most important.  Values of these types are the only ones which can be
 711 produced by instructions, passed as arguments, or used as operands to
 712 instructions.  This means that all structures and arrays must be
 713 manipulated either by pointer or by component.</p>
 714 </div>
 715
 716 <!-- ======================================================================= -->
 717 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
 718
 719 <div class="doc_text">
 720
 721 <p>The real power in LLVM comes from the derived types in the system.
 722 This is what allows a programmer to represent arrays, functions,
 723 pointers, and other useful types.  Note that these derived types may be
 724 recursive: For example, it is possible to have a two dimensional array.</p>
 725
 726 </div>
 727
 728 <!-- _______________________________________________________________________ -->
 729 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
 730
 731 <div class="doc_text">
 732
 733 <h5>Overview:</h5>
 734
 735 <p>The array type is a very simple derived type that arranges elements
 736 sequentially in memory.  The array type requires a size (number of
 737 elements) and an underlying data type.</p>
 738
 739 <h5>Syntax:</h5>
 740
 741 <pre>
 742   [&lt;# elements&gt; x &lt;elementtype&gt;]
 743 </pre>
 744
 745 <p>The number of elements is a constant integer value; elementtype may
 746 be any type with a size.</p>
 747
 748 <h5>Examples:</h5>
 749 <table class="layout">
 750   <tr class="layout">
 751     <td class="left">
 752       <tt>[40 x int ]</tt><br/>
 753       <tt>[41 x int ]</tt><br/>
 754       <tt>[40 x uint]</tt><br/>
 755     </td>
 756     <td class="left">
 757       Array of 40 integer values.<br/>
 758       Array of 41 integer values.<br/>
 759       Array of 40 unsigned integer values.<br/>
 760     </td>
 761   </tr>
 762 </table>
 763 <p>Here are some examples of multidimensional arrays:</p>
 764 <table class="layout">
 765   <tr class="layout">
 766     <td class="left">
 767       <tt>[3 x [4 x int]]</tt><br/>
 768       <tt>[12 x [10 x float]]</tt><br/>
 769       <tt>[2 x [3 x [4 x uint]]]</tt><br/>
 770     </td>
 771     <td class="left">
 772       3x4 array of integer values.<br/>
 773       12x10 array of single precision floating point values.<br/>
 774       2x3x4 array of unsigned integer values.<br/>
 775     </td>
 776   </tr>
 777 </table>
 778
 779 <p>Note that 'variable sized arrays' can be implemented in LLVM with a zero
 780 length array.  Normally, accesses past the end of an array are undefined in
 781 LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
 782 As a special case, however, zero length arrays are recognized to be variable
 783 length.  This allows implementation of 'pascal style arrays' with the  LLVM
 784 type "{ int, [0 x float]}", for example.</p>
 785
 786 </div>
 787
 788 <!-- _______________________________________________________________________ -->
 789 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
 790 <div class="doc_text">
 791 <h5>Overview:</h5>
 792 <p>The function type can be thought of as a function signature.  It
 793 consists of a return type and a list of formal parameter types.
 794 Function types are usually used to build virtual function tables
 795 (which are structures of pointers to functions), for indirect function
 796 calls, and when defining a function.</p>
 797 <p>
 798 The return type of a function type cannot be an aggregate type.
 799 </p>
 800 <h5>Syntax:</h5>
 801 <pre>  &lt;returntype&gt; (&lt;parameter list&gt;)<br></pre>
 802 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
 803 specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
 804 which indicates that the function takes a variable number of arguments.
 805 Variable argument functions can access their arguments with the <a
 806  href="#int_varargs">variable argument handling intrinsic</a> functions.</p>
 807 <h5>Examples:</h5>
 808 <table class="layout">
 809   <tr class="layout">
 810     <td class="left">
 811       <tt>int (int)</tt> <br/>
 812       <tt>float (int, int *) *</tt><br/>
 813       <tt>int (sbyte *, ...)</tt><br/>
 814     </td>
 815     <td class="left">
 816       function taking an <tt>int</tt>, returning an <tt>int</tt><br/>
 817       <a href="#t_pointer">Pointer</a> to a function that takes an
 818       <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>,
 819       returning <tt>float</tt>.<br/>
 820       A vararg function that takes at least one <a href="#t_pointer">pointer</a>
 821       to <tt>sbyte</tt> (signed char in C), which returns an integer.  This is
 822       the signature for <tt>printf</tt> in LLVM.<br/>
 823     </td>
 824   </tr>
 825 </table>
 826
 827 </div>
 828 <!-- _______________________________________________________________________ -->
 829 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
 830 <div class="doc_text">
 831 <h5>Overview:</h5>
 832 <p>The structure type is used to represent a collection of data members
 833 together in memory.  The packing of the field types is defined to match
 834 the ABI of the underlying processor.  The elements of a structure may
 835 be any type that has a size.</p>
 836 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
 837 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
 838 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
 839 instruction.</p>
 840 <h5>Syntax:</h5>
 841 <pre>  { &lt;type list&gt; }<br></pre>
 842 <h5>Examples:</h5>
 843 <table class="layout">
 844   <tr class="layout">
 845     <td class="left">
 846       <tt>{ int, int, int }</tt><br/>
 847       <tt>{ float, int (int) * }</tt><br/>
 848     </td>
 849     <td class="left">
 850       a triple of three <tt>int</tt> values<br/>
 851       A pair, where the first element is a <tt>float</tt> and the second element
 852       is a <a href="#t_pointer">pointer</a> to a <a href="#t_function">function</a>
 853       that takes an <tt>int</tt>, returning an <tt>int</tt>.<br/>
 854     </td>
 855   </tr>
 856 </table>
 857 </div>
 858
 859 <!-- _______________________________________________________________________ -->
 860 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
 861 <div class="doc_text">
 862 <h5>Overview:</h5>
 863 <p>As in many languages, the pointer type represents a pointer or
 864 reference to another object, which must live in memory.</p>
 865 <h5>Syntax:</h5>
 866 <pre>  &lt;type&gt; *<br></pre>
 867 <h5>Examples:</h5>
 868 <table class="layout">
 869   <tr class="layout">
 870     <td class="left">
 871       <tt>[4x int]*</tt><br/>
 872       <tt>int (int *) *</tt><br/>
 873     </td>
 874     <td class="left">
 875       A <a href="#t_pointer">pointer</a> to <a href="#t_array">array</a> of
 876       four <tt>int</tt> values<br/>
 877       A <a href="#t_pointer">pointer</a> to a <a
 878       href="#t_function">function</a> that takes an <tt>int*</tt>, returning an
 879       <tt>int</tt>.<br/>
 880     </td>
 881   </tr>
 882 </table>
 883 </div>
 884
 885 <!-- _______________________________________________________________________ -->
 886 <div class="doc_subsubsection"> <a name="t_packed">Packed Type</a> </div>
 887 <div class="doc_text">
 888
 889 <h5>Overview:</h5>
 890
 891 <p>A packed type is a simple derived type that represents a vector
 892 of elements.  Packed types are used when multiple primitive data
 893 are operated in parallel using a single instruction (SIMD).
 894 A packed type requires a size (number of
 895 elements) and an underlying primitive data type.  Vectors must have a power
 896 of two length (1, 2, 4, 8, 16 ...).  Packed types are
 897 considered <a href="#t_firstclass">first class</a>.</p>
 898
 899 <h5>Syntax:</h5>
 900
 901 <pre>
 902   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
 903 </pre>
 904
 905 <p>The number of elements is a constant integer value; elementtype may
 906 be any integral or floating point type.</p>
 907
 908 <h5>Examples:</h5>
 909
 910 <table class="layout">
 911   <tr class="layout">
 912     <td class="left">
 913       <tt>&lt;4 x int&gt;</tt><br/>
 914       <tt>&lt;8 x float&gt;</tt><br/>
 915       <tt>&lt;2 x uint&gt;</tt><br/>
 916     </td>
 917     <td class="left">
 918       Packed vector of 4 integer values.<br/>
 919       Packed vector of 8 floating-point values.<br/>
 920       Packed vector of 2 unsigned integer values.<br/>
 921     </td>
 922   </tr>
 923 </table>
 924 </div>
 925
 926 <!-- _______________________________________________________________________ -->
 927 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
 928 <div class="doc_text">
 929
 930 <h5>Overview:</h5>
 931
 932 <p>Opaque types are used to represent unknown types in the system.  This
 933 corresponds (for example) to the C notion of a foward declared structure type.
 934 In LLVM, opaque types can eventually be resolved to any type (not just a
 935 structure type).</p>
 936
 937 <h5>Syntax:</h5>
 938
 939 <pre>
 940   opaque
 941 </pre>
 942
 943 <h5>Examples:</h5>
 944
 945 <table class="layout">
 946   <tr class="layout">
 947     <td class="left">
 948       <tt>opaque</tt>
 949     </td>
 950     <td class="left">
 951       An opaque type.<br/>
 952     </td>
 953   </tr>
 954 </table>
 955 </div>
 956
 957
 958 <!-- *********************************************************************** -->
 959 <div class="doc_section"> <a name="constants">Constants</a> </div>
 960 <!-- *********************************************************************** -->
 961
 962 <div class="doc_text">
 963
 964 <p>LLVM has several different basic types of constants.  This section describes
 965 them all and their syntax.</p>
 966
 967 </div>
 968
 969 <!-- ======================================================================= -->
 970 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
 971
 972 <div class="doc_text">
 973
 974 <dl>
 975   <dt><b>Boolean constants</b></dt>
 976
 977   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
 978   constants of the <tt><a href="#t_primitive">bool</a></tt> type.
 979   </dd>
 980
 981   <dt><b>Integer constants</b></dt>
 982
 983   <dd>Standard integers (such as '4') are constants of the <a
 984   href="#t_integer">integer</a> type.  Negative numbers may be used with signed
 985   integer types.
 986   </dd>
 987
 988   <dt><b>Floating point constants</b></dt>
 989
 990   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
 991   exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
 992   notation (see below).  Floating point constants must have a <a
 993   href="#t_floating">floating point</a> type. </dd>
 994
 995   <dt><b>Null pointer constants</b></dt>
 996
 997   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
 998   and must be of <a href="#t_pointer">pointer type</a>.</dd>
 999
1000 </dl>
1001
1002 <p>The one non-intuitive notation for constants is the optional hexadecimal form
1003 of floating point constants.  For example, the form '<tt>double
1004 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
1005 4.5e+15</tt>'.  The only time hexadecimal floating point constants are required
1006 (and the only time that they are generated by the disassembler) is when a
1007 floating point constant must be emitted but it cannot be represented as a
1008 decimal floating point number.  For example, NaN's, infinities, and other
1009 special values are represented in their IEEE hexadecimal format so that
1010 assembly and disassembly do not cause any bits to change in the constants.</p>
1011
1012 </div>
1013
1014 <!-- ======================================================================= -->
1015 <div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a>
1016 </div>
1017
1018 <div class="doc_text">
1019 <p>Aggregate constants arise from aggregation of simple constants
1020 and smaller aggregate constants.</p>
1021
1022 <dl>
1023   <dt><b>Structure constants</b></dt>
1024
1025   <dd>Structure constants are represented with notation similar to structure
1026   type definitions (a comma separated list of elements, surrounded by braces
1027   (<tt>{}</tt>)).  For example: "<tt>{ int 4, float 17.0, int* %G }</tt>",
1028   where "<tt>%G</tt>" is declared as "<tt>%G = external global int</tt>".  Structure constants
1029   must have <a href="#t_struct">structure type</a>, and the number and
1030   types of elements must match those specified by the type.
1031   </dd>
1032
1033   <dt><b>Array constants</b></dt>
1034
1035   <dd>Array constants are represented with notation similar to array type
1036   definitions (a comma separated list of elements, surrounded by square brackets
1037   (<tt>[]</tt>)).  For example: "<tt>[ int 42, int 11, int 74 ]</tt>".  Array
1038   constants must have <a href="#t_array">array type</a>, and the number and
1039   types of elements must match those specified by the type.
1040   </dd>
1041
1042   <dt><b>Packed constants</b></dt>
1043
1044   <dd>Packed constants are represented with notation similar to packed type
1045   definitions (a comma separated list of elements, surrounded by
1046   less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; int 42,
1047   int 11, int 74, int 100 &gt;</tt>".  Packed constants must have <a
1048   href="#t_packed">packed type</a>, and the number and types of elements must
1049   match those specified by the type.
1050   </dd>
1051
1052   <dt><b>Zero initialization</b></dt>
1053
1054   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
1055   value to zero of <em>any</em> type, including scalar and aggregate types.
1056   This is often used to avoid having to print large zero initializers (e.g. for
1057   large arrays) and is always exactly equivalent to using explicit zero
1058   initializers.
1059   </dd>
1060 </dl>
1061
1062 </div>
1063
1064 <!-- ======================================================================= -->
1065 <div class="doc_subsection">
1066   <a name="globalconstants">Global Variable and Function Addresses</a>
1067 </div>
1068
1069 <div class="doc_text">
1070
1071 <p>The addresses of <a href="#globalvars">global variables</a> and <a
1072 href="#functionstructure">functions</a> are always implicitly valid (link-time)
1073 constants.  These constants are explicitly referenced when the <a
1074 href="#identifiers">identifier for the global</a> is used and always have <a
1075 href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
1076 file:</p>
1077
1078 <pre>
1079   %X = global int 17
1080   %Y = global int 42
1081   %Z = global [2 x int*] [ int* %X, int* %Y ]
1082 </pre>
1083
1084 </div>
1085
1086 <!-- ======================================================================= -->
1087 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
1088 <div class="doc_text">
1089   <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
1090   no specific value.  Undefined values may be of any type and be used anywhere
1091   a constant is permitted.</p>
1092
1093   <p>Undefined values indicate to the compiler that the program is well defined
1094   no matter what value is used, giving the compiler more freedom to optimize.
1095   </p>
1096 </div>
1097
1098 <!-- ======================================================================= -->
1099 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
1100 </div>
1101
1102 <div class="doc_text">
1103
1104 <p>Constant expressions are used to allow expressions involving other constants
1105 to be used as constants.  Constant expressions may be of any <a
1106 href="#t_firstclass">first class</a> type and may involve any LLVM operation
1107 that does not have side effects (e.g. load and call are not supported).  The
1108 following is the syntax for constant expressions:</p>
1109
1110 <dl>
1111   <dt><b><tt>cast ( CST to TYPE )</tt></b></dt>
1112
1113   <dd>Cast a constant to another type.</dd>
1114
1115   <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
1116
1117   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
1118   constants.  As with the <a href="#i_getelementptr">getelementptr</a>
1119   instruction, the index list may have zero or more indexes, which are required
1120   to make sense for the type of "CSTPTR".</dd>
1121
1122   <dt><b><tt>select ( COND, VAL1, VAL2 )</tt></b></dt>
1123
1124   <dd>Perform the <a href="#i_select">select operation</a> on
1125   constants.
1126
1127   <dt><b><tt>extractelement ( VAL, IDX )</tt></b></dt>
1128
1129   <dd>Perform the <a href="#i_extractelement">extractelement
1130   operation</a> on constants.
1131
1132   <dt><b><tt>insertelement ( VAL, ELT, IDX )</tt></b></dt>
1133
1134   <dd>Perform the <a href="#i_insertelement">insertelement
1135   operation</a> on constants.
1136
1137   <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
1138
1139   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
1140   be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
1141   binary</a> operations.  The constraints on operands are the same as those for
1142   the corresponding instruction (e.g. no bitwise operations on floating point
1143   values are allowed).</dd>
1144 </dl>
1145 </div>
1146
1147 <!-- *********************************************************************** -->
1148 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
1149 <!-- *********************************************************************** -->
1150
1151 <!-- ======================================================================= -->
1152 <div class="doc_subsection">
1153 <a name="inlineasm">Inline Assembler Expressions</a>
1154 </div>
1155
1156 <div class="doc_text">
1157
1158 <p>
1159 LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm">
1160 Module-Level Inline Assembly</a>) through the use of a special value.  This
1161 value represents the inline assembler as a string (containing the instructions
1162 to emit), a list of operand constraints (stored as a string), and a flag that
1163 indicates whether or not the inline asm expression has side effects.  An example
1164 inline assembler expression is:
1165 </p>
1166
1167 <pre>
1168   int(int) asm "bswap $0", "=r,r"
1169 </pre>
1170
1171 <p>
1172 Inline assembler expressions may <b>only</b> be used as the callee operand of
1173 a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we have:
1174 </p>
1175
1176 <pre>
1177   %X = call int asm "<a href="#i_bswap">bswap</a> $0", "=r,r"(int %Y)
1178 </pre>
1179
1180 <p>
1181 Inline asms with side effects not visible in the constraint list must be marked
1182 as having side effects.  This is done through the use of the
1183 '<tt>sideeffect</tt>' keyword, like so:
1184 </p>
1185
1186 <pre>
1187   call void asm sideeffect "eieio", ""()
1188 </pre>
1189
1190 <p>TODO: The format of the asm and constraints string still need to be
1191 documented here.  Constraints on what can be done (e.g. duplication, moving, etc
1192 need to be documented).
1193 </p>
1194
1195 </div>
1196
1197 <!-- *********************************************************************** -->
1198 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
1199 <!-- *********************************************************************** -->
1200
1201 <div class="doc_text">
1202
1203 <p>The LLVM instruction set consists of several different
1204 classifications of instructions: <a href="#terminators">terminator
1205 instructions</a>, <a href="#binaryops">binary instructions</a>,
1206 <a href="#bitwiseops">bitwise binary instructions</a>, <a
1207  href="#memoryops">memory instructions</a>, and <a href="#otherops">other
1208 instructions</a>.</p>
1209
1210 </div>
1211
1212 <!-- ======================================================================= -->
1213 <div class="doc_subsection"> <a name="terminators">Terminator
1214 Instructions</a> </div>
1215
1216 <div class="doc_text">
1217
1218 <p>As mentioned <a href="#functionstructure">previously</a>, every
1219 basic block in a program ends with a "Terminator" instruction, which
1220 indicates which block should be executed after the current block is
1221 finished. These terminator instructions typically yield a '<tt>void</tt>'
1222 value: they produce control flow, not values (the one exception being
1223 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
1224 <p>There are six different terminator instructions: the '<a
1225  href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
1226 instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
1227 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
1228  href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
1229  href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
1230
1231 </div>
1232
1233 <!-- _______________________________________________________________________ -->
1234 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
1235 Instruction</a> </div>
1236 <div class="doc_text">
1237 <h5>Syntax:</h5>
1238 <pre>  ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
1239   ret void                 <i>; Return from void function</i>
1240 </pre>
1241 <h5>Overview:</h5>
1242 <p>The '<tt>ret</tt>' instruction is used to return control flow (and a
1243 value) from a function back to the caller.</p>
1244 <p>There are two forms of the '<tt>ret</tt>' instruction: one that
1245 returns a value and then causes control flow, and one that just causes
1246 control flow to occur.</p>
1247 <h5>Arguments:</h5>
1248 <p>The '<tt>ret</tt>' instruction may return any '<a
1249  href="#t_firstclass">first class</a>' type.  Notice that a function is
1250 not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>'
1251 instruction inside of the function that returns a value that does not
1252 match the return type of the function.</p>
1253 <h5>Semantics:</h5>
1254 <p>When the '<tt>ret</tt>' instruction is executed, control flow
1255 returns back to the calling function's context.  If the caller is a "<a
1256  href="#i_call"><tt>call</tt></a>" instruction, execution continues at
1257 the instruction after the call.  If the caller was an "<a
1258  href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
1259 at the beginning of the "normal" destination block.  If the instruction
1260 returns a value, that value shall set the call or invoke instruction's
1261 return value.</p>
1262 <h5>Example:</h5>
1263 <pre>  ret int 5                       <i>; Return an integer value of 5</i>
1264   ret void                        <i>; Return from a void function</i>
1265 </pre>
1266 </div>
1267 <!-- _______________________________________________________________________ -->
1268 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
1269 <div class="doc_text">
1270 <h5>Syntax:</h5>
1271 <pre>  br bool &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
1272 </pre>
1273 <h5>Overview:</h5>
1274 <p>The '<tt>br</tt>' instruction is used to cause control flow to
1275 transfer to a different basic block in the current function.  There are
1276 two forms of this instruction, corresponding to a conditional branch
1277 and an unconditional branch.</p>
1278 <h5>Arguments:</h5>
1279 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a
1280 single '<tt>bool</tt>' value and two '<tt>label</tt>' values.  The
1281 unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>'
1282 value as a target.</p>
1283 <h5>Semantics:</h5>
1284 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>'
1285 argument is evaluated.  If the value is <tt>true</tt>, control flows
1286 to the '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
1287 control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
1288 <h5>Example:</h5>
1289 <pre>Test:<br>  %cond = <a href="#i_setcc">seteq</a> int %a, %b<br>  br bool %cond, label %IfEqual, label %IfUnequal<br>IfEqual:<br>  <a
1290  href="#i_ret">ret</a> int 1<br>IfUnequal:<br>  <a href="#i_ret">ret</a> int 0<br></pre>
1291 </div>
1292 <!-- _______________________________________________________________________ -->
1293 <div class="doc_subsubsection">
1294    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
1295 </div>
1296
1297 <div class="doc_text">
1298 <h5>Syntax:</h5>
1299
1300 <pre>
1301   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
1302 </pre>
1303
1304 <h5>Overview:</h5>
1305
1306 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
1307 several different places.  It is a generalization of the '<tt>br</tt>'
1308 instruction, allowing a branch to occur to one of many possible
1309 destinations.</p>
1310
1311
1312 <h5>Arguments:</h5>
1313
1314 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
1315 comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
1316 an array of pairs of comparison value constants and '<tt>label</tt>'s.  The
1317 table is not allowed to contain duplicate constant entries.</p>
1318
1319 <h5>Semantics:</h5>
1320
1321 <p>The <tt>switch</tt> instruction specifies a table of values and
1322 destinations. When the '<tt>switch</tt>' instruction is executed, this
1323 table is searched for the given value.  If the value is found, control flow is
1324 transfered to the corresponding destination; otherwise, control flow is
1325 transfered to the default destination.</p>
1326
1327 <h5>Implementation:</h5>
1328
1329 <p>Depending on properties of the target machine and the particular
1330 <tt>switch</tt> instruction, this instruction may be code generated in different
1331 ways.  For example, it could be generated as a series of chained conditional
1332 branches or with a lookup table.</p>
1333
1334 <h5>Example:</h5>
1335
1336 <pre>
1337  <i>; Emulate a conditional br instruction</i>
1338  %Val = <a href="#i_cast">cast</a> bool %value to int
1339  switch int %Val, label %truedest [int 0, label %falsedest ]
1340
1341  <i>; Emulate an unconditional br instruction</i>
1342  switch uint 0, label %dest [ ]
1343
1344  <i>; Implement a jump table:</i>
1345  switch uint %val, label %otherwise [ uint 0, label %onzero
1346                                       uint 1, label %onone
1347                                       uint 2, label %ontwo ]
1348 </pre>
1349 </div>
1350
1351 <!-- _______________________________________________________________________ -->
1352 <div class="doc_subsubsection">
1353   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
1354 </div>
1355
1356 <div class="doc_text">
1357
1358 <h5>Syntax:</h5>
1359
1360 <pre>
1361   &lt;result&gt; = invoke [<a href="#callingconv">cconv</a>] &lt;ptr to function ty&gt; %&lt;function ptr val&gt;(&lt;function args&gt;)
1362                 to label &lt;normal label&gt; except label &lt;exception label&gt;
1363 </pre>
1364
1365 <h5>Overview:</h5>
1366
1367 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
1368 function, with the possibility of control flow transfer to either the
1369 '<tt>normal</tt>' label or the
1370 '<tt>exception</tt>' label.  If the callee function returns with the
1371 "<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the
1372 "normal" label.  If the callee (or any indirect callees) returns with the "<a
1373 href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and
1374 continued at the dynamically nearest "exception" label.</p>
1375
1376 <h5>Arguments:</h5>
1377
1378 <p>This instruction requires several arguments:</p>
1379
1380 <ol>
1381   <li>
1382     The optional "cconv" marker indicates which <a href="callingconv">calling
1383     convention</a> the call should use.  If none is specified, the call defaults
1384     to using C calling conventions.
1385   </li>
1386   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
1387   function value being invoked.  In most cases, this is a direct function
1388   invocation, but indirect <tt>invoke</tt>s are just as possible, branching off
1389   an arbitrary pointer to function value.
1390   </li>
1391
1392   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
1393   function to be invoked. </li>
1394
1395   <li>'<tt>function args</tt>': argument list whose types match the function
1396   signature argument types.  If the function signature indicates the function
1397   accepts a variable number of arguments, the extra arguments can be
1398   specified. </li>
1399
1400   <li>'<tt>normal label</tt>': the label reached when the called function
1401   executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
1402
1403   <li>'<tt>exception label</tt>': the label reached when a callee returns with
1404   the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
1405
1406 </ol>
1407
1408 <h5>Semantics:</h5>
1409
1410 <p>This instruction is designed to operate as a standard '<tt><a
1411 href="#i_call">call</a></tt>' instruction in most regards.  The primary
1412 difference is that it establishes an association with a label, which is used by
1413 the runtime library to unwind the stack.</p>
1414
1415 <p>This instruction is used in languages with destructors to ensure that proper
1416 cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
1417 exception.  Additionally, this is important for implementation of
1418 '<tt>catch</tt>' clauses in high-level languages that support them.</p>
1419
1420 <h5>Example:</h5>
1421 <pre>
1422   %retval = invoke int %Test(int 15)             to label %Continue
1423               except label %TestCleanup     <i>; {int}:retval set</i>
1424   %retval = invoke <a href="#callingconv">coldcc</a> int %Test(int 15)             to label %Continue
1425               except label %TestCleanup     <i>; {int}:retval set</i>
1426 </pre>
1427 </div>
1428
1429
1430 <!-- _______________________________________________________________________ -->
1431
1432 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
1433 Instruction</a> </div>
1434
1435 <div class="doc_text">
1436
1437 <h5>Syntax:</h5>
1438 <pre>
1439   unwind
1440 </pre>
1441
1442 <h5>Overview:</h5>
1443
1444 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
1445 at the first callee in the dynamic call stack which used an <a
1446 href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.  This is
1447 primarily used to implement exception handling.</p>
1448
1449 <h5>Semantics:</h5>
1450
1451 <p>The '<tt>unwind</tt>' intrinsic causes execution of the current function to
1452 immediately halt.  The dynamic call stack is then searched for the first <a
1453 href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.  Once found,
1454 execution continues at the "exceptional" destination block specified by the
1455 <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt> instruction in the
1456 dynamic call chain, undefined behavior results.</p>
1457 </div>
1458
1459 <!-- _______________________________________________________________________ -->
1460
1461 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
1462 Instruction</a> </div>
1463
1464 <div class="doc_text">
1465
1466 <h5>Syntax:</h5>
1467 <pre>
1468   unreachable
1469 </pre>
1470
1471 <h5>Overview:</h5>
1472
1473 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
1474 instruction is used to inform the optimizer that a particular portion of the
1475 code is not reachable.  This can be used to indicate that the code after a
1476 no-return function cannot be reached, and other facts.</p>
1477
1478 <h5>Semantics:</h5>
1479
1480 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
1481 </div>
1482
1483
1484
1485 <!-- ======================================================================= -->
1486 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
1487 <div class="doc_text">
1488 <p>Binary operators are used to do most of the computation in a
1489 program.  They require two operands, execute an operation on them, and
1490 produce a single value.  The operands might represent
1491 multiple data, as is the case with the <a href="#t_packed">packed</a> data type.
1492 The result value of a binary operator is not
1493 necessarily the same type as its operands.</p>
1494 <p>There are several different binary operators:</p>
1495 </div>
1496 <!-- _______________________________________________________________________ -->
1497 <div class="doc_subsubsection"> <a name="i_add">'<tt>add</tt>'
1498 Instruction</a> </div>
1499 <div class="doc_text">
1500 <h5>Syntax:</h5>
1501 <pre>  &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1502 </pre>
1503 <h5>Overview:</h5>
1504 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
1505 <h5>Arguments:</h5>
1506 <p>The two arguments to the '<tt>add</tt>' instruction must be either <a
1507  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a> values.
1508  This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1509 Both arguments must have identical types.</p>
1510 <h5>Semantics:</h5>
1511 <p>The value produced is the integer or floating point sum of the two
1512 operands.</p>
1513 <h5>Example:</h5>
1514 <pre>  &lt;result&gt; = add int 4, %var          <i>; yields {int}:result = 4 + %var</i>
1515 </pre>
1516 </div>
1517 <!-- _______________________________________________________________________ -->
1518 <div class="doc_subsubsection"> <a name="i_sub">'<tt>sub</tt>'
1519 Instruction</a> </div>
1520 <div class="doc_text">
1521 <h5>Syntax:</h5>
1522 <pre>  &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1523 </pre>
1524 <h5>Overview:</h5>
1525 <p>The '<tt>sub</tt>' instruction returns the difference of its two
1526 operands.</p>
1527 <p>Note that the '<tt>sub</tt>' instruction is used to represent the '<tt>neg</tt>'
1528 instruction present in most other intermediate representations.</p>
1529 <h5>Arguments:</h5>
1530 <p>The two arguments to the '<tt>sub</tt>' instruction must be either <a
1531  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1532 values.
1533 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1534 Both arguments must have identical types.</p>
1535 <h5>Semantics:</h5>
1536 <p>The value produced is the integer or floating point difference of
1537 the two operands.</p>
1538 <h5>Example:</h5>
1539 <pre>  &lt;result&gt; = sub int 4, %var          <i>; yields {int}:result = 4 - %var</i>
1540   &lt;result&gt; = sub int 0, %val          <i>; yields {int}:result = -%var</i>
1541 </pre>
1542 </div>
1543 <!-- _______________________________________________________________________ -->
1544 <div class="doc_subsubsection"> <a name="i_mul">'<tt>mul</tt>'
1545 Instruction</a> </div>
1546 <div class="doc_text">
1547 <h5>Syntax:</h5>
1548 <pre>  &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1549 </pre>
1550 <h5>Overview:</h5>
1551 <p>The  '<tt>mul</tt>' instruction returns the product of its two
1552 operands.</p>
1553 <h5>Arguments:</h5>
1554 <p>The two arguments to the '<tt>mul</tt>' instruction must be either <a
1555  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1556 values.
1557 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1558 Both arguments must have identical types.</p>
1559 <h5>Semantics:</h5>
1560 <p>The value produced is the integer or floating point product of the
1561 two operands.</p>
1562 <p>There is no signed vs unsigned multiplication.  The appropriate
1563 action is taken based on the type of the operand.</p>
1564 <h5>Example:</h5>
1565 <pre>  &lt;result&gt; = mul int 4, %var          <i>; yields {int}:result = 4 * %var</i>
1566 </pre>
1567 </div>
1568 <!-- _______________________________________________________________________ -->
1569 <div class="doc_subsubsection"> <a name="i_div">'<tt>div</tt>'
1570 Instruction</a> </div>
1571 <div class="doc_text">
1572 <h5>Syntax:</h5>
1573 <pre>  &lt;result&gt; = div &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1574 </pre>
1575 <h5>Overview:</h5>
1576 <p>The '<tt>div</tt>' instruction returns the quotient of its two
1577 operands.</p>
1578 <h5>Arguments:</h5>
1579 <p>The two arguments to the '<tt>div</tt>' instruction must be either <a
1580  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1581 values.
1582 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1583 Both arguments must have identical types.</p>
1584 <h5>Semantics:</h5>
1585 <p>The value produced is the integer or floating point quotient of the
1586 two operands.</p>
1587 <h5>Example:</h5>
1588 <pre>  &lt;result&gt; = div int 4, %var          <i>; yields {int}:result = 4 / %var</i>
1589 </pre>
1590 </div>
1591 <!-- _______________________________________________________________________ -->
1592 <div class="doc_subsubsection"> <a name="i_rem">'<tt>rem</tt>'
1593 Instruction</a> </div>
1594 <div class="doc_text">
1595 <h5>Syntax:</h5>
1596 <pre>  &lt;result&gt; = rem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1597 </pre>
1598 <h5>Overview:</h5>
1599 <p>The '<tt>rem</tt>' instruction returns the remainder from the
1600 division of its two operands.</p>
1601 <h5>Arguments:</h5>
1602 <p>The two arguments to the '<tt>rem</tt>' instruction must be either <a
1603  href="#t_integer">integer</a> or <a href="#t_floating">floating point</a>
1604 values.
1605 This instruction can also take <a href="#t_packed">packed</a> versions of the values.
1606 Both arguments must have identical types.</p>
1607 <h5>Semantics:</h5>
1608 <p>This returns the <i>remainder</i> of a division (where the result
1609 has the same sign as the divisor), not the <i>modulus</i> (where the
1610 result has the same sign as the dividend) of a value.  For more
1611 information about the difference, see <a
1612  href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
1613 Math Forum</a>.</p>
1614 <h5>Example:</h5>
1615 <pre>  &lt;result&gt; = rem int 4, %var          <i>; yields {int}:result = 4 % %var</i>
1616 </pre>
1617
1618 </div>
1619 <!-- _______________________________________________________________________ -->
1620 <div class="doc_subsubsection"> <a name="i_setcc">'<tt>set<i>cc</i></tt>'
1621 Instructions</a> </div>
1622 <div class="doc_text">
1623 <h5>Syntax:</h5>
1624 <pre>  &lt;result&gt; = seteq &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1625   &lt;result&gt; = setne &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1626   &lt;result&gt; = setlt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1627   &lt;result&gt; = setgt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1628   &lt;result&gt; = setle &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1629   &lt;result&gt; = setge &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
1630 </pre>
1631 <h5>Overview:</h5>
1632 <p>The '<tt>set<i>cc</i></tt>' family of instructions returns a boolean
1633 value based on a comparison of their two operands.</p>
1634 <h5>Arguments:</h5>
1635 <p>The two arguments to the '<tt>set<i>cc</i></tt>' instructions must
1636 be of <a href="#t_firstclass">first class</a> type (it is not possible
1637 to compare '<tt>label</tt>'s, '<tt>array</tt>'s, '<tt>structure</tt>'
1638 or '<tt>void</tt>' values, etc...).  Both arguments must have identical
1639 types.</p>
1640 <h5>Semantics:</h5>
1641 <p>The '<tt>seteq</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1642 value if both operands are equal.<br>
1643 The '<tt>setne</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1644 value if both operands are unequal.<br>
1645 The '<tt>setlt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1646 value if the first operand is less than the second operand.<br>
1647 The '<tt>setgt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1648 value if the first operand is greater than the second operand.<br>
1649 The '<tt>setle</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1650 value if the first operand is less than or equal to the second operand.<br>
1651 The '<tt>setge</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>'
1652 value if the first operand is greater than or equal to the second
1653 operand.</p>
1654 <h5>Example:</h5>
1655 <pre>  &lt;result&gt; = seteq int   4, 5        <i>; yields {bool}:result = false</i>
1656   &lt;result&gt; = setne float 4, 5        <i>; yields {bool}:result = true</i>
1657   &lt;result&gt; = setlt uint  4, 5        <i>; yields {bool}:result = true</i>
1658   &lt;result&gt; = setgt sbyte 4, 5        <i>; yields {bool}:result = false</i>
1659   &lt;result&gt; = setle sbyte 4, 5        <i>; yields {bool}:result = true</i>
1660   &lt;result&gt; = setge sbyte 4, 5        <i>; yields {bool}:result = false</i>
1661 </pre>
1662 </div>
1663
1664 <!-- ======================================================================= -->
1665 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
1666 Operations</a> </div>
1667 <div class="doc_text">
1668 <p>Bitwise binary operators are used to do various forms of
1669 bit-twiddling in a program.  They are generally very efficient
1670 instructions and can commonly be strength reduced from other
1671 instructions.  They require two operands, execute an operation on them,
1672 and produce a single value.  The resulting value of the bitwise binary
1673 operators is always the same type as its first operand.</p>
1674 </div>
1675 <!-- _______________________________________________________________________ -->
1676 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
1677 Instruction</a> </div>
1678 <div class="doc_text">
1679 <h5>Syntax:</h5>
1680 <pre>  &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1681 </pre>
1682 <h5>Overview:</h5>
1683 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of
1684 its two operands.</p>
1685 <h5>Arguments:</h5>
1686 <p>The two arguments to the '<tt>and</tt>' instruction must be <a
1687  href="#t_integral">integral</a> values.  Both arguments must have
1688 identical types.</p>
1689 <h5>Semantics:</h5>
1690 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
1691 <p> </p>
1692 <div style="align: center">
1693 <table border="1" cellspacing="0" cellpadding="4">
1694   <tbody>
1695     <tr>
1696       <td>In0</td>
1697       <td>In1</td>
1698       <td>Out</td>
1699     </tr>
1700     <tr>
1701       <td>0</td>
1702       <td>0</td>
1703       <td>0</td>
1704     </tr>
1705     <tr>
1706       <td>0</td>
1707       <td>1</td>
1708       <td>0</td>
1709     </tr>
1710     <tr>
1711       <td>1</td>
1712       <td>0</td>
1713       <td>0</td>
1714     </tr>
1715     <tr>
1716       <td>1</td>
1717       <td>1</td>
1718       <td>1</td>
1719     </tr>
1720   </tbody>
1721 </table>
1722 </div>
1723 <h5>Example:</h5>
1724 <pre>  &lt;result&gt; = and int 4, %var         <i>; yields {int}:result = 4 &amp; %var</i>
1725   &lt;result&gt; = and int 15, 40          <i>; yields {int}:result = 8</i>
1726   &lt;result&gt; = and int 4, 8            <i>; yields {int}:result = 0</i>
1727 </pre>
1728 </div>
1729 <!-- _______________________________________________________________________ -->
1730 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
1731 <div class="doc_text">
1732 <h5>Syntax:</h5>
1733 <pre>  &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1734 </pre>
1735 <h5>Overview:</h5>
1736 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
1737 or of its two operands.</p>
1738 <h5>Arguments:</h5>
1739 <p>The two arguments to the '<tt>or</tt>' instruction must be <a
1740  href="#t_integral">integral</a> values.  Both arguments must have
1741 identical types.</p>
1742 <h5>Semantics:</h5>
1743 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
1744 <p> </p>
1745 <div style="align: center">
1746 <table border="1" cellspacing="0" cellpadding="4">
1747   <tbody>
1748     <tr>
1749       <td>In0</td>
1750       <td>In1</td>
1751       <td>Out</td>
1752     </tr>
1753     <tr>
1754       <td>0</td>
1755       <td>0</td>
1756       <td>0</td>
1757     </tr>
1758     <tr>
1759       <td>0</td>
1760       <td>1</td>
1761       <td>1</td>
1762     </tr>
1763     <tr>
1764       <td>1</td>
1765       <td>0</td>
1766       <td>1</td>
1767     </tr>
1768     <tr>
1769       <td>1</td>
1770       <td>1</td>
1771       <td>1</td>
1772     </tr>
1773   </tbody>
1774 </table>
1775 </div>
1776 <h5>Example:</h5>
1777 <pre>  &lt;result&gt; = or int 4, %var         <i>; yields {int}:result = 4 | %var</i>
1778   &lt;result&gt; = or int 15, 40          <i>; yields {int}:result = 47</i>
1779   &lt;result&gt; = or int 4, 8            <i>; yields {int}:result = 12</i>
1780 </pre>
1781 </div>
1782 <!-- _______________________________________________________________________ -->
1783 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
1784 Instruction</a> </div>
1785 <div class="doc_text">
1786 <h5>Syntax:</h5>
1787 <pre>  &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
1788 </pre>
1789 <h5>Overview:</h5>
1790 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
1791 or of its two operands.  The <tt>xor</tt> is used to implement the
1792 "one's complement" operation, which is the "~" operator in C.</p>
1793 <h5>Arguments:</h5>
1794 <p>The two arguments to the '<tt>xor</tt>' instruction must be <a
1795  href="#t_integral">integral</a> values.  Both arguments must have
1796 identical types.</p>
1797 <h5>Semantics:</h5>
1798 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
1799 <p> </p>
1800 <div style="align: center">
1801 <table border="1" cellspacing="0" cellpadding="4">
1802   <tbody>
1803     <tr>
1804       <td>In0</td>
1805       <td>In1</td>
1806       <td>Out</td>
1807     </tr>
1808     <tr>
1809       <td>0</td>
1810       <td>0</td>
1811       <td>0</td>
1812     </tr>
1813     <tr>
1814       <td>0</td>
1815       <td>1</td>
1816       <td>1</td>
1817     </tr>
1818     <tr>
1819       <td>1</td>
1820       <td>0</td>
1821       <td>1</td>
1822     </tr>
1823     <tr>
1824       <td>1</td>
1825       <td>1</td>
1826       <td>0</td>
1827     </tr>
1828   </tbody>
1829 </table>
1830 </div>
1831 <p> </p>
1832 <h5>Example:</h5>
1833 <pre>  &lt;result&gt; = xor int 4, %var         <i>; yields {int}:result = 4 ^ %var</i>
1834   &lt;result&gt; = xor int 15, 40          <i>; yields {int}:result = 39</i>
1835   &lt;result&gt; = xor int 4, 8            <i>; yields {int}:result = 12</i>
1836   &lt;result&gt; = xor int %V, -1          <i>; yields {int}:result = ~%V</i>
1837 </pre>
1838 </div>
1839 <!-- _______________________________________________________________________ -->
1840 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
1841 Instruction</a> </div>
1842 <div class="doc_text">
1843 <h5>Syntax:</h5>
1844 <pre>  &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1845 </pre>
1846 <h5>Overview:</h5>
1847 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to
1848 the left a specified number of bits.</p>
1849 <h5>Arguments:</h5>
1850 <p>The first argument to the '<tt>shl</tt>' instruction must be an <a
1851  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1852 type.</p>
1853 <h5>Semantics:</h5>
1854 <p>The value produced is <tt>var1</tt> * 2<sup><tt>var2</tt></sup>.</p>
1855 <h5>Example:</h5>
1856 <pre>  &lt;result&gt; = shl int 4, ubyte %var   <i>; yields {int}:result = 4 &lt;&lt; %var</i>
1857   &lt;result&gt; = shl int 4, ubyte 2      <i>; yields {int}:result = 16</i>
1858   &lt;result&gt; = shl int 1, ubyte 10     <i>; yields {int}:result = 1024</i>
1859 </pre>
1860 </div>
1861 <!-- _______________________________________________________________________ -->
1862 <div class="doc_subsubsection"> <a name="i_shr">'<tt>shr</tt>'
1863 Instruction</a> </div>
1864 <div class="doc_text">
1865 <h5>Syntax:</h5>
1866 <pre>  &lt;result&gt; = shr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
1867 </pre>
1868 <h5>Overview:</h5>
1869 <p>The '<tt>shr</tt>' instruction returns the first operand shifted to
1870 the right a specified number of bits.</p>
1871 <h5>Arguments:</h5>
1872 <p>The first argument to the '<tt>shr</tt>' instruction must be an <a
1873  href="#t_integer">integer</a> type.  The second argument must be an '<tt>ubyte</tt>'
1874 type.</p>
1875 <h5>Semantics:</h5>
1876 <p>If the first argument is a <a href="#t_signed">signed</a> type, the
1877 most significant bit is duplicated in the newly free'd bit positions.
1878 If the first argument is unsigned, zero bits shall fill the empty
1879 positions.</p>
1880 <h5>Example:</h5>
1881 <pre>  &lt;result&gt; = shr int 4, ubyte %var   <i>; yields {int}:result = 4 &gt;&gt; %var</i>
1882   &lt;result&gt; = shr uint 4, ubyte 1     <i>; yields {uint}:result = 2</i>
1883   &lt;result&gt; = shr int 4, ubyte 2      <i>; yields {int}:result = 1</i>
1884   &lt;result&gt; = shr sbyte 4, ubyte 3    <i>; yields {sbyte}:result = 0</i>
1885   &lt;result&gt; = shr sbyte -2, ubyte 1   <i>; yields {sbyte}:result = -1</i>
1886 </pre>
1887 </div>
1888
1889 <!-- ======================================================================= -->
1890 <div class="doc_subsection">
1891   <a name="memoryops">Memory Access Operations</a>
1892 </div>
1893
1894 <div class="doc_text">
1895
1896 <p>A key design point of an SSA-based representation is how it
1897 represents memory.  In LLVM, no memory locations are in SSA form, which
1898 makes things very simple.  This section describes how to read, write,
1899 allocate, and free memory in LLVM.</p>
1900
1901 </div>
1902
1903 <!-- _______________________________________________________________________ -->
1904 <div class="doc_subsubsection">
1905   <a name="i_malloc">'<tt>malloc</tt>' Instruction</a>
1906 </div>
1907
1908 <div class="doc_text">
1909
1910 <h5>Syntax:</h5>
1911
1912 <pre>
1913   &lt;result&gt; = malloc &lt;type&gt;[, uint &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
1914 </pre>
1915
1916 <h5>Overview:</h5>
1917
1918 <p>The '<tt>malloc</tt>' instruction allocates memory from the system
1919 heap and returns a pointer to it.</p>
1920
1921 <h5>Arguments:</h5>
1922
1923 <p>The '<tt>malloc</tt>' instruction allocates
1924 <tt>sizeof(&lt;type&gt;)*NumElements</tt>
1925 bytes of memory from the operating system and returns a pointer of the
1926 appropriate type to the program.  If "NumElements" is specified, it is the
1927 number of elements allocated.  If an alignment is specified, the value result
1928 of the allocation is guaranteed to be aligned to at least that boundary.  If
1929 not specified, or if zero, the target can choose to align the allocation on any
1930 convenient boundary.</p>
1931
1932 <p>'<tt>type</tt>' must be a sized type.</p>
1933
1934 <h5>Semantics:</h5>
1935
1936 <p>Memory is allocated using the system "<tt>malloc</tt>" function, and
1937 a pointer is returned.</p>
1938
1939 <h5>Example:</h5>
1940
1941 <pre>
1942   %array  = malloc [4 x ubyte ]                    <i>; yields {[%4 x ubyte]*}:array</i>
1943
1944   %size   = <a href="#i_add">add</a> uint 2, 2                          <i>; yields {uint}:size = uint 4</i>
1945   %array1 = malloc ubyte, uint 4                   <i>; yields {ubyte*}:array1</i>
1946   %array2 = malloc [12 x ubyte], uint %size        <i>; yields {[12 x ubyte]*}:array2</i>
1947   %array3 = malloc int, uint 4, align 1024         <i>; yields {int*}:array3</i>
1948   %array4 = malloc int, align 1024                 <i>; yields {int*}:array4</i>
1949 </pre>
1950 </div>
1951
1952 <!-- _______________________________________________________________________ -->
1953 <div class="doc_subsubsection">
1954   <a name="i_free">'<tt>free</tt>' Instruction</a>
1955 </div>
1956
1957 <div class="doc_text">
1958
1959 <h5>Syntax:</h5>
1960
1961 <pre>
1962   free &lt;type&gt; &lt;value&gt;                              <i>; yields {void}</i>
1963 </pre>
1964
1965 <h5>Overview:</h5>
1966
1967 <p>The '<tt>free</tt>' instruction returns memory back to the unused
1968 memory heap to be reallocated in the future.</p>
1969
1970 <h5>Arguments:</h5>
1971
1972 <p>'<tt>value</tt>' shall be a pointer value that points to a value
1973 that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
1974 instruction.</p>
1975
1976 <h5>Semantics:</h5>
1977
1978 <p>Access to the memory pointed to by the pointer is no longer defined
1979 after this instruction executes.</p>
1980
1981 <h5>Example:</h5>
1982
1983 <pre>
1984   %array  = <a href="#i_malloc">malloc</a> [4 x ubyte]                    <i>; yields {[4 x ubyte]*}:array</i>
1985             free   [4 x ubyte]* %array
1986 </pre>
1987 </div>
1988
1989 <!-- _______________________________________________________________________ -->
1990 <div class="doc_subsubsection">
1991   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
1992 </div>
1993
1994 <div class="doc_text">
1995
1996 <h5>Syntax:</h5>
1997
1998 <pre>
1999   &lt;result&gt; = alloca &lt;type&gt;[, uint &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
2000 </pre>
2001
2002 <h5>Overview:</h5>
2003
2004 <p>The '<tt>alloca</tt>' instruction allocates memory on the current
2005 stack frame of the procedure that is live until the current function
2006 returns to its caller.</p>
2007
2008 <h5>Arguments:</h5>
2009
2010 <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
2011 bytes of memory on the runtime stack, returning a pointer of the
2012 appropriate type to the program.    If "NumElements" is specified, it is the
2013 number of elements allocated.  If an alignment is specified, the value result
2014 of the allocation is guaranteed to be aligned to at least that boundary.  If
2015 not specified, or if zero, the target can choose to align the allocation on any
2016 convenient boundary.</p>
2017
2018 <p>'<tt>type</tt>' may be any sized type.</p>
2019
2020 <h5>Semantics:</h5>
2021
2022 <p>Memory is allocated; a pointer is returned.  '<tt>alloca</tt>'d
2023 memory is automatically released when the function returns.  The '<tt>alloca</tt>'
2024 instruction is commonly used to represent automatic variables that must
2025 have an address available.  When the function returns (either with the <tt><a
2026  href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt>
2027 instructions), the memory is reclaimed.</p>
2028
2029 <h5>Example:</h5>
2030
2031 <pre>
2032   %ptr = alloca int                              <i>; yields {int*}:ptr</i>
2033   %ptr = alloca int, uint 4                      <i>; yields {int*}:ptr</i>
2034   %ptr = alloca int, uint 4, align 1024          <i>; yields {int*}:ptr</i>
2035   %ptr = alloca int, align 1024                  <i>; yields {int*}:ptr</i>
2036 </pre>
2037 </div>
2038
2039 <!-- _______________________________________________________________________ -->
2040 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
2041 Instruction</a> </div>
2042 <div class="doc_text">
2043 <h5>Syntax:</h5>
2044 <pre>  &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;<br>  &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;<br></pre>
2045 <h5>Overview:</h5>
2046 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
2047 <h5>Arguments:</h5>
2048 <p>The argument to the '<tt>load</tt>' instruction specifies the memory
2049 address from which to load.  The pointer must point to a <a
2050  href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
2051 marked as <tt>volatile</tt>, then the optimizer is not allowed to modify
2052 the number or order of execution of this <tt>load</tt> with other
2053 volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
2054 instructions. </p>
2055 <h5>Semantics:</h5>
2056 <p>The location of memory pointed to is loaded.</p>
2057 <h5>Examples:</h5>
2058 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
2059   <a
2060  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
2061   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
2062 </pre>
2063 </div>
2064 <!-- _______________________________________________________________________ -->
2065 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
2066 Instruction</a> </div>
2067 <h5>Syntax:</h5>
2068 <pre>  store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
2069   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;                   <i>; yields {void}</i>
2070 </pre>
2071 <h5>Overview:</h5>
2072 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
2073 <h5>Arguments:</h5>
2074 <p>There are two arguments to the '<tt>store</tt>' instruction: a value
2075 to store and an address in which to store it.  The type of the '<tt>&lt;pointer&gt;</tt>'
2076 operand must be a pointer to the type of the '<tt>&lt;value&gt;</tt>'
2077 operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the
2078 optimizer is not allowed to modify the number or order of execution of
2079 this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
2080  href="#i_store">store</a></tt> instructions.</p>
2081 <h5>Semantics:</h5>
2082 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
2083 at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
2084 <h5>Example:</h5>
2085 <pre>  %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
2086   <a
2087  href="#i_store">store</a> int 3, int* %ptr                          <i>; yields {void}</i>
2088   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
2089 </pre>
2090 <!-- _______________________________________________________________________ -->
2091 <div class="doc_subsubsection">
2092    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
2093 </div>
2094
2095 <div class="doc_text">
2096 <h5>Syntax:</h5>
2097 <pre>
2098   &lt;result&gt; = getelementptr &lt;ty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
2099 </pre>
2100
2101 <h5>Overview:</h5>
2102
2103 <p>
2104 The '<tt>getelementptr</tt>' instruction is used to get the address of a
2105 subelement of an aggregate data structure.</p>
2106
2107 <h5>Arguments:</h5>
2108
2109 <p>This instruction takes a list of integer constants that indicate what
2110 elements of the aggregate object to index to.  The actual types of the arguments
2111 provided depend on the type of the first pointer argument.  The
2112 '<tt>getelementptr</tt>' instruction is used to index down through the type
2113 levels of a structure or to a specific index in an array.  When indexing into a
2114 structure, only <tt>uint</tt>
2115 integer constants are allowed.  When indexing into an array or pointer,
2116 <tt>int</tt> and <tt>long</tt> indexes are allowed of any sign.</p>
2117
2118 <p>For example, let's consider a C code fragment and how it gets
2119 compiled to LLVM:</p>
2120
2121 <pre>
2122   struct RT {
2123     char A;
2124     int B[10][20];
2125     char C;
2126   };
2127   struct ST {
2128     int X;
2129     double Y;
2130     struct RT Z;
2131   };
2132
2133   int *foo(struct ST *s) {
2134     return &amp;s[1].Z.B[5][13];
2135   }
2136 </pre>
2137
2138 <p>The LLVM code generated by the GCC frontend is:</p>
2139
2140 <pre>
2141   %RT = type { sbyte, [10 x [20 x int]], sbyte }
2142   %ST = type { int, double, %RT }
2143
2144   implementation
2145
2146   int* %foo(%ST* %s) {
2147   entry:
2148     %reg = getelementptr %ST* %s, int 1, uint 2, uint 1, int 5, int 13
2149     ret int* %reg
2150   }
2151 </pre>
2152
2153 <h5>Semantics:</h5>
2154
2155 <p>The index types specified for the '<tt>getelementptr</tt>' instruction depend
2156 on the pointer type that is being indexed into. <a href="#t_pointer">Pointer</a>
2157 and <a href="#t_array">array</a> types require <tt>uint</tt>, <tt>int</tt>,
2158 <tt>ulong</tt>, or <tt>long</tt> values, and <a href="#t_struct">structure</a>
2159 types require <tt>uint</tt> <b>constants</b>.</p>
2160
2161 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
2162 type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ int, double, %RT
2163 }</tt>' type, a structure.  The second index indexes into the third element of
2164 the structure, yielding a '<tt>%RT</tt>' = '<tt>{ sbyte, [10 x [20 x int]],
2165 sbyte }</tt>' type, another structure.  The third index indexes into the second
2166 element of the structure, yielding a '<tt>[10 x [20 x int]]</tt>' type, an
2167 array.  The two dimensions of the array are subscripted into, yielding an
2168 '<tt>int</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a pointer
2169 to this element, thus computing a value of '<tt>int*</tt>' type.</p>
2170
2171 <p>Note that it is perfectly legal to index partially through a
2172 structure, returning a pointer to an inner element.  Because of this,
2173 the LLVM code for the given testcase is equivalent to:</p>
2174
2175 <pre>
2176   int* %foo(%ST* %s) {
2177     %t1 = getelementptr %ST* %s, int 1                        <i>; yields %ST*:%t1</i>
2178     %t2 = getelementptr %ST* %t1, int 0, uint 2               <i>; yields %RT*:%t2</i>
2179     %t3 = getelementptr %RT* %t2, int 0, uint 1               <i>; yields [10 x [20 x int]]*:%t3</i>
2180     %t4 = getelementptr [10 x [20 x int]]* %t3, int 0, int 5  <i>; yields [20 x int]*:%t4</i>
2181     %t5 = getelementptr [20 x int]* %t4, int 0, int 13        <i>; yields int*:%t5</i>
2182     ret int* %t5
2183   }
2184 </pre>
2185
2186 <p>Note that it is undefined to access an array out of bounds: array and
2187 pointer indexes must always be within the defined bounds of the array type.
2188 The one exception for this rules is zero length arrays.  These arrays are
2189 defined to be accessible as variable length arrays, which requires access
2190 beyond the zero'th element.</p>
2191
2192 <h5>Example:</h5>
2193
2194 <pre>
2195     <i>; yields [12 x ubyte]*:aptr</i>
2196     %aptr = getelementptr {int, [12 x ubyte]}* %sptr, long 0, uint 1
2197 </pre>
2198
2199 </div>
2200 <!-- ======================================================================= -->
2201 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
2202 <div class="doc_text">
2203 <p>The instructions in this category are the "miscellaneous"
2204 instructions, which defy better classification.</p>
2205 </div>
2206 <!-- _______________________________________________________________________ -->
2207 <div class="doc_subsubsection"> <a name="i_phi">'<tt>phi</tt>'
2208 Instruction</a> </div>
2209 <div class="doc_text">
2210 <h5>Syntax:</h5>
2211 <pre>  &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
2212 <h5>Overview:</h5>
2213 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
2214 the SSA graph representing the function.</p>
2215 <h5>Arguments:</h5>
2216 <p>The type of the incoming values are specified with the first type
2217 field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
2218 as arguments, with one pair for each predecessor basic block of the
2219 current block.  Only values of <a href="#t_firstclass">first class</a>
2220 type may be used as the value arguments to the PHI node.  Only labels
2221 may be used as the label arguments.</p>
2222 <p>There must be no non-phi instructions between the start of a basic
2223 block and the PHI instructions: i.e. PHI instructions must be first in
2224 a basic block.</p>
2225 <h5>Semantics:</h5>
2226 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the
2227 value specified by the parameter, depending on which basic block we
2228 came from in the last <a href="#terminators">terminator</a> instruction.</p>
2229 <h5>Example:</h5>
2230 <pre>Loop:       ; Infinite loop that counts from 0 on up...<br>  %indvar = phi uint [ 0, %LoopHeader ], [ %nextindvar, %Loop ]<br>  %nextindvar = add uint %indvar, 1<br>  br label %Loop<br></pre>
2231 </div>
2232
2233 <!-- _______________________________________________________________________ -->
2234 <div class="doc_subsubsection">
2235    <a name="i_cast">'<tt>cast .. to</tt>' Instruction</a>
2236 </div>
2237
2238 <div class="doc_text">
2239
2240 <h5>Syntax:</h5>
2241
2242 <pre>
2243   &lt;result&gt; = cast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
2244 </pre>
2245
2246 <h5>Overview:</h5>
2247
2248 <p>
2249 The '<tt>cast</tt>' instruction is used as the primitive means to convert
2250 integers to floating point, change data type sizes, and break type safety (by
2251 casting pointers).
2252 </p>
2253
2254
2255 <h5>Arguments:</h5>
2256
2257 <p>
2258 The '<tt>cast</tt>' instruction takes a value to cast, which must be a first
2259 class value, and a type to cast it to, which must also be a <a
2260 href="#t_firstclass">first class</a> type.
2261 </p>
2262
2263 <h5>Semantics:</h5>
2264
2265 <p>
2266 This instruction follows the C rules for explicit casts when determining how the
2267 data being cast must change to fit in its new container.
2268 </p>
2269
2270 <p>
2271 When casting to bool, any value that would be considered true in the context of
2272 a C '<tt>if</tt>' condition is converted to the boolean '<tt>true</tt>' values,
2273 all else are '<tt>false</tt>'.
2274 </p>
2275
2276 <p>
2277 When extending an integral value from a type of one signness to another (for
2278 example '<tt>sbyte</tt>' to '<tt>ulong</tt>'), the value is sign-extended if the
2279 <b>source</b> value is signed, and zero-extended if the source value is
2280 unsigned. <tt>bool</tt> values are always zero extended into either zero or
2281 one.
2282 </p>
2283
2284 <h5>Example:</h5>
2285
2286 <pre>
2287   %X = cast int 257 to ubyte              <i>; yields ubyte:1</i>
2288   %Y = cast int 123 to bool               <i>; yields bool:true</i>
2289 </pre>
2290 </div>
2291
2292 <!-- _______________________________________________________________________ -->
2293 <div class="doc_subsubsection">
2294    <a name="i_select">'<tt>select</tt>' Instruction</a>
2295 </div>
2296
2297 <div class="doc_text">
2298
2299 <h5>Syntax:</h5>
2300
2301 <pre>
2302   &lt;result&gt; = select bool &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt;             <i>; yields ty</i>
2303 </pre>
2304
2305 <h5>Overview:</h5>
2306
2307 <p>
2308 The '<tt>select</tt>' instruction is used to choose one value based on a
2309 condition, without branching.
2310 </p>
2311
2312
2313 <h5>Arguments:</h5>
2314
2315 <p>
2316 The '<tt>select</tt>' instruction requires a boolean value indicating the condition, and two values of the same <a href="#t_firstclass">first class</a> type.
2317 </p>
2318
2319 <h5>Semantics:</h5>
2320
2321 <p>
2322 If the boolean condition evaluates to true, the instruction returns the first
2323 value argument; otherwise, it returns the second value argument.
2324 </p>
2325
2326 <h5>Example:</h5>
2327
2328 <pre>
2329   %X = select bool true, ubyte 17, ubyte 42          <i>; yields ubyte:17</i>
2330 </pre>
2331 </div>
2332
2333 <!-- _______________________________________________________________________ -->
2334 <div class="doc_subsubsection"> <a name="i_vset">'<tt>vset</tt>'
2335 Instruction</a> </div>
2336 <div class="doc_text">
2337 <h5>Syntax:</h5>
2338 <pre>&lt;result&gt; = vset &lt;op&gt;, &lt;n x &lt;ty&gt;&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields &lt;n x bool&gt;</i>
2339 </pre>
2340
2341 <h5>Overview:</h5>
2342
2343 <p>The '<tt>vset</tt>' instruction returns a vector of boolean
2344 values representing, at each position, the result of the comparison
2345 between the values at that position in the two operands.</p>
2346
2347 <h5>Arguments:</h5>
2348
2349 <p>The arguments to a '<tt>vset</tt>' instruction are a comparison
2350 operation and two value arguments.  The value arguments must be of <a
2351 href="#t_packed">packed</a> type, and they must have identical types.
2352 For value arguments of integral element type, the operation argument
2353 must be one of <tt>eq</tt>, <tt>ne</tt>, <tt>lt</tt>, <tt>gt</tt>,
2354 <tt>le</tt>, <tt>ge</tt>, <tt>ult</tt>, <tt>ugt</tt>, <tt>ule</tt>,
2355 <tt>uge</tt>, <tt>true</tt>, and <tt>false</tt>.  For value arguments
2356 of floating point element type, the operation argument must be one of
2357 <tt>eq</tt>, <tt>ne</tt>, <tt>lt</tt>, <tt>gt</tt>, <tt>le</tt>,
2358 <tt>ge</tt>, <tt>oeq</tt>, <tt>one</tt>, <tt>olt</tt>, <tt>ogt</tt>,
2359 <tt>ole</tt>, <tt>oge</tt>, <tt>ueq</tt>, <tt>une</tt>, <tt>ult</tt>,
2360 <tt>ugt</tt>, <tt>ule</tt>, <tt>uge</tt>, <tt>o</tt>, <tt>u</tt>,
2361 <tt>true</tt>, and <tt>false</tt>.  The result is a packed
2362 <tt>bool</tt> value with the same length as each operand.</p>
2363
2364 <h5>Semantics:</h5>
2365
2366 <p>The following table shows the semantics of '<tt>vset</tt>' for
2367 integral value arguments.  For each position of the result, the
2368 comparison is done on the corresponding positions of the two value
2369 arguments.  Note that the signedness of the comparison depends on the
2370 comparison opcode and <i>not</i> on the signedness of the value
2371 operands.  E.g., <tt>vset lt <4 x unsigned> %x, %y</tt> does an
2372 elementwise <i>signed</i> comparison of <tt>%x</tt> and
2373 <tt>%y</tt>.</p>
2374
2375 <table  border="1" cellspacing="0" cellpadding="4">
2376   <tbody>
2377     <tr><th>Operation</th><th>Result is true iff</th><th>Comparison is</th></tr>
2378     <tr><td><tt>eq</tt></td><td>var1 == var2</td><td>--</td></tr>
2379     <tr><td><tt>ne</tt></td><td>var1 != var2</td><td>--</td></tr>
2380     <tr><td><tt>lt</tt></td><td>var1 &lt; var2</td><td>signed</td></tr>
2381     <tr><td><tt>gt</tt></td><td>var1 &gt; var2</td><td>signed</td></tr>
2382     <tr><td><tt>le</tt></td><td>var1 &lt;= var2</td><td>signed</td></tr>
2383     <tr><td><tt>ge</tt></td><td>var1 &gt;= var2</td><td>signed</td></tr>
2384     <tr><td><tt>ult</tt></td><td>var1 &lt; var2</td><td>unsigned</td></tr>
2385     <tr><td><tt>ugt</tt></td><td>var1 &gt; var2</td><td>unsigned</td></tr>
2386     <tr><td><tt>ule</tt></td><td>var1 &lt;= var2</td><td>unsigned</td></tr>
2387     <tr><td><tt>uge</tt></td><td>var1 &gt;= var2</td><td>unsigned</td></tr>
2388     <tr><td><tt>true</tt></td><td>always</td><td>--</td></tr>
2389     <tr><td><tt>false</tt></td><td>never</td><td>--</td></tr>
2390   </tbody>
2391 </table>
2392
2393 <p>The following table shows the semantics of '<tt>vset</tt>' for
2394 floating point types.  If either operand is a floating point Not a
2395 Number (NaN) value, the operation is unordered, and the value in the
2396 first column below is produced at that position.  Otherwise, the
2397 operation is ordered, and the value in the second column is
2398 produced.</p>
2399
2400 <table  border="1" cellspacing="0" cellpadding="4">
2401   <tbody>
2402     <tr><th>Operation</th><th>If unordered<th>Otherwise true iff</th></tr>
2403     <tr><td><tt>eq</tt></td><td>undefined</td><td>var1 == var2</td></tr>
2404     <tr><td><tt>ne</tt></td><td>undefined</td><td>var1 != var2</td></tr>
2405     <tr><td><tt>lt</tt></td><td>undefined</td><td>var1 &lt; var2</td></tr>
2406     <tr><td><tt>gt</tt></td><td>undefined</td><td>var1 &gt; var2</td></tr>
2407     <tr><td><tt>le</tt></td><td>undefined</td><td>var1 &lt;= var2</td></tr>
2408     <tr><td><tt>ge</tt></td><td>undefined</td><td>var1 &gt;= var2</td></tr>
2409     <tr><td><tt>oeq</tt></td><td>false</td><td>var1 == var2</td></tr>
2410     <tr><td><tt>one</tt></td><td>false</td><td>var1 != var2</td></tr>
2411     <tr><td><tt>olt</tt></td><td>false</td><td>var1 &lt; var2</td></tr>
2412     <tr><td><tt>ogt</tt></td><td>false</td><td>var1 &gt; var2</td></tr>
2413     <tr><td><tt>ole</tt></td><td>false</td><td>var1 &lt;= var2</td></tr>
2414     <tr><td><tt>oge</tt></td><td>false</td><td>var1 &gt;= var2</td></tr>
2415     <tr><td><tt>ueq</tt></td><td>true</td><td>var1 == var2</td></tr>
2416     <tr><td><tt>une</tt></td><td>true</td><td>var1 != var2</td></tr>
2417     <tr><td><tt>ult</tt></td><td>true</td><td>var1 &lt; var2</td></tr>
2418     <tr><td><tt>ugt</tt></td><td>true</td><td>var1 &gt; var2</td></tr>
2419     <tr><td><tt>ule</tt></td><td>true</td><td>var1 &lt;= var2</td></tr>
2420     <tr><td><tt>uge</tt></td><td>true</td><td>var1 &gt;= var2</td></tr>
2421     <tr><td><tt>o</tt></td><td>false</td><td>always</td></tr>
2422     <tr><td><tt>u</tt></td><td>true</td><td>never</td></tr>
2423     <tr><td><tt>true</tt></td><td>true</td><td>always</td></tr>
2424     <tr><td><tt>false</tt></td><td>false</td><td>never</td></tr>
2425   </tbody>
2426 </table>
2427
2428 <h5>Example:</h5>
2429 <pre>  &lt;result&gt; = vset eq &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = false, false</i>
2430   &lt;result&gt; = vset ne &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = true, true</i>
2431   &lt;result&gt; = vset lt &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = true, false</i>
2432   &lt;result&gt; = vset gt &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = false, true</i>
2433   &lt;result&gt; = vset le &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = true, false</i>
2434   &lt;result&gt; = vset ge &lt;2 x int&gt; &lt;int 0, int 1&gt;, &lt;int 1, int 0&gt;      <i>; yields {&lt;2 x bool&gt;}:result = false, true</i>
2435 </pre>
2436 </div>
2437
2438 <!-- _______________________________________________________________________ -->
2439 <div class="doc_subsubsection">
2440    <a name="i_vselect">'<tt>vselect</tt>' Instruction</a>
2441 </div>
2442
2443 <div class="doc_text">
2444
2445 <h5>Syntax:</h5>
2446
2447 <pre>
2448   &lt;result&gt; = vselect &lt;n x bool&gt; &lt;cond&gt;, &lt;n x &lt;ty&gt;&gt; &lt;val1&gt;, &lt;n x &lt;ty&gt;&gt; &lt;val2&gt; <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
2449 </pre>
2450
2451 <h5>Overview:</h5>
2452
2453 <p>
2454 The '<tt>vselect</tt>' instruction chooses one value at each position
2455 of a vector based on a condition.
2456 </p>
2457
2458
2459 <h5>Arguments:</h5>
2460
2461 <p>
2462 The '<tt>vselect</tt>' instruction requires a <a
2463 href="#t_packed">packed</a> <tt>bool</tt> value indicating the
2464 condition at each vector position, and two values of the same packed
2465 type.  All three operands must have the same length.  The type of the
2466 result is the same as the type of the two value operands.</p>
2467
2468 <h5>Semantics:</h5>
2469
2470 <p>
2471 At each position where the <tt>bool</tt> vector is true, that position
2472 of the result gets its value from the first value argument; otherwise,
2473 it gets its value from the second value argument.
2474 </p>
2475
2476 <h5>Example:</h5>
2477
2478 <pre>
2479   %X = vselect bool &lt;2 x bool&gt; &lt;bool true, bool false&gt;, &lt;2 x ubyte&gt; &lt;ubyte 17, ubyte 17&gt;,
2480     &lt;2 x ubyte&gt; &lt;ubyte 42, ubyte 42&gt;      <i>; yields &lt;2 x ubyte&gt;:17, 42</i>
2481 </pre>
2482 </div>
2483
2484 <!-- _______________________________________________________________________ -->
2485 <div class="doc_subsubsection">
2486    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
2487 </div>
2488
2489 <div class="doc_text">
2490
2491 <h5>Syntax:</h5>
2492
2493 <pre>
2494   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, uint &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
2495 </pre>
2496
2497 <h5>Overview:</h5>
2498
2499 <p>
2500 The '<tt>extractelement</tt>' instruction extracts a single scalar
2501 element from a packed vector at a specified index.
2502 </p>
2503
2504
2505 <h5>Arguments:</h5>
2506
2507 <p>
2508 The first operand of an '<tt>extractelement</tt>' instruction is a
2509 value of <a href="#t_packed">packed</a> type.  The second operand is
2510 an index indicating the position from which to extract the element.
2511 The index may be a variable.</p>
2512
2513 <h5>Semantics:</h5>
2514
2515 <p>
2516 The result is a scalar of the same type as the element type of
2517 <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
2518 <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
2519 results are undefined.
2520 </p>
2521
2522 <h5>Example:</h5>
2523
2524 <pre>
2525   %result = extractelement &lt;4 x int&gt; %vec, uint 0    <i>; yields int</i>
2526 </pre>
2527 </div>
2528
2529
2530 <!-- _______________________________________________________________________ -->
2531 <div class="doc_subsubsection">
2532    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
2533 </div>
2534
2535 <div class="doc_text">
2536
2537 <h5>Syntax:</h5>
2538
2539 <pre>
2540   &lt;result&gt; = insertelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, &lt;ty&gt; &lt;elt&gt, uint &lt;idx&gt;    <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
2541 </pre>
2542
2543 <h5>Overview:</h5>
2544
2545 <p>
2546 The '<tt>insertelement</tt>' instruction inserts a scalar
2547 element into a packed vector at a specified index.
2548 </p>
2549
2550
2551 <h5>Arguments:</h5>
2552
2553 <p>
2554 The first operand of an '<tt>insertelement</tt>' instruction is a
2555 value of <a href="#t_packed">packed</a> type.  The second operand is a
2556 scalar value whose type must equal the element type of the first
2557 operand.  The third operand is an index indicating the position at
2558 which to insert the value.  The index may be a variable.</p>
2559
2560 <h5>Semantics:</h5>
2561
2562 <p>
2563 The result is a packed vector of the same type as <tt>val</tt>.  Its
2564 element values are those of <tt>val</tt> except at position
2565 <tt>idx</tt>, where it gets the value <tt>elt</tt>.  If <tt>idx</tt>
2566 exceeds the length of <tt>val</tt>, the results are undefined.
2567 </p>
2568
2569 <h5>Example:</h5>
2570
2571 <pre>
2572   %result = insertelement &lt;4 x int&gt; %vec, int 1, uint 0    <i>; yields &lt;4 x int&gt;</i>
2573 </pre>
2574 </div>
2575
2576
2577 <!-- _______________________________________________________________________ -->
2578 <div class="doc_subsubsection">
2579   <a name="i_call">'<tt>call</tt>' Instruction</a>
2580 </div>
2581
2582 <div class="doc_text">
2583
2584 <h5>Syntax:</h5>
2585 <pre>
2586   &lt;result&gt; = [tail] call [<a href="#callingconv">cconv</a>] &lt;ty&gt;* &lt;fnptrval&gt;(&lt;param list&gt;)
2587 </pre>
2588
2589 <h5>Overview:</h5>
2590
2591 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
2592
2593 <h5>Arguments:</h5>
2594
2595 <p>This instruction requires several arguments:</p>
2596
2597 <ol>
2598   <li>
2599     <p>The optional "tail" marker indicates whether the callee function accesses
2600     any allocas or varargs in the caller.  If the "tail" marker is present, the
2601     function call is eligible for tail call optimization.  Note that calls may
2602     be marked "tail" even if they do not occur before a <a
2603     href="#i_ret"><tt>ret</tt></a> instruction.
2604   </li>
2605   <li>
2606     <p>The optional "cconv" marker indicates which <a href="callingconv">calling
2607     convention</a> the call should use.  If none is specified, the call defaults
2608     to using C calling conventions.
2609   </li>
2610   <li>
2611     <p>'<tt>ty</tt>': shall be the signature of the pointer to function value
2612     being invoked.  The argument types must match the types implied by this
2613     signature.  This type can be omitted if the function is not varargs and
2614     if the function type does not return a pointer to a function.</p>
2615   </li>
2616   <li>
2617     <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
2618     be invoked. In most cases, this is a direct function invocation, but
2619     indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
2620     to function value.</p>
2621   </li>
2622   <li>
2623     <p>'<tt>function args</tt>': argument list whose types match the
2624     function signature argument types. All arguments must be of
2625     <a href="#t_firstclass">first class</a> type. If the function signature
2626     indicates the function accepts a variable number of arguments, the extra
2627     arguments can be specified.</p>
2628   </li>
2629 </ol>
2630
2631 <h5>Semantics:</h5>
2632
2633 <p>The '<tt>call</tt>' instruction is used to cause control flow to
2634 transfer to a specified function, with its incoming arguments bound to
2635 the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
2636 instruction in the called function, control flow continues with the
2637 instruction after the function call, and the return value of the
2638 function is bound to the result argument.  This is a simpler case of
2639 the <a href="#i_invoke">invoke</a> instruction.</p>
2640
2641 <h5>Example:</h5>
2642
2643 <pre>
2644   %retval = call int %test(int %argc)
2645   call int(sbyte*, ...) *%printf(sbyte* %msg, int 12, sbyte 42);
2646   %X = tail call int %foo()
2647   %Y = tail call <a href="#callingconv">fastcc</a> int %foo()
2648 </pre>
2649
2650 </div>
2651
2652 <!-- _______________________________________________________________________ -->
2653 <div class="doc_subsubsection">
2654   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
2655 </div>
2656
2657 <div class="doc_text">
2658
2659 <h5>Syntax:</h5>
2660
2661 <pre>
2662   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
2663 </pre>
2664
2665 <h5>Overview:</h5>
2666
2667 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
2668 the "variable argument" area of a function call.  It is used to implement the
2669 <tt>va_arg</tt> macro in C.</p>
2670
2671 <h5>Arguments:</h5>
2672
2673 <p>This instruction takes a <tt>va_list*</tt> value and the type of
2674 the argument. It returns a value of the specified argument type and
2675 increments the <tt>va_list</tt> to point to the next argument.  Again, the
2676 actual type of <tt>va_list</tt> is target specific.</p>
2677
2678 <h5>Semantics:</h5>
2679
2680 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified
2681 type from the specified <tt>va_list</tt> and causes the
2682 <tt>va_list</tt> to point to the next argument.  For more information,
2683 see the variable argument handling <a href="#int_varargs">Intrinsic
2684 Functions</a>.</p>
2685
2686 <p>It is legal for this instruction to be called in a function which does not
2687 take a variable number of arguments, for example, the <tt>vfprintf</tt>
2688 function.</p>
2689
2690 <p><tt>va_arg</tt> is an LLVM instruction instead of an <a
2691 href="#intrinsics">intrinsic function</a> because it takes a type as an
2692 argument.</p>
2693
2694 <h5>Example:</h5>
2695
2696 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
2697
2698 </div>
2699
2700 <!-- *********************************************************************** -->
2701 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
2702 <!-- *********************************************************************** -->
2703
2704 <div class="doc_text">
2705
2706 <p>LLVM supports the notion of an "intrinsic function".  These functions have
2707 well known names and semantics and are required to follow certain
2708 restrictions. Overall, these instructions represent an extension mechanism for
2709 the LLVM language that does not require changing all of the transformations in
2710 LLVM to add to the language (or the bytecode reader/writer, the parser,
2711 etc...).</p>
2712
2713 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
2714 prefix is reserved in LLVM for intrinsic names; thus, functions may not be named
2715 this.  Intrinsic functions must always be external functions: you cannot define
2716 the body of intrinsic functions.  Intrinsic functions may only be used in call
2717 or invoke instructions: it is illegal to take the address of an intrinsic
2718 function.  Additionally, because intrinsic functions are part of the LLVM
2719 language, it is required that they all be documented here if any are added.</p>
2720
2721
2722 <p>To learn how to add an intrinsic function, please see the <a
2723 href="ExtendingLLVM.html">Extending LLVM Guide</a>.
2724 </p>
2725
2726 </div>
2727
2728 <!-- ======================================================================= -->
2729 <div class="doc_subsection">
2730   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
2731 </div>
2732
2733 <div class="doc_text">
2734
2735 <p>Variable argument support is defined in LLVM with the <a
2736  href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
2737 intrinsic functions.  These functions are related to the similarly
2738 named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
2739
2740 <p>All of these functions operate on arguments that use a
2741 target-specific value type "<tt>va_list</tt>".  The LLVM assembly
2742 language reference manual does not define what this type is, so all
2743 transformations should be prepared to handle intrinsics with any type
2744 used.</p>
2745
2746 <p>This example shows how the <a href="#i_vanext"><tt>vanext</tt></a>
2747 instruction and the variable argument handling intrinsic functions are
2748 used.</p>
2749
2750 <pre>
2751 int %test(int %X, ...) {
2752   ; Initialize variable argument processing
2753   %ap = alloca sbyte*
2754   call void %<a href="#i_va_start">llvm.va_start</a>(sbyte** %ap)
2755
2756   ; Read a single integer argument
2757   %tmp = va_arg sbyte** %ap, int
2758
2759   ; Demonstrate usage of llvm.va_copy and llvm.va_end
2760   %aq = alloca sbyte*
2761   call void %<a href="#i_va_copy">llvm.va_copy</a>(sbyte** %aq, sbyte** %ap)
2762   call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %aq)
2763
2764   ; Stop processing of arguments.
2765   call void %<a href="#i_va_end">llvm.va_end</a>(sbyte** %ap)
2766   ret int %tmp
2767 }
2768 </pre>
2769 </div>
2770
2771 <!-- _______________________________________________________________________ -->
2772 <div class="doc_subsubsection">
2773   <a name="i_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
2774 </div>
2775
2776
2777 <div class="doc_text">
2778 <h5>Syntax:</h5>
2779 <pre>  declare void %llvm.va_start(&lt;va_list&gt;* &lt;arglist&gt;)<br></pre>
2780 <h5>Overview:</h5>
2781 <P>The '<tt>llvm.va_start</tt>' intrinsic initializes
2782 <tt>*&lt;arglist&gt;</tt> for subsequent use by <tt><a
2783 href="#i_va_arg">va_arg</a></tt>.</p>
2784
2785 <h5>Arguments:</h5>
2786
2787 <P>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
2788
2789 <h5>Semantics:</h5>
2790
2791 <P>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
2792 macro available in C.  In a target-dependent way, it initializes the
2793 <tt>va_list</tt> element the argument points to, so that the next call to
2794 <tt>va_arg</tt> will produce the first variable argument passed to the function.
2795 Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the
2796 last argument of the function, the compiler can figure that out.</p>
2797
2798 </div>
2799
2800 <!-- _______________________________________________________________________ -->
2801 <div class="doc_subsubsection">
2802  <a name="i_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
2803 </div>
2804
2805 <div class="doc_text">
2806 <h5>Syntax:</h5>
2807 <pre>  declare void %llvm.va_end(&lt;va_list*&gt; &lt;arglist&gt;)<br></pre>
2808 <h5>Overview:</h5>
2809 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>&lt;arglist&gt;</tt>
2810 which has been initialized previously with <tt><a href="#i_va_start">llvm.va_start</a></tt>
2811 or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
2812 <h5>Arguments:</h5>
2813 <p>The argument is a <tt>va_list</tt> to destroy.</p>
2814 <h5>Semantics:</h5>
2815 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
2816 macro available in C.  In a target-dependent way, it destroys the <tt>va_list</tt>.
2817 Calls to <a href="#i_va_start"><tt>llvm.va_start</tt></a> and <a
2818  href="#i_va_copy"><tt>llvm.va_copy</tt></a> must be matched exactly
2819 with calls to <tt>llvm.va_end</tt>.</p>
2820 </div>
2821
2822 <!-- _______________________________________________________________________ -->
2823 <div class="doc_subsubsection">
2824   <a name="i_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
2825 </div>
2826
2827 <div class="doc_text">
2828
2829 <h5>Syntax:</h5>
2830
2831 <pre>
2832   declare void %llvm.va_copy(&lt;va_list&gt;* &lt;destarglist&gt;,
2833                                           &lt;va_list&gt;* &lt;srcarglist&gt;)
2834 </pre>
2835
2836 <h5>Overview:</h5>
2837
2838 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position from
2839 the source argument list to the destination argument list.</p>
2840
2841 <h5>Arguments:</h5>
2842
2843 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
2844 The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p>
2845
2846
2847 <h5>Semantics:</h5>
2848
2849 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt> macro
2850 available in C.  In a target-dependent way, it copies the source
2851 <tt>va_list</tt> element into the destination list.  This intrinsic is necessary
2852 because the <tt><a href="i_va_begin">llvm.va_begin</a></tt> intrinsic may be
2853 arbitrarily complex and require memory allocation, for example.</p>
2854
2855 </div>
2856
2857 <!-- ======================================================================= -->
2858 <div class="doc_subsection">
2859   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
2860 </div>
2861
2862 <div class="doc_text">
2863
2864 <p>
2865 LLVM support for <a href="GarbageCollection.html">Accurate Garbage
2866 Collection</a> requires the implementation and generation of these intrinsics.
2867 These intrinsics allow identification of <a href="#i_gcroot">GC roots on the
2868 stack</a>, as well as garbage collector implementations that require <a
2869 href="#i_gcread">read</a> and <a href="#i_gcwrite">write</a> barriers.
2870 Front-ends for type-safe garbage collected languages should generate these
2871 intrinsics to make use of the LLVM garbage collectors.  For more details, see <a
2872 href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
2873 </p>
2874 </div>
2875
2876 <!-- _______________________________________________________________________ -->
2877 <div class="doc_subsubsection">
2878   <a name="i_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
2879 </div>
2880
2881 <div class="doc_text">
2882
2883 <h5>Syntax:</h5>
2884
2885 <pre>
2886   declare void %llvm.gcroot(&lt;ty&gt;** %ptrloc, &lt;ty2&gt;* %metadata)
2887 </pre>
2888
2889 <h5>Overview:</h5>
2890
2891 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
2892 the code generator, and allows some metadata to be associated with it.</p>
2893
2894 <h5>Arguments:</h5>
2895
2896 <p>The first argument specifies the address of a stack object that contains the
2897 root pointer.  The second pointer (which must be either a constant or a global
2898 value address) contains the meta-data to be associated with the root.</p>
2899
2900 <h5>Semantics:</h5>
2901
2902 <p>At runtime, a call to this intrinsics stores a null pointer into the "ptrloc"
2903 location.  At compile-time, the code generator generates information to allow
2904 the runtime to find the pointer at GC safe points.
2905 </p>
2906
2907 </div>
2908
2909
2910 <!-- _______________________________________________________________________ -->
2911 <div class="doc_subsubsection">
2912   <a name="i_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
2913 </div>
2914
2915 <div class="doc_text">
2916
2917 <h5>Syntax:</h5>
2918
2919 <pre>
2920   declare sbyte* %llvm.gcread(sbyte* %ObjPtr, sbyte** %Ptr)
2921 </pre>
2922
2923 <h5>Overview:</h5>
2924
2925 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
2926 locations, allowing garbage collector implementations that require read
2927 barriers.</p>
2928
2929 <h5>Arguments:</h5>
2930
2931 <p>The second argument is the address to read from, which should be an address
2932 allocated from the garbage collector.  The first object is a pointer to the
2933 start of the referenced object, if needed by the language runtime (otherwise
2934 null).</p>
2935
2936 <h5>Semantics:</h5>
2937
2938 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
2939 instruction, but may be replaced with substantially more complex code by the
2940 garbage collector runtime, as needed.</p>
2941
2942 </div>
2943
2944
2945 <!-- _______________________________________________________________________ -->
2946 <div class="doc_subsubsection">
2947   <a name="i_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
2948 </div>
2949
2950 <div class="doc_text">
2951
2952 <h5>Syntax:</h5>
2953
2954 <pre>
2955   declare void %llvm.gcwrite(sbyte* %P1, sbyte* %Obj, sbyte** %P2)
2956 </pre>
2957
2958 <h5>Overview:</h5>
2959
2960 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
2961 locations, allowing garbage collector implementations that require write
2962 barriers (such as generational or reference counting collectors).</p>
2963
2964 <h5>Arguments:</h5>
2965
2966 <p>The first argument is the reference to store, the second is the start of the
2967 object to store it to, and the third is the address of the field of Obj to
2968 store to.  If the runtime does not require a pointer to the object, Obj may be
2969 null.</p>
2970
2971 <h5>Semantics:</h5>
2972
2973 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
2974 instruction, but may be replaced with substantially more complex code by the
2975 garbage collector runtime, as needed.</p>
2976
2977 </div>
2978
2979
2980
2981 <!-- ======================================================================= -->
2982 <div class="doc_subsection">
2983   <a name="int_codegen">Code Generator Intrinsics</a>
2984 </div>
2985
2986 <div class="doc_text">
2987 <p>
2988 These intrinsics are provided by LLVM to expose special features that may only
2989 be implemented with code generator support.
2990 </p>
2991
2992 </div>
2993
2994 <!-- _______________________________________________________________________ -->
2995 <div class="doc_subsubsection">
2996   <a name="i_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
2997 </div>
2998
2999 <div class="doc_text">
3000
3001 <h5>Syntax:</h5>
3002 <pre>
3003   declare sbyte *%llvm.returnaddress(uint &lt;level&gt;)
3004 </pre>
3005
3006 <h5>Overview:</h5>
3007
3008 <p>
3009 The '<tt>llvm.returnaddress</tt>' intrinsic returns a target-specific value
3010 indicating the return address of the current function or one of its callers.
3011 </p>
3012
3013 <h5>Arguments:</h5>
3014
3015 <p>
3016 The argument to this intrinsic indicates which function to return the address
3017 for.  Zero indicates the calling function, one indicates its caller, etc.  The
3018 argument is <b>required</b> to be a constant integer value.
3019 </p>
3020
3021 <h5>Semantics:</h5>
3022
3023 <p>
3024 The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
3025 the return address of the specified call frame, or zero if it cannot be
3026 identified.  The value returned by this intrinsic is likely to be incorrect or 0
3027 for arguments other than zero, so it should only be used for debugging purposes.
3028 </p>
3029
3030 <p>
3031 Note that calling this intrinsic does not prevent function inlining or other
3032 aggressive transformations, so the value returned may not be that of the obvious
3033 source-language caller.
3034 </p>
3035 </div>
3036
3037
3038 <!-- _______________________________________________________________________ -->
3039 <div class="doc_subsubsection">
3040   <a name="i_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
3041 </div>
3042
3043 <div class="doc_text">
3044
3045 <h5>Syntax:</h5>
3046 <pre>
3047   declare sbyte *%llvm.frameaddress(uint &lt;level&gt;)
3048 </pre>
3049
3050 <h5>Overview:</h5>
3051
3052 <p>
3053 The '<tt>llvm.frameaddress</tt>' intrinsic returns the target-specific frame
3054 pointer value for the specified stack frame.
3055 </p>
3056
3057 <h5>Arguments:</h5>
3058
3059 <p>
3060 The argument to this intrinsic indicates which function to return the frame
3061 pointer for.  Zero indicates the calling function, one indicates its caller,
3062 etc.  The argument is <b>required</b> to be a constant integer value.
3063 </p>
3064
3065 <h5>Semantics:</h5>
3066
3067 <p>
3068 The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
3069 the frame address of the specified call frame, or zero if it cannot be
3070 identified.  The value returned by this intrinsic is likely to be incorrect or 0
3071 for arguments other than zero, so it should only be used for debugging purposes.
3072 </p>
3073
3074 <p>
3075 Note that calling this intrinsic does not prevent function inlining or other
3076 aggressive transformations, so the value returned may not be that of the obvious
3077 source-language caller.
3078 </p>
3079 </div>
3080
3081 <!-- _______________________________________________________________________ -->
3082 <div class="doc_subsubsection">
3083   <a name="i_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
3084 </div>
3085
3086 <div class="doc_text">
3087
3088 <h5>Syntax:</h5>
3089 <pre>
3090   declare sbyte *%llvm.stacksave()
3091 </pre>
3092
3093 <h5>Overview:</h5>
3094
3095 <p>
3096 The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state of
3097 the function stack, for use with <a href="#i_stackrestore">
3098 <tt>llvm.stackrestore</tt></a>.  This is useful for implementing language
3099 features like scoped automatic variable sized arrays in C99.
3100 </p>
3101
3102 <h5>Semantics:</h5>
3103
3104 <p>
3105 This intrinsic returns a opaque pointer value that can be passed to <a
3106 href="#i_stackrestore"><tt>llvm.stackrestore</tt></a>.  When an
3107 <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved from
3108 <tt>llvm.stacksave</tt>, it effectively restores the state of the stack to the
3109 state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.  In
3110 practice, this pops any <a href="#i_alloca">alloca</a> blocks from the stack
3111 that were allocated after the <tt>llvm.stacksave</tt> was executed.
3112 </p>
3113
3114 </div>
3115
3116 <!-- _______________________________________________________________________ -->
3117 <div class="doc_subsubsection">
3118   <a name="i_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
3119 </div>
3120
3121 <div class="doc_text">
3122
3123 <h5>Syntax:</h5>
3124 <pre>
3125   declare void %llvm.stackrestore(sbyte* %ptr)
3126 </pre>
3127
3128 <h5>Overview:</h5>
3129
3130 <p>
3131 The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
3132 the function stack to the state it was in when the corresponding <a
3133 href="#llvm.stacksave"><tt>llvm.stacksave</tt></a> intrinsic executed.  This is
3134 useful for implementing language features like scoped automatic variable sized
3135 arrays in C99.
3136 </p>
3137
3138 <h5>Semantics:</h5>
3139
3140 <p>
3141 See the description for <a href="#i_stacksave"><tt>llvm.stacksave</tt></a>.
3142 </p>
3143
3144 </div>
3145
3146
3147 <!-- _______________________________________________________________________ -->
3148 <div class="doc_subsubsection">
3149   <a name="i_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
3150 </div>
3151
3152 <div class="doc_text">
3153
3154 <h5>Syntax:</h5>
3155 <pre>
3156   declare void %llvm.prefetch(sbyte * &lt;address&gt;,
3157                                 uint &lt;rw&gt;, uint &lt;locality&gt;)
3158 </pre>
3159
3160 <h5>Overview:</h5>
3161
3162
3163 <p>
3164 The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
3165 a prefetch instruction if supported; otherwise, it is a noop.  Prefetches have
3166 no
3167 effect on the behavior of the program but can change its performance
3168 characteristics.
3169 </p>
3170
3171 <h5>Arguments:</h5>
3172
3173 <p>
3174 <tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
3175 determining if the fetch should be for a read (0) or write (1), and
3176 <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
3177 locality, to (3) - extremely local keep in cache.  The <tt>rw</tt> and
3178 <tt>locality</tt> arguments must be constant integers.
3179 </p>
3180
3181 <h5>Semantics:</h5>
3182
3183 <p>
3184 This intrinsic does not modify the behavior of the program.  In particular,
3185 prefetches cannot trap and do not produce a value.  On targets that support this
3186 intrinsic, the prefetch can provide hints to the processor cache for better
3187 performance.
3188 </p>
3189
3190 </div>
3191
3192 <!-- _______________________________________________________________________ -->
3193 <div class="doc_subsubsection">
3194   <a name="i_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
3195 </div>
3196
3197 <div class="doc_text">
3198
3199 <h5>Syntax:</h5>
3200 <pre>
3201   declare void %llvm.pcmarker( uint &lt;id&gt; )
3202 </pre>
3203
3204 <h5>Overview:</h5>
3205
3206
3207 <p>
3208 The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter
3209 (PC) in a region of
3210 code to simulators and other tools.  The method is target specific, but it is
3211 expected that the marker will use exported symbols to transmit the PC of the marker.
3212 The marker makes no guarantees that it will remain with any specific instruction
3213 after optimizations.  It is possible that the presence of a marker will inhibit
3214 optimizations.  The intended use is to be inserted after optmizations to allow
3215 correlations of simulation runs.
3216 </p>
3217
3218 <h5>Arguments:</h5>
3219
3220 <p>
3221 <tt>id</tt> is a numerical id identifying the marker.
3222 </p>
3223
3224 <h5>Semantics:</h5>
3225
3226 <p>
3227 This intrinsic does not modify the behavior of the program.  Backends that do not
3228 support this intrinisic may ignore it.
3229 </p>
3230
3231 </div>
3232
3233 <!-- _______________________________________________________________________ -->
3234 <div class="doc_subsubsection">
3235   <a name="i_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
3236 </div>
3237
3238 <div class="doc_text">
3239
3240 <h5>Syntax:</h5>
3241 <pre>
3242   declare ulong %llvm.readcyclecounter( )
3243 </pre>
3244
3245 <h5>Overview:</h5>
3246
3247
3248 <p>
3249 The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
3250 counter register (or similar low latency, high accuracy clocks) on those targets
3251 that support it.  On X86, it should map to RDTSC.  On Alpha, it should map to RPCC.
3252 As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
3253 should only be used for small timings.
3254 </p>
3255
3256 <h5>Semantics:</h5>
3257
3258 <p>
3259 When directly supported, reading the cycle counter should not modify any memory.
3260 Implementations are allowed to either return a application specific value or a
3261 system wide value.  On backends without support, this is lowered to a constant 0.
3262 </p>
3263
3264 </div>
3265
3266 <!-- ======================================================================= -->
3267 <div class="doc_subsection">
3268   <a name="int_libc">Standard C Library Intrinsics</a>
3269 </div>
3270
3271 <div class="doc_text">
3272 <p>
3273 LLVM provides intrinsics for a few important standard C library functions.
3274 These intrinsics allow source-language front-ends to pass information about the
3275 alignment of the pointer arguments to the code generator, providing opportunity
3276 for more efficient code generation.
3277 </p>
3278
3279 </div>
3280
3281 <!-- _______________________________________________________________________ -->
3282 <div class="doc_subsubsection">
3283   <a name="i_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
3284 </div>
3285
3286 <div class="doc_text">
3287
3288 <h5>Syntax:</h5>
3289 <pre>
3290   declare void %llvm.memcpy.i32(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3291                                 uint &lt;len&gt;, uint &lt;align&gt;)
3292   declare void %llvm.memcpy.i64(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3293                                 ulong &lt;len&gt;, uint &lt;align&gt;)
3294 </pre>
3295
3296 <h5>Overview:</h5>
3297
3298 <p>
3299 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
3300 location to the destination location.
3301 </p>
3302
3303 <p>
3304 Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
3305 intrinsics do not return a value, and takes an extra alignment argument.
3306 </p>
3307
3308 <h5>Arguments:</h5>
3309
3310 <p>
3311 The first argument is a pointer to the destination, the second is a pointer to
3312 the source.  The third argument is an integer argument
3313 specifying the number of bytes to copy, and the fourth argument is the alignment
3314 of the source and destination locations.
3315 </p>
3316
3317 <p>
3318 If the call to this intrinisic has an alignment value that is not 0 or 1, then
3319 the caller guarantees that both the source and destination pointers are aligned
3320 to that boundary.
3321 </p>
3322
3323 <h5>Semantics:</h5>
3324
3325 <p>
3326 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
3327 location to the destination location, which are not allowed to overlap.  It
3328 copies "len" bytes of memory over.  If the argument is known to be aligned to
3329 some boundary, this can be specified as the fourth argument, otherwise it should
3330 be set to 0 or 1.
3331 </p>
3332 </div>
3333
3334
3335 <!-- _______________________________________________________________________ -->
3336 <div class="doc_subsubsection">
3337   <a name="i_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
3338 </div>
3339
3340 <div class="doc_text">
3341
3342 <h5>Syntax:</h5>
3343 <pre>
3344   declare void %llvm.memmove.i32(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3345                                  uint &lt;len&gt;, uint &lt;align&gt;)
3346   declare void %llvm.memmove.i64(sbyte* &lt;dest&gt;, sbyte* &lt;src&gt;,
3347                                  ulong &lt;len&gt;, uint &lt;align&gt;)
3348 </pre>
3349
3350 <h5>Overview:</h5>
3351
3352 <p>
3353 The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the source
3354 location to the destination location. It is similar to the
3355 '<tt>llvm.memcmp</tt>' intrinsic but allows the two memory locations to overlap.
3356 </p>
3357
3358 <p>
3359 Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
3360 intrinsics do not return a value, and takes an extra alignment argument.
3361 </p>
3362
3363 <h5>Arguments:</h5>
3364
3365 <p>
3366 The first argument is a pointer to the destination, the second is a pointer to
3367 the source.  The third argument is an integer argument
3368 specifying the number of bytes to copy, and the fourth argument is the alignment
3369 of the source and destination locations.
3370 </p>
3371
3372 <p>
3373 If the call to this intrinisic has an alignment value that is not 0 or 1, then
3374 the caller guarantees that the source and destination pointers are aligned to
3375 that boundary.
3376 </p>
3377
3378 <h5>Semantics:</h5>
3379
3380 <p>
3381 The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the source
3382 location to the destination location, which may overlap.  It
3383 copies "len" bytes of memory over.  If the argument is known to be aligned to
3384 some boundary, this can be specified as the fourth argument, otherwise it should
3385 be set to 0 or 1.
3386 </p>
3387 </div>
3388
3389
3390 <!-- _______________________________________________________________________ -->
3391 <div class="doc_subsubsection">
3392   <a name="i_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
3393 </div>
3394
3395 <div class="doc_text">
3396
3397 <h5>Syntax:</h5>
3398 <pre>
3399   declare void %llvm.memset.i32(sbyte* &lt;dest&gt;, ubyte &lt;val&gt;,
3400                                 uint &lt;len&gt;, uint &lt;align&gt;)
3401   declare void %llvm.memset.i64(sbyte* &lt;dest&gt;, ubyte &lt;val&gt;,
3402                                 ulong &lt;len&gt;, uint &lt;align&gt;)
3403 </pre>
3404
3405 <h5>Overview:</h5>
3406
3407 <p>
3408 The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a particular
3409 byte value.
3410 </p>
3411
3412 <p>
3413 Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
3414 does not return a value, and takes an extra alignment argument.
3415 </p>
3416
3417 <h5>Arguments:</h5>
3418
3419 <p>
3420 The first argument is a pointer to the destination to fill, the second is the
3421 byte value to fill it with, the third argument is an integer
3422 argument specifying the number of bytes to fill, and the fourth argument is the
3423 known alignment of destination location.
3424 </p>
3425
3426 <p>
3427 If the call to this intrinisic has an alignment value that is not 0 or 1, then
3428 the caller guarantees that the destination pointer is aligned to that boundary.
3429 </p>
3430
3431 <h5>Semantics:</h5>
3432
3433 <p>
3434 The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting at
3435 the
3436 destination location.  If the argument is known to be aligned to some boundary,
3437 this can be specified as the fourth argument, otherwise it should be set to 0 or
3438 1.
3439 </p>
3440 </div>
3441
3442
3443 <!-- _______________________________________________________________________ -->
3444 <div class="doc_subsubsection">
3445   <a name="i_isunordered">'<tt>llvm.isunordered.*</tt>' Intrinsic</a>
3446 </div>
3447
3448 <div class="doc_text">
3449
3450 <h5>Syntax:</h5>
3451 <pre>
3452   declare bool %llvm.isunordered.f32(float Val1, float  Val2)
3453   declare bool %llvm.isunordered.f64(double Val1, double Val2)
3454 </pre>
3455
3456 <h5>Overview:</h5>
3457
3458 <p>
3459 The '<tt>llvm.isunordered</tt>' intrinsics return true if either or both of the
3460 specified floating point values is a NAN.
3461 </p>
3462
3463 <h5>Arguments:</h5>
3464
3465 <p>
3466 The arguments are floating point numbers of the same type.
3467 </p>
3468
3469 <h5>Semantics:</h5>
3470
3471 <p>
3472 If either or both of the arguments is a SNAN or QNAN, it returns true, otherwise
3473 false.
3474 </p>
3475 </div>
3476
3477
3478 <!-- _______________________________________________________________________ -->
3479 <div class="doc_subsubsection">
3480   <a name="i_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
3481 </div>
3482
3483 <div class="doc_text">
3484
3485 <h5>Syntax:</h5>
3486 <pre>
3487   declare double %llvm.sqrt.f32(float Val)
3488   declare double %llvm.sqrt.f64(double Val)
3489 </pre>
3490
3491 <h5>Overview:</h5>
3492
3493 <p>
3494 The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
3495 returning the same value as the libm '<tt>sqrt</tt>' function would.  Unlike
3496 <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for
3497 negative numbers (which allows for better optimization).
3498 </p>
3499
3500 <h5>Arguments:</h5>
3501
3502 <p>
3503 The argument and return value are floating point numbers of the same type.
3504 </p>
3505
3506 <h5>Semantics:</h5>
3507
3508 <p>
3509 This function returns the sqrt of the specified operand if it is a positive
3510 floating point number.
3511 </p>
3512 </div>
3513
3514 <!-- ======================================================================= -->
3515 <div class="doc_subsection">
3516   <a name="int_manip">Bit Manipulation Intrinsics</a>
3517 </div>
3518
3519 <div class="doc_text">
3520 <p>
3521 LLVM provides intrinsics for a few important bit manipulation operations.
3522 These allow efficient code generation for some algorithms.
3523 </p>
3524
3525 </div>
3526
3527 <!-- _______________________________________________________________________ -->
3528 <div class="doc_subsubsection">
3529   <a name="i_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
3530 </div>
3531
3532 <div class="doc_text">
3533
3534 <h5>Syntax:</h5>
3535 <pre>
3536   declare ushort %llvm.bswap.i16(ushort &lt;id&gt;)
3537   declare uint   %llvm.bswap.i32(uint &lt;id&gt;)
3538   declare ulong  %llvm.bswap.i64(ulong &lt;id&gt;)
3539 </pre>
3540
3541 <h5>Overview:</h5>
3542
3543 <p>
3544 The '<tt>llvm.bwsap</tt>' family of intrinsics is used to byteswap a 16, 32 or
3545 64 bit quantity.  These are useful for performing operations on data that is not
3546 in the target's  native byte order.
3547 </p>
3548
3549 <h5>Semantics:</h5>
3550
3551 <p>
3552 The <tt>llvm.bswap.16</tt> intrinsic returns a ushort value that has the high and low
3553 byte of the input ushort swapped.  Similarly, the <tt>llvm.bswap.i32</tt> intrinsic
3554 returns a uint value that has the four bytes of the input uint swapped, so that
3555 if the input bytes are numbered 0, 1, 2, 3 then the returned uint will have its
3556 bytes in 3, 2, 1, 0 order.  The <tt>llvm.bswap.i64</tt> intrinsic extends this concept
3557 to 64 bits.
3558 </p>
3559
3560 </div>
3561
3562 <!-- _______________________________________________________________________ -->
3563 <div class="doc_subsubsection">
3564   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
3565 </div>
3566
3567 <div class="doc_text">
3568
3569 <h5>Syntax:</h5>
3570 <pre>
3571   declare ubyte  %llvm.ctpop.i8 (ubyte &lt;src&gt;)
3572   declare ushort %llvm.ctpop.i16(ushort &lt;src&gt;)
3573   declare uint   %llvm.ctpop.i32(uint &lt;src&gt;)
3574   declare ulong  %llvm.ctpop.i64(ulong &lt;src&gt;)
3575 </pre>
3576
3577 <h5>Overview:</h5>
3578
3579 <p>
3580 The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set in a
3581 value.
3582 </p>
3583
3584 <h5>Arguments:</h5>
3585
3586 <p>
3587 The only argument is the value to be counted.  The argument may be of any
3588 unsigned integer type.  The return type must match the argument type.
3589 </p>
3590
3591 <h5>Semantics:</h5>
3592
3593 <p>
3594 The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
3595 </p>
3596 </div>
3597
3598 <!-- _______________________________________________________________________ -->
3599 <div class="doc_subsubsection">
3600   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
3601 </div>
3602
3603 <div class="doc_text">
3604
3605 <h5>Syntax:</h5>
3606 <pre>
3607   declare ubyte  %llvm.ctlz.i8 (ubyte &lt;src&gt;)
3608   declare ushort %llvm.ctlz.i16(ushort &lt;src&gt;)
3609   declare uint   %llvm.ctlz.i32(uint &lt;src&gt;)
3610   declare ulong  %llvm.ctlz.i64(ulong &lt;src&gt;)
3611 </pre>
3612
3613 <h5>Overview:</h5>
3614
3615 <p>
3616 The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
3617 leading zeros in a variable.
3618 </p>
3619
3620 <h5>Arguments:</h5>
3621
3622 <p>
3623 The only argument is the value to be counted.  The argument may be of any
3624 unsigned integer type. The return type must match the argument type.
3625 </p>
3626
3627 <h5>Semantics:</h5>
3628
3629 <p>
3630 The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros
3631 in a variable.  If the src == 0 then the result is the size in bits of the type
3632 of src. For example, <tt>llvm.cttz(int 2) = 30</tt>.
3633 </p>
3634 </div>
3635
3636
3637
3638 <!-- _______________________________________________________________________ -->
3639 <div class="doc_subsubsection">
3640   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
3641 </div>
3642
3643 <div class="doc_text">
3644
3645 <h5>Syntax:</h5>
3646 <pre>
3647   declare ubyte  %llvm.cttz.i8 (ubyte &lt;src&gt;)
3648   declare ushort %llvm.cttz.i16(ushort &lt;src&gt;)
3649   declare uint   %llvm.cttz.i32(uint &lt;src&gt;)
3650   declare ulong  %llvm.cttz.i64(ulong &lt;src&gt;)
3651 </pre>
3652
3653 <h5>Overview:</h5>
3654
3655 <p>
3656 The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
3657 trailing zeros.
3658 </p>
3659
3660 <h5>Arguments:</h5>
3661
3662 <p>
3663 The only argument is the value to be counted.  The argument may be of any
3664 unsigned integer type.  The return type must match the argument type.
3665 </p>
3666
3667 <h5>Semantics:</h5>
3668
3669 <p>
3670 The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros
3671 in a variable.  If the src == 0 then the result is the size in bits of the type
3672 of src.  For example, <tt>llvm.cttz(2) = 1</tt>.
3673 </p>
3674 </div>
3675
3676 <!-- ======================================================================= -->
3677 <div class="doc_subsection">
3678   <a name="int_debugger">Debugger Intrinsics</a>
3679 </div>
3680
3681 <div class="doc_text">
3682 <p>
3683 The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
3684 are described in the <a
3685 href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
3686 Debugging</a> document.
3687 </p>
3688 </div>
3689
3690
3691 <!-- *********************************************************************** -->
3692 <hr>
3693 <address>
3694   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
3695   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
3696   <a href="http://validator.w3.org/check/referer"><img
3697   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
3698
3699   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
3700   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
3701   Last modified: $Date$
3702 </address>
3703 </body>
3704 </html>