improve grammar
[oota-llvm.git] / docs / ExtendingLLVM.html
index d2f358e6137abf0dd517110344214bcd607a0c28..631a09bd6d6993742ee4cc2eaa1be9d731de7073 100644 (file)
@@ -53,9 +53,9 @@ different passes that you intend to use with your extension, and there are
 <em>many</em> LLVM analyses and transformations, so it may be quite a bit of
 work.</p>
 
-<p>Adding an <a href="#intrinsic">intrinsic function</a> is easier than adding
-an instruction, and is transparent to optimization passes which treat it as an
-unanalyzable function.  If your added functionality can be expressed as a
+<p>Adding an <a href="#intrinsic">intrinsic function</a> is far easier than
+adding an instruction, and is transparent to optimization passes.  If your added
+functionality can be expressed as a
 function call, an intrinsic function is the method of choice for LLVM
 extension.</p>
 
@@ -85,17 +85,14 @@ function and then be turned into an instruction if warranted.</p>
     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.td</tt>:
-    Add an entry for your intrinsic.</li>
+<li><tt>llvm/include/llvm/Intrinsics*.td</tt>:
+    Add an entry for your intrinsic.  Describe its memory access characteristics
+    for optimization (this controls whether it will be DCE'd, CSE'd, etc).</li>
 
 <li><tt>llvm/lib/Analysis/ConstantFolding.cpp</tt>: If it is possible to 
     constant fold your intrinsic, add support to it in the 
     <tt>canConstantFoldCallTo</tt> and <tt>ConstantFoldCall</tt> functions.</li>
 
-<li><tt>llvm/lib/Transforms/Utils/Local.cpp</tt>: If your intrinsic has no side-
-    effects, add it to the list of intrinsics in the 
-    <tt>isInstructionTriviallyDead</tt> function.</li>
-
 <li><tt>llvm/test/Regression/*</tt>: Add test cases for your test cases to the 
     test suite</li>
 </ol>
@@ -120,22 +117,13 @@ generator emit code that prints an error message and calls abort if executed.
 </dd>
 
 <dl>
-<dt>Add support to the SelectionDAG Instruction Selector in 
-<tt>lib/CodeGen/SelectionDAG/</tt></dt>
-
-<dd>Since most targets in LLVM use the SelectionDAG framework for generating
-code, you will likely need to add support for your intrinsic there as well.
-This is usually accomplished by adding a new node, and then teaching the
-SelectionDAG code how to handle that node.  To do this, follow the steps in
-the <a href="#sdnode">Adding a new SelectionDAG node</a> section.</dd>
+<dt>Add support to the .td file for the target(s) of your choice in 
+   <tt>lib/Target/*/*.td</tt>.</dt>
 
-<dl>
-<dt>Once you have added the new node, add code to 
-<tt>SelectionDAG/SelectionDAGISel.cpp</tt> to recognize the intrinsic.  In most
-cases, the intrinsic will just be turned into the node you just added.  For an
-example of this, see how <tt>visitIntrinsicCall</tt> handles 
-<tt>Intrinsic::ctpop_*</tt>.
-</dt>
+<dd>This is usually a matter of adding a pattern to the .td file that matches
+    the intrinsic, though it may obviously require adding the instructions you
+    want to generate as well.  There are lots of examples in the PowerPC and X86
+    backend to follow.</dd>
 
 </div>
 
@@ -392,7 +380,7 @@ void calcTypeName(const Type *Ty,
   <a href="http://validator.w3.org/check/referer"><img
   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
 
-  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+  <a href="http://llvm.org">The LLVM Compiler Infrastructure</a>
   <br>
   Last modified: $Date$
 </address>