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="#namedtypes">Named Types</a></li>
  26       <li><a href="#globalvars">Global Variables</a></li>
  27       <li><a href="#functionstructure">Functions</a></li>
  28       <li><a href="#aliasstructure">Aliases</a></li>
  29       <li><a href="#paramattrs">Parameter Attributes</a></li>
  30       <li><a href="#fnattrs">Function Attributes</a></li>
  31       <li><a href="#gc">Garbage Collector Names</a></li>
  32       <li><a href="#moduleasm">Module-Level Inline Assembly</a></li>
  33       <li><a href="#datalayout">Data Layout</a></li>
  34     </ol>
  35   </li>
  36   <li><a href="#typesystem">Type System</a>
  37     <ol>
  38       <li><a href="#t_classifications">Type Classifications</a></li>
  39       <li><a href="#t_primitive">Primitive Types</a>
  40         <ol>
  41           <li><a href="#t_floating">Floating Point Types</a></li>
  42           <li><a href="#t_void">Void Type</a></li>
  43           <li><a href="#t_label">Label Type</a></li>
  44         </ol>
  45       </li>
  46       <li><a href="#t_derived">Derived Types</a>
  47         <ol>
  48           <li><a href="#t_integer">Integer Type</a></li>
  49           <li><a href="#t_array">Array Type</a></li>
  50           <li><a href="#t_function">Function Type</a></li>
  51           <li><a href="#t_pointer">Pointer Type</a></li>
  52           <li><a href="#t_struct">Structure Type</a></li>
  53           <li><a href="#t_pstruct">Packed Structure Type</a></li>
  54           <li><a href="#t_vector">Vector Type</a></li>
  55           <li><a href="#t_opaque">Opaque Type</a></li>
  56         </ol>
  57       </li>
  58       <li><a href="#t_uprefs">Type Up-references</a></li>
  59     </ol>
  60   </li>
  61   <li><a href="#constants">Constants</a>
  62     <ol>
  63       <li><a href="#simpleconstants">Simple Constants</a></li>
  64       <li><a href="#aggregateconstants">Aggregate Constants</a></li>
  65       <li><a href="#globalconstants">Global Variable and Function Addresses</a></li>
  66       <li><a href="#undefvalues">Undefined Values</a></li>
  67       <li><a href="#constantexprs">Constant Expressions</a></li>
  68     </ol>
  69   </li>
  70   <li><a href="#othervalues">Other Values</a>
  71     <ol>
  72       <li><a href="#inlineasm">Inline Assembler Expressions</a></li>
  73     </ol>
  74   </li>
  75   <li><a href="#instref">Instruction Reference</a>
  76     <ol>
  77       <li><a href="#terminators">Terminator Instructions</a>
  78         <ol>
  79           <li><a href="#i_ret">'<tt>ret</tt>' Instruction</a></li>
  80           <li><a href="#i_br">'<tt>br</tt>' Instruction</a></li>
  81           <li><a href="#i_switch">'<tt>switch</tt>' Instruction</a></li>
  82           <li><a href="#i_invoke">'<tt>invoke</tt>' Instruction</a></li>
  83           <li><a href="#i_unwind">'<tt>unwind</tt>'  Instruction</a></li>
  84           <li><a href="#i_unreachable">'<tt>unreachable</tt>' Instruction</a></li>
  85         </ol>
  86       </li>
  87       <li><a href="#binaryops">Binary Operations</a>
  88         <ol>
  89           <li><a href="#i_add">'<tt>add</tt>' Instruction</a></li>
  90           <li><a href="#i_sub">'<tt>sub</tt>' Instruction</a></li>
  91           <li><a href="#i_mul">'<tt>mul</tt>' Instruction</a></li>
  92           <li><a href="#i_udiv">'<tt>udiv</tt>' Instruction</a></li>
  93           <li><a href="#i_sdiv">'<tt>sdiv</tt>' Instruction</a></li>
  94           <li><a href="#i_fdiv">'<tt>fdiv</tt>' Instruction</a></li>
  95           <li><a href="#i_urem">'<tt>urem</tt>' Instruction</a></li>
  96           <li><a href="#i_srem">'<tt>srem</tt>' Instruction</a></li>
  97           <li><a href="#i_frem">'<tt>frem</tt>' Instruction</a></li>
  98         </ol>
  99       </li>
 100       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
 101         <ol>
 102           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a></li>
 103           <li><a href="#i_lshr">'<tt>lshr</tt>' Instruction</a></li>
 104           <li><a href="#i_ashr">'<tt>ashr</tt>' Instruction</a></li>
 105           <li><a href="#i_and">'<tt>and</tt>' Instruction</a></li>
 106           <li><a href="#i_or">'<tt>or</tt>'  Instruction</a></li>
 107           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a></li>
 108         </ol>
 109       </li>
 110       <li><a href="#vectorops">Vector Operations</a>
 111         <ol>
 112           <li><a href="#i_extractelement">'<tt>extractelement</tt>' Instruction</a></li>
 113           <li><a href="#i_insertelement">'<tt>insertelement</tt>' Instruction</a></li>
 114           <li><a href="#i_shufflevector">'<tt>shufflevector</tt>' Instruction</a></li>
 115         </ol>
 116       </li>
 117       <li><a href="#aggregateops">Aggregate Operations</a>
 118         <ol>
 119           <li><a href="#i_extractvalue">'<tt>extractvalue</tt>' Instruction</a></li>
 120           <li><a href="#i_insertvalue">'<tt>insertvalue</tt>' Instruction</a></li>
 121         </ol>
 122       </li>
 123       <li><a href="#memoryops">Memory Access and Addressing Operations</a>
 124         <ol>
 125           <li><a href="#i_malloc">'<tt>malloc</tt>'   Instruction</a></li>
 126           <li><a href="#i_free">'<tt>free</tt>'     Instruction</a></li>
 127           <li><a href="#i_alloca">'<tt>alloca</tt>'   Instruction</a></li>
 128          <li><a href="#i_load">'<tt>load</tt>'     Instruction</a></li>
 129          <li><a href="#i_store">'<tt>store</tt>'    Instruction</a></li>
 130          <li><a href="#i_getelementptr">'<tt>getelementptr</tt>' Instruction</a></li>
 131         </ol>
 132       </li>
 133       <li><a href="#convertops">Conversion Operations</a>
 134         <ol>
 135           <li><a href="#i_trunc">'<tt>trunc .. to</tt>' Instruction</a></li>
 136           <li><a href="#i_zext">'<tt>zext .. to</tt>' Instruction</a></li>
 137           <li><a href="#i_sext">'<tt>sext .. to</tt>' Instruction</a></li>
 138           <li><a href="#i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a></li>
 139           <li><a href="#i_fpext">'<tt>fpext .. to</tt>' Instruction</a></li>
 140           <li><a href="#i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a></li>
 141           <li><a href="#i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a></li>
 142           <li><a href="#i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a></li>
 143           <li><a href="#i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a></li>
 144           <li><a href="#i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a></li>
 145           <li><a href="#i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a></li>
 146           <li><a href="#i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a></li>
 147         </ol>
 148       </li>
 149       <li><a href="#otherops">Other Operations</a>
 150         <ol>
 151           <li><a href="#i_icmp">'<tt>icmp</tt>' Instruction</a></li>
 152           <li><a href="#i_fcmp">'<tt>fcmp</tt>' Instruction</a></li>
 153           <li><a href="#i_vicmp">'<tt>vicmp</tt>' Instruction</a></li>
 154           <li><a href="#i_vfcmp">'<tt>vfcmp</tt>' Instruction</a></li>
 155           <li><a href="#i_phi">'<tt>phi</tt>'   Instruction</a></li>
 156           <li><a href="#i_select">'<tt>select</tt>' Instruction</a></li>
 157           <li><a href="#i_call">'<tt>call</tt>'  Instruction</a></li>
 158           <li><a href="#i_va_arg">'<tt>va_arg</tt>'  Instruction</a></li>
 159         </ol>
 160       </li>
 161     </ol>
 162   </li>
 163   <li><a href="#intrinsics">Intrinsic Functions</a>
 164     <ol>
 165       <li><a href="#int_varargs">Variable Argument Handling Intrinsics</a>
 166         <ol>
 167           <li><a href="#int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a></li>
 168           <li><a href="#int_va_end">'<tt>llvm.va_end</tt>'   Intrinsic</a></li>
 169           <li><a href="#int_va_copy">'<tt>llvm.va_copy</tt>'  Intrinsic</a></li>
 170         </ol>
 171       </li>
 172       <li><a href="#int_gc">Accurate Garbage Collection Intrinsics</a>
 173         <ol>
 174           <li><a href="#int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a></li>
 175           <li><a href="#int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a></li>
 176           <li><a href="#int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a></li>
 177         </ol>
 178       </li>
 179       <li><a href="#int_codegen">Code Generator Intrinsics</a>
 180         <ol>
 181           <li><a href="#int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a></li>
 182           <li><a href="#int_frameaddress">'<tt>llvm.frameaddress</tt>'   Intrinsic</a></li>
 183           <li><a href="#int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a></li>
 184           <li><a href="#int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a></li>
 185           <li><a href="#int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a></li>
 186           <li><a href="#int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a></li>
 187           <li><a href="#int_readcyclecounter"><tt>llvm.readcyclecounter</tt>' Intrinsic</a></li>
 188         </ol>
 189       </li>
 190       <li><a href="#int_libc">Standard C Library Intrinsics</a>
 191         <ol>
 192           <li><a href="#int_memcpy">'<tt>llvm.memcpy.*</tt>' Intrinsic</a></li>
 193           <li><a href="#int_memmove">'<tt>llvm.memmove.*</tt>' Intrinsic</a></li>
 194           <li><a href="#int_memset">'<tt>llvm.memset.*</tt>' Intrinsic</a></li>
 195           <li><a href="#int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a></li>
 196           <li><a href="#int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a></li>
 197           <li><a href="#int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a></li>
 198           <li><a href="#int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a></li>
 199           <li><a href="#int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a></li>
 200         </ol>
 201       </li>
 202       <li><a href="#int_manip">Bit Manipulation Intrinsics</a>
 203         <ol>
 204           <li><a href="#int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a></li>
 205           <li><a href="#int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic </a></li>
 206           <li><a href="#int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic </a></li>
 207           <li><a href="#int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic </a></li>
 208           <li><a href="#int_part_select">'<tt>llvm.part.select.*</tt>' Intrinsic </a></li>
 209           <li><a href="#int_part_set">'<tt>llvm.part.set.*</tt>' Intrinsic </a></li>
 210         </ol>
 211       </li>
 212       <li><a href="#int_debugger">Debugger intrinsics</a></li>
 213       <li><a href="#int_eh">Exception Handling intrinsics</a></li>
 214       <li><a href="#int_trampoline">Trampoline Intrinsic</a>
 215         <ol>
 216           <li><a href="#int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a></li>
 217         </ol>
 218       </li>
 219       <li><a href="#int_atomics">Atomic intrinsics</a>
 220         <ol>
 221           <li><a href="#int_memory_barrier"><tt>llvm.memory_barrier</tt></a></li>
 222           <li><a href="#int_atomic_cmp_swap"><tt>llvm.atomic.cmp.swap</tt></a></li>
 223           <li><a href="#int_atomic_swap"><tt>llvm.atomic.swap</tt></a></li>
 224           <li><a href="#int_atomic_load_add"><tt>llvm.atomic.load.add</tt></a></li>
 225           <li><a href="#int_atomic_load_sub"><tt>llvm.atomic.load.sub</tt></a></li>
 226           <li><a href="#int_atomic_load_and"><tt>llvm.atomic.load.and</tt></a></li>
 227           <li><a href="#int_atomic_load_nand"><tt>llvm.atomic.load.nand</tt></a></li>
 228           <li><a href="#int_atomic_load_or"><tt>llvm.atomic.load.or</tt></a></li>
 229           <li><a href="#int_atomic_load_xor"><tt>llvm.atomic.load.xor</tt></a></li>
 230           <li><a href="#int_atomic_load_max"><tt>llvm.atomic.load.max</tt></a></li>
 231           <li><a href="#int_atomic_load_min"><tt>llvm.atomic.load.min</tt></a></li>
 232           <li><a href="#int_atomic_load_umax"><tt>llvm.atomic.load.umax</tt></a></li>
 233           <li><a href="#int_atomic_load_umin"><tt>llvm.atomic.load.umin</tt></a></li>
 234         </ol>
 235       </li>
 236       <li><a href="#int_general">General intrinsics</a>
 237         <ol>
 238           <li><a href="#int_var_annotation">
 239             '<tt>llvm.var.annotation</tt>' Intrinsic</a></li>
 240           <li><a href="#int_annotation">
 241             '<tt>llvm.annotation.*</tt>' Intrinsic</a></li>
 242           <li><a href="#int_trap">
 243             '<tt>llvm.trap</tt>' Intrinsic</a></li>
 244           <li><a href="#int_stackprotector">
 245             '<tt>llvm.stackprotector</tt>' Intrinsic</a></li>
 246         </ol>
 247       </li>
 248     </ol>
 249   </li>
 250 </ol>
 251
 252 <div class="doc_author">
 253   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
 254             and <a href="mailto:vadve@cs.uiuc.edu">Vikram Adve</a></p>
 255 </div>
 256
 257 <!-- *********************************************************************** -->
 258 <div class="doc_section"> <a name="abstract">Abstract </a></div>
 259 <!-- *********************************************************************** -->
 260
 261 <div class="doc_text">
 262 <p>This document is a reference manual for the LLVM assembly language.
 263 LLVM is a Static Single Assignment (SSA) based representation that provides
 264 type safety, low-level operations, flexibility, and the capability of
 265 representing 'all' high-level languages cleanly.  It is the common code
 266 representation used throughout all phases of the LLVM compilation
 267 strategy.</p>
 268 </div>
 269
 270 <!-- *********************************************************************** -->
 271 <div class="doc_section"> <a name="introduction">Introduction</a> </div>
 272 <!-- *********************************************************************** -->
 273
 274 <div class="doc_text">
 275
 276 <p>The LLVM code representation is designed to be used in three
 277 different forms: as an in-memory compiler IR, as an on-disk bitcode
 278 representation (suitable for fast loading by a Just-In-Time compiler),
 279 and as a human readable assembly language representation.  This allows
 280 LLVM to provide a powerful intermediate representation for efficient
 281 compiler transformations and analysis, while providing a natural means
 282 to debug and visualize the transformations.  The three different forms
 283 of LLVM are all equivalent.  This document describes the human readable
 284 representation and notation.</p>
 285
 286 <p>The LLVM representation aims to be light-weight and low-level
 287 while being expressive, typed, and extensible at the same time.  It
 288 aims to be a "universal IR" of sorts, by being at a low enough level
 289 that high-level ideas may be cleanly mapped to it (similar to how
 290 microprocessors are "universal IR's", allowing many source languages to
 291 be mapped to them).  By providing type information, LLVM can be used as
 292 the target of optimizations: for example, through pointer analysis, it
 293 can be proven that a C automatic variable is never accessed outside of
 294 the current function... allowing it to be promoted to a simple SSA
 295 value instead of a memory location.</p>
 296
 297 </div>
 298
 299 <!-- _______________________________________________________________________ -->
 300 <div class="doc_subsubsection"> <a name="wellformed">Well-Formedness</a> </div>
 301
 302 <div class="doc_text">
 303
 304 <p>It is important to note that this document describes 'well formed'
 305 LLVM assembly language.  There is a difference between what the parser
 306 accepts and what is considered 'well formed'.  For example, the
 307 following instruction is syntactically okay, but not well formed:</p>
 308
 309 <div class="doc_code">
 310 <pre>
 311 %x = <a href="#i_add">add</a> i32 1, %x
 312 </pre>
 313 </div>
 314
 315 <p>...because the definition of <tt>%x</tt> does not dominate all of
 316 its uses. The LLVM infrastructure provides a verification pass that may
 317 be used to verify that an LLVM module is well formed.  This pass is
 318 automatically run by the parser after parsing input assembly and by
 319 the optimizer before it outputs bitcode.  The violations pointed out
 320 by the verifier pass indicate bugs in transformation passes or input to
 321 the parser.</p>
 322 </div>
 323
 324 <!-- Describe the typesetting conventions here. -->
 325
 326 <!-- *********************************************************************** -->
 327 <div class="doc_section"> <a name="identifiers">Identifiers</a> </div>
 328 <!-- *********************************************************************** -->
 329
 330 <div class="doc_text">
 331
 332   <p>LLVM identifiers come in two basic types: global and local. Global
 333   identifiers (functions, global variables) begin with the @ character. Local
 334   identifiers (register names, types) begin with the % character. Additionally,
 335   there are three different formats for identifiers, for different purposes:</p>
 336
 337 <ol>
 338   <li>Named values are represented as a string of characters with their prefix.
 339   For example, %foo, @DivisionByZero, %a.really.long.identifier.  The actual
 340   regular expression used is '<tt>[%@][a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
 341   Identifiers which require other characters in their names can be surrounded
 342   with quotes. Special characters may be escaped using "\xx" where xx is the
 343   ASCII code for the character in hexadecimal.  In this way, any character can
 344   be used in a name value, even quotes themselves.
 345
 346   <li>Unnamed values are represented as an unsigned numeric value with their
 347   prefix.  For example, %12, @2, %44.</li>
 348
 349   <li>Constants, which are described in a <a href="#constants">section about
 350   constants</a>, below.</li>
 351 </ol>
 352
 353 <p>LLVM requires that values start with a prefix for two reasons: Compilers
 354 don't need to worry about name clashes with reserved words, and the set of
 355 reserved words may be expanded in the future without penalty.  Additionally,
 356 unnamed identifiers allow a compiler to quickly come up with a temporary
 357 variable without having to avoid symbol table conflicts.</p>
 358
 359 <p>Reserved words in LLVM are very similar to reserved words in other
 360 languages. There are keywords for different opcodes
 361 ('<tt><a href="#i_add">add</a></tt>',
 362  '<tt><a href="#i_bitcast">bitcast</a></tt>',
 363  '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a
 364 href="#t_void">void</a></tt>', '<tt><a href="#t_primitive">i32</a></tt>', etc...),
 365 and others.  These reserved words cannot conflict with variable names, because
 366 none of them start with a prefix character ('%' or '@').</p>
 367
 368 <p>Here is an example of LLVM code to multiply the integer variable
 369 '<tt>%X</tt>' by 8:</p>
 370
 371 <p>The easy way:</p>
 372
 373 <div class="doc_code">
 374 <pre>
 375 %result = <a href="#i_mul">mul</a> i32 %X, 8
 376 </pre>
 377 </div>
 378
 379 <p>After strength reduction:</p>
 380
 381 <div class="doc_code">
 382 <pre>
 383 %result = <a href="#i_shl">shl</a> i32 %X, i8 3
 384 </pre>
 385 </div>
 386
 387 <p>And the hard way:</p>
 388
 389 <div class="doc_code">
 390 <pre>
 391 <a href="#i_add">add</a> i32 %X, %X           <i>; yields {i32}:%0</i>
 392 <a href="#i_add">add</a> i32 %0, %0           <i>; yields {i32}:%1</i>
 393 %result = <a href="#i_add">add</a> i32 %1, %1
 394 </pre>
 395 </div>
 396
 397 <p>This last way of multiplying <tt>%X</tt> by 8 illustrates several
 398 important lexical features of LLVM:</p>
 399
 400 <ol>
 401
 402   <li>Comments are delimited with a '<tt>;</tt>' and go until the end of
 403   line.</li>
 404
 405   <li>Unnamed temporaries are created when the result of a computation is not
 406   assigned to a named value.</li>
 407
 408   <li>Unnamed temporaries are numbered sequentially</li>
 409
 410 </ol>
 411
 412 <p>...and it also shows a convention that we follow in this document.  When
 413 demonstrating instructions, we will follow an instruction with a comment that
 414 defines the type and name of value produced.  Comments are shown in italic
 415 text.</p>
 416
 417 </div>
 418
 419 <!-- *********************************************************************** -->
 420 <div class="doc_section"> <a name="highlevel">High Level Structure</a> </div>
 421 <!-- *********************************************************************** -->
 422
 423 <!-- ======================================================================= -->
 424 <div class="doc_subsection"> <a name="modulestructure">Module Structure</a>
 425 </div>
 426
 427 <div class="doc_text">
 428
 429 <p>LLVM programs are composed of "Module"s, each of which is a
 430 translation unit of the input programs.  Each module consists of
 431 functions, global variables, and symbol table entries.  Modules may be
 432 combined together with the LLVM linker, which merges function (and
 433 global variable) definitions, resolves forward declarations, and merges
 434 symbol table entries. Here is an example of the "hello world" module:</p>
 435
 436 <div class="doc_code">
 437 <pre><i>; Declare the string constant as a global constant...</i>
 438 <a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a> <a
 439  href="#globalvars">constant</a> <a href="#t_array">[13 x i8]</a> c"hello world\0A\00"          <i>; [13 x i8]*</i>
 440
 441 <i>; External declaration of the puts function</i>
 442 <a href="#functionstructure">declare</a> i32 @puts(i8 *)                                            <i>; i32(i8 *)* </i>
 443
 444 <i>; Definition of main function</i>
 445 define i32 @main() {                                                 <i>; i32()* </i>
 446         <i>; Convert [13 x i8]* to i8  *...</i>
 447         %cast210 = <a
 448  href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0 <i>; i8 *</i>
 449
 450         <i>; Call puts function to write out the string to stdout...</i>
 451         <a
 452  href="#i_call">call</a> i32 @puts(i8 * %cast210)                              <i>; i32</i>
 453         <a
 454  href="#i_ret">ret</a> i32 0<br>}<br>
 455 </pre>
 456 </div>
 457
 458 <p>This example is made up of a <a href="#globalvars">global variable</a>
 459 named "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>"
 460 function, and a <a href="#functionstructure">function definition</a>
 461 for "<tt>main</tt>".</p>
 462
 463 <p>In general, a module is made up of a list of global values,
 464 where both functions and global variables are global values.  Global values are
 465 represented by a pointer to a memory location (in this case, a pointer to an
 466 array of char, and a pointer to a function), and have one of the following <a
 467 href="#linkage">linkage types</a>.</p>
 468
 469 </div>
 470
 471 <!-- ======================================================================= -->
 472 <div class="doc_subsection">
 473   <a name="linkage">Linkage Types</a>
 474 </div>
 475
 476 <div class="doc_text">
 477
 478 <p>
 479 All Global Variables and Functions have one of the following types of linkage:
 480 </p>
 481
 482 <dl>
 483
 484   <dt><tt><b><a name="linkage_private">private</a></b></tt>: </dt>
 485
 486   <dd>Global values with private linkage are only directly accessible by
 487   objects in the current module.  In particular, linking code into a module with
 488   an private global value may cause the private to be renamed as necessary to
 489   avoid collisions.  Because the symbol is private to the module, all
 490   references can be updated. This doesn't show up in any symbol table in the
 491   object file.
 492   </dd>
 493
 494   <dt><tt><b><a name="linkage_internal">internal</a></b></tt>: </dt>
 495
 496   <dd> Similar to private, but the value shows as a local symbol (STB_LOCAL in
 497   the case of ELF) in the object file. This corresponds to the notion of the
 498   '<tt>static</tt>' keyword in C.
 499   </dd>
 500
 501   <dt><tt><b><a name="linkage_linkonce">linkonce</a></b></tt>: </dt>
 502
 503   <dd>Globals with "<tt>linkonce</tt>" linkage are merged with other globals of
 504   the same name when linkage occurs.  This is typically used to implement
 505   inline functions, templates, or other code which must be generated in each
 506   translation unit that uses it.  Unreferenced <tt>linkonce</tt> globals are
 507   allowed to be discarded.
 508   </dd>
 509
 510   <dt><tt><b><a name="linkage_common">common</a></b></tt>: </dt>
 511
 512   <dd>"<tt>common</tt>" linkage is exactly the same as <tt>linkonce</tt>
 513   linkage, except that unreferenced <tt>common</tt> globals may not be
 514   discarded.  This is used for globals that may be emitted in multiple
 515   translation units, but that are not guaranteed to be emitted into every
 516   translation unit that uses them.  One example of this is tentative
 517   definitions in C, such as "<tt>int X;</tt>" at global scope.
 518   </dd>
 519
 520   <dt><tt><b><a name="linkage_weak">weak</a></b></tt>: </dt>
 521
 522   <dd>"<tt>weak</tt>" linkage is the same as <tt>common</tt> linkage, except
 523   that some targets may choose to emit different assembly sequences for them
 524   for target-dependent reasons.  This is used for globals that are declared
 525   "weak" in C source code.
 526   </dd>
 527
 528   <dt><tt><b><a name="linkage_appending">appending</a></b></tt>: </dt>
 529
 530   <dd>"<tt>appending</tt>" linkage may only be applied to global variables of
 531   pointer to array type.  When two global variables with appending linkage are
 532   linked together, the two global arrays are appended together.  This is the
 533   LLVM, typesafe, equivalent of having the system linker append together
 534   "sections" with identical names when .o files are linked.
 535   </dd>
 536
 537   <dt><tt><b><a name="linkage_externweak">extern_weak</a></b></tt>: </dt>
 538   <dd>The semantics of this linkage follow the ELF object file model: the
 539     symbol is weak until linked, if not linked, the symbol becomes null instead
 540     of being an undefined reference.
 541   </dd>
 542
 543   <dt><tt><b><a name="linkage_external">externally visible</a></b></tt>:</dt>
 544
 545   <dd>If none of the above identifiers are used, the global is externally
 546   visible, meaning that it participates in linkage and can be used to resolve
 547   external symbol references.
 548   </dd>
 549 </dl>
 550
 551   <p>
 552   The next two types of linkage are targeted for Microsoft Windows platform
 553   only. They are designed to support importing (exporting) symbols from (to)
 554   DLLs (Dynamic Link Libraries).
 555   </p>
 556
 557   <dl>
 558   <dt><tt><b><a name="linkage_dllimport">dllimport</a></b></tt>: </dt>
 559
 560   <dd>"<tt>dllimport</tt>" linkage causes the compiler to reference a function
 561     or variable via a global pointer to a pointer that is set up by the DLL
 562     exporting the symbol. On Microsoft Windows targets, the pointer name is
 563     formed by combining <code>__imp_</code> and the function or variable name.
 564   </dd>
 565
 566   <dt><tt><b><a name="linkage_dllexport">dllexport</a></b></tt>: </dt>
 567
 568   <dd>"<tt>dllexport</tt>" linkage causes the compiler to provide a global
 569     pointer to a pointer in a DLL, so that it can be referenced with the
 570     <tt>dllimport</tt> attribute. On Microsoft Windows targets, the pointer
 571     name is formed by combining <code>__imp_</code> and the function or variable
 572     name.
 573   </dd>
 574
 575 </dl>
 576
 577 <p>For example, since the "<tt>.LC0</tt>"
 578 variable is defined to be internal, if another module defined a "<tt>.LC0</tt>"
 579 variable and was linked with this one, one of the two would be renamed,
 580 preventing a collision.  Since "<tt>main</tt>" and "<tt>puts</tt>" are
 581 external (i.e., lacking any linkage declarations), they are accessible
 582 outside of the current module.</p>
 583 <p>It is illegal for a function <i>declaration</i>
 584 to have any linkage type other than "externally visible", <tt>dllimport</tt>,
 585 or <tt>extern_weak</tt>.</p>
 586 <p>Aliases can have only <tt>external</tt>, <tt>internal</tt> and <tt>weak</tt>
 587 linkages.</p>
 588 </div>
 589
 590 <!-- ======================================================================= -->
 591 <div class="doc_subsection">
 592   <a name="callingconv">Calling Conventions</a>
 593 </div>
 594
 595 <div class="doc_text">
 596
 597 <p>LLVM <a href="#functionstructure">functions</a>, <a href="#i_call">calls</a>
 598 and <a href="#i_invoke">invokes</a> can all have an optional calling convention
 599 specified for the call.  The calling convention of any pair of dynamic
 600 caller/callee must match, or the behavior of the program is undefined.  The
 601 following calling conventions are supported by LLVM, and more may be added in
 602 the future:</p>
 603
 604 <dl>
 605   <dt><b>"<tt>ccc</tt>" - The C calling convention</b>:</dt>
 606
 607   <dd>This calling convention (the default if no other calling convention is
 608   specified) matches the target C calling conventions.  This calling convention
 609   supports varargs function calls and tolerates some mismatch in the declared
 610   prototype and implemented declaration of the function (as does normal C).
 611   </dd>
 612
 613   <dt><b>"<tt>fastcc</tt>" - The fast calling convention</b>:</dt>
 614
 615   <dd>This calling convention attempts to make calls as fast as possible
 616   (e.g. by passing things in registers).  This calling convention allows the
 617   target to use whatever tricks it wants to produce fast code for the target,
 618   without having to conform to an externally specified ABI (Application Binary
 619   Interface).  Implementations of this convention should allow arbitrary
 620   <a href="CodeGenerator.html#tailcallopt">tail call optimization</a> to be
 621   supported.  This calling convention does not support varargs and requires the
 622   prototype of all callees to exactly match the prototype of the function
 623   definition.
 624   </dd>
 625
 626   <dt><b>"<tt>coldcc</tt>" - The cold calling convention</b>:</dt>
 627
 628   <dd>This calling convention attempts to make code in the caller as efficient
 629   as possible under the assumption that the call is not commonly executed.  As
 630   such, these calls often preserve all registers so that the call does not break
 631   any live ranges in the caller side.  This calling convention does not support
 632   varargs and requires the prototype of all callees to exactly match the
 633   prototype of the function definition.
 634   </dd>
 635
 636   <dt><b>"<tt>cc &lt;<em>n</em>&gt;</tt>" - Numbered convention</b>:</dt>
 637
 638   <dd>Any calling convention may be specified by number, allowing
 639   target-specific calling conventions to be used.  Target specific calling
 640   conventions start at 64.
 641   </dd>
 642 </dl>
 643
 644 <p>More calling conventions can be added/defined on an as-needed basis, to
 645 support pascal conventions or any other well-known target-independent
 646 convention.</p>
 647
 648 </div>
 649
 650 <!-- ======================================================================= -->
 651 <div class="doc_subsection">
 652   <a name="visibility">Visibility Styles</a>
 653 </div>
 654
 655 <div class="doc_text">
 656
 657 <p>
 658 All Global Variables and Functions have one of the following visibility styles:
 659 </p>
 660
 661 <dl>
 662   <dt><b>"<tt>default</tt>" - Default style</b>:</dt>
 663
 664   <dd>On targets that use the ELF object file format, default visibility means
 665     that the declaration is visible to other
 666     modules and, in shared libraries, means that the declared entity may be
 667     overridden. On Darwin, default visibility means that the declaration is
 668     visible to other modules. Default visibility corresponds to "external
 669     linkage" in the language.
 670   </dd>
 671
 672   <dt><b>"<tt>hidden</tt>" - Hidden style</b>:</dt>
 673
 674   <dd>Two declarations of an object with hidden visibility refer to the same
 675     object if they are in the same shared object. Usually, hidden visibility
 676     indicates that the symbol will not be placed into the dynamic symbol table,
 677     so no other module (executable or shared library) can reference it
 678     directly.
 679   </dd>
 680
 681   <dt><b>"<tt>protected</tt>" - Protected style</b>:</dt>
 682
 683   <dd>On ELF, protected visibility indicates that the symbol will be placed in
 684   the dynamic symbol table, but that references within the defining module will
 685   bind to the local symbol. That is, the symbol cannot be overridden by another
 686   module.
 687   </dd>
 688 </dl>
 689
 690 </div>
 691
 692 <!-- ======================================================================= -->
 693 <div class="doc_subsection">
 694   <a name="namedtypes">Named Types</a>
 695 </div>
 696
 697 <div class="doc_text">
 698
 699 <p>LLVM IR allows you to specify name aliases for certain types.  This can make
 700 it easier to read the IR and make the IR more condensed (particularly when
 701 recursive types are involved).  An example of a name specification is:
 702 </p>
 703
 704 <div class="doc_code">
 705 <pre>
 706 %mytype = type { %mytype*, i32 }
 707 </pre>
 708 </div>
 709
 710 <p>You may give a name to any <a href="#typesystem">type</a> except "<a
 711 href="t_void">void</a>".  Type name aliases may be used anywhere a type is
 712 expected with the syntax "%mytype".</p>
 713
 714 <p>Note that type names are aliases for the structural type that they indicate,
 715 and that you can therefore specify multiple names for the same type.  This often
 716 leads to confusing behavior when dumping out a .ll file.  Since LLVM IR uses
 717 structural typing, the name is not part of the type.  When printing out LLVM IR,
 718 the printer will pick <em>one name</em> to render all types of a particular
 719 shape.  This means that if you have code where two different source types end up
 720 having the same LLVM type, that the dumper will sometimes print the "wrong" or
 721 unexpected type.  This is an important design point and isn't going to
 722 change.</p>
 723
 724 </div>
 725
 726 <!-- ======================================================================= -->
 727 <div class="doc_subsection">
 728   <a name="globalvars">Global Variables</a>
 729 </div>
 730
 731 <div class="doc_text">
 732
 733 <p>Global variables define regions of memory allocated at compilation time
 734 instead of run-time.  Global variables may optionally be initialized, may have
 735 an explicit section to be placed in, and may have an optional explicit alignment
 736 specified.  A variable may be defined as "thread_local", which means that it
 737 will not be shared by threads (each thread will have a separated copy of the
 738 variable).  A variable may be defined as a global "constant," which indicates
 739 that the contents of the variable will <b>never</b> be modified (enabling better
 740 optimization, allowing the global data to be placed in the read-only section of
 741 an executable, etc).  Note that variables that need runtime initialization
 742 cannot be marked "constant" as there is a store to the variable.</p>
 743
 744 <p>
 745 LLVM explicitly allows <em>declarations</em> of global variables to be marked
 746 constant, even if the final definition of the global is not.  This capability
 747 can be used to enable slightly better optimization of the program, but requires
 748 the language definition to guarantee that optimizations based on the
 749 'constantness' are valid for the translation units that do not include the
 750 definition.
 751 </p>
 752
 753 <p>As SSA values, global variables define pointer values that are in
 754 scope (i.e. they dominate) all basic blocks in the program.  Global
 755 variables always define a pointer to their "content" type because they
 756 describe a region of memory, and all memory objects in LLVM are
 757 accessed through pointers.</p>
 758
 759 <p>A global variable may be declared to reside in a target-specifc numbered
 760 address space. For targets that support them, address spaces may affect how
 761 optimizations are performed and/or what target instructions are used to access
 762 the variable. The default address space is zero. The address space qualifier
 763 must precede any other attributes.</p>
 764
 765 <p>LLVM allows an explicit section to be specified for globals.  If the target
 766 supports it, it will emit globals to the section specified.</p>
 767
 768 <p>An explicit alignment may be specified for a global.  If not present, or if
 769 the alignment is set to zero, the alignment of the global is set by the target
 770 to whatever it feels convenient.  If an explicit alignment is specified, the
 771 global is forced to have at least that much alignment.  All alignments must be
 772 a power of 2.</p>
 773
 774 <p>For example, the following defines a global in a numbered address space with
 775 an initializer, section, and alignment:</p>
 776
 777 <div class="doc_code">
 778 <pre>
 779 @G = addrspace(5) constant float 1.0, section "foo", align 4
 780 </pre>
 781 </div>
 782
 783 </div>
 784
 785
 786 <!-- ======================================================================= -->
 787 <div class="doc_subsection">
 788   <a name="functionstructure">Functions</a>
 789 </div>
 790
 791 <div class="doc_text">
 792
 793 <p>LLVM function definitions consist of the "<tt>define</tt>" keyord,
 794 an optional <a href="#linkage">linkage type</a>, an optional
 795 <a href="#visibility">visibility style</a>, an optional
 796 <a href="#callingconv">calling convention</a>, a return type, an optional
 797 <a href="#paramattrs">parameter attribute</a> for the return type, a function
 798 name, a (possibly empty) argument list (each with optional
 799 <a href="#paramattrs">parameter attributes</a>), optional
 800 <a href="#fnattrs">function attributes</a>, an optional section,
 801 an optional alignment, an optional <a href="#gc">garbage collector name</a>,
 802 an opening curly brace, a list of basic blocks, and a closing curly brace.
 803
 804 LLVM function declarations consist of the "<tt>declare</tt>" keyword, an
 805 optional <a href="#linkage">linkage type</a>, an optional
 806 <a href="#visibility">visibility style</a>, an optional
 807 <a href="#callingconv">calling convention</a>, a return type, an optional
 808 <a href="#paramattrs">parameter attribute</a> for the return type, a function
 809 name, a possibly empty list of arguments, an optional alignment, and an optional
 810 <a href="#gc">garbage collector name</a>.</p>
 811
 812 <p>A function definition contains a list of basic blocks, forming the CFG
 813 (Control Flow Graph) for
 814 the function.  Each basic block may optionally start with a label (giving the
 815 basic block a symbol table entry), contains a list of instructions, and ends
 816 with a <a href="#terminators">terminator</a> instruction (such as a branch or
 817 function return).</p>
 818
 819 <p>The first basic block in a function is special in two ways: it is immediately
 820 executed on entrance to the function, and it is not allowed to have predecessor
 821 basic blocks (i.e. there can not be any branches to the entry block of a
 822 function).  Because the block can have no predecessors, it also cannot have any
 823 <a href="#i_phi">PHI nodes</a>.</p>
 824
 825 <p>LLVM allows an explicit section to be specified for functions.  If the target
 826 supports it, it will emit functions to the section specified.</p>
 827
 828 <p>An explicit alignment may be specified for a function.  If not present, or if
 829 the alignment is set to zero, the alignment of the function is set by the target
 830 to whatever it feels convenient.  If an explicit alignment is specified, the
 831 function is forced to have at least that much alignment.  All alignments must be
 832 a power of 2.</p>
 833
 834   <h5>Syntax:</h5>
 835
 836 <div class="doc_code">
 837 <tt>
 838 define [<a href="#linkage">linkage</a>] [<a href="#visibility">visibility</a>]
 839       [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>]
 840       &lt;ResultType&gt; @&lt;FunctionName&gt; ([argument list])
 841       [<a href="#fnattrs">fn Attrs</a>] [section "name"] [align N]
 842       [<a href="#gc">gc</a>] { ... }
 843 </tt>
 844 </div>
 845
 846 </div>
 847
 848
 849 <!-- ======================================================================= -->
 850 <div class="doc_subsection">
 851   <a name="aliasstructure">Aliases</a>
 852 </div>
 853 <div class="doc_text">
 854   <p>Aliases act as "second name" for the aliasee value (which can be either
 855   function, global variable, another alias or bitcast of global value). Aliases
 856   may have an optional <a href="#linkage">linkage type</a>, and an
 857   optional <a href="#visibility">visibility style</a>.</p>
 858
 859   <h5>Syntax:</h5>
 860
 861 <div class="doc_code">
 862 <pre>
 863 @&lt;Name&gt; = alias [Linkage] [Visibility] &lt;AliaseeTy&gt; @&lt;Aliasee&gt;
 864 </pre>
 865 </div>
 866
 867 </div>
 868
 869
 870
 871 <!-- ======================================================================= -->
 872 <div class="doc_subsection"><a name="paramattrs">Parameter Attributes</a></div>
 873 <div class="doc_text">
 874   <p>The return type and each parameter of a function type may have a set of
 875   <i>parameter attributes</i> associated with them. Parameter attributes are
 876   used to communicate additional information about the result or parameters of
 877   a function. Parameter attributes are considered to be part of the function,
 878   not of the function type, so functions with different parameter attributes
 879   can have the same function type.</p>
 880
 881   <p>Parameter attributes are simple keywords that follow the type specified. If
 882   multiple parameter attributes are needed, they are space separated. For
 883   example:</p>
 884
 885 <div class="doc_code">
 886 <pre>
 887 declare i32 @printf(i8* noalias , ...)
 888 declare i32 @atoi(i8 zeroext)
 889 declare signext i8 @returns_signed_char()
 890 </pre>
 891 </div>
 892
 893   <p>Note that any attributes for the function result (<tt>nounwind</tt>,
 894   <tt>readonly</tt>) come immediately after the argument list.</p>
 895
 896   <p>Currently, only the following parameter attributes are defined:</p>
 897   <dl>
 898     <dt><tt>zeroext</tt></dt>
 899     <dd>This indicates to the code generator that the parameter or return value
 900     should be zero-extended to a 32-bit value by the caller (for a parameter)
 901     or the callee (for a return value).</dd>
 902
 903     <dt><tt>signext</tt></dt>
 904     <dd>This indicates to the code generator that the parameter or return value
 905     should be sign-extended to a 32-bit value by the caller (for a parameter)
 906     or the callee (for a return value).</dd>
 907
 908     <dt><tt>inreg</tt></dt>
 909     <dd>This indicates that this parameter or return value should be treated
 910     in a special target-dependent fashion during while emitting code for a
 911     function call or return (usually, by putting it in a register as opposed
 912     to memory, though some targets use it to distinguish between two different
 913     kinds of registers).  Use of this attribute is target-specific.</dd>
 914
 915     <dt><tt><a name="byval">byval</a></tt></dt>
 916     <dd>This indicates that the pointer parameter should really be passed by
 917     value to the function.  The attribute implies that a hidden copy of the
 918     pointee is made between the caller and the callee, so the callee is unable
 919     to modify the value in the callee.  This attribute is only valid on LLVM
 920     pointer arguments.  It is generally used to pass structs and arrays by
 921     value, but is also valid on pointers to scalars.  The copy is considered to
 922     belong to the caller not the callee (for example,
 923     <tt><a href="#readonly">readonly</a></tt> functions should not write to
 924     <tt>byval</tt> parameters). This is not a valid attribute for return
 925     values. </dd>
 926
 927     <dt><tt>sret</tt></dt>
 928     <dd>This indicates that the pointer parameter specifies the address of a
 929     structure that is the return value of the function in the source program.
 930     This pointer must be guaranteed by the caller to be valid: loads and stores
 931     to the structure may be assumed by the callee to not to trap.  This may only
 932     be applied to the first parameter. This is not a valid attribute for
 933     return values. </dd>
 934
 935     <dt><tt>noalias</tt></dt>
 936     <dd>This indicates that the pointer does not alias any global or any other
 937     parameter.  The caller is responsible for ensuring that this is the
 938     case. On a function return value, <tt>noalias</tt> additionally indicates
 939     that the pointer does not alias any other pointers visible to the
 940     caller. For further details, please see the discussion of the NoAlias
 941     response in
 942     <a href="http://llvm.org/docs/AliasAnalysis.html#MustMayNo">alias
 943     analysis</a>.</dd>
 944
 945     <dt><tt>nocapture</tt></dt>
 946     <dd>This indicates that the callee does not make any copies of the pointer
 947     that outlive the callee itself. This is not a valid attribute for return
 948     values.</dd>
 949
 950     <dt><tt>nest</tt></dt>
 951     <dd>This indicates that the pointer parameter can be excised using the
 952     <a href="#int_trampoline">trampoline intrinsics</a>. This is not a valid
 953     attribute for return values.</dd>
 954   </dl>
 955
 956 </div>
 957
 958 <!-- ======================================================================= -->
 959 <div class="doc_subsection">
 960   <a name="gc">Garbage Collector Names</a>
 961 </div>
 962
 963 <div class="doc_text">
 964 <p>Each function may specify a garbage collector name, which is simply a
 965 string.</p>
 966
 967 <div class="doc_code"><pre
 968 >define void @f() gc "name" { ...</pre></div>
 969
 970 <p>The compiler declares the supported values of <i>name</i>. Specifying a
 971 collector which will cause the compiler to alter its output in order to support
 972 the named garbage collection algorithm.</p>
 973 </div>
 974
 975 <!-- ======================================================================= -->
 976 <div class="doc_subsection">
 977   <a name="fnattrs">Function Attributes</a>
 978 </div>
 979
 980 <div class="doc_text">
 981
 982 <p>Function attributes are set to communicate additional information about
 983   a function. Function attributes are considered to be part of the function,
 984   not of the function type, so functions with different parameter attributes
 985   can have the same function type.</p>
 986
 987   <p>Function attributes are simple keywords that follow the type specified. If
 988   multiple attributes are needed, they are space separated. For
 989   example:</p>
 990
 991 <div class="doc_code">
 992 <pre>
 993 define void @f() noinline { ... }
 994 define void @f() alwaysinline { ... }
 995 define void @f() alwaysinline optsize { ... }
 996 define void @f() optsize
 997 </pre>
 998 </div>
 999
1000 <dl>
1001 <dt><tt>alwaysinline</tt></dt>
1002 <dd>This attribute indicates that the inliner should attempt to inline this
1003 function into callers whenever possible, ignoring any active inlining size
1004 threshold for this caller.</dd>
1005
1006 <dt><tt>noinline</tt></dt>
1007 <dd>This attribute indicates that the inliner should never inline this function
1008 in any situation. This attribute may not be used together with the
1009 <tt>alwaysinline</tt> attribute.</dd>
1010
1011 <dt><tt>optsize</tt></dt>
1012 <dd>This attribute suggests that optimization passes and code generator passes
1013 make choices that keep the code size of this function low, and otherwise do
1014 optimizations specifically to reduce code size.</dd>
1015
1016 <dt><tt>noreturn</tt></dt>
1017 <dd>This function attribute indicates that the function never returns normally.
1018 This produces undefined behavior at runtime if the function ever does
1019 dynamically return.</dd>
1020
1021 <dt><tt>nounwind</tt></dt>
1022 <dd>This function attribute indicates that the function never returns with an
1023 unwind or exceptional control flow.  If the function does unwind, its runtime
1024 behavior is undefined.</dd>
1025
1026 <dt><tt>readnone</tt></dt>
1027 <dd>This attribute indicates that the function computes its result (or the
1028 exception it throws) based strictly on its arguments, without dereferencing any
1029 pointer arguments or otherwise accessing any mutable state (e.g. memory, control
1030 registers, etc) visible to caller functions.  It does not write through any
1031 pointer arguments (including <tt><a href="#byval">byval</a></tt> arguments) and
1032 never changes any state visible to callers.</dd>
1033
1034 <dt><tt><a name="readonly">readonly</a></tt></dt>
1035 <dd>This attribute indicates that the function does not write through any
1036 pointer arguments (including <tt><a href="#byval">byval</a></tt> arguments)
1037 or otherwise modify any state (e.g. memory, control registers, etc) visible to
1038 caller functions.  It may dereference pointer arguments and read state that may
1039 be set in the caller.  A readonly function always returns the same value (or
1040 throws the same exception) when called with the same set of arguments and global
1041 state.</dd>
1042
1043 <dt><tt><a name="ssp">ssp</a></tt></dt>
1044 <dd>This attribute indicates that the function should emit a stack smashing
1045 protector. It is in the form of a "canary"&mdash;a random value placed on the
1046 stack before the local variables that's checked upon return from the function to
1047 see if it has been overwritten. A heuristic is used to determine if a function
1048 needs stack protectors or not.
1049
1050 <p>If a function that has an <tt>ssp</tt> attribute is inlined into a function
1051 that doesn't have an <tt>ssp</tt> attribute, then the resulting function will
1052 have an <tt>ssp</tt> attribute.</p></dd>
1053
1054 <dt><tt>sspreq</tt></dt>
1055 <dd>This attribute indicates that the function should <em>always</em> emit a
1056 stack smashing protector. This overrides the <tt><a href="#ssp">ssp</a></tt>
1057 function attribute.
1058
1059 <p>If a function that has an <tt>sspreq</tt> attribute is inlined into a
1060 function that doesn't have an <tt>sspreq</tt> attribute or which has
1061 an <tt>ssp</tt> attribute, then the resulting function will have
1062 an <tt>sspreq</tt> attribute.</p></dd>
1063 </dl>
1064
1065 </div>
1066
1067 <!-- ======================================================================= -->
1068 <div class="doc_subsection">
1069   <a name="moduleasm">Module-Level Inline Assembly</a>
1070 </div>
1071
1072 <div class="doc_text">
1073 <p>
1074 Modules may contain "module-level inline asm" blocks, which corresponds to the
1075 GCC "file scope inline asm" blocks.  These blocks are internally concatenated by
1076 LLVM and treated as a single unit, but may be separated in the .ll file if
1077 desired.  The syntax is very simple:
1078 </p>
1079
1080 <div class="doc_code">
1081 <pre>
1082 module asm "inline asm code goes here"
1083 module asm "more can go here"
1084 </pre>
1085 </div>
1086
1087 <p>The strings can contain any character by escaping non-printable characters.
1088    The escape sequence used is simply "\xx" where "xx" is the two digit hex code
1089    for the number.
1090 </p>
1091
1092 <p>
1093   The inline asm code is simply printed to the machine code .s file when
1094   assembly code is generated.
1095 </p>
1096 </div>
1097
1098 <!-- ======================================================================= -->
1099 <div class="doc_subsection">
1100   <a name="datalayout">Data Layout</a>
1101 </div>
1102
1103 <div class="doc_text">
1104 <p>A module may specify a target specific data layout string that specifies how
1105 data is to be laid out in memory. The syntax for the data layout is simply:</p>
1106 <pre>    target datalayout = "<i>layout specification</i>"</pre>
1107 <p>The <i>layout specification</i> consists of a list of specifications
1108 separated by the minus sign character ('-').  Each specification starts with a
1109 letter and may include other information after the letter to define some
1110 aspect of the data layout.  The specifications accepted are as follows: </p>
1111 <dl>
1112   <dt><tt>E</tt></dt>
1113   <dd>Specifies that the target lays out data in big-endian form. That is, the
1114   bits with the most significance have the lowest address location.</dd>
1115   <dt><tt>e</tt></dt>
1116   <dd>Specifies that the target lays out data in little-endian form. That is,
1117   the bits with the least significance have the lowest address location.</dd>
1118   <dt><tt>p:<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1119   <dd>This specifies the <i>size</i> of a pointer and its <i>abi</i> and
1120   <i>preferred</i> alignments. All sizes are in bits. Specifying the <i>pref</i>
1121   alignment is optional. If omitted, the preceding <tt>:</tt> should be omitted
1122   too.</dd>
1123   <dt><tt>i<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1124   <dd>This specifies the alignment for an integer type of a given bit
1125   <i>size</i>. The value of <i>size</i> must be in the range [1,2^23).</dd>
1126   <dt><tt>v<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1127   <dd>This specifies the alignment for a vector type of a given bit
1128   <i>size</i>.</dd>
1129   <dt><tt>f<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1130   <dd>This specifies the alignment for a floating point type of a given bit
1131   <i>size</i>. The value of <i>size</i> must be either 32 (float) or 64
1132   (double).</dd>
1133   <dt><tt>a<i>size</i>:<i>abi</i>:<i>pref</i></tt></dt>
1134   <dd>This specifies the alignment for an aggregate type of a given bit
1135   <i>size</i>.</dd>
1136 </dl>
1137 <p>When constructing the data layout for a given target, LLVM starts with a
1138 default set of specifications which are then (possibly) overriden by the
1139 specifications in the <tt>datalayout</tt> keyword. The default specifications
1140 are given in this list:</p>
1141 <ul>
1142   <li><tt>E</tt> - big endian</li>
1143   <li><tt>p:32:64:64</tt> - 32-bit pointers with 64-bit alignment</li>
1144   <li><tt>i1:8:8</tt> - i1 is 8-bit (byte) aligned</li>
1145   <li><tt>i8:8:8</tt> - i8 is 8-bit (byte) aligned</li>
1146   <li><tt>i16:16:16</tt> - i16 is 16-bit aligned</li>
1147   <li><tt>i32:32:32</tt> - i32 is 32-bit aligned</li>
1148   <li><tt>i64:32:64</tt> - i64 has ABI alignment of 32-bits but preferred
1149   alignment of 64-bits</li>
1150   <li><tt>f32:32:32</tt> - float is 32-bit aligned</li>
1151   <li><tt>f64:64:64</tt> - double is 64-bit aligned</li>
1152   <li><tt>v64:64:64</tt> - 64-bit vector is 64-bit aligned</li>
1153   <li><tt>v128:128:128</tt> - 128-bit vector is 128-bit aligned</li>
1154   <li><tt>a0:0:1</tt> - aggregates are 8-bit aligned</li>
1155 </ul>
1156 <p>When LLVM is determining the alignment for a given type, it uses the
1157 following rules:</p>
1158 <ol>
1159   <li>If the type sought is an exact match for one of the specifications, that
1160   specification is used.</li>
1161   <li>If no match is found, and the type sought is an integer type, then the
1162   smallest integer type that is larger than the bitwidth of the sought type is
1163   used. If none of the specifications are larger than the bitwidth then the the
1164   largest integer type is used. For example, given the default specifications
1165   above, the i7 type will use the alignment of i8 (next largest) while both
1166   i65 and i256 will use the alignment of i64 (largest specified).</li>
1167   <li>If no match is found, and the type sought is a vector type, then the
1168   largest vector type that is smaller than the sought vector type will be used
1169   as a fall back.  This happens because &lt;128 x double&gt; can be implemented
1170   in terms of 64 &lt;2 x double&gt;, for example.</li>
1171 </ol>
1172 </div>
1173
1174 <!-- *********************************************************************** -->
1175 <div class="doc_section"> <a name="typesystem">Type System</a> </div>
1176 <!-- *********************************************************************** -->
1177
1178 <div class="doc_text">
1179
1180 <p>The LLVM type system is one of the most important features of the
1181 intermediate representation.  Being typed enables a number of
1182 optimizations to be performed on the intermediate representation directly,
1183 without having to do
1184 extra analyses on the side before the transformation.  A strong type
1185 system makes it easier to read the generated code and enables novel
1186 analyses and transformations that are not feasible to perform on normal
1187 three address code representations.</p>
1188
1189 </div>
1190
1191 <!-- ======================================================================= -->
1192 <div class="doc_subsection"> <a name="t_classifications">Type
1193 Classifications</a> </div>
1194 <div class="doc_text">
1195 <p>The types fall into a few useful
1196 classifications:</p>
1197
1198 <table border="1" cellspacing="0" cellpadding="4">
1199   <tbody>
1200     <tr><th>Classification</th><th>Types</th></tr>
1201     <tr>
1202       <td><a href="#t_integer">integer</a></td>
1203       <td><tt>i1, i2, i3, ... i8, ... i16, ... i32, ... i64, ... </tt></td>
1204     </tr>
1205     <tr>
1206       <td><a href="#t_floating">floating point</a></td>
1207       <td><tt>float, double, x86_fp80, fp128, ppc_fp128</tt></td>
1208     </tr>
1209     <tr>
1210       <td><a name="t_firstclass">first class</a></td>
1211       <td><a href="#t_integer">integer</a>,
1212           <a href="#t_floating">floating point</a>,
1213           <a href="#t_pointer">pointer</a>,
1214           <a href="#t_vector">vector</a>,
1215           <a href="#t_struct">structure</a>,
1216           <a href="#t_array">array</a>,
1217           <a href="#t_label">label</a>.
1218       </td>
1219     </tr>
1220     <tr>
1221       <td><a href="#t_primitive">primitive</a></td>
1222       <td><a href="#t_label">label</a>,
1223           <a href="#t_void">void</a>,
1224           <a href="#t_floating">floating point</a>.</td>
1225     </tr>
1226     <tr>
1227       <td><a href="#t_derived">derived</a></td>
1228       <td><a href="#t_integer">integer</a>,
1229           <a href="#t_array">array</a>,
1230           <a href="#t_function">function</a>,
1231           <a href="#t_pointer">pointer</a>,
1232           <a href="#t_struct">structure</a>,
1233           <a href="#t_pstruct">packed structure</a>,
1234           <a href="#t_vector">vector</a>,
1235           <a href="#t_opaque">opaque</a>.
1236       </td>
1237     </tr>
1238   </tbody>
1239 </table>
1240
1241 <p>The <a href="#t_firstclass">first class</a> types are perhaps the
1242 most important.  Values of these types are the only ones which can be
1243 produced by instructions, passed as arguments, or used as operands to
1244 instructions.</p>
1245 </div>
1246
1247 <!-- ======================================================================= -->
1248 <div class="doc_subsection"> <a name="t_primitive">Primitive Types</a> </div>
1249
1250 <div class="doc_text">
1251 <p>The primitive types are the fundamental building blocks of the LLVM
1252 system.</p>
1253
1254 </div>
1255
1256 <!-- _______________________________________________________________________ -->
1257 <div class="doc_subsubsection"> <a name="t_floating">Floating Point Types</a> </div>
1258
1259 <div class="doc_text">
1260       <table>
1261         <tbody>
1262           <tr><th>Type</th><th>Description</th></tr>
1263           <tr><td><tt>float</tt></td><td>32-bit floating point value</td></tr>
1264           <tr><td><tt>double</tt></td><td>64-bit floating point value</td></tr>
1265           <tr><td><tt>fp128</tt></td><td>128-bit floating point value (112-bit mantissa)</td></tr>
1266           <tr><td><tt>x86_fp80</tt></td><td>80-bit floating point value (X87)</td></tr>
1267           <tr><td><tt>ppc_fp128</tt></td><td>128-bit floating point value (two 64-bits)</td></tr>
1268         </tbody>
1269       </table>
1270 </div>
1271
1272 <!-- _______________________________________________________________________ -->
1273 <div class="doc_subsubsection"> <a name="t_void">Void Type</a> </div>
1274
1275 <div class="doc_text">
1276 <h5>Overview:</h5>
1277 <p>The void type does not represent any value and has no size.</p>
1278
1279 <h5>Syntax:</h5>
1280
1281 <pre>
1282   void
1283 </pre>
1284 </div>
1285
1286 <!-- _______________________________________________________________________ -->
1287 <div class="doc_subsubsection"> <a name="t_label">Label Type</a> </div>
1288
1289 <div class="doc_text">
1290 <h5>Overview:</h5>
1291 <p>The label type represents code labels.</p>
1292
1293 <h5>Syntax:</h5>
1294
1295 <pre>
1296   label
1297 </pre>
1298 </div>
1299
1300
1301 <!-- ======================================================================= -->
1302 <div class="doc_subsection"> <a name="t_derived">Derived Types</a> </div>
1303
1304 <div class="doc_text">
1305
1306 <p>The real power in LLVM comes from the derived types in the system.
1307 This is what allows a programmer to represent arrays, functions,
1308 pointers, and other useful types.  Note that these derived types may be
1309 recursive: For example, it is possible to have a two dimensional array.</p>
1310
1311 </div>
1312
1313 <!-- _______________________________________________________________________ -->
1314 <div class="doc_subsubsection"> <a name="t_integer">Integer Type</a> </div>
1315
1316 <div class="doc_text">
1317
1318 <h5>Overview:</h5>
1319 <p>The integer type is a very simple derived type that simply specifies an
1320 arbitrary bit width for the integer type desired. Any bit width from 1 bit to
1321 2^23-1 (about 8 million) can be specified.</p>
1322
1323 <h5>Syntax:</h5>
1324
1325 <pre>
1326   iN
1327 </pre>
1328
1329 <p>The number of bits the integer will occupy is specified by the <tt>N</tt>
1330 value.</p>
1331
1332 <h5>Examples:</h5>
1333 <table class="layout">
1334   <tbody>
1335   <tr>
1336     <td><tt>i1</tt></td>
1337     <td>a single-bit integer.</td>
1338   </tr><tr>
1339     <td><tt>i32</tt></td>
1340     <td>a 32-bit integer.</td>
1341   </tr><tr>
1342     <td><tt>i1942652</tt></td>
1343     <td>a really big integer of over 1 million bits.</td>
1344   </tr>
1345   </tbody>
1346 </table>
1347
1348 <p>Note that the code generator does not yet support large integer types
1349 to be used as function return types. The specific limit on how large a
1350 return type the code generator can currently handle is target-dependent;
1351 currently it's often 64 bits for 32-bit targets and 128 bits for 64-bit
1352 targets.</p>
1353
1354 </div>
1355
1356 <!-- _______________________________________________________________________ -->
1357 <div class="doc_subsubsection"> <a name="t_array">Array Type</a> </div>
1358
1359 <div class="doc_text">
1360
1361 <h5>Overview:</h5>
1362
1363 <p>The array type is a very simple derived type that arranges elements
1364 sequentially in memory.  The array type requires a size (number of
1365 elements) and an underlying data type.</p>
1366
1367 <h5>Syntax:</h5>
1368
1369 <pre>
1370   [&lt;# elements&gt; x &lt;elementtype&gt;]
1371 </pre>
1372
1373 <p>The number of elements is a constant integer value; elementtype may
1374 be any type with a size.</p>
1375
1376 <h5>Examples:</h5>
1377 <table class="layout">
1378   <tr class="layout">
1379     <td class="left"><tt>[40 x i32]</tt></td>
1380     <td class="left">Array of 40 32-bit integer values.</td>
1381   </tr>
1382   <tr class="layout">
1383     <td class="left"><tt>[41 x i32]</tt></td>
1384     <td class="left">Array of 41 32-bit integer values.</td>
1385   </tr>
1386   <tr class="layout">
1387     <td class="left"><tt>[4 x i8]</tt></td>
1388     <td class="left">Array of 4 8-bit integer values.</td>
1389   </tr>
1390 </table>
1391 <p>Here are some examples of multidimensional arrays:</p>
1392 <table class="layout">
1393   <tr class="layout">
1394     <td class="left"><tt>[3 x [4 x i32]]</tt></td>
1395     <td class="left">3x4 array of 32-bit integer values.</td>
1396   </tr>
1397   <tr class="layout">
1398     <td class="left"><tt>[12 x [10 x float]]</tt></td>
1399     <td class="left">12x10 array of single precision floating point values.</td>
1400   </tr>
1401   <tr class="layout">
1402     <td class="left"><tt>[2 x [3 x [4 x i16]]]</tt></td>
1403     <td class="left">2x3x4 array of 16-bit integer  values.</td>
1404   </tr>
1405 </table>
1406
1407 <p>Note that 'variable sized arrays' can be implemented in LLVM with a zero
1408 length array.  Normally, accesses past the end of an array are undefined in
1409 LLVM (e.g. it is illegal to access the 5th element of a 3 element array).
1410 As a special case, however, zero length arrays are recognized to be variable
1411 length.  This allows implementation of 'pascal style arrays' with the  LLVM
1412 type "{ i32, [0 x float]}", for example.</p>
1413
1414 <p>Note that the code generator does not yet support large aggregate types
1415 to be used as function return types. The specific limit on how large an
1416 aggregate return type the code generator can currently handle is
1417 target-dependent, and also dependent on the aggregate element types.</p>
1418
1419 </div>
1420
1421 <!-- _______________________________________________________________________ -->
1422 <div class="doc_subsubsection"> <a name="t_function">Function Type</a> </div>
1423 <div class="doc_text">
1424
1425 <h5>Overview:</h5>
1426
1427 <p>The function type can be thought of as a function signature.  It
1428 consists of a return type and a list of formal parameter types. The
1429 return type of a function type is a scalar type, a void type, or a struct type.
1430 If the return type is a struct type then all struct elements must be of first
1431 class types, and the struct must have at least one element.</p>
1432
1433 <h5>Syntax:</h5>
1434
1435 <pre>
1436   &lt;returntype list&gt; (&lt;parameter list&gt;)
1437 </pre>
1438
1439 <p>...where '<tt>&lt;parameter list&gt;</tt>' is a comma-separated list of type
1440 specifiers.  Optionally, the parameter list may include a type <tt>...</tt>,
1441 which indicates that the function takes a variable number of arguments.
1442 Variable argument functions can access their arguments with the <a
1443  href="#int_varargs">variable argument handling intrinsic</a> functions.
1444 '<tt>&lt;returntype list&gt;</tt>' is a comma-separated list of
1445 <a href="#t_firstclass">first class</a> type specifiers.</p>
1446
1447 <h5>Examples:</h5>
1448 <table class="layout">
1449   <tr class="layout">
1450     <td class="left"><tt>i32 (i32)</tt></td>
1451     <td class="left">function taking an <tt>i32</tt>, returning an <tt>i32</tt>
1452     </td>
1453   </tr><tr class="layout">
1454     <td class="left"><tt>float&nbsp;(i16&nbsp;signext,&nbsp;i32&nbsp;*)&nbsp;*
1455     </tt></td>
1456     <td class="left"><a href="#t_pointer">Pointer</a> to a function that takes
1457       an <tt>i16</tt> that should be sign extended and a
1458       <a href="#t_pointer">pointer</a> to <tt>i32</tt>, returning
1459       <tt>float</tt>.
1460     </td>
1461   </tr><tr class="layout">
1462     <td class="left"><tt>i32 (i8*, ...)</tt></td>
1463     <td class="left">A vararg function that takes at least one
1464       <a href="#t_pointer">pointer</a> to <tt>i8 </tt> (char in C),
1465       which returns an integer.  This is the signature for <tt>printf</tt> in
1466       LLVM.
1467     </td>
1468   </tr><tr class="layout">
1469     <td class="left"><tt>{i32, i32} (i32)</tt></td>
1470     <td class="left">A function taking an <tt>i32</tt>, returning two
1471         <tt>i32</tt> values as an aggregate of type <tt>{ i32, i32 }</tt>
1472     </td>
1473   </tr>
1474 </table>
1475
1476 </div>
1477 <!-- _______________________________________________________________________ -->
1478 <div class="doc_subsubsection"> <a name="t_struct">Structure Type</a> </div>
1479 <div class="doc_text">
1480 <h5>Overview:</h5>
1481 <p>The structure type is used to represent a collection of data members
1482 together in memory.  The packing of the field types is defined to match
1483 the ABI of the underlying processor.  The elements of a structure may
1484 be any type that has a size.</p>
1485 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
1486 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
1487 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
1488 instruction.</p>
1489 <h5>Syntax:</h5>
1490 <pre>  { &lt;type list&gt; }<br></pre>
1491 <h5>Examples:</h5>
1492 <table class="layout">
1493   <tr class="layout">
1494     <td class="left"><tt>{ i32, i32, i32 }</tt></td>
1495     <td class="left">A triple of three <tt>i32</tt> values</td>
1496   </tr><tr class="layout">
1497     <td class="left"><tt>{&nbsp;float,&nbsp;i32&nbsp;(i32)&nbsp;*&nbsp;}</tt></td>
1498     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1499       second element is a <a href="#t_pointer">pointer</a> to a
1500       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1501       an <tt>i32</tt>.</td>
1502   </tr>
1503 </table>
1504
1505 <p>Note that the code generator does not yet support large aggregate types
1506 to be used as function return types. The specific limit on how large an
1507 aggregate return type the code generator can currently handle is
1508 target-dependent, and also dependent on the aggregate element types.</p>
1509
1510 </div>
1511
1512 <!-- _______________________________________________________________________ -->
1513 <div class="doc_subsubsection"> <a name="t_pstruct">Packed Structure Type</a>
1514 </div>
1515 <div class="doc_text">
1516 <h5>Overview:</h5>
1517 <p>The packed structure type is used to represent a collection of data members
1518 together in memory.  There is no padding between fields.  Further, the alignment
1519 of a packed structure is 1 byte.  The elements of a packed structure may
1520 be any type that has a size.</p>
1521 <p>Structures are accessed using '<tt><a href="#i_load">load</a></tt>
1522 and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a
1523 field with the '<tt><a href="#i_getelementptr">getelementptr</a></tt>'
1524 instruction.</p>
1525 <h5>Syntax:</h5>
1526 <pre>  &lt; { &lt;type list&gt; } &gt; <br></pre>
1527 <h5>Examples:</h5>
1528 <table class="layout">
1529   <tr class="layout">
1530     <td class="left"><tt>&lt; { i32, i32, i32 } &gt;</tt></td>
1531     <td class="left">A triple of three <tt>i32</tt> values</td>
1532   </tr><tr class="layout">
1533   <td class="left">
1534 <tt>&lt;&nbsp;{&nbsp;float,&nbsp;i32&nbsp;(i32)*&nbsp;}&nbsp;&gt;</tt></td>
1535     <td class="left">A pair, where the first element is a <tt>float</tt> and the
1536       second element is a <a href="#t_pointer">pointer</a> to a
1537       <a href="#t_function">function</a> that takes an <tt>i32</tt>, returning
1538       an <tt>i32</tt>.</td>
1539   </tr>
1540 </table>
1541 </div>
1542
1543 <!-- _______________________________________________________________________ -->
1544 <div class="doc_subsubsection"> <a name="t_pointer">Pointer Type</a> </div>
1545 <div class="doc_text">
1546 <h5>Overview:</h5>
1547 <p>As in many languages, the pointer type represents a pointer or
1548 reference to another object, which must live in memory. Pointer types may have
1549 an optional address space attribute defining the target-specific numbered
1550 address space where the pointed-to object resides. The default address space is
1551 zero.</p>
1552 <h5>Syntax:</h5>
1553 <pre>  &lt;type&gt; *<br></pre>
1554 <h5>Examples:</h5>
1555 <table class="layout">
1556   <tr class="layout">
1557     <td class="left"><tt>[4 x i32]*</tt></td>
1558     <td class="left">A <a href="#t_pointer">pointer</a> to <a
1559                     href="#t_array">array</a> of four <tt>i32</tt> values.</td>
1560   </tr>
1561   <tr class="layout">
1562     <td class="left"><tt>i32 (i32 *) *</tt></td>
1563     <td class="left"> A <a href="#t_pointer">pointer</a> to a <a
1564       href="#t_function">function</a> that takes an <tt>i32*</tt>, returning an
1565       <tt>i32</tt>.</td>
1566   </tr>
1567   <tr class="layout">
1568     <td class="left"><tt>i32 addrspace(5)*</tt></td>
1569     <td class="left">A <a href="#t_pointer">pointer</a> to an <tt>i32</tt> value
1570      that resides in address space #5.</td>
1571   </tr>
1572 </table>
1573 </div>
1574
1575 <!-- _______________________________________________________________________ -->
1576 <div class="doc_subsubsection"> <a name="t_vector">Vector Type</a> </div>
1577 <div class="doc_text">
1578
1579 <h5>Overview:</h5>
1580
1581 <p>A vector type is a simple derived type that represents a vector
1582 of elements.  Vector types are used when multiple primitive data
1583 are operated in parallel using a single instruction (SIMD).
1584 A vector type requires a size (number of
1585 elements) and an underlying primitive data type.  Vectors must have a power
1586 of two length (1, 2, 4, 8, 16 ...).  Vector types are
1587 considered <a href="#t_firstclass">first class</a>.</p>
1588
1589 <h5>Syntax:</h5>
1590
1591 <pre>
1592   &lt; &lt;# elements&gt; x &lt;elementtype&gt; &gt;
1593 </pre>
1594
1595 <p>The number of elements is a constant integer value; elementtype may
1596 be any integer or floating point type.</p>
1597
1598 <h5>Examples:</h5>
1599
1600 <table class="layout">
1601   <tr class="layout">
1602     <td class="left"><tt>&lt;4 x i32&gt;</tt></td>
1603     <td class="left">Vector of 4 32-bit integer values.</td>
1604   </tr>
1605   <tr class="layout">
1606     <td class="left"><tt>&lt;8 x float&gt;</tt></td>
1607     <td class="left">Vector of 8 32-bit floating-point values.</td>
1608   </tr>
1609   <tr class="layout">
1610     <td class="left"><tt>&lt;2 x i64&gt;</tt></td>
1611     <td class="left">Vector of 2 64-bit integer values.</td>
1612   </tr>
1613 </table>
1614
1615 <p>Note that the code generator does not yet support large vector types
1616 to be used as function return types. The specific limit on how large a
1617 vector return type codegen can currently handle is target-dependent;
1618 currently it's often a few times longer than a hardware vector register.</p>
1619
1620 </div>
1621
1622 <!-- _______________________________________________________________________ -->
1623 <div class="doc_subsubsection"> <a name="t_opaque">Opaque Type</a> </div>
1624 <div class="doc_text">
1625
1626 <h5>Overview:</h5>
1627
1628 <p>Opaque types are used to represent unknown types in the system.  This
1629 corresponds (for example) to the C notion of a forward declared structure type.
1630 In LLVM, opaque types can eventually be resolved to any type (not just a
1631 structure type).</p>
1632
1633 <h5>Syntax:</h5>
1634
1635 <pre>
1636   opaque
1637 </pre>
1638
1639 <h5>Examples:</h5>
1640
1641 <table class="layout">
1642   <tr class="layout">
1643     <td class="left"><tt>opaque</tt></td>
1644     <td class="left">An opaque type.</td>
1645   </tr>
1646 </table>
1647 </div>
1648
1649 <!-- ======================================================================= -->
1650 <div class="doc_subsection">
1651   <a name="t_uprefs">Type Up-references</a>
1652 </div>
1653
1654 <div class="doc_text">
1655 <h5>Overview:</h5>
1656 <p>
1657 An "up reference" allows you to refer to a lexically enclosing type without
1658 requiring it to have a name. For instance, a structure declaration may contain a
1659 pointer to any of the types it is lexically a member of.  Example of up
1660 references (with their equivalent as named type declarations) include:</p>
1661
1662 <pre>
1663    { \2 * }                %x = type { %t* }
1664    { \2 }*                 %y = type { %y }*
1665    \1*                     %z = type %z*
1666 </pre>
1667
1668 <p>
1669 An up reference is needed by the asmprinter for printing out cyclic types when
1670 there is no declared name for a type in the cycle.  Because the asmprinter does
1671 not want to print out an infinite type string, it needs a syntax to handle
1672 recursive types that have no names (all names are optional in llvm IR).
1673 </p>
1674
1675 <h5>Syntax:</h5>
1676 <pre>
1677    \&lt;level&gt;
1678 </pre>
1679
1680 <p>
1681 The level is the count of the lexical type that is being referred to.
1682 </p>
1683
1684 <h5>Examples:</h5>
1685
1686 <table class="layout">
1687   <tr class="layout">
1688     <td class="left"><tt>\1*</tt></td>
1689     <td class="left">Self-referential pointer.</td>
1690   </tr>
1691   <tr class="layout">
1692     <td class="left"><tt>{ { \3*, i8 }, i32 }</tt></td>
1693     <td class="left">Recursive structure where the upref refers to the out-most
1694                      structure.</td>
1695   </tr>
1696 </table>
1697 </div>
1698
1699 </div>
1700
1701
1702 <!-- *********************************************************************** -->
1703 <div class="doc_section"> <a name="constants">Constants</a> </div>
1704 <!-- *********************************************************************** -->
1705
1706 <div class="doc_text">
1707
1708 <p>LLVM has several different basic types of constants.  This section describes
1709 them all and their syntax.</p>
1710
1711 </div>
1712
1713 <!-- ======================================================================= -->
1714 <div class="doc_subsection"><a name="simpleconstants">Simple Constants</a></div>
1715
1716 <div class="doc_text">
1717
1718 <dl>
1719   <dt><b>Boolean constants</b></dt>
1720
1721   <dd>The two strings '<tt>true</tt>' and '<tt>false</tt>' are both valid
1722   constants of the <tt><a href="#t_primitive">i1</a></tt> type.
1723   </dd>
1724
1725   <dt><b>Integer constants</b></dt>
1726
1727   <dd>Standard integers (such as '4') are constants of the <a
1728   href="#t_integer">integer</a> type.  Negative numbers may be used with
1729   integer types.
1730   </dd>
1731
1732   <dt><b>Floating point constants</b></dt>
1733
1734   <dd>Floating point constants use standard decimal notation (e.g. 123.421),
1735   exponential notation (e.g. 1.23421e+2), or a more precise hexadecimal
1736   notation (see below).  The assembler requires the exact decimal value of
1737   a floating-point constant.  For example, the assembler accepts 1.25 but
1738   rejects 1.3 because 1.3 is a repeating decimal in binary.  Floating point
1739   constants must have a <a href="#t_floating">floating point</a> type. </dd>
1740
1741   <dt><b>Null pointer constants</b></dt>
1742
1743   <dd>The identifier '<tt>null</tt>' is recognized as a null pointer constant
1744   and must be of <a href="#t_pointer">pointer type</a>.</dd>
1745
1746 </dl>
1747
1748 <p>The one non-intuitive notation for constants is the optional hexadecimal form
1749 of floating point constants.  For example, the form '<tt>double
1750 0x432ff973cafa8000</tt>' is equivalent to (but harder to read than) '<tt>double
1751 4.5e+15</tt>'.  The only time hexadecimal floating point constants are required
1752 (and the only time that they are generated by the disassembler) is when a
1753 floating point constant must be emitted but it cannot be represented as a
1754 decimal floating point number.  For example, NaN's, infinities, and other
1755 special values are represented in their IEEE hexadecimal format so that
1756 assembly and disassembly do not cause any bits to change in the constants.</p>
1757
1758 </div>
1759
1760 <!-- ======================================================================= -->
1761 <div class="doc_subsection"><a name="aggregateconstants">Aggregate Constants</a>
1762 </div>
1763
1764 <div class="doc_text">
1765 <p>Aggregate constants arise from aggregation of simple constants
1766 and smaller aggregate constants.</p>
1767
1768 <dl>
1769   <dt><b>Structure constants</b></dt>
1770
1771   <dd>Structure constants are represented with notation similar to structure
1772   type definitions (a comma separated list of elements, surrounded by braces
1773   (<tt>{}</tt>)).  For example: "<tt>{ i32 4, float 17.0, i32* @G }</tt>",
1774   where "<tt>@G</tt>" is declared as "<tt>@G = external global i32</tt>".  Structure constants
1775   must have <a href="#t_struct">structure type</a>, and the number and
1776   types of elements must match those specified by the type.
1777   </dd>
1778
1779   <dt><b>Array constants</b></dt>
1780
1781   <dd>Array constants are represented with notation similar to array type
1782   definitions (a comma separated list of elements, surrounded by square brackets
1783   (<tt>[]</tt>)).  For example: "<tt>[ i32 42, i32 11, i32 74 ]</tt>".  Array
1784   constants must have <a href="#t_array">array type</a>, and the number and
1785   types of elements must match those specified by the type.
1786   </dd>
1787
1788   <dt><b>Vector constants</b></dt>
1789
1790   <dd>Vector constants are represented with notation similar to vector type
1791   definitions (a comma separated list of elements, surrounded by
1792   less-than/greater-than's (<tt>&lt;&gt;</tt>)).  For example: "<tt>&lt; i32 42,
1793   i32 11, i32 74, i32 100 &gt;</tt>".  Vector constants must have <a
1794   href="#t_vector">vector type</a>, and the number and types of elements must
1795   match those specified by the type.
1796   </dd>
1797
1798   <dt><b>Zero initialization</b></dt>
1799
1800   <dd>The string '<tt>zeroinitializer</tt>' can be used to zero initialize a
1801   value to zero of <em>any</em> type, including scalar and aggregate types.
1802   This is often used to avoid having to print large zero initializers (e.g. for
1803   large arrays) and is always exactly equivalent to using explicit zero
1804   initializers.
1805   </dd>
1806 </dl>
1807
1808 </div>
1809
1810 <!-- ======================================================================= -->
1811 <div class="doc_subsection">
1812   <a name="globalconstants">Global Variable and Function Addresses</a>
1813 </div>
1814
1815 <div class="doc_text">
1816
1817 <p>The addresses of <a href="#globalvars">global variables</a> and <a
1818 href="#functionstructure">functions</a> are always implicitly valid (link-time)
1819 constants.  These constants are explicitly referenced when the <a
1820 href="#identifiers">identifier for the global</a> is used and always have <a
1821 href="#t_pointer">pointer</a> type. For example, the following is a legal LLVM
1822 file:</p>
1823
1824 <div class="doc_code">
1825 <pre>
1826 @X = global i32 17
1827 @Y = global i32 42
1828 @Z = global [2 x i32*] [ i32* @X, i32* @Y ]
1829 </pre>
1830 </div>
1831
1832 </div>
1833
1834 <!-- ======================================================================= -->
1835 <div class="doc_subsection"><a name="undefvalues">Undefined Values</a></div>
1836 <div class="doc_text">
1837   <p>The string '<tt>undef</tt>' is recognized as a type-less constant that has
1838   no specific value.  Undefined values may be of any type and be used anywhere
1839   a constant is permitted.</p>
1840
1841   <p>Undefined values indicate to the compiler that the program is well defined
1842   no matter what value is used, giving the compiler more freedom to optimize.
1843   </p>
1844 </div>
1845
1846 <!-- ======================================================================= -->
1847 <div class="doc_subsection"><a name="constantexprs">Constant Expressions</a>
1848 </div>
1849
1850 <div class="doc_text">
1851
1852 <p>Constant expressions are used to allow expressions involving other constants
1853 to be used as constants.  Constant expressions may be of any <a
1854 href="#t_firstclass">first class</a> type and may involve any LLVM operation
1855 that does not have side effects (e.g. load and call are not supported).  The
1856 following is the syntax for constant expressions:</p>
1857
1858 <dl>
1859   <dt><b><tt>trunc ( CST to TYPE )</tt></b></dt>
1860   <dd>Truncate a constant to another type. The bit size of CST must be larger
1861   than the bit size of TYPE. Both types must be integers.</dd>
1862
1863   <dt><b><tt>zext ( CST to TYPE )</tt></b></dt>
1864   <dd>Zero extend a constant to another type. The bit size of CST must be
1865   smaller or equal to the bit size of TYPE.  Both types must be integers.</dd>
1866
1867   <dt><b><tt>sext ( CST to TYPE )</tt></b></dt>
1868   <dd>Sign extend a constant to another type. The bit size of CST must be
1869   smaller or equal to the bit size of TYPE.  Both types must be integers.</dd>
1870
1871   <dt><b><tt>fptrunc ( CST to TYPE )</tt></b></dt>
1872   <dd>Truncate a floating point constant to another floating point type. The
1873   size of CST must be larger than the size of TYPE. Both types must be
1874   floating point.</dd>
1875
1876   <dt><b><tt>fpext ( CST to TYPE )</tt></b></dt>
1877   <dd>Floating point extend a constant to another type. The size of CST must be
1878   smaller or equal to the size of TYPE. Both types must be floating point.</dd>
1879
1880   <dt><b><tt>fptoui ( CST to TYPE )</tt></b></dt>
1881   <dd>Convert a floating point constant to the corresponding unsigned integer
1882   constant. TYPE must be a scalar or vector integer type. CST must be of scalar
1883   or vector floating point type. Both CST and TYPE must be scalars, or vectors
1884   of the same number of elements. If the  value won't fit in the integer type,
1885   the results are undefined.</dd>
1886
1887   <dt><b><tt>fptosi ( CST to TYPE )</tt></b></dt>
1888   <dd>Convert a floating point constant to the corresponding signed integer
1889   constant.  TYPE must be a scalar or vector integer type. CST must be of scalar
1890   or vector floating point type. Both CST and TYPE must be scalars, or vectors
1891   of the same number of elements. If the  value won't fit in the integer type,
1892   the results are undefined.</dd>
1893
1894   <dt><b><tt>uitofp ( CST to TYPE )</tt></b></dt>
1895   <dd>Convert an unsigned integer constant to the corresponding floating point
1896   constant. TYPE must be a scalar or vector floating point type. CST must be of
1897   scalar or vector integer type. Both CST and TYPE must be scalars, or vectors
1898   of the same number of elements. If the value won't fit in the floating point
1899   type, the results are undefined.</dd>
1900
1901   <dt><b><tt>sitofp ( CST to TYPE )</tt></b></dt>
1902   <dd>Convert a signed integer constant to the corresponding floating point
1903   constant. TYPE must be a scalar or vector floating point type. CST must be of
1904   scalar or vector integer type. Both CST and TYPE must be scalars, or vectors
1905   of the same number of elements. If the value won't fit in the floating point
1906   type, the results are undefined.</dd>
1907
1908   <dt><b><tt>ptrtoint ( CST to TYPE )</tt></b></dt>
1909   <dd>Convert a pointer typed constant to the corresponding integer constant
1910   TYPE must be an integer type. CST must be of pointer type. The CST value is
1911   zero extended, truncated, or unchanged to make it fit in TYPE.</dd>
1912
1913   <dt><b><tt>inttoptr ( CST to TYPE )</tt></b></dt>
1914   <dd>Convert a integer constant to a pointer constant.  TYPE must be a
1915   pointer type.  CST must be of integer type. The CST value is zero extended,
1916   truncated, or unchanged to make it fit in a pointer size. This one is
1917   <i>really</i> dangerous!</dd>
1918
1919   <dt><b><tt>bitcast ( CST to TYPE )</tt></b></dt>
1920   <dd>Convert a constant, CST, to another TYPE. The size of CST and TYPE must be
1921   identical (same number of bits). The conversion is done as if the CST value
1922   was stored to memory and read back as TYPE. In other words, no bits change
1923   with this operator, just the type.  This can be used for conversion of
1924   vector types to any other type, as long as they have the same bit width. For
1925   pointers it is only valid to cast to another pointer type. It is not valid
1926   to bitcast to or from an aggregate type.
1927   </dd>
1928
1929   <dt><b><tt>getelementptr ( CSTPTR, IDX0, IDX1, ... )</tt></b></dt>
1930
1931   <dd>Perform the <a href="#i_getelementptr">getelementptr operation</a> on
1932   constants.  As with the <a href="#i_getelementptr">getelementptr</a>
1933   instruction, the index list may have zero or more indexes, which are required
1934   to make sense for the type of "CSTPTR".</dd>
1935
1936   <dt><b><tt>select ( COND, VAL1, VAL2 )</tt></b></dt>
1937
1938   <dd>Perform the <a href="#i_select">select operation</a> on
1939   constants.</dd>
1940
1941   <dt><b><tt>icmp COND ( VAL1, VAL2 )</tt></b></dt>
1942   <dd>Performs the <a href="#i_icmp">icmp operation</a> on constants.</dd>
1943
1944   <dt><b><tt>fcmp COND ( VAL1, VAL2 )</tt></b></dt>
1945   <dd>Performs the <a href="#i_fcmp">fcmp operation</a> on constants.</dd>
1946
1947   <dt><b><tt>vicmp COND ( VAL1, VAL2 )</tt></b></dt>
1948   <dd>Performs the <a href="#i_vicmp">vicmp operation</a> on constants.</dd>
1949
1950   <dt><b><tt>vfcmp COND ( VAL1, VAL2 )</tt></b></dt>
1951   <dd>Performs the <a href="#i_vfcmp">vfcmp operation</a> on constants.</dd>
1952
1953   <dt><b><tt>extractelement ( VAL, IDX )</tt></b></dt>
1954
1955   <dd>Perform the <a href="#i_extractelement">extractelement
1956   operation</a> on constants.</dd>
1957
1958   <dt><b><tt>insertelement ( VAL, ELT, IDX )</tt></b></dt>
1959
1960   <dd>Perform the <a href="#i_insertelement">insertelement
1961     operation</a> on constants.</dd>
1962
1963
1964   <dt><b><tt>shufflevector ( VEC1, VEC2, IDXMASK )</tt></b></dt>
1965
1966   <dd>Perform the <a href="#i_shufflevector">shufflevector
1967     operation</a> on constants.</dd>
1968
1969   <dt><b><tt>OPCODE ( LHS, RHS )</tt></b></dt>
1970
1971   <dd>Perform the specified operation of the LHS and RHS constants. OPCODE may
1972   be any of the <a href="#binaryops">binary</a> or <a href="#bitwiseops">bitwise
1973   binary</a> operations.  The constraints on operands are the same as those for
1974   the corresponding instruction (e.g. no bitwise operations on floating point
1975   values are allowed).</dd>
1976 </dl>
1977 </div>
1978
1979 <!-- *********************************************************************** -->
1980 <div class="doc_section"> <a name="othervalues">Other Values</a> </div>
1981 <!-- *********************************************************************** -->
1982
1983 <!-- ======================================================================= -->
1984 <div class="doc_subsection">
1985 <a name="inlineasm">Inline Assembler Expressions</a>
1986 </div>
1987
1988 <div class="doc_text">
1989
1990 <p>
1991 LLVM supports inline assembler expressions (as opposed to <a href="#moduleasm">
1992 Module-Level Inline Assembly</a>) through the use of a special value.  This
1993 value represents the inline assembler as a string (containing the instructions
1994 to emit), a list of operand constraints (stored as a string), and a flag that
1995 indicates whether or not the inline asm expression has side effects.  An example
1996 inline assembler expression is:
1997 </p>
1998
1999 <div class="doc_code">
2000 <pre>
2001 i32 (i32) asm "bswap $0", "=r,r"
2002 </pre>
2003 </div>
2004
2005 <p>
2006 Inline assembler expressions may <b>only</b> be used as the callee operand of
2007 a <a href="#i_call"><tt>call</tt> instruction</a>.  Thus, typically we have:
2008 </p>
2009
2010 <div class="doc_code">
2011 <pre>
2012 %X = call i32 asm "<a href="#int_bswap">bswap</a> $0", "=r,r"(i32 %Y)
2013 </pre>
2014 </div>
2015
2016 <p>
2017 Inline asms with side effects not visible in the constraint list must be marked
2018 as having side effects.  This is done through the use of the
2019 '<tt>sideeffect</tt>' keyword, like so:
2020 </p>
2021
2022 <div class="doc_code">
2023 <pre>
2024 call void asm sideeffect "eieio", ""()
2025 </pre>
2026 </div>
2027
2028 <p>TODO: The format of the asm and constraints string still need to be
2029 documented here.  Constraints on what can be done (e.g. duplication, moving, etc
2030 need to be documented).  This is probably best done by reference to another
2031 document that covers inline asm from a holistic perspective.
2032 </p>
2033
2034 </div>
2035
2036 <!-- *********************************************************************** -->
2037 <div class="doc_section"> <a name="instref">Instruction Reference</a> </div>
2038 <!-- *********************************************************************** -->
2039
2040 <div class="doc_text">
2041
2042 <p>The LLVM instruction set consists of several different
2043 classifications of instructions: <a href="#terminators">terminator
2044 instructions</a>, <a href="#binaryops">binary instructions</a>,
2045 <a href="#bitwiseops">bitwise binary instructions</a>, <a
2046  href="#memoryops">memory instructions</a>, and <a href="#otherops">other
2047 instructions</a>.</p>
2048
2049 </div>
2050
2051 <!-- ======================================================================= -->
2052 <div class="doc_subsection"> <a name="terminators">Terminator
2053 Instructions</a> </div>
2054
2055 <div class="doc_text">
2056
2057 <p>As mentioned <a href="#functionstructure">previously</a>, every
2058 basic block in a program ends with a "Terminator" instruction, which
2059 indicates which block should be executed after the current block is
2060 finished. These terminator instructions typically yield a '<tt>void</tt>'
2061 value: they produce control flow, not values (the one exception being
2062 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction).</p>
2063 <p>There are six different terminator instructions: the '<a
2064  href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>'
2065 instruction, the '<a href="#i_switch"><tt>switch</tt></a>' instruction,
2066 the '<a href="#i_invoke"><tt>invoke</tt></a>' instruction, the '<a
2067  href="#i_unwind"><tt>unwind</tt></a>' instruction, and the '<a
2068  href="#i_unreachable"><tt>unreachable</tt></a>' instruction.</p>
2069
2070 </div>
2071
2072 <!-- _______________________________________________________________________ -->
2073 <div class="doc_subsubsection"> <a name="i_ret">'<tt>ret</tt>'
2074 Instruction</a> </div>
2075 <div class="doc_text">
2076 <h5>Syntax:</h5>
2077 <pre>
2078   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void function</i>
2079   ret void                 <i>; Return from void function</i>
2080 </pre>
2081
2082 <h5>Overview:</h5>
2083
2084 <p>The '<tt>ret</tt>' instruction is used to return control flow (and
2085 optionally a value) from a function back to the caller.</p>
2086 <p>There are two forms of the '<tt>ret</tt>' instruction: one that
2087 returns a value and then causes control flow, and one that just causes
2088 control flow to occur.</p>
2089
2090 <h5>Arguments:</h5>
2091
2092 <p>The '<tt>ret</tt>' instruction optionally accepts a single argument,
2093 the return value. The type of the return value must be a
2094 '<a href="#t_firstclass">first class</a>' type.</p>
2095
2096 <p>A function is not <a href="#wellformed">well formed</a> if
2097 it it has a non-void return type and contains a '<tt>ret</tt>'
2098 instruction with no return value or a return value with a type that
2099 does not match its type, or if it has a void return type and contains
2100 a '<tt>ret</tt>' instruction with a return value.</p>
2101
2102 <h5>Semantics:</h5>
2103
2104 <p>When the '<tt>ret</tt>' instruction is executed, control flow
2105 returns back to the calling function's context.  If the caller is a "<a
2106  href="#i_call"><tt>call</tt></a>" instruction, execution continues at
2107 the instruction after the call.  If the caller was an "<a
2108  href="#i_invoke"><tt>invoke</tt></a>" instruction, execution continues
2109 at the beginning of the "normal" destination block.  If the instruction
2110 returns a value, that value shall set the call or invoke instruction's
2111 return value.</p>
2112
2113 <h5>Example:</h5>
2114
2115 <pre>
2116   ret i32 5                       <i>; Return an integer value of 5</i>
2117   ret void                        <i>; Return from a void function</i>
2118   ret { i32, i8 } { i32 4, i8 2 } <i>; Return an aggregate of values 4 and 2</i>
2119 </pre>
2120
2121 <p>Note that the code generator does not yet fully support large
2122    return values. The specific sizes that are currently supported are
2123    dependent on the target. For integers, on 32-bit targets the limit
2124    is often 64 bits, and on 64-bit targets the limit is often 128 bits.
2125    For aggregate types, the current limits are dependent on the element
2126    types; for example targets are often limited to 2 total integer
2127    elements and 2 total floating-point elements.</p>
2128
2129 </div>
2130 <!-- _______________________________________________________________________ -->
2131 <div class="doc_subsubsection"> <a name="i_br">'<tt>br</tt>' Instruction</a> </div>
2132 <div class="doc_text">
2133 <h5>Syntax:</h5>
2134 <pre>  br i1 &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;<br>  br label &lt;dest&gt;          <i>; Unconditional branch</i>
2135 </pre>
2136 <h5>Overview:</h5>
2137 <p>The '<tt>br</tt>' instruction is used to cause control flow to
2138 transfer to a different basic block in the current function.  There are
2139 two forms of this instruction, corresponding to a conditional branch
2140 and an unconditional branch.</p>
2141 <h5>Arguments:</h5>
2142 <p>The conditional branch form of the '<tt>br</tt>' instruction takes a
2143 single '<tt>i1</tt>' value and two '<tt>label</tt>' values.  The
2144 unconditional form of the '<tt>br</tt>' instruction takes a single
2145 '<tt>label</tt>' value as a target.</p>
2146 <h5>Semantics:</h5>
2147 <p>Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>i1</tt>'
2148 argument is evaluated.  If the value is <tt>true</tt>, control flows
2149 to the '<tt>iftrue</tt>' <tt>label</tt> argument.  If "cond" is <tt>false</tt>,
2150 control flows to the '<tt>iffalse</tt>' <tt>label</tt> argument.</p>
2151 <h5>Example:</h5>
2152 <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
2153  href="#i_ret">ret</a> i32 1<br>IfUnequal:<br>  <a href="#i_ret">ret</a> i32 0<br></pre>
2154 </div>
2155 <!-- _______________________________________________________________________ -->
2156 <div class="doc_subsubsection">
2157    <a name="i_switch">'<tt>switch</tt>' Instruction</a>
2158 </div>
2159
2160 <div class="doc_text">
2161 <h5>Syntax:</h5>
2162
2163 <pre>
2164   switch &lt;intty&gt; &lt;value&gt;, label &lt;defaultdest&gt; [ &lt;intty&gt; &lt;val&gt;, label &lt;dest&gt; ... ]
2165 </pre>
2166
2167 <h5>Overview:</h5>
2168
2169 <p>The '<tt>switch</tt>' instruction is used to transfer control flow to one of
2170 several different places.  It is a generalization of the '<tt>br</tt>'
2171 instruction, allowing a branch to occur to one of many possible
2172 destinations.</p>
2173
2174
2175 <h5>Arguments:</h5>
2176
2177 <p>The '<tt>switch</tt>' instruction uses three parameters: an integer
2178 comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and
2179 an array of pairs of comparison value constants and '<tt>label</tt>'s.  The
2180 table is not allowed to contain duplicate constant entries.</p>
2181
2182 <h5>Semantics:</h5>
2183
2184 <p>The <tt>switch</tt> instruction specifies a table of values and
2185 destinations. When the '<tt>switch</tt>' instruction is executed, this
2186 table is searched for the given value.  If the value is found, control flow is
2187 transfered to the corresponding destination; otherwise, control flow is
2188 transfered to the default destination.</p>
2189
2190 <h5>Implementation:</h5>
2191
2192 <p>Depending on properties of the target machine and the particular
2193 <tt>switch</tt> instruction, this instruction may be code generated in different
2194 ways.  For example, it could be generated as a series of chained conditional
2195 branches or with a lookup table.</p>
2196
2197 <h5>Example:</h5>
2198
2199 <pre>
2200  <i>; Emulate a conditional br instruction</i>
2201  %Val = <a href="#i_zext">zext</a> i1 %value to i32
2202  switch i32 %Val, label %truedest [ i32 0, label %falsedest ]
2203
2204  <i>; Emulate an unconditional br instruction</i>
2205  switch i32 0, label %dest [ ]
2206
2207  <i>; Implement a jump table:</i>
2208  switch i32 %val, label %otherwise [ i32 0, label %onzero
2209                                      i32 1, label %onone
2210                                      i32 2, label %ontwo ]
2211 </pre>
2212 </div>
2213
2214 <!-- _______________________________________________________________________ -->
2215 <div class="doc_subsubsection">
2216   <a name="i_invoke">'<tt>invoke</tt>' Instruction</a>
2217 </div>
2218
2219 <div class="doc_text">
2220
2221 <h5>Syntax:</h5>
2222
2223 <pre>
2224   &lt;result&gt; = invoke [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] &lt;ptr to function ty&gt; &lt;function ptr val&gt;(&lt;function args&gt;) [<a href="#fnattrs">fn attrs</a>]
2225                 to label &lt;normal label&gt; unwind label &lt;exception label&gt;
2226 </pre>
2227
2228 <h5>Overview:</h5>
2229
2230 <p>The '<tt>invoke</tt>' instruction causes control to transfer to a specified
2231 function, with the possibility of control flow transfer to either the
2232 '<tt>normal</tt>' label or the
2233 '<tt>exception</tt>' label.  If the callee function returns with the
2234 "<tt><a href="#i_ret">ret</a></tt>" instruction, control flow will return to the
2235 "normal" label.  If the callee (or any indirect callees) returns with the "<a
2236 href="#i_unwind"><tt>unwind</tt></a>" instruction, control is interrupted and
2237 continued at the dynamically nearest "exception" label.</p>
2238
2239 <h5>Arguments:</h5>
2240
2241 <p>This instruction requires several arguments:</p>
2242
2243 <ol>
2244   <li>
2245     The optional "cconv" marker indicates which <a href="#callingconv">calling
2246     convention</a> the call should use.  If none is specified, the call defaults
2247     to using C calling conventions.
2248   </li>
2249
2250   <li>The optional <a href="#paramattrs">Parameter Attributes</a> list for
2251    return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>',
2252    and '<tt>inreg</tt>' attributes are valid here.</li>
2253
2254   <li>'<tt>ptr to function ty</tt>': shall be the signature of the pointer to
2255   function value being invoked.  In most cases, this is a direct function
2256   invocation, but indirect <tt>invoke</tt>s are just as possible, branching off
2257   an arbitrary pointer to function value.
2258   </li>
2259
2260   <li>'<tt>function ptr val</tt>': An LLVM value containing a pointer to a
2261   function to be invoked. </li>
2262
2263   <li>'<tt>function args</tt>': argument list whose types match the function
2264   signature argument types.  If the function signature indicates the function
2265   accepts a variable number of arguments, the extra arguments can be
2266   specified. </li>
2267
2268   <li>'<tt>normal label</tt>': the label reached when the called function
2269   executes a '<tt><a href="#i_ret">ret</a></tt>' instruction. </li>
2270
2271   <li>'<tt>exception label</tt>': the label reached when a callee returns with
2272   the <a href="#i_unwind"><tt>unwind</tt></a> instruction. </li>
2273
2274   <li>The optional <a href="#fnattrs">function attributes</a> list. Only
2275   '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
2276   '<tt>readnone</tt>' attributes are valid here.</li>
2277 </ol>
2278
2279 <h5>Semantics:</h5>
2280
2281 <p>This instruction is designed to operate as a standard '<tt><a
2282 href="#i_call">call</a></tt>' instruction in most regards.  The primary
2283 difference is that it establishes an association with a label, which is used by
2284 the runtime library to unwind the stack.</p>
2285
2286 <p>This instruction is used in languages with destructors to ensure that proper
2287 cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown
2288 exception.  Additionally, this is important for implementation of
2289 '<tt>catch</tt>' clauses in high-level languages that support them.</p>
2290
2291 <h5>Example:</h5>
2292 <pre>
2293   %retval = invoke i32 @Test(i32 15) to label %Continue
2294               unwind label %TestCleanup              <i>; {i32}:retval set</i>
2295   %retval = invoke <a href="#callingconv">coldcc</a> i32 %Testfnptr(i32 15) to label %Continue
2296               unwind label %TestCleanup              <i>; {i32}:retval set</i>
2297 </pre>
2298 </div>
2299
2300
2301 <!-- _______________________________________________________________________ -->
2302
2303 <div class="doc_subsubsection"> <a name="i_unwind">'<tt>unwind</tt>'
2304 Instruction</a> </div>
2305
2306 <div class="doc_text">
2307
2308 <h5>Syntax:</h5>
2309 <pre>
2310   unwind
2311 </pre>
2312
2313 <h5>Overview:</h5>
2314
2315 <p>The '<tt>unwind</tt>' instruction unwinds the stack, continuing control flow
2316 at the first callee in the dynamic call stack which used an <a
2317 href="#i_invoke"><tt>invoke</tt></a> instruction to perform the call.  This is
2318 primarily used to implement exception handling.</p>
2319
2320 <h5>Semantics:</h5>
2321
2322 <p>The '<tt>unwind</tt>' instruction causes execution of the current function to
2323 immediately halt.  The dynamic call stack is then searched for the first <a
2324 href="#i_invoke"><tt>invoke</tt></a> instruction on the call stack.  Once found,
2325 execution continues at the "exceptional" destination block specified by the
2326 <tt>invoke</tt> instruction.  If there is no <tt>invoke</tt> instruction in the
2327 dynamic call chain, undefined behavior results.</p>
2328 </div>
2329
2330 <!-- _______________________________________________________________________ -->
2331
2332 <div class="doc_subsubsection"> <a name="i_unreachable">'<tt>unreachable</tt>'
2333 Instruction</a> </div>
2334
2335 <div class="doc_text">
2336
2337 <h5>Syntax:</h5>
2338 <pre>
2339   unreachable
2340 </pre>
2341
2342 <h5>Overview:</h5>
2343
2344 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.  This
2345 instruction is used to inform the optimizer that a particular portion of the
2346 code is not reachable.  This can be used to indicate that the code after a
2347 no-return function cannot be reached, and other facts.</p>
2348
2349 <h5>Semantics:</h5>
2350
2351 <p>The '<tt>unreachable</tt>' instruction has no defined semantics.</p>
2352 </div>
2353
2354
2355
2356 <!-- ======================================================================= -->
2357 <div class="doc_subsection"> <a name="binaryops">Binary Operations</a> </div>
2358 <div class="doc_text">
2359 <p>Binary operators are used to do most of the computation in a
2360 program.  They require two operands of the same type, execute an operation on them, and
2361 produce a single value.  The operands might represent
2362 multiple data, as is the case with the <a href="#t_vector">vector</a> data type.
2363 The result value has the same type as its operands.</p>
2364 <p>There are several different binary operators:</p>
2365 </div>
2366 <!-- _______________________________________________________________________ -->
2367 <div class="doc_subsubsection">
2368   <a name="i_add">'<tt>add</tt>' Instruction</a>
2369 </div>
2370
2371 <div class="doc_text">
2372
2373 <h5>Syntax:</h5>
2374
2375 <pre>
2376   &lt;result&gt; = add &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2377 </pre>
2378
2379 <h5>Overview:</h5>
2380
2381 <p>The '<tt>add</tt>' instruction returns the sum of its two operands.</p>
2382
2383 <h5>Arguments:</h5>
2384
2385 <p>The two arguments to the '<tt>add</tt>' instruction must be <a
2386  href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>, or
2387  <a href="#t_vector">vector</a> values. Both arguments must have identical
2388  types.</p>
2389
2390 <h5>Semantics:</h5>
2391
2392 <p>The value produced is the integer or floating point sum of the two
2393 operands.</p>
2394
2395 <p>If an integer sum has unsigned overflow, the result returned is the
2396 mathematical result modulo 2<sup>n</sup>, where n is the bit width of
2397 the result.</p>
2398
2399 <p>Because LLVM integers use a two's complement representation, this
2400 instruction is appropriate for both signed and unsigned integers.</p>
2401
2402 <h5>Example:</h5>
2403
2404 <pre>
2405   &lt;result&gt; = add i32 4, %var          <i>; yields {i32}:result = 4 + %var</i>
2406 </pre>
2407 </div>
2408 <!-- _______________________________________________________________________ -->
2409 <div class="doc_subsubsection">
2410    <a name="i_sub">'<tt>sub</tt>' Instruction</a>
2411 </div>
2412
2413 <div class="doc_text">
2414
2415 <h5>Syntax:</h5>
2416
2417 <pre>
2418   &lt;result&gt; = sub &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2419 </pre>
2420
2421 <h5>Overview:</h5>
2422
2423 <p>The '<tt>sub</tt>' instruction returns the difference of its two
2424 operands.</p>
2425
2426 <p>Note that the '<tt>sub</tt>' instruction is used to represent the
2427 '<tt>neg</tt>' instruction present in most other intermediate
2428 representations.</p>
2429
2430 <h5>Arguments:</h5>
2431
2432 <p>The two arguments to the '<tt>sub</tt>' instruction must be <a
2433  href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>,
2434  or <a href="#t_vector">vector</a> values.  Both arguments must have identical
2435  types.</p>
2436
2437 <h5>Semantics:</h5>
2438
2439 <p>The value produced is the integer or floating point difference of
2440 the two operands.</p>
2441
2442 <p>If an integer difference has unsigned overflow, the result returned is the
2443 mathematical result modulo 2<sup>n</sup>, where n is the bit width of
2444 the result.</p>
2445
2446 <p>Because LLVM integers use a two's complement representation, this
2447 instruction is appropriate for both signed and unsigned integers.</p>
2448
2449 <h5>Example:</h5>
2450 <pre>
2451   &lt;result&gt; = sub i32 4, %var          <i>; yields {i32}:result = 4 - %var</i>
2452   &lt;result&gt; = sub i32 0, %val          <i>; yields {i32}:result = -%var</i>
2453 </pre>
2454 </div>
2455
2456 <!-- _______________________________________________________________________ -->
2457 <div class="doc_subsubsection">
2458   <a name="i_mul">'<tt>mul</tt>' Instruction</a>
2459 </div>
2460
2461 <div class="doc_text">
2462
2463 <h5>Syntax:</h5>
2464 <pre>  &lt;result&gt; = mul &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2465 </pre>
2466 <h5>Overview:</h5>
2467 <p>The  '<tt>mul</tt>' instruction returns the product of its two
2468 operands.</p>
2469
2470 <h5>Arguments:</h5>
2471
2472 <p>The two arguments to the '<tt>mul</tt>' instruction must be <a
2473 href="#t_integer">integer</a>, <a href="#t_floating">floating point</a>,
2474 or <a href="#t_vector">vector</a> values.  Both arguments must have identical
2475 types.</p>
2476
2477 <h5>Semantics:</h5>
2478
2479 <p>The value produced is the integer or floating point product of the
2480 two operands.</p>
2481
2482 <p>If the result of an integer multiplication has unsigned overflow,
2483 the result returned is the mathematical result modulo
2484 2<sup>n</sup>, where n is the bit width of the result.</p>
2485 <p>Because LLVM integers use a two's complement representation, and the
2486 result is the same width as the operands, this instruction returns the
2487 correct result for both signed and unsigned integers.  If a full product
2488 (e.g. <tt>i32</tt>x<tt>i32</tt>-><tt>i64</tt>) is needed, the operands
2489 should be sign-extended or zero-extended as appropriate to the
2490 width of the full product.</p>
2491 <h5>Example:</h5>
2492 <pre>  &lt;result&gt; = mul i32 4, %var          <i>; yields {i32}:result = 4 * %var</i>
2493 </pre>
2494 </div>
2495
2496 <!-- _______________________________________________________________________ -->
2497 <div class="doc_subsubsection"> <a name="i_udiv">'<tt>udiv</tt>' Instruction
2498 </a></div>
2499 <div class="doc_text">
2500 <h5>Syntax:</h5>
2501 <pre>  &lt;result&gt; = udiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2502 </pre>
2503 <h5>Overview:</h5>
2504 <p>The '<tt>udiv</tt>' instruction returns the quotient of its two
2505 operands.</p>
2506
2507 <h5>Arguments:</h5>
2508
2509 <p>The two arguments to the '<tt>udiv</tt>' instruction must be
2510 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2511 values.  Both arguments must have identical types.</p>
2512
2513 <h5>Semantics:</h5>
2514
2515 <p>The value produced is the unsigned integer quotient of the two operands.</p>
2516 <p>Note that unsigned integer division and signed integer division are distinct
2517 operations; for signed integer division, use '<tt>sdiv</tt>'.</p>
2518 <p>Division by zero leads to undefined behavior.</p>
2519 <h5>Example:</h5>
2520 <pre>  &lt;result&gt; = udiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
2521 </pre>
2522 </div>
2523 <!-- _______________________________________________________________________ -->
2524 <div class="doc_subsubsection"> <a name="i_sdiv">'<tt>sdiv</tt>' Instruction
2525 </a> </div>
2526 <div class="doc_text">
2527 <h5>Syntax:</h5>
2528 <pre>
2529   &lt;result&gt; = sdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2530 </pre>
2531
2532 <h5>Overview:</h5>
2533
2534 <p>The '<tt>sdiv</tt>' instruction returns the quotient of its two
2535 operands.</p>
2536
2537 <h5>Arguments:</h5>
2538
2539 <p>The two arguments to the '<tt>sdiv</tt>' instruction must be
2540 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2541 values.  Both arguments must have identical types.</p>
2542
2543 <h5>Semantics:</h5>
2544 <p>The value produced is the signed integer quotient of the two operands rounded towards zero.</p>
2545 <p>Note that signed integer division and unsigned integer division are distinct
2546 operations; for unsigned integer division, use '<tt>udiv</tt>'.</p>
2547 <p>Division by zero leads to undefined behavior. Overflow also leads to
2548 undefined behavior; this is a rare case, but can occur, for example,
2549 by doing a 32-bit division of -2147483648 by -1.</p>
2550 <h5>Example:</h5>
2551 <pre>  &lt;result&gt; = sdiv i32 4, %var          <i>; yields {i32}:result = 4 / %var</i>
2552 </pre>
2553 </div>
2554 <!-- _______________________________________________________________________ -->
2555 <div class="doc_subsubsection"> <a name="i_fdiv">'<tt>fdiv</tt>'
2556 Instruction</a> </div>
2557 <div class="doc_text">
2558 <h5>Syntax:</h5>
2559 <pre>
2560   &lt;result&gt; = fdiv &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2561 </pre>
2562 <h5>Overview:</h5>
2563
2564 <p>The '<tt>fdiv</tt>' instruction returns the quotient of its two
2565 operands.</p>
2566
2567 <h5>Arguments:</h5>
2568
2569 <p>The two arguments to the '<tt>fdiv</tt>' instruction must be
2570 <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a>
2571 of floating point values.  Both arguments must have identical types.</p>
2572
2573 <h5>Semantics:</h5>
2574
2575 <p>The value produced is the floating point quotient of the two operands.</p>
2576
2577 <h5>Example:</h5>
2578
2579 <pre>
2580   &lt;result&gt; = fdiv float 4.0, %var          <i>; yields {float}:result = 4.0 / %var</i>
2581 </pre>
2582 </div>
2583
2584 <!-- _______________________________________________________________________ -->
2585 <div class="doc_subsubsection"> <a name="i_urem">'<tt>urem</tt>' Instruction</a>
2586 </div>
2587 <div class="doc_text">
2588 <h5>Syntax:</h5>
2589 <pre>  &lt;result&gt; = urem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2590 </pre>
2591 <h5>Overview:</h5>
2592 <p>The '<tt>urem</tt>' instruction returns the remainder from the
2593 unsigned division of its two arguments.</p>
2594 <h5>Arguments:</h5>
2595 <p>The two arguments to the '<tt>urem</tt>' instruction must be
2596 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2597 values.  Both arguments must have identical types.</p>
2598 <h5>Semantics:</h5>
2599 <p>This instruction returns the unsigned integer <i>remainder</i> of a division.
2600 This instruction always performs an unsigned division to get the remainder.</p>
2601 <p>Note that unsigned integer remainder and signed integer remainder are
2602 distinct operations; for signed integer remainder, use '<tt>srem</tt>'.</p>
2603 <p>Taking the remainder of a division by zero leads to undefined behavior.</p>
2604 <h5>Example:</h5>
2605 <pre>  &lt;result&gt; = urem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
2606 </pre>
2607
2608 </div>
2609 <!-- _______________________________________________________________________ -->
2610 <div class="doc_subsubsection">
2611   <a name="i_srem">'<tt>srem</tt>' Instruction</a>
2612 </div>
2613
2614 <div class="doc_text">
2615
2616 <h5>Syntax:</h5>
2617
2618 <pre>
2619   &lt;result&gt; = srem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2620 </pre>
2621
2622 <h5>Overview:</h5>
2623
2624 <p>The '<tt>srem</tt>' instruction returns the remainder from the
2625 signed division of its two operands. This instruction can also take
2626 <a href="#t_vector">vector</a> versions of the values in which case
2627 the elements must be integers.</p>
2628
2629 <h5>Arguments:</h5>
2630
2631 <p>The two arguments to the '<tt>srem</tt>' instruction must be
2632 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2633 values.  Both arguments must have identical types.</p>
2634
2635 <h5>Semantics:</h5>
2636
2637 <p>This instruction returns the <i>remainder</i> of a division (where the result
2638 has the same sign as the dividend, <tt>op1</tt>), not the <i>modulo</i>
2639 operator (where the result has the same sign as the divisor, <tt>op2</tt>) of
2640 a value.  For more information about the difference, see <a
2641  href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The
2642 Math Forum</a>. For a table of how this is implemented in various languages,
2643 please see <a href="http://en.wikipedia.org/wiki/Modulo_operation">
2644 Wikipedia: modulo operation</a>.</p>
2645 <p>Note that signed integer remainder and unsigned integer remainder are
2646 distinct operations; for unsigned integer remainder, use '<tt>urem</tt>'.</p>
2647 <p>Taking the remainder of a division by zero leads to undefined behavior.
2648 Overflow also leads to undefined behavior; this is a rare case, but can occur,
2649 for example, by taking the remainder of a 32-bit division of -2147483648 by -1.
2650 (The remainder doesn't actually overflow, but this rule lets srem be
2651 implemented using instructions that return both the result of the division
2652 and the remainder.)</p>
2653 <h5>Example:</h5>
2654 <pre>  &lt;result&gt; = srem i32 4, %var          <i>; yields {i32}:result = 4 % %var</i>
2655 </pre>
2656
2657 </div>
2658 <!-- _______________________________________________________________________ -->
2659 <div class="doc_subsubsection">
2660   <a name="i_frem">'<tt>frem</tt>' Instruction</a> </div>
2661
2662 <div class="doc_text">
2663
2664 <h5>Syntax:</h5>
2665 <pre>  &lt;result&gt; = frem &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2666 </pre>
2667 <h5>Overview:</h5>
2668 <p>The '<tt>frem</tt>' instruction returns the remainder from the
2669 division of its two operands.</p>
2670 <h5>Arguments:</h5>
2671 <p>The two arguments to the '<tt>frem</tt>' instruction must be
2672 <a href="#t_floating">floating point</a> or <a href="#t_vector">vector</a>
2673 of floating point values.  Both arguments must have identical types.</p>
2674
2675 <h5>Semantics:</h5>
2676
2677 <p>This instruction returns the <i>remainder</i> of a division.
2678 The remainder has the same sign as the dividend.</p>
2679
2680 <h5>Example:</h5>
2681
2682 <pre>
2683   &lt;result&gt; = frem float 4.0, %var          <i>; yields {float}:result = 4.0 % %var</i>
2684 </pre>
2685 </div>
2686
2687 <!-- ======================================================================= -->
2688 <div class="doc_subsection"> <a name="bitwiseops">Bitwise Binary
2689 Operations</a> </div>
2690 <div class="doc_text">
2691 <p>Bitwise binary operators are used to do various forms of
2692 bit-twiddling in a program.  They are generally very efficient
2693 instructions and can commonly be strength reduced from other
2694 instructions.  They require two operands of the same type, execute an operation on them,
2695 and produce a single value.  The resulting value is the same type as its operands.</p>
2696 </div>
2697
2698 <!-- _______________________________________________________________________ -->
2699 <div class="doc_subsubsection"> <a name="i_shl">'<tt>shl</tt>'
2700 Instruction</a> </div>
2701 <div class="doc_text">
2702 <h5>Syntax:</h5>
2703 <pre>  &lt;result&gt; = shl &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2704 </pre>
2705
2706 <h5>Overview:</h5>
2707
2708 <p>The '<tt>shl</tt>' instruction returns the first operand shifted to
2709 the left a specified number of bits.</p>
2710
2711 <h5>Arguments:</h5>
2712
2713 <p>Both arguments to the '<tt>shl</tt>' instruction must be the same <a
2714  href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2715 type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
2716
2717 <h5>Semantics:</h5>
2718
2719 <p>The value produced is <tt>op1</tt> * 2<sup><tt>op2</tt></sup> mod 2<sup>n</sup>,
2720 where n is the width of the result.  If <tt>op2</tt> is (statically or dynamically) negative or
2721 equal to or larger than the number of bits in <tt>op1</tt>, the result is undefined.
2722 If the arguments are vectors, each vector element of <tt>op1</tt> is shifted by the
2723 corresponding shift amount in <tt>op2</tt>.</p>
2724
2725 <h5>Example:</h5><pre>
2726   &lt;result&gt; = shl i32 4, %var   <i>; yields {i32}: 4 &lt;&lt; %var</i>
2727   &lt;result&gt; = shl i32 4, 2      <i>; yields {i32}: 16</i>
2728   &lt;result&gt; = shl i32 1, 10     <i>; yields {i32}: 1024</i>
2729   &lt;result&gt; = shl i32 1, 32     <i>; undefined</i>
2730   &lt;result&gt; = shl &lt;2 x i32&gt; &lt; i32 1, i32 1&gt;, &lt; i32 1, i32 2&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 2, i32 4&gt;</i>
2731 </pre>
2732 </div>
2733 <!-- _______________________________________________________________________ -->
2734 <div class="doc_subsubsection"> <a name="i_lshr">'<tt>lshr</tt>'
2735 Instruction</a> </div>
2736 <div class="doc_text">
2737 <h5>Syntax:</h5>
2738 <pre>  &lt;result&gt; = lshr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2739 </pre>
2740
2741 <h5>Overview:</h5>
2742 <p>The '<tt>lshr</tt>' instruction (logical shift right) returns the first
2743 operand shifted to the right a specified number of bits with zero fill.</p>
2744
2745 <h5>Arguments:</h5>
2746 <p>Both arguments to the '<tt>lshr</tt>' instruction must be the same
2747 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2748 type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
2749
2750 <h5>Semantics:</h5>
2751
2752 <p>This instruction always performs a logical shift right operation. The most
2753 significant bits of the result will be filled with zero bits after the
2754 shift.  If <tt>op2</tt> is (statically or dynamically) equal to or larger than
2755 the number of bits in <tt>op1</tt>, the result is undefined. If the arguments are
2756 vectors, each vector element of <tt>op1</tt> is shifted by the corresponding shift
2757 amount in <tt>op2</tt>.</p>
2758
2759 <h5>Example:</h5>
2760 <pre>
2761   &lt;result&gt; = lshr i32 4, 1   <i>; yields {i32}:result = 2</i>
2762   &lt;result&gt; = lshr i32 4, 2   <i>; yields {i32}:result = 1</i>
2763   &lt;result&gt; = lshr i8  4, 3   <i>; yields {i8}:result = 0</i>
2764   &lt;result&gt; = lshr i8 -2, 1   <i>; yields {i8}:result = 0x7FFFFFFF </i>
2765   &lt;result&gt; = lshr i32 1, 32  <i>; undefined</i>
2766   &lt;result&gt; = lshr &lt;2 x i32&gt; &lt; i32 -2, i32 4&gt;, &lt; i32 1, i32 2&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 0x7FFFFFFF, i32 1&gt;</i>
2767 </pre>
2768 </div>
2769
2770 <!-- _______________________________________________________________________ -->
2771 <div class="doc_subsubsection"> <a name="i_ashr">'<tt>ashr</tt>'
2772 Instruction</a> </div>
2773 <div class="doc_text">
2774
2775 <h5>Syntax:</h5>
2776 <pre>  &lt;result&gt; = ashr &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2777 </pre>
2778
2779 <h5>Overview:</h5>
2780 <p>The '<tt>ashr</tt>' instruction (arithmetic shift right) returns the first
2781 operand shifted to the right a specified number of bits with sign extension.</p>
2782
2783 <h5>Arguments:</h5>
2784 <p>Both arguments to the '<tt>ashr</tt>' instruction must be the same
2785 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2786 type.  '<tt>op2</tt>' is treated as an unsigned value.</p>
2787
2788 <h5>Semantics:</h5>
2789 <p>This instruction always performs an arithmetic shift right operation,
2790 The most significant bits of the result will be filled with the sign bit
2791 of <tt>op1</tt>.  If <tt>op2</tt> is (statically or dynamically) equal to or
2792 larger than the number of bits in <tt>op1</tt>, the result is undefined. If the
2793 arguments are vectors, each vector element of <tt>op1</tt> is shifted by the
2794 corresponding shift amount in <tt>op2</tt>.</p>
2795
2796 <h5>Example:</h5>
2797 <pre>
2798   &lt;result&gt; = ashr i32 4, 1   <i>; yields {i32}:result = 2</i>
2799   &lt;result&gt; = ashr i32 4, 2   <i>; yields {i32}:result = 1</i>
2800   &lt;result&gt; = ashr i8  4, 3   <i>; yields {i8}:result = 0</i>
2801   &lt;result&gt; = ashr i8 -2, 1   <i>; yields {i8}:result = -1</i>
2802   &lt;result&gt; = ashr i32 1, 32  <i>; undefined</i>
2803   &lt;result&gt; = ashr &lt;2 x i32&gt; &lt; i32 -2, i32 4&gt;, &lt; i32 1, i32 3&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 -1, i32 0&gt;</i>
2804 </pre>
2805 </div>
2806
2807 <!-- _______________________________________________________________________ -->
2808 <div class="doc_subsubsection"> <a name="i_and">'<tt>and</tt>'
2809 Instruction</a> </div>
2810
2811 <div class="doc_text">
2812
2813 <h5>Syntax:</h5>
2814
2815 <pre>
2816   &lt;result&gt; = and &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2817 </pre>
2818
2819 <h5>Overview:</h5>
2820
2821 <p>The '<tt>and</tt>' instruction returns the bitwise logical and of
2822 its two operands.</p>
2823
2824 <h5>Arguments:</h5>
2825
2826 <p>The two arguments to the '<tt>and</tt>' instruction must be
2827 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2828 values.  Both arguments must have identical types.</p>
2829
2830 <h5>Semantics:</h5>
2831 <p>The truth table used for the '<tt>and</tt>' instruction is:</p>
2832 <p> </p>
2833 <div>
2834 <table border="1" cellspacing="0" cellpadding="4">
2835   <tbody>
2836     <tr>
2837       <td>In0</td>
2838       <td>In1</td>
2839       <td>Out</td>
2840     </tr>
2841     <tr>
2842       <td>0</td>
2843       <td>0</td>
2844       <td>0</td>
2845     </tr>
2846     <tr>
2847       <td>0</td>
2848       <td>1</td>
2849       <td>0</td>
2850     </tr>
2851     <tr>
2852       <td>1</td>
2853       <td>0</td>
2854       <td>0</td>
2855     </tr>
2856     <tr>
2857       <td>1</td>
2858       <td>1</td>
2859       <td>1</td>
2860     </tr>
2861   </tbody>
2862 </table>
2863 </div>
2864 <h5>Example:</h5>
2865 <pre>
2866   &lt;result&gt; = and i32 4, %var         <i>; yields {i32}:result = 4 &amp; %var</i>
2867   &lt;result&gt; = and i32 15, 40          <i>; yields {i32}:result = 8</i>
2868   &lt;result&gt; = and i32 4, 8            <i>; yields {i32}:result = 0</i>
2869 </pre>
2870 </div>
2871 <!-- _______________________________________________________________________ -->
2872 <div class="doc_subsubsection"> <a name="i_or">'<tt>or</tt>' Instruction</a> </div>
2873 <div class="doc_text">
2874 <h5>Syntax:</h5>
2875 <pre>  &lt;result&gt; = or &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2876 </pre>
2877 <h5>Overview:</h5>
2878 <p>The '<tt>or</tt>' instruction returns the bitwise logical inclusive
2879 or of its two operands.</p>
2880 <h5>Arguments:</h5>
2881
2882 <p>The two arguments to the '<tt>or</tt>' instruction must be
2883 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2884 values.  Both arguments must have identical types.</p>
2885 <h5>Semantics:</h5>
2886 <p>The truth table used for the '<tt>or</tt>' instruction is:</p>
2887 <p> </p>
2888 <div>
2889 <table border="1" cellspacing="0" cellpadding="4">
2890   <tbody>
2891     <tr>
2892       <td>In0</td>
2893       <td>In1</td>
2894       <td>Out</td>
2895     </tr>
2896     <tr>
2897       <td>0</td>
2898       <td>0</td>
2899       <td>0</td>
2900     </tr>
2901     <tr>
2902       <td>0</td>
2903       <td>1</td>
2904       <td>1</td>
2905     </tr>
2906     <tr>
2907       <td>1</td>
2908       <td>0</td>
2909       <td>1</td>
2910     </tr>
2911     <tr>
2912       <td>1</td>
2913       <td>1</td>
2914       <td>1</td>
2915     </tr>
2916   </tbody>
2917 </table>
2918 </div>
2919 <h5>Example:</h5>
2920 <pre>  &lt;result&gt; = or i32 4, %var         <i>; yields {i32}:result = 4 | %var</i>
2921   &lt;result&gt; = or i32 15, 40          <i>; yields {i32}:result = 47</i>
2922   &lt;result&gt; = or i32 4, 8            <i>; yields {i32}:result = 12</i>
2923 </pre>
2924 </div>
2925 <!-- _______________________________________________________________________ -->
2926 <div class="doc_subsubsection"> <a name="i_xor">'<tt>xor</tt>'
2927 Instruction</a> </div>
2928 <div class="doc_text">
2929 <h5>Syntax:</h5>
2930 <pre>  &lt;result&gt; = xor &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
2931 </pre>
2932 <h5>Overview:</h5>
2933 <p>The '<tt>xor</tt>' instruction returns the bitwise logical exclusive
2934 or of its two operands.  The <tt>xor</tt> is used to implement the
2935 "one's complement" operation, which is the "~" operator in C.</p>
2936 <h5>Arguments:</h5>
2937 <p>The two arguments to the '<tt>xor</tt>' instruction must be
2938 <a href="#t_integer">integer</a> or <a href="#t_vector">vector</a> of integer
2939 values.  Both arguments must have identical types.</p>
2940
2941 <h5>Semantics:</h5>
2942
2943 <p>The truth table used for the '<tt>xor</tt>' instruction is:</p>
2944 <p> </p>
2945 <div>
2946 <table border="1" cellspacing="0" cellpadding="4">
2947   <tbody>
2948     <tr>
2949       <td>In0</td>
2950       <td>In1</td>
2951       <td>Out</td>
2952     </tr>
2953     <tr>
2954       <td>0</td>
2955       <td>0</td>
2956       <td>0</td>
2957     </tr>
2958     <tr>
2959       <td>0</td>
2960       <td>1</td>
2961       <td>1</td>
2962     </tr>
2963     <tr>
2964       <td>1</td>
2965       <td>0</td>
2966       <td>1</td>
2967     </tr>
2968     <tr>
2969       <td>1</td>
2970       <td>1</td>
2971       <td>0</td>
2972     </tr>
2973   </tbody>
2974 </table>
2975 </div>
2976 <p> </p>
2977 <h5>Example:</h5>
2978 <pre>  &lt;result&gt; = xor i32 4, %var         <i>; yields {i32}:result = 4 ^ %var</i>
2979   &lt;result&gt; = xor i32 15, 40          <i>; yields {i32}:result = 39</i>
2980   &lt;result&gt; = xor i32 4, 8            <i>; yields {i32}:result = 12</i>
2981   &lt;result&gt; = xor i32 %V, -1          <i>; yields {i32}:result = ~%V</i>
2982 </pre>
2983 </div>
2984
2985 <!-- ======================================================================= -->
2986 <div class="doc_subsection">
2987   <a name="vectorops">Vector Operations</a>
2988 </div>
2989
2990 <div class="doc_text">
2991
2992 <p>LLVM supports several instructions to represent vector operations in a
2993 target-independent manner.  These instructions cover the element-access and
2994 vector-specific operations needed to process vectors effectively.  While LLVM
2995 does directly support these vector operations, many sophisticated algorithms
2996 will want to use target-specific intrinsics to take full advantage of a specific
2997 target.</p>
2998
2999 </div>
3000
3001 <!-- _______________________________________________________________________ -->
3002 <div class="doc_subsubsection">
3003    <a name="i_extractelement">'<tt>extractelement</tt>' Instruction</a>
3004 </div>
3005
3006 <div class="doc_text">
3007
3008 <h5>Syntax:</h5>
3009
3010 <pre>
3011   &lt;result&gt; = extractelement &lt;n x &lt;ty&gt;&gt; &lt;val&gt;, i32 &lt;idx&gt;    <i>; yields &lt;ty&gt;</i>
3012 </pre>
3013
3014 <h5>Overview:</h5>
3015
3016 <p>
3017 The '<tt>extractelement</tt>' instruction extracts a single scalar
3018 element from a vector at a specified index.
3019 </p>
3020
3021
3022 <h5>Arguments:</h5>
3023
3024 <p>
3025 The first operand of an '<tt>extractelement</tt>' instruction is a
3026 value of <a href="#t_vector">vector</a> type.  The second operand is
3027 an index indicating the position from which to extract the element.
3028 The index may be a variable.</p>
3029
3030 <h5>Semantics:</h5>
3031
3032 <p>
3033 The result is a scalar of the same type as the element type of
3034 <tt>val</tt>.  Its value is the value at position <tt>idx</tt> of
3035 <tt>val</tt>.  If <tt>idx</tt> exceeds the length of <tt>val</tt>, the
3036 results are undefined.
3037 </p>
3038
3039 <h5>Example:</h5>
3040
3041 <pre>
3042   %result = extractelement &lt;4 x i32&gt; %vec, i32 0    <i>; yields i32</i>
3043 </pre>
3044 </div>
3045
3046
3047 <!-- _______________________________________________________________________ -->
3048 <div class="doc_subsubsection">
3049    <a name="i_insertelement">'<tt>insertelement</tt>' Instruction</a>
3050 </div>
3051
3052 <div class="doc_text">
3053
3054 <h5>Syntax:</h5>
3055
3056 <pre>
3057   &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>
3058 </pre>
3059
3060 <h5>Overview:</h5>
3061
3062 <p>
3063 The '<tt>insertelement</tt>' instruction inserts a scalar
3064 element into a vector at a specified index.
3065 </p>
3066
3067
3068 <h5>Arguments:</h5>
3069
3070 <p>
3071 The first operand of an '<tt>insertelement</tt>' instruction is a
3072 value of <a href="#t_vector">vector</a> type.  The second operand is a
3073 scalar value whose type must equal the element type of the first
3074 operand.  The third operand is an index indicating the position at
3075 which to insert the value.  The index may be a variable.</p>
3076
3077 <h5>Semantics:</h5>
3078
3079 <p>
3080 The result is a vector of the same type as <tt>val</tt>.  Its
3081 element values are those of <tt>val</tt> except at position
3082 <tt>idx</tt>, where it gets the value <tt>elt</tt>.  If <tt>idx</tt>
3083 exceeds the length of <tt>val</tt>, the results are undefined.
3084 </p>
3085
3086 <h5>Example:</h5>
3087
3088 <pre>
3089   %result = insertelement &lt;4 x i32&gt; %vec, i32 1, i32 0    <i>; yields &lt;4 x i32&gt;</i>
3090 </pre>
3091 </div>
3092
3093 <!-- _______________________________________________________________________ -->
3094 <div class="doc_subsubsection">
3095    <a name="i_shufflevector">'<tt>shufflevector</tt>' Instruction</a>
3096 </div>
3097
3098 <div class="doc_text">
3099
3100 <h5>Syntax:</h5>
3101
3102 <pre>
3103   &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;m x i32&gt; &lt;mask&gt;    <i>; yields &lt;m x &lt;ty&gt;&gt;</i>
3104 </pre>
3105
3106 <h5>Overview:</h5>
3107
3108 <p>
3109 The '<tt>shufflevector</tt>' instruction constructs a permutation of elements
3110 from two input vectors, returning a vector with the same element type as
3111 the input and length that is the same as the shuffle mask.
3112 </p>
3113
3114 <h5>Arguments:</h5>
3115
3116 <p>
3117 The first two operands of a '<tt>shufflevector</tt>' instruction are vectors
3118 with types that match each other. The third argument is a shuffle mask whose
3119 element type is always 'i32'.  The result of the instruction is a vector whose
3120 length is the same as the shuffle mask and whose element type is the same as
3121 the element type of the first two operands.
3122 </p>
3123
3124 <p>
3125 The shuffle mask operand is required to be a constant vector with either
3126 constant integer or undef values.
3127 </p>
3128
3129 <h5>Semantics:</h5>
3130
3131 <p>
3132 The elements of the two input vectors are numbered from left to right across
3133 both of the vectors.  The shuffle mask operand specifies, for each element of
3134 the result vector, which element of the two input vectors the result element
3135 gets.  The element selector may be undef (meaning "don't care") and the second
3136 operand may be undef if performing a shuffle from only one vector.
3137 </p>
3138
3139 <h5>Example:</h5>
3140
3141 <pre>
3142   %result = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
3143                           &lt;4 x i32&gt; &lt;i32 0, i32 4, i32 1, i32 5&gt;  <i>; yields &lt;4 x i32&gt;</i>
3144   %result = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; undef,
3145                           &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.
3146   %result = shufflevector &lt;8 x i32&gt; %v1, &lt;8 x i32&gt; undef,
3147                           &lt;4 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3&gt;  <i>; yields &lt;4 x i32&gt;</i>
3148   %result = shufflevector &lt;4 x i32&gt; %v1, &lt;4 x i32&gt; %v2,
3149                           &lt;8 x i32&gt; &lt;i32 0, i32 1, i32 2, i32 3, i32 4, i32 5, i32 6, i32 7 &gt;  <i>; yields &lt;8 x i32&gt;</i>
3150 </pre>
3151 </div>
3152
3153
3154 <!-- ======================================================================= -->
3155 <div class="doc_subsection">
3156   <a name="aggregateops">Aggregate Operations</a>
3157 </div>
3158
3159 <div class="doc_text">
3160
3161 <p>LLVM supports several instructions for working with aggregate values.
3162 </p>
3163
3164 </div>
3165
3166 <!-- _______________________________________________________________________ -->
3167 <div class="doc_subsubsection">
3168    <a name="i_extractvalue">'<tt>extractvalue</tt>' Instruction</a>
3169 </div>
3170
3171 <div class="doc_text">
3172
3173 <h5>Syntax:</h5>
3174
3175 <pre>
3176   &lt;result&gt; = extractvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;idx&gt;{, &lt;idx&gt;}*
3177 </pre>
3178
3179 <h5>Overview:</h5>
3180
3181 <p>
3182 The '<tt>extractvalue</tt>' instruction extracts the value of a struct field
3183 or array element from an aggregate value.
3184 </p>
3185
3186
3187 <h5>Arguments:</h5>
3188
3189 <p>
3190 The first operand of an '<tt>extractvalue</tt>' instruction is a
3191 value of <a href="#t_struct">struct</a> or <a href="#t_array">array</a>
3192 type.  The operands are constant indices to specify which value to extract
3193 in a similar manner as indices in a
3194 '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
3195 </p>
3196
3197 <h5>Semantics:</h5>
3198
3199 <p>
3200 The result is the value at the position in the aggregate specified by
3201 the index operands.
3202 </p>
3203
3204 <h5>Example:</h5>
3205
3206 <pre>
3207   %result = extractvalue {i32, float} %agg, 0    <i>; yields i32</i>
3208 </pre>
3209 </div>
3210
3211
3212 <!-- _______________________________________________________________________ -->
3213 <div class="doc_subsubsection">
3214    <a name="i_insertvalue">'<tt>insertvalue</tt>' Instruction</a>
3215 </div>
3216
3217 <div class="doc_text">
3218
3219 <h5>Syntax:</h5>
3220
3221 <pre>
3222   &lt;result&gt; = insertvalue &lt;aggregate type&gt; &lt;val&gt;, &lt;ty&gt; &lt;val&gt;, &lt;idx&gt;    <i>; yields &lt;n x &lt;ty&gt;&gt;</i>
3223 </pre>
3224
3225 <h5>Overview:</h5>
3226
3227 <p>
3228 The '<tt>insertvalue</tt>' instruction inserts a value
3229 into a struct field or array element in an aggregate.
3230 </p>
3231
3232
3233 <h5>Arguments:</h5>
3234
3235 <p>
3236 The first operand of an '<tt>insertvalue</tt>' instruction is a
3237 value of <a href="#t_struct">struct</a> or <a href="#t_array">array</a> type.
3238 The second operand is a first-class value to insert.
3239 The following operands are constant indices
3240 indicating the position at which to insert the value in a similar manner as
3241 indices in a
3242 '<tt><a href="#i_getelementptr">getelementptr</a></tt>' instruction.
3243 The value to insert must have the same type as the value identified
3244 by the indices.
3245 </p>
3246
3247 <h5>Semantics:</h5>
3248
3249 <p>
3250 The result is an aggregate of the same type as <tt>val</tt>.  Its
3251 value is that of <tt>val</tt> except that the value at the position
3252 specified by the indices is that of <tt>elt</tt>.
3253 </p>
3254
3255 <h5>Example:</h5>
3256
3257 <pre>
3258   %result = insertvalue {i32, float} %agg, i32 1, 0    <i>; yields {i32, float}</i>
3259 </pre>
3260 </div>
3261
3262
3263 <!-- ======================================================================= -->
3264 <div class="doc_subsection">
3265   <a name="memoryops">Memory Access and Addressing Operations</a>
3266 </div>
3267
3268 <div class="doc_text">
3269
3270 <p>A key design point of an SSA-based representation is how it
3271 represents memory.  In LLVM, no memory locations are in SSA form, which
3272 makes things very simple.  This section describes how to read, write,
3273 allocate, and free memory in LLVM.</p>
3274
3275 </div>
3276
3277 <!-- _______________________________________________________________________ -->
3278 <div class="doc_subsubsection">
3279   <a name="i_malloc">'<tt>malloc</tt>' Instruction</a>
3280 </div>
3281
3282 <div class="doc_text">
3283
3284 <h5>Syntax:</h5>
3285
3286 <pre>
3287   &lt;result&gt; = malloc &lt;type&gt;[, i32 &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
3288 </pre>
3289
3290 <h5>Overview:</h5>
3291
3292 <p>The '<tt>malloc</tt>' instruction allocates memory from the system
3293 heap and returns a pointer to it. The object is always allocated in the generic
3294 address space (address space zero).</p>
3295
3296 <h5>Arguments:</h5>
3297
3298 <p>The '<tt>malloc</tt>' instruction allocates
3299 <tt>sizeof(&lt;type&gt;)*NumElements</tt>
3300 bytes of memory from the operating system and returns a pointer of the
3301 appropriate type to the program.  If "NumElements" is specified, it is the
3302 number of elements allocated, otherwise "NumElements" is defaulted to be one.
3303 If a constant alignment is specified, the value result of the allocation is guaranteed to
3304 be aligned to at least that boundary.  If not specified, or if zero, the target can
3305 choose to align the allocation on any convenient boundary.</p>
3306
3307 <p>'<tt>type</tt>' must be a sized type.</p>
3308
3309 <h5>Semantics:</h5>
3310
3311 <p>Memory is allocated using the system "<tt>malloc</tt>" function, and
3312 a pointer is returned.  The result of a zero byte allocation is undefined.  The
3313 result is null if there is insufficient memory available.</p>
3314
3315 <h5>Example:</h5>
3316
3317 <pre>
3318   %array  = malloc [4 x i8]                     <i>; yields {[%4 x i8]*}:array</i>
3319
3320   %size   = <a href="#i_add">add</a> i32 2, 2                        <i>; yields {i32}:size = i32 4</i>
3321   %array1 = malloc i8, i32 4                    <i>; yields {i8*}:array1</i>
3322   %array2 = malloc [12 x i8], i32 %size         <i>; yields {[12 x i8]*}:array2</i>
3323   %array3 = malloc i32, i32 4, align 1024       <i>; yields {i32*}:array3</i>
3324   %array4 = malloc i32, align 1024              <i>; yields {i32*}:array4</i>
3325 </pre>
3326
3327 <p>Note that the code generator does not yet respect the
3328    alignment value.</p>
3329
3330 </div>
3331
3332 <!-- _______________________________________________________________________ -->
3333 <div class="doc_subsubsection">
3334   <a name="i_free">'<tt>free</tt>' Instruction</a>
3335 </div>
3336
3337 <div class="doc_text">
3338
3339 <h5>Syntax:</h5>
3340
3341 <pre>
3342   free &lt;type&gt; &lt;value&gt;                           <i>; yields {void}</i>
3343 </pre>
3344
3345 <h5>Overview:</h5>
3346
3347 <p>The '<tt>free</tt>' instruction returns memory back to the unused
3348 memory heap to be reallocated in the future.</p>
3349
3350 <h5>Arguments:</h5>
3351
3352 <p>'<tt>value</tt>' shall be a pointer value that points to a value
3353 that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>'
3354 instruction.</p>
3355
3356 <h5>Semantics:</h5>
3357
3358 <p>Access to the memory pointed to by the pointer is no longer defined
3359 after this instruction executes.  If the pointer is null, the operation
3360 is a noop.</p>
3361
3362 <h5>Example:</h5>
3363
3364 <pre>
3365   %array  = <a href="#i_malloc">malloc</a> [4 x i8]                     <i>; yields {[4 x i8]*}:array</i>
3366             free   [4 x i8]* %array
3367 </pre>
3368 </div>
3369
3370 <!-- _______________________________________________________________________ -->
3371 <div class="doc_subsubsection">
3372   <a name="i_alloca">'<tt>alloca</tt>' Instruction</a>
3373 </div>
3374
3375 <div class="doc_text">
3376
3377 <h5>Syntax:</h5>
3378
3379 <pre>
3380   &lt;result&gt; = alloca &lt;type&gt;[, i32 &lt;NumElements&gt;][, align &lt;alignment&gt;]     <i>; yields {type*}:result</i>
3381 </pre>
3382
3383 <h5>Overview:</h5>
3384
3385 <p>The '<tt>alloca</tt>' instruction allocates memory on the stack frame of the
3386 currently executing function, to be automatically released when this function
3387 returns to its caller. The object is always allocated in the generic address
3388 space (address space zero).</p>
3389
3390 <h5>Arguments:</h5>
3391
3392 <p>The '<tt>alloca</tt>' instruction allocates <tt>sizeof(&lt;type&gt;)*NumElements</tt>
3393 bytes of memory on the runtime stack, returning a pointer of the
3394 appropriate type to the program.  If "NumElements" is specified, it is the
3395 number of elements allocated, otherwise "NumElements" is defaulted to be one.
3396 If a constant alignment is specified, the value result of the allocation is guaranteed
3397 to be aligned to at least that boundary.  If not specified, or if zero, the target
3398 can choose to align the allocation on any convenient boundary.</p>
3399
3400 <p>'<tt>type</tt>' may be any sized type.</p>
3401
3402 <h5>Semantics:</h5>
3403
3404 <p>Memory is allocated; a pointer is returned.  The operation is undefiend if
3405 there is insufficient stack space for the allocation.  '<tt>alloca</tt>'d
3406 memory is automatically released when the function returns.  The '<tt>alloca</tt>'
3407 instruction is commonly used to represent automatic variables that must
3408 have an address available.  When the function returns (either with the <tt><a
3409  href="#i_ret">ret</a></tt> or <tt><a href="#i_unwind">unwind</a></tt>
3410 instructions), the memory is reclaimed.  Allocating zero bytes
3411 is legal, but the result is undefined.</p>
3412
3413 <h5>Example:</h5>
3414
3415 <pre>
3416   %ptr = alloca i32                             <i>; yields {i32*}:ptr</i>
3417   %ptr = alloca i32, i32 4                      <i>; yields {i32*}:ptr</i>
3418   %ptr = alloca i32, i32 4, align 1024          <i>; yields {i32*}:ptr</i>
3419   %ptr = alloca i32, align 1024                 <i>; yields {i32*}:ptr</i>
3420 </pre>
3421 </div>
3422
3423 <!-- _______________________________________________________________________ -->
3424 <div class="doc_subsubsection"> <a name="i_load">'<tt>load</tt>'
3425 Instruction</a> </div>
3426 <div class="doc_text">
3427 <h5>Syntax:</h5>
3428 <pre>  &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;]<br>  &lt;result&gt; = volatile load &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;]<br></pre>
3429 <h5>Overview:</h5>
3430 <p>The '<tt>load</tt>' instruction is used to read from memory.</p>
3431 <h5>Arguments:</h5>
3432 <p>The argument to the '<tt>load</tt>' instruction specifies the memory
3433 address from which to load.  The pointer must point to a <a
3434  href="#t_firstclass">first class</a> type.  If the <tt>load</tt> is
3435 marked as <tt>volatile</tt>, then the optimizer is not allowed to modify
3436 the number or order of execution of this <tt>load</tt> with other
3437 volatile <tt>load</tt> and <tt><a href="#i_store">store</a></tt>
3438 instructions. </p>
3439 <p>
3440 The optional constant "align" argument specifies the alignment of the operation
3441 (that is, the alignment of the memory address). A value of 0 or an
3442 omitted "align" argument means that the operation has the preferential
3443 alignment for the target. It is the responsibility of the code emitter
3444 to ensure that the alignment information is correct. Overestimating
3445 the alignment results in an undefined behavior. Underestimating the
3446 alignment may produce less efficient code. An alignment of 1 is always
3447 safe.
3448 </p>
3449 <h5>Semantics:</h5>
3450 <p>The location of memory pointed to is loaded.</p>
3451 <h5>Examples:</h5>
3452 <pre>  %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
3453   <a
3454  href="#i_store">store</a> i32 3, i32* %ptr                          <i>; yields {void}</i>
3455   %val = load i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
3456 </pre>
3457 </div>
3458 <!-- _______________________________________________________________________ -->
3459 <div class="doc_subsubsection"> <a name="i_store">'<tt>store</tt>'
3460 Instruction</a> </div>
3461 <div class="doc_text">
3462 <h5>Syntax:</h5>
3463 <pre>  store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;]                   <i>; yields {void}</i>
3464   volatile store &lt;ty&gt; &lt;value&gt;, &lt;ty&gt;* &lt;pointer&gt;[, align &lt;alignment&gt;]          <i>; yields {void}</i>
3465 </pre>
3466 <h5>Overview:</h5>
3467 <p>The '<tt>store</tt>' instruction is used to write to memory.</p>
3468 <h5>Arguments:</h5>
3469 <p>There are two arguments to the '<tt>store</tt>' instruction: a value
3470 to store and an address at which to store it.  The type of the '<tt>&lt;pointer&gt;</tt>'
3471 operand must be a pointer to the <a href="#t_firstclass">first class</a> type
3472 of the '<tt>&lt;value&gt;</tt>'
3473 operand. If the <tt>store</tt> is marked as <tt>volatile</tt>, then the
3474 optimizer is not allowed to modify the number or order of execution of
3475 this <tt>store</tt> with other volatile <tt>load</tt> and <tt><a
3476  href="#i_store">store</a></tt> instructions.</p>
3477 <p>
3478 The optional constant "align" argument specifies the alignment of the operation
3479 (that is, the alignment of the memory address). A value of 0 or an
3480 omitted "align" argument means that the operation has the preferential
3481 alignment for the target. It is the responsibility of the code emitter
3482 to ensure that the alignment information is correct. Overestimating
3483 the alignment results in an undefined behavior. Underestimating the
3484 alignment may produce less efficient code. An alignment of 1 is always
3485 safe.
3486 </p>
3487 <h5>Semantics:</h5>
3488 <p>The contents of memory are updated to contain '<tt>&lt;value&gt;</tt>'
3489 at the location specified by the '<tt>&lt;pointer&gt;</tt>' operand.</p>
3490 <h5>Example:</h5>
3491 <pre>  %ptr = <a href="#i_alloca">alloca</a> i32                               <i>; yields {i32*}:ptr</i>
3492   store i32 3, i32* %ptr                          <i>; yields {void}</i>
3493   %val = <a href="#i_load">load</a> i32* %ptr                           <i>; yields {i32}:val = i32 3</i>
3494 </pre>
3495 </div>
3496
3497 <!-- _______________________________________________________________________ -->
3498 <div class="doc_subsubsection">
3499    <a name="i_getelementptr">'<tt>getelementptr</tt>' Instruction</a>
3500 </div>
3501
3502 <div class="doc_text">
3503 <h5>Syntax:</h5>
3504 <pre>
3505   &lt;result&gt; = getelementptr &lt;pty&gt;* &lt;ptrval&gt;{, &lt;ty&gt; &lt;idx&gt;}*
3506 </pre>
3507
3508 <h5>Overview:</h5>
3509
3510 <p>
3511 The '<tt>getelementptr</tt>' instruction is used to get the address of a
3512 subelement of an aggregate data structure. It performs address calculation only
3513 and does not access memory.</p>
3514
3515 <h5>Arguments:</h5>
3516
3517 <p>The first argument is always a pointer, and forms the basis of the
3518 calculation. The remaining arguments are indices, that indicate which of the
3519 elements of the aggregate object are indexed. The interpretation of each index
3520 is dependent on the type being indexed into. The first index always indexes the
3521 pointer value given as the first argument, the second index indexes a value of
3522 the type pointed to (not necessarily the value directly pointed to, since the
3523 first index can be non-zero), etc. The first type indexed into must be a pointer
3524 value, subsequent types can be arrays, vectors and structs. Note that subsequent
3525 types being indexed into can never be pointers, since that would require loading
3526 the pointer before continuing calculation.</p>
3527
3528 <p>The type of each index argument depends on the type it is indexing into.
3529 When indexing into a (packed) structure, only <tt>i32</tt> integer
3530 <b>constants</b> are allowed.  When indexing into an array, pointer or vector,
3531 only integers of 32 or 64 bits are allowed (also non-constants). 32-bit values
3532 will be sign extended to 64-bits if required.</p>
3533
3534 <p>For example, let's consider a C code fragment and how it gets
3535 compiled to LLVM:</p>
3536
3537 <div class="doc_code">
3538 <pre>
3539 struct RT {
3540   char A;
3541   int B[10][20];
3542   char C;
3543 };
3544 struct ST {
3545   int X;
3546   double Y;
3547   struct RT Z;
3548 };
3549
3550 int *foo(struct ST *s) {
3551   return &amp;s[1].Z.B[5][13];
3552 }
3553 </pre>
3554 </div>
3555
3556 <p>The LLVM code generated by the GCC frontend is:</p>
3557
3558 <div class="doc_code">
3559 <pre>
3560 %RT = <a href="#namedtypes">type</a> { i8 , [10 x [20 x i32]], i8  }
3561 %ST = <a href="#namedtypes">type</a> { i32, double, %RT }
3562
3563 define i32* %foo(%ST* %s) {
3564 entry:
3565   %reg = getelementptr %ST* %s, i32 1, i32 2, i32 1, i32 5, i32 13
3566   ret i32* %reg
3567 }
3568 </pre>
3569 </div>
3570
3571 <h5>Semantics:</h5>
3572
3573 <p>In the example above, the first index is indexing into the '<tt>%ST*</tt>'
3574 type, which is a pointer, yielding a '<tt>%ST</tt>' = '<tt>{ i32, double, %RT
3575 }</tt>' type, a structure.  The second index indexes into the third element of
3576 the structure, yielding a '<tt>%RT</tt>' = '<tt>{ i8 , [10 x [20 x i32]],
3577 i8  }</tt>' type, another structure.  The third index indexes into the second
3578 element of the structure, yielding a '<tt>[10 x [20 x i32]]</tt>' type, an
3579 array.  The two dimensions of the array are subscripted into, yielding an
3580 '<tt>i32</tt>' type.  The '<tt>getelementptr</tt>' instruction returns a pointer
3581 to this element, thus computing a value of '<tt>i32*</tt>' type.</p>
3582
3583 <p>Note that it is perfectly legal to index partially through a
3584 structure, returning a pointer to an inner element.  Because of this,
3585 the LLVM code for the given testcase is equivalent to:</p>
3586
3587 <pre>
3588   define i32* %foo(%ST* %s) {
3589     %t1 = getelementptr %ST* %s, i32 1                        <i>; yields %ST*:%t1</i>
3590     %t2 = getelementptr %ST* %t1, i32 0, i32 2                <i>; yields %RT*:%t2</i>
3591     %t3 = getelementptr %RT* %t2, i32 0, i32 1                <i>; yields [10 x [20 x i32]]*:%t3</i>
3592     %t4 = getelementptr [10 x [20 x i32]]* %t3, i32 0, i32 5  <i>; yields [20 x i32]*:%t4</i>
3593     %t5 = getelementptr [20 x i32]* %t4, i32 0, i32 13        <i>; yields i32*:%t5</i>
3594     ret i32* %t5
3595   }
3596 </pre>
3597
3598 <p>Note that it is undefined to access an array out of bounds: array and
3599 pointer indexes must always be within the defined bounds of the array type.
3600 The one exception for this rule is zero length arrays.  These arrays are
3601 defined to be accessible as variable length arrays, which requires access
3602 beyond the zero'th element.</p>
3603
3604 <p>The getelementptr instruction is often confusing.  For some more insight
3605 into how it works, see <a href="GetElementPtr.html">the getelementptr
3606 FAQ</a>.</p>
3607
3608 <h5>Example:</h5>
3609
3610 <pre>
3611     <i>; yields [12 x i8]*:aptr</i>
3612     %aptr = getelementptr {i32, [12 x i8]}* %saptr, i64 0, i32 1
3613     <i>; yields i8*:vptr</i>
3614     %vptr = getelementptr {i32, &lt;2 x i8&gt;}* %svptr, i64 0, i32 1, i32 1
3615     <i>; yields i8*:eptr</i>
3616     %eptr = getelementptr [12 x i8]* %aptr, i64 0, i32 1
3617 </pre>
3618 </div>
3619
3620 <!-- ======================================================================= -->
3621 <div class="doc_subsection"> <a name="convertops">Conversion Operations</a>
3622 </div>
3623 <div class="doc_text">
3624 <p>The instructions in this category are the conversion instructions (casting)
3625 which all take a single operand and a type. They perform various bit conversions
3626 on the operand.</p>
3627 </div>
3628
3629 <!-- _______________________________________________________________________ -->
3630 <div class="doc_subsubsection">
3631    <a name="i_trunc">'<tt>trunc .. to</tt>' Instruction</a>
3632 </div>
3633 <div class="doc_text">
3634
3635 <h5>Syntax:</h5>
3636 <pre>
3637   &lt;result&gt; = trunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3638 </pre>
3639
3640 <h5>Overview:</h5>
3641 <p>
3642 The '<tt>trunc</tt>' instruction truncates its operand to the type <tt>ty2</tt>.
3643 </p>
3644
3645 <h5>Arguments:</h5>
3646 <p>
3647 The '<tt>trunc</tt>' instruction takes a <tt>value</tt> to trunc, which must
3648 be an <a href="#t_integer">integer</a> type, and a type that specifies the size
3649 and type of the result, which must be an <a href="#t_integer">integer</a>
3650 type. The bit size of <tt>value</tt> must be larger than the bit size of
3651 <tt>ty2</tt>. Equal sized types are not allowed.</p>
3652
3653 <h5>Semantics:</h5>
3654 <p>
3655 The '<tt>trunc</tt>' instruction truncates the high order bits in <tt>value</tt>
3656 and converts the remaining bits to <tt>ty2</tt>. Since the source size must be
3657 larger than the destination size, <tt>trunc</tt> cannot be a <i>no-op cast</i>.
3658 It will always truncate bits.</p>
3659
3660 <h5>Example:</h5>
3661 <pre>
3662   %X = trunc i32 257 to i8              <i>; yields i8:1</i>
3663   %Y = trunc i32 123 to i1              <i>; yields i1:true</i>
3664   %Y = trunc i32 122 to i1              <i>; yields i1:false</i>
3665 </pre>
3666 </div>
3667
3668 <!-- _______________________________________________________________________ -->
3669 <div class="doc_subsubsection">
3670    <a name="i_zext">'<tt>zext .. to</tt>' Instruction</a>
3671 </div>
3672 <div class="doc_text">
3673
3674 <h5>Syntax:</h5>
3675 <pre>
3676   &lt;result&gt; = zext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3677 </pre>
3678
3679 <h5>Overview:</h5>
3680 <p>The '<tt>zext</tt>' instruction zero extends its operand to type
3681 <tt>ty2</tt>.</p>
3682
3683
3684 <h5>Arguments:</h5>
3685 <p>The '<tt>zext</tt>' instruction takes a value to cast, which must be of
3686 <a href="#t_integer">integer</a> type, and a type to cast it to, which must
3687 also be of <a href="#t_integer">integer</a> type. The bit size of the
3688 <tt>value</tt> must be smaller than the bit size of the destination type,
3689 <tt>ty2</tt>.</p>
3690
3691 <h5>Semantics:</h5>
3692 <p>The <tt>zext</tt> fills the high order bits of the <tt>value</tt> with zero
3693 bits until it reaches the size of the destination type, <tt>ty2</tt>.</p>
3694
3695 <p>When zero extending from i1, the result will always be either 0 or 1.</p>
3696
3697 <h5>Example:</h5>
3698 <pre>
3699   %X = zext i32 257 to i64              <i>; yields i64:257</i>
3700   %Y = zext i1 true to i32              <i>; yields i32:1</i>
3701 </pre>
3702 </div>
3703
3704 <!-- _______________________________________________________________________ -->
3705 <div class="doc_subsubsection">
3706    <a name="i_sext">'<tt>sext .. to</tt>' Instruction</a>
3707 </div>
3708 <div class="doc_text">
3709
3710 <h5>Syntax:</h5>
3711 <pre>
3712   &lt;result&gt; = sext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3713 </pre>
3714
3715 <h5>Overview:</h5>
3716 <p>The '<tt>sext</tt>' sign extends <tt>value</tt> to the type <tt>ty2</tt>.</p>
3717
3718 <h5>Arguments:</h5>
3719 <p>
3720 The '<tt>sext</tt>' instruction takes a value to cast, which must be of
3721 <a href="#t_integer">integer</a> type, and a type to cast it to, which must
3722 also be of <a href="#t_integer">integer</a> type.  The bit size of the
3723 <tt>value</tt> must be smaller than the bit size of the destination type,
3724 <tt>ty2</tt>.</p>
3725
3726 <h5>Semantics:</h5>
3727 <p>
3728 The '<tt>sext</tt>' instruction performs a sign extension by copying the sign
3729 bit (highest order bit) of the <tt>value</tt> until it reaches the bit size of
3730 the type <tt>ty2</tt>.</p>
3731
3732 <p>When sign extending from i1, the extension always results in -1 or 0.</p>
3733
3734 <h5>Example:</h5>
3735 <pre>
3736   %X = sext i8  -1 to i16              <i>; yields i16   :65535</i>
3737   %Y = sext i1 true to i32             <i>; yields i32:-1</i>
3738 </pre>
3739 </div>
3740
3741 <!-- _______________________________________________________________________ -->
3742 <div class="doc_subsubsection">
3743    <a name="i_fptrunc">'<tt>fptrunc .. to</tt>' Instruction</a>
3744 </div>
3745
3746 <div class="doc_text">
3747
3748 <h5>Syntax:</h5>
3749
3750 <pre>
3751   &lt;result&gt; = fptrunc &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3752 </pre>
3753
3754 <h5>Overview:</h5>
3755 <p>The '<tt>fptrunc</tt>' instruction truncates <tt>value</tt> to type
3756 <tt>ty2</tt>.</p>
3757
3758
3759 <h5>Arguments:</h5>
3760 <p>The '<tt>fptrunc</tt>' instruction takes a <a href="#t_floating">floating
3761   point</a> value to cast and a <a href="#t_floating">floating point</a> type to
3762 cast it to. The size of <tt>value</tt> must be larger than the size of
3763 <tt>ty2</tt>. This implies that <tt>fptrunc</tt> cannot be used to make a
3764 <i>no-op cast</i>.</p>
3765
3766 <h5>Semantics:</h5>
3767 <p> The '<tt>fptrunc</tt>' instruction truncates a <tt>value</tt> from a larger
3768 <a href="#t_floating">floating point</a> type to a smaller
3769 <a href="#t_floating">floating point</a> type.  If the value cannot fit within
3770 the destination type, <tt>ty2</tt>, then the results are undefined.</p>
3771
3772 <h5>Example:</h5>
3773 <pre>
3774   %X = fptrunc double 123.0 to float         <i>; yields float:123.0</i>
3775   %Y = fptrunc double 1.0E+300 to float      <i>; yields undefined</i>
3776 </pre>
3777 </div>
3778
3779 <!-- _______________________________________________________________________ -->
3780 <div class="doc_subsubsection">
3781    <a name="i_fpext">'<tt>fpext .. to</tt>' Instruction</a>
3782 </div>
3783 <div class="doc_text">
3784
3785 <h5>Syntax:</h5>
3786 <pre>
3787   &lt;result&gt; = fpext &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3788 </pre>
3789
3790 <h5>Overview:</h5>
3791 <p>The '<tt>fpext</tt>' extends a floating point <tt>value</tt> to a larger
3792 floating point value.</p>
3793
3794 <h5>Arguments:</h5>
3795 <p>The '<tt>fpext</tt>' instruction takes a
3796 <a href="#t_floating">floating point</a> <tt>value</tt> to cast,
3797 and a <a href="#t_floating">floating point</a> type to cast it to. The source
3798 type must be smaller than the destination type.</p>
3799
3800 <h5>Semantics:</h5>
3801 <p>The '<tt>fpext</tt>' instruction extends the <tt>value</tt> from a smaller
3802 <a href="#t_floating">floating point</a> type to a larger
3803 <a href="#t_floating">floating point</a> type. The <tt>fpext</tt> cannot be
3804 used to make a <i>no-op cast</i> because it always changes bits. Use
3805 <tt>bitcast</tt> to make a <i>no-op cast</i> for a floating point cast.</p>
3806
3807 <h5>Example:</h5>
3808 <pre>
3809   %X = fpext float 3.1415 to double        <i>; yields double:3.1415</i>
3810   %Y = fpext float 1.0 to float            <i>; yields float:1.0 (no-op)</i>
3811 </pre>
3812 </div>
3813
3814 <!-- _______________________________________________________________________ -->
3815 <div class="doc_subsubsection">
3816    <a name="i_fptoui">'<tt>fptoui .. to</tt>' Instruction</a>
3817 </div>
3818 <div class="doc_text">
3819
3820 <h5>Syntax:</h5>
3821 <pre>
3822   &lt;result&gt; = fptoui &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3823 </pre>
3824
3825 <h5>Overview:</h5>
3826 <p>The '<tt>fptoui</tt>' converts a floating point <tt>value</tt> to its
3827 unsigned integer equivalent of type <tt>ty2</tt>.
3828 </p>
3829
3830 <h5>Arguments:</h5>
3831 <p>The '<tt>fptoui</tt>' instruction takes a value to cast, which must be a
3832 scalar or vector <a href="#t_floating">floating point</a> value, and a type
3833 to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
3834 type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
3835 vector integer type with the same number of elements as <tt>ty</tt></p>
3836
3837 <h5>Semantics:</h5>
3838 <p> The '<tt>fptoui</tt>' instruction converts its
3839 <a href="#t_floating">floating point</a> operand into the nearest (rounding
3840 towards zero) unsigned integer value. If the value cannot fit in <tt>ty2</tt>,
3841 the results are undefined.</p>
3842
3843 <h5>Example:</h5>
3844 <pre>
3845   %X = fptoui double 123.0 to i32      <i>; yields i32:123</i>
3846   %Y = fptoui float 1.0E+300 to i1     <i>; yields undefined:1</i>
3847   %X = fptoui float 1.04E+17 to i8     <i>; yields undefined:1</i>
3848 </pre>
3849 </div>
3850
3851 <!-- _______________________________________________________________________ -->
3852 <div class="doc_subsubsection">
3853    <a name="i_fptosi">'<tt>fptosi .. to</tt>' Instruction</a>
3854 </div>
3855 <div class="doc_text">
3856
3857 <h5>Syntax:</h5>
3858 <pre>
3859   &lt;result&gt; = fptosi &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3860 </pre>
3861
3862 <h5>Overview:</h5>
3863 <p>The '<tt>fptosi</tt>' instruction converts
3864 <a href="#t_floating">floating point</a> <tt>value</tt> to type <tt>ty2</tt>.
3865 </p>
3866
3867 <h5>Arguments:</h5>
3868 <p> The '<tt>fptosi</tt>' instruction takes a value to cast, which must be a
3869 scalar or vector <a href="#t_floating">floating point</a> value, and a type
3870 to cast it to <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a>
3871 type. If <tt>ty</tt> is a vector floating point type, <tt>ty2</tt> must be a
3872 vector integer type with the same number of elements as <tt>ty</tt></p>
3873
3874 <h5>Semantics:</h5>
3875 <p>The '<tt>fptosi</tt>' instruction converts its
3876 <a href="#t_floating">floating point</a> operand into the nearest (rounding
3877 towards zero) signed integer value. If the value cannot fit in <tt>ty2</tt>,
3878 the results are undefined.</p>
3879
3880 <h5>Example:</h5>
3881 <pre>
3882   %X = fptosi double -123.0 to i32      <i>; yields i32:-123</i>
3883   %Y = fptosi float 1.0E-247 to i1      <i>; yields undefined:1</i>
3884   %X = fptosi float 1.04E+17 to i8      <i>; yields undefined:1</i>
3885 </pre>
3886 </div>
3887
3888 <!-- _______________________________________________________________________ -->
3889 <div class="doc_subsubsection">
3890    <a name="i_uitofp">'<tt>uitofp .. to</tt>' Instruction</a>
3891 </div>
3892 <div class="doc_text">
3893
3894 <h5>Syntax:</h5>
3895 <pre>
3896   &lt;result&gt; = uitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3897 </pre>
3898
3899 <h5>Overview:</h5>
3900 <p>The '<tt>uitofp</tt>' instruction regards <tt>value</tt> as an unsigned
3901 integer and converts that value to the <tt>ty2</tt> type.</p>
3902
3903 <h5>Arguments:</h5>
3904 <p>The '<tt>uitofp</tt>' instruction takes a value to cast, which must be a
3905 scalar or vector <a href="#t_integer">integer</a> value, and a type to cast it
3906 to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
3907 type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
3908 floating point type with the same number of elements as <tt>ty</tt></p>
3909
3910 <h5>Semantics:</h5>
3911 <p>The '<tt>uitofp</tt>' instruction interprets its operand as an unsigned
3912 integer quantity and converts it to the corresponding floating point value. If
3913 the value cannot fit in the floating point value, the results are undefined.</p>
3914
3915 <h5>Example:</h5>
3916 <pre>
3917   %X = uitofp i32 257 to float         <i>; yields float:257.0</i>
3918   %Y = uitofp i8 -1 to double          <i>; yields double:255.0</i>
3919 </pre>
3920 </div>
3921
3922 <!-- _______________________________________________________________________ -->
3923 <div class="doc_subsubsection">
3924    <a name="i_sitofp">'<tt>sitofp .. to</tt>' Instruction</a>
3925 </div>
3926 <div class="doc_text">
3927
3928 <h5>Syntax:</h5>
3929 <pre>
3930   &lt;result&gt; = sitofp &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3931 </pre>
3932
3933 <h5>Overview:</h5>
3934 <p>The '<tt>sitofp</tt>' instruction regards <tt>value</tt> as a signed
3935 integer and converts that value to the <tt>ty2</tt> type.</p>
3936
3937 <h5>Arguments:</h5>
3938 <p>The '<tt>sitofp</tt>' instruction takes a value to cast, which must be a
3939 scalar or vector <a href="#t_integer">integer</a> value, and a type to cast it
3940 to <tt>ty2</tt>, which must be an <a href="#t_floating">floating point</a>
3941 type. If <tt>ty</tt> is a vector integer type, <tt>ty2</tt> must be a vector
3942 floating point type with the same number of elements as <tt>ty</tt></p>
3943
3944 <h5>Semantics:</h5>
3945 <p>The '<tt>sitofp</tt>' instruction interprets its operand as a signed
3946 integer quantity and converts it to the corresponding floating point value. If
3947 the value cannot fit in the floating point value, the results are undefined.</p>
3948
3949 <h5>Example:</h5>
3950 <pre>
3951   %X = sitofp i32 257 to float         <i>; yields float:257.0</i>
3952   %Y = sitofp i8 -1 to double          <i>; yields double:-1.0</i>
3953 </pre>
3954 </div>
3955
3956 <!-- _______________________________________________________________________ -->
3957 <div class="doc_subsubsection">
3958    <a name="i_ptrtoint">'<tt>ptrtoint .. to</tt>' Instruction</a>
3959 </div>
3960 <div class="doc_text">
3961
3962 <h5>Syntax:</h5>
3963 <pre>
3964   &lt;result&gt; = ptrtoint &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
3965 </pre>
3966
3967 <h5>Overview:</h5>
3968 <p>The '<tt>ptrtoint</tt>' instruction converts the pointer <tt>value</tt> to
3969 the integer type <tt>ty2</tt>.</p>
3970
3971 <h5>Arguments:</h5>
3972 <p>The '<tt>ptrtoint</tt>' instruction takes a <tt>value</tt> to cast, which
3973 must be a <a href="#t_pointer">pointer</a> value, and a type to cast it to
3974 <tt>ty2</tt>, which must be an <a href="#t_integer">integer</a> type.</p>
3975
3976 <h5>Semantics:</h5>
3977 <p>The '<tt>ptrtoint</tt>' instruction converts <tt>value</tt> to integer type
3978 <tt>ty2</tt> by interpreting the pointer value as an integer and either
3979 truncating or zero extending that value to the size of the integer type. If
3980 <tt>value</tt> is smaller than <tt>ty2</tt> then a zero extension is done. If
3981 <tt>value</tt> is larger than <tt>ty2</tt> then a truncation is done. If they
3982 are the same size, then nothing is done (<i>no-op cast</i>) other than a type
3983 change.</p>
3984
3985 <h5>Example:</h5>
3986 <pre>
3987   %X = ptrtoint i32* %X to i8           <i>; yields truncation on 32-bit architecture</i>
3988   %Y = ptrtoint i32* %x to i64          <i>; yields zero extension on 32-bit architecture</i>
3989 </pre>
3990 </div>
3991
3992 <!-- _______________________________________________________________________ -->
3993 <div class="doc_subsubsection">
3994    <a name="i_inttoptr">'<tt>inttoptr .. to</tt>' Instruction</a>
3995 </div>
3996 <div class="doc_text">
3997
3998 <h5>Syntax:</h5>
3999 <pre>
4000   &lt;result&gt; = inttoptr &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4001 </pre>
4002
4003 <h5>Overview:</h5>
4004 <p>The '<tt>inttoptr</tt>' instruction converts an integer <tt>value</tt> to
4005 a pointer type, <tt>ty2</tt>.</p>
4006
4007 <h5>Arguments:</h5>
4008 <p>The '<tt>inttoptr</tt>' instruction takes an <a href="#t_integer">integer</a>
4009 value to cast, and a type to cast it to, which must be a
4010 <a href="#t_pointer">pointer</a> type.</p>
4011
4012 <h5>Semantics:</h5>
4013 <p>The '<tt>inttoptr</tt>' instruction converts <tt>value</tt> to type
4014 <tt>ty2</tt> by applying either a zero extension or a truncation depending on
4015 the size of the integer <tt>value</tt>. If <tt>value</tt> is larger than the
4016 size of a pointer then a truncation is done. If <tt>value</tt> is smaller than
4017 the size of a pointer then a zero extension is done. If they are the same size,
4018 nothing is done (<i>no-op cast</i>).</p>
4019
4020 <h5>Example:</h5>
4021 <pre>
4022   %X = inttoptr i32 255 to i32*          <i>; yields zero extension on 64-bit architecture</i>
4023   %X = inttoptr i32 255 to i32*          <i>; yields no-op on 32-bit architecture</i>
4024   %Y = inttoptr i64 0 to i32*            <i>; yields truncation on 32-bit architecture</i>
4025 </pre>
4026 </div>
4027
4028 <!-- _______________________________________________________________________ -->
4029 <div class="doc_subsubsection">
4030    <a name="i_bitcast">'<tt>bitcast .. to</tt>' Instruction</a>
4031 </div>
4032 <div class="doc_text">
4033
4034 <h5>Syntax:</h5>
4035 <pre>
4036   &lt;result&gt; = bitcast &lt;ty&gt; &lt;value&gt; to &lt;ty2&gt;             <i>; yields ty2</i>
4037 </pre>
4038
4039 <h5>Overview:</h5>
4040
4041 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4042 <tt>ty2</tt> without changing any bits.</p>
4043
4044 <h5>Arguments:</h5>
4045
4046 <p>The '<tt>bitcast</tt>' instruction takes a value to cast, which must be
4047 a non-aggregate first class value, and a type to cast it to, which must also be
4048 a non-aggregate <a href="#t_firstclass">first class</a> type. The bit sizes of
4049 <tt>value</tt>
4050 and the destination type, <tt>ty2</tt>, must be identical. If the source
4051 type is a pointer, the destination type must also be a pointer.  This
4052 instruction supports bitwise conversion of vectors to integers and to vectors
4053 of other types (as long as they have the same size).</p>
4054
4055 <h5>Semantics:</h5>
4056 <p>The '<tt>bitcast</tt>' instruction converts <tt>value</tt> to type
4057 <tt>ty2</tt>. It is always a <i>no-op cast</i> because no bits change with
4058 this conversion.  The conversion is done as if the <tt>value</tt> had been
4059 stored to memory and read back as type <tt>ty2</tt>. Pointer types may only be
4060 converted to other pointer types with this instruction. To convert pointers to
4061 other types, use the <a href="#i_inttoptr">inttoptr</a> or
4062 <a href="#i_ptrtoint">ptrtoint</a> instructions first.</p>
4063
4064 <h5>Example:</h5>
4065 <pre>
4066   %X = bitcast i8 255 to i8              <i>; yields i8 :-1</i>
4067   %Y = bitcast i32* %x to sint*          <i>; yields sint*:%x</i>
4068   %Z = bitcast &lt;2 x int&gt; %V to i64;      <i>; yields i64: %V</i>
4069 </pre>
4070 </div>
4071
4072 <!-- ======================================================================= -->
4073 <div class="doc_subsection"> <a name="otherops">Other Operations</a> </div>
4074 <div class="doc_text">
4075 <p>The instructions in this category are the "miscellaneous"
4076 instructions, which defy better classification.</p>
4077 </div>
4078
4079 <!-- _______________________________________________________________________ -->
4080 <div class="doc_subsubsection"><a name="i_icmp">'<tt>icmp</tt>' Instruction</a>
4081 </div>
4082 <div class="doc_text">
4083 <h5>Syntax:</h5>
4084 <pre>  &lt;result&gt; = icmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {i1} or {&lt;N x i1&gt;}:result</i>
4085 </pre>
4086 <h5>Overview:</h5>
4087 <p>The '<tt>icmp</tt>' instruction returns a boolean value or
4088 a vector of boolean values based on comparison
4089 of its two integer, integer vector, or pointer operands.</p>
4090 <h5>Arguments:</h5>
4091 <p>The '<tt>icmp</tt>' instruction takes three operands. The first operand is
4092 the condition code indicating the kind of comparison to perform. It is not
4093 a value, just a keyword. The possible condition code are:
4094 </p>
4095 <ol>
4096   <li><tt>eq</tt>: equal</li>
4097   <li><tt>ne</tt>: not equal </li>
4098   <li><tt>ugt</tt>: unsigned greater than</li>
4099   <li><tt>uge</tt>: unsigned greater or equal</li>
4100   <li><tt>ult</tt>: unsigned less than</li>
4101   <li><tt>ule</tt>: unsigned less or equal</li>
4102   <li><tt>sgt</tt>: signed greater than</li>
4103   <li><tt>sge</tt>: signed greater or equal</li>
4104   <li><tt>slt</tt>: signed less than</li>
4105   <li><tt>sle</tt>: signed less or equal</li>
4106 </ol>
4107 <p>The remaining two arguments must be <a href="#t_integer">integer</a> or
4108 <a href="#t_pointer">pointer</a>
4109 or integer <a href="#t_vector">vector</a> typed.
4110 They must also be identical types.</p>
4111 <h5>Semantics:</h5>
4112 <p>The '<tt>icmp</tt>' compares <tt>op1</tt> and <tt>op2</tt> according to
4113 the condition code given as <tt>cond</tt>. The comparison performed always
4114 yields either an <a href="#t_primitive"><tt>i1</tt></a> or vector of <tt>i1</tt> result, as follows:
4115 </p>
4116 <ol>
4117   <li><tt>eq</tt>: yields <tt>true</tt> if the operands are equal,
4118   <tt>false</tt> otherwise. No sign interpretation is necessary or performed.
4119   </li>
4120   <li><tt>ne</tt>: yields <tt>true</tt> if the operands are unequal,
4121   <tt>false</tt> otherwise. No sign interpretation is necessary or performed.</li>
4122   <li><tt>ugt</tt>: interprets the operands as unsigned values and yields
4123   <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
4124   <li><tt>uge</tt>: interprets the operands as unsigned values and yields
4125   <tt>true</tt> if <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
4126   <li><tt>ult</tt>: interprets the operands as unsigned values and yields
4127   <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
4128   <li><tt>ule</tt>: interprets the operands as unsigned values and yields
4129   <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
4130   <li><tt>sgt</tt>: interprets the operands as signed values and yields
4131   <tt>true</tt> if <tt>op1</tt> is greater than <tt>op2</tt>.</li>
4132   <li><tt>sge</tt>: interprets the operands as signed values and yields
4133   <tt>true</tt> if <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
4134   <li><tt>slt</tt>: interprets the operands as signed values and yields
4135   <tt>true</tt> if <tt>op1</tt> is less than <tt>op2</tt>.</li>
4136   <li><tt>sle</tt>: interprets the operands as signed values and yields
4137   <tt>true</tt> if <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
4138 </ol>
4139 <p>If the operands are <a href="#t_pointer">pointer</a> typed, the pointer
4140 values are compared as if they were integers.</p>
4141 <p>If the operands are integer vectors, then they are compared
4142 element by element. The result is an <tt>i1</tt> vector with
4143 the same number of elements as the values being compared.
4144 Otherwise, the result is an <tt>i1</tt>.
4145 </p>
4146
4147 <h5>Example:</h5>
4148 <pre>  &lt;result&gt; = icmp eq i32 4, 5          <i>; yields: result=false</i>
4149   &lt;result&gt; = icmp ne float* %X, %X     <i>; yields: result=false</i>
4150   &lt;result&gt; = icmp ult i16  4, 5        <i>; yields: result=true</i>
4151   &lt;result&gt; = icmp sgt i16  4, 5        <i>; yields: result=false</i>
4152   &lt;result&gt; = icmp ule i16 -4, 5        <i>; yields: result=false</i>
4153   &lt;result&gt; = icmp sge i16  4, 5        <i>; yields: result=false</i>
4154 </pre>
4155
4156 <p>Note that the code generator does not yet support vector types with
4157    the <tt>icmp</tt> instruction.</p>
4158
4159 </div>
4160
4161 <!-- _______________________________________________________________________ -->
4162 <div class="doc_subsubsection"><a name="i_fcmp">'<tt>fcmp</tt>' Instruction</a>
4163 </div>
4164 <div class="doc_text">
4165 <h5>Syntax:</h5>
4166 <pre>  &lt;result&gt; = fcmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;     <i>; yields {i1} or {&lt;N x i1&gt;}:result</i>
4167 </pre>
4168 <h5>Overview:</h5>
4169 <p>The '<tt>fcmp</tt>' instruction returns a boolean value
4170 or vector of boolean values based on comparison
4171 of its operands.</p>
4172 <p>
4173 If the operands are floating point scalars, then the result
4174 type is a boolean (<a href="#t_primitive"><tt>i1</tt></a>).
4175 </p>
4176 <p>If the operands are floating point vectors, then the result type
4177 is a vector of boolean with the same number of elements as the
4178 operands being compared.</p>
4179 <h5>Arguments:</h5>
4180 <p>The '<tt>fcmp</tt>' instruction takes three operands. The first operand is
4181 the condition code indicating the kind of comparison to perform. It is not
4182 a value, just a keyword. The possible condition code are:</p>
4183 <ol>
4184   <li><tt>false</tt>: no comparison, always returns false</li>
4185   <li><tt>oeq</tt>: ordered and equal</li>
4186   <li><tt>ogt</tt>: ordered and greater than </li>
4187   <li><tt>oge</tt>: ordered and greater than or equal</li>
4188   <li><tt>olt</tt>: ordered and less than </li>
4189   <li><tt>ole</tt>: ordered and less than or equal</li>
4190   <li><tt>one</tt>: ordered and not equal</li>
4191   <li><tt>ord</tt>: ordered (no nans)</li>
4192   <li><tt>ueq</tt>: unordered or equal</li>
4193   <li><tt>ugt</tt>: unordered or greater than </li>
4194   <li><tt>uge</tt>: unordered or greater than or equal</li>
4195   <li><tt>ult</tt>: unordered or less than </li>
4196   <li><tt>ule</tt>: unordered or less than or equal</li>
4197   <li><tt>une</tt>: unordered or not equal</li>
4198   <li><tt>uno</tt>: unordered (either nans)</li>
4199   <li><tt>true</tt>: no comparison, always returns true</li>
4200 </ol>
4201 <p><i>Ordered</i> means that neither operand is a QNAN while
4202 <i>unordered</i> means that either operand may be a QNAN.</p>
4203 <p>Each of <tt>val1</tt> and <tt>val2</tt> arguments must be
4204 either a <a href="#t_floating">floating point</a> type
4205 or a <a href="#t_vector">vector</a> of floating point type.
4206 They must have identical types.</p>
4207 <h5>Semantics:</h5>
4208 <p>The '<tt>fcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
4209 according to the condition code given as <tt>cond</tt>.
4210 If the operands are vectors, then the vectors are compared
4211 element by element.
4212 Each comparison performed
4213 always yields an <a href="#t_primitive">i1</a> result, as follows:</p>
4214 <ol>
4215   <li><tt>false</tt>: always yields <tt>false</tt>, regardless of operands.</li>
4216   <li><tt>oeq</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4217   <tt>op1</tt> is equal to <tt>op2</tt>.</li>
4218   <li><tt>ogt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4219   <tt>op1</tt> is greather than <tt>op2</tt>.</li>
4220   <li><tt>oge</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4221   <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
4222   <li><tt>olt</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4223   <tt>op1</tt> is less than <tt>op2</tt>.</li>
4224   <li><tt>ole</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4225   <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
4226   <li><tt>one</tt>: yields <tt>true</tt> if both operands are not a QNAN and
4227   <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
4228   <li><tt>ord</tt>: yields <tt>true</tt> if both operands are not a QNAN.</li>
4229   <li><tt>ueq</tt>: yields <tt>true</tt> if either operand is a QNAN or
4230   <tt>op1</tt> is equal to <tt>op2</tt>.</li>
4231   <li><tt>ugt</tt>: yields <tt>true</tt> if either operand is a QNAN or
4232   <tt>op1</tt> is greater than <tt>op2</tt>.</li>
4233   <li><tt>uge</tt>: yields <tt>true</tt> if either operand is a QNAN or
4234   <tt>op1</tt> is greater than or equal to <tt>op2</tt>.</li>
4235   <li><tt>ult</tt>: yields <tt>true</tt> if either operand is a QNAN or
4236   <tt>op1</tt> is less than <tt>op2</tt>.</li>
4237   <li><tt>ule</tt>: yields <tt>true</tt> if either operand is a QNAN or
4238   <tt>op1</tt> is less than or equal to <tt>op2</tt>.</li>
4239   <li><tt>une</tt>: yields <tt>true</tt> if either operand is a QNAN or
4240   <tt>op1</tt> is not equal to <tt>op2</tt>.</li>
4241   <li><tt>uno</tt>: yields <tt>true</tt> if either operand is a QNAN.</li>
4242   <li><tt>true</tt>: always yields <tt>true</tt>, regardless of operands.</li>
4243 </ol>
4244
4245 <h5>Example:</h5>
4246 <pre>  &lt;result&gt; = fcmp oeq float 4.0, 5.0    <i>; yields: result=false</i>
4247   &lt;result&gt; = fcmp one float 4.0, 5.0    <i>; yields: result=true</i>
4248   &lt;result&gt; = fcmp olt float 4.0, 5.0    <i>; yields: result=true</i>
4249   &lt;result&gt; = fcmp ueq double 1.0, 2.0   <i>; yields: result=false</i>
4250 </pre>
4251
4252 <p>Note that the code generator does not yet support vector types with
4253    the <tt>fcmp</tt> instruction.</p>
4254
4255 </div>
4256
4257 <!-- _______________________________________________________________________ -->
4258 <div class="doc_subsubsection">
4259   <a name="i_vicmp">'<tt>vicmp</tt>' Instruction</a>
4260 </div>
4261 <div class="doc_text">
4262 <h5>Syntax:</h5>
4263 <pre>  &lt;result&gt; = vicmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;   <i>; yields {ty}:result</i>
4264 </pre>
4265 <h5>Overview:</h5>
4266 <p>The '<tt>vicmp</tt>' instruction returns an integer vector value based on
4267 element-wise comparison of its two integer vector operands.</p>
4268 <h5>Arguments:</h5>
4269 <p>The '<tt>vicmp</tt>' instruction takes three operands. The first operand is
4270 the condition code indicating the kind of comparison to perform. It is not
4271 a value, just a keyword. The possible condition code are:</p>
4272 <ol>
4273   <li><tt>eq</tt>: equal</li>
4274   <li><tt>ne</tt>: not equal </li>
4275   <li><tt>ugt</tt>: unsigned greater than</li>
4276   <li><tt>uge</tt>: unsigned greater or equal</li>
4277   <li><tt>ult</tt>: unsigned less than</li>
4278   <li><tt>ule</tt>: unsigned less or equal</li>
4279   <li><tt>sgt</tt>: signed greater than</li>
4280   <li><tt>sge</tt>: signed greater or equal</li>
4281   <li><tt>slt</tt>: signed less than</li>
4282   <li><tt>sle</tt>: signed less or equal</li>
4283 </ol>
4284 <p>The remaining two arguments must be <a href="#t_vector">vector</a> or
4285 <a href="#t_integer">integer</a> typed. They must also be identical types.</p>
4286 <h5>Semantics:</h5>
4287 <p>The '<tt>vicmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
4288 according to the condition code given as <tt>cond</tt>. The comparison yields a
4289 <a href="#t_vector">vector</a> of <a href="#t_integer">integer</a> result, of
4290 identical type as the values being compared.  The most significant bit in each
4291 element is 1 if the element-wise comparison evaluates to true, and is 0
4292 otherwise.  All other bits of the result are undefined.  The condition codes
4293 are evaluated identically to the <a href="#i_icmp">'<tt>icmp</tt>'
4294 instruction</a>.</p>
4295
4296 <h5>Example:</h5>
4297 <pre>
4298   &lt;result&gt; = vicmp eq &lt;2 x i32&gt; &lt; i32 4, i32 0&gt;, &lt; i32 5, i32 0&gt;   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 0, i32 -1 &gt;</i>
4299   &lt;result&gt; = vicmp ult &lt;2 x i8 &gt; &lt; i8 1, i8 2&gt;, &lt; i8 2, i8 2 &gt;        <i>; yields: result=&lt;2 x i8&gt; &lt; i8 -1, i8 0 &gt;</i>
4300 </pre>
4301 </div>
4302
4303 <!-- _______________________________________________________________________ -->
4304 <div class="doc_subsubsection">
4305   <a name="i_vfcmp">'<tt>vfcmp</tt>' Instruction</a>
4306 </div>
4307 <div class="doc_text">
4308 <h5>Syntax:</h5>
4309 <pre>  &lt;result&gt; = vfcmp &lt;cond&gt; &lt;ty&gt; &lt;op1&gt;, &lt;op2&gt;</pre>
4310 <h5>Overview:</h5>
4311 <p>The '<tt>vfcmp</tt>' instruction returns an integer vector value based on
4312 element-wise comparison of its two floating point vector operands.  The output
4313 elements have the same width as the input elements.</p>
4314 <h5>Arguments:</h5>
4315 <p>The '<tt>vfcmp</tt>' instruction takes three operands. The first operand is
4316 the condition code indicating the kind of comparison to perform. It is not
4317 a value, just a keyword. The possible condition code are:</p>
4318 <ol>
4319   <li><tt>false</tt>: no comparison, always returns false</li>
4320   <li><tt>oeq</tt>: ordered and equal</li>
4321   <li><tt>ogt</tt>: ordered and greater than </li>
4322   <li><tt>oge</tt>: ordered and greater than or equal</li>
4323   <li><tt>olt</tt>: ordered and less than </li>
4324   <li><tt>ole</tt>: ordered and less than or equal</li>
4325   <li><tt>one</tt>: ordered and not equal</li>
4326   <li><tt>ord</tt>: ordered (no nans)</li>
4327   <li><tt>ueq</tt>: unordered or equal</li>
4328   <li><tt>ugt</tt>: unordered or greater than </li>
4329   <li><tt>uge</tt>: unordered or greater than or equal</li>
4330   <li><tt>ult</tt>: unordered or less than </li>
4331   <li><tt>ule</tt>: unordered or less than or equal</li>
4332   <li><tt>une</tt>: unordered or not equal</li>
4333   <li><tt>uno</tt>: unordered (either nans)</li>
4334   <li><tt>true</tt>: no comparison, always returns true</li>
4335 </ol>
4336 <p>The remaining two arguments must be <a href="#t_vector">vector</a> of
4337 <a href="#t_floating">floating point</a> typed. They must also be identical
4338 types.</p>
4339 <h5>Semantics:</h5>
4340 <p>The '<tt>vfcmp</tt>' instruction compares <tt>op1</tt> and <tt>op2</tt>
4341 according to  the condition code given as <tt>cond</tt>. The comparison yields a
4342 <a href="#t_vector">vector</a> of <a href="#t_integer">integer</a> result, with
4343 an identical number of elements as the values being compared, and each element
4344 having identical with to the width of the floating point elements. The most
4345 significant bit in each element is 1 if the element-wise comparison evaluates to
4346 true, and is 0 otherwise.  All other bits of the result are undefined.  The
4347 condition codes are evaluated identically to the
4348 <a href="#i_fcmp">'<tt>fcmp</tt>' instruction</a>.</p>
4349
4350 <h5>Example:</h5>
4351 <pre>
4352   <i>; yields: result=&lt;2 x i32&gt; &lt; i32 0, i32 -1 &gt;</i>
4353   &lt;result&gt; = vfcmp oeq &lt;2 x float&gt; &lt; float 4, float 0 &gt;, &lt; float 5, float 0 &gt;
4354
4355   <i>; yields: result=&lt;2 x i64&gt; &lt; i64 -1, i64 0 &gt;</i>
4356   &lt;result&gt; = vfcmp ult &lt;2 x double&gt; &lt; double 1, double 2 &gt;, &lt; double 2, double 2&gt;
4357 </pre>
4358 </div>
4359
4360 <!-- _______________________________________________________________________ -->
4361 <div class="doc_subsubsection">
4362   <a name="i_phi">'<tt>phi</tt>' Instruction</a>
4363 </div>
4364
4365 <div class="doc_text">
4366
4367 <h5>Syntax:</h5>
4368
4369 <pre>  &lt;result&gt; = phi &lt;ty&gt; [ &lt;val0&gt;, &lt;label0&gt;], ...<br></pre>
4370 <h5>Overview:</h5>
4371 <p>The '<tt>phi</tt>' instruction is used to implement the &#966; node in
4372 the SSA graph representing the function.</p>
4373 <h5>Arguments:</h5>
4374
4375 <p>The type of the incoming values is specified with the first type
4376 field. After this, the '<tt>phi</tt>' instruction takes a list of pairs
4377 as arguments, with one pair for each predecessor basic block of the
4378 current block.  Only values of <a href="#t_firstclass">first class</a>
4379 type may be used as the value arguments to the PHI node.  Only labels
4380 may be used as the label arguments.</p>
4381
4382 <p>There must be no non-phi instructions between the start of a basic
4383 block and the PHI instructions: i.e. PHI instructions must be first in
4384 a basic block.</p>
4385
4386 <h5>Semantics:</h5>
4387
4388 <p>At runtime, the '<tt>phi</tt>' instruction logically takes on the value
4389 specified by the pair corresponding to the predecessor basic block that executed
4390 just prior to the current block.</p>
4391
4392 <h5>Example:</h5>
4393 <pre>
4394 Loop:       ; Infinite loop that counts from 0 on up...
4395   %indvar = phi i32 [ 0, %LoopHeader ], [ %nextindvar, %Loop ]
4396   %nextindvar = add i32 %indvar, 1
4397   br label %Loop
4398 </pre>
4399 </div>
4400
4401 <!-- _______________________________________________________________________ -->
4402 <div class="doc_subsubsection">
4403    <a name="i_select">'<tt>select</tt>' Instruction</a>
4404 </div>
4405
4406 <div class="doc_text">
4407
4408 <h5>Syntax:</h5>
4409
4410 <pre>
4411   &lt;result&gt; = select <i>selty</i> &lt;cond&gt;, &lt;ty&gt; &lt;val1&gt;, &lt;ty&gt; &lt;val2&gt;             <i>; yields ty</i>
4412
4413   <i>selty</i> is either i1 or {&lt;N x i1&gt;}
4414 </pre>
4415
4416 <h5>Overview:</h5>
4417
4418 <p>
4419 The '<tt>select</tt>' instruction is used to choose one value based on a
4420 condition, without branching.
4421 </p>
4422
4423
4424 <h5>Arguments:</h5>
4425
4426 <p>
4427 The '<tt>select</tt>' instruction requires an 'i1' value or
4428 a vector of 'i1' values indicating the
4429 condition, and two values of the same <a href="#t_firstclass">first class</a>
4430 type.  If the val1/val2 are vectors and
4431 the condition is a scalar, then entire vectors are selected, not
4432 individual elements.
4433 </p>
4434
4435 <h5>Semantics:</h5>
4436
4437 <p>
4438 If the condition is an i1 and it evaluates to 1, the instruction returns the first
4439 value argument; otherwise, it returns the second value argument.
4440 </p>
4441 <p>
4442 If the condition is a vector of i1, then the value arguments must
4443 be vectors of the same size, and the selection is done element
4444 by element.
4445 </p>
4446
4447 <h5>Example:</h5>
4448
4449 <pre>
4450   %X = select i1 true, i8 17, i8 42          <i>; yields i8:17</i>
4451 </pre>
4452
4453 <p>Note that the code generator does not yet support conditions
4454    with vector type.</p>
4455
4456 </div>
4457
4458
4459 <!-- _______________________________________________________________________ -->
4460 <div class="doc_subsubsection">
4461   <a name="i_call">'<tt>call</tt>' Instruction</a>
4462 </div>
4463
4464 <div class="doc_text">
4465
4466 <h5>Syntax:</h5>
4467 <pre>
4468   &lt;result&gt; = [tail] call [<a href="#callingconv">cconv</a>] [<a href="#paramattrs">ret attrs</a>] &lt;ty&gt; [&lt;fnty&gt;*] &lt;fnptrval&gt;(&lt;function args&gt;) [<a href="#fnattrs">fn attrs</a>]
4469 </pre>
4470
4471 <h5>Overview:</h5>
4472
4473 <p>The '<tt>call</tt>' instruction represents a simple function call.</p>
4474
4475 <h5>Arguments:</h5>
4476
4477 <p>This instruction requires several arguments:</p>
4478
4479 <ol>
4480   <li>
4481     <p>The optional "tail" marker indicates whether the callee function accesses
4482     any allocas or varargs in the caller.  If the "tail" marker is present, the
4483     function call is eligible for tail call optimization.  Note that calls may
4484     be marked "tail" even if they do not occur before a <a
4485     href="#i_ret"><tt>ret</tt></a> instruction.</p>
4486   </li>
4487   <li>
4488     <p>The optional "cconv" marker indicates which <a href="#callingconv">calling
4489     convention</a> the call should use.  If none is specified, the call defaults
4490     to using C calling conventions.</p>
4491   </li>
4492
4493   <li>
4494     <p>The optional <a href="#paramattrs">Parameter Attributes</a> list for
4495     return values. Only '<tt>zeroext</tt>', '<tt>signext</tt>',
4496     and '<tt>inreg</tt>' attributes are valid here.</p>
4497   </li>
4498
4499   <li>
4500     <p>'<tt>ty</tt>': the type of the call instruction itself which is also
4501     the type of the return value.  Functions that return no value are marked
4502     <tt><a href="#t_void">void</a></tt>.</p>
4503   </li>
4504   <li>
4505     <p>'<tt>fnty</tt>': shall be the signature of the pointer to function
4506     value being invoked.  The argument types must match the types implied by
4507     this signature.  This type can be omitted if the function is not varargs
4508     and if the function type does not return a pointer to a function.</p>
4509   </li>
4510   <li>
4511     <p>'<tt>fnptrval</tt>': An LLVM value containing a pointer to a function to
4512     be invoked. In most cases, this is a direct function invocation, but
4513     indirect <tt>call</tt>s are just as possible, calling an arbitrary pointer
4514     to function value.</p>
4515   </li>
4516   <li>
4517     <p>'<tt>function args</tt>': argument list whose types match the
4518     function signature argument types. All arguments must be of
4519     <a href="#t_firstclass">first class</a> type. If the function signature
4520     indicates the function accepts a variable number of arguments, the extra
4521     arguments can be specified.</p>
4522   </li>
4523   <li>
4524   <p>The optional <a href="#fnattrs">function attributes</a> list. Only
4525   '<tt>noreturn</tt>', '<tt>nounwind</tt>', '<tt>readonly</tt>' and
4526   '<tt>readnone</tt>' attributes are valid here.</p>
4527   </li>
4528 </ol>
4529
4530 <h5>Semantics:</h5>
4531
4532 <p>The '<tt>call</tt>' instruction is used to cause control flow to
4533 transfer to a specified function, with its incoming arguments bound to
4534 the specified values. Upon a '<tt><a href="#i_ret">ret</a></tt>'
4535 instruction in the called function, control flow continues with the
4536 instruction after the function call, and the return value of the
4537 function is bound to the result argument.</p>
4538
4539 <h5>Example:</h5>
4540
4541 <pre>
4542   %retval = call i32 @test(i32 %argc)
4543   call i32 (i8 *, ...)* @printf(i8 * %msg, i32 12, i8 42)      <i>; yields i32</i>
4544   %X = tail call i32 @foo()                                    <i>; yields i32</i>
4545   %Y = tail call <a href="#callingconv">fastcc</a> i32 @foo()  <i>; yields i32</i>
4546   call void %foo(i8 97 signext)
4547
4548   %struct.A = type { i32, i8 }
4549   %r = call %struct.A @foo()                        <i>; yields { 32, i8 }</i>
4550   %gr = extractvalue %struct.A %r, 0                <i>; yields i32</i>
4551   %gr1 = extractvalue %struct.A %r, 1               <i>; yields i8</i>
4552   %Z = call void @foo() noreturn                    <i>; indicates that %foo never returns normally</i>
4553   %ZZ = call zeroext i32 @bar()                     <i>; Return value is %zero extended</i>
4554 </pre>
4555
4556 </div>
4557
4558 <!-- _______________________________________________________________________ -->
4559 <div class="doc_subsubsection">
4560   <a name="i_va_arg">'<tt>va_arg</tt>' Instruction</a>
4561 </div>
4562
4563 <div class="doc_text">
4564
4565 <h5>Syntax:</h5>
4566
4567 <pre>
4568   &lt;resultval&gt; = va_arg &lt;va_list*&gt; &lt;arglist&gt;, &lt;argty&gt;
4569 </pre>
4570
4571 <h5>Overview:</h5>
4572
4573 <p>The '<tt>va_arg</tt>' instruction is used to access arguments passed through
4574 the "variable argument" area of a function call.  It is used to implement the
4575 <tt>va_arg</tt> macro in C.</p>
4576
4577 <h5>Arguments:</h5>
4578
4579 <p>This instruction takes a <tt>va_list*</tt> value and the type of
4580 the argument. It returns a value of the specified argument type and
4581 increments the <tt>va_list</tt> to point to the next argument.  The
4582 actual type of <tt>va_list</tt> is target specific.</p>
4583
4584 <h5>Semantics:</h5>
4585
4586 <p>The '<tt>va_arg</tt>' instruction loads an argument of the specified
4587 type from the specified <tt>va_list</tt> and causes the
4588 <tt>va_list</tt> to point to the next argument.  For more information,
4589 see the variable argument handling <a href="#int_varargs">Intrinsic
4590 Functions</a>.</p>
4591
4592 <p>It is legal for this instruction to be called in a function which does not
4593 take a variable number of arguments, for example, the <tt>vfprintf</tt>
4594 function.</p>
4595
4596 <p><tt>va_arg</tt> is an LLVM instruction instead of an <a
4597 href="#intrinsics">intrinsic function</a> because it takes a type as an
4598 argument.</p>
4599
4600 <h5>Example:</h5>
4601
4602 <p>See the <a href="#int_varargs">variable argument processing</a> section.</p>
4603
4604 <p>Note that the code generator does not yet fully support va_arg
4605    on many targets. Also, it does not currently support va_arg with
4606    aggregate types on any target.</p>
4607
4608 </div>
4609
4610 <!-- *********************************************************************** -->
4611 <div class="doc_section"> <a name="intrinsics">Intrinsic Functions</a> </div>
4612 <!-- *********************************************************************** -->
4613
4614 <div class="doc_text">
4615
4616 <p>LLVM supports the notion of an "intrinsic function".  These functions have
4617 well known names and semantics and are required to follow certain restrictions.
4618 Overall, these intrinsics represent an extension mechanism for the LLVM
4619 language that does not require changing all of the transformations in LLVM when
4620 adding to the language (or the bitcode reader/writer, the parser, etc...).</p>
4621
4622 <p>Intrinsic function names must all start with an "<tt>llvm.</tt>" prefix. This
4623 prefix is reserved in LLVM for intrinsic names; thus, function names may not
4624 begin with this prefix.  Intrinsic functions must always be external functions:
4625 you cannot define the body of intrinsic functions.  Intrinsic functions may
4626 only be used in call or invoke instructions: it is illegal to take the address
4627 of an intrinsic function.  Additionally, because intrinsic functions are part
4628 of the LLVM language, it is required if any are added that they be documented
4629 here.</p>
4630
4631 <p>Some intrinsic functions can be overloaded, i.e., the intrinsic represents
4632 a family of functions that perform the same operation but on different data
4633 types. Because LLVM can represent over 8 million different integer types,
4634 overloading is used commonly to allow an intrinsic function to operate on any
4635 integer type. One or more of the argument types or the result type can be
4636 overloaded to accept any integer type. Argument types may also be defined as
4637 exactly matching a previous argument's type or the result type. This allows an
4638 intrinsic function which accepts multiple arguments, but needs all of them to
4639 be of the same type, to only be overloaded with respect to a single argument or
4640 the result.</p>
4641
4642 <p>Overloaded intrinsics will have the names of its overloaded argument types
4643 encoded into its function name, each preceded by a period. Only those types
4644 which are overloaded result in a name suffix. Arguments whose type is matched
4645 against another type do not. For example, the <tt>llvm.ctpop</tt> function can
4646 take an integer of any width and returns an integer of exactly the same integer
4647 width. This leads to a family of functions such as
4648 <tt>i8 @llvm.ctpop.i8(i8 %val)</tt> and <tt>i29 @llvm.ctpop.i29(i29 %val)</tt>.
4649 Only one type, the return type, is overloaded, and only one type suffix is
4650 required. Because the argument's type is matched against the return type, it
4651 does not require its own name suffix.</p>
4652
4653 <p>To learn how to add an intrinsic function, please see the
4654 <a href="ExtendingLLVM.html">Extending LLVM Guide</a>.
4655 </p>
4656
4657 </div>
4658
4659 <!-- ======================================================================= -->
4660 <div class="doc_subsection">
4661   <a name="int_varargs">Variable Argument Handling Intrinsics</a>
4662 </div>
4663
4664 <div class="doc_text">
4665
4666 <p>Variable argument support is defined in LLVM with the <a
4667  href="#i_va_arg"><tt>va_arg</tt></a> instruction and these three
4668 intrinsic functions.  These functions are related to the similarly
4669 named macros defined in the <tt>&lt;stdarg.h&gt;</tt> header file.</p>
4670
4671 <p>All of these functions operate on arguments that use a
4672 target-specific value type "<tt>va_list</tt>".  The LLVM assembly
4673 language reference manual does not define what this type is, so all
4674 transformations should be prepared to handle these functions regardless of
4675 the type used.</p>
4676
4677 <p>This example shows how the <a href="#i_va_arg"><tt>va_arg</tt></a>
4678 instruction and the variable argument handling intrinsic functions are
4679 used.</p>
4680
4681 <div class="doc_code">
4682 <pre>
4683 define i32 @test(i32 %X, ...) {
4684   ; Initialize variable argument processing
4685   %ap = alloca i8*
4686   %ap2 = bitcast i8** %ap to i8*
4687   call void @llvm.va_start(i8* %ap2)
4688
4689   ; Read a single integer argument
4690   %tmp = va_arg i8** %ap, i32
4691
4692   ; Demonstrate usage of llvm.va_copy and llvm.va_end
4693   %aq = alloca i8*
4694   %aq2 = bitcast i8** %aq to i8*
4695   call void @llvm.va_copy(i8* %aq2, i8* %ap2)
4696   call void @llvm.va_end(i8* %aq2)
4697
4698   ; Stop processing of arguments.
4699   call void @llvm.va_end(i8* %ap2)
4700   ret i32 %tmp
4701 }
4702
4703 declare void @llvm.va_start(i8*)
4704 declare void @llvm.va_copy(i8*, i8*)
4705 declare void @llvm.va_end(i8*)
4706 </pre>
4707 </div>
4708
4709 </div>
4710
4711 <!-- _______________________________________________________________________ -->
4712 <div class="doc_subsubsection">
4713   <a name="int_va_start">'<tt>llvm.va_start</tt>' Intrinsic</a>
4714 </div>
4715
4716
4717 <div class="doc_text">
4718 <h5>Syntax:</h5>
4719 <pre>  declare void %llvm.va_start(i8* &lt;arglist&gt;)<br></pre>
4720 <h5>Overview:</h5>
4721 <p>The '<tt>llvm.va_start</tt>' intrinsic initializes
4722 <tt>*&lt;arglist&gt;</tt> for subsequent use by <tt><a
4723 href="#i_va_arg">va_arg</a></tt>.</p>
4724
4725 <h5>Arguments:</h5>
4726
4727 <p>The argument is a pointer to a <tt>va_list</tt> element to initialize.</p>
4728
4729 <h5>Semantics:</h5>
4730
4731 <p>The '<tt>llvm.va_start</tt>' intrinsic works just like the <tt>va_start</tt>
4732 macro available in C.  In a target-dependent way, it initializes the
4733 <tt>va_list</tt> element to which the argument points, so that the next call to
4734 <tt>va_arg</tt> will produce the first variable argument passed to the function.
4735 Unlike the C <tt>va_start</tt> macro, this intrinsic does not need to know the
4736 last argument of the function as the compiler can figure that out.</p>
4737
4738 </div>
4739
4740 <!-- _______________________________________________________________________ -->
4741 <div class="doc_subsubsection">
4742  <a name="int_va_end">'<tt>llvm.va_end</tt>' Intrinsic</a>
4743 </div>
4744
4745 <div class="doc_text">
4746 <h5>Syntax:</h5>
4747 <pre>  declare void @llvm.va_end(i8* &lt;arglist&gt;)<br></pre>
4748 <h5>Overview:</h5>
4749
4750 <p>The '<tt>llvm.va_end</tt>' intrinsic destroys <tt>*&lt;arglist&gt;</tt>,
4751 which has been initialized previously with <tt><a href="#int_va_start">llvm.va_start</a></tt>
4752 or <tt><a href="#i_va_copy">llvm.va_copy</a></tt>.</p>
4753
4754 <h5>Arguments:</h5>
4755
4756 <p>The argument is a pointer to a <tt>va_list</tt> to destroy.</p>
4757
4758 <h5>Semantics:</h5>
4759
4760 <p>The '<tt>llvm.va_end</tt>' intrinsic works just like the <tt>va_end</tt>
4761 macro available in C.  In a target-dependent way, it destroys the
4762 <tt>va_list</tt> element to which the argument points.  Calls to <a
4763 href="#int_va_start"><tt>llvm.va_start</tt></a> and <a href="#int_va_copy">
4764 <tt>llvm.va_copy</tt></a> must be matched exactly with calls to
4765 <tt>llvm.va_end</tt>.</p>
4766
4767 </div>
4768
4769 <!-- _______________________________________________________________________ -->
4770 <div class="doc_subsubsection">
4771   <a name="int_va_copy">'<tt>llvm.va_copy</tt>' Intrinsic</a>
4772 </div>
4773
4774 <div class="doc_text">
4775
4776 <h5>Syntax:</h5>
4777
4778 <pre>
4779   declare void @llvm.va_copy(i8* &lt;destarglist&gt;, i8* &lt;srcarglist&gt;)
4780 </pre>
4781
4782 <h5>Overview:</h5>
4783
4784 <p>The '<tt>llvm.va_copy</tt>' intrinsic copies the current argument position
4785 from the source argument list to the destination argument list.</p>
4786
4787 <h5>Arguments:</h5>
4788
4789 <p>The first argument is a pointer to a <tt>va_list</tt> element to initialize.
4790 The second argument is a pointer to a <tt>va_list</tt> element to copy from.</p>
4791
4792
4793 <h5>Semantics:</h5>
4794
4795 <p>The '<tt>llvm.va_copy</tt>' intrinsic works just like the <tt>va_copy</tt>
4796 macro available in C.  In a target-dependent way, it copies the source
4797 <tt>va_list</tt> element into the destination <tt>va_list</tt> element.  This
4798 intrinsic is necessary because the <tt><a href="#int_va_start">
4799 llvm.va_start</a></tt> intrinsic may be arbitrarily complex and require, for
4800 example, memory allocation.</p>
4801
4802 </div>
4803
4804 <!-- ======================================================================= -->
4805 <div class="doc_subsection">
4806   <a name="int_gc">Accurate Garbage Collection Intrinsics</a>
4807 </div>
4808
4809 <div class="doc_text">
4810
4811 <p>
4812 LLVM support for <a href="GarbageCollection.html">Accurate Garbage
4813 Collection</a> (GC) requires the implementation and generation of these
4814 intrinsics.
4815 These intrinsics allow identification of <a href="#int_gcroot">GC roots on the
4816 stack</a>, as well as garbage collector implementations that require <a
4817 href="#int_gcread">read</a> and <a href="#int_gcwrite">write</a> barriers.
4818 Front-ends for type-safe garbage collected languages should generate these
4819 intrinsics to make use of the LLVM garbage collectors.  For more details, see <a
4820 href="GarbageCollection.html">Accurate Garbage Collection with LLVM</a>.
4821 </p>
4822
4823 <p>The garbage collection intrinsics only operate on objects in the generic
4824         address space (address space zero).</p>
4825
4826 </div>
4827
4828 <!-- _______________________________________________________________________ -->
4829 <div class="doc_subsubsection">
4830   <a name="int_gcroot">'<tt>llvm.gcroot</tt>' Intrinsic</a>
4831 </div>
4832
4833 <div class="doc_text">
4834
4835 <h5>Syntax:</h5>
4836
4837 <pre>
4838   declare void @llvm.gcroot(i8** %ptrloc, i8* %metadata)
4839 </pre>
4840
4841 <h5>Overview:</h5>
4842
4843 <p>The '<tt>llvm.gcroot</tt>' intrinsic declares the existence of a GC root to
4844 the code generator, and allows some metadata to be associated with it.</p>
4845
4846 <h5>Arguments:</h5>
4847
4848 <p>The first argument specifies the address of a stack object that contains the
4849 root pointer.  The second pointer (which must be either a constant or a global
4850 value address) contains the meta-data to be associated with the root.</p>
4851
4852 <h5>Semantics:</h5>
4853
4854 <p>At runtime, a call to this intrinsic stores a null pointer into the "ptrloc"
4855 location.  At compile-time, the code generator generates information to allow
4856 the runtime to find the pointer at GC safe points. The '<tt>llvm.gcroot</tt>'
4857 intrinsic may only be used in a function which <a href="#gc">specifies a GC
4858 algorithm</a>.</p>
4859
4860 </div>
4861
4862
4863 <!-- _______________________________________________________________________ -->
4864 <div class="doc_subsubsection">
4865   <a name="int_gcread">'<tt>llvm.gcread</tt>' Intrinsic</a>
4866 </div>
4867
4868 <div class="doc_text">
4869
4870 <h5>Syntax:</h5>
4871
4872 <pre>
4873   declare i8* @llvm.gcread(i8* %ObjPtr, i8** %Ptr)
4874 </pre>
4875
4876 <h5>Overview:</h5>
4877
4878 <p>The '<tt>llvm.gcread</tt>' intrinsic identifies reads of references from heap
4879 locations, allowing garbage collector implementations that require read
4880 barriers.</p>
4881
4882 <h5>Arguments:</h5>
4883
4884 <p>The second argument is the address to read from, which should be an address
4885 allocated from the garbage collector.  The first object is a pointer to the
4886 start of the referenced object, if needed by the language runtime (otherwise
4887 null).</p>
4888
4889 <h5>Semantics:</h5>
4890
4891 <p>The '<tt>llvm.gcread</tt>' intrinsic has the same semantics as a load
4892 instruction, but may be replaced with substantially more complex code by the
4893 garbage collector runtime, as needed. The '<tt>llvm.gcread</tt>' intrinsic
4894 may only be used in a function which <a href="#gc">specifies a GC
4895 algorithm</a>.</p>
4896
4897 </div>
4898
4899
4900 <!-- _______________________________________________________________________ -->
4901 <div class="doc_subsubsection">
4902   <a name="int_gcwrite">'<tt>llvm.gcwrite</tt>' Intrinsic</a>
4903 </div>
4904
4905 <div class="doc_text">
4906
4907 <h5>Syntax:</h5>
4908
4909 <pre>
4910   declare void @llvm.gcwrite(i8* %P1, i8* %Obj, i8** %P2)
4911 </pre>
4912
4913 <h5>Overview:</h5>
4914
4915 <p>The '<tt>llvm.gcwrite</tt>' intrinsic identifies writes of references to heap
4916 locations, allowing garbage collector implementations that require write
4917 barriers (such as generational or reference counting collectors).</p>
4918
4919 <h5>Arguments:</h5>
4920
4921 <p>The first argument is the reference to store, the second is the start of the
4922 object to store it to, and the third is the address of the field of Obj to
4923 store to.  If the runtime does not require a pointer to the object, Obj may be
4924 null.</p>
4925
4926 <h5>Semantics:</h5>
4927
4928 <p>The '<tt>llvm.gcwrite</tt>' intrinsic has the same semantics as a store
4929 instruction, but may be replaced with substantially more complex code by the
4930 garbage collector runtime, as needed. The '<tt>llvm.gcwrite</tt>' intrinsic
4931 may only be used in a function which <a href="#gc">specifies a GC
4932 algorithm</a>.</p>
4933
4934 </div>
4935
4936
4937
4938 <!-- ======================================================================= -->
4939 <div class="doc_subsection">
4940   <a name="int_codegen">Code Generator Intrinsics</a>
4941 </div>
4942
4943 <div class="doc_text">
4944 <p>
4945 These intrinsics are provided by LLVM to expose special features that may only
4946 be implemented with code generator support.
4947 </p>
4948
4949 </div>
4950
4951 <!-- _______________________________________________________________________ -->
4952 <div class="doc_subsubsection">
4953   <a name="int_returnaddress">'<tt>llvm.returnaddress</tt>' Intrinsic</a>
4954 </div>
4955
4956 <div class="doc_text">
4957
4958 <h5>Syntax:</h5>
4959 <pre>
4960   declare i8  *@llvm.returnaddress(i32 &lt;level&gt;)
4961 </pre>
4962
4963 <h5>Overview:</h5>
4964
4965 <p>
4966 The '<tt>llvm.returnaddress</tt>' intrinsic attempts to compute a
4967 target-specific value indicating the return address of the current function
4968 or one of its callers.
4969 </p>
4970
4971 <h5>Arguments:</h5>
4972
4973 <p>
4974 The argument to this intrinsic indicates which function to return the address
4975 for.  Zero indicates the calling function, one indicates its caller, etc.  The
4976 argument is <b>required</b> to be a constant integer value.
4977 </p>
4978
4979 <h5>Semantics:</h5>
4980
4981 <p>
4982 The '<tt>llvm.returnaddress</tt>' intrinsic either returns a pointer indicating
4983 the return address of the specified call frame, or zero if it cannot be
4984 identified.  The value returned by this intrinsic is likely to be incorrect or 0
4985 for arguments other than zero, so it should only be used for debugging purposes.
4986 </p>
4987
4988 <p>
4989 Note that calling this intrinsic does not prevent function inlining or other
4990 aggressive transformations, so the value returned may not be that of the obvious
4991 source-language caller.
4992 </p>
4993 </div>
4994
4995
4996 <!-- _______________________________________________________________________ -->
4997 <div class="doc_subsubsection">
4998   <a name="int_frameaddress">'<tt>llvm.frameaddress</tt>' Intrinsic</a>
4999 </div>
5000
5001 <div class="doc_text">
5002
5003 <h5>Syntax:</h5>
5004 <pre>
5005   declare i8 *@llvm.frameaddress(i32 &lt;level&gt;)
5006 </pre>
5007
5008 <h5>Overview:</h5>
5009
5010 <p>
5011 The '<tt>llvm.frameaddress</tt>' intrinsic attempts to return the
5012 target-specific frame pointer value for the specified stack frame.
5013 </p>
5014
5015 <h5>Arguments:</h5>
5016
5017 <p>
5018 The argument to this intrinsic indicates which function to return the frame
5019 pointer for.  Zero indicates the calling function, one indicates its caller,
5020 etc.  The argument is <b>required</b> to be a constant integer value.
5021 </p>
5022
5023 <h5>Semantics:</h5>
5024
5025 <p>
5026 The '<tt>llvm.frameaddress</tt>' intrinsic either returns a pointer indicating
5027 the frame address of the specified call frame, or zero if it cannot be
5028 identified.  The value returned by this intrinsic is likely to be incorrect or 0
5029 for arguments other than zero, so it should only be used for debugging purposes.
5030 </p>
5031
5032 <p>
5033 Note that calling this intrinsic does not prevent function inlining or other
5034 aggressive transformations, so the value returned may not be that of the obvious
5035 source-language caller.
5036 </p>
5037 </div>
5038
5039 <!-- _______________________________________________________________________ -->
5040 <div class="doc_subsubsection">
5041   <a name="int_stacksave">'<tt>llvm.stacksave</tt>' Intrinsic</a>
5042 </div>
5043
5044 <div class="doc_text">
5045
5046 <h5>Syntax:</h5>
5047 <pre>
5048   declare i8 *@llvm.stacksave()
5049 </pre>
5050
5051 <h5>Overview:</h5>
5052
5053 <p>
5054 The '<tt>llvm.stacksave</tt>' intrinsic is used to remember the current state of
5055 the function stack, for use with <a href="#int_stackrestore">
5056 <tt>llvm.stackrestore</tt></a>.  This is useful for implementing language
5057 features like scoped automatic variable sized arrays in C99.
5058 </p>
5059
5060 <h5>Semantics:</h5>
5061
5062 <p>
5063 This intrinsic returns a opaque pointer value that can be passed to <a
5064 href="#int_stackrestore"><tt>llvm.stackrestore</tt></a>.  When an
5065 <tt>llvm.stackrestore</tt> intrinsic is executed with a value saved from
5066 <tt>llvm.stacksave</tt>, it effectively restores the state of the stack to the
5067 state it was in when the <tt>llvm.stacksave</tt> intrinsic executed.  In
5068 practice, this pops any <a href="#i_alloca">alloca</a> blocks from the stack
5069 that were allocated after the <tt>llvm.stacksave</tt> was executed.
5070 </p>
5071
5072 </div>
5073
5074 <!-- _______________________________________________________________________ -->
5075 <div class="doc_subsubsection">
5076   <a name="int_stackrestore">'<tt>llvm.stackrestore</tt>' Intrinsic</a>
5077 </div>
5078
5079 <div class="doc_text">
5080
5081 <h5>Syntax:</h5>
5082 <pre>
5083   declare void @llvm.stackrestore(i8 * %ptr)
5084 </pre>
5085
5086 <h5>Overview:</h5>
5087
5088 <p>
5089 The '<tt>llvm.stackrestore</tt>' intrinsic is used to restore the state of
5090 the function stack to the state it was in when the corresponding <a
5091 href="#int_stacksave"><tt>llvm.stacksave</tt></a> intrinsic executed.  This is
5092 useful for implementing language features like scoped automatic variable sized
5093 arrays in C99.
5094 </p>
5095
5096 <h5>Semantics:</h5>
5097
5098 <p>
5099 See the description for <a href="#int_stacksave"><tt>llvm.stacksave</tt></a>.
5100 </p>
5101
5102 </div>
5103
5104
5105 <!-- _______________________________________________________________________ -->
5106 <div class="doc_subsubsection">
5107   <a name="int_prefetch">'<tt>llvm.prefetch</tt>' Intrinsic</a>
5108 </div>
5109
5110 <div class="doc_text">
5111
5112 <h5>Syntax:</h5>
5113 <pre>
5114   declare void @llvm.prefetch(i8* &lt;address&gt;, i32 &lt;rw&gt;, i32 &lt;locality&gt;)
5115 </pre>
5116
5117 <h5>Overview:</h5>
5118
5119
5120 <p>
5121 The '<tt>llvm.prefetch</tt>' intrinsic is a hint to the code generator to insert
5122 a prefetch instruction if supported; otherwise, it is a noop.  Prefetches have
5123 no
5124 effect on the behavior of the program but can change its performance
5125 characteristics.
5126 </p>
5127
5128 <h5>Arguments:</h5>
5129
5130 <p>
5131 <tt>address</tt> is the address to be prefetched, <tt>rw</tt> is the specifier
5132 determining if the fetch should be for a read (0) or write (1), and
5133 <tt>locality</tt> is a temporal locality specifier ranging from (0) - no
5134 locality, to (3) - extremely local keep in cache.  The <tt>rw</tt> and
5135 <tt>locality</tt> arguments must be constant integers.
5136 </p>
5137
5138 <h5>Semantics:</h5>
5139
5140 <p>
5141 This intrinsic does not modify the behavior of the program.  In particular,
5142 prefetches cannot trap and do not produce a value.  On targets that support this
5143 intrinsic, the prefetch can provide hints to the processor cache for better
5144 performance.
5145 </p>
5146
5147 </div>
5148
5149 <!-- _______________________________________________________________________ -->
5150 <div class="doc_subsubsection">
5151   <a name="int_pcmarker">'<tt>llvm.pcmarker</tt>' Intrinsic</a>
5152 </div>
5153
5154 <div class="doc_text">
5155
5156 <h5>Syntax:</h5>
5157 <pre>
5158   declare void @llvm.pcmarker(i32 &lt;id&gt;)
5159 </pre>
5160
5161 <h5>Overview:</h5>
5162
5163
5164 <p>
5165 The '<tt>llvm.pcmarker</tt>' intrinsic is a method to export a Program Counter
5166 (PC) in a region of
5167 code to simulators and other tools.  The method is target specific, but it is
5168 expected that the marker will use exported symbols to transmit the PC of the
5169 marker.
5170 The marker makes no guarantees that it will remain with any specific instruction
5171 after optimizations.  It is possible that the presence of a marker will inhibit
5172 optimizations.  The intended use is to be inserted after optimizations to allow
5173 correlations of simulation runs.
5174 </p>
5175
5176 <h5>Arguments:</h5>
5177
5178 <p>
5179 <tt>id</tt> is a numerical id identifying the marker.
5180 </p>
5181
5182 <h5>Semantics:</h5>
5183
5184 <p>
5185 This intrinsic does not modify the behavior of the program.  Backends that do not
5186 support this intrinisic may ignore it.
5187 </p>
5188
5189 </div>
5190
5191 <!-- _______________________________________________________________________ -->
5192 <div class="doc_subsubsection">
5193   <a name="int_readcyclecounter">'<tt>llvm.readcyclecounter</tt>' Intrinsic</a>
5194 </div>
5195
5196 <div class="doc_text">
5197
5198 <h5>Syntax:</h5>
5199 <pre>
5200   declare i64 @llvm.readcyclecounter( )
5201 </pre>
5202
5203 <h5>Overview:</h5>
5204
5205
5206 <p>
5207 The '<tt>llvm.readcyclecounter</tt>' intrinsic provides access to the cycle
5208 counter register (or similar low latency, high accuracy clocks) on those targets
5209 that support it.  On X86, it should map to RDTSC.  On Alpha, it should map to RPCC.
5210 As the backing counters overflow quickly (on the order of 9 seconds on alpha), this
5211 should only be used for small timings.
5212 </p>
5213
5214 <h5>Semantics:</h5>
5215
5216 <p>
5217 When directly supported, reading the cycle counter should not modify any memory.
5218 Implementations are allowed to either return a application specific value or a
5219 system wide value.  On backends without support, this is lowered to a constant 0.
5220 </p>
5221
5222 </div>
5223
5224 <!-- ======================================================================= -->
5225 <div class="doc_subsection">
5226   <a name="int_libc">Standard C Library Intrinsics</a>
5227 </div>
5228
5229 <div class="doc_text">
5230 <p>
5231 LLVM provides intrinsics for a few important standard C library functions.
5232 These intrinsics allow source-language front-ends to pass information about the
5233 alignment of the pointer arguments to the code generator, providing opportunity
5234 for more efficient code generation.
5235 </p>
5236
5237 </div>
5238
5239 <!-- _______________________________________________________________________ -->
5240 <div class="doc_subsubsection">
5241   <a name="int_memcpy">'<tt>llvm.memcpy</tt>' Intrinsic</a>
5242 </div>
5243
5244 <div class="doc_text">
5245
5246 <h5>Syntax:</h5>
5247 <p>This is an overloaded intrinsic. You can use llvm.memcpy on any integer bit
5248 width. Not all targets support all bit widths however.</p>
5249 <pre>
5250   declare void @llvm.memcpy.i8(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5251                                 i8 &lt;len&gt;, i32 &lt;align&gt;)
5252   declare void @llvm.memcpy.i16(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5253                                 i16 &lt;len&gt;, i32 &lt;align&gt;)
5254   declare void @llvm.memcpy.i32(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5255                                 i32 &lt;len&gt;, i32 &lt;align&gt;)
5256   declare void @llvm.memcpy.i64(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5257                                 i64 &lt;len&gt;, i32 &lt;align&gt;)
5258 </pre>
5259
5260 <h5>Overview:</h5>
5261
5262 <p>
5263 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
5264 location to the destination location.
5265 </p>
5266
5267 <p>
5268 Note that, unlike the standard libc function, the <tt>llvm.memcpy.*</tt>
5269 intrinsics do not return a value, and takes an extra alignment argument.
5270 </p>
5271
5272 <h5>Arguments:</h5>
5273
5274 <p>
5275 The first argument is a pointer to the destination, the second is a pointer to
5276 the source.  The third argument is an integer argument
5277 specifying the number of bytes to copy, and the fourth argument is the alignment
5278 of the source and destination locations.
5279 </p>
5280
5281 <p>
5282 If the call to this intrinisic has an alignment value that is not 0 or 1, then
5283 the caller guarantees that both the source and destination pointers are aligned
5284 to that boundary.
5285 </p>
5286
5287 <h5>Semantics:</h5>
5288
5289 <p>
5290 The '<tt>llvm.memcpy.*</tt>' intrinsics copy a block of memory from the source
5291 location to the destination location, which are not allowed to overlap.  It
5292 copies "len" bytes of memory over.  If the argument is known to be aligned to
5293 some boundary, this can be specified as the fourth argument, otherwise it should
5294 be set to 0 or 1.
5295 </p>
5296 </div>
5297
5298
5299 <!-- _______________________________________________________________________ -->
5300 <div class="doc_subsubsection">
5301   <a name="int_memmove">'<tt>llvm.memmove</tt>' Intrinsic</a>
5302 </div>
5303
5304 <div class="doc_text">
5305
5306 <h5>Syntax:</h5>
5307 <p>This is an overloaded intrinsic. You can use llvm.memmove on any integer bit
5308 width. Not all targets support all bit widths however.</p>
5309 <pre>
5310   declare void @llvm.memmove.i8(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5311                                  i8 &lt;len&gt;, i32 &lt;align&gt;)
5312   declare void @llvm.memmove.i16(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5313                                  i16 &lt;len&gt;, i32 &lt;align&gt;)
5314   declare void @llvm.memmove.i32(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5315                                  i32 &lt;len&gt;, i32 &lt;align&gt;)
5316   declare void @llvm.memmove.i64(i8 * &lt;dest&gt;, i8 * &lt;src&gt;,
5317                                  i64 &lt;len&gt;, i32 &lt;align&gt;)
5318 </pre>
5319
5320 <h5>Overview:</h5>
5321
5322 <p>
5323 The '<tt>llvm.memmove.*</tt>' intrinsics move a block of memory from the source
5324 location to the destination location. It is similar to the
5325 '<tt>llvm.memcpy</tt>' intrinsic but allows the two memory locations to overlap.
5326 </p>
5327
5328 <p>
5329 Note that, unlike the standard libc function, the <tt>llvm.memmove.*</tt>
5330 intrinsics do not return a value, and takes an extra alignment argument.
5331 </p>
5332
5333 <h5>Arguments:</h5>
5334
5335 <p>
5336 The first argument is a pointer to the destination, the second is a pointer to
5337 the source.  The third argument is an integer argument
5338 specifying the number of bytes to copy, and the fourth argument is the alignment
5339 of the source and destination locations.
5340 </p>
5341
5342 <p>
5343 If the call to this intrinisic has an alignment value that is not 0 or 1, then
5344 the caller guarantees that the source and destination pointers are aligned to
5345 that boundary.
5346 </p>
5347
5348 <h5>Semantics:</h5>
5349
5350 <p>
5351 The '<tt>llvm.memmove.*</tt>' intrinsics copy a block of memory from the source
5352 location to the destination location, which may overlap.  It
5353 copies "len" bytes of memory over.  If the argument is known to be aligned to
5354 some boundary, this can be specified as the fourth argument, otherwise it should
5355 be set to 0 or 1.
5356 </p>
5357 </div>
5358
5359
5360 <!-- _______________________________________________________________________ -->
5361 <div class="doc_subsubsection">
5362   <a name="int_memset">'<tt>llvm.memset.*</tt>' Intrinsics</a>
5363 </div>
5364
5365 <div class="doc_text">
5366
5367 <h5>Syntax:</h5>
5368 <p>This is an overloaded intrinsic. You can use llvm.memset on any integer bit
5369 width. Not all targets support all bit widths however.</p>
5370 <pre>
5371   declare void @llvm.memset.i8(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
5372                                 i8 &lt;len&gt;, i32 &lt;align&gt;)
5373   declare void @llvm.memset.i16(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
5374                                 i16 &lt;len&gt;, i32 &lt;align&gt;)
5375   declare void @llvm.memset.i32(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
5376                                 i32 &lt;len&gt;, i32 &lt;align&gt;)
5377   declare void @llvm.memset.i64(i8 * &lt;dest&gt;, i8 &lt;val&gt;,
5378                                 i64 &lt;len&gt;, i32 &lt;align&gt;)
5379 </pre>
5380
5381 <h5>Overview:</h5>
5382
5383 <p>
5384 The '<tt>llvm.memset.*</tt>' intrinsics fill a block of memory with a particular
5385 byte value.
5386 </p>
5387
5388 <p>
5389 Note that, unlike the standard libc function, the <tt>llvm.memset</tt> intrinsic
5390 does not return a value, and takes an extra alignment argument.
5391 </p>
5392
5393 <h5>Arguments:</h5>
5394
5395 <p>
5396 The first argument is a pointer to the destination to fill, the second is the
5397 byte value to fill it with, the third argument is an integer
5398 argument specifying the number of bytes to fill, and the fourth argument is the
5399 known alignment of destination location.
5400 </p>
5401
5402 <p>
5403 If the call to this intrinisic has an alignment value that is not 0 or 1, then
5404 the caller guarantees that the destination pointer is aligned to that boundary.
5405 </p>
5406
5407 <h5>Semantics:</h5>
5408
5409 <p>
5410 The '<tt>llvm.memset.*</tt>' intrinsics fill "len" bytes of memory starting at
5411 the
5412 destination location.  If the argument is known to be aligned to some boundary,
5413 this can be specified as the fourth argument, otherwise it should be set to 0 or
5414 1.
5415 </p>
5416 </div>
5417
5418
5419 <!-- _______________________________________________________________________ -->
5420 <div class="doc_subsubsection">
5421   <a name="int_sqrt">'<tt>llvm.sqrt.*</tt>' Intrinsic</a>
5422 </div>
5423
5424 <div class="doc_text">
5425
5426 <h5>Syntax:</h5>
5427 <p>This is an overloaded intrinsic. You can use <tt>llvm.sqrt</tt> on any
5428 floating point or vector of floating point type. Not all targets support all
5429 types however.</p>
5430 <pre>
5431   declare float     @llvm.sqrt.f32(float %Val)
5432   declare double    @llvm.sqrt.f64(double %Val)
5433   declare x86_fp80  @llvm.sqrt.f80(x86_fp80 %Val)
5434   declare fp128     @llvm.sqrt.f128(fp128 %Val)
5435   declare ppc_fp128 @llvm.sqrt.ppcf128(ppc_fp128 %Val)
5436 </pre>
5437
5438 <h5>Overview:</h5>
5439
5440 <p>
5441 The '<tt>llvm.sqrt</tt>' intrinsics return the sqrt of the specified operand,
5442 returning the same value as the libm '<tt>sqrt</tt>' functions would.  Unlike
5443 <tt>sqrt</tt> in libm, however, <tt>llvm.sqrt</tt> has undefined behavior for
5444 negative numbers other than -0.0 (which allows for better optimization, because
5445 there is no need to worry about errno being set).  <tt>llvm.sqrt(-0.0)</tt> is
5446 defined to return -0.0 like IEEE sqrt.
5447 </p>
5448
5449 <h5>Arguments:</h5>
5450
5451 <p>
5452 The argument and return value are floating point numbers of the same type.
5453 </p>
5454
5455 <h5>Semantics:</h5>
5456
5457 <p>
5458 This function returns the sqrt of the specified operand if it is a nonnegative
5459 floating point number.
5460 </p>
5461 </div>
5462
5463 <!-- _______________________________________________________________________ -->
5464 <div class="doc_subsubsection">
5465   <a name="int_powi">'<tt>llvm.powi.*</tt>' Intrinsic</a>
5466 </div>
5467
5468 <div class="doc_text">
5469
5470 <h5>Syntax:</h5>
5471 <p>This is an overloaded intrinsic. You can use <tt>llvm.powi</tt> on any
5472 floating point or vector of floating point type. Not all targets support all
5473 types however.</p>
5474 <pre>
5475   declare float     @llvm.powi.f32(float  %Val, i32 %power)
5476   declare double    @llvm.powi.f64(double %Val, i32 %power)
5477   declare x86_fp80  @llvm.powi.f80(x86_fp80  %Val, i32 %power)
5478   declare fp128     @llvm.powi.f128(fp128 %Val, i32 %power)
5479   declare ppc_fp128 @llvm.powi.ppcf128(ppc_fp128  %Val, i32 %power)
5480 </pre>
5481
5482 <h5>Overview:</h5>
5483
5484 <p>
5485 The '<tt>llvm.powi.*</tt>' intrinsics return the first operand raised to the
5486 specified (positive or negative) power.  The order of evaluation of
5487 multiplications is not defined.  When a vector of floating point type is
5488 used, the second argument remains a scalar integer value.
5489 </p>
5490
5491 <h5>Arguments:</h5>
5492
5493 <p>
5494 The second argument is an integer power, and the first is a value to raise to
5495 that power.
5496 </p>
5497
5498 <h5>Semantics:</h5>
5499
5500 <p>
5501 This function returns the first value raised to the second power with an
5502 unspecified sequence of rounding operations.</p>
5503 </div>
5504
5505 <!-- _______________________________________________________________________ -->
5506 <div class="doc_subsubsection">
5507   <a name="int_sin">'<tt>llvm.sin.*</tt>' Intrinsic</a>
5508 </div>
5509
5510 <div class="doc_text">
5511
5512 <h5>Syntax:</h5>
5513 <p>This is an overloaded intrinsic. You can use <tt>llvm.sin</tt> on any
5514 floating point or vector of floating point type. Not all targets support all
5515 types however.</p>
5516 <pre>
5517   declare float     @llvm.sin.f32(float  %Val)
5518   declare double    @llvm.sin.f64(double %Val)
5519   declare x86_fp80  @llvm.sin.f80(x86_fp80  %Val)
5520   declare fp128     @llvm.sin.f128(fp128 %Val)
5521   declare ppc_fp128 @llvm.sin.ppcf128(ppc_fp128  %Val)
5522 </pre>
5523
5524 <h5>Overview:</h5>
5525
5526 <p>
5527 The '<tt>llvm.sin.*</tt>' intrinsics return the sine of the operand.
5528 </p>
5529
5530 <h5>Arguments:</h5>
5531
5532 <p>
5533 The argument and return value are floating point numbers of the same type.
5534 </p>
5535
5536 <h5>Semantics:</h5>
5537
5538 <p>
5539 This function returns the sine of the specified operand, returning the
5540 same values as the libm <tt>sin</tt> functions would, and handles error
5541 conditions in the same way.</p>
5542 </div>
5543
5544 <!-- _______________________________________________________________________ -->
5545 <div class="doc_subsubsection">
5546   <a name="int_cos">'<tt>llvm.cos.*</tt>' Intrinsic</a>
5547 </div>
5548
5549 <div class="doc_text">
5550
5551 <h5>Syntax:</h5>
5552 <p>This is an overloaded intrinsic. You can use <tt>llvm.cos</tt> on any
5553 floating point or vector of floating point type. Not all targets support all
5554 types however.</p>
5555 <pre>
5556   declare float     @llvm.cos.f32(float  %Val)
5557   declare double    @llvm.cos.f64(double %Val)
5558   declare x86_fp80  @llvm.cos.f80(x86_fp80  %Val)
5559   declare fp128     @llvm.cos.f128(fp128 %Val)
5560   declare ppc_fp128 @llvm.cos.ppcf128(ppc_fp128  %Val)
5561 </pre>
5562
5563 <h5>Overview:</h5>
5564
5565 <p>
5566 The '<tt>llvm.cos.*</tt>' intrinsics return the cosine of the operand.
5567 </p>
5568
5569 <h5>Arguments:</h5>
5570
5571 <p>
5572 The argument and return value are floating point numbers of the same type.
5573 </p>
5574
5575 <h5>Semantics:</h5>
5576
5577 <p>
5578 This function returns the cosine of the specified operand, returning the
5579 same values as the libm <tt>cos</tt> functions would, and handles error
5580 conditions in the same way.</p>
5581 </div>
5582
5583 <!-- _______________________________________________________________________ -->
5584 <div class="doc_subsubsection">
5585   <a name="int_pow">'<tt>llvm.pow.*</tt>' Intrinsic</a>
5586 </div>
5587
5588 <div class="doc_text">
5589
5590 <h5>Syntax:</h5>
5591 <p>This is an overloaded intrinsic. You can use <tt>llvm.pow</tt> on any
5592 floating point or vector of floating point type. Not all targets support all
5593 types however.</p>
5594 <pre>
5595   declare float     @llvm.pow.f32(float  %Val, float %Power)
5596   declare double    @llvm.pow.f64(double %Val, double %Power)
5597   declare x86_fp80  @llvm.pow.f80(x86_fp80  %Val, x86_fp80 %Power)
5598   declare fp128     @llvm.pow.f128(fp128 %Val, fp128 %Power)
5599   declare ppc_fp128 @llvm.pow.ppcf128(ppc_fp128  %Val, ppc_fp128 Power)
5600 </pre>
5601
5602 <h5>Overview:</h5>
5603
5604 <p>
5605 The '<tt>llvm.pow.*</tt>' intrinsics return the first operand raised to the
5606 specified (positive or negative) power.
5607 </p>
5608
5609 <h5>Arguments:</h5>
5610
5611 <p>
5612 The second argument is a floating point power, and the first is a value to
5613 raise to that power.
5614 </p>
5615
5616 <h5>Semantics:</h5>
5617
5618 <p>
5619 This function returns the first value raised to the second power,
5620 returning the
5621 same values as the libm <tt>pow</tt> functions would, and handles error
5622 conditions in the same way.</p>
5623 </div>
5624
5625
5626 <!-- ======================================================================= -->
5627 <div class="doc_subsection">
5628   <a name="int_manip">Bit Manipulation Intrinsics</a>
5629 </div>
5630
5631 <div class="doc_text">
5632 <p>
5633 LLVM provides intrinsics for a few important bit manipulation operations.
5634 These allow efficient code generation for some algorithms.
5635 </p>
5636
5637 </div>
5638
5639 <!-- _______________________________________________________________________ -->
5640 <div class="doc_subsubsection">
5641   <a name="int_bswap">'<tt>llvm.bswap.*</tt>' Intrinsics</a>
5642 </div>
5643
5644 <div class="doc_text">
5645
5646 <h5>Syntax:</h5>
5647 <p>This is an overloaded intrinsic function. You can use bswap on any integer
5648 type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
5649 <pre>
5650   declare i16 @llvm.bswap.i16(i16 &lt;id&gt;)
5651   declare i32 @llvm.bswap.i32(i32 &lt;id&gt;)
5652   declare i64 @llvm.bswap.i64(i64 &lt;id&gt;)
5653 </pre>
5654
5655 <h5>Overview:</h5>
5656
5657 <p>
5658 The '<tt>llvm.bswap</tt>' family of intrinsics is used to byte swap integer
5659 values with an even number of bytes (positive multiple of 16 bits).  These are
5660 useful for performing operations on data that is not in the target's native
5661 byte order.
5662 </p>
5663
5664 <h5>Semantics:</h5>
5665
5666 <p>
5667 The <tt>llvm.bswap.i16</tt> intrinsic returns an i16 value that has the high
5668 and low byte of the input i16 swapped.  Similarly, the <tt>llvm.bswap.i32</tt>
5669 intrinsic returns an i32 value that has the four bytes of the input i32
5670 swapped, so that if the input bytes are numbered 0, 1, 2, 3 then the returned
5671 i32 will have its bytes in 3, 2, 1, 0 order.  The <tt>llvm.bswap.i48</tt>,
5672 <tt>llvm.bswap.i64</tt> and other intrinsics extend this concept to
5673 additional even-byte lengths (6 bytes, 8 bytes and more, respectively).
5674 </p>
5675
5676 </div>
5677
5678 <!-- _______________________________________________________________________ -->
5679 <div class="doc_subsubsection">
5680   <a name="int_ctpop">'<tt>llvm.ctpop.*</tt>' Intrinsic</a>
5681 </div>
5682
5683 <div class="doc_text">
5684
5685 <h5>Syntax:</h5>
5686 <p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer bit
5687 width. Not all targets support all bit widths however.</p>
5688 <pre>
5689   declare i8 @llvm.ctpop.i8 (i8  &lt;src&gt;)
5690   declare i16 @llvm.ctpop.i16(i16 &lt;src&gt;)
5691   declare i32 @llvm.ctpop.i32(i32 &lt;src&gt;)
5692   declare i64 @llvm.ctpop.i64(i64 &lt;src&gt;)
5693   declare i256 @llvm.ctpop.i256(i256 &lt;src&gt;)
5694 </pre>
5695
5696 <h5>Overview:</h5>
5697
5698 <p>
5699 The '<tt>llvm.ctpop</tt>' family of intrinsics counts the number of bits set in a
5700 value.
5701 </p>
5702
5703 <h5>Arguments:</h5>
5704
5705 <p>
5706 The only argument is the value to be counted.  The argument may be of any
5707 integer type.  The return type must match the argument type.
5708 </p>
5709
5710 <h5>Semantics:</h5>
5711
5712 <p>
5713 The '<tt>llvm.ctpop</tt>' intrinsic counts the 1's in a variable.
5714 </p>
5715 </div>
5716
5717 <!-- _______________________________________________________________________ -->
5718 <div class="doc_subsubsection">
5719   <a name="int_ctlz">'<tt>llvm.ctlz.*</tt>' Intrinsic</a>
5720 </div>
5721
5722 <div class="doc_text">
5723
5724 <h5>Syntax:</h5>
5725 <p>This is an overloaded intrinsic. You can use <tt>llvm.ctlz</tt> on any
5726 integer bit width. Not all targets support all bit widths however.</p>
5727 <pre>
5728   declare i8 @llvm.ctlz.i8 (i8  &lt;src&gt;)
5729   declare i16 @llvm.ctlz.i16(i16 &lt;src&gt;)
5730   declare i32 @llvm.ctlz.i32(i32 &lt;src&gt;)
5731   declare i64 @llvm.ctlz.i64(i64 &lt;src&gt;)
5732   declare i256 @llvm.ctlz.i256(i256 &lt;src&gt;)
5733 </pre>
5734
5735 <h5>Overview:</h5>
5736
5737 <p>
5738 The '<tt>llvm.ctlz</tt>' family of intrinsic functions counts the number of
5739 leading zeros in a variable.
5740 </p>
5741
5742 <h5>Arguments:</h5>
5743
5744 <p>
5745 The only argument is the value to be counted.  The argument may be of any
5746 integer type. The return type must match the argument type.
5747 </p>
5748
5749 <h5>Semantics:</h5>
5750
5751 <p>
5752 The '<tt>llvm.ctlz</tt>' intrinsic counts the leading (most significant) zeros
5753 in a variable.  If the src == 0 then the result is the size in bits of the type
5754 of src. For example, <tt>llvm.ctlz(i32 2) = 30</tt>.
5755 </p>
5756 </div>
5757
5758
5759
5760 <!-- _______________________________________________________________________ -->
5761 <div class="doc_subsubsection">
5762   <a name="int_cttz">'<tt>llvm.cttz.*</tt>' Intrinsic</a>
5763 </div>
5764
5765 <div class="doc_text">
5766
5767 <h5>Syntax:</h5>
5768 <p>This is an overloaded intrinsic. You can use <tt>llvm.cttz</tt> on any
5769 integer bit width. Not all targets support all bit widths however.</p>
5770 <pre>
5771   declare i8 @llvm.cttz.i8 (i8  &lt;src&gt;)
5772   declare i16 @llvm.cttz.i16(i16 &lt;src&gt;)
5773   declare i32 @llvm.cttz.i32(i32 &lt;src&gt;)
5774   declare i64 @llvm.cttz.i64(i64 &lt;src&gt;)
5775   declare i256 @llvm.cttz.i256(i256 &lt;src&gt;)
5776 </pre>
5777
5778 <h5>Overview:</h5>
5779
5780 <p>
5781 The '<tt>llvm.cttz</tt>' family of intrinsic functions counts the number of
5782 trailing zeros.
5783 </p>
5784
5785 <h5>Arguments:</h5>
5786
5787 <p>
5788 The only argument is the value to be counted.  The argument may be of any
5789 integer type.  The return type must match the argument type.
5790 </p>
5791
5792 <h5>Semantics:</h5>
5793
5794 <p>
5795 The '<tt>llvm.cttz</tt>' intrinsic counts the trailing (least significant) zeros
5796 in a variable.  If the src == 0 then the result is the size in bits of the type
5797 of src.  For example, <tt>llvm.cttz(2) = 1</tt>.
5798 </p>
5799 </div>
5800
5801 <!-- _______________________________________________________________________ -->
5802 <div class="doc_subsubsection">
5803   <a name="int_part_select">'<tt>llvm.part.select.*</tt>' Intrinsic</a>
5804 </div>
5805
5806 <div class="doc_text">
5807
5808 <h5>Syntax:</h5>
5809 <p>This is an overloaded intrinsic. You can use <tt>llvm.part.select</tt>
5810 on any integer bit width.</p>
5811 <pre>
5812   declare i17 @llvm.part.select.i17 (i17 %val, i32 %loBit, i32 %hiBit)
5813   declare i29 @llvm.part.select.i29 (i29 %val, i32 %loBit, i32 %hiBit)
5814 </pre>
5815
5816 <h5>Overview:</h5>
5817 <p>The '<tt>llvm.part.select</tt>' family of intrinsic functions selects a
5818 range of bits from an integer value and returns them in the same bit width as
5819 the original value.</p>
5820
5821 <h5>Arguments:</h5>
5822 <p>The first argument, <tt>%val</tt> and the result may be integer types of
5823 any bit width but they must have the same bit width. The second and third
5824 arguments must be <tt>i32</tt> type since they specify only a bit index.</p>
5825
5826 <h5>Semantics:</h5>
5827 <p>The operation of the '<tt>llvm.part.select</tt>' intrinsic has two modes
5828 of operation: forwards and reverse. If <tt>%loBit</tt> is greater than
5829 <tt>%hiBits</tt> then the intrinsic operates in reverse mode. Otherwise it
5830 operates in forward mode.</p>
5831 <p>In forward mode, this intrinsic is the equivalent of shifting <tt>%val</tt>
5832 right by <tt>%loBit</tt> bits and then ANDing it with a mask with
5833 only the <tt>%hiBit - %loBit</tt> bits set, as follows:</p>
5834 <ol>
5835   <li>The <tt>%val</tt> is shifted right (LSHR) by the number of bits specified
5836   by <tt>%loBits</tt>. This normalizes the value to the low order bits.</li>
5837   <li>The <tt>%loBits</tt> value is subtracted from the <tt>%hiBits</tt> value
5838   to determine the number of bits to retain.</li>
5839   <li>A mask of the retained bits is created by shifting a -1 value.</li>
5840   <li>The mask is ANDed with <tt>%val</tt> to produce the result.</li>
5841 </ol>
5842 <p>In reverse mode, a similar computation is made except that the bits are
5843 returned in the reverse order. So, for example, if <tt>X</tt> has the value
5844 <tt>i16 0x0ACF (101011001111)</tt> and we apply
5845 <tt>part.select(i16 X, 8, 3)</tt> to it, we get back the value
5846 <tt>i16 0x0026 (000000100110)</tt>.</p>
5847 </div>
5848
5849 <div class="doc_subsubsection">
5850   <a name="int_part_set">'<tt>llvm.part.set.*</tt>' Intrinsic</a>
5851 </div>
5852
5853 <div class="doc_text">
5854
5855 <h5>Syntax:</h5>
5856 <p>This is an overloaded intrinsic. You can use <tt>llvm.part.set</tt>
5857 on any integer bit width.</p>
5858 <pre>
5859   declare i17 @llvm.part.set.i17.i9 (i17 %val, i9 %repl, i32 %lo, i32 %hi)
5860   declare i29 @llvm.part.set.i29.i9 (i29 %val, i9 %repl, i32 %lo, i32 %hi)
5861 </pre>
5862
5863 <h5>Overview:</h5>
5864 <p>The '<tt>llvm.part.set</tt>' family of intrinsic functions replaces a range
5865 of bits in an integer value with another integer value. It returns the integer
5866 with the replaced bits.</p>
5867
5868 <h5>Arguments:</h5>
5869 <p>The first argument, <tt>%val</tt> and the result may be integer types of
5870 any bit width but they must have the same bit width. <tt>%val</tt> is the value
5871 whose bits will be replaced.  The second argument, <tt>%repl</tt> may be an
5872 integer of any bit width. The third and fourth arguments must be <tt>i32</tt>
5873 type since they specify only a bit index.</p>
5874
5875 <h5>Semantics:</h5>
5876 <p>The operation of the '<tt>llvm.part.set</tt>' intrinsic has two modes
5877 of operation: forwards and reverse. If <tt>%lo</tt> is greater than
5878 <tt>%hi</tt> then the intrinsic operates in reverse mode. Otherwise it
5879 operates in forward mode.</p>
5880 <p>For both modes, the <tt>%repl</tt> value is prepared for use by either
5881 truncating it down to the size of the replacement area or zero extending it
5882 up to that size.</p>
5883 <p>In forward mode, the bits between <tt>%lo</tt> and <tt>%hi</tt> (inclusive)
5884 are replaced with corresponding bits from <tt>%repl</tt>. That is the 0th bit
5885 in <tt>%repl</tt> replaces the <tt>%lo</tt>th bit in <tt>%val</tt> and etc. up
5886 to the <tt>%hi</tt>th bit.</p>
5887 <p>In reverse mode, a similar computation is made except that the bits are
5888 reversed.  That is, the <tt>0</tt>th bit in <tt>%repl</tt> replaces the
5889 <tt>%hi</tt> bit in <tt>%val</tt> and etc. down to the <tt>%lo</tt>th bit.</p>
5890 <h5>Examples:</h5>
5891 <pre>
5892   llvm.part.set(0xFFFF, 0, 4, 7) -&gt; 0xFF0F
5893   llvm.part.set(0xFFFF, 0, 7, 4) -&gt; 0xFF0F
5894   llvm.part.set(0xFFFF, 1, 7, 4) -&gt; 0xFF8F
5895   llvm.part.set(0xFFFF, F, 8, 3) -&gt; 0xFFE7
5896   llvm.part.set(0xFFFF, 0, 3, 8) -&gt; 0xFE07
5897 </pre>
5898 </div>
5899
5900 <!-- ======================================================================= -->
5901 <div class="doc_subsection">
5902   <a name="int_debugger">Debugger Intrinsics</a>
5903 </div>
5904
5905 <div class="doc_text">
5906 <p>
5907 The LLVM debugger intrinsics (which all start with <tt>llvm.dbg.</tt> prefix),
5908 are described in the <a
5909 href="SourceLevelDebugging.html#format_common_intrinsics">LLVM Source Level
5910 Debugging</a> document.
5911 </p>
5912 </div>
5913
5914
5915 <!-- ======================================================================= -->
5916 <div class="doc_subsection">
5917   <a name="int_eh">Exception Handling Intrinsics</a>
5918 </div>
5919
5920 <div class="doc_text">
5921 <p> The LLVM exception handling intrinsics (which all start with
5922 <tt>llvm.eh.</tt> prefix), are described in the <a
5923 href="ExceptionHandling.html#format_common_intrinsics">LLVM Exception
5924 Handling</a> document. </p>
5925 </div>
5926
5927 <!-- ======================================================================= -->
5928 <div class="doc_subsection">
5929   <a name="int_trampoline">Trampoline Intrinsic</a>
5930 </div>
5931
5932 <div class="doc_text">
5933 <p>
5934   This intrinsic makes it possible to excise one parameter, marked with
5935   the <tt>nest</tt> attribute, from a function.  The result is a callable
5936   function pointer lacking the nest parameter - the caller does not need
5937   to provide a value for it.  Instead, the value to use is stored in
5938   advance in a "trampoline", a block of memory usually allocated
5939   on the stack, which also contains code to splice the nest value into the
5940   argument list.  This is used to implement the GCC nested function address
5941   extension.
5942 </p>
5943 <p>
5944   For example, if the function is
5945   <tt>i32 f(i8* nest  %c, i32 %x, i32 %y)</tt> then the resulting function
5946   pointer has signature <tt>i32 (i32, i32)*</tt>.  It can be created as follows:</p>
5947 <pre>
5948   %tramp = alloca [10 x i8], align 4 ; size and alignment only correct for X86
5949   %tramp1 = getelementptr [10 x i8]* %tramp, i32 0, i32 0
5950   %p = call i8* @llvm.init.trampoline( i8* %tramp1, i8* bitcast (i32 (i8* nest , i32, i32)* @f to i8*), i8* %nval )
5951   %fp = bitcast i8* %p to i32 (i32, i32)*
5952 </pre>
5953   <p>The call <tt>%val = call i32 %fp( i32 %x, i32 %y )</tt> is then equivalent
5954   to <tt>%val = call i32 %f( i8* %nval, i32 %x, i32 %y )</tt>.</p>
5955 </div>
5956
5957 <!-- _______________________________________________________________________ -->
5958 <div class="doc_subsubsection">
5959   <a name="int_it">'<tt>llvm.init.trampoline</tt>' Intrinsic</a>
5960 </div>
5961 <div class="doc_text">
5962 <h5>Syntax:</h5>
5963 <pre>
5964 declare i8* @llvm.init.trampoline(i8* &lt;tramp&gt;, i8* &lt;func&gt;, i8* &lt;nval&gt;)
5965 </pre>
5966 <h5>Overview:</h5>
5967 <p>
5968   This fills the memory pointed to by <tt>tramp</tt> with code
5969   and returns a function pointer suitable for executing it.
5970 </p>
5971 <h5>Arguments:</h5>
5972 <p>
5973   The <tt>llvm.init.trampoline</tt> intrinsic takes three arguments, all
5974   pointers.  The <tt>tramp</tt> argument must point to a sufficiently large
5975   and sufficiently aligned block of memory; this memory is written to by the
5976   intrinsic.  Note that the size and the alignment are target-specific - LLVM
5977   currently provides no portable way of determining them, so a front-end that
5978   generates this intrinsic needs to have some target-specific knowledge.
5979   The <tt>func</tt> argument must hold a function bitcast to an <tt>i8*</tt>.
5980 </p>
5981 <h5>Semantics:</h5>
5982 <p>
5983   The block of memory pointed to by <tt>tramp</tt> is filled with target
5984   dependent code, turning it into a function.  A pointer to this function is
5985   returned, but needs to be bitcast to an
5986   <a href="#int_trampoline">appropriate function pointer type</a>
5987   before being called.  The new function's signature is the same as that of
5988   <tt>func</tt> with any arguments marked with the <tt>nest</tt> attribute
5989   removed.  At most one such <tt>nest</tt> argument is allowed, and it must be
5990   of pointer type.  Calling the new function is equivalent to calling
5991   <tt>func</tt> with the same argument list, but with <tt>nval</tt> used for the
5992   missing <tt>nest</tt> argument.  If, after calling
5993   <tt>llvm.init.trampoline</tt>, the memory pointed to by <tt>tramp</tt> is
5994   modified, then the effect of any later call to the returned function pointer is
5995   undefined.
5996 </p>
5997 </div>
5998
5999 <!-- ======================================================================= -->
6000 <div class="doc_subsection">
6001   <a name="int_atomics">Atomic Operations and Synchronization Intrinsics</a>
6002 </div>
6003
6004 <div class="doc_text">
6005 <p>
6006   These intrinsic functions expand the "universal IR" of LLVM to represent
6007   hardware constructs for atomic operations and memory synchronization.  This
6008   provides an interface to the hardware, not an interface to the programmer. It
6009   is aimed at a low enough level to allow any programming models or APIs
6010   (Application Programming Interfaces) which
6011   need atomic behaviors to map cleanly onto it. It is also modeled primarily on
6012   hardware behavior. Just as hardware provides a "universal IR" for source
6013   languages, it also provides a starting point for developing a "universal"
6014   atomic operation and synchronization IR.
6015 </p>
6016 <p>
6017   These do <em>not</em> form an API such as high-level threading libraries,
6018   software transaction memory systems, atomic primitives, and intrinsic
6019   functions as found in BSD, GNU libc, atomic_ops, APR, and other system and
6020   application libraries.  The hardware interface provided by LLVM should allow
6021   a clean implementation of all of these APIs and parallel programming models.
6022   No one model or paradigm should be selected above others unless the hardware
6023   itself ubiquitously does so.
6024
6025 </p>
6026 </div>
6027
6028 <!-- _______________________________________________________________________ -->
6029 <div class="doc_subsubsection">
6030   <a name="int_memory_barrier">'<tt>llvm.memory.barrier</tt>' Intrinsic</a>
6031 </div>
6032 <div class="doc_text">
6033 <h5>Syntax:</h5>
6034 <pre>
6035 declare void @llvm.memory.barrier( i1 &lt;ll&gt;, i1 &lt;ls&gt;, i1 &lt;sl&gt;, i1 &lt;ss&gt;,
6036 i1 &lt;device&gt; )
6037
6038 </pre>
6039 <h5>Overview:</h5>
6040 <p>
6041   The <tt>llvm.memory.barrier</tt> intrinsic guarantees ordering between
6042   specific pairs of memory access types.
6043 </p>
6044 <h5>Arguments:</h5>
6045 <p>
6046   The <tt>llvm.memory.barrier</tt> intrinsic requires five boolean arguments.
6047   The first four arguments enables a specific barrier as listed below.  The fith
6048   argument specifies that the barrier applies to io or device or uncached memory.
6049
6050 </p>
6051   <ul>
6052     <li><tt>ll</tt>: load-load barrier</li>
6053     <li><tt>ls</tt>: load-store barrier</li>
6054     <li><tt>sl</tt>: store-load barrier</li>
6055     <li><tt>ss</tt>: store-store barrier</li>
6056     <li><tt>device</tt>: barrier applies to device and uncached memory also.</li>
6057   </ul>
6058 <h5>Semantics:</h5>
6059 <p>
6060   This intrinsic causes the system to enforce some ordering constraints upon
6061   the loads and stores of the program. This barrier does not indicate
6062   <em>when</em> any events will occur, it only enforces an <em>order</em> in
6063   which they occur. For any of the specified pairs of load and store operations
6064   (f.ex.  load-load, or store-load), all of the first operations preceding the
6065   barrier will complete before any of the second operations succeeding the
6066   barrier begin. Specifically the semantics for each pairing is as follows:
6067 </p>
6068   <ul>
6069     <li><tt>ll</tt>: All loads before the barrier must complete before any load
6070     after the barrier begins.</li>
6071
6072     <li><tt>ls</tt>: All loads before the barrier must complete before any
6073     store after the barrier begins.</li>
6074     <li><tt>ss</tt>: All stores before the barrier must complete before any
6075     store after the barrier begins.</li>
6076     <li><tt>sl</tt>: All stores before the barrier must complete before any
6077     load after the barrier begins.</li>
6078   </ul>
6079 <p>
6080   These semantics are applied with a logical "and" behavior when more than  one
6081   is enabled in a single memory barrier intrinsic.
6082 </p>
6083 <p>
6084   Backends may implement stronger barriers than those requested when they do not
6085   support as fine grained a barrier as requested.  Some architectures do not
6086   need all types of barriers and on such architectures, these become noops.
6087 </p>
6088 <h5>Example:</h5>
6089 <pre>
6090 %ptr      = malloc i32
6091             store i32 4, %ptr
6092
6093 %result1  = load i32* %ptr      <i>; yields {i32}:result1 = 4</i>
6094             call void @llvm.memory.barrier( i1 false, i1 true, i1 false, i1 false )
6095                                 <i>; guarantee the above finishes</i>
6096             store i32 8, %ptr   <i>; before this begins</i>
6097 </pre>
6098 </div>
6099
6100 <!-- _______________________________________________________________________ -->
6101 <div class="doc_subsubsection">
6102   <a name="int_atomic_cmp_swap">'<tt>llvm.atomic.cmp.swap.*</tt>' Intrinsic</a>
6103 </div>
6104 <div class="doc_text">
6105 <h5>Syntax:</h5>
6106 <p>
6107   This is an overloaded intrinsic. You can use <tt>llvm.atomic.cmp.swap</tt> on
6108   any integer bit width and for different address spaces. Not all targets
6109   support all bit widths however.</p>
6110
6111 <pre>
6112 declare i8 @llvm.atomic.cmp.swap.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;cmp&gt;, i8 &lt;val&gt; )
6113 declare i16 @llvm.atomic.cmp.swap.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;cmp&gt;, i16 &lt;val&gt; )
6114 declare i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;cmp&gt;, i32 &lt;val&gt; )
6115 declare i64 @llvm.atomic.cmp.swap.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;cmp&gt;, i64 &lt;val&gt; )
6116
6117 </pre>
6118 <h5>Overview:</h5>
6119 <p>
6120   This loads a value in memory and compares it to a given value. If they are
6121   equal, it stores a new value into the memory.
6122 </p>
6123 <h5>Arguments:</h5>
6124 <p>
6125   The <tt>llvm.atomic.cmp.swap</tt> intrinsic takes three arguments. The result as
6126   well as both <tt>cmp</tt> and <tt>val</tt> must be integer values with the
6127   same bit width. The <tt>ptr</tt> argument must be a pointer to a value of
6128   this integer type. While any bit width integer may be used, targets may only
6129   lower representations they support in hardware.
6130
6131 </p>
6132 <h5>Semantics:</h5>
6133 <p>
6134   This entire intrinsic must be executed atomically. It first loads the value
6135   in memory pointed to by <tt>ptr</tt> and compares it with the value
6136   <tt>cmp</tt>. If they are equal, <tt>val</tt> is stored into the memory. The
6137   loaded value is yielded in all cases. This provides the equivalent of an
6138   atomic compare-and-swap operation within the SSA framework.
6139 </p>
6140 <h5>Examples:</h5>
6141
6142 <pre>
6143 %ptr      = malloc i32
6144             store i32 4, %ptr
6145
6146 %val1     = add i32 4, 4
6147 %result1  = call i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* %ptr, i32 4, %val1 )
6148                                           <i>; yields {i32}:result1 = 4</i>
6149 %stored1  = icmp eq i32 %result1, 4       <i>; yields {i1}:stored1 = true</i>
6150 %memval1  = load i32* %ptr                <i>; yields {i32}:memval1 = 8</i>
6151
6152 %val2     = add i32 1, 1
6153 %result2  = call i32 @llvm.atomic.cmp.swap.i32.p0i32( i32* %ptr, i32 5, %val2 )
6154                                           <i>; yields {i32}:result2 = 8</i>
6155 %stored2  = icmp eq i32 %result2, 5       <i>; yields {i1}:stored2 = false</i>
6156
6157 %memval2  = load i32* %ptr                <i>; yields {i32}:memval2 = 8</i>
6158 </pre>
6159 </div>
6160
6161 <!-- _______________________________________________________________________ -->
6162 <div class="doc_subsubsection">
6163   <a name="int_atomic_swap">'<tt>llvm.atomic.swap.*</tt>' Intrinsic</a>
6164 </div>
6165 <div class="doc_text">
6166 <h5>Syntax:</h5>
6167
6168 <p>
6169   This is an overloaded intrinsic. You can use <tt>llvm.atomic.swap</tt> on any
6170   integer bit width. Not all targets support all bit widths however.</p>
6171 <pre>
6172 declare i8 @llvm.atomic.swap.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;val&gt; )
6173 declare i16 @llvm.atomic.swap.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;val&gt; )
6174 declare i32 @llvm.atomic.swap.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;val&gt; )
6175 declare i64 @llvm.atomic.swap.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;val&gt; )
6176
6177 </pre>
6178 <h5>Overview:</h5>
6179 <p>
6180   This intrinsic loads the value stored in memory at <tt>ptr</tt> and yields
6181   the value from memory. It then stores the value in <tt>val</tt> in the memory
6182   at <tt>ptr</tt>.
6183 </p>
6184 <h5>Arguments:</h5>
6185
6186 <p>
6187   The <tt>llvm.atomic.swap</tt> intrinsic takes two arguments. Both the
6188   <tt>val</tt> argument and the result must be integers of the same bit width.
6189   The first argument, <tt>ptr</tt>, must be a pointer to a value of this
6190   integer type. The targets may only lower integer representations they
6191   support.
6192 </p>
6193 <h5>Semantics:</h5>
6194 <p>
6195   This intrinsic loads the value pointed to by <tt>ptr</tt>, yields it, and
6196   stores <tt>val</tt> back into <tt>ptr</tt> atomically. This provides the
6197   equivalent of an atomic swap operation within the SSA framework.
6198
6199 </p>
6200 <h5>Examples:</h5>
6201 <pre>
6202 %ptr      = malloc i32
6203             store i32 4, %ptr
6204
6205 %val1     = add i32 4, 4
6206 %result1  = call i32 @llvm.atomic.swap.i32.p0i32( i32* %ptr, i32 %val1 )
6207                                         <i>; yields {i32}:result1 = 4</i>
6208 %stored1  = icmp eq i32 %result1, 4     <i>; yields {i1}:stored1 = true</i>
6209 %memval1  = load i32* %ptr              <i>; yields {i32}:memval1 = 8</i>
6210
6211 %val2     = add i32 1, 1
6212 %result2  = call i32 @llvm.atomic.swap.i32.p0i32( i32* %ptr, i32 %val2 )
6213                                         <i>; yields {i32}:result2 = 8</i>
6214
6215 %stored2  = icmp eq i32 %result2, 8     <i>; yields {i1}:stored2 = true</i>
6216 %memval2  = load i32* %ptr              <i>; yields {i32}:memval2 = 2</i>
6217 </pre>
6218 </div>
6219
6220 <!-- _______________________________________________________________________ -->
6221 <div class="doc_subsubsection">
6222   <a name="int_atomic_load_add">'<tt>llvm.atomic.load.add.*</tt>' Intrinsic</a>
6223
6224 </div>
6225 <div class="doc_text">
6226 <h5>Syntax:</h5>
6227 <p>
6228   This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.add</tt> on any
6229   integer bit width. Not all targets support all bit widths however.</p>
6230 <pre>
6231 declare i8 @llvm.atomic.load.add.i8..p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6232 declare i16 @llvm.atomic.load.add.i16..p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6233 declare i32 @llvm.atomic.load.add.i32..p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6234 declare i64 @llvm.atomic.load.add.i64..p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6235
6236 </pre>
6237 <h5>Overview:</h5>
6238 <p>
6239   This intrinsic adds <tt>delta</tt> to the value stored in memory at
6240   <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.
6241 </p>
6242 <h5>Arguments:</h5>
6243 <p>
6244
6245   The intrinsic takes two arguments, the first a pointer to an integer value
6246   and the second an integer value. The result is also an integer value. These
6247   integer types can have any bit width, but they must all have the same bit
6248   width. The targets may only lower integer representations they support.
6249 </p>
6250 <h5>Semantics:</h5>
6251 <p>
6252   This intrinsic does a series of operations atomically. It first loads the
6253   value stored at <tt>ptr</tt>. It then adds <tt>delta</tt>, stores the result
6254   to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.
6255 </p>
6256
6257 <h5>Examples:</h5>
6258 <pre>
6259 %ptr      = malloc i32
6260         store i32 4, %ptr
6261 %result1  = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 4 )
6262                                 <i>; yields {i32}:result1 = 4</i>
6263 %result2  = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 2 )
6264                                 <i>; yields {i32}:result2 = 8</i>
6265 %result3  = call i32 @llvm.atomic.load.add.i32.p0i32( i32* %ptr, i32 5 )
6266                                 <i>; yields {i32}:result3 = 10</i>
6267 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 15</i>
6268 </pre>
6269 </div>
6270
6271 <!-- _______________________________________________________________________ -->
6272 <div class="doc_subsubsection">
6273   <a name="int_atomic_load_sub">'<tt>llvm.atomic.load.sub.*</tt>' Intrinsic</a>
6274
6275 </div>
6276 <div class="doc_text">
6277 <h5>Syntax:</h5>
6278 <p>
6279   This is an overloaded intrinsic. You can use <tt>llvm.atomic.load.sub</tt> on
6280   any integer bit width and for different address spaces. Not all targets
6281   support all bit widths however.</p>
6282 <pre>
6283 declare i8 @llvm.atomic.load.sub.i8.p0i32( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6284 declare i16 @llvm.atomic.load.sub.i16.p0i32( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6285 declare i32 @llvm.atomic.load.sub.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6286 declare i64 @llvm.atomic.load.sub.i64.p0i32( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6287
6288 </pre>
6289 <h5>Overview:</h5>
6290 <p>
6291   This intrinsic subtracts <tt>delta</tt> to the value stored in memory at
6292   <tt>ptr</tt>. It yields the original value at <tt>ptr</tt>.
6293 </p>
6294 <h5>Arguments:</h5>
6295 <p>
6296
6297   The intrinsic takes two arguments, the first a pointer to an integer value
6298   and the second an integer value. The result is also an integer value. These
6299   integer types can have any bit width, but they must all have the same bit
6300   width. The targets may only lower integer representations they support.
6301 </p>
6302 <h5>Semantics:</h5>
6303 <p>
6304   This intrinsic does a series of operations atomically. It first loads the
6305   value stored at <tt>ptr</tt>. It then subtracts <tt>delta</tt>, stores the
6306   result to <tt>ptr</tt>. It yields the original value stored at <tt>ptr</tt>.
6307 </p>
6308
6309 <h5>Examples:</h5>
6310 <pre>
6311 %ptr      = malloc i32
6312         store i32 8, %ptr
6313 %result1  = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 4 )
6314                                 <i>; yields {i32}:result1 = 8</i>
6315 %result2  = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 2 )
6316                                 <i>; yields {i32}:result2 = 4</i>
6317 %result3  = call i32 @llvm.atomic.load.sub.i32.p0i32( i32* %ptr, i32 5 )
6318                                 <i>; yields {i32}:result3 = 2</i>
6319 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = -3</i>
6320 </pre>
6321 </div>
6322
6323 <!-- _______________________________________________________________________ -->
6324 <div class="doc_subsubsection">
6325   <a name="int_atomic_load_and">'<tt>llvm.atomic.load.and.*</tt>' Intrinsic</a><br>
6326   <a name="int_atomic_load_nand">'<tt>llvm.atomic.load.nand.*</tt>' Intrinsic</a><br>
6327   <a name="int_atomic_load_or">'<tt>llvm.atomic.load.or.*</tt>' Intrinsic</a><br>
6328   <a name="int_atomic_load_xor">'<tt>llvm.atomic.load.xor.*</tt>' Intrinsic</a><br>
6329
6330 </div>
6331 <div class="doc_text">
6332 <h5>Syntax:</h5>
6333 <p>
6334   These are overloaded intrinsics. You can use <tt>llvm.atomic.load_and</tt>,
6335   <tt>llvm.atomic.load_nand</tt>, <tt>llvm.atomic.load_or</tt>, and
6336   <tt>llvm.atomic.load_xor</tt> on any integer bit width and for different
6337   address spaces. Not all targets support all bit widths however.</p>
6338 <pre>
6339 declare i8 @llvm.atomic.load.and.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6340 declare i16 @llvm.atomic.load.and.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6341 declare i32 @llvm.atomic.load.and.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6342 declare i64 @llvm.atomic.load.and.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6343
6344 </pre>
6345
6346 <pre>
6347 declare i8 @llvm.atomic.load.or.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6348 declare i16 @llvm.atomic.load.or.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6349 declare i32 @llvm.atomic.load.or.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6350 declare i64 @llvm.atomic.load.or.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6351
6352 </pre>
6353
6354 <pre>
6355 declare i8 @llvm.atomic.load.nand.i8.p0i32( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6356 declare i16 @llvm.atomic.load.nand.i16.p0i32( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6357 declare i32 @llvm.atomic.load.nand.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6358 declare i64 @llvm.atomic.load.nand.i64.p0i32( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6359
6360 </pre>
6361
6362 <pre>
6363 declare i8 @llvm.atomic.load.xor.i8.p0i32( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6364 declare i16 @llvm.atomic.load.xor.i16.p0i32( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6365 declare i32 @llvm.atomic.load.xor.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6366 declare i64 @llvm.atomic.load.xor.i64.p0i32( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6367
6368 </pre>
6369 <h5>Overview:</h5>
6370 <p>
6371   These intrinsics bitwise the operation (and, nand, or, xor) <tt>delta</tt> to
6372   the value stored in memory at <tt>ptr</tt>. It yields the original value
6373   at <tt>ptr</tt>.
6374 </p>
6375 <h5>Arguments:</h5>
6376 <p>
6377
6378   These intrinsics take two arguments, the first a pointer to an integer value
6379   and the second an integer value. The result is also an integer value. These
6380   integer types can have any bit width, but they must all have the same bit
6381   width. The targets may only lower integer representations they support.
6382 </p>
6383 <h5>Semantics:</h5>
6384 <p>
6385   These intrinsics does a series of operations atomically. They first load the
6386   value stored at <tt>ptr</tt>. They then do the bitwise operation
6387   <tt>delta</tt>, store the result to <tt>ptr</tt>. They yield the original
6388   value stored at <tt>ptr</tt>.
6389 </p>
6390
6391 <h5>Examples:</h5>
6392 <pre>
6393 %ptr      = malloc i32
6394         store i32 0x0F0F, %ptr
6395 %result0  = call i32 @llvm.atomic.load.nand.i32.p0i32( i32* %ptr, i32 0xFF )
6396                                 <i>; yields {i32}:result0 = 0x0F0F</i>
6397 %result1  = call i32 @llvm.atomic.load.and.i32.p0i32( i32* %ptr, i32 0xFF )
6398                                 <i>; yields {i32}:result1 = 0xFFFFFFF0</i>
6399 %result2  = call i32 @llvm.atomic.load.or.i32.p0i32( i32* %ptr, i32 0F )
6400                                 <i>; yields {i32}:result2 = 0xF0</i>
6401 %result3  = call i32 @llvm.atomic.load.xor.i32.p0i32( i32* %ptr, i32 0F )
6402                                 <i>; yields {i32}:result3 = FF</i>
6403 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = F0</i>
6404 </pre>
6405 </div>
6406
6407
6408 <!-- _______________________________________________________________________ -->
6409 <div class="doc_subsubsection">
6410   <a name="int_atomic_load_max">'<tt>llvm.atomic.load.max.*</tt>' Intrinsic</a><br>
6411   <a name="int_atomic_load_min">'<tt>llvm.atomic.load.min.*</tt>' Intrinsic</a><br>
6412   <a name="int_atomic_load_umax">'<tt>llvm.atomic.load.umax.*</tt>' Intrinsic</a><br>
6413   <a name="int_atomic_load_umin">'<tt>llvm.atomic.load.umin.*</tt>' Intrinsic</a><br>
6414
6415 </div>
6416 <div class="doc_text">
6417 <h5>Syntax:</h5>
6418 <p>
6419   These are overloaded intrinsics. You can use <tt>llvm.atomic.load_max</tt>,
6420   <tt>llvm.atomic.load_min</tt>, <tt>llvm.atomic.load_umax</tt>, and
6421   <tt>llvm.atomic.load_umin</tt> on any integer bit width and for different
6422   address spaces. Not all targets
6423   support all bit widths however.</p>
6424 <pre>
6425 declare i8 @llvm.atomic.load.max.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6426 declare i16 @llvm.atomic.load.max.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6427 declare i32 @llvm.atomic.load.max.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6428 declare i64 @llvm.atomic.load.max.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6429
6430 </pre>
6431
6432 <pre>
6433 declare i8 @llvm.atomic.load.min.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6434 declare i16 @llvm.atomic.load.min.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6435 declare i32 @llvm.atomic.load.min.i32..p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6436 declare i64 @llvm.atomic.load.min.i64..p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6437
6438 </pre>
6439
6440 <pre>
6441 declare i8 @llvm.atomic.load.umax.i8.p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6442 declare i16 @llvm.atomic.load.umax.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6443 declare i32 @llvm.atomic.load.umax.i32.p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6444 declare i64 @llvm.atomic.load.umax.i64.p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6445
6446 </pre>
6447
6448 <pre>
6449 declare i8 @llvm.atomic.load.umin.i8..p0i8( i8* &lt;ptr&gt;, i8 &lt;delta&gt; )
6450 declare i16 @llvm.atomic.load.umin.i16.p0i16( i16* &lt;ptr&gt;, i16 &lt;delta&gt; )
6451 declare i32 @llvm.atomic.load.umin.i32..p0i32( i32* &lt;ptr&gt;, i32 &lt;delta&gt; )
6452 declare i64 @llvm.atomic.load.umin.i64..p0i64( i64* &lt;ptr&gt;, i64 &lt;delta&gt; )
6453
6454 </pre>
6455 <h5>Overview:</h5>
6456 <p>
6457   These intrinsics takes the signed or unsigned minimum or maximum of
6458   <tt>delta</tt> and the value stored in memory at <tt>ptr</tt>. It yields the
6459   original value at <tt>ptr</tt>.
6460 </p>
6461 <h5>Arguments:</h5>
6462 <p>
6463
6464   These intrinsics take two arguments, the first a pointer to an integer value
6465   and the second an integer value. The result is also an integer value. These
6466   integer types can have any bit width, but they must all have the same bit
6467   width. The targets may only lower integer representations they support.
6468 </p>
6469 <h5>Semantics:</h5>
6470 <p>
6471   These intrinsics does a series of operations atomically. They first load the
6472   value stored at <tt>ptr</tt>. They then do the signed or unsigned min or max
6473   <tt>delta</tt> and the value, store the result to <tt>ptr</tt>. They yield
6474   the original value stored at <tt>ptr</tt>.
6475 </p>
6476
6477 <h5>Examples:</h5>
6478 <pre>
6479 %ptr      = malloc i32
6480         store i32 7, %ptr
6481 %result0  = call i32 @llvm.atomic.load.min.i32.p0i32( i32* %ptr, i32 -2 )
6482                                 <i>; yields {i32}:result0 = 7</i>
6483 %result1  = call i32 @llvm.atomic.load.max.i32.p0i32( i32* %ptr, i32 8 )
6484                                 <i>; yields {i32}:result1 = -2</i>
6485 %result2  = call i32 @llvm.atomic.load.umin.i32.p0i32( i32* %ptr, i32 10 )
6486                                 <i>; yields {i32}:result2 = 8</i>
6487 %result3  = call i32 @llvm.atomic.load.umax.i32.p0i32( i32* %ptr, i32 30 )
6488                                 <i>; yields {i32}:result3 = 8</i>
6489 %memval1  = load i32* %ptr      <i>; yields {i32}:memval1 = 30</i>
6490 </pre>
6491 </div>
6492
6493 <!-- ======================================================================= -->
6494 <div class="doc_subsection">
6495   <a name="int_general">General Intrinsics</a>
6496 </div>
6497
6498 <div class="doc_text">
6499 <p> This class of intrinsics is designed to be generic and has
6500 no specific purpose. </p>
6501 </div>
6502
6503 <!-- _______________________________________________________________________ -->
6504 <div class="doc_subsubsection">
6505   <a name="int_var_annotation">'<tt>llvm.var.annotation</tt>' Intrinsic</a>
6506 </div>
6507
6508 <div class="doc_text">
6509
6510 <h5>Syntax:</h5>
6511 <pre>
6512   declare void @llvm.var.annotation(i8* &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6513 </pre>
6514
6515 <h5>Overview:</h5>
6516
6517 <p>
6518 The '<tt>llvm.var.annotation</tt>' intrinsic
6519 </p>
6520
6521 <h5>Arguments:</h5>
6522
6523 <p>
6524 The first argument is a pointer to a value, the second is a pointer to a
6525 global string, the third is a pointer to a global string which is the source
6526 file name, and the last argument is the line number.
6527 </p>
6528
6529 <h5>Semantics:</h5>
6530
6531 <p>
6532 This intrinsic allows annotation of local variables with arbitrary strings.
6533 This can be useful for special purpose optimizations that want to look for these
6534 annotations.  These have no other defined use, they are ignored by code
6535 generation and optimization.
6536 </p>
6537 </div>
6538
6539 <!-- _______________________________________________________________________ -->
6540 <div class="doc_subsubsection">
6541   <a name="int_annotation">'<tt>llvm.annotation.*</tt>' Intrinsic</a>
6542 </div>
6543
6544 <div class="doc_text">
6545
6546 <h5>Syntax:</h5>
6547 <p>This is an overloaded intrinsic. You can use '<tt>llvm.annotation</tt>' on
6548 any integer bit width.
6549 </p>
6550 <pre>
6551   declare i8 @llvm.annotation.i8(i8 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6552   declare i16 @llvm.annotation.i16(i16 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6553   declare i32 @llvm.annotation.i32(i32 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6554   declare i64 @llvm.annotation.i64(i64 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6555   declare i256 @llvm.annotation.i256(i256 &lt;val&gt;, i8* &lt;str&gt;, i8* &lt;str&gt;, i32  &lt;int&gt; )
6556 </pre>
6557
6558 <h5>Overview:</h5>
6559
6560 <p>
6561 The '<tt>llvm.annotation</tt>' intrinsic.
6562 </p>
6563
6564 <h5>Arguments:</h5>
6565
6566 <p>
6567 The first argument is an integer value (result of some expression),
6568 the second is a pointer to a global string, the third is a pointer to a global
6569 string which is the source file name, and the last argument is the line number.
6570 It returns the value of the first argument.
6571 </p>
6572
6573 <h5>Semantics:</h5>
6574
6575 <p>
6576 This intrinsic allows annotations to be put on arbitrary expressions
6577 with arbitrary strings.  This can be useful for special purpose optimizations
6578 that want to look for these annotations.  These have no other defined use, they
6579 are ignored by code generation and optimization.
6580 </p>
6581 </div>
6582
6583 <!-- _______________________________________________________________________ -->
6584 <div class="doc_subsubsection">
6585   <a name="int_trap">'<tt>llvm.trap</tt>' Intrinsic</a>
6586 </div>
6587
6588 <div class="doc_text">
6589
6590 <h5>Syntax:</h5>
6591 <pre>
6592   declare void @llvm.trap()
6593 </pre>
6594
6595 <h5>Overview:</h5>
6596
6597 <p>
6598 The '<tt>llvm.trap</tt>' intrinsic
6599 </p>
6600
6601 <h5>Arguments:</h5>
6602
6603 <p>
6604 None
6605 </p>
6606
6607 <h5>Semantics:</h5>
6608
6609 <p>
6610 This intrinsics is lowered to the target dependent trap instruction. If the
6611 target does not have a trap instruction, this intrinsic will be lowered to the
6612 call of the abort() function.
6613 </p>
6614 </div>
6615
6616 <!-- _______________________________________________________________________ -->
6617 <div class="doc_subsubsection">
6618   <a name="int_stackprotector">'<tt>llvm.stackprotector</tt>' Intrinsic</a>
6619 </div>
6620 <div class="doc_text">
6621 <h5>Syntax:</h5>
6622 <pre>
6623 declare void @llvm.stackprotector( i8* &lt;guard&gt;, i8** &lt;slot&gt; )
6624
6625 </pre>
6626 <h5>Overview:</h5>
6627 <p>
6628   The <tt>llvm.stackprotector</tt> intrinsic takes the <tt>guard</tt> and stores
6629   it onto the stack at <tt>slot</tt>. The stack slot is adjusted to ensure that
6630   it is placed on the stack before local variables.
6631 </p>
6632 <h5>Arguments:</h5>
6633 <p>
6634   The <tt>llvm.stackprotector</tt> intrinsic requires two pointer arguments. The
6635   first argument is the value loaded from the stack guard
6636   <tt>@__stack_chk_guard</tt>. The second variable is an <tt>alloca</tt> that
6637   has enough space to hold the value of the guard.
6638 </p>
6639 <h5>Semantics:</h5>
6640 <p>
6641   This intrinsic causes the prologue/epilogue inserter to force the position of
6642   the <tt>AllocaInst</tt> stack slot to be before local variables on the
6643   stack. This is to ensure that if a local variable on the stack is overwritten,
6644   it will destroy the value of the guard. When the function exits, the guard on
6645   the stack is checked against the original guard. If they're different, then
6646   the program aborts by calling the <tt>__stack_chk_fail()</tt> function.
6647 </p>
6648 </div>
6649
6650 <!-- *********************************************************************** -->
6651 <hr>
6652 <address>
6653   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
6654   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
6655   <a href="http://validator.w3.org/check/referer"><img
6656   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
6657
6658   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
6659   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
6660   Last modified: $Date$
6661 </address>
6662
6663 </body>
6664 </html>