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   <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
   6   <title>LLVM Programmer's Manual</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <div class="doc_title">
  12   LLVM Programmer's Manual
  13 </div>
  14
  15 <ol>
  16   <li><a href="#introduction">Introduction</a></li>
  17   <li><a href="#general">General Information</a>
  18     <ul>
  19       <li><a href="#stl">The C++ Standard Template Library</a></li>
  20 <!--
  21       <li>The <tt>-time-passes</tt> option</li>
  22       <li>How to use the LLVM Makefile system</li>
  23       <li>How to write a regression test</li>
  24
  25 -->
  26     </ul>
  27   </li>
  28   <li><a href="#apis">Important and useful LLVM APIs</a>
  29     <ul>
  30       <li><a href="#isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt>
  31 and <tt>dyn_cast&lt;&gt;</tt> templates</a> </li>
  32       <li><a href="#string_apis">Passing strings (the <tt>StringRef</tt>
  33 and <tt>Twine</tt> classes)</a>
  34         <ul>
  35           <li><a href="#StringRef">The <tt>StringRef</tt> class</a> </li>
  36           <li><a href="#Twine">The <tt>Twine</tt> class</a> </li>
  37         </ul>
  38       </li>
  39       <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt>
  40 option</a>
  41         <ul>
  42           <li><a href="#DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt>
  43 and the <tt>-debug-only</tt> option</a> </li>
  44         </ul>
  45       </li>
  46       <li><a href="#Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
  47 option</a></li>
  48 <!--
  49       <li>The <tt>InstVisitor</tt> template
  50       <li>The general graph API
  51 -->
  52       <li><a href="#ViewGraph">Viewing graphs while debugging code</a></li>
  53     </ul>
  54   </li>
  55   <li><a href="#datastructure">Picking the Right Data Structure for a Task</a>
  56     <ul>
  57     <li><a href="#ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
  58     <ul>
  59       <li><a href="#dss_fixedarrays">Fixed Size Arrays</a></li>
  60       <li><a href="#dss_heaparrays">Heap Allocated Arrays</a></li>
  61       <li><a href="#dss_smallvector">"llvm/ADT/SmallVector.h"</a></li>
  62       <li><a href="#dss_vector">&lt;vector&gt;</a></li>
  63       <li><a href="#dss_deque">&lt;deque&gt;</a></li>
  64       <li><a href="#dss_list">&lt;list&gt;</a></li>
  65       <li><a href="#dss_ilist">llvm/ADT/ilist.h</a></li>
  66       <li><a href="#dss_other">Other Sequential Container Options</a></li>
  67     </ul></li>
  68     <li><a href="#ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
  69     <ul>
  70       <li><a href="#dss_sortedvectorset">A sorted 'vector'</a></li>
  71       <li><a href="#dss_smallset">"llvm/ADT/SmallSet.h"</a></li>
  72       <li><a href="#dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a></li>
  73       <li><a href="#dss_denseset">"llvm/ADT/DenseSet.h"</a></li>
  74       <li><a href="#dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a></li>
  75       <li><a href="#dss_set">&lt;set&gt;</a></li>
  76       <li><a href="#dss_setvector">"llvm/ADT/SetVector.h"</a></li>
  77       <li><a href="#dss_uniquevector">"llvm/ADT/UniqueVector.h"</a></li>
  78       <li><a href="#dss_otherset">Other Set-Like ContainerOptions</a></li>
  79     </ul></li>
  80     <li><a href="#ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
  81     <ul>
  82       <li><a href="#dss_sortedvectormap">A sorted 'vector'</a></li>
  83       <li><a href="#dss_stringmap">"llvm/ADT/StringMap.h"</a></li>
  84       <li><a href="#dss_indexedmap">"llvm/ADT/IndexedMap.h"</a></li>
  85       <li><a href="#dss_densemap">"llvm/ADT/DenseMap.h"</a></li>
  86       <li><a href="#dss_valuemap">"llvm/ADT/ValueMap.h"</a></li>
  87       <li><a href="#dss_intervalmap">"llvm/ADT/IntervalMap.h"</a></li>
  88       <li><a href="#dss_map">&lt;map&gt;</a></li>
  89       <li><a href="#dss_inteqclasses">"llvm/ADT/IntEqClasses.h"</a></li>
  90       <li><a href="#dss_othermap">Other Map-Like Container Options</a></li>
  91     </ul></li>
  92     <li><a href="#ds_string">String-like containers</a>
  93     <!--<ul>
  94        todo
  95     </ul>--></li>
  96     <li><a href="#ds_bit">BitVector-like containers</a>
  97     <ul>
  98       <li><a href="#dss_bitvector">A dense bitvector</a></li>
  99       <li><a href="#dss_smallbitvector">A "small" dense bitvector</a></li>
 100       <li><a href="#dss_sparsebitvector">A sparse bitvector</a></li>
 101     </ul></li>
 102   </ul>
 103   </li>
 104   <li><a href="#common">Helpful Hints for Common Operations</a>
 105     <ul>
 106       <li><a href="#inspection">Basic Inspection and Traversal Routines</a>
 107         <ul>
 108           <li><a href="#iterate_function">Iterating over the <tt>BasicBlock</tt>s
 109 in a <tt>Function</tt></a> </li>
 110           <li><a href="#iterate_basicblock">Iterating over the <tt>Instruction</tt>s
 111 in a <tt>BasicBlock</tt></a> </li>
 112           <li><a href="#iterate_institer">Iterating over the <tt>Instruction</tt>s
 113 in a <tt>Function</tt></a> </li>
 114           <li><a href="#iterate_convert">Turning an iterator into a
 115 class pointer</a> </li>
 116           <li><a href="#iterate_complex">Finding call sites: a more
 117 complex example</a> </li>
 118           <li><a href="#calls_and_invokes">Treating calls and invokes
 119 the same way</a> </li>
 120           <li><a href="#iterate_chains">Iterating over def-use &amp;
 121 use-def chains</a> </li>
 122           <li><a href="#iterate_preds">Iterating over predecessors &amp;
 123 successors of blocks</a></li>
 124         </ul>
 125       </li>
 126       <li><a href="#simplechanges">Making simple changes</a>
 127         <ul>
 128           <li><a href="#schanges_creating">Creating and inserting new
 129                  <tt>Instruction</tt>s</a> </li>
 130           <li><a href="#schanges_deleting">Deleting              <tt>Instruction</tt>s</a> </li>
 131           <li><a href="#schanges_replacing">Replacing an                 <tt>Instruction</tt>
 132 with another <tt>Value</tt></a> </li>
 133           <li><a href="#schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a> </li>
 134         </ul>
 135       </li>
 136       <li><a href="#create_types">How to Create Types</a></li>
 137 <!--
 138     <li>Working with the Control Flow Graph
 139     <ul>
 140       <li>Accessing predecessors and successors of a <tt>BasicBlock</tt>
 141       <li>
 142       <li>
 143     </ul>
 144 -->
 145     </ul>
 146   </li>
 147
 148   <li><a href="#threading">Threads and LLVM</a>
 149   <ul>
 150     <li><a href="#startmultithreaded">Entering and Exiting Multithreaded Mode
 151         </a></li>
 152     <li><a href="#shutdown">Ending execution with <tt>llvm_shutdown()</tt></a></li>
 153     <li><a href="#managedstatic">Lazy initialization with <tt>ManagedStatic</tt></a></li>
 154     <li><a href="#llvmcontext">Achieving Isolation with <tt>LLVMContext</tt></a></li>
 155     <li><a href="#jitthreading">Threads and the JIT</a></li>
 156   </ul>
 157   </li>
 158
 159   <li><a href="#advanced">Advanced Topics</a>
 160   <ul>
 161   <li><a href="#TypeResolve">LLVM Type Resolution</a>
 162   <ul>
 163     <li><a href="#BuildRecType">Basic Recursive Type Construction</a></li>
 164     <li><a href="#refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a></li>
 165     <li><a href="#PATypeHolder">The PATypeHolder Class</a></li>
 166     <li><a href="#AbstractTypeUser">The AbstractTypeUser Class</a></li>
 167   </ul></li>
 168
 169   <li><a href="#SymbolTable">The <tt>ValueSymbolTable</tt> and <tt>TypeSymbolTable</tt> classes</a></li>
 170   <li><a href="#UserLayout">The <tt>User</tt> and owned <tt>Use</tt> classes' memory layout</a></li>
 171   </ul></li>
 172
 173   <li><a href="#coreclasses">The Core LLVM Class Hierarchy Reference</a>
 174     <ul>
 175       <li><a href="#Type">The <tt>Type</tt> class</a> </li>
 176       <li><a href="#Module">The <tt>Module</tt> class</a></li>
 177       <li><a href="#Value">The <tt>Value</tt> class</a>
 178       <ul>
 179         <li><a href="#User">The <tt>User</tt> class</a>
 180         <ul>
 181           <li><a href="#Instruction">The <tt>Instruction</tt> class</a></li>
 182           <li><a href="#Constant">The <tt>Constant</tt> class</a>
 183           <ul>
 184             <li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
 185             <ul>
 186               <li><a href="#Function">The <tt>Function</tt> class</a></li>
 187               <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class</a></li>
 188             </ul>
 189             </li>
 190           </ul>
 191           </li>
 192         </ul>
 193         </li>
 194         <li><a href="#BasicBlock">The <tt>BasicBlock</tt> class</a></li>
 195         <li><a href="#Argument">The <tt>Argument</tt> class</a></li>
 196       </ul>
 197       </li>
 198     </ul>
 199   </li>
 200 </ol>
 201
 202 <div class="doc_author">
 203   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
 204                 <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>,
 205                 <a href="mailto:ggreif@gmail.com">Gabor Greif</a>,
 206                 <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a>,
 207                 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a> and
 208                 <a href="mailto:owen@apple.com">Owen Anderson</a></p>
 209 </div>
 210
 211 <!-- *********************************************************************** -->
 212 <div class="doc_section">
 213   <a name="introduction">Introduction </a>
 214 </div>
 215 <!-- *********************************************************************** -->
 216
 217 <div class="doc_text">
 218
 219 <p>This document is meant to highlight some of the important classes and
 220 interfaces available in the LLVM source-base.  This manual is not
 221 intended to explain what LLVM is, how it works, and what LLVM code looks
 222 like.  It assumes that you know the basics of LLVM and are interested
 223 in writing transformations or otherwise analyzing or manipulating the
 224 code.</p>
 225
 226 <p>This document should get you oriented so that you can find your
 227 way in the continuously growing source code that makes up the LLVM
 228 infrastructure. Note that this manual is not intended to serve as a
 229 replacement for reading the source code, so if you think there should be
 230 a method in one of these classes to do something, but it's not listed,
 231 check the source.  Links to the <a href="/doxygen/">doxygen</a> sources
 232 are provided to make this as easy as possible.</p>
 233
 234 <p>The first section of this document describes general information that is
 235 useful to know when working in the LLVM infrastructure, and the second describes
 236 the Core LLVM classes.  In the future this manual will be extended with
 237 information describing how to use extension libraries, such as dominator
 238 information, CFG traversal routines, and useful utilities like the <tt><a
 239 href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.</p>
 240
 241 </div>
 242
 243 <!-- *********************************************************************** -->
 244 <div class="doc_section">
 245   <a name="general">General Information</a>
 246 </div>
 247 <!-- *********************************************************************** -->
 248
 249 <div class="doc_text">
 250
 251 <p>This section contains general information that is useful if you are working
 252 in the LLVM source-base, but that isn't specific to any particular API.</p>
 253
 254 </div>
 255
 256 <!-- ======================================================================= -->
 257 <div class="doc_subsection">
 258   <a name="stl">The C++ Standard Template Library</a>
 259 </div>
 260
 261 <div class="doc_text">
 262
 263 <p>LLVM makes heavy use of the C++ Standard Template Library (STL),
 264 perhaps much more than you are used to, or have seen before.  Because of
 265 this, you might want to do a little background reading in the
 266 techniques used and capabilities of the library.  There are many good
 267 pages that discuss the STL, and several books on the subject that you
 268 can get, so it will not be discussed in this document.</p>
 269
 270 <p>Here are some useful links:</p>
 271
 272 <ol>
 273
 274 <li><a href="http://www.dinkumware.com/manuals/#Standard C++ Library">Dinkumware
 275 C++ Library reference</a> - an excellent reference for the STL and other parts
 276 of the standard C++ library.</li>
 277
 278 <li><a href="http://www.tempest-sw.com/cpp/">C++ In a Nutshell</a> - This is an
 279 O'Reilly book in the making.  It has a decent Standard Library
 280 Reference that rivals Dinkumware's, and is unfortunately no longer free since the
 281 book has been published.</li>
 282
 283 <li><a href="http://www.parashift.com/c++-faq-lite/">C++ Frequently Asked
 284 Questions</a></li>
 285
 286 <li><a href="http://www.sgi.com/tech/stl/">SGI's STL Programmer's Guide</a> -
 287 Contains a useful <a
 288 href="http://www.sgi.com/tech/stl/stl_introduction.html">Introduction to the
 289 STL</a>.</li>
 290
 291 <li><a href="http://www.research.att.com/%7Ebs/C++.html">Bjarne Stroustrup's C++
 292 Page</a></li>
 293
 294 <li><a href="http://64.78.49.204/">
 295 Bruce Eckel's Thinking in C++, 2nd ed. Volume 2 Revision 4.0 (even better, get
 296 the book).</a></li>
 297
 298 </ol>
 299
 300 <p>You are also encouraged to take a look at the <a
 301 href="CodingStandards.html">LLVM Coding Standards</a> guide which focuses on how
 302 to write maintainable code more than where to put your curly braces.</p>
 303
 304 </div>
 305
 306 <!-- ======================================================================= -->
 307 <div class="doc_subsection">
 308   <a name="stl">Other useful references</a>
 309 </div>
 310
 311 <div class="doc_text">
 312
 313 <ol>
 314 <li><a href="http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html">Using
 315 static and shared libraries across platforms</a></li>
 316 </ol>
 317
 318 </div>
 319
 320 <!-- *********************************************************************** -->
 321 <div class="doc_section">
 322   <a name="apis">Important and useful LLVM APIs</a>
 323 </div>
 324 <!-- *********************************************************************** -->
 325
 326 <div class="doc_text">
 327
 328 <p>Here we highlight some LLVM APIs that are generally useful and good to
 329 know about when writing transformations.</p>
 330
 331 </div>
 332
 333 <!-- ======================================================================= -->
 334 <div class="doc_subsection">
 335   <a name="isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt> and
 336   <tt>dyn_cast&lt;&gt;</tt> templates</a>
 337 </div>
 338
 339 <div class="doc_text">
 340
 341 <p>The LLVM source-base makes extensive use of a custom form of RTTI.
 342 These templates have many similarities to the C++ <tt>dynamic_cast&lt;&gt;</tt>
 343 operator, but they don't have some drawbacks (primarily stemming from
 344 the fact that <tt>dynamic_cast&lt;&gt;</tt> only works on classes that
 345 have a v-table). Because they are used so often, you must know what they
 346 do and how they work. All of these templates are defined in the <a
 347  href="/doxygen/Casting_8h-source.html"><tt>llvm/Support/Casting.h</tt></a>
 348 file (note that you very rarely have to include this file directly).</p>
 349
 350 <dl>
 351   <dt><tt>isa&lt;&gt;</tt>: </dt>
 352
 353   <dd><p>The <tt>isa&lt;&gt;</tt> operator works exactly like the Java
 354   "<tt>instanceof</tt>" operator.  It returns true or false depending on whether
 355   a reference or pointer points to an instance of the specified class.  This can
 356   be very useful for constraint checking of various sorts (example below).</p>
 357   </dd>
 358
 359   <dt><tt>cast&lt;&gt;</tt>: </dt>
 360
 361   <dd><p>The <tt>cast&lt;&gt;</tt> operator is a "checked cast" operation. It
 362   converts a pointer or reference from a base class to a derived class, causing
 363   an assertion failure if it is not really an instance of the right type.  This
 364   should be used in cases where you have some information that makes you believe
 365   that something is of the right type.  An example of the <tt>isa&lt;&gt;</tt>
 366   and <tt>cast&lt;&gt;</tt> template is:</p>
 367
 368 <div class="doc_code">
 369 <pre>
 370 static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
 371   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))
 372     return true;
 373
 374   // <i>Otherwise, it must be an instruction...</i>
 375   return !L-&gt;contains(cast&lt;<a href="#Instruction">Instruction</a>&gt;(V)-&gt;getParent());
 376 }
 377 </pre>
 378 </div>
 379
 380   <p>Note that you should <b>not</b> use an <tt>isa&lt;&gt;</tt> test followed
 381   by a <tt>cast&lt;&gt;</tt>, for that use the <tt>dyn_cast&lt;&gt;</tt>
 382   operator.</p>
 383
 384   </dd>
 385
 386   <dt><tt>dyn_cast&lt;&gt;</tt>:</dt>
 387
 388   <dd><p>The <tt>dyn_cast&lt;&gt;</tt> operator is a "checking cast" operation.
 389   It checks to see if the operand is of the specified type, and if so, returns a
 390   pointer to it (this operator does not work with references). If the operand is
 391   not of the correct type, a null pointer is returned.  Thus, this works very
 392   much like the <tt>dynamic_cast&lt;&gt;</tt> operator in C++, and should be
 393   used in the same circumstances.  Typically, the <tt>dyn_cast&lt;&gt;</tt>
 394   operator is used in an <tt>if</tt> statement or some other flow control
 395   statement like this:</p>
 396
 397 <div class="doc_code">
 398 <pre>
 399 if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast&lt;<a href="#AllocationInst">AllocationInst</a>&gt;(Val)) {
 400   // <i>...</i>
 401 }
 402 </pre>
 403 </div>
 404
 405   <p>This form of the <tt>if</tt> statement effectively combines together a call
 406   to <tt>isa&lt;&gt;</tt> and a call to <tt>cast&lt;&gt;</tt> into one
 407   statement, which is very convenient.</p>
 408
 409   <p>Note that the <tt>dyn_cast&lt;&gt;</tt> operator, like C++'s
 410   <tt>dynamic_cast&lt;&gt;</tt> or Java's <tt>instanceof</tt> operator, can be
 411   abused.  In particular, you should not use big chained <tt>if/then/else</tt>
 412   blocks to check for lots of different variants of classes.  If you find
 413   yourself wanting to do this, it is much cleaner and more efficient to use the
 414   <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p>
 415
 416   </dd>
 417
 418   <dt><tt>cast_or_null&lt;&gt;</tt>: </dt>
 419
 420   <dd><p>The <tt>cast_or_null&lt;&gt;</tt> operator works just like the
 421   <tt>cast&lt;&gt;</tt> operator, except that it allows for a null pointer as an
 422   argument (which it then propagates).  This can sometimes be useful, allowing
 423   you to combine several null checks into one.</p></dd>
 424
 425   <dt><tt>dyn_cast_or_null&lt;&gt;</tt>: </dt>
 426
 427   <dd><p>The <tt>dyn_cast_or_null&lt;&gt;</tt> operator works just like the
 428   <tt>dyn_cast&lt;&gt;</tt> operator, except that it allows for a null pointer
 429   as an argument (which it then propagates).  This can sometimes be useful,
 430   allowing you to combine several null checks into one.</p></dd>
 431
 432 </dl>
 433
 434 <p>These five templates can be used with any classes, whether they have a
 435 v-table or not.  To add support for these templates, you simply need to add
 436 <tt>classof</tt> static methods to the class you are interested casting
 437 to. Describing this is currently outside the scope of this document, but there
 438 are lots of examples in the LLVM source base.</p>
 439
 440 </div>
 441
 442
 443 <!-- ======================================================================= -->
 444 <div class="doc_subsection">
 445   <a name="string_apis">Passing strings (the <tt>StringRef</tt>
 446 and <tt>Twine</tt> classes)</a>
 447 </div>
 448
 449 <div class="doc_text">
 450
 451 <p>Although LLVM generally does not do much string manipulation, we do have
 452 several important APIs which take strings.  Two important examples are the
 453 Value class -- which has names for instructions, functions, etc. -- and the
 454 StringMap class which is used extensively in LLVM and Clang.</p>
 455
 456 <p>These are generic classes, and they need to be able to accept strings which
 457 may have embedded null characters.  Therefore, they cannot simply take
 458 a <tt>const char *</tt>, and taking a <tt>const std::string&amp;</tt> requires
 459 clients to perform a heap allocation which is usually unnecessary.  Instead,
 460 many LLVM APIs use a <tt>StringRef</tt> or a <tt>const Twine&amp;</tt> for
 461 passing strings efficiently.</p>
 462
 463 </div>
 464
 465 <!-- _______________________________________________________________________ -->
 466 <div class="doc_subsubsection">
 467   <a name="StringRef">The <tt>StringRef</tt> class</a>
 468 </div>
 469
 470 <div class="doc_text">
 471
 472 <p>The <tt>StringRef</tt> data type represents a reference to a constant string
 473 (a character array and a length) and supports the common operations available
 474 on <tt>std:string</tt>, but does not require heap allocation.</p>
 475
 476 <p>It can be implicitly constructed using a C style null-terminated string,
 477 an <tt>std::string</tt>, or explicitly with a character pointer and length.
 478 For example, the <tt>StringRef</tt> find function is declared as:</p>
 479
 480 <pre class="doc_code">
 481   iterator find(StringRef Key);
 482 </pre>
 483
 484 <p>and clients can call it using any one of:</p>
 485
 486 <pre class="doc_code">
 487   Map.find("foo");                 <i>// Lookup "foo"</i>
 488   Map.find(std::string("bar"));    <i>// Lookup "bar"</i>
 489   Map.find(StringRef("\0baz", 4)); <i>// Lookup "\0baz"</i>
 490 </pre>
 491
 492 <p>Similarly, APIs which need to return a string may return a <tt>StringRef</tt>
 493 instance, which can be used directly or converted to an <tt>std::string</tt>
 494 using the <tt>str</tt> member function.  See
 495 "<tt><a href="/doxygen/classllvm_1_1StringRef_8h-source.html">llvm/ADT/StringRef.h</a></tt>"
 496 for more information.</p>
 497
 498 <p>You should rarely use the <tt>StringRef</tt> class directly, because it contains
 499 pointers to external memory it is not generally safe to store an instance of the
 500 class (unless you know that the external storage will not be freed). StringRef is
 501 small and pervasive enough in LLVM that it should always be passed by value.</p>
 502
 503 </div>
 504
 505 <!-- _______________________________________________________________________ -->
 506 <div class="doc_subsubsection">
 507   <a name="Twine">The <tt>Twine</tt> class</a>
 508 </div>
 509
 510 <div class="doc_text">
 511
 512 <p>The <tt>Twine</tt> class is an efficient way for APIs to accept concatenated
 513 strings.  For example, a common LLVM paradigm is to name one instruction based on
 514 the name of another instruction with a suffix, for example:</p>
 515
 516 <div class="doc_code">
 517 <pre>
 518     New = CmpInst::Create(<i>...</i>, SO->getName() + ".cmp");
 519 </pre>
 520 </div>
 521
 522 <p>The <tt>Twine</tt> class is effectively a
 523 lightweight <a href="http://en.wikipedia.org/wiki/Rope_(computer_science)">rope</a>
 524 which points to temporary (stack allocated) objects.  Twines can be implicitly
 525 constructed as the result of the plus operator applied to strings (i.e., a C
 526 strings, an <tt>std::string</tt>, or a <tt>StringRef</tt>).  The twine delays the
 527 actual concatenation of strings until it is actually required, at which point
 528 it can be efficiently rendered directly into a character array.  This avoids
 529 unnecessary heap allocation involved in constructing the temporary results of
 530 string concatenation. See
 531 "<tt><a href="/doxygen/classllvm_1_1Twine_8h-source.html">llvm/ADT/Twine.h</a></tt>"
 532 for more information.</p>
 533
 534 <p>As with a <tt>StringRef</tt>, <tt>Twine</tt> objects point to external memory
 535 and should almost never be stored or mentioned directly.  They are intended
 536 solely for use when defining a function which should be able to efficiently
 537 accept concatenated strings.</p>
 538
 539 </div>
 540
 541
 542 <!-- ======================================================================= -->
 543 <div class="doc_subsection">
 544   <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a>
 545 </div>
 546
 547 <div class="doc_text">
 548
 549 <p>Often when working on your pass you will put a bunch of debugging printouts
 550 and other code into your pass.  After you get it working, you want to remove
 551 it, but you may need it again in the future (to work out new bugs that you run
 552 across).</p>
 553
 554 <p> Naturally, because of this, you don't want to delete the debug printouts,
 555 but you don't want them to always be noisy.  A standard compromise is to comment
 556 them out, allowing you to enable them if you need them in the future.</p>
 557
 558 <p>The "<tt><a href="/doxygen/Debug_8h-source.html">llvm/Support/Debug.h</a></tt>"
 559 file provides a macro named <tt>DEBUG()</tt> that is a much nicer solution to
 560 this problem.  Basically, you can put arbitrary code into the argument of the
 561 <tt>DEBUG</tt> macro, and it is only executed if '<tt>opt</tt>' (or any other
 562 tool) is run with the '<tt>-debug</tt>' command line argument:</p>
 563
 564 <div class="doc_code">
 565 <pre>
 566 DEBUG(errs() &lt;&lt; "I am here!\n");
 567 </pre>
 568 </div>
 569
 570 <p>Then you can run your pass like this:</p>
 571
 572 <div class="doc_code">
 573 <pre>
 574 $ opt &lt; a.bc &gt; /dev/null -mypass
 575 <i>&lt;no output&gt;</i>
 576 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 577 I am here!
 578 </pre>
 579 </div>
 580
 581 <p>Using the <tt>DEBUG()</tt> macro instead of a home-brewed solution allows you
 582 to not have to create "yet another" command line option for the debug output for
 583 your pass.  Note that <tt>DEBUG()</tt> macros are disabled for optimized builds,
 584 so they do not cause a performance impact at all (for the same reason, they
 585 should also not contain side-effects!).</p>
 586
 587 <p>One additional nice thing about the <tt>DEBUG()</tt> macro is that you can
 588 enable or disable it directly in gdb.  Just use "<tt>set DebugFlag=0</tt>" or
 589 "<tt>set DebugFlag=1</tt>" from the gdb if the program is running.  If the
 590 program hasn't been started yet, you can always just run it with
 591 <tt>-debug</tt>.</p>
 592
 593 </div>
 594
 595 <!-- _______________________________________________________________________ -->
 596 <div class="doc_subsubsection">
 597   <a name="DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> and
 598   the <tt>-debug-only</tt> option</a>
 599 </div>
 600
 601 <div class="doc_text">
 602
 603 <p>Sometimes you may find yourself in a situation where enabling <tt>-debug</tt>
 604 just turns on <b>too much</b> information (such as when working on the code
 605 generator).  If you want to enable debug information with more fine-grained
 606 control, you define the <tt>DEBUG_TYPE</tt> macro and the <tt>-debug</tt> only
 607 option as follows:</p>
 608
 609 <div class="doc_code">
 610 <pre>
 611 #undef  DEBUG_TYPE
 612 DEBUG(errs() &lt;&lt; "No debug type\n");
 613 #define DEBUG_TYPE "foo"
 614 DEBUG(errs() &lt;&lt; "'foo' debug type\n");
 615 #undef  DEBUG_TYPE
 616 #define DEBUG_TYPE "bar"
 617 DEBUG(errs() &lt;&lt; "'bar' debug type\n"));
 618 #undef  DEBUG_TYPE
 619 #define DEBUG_TYPE ""
 620 DEBUG(errs() &lt;&lt; "No debug type (2)\n");
 621 </pre>
 622 </div>
 623
 624 <p>Then you can run your pass like this:</p>
 625
 626 <div class="doc_code">
 627 <pre>
 628 $ opt &lt; a.bc &gt; /dev/null -mypass
 629 <i>&lt;no output&gt;</i>
 630 $ opt &lt; a.bc &gt; /dev/null -mypass -debug
 631 No debug type
 632 'foo' debug type
 633 'bar' debug type
 634 No debug type (2)
 635 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=foo
 636 'foo' debug type
 637 $ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=bar
 638 'bar' debug type
 639 </pre>
 640 </div>
 641
 642 <p>Of course, in practice, you should only set <tt>DEBUG_TYPE</tt> at the top of
 643 a file, to specify the debug type for the entire module (if you do this before
 644 you <tt>#include "llvm/Support/Debug.h"</tt>, you don't have to insert the ugly
 645 <tt>#undef</tt>'s).  Also, you should use names more meaningful than "foo" and
 646 "bar", because there is no system in place to ensure that names do not
 647 conflict. If two different modules use the same string, they will all be turned
 648 on when the name is specified. This allows, for example, all debug information
 649 for instruction scheduling to be enabled with <tt>-debug-type=InstrSched</tt>,
 650 even if the source lives in multiple files.</p>
 651
 652 <p>The <tt>DEBUG_WITH_TYPE</tt> macro is also available for situations where you
 653 would like to set <tt>DEBUG_TYPE</tt>, but only for one specific <tt>DEBUG</tt>
 654 statement. It takes an additional first parameter, which is the type to use. For
 655 example, the preceding example could be written as:</p>
 656
 657
 658 <div class="doc_code">
 659 <pre>
 660 DEBUG_WITH_TYPE("", errs() &lt;&lt; "No debug type\n");
 661 DEBUG_WITH_TYPE("foo", errs() &lt;&lt; "'foo' debug type\n");
 662 DEBUG_WITH_TYPE("bar", errs() &lt;&lt; "'bar' debug type\n"));
 663 DEBUG_WITH_TYPE("", errs() &lt;&lt; "No debug type (2)\n");
 664 </pre>
 665 </div>
 666
 667 </div>
 668
 669 <!-- ======================================================================= -->
 670 <div class="doc_subsection">
 671   <a name="Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
 672   option</a>
 673 </div>
 674
 675 <div class="doc_text">
 676
 677 <p>The "<tt><a
 678 href="/doxygen/Statistic_8h-source.html">llvm/ADT/Statistic.h</a></tt>" file
 679 provides a class named <tt>Statistic</tt> that is used as a unified way to
 680 keep track of what the LLVM compiler is doing and how effective various
 681 optimizations are.  It is useful to see what optimizations are contributing to
 682 making a particular program run faster.</p>
 683
 684 <p>Often you may run your pass on some big program, and you're interested to see
 685 how many times it makes a certain transformation.  Although you can do this with
 686 hand inspection, or some ad-hoc method, this is a real pain and not very useful
 687 for big programs.  Using the <tt>Statistic</tt> class makes it very easy to
 688 keep track of this information, and the calculated information is presented in a
 689 uniform manner with the rest of the passes being executed.</p>
 690
 691 <p>There are many examples of <tt>Statistic</tt> uses, but the basics of using
 692 it are as follows:</p>
 693
 694 <ol>
 695     <li><p>Define your statistic like this:</p>
 696
 697 <div class="doc_code">
 698 <pre>
 699 #define <a href="#DEBUG_TYPE">DEBUG_TYPE</a> "mypassname"   <i>// This goes before any #includes.</i>
 700 STATISTIC(NumXForms, "The # of times I did stuff");
 701 </pre>
 702 </div>
 703
 704   <p>The <tt>STATISTIC</tt> macro defines a static variable, whose name is
 705     specified by the first argument.  The pass name is taken from the DEBUG_TYPE
 706     macro, and the description is taken from the second argument.  The variable
 707     defined ("NumXForms" in this case) acts like an unsigned integer.</p></li>
 708
 709     <li><p>Whenever you make a transformation, bump the counter:</p>
 710
 711 <div class="doc_code">
 712 <pre>
 713 ++NumXForms;   // <i>I did stuff!</i>
 714 </pre>
 715 </div>
 716
 717     </li>
 718   </ol>
 719
 720   <p>That's all you have to do.  To get '<tt>opt</tt>' to print out the
 721   statistics gathered, use the '<tt>-stats</tt>' option:</p>
 722
 723 <div class="doc_code">
 724 <pre>
 725 $ opt -stats -mypassname &lt; program.bc &gt; /dev/null
 726 <i>... statistics output ...</i>
 727 </pre>
 728 </div>
 729
 730   <p> When running <tt>opt</tt> on a C file from the SPEC benchmark
 731 suite, it gives a report that looks like this:</p>
 732
 733 <div class="doc_code">
 734 <pre>
 735    7646 bitcodewriter   - Number of normal instructions
 736     725 bitcodewriter   - Number of oversized instructions
 737  129996 bitcodewriter   - Number of bitcode bytes written
 738    2817 raise           - Number of insts DCEd or constprop'd
 739    3213 raise           - Number of cast-of-self removed
 740    5046 raise           - Number of expression trees converted
 741      75 raise           - Number of other getelementptr's formed
 742     138 raise           - Number of load/store peepholes
 743      42 deadtypeelim    - Number of unused typenames removed from symtab
 744     392 funcresolve     - Number of varargs functions resolved
 745      27 globaldce       - Number of global variables removed
 746       2 adce            - Number of basic blocks removed
 747     134 cee             - Number of branches revectored
 748      49 cee             - Number of setcc instruction eliminated
 749     532 gcse            - Number of loads removed
 750    2919 gcse            - Number of instructions removed
 751      86 indvars         - Number of canonical indvars added
 752      87 indvars         - Number of aux indvars removed
 753      25 instcombine     - Number of dead inst eliminate
 754     434 instcombine     - Number of insts combined
 755     248 licm            - Number of load insts hoisted
 756    1298 licm            - Number of insts hoisted to a loop pre-header
 757       3 licm            - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
 758      75 mem2reg         - Number of alloca's promoted
 759    1444 cfgsimplify     - Number of blocks simplified
 760 </pre>
 761 </div>
 762
 763 <p>Obviously, with so many optimizations, having a unified framework for this
 764 stuff is very nice.  Making your pass fit well into the framework makes it more
 765 maintainable and useful.</p>
 766
 767 </div>
 768
 769 <!-- ======================================================================= -->
 770 <div class="doc_subsection">
 771   <a name="ViewGraph">Viewing graphs while debugging code</a>
 772 </div>
 773
 774 <div class="doc_text">
 775
 776 <p>Several of the important data structures in LLVM are graphs: for example
 777 CFGs made out of LLVM <a href="#BasicBlock">BasicBlock</a>s, CFGs made out of
 778 LLVM <a href="CodeGenerator.html#machinebasicblock">MachineBasicBlock</a>s, and
 779 <a href="CodeGenerator.html#selectiondag_intro">Instruction Selection
 780 DAGs</a>.  In many cases, while debugging various parts of the compiler, it is
 781 nice to instantly visualize these graphs.</p>
 782
 783 <p>LLVM provides several callbacks that are available in a debug build to do
 784 exactly that.  If you call the <tt>Function::viewCFG()</tt> method, for example,
 785 the current LLVM tool will pop up a window containing the CFG for the function
 786 where each basic block is a node in the graph, and each node contains the
 787 instructions in the block.  Similarly, there also exists
 788 <tt>Function::viewCFGOnly()</tt> (does not include the instructions), the
 789 <tt>MachineFunction::viewCFG()</tt> and <tt>MachineFunction::viewCFGOnly()</tt>,
 790 and the <tt>SelectionDAG::viewGraph()</tt> methods.  Within GDB, for example,
 791 you can usually use something like <tt>call DAG.viewGraph()</tt> to pop
 792 up a window.  Alternatively, you can sprinkle calls to these functions in your
 793 code in places you want to debug.</p>
 794
 795 <p>Getting this to work requires a small amount of configuration.  On Unix
 796 systems with X11, install the <a href="http://www.graphviz.org">graphviz</a>
 797 toolkit, and make sure 'dot' and 'gv' are in your path.  If you are running on
 798 Mac OS/X, download and install the Mac OS/X <a
 799 href="http://www.pixelglow.com/graphviz/">Graphviz program</a>, and add
 800 <tt>/Applications/Graphviz.app/Contents/MacOS/</tt> (or wherever you install
 801 it) to your path.  Once in your system and path are set up, rerun the LLVM
 802 configure script and rebuild LLVM to enable this functionality.</p>
 803
 804 <p><tt>SelectionDAG</tt> has been extended to make it easier to locate
 805 <i>interesting</i> nodes in large complex graphs.  From gdb, if you
 806 <tt>call DAG.setGraphColor(<i>node</i>, "<i>color</i>")</tt>, then the
 807 next <tt>call DAG.viewGraph()</tt> would highlight the node in the
 808 specified color (choices of colors can be found at <a
 809 href="http://www.graphviz.org/doc/info/colors.html">colors</a>.) More
 810 complex node attributes can be provided with <tt>call
 811 DAG.setGraphAttrs(<i>node</i>, "<i>attributes</i>")</tt> (choices can be
 812 found at <a href="http://www.graphviz.org/doc/info/attrs.html">Graph
 813 Attributes</a>.)  If you want to restart and clear all the current graph
 814 attributes, then you can <tt>call DAG.clearGraphAttrs()</tt>. </p>
 815
 816 </div>
 817
 818 <!-- *********************************************************************** -->
 819 <div class="doc_section">
 820   <a name="datastructure">Picking the Right Data Structure for a Task</a>
 821 </div>
 822 <!-- *********************************************************************** -->
 823
 824 <div class="doc_text">
 825
 826 <p>LLVM has a plethora of data structures in the <tt>llvm/ADT/</tt> directory,
 827  and we commonly use STL data structures.  This section describes the trade-offs
 828  you should consider when you pick one.</p>
 829
 830 <p>
 831 The first step is a choose your own adventure: do you want a sequential
 832 container, a set-like container, or a map-like container?  The most important
 833 thing when choosing a container is the algorithmic properties of how you plan to
 834 access the container.  Based on that, you should use:</p>
 835
 836 <ul>
 837 <li>a <a href="#ds_map">map-like</a> container if you need efficient look-up
 838     of an value based on another value.  Map-like containers also support
 839     efficient queries for containment (whether a key is in the map).  Map-like
 840     containers generally do not support efficient reverse mapping (values to
 841     keys).  If you need that, use two maps.  Some map-like containers also
 842     support efficient iteration through the keys in sorted order.  Map-like
 843     containers are the most expensive sort, only use them if you need one of
 844     these capabilities.</li>
 845
 846 <li>a <a href="#ds_set">set-like</a> container if you need to put a bunch of
 847     stuff into a container that automatically eliminates duplicates.  Some
 848     set-like containers support efficient iteration through the elements in
 849     sorted order.  Set-like containers are more expensive than sequential
 850     containers.
 851 </li>
 852
 853 <li>a <a href="#ds_sequential">sequential</a> container provides
 854     the most efficient way to add elements and keeps track of the order they are
 855     added to the collection.  They permit duplicates and support efficient
 856     iteration, but do not support efficient look-up based on a key.
 857 </li>
 858
 859 <li>a <a href="#ds_string">string</a> container is a specialized sequential
 860     container or reference structure that is used for character or byte
 861     arrays.</li>
 862
 863 <li>a <a href="#ds_bit">bit</a> container provides an efficient way to store and
 864     perform set operations on sets of numeric id's, while automatically
 865     eliminating duplicates.  Bit containers require a maximum of 1 bit for each
 866     identifier you want to store.
 867 </li>
 868 </ul>
 869
 870 <p>
 871 Once the proper category of container is determined, you can fine tune the
 872 memory use, constant factors, and cache behaviors of access by intelligently
 873 picking a member of the category.  Note that constant factors and cache behavior
 874 can be a big deal.  If you have a vector that usually only contains a few
 875 elements (but could contain many), for example, it's much better to use
 876 <a href="#dss_smallvector">SmallVector</a> than <a href="#dss_vector">vector</a>
 877 .  Doing so avoids (relatively) expensive malloc/free calls, which dwarf the
 878 cost of adding the elements to the container. </p>
 879
 880 </div>
 881
 882 <!-- ======================================================================= -->
 883 <div class="doc_subsection">
 884   <a name="ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
 885 </div>
 886
 887 <div class="doc_text">
 888 There are a variety of sequential containers available for you, based on your
 889 needs.  Pick the first in this section that will do what you want.
 890 </div>
 891
 892 <!-- _______________________________________________________________________ -->
 893 <div class="doc_subsubsection">
 894   <a name="dss_fixedarrays">Fixed Size Arrays</a>
 895 </div>
 896
 897 <div class="doc_text">
 898 <p>Fixed size arrays are very simple and very fast.  They are good if you know
 899 exactly how many elements you have, or you have a (low) upper bound on how many
 900 you have.</p>
 901 </div>
 902
 903 <!-- _______________________________________________________________________ -->
 904 <div class="doc_subsubsection">
 905   <a name="dss_heaparrays">Heap Allocated Arrays</a>
 906 </div>
 907
 908 <div class="doc_text">
 909 <p>Heap allocated arrays (new[] + delete[]) are also simple.  They are good if
 910 the number of elements is variable, if you know how many elements you will need
 911 before the array is allocated, and if the array is usually large (if not,
 912 consider a <a href="#dss_smallvector">SmallVector</a>).  The cost of a heap
 913 allocated array is the cost of the new/delete (aka malloc/free).  Also note that
 914 if you are allocating an array of a type with a constructor, the constructor and
 915 destructors will be run for every element in the array (re-sizable vectors only
 916 construct those elements actually used).</p>
 917 </div>
 918
 919 <!-- _______________________________________________________________________ -->
 920 <div class="doc_subsubsection">
 921   <a name="dss_smallvector">"llvm/ADT/SmallVector.h"</a>
 922 </div>
 923
 924 <div class="doc_text">
 925 <p><tt>SmallVector&lt;Type, N&gt;</tt> is a simple class that looks and smells
 926 just like <tt>vector&lt;Type&gt;</tt>:
 927 it supports efficient iteration, lays out elements in memory order (so you can
 928 do pointer arithmetic between elements), supports efficient push_back/pop_back
 929 operations, supports efficient random access to its elements, etc.</p>
 930
 931 <p>The advantage of SmallVector is that it allocates space for
 932 some number of elements (N) <b>in the object itself</b>.  Because of this, if
 933 the SmallVector is dynamically smaller than N, no malloc is performed.  This can
 934 be a big win in cases where the malloc/free call is far more expensive than the
 935 code that fiddles around with the elements.</p>
 936
 937 <p>This is good for vectors that are "usually small" (e.g. the number of
 938 predecessors/successors of a block is usually less than 8).  On the other hand,
 939 this makes the size of the SmallVector itself large, so you don't want to
 940 allocate lots of them (doing so will waste a lot of space).  As such,
 941 SmallVectors are most useful when on the stack.</p>
 942
 943 <p>SmallVector also provides a nice portable and efficient replacement for
 944 <tt>alloca</tt>.</p>
 945
 946 </div>
 947
 948 <!-- _______________________________________________________________________ -->
 949 <div class="doc_subsubsection">
 950   <a name="dss_vector">&lt;vector&gt;</a>
 951 </div>
 952
 953 <div class="doc_text">
 954 <p>
 955 std::vector is well loved and respected.  It is useful when SmallVector isn't:
 956 when the size of the vector is often large (thus the small optimization will
 957 rarely be a benefit) or if you will be allocating many instances of the vector
 958 itself (which would waste space for elements that aren't in the container).
 959 vector is also useful when interfacing with code that expects vectors :).
 960 </p>
 961
 962 <p>One worthwhile note about std::vector: avoid code like this:</p>
 963
 964 <div class="doc_code">
 965 <pre>
 966 for ( ... ) {
 967    std::vector&lt;foo&gt; V;
 968    use V;
 969 }
 970 </pre>
 971 </div>
 972
 973 <p>Instead, write this as:</p>
 974
 975 <div class="doc_code">
 976 <pre>
 977 std::vector&lt;foo&gt; V;
 978 for ( ... ) {
 979    use V;
 980    V.clear();
 981 }
 982 </pre>
 983 </div>
 984
 985 <p>Doing so will save (at least) one heap allocation and free per iteration of
 986 the loop.</p>
 987
 988 </div>
 989
 990 <!-- _______________________________________________________________________ -->
 991 <div class="doc_subsubsection">
 992   <a name="dss_deque">&lt;deque&gt;</a>
 993 </div>
 994
 995 <div class="doc_text">
 996 <p>std::deque is, in some senses, a generalized version of std::vector.  Like
 997 std::vector, it provides constant time random access and other similar
 998 properties, but it also provides efficient access to the front of the list.  It
 999 does not guarantee continuity of elements within memory.</p>
