docs/LangRef.html

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