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_text">
  27   <p><b>Written by <a href="http://misha.brukman.net">Misha Brukman</a></b></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 <p>Finally, these are my notes, and since my extensions are not complete, I may
  66 be missing steps. If you find some omissions, please let me know <a
  67 href="http://misha.brukman.net/contact.html">directly</a> or post on <a
  68 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a>.</p>
  69
  70 </div>
  71
  72 <!-- *********************************************************************** -->
  73 <div class="doc_section">
  74   <a name="intrinsic">Adding a new intrinsic function</a>
  75 </div>
  76 <!-- *********************************************************************** -->
  77
  78 <div class="doc_text">
  79
  80 <p>Adding a new intrinsic function to LLVM is much easier than adding a new
  81 instruction.  Almost all extensions to LLVM should start as an intrinsic
  82 function and then be turned into an instruction if warranted.</p>
  83
  84 <ol>
  85 <li><tt>llvm/docs/LangRef.html</tt>:
  86     Document the intrinsic.  Decide whether it is code generator specific and
  87     what the restrictions are.  Talk to other people about it so that you are
  88     sure it's a good idea.</li>
  89
  90 <li><tt>llvm/include/llvm/Intrinsics.h</tt>:
  91     add an enum in the <tt>llvm::Intrinsic</tt> namespace</li>
  92
  93 <li><tt>llvm/lib/VMCore/IntrinsicLowering.cpp</tt>:
  94     implement the lowering for this intrinsic</li>
  95
  96 <li><tt>llvm/lib/VMCore/Verifier.cpp</tt>:
  97     Add code to check the invariants of the intrinsic are respected.</li>
  98
  99 <li><tt>llvm/lib/VMCore/Function.cpp (<tt>Function::getIntrinsicID()</tt>)</tt>:
 100     Identify the new intrinsic function, returning the enum for the intrinsic
 101     that you added.</li>
 102
 103 <li><tt>llvm/lib/Analysis/BasicAliasAnalysis.cpp</tt>: If the new intrinsic does
 104     not access memory, or does not write to memory, add it to the relevant list
 105     of functions.</li>
 106
 107 <li>Test your intrinsic</li>
 108 <li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite.</li>
 109 </ol>
 110
 111 <p>If this intrinsic requires code generator support (ie, it cannot be lowered).
 112 You should also add support to the code generator in question.</p>
 113
 114 </div>
 115
 116 <!-- *********************************************************************** -->
 117 <div class="doc_section">
 118   <a name="instruction">Adding a new instruction</a>
 119 </div>
 120 <!-- *********************************************************************** -->
 121
 122 <div class="doc_text">
 123
 124 <p><span class="doc_warning">WARNING: adding instructions changes the bytecode
 125 format, and it will take some effort to maintain compatibility with
 126 the previous version.</span> Only add an instruction if it is absolutely
 127 necessary.</p>
 128
 129 <ol>
 130
 131 <li><tt>llvm/include/llvm/Instruction.def</tt>:
 132     add a number for your instruction and an enum name</li>
 133
 134 <li><tt>llvm/include/llvm/i*.h</tt>:
 135     add a definition for the class that will represent your instruction</li>
 136
 137 <li><tt>llvm/include/llvm/Support/InstVisitor.h</tt>:
 138     add a prototype for a visitor to your new instruction type</li>
 139
 140 <li><tt>llvm/lib/AsmParser/Lexer.l</tt>:
 141     add a new token to parse your instruction from assembly text file</li>
 142
 143 <li><tt>llvm/lib/AsmParser/llvmAsmParser.y</tt>:
 144     add the grammar on how your instruction can be read and what it will
 145     construct as a result</li>
 146
 147 <li><tt>llvm/lib/Bytecode/Reader/InstructionReader.cpp</tt>:
 148     add a case for your instruction and how it will be parsed from bytecode</li>
 149
 150 <li><tt>llvm/lib/VMCore/Instruction.cpp</tt>:
 151     add a case for how your instruction will be printed out to assembly</li>
 152
 153 <li><tt>llvm/lib/VMCore/i*.cpp</tt>:
 154     implement the class you defined in <tt>llvm/include/llvm/i*.h</tt></li>
 155
 156 </ol>
 157
 158 <p>Also, you need to implement (or modify) any analyses or passes that you want
 159 to understand this new instruction.</p>
 160
 161 </div>
 162
 163
 164 <!-- *********************************************************************** -->
 165 <div class="doc_section">
 166   <a name="type">Adding a new type</a>
 167 </div>
 168 <!-- *********************************************************************** -->
 169
 170 <div class="doc_text">
 171
 172 <p><span class="doc_warning">WARNING: adding new types changes the bytecode
 173 format, and will break compatibility with currently-existing LLVM
 174 installations.</span> Only add new types if it is absolutely necessary.</p>
 175
 176 </div>
 177
 178 <!-- ======================================================================= -->
 179 <div class="doc_subsection">
 180   <a name="fund_type">Adding a fundamental type</a>
 181 </div>
 182
 183 <div class="doc_text">
 184
 185 <ol>
 186
 187 <li><tt>llvm/include/llvm/Type.def</tt>:
 188     add enum for the type</li>
 189
 190 <li><tt>llvm/include/llvm/Type.h</tt>:
 191     add ID number for the new type; add static <tt>Type*</tt> for this type</li>
 192
 193 <li><tt>llvm/lib/VMCore/Type.cpp</tt>:
 194     add mapping from <tt>TypeID</tt> =&gt; <tt>Type*</tt>;
 195     initialize the static <tt>Type*</tt></li>
 196
 197 <li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
 198     add ability to parse in the type from text assembly</li>
 199
 200 <li><tt>llvm/lib/AsmReader/llvmAsmParser.y</tt>:
 201     add a token for that type</li>
 202
 203 </ol>
 204
 205 </div>
 206
 207 <!-- ======================================================================= -->
 208 <div class="doc_subsection">
 209   <a name="derived_type">Adding a derived type</a>
 210 </div>
 211
 212 <div class="doc_text">
 213
 214 <p>TODO</p>
 215
 216 </div>
 217
 218 <!-- *********************************************************************** -->
 219
 220 <hr>
 221 <address>
 222   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 223   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 224   <a href="http://validator.w3.org/check/referer"><img
 225   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 226
 227   <a href="http://misha.brukman.net">Misha Brukman</a><br>
 228   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
 229   <br>
 230   Last modified: $Date$
 231 </address>
 232
 233 </body>
 234 </html>