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