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