Fix the 3 regressions last night, due to my buggy patch from yesterday.

[oota-llvm.git] / docs / ExtendingLLVM.html

diff --git a/docs/ExtendingLLVM.html b/docs/ExtendingLLVM.html
index 8ff27362e9a85551ec3309e68c0c4e114b2649cd..6aece2ff9ce7a0ebd014896cc4caac69d001aa58 100644 (file)
--- a/docs/ExtendingLLVM.html
+++ b/docs/ExtendingLLVM.html
@@ -24,7 +24,8 @@
 </ol>
 
 <div class="doc_author">    
-  <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a></p>
+  <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a> and
+  Brad Jones</p>
 </div>
 
 <!-- *********************************************************************** -->
@@ -62,11 +63,6 @@ looking to do can be done with already-existing infrastructure, or if maybe
 someone else is already working on it. You will save yourself a lot of time and
 effort by doing so.</p>
 
-<p>Finally, these are my notes, and since my extensions are not complete, I may
-be missing steps. If you find some omissions, please let me know <a
-href="http://misha.brukman.net/contact.html">directly</a> or post on <a
-href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a>.</p>
-
 </div>
 
 <!-- *********************************************************************** -->
@@ -104,16 +100,17 @@ function and then be turned into an instruction if warranted.</p>
     not access memory or does not write to memory, add it to the relevant list
     of functions.</li>
 
-<li><tt>llvm/lib/Transforms/Utils/Local.cpp</tt>: If it is possible to constant
-    propagate your intrinsic, add support to it in the
+<li><tt>llvm/lib/Transforms/Utils/Local.cpp</tt>: If it is possible to
+    constant-propagate your intrinsic, add support to it in the
     <tt>canConstantFoldCallTo</tt> and <tt>ConstantFoldCall</tt> functions.</li>
 
 <li>Test your intrinsic</li>
-<li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite.</li>
+
+<li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite</li>
 </ol>
 
-<p>If this intrinsic requires code generator support (ie, it cannot be lowered).
-You should also add support to the code generator in question.</p>
+<p>If this intrinsic requires code generator support (i.e., it cannot be
+lowered), you should also add support to the code generator in question.</p>
 
 </div>
 
@@ -148,14 +145,23 @@ necessary.</p>
     add the grammar on how your instruction can be read and what it will
     construct as a result</li>
 
-<li><tt>llvm/lib/Bytecode/Reader/InstructionReader.cpp</tt>:
+<li><tt>llvm/lib/Bytecode/Reader/Reader.cpp</tt>:
     add a case for your instruction and how it will be parsed from bytecode</li>
 
 <li><tt>llvm/lib/VMCore/Instruction.cpp</tt>:
     add a case for how your instruction will be printed out to assembly</li>
 
-<li><tt>llvm/lib/VMCore/i*.cpp</tt>:
-    implement the class you defined in <tt>llvm/include/llvm/i*.h</tt></li>
+<li><tt>llvm/lib/VMCore/Instructions.cpp</tt>:
+    implement the class you defined in
+    <tt>llvm/include/llvm/Instructions.h</tt></li>
+
+<li>Test your instruction</li>
+
+<li><tt>llvm/lib/Target/*</tt>: 
+    Add support for your instruction to code generators, or add a lowering
+    pass.</li>
+
+<li><tt>llvm/test/Regression/*</tt>: add your test cases to the test suite.</li>
 
 </ol>
 
@@ -215,7 +221,56 @@ installations.</span> Only add new types if it is absolutely necessary.</p>
 
 <div class="doc_text">
 
-<p>TODO</p>
+<ol>
+<li><tt>llvm/include/llvm/Type.def</tt>:
+    add enum for the type</li>
+
+<li><tt>llvm/include/llvm/Type.h</tt>:
+    add ID number for the new type; add a forward declaration of the type
+    also</li>
+
+<li><tt>llvm/include/llvm/DerivedType.h</tt>:
+    add new class to represent new class in the hierarchy; add forward 
+    declaration to the TypeMap value type</li>
+
+<li><tt>llvm/lib/VMCore/Type.cpp</tt>:
+    add support for derived type to: 
+<div class="doc_code">
+<pre>
+std::string getTypeDescription(const Type &amp;Ty,
+  std::vector&lt;const Type*&gt; &amp;TypeStack)
+bool TypesEqual(const Type *Ty, const Type *Ty2,
+  std::map&lt;const Type*, const Type*&gt; &amp; EqTypes)
+</pre>
+</div>
+    add necessary member functions for type, and factory methods</li>
+
+<li><tt>llvm/lib/AsmReader/Lexer.l</tt>:
+    add ability to parse in the type from text assembly</li>
+
+<li><tt>llvm/lib/ByteCode/Writer/Writer.cpp</tt>:
+    modify <tt>void BytecodeWriter::outputType(const Type *T)</tt> to serialize
+    your type</li>
+
+<li><tt>llvm/lib/ByteCode/Reader/Reader.cpp</tt>:
+    modify <tt>const Type *BytecodeReader::ParseType()</tt> to read your data
+    type</li> 
+
+<li><tt>llvm/lib/VMCore/AsmWriter.cpp</tt>:
+    modify
+<div class="doc_code">
+<pre>
+void calcTypeName(const Type *Ty,
+                  std::vector&lt;const Type*&gt; &amp;TypeStack,
+                  std::map&lt;const Type*,std::string&gt; &amp;TypeNames,
+                  std::string &amp; Result)
+</pre>
+</div>
+    to output the new derived type
+</li>  
+ 
+
+</ol>
 
 </div>