Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / fdb5b01df486f8fca44927a38dc9763e9d538e4c / . / docs / SourceLevelDebugging.html
blob: 166ce0790c1113333101ad9ba7c79f196c6b9e1e [file] [log] [blame]
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]6 <title>Source Level Debugging with LLVM</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9<body>
10
11<div class="doc_title">Source Level Debugging with LLVM</div>
12
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]13<table class="layout" style="width:100%">
14 <tr class="layout">
15 <td class="left">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]16<ul>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]17 <li><a href="#introduction">Introduction</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]18 <ol>
19 <li><a href="#phil">Philosophy behind LLVM debugging information</a></li>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]20 <li><a href="#consumers">Debug information consumers</a></li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]21 <li><a href="#debugopt">Debugging optimized code</a></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]22 </ol></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]23 <li><a href="#format">Debugging information format</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]24 <ol>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]25 <li><a href="#debug_info_descriptors">Debug information descriptors</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]26 <ul>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]27 <li><a href="#format_compile_units">Compile unit descriptors</a></li>
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]28 <li><a href="#format_files">File descriptors</a></li>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]29 <li><a href="#format_global_variables">Global variable descriptors</a></li>
30 <li><a href="#format_subprograms">Subprogram descriptors</a></li>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]31 <li><a href="#format_blocks">Block descriptors</a></li>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]32 <li><a href="#format_basic_type">Basic type descriptors</a></li>
33 <li><a href="#format_derived_type">Derived type descriptors</a></li>
34 <li><a href="#format_composite_type">Composite type descriptors</a></li>
35 <li><a href="#format_subrange">Subrange descriptors</a></li>
36 <li><a href="#format_enumeration">Enumerator descriptors</a></li>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]37 <li><a href="#format_variables">Local variables</a></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]38 </ul></li>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]39 <li><a href="#format_common_intrinsics">Debugger intrinsic functions</a>
40 <ul>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]41 <li><a href="#format_common_declare">llvm.dbg.declare</a></li>
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]42 <li><a href="#format_common_value">llvm.dbg.value</a></li>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]43 </ul></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]44 </ol></li>
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]45 <li><a href="#format_common_lifetime">Object lifetimes and scoping</a></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]46 <li><a href="#ccxx_frontend">C/C++ front-end specific debug information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]47 <ol>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]48 <li><a href="#ccxx_compile_units">C/C++ source file information</a></li>
49 <li><a href="#ccxx_global_variable">C/C++ global variable information</a></li>
50 <li><a href="#ccxx_subprogram">C/C++ function information</a></li>
51 <li><a href="#ccxx_basic_types">C/C++ basic types</a></li>
52 <li><a href="#ccxx_derived_types">C/C++ derived types</a></li>
53 <li><a href="#ccxx_composite_types">C/C++ struct/union types</a></li>
54 <li><a href="#ccxx_enumeration_types">C/C++ enumeration types</a></li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]55 </ol></li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]56</ul>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]57</td>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]58<td class="right">
Misha Brukmane849a1a2004-05-12 21:26:16 +0000[diff] [blame]59<img src="img/venusflytrap.jpg" alt="A leafy and green bug eater" width="247"
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]60height="369">
61</td>
Reid Spencerd3f876c2004-11-01 08:19:36 +0000[diff] [blame]62</tr></table>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]63
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]64<div class="doc_author">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]65 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
Jim Laskeyc760a922007-03-14 19:32:21 +0000[diff] [blame]66 and <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p>
Chris Lattner7911ce22004-05-23 21:07:27 +0000[diff] [blame]67</div>
68
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]69
70<!-- *********************************************************************** -->
Misha Brukman94218a72004-12-09 20:27:37 +0000[diff] [blame]71<div class="doc_section"><a name="introduction">Introduction</a></div>
72<!-- *********************************************************************** -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]73
74<div class="doc_text">
75
76<p>This document is the central repository for all information pertaining to
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]77 debug information in LLVM. It describes the <a href="#format">actual format
78 that the LLVM debug information</a> takes, which is useful for those
79 interested in creating front-ends or dealing directly with the information.
Chris Lattner8ad2f982009-07-18 21:47:15 +0000[diff] [blame]80 Further, this document provides specific examples of what debug information
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]81 for C/C++.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]82
83</div>
84
85<!-- ======================================================================= -->
86<div class="doc_subsection">
87 <a name="phil">Philosophy behind LLVM debugging information</a>
88</div>
89
90<div class="doc_text">
91
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]92<p>The idea of the LLVM debugging information is to capture how the important
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]93 pieces of the source-language's Abstract Syntax Tree map onto LLVM code.
94 Several design aspects have shaped the solution that appears here. The
95 important ones are:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]96
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]97<ul>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]98 <li>Debugging information should have very little impact on the rest of the
99 compiler. No transformations, analyses, or code generators should need to
100 be modified because of debugging information.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]101
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]102 <li>LLVM optimizations should interact in <a href="#debugopt">well-defined and
103 easily described ways</a> with the debugging information.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]104
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]105 <li>Because LLVM is designed to support arbitrary programming languages,
106 LLVM-to-LLVM tools should not need to know anything about the semantics of
107 the source-level-language.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]108
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]109 <li>Source-level languages are often <b>widely</b> different from one another.
110 LLVM should not put any restrictions of the flavor of the source-language,
111 and the debugging information should work with any language.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]112
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]113 <li>With code generator support, it should be possible to use an LLVM compiler
114 to compile a program to native machine code and standard debugging
115 formats. This allows compatibility with traditional machine-code level
116 debuggers, like GDB or DBX.</li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]117</ul>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]118
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]119<p>The approach used by the LLVM implementation is to use a small set
120 of <a href="#format_common_intrinsics">intrinsic functions</a> to define a
121 mapping between LLVM program objects and the source-level objects. The
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]122 description of the source-level program is maintained in LLVM metadata
123 in an <a href="#ccxx_frontend">implementation-defined format</a>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]124 (the C/C++ front-end currently uses working draft 7 of
125 the <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3
126 standard</a>).</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]127
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]128<p>When a program is being debugged, a debugger interacts with the user and
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]129 turns the stored debug information into source-language specific information.
130 As such, a debugger must be aware of the source-language, and is thus tied to
131 a specific language or family of languages.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]132
133</div>
134
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]135<!-- ======================================================================= -->
136<div class="doc_subsection">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]137 <a name="consumers">Debug information consumers</a>
138</div>
139
140<div class="doc_text">
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]141
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]142<p>The role of debug information is to provide meta information normally
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]143 stripped away during the compilation process. This meta information provides
144 an LLVM user a relationship between generated code and the original program
145 source code.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]146
Chris Lattnerc3107782010-04-05 04:11:11 +0000[diff] [blame]147<p>Currently, debug information is consumed by DwarfDebug to produce dwarf
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]148 information used by the gdb debugger. Other targets could use the same
149 information to produce stabs or other debug forms.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]150
151<p>It would also be reasonable to use debug information to feed profiling tools
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]152 for analysis of generated code, or, tools for reconstructing the original
153 source from generated code.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]154
155<p>TODO - expound a bit more.</p>
156
157</div>
158
159<!-- ======================================================================= -->
160<div class="doc_subsection">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]161 <a name="debugopt">Debugging optimized code</a>
162</div>
163
164<div class="doc_text">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]165
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]166<p>An extremely high priority of LLVM debugging information is to make it
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]167 interact well with optimizations and analysis. In particular, the LLVM debug
168 information provides the following guarantees:</p>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]169
170<ul>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]171 <li>LLVM debug information <b>always provides information to accurately read
172 the source-level state of the program</b>, regardless of which LLVM
173 optimizations have been run, and without any modification to the
174 optimizations themselves. However, some optimizations may impact the
175 ability to modify the current state of the program with a debugger, such
176 as setting program variables, or calling functions that have been
177 deleted.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]178
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]179 <li>LLVM optimizations gracefully interact with debugging information. If
180 they are not aware of debug information, they are automatically disabled
181 as necessary in the cases that would invalidate the debug info. This
182 retains the LLVM features, making it easy to write new
183 transformations.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]184
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]185 <li>As desired, LLVM optimizations can be upgraded to be aware of the LLVM
186 debugging information, allowing them to update the debugging information
187 as they perform aggressive optimizations. This means that, with effort,
188 the LLVM optimizers could optimize debug code just as well as non-debug
189 code.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]190
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]191 <li>LLVM debug information does not prevent many important optimizations from
192 happening (for example inlining, basic block reordering/merging/cleanup,
193 tail duplication, etc), further reducing the amount of the compiler that
194 eventually is "aware" of debugging information.</li>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]195
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]196 <li>LLVM debug information is automatically optimized along with the rest of
197 the program, using existing facilities. For example, duplicate
198 information is automatically merged by the linker, and unused information
199 is automatically removed.</li>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]200</ul>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]201
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]202<p>Basically, the debug information allows you to compile a program with
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]203 "<tt>-O0 -g</tt>" and get full debug information, allowing you to arbitrarily
204 modify the program as it executes from a debugger. Compiling a program with
205 "<tt>-O3 -g</tt>" gives you full debug information that is always available
206 and accurate for reading (e.g., you get accurate stack traces despite tail
207 call elimination and inlining), but you might lose the ability to modify the
208 program and call functions where were optimized out of the program, or
209 inlined away completely.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]210
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]211<p><a href="TestingGuide.html#quicktestsuite">LLVM test suite</a> provides a
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]212 framework to test optimizer's handling of debugging information. It can be
213 run like this:</p>
Devang Patela5c05aa2008-11-21 19:35:57 +0000[diff] [blame]214
215<div class="doc_code">
216<pre>
217% cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
218% make TEST=dbgopt
219</pre>
220</div>
221
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]222<p>This will test impact of debugging information on optimization passes. If
223 debugging information influences optimization passes then it will be reported
224 as a failure. See <a href="TestingGuide.html">TestingGuide</a> for more
225 information on LLVM test infrastructure and how to run various tests.</p>
Devang Patela5c05aa2008-11-21 19:35:57 +0000[diff] [blame]226
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]227</div>
228
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]229<!-- *********************************************************************** -->
230<div class="doc_section">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]231 <a name="format">Debugging information format</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]232</div>
233<!-- *********************************************************************** -->
234
235<div class="doc_text">
236
237<p>LLVM debugging information has been carefully designed to make it possible
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]238 for the optimizer to optimize the program and debugging information without
239 necessarily having to know anything about debugging information. In
John Criswellb34500f2010-03-17 15:01:50 +0000[diff] [blame]240 particular, the use of metadata avoids duplicated debugging information from
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]241 the beginning, and the global dead code elimination pass automatically
242 deletes debugging information for a function if it decides to delete the
243 function. </p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]244
245<p>To do this, most of the debugging information (descriptors for types,
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]246 variables, functions, source files, etc) is inserted by the language
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]247 front-end in the form of LLVM metadata. </p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]248
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]249<p>Debug information is designed to be agnostic about the target debugger and
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]250 debugging information representation (e.g. DWARF/Stabs/etc). It uses a
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]251 generic pass to decode the information that represents variables, types,
252 functions, namespaces, etc: this allows for arbitrary source-language
253 semantics and type-systems to be used, as long as there is a module
254 written for the target debugger to interpret the information. </p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]255
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]256<p>To provide basic functionality, the LLVM debugger does have to make some
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]257 assumptions about the source-level language being debugged, though it keeps
258 these to a minimum. The only common features that the LLVM debugger assumes
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]259 exist are <a href="#format_files">source files</a>,
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]260 and <a href="#format_global_variables">program objects</a>. These abstract
261 objects are used by a debugger to form stack traces, show information about
262 local variables, etc.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]263
264<p>This section of the documentation first describes the representation aspects
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]265 common to any source-language. The <a href="#ccxx_frontend">next section</a>
266 describes the data layout conventions used by the C and C++ front-ends.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]267
268</div>
269
270<!-- ======================================================================= -->
271<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]272 <a name="debug_info_descriptors">Debug information descriptors</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]273</div>
274
275<div class="doc_text">
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]276
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]277<p>In consideration of the complexity and volume of debug information, LLVM
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]278 provides a specification for well formed debug descriptors. </p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]279
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]280<p>Consumers of LLVM debug information expect the descriptors for program
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]281 objects to start in a canonical format, but the descriptors can include
282 additional information appended at the end that is source-language
283 specific. All LLVM debugging information is versioned, allowing backwards
284 compatibility in the case that the core structures need to change in some
285 way. Also, all debugging information objects start with a tag to indicate
286 what type of object it is. The source-language is allowed to define its own
287 objects, by using unreserved tag numbers. We recommend using with tags in
Benjamin Kramer8040cd32009-10-12 14:46:08 +0000[diff] [blame]288 the range 0x1000 through 0x2000 (there is a defined enum DW_TAG_user_base =
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]289 0x1000.)</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]290
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]291<p>The fields of debug descriptors used internally by LLVM
Nick Lewycky655fd032010-03-31 07:50:17 +0000[diff] [blame]292 are restricted to only the simple data types <tt>i32</tt>, <tt>i1</tt>,
293 <tt>float</tt>, <tt>double</tt>, <tt>mdstring</tt> and <tt>mdnode</tt>. </p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]294
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]295<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]296<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]297!1 = metadata !{
Nick Lewycky655fd032010-03-31 07:50:17 +0000[diff] [blame]298 i32, ;; A tag
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]299 ...
300}
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]301</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]302</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]303
Jim Laskey7089f452006-06-16 13:14:03 +0000[diff] [blame]304<p><a name="LLVMDebugVersion">The first field of a descriptor is always an
Nick Lewycky655fd032010-03-31 07:50:17 +0000[diff] [blame]305 <tt>i32</tt> containing a tag value identifying the content of the
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]306 descriptor. The remaining fields are specific to the descriptor. The values
307 of tags are loosely bound to the tag values of DWARF information entries.
308 However, that does not restrict the use of the information supplied to DWARF
309 targets. To facilitate versioning of debug information, the tag is augmented
Nick Lewycky655fd032010-03-31 07:50:17 +0000[diff] [blame]310 with the current debug version (LLVMDebugVersion = 8 &lt;&lt; 16 or 0x80000 or
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]311 524288.)</a></p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]312
Jim Laskey7089f452006-06-16 13:14:03 +0000[diff] [blame]313<p>The details of the various descriptors follow.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]314
315</div>
316
317<!-- ======================================================================= -->
318<div class="doc_subsubsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]319 <a name="format_compile_units">Compile unit descriptors</a>
320</div>
321
322<div class="doc_text">
323
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]324<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]325<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]326!0 = metadata !{
327 i32, ;; Tag = 17 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
328 ;; (DW_TAG_compile_unit)
329 i32, ;; Unused field.
330 i32, ;; DWARF language identifier (ex. DW_LANG_C89)
331 metadata, ;; Source file name
332 metadata, ;; Source file directory (includes trailing slash)
333 metadata ;; Producer (ex. "4.0.1 LLVM (LLVM research group)")
334 i1, ;; True if this is a main compile unit.
335 i1, ;; True if this is optimized.
336 metadata, ;; Flags
337 i32 ;; Runtime version
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]338}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]339</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]340</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]341
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]342<p>These descriptors contain a source language ID for the file (we use the DWARF
343 3.0 ID numbers, such as <tt>DW_LANG_C89</tt>, <tt>DW_LANG_C_plus_plus</tt>,
344 <tt>DW_LANG_Cobol74</tt>, etc), three strings describing the filename,
345 working directory of the compiler, and an identifier string for the compiler
346 that produced it.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]347
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]348<p>Compile unit descriptors provide the root context for objects declared in a
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]349 specific compilation unit. File descriptors are defined using this context.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]350
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]351</div>
352
353<!-- ======================================================================= -->
354<div class="doc_subsubsection">
355 <a name="format_files">File descriptors</a>
356</div>
357
358<div class="doc_text">
359
360<div class="doc_code">
361<pre>
362!0 = metadata !{
363 i32, ;; Tag = 41 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
364 ;; (DW_TAG_file_type)
365 metadata, ;; Source file name
366 metadata, ;; Source file directory (includes trailing slash)
367 metadata ;; Reference to compile unit where defined
368}
369</pre>
370</div>
371
John Criswellb34500f2010-03-17 15:01:50 +0000[diff] [blame]372<p>These descriptors contain information for a file. Global variables and top
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]373 level functions would be defined using this context.k File descriptors also
374 provide context for source line correspondence. </p>
375
376<p>Each input file is encoded as a separate file descriptor in LLVM debugging
377 information output. Each file descriptor would be defined using a
378 compile unit. </p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]379
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]380</div>
381
382<!-- ======================================================================= -->
383<div class="doc_subsubsection">
384 <a name="format_global_variables">Global variable descriptors</a>
385</div>
386
387<div class="doc_text">
388
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]389<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]390<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]391!1 = metadata !{
392 i32, ;; Tag = 52 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
393 ;; (DW_TAG_variable)
394 i32, ;; Unused field.
395 metadata, ;; Reference to context descriptor
396 metadata, ;; Name
397 metadata, ;; Display name (fully qualified C++ name)
398 metadata, ;; MIPS linkage name (for C++)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]399 metadata, ;; Reference to file where defined
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]400 i32, ;; Line number where defined
401 metadata, ;; Reference to type descriptor
402 i1, ;; True if the global is local to compile unit (static)
403 i1, ;; True if the global is defined in the compile unit (not extern)
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]404 {}* ;; Reference to the global variable
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]405}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]406</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]407</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]408
409<p>These descriptors provide debug information about globals variables. The
410provide details such as name, type and where the variable is defined.</p>
411
412</div>
413
414<!-- ======================================================================= -->
415<div class="doc_subsubsection">
416 <a name="format_subprograms">Subprogram descriptors</a>
417</div>
418
419<div class="doc_text">
420
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]421<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]422<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]423!2 = metadata !{
424 i32, ;; Tag = 46 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
425 ;; (DW_TAG_subprogram)
426 i32, ;; Unused field.
427 metadata, ;; Reference to context descriptor
428 metadata, ;; Name
429 metadata, ;; Display name (fully qualified C++ name)
430 metadata, ;; MIPS linkage name (for C++)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]431 metadata, ;; Reference to file where defined
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]432 i32, ;; Line number where defined
433 metadata, ;; Reference to type descriptor
434 i1, ;; True if the global is local to compile unit (static)
435 i1 ;; True if the global is defined in the compile unit (not extern)
Devang Patel80ecc152010-06-04 22:49:55 +0000[diff] [blame]436 i32 ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual
437 i32 ;; Index into a virtual function
438 metadata, ;; indicates which base type contains the vtable pointer for the
439 ;; derived class
440 i1 ;; isArtificial
441 i1 ;; isOptimized
442 Function *;; Pointer to LLVM function
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]443}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]444</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]445</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]446
447<p>These descriptors provide debug information about functions, methods and
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]448 subprograms. They provide details such as name, return types and the source
449 location where the subprogram is defined.</p>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]450
451</div>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]452
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]453<!-- ======================================================================= -->
454<div class="doc_subsubsection">
455 <a name="format_blocks">Block descriptors</a>
456</div>
457
458<div class="doc_text">
459
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]460<div class="doc_code">
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]461<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]462!3 = metadata !{
Devang Patelc79dda22010-10-04 16:51:59 +0000[diff] [blame]463 i32, ;; Tag = 11 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_lexical_block)
Devang Patel7f271fc2010-10-01 22:45:00 +0000[diff] [blame]464 metadata,;; Reference to context descriptor
465 i32, ;; Line number
466 i32 ;; Column number
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]467}
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]468</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]469</div>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]470
471<p>These descriptors provide debug information about nested blocks within a
Devang Patel7f271fc2010-10-01 22:45:00 +0000[diff] [blame]472 subprogram. The line number and column numbers are used to dinstinguish
473 two lexical blocks at same depth. </p>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]474
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]475</div>
476
477<!-- ======================================================================= -->
478<div class="doc_subsubsection">
479 <a name="format_basic_type">Basic type descriptors</a>
480</div>
481
482<div class="doc_text">
483
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]484<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]485<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]486!4 = metadata !{
487 i32, ;; Tag = 36 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
488 ;; (DW_TAG_base_type)
489 metadata, ;; Reference to context (typically a compile unit)
490 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]491 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]492 i32, ;; Line number where defined (may be 0)
493 i64, ;; Size in bits
494 i64, ;; Alignment in bits
495 i64, ;; Offset in bits
496 i32, ;; Flags
497 i32 ;; DWARF type encoding
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]498}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]499</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]500</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]501
502<p>These descriptors define primitive types used in the code. Example int, bool
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]503 and float. The context provides the scope of the type, which is usually the
504 top level. Since basic types are not usually user defined the compile unit
505 and line number can be left as NULL and 0. The size, alignment and offset
506 are expressed in bits and can be 64 bit values. The alignment is used to
507 round the offset when embedded in a
508 <a href="#format_composite_type">composite type</a> (example to keep float
509 doubles on 64 bit boundaries.) The offset is the bit offset if embedded in
510 a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]511
512<p>The type encoding provides the details of the type. The values are typically
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]513 one of the following:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]514
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]515<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]516<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]517DW_ATE_address = 1
518DW_ATE_boolean = 2
519DW_ATE_float = 4
520DW_ATE_signed = 5
521DW_ATE_signed_char = 6
522DW_ATE_unsigned = 7
523DW_ATE_unsigned_char = 8
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]524</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]525</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]526
527</div>
528
529<!-- ======================================================================= -->
530<div class="doc_subsubsection">
531 <a name="format_derived_type">Derived type descriptors</a>
532</div>
533
534<div class="doc_text">
535
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]536<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]537<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]538!5 = metadata !{
539 i32, ;; Tag (see below)
540 metadata, ;; Reference to context
541 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]542 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]543 i32, ;; Line number where defined (may be 0)
Devang Patel0ffd10b2010-10-01 19:19:30 +0000[diff] [blame]544 i64, ;; Size in bits
545 i64, ;; Alignment in bits
546 i64, ;; Offset in bits
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]547 metadata ;; Reference to type derived from
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]548}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]549</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]550</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]551
552<p>These descriptors are used to define types derived from other types. The
553value of the tag varies depending on the meaning. The following are possible
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]554tag values:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]555
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]556<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]557<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]558DW_TAG_formal_parameter = 5
559DW_TAG_member = 13
560DW_TAG_pointer_type = 15
561DW_TAG_reference_type = 16
562DW_TAG_typedef = 22
563DW_TAG_const_type = 38
564DW_TAG_volatile_type = 53
565DW_TAG_restrict_type = 55
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]566</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]567</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]568
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]569<p><tt>DW_TAG_member</tt> is used to define a member of
570 a <a href="#format_composite_type">composite type</a>
571 or <a href="#format_subprograms">subprogram</a>. The type of the member is
572 the <a href="#format_derived_type">derived
573 type</a>. <tt>DW_TAG_formal_parameter</tt> is used to define a member which
574 is a formal argument of a subprogram.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]575
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]576<p><tt>DW_TAG_typedef</tt> is used to provide a name for the derived type.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]577
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]578<p><tt>DW_TAG_pointer_type</tt>,<tt>DW_TAG_reference_type</tt>,
579 <tt>DW_TAG_const_type</tt>, <tt>DW_TAG_volatile_type</tt>
580 and <tt>DW_TAG_restrict_type</tt> are used to qualify
581 the <a href="#format_derived_type">derived type</a>. </p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]582
583<p><a href="#format_derived_type">Derived type</a> location can be determined
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]584 from the compile unit and line number. The size, alignment and offset are
585 expressed in bits and can be 64 bit values. The alignment is used to round
586 the offset when embedded in a <a href="#format_composite_type">composite
587 type</a> (example to keep float doubles on 64 bit boundaries.) The offset is
588 the bit offset if embedded in a <a href="#format_composite_type">composite
589 type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]590
591<p>Note that the <tt>void *</tt> type is expressed as a
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]592 <tt>llvm.dbg.derivedtype.type</tt> with tag of <tt>DW_TAG_pointer_type</tt>
593 and <tt>NULL</tt> derived type.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]594
595</div>
596
597<!-- ======================================================================= -->
598<div class="doc_subsubsection">
599 <a name="format_composite_type">Composite type descriptors</a>
600</div>
601
602<div class="doc_text">
603
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]604<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]605<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]606!6 = metadata !{
607 i32, ;; Tag (see below)
608 metadata, ;; Reference to context
609 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]610 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]611 i32, ;; Line number where defined (may be 0)
612 i64, ;; Size in bits
613 i64, ;; Alignment in bits
614 i64, ;; Offset in bits
615 i32, ;; Flags
616 metadata, ;; Reference to type derived from
617 metadata, ;; Reference to array of member descriptors
618 i32 ;; Runtime languages
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]619}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]620</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]621</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]622
623<p>These descriptors are used to define types that are composed of 0 or more
624elements. The value of the tag varies depending on the meaning. The following
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]625are possible tag values:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]626
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]627<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]628<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]629DW_TAG_array_type = 1
630DW_TAG_enumeration_type = 4
631DW_TAG_structure_type = 19
632DW_TAG_union_type = 23
633DW_TAG_vector_type = 259
Bruno Cardoso Lopesd80ddc02009-05-29 17:08:57 +0000[diff] [blame]634DW_TAG_subroutine_type = 21
635DW_TAG_inheritance = 28
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]636</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]637</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]638
Jim Laskeyf8a01a92006-06-15 20:51:43 +0000[diff] [blame]639<p>The vector flag indicates that an array type is a native packed vector.</p>
640
Jim Laskey7089f452006-06-16 13:14:03 +0000[diff] [blame]641<p>The members of array types (tag = <tt>DW_TAG_array_type</tt>) or vector types
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]642 (tag = <tt>DW_TAG_vector_type</tt>) are <a href="#format_subrange">subrange
643 descriptors</a>, each representing the range of subscripts at that level of
644 indexing.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]645
646<p>The members of enumeration types (tag = <tt>DW_TAG_enumeration_type</tt>) are
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]647 <a href="#format_enumeration">enumerator descriptors</a>, each representing
648 the definition of enumeration value for the set.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]649
650<p>The members of structure (tag = <tt>DW_TAG_structure_type</tt>) or union (tag
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]651 = <tt>DW_TAG_union_type</tt>) types are any one of
652 the <a href="#format_basic_type">basic</a>,
653 <a href="#format_derived_type">derived</a>
654 or <a href="#format_composite_type">composite</a> type descriptors, each
655 representing a field member of the structure or union.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]656
Jim Laskey4a9df242006-08-21 21:21:06 +0000[diff] [blame]657<p>For C++ classes (tag = <tt>DW_TAG_structure_type</tt>), member descriptors
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]658 provide information about base classes, static members and member
659 functions. If a member is a <a href="#format_derived_type">derived type
660 descriptor</a> and has a tag of <tt>DW_TAG_inheritance</tt>, then the type
661 represents a base class. If the member of is
662 a <a href="#format_global_variables">global variable descriptor</a> then it
663 represents a static member. And, if the member is
664 a <a href="#format_subprograms">subprogram descriptor</a> then it represents
665 a member function. For static members and member
666 functions, <tt>getName()</tt> returns the members link or the C++ mangled
667 name. <tt>getDisplayName()</tt> the simplied version of the name.</p>
Jim Laskey4a9df242006-08-21 21:21:06 +0000[diff] [blame]668
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]669<p>The first member of subroutine (tag = <tt>DW_TAG_subroutine_type</tt>) type
670 elements is the return type for the subroutine. The remaining elements are
671 the formal arguments to the subroutine.</p>
Jim Laskey094ee722006-06-20 21:13:20 +0000[diff] [blame]672
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]673<p><a href="#format_composite_type">Composite type</a> location can be
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]674 determined from the compile unit and line number. The size, alignment and
675 offset are expressed in bits and can be 64 bit values. The alignment is used
676 to round the offset when embedded in
677 a <a href="#format_composite_type">composite type</a> (as an example, to keep
678 float doubles on 64 bit boundaries.) The offset is the bit offset if embedded
679 in a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]680
681</div>
682
683<!-- ======================================================================= -->
684<div class="doc_subsubsection">
685 <a name="format_subrange">Subrange descriptors</a>
686</div>
687
688<div class="doc_text">
689
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]690<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]691<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]692%<a href="#format_subrange">llvm.dbg.subrange.type</a> = type {
693 i32, ;; Tag = 33 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_subrange_type)
694 i64, ;; Low value
695 i64 ;; High value
696}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]697</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]698</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]699
700<p>These descriptors are used to define ranges of array subscripts for an array
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]701 <a href="#format_composite_type">composite type</a>. The low value defines
702 the lower bounds typically zero for C/C++. The high value is the upper
703 bounds. Values are 64 bit. High - low + 1 is the size of the array. If low
704 == high the array will be unbounded.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]705
706</div>
707
708<!-- ======================================================================= -->
709<div class="doc_subsubsection">
710 <a name="format_enumeration">Enumerator descriptors</a>
711</div>
712
713<div class="doc_text">
714
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]715<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]716<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]717!6 = metadata !{
718 i32, ;; Tag = 40 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
719 ;; (DW_TAG_enumerator)
720 metadata, ;; Name
721 i64 ;; Value
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]722}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]723</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]724</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]725
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]726<p>These descriptors are used to define members of an
727 enumeration <a href="#format_composite_type">composite type</a>, it
728 associates the name to the value.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]729
730</div>
731
732<!-- ======================================================================= -->
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]733<div class="doc_subsubsection">
734 <a name="format_variables">Local variables</a>
735</div>
736
737<div class="doc_text">
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]738
739<div class="doc_code">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]740<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]741!7 = metadata !{
742 i32, ;; Tag (see below)
743 metadata, ;; Context
744 metadata, ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]745 metadata, ;; Reference to file where defined
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]746 i32, ;; Line number where defined
747 metadata ;; Type descriptor
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]748}
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]749</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]750</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]751
752<p>These descriptors are used to define variables local to a sub program. The
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]753 value of the tag depends on the usage of the variable:</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]754
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]755<div class="doc_code">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]756<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]757DW_TAG_auto_variable = 256
758DW_TAG_arg_variable = 257
759DW_TAG_return_variable = 258
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]760</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]761</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]762
763<p>An auto variable is any variable declared in the body of the function. An
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]764 argument variable is any variable that appears as a formal argument to the
765 function. A return variable is used to track the result of a function and
766 has no source correspondent.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]767
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]768<p>The context is either the subprogram or block where the variable is defined.
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]769 Name the source variable name. Compile unit and line indicate where the
770 variable was defined. Type descriptor defines the declared type of the
771 variable.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]772
773</div>
774
775<!-- ======================================================================= -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]776<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]777 <a name="format_common_intrinsics">Debugger intrinsic functions</a>
778</div>
779
780<div class="doc_text">
781
782<p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]783 provide debug information at various points in generated code.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]784
785</div>
786
787<!-- ======================================================================= -->
788<div class="doc_subsubsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]789 <a name="format_common_declare">llvm.dbg.declare</a>
790</div>
791
792<div class="doc_text">
793<pre>
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]794 void %<a href="#format_common_declare">llvm.dbg.declare</a>(metadata, metadata)
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]795</pre>
796
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]797<p>This intrinsic provides information about a local element (ex. variable.) The
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]798 first argument is metadata holding alloca for the variable.</tt>. The
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]799 second argument is
800 the <tt>%<a href="#format_variables">llvm.dbg.variable</a></tt> containing
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]801 the description of the variable. </p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]802
803</div>
804
805<!-- ======================================================================= -->
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]806<div class="doc_subsubsection">
807 <a name="format_common_value">llvm.dbg.value</a>
808</div>
809
810<div class="doc_text">
811<pre>
Dan Gohman3dfb3cf2010-05-28 17:07:41 +0000[diff] [blame]812 void %<a href="#format_common_value">llvm.dbg.value</a>(metadata, i64, metadata)
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]813</pre>
814
815<p>This intrinsic provides information when a user source variable is set to a
816 new value. The first argument is the new value (wrapped as metadata). The
817 second argument is the offset in the user source variable where the new value
818 is written. The third argument is
819 the <tt>%<a href="#format_variables">llvm.dbg.variable</a></tt> containing
820 the description of the user source variable. </p>
821
822</div>
823
824<!-- ======================================================================= -->
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]825<div class="doc_subsection">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]826 <a name="format_common_lifetime">Object lifetimes and scoping</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]827</div>
828
829<div class="doc_text">
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]830<p>In many languages, the local variables in functions can have their lifetimes
831 or scopes limited to a subset of a function. In the C family of languages,
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]832 for example, variables are only live (readable and writable) within the
833 source block that they are defined in. In functional languages, values are
834 only readable after they have been defined. Though this is a very obvious
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]835 concept, it is non-trivial to model in LLVM, because it has no notion of
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]836 scoping in this sense, and does not want to be tied to a language's scoping
837 rules.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]838
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]839<p>In order to handle this, the LLVM debug format uses the metadata attached to
Nick Lewycky655fd032010-03-31 07:50:17 +0000[diff] [blame]840 llvm instructions to encode line number and scoping information. Consider
841 the following C fragment, for example:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]842
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]843<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]844<pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8451. void foo() {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8462. int X = 21;
8473. int Y = 22;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8484. {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8495. int Z = 23;
8506. Z = X;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8517. }
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8528. X = Y;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8539. }
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]854</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]855</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]856
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]857<p>Compiled to LLVM, this function would be represented like this:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]858
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]859<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]860<pre>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]861define void @foo() nounwind ssp {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]862entry:
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]863 %X = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
864 %Y = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
865 %Z = alloca i32, align 4 ; &lt;i32*&gt; [#uses=3]
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]866 %0 = bitcast i32* %X to {}* ; &lt;{}*&gt; [#uses=1]
867 call void @llvm.dbg.declare({}* %0, metadata !0), !dbg !7
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]868 store i32 21, i32* %X, !dbg !8
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]869 %1 = bitcast i32* %Y to {}* ; &lt;{}*&gt; [#uses=1]
870 call void @llvm.dbg.declare({}* %1, metadata !9), !dbg !10
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]871 store i32 22, i32* %Y, !dbg !11
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]872 %2 = bitcast i32* %Z to {}* ; &lt;{}*&gt; [#uses=1]
873 call void @llvm.dbg.declare({}* %2, metadata !12), !dbg !14
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]874 store i32 23, i32* %Z, !dbg !15
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]875 %tmp = load i32* %X, !dbg !16 ; &lt;i32&gt; [#uses=1]
876 %tmp1 = load i32* %Y, !dbg !16 ; &lt;i32&gt; [#uses=1]
877 %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]878 store i32 %add, i32* %Z, !dbg !16
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]879 %tmp2 = load i32* %Y, !dbg !17 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]880 store i32 %tmp2, i32* %X, !dbg !17
881 ret void, !dbg !18
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]882}
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]883
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]884declare void @llvm.dbg.declare({}*, metadata) nounwind readnone
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]885
886!0 = metadata !{i32 459008, metadata !1, metadata !"X",
887 metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ]
888!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
889!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", metadata !"foo",
890 metadata !"foo", metadata !3, i32 1, metadata !4,
891 i1 false, i1 true}; [DW_TAG_subprogram ]
892!3 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c",
893 metadata !"/private/tmp", metadata !"clang 1.1", i1 true,
894 i1 false, metadata !"", i32 0}; [DW_TAG_compile_unit ]
895!4 = metadata !{i32 458773, metadata !3, metadata !"", null, i32 0, i64 0, i64 0,
896 i64 0, i32 0, null, metadata !5, i32 0}; [DW_TAG_subroutine_type ]
897!5 = metadata !{null}
898!6 = metadata !{i32 458788, metadata !3, metadata !"int", metadata !3, i32 0,
899 i64 32, i64 32, i64 0, i32 0, i32 5}; [DW_TAG_base_type ]
900!7 = metadata !{i32 2, i32 7, metadata !1, null}
901!8 = metadata !{i32 2, i32 3, metadata !1, null}
902!9 = metadata !{i32 459008, metadata !1, metadata !"Y", metadata !3, i32 3,
903 metadata !6}; [ DW_TAG_auto_variable ]
904!10 = metadata !{i32 3, i32 7, metadata !1, null}
905!11 = metadata !{i32 3, i32 3, metadata !1, null}
906!12 = metadata !{i32 459008, metadata !13, metadata !"Z", metadata !3, i32 5,
907 metadata !6}; [ DW_TAG_auto_variable ]
908!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
909!14 = metadata !{i32 5, i32 9, metadata !13, null}
910!15 = metadata !{i32 5, i32 5, metadata !13, null}
911!16 = metadata !{i32 6, i32 5, metadata !13, null}
912!17 = metadata !{i32 8, i32 3, metadata !1, null}
913!18 = metadata !{i32 9, i32 1, metadata !2, null}
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]914</pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]915</div>
916
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]917<p>This example illustrates a few important details about LLVM debugging
918 information. In particular, it shows how the <tt>llvm.dbg.declare</tt>
919 intrinsic and location information, which are attached to an instruction,
920 are applied together to allow a debugger to analyze the relationship between
921 statements, variable definitions, and the code used to implement the
922 function.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]923
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]924<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]925<pre>
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]926call void @llvm.dbg.declare({}* %0, metadata !0), !dbg !7
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]927</pre>
928</div>
929
930<p>The first intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]931 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]932 encodes debugging information for the variable <tt>X</tt>. The metadata
933 <tt>!dbg !7</tt> attached to the intrinsic provides scope information for the
934 variable <tt>X</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]935
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]936<div class="doc_code">
937<pre>
938!7 = metadata !{i32 2, i32 7, metadata !1, null}
939!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
940!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo",
941 metadata !"foo", metadata !"foo", metadata !3, i32 1,
942 metadata !4, i1 false, i1 true}; [DW_TAG_subprogram ]
943</pre>
944</div>
945
946<p>Here <tt>!7</tt> is metadata providing location information. It has four
947 fields: line number, column number, scope, and original scope. The original
948 scope represents inline location if this instruction is inlined inside a
949 caller, and is null otherwise. In this example, scope is encoded by
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]950 <tt>!1</tt>. <tt>!1</tt> represents a lexical block inside the scope
951 <tt>!2</tt>, where <tt>!2</tt> is a
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]952 <a href="#format_subprograms">subprogram descriptor</a>. This way the
953 location information attached to the intrinsics indicates that the
954 variable <tt>X</tt> is declared at line number 2 at a function level scope in
955 function <tt>foo</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]956
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]957<p>Now lets take another example.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]958
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]959<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]960<pre>
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]961call void @llvm.dbg.declare({}* %2, metadata !12), !dbg !14
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]962</pre>
963</div>
964
965<p>The second intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]966 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]967 encodes debugging information for variable <tt>Z</tt>. The metadata
968 <tt>!dbg !14</tt> attached to the intrinsic provides scope information for
969 the variable <tt>Z</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]970
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]971<div class="doc_code">
972<pre>
973!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
974!14 = metadata !{i32 5, i32 9, metadata !13, null}
975</pre>
976</div>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]977
John Criswellb34500f2010-03-17 15:01:50 +0000[diff] [blame]978<p>Here <tt>!14</tt> indicates that <tt>Z</tt> is declared at line number 5 and
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]979 column number 9 inside of lexical scope <tt>!13</tt>. The lexical scope
980 itself resides inside of lexical scope <tt>!1</tt> described above.</p>
981
982<p>The scope information attached with each instruction provides a
983 straightforward way to find instructions covered by a scope.</p>
984
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]985</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]986
987<!-- *********************************************************************** -->
988<div class="doc_section">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]989 <a name="ccxx_frontend">C/C++ front-end specific debug information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]990</div>
Misha Brukman94218a72004-12-09 20:27:37 +0000[diff] [blame]991<!-- *********************************************************************** -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]992
993<div class="doc_text">
994
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]995<p>The C and C++ front-ends represent information about the program in a format
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]996 that is effectively identical
997 to <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3.0</a> in
998 terms of information content. This allows code generators to trivially
999 support native debuggers by generating standard dwarf information, and
1000 contains enough information for non-dwarf targets to translate it as
1001 needed.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1002
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1003<p>This section describes the forms used to represent C and C++ programs. Other
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1004 languages could pattern themselves after this (which itself is tuned to
1005 representing programs in the same way that DWARF 3 does), or they could
1006 choose to provide completely different forms if they don't fit into the DWARF
1007 model. As support for debugging information gets added to the various LLVM
1008 source-language front-ends, the information used should be documented
1009 here.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1010
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1011<p>The following sections provide examples of various C/C++ constructs and the
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1012 debug information that would best describe those constructs.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1013
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1014</div>
1015
1016<!-- ======================================================================= -->
1017<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1018 <a name="ccxx_compile_units">C/C++ source file information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1019</div>
1020
1021<div class="doc_text">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1022
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1023<p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located
1024 in the directory <tt>/Users/mine/sources</tt>, the following code:</p>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1025
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1026<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1027<pre>
1028#include "MyHeader.h"
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1029
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1030int main(int argc, char *argv[]) {
1031 return 0;
1032}
1033</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1034</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1035
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1036<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1037
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1038<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1039<pre>
1040...
1041;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1042;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1043;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1044!2 = metadata !{
1045 i32 524305, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1046 i32 0, ;; Unused
1047 i32 4, ;; Language Id
1048 metadata !"MySource.cpp",
1049 metadata !"/Users/mine/sources",
1050 metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)",
1051 i1 true, ;; Main Compile Unit
1052 i1 false, ;; Optimized compile unit
1053 metadata !"", ;; Compiler flags
1054 i32 0} ;; Runtime version
1055
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1056;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1057;; Define the file for the file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1058;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1059!1 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1060 i32 524329, ;; Tag
1061 metadata !"MySource.cpp",
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1062 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1063 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1064}
1065
1066;;
1067;; Define the file for the file "/Users/mine/sources/Myheader.h"
1068;;
1069!3 = metadata !{
1070 i32 524329, ;; Tag
1071 metadata !"Myheader.h"
1072 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1073 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1074}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1075
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1076...
1077</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1078</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1079
Devang Pateld98ec5f2010-03-26 19:08:36 +0000[diff] [blame]1080<p>llvm::Instruction provides easy access to metadata attached with an
1081instruction. One can extract line number information encoded in LLVM IR
1082using <tt>Instruction::getMetadata()</tt> and
1083<tt>DILocation::getLineNumber()</tt>.
1084<pre>
1085 if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction
1086 DILocation Loc(N); // DILocation is in DebugInfo.h
1087 unsigned Line = Loc.getLineNumber();
1088 StringRef File = Loc.getFilename();
1089 StringRef Dir = Loc.getDirectory();
1090 }
1091</pre>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1092</div>
1093
1094<!-- ======================================================================= -->
1095<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1096 <a name="ccxx_global_variable">C/C++ global variable information</a>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1097</div>
1098
1099<div class="doc_text">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1100
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1101<p>Given an integer global variable declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1102
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1103<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1104<pre>
1105int MyGlobal = 100;
1106</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1107</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1108
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1109<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1110
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1111<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1112<pre>
1113;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1114;; Define the global itself.
1115;;
1116%MyGlobal = global int 100
1117...
1118;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1119;; List of debug info of globals
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1120;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1121!llvm.dbg.gv = !{!0}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1122
1123;;
1124;; Define the global variable descriptor. Note the reference to the global
1125;; variable anchor and the global variable itself.
1126;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1127!0 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1128 i32 524340, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1129 i32 0, ;; Unused
1130 metadata !1, ;; Context
1131 metadata !"MyGlobal", ;; Name
1132 metadata !"MyGlobal", ;; Display Name
1133 metadata !"MyGlobal", ;; Linkage Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1134 metadata !3, ;; Compile Unit
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1135 i32 1, ;; Line Number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1136 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1137 i1 false, ;; Is a local variable
1138 i1 true, ;; Is this a definition
1139 i32* @MyGlobal ;; The global variable
1140}
1141
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1142;;
1143;; Define the basic type of 32 bit signed integer. Note that since int is an
1144;; intrinsic type the source file is NULL and line 0.
1145;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1146!4 = metadata !{
1147 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1148 metadata !1, ;; Context
1149 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1150 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1151 i32 0, ;; Line number
1152 i64 32, ;; Size in Bits
1153 i64 32, ;; Align in Bits
1154 i64 0, ;; Offset in Bits
1155 i32 0, ;; Flags
1156 i32 5 ;; Encoding
1157}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1158
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1159</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1160</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1161
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1162</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1163
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1164<!-- ======================================================================= -->
1165<div class="doc_subsection">
1166 <a name="ccxx_subprogram">C/C++ function information</a>
1167</div>
1168
1169<div class="doc_text">
1170
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1171<p>Given a function declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1172
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1173<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1174<pre>
1175int main(int argc, char *argv[]) {
1176 return 0;
1177}
1178</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1179</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1180
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1181<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1182
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1183<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1184<pre>
1185;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1186;; Define the anchor for subprograms. Note that the second field of the
1187;; anchor is 46, which is the same as the tag for subprograms
1188;; (46 = DW_TAG_subprogram.)
1189;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1190!6 = metadata !{
1191 i32 524334, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1192 i32 0, ;; Unused
1193 metadata !1, ;; Context
1194 metadata !"main", ;; Name
1195 metadata !"main", ;; Display name
1196 metadata !"main", ;; Linkage name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1197 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1198 i32 1, ;; Line number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1199 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1200 i1 false, ;; Is local
1201 i1 true ;; Is definition
1202}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1203;;
1204;; Define the subprogram itself.
1205;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1206define i32 @main(i32 %argc, i8** %argv) {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1207...
1208}
1209</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1210</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1211
1212</div>
1213
1214<!-- ======================================================================= -->
1215<div class="doc_subsection">
1216 <a name="ccxx_basic_types">C/C++ basic types</a>
1217</div>
1218
1219<div class="doc_text">
1220
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1221<p>The following are the basic type descriptors for C/C++ core types:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1222
1223</div>
1224
1225<!-- ======================================================================= -->
1226<div class="doc_subsubsection">
1227 <a name="ccxx_basic_type_bool">bool</a>
1228</div>
1229
1230<div class="doc_text">
1231
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1232<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1233<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1234!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1235 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1236 metadata !1, ;; Context
1237 metadata !"bool", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1238 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1239 i32 0, ;; Line number
1240 i64 8, ;; Size in Bits
1241 i64 8, ;; Align in Bits
1242 i64 0, ;; Offset in Bits
1243 i32 0, ;; Flags
1244 i32 2 ;; Encoding
1245}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1246</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1247</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1248
1249</div>
1250
1251<!-- ======================================================================= -->
1252<div class="doc_subsubsection">
1253 <a name="ccxx_basic_char">char</a>
1254</div>
1255
1256<div class="doc_text">
1257
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1258<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1259<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1260!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1261 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1262 metadata !1, ;; Context
1263 metadata !"char", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1264 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1265 i32 0, ;; Line number
1266 i64 8, ;; Size in Bits
1267 i64 8, ;; Align in Bits
1268 i64 0, ;; Offset in Bits
1269 i32 0, ;; Flags
1270 i32 6 ;; Encoding
1271}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1272</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1273</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1274
1275</div>
1276
1277<!-- ======================================================================= -->
1278<div class="doc_subsubsection">
1279 <a name="ccxx_basic_unsigned_char">unsigned char</a>
1280</div>
1281
1282<div class="doc_text">
1283
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1284<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1285<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1286!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1287 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1288 metadata !1, ;; Context
1289 metadata !"unsigned char",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1290 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1291 i32 0, ;; Line number
1292 i64 8, ;; Size in Bits
1293 i64 8, ;; Align in Bits
1294 i64 0, ;; Offset in Bits
1295 i32 0, ;; Flags
1296 i32 8 ;; Encoding
1297}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1298</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1299</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1300
1301</div>
1302
1303<!-- ======================================================================= -->
1304<div class="doc_subsubsection">
1305 <a name="ccxx_basic_short">short</a>
1306</div>
1307
1308<div class="doc_text">
1309
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1310<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1311<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1312!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1313 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1314 metadata !1, ;; Context
1315 metadata !"short int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1316 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1317 i32 0, ;; Line number
1318 i64 16, ;; Size in Bits
1319 i64 16, ;; Align in Bits
1320 i64 0, ;; Offset in Bits
1321 i32 0, ;; Flags
1322 i32 5 ;; Encoding
1323}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1324</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1325</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1326
1327</div>
1328
1329<!-- ======================================================================= -->
1330<div class="doc_subsubsection">
1331 <a name="ccxx_basic_unsigned_short">unsigned short</a>
1332</div>
1333
1334<div class="doc_text">
1335
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1336<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1337<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1338!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1339 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1340 metadata !1, ;; Context
1341 metadata !"short unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1342 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1343 i32 0, ;; Line number
1344 i64 16, ;; Size in Bits
1345 i64 16, ;; Align in Bits
1346 i64 0, ;; Offset in Bits
1347 i32 0, ;; Flags
1348 i32 7 ;; Encoding
1349}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1350</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1351</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1352
1353</div>
1354
1355<!-- ======================================================================= -->
1356<div class="doc_subsubsection">
1357 <a name="ccxx_basic_int">int</a>
1358</div>
1359
1360<div class="doc_text">
1361
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1362<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1363<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1364!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1365 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1366 metadata !1, ;; Context
1367 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1368 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1369 i32 0, ;; Line number
1370 i64 32, ;; Size in Bits
1371 i64 32, ;; Align in Bits
1372 i64 0, ;; Offset in Bits
1373 i32 0, ;; Flags
1374 i32 5 ;; Encoding
1375}
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1376</pre></div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1377
1378</div>
1379
1380<!-- ======================================================================= -->
1381<div class="doc_subsubsection">
1382 <a name="ccxx_basic_unsigned_int">unsigned int</a>
1383</div>
1384
1385<div class="doc_text">
1386
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1387<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1388<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1389!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1390 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1391 metadata !1, ;; Context
1392 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1393 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1394 i32 0, ;; Line number
1395 i64 32, ;; Size in Bits
1396 i64 32, ;; Align in Bits
1397 i64 0, ;; Offset in Bits
1398 i32 0, ;; Flags
1399 i32 7 ;; Encoding
1400}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1401</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1402</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1403
1404</div>
1405
1406<!-- ======================================================================= -->
1407<div class="doc_subsubsection">
1408 <a name="ccxx_basic_long_long">long long</a>
1409</div>
1410
1411<div class="doc_text">
1412
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1413<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1414<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1415!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1416 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1417 metadata !1, ;; Context
1418 metadata !"long long int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1419 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1420 i32 0, ;; Line number
1421 i64 64, ;; Size in Bits
1422 i64 64, ;; Align in Bits
1423 i64 0, ;; Offset in Bits
1424 i32 0, ;; Flags
1425 i32 5 ;; Encoding
1426}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1427</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1428</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1429
1430</div>
1431
1432<!-- ======================================================================= -->
1433<div class="doc_subsubsection">
1434 <a name="ccxx_basic_unsigned_long_long">unsigned long long</a>
1435</div>
1436
1437<div class="doc_text">
1438
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1439<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1440<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1441!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1442 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1443 metadata !1, ;; Context
1444 metadata !"long long unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1445 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1446 i32 0, ;; Line number
1447 i64 64, ;; Size in Bits
1448 i64 64, ;; Align in Bits
1449 i64 0, ;; Offset in Bits
1450 i32 0, ;; Flags
1451 i32 7 ;; Encoding
1452}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1453</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1454</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1455
1456</div>
1457
1458<!-- ======================================================================= -->
1459<div class="doc_subsubsection">
1460 <a name="ccxx_basic_float">float</a>
1461</div>
1462
1463<div class="doc_text">
1464
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1465<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1466<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1467!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1468 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1469 metadata !1, ;; Context
1470 metadata !"float",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1471 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1472 i32 0, ;; Line number
1473 i64 32, ;; Size in Bits
1474 i64 32, ;; Align in Bits
1475 i64 0, ;; Offset in Bits
1476 i32 0, ;; Flags
1477 i32 4 ;; Encoding
1478}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1479</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1480</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1481
1482</div>
1483
1484<!-- ======================================================================= -->
1485<div class="doc_subsubsection">
1486 <a name="ccxx_basic_double">double</a>
1487</div>
1488
1489<div class="doc_text">
1490
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1491<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1492<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1493!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1494 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1495 metadata !1, ;; Context
1496 metadata !"double",;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1497 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1498 i32 0, ;; Line number
1499 i64 64, ;; Size in Bits
1500 i64 64, ;; Align in Bits
1501 i64 0, ;; Offset in Bits
1502 i32 0, ;; Flags
1503 i32 4 ;; Encoding
1504}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1505</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1506</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1507
1508</div>
1509
1510<!-- ======================================================================= -->
1511<div class="doc_subsection">
1512 <a name="ccxx_derived_types">C/C++ derived types</a>
1513</div>
1514
1515<div class="doc_text">
1516
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1517<p>Given the following as an example of C/C++ derived type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1518
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1519<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1520<pre>
1521typedef const int *IntPtr;
1522</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1523</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1524
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1525<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1526
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1527<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1528<pre>
1529;;
1530;; Define the typedef "IntPtr".
1531;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1532!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1533 i32 524310, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1534 metadata !1, ;; Context
1535 metadata !"IntPtr", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1536 metadata !3, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1537 i32 0, ;; Line number
1538 i64 0, ;; Size in bits
1539 i64 0, ;; Align in bits
1540 i64 0, ;; Offset in bits
1541 i32 0, ;; Flags
1542 metadata !4 ;; Derived From type
1543}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1544
1545;;
1546;; Define the pointer type.
1547;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1548!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1549 i32 524303, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1550 metadata !1, ;; Context
1551 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1552 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1553 i32 0, ;; Line number
1554 i64 64, ;; Size in bits
1555 i64 64, ;; Align in bits
1556 i64 0, ;; Offset in bits
1557 i32 0, ;; Flags
1558 metadata !5 ;; Derived From type
1559}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1560;;
1561;; Define the const type.
1562;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1563!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1564 i32 524326, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1565 metadata !1, ;; Context
1566 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1567 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1568 i32 0, ;; Line number
1569 i64 32, ;; Size in bits
1570 i64 32, ;; Align in bits
1571 i64 0, ;; Offset in bits
1572 i32 0, ;; Flags
1573 metadata !6 ;; Derived From type
1574}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1575;;
1576;; Define the int type.
1577;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1578!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1579 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1580 metadata !1, ;; Context
1581 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1582 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1583 i32 0, ;; Line number
1584 i64 32, ;; Size in bits
1585 i64 32, ;; Align in bits
1586 i64 0, ;; Offset in bits
1587 i32 0, ;; Flags
1588 5 ;; Encoding
1589}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1590</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1591</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1592
1593</div>
1594
1595<!-- ======================================================================= -->
1596<div class="doc_subsection">
1597 <a name="ccxx_composite_types">C/C++ struct/union types</a>
1598</div>
1599
1600<div class="doc_text">
1601
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1602<p>Given the following as an example of C/C++ struct type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1603
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1604<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1605<pre>
1606struct Color {
1607 unsigned Red;
1608 unsigned Green;
1609 unsigned Blue;
1610};
1611</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1612</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1613
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1614<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1615
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1616<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1617<pre>
1618;;
1619;; Define basic type for unsigned int.
1620;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1621!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1622 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1623 metadata !1, ;; Context
1624 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1625 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1626 i32 0, ;; Line number
1627 i64 32, ;; Size in Bits
1628 i64 32, ;; Align in Bits
1629 i64 0, ;; Offset in Bits
1630 i32 0, ;; Flags
1631 i32 7 ;; Encoding
1632}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1633;;
1634;; Define composite type for struct Color.
1635;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1636!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1637 i32 524307, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1638 metadata !1, ;; Context
1639 metadata !"Color", ;; Name
1640 metadata !1, ;; Compile unit
1641 i32 1, ;; Line number
1642 i64 96, ;; Size in bits
1643 i64 32, ;; Align in bits
1644 i64 0, ;; Offset in bits
1645 i32 0, ;; Flags
1646 null, ;; Derived From
1647 metadata !3, ;; Elements
1648 i32 0 ;; Runtime Language
1649}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1650
1651;;
1652;; Define the Red field.
1653;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1654!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1655 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1656 metadata !1, ;; Context
1657 metadata !"Red", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1658 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1659 i32 2, ;; Line number
1660 i64 32, ;; Size in bits
1661 i64 32, ;; Align in bits
1662 i64 0, ;; Offset in bits
1663 i32 0, ;; Flags
1664 metadata !5 ;; Derived From type
1665}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1666
1667;;
1668;; Define the Green field.
1669;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1670!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1671 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1672 metadata !1, ;; Context
1673 metadata !"Green", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1674 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1675 i32 3, ;; Line number
1676 i64 32, ;; Size in bits
1677 i64 32, ;; Align in bits
1678 i64 32, ;; Offset in bits
1679 i32 0, ;; Flags
1680 metadata !5 ;; Derived From type
1681}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1682
1683;;
1684;; Define the Blue field.
1685;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1686!7 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1687 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1688 metadata !1, ;; Context
1689 metadata !"Blue", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1690 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1691 i32 4, ;; Line number
1692 i64 32, ;; Size in bits
1693 i64 32, ;; Align in bits
1694 i64 64, ;; Offset in bits
1695 i32 0, ;; Flags
1696 metadata !5 ;; Derived From type
1697}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1698
1699;;
1700;; Define the array of fields used by the composite type Color.
1701;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1702!3 = metadata !{metadata !4, metadata !6, metadata !7}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1703</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1704</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1705
1706</div>
1707
1708<!-- ======================================================================= -->
1709<div class="doc_subsection">
1710 <a name="ccxx_enumeration_types">C/C++ enumeration types</a>
1711</div>
1712
1713<div class="doc_text">
1714
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1715<p>Given the following as an example of C/C++ enumeration type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1716
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1717<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1718<pre>
1719enum Trees {
1720 Spruce = 100,
1721 Oak = 200,
1722 Maple = 300
1723};
1724</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1725</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1726
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1727<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1728
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1729<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1730<pre>
1731;;
1732;; Define composite type for enum Trees
1733;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1734!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1735 i32 524292, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1736 metadata !1, ;; Context
1737 metadata !"Trees", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1738 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1739 i32 1, ;; Line number
1740 i64 32, ;; Size in bits
1741 i64 32, ;; Align in bits
1742 i64 0, ;; Offset in bits
1743 i32 0, ;; Flags
1744 null, ;; Derived From type
1745 metadata !3, ;; Elements
1746 i32 0 ;; Runtime language
1747}
Devang Patel2a610c72009-08-25 05:24:07 +0000[diff] [blame]1748
Devang Patel82459882009-08-26 05:01:18 +0000[diff] [blame]1749;;
1750;; Define the array of enumerators used by composite type Trees.
1751;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1752!3 = metadata !{metadata !4, metadata !5, metadata !6}
1753
1754;;
1755;; Define Spruce enumerator.
1756;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1757!4 = metadata !{i32 524328, metadata !"Spruce", i64 100}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1758
1759;;
1760;; Define Oak enumerator.
1761;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1762!5 = metadata !{i32 524328, metadata !"Oak", i64 200}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1763
1764;;
1765;; Define Maple enumerator.
1766;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1767!6 = metadata !{i32 524328, metadata !"Maple", i64 300}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1768
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1769</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1770</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1771
1772</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1773
1774<!-- *********************************************************************** -->
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1775
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1776<hr>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1777<address>
1778 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1779 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1780 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1781 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1782
1783 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1784 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1785 Last modified: $Date$
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1786</address>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1787
1788</body>
1789</html>