docs/BytecodeFormat.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   5   <title>LLVM Bytecode File Format</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7   <style type="text/css">
   8     TR, TD { border: 2px solid gray; padding-left: 4pt; padding-right: 4pt;
   9              padding-top: 2pt; padding-bottom: 2pt; }
  10     TH { border: 2px solid gray; font-weight: bold; font-size: 105%; }
  11     TABLE { text-align: center; border: 2px solid black;
  12       border-collapse: collapse; margin-top: 1em; margin-left: 1em;
  13       margin-right: 1em; margin-bottom: 1em; }
  14     .td_left { border: 2px solid gray; text-align: left; }
  15   </style>
  16 </head>
  17 <body>
  18 <div class="doc_title"> LLVM Bytecode File Format </div>
  19 <ol>
  20   <li><a href="#abstract">Abstract</a></li>
  21   <li><a href="#concepts">Concepts</a>
  22     <ol>
  23       <li><a href="#blocks">Blocks</a></li>
  24       <li><a href="#lists">Lists</a></li>
  25       <li><a href="#fields">Fields</a></li>
  26       <li><a href="#align">Alignment</a></li>
  27       <li><a href="#vbr">Variable Bit-Rate Encoding</a></li>
  28       <li><a href="#encoding">Encoding Primitives</a></li>
  29       <li><a href="#slots">Slots</a></li>
  30     </ol>
  31   </li>
  32   <li><a href="#general">General Structure</a> </li>
  33   <li><a href="#blockdefs">Block Definitions</a>
  34     <ol>
  35       <li><a href="#signature">Signature Block</a></li>
  36       <li><a href="#module">Module Block</a></li>
  37       <li><a href="#globaltypes">Global Type Pool</a></li>
  38       <li><a href="#globalinfo">Module Info Block</a></li>
  39       <li><a href="#constantpool">Global Constant Pool</a></li>
  40       <li><a href="#functiondefs">Function Definition</a></li>
  41       <li><a href="#instructionlist">Instructions List</a></li>
  42       <li><a href="#instructions">Instructions</a></li>
  43       <li><a href="#symtab">Symbol Table</a></li>
  44     </ol>
  45   </li>
  46   <li><a href="#versiondiffs">Version Differences</a>
  47     <ol>
  48       <li><a href="#vers13">Version 1.3 Differences From 1.4</a></li>
  49       <li><a href="#vers12">Version 1.2 Differences From 1.3</a></li>
  50       <li><a href="#vers11">Version 1.1 Differences From 1.2</a></li>
  51       <li><a href="#vers10">Version 1.0 Differences From 1.1</a></li>
  52     </ol>
  53   </li>
  54 </ol>
  55 <div class="doc_author">
  56 <p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
  57 </p>
  58 </div>
  59 <!-- *********************************************************************** -->
  60 <div class="doc_section"> <a name="abstract">Abstract </a></div>
  61 <!-- *********************************************************************** -->
  62 <div class="doc_text">
  63 <p>This document describes the LLVM bytecode file format. It specifies
  64 the binary encoding rules of the bytecode file format so that
  65 equivalent systems can encode bytecode files correctly. The LLVM
  66 bytecode representation is used to store the intermediate
  67 representation on disk in compacted form.</p>
  68 <p>The LLVM bytecode format may change in the future, but LLVM will
  69 always be backwards compatible with older formats. This document will
  70 only describe the most current version of the bytecode format. See <a
  71  href="#versiondiffs">Version Differences</a> for the details on how
  72 the current version is different from previous versions.</p>
  73 </div>
  74 <!-- *********************************************************************** -->
  75 <div class="doc_section"> <a name="concepts">Concepts</a> </div>
  76 <!-- *********************************************************************** -->
  77 <div class="doc_text">
  78 <p>This section describes the general concepts of the bytecode file
  79 format without getting into specific layout details. It is recommended
  80 that you read this section thoroughly before interpreting the detailed
  81 descriptions.</p>
  82 </div>
  83 <!-- _______________________________________________________________________ -->
  84 <div class="doc_subsection"><a name="blocks">Blocks</a> </div>
  85 <div class="doc_text">
  86 <p>LLVM bytecode files consist simply of a sequence of blocks of bytes
  87 using a binary encoding Each block begins with an header of two
  88 unsigned integers. The first value identifies the type of block and the
  89 second value provides the size of the block in bytes. The block
  90 identifier is used because it is possible for entire blocks to be
  91 omitted from the file if they are empty. The block identifier helps the
  92 reader determine which kind of block is next in the file. Note that
  93 blocks can be nested within other blocks.</p>
  94 <p> All blocks are variable length, and the block header specifies the
  95 size of the block. All blocks begin on a byte index that is aligned to
  96 an even 32-bit boundary. That is, the first block is 32-bit aligned
  97 because it starts at offset 0. Each block is padded with zero fill
  98 bytes to ensure that the next block also starts on a 32-bit boundary.</p>
  99 </div>
 100 <!-- _______________________________________________________________________ -->
 101 <div class="doc_subsection"><a name="lists">Lists</a> </div>
 102 <div class="doc_text">
 103 <p>LLVM Bytecode blocks often contain lists of things of a similar
 104 type. For example, a function contains a list of instructions and a
 105 function type contains a list of argument types. There are two basic
 106 types of lists: length lists (<a href="#llist">llist</a>), and null
 107 terminated lists (<a href="#zlist">zlist</a>), as described below in
 108 the <a href="#encoding">Encoding Primitives</a>.</p>
 109 </div>
 110 <!-- _______________________________________________________________________ -->
 111 <div class="doc_subsection"><a name="fields">Fields</a> </div>
 112 <div class="doc_text">
 113 <p>Fields are units of information that LLVM knows how to write atomically. Most
 114 fields have a uniform length or some kind of length indication built into their
 115 encoding. For example, a constant string (array of bytes) is written simply as
 116 the length followed by the characters. Although this is similar to a list,
 117 constant strings are treated atomically and are thus fields.</p>
 118 <p>Fields use a condensed bit format specific to the type of information
 119 they must contain. As few bits as possible are written for each field. The
 120 sections that follow will provide the details on how these fields are
 121 written and how the bits are to be interpreted.</p>
 122 </div>
 123 <!-- _______________________________________________________________________ -->
 124 <div class="doc_subsection"><a name="align">Alignment</a> </div>
 125 <div class="doc_text">
 126   <p>To support cross-platform differences, the bytecode file is aligned on
 127   certain boundaries. This means that a small amount of padding (at most 3
 128   bytes) will be added to ensure that the next entry is aligned to a 32-bit
 129   boundary.</p>
 130 </div>
 131 <!-- _______________________________________________________________________ -->
 132 <div class="doc_subsection"><a name="vbr">Variable Bit-Rate Encoding</a>
 133 </div>
 134 <div class="doc_text">
 135 <p>Most of the values written to LLVM bytecode files are small integers. To
 136 minimize the number of bytes written for these quantities, an encoding scheme
 137 similar to UTF-8 is used to write integer data. The scheme is known as
 138 variable bit rate (vbr) encoding. In this encoding, the high bit of
 139 each byte is used to indicate if more bytes follow. If (byte &amp;
 140 0x80) is non-zero in any given byte, it means there is another byte
 141 immediately following that also contributes to the value. For the final
 142 byte (byte &amp; 0x80) is false (the high bit is not set). In each byte
 143 only the low seven bits contribute to the value. Consequently 32-bit
 144 quantities can take from one to <em>five</em> bytes to encode. In
 145 general, smaller quantities will encode in fewer bytes, as follows:</p>
 146 <table>
 147   <tbody>
 148     <tr>
 149       <th>Byte #</th>
 150       <th>Significant Bits</th>
 151       <th>Maximum Value</th>
 152     </tr>
 153     <tr>
 154       <td>1</td>
 155       <td>0-6</td>
 156       <td>127</td>
 157     </tr>
 158     <tr>
 159       <td>2</td>
 160       <td>7-13</td>
 161       <td>16,383</td>
 162     </tr>
 163     <tr>
 164       <td>3</td>
 165       <td>14-20</td>
 166       <td>2,097,151</td>
 167     </tr>
 168     <tr>
 169       <td>4</td>
 170       <td>21-27</td>
 171       <td>268,435,455</td>
 172     </tr>
 173     <tr>
 174       <td>5</td>
 175       <td>28-34</td>
 176       <td>34,359,738,367</td>
 177     </tr>
 178     <tr>
 179       <td>6</td>
 180       <td>35-41</td>
 181       <td>4,398,046,511,103</td>
 182     </tr>
 183     <tr>
 184       <td>7</td>
 185       <td>42-48</td>
 186       <td>562,949,953,421,311</td>
 187     </tr>
 188     <tr>
 189       <td>8</td>
 190       <td>49-55</td>
 191       <td>72,057,594,037,927,935</td>
 192     </tr>
 193     <tr>
 194       <td>9</td>
 195       <td>56-62</td>
 196       <td>9,223,372,036,854,775,807</td>
 197     </tr>
 198     <tr>
 199       <td>10</td>
 200       <td>63-69</td>
 201       <td>1,180,591,620,717,411,303,423</td>
 202     </tr>
 203   </tbody>
 204 </table>
 205 <p>Note that in practice, the tenth byte could only encode bit 63 since
 206 the maximum quantity to use this encoding is a 64-bit integer.</p>
 207 <p><em>Signed</em> VBR values are encoded with the standard vbr
 208 encoding, but with the sign bit as the low order bit instead of the
 209 high order bit. This allows small negative quantities to be encoded
 210 efficiently. For example, -3
 211 is encoded as "((3 &lt;&lt; 1) | 1)" and 3 is encoded as "(3 &lt;&lt;
 212 1) | 0)", emitted with the standard vbr encoding above.</p>
 213 </div>
 214 <!-- _______________________________________________________________________ -->
 215 <div class="doc_subsection"><a name="encoding">Encoding Primitives</a> </div>
 216 <div class="doc_text">
 217 <p>Each field in the bytecode format is encoded into the file using a
 218 small set of primitive formats. The table below defines the encoding
 219 rules for the various primitives used and gives them each a type name.
 220 The type names used in the descriptions of blocks and fields in the <a
 221  href="#details">Detailed Layout</a>next section. Any type name with
 222 the suffix <em>_vbr</em> indicates a quantity that is encoded using
 223 variable bit rate encoding as described above.</p>
 224 <table class="doc_table">
 225   <tbody>
 226     <tr>
 227       <th><b>Type</b></th>
 228       <th class="td_left"><b>Rule</b></th>
 229     </tr>
 230     <tr>
 231       <td><a name="unsigned"><b>unsigned</b></a></td>
 232       <td class="td_left">A 32-bit unsigned integer that always occupies four
 233       consecutive bytes. The unsigned integer is encoded using LSB first
 234       ordering. That is bits 2<sup>0</sup> through 2<sup>7</sup> are in the
 235       byte with the lowest file offset (little endian).</td>
 236     </tr>
 237     <tr>
 238       <td style="vertical-align: top;"><a name="uint24_vbr">
 239         <b>uint24_vbr</b></a></td>
 240       <td style="vertical-align: top; text-align: left;">A 24-bit unsigned
 241       integer that occupies from one to four bytes using variable bit rate
 242       encoding.</td>
 243     </tr>
 244     <tr>
 245       <td><a name="uint32_vbr"><b>uint32_vbr</b></a></td>
 246       <td class="td_left">A 32-bit unsigned integer that occupies from one to
 247         five bytes using variable bit rate encoding.</td>
 248     </tr>
 249     <tr>
 250       <td><a name="uint64_vbr"><b>uint64_vbr</b></a></td>
 251       <td class="td_left">A 64-bit unsigned integer that occupies from one to
 252         ten bytes using variable bit rate encoding.</td>
 253     </tr>
 254     <tr>
 255       <td><a name="int64_vbr"><b>int64_vbr</b></a></td>
 256       <td class="td_left">A 64-bit signed integer that occupies from one to ten
 257         bytes using the signed variable bit rate encoding.</td>
 258     </tr>
 259     <tr>
 260       <td><a name="char"><b>char</b></a></td>
 261       <td class="td_left">A single unsigned character encoded into one byte</td>
 262     </tr>
 263     <tr>
 264       <td><a name="bit"><b>bit(n-m)</b></a></td>
 265       <td class="td_left">A set of bit within some larger integer field. The
 266         values of <code>n</code> and <code>m</code> specify the inclusive range
 267         of bits that define the subfield. The value for <code>m</code> may be
 268         omitted if its the same as <code>n</code>.</td>
 269     </tr>
 270     <tr>
 271       <td style="vertical-align: top;"><b><a name="float"><b>float</b></a></b>
 272       </td>
 273       <td style="vertical-align: top; text-align: left;">A floating point
 274         value encoded as a 32-bit IEEE value written in little-endian form.<br>
 275       </td>
 276     </tr>
 277     <tr>
 278       <td style="vertical-align: top;"><b><b><a name="double"><b>double</b></a>
 279       </b></b></td>
 280       <td style="vertical-align: top; text-align: left;">A floating point value
 281         encoded as a64-bit IEEE value written in little-endian form</td>
 282     </tr>
 283     <tr>
 284       <td><a name="string"><b>string</b></a></td>
 285       <td class="td_left">A uint32_vbr indicating the type of the constant
 286         string which also includes its length, immediately followed by the
 287         characters of the string. There is no terminating null byte in the
 288         string.</td>
 289     </tr>
 290     <tr>
 291       <td><a name="data"><b>data</b></a></td>
 292       <td class="td_left">An arbitrarily long segment of data to which no
 293         interpretation is implied. This is used for constant initializers.<br>
 294       </td>
 295     </tr>
 296     <tr>
 297       <td><a name="llist"><b>llist(x)</b></a></td>
 298       <td class="td_left">A length list of x. This means the list is encoded
 299         as an <a href="#uint32_vbr">uint32_vbr</a> providing the length of the
 300         list, followed by a sequence of that many "x" items. This implies that
 301         the reader should iterate the number of times provided by the length.
 302       </td>
 303     </tr>
 304     <tr>
 305       <td><a name="zlist"><b>zlist(x)</b></a></td>
 306       <td class="td_left">A zero-terminated list of x. This means the list is
 307         encoded as a sequence of an indeterminate number of "x" items, followed
 308         by an <a href="#uint32_vbr">uint32_vbr</a> terminating value.  This
 309         implies that none of the "x" items can have a zero value (or else the
 310         list terminates).</td>
 311     </tr>
 312     <tr>
 313       <td><a name="block"><b>block</b></a></td>
 314       <td class="td_left">A block of data that is logically related. A block
 315         is an unsigned 32-bit integer that encodes the type of the block in
 316         the low 5 bits and the size of the block in the high 27 bits. The
 317         length does not include the block header or any alignment bytes at the
 318         end of the block. Blocks may compose other blocks. </td>
 319     </tr>
 320   </tbody>
 321 </table>
 322 </div>
 323 <!-- _______________________________________________________________________ -->
 324 <div class="doc_subsection"><a name="notation">Field Notation</a> </div>
 325 <div class="doc_text">
 326 <p>In the detailed block and field descriptions that follow, a regex
 327 like notation is used to describe optional and repeated fields. A very
 328 limited subset of regex is used to describe these, as given in the
 329 following table: </p>
 330 <table class="doc_table">
 331   <tbody>
 332     <tr>
 333       <th><b>Character</b></th>
 334       <th class="td_left"><b>Meaning</b></th>
 335     </tr>
 336     <tr>
 337       <td><b><code>?</code></b></td>
 338       <td class="td_left">The question mark indicates 0 or 1 occurrences of
 339         the thing preceding it.</td>
 340     </tr>
 341     <tr>
 342       <td><b><code>*</code></b></td>
 343       <td class="td_left">The asterisk indicates 0 or more occurrences of the
 344         thing preceding it.</td>
 345     </tr>
 346     <tr>
 347       <td><b><code>+</code></b></td>
 348       <td class="td_left">The plus sign indicates 1 or more occurrences of the
 349         thing preceding it.</td>
 350     </tr>
 351     <tr>
 352       <td><b><code>()</code></b></td>
 353       <td class="td_left">Parentheses are used for grouping.</td>
 354     </tr>
 355     <tr>
 356       <td><b><code>,</code></b></td>
 357       <td class="td_left">The comma separates sequential fields.</td>
 358     </tr>
 359   </tbody>
 360 </table>
 361 <p>So, for example, consider the following specifications:</p>
 362 <div class="doc_code">
 363 <ol>
 364   <li><code>string?</code></li>
 365   <li><code>(uint32_vbr,uin32_vbr)+</code></li>
 366   <li><code>(unsigned?,uint32_vbr)*</code></li>
 367   <li><code>(llist(unsigned))?</code></li>
 368 </ol>
 369 </div>
 370 <p>with the following interpretations:</p>
 371 <ol>
 372   <li>An optional string. Matches either nothing or a single string</li>
 373   <li>One or more pairs of uint32_vbr.</li>
 374   <li>Zero or more occurrences of either an unsigned followed by a uint32_vbr
 375   or just a uint32_vbr.</li>
 376   <li>An optional length list of unsigned values.</li>
 377 </ol>
 378 </div>
 379 <!-- _______________________________________________________________________ -->
 380 <div class="doc_subsection"><a name="slots">Slots</a> </div>
 381 <div class="doc_text">
 382 <p>The bytecode format uses the notion of a "slot" to reference Types
 383 and Values. Since the bytecode file is a <em>direct</em> representation of
 384 LLVM's intermediate representation, there is a need to represent pointers in
 385 the file.  Slots are used for this purpose. For example, if one has the
 386 following assembly:
 387 </p>
 388 <div class="doc_code"><code> %MyType = type { int, sbyte }<br>
 389 %MyVar = external global %MyType
 390 </code></div>
 391 <p>there are two definitions. The definition of <tt>%MyVar</tt> uses
 392 <tt>%MyType</tt>.
 393 In the C++ IR this linkage between <tt>%MyVar</tt> and <tt>%MyType</tt>
 394 is explicit through the use of C++ pointers. In bytecode, however, there's no
 395 ability to store memory addresses. Instead, we compute and write out
 396 slot numbers for every Type and Value written to the file.</p>
 397 <p>A slot number is simply an unsigned 32-bit integer encoded in the variable
 398 bit rate scheme (see <a href="#encoding">encoding</a>). This ensures that
 399 low slot numbers are encoded in one byte. Through various bits of magic LLVM
 400 attempts to always keep the slot numbers low. The first attempt is to associate
 401 slot numbers with their "type plane". That is, Values of the same type
 402 are written to the bytecode file in a list (sequentially). Their order in
 403 that list determines their slot number. This means that slot #1 doesn't mean
 404 anything unless you also specify for which type you want slot #1. Types are
 405 always written to the file first (in the <a href="#globaltypes">Global Type
 406 Pool</a>) and in such a way that both forward and backward references of the
 407 types can often be resolved with a single pass through the type pool. </p>
 408 <p>In summary then, a slot number can be thought of as just a vbr encoded index
 409 into a list of Type* or Value*. To keep slot numbers low, Value* are indexed by
 410 two slot numbers: the "type plane index" (type slot) and the "value index"
 411 (value slot).</p>
 412 </div>
 413 <!-- *********************************************************************** -->
 414 <div class="doc_section"> <a name="general">General Structure</a> </div>
 415 <!-- *********************************************************************** -->
 416 <div class="doc_text">
 417 <p>This section provides the general structure of the LLVM bytecode
 418 file format. The bytecode file format requires blocks to be in a
 419 certain order and nested in a particular way so that an LLVM module can
 420 be constructed efficiently from the contents of the file. This ordering
 421 defines a general structure for bytecode files as shown below. The
 422 table below shows the order in which all block types may appear. Please
 423 note that some of the blocks are optional and some may be repeated. The
 424 structure is fairly loose because optional blocks, if empty, are
 425 completely omitted from the file.</p>
 426 <table>
 427   <tbody>
 428     <tr>
 429       <th>ID</th>
 430       <th>Parent</th>
 431       <th>Optional?</th>
 432       <th>Repeated?</th>
 433       <th>Level</th>
 434       <th>Block Type</th>
 435       <th>Description</th>
 436     </tr>
 437     <tr>
 438       <td>N/A</td>
 439       <td>File</td>
 440       <td>No</td>
 441       <td>No</td>
 442       <td>0</td>
 443       <td class="td_left"><a href="#signature">Signature</a></td>
 444       <td class="td_left">This contains the file signature (magic
 445 number) that identifies the file as LLVM bytecode.</td>
 446     </tr>
 447     <tr>
 448       <td>0x01</td>
 449       <td>File</td>
 450       <td>No</td>
 451       <td>No</td>
 452       <td>0</td>
 453       <td class="td_left"><a href="#module">Module</a></td>
 454       <td class="td_left">This is the top level block in a bytecode
 455 file. It contains all the other blocks. </td>
 456     </tr>
 457     <tr>
 458       <td>0x06</td>
 459       <td>Module</td>
 460       <td>No</td>
 461       <td>No</td>
 462       <td>1</td>
 463       <td class="td_left">&nbsp;&nbsp;&nbsp;<a href="#globaltypes">Global&nbsp;Type&nbsp;Pool</a></td>
 464       <td class="td_left">This block contains all the global (module)
 465 level types.</td>
 466     </tr>
 467     <tr>
 468       <td>0x05</td>
 469       <td>Module</td>
 470       <td>No</td>
 471       <td>No</td>
 472       <td>1</td>
 473       <td class="td_left">&nbsp;&nbsp;&nbsp;<a href="#globalinfo">Module&nbsp;Globals&nbsp;Info</a></td>
 474       <td class="td_left">This block contains the type, constness, and
 475 linkage for each of the global variables in the module. It also
 476 contains the type of the functions and the constant initializers.</td>
 477     </tr>
 478     <tr>
 479       <td>0x03</td>
 480       <td>Module</td>
 481       <td>Yes</td>
 482       <td>No</td>
 483       <td>1</td>
 484       <td class="td_left">&nbsp;&nbsp;&nbsp;<a href="#constantpool">Module&nbsp;Constant&nbsp;Pool</a></td>
 485       <td class="td_left">This block contains all the global constants
 486 except function arguments, global values and constant strings.</td>
 487     </tr>
 488     <tr>
 489       <td>0x02</td>
 490       <td>Module</td>
 491       <td>Yes</td>
 492       <td>Yes</td>
 493       <td>1</td>
 494       <td class="td_left">&nbsp;&nbsp;&nbsp;<a href="#functiondefs">Function&nbsp;Definitions</a>*</td>
 495       <td class="td_left">One function block is written for each
 496 function in the module. The function block contains the instructions,
 497 type constant pool, and symbol table for the function.</td>
 498     </tr>
 499     <tr>
 500       <td>0x03</td>
 501       <td>Function</td>
 502       <td>Yes</td>
 503       <td>No</td>
 504       <td>2</td>
 505       <td class="td_left">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a
 506  href="#constantpool">Function&nbsp;Constant&nbsp;Pool</a></td>
 507       <td class="td_left">Any constants (including types) used solely within
 508         the function are emitted here in the function constant pool. </td>
 509     </tr>
 510     <tr>
 511       <td>0x07</td>
 512       <td>Function</td>
 513       <td>No</td>
 514       <td>No</td>
 515       <td>2</td>
 516       <td class="td_left">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a
 517  href="#instructionlist">Instruction&nbsp;List</a></td>
 518       <td class="td_left">This block contains all the instructions of the
 519         function. The basic blocks are inferred by terminating instructions.
 520       </td>
 521     </tr>
 522     <tr>
 523       <td>0x04</td>
 524       <td>Function</td>
 525       <td>Yes</td>
 526       <td>No</td>
 527       <td>2</td>
 528       <td class="td_left">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a
 529  href="#symtab">Function&nbsp;Symbol&nbsp;Table</a></td>
 530       <td class="td_left">This symbol table provides the names for the function
 531         specific values used (basic block labels mostly).</td>
 532     </tr>
 533     <tr>
 534       <td>0x04</td>
 535       <td>Module</td>
 536       <td>Yes</td>
 537       <td>No</td>
 538       <td>1</td>
 539       <td class="td_left">&nbsp;&nbsp;&nbsp;<a href="#symtab">Module&nbsp;Symbol&nbsp;Table</a></td>
 540       <td class="td_left">This symbol table provides the names for the various
 541         entries in the file that are not function specific (global vars, and
 542         functions mostly).</td>
 543     </tr>
 544   </tbody>
 545 </table>
 546 <p>Use the links in the table for details about the contents of each of
 547 the block types.</p>
 548 </div>
 549 <!-- *********************************************************************** -->
 550 <div class="doc_section"> <a name="blockdefs">Block Definitions</a> </div>
 551 <!-- *********************************************************************** -->
 552 <div class="doc_text">
 553 <p>This section provides the detailed layout of the individual block
 554 types in the LLVM bytecode file format. </p>
 555 </div>
 556 <!-- _______________________________________________________________________ -->
 557 <div class="doc_subsection"><a name="signature">Signature Block</a> </div>
 558 <div class="doc_text">
 559 <p>The signature occurs in every LLVM bytecode file and is always first.
 560 It simply provides a few bytes of data to identify the file as being an LLVM
 561 bytecode file. This block is always four bytes in length and differs from the
 562 other blocks because there is no identifier and no block length at the start
 563 of the block. Essentially, this block is just the "magic number" for the file.
 564 </p>
 565 <p>There are two types of signatures for LLVM bytecode: uncompressed and
 566 compressed as shown in the table below. </p>
 567 <table>
 568   <tbody>
 569     <tr>
 570       <th><b>Type</b></th>
 571       <th class="td_left"><b>Uncompressed</b></th>
 572       <th class="td_left"><b>Compressed</b></th>
 573     </tr>
 574     <tr>
 575       <td><a href="#char">char</a></td>
 576       <td class="td_left">Constant "l" (0x6C)</td>
 577       <td class="td_left">Constant "l" (0x6C)</td>
 578     </tr>
 579     <tr>
 580       <td><a href="#char">char</a></td>
 581       <td class="td_left">Constant "l" (0x6C)</td>
 582       <td class="td_left">Constant "l" (0x6C)</td>
 583     </tr>
 584     <tr>
 585       <td><a href="#char">char</a></td>
 586       <td class="td_left">Constant "v" (0x76)</td>
 587       <td class="td_left">Constant "v" (0x76)</td>
 588     </tr>
 589     <tr>
 590       <td><a href="#char">char</a></td>
 591       <td class="td_left">Constant "m" (0x6D)</td>
 592       <td class="td_left">Constant "c" (0x63)</td>
 593     </tr>
 594     <tr>
 595       <td><a href="#char">char</a></td>
 596       <td class="td_left">N/A</td>
 597       <td class="td_left">'0'=null,'1'=gzip,'2'=bzip2</td>
 598     </tr>
 599   </tbody>
 600 </table>
 601 <p>In other words, the uncompressed signature is just the characters 'llvm'
 602 while the compressed signature is the characters 'llvc' followed by an ascii
 603 digit ('0', '1', or '2') that indicates the kind of compression used. A value of
 604 '0' indicates that null compression was used. This can happen when compression
 605 was requested on a platform that wasn't configured for gzip or bzip2. A value of
 606 '1' means that the rest of the file is compressed using the gzip algorithm and
 607 should be uncompressed before interpretation. A value of '2' means that the rest
 608 of the file is compressed using the bzip2 algorithm and should be uncompressed
 609 before interpretation. In all cases, the data resulting from uncompression
 610 should be interpreted as if it occurred immediately after the 'llvm'
 611 signature (i.e. the uncompressed data begins with the
 612 <a href="#module">Module Block</a></p>
 613 <p><b>NOTE:</b> As of LLVM 1.4, all bytecode files produced by the LLVM tools
 614 are compressed by default. To disable compression, pass the
 615 <tt>--disable-compression</tt> option to the tool, if it supports it.
 616 </div>
 617 <!-- _______________________________________________________________________ -->
 618 <div class="doc_subsection"><a name="module">Module Block</a> </div>
 619 <div class="doc_text">
 620 <p>The module block contains a small pre-amble and all the other blocks in
 621 the file. The table below shows the structure of the module block. Note that it
 622 only provides the module identifier, size of the module block, and the format
 623 information. Everything else is contained in other blocks, described in other
 624 sections.</p>
 625 <table>
 626   <tbody>
 627     <tr>
 628       <th><b>Type</b></th>
 629       <th class="td_left"><b>Field Description</b></th>
 630     </tr>
 631     <tr>
 632       <td><a href="#unsigned">unsigned</a><br></td>
 633       <td class="td_left"><a href="#mod_header">Module Block Identifier
 634           (0x01)</a></td>
 635     </tr>
 636     <tr>
 637       <td><a href="#unsigned">unsigned</a></td>
 638       <td class="td_left"><a href="#mod_header">Module Block Size</a></td>
 639     </tr>
 640     <tr>
 641       <td><a href="#uint32_vbr">uint32_vbr</a></td>
 642       <td class="td_left"><a href="#format">Format Information</a></td>
 643     </tr>
 644     <tr>
 645       <td><a href="#block">block</a></td>
 646       <td class="td_left"><a href="#globaltypes">Global Type Pool</a></td>
 647     </tr>
 648     <tr>
 649       <td><a href="#block">block</a></td>
 650       <td class="td_left"><a href="#globalinfo">Module Globals Info</a></td>
 651     </tr>
 652     <tr>
 653       <td><a href="#block">block</a></td>
 654       <td class="td_left"><a href="#constantpool">Module Constant Pool</a></td>
 655     </tr>
 656     <tr>
 657       <td><a href="#block">block</a>*</td>
 658       <td class="td_left"><a href="#functiondefs">Function Definitions</a></td>
 659     </tr>
 660     <tr>
 661       <td><a href="#block">block</a></td>
 662       <td class="td_left"><a href="#symtab">Module Symbol Table</a></td>
 663     </tr>
 664   </tbody>
 665 </table>
 666 </div>
 667
 668 <!-- _______________________________________________________________________ -->
 669 <div class="doc_subsubsection"><a name="mod_header">Module Block Header</a></div>
 670 <div class="doc_text">
 671   <p>The block header for the module block uses a longer format than the other
 672   blocks in a bytecode file. Specifically, instead of encoding the type and size
 673   of the block into a 32-bit integer with 5-bits for type and 27-bits for size,
 674   the module block header uses two 32-bit unsigned values, one for type, and one
 675   for size. While the 2<sup>27</sup> byte limit on block size is sufficient
 676   for the blocks contained in the module, it isn't sufficient for the module
 677   block itself because we want to ensure that bytecode files as large as
 678   2<sup>32</sup> bytes are possible. For this reason, the module block (and
 679   only the module block) uses a long format header.</p>
 680 </div>
 681
 682 <!-- _______________________________________________________________________ -->
 683 <div class="doc_subsubsection"><a name="format">Format Information</a></div>
 684 <div class="doc_text">
 685 <p>The format information field is encoded into a <a href="#uint32_vbr">uint32_vbr</a>.</p>
 686
 687 <p>Of particular note, the bytecode format number is simply a 32-bit
 688 monotonically increasing integer that identifies the version of the bytecode
 689 format (which is not directly related to the LLVM release number). The
 690 bytecode versions defined so far are (note that this document only
 691 describes the latest version, 2.0):</p>
 692 <ul>
 693   <li>#0: LLVM 1.0 &amp; 1.1</li>
 694   <li>#1: LLVM 1.2</li>
 695   <li>#2: LLVM 1.2.5 (not released)</li>
 696   <li>#3: LLVM 1.3</li>
 697   <li>#4: LLVM 1.3.x (not released)</li>
 698   <li>#5: LLVM 1.4 through 1.8</li>
 699   <li>#6: LLVM 1.9</li>
 700   <li>#7: LLVM 2.0 and newer</li>
 701 </ul>
 702 </div>
 703 <!-- _______________________________________________________________________ -->
 704 <div class="doc_subsection"><a name="globaltypes">Global Type Pool</a> </div>
 705 <div class="doc_text">
 706 <p>The global type pool consists of type definitions. Their order of appearance
 707 in the file determines their type slot number (0 based). Slot numbers are
 708 used to replace pointers in the intermediate representation. Each slot number
 709 uniquely identifies one entry in a type plane (a collection of values of the
 710 same type).  Since all values have types and are associated with the order in
 711 which the type pool is written, the global type pool <em>must</em> be written
 712 as the first block of a module. If it is not, attempts to read the file will
 713 fail because both forward and backward type resolution will not be possible.</p>
 714 <p>The type pool is simply a list of type definitions, as shown in the
 715 table below.</p>
 716 <table>
 717   <tbody>
 718     <tr>
 719       <th><b>Type</b></th>
 720       <th class="td_left"><b>Field Description</b></th>
 721     </tr>
 722     <tr>
 723       <td><a href="#unsigned">block</a></td>
 724       <td class="td_left">Type Pool Identifier (0x06) + Size<br>
 725       </td>
 726     </tr>
 727     <tr>
 728       <td><a href="#llist">llist</a>(<a href="#type">type</a>)</td>
 729       <td class="td_left">A length list of type definitions.</td>
 730     </tr>
 731   </tbody>
 732 </table>
 733 </div>
 734 <!-- _______________________________________________________________________ -->
 735 <div class="doc_subsubsection"><a name="type">Type Definitions</a></div>
 736 <div class="doc_text">
 737 <p>Types in the type pool are defined using a different format for each kind
 738 of type, as given in the following sections.</p>
 739 <h3>Primitive Types</h3>
 740 <p>The primitive types encompass the basic integer and floating point
 741 types. They are encoded simply as their TypeID.</p>
 742 <table>
 743   <tbody>
 744     <tr>
 745       <th><b>Type</b></th>
 746       <th class="td_left"><b>Description</b></th>
 747     </tr>
 748     <tr>
 749       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 750       <td class="td_left">Type ID for the primitive types (values 1 to 11)
 751         <sup>1</sup></td>
 752     </tr>
 753   </tbody>
 754 </table>
 755 Notes:
 756 <ol>
 757   <li>The values for the Type IDs for the primitive types are provided by the
 758   definition of the <code>llvm::Type::TypeID</code> enumeration in
 759   <code>include/llvm/Type.h</code>. The enumeration gives the following mapping:
 760     <ol>
 761       <li>bool</li>
 762       <li>ubyte</li>
 763       <li>sbyte</li>
 764       <li>ushort</li>
 765       <li>short</li>
 766       <li>uint</li>
 767       <li>int</li>
 768       <li>ulong</li>
 769       <li>long</li>
 770       <li>float</li>
 771       <li>double</li>
 772     </ol>
 773   </li>
 774 </ol>
 775 <h3>Function Types</h3>
 776 <table>
 777   <tbody>
 778     <tr>
 779       <th><b>Type</b></th>
 780       <th class="td_left"><b>Description</b></th>
 781     </tr>
 782     <tr>
 783       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 784       <td class="td_left">Type ID for function types (13)</td>
 785     </tr>
 786     <tr>
 787       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 788       <td class="td_left">Type slot number of function's return type.</td>
 789     </tr>
 790     <tr>
 791       <td><a href="#llist">llist</a>(<a href="#uint24_vbr">uint24_vbr</a>)</td>
 792       <td class="td_left">Type slot number of each argument's type.</td>
 793     </tr>
 794     <tr>
 795       <td><a href="#uint32_vbr">uint32_vbr</a>?</td>
 796       <td class="td_left">Value 0 if this is a varargs function, missing
 797         otherwise.</td>
 798     </tr>
 799   </tbody>
 800 </table>
 801 <h3>Structure Types</h3>
 802 <table>
 803   <tbody>
 804     <tr>
 805       <th><b>Type</b></th>
 806       <th class="td_left"><b>Description</b></th>
 807     </tr>
 808     <tr>
 809       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 810       <td class="td_left">Type ID for structure types (14)</td>
 811     </tr>
 812     <tr>
 813       <td><a href="#zlist">zlist</a>(<a href="#uint24_vbr">uint24_vbr</a>)</td>
 814       <td class="td_left">Slot number of each of the element's fields.</td>
 815     </tr>
 816   </tbody>
 817 </table>
 818 <h3>Array Types</h3>
 819 <table>
 820   <tbody>
 821     <tr>
 822       <th><b>Type</b></th>
 823       <th class="td_left"><b>Description</b></th>
 824     </tr>
 825     <tr>
 826       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 827       <td class="td_left">Type ID for Array Types (15)</td>
 828     </tr>
 829     <tr>
 830       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 831       <td class="td_left">Type slot number of array's element type.</td>
 832     </tr>
 833     <tr>
 834       <td><a href="#uint32_vbr">uint32_vbr</a></td>
 835       <td class="td_left">The number of elements in the array.</td>
 836     </tr>
 837   </tbody>
 838 </table>
 839 <h3>Pointer Types</h3>
 840 <table>
 841   <tbody>
 842     <tr>
 843       <th><b>Type</b></th>
 844       <th class="td_left"><b>Description</b></th>
 845     </tr>
 846     <tr>
 847       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 848       <td class="td_left">Type ID For Pointer Types (16)</td>
 849     </tr>
 850     <tr>
 851       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 852       <td class="td_left">Type slot number of pointer's element type.</td>
 853     </tr>
 854   </tbody>
 855 </table>
 856 <h3>Opaque Types</h3>
 857 <table>
 858   <tbody>
 859     <tr>
 860       <th><b>Type</b></th>
 861       <th class="td_left"><b>Description</b></th>
 862     </tr>
 863     <tr>
 864       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 865       <td class="td_left">Type ID For Opaque Types (17)</td>
 866     </tr>
 867   </tbody>
 868 </table>
 869 <h3>Vector Types</h3>
 870 <table>
 871   <tbody>
 872     <tr>
 873       <th><b>Type</b></th>
 874       <th class="td_left"><b>Description</b></th>
 875     </tr>
 876     <tr>
 877       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 878       <td class="td_left">Type ID for Vector Types (18)</td>
 879     </tr>
 880     <tr>
 881       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 882       <td class="td_left">Slot number of the vector's element type.</td>
 883     </tr>
 884     <tr>
 885       <td><a href="#uint32_vbr">uint32_vbr</a></td>
 886       <td class="td_left">The number of elements in the vector.</td>
 887     </tr>
 888   </tbody>
 889 </table>
 890 <h3>Packed Structure Types</h3>
 891 <table>
 892   <tbody>
 893     <tr>
 894       <th><b>Type</b></th>
 895       <th class="td_left"><b>Description</b></th>
 896     </tr>
 897     <tr>
 898       <td><a href="#uint24_vbr">uint24_vbr</a></td>
 899       <td class="td_left">Type ID for packed structure types (19)</td>
 900     </tr>
 901     <tr>
 902       <td><a href="#zlist">zlist</a>(<a href="#uint24_vbr">uint24_vbr</a>)</td>
 903       <td class="td_left">Slot number of each of the element's fields.</td>
 904     </tr>
 905   </tbody>
 906 </table>
 907 </div>
 908 <!-- _______________________________________________________________________ -->
 909 <div class="doc_subsection"><a name="globalinfo">Module Global Info</a>
 910 </div>
 911 <div class="doc_text">
 912 <p>The module global info block contains the definitions of all global
 913 variables including their initializers and the <em>declaration</em> of
 914 all functions. The format is shown in the table below:</p>
 915 <table>
 916   <tbody>
 917     <tr>
 918       <th><b>Type</b></th>
 919       <th class="td_left"><b>Field Description</b></th>
 920     </tr>
 921     <tr>
 922       <td><a href="#block">block</a></td>
 923       <td class="td_left">Module global info identifier (0x05) + size</td>
 924     </tr>
 925     <tr>
 926       <td><a href="#zlist">zlist</a>(<a href="#globalvar">globalvar</a>)</td>
 927       <td class="td_left">A zero terminated list of global var definitions
 928         occurring in the module.</td>
 929     </tr>
 930     <tr>
 931       <td><a href="#zlist">zlist</a>(<a href="#funcfield">funcfield</a>)</td>
 932       <td class="td_left">A zero terminated list of function definitions
 933         occurring in the module.</td>
 934     </tr>
 935     <tr>
 936       <td><a href="#llist">llist</a>(<a href="#string">string</a>)</td>
 937       <td class="td_left">A length list of strings that specify the names of
 938         the libraries that this module depends upon.</td>
 939     </tr>
 940     <tr>
 941       <td><a href="#string">string</a></td>
 942       <td class="td_left">The target triple for the module (blank means no
 943         target triple specified, i.e. a platform-independent module).</td>
 944     </tr>
 945     <tr>
 946       <td><a href="#string">string</a></td>
 947       <td class="td_left">The data layout string describing the endianness,
 948         pointer size, and type alignments for which the module was written
 949         (blank means no data layout specified, i.e. a platform-independent
 950         module).</td>
 951     </tr>
 952     <tr>
 953       <td><a href="#llist">llist</a>(<a href="#string">string</a>)</td>
 954       <td class="td_left">A length list of strings that defines a table of
 955         section strings for globals.  A global's SectionID is an index into
 956         this table.</td>
 957     </tr>
 958     <tr>
 959       <td><a href="#string">string</a></td>
 960       <td class="td_left">The inline asm block for this module.</td>
 961     </tr>
 962     <tr>
 963       <td><a href="#zlist">zlist</a>(<a href="#alias">alias</a>)</td>
 964       <td class="td_left">A zero terminated list of aliases occurring in the
 965       module.</td>
 966     </tr>
 967   </tbody>
 968 </table>
 969 </div>
 970
 971 <!-- _______________________________________________________________________ -->
 972 <div class="doc_subsubsection"><a name="globalvar">Global Variable Field</a>
 973 </div>
 974
 975 <div class="doc_text">
 976
 977 <p>Global variables are written using an <a href="#uint32_vbr">uint32_vbr</a>
 978 that encodes information about the global variable, an optional extension vbr,
 979 and a an optional initializers for the global var.</p>
 980
 981 <p>The table below provides the bit layout of the first <a
 982  href="#uint32_vbr">uint32_vbr</a> that describes the global variable.</p>
 983
 984 <table>
 985   <tbody>
 986     <tr>
 987       <th><b>Type</b></th>
 988       <th class="td_left"><b>Description</b></th>
 989     </tr>
 990     <tr>
 991       <td><a href="#bit">bit(0)</a></td>
 992       <td class="td_left">Is constant?</td>
 993     </tr>
 994     <tr>
 995       <td><a href="#bit">bit(1)</a></td>
 996       <td class="td_left">Has initializer? Note that this bit determines
 997         whether the constant initializer field (described below) follows.</td>
 998     </tr>
 999     <tr>
1000       <td><a href="#bit">bit(2-4)</a></td>
1001       <td class="td_left">Linkage type: 0=External, 1=Weak,
1002         2=Appending, 3=Internal, 4=LinkOnce, 5=DllImport,
1003         6=DllExport, 7=ExternWeak</td>
1004     </tr>
1005     <tr>
1006       <td><a href="#bit">bit(5)</a></td>
1007       <td class="td_left">Is Thread Local?</td>
1008     </tr>
1009     <tr>
1010       <td><a href="#bit">bit(6-31)</a></td>
1011       <td class="td_left">Type slot number of type for the global variable.</td>
1012     </tr>
1013   </tbody>
1014 </table>
1015
1016 <p>When the Linkage type is set to 3 (internal) and the initializer field is set
1017 to 0 (an invalid combination), an extension word follows the first <a
1018 href="#uint32_vbr">uint32_vbr</a> which encodes the real linkage and init flag,
1019 and can includes more information:</p>
1020
1021 <table>
1022   <tbody>
1023     <tr>
1024       <th><b>Type</b></th>
1025       <th class="td_left"><b>Description</b></th>
1026     </tr>
1027     <tr>
1028       <td><a href="#bit">bit(0)</a></td>
1029       <td class="td_left">Has initializer?  Indicates the real value of the "Has
1030         initializer" field for the global. </td>
1031     </tr>
1032     <tr>
1033       <td><a href="#bit">bit(2-4)</a></td>
1034       <td class="td_left">Linkage type: Indicates the real value of the "linkage
1035         type" field for the global.</td>
1036     </tr>
1037     <tr>
1038       <td><a href="#bit">bit(4-8)</a></td>
1039       <td class="td_left">The log-base-2 of the alignment for the global.</td>
1040     </tr>
1041     <tr>
1042       <td><a href="#bit">bit(9)</a></td>
1043       <td class="td_left">If this bit is set, a SectionID follows this vbr.</td>
1044     </tr>
1045     <tr>
1046       <td><a href="#bit">bit(10-12)</a></td>
1047       <td class="td_left">Visibility style: 0=Default, 1=Hidden, 2=Protected.</td>
1048     </tr>
1049     <tr>
1050       <td><a href="#bit">bit(13-31)</a></td>
1051       <td class="td_left">Currently unassigned.</td>
1052     </tr>
1053   </tbody>
1054 </table>
1055
1056 <p>If the SectionID bit is set above, the following field is included:</p>
1057
1058 <table>
1059   <tbody>
1060     <tr>
1061       <th><b>Type</b></th>
1062       <th class="td_left"><b>Description</b></th>
1063     </tr>
1064     <tr>
1065       <td><a href="#uint32_vbr">uint32_vbr</a>
1066       </td>
1067       <td class="td_left">An optional section ID number, specifying the string
1068         to use for the section of the global.  This an index (+1) of an entry
1069         into the SectionID llist in the
1070         <a href="#globalinfo">Module Global Info</a> block.  If this value is
1071         0 or not present, the global has an empty section string.</td>
1072     </tr>
1073   </tbody>
1074 </table>
1075
1076 <p>If the "Has initializer" field is set, the following field is included:</p>
1077
1078 <table>
1079   <tbody>
1080     <tr>
1081       <th><b>Type</b></th>
1082       <th class="td_left"><b>Description</b></th>
1083     </tr>
1084     <tr>
1085       <td><a href="#uint32_vbr">uint32_vbr</a>
1086       </td>
1087       <td class="td_left">An optional value slot number for the global
1088           variable's constant initializer.</td>
1089     </tr>
1090   </tbody>
1091 </table>
1092 </div>
1093
1094 <!-- _______________________________________________________________________ -->
1095 <div class="doc_subsubsection"><a name="funcfield">Function Field</a>
1096 </div>
1097 <div class="doc_text">
1098 <p>Functions are written using an <a href="#uint32_vbr">uint32_vbr</a>
1099 that encodes information about the function and a set of flags.  If needed,
1100 an extension word may follow this first field.</p>
1101
1102 <p>The table below provides the bit layout of the <a
1103 href="#uint32_vbr">uint32_vbr</a> that describes the function.</p>
1104
1105 <table>
1106   <tbody>
1107     <tr>
1108       <th><b>Type</b></th>
1109       <th class="td_left"><b>Description</b></th>
1110     </tr>
1111     <tr>
1112       <td><a href="#bit">bit(0-3)</a></td>
1113       <td class="td_left">
1114       Encodes the calling convention number of the function. The
1115       CC number of the function is the value of this field minus one.
1116       </td>
1117     </tr>
1118     <tr>
1119       <td><a href="#bit">bit(4)</a></td>
1120       <td class="td_left">If this bit is set to 1, the indicated function is
1121         external, and there is no
1122         <a href="#functiondefs">Function Definiton Block</a> in the bytecode
1123         file for the function. If the function is external and has
1124         <tt>dllimport or extern_weak</tt> linkage additional field in the
1125         extension word is used to indicate the actual linkage type.</td>
1126     </tr>
1127     <tr>
1128       <td><a href="#bit">bit(5-30)</a></td>
1129       <td class="td_left">Type slot number of type for the function.</td>
1130     </tr>
1131     <tr>
1132       <td><a href="#bit">bit(31)</a></td>
1133       <td class="td_left">Indicates whether an extension word follows.</td>
1134     </tr>
1135   </tbody>
1136 </table>
1137
1138 <p>If bit(31) is set, an additional <a href="#uint32_vbr">uint32_vbr</a> word
1139 follows with the following fields:</p>
1140
1141 <table>
1142   <tbody>
1143     <tr>
1144       <th><b>Type</b></th>
1145       <th class="td_left"><b>Description</b></th>
1146     </tr>
1147     <tr>
1148       <td><a href="#bit">bit(0-4)</a></td>
1149       <td class="td_left">The log-base-2 of the alignment for the function.</td>
1150     </tr>
1151     <tr>
1152       <td><a href="#bit">bit(5-9)</a></td>
1153       <td class="td_left">The top nibble of the calling convention.</td>
1154     </tr>
1155     <tr>
1156       <td><a href="#bit">bit(10)</a></td>
1157       <td class="td_left">If this bit is set, a SectionID follows this vbr.</td>
1158     </tr>
1159     <tr>
1160       <td><a href="#bit">bit(11-12)</a></td>
1161       <td class="td_left">Linkage type for external functions. 0 - External
1162         linkage, 1 - DLLImport linkage, 2 - External weak linkage.</td>
1163     </tr>
1164     <tr>
1165       <td><a href="#bit">bit(13-31)</a></td>
1166       <td class="td_left">Currently unassigned.</td>
1167     </tr>
1168   </tbody>
1169 </table>
1170
1171 <p>If the SectionID bit is set above, the following field is included:</p>
1172
1173 <table>
1174   <tbody>
1175     <tr>
1176       <th><b>Type</b></th>
1177       <th class="td_left"><b>Description</b></th>
1178     </tr>
1179     <tr>
1180       <td><a href="#uint32_vbr">uint32_vbr</a>
1181       </td>
1182       <td class="td_left">An optional section ID number, specifying the string
1183         to use for the section of the function.  This an index (+1) of an entry
1184         into the SectionID llist in the
1185         <a href="#globalinfo">Module Global Info</a> block.  If this value is
1186         0 or not present, the function has an empty section string.</td>
1187     </tr>
1188   </tbody>
1189 </table>
1190
1191 </div>
1192
1193 <!-- _______________________________________________________________________ -->
1194 <div class="doc_subsubsection"><a name="alias">Alias Field</a>
1195 </div>
1196 <div class="doc_text">
1197 <p>Aliases are written using 3 <a href="#uint32_vbr">uint32_vbr</a>
1198 that encode information about alias itself and aliasee.</p>
1199
1200 <p>The table below provides the bit layout of
1201 the first <a href="#uint32_vbr">uint32_vbr</a> which describes alias itself.</p>
1202
1203 <table>
1204   <tbody>
1205     <tr>
1206       <th><b>Type</b></th>
1207       <th class="td_left"><b>Description</b></th>
1208     </tr>
1209     <tr>
1210       <td><a href="#bit">bit(0-1)</a></td>
1211       <td class="td_left">Alias linkage. 0 - External linkage, 1 - Internal
1212       linkage, 2 - Weak linkage.</td>
1213     </tr>
1214     <tr>
1215       <td><a href="#bit">bit(2)</a></td>
1216       <td class="td_left">0 - Aliasee is global value. 1 - Aliasee is constant
1217       expression (bitcast of global value)</td>
1218     </tr>
1219     <tr>
1220       <td><a href="#bit">bit(3-31)</a></td>
1221       <td class="td_left">Type slot number of type for the alias itself.</td>
1222     </tr>
1223   </tbody>
1224 </table>
1225
1226   <p>The next <a href="#uint32_vbr">uint32_vbr</a> describes the aliasee. </p>
1227
1228 <table>
1229   <tbody>
1230     <tr>
1231       <th><b>Type</b></th>
1232       <th class="td_left"><b>Description</b></th>
1233     </tr>
1234     <tr>
1235       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1236       <td class="td_left">Slot number of the aliasee.</td>
1237     </tr>
1238   </tbody>
1239 </table>
1240
1241 </div>
1242
1243 <!-- _______________________________________________________________________ -->
1244 <div class="doc_subsection"><a name="constantpool">Constant Pool</a> </div>
1245 <div class="doc_text">
1246 <p>A constant pool defines as set of constant values. There are
1247 actually two types of constant pool blocks: one for modules and one for
1248 functions. For modules, the block begins with the constant strings
1249 encountered anywhere in the module. For functions, the block begins
1250 with types only encountered in the function. In both cases the header
1251 is identical. The tables that follow, show the header, module constant
1252 pool preamble, function constant pool preamble, and the part common to
1253 both function and module constant pools.</p>
1254 <p><b>Common Block Header</b></p>
1255 <table>
1256   <tbody>
1257     <tr>
1258       <th><b>Type</b></th>
1259       <th class="td_left"><b>Field Description</b></th>
1260     </tr>
1261     <tr>
1262       <td><a href="#block">block</a></td>
1263       <td class="td_left">Constant pool identifier (0x03) + size<br>
1264       </td>
1265     </tr>
1266   </tbody>
1267 </table>
1268 <p><b>Module Constant Pool Preamble (constant strings)</b></p>
1269 <table>
1270   <tbody>
1271     <tr>
1272       <th><b>Type</b></th>
1273       <th class="td_left"><b>Field Description</b></th>
1274     </tr>
1275     <tr>
1276       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1277       <td class="td_left">The number of constant strings that follow.</td>
1278     </tr>
1279     <tr>
1280       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1281       <td class="td_left">Zero. This identifies the following "plane" as
1282         containing the constant strings. This is needed to identify it uniquely
1283         from other constant planes that follow. </td>
1284     </tr>
1285     <tr>
1286       <td><a href="#uint24_vbr">uint24_vbr</a>+</td>
1287       <td class="td_left">Type slot number of the constant string's type.  Note
1288         that the constant string's type implicitly defines the length of the
1289         string. </td>
1290     </tr>
1291   </tbody>
1292 </table>
1293 <p><b>Function Constant Pool Preamble (function types)</b></p>
1294 <p>The structure of the types for functions is identical to the <a
1295  href="#globaltypes">Global Type Pool</a>. Please refer to that section
1296 for the details. </p>
1297 <p><b>Common Part (other constants)</b></p>
1298 <table>
1299   <tbody>
1300     <tr>
1301       <th><b>Type</b></th>
1302       <th class="td_left"><b>Field Description</b></th>
1303     </tr>
1304     <tr>
1305       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1306       <td class="td_left">Number of entries in this type plane.</td>
1307     </tr>
1308     <tr>
1309       <td><a href="#uint24_vbr">uint24_vbr</a></td>
1310       <td class="td_left">Type slot number of this plane.</td>
1311     </tr>
1312     <tr>
1313       <td><a href="#constant">constant</a>+</td>
1314       <td class="td_left">The definition of a constant (see below).</td>
1315     </tr>
1316   </tbody>
1317 </table>
1318 </div>
1319
1320 <!-- _______________________________________________________________________ -->
1321 <div class="doc_subsubsection"><a name="constant">Simple Constant Pool
1322 Entries</a></div>
1323
1324 <div class="doc_text">
1325
1326 <p>Constant pool entries come in many shapes and flavors. The sections that
1327 follow define the format for each of them. All constants start with a <a
1328  href="#uint32_vbr">uint32_vbr</a> encoded integer that provides the
1329 number of operands for the constant. For primitive, structure, and
1330 array constants, this will always be zero to indicate that the form of the
1331 constant is solely determined by its type. In this case, we have the following
1332 field definitions, based on type:</p>
1333
1334 <ul>
1335   <li><b>Bool</b>. This is written as an <a href="#uint32_vbr">uint32_vbr</a> of
1336   value 1U or 0U.</li>
1337   <li><b>Signed Integers (sbyte,short,int,long) &le; 64 bits</b>. These are
1338   written as an <a href="#int64_vbr">int64_vbr</a> with the corresponding
1339   value.</li>
1340   <li><b>Unsigned Integers (ubyte,ushort,uint,ulong) &le; 64 bits</b>. These
1341   are written as an <a href="#uint64_vbr">uint64_vbr</a> with the corresponding
1342   value. </li>
1343   <li><b>Integers &gt; 64 bits</b>. These are written as a length followed by a
1344   series of 64-bit words. The length specifies the number of words that follow.
1345   Any zero-valued high order words are elided. Words with the least significant
1346   bits are written to the lowest file offsets (little endian). The length is
1347   written as an <a href="#uint32_vbr">uint32_vbr</a>. Each word of the value
1348   is written as an <a href="#uint64_vbr">uint64_vbr</a>.</li>
1349   <li><b>Floating Point</b>. Both the float and double types are written
1350   literally in binary format.</li>
1351   <li><b>Arrays</b>. Arrays are written simply as a list of
1352   <a href="#uint32_vbr">uint32_vbr</a> encoded value slot numbers to the
1353   constant element values.</li>
1354   <li><b>Structures</b>. Structures are written simply as a list of
1355   <a href="#uint32_vbr">uint32_vbr</a> encoded value slot numbers to the
1356   constant field values of the structure.</li>
1357 </ul>
1358
1359 </div>
1360
1361 <!-- _______________________________________________________________________ -->
1362 <div class="doc_subsubsection">Undef Entries</div>
1363
1364 <div class="doc_text">
1365 <p>When the number of operands to the constant is one, we have an 'undef' value
1366 of the specified type.</p>
1367 </div>
1368
1369 <!-- _______________________________________________________________________ -->
1370 <div class="doc_subsubsection">Inline Assembler Entries</div>
1371
1372 <div class="doc_text">
1373 <p>Inline Assembler entries are stored in the constant pool, though they are not
1374    officially LLVM constants.  These entries are marked with a value of
1375    "4294967295" (all ones) for the number of operands.  They are encoded as
1376    follows:</p>
1377
1378 <table>
1379   <tbody>
1380     <tr>
1381       <th><b>Type</b></th>
1382       <th class="td_left"><b>Field Description</b></th>
1383     </tr>
1384     <tr>
1385       <td><a href="#string">string</a></td>
1386       <td class="td_left">The asm string.</td>
1387     </tr>
1388     <tr>
1389       <td><a href="#string">string</a></td>
1390       <td class="td_left">The constraints string.</td>
1391     </tr>
1392     <tr>
1393       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1394       <td class="td_left">Flags</td>
1395     </tr>
1396   </tbody>
1397 </table>
1398
1399 <p>Currently, the only defined flag, the low bit, indicates whether or not the
1400    inline assembler has side effects.</p>
1401
1402 </div>
1403
1404 <!-- _______________________________________________________________________ -->
1405 <div class="doc_subsubsection">Constant Expression Entries</div>
1406
1407 <div class="doc_text">
1408
1409 <p>Otherwise, we have a constant expression.  The format of the constant
1410 expression is specified in the table below, and the number is equal to the
1411 number of operands+1.</p>
1412 <table>
1413   <tbody>
1414     <tr>
1415       <th><b>Type</b></th>
1416       <th class="td_left"><b>Field Description</b></th>
1417     </tr>
1418     <tr>
1419       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1420       <td class="td_left">Op code of the instruction for the constant
1421         expression.</td>
1422     </tr>
1423     <tr>
1424       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1425       <td class="td_left">The value slot number of the constant value for an
1426         operand.<sup>1</sup></td>
1427     </tr>
1428     <tr>
1429       <td><a href="#uint24_vbr">uint24_vbr</a></td>
1430       <td class="td_left">The type slot number for the type of the constant
1431         value for an operand.<sup>1</sup></td>
1432     </tr>
1433   </tbody>
1434 </table>
1435 Notes:
1436 <ol>
1437   <li>Both these fields are repeatable but only in pairs.</li>
1438 </ol>
1439 </div>
1440 <!-- _______________________________________________________________________ -->
1441 <div class="doc_subsection"><a name="functiondefs">Function Definition</a></div>
1442 <div class="doc_text">
1443 <p>Function definitions contain the linkage, constant pool, instruction list,
1444 and symbol table for a function.  The following table shows the structure of
1445 a function definition.</p>
1446 <table>
1447   <tbody>
1448     <tr>
1449       <th><b>Type</b></th>
1450       <th class="td_left"><b>Field Description</b></th>
1451     </tr>
1452     <tr>
1453       <td><a href="#block">block</a><br>
1454       </td>
1455       <td class="td_left">Function definition block identifier (0x02) +
1456 size<br>
1457       </td>
1458     </tr>
1459     <tr>
1460       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1461       <td class="td_left">
1462         <a href="#funclinkage_and_visibility">The linkage and visibility</a>
1463         style field</td>
1464     </tr>
1465     <tr>
1466       <td><a href="#block">block</a></td>
1467       <td class="td_left">The <a href="#constantpool">constant pool</a> block
1468         for this function.<sup>2</sup></td>
1469     </tr>
1470     <tr>
1471       <td><a href="#block">block</a></td>
1472       <td class="td_left">The <a href="#instructionlist">instruction list</a>
1473         for the function.</td>
1474     </tr>
1475     <tr>
1476       <td><a href="#block">block</a></td>
1477       <td class="td_left">The function's <a href="#symtab">symbol table</a>
1478         containing only those symbols pertinent to the function (mostly block
1479         labels).</td>
1480     </tr>
1481   </tbody>
1482 </table>
1483 Notes:
1484 <ol>
1485   <li>Note that if the linkage type is "External" then none of the
1486 other fields will be present as the function is defined elsewhere.</li>
1487 </ol>
1488
1489 <!-- _______________________________________________________________________ -->
1490 <div class="doc_subsubsection"><a name="funclinkage_and_visibility">Linkage and
1491     visibility word</a>
1492 </div>
1493 <div class="doc_text">
1494
1495 <table>
1496   <tbody>
1497     <tr>
1498       <th><b>Type</b></th>
1499       <th class="td_left"><b>Field Description</b></th>
1500     </tr>
1501     <tr>
1502       <td><a href="#bit">bit(0-15)</a></td>
1503       <td class="td_left">The linkage type of the function: 0=External, 1=Weak,
1504         2=Appending, 3=Internal, 4=LinkOnce, 5=DllImport,
1505         6=DllExport<sup>1</sup></td>
1506     </tr>
1507     <tr>
1508       <td><a href="#bit">bit(16-18)</a></td>
1509       <td class="td_left">Visibility style: 0=Default, 1=Hidden, 2=Protected.</td>
1510     </tr>
1511     <tr>
1512       <td><a href="#bit">bit(19-31)</a></td>
1513       <td class="td_left">Currently unassigned.</td>
1514     </tr>
1515   </tbody>
1516 </table>
1517 </div>
1518
1519 <!-- _______________________________________________________________________ -->
1520 <div class="doc_subsection"><a name="instructionlist">Instruction List</a></div>
1521 <div class="doc_text">
1522 <p>The instructions in a function are written as a simple list. Basic
1523 blocks are inferred by the terminating instruction types. The format of
1524 the block is given in the following table.</p>
1525 <table>
1526   <tbody>
1527     <tr>
1528       <th><b>Type</b></th>
1529       <th class="td_left"><b>Field Description</b></th>
1530     </tr>
1531     <tr>
1532       <td><a href="#block">block</a><br>
1533       </td>
1534       <td class="td_left">Instruction list identifier (0x07) + size<br>
1535       </td>
1536     </tr>
1537     <tr>
1538       <td><a href="#instruction">instruction</a>+</td>
1539       <td class="td_left">An instruction. Instructions have a variety of
1540         formats. See <a href="#instruction">Instructions</a> for details.</td>
1541     </tr>
1542   </tbody>
1543 </table>
1544 </div>
1545
1546 <!-- _______________________________________________________________________ -->
1547 <div class="doc_subsection"><a name="instructions">Instructions</a></div>
1548
1549 <div class="doc_text">
1550 <p>Instructions are written out one at a time as distinct units.  Each
1551 instruction
1552 record contains at least an <a href="#opcodes">opcode</a> and a type field,
1553 and may contain a <a href="#instoperands">list of operands</a> (whose
1554 interpretation depends on the opcode). Based on the number of operands, the
1555 <a href="#instencode">instruction is encoded</a> in a
1556 dense format that tries to encoded each instruction into 32-bits if
1557 possible. </p>
1558 </div>
1559
1560 <!-- _______________________________________________________________________ -->
1561 <div class="doc_subsubsection"><a name="opcodes">Instruction Opcodes</a></div>
1562 <div class="doc_text">
1563   <p>Instructions encode an opcode that identifies the kind of instruction.
1564   Opcodes are an enumerated integer value. The specific values used depend on
1565   the version of LLVM you're using. The opcode values are defined in the
1566   <a href="http://llvm.org/cvsweb/cvsweb.cgi/llvm/include/llvm/Instruction.def">
1567   <tt>include/llvm/Instruction.def</tt></a> file. You should check there for the
1568   most recent definitions. The table below provides the opcodes defined as of
1569   the writing of this document. The table associates each opcode mnemonic with
1570   its enumeration value and the bytecode and LLVM version numbers in which the
1571   opcode was introduced.</p>
1572   <table>
1573     <tbody>
1574       <tr>
1575         <th>Opcode</th>
1576         <th>Number</th>
1577         <th>Bytecode Version</th>
1578         <th>LLVM Version</th>
1579       </tr>
1580       <tr><td colspan="4"><b>Terminator Instructions</b></td></tr>
1581       <tr><td>Ret</td><td>1</td><td>1</td><td>1.0</td></tr>
1582       <tr><td>Br</td><td>2</td><td>1</td><td>1.0</td></tr>
1583       <tr><td>Switch</td><td>3</td><td>1</td><td>1.0</td></tr>
1584       <tr><td>Invoke</td><td>4</td><td>1</td><td>1.0</td></tr>
1585       <tr><td>Unwind</td><td>5</td><td>1</td><td>1.0</td></tr>
1586       <tr><td>Unreachable</td><td>6</td><td>1</td><td>1.4</td></tr>
1587       <tr><td colspan="4"><b>Binary Operators</b></td></tr>
1588       <tr><td>Add</td><td>7</td><td>1</td><td>1.0</td></tr>
1589       <tr><td>Sub</td><td>8</td><td>1</td><td>1.0</td></tr>
1590       <tr><td>Mul</td><td>9</td><td>1</td><td>1.0</td></tr>
1591       <tr><td>UDiv</td><td>10</td><td>6</td><td>1.9</td></tr>
1592       <tr><td>SDiv</td><td>11</td><td>6</td><td>1.9</td></tr>
1593       <tr><td>FDiv</td><td>12</td><td>6</td><td>1.9</td></tr>
1594       <tr><td>URem</td><td>13</td><td>6</td><td>1.9</td></tr>
1595       <tr><td>SRem</td><td>14</td><td>6</td><td>1.9</td></tr>
1596       <tr><td>FRem</td><td>15</td><td>6</td><td>1.9</td></tr>
1597       <tr><td colspan="4"><b>Logical Operators</b></td></tr>
1598       <tr><td>Shl</td><td>16</td><td>1</td><td>1.0</td></tr>
1599       <tr><td>LShr</td><td>17</td><td>6</td><td>1.9</td></tr>
1600       <tr><td>AShr</td><td>18</td><td>6</td><td>1.9</td></tr>
1601       <tr><td>And</td><td>19</td><td>1</td><td>1.0</td></tr>
1602       <tr><td>Or</td><td>20</td><td>1</td><td>1.0</td></tr>
1603       <tr><td>Xor</td><td>21</td><td>1</td><td>1.0</td></tr>
1604       <tr><td colspan="4"><b>Memory Operators</b></td></tr>
1605       <tr><td>Malloc</td><td>22</td><td>1</td><td>1.0</td></tr>
1606       <tr><td>Free</td><td>23</td><td>1</td><td>1.0</td></tr>
1607       <tr><td>Alloca</td><td>24</td><td>1</td><td>1.0</td></tr>
1608       <tr><td>Load</td><td>25</td><td>1</td><td>1.0</td></tr>
1609       <tr><td>Store</td><td>26</td><td>1</td><td>1.0</td></tr>
1610       <tr><td>GetElementPtr</td><td>27</td><td>1</td><td>1.0</td></tr>
1611       <tr><td colspan="4"><b>Cast Operators</b></td></tr>
1612       <tr><td>Trunc</td><td>28</td><td>7</td><td>2.0</td></tr>
1613       <tr><td>ZExt</td><td>29</td><td>7</td><td>2.0</td></tr>
1614       <tr><td>SExt</td><td>30</td><td>7</td><td>2.0</td></tr>
1615       <tr><td>FPToUI</td><td>31</td><td>7</td><td>2.0</td></tr>
1616       <tr><td>FPToSI</td><td>32</td><td>7</td><td>2.0</td></tr>
1617       <tr><td>UIToFP</td><td>33</td><td>7</td><td>2.0</td></tr>
1618       <tr><td>SIToFP</td><td>34</td><td>7</td><td>2.0</td></tr>
1619       <tr><td>FPTrunc</td><td>35</td><td>7</td><td>2.0</td></tr>
1620       <tr><td>FPExt</td><td>36</td><td>7</td><td>2.0</td></tr>
1621       <tr><td>PtrToInt</td><td>37</td><td>7</td><td>2.0</td></tr>
1622       <tr><td>IntToPtr</td><td>38</td><td>7</td><td>2.0</td></tr>
1623       <tr><td>BitCast</td><td>39</td><td>7</td><td>2.0</td></tr>
1624       <tr><td colspan="4"><b>Other Operators</b></td></tr>
1625       <tr><td>ICmp</td><td>40</td><td>7</td><td>2.0</td></tr>
1626       <tr><td>FCmp</td><td>41</td><td>7</td><td>2.0</td></tr>
1627       <tr><td>PHI</td><td>42</td><td>1</td><td>1.0</td></tr>
1628       <tr><td>Call</td><td>43</td><td>1</td><td>1.0</td></tr>
1629       <tr><td>Select</td><td>44</td><td>2</td><td>1.2</td></tr>
1630       <tr><td>UserOp1</td><td>45</td><td>1</td><td>1.0</td></tr>
1631       <tr><td>UserOp2</td><td>46</td><td>1</td><td>1.0</td></tr>
1632       <tr><td>VAArg</td><td>47</td><td>5</td><td>1.5</td></tr>
1633       <tr><td>ExtractElement</td><td>48</td><td>5</td><td>1.5</td></tr>
1634       <tr><td>InsertElement</td><td>49</td><td>5</td><td>1.5</td></tr>
1635       <tr><td>ShuffleElement</td><td>50</td><td>5</td><td>1.5</td></tr>
1636       <tr><td colspan="4">
1637           <b>Pseudo Instructions<a href="#pi_note">*</a></b>
1638       </td></tr>
1639       <tr><td>Invoke+CC </td><td>56</td><td>5</td><td>1.5</td></tr>
1640       <tr><td>Invoke+FastCC</td><td>57</td><td>5</td><td>1.5</td></tr>
1641       <tr><td>Call+CC</td><td>58</td><td>5</td><td>1.5</td></tr>
1642       <tr><td>Call+FastCC+TailCall</td><td>59</td><td>5</td><td>1.5</td></tr>
1643       <tr><td>Call+FastCC</td><td>60</td><td>5</td><td>1.5</td></tr>
1644       <tr><td>Call+CCC+TailCall</td><td>61</td><td>5</td><td>1.5</td></tr>
1645       <tr><td>Load+Attributes</td><td>62</td><td>7</td><td>2.0</td></tr>
1646       <tr><td>Store+Attributes</td><td>63</td><td>7</td><td>2.0</td></tr>
1647     </tbody>
1648   </table>
1649
1650 <p><b><a name="pi_note">* Note: </a></b>
1651 These aren't really opcodes from an LLVM language perspective. They encode
1652 information into other opcodes without reserving space for that information.
1653 For example, opcode=63 is an Attributed Store. The opcode for this
1654 instruction is 25 (Store) but we encode it as 63 to indicate that is a Volatile
1655 Store. The same is done for the calling conventions and tail calls.
1656 In each of these entries in range 56-63, the opcode is documented as the base
1657 opcode (Invoke, Call, Store) plus some set of modifiers, as follows:</p>
1658 <dl>
1659   <dt>CC</dt>
1660   <dd>This means an arbitrary calling convention is specified
1661   in a VBR that follows the opcode. This is used when the instruction cannot
1662   be encoded with one of the more compact forms.
1663   </dd>
1664   <dt>FastCC</dt>
1665   <dd>This indicates that the Call or Invoke is using the FastCC calling
1666   convention.</dd>
1667   <dt>CCC</dt>
1668   <dd>This indicates that the Call or Invoke is using the native "C" calling
1669   convention.</dd>
1670   <dt>TailCall</dt>
1671   <dd>This indicates that the Call has the 'tail' modifier.</dd>
1672 </dl>
1673 </div>
1674
1675 <!-- _______________________________________________________________________ -->
1676 <div class="doc_subsubsection"><a name="instoperands">Instruction
1677 Operands</a></div>
1678
1679 <div class="doc_text">
1680 <p>
1681 Based on the instruction opcode and type, the bytecode format implicitly (to
1682 save space) specifies the interpretation of the operand list.  For most
1683 instructions, the type of each operand is implicit from the type of the
1684 instruction itself (e.g. the type of operands of a binary operator must match
1685 the type of the instruction).  As such, the bytecode format generally only
1686 encodes the value number of the operand, not the type.</p>
1687
1688 <p>In some cases, however, this is not sufficient.  This section enumerates
1689 those cases:</p>
1690
1691 <ul>
1692   <li>getelementptr: the slot numbers for sequential type indexes are shifted
1693   up two bits.  This allows the low order bits will encode the type of index
1694   used, as follows: 0=uint, 1=int, 2=ulong, 3=long.</li>
1695   <li>cast: the result type number is encoded as the second operand.</li>
1696   <li>alloca/malloc: If the allocation has an explicit alignment, the log2 of
1697   the alignment is encoded as the second operand.</li>
1698   <li>call: If the tail marker and calling convention cannot be
1699   <a href="#pi_note">encoded into the opcode</a> of the call, it is passed as
1700   an additional operand.  The low bit of the operand is a flag indicating
1701   whether the call is a tail call.  The rest of the bits contain the calling
1702   convention number (shifted left by one bit).</li>
1703 </ul>
1704 </div>
1705
1706 <!-- _______________________________________________________________________ -->
1707 <div class="doc_subsubsection"><a name="instencode">Instruction
1708 Encoding</a></div>
1709
1710 <div class="doc_text">
1711 <p>For brevity, instructions are written in one of four formats,
1712 depending on the number of operands to the instruction. Each
1713 instruction begins with a <a href="#uint32_vbr">uint32_vbr</a> that
1714 encodes the type of the instruction as well as other things. The tables
1715 that follow describe the format of this first part of each instruction.</p>
1716 <p><b>Instruction Format 0</b></p>
1717 <p>This format is used for a few instructions that can't easily be
1718 shortened because they have large numbers of operands (e.g. PHI Node or
1719 getelementptr). Each of the opcode, type, and operand fields is found in
1720 successive fields.</p>
1721 <table>
1722   <tbody>
1723     <tr>
1724       <th><b>Type</b></th>
1725       <th class="td_left"><b>Field Description</b></th>
1726     </tr>
1727     <tr>
1728       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1729       <td class="td_left">Specifies the opcode of the instruction. Note that
1730         for compatibility with the other instruction formats, the opcode is
1731         shifted left by 2 bits. Bits 0 and 1 must have value zero for this
1732         format.</td>
1733     </tr>
1734     <tr>
1735       <td><a href="#uint24_vbr">uint24_vbr</a></td>
1736       <td class="td_left">Provides the type slot number of the result type of
1737         the instruction.</td>
1738     </tr>
1739     <tr>
1740       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1741       <td class="td_left">The number of operands that follow.</td>
1742     </tr>
1743     <tr>
1744       <td><a href="#uint32_vbr">uint32_vbr</a>+</td>
1745       <td class="td_left">The slot number of the value(s) for the operand(s).
1746       </td>
1747     </tr>
1748   </tbody>
1749 </table>
1750
1751 <p><b>Instruction Format 1</b></p>
1752 <p>This format encodes the opcode, type and a single operand into a
1753 single <a href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1754 <table>
1755   <tbody>
1756     <tr>
1757       <th><b>Bits</b></th>
1758       <th><b>Type</b></th>
1759       <th class="td_left"><b>Field Description</b></th>
1760     </tr>
1761     <tr>
1762       <td>0-1</td>
1763       <td>constant "1"</td>
1764       <td class="td_left">These two bits must be the value 1 which identifies
1765         this as an instruction of format 1.</td>
1766     </tr>
1767     <tr>
1768       <td>2-7</td>
1769       <td><a href="#instructions">opcode</a></td>
1770       <td class="td_left">Specifies the opcode of the instruction. Note that
1771         the maximum opcode value is 63.</td>
1772     </tr>
1773     <tr>
1774       <td>8-19</td>
1775       <td><a href="#unsigned">unsigned</a></td>
1776       <td class="td_left">Specifies the slot number of the type for this
1777         instruction. Maximum slot number is 2<sup>12</sup>-1=4095.</td>
1778     </tr>
1779     <tr>
1780       <td>20-31</td>
1781       <td><a href="#unsigned">unsigned</a></td>
1782       <td class="td_left">Specifies the slot number of the value for the
1783         first operand. Maximum slot number is 2<sup>12</sup>-1=4095. Note that
1784         the value 2<sup>12</sup>-1 denotes zero operands.</td>
1785     </tr>
1786   </tbody>
1787 </table>
1788 <p><b>Instruction Format 2</b></p>
1789 <p>This format encodes the opcode, type and two operands into a single <a
1790  href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1791 <table>
1792   <tbody>
1793     <tr>
1794       <th><b>Bits</b></th>
1795       <th><b>Type</b></th>
1796       <th class="td_left"><b>Field Description</b></th>
1797     </tr>
1798     <tr>
1799       <td>0-1</td>
1800       <td>constant "2"</td>
1801       <td class="td_left">These two bits must be the value 2 which identifies
1802         this as an instruction of format 2.</td>
1803     </tr>
1804     <tr>
1805       <td>2-7</td>
1806       <td><a href="#instructions">opcode</a></td>
1807       <td class="td_left">Specifies the opcode of the instruction. Note that
1808         the maximum opcode value is 63.</td>
1809     </tr>
1810     <tr>
1811       <td>8-15</td>
1812       <td><a href="#unsigned">unsigned</a></td>
1813       <td class="td_left">Specifies the slot number of the type for this
1814         instruction. Maximum slot number is 2<sup>8</sup>-1=255.</td>
1815     </tr>
1816     <tr>
1817       <td>16-23</td>
1818       <td><a href="#unsigned">unsigned</a></td>
1819       <td class="td_left">Specifies the slot number of the value for the first
1820         operand. Maximum slot number is 2<sup>8</sup>-1=255.</td>
1821     </tr>
1822     <tr>
1823       <td>24-31</td>
1824       <td><a href="#unsigned">unsigned</a></td>
1825       <td class="td_left">Specifies the slot number of the value for the second
1826         operand. Maximum slot number is 2<sup>8</sup>-1=255.</td>
1827     </tr>
1828   </tbody>
1829 </table>
1830 <p><b>Instruction Format 3</b></p>
1831 <p>This format encodes the opcode, type and three operands into a
1832 single <a href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1833 <table>
1834   <tbody>
1835     <tr>
1836       <th><b>Bits</b></th>
1837       <th><b>Type</b></th>
1838       <th class="td_left"><b>Field Description</b></th>
1839     </tr>
1840     <tr>
1841       <td>0-1</td>
1842       <td>constant "3"</td>
1843       <td class="td_left">These two bits must be the value 3 which identifies
1844         this as an instruction of format 3.</td>
1845     </tr>
1846     <tr>
1847       <td>2-7</td>
1848       <td><a href="#instructions">opcode</a></td>
1849       <td class="td_left">Specifies the opcode of the instruction. Note that
1850         the maximum opcode value is 63.</td>
1851     </tr>
1852     <tr>
1853       <td>8-13</td>
1854       <td><a href="#unsigned">unsigned</a></td>
1855       <td class="td_left">Specifies the slot number of the type for this
1856         instruction. Maximum slot number is 2<sup>6</sup>-1=63.</td>
1857     </tr>
1858     <tr>
1859       <td>14-19</td>
1860       <td><a href="#unsigned">unsigned</a></td>
1861       <td class="td_left">Specifies the slot number of the value for the first
1862         operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
1863     </tr>
1864     <tr>
1865       <td>20-25</td>
1866       <td><a href="#unsigned">unsigned</a></td>
1867       <td class="td_left">Specifies the slot number of the value for the second
1868         operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
1869     </tr>
1870     <tr>
1871       <td>26-31</td>
1872       <td><a href="#unsigned">unsigned</a></td>
1873       <td class="td_left">Specifies the slot number of the value for the third
1874         operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
1875     </tr>
1876   </tbody>
1877 </table>
1878 </div>
1879
1880 <!-- _______________________________________________________________________ -->
1881 <div class="doc_subsection"><a name="symtab">Symbol Table</a> </div>
1882 <div class="doc_text">
1883 <p>A symbol table can be put out in conjunction with a module or a function. A
1884 symbol table has a list of name/type associations followed by a list of
1885 name/value associations. The name/value associations are organized into "type
1886 planes" so that all values of a common type are listed together.  Each type
1887 plane starts with the number of entries in the plane and the type slot number
1888 for all the values in that plane (so the type can be looked up in the global
1889 type pool). For each entry in a type plane, the slot number of the value and
1890 the name associated with that value are written. The format is given in the
1891 table below. </p>
1892 <table>
1893   <tbody>
1894     <tr>
1895       <th><b>Type</b></th>
1896       <th class="td_left"><b>Field Description</b></th>
1897     </tr>
1898     <tr>
1899       <td><a href="#block">block</a><br>
1900       </td>
1901       <td class="td_left">Symbol Table Identifier (0x04)</td>
1902     </tr>
1903     <tr>
1904       <td><a href="#llist">llist</a>(<a href="#symtab_entry">type_entry</a>)
1905       </td>
1906       <td class="td_left">A length list of symbol table entries for
1907         <tt>Type</tt>s
1908       </td>
1909     </tr>
1910     <tr>
1911       <td><a href="#zlist">llist</a>(<a href="#symtab_plane">symtab_plane</a>)
1912       </td>
1913       <td class="td_left">A length list of "type planes" of symbol table
1914         entries for <tt>Value</tt>s</td>
1915     </tr>
1916   </tbody>
1917 </table>
1918 </div>
1919
1920 <!-- _______________________________________________________________________ -->
1921 <div class="doc_subsubsection"> <a name="type_entry">Symbol Table Type
1922 Entry</a>
1923 </div>
1924 <div class="doc_text">
1925 <p>A symbol table type entry associates a name with a type. The name is provided
1926 simply as an array of chars. The type is provided as a type slot number (index)
1927 into the global type pool. The format is given in the following table:</p>
1928 <table>
1929   <tbody>
1930     <tr>
1931       <th><b>Type</b></th>
1932       <th class="td_left"><b>Field Description</b></th>
1933     </tr>
1934     <tr>
1935       <td><a href="#uint32_vbr">uint24_vbr</a></td>
1936       <td class="td_left">Type slot number of the type being given a
1937         name relative to the global type pool.
1938       </td>
1939     </tr>
1940     <tr>
1941       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1942       <td class="td_left">Length of the character array that follows.</td>
1943     </tr>
1944     <tr>
1945       <td><a href="#char">char</a>+</td>
1946       <td class="td_left">The characters of the name.</td>
1947     </tr>
1948   </tbody>
1949 </table>
1950 </div>
1951 <!-- _______________________________________________________________________ -->
1952 <div class="doc_subsubsection"> <a name="symtab_plane">Symbol Table
1953 Plane</a>
1954 </div>
1955 <div class="doc_text">
1956 <p>A symbol table plane provides the symbol table entries for all
1957 values of a common type. The encoding is given in the following table:</p>
1958 <table>
1959   <tbody>
1960     <tr>
1961       <th><b>Type</b></th>
1962       <th class="td_left"><b>Field Description</b></th>
1963     </tr>
1964     <tr>
1965       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1966       <td class="td_left">Number of entries in this plane.</td>
1967     </tr>
1968     <tr>
1969       <td><a href="#uint32_vbr">uint32_vbr</a></td>
1970       <td class="td_left">Type slot number of type for all values in this plane.
1971       </td>
1972     </tr>
1973     <tr>
1974       <td><a href="#value_entry">value_entry</a>+</td>
1975       <td class="td_left">The symbol table entries for to associate values with
1976         names.</td>
1977     </tr>
1978   </tbody>
1979 </table>
1980 </div>
1981 <!-- _______________________________________________________________________ -->
1982 <div class="doc_subsubsection"><a name="value_entry">Symbol Table Value
1983 Entry</a>
1984 </div>
1985 <div class="doc_text">
1986 <p>A symbol table value entry provides the assocation between a value and the
1987 name given to the value. The value is referenced by its slot number. The
1988 format is given in the following table:</p>
1989 <table>
1990   <tbody>
1991     <tr>
1992       <th><b>Type</b></th>
1993       <th class="td_left"><b>Field Description</b></th>
1994     </tr>
1995     <tr>
1996       <td><a href="#uint32_vbr">uint24_vbr</a></td>
1997       <td class="td_left">Value slot number of the value being given a name.
1998       </td>
1999     </tr>
2000     <tr>
2001       <td><a href="#uint32_vbr">uint32_vbr</a></td>
2002       <td class="td_left">Length of the character array that follows.</td>
2003     </tr>
2004     <tr>
2005       <td><a href="#char">char</a>+</td>
2006       <td class="td_left">The characters of the name.</td>
2007     </tr>
2008   </tbody>
2009 </table>
2010 </div>
2011
2012 <!-- *********************************************************************** -->
2013 <div class="doc_section"> <a name="versiondiffs">Version Differences</a>
2014 </div>
2015 <!-- *********************************************************************** -->
2016 <div class="doc_text">
2017 <p>This section describes the differences in the Bytecode Format across
2018 LLVM
2019 versions. The versions are listed in reverse order because it assumes
2020 the current version is as documented in the previous sections. Each
2021 section here
2022 describes the differences between that version and the one that <i>follows</i>.
2023 </p>
2024 </div>
2025
2026 <!-- _______________________________________________________________________ -->
2027 <div class="doc_subsection"><a name="vers13">Version 1.3 Differences From
2028     1.4</a></div>
2029 <!-- _______________________________________________________________________ -->
2030
2031 <div class="doc_subsubsection">Unreachable Instruction</div>
2032 <div class="doc_text">
2033   <p>The LLVM <a href="LangRef.html#i_unreachable">Unreachable</a> instruction
2034   was added in version 1.4 of LLVM.  This caused all instruction numbers after
2035   it to shift down by one.</p>
2036 </div>
2037
2038 <div class="doc_subsubsection">Function Flags</div>
2039 <div class="doc_text">
2040   <p>LLVM bytecode versions prior to 1.4 did not include the 5 bit offset
2041      in <a href="#funcfield">the function list</a> in the <a
2042      href="#globalinfo">Module Global Info</a> block.</p>
2043 </div>
2044
2045 <div class="doc_subsubsection">Function Flags</div>
2046 <div class="doc_text">
2047   <p>LLVM bytecode versions prior to 1.4 did not include the 'undef' constant
2048   value, which affects the encoding of <a href="#constant">Constant Fields</a>.
2049   </p>
2050 </div>
2051
2052
2053 <!-- _______________________________________________________________________ -->
2054 <div class="doc_subsection"><a name="vers12">Version 1.2 Differences
2055 From 1.3</a></div>
2056 <!-- _______________________________________________________________________ -->
2057
2058 <div class="doc_subsubsection">Type Derives From Value</div>
2059 <div class="doc_text">
2060 <p>In version 1.2, the Type class in the LLVM IR derives from the Value
2061 class. This is not the case in version 1.3. Consequently, in version
2062 1.2 the notion of a "Type Type" was used to write out values that were
2063 Types. The types always occuped plane 12 (corresponding to the
2064 TypeTyID) of any type planed set of values. In 1.3 this representation
2065 is not convenient because the TypeTyID (12) is not present and its
2066 value is now used for LabelTyID. Consequently, the data structures
2067 written that involve types do so by writing all the types first and
2068 then each of the value planes according to those types. In version 1.2,
2069 the types would have been written intermingled with the values.</p>
2070 </div>
2071 <!-- _______________________________________________________________________ -->
2072 <div class="doc_subsubsection">Restricted getelementptr Types</div>
2073 <div class="doc_text">
2074 <p>In version 1.2, the getelementptr instruction required a ubyte type
2075 index for accessing a structure field and a long type index for
2076 accessing an array element. Consequently, it was only possible to
2077 access structures of 255 or fewer elements. Starting in version 1.3,
2078 this restriction was lifted. Structures must now be indexed with uint
2079 constants. Arrays may now be indexed with int, uint, long, or ulong
2080 typed values. The consequence of this was that the bytecode format had
2081 to change in order to accommodate the larger range of structure indices.</p>
2082 </div>
2083 <!-- _______________________________________________________________________ -->
2084 <div class="doc_subsubsection">Short Block Headers</div>
2085 <div class="doc_text">
2086 <p>In version 1.2, block headers were always 8 bytes being comprised of
2087 both an unsigned integer type and an unsigned integer size. For very
2088 small modules, these block headers turn out to be a large fraction of
2089 the total bytecode file size. In an attempt to make these small files
2090 smaller, the type and size information was encoded into a single
2091 unsigned integer (4 bytes) comprised of 5 bits for the block type
2092 (maximum 31 block types) and 27 bits for the block size (max
2093 ~134MBytes). These limits seemed sufficient for any blocks or sizes
2094 forseen in the future. Note that the module block, which encloses all
2095 the other blocks is still written as 8 bytes since bytecode files
2096 larger than 134MBytes might be possible.</p>
2097 </div>
2098 <!-- _______________________________________________________________________ -->
2099 <div class="doc_subsubsection">Dependent Libraries and Target Triples</div>
2100 <div class="doc_text">
2101 <p>In version 1.2, the bytecode format does not store module's target
2102 triple or dependent. These fields have been added to the end of the <a
2103  href="#globalinfo">module global info block</a>. The purpose of these
2104 fields is to allow a front end compiler to specifiy that the generated
2105 module is specific to a particular target triple (operating
2106 system/manufacturer/processor) which makes it non-portable; and to
2107 allow front end compilers to specify the list of libraries that the
2108 module depends on for successful linking.</p>
2109 </div>
2110 <!-- _______________________________________________________________________ -->
2111 <div class="doc_subsubsection">Types Restricted to 24-bits</div>
2112 <div class="doc_text">
2113 <p>In version 1.2, type slot identifiers were written as 32-bit VBR
2114 quantities. In 1.3 this has been reduced to 24-bits in order to ensure
2115 that it is not possible to overflow the type field of a global variable
2116 definition. 24-bits for type slot numbers is deemed sufficient for any
2117 practical use of LLVM.</p>
2118 </div>
2119 <!-- _______________________________________________________________________ -->
2120 <!-- _______________________________________________________________________ -->
2121 <div class="doc_subsection"><a name="vers11">Version 1.1 Differences
2122 From 1.2 </a></div>
2123 <!-- _______________________________________________________________________ -->
2124 <div class="doc_subsubsection">Explicit Primitive Zeros</div>
2125 <div class="doc_text">
2126 <p>In version 1.1, the zero value for primitives was explicitly encoded
2127 into the bytecode format. Since these zero values are constant values
2128 in the LLVM IR and never change, there is no reason to explicitly
2129 encode them. This explicit encoding was removed in version 1.2.</p>
2130 </div>
2131 <!-- _______________________________________________________________________ -->
2132 <div class="doc_subsubsection">Inconsistent Module Global Info</div>
2133 <div class="doc_text">
2134 <p>In version 1.1, the Module Global Info block was not aligned causing
2135 the next block to be read in on an unaligned boundary. This problem was
2136 corrected in version 1.2.<br>
2137 <br>
2138 </p>
2139 </div>
2140 <!-- _______________________________________________________________________ -->
2141 <div class="doc_subsection"><a name="vers10">Version 1.0 Differences
2142 From 1.1</a></div>
2143 <div class="doc_text">
2144 <p>None. Version 1.0 and 1.1 bytecode formats are identical.</p>
2145 </div>
2146 <!-- *********************************************************************** -->
2147 <hr>
2148 <address> <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
2149  src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
2150 <a href="http://validator.w3.org/check/referer"><img
2151  src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
2152 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a> and <a
2153  href="mailto:sabre@nondot.org">Chris Lattner</a><br>
2154 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
2155 Last modified: $Date$
2156 </address>
2157 </body>
2158 </html>