Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 812aa2ba19124ae869ce465bac69aab9a4ff547a / . / llvm / docs / BytecodeFormat.html
blob: 9cb8cb744c2c91dbda77f3478d3335da5bd98606 [file] [log] [blame]
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]2<html>
3<head>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]5 <title>LLVM Bytecode File Format</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]7 <style type="text/css">
Reid Spencer435a1ab2004-08-03 20:21:05 +0000[diff] [blame]8 TR, TD { border: 2px solid gray; padding-left: 4pt; padding-right: 4pt;
9 padding-top: 2pt; padding-bottom: 2pt; }
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]10 TH { border: 2px solid gray; font-weight: bold; font-size: 105%; }
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]11 TABLE { text-align: center; border: 2px solid black;
Reid Spencer435a1ab2004-08-03 20:21:05 +0000[diff] [blame]12 border-collapse: collapse; margin-top: 1em; margin-left: 1em;
13 margin-right: 1em; margin-bottom: 1em; }
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]14 .td_left { border: 2px solid gray; text-align: left; }
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]15 </style>
16</head>
17<body>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]18<div class="doc_title"> LLVM Bytecode File Format </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]19<ol>
20 <li><a href="#abstract">Abstract</a></li>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]21 <li><a href="#concepts">Concepts</a>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]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>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]27 <li><a href="#vbr">Variable Bit-Rate Encoding</a></li>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]28 <li><a href="#encoding">Encoding Primitives</a></li>
29 <li><a href="#slots">Slots</a></li>
30 </ol>
31 </li>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]32 <li><a href="#general">General Structure</a> </li>
33 <li><a href="#blockdefs">Block Definitions</a>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]34 <ol>
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]35 <li><a href="#signature">Signature Block</a></li>
36 <li><a href="#module">Module Block</a></li>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]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">Instruction List</a></li>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]43 <li><a href="#opcodes">Instruction Opcodes</a></li>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]44 <li><a href="#symtab">Symbol Table</a></li>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]45 </ol>
46 </li>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]47 <li><a href="#versiondiffs">Version Differences</a>
48 <ol>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]49 <li><a href="#vers13">Version 1.3 Differences From 1.4</a></li>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]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>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]55</ol>
Chris Lattnere7d5ec22004-05-25 17:44:58 +0000[diff] [blame]56<div class="doc_author">
57<p>Written by <a href="mailto:rspencer@x10sys.com">Reid Spencer</a>
58</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]59</div>
60<!-- *********************************************************************** -->
61<div class="doc_section"> <a name="abstract">Abstract </a></div>
62<!-- *********************************************************************** -->
63<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]64<p>This document describes the LLVM bytecode file format. It specifies
65the binary encoding rules of the bytecode file format so that
66equivalent systems can encode bytecode files correctly. The LLVM
67bytecode representation is used to store the intermediate
68representation on disk in compacted form.</p>
69<p>The LLVM bytecode format may change in the future, but LLVM will
70always be backwards compatible with older formats. This document will
71only describe the most current version of the bytecode format. See <a
72 href="#versiondiffs">Version Differences</a> for the details on how
73the current version is different from previous versions.</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]74</div>
75<!-- *********************************************************************** -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]76<div class="doc_section"> <a name="concepts">Concepts</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]77<!-- *********************************************************************** -->
78<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]79<p>This section describes the general concepts of the bytecode file
80format without getting into specific layout details. It is recommended
81that you read this section thoroughly before interpreting the detailed
82descriptions.</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]83</div>
84<!-- _______________________________________________________________________ -->
85<div class="doc_subsection"><a name="blocks">Blocks</a> </div>
86<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]87<p>LLVM bytecode files consist simply of a sequence of blocks of bytes
88using a binary encoding Each block begins with an header of two
89unsigned integers. The first value identifies the type of block and the
90second value provides the size of the block in bytes. The block
91identifier is used because it is possible for entire blocks to be
92omitted from the file if they are empty. The block identifier helps the
93reader determine which kind of block is next in the file. Note that
94blocks can be nested within other blocks.</p>
95<p> All blocks are variable length, and the block header specifies the
96size of the block. All blocks begin on a byte index that is aligned to
97an even 32-bit boundary. That is, the first block is 32-bit aligned
98because it starts at offset 0. Each block is padded with zero fill
99bytes to ensure that the next block also starts on a 32-bit boundary.</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]100</div>
101<!-- _______________________________________________________________________ -->
102<div class="doc_subsection"><a name="lists">Lists</a> </div>
103<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]104<p>LLVM Bytecode blocks often contain lists of things of a similar
105type. For example, a function contains a list of instructions and a
106function type contains a list of argument types. There are two basic
107types of lists: length lists (<a href="#llist">llist</a>), and null
108terminated lists (<a href="#zlist">zlist</a>), as described below in
109the <a href="#encoding">Encoding Primitives</a>.</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]110</div>
111<!-- _______________________________________________________________________ -->
112<div class="doc_subsection"><a name="fields">Fields</a> </div>
113<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]114<p>Fields are units of information that LLVM knows how to write atomically. Most
115fields have a uniform length or some kind of length indication built into their
116encoding. For example, a constant string (array of bytes) is written simply as
117the length followed by the characters. Although this is similar to a list,
118constant strings are treated atomically and are thus fields.</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]119<p>Fields use a condensed bit format specific to the type of information
120they must contain. As few bits as possible are written for each field. The
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]121sections that follow will provide the details on how these fields are
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]122written and how the bits are to be interpreted.</p>
123</div>
124<!-- _______________________________________________________________________ -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]125<div class="doc_subsection"><a name="align">Alignment</a> </div>
Reid Spencer49ad21c2004-05-25 15:47:57 +0000[diff] [blame]126<div class="doc_text">
Reid Spencer40e93a42004-08-03 20:33:56 +0000[diff] [blame]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>
Chris Lattnere7d5ec22004-05-25 17:44:58 +0000[diff] [blame]131</div>
Reid Spencer49ad21c2004-05-25 15:47:57 +0000[diff] [blame]132<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]133<div class="doc_subsection"><a name="vbr">Variable Bit-Rate Encoding</a>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]134</div>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]135<div class="doc_text">
136<p>Most of the values written to LLVM bytecode files are small integers. To
137minimize the number of bytes written for these quantities, an encoding scheme
138similar to UTF-8 is used to write integer data. The scheme is known as
139variable bit rate (vbr) encoding. In this encoding, the high bit of
140each byte is used to indicate if more bytes follow. If (byte &amp;
1410x80) is non-zero in any given byte, it means there is another byte
142immediately following that also contributes to the value. For the final
143byte (byte &amp; 0x80) is false (the high bit is not set). In each byte
144only the low seven bits contribute to the value. Consequently 32-bit
145quantities can take from one to <em>five</em> bytes to encode. In
146general, 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
207the 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
209encoding, but with the sign bit as the low order bit instead of the
210high order bit. This allows small negative quantities to be encoded
211efficiently. For example, -3
212is encoded as "((3 &lt;&lt; 1) | 1)" and 3 is encoded as "(3 &lt;&lt;
2131) | 0)", emitted with the standard vbr encoding above.</p>
214</div>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]215<!-- _______________________________________________________________________ -->
216<div class="doc_subsection"><a name="encoding">Encoding Primitives</a> </div>
217<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]218<p>Each field in the bytecode format is encoded into the file using a
219small set of primitive formats. The table below defines the encoding
220rules for the various primitives used and gives them each a type name.
221The 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
223the suffix <em>_vbr</em> indicates a quantity that is encoded using
224variable 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
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]237 </tr>
238 <tr>
Reid Spencer02d7f922004-08-03 20:57:56 +0000[diff] [blame]239 <td style="vertical-align: top;"><a name="uint24_vbr">
240 <b>uint24_vbr</b></a></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]247 <td class="td_left">A 32-bit unsigned integer that occupies from one to
248 five bytes using variable bit rate encoding.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]249 </tr>
250 <tr>
251 <td><a name="uint64_vbr"><b>uint64_vbr</b></a></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]252 <td class="td_left">A 64-bit unsigned integer that occupies from one to ten
253 bytes using variable bit rate encoding.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]254 </tr>
255 <tr>
256 <td><a name="int64_vbr"><b>int64_vbr</b></a></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]259 </tr>
260 <tr>
261 <td><a name="char"><b>char</b></a></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]262 <td class="td_left">A single unsigned character encoded into one byte</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]263 </tr>
264 <tr>
265 <td><a name="bit"><b>bit(n-m)</b></a></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]270 </tr>
271 <tr>
272 <td style="vertical-align: top;"><b><a name="float"><b>float</b></a></b></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]275 </td>
276 </tr>
277 <tr>
278 <td style="vertical-align: top;"><b><b><a name="double"><b>double</b></a></b></b></td>
Reid Spencera54f1102004-08-03 19:20:18 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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
285constant string which also includes its length, immediately followed by
286the characters of the string. There is no terminating null byte in the
287string.</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
292no 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
298encoded as an <a href="#uint32_vbr">uint32_vbr</a> providing the
299length of the list, followed by a sequence of that many "x" items. This
300implies that the reader should iterate the number of times provided by
301the 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
306list is encoded as a sequence of an indeterminate number of "x" items,
307followed by an <a href="#uint32_vbr">uint32_vbr</a> terminating value.
308This implies that none of the "x" items can have a zero value (or else
309the 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
314block is an unsigned 32-bit integer that encodes the type of the block
315in the low 5 bits and the size of the block in the high 27 bits. The
316length does not include the block header or any alignment bytes at the
317end of the block. Blocks may compose other blocks. </td>
318 </tr>
319 </tbody>
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]320</table>
321</div>
322<!-- _______________________________________________________________________ -->
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]323<div class="doc_subsection"><a name="notation">Field Notation</a> </div>
324<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]325<p>In the detailed block and field descriptions that follow, a regex
326like notation is used to describe optional and repeated fields. A very
327limited subset of regex is used to describe these, as given in the
328following table: </p>
329<table class="doc_table">
330 <tbody>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]331 <tr>
332 <th><b>Character</b></th>
333 <th class="td_left"><b>Meaning</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]334 </tr>
335 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]336 <td><b><code>?</code></b></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]337 <td class="td_left">The question mark indicates 0 or 1
338occurrences of the thing preceding it.</td>
339 </tr>
340 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]341 <td><b><code>*</code></b></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]342 <td class="td_left">The asterisk indicates 0 or more occurrences
343of the thing preceding it.</td>
344 </tr>
345 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]346 <td><b><code>+</code></b></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]347 <td class="td_left">The plus sign indicates 1 or more occurrences
348of the thing preceding it.</td>
349 </tr>
350 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]351 <td><b><code>()</code></b></td>
352 <td class="td_left">Parentheses are used for grouping.</td>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]353 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]368</div>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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
374uint32_vbr or just a uint32_vbr.</li>
375 <li>An optional length list of unsigned values.</li>
376</ol>
377</div>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]378<!-- _______________________________________________________________________ -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]379<div class="doc_subsection"><a name="slots">Slots</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]380<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]381<p>The bytecode format uses the notion of a "slot" to reference Types
382and Values. Since the bytecode file is a <em>direct</em> representation of
383LLVM's intermediate representation, there is a need to represent pointers in
384the file. Slots are used for this purpose. For example, if one has the following
385assembly:
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]386</p>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]387<div class="doc_code"><code> %MyType = type { int, sbyte }<br>
388%MyVar = external global %MyType
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]389</code></div>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]390<p>there are two definitions. The definition of <tt>%MyVar</tt> uses <tt>%MyType</tt>.
391In the C++ IR this linkage between <tt>%MyVar</tt> and <tt>%MyType</tt>
392is explicit through the use of C++ pointers. In bytecode, however, there's no
393ability to store memory addresses. Instead, we compute and write out
394slot numbers for every Type and Value written to the file.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]395<p>A slot number is simply an unsigned 32-bit integer encoded in the variable
396bit rate scheme (see <a href="#encoding">encoding</a>). This ensures that
397low slot numbers are encoded in one byte. Through various bits of magic LLVM
398attempts to always keep the slot numbers low. The first attempt is to associate
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]399slot numbers with their "type plane". That is, Values of the same type
400are written to the bytecode file in a list (sequentially). Their order in
401that list determines their slot number. This means that slot #1 doesn't mean
402anything unless you also specify for which type you want slot #1. Types are
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]403always written to the file first (in the <a href="#globaltypes">Global Type
404Pool</a>) and in such a way that both forward and backward references of the
405types can often be resolved with a single pass through the type pool. </p>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]406<p>Slot numbers are also kept small by rearranging their order. Because
407of the structure of LLVM, certain values are much more likely to be used
408frequently in the body of a function. For this reason, a compaction table is
409provided in the body of a function if its use would make the function body
410smaller. 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
412slot 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>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]414<p>In summary then, a slot number can be though of as just a vbr encoded index
415into a list of Type* or Value*. To keep slot numbers low, Value* are indexed by
416two slot numbers: the "type plane index" (type slot) and the "value index"
417(value slot).</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]418</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]419<!-- *********************************************************************** -->
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]420<div class="doc_section"> <a name="general">General Structure</a> </div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]421<!-- *********************************************************************** -->
422<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]423<p>This section provides the general structure of the LLVM bytecode
424file format. The bytecode file format requires blocks to be in a
425certain order and nested in a particular way so that an LLVM module can
426be constructed efficiently from the contents of the file. This ordering
427defines a general structure for bytecode files as shown below. The
428table below shows the order in which all block types may appear. Please
429note that some of the blocks are optional and some may be repeated. The
430structure is fairly loose because optional blocks, if empty, are
431completely omitted from the file.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]432<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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
451number) 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
461file. 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)
471level 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
481linkage for each of the global variables in the module. It also
482contains 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
492except 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
502function in the module. The function block contains the instructions,
503compaction 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
514within 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
525a funtion-local mapping of type and value slot numbers to their global
526slot 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
537the function. The basic blocks are inferred by terminating
538instructions. </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
549function 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
559various entries in the file that are not function specific (global
560vars, and functions mostly).</td>
561 </tr>
562 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]563</table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]564<p>Use the links in the table for details about the contents of each of
565the block types.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]566</div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]567<!-- *********************************************************************** -->
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]568<div class="doc_section"> <a name="blockdefs">Block Definitions</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]569<!-- *********************************************************************** -->
570<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]571<p>This section provides the detailed layout of the individual block
572types in the LLVM bytecode file format. </p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]573</div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]574<!-- _______________________________________________________________________ -->
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]575<div class="doc_subsection"><a name="signature">Signature Block</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]576<div class="doc_text">
Chris Lattnera0390ec2004-05-24 05:35:17 +0000[diff] [blame]577<p>The signature occurs in every LLVM bytecode file and is always first.
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]578It simply provides a few bytes of data to identify the file as being an LLVM
579bytecode file. This block is always four bytes in length and differs from the
580other blocks because there is no identifier and no block length at the start
581of the block. Essentially, this block is just the "magic number" for the file.
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]582</p>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]583<p>There are two types of signatures for LLVM bytecode: uncompressed and
584compressed as shown in the table below. </p>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]585<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]586 <tbody>
587 <tr>
588 <th><b>Type</b></th>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]589 <th class="td_left"><b>Uncompressed</b></th>
590 <th class="td_left"><b>Compressed</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]591 </tr>
592 <tr>
593 <td><a href="#char">char</a></td>
594 <td class="td_left">Constant "l" (0x6C)</td>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]595 <td class="td_left">Constant "l" (0x6C)</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]596 </tr>
597 <tr>
598 <td><a href="#char">char</a></td>
599 <td class="td_left">Constant "l" (0x6C)</td>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]600 <td class="td_left">Constant "l" (0x6C)</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]601 </tr>
602 <tr>
603 <td><a href="#char">char</a></td>
604 <td class="td_left">Constant "v" (0x76)</td>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]605 <td class="td_left">Constant "v" (0x76)</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]606 </tr>
607 <tr>
608 <td><a href="#char">char</a></td>
609 <td class="td_left">Constant "m" (0x6D)</td>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]616 </tr>
617 </tbody>
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]618</table>
Reid Spencer812aa2ba2004-11-08 08:55:21 +0000[diff] [blame^]619<p>In other words, the uncompressed signature is just the characters 'llvm'
620while the compressed signature is the characters 'llvc' followed by an ascii
621digit ('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
623was 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
625should be uncompressed before interpretation. A value of '2' means that the rest
626of the file is compressed using the bzip2 algorithm and should be uncompressed
627before interpretation. In all cases, the data resulting from uncompression
628should be interpreted as if it occurred immediately after the 'llvm'
629signature (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
632are compressed byte default. To disable compression, pass the
633<tt>--disable-compression</tt> option to the tool, if it supports it.
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]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
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]639the file. The table below shows the structure of the module block. Note that it
640only provides the module identifier, size of the module block, and the format
641information. Everything else is contained in other blocks, described in other
642sections.</p>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]643<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]644 <tbody>
645 <tr>
646 <th><b>Type</b></th>
647 <th class="td_left"><b>Field Description</b></th>
648 </tr>
649 <tr>
Reid Spencerf57b8b92004-08-16 19:24:36 +0000[diff] [blame]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>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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>
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]680 <td class="td_left"><a href="#symtab">Module Symbol Table</a></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]681 </tr>
682 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]683</table>
684</div>
Reid Spencerf57b8b92004-08-16 19:24:36 +0000[diff] [blame]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
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]700<!-- _______________________________________________________________________ -->
701<div class="doc_subsubsection"><a name="format">Format Information</a></div>
702<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]703<p>The format information field is encoded into a <a href="#uint32_vbr">uint32_vbr</a>
704as shown in the following table.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]705<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]732</table>
733<p>
734Of particular note, the bytecode format number is simply a 28-bit
735monotonically increase integer that identifies the version of the bytecode
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]736format (which is not directly related to the LLVM release number). The
737bytecode versions defined so far are (note that this document only
738describes the latest version, 1.3):</p>
Chris Lattnera0390ec2004-05-24 05:35:17 +0000[diff] [blame]739<ul>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]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<br>
744 </li>
Chris Lattnera0390ec2004-05-24 05:35:17 +0000[diff] [blame]745</ul>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]746<p>Note that we plan to eventually expand the target description
747capabilities
748of bytecode files to <a href="http://llvm.cs.uiuc.edu/PR263">target
749triples</a>.
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]750</p>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]751</div>
752<!-- _______________________________________________________________________ -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]753<div class="doc_subsection"><a name="globaltypes">Global Type Pool</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]754<div class="doc_text">
Chris Lattnera0390ec2004-05-24 05:35:17 +0000[diff] [blame]755<p>The global type pool consists of type definitions. Their order of appearance
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]756in the file determines their type slot number (0 based). Slot numbers are
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]757used to replace pointers in the intermediate representation. Each slot number
758uniquely identifies one entry in a type plane (a collection of values of the
759same type). Since all values have types and are associated with the order in
760which the type pool is written, the global type pool <em>must</em> be written
761as the first block of a module. If it is not, attempts to read the file will
762fail because both forward and backward type resolution will not be possible.</p>
763<p>The type pool is simply a list of type definitions, as shown in the
764table below.</p>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]765<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]766 <tbody>
767 <tr>
768 <th><b>Type</b></th>
769 <th class="td_left"><b>Field Description</b></th>
770 </tr>
771 <tr>
772 <td><a href="#unsigned">block</a></td>
773 <td class="td_left">Type Pool Identifier (0x06) + Size<br>
774 </td>
775 </tr>
776 <tr>
777 <td><a href="#llist">llist</a>(<a href="#type">type</a>)</td>
778 <td class="td_left">A length list of type definitions.</td>
779 </tr>
780 </tbody>
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]781</table>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]782</div>
783<!-- _______________________________________________________________________ -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]784<div class="doc_subsubsection"><a name="type">Type Definitions</a></div>
785<div class="doc_text">
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]786<p>Types in the type pool are defined using a different format for each kind
787of type, as given in the following sections.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]788<h3>Primitive Types</h3>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]789<p>The primitive types encompass the basic integer and floating point
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]790types. They are encoded simply as their TypeID.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]791<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]792 <tbody>
793 <tr>
794 <th><b>Type</b></th>
795 <th class="td_left"><b>Description</b></th>
796 </tr>
797 <tr>
798 <td><a href="#uint24_vbr">uint24_vbr</a></td>
799 <td class="td_left">Type ID for the primitive types (values 1 to
80011) <sup>1</sup></td>
801 </tr>
802 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]803</table>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]804Notes:
805<ol>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]806 <li>The values for the Type IDs for the primitive types are provided
807by the definition of the <code>llvm::Type::TypeID</code> enumeration
808in <code>include/llvm/Type.h</code>. The enumeration gives the
809following mapping:
810 <ol>
811 <li>bool</li>
812 <li>ubyte</li>
813 <li>sbyte</li>
814 <li>ushort</li>
815 <li>short</li>
816 <li>uint</li>
817 <li>int</li>
818 <li>ulong</li>
819 <li>long</li>
820 <li>float</li>
821 <li>double</li>
822 </ol>
823 </li>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]824</ol>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]825<h3>Function Types</h3>
826<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]827 <tbody>
828 <tr>
829 <th><b>Type</b></th>
830 <th class="td_left"><b>Description</b></th>
831 </tr>
832 <tr>
833 <td><a href="#uint24_vbr">uint24_vbr</a></td>
834 <td class="td_left">Type ID for function types (13)</td>
835 </tr>
836 <tr>
837 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]838 <td class="td_left">Type slot number of function's return type.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]839 </tr>
840 <tr>
841 <td><a href="#llist">llist</a>(<a href="#uint24_vbr">uint24_vbr</a>)</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]842 <td class="td_left">Type slot number of each argument's type.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]843 </tr>
844 <tr>
845 <td><a href="#uint32_vbr">uint32_vbr</a>?</td>
846 <td class="td_left">Value 0 if this is a varargs function,
847missing otherwise.</td>
848 </tr>
849 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]850</table>
851<h3>Structure Types</h3>
852<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]853 <tbody>
854 <tr>
855 <th><b>Type</b></th>
856 <th class="td_left"><b>Description</b></th>
857 </tr>
858 <tr>
859 <td><a href="#uint24_vbr">uint24_vbr</a></td>
860 <td class="td_left">Type ID for structure types (14)</td>
861 </tr>
862 <tr>
863 <td><a href="#zlist">zlist</a>(<a href="#uint24_vbr">uint24_vbr</a>)</td>
864 <td class="td_left">Slot number of each of the element's fields.</td>
865 </tr>
866 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]867</table>
868<h3>Array Types</h3>
869<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]870 <tbody>
871 <tr>
872 <th><b>Type</b></th>
873 <th class="td_left"><b>Description</b></th>
874 </tr>
875 <tr>
876 <td><a href="#uint24_vbr">uint24_vbr</a></td>
877 <td class="td_left">Type ID for Array Types (15)</td>
878 </tr>
879 <tr>
880 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]881 <td class="td_left">Type slot number of array's element type.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]882 </tr>
883 <tr>
884 <td><a href="#uint32_vbr">uint32_vbr</a></td>
885 <td class="td_left">The number of elements in the array.</td>
886 </tr>
887 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]888</table>
889<h3>Pointer Types</h3>
890<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]891 <tbody>
892 <tr>
893 <th><b>Type</b></th>
894 <th class="td_left"><b>Description</b></th>
895 </tr>
896 <tr>
897 <td><a href="#uint24_vbr">uint24_vbr</a></td>
898 <td class="td_left">Type ID For Pointer Types (16)</td>
899 </tr>
900 <tr>
901 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]902 <td class="td_left">Type slot number of pointer's element type.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]903 </tr>
904 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]905</table>
906<h3>Opaque Types</h3>
907<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]908 <tbody>
909 <tr>
910 <th><b>Type</b></th>
911 <th class="td_left"><b>Description</b></th>
912 </tr>
913 <tr>
914 <td><a href="#uint24_vbr">uint24_vbr</a></td>
915 <td class="td_left">Type ID For Opaque Types (17)</td>
916 </tr>
917 </tbody>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]918</table>
Brian Gaeke02209042004-08-20 06:00:58 +0000[diff] [blame]919<h3>Packed Types</h3>
920<table>
921 <tbody>
922 <tr>
923 <th><b>Type</b></th>
924 <th class="td_left"><b>Description</b></th>
925 </tr>
926 <tr>
927 <td><a href="#uint24_vbr">uint24_vbr</a></td>
928 <td class="td_left">Type ID for Packed Types (18)</td>
929 </tr>
930 <tr>
931 <td><a href="#uint24_vbr">uint24_vbr</a></td>
932 <td class="td_left">Slot number of packed vector's element type.</td>
933 </tr>
934 <tr>
935 <td><a href="#uint32_vbr">uint32_vbr</a></td>
936 <td class="td_left">The number of elements in the packed vector.</td>
937 </tr>
938 </tbody>
939</table>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]940</div>
941<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]942<div class="doc_subsection"><a name="globalinfo">Module Global Info</a>
943</div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]944<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]945<p>The module global info block contains the definitions of all global
946variables including their initializers and the <em>declaration</em> of
947all functions. The format is shown in the table below:</p>
948<table>
949 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]950 <tr>
951 <th><b>Type</b></th>
952 <th class="td_left"><b>Field Description</b></th>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]953 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]954 <tr>
955 <td><a href="#block">block</a></td>
956 <td class="td_left">Module global info identifier (0x05) + size<br>
957 </td>
958 </tr>
959 <tr>
960 <td><a href="#zlist">zlist</a>(<a href="#globalvar">globalvar</a>)</td>
961 <td class="td_left">A zero terminated list of global var
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]962definitions occurring in the module.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]963 </tr>
964 <tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]965 <td><a href="#zlist">zlist</a>(<a href="#funcfield">funcfield</a>)</td>
966 <td class="td_left">A zero terminated list of function definitions
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]967occurring in the module.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]968 </tr>
969 <tr>
970 <td style="vertical-align: top;"><a href="#llist">llist</a>(<a
971 href="#string">string</a>)<br>
972 </td>
973 <td style="vertical-align: top; text-align: left;">A length list
974of strings that specify the names of the libraries that this module
975depends upon.<br>
976 </td>
977 </tr>
978 <tr>
979 <td style="vertical-align: top;"><a href="#string">string</a><br>
980 </td>
981 <td style="vertical-align: top; text-align: left;">The target
982triple for the module (blank means no target triple specified, i.e. a
983platform independent module).<br>
984 </td>
985 </tr>
986 </tbody>
987</table>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]988</div>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]989
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]990<!-- _______________________________________________________________________ -->
991<div class="doc_subsubsection"><a name="globalvar">Global Variable Field</a>
992</div>
993<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]994<p>Global variables are written using an <a href="#uint32_vbr">uint32_vbr</a>
995that encodes information about the global variable and a list of the
996constant initializers for the global var, if any.</p>
997<p>The table below provides the bit layout of the first <a
998 href="#uint32_vbr">uint32_vbr</a> that describes the global variable.</p>
999<table>
1000 <tbody>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]1001 <tr>
1002 <th><b>Type</b></th>
1003 <th class="td_left"><b>Description</b></th>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]1004 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1005 <tr>
1006 <td><a href="#bit">bit(0)</a></td>
1007 <td class="td_left">Is constant?</td>
1008 </tr>
1009 <tr>
1010 <td><a href="#bit">bit(1)</a></td>
1011 <td class="td_left">Has initializer? Note that this bit
1012determines whether the constant initializer field (described below)
1013follows. </td>
1014 </tr>
1015 <tr>
1016 <td><a href="#bit">bit(2-4)</a></td>
1017 <td class="td_left">Linkage type: 0=External, 1=Weak,
10182=Appending, 3=Internal, 4=LinkOnce</td>
1019 </tr>
1020 <tr>
1021 <td><a href="#bit">bit(5-31)</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1022 <td class="td_left">Type slot number of type for the global variable.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1023 </tr>
1024 </tbody>
1025</table>
1026<p>The table below provides the format of the constant initializers for
1027the global variable field, if it has one.</p>
1028<table>
1029 <tbody>
1030 <tr>
1031 <th><b>Type</b></th>
1032 <th class="td_left"><b>Description</b></th>
1033 </tr>
1034 <tr>
1035 <td>(<a href="#zlist">zlist</a>(<a href="#uint32_vbr">uint32_vbr</a>))?
1036 </td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1037 <td class="td_left">An optional zero-terminated list of value slot
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1038numbers of the global variable's constant initializer.</td>
1039 </tr>
1040 </tbody>
1041</table>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1042</div>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1043
1044<!-- _______________________________________________________________________ -->
1045<div class="doc_subsubsection"><a name="funcfield">Function Field</a>
1046</div>
1047<div class="doc_text">
1048<p>Functions are written using an <a href="#uint32_vbr">uint32_vbr</a>
1049that encodes information about the function and a set of flags.</p>
1050
1051<p>The table below provides the bit layout of the <a
1052href="#uint32_vbr">uint32_vbr</a> that describes the function.</p>
1053
1054<table>
1055 <tbody>
1056 <tr>
1057 <th><b>Type</b></th>
1058 <th class="td_left"><b>Description</b></th>
1059 </tr>
1060 <tr>
1061 <td><a href="#bit">bit(0-4)</a></td>
1062 <td class="td_left">Reserved for future use. Currently set to 00001.</td>
1063 </tr>
1064 <tr>
1065 <td><a href="#bit">bit(5-)</a></td>
1066 <td class="td_left">Type slot number of type for the function.</td>
1067 </tr>
1068 </tbody>
1069</table>
1070
1071</div>
1072
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1073<!-- _______________________________________________________________________ -->
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1074<div class="doc_subsection"><a name="constantpool">Constant Pool</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1075<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1076<p>A constant pool defines as set of constant values. There are
1077actually two types of constant pool blocks: one for modules and one for
1078functions. For modules, the block begins with the constant strings
1079encountered anywhere in the module. For functions, the block begins
1080with types only encountered in the function. In both cases the header
1081is identical. The tables that follow, show the header, module constant
1082pool preamble, function constant pool preamble, and the part common to
1083both function and module constant pools.</p>
1084<p><b>Common Block Header</b></p>
1085<table>
1086 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1087 <tr>
1088 <th><b>Type</b></th>
1089 <th class="td_left"><b>Field Description</b></th>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1090 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1091 <tr>
1092 <td><a href="#block">block</a></td>
1093 <td class="td_left">Constant pool identifier (0x03) + size<br>
1094 </td>
1095 </tr>
1096 </tbody>
1097</table>
1098<p><b>Module Constant Pool Preamble (constant strings)</b></p>
1099<table>
1100 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1101 <tr>
1102 <th><b>Type</b></th>
1103 <th class="td_left"><b>Field Description</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1104 </tr>
1105 <tr>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1106 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1107 <td class="td_left">The number of constant strings that follow.</td>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1108 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1109 <tr>
1110 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1111 <td class="td_left">Zero. This identifies the following "plane"
1112as containing the constant strings. This is needed to identify it
1113uniquely from other constant planes that follow. </td>
1114 </tr>
1115 <tr>
1116 <td><a href="#uint24_vbr">uint24_vbr</a>+</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1117 <td class="td_left">Type slot number of the constant string's type.
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1118Note that the constant string's type implicitly defines the length of
1119the string. </td>
1120 </tr>
1121 </tbody>
1122</table>
1123<p><b>Function Constant Pool Preamble (function types)</b></p>
1124<p>The structure of the types for functions is identical to the <a
1125 href="#globaltypes">Global Type Pool</a>. Please refer to that section
1126for the details. </p>
1127<p><b>Common Part (other constants)</b></p>
1128<table>
1129 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1130 <tr>
1131 <th><b>Type</b></th>
1132 <th class="td_left"><b>Field Description</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1133 </tr>
1134 <tr>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1135 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1136 <td class="td_left">Number of entries in this type plane.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1137 </tr>
1138 <tr>
1139 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1140 <td class="td_left">Type slot number of this plane.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1141 </tr>
1142 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]1143 <td><a href="#constant">constant</a>+</td>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1144 <td class="td_left">The definition of a constant (see below).</td>
1145 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1146 </tbody>
1147</table>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1148</div>
1149<!-- _______________________________________________________________________ -->
1150<div class="doc_subsubsection"><a name="constant">Constant Field</a></div>
1151<div class="doc_text">
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1152<p>Constants come in many shapes and flavors. The sections that follow
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1153define the format for each of them. All constants start with a <a
1154 href="#uint32_vbr">uint32_vbr</a> encoded integer that provides the
1155number of operands for the constant. For primitive, structure, and
1156array constants, this will always be zero since those types of
1157constants have no operands. In this case, we have the following field
1158definitions:</p>
1159<ul>
1160 <li><b>Bool</b>. This is written as an <a href="#uint32_vbr">uint32_vbr</a>
1161of value 1U or 0U.</li>
1162 <li><b>Signed Integers (sbyte,short,int,long)</b>. These are written
1163as an <a href="#int64_vbr">int64_vbr</a> with the corresponding value.</li>
1164 <li><b>Unsigned Integers (ubyte,ushort,uint,ulong)</b>. These are
1165written as an <a href="#uint64_vbr">uint64_vbr</a> with the
1166corresponding value. </li>
1167 <li><b>Floating Point</b>. Both the float and double types are
1168written literally in binary format.</li>
1169 <li><b>Arrays</b>. Arrays are written simply as a list of <a
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1170 href="#uint32_vbr">uint32_vbr</a> encoded value slot numbers to the constant
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1171element values.</li>
1172 <li><b>Structures</b>. Structures are written simply as a list of <a
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1173 href="#uint32_vbr">uint32_vbr</a> encoded value slot numbers to the constant
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1174field values of the structure.</li>
1175</ul>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1176
1177<p>When the number of operands to the constant is one, we have an 'undef' value
1178of the specified type.</p>
1179
1180<p>When the number of operands to the constant is greater than one, we have a
1181constant expression and its field format is provided in the table below, and the
1182number is equal to the number of operands+1.</p>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1183<table>
1184 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1185 <tr>
1186 <th><b>Type</b></th>
1187 <th class="td_left"><b>Field Description</b></th>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1188 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1189 <tr>
1190 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1191 <td class="td_left">Op code of the instruction for the constant
1192expression.</td>
1193 </tr>
1194 <tr>
1195 <td><a href="#uint32_vbr">uint32_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1196 <td class="td_left">The value slot number of the constant value for an
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1197operand.<sup>1</sup></td>
1198 </tr>
1199 <tr>
1200 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1201 <td class="td_left">The type slot number for the type of the constant
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1202value for an operand.<sup>1</sup></td>
1203 </tr>
1204 </tbody>
1205</table>
1206Notes:
1207<ol>
1208 <li>Both these fields are repeatable but only in pairs.</li>
1209</ol>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1210</div>
1211<!-- _______________________________________________________________________ -->
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1212<div class="doc_subsection"><a name="functiondefs">Function Definition</a></div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1213<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1214<p>Function definitions contain the linkage, constant pool or
1215compaction table, instruction list, and symbol table for a function.
1216The following table shows the structure of a function definition.</p>
1217<table>
1218 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1219 <tr>
1220 <th><b>Type</b></th>
1221 <th class="td_left"><b>Field Description</b></th>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1222 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1223 <tr>
1224 <td><a href="#block">block</a><br>
1225 </td>
1226 <td class="td_left">Function definition block identifier (0x02) +
1227size<br>
1228 </td>
1229 </tr>
1230 <tr>
1231 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1232 <td class="td_left">The linkage type of the function: 0=External,
12331=Weak, 2=Appending, 3=Internal, 4=LinkOnce<sup>1</sup></td>
1234 </tr>
1235 <tr>
1236 <td><a href="#block">block</a></td>
1237 <td class="td_left">The <a href="#constantpool">constant pool</a>
1238block for this function.<sup>2</sup></td>
1239 </tr>
1240 <tr>
1241 <td><a href="#block">block</a></td>
1242 <td class="td_left">The <a href="#compactiontable">compaction
1243table</a> block for the function.<sup>2</sup></td>
1244 </tr>
1245 <tr>
1246 <td><a href="#block">block</a></td>
1247 <td class="td_left">The <a href="#instructionlist">instruction
1248list</a> for the function.</td>
1249 </tr>
1250 <tr>
1251 <td><a href="#block">block</a></td>
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1252 <td class="td_left">The function's <a href="#symtab">symbol
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1253table</a> containing only those symbols pertinent to the function
1254(mostly block labels).</td>
1255 </tr>
1256 </tbody>
1257</table>
1258Notes:
1259<ol>
1260 <li>Note that if the linkage type is "External" then none of the
1261other fields will be present as the function is defined elsewhere.</li>
1262 <li>Note that only one of the constant pool or compaction table will
1263be written. Compaction tables are only written if they will actually
1264save bytecode space. If not, then a regular constant pool is written.</li>
1265</ol>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1266</div>
1267<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1268<div class="doc_subsection"><a name="compactiontable">Compaction Table</a>
1269</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1270<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1271<p>Compaction tables are part of a function definition. They are merely
1272a device for reducing the size of bytecode files. The size of a
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1273bytecode file is dependent on the <em>values</em> of the slot numbers
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1274used because larger values use more bytes in the variable bit rate
1275encoding scheme. Furthermore, the compressed instruction format
1276reserves only six bits for the type of the instruction. In large
1277modules, declaring hundreds or thousands of types, the values of the
1278slot numbers can be quite large. However, functions may use only a
1279small fraction of the global types. In such cases a compaction table is
1280created that maps the global type and value slot numbers to smaller
1281values used by a function. Functions will contain either a
1282function-specific constant pool <em>or</em> a compaction table but not
1283both. Compaction tables have the format shown in the table below.</p>
1284<table>
1285 <tbody>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1286 <tr>
1287 <th><b>Type</b></th>
1288 <th class="td_left"><b>Field Description</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1289 </tr>
1290 <tr>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1291 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1292 <td class="td_left">The number of types that follow</td>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1293 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1294 <tr>
1295 <td><a href="#uint24_vbr">uint24_vbr</a>+</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1296 <td class="td_left">The type slot number in the global types of
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1297the type that will be referenced in the function with the index of this
1298entry in the compaction table.</td>
1299 </tr>
1300 <tr>
1301 <td><a href="#type_len">type_len</a></td>
1302 <td class="td_left">An encoding of the type and number of values
1303that follow. This field's encoding varies depending on the size of the
1304type plane. See <a href="#type_len">Type and Length</a> for further
1305details.</td>
1306 </tr>
1307 <tr>
1308 <td><a href="#uint32_vbr">uint32_vbr</a>+</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1309 <td class="td_left">The value slot number in the global values
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1310that will be referenced in the function with the index of this entry in
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1311the compaction table.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1312 </tr>
1313 </tbody>
1314</table>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1315</div>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1316<!-- _______________________________________________________________________ -->
1317<div class="doc_subsubsection"><a name="type_len">Type and Length</a></div>
1318<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1319<p>The type and length of a compaction table type plane is encoded
1320differently depending on the length of the plane. For planes of length
13211 or 2, the length is encoded into bits 0 and 1 of a <a
1322 href="#uint32_vbr">uint32_vbr</a> and the type is encoded into bits
13232-31. Because type numbers are often small, this often saves an extra
1324byte per plane. If the length of the plane is greater than 2 then the
1325encoding uses a <a href="#uint32_vbr">uint32_vbr</a> for each of the
1326length and type, in that order.</p>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1327</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1328<!-- _______________________________________________________________________ -->
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1329<div class="doc_subsection"><a name="instructionlist">Instruction List</a></div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1330<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1331<p>The instructions in a function are written as a simple list. Basic
1332blocks are inferred by the terminating instruction types. The format of
1333the block is given in the following table.</p>
1334<table>
1335 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1336 <tr>
1337 <th><b>Type</b></th>
1338 <th class="td_left"><b>Field Description</b></th>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1339 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1340 <tr>
1341 <td><a href="#block">block</a><br>
1342 </td>
1343 <td class="td_left">Instruction list identifier (0x07) + size<br>
1344 </td>
1345 </tr>
1346 <tr>
1347 <td><a href="#instruction">instruction</a>+</td>
1348 <td class="td_left">An instruction. Instructions have a variety
1349of formats. See <a href="#instruction">Instructions</a> for details.</td>
1350 </tr>
1351 </tbody>
1352</table>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1353</div>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1354<!-- _______________________________________________________________________ -->
1355<div class="doc_subsubsection"><a name="instruction">Instructions</a></div>
1356<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1357<p>For brevity, instructions are written in one of four formats,
1358depending on the number of operands to the instruction. Each
1359instruction begins with a <a href="#uint32_vbr">uint32_vbr</a> that
1360encodes the type of the instruction as well as other things. The tables
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1361that follow describe the format of this first part of each instruction.</p>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1362<p><b>Instruction Format 0</b></p>
1363<p>This format is used for a few instructions that can't easily be
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1364shortened because they have large numbers of operands (e.g. PHI Node or
1365getelementptr). Each of the opcode, type, and operand fields is found in
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1366successive fields.</p>
1367<table>
1368 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1369 <tr>
1370 <th><b>Type</b></th>
1371 <th class="td_left"><b>Field Description</b></th>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1372 </tr>
1373 <tr>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1374 <td><a href="#uint32_vbr">uint32_vbr</a></td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1375 <td class="td_left">Specifies the opcode of the instruction. Note
1376that for compatibility with the other instruction formats, the opcode
1377is shifted left by 2 bits. Bits 0 and 1 must have value zero for this
1378format.</td>
1379 </tr>
1380 <tr>
1381 <td><a href="#uint24_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1382 <td class="td_left">Provides the type slot number of the result type of
1383 the instruction.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1384 </tr>
1385 <tr>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1386 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1387 <td class="td_left">The number of operands that follow.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1388 </tr>
1389 <tr>
Reid Spencer8e32af02004-07-07 13:34:26 +0000[diff] [blame]1390 <td><a href="#uint32_vbr">uint32_vbr</a>+</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1391 <td class="td_left">The slot number of the value(s) for the operand(s).
1392 <sup>1</sup></td>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1393 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1394 </tbody>
1395</table>
1396Notes:
1397<ol>
1398 <li>Note that if the instruction is a getelementptr and the type of
1399the operand is a sequential type (array or pointer) then the slot
1400number is shifted up two bits and the low order bits will encode the
1401type of index used, as follows: 0=uint, 1=int, 2=ulong, 3=long.</li>
1402</ol>
1403<p><b>Instruction Format 1</b></p>
1404<p>This format encodes the opcode, type and a single operand into a
1405single <a href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1406<table>
1407 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1408 <tr>
1409 <th><b>Bits</b></th>
1410 <th><b>Type</b></th>
1411 <th class="td_left"><b>Field Description</b></th>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1412 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1413 <tr>
1414 <td>0-1</td>
1415 <td>constant "1"</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1416 <td class="td_left">These two bits must be the value 1 which identifies
1417 this as an instruction of format 1.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1418 </tr>
1419 <tr>
1420 <td>2-7</td>
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1421 <td><a href="#opcode">opcode</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1422 <td class="td_left">Specifies the opcode of the instruction. Note that
1423 the maximum opcode value is 63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1424 </tr>
1425 <tr>
1426 <td>8-19</td>
1427 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1428 <td class="td_left">Specifies the slot number of the type for this
1429 instruction. Maximum slot number is 2<sup>12</sup>-1=4095.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1430 </tr>
1431 <tr>
1432 <td>20-31</td>
1433 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1434 <td class="td_left">Specifies the slot number of the value for the
1435 first operand. Maximum slot number is 2<sup>12</sup>-1=4095. Note that
1436 the value 2<sup>12</sup>-1 denotes zero operands.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1437 </tr>
1438 </tbody>
1439</table>
1440<p><b>Instruction Format 2</b></p>
1441<p>This format encodes the opcode, type and two operands into a single <a
1442 href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1443<table>
1444 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1445 <tr>
1446 <th><b>Bits</b></th>
1447 <th><b>Type</b></th>
1448 <th class="td_left"><b>Field Description</b></th>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1449 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1450 <tr>
1451 <td>0-1</td>
1452 <td>constant "2"</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1453 <td class="td_left">These two bits must be the value 2 which identifies
1454 this as an instruction of format 2.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1455 </tr>
1456 <tr>
1457 <td>2-7</td>
1458 <td><a href="#opcodes">opcode</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1459 <td class="td_left">Specifies the opcode of the instruction. Note that
1460 the maximum opcode value is 63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1461 </tr>
1462 <tr>
1463 <td>8-15</td>
1464 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1465 <td class="td_left">Specifies the slot number of the type for this
1466 instruction. Maximum slot number is 2<sup>8</sup>-1=255.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1467 </tr>
1468 <tr>
1469 <td>16-23</td>
1470 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1471 <td class="td_left">Specifies the slot number of the value for the first
1472 operand. Maximum slot number is 2<sup>8</sup>-1=255.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1473 </tr>
1474 <tr>
1475 <td>24-31</td>
1476 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1477 <td class="td_left">Specifies the slot number of the value for the second
1478 operand. Maximum slot number is 2<sup>8</sup>-1=255.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1479 </tr>
1480 </tbody>
1481</table>
1482<p><b>Instruction Format 3</b></p>
1483<p>This format encodes the opcode, type and three operands into a
1484single <a href="#uint32_vbr">uint32_vbr</a> as follows:</p>
1485<table>
1486 <tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1487 <tr>
1488 <th><b>Bits</b></th>
1489 <th><b>Type</b></th>
1490 <th class="td_left"><b>Field Description</b></th>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1491 </tr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1492 <tr>
1493 <td>0-1</td>
1494 <td>constant "3"</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1495 <td class="td_left">These two bits must be the value 3 which identifies
1496 this as an instruction of format 3.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1497 </tr>
1498 <tr>
1499 <td>2-7</td>
1500 <td><a href="#opcodes">opcode</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1501 <td class="td_left">Specifies the opcode of the instruction. Note that
1502 the maximum opcode value is 63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1503 </tr>
1504 <tr>
1505 <td>8-13</td>
1506 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1507 <td class="td_left">Specifies the slot number of the type for this
1508 instruction. Maximum slot number is 2<sup>6</sup>-1=63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1509 </tr>
1510 <tr>
1511 <td>14-19</td>
1512 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1513 <td class="td_left">Specifies the slot number of the value for the first
1514 operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1515 </tr>
1516 <tr>
1517 <td>20-25</td>
1518 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1519 <td class="td_left">Specifies the slot number of the value for the second
1520 operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1521 </tr>
1522 <tr>
1523 <td>26-31</td>
1524 <td><a href="#unsigned">unsigned</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1525 <td class="td_left">Specifies the slot number of the value for the third
1526 operand. Maximum slot number is 2<sup>6</sup>-1=63.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1527 </tr>
1528 </tbody>
1529</table>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1530</div>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1531
1532<!-- _______________________________________________________________________ -->
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1533<div class="doc_subsection"><a name="opcodes">Instruction Opcodes</a></div>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1534<div class="doc_text">
1535 <p>Instructions encode an opcode that identifies the kind of instruction.
1536 Opcodes are an enumerated integer value. The specific values used depend on
1537 the version of LLVM you're using. The opcode values are defined in the
Misha Brukmanaeee58f2004-11-07 00:59:58 +0000[diff] [blame]1538 <a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/include/llvm/Instruction.def">
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1539 <tt>include/llvm/Instruction.def</tt></a> file. You should check there for the
1540 most recent definitions. The table below provides the opcodes defined as of
Nate Begeman0c1e6802004-08-27 07:59:37 +0000[diff] [blame]1541 the writing of this document. The table associates each opcode mnemonic with
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1542 its enumeration value and the bytecode and LLVM version numbers in which the
1543 opcode was introduced.</p>
1544 <table>
1545 <tbody>
1546 <tr>
1547 <th>Opcode</th>
1548 <th>Number</th>
1549 <th>Bytecode Version</th>
1550 <th>LLVM Version</th>
1551 </tr>
1552 <tr><td colspan="4"><b>Terminator Instructions</b></td></tr>
1553 <tr><td>Ret</td><td>1</td><td>1</td><td>1.0</td></tr>
1554 <tr><td>Br</td><td>2</td><td>1</td><td>1.0</td></tr>
1555 <tr><td>Switch</td><td>3</td><td>1</td><td>1.0</td></tr>
1556 <tr><td>Invoke</td><td>4</td><td>1</td><td>1.0</td></tr>
1557 <tr><td>Unwind</td><td>5</td><td>1</td><td>1.0</td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1558 <tr><td>Unreachable</td><td>6</td><td>1</td><td>1.4</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1559 <tr><td colspan="4"><b>Binary Operators</b></td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1560 <tr><td>Add</td><td>7</td><td>1</td><td>1.0</td></tr>
1561 <tr><td>Sub</td><td>8</td><td>1</td><td>1.0</td></tr>
1562 <tr><td>Mul</td><td>9</td><td>1</td><td>1.0</td></tr>
1563 <tr><td>Div</td><td>10</td><td>1</td><td>1.0</td></tr>
1564 <tr><td>Rem</td><td>11</td><td>1</td><td>1.0</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1565 <tr><td colspan="4"><b>Logical Operators</b></td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1566 <tr><td>And</td><td>12</td><td>1</td><td>1.0</td></tr>
1567 <tr><td>Or</td><td>13</td><td>1</td><td>1.0</td></tr>
1568 <tr><td>Xor</td><td>14</td><td>1</td><td>1.0</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1569 <tr><td colspan="4"><b>Binary Comparison Operators</b></td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1570 <tr><td>SetEQ</td><td>15</td><td>1</td><td>1.0</td></tr>
1571 <tr><td>SetNE</td><td>16</td><td>1</td><td>1.0</td></tr>
1572 <tr><td>SetLE</td><td>17</td><td>1</td><td>1.0</td></tr>
1573 <tr><td>SetGE</td><td>18</td><td>1</td><td>1.0</td></tr>
1574 <tr><td>SetLT</td><td>19</td><td>1</td><td>1.0</td></tr>
1575 <tr><td>SetGT</td><td>20</td><td>1</td><td>1.0</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1576 <tr><td colspan="4"><b>Memory Operators</b></td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1577 <tr><td>Malloc</td><td>21</td><td>1</td><td>1.0</td></tr>
1578 <tr><td>Free</td><td>22</td><td>1</td><td>1.0</td></tr>
1579 <tr><td>Alloca</td><td>23</td><td>1</td><td>1.0</td></tr>
1580 <tr><td>Load</td><td>24</td><td>1</td><td>1.0</td></tr>
1581 <tr><td>Store</td><td>25</td><td>1</td><td>1.0</td></tr>
1582 <tr><td>GetElementPtr</td><td>26</td><td>1</td><td>1.0</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1583 <tr><td colspan="4"><b>Other Operators</b></td></tr>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1584 <tr><td>PHI</td><td>27</td><td>1</td><td>1.0</td></tr>
1585 <tr><td>Cast</td><td>28</td><td>1</td><td>1.0</td></tr>
1586 <tr><td>Call</td><td>29</td><td>1</td><td>1.0</td></tr>
1587 <tr><td>Shl</td><td>30</td><td>1</td><td>1.0</td></tr>
1588 <tr><td>Shr</td><td>31</td><td>1</td><td>1.0</td></tr>
1589 <tr><td>VANext</td><td>32</td><td>1</td><td>1.0</td></tr>
1590 <tr><td>VAArg</td><td>33</td><td>1</td><td>1.0</td></tr>
1591 <tr><td>Select</td><td>34</td><td>2</td><td>1.2</td></tr>
1592 <tr><td>UserOp1</td><td>35</td><td>1</td><td>1.0</td></tr>
1593 <tr><td>UserOp2</td><td>36</td><td>1</td><td>1.0</td></tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1594 </tbody>
1595 </table>
1596</div>
1597
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1598<!-- _______________________________________________________________________ -->
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]1599<div class="doc_subsection"><a name="symtab">Symbol Table</a> </div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1600<div class="doc_text">
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1601<p>A symbol table can be put out in conjunction with a module or a function. A
1602symbol table has a list of name/type associations followed by a list of
1603name/value associations. The name/value associations are organized into "type
1604planes" so that all values of a common type are listed together. Each type
1605plane starts with the number of entries in the plane and the type slot number
1606for all the values in that plane (so the type can be looked up in the global
1607type pool). For each entry in a type plane, the slot number of the value and
1608the name associated with that value are written. The format is given in the
1609table below. </p>
Reid Spencer9ce11e42004-07-05 19:04:27 +0000[diff] [blame]1610<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1611 <tbody>
1612 <tr>
1613 <th><b>Type</b></th>
1614 <th class="td_left"><b>Field Description</b></th>
1615 </tr>
1616 <tr>
1617 <td><a href="#block">block</a><br>
1618 </td>
1619 <td class="td_left">Symbol Table Identifier (0x04)</td>
1620 </tr>
1621 <tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1622 <td><a href="#llist">llist</a>(<a href="#symtab_entry">type_entry</a>)</td>
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1623 <td class="td_left">A length list of symbol table entries for
1624 <tt>Type</tt>s
1625 </td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1626 </tr>
1627 <tr>
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1628 <td><a href="#zlist">llist</a>(<a href="#symtab_plane">symtab_plane</a>)</td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1629 <td class="td_left">A length list of "type planes" of symbol table
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1630 entries for <tt>Value</tt>s</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1631 </tr>
1632 </tbody>
Reid Spencereca340b2004-05-23 17:05:09 +0000[diff] [blame]1633</table>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1634</div>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1635
1636<!-- _______________________________________________________________________ -->
1637<div class="doc_subsubsection"> <a name="type_entry">Symbol Table Type
1638Entry</a>
1639</div>
1640<div class="doc_text">
1641<p>A symbol table type entry associates a name with a type. The name is provided
1642simply as an array of chars. The type is provided as a type slot number (index)
1643into the global type pool. The format is given in the following table:</p>
1644<table>
1645 <tbody>
1646 <tr>
1647 <th><b>Type</b></th>
1648 <th class="td_left"><b>Field Description</b></th>
1649 </tr>
1650 <tr>
1651 <td><a href="#uint32_vbr">uint24_vbr</a></td>
1652 <td class="td_left">Type slot number of the type being given a
1653 name relative to the global type pool.
1654 </td>
1655 </tr>
1656 <tr>
1657 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1658 <td class="td_left">Length of the character array that follows.</td>
1659 </tr>
1660 <tr>
1661 <td><a href="#char">char</a>+</td>
1662 <td class="td_left">The characters of the name.</td>
1663 </tr>
1664 </tbody>
1665</table>
1666</div>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1667<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1668<div class="doc_subsubsection"> <a name="symtab_plane">Symbol Table
1669Plane</a>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1670</div>
1671<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1672<p>A symbol table plane provides the symbol table entries for all
1673values of a common type. The encoding is given in the following table:</p>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1674<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1675 <tbody>
1676 <tr>
1677 <th><b>Type</b></th>
1678 <th class="td_left"><b>Field Description</b></th>
1679 </tr>
1680 <tr>
1681 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1682 <td class="td_left">Number of entries in this plane.</td>
1683 </tr>
1684 <tr>
1685 <td><a href="#uint32_vbr">uint32_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1686 <td class="td_left">Type slot number of type for all values in this plane..</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1687 </tr>
1688 <tr>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1689 <td><a href="#value_entry">value_entry</a>+</td>
1690 <td class="td_left">The symbol table entries for to associate values with
1691 names.</td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1692 </tr>
1693 </tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1694</table>
1695</div>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1696<!-- _______________________________________________________________________ -->
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1697<div class="doc_subsubsection"><a name="value_entry">Symbol Table Value
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1698Entry</a>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1699</div>
1700<div class="doc_text">
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1701<p>A symbol table value entry provides the assocation between a value and the
1702name given to the value. The value is referenced by its slot number. The
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1703format is given in the following table:</p>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1704<table>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1705 <tbody>
1706 <tr>
1707 <th><b>Type</b></th>
1708 <th class="td_left"><b>Field Description</b></th>
1709 </tr>
1710 <tr>
1711 <td><a href="#uint32_vbr">uint24_vbr</a></td>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1712 <td class="td_left">Value slot number of the value being given a name.
Reid Spencer9a910812004-08-17 00:49:03 +0000[diff] [blame]1713 </td>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1714 </tr>
1715 <tr>
1716 <td><a href="#uint32_vbr">uint32_vbr</a></td>
1717 <td class="td_left">Length of the character array that follows.</td>
1718 </tr>
1719 <tr>
1720 <td><a href="#char">char</a>+</td>
1721 <td class="td_left">The characters of the name.</td>
1722 </tr>
1723 </tbody>
Reid Spencere2f97b32004-07-05 22:28:02 +0000[diff] [blame]1724</table>
1725</div>
Reid Spencer375d7842004-08-18 20:06:19 +0000[diff] [blame]1726
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1727<!-- *********************************************************************** -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1728<div class="doc_section"> <a name="versiondiffs">Version Differences</a>
1729</div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1730<!-- *********************************************************************** -->
1731<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1732<p>This section describes the differences in the Bytecode Format across
1733LLVM
1734versions. The versions are listed in reverse order because it assumes
1735the current version is as documented in the previous sections. Each
1736section here
Chris Lattnere5589ea2004-07-05 18:05:48 +0000[diff] [blame]1737describes the differences between that version and the one that <i>follows</i>.
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1738</p>
1739</div>
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1740
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1741<!-- _______________________________________________________________________ -->
Reid Spencer3cff8a042004-08-18 20:17:05 +0000[diff] [blame]1742<div class="doc_subsection"><a name="vers13">Version 1.3 Differences From
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1743 1.4</a></div>
Reid Spencer0b85d032004-08-17 07:43:43 +0000[diff] [blame]1744<!-- _______________________________________________________________________ -->
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1745
1746<div class="doc_subsubsection">Unreachable Instruction</div>
1747<div class="doc_text">
1748 <p>The LLVM <a href="LangRef.html#i_unreachable">Unreachable</a> instruction
1749 was added in version 1.4 of LLVM. This caused all instruction numbers after
1750 it to shift down by one.</p>
1751</div>
1752
1753<div class="doc_subsubsection">Function Flags</div>
1754<div class="doc_text">
1755 <p>LLVM bytecode versions prior to 1.4 did not include the 5 bit offset
1756 in <a href="#funcfield">the function list</a> in the <a
1757 href="#globalinfo">Module Global Info</a> block.</p>
1758</div>
1759
1760<div class="doc_subsubsection">Function Flags</div>
1761<div class="doc_text">
1762 <p>LLVM bytecode versions prior to 1.4 did not include the 'undef' constant
1763 value, which affects the encoding of <a href="#constant">Constant
1764 Fields</a>.</p>
1765</div>
1766
Chris Lattnerdb6a9fd2004-10-16 00:29:30 +0000[diff] [blame]1767<!--
Reid Spencer0b85d032004-08-17 07:43:43 +0000[diff] [blame]1768<div class="doc_subsubsection">Aligned Data</div>
1769<div class="doc_text">
1770 <p>In version 1.3, certain data items were aligned to 32-bit boundaries. In
1771 version 1.4, alignment of data was done away with completely. The need for
1772 alignment has gone away and the only thing it adds is bytecode file size
1773 overhead. In most cases this overhead was small. However, in functions with
1774 large numbers of format 0 instructions (GEPs and PHIs with lots of parameters)
1775 or regular instructions with large valued operands (e.g. because there's just
1776 a lot of instructions in the function) the overhead can be extreme. In one
1777 test case, the overhead was 44,000 bytes (34% of the total file size).
1778 Consequently in release 1.4, the decision was made to eliminate alignment
1779 altogether.</p>
1780 <p>In version 1.3 format, the following bytecode constructs were aligned (i.e.
1781 they were followed by one to three bytes of padding):</p>
1782 <ul>
1783 <li>All blocks.</li>
1784 <li>Instructions using the long format (format 0).</li>
1785 <li>All call instructions that called a var args function.</li>
1786 <li>The target triple (a string field at the end of the module block).</li>
1787 <li>The version field (immediately following the signature).</li>
1788 </ul>
1789 <p>None of these constructs are aligned in version 1.4</p>
1790</div>
Chris Lattnerdb6a9fd2004-10-16 00:29:30 +0000[diff] [blame]1791-->
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1792
Reid Spencer0b85d032004-08-17 07:43:43 +0000[diff] [blame]1793<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1794<div class="doc_subsection"><a name="vers12">Version 1.2 Differences
1795From 1.3</a></div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1796<!-- _______________________________________________________________________ -->
Chris Lattnercd196a92004-10-16 18:03:55 +0000[diff] [blame]1797
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1798<div class="doc_subsubsection">Type Derives From Value</div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1799<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1800<p>In version 1.2, the Type class in the LLVM IR derives from the Value
1801class. This is not the case in version 1.3. Consequently, in version
18021.2 the notion of a "Type Type" was used to write out values that were
1803Types. The types always occuped plane 12 (corresponding to the
1804TypeTyID) of any type planed set of values. In 1.3 this representation
1805is not convenient because the TypeTyID (12) is not present and its
1806value is now used for LabelTyID. Consequently, the data structures
1807written that involve types do so by writing all the types first and
1808then each of the value planes according to those types. In version 1.2,
1809the types would have been written intermingled with the values.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1810</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1811<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1812<div class="doc_subsubsection">Restricted getelementptr Types</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1813<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1814<p>In version 1.2, the getelementptr instruction required a ubyte type
1815index for accessing a structure field and a long type index for
1816accessing an array element. Consequently, it was only possible to
1817access structures of 255 or fewer elements. Starting in version 1.3,
1818this restriction was lifted. Structures must now be indexed with uint
1819constants. Arrays may now be indexed with int, uint, long, or ulong
1820typed values. The consequence of this was that the bytecode format had
1821to change in order to accommodate the larger range of structure indices.</p>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1822</div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1823<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1824<div class="doc_subsubsection">Short Block Headers</div>
1825<div class="doc_text">
1826<p>In version 1.2, block headers were always 8 bytes being comprised of
1827both an unsigned integer type and an unsigned integer size. For very
1828small modules, these block headers turn out to be a large fraction of
1829the total bytecode file size. In an attempt to make these small files
1830smaller, the type and size information was encoded into a single
1831unsigned integer (4 bytes) comprised of 5 bits for the block type
1832(maximum 31 block types) and 27 bits for the block size (max
1833~134MBytes). These limits seemed sufficient for any blocks or sizes
1834forseen in the future. Note that the module block, which encloses all
1835the other blocks is still written as 8 bytes since bytecode files
1836larger than 134MBytes might be possible.</p>
1837</div>
1838<!-- _______________________________________________________________________ -->
1839<div class="doc_subsubsection">Dependent Libraries and Target Triples</div>
1840<div class="doc_text">
1841<p>In version 1.2, the bytecode format does not store module's target
1842triple or dependent. These fields have been added to the end of the <a
1843 href="#globalinfo">module global info block</a>. The purpose of these
1844fields is to allow a front end compiler to specifiy that the generated
1845module is specific to a particular target triple (operating
1846system/manufacturer/processor) which makes it non-portable; and to
1847allow front end compilers to specify the list of libraries that the
1848module depends on for successful linking.</p>
1849</div>
1850<!-- _______________________________________________________________________ -->
1851<div class="doc_subsubsection">Types Restricted to 24-bits</div>
1852<div class="doc_text">
1853<p>In version 1.2, type slot identifiers were written as 32-bit VBR
1854quantities. In 1.3 this has been reduced to 24-bits in order to ensure
1855that it is not possible to overflow the type field of a global variable
1856definition. 24-bits for type slot numbers is deemed sufficient for any
1857practical use of LLVM.</p>
1858</div>
1859<!-- _______________________________________________________________________ -->
1860<!-- _______________________________________________________________________ -->
1861<div class="doc_subsection"><a name="vers11">Version 1.1 Differences
1862From 1.2 </a></div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1863<!-- _______________________________________________________________________ -->
1864<div class="doc_subsubsection">Explicit Primitive Zeros</div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1865<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1866<p>In version 1.1, the zero value for primitives was explicitly encoded
1867into the bytecode format. Since these zero values are constant values
1868in the LLVM IR and never change, there is no reason to explicitly
1869encode them. This explicit encoding was removed in version 1.2.</p>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1870</div>
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1871<!-- _______________________________________________________________________ -->
1872<div class="doc_subsubsection">Inconsistent Module Global Info</div>
1873<div class="doc_text">
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1874<p>In version 1.1, the Module Global Info block was not aligned causing
1875the next block to be read in on an unaligned boundary. This problem was
1876corrected in version 1.2.<br>
1877<br>
1878</p>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1879</div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1880<!-- _______________________________________________________________________ -->
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1881<div class="doc_subsection"><a name="vers10">Version 1.0 Differences
1882From 1.1</a></div>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1883<div class="doc_text">
Reid Spencer4e0352d2004-07-05 08:18:07 +0000[diff] [blame]1884<p>None. Version 1.0 and 1.1 bytecode formats are identical.</p>
Reid Spencerb14a0a62004-06-08 07:41:41 +0000[diff] [blame]1885</div>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1886<!-- *********************************************************************** -->
1887<hr>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1888<address> <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1889 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1890<a href="http://validator.w3.org/check/referer"><img
1891 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
1892<a href="mailto:rspencer@x10sys.com">Reid Spencer</a> and <a
1893 href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1894<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1895Last modified: $Date$
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]1896</address>
Reid Spencere831f0b2004-07-29 00:13:04 +0000[diff] [blame]1897</body>
1898</html>