Update documentation to reflect:
[oota-llvm.git] / docs / LangRef.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><title>llvm Assembly Language Reference Manual</title></head>
3 <body bgcolor=white>
4
5 <table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
6 <tr><td>&nbsp; <font size=+5 color="#EEEEFF" face="Georgia,Palatino,Times,Roman"><b>llvm Assembly Language Reference Manual</b></font></td>
7 </tr></table>
8
9 <ol>
10   <li><a href="#abstract">Abstract</a>
11   <li><a href="#introduction">Introduction</a>
12   <li><a href="#identifiers">Identifiers</a>
13   <li><a href="#typesystem">Type System</a>
14     <ol>
15       <li><a href="#t_primitive">Primitive Types</a>
16         <ol>
17           <li><a href="#t_classifications">Type Classifications</a>
18         </ol>
19       <li><a href="#t_derived">Derived Types</a>
20         <ol>
21           <li><a href="#t_array"  >Array Type</a>
22           <li><a href="#t_method" >Method Type</a>
23           <li><a href="#t_pointer">Pointer Type</a>
24           <li><a href="#t_struct" >Structure Type</a>
25           <li><a href="#t_packed" >Packed Type</a>
26         </ol>
27     </ol>
28   <li><a href="#highlevel">High Level Structure</a>
29     <ol>
30       <li><a href="#modulestructure">Module Structure</a>
31       <li><a href="#methodstructure">Method Structure</a>
32     </ol>
33   <li><a href="#instref">Instruction Reference</a>
34     <ol>
35       <li><a href="#terminators">Terminator Instructions</a>
36         <ol>
37           <li><a href="#i_ret"     >'<tt>ret</tt>' Instruction</a>
38           <li><a href="#i_br"      >'<tt>br</tt>' Instruction</a>
39           <li><a href="#i_switch"  >'<tt>switch</tt>' Instruction</a>
40           <li><a href="#i_callwith">'<tt>call .. with</tt>' Instruction</a>
41         </ol>
42       <li><a href="#unaryops">Unary Operations</a>
43         <ol>
44           <li><a href="#i_not" >'<tt>not</tt>' Instruction</a>
45           <li><a href="#i_cast">'<tt>cast .. to</tt>' Instruction</a>
46         </ol>
47       <li><a href="#binaryops">Binary Operations</a>
48         <ol>
49           <li><a href="#i_add"  >'<tt>add</tt>' Instruction</a>
50           <li><a href="#i_sub"  >'<tt>sub</tt>' Instruction</a>
51           <li><a href="#i_mul"  >'<tt>mul</tt>' Instruction</a>
52           <li><a href="#i_div"  >'<tt>div</tt>' Instruction</a>
53           <li><a href="#i_rem"  >'<tt>rem</tt>' Instruction</a>
54           <li><a href="#i_setcc">'<tt>set<i>cc</i></tt>' Instructions</a>
55         </ol>
56       <li><a href="#bitwiseops">Bitwise Binary Operations</a>
57         <ol>
58           <li><a href="#i_and">'<tt>and</tt>' Instruction</a>
59           <li><a href="#i_or" >'<tt>or</tt>'  Instruction</a>
60           <li><a href="#i_xor">'<tt>xor</tt>' Instruction</a>
61           <li><a href="#i_shl">'<tt>shl</tt>' Instruction</a>
62           <li><a href="#i_shr">'<tt>shr</tt>' Instruction</a>
63         </ol>
64       <li><a href="#memoryops">Memory Access Operations</a>
65         <ol>
66           <li><a href="#i_malloc"  >'<tt>malloc</tt>'   Instruction</a>
67           <li><a href="#i_free"    >'<tt>free</tt>'     Instruction</a>
68           <li><a href="#i_alloca"  >'<tt>alloca</tt>'   Instruction</a>
69           <li><a href="#i_load"    >'<tt>load</tt>'     Instruction</a>
70           <li><a href="#i_store"   >'<tt>store</tt>'    Instruction</a>
71           <li><a href="#i_getfieldptr">'<tt>getfieldptr</tt>' Instruction</a>
72         </ol>
73       <li><a href="#otherops">Other Operations</a>
74         <ol>
75           <li><a href="#i_call" >'<tt>call</tt>'  Instruction</a>
76           <li><a href="#i_icall">'<tt>icall</tt>' Instruction</a>
77           <li><a href="#i_phi"  >'<tt>phi</tt>'   Instruction</a>
78         </ol>
79       <li><a href="#builtinfunc">Builtin Functions</a>
80     </ol>
81   <li><a href="#todo">TODO List</a>
82     <ol>
83       <li><a href="#exception">Exception Handling Instructions</a>
84       <li><a href="#synchronization">Synchronization Instructions</a>
85     </ol>
86   <li><a href="#extensions">Possible Extensions</a>
87     <ol>
88       <li><a href="#i_tailcall">'<tt>tailcall</tt>' Instruction</a>
89       <li><a href="#globalvars">Global Variables</a>
90       <li><a href="#explicitparrellelism">Explicit Parrellelism</a>
91     </ol>
92   <li><a href="#related">Related Work</a>
93 </ol>
94
95
96 <!-- *********************************************************************** -->
97 <p><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
98 <a name="abstract">Abstract
99 </b></font></td></tr></table><ul>
100 <!-- *********************************************************************** -->
101
102 <blockquote>
103   This document describes the LLVM assembly language IR/VM.  LLVM is an SSA
104   based representation that attempts to be a useful midlevel IR by providing 
105   type safety, low level operations, flexibility, and the capability to 
106   represent 'all' high level languages cleanly.
107 </blockquote>
108
109
110
111
112 <!-- *********************************************************************** -->
113 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
114 <a name="introduction">Introduction
115 </b></font></td></tr></table><ul>
116 <!-- *********************************************************************** -->
117
118 The LLVM is designed to exhibit a dual nature: on one hand, it is a useful compiler IR, on the other hand, it is a bytecode representation for dynamic compilation.  We contend that this is a natural and good thing, making LLVM a natural form of communication between different compiler phases, and also between a static and dynamic compiler.<p>
119
120 This dual nature leads to three different representations of LLVM (the human readable assembly representation, the compact bytecode representation, and the in memory, pointer based, representation).  This document describes the human readable representation and notation.<p>
121
122 The LLVM representation aims to be a light weight and low level while being expressive, type safe, and extensible at the same time.  It aims to be a "universal IR" of sorts, by being at a low enough level that high level ideas may be cleanly mapped to it.  By providing type safety, LLVM can be used as the target of optimizations: for example, through pointer analysis, it can be proven that a C automatic variable is never accessed outside of the current function... allowing it to be promoted to a simple SSA value instead of a memory location.<p>
123
124 <!-- _______________________________________________________________________ -->
125 </ul><a name="wellformed"><h4><hr size=0>Well Formedness</h4><ul>
126
127 It is important to note that this document describes 'well formed' llvm assembly language.  There is a difference between what the parser accepts and what is considered 'well formed'.  For example, the following instruction is syntactically okay, but not well formed:<p>
128
129 <pre>
130   %x = <a href="#i_add">add</a> int 1, %x
131 </pre>
132
133 ...because only a <tt><a href="#i_phi">phi</a></tt> node may refer to itself.  The LLVM api provides a verification function (<tt>verify</tt>) that may be used to verify that a whole module or a single method is well formed.  It is useful to validate whether an optimization pass performed a well formed transformation to the code.<p>
134
135
136 Describe the typesetting conventions here. 
137
138
139 <!-- *********************************************************************** -->
140 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
141 <a name="identifiers">Identifiers
142 </b></font></td></tr></table><ul>
143 <!-- *********************************************************************** -->
144
145 LLVM uses three different forms of identifiers, for different purposes:<p>
146
147 <ol>
148 <li>Numeric constants are represented as you would expect: 12, -3 123.421, etc.
149 <li>Named values are represented as a string of characters with a '%' prefix.  For example, %foo, %DivisionByZero, %a.really.long.identifier.  The actual regular expression used is '<tt>%[a-zA-Z$._][a-zA-Z$._0-9]*</tt>'.
150 <li>Unnamed values are represented as an unsigned numeric value with a '%' prefix.  For example, %12, %2, %44.
151 </ol><p>
152
153 LLVM requires the values start with a '%' sign for two reasons: Compilers don't need to worry about name clashes with reserved words, and the set of reserved words may be expanded in the future without penalty.  Additionally, unnamed identifiers allow a compiler to quickly come up with a temporary variable without having to avoid symbol table conflicts.<p>
154
155 Reserved words in LLVM are very similar to reserved words in other languages.  There are keywords for different opcodes ('<tt><a href="#i_add">add</a></tt>', '<tt><a href="#i_cast">cast</a></tt>', '<tt><a href="#i_ret">ret</a></tt>', etc...), for primitive type names ('<tt><a href="#t_void">void</a></tt>', '<tt><a href="#t_uint">uint</a></tt>', etc...), and others.  These reserved words cannot conflict with variable names, because none of them may start with a '%' character.<p>
156
157 Here is an example of LLVM code to multiply the integer variable '<tt>%X</tt>' by 8:<p>
158
159 The easy way:
160 <pre>
161   %result = <a href="#i_mul">mul</a> int %X, 8
162 </pre>
163
164 After strength reduction:
165 <pre>
166   %result = <a href="#i_shl">shl</a> int %X, ubyte 3
167 </pre>
168
169 And the hard way:
170 <pre>
171   <a href="#i_add">add</a> int %X, %X           <i>; yields {int}:%0</i>
172   <a href="#i_add">add</a> int %0, %0           <i>; yields {int}:%1</i>
173   %result = <a href="#i_add">add</a> int %1, %1
174 </pre>
175
176 This last way of multiplying <tt>%X</tt> by 8 illustrates several important lexical features of LLVM:<p>
177
178 <ol>
179 <li>Comments are delimited with a '<tt>;</tt>' and go until the end of line.
180 <li>Unnamed temporaries are created when the result of a computation is not assigned to a named value.
181 <li>Unnamed temporaries are numbered sequentially
182 </ol><p>
183
184 ...and it also show a convention that we follow in this document.  When demonstrating instructions, we will follow an instruction with a comment that defines the type and name of value produced.  Comments are shown in italic text.<p>
185
186
187
188 <!-- *********************************************************************** -->
189 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
190 <a name="typesystem">Type System
191 </b></font></td></tr></table><ul>
192 <!-- *********************************************************************** -->
193
194 The LLVM type system is important to the overall usefulness of the language and VM runtime.  By being strongly typed, a number of optimizations may be performed on the IR directly, without having to do extra analysis to derive types.  A strong type system also makes it easier to comprehend generated code and assists with safety concerns.<p>
195
196 The assembly language form for the type system was heavily influenced by the type problems in the C language<sup><a href="#rw_stroustrup">1</a></sup>.<p>
197
198
199
200 <!-- ======================================================================= -->
201 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
202 <a name="t_primitive">Primitive Types
203 </b></font></td></tr></table><ul>
204
205 The primitive types are the fundemental building blocks of the LLVM system.  The current set of primitive types are as follows:<p>
206
207 <table border=0 align=center><tr><td>
208
209 <table border=1 cellspacing=0 cellpadding=4 align=center>
210 <tr><td><tt>void</tt></td>  <td>No value</td></tr>
211 <tr><td><tt>ubyte</tt></td> <td>Unsigned 8 bit value</td></tr>
212 <tr><td><tt>ushort</tt></td><td>Unsigned 16 bit value</td></tr>
213 <tr><td><tt>uint</tt></td>  <td>Unsigned 32 bit value</td></tr>
214 <tr><td><tt>ulong</tt></td> <td>Unsigned 64 bit value</td></tr>
215 <tr><td><tt>float</tt></td> <td>32 bit floating point value</td></tr>
216 <tr><td><tt>label</tt></td> <td>Branch destination</td></tr>
217 </table>
218
219 </td><td>
220
221 <table border=1 cellspacing=0 cellpadding=4 align=center>
222 <tr><td><tt>bool</tt></td>  <td>True or False value</td></tr>
223 <tr><td><tt>sbyte</tt></td> <td>Signed 8 bit value</td></tr>
224 <tr><td><tt>short</tt></td> <td>Signed 16 bit value</td></tr>
225 <tr><td><tt>int</tt></td>   <td>Signed 32 bit value</td></tr>
226 <tr><td><tt>long</tt></td>  <td>Signed 64 bit value</td></tr>
227 <tr><td><tt>double</tt></td><td>64 bit floating point value</td></tr>
228 <tr><td><tt>lock</tt></td>  <td>Recursive mutex value</td></tr>
229 </table>
230
231 </td></tr></table><p>
232
233
234
235 <!-- _______________________________________________________________________ -->
236 </ul><a name="t_classifications"><h4><hr size=0>Type Classifications</h4><ul>
237
238 These different primitive types fall into a few useful classifications:<p>
239
240 <table border=1 cellspacing=0 cellpadding=4 align=center>
241 <tr><td><a name="t_signed">signed</td>    <td><tt>sbyte, short, int, long, float, double</tt></td></tr>
242 <tr><td><a name="t_unsigned">unsigned</td><td><tt>ubyte, ushort, uint, ulong</tt></td></tr>
243 <tr><td><a name="t_integral">integral</td><td><tt>ubyte, sbyte, ushort, short, uint, int, ulong, long</tt></td></tr>
244 <tr><td><a name="t_floating">floating point</td><td><tt>float, double</tt></td></tr>
245 <tr><td><a name="t_firstclass">first class</td><td><tt>bool, ubyte, sbyte, ushort, short, uint, int, ulong, long, float, double, lock</tt></td></tr>
246 </table><p>
247
248
249
250
251
252 <!-- ======================================================================= -->
253 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
254 <a name="t_derived">Derived Types
255 </b></font></td></tr></table><ul>
256
257 The real power in LLVM comes from the derived types in the system.  This is what allows a programmer to represent arrays, methods, pointers, and other useful types.  Note that these derived types may be recursive: For example, it is possible to have a two dimensional array.<p>
258
259
260
261 <!-- _______________________________________________________________________ -->
262 </ul><a name="t_array"><h4><hr size=0>Array Type</h4><ul>
263
264 <h5>Overview:</h5>
265
266 The array type is a very simple derived type.  It arranges elements sequentially in memory.  There are two different forms of the array type:<p>
267
268 <ol>
269 <a name="t_array_fixed"><b><li>Fixed size array type:</b><br>
270    The simplest form of the array type, has a size hard coded in as part of the type.  Thus these are three distinct type qualifiers:<p>
271
272    <tt>[40 x int ]</tt>: Array of 40 integer values.<br>
273    <tt>[41 x int ]</tt>: Array of 41 integer values.<br>
274    <tt>[40 x uint]</tt>: Array of 40 unsigned integer values.<p>
275
276 Fixed sized arrays are very useful for compiler optimization passes and for representing analysis results.  Additionally, multidimensional arrays must have fixed sizes for all dimensions except the outer-most dimension.<p>
277
278 <a name="t_array_unsized"><b><li>Dynamically sized array type:</b><br>
279   The dynamically sized arrays are very similar to the fixed size arrays, except that the size of the array is calculated at runtime by the virtual machine.  This is useful for representing generic methods that take any size array as an argument, or when representing Java style arrays.
280 </ol><p>
281
282 Here are some examples of multidimensional arrays:<p>
283 <ul>
284 <table border=0 cellpadding=0 cellspacing=0>
285 <tr><td><tt>[3 x [4 x int]]</tt></td><td>: 3x4 array integer values.</td></tr>
286 <tr><td><tt>[[10 x int]]</tt></td><td>: Nx10 array of integer values.</td></tr>
287 <tr><td><tt>[2 x [3 x [4 x uint]]]</tt></td><td>: 2x3x4 array of unsigned integer values.</td></tr>
288 </table>
289 </ul>
290
291
292
293 <!-- _______________________________________________________________________ -->
294 </ul><a name="t_method"><h4><hr size=0>Method Type</h4><ul>
295
296 <h5>Overview:</h5>
297
298 The method type can be thought of as a method signature.  It consists of a return type and a list of formal parameter types.  Method types are usually used when to build virtual function tables (which are structures of pointers to methods) and for indirect method calls.<p>
299
300 <h5>Syntax:</h5>
301 <pre>
302   &lt;returntype&gt; (&lt;parameter list&gt;)
303 </pre>
304
305 Where '<tt>&lt;parameter list&gt;</tt>' is a comma seperated list of type specifiers.<p>
306
307 <h5>Examples:</h5>
308 <ul>
309 <table border=0 cellpadding=0 cellspacing=0>
310 <tr><td><tt>int (int)</tt></td><td>: method taking an <tt>int</tt>, returning an <tt>int</tt></td></tr>
311 <tr><td><tt>float (int, int *) *</tt></td><td>: <a href="#t_pointer">Pointer</a> to a method that takes an <tt>int</tt> and a <a href="#t_pointer">pointer</a> to <tt>int</tt>, returning <tt>float</tt>.</td></tr>
312 </table>
313 </ul>
314
315
316
317 <!-- _______________________________________________________________________ -->
318 </ul><a name="t_struct"><h4><hr size=0>Structure Type</h4><ul>
319
320 <h5>Overview:</h5>
321
322 The structure type is used to represent a collection of data members together in memory.  Although the runtime is allowed to lay out the data members any way that it would like, they are guaranteed to be "close" to each other.<p>
323
324 Structures are accessed using '<tt><a href="#i_load">load</a></tt> and '<tt><a href="#i_store">store</a></tt>' by getting a pointer to a field with the '<tt><a href="#i_getfieldptr">getfieldptr</a></tt>' instruction.<p>
325
326 <h5>Syntax:</h5>
327 <pre>
328   { &lt;type list&gt; }
329 </pre>
330
331
332 <h5>Examples:</h5>
333 <table border=0 cellpadding=0 cellspacing=0>
334 <tr><td><tt>{ int, int, int }</tt></td><td>: a triple of three <tt>int</tt> values</td></tr>
335 <tr><td><tt>{ float, int (int *) * }</tt></td><td>: A pair, where the first element is a <tt>float</tt> and the second element is a <a href="#t_pointer">pointer</a> to a <a href="t_method">method</a> that takes an <tt>int</tt>, returning an <tt>int</tt>.</td></tr>
336 </table>
337
338
339 <!-- _______________________________________________________________________ -->
340 </ul><a name="t_pointer"><h4><hr size=0>Pointer Type</h4><ul>
341
342
343 <!-- _______________________________________________________________________ -->
344 </ul><a name="t_packed"><h4><hr size=0>Packed Type</h4><ul>
345
346 Mention/decide that packed types work with saturation or not. Maybe have a packed+saturated type in addition to just a packed type.<p>
347
348 Packed types should be 'nonsaturated' because standard data types are not saturated.  Maybe have a saturated packed type?<p>
349
350
351 <!-- *********************************************************************** -->
352 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
353 <a name="highlevel">High Level Structure
354 </b></font></td></tr></table><ul>
355 <!-- *********************************************************************** -->
356
357
358 <!-- ======================================================================= -->
359 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
360 <a name="modulestructure">Module Structure
361 </b></font></td></tr></table><ul>
362
363
364 talk about the elements of a module: constant pool and method list.<p>
365
366
367 <!-- ======================================================================= -->
368 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
369 <a name="methodstructure">Method Structure
370 </b></font></td></tr></table><ul>
371
372
373 talk about the constant pool<p>
374 talk about how basic blocks delinate labels<p>
375 talk about how basic blocks end with terminators<p>
376
377
378 <!-- *********************************************************************** -->
379 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
380 <a name="instref">Instruction Reference
381 </b></font></td></tr></table><ul>
382 <!-- *********************************************************************** -->
383
384 List all of the instructions, list valid types that they accept. Tell what they
385 do and stuff also.
386
387 <!-- ======================================================================= -->
388 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
389 <a name="terminators">Terminator Instructions
390 </b></font></td></tr></table><ul>
391
392
393
394 As was mentioned <a href="#methodstructure">previously</a>, every basic block in
395 a program ends with a "Terminator" instruction.  Additionally, all terminators yield a '<tt>void</tt>' value: they produce control flow, not values.<p>
396
397 There are three different terminator instructions: the '<a href="#i_ret"><tt>ret</tt></a>' instruction, the '<a href="#i_br"><tt>br</tt></a>' instruction, and the '<a href="#i_switch"><tt>switch</tt></a>' instruction.<p>
398
399
400 <!-- _______________________________________________________________________ -->
401 </ul><a name="i_ret"><h4><hr size=0>'<tt>ret</tt>' Instruction</h4><ul>
402
403 <h5>Syntax:</h5>
404 <pre>
405   ret &lt;type&gt; &lt;value&gt;       <i>; Return a value from a non-void method</i>
406   ret void                 <i>; Return from void method</i>
407 </pre>
408
409 <h5>Overview:</h5>
410 The '<tt>ret</tt>' instruction is used to return control flow (and optionally a value) from a method, back to the caller.<p>
411
412 There are two forms of the '<tt>ret</tt>' instructruction: one that returns a value and then causes control flow, and one that just causes control flow to occur.<p>
413
414 <h5>Arguments:</h5>
415 The '<tt>ret</tt>' instruction may return any '<a href="#t_firstclass">first class</a>' type.  Notice that a method is not <a href="#wellformed">well formed</a> if there exists a '<tt>ret</tt>' instruction inside of the method that returns a value that does not match the return type of the method.<p>
416
417 <h5>Semantics:</h5>
418 When the '<tt>ret</tt>' instruction is executed, control flow returns back to the calling method's context.  If the instruction returns a value, that value shall be propogated into the calling method's data space.<p>
419
420 <h5>Example:</h5>
421 <pre>
422   ret int 5                       <i>; Return an integer value of 5</i>
423   ret void                        <i>; Return from a void method</i>
424 </pre>
425
426
427 <!-- _______________________________________________________________________ -->
428 </ul><a name="i_br"><h4><hr size=0>'<tt>br</tt>' Instruction</h4><ul>
429
430 <h5>Syntax:</h5>
431 <pre>
432   br bool &lt;cond&gt;, label &lt;iftrue&gt;, label &lt;iffalse&gt;
433   br label &lt;dest&gt;          <i>; Unconditional branch</i>
434 </pre>
435
436 <h5>Overview:</h5>
437 The '<tt>br</tt>' instruction is used to cause control flow to transfer to a different basic block in the current method.  There are two forms of this instruction, corresponding to a conditional branch and an unconditional branch.  The '<tt>br</tt>' instruction is a (useful) special case '<tt><a href="#i_switch">switch</a></tt>' instruction.<p>
438
439 <h5>Arguments:</h5>
440
441 The conditional branch form of the '<tt>br</tt>' instruction shall take a single '<tt>bool</tt>' value and two '<tt>label</tt>' values.  The unconditional form of the '<tt>br</tt>' instruction takes a single '<tt>label</tt>' value as a target.<p>
442
443 <h5>Semantics:</h5>
444
445 Upon execution of a conditional '<tt>br</tt>' instruction, the '<tt>bool</tt>' argument is evaluated.  If the value is <tt>true</tt>, control flows to the '<tt>iftrue</tt>' '<tt>label</tt>' argument.  If "cond" is <tt>false</tt>, control flows to the '<tt>iffalse</tt>' '<tt>label</tt>' argument.<p>
446
447 <h5>Example:</h5>
448 <pre>
449 Test:
450   %cond = <a href="#i_setcc">seteq</a> int %a, %b
451   br bool %cond, label %IfEqual, label %IfUnequal
452 IfEqual:
453   <a href="#i_ret">ret</a> bool true
454 IfUnequal:
455   <a href="#i_ret">ret</a> bool false
456 </pre>
457
458
459 <!-- _______________________________________________________________________ -->
460 </ul><a name="i_switch"><h4><hr size=0>'<tt>switch</tt>' Instruction</h4><ul>
461
462 <h5>Syntax:</h5>
463 <pre>
464   <i>; Definitions for lookup indirect branch</i>
465   %switchtype = type [&lt;anysize&gt; x { uint, label }]
466
467   <i>; Lookup indirect branch</i>
468   switch uint &lt;value&gt;, label &lt;defaultdest&gt;, %switchtype &lt;switchtable&gt;
469
470   <i>; Indexed indirect branch</i>
471   switch uint &lt;idxvalue&gt;, label &lt;defaultdest&gt;, [&lt;anysize&gt; x label] &lt;desttable&gt;
472 </pre>
473
474 <h5>Overview:</h5>
475 The '<tt>switch</tt>' instruction is used to transfer control flow to one of several different places.  It is a simple generalization of the '<tt>br</tt>' instruction, and supports a strict superset of its functionality.<p>
476
477 The '<tt>switch</tt>' statement supports two different styles of indirect branching: lookup branching and indexed branching.  Lookup branching is generally useful if the values to switch on are spread far appart, where index branching is useful if the values to switch on are generally dense.<p>
478
479 The two different forms of the '<tt>switch</tt>' statement are simple hints to the underlying virtual machine implementation.  For example, a virtual machine may choose to implement a small indirect branch table as a series of predicated comparisons: if it is faster for the target architecture.<p>
480
481 <h5>Arguments:</h5>
482 The lookup form of the '<tt>switch</tt>' instruction uses three parameters: a '<tt>uint</tt>' comparison value '<tt>value</tt>', a default '<tt>label</tt>' destination, and a sized array of pairs of comparison value constants and '<tt>label</tt>'s.  The sized array must be a constant value.<p>
483
484 The indexed form of the '<tt>switch</tt>' instruction uses three parameters: an '<tt>uint</tt>' index value, a default '<tt>label</tt>' and a sized array of '<tt>label</tt>'s.  The '<tt>dests</tt>' array must be a constant array.
485
486 <h5>Semantics:</h5>
487
488 The lookup style switch statement specifies a table of values and destinations.  When the '<tt>switch</tt>' instruction is executed, this table is searched for the given value.  If the value is found, the corresponding destination is branched to. <p>
489 The index branch form simply looks up a label element directly in a table and branches to it.<p>
490
491 In either case, the compiler knows the static size of the array, because it is provided as part of the constant values type.<p>
492
493 <h5>Example:</h5>
494 <pre>
495   <i>; Emulate a conditional br instruction</i>
496   %Val = <a href="#i_cast">cast</a> bool %value to uint
497   switch uint %Val, label %truedest, [1 x label] [label %falsedest ]
498
499   <i>; Emulate an unconditional br instruction</i>
500   switch uint 0, label %dest, [ 0 x label] [ ]
501
502   <i>; Implement a jump table using the constant pool:</i>
503   void "testmeth"(int %arg0)
504     %switchdests = [3 x label] [ label %onzero, label %onone, label %ontwo ]
505   {
506   ...
507     switch uint %val, label %otherwise, [3 x label] %switchdests...
508   ...
509   }
510
511   <i>; Implement the equivilent jump table directly:</i>
512   switch uint %val, label %otherwise, [3 x label] [ label %onzero, 
513                                                     label %onone, 
514                                                     label %ontwo ]
515
516 </pre>
517
518
519
520 <!-- _______________________________________________________________________ -->
521 </ul><a name="i_callwith"><h4><hr size=0>'<tt>call .. with</tt>' Instruction</h4><ul>
522
523 <h5>Syntax:</h5>
524 <pre>
525   &lt;result&gt; = call &lt;method ty&gt; %&lt;method name&gt;(&lt;method args&gt;) with label &lt;break label&gt;
526 </pre>
527
528 <h5>Overview:</h5>
529 The '<tt>call .. with</tt>' instruction is used to cause control flow to transfer to a specified method, with the possibility of control flow transfer to the '<tt>break label</tt>' label, in addition to the possibility of fallthrough to the next basic block.  The '<tt><a href="#i_call">call</a></tt>' instruction is closely related, but does guarantees that control flow either never returns from the invoked method, or that it returns to the instruction succeeding the '<tt><a href="#i_call">call</a></tt>' instruction.<p>
530
531 TODO: icall .. with needs to be defined as well for an indirect call.<p>
532
533 <h5>Arguments:</h5>
534
535 This instruction requires several arguments:<p>
536 <ol>
537 <li>'<tt>method ty</tt>': shall be the signature of the named method being invoked.  This must be a <a href="#t_method">method type</a>.
538 <li>'<tt>method name</tt>': method name to be invoked.
539 <li>'<tt>method args</tt>': argument list whose types match the method signature argument types.
540 <li>'<tt>break label</tt>': a label that specifies the break label associated with this call.
541 </ol>
542
543 <h5>Semantics:</h5>
544
545 This instruction is designed to operate as a standard '<tt><a href="#i_call">call</a></tt>' instruction in most regards.  The primary difference is that it assiciates a label with the method invocation that may be accessed via the runtime library provided by the execution environment.  This instruction is used in languages with destructors to ensure that proper cleanup is performed in the case of either a <tt>longjmp</tt> or a thrown exception.  Additionally, this is important for implementation of '<tt>catch</tt>' clauses in high-level languages that support them.<p>
546
547 For a more comprehensive explanation of this instruction look in the llvm/docs/2001-05-18-ExceptionHandling.txt document.
548
549 <h5>Example:</h5>
550 <pre>
551   %retval = call int (int) %Test(int 15) with label %TestCleanup     <i>; {int}:retval set</i>
552 </pre>
553
554
555
556 <!-- ======================================================================= -->
557 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
558 <a name="unaryops">Unary Operations
559 </b></font></td></tr></table><ul>
560
561 Unary operators are used to do a simple operation to a single value.<p>
562
563 There are two different unary operators: the '<a href="#i_not"><tt>not</tt></a>' instruction and the '<a href="#i_cast"><tt>cast</tt></a>' instruction.<p>
564
565
566 <!-- _______________________________________________________________________ -->
567 </ul><a name="i_not"><h4><hr size=0>'<tt>not</tt>' Instruction</h4><ul>
568
569 <h5>Syntax:</h5>
570 <pre>
571   &lt;result&gt; = not &lt;ty&gt; &lt;var&gt;       <i>; yields {ty}:result</i>
572 </pre>
573
574 <h5>Overview:</h5>
575 The  '<tt>not</tt>' instruction returns the <a href="#logical_integrals">logical</a> inverse of its operand.<p>
576
577 <h5>Arguments:</h5>
578 The single argument to '<tt>not</tt>' must be of of <a href="#t_integral">integral</a> type.<p>
579
580
581 <h5>Semantics:</h5>
582 The '<tt>not</tt>' instruction returns the <a href="#logical_integrals">logical</a> inverse of an <a href="#t_integral">integral</a> type.<p>
583
584 Note that the '<tt>not</tt>' instruction is is not defined over to '<tt>bool</tt>' type.  To invert a boolean value, the recommended method is to use:<p>
585
586 <pre>
587   &lt;result&gt; = xor bool true, &lt;var&gt; <i>; yields {bool}:result</i>
588 </pre>
589
590 <h5>Example:</h5>
591 <pre>
592   %x = not int 1                  <i>; {int}:x is now equal to 0</i>
593   %x = not bool true              <i>; {bool}:x is now equal to false</i>
594 </pre>
595
596
597
598 <!-- _______________________________________________________________________ -->
599 </ul><a name="i_cast"><h4><hr size=0>'<tt>cast .. to</tt>' Instruction</h4><ul>
600
601 <h1>TODO</h1>
602
603 <a name="logical_integrals">
604   Talk about what is considered true or false for integrals.
605
606
607
608 <h5>Syntax:</h5>
609 <pre>
610 </pre>
611
612 <h5>Overview:</h5>
613
614
615 <h5>Arguments:</h5>
616
617
618 <h5>Semantics:</h5>
619
620
621 <h5>Example:</h5>
622 <pre>
623 </pre>
624
625
626 <!-- ======================================================================= -->
627 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
628 <a name="binaryops">Binary Operations
629 </b></font></td></tr></table><ul>
630
631 Binary operators are used to do most of the computation in a program.  They require two operands, execute an operation on them, and produce a single value.  The result value of a binary operator is not neccesarily the same type as its operands.<p>
632
633 There are several different binary operators:<p>
634
635
636 <!-- _______________________________________________________________________ -->
637 </ul><a name="i_add"><h4><hr size=0>'<tt>add</tt>' Instruction</h4><ul>
638
639 <h5>Syntax:</h5>
640 <pre>
641   &lt;result&gt; = add &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
642 </pre>
643
644 <h5>Overview:</h5>
645 The '<tt>add</tt>' instruction returns the sum of its two operands.<p>
646
647 <h5>Arguments:</h5>
648 The two arguments to the '<tt>add</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_floating">floating point</a> values.  Both arguments must have identical types.<p>
649
650 <h5>Semantics:</h5>
651 ...<p>
652
653 <h5>Example:</h5>
654 <pre>
655   &lt;result&gt; = add int 4, %var          <i>; yields {int}:result = 4 + %var</i>
656 </pre>
657
658
659 <!-- _______________________________________________________________________ -->
660 </ul><a name="i_sub"><h4><hr size=0>'<tt>sub</tt>' Instruction</h4><ul>
661
662 <h5>Syntax:</h5>
663 <pre>
664   &lt;result&gt; = sub &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
665 </pre>
666
667 <h5>Overview:</h5>
668 The '<tt>sub</tt>' instruction returns the difference of its two operands.<p>
669
670 Note that the '<tt>sub</tt>' instruction is the cannonical way the '<tt>neg</tt>' instruction is represented as well.<p>
671
672 <h5>Arguments:</h5>
673 The two arguments to the '<tt>sub</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_floating">floating point</a> values.  Both arguments must have identical types.<p>
674
675 <h5>Semantics:</h5>
676 ...<p>
677
678 <h5>Example:</h5>
679 <pre>
680   &lt;result&gt; = sub int 4, %var          <i>; yields {int}:result = 4 - %var</i>
681   &lt;result&gt; = sub int 0, %val          <i>; yields {int}:result = -%var</i>
682 </pre>
683
684 <!-- _______________________________________________________________________ -->
685 </ul><a name="i_mul"><h4><hr size=0>'<tt>mul</tt>' Instruction</h4><ul>
686
687 <h5>Syntax:</h5>
688 <pre>
689   &lt;result&gt; = mul &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
690 </pre>
691
692 <h5>Overview:</h5>
693 The  '<tt>mul</tt>' instruction returns the product of its two operands.<p>
694
695 <h5>Arguments:</h5>
696 The two arguments to the '<tt>mul</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_floating">floating point</a> values.  Both arguments must have identical types.<p>
697
698 <h5>Semantics:</h5>
699 ...<p>
700 There is no signed vs unsigned multiplication.  The appropriate action is taken based on the type of the operand. <p>
701
702
703 <h5>Example:</h5>
704 <pre>
705   &lt;result&gt; = mul int 4, %var          <i>; yields {int}:result = 4 * %var</i>
706 </pre>
707
708
709 <!-- _______________________________________________________________________ -->
710 </ul><a name="i_div"><h4><hr size=0>'<tt>div</tt>' Instruction</h4><ul>
711
712 <h5>Syntax:</h5>
713 <pre>
714   &lt;result&gt; = div &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
715 </pre>
716
717 <h5>Overview:</h5>
718 The  '<tt>div</tt>' instruction returns the quotient of its two operands.<p>
719
720 <h5>Arguments:</h5>
721 The two arguments to the '<tt>div</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_floating">floating point</a> values.  Both arguments must have identical types.<p>
722
723 <h5>Semantics:</h5>
724 ...<p>
725
726 <h5>Example:</h5>
727 <pre>
728   &lt;result&gt; = div int 4, %var          <i>; yields {int}:result = 4 / %var</i>
729 </pre>
730
731
732 <!-- _______________________________________________________________________ -->
733 </ul><a name="i_rem"><h4><hr size=0>'<tt>rem</tt>' Instruction</h4><ul>
734
735 <h5>Syntax:</h5>
736 <pre>
737   &lt;result&gt; = rem &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
738 </pre>
739
740 <h5>Overview:</h5>
741 The  '<tt>rem</tt>' instruction returns the remainder from the division of its two operands.<p>
742
743 <h5>Arguments:</h5>
744 The two arguments to the '<tt>rem</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_floating">floating point</a> values.  Both arguments must have identical types.<p>
745
746 <h5>Semantics:</h5>
747 TODO: remainder or modulus?<p>
748 ...<p>
749
750 <h5>Example:</h5>
751 <pre>
752   &lt;result&gt; = rem int 4, %var          <i>; yields {int}:result = 4 % %var</i>
753 </pre>
754
755
756 <!-- _______________________________________________________________________ -->
757 </ul><a name="i_setcc"><h4><hr size=0>'<tt>set<i>cc</i></tt>' Instructions</h4><ul>
758
759 <h5>Syntax:</h5>
760 <pre>
761   &lt;result&gt; = seteq &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
762   &lt;result&gt; = setne &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
763   &lt;result&gt; = setlt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
764   &lt;result&gt; = setgt &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
765   &lt;result&gt; = setle &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
766   &lt;result&gt; = setge &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {bool}:result</i>
767 </pre>
768
769 <h5>Overview:</h5>
770 The '<tt>set<i>cc</i></tt>' family of instructions returns a boolean value based on a comparison of their two operands.<p>
771
772 <h5>Arguments:</h5>
773 The two arguments to the '<tt>set<i>cc</i></tt>' instructions must be of <a href="#t_firstclass">first class</a> or <a href="#t_derived">derived</a> type (it is not possible to compare '<tt>label</tt>'s or '<tt>void</tt>' values).  Both arguments must have identical types.<p>
774
775 The '<tt>setlt</tt>', '<tt>setgt</tt>', '<tt>setle</tt>', and '<tt>setge</tt>' instructions do not operate on '<tt>bool</tt>' typed arguments.<p>
776
777 <h5>Semantics:</h5>
778 The '<tt>seteq</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if both operands are equal.<br>
779 The '<tt>setne</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if both operands are unequal.<br>
780 The '<tt>setlt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if the first operand is less than the second operand.<br>
781 The '<tt>setgt</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if the first operand is greater than the second operand.<br>
782 The '<tt>setle</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if the first operand is less than or equal to the second operand.<br>
783 The '<tt>setge</tt>' instruction yields a <tt>true</tt> '<tt>bool</tt>' value if the first operand is greater than or equal to the second operand.<p>
784
785 <h5>Example:</h5>
786 <pre>
787   &lt;result&gt; = seteq int   4, 5        <i>; yields {bool}:result = false</i>
788   &lt;result&gt; = setne float 4, 5        <i>; yields {bool}:result = true</i>
789   &lt;result&gt; = setlt uint  4, 5        <i>; yields {bool}:result = true</i>
790   &lt;result&gt; = setgt sbyte 4, 5        <i>; yields {bool}:result = false</i>
791   &lt;result&gt; = setle sbyte 4, 5        <i>; yields {bool}:result = true</i>
792   &lt;result&gt; = setge sbyte 4, 5        <i>; yields {bool}:result = false</i>
793 </pre>
794
795
796
797 <!-- ======================================================================= -->
798 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
799 <a name="bitwiseops">Bitwise Binary Operations
800 </b></font></td></tr></table><ul>
801
802 Bitwise binary operators are used to do various forms of bit-twiddling in a program.  They are generally very efficient instructions, and can commonly be strength reduced from other instructions.  They require two operands, execute an operation on them, and produce a single value.  The resulting value of the bitwise binary operators is always the same type as its first operand.<p>
803
804 <!-- _______________________________________________________________________ -->
805 </ul><a name="i_and"><h4><hr size=0>'<tt>and</tt>' Instruction</h4><ul>
806
807 <h5>Syntax:</h5>
808 <pre>
809   &lt;result&gt; = and &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
810 </pre>
811
812 <h5>Overview:</h5>
813 The '<tt>and</tt>' instruction returns the bitwise logical and of its two operands.<p>
814
815 <h5>Arguments:</h5>
816 The two arguments to the '<tt>and</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_bool"><tt>bool</tt></a> values.  Both arguments must have identical types.<p>
817
818
819 <h5>Semantics:</h5>
820 ...<p>
821
822
823 <h5>Example:</h5>
824 <pre>
825   &lt;result&gt; = and int 4, %var         <i>; yields {int}:result = 4 & %var</i>
826   &lt;result&gt; = and int 15, 40          <i>; yields {int}:result = 8</i>
827   &lt;result&gt; = and int 4, 8            <i>; yields {int}:result = 0</i>
828 </pre>
829
830
831
832 <!-- _______________________________________________________________________ -->
833 </ul><a name="i_or"><h4><hr size=0>'<tt>or</tt>' Instruction</h4><ul>
834
835 <h5>Syntax:</h5>
836 <pre>
837   &lt;result&gt; = or &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
838 </pre>
839
840 <h5>Overview:</h5>
841 The '<tt>or</tt>' instruction returns the bitwise logical inclusive or of its two operands.<p>
842
843 <h5>Arguments:</h5>
844 The two arguments to the '<tt>or</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_bool"><tt>bool</tt></a> values.  Both arguments must have identical types.<p>
845
846
847 <h5>Semantics:</h5>
848 ...<p>
849
850
851 <h5>Example:</h5>
852 <pre>
853   &lt;result&gt; = or int 4, %var         <i>; yields {int}:result = 4 | %var</i>
854   &lt;result&gt; = or int 15, 40          <i>; yields {int}:result = 47</i>
855   &lt;result&gt; = or int 4, 8            <i>; yields {int}:result = 12</i>
856 </pre>
857
858
859 <!-- _______________________________________________________________________ -->
860 </ul><a name="i_xor"><h4><hr size=0>'<tt>xor</tt>' Instruction</h4><ul>
861
862 <h5>Syntax:</h5>
863 <pre>
864   &lt;result&gt; = xor &lt;ty&gt; &lt;var1&gt;, &lt;var2&gt;   <i>; yields {ty}:result</i>
865 </pre>
866
867 <h5>Overview:</h5>
868 The '<tt>xor</tt>' instruction returns the bitwise logical exclusive or of its two operands.<p>
869
870 <h5>Arguments:</h5>
871 The two arguments to the '<tt>xor</tt>' instruction must be either <a href="#t_integral">integral</a> or <a href="#t_bool"><tt>bool</tt></a> values.  Both arguments must have identical types.<p>
872
873
874 <h5>Semantics:</h5>
875 ...<p>
876
877
878 <h5>Example:</h5>
879 <pre>
880   &lt;result&gt; = xor int 4, %var         <i>; yields {int}:result = 4 ^ %var</i>
881   &lt;result&gt; = xor int 15, 40          <i>; yields {int}:result = 39</i>
882   &lt;result&gt; = xor int 4, 8            <i>; yields {int}:result = 12</i>
883 </pre>
884
885
886 <!-- _______________________________________________________________________ -->
887 </ul><a name="i_shl"><h4><hr size=0>'<tt>shl</tt>' Instruction</h4><ul>
888
889 <h5>Syntax:</h5>
890 <pre>
891   &lt;result&gt; = shl &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
892 </pre>
893
894 <h5>Overview:</h5>
895 The '<tt>shl</tt>' instruction returns the first operand shifted to the left a specified number of bits.
896
897 <h5>Arguments:</h5>
898 The first argument to the '<tt>shl</tt>' instruction must be an  <a href="#t_integral">integral</a> type.  The second argument must be an '<tt>ubyte</tt>' type.<p>
899
900 <h5>Semantics:</h5>
901 ... 0 bits are shifted into the emptied bit positions...<p>
902
903
904 <h5>Example:</h5>
905 <pre>
906   &lt;result&gt; = shl int 4, ubyte %var   <i>; yields {int}:result = 4 << %var</i>
907   &lt;result&gt; = shl int 4, ubyte 2      <i>; yields {int}:result = 16</i>
908   &lt;result&gt; = shl int 1, ubyte 10     <i>; yields {int}:result = 1024</i>
909 </pre>
910
911
912 <!-- _______________________________________________________________________ -->
913 </ul><a name="i_shr"><h4><hr size=0>'<tt>shr</tt>' Instruction</h4><ul>
914
915
916 <h5>Syntax:</h5>
917 <pre>
918   &lt;result&gt; = shr &lt;ty&gt; &lt;var1&gt;, ubyte &lt;var2&gt;   <i>; yields {ty}:result</i>
919 </pre>
920
921 <h5>Overview:</h5>
922 The '<tt>shr</tt>' instruction returns the first operand shifted to the right a specified number of bits.
923
924 <h5>Arguments:</h5>
925 The first argument to the '<tt>shr</tt>' instruction must be an  <a href="#t_integral">integral</a> type.  The second argument must be an '<tt>ubyte</tt>' type.<p>
926
927 <h5>Semantics:</h5>
928 ... if the first argument is a <a href="#t_signed">signed</a> type, the most significant bit is duplicated in the newly free'd bit positions.  If the first argument is unsigned, zeros shall fill the empty positions...<p>
929
930 <h5>Example:</h5>
931 <pre>
932   &lt;result&gt; = shr int 4, ubyte %var   <i>; yields {int}:result = 4 >> %var</i>
933   &lt;result&gt; = shr int 4, ubyte 1      <i>; yields {int}:result = 2</i>
934   &lt;result&gt; = shr int 4, ubyte 2      <i>; yields {int}:result = 1</i>
935   &lt;result&gt; = shr int 4, ubyte 3      <i>; yields {int}:result = 0</i>
936 </pre>
937
938
939
940
941
942 <!-- ======================================================================= -->
943 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
944 <a name="memoryops">Memory Access Operations
945 </b></font></td></tr></table><ul>
946
947 Accessing memory in SSA form is, well, sticky at best.  This section describes how to read and write memory in LLVM.<p>
948
949
950 <!-- _______________________________________________________________________ -->
951 </ul><a name="i_malloc"><h4><hr size=0>'<tt>malloc</tt>' Instruction</h4><ul>
952
953 <h5>Syntax:</h5>
954 <pre>
955   &lt;result&gt; = malloc  &lt;type&gt;                        <i>; yields { type  *}:result</i>
956   &lt;result&gt; = malloc [&lt;type&gt;], uint &lt;NumElements&gt;   <i>; yields {[type] *}:result</i>
957 </pre>
958
959 <h5>Overview:</h5>
960 The '<tt>malloc</tt>' instruction allocates memory from the system heap and returns a pointer to it.<p>
961
962 <h5>Arguments:</h5>
963
964 There are two forms of the '<tt>malloc</tt>' instruction, one for allocating a variable of a fixed type, and one for allocating an array.  The array form is used to allocate an array, where the upper bound is not known until run time.  If the upper bound is known at compile time, it is recommended that the first form be used with a <a href="#t_array_fixed">sized array type</a>.<p>
965
966 '<tt>type</tt>' may be any type except for a <a href="#t_array_unsized">unsized array type</a>.<p>
967
968 <h5>Semantics:</h5>
969 Memory is allocated, a pointer is returned.<p>
970
971 <h5>Example:</h5>
972 <pre>
973   %array  = malloc [4 x ubyte ]                    <i>; yields {[%4 x ubyte]*}:array</i>
974
975   %size   = <a href="#i_add">add</a> uint 2, 2                          <i>; yields {uint}:size = uint 4</i>
976   %array1 = malloc [ubyte], uint 4                 <i>; yields {[ubyte]*}:array1</i>
977   %array2 = malloc [ubyte], uint %size             <i>; yields {[ubyte]*}:array2</i>
978 </pre>
979
980
981 <!-- _______________________________________________________________________ -->
982 </ul><a name="i_free"><h4><hr size=0>'<tt>free</tt>' Instruction</h4><ul>
983
984 <h5>Syntax:</h5>
985 <pre>
986   free &lt;type&gt; &lt;value&gt;                              <i>; yields {void}</i>
987 </pre>
988
989
990 <h5>Overview:</h5>
991 The '<tt>free</tt>' instruction returns memory back to the unused memory heap, to be reallocated in the future.<p>
992
993
994 <h5>Arguments:</h5>
995
996 '<tt>value</tt>' shall be a pointer value that points to a value that was allocated with the '<tt><a href="#i_malloc">malloc</a></tt>' instruction.<p>
997
998
999 <h5>Semantics:</h5>
1000 Memory is available for use after this point.  The contents of the '<tt>value</tt>' pointer are undefined after this instruction.<p>
1001
1002
1003 <h5>Example:</h5>
1004 <pre>
1005   %array  = <a href="#i_malloc">malloc</a> [4 x ubyte]                    <i>; yields {[4 x ubyte]*}:array</i>
1006             free   [4 x ubyte]* %array
1007 </pre>
1008
1009
1010 <!-- _______________________________________________________________________ -->
1011 </ul><a name="i_alloca"><h4><hr size=0>'<tt>alloca</tt>' Instruction</h4><ul>
1012
1013 <h5>Syntax:</h5>
1014 <pre>
1015   &lt;result&gt; = alloca  &lt;type&gt;                       <i>; yields {type*}:result</i>
1016   &lt;result&gt; = alloca [&lt;type&gt;], uint &lt;NumElements&gt;  <i>; yields {[type] *}:result</i>
1017 </pre>
1018
1019 <h5>Overview:</h5>
1020
1021 The '<tt>alloca</tt>' instruction allocates memory on the current stack frame of the procedure that is live as long as the method does not return.<p>
1022
1023 <h5>Arguments:</h5>
1024 There are two forms of the '<tt>alloca</tt>' instruction, one for allocating a variable of a fixed type, and one for allocating an array.  The array form is used to allocate an array, where the upper bound is not known until run time.  If the upper bound is known at compile time, it is recommended that the first form be used with a <a href="#t_array_fixed">sized array type</a>.<p>
1025
1026 '<tt>type</tt>' may be any type except for a <a href="#t_array_unsized">unsized array type</a>.<p>
1027
1028 Note that a virtual machine may generate more efficient native code for a method if all of the fixed size '<tt>alloca</tt>' instructions live in the first basic block of that method.
1029
1030
1031 <h5>Semantics:</h5>
1032 Memory is allocated, a pointer is returned.  '<tt>alloca</tt>'d memory is automatically released when the method returns.  The '<tt>alloca</tt>' utility is how variable spills shall be implemented.<p>
1033
1034 <h5>Example:</h5>
1035 <pre>
1036   %ptr = alloca int                              <i>; yields {int*}:ptr</i>
1037   %ptr = alloca [int], uint 4                    <i>; yields {[int]*}:ptr</i>
1038 </pre>
1039
1040
1041 <!-- _______________________________________________________________________ -->
1042 </ul><a name="i_load"><h4><hr size=0>'<tt>load</tt>' Instruction</h4><ul>
1043
1044 <h5>Syntax:</h5>
1045 <pre>
1046   &lt;result&gt; = load &lt;ty&gt;* &lt;pointer&gt;                 <i>; yields {ty}:result</i>
1047   &lt;result&gt; = load &lt;ty&gt;* &lt;arrayptr&gt;, uint &lt;idx&gt;    <i>; yields {ty}:result</i>
1048   &lt;result&gt; = load &lt;ty&gt;* &lt;structptr&gt;{, &lt;idx&gt;}*     <i>; yields field type</i>
1049 </pre>
1050
1051 <h5>Overview:</h5>
1052 The '<tt>load</tt>' instruction is used to read from memory.<p>
1053
1054 <h5>Arguments:</h5>
1055
1056 There are three forms of the '<tt>load</tt>' instruction: one for reading from a general pointer, one for reading from a pointer to an array, and one for reading from a pointer to a structure.<p>
1057
1058 In the first form, '<tt>&lt;ty&gt;</tt>' may be any pointer type.  If it is a pointer to an array, the first (zeroth) element is read from).  In the second form, '<tt>&lt;ty&gt;</tt>' must be a pointer to an array.  No bounds checking is performed on array reads.  In the third form, the pointer must point to a (possibly nested) structure.  There shall be one ubyte argument for each level of dereferencing involved.<p>
1059
1060
1061 <h5>Semantics:</h5>
1062 ...
1063
1064 <h5>Examples:</h5>
1065 <pre>
1066   %ptr = <a href="#i_alloca">alloca</a> int                               <i>; yields {int*}:ptr</i>
1067          <a href="#i_store">store</a> int* %ptr, int 3                   <i>; yields {void}</i>
1068   %val = load int* %ptr                           <i>; yields {int}:val = int 3</i>
1069
1070   %array = <a href="#i_malloc">malloc</a> [4 x ubyte]                     <i>; yields {[4 x ubyte]*}:array</i>
1071            <a href="#i_store">store</a> [4 x ubyte]* %array, 
1072                  uint 4, ubyte 124
1073   %val   = load [4 x ubyte]* %array, uint 4       <i>; yields {ubyte}:val = ubyte 124</i>
1074   %val   = load {{int, float}}* %stptr, 0, 1      <i>; yields {float}:val</i>
1075 </pre>
1076
1077
1078
1079
1080 <!-- _______________________________________________________________________ -->
1081 </ul><a name="i_store"><h4><hr size=0>'<tt>store</tt>' Instruction</h4><ul>
1082
1083 <h5>Syntax:</h5>
1084 <pre>
1085   store &lt;ty&gt;* &lt;pointer&gt;, &lt;ty&gt; &lt;value&gt;              <i>; yields {void}</i>
1086   store &lt;ty&gt;* &lt;arrayptr&gt;, uint &lt;idx&gt;, &lt;ty&gt; &lt;value&gt; <i>; yields {void}</i>
1087 </pre>
1088
1089 <h5>Overview:</h5>
1090 The '<tt>store</tt>' instruction is used to write to memory.<p>
1091
1092
1093 <h5>Arguments:</h5>
1094 There are two forms of the '<tt>store</tt>' instruction: one for writing through a general pointer, and one for writing through a pointer to an array.<p>
1095
1096 In the first form, '<tt>&lt;ty&gt;</tt>' may be any pointer type.  If it is a pointer to an array, the first (zeroth) element is writen to).  In the second form, '<tt>&lt;ty&gt;</tt>' must be a pointer to an array.  No bounds checking is performed on array writes.<p>
1097
1098
1099 <h5>Semantics:</h5>
1100 ...
1101
1102 <h5>Example:</h5>
1103 <pre>
1104   %ptr =   <a href="#i_alloca">alloca</a> int                              <i>; yields {int*}:ptr</i>
1105            store int* %ptr, int 3                  <i>; yields {void}</i>
1106   %val =   <a href="#i_load">load</a> int* %ptr                          <i>; yields {int}:val = int 3</i>
1107
1108   %array = <a href="#i_malloc">malloc</a> [4 x ubyte]                      <i>; yields {[4 x ubyte]*}:array</i>
1109            store [4 x ubyte]* %array, 
1110                  uint 4, ubyte 124
1111   %val   = <a href="#i_load">load</a> [4 x ubyte]* %array, uint 4        <i>; yields {ubyte}:val = ubyte 124</i>
1112 </pre>
1113
1114
1115
1116
1117 <!-- _______________________________________________________________________ -->
1118 </ul><a name="i_getfieldptr"><h4><hr size=0>'<tt>getfieldptr</tt>' Instruction</h4><ul>
1119
1120 <h5>Syntax:</h5>
1121 <pre>
1122
1123 </pre>
1124
1125 <h5>Overview:</h5>
1126
1127 getfield takes a structure pointer, and an unsigned byte.  It returns a pointer to the specified element, of the correct type.  At the implementation level, this would be compiled down to an addition of a constant int.
1128
1129 <h5>Arguments:</h5>
1130
1131
1132 <h5>Semantics:</h5>
1133
1134
1135 <h5>Example:</h5>
1136 <pre>
1137
1138 </pre>
1139
1140
1141
1142 <!-- ======================================================================= -->
1143 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
1144 <a name="otherops">Other Operations
1145 </b></font></td></tr></table><ul>
1146
1147 The instructions in this catagory are the "miscellaneous" functions, that defy better classification.<p>
1148
1149
1150 <!-- _______________________________________________________________________ -->
1151 </ul><a name="i_call"><h4><hr size=0>'<tt>call</tt>' Instruction</h4><ul>
1152
1153 <h5>Syntax:</h5>
1154 <pre>
1155
1156 </pre>
1157
1158 <h5>Overview:</h5>
1159
1160
1161 <h5>Arguments:</h5>
1162
1163
1164 <h5>Semantics:</h5>
1165
1166
1167 <h5>Example:</h5>
1168 <pre>
1169   %retval = call int %test(int %argc)
1170 </pre>
1171
1172
1173 <!-- _______________________________________________________________________ --></ul><a name="i_icall"><h3><hr size=0>'<tt>icall</tt>' Instruction</h3><ul>
1174
1175 Indirect calls are desperately needed to implement virtual function tables (C++, java) and function pointers (C, C++, ...).<p>
1176
1177 A new instruction <tt>icall</tt> or similar should be introduced to represent an indirect call.<p>
1178
1179 Example:
1180 <pre>
1181   %retval = icall int %funcptr(int %arg1)          <i>; yields {int}:%retval</i>
1182 </pre>
1183
1184
1185
1186 <!-- _______________________________________________________________________ -->
1187 </ul><a name="i_phi"><h4><hr size=0>'<tt>phi</tt>' Instruction</h4><ul>
1188
1189 <h5>Syntax:</h5>
1190 <pre>
1191 </pre>
1192
1193 <h5>Overview:</h5>
1194
1195
1196 <h5>Arguments:</h5>
1197
1198
1199 <h5>Semantics:</h5>
1200
1201
1202 <h5>Example:</h5>
1203 <pre>
1204 </pre>
1205
1206
1207 <!-- ======================================================================= -->
1208 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0><tr><td>&nbsp;</td><td width="100%">&nbsp; <font color="#EEEEFF" face="Georgia,Palatino"><b>
1209 <a name="builtinfunc">Builtin Functions
1210 </b></font></td></tr></table><ul>
1211
1212 <b>Notice:</b> Preliminary idea!<p>
1213
1214 Builtin functions are very similar to normal functions, except they are defined by the implementation.  Invocations of these functions are very similar to method invocations, except that the syntax is a little less verbose.<p>
1215
1216 Builtin functions are useful to implement semi-high level ideas like a '<tt>min</tt>' or '<tt>max</tt>' operation that can have important properties when doing program analysis.  For example:
1217
1218 <ul>
1219 <li>Some optimizations can make use of identities defined over the functions, 
1220     for example a parrallelizing compiler could make use of '<tt>min</tt>' 
1221     identities to parrellelize a loop.
1222 <li>Builtin functions would have polymorphic types, where normal method calls
1223     may only have a single type.
1224 <li>Builtin functions would be known to not have side effects, simplifying 
1225     analysis over straight method calls.
1226 <li>The syntax of the builtin are cleaner than the syntax of the 
1227     '<a href="#i_call"><tt>call</tt></a>' instruction (very minor point).
1228 </ul>
1229
1230 Because these invocations are explicit in the representation, the runtime can choose to implement these builtin functions any way that they want, including:
1231
1232 <ul>
1233 <li>Inlining the code directly into the invocation
1234 <li>Implementing the functions in some sort of Runtime class, convert invocation
1235     to a standard method call.
1236 <li>Implementing the functions in some sort of Runtime class, and perform 
1237     standard inlining optimizations on it.
1238 </ul>
1239
1240 Note that these builtins do not use quoted identifiers: the name of the builtin effectively becomes an identifier in the language.<p>
1241
1242 Example:
1243 <pre>
1244   ; Example of a normal method call
1245   %maximum = call int %maximum(int %arg1, int %arg2)   <i>; yields {int}:%maximum</i>
1246
1247   ; Examples of potential builtin functions
1248   %max = max(int %arg1, int %arg2)                     <i>; yields {int}:%max</i>
1249   %min = min(int %arg1, int %arg2)                     <i>; yields {int}:%min</i>
1250   %sin = sin(double %arg)                              <i>; yields {double}:%sin</i>
1251   %cos = cos(double %arg)                              <i>; yields {double}:%cos</i>
1252
1253   ; Show that builtin's are polymorphic, like instructions
1254   %max = max(float %arg1, float %arg2)                 <i>; yields {float}:%max</i>
1255   %cos = cos(float %arg)                               <i>; yields {float}:%cos</i>
1256 </pre>
1257
1258 The '<tt>maximum</tt>' vs '<tt>max</tt>' example illustrates the difference in calling semantics between a '<a href="#i_call"><tt>call</tt></a>' instruction and a builtin function invocation.  Notice that the '<tt>maximum</tt>' example assumes that the method is defined local to the caller.<p>
1259
1260
1261
1262
1263 <!-- *********************************************************************** -->
1264 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
1265 <a name="todo">TODO List
1266 </b></font></td></tr></table><ul>
1267 <!-- *********************************************************************** -->
1268
1269 This list of random topics includes things that will <b>need</b> to be addressed before the llvm may be used to implement a java like langauge.  Right now, it is pretty much useless for any language, given to unavailable of structure types<p>
1270
1271 <!-- _______________________________________________________________________ -->
1272 </ul><a name="synchronization"><h3><hr size=0>Synchronization Instructions</h3><ul>
1273
1274 We will need some type of synchronization instructions to be able to implement stuff in Java well.  The way I currently envision doing this is to introduce a '<tt>lock</tt>' type, and then add two (builtin or instructions) operations to lock and unlock the lock.<p>
1275
1276
1277 <!-- *********************************************************************** -->
1278 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
1279 <a name="extensions">Possible Extensions
1280 </b></font></td></tr></table><ul>
1281 <!-- *********************************************************************** -->
1282
1283 These extensions are distinct from the TODO list, as they are mostly "interesting" ideas that could be implemented in the future by someone so motivated.  They are not directly required to get <a href="#rw_java">Java</a> like languages working.<p>
1284
1285 <!-- _______________________________________________________________________ -->
1286 </ul><a name="i_tailcall"><h3><hr size=0>'<tt>tailcall</tt>' Instruction</h3><ul>
1287
1288 This could be useful.  Who knows.  '.net' does it, but is the optimization really worth the extra hassle?  Using strong typing would make this trivial to implement and a runtime could always callback to using downconverting this to a normal '<a href="#i_call"><tt>call</tt></a>' instruction.<p>
1289
1290
1291 <!-- _______________________________________________________________________ -->
1292 </ul><a name="globalvars"><h3><hr size=0>Global Variables</h3><ul>
1293
1294 In order to represent programs written in languages like C, we need to be able to support variables at the module (global) scope.  Perhaps they should be written outside of the module definition even.  Maybe global functions should be handled like this as well.<p>
1295
1296
1297 <!-- _______________________________________________________________________ -->
1298 </ul><a name="explicitparrellelism"><h3><hr size=0>Explicit Parrellelism</h3><ul>
1299
1300 With the rise of massively parrellel architectures (like <a href="#rw_ia64">the IA64 architecture</a>, multithreaded CPU cores, and SIMD data sets) it is becoming increasingly more important to extract all of the ILP from a code stream possible.  It would be interesting to research encoding methods that can explicitly represent this.  One straightforward way to do this would be to introduce a "stop" instruction that is equilivent to the IA64 stop bit.<p>
1301
1302
1303
1304 <!-- *********************************************************************** -->
1305 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0><tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
1306 <a name="related">Related Work
1307 </b></font></td></tr></table><ul>
1308 <!-- *********************************************************************** -->
1309
1310
1311 Codesigned virtual machines.<p>
1312
1313 <dl>
1314 <a name="rw_safetsa">
1315 <dt>SafeTSA
1316 <DD>Description here<p>
1317
1318 <a name="rw_java">
1319 <dt><a href="http://www.javasoft.com">Java</a>
1320 <DD>Desciption here<p>
1321
1322 <a name="rw_net">
1323 <dt><a href="http://www.microsoft.com/net">Microsoft .net</a>
1324 <DD>Desciption here<p>
1325
1326 <a name="rw_gccrtl">
1327 <dt><a href="http://www.math.umn.edu/systems_guide/gcc-2.95.1/gcc_15.html">GNU RTL Intermediate Representation</a>
1328 <DD>Desciption here<p>
1329
1330 <a name="rw_ia64">
1331 <dt><a href="http://developer.intel.com/design/ia-64/index.htm">IA64 Architecture &amp; Instruction Set</a>
1332 <DD>Desciption here<p>
1333
1334 <a name="rw_mmix">
1335 <dt><a href="http://www-cs-faculty.stanford.edu/~knuth/mmix-news.html">MMIX Instruction Set</a>
1336 <DD>Desciption here<p>
1337
1338 <a name="rw_stroustrup">
1339 <dt><a href="http://www.research.att.com/~bs/devXinterview.html">"Interview With Bjarne Stroustrup"</a>
1340 <DD>This interview influenced the design and thought process behind LLVM in several ways, most notably the way that derived types are written in text format. See the question that starts with "you defined the C declarator syntax as an experiment that failed".<p>
1341 </dl>
1342
1343 <!-- _______________________________________________________________________ -->
1344 </ul><a name="rw_vectorization"><h3><hr size=0>Vectorized Architectures</h3><ul>
1345
1346 <dl>
1347 <a name="rw_intel_simd">
1348 <dt>Intel MMX, MMX2, SSE, SSE2
1349 <DD>Description here<p>
1350
1351 <a name="rw_amd_simd">
1352 <dt><a href="http://www.nondot.org/~sabre/os/H1ChipFeatures/3DNow!TechnologyManual.pdf">AMD 3Dnow!, 3Dnow! 2</a>
1353 <DD>Desciption here<p>
1354
1355 <a name="rw_sun_simd">
1356 <dt><a href="http://www.nondot.org/~sabre/os/H1ChipFeatures/VISInstructionSetUsersManual.pdf">Sun VIS ISA</a>
1357 <DD>Desciption here<p>
1358
1359
1360 </dl>
1361
1362 more...
1363
1364 <!-- *********************************************************************** -->
1365 </ul>
1366 <!-- *********************************************************************** -->
1367
1368
1369 <hr>
1370 <font size=-1>
1371 <address><a href="mailto:sabre@nondot.org">Chris Lattner</a></address>
1372 <!-- Created: Tue Jan 23 15:19:28 CST 2001 -->
1373 <!-- hhmts start -->
1374 Last modified: Mon Jun 11 09:30:45 CDT 2001
1375 <!-- hhmts end -->
1376 </font>
1377 </body></html>