Inline the fastpath of PATypeHolder::get(). This is a small speedup in
[oota-llvm.git] / docs / WritingAnLLVMBackend.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <title>Writing an LLVM backend</title>
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7 </head>
8
9 <body>
10
11 <div class="doc_title">
12   Writing an LLVM backend
13 </div>
14
15 <ol>
16   <li><a href="#intro">Introduction</a>
17   <li><a href="#backends">Writing a backend</a>
18   <ol>
19     <li><a href="#machine">Machine backends</a>
20     <ol>
21       <li><a href="#machineTOC">Outline</a></li>
22       <li><a href="#machineDetails">Implementation details</a></li>
23     </ol></li>  
24     <li><a href="#lang">Language backends</a></li>
25   </ol></li>
26   <li><a href="#related">Related reading material</a>
27 </ol>
28
29 <div class="doc_author">    
30   <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a></p>
31 </div>
32
33 <!-- *********************************************************************** -->
34 <div class="doc_section">
35   <a name="intro">Introduction</a>
36 </div>
37 <!-- *********************************************************************** -->
38
39 <div class="doc_text">
40
41 <p>This document describes techniques for writing backends for LLVM which
42 convert the LLVM representation to machine assembly code or other languages.</p>
43
44 </div>
45
46 <!-- *********************************************************************** -->
47 <div class="doc_section">
48   <a name="backends">Writing a backend</a>
49 </div>
50 <!-- *********************************************************************** -->
51
52 <!-- ======================================================================= -->
53 <div class="doc_subsection">
54   <a name="machine">Machine backends</a>
55 </div>
56     
57 <!-- _______________________________________________________________________ -->
58 <div class="doc_subsubsection">
59   <a name="machineTOC">Outline</a>
60 </div>
61
62 <div class="doc_text">
63
64 <p>In general, you want to follow the format of SPARC, X86 or PowerPC (in
65 <tt>lib/Target</tt>).  SPARC is the simplest backend, and is RISC, so if
66 you're working on a RISC target, it is a good one to start with.</p>
67
68 <p>To create a static compiler (one that emits text assembly), you need to
69 implement the following:</p>
70
71 <ul>
72 <li>Describe the register set.
73   <ul>
74   <li>Create a <a href="TableGenFundamentals.html">TableGen</a> description of
75       the register set and register classes</li>
76   <li>Implement a subclass of <tt><a
77       href="CodeGenerator.html#targetregisterinfo">TargetRegisterInfo</a></tt></li>
78   </ul></li>
79 <li>Describe the instruction set.
80   <ul>
81   <li>Create a <a href="TableGenFundamentals.html">TableGen</a> description of
82       the instruction set</li>
83   <li>Implement a subclass of <tt><a
84       href="CodeGenerator.html#targetinstrinfo">TargetInstrInfo</a></tt></li>
85   </ul></li>
86 <li>Describe the target machine.
87   <ul>
88   <li>Create a <a href="TableGenFundamentals.html">TableGen</a> description of
89       the target that describes the pointer size and references the instruction
90       set</li>
91   <li>Implement a subclass of <tt><a
92       href="CodeGenerator.html#targetmachine">TargetMachine</a></tt>, which
93       configures <tt><a href="CodeGenerator.html#targetdata">TargetData</a></tt>
94       correctly</li>
95   <li>Register your new target using the <tt>RegisterTarget</tt>
96   template:<br><br>
97 <div class="doc_code"><pre>
98 RegisterTarget&lt;<em>MyTargetMachine</em>&gt; M("short_name", "  Target name");
99 </pre></div>
100       <br>Here, <em>MyTargetMachine</em> is the name of your implemented
101       subclass of <tt><a
102       href="CodeGenerator.html#targetmachine">TargetMachine</a></tt>,
103       <em>short_name</em> is the option that will be active following
104       <tt>-march=</tt> to select a target in llc and lli, and the last string
105       is the description of your target to appear in <tt>-help</tt>
106       listing.</li>
107   </ul></li>
108 <li>Implement the assembly printer for the architecture.
109   <ul>
110   <li>Define all of the assembly strings for your target, adding them to the
111       instructions in your *InstrInfo.td file.</li>
112   <li>Implement the <tt>llvm::AsmPrinter</tt> interface.</li>
113   </ul>
114 </li>
115 <li>Implement an instruction selector for the architecture.
116   <ul>
117   <li>The recommended method is the <a href="CodeGenerator.html#instselect">
118       pattern-matching DAG-to-DAG instruction selector</a> (for example, see
119       the PowerPC backend in PPCISelDAGtoDAG.cpp).  Parts of instruction
120       selector creation can be performed by adding patterns to the instructions
121       in your <tt>.td</tt> file.</li>
122   </ul>
123 </li>
124 <li>Optionally, add subtarget support.
125 <ul>
126   <li>If your target has multiple subtargets (e.g. variants with different
127       capabilities), implement the <tt>llvm::TargetSubtarget</tt> interface
128       for your architecture.  This allows you to add <tt>-mcpu=</tt> and 
129       <tt>-mattr=</tt> options.</li>
130 </ul>
131 <li>Optionally, add JIT support.
132   <ul>
133   <li>Create a subclass of <tt><a
134       href="CodeGenerator.html#targetjitinfo">TargetJITInfo</a></tt></li>
135   <li>Create a machine code emitter that will be used to emit binary code
136       directly into memory, given <tt>MachineInstr</tt>s</li>
137   </ul>
138 </ul>
139 </div>
140
141 <!-- _______________________________________________________________________ -->
142 <div class="doc_subsubsection">
143   <a name="machineDetails">Implementation details</a>
144 </div>
145
146 <div class="doc_text">
147
148 <ul>
149
150 <li><p><b>TableGen register info description</b> - describe a class which
151 will store the register's number in the binary encoding of the instruction
152 (e.g., for JIT purposes).</p>
153
154 <p>You also need to define register classes to contain these registers, such as
155 the integer register class and floating-point register class, so that you can
156 allocate virtual registers to instructions from these sets, and let the
157 target-independent register allocator automatically choose the actual
158 architected registers.</p>
159
160 <div class="doc_code">
161 <pre>
162 // class Register is defined in Target.td
163 <b>class</b> <em>Target</em>Reg&lt;string name&gt; : Register&lt;name&gt; {
164   <b>let</b> Namespace = "<em>Target</em>";
165 }
166
167 <b>class</b> IntReg&lt;<b>bits</b>&lt;5&gt; num, string name&gt; : <em>Target</em>Reg&lt;name&gt; {
168   <b>field</b> <b>bits</b>&lt;5&gt; Num = num;
169 }
170
171 <b>def</b> R0 : IntReg&lt;0, "%R0"&gt;;
172 ...
173
174 // class RegisterClass is defined in Target.td
175 <b>def</b> IReg : RegisterClass&lt;i64, 64, [R0, ... ]&gt;;
176 </pre>
177 </div>
178 </li>
179
180 <li><p><b>TableGen instruction info description</b> - break up instructions into
181 classes, usually that's already done by the manufacturer (see instruction
182 manual).  Define a class for each instruction category.  Define each opcode as a
183 subclass of the category, with appropriate parameters such as the fixed binary
184 encoding of opcodes and extended opcodes, and map the register bits to the bits
185 of the instruction which they are encoded in (for the JIT).  Also specify how
186 the instruction should be printed so it can use the automatic assembly printer,
187 e.g.:</p>
188
189 <div class="doc_code">
190 <pre>
191 // class Instruction is defined in Target.td
192 <b>class</b> Form&lt;<b>bits</b>&lt;6&gt; opcode, <b>dag</b> OL, <b>string</b> asmstr&gt; : Instruction {
193   <b>field</b> <b>bits</b>&lt;42&gt; Inst;
194
195   <b>let</b> Namespace = "<em>Target</em>";
196   <b>let</b> Inst{0-6} = opcode;
197   <b>let</b> OperandList = OL;
198   <b>let</b> AsmString = asmstr;
199 }
200
201 <b>def</b> ADD : Form&lt;42, (ops IReg:$rD, IReg:$rA, IReg:$rB), "add $rD, $rA, $rB"&gt;;
202 </pre>
203 </div>
204 </li>
205
206 </ul>
207
208 </div>
209
210 <!-- ======================================================================= -->
211 <div class="doc_subsection">
212   <a name="lang">Language backends</a>
213 </div>
214
215 <div class="doc_text">
216
217 <p>For now, just take a look at <tt>lib/Target/CBackend</tt> for an example of
218 how the C backend is written.</p>
219
220 </div>
221
222 <!-- *********************************************************************** -->
223 <div class="doc_section">
224   <a name="related">Related reading material</a>
225 </div>
226 <!-- *********************************************************************** -->
227
228 <div class="doc_text">
229
230 <ul>
231 <li><a href="CodeGenerator.html">Code generator</a> -
232     describes some of the classes in code generation at a high level, but
233     it is not (yet) complete</li>
234 <li><a href="TableGenFundamentals.html">TableGen fundamentals</a> -
235     describes how to use TableGen to describe your target information
236     succinctly</li>
237 <li><a href="HowToSubmitABug.html#codegen">Debugging code generation with
238     bugpoint</a> - shows bugpoint usage scenarios to simplify backend
239     development</li>
240 </ul>
241
242 </div>
243
244 <!-- *********************************************************************** -->
245
246 <hr>
247 <address>
248   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
249   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
250   <a href="http://validator.w3.org/check/referer"><img
251   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
252
253   <a href="http://misha.brukman.net">Misha Brukman</a><br>
254   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a>
255   <br>
256   Last modified: $Date$
257 </address>
258
259 </body>
260 </html>