docs/ProgrammersManual.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><title>LLVM Programmer's Manual</title></head>
   3
   4 <body bgcolor=white>
   5
   6 <table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
   7 <tr><td>&nbsp; <font size=+3 color="#EEEEFF" face="Georgia,Palatino,Times,Roman"><b>LLVM Programmer's Manual</b></font></td>
   8 </tr></table>
   9
  10 <ol>
  11   <li><a href="#introduction">Introduction</a>
  12   <li><a href="#general">General Information</a>
  13   <ul>
  14     <li><a href="#stl">The C++ Standard Template Library</a>
  15 <!--
  16     <li>The <tt>-time-passes</tt> option
  17     <li>How to use the LLVM Makefile system
  18     <li>How to write a regression test
  19 -->
  20   </ul>
  21   <li><a href="#apis">Important and useful LLVM APIs</a>
  22   <ul>
  23     <li><a href="#isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt> and
  24                        <tt>dyn_cast&lt;&gt;</tt> templates</a>
  25     <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro &amp;
  26                        <tt>-debug</tt> option</a>
  27     <li><a href="#Statistic">The <tt>Statistic</tt> template &amp;
  28                        <tt>-stats</tt> option</a>
  29 <!--
  30     <li>The <tt>InstVisitor</tt> template
  31     <li>The general graph API
  32 -->
  33   </ul>
  34   <li><a href="#common">Helpful Hints for Common Operations</a>
  35   <ul>
  36     <li><a href="#inspection">Basic Inspection and Traversal Routines</a>
  37     <ul>
  38       <li><a href="#iterate_function">Iterating over the <tt>BasicBlock</tt>s
  39                                        in a <tt>Function</tt></a>
  40       <li><a href="#iterate_basicblock">Iterating over the <tt>Instruction</tt>s
  41                                        in a <tt>BasicBlock</tt></a>
  42       <li><a href="#iterate_institer">Iterating over the <tt>Instruction</tt>s
  43                                        in a <tt>Function</tt></a>
  44       <li><a href="#iterate_convert">Turning an iterator into a class
  45                                         pointer</a>
  46       <li><a href="#iterate_complex">Finding call sites: a more complex
  47                                         example</a>
  48       <li><a href="#iterate_chains">Iterating over def-use &amp; use-def
  49                                     chains</a>
  50     </ul>
  51     <li><a href="#simplechanges">Making simple changes</a>
  52     <ul>
  53       <li><a href="#schanges_creating">Creating and inserting new
  54                   <tt>Instruction</tt>s</a>
  55       <li><a href="#schanges_deleting">Deleting
  56                   <tt>Instruction</tt>s</a>
  57       <li><a href="#schanges_replacing">Replacing an
  58                   <tt>Instruction</tt> with another <tt>Value</tt></a>
  59     </ul>
  60 <!--
  61     <li>Working with the Control Flow Graph
  62     <ul>
  63       <li>Accessing predecessors and successors of a <tt>BasicBlock</tt>
  64       <li>
  65       <li>
  66     </ul>
  67 -->
  68   </ul>
  69   <li><a href="#coreclasses">The Core LLVM Class Hierarchy Reference</a>
  70   <ul>
  71     <li><a href="#Value">The <tt>Value</tt> class</a>
  72     <ul>
  73       <li><a href="#User">The <tt>User</tt> class</a>
  74       <ul>
  75         <li><a href="#Instruction">The <tt>Instruction</tt> class</a>
  76         <ul>
  77         <li>
  78         </ul>
  79         <li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
  80         <ul>
  81           <li><a href="#BasicBlock">The <tt>BasicBlock</tt> class</a>
  82           <li><a href="#Function">The <tt>Function</tt> class</a>
  83           <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class</a>
  84         </ul>
  85         <li><a href="#Module">The <tt>Module</tt> class</a>
  86         <li><a href="#Constant">The <tt>Constant</tt> class</a>
  87         <ul>
  88         <li>
  89         <li>
  90         </ul>
  91       </ul>
  92       <li><a href="#Type">The <tt>Type</tt> class</a>
  93       <li><a href="#Argument">The <tt>Argument</tt> class</a>
  94     </ul>
  95     <li>The <tt>SymbolTable</tt> class
  96     <li>The <tt>ilist</tt> and <tt>iplist</tt> classes
  97     <ul>
  98       <li>Creating, inserting, moving and deleting from LLVM lists
  99     </ul>
 100     <li>Important iterator invalidation semantics to be aware of
 101   </ul>
 102
 103   <p><b>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
 104         <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>, and
 105       <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a></b><p>
 106 </ol>
 107
 108
 109 <!-- *********************************************************************** -->
 110 <table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
 111 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
 112 <a name="introduction">Introduction
 113 </b></font></td></tr></table><ul>
 114 <!-- *********************************************************************** -->
 115
 116 This document is meant to highlight some of the important classes and interfaces
 117 available in the LLVM source-base.  This manual is not intended to explain what
 118 LLVM is, how it works, and what LLVM code looks like.  It assumes that you know
 119 the basics of LLVM and are interested in writing transformations or otherwise
 120 analyzing or manipulating the code.<p>
 121
 122 This document should get you oriented so that you can find your way in the
 123 continuously growing source code that makes up the LLVM infrastructure.  Note
 124 that this manual is not intended to serve as a replacement for reading the
 125 source code, so if you think there should be a method in one of these classes to
 126 do something, but it's not listed, check the source.  Links to the <a
 127 href="/doxygen/">doxygen</a> sources are provided to make this as easy as
 128 possible.<p>
 129
 130 The first section of this document describes general information that is useful
 131 to know when working in the LLVM infrastructure, and the second describes the
 132 Core LLVM classes.  In the future this manual will be extended with information
 133 describing how to use extension libraries, such as dominator information, CFG
 134 traversal routines, and useful utilities like the <tt><a
 135 href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.<p>
 136
 137
 138 <!-- *********************************************************************** -->
 139 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
 140 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
 141 <a name="general">General Information
 142 </b></font></td></tr></table><ul>
 143 <!-- *********************************************************************** -->
 144
 145 This section contains general information that is useful if you are working in
 146 the LLVM source-base, but that isn't specific to any particular API.<p>
 147
 148
 149 <!-- ======================================================================= -->
 150 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 151 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 152 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 153 <a name="stl">The C++ Standard Template Library</a>
 154 </b></font></td></tr></table><ul>
 155
 156 LLVM makes heavy use of the C++ Standard Template Library (STL), perhaps much
 157 more than you are used to, or have seen before.  Because of this, you might want
 158 to do a little background reading in the techniques used and capabilities of the
 159 library.  There are many good pages that discuss the STL, and several books on
 160 the subject that you can get, so it will not be discussed in this document.<p>
 161
 162 Here are some useful links:<p>
 163 <ol>
 164 <li><a href="http://www.dinkumware.com/refxcpp.html">Dinkumware C++
 165 Library reference</a> - an excellent reference for the STL and other parts of
 166 the standard C++ library.<br>
 167
 168 <li><a href="http://www.parashift.com/c++-faq-lite/">C++ Frequently Asked
 169 Questions</a>
 170
 171 <li><a href="http://www.sgi.com/tech/stl/">SGI's STL Programmer's Guide</a> -
 172 Contains a useful <a
 173 href="http://www.sgi.com/tech/stl/stl_introduction.html">Introduction to the
 174 STL</a>.
 175
 176 <li><a href="http://www.research.att.com/~bs/C++.html">Bjarne Stroustrup's C++
 177 Page</a>
 178
 179 </ol><p>
 180
 181 You are also encouraged to take a look at the <a
 182 href="CodingStandards.html">LLVM Coding Standards</a> guide which focuses on how
 183 to write maintainable code more than where to put your curly braces.<p>
 184
 185
 186 <!-- *********************************************************************** -->
 187 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
 188 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
 189 <a name="apis">Important and useful LLVM APIs
 190 </b></font></td></tr></table><ul>
 191 <!-- *********************************************************************** -->
 192
 193 Here we highlight some LLVM APIs that are generally useful and good to know
 194 about when writing transformations.<p>
 195
 196 <!-- ======================================================================= -->
 197 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 198 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 199 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 200 <a name="isa">The isa&lt;&gt;, cast&lt;&gt; and dyn_cast&lt;&gt; templates</a>
 201 </b></font></td></tr></table><ul>
 202
 203 The LLVM source-base makes extensive use of a custom form of RTTI.  These
 204 templates have many similarities to the C++ <tt>dynamic_cast&lt;&gt;</tt>
 205 operator, but they don't have some drawbacks (primarily stemming from the fact
 206 that <tt>dynamic_cast&lt;&gt;</tt> only works on classes that have a v-table).
 207 Because they are used so often, you must know what they do and how they work.
 208 All of these templates are defined in the <a
 209 href="/doxygen/Casting_8h-source.html"><tt>Support/Casting.h</tt></a> file (note
 210 that you very rarely have to include this file directly).<p>
 211
 212 <dl>
 213
 214 <dt><tt>isa&lt;&gt;</tt>:
 215
 216 <dd>The <tt>isa&lt;&gt;</tt> operator works exactly like the Java
 217 "<tt>instanceof</tt>" operator.  It returns true or false depending on whether a
 218 reference or pointer points to an instance of the specified class.  This can be
 219 very useful for constraint checking of various sorts (example below).<p>
 220
 221
 222 <dt><tt>cast&lt;&gt;</tt>:
 223
 224 <dd>The <tt>cast&lt;&gt;</tt> operator is a "checked cast" operation.  It
 225 converts a pointer or reference from a base class to a derived cast, causing an
 226 assertion failure if it is not really an instance of the right type.  This
 227 should be used in cases where you have some information that makes you believe
 228 that something is of the right type.  An example of the <tt>isa&lt;&gt;</tt> and
 229 <tt>cast&lt;&gt;</tt> template is:<p>
 230
 231 <pre>
 232 static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
 233   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))
 234     return true;
 235
 236   <i>// Otherwise, it must be an instruction...</i>
 237   return !L->contains(cast&lt;<a href="#Instruction">Instruction</a>&gt;(V)->getParent());
 238 </pre><p>
 239
 240 Note that you should <b>not</b> use an <tt>isa&lt;&gt;</tt> test followed by a
 241 <tt>cast&lt;&gt;</tt>, for that use the <tt>dyn_cast&lt;&gt;</tt> operator.<p>
 242
 243
 244 <dt><tt>dyn_cast&lt;&gt;</tt>:
 245
 246 <dd>The <tt>dyn_cast&lt;&gt;</tt> operator is a "checking cast" operation.  It
 247 checks to see if the operand is of the specified type, and if so, returns a
 248 pointer to it (this operator does not work with references).  If the operand is
 249 not of the correct type, a null pointer is returned.  Thus, this works very much
 250 like the <tt>dynamic_cast</tt> operator in C++, and should be used in the same
 251 circumstances.  Typically, the <tt>dyn_cast&lt;&gt;</tt> operator is used in an
 252 <tt>if</tt> statement or some other flow control statement like this:<p>
 253
 254 <pre>
 255   if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast&lt;<a href="#AllocationInst">AllocationInst</a>&gt;(Val)) {
 256     ...
 257   }
 258 </pre><p>
 259
 260 This form of the <tt>if</tt> statement effectively combines together a call to
 261 <tt>isa&lt;&gt;</tt> and a call to <tt>cast&lt;&gt;</tt> into one statement,
 262 which is very convenient.<p>
 263
 264 Another common example is:<p>
 265
 266 <pre>
 267   <i>// Loop over all of the phi nodes in a basic block</i>
 268   BasicBlock::iterator BBI = BB->begin();
 269   for (; <a href="#PhiNode">PHINode</a> *PN = dyn_cast&lt;<a href="#PHINode">PHINode</a>&gt;(&amp;*BBI); ++BBI)
 270     cerr &lt;&lt; *PN;
 271 </pre><p>
 272
 273 Note that the <tt>dyn_cast&lt;&gt;</tt> operator, like C++'s
 274 <tt>dynamic_cast</tt> or Java's <tt>instanceof</tt> operator, can be abused.  In
 275 particular you should not use big chained <tt>if/then/else</tt> blocks to check
 276 for lots of different variants of classes.  If you find yourself wanting to do
 277 this, it is much cleaner and more efficient to use the InstVisitor class to
 278 dispatch over the instruction type directly.<p>
 279
 280
 281 <dt><tt>cast_or_null&lt;&gt;</tt>:
 282
 283 <dd>The <tt>cast_or_null&lt;&gt;</tt> operator works just like the
 284 <tt>cast&lt;&gt;</tt> operator, except that it allows for a null pointer as an
 285 argument (which it then propagates).  This can sometimes be useful, allowing you
 286 to combine several null checks into one.<p>
 287
 288
 289 <dt><tt>dyn_cast_or_null&lt;&gt;</tt>:
 290
 291 <dd>The <tt>dyn_cast_or_null&lt;&gt;</tt> operator works just like the
 292 <tt>dyn_cast&lt;&gt;</tt> operator, except that it allows for a null pointer as
 293 an argument (which it then propagates).  This can sometimes be useful, allowing
 294 you to combine several null checks into one.<p>
 295
 296 </dl>
 297
 298 These five templates can be used with any classes, whether they have a v-table
 299 or not.  To add support for these templates, you simply need to add
 300 <tt>classof</tt> static methods to the class you are interested casting to.
 301 Describing this is currently outside the scope of this document, but there are
 302 lots of examples in the LLVM source base.<p>
 303
 304
 305 <!-- ======================================================================= -->
 306 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 307 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 308 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 309 <a name="DEBUG">The <tt>DEBUG()</tt> macro &amp; <tt>-debug</tt> option</a>
 310 </b></font></td></tr></table><ul>
 311
 312 Often when working on your pass you will put a bunch of debugging printouts and
 313 other code into your pass.  After you get it working, you want to remove
 314 it... but you may need it again in the future (to work out new bugs that you run
 315 across).<p>
 316
 317 Naturally, because of this, you don't want to delete the debug printouts, but
 318 you don't want them to always be noisy.  A standard compromise is to comment
 319 them out, allowing you to enable them if you need them in the future.<p>
 320
 321 The "<tt><a
 322 href="/doxygen/Statistic_8h-source.html">Support/Statistic.h</a></tt>"
 323 file provides a macro named <tt>DEBUG()</tt> that is a much nicer solution to
 324 this problem.  Basically, you can put arbitrary code into the argument of the
 325 <tt>DEBUG</tt> macro, and it is only executed if '<tt>opt</tt>' is run with the
 326 '<tt>-debug</tt>' command line argument:
 327
 328 <pre>
 329      ...
 330      DEBUG(std::cerr &lt;&lt; "I am here!\n");
 331      ...
 332 </pre><p>
 333
 334 Then you can run your pass like this:<p>
 335
 336 <pre>
 337   $ opt &lt; a.bc &gt; /dev/null -mypass
 338     &lt;no output&gt;
 339   $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 340     I am here!
 341   $
 342 </pre><p>
 343
 344 Using the <tt>DEBUG()</tt> macro instead of a home brewed solution allows you to
 345 now have to create "yet another" command line option for the debug output for
 346 your pass.  Note that <tt>DEBUG()</tt> macros are disabled for optimized
 347 builds, so they do not cause a performance impact at all.<p>
 348
 349
 350 <!-- ======================================================================= -->
 351 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 352 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 353 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 354 <a name="Statistic">The <tt>Statistic</tt> template &amp; <tt>-stats</tt>
 355 option</a>
 356 </b></font></td></tr></table><ul>
 357
 358 The "<tt><a
 359 href="/doxygen/Statistic_8h-source.html">Support/Statistic.h</a></tt>"
 360 file provides a template named <tt>Statistic</tt> that is used as a unified way
 361 to keeping track of what the LLVM compiler is doing and how effective various
 362 optimizations are.  It is useful to see what optimizations are contributing to
 363 making a particular program run faster.<p>
 364
 365 Often you may run your pass on some big program, and you're interested to see
 366 how many times it makes a certain transformation.  Although you can do this with
 367 hand inspection, or some ad-hoc method, this is a real pain and not very useful
 368 for big programs.  Using the <tt>Statistic</tt> template makes it very easy to
 369 keep track of this information, and the calculated information is presented in a
 370 uniform manner with the rest of the passes being executed.<p>
 371
 372 There are many examples of <tt>Statistic</tt> users, but this basics of using it
 373 are as follows:<p>
 374
 375 <ol>
 376 <li>Define your statistic like this:<p>
 377
 378 <pre>
 379 static Statistic&lt;&gt; NumXForms("mypassname", "The # of times I did stuff");
 380 </pre><p>
 381
 382 The <tt>Statistic</tt> template can emulate just about any data-type, but if you
 383 do not specify a template argument, it defaults to acting like an unsigned int
 384 counter (this is usually what you want).<p>
 385
 386 <li>Whenever you make a transformation, bump the counter:<p>
 387
 388 <pre>
 389    ++NumXForms;   // I did stuff
 390 </pre><p>
 391
 392 </ol><p>
 393
 394 That's all you have to do.  To get '<tt>opt</tt>' to print out the statistics
 395 gathered, use the '<tt>-stats</tt>' option:<p>
 396
 397 <pre>
 398    $ opt -stats -mypassname &lt; program.bc &gt; /dev/null
 399     ... statistic output ...
 400 </pre><p>
 401
 402 When running <tt>gccas</tt> on a C file from the SPEC benchmark suite, it gives
 403 a report that looks like this:<p>
 404
 405 <pre>
 406    7646 bytecodewriter  - Number of normal instructions
 407     725 bytecodewriter  - Number of oversized instructions
 408  129996 bytecodewriter  - Number of bytecode bytes written
 409    2817 raise           - Number of insts DCEd or constprop'd
 410    3213 raise           - Number of cast-of-self removed
 411    5046 raise           - Number of expression trees converted
 412      75 raise           - Number of other getelementptr's formed
 413     138 raise           - Number of load/store peepholes
 414      42 deadtypeelim    - Number of unused typenames removed from symtab
 415     392 funcresolve     - Number of varargs functions resolved
 416      27 globaldce       - Number of global variables removed
 417       2 adce            - Number of basic blocks removed
 418     134 cee             - Number of branches revectored
 419      49 cee             - Number of setcc instruction eliminated
 420     532 gcse            - Number of loads removed
 421    2919 gcse            - Number of instructions removed
 422      86 indvars         - Number of cannonical indvars added
 423      87 indvars         - Number of aux indvars removed
 424      25 instcombine     - Number of dead inst eliminate
 425     434 instcombine     - Number of insts combined
 426     248 licm            - Number of load insts hoisted
 427    1298 licm            - Number of insts hoisted to a loop pre-header
 428       3 licm            - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
 429      75 mem2reg         - Number of alloca's promoted
 430    1444 cfgsimplify     - Number of blocks simplified
 431 </pre><p>
 432
 433 Obviously, with so many optimizations, having a unified framework for this stuff
 434 is very nice.  Making your pass fit well into the framework makes it more
 435 maintainable and useful.<p>
 436
 437
 438 <!-- *********************************************************************** -->
 439 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
 440 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
 441 <a name="common">Helpful Hints for Common Operations
 442 </b></font></td></tr></table><ul> <!--
 443 *********************************************************************** -->
 444
 445 This section describes how to perform some very simple transformations of LLVM
 446 code.  This is meant to give examples of common idioms used, showing the
 447 practical side of LLVM transformations.<p>
 448
 449 Because this is a "how-to" section, you should also read about the main classes
 450 that you will be working with.  The <a href="#coreclasses">Core LLVM Class
 451 Hierarchy Reference</a> contains details and descriptions of the main classes
 452 that you should know about.<p>
 453
 454 <!-- NOTE: this section should be heavy on example code -->
 455
 456
 457 <!-- ======================================================================= -->
 458 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 459 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 460 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 461 <a name="inspection">Basic Inspection and Traversal Routines</a>
 462 </b></font></td></tr></table><ul>
 463
 464 The LLVM compiler infrastructure have many different data structures that may be
 465 traversed.  Following the example of the C++ standard template library, the
 466 techniques used to traverse these various data structures are all basically the
 467 same.  For a enumerable sequence of values, the <tt>XXXbegin()</tt> function (or
 468 method) returns an iterator to the start of the sequence, the <tt>XXXend()</tt>
 469 function returns an iterator pointing to one past the last valid element of the
 470 sequence, and there is some <tt>XXXiterator</tt> data type that is common
 471 between the two operations.<p>
 472
 473 Because the pattern for iteration is common across many different aspects of the
 474 program representation, the standard template library algorithms may be used on
 475 them, and it is easier to remember how to iterate.  First we show a few common
 476 examples of the data structures that need to be traversed.  Other data
 477 structures are traversed in very similar ways.<p>
 478
 479
 480 <!-- _______________________________________________________________________ -->
 481 </ul><h4><a name="iterate_function"><hr size=0>Iterating over the <a
 482 href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
 483 href="#Function"><tt>Function</tt></a> </h4><ul>
 484
 485 It's quite common to have a <tt>Function</tt> instance that you'd like
 486 to transform in some way; in particular, you'd like to manipulate its
 487 <tt>BasicBlock</tt>s.  To facilitate this, you'll need to iterate over
 488 all of the <tt>BasicBlock</tt>s that constitute the <tt>Function</tt>.
 489 The following is an example that prints the name of a
 490 <tt>BasicBlock</tt> and the number of <tt>Instruction</tt>s it
 491 contains:
 492
 493 <pre>
 494   // func is a pointer to a Function instance
 495   for(Function::iterator i = func->begin(), e = func->end(); i != e; ++i) {
 496
 497       // print out the name of the basic block if it has one, and then the
 498       // number of instructions that it contains
 499
 500       cerr &lt;&lt "Basic block (name=" &lt;&lt i-&gt;getName() &lt;&lt; ") has "
 501            &lt;&lt i-&gt;size() &lt;&lt " instructions.\n";
 502   }
 503 </pre>
 504
 505 Note that i can be used as if it were a pointer for the purposes of
 506 invoking member functions of the <tt>Instruction</tt> class.  This is
 507 because the indirection operator is overloaded for the iterator
 508 classes.  In the above code, the expression <tt>i->size()</tt> is
 509 exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.
 510
 511 <!-- _______________________________________________________________________ -->
 512 </ul><h4><a name="iterate_basicblock"><hr size=0>Iterating over the <a
 513 href="#Instruction"><tt>Instruction</tt></a>s in a <a
 514 href="#BasicBlock"><tt>BasicBlock</tt></a> </h4><ul>
 515
 516 Just like when dealing with <tt>BasicBlock</tt>s in
 517 <tt>Function</tt>s, it's easy to iterate over the individual
 518 instructions that make up <tt>BasicBlock</tt>s.  Here's a code snippet
 519 that prints out each instruction in a <tt>BasicBlock</tt>:
 520
 521 <pre>
 522   // blk is a pointer to a BasicBlock instance
 523   for(BasicBlock::iterator i = blk-&gt;begin(), e = blk-&gt;end(); i != e; ++i)
 524      // the next statement works since operator&lt;&lt;(ostream&amp;,...)
 525      // is overloaded for Instruction&amp;
 526      cerr &lt;&lt; *i &lt;&lt; "\n";
 527 </pre>
 528
 529 However, this isn't really the best way to print out the contents of a
 530 <tt>BasicBlock</tt>!  Since the ostream operators are overloaded for
 531 virtually anything you'll care about, you could have just invoked the
 532 print routine on the basic block itself: <tt>cerr &lt;&lt; *blk &lt;&lt;
 533 "\n";</tt>.<p>
 534
 535 Note that currently operator&lt;&lt; is implemented for <tt>Value*</tt>, so it
 536 will print out the contents of the pointer, instead of
 537 the pointer value you might expect.  This is a deprecated interface that will
 538 be removed in the future, so it's best not to depend on it.  To print out the
 539 pointer value for now, you must cast to <tt>void*</tt>.<p>
 540
 541
 542 <!-- _______________________________________________________________________ -->
 543 </ul><h4><a name="iterate_institer"><hr size=0>Iterating over the <a
 544 href="#Instruction"><tt>Instruction</tt></a>s in a <a
 545 href="#Function"><tt>Function</tt></a></h4><ul>
 546
 547 If you're finding that you commonly iterate over a <tt>Function</tt>'s
 548 <tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s
 549 <tt>Instruction</tt>s, <tt>InstIterator</tt> should be used instead.
 550 You'll need to include <a href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>, and then
 551 instantiate <tt>InstIterator</tt>s explicitly in your code.  Here's a
 552 small example that shows how to dump all instructions in a function to
 553 stderr (<b>Note:</b> Dereferencing an <tt>InstIterator</tt> yields an
 554 <tt>Instruction*</tt>, <i>not</i> an <tt>Instruction&amp</tt>!):
 555
 556 <pre>
 557 #include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"
 558 ...
 559 // Suppose F is a ptr to a function
 560 for(inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
 561   cerr &lt;&lt **i &lt;&lt "\n";
 562 </pre>
 563
 564 Easy, isn't it?  You can also use <tt>InstIterator</tt>s to fill a
 565 worklist with its initial contents.  For example, if you wanted to
 566 initialize a worklist to contain all instructions in a
 567 <tt>Function</tt> F, all you would need to do is something like:
 568
 569 <pre>
 570 std::set&lt;Instruction*&gt worklist;
 571 worklist.insert(inst_begin(F), inst_end(F));
 572 </pre>
 573
 574 The STL set <tt>worklist</tt> would now contain all instructions in
 575 the <tt>Function</tt> pointed to by F.
 576
 577 <!-- _______________________________________________________________________ -->
 578 </ul><h4><a name="iterate_convert"><hr size=0>Turning an iterator into a class
 579 pointer (and vice-versa) </h4><ul>
 580
 581 Sometimes, it'll be useful to grab a reference (or pointer) to a class
 582 instance when all you've got at hand is an iterator.  Well, extracting
 583 a reference or a pointer from an iterator is very straightforward.
 584 Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and
 585 <tt>j</tt> is a <tt>BasicBlock::const_iterator</tt>:
 586
 587 <pre>
 588     Instruction&amp; inst = *i;   // grab reference to instruction reference
 589     Instruction* pinst = &amp;*i; // grab pointer to instruction reference
 590     const Instruction&amp; inst = *j;
 591 </pre>
 592 However, the iterators you'll be working with in the LLVM framework
 593 are special: they will automatically convert to a ptr-to-instance type
 594 whenever they need to.  Instead of dereferencing the iterator and then
 595 taking the address of the result, you can simply assign the iterator
 596 to the proper pointer type and you get the dereference and address-of
 597 operation as a result of the assignment (behind the scenes, this is a
 598 result of overloading casting mechanisms).  Thus the last line of the
 599 last example,
 600
 601 <pre>Instruction* pinst = &amp;*i;</pre>
 602
 603 is semantically equivalent to
 604
 605 <pre>Instruction* pinst = i;</pre>
 606
 607 <b>Caveat emptor</b>: The above syntax works <i>only</i> when you're <i>not</i>
 608 working with <tt>dyn_cast</tt>.  The template definition of <tt><a
 609 href="#isa">dyn_cast</a></tt> isn't implemented to handle this yet, so you'll
 610 still need the following in order for things to work properly:
 611
 612 <pre>
 613 BasicBlock::iterator bbi = ...;
 614 <a href="#BranchInst">BranchInst</a>* b = <a href="#isa">dyn_cast</a>&lt;<a href="#BranchInst">BranchInst</a>&gt;(&amp;*bbi);
 615 </pre>
 616
 617 It's also possible to turn a class pointer into the corresponding
 618 iterator.  Usually, this conversion is quite inexpensive.  The
 619 following code snippet illustrates use of the conversion constructors
 620 provided by LLVM iterators.  By using these, you can explicitly grab
 621 the iterator of something without actually obtaining it via iteration
 622 over some structure:
 623
 624 <pre>
 625 void printNextInstruction(Instruction* inst) {
 626     BasicBlock::iterator it(inst);
 627     ++it; // after this line, it refers to the instruction after *inst.
 628     if(it != inst-&gt;getParent()->end()) cerr &lt;&lt; *it &lt;&lt; "\n";
 629 }
 630 </pre>
 631 Of course, this example is strictly pedagogical, because it'd be much
 632 better to explicitly grab the next instruction directly from inst.
 633
 634
 635 <!--_______________________________________________________________________-->
 636 </ul><h4><a name="iterate_complex"><hr size=0>Finding call sites: a slightly
 637 more complex example </h4><ul>
 638
 639 Say that you're writing a FunctionPass and would like to count all the
 640 locations in the entire module (that is, across every
 641 <tt>Function</tt>) where a certain function (i.e. some
 642 <tt>Function</tt>*) already in scope.  As you'll learn later, you may
 643 want to use an <tt>InstVisitor</tt> to accomplish this in a much more
 644 straightforward manner, but this example will allow us to explore how
 645 you'd do it if you didn't have <tt>InstVisitor</tt> around.  In
 646 pseudocode, this is what we want to do:
 647
 648 <pre>
 649 initialize callCounter to zero
 650 for each Function f in the Module
 651     for each BasicBlock b in f
 652       for each Instruction i in b
 653         if(i is a CallInst and calls the given function)
 654           increment callCounter
 655 </pre>
 656
 657 And the actual code is (remember, since we're writing a
 658 <tt>FunctionPass</tt>, our <tt>FunctionPass</tt>-derived class simply
 659 has to override the <tt>runOnFunction</tt> method...):
 660
 661 <pre>
 662 Function* targetFunc = ...;
 663
 664 class OurFunctionPass : public FunctionPass {
 665   public:
 666     OurFunctionPass(): callCounter(0) { }
 667
 668     virtual runOnFunction(Function&amp; F) {
 669         for(Function::iterator b = F.begin(), be = F.end(); b != be; ++b) {
 670             for(BasicBlock::iterator i = b-&gt;begin(); ie = b-&gt;end(); i != ie; ++i) {
 671                 if (<a href="#CallInst">CallInst</a>* callInst = <a href="#isa">dyn_cast</a>&lt;<a href="#CallInst">CallInst</a>&gt;(&amp;*i)) {
 672                     // we know we've encountered a call instruction, so we
 673                     // need to determine if it's a call to the
 674                     // function pointed to by m_func or not.
 675
 676                     if(callInst-&gt;getCalledFunction() == targetFunc)
 677                         ++callCounter;
 678             }
 679         }
 680     }
 681
 682   private:
 683     unsigned  callCounter;
 684 };
 685 </pre>
 686
 687 <!--_______________________________________________________________________-->
 688 </ul><h4><a name="iterate_chains"><hr size=0>Iterating over def-use &amp;
 689 use-def chains</h4><ul>
 690
 691 Frequently, we might have an instance of the <a
 692 href="/doxygen/classValue.html">Value Class</a> and we want to
 693 determine which <tt>User</tt>s use the <tt>Value</tt>.  The list of
 694 all <tt>User</tt>s of a particular <tt>Value</tt> is called a
 695 <i>def-use</i> chain.  For example, let's say we have a
 696 <tt>Function*</tt> named <tt>F</tt> to a particular function
 697 <tt>foo</tt>. Finding all of the instructions that <i>use</i>
 698 <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain of
 699 <tt>F</tt>:
 700
 701 <pre>
 702 Function* F = ...;
 703
 704 for(Value::use_iterator i = F-&gt;use_begin(), e = F-&gt;use_end(); i != e; ++i) {
 705     if(Instruction* Inst = dyn_cast&lt;Instruction&gt;(*i)) {
 706         cerr &lt;&lt; "F is used in instruction:\n";
 707         cerr &lt;&lt; *Inst &lt;&lt; "\n";
 708     }
 709 }
 710 </pre>
 711
 712 Alternately, it's common to have an instance of the <a
 713 href="/doxygen/classUser.html">User Class</a> and need to know what
 714 <tt>Value</tt>s are used by it.  The list of all <tt>Value</tt>s used
 715 by a <tt>User</tt> is known as a <i>use-def</i> chain.  Instances of
 716 class <tt>Instruction</tt> are common <tt>User</tt>s, so we might want
 717 to iterate over all of the values that a particular instruction uses
 718 (that is, the operands of the particular <tt>Instruction</tt>):
 719
 720 <pre>
 721 Instruction* pi = ...;
 722
 723 for(User::op_iterator i = pi-&gt;op_begin(), e = pi-&gt;op_end(); i != e; ++i) {
 724     Value* v = *i;
 725     ...
 726 }
 727 </pre>
 728
 729
 730 <!--
 731   def-use chains ("finding all users of"): Value::use_begin/use_end
 732   use-def chains ("finding all values used"): User::op_begin/op_end [op=operand]
 733 -->
 734
 735 <!-- ======================================================================= -->
 736 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 737 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 738 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 739 <a name="simplechanges">Making simple changes</a>
 740 </b></font></td></tr></table><ul>
 741
 742 There are some primitive transformation operations present in the LLVM
 743 infrastructure that are worth knowing about.  When performing
 744 transformations, it's fairly common to manipulate the contents of
 745 basic blocks.  This section describes some of the common methods for
 746 doing so and gives example code.
 747
 748 <!--_______________________________________________________________________-->
 749 </ul><h4><a name="schanges_creating"><hr size=0>Creating and inserting
 750     new <tt>Instruction</tt>s</h4><ul>
 751
 752 <i>Instantiating Instructions</i>
 753
 754 <p>Creation of <tt>Instruction</tt>s is straightforward: simply call the
 755 constructor for the kind of instruction to instantiate and provide the
 756 necessary parameters.  For example, an <tt>AllocaInst</tt> only
 757 <i>requires</i> a (const-ptr-to) <tt>Type</tt>.  Thus:
 758
 759 <pre>AllocaInst* ai = new AllocaInst(Type::IntTy);</pre>
 760
 761 will create an <tt>AllocaInst</tt> instance that represents the
 762 allocation of one integer in the current stack frame, at runtime.
 763 Each <tt>Instruction</tt> subclass is likely to have varying default
 764 parameters which change the semantics of the instruction, so refer to
 765 the <a href="/doxygen/classInstruction.html">doxygen documentation for
 766 the subclass of Instruction</a> that you're interested in
 767 instantiating.</p>
 768
 769 <p><i>Naming values</i></p>
 770
 771 <p>
 772 It is very useful to name the values of instructions when you're able
 773 to, as this facilitates the debugging of your transformations.  If you
 774 end up looking at generated LLVM machine code, you definitely want to
 775 have logical names associated with the results of instructions!  By
 776 supplying a value for the <tt>Name</tt> (default) parameter of the
 777 <tt>Instruction</tt> constructor, you associate a logical name with
 778 the result of the instruction's execution at runtime.  For example,
 779 say that I'm writing a transformation that dynamically allocates space
 780 for an integer on the stack, and that integer is going to be used as
 781 some kind of index by some other code.  To accomplish this, I place an
 782 <tt>AllocaInst</tt> at the first point in the first
 783 <tt>BasicBlock</tt> of some <tt>Function</tt>, and I'm intending to
 784 use it within the same <tt>Function</tt>.  I might do:
 785
 786 <pre>AllocaInst* pa = new AllocaInst(Type::IntTy, 0, "indexLoc");</pre>
 787
 788 where <tt>indexLoc</tt> is now the logical name of the instruction's
 789 execution value, which is a pointer to an integer on the runtime
 790 stack.
 791 </p>
 792
 793 <p><i>Inserting instructions</i></p>
 794
 795 <p>
 796 There are essentially two ways to insert an <tt>Instruction</tt> into
 797 an existing sequence of instructions that form a <tt>BasicBlock</tt>:
 798 <ul>
 799 <li>Insertion into an explicit instruction list
 800
 801 <p>Given a <tt>BasicBlock* pb</tt>, an <tt>Instruction* pi</tt> within
 802 that <tt>BasicBlock</tt>, and a newly-created instruction
 803 we wish to insert before <tt>*pi</tt>, we do the following:
 804
 805 <pre>
 806 BasicBlock* pb = ...;
 807 Instruction* pi = ...;
 808 Instruction* newInst = new Instruction(...);
 809 pb->getInstList().insert(pi, newInst); // inserts newInst before pi in pb
 810 </pre>
 811 </p>
 812
 813 <li>Insertion into an implicit instruction list
 814 <p><tt>Instruction</tt> instances that are already in
 815 <tt>BasicBlock</tt>s are implicitly associated with an existing
 816 instruction list: the instruction list of the enclosing basic block.
 817 Thus, we could have accomplished the same thing as the above code
 818 without being given a <tt>BasicBlock</tt> by doing:
 819 <pre>
 820 Instruction* pi = ...;
 821 Instruction* newInst = new Instruction(...);
 822 pi->getParent()->getInstList().insert(pi, newInst);
 823 </pre>
 824 In fact, this sequence of steps occurs so frequently that the
 825 <tt>Instruction</tt> class and <tt>Instruction</tt>-derived classes
 826 provide constructors which take (as a default parameter) a pointer to
 827 an <tt>Instruction</tt> which the newly-created <tt>Instruction</tt>
 828 should precede.  That is, <tt>Instruction</tt> constructors are
 829 capable of inserting the newly-created instance into the
 830 <tt>BasicBlock</tt> of a provided instruction, immediately before that
 831 instruction.  Using an <tt>Instruction</tt> constructor with a
 832 <tt>insertBefore</tt> (default) parameter, the above code becomes:
 833 <pre>
 834 Instruction* pi = ...;
 835 Instruction* newInst = new Instruction(..., pi);
 836 </pre>
 837 which is much cleaner, especially if you're creating a lot of
 838 instructions and adding them to <tt>BasicBlock</tt>s.
 839  </p>
 840 </p>
 841 </ul>
 842
 843 <!--_______________________________________________________________________-->
 844 </ul><h4><a name="schanges_deleting"><hr size=0>Deleting
 845 <tt>Instruction</tt>s</h4><ul>
 846
 847 Deleting an instruction from an existing sequence of instructions that form a <a
 848 href="#BasicBlock"><tt>BasicBlock</tt></a> is very straightforward. First, you
 849 must have a pointer to the instruction that you wish to delete.  Second, you
 850 need to obtain the pointer to that instruction's basic block. You use the
 851 pointer to the basic block to get its list of instructions and then use the
 852 erase function to remove your instruction.<p>
 853
 854 For example:<p>
 855
 856 <pre>
 857   <a href="#Instruction">Instruction</a> *I = .. ;
 858   <a href="#BasicBlock">BasicBlock</a> *BB = I-&gt;getParent();
 859   BB-&gt;getInstList().erase(I);
 860 </pre><p>
 861
 862 <!--_______________________________________________________________________-->
 863 </ul><h4><a name="schanges_replacing"><hr size=0>Replacing an
 864     <tt>Instruction</tt> with another <tt>Value</tt></h4><ul>
 865
 866 <p><i>Replacing individual instructions</i></p>
 867 <p>
 868 Including "<a
 869 href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h
 870 </a>" permits use of two very useful replace functions:
 871 <tt>ReplaceInstWithValue</tt> and <tt>ReplaceInstWithInst</tt>.
 872
 873 <ul>
 874
 875 <li><tt>ReplaceInstWithValue</tt>
 876
 877 <p>This function replaces all uses (within a basic block) of a given
 878 instruction with a value, and then removes the original instruction.
 879 The following example illustrates the replacement of the result of a
 880 particular <tt>AllocaInst</tt> that allocates memory for a single
 881 integer with an null pointer to an integer.</p>
 882
 883 <pre>
 884 AllocaInst* instToReplace = ...;
 885 BasicBlock::iterator ii(instToReplace);
 886 ReplaceInstWithValue(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
 887                      Constant::getNullValue(PointerType::get(Type::IntTy)));
 888 </pre>
 889
 890 <li><tt>ReplaceInstWithInst</tt>
 891
 892 <p>This function replaces a particular instruction with another
 893 instruction.  The following example illustrates the replacement of one
 894 <tt>AllocaInst</tt> with another.<p>
 895
 896 <pre>
 897 AllocaInst* instToReplace = ...;
 898 BasicBlock::iterator ii(instToReplace);
 899 ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
 900                     new AllocaInst(Type::IntTy, 0, "ptrToReplacedInt");
 901 </pre>
 902
 903 </ul>
 904 <p><i>Replacing multiple uses of <tt>User</tt>s and
 905                     <tt>Value</tt>s</i></p>
 906
 907 You can use <tt>Value::replaceAllUsesWith</tt> and
 908 <tt>User::replaceUsesOfWith</tt> to change more than one use at a
 909 time.  See the doxygen documentation for the <a
 910 href="/doxygen/classValue.html">Value Class</a> and <a
 911 href="/doxygen/classUser.html">User Class</a>, respectively, for more
 912 information.
 913
 914 <!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
 915 include/llvm/Transforms/Utils/ especially BasicBlockUtils.h with:
 916 ReplaceInstWithValue, ReplaceInstWithInst
 917 -->
 918
 919 <!-- *********************************************************************** -->
 920 </ul><table width="100%" bgcolor="#330077" border=0 cellpadding=4 cellspacing=0>
 921 <tr><td align=center><font color="#EEEEFF" size=+2 face="Georgia,Palatino"><b>
 922 <a name="coreclasses">The Core LLVM Class Hierarchy Reference
 923 </b></font></td></tr></table><ul>
 924 <!-- *********************************************************************** -->
 925
 926 The Core LLVM classes are the primary means of representing the program being
 927 inspected or transformed.  The core LLVM classes are defined in header files in
 928 the <tt>include/llvm/</tt> directory, and implemented in the <tt>lib/VMCore</tt>
 929 directory.<p>
 930
 931
 932 <!-- ======================================================================= -->
 933 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
 934 <tr><td>&nbsp;</td><td width="100%">&nbsp;
 935 <font color="#EEEEFF" face="Georgia,Palatino"><b>
 936 <a name="Value">The <tt>Value</tt> class</a>
 937 </b></font></td></tr></table><ul>
 938
 939 <tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt></b><br>
 940 doxygen info: <a href="/doxygen/classValue.html">Value Class</a><p>
 941
 942
 943 The <tt>Value</tt> class is the most important class in LLVM Source base.  It
 944 represents a typed value that may be used (among other things) as an operand to
 945 an instruction.  There are many different types of <tt>Value</tt>s, such as <a
 946 href="#Constant"><tt>Constant</tt></a>s, <a
 947 href="#Argument"><tt>Argument</tt></a>s, and even <a
 948 href="#Instruction"><tt>Instruction</tt></a>s and <a
 949 href="#Function"><tt>Function</tt></a>s are <tt>Value</tt>s.<p>
 950
 951 A particular <tt>Value</tt> may be used many times in the LLVM representation
 952 for a program.  For example, an incoming argument to a function (represented
 953 with an instance of the <a href="#Argument">Argument</a> class) is "used" by
 954 every instruction in the function that references the argument.  To keep track
 955 of this relationship, the <tt>Value</tt> class keeps a list of all of the <a
 956 href="#User"><tt>User</tt></a>s that is using it (the <a
 957 href="#User"><tt>User</tt></a> class is a base class for all nodes in the LLVM
 958 graph that can refer to <tt>Value</tt>s).  This use list is how LLVM represents
 959 def-use information in the program, and is accessible through the <tt>use_</tt>*
 960 methods, shown below.<p>
 961
 962 Because LLVM is a typed representation, every LLVM <tt>Value</tt> is typed, and
 963 this <a href="#Type">Type</a> is available through the <tt>getType()</tt>
 964 method.  <a name="#nameWarning">In addition, all LLVM values can be named.  The
 965 "name" of the <tt>Value</tt> is symbolic string printed in the LLVM code:<p>
 966
 967 <pre>
 968    %<b>foo</b> = add int 1, 2
 969 </pre>
 970
 971 The name of this instruction is "foo".  <b>NOTE</b> that the name of any value
 972 may be missing (an empty string), so names should <b>ONLY</b> be used for
 973 debugging (making the source code easier to read, debugging printouts), they
 974 should not be used to keep track of values or map between them.  For this
 975 purpose, use a <tt>std::map</tt> of pointers to the <tt>Value</tt> itself
 976 instead.<p>
 977
 978 One important aspect of LLVM is that there is no distinction between an SSA
 979 variable and the operation that produces it.  Because of this, any reference to
 980 the value produced by an instruction (or the value available as an incoming
 981 argument, for example) is represented as a direct pointer to the class that
 982 represents this value.  Although this may take some getting used to, it
 983 simplifies the representation and makes it easier to manipulate.<p>
 984
 985
 986 <!-- _______________________________________________________________________ -->
 987 </ul><h4><a name="m_Value"><hr size=0>Important Public Members of
 988 the <tt>Value</tt> class</h4><ul>
 989
 990 <li><tt>Value::use_iterator</tt> - Typedef for iterator over the use-list<br>
 991     <tt>Value::use_const_iterator</tt>
 992                  - Typedef for const_iterator over the use-list<br>
 993     <tt>unsigned use_size()</tt> - Returns the number of users of the value.<br>
 994     <tt>bool use_empty()</tt> - Returns true if there are no users.<br>
 995     <tt>use_iterator use_begin()</tt>
 996                  - Get an iterator to the start of the use-list.<br>
 997     <tt>use_iterator use_end()</tt>
 998                  - Get an iterator to the end of the use-list.<br>
 999     <tt><a href="#User">User</a> *use_back()</tt>
1000                  - Returns the last element in the list.<p>
1001
1002 These methods are the interface to access the def-use information in LLVM.  As with all other iterators in LLVM, the naming conventions follow the conventions defined by the <a href="#stl">STL</a>.<p>
1003
1004 <li><tt><a href="#Type">Type</a> *getType() const</tt><p>
1005 This method returns the Type of the Value.
1006
1007 <li><tt>bool hasName() const</tt><br>
1008     <tt>std::string getName() const</tt><br>
1009     <tt>void setName(const std::string &amp;Name)</tt><p>
1010
1011 This family of methods is used to access and assign a name to a <tt>Value</tt>,
1012 be aware of the <a href="#nameWarning">precaution above</a>.<p>
1013
1014
1015 <li><tt>void replaceAllUsesWith(Value *V)</tt><p>
1016
1017 This method traverses the use list of a <tt>Value</tt> changing all <a
1018 href="#User"><tt>User</tt>s</a> of the current value to refer to "<tt>V</tt>"
1019 instead.  For example, if you detect that an instruction always produces a
1020 constant value (for example through constant folding), you can replace all uses
1021 of the instruction with the constant like this:<p>
1022
1023 <pre>
1024   Inst-&gt;replaceAllUsesWith(ConstVal);
1025 </pre><p>
1026
1027
1028
1029 <!-- ======================================================================= -->
1030 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1031 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1032 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1033 <a name="User">The <tt>User</tt> class</a>
1034 </b></font></td></tr></table><ul>
1035
1036 <tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt></b><br>
1037 doxygen info: <a href="/doxygen/classUser.html">User Class</a><br>
1038 Superclass: <a href="#Value"><tt>Value</tt></a><p>
1039
1040
1041 The <tt>User</tt> class is the common base class of all LLVM nodes that may
1042 refer to <a href="#Value"><tt>Value</tt></a>s.  It exposes a list of "Operands"
1043 that are all of the <a href="#Value"><tt>Value</tt></a>s that the User is
1044 referring to.  The <tt>User</tt> class itself is a subclass of
1045 <tt>Value</tt>.<p>
1046
1047 The operands of a <tt>User</tt> point directly to the LLVM <a
1048 href="#Value"><tt>Value</tt></a> that it refers to.  Because LLVM uses Static
1049 Single Assignment (SSA) form, there can only be one definition referred to,
1050 allowing this direct connection.  This connection provides the use-def
1051 information in LLVM.<p>
1052
1053 <!-- _______________________________________________________________________ -->
1054 </ul><h4><a name="m_User"><hr size=0>Important Public Members of
1055 the <tt>User</tt> class</h4><ul>
1056
1057 The <tt>User</tt> class exposes the operand list in two ways: through an index
1058 access interface and through an iterator based interface.<p>
1059
1060 <li><tt>Value *getOperand(unsigned i)</tt><br>
1061     <tt>unsigned getNumOperands()</tt><p>
1062
1063 These two methods expose the operands of the <tt>User</tt> in a convenient form
1064 for direct access.<p>
1065
1066 <li><tt>User::op_iterator</tt> - Typedef for iterator over the operand list<br>
1067     <tt>User::op_const_iterator</tt>
1068     <tt>use_iterator op_begin()</tt>
1069                  - Get an iterator to the start of the operand list.<br>
1070     <tt>use_iterator op_end()</tt>
1071                  - Get an iterator to the end of the operand list.<p>
1072
1073 Together, these methods make up the iterator based interface to the operands of
1074 a <tt>User</tt>.<p>
1075
1076
1077
1078 <!-- ======================================================================= -->
1079 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1080 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1081 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1082 <a name="Instruction">The <tt>Instruction</tt> class</a>
1083 </b></font></td></tr></table><ul>
1084
1085 <tt>#include "<a
1086 href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt></b><br>
1087 doxygen info: <a href="/doxygen/classInstruction.html">Instruction Class</a><br>
1088 Superclasses: <a href="#User"><tt>User</tt></a>, <a
1089 href="#Value"><tt>Value</tt></a><p>
1090
1091 The <tt>Instruction</tt> class is the common base class for all LLVM
1092 instructions.  It provides only a few methods, but is a very commonly used
1093 class.  The primary data tracked by the <tt>Instruction</tt> class itself is the
1094 opcode (instruction type) and the parent <a
1095 href="#BasicBlock"><tt>BasicBlock</tt></a> the <tt>Instruction</tt> is embedded
1096 into.  To represent a specific type of instruction, one of many subclasses of
1097 <tt>Instruction</tt> are used.<p>
1098
1099 Because the <tt>Instruction</tt> class subclasses the <a
1100 href="#User"><tt>User</tt></a> class, its operands can be accessed in the same
1101 way as for other <a href="#User"><tt>User</tt></a>s (with the
1102 <tt>getOperand()</tt>/<tt>getNumOperands()</tt> and
1103 <tt>op_begin()</tt>/<tt>op_end()</tt> methods).<p>
1104
1105 An important file for the <tt>Instruction</tt> class is the
1106 <tt>llvm/Instruction.def</tt> file.  This file contains some meta-data about the
1107 various different types of instructions in LLVM.  It describes the enum values
1108 that are used as opcodes (for example <tt>Instruction::Add</tt> and
1109 <tt>Instruction::SetLE</tt>), as well as the concrete sub-classes of
1110 <tt>Instruction</tt> that implement the instruction (for example <tt><a
1111 href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
1112 href="#SetCondInst">SetCondInst</a></tt>).  Unfortunately, the use of macros in
1113 this file confused doxygen, so these enum values don't show up correctly in the
1114 <a href="/doxygen/classInstruction.html">doxygen output</a>.<p>
1115
1116
1117 <!-- _______________________________________________________________________ -->
1118 </ul><h4><a name="m_Instruction"><hr size=0>Important Public Members of
1119 the <tt>Instruction</tt> class</h4><ul>
1120
1121 <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt><p>
1122
1123 Returns the <a href="#BasicBlock"><tt>BasicBlock</tt></a> that this
1124 <tt>Instruction</tt> is embedded into.<p>
1125
1126 <li><tt>bool hasSideEffects()</tt><p>
1127
1128 Returns true if the instruction has side effects, i.e. it is a <tt>call</tt>,
1129 <tt>free</tt>, <tt>invoke</tt>, or <tt>store</tt>.<p>
1130
1131 <li><tt>unsigned getOpcode()</tt><p>
1132
1133 Returns the opcode for the <tt>Instruction</tt>.<p>
1134
1135 <li><tt><a href="#Instruction">Instruction</a> *clone() const</tt><p>
1136
1137 Returns another instance of the specified instruction, identical in all ways to
1138 the original except that the instruction has no parent (ie it's not embedded
1139 into a <a href="#BasicBlock"><tt>BasicBlock</tt></a>), and it has no name.<p>
1140
1141
1142
1143 <!--
1144
1145 \subsection{Subclasses of Instruction :}
1146 \begin{itemize}
1147 <li>BinaryOperator : This subclass of Instruction defines a general interface to the all the instructions involvong  binary operators in LLVM.
1148         \begin{itemize}
1149         <li><tt>bool swapOperands()</tt>: Exchange the two operands to this instruction. If the instruction cannot be reversed (i.e. if it's a Div), it returns true.
1150         \end{itemize}
1151 <li>TerminatorInst : This subclass of Instructions defines an interface for all instructions that can terminate a BasicBlock.
1152         \begin{itemize}
1153          <li> <tt>unsigned getNumSuccessors()</tt>: Returns the number of successors for this terminator instruction.
1154         <li><tt>BasicBlock *getSuccessor(unsigned i)</tt>: As the name suggests returns the ith successor BasicBlock.
1155         <li><tt>void setSuccessor(unsigned i, BasicBlock *B)</tt>: sets BasicBlock B as the ith succesor to this terminator instruction.
1156         \end{itemize}
1157
1158 <li>PHINode : This represents the PHI instructions in the SSA form.
1159         \begin{itemize}
1160         <li><tt> unsigned getNumIncomingValues()</tt>: Returns the number of incoming edges to this PHI node.
1161         <li><tt> Value *getIncomingValue(unsigned i)</tt>: Returns the ith incoming Value.
1162         <li><tt>void setIncomingValue(unsigned i, Value *V)</tt>: Sets the ith incoming Value as V
1163         <li><tt>BasicBlock *getIncomingBlock(unsigned i)</tt>: Returns the Basic Block corresponding to the ith incoming Value.
1164         <li><tt> void addIncoming(Value *D, BasicBlock *BB)</tt>:
1165         Add an incoming value to the end of the PHI list
1166         <li><tt> int getBasicBlockIndex(const BasicBlock *BB) const</tt>:
1167         Returns the first index of the specified basic block in the value list for this PHI.  Returns -1 if no instance.
1168         \end{itemize}
1169 <li>CastInst : In LLVM all casts have to be done through explicit cast instructions. CastInst defines the interface to the cast instructions.
1170 <li>CallInst : This defines an interface to the call instruction in LLVM. ARguments to the function are nothing but operands of the instruction.
1171         \begin{itemize}
1172         <li>: <tt>Function *getCalledFunction()</tt>: Returns a handle to the function that is being called by this Function.
1173         \end{itemize}
1174 <li>LoadInst, StoreInst, GetElemPtrInst : These subclasses represent load, store and getelementptr instructions in LLVM.
1175         \begin{itemize}
1176         <li><tt>Value * getPointerOperand()</tt>: Returns the Pointer Operand which is typically the 0th operand.
1177         \end{itemize}
1178 <li>BranchInst : This is a subclass of TerminatorInst and defines the interface for conditional and unconditional branches in LLVM.
1179         \begin{itemize}
1180         <li><tt>bool isConditional()</tt>: Returns true if the branch is a conditional branch else returns false
1181         <li> <tt>Value *getCondition()</tt>: Returns the condition if it is a conditional branch else returns null.
1182         <li> <tt>void setUnconditionalDest(BasicBlock *Dest)</tt>: Changes the current branch to an unconditional one targetting the specified block.
1183         \end{itemize}
1184
1185 \end{itemize}
1186
1187 -->
1188
1189
1190 <!-- ======================================================================= -->
1191 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1192 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1193 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1194 <a name="BasicBlock">The <tt>BasicBlock</tt> class</a>
1195 </b></font></td></tr></table><ul>
1196
1197 <tt>#include "<a
1198 href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt></b><br>
1199 doxygen info: <a href="/doxygen/classBasicBlock.html">BasicBlock Class</a><br>
1200 Superclass: <a href="#Value"><tt>Value</tt></a><p>
1201
1202
1203 This class represents a single entry multiple exit section of the code, commonly
1204 known as a basic block by the compiler community.  The <tt>BasicBlock</tt> class
1205 maintains a list of <a href="#Instruction"><tt>Instruction</tt></a>s, which form
1206 the body of the block.  Matching the language definition, the last element of
1207 this list of instructions is always a terminator instruction (a subclass of the
1208 <a href="#TerminatorInst"><tt>TerminatorInst</tt></a> class).<p>
1209
1210 In addition to tracking the list of instructions that make up the block, the
1211 <tt>BasicBlock</tt> class also keeps track of the <a
1212 href="#Function"><tt>Function</tt></a> that it is embedded into.<p>
1213
1214 Note that <tt>BasicBlock</tt>s themselves are <a
1215 href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions
1216 like branches and can go in the switch tables.  <tt>BasicBlock</tt>s have type
1217 <tt>label</tt>.<p>
1218
1219
1220 <!-- _______________________________________________________________________ -->
1221 </ul><h4><a name="m_BasicBlock"><hr size=0>Important Public Members of
1222 the <tt>BasicBlock</tt> class</h4><ul>
1223
1224 <li><tt>BasicBlock(const std::string &amp;Name = "", <a
1225 href="#Function">Function</a> *Parent = 0)</tt><p>
1226
1227 The <tt>BasicBlock</tt> constructor is used to create new basic blocks for
1228 insertion into a function.  The constructor simply takes a name for the new
1229 block, and optionally a <a href="#Function"><tt>Function</tt></a> to insert it
1230 into.  If the <tt>Parent</tt> parameter is specified, the new
1231 <tt>BasicBlock</tt> is automatically inserted at the end of the specified <a
1232 href="#Function"><tt>Function</tt></a>, if not specified, the BasicBlock must be
1233 manually inserted into the <a href="#Function"><tt>Function</tt></a>.<p>
1234
1235 <li><tt>BasicBlock::iterator</tt> - Typedef for instruction list iterator<br>
1236     <tt>BasicBlock::const_iterator</tt> - Typedef for const_iterator.<br>
1237     <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
1238     <tt>size()</tt>, <tt>empty()</tt>, <tt>rbegin()</tt>, <tt>rend()</tt><p>
1239
1240 These methods and typedefs are forwarding functions that have the same semantics
1241 as the standard library methods of the same names.  These methods expose the
1242 underlying instruction list of a basic block in a way that is easy to
1243 manipulate.  To get the full complement of container operations (including
1244 operations to update the list), you must use the <tt>getInstList()</tt>
1245 method.<p>
1246
1247 <li><tt>BasicBlock::InstListType &amp;getInstList()</tt><p>
1248
1249 This method is used to get access to the underlying container that actually
1250 holds the Instructions.  This method must be used when there isn't a forwarding
1251 function in the <tt>BasicBlock</tt> class for the operation that you would like
1252 to perform.  Because there are no forwarding functions for "updating"
1253 operations, you need to use this if you want to update the contents of a
1254 <tt>BasicBlock</tt>.<p>
1255
1256 <li><tt><A href="#Function">Function</a> *getParent()</tt><p>
1257
1258 Returns a pointer to <a href="#Function"><tt>Function</tt></a> the block is
1259 embedded into, or a null pointer if it is homeless.<p>
1260
1261 <li><tt><a href="#TerminatorInst">TerminatorInst</a> *getTerminator()</tt><p>
1262
1263 Returns a pointer to the terminator instruction that appears at the end of the
1264 <tt>BasicBlock</tt>.  If there is no terminator instruction, or if the last
1265 instruction in the block is not a terminator, then a null pointer is
1266 returned.<p>
1267
1268
1269 <!-- ======================================================================= -->
1270 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1271 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1272 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1273 <a name="GlobalValue">The <tt>GlobalValue</tt> class</a>
1274 </b></font></td></tr></table><ul>
1275
1276 <tt>#include "<a
1277 href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt></b><br>
1278 doxygen info: <a href="/doxygen/classGlobalValue.html">GlobalValue Class</a><br>
1279 Superclasses: <a href="#User"><tt>User</tt></a>, <a
1280 href="#Value"><tt>Value</tt></a><p>
1281
1282 Global values (<A href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
1283 href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
1284 visible in the bodies of all <a href="#Function"><tt>Function</tt></a>s.
1285 Because they are visible at global scope, they are also subject to linking with
1286 other globals defined in different translation units.  To control the linking
1287 process, <tt>GlobalValue</tt>s know their linkage rules.  Specifically,
1288 <tt>GlobalValue</tt>s know whether they have internal or external linkage.<p>
1289
1290 If a <tt>GlobalValue</tt> has internal linkage (equivalent to being
1291 <tt>static</tt> in C), it is not visible to code outside the current translation
1292 unit, and does not participate in linking.  If it has external linkage, it is
1293 visible to external code, and does participate in linking.  In addition to
1294 linkage information, <tt>GlobalValue</tt>s keep track of which <a
1295 href="#Module"><tt>Module</tt></a> they are currently part of.<p>
1296
1297 Because <tt>GlobalValue</tt>s are memory objects, they are always referred to by
1298 their address.  As such, the <a href="#Type"><tt>Type</tt></a> of a global is
1299 always a pointer to its contents.  This is explained in the LLVM Language
1300 Reference Manual.<p>
1301
1302
1303 <!-- _______________________________________________________________________ -->
1304 </ul><h4><a name="m_GlobalValue"><hr size=0>Important Public Members of
1305 the <tt>GlobalValue</tt> class</h4><ul>
1306
1307 <li><tt>bool hasInternalLinkage() const</tt><br>
1308     <tt>bool hasExternalLinkage() const</tt><br>
1309     <tt>void setInternalLinkage(bool HasInternalLinkage)</tt><p>
1310
1311 These methods manipulate the linkage characteristics of the
1312 <tt>GlobalValue</tt>.<p>
1313
1314 <li><tt><a href="#Module">Module</a> *getParent()</tt><p>
1315
1316 This returns the <a href="#Module"><tt>Module</tt></a> that the GlobalValue is
1317 currently embedded into.<p>
1318
1319
1320
1321 <!-- ======================================================================= -->
1322 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1323 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1324 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1325 <a name="Function">The <tt>Function</tt> class</a>
1326 </b></font></td></tr></table><ul>
1327
1328 <tt>#include "<a
1329 href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt></b><br>
1330 doxygen info: <a href="/doxygen/classFunction.html">Function Class</a><br>
1331 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
1332 href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a><p>
1333
1334 The <tt>Function</tt> class represents a single procedure in LLVM.  It is
1335 actually one of the more complex classes in the LLVM heirarchy because it must
1336 keep track of a large amount of data.  The <tt>Function</tt> class keeps track
1337 of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal <a
1338 href="#Argument"><tt>Argument</tt></a>s, and a <a
1339 href="#SymbolTable"><tt>SymbolTable</tt></a>.<p>
1340
1341 The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most commonly
1342 used part of <tt>Function</tt> objects.  The list imposes an implicit ordering
1343 of the blocks in the function, which indicate how the code will be layed out by
1344 the backend.  Additionally, the first <a
1345 href="#BasicBlock"><tt>BasicBlock</tt></a> is the implicit entry node for the
1346 <tt>Function</tt>.  It is not legal in LLVM explicitly branch to this initial
1347 block.  There are no implicit exit nodes, and in fact there may be multiple exit
1348 nodes from a single <tt>Function</tt>.  If the <a
1349 href="#BasicBlock"><tt>BasicBlock</tt></a> list is empty, this indicates that
1350 the <tt>Function</tt> is actually a function declaration: the actual body of the
1351 function hasn't been linked in yet.<p>
1352
1353 In addition to a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, the
1354 <tt>Function</tt> class also keeps track of the list of formal <a
1355 href="#Argument"><tt>Argument</tt></a>s that the function receives.  This
1356 container manages the lifetime of the <a href="#Argument"><tt>Argument</tt></a>
1357 nodes, just like the <a href="#BasicBlock"><tt>BasicBlock</tt></a> list does for
1358 the <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.<p>
1359
1360 The <a href="#SymbolTable"><tt>SymbolTable</tt></a> is a very rarely used LLVM
1361 feature that is only used when you have to look up a value by name.  Aside from
1362 that, the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is used internally to
1363 make sure that there are not conflicts between the names of <a
1364 href="#Instruction"><tt>Instruction</tt></a>s, <a
1365 href="#BasicBlock"><tt>BasicBlock</tt></a>s, or <a
1366 href="#Argument"><tt>Argument</tt></a>s in the function body.<p>
1367
1368
1369 <!-- _______________________________________________________________________ -->
1370 </ul><h4><a name="m_Function"><hr size=0>Important Public Members of
1371 the <tt>Function</tt> class</h4><ul>
1372
1373 <li><tt>Function(const <a href="#FunctionType">FunctionType</a> *Ty, bool isInternal, const std::string &amp;N = "")</tt><p>
1374
1375 Constructor used when you need to create new <tt>Function</tt>s to add the the
1376 program.  The constructor must specify the type of the function to create and
1377 whether or not it should start out with internal or external linkage.<p>
1378
1379 <li><tt>bool isExternal()</tt><p>
1380
1381 Return whether or not the <tt>Function</tt> has a body defined.  If the function
1382 is "external", it does not have a body, and thus must be resolved by linking
1383 with a function defined in a different translation unit.<p>
1384
1385
1386 <li><tt>Function::iterator</tt> - Typedef for basic block list iterator<br>
1387     <tt>Function::const_iterator</tt> - Typedef for const_iterator.<br>
1388     <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
1389     <tt>size()</tt>, <tt>empty()</tt>, <tt>rbegin()</tt>, <tt>rend()</tt><p>
1390
1391 These are forwarding methods that make it easy to access the contents of a
1392 <tt>Function</tt> object's <a href="#BasicBlock"><tt>BasicBlock</tt></a>
1393 list.<p>
1394
1395 <li><tt>Function::BasicBlockListType &amp;getBasicBlockList()</tt><p>
1396
1397 Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.  This is
1398 neccesary to use when you need to update the list or perform a complex action
1399 that doesn't have a forwarding method.<p>
1400
1401
1402 <li><tt>Function::aiterator</tt> - Typedef for the argument list iterator<br>
1403     <tt>Function::const_aiterator</tt> - Typedef for const_iterator.<br>
1404     <tt>abegin()</tt>, <tt>aend()</tt>, <tt>afront()</tt>, <tt>aback()</tt>,
1405     <tt>asize()</tt>, <tt>aempty()</tt>, <tt>arbegin()</tt>, <tt>arend()</tt><p>
1406
1407 These are forwarding methods that make it easy to access the contents of a
1408 <tt>Function</tt> object's <a href="#Argument"><tt>Argument</tt></a> list.<p>
1409
1410 <li><tt>Function::ArgumentListType &amp;getArgumentList()</tt><p>
1411
1412 Returns the list of <a href="#Argument"><tt>Argument</tt></a>s.  This is
1413 neccesary to use when you need to update the list or perform a complex action
1414 that doesn't have a forwarding method.<p>
1415
1416
1417
1418 <li><tt><a href="#BasicBlock">BasicBlock</a> &getEntryNode()</tt><p>
1419
1420 Returns the entry <a href="#BasicBlock"><tt>BasicBlock</tt></a> for the
1421 function.  Because the entry block for the function is always the first block,
1422 this returns the first block of the <tt>Function</tt>.<p>
1423
1424 <li><tt><a href="#Type">Type</a> *getReturnType()</tt><br>
1425     <tt><a href="#FunctionType">FunctionType</a> *getFunctionType()</tt><p>
1426
1427 This traverses the <a href="#Type"><tt>Type</tt></a> of the <tt>Function</tt>
1428 and returns the return type of the function, or the <a
1429 href="#FunctionType"><tt>FunctionType</tt></a> of the actual function.<p>
1430
1431
1432 <li><tt>bool hasSymbolTable() const</tt><p>
1433
1434 Return true if the <tt>Function</tt> has a symbol table allocated to it and if
1435 there is at least one entry in it.<p>
1436
1437 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt><p>
1438
1439 Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a> for this
1440 <tt>Function</tt> or a null pointer if one has not been allocated (because there
1441 are no named values in the function).<p>
1442
1443 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTableSure()</tt><p>
1444
1445 Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a> for this
1446 <tt>Function</tt> or allocate a new <a
1447 href="#SymbolTable"><tt>SymbolTable</tt></a> if one is not already around.  This
1448 should only be used when adding elements to the <a
1449 href="#SymbolTable"><tt>SymbolTable</tt></a>, so that empty symbol tables are
1450 not left laying around.<p>
1451
1452
1453
1454 <!-- ======================================================================= -->
1455 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1456 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1457 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1458 <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a>
1459 </b></font></td></tr></table><ul>
1460
1461 <tt>#include "<a
1462 href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt></b><br>
1463 doxygen info: <a href="/doxygen/classGlobalVariable.html">GlobalVariable Class</a><br>
1464 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>, <a
1465 href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a><p>
1466
1467 Global variables are represented with the (suprise suprise)
1468 <tt>GlobalVariable</tt> class.  Like functions, <tt>GlobalVariable</tt>s are
1469 also subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such
1470 are always referenced by their address (global values must live in memory, so
1471 their "name" refers to their address).  Global variables may have an initial
1472 value (which must be a <a href="#Constant"><tt>Constant</tt></a>), and if they
1473 have an initializer, they may be marked as "constant" themselves (indicating
1474 that their contents never change at runtime).<p>
1475
1476
1477 <!-- _______________________________________________________________________ -->
1478 </ul><h4><a name="m_GlobalVariable"><hr size=0>Important Public Members of the
1479 <tt>GlobalVariable</tt> class</h4><ul>
1480
1481 <li><tt>GlobalVariable(const <a href="#Type">Type</a> *Ty, bool isConstant, bool
1482 isInternal, <a href="#Constant">Constant</a> *Initializer = 0, const std::string
1483 &amp;Name = "")</tt><p>
1484
1485 Create a new global variable of the specified type.  If <tt>isConstant</tt> is
1486 true then the global variable will be marked as unchanging for the program, and
1487 if <tt>isInternal</tt> is true the resultant global variable will have internal
1488 linkage.  Optionally an initializer and name may be specified for the global variable as well.<p>
1489
1490
1491 <li><tt>bool isConstant() const</tt><p>
1492
1493 Returns true if this is a global variable is known not to be modified at
1494 runtime.<p>
1495
1496
1497 <li><tt>bool hasInitializer()</tt><p>
1498
1499 Returns true if this <tt>GlobalVariable</tt> has an intializer.<p>
1500
1501
1502 <li><tt><a href="#Constant">Constant</a> *getInitializer()</tt><p>
1503
1504 Returns the intial value for a <tt>GlobalVariable</tt>.  It is not legal to call
1505 this method if there is no initializer.<p>
1506
1507
1508 <!-- ======================================================================= -->
1509 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1510 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1511 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1512 <a name="Module">The <tt>Module</tt> class</a>
1513 </b></font></td></tr></table><ul>
1514
1515 <tt>#include "<a
1516 href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt></b><br>
1517 doxygen info: <a href="/doxygen/classModule.html">Module Class</a><p>
1518
1519 The <tt>Module</tt> class represents the top level structure present in LLVM
1520 programs.  An LLVM module is effectively either a translation unit of the
1521 original program or a combination of several translation units merged by the
1522 linker.  The <tt>Module</tt> class keeps track of a list of <a
1523 href="#Function"><tt>Function</tt></a>s, a list of <a
1524 href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a
1525 href="#SymbolTable"><tt>SymbolTable</tt></a>.  Additionally, it contains a few
1526 helpful member functions that try to make common operations easy.<p>
1527
1528
1529 <!-- _______________________________________________________________________ -->
1530 </ul><h4><a name="m_Module"><hr size=0>Important Public Members of the
1531 <tt>Module</tt> class</h4><ul>
1532
1533 <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
1534     <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>
1535     <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
1536     <tt>size()</tt>, <tt>empty()</tt>, <tt>rbegin()</tt>, <tt>rend()</tt><p>
1537
1538 These are forwarding methods that make it easy to access the contents of a
1539 <tt>Module</tt> object's <a href="#Function"><tt>Function</tt></a>
1540 list.<p>
1541
1542 <li><tt>Module::FunctionListType &amp;getFunctionList()</tt><p>
1543
1544 Returns the list of <a href="#Function"><tt>Function</tt></a>s.  This is
1545 neccesary to use when you need to update the list or perform a complex action
1546 that doesn't have a forwarding method.<p>
1547
1548 <!--  Global Variable -->
1549 <hr size=0>
1550
1551 <li><tt>Module::giterator</tt> - Typedef for global variable list iterator<br>
1552     <tt>Module::const_giterator</tt> - Typedef for const_iterator.<br>
1553     <tt>gbegin()</tt>, <tt>gend()</tt>, <tt>gfront()</tt>, <tt>gback()</tt>,
1554     <tt>gsize()</tt>, <tt>gempty()</tt>, <tt>grbegin()</tt>, <tt>grend()</tt><p>
1555
1556 These are forwarding methods that make it easy to access the contents of a
1557 <tt>Module</tt> object's <a href="#GlobalVariable"><tt>GlobalVariable</tt></a>
1558 list.<p>
1559
1560 <li><tt>Module::GlobalListType &amp;getGlobalList()</tt><p>
1561
1562 Returns the list of <a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s.
1563 This is neccesary to use when you need to update the list or perform a complex
1564 action that doesn't have a forwarding method.<p>
1565
1566
1567 <!--  Symbol table stuff -->
1568 <hr size=0>
1569
1570 <li><tt>bool hasSymbolTable() const</tt><p>
1571
1572 Return true if the <tt>Module</tt> has a symbol table allocated to it and if
1573 there is at least one entry in it.<p>
1574
1575 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt><p>
1576
1577 Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a> for this
1578 <tt>Module</tt> or a null pointer if one has not been allocated (because there
1579 are no named values in the function).<p>
1580
1581 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTableSure()</tt><p>
1582
1583 Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a> for this
1584 <tt>Module</tt> or allocate a new <a
1585 href="#SymbolTable"><tt>SymbolTable</tt></a> if one is not already around.  This
1586 should only be used when adding elements to the <a
1587 href="#SymbolTable"><tt>SymbolTable</tt></a>, so that empty symbol tables are
1588 not left laying around.<p>
1589
1590
1591 <!--  Convenience methods -->
1592 <hr size=0>
1593
1594 <li><tt><a href="#Function">Function</a> *getFunction(const std::string &amp;Name, const <a href="#FunctionType">FunctionType</a> *Ty)</tt><p>
1595
1596 Look up the specified function in the <tt>Module</tt> <a
1597 href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, return
1598 <tt>null</tt>.<p>
1599
1600
1601 <li><tt><a href="#Function">Function</a> *getOrInsertFunction(const std::string
1602          &amp;Name, const <a href="#FunctionType">FunctionType</a> *T)</tt><p>
1603
1604 Look up the specified function in the <tt>Module</tt> <a
1605 href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, add an
1606 external declaration for the function and return it.<p>
1607
1608
1609 <li><tt>std::string getTypeName(const <a href="#Type">Type</a> *Ty)</tt><p>
1610
1611 If there is at least one entry in the <a
1612 href="#SymbolTable"><tt>SymbolTable</tt></a> for the specified <a
1613 href="#Type"><tt>Type</tt></a>, return it.  Otherwise return the empty
1614 string.<p>
1615
1616
1617 <li><tt>bool addTypeName(const std::string &Name, const <a href="#Type">Type</a>
1618 *Ty)</tt><p>
1619
1620 Insert an entry in the <a href="#SymbolTable"><tt>SymbolTable</tt></a> mapping
1621 <tt>Name</tt> to <tt>Ty</tt>. If there is already an entry for this name, true
1622 is returned and the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is not
1623 modified.<p>
1624
1625
1626 <!-- ======================================================================= -->
1627 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1628 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1629 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1630 <a name="Constant">The <tt>Constant</tt> class and subclasses</a>
1631 </b></font></td></tr></table><ul>
1632
1633 Constant represents a base class for different types of constants. It is
1634 subclassed by ConstantBool, ConstantInt, ConstantSInt, ConstantUInt,
1635 ConstantArray etc for representing the various types of Constants.<p>
1636
1637
1638 <!-- _______________________________________________________________________ -->
1639 </ul><h4><a name="m_Value"><hr size=0>Important Public Methods</h4><ul>
1640
1641 <li><tt>bool isConstantExpr()</tt>: Returns true if it is a ConstantExpr
1642
1643
1644 <hr>
1645 Important Subclasses of Constant<p>
1646
1647 <ul>
1648 <li>ConstantSInt : This subclass of Constant represents a signed integer constant.
1649 <ul>
1650         <li><tt>int64_t getValue() const</tt>: Returns the underlying value of this constant.
1651 </ul>
1652 <li>ConstantUInt : This class represents an unsigned integer.
1653 <ul>
1654         <li><tt>uint64_t getValue() const</tt>: Returns the underlying value of this constant.
1655 </ul>
1656 <li>ConstantFP : This class represents a floating point constant.
1657 <ul>
1658         <li><tt>double getValue() const</tt>: Returns the underlying value of this constant.
1659 </ul>
1660 <li>ConstantBool : This represents a boolean constant.
1661 <ul>
1662         <li><tt>bool getValue() const</tt>: Returns the underlying value of this constant.
1663 </ul>
1664 <li>ConstantArray : This represents a constant array.
1665 <ul>
1666         <li><tt>const std::vector<Use> &amp;getValues() const</tt>: Returns a Vecotr of component constants that makeup this array.
1667 </ul>
1668 <li>ConstantStruct : This represents a constant struct.
1669 <ul>
1670         <li><tt>const std::vector<Use> &amp;getValues() const</tt>: Returns a Vecotr of component constants that makeup this array.
1671 </ul>
1672 <li>ConstantPointerRef : This represents a constant pointer value that is initialized to point to a global value, which lies at a constant fixed address.
1673 <ul>
1674 <li><tt>GlobalValue *getValue()</tt>: Returns the global value to which this pointer is pointing to.
1675 </ul>
1676 </ul>
1677
1678
1679 <!-- ======================================================================= -->
1680 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1681 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1682 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1683 <a name="Type">The <tt>Type</tt> class and Derived Types</a>
1684 </b></font></td></tr></table><ul>
1685
1686 Type as noted earlier is also a subclass of a Value class.  Any primitive
1687 type (like int, short etc) in LLVM is an instance of Type Class.  All
1688 other types are instances of subclasses of type like FunctionType,
1689 ArrayType etc. DerivedType is the interface for all such dervied types
1690 including FunctionType, ArrayType, PointerType, StructType. Types can have
1691 names. They can be recursive (StructType). There exists exactly one instance
1692 of any type structure at a time. This allows using pointer equality of Type *s for comparing types.
1693
1694 <!-- _______________________________________________________________________ -->
1695 </ul><h4><a name="m_Value"><hr size=0>Important Public Methods</h4><ul>
1696
1697 <li><tt>PrimitiveID getPrimitiveID() const</tt>: Returns the base type of the type.
1698 <li><tt> bool isSigned() const</tt>: Returns whether an integral numeric type is signed. This is true for SByteTy, ShortTy, IntTy, LongTy. Note that this is not true for Float and Double.
1699 <li><tt>bool isUnsigned() const</tt>: Returns whether a numeric type is unsigned. This is not quite the complement of isSigned... nonnumeric types return false as they do with isSigned. This returns true for UByteTy, UShortTy, UIntTy, and ULongTy.
1700 <li><tt> bool isInteger() const</tt>: Equilivent to isSigned() || isUnsigned(), but with only a single virtual function invocation.
1701 <li><tt>bool isIntegral() const</tt>: Returns true if this is an integral type, which is either Bool type or one of the Integer types.
1702
1703 <li><tt>bool isFloatingPoint()</tt>: Return true if this is one of the two floating point types.
1704 <li><tt>bool isRecursive() const</tt>: Returns rue if the type graph contains a cycle.
1705 <li><tt>isLosslesslyConvertableTo (const Type *Ty) const</tt>: Return true if this type can be converted to 'Ty' without any reinterpretation of bits. For example, uint to int.
1706 <li><tt>bool isPrimitiveType() const</tt>: Returns true if it is a primitive type.
1707 <li><tt>bool isDerivedType() const</tt>: Returns true if it is a derived type.
1708 <li><tt>const Type * getContainedType (unsigned i) const</tt>:
1709 This method is used to implement the type iterator. For derived types, this returns the types 'contained' in the derived type, returning 0 when 'i' becomes invalid. This allows the user to iterate over the types in a struct, for example, really easily.
1710 <li><tt>unsigned getNumContainedTypes() const</tt>: Return the number of types in the derived type.
1711
1712 <p>
1713
1714 <hr>
1715 Derived Types<p>
1716
1717 <ul>
1718 <li>SequentialType : This is subclassed by ArrayType and PointerType
1719 <ul>
1720         <li><tt>const Type * getElementType() const</tt>: Returns the type of each of the elements in the sequential type.
1721 </ul>
1722 <li>ArrayType : This is a subclass of SequentialType and defines interface for array types.
1723 <ul>
1724         <li><tt>unsigned getNumElements() const</tt>: Returns the number of elements in the array.
1725 </ul>
1726 <li>PointerType : Subclass of SequentialType for  pointer types.
1727 <li>StructType : subclass of DerivedTypes for struct types
1728 <li>FunctionType : subclass of DerivedTypes for function types.
1729
1730 <ul>
1731
1732         <li><tt>bool isVarArg() const</tt>: Returns true if its a vararg function
1733         <li><tt> const Type * getReturnType() const</tt>: Returns the return type of the function.
1734         <li><tt> const ParamTypes &amp;getParamTypes() const</tt>: Returns a vector of parameter types.
1735         <li><tt>const Type * getParamType (unsigned i)</tt>: Returns the type of the ith parameter.
1736         <li><tt> const unsigned getNumParams() const</tt>: Returns the number of formal parameters.
1737 </ul>
1738 </ul>
1739
1740
1741
1742
1743 <!-- ======================================================================= -->
1744 </ul><table width="100%" bgcolor="#441188" border=0 cellpadding=4 cellspacing=0>
1745 <tr><td>&nbsp;</td><td width="100%">&nbsp;
1746 <font color="#EEEEFF" face="Georgia,Palatino"><b>
1747 <a name="Argument">The <tt>Argument</tt> class</a>
1748 </b></font></td></tr></table><ul>
1749
1750 This subclass of Value defines the interface for incoming formal arguments to a
1751 function. A Function maitanis a list of its formal arguments. An argument has a
1752 pointer to the parent Function.
1753
1754
1755
1756
1757 <!-- *********************************************************************** -->
1758 </ul>
1759 <!-- *********************************************************************** -->
1760
1761 <hr><font size-1>
1762 <address>By: <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and
1763 <a href="mailto:sabre@nondot.org">Chris Lattner</a></address>
1764 <!-- Created: Tue Aug  6 15:00:33 CDT 2002 -->
1765 <!-- hhmts start -->
1766 Last modified: Tue Oct  1 18:15:43 CDT 2002
1767 <!-- hhmts end -->
1768 </font></body></html>