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