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