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