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="#datastructure">Picking the Right Data Structure for a Task</a>
  48     <ul>
  49     <li><a href="#ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
  50     <ul>
  51       <li><a href="#dss_fixedarrays">Fixed Size Arrays</a></li>
  52       <li><a href="#dss_heaparrays">Heap Allocated Arrays</a></li>
  53       <li><a href="#dss_smallvector">"llvm/ADT/SmallVector.h"</a></li>
  54       <li><a href="#dss_vector">&lt;vector&gt;</a></li>
  55       <li><a href="#dss_deque">&lt;deque&gt;</a></li>
  56       <li><a href="#dss_list">&lt;list&gt;</a></li>
  57       <li><a href="#dss_ilist">llvm/ADT/ilist</a></li>
  58       <li><a href="#dss_other">Other Sequential Container Options</a></li>
  59     </ul></li>
  60     <li><a href="#ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
  61     <ul>
  62       <li><a href="#dss_sortedvectorset">A sorted 'vector'</a></li>
  63       <li><a href="#dss_smallset">"llvm/ADT/SmallSet.h"</a></li>
  64       <li><a href="#dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a></li>
  65       <li><a href="#dss_denseset">"llvm/ADT/DenseSet.h"</a></li>
  66       <li><a href="#dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a></li>
  67       <li><a href="#dss_set">&lt;set&gt;</a></li>
  68       <li><a href="#dss_setvector">"llvm/ADT/SetVector.h"</a></li>
  69       <li><a href="#dss_uniquevector">"llvm/ADT/UniqueVector.h"</a></li>
  70       <li><a href="#dss_otherset">Other Set-Like ContainerOptions</a></li>
  71     </ul></li>
  72     <li><a href="#ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
  73     <ul>
  74       <li><a href="#dss_sortedvectormap">A sorted 'vector'</a></li>
  75       <li><a href="#dss_stringmap">"llvm/ADT/StringMap.h"</a></li>
  76       <li><a href="#dss_indexedmap">"llvm/ADT/IndexedMap.h"</a></li>
  77       <li><a href="#dss_densemap">"llvm/ADT/DenseMap.h"</a></li>
  78       <li><a href="#dss_map">&lt;map&gt;</a></li>
  79       <li><a href="#dss_othermap">Other Map-Like Container Options</a></li>
  80     </ul></li>
  81     <li><a href="#ds_bit">BitVector-like containers</a>
  82     <ul>
  83       <li><a href="#dss_bitvector">A dense bitvector</a></li>
  84       <li><a href="#dss_sparsebitvector">A sparse bitvector</a></li>
  85     </ul></li>
  86   </ul>
  87   </li>
  88   <li><a href="#common">Helpful Hints for Common Operations</a>
  89     <ul>
  90       <li><a href="#inspection">Basic Inspection and Traversal Routines</a>
  91         <ul>
  92           <li><a href="#iterate_function">Iterating over the <tt>BasicBlock</tt>s
  93 in a <tt>Function</tt></a> </li>
  94           <li><a href="#iterate_basicblock">Iterating over the <tt>Instruction</tt>s
  95 in a <tt>BasicBlock</tt></a> </li>
  96           <li><a href="#iterate_institer">Iterating over the <tt>Instruction</tt>s
  97 in a <tt>Function</tt></a> </li>
  98           <li><a href="#iterate_convert">Turning an iterator into a
  99 class pointer</a> </li>
 100           <li><a href="#iterate_complex">Finding call sites: a more
 101 complex example</a> </li>
 102           <li><a href="#calls_and_invokes">Treating calls and invokes
 103 the same way</a> </li>
 104           <li><a href="#iterate_chains">Iterating over def-use &amp;
 105 use-def chains</a> </li>
 106           <li><a href="#iterate_preds">Iterating over predecessors &amp;
 107 successors of blocks</a></li>
 108         </ul>
 109       </li>
 110       <li><a href="#simplechanges">Making simple changes</a>
 111         <ul>
 112           <li><a href="#schanges_creating">Creating and inserting new
 113                  <tt>Instruction</tt>s</a> </li>
 114           <li><a href="#schanges_deleting">Deleting              <tt>Instruction</tt>s</a> </li>
 115           <li><a href="#schanges_replacing">Replacing an                 <tt>Instruction</tt>
 116 with another <tt>Value</tt></a> </li>
 117           <li><a href="#schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a> </li>
 118         </ul>
 119       </li>
 120 <!--
 121     <li>Working with the Control Flow Graph
 122     <ul>
 123       <li>Accessing predecessors and successors of a <tt>BasicBlock</tt>
 124       <li>
 125       <li>
 126     </ul>
 127 -->
 128     </ul>
 129   </li>
 130
 131   <li><a href="#advanced">Advanced Topics</a>
 132   <ul>
 133   <li><a href="#TypeResolve">LLVM Type Resolution</a>
 134   <ul>
 135     <li><a href="#BuildRecType">Basic Recursive Type Construction</a></li>
 136     <li><a href="#refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a></li>
 137     <li><a href="#PATypeHolder">The PATypeHolder Class</a></li>
 138     <li><a href="#AbstractTypeUser">The AbstractTypeUser Class</a></li>
 139   </ul></li>
 140
 141   <li><a href="#SymbolTable">The <tt>ValueSymbolTable</tt> and <tt>TypeSymbolTable</tt> classes </a></li>
 142   </ul></li>
 143
 144   <li><a href="#coreclasses">The Core LLVM Class Hierarchy Reference</a>
 145     <ul>
 146       <li><a href="#Type">The <tt>Type</tt> class</a> </li>
 147       <li><a href="#Module">The <tt>Module</tt> class</a></li>
 148       <li><a href="#Value">The <tt>Value</tt> class</a>
 149       <ul>
 150         <li><a href="#User">The <tt>User</tt> class</a>
 151         <ul>
 152           <li><a href="#Instruction">The <tt>Instruction</tt> class</a></li>
 153           <li><a href="#Constant">The <tt>Constant</tt> class</a>
 154           <ul>
 155             <li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
 156             <ul>
 157               <li><a href="#Function">The <tt>Function</tt> class</a></li>
 158               <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class</a></li>
 159             </ul>
 160             </li>
 161           </ul>
 162           </li>
 163         </ul>
 164         </li>
 165         <li><a href="#BasicBlock">The <tt>BasicBlock</tt> class</a></li>
 166         <li><a href="#Argument">The <tt>Argument</tt> class</a></li>
 167       </ul>
 168       </li>
 169     </ul>
 170   </li>
 171 </ol>
 172
 173 <div class="doc_author">
 174   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
 175                 <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>,
 176                 <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a>, and
 177                 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
 178 </div>
 179
 180 <!-- *********************************************************************** -->
 181 <div class="doc_section">
 182   <a name="introduction">Introduction </a>
 183 </div>
 184 <!-- *********************************************************************** -->
 185
 186 <div class="doc_text">
 187
 188 <p>This document is meant to highlight some of the important classes and
 189 interfaces available in the LLVM source-base.  This manual is not
 190 intended to explain what LLVM is, how it works, and what LLVM code looks
 191 like.  It assumes that you know the basics of LLVM and are interested
 192 in writing transformations or otherwise analyzing or manipulating the
 193 code.</p>
 194
 195 <p>This document should get you oriented so that you can find your
 196 way in the continuously growing source code that makes up the LLVM
 197 infrastructure. Note that this manual is not intended to serve as a
 198 replacement for reading the source code, so if you think there should be
 199 a method in one of these classes to do something, but it's not listed,
 200 check the source.  Links to the <a href="/doxygen/">doxygen</a> sources
 201 are provided to make this as easy as possible.</p>
 202
 203 <p>The first section of this document describes general information that is
 204 useful to know when working in the LLVM infrastructure, and the second describes
 205 the Core LLVM classes.  In the future this manual will be extended with
 206 information describing how to use extension libraries, such as dominator
 207 information, CFG traversal routines, and useful utilities like the <tt><a
 208 href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.</p>
 209
 210 </div>
 211
 212 <!-- *********************************************************************** -->
 213 <div class="doc_section">
 214   <a name="general">General Information</a>
 215 </div>
 216 <!-- *********************************************************************** -->
 217
 218 <div class="doc_text">
 219
 220 <p>This section contains general information that is useful if you are working
 221 in the LLVM source-base, but that isn't specific to any particular API.</p>
 222
 223 </div>
 224
 225 <!-- ======================================================================= -->
 226 <div class="doc_subsection">
 227   <a name="stl">The C++ Standard Template Library</a>
 228 </div>
 229
 230 <div class="doc_text">
 231
 232 <p>LLVM makes heavy use of the C++ Standard Template Library (STL),
 233 perhaps much more than you are used to, or have seen before.  Because of
 234 this, you might want to do a little background reading in the
 235 techniques used and capabilities of the library.  There are many good
 236 pages that discuss the STL, and several books on the subject that you
 237 can get, so it will not be discussed in this document.</p>
 238
 239 <p>Here are some useful links:</p>
 240
 241 <ol>
 242
 243 <li><a href="http://www.dinkumware.com/refxcpp.html">Dinkumware C++ Library
 244 reference</a> - an excellent reference for the STL and other parts of the
 245 standard C++ library.</li>
 246
 247 <li><a href="http://www.tempest-sw.com/cpp/">C++ In a Nutshell</a> - This is an
 248 O'Reilly book in the making.  It has a decent
 249 Standard Library
 250 Reference that rivals Dinkumware's, and is unfortunately no longer free since the book has been
 251 published.</li>
 252
 253 <li><a href="http://www.parashift.com/c++-faq-lite/">C++ Frequently Asked
 254 Questions</a></li>
 255
 256 <li><a href="http://www.sgi.com/tech/stl/">SGI's STL Programmer's Guide</a> -
 257 Contains a useful <a
 258 href="http://www.sgi.com/tech/stl/stl_introduction.html">Introduction to the
 259 STL</a>.</li>
 260
 261 <li><a href="http://www.research.att.com/%7Ebs/C++.html">Bjarne Stroustrup's C++
 262 Page</a></li>
 263
 264 <li><a href="http://64.78.49.204/">
 265 Bruce Eckel's Thinking in C++, 2nd ed. Volume 2 Revision 4.0 (even better, get
 266 the book).</a></li>
 267
 268 </ol>
 269
 270 <p>You are also encouraged to take a look at the <a
 271 href="CodingStandards.html">LLVM Coding Standards</a> guide which focuses on how
 272 to write maintainable code more than where to put your curly braces.</p>
 273
 274 </div>
 275
 276 <!-- ======================================================================= -->
 277 <div class="doc_subsection">
 278   <a name="stl">Other useful references</a>
 279 </div>
 280
 281 <div class="doc_text">
 282
 283 <ol>
 284 <li><a href="http://www.psc.edu/%7Esemke/cvs_branches.html">CVS
 285 Branch and Tag Primer</a></li>
 286 <li><a href="http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html">Using
 287 static and shared libraries across platforms</a></li>
 288 </ol>
 289
 290 </div>
 291
 292 <!-- *********************************************************************** -->
 293 <div class="doc_section">
 294   <a name="apis">Important and useful LLVM APIs</a>
 295 </div>
 296 <!-- *********************************************************************** -->
 297
 298 <div class="doc_text">
 299
 300 <p>Here we highlight some LLVM APIs that are generally useful and good to
 301 know about when writing transformations.</p>
 302
 303 </div>
 304
 305 <!-- ======================================================================= -->
 306 <div class="doc_subsection">
 307   <a name="isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt> and
 308   <tt>dyn_cast&lt;&gt;</tt> templates</a>
 309 </div>
 310
 311 <div class="doc_text">
 312
 313 <p>The LLVM source-base makes extensive use of a custom form of RTTI.
 314 These templates have many similarities to the C++ <tt>dynamic_cast&lt;&gt;</tt>
 315 operator, but they don't have some drawbacks (primarily stemming from
 316 the fact that <tt>dynamic_cast&lt;&gt;</tt> only works on classes that
 317 have a v-table). Because they are used so often, you must know what they
 318 do and how they work. All of these templates are defined in the <a
 319  href="/doxygen/Casting_8h-source.html"><tt>llvm/Support/Casting.h</tt></a>
 320 file (note that you very rarely have to include this file directly).</p>
 321
 322 <dl>
 323   <dt><tt>isa&lt;&gt;</tt>: </dt>
 324
 325   <dd><p>The <tt>isa&lt;&gt;</tt> operator works exactly like the Java
 326   "<tt>instanceof</tt>" operator.  It returns true or false depending on whether
 327   a reference or pointer points to an instance of the specified class.  This can
 328   be very useful for constraint checking of various sorts (example below).</p>
 329   </dd>
 330
 331   <dt><tt>cast&lt;&gt;</tt>: </dt>
 332
 333   <dd><p>The <tt>cast&lt;&gt;</tt> operator is a "checked cast" operation. It
 334   converts a pointer or reference from a base class to a derived cast, causing
 335   an assertion failure if it is not really an instance of the right type.  This
 336   should be used in cases where you have some information that makes you believe
 337   that something is of the right type.  An example of the <tt>isa&lt;&gt;</tt>
 338   and <tt>cast&lt;&gt;</tt> template is:</p>
 339
 340 <div class="doc_code">
 341 <pre>
 342 static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
 343   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))
 344     return true;
 345
 346   // <i>Otherwise, it must be an instruction...</i>
 347   return !L-&gt;contains(cast&lt;<a href="#Instruction">Instruction</a>&gt;(V)-&gt;getParent());
 348 }
 349 </pre>
 350 </div>
 351
 352   <p>Note that you should <b>not</b> use an <tt>isa&lt;&gt;</tt> test followed
 353   by a <tt>cast&lt;&gt;</tt>, for that use the <tt>dyn_cast&lt;&gt;</tt>
 354   operator.</p>
 355
 356   </dd>
 357
 358   <dt><tt>dyn_cast&lt;&gt;</tt>:</dt>
 359
 360   <dd><p>The <tt>dyn_cast&lt;&gt;</tt> operator is a "checking cast" operation.
 361   It checks to see if the operand is of the specified type, and if so, returns a
 362   pointer to it (this operator does not work with references). If the operand is
 363   not of the correct type, a null pointer is returned.  Thus, this works very
 364   much like the <tt>dynamic_cast&lt;&gt;</tt> operator in C++, and should be
 365   used in the same circumstances.  Typically, the <tt>dyn_cast&lt;&gt;</tt>
 366   operator is used in an <tt>if</tt> statement or some other flow control
 367   statement like this:</p>
 368
 369 <div class="doc_code">
 370 <pre>
 371 if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast&lt;<a href="#AllocationInst">AllocationInst</a>&gt;(Val)) {
 372   // <i>...</i>
 373 }
 374 </pre>
 375 </div>
 376
 377   <p>This form of the <tt>if</tt> statement effectively combines together a call
 378   to <tt>isa&lt;&gt;</tt> and a call to <tt>cast&lt;&gt;</tt> into one
 379   statement, which is very convenient.</p>
 380
 381   <p>Note that the <tt>dyn_cast&lt;&gt;</tt> operator, like C++'s
 382   <tt>dynamic_cast&lt;&gt;</tt> or Java's <tt>instanceof</tt> operator, can be
 383   abused.  In particular, you should not use big chained <tt>if/then/else</tt>
 384   blocks to check for lots of different variants of classes.  If you find
 385   yourself wanting to do this, it is much cleaner and more efficient to use the
 386   <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p>
 387
 388   </dd>
 389
 390   <dt><tt>cast_or_null&lt;&gt;</tt>: </dt>
 391
 392   <dd><p>The <tt>cast_or_null&lt;&gt;</tt> operator works just like the
 393   <tt>cast&lt;&gt;</tt> operator, except that it allows for a null pointer as an
 394   argument (which it then propagates).  This can sometimes be useful, allowing
 395   you to combine several null checks into one.</p></dd>
 396
 397   <dt><tt>dyn_cast_or_null&lt;&gt;</tt>: </dt>
 398
 399   <dd><p>The <tt>dyn_cast_or_null&lt;&gt;</tt> operator works just like the
 400   <tt>dyn_cast&lt;&gt;</tt> operator, except that it allows for a null pointer
 401   as an argument (which it then propagates).  This can sometimes be useful,
 402   allowing you to combine several null checks into one.</p></dd>
 403
 404 </dl>
 405
 406 <p>These five templates can be used with any classes, whether they have a
 407 v-table or not.  To add support for these templates, you simply need to add
 408 <tt>classof</tt> static methods to the class you are interested casting
 409 to. Describing this is currently outside the scope of this document, but there
 410 are lots of examples in the LLVM source base.</p>
 411
 412 </div>
 413
 414 <!-- ======================================================================= -->
 415 <div class="doc_subsection">
 416   <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a>
 417 </div>
 418
 419 <div class="doc_text">
 420
 421 <p>Often when working on your pass you will put a bunch of debugging printouts
 422 and other code into your pass.  After you get it working, you want to remove
 423 it, but you may need it again in the future (to work out new bugs that you run
 424 across).</p>
 425
 426 <p> Naturally, because of this, you don't want to delete the debug printouts,
 427 but you don't want them to always be noisy.  A standard compromise is to comment
 428 them out, allowing you to enable them if you need them in the future.</p>
 429
 430 <p>The "<tt><a href="/doxygen/Debug_8h-source.html">llvm/Support/Debug.h</a></tt>"
 431 file provides a macro named <tt>DEBUG()</tt> that is a much nicer solution to
 432 this problem.  Basically, you can put arbitrary code into the argument of the
 433 <tt>DEBUG</tt> macro, and it is only executed if '<tt>opt</tt>' (or any other
 434 tool) is run with the '<tt>-debug</tt>' command line argument:</p>
 435
 436 <div class="doc_code">
 437 <pre>
 438 DOUT &lt;&lt; "I am here!\n";
 439 </pre>
 440 </div>
 441
 442 <p>Then you can run your pass like this:</p>
 443
 444 <div class="doc_code">
 445 <pre>
 446 $ opt &lt; a.bc &gt; /dev/null -mypass
 447 <i>&lt;no output&gt;</i>
 448 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 449 I am here!
 450 </pre>
 451 </div>
 452
 453 <p>Using the <tt>DEBUG()</tt> macro instead of a home-brewed solution allows you
 454 to not have to create "yet another" command line option for the debug output for
 455 your pass.  Note that <tt>DEBUG()</tt> macros are disabled for optimized builds,
 456 so they do not cause a performance impact at all (for the same reason, they
 457 should also not contain side-effects!).</p>
 458
 459 <p>One additional nice thing about the <tt>DEBUG()</tt> macro is that you can
 460 enable or disable it directly in gdb.  Just use "<tt>set DebugFlag=0</tt>" or
 461 "<tt>set DebugFlag=1</tt>" from the gdb if the program is running.  If the
 462 program hasn't been started yet, you can always just run it with
 463 <tt>-debug</tt>.</p>
 464
 465 </div>
 466
 467 <!-- _______________________________________________________________________ -->
 468 <div class="doc_subsubsection">
 469   <a name="DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> and
 470   the <tt>-debug-only</tt> option</a>
 471 </div>
 472
 473 <div class="doc_text">
 474
 475 <p>Sometimes you may find yourself in a situation where enabling <tt>-debug</tt>
 476 just turns on <b>too much</b> information (such as when working on the code
 477 generator).  If you want to enable debug information with more fine-grained
 478 control, you define the <tt>DEBUG_TYPE</tt> macro and the <tt>-debug</tt> only
 479 option as follows:</p>
 480
 481 <div class="doc_code">
 482 <pre>
 483 DOUT &lt;&lt; "No debug type\n";
 484 #undef  DEBUG_TYPE
 485 #define DEBUG_TYPE "foo"
 486 DOUT &lt;&lt; "'foo' debug type\n";
 487 #undef  DEBUG_TYPE
 488 #define DEBUG_TYPE "bar"
 489 DOUT &lt;&lt; "'bar' debug type\n";
 490 #undef  DEBUG_TYPE
 491 #define DEBUG_TYPE ""
 492 DOUT &lt;&lt; "No debug type (2)\n";
 493 </pre>
 494 </div>
 495
 496 <p>Then you can run your pass like this:</p>
 497
 498 <div class="doc_code">
 499 <pre>
 500 $ opt &lt; a.bc &gt; /dev/null -mypass
 501 <i>&lt;no output&gt;</i>
 502 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 503 No debug type
 504 'foo' debug type
 505 'bar' debug type
 506 No debug type (2)
 507 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=foo
 508 'foo' debug type
 509 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=bar
 510 'bar' debug type
 511 </pre>
 512 </div>
 513
 514 <p>Of course, in practice, you should only set <tt>DEBUG_TYPE</tt> at the top of
 515 a file, to specify the debug type for the entire module (if you do this before
 516 you <tt>#include "llvm/Support/Debug.h"</tt>, you don't have to insert the ugly
 517 <tt>#undef</tt>'s).  Also, you should use names more meaningful than "foo" and
 518 "bar", because there is no system in place to ensure that names do not
 519 conflict. If two different modules use the same string, they will all be turned
 520 on when the name is specified. This allows, for example, all debug information
 521 for instruction scheduling to be enabled with <tt>-debug-type=InstrSched</tt>,
 522 even if the source lives in multiple files.</p>
 523
 524 </div>
 525
 526 <!-- ======================================================================= -->
 527 <div class="doc_subsection">
 528   <a name="Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
 529   option</a>
 530 </div>
 531
 532 <div class="doc_text">
 533
 534 <p>The "<tt><a
 535 href="/doxygen/Statistic_8h-source.html">llvm/ADT/Statistic.h</a></tt>" file
 536 provides a class named <tt>Statistic</tt> that is used as a unified way to
 537 keep track of what the LLVM compiler is doing and how effective various
 538 optimizations are.  It is useful to see what optimizations are contributing to
 539 making a particular program run faster.</p>
 540
 541 <p>Often you may run your pass on some big program, and you're interested to see
 542 how many times it makes a certain transformation.  Although you can do this with
 543 hand inspection, or some ad-hoc method, this is a real pain and not very useful
 544 for big programs.  Using the <tt>Statistic</tt> class makes it very easy to
 545 keep track of this information, and the calculated information is presented in a
 546 uniform manner with the rest of the passes being executed.</p>
 547
 548 <p>There are many examples of <tt>Statistic</tt> uses, but the basics of using
 549 it are as follows:</p>
 550
 551 <ol>
 552     <li><p>Define your statistic like this:</p>
 553
 554 <div class="doc_code">
 555 <pre>
 556 #define <a href="#DEBUG_TYPE">DEBUG_TYPE</a> "mypassname"   <i>// This goes before any #includes.</i>
 557 STATISTIC(NumXForms, "The # of times I did stuff");
 558 </pre>
 559 </div>
 560
 561   <p>The <tt>STATISTIC</tt> macro defines a static variable, whose name is
 562     specified by the first argument.  The pass name is taken from the DEBUG_TYPE
 563     macro, and the description is taken from the second argument.  The variable
 564     defined ("NumXForms" in this case) acts like an unsigned integer.</p></li>
 565
 566     <li><p>Whenever you make a transformation, bump the counter:</p>
 567
 568 <div class="doc_code">
 569 <pre>
 570 ++NumXForms;   // <i>I did stuff!</i>
 571 </pre>
 572 </div>
 573
 574     </li>
 575   </ol>
 576
 577   <p>That's all you have to do.  To get '<tt>opt</tt>' to print out the
 578   statistics gathered, use the '<tt>-stats</tt>' option:</p>
 579
 580 <div class="doc_code">
 581 <pre>
 582 $ opt -stats -mypassname &lt; program.bc &gt; /dev/null
 583 <i>... statistics output ...</i>
 584 </pre>
 585 </div>
 586
 587   <p> When running <tt>opt</tt> on a C file from the SPEC benchmark
 588 suite, it gives a report that looks like this:</p>
 589
 590 <div class="doc_code">
 591 <pre>
 592    7646 bitcodewriter   - Number of normal instructions
 593     725 bitcodewriter   - Number of oversized instructions
 594  129996 bitcodewriter   - Number of bitcode bytes written
 595    2817 raise           - Number of insts DCEd or constprop'd
 596    3213 raise           - Number of cast-of-self removed
 597    5046 raise           - Number of expression trees converted
 598      75 raise           - Number of other getelementptr's formed
 599     138 raise           - Number of load/store peepholes
 600      42 deadtypeelim    - Number of unused typenames removed from symtab
 601     392 funcresolve     - Number of varargs functions resolved
 602      27 globaldce       - Number of global variables removed
 603       2 adce            - Number of basic blocks removed
 604     134 cee             - Number of branches revectored
 605      49 cee             - Number of setcc instruction eliminated
 606     532 gcse            - Number of loads removed
 607    2919 gcse            - Number of instructions removed
 608      86 indvars         - Number of canonical indvars added
 609      87 indvars         - Number of aux indvars removed
 610      25 instcombine     - Number of dead inst eliminate
 611     434 instcombine     - Number of insts combined
 612     248 licm            - Number of load insts hoisted
 613    1298 licm            - Number of insts hoisted to a loop pre-header
 614       3 licm            - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
 615      75 mem2reg         - Number of alloca's promoted
 616    1444 cfgsimplify     - Number of blocks simplified
 617 </pre>
 618 </div>
 619
 620 <p>Obviously, with so many optimizations, having a unified framework for this
 621 stuff is very nice.  Making your pass fit well into the framework makes it more
 622 maintainable and useful.</p>
 623
 624 </div>
 625
 626 <!-- ======================================================================= -->
 627 <div class="doc_subsection">
 628   <a name="ViewGraph">Viewing graphs while debugging code</a>
 629 </div>
 630
 631 <div class="doc_text">
 632
 633 <p>Several of the important data structures in LLVM are graphs: for example
 634 CFGs made out of LLVM <a href="#BasicBlock">BasicBlock</a>s, CFGs made out of
 635 LLVM <a href="CodeGenerator.html#machinebasicblock">MachineBasicBlock</a>s, and
 636 <a href="CodeGenerator.html#selectiondag_intro">Instruction Selection
 637 DAGs</a>.  In many cases, while debugging various parts of the compiler, it is
 638 nice to instantly visualize these graphs.</p>
 639
 640 <p>LLVM provides several callbacks that are available in a debug build to do
 641 exactly that.  If you call the <tt>Function::viewCFG()</tt> method, for example,
 642 the current LLVM tool will pop up a window containing the CFG for the function
 643 where each basic block is a node in the graph, and each node contains the
 644 instructions in the block.  Similarly, there also exists
 645 <tt>Function::viewCFGOnly()</tt> (does not include the instructions), the
 646 <tt>MachineFunction::viewCFG()</tt> and <tt>MachineFunction::viewCFGOnly()</tt>,
 647 and the <tt>SelectionDAG::viewGraph()</tt> methods.  Within GDB, for example,
 648 you can usually use something like <tt>call DAG.viewGraph()</tt> to pop
 649 up a window.  Alternatively, you can sprinkle calls to these functions in your
 650 code in places you want to debug.</p>
 651
 652 <p>Getting this to work requires a small amount of configuration.  On Unix
 653 systems with X11, install the <a href="http://www.graphviz.org">graphviz</a>
 654 toolkit, and make sure 'dot' and 'gv' are in your path.  If you are running on
 655 Mac OS/X, download and install the Mac OS/X <a
 656 href="http://www.pixelglow.com/graphviz/">Graphviz program</a>, and add
 657 <tt>/Applications/Graphviz.app/Contents/MacOS/</tt> (or wherever you install
 658 it) to your path.  Once in your system and path are set up, rerun the LLVM
 659 configure script and rebuild LLVM to enable this functionality.</p>
 660
 661 <p><tt>SelectionDAG</tt> has been extended to make it easier to locate
 662 <i>interesting</i> nodes in large complex graphs.  From gdb, if you
 663 <tt>call DAG.setGraphColor(<i>node</i>, "<i>color</i>")</tt>, then the
 664 next <tt>call DAG.viewGraph()</tt> would highlight the node in the
 665 specified color (choices of colors can be found at <a
 666 href="http://www.graphviz.org/doc/info/colors.html">colors</a>.) More
 667 complex node attributes can be provided with <tt>call
 668 DAG.setGraphAttrs(<i>node</i>, "<i>attributes</i>")</tt> (choices can be
 669 found at <a href="http://www.graphviz.org/doc/info/attrs.html">Graph
 670 Attributes</a>.)  If you want to restart and clear all the current graph
 671 attributes, then you can <tt>call DAG.clearGraphAttrs()</tt>. </p>
 672
 673 </div>
 674
 675 <!-- *********************************************************************** -->
 676 <div class="doc_section">
 677   <a name="datastructure">Picking the Right Data Structure for a Task</a>
 678 </div>
 679 <!-- *********************************************************************** -->
 680
 681 <div class="doc_text">
 682
 683 <p>LLVM has a plethora of data structures in the <tt>llvm/ADT/</tt> directory,
 684  and we commonly use STL data structures.  This section describes the trade-offs
 685  you should consider when you pick one.</p>
 686
 687 <p>
 688 The first step is a choose your own adventure: do you want a sequential
 689 container, a set-like container, or a map-like container?  The most important
 690 thing when choosing a container is the algorithmic properties of how you plan to
 691 access the container.  Based on that, you should use:</p>
 692
 693 <ul>
 694 <li>a <a href="#ds_map">map-like</a> container if you need efficient look-up
 695     of an value based on another value.  Map-like containers also support
 696     efficient queries for containment (whether a key is in the map).  Map-like
 697     containers generally do not support efficient reverse mapping (values to
 698     keys).  If you need that, use two maps.  Some map-like containers also
 699     support efficient iteration through the keys in sorted order.  Map-like
 700     containers are the most expensive sort, only use them if you need one of
 701     these capabilities.</li>
 702
 703 <li>a <a href="#ds_set">set-like</a> container if you need to put a bunch of
 704     stuff into a container that automatically eliminates duplicates.  Some
 705     set-like containers support efficient iteration through the elements in
 706     sorted order.  Set-like containers are more expensive than sequential
 707     containers.
 708 </li>
 709
 710 <li>a <a href="#ds_sequential">sequential</a> container provides
 711     the most efficient way to add elements and keeps track of the order they are
 712     added to the collection.  They permit duplicates and support efficient
 713     iteration, but do not support efficient look-up based on a key.
 714 </li>
 715
 716 <li>a <a href="#ds_bit">bit</a> container provides an efficient way to store and
 717     perform set operations on sets of numeric id's, while automatically
 718     eliminating duplicates.  Bit containers require a maximum of 1 bit for each
 719     identifier you want to store.
 720 </li>
 721 </ul>
 722
 723 <p>
 724 Once the proper category of container is determined, you can fine tune the
 725 memory use, constant factors, and cache behaviors of access by intelligently
 726 picking a member of the category.  Note that constant factors and cache behavior
 727 can be a big deal.  If you have a vector that usually only contains a few
 728 elements (but could contain many), for example, it's much better to use
 729 <a href="#dss_smallvector">SmallVector</a> than <a href="#dss_vector">vector</a>
 730 .  Doing so avoids (relatively) expensive malloc/free calls, which dwarf the
 731 cost of adding the elements to the container. </p>
 732
 733 </div>
 734
 735 <!-- ======================================================================= -->
 736 <div class="doc_subsection">
 737   <a name="ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
 738 </div>
 739
 740 <div class="doc_text">
 741 There are a variety of sequential containers available for you, based on your
 742 needs.  Pick the first in this section that will do what you want.
 743 </div>
 744
 745 <!-- _______________________________________________________________________ -->
 746 <div class="doc_subsubsection">
 747   <a name="dss_fixedarrays">Fixed Size Arrays</a>
 748 </div>
 749
 750 <div class="doc_text">
 751 <p>Fixed size arrays are very simple and very fast.  They are good if you know
 752 exactly how many elements you have, or you have a (low) upper bound on how many
 753 you have.</p>
 754 </div>
 755
 756 <!-- _______________________________________________________________________ -->
 757 <div class="doc_subsubsection">
 758   <a name="dss_heaparrays">Heap Allocated Arrays</a>
 759 </div>
 760
 761 <div class="doc_text">
 762 <p>Heap allocated arrays (new[] + delete[]) are also simple.  They are good if
 763 the number of elements is variable, if you know how many elements you will need
 764 before the array is allocated, and if the array is usually large (if not,
 765 consider a <a href="#dss_smallvector">SmallVector</a>).  The cost of a heap
 766 allocated array is the cost of the new/delete (aka malloc/free).  Also note that
 767 if you are allocating an array of a type with a constructor, the constructor and
 768 destructors will be run for every element in the array (re-sizable vectors only
 769 construct those elements actually used).</p>
 770 </div>
 771
 772 <!-- _______________________________________________________________________ -->
 773 <div class="doc_subsubsection">
 774   <a name="dss_smallvector">"llvm/ADT/SmallVector.h"</a>
 775 </div>
 776
 777 <div class="doc_text">
 778 <p><tt>SmallVector&lt;Type, N&gt;</tt> is a simple class that looks and smells
 779 just like <tt>vector&lt;Type&gt;</tt>:
 780 it supports efficient iteration, lays out elements in memory order (so you can
 781 do pointer arithmetic between elements), supports efficient push_back/pop_back
 782 operations, supports efficient random access to its elements, etc.</p>
 783
 784 <p>The advantage of SmallVector is that it allocates space for
 785 some number of elements (N) <b>in the object itself</b>.  Because of this, if
 786 the SmallVector is dynamically smaller than N, no malloc is performed.  This can
 787 be a big win in cases where the malloc/free call is far more expensive than the
 788 code that fiddles around with the elements.</p>
 789
 790 <p>This is good for vectors that are "usually small" (e.g. the number of
 791 predecessors/successors of a block is usually less than 8).  On the other hand,
 792 this makes the size of the SmallVector itself large, so you don't want to
 793 allocate lots of them (doing so will waste a lot of space).  As such,
 794 SmallVectors are most useful when on the stack.</p>
 795
 796 <p>SmallVector also provides a nice portable and efficient replacement for
 797 <tt>alloca</tt>.</p>
 798
 799 </div>
 800
 801 <!-- _______________________________________________________________________ -->
 802 <div class="doc_subsubsection">
 803   <a name="dss_vector">&lt;vector&gt;</a>
 804 </div>
 805
 806 <div class="doc_text">
 807 <p>
 808 std::vector is well loved and respected.  It is useful when SmallVector isn't:
 809 when the size of the vector is often large (thus the small optimization will
 810 rarely be a benefit) or if you will be allocating many instances of the vector
 811 itself (which would waste space for elements that aren't in the container).
 812 vector is also useful when interfacing with code that expects vectors :).
 813 </p>
 814
 815 <p>One worthwhile note about std::vector: avoid code like this:</p>
 816
 817 <div class="doc_code">
 818 <pre>
 819 for ( ... ) {
 820    std::vector&lt;foo&gt; V;
 821    use V;
 822 }
 823 </pre>
 824 </div>
 825
 826 <p>Instead, write this as:</p>
 827
 828 <div class="doc_code">
 829 <pre>
 830 std::vector&lt;foo&gt; V;
 831 for ( ... ) {
 832    use V;
 833    V.clear();
 834 }
 835 </pre>
 836 </div>
 837
 838 <p>Doing so will save (at least) one heap allocation and free per iteration of
 839 the loop.</p>
 840
 841 </div>
 842
 843 <!-- _______________________________________________________________________ -->
 844 <div class="doc_subsubsection">
 845   <a name="dss_deque">&lt;deque&gt;</a>
 846 </div>
 847
 848 <div class="doc_text">
 849 <p>std::deque is, in some senses, a generalized version of std::vector.  Like
 850 std::vector, it provides constant time random access and other similar
 851 properties, but it also provides efficient access to the front of the list.  It
 852 does not guarantee continuity of elements within memory.</p>
 853
 854 <p>In exchange for this extra flexibility, std::deque has significantly higher
 855 constant factor costs than std::vector.  If possible, use std::vector or
 856 something cheaper.</p>
 857 </div>
 858
 859 <!-- _______________________________________________________________________ -->
 860 <div class="doc_subsubsection">
 861   <a name="dss_list">&lt;list&gt;</a>
 862 </div>
 863
 864 <div class="doc_text">
 865 <p>std::list is an extremely inefficient class that is rarely useful.
 866 It performs a heap allocation for every element inserted into it, thus having an
 867 extremely high constant factor, particularly for small data types.  std::list
 868 also only supports bidirectional iteration, not random access iteration.</p>
 869
 870 <p>In exchange for this high cost, std::list supports efficient access to both
 871 ends of the list (like std::deque, but unlike std::vector or SmallVector).  In
 872 addition, the iterator invalidation characteristics of std::list are stronger
 873 than that of a vector class: inserting or removing an element into the list does
 874 not invalidate iterator or pointers to other elements in the list.</p>
 875 </div>
 876
 877 <!-- _______________________________________________________________________ -->
 878 <div class="doc_subsubsection">
 879   <a name="dss_ilist">llvm/ADT/ilist</a>
 880 </div>
 881
 882 <div class="doc_text">
 883 <p><tt>ilist&lt;T&gt;</tt> implements an 'intrusive' doubly-linked list.  It is
 884 intrusive, because it requires the element to store and provide access to the
 885 prev/next pointers for the list.</p>
 886
 887 <p>ilist has the same drawbacks as std::list, and additionally requires an
 888 ilist_traits implementation for the element type, but it provides some novel
 889 characteristics.  In particular, it can efficiently store polymorphic objects,
 890 the traits class is informed when an element is inserted or removed from the
 891 list, and ilists are guaranteed to support a constant-time splice operation.
 892 </p>
 893
 894 <p>These properties are exactly what we want for things like Instructions and
 895 basic blocks, which is why these are implemented with ilists.</p>
 896 </div>
 897
 898 <!-- _______________________________________________________________________ -->
 899 <div class="doc_subsubsection">
 900   <a name="dss_other">Other Sequential Container options</a>
 901 </div>
 902
 903 <div class="doc_text">
 904 <p>Other STL containers are available, such as std::string.</p>
 905
 906 <p>There are also various STL adapter classes such as std::queue,
 907 std::priority_queue, std::stack, etc.  These provide simplified access to an
 908 underlying container but don't affect the cost of the container itself.</p>
 909
 910 </div>
 911
 912
 913 <!-- ======================================================================= -->
 914 <div class="doc_subsection">
 915   <a name="ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
 916 </div>
 917
 918 <div class="doc_text">
 919
 920 <p>Set-like containers are useful when you need to canonicalize multiple values
 921 into a single representation.  There are several different choices for how to do
 922 this, providing various trade-offs.</p>
 923
 924 </div>
 925
 926
 927 <!-- _______________________________________________________________________ -->
 928 <div class="doc_subsubsection">
 929   <a name="dss_sortedvectorset">A sorted 'vector'</a>
 930 </div>
 931
 932 <div class="doc_text">
 933
 934 <p>If you intend to insert a lot of elements, then do a lot of queries, a
 935 great approach is to use a vector (or other sequential container) with
 936 std::sort+std::unique to remove duplicates.  This approach works really well if
 937 your usage pattern has these two distinct phases (insert then query), and can be
 938 coupled with a good choice of <a href="#ds_sequential">sequential container</a>.
 939 </p>
 940
 941 <p>
 942 This combination provides the several nice properties: the result data is
 943 contiguous in memory (good for cache locality), has few allocations, is easy to
 944 address (iterators in the final vector are just indices or pointers), and can be
 945 efficiently queried with a standard binary or radix search.</p>
 946
 947 </div>
 948
 949 <!-- _______________________________________________________________________ -->
 950 <div class="doc_subsubsection">
 951   <a name="dss_smallset">"llvm/ADT/SmallSet.h"</a>
 952 </div>
 953
 954 <div class="doc_text">
 955
 956 <p>If you have a set-like data structure that is usually small and whose elements
 957 are reasonably small, a <tt>SmallSet&lt;Type, N&gt;</tt> is a good choice.  This set
 958 has space for N elements in place (thus, if the set is dynamically smaller than
 959 N, no malloc traffic is required) and accesses them with a simple linear search.
 960 When the set grows beyond 'N' elements, it allocates a more expensive representation that
 961 guarantees efficient access (for most types, it falls back to std::set, but for
 962 pointers it uses something far better, <a
 963 href="#dss_smallptrset">SmallPtrSet</a>).</p>
 964
 965 <p>The magic of this class is that it handles small sets extremely efficiently,
 966 but gracefully handles extremely large sets without loss of efficiency.  The
 967 drawback is that the interface is quite small: it supports insertion, queries
 968 and erasing, but does not support iteration.</p>
 969
 970 </div>
 971
 972 <!-- _______________________________________________________________________ -->
 973 <div class="doc_subsubsection">
 974   <a name="dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a>
 975 </div>
 976
 977 <div class="doc_text">
 978
 979 <p>SmallPtrSet has all the advantages of SmallSet (and a SmallSet of pointers is
 980 transparently implemented with a SmallPtrSet), but also supports iterators.  If
 981 more than 'N' insertions are performed, a single quadratically
 982 probed hash table is allocated and grows as needed, providing extremely
 983 efficient access (constant time insertion/deleting/queries with low constant
 984 factors) and is very stingy with malloc traffic.</p>
 985
 986 <p>Note that, unlike std::set, the iterators of SmallPtrSet are invalidated
 987 whenever an insertion occurs.  Also, the values visited by the iterators are not
 988 visited in sorted order.</p>
 989
 990 </div>
 991
 992 <!-- _______________________________________________________________________ -->
 993 <div class="doc_subsubsection">
 994   <a name="dss_denseset">"llvm/ADT/DenseSet.h"</a>
 995 </div>
 996
 997 <div class="doc_text">
 998
 999 <p>
1000 DenseSet is a simple quadratically probed hash table.  It excels at supporting
1001 small values: it uses a single allocation to hold all of the pairs that
1002 are currently inserted in the set.  DenseSet is a great way to unique small
1003 values that are not simple pointers (use <a
1004 href="#dss_smallptrset">SmallPtrSet</a> for pointers).  Note that DenseSet has
1005 the same requirements for the value type that <a
1006 href="#dss_densemap">DenseMap</a> has.
1007 </p>
1008
1009 </div>
1010
1011 <!-- _______________________________________________________________________ -->
1012 <div class="doc_subsubsection">
1013   <a name="dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a>
1014 </div>
1015
1016 <div class="doc_text">
1017
1018 <p>
1019 FoldingSet is an aggregate class that is really good at uniquing
1020 expensive-to-create or polymorphic objects.  It is a combination of a chained
1021 hash table with intrusive links (uniqued objects are required to inherit from
1022 FoldingSetNode) that uses <a href="#dss_smallvector">SmallVector</a> as part of
1023 its ID process.</p>
1024
1025 <p>Consider a case where you want to implement a "getOrCreateFoo" method for
1026 a complex object (for example, a node in the code generator).  The client has a
1027 description of *what* it wants to generate (it knows the opcode and all the
1028 operands), but we don't want to 'new' a node, then try inserting it into a set
1029 only to find out it already exists, at which point we would have to delete it
1030 and return the node that already exists.
1031 </p>
1032
1033 <p>To support this style of client, FoldingSet perform a query with a
1034 FoldingSetNodeID (which wraps SmallVector) that can be used to describe the
1035 element that we want to query for.  The query either returns the element
1036 matching the ID or it returns an opaque ID that indicates where insertion should
1037 take place.  Construction of the ID usually does not require heap traffic.</p>
1038
1039 <p>Because FoldingSet uses intrusive links, it can support polymorphic objects
1040 in the set (for example, you can have SDNode instances mixed with LoadSDNodes).
1041 Because the elements are individually allocated, pointers to the elements are
1042 stable: inserting or removing elements does not invalidate any pointers to other
1043 elements.
1044 </p>
1045
1046 </div>
1047
1048 <!-- _______________________________________________________________________ -->
1049 <div class="doc_subsubsection">
1050   <a name="dss_set">&lt;set&gt;</a>
1051 </div>
1052
1053 <div class="doc_text">
1054
1055 <p><tt>std::set</tt> is a reasonable all-around set class, which is decent at
1056 many things but great at nothing.  std::set allocates memory for each element
1057 inserted (thus it is very malloc intensive) and typically stores three pointers
1058 per element in the set (thus adding a large amount of per-element space
1059 overhead).  It offers guaranteed log(n) performance, which is not particularly
1060 fast from a complexity standpoint (particularly if the elements of the set are
1061 expensive to compare, like strings), and has extremely high constant factors for
1062 lookup, insertion and removal.</p>
1063
1064 <p>The advantages of std::set are that its iterators are stable (deleting or
1065 inserting an element from the set does not affect iterators or pointers to other
1066 elements) and that iteration over the set is guaranteed to be in sorted order.
1067 If the elements in the set are large, then the relative overhead of the pointers
1068 and malloc traffic is not a big deal, but if the elements of the set are small,
1069 std::set is almost never a good choice.</p>
1070
1071 </div>
1072
1073 <!-- _______________________________________________________________________ -->
1074 <div class="doc_subsubsection">
1075   <a name="dss_setvector">"llvm/ADT/SetVector.h"</a>
1076 </div>
1077
1078 <div class="doc_text">
1079 <p>LLVM's SetVector&lt;Type&gt; is an adapter class that combines your choice of
1080 a set-like container along with a <a href="#ds_sequential">Sequential
1081 Container</a>.  The important property
1082 that this provides is efficient insertion with uniquing (duplicate elements are
1083 ignored) with iteration support.  It implements this by inserting elements into
1084 both a set-like container and the sequential container, using the set-like
1085 container for uniquing and the sequential container for iteration.
1086 </p>
1087
1088 <p>The difference between SetVector and other sets is that the order of
1089 iteration is guaranteed to match the order of insertion into the SetVector.
1090 This property is really important for things like sets of pointers.  Because
1091 pointer values are non-deterministic (e.g. vary across runs of the program on
1092 different machines), iterating over the pointers in the set will
1093 not be in a well-defined order.</p>
1094
1095 <p>
1096 The drawback of SetVector is that it requires twice as much space as a normal
1097 set and has the sum of constant factors from the set-like container and the
1098 sequential container that it uses.  Use it *only* if you need to iterate over
1099 the elements in a deterministic order.  SetVector is also expensive to delete
1100 elements out of (linear time), unless you use it's "pop_back" method, which is
1101 faster.
1102 </p>
1103
1104 <p>SetVector is an adapter class that defaults to using std::vector and std::set
1105 for the underlying containers, so it is quite expensive.  However,
1106 <tt>"llvm/ADT/SetVector.h"</tt> also provides a SmallSetVector class, which
1107 defaults to using a SmallVector and SmallSet of a specified size.  If you use
1108 this, and if your sets are dynamically smaller than N, you will save a lot of
1109 heap traffic.</p>
1110
1111 </div>
1112
1113 <!-- _______________________________________________________________________ -->
1114 <div class="doc_subsubsection">
1115   <a name="dss_uniquevector">"llvm/ADT/UniqueVector.h"</a>
1116 </div>
1117
1118 <div class="doc_text">
1119
1120 <p>
1121 UniqueVector is similar to <a href="#dss_setvector">SetVector</a>, but it
1122 retains a unique ID for each element inserted into the set.  It internally
1123 contains a map and a vector, and it assigns a unique ID for each value inserted
1124 into the set.</p>
1125
1126 <p>UniqueVector is very expensive: its cost is the sum of the cost of
1127 maintaining both the map and vector, it has high complexity, high constant
1128 factors, and produces a lot of malloc traffic.  It should be avoided.</p>
1129
1130 </div>
1131
1132
1133 <!-- _______________________________________________________________________ -->
1134 <div class="doc_subsubsection">
1135   <a name="dss_otherset">Other Set-Like Container Options</a>
1136 </div>
1137
1138 <div class="doc_text">
1139
1140 <p>
1141 The STL provides several other options, such as std::multiset and the various
1142 "hash_set" like containers (whether from C++ TR1 or from the SGI library).</p>
1143
1144 <p>std::multiset is useful if you're not interested in elimination of
1145 duplicates, but has all the drawbacks of std::set.  A sorted vector (where you
1146 don't delete duplicate entries) or some other approach is almost always
1147 better.</p>
1148
1149 <p>The various hash_set implementations (exposed portably by
1150 "llvm/ADT/hash_set") is a simple chained hashtable.  This algorithm is as malloc
1151 intensive as std::set (performing an allocation for each element inserted,
1152 thus having really high constant factors) but (usually) provides O(1)
1153 insertion/deletion of elements.  This can be useful if your elements are large
1154 (thus making the constant-factor cost relatively low) or if comparisons are
1155 expensive.  Element iteration does not visit elements in a useful order.</p>
1156
1157 </div>
1158
1159 <!-- ======================================================================= -->
1160 <div class="doc_subsection">
1161   <a name="ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
1162 </div>
1163
1164 <div class="doc_text">
1165 Map-like containers are useful when you want to associate data to a key.  As
1166 usual, there are a lot of different ways to do this. :)
1167 </div>
1168
1169 <!-- _______________________________________________________________________ -->
1170 <div class="doc_subsubsection">
1171   <a name="dss_sortedvectormap">A sorted 'vector'</a>
1172 </div>
1173
1174 <div class="doc_text">
1175
1176 <p>
1177 If your usage pattern follows a strict insert-then-query approach, you can
1178 trivially use the same approach as <a href="#dss_sortedvectorset">sorted vectors
1179 for set-like containers</a>.  The only difference is that your query function
1180 (which uses std::lower_bound to get efficient log(n) lookup) should only compare
1181 the key, not both the key and value.  This yields the same advantages as sorted
1182 vectors for sets.
1183 </p>
1184 </div>
1185
1186 <!-- _______________________________________________________________________ -->
1187 <div class="doc_subsubsection">
1188   <a name="dss_stringmap">"llvm/ADT/StringMap.h"</a>
1189 </div>
1190
1191 <div class="doc_text">
1192
1193 <p>
1194 Strings are commonly used as keys in maps, and they are difficult to support
1195 efficiently: they are variable length, inefficient to hash and compare when
1196 long, expensive to copy, etc.  StringMap is a specialized container designed to
1197 cope with these issues.  It supports mapping an arbitrary range of bytes to an
1198 arbitrary other object.</p>
1199
1200 <p>The StringMap implementation uses a quadratically-probed hash table, where
1201 the buckets store a pointer to the heap allocated entries (and some other
1202 stuff).  The entries in the map must be heap allocated because the strings are
1203 variable length.  The string data (key) and the element object (value) are
1204 stored in the same allocation with the string data immediately after the element
1205 object.  This container guarantees the "<tt>(char*)(&amp;Value+1)</tt>" points
1206 to the key string for a value.</p>
1207
1208 <p>The StringMap is very fast for several reasons: quadratic probing is very
1209 cache efficient for lookups, the hash value of strings in buckets is not
1210 recomputed when lookup up an element, StringMap rarely has to touch the
1211 memory for unrelated objects when looking up a value (even when hash collisions
1212 happen), hash table growth does not recompute the hash values for strings
1213 already in the table, and each pair in the map is store in a single allocation
1214 (the string data is stored in the same allocation as the Value of a pair).</p>
1215
1216 <p>StringMap also provides query methods that take byte ranges, so it only ever
1217 copies a string if a value is inserted into the table.</p>
1218 </div>
1219
1220 <!-- _______________________________________________________________________ -->
1221 <div class="doc_subsubsection">
1222   <a name="dss_indexedmap">"llvm/ADT/IndexedMap.h"</a>
1223 </div>
1224
1225 <div class="doc_text">
1226 <p>
1227 IndexedMap is a specialized container for mapping small dense integers (or
1228 values that can be mapped to small dense integers) to some other type.  It is
1229 internally implemented as a vector with a mapping function that maps the keys to
1230 the dense integer range.
1231 </p>
1232
1233 <p>
1234 This is useful for cases like virtual registers in the LLVM code generator: they
1235 have a dense mapping that is offset by a compile-time constant (the first
1236 virtual register ID).</p>
1237
1238 </div>
1239
1240 <!-- _______________________________________________________________________ -->
1241 <div class="doc_subsubsection">
1242   <a name="dss_densemap">"llvm/ADT/DenseMap.h"</a>
1243 </div>
1244
1245 <div class="doc_text">
1246
1247 <p>
1248 DenseMap is a simple quadratically probed hash table.  It excels at supporting
1249 small keys and values: it uses a single allocation to hold all of the pairs that
1250 are currently inserted in the map.  DenseMap is a great way to map pointers to
1251 pointers, or map other small types to each other.
1252 </p>
1253
1254 <p>
1255 There are several aspects of DenseMap that you should be aware of, however.  The
1256 iterators in a densemap are invalidated whenever an insertion occurs, unlike
1257 map.  Also, because DenseMap allocates space for a large number of key/value
1258 pairs (it starts with 64 by default), it will waste a lot of space if your keys
1259 or values are large.  Finally, you must implement a partial specialization of
1260 DenseMapInfo for the key that you want, if it isn't already supported.  This
1261 is required to tell DenseMap about two special marker values (which can never be
1262 inserted into the map) that it needs internally.</p>
1263
1264 </div>
1265
1266 <!-- _______________________________________________________________________ -->
1267 <div class="doc_subsubsection">
1268   <a name="dss_map">&lt;map&gt;</a>
1269 </div>
1270
1271 <div class="doc_text">
1272
1273 <p>
1274 std::map has similar characteristics to <a href="#dss_set">std::set</a>: it uses
1275 a single allocation per pair inserted into the map, it offers log(n) lookup with
1276 an extremely large constant factor, imposes a space penalty of 3 pointers per
1277 pair in the map, etc.</p>
1278
1279 <p>std::map is most useful when your keys or values are very large, if you need
1280 to iterate over the collection in sorted order, or if you need stable iterators
1281 into the map (i.e. they don't get invalidated if an insertion or deletion of
1282 another element takes place).</p>
1283
1284 </div>
1285
1286 <!-- _______________________________________________________________________ -->
1287 <div class="doc_subsubsection">
1288   <a name="dss_othermap">Other Map-Like Container Options</a>
1289 </div>
1290
1291 <div class="doc_text">
1292
1293 <p>
1294 The STL provides several other options, such as std::multimap and the various
1295 "hash_map" like containers (whether from C++ TR1 or from the SGI library).</p>
1296
1297 <p>std::multimap is useful if you want to map a key to multiple values, but has
1298 all the drawbacks of std::map.  A sorted vector or some other approach is almost
1299 always better.</p>
1300
1301 <p>The various hash_map implementations (exposed portably by
1302 "llvm/ADT/hash_map") are simple chained hash tables.  This algorithm is as
1303 malloc intensive as std::map (performing an allocation for each element
1304 inserted, thus having really high constant factors) but (usually) provides O(1)
1305 insertion/deletion of elements.  This can be useful if your elements are large
1306 (thus making the constant-factor cost relatively low) or if comparisons are
1307 expensive.  Element iteration does not visit elements in a useful order.</p>
1308
1309 </div>
1310
1311 <!-- ======================================================================= -->
1312 <div class="doc_subsection">
1313   <a name="ds_bit">Bit storage containers (BitVector, SparseBitVector)</a>
1314 </div>
1315
1316 <div class="doc_text">
1317 <p>Unlike the other containers, there are only two bit storage containers, and
1318 choosing when to use each is relatively straightforward.</p>
1319
1320 <p>One additional option is
1321 <tt>std::vector&lt;bool&gt;</tt>: we discourage its use for two reasons 1) the
1322 implementation in many common compilers (e.g. commonly available versions of
1323 GCC) is extremely inefficient and 2) the C++ standards committee is likely to
1324 deprecate this container and/or change it significantly somehow.  In any case,
1325 please don't use it.</p>
1326 </div>
1327
1328 <!-- _______________________________________________________________________ -->
1329 <div class="doc_subsubsection">
1330   <a name="dss_bitvector">BitVector</a>
1331 </div>
1332
1333 <div class="doc_text">
1334 <p> The BitVector container provides a fixed size set of bits for manipulation.
1335 It supports individual bit setting/testing, as well as set operations.  The set
1336 operations take time O(size of bitvector), but operations are performed one word
1337 at a time, instead of one bit at a time.  This makes the BitVector very fast for
1338 set operations compared to other containers.  Use the BitVector when you expect
1339 the number of set bits to be high (IE a dense set).
1340 </p>
1341 </div>
1342
1343 <!-- _______________________________________________________________________ -->
1344 <div class="doc_subsubsection">
1345   <a name="dss_sparsebitvector">SparseBitVector</a>
1346 </div>
1347
1348 <div class="doc_text">
1349 <p> The SparseBitVector container is much like BitVector, with one major
1350 difference: Only the bits that are set, are stored.  This makes the
1351 SparseBitVector much more space efficient than BitVector when the set is sparse,
1352 as well as making set operations O(number of set bits) instead of O(size of
1353 universe).  The downside to the SparseBitVector is that setting and testing of random bits is O(N), and on large SparseBitVectors, this can be slower than BitVector. In our implementation, setting or testing bits in sorted order
1354 (either forwards or reverse) is O(1) worst case.  Testing and setting bits within 128 bits (depends on size) of the current bit is also O(1).  As a general statement, testing/setting bits in a SparseBitVector is O(distance away from last set bit).
1355 </p>
1356 </div>
1357
1358 <!-- *********************************************************************** -->
1359 <div class="doc_section">
1360   <a name="common">Helpful Hints for Common Operations</a>
1361 </div>
1362 <!-- *********************************************************************** -->
1363
1364 <div class="doc_text">
1365
1366 <p>This section describes how to perform some very simple transformations of
1367 LLVM code.  This is meant to give examples of common idioms used, showing the
1368 practical side of LLVM transformations.  <p> Because this is a "how-to" section,
1369 you should also read about the main classes that you will be working with.  The
1370 <a href="#coreclasses">Core LLVM Class Hierarchy Reference</a> contains details
1371 and descriptions of the main classes that you should know about.</p>
1372
1373 </div>
1374
1375 <!-- NOTE: this section should be heavy on example code -->
1376 <!-- ======================================================================= -->
1377 <div class="doc_subsection">
1378   <a name="inspection">Basic Inspection and Traversal Routines</a>
1379 </div>
1380
1381 <div class="doc_text">
1382
1383 <p>The LLVM compiler infrastructure have many different data structures that may
1384 be traversed.  Following the example of the C++ standard template library, the
1385 techniques used to traverse these various data structures are all basically the
1386 same.  For a enumerable sequence of values, the <tt>XXXbegin()</tt> function (or
1387 method) returns an iterator to the start of the sequence, the <tt>XXXend()</tt>
1388 function returns an iterator pointing to one past the last valid element of the
1389 sequence, and there is some <tt>XXXiterator</tt> data type that is common
1390 between the two operations.</p>
1391
1392 <p>Because the pattern for iteration is common across many different aspects of
1393 the program representation, the standard template library algorithms may be used
1394 on them, and it is easier to remember how to iterate. First we show a few common
1395 examples of the data structures that need to be traversed.  Other data
1396 structures are traversed in very similar ways.</p>
1397
1398 </div>
1399
1400 <!-- _______________________________________________________________________ -->
1401 <div class="doc_subsubsection">
1402   <a name="iterate_function">Iterating over the </a><a
1403   href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
1404   href="#Function"><tt>Function</tt></a>
1405 </div>
1406
1407 <div class="doc_text">
1408
1409 <p>It's quite common to have a <tt>Function</tt> instance that you'd like to
1410 transform in some way; in particular, you'd like to manipulate its
1411 <tt>BasicBlock</tt>s.  To facilitate this, you'll need to iterate over all of
1412 the <tt>BasicBlock</tt>s that constitute the <tt>Function</tt>. The following is
1413 an example that prints the name of a <tt>BasicBlock</tt> and the number of
1414 <tt>Instruction</tt>s it contains:</p>
1415
1416 <div class="doc_code">
1417 <pre>
1418 // <i>func is a pointer to a Function instance</i>
1419 for (Function::iterator i = func-&gt;begin(), e = func-&gt;end(); i != e; ++i)
1420   // <i>Print out the name of the basic block if it has one, and then the</i>
1421   // <i>number of instructions that it contains</i>
1422   llvm::cerr &lt;&lt; "Basic block (name=" &lt;&lt; i-&gt;getName() &lt;&lt; ") has "
1423              &lt;&lt; i-&gt;size() &lt;&lt; " instructions.\n";
1424 </pre>
1425 </div>
1426
1427 <p>Note that i can be used as if it were a pointer for the purposes of
1428 invoking member functions of the <tt>Instruction</tt> class.  This is
1429 because the indirection operator is overloaded for the iterator
1430 classes.  In the above code, the expression <tt>i-&gt;size()</tt> is
1431 exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.</p>
1432
1433 </div>
1434
1435 <!-- _______________________________________________________________________ -->
1436 <div class="doc_subsubsection">
1437   <a name="iterate_basicblock">Iterating over the </a><a
1438   href="#Instruction"><tt>Instruction</tt></a>s in a <a
1439   href="#BasicBlock"><tt>BasicBlock</tt></a>
1440 </div>
1441
1442 <div class="doc_text">
1443
1444 <p>Just like when dealing with <tt>BasicBlock</tt>s in <tt>Function</tt>s, it's
1445 easy to iterate over the individual instructions that make up
1446 <tt>BasicBlock</tt>s. Here's a code snippet that prints out each instruction in
1447 a <tt>BasicBlock</tt>:</p>
1448
1449 <div class="doc_code">
1450 <pre>
1451 // <i>blk is a pointer to a BasicBlock instance</i>
1452 for (BasicBlock::iterator i = blk-&gt;begin(), e = blk-&gt;end(); i != e; ++i)
1453    // <i>The next statement works since operator&lt;&lt;(ostream&amp;,...)</i>
1454    // <i>is overloaded for Instruction&amp;</i>
1455    llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
1456 </pre>
1457 </div>
1458
1459 <p>However, this isn't really the best way to print out the contents of a
1460 <tt>BasicBlock</tt>!  Since the ostream operators are overloaded for virtually
1461 anything you'll care about, you could have just invoked the print routine on the
1462 basic block itself: <tt>llvm::cerr &lt;&lt; *blk &lt;&lt; "\n";</tt>.</p>
1463
1464 </div>
1465
1466 <!-- _______________________________________________________________________ -->
1467 <div class="doc_subsubsection">
1468   <a name="iterate_institer">Iterating over the </a><a
1469   href="#Instruction"><tt>Instruction</tt></a>s in a <a
1470   href="#Function"><tt>Function</tt></a>
1471 </div>
1472
1473 <div class="doc_text">
1474
1475 <p>If you're finding that you commonly iterate over a <tt>Function</tt>'s
1476 <tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s <tt>Instruction</tt>s,
1477 <tt>InstIterator</tt> should be used instead. You'll need to include <a
1478 href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>,
1479 and then instantiate <tt>InstIterator</tt>s explicitly in your code.  Here's a
1480 small example that shows how to dump all instructions in a function to the standard error stream:<p>
1481
1482 <div class="doc_code">
1483 <pre>
1484 #include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"
1485
1486 // <i>F is a pointer to a Function instance</i>
1487 for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
1488   llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
1489 </pre>
1490 </div>
1491
1492 <p>Easy, isn't it?  You can also use <tt>InstIterator</tt>s to fill a
1493 work list with its initial contents.  For example, if you wanted to
1494 initialize a work list to contain all instructions in a <tt>Function</tt>
1495 F, all you would need to do is something like:</p>
1496
1497 <div class="doc_code">
1498 <pre>
1499 std::set&lt;Instruction*&gt; worklist;
1500 worklist.insert(inst_begin(F), inst_end(F));
1501 </pre>
1502 </div>
1503
1504 <p>The STL set <tt>worklist</tt> would now contain all instructions in the
1505 <tt>Function</tt> pointed to by F.</p>
1506
1507 </div>
1508
1509 <!-- _______________________________________________________________________ -->
1510 <div class="doc_subsubsection">
1511   <a name="iterate_convert">Turning an iterator into a class pointer (and
1512   vice-versa)</a>
1513 </div>
1514
1515 <div class="doc_text">
1516
1517 <p>Sometimes, it'll be useful to grab a reference (or pointer) to a class
1518 instance when all you've got at hand is an iterator.  Well, extracting
1519 a reference or a pointer from an iterator is very straight-forward.
1520 Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and <tt>j</tt>
1521 is a <tt>BasicBlock::const_iterator</tt>:</p>
1522
1523 <div class="doc_code">
1524 <pre>
1525 Instruction&amp; inst = *i;   // <i>Grab reference to instruction reference</i>
1526 Instruction* pinst = &amp;*i; // <i>Grab pointer to instruction reference</i>
1527 const Instruction&amp; inst = *j;
1528 </pre>
1529 </div>
1530
1531 <p>However, the iterators you'll be working with in the LLVM framework are
1532 special: they will automatically convert to a ptr-to-instance type whenever they
1533 need to.  Instead of dereferencing the iterator and then taking the address of
1534 the result, you can simply assign the iterator to the proper pointer type and
1535 you get the dereference and address-of operation as a result of the assignment
1536 (behind the scenes, this is a result of overloading casting mechanisms).  Thus
1537 the last line of the last example,</p>
1538
1539 <div class="doc_code">
1540 <pre>
1541 Instruction *pinst = &amp;*i;
1542 </pre>
1543 </div>
1544
1545 <p>is semantically equivalent to</p>
1546
1547 <div class="doc_code">
1548 <pre>
1549 Instruction *pinst = i;
1550 </pre>
1551 </div>
1552
1553 <p>It's also possible to turn a class pointer into the corresponding iterator,
1554 and this is a constant time operation (very efficient).  The following code
1555 snippet illustrates use of the conversion constructors provided by LLVM
1556 iterators.  By using these, you can explicitly grab the iterator of something
1557 without actually obtaining it via iteration over some structure:</p>
1558
1559 <div class="doc_code">
1560 <pre>
1561 void printNextInstruction(Instruction* inst) {
1562   BasicBlock::iterator it(inst);
1563   ++it; // <i>After this line, it refers to the instruction after *inst</i>
1564   if (it != inst-&gt;getParent()-&gt;end()) llvm::cerr &lt;&lt; *it &lt;&lt; "\n";
1565 }
1566 </pre>
1567 </div>
1568
1569 </div>
1570
1571 <!--_______________________________________________________________________-->
1572 <div class="doc_subsubsection">
1573   <a name="iterate_complex">Finding call sites: a slightly more complex
1574   example</a>
1575 </div>
1576
1577 <div class="doc_text">
1578
1579 <p>Say that you're writing a FunctionPass and would like to count all the
1580 locations in the entire module (that is, across every <tt>Function</tt>) where a
1581 certain function (i.e., some <tt>Function</tt>*) is already in scope.  As you'll
1582 learn later, you may want to use an <tt>InstVisitor</tt> to accomplish this in a
1583 much more straight-forward manner, but this example will allow us to explore how
1584 you'd do it if you didn't have <tt>InstVisitor</tt> around. In pseudo-code, this
1585 is what we want to do:</p>
1586
1587 <div class="doc_code">
1588 <pre>
1589 initialize callCounter to zero
1590 for each Function f in the Module
1591   for each BasicBlock b in f
1592     for each Instruction i in b
1593       if (i is a CallInst and calls the given function)
1594         increment callCounter
1595 </pre>
1596 </div>
1597
1598 <p>And the actual code is (remember, because we're writing a
1599 <tt>FunctionPass</tt>, our <tt>FunctionPass</tt>-derived class simply has to
1600 override the <tt>runOnFunction</tt> method):</p>
1601
1602 <div class="doc_code">
1603 <pre>
1604 Function* targetFunc = ...;
1605
1606 class OurFunctionPass : public FunctionPass {
1607   public:
1608     OurFunctionPass(): callCounter(0) { }
1609
1610     virtual runOnFunction(Function&amp; F) {
1611       for (Function::iterator b = F.begin(), be = F.end(); b != be; ++b) {
1612         for (BasicBlock::iterator i = b-&gt;begin(); ie = b-&gt;end(); i != ie; ++i) {
1613           if (<a href="#CallInst">CallInst</a>* callInst = <a href="#isa">dyn_cast</a>&lt;<a
1614  href="#CallInst">CallInst</a>&gt;(&amp;*i)) {
1615             // <i>We know we've encountered a call instruction, so we</i>
1616             // <i>need to determine if it's a call to the</i>
1617             // <i>function pointed to by m_func or not.</i>
1618             if (callInst-&gt;getCalledFunction() == targetFunc)
1619               ++callCounter;
1620           }
1621         }
1622       }
1623     }
1624
1625   private:
1626     unsigned callCounter;
1627 };
1628 </pre>
1629 </div>
1630
1631 </div>
1632
1633 <!--_______________________________________________________________________-->
1634 <div class="doc_subsubsection">
1635   <a name="calls_and_invokes">Treating calls and invokes the same way</a>
1636 </div>
1637
1638 <div class="doc_text">
1639
1640 <p>You may have noticed that the previous example was a bit oversimplified in
1641 that it did not deal with call sites generated by 'invoke' instructions. In
1642 this, and in other situations, you may find that you want to treat
1643 <tt>CallInst</tt>s and <tt>InvokeInst</tt>s the same way, even though their
1644 most-specific common base class is <tt>Instruction</tt>, which includes lots of
1645 less closely-related things. For these cases, LLVM provides a handy wrapper
1646 class called <a
1647 href="http://llvm.org/doxygen/classllvm_1_1CallSite.html"><tt>CallSite</tt></a>.
1648 It is essentially a wrapper around an <tt>Instruction</tt> pointer, with some
1649 methods that provide functionality common to <tt>CallInst</tt>s and
1650 <tt>InvokeInst</tt>s.</p>
1651
1652 <p>This class has "value semantics": it should be passed by value, not by
1653 reference and it should not be dynamically allocated or deallocated using
1654 <tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently copyable,
1655 assignable and constructable, with costs equivalents to that of a bare pointer.
1656 If you look at its definition, it has only a single pointer member.</p>
1657
1658 </div>
1659
1660 <!--_______________________________________________________________________-->
1661 <div class="doc_subsubsection">
1662   <a name="iterate_chains">Iterating over def-use &amp; use-def chains</a>
1663 </div>
1664
1665 <div class="doc_text">
1666
1667 <p>Frequently, we might have an instance of the <a
1668 href="/doxygen/classllvm_1_1Value.html">Value Class</a> and we want to
1669 determine which <tt>User</tt>s use the <tt>Value</tt>.  The list of all
1670 <tt>User</tt>s of a particular <tt>Value</tt> is called a <i>def-use</i> chain.
1671 For example, let's say we have a <tt>Function*</tt> named <tt>F</tt> to a
1672 particular function <tt>foo</tt>. Finding all of the instructions that
1673 <i>use</i> <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain
1674 of <tt>F</tt>:</p>
1675
1676 <div class="doc_code">
1677 <pre>
1678 Function *F = ...;
1679
1680 for (Value::use_iterator i = F-&gt;use_begin(), e = F-&gt;use_end(); i != e; ++i)
1681   if (Instruction *Inst = dyn_cast&lt;Instruction&gt;(*i)) {
1682     llvm::cerr &lt;&lt; "F is used in instruction:\n";
1683     llvm::cerr &lt;&lt; *Inst &lt;&lt; "\n";
1684   }
1685 </pre>
1686 </div>
1687
1688 <p>Alternately, it's common to have an instance of the <a
1689 href="/doxygen/classllvm_1_1User.html">User Class</a> and need to know what
1690 <tt>Value</tt>s are used by it.  The list of all <tt>Value</tt>s used by a
1691 <tt>User</tt> is known as a <i>use-def</i> chain.  Instances of class
1692 <tt>Instruction</tt> are common <tt>User</tt>s, so we might want to iterate over
1693 all of the values that a particular instruction uses (that is, the operands of
1694 the particular <tt>Instruction</tt>):</p>
1695
1696 <div class="doc_code">
1697 <pre>
1698 Instruction *pi = ...;
1699
1700 for (User::op_iterator i = pi-&gt;op_begin(), e = pi-&gt;op_end(); i != e; ++i) {
1701   Value *v = *i;
1702   // <i>...</i>
1703 }
1704 </pre>
1705 </div>
1706
1707 <!--
1708   def-use chains ("finding all users of"): Value::use_begin/use_end
1709   use-def chains ("finding all values used"): User::op_begin/op_end [op=operand]
1710 -->
1711
1712 </div>
1713
1714 <!--_______________________________________________________________________-->
1715 <div class="doc_subsubsection">
1716   <a name="iterate_preds">Iterating over predecessors &amp;
1717 successors of blocks</a>
1718 </div>
1719
1720 <div class="doc_text">
1721
1722 <p>Iterating over the predecessors and successors of a block is quite easy
1723 with the routines defined in <tt>"llvm/Support/CFG.h"</tt>.  Just use code like
1724 this to iterate over all predecessors of BB:</p>
1725
1726 <div class="doc_code">
1727 <pre>
1728 #include "llvm/Support/CFG.h"
1729 BasicBlock *BB = ...;
1730
1731 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1732   BasicBlock *Pred = *PI;
1733   // <i>...</i>
1734 }
1735 </pre>
1736 </div>
1737
1738 <p>Similarly, to iterate over successors use
1739 succ_iterator/succ_begin/succ_end.</p>
1740
1741 </div>
1742
1743
1744 <!-- ======================================================================= -->
1745 <div class="doc_subsection">
1746   <a name="simplechanges">Making simple changes</a>
1747 </div>
1748
1749 <div class="doc_text">
1750
1751 <p>There are some primitive transformation operations present in the LLVM
1752 infrastructure that are worth knowing about.  When performing
1753 transformations, it's fairly common to manipulate the contents of basic
1754 blocks. This section describes some of the common methods for doing so
1755 and gives example code.</p>
1756
1757 </div>
1758
1759 <!--_______________________________________________________________________-->
1760 <div class="doc_subsubsection">
1761   <a name="schanges_creating">Creating and inserting new
1762   <tt>Instruction</tt>s</a>
1763 </div>
1764
1765 <div class="doc_text">
1766
1767 <p><i>Instantiating Instructions</i></p>
1768
1769 <p>Creation of <tt>Instruction</tt>s is straight-forward: simply call the
1770 constructor for the kind of instruction to instantiate and provide the necessary
1771 parameters. For example, an <tt>AllocaInst</tt> only <i>requires</i> a
1772 (const-ptr-to) <tt>Type</tt>. Thus:</p>
1773
1774 <div class="doc_code">
1775 <pre>
1776 AllocaInst* ai = new AllocaInst(Type::Int32Ty);
1777 </pre>
1778 </div>
1779
1780 <p>will create an <tt>AllocaInst</tt> instance that represents the allocation of
1781 one integer in the current stack frame, at run time. Each <tt>Instruction</tt>
1782 subclass is likely to have varying default parameters which change the semantics
1783 of the instruction, so refer to the <a
1784 href="/doxygen/classllvm_1_1Instruction.html">doxygen documentation for the subclass of
1785 Instruction</a> that you're interested in instantiating.</p>
1786
1787 <p><i>Naming values</i></p>
1788
1789 <p>It is very useful to name the values of instructions when you're able to, as
1790 this facilitates the debugging of your transformations.  If you end up looking
1791 at generated LLVM machine code, you definitely want to have logical names
1792 associated with the results of instructions!  By supplying a value for the
1793 <tt>Name</tt> (default) parameter of the <tt>Instruction</tt> constructor, you
1794 associate a logical name with the result of the instruction's execution at
1795 run time.  For example, say that I'm writing a transformation that dynamically
1796 allocates space for an integer on the stack, and that integer is going to be
1797 used as some kind of index by some other code.  To accomplish this, I place an
1798 <tt>AllocaInst</tt> at the first point in the first <tt>BasicBlock</tt> of some
1799 <tt>Function</tt>, and I'm intending to use it within the same
1800 <tt>Function</tt>. I might do:</p>
1801
1802 <div class="doc_code">
1803 <pre>
1804 AllocaInst* pa = new AllocaInst(Type::Int32Ty, 0, "indexLoc");
1805 </pre>
1806 </div>
1807
1808 <p>where <tt>indexLoc</tt> is now the logical name of the instruction's
1809 execution value, which is a pointer to an integer on the run time stack.</p>
1810
1811 <p><i>Inserting instructions</i></p>
1812
1813 <p>There are essentially two ways to insert an <tt>Instruction</tt>
1814 into an existing sequence of instructions that form a <tt>BasicBlock</tt>:</p>
1815
1816 <ul>
1817   <li>Insertion into an explicit instruction list
1818
1819     <p>Given a <tt>BasicBlock* pb</tt>, an <tt>Instruction* pi</tt> within that
1820     <tt>BasicBlock</tt>, and a newly-created instruction we wish to insert
1821     before <tt>*pi</tt>, we do the following: </p>
1822
1823 <div class="doc_code">
1824 <pre>
1825 BasicBlock *pb = ...;
1826 Instruction *pi = ...;
1827 Instruction *newInst = new Instruction(...);
1828
1829 pb-&gt;getInstList().insert(pi, newInst); // <i>Inserts newInst before pi in pb</i>
1830 </pre>
1831 </div>
1832
1833     <p>Appending to the end of a <tt>BasicBlock</tt> is so common that
1834     the <tt>Instruction</tt> class and <tt>Instruction</tt>-derived
1835     classes provide constructors which take a pointer to a
1836     <tt>BasicBlock</tt> to be appended to. For example code that
1837     looked like: </p>
1838
1839 <div class="doc_code">
1840 <pre>
1841 BasicBlock *pb = ...;
1842 Instruction *newInst = new Instruction(...);
1843
1844 pb-&gt;getInstList().push_back(newInst); // <i>Appends newInst to pb</i>
1845 </pre>
1846 </div>
1847
1848     <p>becomes: </p>
1849
1850 <div class="doc_code">
1851 <pre>
1852 BasicBlock *pb = ...;
1853 Instruction *newInst = new Instruction(..., pb);
1854 </pre>
1855 </div>
1856
1857     <p>which is much cleaner, especially if you are creating
1858     long instruction streams.</p></li>
1859
1860   <li>Insertion into an implicit instruction list
1861
1862     <p><tt>Instruction</tt> instances that are already in <tt>BasicBlock</tt>s
1863     are implicitly associated with an existing instruction list: the instruction
1864     list of the enclosing basic block. Thus, we could have accomplished the same
1865     thing as the above code without being given a <tt>BasicBlock</tt> by doing:
1866     </p>
1867
1868 <div class="doc_code">
1869 <pre>
1870 Instruction *pi = ...;
1871 Instruction *newInst = new Instruction(...);
1872
1873 pi-&gt;getParent()-&gt;getInstList().insert(pi, newInst);
1874 </pre>
1875 </div>
1876
1877     <p>In fact, this sequence of steps occurs so frequently that the
1878     <tt>Instruction</tt> class and <tt>Instruction</tt>-derived classes provide
1879     constructors which take (as a default parameter) a pointer to an
1880     <tt>Instruction</tt> which the newly-created <tt>Instruction</tt> should
1881     precede.  That is, <tt>Instruction</tt> constructors are capable of
1882     inserting the newly-created instance into the <tt>BasicBlock</tt> of a
1883     provided instruction, immediately before that instruction.  Using an
1884     <tt>Instruction</tt> constructor with a <tt>insertBefore</tt> (default)
1885     parameter, the above code becomes:</p>
1886
1887 <div class="doc_code">
1888 <pre>
1889 Instruction* pi = ...;
1890 Instruction* newInst = new Instruction(..., pi);
1891 </pre>
1892 </div>
1893
1894     <p>which is much cleaner, especially if you're creating a lot of
1895     instructions and adding them to <tt>BasicBlock</tt>s.</p></li>
1896 </ul>
1897
1898 </div>
1899
1900 <!--_______________________________________________________________________-->
1901 <div class="doc_subsubsection">
1902   <a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a>
1903 </div>
1904
1905 <div class="doc_text">
1906
1907 <p>Deleting an instruction from an existing sequence of instructions that form a
1908 <a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward. First,
1909 you must have a pointer to the instruction that you wish to delete.  Second, you
1910 need to obtain the pointer to that instruction's basic block. You use the
1911 pointer to the basic block to get its list of instructions and then use the
1912 erase function to remove your instruction. For example:</p>
1913
1914 <div class="doc_code">
1915 <pre>
1916 <a href="#Instruction">Instruction</a> *I = .. ;
1917 <a href="#BasicBlock">BasicBlock</a> *BB = I-&gt;getParent();
1918
1919 BB-&gt;getInstList().erase(I);
1920 </pre>
1921 </div>
1922
1923 </div>
1924
1925 <!--_______________________________________________________________________-->
1926 <div class="doc_subsubsection">
1927   <a name="schanges_replacing">Replacing an <tt>Instruction</tt> with another
1928   <tt>Value</tt></a>
1929 </div>
1930
1931 <div class="doc_text">
1932
1933 <p><i>Replacing individual instructions</i></p>
1934
1935 <p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>"
1936 permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt>
1937 and <tt>ReplaceInstWithInst</tt>.</p>
1938
1939 <h4><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h4>
1940
1941 <ul>
1942   <li><tt>ReplaceInstWithValue</tt>
1943
1944     <p>This function replaces all uses (within a basic block) of a given
1945     instruction with a value, and then removes the original instruction. The
1946     following example illustrates the replacement of the result of a particular
1947     <tt>AllocaInst</tt> that allocates memory for a single integer with a null
1948     pointer to an integer.</p>
1949
1950 <div class="doc_code">
1951 <pre>
1952 AllocaInst* instToReplace = ...;
1953 BasicBlock::iterator ii(instToReplace);
1954
1955 ReplaceInstWithValue(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1956                      Constant::getNullValue(PointerType::get(Type::Int32Ty)));
1957 </pre></div></li>
1958
1959   <li><tt>ReplaceInstWithInst</tt>
1960
1961     <p>This function replaces a particular instruction with another
1962     instruction. The following example illustrates the replacement of one
1963     <tt>AllocaInst</tt> with another.</p>
1964
1965 <div class="doc_code">
1966 <pre>
1967 AllocaInst* instToReplace = ...;
1968 BasicBlock::iterator ii(instToReplace);
1969
1970 ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1971                     new AllocaInst(Type::Int32Ty, 0, "ptrToReplacedInt"));
1972 </pre></div></li>
1973 </ul>
1974
1975 <p><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></p>
1976
1977 <p>You can use <tt>Value::replaceAllUsesWith</tt> and
1978 <tt>User::replaceUsesOfWith</tt> to change more than one use at a time.  See the
1979 doxygen documentation for the <a href="/doxygen/classllvm_1_1Value.html">Value Class</a>
1980 and <a href="/doxygen/classllvm_1_1User.html">User Class</a>, respectively, for more
1981 information.</p>
1982
1983 <!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
1984 include/llvm/Transforms/Utils/ especially BasicBlockUtils.h with:
1985 ReplaceInstWithValue, ReplaceInstWithInst -->
1986
1987 </div>
1988
1989 <!--_______________________________________________________________________-->
1990 <div class="doc_subsubsection">
1991   <a name="schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a>
1992 </div>
1993
1994 <div class="doc_text">
1995
1996 <p>Deleting a global variable from a module is just as easy as deleting an
1997 Instruction. First, you must have a pointer to the global variable that you wish
1998  to delete.  You use this pointer to erase it from its parent, the module.
1999  For example:</p>
2000
2001 <div class="doc_code">
2002 <pre>
2003 <a href="#GlobalVariable">GlobalVariable</a> *GV = .. ;
2004
2005 GV-&gt;eraseFromParent();
2006 </pre>
2007 </div>
2008
2009 </div>
2010
2011 <!-- *********************************************************************** -->
2012 <div class="doc_section">
2013   <a name="advanced">Advanced Topics</a>
2014 </div>
2015 <!-- *********************************************************************** -->
2016
2017 <div class="doc_text">
2018 <p>
2019 This section describes some of the advanced or obscure API's that most clients
2020 do not need to be aware of.  These API's tend manage the inner workings of the
2021 LLVM system, and only need to be accessed in unusual circumstances.
2022 </p>
2023 </div>
2024
2025 <!-- ======================================================================= -->
2026 <div class="doc_subsection">
2027   <a name="TypeResolve">LLVM Type Resolution</a>
2028 </div>
2029
2030 <div class="doc_text">
2031
2032 <p>
2033 The LLVM type system has a very simple goal: allow clients to compare types for
2034 structural equality with a simple pointer comparison (aka a shallow compare).
2035 This goal makes clients much simpler and faster, and is used throughout the LLVM
2036 system.
2037 </p>
2038
2039 <p>
2040 Unfortunately achieving this goal is not a simple matter.  In particular,
2041 recursive types and late resolution of opaque types makes the situation very
2042 difficult to handle.  Fortunately, for the most part, our implementation makes
2043 most clients able to be completely unaware of the nasty internal details.  The
2044 primary case where clients are exposed to the inner workings of it are when
2045 building a recursive type.  In addition to this case, the LLVM bitcode reader,
2046 assembly parser, and linker also have to be aware of the inner workings of this
2047 system.
2048 </p>
2049
2050 <p>
2051 For our purposes below, we need three concepts.  First, an "Opaque Type" is
2052 exactly as defined in the <a href="LangRef.html#t_opaque">language
2053 reference</a>.  Second an "Abstract Type" is any type which includes an
2054 opaque type as part of its type graph (for example "<tt>{ opaque, i32 }</tt>").
2055 Third, a concrete type is a type that is not an abstract type (e.g. "<tt>{ i32,
2056 float }</tt>").
2057 </p>
2058
2059 </div>
2060
2061 <!-- ______________________________________________________________________ -->
2062 <div class="doc_subsubsection">
2063   <a name="BuildRecType">Basic Recursive Type Construction</a>
2064 </div>
2065
2066 <div class="doc_text">
2067
2068 <p>
2069 Because the most common question is "how do I build a recursive type with LLVM",
2070 we answer it now and explain it as we go.  Here we include enough to cause this
2071 to be emitted to an output .ll file:
2072 </p>
2073
2074 <div class="doc_code">
2075 <pre>
2076 %mylist = type { %mylist*, i32 }
2077 </pre>
2078 </div>
2079
2080 <p>
2081 To build this, use the following LLVM APIs:
2082 </p>
2083
2084 <div class="doc_code">
2085 <pre>
2086 // <i>Create the initial outer struct</i>
2087 <a href="#PATypeHolder">PATypeHolder</a> StructTy = OpaqueType::get();
2088 std::vector&lt;const Type*&gt; Elts;
2089 Elts.push_back(PointerType::get(StructTy));
2090 Elts.push_back(Type::Int32Ty);
2091 StructType *NewSTy = StructType::get(Elts);
2092
2093 // <i>At this point, NewSTy = "{ opaque*, i32 }". Tell VMCore that</i>
2094 // <i>the struct and the opaque type are actually the same.</i>
2095 cast&lt;OpaqueType&gt;(StructTy.get())-&gt;<a href="#refineAbstractTypeTo">refineAbstractTypeTo</a>(NewSTy);
2096
2097 // <i>NewSTy is potentially invalidated, but StructTy (a <a href="#PATypeHolder">PATypeHolder</a>) is</i>
2098 // <i>kept up-to-date</i>
2099 NewSTy = cast&lt;StructType&gt;(StructTy.get());
2100
2101 // <i>Add a name for the type to the module symbol table (optional)</i>
2102 MyModule-&gt;addTypeName("mylist", NewSTy);
2103 </pre>
2104 </div>
2105
2106 <p>
2107 This code shows the basic approach used to build recursive types: build a
2108 non-recursive type using 'opaque', then use type unification to close the cycle.
2109 The type unification step is performed by the <tt><a
2110 href="#refineAbstractTypeTo">refineAbstractTypeTo</a></tt> method, which is
2111 described next.  After that, we describe the <a
2112 href="#PATypeHolder">PATypeHolder class</a>.
2113 </p>
2114
2115 </div>
2116
2117 <!-- ______________________________________________________________________ -->
2118 <div class="doc_subsubsection">
2119   <a name="refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a>
2120 </div>
2121
2122 <div class="doc_text">
2123 <p>
2124 The <tt>refineAbstractTypeTo</tt> method starts the type unification process.
2125 While this method is actually a member of the DerivedType class, it is most
2126 often used on OpaqueType instances.  Type unification is actually a recursive
2127 process.  After unification, types can become structurally isomorphic to
2128 existing types, and all duplicates are deleted (to preserve pointer equality).
2129 </p>
2130
2131 <p>
2132 In the example above, the OpaqueType object is definitely deleted.
2133 Additionally, if there is an "{ \2*, i32}" type already created in the system,
2134 the pointer and struct type created are <b>also</b> deleted.  Obviously whenever
2135 a type is deleted, any "Type*" pointers in the program are invalidated.  As
2136 such, it is safest to avoid having <i>any</i> "Type*" pointers to abstract types
2137 live across a call to <tt>refineAbstractTypeTo</tt> (note that non-abstract
2138 types can never move or be deleted).  To deal with this, the <a
2139 href="#PATypeHolder">PATypeHolder</a> class is used to maintain a stable
2140 reference to a possibly refined type, and the <a
2141 href="#AbstractTypeUser">AbstractTypeUser</a> class is used to update more
2142 complex datastructures.
2143 </p>
2144
2145 </div>
2146
2147 <!-- ______________________________________________________________________ -->
2148 <div class="doc_subsubsection">
2149   <a name="PATypeHolder">The PATypeHolder Class</a>
2150 </div>
2151
2152 <div class="doc_text">
2153 <p>
2154 PATypeHolder is a form of a "smart pointer" for Type objects.  When VMCore
2155 happily goes about nuking types that become isomorphic to existing types, it
2156 automatically updates all PATypeHolder objects to point to the new type.  In the
2157 example above, this allows the code to maintain a pointer to the resultant
2158 resolved recursive type, even though the Type*'s are potentially invalidated.
2159 </p>
2160
2161 <p>
2162 PATypeHolder is an extremely light-weight object that uses a lazy union-find
2163 implementation to update pointers.  For example the pointer from a Value to its
2164 Type is maintained by PATypeHolder objects.
2165 </p>
2166
2167 </div>
2168
2169 <!-- ______________________________________________________________________ -->
2170 <div class="doc_subsubsection">
2171   <a name="AbstractTypeUser">The AbstractTypeUser Class</a>
2172 </div>
2173
2174 <div class="doc_text">
2175
2176 <p>
2177 Some data structures need more to perform more complex updates when types get
2178 resolved.  To support this, a class can derive from the AbstractTypeUser class.
2179 This class
2180 allows it to get callbacks when certain types are resolved.  To register to get
2181 callbacks for a particular type, the DerivedType::{add/remove}AbstractTypeUser
2182 methods can be called on a type.  Note that these methods only work for <i>
2183   abstract</i> types.  Concrete types (those that do not include any opaque
2184 objects) can never be refined.
2185 </p>
2186 </div>
2187
2188
2189 <!-- ======================================================================= -->
2190 <div class="doc_subsection">
2191   <a name="SymbolTable">The <tt>ValueSymbolTable</tt> and
2192    <tt>TypeSymbolTable</tt> classes</a>
2193 </div>
2194
2195 <div class="doc_text">
2196 <p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1ValueSymbolTable.html">
2197 ValueSymbolTable</a></tt> class provides a symbol table that the <a
2198 href="#Function"><tt>Function</tt></a> and <a href="#Module">
2199 <tt>Module</tt></a> classes use for naming value definitions. The symbol table
2200 can provide a name for any <a href="#Value"><tt>Value</tt></a>.
2201 The <tt><a href="http://llvm.org/doxygen/classllvm_1_1TypeSymbolTable.html">
2202 TypeSymbolTable</a></tt> class is used by the <tt>Module</tt> class to store
2203 names for types.</p>
2204
2205 <p>Note that the <tt>SymbolTable</tt> class should not be directly accessed
2206 by most clients.  It should only be used when iteration over the symbol table
2207 names themselves are required, which is very special purpose.  Note that not
2208 all LLVM
2209 <a href="#Value">Value</a>s have names, and those without names (i.e. they have
2210 an empty name) do not exist in the symbol table.
2211 </p>
2212
2213 <p>These symbol tables support iteration over the values/types in the symbol
2214 table with <tt>begin/end/iterator</tt> and supports querying to see if a
2215 specific name is in the symbol table (with <tt>lookup</tt>).  The
2216 <tt>ValueSymbolTable</tt> class exposes no public mutator methods, instead,
2217 simply call <tt>setName</tt> on a value, which will autoinsert it into the
2218 appropriate symbol table.  For types, use the Module::addTypeName method to
2219 insert entries into the symbol table.</p>
2220
2221 </div>
2222
2223
2224
2225 <!-- *********************************************************************** -->
2226 <div class="doc_section">
2227   <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a>
2228 </div>
2229 <!-- *********************************************************************** -->
2230
2231 <div class="doc_text">
2232 <p><tt>#include "<a href="/doxygen/Type_8h-source.html">llvm/Type.h</a>"</tt>
2233 <br>doxygen info: <a href="/doxygen/classllvm_1_1Type.html">Type Class</a></p>
2234
2235 <p>The Core LLVM classes are the primary means of representing the program
2236 being inspected or transformed.  The core LLVM classes are defined in
2237 header files in the <tt>include/llvm/</tt> directory, and implemented in
2238 the <tt>lib/VMCore</tt> directory.</p>
2239
2240 </div>
2241
2242 <!-- ======================================================================= -->
2243 <div class="doc_subsection">
2244   <a name="Type">The <tt>Type</tt> class and Derived Types</a>
2245 </div>
2246
2247 <div class="doc_text">
2248
2249   <p><tt>Type</tt> is a superclass of all type classes. Every <tt>Value</tt> has
2250   a <tt>Type</tt>. <tt>Type</tt> cannot be instantiated directly but only
2251   through its subclasses. Certain primitive types (<tt>VoidType</tt>,
2252   <tt>LabelType</tt>, <tt>FloatType</tt> and <tt>DoubleType</tt>) have hidden
2253   subclasses. They are hidden because they offer no useful functionality beyond
2254   what the <tt>Type</tt> class offers except to distinguish themselves from
2255   other subclasses of <tt>Type</tt>.</p>
2256   <p>All other types are subclasses of <tt>DerivedType</tt>.  Types can be
2257   named, but this is not a requirement. There exists exactly
2258   one instance of a given shape at any one time.  This allows type equality to
2259   be performed with address equality of the Type Instance. That is, given two
2260   <tt>Type*</tt> values, the types are identical if the pointers are identical.
2261   </p>
2262 </div>
2263
2264 <!-- _______________________________________________________________________ -->
2265 <div class="doc_subsubsection">
2266   <a name="m_Value">Important Public Methods</a>
2267 </div>
2268
2269 <div class="doc_text">
2270
2271 <ul>
2272   <li><tt>bool isInteger() const</tt>: Returns true for any integer type.</li>
2273
2274   <li><tt>bool isFloatingPoint()</tt>: Return true if this is one of the two
2275   floating point types.</li>
2276
2277   <li><tt>bool isAbstract()</tt>: Return true if the type is abstract (contains
2278   an OpaqueType anywhere in its definition).</li>
2279
2280   <li><tt>bool isSized()</tt>: Return true if the type has known size. Things
2281   that don't have a size are abstract types, labels and void.</li>
2282
2283 </ul>
2284 </div>
2285
2286 <!-- _______________________________________________________________________ -->
2287 <div class="doc_subsubsection">
2288   <a name="m_Value">Important Derived Types</a>
2289 </div>
2290 <div class="doc_text">
2291 <dl>
2292   <dt><tt>IntegerType</tt></dt>
2293   <dd>Subclass of DerivedType that represents integer types of any bit width.
2294   Any bit width between <tt>IntegerType::MIN_INT_BITS</tt> (1) and
2295   <tt>IntegerType::MAX_INT_BITS</tt> (~8 million) can be represented.
2296   <ul>
2297     <li><tt>static const IntegerType* get(unsigned NumBits)</tt>: get an integer
2298     type of a specific bit width.</li>
2299     <li><tt>unsigned getBitWidth() const</tt>: Get the bit width of an integer
2300     type.</li>
2301   </ul>
2302   </dd>
2303   <dt><tt>SequentialType</tt></dt>
2304   <dd>This is subclassed by ArrayType and PointerType
2305     <ul>
2306       <li><tt>const Type * getElementType() const</tt>: Returns the type of each
2307       of the elements in the sequential type. </li>
2308     </ul>
2309   </dd>
2310   <dt><tt>ArrayType</tt></dt>
2311   <dd>This is a subclass of SequentialType and defines the interface for array
2312   types.
2313     <ul>
2314       <li><tt>unsigned getNumElements() const</tt>: Returns the number of
2315       elements in the array. </li>
2316     </ul>
2317   </dd>
2318   <dt><tt>PointerType</tt></dt>
2319   <dd>Subclass of SequentialType for pointer types.</dd>
2320   <dt><tt>VectorType</tt></dt>
2321   <dd>Subclass of SequentialType for vector types. A
2322   vector type is similar to an ArrayType but is distinguished because it is
2323   a first class type wherease ArrayType is not. Vector types are used for
2324   vector operations and are usually small vectors of of an integer or floating
2325   point type.</dd>
2326   <dt><tt>StructType</tt></dt>
2327   <dd>Subclass of DerivedTypes for struct types.</dd>
2328   <dt><tt><a name="FunctionType">FunctionType</a></tt></dt>
2329   <dd>Subclass of DerivedTypes for function types.
2330     <ul>
2331       <li><tt>bool isVarArg() const</tt>: Returns true if its a vararg
2332       function</li>
2333       <li><tt> const Type * getReturnType() const</tt>: Returns the
2334       return type of the function.</li>
2335       <li><tt>const Type * getParamType (unsigned i)</tt>: Returns
2336       the type of the ith parameter.</li>
2337       <li><tt> const unsigned getNumParams() const</tt>: Returns the
2338       number of formal parameters.</li>
2339     </ul>
2340   </dd>
2341   <dt><tt>OpaqueType</tt></dt>
2342   <dd>Sublcass of DerivedType for abstract types. This class
2343   defines no content and is used as a placeholder for some other type. Note
2344   that OpaqueType is used (temporarily) during type resolution for forward
2345   references of types. Once the referenced type is resolved, the OpaqueType
2346   is replaced with the actual type. OpaqueType can also be used for data
2347   abstraction. At link time opaque types can be resolved to actual types
2348   of the same name.</dd>
2349 </dl>
2350 </div>
2351
2352
2353
2354 <!-- ======================================================================= -->
2355 <div class="doc_subsection">
2356   <a name="Module">The <tt>Module</tt> class</a>
2357 </div>
2358
2359 <div class="doc_text">
2360
2361 <p><tt>#include "<a
2362 href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info:
2363 <a href="/doxygen/classllvm_1_1Module.html">Module Class</a></p>
2364
2365 <p>The <tt>Module</tt> class represents the top level structure present in LLVM
2366 programs.  An LLVM module is effectively either a translation unit of the
2367 original program or a combination of several translation units merged by the
2368 linker.  The <tt>Module</tt> class keeps track of a list of <a
2369 href="#Function"><tt>Function</tt></a>s, a list of <a
2370 href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a
2371 href="#SymbolTable"><tt>SymbolTable</tt></a>.  Additionally, it contains a few
2372 helpful member functions that try to make common operations easy.</p>
2373
2374 </div>
2375
2376 <!-- _______________________________________________________________________ -->
2377 <div class="doc_subsubsection">
2378   <a name="m_Module">Important Public Members of the <tt>Module</tt> class</a>
2379 </div>
2380
2381 <div class="doc_text">
2382
2383 <ul>
2384   <li><tt>Module::Module(std::string name = "")</tt></li>
2385 </ul>
2386
2387 <p>Constructing a <a href="#Module">Module</a> is easy. You can optionally
2388 provide a name for it (probably based on the name of the translation unit).</p>
2389
2390 <ul>
2391   <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
2392     <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>
2393
2394     <tt>begin()</tt>, <tt>end()</tt>
2395     <tt>size()</tt>, <tt>empty()</tt>
2396
2397     <p>These are forwarding methods that make it easy to access the contents of
2398     a <tt>Module</tt> object's <a href="#Function"><tt>Function</tt></a>
2399     list.</p></li>
2400
2401   <li><tt>Module::FunctionListType &amp;getFunctionList()</tt>
2402
2403     <p> Returns the list of <a href="#Function"><tt>Function</tt></a>s.  This is
2404     necessary to use when you need to update the list or perform a complex
2405     action that doesn't have a forwarding method.</p>
2406
2407     <p><!--  Global Variable --></p></li>
2408 </ul>
2409
2410 <hr>
2411
2412 <ul>
2413   <li><tt>Module::global_iterator</tt> - Typedef for global variable list iterator<br>
2414
2415     <tt>Module::const_global_iterator</tt> - Typedef for const_iterator.<br>
2416
2417     <tt>global_begin()</tt>, <tt>global_end()</tt>
2418     <tt>global_size()</tt>, <tt>global_empty()</tt>
2419
2420     <p> These are forwarding methods that make it easy to access the contents of
2421     a <tt>Module</tt> object's <a
2422     href="#GlobalVariable"><tt>GlobalVariable</tt></a> list.</p></li>
2423
2424   <li><tt>Module::GlobalListType &amp;getGlobalList()</tt>
2425
2426     <p>Returns the list of <a
2427     href="#GlobalVariable"><tt>GlobalVariable</tt></a>s.  This is necessary to
2428     use when you need to update the list or perform a complex action that
2429     doesn't have a forwarding method.</p>
2430
2431     <p><!--  Symbol table stuff --> </p></li>
2432 </ul>
2433
2434 <hr>
2435
2436 <ul>
2437   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
2438
2439     <p>Return a reference to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2440     for this <tt>Module</tt>.</p>
2441
2442     <p><!--  Convenience methods --></p></li>
2443 </ul>
2444
2445 <hr>
2446
2447 <ul>
2448   <li><tt><a href="#Function">Function</a> *getFunction(const std::string
2449   &amp;Name, const <a href="#FunctionType">FunctionType</a> *Ty)</tt>
2450
2451     <p>Look up the specified function in the <tt>Module</tt> <a
2452     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, return
2453     <tt>null</tt>.</p></li>
2454
2455   <li><tt><a href="#Function">Function</a> *getOrInsertFunction(const
2456   std::string &amp;Name, const <a href="#FunctionType">FunctionType</a> *T)</tt>
2457
2458     <p>Look up the specified function in the <tt>Module</tt> <a
2459     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, add an
2460     external declaration for the function and return it.</p></li>
2461
2462   <li><tt>std::string getTypeName(const <a href="#Type">Type</a> *Ty)</tt>
2463
2464     <p>If there is at least one entry in the <a
2465     href="#SymbolTable"><tt>SymbolTable</tt></a> for the specified <a
2466     href="#Type"><tt>Type</tt></a>, return it.  Otherwise return the empty
2467     string.</p></li>
2468
2469   <li><tt>bool addTypeName(const std::string &amp;Name, const <a
2470   href="#Type">Type</a> *Ty)</tt>
2471
2472     <p>Insert an entry in the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2473     mapping <tt>Name</tt> to <tt>Ty</tt>. If there is already an entry for this
2474     name, true is returned and the <a
2475     href="#SymbolTable"><tt>SymbolTable</tt></a> is not modified.</p></li>
2476 </ul>
2477
2478 </div>
2479
2480
2481 <!-- ======================================================================= -->
2482 <div class="doc_subsection">
2483   <a name="Value">The <tt>Value</tt> class</a>
2484 </div>
2485
2486 <div class="doc_text">
2487
2488 <p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt>
2489 <br>
2490 doxygen info: <a href="/doxygen/classllvm_1_1Value.html">Value Class</a></p>
2491
2492 <p>The <tt>Value</tt> class is the most important class in the LLVM Source
2493 base.  It represents a typed value that may be used (among other things) as an
2494 operand to an instruction.  There are many different types of <tt>Value</tt>s,
2495 such as <a href="#Constant"><tt>Constant</tt></a>s,<a
2496 href="#Argument"><tt>Argument</tt></a>s. Even <a
2497 href="#Instruction"><tt>Instruction</tt></a>s and <a
2498 href="#Function"><tt>Function</tt></a>s are <tt>Value</tt>s.</p>
2499
2500 <p>A particular <tt>Value</tt> may be used many times in the LLVM representation
2501 for a program.  For example, an incoming argument to a function (represented
2502 with an instance of the <a href="#Argument">Argument</a> class) is "used" by
2503 every instruction in the function that references the argument.  To keep track
2504 of this relationship, the <tt>Value</tt> class keeps a list of all of the <a
2505 href="#User"><tt>User</tt></a>s that is using it (the <a
2506 href="#User"><tt>User</tt></a> class is a base class for all nodes in the LLVM
2507 graph that can refer to <tt>Value</tt>s).  This use list is how LLVM represents
2508 def-use information in the program, and is accessible through the <tt>use_</tt>*
2509 methods, shown below.</p>
2510
2511 <p>Because LLVM is a typed representation, every LLVM <tt>Value</tt> is typed,
2512 and this <a href="#Type">Type</a> is available through the <tt>getType()</tt>
2513 method. In addition, all LLVM values can be named.  The "name" of the
2514 <tt>Value</tt> is a symbolic string printed in the LLVM code:</p>
2515
2516 <div class="doc_code">
2517 <pre>
2518 %<b>foo</b> = add i32 1, 2
2519 </pre>
2520 </div>
2521
2522 <p><a name="nameWarning">The name of this instruction is "foo".</a> <b>NOTE</b>
2523 that the name of any value may be missing (an empty string), so names should
2524 <b>ONLY</b> be used for debugging (making the source code easier to read,
2525 debugging printouts), they should not be used to keep track of values or map
2526 between them.  For this purpose, use a <tt>std::map</tt> of pointers to the
2527 <tt>Value</tt> itself instead.</p>
2528
2529 <p>One important aspect of LLVM is that there is no distinction between an SSA
2530 variable and the operation that produces it.  Because of this, any reference to
2531 the value produced by an instruction (or the value available as an incoming
2532 argument, for example) is represented as a direct pointer to the instance of
2533 the class that
2534 represents this value.  Although this may take some getting used to, it
2535 simplifies the representation and makes it easier to manipulate.</p>
2536
2537 </div>
2538
2539 <!-- _______________________________________________________________________ -->
2540 <div class="doc_subsubsection">
2541   <a name="m_Value">Important Public Members of the <tt>Value</tt> class</a>
2542 </div>
2543
2544 <div class="doc_text">
2545
2546 <ul>
2547   <li><tt>Value::use_iterator</tt> - Typedef for iterator over the
2548 use-list<br>
2549     <tt>Value::use_const_iterator</tt> - Typedef for const_iterator over
2550 the use-list<br>
2551     <tt>unsigned use_size()</tt> - Returns the number of users of the
2552 value.<br>
2553     <tt>bool use_empty()</tt> - Returns true if there are no users.<br>
2554     <tt>use_iterator use_begin()</tt> - Get an iterator to the start of
2555 the use-list.<br>
2556     <tt>use_iterator use_end()</tt> - Get an iterator to the end of the
2557 use-list.<br>
2558     <tt><a href="#User">User</a> *use_back()</tt> - Returns the last
2559 element in the list.
2560     <p> These methods are the interface to access the def-use
2561 information in LLVM.  As with all other iterators in LLVM, the naming
2562 conventions follow the conventions defined by the <a href="#stl">STL</a>.</p>
2563   </li>
2564   <li><tt><a href="#Type">Type</a> *getType() const</tt>
2565     <p>This method returns the Type of the Value.</p>
2566   </li>
2567   <li><tt>bool hasName() const</tt><br>
2568     <tt>std::string getName() const</tt><br>
2569     <tt>void setName(const std::string &amp;Name)</tt>
2570     <p> This family of methods is used to access and assign a name to a <tt>Value</tt>,
2571 be aware of the <a href="#nameWarning">precaution above</a>.</p>
2572   </li>
2573   <li><tt>void replaceAllUsesWith(Value *V)</tt>
2574
2575     <p>This method traverses the use list of a <tt>Value</tt> changing all <a
2576     href="#User"><tt>User</tt>s</a> of the current value to refer to
2577     "<tt>V</tt>" instead.  For example, if you detect that an instruction always
2578     produces a constant value (for example through constant folding), you can
2579     replace all uses of the instruction with the constant like this:</p>
2580
2581 <div class="doc_code">
2582 <pre>
2583 Inst-&gt;replaceAllUsesWith(ConstVal);
2584 </pre>
2585 </div>
2586
2587 </ul>
2588
2589 </div>
2590
2591 <!-- ======================================================================= -->
2592 <div class="doc_subsection">
2593   <a name="User">The <tt>User</tt> class</a>
2594 </div>
2595
2596 <div class="doc_text">
2597
2598 <p>
2599 <tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br>
2600 doxygen info: <a href="/doxygen/classllvm_1_1User.html">User Class</a><br>
2601 Superclass: <a href="#Value"><tt>Value</tt></a></p>
2602
2603 <p>The <tt>User</tt> class is the common base class of all LLVM nodes that may
2604 refer to <a href="#Value"><tt>Value</tt></a>s.  It exposes a list of "Operands"
2605 that are all of the <a href="#Value"><tt>Value</tt></a>s that the User is
2606 referring to.  The <tt>User</tt> class itself is a subclass of
2607 <tt>Value</tt>.</p>
2608
2609 <p>The operands of a <tt>User</tt> point directly to the LLVM <a
2610 href="#Value"><tt>Value</tt></a> that it refers to.  Because LLVM uses Static
2611 Single Assignment (SSA) form, there can only be one definition referred to,
2612 allowing this direct connection.  This connection provides the use-def
2613 information in LLVM.</p>
2614
2615 </div>
2616
2617 <!-- _______________________________________________________________________ -->
2618 <div class="doc_subsubsection">
2619   <a name="m_User">Important Public Members of the <tt>User</tt> class</a>
2620 </div>
2621
2622 <div class="doc_text">
2623
2624 <p>The <tt>User</tt> class exposes the operand list in two ways: through
2625 an index access interface and through an iterator based interface.</p>
2626
2627 <ul>
2628   <li><tt>Value *getOperand(unsigned i)</tt><br>
2629     <tt>unsigned getNumOperands()</tt>
2630     <p> These two methods expose the operands of the <tt>User</tt> in a
2631 convenient form for direct access.</p></li>
2632
2633   <li><tt>User::op_iterator</tt> - Typedef for iterator over the operand
2634 list<br>
2635     <tt>op_iterator op_begin()</tt> - Get an iterator to the start of
2636 the operand list.<br>
2637     <tt>op_iterator op_end()</tt> - Get an iterator to the end of the
2638 operand list.
2639     <p> Together, these methods make up the iterator based interface to
2640 the operands of a <tt>User</tt>.</p></li>
2641 </ul>
2642
2643 </div>
2644
2645 <!-- ======================================================================= -->
2646 <div class="doc_subsection">
2647   <a name="Instruction">The <tt>Instruction</tt> class</a>
2648 </div>
2649
2650 <div class="doc_text">
2651
2652 <p><tt>#include "</tt><tt><a
2653 href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br>
2654 doxygen info: <a href="/doxygen/classllvm_1_1Instruction.html">Instruction Class</a><br>
2655 Superclasses: <a href="#User"><tt>User</tt></a>, <a
2656 href="#Value"><tt>Value</tt></a></p>
2657
2658 <p>The <tt>Instruction</tt> class is the common base class for all LLVM
2659 instructions.  It provides only a few methods, but is a very commonly used
2660 class.  The primary data tracked by the <tt>Instruction</tt> class itself is the
2661 opcode (instruction type) and the parent <a
2662 href="#BasicBlock"><tt>BasicBlock</tt></a> the <tt>Instruction</tt> is embedded
2663 into.  To represent a specific type of instruction, one of many subclasses of
2664 <tt>Instruction</tt> are used.</p>
2665
2666 <p> Because the <tt>Instruction</tt> class subclasses the <a
2667 href="#User"><tt>User</tt></a> class, its operands can be accessed in the same
2668 way as for other <a href="#User"><tt>User</tt></a>s (with the
2669 <tt>getOperand()</tt>/<tt>getNumOperands()</tt> and
2670 <tt>op_begin()</tt>/<tt>op_end()</tt> methods).</p> <p> An important file for
2671 the <tt>Instruction</tt> class is the <tt>llvm/Instruction.def</tt> file. This
2672 file contains some meta-data about the various different types of instructions
2673 in LLVM.  It describes the enum values that are used as opcodes (for example
2674 <tt>Instruction::Add</tt> and <tt>Instruction::ICmp</tt>), as well as the
2675 concrete sub-classes of <tt>Instruction</tt> that implement the instruction (for
2676 example <tt><a href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
2677 href="#CmpInst">CmpInst</a></tt>).  Unfortunately, the use of macros in
2678 this file confuses doxygen, so these enum values don't show up correctly in the
2679 <a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p>
2680
2681 </div>
2682
2683 <!-- _______________________________________________________________________ -->
2684 <div class="doc_subsubsection">
2685   <a name="s_Instruction">Important Subclasses of the <tt>Instruction</tt>
2686   class</a>
2687 </div>
2688 <div class="doc_text">
2689   <ul>
2690     <li><tt><a name="BinaryOperator">BinaryOperator</a></tt>
2691     <p>This subclasses represents all two operand instructions whose operands
2692     must be the same type, except for the comparison instructions.</p></li>
2693     <li><tt><a name="CastInst">CastInst</a></tt>
2694     <p>This subclass is the parent of the 12 casting instructions. It provides
2695     common operations on cast instructions.</p>
2696     <li><tt><a name="CmpInst">CmpInst</a></tt>
2697     <p>This subclass respresents the two comparison instructions,
2698     <a href="LangRef.html#i_icmp">ICmpInst</a> (integer opreands), and
2699     <a href="LangRef.html#i_fcmp">FCmpInst</a> (floating point operands).</p>
2700     <li><tt><a name="TerminatorInst">TerminatorInst</a></tt>
2701     <p>This subclass is the parent of all terminator instructions (those which
2702     can terminate a block).</p>
2703   </ul>
2704   </div>
2705
2706 <!-- _______________________________________________________________________ -->
2707 <div class="doc_subsubsection">
2708   <a name="m_Instruction">Important Public Members of the <tt>Instruction</tt>
2709   class</a>
2710 </div>
2711
2712 <div class="doc_text">
2713
2714 <ul>
2715   <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt>
2716     <p>Returns the <a href="#BasicBlock"><tt>BasicBlock</tt></a> that
2717 this  <tt>Instruction</tt> is embedded into.</p></li>
2718   <li><tt>bool mayWriteToMemory()</tt>
2719     <p>Returns true if the instruction writes to memory, i.e. it is a
2720       <tt>call</tt>,<tt>free</tt>,<tt>invoke</tt>, or <tt>store</tt>.</p></li>
2721   <li><tt>unsigned getOpcode()</tt>
2722     <p>Returns the opcode for the <tt>Instruction</tt>.</p></li>
2723   <li><tt><a href="#Instruction">Instruction</a> *clone() const</tt>
2724     <p>Returns another instance of the specified instruction, identical
2725 in all ways to the original except that the instruction has no parent
2726 (ie it's not embedded into a <a href="#BasicBlock"><tt>BasicBlock</tt></a>),
2727 and it has no name</p></li>
2728 </ul>
2729
2730 </div>
2731
2732 <!-- ======================================================================= -->
2733 <div class="doc_subsection">
2734   <a name="Constant">The <tt>Constant</tt> class and subclasses</a>
2735 </div>
2736
2737 <div class="doc_text">
2738
2739 <p>Constant represents a base class for different types of constants. It
2740 is subclassed by ConstantInt, ConstantArray, etc. for representing
2741 the various types of Constants.  <a href="#GlobalValue">GlobalValue</a> is also
2742 a subclass, which represents the address of a global variable or function.
2743 </p>
2744
2745 </div>
2746
2747 <!-- _______________________________________________________________________ -->
2748 <div class="doc_subsubsection">Important Subclasses of Constant </div>
2749 <div class="doc_text">
2750 <ul>
2751   <li>ConstantInt : This subclass of Constant represents an integer constant of
2752   any width.
2753     <ul>
2754       <li><tt>const APInt&amp; getValue() const</tt>: Returns the underlying
2755       value of this constant, an APInt value.</li>
2756       <li><tt>int64_t getSExtValue() const</tt>: Converts the underlying APInt
2757       value to an int64_t via sign extension. If the value (not the bit width)
2758       of the APInt is too large to fit in an int64_t, an assertion will result.
2759       For this reason, use of this method is discouraged.</li>
2760       <li><tt>uint64_t getZExtValue() const</tt>: Converts the underlying APInt
2761       value to a uint64_t via zero extension. IF the value (not the bit width)
2762       of the APInt is too large to fit in a uint64_t, an assertion will result.
2763       For this reason, use of this method is discouraged.</li>
2764       <li><tt>static ConstantInt* get(const APInt&amp; Val)</tt>: Returns the
2765       ConstantInt object that represents the value provided by <tt>Val</tt>.
2766       The type is implied as the IntegerType that corresponds to the bit width
2767       of <tt>Val</tt>.</li>
2768       <li><tt>static ConstantInt* get(const Type *Ty, uint64_t Val)</tt>:
2769       Returns the ConstantInt object that represents the value provided by
2770       <tt>Val</tt> for integer type <tt>Ty</tt>.</li>
2771     </ul>
2772   </li>
2773   <li>ConstantFP : This class represents a floating point constant.
2774     <ul>
2775       <li><tt>double getValue() const</tt>: Returns the underlying value of
2776       this constant. </li>
2777     </ul>
2778   </li>
2779   <li>ConstantArray : This represents a constant array.
2780     <ul>
2781       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2782       a vector of component constants that makeup this array. </li>
2783     </ul>
2784   </li>
2785   <li>ConstantStruct : This represents a constant struct.
2786     <ul>
2787       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2788       a vector of component constants that makeup this array. </li>
2789     </ul>
2790   </li>
2791   <li>GlobalValue : This represents either a global variable or a function. In
2792   either case, the value is a constant fixed address (after linking).
2793   </li>
2794 </ul>
2795 </div>
2796
2797
2798 <!-- ======================================================================= -->
2799 <div class="doc_subsection">
2800   <a name="GlobalValue">The <tt>GlobalValue</tt> class</a>
2801 </div>
2802
2803 <div class="doc_text">
2804
2805 <p><tt>#include "<a
2806 href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
2807 doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
2808 Class</a><br>
2809 Superclasses: <a href="#Constant"><tt>Constant</tt></a>,
2810 <a href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
2811
2812 <p>Global values (<a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
2813 href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
2814 visible in the bodies of all <a href="#Function"><tt>Function</tt></a>s.
2815 Because they are visible at global scope, they are also subject to linking with
2816 other globals defined in different translation units.  To control the linking
2817 process, <tt>GlobalValue</tt>s know their linkage rules. Specifically,
2818 <tt>GlobalValue</tt>s know whether they have internal or external linkage, as
2819 defined by the <tt>LinkageTypes</tt> enumeration.</p>
2820
2821 <p>If a <tt>GlobalValue</tt> has internal linkage (equivalent to being
2822 <tt>static</tt> in C), it is not visible to code outside the current translation
2823 unit, and does not participate in linking.  If it has external linkage, it is
2824 visible to external code, and does participate in linking.  In addition to
2825 linkage information, <tt>GlobalValue</tt>s keep track of which <a
2826 href="#Module"><tt>Module</tt></a> they are currently part of.</p>
2827
2828 <p>Because <tt>GlobalValue</tt>s are memory objects, they are always referred to
2829 by their <b>address</b>. As such, the <a href="#Type"><tt>Type</tt></a> of a
2830 global is always a pointer to its contents. It is important to remember this
2831 when using the <tt>GetElementPtrInst</tt> instruction because this pointer must
2832 be dereferenced first. For example, if you have a <tt>GlobalVariable</tt> (a
2833 subclass of <tt>GlobalValue)</tt> that is an array of 24 ints, type <tt>[24 x
2834 i32]</tt>, then the <tt>GlobalVariable</tt> is a pointer to that array. Although
2835 the address of the first element of this array and the value of the
2836 <tt>GlobalVariable</tt> are the same, they have different types. The
2837 <tt>GlobalVariable</tt>'s type is <tt>[24 x i32]</tt>. The first element's type
2838 is <tt>i32.</tt> Because of this, accessing a global value requires you to
2839 dereference the pointer with <tt>GetElementPtrInst</tt> first, then its elements
2840 can be accessed. This is explained in the <a href="LangRef.html#globalvars">LLVM
2841 Language Reference Manual</a>.</p>
2842
2843 </div>
2844
2845 <!-- _______________________________________________________________________ -->
2846 <div class="doc_subsubsection">
2847   <a name="m_GlobalValue">Important Public Members of the <tt>GlobalValue</tt>
2848   class</a>
2849 </div>
2850
2851 <div class="doc_text">
2852
2853 <ul>
2854   <li><tt>bool hasInternalLinkage() const</tt><br>
2855     <tt>bool hasExternalLinkage() const</tt><br>
2856     <tt>void setInternalLinkage(bool HasInternalLinkage)</tt>
2857     <p> These methods manipulate the linkage characteristics of the <tt>GlobalValue</tt>.</p>
2858     <p> </p>
2859   </li>
2860   <li><tt><a href="#Module">Module</a> *getParent()</tt>
2861     <p> This returns the <a href="#Module"><tt>Module</tt></a> that the
2862 GlobalValue is currently embedded into.</p></li>
2863 </ul>
2864
2865 </div>
2866
2867 <!-- ======================================================================= -->
2868 <div class="doc_subsection">
2869   <a name="Function">The <tt>Function</tt> class</a>
2870 </div>
2871
2872 <div class="doc_text">
2873
2874 <p><tt>#include "<a
2875 href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
2876 info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
2877 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
2878 <a href="#Constant"><tt>Constant</tt></a>,
2879 <a href="#User"><tt>User</tt></a>,
2880 <a href="#Value"><tt>Value</tt></a></p>
2881
2882 <p>The <tt>Function</tt> class represents a single procedure in LLVM.  It is
2883 actually one of the more complex classes in the LLVM heirarchy because it must
2884 keep track of a large amount of data.  The <tt>Function</tt> class keeps track
2885 of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal
2886 <a href="#Argument"><tt>Argument</tt></a>s, and a
2887 <a href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
2888
2889 <p>The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most
2890 commonly used part of <tt>Function</tt> objects.  The list imposes an implicit
2891 ordering of the blocks in the function, which indicate how the code will be
2892 layed out by the backend.  Additionally, the first <a
2893 href="#BasicBlock"><tt>BasicBlock</tt></a> is the implicit entry node for the
2894 <tt>Function</tt>.  It is not legal in LLVM to explicitly branch to this initial
2895 block.  There are no implicit exit nodes, and in fact there may be multiple exit
2896 nodes from a single <tt>Function</tt>.  If the <a
2897 href="#BasicBlock"><tt>BasicBlock</tt></a> list is empty, this indicates that
2898 the <tt>Function</tt> is actually a function declaration: the actual body of the
2899 function hasn't been linked in yet.</p>
2900
2901 <p>In addition to a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, the
2902 <tt>Function</tt> class also keeps track of the list of formal <a
2903 href="#Argument"><tt>Argument</tt></a>s that the function receives.  This
2904 container manages the lifetime of the <a href="#Argument"><tt>Argument</tt></a>
2905 nodes, just like the <a href="#BasicBlock"><tt>BasicBlock</tt></a> list does for
2906 the <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.</p>
2907
2908 <p>The <a href="#SymbolTable"><tt>SymbolTable</tt></a> is a very rarely used
2909 LLVM feature that is only used when you have to look up a value by name.  Aside
2910 from that, the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is used
2911 internally to make sure that there are not conflicts between the names of <a
2912 href="#Instruction"><tt>Instruction</tt></a>s, <a
2913 href="#BasicBlock"><tt>BasicBlock</tt></a>s, or <a
2914 href="#Argument"><tt>Argument</tt></a>s in the function body.</p>
2915
2916 <p>Note that <tt>Function</tt> is a <a href="#GlobalValue">GlobalValue</a>
2917 and therefore also a <a href="#Constant">Constant</a>. The value of the function
2918 is its address (after linking) which is guaranteed to be constant.</p>
2919 </div>
2920
2921 <!-- _______________________________________________________________________ -->
2922 <div class="doc_subsubsection">
2923   <a name="m_Function">Important Public Members of the <tt>Function</tt>
2924   class</a>
2925 </div>
2926
2927 <div class="doc_text">
2928
2929 <ul>
2930   <li><tt>Function(const </tt><tt><a href="#FunctionType">FunctionType</a>
2931   *Ty, LinkageTypes Linkage, const std::string &amp;N = "", Module* Parent = 0)</tt>
2932
2933     <p>Constructor used when you need to create new <tt>Function</tt>s to add
2934     the the program.  The constructor must specify the type of the function to
2935     create and what type of linkage the function should have. The <a
2936     href="#FunctionType"><tt>FunctionType</tt></a> argument
2937     specifies the formal arguments and return value for the function. The same
2938     <a href="#FunctionType"><tt>FunctionType</tt></a> value can be used to
2939     create multiple functions. The <tt>Parent</tt> argument specifies the Module
2940     in which the function is defined. If this argument is provided, the function
2941     will automatically be inserted into that module's list of
2942     functions.</p></li>
2943
2944   <li><tt>bool isExternal()</tt>
2945
2946     <p>Return whether or not the <tt>Function</tt> has a body defined.  If the
2947     function is "external", it does not have a body, and thus must be resolved
2948     by linking with a function defined in a different translation unit.</p></li>
2949
2950   <li><tt>Function::iterator</tt> - Typedef for basic block list iterator<br>
2951     <tt>Function::const_iterator</tt> - Typedef for const_iterator.<br>
2952
2953     <tt>begin()</tt>, <tt>end()</tt>
2954     <tt>size()</tt>, <tt>empty()</tt>
2955
2956     <p>These are forwarding methods that make it easy to access the contents of
2957     a <tt>Function</tt> object's <a href="#BasicBlock"><tt>BasicBlock</tt></a>
2958     list.</p></li>
2959
2960   <li><tt>Function::BasicBlockListType &amp;getBasicBlockList()</tt>
2961
2962     <p>Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.  This
2963     is necessary to use when you need to update the list or perform a complex
2964     action that doesn't have a forwarding method.</p></li>
2965
2966   <li><tt>Function::arg_iterator</tt> - Typedef for the argument list
2967 iterator<br>
2968     <tt>Function::const_arg_iterator</tt> - Typedef for const_iterator.<br>
2969
2970     <tt>arg_begin()</tt>, <tt>arg_end()</tt>
2971     <tt>arg_size()</tt>, <tt>arg_empty()</tt>
2972
2973     <p>These are forwarding methods that make it easy to access the contents of
2974     a <tt>Function</tt> object's <a href="#Argument"><tt>Argument</tt></a>
2975     list.</p></li>
2976
2977   <li><tt>Function::ArgumentListType &amp;getArgumentList()</tt>
2978
2979     <p>Returns the list of <a href="#Argument"><tt>Argument</tt></a>s.  This is
2980     necessary to use when you need to update the list or perform a complex
2981     action that doesn't have a forwarding method.</p></li>
2982
2983   <li><tt><a href="#BasicBlock">BasicBlock</a> &amp;getEntryBlock()</tt>
2984
2985     <p>Returns the entry <a href="#BasicBlock"><tt>BasicBlock</tt></a> for the
2986     function.  Because the entry block for the function is always the first
2987     block, this returns the first block of the <tt>Function</tt>.</p></li>
2988
2989   <li><tt><a href="#Type">Type</a> *getReturnType()</tt><br>
2990     <tt><a href="#FunctionType">FunctionType</a> *getFunctionType()</tt>
2991
2992     <p>This traverses the <a href="#Type"><tt>Type</tt></a> of the
2993     <tt>Function</tt> and returns the return type of the function, or the <a
2994     href="#FunctionType"><tt>FunctionType</tt></a> of the actual
2995     function.</p></li>
2996
2997   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
2998
2999     <p> Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
3000     for this <tt>Function</tt>.</p></li>
3001 </ul>
3002
3003 </div>
3004
3005 <!-- ======================================================================= -->
3006 <div class="doc_subsection">
3007   <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a>
3008 </div>
3009
3010 <div class="doc_text">
3011
3012 <p><tt>#include "<a
3013 href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt>
3014 <br>
3015 doxygen info: <a href="/doxygen/classllvm_1_1GlobalVariable.html">GlobalVariable
3016  Class</a><br>
3017 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
3018 <a href="#Constant"><tt>Constant</tt></a>,
3019 <a href="#User"><tt>User</tt></a>,
3020 <a href="#Value"><tt>Value</tt></a></p>
3021
3022 <p>Global variables are represented with the (suprise suprise)
3023 <tt>GlobalVariable</tt> class. Like functions, <tt>GlobalVariable</tt>s are also
3024 subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such are
3025 always referenced by their address (global values must live in memory, so their
3026 "name" refers to their constant address). See
3027 <a href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this.  Global
3028 variables may have an initial value (which must be a
3029 <a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer,
3030 they may be marked as "constant" themselves (indicating that their contents
3031 never change at runtime).</p>
3032 </div>
3033
3034 <!-- _______________________________________________________________________ -->
3035 <div class="doc_subsubsection">
3036   <a name="m_GlobalVariable">Important Public Members of the
3037   <tt>GlobalVariable</tt> class</a>
3038 </div>
3039
3040 <div class="doc_text">
3041
3042 <ul>
3043   <li><tt>GlobalVariable(const </tt><tt><a href="#Type">Type</a> *Ty, bool
3044   isConstant, LinkageTypes&amp; Linkage, <a href="#Constant">Constant</a>
3045   *Initializer = 0, const std::string &amp;Name = "", Module* Parent = 0)</tt>
3046
3047     <p>Create a new global variable of the specified type. If
3048     <tt>isConstant</tt> is true then the global variable will be marked as
3049     unchanging for the program. The Linkage parameter specifies the type of
3050     linkage (internal, external, weak, linkonce, appending) for the variable. If
3051     the linkage is InternalLinkage, WeakLinkage, or LinkOnceLinkage,&nbsp; then
3052     the resultant global variable will have internal linkage.  AppendingLinkage
3053     concatenates together all instances (in different translation units) of the
3054     variable into a single variable but is only applicable to arrays.  &nbsp;See
3055     the <a href="LangRef.html#modulestructure">LLVM Language Reference</a> for
3056     further details on linkage types. Optionally an initializer, a name, and the
3057     module to put the variable into may be specified for the global variable as
3058     well.</p></li>
3059
3060   <li><tt>bool isConstant() const</tt>
3061
3062     <p>Returns true if this is a global variable that is known not to
3063     be modified at runtime.</p></li>
3064
3065   <li><tt>bool hasInitializer()</tt>
3066
3067     <p>Returns true if this <tt>GlobalVariable</tt> has an intializer.</p></li>
3068
3069   <li><tt><a href="#Constant">Constant</a> *getInitializer()</tt>
3070
3071     <p>Returns the intial value for a <tt>GlobalVariable</tt>.  It is not legal
3072     to call this method if there is no initializer.</p></li>
3073 </ul>
3074
3075 </div>
3076
3077
3078 <!-- ======================================================================= -->
3079 <div class="doc_subsection">
3080   <a name="BasicBlock">The <tt>BasicBlock</tt> class</a>
3081 </div>
3082
3083 <div class="doc_text">
3084
3085 <p><tt>#include "<a
3086 href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
3087 doxygen info: <a href="/doxygen/structllvm_1_1BasicBlock.html">BasicBlock
3088 Class</a><br>
3089 Superclass: <a href="#Value"><tt>Value</tt></a></p>
3090
3091 <p>This class represents a single entry multiple exit section of the code,
3092 commonly known as a basic block by the compiler community.  The
3093 <tt>BasicBlock</tt> class maintains a list of <a
3094 href="#Instruction"><tt>Instruction</tt></a>s, which form the body of the block.
3095 Matching the language definition, the last element of this list of instructions
3096 is always a terminator instruction (a subclass of the <a
3097 href="#TerminatorInst"><tt>TerminatorInst</tt></a> class).</p>
3098
3099 <p>In addition to tracking the list of instructions that make up the block, the
3100 <tt>BasicBlock</tt> class also keeps track of the <a
3101 href="#Function"><tt>Function</tt></a> that it is embedded into.</p>
3102
3103 <p>Note that <tt>BasicBlock</tt>s themselves are <a
3104 href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions
3105 like branches and can go in the switch tables. <tt>BasicBlock</tt>s have type
3106 <tt>label</tt>.</p>
3107
3108 </div>
3109
3110 <!-- _______________________________________________________________________ -->
3111 <div class="doc_subsubsection">
3112   <a name="m_BasicBlock">Important Public Members of the <tt>BasicBlock</tt>
3113   class</a>
3114 </div>
3115
3116 <div class="doc_text">
3117 <ul>
3118
3119 <li><tt>BasicBlock(const std::string &amp;Name = "", </tt><tt><a
3120  href="#Function">Function</a> *Parent = 0)</tt>
3121
3122 <p>The <tt>BasicBlock</tt> constructor is used to create new basic blocks for
3123 insertion into a function.  The constructor optionally takes a name for the new
3124 block, and a <a href="#Function"><tt>Function</tt></a> to insert it into.  If
3125 the <tt>Parent</tt> parameter is specified, the new <tt>BasicBlock</tt> is
3126 automatically inserted at the end of the specified <a
3127 href="#Function"><tt>Function</tt></a>, if not specified, the BasicBlock must be
3128 manually inserted into the <a href="#Function"><tt>Function</tt></a>.</p></li>
3129
3130 <li><tt>BasicBlock::iterator</tt> - Typedef for instruction list iterator<br>
3131 <tt>BasicBlock::const_iterator</tt> - Typedef for const_iterator.<br>
3132 <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
3133 <tt>size()</tt>, <tt>empty()</tt>
3134 STL-style functions for accessing the instruction list.
3135
3136 <p>These methods and typedefs are forwarding functions that have the same
3137 semantics as the standard library methods of the same names.  These methods
3138 expose the underlying instruction list of a basic block in a way that is easy to
3139 manipulate.  To get the full complement of container operations (including
3140 operations to update the list), you must use the <tt>getInstList()</tt>
3141 method.</p></li>
3142
3143 <li><tt>BasicBlock::InstListType &amp;getInstList()</tt>
3144
3145 <p>This method is used to get access to the underlying container that actually
3146 holds the Instructions.  This method must be used when there isn't a forwarding
3147 function in the <tt>BasicBlock</tt> class for the operation that you would like
3148 to perform.  Because there are no forwarding functions for "updating"
3149 operations, you need to use this if you want to update the contents of a
3150 <tt>BasicBlock</tt>.</p></li>
3151
3152 <li><tt><a href="#Function">Function</a> *getParent()</tt>
3153
3154 <p> Returns a pointer to <a href="#Function"><tt>Function</tt></a> the block is
3155 embedded into, or a null pointer if it is homeless.</p></li>
3156
3157 <li><tt><a href="#TerminatorInst">TerminatorInst</a> *getTerminator()</tt>
3158
3159 <p> Returns a pointer to the terminator instruction that appears at the end of
3160 the <tt>BasicBlock</tt>.  If there is no terminator instruction, or if the last
3161 instruction in the block is not a terminator, then a null pointer is
3162 returned.</p></li>
3163
3164 </ul>
3165
3166 </div>
3167
3168
3169 <!-- ======================================================================= -->
3170 <div class="doc_subsection">
3171   <a name="Argument">The <tt>Argument</tt> class</a>
3172 </div>
3173
3174 <div class="doc_text">
3175
3176 <p>This subclass of Value defines the interface for incoming formal
3177 arguments to a function. A Function maintains a list of its formal
3178 arguments. An argument has a pointer to the parent Function.</p>
3179
3180 </div>
3181
3182 <!-- *********************************************************************** -->
3183 <hr>
3184 <address>
3185   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
3186   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
3187   <a href="http://validator.w3.org/check/referer"><img
3188   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
3189
3190   <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and
3191   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
3192   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
3193   Last modified: $Date$
3194 </address>
3195
3196 </body>
3197 </html>