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