Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 3f782f4d7586a4e644850ad4d05ef6a027aabc04 / . / docs / SourceLevelDebugging.html
blob: f1e1cd0285d88d2d11cf6cdd2529aa5772656b79 [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 Patela83688f2011-03-08 16:29:40 +0000[diff] [blame]747 i32, ;; 24 bit - Line number where defined
748 ;; 8 bit - Argument number. 1 indicates 1st argument.
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]749 metadata ;; Type descriptor
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]750}
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]751</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]752</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]753
754<p>These descriptors are used to define variables local to a sub program. The
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]755 value of the tag depends on the usage of the variable:</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]756
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]757<div class="doc_code">
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]758<pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]759DW_TAG_auto_variable = 256
760DW_TAG_arg_variable = 257
761DW_TAG_return_variable = 258
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]762</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]763</div>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]764
765<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]766 argument variable is any variable that appears as a formal argument to the
767 function. A return variable is used to track the result of a function and
768 has no source correspondent.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]769
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]770<p>The context is either the subprogram or block where the variable is defined.
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]771 Name the source variable name. Compile unit and line indicate where the
772 variable was defined. Type descriptor defines the declared type of the
773 variable.</p>
Jim Laskey383e0092006-03-23 17:54:33 +0000[diff] [blame]774
775</div>
776
777<!-- ======================================================================= -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]778<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]779 <a name="format_common_intrinsics">Debugger intrinsic functions</a>
780</div>
781
782<div class="doc_text">
783
784<p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]785 provide debug information at various points in generated code.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]786
787</div>
788
789<!-- ======================================================================= -->
790<div class="doc_subsubsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]791 <a name="format_common_declare">llvm.dbg.declare</a>
792</div>
793
794<div class="doc_text">
795<pre>
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]796 void %<a href="#format_common_declare">llvm.dbg.declare</a>(metadata, metadata)
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]797</pre>
798
Jim Laskey2d395d92006-03-24 09:20:27 +0000[diff] [blame]799<p>This intrinsic provides information about a local element (ex. variable.) The
Devang Patel4c7c0c62010-10-01 19:22:16 +0000[diff] [blame]800 first argument is metadata holding alloca for the variable.</tt>. The
Devang Patele136e502011-02-01 17:22:12 +0000[diff] [blame]801 second argument is metadata containing description of the variable. </p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]802</div>
803
804<!-- ======================================================================= -->
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]805<div class="doc_subsubsection">
806 <a name="format_common_value">llvm.dbg.value</a>
807</div>
808
809<div class="doc_text">
810<pre>
Dan Gohman3dfb3cf2010-05-28 17:07:41 +0000[diff] [blame]811 void %<a href="#format_common_value">llvm.dbg.value</a>(metadata, i64, metadata)
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]812</pre>
813
814<p>This intrinsic provides information when a user source variable is set to a
815 new value. The first argument is the new value (wrapped as metadata). The
816 second argument is the offset in the user source variable where the new value
Devang Patele136e502011-02-01 17:22:12 +0000[diff] [blame]817 is written. The third argument is metadata containing description of the
818 user source variable. </p>
Victor Hernandez67a1a542010-01-11 22:53:48 +0000[diff] [blame]819</div>
820
821<!-- ======================================================================= -->
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]822<div class="doc_subsection">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]823 <a name="format_common_lifetime">Object lifetimes and scoping</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]824</div>
825
826<div class="doc_text">
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]827<p>In many languages, the local variables in functions can have their lifetimes
828 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]829 for example, variables are only live (readable and writable) within the
830 source block that they are defined in. In functional languages, values are
831 only readable after they have been defined. Though this is a very obvious
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]832 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]833 scoping in this sense, and does not want to be tied to a language's scoping
834 rules.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]835
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]836<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]837 llvm instructions to encode line number and scoping information. Consider
838 the following C fragment, for example:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]839
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]840<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]841<pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8421. void foo() {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8432. int X = 21;
8443. int Y = 22;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8454. {
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8465. int Z = 23;
8476. Z = X;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8487. }
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]8498. X = Y;
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]8509. }
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]851</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]852</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]853
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]854<p>Compiled to LLVM, this function would be represented like this:</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]855
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]856<div class="doc_code">
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]857<pre>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]858define void @foo() nounwind ssp {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]859entry:
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]860 %X = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
861 %Y = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
862 %Z = alloca i32, align 4 ; &lt;i32*&gt; [#uses=3]
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]863 %0 = bitcast i32* %X to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]864 call void @llvm.dbg.declare(metadata !{i32 * %X}, metadata !0), !dbg !7
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]865 store i32 21, i32* %X, !dbg !8
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]866 %1 = bitcast i32* %Y to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]867 call void @llvm.dbg.declare(metadata !{i32 * %Y}, metadata !9), !dbg !10
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]868 store i32 22, i32* %Y, !dbg !11
Dan Gohmanfe47aae2010-05-28 17:13:49 +0000[diff] [blame]869 %2 = bitcast i32* %Z to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]870 call void @llvm.dbg.declare(metadata !{i32 * %Z}, metadata !12), !dbg !14
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]871 store i32 23, i32* %Z, !dbg !15
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]872 %tmp = load i32* %X, !dbg !16 ; &lt;i32&gt; [#uses=1]
873 %tmp1 = load i32* %Y, !dbg !16 ; &lt;i32&gt; [#uses=1]
874 %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]875 store i32 %add, i32* %Z, !dbg !16
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]876 %tmp2 = load i32* %Y, !dbg !17 ; &lt;i32&gt; [#uses=1]
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]877 store i32 %tmp2, i32* %X, !dbg !17
878 ret void, !dbg !18
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]879}
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]880
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]881declare void @llvm.dbg.declare(metadata, metadata) nounwind readnone
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]882
883!0 = metadata !{i32 459008, metadata !1, metadata !"X",
884 metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ]
885!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
886!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", metadata !"foo",
887 metadata !"foo", metadata !3, i32 1, metadata !4,
888 i1 false, i1 true}; [DW_TAG_subprogram ]
889!3 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c",
890 metadata !"/private/tmp", metadata !"clang 1.1", i1 true,
891 i1 false, metadata !"", i32 0}; [DW_TAG_compile_unit ]
892!4 = metadata !{i32 458773, metadata !3, metadata !"", null, i32 0, i64 0, i64 0,
893 i64 0, i32 0, null, metadata !5, i32 0}; [DW_TAG_subroutine_type ]
894!5 = metadata !{null}
895!6 = metadata !{i32 458788, metadata !3, metadata !"int", metadata !3, i32 0,
896 i64 32, i64 32, i64 0, i32 0, i32 5}; [DW_TAG_base_type ]
897!7 = metadata !{i32 2, i32 7, metadata !1, null}
898!8 = metadata !{i32 2, i32 3, metadata !1, null}
899!9 = metadata !{i32 459008, metadata !1, metadata !"Y", metadata !3, i32 3,
900 metadata !6}; [ DW_TAG_auto_variable ]
901!10 = metadata !{i32 3, i32 7, metadata !1, null}
902!11 = metadata !{i32 3, i32 3, metadata !1, null}
903!12 = metadata !{i32 459008, metadata !13, metadata !"Z", metadata !3, i32 5,
904 metadata !6}; [ DW_TAG_auto_variable ]
905!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
906!14 = metadata !{i32 5, i32 9, metadata !13, null}
907!15 = metadata !{i32 5, i32 5, metadata !13, null}
908!16 = metadata !{i32 6, i32 5, metadata !13, null}
909!17 = metadata !{i32 8, i32 3, metadata !1, null}
910!18 = metadata !{i32 9, i32 1, metadata !2, null}
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]911</pre>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]912</div>
913
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]914<p>This example illustrates a few important details about LLVM debugging
915 information. In particular, it shows how the <tt>llvm.dbg.declare</tt>
916 intrinsic and location information, which are attached to an instruction,
917 are applied together to allow a debugger to analyze the relationship between
918 statements, variable definitions, and the code used to implement the
919 function.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]920
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]921<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]922<pre>
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]923call void @llvm.dbg.declare(metadata, metadata !0), !dbg !7
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]924</pre>
925</div>
926
927<p>The first intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]928 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]929 encodes debugging information for the variable <tt>X</tt>. The metadata
930 <tt>!dbg !7</tt> attached to the intrinsic provides scope information for the
931 variable <tt>X</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]932
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]933<div class="doc_code">
934<pre>
935!7 = metadata !{i32 2, i32 7, metadata !1, null}
936!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
937!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo",
938 metadata !"foo", metadata !"foo", metadata !3, i32 1,
939 metadata !4, i1 false, i1 true}; [DW_TAG_subprogram ]
940</pre>
941</div>
942
943<p>Here <tt>!7</tt> is metadata providing location information. It has four
944 fields: line number, column number, scope, and original scope. The original
945 scope represents inline location if this instruction is inlined inside a
946 caller, and is null otherwise. In this example, scope is encoded by
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]947 <tt>!1</tt>. <tt>!1</tt> represents a lexical block inside the scope
948 <tt>!2</tt>, where <tt>!2</tt> is a
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]949 <a href="#format_subprograms">subprogram descriptor</a>. This way the
950 location information attached to the intrinsics indicates that the
951 variable <tt>X</tt> is declared at line number 2 at a function level scope in
952 function <tt>foo</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]953
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]954<p>Now lets take another example.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]955
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]956<div class="doc_code">
Bill Wendling02216ff2009-12-01 00:59:58 +0000[diff] [blame]957<pre>
Devang Patel37280782011-02-03 00:22:17 +0000[diff] [blame]958call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]959</pre>
960</div>
961
962<p>The second intrinsic
Devang Patel744950d2009-11-25 23:28:01 +0000[diff] [blame]963 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]964 encodes debugging information for variable <tt>Z</tt>. The metadata
965 <tt>!dbg !14</tt> attached to the intrinsic provides scope information for
966 the variable <tt>Z</tt>.</p>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]967
Bill Wendlingcf493b82009-12-01 00:53:11 +0000[diff] [blame]968<div class="doc_code">
969<pre>
970!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
971!14 = metadata !{i32 5, i32 9, metadata !13, null}
972</pre>
973</div>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]974
John Criswellb34500f2010-03-17 15:01:50 +0000[diff] [blame]975<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]976 column number 9 inside of lexical scope <tt>!13</tt>. The lexical scope
977 itself resides inside of lexical scope <tt>!1</tt> described above.</p>
978
979<p>The scope information attached with each instruction provides a
980 straightforward way to find instructions covered by a scope.</p>
981
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]982</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]983
984<!-- *********************************************************************** -->
985<div class="doc_section">
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]986 <a name="ccxx_frontend">C/C++ front-end specific debug information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]987</div>
Misha Brukman94218a72004-12-09 20:27:37 +0000[diff] [blame]988<!-- *********************************************************************** -->
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]989
990<div class="doc_text">
991
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]992<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]993 that is effectively identical
994 to <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3.0</a> in
995 terms of information content. This allows code generators to trivially
996 support native debuggers by generating standard dwarf information, and
997 contains enough information for non-dwarf targets to translate it as
998 needed.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]999
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1000<p>This section describes the forms used to represent C and C++ programs. Other
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1001 languages could pattern themselves after this (which itself is tuned to
1002 representing programs in the same way that DWARF 3 does), or they could
1003 choose to provide completely different forms if they don't fit into the DWARF
1004 model. As support for debugging information gets added to the various LLVM
1005 source-language front-ends, the information used should be documented
1006 here.</p>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1007
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1008<p>The following sections provide examples of various C/C++ constructs and the
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1009 debug information that would best describe those constructs.</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1010
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1011</div>
1012
1013<!-- ======================================================================= -->
1014<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1015 <a name="ccxx_compile_units">C/C++ source file information</a>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1016</div>
1017
1018<div class="doc_text">
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1019
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1020<p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located
1021 in the directory <tt>/Users/mine/sources</tt>, the following code:</p>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1022
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1023<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1024<pre>
1025#include "MyHeader.h"
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1026
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1027int main(int argc, char *argv[]) {
1028 return 0;
1029}
1030</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1031</div>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1032
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1033<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1034
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1035<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1036<pre>
1037...
1038;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1039;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1040;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1041!2 = metadata !{
1042 i32 524305, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1043 i32 0, ;; Unused
1044 i32 4, ;; Language Id
1045 metadata !"MySource.cpp",
1046 metadata !"/Users/mine/sources",
1047 metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)",
1048 i1 true, ;; Main Compile Unit
1049 i1 false, ;; Optimized compile unit
1050 metadata !"", ;; Compiler flags
1051 i32 0} ;; Runtime version
1052
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1053;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1054;; Define the file for the file "/Users/mine/sources/MySource.cpp".
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1055;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1056!1 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1057 i32 524329, ;; Tag
1058 metadata !"MySource.cpp",
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1059 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1060 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1061}
1062
1063;;
1064;; Define the file for the file "/Users/mine/sources/Myheader.h"
1065;;
1066!3 = metadata !{
1067 i32 524329, ;; Tag
1068 metadata !"Myheader.h"
1069 metadata !"/Users/mine/sources",
Devang Patel9fea9c22010-07-13 16:53:20 +0000[diff] [blame]1070 metadata !2 ;; Compile unit
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1071}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1072
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1073...
1074</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1075</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1076
Devang Pateld98ec5f2010-03-26 19:08:36 +0000[diff] [blame]1077<p>llvm::Instruction provides easy access to metadata attached with an
1078instruction. One can extract line number information encoded in LLVM IR
1079using <tt>Instruction::getMetadata()</tt> and
1080<tt>DILocation::getLineNumber()</tt>.
1081<pre>
1082 if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction
1083 DILocation Loc(N); // DILocation is in DebugInfo.h
1084 unsigned Line = Loc.getLineNumber();
1085 StringRef File = Loc.getFilename();
1086 StringRef Dir = Loc.getDirectory();
1087 }
1088</pre>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1089</div>
1090
1091<!-- ======================================================================= -->
1092<div class="doc_subsection">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1093 <a name="ccxx_global_variable">C/C++ global variable information</a>
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1094</div>
1095
1096<div class="doc_text">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1097
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1098<p>Given an integer global variable declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1099
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1100<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1101<pre>
1102int MyGlobal = 100;
1103</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1104</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1105
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1106<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1107
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1108<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1109<pre>
1110;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1111;; Define the global itself.
1112;;
1113%MyGlobal = global int 100
1114...
1115;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1116;; List of debug info of globals
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1117;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1118!llvm.dbg.gv = !{!0}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1119
1120;;
1121;; Define the global variable descriptor. Note the reference to the global
1122;; variable anchor and the global variable itself.
1123;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1124!0 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1125 i32 524340, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1126 i32 0, ;; Unused
1127 metadata !1, ;; Context
1128 metadata !"MyGlobal", ;; Name
1129 metadata !"MyGlobal", ;; Display Name
1130 metadata !"MyGlobal", ;; Linkage Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1131 metadata !3, ;; Compile Unit
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1132 i32 1, ;; Line Number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1133 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1134 i1 false, ;; Is a local variable
1135 i1 true, ;; Is this a definition
1136 i32* @MyGlobal ;; The global variable
1137}
1138
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1139;;
1140;; Define the basic type of 32 bit signed integer. Note that since int is an
1141;; intrinsic type the source file is NULL and line 0.
1142;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1143!4 = metadata !{
1144 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1145 metadata !1, ;; Context
1146 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1147 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1148 i32 0, ;; Line number
1149 i64 32, ;; Size in Bits
1150 i64 32, ;; Align in Bits
1151 i64 0, ;; Offset in Bits
1152 i32 0, ;; Flags
1153 i32 5 ;; Encoding
1154}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1155
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1156</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1157</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1158
Chris Lattner8ff75902004-01-06 05:31:32 +0000[diff] [blame]1159</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1160
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1161<!-- ======================================================================= -->
1162<div class="doc_subsection">
1163 <a name="ccxx_subprogram">C/C++ function information</a>
1164</div>
1165
1166<div class="doc_text">
1167
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1168<p>Given a function declared as follows:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1169
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1170<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1171<pre>
1172int main(int argc, char *argv[]) {
1173 return 0;
1174}
1175</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1176</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1177
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1178<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1179
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1180<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1181<pre>
1182;;
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1183;; Define the anchor for subprograms. Note that the second field of the
1184;; anchor is 46, which is the same as the tag for subprograms
1185;; (46 = DW_TAG_subprogram.)
1186;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1187!6 = metadata !{
1188 i32 524334, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1189 i32 0, ;; Unused
1190 metadata !1, ;; Context
1191 metadata !"main", ;; Name
1192 metadata !"main", ;; Display name
1193 metadata !"main", ;; Linkage name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1194 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1195 i32 1, ;; Line number
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1196 metadata !4, ;; Type
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1197 i1 false, ;; Is local
1198 i1 true ;; Is definition
1199}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1200;;
1201;; Define the subprogram itself.
1202;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1203define i32 @main(i32 %argc, i8** %argv) {
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1204...
1205}
1206</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1207</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1208
1209</div>
1210
1211<!-- ======================================================================= -->
1212<div class="doc_subsection">
1213 <a name="ccxx_basic_types">C/C++ basic types</a>
1214</div>
1215
1216<div class="doc_text">
1217
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1218<p>The following are the basic type descriptors for C/C++ core types:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1219
1220</div>
1221
1222<!-- ======================================================================= -->
1223<div class="doc_subsubsection">
1224 <a name="ccxx_basic_type_bool">bool</a>
1225</div>
1226
1227<div class="doc_text">
1228
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1229<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1230<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1231!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1232 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1233 metadata !1, ;; Context
1234 metadata !"bool", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1235 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1236 i32 0, ;; Line number
1237 i64 8, ;; Size in Bits
1238 i64 8, ;; Align in Bits
1239 i64 0, ;; Offset in Bits
1240 i32 0, ;; Flags
1241 i32 2 ;; Encoding
1242}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1243</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1244</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1245
1246</div>
1247
1248<!-- ======================================================================= -->
1249<div class="doc_subsubsection">
1250 <a name="ccxx_basic_char">char</a>
1251</div>
1252
1253<div class="doc_text">
1254
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1255<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1256<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1257!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1258 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1259 metadata !1, ;; Context
1260 metadata !"char", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1261 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1262 i32 0, ;; Line number
1263 i64 8, ;; Size in Bits
1264 i64 8, ;; Align in Bits
1265 i64 0, ;; Offset in Bits
1266 i32 0, ;; Flags
1267 i32 6 ;; Encoding
1268}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1269</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1270</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1271
1272</div>
1273
1274<!-- ======================================================================= -->
1275<div class="doc_subsubsection">
1276 <a name="ccxx_basic_unsigned_char">unsigned char</a>
1277</div>
1278
1279<div class="doc_text">
1280
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1281<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1282<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1283!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1284 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1285 metadata !1, ;; Context
1286 metadata !"unsigned char",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1287 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1288 i32 0, ;; Line number
1289 i64 8, ;; Size in Bits
1290 i64 8, ;; Align in Bits
1291 i64 0, ;; Offset in Bits
1292 i32 0, ;; Flags
1293 i32 8 ;; Encoding
1294}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1295</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1296</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1297
1298</div>
1299
1300<!-- ======================================================================= -->
1301<div class="doc_subsubsection">
1302 <a name="ccxx_basic_short">short</a>
1303</div>
1304
1305<div class="doc_text">
1306
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1307<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1308<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1309!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1310 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1311 metadata !1, ;; Context
1312 metadata !"short int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1313 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1314 i32 0, ;; Line number
1315 i64 16, ;; Size in Bits
1316 i64 16, ;; Align in Bits
1317 i64 0, ;; Offset in Bits
1318 i32 0, ;; Flags
1319 i32 5 ;; Encoding
1320}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1321</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1322</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1323
1324</div>
1325
1326<!-- ======================================================================= -->
1327<div class="doc_subsubsection">
1328 <a name="ccxx_basic_unsigned_short">unsigned short</a>
1329</div>
1330
1331<div class="doc_text">
1332
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1333<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1334<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1335!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1336 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1337 metadata !1, ;; Context
1338 metadata !"short unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1339 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1340 i32 0, ;; Line number
1341 i64 16, ;; Size in Bits
1342 i64 16, ;; Align in Bits
1343 i64 0, ;; Offset in Bits
1344 i32 0, ;; Flags
1345 i32 7 ;; Encoding
1346}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1347</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1348</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1349
1350</div>
1351
1352<!-- ======================================================================= -->
1353<div class="doc_subsubsection">
1354 <a name="ccxx_basic_int">int</a>
1355</div>
1356
1357<div class="doc_text">
1358
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1359<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1360<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1361!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1362 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1363 metadata !1, ;; Context
1364 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1365 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1366 i32 0, ;; Line number
1367 i64 32, ;; Size in Bits
1368 i64 32, ;; Align in Bits
1369 i64 0, ;; Offset in Bits
1370 i32 0, ;; Flags
1371 i32 5 ;; Encoding
1372}
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1373</pre></div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1374
1375</div>
1376
1377<!-- ======================================================================= -->
1378<div class="doc_subsubsection">
1379 <a name="ccxx_basic_unsigned_int">unsigned int</a>
1380</div>
1381
1382<div class="doc_text">
1383
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1384<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1385<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1386!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1387 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1388 metadata !1, ;; Context
1389 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1390 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1391 i32 0, ;; Line number
1392 i64 32, ;; Size in Bits
1393 i64 32, ;; Align in Bits
1394 i64 0, ;; Offset in Bits
1395 i32 0, ;; Flags
1396 i32 7 ;; Encoding
1397}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1398</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1399</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1400
1401</div>
1402
1403<!-- ======================================================================= -->
1404<div class="doc_subsubsection">
1405 <a name="ccxx_basic_long_long">long long</a>
1406</div>
1407
1408<div class="doc_text">
1409
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1410<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1411<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1412!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1413 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1414 metadata !1, ;; Context
1415 metadata !"long long int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1416 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1417 i32 0, ;; Line number
1418 i64 64, ;; Size in Bits
1419 i64 64, ;; Align in Bits
1420 i64 0, ;; Offset in Bits
1421 i32 0, ;; Flags
1422 i32 5 ;; Encoding
1423}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1424</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1425</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1426
1427</div>
1428
1429<!-- ======================================================================= -->
1430<div class="doc_subsubsection">
1431 <a name="ccxx_basic_unsigned_long_long">unsigned long long</a>
1432</div>
1433
1434<div class="doc_text">
1435
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1436<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1437<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1438!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1439 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1440 metadata !1, ;; Context
1441 metadata !"long long unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1442 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1443 i32 0, ;; Line number
1444 i64 64, ;; Size in Bits
1445 i64 64, ;; Align in Bits
1446 i64 0, ;; Offset in Bits
1447 i32 0, ;; Flags
1448 i32 7 ;; Encoding
1449}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1450</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1451</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1452
1453</div>
1454
1455<!-- ======================================================================= -->
1456<div class="doc_subsubsection">
1457 <a name="ccxx_basic_float">float</a>
1458</div>
1459
1460<div class="doc_text">
1461
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1462<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1463<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1464!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1465 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1466 metadata !1, ;; Context
1467 metadata !"float",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1468 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1469 i32 0, ;; Line number
1470 i64 32, ;; Size in Bits
1471 i64 32, ;; Align in Bits
1472 i64 0, ;; Offset in Bits
1473 i32 0, ;; Flags
1474 i32 4 ;; Encoding
1475}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1476</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1477</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1478
1479</div>
1480
1481<!-- ======================================================================= -->
1482<div class="doc_subsubsection">
1483 <a name="ccxx_basic_double">double</a>
1484</div>
1485
1486<div class="doc_text">
1487
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1488<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1489<pre>
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1490!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1491 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1492 metadata !1, ;; Context
1493 metadata !"double",;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1494 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1495 i32 0, ;; Line number
1496 i64 64, ;; Size in Bits
1497 i64 64, ;; Align in Bits
1498 i64 0, ;; Offset in Bits
1499 i32 0, ;; Flags
1500 i32 4 ;; Encoding
1501}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1502</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1503</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1504
1505</div>
1506
1507<!-- ======================================================================= -->
1508<div class="doc_subsection">
1509 <a name="ccxx_derived_types">C/C++ derived types</a>
1510</div>
1511
1512<div class="doc_text">
1513
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1514<p>Given the following as an example of C/C++ derived type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1515
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1516<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1517<pre>
1518typedef const int *IntPtr;
1519</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1520</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1521
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1522<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1523
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1524<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1525<pre>
1526;;
1527;; Define the typedef "IntPtr".
1528;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1529!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1530 i32 524310, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1531 metadata !1, ;; Context
1532 metadata !"IntPtr", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1533 metadata !3, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1534 i32 0, ;; Line number
1535 i64 0, ;; Size in bits
1536 i64 0, ;; Align in bits
1537 i64 0, ;; Offset in bits
1538 i32 0, ;; Flags
1539 metadata !4 ;; Derived From type
1540}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1541
1542;;
1543;; Define the pointer type.
1544;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1545!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1546 i32 524303, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1547 metadata !1, ;; Context
1548 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1549 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1550 i32 0, ;; Line number
1551 i64 64, ;; Size in bits
1552 i64 64, ;; Align in bits
1553 i64 0, ;; Offset in bits
1554 i32 0, ;; Flags
1555 metadata !5 ;; Derived From type
1556}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1557;;
1558;; Define the const type.
1559;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1560!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1561 i32 524326, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1562 metadata !1, ;; Context
1563 metadata !"", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1564 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1565 i32 0, ;; Line number
1566 i64 32, ;; Size in bits
1567 i64 32, ;; Align in bits
1568 i64 0, ;; Offset in bits
1569 i32 0, ;; Flags
1570 metadata !6 ;; Derived From type
1571}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1572;;
1573;; Define the int type.
1574;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1575!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1576 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1577 metadata !1, ;; Context
1578 metadata !"int", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1579 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1580 i32 0, ;; Line number
1581 i64 32, ;; Size in bits
1582 i64 32, ;; Align in bits
1583 i64 0, ;; Offset in bits
1584 i32 0, ;; Flags
1585 5 ;; Encoding
1586}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1587</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1588</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1589
1590</div>
1591
1592<!-- ======================================================================= -->
1593<div class="doc_subsection">
1594 <a name="ccxx_composite_types">C/C++ struct/union types</a>
1595</div>
1596
1597<div class="doc_text">
1598
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1599<p>Given the following as an example of C/C++ struct type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1600
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1601<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1602<pre>
1603struct Color {
1604 unsigned Red;
1605 unsigned Green;
1606 unsigned Blue;
1607};
1608</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1609</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1610
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1611<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1612
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1613<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1614<pre>
1615;;
1616;; Define basic type for unsigned int.
1617;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1618!5 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1619 i32 524324, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1620 metadata !1, ;; Context
1621 metadata !"unsigned int",
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1622 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1623 i32 0, ;; Line number
1624 i64 32, ;; Size in Bits
1625 i64 32, ;; Align in Bits
1626 i64 0, ;; Offset in Bits
1627 i32 0, ;; Flags
1628 i32 7 ;; Encoding
1629}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1630;;
1631;; Define composite type for struct Color.
1632;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1633!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1634 i32 524307, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1635 metadata !1, ;; Context
1636 metadata !"Color", ;; Name
1637 metadata !1, ;; Compile unit
1638 i32 1, ;; Line number
1639 i64 96, ;; Size in bits
1640 i64 32, ;; Align in bits
1641 i64 0, ;; Offset in bits
1642 i32 0, ;; Flags
1643 null, ;; Derived From
1644 metadata !3, ;; Elements
1645 i32 0 ;; Runtime Language
1646}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1647
1648;;
1649;; Define the Red field.
1650;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1651!4 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1652 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1653 metadata !1, ;; Context
1654 metadata !"Red", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1655 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1656 i32 2, ;; Line number
1657 i64 32, ;; Size in bits
1658 i64 32, ;; Align in bits
1659 i64 0, ;; Offset in bits
1660 i32 0, ;; Flags
1661 metadata !5 ;; Derived From type
1662}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1663
1664;;
1665;; Define the Green field.
1666;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1667!6 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1668 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1669 metadata !1, ;; Context
1670 metadata !"Green", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1671 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1672 i32 3, ;; Line number
1673 i64 32, ;; Size in bits
1674 i64 32, ;; Align in bits
1675 i64 32, ;; Offset in bits
1676 i32 0, ;; Flags
1677 metadata !5 ;; Derived From type
1678}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1679
1680;;
1681;; Define the Blue field.
1682;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1683!7 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1684 i32 524301, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1685 metadata !1, ;; Context
1686 metadata !"Blue", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1687 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1688 i32 4, ;; Line number
1689 i64 32, ;; Size in bits
1690 i64 32, ;; Align in bits
1691 i64 64, ;; Offset in bits
1692 i32 0, ;; Flags
1693 metadata !5 ;; Derived From type
1694}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1695
1696;;
1697;; Define the array of fields used by the composite type Color.
1698;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1699!3 = metadata !{metadata !4, metadata !6, metadata !7}
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1700</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1701</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1702
1703</div>
1704
1705<!-- ======================================================================= -->
1706<div class="doc_subsection">
1707 <a name="ccxx_enumeration_types">C/C++ enumeration types</a>
1708</div>
1709
1710<div class="doc_text">
1711
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1712<p>Given the following as an example of C/C++ enumeration type:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1713
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1714<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1715<pre>
1716enum Trees {
1717 Spruce = 100,
1718 Oak = 200,
1719 Maple = 300
1720};
1721</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1722</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1723
Misha Brukman96e00812008-12-16 02:54:22 +0000[diff] [blame]1724<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1725
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1726<div class="doc_code">
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1727<pre>
1728;;
1729;; Define composite type for enum Trees
1730;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1731!2 = metadata !{
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1732 i32 524292, ;; Tag
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1733 metadata !1, ;; Context
1734 metadata !"Trees", ;; Name
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1735 metadata !1, ;; File
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1736 i32 1, ;; Line number
1737 i64 32, ;; Size in bits
1738 i64 32, ;; Align in bits
1739 i64 0, ;; Offset in bits
1740 i32 0, ;; Flags
1741 null, ;; Derived From type
1742 metadata !3, ;; Elements
1743 i32 0 ;; Runtime language
1744}
Devang Patel2a610c72009-08-25 05:24:07 +0000[diff] [blame]1745
Devang Patel82459882009-08-26 05:01:18 +0000[diff] [blame]1746;;
1747;; Define the array of enumerators used by composite type Trees.
1748;;
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1749!3 = metadata !{metadata !4, metadata !5, metadata !6}
1750
1751;;
1752;; Define Spruce enumerator.
1753;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1754!4 = metadata !{i32 524328, metadata !"Spruce", i64 100}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1755
1756;;
1757;; Define Oak enumerator.
1758;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1759!5 = metadata !{i32 524328, metadata !"Oak", i64 200}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1760
1761;;
1762;; Define Maple enumerator.
1763;;
Devang Patel4b945502010-03-09 00:44:10 +0000[diff] [blame]1764!6 = metadata !{i32 524328, metadata !"Maple", i64 300}
Devang Patele4b27562009-08-28 23:24:31 +0000[diff] [blame]1765
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1766</pre>
Bill Wendling48839d92009-05-17 05:52:39 +0000[diff] [blame]1767</div>
Jim Laskeycec12a52006-03-14 18:08:46 +0000[diff] [blame]1768
1769</div>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1770
1771<!-- *********************************************************************** -->
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1772
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1773<hr>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1774<address>
1775 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1776 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1777 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman44408702008-12-11 17:34:48 +0000[diff] [blame]1778 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]1779
1780 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
Reid Spencer05fe4b02006-03-14 05:39:39 +0000[diff] [blame]1781 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1782 Last modified: $Date$
Misha Brukman82873732004-05-12 19:21:57 +0000[diff] [blame]1783</address>
Chris Lattnerbdfb3392004-01-05 05:06:33 +0000[diff] [blame]1784
1785</body>
1786</html>