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