Improve the style of B3 documentation
[WebKit-https.git] / Websites / webkit.org / docs / b3 / intermediate-representation.html
1 <html>
2 <head>
3   <title>B3 Intermediate Representation</title>
4   <link rel="stylesheet" type="text/css" href="style.css">
5 </head>
6 <body>
7   <div id="banner">
8     <a href="http://www.webkit.org/" class="banner-link">
9       <div id="logo" class="site-logo">
10         WebKit
11         <span class="tagline">Open Source Web Browser</span>
12       </div>
13     </a>
14   </div>
15   <div id="contents">
16     <h1><a href="index.html">Bare Bones Backend</a> / B3 Intermediate Representation</h1>
17     <p>B3 IR is a C-like SSA representation of a procedure.  A procedure has a root block at
18       which it starts execution when it is invoked.  A procedure does not have to terminate, but
19       if it does, then it can be either due to a Return, which gracefully returns some value, or
20       by a side-exit at designated instructions.  B3 gives the client a lot of flexibility to
21       implement many different kinds of side-exits.</p>
22     
23     <p>B3 is designed to represent procedures for the purpose of transforming them.  Knowing
24       what transformations are legal requires knowing what a procedure does.  A transformation
25       is valid if it does not change the observable behavior of a procedure.  This document
26       tells you what B3 procedures do by telling you what each construct in B3 IR does.</p>
27     
28     <h2>Procedure</h2>
29
30     <p>The parent object of all things in B3 is the Procedure.  Every time you want to compile
31       something, you start by creating a Procedure.  The lifecycle of a Procedure is
32       usually:</p>
33
34     <ol>
35       <li>Create the Procedure.</li>
36       <li>Populate the Procedure with code.</li>
37       <li>Use either the <a href="http://trac.webkit.org/browser/trunk/Source/JavaScriptCore/b3/B3Compilation.h">high-level
38           Compilation API</a> or the
39         <a href="http://trac.webkit.org/browser/trunk/Source/JavaScriptCore/b3/B3Generate.h">low-level
40           generation API</a>.</li>
41     </ol>
42
43     <p>The act of compiling the Procedure changes it in-place, making it unsuitable for
44       compiling again.  Always create a new Procedure every time you want to compile
45       something.</p>
46
47     <h2>Types</h2>
48
49     <p>B3 has a trivial type system with only five types:</p>
50
51     <dl>
52       <dt>Void</dt>
53       <dd>Used to say that an instruction does not return a value.</dd>
54
55       <dt>Int32</dt>
56       <dd>32-bit integer.  Integers don't have sign, but operations on them do.</dd>
57
58       <dt>Int64</dt>
59       <dd>64-bit integer.</dd>
60
61       <dt>Float</dt>
62       <dd>32-bit binary floating point number.</dd>
63
64       <dt>Double</dt>
65       <dd>64-bit binary floating point number.</dd>
66     </dl>
67
68     <h2>Values</h2>
69
70     <p>Variables, and the instructions that define them, are represented using the Value object.
71       The Value object has a return type, an opcode, and zero or more children.  Children are
72       references to other Values.  Those values are used as input to the instruction that
73       computes this value.</p>
74     <p>Values also have a unique 32-bit index that is used as the name.</p>
75     
76     <p>Example:</p>
77
78     <pre><code>Int32 @3 = Add(@1, @2)</code></pre>
79
80     <p>This represents a single Value instance.  Its index is 3.  It is an Int32.  The opcode is
81       Add, and its children are @1 and @2.</p>
82
83     <p>Values may also have additional meta-data.  We use special subclasses of the B3::Value
84       class for values that need meta-data.  For example, the Load value needs a 32-bit offset
85       for the load.  We use the MemoryValue class for memory-accessing values, which all have
86       such an offset.</p>
87
88     <h2>Stack Slot</h2>
89
90     <p>B3 exposes the concept of stack-allocated data and gives the client a lot of control.
91       You can force stack slots to end up at a particular offset from the frame pointer, though
92       this is very dangerous.  After compilation is done, you can get the selected frame pointer
93       offset from any stack slot.  Usually, you let B3 select where stack slots go, and then use
94       the StackSlot API to get its FP offset after compilation.</p>
95
96     <p>Stack slots are also used for creating non-SSA variables with the intention of having B3
97       convert them into SSA.  There are two kinds of stack lots.</p>
98
99     <dl>
100       <dt>Anonymous</dt>
101       <dd>Anonymous stack slots are used to represent local variables that aren't in SSA form.
102         B3 is allowed to assume that nobody will store to an anonymous stack slot except through
103         Store instructions in the B3 procedure.  B3 is allowed to assume that a Store that does
104         not write to the entire anonymous stack slot leaves the unwritten part in an undefined
105         state.  Usually, anonymous stack slots are allocated to have the same size as the type
106         of variable they are being used to represent.</dd>
107
108       <dt>Locked</dt>
109       <dd>These stack slots are assumed to operate "as if" they were in the heap, in the sense
110         that the may get read or written using operations not visible in B3 IR.</dd>
111     </dl>
112
113     <p>The fixSSA() phase will convert anonymous stack slots to SSA.</p>
114
115     <h2>Control flow</h2>
116
117     <p>B3 represents control flow using basic blocks.  Each basic block may have zero or more
118       predecessors.  Each basic block may have zero or more successors.  The successors are
119       controlled by the basic block's last Value, which must be a ControlValue instance.</p>
120
121     <p>Each basic block contains a Vector&lt;Value*&gt; as the contents of the block.</p>
122
123     <h2>Opcodes</h2>
124
125     <p>This section describes opcodes in the following format:</p>
126
127     <dl>
128       <dt>Int32 Foo(Int64, Double)</dt>
129       <dd>This describes an opcode named Foo that uses Int32 as its return type and takes two
130         children - one of type Int64 and another of type Double.</dd>
131     </dl>
132
133     <p>We sometimes use the wildcard type T to represent polymorphic operations, like "T Add(T,
134       T)".  This means that the value must take two children of the same type and returns a
135       value of that type.  We use the type IntPtr to mean either Int32, or Int64, depending on
136       the platform.</p>
137
138     <h3>Opcode descriptions</h3>
139
140     <dl>
141       <dt>Void Nop()</dt>
142       <dd>The empty value.  Instead of removing Values from basic blocks, most optimizations
143         convert them to Nops.  Various phases run fix-up where all Nops are removed in one pass.
144         It's common to see Nops in intermediate versions of B3 IR during optimizations.  Nops
145         never lead to any code being generated and they do not impede optimizations, so they are
146         usually harmless.  You can convert a Value to a Nop by doing convertToNop().</dd>
147
148       <dt>T Identity(T)</dt>
149       <dd>Returns the passed value.  May be used for any type except Void.  Instead of replacing
150         all uses of a Value with a different Value, most optimizations convert them to Identity.
151         Various phases run fix-up where all uses of Identity are replaced with the Identity's
152         child (transitively, so Identity(Identity(Identity(@x))) is changed to just @x).  Even
153         the instruction selector "sees through" Identity.  You can remove all references to
154         Identity in any value by calling Value::performSubstitution().  You can convert a Value
155         to an Identity by doing convertToIdentity(otherValue).  If the value is Void,
156         convertToIdentity() converts it to a Nop instead.</dd>
157
158       <dt>Int32 Const32(constant)</dt>
159       <dd>32-bit integer constant.  Must use the Const32Value class, which has space for the
160         int32_t constant.</dd>
161
162       <dt>Int64 Const64(constant)</dt>
163       <dd>64-bit integer constant.  Must use the Const64Value class, which has space for the
164         int64_t constant.</dd>
165
166       <dt>Float ConstFloat(constant)</dt>
167       <dd>Float constant.  Must use the ConstFloatValue class, which has space for the float constant.</dd>
168
169       <dt>Double ConstDouble(constant)</dt>
170       <dd>Double constant.  Must use the ConstDoubleValue class, which has space for the double constant.</dd>
171
172       <dt>IntPtr SlotBase(stackSlot)</dt>
173       <dd>Returns a pointer to the base of the given stack slot.  Must use the SlotBaseValue
174         class.</dd>
175
176       <dt>IntPtr|Double ArgumentReg(%register)</dt>
177       <dd>Returns the value that the given register had at the prologue of the procedure.  It
178         returns IntPtr for general-purpose registers and Double for FPRs.  Must use the
179         ArgumentRegValue class.</dd>
180
181       <dt>IntPtr FramePointer()</dt>
182       <dd>Returns the value of the frame pointer register.  B3 procedures alway use a frame
183         pointer ABI, and the frame pointer is always guaranteed to have this value anywhere
184         inside the procedure.</dd>
185
186       <dt>T Add(T, T)</dt>
187       <dd>Works with any type except Void.  For integer types, this represents addition with
188         wrap-around semantics.  For floating point types, this represents addition according to
189         the IEEE 854 spec.  B3 does not have any notion of "fast math".  A transformation over
190         floating point code is valid if the new code produces exactly the same value, bit for
191         bit.</dd>
192
193       <dt>T Sub(T, T)</dt>
194       <dd>Works with any type except Void.  For integer types, this represents subtraction with
195         wrap-around semantics.  For floating point types, this represents subtraction according
196         to the IEEE 854 spec.</dd>
197
198       <dt>T Mul(T, T)</dt>
199       <dd>Works with any type except Void.  For integer types, this represents multiplication
200         with wrap-around semantics.  For floating point types, this represents multiplication
201         according to the IEEE 854 spec.</dd>
202
203       <dt>T Div(T, T)</dt>
204       <dd>Works with any type except Void.  For integer types, this represents signed division
205         with round-to-zero.  Its behavior is undefined for x/0 or -2<sup>31</sup>/-1.  For floating
206         point types, this represents division according to the IEEE 854 spec.</dd>
207
208       <dt>T Mod(T, T)</dt>
209       <dd>Works with any type except Void.  For integer types, this represents signed modulo.
210         Its behavior is undefined for x%0 or -2<sup>31</sup>%-1.  For floating point types, this
211         represents modulo according to "fmod()".</dd>
212
213       <dt>T Neg(T)</dt>
214       <dd>Works with any type except Void.  For integer types, this represents twos-complement
215         negation.  For floating point types, this represents negation according to the IEEE
216         spec.</dd>
217
218       <dt>T ChillDiv(T, T)</dt>
219       <dd>Chill division.  Valid for Int32 and Int64.  An operation is said to be chill if it
220         returns a sensible value whenever its non-chill form would have had undefined behavior.
221         ChillDiv turns x/0 into 0 and -2<sup>31</sup>/-1 into -2<sup>31</sup>.  This is a separate opcode
222         because it's exactly the semantics of division on ARM64, and it's also exactly the
223         semantics that JavaScript wants for "(x/y)|0".</dd>
224
225       <dt>T ChillMod(T, T)</dt>
226       <dd>Chill modulo.  Valid for Int32 and Int64.  ChllMod turns x%0 into 0 and
227         -2<sup>31</sup>%-1 into 0.</dd>
228
229       <dt>T BitAnd(T, T)</dt>
230       <dd>Bitwise and.  Valid for Int32 and Int64.</dd>
231
232       <dt>T BitOr(T, T)</dt>
233       <dd>Bitwise or.  Valid for Int32 and Int64.</dd>
234
235       <dt>T BitXor(T, T)</dt>
236       <dd>Bitwise xor.  Valid for Int32 and Int64.</dd>
237
238       <dt>T Shl(T, Int32)</dt>
239       <dd>Shift left.  Valid for Int32 and Int64.  The shift amount is always Int32.  Only the
240         low 31 bits of the shift amount are used for Int32.  Only the low 63 bits of the shift
241         amount are used for Int64.</dd>
242
243       <dt>T SShr(T, Int32)</dt>
244       <dd>Shift right with sign extension.  Valid for Int32 and Int64.  The shift amount is
245         always Int32.  Only the low 31 bits of the shift amount are used for Int32.  Only the
246         low 63 bits of the shift amount are used for Int64.</dd>
247
248       <dt>T ZShr(T, Int32)</dt>
249       <dd>Shift right with zero extension.  Valid for Int32 and Int64.  The shift amount is
250         always Int32.  Only the low 31 bits of the shift amount are used for Int32.  Only the
251         low 63 bits of the shift amount are used for Int64.</dd>
252
253       <dt>T Clz(T)</dt>
254       <dd>Count leading zeroes.  Valid for Int32 and Int64.</dd>
255
256       <dt>T Abs(T)</dt>
257       <dd>Absolute value.  Valid for Float and Double.</dd>
258
259       <dt>T Ceil(T)</dt>
260       <dd>Ceiling.  Valid for Float and Double.</dd>
261
262       <dt>T Sqrt(T)</dt>
263       <dd>Square root.  Valid for Float and Double.</dd>
264
265       <dt>U BitwiseCast(T)</dt>
266       <dd>If T is Int32 or Int64, it returns the bitwise-corresponding Float or Double,
267         respectively.  If T is Float or Double, it returns the bitwise-corresponding Int32 or
268         Int64, respectively.</dd>
269
270       <dt>Int32 SExt8(Int32)</dt>
271       <dd>Fills the top 24 bits of the integer with the low byte's sign extension.</dd>
272
273       <dt>Int32 SExt16(Int32)</dt>
274       <dd>Fills the top 16 bits of the integer with the low short's sign extension.</dd>
275
276       <dt>Int64 SExt32(Int32)</dt>
277       <dd>Returns a 64-bit integer such that the low 32 bits are the given Int32 value and the
278         high 32 bits are its sign extension.</dd>
279
280       <dt>Int64 ZExt32(Int32)</dt>
281       <dd>Returns a 64-bit integer such that the low 32 bits are the given Int32 value and the
282         high 32 bits are zero.</dd>
283
284       <dt>Int32 Trunc(Int64)</dt>
285       <dd>Returns the low 32 bits of the 64-bit value.</dd>
286
287       <dt>Double IToD(T)</dt>
288       <dd>Converts the given integer into a double.  Value for Int32 or Int64 inputs.</dd>
289
290       <dt>Double FloatToDouble(Float)</dt>
291       <dd>Converts the given float into a double.</dd>
292
293       <dt>Float DoubleToFloat(Double)</dt>
294       <dd>Converts the given double into a float.</dd>
295
296       <dt>Int32 Equal(T, T)</dt>
297       <dd>Compares the two values.  If they are equal, return 1; else return 0.  Valid for all
298         types except Void.  Integer comparisons simply compare all bits.  Floating point
299         comparisons mostly compare bits, but have some corner cases: positive zero and negative
300         zero are considered equal, and they return false when either value is NaN.</dd>
301
302       <dt>Int32 NotEqual(T, T)</dt>
303       <dd>The opposite of Equal().  NotEqual(@x, @y) yields the same result as BitXor(Equal(@x,
304         @y), 1).</dd>
305
306       <dt>Int32 LessThan(T, T)</dt>
307       <dd>Returns 1 if the left value is less than the right one, 0 otherwise.  Does a signed
308         comparison for integers.  For floating point comparisons, this has the usual caveats
309         with respect to negative zero and NaN.</dd>
310
311       <dt>Int32 GreaterThan(T, T)</dt>
312       <dd>Returns 1 if the left value is greater than the right one, 0 otherwise.  Does a signed
313         comparison for integers.  For floating point comparisons, this has the usual caveats
314         with respect to negative zero and NaN.</dd>
315
316       <dt>Int32 LessEqual(T, T)</dt>
317       <dd>Returns 1 if the left value is less than or equal to the right one, 0 otherwise.  Does
318         a signed comparison for integers.  For floating point comparisons, this has the usual
319         caveats with respect to negative zero and NaN.</dd>
320
321       <dt>Int32 GreaterEqual(T, T)</dt>
322       <dd>Returns 1 if the left value is greater than or equal to the right one, 0 otherwise.
323         Does a signed comparison for integers.  For floating point comparisons, this has the
324         usual caveats with respect to negative zero and NaN.</dd>
325
326       <dt>Int32 Above(T, T)</dt>
327       <dd>Unsigned integer comparison, valid for Int32 and Int64 only.  Returns 1 if the left
328         value is unsigned-greater-than the right one, 0 otherwise.</dd>
329
330       <dt>Int32 Below(T, T)</dt>
331       <dd>Unsigned integer comparison, valid for Int32 and Int64 only.  Returns 1 if the left
332         value is unsigned-less-than the right one, 0 otherwise.</dd>
333
334       <dt>Int32 AboveEqual(T, T)</dt>
335       <dd>Unsigned integer comparison, valid for Int32 and Int64 only.  Returns 1 if the left
336         value is unsigned-greater-than-or-equal the right one, 0 otherwise.</dd>
337
338       <dt>Int32 BelowEqual(T, T)</dt>
339       <dd>Unsigned integer comparison, valid for Int32 and Int64 only.  Returns 1 if the left
340         value is unsigned-less-than-or-equal the right one, 0 otherwise.</dd>
341
342       <dt>Int32 EqualOrUnordered(T, T)</dt>
343       <dd>Floating point comparison, valid for Float and Double only.  Returns 1 if the left
344         value is equal to the right one or if either value is NaN.  Returns 0 otherwise.</dd>
345
346       <dt>T Select(U, T, T)</dt>
347       <dd>Returns either the second child or the third child.  T can be any type except Void.  U
348         can be either Int32 or Int64.  If the first child is non-zero, returns the second child.
349         Otherwise returns the third child.</dd>
350
351       <dt>Int32 Load8Z(IntPtr, offset)</dt>
352       <dd>Loads a byte from the address, which is computed by adding the compile-time 32-bit
353         signed integer offset to the child value.  Zero extends the loaded byte, so the high 24
354         bits are all zero.  Must use the MemoryValue class.</dd>
355
356       <dt>Int32 Load8S(IntPtr, offset)</dt>
357       <dd>Loads a byte from the address, which is computed by adding the compile-time 32-bit
358         signed integer offset to the child value.  Sign extends the loaded byte.  Must use the
359         MemoryValue class.</dd>
360
361       <dt>Int32 Load16Z(IntPtr, offset)</dt>
362       <dd>Loads a 16-bit integer from the address, which is computed by adding the compile-time
363         32-bit signed integer offset to the child value.  Zero extends the loaded 16-bit
364         integer, so the high 16 bits are all zero.  Misaligned loads are not penalized.  Must
365         use the MemoryValue class.</dd>
366
367       <dt>Int32 Load16S(IntPtr, offset)</dt>
368       <dd>Loads a 16-bit integer from the address, which is computed by adding the compile-time
369         32-bit signed integer offset to the child value.  Sign extends the loaded 16-bit
370         integer.  Misaligned loads are not penalized.  Must use the MemoryValue class.</dd>
371
372       <dt>T Load(IntPtr, offset)</dt>
373       <dd>Valid for any type except Void.  Loads a value of that type from the address, which is
374         computed by adding the compile-time 32-bit signed integer offset to the child value.
375         Misaligned loads are not penalized.  Must use the MemoryValue class.</dd>
376
377       <dt>Void Store8(Int32, IntPtr, offset)</dt>
378       <dd>Stores a the low byte of the first child into the address computed by adding the
379         compile-time 32-bit signed integer offset to the second child.  Must use the MemoryValue
380         class.</dd>
381
382       <dt>Void Store16(Int32, IntPtr, offset)</dt>
383       <dd>Stores a the low 16 bits of the first child into the address computed by adding the
384         compile-time 32-bit signed integer offset to the second child.  Misaligned stores are
385         not penalized.  Must use the MemoryValue class.</dd>
386
387       <dt>Void Store(T, IntPtr, offset)</dt>
388       <dd>Stores the value in the first child into the address computed by adding the
389         compile-time 32-bit signed integer offset to the second child.  Misaligned stores are
390         not penalized.  Must use the MemoryValue class.</dd>
391
392       <dt>T1 CCall(IntPtr, [T2, [T3, ...]])</dt>
393       <dd>Performs a C function call to the function pointed to by the first child.  The types
394         that the function takes and the type that it returns are determined by the types of the
395         children and the type of the CCallValue.  Only the first child is mandatory.  Must use
396         the CCallValue class.</dd>
397
398       <dt>T1 Patchpoint([T2, [T3, ...]])</dt>
399       <dd>A Patchpoint is a customizable value.  Patchpoints take zero or more values of any
400         type and return any type.  A Patchpoint's behavior is determined by the generator
401         object.  The generator is a C++ lambda that gets called during code generation.  It gets
402         passed an assembler instance (specifically, CCallHelpers&) and an object describing
403         where to find all of the input values and where to put the result.  Here's an example:
404  
405         <pre><code>PatchpointValue* patchpoint = block->appendNew&lt;PatchpointValue&gt;(proc, Int32, Origin());
406 patchpoint->append(ConstrainedValue(arg1, ValueRep::SomeRegister));
407 patchpoint->append(ConstrainedValue(arg2, ValueRep::SomeRegister));
408 patchpoint->setGenerator(
409     [&] (CCallHelpers& jit, const StackmapGenerationParams& params) {
410         jit.add32(params[1].gpr(), params[2].gpr(), params[0].gpr());
411     });</code></pre>
412  
413         <p>This creates a patchpoint that just adds two numbers. The patchpoint is set to return
414           Int32.  The two child values, arg1 and arg2, are passed to the patchpoint with the
415           SomeRegister constraint, which just requests that they get put in appropriate
416           registers (GPR for integer values, FPR for floating point values).  The generator uses
417           the params object to figure out which registers the inputs are in (params[1] and
418           params[2]) and which register to put the result in (params[0]).  Many sophisticated
419           constraints are possible.  You can request that a child gets placed in a specific
420           register.  You can list additional registers that are
421           clobbered - either at the top of the patchpoint (i.e. early) so that the clobbered
422           registers interfere with the inputs, or at the bottom of the patchpoint (i.e. late) so
423           that the clobbered registers interfere with the output.  Patchpoint constraints also
424           allow you to force values onto the call argument area of the stack.  Patchpoints are
425           powerful enough to implement custom calling conventions, inline caches, and
426           side-exits.</p>
427
428         <p>A patchpoint is allowed to "side exit", i.e. abruptly exit from the procedure.  If it
429           wants to do so by returning, it can use Procedure's API for getting the callee-save
430           register layout, unwinding the callee-saves, and then returning.  More likely, the
431           patchpoint will take some exit state as part of its arguments, and it will manipulate
432           the call frame in place to make it look like another execution engine's call frame.
433           This is called OSR, and JavaScriptCore does it a lot.</p>
434  
435         <p>Must use the PatchpointValue class with the Patchpoint opcode.</p>
436       </dd>
437
438       <dt>T CheckAdd(T, T, [T2, [T3, ...]])</dt>
439       <dd>Checked integer addition.  Works for T = Int32 or T = Int64.  First first two children
440         are mandatory.  Additional children are optional.  All of the Check instructions take a
441         generator and value constraints like a Patchpoint.  In the case of a CheckAdd, the
442         generator runs on the path where the integer addition overflowed.  B3 assumes that
443         CheckAdd will side-exit upon overflow, so the generator must do some kind of
444         termination.  Usually, this is used to implement OSR exits on integer overflow and the
445         optional arguments to CheckAdd will be the OSR exit state.  Must use the CheckValue
446         class.</dd>
447
448       <dt>T CheckSub(T, T, [T2, [T3, ...]])</dt>
449       <dd>Checked integer subtraction.  Works for T = Int32 or T = Int64.  First first two
450         children are mandatory.  Additional children are optional.  All of the Check
451         instructions take a generator and value constraints like a Patchpoint.  In the case of a
452         CheckSub, the generator runs on the path where the integer subtraction overflowed.  B3
453         assumes that CheckSub will side-exit upon overflow, so the generator must do some kind
454         of termination.  Usually, this is used to implement OSR exits on integer overflow and
455         the optional arguments to CheckSub will be the OSR exit state.  You can use CheckSub for
456         checked negation by using zero for the first child.  B3 will select the native negate
457         instruction when you do this.  Must use the CheckValue class.</dd>
458
459       <dt>T CheckMul(T, T, [T2, [T3, ...]])</dt>
460       <dd>Checked integer multiplication.  Works for T = Int32 or T = Int64.  First first two
461         children are mandatory.  Additional children are optional.  All of the Check
462         instructions take a generator and value constraints like a Patchpoint.  In the case of a
463         CheckMul, the generator runs on the path where the integer multiplication overflowed.
464         B3 assumes that CheckMul will side-exit upon overflow, so the generator must do some
465         kind of termination.  Usually, this is used to implement OSR exits on integer overflow
466         and the optional arguments to CheckMul will be the OSR exit state.  Must use the
467         CheckValue class.</dd>
468
469       <dt>Void Check(T, [T2, [T3, ...]])</dt>
470       <dd>Exit check.  Works for T = Int32 or T = Int64.  This branches on the first child.  If
471         the first child is zero, this just falls through.  If it's non-zero, it goes to the exit
472         path generated by the passed generator.  Only the first child is mandatory.  B3 assumes
473         that Check will side-exit when the first child is non-zero, so the generator must do
474         some kind of termination.  Usually, this is used to implement OSR exit checks and the
475         optional arguments to Check will be the OSR exit state.  Check supports efficient
476         compare/branch fusion, so you can Check for fairly sophisticated predicates.  For
477         example, Check(Equal(LessThan(@a, @b), 0)) where @a and @b are doubles will be generated
478         to an instruction that branches to the exit if @a &gt;= @b or if either @a or @b are
479         NaN.  Must use the CheckValue class.</dd>
480
481       <dt>Void Upsilon(T, ^phi)</dt>
482       <dd>B3 uses SSA.  SSA requires that each variable gets assigned to only once anywhere in
483         the procedure.  But that doesn't work if you have a variable that is supposed to be the
484         result of merging two values along control flow.  B3 uses Phi values to represent value
485         merges, just like SSA compilers usually do.  But while other SSA compilers represent the
486         inputs to the Phi by listing the control flow edges from which the Phi gets its values,
487         B3 uses the Upsilon value.  Each Phi behaves as if it has a memory location associated
488         with it.  Executing the Phi behaves like a load from that memory location.
489         Upsilon(@value, ^phi) behaves like a store of @value into the memory location associated
490         with @phi.  We say "^phi" when we mean that we are writing to the memory location
491         associated with the Phi.  Must use the UpsilonValue class.</dd>
492
493       <dt>T Phi()</dt>
494       <dd>Works for any type except Void.  Represents a local memory location large enough to
495         hold T.  Loads from that memory location.  The only way to store to that location is
496         with Upsilon.</dd>
497
498       <dt>Void Jump(takenBlock)</dt>
499       <dd>Jumps to takenBlock.  This is a ControlValue, so it must appear at the end of the
500         basic block.</dd>
501
502       <dt>Void Branch(T, takenBlock, notTakenBlock)</dt>
503       <dd>Works for T = Int32 or T = Int64.  Branches on the child.  If the child is non-zero,
504         it branches to the takenBlock.  Otherwise it branches to the notTakenBlock.  Must use
505         the ControlValue class.  Must appear at the end of the basic block.</dd>
506
507       <dt>Void Switch(T, cases...)</dt>
508       <dd>Works for T = Int32 or T = Int64.  Switches on the child.  Contains a list of switch
509         cases.  Each switch case has an integer constant and a target block.  The switch value
510         also contains a fall-through target in case the child has a value that wasn't mentioned
511         in the cases list.  Must use the SwitchValue class.  Must appear at the end of the basic
512         block.</dd>
513
514       <dt>Void Return(T)</dt>
515       <dd>Works for any type except Void.  Returns the given value and terminates the procedure.
516         This is a ControlValue, but it must have an empty successors list.  Must appear at the
517         end of the basic block.</dd>
518
519       <dt>Void Oops()</dt>
520       <dd>Indicates unreachable code.  This may be implemented as either a trap or as a bare
521         fall-through, since B3 is allowed to assume that this will never be reached.  This is a
522         ControlValue, but it must have an empty successors list.  Must appear at the end of the
523         basic block.  Note that we also use the Oops opcode to mean "no such opcode" in some B3
524         transformations.</dd>
525     </dl>
526
527   </div>
528 </body>
529 </html>
530