docs/LangRef.html

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