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