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