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