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