docs/LangRef.html

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