<ol>
<li><a href="#introduction">Introduction and Warning</a></li>
- <li><a href="#instruction">Adding a new instruction</a></li>
<li><a href="#intrinsic">Adding a new intrinsic function</a></li>
+ <li><a href="#instruction">Adding a new instruction</a></li>
<li><a href="#type">Adding a new type</a>
<ol>
<li><a href="#fund_type">Adding a new fundamental type</a></li>
</ol></li>
</ol>
-<div class="doc_text">
- <p><b>Written by <a href="http://misha.brukman.net">Misha Brukman</a></b></p>
+<div class="doc_author">
+ <p>Written by <a href="http://misha.brukman.net">Misha Brukman</a></p>
</div>
<!-- *********************************************************************** -->
</div>
+<!-- *********************************************************************** -->
+<div class="doc_section">
+ <a name="intrinsic">Adding a new intrinsic function</a>
+</div>
+<!-- *********************************************************************** -->
+
+<div class="doc_text">
+
+<p>Adding a new intrinsic function to LLVM is much easier than adding a new
+instruction. Almost all extensions to LLVM should start as an intrinsic
+function and then be turned into an instruction if warranted.</p>
+
+<ol>
+<li><tt>llvm/docs/LangRef.html</tt>:
+ Document the intrinsic. Decide whether it is code generator specific and
+ what the restrictions are. Talk to other people about it so that you are
+ sure it's a good idea.</li>
+
+<li><tt>llvm/include/llvm/Intrinsics.h</tt>:
+ add an enum in the <tt>llvm::Intrinsic</tt> namespace</li>
+
+<li><tt>llvm/lib/CodeGen/IntrinsicLowering.cpp</tt>:
+ implement the lowering for this intrinsic</li>
+
+<li><tt>llvm/lib/VMCore/Verifier.cpp</tt>:
+ Add code to check the invariants of the intrinsic are respected.</li>
+
+<li><tt>llvm/lib/VMCore/Function.cpp (<tt>Function::getIntrinsicID()</tt>)</tt>:
+ Identify the new intrinsic function, returning the enum for the intrinsic
+ that you added.</li>
+
+<li><tt>llvm/lib/Analysis/BasicAliasAnalysis.cpp</tt>: If the new intrinsic does
+ 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
+ <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>
+</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>
+
+</div>
+
<!-- *********************************************************************** -->
<div class="doc_section">
<a name="instruction">Adding a new instruction</a>
<li><tt>llvm/include/llvm/Instruction.def</tt>:
add a number for your instruction and an enum name</li>
-<li><tt>llvm/include/llvm/i*.h</tt>:
+<li><tt>llvm/include/llvm/Instructions.h</tt>:
add a definition for the class that will represent your instruction</li>
<li><tt>llvm/include/llvm/Support/InstVisitor.h</tt>:
<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>
</ol>
</div>
-<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="intrinsic">Adding a new intrinsic function</a>
-</div>
-<!-- *********************************************************************** -->
-
-<div class="doc_text">
-
-<ol>
-
-<li><tt>llvm/include/llvm/Intrinsics.h</tt>:
- add an enum in the <tt>llvm::Intrinsic</tt> namespace</li>
-
-<li><tt>llvm/lib/VMCore/IntrinsicLowering.cpp</tt>:
- implement the lowering for this intrinsic</li>
-
-<li><tt>llvm/lib/VMCore/Verifier.cpp</tt>:
- handle the new intrinsic</li>
-
-<li><tt>llvm/lib/VMCore/Function.cpp</tt>:
- handle the new intrinsic</li>
-
-</ol>
-
-</div>
<!-- *********************************************************************** -->
<div class="doc_section">
<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 &Ty,
+ std::vector<const Type*> &TypeStack)
+bool TypesEqual(const Type *Ty, const Type *Ty2,
+ std::map<const Type*, const Type*> & 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<const Type*> &TypeStack,
+ std::map<const Type*,std::string> &TypeNames,
+ std::string & Result)
+</pre>
+</div>
+ to output the new derived type
+</li>
+
+
+</ol>
</div>
projects / oota-llvm.git / blobdiff