docs/ExtendingLLVM.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>Extending LLVM: Adding instructions, intrinsics, types, etc.</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8
   9 <body>
  10
  11 <div class="doc_title">
  12   Extending LLVM: Adding instructions, intrinsics, types, etc.
  13 </div>
  14
  15 <ol>
  16   <li><a href="#introduction">Introduction and Warning</a></li>
  17   <li><a href="#intrinsic">Adding a new intrinsic function</a></li>
  18   <li><a href="#instruction">Adding a new instruction</a></li>
  19   <li><a href="#type">Adding a new type</a>
  20   <ol>
  21     <li><a href="#fund_type">Adding a new fundamental type</a></li>
  22     <li><a href="#derived_type">Adding a new derived type</a></li>
  23   </ol></li>
  24 </ol>
  25
  26 <div class="doc_author">
  27   <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a></p>
  28 </div>
  29
  30 <!-- *********************************************************************** -->
  31 <div class="doc_section">
  32   <a name="introduction">Introduction and Warning</a>
  33 </div>
  34 <!-- *********************************************************************** -->
  35
  36 <div class="doc_text">
  37
  38 <p>During the course of using LLVM, you may wish to customize it for your
  39 research project or for experimentation. At this point, you may realize that
  40 you need to add something to LLVM, whether it be a new fundamental type, a new
  41 intrinsic function, or a whole new instruction.</p>
  42
  43 <p>When you come to this realization, stop and think. Do you really need to
  44 extend LLVM? Is it a new fundamental capability that LLVM does not support at
  45 its current incarnation or can it be synthesized from already pre-existing LLVM
  46 elements? If you are not sure, ask on the <a
  47 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a> list. The
  48 reason is that extending LLVM will get involved as you need to update all the
  49 different passes that you intend to use with your extension, and there are
  50 <em>many</em> LLVM analyses and transformations, so it may be quite a bit of
  51 work.</p>
  52
  53 <p>Adding an <a href="#intrinsic">intrinsic function</a> is easier than adding
  54 an instruction, and is transparent to optimization passes which treat it as an
  55 unanalyzable function.  If your added functionality can be expressed as a
  56 function call, an intrinsic function is the method of choice for LLVM
  57 extension.</p>
  58
  59 <p>Before you invest a significant amount of effort into a non-trivial
  60 extension, <span class="doc_warning">ask on the list</span> if what you are
  61 looking to do can be done with already-existing infrastructure, or if maybe
  62 someone else is already working on it. You will save yourself a lot of time and
  63 effort by doing so.</p>
  64
  65 </div>
  66
  67 <!-- *********************************************************************** -->
  68 <div class="doc_section">
  69   <a name="intrinsic">Adding a new intrinsic function</a>
  70 </div>
  71 <!-- *********************************************************************** -->
  72
  73 <div class="doc_text">
  74
  75 <p>Adding a new intrinsic function to LLVM is much easier than adding a new
  76 instruction.  Almost all extensions to LLVM should start as an intrinsic
  77 function and then be turned into an instruction if warranted.</p>
  78
  79 <ol>
  80 <li><tt>llvm/docs/LangRef.html</tt>:
  81     Document the intrinsic.  Decide whether it is code generator specific and
  82     what the restrictions are.  Talk to other people about it so that you are
  83     sure it's a good idea.</li>
  84
  85 <li><tt>llvm/include/llvm/Intrinsics.h</tt>:
  86     add an enum in the <tt>llvm::Intrinsic</tt> namespace</li>
  87
  88 <li><tt>llvm/lib/CodeGen/IntrinsicLowering.cpp</tt>:
  89     implement the lowering for this intrinsic</li>
  90
  91 <li><tt>llvm/lib/VMCore/Verifier.cpp</tt>:
  92     Add code to check the invariants of the intrinsic are respected.</li>
  93
  94 <li><tt>llvm/lib/VMCore/Function.cpp (<tt>Function::getIntrinsicID()</tt>)</tt>:
  95     Identify the new intrinsic function, returning the enum for the intrinsic
  96     that you added.</li>
  97
  98 <li><tt>llvm/lib/Analysis/BasicAliasAnalysis.cpp</tt>: If the new intrinsic does
  99     not access memory or does not write to memory, add it to the relevant list
 100     of functions.</li>
 101
 102 <li><tt>llvm/lib/Transforms/Utils/Local.cpp</tt>: If it is possible to constant
 103     propagate your intrinsic, add support to it in the
 104     <tt>canConstantFoldCallTo</tt> and <tt>ConstantFoldCall</tt> functions.</li>
 105
 106 <li>Test your intrinsic</li>
 107 <li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite.</li>
 108 </ol>
 109
 110 <p>If this intrinsic requires code generator support (ie, it cannot be lowered).
 111 You should also add support to the code generator in question.</p>
 112
 113 </div>
 114
 115 <!-- *********************************************************************** -->
 116 <div class="doc_section">
 117   <a name="instruction">Adding a new instruction</a>
 118 </div>
 119 <!-- *********************************************************************** -->
 120
 121 <div class="doc_text">
 122
 123 <p><span class="doc_warning">WARNING: adding instructions changes the bytecode
 124 format, and it will take some effort to maintain compatibility with
 125 the previous version.</span> Only add an instruction if it is absolutely
 126 necessary.</p>
 127
 128 <ol>
 129
 130 <li><tt>llvm/include/llvm/Instruction.def</tt>:
 131     add a number for your instruction and an enum name</li>
 132
 133 <li><tt>llvm/include/llvm/Instructions.h</tt>:
 134     add a definition for the class that will represent your instruction</li>
 135
 136 <li><tt>llvm/include/llvm/Support/InstVisitor.h</tt>:
 137     add a prototype for a visitor to your new instruction type</li>
 138
 139 <li><tt>llvm/lib/AsmParser/Lexer.l</tt>:
 140     add a new token to parse your instruction from assembly text file</li>
 141
 142 <li><tt>llvm/lib/AsmParser/llvmAsmParser.y</tt>:
 143     add the grammar on how your instruction can be read and what it will
 144     construct as a result</li>
 145
 146 <li><tt>llvm/lib/Bytecode/Reader/InstructionReader.cpp</tt>:
 147     add a case for your instruction and how it will be parsed from bytecode</li>
 148
 149 <li><tt>llvm/lib/VMCore/Instruction.cpp</tt>:
 150     add a case for how your instruction will be printed out to assembly</li>
 151
 152 <li><tt>llvm/lib/VMCore/Instructions.cpp</tt>:
 153     implement the class you defined in <tt>llvm/include/llvm/Instructions.h</tt></li>
 154
 155 </ol>
 156
 157 <p>Also, you need to implement (or modify) any analyses or passes that you want
 158 to understand this new instruction.</p>
 159
 160 </div>
 161
 162
 163 <!-- *********************************************************************** -->
 164 <div class="doc_section">
 165   <a name="type">Adding a new type</a>
 166 </div>
 167 <!-- *********************************************************************** -->
 168
 169 <div class="doc_text">
 170
 171 <p><span class="doc_warning">WARNING: adding new types changes the bytecode
 172 format, and will break compatibility with currently-existing LLVM
 173 installations.</span> Only add new types if it is absolutely necessary.</p>
 174
 175 </div>
 176
 177 <!-- ======================================================================= -->
 178 <div class="doc_subsection">
 179   <a name="fund_type">Adding a fundamental type</a>
 180 </div>
 181
 182 <div class="doc_text">
 183
 184 <ol>
 185
 186 <li><tt>llvm/include/llvm/Type.def</tt>:
 187     add enum for the type</li>
 188
 189 <li><tt>llvm/include/llvm/Type.h</tt>:
 190     add ID number for the new type; add static <tt>Type*</tt> for this type</li>
 191
 192 <li><tt>llvm/lib/VMCore/Type.cpp</tt>:
 193     add mapping from <tt>TypeID</tt> =&gt; <tt>Type*</tt>;
 194     initialize the static <tt>Type*</tt></li>
 195
 196 <li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
 197     add ability to parse in the type from text assembly</li>
 198
 199 <li><tt>llvm/lib/AsmReader/llvmAsmParser.y</tt>:
 200     add a token for that type</li>
 201
 202 </ol>
 203
 204 </div>
 205
 206 <!-- ======================================================================= -->
 207 <div class="doc_subsection">
 208   <a name="derived_type">Adding a derived type</a>
 209 </div>
 210
 211 <div class="doc_text">
 212
 213 <ol>
 214 <li><tt>llvm/include/llvm/Type.def</tt>:
 215     add enum for the type</li>
 216
 217 <li><tt>llvm/include/llvm/Type.h</tt>:
 218     add ID number for the new type; add a forward declaration of the type
 219     also</li>
 220
 221 <li><tt>llvm/include/llvm/DerivedType.h</tt>:
 222     add new class to represent new class in the hierarchy; add forward
 223     declaration to the TypeMap value type</li>
 224
 225 <li><tt>llvm/lib/VMCore/Type.cpp</tt>:
 226     add support for derived type to:
 227 <div class="doc_code">
 228 <pre>
 229 std::string getTypeDescription(const Type &amp;Ty,
 230   std::vector&lt;const Type*&gt; &amp;TypeStack)
 231 bool TypesEqual(const Type *Ty, const Type *Ty2,
 232   std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
 233 </pre>
 234 </div>
 235     add necessary member functions for type, and factory methods</li>
 236
 237 <li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
 238     add ability to parse in the type from text assembly</li>
 239
 240 <li><tt>llvm/lib/ByteCode/Writer/Writer.cpp</tt>:
 241     modify <tt>void BytecodeWriter::outputType(const Type *T)</tt> to serialize
 242     your type</li>
 243
 244 <li><tt>llvm/lib/ByteCode/Reader/Reader.cpp</tt>:
 245     modify <tt>const Type *BytecodeReader::ParseType()</tt> to read your data
 246     type</li>
 247
 248 <li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
 249     modify
 250 <div class="doc_code">
 251 <pre>
 252 void calcTypeName(const Type *Ty,
 253                   std::vector&lt;const Type*&gt; &amp;TypeStack,
 254                   std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
 255                   std::string &amp; Result)
 256 </pre>
 257 </div>
 258     to output the new derived type
 259 </li>
 260
 261
 262 </ol>
 263
 264 </div>
 265
 266 <!-- *********************************************************************** -->
 267
 268 <hr>
 269 <address>
 270   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 271   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 272   <a href="http://validator.w3.org/check/referer"><img
 273   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 274
 275   <a href="http://misha.brukman.net">Misha Brukman</a><br>
 276   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
 277   <br>
 278   Last modified: $Date$
 279 </address>
 280
 281 </body>
 282 </html>