Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / b2d03a6d003a9255655321b649117a010b8efe7f / . / llvm / docs / ExtendingLLVM.html
blob: ca8d3e990bd9a1d1cee3765b8d9d00879a2e6b05 [file] [log] [blame]
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
NAKAMURA Takumib8004d92011-10-31 11:21:59 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]6 <title>Extending LLVM: Adding instructions, intrinsics, types, etc.</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9
10<body>
11
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]12<h1>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]13 Extending LLVM: Adding instructions, intrinsics, types, etc.
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]14</h1>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]15
16<ol>
17 <li><a href="#introduction">Introduction and Warning</a></li>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]18 <li><a href="#intrinsic">Adding a new intrinsic function</a></li>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]19 <li><a href="#instruction">Adding a new instruction</a></li>
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]20 <li><a href="#sdnode">Adding a new SelectionDAG node</a></li>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]21 <li><a href="#type">Adding a new type</a>
22 <ol>
23 <li><a href="#fund_type">Adding a new fundamental type</a></li>
24 <li><a href="#derived_type">Adding a new derived type</a></li>
25 </ol></li>
26</ol>
27
Chris Lattner020e1fc2004-05-23 21:07:27 +0000[diff] [blame]28<div class="doc_author">
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]29 <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a>,
Chris Lattner63f29c62006-01-16 16:31:40 +0000[diff] [blame]30 Brad Jones, Nate Begeman,
31 and <a href="http://nondot.org/sabre">Chris Lattner</a></p>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]32</div>
33
34<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]35<h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]36 <a name="introduction">Introduction and Warning</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]37</h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]38<!-- *********************************************************************** -->
39
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]40<div>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]41
42<p>During the course of using LLVM, you may wish to customize it for your
43research project or for experimentation. At this point, you may realize that
44you need to add something to LLVM, whether it be a new fundamental type, a new
45intrinsic function, or a whole new instruction.</p>
46
47<p>When you come to this realization, stop and think. Do you really need to
48extend LLVM? Is it a new fundamental capability that LLVM does not support at
49its current incarnation or can it be synthesized from already pre-existing LLVM
50elements? If you are not sure, ask on the <a
51href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a> list. The
52reason is that extending LLVM will get involved as you need to update all the
53different passes that you intend to use with your extension, and there are
54<em>many</em> LLVM analyses and transformations, so it may be quite a bit of
55work.</p>
56
Chris Lattnerb1dc4362006-04-12 17:42:39 +0000[diff] [blame]57<p>Adding an <a href="#intrinsic">intrinsic function</a> is far easier than
58adding an instruction, and is transparent to optimization passes. If your added
59functionality can be expressed as a
Misha Brukmanc069ca52004-04-06 04:17:51 +0000[diff] [blame]60function call, an intrinsic function is the method of choice for LLVM
61extension.</p>
62
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]63<p>Before you invest a significant amount of effort into a non-trivial
64extension, <span class="doc_warning">ask on the list</span> if what you are
65looking to do can be done with already-existing infrastructure, or if maybe
66someone else is already working on it. You will save yourself a lot of time and
67effort by doing so.</p>
68
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]69</div>
70
71<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]72<h2>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]73 <a name="intrinsic">Adding a new intrinsic function</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]74</h2>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]75<!-- *********************************************************************** -->
76
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]77<div>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]78
79<p>Adding a new intrinsic function to LLVM is much easier than adding a new
80instruction. Almost all extensions to LLVM should start as an intrinsic
81function and then be turned into an instruction if warranted.</p>
82
83<ol>
84<li><tt>llvm/docs/LangRef.html</tt>:
85 Document the intrinsic. Decide whether it is code generator specific and
86 what the restrictions are. Talk to other people about it so that you are
87 sure it's a good idea.</li>
88
Chris Lattnerb1dc4362006-04-12 17:42:39 +0000[diff] [blame]89<li><tt>llvm/include/llvm/Intrinsics*.td</tt>:
90 Add an entry for your intrinsic. Describe its memory access characteristics
Reid Spencer9ade28d2007-04-01 07:44:52 +0000[diff] [blame]91 for optimization (this controls whether it will be DCE'd, CSE'd, etc). Note
92 that any intrinsic using the <tt>llvm_int_ty</tt> type for an argument will
93 be deemed by <tt>tblgen</tt> as overloaded and the corresponding suffix
94 will be required on the intrinsic's name.</li>
Chris Lattner027ccc12004-04-10 06:56:53 +0000[diff] [blame]95
Nate Begemanf6b7dd72006-01-14 01:27:10 +0000[diff] [blame]96<li><tt>llvm/lib/Analysis/ConstantFolding.cpp</tt>: If it is possible to
97 constant fold your intrinsic, add support to it in the
98 <tt>canConstantFoldCallTo</tt> and <tt>ConstantFoldCall</tt> functions.</li>
99
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]100<li><tt>llvm/test/Regression/*</tt>: Add test cases for your test cases to the
101 test suite</li>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]102</ol>
103
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]104<p>Once the intrinsic has been added to the system, you must add code generator
105support for it. Generally you must do the following steps:</p>
106
107<dl>
108<dt>Add support to the C backend in <tt>lib/Target/CBackend/</tt></dt>
109
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]110<dd>Depending on the intrinsic, there are a few ways to implement this. For
Bill Wendling31e1e5e2007-09-22 10:07:00 +0000[diff] [blame]111 most intrinsics, it makes sense to add code to lower your intrinsic in
112 <tt>LowerIntrinsicCall</tt> in <tt>lib/CodeGen/IntrinsicLowering.cpp</tt>.
113 Second, if it makes sense to lower the intrinsic to an expanded sequence of
114 C code in all cases, just emit the expansion in <tt>visitCallInst</tt> in
115 <tt>Writer.cpp</tt>. If the intrinsic has some way to express it with GCC
116 (or any other compiler) extensions, it can be conditionally supported based
117 on the compiler compiling the CBE output (see <tt>llvm.prefetch</tt> for an
118 example). Third, if the intrinsic really has no way to be lowered, just
119 have the code generator emit code that prints an error message and calls
120 abort if executed.</dd>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]121
Chris Lattnerb1dc4362006-04-12 17:42:39 +0000[diff] [blame]122<dt>Add support to the .td file for the target(s) of your choice in
123 <tt>lib/Target/*/*.td</tt>.</dt>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]124
Chris Lattnerb1dc4362006-04-12 17:42:39 +0000[diff] [blame]125<dd>This is usually a matter of adding a pattern to the .td file that matches
126 the intrinsic, though it may obviously require adding the instructions you
127 want to generate as well. There are lots of examples in the PowerPC and X86
128 backend to follow.</dd>
Bill Wendling31e1e5e2007-09-22 10:07:00 +0000[diff] [blame]129</dl>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]130
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]131</div>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]132
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]133<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]134<h2>
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]135 <a name="sdnode">Adding a new SelectionDAG node</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]136</h2>
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]137<!-- *********************************************************************** -->
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]138
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]139<div>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]140
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]141<p>As with intrinsics, adding a new SelectionDAG node to LLVM is much easier
142than adding a new instruction. New nodes are often added to help represent
143instructions common to many targets. These nodes often map to an LLVM
144instruction (add, sub) or intrinsic (byteswap, population count). In other
145cases, new nodes have been added to allow many targets to perform a common task
146(converting between floating point and integer representation) or capture more
147complicated behavior in a single node (rotate).</p>
Chris Lattner0a338a62005-05-11 03:53:53 +0000[diff] [blame]148
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]149<ol>
Duncan Sands23fb54e2011-06-30 06:37:07 +0000[diff] [blame]150<li><tt>include/llvm/CodeGen/ISDOpcodes.h</tt>:
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]151 Add an enum value for the new SelectionDAG node.</li>
152<li><tt>lib/CodeGen/SelectionDAG/SelectionDAG.cpp</tt>:
153 Add code to print the node to <tt>getOperationName</tt>. If your new node
154 can be evaluated at compile time when given constant arguments (such as an
155 add of a constant with another constant), find the <tt>getNode</tt> method
156 that takes the appropriate number of arguments, and add a case for your node
157 to the switch statement that performs constant folding for nodes that take
158 the same number of arguments as your new node.</li>
159<li><tt>lib/CodeGen/SelectionDAG/LegalizeDAG.cpp</tt>:
160 Add code to <a href="CodeGenerator.html#selectiondag_legalize">legalize,
161 promote, and expand</a> the node as necessary. At a minimum, you will need
162 to add a case statement for your node in <tt>LegalizeOp</tt> which calls
163 LegalizeOp on the node's operands, and returns a new node if any of the
164 operands changed as a result of being legalized. It is likely that not all
165 targets supported by the SelectionDAG framework will natively support the
166 new node. In this case, you must also add code in your node's case
167 statement in <tt>LegalizeOp</tt> to Expand your node into simpler, legal
Chris Lattner63f29c62006-01-16 16:31:40 +0000[diff] [blame]168 operations. The case for <tt>ISD::UREM</tt> for expanding a remainder into
169 a divide, multiply, and a subtract is a good example.</li>
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]170<li><tt>lib/CodeGen/SelectionDAG/LegalizeDAG.cpp</tt>:
171 If targets may support the new node being added only at certain sizes, you
172 will also need to add code to your node's case statement in
173 <tt>LegalizeOp</tt> to Promote your node's operands to a larger size, and
174 perform the correct operation. You will also need to add code to
Chris Lattner63f29c62006-01-16 16:31:40 +0000[diff] [blame]175 <tt>PromoteOp</tt> to do this as well. For a good example, see
176 <tt>ISD::BSWAP</tt>,
Nate Begeman024348e2006-01-16 07:54:23 +0000[diff] [blame]177 which promotes its operand to a wider size, performs the byteswap, and then
178 shifts the correct bytes right to emulate the narrower byteswap in the
179 wider type.</li>
180<li><tt>lib/CodeGen/SelectionDAG/LegalizeDAG.cpp</tt>:
181 Add a case for your node in <tt>ExpandOp</tt> to teach the legalizer how to
182 perform the action represented by the new node on a value that has been
183 split into high and low halves. This case will be used to support your
184 node with a 64 bit operand on a 32 bit target.</li>
185<li><tt>lib/CodeGen/SelectionDAG/DAGCombiner.cpp</tt>:
186 If your node can be combined with itself, or other existing nodes in a
187 peephole-like fashion, add a visit function for it, and call that function
188 from <tt></tt>. There are several good examples for simple combines you
189 can do; <tt>visitFABS</tt> and <tt>visitSRL</tt> are good starting places.
190 </li>
191<li><tt>lib/Target/PowerPC/PPCISelLowering.cpp</tt>:
192 Each target has an implementation of the <tt>TargetLowering</tt> class,
193 usually in its own file (although some targets include it in the same
194 file as the DAGToDAGISel). The default behavior for a target is to
195 assume that your new node is legal for all types that are legal for
196 that target. If this target does not natively support your node, then
197 tell the target to either Promote it (if it is supported at a larger
198 type) or Expand it. This will cause the code you wrote in
199 <tt>LegalizeOp</tt> above to decompose your new node into other legal
200 nodes for this target.</li>
201<li><tt>lib/Target/TargetSelectionDAG.td</tt>:
202 Most current targets supported by LLVM generate code using the DAGToDAG
203 method, where SelectionDAG nodes are pattern matched to target-specific
204 nodes, which represent individual instructions. In order for the targets
205 to match an instruction to your new node, you must add a def for that node
206 to the list in this file, with the appropriate type constraints. Look at
207 <tt>add</tt>, <tt>bswap</tt>, and <tt>fadd</tt> for examples.</li>
208<li><tt>lib/Target/PowerPC/PPCInstrInfo.td</tt>:
209 Each target has a tablegen file that describes the target's instruction
210 set. For targets that use the DAGToDAG instruction selection framework,
211 add a pattern for your new node that uses one or more target nodes.
212 Documentation for this is a bit sparse right now, but there are several
213 decent examples. See the patterns for <tt>rotl</tt> in
214 <tt>PPCInstrInfo.td</tt>.</li>
215<li>TODO: document complex patterns.</li>
216<li><tt>llvm/test/Regression/CodeGen/*</tt>: Add test cases for your new node
217 to the test suite. <tt>llvm/test/Regression/CodeGen/X86/bswap.ll</tt> is
218 a good example.</li>
219</ol>
Chris Lattner8ffe3e02004-04-09 19:24:20 +0000[diff] [blame]220
221</div>
222
223<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]224<h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]225 <a name="instruction">Adding a new instruction</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]226</h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]227<!-- *********************************************************************** -->
228
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]229<div>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]230
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]231<p><span class="doc_warning">WARNING: adding instructions changes the bitcode
Misha Brukmanc069ca52004-04-06 04:17:51 +0000[diff] [blame]232format, and it will take some effort to maintain compatibility with
233the previous version.</span> Only add an instruction if it is absolutely
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]234necessary.</p>
235
236<ol>
Misha Brukmanc069ca52004-04-06 04:17:51 +0000[diff] [blame]237
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]238<li><tt>llvm/include/llvm/Instruction.def</tt>:
239 add a number for your instruction and an enum name</li>
240
Misha Brukman63b38bd2004-07-29 17:30:56 +0000[diff] [blame]241<li><tt>llvm/include/llvm/Instructions.h</tt>:
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]242 add a definition for the class that will represent your instruction</li>
243
244<li><tt>llvm/include/llvm/Support/InstVisitor.h</tt>:
245 add a prototype for a visitor to your new instruction type</li>
246
247<li><tt>llvm/lib/AsmParser/Lexer.l</tt>:
248 add a new token to parse your instruction from assembly text file</li>
249
250<li><tt>llvm/lib/AsmParser/llvmAsmParser.y</tt>:
251 add the grammar on how your instruction can be read and what it will
252 construct as a result</li>
253
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]254<li><tt>llvm/lib/Bitcode/Reader/Reader.cpp</tt>:
255 add a case for your instruction and how it will be parsed from bitcode</li>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]256
257<li><tt>llvm/lib/VMCore/Instruction.cpp</tt>:
258 add a case for how your instruction will be printed out to assembly</li>
259
Chris Lattner5de840d2004-07-29 17:31:57 +0000[diff] [blame]260<li><tt>llvm/lib/VMCore/Instructions.cpp</tt>:
Misha Brukman57538832004-09-28 16:58:12 +0000[diff] [blame]261 implement the class you defined in
262 <tt>llvm/include/llvm/Instructions.h</tt></li>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]263
Misha Brukmand0bb8be2004-12-01 20:58:54 +0000[diff] [blame]264<li>Test your instruction</li>
265
266<li><tt>llvm/lib/Target/*</tt>:
267 Add support for your instruction to code generators, or add a lowering
268 pass.</li>
269
270<li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite.</li>
271
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]272</ol>
273
274<p>Also, you need to implement (or modify) any analyses or passes that you want
275to understand this new instruction.</p>
276
277</div>
278
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]279
280<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]281<h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]282 <a name="type">Adding a new type</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]283</h2>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]284<!-- *********************************************************************** -->
285
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]286<div>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]287
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]288<p><span class="doc_warning">WARNING: adding new types changes the bitcode
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]289format, and will break compatibility with currently-existing LLVM
290installations.</span> Only add new types if it is absolutely necessary.</p>
291
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]292<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]293<h3>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]294 <a name="fund_type">Adding a fundamental type</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]295</h3>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]296
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]297<div>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]298
299<ol>
300
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]301<li><tt>llvm/include/llvm/Type.h</tt>:
Chris Lattner6226f942005-04-23 21:59:11 +0000[diff] [blame]302 add enum for the new type; add static <tt>Type*</tt> for this type</li>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]303
304<li><tt>llvm/lib/VMCore/Type.cpp</tt>:
305 add mapping from <tt>TypeID</tt> =&gt; <tt>Type*</tt>;
306 initialize the static <tt>Type*</tt></li>
307
308<li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
309 add ability to parse in the type from text assembly</li>
310
311<li><tt>llvm/lib/AsmReader/llvmAsmParser.y</tt>:
312 add a token for that type</li>
313
314</ol>
315
316</div>
317
318<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]319<h3>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]320 <a name="derived_type">Adding a derived type</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000[diff] [blame]321</h3>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]322
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]323<div>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]324
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]325<ol>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]326<li><tt>llvm/include/llvm/Type.h</tt>:
Chris Lattner6226f942005-04-23 21:59:11 +0000[diff] [blame]327 add enum for the new type; add a forward declaration of the type
Misha Brukman810f89d2004-08-12 19:58:43 +0000[diff] [blame]328 also</li>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]329
Chris Lattnerd05550a2005-11-13 02:09:55 +0000[diff] [blame]330<li><tt>llvm/include/llvm/DerivedTypes.h</tt>:
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]331 add new class to represent new class in the hierarchy; add forward
332 declaration to the TypeMap value type</li>
333
334<li><tt>llvm/lib/VMCore/Type.cpp</tt>:
335 add support for derived type to:
Misha Brukman810f89d2004-08-12 19:58:43 +0000[diff] [blame]336<div class="doc_code">
337<pre>
338std::string getTypeDescription(const Type &amp;Ty,
339 std::vector&lt;const Type*&gt; &amp;TypeStack)
340bool TypesEqual(const Type *Ty, const Type *Ty2,
341 std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
342</pre>
343</div>
344 add necessary member functions for type, and factory methods</li>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]345
346<li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
347 add ability to parse in the type from text assembly</li>
348
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]349<li><tt>llvm/lib/BitCode/Writer/Writer.cpp</tt>:
350 modify <tt>void BitcodeWriter::outputType(const Type *T)</tt> to serialize
Misha Brukman810f89d2004-08-12 19:58:43 +0000[diff] [blame]351 your type</li>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]352
Gabor Greifa54634a2007-07-06 22:07:22 +0000[diff] [blame]353<li><tt>llvm/lib/BitCode/Reader/Reader.cpp</tt>:
354 modify <tt>const Type *BitcodeReader::ParseType()</tt> to read your data
Misha Brukman810f89d2004-08-12 19:58:43 +0000[diff] [blame]355 type</li>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]356
357<li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
Misha Brukman810f89d2004-08-12 19:58:43 +0000[diff] [blame]358 modify
359<div class="doc_code">
360<pre>
361void calcTypeName(const Type *Ty,
362 std::vector&lt;const Type*&gt; &amp;TypeStack,
363 std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
364 std::string &amp; Result)
365</pre>
366</div>
Chris Lattner012301c2004-08-12 19:06:24 +0000[diff] [blame]367 to output the new derived type
368</li>
369
370
371</ol>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]372
373</div>
374
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000[diff] [blame]375</div>
376
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]377<!-- *********************************************************************** -->
378
379<hr>
380<address>
381 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +0000[diff] [blame]382 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]383 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman21a63702008-12-11 18:23:24 +0000[diff] [blame]384 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]385
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +0000[diff] [blame]386 <a href="http://llvm.org/">The LLVM Compiler Infrastructure</a>
Misha Brukman2282a6e2004-04-06 03:53:49 +0000[diff] [blame]387 <br>
388 Last modified: $Date$
389</address>
390
391</body>
392</html>