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