[CMake] Allow overriding MSVC_DIA_SDK_DIR via CMake
[llvm-core.git] / docs / ProgrammersManual.rst
bloba96f8b4b714ca58b123666898ba6a7349fee0711
1 ========================
2 LLVM Programmer's Manual
3 ========================
5 .. contents::
6    :local:
8 .. warning::
9    This is always a work in progress.
11 .. _introduction:
13 Introduction
14 ============
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.
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.
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.
37 .. _general:
39 General Information
40 ===================
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.
45 .. _stl:
47 The C++ Standard Template Library
48 ---------------------------------
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.
56 Here are some useful links:
58 #. `cppreference.com
59    <http://en.cppreference.com/w/>`_ - an excellent
60    reference for the STL and other parts of the standard C++ library.
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.
67 #. `C++ Frequently Asked Questions <http://www.parashift.com/c++-faq-lite/>`_.
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>`_.
73 #. `Bjarne Stroustrup's C++ Page
74    <http://www.research.att.com/%7Ebs/C++.html>`_.
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>`_.
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.
84 .. _resources:
86 Other useful references
87 -----------------------
89 #. `Using static and shared libraries across platforms
90    <http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html>`_
92 .. _apis:
94 Important and useful LLVM APIs
95 ==============================
97 Here we highlight some LLVM APIs that are generally useful and good to know
98 about when writing transformations.
100 .. _isa:
102 The ``isa<>``, ``cast<>`` and ``dyn_cast<>`` templates
103 ------------------------------------------------------
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).
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).
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:
128   .. code-block:: c++
130     static bool isLoopInvariant(const Value *V, const Loop *L) {
131       if (isa<Constant>(V) || isa<Argument>(V) || isa<GlobalValue>(V))
132         return true;
134       // Otherwise, it must be an instruction...
135       return !L->contains(cast<Instruction>(V)->getParent());
136     }
138   Note that you should **not** use an ``isa<>`` test followed by a ``cast<>``,
139   for that use the ``dyn_cast<>`` operator.
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:
150   .. code-block:: c++
152     if (auto *AI = dyn_cast<AllocationInst>(Val)) {
153       // ...
154     }
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.
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.
167 ``isa_and_nonnull<>``:
168   The ``isa_and_nonnull<>`` operator works just like the ``isa<>`` operator,
169   except that it allows for a null pointer as an argument (which it then
170   returns false).  This can sometimes be useful, allowing you to combine several
171   null checks into one.
173 ``cast_or_null<>``:
174   The ``cast_or_null<>`` operator works just like the ``cast<>`` operator,
175   except that it allows for a null pointer as an argument (which it then
176   propagates).  This can sometimes be useful, allowing you to combine several
177   null checks into one.
179 ``dyn_cast_or_null<>``:
180   The ``dyn_cast_or_null<>`` operator works just like the ``dyn_cast<>``
181   operator, except that it allows for a null pointer as an argument (which it
182   then propagates).  This can sometimes be useful, allowing you to combine
183   several null checks into one.
185 These five templates can be used with any classes, whether they have a v-table
186 or not.  If you want to add support for these templates, see the document
187 :doc:`How to set up LLVM-style RTTI for your class hierarchy
188 <HowToSetUpLLVMStyleRTTI>`
190 .. _string_apis:
192 Passing strings (the ``StringRef`` and ``Twine`` classes)
193 ---------------------------------------------------------
195 Although LLVM generally does not do much string manipulation, we do have several
196 important APIs which take strings.  Two important examples are the Value class
197 -- which has names for instructions, functions, etc. -- and the ``StringMap``
198 class which is used extensively in LLVM and Clang.
200 These are generic classes, and they need to be able to accept strings which may
201 have embedded null characters.  Therefore, they cannot simply take a ``const
202 char *``, and taking a ``const std::string&`` requires clients to perform a heap
203 allocation which is usually unnecessary.  Instead, many LLVM APIs use a
204 ``StringRef`` or a ``const Twine&`` for passing strings efficiently.
206 .. _StringRef:
208 The ``StringRef`` class
209 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
211 The ``StringRef`` data type represents a reference to a constant string (a
212 character array and a length) and supports the common operations available on
213 ``std::string``, but does not require heap allocation.
215 It can be implicitly constructed using a C style null-terminated string, an
216 ``std::string``, or explicitly with a character pointer and length.  For
217 example, the ``StringRef`` find function is declared as:
219 .. code-block:: c++
221   iterator find(StringRef Key);
223 and clients can call it using any one of:
225 .. code-block:: c++
227   Map.find("foo");                 // Lookup "foo"
228   Map.find(std::string("bar"));    // Lookup "bar"
229   Map.find(StringRef("\0baz", 4)); // Lookup "\0baz"
231 Similarly, APIs which need to return a string may return a ``StringRef``
232 instance, which can be used directly or converted to an ``std::string`` using
233 the ``str`` member function.  See ``llvm/ADT/StringRef.h`` (`doxygen
234 <http://llvm.org/doxygen/StringRef_8h_source.html>`__) for more
235 information.
237 You should rarely use the ``StringRef`` class directly, because it contains
238 pointers to external memory it is not generally safe to store an instance of the
239 class (unless you know that the external storage will not be freed).
240 ``StringRef`` is small and pervasive enough in LLVM that it should always be
241 passed by value.
243 The ``Twine`` class
244 ^^^^^^^^^^^^^^^^^^^
246 The ``Twine`` (`doxygen <http://llvm.org/doxygen/classllvm_1_1Twine.html>`__)
247 class is an efficient way for APIs to accept concatenated strings.  For example,
248 a common LLVM paradigm is to name one instruction based on the name of another
249 instruction with a suffix, for example:
251 .. code-block:: c++
253     New = CmpInst::Create(..., SO->getName() + ".cmp");
255 The ``Twine`` class is effectively a lightweight `rope
256 <http://en.wikipedia.org/wiki/Rope_(computer_science)>`_ which points to
257 temporary (stack allocated) objects.  Twines can be implicitly constructed as
258 the result of the plus operator applied to strings (i.e., a C strings, an
259 ``std::string``, or a ``StringRef``).  The twine delays the actual concatenation
260 of strings until it is actually required, at which point it can be efficiently
261 rendered directly into a character array.  This avoids unnecessary heap
262 allocation involved in constructing the temporary results of string
263 concatenation.  See ``llvm/ADT/Twine.h`` (`doxygen
264 <http://llvm.org/doxygen/Twine_8h_source.html>`__) and :ref:`here <dss_twine>`
265 for more information.
267 As with a ``StringRef``, ``Twine`` objects point to external memory and should
268 almost never be stored or mentioned directly.  They are intended solely for use
269 when defining a function which should be able to efficiently accept concatenated
270 strings.
272 .. _formatting_strings:
274 Formatting strings (the ``formatv`` function)
275 ---------------------------------------------
276 While LLVM doesn't necessarily do a lot of string manipulation and parsing, it
277 does do a lot of string formatting.  From diagnostic messages, to llvm tool
278 outputs such as ``llvm-readobj`` to printing verbose disassembly listings and
279 LLDB runtime logging, the need for string formatting is pervasive.
281 The ``formatv`` is similar in spirit to ``printf``, but uses a different syntax
282 which borrows heavily from Python and C#.  Unlike ``printf`` it deduces the type
283 to be formatted at compile time, so it does not need a format specifier such as
284 ``%d``.  This reduces the mental overhead of trying to construct portable format
285 strings, especially for platform-specific types like ``size_t`` or pointer types.
286 Unlike both ``printf`` and Python, it additionally fails to compile if LLVM does
287 not know how to format the type.  These two properties ensure that the function
288 is both safer and simpler to use than traditional formatting methods such as 
289 the ``printf`` family of functions.
291 Simple formatting
292 ^^^^^^^^^^^^^^^^^
294 A call to ``formatv`` involves a single **format string** consisting of 0 or more
295 **replacement sequences**, followed by a variable length list of **replacement values**.
296 A replacement sequence is a string of the form ``{N[[,align]:style]}``.
298 ``N`` refers to the 0-based index of the argument from the list of replacement
299 values.  Note that this means it is possible to reference the same parameter
300 multiple times, possibly with different style and/or alignment options, in any order.
302 ``align`` is an optional string specifying the width of the field to format
303 the value into, and the alignment of the value within the field.  It is specified as
304 an optional **alignment style** followed by a positive integral **field width**.  The
305 alignment style can be one of the characters ``-`` (left align), ``=`` (center align),
306 or ``+`` (right align).  The default is right aligned.  
308 ``style`` is an optional string consisting of a type specific that controls the
309 formatting of the value.  For example, to format a floating point value as a percentage,
310 you can use the style option ``P``.
312 Custom formatting
313 ^^^^^^^^^^^^^^^^^
315 There are two ways to customize the formatting behavior for a type.
317 1. Provide a template specialization of ``llvm::format_provider<T>`` for your
318    type ``T`` with the appropriate static format method.
320   .. code-block:: c++
321   
322     namespace llvm {
323       template<>
324       struct format_provider<MyFooBar> {
325         static void format(const MyFooBar &V, raw_ostream &Stream, StringRef Style) {
326           // Do whatever is necessary to format `V` into `Stream`
327         }
328       };
329       void foo() {
330         MyFooBar X;
331         std::string S = formatv("{0}", X);
332       }
333     }
334     
335   This is a useful extensibility mechanism for adding support for formatting your own
336   custom types with your own custom Style options.  But it does not help when you want
337   to extend the mechanism for formatting a type that the library already knows how to
338   format.  For that, we need something else.
339     
340 2. Provide a **format adapter** inheriting from ``llvm::FormatAdapter<T>``.
342   .. code-block:: c++
343   
344     namespace anything {
345       struct format_int_custom : public llvm::FormatAdapter<int> {
346         explicit format_int_custom(int N) : llvm::FormatAdapter<int>(N) {}
347         void format(llvm::raw_ostream &Stream, StringRef Style) override {
348           // Do whatever is necessary to format ``this->Item`` into ``Stream``
349         }
350       };
351     }
352     namespace llvm {
353       void foo() {
354         std::string S = formatv("{0}", anything::format_int_custom(42));
355       }
356     }
357     
358   If the type is detected to be derived from ``FormatAdapter<T>``, ``formatv``
359   will call the
360   ``format`` method on the argument passing in the specified style.  This allows
361   one to provide custom formatting of any type, including one which already has
362   a builtin format provider.
364 ``formatv`` Examples
365 ^^^^^^^^^^^^^^^^^^^^
366 Below is intended to provide an incomplete set of examples demonstrating
367 the usage of ``formatv``.  More information can be found by reading the
368 doxygen documentation or by looking at the unit test suite.
371 .. code-block:: c++
372   
373   std::string S;
374   // Simple formatting of basic types and implicit string conversion.
375   S = formatv("{0} ({1:P})", 7, 0.35);  // S == "7 (35.00%)"
376   
377   // Out-of-order referencing and multi-referencing
378   outs() << formatv("{0} {2} {1} {0}", 1, "test", 3); // prints "1 3 test 1"
379   
380   // Left, right, and center alignment
381   S = formatv("{0,7}",  'a');  // S == "      a";
382   S = formatv("{0,-7}", 'a');  // S == "a      ";
383   S = formatv("{0,=7}", 'a');  // S == "   a   ";
384   S = formatv("{0,+7}", 'a');  // S == "      a";
385   
386   // Custom styles
387   S = formatv("{0:N} - {0:x} - {1:E}", 12345, 123908342); // S == "12,345 - 0x3039 - 1.24E8"
388   
389   // Adapters
390   S = formatv("{0}", fmt_align(42, AlignStyle::Center, 7));  // S == "  42   "
391   S = formatv("{0}", fmt_repeat("hi", 3)); // S == "hihihi"
392   S = formatv("{0}", fmt_pad("hi", 2, 6)); // S == "  hi      "
393   
394   // Ranges
395   std::vector<int> V = {8, 9, 10};
396   S = formatv("{0}", make_range(V.begin(), V.end())); // S == "8, 9, 10"
397   S = formatv("{0:$[+]}", make_range(V.begin(), V.end())); // S == "8+9+10"
398   S = formatv("{0:$[ + ]@[x]}", make_range(V.begin(), V.end())); // S == "0x8 + 0x9 + 0xA"
400 .. _error_apis:
402 Error handling
403 --------------
405 Proper error handling helps us identify bugs in our code, and helps end-users
406 understand errors in their tool usage. Errors fall into two broad categories:
407 *programmatic* and *recoverable*, with different strategies for handling and
408 reporting.
410 Programmatic Errors
411 ^^^^^^^^^^^^^^^^^^^
413 Programmatic errors are violations of program invariants or API contracts, and
414 represent bugs within the program itself. Our aim is to document invariants, and
415 to abort quickly at the point of failure (providing some basic diagnostic) when
416 invariants are broken at runtime.
418 The fundamental tools for handling programmatic errors are assertions and the
419 llvm_unreachable function. Assertions are used to express invariant conditions,
420 and should include a message describing the invariant:
422 .. code-block:: c++
424   assert(isPhysReg(R) && "All virt regs should have been allocated already.");
426 The llvm_unreachable function can be used to document areas of control flow
427 that should never be entered if the program invariants hold:
429 .. code-block:: c++
431   enum { Foo, Bar, Baz } X = foo();
433   switch (X) {
434     case Foo: /* Handle Foo */; break;
435     case Bar: /* Handle Bar */; break;
436     default:
437       llvm_unreachable("X should be Foo or Bar here");
438   }
440 Recoverable Errors
441 ^^^^^^^^^^^^^^^^^^
443 Recoverable errors represent an error in the program's environment, for example
444 a resource failure (a missing file, a dropped network connection, etc.), or
445 malformed input. These errors should be detected and communicated to a level of
446 the program where they can be handled appropriately. Handling the error may be
447 as simple as reporting the issue to the user, or it may involve attempts at
448 recovery.
450 .. note::
452    While it would be ideal to use this error handling scheme throughout
453    LLVM, there are places where this hasn't been practical to apply. In
454    situations where you absolutely must emit a non-programmatic error and
455    the ``Error`` model isn't workable you can call ``report_fatal_error``,
456    which will call installed error handlers, print a message, and exit the
457    program.
459 Recoverable errors are modeled using LLVM's ``Error`` scheme. This scheme
460 represents errors using function return values, similar to classic C integer
461 error codes, or C++'s ``std::error_code``. However, the ``Error`` class is
462 actually a lightweight wrapper for user-defined error types, allowing arbitrary
463 information to be attached to describe the error. This is similar to the way C++
464 exceptions allow throwing of user-defined types.
466 Success values are created by calling ``Error::success()``, E.g.:
468 .. code-block:: c++
470   Error foo() {
471     // Do something.
472     // Return success.
473     return Error::success();
474   }
476 Success values are very cheap to construct and return - they have minimal
477 impact on program performance.
479 Failure values are constructed using ``make_error<T>``, where ``T`` is any class
480 that inherits from the ErrorInfo utility, E.g.:
482 .. code-block:: c++
484   class BadFileFormat : public ErrorInfo<BadFileFormat> {
485   public:
486     static char ID;
487     std::string Path;
489     BadFileFormat(StringRef Path) : Path(Path.str()) {}
491     void log(raw_ostream &OS) const override {
492       OS << Path << " is malformed";
493     }
495     std::error_code convertToErrorCode() const override {
496       return make_error_code(object_error::parse_failed);
497     }
498   };
500   char BadFileFormat::ID; // This should be declared in the C++ file.
502   Error printFormattedFile(StringRef Path) {
503     if (<check for valid format>)
504       return make_error<BadFileFormat>(Path);
505     // print file contents.
506     return Error::success();
507   }
509 Error values can be implicitly converted to bool: true for error, false for
510 success, enabling the following idiom:
512 .. code-block:: c++
514   Error mayFail();
516   Error foo() {
517     if (auto Err = mayFail())
518       return Err;
519     // Success! We can proceed.
520     ...
522 For functions that can fail but need to return a value the ``Expected<T>``
523 utility can be used. Values of this type can be constructed with either a
524 ``T``, or an ``Error``. Expected<T> values are also implicitly convertible to
525 boolean, but with the opposite convention to ``Error``: true for success, false
526 for error. If success, the ``T`` value can be accessed via the dereference
527 operator. If failure, the ``Error`` value can be extracted using the
528 ``takeError()`` method. Idiomatic usage looks like:
530 .. code-block:: c++
532   Expected<FormattedFile> openFormattedFile(StringRef Path) {
533     // If badly formatted, return an error.
534     if (auto Err = checkFormat(Path))
535       return std::move(Err);
536     // Otherwise return a FormattedFile instance.
537     return FormattedFile(Path);
538   }
540   Error processFormattedFile(StringRef Path) {
541     // Try to open a formatted file
542     if (auto FileOrErr = openFormattedFile(Path)) {
543       // On success, grab a reference to the file and continue.
544       auto &File = *FileOrErr;
545       ...
546     } else
547       // On error, extract the Error value and return it.
548       return FileOrErr.takeError();
549   }
551 If an ``Expected<T>`` value is in success mode then the ``takeError()`` method
552 will return a success value. Using this fact, the above function can be
553 rewritten as:
555 .. code-block:: c++
557   Error processFormattedFile(StringRef Path) {
558     // Try to open a formatted file
559     auto FileOrErr = openFormattedFile(Path);
560     if (auto Err = FileOrErr.takeError())
561       // On error, extract the Error value and return it.
562       return Err;
563     // On success, grab a reference to the file and continue.
564     auto &File = *FileOrErr;
565     ...
566   }
568 This second form is often more readable for functions that involve multiple
569 ``Expected<T>`` values as it limits the indentation required.
571 All ``Error`` instances, whether success or failure, must be either checked or
572 moved from (via ``std::move`` or a return) before they are destructed.
573 Accidentally discarding an unchecked error will cause a program abort at the
574 point where the unchecked value's destructor is run, making it easy to identify
575 and fix violations of this rule.
577 Success values are considered checked once they have been tested (by invoking
578 the boolean conversion operator):
580 .. code-block:: c++
582   if (auto Err = mayFail(...))
583     return Err; // Failure value - move error to caller.
585   // Safe to continue: Err was checked.
587 In contrast, the following code will always cause an abort, even if ``mayFail``
588 returns a success value:
590 .. code-block:: c++
592     mayFail();
593     // Program will always abort here, even if mayFail() returns Success, since
594     // the value is not checked.
596 Failure values are considered checked once a handler for the error type has
597 been activated:
599 .. code-block:: c++
601   handleErrors(
602     processFormattedFile(...),
603     [](const BadFileFormat &BFF) {
604       report("Unable to process " + BFF.Path + ": bad format");
605     },
606     [](const FileNotFound &FNF) {
607       report("File not found " + FNF.Path);
608     });
610 The ``handleErrors`` function takes an error as its first argument, followed by
611 a variadic list of "handlers", each of which must be a callable type (a
612 function, lambda, or class with a call operator) with one argument. The
613 ``handleErrors`` function will visit each handler in the sequence and check its
614 argument type against the dynamic type of the error, running the first handler
615 that matches. This is the same decision process that is used decide which catch
616 clause to run for a C++ exception.
618 Since the list of handlers passed to ``handleErrors`` may not cover every error
619 type that can occur, the ``handleErrors`` function also returns an Error value
620 that must be checked or propagated. If the error value that is passed to
621 ``handleErrors`` does not match any of the handlers it will be returned from
622 handleErrors. Idiomatic use of ``handleErrors`` thus looks like:
624 .. code-block:: c++
626   if (auto Err =
627         handleErrors(
628           processFormattedFile(...),
629           [](const BadFileFormat &BFF) {
630             report("Unable to process " + BFF.Path + ": bad format");
631           },
632           [](const FileNotFound &FNF) {
633             report("File not found " + FNF.Path);
634           }))
635     return Err;
637 In cases where you truly know that the handler list is exhaustive the
638 ``handleAllErrors`` function can be used instead. This is identical to
639 ``handleErrors`` except that it will terminate the program if an unhandled
640 error is passed in, and can therefore return void. The ``handleAllErrors``
641 function should generally be avoided: the introduction of a new error type
642 elsewhere in the program can easily turn a formerly exhaustive list of errors
643 into a non-exhaustive list, risking unexpected program termination. Where
644 possible, use handleErrors and propagate unknown errors up the stack instead.
646 For tool code, where errors can be handled by printing an error message then
647 exiting with an error code, the :ref:`ExitOnError <err_exitonerr>` utility
648 may be a better choice than handleErrors, as it simplifies control flow when
649 calling fallible functions.
651 In situations where it is known that a particular call to a fallible function
652 will always succeed (for example, a call to a function that can only fail on a
653 subset of inputs with an input that is known to be safe) the
654 :ref:`cantFail <err_cantfail>` functions can be used to remove the error type,
655 simplifying control flow.
657 StringError
658 """""""""""
660 Many kinds of errors have no recovery strategy, the only action that can be
661 taken is to report them to the user so that the user can attempt to fix the
662 environment. In this case representing the error as a string makes perfect
663 sense. LLVM provides the ``StringError`` class for this purpose. It takes two
664 arguments: A string error message, and an equivalent ``std::error_code`` for
665 interoperability. It also provides a ``createStringError`` function to simplify
666 common usage of this class:
668 .. code-block:: c++
670   // These two lines of code are equivalent:
671   make_error<StringError>("Bad executable", errc::executable_format_error);
672   createStringError(errc::executable_format_error, "Bad executable");
674 If you're certain that the error you're building will never need to be converted
675 to a ``std::error_code`` you can use the ``inconvertibleErrorCode()`` function:
677 .. code-block:: c++
679   createStringError(inconvertibleErrorCode(), "Bad executable");
681 This should be done only after careful consideration. If any attempt is made to
682 convert this error to a ``std::error_code`` it will trigger immediate program
683 termination. Unless you are certain that your errors will not need
684 interoperability you should look for an existing ``std::error_code`` that you
685 can convert to, and even (as painful as it is) consider introducing a new one as
686 a stopgap measure.
688 ``createStringError`` can take ``printf`` style format specifiers to provide a
689 formatted message:
691 .. code-block:: c++
693   createStringError(errc::executable_format_error,
694                     "Bad executable: %s", FileName);
696 Interoperability with std::error_code and ErrorOr
697 """""""""""""""""""""""""""""""""""""""""""""""""
699 Many existing LLVM APIs use ``std::error_code`` and its partner ``ErrorOr<T>``
700 (which plays the same role as ``Expected<T>``, but wraps a ``std::error_code``
701 rather than an ``Error``). The infectious nature of error types means that an
702 attempt to change one of these functions to return ``Error`` or ``Expected<T>``
703 instead often results in an avalanche of changes to callers, callers of callers,
704 and so on. (The first such attempt, returning an ``Error`` from
705 MachOObjectFile's constructor, was abandoned after the diff reached 3000 lines,
706 impacted half a dozen libraries, and was still growing).
708 To solve this problem, the ``Error``/``std::error_code`` interoperability requirement was
709 introduced. Two pairs of functions allow any ``Error`` value to be converted to a
710 ``std::error_code``, any ``Expected<T>`` to be converted to an ``ErrorOr<T>``, and vice
711 versa:
713 .. code-block:: c++
715   std::error_code errorToErrorCode(Error Err);
716   Error errorCodeToError(std::error_code EC);
718   template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> TOrErr);
719   template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> TOrEC);
722 Using these APIs it is easy to make surgical patches that update individual
723 functions from ``std::error_code`` to ``Error``, and from ``ErrorOr<T>`` to
724 ``Expected<T>``.
726 Returning Errors from error handlers
727 """"""""""""""""""""""""""""""""""""
729 Error recovery attempts may themselves fail. For that reason, ``handleErrors``
730 actually recognises three different forms of handler signature:
732 .. code-block:: c++
734   // Error must be handled, no new errors produced:
735   void(UserDefinedError &E);
737   // Error must be handled, new errors can be produced:
738   Error(UserDefinedError &E);
740   // Original error can be inspected, then re-wrapped and returned (or a new
741   // error can be produced):
742   Error(std::unique_ptr<UserDefinedError> E);
744 Any error returned from a handler will be returned from the ``handleErrors``
745 function so that it can be handled itself, or propagated up the stack.
747 .. _err_exitonerr:
749 Using ExitOnError to simplify tool code
750 """""""""""""""""""""""""""""""""""""""
752 Library code should never call ``exit`` for a recoverable error, however in tool
753 code (especially command line tools) this can be a reasonable approach. Calling
754 ``exit`` upon encountering an error dramatically simplifies control flow as the
755 error no longer needs to be propagated up the stack. This allows code to be
756 written in straight-line style, as long as each fallible call is wrapped in a
757 check and call to exit. The ``ExitOnError`` class supports this pattern by
758 providing call operators that inspect ``Error`` values, stripping the error away
759 in the success case and logging to ``stderr`` then exiting in the failure case.
761 To use this class, declare a global ``ExitOnError`` variable in your program:
763 .. code-block:: c++
765   ExitOnError ExitOnErr;
767 Calls to fallible functions can then be wrapped with a call to ``ExitOnErr``,
768 turning them into non-failing calls:
770 .. code-block:: c++
772   Error mayFail();
773   Expected<int> mayFail2();
775   void foo() {
776     ExitOnErr(mayFail());
777     int X = ExitOnErr(mayFail2());
778   }
780 On failure, the error's log message will be written to ``stderr``, optionally
781 preceded by a string "banner" that can be set by calling the setBanner method. A
782 mapping can also be supplied from ``Error`` values to exit codes using the
783 ``setExitCodeMapper`` method:
785 .. code-block:: c++
787   int main(int argc, char *argv[]) {
788     ExitOnErr.setBanner(std::string(argv[0]) + " error:");
789     ExitOnErr.setExitCodeMapper(
790       [](const Error &Err) {
791         if (Err.isA<BadFileFormat>())
792           return 2;
793         return 1;
794       });
796 Use ``ExitOnError`` in your tool code where possible as it can greatly improve
797 readability.
799 .. _err_cantfail:
801 Using cantFail to simplify safe callsites
802 """""""""""""""""""""""""""""""""""""""""
804 Some functions may only fail for a subset of their inputs, so calls using known
805 safe inputs can be assumed to succeed.
807 The cantFail functions encapsulate this by wrapping an assertion that their
808 argument is a success value and, in the case of Expected<T>, unwrapping the
809 T value:
811 .. code-block:: c++
813   Error onlyFailsForSomeXValues(int X);
814   Expected<int> onlyFailsForSomeXValues2(int X);
816   void foo() {
817     cantFail(onlyFailsForSomeXValues(KnownSafeValue));
818     int Y = cantFail(onlyFailsForSomeXValues2(KnownSafeValue));
819     ...
820   }
822 Like the ExitOnError utility, cantFail simplifies control flow. Their treatment
823 of error cases is very different however: Where ExitOnError is guaranteed to
824 terminate the program on an error input, cantFail simply asserts that the result
825 is success. In debug builds this will result in an assertion failure if an error
826 is encountered. In release builds the behavior of cantFail for failure values is
827 undefined. As such, care must be taken in the use of cantFail: clients must be
828 certain that a cantFail wrapped call really can not fail with the given
829 arguments.
831 Use of the cantFail functions should be rare in library code, but they are
832 likely to be of more use in tool and unit-test code where inputs and/or
833 mocked-up classes or functions may be known to be safe.
835 Fallible constructors
836 """""""""""""""""""""
838 Some classes require resource acquisition or other complex initialization that
839 can fail during construction. Unfortunately constructors can't return errors,
840 and having clients test objects after they're constructed to ensure that they're
841 valid is error prone as it's all too easy to forget the test. To work around
842 this, use the named constructor idiom and return an ``Expected<T>``:
844 .. code-block:: c++
846   class Foo {
847   public:
849     static Expected<Foo> Create(Resource R1, Resource R2) {
850       Error Err;
851       Foo F(R1, R2, Err);
852       if (Err)
853         return std::move(Err);
854       return std::move(F);
855     }
857   private:
859     Foo(Resource R1, Resource R2, Error &Err) {
860       ErrorAsOutParameter EAO(&Err);
861       if (auto Err2 = R1.acquire()) {
862         Err = std::move(Err2);
863         return;
864       }
865       Err = R2.acquire();
866     }
867   };
870 Here, the named constructor passes an ``Error`` by reference into the actual
871 constructor, which the constructor can then use to return errors. The
872 ``ErrorAsOutParameter`` utility sets the ``Error`` value's checked flag on entry
873 to the constructor so that the error can be assigned to, then resets it on exit
874 to force the client (the named constructor) to check the error.
876 By using this idiom, clients attempting to construct a Foo receive either a
877 well-formed Foo or an Error, never an object in an invalid state.
879 Propagating and consuming errors based on types
880 """""""""""""""""""""""""""""""""""""""""""""""
882 In some contexts, certain types of error are known to be benign. For example,
883 when walking an archive, some clients may be happy to skip over badly formatted
884 object files rather than terminating the walk immediately. Skipping badly
885 formatted objects could be achieved using an elaborate handler method, but the
886 Error.h header provides two utilities that make this idiom much cleaner: the
887 type inspection method, ``isA``, and the ``consumeError`` function:
889 .. code-block:: c++
891   Error walkArchive(Archive A) {
892     for (unsigned I = 0; I != A.numMembers(); ++I) {
893       auto ChildOrErr = A.getMember(I);
894       if (auto Err = ChildOrErr.takeError()) {
895         if (Err.isA<BadFileFormat>())
896           consumeError(std::move(Err))
897         else
898           return Err;
899       }
900       auto &Child = *ChildOrErr;
901       // Use Child
902       ...
903     }
904     return Error::success();
905   }
907 Concatenating Errors with joinErrors
908 """"""""""""""""""""""""""""""""""""
910 In the archive walking example above ``BadFileFormat`` errors are simply
911 consumed and ignored. If the client had wanted report these errors after
912 completing the walk over the archive they could use the ``joinErrors`` utility:
914 .. code-block:: c++
916   Error walkArchive(Archive A) {
917     Error DeferredErrs = Error::success();
918     for (unsigned I = 0; I != A.numMembers(); ++I) {
919       auto ChildOrErr = A.getMember(I);
920       if (auto Err = ChildOrErr.takeError())
921         if (Err.isA<BadFileFormat>())
922           DeferredErrs = joinErrors(std::move(DeferredErrs), std::move(Err));
923         else
924           return Err;
925       auto &Child = *ChildOrErr;
926       // Use Child
927       ...
928     }
929     return DeferredErrs;
930   }
932 The ``joinErrors`` routine builds a special error type called ``ErrorList``,
933 which holds a list of user defined errors. The ``handleErrors`` routine
934 recognizes this type and will attempt to handle each of the contained errors in
935 order. If all contained errors can be handled, ``handleErrors`` will return
936 ``Error::success()``, otherwise ``handleErrors`` will concatenate the remaining
937 errors and return the resulting ``ErrorList``.
939 Building fallible iterators and iterator ranges
940 """""""""""""""""""""""""""""""""""""""""""""""
942 The archive walking examples above retrieve archive members by index, however
943 this requires considerable boiler-plate for iteration and error checking. We can
944 clean this up by using the "fallible iterator" pattern, which supports the
945 following natural iteration idiom for fallible containers like Archive:
947 .. code-block:: c++
949   Error Err;
950   for (auto &Child : Ar->children(Err)) {
951     // Use Child - only enter the loop when it's valid
953     // Allow early exit from the loop body, since we know that Err is success
954     // when we're inside the loop.
955     if (BailOutOn(Child))
956       return;
958     ...
959   }
960   // Check Err after the loop to ensure it didn't break due to an error.
961   if (Err)
962     return Err;
964 To enable this idiom, iterators over fallible containers are written in a
965 natural style, with their ``++`` and ``--`` operators replaced with fallible
966 ``Error inc()`` and ``Error dec()`` functions. E.g.:
968 .. code-block:: c++
970   class FallibleChildIterator {
971   public:
972     FallibleChildIterator(Archive &A, unsigned ChildIdx);
973     Archive::Child &operator*();
974     friend bool operator==(const ArchiveIterator &LHS,
975                            const ArchiveIterator &RHS);
977     // operator++/operator-- replaced with fallible increment / decrement:
978     Error inc() {
979       if (!A.childValid(ChildIdx + 1))
980         return make_error<BadArchiveMember>(...);
981       ++ChildIdx;
982       return Error::success();
983     }
985     Error dec() { ... }
986   };
988 Instances of this kind of fallible iterator interface are then wrapped with the
989 fallible_iterator utility which provides ``operator++`` and ``operator--``,
990 returning any errors via a reference passed in to the wrapper at construction
991 time. The fallible_iterator wrapper takes care of (a) jumping to the end of the
992 range on error, and (b) marking the error as checked whenever an iterator is
993 compared to ``end`` and found to be inequal (in particular: this marks the
994 error as checked throughout the body of a range-based for loop), enabling early
995 exit from the loop without redundant error checking.
997 Instances of the fallible iterator interface (e.g. FallibleChildIterator above)
998 are wrapped using the ``make_fallible_itr`` and ``make_fallible_end``
999 functions. E.g.:
1001 .. code-block:: c++
1003   class Archive {
1004   public:
1005     using child_iterator = fallible_iterator<FallibleChildIterator>;
1007     child_iterator child_begin(Error &Err) {
1008       return make_fallible_itr(FallibleChildIterator(*this, 0), Err);
1009     }
1011     child_iterator child_end() {
1012       return make_fallible_end(FallibleChildIterator(*this, size()));
1013     }
1015     iterator_range<child_iterator> children(Error &Err) {
1016       return make_range(child_begin(Err), child_end());
1017     }
1018   };
1020 Using the fallible_iterator utility allows for both natural construction of
1021 fallible iterators (using failing ``inc`` and ``dec`` operations) and
1022 relatively natural use of c++ iterator/loop idioms.
1024 .. _function_apis:
1026 More information on Error and its related utilities can be found in the
1027 Error.h header file.
1029 Passing functions and other callable objects
1030 --------------------------------------------
1032 Sometimes you may want a function to be passed a callback object. In order to
1033 support lambda expressions and other function objects, you should not use the
1034 traditional C approach of taking a function pointer and an opaque cookie:
1036 .. code-block:: c++
1038     void takeCallback(bool (*Callback)(Function *, void *), void *Cookie);
1040 Instead, use one of the following approaches:
1042 Function template
1043 ^^^^^^^^^^^^^^^^^
1045 If you don't mind putting the definition of your function into a header file,
1046 make it a function template that is templated on the callable type.
1048 .. code-block:: c++
1050     template<typename Callable>
1051     void takeCallback(Callable Callback) {
1052       Callback(1, 2, 3);
1053     }
1055 The ``function_ref`` class template
1056 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1058 The ``function_ref``
1059 (`doxygen <http://llvm.org/doxygen/classllvm_1_1function__ref_3_01Ret_07Params_8_8_8_08_4.html>`__) class
1060 template represents a reference to a callable object, templated over the type
1061 of the callable. This is a good choice for passing a callback to a function,
1062 if you don't need to hold onto the callback after the function returns. In this
1063 way, ``function_ref`` is to ``std::function`` as ``StringRef`` is to
1064 ``std::string``.
1066 ``function_ref<Ret(Param1, Param2, ...)>`` can be implicitly constructed from
1067 any callable object that can be called with arguments of type ``Param1``,
1068 ``Param2``, ..., and returns a value that can be converted to type ``Ret``.
1069 For example:
1071 .. code-block:: c++
1073     void visitBasicBlocks(Function *F, function_ref<bool (BasicBlock*)> Callback) {
1074       for (BasicBlock &BB : *F)
1075         if (Callback(&BB))
1076           return;
1077     }
1079 can be called using:
1081 .. code-block:: c++
1083     visitBasicBlocks(F, [&](BasicBlock *BB) {
1084       if (process(BB))
1085         return isEmpty(BB);
1086       return false;
1087     });
1089 Note that a ``function_ref`` object contains pointers to external memory, so it
1090 is not generally safe to store an instance of the class (unless you know that
1091 the external storage will not be freed). If you need this ability, consider
1092 using ``std::function``. ``function_ref`` is small enough that it should always
1093 be passed by value.
1095 .. _DEBUG:
1097 The ``LLVM_DEBUG()`` macro and ``-debug`` option
1098 ------------------------------------------------
1100 Often when working on your pass you will put a bunch of debugging printouts and
1101 other code into your pass.  After you get it working, you want to remove it, but
1102 you may need it again in the future (to work out new bugs that you run across).
1104 Naturally, because of this, you don't want to delete the debug printouts, but
1105 you don't want them to always be noisy.  A standard compromise is to comment
1106 them out, allowing you to enable them if you need them in the future.
1108 The ``llvm/Support/Debug.h`` (`doxygen
1109 <http://llvm.org/doxygen/Debug_8h_source.html>`__) file provides a macro named
1110 ``LLVM_DEBUG()`` that is a much nicer solution to this problem.  Basically, you can
1111 put arbitrary code into the argument of the ``LLVM_DEBUG`` macro, and it is only
1112 executed if '``opt``' (or any other tool) is run with the '``-debug``' command
1113 line argument:
1115 .. code-block:: c++
1117   LLVM_DEBUG(dbgs() << "I am here!\n");
1119 Then you can run your pass like this:
1121 .. code-block:: none
1123   $ opt < a.bc > /dev/null -mypass
1124   <no output>
1125   $ opt < a.bc > /dev/null -mypass -debug
1126   I am here!
1128 Using the ``LLVM_DEBUG()`` macro instead of a home-brewed solution allows you to not
1129 have to create "yet another" command line option for the debug output for your
1130 pass.  Note that ``LLVM_DEBUG()`` macros are disabled for non-asserts builds, so they
1131 do not cause a performance impact at all (for the same reason, they should also
1132 not contain side-effects!).
1134 One additional nice thing about the ``LLVM_DEBUG()`` macro is that you can enable or
1135 disable it directly in gdb.  Just use "``set DebugFlag=0``" or "``set
1136 DebugFlag=1``" from the gdb if the program is running.  If the program hasn't
1137 been started yet, you can always just run it with ``-debug``.
1139 .. _DEBUG_TYPE:
1141 Fine grained debug info with ``DEBUG_TYPE`` and the ``-debug-only`` option
1142 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1144 Sometimes you may find yourself in a situation where enabling ``-debug`` just
1145 turns on **too much** information (such as when working on the code generator).
1146 If you want to enable debug information with more fine-grained control, you
1147 should define the ``DEBUG_TYPE`` macro and use the ``-debug-only`` option as
1148 follows:
1150 .. code-block:: c++
1152   #define DEBUG_TYPE "foo"
1153   LLVM_DEBUG(dbgs() << "'foo' debug type\n");
1154   #undef  DEBUG_TYPE
1155   #define DEBUG_TYPE "bar"
1156   LLVM_DEBUG(dbgs() << "'bar' debug type\n");
1157   #undef  DEBUG_TYPE
1159 Then you can run your pass like this:
1161 .. code-block:: none
1163   $ opt < a.bc > /dev/null -mypass
1164   <no output>
1165   $ opt < a.bc > /dev/null -mypass -debug
1166   'foo' debug type
1167   'bar' debug type
1168   $ opt < a.bc > /dev/null -mypass -debug-only=foo
1169   'foo' debug type
1170   $ opt < a.bc > /dev/null -mypass -debug-only=bar
1171   'bar' debug type
1172   $ opt < a.bc > /dev/null -mypass -debug-only=foo,bar
1173   'foo' debug type
1174   'bar' debug type
1176 Of course, in practice, you should only set ``DEBUG_TYPE`` at the top of a file,
1177 to specify the debug type for the entire module. Be careful that you only do
1178 this after including Debug.h and not around any #include of headers. Also, you
1179 should use names more meaningful than "foo" and "bar", because there is no
1180 system in place to ensure that names do not conflict. If two different modules
1181 use the same string, they will all be turned on when the name is specified.
1182 This allows, for example, all debug information for instruction scheduling to be
1183 enabled with ``-debug-only=InstrSched``, even if the source lives in multiple
1184 files. The name must not include a comma (,) as that is used to separate the
1185 arguments of the ``-debug-only`` option.
1187 For performance reasons, -debug-only is not available in optimized build
1188 (``--enable-optimized``) of LLVM.
1190 The ``DEBUG_WITH_TYPE`` macro is also available for situations where you would
1191 like to set ``DEBUG_TYPE``, but only for one specific ``DEBUG`` statement.  It
1192 takes an additional first parameter, which is the type to use.  For example, the
1193 preceding example could be written as:
1195 .. code-block:: c++
1197   DEBUG_WITH_TYPE("foo", dbgs() << "'foo' debug type\n");
1198   DEBUG_WITH_TYPE("bar", dbgs() << "'bar' debug type\n");
1200 .. _Statistic:
1202 The ``Statistic`` class & ``-stats`` option
1203 -------------------------------------------
1205 The ``llvm/ADT/Statistic.h`` (`doxygen
1206 <http://llvm.org/doxygen/Statistic_8h_source.html>`__) file provides a class
1207 named ``Statistic`` that is used as a unified way to keep track of what the LLVM
1208 compiler is doing and how effective various optimizations are.  It is useful to
1209 see what optimizations are contributing to making a particular program run
1210 faster.
1212 Often you may run your pass on some big program, and you're interested to see
1213 how many times it makes a certain transformation.  Although you can do this with
1214 hand inspection, or some ad-hoc method, this is a real pain and not very useful
1215 for big programs.  Using the ``Statistic`` class makes it very easy to keep
1216 track of this information, and the calculated information is presented in a
1217 uniform manner with the rest of the passes being executed.
1219 There are many examples of ``Statistic`` uses, but the basics of using it are as
1220 follows:
1222 Define your statistic like this:
1224 .. code-block:: c++
1226   #define DEBUG_TYPE "mypassname"   // This goes before any #includes.
1227   STATISTIC(NumXForms, "The # of times I did stuff");
1229 The ``STATISTIC`` macro defines a static variable, whose name is specified by
1230 the first argument.  The pass name is taken from the ``DEBUG_TYPE`` macro, and
1231 the description is taken from the second argument.  The variable defined
1232 ("NumXForms" in this case) acts like an unsigned integer.
1234 Whenever you make a transformation, bump the counter:
1236 .. code-block:: c++
1238   ++NumXForms;   // I did stuff!
1240 That's all you have to do.  To get '``opt``' to print out the statistics
1241 gathered, use the '``-stats``' option:
1243 .. code-block:: none
1245   $ opt -stats -mypassname < program.bc > /dev/null
1246   ... statistics output ...
1248 Note that in order to use the '``-stats``' option, LLVM must be
1249 compiled with assertions enabled.
1251 When running ``opt`` on a C file from the SPEC benchmark suite, it gives a
1252 report that looks like this:
1254 .. code-block:: none
1256    7646 bitcodewriter   - Number of normal instructions
1257     725 bitcodewriter   - Number of oversized instructions
1258  129996 bitcodewriter   - Number of bitcode bytes written
1259    2817 raise           - Number of insts DCEd or constprop'd
1260    3213 raise           - Number of cast-of-self removed
1261    5046 raise           - Number of expression trees converted
1262      75 raise           - Number of other getelementptr's formed
1263     138 raise           - Number of load/store peepholes
1264      42 deadtypeelim    - Number of unused typenames removed from symtab
1265     392 funcresolve     - Number of varargs functions resolved
1266      27 globaldce       - Number of global variables removed
1267       2 adce            - Number of basic blocks removed
1268     134 cee             - Number of branches revectored
1269      49 cee             - Number of setcc instruction eliminated
1270     532 gcse            - Number of loads removed
1271    2919 gcse            - Number of instructions removed
1272      86 indvars         - Number of canonical indvars added
1273      87 indvars         - Number of aux indvars removed
1274      25 instcombine     - Number of dead inst eliminate
1275     434 instcombine     - Number of insts combined
1276     248 licm            - Number of load insts hoisted
1277    1298 licm            - Number of insts hoisted to a loop pre-header
1278       3 licm            - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
1279      75 mem2reg         - Number of alloca's promoted
1280    1444 cfgsimplify     - Number of blocks simplified
1282 Obviously, with so many optimizations, having a unified framework for this stuff
1283 is very nice.  Making your pass fit well into the framework makes it more
1284 maintainable and useful.
1286 .. _DebugCounters:
1288 Adding debug counters to aid in debugging your code
1289 ---------------------------------------------------
1291 Sometimes, when writing new passes, or trying to track down bugs, it
1292 is useful to be able to control whether certain things in your pass
1293 happen or not.  For example, there are times the minimization tooling
1294 can only easily give you large testcases.  You would like to narrow
1295 your bug down to a specific transformation happening or not happening,
1296 automatically, using bisection.  This is where debug counters help.
1297 They provide a framework for making parts of your code only execute a
1298 certain number of times.
1300 The ``llvm/Support/DebugCounter.h`` (`doxygen
1301 <http://llvm.org/doxygen/DebugCounter_8h_source.html>`__) file
1302 provides a class named ``DebugCounter`` that can be used to create
1303 command line counter options that control execution of parts of your code.
1305 Define your DebugCounter like this:
1307 .. code-block:: c++
1309   DEBUG_COUNTER(DeleteAnInstruction, "passname-delete-instruction",
1310                 "Controls which instructions get delete");
1312 The ``DEBUG_COUNTER`` macro defines a static variable, whose name
1313 is specified by the first argument.  The name of the counter
1314 (which is used on the command line) is specified by the second
1315 argument, and the description used in the help is specified by the
1316 third argument.
1318 Whatever code you want that control, use ``DebugCounter::shouldExecute`` to control it.
1320 .. code-block:: c++
1322   if (DebugCounter::shouldExecute(DeleteAnInstruction))
1323     I->eraseFromParent();
1325 That's all you have to do.  Now, using opt, you can control when this code triggers using
1326 the '``--debug-counter``' option.  There are two counters provided, ``skip`` and ``count``.
1327 ``skip`` is the number of times to skip execution of the codepath.  ``count`` is the number
1328 of times, once we are done skipping, to execute the codepath.
1330 .. code-block:: none
1332   $ opt --debug-counter=passname-delete-instruction-skip=1,passname-delete-instruction-count=2 -passname
1334 This will skip the above code the first time we hit it, then execute it twice, then skip the rest of the executions.
1336 So if executed on the following code:
1338 .. code-block:: llvm
1340   %1 = add i32 %a, %b
1341   %2 = add i32 %a, %b
1342   %3 = add i32 %a, %b
1343   %4 = add i32 %a, %b
1345 It would delete number ``%2`` and ``%3``.
1347 A utility is provided in `utils/bisect-skip-count` to binary search
1348 skip and count arguments. It can be used to automatically minimize the
1349 skip and count for a debug-counter variable.
1351 .. _ViewGraph:
1353 Viewing graphs while debugging code
1354 -----------------------------------
1356 Several of the important data structures in LLVM are graphs: for example CFGs
1357 made out of LLVM :ref:`BasicBlocks <BasicBlock>`, CFGs made out of LLVM
1358 :ref:`MachineBasicBlocks <MachineBasicBlock>`, and :ref:`Instruction Selection
1359 DAGs <SelectionDAG>`.  In many cases, while debugging various parts of the
1360 compiler, it is nice to instantly visualize these graphs.
1362 LLVM provides several callbacks that are available in a debug build to do
1363 exactly that.  If you call the ``Function::viewCFG()`` method, for example, the
1364 current LLVM tool will pop up a window containing the CFG for the function where
1365 each basic block is a node in the graph, and each node contains the instructions
1366 in the block.  Similarly, there also exists ``Function::viewCFGOnly()`` (does
1367 not include the instructions), the ``MachineFunction::viewCFG()`` and
1368 ``MachineFunction::viewCFGOnly()``, and the ``SelectionDAG::viewGraph()``
1369 methods.  Within GDB, for example, you can usually use something like ``call
1370 DAG.viewGraph()`` to pop up a window.  Alternatively, you can sprinkle calls to
1371 these functions in your code in places you want to debug.
1373 Getting this to work requires a small amount of setup.  On Unix systems
1374 with X11, install the `graphviz <http://www.graphviz.org>`_ toolkit, and make
1375 sure 'dot' and 'gv' are in your path.  If you are running on macOS, download
1376 and install the macOS `Graphviz program
1377 <http://www.pixelglow.com/graphviz/>`_ and add
1378 ``/Applications/Graphviz.app/Contents/MacOS/`` (or wherever you install it) to
1379 your path. The programs need not be present when configuring, building or
1380 running LLVM and can simply be installed when needed during an active debug
1381 session.
1383 ``SelectionDAG`` has been extended to make it easier to locate *interesting*
1384 nodes in large complex graphs.  From gdb, if you ``call DAG.setGraphColor(node,
1385 "color")``, then the next ``call DAG.viewGraph()`` would highlight the node in
1386 the specified color (choices of colors can be found at `colors
1387 <http://www.graphviz.org/doc/info/colors.html>`_.) More complex node attributes
1388 can be provided with ``call DAG.setGraphAttrs(node, "attributes")`` (choices can
1389 be found at `Graph attributes <http://www.graphviz.org/doc/info/attrs.html>`_.)
1390 If you want to restart and clear all the current graph attributes, then you can
1391 ``call DAG.clearGraphAttrs()``.
1393 Note that graph visualization features are compiled out of Release builds to
1394 reduce file size.  This means that you need a Debug+Asserts or Release+Asserts
1395 build to use these features.
1397 .. _datastructure:
1399 Picking the Right Data Structure for a Task
1400 ===========================================
1402 LLVM has a plethora of data structures in the ``llvm/ADT/`` directory, and we
1403 commonly use STL data structures.  This section describes the trade-offs you
1404 should consider when you pick one.
1406 The first step is a choose your own adventure: do you want a sequential
1407 container, a set-like container, or a map-like container?  The most important
1408 thing when choosing a container is the algorithmic properties of how you plan to
1409 access the container.  Based on that, you should use:
1412 * a :ref:`map-like <ds_map>` container if you need efficient look-up of a
1413   value based on another value.  Map-like containers also support efficient
1414   queries for containment (whether a key is in the map).  Map-like containers
1415   generally do not support efficient reverse mapping (values to keys).  If you
1416   need that, use two maps.  Some map-like containers also support efficient
1417   iteration through the keys in sorted order.  Map-like containers are the most
1418   expensive sort, only use them if you need one of these capabilities.
1420 * a :ref:`set-like <ds_set>` container if you need to put a bunch of stuff into
1421   a container that automatically eliminates duplicates.  Some set-like
1422   containers support efficient iteration through the elements in sorted order.
1423   Set-like containers are more expensive than sequential containers.
1425 * a :ref:`sequential <ds_sequential>` container provides the most efficient way
1426   to add elements and keeps track of the order they are added to the collection.
1427   They permit duplicates and support efficient iteration, but do not support
1428   efficient look-up based on a key.
1430 * a :ref:`string <ds_string>` container is a specialized sequential container or
1431   reference structure that is used for character or byte arrays.
1433 * a :ref:`bit <ds_bit>` container provides an efficient way to store and
1434   perform set operations on sets of numeric id's, while automatically
1435   eliminating duplicates.  Bit containers require a maximum of 1 bit for each
1436   identifier you want to store.
1438 Once the proper category of container is determined, you can fine tune the
1439 memory use, constant factors, and cache behaviors of access by intelligently
1440 picking a member of the category.  Note that constant factors and cache behavior
1441 can be a big deal.  If you have a vector that usually only contains a few
1442 elements (but could contain many), for example, it's much better to use
1443 :ref:`SmallVector <dss_smallvector>` than :ref:`vector <dss_vector>`.  Doing so
1444 avoids (relatively) expensive malloc/free calls, which dwarf the cost of adding
1445 the elements to the container.
1447 .. _ds_sequential:
1449 Sequential Containers (std::vector, std::list, etc)
1450 ---------------------------------------------------
1452 There are a variety of sequential containers available for you, based on your
1453 needs.  Pick the first in this section that will do what you want.
1455 .. _dss_arrayref:
1457 llvm/ADT/ArrayRef.h
1458 ^^^^^^^^^^^^^^^^^^^
1460 The ``llvm::ArrayRef`` class is the preferred class to use in an interface that
1461 accepts a sequential list of elements in memory and just reads from them.  By
1462 taking an ``ArrayRef``, the API can be passed a fixed size array, an
1463 ``std::vector``, an ``llvm::SmallVector`` and anything else that is contiguous
1464 in memory.
1466 .. _dss_fixedarrays:
1468 Fixed Size Arrays
1469 ^^^^^^^^^^^^^^^^^
1471 Fixed size arrays are very simple and very fast.  They are good if you know
1472 exactly how many elements you have, or you have a (low) upper bound on how many
1473 you have.
1475 .. _dss_heaparrays:
1477 Heap Allocated Arrays
1478 ^^^^^^^^^^^^^^^^^^^^^
1480 Heap allocated arrays (``new[]`` + ``delete[]``) are also simple.  They are good
1481 if the number of elements is variable, if you know how many elements you will
1482 need before the array is allocated, and if the array is usually large (if not,
1483 consider a :ref:`SmallVector <dss_smallvector>`).  The cost of a heap allocated
1484 array is the cost of the new/delete (aka malloc/free).  Also note that if you
1485 are allocating an array of a type with a constructor, the constructor and
1486 destructors will be run for every element in the array (re-sizable vectors only
1487 construct those elements actually used).
1489 .. _dss_tinyptrvector:
1491 llvm/ADT/TinyPtrVector.h
1492 ^^^^^^^^^^^^^^^^^^^^^^^^
1494 ``TinyPtrVector<Type>`` is a highly specialized collection class that is
1495 optimized to avoid allocation in the case when a vector has zero or one
1496 elements.  It has two major restrictions: 1) it can only hold values of pointer
1497 type, and 2) it cannot hold a null pointer.
1499 Since this container is highly specialized, it is rarely used.
1501 .. _dss_smallvector:
1503 llvm/ADT/SmallVector.h
1504 ^^^^^^^^^^^^^^^^^^^^^^
1506 ``SmallVector<Type, N>`` is a simple class that looks and smells just like
1507 ``vector<Type>``: it supports efficient iteration, lays out elements in memory
1508 order (so you can do pointer arithmetic between elements), supports efficient
1509 push_back/pop_back operations, supports efficient random access to its elements,
1510 etc.
1512 The main advantage of SmallVector is that it allocates space for some number of
1513 elements (N) **in the object itself**.  Because of this, if the SmallVector is
1514 dynamically smaller than N, no malloc is performed.  This can be a big win in
1515 cases where the malloc/free call is far more expensive than the code that
1516 fiddles around with the elements.
1518 This is good for vectors that are "usually small" (e.g. the number of
1519 predecessors/successors of a block is usually less than 8).  On the other hand,
1520 this makes the size of the SmallVector itself large, so you don't want to
1521 allocate lots of them (doing so will waste a lot of space).  As such,
1522 SmallVectors are most useful when on the stack.
1524 SmallVector also provides a nice portable and efficient replacement for
1525 ``alloca``.
1527 SmallVector has grown a few other minor advantages over std::vector, causing
1528 ``SmallVector<Type, 0>`` to be preferred over ``std::vector<Type>``.
1530 #. std::vector is exception-safe, and some implementations have pessimizations
1531    that copy elements when SmallVector would move them.
1533 #. SmallVector understands ``llvm::is_trivially_copyable<Type>`` and uses realloc aggressively.
1535 #. Many LLVM APIs take a SmallVectorImpl as an out parameter (see the note
1536    below).
1538 #. SmallVector with N equal to 0 is smaller than std::vector on 64-bit
1539    platforms, since it uses ``unsigned`` (instead of ``void*``) for its size
1540    and capacity.
1542 .. note::
1544    Prefer to use ``SmallVectorImpl<T>`` as a parameter type.
1546    In APIs that don't care about the "small size" (most?), prefer to use
1547    the ``SmallVectorImpl<T>`` class, which is basically just the "vector
1548    header" (and methods) without the elements allocated after it. Note that
1549    ``SmallVector<T, N>`` inherits from ``SmallVectorImpl<T>`` so the
1550    conversion is implicit and costs nothing. E.g.
1552    .. code-block:: c++
1554       // BAD: Clients cannot pass e.g. SmallVector<Foo, 4>.
1555       hardcodedSmallSize(SmallVector<Foo, 2> &Out);
1556       // GOOD: Clients can pass any SmallVector<Foo, N>.
1557       allowsAnySmallSize(SmallVectorImpl<Foo> &Out);
1559       void someFunc() {
1560         SmallVector<Foo, 8> Vec;
1561         hardcodedSmallSize(Vec); // Error.
1562         allowsAnySmallSize(Vec); // Works.
1563       }
1565    Even though it has "``Impl``" in the name, this is so widely used that
1566    it really isn't "private to the implementation" anymore. A name like
1567    ``SmallVectorHeader`` would be more appropriate.
1569 .. _dss_vector:
1571 <vector>
1572 ^^^^^^^^
1574 ``std::vector<T>`` is well loved and respected.  However, ``SmallVector<T, 0>``
1575 is often a better option due to the advantages listed above.  std::vector is
1576 still useful when you need to store more than ``UINT32_MAX`` elements or when
1577 interfacing with code that expects vectors :).
1579 One worthwhile note about std::vector: avoid code like this:
1581 .. code-block:: c++
1583   for ( ... ) {
1584      std::vector<foo> V;
1585      // make use of V.
1586   }
1588 Instead, write this as:
1590 .. code-block:: c++
1592   std::vector<foo> V;
1593   for ( ... ) {
1594      // make use of V.
1595      V.clear();
1596   }
1598 Doing so will save (at least) one heap allocation and free per iteration of the
1599 loop.
1601 .. _dss_deque:
1603 <deque>
1604 ^^^^^^^
1606 ``std::deque`` is, in some senses, a generalized version of ``std::vector``.
1607 Like ``std::vector``, it provides constant time random access and other similar
1608 properties, but it also provides efficient access to the front of the list.  It
1609 does not guarantee continuity of elements within memory.
1611 In exchange for this extra flexibility, ``std::deque`` has significantly higher
1612 constant factor costs than ``std::vector``.  If possible, use ``std::vector`` or
1613 something cheaper.
1615 .. _dss_list:
1617 <list>
1618 ^^^^^^
1620 ``std::list`` is an extremely inefficient class that is rarely useful.  It
1621 performs a heap allocation for every element inserted into it, thus having an
1622 extremely high constant factor, particularly for small data types.
1623 ``std::list`` also only supports bidirectional iteration, not random access
1624 iteration.
1626 In exchange for this high cost, std::list supports efficient access to both ends
1627 of the list (like ``std::deque``, but unlike ``std::vector`` or
1628 ``SmallVector``).  In addition, the iterator invalidation characteristics of
1629 std::list are stronger than that of a vector class: inserting or removing an
1630 element into the list does not invalidate iterator or pointers to other elements
1631 in the list.
1633 .. _dss_ilist:
1635 llvm/ADT/ilist.h
1636 ^^^^^^^^^^^^^^^^
1638 ``ilist<T>`` implements an 'intrusive' doubly-linked list.  It is intrusive,
1639 because it requires the element to store and provide access to the prev/next
1640 pointers for the list.
1642 ``ilist`` has the same drawbacks as ``std::list``, and additionally requires an
1643 ``ilist_traits`` implementation for the element type, but it provides some novel
1644 characteristics.  In particular, it can efficiently store polymorphic objects,
1645 the traits class is informed when an element is inserted or removed from the
1646 list, and ``ilist``\ s are guaranteed to support a constant-time splice
1647 operation.
1649 These properties are exactly what we want for things like ``Instruction``\ s and
1650 basic blocks, which is why these are implemented with ``ilist``\ s.
1652 Related classes of interest are explained in the following subsections:
1654 * :ref:`ilist_traits <dss_ilist_traits>`
1656 * :ref:`iplist <dss_iplist>`
1658 * :ref:`llvm/ADT/ilist_node.h <dss_ilist_node>`
1660 * :ref:`Sentinels <dss_ilist_sentinel>`
1662 .. _dss_packedvector:
1664 llvm/ADT/PackedVector.h
1665 ^^^^^^^^^^^^^^^^^^^^^^^
1667 Useful for storing a vector of values using only a few number of bits for each
1668 value.  Apart from the standard operations of a vector-like container, it can
1669 also perform an 'or' set operation.
1671 For example:
1673 .. code-block:: c++
1675   enum State {
1676       None = 0x0,
1677       FirstCondition = 0x1,
1678       SecondCondition = 0x2,
1679       Both = 0x3
1680   };
1682   State get() {
1683       PackedVector<State, 2> Vec1;
1684       Vec1.push_back(FirstCondition);
1686       PackedVector<State, 2> Vec2;
1687       Vec2.push_back(SecondCondition);
1689       Vec1 |= Vec2;
1690       return Vec1[0]; // returns 'Both'.
1691   }
1693 .. _dss_ilist_traits:
1695 ilist_traits
1696 ^^^^^^^^^^^^
1698 ``ilist_traits<T>`` is ``ilist<T>``'s customization mechanism. ``iplist<T>``
1699 (and consequently ``ilist<T>``) publicly derive from this traits class.
1701 .. _dss_iplist:
1703 iplist
1704 ^^^^^^
1706 ``iplist<T>`` is ``ilist<T>``'s base and as such supports a slightly narrower
1707 interface.  Notably, inserters from ``T&`` are absent.
1709 ``ilist_traits<T>`` is a public base of this class and can be used for a wide
1710 variety of customizations.
1712 .. _dss_ilist_node:
1714 llvm/ADT/ilist_node.h
1715 ^^^^^^^^^^^^^^^^^^^^^
1717 ``ilist_node<T>`` implements the forward and backward links that are expected
1718 by the ``ilist<T>`` (and analogous containers) in the default manner.
1720 ``ilist_node<T>``\ s are meant to be embedded in the node type ``T``, usually
1721 ``T`` publicly derives from ``ilist_node<T>``.
1723 .. _dss_ilist_sentinel:
1725 Sentinels
1726 ^^^^^^^^^
1728 ``ilist``\ s have another specialty that must be considered.  To be a good
1729 citizen in the C++ ecosystem, it needs to support the standard container
1730 operations, such as ``begin`` and ``end`` iterators, etc.  Also, the
1731 ``operator--`` must work correctly on the ``end`` iterator in the case of
1732 non-empty ``ilist``\ s.
1734 The only sensible solution to this problem is to allocate a so-called *sentinel*
1735 along with the intrusive list, which serves as the ``end`` iterator, providing
1736 the back-link to the last element.  However conforming to the C++ convention it
1737 is illegal to ``operator++`` beyond the sentinel and it also must not be
1738 dereferenced.
1740 These constraints allow for some implementation freedom to the ``ilist`` how to
1741 allocate and store the sentinel.  The corresponding policy is dictated by
1742 ``ilist_traits<T>``.  By default a ``T`` gets heap-allocated whenever the need
1743 for a sentinel arises.
1745 While the default policy is sufficient in most cases, it may break down when
1746 ``T`` does not provide a default constructor.  Also, in the case of many
1747 instances of ``ilist``\ s, the memory overhead of the associated sentinels is
1748 wasted.  To alleviate the situation with numerous and voluminous
1749 ``T``-sentinels, sometimes a trick is employed, leading to *ghostly sentinels*.
1751 Ghostly sentinels are obtained by specially-crafted ``ilist_traits<T>`` which
1752 superpose the sentinel with the ``ilist`` instance in memory.  Pointer
1753 arithmetic is used to obtain the sentinel, which is relative to the ``ilist``'s
1754 ``this`` pointer.  The ``ilist`` is augmented by an extra pointer, which serves
1755 as the back-link of the sentinel.  This is the only field in the ghostly
1756 sentinel which can be legally accessed.
1758 .. _dss_other:
1760 Other Sequential Container options
1761 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1763 Other STL containers are available, such as ``std::string``.
1765 There are also various STL adapter classes such as ``std::queue``,
1766 ``std::priority_queue``, ``std::stack``, etc.  These provide simplified access
1767 to an underlying container but don't affect the cost of the container itself.
1769 .. _ds_string:
1771 String-like containers
1772 ----------------------
1774 There are a variety of ways to pass around and use strings in C and C++, and
1775 LLVM adds a few new options to choose from.  Pick the first option on this list
1776 that will do what you need, they are ordered according to their relative cost.
1778 Note that it is generally preferred to *not* pass strings around as ``const
1779 char*``'s.  These have a number of problems, including the fact that they
1780 cannot represent embedded nul ("\0") characters, and do not have a length
1781 available efficiently.  The general replacement for '``const char*``' is
1782 StringRef.
1784 For more information on choosing string containers for APIs, please see
1785 :ref:`Passing Strings <string_apis>`.
1787 .. _dss_stringref:
1789 llvm/ADT/StringRef.h
1790 ^^^^^^^^^^^^^^^^^^^^
1792 The StringRef class is a simple value class that contains a pointer to a
1793 character and a length, and is quite related to the :ref:`ArrayRef
1794 <dss_arrayref>` class (but specialized for arrays of characters).  Because
1795 StringRef carries a length with it, it safely handles strings with embedded nul
1796 characters in it, getting the length does not require a strlen call, and it even
1797 has very convenient APIs for slicing and dicing the character range that it
1798 represents.
1800 StringRef is ideal for passing simple strings around that are known to be live,
1801 either because they are C string literals, std::string, a C array, or a
1802 SmallVector.  Each of these cases has an efficient implicit conversion to
1803 StringRef, which doesn't result in a dynamic strlen being executed.
1805 StringRef has a few major limitations which make more powerful string containers
1806 useful:
1808 #. You cannot directly convert a StringRef to a 'const char*' because there is
1809    no way to add a trailing nul (unlike the .c_str() method on various stronger
1810    classes).
1812 #. StringRef doesn't own or keep alive the underlying string bytes.
1813    As such it can easily lead to dangling pointers, and is not suitable for
1814    embedding in datastructures in most cases (instead, use an std::string or
1815    something like that).
1817 #. For the same reason, StringRef cannot be used as the return value of a
1818    method if the method "computes" the result string.  Instead, use std::string.
1820 #. StringRef's do not allow you to mutate the pointed-to string bytes and it
1821    doesn't allow you to insert or remove bytes from the range.  For editing
1822    operations like this, it interoperates with the :ref:`Twine <dss_twine>`
1823    class.
1825 Because of its strengths and limitations, it is very common for a function to
1826 take a StringRef and for a method on an object to return a StringRef that points
1827 into some string that it owns.
1829 .. _dss_twine:
1831 llvm/ADT/Twine.h
1832 ^^^^^^^^^^^^^^^^
1834 The Twine class is used as an intermediary datatype for APIs that want to take a
1835 string that can be constructed inline with a series of concatenations.  Twine
1836 works by forming recursive instances of the Twine datatype (a simple value
1837 object) on the stack as temporary objects, linking them together into a tree
1838 which is then linearized when the Twine is consumed.  Twine is only safe to use
1839 as the argument to a function, and should always be a const reference, e.g.:
1841 .. code-block:: c++
1843   void foo(const Twine &T);
1844   ...
1845   StringRef X = ...
1846   unsigned i = ...
1847   foo(X + "." + Twine(i));
1849 This example forms a string like "blarg.42" by concatenating the values
1850 together, and does not form intermediate strings containing "blarg" or "blarg.".
1852 Because Twine is constructed with temporary objects on the stack, and because
1853 these instances are destroyed at the end of the current statement, it is an
1854 inherently dangerous API.  For example, this simple variant contains undefined
1855 behavior and will probably crash:
1857 .. code-block:: c++
1859   void foo(const Twine &T);
1860   ...
1861   StringRef X = ...
1862   unsigned i = ...
1863   const Twine &Tmp = X + "." + Twine(i);
1864   foo(Tmp);
1866 ... because the temporaries are destroyed before the call.  That said, Twine's
1867 are much more efficient than intermediate std::string temporaries, and they work
1868 really well with StringRef.  Just be aware of their limitations.
1870 .. _dss_smallstring:
1872 llvm/ADT/SmallString.h
1873 ^^^^^^^^^^^^^^^^^^^^^^
1875 SmallString is a subclass of :ref:`SmallVector <dss_smallvector>` that adds some
1876 convenience APIs like += that takes StringRef's.  SmallString avoids allocating
1877 memory in the case when the preallocated space is enough to hold its data, and
1878 it calls back to general heap allocation when required.  Since it owns its data,
1879 it is very safe to use and supports full mutation of the string.
1881 Like SmallVector's, the big downside to SmallString is their sizeof.  While they
1882 are optimized for small strings, they themselves are not particularly small.
1883 This means that they work great for temporary scratch buffers on the stack, but
1884 should not generally be put into the heap: it is very rare to see a SmallString
1885 as the member of a frequently-allocated heap data structure or returned
1886 by-value.
1888 .. _dss_stdstring:
1890 std::string
1891 ^^^^^^^^^^^
1893 The standard C++ std::string class is a very general class that (like
1894 SmallString) owns its underlying data.  sizeof(std::string) is very reasonable
1895 so it can be embedded into heap data structures and returned by-value.  On the
1896 other hand, std::string is highly inefficient for inline editing (e.g.
1897 concatenating a bunch of stuff together) and because it is provided by the
1898 standard library, its performance characteristics depend a lot of the host
1899 standard library (e.g. libc++ and MSVC provide a highly optimized string class,
1900 GCC contains a really slow implementation).
1902 The major disadvantage of std::string is that almost every operation that makes
1903 them larger can allocate memory, which is slow.  As such, it is better to use
1904 SmallVector or Twine as a scratch buffer, but then use std::string to persist
1905 the result.
1907 .. _ds_set:
1909 Set-Like Containers (std::set, SmallSet, SetVector, etc)
1910 --------------------------------------------------------
1912 Set-like containers are useful when you need to canonicalize multiple values
1913 into a single representation.  There are several different choices for how to do
1914 this, providing various trade-offs.
1916 .. _dss_sortedvectorset:
1918 A sorted 'vector'
1919 ^^^^^^^^^^^^^^^^^
1921 If you intend to insert a lot of elements, then do a lot of queries, a great
1922 approach is to use an std::vector (or other sequential container) with
1923 std::sort+std::unique to remove duplicates.  This approach works really well if
1924 your usage pattern has these two distinct phases (insert then query), and can be
1925 coupled with a good choice of :ref:`sequential container <ds_sequential>`.
1927 This combination provides the several nice properties: the result data is
1928 contiguous in memory (good for cache locality), has few allocations, is easy to
1929 address (iterators in the final vector are just indices or pointers), and can be
1930 efficiently queried with a standard binary search (e.g.
1931 ``std::lower_bound``; if you want the whole range of elements comparing
1932 equal, use ``std::equal_range``).
1934 .. _dss_smallset:
1936 llvm/ADT/SmallSet.h
1937 ^^^^^^^^^^^^^^^^^^^
1939 If you have a set-like data structure that is usually small and whose elements
1940 are reasonably small, a ``SmallSet<Type, N>`` is a good choice.  This set has
1941 space for N elements in place (thus, if the set is dynamically smaller than N,
1942 no malloc traffic is required) and accesses them with a simple linear search.
1943 When the set grows beyond N elements, it allocates a more expensive
1944 representation that guarantees efficient access (for most types, it falls back
1945 to :ref:`std::set <dss_set>`, but for pointers it uses something far better,
1946 :ref:`SmallPtrSet <dss_smallptrset>`.
1948 The magic of this class is that it handles small sets extremely efficiently, but
1949 gracefully handles extremely large sets without loss of efficiency.
1951 .. _dss_smallptrset:
1953 llvm/ADT/SmallPtrSet.h
1954 ^^^^^^^^^^^^^^^^^^^^^^
1956 ``SmallPtrSet`` has all the advantages of ``SmallSet`` (and a ``SmallSet`` of
1957 pointers is transparently implemented with a ``SmallPtrSet``). If more than N
1958 insertions are performed, a single quadratically probed hash table is allocated
1959 and grows as needed, providing extremely efficient access (constant time
1960 insertion/deleting/queries with low constant factors) and is very stingy with
1961 malloc traffic.
1963 Note that, unlike :ref:`std::set <dss_set>`, the iterators of ``SmallPtrSet``
1964 are invalidated whenever an insertion occurs.  Also, the values visited by the
1965 iterators are not visited in sorted order.
1967 .. _dss_stringset:
1969 llvm/ADT/StringSet.h
1970 ^^^^^^^^^^^^^^^^^^^^
1972 ``StringSet`` is a thin wrapper around :ref:`StringMap\<char\> <dss_stringmap>`,
1973 and it allows efficient storage and retrieval of unique strings.
1975 Functionally analogous to ``SmallSet<StringRef>``, ``StringSet`` also supports
1976 iteration. (The iterator dereferences to a ``StringMapEntry<char>``, so you
1977 need to call ``i->getKey()`` to access the item of the StringSet.)  On the
1978 other hand, ``StringSet`` doesn't support range-insertion and
1979 copy-construction, which :ref:`SmallSet <dss_smallset>` and :ref:`SmallPtrSet
1980 <dss_smallptrset>` do support.
1982 .. _dss_denseset:
1984 llvm/ADT/DenseSet.h
1985 ^^^^^^^^^^^^^^^^^^^
1987 DenseSet is a simple quadratically probed hash table.  It excels at supporting
1988 small values: it uses a single allocation to hold all of the pairs that are
1989 currently inserted in the set.  DenseSet is a great way to unique small values
1990 that are not simple pointers (use :ref:`SmallPtrSet <dss_smallptrset>` for
1991 pointers).  Note that DenseSet has the same requirements for the value type that
1992 :ref:`DenseMap <dss_densemap>` has.
1994 .. _dss_sparseset:
1996 llvm/ADT/SparseSet.h
1997 ^^^^^^^^^^^^^^^^^^^^
1999 SparseSet holds a small number of objects identified by unsigned keys of
2000 moderate size.  It uses a lot of memory, but provides operations that are almost
2001 as fast as a vector.  Typical keys are physical registers, virtual registers, or
2002 numbered basic blocks.
2004 SparseSet is useful for algorithms that need very fast clear/find/insert/erase
2005 and fast iteration over small sets.  It is not intended for building composite
2006 data structures.
2008 .. _dss_sparsemultiset:
2010 llvm/ADT/SparseMultiSet.h
2011 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2013 SparseMultiSet adds multiset behavior to SparseSet, while retaining SparseSet's
2014 desirable attributes. Like SparseSet, it typically uses a lot of memory, but
2015 provides operations that are almost as fast as a vector.  Typical keys are
2016 physical registers, virtual registers, or numbered basic blocks.
2018 SparseMultiSet is useful for algorithms that need very fast
2019 clear/find/insert/erase of the entire collection, and iteration over sets of
2020 elements sharing a key. It is often a more efficient choice than using composite
2021 data structures (e.g. vector-of-vectors, map-of-vectors). It is not intended for
2022 building composite data structures.
2024 .. _dss_FoldingSet:
2026 llvm/ADT/FoldingSet.h
2027 ^^^^^^^^^^^^^^^^^^^^^
2029 FoldingSet is an aggregate class that is really good at uniquing
2030 expensive-to-create or polymorphic objects.  It is a combination of a chained
2031 hash table with intrusive links (uniqued objects are required to inherit from
2032 FoldingSetNode) that uses :ref:`SmallVector <dss_smallvector>` as part of its ID
2033 process.
2035 Consider a case where you want to implement a "getOrCreateFoo" method for a
2036 complex object (for example, a node in the code generator).  The client has a
2037 description of **what** it wants to generate (it knows the opcode and all the
2038 operands), but we don't want to 'new' a node, then try inserting it into a set
2039 only to find out it already exists, at which point we would have to delete it
2040 and return the node that already exists.
2042 To support this style of client, FoldingSet perform a query with a
2043 FoldingSetNodeID (which wraps SmallVector) that can be used to describe the
2044 element that we want to query for.  The query either returns the element
2045 matching the ID or it returns an opaque ID that indicates where insertion should
2046 take place.  Construction of the ID usually does not require heap traffic.
2048 Because FoldingSet uses intrusive links, it can support polymorphic objects in
2049 the set (for example, you can have SDNode instances mixed with LoadSDNodes).
2050 Because the elements are individually allocated, pointers to the elements are
2051 stable: inserting or removing elements does not invalidate any pointers to other
2052 elements.
2054 .. _dss_set:
2056 <set>
2057 ^^^^^
2059 ``std::set`` is a reasonable all-around set class, which is decent at many
2060 things but great at nothing.  std::set allocates memory for each element
2061 inserted (thus it is very malloc intensive) and typically stores three pointers
2062 per element in the set (thus adding a large amount of per-element space
2063 overhead).  It offers guaranteed log(n) performance, which is not particularly
2064 fast from a complexity standpoint (particularly if the elements of the set are
2065 expensive to compare, like strings), and has extremely high constant factors for
2066 lookup, insertion and removal.
2068 The advantages of std::set are that its iterators are stable (deleting or
2069 inserting an element from the set does not affect iterators or pointers to other
2070 elements) and that iteration over the set is guaranteed to be in sorted order.
2071 If the elements in the set are large, then the relative overhead of the pointers
2072 and malloc traffic is not a big deal, but if the elements of the set are small,
2073 std::set is almost never a good choice.
2075 .. _dss_setvector:
2077 llvm/ADT/SetVector.h
2078 ^^^^^^^^^^^^^^^^^^^^
2080 LLVM's ``SetVector<Type>`` is an adapter class that combines your choice of a
2081 set-like container along with a :ref:`Sequential Container <ds_sequential>` The
2082 important property that this provides is efficient insertion with uniquing
2083 (duplicate elements are ignored) with iteration support.  It implements this by
2084 inserting elements into both a set-like container and the sequential container,
2085 using the set-like container for uniquing and the sequential container for
2086 iteration.
2088 The difference between SetVector and other sets is that the order of iteration
2089 is guaranteed to match the order of insertion into the SetVector.  This property
2090 is really important for things like sets of pointers.  Because pointer values
2091 are non-deterministic (e.g. vary across runs of the program on different
2092 machines), iterating over the pointers in the set will not be in a well-defined
2093 order.
2095 The drawback of SetVector is that it requires twice as much space as a normal
2096 set and has the sum of constant factors from the set-like container and the
2097 sequential container that it uses.  Use it **only** if you need to iterate over
2098 the elements in a deterministic order.  SetVector is also expensive to delete
2099 elements out of (linear time), unless you use its "pop_back" method, which is
2100 faster.
2102 ``SetVector`` is an adapter class that defaults to using ``std::vector`` and a
2103 size 16 ``SmallSet`` for the underlying containers, so it is quite expensive.
2104 However, ``"llvm/ADT/SetVector.h"`` also provides a ``SmallSetVector`` class,
2105 which defaults to using a ``SmallVector`` and ``SmallSet`` of a specified size.
2106 If you use this, and if your sets are dynamically smaller than ``N``, you will
2107 save a lot of heap traffic.
2109 .. _dss_uniquevector:
2111 llvm/ADT/UniqueVector.h
2112 ^^^^^^^^^^^^^^^^^^^^^^^
2114 UniqueVector is similar to :ref:`SetVector <dss_setvector>` but it retains a
2115 unique ID for each element inserted into the set.  It internally contains a map
2116 and a vector, and it assigns a unique ID for each value inserted into the set.
2118 UniqueVector is very expensive: its cost is the sum of the cost of maintaining
2119 both the map and vector, it has high complexity, high constant factors, and
2120 produces a lot of malloc traffic.  It should be avoided.
2122 .. _dss_immutableset:
2124 llvm/ADT/ImmutableSet.h
2125 ^^^^^^^^^^^^^^^^^^^^^^^
2127 ImmutableSet is an immutable (functional) set implementation based on an AVL
2128 tree.  Adding or removing elements is done through a Factory object and results
2129 in the creation of a new ImmutableSet object.  If an ImmutableSet already exists
2130 with the given contents, then the existing one is returned; equality is compared
2131 with a FoldingSetNodeID.  The time and space complexity of add or remove
2132 operations is logarithmic in the size of the original set.
2134 There is no method for returning an element of the set, you can only check for
2135 membership.
2137 .. _dss_otherset:
2139 Other Set-Like Container Options
2140 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2142 The STL provides several other options, such as std::multiset and the various
2143 "hash_set" like containers (whether from C++ TR1 or from the SGI library).  We
2144 never use hash_set and unordered_set because they are generally very expensive
2145 (each insertion requires a malloc) and very non-portable.
2147 std::multiset is useful if you're not interested in elimination of duplicates,
2148 but has all the drawbacks of :ref:`std::set <dss_set>`.  A sorted vector
2149 (where you don't delete duplicate entries) or some other approach is almost
2150 always better.
2152 .. _ds_map:
2154 Map-Like Containers (std::map, DenseMap, etc)
2155 ---------------------------------------------
2157 Map-like containers are useful when you want to associate data to a key.  As
2158 usual, there are a lot of different ways to do this. :)
2160 .. _dss_sortedvectormap:
2162 A sorted 'vector'
2163 ^^^^^^^^^^^^^^^^^
2165 If your usage pattern follows a strict insert-then-query approach, you can
2166 trivially use the same approach as :ref:`sorted vectors for set-like containers
2167 <dss_sortedvectorset>`.  The only difference is that your query function (which
2168 uses std::lower_bound to get efficient log(n) lookup) should only compare the
2169 key, not both the key and value.  This yields the same advantages as sorted
2170 vectors for sets.
2172 .. _dss_stringmap:
2174 llvm/ADT/StringMap.h
2175 ^^^^^^^^^^^^^^^^^^^^
2177 Strings are commonly used as keys in maps, and they are difficult to support
2178 efficiently: they are variable length, inefficient to hash and compare when
2179 long, expensive to copy, etc.  StringMap is a specialized container designed to
2180 cope with these issues.  It supports mapping an arbitrary range of bytes to an
2181 arbitrary other object.
2183 The StringMap implementation uses a quadratically-probed hash table, where the
2184 buckets store a pointer to the heap allocated entries (and some other stuff).
2185 The entries in the map must be heap allocated because the strings are variable
2186 length.  The string data (key) and the element object (value) are stored in the
2187 same allocation with the string data immediately after the element object.
2188 This container guarantees the "``(char*)(&Value+1)``" points to the key string
2189 for a value.
2191 The StringMap is very fast for several reasons: quadratic probing is very cache
2192 efficient for lookups, the hash value of strings in buckets is not recomputed
2193 when looking up an element, StringMap rarely has to touch the memory for
2194 unrelated objects when looking up a value (even when hash collisions happen),
2195 hash table growth does not recompute the hash values for strings already in the
2196 table, and each pair in the map is store in a single allocation (the string data
2197 is stored in the same allocation as the Value of a pair).
2199 StringMap also provides query methods that take byte ranges, so it only ever
2200 copies a string if a value is inserted into the table.
2202 StringMap iteration order, however, is not guaranteed to be deterministic, so
2203 any uses which require that should instead use a std::map.
2205 .. _dss_indexmap:
2207 llvm/ADT/IndexedMap.h
2208 ^^^^^^^^^^^^^^^^^^^^^
2210 IndexedMap is a specialized container for mapping small dense integers (or
2211 values that can be mapped to small dense integers) to some other type.  It is
2212 internally implemented as a vector with a mapping function that maps the keys
2213 to the dense integer range.
2215 This is useful for cases like virtual registers in the LLVM code generator: they
2216 have a dense mapping that is offset by a compile-time constant (the first
2217 virtual register ID).
2219 .. _dss_densemap:
2221 llvm/ADT/DenseMap.h
2222 ^^^^^^^^^^^^^^^^^^^
2224 DenseMap is a simple quadratically probed hash table.  It excels at supporting
2225 small keys and values: it uses a single allocation to hold all of the pairs
2226 that are currently inserted in the map.  DenseMap is a great way to map
2227 pointers to pointers, or map other small types to each other.
2229 There are several aspects of DenseMap that you should be aware of, however.
2230 The iterators in a DenseMap are invalidated whenever an insertion occurs,
2231 unlike map.  Also, because DenseMap allocates space for a large number of
2232 key/value pairs (it starts with 64 by default), it will waste a lot of space if
2233 your keys or values are large.  Finally, you must implement a partial
2234 specialization of DenseMapInfo for the key that you want, if it isn't already
2235 supported.  This is required to tell DenseMap about two special marker values
2236 (which can never be inserted into the map) that it needs internally.
2238 DenseMap's find_as() method supports lookup operations using an alternate key
2239 type.  This is useful in cases where the normal key type is expensive to
2240 construct, but cheap to compare against.  The DenseMapInfo is responsible for
2241 defining the appropriate comparison and hashing methods for each alternate key
2242 type used.
2244 .. _dss_valuemap:
2246 llvm/IR/ValueMap.h
2247 ^^^^^^^^^^^^^^^^^^^
2249 ValueMap is a wrapper around a :ref:`DenseMap <dss_densemap>` mapping
2250 ``Value*``\ s (or subclasses) to another type.  When a Value is deleted or
2251 RAUW'ed, ValueMap will update itself so the new version of the key is mapped to
2252 the same value, just as if the key were a WeakVH.  You can configure exactly how
2253 this happens, and what else happens on these two events, by passing a ``Config``
2254 parameter to the ValueMap template.
2256 .. _dss_intervalmap:
2258 llvm/ADT/IntervalMap.h
2259 ^^^^^^^^^^^^^^^^^^^^^^
2261 IntervalMap is a compact map for small keys and values.  It maps key intervals
2262 instead of single keys, and it will automatically coalesce adjacent intervals.
2263 When the map only contains a few intervals, they are stored in the map object
2264 itself to avoid allocations.
2266 The IntervalMap iterators are quite big, so they should not be passed around as
2267 STL iterators.  The heavyweight iterators allow a smaller data structure.
2269 .. _dss_map:
2271 <map>
2272 ^^^^^
2274 std::map has similar characteristics to :ref:`std::set <dss_set>`: it uses a
2275 single allocation per pair inserted into the map, it offers log(n) lookup with
2276 an extremely large constant factor, imposes a space penalty of 3 pointers per
2277 pair in the map, etc.
2279 std::map is most useful when your keys or values are very large, if you need to
2280 iterate over the collection in sorted order, or if you need stable iterators
2281 into the map (i.e. they don't get invalidated if an insertion or deletion of
2282 another element takes place).
2284 .. _dss_mapvector:
2286 llvm/ADT/MapVector.h
2287 ^^^^^^^^^^^^^^^^^^^^
2289 ``MapVector<KeyT,ValueT>`` provides a subset of the DenseMap interface.  The
2290 main difference is that the iteration order is guaranteed to be the insertion
2291 order, making it an easy (but somewhat expensive) solution for non-deterministic
2292 iteration over maps of pointers.
2294 It is implemented by mapping from key to an index in a vector of key,value
2295 pairs.  This provides fast lookup and iteration, but has two main drawbacks:
2296 the key is stored twice and removing elements takes linear time.  If it is
2297 necessary to remove elements, it's best to remove them in bulk using
2298 ``remove_if()``.
2300 .. _dss_inteqclasses:
2302 llvm/ADT/IntEqClasses.h
2303 ^^^^^^^^^^^^^^^^^^^^^^^
2305 IntEqClasses provides a compact representation of equivalence classes of small
2306 integers.  Initially, each integer in the range 0..n-1 has its own equivalence
2307 class.  Classes can be joined by passing two class representatives to the
2308 join(a, b) method.  Two integers are in the same class when findLeader() returns
2309 the same representative.
2311 Once all equivalence classes are formed, the map can be compressed so each
2312 integer 0..n-1 maps to an equivalence class number in the range 0..m-1, where m
2313 is the total number of equivalence classes.  The map must be uncompressed before
2314 it can be edited again.
2316 .. _dss_immutablemap:
2318 llvm/ADT/ImmutableMap.h
2319 ^^^^^^^^^^^^^^^^^^^^^^^
2321 ImmutableMap is an immutable (functional) map implementation based on an AVL
2322 tree.  Adding or removing elements is done through a Factory object and results
2323 in the creation of a new ImmutableMap object.  If an ImmutableMap already exists
2324 with the given key set, then the existing one is returned; equality is compared
2325 with a FoldingSetNodeID.  The time and space complexity of add or remove
2326 operations is logarithmic in the size of the original map.
2328 .. _dss_othermap:
2330 Other Map-Like Container Options
2331 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2333 The STL provides several other options, such as std::multimap and the various
2334 "hash_map" like containers (whether from C++ TR1 or from the SGI library).  We
2335 never use hash_set and unordered_set because they are generally very expensive
2336 (each insertion requires a malloc) and very non-portable.
2338 std::multimap is useful if you want to map a key to multiple values, but has all
2339 the drawbacks of std::map.  A sorted vector or some other approach is almost
2340 always better.
2342 .. _ds_bit:
2344 Bit storage containers (BitVector, SparseBitVector)
2345 ---------------------------------------------------
2347 Unlike the other containers, there are only two bit storage containers, and
2348 choosing when to use each is relatively straightforward.
2350 One additional option is ``std::vector<bool>``: we discourage its use for two
2351 reasons 1) the implementation in many common compilers (e.g.  commonly
2352 available versions of GCC) is extremely inefficient and 2) the C++ standards
2353 committee is likely to deprecate this container and/or change it significantly
2354 somehow.  In any case, please don't use it.
2356 .. _dss_bitvector:
2358 BitVector
2359 ^^^^^^^^^
2361 The BitVector container provides a dynamic size set of bits for manipulation.
2362 It supports individual bit setting/testing, as well as set operations.  The set
2363 operations take time O(size of bitvector), but operations are performed one word
2364 at a time, instead of one bit at a time.  This makes the BitVector very fast for
2365 set operations compared to other containers.  Use the BitVector when you expect
2366 the number of set bits to be high (i.e. a dense set).
2368 .. _dss_smallbitvector:
2370 SmallBitVector
2371 ^^^^^^^^^^^^^^
2373 The SmallBitVector container provides the same interface as BitVector, but it is
2374 optimized for the case where only a small number of bits, less than 25 or so,
2375 are needed.  It also transparently supports larger bit counts, but slightly less
2376 efficiently than a plain BitVector, so SmallBitVector should only be used when
2377 larger counts are rare.
2379 At this time, SmallBitVector does not support set operations (and, or, xor), and
2380 its operator[] does not provide an assignable lvalue.
2382 .. _dss_sparsebitvector:
2384 SparseBitVector
2385 ^^^^^^^^^^^^^^^
2387 The SparseBitVector container is much like BitVector, with one major difference:
2388 Only the bits that are set, are stored.  This makes the SparseBitVector much
2389 more space efficient than BitVector when the set is sparse, as well as making
2390 set operations O(number of set bits) instead of O(size of universe).  The
2391 downside to the SparseBitVector is that setting and testing of random bits is
2392 O(N), and on large SparseBitVectors, this can be slower than BitVector.  In our
2393 implementation, setting or testing bits in sorted order (either forwards or
2394 reverse) is O(1) worst case.  Testing and setting bits within 128 bits (depends
2395 on size) of the current bit is also O(1).  As a general statement,
2396 testing/setting bits in a SparseBitVector is O(distance away from last set bit).
2398 .. _debugging:
2400 Debugging
2401 =========
2403 A handful of `GDB pretty printers
2404 <https://sourceware.org/gdb/onlinedocs/gdb/Pretty-Printing.html>`__ are
2405 provided for some of the core LLVM libraries. To use them, execute the
2406 following (or add it to your ``~/.gdbinit``)::
2408   source /path/to/llvm/src/utils/gdb-scripts/prettyprinters.py
2410 It also might be handy to enable the `print pretty
2411 <http://ftp.gnu.org/old-gnu/Manuals/gdb/html_node/gdb_57.html>`__ option to
2412 avoid data structures being printed as a big block of text.
2414 .. _common:
2416 Helpful Hints for Common Operations
2417 ===================================
2419 This section describes how to perform some very simple transformations of LLVM
2420 code.  This is meant to give examples of common idioms used, showing the
2421 practical side of LLVM transformations.
2423 Because this is a "how-to" section, you should also read about the main classes
2424 that you will be working with.  The :ref:`Core LLVM Class Hierarchy Reference
2425 <coreclasses>` contains details and descriptions of the main classes that you
2426 should know about.
2428 .. _inspection:
2430 Basic Inspection and Traversal Routines
2431 ---------------------------------------
2433 The LLVM compiler infrastructure have many different data structures that may be
2434 traversed.  Following the example of the C++ standard template library, the
2435 techniques used to traverse these various data structures are all basically the
2436 same.  For a enumerable sequence of values, the ``XXXbegin()`` function (or
2437 method) returns an iterator to the start of the sequence, the ``XXXend()``
2438 function returns an iterator pointing to one past the last valid element of the
2439 sequence, and there is some ``XXXiterator`` data type that is common between the
2440 two operations.
2442 Because the pattern for iteration is common across many different aspects of the
2443 program representation, the standard template library algorithms may be used on
2444 them, and it is easier to remember how to iterate.  First we show a few common
2445 examples of the data structures that need to be traversed.  Other data
2446 structures are traversed in very similar ways.
2448 .. _iterate_function:
2450 Iterating over the ``BasicBlock`` in a ``Function``
2451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2453 It's quite common to have a ``Function`` instance that you'd like to transform
2454 in some way; in particular, you'd like to manipulate its ``BasicBlock``\ s.  To
2455 facilitate this, you'll need to iterate over all of the ``BasicBlock``\ s that
2456 constitute the ``Function``.  The following is an example that prints the name
2457 of a ``BasicBlock`` and the number of ``Instruction``\ s it contains:
2459 .. code-block:: c++
2461   Function &Func = ...
2462   for (BasicBlock &BB : Func)
2463     // Print out the name of the basic block if it has one, and then the
2464     // number of instructions that it contains
2465     errs() << "Basic block (name=" << BB.getName() << ") has "
2466                << BB.size() << " instructions.\n";
2468 .. _iterate_basicblock:
2470 Iterating over the ``Instruction`` in a ``BasicBlock``
2471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2473 Just like when dealing with ``BasicBlock``\ s in ``Function``\ s, it's easy to
2474 iterate over the individual instructions that make up ``BasicBlock``\ s.  Here's
2475 a code snippet that prints out each instruction in a ``BasicBlock``:
2477 .. code-block:: c++
2479   BasicBlock& BB = ...
2480   for (Instruction &I : BB)
2481      // The next statement works since operator<<(ostream&,...)
2482      // is overloaded for Instruction&
2483      errs() << I << "\n";
2486 However, this isn't really the best way to print out the contents of a
2487 ``BasicBlock``!  Since the ostream operators are overloaded for virtually
2488 anything you'll care about, you could have just invoked the print routine on the
2489 basic block itself: ``errs() << BB << "\n";``.
2491 .. _iterate_insiter:
2493 Iterating over the ``Instruction`` in a ``Function``
2494 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2496 If you're finding that you commonly iterate over a ``Function``'s
2497 ``BasicBlock``\ s and then that ``BasicBlock``'s ``Instruction``\ s,
2498 ``InstIterator`` should be used instead.  You'll need to include
2499 ``llvm/IR/InstIterator.h`` (`doxygen
2500 <http://llvm.org/doxygen/InstIterator_8h.html>`__) and then instantiate
2501 ``InstIterator``\ s explicitly in your code.  Here's a small example that shows
2502 how to dump all instructions in a function to the standard error stream:
2504 .. code-block:: c++
2506   #include "llvm/IR/InstIterator.h"
2508   // F is a pointer to a Function instance
2509   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
2510     errs() << *I << "\n";
2512 Easy, isn't it?  You can also use ``InstIterator``\ s to fill a work list with
2513 its initial contents.  For example, if you wanted to initialize a work list to
2514 contain all instructions in a ``Function`` F, all you would need to do is
2515 something like:
2517 .. code-block:: c++
2519   std::set<Instruction*> worklist;
2520   // or better yet, SmallPtrSet<Instruction*, 64> worklist;
2522   for (inst_iterator I = inst_begin(F), E = inst_end(F); I != E; ++I)
2523     worklist.insert(&*I);
2525 The STL set ``worklist`` would now contain all instructions in the ``Function``
2526 pointed to by F.
2528 .. _iterate_convert:
2530 Turning an iterator into a class pointer (and vice-versa)
2531 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2533 Sometimes, it'll be useful to grab a reference (or pointer) to a class instance
2534 when all you've got at hand is an iterator.  Well, extracting a reference or a
2535 pointer from an iterator is very straight-forward.  Assuming that ``i`` is a
2536 ``BasicBlock::iterator`` and ``j`` is a ``BasicBlock::const_iterator``:
2538 .. code-block:: c++
2540   Instruction& inst = *i;   // Grab reference to instruction reference
2541   Instruction* pinst = &*i; // Grab pointer to instruction reference
2542   const Instruction& inst = *j;
2544 However, the iterators you'll be working with in the LLVM framework are special:
2545 they will automatically convert to a ptr-to-instance type whenever they need to.
2546 Instead of dereferencing the iterator and then taking the address of the result,
2547 you can simply assign the iterator to the proper pointer type and you get the
2548 dereference and address-of operation as a result of the assignment (behind the
2549 scenes, this is a result of overloading casting mechanisms).  Thus the second
2550 line of the last example,
2552 .. code-block:: c++
2554   Instruction *pinst = &*i;
2556 is semantically equivalent to
2558 .. code-block:: c++
2560   Instruction *pinst = i;
2562 It's also possible to turn a class pointer into the corresponding iterator, and
2563 this is a constant time operation (very efficient).  The following code snippet
2564 illustrates use of the conversion constructors provided by LLVM iterators.  By
2565 using these, you can explicitly grab the iterator of something without actually
2566 obtaining it via iteration over some structure:
2568 .. code-block:: c++
2570   void printNextInstruction(Instruction* inst) {
2571     BasicBlock::iterator it(inst);
2572     ++it; // After this line, it refers to the instruction after *inst
2573     if (it != inst->getParent()->end()) errs() << *it << "\n";
2574   }
2576 Unfortunately, these implicit conversions come at a cost; they prevent these
2577 iterators from conforming to standard iterator conventions, and thus from being
2578 usable with standard algorithms and containers.  For example, they prevent the
2579 following code, where ``B`` is a ``BasicBlock``, from compiling:
2581 .. code-block:: c++
2583   llvm::SmallVector<llvm::Instruction *, 16>(B->begin(), B->end());
2585 Because of this, these implicit conversions may be removed some day, and
2586 ``operator*`` changed to return a pointer instead of a reference.
2588 .. _iterate_complex:
2590 Finding call sites: a slightly more complex example
2591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2593 Say that you're writing a FunctionPass and would like to count all the locations
2594 in the entire module (that is, across every ``Function``) where a certain
2595 function (i.e., some ``Function *``) is already in scope.  As you'll learn
2596 later, you may want to use an ``InstVisitor`` to accomplish this in a much more
2597 straight-forward manner, but this example will allow us to explore how you'd do
2598 it if you didn't have ``InstVisitor`` around.  In pseudo-code, this is what we
2599 want to do:
2601 .. code-block:: none
2603   initialize callCounter to zero
2604   for each Function f in the Module
2605     for each BasicBlock b in f
2606       for each Instruction i in b
2607         if (i is a CallInst and calls the given function)
2608           increment callCounter
2610 And the actual code is (remember, because we're writing a ``FunctionPass``, our
2611 ``FunctionPass``-derived class simply has to override the ``runOnFunction``
2612 method):
2614 .. code-block:: c++
2616   Function* targetFunc = ...;
2618   class OurFunctionPass : public FunctionPass {
2619     public:
2620       OurFunctionPass(): callCounter(0) { }
2622       virtual runOnFunction(Function& F) {
2623         for (BasicBlock &B : F) {
2624           for (Instruction &I: B) {
2625             if (auto *CallInst = dyn_cast<CallInst>(&I)) {
2626               // We know we've encountered a call instruction, so we
2627               // need to determine if it's a call to the
2628               // function pointed to by m_func or not.
2629               if (CallInst->getCalledFunction() == targetFunc)
2630                 ++callCounter;
2631             }
2632           }
2633         }
2634       }
2636     private:
2637       unsigned callCounter;
2638   };
2640 .. _calls_and_invokes:
2642 Treating calls and invokes the same way
2643 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2645 You may have noticed that the previous example was a bit oversimplified in that
2646 it did not deal with call sites generated by 'invoke' instructions.  In this,
2647 and in other situations, you may find that you want to treat ``CallInst``\ s and
2648 ``InvokeInst``\ s the same way, even though their most-specific common base
2649 class is ``Instruction``, which includes lots of less closely-related things.
2650 For these cases, LLVM provides a handy wrapper class called ``CallSite``
2651 (`doxygen <http://llvm.org/doxygen/classllvm_1_1CallSite.html>`__) It is
2652 essentially a wrapper around an ``Instruction`` pointer, with some methods that
2653 provide functionality common to ``CallInst``\ s and ``InvokeInst``\ s.
2655 This class has "value semantics": it should be passed by value, not by reference
2656 and it should not be dynamically allocated or deallocated using ``operator new``
2657 or ``operator delete``.  It is efficiently copyable, assignable and
2658 constructable, with costs equivalents to that of a bare pointer.  If you look at
2659 its definition, it has only a single pointer member.
2661 .. _iterate_chains:
2663 Iterating over def-use & use-def chains
2664 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2666 Frequently, we might have an instance of the ``Value`` class (`doxygen
2667 <http://llvm.org/doxygen/classllvm_1_1Value.html>`__) and we want to determine
2668 which ``User``\ s use the ``Value``.  The list of all ``User``\ s of a particular
2669 ``Value`` is called a *def-use* chain.  For example, let's say we have a
2670 ``Function*`` named ``F`` to a particular function ``foo``.  Finding all of the
2671 instructions that *use* ``foo`` is as simple as iterating over the *def-use*
2672 chain of ``F``:
2674 .. code-block:: c++
2676   Function *F = ...;
2678   for (User *U : F->users()) {
2679     if (Instruction *Inst = dyn_cast<Instruction>(U)) {
2680       errs() << "F is used in instruction:\n";
2681       errs() << *Inst << "\n";
2682     }
2684 Alternatively, it's common to have an instance of the ``User`` Class (`doxygen
2685 <http://llvm.org/doxygen/classllvm_1_1User.html>`__) and need to know what
2686 ``Value``\ s are used by it.  The list of all ``Value``\ s used by a ``User`` is
2687 known as a *use-def* chain.  Instances of class ``Instruction`` are common
2688 ``User`` s, so we might want to iterate over all of the values that a particular
2689 instruction uses (that is, the operands of the particular ``Instruction``):
2691 .. code-block:: c++
2693   Instruction *pi = ...;
2695   for (Use &U : pi->operands()) {
2696     Value *v = U.get();
2697     // ...
2698   }
2700 Declaring objects as ``const`` is an important tool of enforcing mutation free
2701 algorithms (such as analyses, etc.).  For this purpose above iterators come in
2702 constant flavors as ``Value::const_use_iterator`` and
2703 ``Value::const_op_iterator``.  They automatically arise when calling
2704 ``use/op_begin()`` on ``const Value*``\ s or ``const User*``\ s respectively.
2705 Upon dereferencing, they return ``const Use*``\ s.  Otherwise the above patterns
2706 remain unchanged.
2708 .. _iterate_preds:
2710 Iterating over predecessors & successors of blocks
2711 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2713 Iterating over the predecessors and successors of a block is quite easy with the
2714 routines defined in ``"llvm/IR/CFG.h"``.  Just use code like this to
2715 iterate over all predecessors of BB:
2717 .. code-block:: c++
2719   #include "llvm/IR/CFG.h"
2720   BasicBlock *BB = ...;
2722   for (BasicBlock *Pred : predecessors(BB)) {
2723     // ...
2724   }
2726 Similarly, to iterate over successors use ``successors``.
2728 .. _simplechanges:
2730 Making simple changes
2731 ---------------------
2733 There are some primitive transformation operations present in the LLVM
2734 infrastructure that are worth knowing about.  When performing transformations,
2735 it's fairly common to manipulate the contents of basic blocks.  This section
2736 describes some of the common methods for doing so and gives example code.
2738 .. _schanges_creating:
2740 Creating and inserting new ``Instruction``\ s
2741 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2743 *Instantiating Instructions*
2745 Creation of ``Instruction``\ s is straight-forward: simply call the constructor
2746 for the kind of instruction to instantiate and provide the necessary parameters.
2747 For example, an ``AllocaInst`` only *requires* a (const-ptr-to) ``Type``.  Thus:
2749 .. code-block:: c++
2751   auto *ai = new AllocaInst(Type::Int32Ty);
2753 will create an ``AllocaInst`` instance that represents the allocation of one
2754 integer in the current stack frame, at run time.  Each ``Instruction`` subclass
2755 is likely to have varying default parameters which change the semantics of the
2756 instruction, so refer to the `doxygen documentation for the subclass of
2757 Instruction <http://llvm.org/doxygen/classllvm_1_1Instruction.html>`_ that
2758 you're interested in instantiating.
2760 *Naming values*
2762 It is very useful to name the values of instructions when you're able to, as
2763 this facilitates the debugging of your transformations.  If you end up looking
2764 at generated LLVM machine code, you definitely want to have logical names
2765 associated with the results of instructions!  By supplying a value for the
2766 ``Name`` (default) parameter of the ``Instruction`` constructor, you associate a
2767 logical name with the result of the instruction's execution at run time.  For
2768 example, say that I'm writing a transformation that dynamically allocates space
2769 for an integer on the stack, and that integer is going to be used as some kind
2770 of index by some other code.  To accomplish this, I place an ``AllocaInst`` at
2771 the first point in the first ``BasicBlock`` of some ``Function``, and I'm
2772 intending to use it within the same ``Function``.  I might do:
2774 .. code-block:: c++
2776   auto *pa = new AllocaInst(Type::Int32Ty, 0, "indexLoc");
2778 where ``indexLoc`` is now the logical name of the instruction's execution value,
2779 which is a pointer to an integer on the run time stack.
2781 *Inserting instructions*
2783 There are essentially three ways to insert an ``Instruction`` into an existing
2784 sequence of instructions that form a ``BasicBlock``:
2786 * Insertion into an explicit instruction list
2788   Given a ``BasicBlock* pb``, an ``Instruction* pi`` within that ``BasicBlock``,
2789   and a newly-created instruction we wish to insert before ``*pi``, we do the
2790   following:
2792   .. code-block:: c++
2794       BasicBlock *pb = ...;
2795       Instruction *pi = ...;
2796       auto *newInst = new Instruction(...);
2798       pb->getInstList().insert(pi, newInst); // Inserts newInst before pi in pb
2800   Appending to the end of a ``BasicBlock`` is so common that the ``Instruction``
2801   class and ``Instruction``-derived classes provide constructors which take a
2802   pointer to a ``BasicBlock`` to be appended to.  For example code that looked
2803   like:
2805   .. code-block:: c++
2807     BasicBlock *pb = ...;
2808     auto *newInst = new Instruction(...);
2810     pb->getInstList().push_back(newInst); // Appends newInst to pb
2812   becomes:
2814   .. code-block:: c++
2816     BasicBlock *pb = ...;
2817     auto *newInst = new Instruction(..., pb);
2819   which is much cleaner, especially if you are creating long instruction
2820   streams.
2822 * Insertion into an implicit instruction list
2824   ``Instruction`` instances that are already in ``BasicBlock``\ s are implicitly
2825   associated with an existing instruction list: the instruction list of the
2826   enclosing basic block.  Thus, we could have accomplished the same thing as the
2827   above code without being given a ``BasicBlock`` by doing:
2829   .. code-block:: c++
2831     Instruction *pi = ...;
2832     auto *newInst = new Instruction(...);
2834     pi->getParent()->getInstList().insert(pi, newInst);
2836   In fact, this sequence of steps occurs so frequently that the ``Instruction``
2837   class and ``Instruction``-derived classes provide constructors which take (as
2838   a default parameter) a pointer to an ``Instruction`` which the newly-created
2839   ``Instruction`` should precede.  That is, ``Instruction`` constructors are
2840   capable of inserting the newly-created instance into the ``BasicBlock`` of a
2841   provided instruction, immediately before that instruction.  Using an
2842   ``Instruction`` constructor with a ``insertBefore`` (default) parameter, the
2843   above code becomes:
2845   .. code-block:: c++
2847     Instruction* pi = ...;
2848     auto *newInst = new Instruction(..., pi);
2850   which is much cleaner, especially if you're creating a lot of instructions and
2851   adding them to ``BasicBlock``\ s.
2853 * Insertion using an instance of ``IRBuilder``
2855   Inserting several ``Instruction``\ s can be quite laborious using the previous
2856   methods. The ``IRBuilder`` is a convenience class that can be used to add
2857   several instructions to the end of a ``BasicBlock`` or before a particular
2858   ``Instruction``. It also supports constant folding and renaming named
2859   registers (see ``IRBuilder``'s template arguments).
2861   The example below demonstrates a very simple use of the ``IRBuilder`` where
2862   three instructions are inserted before the instruction ``pi``. The first two
2863   instructions are Call instructions and third instruction multiplies the return
2864   value of the two calls.
2866   .. code-block:: c++
2868     Instruction *pi = ...;
2869     IRBuilder<> Builder(pi);
2870     CallInst* callOne = Builder.CreateCall(...);
2871     CallInst* callTwo = Builder.CreateCall(...);
2872     Value* result = Builder.CreateMul(callOne, callTwo);
2874   The example below is similar to the above example except that the created
2875   ``IRBuilder`` inserts instructions at the end of the ``BasicBlock`` ``pb``.
2877   .. code-block:: c++
2879     BasicBlock *pb = ...;
2880     IRBuilder<> Builder(pb);
2881     CallInst* callOne = Builder.CreateCall(...);
2882     CallInst* callTwo = Builder.CreateCall(...);
2883     Value* result = Builder.CreateMul(callOne, callTwo);
2885   See :doc:`tutorial/LangImpl03` for a practical use of the ``IRBuilder``.
2888 .. _schanges_deleting:
2890 Deleting Instructions
2891 ^^^^^^^^^^^^^^^^^^^^^
2893 Deleting an instruction from an existing sequence of instructions that form a
2894 BasicBlock_ is very straight-forward: just call the instruction's
2895 ``eraseFromParent()`` method.  For example:
2897 .. code-block:: c++
2899   Instruction *I = .. ;
2900   I->eraseFromParent();
2902 This unlinks the instruction from its containing basic block and deletes it.  If
2903 you'd just like to unlink the instruction from its containing basic block but
2904 not delete it, you can use the ``removeFromParent()`` method.
2906 .. _schanges_replacing:
2908 Replacing an Instruction with another Value
2909 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2911 Replacing individual instructions
2912 """""""""""""""""""""""""""""""""
2914 Including "`llvm/Transforms/Utils/BasicBlockUtils.h
2915 <http://llvm.org/doxygen/BasicBlockUtils_8h_source.html>`_" permits use of two
2916 very useful replace functions: ``ReplaceInstWithValue`` and
2917 ``ReplaceInstWithInst``.
2919 .. _schanges_deleting_sub:
2921 Deleting Instructions
2922 """""""""""""""""""""
2924 * ``ReplaceInstWithValue``
2926   This function replaces all uses of a given instruction with a value, and then
2927   removes the original instruction.  The following example illustrates the
2928   replacement of the result of a particular ``AllocaInst`` that allocates memory
2929   for a single integer with a null pointer to an integer.
2931   .. code-block:: c++
2933     AllocaInst* instToReplace = ...;
2934     BasicBlock::iterator ii(instToReplace);
2936     ReplaceInstWithValue(instToReplace->getParent()->getInstList(), ii,
2937                          Constant::getNullValue(PointerType::getUnqual(Type::Int32Ty)));
2939 * ``ReplaceInstWithInst``
2941   This function replaces a particular instruction with another instruction,
2942   inserting the new instruction into the basic block at the location where the
2943   old instruction was, and replacing any uses of the old instruction with the
2944   new instruction.  The following example illustrates the replacement of one
2945   ``AllocaInst`` with another.
2947   .. code-block:: c++
2949     AllocaInst* instToReplace = ...;
2950     BasicBlock::iterator ii(instToReplace);
2952     ReplaceInstWithInst(instToReplace->getParent()->getInstList(), ii,
2953                         new AllocaInst(Type::Int32Ty, 0, "ptrToReplacedInt"));
2956 Replacing multiple uses of Users and Values
2957 """""""""""""""""""""""""""""""""""""""""""
2959 You can use ``Value::replaceAllUsesWith`` and ``User::replaceUsesOfWith`` to
2960 change more than one use at a time.  See the doxygen documentation for the
2961 `Value Class <http://llvm.org/doxygen/classllvm_1_1Value.html>`_ and `User Class
2962 <http://llvm.org/doxygen/classllvm_1_1User.html>`_, respectively, for more
2963 information.
2965 .. _schanges_deletingGV:
2967 Deleting GlobalVariables
2968 ^^^^^^^^^^^^^^^^^^^^^^^^
2970 Deleting a global variable from a module is just as easy as deleting an
2971 Instruction.  First, you must have a pointer to the global variable that you
2972 wish to delete.  You use this pointer to erase it from its parent, the module.
2973 For example:
2975 .. code-block:: c++
2977   GlobalVariable *GV = .. ;
2979   GV->eraseFromParent();
2982 .. _threading:
2984 Threads and LLVM
2985 ================
2987 This section describes the interaction of the LLVM APIs with multithreading,
2988 both on the part of client applications, and in the JIT, in the hosted
2989 application.
2991 Note that LLVM's support for multithreading is still relatively young.  Up
2992 through version 2.5, the execution of threaded hosted applications was
2993 supported, but not threaded client access to the APIs.  While this use case is
2994 now supported, clients *must* adhere to the guidelines specified below to ensure
2995 proper operation in multithreaded mode.
2997 Note that, on Unix-like platforms, LLVM requires the presence of GCC's atomic
2998 intrinsics in order to support threaded operation.  If you need a
2999 multhreading-capable LLVM on a platform without a suitably modern system
3000 compiler, consider compiling LLVM and LLVM-GCC in single-threaded mode, and
3001 using the resultant compiler to build a copy of LLVM with multithreading
3002 support.
3004 .. _shutdown:
3006 Ending Execution with ``llvm_shutdown()``
3007 -----------------------------------------
3009 When you are done using the LLVM APIs, you should call ``llvm_shutdown()`` to
3010 deallocate memory used for internal structures.
3012 .. _managedstatic:
3014 Lazy Initialization with ``ManagedStatic``
3015 ------------------------------------------
3017 ``ManagedStatic`` is a utility class in LLVM used to implement static
3018 initialization of static resources, such as the global type tables.  In a
3019 single-threaded environment, it implements a simple lazy initialization scheme.
3020 When LLVM is compiled with support for multi-threading, however, it uses
3021 double-checked locking to implement thread-safe lazy initialization.
3023 .. _llvmcontext:
3025 Achieving Isolation with ``LLVMContext``
3026 ----------------------------------------
3028 ``LLVMContext`` is an opaque class in the LLVM API which clients can use to
3029 operate multiple, isolated instances of LLVM concurrently within the same
3030 address space.  For instance, in a hypothetical compile-server, the compilation
3031 of an individual translation unit is conceptually independent from all the
3032 others, and it would be desirable to be able to compile incoming translation
3033 units concurrently on independent server threads.  Fortunately, ``LLVMContext``
3034 exists to enable just this kind of scenario!
3036 Conceptually, ``LLVMContext`` provides isolation.  Every LLVM entity
3037 (``Module``\ s, ``Value``\ s, ``Type``\ s, ``Constant``\ s, etc.) in LLVM's
3038 in-memory IR belongs to an ``LLVMContext``.  Entities in different contexts
3039 *cannot* interact with each other: ``Module``\ s in different contexts cannot be
3040 linked together, ``Function``\ s cannot be added to ``Module``\ s in different
3041 contexts, etc.  What this means is that is safe to compile on multiple
3042 threads simultaneously, as long as no two threads operate on entities within the
3043 same context.
3045 In practice, very few places in the API require the explicit specification of a
3046 ``LLVMContext``, other than the ``Type`` creation/lookup APIs.  Because every
3047 ``Type`` carries a reference to its owning context, most other entities can
3048 determine what context they belong to by looking at their own ``Type``.  If you
3049 are adding new entities to LLVM IR, please try to maintain this interface
3050 design.
3052 .. _jitthreading:
3054 Threads and the JIT
3055 -------------------
3057 LLVM's "eager" JIT compiler is safe to use in threaded programs.  Multiple
3058 threads can call ``ExecutionEngine::getPointerToFunction()`` or
3059 ``ExecutionEngine::runFunction()`` concurrently, and multiple threads can run
3060 code output by the JIT concurrently.  The user must still ensure that only one
3061 thread accesses IR in a given ``LLVMContext`` while another thread might be
3062 modifying it.  One way to do that is to always hold the JIT lock while accessing
3063 IR outside the JIT (the JIT *modifies* the IR by adding ``CallbackVH``\ s).
3064 Another way is to only call ``getPointerToFunction()`` from the
3065 ``LLVMContext``'s thread.
3067 When the JIT is configured to compile lazily (using
3068 ``ExecutionEngine::DisableLazyCompilation(false)``), there is currently a `race
3069 condition <https://bugs.llvm.org/show_bug.cgi?id=5184>`_ in updating call sites
3070 after a function is lazily-jitted.  It's still possible to use the lazy JIT in a
3071 threaded program if you ensure that only one thread at a time can call any
3072 particular lazy stub and that the JIT lock guards any IR access, but we suggest
3073 using only the eager JIT in threaded programs.
3075 .. _advanced:
3077 Advanced Topics
3078 ===============
3080 This section describes some of the advanced or obscure API's that most clients
3081 do not need to be aware of.  These API's tend manage the inner workings of the
3082 LLVM system, and only need to be accessed in unusual circumstances.
3084 .. _SymbolTable:
3086 The ``ValueSymbolTable`` class
3087 ------------------------------
3089 The ``ValueSymbolTable`` (`doxygen
3090 <http://llvm.org/doxygen/classllvm_1_1ValueSymbolTable.html>`__) class provides
3091 a symbol table that the :ref:`Function <c_Function>` and Module_ classes use for
3092 naming value definitions.  The symbol table can provide a name for any Value_.
3094 Note that the ``SymbolTable`` class should not be directly accessed by most
3095 clients.  It should only be used when iteration over the symbol table names
3096 themselves are required, which is very special purpose.  Note that not all LLVM
3097 Value_\ s have names, and those without names (i.e. they have an empty name) do
3098 not exist in the symbol table.
3100 Symbol tables support iteration over the values in the symbol table with
3101 ``begin/end/iterator`` and supports querying to see if a specific name is in the
3102 symbol table (with ``lookup``).  The ``ValueSymbolTable`` class exposes no
3103 public mutator methods, instead, simply call ``setName`` on a value, which will
3104 autoinsert it into the appropriate symbol table.
3106 .. _UserLayout:
3108 The ``User`` and owned ``Use`` classes' memory layout
3109 -----------------------------------------------------
3111 The ``User`` (`doxygen <http://llvm.org/doxygen/classllvm_1_1User.html>`__)
3112 class provides a basis for expressing the ownership of ``User`` towards other
3113 `Value instance <http://llvm.org/doxygen/classllvm_1_1Value.html>`_\ s.  The
3114 ``Use`` (`doxygen <http://llvm.org/doxygen/classllvm_1_1Use.html>`__) helper
3115 class is employed to do the bookkeeping and to facilitate *O(1)* addition and
3116 removal.
3118 .. _Use2User:
3120 Interaction and relationship between ``User`` and ``Use`` objects
3121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3123 A subclass of ``User`` can choose between incorporating its ``Use`` objects or
3124 refer to them out-of-line by means of a pointer.  A mixed variant (some ``Use``
3125 s inline others hung off) is impractical and breaks the invariant that the
3126 ``Use`` objects belonging to the same ``User`` form a contiguous array.
3128 We have 2 different layouts in the ``User`` (sub)classes:
3130 * Layout a)
3132   The ``Use`` object(s) are inside (resp. at fixed offset) of the ``User``
3133   object and there are a fixed number of them.
3135 * Layout b)
3137   The ``Use`` object(s) are referenced by a pointer to an array from the
3138   ``User`` object and there may be a variable number of them.
3140 As of v2.4 each layout still possesses a direct pointer to the start of the
3141 array of ``Use``\ s.  Though not mandatory for layout a), we stick to this
3142 redundancy for the sake of simplicity.  The ``User`` object also stores the
3143 number of ``Use`` objects it has. (Theoretically this information can also be
3144 calculated given the scheme presented below.)
3146 Special forms of allocation operators (``operator new``) enforce the following
3147 memory layouts:
3149 * Layout a) is modelled by prepending the ``User`` object by the ``Use[]``
3150   array.
3152   .. code-block:: none
3154     ...---.---.---.---.-------...
3155       | P | P | P | P | User
3156     '''---'---'---'---'-------'''
3158 * Layout b) is modelled by pointing at the ``Use[]`` array.
3160   .. code-block:: none
3162     .-------...
3163     | User
3164     '-------'''
3165         |
3166         v
3167         .---.---.---.---...
3168         | P | P | P | P |
3169         '---'---'---'---'''
3171 *(In the above figures* '``P``' *stands for the* ``Use**`` *that is stored in
3172 each* ``Use`` *object in the member* ``Use::Prev`` *)*
3174 .. _Waymarking:
3176 The waymarking algorithm
3177 ^^^^^^^^^^^^^^^^^^^^^^^^
3179 Since the ``Use`` objects are deprived of the direct (back)pointer to their
3180 ``User`` objects, there must be a fast and exact method to recover it.  This is
3181 accomplished by the following scheme:
3183 A bit-encoding in the 2 LSBits (least significant bits) of the ``Use::Prev``
3184 allows to find the start of the ``User`` object:
3186 * ``00`` --- binary digit 0
3188 * ``01`` --- binary digit 1
3190 * ``10`` --- stop and calculate (``s``)
3192 * ``11`` --- full stop (``S``)
3194 Given a ``Use*``, all we have to do is to walk till we get a stop and we either
3195 have a ``User`` immediately behind or we have to walk to the next stop picking
3196 up digits and calculating the offset:
3198 .. code-block:: none
3200   .---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.---.----------------
3201   | 1 | s | 1 | 0 | 1 | 0 | s | 1 | 1 | 0 | s | 1 | 1 | s | 1 | S | User (or User*)
3202   '---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'---'----------------
3203       |+15                |+10            |+6         |+3     |+1
3204       |                   |               |           |       | __>
3205       |                   |               |           | __________>
3206       |                   |               | ______________________>
3207       |                   | ______________________________________>
3208       | __________________________________________________________>
3210 Only the significant number of bits need to be stored between the stops, so that
3211 the *worst case is 20 memory accesses* when there are 1000 ``Use`` objects
3212 associated with a ``User``.
3214 .. _ReferenceImpl:
3216 Reference implementation
3217 ^^^^^^^^^^^^^^^^^^^^^^^^
3219 The following literate Haskell fragment demonstrates the concept:
3221 .. code-block:: haskell
3223   > import Test.QuickCheck
3224   >
3225   > digits :: Int -> [Char] -> [Char]
3226   > digits 0 acc = '0' : acc
3227   > digits 1 acc = '1' : acc
3228   > digits n acc = digits (n `div` 2) $ digits (n `mod` 2) acc
3229   >
3230   > dist :: Int -> [Char] -> [Char]
3231   > dist 0 [] = ['S']
3232   > dist 0 acc = acc
3233   > dist 1 acc = let r = dist 0 acc in 's' : digits (length r) r
3234   > dist n acc = dist (n - 1) $ dist 1 acc
3235   >
3236   > takeLast n ss = reverse $ take n $ reverse ss
3237   >
3238   > test = takeLast 40 $ dist 20 []
3239   >
3241 Printing <test> gives: ``"1s100000s11010s10100s1111s1010s110s11s1S"``
3243 The reverse algorithm computes the length of the string just by examining a
3244 certain prefix:
3246 .. code-block:: haskell
3248   > pref :: [Char] -> Int
3249   > pref "S" = 1
3250   > pref ('s':'1':rest) = decode 2 1 rest
3251   > pref (_:rest) = 1 + pref rest
3252   >
3253   > decode walk acc ('0':rest) = decode (walk + 1) (acc * 2) rest
3254   > decode walk acc ('1':rest) = decode (walk + 1) (acc * 2 + 1) rest
3255   > decode walk acc _ = walk + acc
3256   >
3258 Now, as expected, printing <pref test> gives ``40``.
3260 We can *quickCheck* this with following property:
3262 .. code-block:: haskell
3264   > testcase = dist 2000 []
3265   > testcaseLength = length testcase
3266   >
3267   > identityProp n = n > 0 && n <= testcaseLength ==> length arr == pref arr
3268   >     where arr = takeLast n testcase
3269   >
3271 As expected <quickCheck identityProp> gives:
3275   *Main> quickCheck identityProp
3276   OK, passed 100 tests.
3278 Let's be a bit more exhaustive:
3280 .. code-block:: haskell
3282   >
3283   > deepCheck p = check (defaultConfig { configMaxTest = 500 }) p
3284   >
3286 And here is the result of <deepCheck identityProp>:
3290   *Main> deepCheck identityProp
3291   OK, passed 500 tests.
3293 .. _Tagging:
3295 Tagging considerations
3296 ^^^^^^^^^^^^^^^^^^^^^^
3298 To maintain the invariant that the 2 LSBits of each ``Use**`` in ``Use`` never
3299 change after being set up, setters of ``Use::Prev`` must re-tag the new
3300 ``Use**`` on every modification.  Accordingly getters must strip the tag bits.
3302 For layout b) instead of the ``User`` we find a pointer (``User*`` with LSBit
3303 set).  Following this pointer brings us to the ``User``.  A portable trick
3304 ensures that the first bytes of ``User`` (if interpreted as a pointer) never has
3305 the LSBit set. (Portability is relying on the fact that all known compilers
3306 place the ``vptr`` in the first word of the instances.)
3308 .. _polymorphism:
3310 Designing Type Hiercharies and Polymorphic Interfaces
3311 -----------------------------------------------------
3313 There are two different design patterns that tend to result in the use of
3314 virtual dispatch for methods in a type hierarchy in C++ programs. The first is
3315 a genuine type hierarchy where different types in the hierarchy model
3316 a specific subset of the functionality and semantics, and these types nest
3317 strictly within each other. Good examples of this can be seen in the ``Value``
3318 or ``Type`` type hierarchies.
3320 A second is the desire to dispatch dynamically across a collection of
3321 polymorphic interface implementations. This latter use case can be modeled with
3322 virtual dispatch and inheritance by defining an abstract interface base class
3323 which all implementations derive from and override. However, this
3324 implementation strategy forces an **"is-a"** relationship to exist that is not
3325 actually meaningful. There is often not some nested hierarchy of useful
3326 generalizations which code might interact with and move up and down. Instead,
3327 there is a singular interface which is dispatched across a range of
3328 implementations.
3330 The preferred implementation strategy for the second use case is that of
3331 generic programming (sometimes called "compile-time duck typing" or "static
3332 polymorphism"). For example, a template over some type parameter ``T`` can be
3333 instantiated across any particular implementation that conforms to the
3334 interface or *concept*. A good example here is the highly generic properties of
3335 any type which models a node in a directed graph. LLVM models these primarily
3336 through templates and generic programming. Such templates include the
3337 ``LoopInfoBase`` and ``DominatorTreeBase``. When this type of polymorphism
3338 truly needs **dynamic** dispatch you can generalize it using a technique
3339 called *concept-based polymorphism*. This pattern emulates the interfaces and
3340 behaviors of templates using a very limited form of virtual dispatch for type
3341 erasure inside its implementation. You can find examples of this technique in
3342 the ``PassManager.h`` system, and there is a more detailed introduction to it
3343 by Sean Parent in several of his talks and papers:
3345 #. `Inheritance Is The Base Class of Evil
3346    <http://channel9.msdn.com/Events/GoingNative/2013/Inheritance-Is-The-Base-Class-of-Evil>`_
3347    - The GoingNative 2013 talk describing this technique, and probably the best
3348    place to start.
3349 #. `Value Semantics and Concepts-based Polymorphism
3350    <http://www.youtube.com/watch?v=_BpMYeUFXv8>`_ - The C++Now! 2012 talk
3351    describing this technique in more detail.
3352 #. `Sean Parent's Papers and Presentations
3353    <http://github.com/sean-parent/sean-parent.github.com/wiki/Papers-and-Presentations>`_
3354    - A Github project full of links to slides, video, and sometimes code.
3356 When deciding between creating a type hierarchy (with either tagged or virtual
3357 dispatch) and using templates or concepts-based polymorphism, consider whether
3358 there is some refinement of an abstract base class which is a semantically
3359 meaningful type on an interface boundary. If anything more refined than the
3360 root abstract interface is meaningless to talk about as a partial extension of
3361 the semantic model, then your use case likely fits better with polymorphism and
3362 you should avoid using virtual dispatch. However, there may be some exigent
3363 circumstances that require one technique or the other to be used.
3365 If you do need to introduce a type hierarchy, we prefer to use explicitly
3366 closed type hierarchies with manual tagged dispatch and/or RTTI rather than the
3367 open inheritance model and virtual dispatch that is more common in C++ code.
3368 This is because LLVM rarely encourages library consumers to extend its core
3369 types, and leverages the closed and tag-dispatched nature of its hierarchies to
3370 generate significantly more efficient code. We have also found that a large
3371 amount of our usage of type hierarchies fits better with tag-based pattern
3372 matching rather than dynamic dispatch across a common interface. Within LLVM we
3373 have built custom helpers to facilitate this design. See this document's
3374 section on :ref:`isa and dyn_cast <isa>` and our :doc:`detailed document
3375 <HowToSetUpLLVMStyleRTTI>` which describes how you can implement this
3376 pattern for use with the LLVM helpers.
3378 .. _abi_breaking_checks:
3380 ABI Breaking Checks
3381 -------------------
3383 Checks and asserts that alter the LLVM C++ ABI are predicated on the
3384 preprocessor symbol `LLVM_ENABLE_ABI_BREAKING_CHECKS` -- LLVM
3385 libraries built with `LLVM_ENABLE_ABI_BREAKING_CHECKS` are not ABI
3386 compatible LLVM libraries built without it defined.  By default,
3387 turning on assertions also turns on `LLVM_ENABLE_ABI_BREAKING_CHECKS`
3388 so a default +Asserts build is not ABI compatible with a
3389 default -Asserts build.  Clients that want ABI compatibility
3390 between +Asserts and -Asserts builds should use the CMake build system
3391 to set `LLVM_ENABLE_ABI_BREAKING_CHECKS` independently
3392 of `LLVM_ENABLE_ASSERTIONS`.
3394 .. _coreclasses:
3396 The Core LLVM Class Hierarchy Reference
3397 =======================================
3399 ``#include "llvm/IR/Type.h"``
3401 header source: `Type.h <http://llvm.org/doxygen/Type_8h_source.html>`_
3403 doxygen info: `Type Clases <http://llvm.org/doxygen/classllvm_1_1Type.html>`_
3405 The Core LLVM classes are the primary means of representing the program being
3406 inspected or transformed.  The core LLVM classes are defined in header files in
3407 the ``include/llvm/IR`` directory, and implemented in the ``lib/IR``
3408 directory. It's worth noting that, for historical reasons, this library is
3409 called ``libLLVMCore.so``, not ``libLLVMIR.so`` as you might expect.
3411 .. _Type:
3413 The Type class and Derived Types
3414 --------------------------------
3416 ``Type`` is a superclass of all type classes.  Every ``Value`` has a ``Type``.
3417 ``Type`` cannot be instantiated directly but only through its subclasses.
3418 Certain primitive types (``VoidType``, ``LabelType``, ``FloatType`` and
3419 ``DoubleType``) have hidden subclasses.  They are hidden because they offer no
3420 useful functionality beyond what the ``Type`` class offers except to distinguish
3421 themselves from other subclasses of ``Type``.
3423 All other types are subclasses of ``DerivedType``.  Types can be named, but this
3424 is not a requirement.  There exists exactly one instance of a given shape at any
3425 one time.  This allows type equality to be performed with address equality of
3426 the Type Instance.  That is, given two ``Type*`` values, the types are identical
3427 if the pointers are identical.
3429 .. _m_Type:
3431 Important Public Methods
3432 ^^^^^^^^^^^^^^^^^^^^^^^^
3434 * ``bool isIntegerTy() const``: Returns true for any integer type.
3436 * ``bool isFloatingPointTy()``: Return true if this is one of the five
3437   floating point types.
3439 * ``bool isSized()``: Return true if the type has known size.  Things
3440   that don't have a size are abstract types, labels and void.
3442 .. _derivedtypes:
3444 Important Derived Types
3445 ^^^^^^^^^^^^^^^^^^^^^^^
3447 ``IntegerType``
3448   Subclass of DerivedType that represents integer types of any bit width.  Any
3449   bit width between ``IntegerType::MIN_INT_BITS`` (1) and
3450   ``IntegerType::MAX_INT_BITS`` (~8 million) can be represented.
3452   * ``static const IntegerType* get(unsigned NumBits)``: get an integer
3453     type of a specific bit width.
3455   * ``unsigned getBitWidth() const``: Get the bit width of an integer type.
3457 ``SequentialType``
3458   This is subclassed by ArrayType and VectorType.
3460   * ``const Type * getElementType() const``: Returns the type of each
3461     of the elements in the sequential type.
3463   * ``uint64_t getNumElements() const``: Returns the number of elements
3464     in the sequential type.
3466 ``ArrayType``
3467   This is a subclass of SequentialType and defines the interface for array
3468   types.
3470 ``PointerType``
3471   Subclass of Type for pointer types.
3473 ``VectorType``
3474   Subclass of SequentialType for vector types.  A vector type is similar to an
3475   ArrayType but is distinguished because it is a first class type whereas
3476   ArrayType is not.  Vector types are used for vector operations and are usually
3477   small vectors of an integer or floating point type.
3479 ``StructType``
3480   Subclass of DerivedTypes for struct types.
3482 .. _FunctionType:
3484 ``FunctionType``
3485   Subclass of DerivedTypes for function types.
3487   * ``bool isVarArg() const``: Returns true if it's a vararg function.
3489   * ``const Type * getReturnType() const``: Returns the return type of the
3490     function.
3492   * ``const Type * getParamType (unsigned i)``: Returns the type of the ith
3493     parameter.
3495   * ``const unsigned getNumParams() const``: Returns the number of formal
3496     parameters.
3498 .. _Module:
3500 The ``Module`` class
3501 --------------------
3503 ``#include "llvm/IR/Module.h"``
3505 header source: `Module.h <http://llvm.org/doxygen/Module_8h_source.html>`_
3507 doxygen info: `Module Class <http://llvm.org/doxygen/classllvm_1_1Module.html>`_
3509 The ``Module`` class represents the top level structure present in LLVM
3510 programs.  An LLVM module is effectively either a translation unit of the
3511 original program or a combination of several translation units merged by the
3512 linker.  The ``Module`` class keeps track of a list of :ref:`Function
3513 <c_Function>`\ s, a list of GlobalVariable_\ s, and a SymbolTable_.
3514 Additionally, it contains a few helpful member functions that try to make common
3515 operations easy.
3517 .. _m_Module:
3519 Important Public Members of the ``Module`` class
3520 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3522 * ``Module::Module(std::string name = "")``
3524   Constructing a Module_ is easy.  You can optionally provide a name for it
3525   (probably based on the name of the translation unit).
3527 * | ``Module::iterator`` - Typedef for function list iterator
3528   | ``Module::const_iterator`` - Typedef for const_iterator.
3529   | ``begin()``, ``end()``, ``size()``, ``empty()``
3531   These are forwarding methods that make it easy to access the contents of a
3532   ``Module`` object's :ref:`Function <c_Function>` list.
3534 * ``Module::FunctionListType &getFunctionList()``
3536   Returns the list of :ref:`Function <c_Function>`\ s.  This is necessary to use
3537   when you need to update the list or perform a complex action that doesn't have
3538   a forwarding method.
3540 ----------------
3542 * | ``Module::global_iterator`` - Typedef for global variable list iterator
3543   | ``Module::const_global_iterator`` - Typedef for const_iterator.
3544   | ``global_begin()``, ``global_end()``, ``global_size()``, ``global_empty()``
3546   These are forwarding methods that make it easy to access the contents of a
3547   ``Module`` object's GlobalVariable_ list.
3549 * ``Module::GlobalListType &getGlobalList()``
3551   Returns the list of GlobalVariable_\ s.  This is necessary to use when you
3552   need to update the list or perform a complex action that doesn't have a
3553   forwarding method.
3555 ----------------
3557 * ``SymbolTable *getSymbolTable()``
3559   Return a reference to the SymbolTable_ for this ``Module``.
3561 ----------------
3563 * ``Function *getFunction(StringRef Name) const``
3565   Look up the specified function in the ``Module`` SymbolTable_.  If it does not
3566   exist, return ``null``.
3568 * ``FunctionCallee getOrInsertFunction(const std::string &Name,
3569   const FunctionType *T)``
3571   Look up the specified function in the ``Module`` SymbolTable_.  If
3572   it does not exist, add an external declaration for the function and
3573   return it. Note that the function signature already present may not
3574   match the requested signature. Thus, in order to enable the common
3575   usage of passing the result directly to EmitCall, the return type is
3576   a struct of ``{FunctionType *T, Constant *FunctionPtr}``, rather
3577   than simply the ``Function*`` with potentially an unexpected
3578   signature.
3580 * ``std::string getTypeName(const Type *Ty)``
3582   If there is at least one entry in the SymbolTable_ for the specified Type_,
3583   return it.  Otherwise return the empty string.
3585 * ``bool addTypeName(const std::string &Name, const Type *Ty)``
3587   Insert an entry in the SymbolTable_ mapping ``Name`` to ``Ty``.  If there is
3588   already an entry for this name, true is returned and the SymbolTable_ is not
3589   modified.
3591 .. _Value:
3593 The ``Value`` class
3594 -------------------
3596 ``#include "llvm/IR/Value.h"``
3598 header source: `Value.h <http://llvm.org/doxygen/Value_8h_source.html>`_
3600 doxygen info: `Value Class <http://llvm.org/doxygen/classllvm_1_1Value.html>`_
3602 The ``Value`` class is the most important class in the LLVM Source base.  It
3603 represents a typed value that may be used (among other things) as an operand to
3604 an instruction.  There are many different types of ``Value``\ s, such as
3605 Constant_\ s, Argument_\ s.  Even Instruction_\ s and :ref:`Function
3606 <c_Function>`\ s are ``Value``\ s.
3608 A particular ``Value`` may be used many times in the LLVM representation for a
3609 program.  For example, an incoming argument to a function (represented with an
3610 instance of the Argument_ class) is "used" by every instruction in the function
3611 that references the argument.  To keep track of this relationship, the ``Value``
3612 class keeps a list of all of the ``User``\ s that is using it (the User_ class
3613 is a base class for all nodes in the LLVM graph that can refer to ``Value``\ s).
3614 This use list is how LLVM represents def-use information in the program, and is
3615 accessible through the ``use_*`` methods, shown below.
3617 Because LLVM is a typed representation, every LLVM ``Value`` is typed, and this
3618 Type_ is available through the ``getType()`` method.  In addition, all LLVM
3619 values can be named.  The "name" of the ``Value`` is a symbolic string printed
3620 in the LLVM code:
3622 .. code-block:: llvm
3624   %foo = add i32 1, 2
3626 .. _nameWarning:
3628 The name of this instruction is "foo". **NOTE** that the name of any value may
3629 be missing (an empty string), so names should **ONLY** be used for debugging
3630 (making the source code easier to read, debugging printouts), they should not be
3631 used to keep track of values or map between them.  For this purpose, use a
3632 ``std::map`` of pointers to the ``Value`` itself instead.
3634 One important aspect of LLVM is that there is no distinction between an SSA
3635 variable and the operation that produces it.  Because of this, any reference to
3636 the value produced by an instruction (or the value available as an incoming
3637 argument, for example) is represented as a direct pointer to the instance of the
3638 class that represents this value.  Although this may take some getting used to,
3639 it simplifies the representation and makes it easier to manipulate.
3641 .. _m_Value:
3643 Important Public Members of the ``Value`` class
3644 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3646 * | ``Value::use_iterator`` - Typedef for iterator over the use-list
3647   | ``Value::const_use_iterator`` - Typedef for const_iterator over the
3648     use-list
3649   | ``unsigned use_size()`` - Returns the number of users of the value.
3650   | ``bool use_empty()`` - Returns true if there are no users.
3651   | ``use_iterator use_begin()`` - Get an iterator to the start of the
3652     use-list.
3653   | ``use_iterator use_end()`` - Get an iterator to the end of the use-list.
3654   | ``User *use_back()`` - Returns the last element in the list.
3656   These methods are the interface to access the def-use information in LLVM.
3657   As with all other iterators in LLVM, the naming conventions follow the
3658   conventions defined by the STL_.
3660 * ``Type *getType() const``
3661   This method returns the Type of the Value.
3663 * | ``bool hasName() const``
3664   | ``std::string getName() const``
3665   | ``void setName(const std::string &Name)``
3667   This family of methods is used to access and assign a name to a ``Value``, be
3668   aware of the :ref:`precaution above <nameWarning>`.
3670 * ``void replaceAllUsesWith(Value *V)``
3672   This method traverses the use list of a ``Value`` changing all User_\ s of the
3673   current value to refer to "``V``" instead.  For example, if you detect that an
3674   instruction always produces a constant value (for example through constant
3675   folding), you can replace all uses of the instruction with the constant like
3676   this:
3678   .. code-block:: c++
3680     Inst->replaceAllUsesWith(ConstVal);
3682 .. _User:
3684 The ``User`` class
3685 ------------------
3687 ``#include "llvm/IR/User.h"``
3689 header source: `User.h <http://llvm.org/doxygen/User_8h_source.html>`_
3691 doxygen info: `User Class <http://llvm.org/doxygen/classllvm_1_1User.html>`_
3693 Superclass: Value_
3695 The ``User`` class is the common base class of all LLVM nodes that may refer to
3696 ``Value``\ s.  It exposes a list of "Operands" that are all of the ``Value``\ s
3697 that the User is referring to.  The ``User`` class itself is a subclass of
3698 ``Value``.
3700 The operands of a ``User`` point directly to the LLVM ``Value`` that it refers
3701 to.  Because LLVM uses Static Single Assignment (SSA) form, there can only be
3702 one definition referred to, allowing this direct connection.  This connection
3703 provides the use-def information in LLVM.
3705 .. _m_User:
3707 Important Public Members of the ``User`` class
3708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3710 The ``User`` class exposes the operand list in two ways: through an index access
3711 interface and through an iterator based interface.
3713 * | ``Value *getOperand(unsigned i)``
3714   | ``unsigned getNumOperands()``
3716   These two methods expose the operands of the ``User`` in a convenient form for
3717   direct access.
3719 * | ``User::op_iterator`` - Typedef for iterator over the operand list
3720   | ``op_iterator op_begin()`` - Get an iterator to the start of the operand
3721     list.
3722   | ``op_iterator op_end()`` - Get an iterator to the end of the operand list.
3724   Together, these methods make up the iterator based interface to the operands
3725   of a ``User``.
3728 .. _Instruction:
3730 The ``Instruction`` class
3731 -------------------------
3733 ``#include "llvm/IR/Instruction.h"``
3735 header source: `Instruction.h
3736 <http://llvm.org/doxygen/Instruction_8h_source.html>`_
3738 doxygen info: `Instruction Class
3739 <http://llvm.org/doxygen/classllvm_1_1Instruction.html>`_
3741 Superclasses: User_, Value_
3743 The ``Instruction`` class is the common base class for all LLVM instructions.
3744 It provides only a few methods, but is a very commonly used class.  The primary
3745 data tracked by the ``Instruction`` class itself is the opcode (instruction
3746 type) and the parent BasicBlock_ the ``Instruction`` is embedded into.  To
3747 represent a specific type of instruction, one of many subclasses of
3748 ``Instruction`` are used.
3750 Because the ``Instruction`` class subclasses the User_ class, its operands can
3751 be accessed in the same way as for other ``User``\ s (with the
3752 ``getOperand()``/``getNumOperands()`` and ``op_begin()``/``op_end()`` methods).
3753 An important file for the ``Instruction`` class is the ``llvm/Instruction.def``
3754 file.  This file contains some meta-data about the various different types of
3755 instructions in LLVM.  It describes the enum values that are used as opcodes
3756 (for example ``Instruction::Add`` and ``Instruction::ICmp``), as well as the
3757 concrete sub-classes of ``Instruction`` that implement the instruction (for
3758 example BinaryOperator_ and CmpInst_).  Unfortunately, the use of macros in this
3759 file confuses doxygen, so these enum values don't show up correctly in the
3760 `doxygen output <http://llvm.org/doxygen/classllvm_1_1Instruction.html>`_.
3762 .. _s_Instruction:
3764 Important Subclasses of the ``Instruction`` class
3765 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3767 .. _BinaryOperator:
3769 * ``BinaryOperator``
3771   This subclasses represents all two operand instructions whose operands must be
3772   the same type, except for the comparison instructions.
3774 .. _CastInst:
3776 * ``CastInst``
3777   This subclass is the parent of the 12 casting instructions.  It provides
3778   common operations on cast instructions.
3780 .. _CmpInst:
3782 * ``CmpInst``
3784   This subclass represents the two comparison instructions,
3785   `ICmpInst <LangRef.html#i_icmp>`_ (integer opreands), and
3786   `FCmpInst <LangRef.html#i_fcmp>`_ (floating point operands).
3788 .. _m_Instruction:
3790 Important Public Members of the ``Instruction`` class
3791 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3793 * ``BasicBlock *getParent()``
3795   Returns the BasicBlock_ that this
3796   ``Instruction`` is embedded into.
3798 * ``bool mayWriteToMemory()``
3800   Returns true if the instruction writes to memory, i.e. it is a ``call``,
3801   ``free``, ``invoke``, or ``store``.
3803 * ``unsigned getOpcode()``
3805   Returns the opcode for the ``Instruction``.
3807 * ``Instruction *clone() const``
3809   Returns another instance of the specified instruction, identical in all ways
3810   to the original except that the instruction has no parent (i.e. it's not
3811   embedded into a BasicBlock_), and it has no name.
3813 .. _Constant:
3815 The ``Constant`` class and subclasses
3816 -------------------------------------
3818 Constant represents a base class for different types of constants.  It is
3819 subclassed by ConstantInt, ConstantArray, etc. for representing the various
3820 types of Constants.  GlobalValue_ is also a subclass, which represents the
3821 address of a global variable or function.
3823 .. _s_Constant:
3825 Important Subclasses of Constant
3826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3828 * ConstantInt : This subclass of Constant represents an integer constant of
3829   any width.
3831   * ``const APInt& getValue() const``: Returns the underlying
3832     value of this constant, an APInt value.
3834   * ``int64_t getSExtValue() const``: Converts the underlying APInt value to an
3835     int64_t via sign extension.  If the value (not the bit width) of the APInt
3836     is too large to fit in an int64_t, an assertion will result.  For this
3837     reason, use of this method is discouraged.
3839   * ``uint64_t getZExtValue() const``: Converts the underlying APInt value
3840     to a uint64_t via zero extension.  IF the value (not the bit width) of the
3841     APInt is too large to fit in a uint64_t, an assertion will result.  For this
3842     reason, use of this method is discouraged.
3844   * ``static ConstantInt* get(const APInt& Val)``: Returns the ConstantInt
3845     object that represents the value provided by ``Val``.  The type is implied
3846     as the IntegerType that corresponds to the bit width of ``Val``.
3848   * ``static ConstantInt* get(const Type *Ty, uint64_t Val)``: Returns the
3849     ConstantInt object that represents the value provided by ``Val`` for integer
3850     type ``Ty``.
3852 * ConstantFP : This class represents a floating point constant.
3854   * ``double getValue() const``: Returns the underlying value of this constant.
3856 * ConstantArray : This represents a constant array.
3858   * ``const std::vector<Use> &getValues() const``: Returns a vector of
3859     component constants that makeup this array.
3861 * ConstantStruct : This represents a constant struct.
3863   * ``const std::vector<Use> &getValues() const``: Returns a vector of
3864     component constants that makeup this array.
3866 * GlobalValue : This represents either a global variable or a function.  In
3867   either case, the value is a constant fixed address (after linking).
3869 .. _GlobalValue:
3871 The ``GlobalValue`` class
3872 -------------------------
3874 ``#include "llvm/IR/GlobalValue.h"``
3876 header source: `GlobalValue.h
3877 <http://llvm.org/doxygen/GlobalValue_8h_source.html>`_
3879 doxygen info: `GlobalValue Class
3880 <http://llvm.org/doxygen/classllvm_1_1GlobalValue.html>`_
3882 Superclasses: Constant_, User_, Value_
3884 Global values ( GlobalVariable_\ s or :ref:`Function <c_Function>`\ s) are the
3885 only LLVM values that are visible in the bodies of all :ref:`Function
3886 <c_Function>`\ s.  Because they are visible at global scope, they are also
3887 subject to linking with other globals defined in different translation units.
3888 To control the linking process, ``GlobalValue``\ s know their linkage rules.
3889 Specifically, ``GlobalValue``\ s know whether they have internal or external
3890 linkage, as defined by the ``LinkageTypes`` enumeration.
3892 If a ``GlobalValue`` has internal linkage (equivalent to being ``static`` in C),
3893 it is not visible to code outside the current translation unit, and does not
3894 participate in linking.  If it has external linkage, it is visible to external
3895 code, and does participate in linking.  In addition to linkage information,
3896 ``GlobalValue``\ s keep track of which Module_ they are currently part of.
3898 Because ``GlobalValue``\ s are memory objects, they are always referred to by
3899 their **address**.  As such, the Type_ of a global is always a pointer to its
3900 contents.  It is important to remember this when using the ``GetElementPtrInst``
3901 instruction because this pointer must be dereferenced first.  For example, if
3902 you have a ``GlobalVariable`` (a subclass of ``GlobalValue)`` that is an array
3903 of 24 ints, type ``[24 x i32]``, then the ``GlobalVariable`` is a pointer to
3904 that array.  Although the address of the first element of this array and the
3905 value of the ``GlobalVariable`` are the same, they have different types.  The
3906 ``GlobalVariable``'s type is ``[24 x i32]``.  The first element's type is
3907 ``i32.`` Because of this, accessing a global value requires you to dereference
3908 the pointer with ``GetElementPtrInst`` first, then its elements can be accessed.
3909 This is explained in the `LLVM Language Reference Manual
3910 <LangRef.html#globalvars>`_.
3912 .. _m_GlobalValue:
3914 Important Public Members of the ``GlobalValue`` class
3915 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3917 * | ``bool hasInternalLinkage() const``
3918   | ``bool hasExternalLinkage() const``
3919   | ``void setInternalLinkage(bool HasInternalLinkage)``
3921   These methods manipulate the linkage characteristics of the ``GlobalValue``.
3923 * ``Module *getParent()``
3925   This returns the Module_ that the
3926   GlobalValue is currently embedded into.
3928 .. _c_Function:
3930 The ``Function`` class
3931 ----------------------
3933 ``#include "llvm/IR/Function.h"``
3935 header source: `Function.h <http://llvm.org/doxygen/Function_8h_source.html>`_
3937 doxygen info: `Function Class
3938 <http://llvm.org/doxygen/classllvm_1_1Function.html>`_
3940 Superclasses: GlobalValue_, Constant_, User_, Value_
3942 The ``Function`` class represents a single procedure in LLVM.  It is actually
3943 one of the more complex classes in the LLVM hierarchy because it must keep track
3944 of a large amount of data.  The ``Function`` class keeps track of a list of
3945 BasicBlock_\ s, a list of formal Argument_\ s, and a SymbolTable_.
3947 The list of BasicBlock_\ s is the most commonly used part of ``Function``
3948 objects.  The list imposes an implicit ordering of the blocks in the function,
3949 which indicate how the code will be laid out by the backend.  Additionally, the
3950 first BasicBlock_ is the implicit entry node for the ``Function``.  It is not
3951 legal in LLVM to explicitly branch to this initial block.  There are no implicit
3952 exit nodes, and in fact there may be multiple exit nodes from a single
3953 ``Function``.  If the BasicBlock_ list is empty, this indicates that the
3954 ``Function`` is actually a function declaration: the actual body of the function
3955 hasn't been linked in yet.
3957 In addition to a list of BasicBlock_\ s, the ``Function`` class also keeps track
3958 of the list of formal Argument_\ s that the function receives.  This container
3959 manages the lifetime of the Argument_ nodes, just like the BasicBlock_ list does
3960 for the BasicBlock_\ s.
3962 The SymbolTable_ is a very rarely used LLVM feature that is only used when you
3963 have to look up a value by name.  Aside from that, the SymbolTable_ is used
3964 internally to make sure that there are not conflicts between the names of
3965 Instruction_\ s, BasicBlock_\ s, or Argument_\ s in the function body.
3967 Note that ``Function`` is a GlobalValue_ and therefore also a Constant_.  The
3968 value of the function is its address (after linking) which is guaranteed to be
3969 constant.
3971 .. _m_Function:
3973 Important Public Members of the ``Function``
3974 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3976 * ``Function(const FunctionType *Ty, LinkageTypes Linkage,
3977   const std::string &N = "", Module* Parent = 0)``
3979   Constructor used when you need to create new ``Function``\ s to add the
3980   program.  The constructor must specify the type of the function to create and
3981   what type of linkage the function should have.  The FunctionType_ argument
3982   specifies the formal arguments and return value for the function.  The same
3983   FunctionType_ value can be used to create multiple functions.  The ``Parent``
3984   argument specifies the Module in which the function is defined.  If this
3985   argument is provided, the function will automatically be inserted into that
3986   module's list of functions.
3988 * ``bool isDeclaration()``
3990   Return whether or not the ``Function`` has a body defined.  If the function is
3991   "external", it does not have a body, and thus must be resolved by linking with
3992   a function defined in a different translation unit.
3994 * | ``Function::iterator`` - Typedef for basic block list iterator
3995   | ``Function::const_iterator`` - Typedef for const_iterator.
3996   | ``begin()``, ``end()``, ``size()``, ``empty()``
3998   These are forwarding methods that make it easy to access the contents of a
3999   ``Function`` object's BasicBlock_ list.
4001 * ``Function::BasicBlockListType &getBasicBlockList()``
4003   Returns the list of BasicBlock_\ s.  This is necessary to use when you need to
4004   update the list or perform a complex action that doesn't have a forwarding
4005   method.
4007 * | ``Function::arg_iterator`` - Typedef for the argument list iterator
4008   | ``Function::const_arg_iterator`` - Typedef for const_iterator.
4009   | ``arg_begin()``, ``arg_end()``, ``arg_size()``, ``arg_empty()``
4011   These are forwarding methods that make it easy to access the contents of a
4012   ``Function`` object's Argument_ list.
4014 * ``Function::ArgumentListType &getArgumentList()``
4016   Returns the list of Argument_.  This is necessary to use when you need to
4017   update the list or perform a complex action that doesn't have a forwarding
4018   method.
4020 * ``BasicBlock &getEntryBlock()``
4022   Returns the entry ``BasicBlock`` for the function.  Because the entry block
4023   for the function is always the first block, this returns the first block of
4024   the ``Function``.
4026 * | ``Type *getReturnType()``
4027   | ``FunctionType *getFunctionType()``
4029   This traverses the Type_ of the ``Function`` and returns the return type of
4030   the function, or the FunctionType_ of the actual function.
4032 * ``SymbolTable *getSymbolTable()``
4034   Return a pointer to the SymbolTable_ for this ``Function``.
4036 .. _GlobalVariable:
4038 The ``GlobalVariable`` class
4039 ----------------------------
4041 ``#include "llvm/IR/GlobalVariable.h"``
4043 header source: `GlobalVariable.h
4044 <http://llvm.org/doxygen/GlobalVariable_8h_source.html>`_
4046 doxygen info: `GlobalVariable Class
4047 <http://llvm.org/doxygen/classllvm_1_1GlobalVariable.html>`_
4049 Superclasses: GlobalValue_, Constant_, User_, Value_
4051 Global variables are represented with the (surprise surprise) ``GlobalVariable``
4052 class.  Like functions, ``GlobalVariable``\ s are also subclasses of
4053 GlobalValue_, and as such are always referenced by their address (global values
4054 must live in memory, so their "name" refers to their constant address).  See
4055 GlobalValue_ for more on this.  Global variables may have an initial value
4056 (which must be a Constant_), and if they have an initializer, they may be marked
4057 as "constant" themselves (indicating that their contents never change at
4058 runtime).
4060 .. _m_GlobalVariable:
4062 Important Public Members of the ``GlobalVariable`` class
4063 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4065 * ``GlobalVariable(const Type *Ty, bool isConstant, LinkageTypes &Linkage,
4066   Constant *Initializer = 0, const std::string &Name = "", Module* Parent = 0)``
4068   Create a new global variable of the specified type.  If ``isConstant`` is true
4069   then the global variable will be marked as unchanging for the program.  The
4070   Linkage parameter specifies the type of linkage (internal, external, weak,
4071   linkonce, appending) for the variable.  If the linkage is InternalLinkage,
4072   WeakAnyLinkage, WeakODRLinkage, LinkOnceAnyLinkage or LinkOnceODRLinkage, then
4073   the resultant global variable will have internal linkage.  AppendingLinkage
4074   concatenates together all instances (in different translation units) of the
4075   variable into a single variable but is only applicable to arrays.  See the
4076   `LLVM Language Reference <LangRef.html#modulestructure>`_ for further details
4077   on linkage types.  Optionally an initializer, a name, and the module to put
4078   the variable into may be specified for the global variable as well.
4080 * ``bool isConstant() const``
4082   Returns true if this is a global variable that is known not to be modified at
4083   runtime.
4085 * ``bool hasInitializer()``
4087   Returns true if this ``GlobalVariable`` has an intializer.
4089 * ``Constant *getInitializer()``
4091   Returns the initial value for a ``GlobalVariable``.  It is not legal to call
4092   this method if there is no initializer.
4094 .. _BasicBlock:
4096 The ``BasicBlock`` class
4097 ------------------------
4099 ``#include "llvm/IR/BasicBlock.h"``
4101 header source: `BasicBlock.h
4102 <http://llvm.org/doxygen/BasicBlock_8h_source.html>`_
4104 doxygen info: `BasicBlock Class
4105 <http://llvm.org/doxygen/classllvm_1_1BasicBlock.html>`_
4107 Superclass: Value_
4109 This class represents a single entry single exit section of the code, commonly
4110 known as a basic block by the compiler community.  The ``BasicBlock`` class
4111 maintains a list of Instruction_\ s, which form the body of the block.  Matching
4112 the language definition, the last element of this list of instructions is always
4113 a terminator instruction.
4115 In addition to tracking the list of instructions that make up the block, the
4116 ``BasicBlock`` class also keeps track of the :ref:`Function <c_Function>` that
4117 it is embedded into.
4119 Note that ``BasicBlock``\ s themselves are Value_\ s, because they are
4120 referenced by instructions like branches and can go in the switch tables.
4121 ``BasicBlock``\ s have type ``label``.
4123 .. _m_BasicBlock:
4125 Important Public Members of the ``BasicBlock`` class
4126 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4128 * ``BasicBlock(const std::string &Name = "", Function *Parent = 0)``
4130   The ``BasicBlock`` constructor is used to create new basic blocks for
4131   insertion into a function.  The constructor optionally takes a name for the
4132   new block, and a :ref:`Function <c_Function>` to insert it into.  If the
4133   ``Parent`` parameter is specified, the new ``BasicBlock`` is automatically
4134   inserted at the end of the specified :ref:`Function <c_Function>`, if not
4135   specified, the BasicBlock must be manually inserted into the :ref:`Function
4136   <c_Function>`.
4138 * | ``BasicBlock::iterator`` - Typedef for instruction list iterator
4139   | ``BasicBlock::const_iterator`` - Typedef for const_iterator.
4140   | ``begin()``, ``end()``, ``front()``, ``back()``,
4141     ``size()``, ``empty()``
4142     STL-style functions for accessing the instruction list.
4144   These methods and typedefs are forwarding functions that have the same
4145   semantics as the standard library methods of the same names.  These methods
4146   expose the underlying instruction list of a basic block in a way that is easy
4147   to manipulate.  To get the full complement of container operations (including
4148   operations to update the list), you must use the ``getInstList()`` method.
4150 * ``BasicBlock::InstListType &getInstList()``
4152   This method is used to get access to the underlying container that actually
4153   holds the Instructions.  This method must be used when there isn't a
4154   forwarding function in the ``BasicBlock`` class for the operation that you
4155   would like to perform.  Because there are no forwarding functions for
4156   "updating" operations, you need to use this if you want to update the contents
4157   of a ``BasicBlock``.
4159 * ``Function *getParent()``
4161   Returns a pointer to :ref:`Function <c_Function>` the block is embedded into,
4162   or a null pointer if it is homeless.
4164 * ``Instruction *getTerminator()``
4166   Returns a pointer to the terminator instruction that appears at the end of the
4167   ``BasicBlock``.  If there is no terminator instruction, or if the last
4168   instruction in the block is not a terminator, then a null pointer is returned.
4170 .. _Argument:
4172 The ``Argument`` class
4173 ----------------------
4175 This subclass of Value defines the interface for incoming formal arguments to a
4176 function.  A Function maintains a list of its formal arguments.  An argument has
4177 a pointer to the parent Function.