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