Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 90d81f1dd5a27b7b9bcf81783cdfe5543ab9b60e / . / docs / SourceLevelDebugging.html
blob: 789b8ca64905520624f0ef3f42b27897d0a0d8a8 [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
Chris Lattner89940752011-01-18 06:12:10 +0000[diff] [blame]81 for C/C++ looks like.</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
Devang Patel90d81f12011-03-08 16:25:29 +0000[diff] [blame^]466 i32, ;; Column number
467 metadata,;; Reference to source file
468 i32 ;; Unique ID to identify blocks from a template function
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]469}
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]470</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]471</div>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]472
473<p>These descriptors provide debug information about nested blocks within a
Devang Patel7f271fc2010-10-01 22:45:00 +0000[diff] [blame]474 subprogram. The line number and column numbers are used to dinstinguish
475 two lexical blocks at same depth. </p>
Jim Laskey3d11bee2006-03-15 19:10:52 +0000[diff] [blame]476
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]477</div>
478
479<!-- ======================================================================= -->
480<div class="doc_subsubsection">
481 <a name="format_basic_type">Basic type descriptors</a>
482</div>
483
484<div class="doc_text">
485
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]486<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]487<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]488!4 = metadata !{
489 i32, ;; Tag = 36 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
490 ;; (DW_TAG_base_type)
491 metadata, ;; Reference to context (typically a compile unit)
492 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]493 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]494 i32, ;; Line number where defined (may be 0)
495 i64, ;; Size in bits
496 i64, ;; Alignment in bits
497 i64, ;; Offset in bits
498 i32, ;; Flags
499 i32 ;; DWARF type encoding
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]500}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]501</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]502</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]503
504<p>These descriptors define primitive types used in the code. Example int, bool
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]505 and float. The context provides the scope of the type, which is usually the
506 top level. Since basic types are not usually user defined the compile unit
507 and line number can be left as NULL and 0. The size, alignment and offset
508 are expressed in bits and can be 64 bit values. The alignment is used to
509 round the offset when embedded in a
510 <a href="#format_composite_type">composite type</a> (example to keep float
511 doubles on 64 bit boundaries.) The offset is the bit offset if embedded in
512 a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]513
514<p>The type encoding provides the details of the type. The values are typically
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]515 one of the following:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]516
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]517<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]518<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]519DW_ATE_address = 1
520DW_ATE_boolean = 2
521DW_ATE_float = 4
522DW_ATE_signed = 5
523DW_ATE_signed_char = 6
524DW_ATE_unsigned = 7
525DW_ATE_unsigned_char = 8
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]526</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]527</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]528
529</div>
530
531<!-- ======================================================================= -->
532<div class="doc_subsubsection">
533 <a name="format_derived_type">Derived type descriptors</a>
534</div>
535
536<div class="doc_text">
537
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]538<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]539<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]540!5 = metadata !{
541 i32, ;; Tag (see below)
542 metadata, ;; Reference to context
543 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]544 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]545 i32, ;; Line number where defined (may be 0)
Devang Patel0ffd10b2010-10-01 19:19:30 +0000[diff] [blame]546 i64, ;; Size in bits
547 i64, ;; Alignment in bits
548 i64, ;; Offset in bits
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]549 metadata ;; Reference to type derived from
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]550}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]551</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]552</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]553
554<p>These descriptors are used to define types derived from other types. The
555value of the tag varies depending on the meaning. The following are possible
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]556tag values:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]557
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]558<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]559<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]560DW_TAG_formal_parameter = 5
561DW_TAG_member = 13
562DW_TAG_pointer_type = 15
563DW_TAG_reference_type = 16
564DW_TAG_typedef = 22
565DW_TAG_const_type = 38
566DW_TAG_volatile_type = 53
567DW_TAG_restrict_type = 55
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]568</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]569</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]570
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]571<p><tt>DW_TAG_member</tt> is used to define a member of
572 a <a href="#format_composite_type">composite type</a>
573 or <a href="#format_subprograms">subprogram</a>. The type of the member is
574 the <a href="#format_derived_type">derived
575 type</a>. <tt>DW_TAG_formal_parameter</tt> is used to define a member which
576 is a formal argument of a subprogram.</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_typedef</tt> is used to provide a name for the derived type.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]579
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]580<p><tt>DW_TAG_pointer_type</tt>,<tt>DW_TAG_reference_type</tt>,
581 <tt>DW_TAG_const_type</tt>, <tt>DW_TAG_volatile_type</tt>
582 and <tt>DW_TAG_restrict_type</tt> are used to qualify
583 the <a href="#format_derived_type">derived type</a>. </p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]584
585<p><a href="#format_derived_type">Derived type</a> location can be determined
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]586 from the compile unit and line number. The size, alignment and offset are
587 expressed in bits and can be 64 bit values. The alignment is used to round
588 the offset when embedded in a <a href="#format_composite_type">composite
589 type</a> (example to keep float doubles on 64 bit boundaries.) The offset is
590 the bit offset if embedded in a <a href="#format_composite_type">composite
591 type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]592
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]593<p>Note that the <tt>void *</tt> type is expressed as a type derived from NULL.
594</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]595
596</div>
597
598<!-- ======================================================================= -->
599<div class="doc_subsubsection">
600 <a name="format_composite_type">Composite type descriptors</a>
601</div>
602
603<div class="doc_text">
604
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]605<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]606<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]607!6 = metadata !{
608 i32, ;; Tag (see below)
609 metadata, ;; Reference to context
610 metadata, ;; Name (may be "" for anonymous types)
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]611 metadata, ;; Reference to file where defined (may be NULL)
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]612 i32, ;; Line number where defined (may be 0)
613 i64, ;; Size in bits
614 i64, ;; Alignment in bits
615 i64, ;; Offset in bits
616 i32, ;; Flags
617 metadata, ;; Reference to type derived from
618 metadata, ;; Reference to array of member descriptors
619 i32 ;; Runtime languages
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]620}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]621</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]622</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]623
624<p>These descriptors are used to define types that are composed of 0 or more
625elements. The value of the tag varies depending on the meaning. The following
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]626are possible tag values:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]627
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]628<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]629<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]630DW_TAG_array_type = 1
631DW_TAG_enumeration_type = 4
632DW_TAG_structure_type = 19
633DW_TAG_union_type = 23
634DW_TAG_vector_type = 259
Bruno Cardoso Lopesd80ddc02009-05-29 17:08:57 +0000[diff] [blame]635DW_TAG_subroutine_type = 21
636DW_TAG_inheritance = 28
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]637</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]638</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]639
Jim Laskeyf8a01a92006-06-15 20:51:43 +0000[diff] [blame]640<p>The vector flag indicates that an array type is a native packed vector.</p>
641
Jim Laskey7089f452006-06-16 13:14:03 +0000[diff] [blame]642<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]643 (tag = <tt>DW_TAG_vector_type</tt>) are <a href="#format_subrange">subrange
644 descriptors</a>, each representing the range of subscripts at that level of
645 indexing.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]646
647<p>The members of enumeration types (tag = <tt>DW_TAG_enumeration_type</tt>) are
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]648 <a href="#format_enumeration">enumerator descriptors</a>, each representing
649 the definition of enumeration value for the set.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]650
651<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]652 = <tt>DW_TAG_union_type</tt>) types are any one of
653 the <a href="#format_basic_type">basic</a>,
654 <a href="#format_derived_type">derived</a>
655 or <a href="#format_composite_type">composite</a> type descriptors, each
656 representing a field member of the structure or union.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]657
Jim Laskey4a9df242006-08-21 21:21:06 +0000[diff] [blame]658<p>For C++ classes (tag = <tt>DW_TAG_structure_type</tt>), member descriptors
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]659 provide information about base classes, static members and member
660 functions. If a member is a <a href="#format_derived_type">derived type
661 descriptor</a> and has a tag of <tt>DW_TAG_inheritance</tt>, then the type
662 represents a base class. If the member of is
663 a <a href="#format_global_variables">global variable descriptor</a> then it
664 represents a static member. And, if the member is
665 a <a href="#format_subprograms">subprogram descriptor</a> then it represents
666 a member function. For static members and member
667 functions, <tt>getName()</tt> returns the members link or the C++ mangled
668 name. <tt>getDisplayName()</tt> the simplied version of the name.</p>
Jim Laskey4a9df242006-08-21 21:21:06 +0000[diff] [blame]669
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]670<p>The first member of subroutine (tag = <tt>DW_TAG_subroutine_type</tt>) type
671 elements is the return type for the subroutine. The remaining elements are
672 the formal arguments to the subroutine.</p>
Jim Laskey094ee722006-06-20 21:13:20 +0000[diff] [blame]673
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]674<p><a href="#format_composite_type">Composite type</a> location can be
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]675 determined from the compile unit and line number. The size, alignment and
676 offset are expressed in bits and can be 64 bit values. The alignment is used
677 to round the offset when embedded in
678 a <a href="#format_composite_type">composite type</a> (as an example, to keep
679 float doubles on 64 bit boundaries.) The offset is the bit offset if embedded
680 in a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]681
682</div>
683
684<!-- ======================================================================= -->
685<div class="doc_subsubsection">
686 <a name="format_subrange">Subrange descriptors</a>
687</div>
688
689<div class="doc_text">
690
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]691<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]692<pre>
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]693!42 = metadata !{
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]694 i32, ;; Tag = 33 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_subrange_type)
695 i64, ;; Low value
696 i64 ;; High value
697}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]698</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]699</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]700
701<p>These descriptors are used to define ranges of array subscripts for an array
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]702 <a href="#format_composite_type">composite type</a>. The low value defines
703 the lower bounds typically zero for C/C++. The high value is the upper
704 bounds. Values are 64 bit. High - low + 1 is the size of the array. If low
705 == high the array will be unbounded.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]706
707</div>
708
709<!-- ======================================================================= -->
710<div class="doc_subsubsection">
711 <a name="format_enumeration">Enumerator descriptors</a>
712</div>
713
714<div class="doc_text">
715
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]716<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]717<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]718!6 = metadata !{
719 i32, ;; Tag = 40 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
720 ;; (DW_TAG_enumerator)
721 metadata, ;; Name
722 i64 ;; Value
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]723}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]724</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]725</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]726
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]727<p>These descriptors are used to define members of an
728 enumeration <a href="#format_composite_type">composite type</a>, it
729 associates the name to the value.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]730
731</div>
732
733<!-- ======================================================================= -->
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]734<div class="doc_subsubsection">
735 <a name="format_variables">Local variables</a>
736</div>
737
738<div class="doc_text">
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]739
740<div class="doc_code">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]741<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]742!7 = metadata !{
743 i32, ;; Tag (see below)
744 metadata, ;; Context
745 metadata, ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]746 metadata, ;; Reference to file where defined
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]747 i32, ;; Line number where defined
748 metadata ;; Type descriptor
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]749}
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]750</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]751</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]752
753<p>These descriptors are used to define variables local to a sub program. The
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]754 value of the tag depends on the usage of the variable:</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]755
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]756<div class="doc_code">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]757<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]758DW_TAG_auto_variable = 256
759DW_TAG_arg_variable = 257
760DW_TAG_return_variable = 258
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]761</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]762</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]763
764<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]765 argument variable is any variable that appears as a formal argument to the
766 function. A return variable is used to track the result of a function and
767 has no source correspondent.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]768
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]769<p>The context is either the subprogram or block where the variable is defined.
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]770 Name the source variable name. Compile unit and line indicate where the
771 variable was defined. Type descriptor defines the declared type of the
772 variable.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]773
774</div>
775
776<!-- ======================================================================= -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]777<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]778 <a name="format_common_intrinsics">Debugger intrinsic functions</a>
779</div>
780
781<div class="doc_text">
782
783<p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]784 provide debug information at various points in generated code.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]785
786</div>
787
788<!-- ======================================================================= -->
789<div class="doc_subsubsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]790 <a name="format_common_declare">llvm.dbg.declare</a>
791</div>
792
793<div class="doc_text">
794<pre>
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]795 void %<a href="#format_common_declare">llvm.dbg.declare</a>(metadata, metadata)
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]796</pre>
797
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]798<p>This intrinsic provides information about a local element (ex. variable.) The
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]799 first argument is metadata holding alloca for the variable.</tt>. The
Devang Patele136e502011-02-01 17:22:12 +0000[diff] [blame]800 second argument is metadata containing description of the variable. </p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]801</div>
802
803<!-- ======================================================================= -->
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]804<div class="doc_subsubsection">
805 <a name="format_common_value">llvm.dbg.value</a>
806</div>
807
808<div class="doc_text">
809<pre>
Dan Gohman3dfb3cf2010-05-28 17:07:41 +0000[diff] [blame]810 void %<a href="#format_common_value">llvm.dbg.value</a>(metadata, i64, metadata)
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]811</pre>
812
813<p>This intrinsic provides information when a user source variable is set to a
814 new value. The first argument is the new value (wrapped as metadata). The
815 second argument is the offset in the user source variable where the new value
Devang Patele136e502011-02-01 17:22:12 +0000[diff] [blame]816 is written. The third argument is metadata containing description of the
817 user source variable. </p>
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]818</div>
819
820<!-- ======================================================================= -->
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]821<div class="doc_subsection">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]822 <a name="format_common_lifetime">Object lifetimes and scoping</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]823</div>
824
825<div class="doc_text">
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]826<p>In many languages, the local variables in functions can have their lifetimes
827 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]828 for example, variables are only live (readable and writable) within the
829 source block that they are defined in. In functional languages, values are
830 only readable after they have been defined. Though this is a very obvious
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]831 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]832 scoping in this sense, and does not want to be tied to a language's scoping
833 rules.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]834
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]835<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]836 llvm instructions to encode line number and scoping information. Consider
837 the following C fragment, for example:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]838
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]839<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]840<pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8411. void foo() {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8422. int X = 21;
8433. int Y = 22;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8444. {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8455. int Z = 23;
8466. Z = X;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8477. }
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8488. X = Y;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8499. }
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]850</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]851</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]852
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]853<p>Compiled to LLVM, this function would be represented like this:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]854
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]855<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]856<pre>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]857define void @foo() nounwind ssp {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]858entry:
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]859 %X = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
860 %Y = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
861 %Z = alloca i32, align 4 ; &lt;i32*&gt; [#uses=3]
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]862 %0 = bitcast i32* %X to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]863 call void @llvm.dbg.declare(metadata !{i32 * %X}, metadata !0), !dbg !7
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]864 store i32 21, i32* %X, !dbg !8
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]865 %1 = bitcast i32* %Y to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]866 call void @llvm.dbg.declare(metadata !{i32 * %Y}, metadata !9), !dbg !10
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]867 store i32 22, i32* %Y, !dbg !11
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]868 %2 = bitcast i32* %Z to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]869 call void @llvm.dbg.declare(metadata !{i32 * %Z}, metadata !12), !dbg !14
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]870 store i32 23, i32* %Z, !dbg !15
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]871 %tmp = load i32* %X, !dbg !16 ; &lt;i32&gt; [#uses=1]
872 %tmp1 = load i32* %Y, !dbg !16 ; &lt;i32&gt; [#uses=1]
873 %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]874 store i32 %add, i32* %Z, !dbg !16
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]875 %tmp2 = load i32* %Y, !dbg !17 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]876 store i32 %tmp2, i32* %X, !dbg !17
877 ret void, !dbg !18
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]878}
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]879
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]880declare void @llvm.dbg.declare(metadata, metadata) nounwind readnone
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]881
882!0 = metadata !{i32 459008, metadata !1, metadata !"X",
883 metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ]
884!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
885!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", metadata !"foo",
886 metadata !"foo", metadata !3, i32 1, metadata !4,
887 i1 false, i1 true}; [DW_TAG_subprogram ]
888!3 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c",
889 metadata !"/private/tmp", metadata !"clang 1.1", i1 true,
890 i1 false, metadata !"", i32 0}; [DW_TAG_compile_unit ]
891!4 = metadata !{i32 458773, metadata !3, metadata !"", null, i32 0, i64 0, i64 0,
892 i64 0, i32 0, null, metadata !5, i32 0}; [DW_TAG_subroutine_type ]
893!5 = metadata !{null}
894!6 = metadata !{i32 458788, metadata !3, metadata !"int", metadata !3, i32 0,
895 i64 32, i64 32, i64 0, i32 0, i32 5}; [DW_TAG_base_type ]
896!7 = metadata !{i32 2, i32 7, metadata !1, null}
897!8 = metadata !{i32 2, i32 3, metadata !1, null}
898!9 = metadata !{i32 459008, metadata !1, metadata !"Y", metadata !3, i32 3,
899 metadata !6}; [ DW_TAG_auto_variable ]
900!10 = metadata !{i32 3, i32 7, metadata !1, null}
901!11 = metadata !{i32 3, i32 3, metadata !1, null}
902!12 = metadata !{i32 459008, metadata !13, metadata !"Z", metadata !3, i32 5,
903 metadata !6}; [ DW_TAG_auto_variable ]
904!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
905!14 = metadata !{i32 5, i32 9, metadata !13, null}
906!15 = metadata !{i32 5, i32 5, metadata !13, null}
907!16 = metadata !{i32 6, i32 5, metadata !13, null}
908!17 = metadata !{i32 8, i32 3, metadata !1, null}
909!18 = metadata !{i32 9, i32 1, metadata !2, null}
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]910</pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]911</div>
912
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]913<p>This example illustrates a few important details about LLVM debugging
914 information. In particular, it shows how the <tt>llvm.dbg.declare</tt>
915 intrinsic and location information, which are attached to an instruction,
916 are applied together to allow a debugger to analyze the relationship between
917 statements, variable definitions, and the code used to implement the
918 function.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]919
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]920<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]921<pre>
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]922call void @llvm.dbg.declare(metadata, metadata !0), !dbg !7
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]923</pre>
924</div>
925
926<p>The first intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]927 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]928 encodes debugging information for the variable <tt>X</tt>. The metadata
929 <tt>!dbg !7</tt> attached to the intrinsic provides scope information for the
930 variable <tt>X</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]931
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]932<div class="doc_code">
933<pre>
934!7 = metadata !{i32 2, i32 7, metadata !1, null}
935!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
936!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo",
937 metadata !"foo", metadata !"foo", metadata !3, i32 1,
938 metadata !4, i1 false, i1 true}; [DW_TAG_subprogram ]
939</pre>
940</div>
941
942<p>Here <tt>!7</tt> is metadata providing location information. It has four
943 fields: line number, column number, scope, and original scope. The original
944 scope represents inline location if this instruction is inlined inside a
945 caller, and is null otherwise. In this example, scope is encoded by
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]946 <tt>!1</tt>. <tt>!1</tt> represents a lexical block inside the scope
947 <tt>!2</tt>, where <tt>!2</tt> is a
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]948 <a href="#format_subprograms">subprogram descriptor</a>. This way the
949 location information attached to the intrinsics indicates that the
950 variable <tt>X</tt> is declared at line number 2 at a function level scope in
951 function <tt>foo</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]952
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]953<p>Now lets take another example.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]954
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]955<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]956<pre>
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]957call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]958</pre>
959</div>
960
961<p>The second intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]962 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]963 encodes debugging information for variable <tt>Z</tt>. The metadata
964 <tt>!dbg !14</tt> attached to the intrinsic provides scope information for
965 the variable <tt>Z</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]966
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]967<div class="doc_code">
968<pre>
969!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
970!14 = metadata !{i32 5, i32 9, metadata !13, null}
971</pre>
972</div>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]973
John Criswellb34500f2010-03-17 15:01:50 +0000[diff] [blame]974<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]975 column number 9 inside of lexical scope <tt>!13</tt>. The lexical scope
976 itself resides inside of lexical scope <tt>!1</tt> described above.</p>
977
978<p>The scope information attached with each instruction provides a
979 straightforward way to find instructions covered by a scope.</p>
980
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]981</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]982
983<!-- *********************************************************************** -->
984<div class="doc_section">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]985 <a name="ccxx_frontend">C/C++ front-end specific debug information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]986</div>
Misha Brukman94218a72004-12-09 20:27:37 +0000[diff] [blame]987<!-- *********************************************************************** -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]988
989<div class="doc_text">
990
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]991<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]992 that is effectively identical
993 to <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3.0</a> in
994 terms of information content. This allows code generators to trivially
995 support native debuggers by generating standard dwarf information, and
996 contains enough information for non-dwarf targets to translate it as
997 needed.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]998
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]999<p>This section describes the forms used to represent C and C++ programs. Other
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1000 languages could pattern themselves after this (which itself is tuned to
1001 representing programs in the same way that DWARF 3 does), or they could
1002 choose to provide completely different forms if they don't fit into the DWARF
1003 model. As support for debugging information gets added to the various LLVM
1004 source-language front-ends, the information used should be documented
1005 here.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1006
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1007<p>The following sections provide examples of various C/C++ constructs and the
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1008 debug information that would best describe those constructs.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1009
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1010</div>
1011
1012<!-- ======================================================================= -->
1013<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1014 <a name="ccxx_compile_units">C/C++ source file information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1015</div>
1016
1017<div class="doc_text">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1018
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1019<p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located
1020 in the directory <tt>/Users/mine/sources</tt>, the following code:</p>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1021
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1022<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1023<pre>
1024#include "MyHeader.h"
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1025
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1026int main(int argc, char *argv[]) {
1027 return 0;
1028}
1029</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1030</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1031
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1032<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1033
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1034<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1035<pre>
1036...
1037;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1038;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1039;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1040!2 = metadata !{
1041 i32 524305, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1042 i32 0, ;; Unused
1043 i32 4, ;; Language Id
1044 metadata !"MySource.cpp",
1045 metadata !"/Users/mine/sources",
1046 metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)",
1047 i1 true, ;; Main Compile Unit
1048 i1 false, ;; Optimized compile unit
1049 metadata !"", ;; Compiler flags
1050 i32 0} ;; Runtime version
1051
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1052;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1053;; Define the file for the file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1054;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1055!1 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1056 i32 524329, ;; Tag
1057 metadata !"MySource.cpp",
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1058 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1059 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1060}
1061
1062;;
1063;; Define the file for the file "/Users/mine/sources/Myheader.h"
1064;;
1065!3 = metadata !{
1066 i32 524329, ;; Tag
1067 metadata !"Myheader.h"
1068 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1069 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1070}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1071
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1072...
1073</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1074</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1075
Devang Pateld98ec5f2010-03-26 19:08:36 +0000[diff] [blame]1076<p>llvm::Instruction provides easy access to metadata attached with an
1077instruction. One can extract line number information encoded in LLVM IR
1078using <tt>Instruction::getMetadata()</tt> and
1079<tt>DILocation::getLineNumber()</tt>.
1080<pre>
1081 if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction
1082 DILocation Loc(N); // DILocation is in DebugInfo.h
1083 unsigned Line = Loc.getLineNumber();
1084 StringRef File = Loc.getFilename();
1085 StringRef Dir = Loc.getDirectory();
1086 }
1087</pre>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1088</div>
1089
1090<!-- ======================================================================= -->
1091<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1092 <a name="ccxx_global_variable">C/C++ global variable information</a>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1093</div>
1094
1095<div class="doc_text">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1096
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1097<p>Given an integer global variable declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1098
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1099<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1100<pre>
1101int MyGlobal = 100;
1102</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1103</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1104
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1105<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1106
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1107<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1108<pre>
1109;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1110;; Define the global itself.
1111;;
1112%MyGlobal = global int 100
1113...
1114;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1115;; List of debug info of globals
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1116;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1117!llvm.dbg.gv = !{!0}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1118
1119;;
1120;; Define the global variable descriptor. Note the reference to the global
1121;; variable anchor and the global variable itself.
1122;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1123!0 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1124 i32 524340, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1125 i32 0, ;; Unused
1126 metadata !1, ;; Context
1127 metadata !"MyGlobal", ;; Name
1128 metadata !"MyGlobal", ;; Display Name
1129 metadata !"MyGlobal", ;; Linkage Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1130 metadata !3, ;; Compile Unit
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1131 i32 1, ;; Line Number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1132 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1133 i1 false, ;; Is a local variable
1134 i1 true, ;; Is this a definition
1135 i32* @MyGlobal ;; The global variable
1136}
1137
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1138;;
1139;; Define the basic type of 32 bit signed integer. Note that since int is an
1140;; intrinsic type the source file is NULL and line 0.
1141;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1142!4 = metadata !{
1143 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1144 metadata !1, ;; Context
1145 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1146 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1147 i32 0, ;; Line number
1148 i64 32, ;; Size in Bits
1149 i64 32, ;; Align in Bits
1150 i64 0, ;; Offset in Bits
1151 i32 0, ;; Flags
1152 i32 5 ;; Encoding
1153}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1154
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1155</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1156</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1157
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1158</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1159
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1160<!-- ======================================================================= -->
1161<div class="doc_subsection">
1162 <a name="ccxx_subprogram">C/C++ function information</a>
1163</div>
1164
1165<div class="doc_text">
1166
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1167<p>Given a function declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1168
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1169<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1170<pre>
1171int main(int argc, char *argv[]) {
1172 return 0;
1173}
1174</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1175</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1176
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1177<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1178
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1179<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1180<pre>
1181;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1182;; Define the anchor for subprograms. Note that the second field of the
1183;; anchor is 46, which is the same as the tag for subprograms
1184;; (46 = DW_TAG_subprogram.)
1185;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1186!6 = metadata !{
1187 i32 524334, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1188 i32 0, ;; Unused
1189 metadata !1, ;; Context
1190 metadata !"main", ;; Name
1191 metadata !"main", ;; Display name
1192 metadata !"main", ;; Linkage name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1193 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1194 i32 1, ;; Line number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1195 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1196 i1 false, ;; Is local
1197 i1 true ;; Is definition
1198}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1199;;
1200;; Define the subprogram itself.
1201;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1202define i32 @main(i32 %argc, i8** %argv) {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1203...
1204}
1205</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1206</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1207
1208</div>
1209
1210<!-- ======================================================================= -->
1211<div class="doc_subsection">
1212 <a name="ccxx_basic_types">C/C++ basic types</a>
1213</div>
1214
1215<div class="doc_text">
1216
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1217<p>The following are the basic type descriptors for C/C++ core types:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1218
1219</div>
1220
1221<!-- ======================================================================= -->
1222<div class="doc_subsubsection">
1223 <a name="ccxx_basic_type_bool">bool</a>
1224</div>
1225
1226<div class="doc_text">
1227
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1228<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1229<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1230!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1231 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1232 metadata !1, ;; Context
1233 metadata !"bool", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1234 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1235 i32 0, ;; Line number
1236 i64 8, ;; Size in Bits
1237 i64 8, ;; Align in Bits
1238 i64 0, ;; Offset in Bits
1239 i32 0, ;; Flags
1240 i32 2 ;; Encoding
1241}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1242</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1243</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1244
1245</div>
1246
1247<!-- ======================================================================= -->
1248<div class="doc_subsubsection">
1249 <a name="ccxx_basic_char">char</a>
1250</div>
1251
1252<div class="doc_text">
1253
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1254<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1255<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1256!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1257 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1258 metadata !1, ;; Context
1259 metadata !"char", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1260 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1261 i32 0, ;; Line number
1262 i64 8, ;; Size in Bits
1263 i64 8, ;; Align in Bits
1264 i64 0, ;; Offset in Bits
1265 i32 0, ;; Flags
1266 i32 6 ;; Encoding
1267}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1268</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1269</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1270
1271</div>
1272
1273<!-- ======================================================================= -->
1274<div class="doc_subsubsection">
1275 <a name="ccxx_basic_unsigned_char">unsigned char</a>
1276</div>
1277
1278<div class="doc_text">
1279
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1280<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1281<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1282!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1283 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1284 metadata !1, ;; Context
1285 metadata !"unsigned char",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1286 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1287 i32 0, ;; Line number
1288 i64 8, ;; Size in Bits
1289 i64 8, ;; Align in Bits
1290 i64 0, ;; Offset in Bits
1291 i32 0, ;; Flags
1292 i32 8 ;; Encoding
1293}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1294</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1295</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1296
1297</div>
1298
1299<!-- ======================================================================= -->
1300<div class="doc_subsubsection">
1301 <a name="ccxx_basic_short">short</a>
1302</div>
1303
1304<div class="doc_text">
1305
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1306<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1307<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1308!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1309 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1310 metadata !1, ;; Context
1311 metadata !"short int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1312 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1313 i32 0, ;; Line number
1314 i64 16, ;; Size in Bits
1315 i64 16, ;; Align in Bits
1316 i64 0, ;; Offset in Bits
1317 i32 0, ;; Flags
1318 i32 5 ;; Encoding
1319}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1320</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1321</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1322
1323</div>
1324
1325<!-- ======================================================================= -->
1326<div class="doc_subsubsection">
1327 <a name="ccxx_basic_unsigned_short">unsigned short</a>
1328</div>
1329
1330<div class="doc_text">
1331
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1332<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1333<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1334!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1335 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1336 metadata !1, ;; Context
1337 metadata !"short unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1338 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1339 i32 0, ;; Line number
1340 i64 16, ;; Size in Bits
1341 i64 16, ;; Align in Bits
1342 i64 0, ;; Offset in Bits
1343 i32 0, ;; Flags
1344 i32 7 ;; Encoding
1345}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1346</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1347</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1348
1349</div>
1350
1351<!-- ======================================================================= -->
1352<div class="doc_subsubsection">
1353 <a name="ccxx_basic_int">int</a>
1354</div>
1355
1356<div class="doc_text">
1357
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1358<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1359<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1360!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1361 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1362 metadata !1, ;; Context
1363 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1364 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1365 i32 0, ;; Line number
1366 i64 32, ;; Size in Bits
1367 i64 32, ;; Align in Bits
1368 i64 0, ;; Offset in Bits
1369 i32 0, ;; Flags
1370 i32 5 ;; Encoding
1371}
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1372</pre></div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1373
1374</div>
1375
1376<!-- ======================================================================= -->
1377<div class="doc_subsubsection">
1378 <a name="ccxx_basic_unsigned_int">unsigned int</a>
1379</div>
1380
1381<div class="doc_text">
1382
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1383<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1384<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1385!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1386 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1387 metadata !1, ;; Context
1388 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1389 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1390 i32 0, ;; Line number
1391 i64 32, ;; Size in Bits
1392 i64 32, ;; Align in Bits
1393 i64 0, ;; Offset in Bits
1394 i32 0, ;; Flags
1395 i32 7 ;; Encoding
1396}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1397</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1398</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1399
1400</div>
1401
1402<!-- ======================================================================= -->
1403<div class="doc_subsubsection">
1404 <a name="ccxx_basic_long_long">long long</a>
1405</div>
1406
1407<div class="doc_text">
1408
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1409<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1410<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1411!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1412 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1413 metadata !1, ;; Context
1414 metadata !"long long int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1415 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1416 i32 0, ;; Line number
1417 i64 64, ;; Size in Bits
1418 i64 64, ;; Align in Bits
1419 i64 0, ;; Offset in Bits
1420 i32 0, ;; Flags
1421 i32 5 ;; Encoding
1422}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1423</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1424</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1425
1426</div>
1427
1428<!-- ======================================================================= -->
1429<div class="doc_subsubsection">
1430 <a name="ccxx_basic_unsigned_long_long">unsigned long long</a>
1431</div>
1432
1433<div class="doc_text">
1434
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1435<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1436<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1437!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1438 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1439 metadata !1, ;; Context
1440 metadata !"long long unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1441 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1442 i32 0, ;; Line number
1443 i64 64, ;; Size in Bits
1444 i64 64, ;; Align in Bits
1445 i64 0, ;; Offset in Bits
1446 i32 0, ;; Flags
1447 i32 7 ;; Encoding
1448}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1449</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1450</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1451
1452</div>
1453
1454<!-- ======================================================================= -->
1455<div class="doc_subsubsection">
1456 <a name="ccxx_basic_float">float</a>
1457</div>
1458
1459<div class="doc_text">
1460
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1461<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1462<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1463!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1464 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1465 metadata !1, ;; Context
1466 metadata !"float",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1467 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1468 i32 0, ;; Line number
1469 i64 32, ;; Size in Bits
1470 i64 32, ;; Align in Bits
1471 i64 0, ;; Offset in Bits
1472 i32 0, ;; Flags
1473 i32 4 ;; Encoding
1474}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1475</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1476</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1477
1478</div>
1479
1480<!-- ======================================================================= -->
1481<div class="doc_subsubsection">
1482 <a name="ccxx_basic_double">double</a>
1483</div>
1484
1485<div class="doc_text">
1486
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1487<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1488<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1489!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1490 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1491 metadata !1, ;; Context
1492 metadata !"double",;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1493 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1494 i32 0, ;; Line number
1495 i64 64, ;; Size in Bits
1496 i64 64, ;; Align in Bits
1497 i64 0, ;; Offset in Bits
1498 i32 0, ;; Flags
1499 i32 4 ;; Encoding
1500}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1501</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1502</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1503
1504</div>
1505
1506<!-- ======================================================================= -->
1507<div class="doc_subsection">
1508 <a name="ccxx_derived_types">C/C++ derived types</a>
1509</div>
1510
1511<div class="doc_text">
1512
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1513<p>Given the following as an example of C/C++ derived type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1514
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1515<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1516<pre>
1517typedef const int *IntPtr;
1518</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1519</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1520
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1521<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1522
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1523<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1524<pre>
1525;;
1526;; Define the typedef "IntPtr".
1527;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1528!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1529 i32 524310, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1530 metadata !1, ;; Context
1531 metadata !"IntPtr", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1532 metadata !3, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1533 i32 0, ;; Line number
1534 i64 0, ;; Size in bits
1535 i64 0, ;; Align in bits
1536 i64 0, ;; Offset in bits
1537 i32 0, ;; Flags
1538 metadata !4 ;; Derived From type
1539}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1540
1541;;
1542;; Define the pointer type.
1543;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1544!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1545 i32 524303, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1546 metadata !1, ;; Context
1547 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1548 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1549 i32 0, ;; Line number
1550 i64 64, ;; Size in bits
1551 i64 64, ;; Align in bits
1552 i64 0, ;; Offset in bits
1553 i32 0, ;; Flags
1554 metadata !5 ;; Derived From type
1555}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1556;;
1557;; Define the const type.
1558;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1559!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1560 i32 524326, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1561 metadata !1, ;; Context
1562 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1563 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1564 i32 0, ;; Line number
1565 i64 32, ;; Size in bits
1566 i64 32, ;; Align in bits
1567 i64 0, ;; Offset in bits
1568 i32 0, ;; Flags
1569 metadata !6 ;; Derived From type
1570}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1571;;
1572;; Define the int type.
1573;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1574!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1575 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1576 metadata !1, ;; Context
1577 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1578 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1579 i32 0, ;; Line number
1580 i64 32, ;; Size in bits
1581 i64 32, ;; Align in bits
1582 i64 0, ;; Offset in bits
1583 i32 0, ;; Flags
1584 5 ;; Encoding
1585}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1586</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1587</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1588
1589</div>
1590
1591<!-- ======================================================================= -->
1592<div class="doc_subsection">
1593 <a name="ccxx_composite_types">C/C++ struct/union types</a>
1594</div>
1595
1596<div class="doc_text">
1597
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1598<p>Given the following as an example of C/C++ struct type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1599
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1600<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1601<pre>
1602struct Color {
1603 unsigned Red;
1604 unsigned Green;
1605 unsigned Blue;
1606};
1607</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1608</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1609
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1610<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1611
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1612<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1613<pre>
1614;;
1615;; Define basic type for unsigned int.
1616;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1617!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1618 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1619 metadata !1, ;; Context
1620 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1621 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1622 i32 0, ;; Line number
1623 i64 32, ;; Size in Bits
1624 i64 32, ;; Align in Bits
1625 i64 0, ;; Offset in Bits
1626 i32 0, ;; Flags
1627 i32 7 ;; Encoding
1628}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1629;;
1630;; Define composite type for struct Color.
1631;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1632!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1633 i32 524307, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1634 metadata !1, ;; Context
1635 metadata !"Color", ;; Name
1636 metadata !1, ;; Compile unit
1637 i32 1, ;; Line number
1638 i64 96, ;; Size in bits
1639 i64 32, ;; Align in bits
1640 i64 0, ;; Offset in bits
1641 i32 0, ;; Flags
1642 null, ;; Derived From
1643 metadata !3, ;; Elements
1644 i32 0 ;; Runtime Language
1645}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1646
1647;;
1648;; Define the Red field.
1649;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1650!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1651 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1652 metadata !1, ;; Context
1653 metadata !"Red", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1654 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1655 i32 2, ;; Line number
1656 i64 32, ;; Size in bits
1657 i64 32, ;; Align in bits
1658 i64 0, ;; Offset in bits
1659 i32 0, ;; Flags
1660 metadata !5 ;; Derived From type
1661}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1662
1663;;
1664;; Define the Green field.
1665;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1666!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1667 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1668 metadata !1, ;; Context
1669 metadata !"Green", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1670 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1671 i32 3, ;; Line number
1672 i64 32, ;; Size in bits
1673 i64 32, ;; Align in bits
1674 i64 32, ;; Offset in bits
1675 i32 0, ;; Flags
1676 metadata !5 ;; Derived From type
1677}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1678
1679;;
1680;; Define the Blue field.
1681;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1682!7 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1683 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1684 metadata !1, ;; Context
1685 metadata !"Blue", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1686 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1687 i32 4, ;; Line number
1688 i64 32, ;; Size in bits
1689 i64 32, ;; Align in bits
1690 i64 64, ;; Offset in bits
1691 i32 0, ;; Flags
1692 metadata !5 ;; Derived From type
1693}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1694
1695;;
1696;; Define the array of fields used by the composite type Color.
1697;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1698!3 = metadata !{metadata !4, metadata !6, metadata !7}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1699</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1700</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1701
1702</div>
1703
1704<!-- ======================================================================= -->
1705<div class="doc_subsection">
1706 <a name="ccxx_enumeration_types">C/C++ enumeration types</a>
1707</div>
1708
1709<div class="doc_text">
1710
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1711<p>Given the following as an example of C/C++ enumeration type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1712
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1713<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1714<pre>
1715enum Trees {
1716 Spruce = 100,
1717 Oak = 200,
1718 Maple = 300
1719};
1720</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1721</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1722
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1723<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1724
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1725<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1726<pre>
1727;;
1728;; Define composite type for enum Trees
1729;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1730!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1731 i32 524292, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1732 metadata !1, ;; Context
1733 metadata !"Trees", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1734 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1735 i32 1, ;; Line number
1736 i64 32, ;; Size in bits
1737 i64 32, ;; Align in bits
1738 i64 0, ;; Offset in bits
1739 i32 0, ;; Flags
1740 null, ;; Derived From type
1741 metadata !3, ;; Elements
1742 i32 0 ;; Runtime language
1743}
Devang Patel2a610c72009-08-25 05:24:07 +0000[diff] [blame]1744
Devang Patel82459882009-08-26 05:01:18 +0000[diff] [blame]1745;;
1746;; Define the array of enumerators used by composite type Trees.
1747;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1748!3 = metadata !{metadata !4, metadata !5, metadata !6}
1749
1750;;
1751;; Define Spruce enumerator.
1752;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1753!4 = metadata !{i32 524328, metadata !"Spruce", i64 100}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1754
1755;;
1756;; Define Oak enumerator.
1757;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1758!5 = metadata !{i32 524328, metadata !"Oak", i64 200}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1759
1760;;
1761;; Define Maple enumerator.
1762;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1763!6 = metadata !{i32 524328, metadata !"Maple", i64 300}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1764
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1765</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1766</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1767
1768</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1769
1770<!-- *********************************************************************** -->
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1771
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1772<hr>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1773<address>
1774 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1775 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1776 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1777 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]1778
1779 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1780 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1781 Last modified: $Date$
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1782</address>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1783
1784</body>
1785</html>