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