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