1000
1001 <p>In exchange for this extra flexibility, std::deque has significantly higher
1002 constant factor costs than std::vector.  If possible, use std::vector or
1003 something cheaper.</p>
1004 </div>
1005
1006 <!-- _______________________________________________________________________ -->
1007 <div class="doc_subsubsection">
1008   <a name="dss_list">&lt;list&gt;</a>
1009 </div>
1010
1011 <div class="doc_text">
1012 <p>std::list is an extremely inefficient class that is rarely useful.
1013 It performs a heap allocation for every element inserted into it, thus having an
1014 extremely high constant factor, particularly for small data types.  std::list
1015 also only supports bidirectional iteration, not random access iteration.</p>
1016
1017 <p>In exchange for this high cost, std::list supports efficient access to both
1018 ends of the list (like std::deque, but unlike std::vector or SmallVector).  In
1019 addition, the iterator invalidation characteristics of std::list are stronger
1020 than that of a vector class: inserting or removing an element into the list does
1021 not invalidate iterator or pointers to other elements in the list.</p>
1022 </div>
1023
1024 <!-- _______________________________________________________________________ -->
1025 <div class="doc_subsubsection">
1026   <a name="dss_ilist">llvm/ADT/ilist.h</a>
1027 </div>
1028
1029 <div class="doc_text">
1030 <p><tt>ilist&lt;T&gt;</tt> implements an 'intrusive' doubly-linked list.  It is
1031 intrusive, because it requires the element to store and provide access to the
1032 prev/next pointers for the list.</p>
1033
1034 <p><tt>ilist</tt> has the same drawbacks as <tt>std::list</tt>, and additionally
1035 requires an <tt>ilist_traits</tt> implementation for the element type, but it
1036 provides some novel characteristics.  In particular, it can efficiently store
1037 polymorphic objects, the traits class is informed when an element is inserted or
1038 removed from the list, and <tt>ilist</tt>s are guaranteed to support a
1039 constant-time splice operation.</p>
1040
1041 <p>These properties are exactly what we want for things like
1042 <tt>Instruction</tt>s and basic blocks, which is why these are implemented with
1043 <tt>ilist</tt>s.</p>
1044
1045 Related classes of interest are explained in the following subsections:
1046     <ul>
1047       <li><a href="#dss_ilist_traits">ilist_traits</a></li>
1048       <li><a href="#dss_iplist">iplist</a></li>
1049       <li><a href="#dss_ilist_node">llvm/ADT/ilist_node.h</a></li>
1050       <li><a href="#dss_ilist_sentinel">Sentinels</a></li>
1051     </ul>
1052 </div>
1053
1054 <!-- _______________________________________________________________________ -->
1055 <div class="doc_subsubsection">
1056   <a name="dss_ilist_traits">ilist_traits</a>
1057 </div>
1058
1059 <div class="doc_text">
1060 <p><tt>ilist_traits&lt;T&gt;</tt> is <tt>ilist&lt;T&gt;</tt>'s customization
1061 mechanism. <tt>iplist&lt;T&gt;</tt> (and consequently <tt>ilist&lt;T&gt;</tt>)
1062 publicly derive from this traits class.</p>
1063 </div>
1064
1065 <!-- _______________________________________________________________________ -->
1066 <div class="doc_subsubsection">
1067   <a name="dss_iplist">iplist</a>
1068 </div>
1069
1070 <div class="doc_text">
1071 <p><tt>iplist&lt;T&gt;</tt> is <tt>ilist&lt;T&gt;</tt>'s base and as such
1072 supports a slightly narrower interface. Notably, inserters from
1073 <tt>T&amp;</tt> are absent.</p>
1074
1075 <p><tt>ilist_traits&lt;T&gt;</tt> is a public base of this class and can be
1076 used for a wide variety of customizations.</p>
1077 </div>
1078
1079 <!-- _______________________________________________________________________ -->
1080 <div class="doc_subsubsection">
1081   <a name="dss_ilist_node">llvm/ADT/ilist_node.h</a>
1082 </div>
1083
1084 <div class="doc_text">
1085 <p><tt>ilist_node&lt;T&gt;</tt> implements a the forward and backward links
1086 that are expected by the <tt>ilist&lt;T&gt;</tt> (and analogous containers)
1087 in the default manner.</p>
1088
1089 <p><tt>ilist_node&lt;T&gt;</tt>s are meant to be embedded in the node type
1090 <tt>T</tt>, usually <tt>T</tt> publicly derives from
1091 <tt>ilist_node&lt;T&gt;</tt>.</p>
1092 </div>
1093
1094 <!-- _______________________________________________________________________ -->
1095 <div class="doc_subsubsection">
1096   <a name="dss_ilist_sentinel">Sentinels</a>
1097 </div>
1098
1099 <div class="doc_text">
1100 <p><tt>ilist</tt>s have another specialty that must be considered. To be a good
1101 citizen in the C++ ecosystem, it needs to support the standard container
1102 operations, such as <tt>begin</tt> and <tt>end</tt> iterators, etc. Also, the
1103 <tt>operator--</tt> must work correctly on the <tt>end</tt> iterator in the
1104 case of non-empty <tt>ilist</tt>s.</p>
1105
1106 <p>The only sensible solution to this problem is to allocate a so-called
1107 <i>sentinel</i> along with the intrusive list, which serves as the <tt>end</tt>
1108 iterator, providing the back-link to the last element. However conforming to the
1109 C++ convention it is illegal to <tt>operator++</tt> beyond the sentinel and it
1110 also must not be dereferenced.</p>
1111
1112 <p>These constraints allow for some implementation freedom to the <tt>ilist</tt>
1113 how to allocate and store the sentinel. The corresponding policy is dictated
1114 by <tt>ilist_traits&lt;T&gt;</tt>. By default a <tt>T</tt> gets heap-allocated
1115 whenever the need for a sentinel arises.</p>
1116
1117 <p>While the default policy is sufficient in most cases, it may break down when
1118 <tt>T</tt> does not provide a default constructor. Also, in the case of many
1119 instances of <tt>ilist</tt>s, the memory overhead of the associated sentinels
1120 is wasted. To alleviate the situation with numerous and voluminous
1121 <tt>T</tt>-sentinels, sometimes a trick is employed, leading to <i>ghostly
1122 sentinels</i>.</p>
1123
1124 <p>Ghostly sentinels are obtained by specially-crafted <tt>ilist_traits&lt;T&gt;</tt>
1125 which superpose the sentinel with the <tt>ilist</tt> instance in memory. Pointer
1126 arithmetic is used to obtain the sentinel, which is relative to the
1127 <tt>ilist</tt>'s <tt>this</tt> pointer. The <tt>ilist</tt> is augmented by an
1128 extra pointer, which serves as the back-link of the sentinel. This is the only
1129 field in the ghostly sentinel which can be legally accessed.</p>
1130 </div>
1131
1132 <!-- _______________________________________________________________________ -->
1133 <div class="doc_subsubsection">
1134   <a name="dss_other">Other Sequential Container options</a>
1135 </div>
1136
1137 <div class="doc_text">
1138 <p>Other STL containers are available, such as std::string.</p>
1139
1140 <p>There are also various STL adapter classes such as std::queue,
1141 std::priority_queue, std::stack, etc.  These provide simplified access to an
1142 underlying container but don't affect the cost of the container itself.</p>
1143
1144 </div>
1145
1146
1147 <!-- ======================================================================= -->
1148 <div class="doc_subsection">
1149   <a name="ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
1150 </div>
1151
1152 <div class="doc_text">
1153
1154 <p>Set-like containers are useful when you need to canonicalize multiple values
1155 into a single representation.  There are several different choices for how to do
1156 this, providing various trade-offs.</p>
1157
1158 </div>
1159
1160
1161 <!-- _______________________________________________________________________ -->
1162 <div class="doc_subsubsection">
1163   <a name="dss_sortedvectorset">A sorted 'vector'</a>
1164 </div>
1165
1166 <div class="doc_text">
1167
1168 <p>If you intend to insert a lot of elements, then do a lot of queries, a
1169 great approach is to use a vector (or other sequential container) with
1170 std::sort+std::unique to remove duplicates.  This approach works really well if
1171 your usage pattern has these two distinct phases (insert then query), and can be
1172 coupled with a good choice of <a href="#ds_sequential">sequential container</a>.
1173 </p>
1174
1175 <p>
1176 This combination provides the several nice properties: the result data is
1177 contiguous in memory (good for cache locality), has few allocations, is easy to
1178 address (iterators in the final vector are just indices or pointers), and can be
1179 efficiently queried with a standard binary or radix search.</p>
1180
1181 </div>
1182
1183 <!-- _______________________________________________________________________ -->
1184 <div class="doc_subsubsection">
1185   <a name="dss_smallset">"llvm/ADT/SmallSet.h"</a>
1186 </div>
1187
1188 <div class="doc_text">
1189
1190 <p>If you have a set-like data structure that is usually small and whose elements
1191 are reasonably small, a <tt>SmallSet&lt;Type, N&gt;</tt> is a good choice.  This set
1192 has space for N elements in place (thus, if the set is dynamically smaller than
1193 N, no malloc traffic is required) and accesses them with a simple linear search.
1194 When the set grows beyond 'N' elements, it allocates a more expensive representation that
1195 guarantees efficient access (for most types, it falls back to std::set, but for
1196 pointers it uses something far better, <a
1197 href="#dss_smallptrset">SmallPtrSet</a>).</p>
1198
1199 <p>The magic of this class is that it handles small sets extremely efficiently,
1200 but gracefully handles extremely large sets without loss of efficiency.  The
1201 drawback is that the interface is quite small: it supports insertion, queries
1202 and erasing, but does not support iteration.</p>
1203
1204 </div>
1205
1206 <!-- _______________________________________________________________________ -->
1207 <div class="doc_subsubsection">
1208   <a name="dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a>
1209 </div>
1210
1211 <div class="doc_text">
1212
1213 <p>SmallPtrSet has all the advantages of <tt>SmallSet</tt> (and a <tt>SmallSet</tt> of pointers is
1214 transparently implemented with a <tt>SmallPtrSet</tt>), but also supports iterators.  If
1215 more than 'N' insertions are performed, a single quadratically
1216 probed hash table is allocated and grows as needed, providing extremely
1217 efficient access (constant time insertion/deleting/queries with low constant
1218 factors) and is very stingy with malloc traffic.</p>
1219
1220 <p>Note that, unlike <tt>std::set</tt>, the iterators of <tt>SmallPtrSet</tt> are invalidated
1221 whenever an insertion occurs.  Also, the values visited by the iterators are not
1222 visited in sorted order.</p>
1223
1224 </div>
1225
1226 <!-- _______________________________________________________________________ -->
1227 <div class="doc_subsubsection">
1228   <a name="dss_denseset">"llvm/ADT/DenseSet.h"</a>
1229 </div>
1230
1231 <div class="doc_text">
1232
1233 <p>
1234 DenseSet is a simple quadratically probed hash table.  It excels at supporting
1235 small values: it uses a single allocation to hold all of the pairs that
1236 are currently inserted in the set.  DenseSet is a great way to unique small
1237 values that are not simple pointers (use <a
1238 href="#dss_smallptrset">SmallPtrSet</a> for pointers).  Note that DenseSet has
1239 the same requirements for the value type that <a
1240 href="#dss_densemap">DenseMap</a> has.
1241 </p>
1242
1243 </div>
1244
1245 <!-- _______________________________________________________________________ -->
1246 <div class="doc_subsubsection">
1247   <a name="dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a>
1248 </div>
1249
1250 <div class="doc_text">
1251
1252 <p>
1253 FoldingSet is an aggregate class that is really good at uniquing
1254 expensive-to-create or polymorphic objects.  It is a combination of a chained
1255 hash table with intrusive links (uniqued objects are required to inherit from
1256 FoldingSetNode) that uses <a href="#dss_smallvector">SmallVector</a> as part of
1257 its ID process.</p>
1258
1259 <p>Consider a case where you want to implement a "getOrCreateFoo" method for
1260 a complex object (for example, a node in the code generator).  The client has a
1261 description of *what* it wants to generate (it knows the opcode and all the
1262 operands), but we don't want to 'new' a node, then try inserting it into a set
1263 only to find out it already exists, at which point we would have to delete it
1264 and return the node that already exists.
1265 </p>
1266
1267 <p>To support this style of client, FoldingSet perform a query with a
1268 FoldingSetNodeID (which wraps SmallVector) that can be used to describe the
1269 element that we want to query for.  The query either returns the element
1270 matching the ID or it returns an opaque ID that indicates where insertion should
1271 take place.  Construction of the ID usually does not require heap traffic.</p>
1272
1273 <p>Because FoldingSet uses intrusive links, it can support polymorphic objects
1274 in the set (for example, you can have SDNode instances mixed with LoadSDNodes).
1275 Because the elements are individually allocated, pointers to the elements are
1276 stable: inserting or removing elements does not invalidate any pointers to other
1277 elements.
1278 </p>
1279
1280 </div>
1281
1282 <!-- _______________________________________________________________________ -->
1283 <div class="doc_subsubsection">
1284   <a name="dss_set">&lt;set&gt;</a>
1285 </div>
1286
1287 <div class="doc_text">
1288
1289 <p><tt>std::set</tt> is a reasonable all-around set class, which is decent at
1290 many things but great at nothing.  std::set allocates memory for each element
1291 inserted (thus it is very malloc intensive) and typically stores three pointers
1292 per element in the set (thus adding a large amount of per-element space
1293 overhead).  It offers guaranteed log(n) performance, which is not particularly
1294 fast from a complexity standpoint (particularly if the elements of the set are
1295 expensive to compare, like strings), and has extremely high constant factors for
1296 lookup, insertion and removal.</p>
1297
1298 <p>The advantages of std::set are that its iterators are stable (deleting or
1299 inserting an element from the set does not affect iterators or pointers to other
1300 elements) and that iteration over the set is guaranteed to be in sorted order.
1301 If the elements in the set are large, then the relative overhead of the pointers
1302 and malloc traffic is not a big deal, but if the elements of the set are small,
1303 std::set is almost never a good choice.</p>
1304
1305 </div>
1306
1307 <!-- _______________________________________________________________________ -->
1308 <div class="doc_subsubsection">
1309   <a name="dss_setvector">"llvm/ADT/SetVector.h"</a>
1310 </div>
1311
1312 <div class="doc_text">
1313 <p>LLVM's SetVector&lt;Type&gt; is an adapter class that combines your choice of
1314 a set-like container along with a <a href="#ds_sequential">Sequential
1315 Container</a>.  The important property
1316 that this provides is efficient insertion with uniquing (duplicate elements are
1317 ignored) with iteration support.  It implements this by inserting elements into
1318 both a set-like container and the sequential container, using the set-like
1319 container for uniquing and the sequential container for iteration.
1320 </p>
1321
1322 <p>The difference between SetVector and other sets is that the order of
1323 iteration is guaranteed to match the order of insertion into the SetVector.
1324 This property is really important for things like sets of pointers.  Because
1325 pointer values are non-deterministic (e.g. vary across runs of the program on
1326 different machines), iterating over the pointers in the set will
1327 not be in a well-defined order.</p>
1328
1329 <p>
1330 The drawback of SetVector is that it requires twice as much space as a normal
1331 set and has the sum of constant factors from the set-like container and the
1332 sequential container that it uses.  Use it *only* if you need to iterate over
1333 the elements in a deterministic order.  SetVector is also expensive to delete
1334 elements out of (linear time), unless you use it's "pop_back" method, which is
1335 faster.
1336 </p>
1337
1338 <p>SetVector is an adapter class that defaults to using std::vector and std::set
1339 for the underlying containers, so it is quite expensive.  However,
1340 <tt>"llvm/ADT/SetVector.h"</tt> also provides a SmallSetVector class, which
1341 defaults to using a SmallVector and SmallSet of a specified size.  If you use
1342 this, and if your sets are dynamically smaller than N, you will save a lot of
1343 heap traffic.</p>
1344
1345 </div>
1346
1347 <!-- _______________________________________________________________________ -->
1348 <div class="doc_subsubsection">
1349   <a name="dss_uniquevector">"llvm/ADT/UniqueVector.h"</a>
1350 </div>
1351
1352 <div class="doc_text">
1353
1354 <p>
1355 UniqueVector is similar to <a href="#dss_setvector">SetVector</a>, but it
1356 retains a unique ID for each element inserted into the set.  It internally
1357 contains a map and a vector, and it assigns a unique ID for each value inserted
1358 into the set.</p>
1359
1360 <p>UniqueVector is very expensive: its cost is the sum of the cost of
1361 maintaining both the map and vector, it has high complexity, high constant
1362 factors, and produces a lot of malloc traffic.  It should be avoided.</p>
1363
1364 </div>
1365
1366
1367 <!-- _______________________________________________________________________ -->
1368 <div class="doc_subsubsection">
1369   <a name="dss_otherset">Other Set-Like Container Options</a>
1370 </div>
1371
1372 <div class="doc_text">
1373
1374 <p>
1375 The STL provides several other options, such as std::multiset and the various
1376 "hash_set" like containers (whether from C++ TR1 or from the SGI library). We
1377 never use hash_set and unordered_set because they are generally very expensive
1378 (each insertion requires a malloc) and very non-portable.
1379 </p>
1380
1381 <p>std::multiset is useful if you're not interested in elimination of
1382 duplicates, but has all the drawbacks of std::set.  A sorted vector (where you
1383 don't delete duplicate entries) or some other approach is almost always
1384 better.</p>
1385
1386 </div>
1387
1388 <!-- ======================================================================= -->
1389 <div class="doc_subsection">
1390   <a name="ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
1391 </div>
1392
1393 <div class="doc_text">
1394 Map-like containers are useful when you want to associate data to a key.  As
1395 usual, there are a lot of different ways to do this. :)
1396 </div>
1397
1398 <!-- _______________________________________________________________________ -->
1399 <div class="doc_subsubsection">
1400   <a name="dss_sortedvectormap">A sorted 'vector'</a>
1401 </div>
1402
1403 <div class="doc_text">
1404
1405 <p>
1406 If your usage pattern follows a strict insert-then-query approach, you can
1407 trivially use the same approach as <a href="#dss_sortedvectorset">sorted vectors
1408 for set-like containers</a>.  The only difference is that your query function
1409 (which uses std::lower_bound to get efficient log(n) lookup) should only compare
1410 the key, not both the key and value.  This yields the same advantages as sorted
1411 vectors for sets.
1412 </p>
1413 </div>
1414
1415 <!-- _______________________________________________________________________ -->
1416 <div class="doc_subsubsection">
1417   <a name="dss_stringmap">"llvm/ADT/StringMap.h"</a>
1418 </div>
1419
1420 <div class="doc_text">
1421
1422 <p>
1423 Strings are commonly used as keys in maps, and they are difficult to support
1424 efficiently: they are variable length, inefficient to hash and compare when
1425 long, expensive to copy, etc.  StringMap is a specialized container designed to
1426 cope with these issues.  It supports mapping an arbitrary range of bytes to an
1427 arbitrary other object.</p>
1428
1429 <p>The StringMap implementation uses a quadratically-probed hash table, where
1430 the buckets store a pointer to the heap allocated entries (and some other
1431 stuff).  The entries in the map must be heap allocated because the strings are
1432 variable length.  The string data (key) and the element object (value) are
1433 stored in the same allocation with the string data immediately after the element
1434 object.  This container guarantees the "<tt>(char*)(&amp;Value+1)</tt>" points
1435 to the key string for a value.</p>
1436
1437 <p>The StringMap is very fast for several reasons: quadratic probing is very
1438 cache efficient for lookups, the hash value of strings in buckets is not
1439 recomputed when looking up an element, StringMap rarely has to touch the
1440 memory for unrelated objects when looking up a value (even when hash collisions
1441 happen), hash table growth does not recompute the hash values for strings
1442 already in the table, and each pair in the map is store in a single allocation
1443 (the string data is stored in the same allocation as the Value of a pair).</p>
1444
1445 <p>StringMap also provides query methods that take byte ranges, so it only ever
1446 copies a string if a value is inserted into the table.</p>
1447 </div>
1448
1449 <!-- _______________________________________________________________________ -->
1450 <div class="doc_subsubsection">
1451   <a name="dss_indexedmap">"llvm/ADT/IndexedMap.h"</a>
1452 </div>
1453
1454 <div class="doc_text">
1455 <p>
1456 IndexedMap is a specialized container for mapping small dense integers (or
1457 values that can be mapped to small dense integers) to some other type.  It is
1458 internally implemented as a vector with a mapping function that maps the keys to
1459 the dense integer range.
1460 </p>
1461
1462 <p>
1463 This is useful for cases like virtual registers in the LLVM code generator: they
1464 have a dense mapping that is offset by a compile-time constant (the first
1465 virtual register ID).</p>
1466
1467 </div>
1468
1469 <!-- _______________________________________________________________________ -->
1470 <div class="doc_subsubsection">
1471   <a name="dss_densemap">"llvm/ADT/DenseMap.h"</a>
1472 </div>
1473
1474 <div class="doc_text">
1475
1476 <p>
1477 DenseMap is a simple quadratically probed hash table.  It excels at supporting
1478 small keys and values: it uses a single allocation to hold all of the pairs that
1479 are currently inserted in the map.  DenseMap is a great way to map pointers to
1480 pointers, or map other small types to each other.
1481 </p>
1482
1483 <p>
1484 There are several aspects of DenseMap that you should be aware of, however.  The
1485 iterators in a densemap are invalidated whenever an insertion occurs, unlike
1486 map.  Also, because DenseMap allocates space for a large number of key/value
1487 pairs (it starts with 64 by default), it will waste a lot of space if your keys
1488 or values are large.  Finally, you must implement a partial specialization of
1489 DenseMapInfo for the key that you want, if it isn't already supported.  This
1490 is required to tell DenseMap about two special marker values (which can never be
1491 inserted into the map) that it needs internally.</p>
1492
1493 </div>
1494
1495 <!-- _______________________________________________________________________ -->
1496 <div class="doc_subsubsection">
1497   <a name="dss_valuemap">"llvm/ADT/ValueMap.h"</a>
1498 </div>
1499
1500 <div class="doc_text">
1501
1502 <p>
1503 ValueMap is a wrapper around a <a href="#dss_densemap">DenseMap</a> mapping
1504 Value*s (or subclasses) to another type.  When a Value is deleted or RAUW'ed,
1505 ValueMap will update itself so the new version of the key is mapped to the same
1506 value, just as if the key were a WeakVH.  You can configure exactly how this
1507 happens, and what else happens on these two events, by passing
1508 a <code>Config</code> parameter to the ValueMap template.</p>
1509
1510 </div>
1511
1512 <!-- _______________________________________________________________________ -->
1513 <div class="doc_subsubsection">
1514   <a name="dss_intervalmap">"llvm/ADT/IntervalMap.h"</a>
1515 </div>
1516
1517 <div class="doc_text">
1518
1519 <p> IntervalMap is a compact map for small keys and values. It maps key
1520 intervals instead of single keys, and it will automatically coalesce adjacent
1521 intervals. When then map only contains a few intervals, they are stored in the
1522 map object itself to avoid allocations.</p>
1523
1524 <p> The IntervalMap iterators are quite big, so they should not be passed around
1525 as STL iterators. The heavyweight iterators allow a smaller data structure.</p>
1526
1527 </div>
1528
1529 <!-- _______________________________________________________________________ -->
1530 <div class="doc_subsubsection">
1531   <a name="dss_map">&lt;map&gt;</a>
1532 </div>
1533
1534 <div class="doc_text">
1535
1536 <p>
1537 std::map has similar characteristics to <a href="#dss_set">std::set</a>: it uses
1538 a single allocation per pair inserted into the map, it offers log(n) lookup with
1539 an extremely large constant factor, imposes a space penalty of 3 pointers per
1540 pair in the map, etc.</p>
1541
1542 <p>std::map is most useful when your keys or values are very large, if you need
1543 to iterate over the collection in sorted order, or if you need stable iterators
1544 into the map (i.e. they don't get invalidated if an insertion or deletion of
1545 another element takes place).</p>
1546
1547 </div>
1548
1549 <!-- _______________________________________________________________________ -->
1550 <div class="doc_subsubsection">
1551   <a name="dss_inteqclasses">"llvm/ADT/IntEqClasses.h"</a>
1552 </div>
1553
1554 <div class="doc_text">
1555
1556 <p>IntEqClasses provides a compact representation of equivalence classes of
1557 small integers. Initially, each integer in the range 0..n-1 has its own
1558 equivalence class. Classes can be joined by passing two class representatives to
1559 the join(a, b) method. Two integers are in the same class when findLeader()
1560 returns the same representative.</p>
1561
1562 <p>Once all equivalence classes are formed, the map can be compressed so each
1563 integer 0..n-1 maps to an equivalence class number in the range 0..m-1, where m
1564 is the total number of equivalence classes. The map must be uncompressed before
1565 it can be edited again.</p>
1566
1567 </div>
1568
1569 <!-- _______________________________________________________________________ -->
1570 <div class="doc_subsubsection">
1571   <a name="dss_othermap">Other Map-Like Container Options</a>
1572 </div>
1573
1574 <div class="doc_text">
1575
1576 <p>
1577 The STL provides several other options, such as std::multimap and the various
1578 "hash_map" like containers (whether from C++ TR1 or from the SGI library). We
1579 never use hash_set and unordered_set because they are generally very expensive
1580 (each insertion requires a malloc) and very non-portable.</p>
1581
1582 <p>std::multimap is useful if you want to map a key to multiple values, but has
1583 all the drawbacks of std::map.  A sorted vector or some other approach is almost
1584 always better.</p>
1585
1586 </div>
1587
1588 <!-- ======================================================================= -->
1589 <div class="doc_subsection">
1590   <a name="ds_string">String-like containers</a>
1591 </div>
1592
1593 <div class="doc_text">
1594
1595 <p>
1596 TODO: const char* vs stringref vs smallstring vs std::string.  Describe twine,
1597 xref to #string_apis.
1598 </p>
1599
1600 </div>
1601
1602 <!-- ======================================================================= -->
1603 <div class="doc_subsection">
1604   <a name="ds_bit">Bit storage containers (BitVector, SparseBitVector)</a>
1605 </div>
1606
1607 <div class="doc_text">
1608 <p>Unlike the other containers, there are only two bit storage containers, and
1609 choosing when to use each is relatively straightforward.</p>
1610
1611 <p>One additional option is
1612 <tt>std::vector&lt;bool&gt;</tt>: we discourage its use for two reasons 1) the
1613 implementation in many common compilers (e.g. commonly available versions of
1614 GCC) is extremely inefficient and 2) the C++ standards committee is likely to
1615 deprecate this container and/or change it significantly somehow.  In any case,
1616 please don't use it.</p>
1617 </div>
1618
1619 <!-- _______________________________________________________________________ -->
1620 <div class="doc_subsubsection">
1621   <a name="dss_bitvector">BitVector</a>
1622 </div>
1623
1624 <div class="doc_text">
1625 <p> The BitVector container provides a dynamic size set of bits for manipulation.
1626 It supports individual bit setting/testing, as well as set operations.  The set
1627 operations take time O(size of bitvector), but operations are performed one word
1628 at a time, instead of one bit at a time.  This makes the BitVector very fast for
1629 set operations compared to other containers.  Use the BitVector when you expect
1630 the number of set bits to be high (IE a dense set).
1631 </p>
1632 </div>
1633
1634 <!-- _______________________________________________________________________ -->
1635 <div class="doc_subsubsection">
1636   <a name="dss_smallbitvector">SmallBitVector</a>
1637 </div>
1638
1639 <div class="doc_text">
1640 <p> The SmallBitVector container provides the same interface as BitVector, but
1641 it is optimized for the case where only a small number of bits, less than
1642 25 or so, are needed. It also transparently supports larger bit counts, but
1643 slightly less efficiently than a plain BitVector, so SmallBitVector should
1644 only be used when larger counts are rare.
1645 </p>
1646
1647 <p>
1648 At this time, SmallBitVector does not support set operations (and, or, xor),
1649 and its operator[] does not provide an assignable lvalue.
1650 </p>
1651 </div>
1652
1653 <!-- _______________________________________________________________________ -->
1654 <div class="doc_subsubsection">
1655   <a name="dss_sparsebitvector">SparseBitVector</a>
1656 </div>
1657
1658 <div class="doc_text">
1659 <p> The SparseBitVector container is much like BitVector, with one major
1660 difference: Only the bits that are set, are stored.  This makes the
1661 SparseBitVector much more space efficient than BitVector when the set is sparse,
1662 as well as making set operations O(number of set bits) instead of O(size of
1663 universe).  The downside to the SparseBitVector is that setting and testing of random bits is O(N), and on large SparseBitVectors, this can be slower than BitVector. In our implementation, setting or testing bits in sorted order
1664 (either forwards or reverse) is O(1) worst case.  Testing and setting bits within 128 bits (depends on size) of the current bit is also O(1).  As a general statement, testing/setting bits in a SparseBitVector is O(distance away from last set bit).
1665 </p>
1666 </div>
1667
1668 <!-- *********************************************************************** -->
1669 <div class="doc_section">
1670   <a name="common">Helpful Hints for Common Operations</a>
1671 </div>
1672 <!-- *********************************************************************** -->
1673
1674 <div class="doc_text">
1675
1676 <p>This section describes how to perform some very simple transformations of
1677 LLVM code.  This is meant to give examples of common idioms used, showing the
1678 practical side of LLVM transformations.  <p> Because this is a "how-to" section,
1679 you should also read about the main classes that you will be working with.  The
1680 <a href="#coreclasses">Core LLVM Class Hierarchy Reference</a> contains details
1681 and descriptions of the main classes that you should know about.</p>
1682
1683 </div>
1684
1685 <!-- NOTE: this section should be heavy on example code -->
1686 <!-- ======================================================================= -->
1687 <div class="doc_subsection">
1688   <a name="inspection">Basic Inspection and Traversal Routines</a>
1689 </div>
1690
1691 <div class="doc_text">
1692
1693 <p>The LLVM compiler infrastructure have many different data structures that may
1694 be traversed.  Following the example of the C++ standard template library, the
1695 techniques used to traverse these various data structures are all basically the
1696 same.  For a enumerable sequence of values, the <tt>XXXbegin()</tt> function (or
1697 method) returns an iterator to the start of the sequence, the <tt>XXXend()</tt>
1698 function returns an iterator pointing to one past the last valid element of the
1699 sequence, and there is some <tt>XXXiterator</tt> data type that is common
1700 between the two operations.</p>
1701
1702 <p>Because the pattern for iteration is common across many different aspects of
1703 the program representation, the standard template library algorithms may be used
1704 on them, and it is easier to remember how to iterate. First we show a few common
1705 examples of the data structures that need to be traversed.  Other data
1706 structures are traversed in very similar ways.</p>
1707
1708 </div>
1709
1710 <!-- _______________________________________________________________________ -->
1711 <div class="doc_subsubsection">
1712   <a name="iterate_function">Iterating over the </a><a
1713   href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
1714   href="#Function"><tt>Function</tt></a>
1715 </div>
1716
1717 <div class="doc_text">
1718
1719 <p>It's quite common to have a <tt>Function</tt> instance that you'd like to
1720 transform in some way; in particular, you'd like to manipulate its
1721 <tt>BasicBlock</tt>s.  To facilitate this, you'll need to iterate over all of
1722 the <tt>BasicBlock</tt>s that constitute the <tt>Function</tt>. The following is
1723 an example that prints the name of a <tt>BasicBlock</tt> and the number of
1724 <tt>Instruction</tt>s it contains:</p>
1725
1726 <div class="doc_code">
1727 <pre>
1728 // <i>func is a pointer to a Function instance</i>
1729 for (Function::iterator i = func-&gt;begin(), e = func-&gt;end(); i != e; ++i)
1730   // <i>Print out the name of the basic block if it has one, and then the</i>
1731   // <i>number of instructions that it contains</i>
1732   errs() &lt;&lt; "Basic block (name=" &lt;&lt; i-&gt;getName() &lt;&lt; ") has "
1733              &lt;&lt; i-&gt;size() &lt;&lt; " instructions.\n";
1734 </pre>
1735 </div>
1736
1737 <p>Note that i can be used as if it were a pointer for the purposes of
1738 invoking member functions of the <tt>Instruction</tt> class.  This is
1739 because the indirection operator is overloaded for the iterator
1740 classes.  In the above code, the expression <tt>i-&gt;size()</tt> is
1741 exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.</p>
1742
1743 </div>
1744
1745 <!-- _______________________________________________________________________ -->
1746 <div class="doc_subsubsection">
1747   <a name="iterate_basicblock">Iterating over the </a><a
1748   href="#Instruction"><tt>Instruction</tt></a>s in a <a
1749   href="#BasicBlock"><tt>BasicBlock</tt></a>
1750 </div>
1751
1752 <div class="doc_text">
1753
1754 <p>Just like when dealing with <tt>BasicBlock</tt>s in <tt>Function</tt>s, it's
1755 easy to iterate over the individual instructions that make up
1756 <tt>BasicBlock</tt>s. Here's a code snippet that prints out each instruction in
1757 a <tt>BasicBlock</tt>:</p>
1758
1759 <div class="doc_code">
1760 <pre>
1761 // <i>blk is a pointer to a BasicBlock instance</i>
1762 for (BasicBlock::iterator i = blk-&gt;begin(), e = blk-&gt;end(); i != e; ++i)
1763    // <i>The next statement works since operator&lt;&lt;(ostream&amp;,...)</i>
1764    // <i>is overloaded for Instruction&amp;</i>
1765    errs() &lt;&lt; *i &lt;&lt; "\n";
1766 </pre>
1767 </div>
1768
1769 <p>However, this isn't really the best way to print out the contents of a
1770 <tt>BasicBlock</tt>!  Since the ostream operators are overloaded for virtually
1771 anything you'll care about, you could have just invoked the print routine on the
1772 basic block itself: <tt>errs() &lt;&lt; *blk &lt;&lt; "\n";</tt>.</p>
1773
1774 </div>
1775
1776 <!-- _______________________________________________________________________ -->
1777 <div class="doc_subsubsection">
1778   <a name="iterate_institer">Iterating over the </a><a
1779   href="#Instruction"><tt>Instruction</tt></a>s in a <a
1780   href="#Function"><tt>Function</tt></a>
1781 </div>
1782
1783 <div class="doc_text">
1784
1785 <p>If you're finding that you commonly iterate over a <tt>Function</tt>'s
1786 <tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s <tt>Instruction</tt>s,
1787 <tt>InstIterator</tt> should be used instead. You'll need to include <a
1788 href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>,
1789 and then instantiate <tt>InstIterator</tt>s explicitly in your code.  Here's a
1790 small example that shows how to dump all instructions in a function to the standard error stream:<p>
1791
1792 <div class="doc_code">
1793 <pre>
1794 #include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"
1795
1796 // <i>F is a pointer to a Function instance</i>
1797 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
1798   errs() &lt;&lt; *I &lt;&lt; "\n";
1799 </pre>
1800 </div>
1801
1802 <p>Easy, isn't it?  You can also use <tt>InstIterator</tt>s to fill a
1803 work list with its initial contents.  For example, if you wanted to
1804 initialize a work list to contain all instructions in a <tt>Function</tt>
1805 F, all you would need to do is something like:</p>
1806
1807 <div class="doc_code">
1808 <pre>
1809 std::set&lt;Instruction*&gt; worklist;
1810 // or better yet, SmallPtrSet&lt;Instruction*, 64&gt; worklist;
1811
1812 for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
1813    worklist.insert(&amp;*I);
1814 </pre>
1815 </div>
1816
1817 <p>The STL set <tt>worklist</tt> would now contain all instructions in the
1818 <tt>Function</tt> pointed to by F.</p>
1819
1820 </div>
1821
1822 <!-- _______________________________________________________________________ -->
1823 <div class="doc_subsubsection">
1824   <a name="iterate_convert">Turning an iterator into a class pointer (and
1825   vice-versa)</a>
1826 </div>
1827
1828 <div class="doc_text">
1829
1830 <p>Sometimes, it'll be useful to grab a reference (or pointer) to a class
1831 instance when all you've got at hand is an iterator.  Well, extracting
1832 a reference or a pointer from an iterator is very straight-forward.
1833 Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and <tt>j</tt>
1834 is a <tt>BasicBlock::const_iterator</tt>:</p>
1835
1836 <div class="doc_code">
1837 <pre>
1838 Instruction&amp; inst = *i;   // <i>Grab reference to instruction reference</i>
1839 Instruction* pinst = &amp;*i; // <i>Grab pointer to instruction reference</i>
1840 const Instruction&amp; inst = *j;
1841 </pre>
1842 </div>
1843
1844 <p>However, the iterators you'll be working with in the LLVM framework are
1845 special: they will automatically convert to a ptr-to-instance type whenever they
1846 need to.  Instead of dereferencing the iterator and then taking the address of
1847 the result, you can simply assign the iterator to the proper pointer type and
1848 you get the dereference and address-of operation as a result of the assignment
1849 (behind the scenes, this is a result of overloading casting mechanisms).  Thus
1850 the last line of the last example,</p>
1851
1852 <div class="doc_code">
1853 <pre>
1854 Instruction *pinst = &amp;*i;
1855 </pre>
1856 </div>
1857
1858 <p>is semantically equivalent to</p>
1859
1860 <div class="doc_code">
1861 <pre>
1862 Instruction *pinst = i;
1863 </pre>
1864 </div>
1865
1866 <p>It's also possible to turn a class pointer into the corresponding iterator,
1867 and this is a constant time operation (very efficient).  The following code
1868 snippet illustrates use of the conversion constructors provided by LLVM
1869 iterators.  By using these, you can explicitly grab the iterator of something
1870 without actually obtaining it via iteration over some structure:</p>
1871
1872 <div class="doc_code">
1873 <pre>
1874 void printNextInstruction(Instruction* inst) {
1875   BasicBlock::iterator it(inst);
1876   ++it; // <i>After this line, it refers to the instruction after *inst</i>
1877   if (it != inst-&gt;getParent()-&gt;end()) errs() &lt;&lt; *it &lt;&lt; "\n";
1878 }
1879 </pre>
1880 </div>
1881
1882 <p>Unfortunately, these implicit conversions come at a cost; they prevent
1883 these iterators from conforming to standard iterator conventions, and thus
1884 from being usable with standard algorithms and containers. For example, they
1885 prevent the following code, where <tt>B</tt> is a <tt>BasicBlock</tt>,
1886 from compiling:</p>
1887
1888 <div class="doc_code">
1889 <pre>
1890   llvm::SmallVector&lt;llvm::Instruction *, 16&gt;(B-&gt;begin(), B-&gt;end());
1891 </pre>
1892 </div>
1893
1894 <p>Because of this, these implicit conversions may be removed some day,
1895 and <tt>operator*</tt> changed to return a pointer instead of a reference.</p>
1896
1897 </div>
1898
1899 <!--_______________________________________________________________________-->
1900 <div class="doc_subsubsection">
1901   <a name="iterate_complex">Finding call sites: a slightly more complex
1902   example</a>
1903 </div>
1904
1905 <div class="doc_text">
1906
1907 <p>Say that you're writing a FunctionPass and would like to count all the
1908 locations in the entire module (that is, across every <tt>Function</tt>) where a
1909 certain function (i.e., some <tt>Function</tt>*) is already in scope.  As you'll
1910 learn later, you may want to use an <tt>InstVisitor</tt> to accomplish this in a
1911 much more straight-forward manner, but this example will allow us to explore how
1912 you'd do it if you didn't have <tt>InstVisitor</tt> around. In pseudo-code, this
1913 is what we want to do:</p>
1914
1915 <div class="doc_code">
1916 <pre>
1917 initialize callCounter to zero
1918 for each Function f in the Module
1919   for each BasicBlock b in f
1920     for each Instruction i in b
1921       if (i is a CallInst and calls the given function)
1922         increment callCounter
1923 </pre>
1924 </div>
1925
1926 <p>And the actual code is (remember, because we're writing a
1927 <tt>FunctionPass</tt>, our <tt>FunctionPass</tt>-derived class simply has to
1928 override the <tt>runOnFunction</tt> method):</p>
1929
1930 <div class="doc_code">
1931 <pre>
1932 Function* targetFunc = ...;
1933
1934 class OurFunctionPass : public FunctionPass {
1935   public:
1936     OurFunctionPass(): callCounter(0) { }
1937
1938     virtual runOnFunction(Function&amp; F) {
1939       for (Function::iterator b = F.begin(), be = F.end(); b != be; ++b) {
1940         for (BasicBlock::iterator i = b-&gt;begin(), ie = b-&gt;end(); i != ie; ++i) {
1941           if (<a href="#CallInst">CallInst</a>* callInst = <a href="#isa">dyn_cast</a>&lt;<a
1942  href="#CallInst">CallInst</a>&gt;(&amp;*i)) {
1943             // <i>We know we've encountered a call instruction, so we</i>
1944             // <i>need to determine if it's a call to the</i>
1945             // <i>function pointed to by m_func or not.</i>
1946             if (callInst-&gt;getCalledFunction() == targetFunc)
1947               ++callCounter;
1948           }
1949         }
1950       }
1951     }
1952
1953   private:
1954     unsigned callCounter;
1955 };
1956 </pre>
1957 </div>
1958
1959 </div>
1960
1961 <!--_______________________________________________________________________-->
1962 <div class="doc_subsubsection">
1963   <a name="calls_and_invokes">Treating calls and invokes the same way</a>
1964 </div>
1965
1966 <div class="doc_text">
1967
1968 <p>You may have noticed that the previous example was a bit oversimplified in
1969 that it did not deal with call sites generated by 'invoke' instructions. In
1970 this, and in other situations, you may find that you want to treat
1971 <tt>CallInst</tt>s and <tt>InvokeInst</tt>s the same way, even though their
1972 most-specific common base class is <tt>Instruction</tt>, which includes lots of
1973 less closely-related things. For these cases, LLVM provides a handy wrapper
1974 class called <a
1975 href="http://llvm.org/doxygen/classllvm_1_1CallSite.html"><tt>CallSite</tt></a>.
1976 It is essentially a wrapper around an <tt>Instruction</tt> pointer, with some
1977 methods that provide functionality common to <tt>CallInst</tt>s and
1978 <tt>InvokeInst</tt>s.</p>
1979
1980 <p>This class has "value semantics": it should be passed by value, not by
1981 reference and it should not be dynamically allocated or deallocated using
1982 <tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently copyable,
1983 assignable and constructable, with costs equivalents to that of a bare pointer.
1984 If you look at its definition, it has only a single pointer member.</p>
1985
1986 </div>
1987
1988 <!--_______________________________________________________________________-->
1989 <div class="doc_subsubsection">
1990   <a name="iterate_chains">Iterating over def-use &amp; use-def chains</a>
1991 </div>
1992
1993 <div class="doc_text">
1994
1995 <p>Frequently, we might have an instance of the <a
1996 href="/doxygen/classllvm_1_1Value.html">Value Class</a> and we want to
1997 determine which <tt>User</tt>s use the <tt>Value</tt>.  The list of all
1998 <tt>User</tt>s of a particular <tt>Value</tt> is called a <i>def-use</i> chain.
1999 For example, let's say we have a <tt>Function*</tt> named <tt>F</tt> to a
2000 particular function <tt>foo</tt>. Finding all of the instructions that
2001 <i>use</i> <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain
2002 of <tt>F</tt>:</p>
2003
2004 <div class="doc_code">
2005 <pre>
2006 Function *F = ...;
2007
2008 for (Value::use_iterator i = F-&gt;use_begin(), e = F-&gt;use_end(); i != e; ++i)
2009   if (Instruction *Inst = dyn_cast&lt;Instruction&gt;(*i)) {
2010     errs() &lt;&lt; "F is used in instruction:\n";
2011     errs() &lt;&lt; *Inst &lt;&lt; "\n";
2012   }
2013 </pre>
2014 </div>
2015
2016 <p>Note that dereferencing a <tt>Value::use_iterator</tt> is not a very cheap
2017 operation. Instead of performing <tt>*i</tt> above several times, consider
2018 doing it only once in the loop body and reusing its result.</p>
2019
2020 <p>Alternatively, it's common to have an instance of the <a
2021 href="/doxygen/classllvm_1_1User.html">User Class</a> and need to know what
2022 <tt>Value</tt>s are used by it.  The list of all <tt>Value</tt>s used by a
2023 <tt>User</tt> is known as a <i>use-def</i> chain.  Instances of class
2024 <tt>Instruction</tt> are common <tt>User</tt>s, so we might want to iterate over
2025 all of the values that a particular instruction uses (that is, the operands of
2026 the particular <tt>Instruction</tt>):</p>
2027
2028 <div class="doc_code">
2029 <pre>
2030 Instruction *pi = ...;
2031
2032 for (User::op_iterator i = pi-&gt;op_begin(), e = pi-&gt;op_end(); i != e; ++i) {
2033   Value *v = *i;
2034   // <i>...</i>
2035 }
2036 </pre>
2037 </div>
2038
2039 <p>Declaring objects as <tt>const</tt> is an important tool of enforcing
2040 mutation free algorithms (such as analyses, etc.). For this purpose above
2041 iterators come in constant flavors as <tt>Value::const_use_iterator</tt>
2042 and <tt>Value::const_op_iterator</tt>.  They automatically arise when
2043 calling <tt>use/op_begin()</tt> on <tt>const Value*</tt>s or
2044 <tt>const User*</tt>s respectively.  Upon dereferencing, they return
2045 <tt>const Use*</tt>s. Otherwise the above patterns remain unchanged.</p>
2046
2047 </div>
2048
2049 <!--_______________________________________________________________________-->
2050 <div class="doc_subsubsection">
2051   <a name="iterate_preds">Iterating over predecessors &amp;
2052 successors of blocks</a>
2053 </div>
2054
2055 <div class="doc_text">
2056
2057 <p>Iterating over the predecessors and successors of a block is quite easy
2058 with the routines defined in <tt>"llvm/Support/CFG.h"</tt>.  Just use code like
2059 this to iterate over all predecessors of BB:</p>
2060
2061 <div class="doc_code">
2062 <pre>
2063 #include "llvm/Support/CFG.h"
2064 BasicBlock *BB = ...;
2065
2066 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
2067   BasicBlock *Pred = *PI;
2068   // <i>...</i>
2069 }
2070 </pre>
2071 </div>
2072
2073 <p>Similarly, to iterate over successors use
2074 succ_iterator/succ_begin/succ_end.</p>
2075
2076 </div>
2077
2078
2079 <!-- ======================================================================= -->
2080 <div class="doc_subsection">
2081   <a name="simplechanges">Making simple changes</a>
2082 </div>
2083
2084 <div class="doc_text">
2085
2086 <p>There are some primitive transformation operations present in the LLVM
2087 infrastructure that are worth knowing about.  When performing
2088 transformations, it's fairly common to manipulate the contents of basic
2089 blocks. This section describes some of the common methods for doing so
2090 and gives example code.</p>
2091
2092 </div>
2093
2094 <!--_______________________________________________________________________-->
2095 <div class="doc_subsubsection">
2096   <a name="schanges_creating">Creating and inserting new
2097   <tt>Instruction</tt>s</a>
2098 </div>
2099
2100 <div class="doc_text">
2101
2102 <p><i>Instantiating Instructions</i></p>
2103
2104 <p>Creation of <tt>Instruction</tt>s is straight-forward: simply call the
2105 constructor for the kind of instruction to instantiate and provide the necessary
2106 parameters. For example, an <tt>AllocaInst</tt> only <i>requires</i> a
2107 (const-ptr-to) <tt>Type</tt>. Thus:</p>
2108
2109 <div class="doc_code">
2110 <pre>
2111 AllocaInst* ai = new AllocaInst(Type::Int32Ty);
2112 </pre>
2113 </div>
2114
2115 <p>will create an <tt>AllocaInst</tt> instance that represents the allocation of
2116 one integer in the current stack frame, at run time. Each <tt>Instruction</tt>
2117 subclass is likely to have varying default parameters which change the semantics
2118 of the instruction, so refer to the <a
2119 href="/doxygen/classllvm_1_1Instruction.html">doxygen documentation for the subclass of
2120 Instruction</a> that you're interested in instantiating.</p>
2121
2122 <p><i>Naming values</i></p>
2123
2124 <p>It is very useful to name the values of instructions when you're able to, as
2125 this facilitates the debugging of your transformations.  If you end up looking
2126 at generated LLVM machine code, you definitely want to have logical names
2127 associated with the results of instructions!  By supplying a value for the
2128 <tt>Name</tt> (default) parameter of the <tt>Instruction</tt> constructor, you
2129 associate a logical name with the result of the instruction's execution at
2130 run time.  For example, say that I'm writing a transformation that dynamically
2131 allocates space for an integer on the stack, and that integer is going to be
2132 used as some kind of index by some other code.  To accomplish this, I place an
2133 <tt>AllocaInst</tt> at the first point in the first <tt>BasicBlock</tt> of some
2134 <tt>Function</tt>, and I'm intending to use it within the same
2135 <tt>Function</tt>. I might do:</p>
2136
2137 <div class="doc_code">
2138 <pre>
2139 AllocaInst* pa = new AllocaInst(Type::Int32Ty, 0, "indexLoc");
2140 </pre>
2141 </div>
2142
2143 <p>where <tt>indexLoc</tt> is now the logical name of the instruction's
2144 execution value, which is a pointer to an integer on the run time stack.</p>
2145
2146 <p><i>Inserting instructions</i></p>
2147
2148 <p>There are essentially two ways to insert an <tt>Instruction</tt>
2149 into an existing sequence of instructions that form a <tt>BasicBlock</tt>:</p>
2150
2151 <ul>
2152   <li>Insertion into an explicit instruction list
2153
2154     <p>Given a <tt>BasicBlock* pb</tt>, an <tt>Instruction* pi</tt> within that
2155     <tt>BasicBlock</tt>, and a newly-created instruction we wish to insert
2156     before <tt>*pi</tt>, we do the following: </p>
2157
2158 <div class="doc_code">
2159 <pre>
2160 BasicBlock *pb = ...;
2161 Instruction *pi = ...;
2162 Instruction *newInst = new Instruction(...);
2163
2164 pb-&gt;getInstList().insert(pi, newInst); // <i>Inserts newInst before pi in pb</i>
2165 </pre>
2166 </div>
2167
2168     <p>Appending to the end of a <tt>BasicBlock</tt> is so common that
2169     the <tt>Instruction</tt> class and <tt>Instruction</tt>-derived
2170     classes provide constructors which take a pointer to a
2171     <tt>BasicBlock</tt> to be appended to. For example code that
2172     looked like: </p>
2173
2174 <div class="doc_code">
2175 <pre>
2176 BasicBlock *pb = ...;
2177 Instruction *newInst = new Instruction(...);
2178
2179 pb-&gt;getInstList().push_back(newInst); // <i>Appends newInst to pb</i>
2180 </pre>
2181 </div>
2182
2183     <p>becomes: </p>
2184
2185 <div class="doc_code">
2186 <pre>
2187 BasicBlock *pb = ...;
2188 Instruction *newInst = new Instruction(..., pb);
2189 </pre>
2190 </div>
2191
2192     <p>which is much cleaner, especially if you are creating
2193     long instruction streams.</p></li>
2194
2195   <li>Insertion into an implicit instruction list
2196
2197     <p><tt>Instruction</tt> instances that are already in <tt>BasicBlock</tt>s
2198     are implicitly associated with an existing instruction list: the instruction
2199     list of the enclosing basic block. Thus, we could have accomplished the same
2200     thing as the above code without being given a <tt>BasicBlock</tt> by doing:
2201     </p>
2202
2203 <div class="doc_code">
2204 <pre>
2205 Instruction *pi = ...;
2206 Instruction *newInst = new Instruction(...);
2207
2208 pi-&gt;getParent()-&gt;getInstList().insert(pi, newInst);
2209 </pre>
2210 </div>
2211
2212     <p>In fact, this sequence of steps occurs so frequently that the
2213     <tt>Instruction</tt> class and <tt>Instruction</tt>-derived classes provide
2214     constructors which take (as a default parameter) a pointer to an
2215     <tt>Instruction</tt> which the newly-created <tt>Instruction</tt> should
2216     precede.  That is, <tt>Instruction</tt> constructors are capable of
2217     inserting the newly-created instance into the <tt>BasicBlock</tt> of a
2218     provided instruction, immediately before that instruction.  Using an
2219     <tt>Instruction</tt> constructor with a <tt>insertBefore</tt> (default)
2220     parameter, the above code becomes:</p>
2221
2222 <div class="doc_code">
2223 <pre>
2224 Instruction* pi = ...;
2225 Instruction* newInst = new Instruction(..., pi);
2226 </pre>
2227 </div>
2228
2229     <p>which is much cleaner, especially if you're creating a lot of
2230     instructions and adding them to <tt>BasicBlock</tt>s.</p></li>
2231 </ul>
2232
2233 </div>
2234
2235 <!--_______________________________________________________________________-->
2236 <div class="doc_subsubsection">
2237   <a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a>
2238 </div>
2239
2240 <div class="doc_text">
2241
2242 <p>Deleting an instruction from an existing sequence of instructions that form a
2243 <a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward: just
2244 call the instruction's eraseFromParent() method.  For example:</p>
2245
2246 <div class="doc_code">
2247 <pre>
2248 <a href="#Instruction">Instruction</a> *I = .. ;
2249 I-&gt;eraseFromParent();
2250 </pre>
2251 </div>
2252
2253 <p>This unlinks the instruction from its containing basic block and deletes
2254 it.  If you'd just like to unlink the instruction from its containing basic
2255 block but not delete it, you can use the <tt>removeFromParent()</tt> method.</p>
2256
2257 </div>
2258
2259 <!--_______________________________________________________________________-->
2260 <div class="doc_subsubsection">
2261   <a name="schanges_replacing">Replacing an <tt>Instruction</tt> with another
2262   <tt>Value</tt></a>
2263 </div>
2264
2265 <div class="doc_text">
2266
2267 <p><i>Replacing individual instructions</i></p>
2268
2269 <p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>"
2270 permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt>
2271 and <tt>ReplaceInstWithInst</tt>.</p>
2272
2273 <h4><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h4>
2274
2275 <ul>
2276   <li><tt>ReplaceInstWithValue</tt>
2277
2278     <p>This function replaces all uses of a given instruction with a value,
2279     and then removes the original instruction. The following example
2280     illustrates the replacement of the result of a particular
2281     <tt>AllocaInst</tt> that allocates memory for a single integer with a null
2282     pointer to an integer.</p>
2283
2284 <div class="doc_code">
2285 <pre>
2286 AllocaInst* instToReplace = ...;
2287 BasicBlock::iterator ii(instToReplace);
2288
2289 ReplaceInstWithValue(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
2290                      Constant::getNullValue(PointerType::getUnqual(Type::Int32Ty)));
2291 </pre></div></li>
2292
2293   <li><tt>ReplaceInstWithInst</tt>
2294
2295     <p>This function replaces a particular instruction with another
2296     instruction, inserting the new instruction into the basic block at the
2297     location where the old instruction was, and replacing any uses of the old
2298     instruction with the new instruction. The following example illustrates
2299     the replacement of one <tt>AllocaInst</tt> with another.</p>
2300
2301 <div class="doc_code">
2302 <pre>
2303 AllocaInst* instToReplace = ...;
2304 BasicBlock::iterator ii(instToReplace);
2305
2306 ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
2307                     new AllocaInst(Type::Int32Ty, 0, "ptrToReplacedInt"));
2308 </pre></div></li>
2309 </ul>
2310
2311 <p><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></p>
2312
2313 <p>You can use <tt>Value::replaceAllUsesWith</tt> and
2314 <tt>User::replaceUsesOfWith</tt> to change more than one use at a time.  See the
2315 doxygen documentation for the <a href="/doxygen/classllvm_1_1Value.html">Value Class</a>
2316 and <a href="/doxygen/classllvm_1_1User.html">User Class</a>, respectively, for more
2317 information.</p>
2318
2319 <!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
2320 include/llvm/Transforms/Utils/ especially BasicBlockUtils.h with:
2321 ReplaceInstWithValue, ReplaceInstWithInst -->
2322
2323 </div>
2324
2325 <!--_______________________________________________________________________-->
2326 <div class="doc_subsubsection">
2327   <a name="schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a>
2328 </div>
2329
2330 <div class="doc_text">
2331
2332 <p>Deleting a global variable from a module is just as easy as deleting an
2333 Instruction. First, you must have a pointer to the global variable that you wish
2334  to delete.  You use this pointer to erase it from its parent, the module.
2335  For example:</p>
2336
2337 <div class="doc_code">
2338 <pre>
2339 <a href="#GlobalVariable">GlobalVariable</a> *GV = .. ;
2340
2341 GV-&gt;eraseFromParent();
2342 </pre>
2343 </div>
2344
2345 </div>
2346
2347 <!-- ======================================================================= -->
2348 <div class="doc_subsection">
2349   <a name="create_types">How to Create Types</a>
2350 </div>
2351
2352 <div class="doc_text">
2353
2354 <p>In generating IR, you may need some complex types.  If you know these types
2355 statically, you can use <tt>TypeBuilder&lt;...&gt;::get()</tt>, defined
2356 in <tt>llvm/Support/TypeBuilder.h</tt>, to retrieve them.  <tt>TypeBuilder</tt>
2357 has two forms depending on whether you're building types for cross-compilation
2358 or native library use.  <tt>TypeBuilder&lt;T, true&gt;</tt> requires
2359 that <tt>T</tt> be independent of the host environment, meaning that it's built
2360 out of types from
2361 the <a href="/doxygen/namespacellvm_1_1types.html"><tt>llvm::types</tt></a>
2362 namespace and pointers, functions, arrays, etc. built of
2363 those.  <tt>TypeBuilder&lt;T, false&gt;</tt> additionally allows native C types
2364 whose size may depend on the host compiler.  For example,</p>
2365
2366 <div class="doc_code">
2367 <pre>
2368 FunctionType *ft = TypeBuilder&lt;types::i&lt;8&gt;(types::i&lt;32&gt;*), true&gt;::get();
2369 </pre>
2370 </div>
2371
2372 <p>is easier to read and write than the equivalent</p>
2373
2374 <div class="doc_code">
2375 <pre>
2376 std::vector&lt;const Type*&gt; params;
2377 params.push_back(PointerType::getUnqual(Type::Int32Ty));
2378 FunctionType *ft = FunctionType::get(Type::Int8Ty, params, false);
2379 </pre>
2380 </div>
2381
2382 <p>See the <a href="/doxygen/TypeBuilder_8h-source.html#l00001">class
2383 comment</a> for more details.</p>
2384
2385 </div>
2386
2387 <!-- *********************************************************************** -->
2388 <div class="doc_section">
2389   <a name="threading">Threads and LLVM</a>
2390 </div>
2391 <!-- *********************************************************************** -->
2392
2393 <div class="doc_text">
2394 <p>
2395 This section describes the interaction of the LLVM APIs with multithreading,
2396 both on the part of client applications, and in the JIT, in the hosted
2397 application.
2398 </p>
2399
2400 <p>
2401 Note that LLVM's support for multithreading is still relatively young.  Up
2402 through version 2.5, the execution of threaded hosted applications was
2403 supported, but not threaded client access to the APIs.  While this use case is
2404 now supported, clients <em>must</em> adhere to the guidelines specified below to
2405 ensure proper operation in multithreaded mode.
2406 </p>
2407
2408 <p>
2409 Note that, on Unix-like platforms, LLVM requires the presence of GCC's atomic
2410 intrinsics in order to support threaded operation.  If you need a
2411 multhreading-capable LLVM on a platform without a suitably modern system
2412 compiler, consider compiling LLVM and LLVM-GCC in single-threaded mode, and
2413 using the resultant compiler to build a copy of LLVM with multithreading
2414 support.
2415 </p>
2416 </div>
2417
2418 <!-- ======================================================================= -->
2419 <div class="doc_subsection">
2420   <a name="startmultithreaded">Entering and Exiting Multithreaded Mode</a>
2421 </div>
2422
2423 <div class="doc_text">
2424
2425 <p>
2426 In order to properly protect its internal data structures while avoiding
2427 excessive locking overhead in the single-threaded case, the LLVM must intialize
2428 certain data structures necessary to provide guards around its internals.  To do
2429 so, the client program must invoke <tt>llvm_start_multithreaded()</tt> before
2430 making any concurrent LLVM API calls.  To subsequently tear down these
2431 structures, use the <tt>llvm_stop_multithreaded()</tt> call.  You can also use
2432 the <tt>llvm_is_multithreaded()</tt> call to check the status of multithreaded
2433 mode.
2434 </p>
2435
2436 <p>
2437 Note that both of these calls must be made <em>in isolation</em>.  That is to
2438 say that no other LLVM API calls may be executing at any time during the
2439 execution of <tt>llvm_start_multithreaded()</tt> or <tt>llvm_stop_multithreaded
2440 </tt>.  It's is the client's responsibility to enforce this isolation.
2441 </p>
2442
2443 <p>
2444 The return value of <tt>llvm_start_multithreaded()</tt> indicates the success or
2445 failure of the initialization.  Failure typically indicates that your copy of
2446 LLVM was built without multithreading support, typically because GCC atomic
2447 intrinsics were not found in your system compiler.  In this case, the LLVM API
2448 will not be safe for concurrent calls.  However, it <em>will</em> be safe for
2449 hosting threaded applications in the JIT, though <a href="#jitthreading">care
2450 must be taken</a> to ensure that side exits and the like do not accidentally
2451 result in concurrent LLVM API calls.
2452 </p>
2453 </div>
2454
2455 <!-- ======================================================================= -->
2456 <div class="doc_subsection">
2457   <a name="shutdown">Ending Execution with <tt>llvm_shutdown()</tt></a>
2458 </div>
2459
2460 <div class="doc_text">
2461 <p>
2462 When you are done using the LLVM APIs, you should call <tt>llvm_shutdown()</tt>
2463 to deallocate memory used for internal structures.  This will also invoke
2464 <tt>llvm_stop_multithreaded()</tt> if LLVM is operating in multithreaded mode.
2465 As such, <tt>llvm_shutdown()</tt> requires the same isolation guarantees as
2466 <tt>llvm_stop_multithreaded()</tt>.
2467 </p>
2468
2469 <p>
2470 Note that, if you use scope-based shutdown, you can use the
2471 <tt>llvm_shutdown_obj</tt> class, which calls <tt>llvm_shutdown()</tt> in its
2472 destructor.
2473 </div>
2474
2475 <!-- ======================================================================= -->
2476 <div class="doc_subsection">
2477   <a name="managedstatic">Lazy Initialization with <tt>ManagedStatic</tt></a>
2478 </div>
2479
2480 <div class="doc_text">
2481 <p>
2482 <tt>ManagedStatic</tt> is a utility class in LLVM used to implement static
2483 initialization of static resources, such as the global type tables.  Before the
2484 invocation of <tt>llvm_shutdown()</tt>, it implements a simple lazy
2485 initialization scheme.  Once <tt>llvm_start_multithreaded()</tt> returns,
2486 however, it uses double-checked locking to implement thread-safe lazy
2487 initialization.
2488 </p>
2489
2490 <p>
2491 Note that, because no other threads are allowed to issue LLVM API calls before
2492 <tt>llvm_start_multithreaded()</tt> returns, it is possible to have
2493 <tt>ManagedStatic</tt>s of <tt>llvm::sys::Mutex</tt>s.
2494 </p>
2495
2496 <p>
2497 The <tt>llvm_acquire_global_lock()</tt> and <tt>llvm_release_global_lock</tt>
2498 APIs provide access to the global lock used to implement the double-checked
2499 locking for lazy initialization.  These should only be used internally to LLVM,
2500 and only if you know what you're doing!
2501 </p>
2502 </div>
2503
2504 <!-- ======================================================================= -->
2505 <div class="doc_subsection">
2506   <a name="llvmcontext">Achieving Isolation with <tt>LLVMContext</tt></a>
2507 </div>
2508
2509 <div class="doc_text">
2510 <p>
2511 <tt>LLVMContext</tt> is an opaque class in the LLVM API which clients can use
2512 to operate multiple, isolated instances of LLVM concurrently within the same
2513 address space.  For instance, in a hypothetical compile-server, the compilation
2514 of an individual translation unit is conceptually independent from all the
2515 others, and it would be desirable to be able to compile incoming translation
2516 units concurrently on independent server threads.  Fortunately,
2517 <tt>LLVMContext</tt> exists to enable just this kind of scenario!
2518 </p>
2519
2520 <p>
2521 Conceptually, <tt>LLVMContext</tt> provides isolation.  Every LLVM entity
2522 (<tt>Module</tt>s, <tt>Value</tt>s, <tt>Type</tt>s, <tt>Constant</tt>s, etc.)
2523 in LLVM's in-memory IR belongs to an <tt>LLVMContext</tt>.  Entities in
2524 different contexts <em>cannot</em> interact with each other: <tt>Module</tt>s in
2525 different contexts cannot be linked together, <tt>Function</tt>s cannot be added
2526 to <tt>Module</tt>s in different contexts, etc.  What this means is that is is
2527 safe to compile on multiple threads simultaneously, as long as no two threads
2528 operate on entities within the same context.
2529 </p>
2530
2531 <p>
2532 In practice, very few places in the API require the explicit specification of a
2533 <tt>LLVMContext</tt>, other than the <tt>Type</tt> creation/lookup APIs.
2534 Because every <tt>Type</tt> carries a reference to its owning context, most
2535 other entities can determine what context they belong to by looking at their
2536 own <tt>Type</tt>.  If you are adding new entities to LLVM IR, please try to
2537 maintain this interface design.
2538 </p>
2539
2540 <p>
2541 For clients that do <em>not</em> require the benefits of isolation, LLVM
2542 provides a convenience API <tt>getGlobalContext()</tt>.  This returns a global,
2543 lazily initialized <tt>LLVMContext</tt> that may be used in situations where
2544 isolation is not a concern.
2545 </p>
2546 </div>
2547
2548 <!-- ======================================================================= -->
2549 <div class="doc_subsection">
2550   <a name="jitthreading">Threads and the JIT</a>
2551 </div>
2552
2553 <div class="doc_text">
2554 <p>
2555 LLVM's "eager" JIT compiler is safe to use in threaded programs.  Multiple
2556 threads can call <tt>ExecutionEngine::getPointerToFunction()</tt> or
2557 <tt>ExecutionEngine::runFunction()</tt> concurrently, and multiple threads can
2558 run code output by the JIT concurrently.  The user must still ensure that only
2559 one thread accesses IR in a given <tt>LLVMContext</tt> while another thread
2560 might be modifying it.  One way to do that is to always hold the JIT lock while
2561 accessing IR outside the JIT (the JIT <em>modifies</em> the IR by adding
2562 <tt>CallbackVH</tt>s).  Another way is to only
2563 call <tt>getPointerToFunction()</tt> from the <tt>LLVMContext</tt>'s thread.
2564 </p>
2565
2566 <p>When the JIT is configured to compile lazily (using
2567 <tt>ExecutionEngine::DisableLazyCompilation(false)</tt>), there is currently a
2568 <a href="http://llvm.org/bugs/show_bug.cgi?id=5184">race condition</a> in
2569 updating call sites after a function is lazily-jitted.  It's still possible to
2570 use the lazy JIT in a threaded program if you ensure that only one thread at a
2571 time can call any particular lazy stub and that the JIT lock guards any IR
2572 access, but we suggest using only the eager JIT in threaded programs.
2573 </p>
2574 </div>
2575
2576 <!-- *********************************************************************** -->
2577 <div class="doc_section">
2578   <a name="advanced">Advanced Topics</a>
2579 </div>
2580 <!-- *********************************************************************** -->
2581
2582 <div class="doc_text">
2583 <p>
2584 This section describes some of the advanced or obscure API's that most clients
2585 do not need to be aware of.  These API's tend manage the inner workings of the
2586 LLVM system, and only need to be accessed in unusual circumstances.
2587 </p>
2588 </div>
2589
2590 <!-- ======================================================================= -->
2591 <div class="doc_subsection">
2592   <a name="TypeResolve">LLVM Type Resolution</a>
2593 </div>
2594
2595 <div class="doc_text">
2596
2597 <p>
2598 The LLVM type system has a very simple goal: allow clients to compare types for
2599 structural equality with a simple pointer comparison (aka a shallow compare).
2600 This goal makes clients much simpler and faster, and is used throughout the LLVM
2601 system.
2602 </p>
2603
2604 <p>
2605 Unfortunately achieving this goal is not a simple matter.  In particular,
2606 recursive types and late resolution of opaque types makes the situation very
2607 difficult to handle.  Fortunately, for the most part, our implementation makes
2608 most clients able to be completely unaware of the nasty internal details.  The
2609 primary case where clients are exposed to the inner workings of it are when
2610 building a recursive type.  In addition to this case, the LLVM bitcode reader,
2611 assembly parser, and linker also have to be aware of the inner workings of this
2612 system.
2613 </p>
2614
2615 <p>
2616 For our purposes below, we need three concepts.  First, an "Opaque Type" is
2617 exactly as defined in the <a href="LangRef.html#t_opaque">language
2618 reference</a>.  Second an "Abstract Type" is any type which includes an
2619 opaque type as part of its type graph (for example "<tt>{ opaque, i32 }</tt>").
2620 Third, a concrete type is a type that is not an abstract type (e.g. "<tt>{ i32,
2621 float }</tt>").
2622 </p>
2623
2624 </div>
2625
2626 <!-- ______________________________________________________________________ -->
2627 <div class="doc_subsubsection">
2628   <a name="BuildRecType">Basic Recursive Type Construction</a>
2629 </div>
2630
2631 <div class="doc_text">
2632
2633 <p>
2634 Because the most common question is "how do I build a recursive type with LLVM",
2635 we answer it now and explain it as we go.  Here we include enough to cause this
2636 to be emitted to an output .ll file:
2637 </p>
2638
2639 <div class="doc_code">
2640 <pre>
2641 %mylist = type { %mylist*, i32 }
2642 </pre>
2643 </div>
2644
2645 <p>
2646 To build this, use the following LLVM APIs:
2647 </p>
2648
2649 <div class="doc_code">
2650 <pre>
2651 // <i>Create the initial outer struct</i>
2652 <a href="#PATypeHolder">PATypeHolder</a> StructTy = OpaqueType::get();
2653 std::vector&lt;const Type*&gt; Elts;
2654 Elts.push_back(PointerType::getUnqual(StructTy));
2655 Elts.push_back(Type::Int32Ty);
2656 StructType *NewSTy = StructType::get(Elts);
2657
2658 // <i>At this point, NewSTy = "{ opaque*, i32 }". Tell VMCore that</i>
2659 // <i>the struct and the opaque type are actually the same.</i>
2660 cast&lt;OpaqueType&gt;(StructTy.get())-&gt;<a href="#refineAbstractTypeTo">refineAbstractTypeTo</a>(NewSTy);
2661
2662 // <i>NewSTy is potentially invalidated, but StructTy (a <a href="#PATypeHolder">PATypeHolder</a>) is</i>
2663 // <i>kept up-to-date</i>
2664 NewSTy = cast&lt;StructType&gt;(StructTy.get());
2665
2666 // <i>Add a name for the type to the module symbol table (optional)</i>
2667 MyModule-&gt;addTypeName("mylist", NewSTy);
2668 </pre>
2669 </div>
2670
2671 <p>
2672 This code shows the basic approach used to build recursive types: build a
2673 non-recursive type using 'opaque', then use type unification to close the cycle.
2674 The type unification step is performed by the <tt><a
2675 href="#refineAbstractTypeTo">refineAbstractTypeTo</a></tt> method, which is
2676 described next.  After that, we describe the <a
2677 href="#PATypeHolder">PATypeHolder class</a>.
2678 </p>
2679
2680 </div>
2681
2682 <!-- ______________________________________________________________________ -->
2683 <div class="doc_subsubsection">
2684   <a name="refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a>
2685 </div>
2686
2687 <div class="doc_text">
2688 <p>
2689 The <tt>refineAbstractTypeTo</tt> method starts the type unification process.
2690 While this method is actually a member of the DerivedType class, it is most
2691 often used on OpaqueType instances.  Type unification is actually a recursive
2692 process.  After unification, types can become structurally isomorphic to
2693 existing types, and all duplicates are deleted (to preserve pointer equality).
2694 </p>
2695
2696 <p>
2697 In the example above, the OpaqueType object is definitely deleted.
2698 Additionally, if there is an "{ \2*, i32}" type already created in the system,
2699 the pointer and struct type created are <b>also</b> deleted.  Obviously whenever
2700 a type is deleted, any "Type*" pointers in the program are invalidated.  As
2701 such, it is safest to avoid having <i>any</i> "Type*" pointers to abstract types
2702 live across a call to <tt>refineAbstractTypeTo</tt> (note that non-abstract
2703 types can never move or be deleted).  To deal with this, the <a
2704 href="#PATypeHolder">PATypeHolder</a> class is used to maintain a stable
2705 reference to a possibly refined type, and the <a
2706 href="#AbstractTypeUser">AbstractTypeUser</a> class is used to update more
2707 complex datastructures.
2708 </p>
2709
2710 </div>
2711
2712 <!-- ______________________________________________________________________ -->
2713 <div class="doc_subsubsection">
2714   <a name="PATypeHolder">The PATypeHolder Class</a>
2715 </div>
2716
2717 <div class="doc_text">
2718 <p>
2719 PATypeHolder is a form of a "smart pointer" for Type objects.  When VMCore
2720 happily goes about nuking types that become isomorphic to existing types, it
2721 automatically updates all PATypeHolder objects to point to the new type.  In the
2722 example above, this allows the code to maintain a pointer to the resultant
2723 resolved recursive type, even though the Type*'s are potentially invalidated.
2724 </p>
2725
2726 <p>
2727 PATypeHolder is an extremely light-weight object that uses a lazy union-find
2728 implementation to update pointers.  For example the pointer from a Value to its
2729 Type is maintained by PATypeHolder objects.
2730 </p>
2731
2732 </div>
2733
2734 <!-- ______________________________________________________________________ -->
2735 <div class="doc_subsubsection">
2736   <a name="AbstractTypeUser">The AbstractTypeUser Class</a>
2737 </div>
2738
2739 <div class="doc_text">
2740
2741 <p>
2742 Some data structures need more to perform more complex updates when types get
2743 resolved.  To support this, a class can derive from the AbstractTypeUser class.
2744 This class
2745 allows it to get callbacks when certain types are resolved.  To register to get
2746 callbacks for a particular type, the DerivedType::{add/remove}AbstractTypeUser
2747 methods can be called on a type.  Note that these methods only work for <i>
2748   abstract</i> types.  Concrete types (those that do not include any opaque
2749 objects) can never be refined.
2750 </p>
2751 </div>
2752
2753
2754 <!-- ======================================================================= -->
2755 <div class="doc_subsection">
2756   <a name="SymbolTable">The <tt>ValueSymbolTable</tt> and
2757    <tt>TypeSymbolTable</tt> classes</a>
2758 </div>
2759
2760 <div class="doc_text">
2761 <p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1ValueSymbolTable.html">
2762 ValueSymbolTable</a></tt> class provides a symbol table that the <a
2763 href="#Function"><tt>Function</tt></a> and <a href="#Module">
2764 <tt>Module</tt></a> classes use for naming value definitions. The symbol table
2765 can provide a name for any <a href="#Value"><tt>Value</tt></a>.
2766 The <tt><a href="http://llvm.org/doxygen/classllvm_1_1TypeSymbolTable.html">
2767 TypeSymbolTable</a></tt> class is used by the <tt>Module</tt> class to store
2768 names for types.</p>
2769
2770 <p>Note that the <tt>SymbolTable</tt> class should not be directly accessed
2771 by most clients.  It should only be used when iteration over the symbol table
2772 names themselves are required, which is very special purpose.  Note that not
2773 all LLVM
2774 <tt><a href="#Value">Value</a></tt>s have names, and those without names (i.e. they have
2775 an empty name) do not exist in the symbol table.
2776 </p>
2777
2778 <p>These symbol tables support iteration over the values/types in the symbol
2779 table with <tt>begin/end/iterator</tt> and supports querying to see if a
2780 specific name is in the symbol table (with <tt>lookup</tt>).  The
2781 <tt>ValueSymbolTable</tt> class exposes no public mutator methods, instead,
2782 simply call <tt>setName</tt> on a value, which will autoinsert it into the
2783 appropriate symbol table.  For types, use the Module::addTypeName method to
2784 insert entries into the symbol table.</p>
2785
2786 </div>
2787
2788
2789
2790 <!-- ======================================================================= -->
2791 <div class="doc_subsection">
2792   <a name="UserLayout">The <tt>User</tt> and owned <tt>Use</tt> classes' memory layout</a>
2793 </div>
2794
2795 <div class="doc_text">
2796 <p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1User.html">
2797 User</a></tt> class provides a basis for expressing the ownership of <tt>User</tt>
2798 towards other <tt><a href="http://llvm.org/doxygen/classllvm_1_1Value.html">
2799 Value</a></tt>s. The <tt><a href="http://llvm.org/doxygen/classllvm_1_1Use.html">
2800 Use</a></tt> helper class is employed to do the bookkeeping and to facilitate <i>O(1)</i>
2801 addition and removal.</p>
2802
2803 <!-- ______________________________________________________________________ -->
2804 <div class="doc_subsubsection">
2805   <a name="Use2User">Interaction and relationship between <tt>User</tt> and <tt>Use</tt> objects</a>
2806 </div>
2807
2808 <div class="doc_text">
2809 <p>
2810 A subclass of <tt>User</tt> can choose between incorporating its <tt>Use</tt> objects
2811 or refer to them out-of-line by means of a pointer. A mixed variant
2812 (some <tt>Use</tt>s inline others hung off) is impractical and breaks the invariant
2813 that the <tt>Use</tt> objects belonging to the same <tt>User</tt> form a contiguous array.
2814 </p>
2815 </div>
2816
2817 <p>
2818 We have 2 different layouts in the <tt>User</tt> (sub)classes:
2819 <ul>
2820 <li><p>Layout a)
2821 The <tt>Use</tt> object(s) are inside (resp. at fixed offset) of the <tt>User</tt>
2822 object and there are a fixed number of them.</p>
2823
2824 <li><p>Layout b)
2825 The <tt>Use</tt> object(s) are referenced by a pointer to an
2826 array from the <tt>User</tt> object and there may be a variable
2827 number of them.</p>
2828 </ul>
2829 <p>
2830 As of v2.4 each layout still possesses a direct pointer to the
2831 start of the array of <tt>Use</tt>s. Though not mandatory for layout a),
2832 we stick to this redundancy for the sake of simplicity.
2833 The <tt>User</tt> object also stores the number of <tt>Use</tt> objects it
2834 has. (Theoretically this information can also be calculated
2835 given the scheme presented below.)</p>
2836 <p>
2837 Special forms of allocation operators (<tt>operator new</tt>)
2838 enforce the following memory layouts:</p>
2839
2840 <ul>
2841 <li><p>Layout a) is modelled by prepending the <tt>User</tt> object by the <tt>Use[]</tt> array.</p>
2842
2843 <pre>
2844 ...---.---.---.---.-------...
2845   | P | P | P | P | User
2846 '''---'---'---'---'-------'''
2847 </pre>
2848
2849 <li><p>Layout b) is modelled by pointing at the <tt>Use[]</tt> array.</p>
2850 <pre>
2851 .-------...
2852 | User
2853 '-------'''
2854     |
2855     v
2856     .---.---.---.---...
2857     | P | P | P | P |
2858     '---'---'---'---'''
2859 </pre>
2860 </ul>
2861 <i>(In the above figures '<tt>P</tt>' stands for the <tt>Use**</tt> that
2862     is stored in each <tt>Use</tt> object in the member <tt>Use::Prev</tt>)</i>
2863
2864 <!-- ______________________________________________________________________ -->
2865 <div class="doc_subsubsection">
2866   <a name="Waymarking">The waymarking algorithm</a>
2867 </div>
2868
2869 <div class="doc_text">
2870 <p>
2871 Since the <tt>Use</tt> objects are deprived of the direct (back)pointer to
2872 their <tt>User</tt> objects, there must be a fast and exact method to
2873 recover it. This is accomplished by the following scheme:</p>
2874 </div>
2875
2876 A bit-encoding in the 2 LSBits (least significant bits) of the <tt>Use::Prev</tt> allows to find the
2877 start of the <tt>User</tt> object:
2878 <ul>
2879 <li><tt>00</tt> &mdash;&gt; binary digit 0</li>
2880 <li><tt>01</tt> &mdash;&gt; binary digit 1</li>
2881 <li><tt>10</tt> &mdash;&gt; stop and calculate (<tt>s</tt>)</li>
2882 <li><tt>11</tt> &mdash;&gt; full stop (<tt>S</tt>)</li>
2883 </ul>
2884 <p>
2885 Given a <tt>Use*</tt>, all we have to do is to walk till we get
2886 a stop and we either have a <tt>User</tt> immediately behind or
2887 we have to walk to the next stop picking up digits
2888 and calculating the offset:</p>
2889 <pre>
2890 .---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.----------------
2891 | 1 | s | 1 | 0 | 1 | 0 | s | 1 | 1 | 0 | s | 1 | 1 | s | 1 | S | User (or User*)
2892 '---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'----------------
2893     |+15                |+10            |+6         |+3     |+1
2894     |                   |               |           |       |__>
2895     |                   |               |           |__________>
2896     |                   |               |______________________>
2897     |                   |______________________________________>
2898     |__________________________________________________________>
2899 </pre>
2900 <p>
2901 Only the significant number of bits need to be stored between the
2902 stops, so that the <i>worst case is 20 memory accesses</i> when there are
2903 1000 <tt>Use</tt> objects associated with a <tt>User</tt>.</p>
2904
2905 <!-- ______________________________________________________________________ -->
2906 <div class="doc_subsubsection">
2907   <a name="ReferenceImpl">Reference implementation</a>
2908 </div>
2909
2910 <div class="doc_text">
2911 <p>
2912 The following literate Haskell fragment demonstrates the concept:</p>
2913 </div>
2914
2915 <div class="doc_code">
2916 <pre>
2917 > import Test.QuickCheck
2918 >
2919 > digits :: Int -> [Char] -> [Char]
2920 > digits 0 acc = '0' : acc
2921 > digits 1 acc = '1' : acc
2922 > digits n acc = digits (n `div` 2) $ digits (n `mod` 2) acc
2923 >
2924 > dist :: Int -> [Char] -> [Char]
2925 > dist 0 [] = ['S']
2926 > dist 0 acc = acc
2927 > dist 1 acc = let r = dist 0 acc in 's' : digits (length r) r
2928 > dist n acc = dist (n - 1) $ dist 1 acc
2929 >
2930 > takeLast n ss = reverse $ take n $ reverse ss
2931 >
2932 > test = takeLast 40 $ dist 20 []
2933 >
2934 </pre>
2935 </div>
2936 <p>
2937 Printing &lt;test&gt; gives: <tt>"1s100000s11010s10100s1111s1010s110s11s1S"</tt></p>
2938 <p>
2939 The reverse algorithm computes the length of the string just by examining
2940 a certain prefix:</p>
2941
2942 <div class="doc_code">
2943 <pre>
2944 > pref :: [Char] -> Int
2945 > pref "S" = 1
2946 > pref ('s':'1':rest) = decode 2 1 rest
2947 > pref (_:rest) = 1 + pref rest
2948 >
2949 > decode walk acc ('0':rest) = decode (walk + 1) (acc * 2) rest
2950 > decode walk acc ('1':rest) = decode (walk + 1) (acc * 2 + 1) rest
2951 > decode walk acc _ = walk + acc
2952 >
2953 </pre>
2954 </div>
2955 <p>
2956 Now, as expected, printing &lt;pref test&gt; gives <tt>40</tt>.</p>
2957 <p>
2958 We can <i>quickCheck</i> this with following property:</p>
2959
2960 <div class="doc_code">
2961 <pre>
2962 > testcase = dist 2000 []
2963 > testcaseLength = length testcase
2964 >
2965 > identityProp n = n > 0 && n <= testcaseLength ==> length arr == pref arr
2966 >     where arr = takeLast n testcase
2967 >
2968 </pre>
2969 </div>
2970 <p>
2971 As expected &lt;quickCheck identityProp&gt; gives:</p>
2972
2973 <pre>
2974 *Main> quickCheck identityProp
2975 OK, passed 100 tests.
2976 </pre>
2977 <p>
2978 Let's be a bit more exhaustive:</p>
2979
2980 <div class="doc_code">
2981 <pre>
2982 >
2983 > deepCheck p = check (defaultConfig { configMaxTest = 500 }) p
2984 >
2985 </pre>
2986 </div>
2987 <p>
2988 And here is the result of &lt;deepCheck identityProp&gt;:</p>
2989
2990 <pre>
2991 *Main> deepCheck identityProp
2992 OK, passed 500 tests.
2993 </pre>
2994
2995 <!-- ______________________________________________________________________ -->
2996 <div class="doc_subsubsection">
2997   <a name="Tagging">Tagging considerations</a>
2998 </div>
2999
3000 <p>
3001 To maintain the invariant that the 2 LSBits of each <tt>Use**</tt> in <tt>Use</tt>
3002 never change after being set up, setters of <tt>Use::Prev</tt> must re-tag the
3003 new <tt>Use**</tt> on every modification. Accordingly getters must strip the
3004 tag bits.</p>
3005 <p>
3006 For layout b) instead of the <tt>User</tt> we find a pointer (<tt>User*</tt> with LSBit set).
3007 Following this pointer brings us to the <tt>User</tt>. A portable trick ensures
3008 that the first bytes of <tt>User</tt> (if interpreted as a pointer) never has
3009 the LSBit set. (Portability is relying on the fact that all known compilers place the
3010 <tt>vptr</tt> in the first word of the instances.)</p>
3011
3012 </div>
3013
3014   <!-- *********************************************************************** -->
3015 <div class="doc_section">
3016   <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a>
3017 </div>
3018 <!-- *********************************************************************** -->
3019
3020 <div class="doc_text">
3021 <p><tt>#include "<a href="/doxygen/Type_8h-source.html">llvm/Type.h</a>"</tt>
3022 <br>doxygen info: <a href="/doxygen/classllvm_1_1Type.html">Type Class</a></p>
3023
3024 <p>The Core LLVM classes are the primary means of representing the program
3025 being inspected or transformed.  The core LLVM classes are defined in
3026 header files in the <tt>include/llvm/</tt> directory, and implemented in
3027 the <tt>lib/VMCore</tt> directory.</p>
3028
3029 </div>
3030
3031 <!-- ======================================================================= -->
3032 <div class="doc_subsection">
3033   <a name="Type">The <tt>Type</tt> class and Derived Types</a>
3034 </div>
3035
3036 <div class="doc_text">
3037
3038   <p><tt>Type</tt> is a superclass of all type classes. Every <tt>Value</tt> has
3039   a <tt>Type</tt>. <tt>Type</tt> cannot be instantiated directly but only
3040   through its subclasses. Certain primitive types (<tt>VoidType</tt>,
3041   <tt>LabelType</tt>, <tt>FloatType</tt> and <tt>DoubleType</tt>) have hidden
3042   subclasses. They are hidden because they offer no useful functionality beyond
3043   what the <tt>Type</tt> class offers except to distinguish themselves from
3044   other subclasses of <tt>Type</tt>.</p>
3045   <p>All other types are subclasses of <tt>DerivedType</tt>.  Types can be
3046   named, but this is not a requirement. There exists exactly
3047   one instance of a given shape at any one time.  This allows type equality to
3048   be performed with address equality of the Type Instance. That is, given two
3049   <tt>Type*</tt> values, the types are identical if the pointers are identical.
3050   </p>
3051 </div>
3052
3053 <!-- _______________________________________________________________________ -->
3054 <div class="doc_subsubsection">
3055   <a name="m_Type">Important Public Methods</a>
3056 </div>
3057
3058 <div class="doc_text">
3059
3060 <ul>
3061   <li><tt>bool isIntegerTy() const</tt>: Returns true for any integer type.</li>
3062
3063   <li><tt>bool isFloatingPointTy()</tt>: Return true if this is one of the five
3064   floating point types.</li>
3065
3066   <li><tt>bool isAbstract()</tt>: Return true if the type is abstract (contains
3067   an OpaqueType anywhere in its definition).</li>
3068
3069   <li><tt>bool isSized()</tt>: Return true if the type has known size. Things
3070   that don't have a size are abstract types, labels and void.</li>
3071
3072 </ul>
3073 </div>
3074
3075 <!-- _______________________________________________________________________ -->
3076 <div class="doc_subsubsection">
3077   <a name="derivedtypes">Important Derived Types</a>
3078 </div>
3079 <div class="doc_text">
3080 <dl>
3081   <dt><tt>IntegerType</tt></dt>
3082   <dd>Subclass of DerivedType that represents integer types of any bit width.
3083   Any bit width between <tt>IntegerType::MIN_INT_BITS</tt> (1) and
3084   <tt>IntegerType::MAX_INT_BITS</tt> (~8 million) can be represented.
3085   <ul>
3086     <li><tt>static const IntegerType* get(unsigned NumBits)</tt>: get an integer
3087     type of a specific bit width.</li>
3088     <li><tt>unsigned getBitWidth() const</tt>: Get the bit width of an integer
3089     type.</li>
3090   </ul>
3091   </dd>
3092   <dt><tt>SequentialType</tt></dt>
3093   <dd>This is subclassed by ArrayType and PointerType
3094     <ul>
3095       <li><tt>const Type * getElementType() const</tt>: Returns the type of each
3096       of the elements in the sequential type. </li>
3097     </ul>
3098   </dd>
3099   <dt><tt>ArrayType</tt></dt>
3100   <dd>This is a subclass of SequentialType and defines the interface for array
3101   types.
3102     <ul>
3103       <li><tt>unsigned getNumElements() const</tt>: Returns the number of
3104       elements in the array. </li>
3105     </ul>
3106   </dd>
3107   <dt><tt>PointerType</tt></dt>
3108   <dd>Subclass of SequentialType for pointer types.</dd>
3109   <dt><tt>VectorType</tt></dt>
3110   <dd>Subclass of SequentialType for vector types. A
3111   vector type is similar to an ArrayType but is distinguished because it is
3112   a first class type whereas ArrayType is not. Vector types are used for
3113   vector operations and are usually small vectors of of an integer or floating
3114   point type.</dd>
3115   <dt><tt>StructType</tt></dt>
3116   <dd>Subclass of DerivedTypes for struct types.</dd>
3117   <dt><tt><a name="FunctionType">FunctionType</a></tt></dt>
3118   <dd>Subclass of DerivedTypes for function types.
3119     <ul>
3120       <li><tt>bool isVarArg() const</tt>: Returns true if it's a vararg
3121       function</li>
3122       <li><tt> const Type * getReturnType() const</tt>: Returns the
3123       return type of the function.</li>
3124       <li><tt>const Type * getParamType (unsigned i)</tt>: Returns
3125       the type of the ith parameter.</li>
3126       <li><tt> const unsigned getNumParams() const</tt>: Returns the
3127       number of formal parameters.</li>
3128     </ul>
3129   </dd>
3130   <dt><tt>OpaqueType</tt></dt>
3131   <dd>Sublcass of DerivedType for abstract types. This class
3132   defines no content and is used as a placeholder for some other type. Note
3133   that OpaqueType is used (temporarily) during type resolution for forward
3134   references of types. Once the referenced type is resolved, the OpaqueType
3135   is replaced with the actual type. OpaqueType can also be used for data
3136   abstraction. At link time opaque types can be resolved to actual types
3137   of the same name.</dd>
3138 </dl>
3139 </div>
3140
3141
3142
3143 <!-- ======================================================================= -->
3144 <div class="doc_subsection">
3145   <a name="Module">The <tt>Module</tt> class</a>
3146 </div>
3147
3148 <div class="doc_text">
3149
3150 <p><tt>#include "<a
3151 href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info:
3152 <a href="/doxygen/classllvm_1_1Module.html">Module Class</a></p>
3153
3154 <p>The <tt>Module</tt> class represents the top level structure present in LLVM
3155 programs.  An LLVM module is effectively either a translation unit of the
3156 original program or a combination of several translation units merged by the
3157 linker.  The <tt>Module</tt> class keeps track of a list of <a
3158 href="#Function"><tt>Function</tt></a>s, a list of <a
3159 href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a
3160 href="#SymbolTable"><tt>SymbolTable</tt></a>.  Additionally, it contains a few
3161 helpful member functions that try to make common operations easy.</p>
3162
3163 </div>
3164
3165 <!-- _______________________________________________________________________ -->
3166 <div class="doc_subsubsection">
3167   <a name="m_Module">Important Public Members of the <tt>Module</tt> class</a>
3168 </div>
3169
3170 <div class="doc_text">
3171
3172 <ul>
3173   <li><tt>Module::Module(std::string name = "")</tt></li>
3174 </ul>
3175
3176 <p>Constructing a <a href="#Module">Module</a> is easy. You can optionally
3177 provide a name for it (probably based on the name of the translation unit).</p>
3178
3179 <ul>
3180   <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
3181     <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>
3182
3183     <tt>begin()</tt>, <tt>end()</tt>
3184     <tt>size()</tt>, <tt>empty()</tt>
3185
3186     <p>These are forwarding methods that make it easy to access the contents of
3187     a <tt>Module</tt> object's <a href="#Function"><tt>Function</tt></a>
3188     list.</p></li>
3189
3190   <li><tt>Module::FunctionListType &amp;getFunctionList()</tt>
3191
3192     <p> Returns the list of <a href="#Function"><tt>Function</tt></a>s.  This is
3193     necessary to use when you need to update the list or perform a complex
3194     action that doesn't have a forwarding method.</p>
3195
3196     <p><!--  Global Variable --></p></li>
3197 </ul>
3198
3199 <hr>
3200
3201 <ul>
3202   <li><tt>Module::global_iterator</tt> - Typedef for global variable list iterator<br>
3203
3204     <tt>Module::const_global_iterator</tt> - Typedef for const_iterator.<br>
3205
3206     <tt>global_begin()</tt>, <tt>global_end()</tt>
3207     <tt>global_size()</tt>, <tt>global_empty()</tt>
3208
3209     <p> These are forwarding methods that make it easy to access the contents of
3210     a <tt>Module</tt> object's <a
3211     href="#GlobalVariable"><tt>GlobalVariable</tt></a> list.</p></li>
3212
3213   <li><tt>Module::GlobalListType &amp;getGlobalList()</tt>
3214
3215     <p>Returns the list of <a
3216     href="#GlobalVariable"><tt>GlobalVariable</tt></a>s.  This is necessary to
3217     use when you need to update the list or perform a complex action that
3218     doesn't have a forwarding method.</p>
3219
3220     <p><!--  Symbol table stuff --> </p></li>
3221 </ul>
3222
3223 <hr>
3224
3225 <ul>
3226   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
3227
3228     <p>Return a reference to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
3229     for this <tt>Module</tt>.</p>
3230
3231     <p><!--  Convenience methods --></p></li>
3232 </ul>
3233
3234 <hr>
3235
3236 <ul>
3237   <li><tt><a href="#Function">Function</a> *getFunction(const std::string
3238   &amp;Name, const <a href="#FunctionType">FunctionType</a> *Ty)</tt>
3239
3240     <p>Look up the specified function in the <tt>Module</tt> <a
3241     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, return
3242     <tt>null</tt>.</p></li>
3243
3244   <li><tt><a href="#Function">Function</a> *getOrInsertFunction(const
3245   std::string &amp;Name, const <a href="#FunctionType">FunctionType</a> *T)</tt>
3246
3247     <p>Look up the specified function in the <tt>Module</tt> <a
3248     href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, add an
3249     external declaration for the function and return it.</p></li>
3250
3251   <li><tt>std::string getTypeName(const <a href="#Type">Type</a> *Ty)</tt>
3252
3253     <p>If there is at least one entry in the <a
3254     href="#SymbolTable"><tt>SymbolTable</tt></a> for the specified <a
3255     href="#Type"><tt>Type</tt></a>, return it.  Otherwise return the empty
3256     string.</p></li>
3257
3258   <li><tt>bool addTypeName(const std::string &amp;Name, const <a
3259   href="#Type">Type</a> *Ty)</tt>
3260
3261     <p>Insert an entry in the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
3262     mapping <tt>Name</tt> to <tt>Ty</tt>. If there is already an entry for this
3263     name, true is returned and the <a
3264     href="#SymbolTable"><tt>SymbolTable</tt></a> is not modified.</p></li>
3265 </ul>
3266
3267 </div>
3268
3269
3270 <!-- ======================================================================= -->
3271 <div class="doc_subsection">
3272   <a name="Value">The <tt>Value</tt> class</a>
3273 </div>
3274
3275 <div class="doc_text">
3276
3277 <p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt>
3278 <br>
3279 doxygen info: <a href="/doxygen/classllvm_1_1Value.html">Value Class</a></p>
3280
3281 <p>The <tt>Value</tt> class is the most important class in the LLVM Source
3282 base.  It represents a typed value that may be used (among other things) as an
3283 operand to an instruction.  There are many different types of <tt>Value</tt>s,
3284 such as <a href="#Constant"><tt>Constant</tt></a>s,<a
3285 href="#Argument"><tt>Argument</tt></a>s. Even <a
3286 href="#Instruction"><tt>Instruction</tt></a>s and <a
3287 href="#Function"><tt>Function</tt></a>s are <tt>Value</tt>s.</p>
3288
3289 <p>A particular <tt>Value</tt> may be used many times in the LLVM representation
3290 for a program.  For example, an incoming argument to a function (represented
3291 with an instance of the <a href="#Argument">Argument</a> class) is "used" by
3292 every instruction in the function that references the argument.  To keep track
3293 of this relationship, the <tt>Value</tt> class keeps a list of all of the <a
3294 href="#User"><tt>User</tt></a>s that is using it (the <a
3295 href="#User"><tt>User</tt></a> class is a base class for all nodes in the LLVM
3296 graph that can refer to <tt>Value</tt>s).  This use list is how LLVM represents
3297 def-use information in the program, and is accessible through the <tt>use_</tt>*
3298 methods, shown below.</p>
3299
3300 <p>Because LLVM is a typed representation, every LLVM <tt>Value</tt> is typed,
3301 and this <a href="#Type">Type</a> is available through the <tt>getType()</tt>
3302 method. In addition, all LLVM values can be named.  The "name" of the
3303 <tt>Value</tt> is a symbolic string printed in the LLVM code:</p>
3304
3305 <div class="doc_code">
3306 <pre>
3307 %<b>foo</b> = add i32 1, 2
3308 </pre>
3309 </div>
3310
3311 <p><a name="nameWarning">The name of this instruction is "foo".</a> <b>NOTE</b>
3312 that the name of any value may be missing (an empty string), so names should
3313 <b>ONLY</b> be used for debugging (making the source code easier to read,
3314 debugging printouts), they should not be used to keep track of values or map
3315 between them.  For this purpose, use a <tt>std::map</tt> of pointers to the
3316 <tt>Value</tt> itself instead.</p>
3317
3318 <p>One important aspect of LLVM is that there is no distinction between an SSA
3319 variable and the operation that produces it.  Because of this, any reference to
3320 the value produced by an instruction (or the value available as an incoming
3321 argument, for example) is represented as a direct pointer to the instance of
3322 the class that
3323 represents this value.  Although this may take some getting used to, it
3324 simplifies the representation and makes it easier to manipulate.</p>
3325
3326 </div>
3327
3328 <!-- _______________________________________________________________________ -->
3329 <div class="doc_subsubsection">
3330   <a name="m_Value">Important Public Members of the <tt>Value</tt> class</a>
3331 </div>
3332
3333 <div class="doc_text">
3334
3335 <ul>
3336   <li><tt>Value::use_iterator</tt> - Typedef for iterator over the
3337 use-list<br>
3338     <tt>Value::const_use_iterator</tt> - Typedef for const_iterator over
3339 the use-list<br>
3340     <tt>unsigned use_size()</tt> - Returns the number of users of the
3341 value.<br>
3342     <tt>bool use_empty()</tt> - Returns true if there are no users.<br>
3343     <tt>use_iterator use_begin()</tt> - Get an iterator to the start of
3344 the use-list.<br>
3345     <tt>use_iterator use_end()</tt> - Get an iterator to the end of the
3346 use-list.<br>
3347     <tt><a href="#User">User</a> *use_back()</tt> - Returns the last
3348 element in the list.
3349     <p> These methods are the interface to access the def-use
3350 information in LLVM.  As with all other iterators in LLVM, the naming
3351 conventions follow the conventions defined by the <a href="#stl">STL</a>.</p>
3352   </li>
3353   <li><tt><a href="#Type">Type</a> *getType() const</tt>
3354     <p>This method returns the Type of the Value.</p>
3355   </li>
3356   <li><tt>bool hasName() const</tt><br>
3357     <tt>std::string getName() const</tt><br>
3358     <tt>void setName(const std::string &amp;Name)</tt>
3359     <p> This family of methods is used to access and assign a name to a <tt>Value</tt>,
3360 be aware of the <a href="#nameWarning">precaution above</a>.</p>
3361   </li>
3362   <li><tt>void replaceAllUsesWith(Value *V)</tt>
3363
3364     <p>This method traverses the use list of a <tt>Value</tt> changing all <a
3365     href="#User"><tt>User</tt>s</a> of the current value to refer to
3366     "<tt>V</tt>" instead.  For example, if you detect that an instruction always
3367     produces a constant value (for example through constant folding), you can
3368     replace all uses of the instruction with the constant like this:</p>
3369
3370 <div class="doc_code">
3371 <pre>
3372 Inst-&gt;replaceAllUsesWith(ConstVal);
3373 </pre>
3374 </div>
3375
3376 </ul>
3377
3378 </div>
3379
3380 <!-- ======================================================================= -->
3381 <div class="doc_subsection">
3382   <a name="User">The <tt>User</tt> class</a>
3383 </div>
3384
3385 <div class="doc_text">
3386
3387 <p>
3388 <tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br>
3389 doxygen info: <a href="/doxygen/classllvm_1_1User.html">User Class</a><br>
3390 Superclass: <a href="#Value"><tt>Value</tt></a></p>
3391
3392 <p>The <tt>User</tt> class is the common base class of all LLVM nodes that may
3393 refer to <a href="#Value"><tt>Value</tt></a>s.  It exposes a list of "Operands"
3394 that are all of the <a href="#Value"><tt>Value</tt></a>s that the User is
3395 referring to.  The <tt>User</tt> class itself is a subclass of
3396 <tt>Value</tt>.</p>
3397
3398 <p>The operands of a <tt>User</tt> point directly to the LLVM <a
3399 href="#Value"><tt>Value</tt></a> that it refers to.  Because LLVM uses Static
3400 Single Assignment (SSA) form, there can only be one definition referred to,
3401 allowing this direct connection.  This connection provides the use-def
3402 information in LLVM.</p>
3403
3404 </div>
3405
3406 <!-- _______________________________________________________________________ -->
3407 <div class="doc_subsubsection">
3408   <a name="m_User">Important Public Members of the <tt>User</tt> class</a>
3409 </div>
3410
3411 <div class="doc_text">
3412
3413 <p>The <tt>User</tt> class exposes the operand list in two ways: through
3414 an index access interface and through an iterator based interface.</p>
3415
3416 <ul>
3417   <li><tt>Value *getOperand(unsigned i)</tt><br>
3418     <tt>unsigned getNumOperands()</tt>
3419     <p> These two methods expose the operands of the <tt>User</tt> in a
3420 convenient form for direct access.</p></li>
3421
3422   <li><tt>User::op_iterator</tt> - Typedef for iterator over the operand
3423 list<br>
3424     <tt>op_iterator op_begin()</tt> - Get an iterator to the start of
3425 the operand list.<br>
3426     <tt>op_iterator op_end()</tt> - Get an iterator to the end of the
3427 operand list.
3428     <p> Together, these methods make up the iterator based interface to
3429 the operands of a <tt>User</tt>.</p></li>
3430 </ul>
3431
3432 </div>
3433
3434 <!-- ======================================================================= -->
3435 <div class="doc_subsection">
3436   <a name="Instruction">The <tt>Instruction</tt> class</a>
3437 </div>
3438
3439 <div class="doc_text">
3440
3441 <p><tt>#include "</tt><tt><a
3442 href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br>
3443 doxygen info: <a href="/doxygen/classllvm_1_1Instruction.html">Instruction Class</a><br>
3444 Superclasses: <a href="#User"><tt>User</tt></a>, <a
3445 href="#Value"><tt>Value</tt></a></p>
3446
3447 <p>The <tt>Instruction</tt> class is the common base class for all LLVM
3448 instructions.  It provides only a few methods, but is a very commonly used
3449 class.  The primary data tracked by the <tt>Instruction</tt> class itself is the
3450 opcode (instruction type) and the parent <a
3451 href="#BasicBlock"><tt>BasicBlock</tt></a> the <tt>Instruction</tt> is embedded
3452 into.  To represent a specific type of instruction, one of many subclasses of
3453 <tt>Instruction</tt> are used.</p>
3454
3455 <p> Because the <tt>Instruction</tt> class subclasses the <a
3456 href="#User"><tt>User</tt></a> class, its operands can be accessed in the same
3457 way as for other <a href="#User"><tt>User</tt></a>s (with the
3458 <tt>getOperand()</tt>/<tt>getNumOperands()</tt> and
3459 <tt>op_begin()</tt>/<tt>op_end()</tt> methods).</p> <p> An important file for
3460 the <tt>Instruction</tt> class is the <tt>llvm/Instruction.def</tt> file. This
3461 file contains some meta-data about the various different types of instructions
3462 in LLVM.  It describes the enum values that are used as opcodes (for example
3463 <tt>Instruction::Add</tt> and <tt>Instruction::ICmp</tt>), as well as the
3464 concrete sub-classes of <tt>Instruction</tt> that implement the instruction (for
3465 example <tt><a href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
3466 href="#CmpInst">CmpInst</a></tt>).  Unfortunately, the use of macros in
3467 this file confuses doxygen, so these enum values don't show up correctly in the
3468 <a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p>
3469
3470 </div>
3471
3472 <!-- _______________________________________________________________________ -->
3473 <div class="doc_subsubsection">
3474   <a name="s_Instruction">Important Subclasses of the <tt>Instruction</tt>
3475   class</a>
3476 </div>
3477 <div class="doc_text">
3478   <ul>
3479     <li><tt><a name="BinaryOperator">BinaryOperator</a></tt>
3480     <p>This subclasses represents all two operand instructions whose operands
3481     must be the same type, except for the comparison instructions.</p></li>
3482     <li><tt><a name="CastInst">CastInst</a></tt>
3483     <p>This subclass is the parent of the 12 casting instructions. It provides
3484     common operations on cast instructions.</p>
3485     <li><tt><a name="CmpInst">CmpInst</a></tt>
3486     <p>This subclass respresents the two comparison instructions,
3487     <a href="LangRef.html#i_icmp">ICmpInst</a> (integer opreands), and
3488     <a href="LangRef.html#i_fcmp">FCmpInst</a> (floating point operands).</p>
3489     <li><tt><a name="TerminatorInst">TerminatorInst</a></tt>
3490     <p>This subclass is the parent of all terminator instructions (those which
3491     can terminate a block).</p>
3492   </ul>
3493   </div>
3494
3495 <!-- _______________________________________________________________________ -->
3496 <div class="doc_subsubsection">
3497   <a name="m_Instruction">Important Public Members of the <tt>Instruction</tt>
3498   class</a>
3499 </div>
3500
3501 <div class="doc_text">
3502
3503 <ul>
3504   <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt>
3505     <p>Returns the <a href="#BasicBlock"><tt>BasicBlock</tt></a> that
3506 this  <tt>Instruction</tt> is embedded into.</p></li>
3507   <li><tt>bool mayWriteToMemory()</tt>
3508     <p>Returns true if the instruction writes to memory, i.e. it is a
3509       <tt>call</tt>,<tt>free</tt>,<tt>invoke</tt>, or <tt>store</tt>.</p></li>
3510   <li><tt>unsigned getOpcode()</tt>
3511     <p>Returns the opcode for the <tt>Instruction</tt>.</p></li>
3512   <li><tt><a href="#Instruction">Instruction</a> *clone() const</tt>
3513     <p>Returns another instance of the specified instruction, identical
3514 in all ways to the original except that the instruction has no parent
3515 (ie it's not embedded into a <a href="#BasicBlock"><tt>BasicBlock</tt></a>),
3516 and it has no name</p></li>
3517 </ul>
3518
3519 </div>
3520
3521 <!-- ======================================================================= -->
3522 <div class="doc_subsection">
3523   <a name="Constant">The <tt>Constant</tt> class and subclasses</a>
3524 </div>
3525
3526 <div class="doc_text">
3527
3528 <p>Constant represents a base class for different types of constants. It
3529 is subclassed by ConstantInt, ConstantArray, etc. for representing
3530 the various types of Constants.  <a href="#GlobalValue">GlobalValue</a> is also
3531 a subclass, which represents the address of a global variable or function.
3532 </p>
3533
3534 </div>
3535
3536 <!-- _______________________________________________________________________ -->
3537 <div class="doc_subsubsection">Important Subclasses of Constant </div>
3538 <div class="doc_text">
3539 <ul>
3540   <li>ConstantInt : This subclass of Constant represents an integer constant of
3541   any width.
3542     <ul>
3543       <li><tt>const APInt&amp; getValue() const</tt>: Returns the underlying
3544       value of this constant, an APInt value.</li>
3545       <li><tt>int64_t getSExtValue() const</tt>: Converts the underlying APInt
3546       value to an int64_t via sign extension. If the value (not the bit width)
3547       of the APInt is too large to fit in an int64_t, an assertion will result.
3548       For this reason, use of this method is discouraged.</li>
3549       <li><tt>uint64_t getZExtValue() const</tt>: Converts the underlying APInt
3550       value to a uint64_t via zero extension. IF the value (not the bit width)
3551       of the APInt is too large to fit in a uint64_t, an assertion will result.
3552       For this reason, use of this method is discouraged.</li>
3553       <li><tt>static ConstantInt* get(const APInt&amp; Val)</tt>: Returns the
3554       ConstantInt object that represents the value provided by <tt>Val</tt>.
3555       The type is implied as the IntegerType that corresponds to the bit width
3556       of <tt>Val</tt>.</li>
3557       <li><tt>static ConstantInt* get(const Type *Ty, uint64_t Val)</tt>:
3558       Returns the ConstantInt object that represents the value provided by
3559       <tt>Val</tt> for integer type <tt>Ty</tt>.</li>
3560     </ul>
3561   </li>
3562   <li>ConstantFP : This class represents a floating point constant.
3563     <ul>
3564       <li><tt>double getValue() const</tt>: Returns the underlying value of
3565       this constant. </li>
3566     </ul>
3567   </li>
3568   <li>ConstantArray : This represents a constant array.
3569     <ul>
3570       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
3571       a vector of component constants that makeup this array. </li>
3572     </ul>
3573   </li>
3574   <li>ConstantStruct : This represents a constant struct.
3575     <ul>
3576       <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
3577       a vector of component constants that makeup this array. </li>
3578     </ul>
3579   </li>
3580   <li>GlobalValue : This represents either a global variable or a function. In
3581   either case, the value is a constant fixed address (after linking).
3582   </li>
3583 </ul>
3584 </div>
3585
3586
3587 <!-- ======================================================================= -->
3588 <div class="doc_subsection">
3589   <a name="GlobalValue">The <tt>GlobalValue</tt> class</a>
3590 </div>
3591
3592 <div class="doc_text">
3593
3594 <p><tt>#include "<a
3595 href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
3596 doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
3597 Class</a><br>
3598 Superclasses: <a href="#Constant"><tt>Constant</tt></a>,
3599 <a href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
3600
3601 <p>Global values (<a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
3602 href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
3603 visible in the bodies of all <a href="#Function"><tt>Function</tt></a>s.
3604 Because they are visible at global scope, they are also subject to linking with
3605 other globals defined in different translation units.  To control the linking
3606 process, <tt>GlobalValue</tt>s know their linkage rules. Specifically,
3607 <tt>GlobalValue</tt>s know whether they have internal or external linkage, as
3608 defined by the <tt>LinkageTypes</tt> enumeration.</p>
3609
3610 <p>If a <tt>GlobalValue</tt> has internal linkage (equivalent to being
3611 <tt>static</tt> in C), it is not visible to code outside the current translation
3612 unit, and does not participate in linking.  If it has external linkage, it is
3613 visible to external code, and does participate in linking.  In addition to
3614 linkage information, <tt>GlobalValue</tt>s keep track of which <a
3615 href="#Module"><tt>Module</tt></a> they are currently part of.</p>
3616
3617 <p>Because <tt>GlobalValue</tt>s are memory objects, they are always referred to
3618 by their <b>address</b>. As such, the <a href="#Type"><tt>Type</tt></a> of a
3619 global is always a pointer to its contents. It is important to remember this
3620 when using the <tt>GetElementPtrInst</tt> instruction because this pointer must
3621 be dereferenced first. For example, if you have a <tt>GlobalVariable</tt> (a
3622 subclass of <tt>GlobalValue)</tt> that is an array of 24 ints, type <tt>[24 x
3623 i32]</tt>, then the <tt>GlobalVariable</tt> is a pointer to that array. Although
3624 the address of the first element of this array and the value of the
3625 <tt>GlobalVariable</tt> are the same, they have different types. The
3626 <tt>GlobalVariable</tt>'s type is <tt>[24 x i32]</tt>. The first element's type
3627 is <tt>i32.</tt> Because of this, accessing a global value requires you to
3628 dereference the pointer with <tt>GetElementPtrInst</tt> first, then its elements
3629 can be accessed. This is explained in the <a href="LangRef.html#globalvars">LLVM
3630 Language Reference Manual</a>.</p>
3631
3632 </div>
3633
3634 <!-- _______________________________________________________________________ -->
3635 <div class="doc_subsubsection">
3636   <a name="m_GlobalValue">Important Public Members of the <tt>GlobalValue</tt>
3637   class</a>
3638 </div>
3639
3640 <div class="doc_text">
3641
3642 <ul>
3643   <li><tt>bool hasInternalLinkage() const</tt><br>
3644     <tt>bool hasExternalLinkage() const</tt><br>
3645     <tt>void setInternalLinkage(bool HasInternalLinkage)</tt>
3646     <p> These methods manipulate the linkage characteristics of the <tt>GlobalValue</tt>.</p>
3647     <p> </p>
3648   </li>
3649   <li><tt><a href="#Module">Module</a> *getParent()</tt>
3650     <p> This returns the <a href="#Module"><tt>Module</tt></a> that the
3651 GlobalValue is currently embedded into.</p></li>
3652 </ul>
3653
3654 </div>
3655
3656 <!-- ======================================================================= -->
3657 <div class="doc_subsection">
3658   <a name="Function">The <tt>Function</tt> class</a>
3659 </div>
3660
3661 <div class="doc_text">
3662
3663 <p><tt>#include "<a
3664 href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
3665 info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
3666 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
3667 <a href="#Constant"><tt>Constant</tt></a>,
3668 <a href="#User"><tt>User</tt></a>,
3669 <a href="#Value"><tt>Value</tt></a></p>
3670
3671 <p>The <tt>Function</tt> class represents a single procedure in LLVM.  It is
3672 actually one of the more complex classes in the LLVM hierarchy because it must
3673 keep track of a large amount of data.  The <tt>Function</tt> class keeps track
3674 of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal
3675 <a href="#Argument"><tt>Argument</tt></a>s, and a
3676 <a href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
3677
3678 <p>The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most
3679 commonly used part of <tt>Function</tt> objects.  The list imposes an implicit
3680 ordering of the blocks in the function, which indicate how the code will be
3681 laid out by the backend.  Additionally, the first <a
3682 href="#BasicBlock"><tt>BasicBlock</tt></a> is the implicit entry node for the
3683 <tt>Function</tt>.  It is not legal in LLVM to explicitly branch to this initial
3684 block.  There are no implicit exit nodes, and in fact there may be multiple exit
3685 nodes from a single <tt>Function</tt>.  If the <a
3686 href="#BasicBlock"><tt>BasicBlock</tt></a> list is empty, this indicates that
3687 the <tt>Function</tt> is actually a function declaration: the actual body of the
3688 function hasn't been linked in yet.</p>
3689
3690 <p>In addition to a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, the
3691 <tt>Function</tt> class also keeps track of the list of formal <a
3692 href="#Argument"><tt>Argument</tt></a>s that the function receives.  This
3693 container manages the lifetime of the <a href="#Argument"><tt>Argument</tt></a>
3694 nodes, just like the <a href="#BasicBlock"><tt>BasicBlock</tt></a> list does for
3695 the <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.</p>
3696
3697 <p>The <a href="#SymbolTable"><tt>SymbolTable</tt></a> is a very rarely used
3698 LLVM feature that is only used when you have to look up a value by name.  Aside
3699 from that, the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is used
3700 internally to make sure that there are not conflicts between the names of <a
3701 href="#Instruction"><tt>Instruction</tt></a>s, <a
3702 href="#BasicBlock"><tt>BasicBlock</tt></a>s, or <a
3703 href="#Argument"><tt>Argument</tt></a>s in the function body.</p>
3704
3705 <p>Note that <tt>Function</tt> is a <a href="#GlobalValue">GlobalValue</a>
3706 and therefore also a <a href="#Constant">Constant</a>. The value of the function
3707 is its address (after linking) which is guaranteed to be constant.</p>
3708 </div>
3709
3710 <!-- _______________________________________________________________________ -->
3711 <div class="doc_subsubsection">
3712   <a name="m_Function">Important Public Members of the <tt>Function</tt>
3713   class</a>
3714 </div>
3715
3716 <div class="doc_text">
3717
3718 <ul>
3719   <li><tt>Function(const </tt><tt><a href="#FunctionType">FunctionType</a>
3720   *Ty, LinkageTypes Linkage, const std::string &amp;N = "", Module* Parent = 0)</tt>
3721
3722     <p>Constructor used when you need to create new <tt>Function</tt>s to add
3723     the the program.  The constructor must specify the type of the function to
3724     create and what type of linkage the function should have. The <a
3725     href="#FunctionType"><tt>FunctionType</tt></a> argument
3726     specifies the formal arguments and return value for the function. The same
3727     <a href="#FunctionType"><tt>FunctionType</tt></a> value can be used to
3728     create multiple functions. The <tt>Parent</tt> argument specifies the Module
3729     in which the function is defined. If this argument is provided, the function
3730     will automatically be inserted into that module's list of
3731     functions.</p></li>
3732
3733   <li><tt>bool isDeclaration()</tt>
3734
3735     <p>Return whether or not the <tt>Function</tt> has a body defined.  If the
3736     function is "external", it does not have a body, and thus must be resolved
3737     by linking with a function defined in a different translation unit.</p></li>
3738
3739   <li><tt>Function::iterator</tt> - Typedef for basic block list iterator<br>
3740     <tt>Function::const_iterator</tt> - Typedef for const_iterator.<br>
3741
3742     <tt>begin()</tt>, <tt>end()</tt>
3743     <tt>size()</tt>, <tt>empty()</tt>
3744
3745     <p>These are forwarding methods that make it easy to access the contents of
3746     a <tt>Function</tt> object's <a href="#BasicBlock"><tt>BasicBlock</tt></a>
3747     list.</p></li>
3748
3749   <li><tt>Function::BasicBlockListType &amp;getBasicBlockList()</tt>
3750
3751     <p>Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.  This
3752     is necessary to use when you need to update the list or perform a complex
3753     action that doesn't have a forwarding method.</p></li>
3754
3755   <li><tt>Function::arg_iterator</tt> - Typedef for the argument list
3756 iterator<br>
3757     <tt>Function::const_arg_iterator</tt> - Typedef for const_iterator.<br>
3758
3759     <tt>arg_begin()</tt>, <tt>arg_end()</tt>
3760     <tt>arg_size()</tt>, <tt>arg_empty()</tt>
3761
3762     <p>These are forwarding methods that make it easy to access the contents of
3763     a <tt>Function</tt> object's <a href="#Argument"><tt>Argument</tt></a>
3764     list.</p></li>
3765
3766   <li><tt>Function::ArgumentListType &amp;getArgumentList()</tt>
3767
3768     <p>Returns the list of <a href="#Argument"><tt>Argument</tt></a>s.  This is
3769     necessary to use when you need to update the list or perform a complex
3770     action that doesn't have a forwarding method.</p></li>
3771
3772   <li><tt><a href="#BasicBlock">BasicBlock</a> &amp;getEntryBlock()</tt>
3773
3774     <p>Returns the entry <a href="#BasicBlock"><tt>BasicBlock</tt></a> for the
3775     function.  Because the entry block for the function is always the first
3776     block, this returns the first block of the <tt>Function</tt>.</p></li>
3777
3778   <li><tt><a href="#Type">Type</a> *getReturnType()</tt><br>
3779     <tt><a href="#FunctionType">FunctionType</a> *getFunctionType()</tt>
3780
3781     <p>This traverses the <a href="#Type"><tt>Type</tt></a> of the
3782     <tt>Function</tt> and returns the return type of the function, or the <a
3783     href="#FunctionType"><tt>FunctionType</tt></a> of the actual
3784     function.</p></li>
3785
3786   <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
3787
3788     <p> Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
3789     for this <tt>Function</tt>.</p></li>
3790 </ul>
3791
3792 </div>
3793
3794 <!-- ======================================================================= -->
3795 <div class="doc_subsection">
3796   <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a>
3797 </div>
3798
3799 <div class="doc_text">
3800
3801 <p><tt>#include "<a
3802 href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt>
3803 <br>
3804 doxygen info: <a href="/doxygen/classllvm_1_1GlobalVariable.html">GlobalVariable
3805  Class</a><br>
3806 Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
3807 <a href="#Constant"><tt>Constant</tt></a>,
3808 <a href="#User"><tt>User</tt></a>,
3809 <a href="#Value"><tt>Value</tt></a></p>
3810
3811 <p>Global variables are represented with the (surprise surprise)
3812 <tt>GlobalVariable</tt> class. Like functions, <tt>GlobalVariable</tt>s are also
3813 subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such are
3814 always referenced by their address (global values must live in memory, so their
3815 "name" refers to their constant address). See
3816 <a href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this.  Global
3817 variables may have an initial value (which must be a
3818 <a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer,
3819 they may be marked as "constant" themselves (indicating that their contents
3820 never change at runtime).</p>
3821 </div>
3822
3823 <!-- _______________________________________________________________________ -->
3824 <div class="doc_subsubsection">
3825   <a name="m_GlobalVariable">Important Public Members of the
3826   <tt>GlobalVariable</tt> class</a>
3827 </div>
3828
3829 <div class="doc_text">
3830
3831 <ul>
3832   <li><tt>GlobalVariable(const </tt><tt><a href="#Type">Type</a> *Ty, bool
3833   isConstant, LinkageTypes&amp; Linkage, <a href="#Constant">Constant</a>
3834   *Initializer = 0, const std::string &amp;Name = "", Module* Parent = 0)</tt>
3835
3836     <p>Create a new global variable of the specified type. If
3837     <tt>isConstant</tt> is true then the global variable will be marked as
3838     unchanging for the program. The Linkage parameter specifies the type of
3839     linkage (internal, external, weak, linkonce, appending) for the variable.
3840     If the linkage is InternalLinkage, WeakAnyLinkage, WeakODRLinkage,
3841     LinkOnceAnyLinkage or LinkOnceODRLinkage,&nbsp; then the resultant
3842     global variable will have internal linkage.  AppendingLinkage concatenates
3843     together all instances (in different translation units) of the variable
3844     into a single variable but is only applicable to arrays.  &nbsp;See
3845     the <a href="LangRef.html#modulestructure">LLVM Language Reference</a> for
3846     further details on linkage types. Optionally an initializer, a name, and the
3847     module to put the variable into may be specified for the global variable as
3848     well.</p></li>
3849
3850   <li><tt>bool isConstant() const</tt>
3851
3852     <p>Returns true if this is a global variable that is known not to
3853     be modified at runtime.</p></li>
3854
3855   <li><tt>bool hasInitializer()</tt>
3856
3857     <p>Returns true if this <tt>GlobalVariable</tt> has an intializer.</p></li>
3858
3859   <li><tt><a href="#Constant">Constant</a> *getInitializer()</tt>
3860
3861     <p>Returns the initial value for a <tt>GlobalVariable</tt>.  It is not legal
3862     to call this method if there is no initializer.</p></li>
3863 </ul>
3864
3865 </div>
3866
3867
3868 <!-- ======================================================================= -->
3869 <div class="doc_subsection">
3870   <a name="BasicBlock">The <tt>BasicBlock</tt> class</a>
3871 </div>
3872
3873 <div class="doc_text">
3874
3875 <p><tt>#include "<a
3876 href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
3877 doxygen info: <a href="/doxygen/classllvm_1_1BasicBlock.html">BasicBlock
3878 Class</a><br>
3879 Superclass: <a href="#Value"><tt>Value</tt></a></p>
3880
3881 <p>This class represents a single entry single exit section of the code,
3882 commonly known as a basic block by the compiler community.  The
3883 <tt>BasicBlock</tt> class maintains a list of <a
3884 href="#Instruction"><tt>Instruction</tt></a>s, which form the body of the block.
3885 Matching the language definition, the last element of this list of instructions
3886 is always a terminator instruction (a subclass of the <a
3887 href="#TerminatorInst"><tt>TerminatorInst</tt></a> class).</p>
3888
3889 <p>In addition to tracking the list of instructions that make up the block, the
3890 <tt>BasicBlock</tt> class also keeps track of the <a
3891 href="#Function"><tt>Function</tt></a> that it is embedded into.</p>
3892
3893 <p>Note that <tt>BasicBlock</tt>s themselves are <a
3894 href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions
3895 like branches and can go in the switch tables. <tt>BasicBlock</tt>s have type
3896 <tt>label</tt>.</p>
3897
3898 </div>
3899
3900 <!-- _______________________________________________________________________ -->
3901 <div class="doc_subsubsection">
3902   <a name="m_BasicBlock">Important Public Members of the <tt>BasicBlock</tt>
3903   class</a>
3904 </div>
3905
3906 <div class="doc_text">
3907 <ul>
3908
3909 <li><tt>BasicBlock(const std::string &amp;Name = "", </tt><tt><a
3910  href="#Function">Function</a> *Parent = 0)</tt>
3911
3912 <p>The <tt>BasicBlock</tt> constructor is used to create new basic blocks for
3913 insertion into a function.  The constructor optionally takes a name for the new
3914 block, and a <a href="#Function"><tt>Function</tt></a> to insert it into.  If
3915 the <tt>Parent</tt> parameter is specified, the new <tt>BasicBlock</tt> is
3916 automatically inserted at the end of the specified <a
3917 href="#Function"><tt>Function</tt></a>, if not specified, the BasicBlock must be
3918 manually inserted into the <a href="#Function"><tt>Function</tt></a>.</p></li>
3919
3920 <li><tt>BasicBlock::iterator</tt> - Typedef for instruction list iterator<br>
3921 <tt>BasicBlock::const_iterator</tt> - Typedef for const_iterator.<br>
3922 <tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
3923 <tt>size()</tt>, <tt>empty()</tt>
3924 STL-style functions for accessing the instruction list.
3925
3926 <p>These methods and typedefs are forwarding functions that have the same
3927 semantics as the standard library methods of the same names.  These methods
3928 expose the underlying instruction list of a basic block in a way that is easy to
3929 manipulate.  To get the full complement of container operations (including
3930 operations to update the list), you must use the <tt>getInstList()</tt>
3931 method.</p></li>
3932
3933 <li><tt>BasicBlock::InstListType &amp;getInstList()</tt>
3934
3935 <p>This method is used to get access to the underlying container that actually
3936 holds the Instructions.  This method must be used when there isn't a forwarding
3937 function in the <tt>BasicBlock</tt> class for the operation that you would like
3938 to perform.  Because there are no forwarding functions for "updating"
3939 operations, you need to use this if you want to update the contents of a
3940 <tt>BasicBlock</tt>.</p></li>
3941
3942 <li><tt><a href="#Function">Function</a> *getParent()</tt>
3943
3944 <p> Returns a pointer to <a href="#Function"><tt>Function</tt></a> the block is
3945 embedded into, or a null pointer if it is homeless.</p></li>
3946
3947 <li><tt><a href="#TerminatorInst">TerminatorInst</a> *getTerminator()</tt>
3948
3949 <p> Returns a pointer to the terminator instruction that appears at the end of
3950 the <tt>BasicBlock</tt>.  If there is no terminator instruction, or if the last
3951 instruction in the block is not a terminator, then a null pointer is
3952 returned.</p></li>
3953
3954 </ul>
3955
3956 </div>
3957
3958
3959 <!-- ======================================================================= -->
3960 <div class="doc_subsection">
3961   <a name="Argument">The <tt>Argument</tt> class</a>
3962 </div>
3963
3964 <div class="doc_text">
3965
3966 <p>This subclass of Value defines the interface for incoming formal
3967 arguments to a function. A Function maintains a list of its formal
3968 arguments. An argument has a pointer to the parent Function.</p>
3969
3970 </div>
3971
3972 <!-- *********************************************************************** -->
3973 <hr>
3974 <address>
3975   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
3976   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
3977   <a href="http://validator.w3.org/check/referer"><img
3978   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Strict"></a>
3979
3980   <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and
3981   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
3982   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
3983   Last modified: $Date$
3984 </address>
3985
3986 </body>
3987 </html>