docs/LangRef.html

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