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