docs/ProgrammersManual.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>LLVM Programmer's Manual</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   LLVM Programmer's Manual
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction</a></li>
  16   <li><a href="#general">General Information</a>
  17     <ul>
  18       <li><a href="#stl">The C++ Standard Template Library</a></li>
  19 <!--
  20       <li>The <tt>-time-passes</tt> option</li>
  21       <li>How to use the LLVM Makefile system</li>
  22       <li>How to write a regression test</li>
  23
  24 -->
  25     </ul>
  26   </li>
  27   <li><a href="#apis">Important and useful LLVM APIs</a>
  28     <ul>
  29       <li><a href="#isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt>
  30 and <tt>dyn_cast&lt;&gt;</tt> templates</a> </li>
  31       <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt>
  32 option</a>
  33         <ul>
  34           <li><a href="#DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt>
  35 and the <tt>-debug-only</tt> option</a> </li>
  36         </ul>
  37       </li>
  38       <li><a href="#Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
  39 option</a></li>
  40 <!--
  41       <li>The <tt>InstVisitor</tt> template
  42       <li>The general graph API
  43 -->
  44       <li><a href="#ViewGraph">Viewing graphs while debugging code</a></li>
  45     </ul>
  46   </li>
  47   <li><a href="#common">Helpful Hints for Common Operations</a>
  48     <ul>
  49       <li><a href="#inspection">Basic Inspection and Traversal Routines</a>
  50         <ul>
  51           <li><a href="#iterate_function">Iterating over the <tt>BasicBlock</tt>s
  52 in a <tt>Function</tt></a> </li>
  53           <li><a href="#iterate_basicblock">Iterating over the <tt>Instruction</tt>s
  54 in a <tt>BasicBlock</tt></a> </li>
  55           <li><a href="#iterate_institer">Iterating over the <tt>Instruction</tt>s
  56 in a <tt>Function</tt></a> </li>
  57           <li><a href="#iterate_convert">Turning an iterator into a
  58 class pointer</a> </li>
  59           <li><a href="#iterate_complex">Finding call sites: a more
  60 complex example</a> </li>
  61           <li><a href="#calls_and_invokes">Treating calls and invokes
  62 the same way</a> </li>
  63           <li><a href="#iterate_chains">Iterating over def-use &amp;
  64 use-def chains</a> </li>
  65         </ul>
  66       </li>
  67       <li><a href="#simplechanges">Making simple changes</a>
  68         <ul>
  69           <li><a href="#schanges_creating">Creating and inserting new
  70                  <tt>Instruction</tt>s</a> </li>
  71           <li><a href="#schanges_deleting">Deleting              <tt>Instruction</tt>s</a> </li>
  72           <li><a href="#schanges_replacing">Replacing an                 <tt>Instruction</tt>
  73 with another <tt>Value</tt></a> </li>
  74         </ul>
  75       </li>
  76 <!--
  77     <li>Working with the Control Flow Graph
  78     <ul>
  79       <li>Accessing predecessors and successors of a <tt>BasicBlock</tt>
  80       <li>
  81       <li>
  82     </ul>
  83 -->
  84     </ul>
  85   </li>
  86
  87   <li><a href="#advanced">Advanced Topics</a>
  88   <ul>
  89   <li><a href="#TypeResolve">LLVM Type Resolution</a>
  90   <ul>
  91     <li><a href="#BuildRecType">Basic Recursive Type Construction</a></li>
  92     <li><a href="#refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a></li>
  93     <li><a href="#PATypeHolder">The PATypeHolder Class</a></li>
  94     <li><a href="#AbstractTypeUser">The AbstractTypeUser Class</a></li>
  95   </ul></li>
  96
  97   <li><a href="#SymbolTable">The <tt>SymbolTable</tt> class </a></li>
  98   </ul></li>
  99
 100   <li><a href="#coreclasses">The Core LLVM Class Hierarchy Reference</a>
 101     <ul>
 102       <li><a href="#Value">The <tt>Value</tt> class</a>
 103         <ul>
 104           <li><a href="#User">The <tt>User</tt> class</a>
 105             <ul>
 106               <li><a href="#Instruction">The <tt>Instruction</tt> class</a>
 107                 <ul>
 108                   <li><a href="#GetElementPtrInst">The <tt>GetElementPtrInst</tt> class</a></li>
 109                 </ul>
 110               </li>
 111               <li><a href="#Module">The <tt>Module</tt> class</a></li>
 112               <li><a href="#Constant">The <tt>Constant</tt> class</a>
 113                 <ul>
 114                   <li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
 115                     <ul>
 116                       <li><a href="#BasicBlock">The <tt>BasicBlock</tt>class</a></li>
 117                       <li><a href="#Function">The <tt>Function</tt> class</a></li>
 118                       <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class</a></li>
 119                     </ul>
 120                   </li>
 121                 </ul>
 122               </li>
 123             </ul>
 124           </li>
 125           <li><a href="#Type">The <tt>Type</tt> class</a> </li>
 126           <li><a href="#Argument">The <tt>Argument</tt> class</a></li>
 127         </ul>
 128       </li>
 129     </ul>
 130   </li>
 131 </ol>
 132
 133 <div class="doc_author">
 134   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
 135                 <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>,
 136                 <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a>, and
 137                 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
 138 </div>
 139
 140 <!-- *********************************************************************** -->
 141 <div class="doc_section">
 142   <a name="introduction">Introduction </a>
 143 </div>
 144 <!-- *********************************************************************** -->
 145
 146 <div class="doc_text">
 147
 148 <p>This document is meant to highlight some of the important classes and
 149 interfaces available in the LLVM source-base.  This manual is not
 150 intended to explain what LLVM is, how it works, and what LLVM code looks
 151 like.  It assumes that you know the basics of LLVM and are interested
 152 in writing transformations or otherwise analyzing or manipulating the
 153 code.</p>
 154
 155 <p>This document should get you oriented so that you can find your
 156 way in the continuously growing source code that makes up the LLVM
 157 infrastructure. Note that this manual is not intended to serve as a
 158 replacement for reading the source code, so if you think there should be
 159 a method in one of these classes to do something, but it's not listed,
 160 check the source.  Links to the <a href="/doxygen/">doxygen</a> sources
 161 are provided to make this as easy as possible.</p>
 162
 163 <p>The first section of this document describes general information that is
 164 useful to know when working in the LLVM infrastructure, and the second describes
 165 the Core LLVM classes.  In the future this manual will be extended with
 166 information describing how to use extension libraries, such as dominator
 167 information, CFG traversal routines, and useful utilities like the <tt><a
 168 href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.</p>
 169
 170 </div>
 171
 172 <!-- *********************************************************************** -->
 173 <div class="doc_section">
 174   <a name="general">General Information</a>
 175 </div>
 176 <!-- *********************************************************************** -->
 177
 178 <div class="doc_text">
 179
 180 <p>This section contains general information that is useful if you are working
 181 in the LLVM source-base, but that isn't specific to any particular API.</p>
 182
 183 </div>
 184
 185 <!-- ======================================================================= -->
 186 <div class="doc_subsection">
 187   <a name="stl">The C++ Standard Template Library</a>
 188 </div>
 189
 190 <div class="doc_text">
 191
 192 <p>LLVM makes heavy use of the C++ Standard Template Library (STL),
 193 perhaps much more than you are used to, or have seen before.  Because of
 194 this, you might want to do a little background reading in the
 195 techniques used and capabilities of the library.  There are many good
 196 pages that discuss the STL, and several books on the subject that you
 197 can get, so it will not be discussed in this document.</p>
 198
 199 <p>Here are some useful links:</p>
 200
 201 <ol>
 202
 203 <li><a href="http://www.dinkumware.com/refxcpp.html">Dinkumware C++ Library
 204 reference</a> - an excellent reference for the STL and other parts of the
 205 standard C++ library.</li>
 206
 207 <li><a href="http://www.tempest-sw.com/cpp/">C++ In a Nutshell</a> - This is an
 208 O'Reilly book in the making.  It has a decent
 209 Standard Library
 210 Reference that rivals Dinkumware's, and is unfortunately no longer free since the book has been
 211 published.</li>
 212
 213 <li><a href="http://www.parashift.com/c++-faq-lite/">C++ Frequently Asked
 214 Questions</a></li>
 215
 216 <li><a href="http://www.sgi.com/tech/stl/">SGI's STL Programmer's Guide</a> -
 217 Contains a useful <a
 218 href="http://www.sgi.com/tech/stl/stl_introduction.html">Introduction to the
 219 STL</a>.</li>
 220
 221 <li><a href="http://www.research.att.com/%7Ebs/C++.html">Bjarne Stroustrup's C++
 222 Page</a></li>
 223
 224 <li><a href="http://64.78.49.204/">
 225 Bruce Eckel's Thinking in C++, 2nd ed. Volume 2 Revision 4.0 (even better, get
 226 the book).</a></li>
 227
 228 </ol>
 229
 230 <p>You are also encouraged to take a look at the <a
 231 href="CodingStandards.html">LLVM Coding Standards</a> guide which focuses on how
 232 to write maintainable code more than where to put your curly braces.</p>
 233
 234 </div>
 235
 236 <!-- ======================================================================= -->
 237 <div class="doc_subsection">
 238   <a name="stl">Other useful references</a>
 239 </div>
 240
 241 <div class="doc_text">
 242
 243 <ol>
 244 <li><a href="http://www.psc.edu/%7Esemke/cvs_branches.html">CVS
 245 Branch and Tag Primer</a></li>
 246 <li><a href="http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html">Using
 247 static and shared libraries across platforms</a></li>
 248 </ol>
 249
 250 </div>
 251
 252 <!-- *********************************************************************** -->
 253 <div class="doc_section">
 254   <a name="apis">Important and useful LLVM APIs</a>
 255 </div>
 256 <!-- *********************************************************************** -->
 257
 258 <div class="doc_text">
 259
 260 <p>Here we highlight some LLVM APIs that are generally useful and good to
 261 know about when writing transformations.</p>
 262
 263 </div>
 264
 265 <!-- ======================================================================= -->
 266 <div class="doc_subsection">
 267   <a name="isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt> and
 268   <tt>dyn_cast&lt;&gt;</tt> templates</a>
 269 </div>
 270
 271 <div class="doc_text">
 272
 273 <p>The LLVM source-base makes extensive use of a custom form of RTTI.
 274 These templates have many similarities to the C++ <tt>dynamic_cast&lt;&gt;</tt>
 275 operator, but they don't have some drawbacks (primarily stemming from
 276 the fact that <tt>dynamic_cast&lt;&gt;</tt> only works on classes that
 277 have a v-table). Because they are used so often, you must know what they
 278 do and how they work. All of these templates are defined in the <a
 279  href="/doxygen/Casting_8h-source.html"><tt>llvm/Support/Casting.h</tt></a>
 280 file (note that you very rarely have to include this file directly).</p>
 281
 282 <dl>
 283   <dt><tt>isa&lt;&gt;</tt>: </dt>
 284
 285   <dd><p>The <tt>isa&lt;&gt;</tt> operator works exactly like the Java
 286   "<tt>instanceof</tt>" operator.  It returns true or false depending on whether
 287   a reference or pointer points to an instance of the specified class.  This can
 288   be very useful for constraint checking of various sorts (example below).</p>
 289   </dd>
 290
 291   <dt><tt>cast&lt;&gt;</tt>: </dt>
 292
 293   <dd><p>The <tt>cast&lt;&gt;</tt> operator is a "checked cast" operation. It
 294   converts a pointer or reference from a base class to a derived cast, causing
 295   an assertion failure if it is not really an instance of the right type.  This
 296   should be used in cases where you have some information that makes you believe
 297   that something is of the right type.  An example of the <tt>isa&lt;&gt;</tt>
 298   and <tt>cast&lt;&gt;</tt> template is:</p>
 299
 300 <div class="doc_code">
 301 <pre>
 302 static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
 303   if (isa&lt;<a href="#Constant">Constant</a>&gt;(V) || isa&lt;<a href="#Argument">Argument</a>&gt;(V) || isa&lt;<a href="#GlobalValue">GlobalValue</a>&gt;(V))
 304     return true;
 305
 306   // <i>Otherwise, it must be an instruction...</i>
 307   return !L-&gt;contains(cast&lt;<a href="#Instruction">Instruction</a>&gt;(V)-&gt;getParent());
 308 }
 309 </pre>
 310 </div>
 311
 312   <p>Note that you should <b>not</b> use an <tt>isa&lt;&gt;</tt> test followed
 313   by a <tt>cast&lt;&gt;</tt>, for that use the <tt>dyn_cast&lt;&gt;</tt>
 314   operator.</p>
 315
 316   </dd>
 317
 318   <dt><tt>dyn_cast&lt;&gt;</tt>:</dt>
 319
 320   <dd><p>The <tt>dyn_cast&lt;&gt;</tt> operator is a "checking cast" operation.
 321   It checks to see if the operand is of the specified type, and if so, returns a
 322   pointer to it (this operator does not work with references). If the operand is
 323   not of the correct type, a null pointer is returned.  Thus, this works very
 324   much like the <tt>dynamic_cast&lt;&gt;</tt> operator in C++, and should be
 325   used in the same circumstances.  Typically, the <tt>dyn_cast&lt;&gt;</tt>
 326   operator is used in an <tt>if</tt> statement or some other flow control
 327   statement like this:</p>
 328
 329 <div class="doc_code">
 330 <pre>
 331 if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast&lt;<a href="#AllocationInst">AllocationInst</a>&gt;(Val)) {
 332   // <i>...</i>
 333 }
 334 </pre>
 335 </div>
 336
 337   <p>This form of the <tt>if</tt> statement effectively combines together a call
 338   to <tt>isa&lt;&gt;</tt> and a call to <tt>cast&lt;&gt;</tt> into one
 339   statement, which is very convenient.</p>
 340
 341   <p>Note that the <tt>dyn_cast&lt;&gt;</tt> operator, like C++'s
 342   <tt>dynamic_cast&lt;&gt;</tt> or Java's <tt>instanceof</tt> operator, can be
 343   abused.  In particular, you should not use big chained <tt>if/then/else</tt>
 344   blocks to check for lots of different variants of classes.  If you find
 345   yourself wanting to do this, it is much cleaner and more efficient to use the
 346   <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p>
 347
 348   </dd>
 349
 350   <dt><tt>cast_or_null&lt;&gt;</tt>: </dt>
 351
 352   <dd><p>The <tt>cast_or_null&lt;&gt;</tt> operator works just like the
 353   <tt>cast&lt;&gt;</tt> operator, except that it allows for a null pointer as an
 354   argument (which it then propagates).  This can sometimes be useful, allowing
 355   you to combine several null checks into one.</p></dd>
 356
 357   <dt><tt>dyn_cast_or_null&lt;&gt;</tt>: </dt>
 358
 359   <dd><p>The <tt>dyn_cast_or_null&lt;&gt;</tt> operator works just like the
 360   <tt>dyn_cast&lt;&gt;</tt> operator, except that it allows for a null pointer
 361   as an argument (which it then propagates).  This can sometimes be useful,
 362   allowing you to combine several null checks into one.</p></dd>
 363
 364 </dl>
 365
 366 <p>These five templates can be used with any classes, whether they have a
 367 v-table or not.  To add support for these templates, you simply need to add
 368 <tt>classof</tt> static methods to the class you are interested casting
 369 to. Describing this is currently outside the scope of this document, but there
 370 are lots of examples in the LLVM source base.</p>
 371
 372 </div>
 373
 374 <!-- ======================================================================= -->
 375 <div class="doc_subsection">
 376   <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a>
 377 </div>
 378
 379 <div class="doc_text">
 380
 381 <p>Often when working on your pass you will put a bunch of debugging printouts
 382 and other code into your pass.  After you get it working, you want to remove
 383 it, but you may need it again in the future (to work out new bugs that you run
 384 across).</p>
 385
 386 <p> Naturally, because of this, you don't want to delete the debug printouts,
 387 but you don't want them to always be noisy.  A standard compromise is to comment
 388 them out, allowing you to enable them if you need them in the future.</p>
 389
 390 <p>The "<tt><a href="/doxygen/Debug_8h-source.html">llvm/Support/Debug.h</a></tt>"
 391 file provides a macro named <tt>DEBUG()</tt> that is a much nicer solution to
 392 this problem.  Basically, you can put arbitrary code into the argument of the
 393 <tt>DEBUG</tt> macro, and it is only executed if '<tt>opt</tt>' (or any other
 394 tool) is run with the '<tt>-debug</tt>' command line argument:</p>
 395
 396 <div class="doc_code">
 397 <pre>
 398 DOUT &lt;&lt; "I am here!\n";
 399 </pre>
 400 </div>
 401
 402 <p>Then you can run your pass like this:</p>
 403
 404 <div class="doc_code">
 405 <pre>
 406 $ opt &lt; a.bc &gt; /dev/null -mypass
 407 <i>&lt;no output&gt;</i>
 408 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 409 I am here!
 410 </pre>
 411 </div>
 412
 413 <p>Using the <tt>DEBUG()</tt> macro instead of a home-brewed solution allows you
 414 to not have to create "yet another" command line option for the debug output for
 415 your pass.  Note that <tt>DEBUG()</tt> macros are disabled for optimized builds,
 416 so they do not cause a performance impact at all (for the same reason, they
 417 should also not contain side-effects!).</p>
 418
 419 <p>One additional nice thing about the <tt>DEBUG()</tt> macro is that you can
 420 enable or disable it directly in gdb.  Just use "<tt>set DebugFlag=0</tt>" or
 421 "<tt>set DebugFlag=1</tt>" from the gdb if the program is running.  If the
 422 program hasn't been started yet, you can always just run it with
 423 <tt>-debug</tt>.</p>
 424
 425 </div>
 426
 427 <!-- _______________________________________________________________________ -->
 428 <div class="doc_subsubsection">
 429   <a name="DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> and
 430   the <tt>-debug-only</tt> option</a>
 431 </div>
 432
 433 <div class="doc_text">
 434
 435 <p>Sometimes you may find yourself in a situation where enabling <tt>-debug</tt>
 436 just turns on <b>too much</b> information (such as when working on the code
 437 generator).  If you want to enable debug information with more fine-grained
 438 control, you define the <tt>DEBUG_TYPE</tt> macro and the <tt>-debug</tt> only
 439 option as follows:</p>
 440
 441 <div class="doc_code">
 442 <pre>
 443 DOUT &lt;&lt; "No debug type\n";
 444 #undef  DEBUG_TYPE
 445 #define DEBUG_TYPE "foo"
 446 DOUT &lt;&lt; "'foo' debug type\n";
 447 #undef  DEBUG_TYPE
 448 #define DEBUG_TYPE "bar"
 449 DOUT &lt;&lt; "'bar' debug type\n";
 450 #undef  DEBUG_TYPE
 451 #define DEBUG_TYPE ""
 452 DOUT &lt;&lt; "No debug type (2)\n";
 453 </pre>
 454 </div>
 455
 456 <p>Then you can run your pass like this:</p>
 457
 458 <div class="doc_code">
 459 <pre>
 460 $ opt &lt; a.bc &gt; /dev/null -mypass
 461 <i>&lt;no output&gt;</i>
 462 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 463 No debug type
 464 'foo' debug type
 465 'bar' debug type
 466 No debug type (2)
 467 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=foo
 468 'foo' debug type
 469 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=bar
 470 'bar' debug type
 471 </pre>
 472 </div>
 473
 474 <p>Of course, in practice, you should only set <tt>DEBUG_TYPE</tt> at the top of
 475 a file, to specify the debug type for the entire module (if you do this before
 476 you <tt>#include "llvm/Support/Debug.h"</tt>, you don't have to insert the ugly
 477 <tt>#undef</tt>'s).  Also, you should use names more meaningful than "foo" and
 478 "bar", because there is no system in place to ensure that names do not
 479 conflict. If two different modules use the same string, they will all be turned
 480 on when the name is specified. This allows, for example, all debug information
 481 for instruction scheduling to be enabled with <tt>-debug-type=InstrSched</tt>,
 482 even if the source lives in multiple files.</p>
 483
 484 </div>
 485
 486 <!-- ======================================================================= -->
 487 <div class="doc_subsection">
 488   <a name="Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
 489   option</a>
 490 </div>
 491
 492 <div class="doc_text">
 493
 494 <p>The "<tt><a
 495 href="/doxygen/Statistic_8h-source.html">llvm/ADT/Statistic.h</a></tt>" file
 496 provides a class named <tt>Statistic</tt> that is used as a unified way to
 497 keep track of what the LLVM compiler is doing and how effective various
 498 optimizations are.  It is useful to see what optimizations are contributing to
 499 making a particular program run faster.</p>
 500
 501 <p>Often you may run your pass on some big program, and you're interested to see
 502 how many times it makes a certain transformation.  Although you can do this with
 503 hand inspection, or some ad-hoc method, this is a real pain and not very useful
 504 for big programs.  Using the <tt>Statistic</tt> class makes it very easy to
 505 keep track of this information, and the calculated information is presented in a
 506 uniform manner with the rest of the passes being executed.</p>
 507
 508 <p>There are many examples of <tt>Statistic</tt> uses, but the basics of using
 509 it are as follows:</p>
 510
 511 <ol>
 512     <li><p>Define your statistic like this:</p>
 513
 514 <div class="doc_code">
 515 <pre>
 516 #define <a href="#DEBUG_TYPE">DEBUG_TYPE</a> "mypassname"   <i>// This goes before any #includes.</i>
 517 STATISTIC(NumXForms, "The # of times I did stuff");
 518 </pre>
 519 </div>
 520
 521   <p>The <tt>STATISTIC</tt> macro defines a static variable, whose name is
 522     specified by the first argument.  The pass name is taken from the DEBUG_TYPE
 523     macro, and the description is taken from the second argument.  The variable
 524     defined ("NumXForms" in this case) acts like an unsigned int.</p></li>
 525
 526     <li><p>Whenever you make a transformation, bump the counter:</p>
 527
 528 <div class="doc_code">
 529 <pre>
 530 ++NumXForms;   // <i>I did stuff!</i>
 531 </pre>
 532 </div>
 533
 534     </li>
 535   </ol>
 536
 537   <p>That's all you have to do.  To get '<tt>opt</tt>' to print out the
 538   statistics gathered, use the '<tt>-stats</tt>' option:</p>
 539
 540 <div class="doc_code">
 541 <pre>
 542 $ opt -stats -mypassname &lt; program.bc &gt; /dev/null
 543 <i>... statistics output ...</i>
 544 </pre>
 545 </div>
 546
 547   <p> When running <tt>gccas</tt> on a C file from the SPEC benchmark
 548 suite, it gives a report that looks like this:</p>
 549
 550 <div class="doc_code">
 551 <pre>
 552    7646 bytecodewriter  - Number of normal instructions
 553     725 bytecodewriter  - Number of oversized instructions
 554  129996 bytecodewriter  - Number of bytecode bytes written
 555    2817 raise           - Number of insts DCEd or constprop'd
 556    3213 raise           - Number of cast-of-self removed
 557    5046 raise           - Number of expression trees converted
 558      75 raise           - Number of other getelementptr's formed
 559     138 raise           - Number of load/store peepholes
 560      42 deadtypeelim    - Number of unused typenames removed from symtab
 561     392 funcresolve     - Number of varargs functions resolved
 562      27 globaldce       - Number of global variables removed
 563       2 adce            - Number of basic blocks removed
 564     134 cee             - Number of branches revectored
 565      49 cee             - Number of setcc instruction eliminated
 566     532 gcse            - Number of loads removed
 567    2919 gcse            - Number of instructions removed
 568      86 indvars         - Number of canonical indvars added
 569      87 indvars         - Number of aux indvars removed
 570      25 instcombine     - Number of dead inst eliminate
 571     434 instcombine     - Number of insts combined
 572     248 licm            - Number of load insts hoisted
 573    1298 licm            - Number of insts hoisted to a loop pre-header
 574       3 licm            - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
 575      75 mem2reg         - Number of alloca's promoted
 576    1444 cfgsimplify     - Number of blocks simplified
 577 </pre>
 578 </div>
 579
 580 <p>Obviously, with so many optimizations, having a unified framework for this
 581 stuff is very nice.  Making your pass fit well into the framework makes it more
 582 maintainable and useful.</p>
 583
 584 </div>
 585
 586 <!-- ======================================================================= -->
 587 <div class="doc_subsection">
 588   <a name="ViewGraph">Viewing graphs while debugging code</a>
 589 </div>
 590
 591 <div class="doc_text">
 592
 593 <p>Several of the important data structures in LLVM are graphs: for example
 594 CFGs made out of LLVM <a href="#BasicBlock">BasicBlock</a>s, CFGs made out of
 595 LLVM <a href="CodeGenerator.html#machinebasicblock">MachineBasicBlock</a>s, and
 596 <a href="CodeGenerator.html#selectiondag_intro">Instruction Selection
 597 DAGs</a>.  In many cases, while debugging various parts of the compiler, it is
 598 nice to instantly visualize these graphs.</p>
 599
 600 <p>LLVM provides several callbacks that are available in a debug build to do
 601 exactly that.  If you call the <tt>Function::viewCFG()</tt> method, for example,
 602 the current LLVM tool will pop up a window containing the CFG for the function
 603 where each basic block is a node in the graph, and each node contains the
 604 instructions in the block.  Similarly, there also exists
 605 <tt>Function::viewCFGOnly()</tt> (does not include the instructions), the
 606 <tt>MachineFunction::viewCFG()</tt> and <tt>MachineFunction::viewCFGOnly()</tt>,
 607 and the <tt>SelectionDAG::viewGraph()</tt> methods.  Within GDB, for example,
 608 you can usually use something like <tt>call DAG.viewGraph()</tt> to pop
 609 up a window.  Alternatively, you can sprinkle calls to these functions in your
 610 code in places you want to debug.</p>
 611
 612 <p>Getting this to work requires a small amount of configuration.  On Unix
 613 systems with X11, install the <a href="http://www.graphviz.org">graphviz</a>
 614 toolkit, and make sure 'dot' and 'gv' are in your path.  If you are running on
 615 Mac OS/X, download and install the Mac OS/X <a
 616 href="http://www.pixelglow.com/graphviz/">Graphviz program</a>, and add
 617 <tt>/Applications/Graphviz.app/Contents/MacOS/</tt> (or whereever you install
 618 it) to your path.  Once in your system and path are set up, rerun the LLVM
 619 configure script and rebuild LLVM to enable this functionality.</p>
 620
 621 <p><tt>SelectionDAG</tt> has been extended to make it easier to locate
 622 <i>interesting</i> nodes in large complex graphs.  From gdb, if you
 623 <tt>call DAG.setGraphColor(<i>node</i>, "<i>color</i>")</tt>, then the
 624 next <tt>call DAG.viewGraph()</tt> would hilight the node in the
 625 specified color (choices of colors can be found at <a
 626 href="http://www.graphviz.org/doc/info/colors.html">Colors<a>.) More
 627 complex node attributes can be provided with <tt>call
 628 DAG.setGraphAttrs(<i>node</i>, "<i>attributes</i>")</tt> (choices can be
 629 found at <a href="http://www.graphviz.org/doc/info/attrs.html">Graph
 630 Attributes</a>.)  If you want to restart and clear all the current graph
 631 attributes, then you can <tt>call DAG.clearGraphAttrs()</tt>. </p>
 632
 633 </div>
 634
 635
 636 <!-- *********************************************************************** -->
 637 <div class="doc_section">
 638   <a name="common">Helpful Hints for Common Operations</a>
 639 </div>
 640 <!-- *********************************************************************** -->
 641
 642 <div class="doc_text">
 643
 644 <p>This section describes how to perform some very simple transformations of
 645 LLVM code.  This is meant to give examples of common idioms used, showing the
 646 practical side of LLVM transformations.  <p> Because this is a "how-to" section,
 647 you should also read about the main classes that you will be working with.  The
 648 <a href="#coreclasses">Core LLVM Class Hierarchy Reference</a> contains details
 649 and descriptions of the main classes that you should know about.</p>
 650
 651 </div>
 652
 653 <!-- NOTE: this section should be heavy on example code -->
 654 <!-- ======================================================================= -->
 655 <div class="doc_subsection">
 656   <a name="inspection">Basic Inspection and Traversal Routines</a>
 657 </div>
 658
 659 <div class="doc_text">
 660
 661 <p>The LLVM compiler infrastructure have many different data structures that may
 662 be traversed.  Following the example of the C++ standard template library, the
 663 techniques used to traverse these various data structures are all basically the
 664 same.  For a enumerable sequence of values, the <tt>XXXbegin()</tt> function (or
 665 method) returns an iterator to the start of the sequence, the <tt>XXXend()</tt>
 666 function returns an iterator pointing to one past the last valid element of the
 667 sequence, and there is some <tt>XXXiterator</tt> data type that is common
 668 between the two operations.</p>
 669
 670 <p>Because the pattern for iteration is common across many different aspects of
 671 the program representation, the standard template library algorithms may be used
 672 on them, and it is easier to remember how to iterate. First we show a few common
 673 examples of the data structures that need to be traversed.  Other data
 674 structures are traversed in very similar ways.</p>
 675
 676 </div>
 677
 678 <!-- _______________________________________________________________________ -->
 679 <div class="doc_subsubsection">
 680   <a name="iterate_function">Iterating over the </a><a
 681   href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
 682   href="#Function"><tt>Function</tt></a>
 683 </div>
 684
 685 <div class="doc_text">
 686
 687 <p>It's quite common to have a <tt>Function</tt> instance that you'd like to
 688 transform in some way; in particular, you'd like to manipulate its
 689 <tt>BasicBlock</tt>s.  To facilitate this, you'll need to iterate over all of
 690 the <tt>BasicBlock</tt>s that constitute the <tt>Function</tt>. The following is
 691 an example that prints the name of a <tt>BasicBlock</tt> and the number of
 692 <tt>Instruction</tt>s it contains:</p>
 693
 694 <div class="doc_code">
 695 <pre>
 696 // <i>func is a pointer to a Function instance</i>
 697 for (Function::iterator i = func-&gt;begin(), e = func-&gt;end(); i != e; ++i)
 698   // <i>Print out the name of the basic block if it has one, and then the</i>
 699   // <i>number of instructions that it contains</i>
 700   llvm::cerr &lt;&lt; "Basic block (name=" &lt;&lt; i-&gt;getName() &lt;&lt; ") has "
 701              &lt;&lt; i-&gt;size() &lt;&lt; " instructions.\n";
 702 </pre>
 703 </div>
 704
 705 <p>Note that i can be used as if it were a pointer for the purposes of
 706 invoking member functions of the <tt>Instruction</tt> class.  This is
 707 because the indirection operator is overloaded for the iterator
 708 classes.  In the above code, the expression <tt>i-&gt;size()</tt> is
 709 exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.</p>
 710
 711 </div>
 712
 713 <!-- _______________________________________________________________________ -->
 714 <div class="doc_subsubsection">
 715   <a name="iterate_basicblock">Iterating over the </a><a
 716   href="#Instruction"><tt>Instruction</tt></a>s in a <a
 717   href="#BasicBlock"><tt>BasicBlock</tt></a>
 718 </div>
 719
 720 <div class="doc_text">
 721
 722 <p>Just like when dealing with <tt>BasicBlock</tt>s in <tt>Function</tt>s, it's
 723 easy to iterate over the individual instructions that make up
 724 <tt>BasicBlock</tt>s. Here's a code snippet that prints out each instruction in
 725 a <tt>BasicBlock</tt>:</p>
 726
 727 <div class="doc_code">
 728 <pre>
 729 // <i>blk is a pointer to a BasicBlock instance</i>
 730 for (BasicBlock::iterator i = blk-&gt;begin(), e = blk-&gt;end(); i != e; ++i)
 731    // <i>The next statement works since operator&lt;&lt;(ostream&amp;,...)</i>
 732    // <i>is overloaded for Instruction&amp;</i>
 733    llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
 734 </pre>
 735 </div>
 736
 737 <p>However, this isn't really the best way to print out the contents of a
 738 <tt>BasicBlock</tt>!  Since the ostream operators are overloaded for virtually
 739 anything you'll care about, you could have just invoked the print routine on the
 740 basic block itself: <tt>llvm::cerr &lt;&lt; *blk &lt;&lt; "\n";</tt>.</p>
 741
 742 </div>
 743
 744 <!-- _______________________________________________________________________ -->
 745 <div class="doc_subsubsection">
 746   <a name="iterate_institer">Iterating over the </a><a
 747   href="#Instruction"><tt>Instruction</tt></a>s in a <a
 748   href="#Function"><tt>Function</tt></a>
 749 </div>
 750
 751 <div class="doc_text">
 752
 753 <p>If you're finding that you commonly iterate over a <tt>Function</tt>'s
 754 <tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s <tt>Instruction</tt>s,
 755 <tt>InstIterator</tt> should be used instead. You'll need to include <a
 756 href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>,
 757 and then instantiate <tt>InstIterator</tt>s explicitly in your code.  Here's a
 758 small example that shows how to dump all instructions in a function to the standard error stream:<p>
 759
 760 <div class="doc_code">
 761 <pre>
 762 #include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"
 763
 764 // <i>F is a ptr to a Function instance</i>
 765 for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
 766   llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
 767 </pre>
 768 </div>
 769
 770 <p>Easy, isn't it?  You can also use <tt>InstIterator</tt>s to fill a
 771 worklist with its initial contents.  For example, if you wanted to
 772 initialize a worklist to contain all instructions in a <tt>Function</tt>
 773 F, all you would need to do is something like:</p>
 774
 775 <div class="doc_code">
 776 <pre>
 777 std::set&lt;Instruction*&gt; worklist;
 778 worklist.insert(inst_begin(F), inst_end(F));
 779 </pre>
 780 </div>
 781
 782 <p>The STL set <tt>worklist</tt> would now contain all instructions in the
 783 <tt>Function</tt> pointed to by F.</p>
 784
 785 </div>
 786
 787 <!-- _______________________________________________________________________ -->
 788 <div class="doc_subsubsection">
 789   <a name="iterate_convert">Turning an iterator into a class pointer (and
 790   vice-versa)</a>
 791 </div>
 792
 793 <div class="doc_text">
 794
 795 <p>Sometimes, it'll be useful to grab a reference (or pointer) to a class
 796 instance when all you've got at hand is an iterator.  Well, extracting
 797 a reference or a pointer from an iterator is very straight-forward.
 798 Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and <tt>j</tt>
 799 is a <tt>BasicBlock::const_iterator</tt>:</p>
 800
 801 <div class="doc_code">
 802 <pre>
 803 Instruction&amp; inst = *i;   // <i>Grab reference to instruction reference</i>
 804 Instruction* pinst = &amp;*i; // <i>Grab pointer to instruction reference</i>
 805 const Instruction&amp; inst = *j;
 806 </pre>
 807 </div>
 808
 809 <p>However, the iterators you'll be working with in the LLVM framework are
 810 special: they will automatically convert to a ptr-to-instance type whenever they
 811 need to.  Instead of dereferencing the iterator and then taking the address of
 812 the result, you can simply assign the iterator to the proper pointer type and
 813 you get the dereference and address-of operation as a result of the assignment
 814 (behind the scenes, this is a result of overloading casting mechanisms).  Thus
 815 the last line of the last example,</p>
 816
 817 <div class="doc_code">
 818 <pre>
 819 Instruction* pinst = &amp;*i;
 820 </pre>
 821 </div>
 822
 823 <p>is semantically equivalent to</p>
 824
 825 <div class="doc_code">
 826 <pre>
 827 Instruction* pinst = i;
 828 </pre>
 829 </div>
 830
 831 <p>It's also possible to turn a class pointer into the corresponding iterator,
 832 and this is a constant time operation (very efficient).  The following code
 833 snippet illustrates use of the conversion constructors provided by LLVM
 834 iterators.  By using these, you can explicitly grab the iterator of something
 835 without actually obtaining it via iteration over some structure:</p>
 836
 837 <div class="doc_code">
 838 <pre>
 839 void printNextInstruction(Instruction* inst) {
 840   BasicBlock::iterator it(inst);
 841   ++it; // <i>After this line, it refers to the instruction after *inst</i>
 842   if (it != inst-&gt;getParent()-&gt;end()) llvm::cerr &lt;&lt; *it &lt;&lt; "\n";
 843 }
 844 </pre>
 845 </div>
 846
 847 </div>
 848
 849 <!--_______________________________________________________________________-->
 850 <div class="doc_subsubsection">
 851   <a name="iterate_complex">Finding call sites: a slightly more complex
 852   example</a>
 853 </div>
 854
 855 <div class="doc_text">
 856
 857 <p>Say that you're writing a FunctionPass and would like to count all the
 858 locations in the entire module (that is, across every <tt>Function</tt>) where a
 859 certain function (i.e., some <tt>Function</tt>*) is already in scope.  As you'll
 860 learn later, you may want to use an <tt>InstVisitor</tt> to accomplish this in a
 861 much more straight-forward manner, but this example will allow us to explore how
 862 you'd do it if you didn't have <tt>InstVisitor</tt> around. In pseudocode, this
 863 is what we want to do:</p>
 864
 865 <div class="doc_code">
 866 <pre>
 867 initialize callCounter to zero
 868 for each Function f in the Module
 869   for each BasicBlock b in f
 870     for each Instruction i in b
 871       if (i is a CallInst and calls the given function)
 872         increment callCounter
 873 </pre>
 874 </div>
 875
 876 <p>And the actual code is (remember, because we're writing a
 877 <tt>FunctionPass</tt>, our <tt>FunctionPass</tt>-derived class simply has to
 878 override the <tt>runOnFunction</tt> method):</p>
 879
 880 <div class="doc_code">
 881 <pre>
 882 Function* targetFunc = ...;
 883
 884 class OurFunctionPass : public FunctionPass {
 885   public:
 886     OurFunctionPass(): callCounter(0) { }
 887
 888     virtual runOnFunction(Function&amp; F) {
 889       for (Function::iterator b = F.begin(), be = F.end(); b != be; ++b) {
 890         for (BasicBlock::iterator i = b-&gt;begin(); ie = b-&gt;end(); i != ie; ++i) {
 891           if (<a href="#CallInst">CallInst</a>* callInst = <a href="#isa">dyn_cast</a>&lt;<a
 892  href="#CallInst">CallInst</a>&gt;(&amp;*i)) {
 893             // <i>We know we've encountered a call instruction, so we</i>
 894             // <i>need to determine if it's a call to the</i>
 895             // <i>function pointed to by m_func or not</i>
 896
 897             if (callInst-&gt;getCalledFunction() == targetFunc)
 898               ++callCounter;
 899           }
 900         }
 901       }
 902     }
 903
 904   private:
 905     unsigned  callCounter;
 906 };
 907 </pre>
 908 </div>
 909
 910 </div>
 911
 912 <!--_______________________________________________________________________-->
 913 <div class="doc_subsubsection">
 914   <a name="calls_and_invokes">Treating calls and invokes the same way</a>
 915 </div>
 916
 917 <div class="doc_text">
 918
 919 <p>You may have noticed that the previous example was a bit oversimplified in
 920 that it did not deal with call sites generated by 'invoke' instructions. In
 921 this, and in other situations, you may find that you want to treat
 922 <tt>CallInst</tt>s and <tt>InvokeInst</tt>s the same way, even though their
 923 most-specific common base class is <tt>Instruction</tt>, which includes lots of
 924 less closely-related things. For these cases, LLVM provides a handy wrapper
 925 class called <a
 926 href="http://llvm.org/doxygen/classllvm_1_1CallSite.html"><tt>CallSite</tt></a>.
 927 It is essentially a wrapper around an <tt>Instruction</tt> pointer, with some
 928 methods that provide functionality common to <tt>CallInst</tt>s and
 929 <tt>InvokeInst</tt>s.</p>
 930
 931 <p>This class has "value semantics": it should be passed by value, not by
 932 reference and it should not be dynamically allocated or deallocated using
 933 <tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently copyable,
 934 assignable and constructable, with costs equivalents to that of a bare pointer.
 935 If you look at its definition, it has only a single pointer member.</p>
 936
 937 </div>
 938
 939 <!--_______________________________________________________________________-->
 940 <div class="doc_subsubsection">
 941   <a name="iterate_chains">Iterating over def-use &amp; use-def chains</a>
 942 </div>
 943
 944 <div class="doc_text">
 945
 946 <p>Frequently, we might have an instance of the <a
 947 href="/doxygen/structllvm_1_1Value.html">Value Class</a> and we want to
 948 determine which <tt>User</tt>s use the <tt>Value</tt>.  The list of all
 949 <tt>User</tt>s of a particular <tt>Value</tt> is called a <i>def-use</i> chain.
 950 For example, let's say we have a <tt>Function*</tt> named <tt>F</tt> to a
 951 particular function <tt>foo</tt>. Finding all of the instructions that
 952 <i>use</i> <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain
 953 of <tt>F</tt>:</p>
 954
 955 <div class="doc_code">
 956 <pre>
 957 Function* F = ...;
 958
 959 for (Value::use_iterator i = F-&gt;use_begin(), e = F-&gt;use_end(); i != e; ++i)
 960   if (Instruction *Inst = dyn_cast&lt;Instruction&gt;(*i)) {
 961     llvm::cerr &lt;&lt; "F is used in instruction:\n";
 962     llvm::cerr &lt;&lt; *Inst &lt;&lt; "\n";
 963   }
 964 </pre>
 965 </div>
 966
 967 <p>Alternately, it's common to have an instance of the <a
 968 href="/doxygen/classllvm_1_1User.html">User Class</a> and need to know what
 969 <tt>Value</tt>s are used by it.  The list of all <tt>Value</tt>s used by a
 970 <tt>User</tt> is known as a <i>use-def</i> chain.  Instances of class
 971 <tt>Instruction</tt> are common <tt>User</tt>s, so we might want to iterate over
 972 all of the values that a particular instruction uses (that is, the operands of
 973 the particular <tt>Instruction</tt>):</p>
 974
 975 <div class="doc_code">
 976 <pre>
 977 Instruction* pi = ...;
 978
 979 for (User::op_iterator i = pi-&gt;op_begin(), e = pi-&gt;op_end(); i != e; ++i) {
 980   Value* v = *i;
 981   // <i>...</i>
 982 }
 983 </pre>
 984 </div>
 985
 986 <!--
 987   def-use chains ("finding all users of"): Value::use_begin/use_end
 988   use-def chains ("finding all values used"): User::op_begin/op_end [op=operand]
 989 -->
 990
 991 </div>
 992
 993 <!-- ======================================================================= -->
 994 <div class="doc_subsection">
 995   <a name="simplechanges">Making simple changes</a>
 996 </div>
 997
 998 <div class="doc_text">
 999
1000 <p>There are some primitive transformation operations present in the LLVM
1001 infrastructure that are worth knowing about.  When performing
1002 transformations, it's fairly common to manipulate the contents of basic
1003 blocks. This section describes some of the common methods for doing so
1004 and gives example code.</p>
1005
1006 </div>
1007
1008 <!--_______________________________________________________________________-->
1009 <div class="doc_subsubsection">
1010   <a name="schanges_creating">Creating and inserting new
1011   <tt>Instruction</tt>s</a>
1012 </div>
1013
1014 <div class="doc_text">
1015
1016 <p><i>Instantiating Instructions</i></p>
1017
1018 <p>Creation of <tt>Instruction</tt>s is straight-forward: simply call the
1019 constructor for the kind of instruction to instantiate and provide the necessary
1020 parameters. For example, an <tt>AllocaInst</tt> only <i>requires</i> a
1021 (const-ptr-to) <tt>Type</tt>. Thus:</p>
1022
1023 <div class="doc_code">
1024 <pre>
1025 AllocaInst* ai = new AllocaInst(Type::IntTy);
1026 </pre>
1027 </div>
1028
1029 <p>will create an <tt>AllocaInst</tt> instance that represents the allocation of
1030 one integer in the current stack frame, at runtime. Each <tt>Instruction</tt>
1031 subclass is likely to have varying default parameters which change the semantics
1032 of the instruction, so refer to the <a
1033 href="/doxygen/classllvm_1_1Instruction.html">doxygen documentation for the subclass of
1034 Instruction</a> that you're interested in instantiating.</p>
1035
1036 <p><i>Naming values</i></p>
1037
1038 <p>It is very useful to name the values of instructions when you're able to, as
1039 this facilitates the debugging of your transformations.  If you end up looking
1040 at generated LLVM machine code, you definitely want to have logical names
1041 associated with the results of instructions!  By supplying a value for the
1042 <tt>Name</tt> (default) parameter of the <tt>Instruction</tt> constructor, you
1043 associate a logical name with the result of the instruction's execution at
1044 runtime.  For example, say that I'm writing a transformation that dynamically
1045 allocates space for an integer on the stack, and that integer is going to be
1046 used as some kind of index by some other code.  To accomplish this, I place an
1047 <tt>AllocaInst</tt> at the first point in the first <tt>BasicBlock</tt> of some
1048 <tt>Function</tt>, and I'm intending to use it within the same
1049 <tt>Function</tt>. I might do:</p>
1050
1051 <div class="doc_code">
1052 <pre>
1053 AllocaInst* pa = new AllocaInst(Type::IntTy, 0, "indexLoc");
1054 </pre>
1055 </div>
1056
1057 <p>where <tt>indexLoc</tt> is now the logical name of the instruction's
1058 execution value, which is a pointer to an integer on the runtime stack.</p>
1059
1060 <p><i>Inserting instructions</i></p>
1061
1062 <p>There are essentially two ways to insert an <tt>Instruction</tt>
1063 into an existing sequence of instructions that form a <tt>BasicBlock</tt>:</p>
1064
1065 <ul>
1066   <li>Insertion into an explicit instruction list
1067
1068     <p>Given a <tt>BasicBlock* pb</tt>, an <tt>Instruction* pi</tt> within that
1069     <tt>BasicBlock</tt>, and a newly-created instruction we wish to insert
1070     before <tt>*pi</tt>, we do the following: </p>
1071
1072 <div class="doc_code">
1073 <pre>
1074 BasicBlock *pb = ...;
1075 Instruction *pi = ...;
1076 Instruction *newInst = new Instruction(...);
1077
1078 pb-&gt;getInstList().insert(pi, newInst); // <i>Inserts newInst before pi in pb</i>
1079 </pre>
1080 </div>
1081
1082     <p>Appending to the end of a <tt>BasicBlock</tt> is so common that
1083     the <tt>Instruction</tt> class and <tt>Instruction</tt>-derived
1084     classes provide constructors which take a pointer to a
1085     <tt>BasicBlock</tt> to be appended to. For example code that
1086     looked like: </p>
1087
1088 <div class="doc_code">
1089 <pre>
1090 BasicBlock *pb = ...;
1091 Instruction *newInst = new Instruction(...);
1092
1093 pb-&gt;getInstList().push_back(newInst); // <i>Appends newInst to pb</i>
1094 </pre>
1095 </div>
1096
1097     <p>becomes: </p>
1098
1099 <div class="doc_code">
1100 <pre>
1101 BasicBlock *pb = ...;
1102 Instruction *newInst = new Instruction(..., pb);
1103 </pre>
1104 </div>
1105
1106     <p>which is much cleaner, especially if you are creating
1107     long instruction streams.</p></li>
1108
1109   <li>Insertion into an implicit instruction list
1110
1111     <p><tt>Instruction</tt> instances that are already in <tt>BasicBlock</tt>s
1112     are implicitly associated with an existing instruction list: the instruction
1113     list of the enclosing basic block. Thus, we could have accomplished the same
1114     thing as the above code without being given a <tt>BasicBlock</tt> by doing:
1115     </p>
1116
1117 <div class="doc_code">
1118 <pre>
1119 Instruction *pi = ...;
1120 Instruction *newInst = new Instruction(...);
1121
1122 pi-&gt;getParent()-&gt;getInstList().insert(pi, newInst);
1123 </pre>
1124 </div>
1125
1126     <p>In fact, this sequence of steps occurs so frequently that the
1127     <tt>Instruction</tt> class and <tt>Instruction</tt>-derived classes provide
1128     constructors which take (as a default parameter) a pointer to an
1129     <tt>Instruction</tt> which the newly-created <tt>Instruction</tt> should
1130     precede.  That is, <tt>Instruction</tt> constructors are capable of
1131     inserting the newly-created instance into the <tt>BasicBlock</tt> of a
1132     provided instruction, immediately before that instruction.  Using an
1133     <tt>Instruction</tt> constructor with a <tt>insertBefore</tt> (default)
1134     parameter, the above code becomes:</p>
1135
1136 <div class="doc_code">
1137 <pre>
1138 Instruction* pi = ...;
1139 Instruction* newInst = new Instruction(..., pi);
1140 </pre>
1141 </div>
1142
1143     <p>which is much cleaner, especially if you're creating a lot of
1144     instructions and adding them to <tt>BasicBlock</tt>s.</p></li>
1145 </ul>
1146
1147 </div>
1148
1149 <!--_______________________________________________________________________-->
1150 <div class="doc_subsubsection">
1151   <a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a>
1152 </div>
1153
1154 <div class="doc_text">
1155
1156 <p>Deleting an instruction from an existing sequence of instructions that form a
1157 <a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward. First,
1158 you must have a pointer to the instruction that you wish to delete.  Second, you
1159 need to obtain the pointer to that instruction's basic block. You use the
1160 pointer to the basic block to get its list of instructions and then use the
1161 erase function to remove your instruction. For example:</p>
1162
1163 <div class="doc_code">
1164 <pre>
1165 <a href="#Instruction">Instruction</a> *I = .. ;
1166 <a href="#BasicBlock">BasicBlock</a> *BB = I-&gt;getParent();
1167
1168 BB-&gt;getInstList().erase(I);
1169 </pre>
1170 </div>
1171
1172 </div>
1173
1174 <!--_______________________________________________________________________-->
1175 <div class="doc_subsubsection">
1176   <a name="schanges_replacing">Replacing an <tt>Instruction</tt> with another
1177   <tt>Value</tt></a>
1178 </div>
1179
1180 <div class="doc_text">
1181
1182 <p><i>Replacing individual instructions</i></p>
1183
1184 <p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>"
1185 permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt>
1186 and <tt>ReplaceInstWithInst</tt>.</p>
1187
1188 <h4><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h4>
1189
1190 <ul>
1191   <li><tt>ReplaceInstWithValue</tt>
1192
1193     <p>This function replaces all uses (within a basic block) of a given
1194     instruction with a value, and then removes the original instruction. The
1195     following example illustrates the replacement of the result of a particular
1196     <tt>AllocaInst</tt> that allocates memory for a single integer with a null
1197     pointer to an integer.</p>
1198
1199 <div class="doc_code">
1200 <pre>
1201 AllocaInst* instToReplace = ...;
1202 BasicBlock::iterator ii(instToReplace);
1203
1204 ReplaceInstWithValue(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1205                      Constant::getNullValue(PointerType::get(Type::IntTy)));
1206 </pre></div></li>
1207
1208   <li><tt>ReplaceInstWithInst</tt>
1209
1210     <p>This function replaces a particular instruction with another
1211     instruction. The following example illustrates the replacement of one
1212     <tt>AllocaInst</tt> with another.</p>
1213
1214 <div class="doc_code">
1215 <pre>
1216 AllocaInst* instToReplace = ...;
1217 BasicBlock::iterator ii(instToReplace);
1218
1219 ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1220                     new AllocaInst(Type::IntTy, 0, "ptrToReplacedInt"));
1221 </pre></div></li>
1222 </ul>
1223
1224 <p><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></p>
1225
1226 <p>You can use <tt>Value::replaceAllUsesWith</tt> and
1227 <tt>User::replaceUsesOfWith</tt> to change more than one use at a time.  See the
1228 doxygen documentation for the <a href="/doxygen/structllvm_1_1Value.html">Value Class</a>
1229 and <a href="/doxygen/classllvm_1_1User.html">User Class</a>, respectively, for more
1230 information.</p>
1231
1232 <!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
1233 include/llvm/Transforms/Utils/ especially BasicBlockUtils.h with:
1234 ReplaceInstWithValue, ReplaceInstWithInst -->
1235
1236 </div>
1237
1238 <!-- *********************************************************************** -->
1239 <div class="doc_section">
1240   <a name="advanced">Advanced Topics</a>
1241 </div>
1242 <!-- *********************************************************************** -->
1243
1244 <div class="doc_text">
1245 <p>
1246 This section describes some of the advanced or obscure API's that most clients
1247 do not need to be aware of.  These API's tend manage the inner workings of the
1248 LLVM system, and only need to be accessed in unusual circumstances.
1249 </p>
1250 </div>
1251
1252 <!-- ======================================================================= -->
1253 <div class="doc_subsection">
1254   <a name="TypeResolve">LLVM Type Resolution</a>
1255 </div>
1256
1257 <div class="doc_text">
1258
1259 <p>
1260 The LLVM type system has a very simple goal: allow clients to compare types for
1261 structural equality with a simple pointer comparison (aka a shallow compare).
1262 This goal makes clients much simpler and faster, and is used throughout the LLVM
1263 system.
1264 </p>
1265
1266 <p>
1267 Unfortunately achieving this goal is not a simple matter.  In particular,
1268 recursive types and late resolution of opaque types makes the situation very
1269 difficult to handle.  Fortunately, for the most part, our implementation makes
1270 most clients able to be completely unaware of the nasty internal details.  The
1271 primary case where clients are exposed to the inner workings of it are when
1272 building a recursive type.  In addition to this case, the LLVM bytecode reader,
1273 assembly parser, and linker also have to be aware of the inner workings of this
1274 system.
1275 </p>
1276
1277 <p>
1278 For our purposes below, we need three concepts.  First, an "Opaque Type" is
1279 exactly as defined in the <a href="LangRef.html#t_opaque">language
1280 reference</a>.  Second an "Abstract Type" is any type which includes an
1281 opaque type as part of its type graph (for example "<tt>{ opaque, int }</tt>").
1282 Third, a concrete type is a type that is not an abstract type (e.g. "<tt>[ int,
1283 float }</tt>").
1284 </p>
1285
1286 </div>
1287
1288 <!-- ______________________________________________________________________ -->
1289 <div class="doc_subsubsection">
1290   <a name="BuildRecType">Basic Recursive Type Construction</a>
1291 </div>
1292
1293 <div class="doc_text">
1294
1295 <p>
1296 Because the most common question is "how do I build a recursive type with LLVM",
1297 we answer it now and explain it as we go.  Here we include enough to cause this
1298 to be emitted to an output .ll file:
1299 </p>
1300
1301 <div class="doc_code">
1302 <pre>
1303 %mylist = type { %mylist*, int }
1304 </pre>
1305 </div>
1306
1307 <p>
1308 To build this, use the following LLVM APIs:
1309 </p>
1310
1311 <div class="doc_code">
1312 <pre>
1313 // <i>Create the initial outer struct</i>
1314 <a href="#PATypeHolder">PATypeHolder</a> StructTy = OpaqueType::get();
1315 std::vector&lt;const Type*&gt; Elts;
1316 Elts.push_back(PointerType::get(StructTy));
1317 Elts.push_back(Type::IntTy);
1318 StructType *NewSTy = StructType::get(Elts);
1319
1320 // <i>At this point, NewSTy = "{ opaque*, int }". Tell VMCore that</i>
1321 // <i>the struct and the opaque type are actually the same.</i>
1322 cast&lt;OpaqueType&gt;(StructTy.get())-&gt;<a href="#refineAbstractTypeTo">refineAbstractTypeTo</a>(NewSTy);
1323
1324 // <i>NewSTy is potentially invalidated, but StructTy (a <a href="#PATypeHolder">PATypeHolder</a>) is</i>
1325 // <i>kept up-to-date</i>
1326 NewSTy = cast&lt;StructType&gt;(StructTy.get());
1327
1328 // <i>Add a name for the type to the module symbol table (optional)</i>
1329 MyModule-&gt;addTypeName("mylist", NewSTy);
1330 </pre>
1331 </div>
1332
1333 <p>
1334 This code shows the basic approach used to build recursive types: build a
1335 non-recursive type using 'opaque', then use type unification to close the cycle.
1336 The type unification step is performed by the <tt><a
1337 ref="#refineAbstractTypeTo">refineAbstractTypeTo</a></tt> method, which is
1338 described next.  After that, we describe the <a
1339 href="#PATypeHolder">PATypeHolder class</a>.
1340 </p>
1341
1342 </div>
1343
1344 <!-- ______________________________________________________________________ -->
1345 <div class="doc_subsubsection">
1346   <a name="refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a>
1347 </div>
1348
1349 <div class="doc_text">
1350 <p>
1351 The <tt>refineAbstractTypeTo</tt> method starts the type unification process.
1352 While this method is actually a member of the DerivedType class, it is most
1353 often used on OpaqueType instances.  Type unification is actually a recursive
1354 process.  After unification, types can become structurally isomorphic to
1355 existing types, and all duplicates are deleted (to preserve pointer equality).
1356 </p>
1357
1358 <p>
1359 In the example above, the OpaqueType object is definitely deleted.
1360 Additionally, if there is an "{ \2*, int}" type already created in the system,
1361 the pointer and struct type created are <b>also</b> deleted.  Obviously whenever
1362 a type is deleted, any "Type*" pointers in the program are invalidated.  As
1363 such, it is safest to avoid having <i>any</i> "Type*" pointers to abstract types
1364 live across a call to <tt>refineAbstractTypeTo</tt> (note that non-abstract
1365 types can never move or be deleted).  To deal with this, the <a
1366 href="#PATypeHolder">PATypeHolder</a> class is used to maintain a stable
1367 reference to a possibly refined type, and the <a
1368 href="#AbstractTypeUser">AbstractTypeUser</a> class is used to update more
1369 complex datastructures.
1370 </p>
1371
1372 </div>
1373
1374 <!-- ______________________________________________________________________ -->
1375 <div class="doc_subsubsection">
1376   <a name="PATypeHolder">The PATypeHolder Class</a>
1377 </div>
1378
1379 <div class="doc_text">
1380 <p>
1381 PATypeHolder is a form of a "smart pointer" for Type objects.  When VMCore
1382 happily goes about nuking types that become isomorphic to existing types, it
1383 automatically updates all PATypeHolder objects to point to the new type.  In the
1384 example above, this allows the code to maintain a pointer to the resultant
1385 resolved recursive type, even though the Type*'s are potentially invalidated.
1386 </p>
1387
1388 <p>
1389 PATypeHolder is an extremely light-weight object that uses a lazy union-find
1390 implementation to update pointers.  For example the pointer from a Value to its
1391 Type is maintained by PATypeHolder objects.
1392 </p>
1393
1394 </div>
1395
1396 <!-- ______________________________________________________________________ -->
1397 <div class="doc_subsubsection">
1398   <a name="AbstractTypeUser">The AbstractTypeUser Class</a>
1399 </div>
1400
1401 <div class="doc_text">
1402
1403 <p>
1404 Some data structures need more to perform more complex updates when types get
1405 resolved.  The <a href="#SymbolTable">SymbolTable</a> class, for example, needs
1406 move and potentially merge type planes in its representation when a pointer
1407 changes.</p>
1408
1409 <p>
1410 To support this, a class can derive from the AbstractTypeUser class.  This class
1411 allows it to get callbacks when certain types are resolved.  To register to get
1412 callbacks for a particular type, the DerivedType::{add/remove}AbstractTypeUser
1413 methods can be called on a type.  Note that these methods only work for <i>
1414 abstract</i> types.  Concrete types (those that do not include an opaque objects
1415 somewhere) can never be refined.
1416 </p>
1417 </div>
1418
1419
1420 <!-- ======================================================================= -->
1421 <div class="doc_subsection">
1422   <a name="SymbolTable">The <tt>SymbolTable</tt> class</a>
1423 </div>
1424
1425 <div class="doc_text">
1426 <p>This class provides a symbol table that the <a
1427 href="#Function"><tt>Function</tt></a> and <a href="#Module">
1428 <tt>Module</tt></a> classes use for naming definitions. The symbol table can
1429 provide a name for any <a href="#Value"><tt>Value</tt></a> or <a
1430 href="#Type"><tt>Type</tt></a>.  <tt>SymbolTable</tt> is an abstract data
1431 type. It hides the data it contains and provides access to it through a
1432 controlled interface.</p>
1433
1434 <p>Note that the symbol table class is should not be directly accessed by most
1435 clients.  It should only be used when iteration over the symbol table names
1436 themselves are required, which is very special purpose.  Note that not all LLVM
1437 <a href="#Value">Value</a>s have names, and those without names (i.e. they have
1438 an empty name) do not exist in the symbol table.
1439 </p>
1440
1441 <p>To use the <tt>SymbolTable</tt> well, you need to understand the
1442 structure of the information it holds. The class contains two
1443 <tt>std::map</tt> objects. The first, <tt>pmap</tt>, is a map of
1444 <tt>Type*</tt> to maps of name (<tt>std::string</tt>) to <tt>Value*</tt>.
1445 The second, <tt>tmap</tt>, is a map of names to <tt>Type*</tt>. Thus, Values
1446 are stored in two-dimensions and accessed by <tt>Type</tt> and name. Types,
1447 however, are stored in a single dimension and accessed only by name.</p>
1448
1449 <p>The interface of this class provides three basic types of operations:
1450 <ol>
1451   <li><em>Accessors</em>. Accessors provide read-only access to information
1452   such as finding a value for a name with the
1453   <a href="#SymbolTable_lookup">lookup</a> method.</li>
1454   <li><em>Mutators</em>. Mutators allow the user to add information to the
1455   <tt>SymbolTable</tt> with methods like
1456   <a href="#SymbolTable_insert"><tt>insert</tt></a>.</li>
1457   <li><em>Iterators</em>. Iterators allow the user to traverse the content
1458   of the symbol table in well defined ways, such as the method
1459   <a href="#SymbolTable_type_begin"><tt>type_begin</tt></a>.</li>
1460 </ol>
1461
1462 <h3>Accessors</h3>
1463 <dl>
1464   <dt><tt>Value* lookup(const Type* Ty, const std::string&amp; name) const</tt>:
1465   </dt>
1466   <dd>The <tt>lookup</tt> method searches the type plane given by the
1467   <tt>Ty</tt> parameter for a <tt>Value</tt> with the provided <tt>name</tt>.
1468   If a suitable <tt>Value</tt> is not found, null is returned.</dd>
1469
1470   <dt><tt>Type* lookupType( const std::string&amp; name) const</tt>:</dt>
1471   <dd>The <tt>lookupType</tt> method searches through the types for a
1472   <tt>Type</tt> with the provided <tt>name</tt>. If a suitable <tt>Type</tt>
1473   is not found, null is returned.</dd>
1474
1475   <dt><tt>bool hasTypes() const</tt>:</dt>
1476   <dd>This function returns true if an entry has been made into the type
1477   map.</dd>
1478
1479   <dt><tt>bool isEmpty() const</tt>:</dt>
1480   <dd>This function returns true if both the value and types maps are
1481   empty</dd>
1482 </dl>
1483
1484 <h3>Mutators</h3>
1485 <dl>
1486   <dt><tt>void insert(Value *Val)</tt>:</dt>
1487   <dd>This method adds the provided value to the symbol table.  The Value must
1488   have both a name and a type which are extracted and used to place the value
1489   in the correct type plane under the value's name.</dd>
1490
1491   <dt><tt>void insert(const std::string&amp; Name, Value *Val)</tt>:</dt>
1492   <dd> Inserts a constant or type into the symbol table with the specified
1493   name. There can be a many to one mapping between names and constants
1494   or types.</dd>
1495
1496   <dt><tt>void insert(const std::string&amp; Name, Type *Typ)</tt>:</dt>
1497   <dd> Inserts a type into the symbol table with the specified name. There
1498   can be a many-to-one mapping between names and types. This method
1499   allows a type with an existing entry in the symbol table to get
1500   a new name.</dd>
1501
1502   <dt><tt>void remove(Value* Val)</tt>:</dt>
1503  <dd> This method removes a named value from the symbol table. The
1504   type and name of the Value are extracted from \p N and used to
1505   lookup the Value in the correct type plane. If the Value is
1506   not in the symbol table, this method silently ignores the
1507   request.</dd>
1508
1509   <dt><tt>void remove(Type* Typ)</tt>:</dt>
1510   <dd> This method removes a named type from the symbol table. The
1511   name of the type is extracted from \P T and used to look up
1512   the Type in the type map. If the Type is not in the symbol
1513   table, this method silently ignores the request.</dd>
1514
1515   <dt><tt>Value* remove(const std::string&amp; Name, Value *Val)</tt>:</dt>
1516   <dd> Remove a constant or type with the specified name from the
1517   symbol table.</dd>
1518
1519   <dt><tt>Type* remove(const std::string&amp; Name, Type* T)</tt>:</dt>
1520   <dd> Remove a type with the specified name from the symbol table.
1521   Returns the removed Type.</dd>
1522
1523   <dt><tt>Value *value_remove(const value_iterator&amp; It)</tt>:</dt>
1524   <dd> Removes a specific value from the symbol table.
1525   Returns the removed value.</dd>
1526
1527   <dt><tt>bool strip()</tt>:</dt>
1528   <dd> This method will strip the symbol table of its names leaving
1529   the type and values. </dd>
1530
1531   <dt><tt>void clear()</tt>:</dt>
1532   <dd>Empty the symbol table completely.</dd>
1533 </dl>
1534
1535 <h3>Iteration</h3>
1536 <p>The following functions describe three types of iterators you can obtain
1537 the beginning or end of the sequence for both const and non-const. It is
1538 important to keep track of the different kinds of iterators. There are
1539 three idioms worth pointing out:</p>
1540
1541 <table>
1542   <tr><th>Units</th><th>Iterator</th><th>Idiom</th></tr>
1543   <tr>
1544     <td align="left">Planes Of name/Value maps</td><td>PI</td>
1545     <td align="left"><pre><tt>
1546 for (SymbolTable::plane_const_iterator PI = ST.plane_begin(),
1547      PE = ST.plane_end(); PI != PE; ++PI ) {
1548   PI-&gt;first  // <i>This is the Type* of the plane</i>
1549   PI-&gt;second // <i>This is the SymbolTable::ValueMap of name/Value pairs</i>
1550 }
1551     </tt></pre></td>
1552   </tr>
1553   <tr>
1554     <td align="left">All name/Type Pairs</td><td>TI</td>
1555     <td align="left"><pre><tt>
1556 for (SymbolTable::type_const_iterator TI = ST.type_begin(),
1557      TE = ST.type_end(); TI != TE; ++TI ) {
1558   TI-&gt;first  // <i>This is the name of the type</i>
1559   TI-&gt;second // <i>This is the Type* value associated with the name</i>
1560 }
1561     </tt></pre></td>
1562   </tr>
1563   <tr>
1564     <td align="left">name/Value pairs in a plane</td><td>VI</td>
1565     <td align="left"><pre><tt>
1566 for (SymbolTable::value_const_iterator VI = ST.value_begin(SomeType),
1567      VE = ST.value_end(SomeType); VI != VE; ++VI ) {
1568   VI-&gt;first  // <i>This is the name of the Value</i>
1569   VI-&gt;second // <i>This is the Value* value associated with the name</i>
1570 }
1571     </tt></pre></td>
1572   </tr>
1573 </table>
1574
1575 <p>Using the recommended iterator names and idioms will help you avoid
1576 making mistakes. Of particular note, make sure that whenever you use
1577 value_begin(SomeType) that you always compare the resulting iterator
1578 with value_end(SomeType) not value_end(SomeOtherType) or else you
1579 will loop infinitely.</p>
1580
1581 <dl>
1582
1583   <dt><tt>plane_iterator plane_begin()</tt>:</dt>
1584   <dd>Get an iterator that starts at the beginning of the type planes.
1585   The iterator will iterate over the Type/ValueMap pairs in the
1586   type planes. </dd>
1587
1588   <dt><tt>plane_const_iterator plane_begin() const</tt>:</dt>
1589   <dd>Get a const_iterator that starts at the beginning of the type
1590   planes.  The iterator will iterate over the Type/ValueMap pairs
1591   in the type planes. </dd>
1592
1593   <dt><tt>plane_iterator plane_end()</tt>:</dt>
1594   <dd>Get an iterator at the end of the type planes. This serves as
1595   the marker for end of iteration over the type planes.</dd>
1596
1597   <dt><tt>plane_const_iterator plane_end() const</tt>:</dt>
1598   <dd>Get a const_iterator at the end of the type planes. This serves as
1599   the marker for end of iteration over the type planes.</dd>
1600
1601   <dt><tt>value_iterator value_begin(const Type *Typ)</tt>:</dt>
1602   <dd>Get an iterator that starts at the beginning of a type plane.
1603   The iterator will iterate over the name/value pairs in the type plane.
1604   Note: The type plane must already exist before using this.</dd>
1605
1606   <dt><tt>value_const_iterator value_begin(const Type *Typ) const</tt>:</dt>
1607   <dd>Get a const_iterator that starts at the beginning of a type plane.
1608   The iterator will iterate over the name/value pairs in the type plane.
1609   Note: The type plane must already exist before using this.</dd>
1610
1611   <dt><tt>value_iterator value_end(const Type *Typ)</tt>:</dt>
1612   <dd>Get an iterator to the end of a type plane. This serves as the marker
1613   for end of iteration of the type plane.
1614   Note: The type plane must already exist before using this.</dd>
1615
1616   <dt><tt>value_const_iterator value_end(const Type *Typ) const</tt>:</dt>
1617   <dd>Get a const_iterator to the end of a type plane. This serves as the
1618   marker for end of iteration of the type plane.
1619   Note: the type plane must already exist before using this.</dd>
1620
1621   <dt><tt>type_iterator type_begin()</tt>:</dt>
1622   <dd>Get an iterator to the start of the name/Type map.</dd>
1623
1624   <dt><tt>type_const_iterator type_begin() cons</tt>:</dt>
1625   <dd> Get a const_iterator to the start of the name/Type map.</dd>
1626
1627   <dt><tt>type_iterator type_end()</tt>:</dt>
1628   <dd>Get an iterator to the end of the name/Type map. This serves as the
1629   marker for end of iteration of the types.</dd>
1630
1631   <dt><tt>type_const_iterator type_end() const</tt>:</dt>
1632   <dd>Get a const-iterator to the end of the name/Type map. This serves
1633   as the marker for end of iteration of the types.</dd>
1634
1635   <dt><tt>plane_const_iterator find(const Type* Typ ) const</tt>:</dt>
1636   <dd>This method returns a plane_const_iterator for iteration over
1637   the type planes starting at a specific plane, given by \p Ty.</dd>
1638
1639   <dt><tt>plane_iterator find( const Type* Typ </tt>:</dt>
1640   <dd>This method returns a plane_iterator for iteration over the
1641   type planes starting at a specific plane, given by \p Ty.</dd>
1642
1643 </dl>
1644 </div>
1645
1646
1647
1648 <!-- *********************************************************************** -->
1649 <div class="doc_section">
1650   <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a>
1651 </div>
1652 <!-- *********************************************************************** -->
1653
1654 <div class="doc_text">
1655
1656 <p>The Core LLVM classes are the primary means of representing the program
1657 being inspected or transformed.  The core LLVM classes are defined in
1658 header files in the <tt>include/llvm/</tt> directory, and implemented in
1659 the <tt>lib/VMCore</tt> directory.</p>
1660
1661 </div>
1662
1663 <!-- ======================================================================= -->
1664 <div class="doc_subsection">
1665   <a name="Value">The <tt>Value</tt> class</a>
1666 </div>
1667
1668 <div>
1669
1670 <p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt>
1671 <br>
1672 doxygen info: <a href="/doxygen/structllvm_1_1Value.html">Value Class</a></p>
1673
1674 <p>The <tt>Value</tt> class is the most important class in the LLVM Source
1675 base.  It represents a typed value that may be used (among other things) as an
1676 operand to an instruction.  There are many different types of <tt>Value</tt>s,
1677 such as <a href="#Constant"><tt>Constant</tt></a>s,<a
1678 href="#Argument"><tt>Argument</tt></a>s. Even <a
1679 href="#Instruction"><tt>Instruction</tt></a>s and <a
1680 href="#Function"><tt>Function</tt></a>s are <tt>Value</tt>s.</p>
1681
1682 <p>A particular <tt>Value</tt> may be used many times in the LLVM representation
1683 for a program.  For example, an incoming argument to a function (represented
1684 with an instance of the <a href="#Argument">Argument</a> class) is "used" by
1685 every instruction in the function that references the argument.  To keep track
1686 of this relationship, the <tt>Value</tt> class keeps a list of all of the <a
1687 href="#User"><tt>User</tt></a>s that is using it (the <a
1688 href="#User"><tt>User</tt></a> class is a base class for all nodes in the LLVM
1689 graph that can refer to <tt>Value</tt>s).  This use list is how LLVM represents
1690 def-use information in the program, and is accessible through the <tt>use_</tt>*
1691 methods, shown below.</p>
1692
1693 <p>Because LLVM is a typed representation, every LLVM <tt>Value</tt> is typed,
1694 and this <a href="#Type">Type</a> is available through the <tt>getType()</tt>
1695 method. In addition, all LLVM values can be named.  The "name" of the
1696 <tt>Value</tt> is a symbolic string printed in the LLVM code:</p>
1697
1698 <div class="doc_code">
1699 <pre>
1700 %<b>foo</b> = add int 1, 2
1701 </pre>
1702 </div>
1703
1704 <p><a name="#nameWarning">The name of this instruction is "foo".</a> <b>NOTE</b>
1705 that the name of any value may be missing (an empty string), so names should
1706 <b>ONLY</b> be used for debugging (making the source code easier to read,
1707 debugging printouts), they should not be used to keep track of values or map
1708 between them.  For this purpose, use a <tt>std::map</tt> of pointers to the
1709 <tt>Value</tt> itself instead.</p>
1710
1711 <p>One important aspect of LLVM is that there is no distinction between an SSA
1712 variable and the operation that produces it.  Because of this, any reference to
1713 the value produced by an instruction (or the value available as an incoming
1714 argument, for example) is represented as a direct pointer to the instance of
1715 the class that
1716 represents this value.  Although this may take some getting used to, it
1717 simplifies the representation and makes it easier to manipulate.</p>
1718
1719 </div>
1720
1721 <!-- _______________________________________________________________________ -->
1722 <div class="doc_subsubsection">
1723   <a name="m_Value">Important Public Members of the <tt>Value</tt> class</a>
1724 </div>
1725
1726 <div class="doc_text">
1727
1728 <ul>
1729   <li><tt>Value::use_iterator</tt> - Typedef for iterator over the
1730 use-list<br>
1731     <tt>Value::use_const_iterator</tt> - Typedef for const_iterator over
1732 the use-list<br>
1733     <tt>unsigned use_size()</tt> - Returns the number of users of the
1734 value.<br>
1735     <tt>bool use_empty()</tt> - Returns true if there are no users.<br>
1736     <tt>use_iterator use_begin()</tt> - Get an iterator to the start of
1737 the use-list.<br>
1738     <tt>use_iterator use_end()</tt> - Get an iterator to the end of the
1739 use-list.<br>
1740     <tt><a href="#User">User</a> *use_back()</tt> - Returns the last
1741 element in the list.
1742     <p> These methods are the interface to access the def-use
1743 information in LLVM.  As with all other iterators in LLVM, the naming
1744 conventions follow the conventions defined by the <a href="#stl">STL</a>.</p>
1745   </li>
1746   <li><tt><a href="#Type">Type</a> *getType() const</tt>
1747     <p>This method returns the Type of the Value.</p>
1748   </li>
1749   <li><tt>bool hasName() const</tt><br>
1750     <tt>std::string getName() const</tt><br>
1751     <tt>void setName(const std::string &amp;Name)</tt>
1752     <p> This family of methods is used to access and assign a name to a <tt>Value</tt>,
1753 be aware of the <a href="#nameWarning">precaution above</a>.</p>
1754   </li>
1755   <li><tt>void replaceAllUsesWith(Value *V)</tt>
1756
1757     <p>This method traverses the use list of a <tt>Value</tt> changing all <a
1758     href="#User"><tt>User</tt>s</a> of the current value to refer to
1759     "<tt>V</tt>" instead.  For example, if you detect that an instruction always
1760     produces a constant value (for example through constant folding), you can
1761     replace all uses of the instruction with the constant like this:</p>
1762
1763 <div class="doc_code">
1764 <pre>
1765 Inst-&gt;replaceAllUsesWith(ConstVal);
1766 </pre>
1767 </div>
1768
1769 </ul>
1770
1771 </div>
1772
1773 <!-- ======================================================================= -->
1774 <div class="doc_subsection">
1775   <a name="User">The <tt>User</tt> class</a>
1776 </div>
1777
1778 <div class="doc_text">
1779
1780 <p>
1781 <tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br>
1782 doxygen info: <a href="/doxygen/classllvm_1_1User.html">User Class</a><br>
1783 Superclass: <a href="#Value"><tt>Value</tt></a></p>
1784
1785 <p>The <tt>User</tt> class is the common base class of all LLVM nodes that may
1786 refer to <a href="#Value"><tt>Value</tt></a>s.  It exposes a list of "Operands"
1787 that are all of the <a href="#Value"><tt>Value</tt></a>s that the User is
1788 referring to.  The <tt>User</tt> class itself is a subclass of
1789 <tt>Value</tt>.</p>
1790
1791 <p>The operands of a <tt>User</tt> point directly to the LLVM <a
1792 href="#Value"><tt>Value</tt></a> that it refers to.  Because LLVM uses Static
1793 Single Assignment (SSA) form, there can only be one definition referred to,
1794 allowing this direct connection.  This connection provides the use-def
1795 information in LLVM.</p>
1796
1797 </div>
1798
1799 <!-- _______________________________________________________________________ -->
1800 <div class="doc_subsubsection">
1801   <a name="m_User">Important Public Members of the <tt>User</tt> class</a>
1802 </div>
1803
1804 <div class="doc_text">
1805
1806 <p>The <tt>User</tt> class exposes the operand list in two ways: through
1807 an index access interface and through an iterator based interface.</p>
1808
1809 <ul>
1810   <li><tt>Value *getOperand(unsigned i)</tt><br>
1811     <tt>unsigned getNumOperands()</tt>
1812     <p> These two methods expose the operands of the <tt>User</tt> in a
1813 convenient form for direct access.</p></li>
1814
1815   <li><tt>User::op_iterator</tt> - Typedef for iterator over the operand
1816 list<br>
1817     <tt>op_iterator op_begin()</tt> - Get an iterator to the start of
1818 the operand list.<br>
1819     <tt>op_iterator op_end()</tt> - Get an iterator to the end of the
1820 operand list.
1821     <p> Together, these methods make up the iterator based interface to
1822 the operands of a <tt>User</tt>.</p></li>
1823 </ul>
1824
1825 </div>
1826
1827 <!-- ======================================================================= -->
1828 <div class="doc_subsection">
1829   <a name="Instruction">The <tt>Instruction</tt> class</a>
1830 </div>
1831
1832 <div class="doc_text">
1833
1834 <p><tt>#include "</tt><tt><a
1835 href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br>
1836 doxygen info: <a href="/doxygen/classllvm_1_1Instruction.html">Instruction Class</a><br>
1837 Superclasses: <a href="#User"><tt>User</tt></a>, <a
1838 href="#Value"><tt>Value</tt></a></p>
1839
1840 <p>The <tt>Instruction</tt> class is the common base class for all LLVM
1841 instructions.  It provides only a few methods, but is a very commonly used
1842 class.  The primary data tracked by the <tt>Instruction</tt> class itself is the
1843 opcode (instruction type) and the parent <a
1844 href="#BasicBlock"><tt>BasicBlock</tt></a> the <tt>Instruction</tt> is embedded
1845 into.  To represent a specific type of instruction, one of many subclasses of
1846 <tt>Instruction</tt> are used.</p>
1847
1848 <p> Because the <tt>Instruction</tt> class subclasses the <a
1849 href="#User"><tt>User</tt></a> class, its operands can be accessed in the same
1850 way as for other <a href="#User"><tt>User</tt></a>s (with the
1851 <tt>getOperand()</tt>/<tt>getNumOperands()</tt> and
1852 <tt>op_begin()</tt>/<tt>op_end()</tt> methods).</p> <p> An important file for
1853 the <tt>Instruction</tt> class is the <tt>llvm/Instruction.def</tt> file. This
1854 file contains some meta-data about the various different types of instructions
1855 in LLVM.  It describes the enum values that are used as opcodes (for example
1856 <tt>Instruction::Add</tt> and <tt>Instruction::ICmp</tt>), as well as the
1857 concrete sub-classes of <tt>Instruction</tt> that implement the instruction (for
1858 example <tt><a href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
1859 href="#CmpInst">CmpInst</a></tt>).  Unfortunately, the use of macros in
1860 this file confuses doxygen, so these enum values don't show up correctly in the
1861 <a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p>
1862
1863 </div>
1864
1865 <!-- _______________________________________________________________________ -->
1866 <div class="doc_subsubsection">
1867   <a name="s_Instruction">Important Subclasses of the <tt>Instruction</tt>
1868   class</a>
1869 </div>
1870 <div class="doc_text">
1871   <ul>
1872     <li><tt><a name="BinaryOperator">BinaryOperator</a></tt>
1873     <p>This subclasses represents all two operand instructions whose operands
1874     must be the same type, except for the comparison instructions.</p></li>
1875     <li><tt><a name="CastInst">CastInst</a></tt>
1876     <p>This subclass is the parent of the 12 casting instructions. It provides
1877     common operations on cast instructions.</p>
1878     <li><tt><a name="CmpInst">CmpInst</a></tt>
1879     <p>This subclass respresents the two comparison instructions,
1880     <a href="LangRef.html#i_icmp">ICmpInst</a> (integer opreands), and
1881     <a href="LangRef.html#i_fcmp">FCmpInst</a> (floating point operands).</p>
1882     <li><tt><a name="TerminatorInst">TerminatorInst</a></tt>
1883     <p>This subclass is the parent of all terminator instructions (those which
1884     can terminate a block).</p>
1885   </ul>
1886   </div>
1887
1888 <!-- _______________________________________________________________________ -->
1889 <div class="doc_subsubsection">
1890   <a name="m_Instruction">Important Public Members of the <tt>Instruction</tt>
1891   class</a>
1892 </div>
1893
1894 <div class="doc_text">
1895
1896 <ul>
1897   <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt>
1898     <p>Returns the <a href="#BasicBlock"><tt>BasicBlock</tt></a> that
1899 this  <tt>Instruction</tt> is embedded into.</p></li>
1900   <li><tt>bool mayWriteToMemory()</tt>
1901     <p>Returns true if the instruction writes to memory, i.e. it is a
1902       <tt>call</tt>,<tt>free</tt>,<tt>invoke</tt>, or <tt>store</tt>.</p></li>
1903   <li><tt>unsigned getOpcode()</tt>
1904     <p>Returns the opcode for the <tt>Instruction</tt>.</p></li>
1905   <li><tt><a href="#Instruction">Instruction</a> *clone() const</tt>
1906     <p>Returns another instance of the specified instruction, identical
1907 in all ways to the original except that the instruction has no parent
1908 (ie it's not embedded into a <a href="#BasicBlock"><tt>BasicBlock</tt></a>),
1909 and it has no name</p></li>
1910 </ul>
1911
1912 </div>
1913
1914 <!-- ======================================================================= -->
1915 <div class="doc_subsection">
1916   <a name="BasicBlock">The <tt>BasicBlock</tt> class</a>
1917 </div>
1918
1919 <div class="doc_text">
1920
1921 <p><tt>#include "<a
1922 href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
1923 doxygen info: <a href="/doxygen/structllvm_1_1BasicBlock.html">BasicBlock
1924 Class</a><br>
1925 Superclass: <a href="#Value"><tt>Value</tt></a></p>
1926
1927 <p>This class represents a single entry multiple exit section of the code,
1928 commonly known as a basic block by the compiler community.  The
1929 <tt>BasicBlock</tt> class maintains a list of <a
1930 href="#Instruction"><tt>Instruction</tt></a>s, which form the body of the block.
1931 Matching the language definition, the last element of this list of instructions
1932 is always a terminator instruction (a subclass of the <a
1933 href="#TerminatorInst"><tt>TerminatorInst</tt></a> class).</p>
1934
1935 <p>In addition to tracking the list of instructions that make up the block, the
1936 <tt>BasicBlock</tt> class also keeps track of the <a
1937 href="#Function"><tt>Function</tt></a> that it is embedded into.</p>
1938
1939 <p>Note that <tt>BasicBlock</tt>s themselves are <a
1940 href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions
1941 like branches and can go in the switch tables. <tt>BasicBlock</tt>s have type
1942 <tt>label</tt>.</p>
1943
1944 </div>
1945
1946 <!-- _______________________________________________________________________ -->
1947 <div class="doc_subsubsection">
1948   <a name="m_BasicBlock">Important Public Members of the <tt>BasicBlock</tt>
1949   class</a>
1950 </div>
1951
1952 <div class="doc_text">
1953
1954 <ul>
1955
1956 <li><tt>BasicBlock(const std::string &amp;Name = "", </tt><tt><a
1957  href="#Function">Function</a> *Parent = 0)</tt>
1958
1959 <p>The <tt>BasicBlock</tt> constructor is used to create new basic blocks for
1960 insertion into a function.  The constructor optionally takes a name for the new
1961 block, and a <a href="#Function"><tt>Function</tt></a> to insert it into.  If
1962 the <tt>Parent</tt> parameter is specified, the new <tt>BasicBlock</tt> is
1963 automatically inserted at the end of the specified <a
1964 href="#Function"><tt>Function</tt></a>, if not specified, the BasicBlock must be
1965 manually inserted into the <a href="#Function"><tt>Function</tt></a>.</p></li>
1966
1967 <li><tt>BasicBlock::iterator</tt> - Typedef for instruction list iterator<br>
1968 <tt>BasicBlock::const_iterator</tt> - Typedef for const_iterator.<br>
1969 <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
1970 <tt>size()</tt>, <tt>empty()</tt>
1971 STL-style functions for accessing the instruction list.
1972
1973 <p>These methods and typedefs are forwarding functions that have the same
1974 semantics as the standard library methods of the same names.  These methods
1975 expose the underlying instruction list of a basic block in a way that is easy to
1976 manipulate.  To get the full complement of container operations (including
1977 operations to update the list), you must use the <tt>getInstList()</tt>
1978 method.</p></li>
1979
1980 <li><tt>BasicBlock::InstListType &amp;getInstList()</tt>
1981
1982 <p>This method is used to get access to the underlying container that actually
1983 holds the Instructions.  This method must be used when there isn't a forwarding
1984 function in the <tt>BasicBlock</tt> class for the operation that you would like
1985 to perform.  Because there are no forwarding functions for "updating"
1986 operations, you need to use this if you want to update the contents of a
1987 <tt>BasicBlock</tt>.</p></li>
1988
1989 <li><tt><a href="#Function">Function</a> *getParent()</tt>
1990
1991 <p> Returns a pointer to <a href="#Function"><tt>Function</tt></a> the block is
1992 embedded into, or a null pointer if it is homeless.</p></li>
1993
1994 <li><tt><a href="#TerminatorInst">TerminatorInst</a> *getTerminator()</tt>
1995
1996 <p> Returns a pointer to the terminator instruction that appears at the end of
1997 the <tt>BasicBlock</tt>.  If there is no terminator instruction, or if the last
1998 instruction in the block is not a terminator, then a null pointer is
1999 returned.</p></li>
2000
2001 </ul>
2002
2003 </div>
2004
2005 <!-- ======================================================================= -->
2006 <div class="doc_subsection">
2007   <a name="GlobalValue">The <tt>GlobalValue</tt> class</a>
2008 </div>
2009
2010 <div class="doc_text">
2011
2012 <p><tt>#include "<a
2013 href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
2014 doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
2015 Class</a><br>
2016 Superclasses: <a href="#Constant"><tt>Constant</tt></a>,
2017 <a href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
2018
2019 <p>Global values (<a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
2020 href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
2021 visible in the bodies of all <a href="#Function"><tt>Function</tt></a>s.
2022 Because they are visible at global scope, they are also subject to linking with
2023 other globals defined in different translation units.  To control the linking
2024 process, <tt>GlobalValue</tt>s know their linkage rules. Specifically,
2025 <tt>GlobalValue</tt>s know whether they have internal or external linkage, as
2026 defined by the <tt>LinkageTypes</tt> enumeration.</p>
2027
2028 <p>If a <tt>GlobalValue</tt> has internal linkage (equivalent to being
2029 <tt>static</tt> in C), it is not visible to code outside the current translation
2030 unit, and does not participate in linking.  If it has external linkage, it is
2031 visible to external code, and does participate in linking.  In addition to
2032 linkage information, <tt>GlobalValue</tt>s keep track of which <a
2033 href="#Module"><tt>Module</tt></a> they are currently part of.</p>
2034
2035 <p>Because <tt>GlobalValue</tt>s are memory objects, they are always referred to
2036 by their <b>address</b>. As such, the <a href="#Type"><tt>Type</tt></a> of a
2037 global is always a pointer to its contents. It is important to remember this
2038 when using the <tt>GetElementPtrInst</tt> instruction because this pointer must
2039 be dereferenced first. For example, if you have a <tt>GlobalVariable</tt> (a
2040 subclass of <tt>GlobalValue)</tt> that is an array of 24 ints, type <tt>[24 x
2041 int]</tt>, then the <tt>GlobalVariable</tt> is a pointer to that array. Although
2042 the address of the first element of this array and the value of the
2043 <tt>GlobalVariable</tt> are the same, they have different types. The
2044 <tt>GlobalVariable</tt>'s type is <tt>[24 x int]</tt>. The first element's type
2045 is <tt>int.</tt> Because of this, accessing a global value requires you to
2046 dereference the pointer with <tt>GetElementPtrInst</tt> first, then its elements
2047 can be accessed. This is explained in the <a href="LangRef.html#globalvars">LLVM
2048 Language Reference Manual</a>.</p>
2049
2050 </div>
2051
2052 <!-- _______________________________________________________________________ -->
2053 <div class="doc_subsubsection">
2054   <a name="m_GlobalValue">Important Public Members of the <tt>GlobalValue</tt>
2055   class</a>
2056 </div>
2057
2058 <div class="doc_text">
2059
2060 <ul>
2061   <li><tt>bool hasInternalLinkage() const</tt><br>
2062     <tt>bool hasExternalLinkage() const</tt><br>
2063     <tt>void setInternalLinkage(bool HasInternalLinkage)</tt>
2064     <p> These methods manipulate the linkage characteristics of the <tt>GlobalValue</tt>.</p>
2065     <p> </p>
2066   </li>
2067   <li><tt><a href="#Module">Module</a> *getParent()</tt>
2068     <p> This returns the <a href="#Module"><tt>Module</tt></a> that the
2069 GlobalValue is currently embedded into.</p></li>
2070 </ul>
2071
2072 </div>
2073
2074 <!-- ======================================================================= -->
2075 <div class="doc_subsection">
2076   <a name="Function">The <tt>Function</tt> class</a>
2077 </div>
2078
2079 <div class="doc_text">
2080
2081 <p><tt>#include "<a
2082 href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
2083 info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
2084 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
2085 <a href="#Constant"><tt>Constant</tt></a>,
2086 <a href="#User"><tt>User</tt></a>,
2087 <a href="#Value"><tt>Value</tt></a></p>
2088
2089 <p>The <tt>Function</tt> class represents a single procedure in LLVM.  It is
2090 actually one of the more complex classes in the LLVM heirarchy because it must
2091 keep track of a large amount of data.  The <tt>Function</tt> class keeps track
2092 of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal
2093 <a href="#Argument"><tt>Argument</tt></a>s, and a
2094 <a href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
2095
2096 <p>The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most
2097 commonly used part of <tt>Function</tt> objects.  The list imposes an implicit
2098 ordering of the blocks in the function, which indicate how the code will be
2099 layed out by the backend.  Additionally, the first <a
2100 href="#BasicBlock"><tt>BasicBlock</tt></a> is the implicit entry node for the
2101 <tt>Function</tt>.  It is not legal in LLVM to explicitly branch to this initial
2102 block.  There are no implicit exit nodes, and in fact there may be multiple exit
2103 nodes from a single <tt>Function</tt>.  If the <a
2104 href="#BasicBlock"><tt>BasicBlock</tt></a> list is empty, this indicates that
2105 the <tt>Function</tt> is actually a function declaration: the actual body of the
2106 function hasn't been linked in yet.</p>
2107
2108 <p>In addition to a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, the
2109 <tt>Function</tt> class also keeps track of the list of formal <a
2110 href="#Argument"><tt>Argument</tt></a>s that the function receives.  This
2111 container manages the lifetime of the <a href="#Argument"><tt>Argument</tt></a>
2112 nodes, just like the <a href="#BasicBlock"><tt>BasicBlock</tt></a> list does for
2113 the <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.</p>
2114
2115 <p>The <a href="#SymbolTable"><tt>SymbolTable</tt></a> is a very rarely used
2116 LLVM feature that is only used when you have to look up a value by name.  Aside
2117 from that, the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is used
2118 internally to make sure that there are not conflicts between the names of <a
2119 href="#Instruction"><tt>Instruction</tt></a>s, <a
2120 href="#BasicBlock"><tt>BasicBlock</tt></a>s, or <a
2121 href="#Argument"><tt>Argument</tt></a>s in the function body.</p>
2122
2123 <p>Note that <tt>Function</tt> is a <a href="#GlobalValue">GlobalValue</a>
2124 and therefore also a <a href="#Constant">Constant</a>. The value of the function
2125 is its address (after linking) which is guaranteed to be constant.</p>
2126 </div>
2127
2128 <!-- _______________________________________________________________________ -->
2129 <div class="doc_subsubsection">
2130   <a name="m_Function">Important Public Members of the <tt>Function</tt>
2131   class</a>
2132 </div>
2133
2134 <div class="doc_text">
2135
2136 <ul>
2137   <li><tt>Function(const </tt><tt><a href="#FunctionType">FunctionType</a>
2138   *Ty, LinkageTypes Linkage, const std::string &amp;N = "", Module* Parent = 0)</tt>
2139
2140     <p>Constructor used when you need to create new <tt>Function</tt>s to add
2141     the the program.  The constructor must specify the type of the function to
2142     create and what type of linkage the function should have. The <a
2143     href="#FunctionType"><tt>FunctionType</tt></a> argument
2144     specifies the formal arguments and return value for the function. The same
2145     <a href="#FunctionTypel"><tt>FunctionType</tt></a> value can be used to
2146     create multiple functions. The <tt>Parent</tt> argument specifies the Module
2147     in which the function is defined. If this argument is provided, the function
2148     will automatically be inserted into that module's list of
2149     functions.</p></li>
2150
2151   <li><tt>bool isExternal()</tt>
2152
2153     <p>Return whether or not the <tt>Function</tt> has a body defined.  If the
2154     function is "external", it does not have a body, and thus must be resolved
2155     by linking with a function defined in a different translation unit.</p></li>
2156
2157   <li><tt>Function::iterator</tt> - Typedef for basic block list iterator<br>
2158     <tt>Function::const_iterator</tt> - Typedef for const_iterator.<br>
2159
2160     <tt>begin()</tt>, <tt>end()</tt>
2161     <tt>size()</tt>, <tt>empty()</tt>
2162
2163     <p>These are forwarding methods that make it easy to access the contents of
2164     a <tt>Function</tt> object's <a href="#BasicBlock"><tt>BasicBlock</tt></a>
2165     list.</p></li>
2166
2167   <li><tt>Function::BasicBlockListType &amp;getBasicBlockList()</tt>
2168
2169     <p>Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.  This
2170     is necessary to use when you need to update the list or perform a complex
2171     action that doesn't have a forwarding method.</p></li>
2172
2173   <li><tt>Function::arg_iterator</tt> - Typedef for the argument list
2174 iterator<br>
2175     <tt>Function::const_arg_iterator</tt> - Typedef for const_iterator.<br>
2176
2177     <tt>arg_begin()</tt>, <tt>arg_end()</tt>
2178     <tt>arg_size()</tt>, <tt>arg_empty()</tt>
2179
2180     <p>These are forwarding methods that make it easy to access the contents of
2181     a <tt>Function</tt> object's <a href="#Argument"><tt>Argument</tt></a>
2182     list.</p></li>
2183
2184   <li><tt>Function::ArgumentListType &amp;getArgumentList()</tt>
2185
2186     <p>Returns the list of <a href="#Argument"><tt>Argument</tt></a>s.  This is
2187     necessary to use when you need to update the list or perform a complex
2188     action that doesn't have a forwarding method.</p></li>
2189
2190   <li><tt><a href="#BasicBlock">BasicBlock</a> &amp;getEntryBlock()</tt>
2191
2192     <p>Returns the entry <a href="#BasicBlock"><tt>BasicBlock</tt></a> for the
2193     function.  Because the entry block for the function is always the first
2194     block, this returns the first block of the <tt>Function</tt>.</p></li>
2195
2196   <li><tt><a href="#Type">Type</a> *getReturnType()</tt><br>
2197     <tt><a href="#FunctionType">FunctionType</a> *getFunctionType()</tt>
2198
2199     <p>This traverses the <a href="#Type"><tt>Type</tt></a> of the
2200     <tt>Function</tt> and returns the return type of the function, or the <a
2201     href="#FunctionType"><tt>FunctionType</tt></a> of the actual
2202     function.</p></li>
2203
2204   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
2205
2206     <p> Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2207     for this <tt>Function</tt>.</p></li>
2208 </ul>
2209
2210 </div>
2211
2212 <!-- ======================================================================= -->
2213 <div class="doc_subsection">
2214   <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a>
2215 </div>
2216
2217 <div class="doc_text">
2218
2219 <p><tt>#include "<a
2220 href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt>
2221 <br>
2222 doxygen info: <a href="/doxygen/classllvm_1_1GlobalVariable.html">GlobalVariable
2223  Class</a><br>
2224 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
2225 <a href="#Constant"><tt>Constant</tt></a>,
2226 <a href="#User"><tt>User</tt></a>,
2227 <a href="#Value"><tt>Value</tt></a></p>
2228
2229 <p>Global variables are represented with the (suprise suprise)
2230 <tt>GlobalVariable</tt> class. Like functions, <tt>GlobalVariable</tt>s are also
2231 subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such are
2232 always referenced by their address (global values must live in memory, so their
2233 "name" refers to their constant address). See
2234 <a href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this.  Global
2235 variables may have an initial value (which must be a
2236 <a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer,
2237 they may be marked as "constant" themselves (indicating that their contents
2238 never change at runtime).</p>
2239 </div>
2240
2241 <!-- _______________________________________________________________________ -->
2242 <div class="doc_subsubsection">
2243   <a name="m_GlobalVariable">Important Public Members of the
2244   <tt>GlobalVariable</tt> class</a>
2245 </div>
2246
2247 <div class="doc_text">
2248
2249 <ul>
2250   <li><tt>GlobalVariable(const </tt><tt><a href="#Type">Type</a> *Ty, bool
2251   isConstant, LinkageTypes&amp; Linkage, <a href="#Constant">Constant</a>
2252   *Initializer = 0, const std::string &amp;Name = "", Module* Parent = 0)</tt>
2253
2254     <p>Create a new global variable of the specified type. If
2255     <tt>isConstant</tt> is true then the global variable will be marked as
2256     unchanging for the program. The Linkage parameter specifies the type of
2257     linkage (internal, external, weak, linkonce, appending) for the variable. If
2258     the linkage is InternalLinkage, WeakLinkage, or LinkOnceLinkage,&nbsp; then
2259     the resultant global variable will have internal linkage.  AppendingLinkage
2260     concatenates together all instances (in different translation units) of the
2261     variable into a single variable but is only applicable to arrays.  &nbsp;See
2262     the <a href="LangRef.html#modulestructure">LLVM Language Reference</a> for
2263     further details on linkage types. Optionally an initializer, a name, and the
2264     module to put the variable into may be specified for the global variable as
2265     well.</p></li>
2266
2267   <li><tt>bool isConstant() const</tt>
2268
2269     <p>Returns true if this is a global variable that is known not to
2270     be modified at runtime.</p></li>
2271
2272   <li><tt>bool hasInitializer()</tt>
2273
2274     <p>Returns true if this <tt>GlobalVariable</tt> has an intializer.</p></li>
2275
2276   <li><tt><a href="#Constant">Constant</a> *getInitializer()</tt>
2277
2278     <p>Returns the intial value for a <tt>GlobalVariable</tt>.  It is not legal
2279     to call this method if there is no initializer.</p></li>
2280 </ul>
2281
2282 </div>
2283
2284 <!-- ======================================================================= -->
2285 <div class="doc_subsection">
2286   <a name="Module">The <tt>Module</tt> class</a>
2287 </div>
2288
2289 <div class="doc_text">
2290
2291 <p><tt>#include "<a
2292 href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info:
2293 <a href="/doxygen/classllvm_1_1Module.html">Module Class</a></p>
2294
2295 <p>The <tt>Module</tt> class represents the top level structure present in LLVM
2296 programs.  An LLVM module is effectively either a translation unit of the
2297 original program or a combination of several translation units merged by the
2298 linker.  The <tt>Module</tt> class keeps track of a list of <a
2299 href="#Function"><tt>Function</tt></a>s, a list of <a
2300 href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a
2301 href="#SymbolTable"><tt>SymbolTable</tt></a>.  Additionally, it contains a few
2302 helpful member functions that try to make common operations easy.</p>
2303
2304 </div>
2305
2306 <!-- _______________________________________________________________________ -->
2307 <div class="doc_subsubsection">
2308   <a name="m_Module">Important Public Members of the <tt>Module</tt> class</a>
2309 </div>
2310
2311 <div class="doc_text">
2312
2313 <ul>
2314   <li><tt>Module::Module(std::string name = "")</tt></li>
2315 </ul>
2316
2317 <p>Constructing a <a href="#Module">Module</a> is easy. You can optionally
2318 provide a name for it (probably based on the name of the translation unit).</p>
2319
2320 <ul>
2321   <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
2322     <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>
2323
2324     <tt>begin()</tt>, <tt>end()</tt>
2325     <tt>size()</tt>, <tt>empty()</tt>
2326
2327     <p>These are forwarding methods that make it easy to access the contents of
2328     a <tt>Module</tt> object's <a href="#Function"><tt>Function</tt></a>
2329     list.</p></li>
2330
2331   <li><tt>Module::FunctionListType &amp;getFunctionList()</tt>
2332
2333     <p> Returns the list of <a href="#Function"><tt>Function</tt></a>s.  This is
2334     necessary to use when you need to update the list or perform a complex
2335     action that doesn't have a forwarding method.</p>
2336
2337     <p><!--  Global Variable --></p></li>
2338 </ul>
2339
2340 <hr>
2341
2342 <ul>
2343   <li><tt>Module::global_iterator</tt> - Typedef for global variable list iterator<br>
2344
2345     <tt>Module::const_global_iterator</tt> - Typedef for const_iterator.<br>
2346
2347     <tt>global_begin()</tt>, <tt>global_end()</tt>
2348     <tt>global_size()</tt>, <tt>global_empty()</tt>
2349
2350     <p> These are forwarding methods that make it easy to access the contents of
2351     a <tt>Module</tt> object's <a
2352     href="#GlobalVariable"><tt>GlobalVariable</tt></a> list.</p></li>
2353
2354   <li><tt>Module::GlobalListType &amp;getGlobalList()</tt>
2355
2356     <p>Returns the list of <a
2357     href="#GlobalVariable"><tt>GlobalVariable</tt></a>s.  This is necessary to
2358     use when you need to update the list or perform a complex action that
2359     doesn't have a forwarding method.</p>
2360
2361     <p><!--  Symbol table stuff --> </p></li>
2362 </ul>
2363
2364 <hr>
2365
2366 <ul>
2367   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
2368
2369     <p>Return a reference to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2370     for this <tt>Module</tt>.</p>
2371
2372     <p><!--  Convenience methods --></p></li>
2373 </ul>
2374
2375 <hr>
2376
2377 <ul>
2378   <li><tt><a href="#Function">Function</a> *getFunction(const std::string
2379   &amp;Name, const <a href="#FunctionType">FunctionType</a> *Ty)</tt>
2380
2381     <p>Look up the specified function in the <tt>Module</tt> <a
2382     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, return
2383     <tt>null</tt>.</p></li>
2384
2385   <li><tt><a href="#Function">Function</a> *getOrInsertFunction(const
2386   std::string &amp;Name, const <a href="#FunctionType">FunctionType</a> *T)</tt>
2387
2388     <p>Look up the specified function in the <tt>Module</tt> <a
2389     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, add an
2390     external declaration for the function and return it.</p></li>
2391
2392   <li><tt>std::string getTypeName(const <a href="#Type">Type</a> *Ty)</tt>
2393
2394     <p>If there is at least one entry in the <a
2395     href="#SymbolTable"><tt>SymbolTable</tt></a> for the specified <a
2396     href="#Type"><tt>Type</tt></a>, return it.  Otherwise return the empty
2397     string.</p></li>
2398
2399   <li><tt>bool addTypeName(const std::string &amp;Name, const <a
2400   href="#Type">Type</a> *Ty)</tt>
2401
2402     <p>Insert an entry in the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2403     mapping <tt>Name</tt> to <tt>Ty</tt>. If there is already an entry for this
2404     name, true is returned and the <a
2405     href="#SymbolTable"><tt>SymbolTable</tt></a> is not modified.</p></li>
2406 </ul>
2407
2408 </div>
2409
2410 <!-- ======================================================================= -->
2411 <div class="doc_subsection">
2412   <a name="Constant">The <tt>Constant</tt> class and subclasses</a>
2413 </div>
2414
2415 <div class="doc_text">
2416
2417 <p>Constant represents a base class for different types of constants. It
2418 is subclassed by ConstantBool, ConstantInt, ConstantArray etc for representing
2419 the various types of Constants.</p>
2420
2421 </div>
2422
2423 <!-- _______________________________________________________________________ -->
2424 <div class="doc_subsubsection">
2425   <a name="m_Constant">Important Public Methods</a>
2426 </div>
2427 <div class="doc_text">
2428 </div>
2429
2430 <!-- _______________________________________________________________________ -->
2431 <div class="doc_subsubsection">Important Subclasses of Constant </div>
2432 <div class="doc_text">
2433 <ul>
2434   <li>ConstantInt : This subclass of Constant represents an integer constant.
2435     <ul>
2436       <li><tt>int64_t getSExtValue() const</tt>: Returns the underlying value of
2437       this constant as a sign extended signed integer value.</li>
2438       <li><tt>uint64_t getZExtValue() const</tt>: Returns the underlying value
2439       of this constant as a zero extended unsigned integer value.</li>
2440     </ul>
2441   </li>
2442   <li>ConstantFP : This class represents a floating point constant.
2443     <ul>
2444       <li><tt>double getValue() const</tt>: Returns the underlying value of
2445       this constant. </li>
2446     </ul>
2447   </li>
2448   <li>ConstantBool : This represents a boolean constant.
2449     <ul>
2450       <li><tt>bool getValue() const</tt>: Returns the underlying value of this
2451       constant. </li>
2452     </ul>
2453   </li>
2454   <li>ConstantArray : This represents a constant array.
2455     <ul>
2456       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2457       a vector of component constants that makeup this array. </li>
2458     </ul>
2459   </li>
2460   <li>ConstantStruct : This represents a constant struct.
2461     <ul>
2462       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2463       a vector of component constants that makeup this array. </li>
2464     </ul>
2465   </li>
2466   <li>GlobalValue : This represents either a global variable or a function. In
2467   either case, the value is a constant fixed address (after linking).
2468   </li>
2469 </ul>
2470 </div>
2471
2472 <!-- ======================================================================= -->
2473 <div class="doc_subsection">
2474   <a name="Type">The <tt>Type</tt> class and Derived Types</a>
2475 </div>
2476
2477 <div class="doc_text">
2478
2479 <p>Type as noted earlier is also a subclass of a Value class.  Any primitive
2480 type (like int, short etc) in LLVM is an instance of Type Class.  All other
2481 types are instances of subclasses of type like FunctionType, ArrayType
2482 etc. DerivedType is the interface for all such dervied types including
2483 FunctionType, ArrayType, PointerType, StructType. Types can have names. They can
2484 be recursive (StructType).  There exists exactly one instance of any type
2485 structure at a time. This allows using pointer equality of Type *s for comparing
2486 types.</p>
2487
2488 </div>
2489
2490 <!-- _______________________________________________________________________ -->
2491 <div class="doc_subsubsection">
2492   <a name="m_Value">Important Public Methods</a>
2493 </div>
2494
2495 <div class="doc_text">
2496
2497 <ul>
2498
2499   <li><tt>bool isSigned() const</tt>: Returns whether an integral numeric type
2500   is signed. This is true for SByteTy, ShortTy, IntTy, LongTy. Note that this is
2501   not true for Float and Double. </li>
2502
2503   <li><tt>bool isUnsigned() const</tt>: Returns whether a numeric type is
2504   unsigned. This is not quite the complement of isSigned... nonnumeric types
2505   return false as they do with isSigned. This returns true for UByteTy,
2506   UShortTy, UIntTy, and ULongTy. </li>
2507
2508   <li><tt>bool isInteger() const</tt>: Equivalent to isSigned() || isUnsigned().</li>
2509
2510   <li><tt>bool isIntegral() const</tt>: Returns true if this is an integral
2511   type, which is either Bool type or one of the Integer types.</li>
2512
2513   <li><tt>bool isFloatingPoint()</tt>: Return true if this is one of the two
2514   floating point types.</li>
2515
2516   <li><tt>isLosslesslyConvertableTo (const Type *Ty) const</tt>: Return true if
2517   this type can be converted to 'Ty' without any reinterpretation of bits. For
2518   example, uint to int or one pointer type to another.</li>
2519 </ul>
2520 </div>
2521
2522 <!-- _______________________________________________________________________ -->
2523 <div class="doc_subsubsection">
2524   <a name="m_Value">Important Derived Types</a>
2525 </div>
2526 <div class="doc_text">
2527 <ul>
2528   <li>SequentialType : This is subclassed by ArrayType and PointerType
2529     <ul>
2530       <li><tt>const Type * getElementType() const</tt>: Returns the type of each
2531       of the elements in the sequential type. </li>
2532     </ul>
2533   </li>
2534   <li>ArrayType : This is a subclass of SequentialType and defines interface for
2535   array types.
2536     <ul>
2537       <li><tt>unsigned getNumElements() const</tt>: Returns the number of
2538       elements in the array. </li>
2539     </ul>
2540   </li>
2541   <li>PointerType : Subclass of SequentialType for  pointer types. </li>
2542   <li>StructType : subclass of DerivedTypes for struct types </li>
2543   <li>FunctionType : subclass of DerivedTypes for function types.
2544     <ul>
2545       <li><tt>bool isVarArg() const</tt>: Returns true if its a vararg
2546       function</li>
2547       <li><tt> const Type * getReturnType() const</tt>: Returns the
2548       return type of the function.</li>
2549       <li><tt>const Type * getParamType (unsigned i)</tt>: Returns
2550       the type of the ith parameter.</li>
2551       <li><tt> const unsigned getNumParams() const</tt>: Returns the
2552       number of formal parameters.</li>
2553     </ul>
2554   </li>
2555 </ul>
2556 </div>
2557
2558 <!-- ======================================================================= -->
2559 <div class="doc_subsection">
2560   <a name="Argument">The <tt>Argument</tt> class</a>
2561 </div>
2562
2563 <div class="doc_text">
2564
2565 <p>This subclass of Value defines the interface for incoming formal
2566 arguments to a function. A Function maintains a list of its formal
2567 arguments. An argument has a pointer to the parent Function.</p>
2568
2569 </div>
2570
2571 <!-- *********************************************************************** -->
2572 <hr>
2573 <address>
2574   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
2575   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
2576   <a href="http://validator.w3.org/check/referer"><img
2577   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
2578
2579   <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and
2580   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
2581   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
2582   Last modified: $Date$
2583 </address>
2584
2585 </body>
2586 </html>