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