B3 should have documentation
[WebKit-https.git] / Websites / webkit.org / docs / b3 / index.html
1 <html>
2   <head>
3     <title>Bare Bones Backend</title>
4     <link rel="stylesheet" type="text/css" href="style.css">
5   </head>
6   <body>
7     <h1>Bare Bones Backend</h1>
8     <p>The Bare Bones Backend, or B3 for short, is WebKit's optimizing JIT for procedures
9       containing C-like code.  It's currently used as the default backend for the
10       <a href="https://trac.webkit.org/wiki/FTLJIT">FTL JIT</a> inside
11       <a href="https://trac.webkit.org/wiki/JavaScriptCore">JavaScriptCore</a>.</p>
12
13     <p>B3 comprises a <a href="intermediate-representation.html">C-like
14         SSA IR</a> known as "B3 IR", optimizations on B3 IR, an
15       <a href="assembly-intermediate-representation.html">assembly IR</a>
16       known as "Air", optimizations on Air, an instruction selector that turns B3 IR into Air,
17       and a code generator that assembles Air into machine code.</p>
18
19     <h2>Hello, World!</h2>
20
21     <p>Here's a simple example of C++ code that uses B3 to generate a function that adds two to
22       its argument and returns it:</p>
23
24     <pre><code>Procedure proc;
25 BasicBlock* root = proc.addBlock();
26 root->appendNew&lt;ControlValue&gt;(
27     proc, Return, Origin(),
28     root->appendNew&lt;Value&gt;(
29         proc, Add, Origin(),
30         root->appendNew<ArgumentRegValue>(proc, Origin(), GPRInfo::argumentGPR0),
31         root->appendNew<Const64Value>(proc, Origin(), 2)));
32
33 std::unique_ptr&lt;Compilation&gt; compilation = std::make_unique&lt;Compilation&gt;(vm, proc);
34 int64_t (*function)(int64_t) = static_cast&lt;int64_t (*)(int64_t)&gt;(compilation->code().executableAddress());
35
36 printf("%d\n", function(42)); // prints 44</code></pre>
37
38     <p>When compiled, the resulting machine code looks like this:</p>
39
40     <pre><code>0x3aa6eb801000: pushq %rbp
41 0x3aa6eb801001: movq %rsp, %rbp
42 0x3aa6eb801004: leaq 0x2(%rdi), %rax
43 0x3aa6eb801008: popq %rbp
44 0x3aa6eb801009: ret </code></pre>
45
46     <p>B3 always emits a frame pointer prologue/epilogue to play nice with debugging tools.
47       Besides that, you can see that B3 optimized the procedure's body to a single instruction:
48       in this case, a Load Effective Address to transfer %rdi + 2, where %rdi is the first
49       argument register, into %rax, which is the result register.</p>
50
51     <h2>B3 IR</h2>
52
53     <p>Clients of B3 usually interact with it using B3 IR.  It's C-like, in the sense that it
54       models heap references as integers and does not attempt to verify memory accesses.  It
55       enforces static single assignment, or SSA for short.  An SSA program will contain only one
56       assignment to each variable, which makes it trivial to trace from a use of a variable to
57       the operation that defined its value.  B3 IR is designed to be easy to generate and cheap
58       to manipulate.</p>
59
60     <p>B3 is designed to be used as a backend for JITs, rather than as a tool that programmers
61       use directly.  Therefore, B3 embraces platform-specific concepts like argument registers,
62       stack frame layout, the frame pointer, and the call argument areas.  It's possible to emit
63       B3 IR that defines completely novel calling conventions, both for callers of the procedure
64       being generated and for callees of the procedure's callsites.  B3 also makes it easy to
65       just emit a C call.  There's an opcode for that.</p>
66
67     <p>See <a href="/documentation/b3/intermediate-representation.html">the IR documentation</a>
68       for more info.</p>
69
70     <p>Here's an example of the IR from the example above:</p>
71
72     <pre><code>BB#0: ; frequency = 1.000000
73     Int64 @0 = ArgumentReg(%rdi)
74     Int64 @1 = Const64(2)
75     Int64 @2 = Add(@0, $2(@1))
76     Void @3 = Return(@2, Terminal)</code></pre>
77
78     <h2>B3 Optimizations</h2>
79
80     <p>B3 is fairly new - we only started working on it in late Oct 2015.  But it already has
81       some awesome optimizations:</p>
82     
83     <ul>
84       <li>CFG simplification.</li>
85       <li>Constant folding with some flow sensitivity.</li>
86       <li>Global CSE, including sophisticated load elimination.</li>
87       <li>Aggressive dead code elimination.</li>
88       <li>Tail duplication.</li>
89       <li>SSA fix-up</li>
90       <li>Optimal placement of constant materializations.</li>
91       <li>Integer overflow check elimination.</li>
92       <li>Reassociation.</li>
93       <li>Lots of miscellaneous strength reduction rules.</li>
94     </ul>
95
96     <h2>Air</h2>
97
98     <p>Air, or Assembly IR, is the way that B3 represents the machine instruction sequence prior
99       to code generation.  Air is like assembly, except that in addition to registers it has
100       temporaries, and in addition to the native address forms it has abstract ones like "stack"
101       (an abstract stack slot) and "callArg" (an abstract location in the outgoing call argument
102       area of the stack).</p>
103
104     <p>Here's the initial Air generated from the example above:</p>
105
106     <pre><code>BB#0: ; frequency = 1.000000
107     Move %rdi, %tmp1, @0
108     Move $2, %tmp2, $2(@1)
109     Add64 $2, %tmp1, %tmp0, @2
110     Move %tmp0, %rax, @3
111     Ret64 %rax, @3</code></pre>
112
113     <p>Note that the "@" references indicate the origin of the instruction in the B3 IR.</p>
114
115     <h2>Air Optimizations</h2>
116
117     <p>Air has sophisticated optimizations that transform programs that use temporaries and
118       abstract stack locations into ones that use registers directly.  Air is also responsible
119       for ABI-related issues like stack layout and handling the C calling convention.  Air has
120       the following optimizations:</p>
121
122     <ul>
123       <li><a href="https://www.cs.princeton.edu/research/techreps/TR-498-95">Iterated Register Coalescing</a>.  This is our register allocator.</li>
124       <li>Graph coloring stack allocation.</li>
125       <li>Spill code fix-up.</li>
126       <li>Dead code elimination.</li>
127       <li>Partial register stall fix-up.</li>
128       <li>CFG simplification.</li>
129       <li>CFG layout optimization.</li>
130     </ul>
131
132     <p>Here's what these optimizations do to the example program:</p>
133
134     <pre><code>BB#0: ; frequency = 1.000000
135     Add64 $2, %rdi, %rax, @2
136     Ret64 %rax, @3</code></pre>
137
138     <h2>B3->Air lowering, also known as Instruction Selection</h2>
139
140     <p>The B3::LowerToAir phase converts B3 into Air by doing pattern-matching.  It processes
141       programs backwards.  At each B3 value, it greedily tries to match both the value and as
142       many of its children (i.e. Values it uses) and their children as possible to create a
143       single instruction.  Different hardware targets support different instructions.  Air
144       allows B3 to speak of the superset of all instructions on all targets, but exposes a fast
145       query to check if a given instruction, or specific instruction form (like 3-operand add,
146       for example) is available.  The instruction selector simply cascades through the patterns
147       it knows about until it finds one that gives a legal instruction in Air.</p>
148
149     <p>The instruction selector is powerful enough to do basic things like compare-branch and
150       load-op-store fusion.  It's smart enough to do things like what we call the Mega Combo,
151       where the following B3 IR:</p>
152
153     <pre><code>Int64 @0 = ArgumentReg(%rdi)
154 Int64 @1 = ArgumentReg(%rsi)
155 Int32 @2 = Trunc(@1)
156 Int64 @3 = ZExt32(@2)
157 Int32 @4 = Const32(1)
158 Int64 @5 = Shl(@3, $1(@4))
159 Int64 @6 = Add(@0, @5)
160 Int32 @7 = Load8S(@6, ControlDependent|Reads:Top)
161 Int32 @8 = Const32(42)
162 Int32 @9 = LessThan(@7, $42(@8))
163 Void @10 = Check(@9:WarmAny, generator = 0x103fe1010, earlyClobbered = [], lateClobbered = [], usedRegisters = [], ExitsSideways|Reads:Top)</code></pre>
164
165     <p>Is turned into the following Air:</p>
166
167     <pre><code>Move %rsi, %tmp7, @1
168 Move %rdi, %tmp1, @0
169 Move32 %tmp7, %tmp2, @3
170 Patch &Branch8(3,SameAsRep), LessThan, (%tmp1,%tmp2,2), $42, @10</code></pre>
171
172     <p>And the resulting code ends up being:</p>
173
174     <pre><code>0x311001401004: movl %esi, %eax
175 0x311001401006: cmpb $0x2a, (%rdi,%rax,2)
176 0x31100140100a: jl 0x311001401015</code></pre>
177
178     <p>Other than the mandatory zero-extending operation to deal with the 32-bit argument being
179       used as an index, B3 is smart enough to convert the address computation, load, and compare
180       into a single instruction and then fuse that with the branch.</p>
181
182     <h2>Code generation</h2>
183
184     <p>The final form of Air contains no registers or abstract stack slots.  Therefore, it maps
185       directly to machine code.  The final code generation step is a very fast transformation
186       from Air's object-oriented way of representing those instructions to the target's machine
187       code.  We use JavaScriptCore's macro assembler for this purpose.</p>
188
189   </body>
190 </html>
191
192