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