docs/LangRef.html

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