Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / be207738d3b4bbfc9da11025ebbf10f4f12216b9 / . / docs / ProgrammersManual.html
blob: d3b7eefee36e687b9cd4a0ed7f9bde10f3beae69 [file] [log] [blame]
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3<html>
4<head>
5 <title>LLVM Programmer's Manual</title>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]6 <link rel="stylesheet" href="llvm.css" type="text/css">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]7</head>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]8<body>
9
10<div class="doc_title">
11 LLVM Programmer's Manual
12</div>
13
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]14<ol>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]15 <li><a href="#introduction">Introduction</a></li>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]16 <li><a href="#general">General Information</a>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]17 <ul>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]18 <li><a href="#stl">The C++ Standard Template Library</a></li>
19<!--
20 <li>The <tt>-time-passes</tt> option</li>
21 <li>How to use the LLVM Makefile system</li>
22 <li>How to write a regression test</li>
Chris Lattner61db4652004-12-08 19:05:44 +0000[diff] [blame]23
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]24-->
Chris Lattner84b7f8d2003-08-01 22:20:59 +0000[diff] [blame]25 </ul>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]26 </li>
27 <li><a href="#apis">Important and useful LLVM APIs</a>
28 <ul>
29 <li><a href="#isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt>
30and <tt>dyn_cast&lt;&gt;</tt> templates</a> </li>
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]31 <li><a href="#DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]32option</a>
33 <ul>
34 <li><a href="#DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt>
35and the <tt>-debug-only</tt> option</a> </li>
36 </ul>
37 </li>
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]38 <li><a href="#Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]39option</a></li>
40<!--
41 <li>The <tt>InstVisitor</tt> template
42 <li>The general graph API
43-->
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]44 <li><a href="#ViewGraph">Viewing graphs while debugging code</a></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]45 </ul>
46 </li>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]47 <li><a href="#datastructure">Picking the Right Data Structure for a Task</a>
48 <ul>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]49 <li><a href="#ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
50 <ul>
51 <li><a href="#dss_fixedarrays">Fixed Size Arrays</a></li>
52 <li><a href="#dss_heaparrays">Heap Allocated Arrays</a></li>
53 <li><a href="#dss_smallvector">"llvm/ADT/SmallVector.h"</a></li>
54 <li><a href="#dss_vector">&lt;vector&gt;</a></li>
55 <li><a href="#dss_deque">&lt;deque&gt;</a></li>
56 <li><a href="#dss_list">&lt;list&gt;</a></li>
57 <li><a href="#dss_ilist">llvm/ADT/ilist</a></li>
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]58 <li><a href="#dss_other">Other Sequential Container Options</a></li>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]59 </ul></li>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]60 <li><a href="#ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
61 <ul>
62 <li><a href="#dss_sortedvectorset">A sorted 'vector'</a></li>
63 <li><a href="#dss_smallset">"llvm/ADT/SmallSet.h"</a></li>
64 <li><a href="#dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a></li>
65 <li><a href="#dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a></li>
66 <li><a href="#dss_set">&lt;set&gt;</a></li>
67 <li><a href="#dss_setvector">"llvm/ADT/SetVector.h"</a></li>
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]68 <li><a href="#dss_uniquevector">"llvm/ADT/UniqueVector.h"</a></li>
69 <li><a href="#dss_otherset">Other Set-Like ContainerOptions</a></li>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]70 </ul></li>
Chris Lattnerf3692522007-02-03 19:51:56 +0000[diff] [blame]71 <li><a href="#ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
72 <ul>
73 <li><a href="#dss_sortedvectormap">A sorted 'vector'</a></li>
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]74 <li><a href="#dss_stringmap">"llvm/ADT/StringMap.h"</a></li>
Chris Lattnerf3692522007-02-03 19:51:56 +0000[diff] [blame]75 <li><a href="#dss_indexedmap">"llvm/ADT/IndexedMap.h"</a></li>
76 <li><a href="#dss_densemap">"llvm/ADT/DenseMap.h"</a></li>
77 <li><a href="#dss_map">&lt;map&gt;</a></li>
78 <li><a href="#dss_othermap">Other Map-Like Container Options</a></li>
79 </ul></li>
Daniel Berlin1939ace2007-09-24 17:52:25 +0000[diff] [blame]80 <li><a href="#ds_bit">BitVector-like containers</a>
81 <ul>
82 <li><a href="#dss_bitvector">A dense bitvector</a></li>
83 <li><a href="#dss_sparsebitvector">A sparse bitvector</a></li>
84 </ul></li>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]85 </ul>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]86 </li>
Chris Lattnerae7f7592002-09-06 18:31:18 +0000[diff] [blame]87 <li><a href="#common">Helpful Hints for Common Operations</a>
Chris Lattnerae7f7592002-09-06 18:31:18 +0000[diff] [blame]88 <ul>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]89 <li><a href="#inspection">Basic Inspection and Traversal Routines</a>
90 <ul>
91 <li><a href="#iterate_function">Iterating over the <tt>BasicBlock</tt>s
92in a <tt>Function</tt></a> </li>
93 <li><a href="#iterate_basicblock">Iterating over the <tt>Instruction</tt>s
94in a <tt>BasicBlock</tt></a> </li>
95 <li><a href="#iterate_institer">Iterating over the <tt>Instruction</tt>s
96in a <tt>Function</tt></a> </li>
97 <li><a href="#iterate_convert">Turning an iterator into a
98class pointer</a> </li>
99 <li><a href="#iterate_complex">Finding call sites: a more
100complex example</a> </li>
101 <li><a href="#calls_and_invokes">Treating calls and invokes
102the same way</a> </li>
103 <li><a href="#iterate_chains">Iterating over def-use &amp;
104use-def chains</a> </li>
105 </ul>
106 </li>
107 <li><a href="#simplechanges">Making simple changes</a>
108 <ul>
109 <li><a href="#schanges_creating">Creating and inserting new
110 <tt>Instruction</tt>s</a> </li>
111 <li><a href="#schanges_deleting">Deleting <tt>Instruction</tt>s</a> </li>
112 <li><a href="#schanges_replacing">Replacing an <tt>Instruction</tt>
113with another <tt>Value</tt></a> </li>
Tanya Lattnerb011c662007-06-20 18:33:15 +0000[diff] [blame]114 <li><a href="#schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a> </li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]115 </ul>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]116 </li>
Chris Lattnerae7f7592002-09-06 18:31:18 +0000[diff] [blame]117<!--
118 <li>Working with the Control Flow Graph
119 <ul>
120 <li>Accessing predecessors and successors of a <tt>BasicBlock</tt>
121 <li>
122 <li>
123 </ul>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]124-->
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]125 </ul>
126 </li>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]127
128 <li><a href="#advanced">Advanced Topics</a>
129 <ul>
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]130 <li><a href="#TypeResolve">LLVM Type Resolution</a>
131 <ul>
132 <li><a href="#BuildRecType">Basic Recursive Type Construction</a></li>
133 <li><a href="#refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a></li>
134 <li><a href="#PATypeHolder">The PATypeHolder Class</a></li>
135 <li><a href="#AbstractTypeUser">The AbstractTypeUser Class</a></li>
136 </ul></li>
137
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]138 <li><a href="#SymbolTable">The <tt>ValueSymbolTable</tt> and <tt>TypeSymbolTable</tt> classes </a></li>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]139 </ul></li>
140
Joel Stanley9b96c442002-09-06 21:55:13 +0000[diff] [blame]141 <li><a href="#coreclasses">The Core LLVM Class Hierarchy Reference</a>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]142 <ul>
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]143 <li><a href="#Type">The <tt>Type</tt> class</a> </li>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]144 <li><a href="#Module">The <tt>Module</tt> class</a></li>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]145 <li><a href="#Value">The <tt>Value</tt> class</a>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]146 <ul>
147 <li><a href="#User">The <tt>User</tt> class</a>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]148 <ul>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]149 <li><a href="#Instruction">The <tt>Instruction</tt> class</a></li>
150 <li><a href="#Constant">The <tt>Constant</tt> class</a>
151 <ul>
152 <li><a href="#GlobalValue">The <tt>GlobalValue</tt> class</a>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]153 <ul>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]154 <li><a href="#Function">The <tt>Function</tt> class</a></li>
155 <li><a href="#GlobalVariable">The <tt>GlobalVariable</tt> class</a></li>
156 </ul>
157 </li>
158 </ul>
159 </li>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]160 </ul>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]161 </li>
162 <li><a href="#BasicBlock">The <tt>BasicBlock</tt> class</a></li>
163 <li><a href="#Argument">The <tt>Argument</tt> class</a></li>
164 </ul>
Reid Spencerfe8f4ff2004-11-01 09:02:53 +0000[diff] [blame]165 </li>
166 </ul>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]167 </li>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]168</ol>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]169
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]170<div class="doc_author">
171 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>,
Chris Lattner94c43592004-05-26 16:52:55 +0000[diff] [blame]172 <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a>,
173 <a href="mailto:jstanley@cs.uiuc.edu">Joel Stanley</a>, and
174 <a href="mailto:rspencer@x10sys.com">Reid Spencer</a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]175</div>
176
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]177<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]178<div class="doc_section">
179 <a name="introduction">Introduction </a>
180</div>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]181<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]182
183<div class="doc_text">
184
185<p>This document is meant to highlight some of the important classes and
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]186interfaces available in the LLVM source-base. This manual is not
187intended to explain what LLVM is, how it works, and what LLVM code looks
188like. It assumes that you know the basics of LLVM and are interested
189in writing transformations or otherwise analyzing or manipulating the
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]190code.</p>
191
192<p>This document should get you oriented so that you can find your
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]193way in the continuously growing source code that makes up the LLVM
194infrastructure. Note that this manual is not intended to serve as a
195replacement for reading the source code, so if you think there should be
196a method in one of these classes to do something, but it's not listed,
197check the source. Links to the <a href="/doxygen/">doxygen</a> sources
198are provided to make this as easy as possible.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]199
200<p>The first section of this document describes general information that is
201useful to know when working in the LLVM infrastructure, and the second describes
202the Core LLVM classes. In the future this manual will be extended with
203information describing how to use extension libraries, such as dominator
204information, CFG traversal routines, and useful utilities like the <tt><a
205href="/doxygen/InstVisitor_8h-source.html">InstVisitor</a></tt> template.</p>
206
207</div>
208
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]209<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]210<div class="doc_section">
211 <a name="general">General Information</a>
212</div>
213<!-- *********************************************************************** -->
214
215<div class="doc_text">
216
217<p>This section contains general information that is useful if you are working
218in the LLVM source-base, but that isn't specific to any particular API.</p>
219
220</div>
221
222<!-- ======================================================================= -->
223<div class="doc_subsection">
224 <a name="stl">The C++ Standard Template Library</a>
225</div>
226
227<div class="doc_text">
228
229<p>LLVM makes heavy use of the C++ Standard Template Library (STL),
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]230perhaps much more than you are used to, or have seen before. Because of
231this, you might want to do a little background reading in the
232techniques used and capabilities of the library. There are many good
233pages that discuss the STL, and several books on the subject that you
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]234can get, so it will not be discussed in this document.</p>
235
236<p>Here are some useful links:</p>
237
238<ol>
239
240<li><a href="http://www.dinkumware.com/refxcpp.html">Dinkumware C++ Library
241reference</a> - an excellent reference for the STL and other parts of the
242standard C++ library.</li>
243
244<li><a href="http://www.tempest-sw.com/cpp/">C++ In a Nutshell</a> - This is an
Tanya Lattner09cf73c2004-06-22 04:24:55 +0000[diff] [blame]245O'Reilly book in the making. It has a decent
246Standard Library
247Reference that rivals Dinkumware's, and is unfortunately no longer free since the book has been
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]248published.</li>
249
250<li><a href="http://www.parashift.com/c++-faq-lite/">C++ Frequently Asked
251Questions</a></li>
252
253<li><a href="http://www.sgi.com/tech/stl/">SGI's STL Programmer's Guide</a> -
254Contains a useful <a
255href="http://www.sgi.com/tech/stl/stl_introduction.html">Introduction to the
256STL</a>.</li>
257
258<li><a href="http://www.research.att.com/%7Ebs/C++.html">Bjarne Stroustrup's C++
259Page</a></li>
260
Tanya Lattner79445ba2004-12-08 18:34:56 +0000[diff] [blame]261<li><a href="http://64.78.49.204/">
Reid Spencer096603a2004-05-26 08:41:35 +0000[diff] [blame]262Bruce Eckel's Thinking in C++, 2nd ed. Volume 2 Revision 4.0 (even better, get
263the book).</a></li>
264
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]265</ol>
266
267<p>You are also encouraged to take a look at the <a
268href="CodingStandards.html">LLVM Coding Standards</a> guide which focuses on how
269to write maintainable code more than where to put your curly braces.</p>
270
271</div>
272
273<!-- ======================================================================= -->
274<div class="doc_subsection">
275 <a name="stl">Other useful references</a>
276</div>
277
278<div class="doc_text">
279
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]280<ol>
281<li><a href="http://www.psc.edu/%7Esemke/cvs_branches.html">CVS
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]282Branch and Tag Primer</a></li>
Misha Brukmana0f71e42004-06-18 18:39:00 +0000[diff] [blame]283<li><a href="http://www.fortran-2000.com/ArnaudRecipes/sharedlib.html">Using
284static and shared libraries across platforms</a></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]285</ol>
286
287</div>
288
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]289<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]290<div class="doc_section">
291 <a name="apis">Important and useful LLVM APIs</a>
292</div>
293<!-- *********************************************************************** -->
294
295<div class="doc_text">
296
297<p>Here we highlight some LLVM APIs that are generally useful and good to
298know about when writing transformations.</p>
299
300</div>
301
302<!-- ======================================================================= -->
303<div class="doc_subsection">
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]304 <a name="isa">The <tt>isa&lt;&gt;</tt>, <tt>cast&lt;&gt;</tt> and
305 <tt>dyn_cast&lt;&gt;</tt> templates</a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]306</div>
307
308<div class="doc_text">
309
310<p>The LLVM source-base makes extensive use of a custom form of RTTI.
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]311These templates have many similarities to the C++ <tt>dynamic_cast&lt;&gt;</tt>
312operator, but they don't have some drawbacks (primarily stemming from
313the fact that <tt>dynamic_cast&lt;&gt;</tt> only works on classes that
314have a v-table). Because they are used so often, you must know what they
315do and how they work. All of these templates are defined in the <a
Chris Lattner695b78b2005-04-26 22:56:16 +0000[diff] [blame]316 href="/doxygen/Casting_8h-source.html"><tt>llvm/Support/Casting.h</tt></a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]317file (note that you very rarely have to include this file directly).</p>
318
319<dl>
320 <dt><tt>isa&lt;&gt;</tt>: </dt>
321
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]322 <dd><p>The <tt>isa&lt;&gt;</tt> operator works exactly like the Java
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]323 "<tt>instanceof</tt>" operator. It returns true or false depending on whether
324 a reference or pointer points to an instance of the specified class. This can
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]325 be very useful for constraint checking of various sorts (example below).</p>
326 </dd>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]327
328 <dt><tt>cast&lt;&gt;</tt>: </dt>
329
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]330 <dd><p>The <tt>cast&lt;&gt;</tt> operator is a "checked cast" operation. It
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]331 converts a pointer or reference from a base class to a derived cast, causing
332 an assertion failure if it is not really an instance of the right type. This
333 should be used in cases where you have some information that makes you believe
334 that something is of the right type. An example of the <tt>isa&lt;&gt;</tt>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]335 and <tt>cast&lt;&gt;</tt> template is:</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]336
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]337<div class="doc_code">
338<pre>
339static bool isLoopInvariant(const <a href="#Value">Value</a> *V, const Loop *L) {
340 if (isa&lt;<a href="#Constant">Constant</a>&gt;(V) || isa&lt;<a href="#Argument">Argument</a>&gt;(V) || isa&lt;<a href="#GlobalValue">GlobalValue</a>&gt;(V))
341 return true;
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]342
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]343 // <i>Otherwise, it must be an instruction...</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]344 return !L-&gt;contains(cast&lt;<a href="#Instruction">Instruction</a>&gt;(V)-&gt;getParent());
345}
346</pre>
347</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]348
349 <p>Note that you should <b>not</b> use an <tt>isa&lt;&gt;</tt> test followed
350 by a <tt>cast&lt;&gt;</tt>, for that use the <tt>dyn_cast&lt;&gt;</tt>
351 operator.</p>
352
353 </dd>
354
355 <dt><tt>dyn_cast&lt;&gt;</tt>:</dt>
356
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]357 <dd><p>The <tt>dyn_cast&lt;&gt;</tt> operator is a "checking cast" operation.
358 It checks to see if the operand is of the specified type, and if so, returns a
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]359 pointer to it (this operator does not work with references). If the operand is
360 not of the correct type, a null pointer is returned. Thus, this works very
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]361 much like the <tt>dynamic_cast&lt;&gt;</tt> operator in C++, and should be
362 used in the same circumstances. Typically, the <tt>dyn_cast&lt;&gt;</tt>
363 operator is used in an <tt>if</tt> statement or some other flow control
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]364 statement like this:</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]365
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]366<div class="doc_code">
367<pre>
368if (<a href="#AllocationInst">AllocationInst</a> *AI = dyn_cast&lt;<a href="#AllocationInst">AllocationInst</a>&gt;(Val)) {
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]369 // <i>...</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]370}
371</pre>
372</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]373
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]374 <p>This form of the <tt>if</tt> statement effectively combines together a call
375 to <tt>isa&lt;&gt;</tt> and a call to <tt>cast&lt;&gt;</tt> into one
376 statement, which is very convenient.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]377
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]378 <p>Note that the <tt>dyn_cast&lt;&gt;</tt> operator, like C++'s
379 <tt>dynamic_cast&lt;&gt;</tt> or Java's <tt>instanceof</tt> operator, can be
380 abused. In particular, you should not use big chained <tt>if/then/else</tt>
381 blocks to check for lots of different variants of classes. If you find
382 yourself wanting to do this, it is much cleaner and more efficient to use the
383 <tt>InstVisitor</tt> class to dispatch over the instruction type directly.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]384
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]385 </dd>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]386
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]387 <dt><tt>cast_or_null&lt;&gt;</tt>: </dt>
388
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]389 <dd><p>The <tt>cast_or_null&lt;&gt;</tt> operator works just like the
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]390 <tt>cast&lt;&gt;</tt> operator, except that it allows for a null pointer as an
391 argument (which it then propagates). This can sometimes be useful, allowing
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]392 you to combine several null checks into one.</p></dd>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]393
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]394 <dt><tt>dyn_cast_or_null&lt;&gt;</tt>: </dt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]395
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]396 <dd><p>The <tt>dyn_cast_or_null&lt;&gt;</tt> operator works just like the
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]397 <tt>dyn_cast&lt;&gt;</tt> operator, except that it allows for a null pointer
398 as an argument (which it then propagates). This can sometimes be useful,
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]399 allowing you to combine several null checks into one.</p></dd>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]400
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]401</dl>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]402
403<p>These five templates can be used with any classes, whether they have a
404v-table or not. To add support for these templates, you simply need to add
405<tt>classof</tt> static methods to the class you are interested casting
406to. Describing this is currently outside the scope of this document, but there
407are lots of examples in the LLVM source base.</p>
408
409</div>
410
411<!-- ======================================================================= -->
412<div class="doc_subsection">
Misha Brukman2c122ce2005-11-01 21:12:49 +0000[diff] [blame]413 <a name="DEBUG">The <tt>DEBUG()</tt> macro and <tt>-debug</tt> option</a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]414</div>
415
416<div class="doc_text">
417
418<p>Often when working on your pass you will put a bunch of debugging printouts
419and other code into your pass. After you get it working, you want to remove
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]420it, but you may need it again in the future (to work out new bugs that you run
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]421across).</p>
422
423<p> Naturally, because of this, you don't want to delete the debug printouts,
424but you don't want them to always be noisy. A standard compromise is to comment
425them out, allowing you to enable them if you need them in the future.</p>
426
Chris Lattner695b78b2005-04-26 22:56:16 +0000[diff] [blame]427<p>The "<tt><a href="/doxygen/Debug_8h-source.html">llvm/Support/Debug.h</a></tt>"
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]428file provides a macro named <tt>DEBUG()</tt> that is a much nicer solution to
429this problem. Basically, you can put arbitrary code into the argument of the
430<tt>DEBUG</tt> macro, and it is only executed if '<tt>opt</tt>' (or any other
431tool) is run with the '<tt>-debug</tt>' command line argument:</p>
432
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]433<div class="doc_code">
434<pre>
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]435DOUT &lt;&lt; "I am here!\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]436</pre>
437</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]438
439<p>Then you can run your pass like this:</p>
440
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]441<div class="doc_code">
442<pre>
443$ opt &lt; a.bc &gt; /dev/null -mypass
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]444<i>&lt;no output&gt;</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]445$ opt &lt; a.bc &gt; /dev/null -mypass -debug
446I am here!
447</pre>
448</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]449
450<p>Using the <tt>DEBUG()</tt> macro instead of a home-brewed solution allows you
451to not have to create "yet another" command line option for the debug output for
452your pass. Note that <tt>DEBUG()</tt> macros are disabled for optimized builds,
453so they do not cause a performance impact at all (for the same reason, they
454should also not contain side-effects!).</p>
455
456<p>One additional nice thing about the <tt>DEBUG()</tt> macro is that you can
457enable or disable it directly in gdb. Just use "<tt>set DebugFlag=0</tt>" or
458"<tt>set DebugFlag=1</tt>" from the gdb if the program is running. If the
459program hasn't been started yet, you can always just run it with
460<tt>-debug</tt>.</p>
461
462</div>
463
464<!-- _______________________________________________________________________ -->
465<div class="doc_subsubsection">
Chris Lattnerc9151082005-04-26 22:57:07 +0000[diff] [blame]466 <a name="DEBUG_TYPE">Fine grained debug info with <tt>DEBUG_TYPE</tt> and
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]467 the <tt>-debug-only</tt> option</a>
468</div>
469
470<div class="doc_text">
471
472<p>Sometimes you may find yourself in a situation where enabling <tt>-debug</tt>
473just turns on <b>too much</b> information (such as when working on the code
474generator). If you want to enable debug information with more fine-grained
475control, you define the <tt>DEBUG_TYPE</tt> macro and the <tt>-debug</tt> only
476option as follows:</p>
477
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]478<div class="doc_code">
479<pre>
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]480DOUT &lt;&lt; "No debug type\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]481#undef DEBUG_TYPE
482#define DEBUG_TYPE "foo"
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]483DOUT &lt;&lt; "'foo' debug type\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]484#undef DEBUG_TYPE
485#define DEBUG_TYPE "bar"
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]486DOUT &lt;&lt; "'bar' debug type\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]487#undef DEBUG_TYPE
488#define DEBUG_TYPE ""
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]489DOUT &lt;&lt; "No debug type (2)\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]490</pre>
491</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]492
493<p>Then you can run your pass like this:</p>
494
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]495<div class="doc_code">
496<pre>
497$ opt &lt; a.bc &gt; /dev/null -mypass
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]498<i>&lt;no output&gt;</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]499$ opt &lt; a.bc &gt; /dev/null -mypass -debug
500No debug type
501'foo' debug type
502'bar' debug type
503No debug type (2)
504$ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=foo
505'foo' debug type
506$ opt &lt; a.bc &gt; /dev/null -mypass -debug-only=bar
507'bar' debug type
508</pre>
509</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]510
511<p>Of course, in practice, you should only set <tt>DEBUG_TYPE</tt> at the top of
512a file, to specify the debug type for the entire module (if you do this before
Chris Lattner695b78b2005-04-26 22:56:16 +0000[diff] [blame]513you <tt>#include "llvm/Support/Debug.h"</tt>, you don't have to insert the ugly
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]514<tt>#undef</tt>'s). Also, you should use names more meaningful than "foo" and
515"bar", because there is no system in place to ensure that names do not
516conflict. If two different modules use the same string, they will all be turned
517on when the name is specified. This allows, for example, all debug information
518for instruction scheduling to be enabled with <tt>-debug-type=InstrSched</tt>,
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]519even if the source lives in multiple files.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]520
521</div>
522
523<!-- ======================================================================= -->
524<div class="doc_subsection">
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]525 <a name="Statistic">The <tt>Statistic</tt> class &amp; <tt>-stats</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]526 option</a>
527</div>
528
529<div class="doc_text">
530
531<p>The "<tt><a
Chris Lattner695b78b2005-04-26 22:56:16 +0000[diff] [blame]532href="/doxygen/Statistic_8h-source.html">llvm/ADT/Statistic.h</a></tt>" file
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]533provides a class named <tt>Statistic</tt> that is used as a unified way to
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]534keep track of what the LLVM compiler is doing and how effective various
535optimizations are. It is useful to see what optimizations are contributing to
536making a particular program run faster.</p>
537
538<p>Often you may run your pass on some big program, and you're interested to see
539how many times it makes a certain transformation. Although you can do this with
540hand inspection, or some ad-hoc method, this is a real pain and not very useful
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]541for big programs. Using the <tt>Statistic</tt> class makes it very easy to
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]542keep track of this information, and the calculated information is presented in a
543uniform manner with the rest of the passes being executed.</p>
544
545<p>There are many examples of <tt>Statistic</tt> uses, but the basics of using
546it are as follows:</p>
547
548<ol>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]549 <li><p>Define your statistic like this:</p>
550
551<div class="doc_code">
552<pre>
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]553#define <a href="#DEBUG_TYPE">DEBUG_TYPE</a> "mypassname" <i>// This goes before any #includes.</i>
554STATISTIC(NumXForms, "The # of times I did stuff");
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]555</pre>
556</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]557
Chris Lattner0be6fdf2006-12-19 21:46:21 +0000[diff] [blame]558 <p>The <tt>STATISTIC</tt> macro defines a static variable, whose name is
559 specified by the first argument. The pass name is taken from the DEBUG_TYPE
560 macro, and the description is taken from the second argument. The variable
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]561 defined ("NumXForms" in this case) acts like an unsigned integer.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]562
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]563 <li><p>Whenever you make a transformation, bump the counter:</p>
564
565<div class="doc_code">
566<pre>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]567++NumXForms; // <i>I did stuff!</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]568</pre>
569</div>
570
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]571 </li>
572 </ol>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]573
574 <p>That's all you have to do. To get '<tt>opt</tt>' to print out the
575 statistics gathered, use the '<tt>-stats</tt>' option:</p>
576
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]577<div class="doc_code">
578<pre>
579$ opt -stats -mypassname &lt; program.bc &gt; /dev/null
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]580<i>... statistics output ...</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]581</pre>
582</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]583
Reid Spencer6b6c73e2007-02-09 16:00:28 +0000[diff] [blame]584 <p> When running <tt>opt</tt> on a C file from the SPEC benchmark
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]585suite, it gives a report that looks like this:</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]586
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]587<div class="doc_code">
588<pre>
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]589 7646 bitcodewriter - Number of normal instructions
590 725 bitcodewriter - Number of oversized instructions
591 129996 bitcodewriter - Number of bitcode bytes written
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]592 2817 raise - Number of insts DCEd or constprop'd
593 3213 raise - Number of cast-of-self removed
594 5046 raise - Number of expression trees converted
595 75 raise - Number of other getelementptr's formed
596 138 raise - Number of load/store peepholes
597 42 deadtypeelim - Number of unused typenames removed from symtab
598 392 funcresolve - Number of varargs functions resolved
599 27 globaldce - Number of global variables removed
600 2 adce - Number of basic blocks removed
601 134 cee - Number of branches revectored
602 49 cee - Number of setcc instruction eliminated
603 532 gcse - Number of loads removed
604 2919 gcse - Number of instructions removed
605 86 indvars - Number of canonical indvars added
606 87 indvars - Number of aux indvars removed
607 25 instcombine - Number of dead inst eliminate
608 434 instcombine - Number of insts combined
609 248 licm - Number of load insts hoisted
610 1298 licm - Number of insts hoisted to a loop pre-header
611 3 licm - Number of insts hoisted to multiple loop preds (bad, no loop pre-header)
612 75 mem2reg - Number of alloca's promoted
613 1444 cfgsimplify - Number of blocks simplified
614</pre>
615</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]616
617<p>Obviously, with so many optimizations, having a unified framework for this
618stuff is very nice. Making your pass fit well into the framework makes it more
619maintainable and useful.</p>
620
621</div>
622
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]623<!-- ======================================================================= -->
624<div class="doc_subsection">
625 <a name="ViewGraph">Viewing graphs while debugging code</a>
626</div>
627
628<div class="doc_text">
629
630<p>Several of the important data structures in LLVM are graphs: for example
631CFGs made out of LLVM <a href="#BasicBlock">BasicBlock</a>s, CFGs made out of
632LLVM <a href="CodeGenerator.html#machinebasicblock">MachineBasicBlock</a>s, and
633<a href="CodeGenerator.html#selectiondag_intro">Instruction Selection
634DAGs</a>. In many cases, while debugging various parts of the compiler, it is
635nice to instantly visualize these graphs.</p>
636
637<p>LLVM provides several callbacks that are available in a debug build to do
638exactly that. If you call the <tt>Function::viewCFG()</tt> method, for example,
639the current LLVM tool will pop up a window containing the CFG for the function
640where each basic block is a node in the graph, and each node contains the
641instructions in the block. Similarly, there also exists
642<tt>Function::viewCFGOnly()</tt> (does not include the instructions), the
643<tt>MachineFunction::viewCFG()</tt> and <tt>MachineFunction::viewCFGOnly()</tt>,
644and the <tt>SelectionDAG::viewGraph()</tt> methods. Within GDB, for example,
Jim Laskey543a0ee2006-10-02 12:28:07 +0000[diff] [blame]645you can usually use something like <tt>call DAG.viewGraph()</tt> to pop
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]646up a window. Alternatively, you can sprinkle calls to these functions in your
647code in places you want to debug.</p>
648
649<p>Getting this to work requires a small amount of configuration. On Unix
650systems with X11, install the <a href="http://www.graphviz.org">graphviz</a>
651toolkit, and make sure 'dot' and 'gv' are in your path. If you are running on
652Mac OS/X, download and install the Mac OS/X <a
653href="http://www.pixelglow.com/graphviz/">Graphviz program</a>, and add
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]654<tt>/Applications/Graphviz.app/Contents/MacOS/</tt> (or wherever you install
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]655it) to your path. Once in your system and path are set up, rerun the LLVM
656configure script and rebuild LLVM to enable this functionality.</p>
657
Jim Laskey543a0ee2006-10-02 12:28:07 +0000[diff] [blame]658<p><tt>SelectionDAG</tt> has been extended to make it easier to locate
659<i>interesting</i> nodes in large complex graphs. From gdb, if you
660<tt>call DAG.setGraphColor(<i>node</i>, "<i>color</i>")</tt>, then the
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]661next <tt>call DAG.viewGraph()</tt> would highlight the node in the
Jim Laskey543a0ee2006-10-02 12:28:07 +0000[diff] [blame]662specified color (choices of colors can be found at <a
Chris Lattner302da1e2007-02-03 03:05:57 +0000[diff] [blame]663href="http://www.graphviz.org/doc/info/colors.html">colors</a>.) More
Jim Laskey543a0ee2006-10-02 12:28:07 +0000[diff] [blame]664complex node attributes can be provided with <tt>call
665DAG.setGraphAttrs(<i>node</i>, "<i>attributes</i>")</tt> (choices can be
666found at <a href="http://www.graphviz.org/doc/info/attrs.html">Graph
667Attributes</a>.) If you want to restart and clear all the current graph
668attributes, then you can <tt>call DAG.clearGraphAttrs()</tt>. </p>
669
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]670</div>
671
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]672<!-- *********************************************************************** -->
673<div class="doc_section">
674 <a name="datastructure">Picking the Right Data Structure for a Task</a>
675</div>
676<!-- *********************************************************************** -->
677
678<div class="doc_text">
679
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]680<p>LLVM has a plethora of data structures in the <tt>llvm/ADT/</tt> directory,
681 and we commonly use STL data structures. This section describes the trade-offs
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]682 you should consider when you pick one.</p>
683
684<p>
685The first step is a choose your own adventure: do you want a sequential
686container, a set-like container, or a map-like container? The most important
687thing when choosing a container is the algorithmic properties of how you plan to
688access the container. Based on that, you should use:</p>
689
690<ul>
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]691<li>a <a href="#ds_map">map-like</a> container if you need efficient look-up
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]692 of an value based on another value. Map-like containers also support
693 efficient queries for containment (whether a key is in the map). Map-like
694 containers generally do not support efficient reverse mapping (values to
695 keys). If you need that, use two maps. Some map-like containers also
696 support efficient iteration through the keys in sorted order. Map-like
697 containers are the most expensive sort, only use them if you need one of
698 these capabilities.</li>
699
700<li>a <a href="#ds_set">set-like</a> container if you need to put a bunch of
701 stuff into a container that automatically eliminates duplicates. Some
702 set-like containers support efficient iteration through the elements in
703 sorted order. Set-like containers are more expensive than sequential
704 containers.
705</li>
706
707<li>a <a href="#ds_sequential">sequential</a> container provides
708 the most efficient way to add elements and keeps track of the order they are
709 added to the collection. They permit duplicates and support efficient
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]710 iteration, but do not support efficient look-up based on a key.
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]711</li>
712
Daniel Berlin1939ace2007-09-24 17:52:25 +0000[diff] [blame]713<li>a <a href="#ds_bit">bit</a> container provides an efficient way to store and
714 perform set operations on sets of numeric id's, while automatically
715 eliminating duplicates. Bit containers require a maximum of 1 bit for each
716 identifier you want to store.
717</li>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]718</ul>
719
720<p>
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]721Once the proper category of container is determined, you can fine tune the
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]722memory use, constant factors, and cache behaviors of access by intelligently
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]723picking a member of the category. Note that constant factors and cache behavior
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]724can be a big deal. If you have a vector that usually only contains a few
725elements (but could contain many), for example, it's much better to use
726<a href="#dss_smallvector">SmallVector</a> than <a href="#dss_vector">vector</a>
727. Doing so avoids (relatively) expensive malloc/free calls, which dwarf the
728cost of adding the elements to the container. </p>
729
730</div>
731
732<!-- ======================================================================= -->
733<div class="doc_subsection">
734 <a name="ds_sequential">Sequential Containers (std::vector, std::list, etc)</a>
735</div>
736
737<div class="doc_text">
738There are a variety of sequential containers available for you, based on your
739needs. Pick the first in this section that will do what you want.
740</div>
741
742<!-- _______________________________________________________________________ -->
743<div class="doc_subsubsection">
744 <a name="dss_fixedarrays">Fixed Size Arrays</a>
745</div>
746
747<div class="doc_text">
748<p>Fixed size arrays are very simple and very fast. They are good if you know
749exactly how many elements you have, or you have a (low) upper bound on how many
750you have.</p>
751</div>
752
753<!-- _______________________________________________________________________ -->
754<div class="doc_subsubsection">
755 <a name="dss_heaparrays">Heap Allocated Arrays</a>
756</div>
757
758<div class="doc_text">
759<p>Heap allocated arrays (new[] + delete[]) are also simple. They are good if
760the number of elements is variable, if you know how many elements you will need
761before the array is allocated, and if the array is usually large (if not,
762consider a <a href="#dss_smallvector">SmallVector</a>). The cost of a heap
763allocated array is the cost of the new/delete (aka malloc/free). Also note that
764if you are allocating an array of a type with a constructor, the constructor and
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]765destructors will be run for every element in the array (re-sizable vectors only
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]766construct those elements actually used).</p>
767</div>
768
769<!-- _______________________________________________________________________ -->
770<div class="doc_subsubsection">
771 <a name="dss_smallvector">"llvm/ADT/SmallVector.h"</a>
772</div>
773
774<div class="doc_text">
775<p><tt>SmallVector&lt;Type, N&gt;</tt> is a simple class that looks and smells
776just like <tt>vector&lt;Type&gt;</tt>:
777it supports efficient iteration, lays out elements in memory order (so you can
778do pointer arithmetic between elements), supports efficient push_back/pop_back
779operations, supports efficient random access to its elements, etc.</p>
780
781<p>The advantage of SmallVector is that it allocates space for
782some number of elements (N) <b>in the object itself</b>. Because of this, if
783the SmallVector is dynamically smaller than N, no malloc is performed. This can
784be a big win in cases where the malloc/free call is far more expensive than the
785code that fiddles around with the elements.</p>
786
787<p>This is good for vectors that are "usually small" (e.g. the number of
788predecessors/successors of a block is usually less than 8). On the other hand,
789this makes the size of the SmallVector itself large, so you don't want to
790allocate lots of them (doing so will waste a lot of space). As such,
791SmallVectors are most useful when on the stack.</p>
792
793<p>SmallVector also provides a nice portable and efficient replacement for
794<tt>alloca</tt>.</p>
795
796</div>
797
798<!-- _______________________________________________________________________ -->
799<div class="doc_subsubsection">
800 <a name="dss_vector">&lt;vector&gt;</a>
801</div>
802
803<div class="doc_text">
804<p>
805std::vector is well loved and respected. It is useful when SmallVector isn't:
806when the size of the vector is often large (thus the small optimization will
807rarely be a benefit) or if you will be allocating many instances of the vector
808itself (which would waste space for elements that aren't in the container).
809vector is also useful when interfacing with code that expects vectors :).
810</p>
Chris Lattner32d84762007-02-05 06:30:51 +0000[diff] [blame]811
812<p>One worthwhile note about std::vector: avoid code like this:</p>
813
814<div class="doc_code">
815<pre>
816for ( ... ) {
Chris Lattner9bb3dbb2007-03-28 18:27:57 +0000[diff] [blame]817 std::vector&lt;foo&gt; V;
Chris Lattner32d84762007-02-05 06:30:51 +0000[diff] [blame]818 use V;
819}
820</pre>
821</div>
822
823<p>Instead, write this as:</p>
824
825<div class="doc_code">
826<pre>
Chris Lattner9bb3dbb2007-03-28 18:27:57 +0000[diff] [blame]827std::vector&lt;foo&gt; V;
Chris Lattner32d84762007-02-05 06:30:51 +0000[diff] [blame]828for ( ... ) {
829 use V;
830 V.clear();
831}
832</pre>
833</div>
834
835<p>Doing so will save (at least) one heap allocation and free per iteration of
836the loop.</p>
837
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]838</div>
839
840<!-- _______________________________________________________________________ -->
841<div class="doc_subsubsection">
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]842 <a name="dss_deque">&lt;deque&gt;</a>
843</div>
844
845<div class="doc_text">
846<p>std::deque is, in some senses, a generalized version of std::vector. Like
847std::vector, it provides constant time random access and other similar
848properties, but it also provides efficient access to the front of the list. It
849does not guarantee continuity of elements within memory.</p>
850
851<p>In exchange for this extra flexibility, std::deque has significantly higher
852constant factor costs than std::vector. If possible, use std::vector or
853something cheaper.</p>
854</div>
855
856<!-- _______________________________________________________________________ -->
857<div class="doc_subsubsection">
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]858 <a name="dss_list">&lt;list&gt;</a>
859</div>
860
861<div class="doc_text">
862<p>std::list is an extremely inefficient class that is rarely useful.
863It performs a heap allocation for every element inserted into it, thus having an
864extremely high constant factor, particularly for small data types. std::list
865also only supports bidirectional iteration, not random access iteration.</p>
866
867<p>In exchange for this high cost, std::list supports efficient access to both
868ends of the list (like std::deque, but unlike std::vector or SmallVector). In
869addition, the iterator invalidation characteristics of std::list are stronger
870than that of a vector class: inserting or removing an element into the list does
871not invalidate iterator or pointers to other elements in the list.</p>
872</div>
873
874<!-- _______________________________________________________________________ -->
875<div class="doc_subsubsection">
876 <a name="dss_ilist">llvm/ADT/ilist</a>
877</div>
878
879<div class="doc_text">
880<p><tt>ilist&lt;T&gt;</tt> implements an 'intrusive' doubly-linked list. It is
881intrusive, because it requires the element to store and provide access to the
882prev/next pointers for the list.</p>
883
884<p>ilist has the same drawbacks as std::list, and additionally requires an
885ilist_traits implementation for the element type, but it provides some novel
886characteristics. In particular, it can efficiently store polymorphic objects,
887the traits class is informed when an element is inserted or removed from the
888list, and ilists are guaranteed to support a constant-time splice operation.
889</p>
890
891<p>These properties are exactly what we want for things like Instructions and
892basic blocks, which is why these are implemented with ilists.</p>
893</div>
894
895<!-- _______________________________________________________________________ -->
896<div class="doc_subsubsection">
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]897 <a name="dss_other">Other Sequential Container options</a>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]898</div>
899
900<div class="doc_text">
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]901<p>Other STL containers are available, such as std::string.</p>
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]902
903<p>There are also various STL adapter classes such as std::queue,
904std::priority_queue, std::stack, etc. These provide simplified access to an
905underlying container but don't affect the cost of the container itself.</p>
906
907</div>
908
909
910<!-- ======================================================================= -->
911<div class="doc_subsection">
912 <a name="ds_set">Set-Like Containers (std::set, SmallSet, SetVector, etc)</a>
913</div>
914
915<div class="doc_text">
916
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]917<p>Set-like containers are useful when you need to canonicalize multiple values
918into a single representation. There are several different choices for how to do
919this, providing various trade-offs.</p>
920
921</div>
922
923
924<!-- _______________________________________________________________________ -->
925<div class="doc_subsubsection">
926 <a name="dss_sortedvectorset">A sorted 'vector'</a>
927</div>
928
929<div class="doc_text">
930
Chris Lattner3b23a8c2007-02-03 08:10:45 +0000[diff] [blame]931<p>If you intend to insert a lot of elements, then do a lot of queries, a
932great approach is to use a vector (or other sequential container) with
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]933std::sort+std::unique to remove duplicates. This approach works really well if
Chris Lattner3b23a8c2007-02-03 08:10:45 +0000[diff] [blame]934your usage pattern has these two distinct phases (insert then query), and can be
935coupled with a good choice of <a href="#ds_sequential">sequential container</a>.
936</p>
937
938<p>
939This combination provides the several nice properties: the result data is
940contiguous in memory (good for cache locality), has few allocations, is easy to
941address (iterators in the final vector are just indices or pointers), and can be
942efficiently queried with a standard binary or radix search.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]943
944</div>
945
946<!-- _______________________________________________________________________ -->
947<div class="doc_subsubsection">
948 <a name="dss_smallset">"llvm/ADT/SmallSet.h"</a>
949</div>
950
951<div class="doc_text">
952
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]953<p>If you have a set-like data structure that is usually small and whose elements
Chris Lattner4ddfac12007-02-03 07:59:51 +0000[diff] [blame]954are reasonably small, a <tt>SmallSet&lt;Type, N&gt;</tt> is a good choice. This set
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]955has space for N elements in place (thus, if the set is dynamically smaller than
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]956N, no malloc traffic is required) and accesses them with a simple linear search.
957When the set grows beyond 'N' elements, it allocates a more expensive representation that
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]958guarantees efficient access (for most types, it falls back to std::set, but for
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]959pointers it uses something far better, <a
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]960href="#dss_smallptrset">SmallPtrSet</a>).</p>
961
962<p>The magic of this class is that it handles small sets extremely efficiently,
963but gracefully handles extremely large sets without loss of efficiency. The
964drawback is that the interface is quite small: it supports insertion, queries
965and erasing, but does not support iteration.</p>
966
967</div>
968
969<!-- _______________________________________________________________________ -->
970<div class="doc_subsubsection">
971 <a name="dss_smallptrset">"llvm/ADT/SmallPtrSet.h"</a>
972</div>
973
974<div class="doc_text">
975
976<p>SmallPtrSet has all the advantages of SmallSet (and a SmallSet of pointers is
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]977transparently implemented with a SmallPtrSet), but also supports iterators. If
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]978more than 'N' insertions are performed, a single quadratically
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]979probed hash table is allocated and grows as needed, providing extremely
980efficient access (constant time insertion/deleting/queries with low constant
981factors) and is very stingy with malloc traffic.</p>
982
983<p>Note that, unlike std::set, the iterators of SmallPtrSet are invalidated
984whenever an insertion occurs. Also, the values visited by the iterators are not
985visited in sorted order.</p>
986
987</div>
988
989<!-- _______________________________________________________________________ -->
990<div class="doc_subsubsection">
991 <a name="dss_FoldingSet">"llvm/ADT/FoldingSet.h"</a>
992</div>
993
994<div class="doc_text">
995
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]996<p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]997FoldingSet is an aggregate class that is really good at uniquing
998expensive-to-create or polymorphic objects. It is a combination of a chained
999hash table with intrusive links (uniqued objects are required to inherit from
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1000FoldingSetNode) that uses <a href="#dss_smallvector">SmallVector</a> as part of
1001its ID process.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1002
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1003<p>Consider a case where you want to implement a "getOrCreateFoo" method for
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1004a complex object (for example, a node in the code generator). The client has a
1005description of *what* it wants to generate (it knows the opcode and all the
1006operands), but we don't want to 'new' a node, then try inserting it into a set
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1007only to find out it already exists, at which point we would have to delete it
1008and return the node that already exists.
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]1009</p>
1010
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1011<p>To support this style of client, FoldingSet perform a query with a
1012FoldingSetNodeID (which wraps SmallVector) that can be used to describe the
1013element that we want to query for. The query either returns the element
1014matching the ID or it returns an opaque ID that indicates where insertion should
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1015take place. Construction of the ID usually does not require heap traffic.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1016
1017<p>Because FoldingSet uses intrusive links, it can support polymorphic objects
1018in the set (for example, you can have SDNode instances mixed with LoadSDNodes).
1019Because the elements are individually allocated, pointers to the elements are
1020stable: inserting or removing elements does not invalidate any pointers to other
1021elements.
1022</p>
1023
1024</div>
1025
1026<!-- _______________________________________________________________________ -->
1027<div class="doc_subsubsection">
1028 <a name="dss_set">&lt;set&gt;</a>
1029</div>
1030
1031<div class="doc_text">
1032
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1033<p><tt>std::set</tt> is a reasonable all-around set class, which is decent at
1034many things but great at nothing. std::set allocates memory for each element
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1035inserted (thus it is very malloc intensive) and typically stores three pointers
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1036per element in the set (thus adding a large amount of per-element space
1037overhead). It offers guaranteed log(n) performance, which is not particularly
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1038fast from a complexity standpoint (particularly if the elements of the set are
1039expensive to compare, like strings), and has extremely high constant factors for
1040lookup, insertion and removal.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1041
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1042<p>The advantages of std::set are that its iterators are stable (deleting or
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1043inserting an element from the set does not affect iterators or pointers to other
1044elements) and that iteration over the set is guaranteed to be in sorted order.
1045If the elements in the set are large, then the relative overhead of the pointers
1046and malloc traffic is not a big deal, but if the elements of the set are small,
1047std::set is almost never a good choice.</p>
1048
1049</div>
1050
1051<!-- _______________________________________________________________________ -->
1052<div class="doc_subsubsection">
1053 <a name="dss_setvector">"llvm/ADT/SetVector.h"</a>
1054</div>
1055
1056<div class="doc_text">
Chris Lattneredca3c52007-02-04 00:00:26 +0000[diff] [blame]1057<p>LLVM's SetVector&lt;Type&gt; is an adapter class that combines your choice of
1058a set-like container along with a <a href="#ds_sequential">Sequential
1059Container</a>. The important property
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1060that this provides is efficient insertion with uniquing (duplicate elements are
1061ignored) with iteration support. It implements this by inserting elements into
1062both a set-like container and the sequential container, using the set-like
1063container for uniquing and the sequential container for iteration.
1064</p>
1065
1066<p>The difference between SetVector and other sets is that the order of
1067iteration is guaranteed to match the order of insertion into the SetVector.
1068This property is really important for things like sets of pointers. Because
1069pointer values are non-deterministic (e.g. vary across runs of the program on
Chris Lattneredca3c52007-02-04 00:00:26 +0000[diff] [blame]1070different machines), iterating over the pointers in the set will
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1071not be in a well-defined order.</p>
1072
1073<p>
1074The drawback of SetVector is that it requires twice as much space as a normal
1075set and has the sum of constant factors from the set-like container and the
1076sequential container that it uses. Use it *only* if you need to iterate over
1077the elements in a deterministic order. SetVector is also expensive to delete
Chris Lattneredca3c52007-02-04 00:00:26 +0000[diff] [blame]1078elements out of (linear time), unless you use it's "pop_back" method, which is
1079faster.
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1080</p>
1081
Chris Lattneredca3c52007-02-04 00:00:26 +0000[diff] [blame]1082<p>SetVector is an adapter class that defaults to using std::vector and std::set
1083for the underlying containers, so it is quite expensive. However,
1084<tt>"llvm/ADT/SetVector.h"</tt> also provides a SmallSetVector class, which
1085defaults to using a SmallVector and SmallSet of a specified size. If you use
1086this, and if your sets are dynamically smaller than N, you will save a lot of
1087heap traffic.</p>
1088
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1089</div>
1090
1091<!-- _______________________________________________________________________ -->
1092<div class="doc_subsubsection">
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1093 <a name="dss_uniquevector">"llvm/ADT/UniqueVector.h"</a>
1094</div>
1095
1096<div class="doc_text">
1097
1098<p>
1099UniqueVector is similar to <a href="#dss_setvector">SetVector</a>, but it
1100retains a unique ID for each element inserted into the set. It internally
1101contains a map and a vector, and it assigns a unique ID for each value inserted
1102into the set.</p>
1103
1104<p>UniqueVector is very expensive: its cost is the sum of the cost of
1105maintaining both the map and vector, it has high complexity, high constant
1106factors, and produces a lot of malloc traffic. It should be avoided.</p>
1107
1108</div>
1109
1110
1111<!-- _______________________________________________________________________ -->
1112<div class="doc_subsubsection">
1113 <a name="dss_otherset">Other Set-Like Container Options</a>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1114</div>
1115
1116<div class="doc_text">
1117
1118<p>
1119The STL provides several other options, such as std::multiset and the various
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1120"hash_set" like containers (whether from C++ TR1 or from the SGI library).</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1121
1122<p>std::multiset is useful if you're not interested in elimination of
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1123duplicates, but has all the drawbacks of std::set. A sorted vector (where you
1124don't delete duplicate entries) or some other approach is almost always
1125better.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1126
1127<p>The various hash_set implementations (exposed portably by
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1128"llvm/ADT/hash_set") is a simple chained hashtable. This algorithm is as malloc
1129intensive as std::set (performing an allocation for each element inserted,
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1130thus having really high constant factors) but (usually) provides O(1)
1131insertion/deletion of elements. This can be useful if your elements are large
Chris Lattner14868db2007-02-03 08:20:15 +0000[diff] [blame]1132(thus making the constant-factor cost relatively low) or if comparisons are
1133expensive. Element iteration does not visit elements in a useful order.</p>
Chris Lattner74c4ca12007-02-03 07:59:07 +0000[diff] [blame]1134
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]1135</div>
1136
1137<!-- ======================================================================= -->
1138<div class="doc_subsection">
1139 <a name="ds_map">Map-Like Containers (std::map, DenseMap, etc)</a>
1140</div>
1141
1142<div class="doc_text">
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1143Map-like containers are useful when you want to associate data to a key. As
1144usual, there are a lot of different ways to do this. :)
1145</div>
1146
1147<!-- _______________________________________________________________________ -->
1148<div class="doc_subsubsection">
1149 <a name="dss_sortedvectormap">A sorted 'vector'</a>
1150</div>
1151
1152<div class="doc_text">
1153
1154<p>
1155If your usage pattern follows a strict insert-then-query approach, you can
1156trivially use the same approach as <a href="#dss_sortedvectorset">sorted vectors
1157for set-like containers</a>. The only difference is that your query function
1158(which uses std::lower_bound to get efficient log(n) lookup) should only compare
1159the key, not both the key and value. This yields the same advantages as sorted
1160vectors for sets.
1161</p>
1162</div>
1163
1164<!-- _______________________________________________________________________ -->
1165<div class="doc_subsubsection">
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1166 <a name="dss_stringmap">"llvm/ADT/StringMap.h"</a>
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1167</div>
1168
1169<div class="doc_text">
1170
1171<p>
1172Strings are commonly used as keys in maps, and they are difficult to support
1173efficiently: they are variable length, inefficient to hash and compare when
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1174long, expensive to copy, etc. StringMap is a specialized container designed to
1175cope with these issues. It supports mapping an arbitrary range of bytes to an
1176arbitrary other object.</p>
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1177
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1178<p>The StringMap implementation uses a quadratically-probed hash table, where
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1179the buckets store a pointer to the heap allocated entries (and some other
1180stuff). The entries in the map must be heap allocated because the strings are
1181variable length. The string data (key) and the element object (value) are
1182stored in the same allocation with the string data immediately after the element
1183object. This container guarantees the "<tt>(char*)(&amp;Value+1)</tt>" points
1184to the key string for a value.</p>
1185
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1186<p>The StringMap is very fast for several reasons: quadratic probing is very
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1187cache efficient for lookups, the hash value of strings in buckets is not
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1188recomputed when lookup up an element, StringMap rarely has to touch the
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1189memory for unrelated objects when looking up a value (even when hash collisions
1190happen), hash table growth does not recompute the hash values for strings
1191already in the table, and each pair in the map is store in a single allocation
1192(the string data is stored in the same allocation as the Value of a pair).</p>
1193
Chris Lattner796f9fa2007-02-08 19:14:21 +0000[diff] [blame]1194<p>StringMap also provides query methods that take byte ranges, so it only ever
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1195copies a string if a value is inserted into the table.</p>
1196</div>
1197
1198<!-- _______________________________________________________________________ -->
1199<div class="doc_subsubsection">
1200 <a name="dss_indexedmap">"llvm/ADT/IndexedMap.h"</a>
1201</div>
1202
1203<div class="doc_text">
1204<p>
1205IndexedMap is a specialized container for mapping small dense integers (or
1206values that can be mapped to small dense integers) to some other type. It is
1207internally implemented as a vector with a mapping function that maps the keys to
1208the dense integer range.
1209</p>
1210
1211<p>
1212This is useful for cases like virtual registers in the LLVM code generator: they
1213have a dense mapping that is offset by a compile-time constant (the first
1214virtual register ID).</p>
1215
1216</div>
1217
1218<!-- _______________________________________________________________________ -->
1219<div class="doc_subsubsection">
1220 <a name="dss_densemap">"llvm/ADT/DenseMap.h"</a>
1221</div>
1222
1223<div class="doc_text">
1224
1225<p>
1226DenseMap is a simple quadratically probed hash table. It excels at supporting
1227small keys and values: it uses a single allocation to hold all of the pairs that
1228are currently inserted in the map. DenseMap is a great way to map pointers to
1229pointers, or map other small types to each other.
1230</p>
1231
1232<p>
1233There are several aspects of DenseMap that you should be aware of, however. The
1234iterators in a densemap are invalidated whenever an insertion occurs, unlike
1235map. Also, because DenseMap allocates space for a large number of key/value
Chris Lattnera4a264d2007-02-03 20:17:53 +0000[diff] [blame]1236pairs (it starts with 64 by default), it will waste a lot of space if your keys
1237or values are large. Finally, you must implement a partial specialization of
Chris Lattner76c1b972007-09-17 18:34:04 +0000[diff] [blame]1238DenseMapInfo for the key that you want, if it isn't already supported. This
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1239is required to tell DenseMap about two special marker values (which can never be
Chris Lattnera4a264d2007-02-03 20:17:53 +0000[diff] [blame]1240inserted into the map) that it needs internally.</p>
Chris Lattnerc5722432007-02-03 19:49:31 +0000[diff] [blame]1241
1242</div>
1243
1244<!-- _______________________________________________________________________ -->
1245<div class="doc_subsubsection">
1246 <a name="dss_map">&lt;map&gt;</a>
1247</div>
1248
1249<div class="doc_text">
1250
1251<p>
1252std::map has similar characteristics to <a href="#dss_set">std::set</a>: it uses
1253a single allocation per pair inserted into the map, it offers log(n) lookup with
1254an extremely large constant factor, imposes a space penalty of 3 pointers per
1255pair in the map, etc.</p>
1256
1257<p>std::map is most useful when your keys or values are very large, if you need
1258to iterate over the collection in sorted order, or if you need stable iterators
1259into the map (i.e. they don't get invalidated if an insertion or deletion of
1260another element takes place).</p>
1261
1262</div>
1263
1264<!-- _______________________________________________________________________ -->
1265<div class="doc_subsubsection">
1266 <a name="dss_othermap">Other Map-Like Container Options</a>
1267</div>
1268
1269<div class="doc_text">
1270
1271<p>
1272The STL provides several other options, such as std::multimap and the various
1273"hash_map" like containers (whether from C++ TR1 or from the SGI library).</p>
1274
1275<p>std::multimap is useful if you want to map a key to multiple values, but has
1276all the drawbacks of std::map. A sorted vector or some other approach is almost
1277always better.</p>
1278
1279<p>The various hash_map implementations (exposed portably by
1280"llvm/ADT/hash_map") are simple chained hash tables. This algorithm is as
1281malloc intensive as std::map (performing an allocation for each element
1282inserted, thus having really high constant factors) but (usually) provides O(1)
1283insertion/deletion of elements. This can be useful if your elements are large
1284(thus making the constant-factor cost relatively low) or if comparisons are
1285expensive. Element iteration does not visit elements in a useful order.</p>
1286
Chris Lattner098129a2007-02-03 03:04:03 +0000[diff] [blame]1287</div>
1288
Daniel Berlin1939ace2007-09-24 17:52:25 +0000[diff] [blame]1289<!-- ======================================================================= -->
1290<div class="doc_subsection">
1291 <a name="ds_bit">Bit storage containers (BitVector, SparseBitVector)</a>
1292</div>
1293
1294<div class="doc_text">
Chris Lattner7086ce72007-09-25 22:37:50 +0000[diff] [blame]1295<p>Unlike the other containers, there are only two bit storage containers, and
1296choosing when to use each is relatively straightforward.</p>
1297
1298<p>One additional option is
1299<tt>std::vector&lt;bool&gt;</tt>: we discourage its use for two reasons 1) the
1300implementation in many common compilers (e.g. commonly available versions of
1301GCC) is extremely inefficient and 2) the C++ standards committee is likely to
1302deprecate this container and/or change it significantly somehow. In any case,
1303please don't use it.</p>
Daniel Berlin1939ace2007-09-24 17:52:25 +0000[diff] [blame]1304</div>
1305
1306<!-- _______________________________________________________________________ -->
1307<div class="doc_subsubsection">
1308 <a name="dss_bitvector">BitVector</a>
1309</div>
1310
1311<div class="doc_text">
1312<p> The BitVector container provides a fixed size set of bits for manipulation.
1313It supports individual bit setting/testing, as well as set operations. The set
1314operations take time O(size of bitvector), but operations are performed one word
1315at a time, instead of one bit at a time. This makes the BitVector very fast for
1316set operations compared to other containers. Use the BitVector when you expect
1317the number of set bits to be high (IE a dense set).
1318</p>
1319</div>
1320
1321<!-- _______________________________________________________________________ -->
1322<div class="doc_subsubsection">
1323 <a name="dss_sparsebitvector">SparseBitVector</a>
1324</div>
1325
1326<div class="doc_text">
1327<p> The SparseBitVector container is much like BitVector, with one major
1328difference: Only the bits that are set, are stored. This makes the
1329SparseBitVector much more space efficient than BitVector when the set is sparse,
1330as well as making set operations O(number of set bits) instead of O(size of
1331universe). The downside to the SparseBitVector is that setting and testing of random bits is O(N), and on large SparseBitVectors, this can be slower than BitVector. In our implementation, setting or testing bits in sorted order
1332(either forwards or reverse) is O(1) worst case. Testing and setting bits within 128 bits (depends on size) of the current bit is also O(1). As a general statement, testing/setting bits in a SparseBitVector is O(distance away from last set bit).
1333</p>
1334</div>
Chris Lattnerf623a082005-10-17 01:36:23 +0000[diff] [blame]1335
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1336<!-- *********************************************************************** -->
1337<div class="doc_section">
1338 <a name="common">Helpful Hints for Common Operations</a>
1339</div>
1340<!-- *********************************************************************** -->
1341
1342<div class="doc_text">
1343
1344<p>This section describes how to perform some very simple transformations of
1345LLVM code. This is meant to give examples of common idioms used, showing the
1346practical side of LLVM transformations. <p> Because this is a "how-to" section,
1347you should also read about the main classes that you will be working with. The
1348<a href="#coreclasses">Core LLVM Class Hierarchy Reference</a> contains details
1349and descriptions of the main classes that you should know about.</p>
1350
1351</div>
1352
1353<!-- NOTE: this section should be heavy on example code -->
1354<!-- ======================================================================= -->
1355<div class="doc_subsection">
1356 <a name="inspection">Basic Inspection and Traversal Routines</a>
1357</div>
1358
1359<div class="doc_text">
1360
1361<p>The LLVM compiler infrastructure have many different data structures that may
1362be traversed. Following the example of the C++ standard template library, the
1363techniques used to traverse these various data structures are all basically the
1364same. For a enumerable sequence of values, the <tt>XXXbegin()</tt> function (or
1365method) returns an iterator to the start of the sequence, the <tt>XXXend()</tt>
1366function returns an iterator pointing to one past the last valid element of the
1367sequence, and there is some <tt>XXXiterator</tt> data type that is common
1368between the two operations.</p>
1369
1370<p>Because the pattern for iteration is common across many different aspects of
1371the program representation, the standard template library algorithms may be used
1372on them, and it is easier to remember how to iterate. First we show a few common
1373examples of the data structures that need to be traversed. Other data
1374structures are traversed in very similar ways.</p>
1375
1376</div>
1377
1378<!-- _______________________________________________________________________ -->
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1379<div class="doc_subsubsection">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1380 <a name="iterate_function">Iterating over the </a><a
1381 href="#BasicBlock"><tt>BasicBlock</tt></a>s in a <a
1382 href="#Function"><tt>Function</tt></a>
1383</div>
1384
1385<div class="doc_text">
1386
1387<p>It's quite common to have a <tt>Function</tt> instance that you'd like to
1388transform in some way; in particular, you'd like to manipulate its
1389<tt>BasicBlock</tt>s. To facilitate this, you'll need to iterate over all of
1390the <tt>BasicBlock</tt>s that constitute the <tt>Function</tt>. The following is
1391an example that prints the name of a <tt>BasicBlock</tt> and the number of
1392<tt>Instruction</tt>s it contains:</p>
1393
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1394<div class="doc_code">
1395<pre>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1396// <i>func is a pointer to a Function instance</i>
1397for (Function::iterator i = func-&gt;begin(), e = func-&gt;end(); i != e; ++i)
1398 // <i>Print out the name of the basic block if it has one, and then the</i>
1399 // <i>number of instructions that it contains</i>
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1400 llvm::cerr &lt;&lt; "Basic block (name=" &lt;&lt; i-&gt;getName() &lt;&lt; ") has "
1401 &lt;&lt; i-&gt;size() &lt;&lt; " instructions.\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1402</pre>
1403</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1404
1405<p>Note that i can be used as if it were a pointer for the purposes of
Joel Stanley9b96c442002-09-06 21:55:13 +0000[diff] [blame]1406invoking member functions of the <tt>Instruction</tt> class. This is
1407because the indirection operator is overloaded for the iterator
Chris Lattner7496ec52003-08-05 22:54:23 +0000[diff] [blame]1408classes. In the above code, the expression <tt>i-&gt;size()</tt> is
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1409exactly equivalent to <tt>(*i).size()</tt> just like you'd expect.</p>
1410
1411</div>
1412
1413<!-- _______________________________________________________________________ -->
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1414<div class="doc_subsubsection">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1415 <a name="iterate_basicblock">Iterating over the </a><a
1416 href="#Instruction"><tt>Instruction</tt></a>s in a <a
1417 href="#BasicBlock"><tt>BasicBlock</tt></a>
1418</div>
1419
1420<div class="doc_text">
1421
1422<p>Just like when dealing with <tt>BasicBlock</tt>s in <tt>Function</tt>s, it's
1423easy to iterate over the individual instructions that make up
1424<tt>BasicBlock</tt>s. Here's a code snippet that prints out each instruction in
1425a <tt>BasicBlock</tt>:</p>
1426
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1427<div class="doc_code">
Chris Lattner55c04612005-03-06 06:00:13 +0000[diff] [blame]1428<pre>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1429// <i>blk is a pointer to a BasicBlock instance</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1430for (BasicBlock::iterator i = blk-&gt;begin(), e = blk-&gt;end(); i != e; ++i)
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1431 // <i>The next statement works since operator&lt;&lt;(ostream&amp;,...)</i>
1432 // <i>is overloaded for Instruction&amp;</i>
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1433 llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
Chris Lattner55c04612005-03-06 06:00:13 +0000[diff] [blame]1434</pre>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1435</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1436
1437<p>However, this isn't really the best way to print out the contents of a
1438<tt>BasicBlock</tt>! Since the ostream operators are overloaded for virtually
1439anything you'll care about, you could have just invoked the print routine on the
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1440basic block itself: <tt>llvm::cerr &lt;&lt; *blk &lt;&lt; "\n";</tt>.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1441
1442</div>
1443
1444<!-- _______________________________________________________________________ -->
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1445<div class="doc_subsubsection">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1446 <a name="iterate_institer">Iterating over the </a><a
1447 href="#Instruction"><tt>Instruction</tt></a>s in a <a
1448 href="#Function"><tt>Function</tt></a>
1449</div>
1450
1451<div class="doc_text">
1452
1453<p>If you're finding that you commonly iterate over a <tt>Function</tt>'s
1454<tt>BasicBlock</tt>s and then that <tt>BasicBlock</tt>'s <tt>Instruction</tt>s,
1455<tt>InstIterator</tt> should be used instead. You'll need to include <a
1456href="/doxygen/InstIterator_8h-source.html"><tt>llvm/Support/InstIterator.h</tt></a>,
1457and then instantiate <tt>InstIterator</tt>s explicitly in your code. Here's a
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1458small example that shows how to dump all instructions in a function to the standard error stream:<p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1459
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1460<div class="doc_code">
1461<pre>
1462#include "<a href="/doxygen/InstIterator_8h-source.html">llvm/Support/InstIterator.h</a>"
1463
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1464// <i>F is a pointer to a Function instance</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1465for (inst_iterator i = inst_begin(F), e = inst_end(F); i != e; ++i)
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1466 llvm::cerr &lt;&lt; *i &lt;&lt; "\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1467</pre>
1468</div>
1469
1470<p>Easy, isn't it? You can also use <tt>InstIterator</tt>s to fill a
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1471work list with its initial contents. For example, if you wanted to
1472initialize a work list to contain all instructions in a <tt>Function</tt>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1473F, all you would need to do is something like:</p>
1474
1475<div class="doc_code">
1476<pre>
1477std::set&lt;Instruction*&gt; worklist;
1478worklist.insert(inst_begin(F), inst_end(F));
1479</pre>
1480</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1481
1482<p>The STL set <tt>worklist</tt> would now contain all instructions in the
1483<tt>Function</tt> pointed to by F.</p>
1484
1485</div>
1486
1487<!-- _______________________________________________________________________ -->
1488<div class="doc_subsubsection">
1489 <a name="iterate_convert">Turning an iterator into a class pointer (and
1490 vice-versa)</a>
1491</div>
1492
1493<div class="doc_text">
1494
1495<p>Sometimes, it'll be useful to grab a reference (or pointer) to a class
Joel Stanley9b96c442002-09-06 21:55:13 +0000[diff] [blame]1496instance when all you've got at hand is an iterator. Well, extracting
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1497a reference or a pointer from an iterator is very straight-forward.
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1498Assuming that <tt>i</tt> is a <tt>BasicBlock::iterator</tt> and <tt>j</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1499is a <tt>BasicBlock::const_iterator</tt>:</p>
1500
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1501<div class="doc_code">
1502<pre>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1503Instruction&amp; inst = *i; // <i>Grab reference to instruction reference</i>
1504Instruction* pinst = &amp;*i; // <i>Grab pointer to instruction reference</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1505const Instruction&amp; inst = *j;
1506</pre>
1507</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1508
1509<p>However, the iterators you'll be working with in the LLVM framework are
1510special: they will automatically convert to a ptr-to-instance type whenever they
1511need to. Instead of dereferencing the iterator and then taking the address of
1512the result, you can simply assign the iterator to the proper pointer type and
1513you get the dereference and address-of operation as a result of the assignment
1514(behind the scenes, this is a result of overloading casting mechanisms). Thus
1515the last line of the last example,</p>
1516
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1517<div class="doc_code">
1518<pre>
1519Instruction* pinst = &amp;*i;
1520</pre>
1521</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1522
1523<p>is semantically equivalent to</p>
1524
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1525<div class="doc_code">
1526<pre>
1527Instruction* pinst = i;
1528</pre>
1529</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1530
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1531<p>It's also possible to turn a class pointer into the corresponding iterator,
1532and this is a constant time operation (very efficient). The following code
1533snippet illustrates use of the conversion constructors provided by LLVM
1534iterators. By using these, you can explicitly grab the iterator of something
1535without actually obtaining it via iteration over some structure:</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1536
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1537<div class="doc_code">
1538<pre>
1539void printNextInstruction(Instruction* inst) {
1540 BasicBlock::iterator it(inst);
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1541 ++it; // <i>After this line, it refers to the instruction after *inst</i>
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1542 if (it != inst-&gt;getParent()-&gt;end()) llvm::cerr &lt;&lt; *it &lt;&lt; "\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1543}
1544</pre>
1545</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1546
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1547</div>
1548
1549<!--_______________________________________________________________________-->
1550<div class="doc_subsubsection">
1551 <a name="iterate_complex">Finding call sites: a slightly more complex
1552 example</a>
1553</div>
1554
1555<div class="doc_text">
1556
1557<p>Say that you're writing a FunctionPass and would like to count all the
1558locations in the entire module (that is, across every <tt>Function</tt>) where a
1559certain function (i.e., some <tt>Function</tt>*) is already in scope. As you'll
1560learn later, you may want to use an <tt>InstVisitor</tt> to accomplish this in a
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1561much more straight-forward manner, but this example will allow us to explore how
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1562you'd do it if you didn't have <tt>InstVisitor</tt> around. In pseudo-code, this
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1563is what we want to do:</p>
1564
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1565<div class="doc_code">
1566<pre>
1567initialize callCounter to zero
1568for each Function f in the Module
1569 for each BasicBlock b in f
1570 for each Instruction i in b
1571 if (i is a CallInst and calls the given function)
1572 increment callCounter
1573</pre>
1574</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1575
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1576<p>And the actual code is (remember, because we're writing a
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1577<tt>FunctionPass</tt>, our <tt>FunctionPass</tt>-derived class simply has to
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1578override the <tt>runOnFunction</tt> method):</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1579
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1580<div class="doc_code">
1581<pre>
1582Function* targetFunc = ...;
1583
1584class OurFunctionPass : public FunctionPass {
1585 public:
1586 OurFunctionPass(): callCounter(0) { }
1587
1588 virtual runOnFunction(Function&amp; F) {
1589 for (Function::iterator b = F.begin(), be = F.end(); b != be; ++b) {
1590 for (BasicBlock::iterator i = b-&gt;begin(); ie = b-&gt;end(); i != ie; ++i) {
1591 if (<a href="#CallInst">CallInst</a>* callInst = <a href="#isa">dyn_cast</a>&lt;<a
1592 href="#CallInst">CallInst</a>&gt;(&amp;*i)) {
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1593 // <i>We know we've encountered a call instruction, so we</i>
1594 // <i>need to determine if it's a call to the</i>
1595 // <i>function pointed to by m_func or not</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1596
1597 if (callInst-&gt;getCalledFunction() == targetFunc)
1598 ++callCounter;
1599 }
1600 }
1601 }
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1602 }
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1603
1604 private:
1605 unsigned callCounter;
1606};
1607</pre>
1608</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1609
1610</div>
1611
Brian Gaekef1972c62003-11-07 19:25:45 +0000[diff] [blame]1612<!--_______________________________________________________________________-->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1613<div class="doc_subsubsection">
1614 <a name="calls_and_invokes">Treating calls and invokes the same way</a>
1615</div>
1616
1617<div class="doc_text">
1618
1619<p>You may have noticed that the previous example was a bit oversimplified in
1620that it did not deal with call sites generated by 'invoke' instructions. In
1621this, and in other situations, you may find that you want to treat
1622<tt>CallInst</tt>s and <tt>InvokeInst</tt>s the same way, even though their
1623most-specific common base class is <tt>Instruction</tt>, which includes lots of
1624less closely-related things. For these cases, LLVM provides a handy wrapper
1625class called <a
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1626href="http://llvm.org/doxygen/classllvm_1_1CallSite.html"><tt>CallSite</tt></a>.
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1627It is essentially a wrapper around an <tt>Instruction</tt> pointer, with some
1628methods that provide functionality common to <tt>CallInst</tt>s and
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1629<tt>InvokeInst</tt>s.</p>
1630
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1631<p>This class has "value semantics": it should be passed by value, not by
1632reference and it should not be dynamically allocated or deallocated using
1633<tt>operator new</tt> or <tt>operator delete</tt>. It is efficiently copyable,
1634assignable and constructable, with costs equivalents to that of a bare pointer.
1635If you look at its definition, it has only a single pointer member.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1636
1637</div>
1638
Chris Lattner1a3105b2002-09-09 05:49:39 +0000[diff] [blame]1639<!--_______________________________________________________________________-->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1640<div class="doc_subsubsection">
1641 <a name="iterate_chains">Iterating over def-use &amp; use-def chains</a>
1642</div>
1643
1644<div class="doc_text">
1645
1646<p>Frequently, we might have an instance of the <a
Chris Lattner00815172007-01-04 22:01:45 +0000[diff] [blame]1647href="/doxygen/classllvm_1_1Value.html">Value Class</a> and we want to
Misha Brukman384047f2004-06-03 23:29:12 +0000[diff] [blame]1648determine which <tt>User</tt>s use the <tt>Value</tt>. The list of all
1649<tt>User</tt>s of a particular <tt>Value</tt> is called a <i>def-use</i> chain.
1650For example, let's say we have a <tt>Function*</tt> named <tt>F</tt> to a
1651particular function <tt>foo</tt>. Finding all of the instructions that
1652<i>use</i> <tt>foo</tt> is as simple as iterating over the <i>def-use</i> chain
1653of <tt>F</tt>:</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1654
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1655<div class="doc_code">
1656<pre>
1657Function* F = ...;
1658
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1659for (Value::use_iterator i = F-&gt;use_begin(), e = F-&gt;use_end(); i != e; ++i)
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1660 if (Instruction *Inst = dyn_cast&lt;Instruction&gt;(*i)) {
Bill Wendling832171c2006-12-07 20:04:42 +0000[diff] [blame]1661 llvm::cerr &lt;&lt; "F is used in instruction:\n";
1662 llvm::cerr &lt;&lt; *Inst &lt;&lt; "\n";
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1663 }
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1664</pre>
1665</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1666
1667<p>Alternately, it's common to have an instance of the <a
Misha Brukman384047f2004-06-03 23:29:12 +0000[diff] [blame]1668href="/doxygen/classllvm_1_1User.html">User Class</a> and need to know what
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1669<tt>Value</tt>s are used by it. The list of all <tt>Value</tt>s used by a
1670<tt>User</tt> is known as a <i>use-def</i> chain. Instances of class
1671<tt>Instruction</tt> are common <tt>User</tt>s, so we might want to iterate over
1672all of the values that a particular instruction uses (that is, the operands of
1673the particular <tt>Instruction</tt>):</p>
1674
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1675<div class="doc_code">
1676<pre>
1677Instruction* pi = ...;
1678
1679for (User::op_iterator i = pi-&gt;op_begin(), e = pi-&gt;op_end(); i != e; ++i) {
1680 Value* v = *i;
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1681 // <i>...</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1682}
1683</pre>
1684</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1685
Chris Lattner1a3105b2002-09-09 05:49:39 +0000[diff] [blame]1686<!--
1687 def-use chains ("finding all users of"): Value::use_begin/use_end
1688 use-def chains ("finding all values used"): User::op_begin/op_end [op=operand]
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1689-->
1690
1691</div>
1692
1693<!-- ======================================================================= -->
1694<div class="doc_subsection">
1695 <a name="simplechanges">Making simple changes</a>
1696</div>
1697
1698<div class="doc_text">
1699
1700<p>There are some primitive transformation operations present in the LLVM
Joel Stanley753eb712002-09-11 22:32:24 +0000[diff] [blame]1701infrastructure that are worth knowing about. When performing
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1702transformations, it's fairly common to manipulate the contents of basic
1703blocks. This section describes some of the common methods for doing so
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1704and gives example code.</p>
1705
1706</div>
1707
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1708<!--_______________________________________________________________________-->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1709<div class="doc_subsubsection">
1710 <a name="schanges_creating">Creating and inserting new
1711 <tt>Instruction</tt>s</a>
1712</div>
1713
1714<div class="doc_text">
1715
1716<p><i>Instantiating Instructions</i></p>
1717
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1718<p>Creation of <tt>Instruction</tt>s is straight-forward: simply call the
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1719constructor for the kind of instruction to instantiate and provide the necessary
1720parameters. For example, an <tt>AllocaInst</tt> only <i>requires</i> a
1721(const-ptr-to) <tt>Type</tt>. Thus:</p>
1722
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1723<div class="doc_code">
1724<pre>
1725AllocaInst* ai = new AllocaInst(Type::IntTy);
1726</pre>
1727</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1728
1729<p>will create an <tt>AllocaInst</tt> instance that represents the allocation of
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1730one integer in the current stack frame, at run time. Each <tt>Instruction</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1731subclass is likely to have varying default parameters which change the semantics
1732of the instruction, so refer to the <a
Misha Brukman31ca1de2004-06-03 23:35:54 +0000[diff] [blame]1733href="/doxygen/classllvm_1_1Instruction.html">doxygen documentation for the subclass of
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1734Instruction</a> that you're interested in instantiating.</p>
1735
1736<p><i>Naming values</i></p>
1737
1738<p>It is very useful to name the values of instructions when you're able to, as
1739this facilitates the debugging of your transformations. If you end up looking
1740at generated LLVM machine code, you definitely want to have logical names
1741associated with the results of instructions! By supplying a value for the
1742<tt>Name</tt> (default) parameter of the <tt>Instruction</tt> constructor, you
1743associate a logical name with the result of the instruction's execution at
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1744run time. For example, say that I'm writing a transformation that dynamically
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1745allocates space for an integer on the stack, and that integer is going to be
1746used as some kind of index by some other code. To accomplish this, I place an
1747<tt>AllocaInst</tt> at the first point in the first <tt>BasicBlock</tt> of some
1748<tt>Function</tt>, and I'm intending to use it within the same
1749<tt>Function</tt>. I might do:</p>
1750
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1751<div class="doc_code">
1752<pre>
1753AllocaInst* pa = new AllocaInst(Type::IntTy, 0, "indexLoc");
1754</pre>
1755</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1756
1757<p>where <tt>indexLoc</tt> is now the logical name of the instruction's
Reid Spencer128a7a72007-02-03 21:06:43 +0000[diff] [blame]1758execution value, which is a pointer to an integer on the run time stack.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1759
1760<p><i>Inserting instructions</i></p>
1761
1762<p>There are essentially two ways to insert an <tt>Instruction</tt>
1763into an existing sequence of instructions that form a <tt>BasicBlock</tt>:</p>
1764
Joel Stanley9dd1ad62002-09-18 03:17:23 +0000[diff] [blame]1765<ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1766 <li>Insertion into an explicit instruction list
1767
1768 <p>Given a <tt>BasicBlock* pb</tt>, an <tt>Instruction* pi</tt> within that
1769 <tt>BasicBlock</tt>, and a newly-created instruction we wish to insert
1770 before <tt>*pi</tt>, we do the following: </p>
1771
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1772<div class="doc_code">
1773<pre>
1774BasicBlock *pb = ...;
1775Instruction *pi = ...;
1776Instruction *newInst = new Instruction(...);
1777
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1778pb-&gt;getInstList().insert(pi, newInst); // <i>Inserts newInst before pi in pb</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1779</pre>
1780</div>
Alkis Evlogimenos9a5dc4f2004-05-27 00:57:51 +0000[diff] [blame]1781
1782 <p>Appending to the end of a <tt>BasicBlock</tt> is so common that
1783 the <tt>Instruction</tt> class and <tt>Instruction</tt>-derived
1784 classes provide constructors which take a pointer to a
1785 <tt>BasicBlock</tt> to be appended to. For example code that
1786 looked like: </p>
1787
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1788<div class="doc_code">
1789<pre>
1790BasicBlock *pb = ...;
1791Instruction *newInst = new Instruction(...);
1792
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]1793pb-&gt;getInstList().push_back(newInst); // <i>Appends newInst to pb</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1794</pre>
1795</div>
Alkis Evlogimenos9a5dc4f2004-05-27 00:57:51 +0000[diff] [blame]1796
1797 <p>becomes: </p>
1798
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1799<div class="doc_code">
1800<pre>
1801BasicBlock *pb = ...;
1802Instruction *newInst = new Instruction(..., pb);
1803</pre>
1804</div>
Alkis Evlogimenos9a5dc4f2004-05-27 00:57:51 +0000[diff] [blame]1805
1806 <p>which is much cleaner, especially if you are creating
1807 long instruction streams.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1808
1809 <li>Insertion into an implicit instruction list
1810
1811 <p><tt>Instruction</tt> instances that are already in <tt>BasicBlock</tt>s
1812 are implicitly associated with an existing instruction list: the instruction
1813 list of the enclosing basic block. Thus, we could have accomplished the same
1814 thing as the above code without being given a <tt>BasicBlock</tt> by doing:
1815 </p>
1816
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1817<div class="doc_code">
1818<pre>
1819Instruction *pi = ...;
1820Instruction *newInst = new Instruction(...);
1821
1822pi-&gt;getParent()-&gt;getInstList().insert(pi, newInst);
1823</pre>
1824</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1825
1826 <p>In fact, this sequence of steps occurs so frequently that the
1827 <tt>Instruction</tt> class and <tt>Instruction</tt>-derived classes provide
1828 constructors which take (as a default parameter) a pointer to an
1829 <tt>Instruction</tt> which the newly-created <tt>Instruction</tt> should
1830 precede. That is, <tt>Instruction</tt> constructors are capable of
1831 inserting the newly-created instance into the <tt>BasicBlock</tt> of a
1832 provided instruction, immediately before that instruction. Using an
1833 <tt>Instruction</tt> constructor with a <tt>insertBefore</tt> (default)
1834 parameter, the above code becomes:</p>
1835
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1836<div class="doc_code">
1837<pre>
1838Instruction* pi = ...;
1839Instruction* newInst = new Instruction(..., pi);
1840</pre>
1841</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1842
1843 <p>which is much cleaner, especially if you're creating a lot of
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1844 instructions and adding them to <tt>BasicBlock</tt>s.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1845</ul>
1846
1847</div>
1848
1849<!--_______________________________________________________________________-->
1850<div class="doc_subsubsection">
1851 <a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a>
1852</div>
1853
1854<div class="doc_text">
1855
1856<p>Deleting an instruction from an existing sequence of instructions that form a
Chris Lattner69bf8a92004-05-23 21:06:58 +0000[diff] [blame]1857<a href="#BasicBlock"><tt>BasicBlock</tt></a> is very straight-forward. First,
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1858you must have a pointer to the instruction that you wish to delete. Second, you
1859need to obtain the pointer to that instruction's basic block. You use the
1860pointer to the basic block to get its list of instructions and then use the
1861erase function to remove your instruction. For example:</p>
1862
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1863<div class="doc_code">
1864<pre>
1865<a href="#Instruction">Instruction</a> *I = .. ;
1866<a href="#BasicBlock">BasicBlock</a> *BB = I-&gt;getParent();
1867
1868BB-&gt;getInstList().erase(I);
1869</pre>
1870</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1871
1872</div>
1873
1874<!--_______________________________________________________________________-->
1875<div class="doc_subsubsection">
1876 <a name="schanges_replacing">Replacing an <tt>Instruction</tt> with another
1877 <tt>Value</tt></a>
1878</div>
1879
1880<div class="doc_text">
1881
1882<p><i>Replacing individual instructions</i></p>
1883
1884<p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>"
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1885permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1886and <tt>ReplaceInstWithInst</tt>.</p>
1887
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1888<h4><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h4>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1889
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1890<ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1891 <li><tt>ReplaceInstWithValue</tt>
1892
1893 <p>This function replaces all uses (within a basic block) of a given
1894 instruction with a value, and then removes the original instruction. The
1895 following example illustrates the replacement of the result of a particular
Chris Lattner58360822005-01-17 00:12:04 +0000[diff] [blame]1896 <tt>AllocaInst</tt> that allocates memory for a single integer with a null
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1897 pointer to an integer.</p>
1898
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1899<div class="doc_code">
1900<pre>
1901AllocaInst* instToReplace = ...;
1902BasicBlock::iterator ii(instToReplace);
1903
1904ReplaceInstWithValue(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1905 Constant::getNullValue(PointerType::get(Type::IntTy)));
1906</pre></div></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1907
1908 <li><tt>ReplaceInstWithInst</tt>
1909
1910 <p>This function replaces a particular instruction with another
1911 instruction. The following example illustrates the replacement of one
1912 <tt>AllocaInst</tt> with another.</p>
1913
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]1914<div class="doc_code">
1915<pre>
1916AllocaInst* instToReplace = ...;
1917BasicBlock::iterator ii(instToReplace);
1918
1919ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
1920 new AllocaInst(Type::IntTy, 0, "ptrToReplacedInt"));
1921</pre></div></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]1922</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1923
1924<p><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></p>
1925
1926<p>You can use <tt>Value::replaceAllUsesWith</tt> and
1927<tt>User::replaceUsesOfWith</tt> to change more than one use at a time. See the
Chris Lattner00815172007-01-04 22:01:45 +0000[diff] [blame]1928doxygen documentation for the <a href="/doxygen/classllvm_1_1Value.html">Value Class</a>
Misha Brukman384047f2004-06-03 23:29:12 +0000[diff] [blame]1929and <a href="/doxygen/classllvm_1_1User.html">User Class</a>, respectively, for more
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1930information.</p>
1931
1932<!-- Value::replaceAllUsesWith User::replaceUsesOfWith Point out:
1933include/llvm/Transforms/Utils/ especially BasicBlockUtils.h with:
1934ReplaceInstWithValue, ReplaceInstWithInst -->
1935
1936</div>
1937
Tanya Lattnerb011c662007-06-20 18:33:15 +0000[diff] [blame]1938<!--_______________________________________________________________________-->
1939<div class="doc_subsubsection">
1940 <a name="schanges_deletingGV">Deleting <tt>GlobalVariable</tt>s</a>
1941</div>
1942
1943<div class="doc_text">
1944
Tanya Lattnerc5dfcdb2007-06-20 20:46:37 +0000[diff] [blame]1945<p>Deleting a global variable from a module is just as easy as deleting an
1946Instruction. First, you must have a pointer to the global variable that you wish
1947 to delete. You use this pointer to erase it from its parent, the module.
Tanya Lattnerb011c662007-06-20 18:33:15 +0000[diff] [blame]1948 For example:</p>
1949
1950<div class="doc_code">
1951<pre>
1952<a href="#GlobalVariable">GlobalVariable</a> *GV = .. ;
Tanya Lattnerb011c662007-06-20 18:33:15 +0000[diff] [blame]1953
Tanya Lattnerc5dfcdb2007-06-20 20:46:37 +0000[diff] [blame]1954GV-&gt;eraseFromParent();
Tanya Lattnerb011c662007-06-20 18:33:15 +0000[diff] [blame]1955</pre>
1956</div>
1957
1958</div>
1959
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]1960<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]1961<div class="doc_section">
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]1962 <a name="advanced">Advanced Topics</a>
1963</div>
1964<!-- *********************************************************************** -->
1965
1966<div class="doc_text">
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]1967<p>
1968This section describes some of the advanced or obscure API's that most clients
1969do not need to be aware of. These API's tend manage the inner workings of the
1970LLVM system, and only need to be accessed in unusual circumstances.
1971</p>
1972</div>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]1973
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]1974<!-- ======================================================================= -->
1975<div class="doc_subsection">
1976 <a name="TypeResolve">LLVM Type Resolution</a>
1977</div>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]1978
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]1979<div class="doc_text">
1980
1981<p>
1982The LLVM type system has a very simple goal: allow clients to compare types for
1983structural equality with a simple pointer comparison (aka a shallow compare).
1984This goal makes clients much simpler and faster, and is used throughout the LLVM
1985system.
1986</p>
1987
1988<p>
1989Unfortunately achieving this goal is not a simple matter. In particular,
1990recursive types and late resolution of opaque types makes the situation very
1991difficult to handle. Fortunately, for the most part, our implementation makes
1992most clients able to be completely unaware of the nasty internal details. The
1993primary case where clients are exposed to the inner workings of it are when
Gabor Greif04367bf2007-07-06 22:07:22 +0000[diff] [blame]1994building a recursive type. In addition to this case, the LLVM bitcode reader,
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]1995assembly parser, and linker also have to be aware of the inner workings of this
1996system.
1997</p>
1998
Chris Lattner0f876db2005-04-25 15:47:57 +0000[diff] [blame]1999<p>
2000For our purposes below, we need three concepts. First, an "Opaque Type" is
2001exactly as defined in the <a href="LangRef.html#t_opaque">language
2002reference</a>. Second an "Abstract Type" is any type which includes an
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2003opaque type as part of its type graph (for example "<tt>{ opaque, i32 }</tt>").
2004Third, a concrete type is a type that is not an abstract type (e.g. "<tt>{ i32,
Chris Lattner0f876db2005-04-25 15:47:57 +0000[diff] [blame]2005float }</tt>").
2006</p>
2007
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2008</div>
2009
2010<!-- ______________________________________________________________________ -->
2011<div class="doc_subsubsection">
2012 <a name="BuildRecType">Basic Recursive Type Construction</a>
2013</div>
2014
2015<div class="doc_text">
2016
2017<p>
2018Because the most common question is "how do I build a recursive type with LLVM",
2019we answer it now and explain it as we go. Here we include enough to cause this
2020to be emitted to an output .ll file:
2021</p>
2022
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2023<div class="doc_code">
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2024<pre>
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2025%mylist = type { %mylist*, i32 }
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2026</pre>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2027</div>
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2028
2029<p>
2030To build this, use the following LLVM APIs:
2031</p>
2032
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2033<div class="doc_code">
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2034<pre>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]2035// <i>Create the initial outer struct</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2036<a href="#PATypeHolder">PATypeHolder</a> StructTy = OpaqueType::get();
2037std::vector&lt;const Type*&gt; Elts;
2038Elts.push_back(PointerType::get(StructTy));
2039Elts.push_back(Type::IntTy);
2040StructType *NewSTy = StructType::get(Elts);
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2041
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2042// <i>At this point, NewSTy = "{ opaque*, i32 }". Tell VMCore that</i>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]2043// <i>the struct and the opaque type are actually the same.</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2044cast&lt;OpaqueType&gt;(StructTy.get())-&gt;<a href="#refineAbstractTypeTo">refineAbstractTypeTo</a>(NewSTy);
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2045
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2046// <i>NewSTy is potentially invalidated, but StructTy (a <a href="#PATypeHolder">PATypeHolder</a>) is</i>
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]2047// <i>kept up-to-date</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2048NewSTy = cast&lt;StructType&gt;(StructTy.get());
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2049
Bill Wendling82e2eea2006-10-11 18:00:22 +0000[diff] [blame]2050// <i>Add a name for the type to the module symbol table (optional)</i>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2051MyModule-&gt;addTypeName("mylist", NewSTy);
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2052</pre>
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2053</div>
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2054
2055<p>
2056This code shows the basic approach used to build recursive types: build a
2057non-recursive type using 'opaque', then use type unification to close the cycle.
2058The type unification step is performed by the <tt><a
Chris Lattneraff26d12007-02-03 03:06:52 +0000[diff] [blame]2059href="#refineAbstractTypeTo">refineAbstractTypeTo</a></tt> method, which is
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2060described next. After that, we describe the <a
2061href="#PATypeHolder">PATypeHolder class</a>.
2062</p>
2063
2064</div>
2065
2066<!-- ______________________________________________________________________ -->
2067<div class="doc_subsubsection">
2068 <a name="refineAbstractTypeTo">The <tt>refineAbstractTypeTo</tt> method</a>
2069</div>
2070
2071<div class="doc_text">
2072<p>
2073The <tt>refineAbstractTypeTo</tt> method starts the type unification process.
2074While this method is actually a member of the DerivedType class, it is most
2075often used on OpaqueType instances. Type unification is actually a recursive
2076process. After unification, types can become structurally isomorphic to
2077existing types, and all duplicates are deleted (to preserve pointer equality).
2078</p>
2079
2080<p>
2081In the example above, the OpaqueType object is definitely deleted.
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2082Additionally, if there is an "{ \2*, i32}" type already created in the system,
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2083the pointer and struct type created are <b>also</b> deleted. Obviously whenever
2084a type is deleted, any "Type*" pointers in the program are invalidated. As
2085such, it is safest to avoid having <i>any</i> "Type*" pointers to abstract types
2086live across a call to <tt>refineAbstractTypeTo</tt> (note that non-abstract
2087types can never move or be deleted). To deal with this, the <a
2088href="#PATypeHolder">PATypeHolder</a> class is used to maintain a stable
2089reference to a possibly refined type, and the <a
2090href="#AbstractTypeUser">AbstractTypeUser</a> class is used to update more
2091complex datastructures.
2092</p>
2093
2094</div>
2095
2096<!-- ______________________________________________________________________ -->
2097<div class="doc_subsubsection">
2098 <a name="PATypeHolder">The PATypeHolder Class</a>
2099</div>
2100
2101<div class="doc_text">
2102<p>
2103PATypeHolder is a form of a "smart pointer" for Type objects. When VMCore
2104happily goes about nuking types that become isomorphic to existing types, it
2105automatically updates all PATypeHolder objects to point to the new type. In the
2106example above, this allows the code to maintain a pointer to the resultant
2107resolved recursive type, even though the Type*'s are potentially invalidated.
2108</p>
2109
2110<p>
2111PATypeHolder is an extremely light-weight object that uses a lazy union-find
2112implementation to update pointers. For example the pointer from a Value to its
2113Type is maintained by PATypeHolder objects.
2114</p>
2115
2116</div>
2117
2118<!-- ______________________________________________________________________ -->
2119<div class="doc_subsubsection">
2120 <a name="AbstractTypeUser">The AbstractTypeUser Class</a>
2121</div>
2122
2123<div class="doc_text">
2124
2125<p>
2126Some data structures need more to perform more complex updates when types get
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]2127resolved. To support this, a class can derive from the AbstractTypeUser class.
2128This class
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2129allows it to get callbacks when certain types are resolved. To register to get
2130callbacks for a particular type, the DerivedType::{add/remove}AbstractTypeUser
Chris Lattner0f876db2005-04-25 15:47:57 +0000[diff] [blame]2131methods can be called on a type. Note that these methods only work for <i>
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2132 abstract</i> types. Concrete types (those that do not include any opaque
2133objects) can never be refined.
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2134</p>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2135</div>
2136
2137
2138<!-- ======================================================================= -->
2139<div class="doc_subsection">
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]2140 <a name="SymbolTable">The <tt>ValueSymbolTable</tt> and
2141 <tt>TypeSymbolTable</tt> classes</a>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2142</div>
Chris Lattnerf1b200b2005-04-23 17:27:36 +0000[diff] [blame]2143
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2144<div class="doc_text">
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]2145<p>The <tt><a href="http://llvm.org/doxygen/classllvm_1_1ValueSymbolTable.html">
2146ValueSymbolTable</a></tt> class provides a symbol table that the <a
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2147href="#Function"><tt>Function</tt></a> and <a href="#Module">
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]2148<tt>Module</tt></a> classes use for naming value definitions. The symbol table
2149can provide a name for any <a href="#Value"><tt>Value</tt></a>.
2150The <tt><a href="http://llvm.org/doxygen/classllvm_1_1TypeSymbolTable.html">
2151TypeSymbolTable</a></tt> class is used by the <tt>Module</tt> class to store
2152names for types.</p>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2153
Reid Spencera6362242007-01-07 00:41:39 +0000[diff] [blame]2154<p>Note that the <tt>SymbolTable</tt> class should not be directly accessed
2155by most clients. It should only be used when iteration over the symbol table
2156names themselves are required, which is very special purpose. Note that not
2157all LLVM
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2158<a href="#Value">Value</a>s have names, and those without names (i.e. they have
2159an empty name) do not exist in the symbol table.
2160</p>
2161
Chris Lattner263a98e2007-02-16 04:37:31 +0000[diff] [blame]2162<p>These symbol tables support iteration over the values/types in the symbol
2163table with <tt>begin/end/iterator</tt> and supports querying to see if a
2164specific name is in the symbol table (with <tt>lookup</tt>). The
2165<tt>ValueSymbolTable</tt> class exposes no public mutator methods, instead,
2166simply call <tt>setName</tt> on a value, which will autoinsert it into the
2167appropriate symbol table. For types, use the Module::addTypeName method to
2168insert entries into the symbol table.</p>
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2169
Chris Lattnerd9d6e102005-04-23 16:10:52 +0000[diff] [blame]2170</div>
2171
2172
2173
2174<!-- *********************************************************************** -->
2175<div class="doc_section">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2176 <a name="coreclasses">The Core LLVM Class Hierarchy Reference </a>
2177</div>
2178<!-- *********************************************************************** -->
2179
2180<div class="doc_text">
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2181<p><tt>#include "<a href="/doxygen/Type_8h-source.html">llvm/Type.h</a>"</tt>
2182<br>doxygen info: <a href="/doxygen/classllvm_1_1Type.html">Type Class</a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2183
2184<p>The Core LLVM classes are the primary means of representing the program
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2185being inspected or transformed. The core LLVM classes are defined in
2186header files in the <tt>include/llvm/</tt> directory, and implemented in
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2187the <tt>lib/VMCore</tt> directory.</p>
2188
2189</div>
2190
2191<!-- ======================================================================= -->
2192<div class="doc_subsection">
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2193 <a name="Type">The <tt>Type</tt> class and Derived Types</a>
2194</div>
2195
2196<div class="doc_text">
2197
2198 <p><tt>Type</tt> is a superclass of all type classes. Every <tt>Value</tt> has
2199 a <tt>Type</tt>. <tt>Type</tt> cannot be instantiated directly but only
2200 through its subclasses. Certain primitive types (<tt>VoidType</tt>,
2201 <tt>LabelType</tt>, <tt>FloatType</tt> and <tt>DoubleType</tt>) have hidden
2202 subclasses. They are hidden because they offer no useful functionality beyond
2203 what the <tt>Type</tt> class offers except to distinguish themselves from
2204 other subclasses of <tt>Type</tt>.</p>
2205 <p>All other types are subclasses of <tt>DerivedType</tt>. Types can be
2206 named, but this is not a requirement. There exists exactly
2207 one instance of a given shape at any one time. This allows type equality to
2208 be performed with address equality of the Type Instance. That is, given two
2209 <tt>Type*</tt> values, the types are identical if the pointers are identical.
2210 </p>
2211</div>
2212
2213<!-- _______________________________________________________________________ -->
2214<div class="doc_subsubsection">
2215 <a name="m_Value">Important Public Methods</a>
2216</div>
2217
2218<div class="doc_text">
2219
2220<ul>
Chris Lattner8f79df32007-01-15 01:55:32 +0000[diff] [blame]2221 <li><tt>bool isInteger() const</tt>: Returns true for any integer type.</li>
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2222
2223 <li><tt>bool isFloatingPoint()</tt>: Return true if this is one of the two
2224 floating point types.</li>
2225
2226 <li><tt>bool isAbstract()</tt>: Return true if the type is abstract (contains
2227 an OpaqueType anywhere in its definition).</li>
2228
2229 <li><tt>bool isSized()</tt>: Return true if the type has known size. Things
2230 that don't have a size are abstract types, labels and void.</li>
2231
2232</ul>
2233</div>
2234
2235<!-- _______________________________________________________________________ -->
2236<div class="doc_subsubsection">
2237 <a name="m_Value">Important Derived Types</a>
2238</div>
2239<div class="doc_text">
2240<dl>
2241 <dt><tt>IntegerType</tt></dt>
2242 <dd>Subclass of DerivedType that represents integer types of any bit width.
2243 Any bit width between <tt>IntegerType::MIN_INT_BITS</tt> (1) and
2244 <tt>IntegerType::MAX_INT_BITS</tt> (~8 million) can be represented.
2245 <ul>
2246 <li><tt>static const IntegerType* get(unsigned NumBits)</tt>: get an integer
2247 type of a specific bit width.</li>
2248 <li><tt>unsigned getBitWidth() const</tt>: Get the bit width of an integer
2249 type.</li>
2250 </ul>
2251 </dd>
2252 <dt><tt>SequentialType</tt></dt>
2253 <dd>This is subclassed by ArrayType and PointerType
2254 <ul>
2255 <li><tt>const Type * getElementType() const</tt>: Returns the type of each
2256 of the elements in the sequential type. </li>
2257 </ul>
2258 </dd>
2259 <dt><tt>ArrayType</tt></dt>
2260 <dd>This is a subclass of SequentialType and defines the interface for array
2261 types.
2262 <ul>
2263 <li><tt>unsigned getNumElements() const</tt>: Returns the number of
2264 elements in the array. </li>
2265 </ul>
2266 </dd>
2267 <dt><tt>PointerType</tt></dt>
Chris Lattner302da1e2007-02-03 03:05:57 +0000[diff] [blame]2268 <dd>Subclass of SequentialType for pointer types.</dd>
Reid Spencer9d6565a2007-02-15 02:26:10 +0000[diff] [blame]2269 <dt><tt>VectorType</tt></dt>
Reid Spencer485bad12007-02-15 03:07:05 +0000[diff] [blame]2270 <dd>Subclass of SequentialType for vector types. A
2271 vector type is similar to an ArrayType but is distinguished because it is
2272 a first class type wherease ArrayType is not. Vector types are used for
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2273 vector operations and are usually small vectors of of an integer or floating
2274 point type.</dd>
2275 <dt><tt>StructType</tt></dt>
2276 <dd>Subclass of DerivedTypes for struct types.</dd>
Duncan Sands8036ca42007-03-30 12:22:09 +0000[diff] [blame]2277 <dt><tt><a name="FunctionType">FunctionType</a></tt></dt>
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2278 <dd>Subclass of DerivedTypes for function types.
2279 <ul>
2280 <li><tt>bool isVarArg() const</tt>: Returns true if its a vararg
2281 function</li>
2282 <li><tt> const Type * getReturnType() const</tt>: Returns the
2283 return type of the function.</li>
2284 <li><tt>const Type * getParamType (unsigned i)</tt>: Returns
2285 the type of the ith parameter.</li>
2286 <li><tt> const unsigned getNumParams() const</tt>: Returns the
2287 number of formal parameters.</li>
2288 </ul>
2289 </dd>
2290 <dt><tt>OpaqueType</tt></dt>
2291 <dd>Sublcass of DerivedType for abstract types. This class
2292 defines no content and is used as a placeholder for some other type. Note
2293 that OpaqueType is used (temporarily) during type resolution for forward
2294 references of types. Once the referenced type is resolved, the OpaqueType
2295 is replaced with the actual type. OpaqueType can also be used for data
2296 abstraction. At link time opaque types can be resolved to actual types
2297 of the same name.</dd>
2298</dl>
2299</div>
2300
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2301
2302
2303<!-- ======================================================================= -->
2304<div class="doc_subsection">
2305 <a name="Module">The <tt>Module</tt> class</a>
2306</div>
2307
2308<div class="doc_text">
2309
2310<p><tt>#include "<a
2311href="/doxygen/Module_8h-source.html">llvm/Module.h</a>"</tt><br> doxygen info:
2312<a href="/doxygen/classllvm_1_1Module.html">Module Class</a></p>
2313
2314<p>The <tt>Module</tt> class represents the top level structure present in LLVM
2315programs. An LLVM module is effectively either a translation unit of the
2316original program or a combination of several translation units merged by the
2317linker. The <tt>Module</tt> class keeps track of a list of <a
2318href="#Function"><tt>Function</tt></a>s, a list of <a
2319href="#GlobalVariable"><tt>GlobalVariable</tt></a>s, and a <a
2320href="#SymbolTable"><tt>SymbolTable</tt></a>. Additionally, it contains a few
2321helpful member functions that try to make common operations easy.</p>
2322
2323</div>
2324
2325<!-- _______________________________________________________________________ -->
2326<div class="doc_subsubsection">
2327 <a name="m_Module">Important Public Members of the <tt>Module</tt> class</a>
2328</div>
2329
2330<div class="doc_text">
2331
2332<ul>
2333 <li><tt>Module::Module(std::string name = "")</tt></li>
2334</ul>
2335
2336<p>Constructing a <a href="#Module">Module</a> is easy. You can optionally
2337provide a name for it (probably based on the name of the translation unit).</p>
2338
2339<ul>
2340 <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
2341 <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>
2342
2343 <tt>begin()</tt>, <tt>end()</tt>
2344 <tt>size()</tt>, <tt>empty()</tt>
2345
2346 <p>These are forwarding methods that make it easy to access the contents of
2347 a <tt>Module</tt> object's <a href="#Function"><tt>Function</tt></a>
2348 list.</p></li>
2349
2350 <li><tt>Module::FunctionListType &amp;getFunctionList()</tt>
2351
2352 <p> Returns the list of <a href="#Function"><tt>Function</tt></a>s. This is
2353 necessary to use when you need to update the list or perform a complex
2354 action that doesn't have a forwarding method.</p>
2355
2356 <p><!-- Global Variable --></p></li>
2357</ul>
2358
2359<hr>
2360
2361<ul>
2362 <li><tt>Module::global_iterator</tt> - Typedef for global variable list iterator<br>
2363
2364 <tt>Module::const_global_iterator</tt> - Typedef for const_iterator.<br>
2365
2366 <tt>global_begin()</tt>, <tt>global_end()</tt>
2367 <tt>global_size()</tt>, <tt>global_empty()</tt>
2368
2369 <p> These are forwarding methods that make it easy to access the contents of
2370 a <tt>Module</tt> object's <a
2371 href="#GlobalVariable"><tt>GlobalVariable</tt></a> list.</p></li>
2372
2373 <li><tt>Module::GlobalListType &amp;getGlobalList()</tt>
2374
2375 <p>Returns the list of <a
2376 href="#GlobalVariable"><tt>GlobalVariable</tt></a>s. This is necessary to
2377 use when you need to update the list or perform a complex action that
2378 doesn't have a forwarding method.</p>
2379
2380 <p><!-- Symbol table stuff --> </p></li>
2381</ul>
2382
2383<hr>
2384
2385<ul>
2386 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
2387
2388 <p>Return a reference to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2389 for this <tt>Module</tt>.</p>
2390
2391 <p><!-- Convenience methods --></p></li>
2392</ul>
2393
2394<hr>
2395
2396<ul>
2397 <li><tt><a href="#Function">Function</a> *getFunction(const std::string
2398 &amp;Name, const <a href="#FunctionType">FunctionType</a> *Ty)</tt>
2399
2400 <p>Look up the specified function in the <tt>Module</tt> <a
2401 href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, return
2402 <tt>null</tt>.</p></li>
2403
2404 <li><tt><a href="#Function">Function</a> *getOrInsertFunction(const
2405 std::string &amp;Name, const <a href="#FunctionType">FunctionType</a> *T)</tt>
2406
2407 <p>Look up the specified function in the <tt>Module</tt> <a
2408 href="#SymbolTable"><tt>SymbolTable</tt></a>. If it does not exist, add an
2409 external declaration for the function and return it.</p></li>
2410
2411 <li><tt>std::string getTypeName(const <a href="#Type">Type</a> *Ty)</tt>
2412
2413 <p>If there is at least one entry in the <a
2414 href="#SymbolTable"><tt>SymbolTable</tt></a> for the specified <a
2415 href="#Type"><tt>Type</tt></a>, return it. Otherwise return the empty
2416 string.</p></li>
2417
2418 <li><tt>bool addTypeName(const std::string &amp;Name, const <a
2419 href="#Type">Type</a> *Ty)</tt>
2420
2421 <p>Insert an entry in the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
2422 mapping <tt>Name</tt> to <tt>Ty</tt>. If there is already an entry for this
2423 name, true is returned and the <a
2424 href="#SymbolTable"><tt>SymbolTable</tt></a> is not modified.</p></li>
2425</ul>
2426
2427</div>
2428
2429
Reid Spencer303c4b42007-01-12 17:26:25 +0000[diff] [blame]2430<!-- ======================================================================= -->
2431<div class="doc_subsection">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2432 <a name="Value">The <tt>Value</tt> class</a>
2433</div>
2434
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2435<div class="doc_text">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2436
2437<p><tt>#include "<a href="/doxygen/Value_8h-source.html">llvm/Value.h</a>"</tt>
2438<br>
Chris Lattner00815172007-01-04 22:01:45 +0000[diff] [blame]2439doxygen info: <a href="/doxygen/classllvm_1_1Value.html">Value Class</a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2440
2441<p>The <tt>Value</tt> class is the most important class in the LLVM Source
2442base. It represents a typed value that may be used (among other things) as an
2443operand to an instruction. There are many different types of <tt>Value</tt>s,
2444such as <a href="#Constant"><tt>Constant</tt></a>s,<a
2445href="#Argument"><tt>Argument</tt></a>s. Even <a
2446href="#Instruction"><tt>Instruction</tt></a>s and <a
2447href="#Function"><tt>Function</tt></a>s are <tt>Value</tt>s.</p>
2448
2449<p>A particular <tt>Value</tt> may be used many times in the LLVM representation
2450for a program. For example, an incoming argument to a function (represented
2451with an instance of the <a href="#Argument">Argument</a> class) is "used" by
2452every instruction in the function that references the argument. To keep track
2453of this relationship, the <tt>Value</tt> class keeps a list of all of the <a
2454href="#User"><tt>User</tt></a>s that is using it (the <a
2455href="#User"><tt>User</tt></a> class is a base class for all nodes in the LLVM
2456graph that can refer to <tt>Value</tt>s). This use list is how LLVM represents
2457def-use information in the program, and is accessible through the <tt>use_</tt>*
2458methods, shown below.</p>
2459
2460<p>Because LLVM is a typed representation, every LLVM <tt>Value</tt> is typed,
2461and this <a href="#Type">Type</a> is available through the <tt>getType()</tt>
2462method. In addition, all LLVM values can be named. The "name" of the
2463<tt>Value</tt> is a symbolic string printed in the LLVM code:</p>
2464
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2465<div class="doc_code">
2466<pre>
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2467%<b>foo</b> = add i32 1, 2
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2468</pre>
2469</div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2470
Duncan Sands8036ca42007-03-30 12:22:09 +0000[diff] [blame]2471<p><a name="nameWarning">The name of this instruction is "foo".</a> <b>NOTE</b>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2472that the name of any value may be missing (an empty string), so names should
2473<b>ONLY</b> be used for debugging (making the source code easier to read,
2474debugging printouts), they should not be used to keep track of values or map
2475between them. For this purpose, use a <tt>std::map</tt> of pointers to the
2476<tt>Value</tt> itself instead.</p>
2477
2478<p>One important aspect of LLVM is that there is no distinction between an SSA
2479variable and the operation that produces it. Because of this, any reference to
2480the value produced by an instruction (or the value available as an incoming
Chris Lattnerd5fc4fc2004-03-18 14:58:55 +0000[diff] [blame]2481argument, for example) is represented as a direct pointer to the instance of
2482the class that
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2483represents this value. Although this may take some getting used to, it
2484simplifies the representation and makes it easier to manipulate.</p>
2485
2486</div>
2487
2488<!-- _______________________________________________________________________ -->
2489<div class="doc_subsubsection">
2490 <a name="m_Value">Important Public Members of the <tt>Value</tt> class</a>
2491</div>
2492
2493<div class="doc_text">
2494
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2495<ul>
2496 <li><tt>Value::use_iterator</tt> - Typedef for iterator over the
2497use-list<br>
2498 <tt>Value::use_const_iterator</tt> - Typedef for const_iterator over
2499the use-list<br>
2500 <tt>unsigned use_size()</tt> - Returns the number of users of the
2501value.<br>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]2502 <tt>bool use_empty()</tt> - Returns true if there are no users.<br>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2503 <tt>use_iterator use_begin()</tt> - Get an iterator to the start of
2504the use-list.<br>
2505 <tt>use_iterator use_end()</tt> - Get an iterator to the end of the
2506use-list.<br>
2507 <tt><a href="#User">User</a> *use_back()</tt> - Returns the last
2508element in the list.
2509 <p> These methods are the interface to access the def-use
2510information in LLVM. As with all other iterators in LLVM, the naming
2511conventions follow the conventions defined by the <a href="#stl">STL</a>.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2512 </li>
2513 <li><tt><a href="#Type">Type</a> *getType() const</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2514 <p>This method returns the Type of the Value.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2515 </li>
2516 <li><tt>bool hasName() const</tt><br>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]2517 <tt>std::string getName() const</tt><br>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2518 <tt>void setName(const std::string &amp;Name)</tt>
2519 <p> This family of methods is used to access and assign a name to a <tt>Value</tt>,
2520be aware of the <a href="#nameWarning">precaution above</a>.</p>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2521 </li>
2522 <li><tt>void replaceAllUsesWith(Value *V)</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2523
2524 <p>This method traverses the use list of a <tt>Value</tt> changing all <a
2525 href="#User"><tt>User</tt>s</a> of the current value to refer to
2526 "<tt>V</tt>" instead. For example, if you detect that an instruction always
2527 produces a constant value (for example through constant folding), you can
2528 replace all uses of the instruction with the constant like this:</p>
2529
Bill Wendling3cd5ca62006-10-11 06:30:10 +0000[diff] [blame]2530<div class="doc_code">
2531<pre>
2532Inst-&gt;replaceAllUsesWith(ConstVal);
2533</pre>
2534</div>
2535
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2536</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2537
2538</div>
2539
2540<!-- ======================================================================= -->
2541<div class="doc_subsection">
2542 <a name="User">The <tt>User</tt> class</a>
2543</div>
2544
2545<div class="doc_text">
2546
2547<p>
2548<tt>#include "<a href="/doxygen/User_8h-source.html">llvm/User.h</a>"</tt><br>
Misha Brukman384047f2004-06-03 23:29:12 +0000[diff] [blame]2549doxygen info: <a href="/doxygen/classllvm_1_1User.html">User Class</a><br>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2550Superclass: <a href="#Value"><tt>Value</tt></a></p>
2551
2552<p>The <tt>User</tt> class is the common base class of all LLVM nodes that may
2553refer to <a href="#Value"><tt>Value</tt></a>s. It exposes a list of "Operands"
2554that are all of the <a href="#Value"><tt>Value</tt></a>s that the User is
2555referring to. The <tt>User</tt> class itself is a subclass of
2556<tt>Value</tt>.</p>
2557
2558<p>The operands of a <tt>User</tt> point directly to the LLVM <a
2559href="#Value"><tt>Value</tt></a> that it refers to. Because LLVM uses Static
2560Single Assignment (SSA) form, there can only be one definition referred to,
2561allowing this direct connection. This connection provides the use-def
2562information in LLVM.</p>
2563
2564</div>
2565
2566<!-- _______________________________________________________________________ -->
2567<div class="doc_subsubsection">
2568 <a name="m_User">Important Public Members of the <tt>User</tt> class</a>
2569</div>
2570
2571<div class="doc_text">
2572
2573<p>The <tt>User</tt> class exposes the operand list in two ways: through
2574an index access interface and through an iterator based interface.</p>
2575
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2576<ul>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2577 <li><tt>Value *getOperand(unsigned i)</tt><br>
2578 <tt>unsigned getNumOperands()</tt>
2579 <p> These two methods expose the operands of the <tt>User</tt> in a
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2580convenient form for direct access.</p></li>
2581
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2582 <li><tt>User::op_iterator</tt> - Typedef for iterator over the operand
2583list<br>
Chris Lattner58360822005-01-17 00:12:04 +0000[diff] [blame]2584 <tt>op_iterator op_begin()</tt> - Get an iterator to the start of
2585the operand list.<br>
2586 <tt>op_iterator op_end()</tt> - Get an iterator to the end of the
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2587operand list.
2588 <p> Together, these methods make up the iterator based interface to
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2589the operands of a <tt>User</tt>.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2590</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2591
2592</div>
2593
2594<!-- ======================================================================= -->
2595<div class="doc_subsection">
2596 <a name="Instruction">The <tt>Instruction</tt> class</a>
2597</div>
2598
2599<div class="doc_text">
2600
2601<p><tt>#include "</tt><tt><a
2602href="/doxygen/Instruction_8h-source.html">llvm/Instruction.h</a>"</tt><br>
Misha Brukman31ca1de2004-06-03 23:35:54 +0000[diff] [blame]2603doxygen info: <a href="/doxygen/classllvm_1_1Instruction.html">Instruction Class</a><br>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2604Superclasses: <a href="#User"><tt>User</tt></a>, <a
2605href="#Value"><tt>Value</tt></a></p>
2606
2607<p>The <tt>Instruction</tt> class is the common base class for all LLVM
2608instructions. It provides only a few methods, but is a very commonly used
2609class. The primary data tracked by the <tt>Instruction</tt> class itself is the
2610opcode (instruction type) and the parent <a
2611href="#BasicBlock"><tt>BasicBlock</tt></a> the <tt>Instruction</tt> is embedded
2612into. To represent a specific type of instruction, one of many subclasses of
2613<tt>Instruction</tt> are used.</p>
2614
2615<p> Because the <tt>Instruction</tt> class subclasses the <a
2616href="#User"><tt>User</tt></a> class, its operands can be accessed in the same
2617way as for other <a href="#User"><tt>User</tt></a>s (with the
2618<tt>getOperand()</tt>/<tt>getNumOperands()</tt> and
2619<tt>op_begin()</tt>/<tt>op_end()</tt> methods).</p> <p> An important file for
2620the <tt>Instruction</tt> class is the <tt>llvm/Instruction.def</tt> file. This
2621file contains some meta-data about the various different types of instructions
2622in LLVM. It describes the enum values that are used as opcodes (for example
Reid Spencerc92d25d2006-12-19 19:47:19 +0000[diff] [blame]2623<tt>Instruction::Add</tt> and <tt>Instruction::ICmp</tt>), as well as the
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2624concrete sub-classes of <tt>Instruction</tt> that implement the instruction (for
2625example <tt><a href="#BinaryOperator">BinaryOperator</a></tt> and <tt><a
Reid Spencerc92d25d2006-12-19 19:47:19 +0000[diff] [blame]2626href="#CmpInst">CmpInst</a></tt>). Unfortunately, the use of macros in
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2627this file confuses doxygen, so these enum values don't show up correctly in the
Misha Brukman31ca1de2004-06-03 23:35:54 +0000[diff] [blame]2628<a href="/doxygen/classllvm_1_1Instruction.html">doxygen output</a>.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2629
2630</div>
2631
2632<!-- _______________________________________________________________________ -->
2633<div class="doc_subsubsection">
Reid Spencerc92d25d2006-12-19 19:47:19 +0000[diff] [blame]2634 <a name="s_Instruction">Important Subclasses of the <tt>Instruction</tt>
2635 class</a>
2636</div>
2637<div class="doc_text">
2638 <ul>
2639 <li><tt><a name="BinaryOperator">BinaryOperator</a></tt>
2640 <p>This subclasses represents all two operand instructions whose operands
2641 must be the same type, except for the comparison instructions.</p></li>
2642 <li><tt><a name="CastInst">CastInst</a></tt>
2643 <p>This subclass is the parent of the 12 casting instructions. It provides
2644 common operations on cast instructions.</p>
2645 <li><tt><a name="CmpInst">CmpInst</a></tt>
2646 <p>This subclass respresents the two comparison instructions,
2647 <a href="LangRef.html#i_icmp">ICmpInst</a> (integer opreands), and
2648 <a href="LangRef.html#i_fcmp">FCmpInst</a> (floating point operands).</p>
2649 <li><tt><a name="TerminatorInst">TerminatorInst</a></tt>
2650 <p>This subclass is the parent of all terminator instructions (those which
2651 can terminate a block).</p>
2652 </ul>
2653 </div>
2654
2655<!-- _______________________________________________________________________ -->
2656<div class="doc_subsubsection">
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2657 <a name="m_Instruction">Important Public Members of the <tt>Instruction</tt>
2658 class</a>
2659</div>
2660
2661<div class="doc_text">
2662
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2663<ul>
2664 <li><tt><a href="#BasicBlock">BasicBlock</a> *getParent()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2665 <p>Returns the <a href="#BasicBlock"><tt>BasicBlock</tt></a> that
2666this <tt>Instruction</tt> is embedded into.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2667 <li><tt>bool mayWriteToMemory()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2668 <p>Returns true if the instruction writes to memory, i.e. it is a
2669 <tt>call</tt>,<tt>free</tt>,<tt>invoke</tt>, or <tt>store</tt>.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2670 <li><tt>unsigned getOpcode()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2671 <p>Returns the opcode for the <tt>Instruction</tt>.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2672 <li><tt><a href="#Instruction">Instruction</a> *clone() const</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2673 <p>Returns another instance of the specified instruction, identical
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2674in all ways to the original except that the instruction has no parent
2675(ie it's not embedded into a <a href="#BasicBlock"><tt>BasicBlock</tt></a>),
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2676and it has no name</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2677</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2678
2679</div>
2680
2681<!-- ======================================================================= -->
2682<div class="doc_subsection">
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2683 <a name="Constant">The <tt>Constant</tt> class and subclasses</a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2684</div>
2685
2686<div class="doc_text">
2687
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2688<p>Constant represents a base class for different types of constants. It
2689is subclassed by ConstantInt, ConstantArray, etc. for representing
2690the various types of Constants. <a href="#GlobalValue">GlobalValue</a> is also
2691a subclass, which represents the address of a global variable or function.
2692</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2693
2694</div>
2695
2696<!-- _______________________________________________________________________ -->
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2697<div class="doc_subsubsection">Important Subclasses of Constant </div>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2698<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2699<ul>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2700 <li>ConstantInt : This subclass of Constant represents an integer constant of
2701 any width.
2702 <ul>
Reid Spencer97b4ee32007-03-01 21:05:33 +0000[diff] [blame]2703 <li><tt>const APInt&amp; getValue() const</tt>: Returns the underlying
2704 value of this constant, an APInt value.</li>
2705 <li><tt>int64_t getSExtValue() const</tt>: Converts the underlying APInt
2706 value to an int64_t via sign extension. If the value (not the bit width)
2707 of the APInt is too large to fit in an int64_t, an assertion will result.
2708 For this reason, use of this method is discouraged.</li>
2709 <li><tt>uint64_t getZExtValue() const</tt>: Converts the underlying APInt
2710 value to a uint64_t via zero extension. IF the value (not the bit width)
2711 of the APInt is too large to fit in a uint64_t, an assertion will result.
Reid Spencer4474d872007-03-02 01:31:31 +0000[diff] [blame]2712 For this reason, use of this method is discouraged.</li>
Reid Spencer97b4ee32007-03-01 21:05:33 +0000[diff] [blame]2713 <li><tt>static ConstantInt* get(const APInt&amp; Val)</tt>: Returns the
2714 ConstantInt object that represents the value provided by <tt>Val</tt>.
2715 The type is implied as the IntegerType that corresponds to the bit width
2716 of <tt>Val</tt>.</li>
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2717 <li><tt>static ConstantInt* get(const Type *Ty, uint64_t Val)</tt>:
2718 Returns the ConstantInt object that represents the value provided by
2719 <tt>Val</tt> for integer type <tt>Ty</tt>.</li>
2720 </ul>
2721 </li>
2722 <li>ConstantFP : This class represents a floating point constant.
2723 <ul>
2724 <li><tt>double getValue() const</tt>: Returns the underlying value of
2725 this constant. </li>
2726 </ul>
2727 </li>
2728 <li>ConstantArray : This represents a constant array.
2729 <ul>
2730 <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2731 a vector of component constants that makeup this array. </li>
2732 </ul>
2733 </li>
2734 <li>ConstantStruct : This represents a constant struct.
2735 <ul>
2736 <li><tt>const std::vector&lt;Use&gt; &amp;getValues() const</tt>: Returns
2737 a vector of component constants that makeup this array. </li>
2738 </ul>
2739 </li>
2740 <li>GlobalValue : This represents either a global variable or a function. In
2741 either case, the value is a constant fixed address (after linking).
2742 </li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2743</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2744</div>
2745
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]2746
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2747<!-- ======================================================================= -->
2748<div class="doc_subsection">
2749 <a name="GlobalValue">The <tt>GlobalValue</tt> class</a>
2750</div>
2751
2752<div class="doc_text">
2753
2754<p><tt>#include "<a
2755href="/doxygen/GlobalValue_8h-source.html">llvm/GlobalValue.h</a>"</tt><br>
Misha Brukman384047f2004-06-03 23:29:12 +0000[diff] [blame]2756doxygen info: <a href="/doxygen/classllvm_1_1GlobalValue.html">GlobalValue
2757Class</a><br>
Reid Spencerbe5e85e2006-04-14 14:11:48 +0000[diff] [blame]2758Superclasses: <a href="#Constant"><tt>Constant</tt></a>,
2759<a href="#User"><tt>User</tt></a>, <a href="#Value"><tt>Value</tt></a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2760
2761<p>Global values (<a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s or <a
2762href="#Function"><tt>Function</tt></a>s) are the only LLVM values that are
2763visible in the bodies of all <a href="#Function"><tt>Function</tt></a>s.
2764Because they are visible at global scope, they are also subject to linking with
2765other globals defined in different translation units. To control the linking
2766process, <tt>GlobalValue</tt>s know their linkage rules. Specifically,
2767<tt>GlobalValue</tt>s know whether they have internal or external linkage, as
Reid Spencer8b2da7a2004-07-18 13:10:31 +0000[diff] [blame]2768defined by the <tt>LinkageTypes</tt> enumeration.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2769
2770<p>If a <tt>GlobalValue</tt> has internal linkage (equivalent to being
2771<tt>static</tt> in C), it is not visible to code outside the current translation
2772unit, and does not participate in linking. If it has external linkage, it is
2773visible to external code, and does participate in linking. In addition to
2774linkage information, <tt>GlobalValue</tt>s keep track of which <a
2775href="#Module"><tt>Module</tt></a> they are currently part of.</p>
2776
2777<p>Because <tt>GlobalValue</tt>s are memory objects, they are always referred to
2778by their <b>address</b>. As such, the <a href="#Type"><tt>Type</tt></a> of a
2779global is always a pointer to its contents. It is important to remember this
2780when using the <tt>GetElementPtrInst</tt> instruction because this pointer must
2781be dereferenced first. For example, if you have a <tt>GlobalVariable</tt> (a
2782subclass of <tt>GlobalValue)</tt> that is an array of 24 ints, type <tt>[24 x
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2783i32]</tt>, then the <tt>GlobalVariable</tt> is a pointer to that array. Although
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2784the address of the first element of this array and the value of the
2785<tt>GlobalVariable</tt> are the same, they have different types. The
Reid Spencer06565dc2007-01-12 17:11:23 +0000[diff] [blame]2786<tt>GlobalVariable</tt>'s type is <tt>[24 x i32]</tt>. The first element's type
2787is <tt>i32.</tt> Because of this, accessing a global value requires you to
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2788dereference the pointer with <tt>GetElementPtrInst</tt> first, then its elements
2789can be accessed. This is explained in the <a href="LangRef.html#globalvars">LLVM
2790Language Reference Manual</a>.</p>
2791
2792</div>
2793
2794<!-- _______________________________________________________________________ -->
2795<div class="doc_subsubsection">
2796 <a name="m_GlobalValue">Important Public Members of the <tt>GlobalValue</tt>
2797 class</a>
2798</div>
2799
2800<div class="doc_text">
2801
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2802<ul>
2803 <li><tt>bool hasInternalLinkage() const</tt><br>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]2804 <tt>bool hasExternalLinkage() const</tt><br>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2805 <tt>void setInternalLinkage(bool HasInternalLinkage)</tt>
2806 <p> These methods manipulate the linkage characteristics of the <tt>GlobalValue</tt>.</p>
2807 <p> </p>
2808 </li>
2809 <li><tt><a href="#Module">Module</a> *getParent()</tt>
2810 <p> This returns the <a href="#Module"><tt>Module</tt></a> that the
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2811GlobalValue is currently embedded into.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2812</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2813
2814</div>
2815
2816<!-- ======================================================================= -->
2817<div class="doc_subsection">
2818 <a name="Function">The <tt>Function</tt> class</a>
2819</div>
2820
2821<div class="doc_text">
2822
2823<p><tt>#include "<a
2824href="/doxygen/Function_8h-source.html">llvm/Function.h</a>"</tt><br> doxygen
Misha Brukman31ca1de2004-06-03 23:35:54 +0000[diff] [blame]2825info: <a href="/doxygen/classllvm_1_1Function.html">Function Class</a><br>
Reid Spencerbe5e85e2006-04-14 14:11:48 +0000[diff] [blame]2826Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
2827<a href="#Constant"><tt>Constant</tt></a>,
2828<a href="#User"><tt>User</tt></a>,
2829<a href="#Value"><tt>Value</tt></a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2830
2831<p>The <tt>Function</tt> class represents a single procedure in LLVM. It is
2832actually one of the more complex classes in the LLVM heirarchy because it must
2833keep track of a large amount of data. The <tt>Function</tt> class keeps track
Reid Spencerbe5e85e2006-04-14 14:11:48 +0000[diff] [blame]2834of a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, a list of formal
2835<a href="#Argument"><tt>Argument</tt></a>s, and a
2836<a href="#SymbolTable"><tt>SymbolTable</tt></a>.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2837
2838<p>The list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s is the most
2839commonly used part of <tt>Function</tt> objects. The list imposes an implicit
2840ordering of the blocks in the function, which indicate how the code will be
2841layed out by the backend. Additionally, the first <a
2842href="#BasicBlock"><tt>BasicBlock</tt></a> is the implicit entry node for the
2843<tt>Function</tt>. It is not legal in LLVM to explicitly branch to this initial
2844block. There are no implicit exit nodes, and in fact there may be multiple exit
2845nodes from a single <tt>Function</tt>. If the <a
2846href="#BasicBlock"><tt>BasicBlock</tt></a> list is empty, this indicates that
2847the <tt>Function</tt> is actually a function declaration: the actual body of the
2848function hasn't been linked in yet.</p>
2849
2850<p>In addition to a list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s, the
2851<tt>Function</tt> class also keeps track of the list of formal <a
2852href="#Argument"><tt>Argument</tt></a>s that the function receives. This
2853container manages the lifetime of the <a href="#Argument"><tt>Argument</tt></a>
2854nodes, just like the <a href="#BasicBlock"><tt>BasicBlock</tt></a> list does for
2855the <a href="#BasicBlock"><tt>BasicBlock</tt></a>s.</p>
2856
2857<p>The <a href="#SymbolTable"><tt>SymbolTable</tt></a> is a very rarely used
2858LLVM feature that is only used when you have to look up a value by name. Aside
2859from that, the <a href="#SymbolTable"><tt>SymbolTable</tt></a> is used
2860internally to make sure that there are not conflicts between the names of <a
2861href="#Instruction"><tt>Instruction</tt></a>s, <a
2862href="#BasicBlock"><tt>BasicBlock</tt></a>s, or <a
2863href="#Argument"><tt>Argument</tt></a>s in the function body.</p>
2864
Reid Spencer8b2da7a2004-07-18 13:10:31 +0000[diff] [blame]2865<p>Note that <tt>Function</tt> is a <a href="#GlobalValue">GlobalValue</a>
2866and therefore also a <a href="#Constant">Constant</a>. The value of the function
2867is its address (after linking) which is guaranteed to be constant.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2868</div>
2869
2870<!-- _______________________________________________________________________ -->
2871<div class="doc_subsubsection">
2872 <a name="m_Function">Important Public Members of the <tt>Function</tt>
2873 class</a>
2874</div>
2875
2876<div class="doc_text">
2877
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2878<ul>
2879 <li><tt>Function(const </tt><tt><a href="#FunctionType">FunctionType</a>
Chris Lattnerac479e52004-08-04 05:10:48 +0000[diff] [blame]2880 *Ty, LinkageTypes Linkage, const std::string &amp;N = "", Module* Parent = 0)</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2881
2882 <p>Constructor used when you need to create new <tt>Function</tt>s to add
2883 the the program. The constructor must specify the type of the function to
Chris Lattnerac479e52004-08-04 05:10:48 +0000[diff] [blame]2884 create and what type of linkage the function should have. The <a
2885 href="#FunctionType"><tt>FunctionType</tt></a> argument
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2886 specifies the formal arguments and return value for the function. The same
Duncan Sands8036ca42007-03-30 12:22:09 +0000[diff] [blame]2887 <a href="#FunctionType"><tt>FunctionType</tt></a> value can be used to
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2888 create multiple functions. The <tt>Parent</tt> argument specifies the Module
2889 in which the function is defined. If this argument is provided, the function
2890 will automatically be inserted into that module's list of
2891 functions.</p></li>
2892
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2893 <li><tt>bool isExternal()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2894
2895 <p>Return whether or not the <tt>Function</tt> has a body defined. If the
2896 function is "external", it does not have a body, and thus must be resolved
2897 by linking with a function defined in a different translation unit.</p></li>
2898
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2899 <li><tt>Function::iterator</tt> - Typedef for basic block list iterator<br>
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]2900 <tt>Function::const_iterator</tt> - Typedef for const_iterator.<br>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2901
Chris Lattner77d69242005-03-15 05:19:20 +0000[diff] [blame]2902 <tt>begin()</tt>, <tt>end()</tt>
2903 <tt>size()</tt>, <tt>empty()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2904
2905 <p>These are forwarding methods that make it easy to access the contents of
2906 a <tt>Function</tt> object's <a href="#BasicBlock"><tt>BasicBlock</tt></a>
2907 list.</p></li>
2908
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2909 <li><tt>Function::BasicBlockListType &amp;getBasicBlockList()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2910
2911 <p>Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s. This
2912 is necessary to use when you need to update the list or perform a complex
2913 action that doesn't have a forwarding method.</p></li>
2914
Chris Lattner89cc2652005-03-15 04:48:32 +0000[diff] [blame]2915 <li><tt>Function::arg_iterator</tt> - Typedef for the argument list
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2916iterator<br>
Chris Lattner89cc2652005-03-15 04:48:32 +0000[diff] [blame]2917 <tt>Function::const_arg_iterator</tt> - Typedef for const_iterator.<br>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2918
Chris Lattner77d69242005-03-15 05:19:20 +0000[diff] [blame]2919 <tt>arg_begin()</tt>, <tt>arg_end()</tt>
Chris Lattner89cc2652005-03-15 04:48:32 +0000[diff] [blame]2920 <tt>arg_size()</tt>, <tt>arg_empty()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2921
2922 <p>These are forwarding methods that make it easy to access the contents of
2923 a <tt>Function</tt> object's <a href="#Argument"><tt>Argument</tt></a>
2924 list.</p></li>
2925
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2926 <li><tt>Function::ArgumentListType &amp;getArgumentList()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2927
2928 <p>Returns the list of <a href="#Argument"><tt>Argument</tt></a>s. This is
2929 necessary to use when you need to update the list or perform a complex
2930 action that doesn't have a forwarding method.</p></li>
2931
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2932 <li><tt><a href="#BasicBlock">BasicBlock</a> &amp;getEntryBlock()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2933
2934 <p>Returns the entry <a href="#BasicBlock"><tt>BasicBlock</tt></a> for the
2935 function. Because the entry block for the function is always the first
2936 block, this returns the first block of the <tt>Function</tt>.</p></li>
2937
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2938 <li><tt><a href="#Type">Type</a> *getReturnType()</tt><br>
2939 <tt><a href="#FunctionType">FunctionType</a> *getFunctionType()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2940
2941 <p>This traverses the <a href="#Type"><tt>Type</tt></a> of the
2942 <tt>Function</tt> and returns the return type of the function, or the <a
2943 href="#FunctionType"><tt>FunctionType</tt></a> of the actual
2944 function.</p></li>
2945
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2946 <li><tt><a href="#SymbolTable">SymbolTable</a> *getSymbolTable()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2947
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2948 <p> Return a pointer to the <a href="#SymbolTable"><tt>SymbolTable</tt></a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2949 for this <tt>Function</tt>.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2950</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2951
2952</div>
2953
2954<!-- ======================================================================= -->
2955<div class="doc_subsection">
2956 <a name="GlobalVariable">The <tt>GlobalVariable</tt> class</a>
2957</div>
2958
2959<div class="doc_text">
2960
2961<p><tt>#include "<a
2962href="/doxygen/GlobalVariable_8h-source.html">llvm/GlobalVariable.h</a>"</tt>
2963<br>
Tanya Lattnera3da7772004-06-22 08:02:25 +0000[diff] [blame]2964doxygen info: <a href="/doxygen/classllvm_1_1GlobalVariable.html">GlobalVariable
Reid Spencerbe5e85e2006-04-14 14:11:48 +0000[diff] [blame]2965 Class</a><br>
2966Superclasses: <a href="#GlobalValue"><tt>GlobalValue</tt></a>,
2967<a href="#Constant"><tt>Constant</tt></a>,
2968<a href="#User"><tt>User</tt></a>,
2969<a href="#Value"><tt>Value</tt></a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2970
2971<p>Global variables are represented with the (suprise suprise)
2972<tt>GlobalVariable</tt> class. Like functions, <tt>GlobalVariable</tt>s are also
2973subclasses of <a href="#GlobalValue"><tt>GlobalValue</tt></a>, and as such are
2974always referenced by their address (global values must live in memory, so their
Reid Spencerbe5e85e2006-04-14 14:11:48 +0000[diff] [blame]2975"name" refers to their constant address). See
2976<a href="#GlobalValue"><tt>GlobalValue</tt></a> for more on this. Global
2977variables may have an initial value (which must be a
2978<a href="#Constant"><tt>Constant</tt></a>), and if they have an initializer,
2979they may be marked as "constant" themselves (indicating that their contents
2980never change at runtime).</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2981</div>
2982
2983<!-- _______________________________________________________________________ -->
2984<div class="doc_subsubsection">
2985 <a name="m_GlobalVariable">Important Public Members of the
2986 <tt>GlobalVariable</tt> class</a>
2987</div>
2988
2989<div class="doc_text">
2990
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]2991<ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]2992 <li><tt>GlobalVariable(const </tt><tt><a href="#Type">Type</a> *Ty, bool
2993 isConstant, LinkageTypes&amp; Linkage, <a href="#Constant">Constant</a>
2994 *Initializer = 0, const std::string &amp;Name = "", Module* Parent = 0)</tt>
2995
2996 <p>Create a new global variable of the specified type. If
2997 <tt>isConstant</tt> is true then the global variable will be marked as
2998 unchanging for the program. The Linkage parameter specifies the type of
2999 linkage (internal, external, weak, linkonce, appending) for the variable. If
3000 the linkage is InternalLinkage, WeakLinkage, or LinkOnceLinkage,&nbsp; then
3001 the resultant global variable will have internal linkage. AppendingLinkage
3002 concatenates together all instances (in different translation units) of the
3003 variable into a single variable but is only applicable to arrays. &nbsp;See
3004 the <a href="LangRef.html#modulestructure">LLVM Language Reference</a> for
3005 further details on linkage types. Optionally an initializer, a name, and the
3006 module to put the variable into may be specified for the global variable as
3007 well.</p></li>
3008
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3009 <li><tt>bool isConstant() const</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3010
3011 <p>Returns true if this is a global variable that is known not to
3012 be modified at runtime.</p></li>
3013
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3014 <li><tt>bool hasInitializer()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3015
3016 <p>Returns true if this <tt>GlobalVariable</tt> has an intializer.</p></li>
3017
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3018 <li><tt><a href="#Constant">Constant</a> *getInitializer()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3019
3020 <p>Returns the intial value for a <tt>GlobalVariable</tt>. It is not legal
3021 to call this method if there is no initializer.</p></li>
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3022</ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3023
3024</div>
3025
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3026
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3027<!-- ======================================================================= -->
3028<div class="doc_subsection">
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3029 <a name="BasicBlock">The <tt>BasicBlock</tt> class</a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3030</div>
3031
3032<div class="doc_text">
3033
3034<p><tt>#include "<a
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3035href="/doxygen/BasicBlock_8h-source.html">llvm/BasicBlock.h</a>"</tt><br>
3036doxygen info: <a href="/doxygen/structllvm_1_1BasicBlock.html">BasicBlock
3037Class</a><br>
3038Superclass: <a href="#Value"><tt>Value</tt></a></p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3039
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3040<p>This class represents a single entry multiple exit section of the code,
3041commonly known as a basic block by the compiler community. The
3042<tt>BasicBlock</tt> class maintains a list of <a
3043href="#Instruction"><tt>Instruction</tt></a>s, which form the body of the block.
3044Matching the language definition, the last element of this list of instructions
3045is always a terminator instruction (a subclass of the <a
3046href="#TerminatorInst"><tt>TerminatorInst</tt></a> class).</p>
3047
3048<p>In addition to tracking the list of instructions that make up the block, the
3049<tt>BasicBlock</tt> class also keeps track of the <a
3050href="#Function"><tt>Function</tt></a> that it is embedded into.</p>
3051
3052<p>Note that <tt>BasicBlock</tt>s themselves are <a
3053href="#Value"><tt>Value</tt></a>s, because they are referenced by instructions
3054like branches and can go in the switch tables. <tt>BasicBlock</tt>s have type
3055<tt>label</tt>.</p>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3056
3057</div>
3058
3059<!-- _______________________________________________________________________ -->
3060<div class="doc_subsubsection">
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3061 <a name="m_BasicBlock">Important Public Members of the <tt>BasicBlock</tt>
3062 class</a>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3063</div>
3064
3065<div class="doc_text">
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3066<ul>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3067
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3068<li><tt>BasicBlock(const std::string &amp;Name = "", </tt><tt><a
3069 href="#Function">Function</a> *Parent = 0)</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3070
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3071<p>The <tt>BasicBlock</tt> constructor is used to create new basic blocks for
3072insertion into a function. The constructor optionally takes a name for the new
3073block, and a <a href="#Function"><tt>Function</tt></a> to insert it into. If
3074the <tt>Parent</tt> parameter is specified, the new <tt>BasicBlock</tt> is
3075automatically inserted at the end of the specified <a
3076href="#Function"><tt>Function</tt></a>, if not specified, the BasicBlock must be
3077manually inserted into the <a href="#Function"><tt>Function</tt></a>.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3078
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3079<li><tt>BasicBlock::iterator</tt> - Typedef for instruction list iterator<br>
3080<tt>BasicBlock::const_iterator</tt> - Typedef for const_iterator.<br>
3081<tt>begin()</tt>, <tt>end()</tt>, <tt>front()</tt>, <tt>back()</tt>,
3082<tt>size()</tt>, <tt>empty()</tt>
3083STL-style functions for accessing the instruction list.
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3084
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3085<p>These methods and typedefs are forwarding functions that have the same
3086semantics as the standard library methods of the same names. These methods
3087expose the underlying instruction list of a basic block in a way that is easy to
3088manipulate. To get the full complement of container operations (including
3089operations to update the list), you must use the <tt>getInstList()</tt>
3090method.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3091
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3092<li><tt>BasicBlock::InstListType &amp;getInstList()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3093
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3094<p>This method is used to get access to the underlying container that actually
3095holds the Instructions. This method must be used when there isn't a forwarding
3096function in the <tt>BasicBlock</tt> class for the operation that you would like
3097to perform. Because there are no forwarding functions for "updating"
3098operations, you need to use this if you want to update the contents of a
3099<tt>BasicBlock</tt>.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3100
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3101<li><tt><a href="#Function">Function</a> *getParent()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3102
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3103<p> Returns a pointer to <a href="#Function"><tt>Function</tt></a> the block is
3104embedded into, or a null pointer if it is homeless.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3105
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3106<li><tt><a href="#TerminatorInst">TerminatorInst</a> *getTerminator()</tt>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3107
Chris Lattner2b78d962007-02-03 20:02:25 +0000[diff] [blame]3108<p> Returns a pointer to the terminator instruction that appears at the end of
3109the <tt>BasicBlock</tt>. If there is no terminator instruction, or if the last
3110instruction in the block is not a terminator, then a null pointer is
3111returned.</p></li>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3112
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3113</ul>
3114
3115</div>
3116
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3117
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3118<!-- ======================================================================= -->
3119<div class="doc_subsection">
3120 <a name="Argument">The <tt>Argument</tt> class</a>
3121</div>
3122
3123<div class="doc_text">
3124
3125<p>This subclass of Value defines the interface for incoming formal
Chris Lattner58360822005-01-17 00:12:04 +0000[diff] [blame]3126arguments to a function. A Function maintains a list of its formal
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3127arguments. An argument has a pointer to the parent Function.</p>
3128
3129</div>
3130
Chris Lattner9355b472002-09-06 02:50:58 +0000[diff] [blame]3131<!-- *********************************************************************** -->
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3132<hr>
3133<address>
3134 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
3135 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
3136 <a href="http://validator.w3.org/check/referer"><img
3137 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
3138
3139 <a href="mailto:dhurjati@cs.uiuc.edu">Dinakar Dhurjati</a> and
3140 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]3141 <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
Misha Brukman13fd15c2004-01-15 00:14:41 +0000[diff] [blame]3142 Last modified: $Date$
3143</address>
3144
Chris Lattner261efe92003-11-25 01:02:51 +0000[diff] [blame]3145</body>
3146</html>