blob: 1bf63959817d3c53b68cd5933a5a4ed3200126ed [file] [log] [blame]
Chris Lattner1811fca2004-01-05 05:06:33 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
Bill Wendlinge9353d72009-05-17 05:52:39 +00005 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Chris Lattner1811fca2004-01-05 05:06:33 +00006 <title>Source Level Debugging with LLVM</title>
7 <link rel="stylesheet" href="llvm.css" type="text/css">
8</head>
9<body>
10
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +000011<h1>Source Level Debugging with LLVM</h1>
Chris Lattner1811fca2004-01-05 05:06:33 +000012
Reid Spencerc3c4c4f2004-11-01 08:19:36 +000013<table class="layout" style="width:100%">
14 <tr class="layout">
15 <td class="left">
Chris Lattner1811fca2004-01-05 05:06:33 +000016<ul>
Misha Brukmanf91d9942004-05-12 19:21:57 +000017 <li><a href="#introduction">Introduction</a>
Chris Lattner1811fca2004-01-05 05:06:33 +000018 <ol>
19 <li><a href="#phil">Philosophy behind LLVM debugging information</a></li>
Jim Laskey5dcfd562006-03-23 17:54:33 +000020 <li><a href="#consumers">Debug information consumers</a></li>
Chris Lattner1811fca2004-01-05 05:06:33 +000021 <li><a href="#debugopt">Debugging optimized code</a></li>
Misha Brukmanf91d9942004-05-12 19:21:57 +000022 </ol></li>
Misha Brukmanf91d9942004-05-12 19:21:57 +000023 <li><a href="#format">Debugging information format</a>
Chris Lattner1811fca2004-01-05 05:06:33 +000024 <ol>
Jim Laskey14edc932006-03-14 18:08:46 +000025 <li><a href="#debug_info_descriptors">Debug information descriptors</a>
Chris Lattner1811fca2004-01-05 05:06:33 +000026 <ul>
Jim Laskey14edc932006-03-14 18:08:46 +000027 <li><a href="#format_compile_units">Compile unit descriptors</a></li>
Devang Patel59445db2010-03-09 00:44:10 +000028 <li><a href="#format_files">File descriptors</a></li>
Jim Laskey14edc932006-03-14 18:08:46 +000029 <li><a href="#format_global_variables">Global variable descriptors</a></li>
30 <li><a href="#format_subprograms">Subprogram descriptors</a></li>
Jim Laskey9dcffe72006-03-15 19:10:52 +000031 <li><a href="#format_blocks">Block descriptors</a></li>
Jim Laskey14edc932006-03-14 18:08:46 +000032 <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 Laskey5dcfd562006-03-23 17:54:33 +000037 <li><a href="#format_variables">Local variables</a></li>
Misha Brukmanf91d9942004-05-12 19:21:57 +000038 </ul></li>
Jim Laskey14edc932006-03-14 18:08:46 +000039 <li><a href="#format_common_intrinsics">Debugger intrinsic functions</a>
40 <ul>
Jim Laskey14edc932006-03-14 18:08:46 +000041 <li><a href="#format_common_declare">llvm.dbg.declare</a></li>
Victor Hernandez0b62cc62010-01-11 22:53:48 +000042 <li><a href="#format_common_value">llvm.dbg.value</a></li>
Jim Laskey14edc932006-03-14 18:08:46 +000043 </ul></li>
Misha Brukmanf91d9942004-05-12 19:21:57 +000044 </ol></li>
Devang Patel4da997b2009-11-25 23:28:01 +000045 <li><a href="#format_common_lifetime">Object lifetimes and scoping</a></li>
Misha Brukmanf91d9942004-05-12 19:21:57 +000046 <li><a href="#ccxx_frontend">C/C++ front-end specific debug information</a>
Chris Lattner1811fca2004-01-05 05:06:33 +000047 <ol>
Jim Laskey14edc932006-03-14 18:08:46 +000048 <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 Brukmanf91d9942004-05-12 19:21:57 +000055 </ol></li>
Chris Lattner1811fca2004-01-05 05:06:33 +000056</ul>
Misha Brukmanf91d9942004-05-12 19:21:57 +000057</td>
Reid Spencerc3c4c4f2004-11-01 08:19:36 +000058<td class="right">
Misha Brukman3c1f8e72004-05-12 21:26:16 +000059<img src="img/venusflytrap.jpg" alt="A leafy and green bug eater" width="247"
Misha Brukmanf91d9942004-05-12 19:21:57 +000060height="369">
61</td>
Reid Spencerc3c4c4f2004-11-01 08:19:36 +000062</tr></table>
Misha Brukmanf91d9942004-05-12 19:21:57 +000063
Chris Lattner020e1fc2004-05-23 21:07:27 +000064<div class="doc_author">
Jim Laskey14edc932006-03-14 18:08:46 +000065 <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a>
Jim Laskey6e8a2f42007-03-14 19:32:21 +000066 and <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p>
Chris Lattner020e1fc2004-05-23 21:07:27 +000067</div>
68
Chris Lattner1811fca2004-01-05 05:06:33 +000069
70<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +000071<h2><a name="introduction">Introduction</a></h2>
Misha Brukmancda6a9b2004-12-09 20:27:37 +000072<!-- *********************************************************************** -->
Chris Lattner1811fca2004-01-05 05:06:33 +000073
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +000074<div>
Chris Lattner1811fca2004-01-05 05:06:33 +000075
76<p>This document is the central repository for all information pertaining to
Bill Wendlinge9353d72009-05-17 05:52:39 +000077 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 Lattnercb3f64f2009-07-18 21:47:15 +000080 Further, this document provides specific examples of what debug information
Chris Lattner92ec3d12011-01-18 06:12:10 +000081 for C/C++ looks like.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +000082
Chris Lattner1811fca2004-01-05 05:06:33 +000083<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +000084<h3>
Chris Lattner1811fca2004-01-05 05:06:33 +000085 <a name="phil">Philosophy behind LLVM debugging information</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +000086</h3>
Chris Lattner1811fca2004-01-05 05:06:33 +000087
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +000088<div>
Chris Lattner1811fca2004-01-05 05:06:33 +000089
Misha Brukmanf91d9942004-05-12 19:21:57 +000090<p>The idea of the LLVM debugging information is to capture how the important
Bill Wendlinge9353d72009-05-17 05:52:39 +000091 pieces of the source-language's Abstract Syntax Tree map onto LLVM code.
92 Several design aspects have shaped the solution that appears here. The
93 important ones are:</p>
Chris Lattner1811fca2004-01-05 05:06:33 +000094
Misha Brukmanf91d9942004-05-12 19:21:57 +000095<ul>
Bill Wendlinge9353d72009-05-17 05:52:39 +000096 <li>Debugging information should have very little impact on the rest of the
97 compiler. No transformations, analyses, or code generators should need to
98 be modified because of debugging information.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +000099
Bill Wendlinge9353d72009-05-17 05:52:39 +0000100 <li>LLVM optimizations should interact in <a href="#debugopt">well-defined and
101 easily described ways</a> with the debugging information.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000102
Bill Wendlinge9353d72009-05-17 05:52:39 +0000103 <li>Because LLVM is designed to support arbitrary programming languages,
104 LLVM-to-LLVM tools should not need to know anything about the semantics of
105 the source-level-language.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000106
Bill Wendlinge9353d72009-05-17 05:52:39 +0000107 <li>Source-level languages are often <b>widely</b> different from one another.
108 LLVM should not put any restrictions of the flavor of the source-language,
109 and the debugging information should work with any language.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000110
Bill Wendlinge9353d72009-05-17 05:52:39 +0000111 <li>With code generator support, it should be possible to use an LLVM compiler
112 to compile a program to native machine code and standard debugging
113 formats. This allows compatibility with traditional machine-code level
114 debuggers, like GDB or DBX.</li>
Misha Brukmanf91d9942004-05-12 19:21:57 +0000115</ul>
Chris Lattner1811fca2004-01-05 05:06:33 +0000116
Bill Wendlinge9353d72009-05-17 05:52:39 +0000117<p>The approach used by the LLVM implementation is to use a small set
118 of <a href="#format_common_intrinsics">intrinsic functions</a> to define a
119 mapping between LLVM program objects and the source-level objects. The
Devang Patel80ae3492009-08-28 23:24:31 +0000120 description of the source-level program is maintained in LLVM metadata
121 in an <a href="#ccxx_frontend">implementation-defined format</a>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000122 (the C/C++ front-end currently uses working draft 7 of
123 the <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3
124 standard</a>).</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000125
Jim Laskey14edc932006-03-14 18:08:46 +0000126<p>When a program is being debugged, a debugger interacts with the user and
Bill Wendlinge9353d72009-05-17 05:52:39 +0000127 turns the stored debug information into source-language specific information.
128 As such, a debugger must be aware of the source-language, and is thus tied to
129 a specific language or family of languages.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000130
131</div>
132
Chris Lattner1811fca2004-01-05 05:06:33 +0000133<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000134<h3>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000135 <a name="consumers">Debug information consumers</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000136</h3>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000137
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000138<div>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000139
Jim Laskey5dcfd562006-03-23 17:54:33 +0000140<p>The role of debug information is to provide meta information normally
Bill Wendlinge9353d72009-05-17 05:52:39 +0000141 stripped away during the compilation process. This meta information provides
142 an LLVM user a relationship between generated code and the original program
143 source code.</p>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000144
Chris Lattner904f2172010-04-05 04:11:11 +0000145<p>Currently, debug information is consumed by DwarfDebug to produce dwarf
Bill Wendlinge9353d72009-05-17 05:52:39 +0000146 information used by the gdb debugger. Other targets could use the same
147 information to produce stabs or other debug forms.</p>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000148
149<p>It would also be reasonable to use debug information to feed profiling tools
Bill Wendlinge9353d72009-05-17 05:52:39 +0000150 for analysis of generated code, or, tools for reconstructing the original
151 source from generated code.</p>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000152
153<p>TODO - expound a bit more.</p>
154
155</div>
156
157<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000158<h3>
Chris Lattner1811fca2004-01-05 05:06:33 +0000159 <a name="debugopt">Debugging optimized code</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000160</h3>
Chris Lattner1811fca2004-01-05 05:06:33 +0000161
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000162<div>
Chris Lattner1811fca2004-01-05 05:06:33 +0000163
Misha Brukmanf91d9942004-05-12 19:21:57 +0000164<p>An extremely high priority of LLVM debugging information is to make it
Bill Wendlinge9353d72009-05-17 05:52:39 +0000165 interact well with optimizations and analysis. In particular, the LLVM debug
166 information provides the following guarantees:</p>
Misha Brukmanf91d9942004-05-12 19:21:57 +0000167
168<ul>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000169 <li>LLVM debug information <b>always provides information to accurately read
170 the source-level state of the program</b>, regardless of which LLVM
171 optimizations have been run, and without any modification to the
172 optimizations themselves. However, some optimizations may impact the
173 ability to modify the current state of the program with a debugger, such
174 as setting program variables, or calling functions that have been
175 deleted.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000176
Bill Wendlinge9353d72009-05-17 05:52:39 +0000177 <li>As desired, LLVM optimizations can be upgraded to be aware of the LLVM
178 debugging information, allowing them to update the debugging information
179 as they perform aggressive optimizations. This means that, with effort,
180 the LLVM optimizers could optimize debug code just as well as non-debug
181 code.</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000182
Devang Patel5c26a852011-05-31 17:45:27 +0000183 <li>LLVM debug information does not prevent optimizations from
Bill Wendlinge9353d72009-05-17 05:52:39 +0000184 happening (for example inlining, basic block reordering/merging/cleanup,
Devang Patel1d81ea82011-05-31 18:06:14 +0000185 tail duplication, etc).</li>
Chris Lattner1811fca2004-01-05 05:06:33 +0000186
Bill Wendlinge9353d72009-05-17 05:52:39 +0000187 <li>LLVM debug information is automatically optimized along with the rest of
188 the program, using existing facilities. For example, duplicate
189 information is automatically merged by the linker, and unused information
190 is automatically removed.</li>
Misha Brukmanf91d9942004-05-12 19:21:57 +0000191</ul>
Chris Lattner1811fca2004-01-05 05:06:33 +0000192
Misha Brukmanf91d9942004-05-12 19:21:57 +0000193<p>Basically, the debug information allows you to compile a program with
Bill Wendlinge9353d72009-05-17 05:52:39 +0000194 "<tt>-O0 -g</tt>" and get full debug information, allowing you to arbitrarily
195 modify the program as it executes from a debugger. Compiling a program with
196 "<tt>-O3 -g</tt>" gives you full debug information that is always available
197 and accurate for reading (e.g., you get accurate stack traces despite tail
198 call elimination and inlining), but you might lose the ability to modify the
199 program and call functions where were optimized out of the program, or
200 inlined away completely.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000201
Misha Brukman39dcddf2008-12-16 02:54:22 +0000202<p><a href="TestingGuide.html#quicktestsuite">LLVM test suite</a> provides a
Bill Wendlinge9353d72009-05-17 05:52:39 +0000203 framework to test optimizer's handling of debugging information. It can be
204 run like this:</p>
Devang Patelb885a912008-11-21 19:35:57 +0000205
206<div class="doc_code">
207<pre>
208% cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level
209% make TEST=dbgopt
210</pre>
211</div>
212
Bill Wendlinge9353d72009-05-17 05:52:39 +0000213<p>This will test impact of debugging information on optimization passes. If
214 debugging information influences optimization passes then it will be reported
215 as a failure. See <a href="TestingGuide.html">TestingGuide</a> for more
216 information on LLVM test infrastructure and how to run various tests.</p>
Devang Patelb885a912008-11-21 19:35:57 +0000217
Chris Lattner1811fca2004-01-05 05:06:33 +0000218</div>
219
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000220</div>
221
Chris Lattner1811fca2004-01-05 05:06:33 +0000222<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000223<h2>
Chris Lattner941515c2004-01-06 05:31:32 +0000224 <a name="format">Debugging information format</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000225</h2>
Chris Lattner1811fca2004-01-05 05:06:33 +0000226<!-- *********************************************************************** -->
227
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000228<div>
Chris Lattner1811fca2004-01-05 05:06:33 +0000229
230<p>LLVM debugging information has been carefully designed to make it possible
Bill Wendlinge9353d72009-05-17 05:52:39 +0000231 for the optimizer to optimize the program and debugging information without
232 necessarily having to know anything about debugging information. In
John Criswell2a4b0802010-03-17 15:01:50 +0000233 particular, the use of metadata avoids duplicated debugging information from
Devang Patel80ae3492009-08-28 23:24:31 +0000234 the beginning, and the global dead code elimination pass automatically
235 deletes debugging information for a function if it decides to delete the
236 function. </p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000237
238<p>To do this, most of the debugging information (descriptors for types,
Bill Wendlinge9353d72009-05-17 05:52:39 +0000239 variables, functions, source files, etc) is inserted by the language
Devang Patel80ae3492009-08-28 23:24:31 +0000240 front-end in the form of LLVM metadata. </p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000241
Jim Laskey14edc932006-03-14 18:08:46 +0000242<p>Debug information is designed to be agnostic about the target debugger and
Bill Wendlinge9353d72009-05-17 05:52:39 +0000243 debugging information representation (e.g. DWARF/Stabs/etc). It uses a
Devang Patel80ae3492009-08-28 23:24:31 +0000244 generic pass to decode the information that represents variables, types,
245 functions, namespaces, etc: this allows for arbitrary source-language
246 semantics and type-systems to be used, as long as there is a module
247 written for the target debugger to interpret the information. </p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000248
Misha Brukmanf91d9942004-05-12 19:21:57 +0000249<p>To provide basic functionality, the LLVM debugger does have to make some
Bill Wendlinge9353d72009-05-17 05:52:39 +0000250 assumptions about the source-level language being debugged, though it keeps
251 these to a minimum. The only common features that the LLVM debugger assumes
Devang Patel59445db2010-03-09 00:44:10 +0000252 exist are <a href="#format_files">source files</a>,
Bill Wendlinge9353d72009-05-17 05:52:39 +0000253 and <a href="#format_global_variables">program objects</a>. These abstract
254 objects are used by a debugger to form stack traces, show information about
255 local variables, etc.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000256
257<p>This section of the documentation first describes the representation aspects
Bill Wendlinge9353d72009-05-17 05:52:39 +0000258 common to any source-language. The <a href="#ccxx_frontend">next section</a>
259 describes the data layout conventions used by the C and C++ front-ends.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000260
Chris Lattner1811fca2004-01-05 05:06:33 +0000261<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000262<h3>
Jim Laskey14edc932006-03-14 18:08:46 +0000263 <a name="debug_info_descriptors">Debug information descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000264</h3>
Chris Lattner1811fca2004-01-05 05:06:33 +0000265
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000266<div>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000267
Jim Laskey14edc932006-03-14 18:08:46 +0000268<p>In consideration of the complexity and volume of debug information, LLVM
Devang Patel80ae3492009-08-28 23:24:31 +0000269 provides a specification for well formed debug descriptors. </p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000270
Jim Laskey14edc932006-03-14 18:08:46 +0000271<p>Consumers of LLVM debug information expect the descriptors for program
Bill Wendlinge9353d72009-05-17 05:52:39 +0000272 objects to start in a canonical format, but the descriptors can include
273 additional information appended at the end that is source-language
274 specific. All LLVM debugging information is versioned, allowing backwards
275 compatibility in the case that the core structures need to change in some
276 way. Also, all debugging information objects start with a tag to indicate
277 what type of object it is. The source-language is allowed to define its own
278 objects, by using unreserved tag numbers. We recommend using with tags in
Benjamin Kramer0f420382009-10-12 14:46:08 +0000279 the range 0x1000 through 0x2000 (there is a defined enum DW_TAG_user_base =
Bill Wendlinge9353d72009-05-17 05:52:39 +0000280 0x1000.)</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000281
Devang Patel80ae3492009-08-28 23:24:31 +0000282<p>The fields of debug descriptors used internally by LLVM
Nick Lewyckya87014f2010-03-31 07:50:17 +0000283 are restricted to only the simple data types <tt>i32</tt>, <tt>i1</tt>,
284 <tt>float</tt>, <tt>double</tt>, <tt>mdstring</tt> and <tt>mdnode</tt>. </p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000285
Bill Wendlinge9353d72009-05-17 05:52:39 +0000286<div class="doc_code">
Misha Brukmanf91d9942004-05-12 19:21:57 +0000287<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000288!1 = metadata !{
Nick Lewyckya87014f2010-03-31 07:50:17 +0000289 i32, ;; A tag
Bill Wendlinge9353d72009-05-17 05:52:39 +0000290 ...
291}
Misha Brukmanf91d9942004-05-12 19:21:57 +0000292</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000293</div>
Chris Lattner1811fca2004-01-05 05:06:33 +0000294
Jim Laskeyb2ff2d42006-06-16 13:14:03 +0000295<p><a name="LLVMDebugVersion">The first field of a descriptor is always an
Nick Lewyckya87014f2010-03-31 07:50:17 +0000296 <tt>i32</tt> containing a tag value identifying the content of the
Bill Wendlinge9353d72009-05-17 05:52:39 +0000297 descriptor. The remaining fields are specific to the descriptor. The values
298 of tags are loosely bound to the tag values of DWARF information entries.
299 However, that does not restrict the use of the information supplied to DWARF
300 targets. To facilitate versioning of debug information, the tag is augmented
Nick Lewyckyf6e37112011-07-25 21:13:23 +0000301 with the current debug version (LLVMDebugVersion = 8 &lt;&lt; 16 or
302 0x80000 or 524288.)</a></p>
Jim Laskey14edc932006-03-14 18:08:46 +0000303
Jim Laskeyb2ff2d42006-06-16 13:14:03 +0000304<p>The details of the various descriptors follow.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000305
Jim Laskey14edc932006-03-14 18:08:46 +0000306<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000307<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000308 <a name="format_compile_units">Compile unit descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000309</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000310
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000311<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000312
Bill Wendlinge9353d72009-05-17 05:52:39 +0000313<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000314<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000315!0 = metadata !{
316 i32, ;; Tag = 17 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
317 ;; (DW_TAG_compile_unit)
318 i32, ;; Unused field.
319 i32, ;; DWARF language identifier (ex. DW_LANG_C89)
320 metadata, ;; Source file name
321 metadata, ;; Source file directory (includes trailing slash)
322 metadata ;; Producer (ex. "4.0.1 LLVM (LLVM research group)")
323 i1, ;; True if this is a main compile unit.
324 i1, ;; True if this is optimized.
325 metadata, ;; Flags
326 i32 ;; Runtime version
Bill Wendlinge9353d72009-05-17 05:52:39 +0000327}
Jim Laskey14edc932006-03-14 18:08:46 +0000328</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000329</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000330
Bill Wendlinge9353d72009-05-17 05:52:39 +0000331<p>These descriptors contain a source language ID for the file (we use the DWARF
332 3.0 ID numbers, such as <tt>DW_LANG_C89</tt>, <tt>DW_LANG_C_plus_plus</tt>,
333 <tt>DW_LANG_Cobol74</tt>, etc), three strings describing the filename,
334 working directory of the compiler, and an identifier string for the compiler
335 that produced it.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000336
Bill Wendlinge9353d72009-05-17 05:52:39 +0000337<p>Compile unit descriptors provide the root context for objects declared in a
Devang Patel09fa69e2011-05-03 16:18:28 +0000338 specific compilation unit. File descriptors are defined using this context.
339 These descriptors are collected by a named metadata
340 <tt>!llvm.dbg.cu</tt>.
Jim Laskey14edc932006-03-14 18:08:46 +0000341
Devang Patel59445db2010-03-09 00:44:10 +0000342</div>
343
344<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000345<h4>
Devang Patel59445db2010-03-09 00:44:10 +0000346 <a name="format_files">File descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000347</h4>
Devang Patel59445db2010-03-09 00:44:10 +0000348
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000349<div>
Devang Patel59445db2010-03-09 00:44:10 +0000350
351<div class="doc_code">
352<pre>
353!0 = metadata !{
354 i32, ;; Tag = 41 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
355 ;; (DW_TAG_file_type)
356 metadata, ;; Source file name
357 metadata, ;; Source file directory (includes trailing slash)
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000358 metadata ;; Unused
Devang Patel59445db2010-03-09 00:44:10 +0000359}
360</pre>
361</div>
362
John Criswell2a4b0802010-03-17 15:01:50 +0000363<p>These descriptors contain information for a file. Global variables and top
Devang Patel59445db2010-03-09 00:44:10 +0000364 level functions would be defined using this context.k File descriptors also
365 provide context for source line correspondence. </p>
366
367<p>Each input file is encoded as a separate file descriptor in LLVM debugging
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000368 information output. </p>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000369
Jim Laskey14edc932006-03-14 18:08:46 +0000370</div>
371
372<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000373<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000374 <a name="format_global_variables">Global variable descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000375</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000376
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000377<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000378
Bill Wendlinge9353d72009-05-17 05:52:39 +0000379<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000380<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000381!1 = metadata !{
382 i32, ;; Tag = 52 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
383 ;; (DW_TAG_variable)
384 i32, ;; Unused field.
385 metadata, ;; Reference to context descriptor
386 metadata, ;; Name
387 metadata, ;; Display name (fully qualified C++ name)
388 metadata, ;; MIPS linkage name (for C++)
Devang Patel59445db2010-03-09 00:44:10 +0000389 metadata, ;; Reference to file where defined
Devang Patel80ae3492009-08-28 23:24:31 +0000390 i32, ;; Line number where defined
391 metadata, ;; Reference to type descriptor
392 i1, ;; True if the global is local to compile unit (static)
393 i1, ;; True if the global is defined in the compile unit (not extern)
Dan Gohmanaabfdb32010-05-28 17:13:49 +0000394 {}* ;; Reference to the global variable
Bill Wendlinge9353d72009-05-17 05:52:39 +0000395}
Jim Laskey14edc932006-03-14 18:08:46 +0000396</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000397</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000398
399<p>These descriptors provide debug information about globals variables. The
Devang Patel1c6b6812011-03-29 17:27:08 +0000400provide details such as name, type and where the variable is defined. All
401global variables are collected by named metadata <tt>!llvm.dbg.gv</tt>.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000402
403</div>
404
405<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000406<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000407 <a name="format_subprograms">Subprogram descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000408</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000409
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000410<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000411
Bill Wendlinge9353d72009-05-17 05:52:39 +0000412<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000413<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000414!2 = metadata !{
415 i32, ;; Tag = 46 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
416 ;; (DW_TAG_subprogram)
417 i32, ;; Unused field.
418 metadata, ;; Reference to context descriptor
419 metadata, ;; Name
420 metadata, ;; Display name (fully qualified C++ name)
421 metadata, ;; MIPS linkage name (for C++)
Devang Patel59445db2010-03-09 00:44:10 +0000422 metadata, ;; Reference to file where defined
Devang Patel80ae3492009-08-28 23:24:31 +0000423 i32, ;; Line number where defined
424 metadata, ;; Reference to type descriptor
425 i1, ;; True if the global is local to compile unit (static)
Devang Patel1d6bbd42011-04-22 23:10:17 +0000426 i1, ;; True if the global is defined in the compile unit (not extern)
427 i32, ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual
428 i32, ;; Index into a virtual function
Devang Patele89b7592010-06-04 22:49:55 +0000429 metadata, ;; indicates which base type contains the vtable pointer for the
430 ;; derived class
Devang Patel1d6bbd42011-04-22 23:10:17 +0000431 i1, ;; isArtificial
432 i1, ;; isOptimized
433 Function *,;; Pointer to LLVM function
434 metadata, ;; Lists function template parameters
435 metadata ;; Function declaration descriptor
Bill Wendlinge9353d72009-05-17 05:52:39 +0000436}
Jim Laskey14edc932006-03-14 18:08:46 +0000437</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000438</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000439
440<p>These descriptors provide debug information about functions, methods and
Bill Wendlinge9353d72009-05-17 05:52:39 +0000441 subprograms. They provide details such as name, return types and the source
Devang Patel1c6b6812011-03-29 17:27:08 +0000442 location where the subprogram is defined.
443 All subprogram descriptors are collected by a named metadata
444 <tt>!llvm.dbg.sp</tt>.
445</p>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000446
447</div>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000448
Jim Laskey9dcffe72006-03-15 19:10:52 +0000449<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000450<h4>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000451 <a name="format_blocks">Block descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000452</h4>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000453
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000454<div>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000455
Bill Wendlinge9353d72009-05-17 05:52:39 +0000456<div class="doc_code">
Jim Laskey9dcffe72006-03-15 19:10:52 +0000457<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000458!3 = metadata !{
Devang Patel9fbc6802010-10-04 16:51:59 +0000459 i32, ;; Tag = 11 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_lexical_block)
Devang Patelcac38902010-10-01 22:45:00 +0000460 metadata,;; Reference to context descriptor
461 i32, ;; Line number
Devang Patelfb30b852011-03-08 16:25:29 +0000462 i32, ;; Column number
463 metadata,;; Reference to source file
464 i32 ;; Unique ID to identify blocks from a template function
Bill Wendlinge9353d72009-05-17 05:52:39 +0000465}
Jim Laskey9dcffe72006-03-15 19:10:52 +0000466</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000467</div>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000468
469<p>These descriptors provide debug information about nested blocks within a
Devang Patelcac38902010-10-01 22:45:00 +0000470 subprogram. The line number and column numbers are used to dinstinguish
471 two lexical blocks at same depth. </p>
Jim Laskey9dcffe72006-03-15 19:10:52 +0000472
Jim Laskey14edc932006-03-14 18:08:46 +0000473</div>
474
475<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000476<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000477 <a name="format_basic_type">Basic type descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000478</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000479
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000480<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000481
Bill Wendlinge9353d72009-05-17 05:52:39 +0000482<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000483<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000484!4 = metadata !{
485 i32, ;; Tag = 36 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
486 ;; (DW_TAG_base_type)
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000487 metadata, ;; Reference to context
Devang Patel80ae3492009-08-28 23:24:31 +0000488 metadata, ;; Name (may be "" for anonymous types)
Devang Patel59445db2010-03-09 00:44:10 +0000489 metadata, ;; Reference to file where defined (may be NULL)
Devang Patel80ae3492009-08-28 23:24:31 +0000490 i32, ;; Line number where defined (may be 0)
491 i64, ;; Size in bits
492 i64, ;; Alignment in bits
493 i64, ;; Offset in bits
494 i32, ;; Flags
495 i32 ;; DWARF type encoding
Bill Wendlinge9353d72009-05-17 05:52:39 +0000496}
Jim Laskey14edc932006-03-14 18:08:46 +0000497</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000498</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000499
500<p>These descriptors define primitive types used in the code. Example int, bool
Bill Wendlinge9353d72009-05-17 05:52:39 +0000501 and float. The context provides the scope of the type, which is usually the
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000502 top level. Since basic types are not usually user defined the context
Bill Wendlinge9353d72009-05-17 05:52:39 +0000503 and line number can be left as NULL and 0. The size, alignment and offset
504 are expressed in bits and can be 64 bit values. The alignment is used to
505 round the offset when embedded in a
506 <a href="#format_composite_type">composite type</a> (example to keep float
507 doubles on 64 bit boundaries.) The offset is the bit offset if embedded in
508 a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000509
510<p>The type encoding provides the details of the type. The values are typically
Bill Wendlinge9353d72009-05-17 05:52:39 +0000511 one of the following:</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000512
Bill Wendlinge9353d72009-05-17 05:52:39 +0000513<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000514<pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000515DW_ATE_address = 1
516DW_ATE_boolean = 2
517DW_ATE_float = 4
518DW_ATE_signed = 5
519DW_ATE_signed_char = 6
520DW_ATE_unsigned = 7
521DW_ATE_unsigned_char = 8
Jim Laskey14edc932006-03-14 18:08:46 +0000522</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000523</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000524
525</div>
526
527<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000528<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000529 <a name="format_derived_type">Derived type descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000530</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000531
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000532<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000533
Bill Wendlinge9353d72009-05-17 05:52:39 +0000534<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000535<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000536!5 = metadata !{
537 i32, ;; Tag (see below)
538 metadata, ;; Reference to context
539 metadata, ;; Name (may be "" for anonymous types)
Devang Patel59445db2010-03-09 00:44:10 +0000540 metadata, ;; Reference to file where defined (may be NULL)
Devang Patel80ae3492009-08-28 23:24:31 +0000541 i32, ;; Line number where defined (may be 0)
Devang Patelbed5e7d2010-10-01 19:19:30 +0000542 i64, ;; Size in bits
543 i64, ;; Alignment in bits
544 i64, ;; Offset in bits
Devang Patel514b4002011-04-16 00:11:51 +0000545 metadata, ;; Reference to type derived from
546 metadata, ;; (optional) Name of the Objective C property assoicated with
547 ;; Objective-C an ivar
548 metadata, ;; (optional) Name of the Objective C property getter selector.
549 metadata, ;; (optional) Name of the Objective C property setter selector.
550 i32 ;; (optional) Objective C property attributes.
Bill Wendlinge9353d72009-05-17 05:52:39 +0000551}
Jim Laskey14edc932006-03-14 18:08:46 +0000552</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000553</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000554
555<p>These descriptors are used to define types derived from other types. The
556value of the tag varies depending on the meaning. The following are possible
Misha Brukman39dcddf2008-12-16 02:54:22 +0000557tag values:</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000558
Bill Wendlinge9353d72009-05-17 05:52:39 +0000559<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000560<pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000561DW_TAG_formal_parameter = 5
562DW_TAG_member = 13
563DW_TAG_pointer_type = 15
564DW_TAG_reference_type = 16
565DW_TAG_typedef = 22
566DW_TAG_const_type = 38
567DW_TAG_volatile_type = 53
568DW_TAG_restrict_type = 55
Jim Laskey14edc932006-03-14 18:08:46 +0000569</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000570</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000571
Bill Wendlinge9353d72009-05-17 05:52:39 +0000572<p><tt>DW_TAG_member</tt> is used to define a member of
573 a <a href="#format_composite_type">composite type</a>
574 or <a href="#format_subprograms">subprogram</a>. The type of the member is
575 the <a href="#format_derived_type">derived
576 type</a>. <tt>DW_TAG_formal_parameter</tt> is used to define a member which
577 is a formal argument of a subprogram.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000578
Bill Wendlinge9353d72009-05-17 05:52:39 +0000579<p><tt>DW_TAG_typedef</tt> is used to provide a name for the derived type.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000580
Bill Wendlinge9353d72009-05-17 05:52:39 +0000581<p><tt>DW_TAG_pointer_type</tt>,<tt>DW_TAG_reference_type</tt>,
582 <tt>DW_TAG_const_type</tt>, <tt>DW_TAG_volatile_type</tt>
583 and <tt>DW_TAG_restrict_type</tt> are used to qualify
584 the <a href="#format_derived_type">derived type</a>. </p>
Jim Laskey14edc932006-03-14 18:08:46 +0000585
586<p><a href="#format_derived_type">Derived type</a> location can be determined
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000587 from the context and line number. The size, alignment and offset are
Bill Wendlinge9353d72009-05-17 05:52:39 +0000588 expressed in bits and can be 64 bit values. The alignment is used to round
589 the offset when embedded in a <a href="#format_composite_type">composite
590 type</a> (example to keep float doubles on 64 bit boundaries.) The offset is
591 the bit offset if embedded in a <a href="#format_composite_type">composite
592 type</a>.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000593
Devang Patel7846c1e2011-02-03 00:22:17 +0000594<p>Note that the <tt>void *</tt> type is expressed as a type derived from NULL.
595</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000596
597</div>
598
599<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000600<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000601 <a name="format_composite_type">Composite type descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000602</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000603
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000604<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000605
Bill Wendlinge9353d72009-05-17 05:52:39 +0000606<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000607<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000608!6 = metadata !{
609 i32, ;; Tag (see below)
610 metadata, ;; Reference to context
611 metadata, ;; Name (may be "" for anonymous types)
Devang Patel59445db2010-03-09 00:44:10 +0000612 metadata, ;; Reference to file where defined (may be NULL)
Devang Patel80ae3492009-08-28 23:24:31 +0000613 i32, ;; Line number where defined (may be 0)
614 i64, ;; Size in bits
615 i64, ;; Alignment in bits
616 i64, ;; Offset in bits
617 i32, ;; Flags
618 metadata, ;; Reference to type derived from
619 metadata, ;; Reference to array of member descriptors
620 i32 ;; Runtime languages
Bill Wendlinge9353d72009-05-17 05:52:39 +0000621}
Jim Laskey14edc932006-03-14 18:08:46 +0000622</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000623</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000624
625<p>These descriptors are used to define types that are composed of 0 or more
626elements. The value of the tag varies depending on the meaning. The following
Misha Brukman39dcddf2008-12-16 02:54:22 +0000627are possible tag values:</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000628
Bill Wendlinge9353d72009-05-17 05:52:39 +0000629<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000630<pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000631DW_TAG_array_type = 1
632DW_TAG_enumeration_type = 4
633DW_TAG_structure_type = 19
634DW_TAG_union_type = 23
635DW_TAG_vector_type = 259
Bruno Cardoso Lopes9d809ca2009-05-29 17:08:57 +0000636DW_TAG_subroutine_type = 21
637DW_TAG_inheritance = 28
Jim Laskey14edc932006-03-14 18:08:46 +0000638</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000639</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000640
Jim Laskey19f964e2006-06-15 20:51:43 +0000641<p>The vector flag indicates that an array type is a native packed vector.</p>
642
Jim Laskeyb2ff2d42006-06-16 13:14:03 +0000643<p>The members of array types (tag = <tt>DW_TAG_array_type</tt>) or vector types
Bill Wendlinge9353d72009-05-17 05:52:39 +0000644 (tag = <tt>DW_TAG_vector_type</tt>) are <a href="#format_subrange">subrange
645 descriptors</a>, each representing the range of subscripts at that level of
646 indexing.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000647
648<p>The members of enumeration types (tag = <tt>DW_TAG_enumeration_type</tt>) are
Bill Wendlinge9353d72009-05-17 05:52:39 +0000649 <a href="#format_enumeration">enumerator descriptors</a>, each representing
Devang Patel1c6b6812011-03-29 17:27:08 +0000650 the definition of enumeration value for the set. All enumeration type
651 descriptors are collected by named metadata <tt>!llvm.dbg.enum</tt>.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000652
653<p>The members of structure (tag = <tt>DW_TAG_structure_type</tt>) or union (tag
Bill Wendlinge9353d72009-05-17 05:52:39 +0000654 = <tt>DW_TAG_union_type</tt>) types are any one of
655 the <a href="#format_basic_type">basic</a>,
656 <a href="#format_derived_type">derived</a>
657 or <a href="#format_composite_type">composite</a> type descriptors, each
658 representing a field member of the structure or union.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000659
Jim Laskey4771cca2006-08-21 21:21:06 +0000660<p>For C++ classes (tag = <tt>DW_TAG_structure_type</tt>), member descriptors
Bill Wendlinge9353d72009-05-17 05:52:39 +0000661 provide information about base classes, static members and member
662 functions. If a member is a <a href="#format_derived_type">derived type
663 descriptor</a> and has a tag of <tt>DW_TAG_inheritance</tt>, then the type
664 represents a base class. If the member of is
665 a <a href="#format_global_variables">global variable descriptor</a> then it
666 represents a static member. And, if the member is
667 a <a href="#format_subprograms">subprogram descriptor</a> then it represents
668 a member function. For static members and member
669 functions, <tt>getName()</tt> returns the members link or the C++ mangled
670 name. <tt>getDisplayName()</tt> the simplied version of the name.</p>
Jim Laskey4771cca2006-08-21 21:21:06 +0000671
Bill Wendlinge9353d72009-05-17 05:52:39 +0000672<p>The first member of subroutine (tag = <tt>DW_TAG_subroutine_type</tt>) type
673 elements is the return type for the subroutine. The remaining elements are
674 the formal arguments to the subroutine.</p>
Jim Laskey4810c262006-06-20 21:13:20 +0000675
Jim Laskey14edc932006-03-14 18:08:46 +0000676<p><a href="#format_composite_type">Composite type</a> location can be
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000677 determined from the context and line number. The size, alignment and
Bill Wendlinge9353d72009-05-17 05:52:39 +0000678 offset are expressed in bits and can be 64 bit values. The alignment is used
679 to round the offset when embedded in
680 a <a href="#format_composite_type">composite type</a> (as an example, to keep
681 float doubles on 64 bit boundaries.) The offset is the bit offset if embedded
682 in a <a href="#format_composite_type">composite type</a>.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000683
684</div>
685
686<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000687<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000688 <a name="format_subrange">Subrange descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000689</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000690
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000691<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000692
Bill Wendlinge9353d72009-05-17 05:52:39 +0000693<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000694<pre>
Devang Patel7846c1e2011-02-03 00:22:17 +0000695!42 = metadata !{
Bill Wendlinge9353d72009-05-17 05:52:39 +0000696 i32, ;; Tag = 33 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_subrange_type)
697 i64, ;; Low value
698 i64 ;; High value
699}
Jim Laskey14edc932006-03-14 18:08:46 +0000700</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000701</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000702
703<p>These descriptors are used to define ranges of array subscripts for an array
Bill Wendlinge9353d72009-05-17 05:52:39 +0000704 <a href="#format_composite_type">composite type</a>. The low value defines
705 the lower bounds typically zero for C/C++. The high value is the upper
706 bounds. Values are 64 bit. High - low + 1 is the size of the array. If low
Devang Patel778947c2011-04-08 23:39:38 +0000707 > high the array bounds are not included in generated debugging information.
708</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000709
710</div>
711
712<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000713<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000714 <a name="format_enumeration">Enumerator descriptors</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000715</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000716
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000717<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000718
Bill Wendlinge9353d72009-05-17 05:52:39 +0000719<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +0000720<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000721!6 = metadata !{
722 i32, ;; Tag = 40 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a>
723 ;; (DW_TAG_enumerator)
724 metadata, ;; Name
725 i64 ;; Value
Bill Wendlinge9353d72009-05-17 05:52:39 +0000726}
Jim Laskey14edc932006-03-14 18:08:46 +0000727</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000728</div>
Jim Laskey14edc932006-03-14 18:08:46 +0000729
Bill Wendlinge9353d72009-05-17 05:52:39 +0000730<p>These descriptors are used to define members of an
731 enumeration <a href="#format_composite_type">composite type</a>, it
732 associates the name to the value.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000733
734</div>
735
736<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000737<h4>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000738 <a name="format_variables">Local variables</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000739</h4>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000740
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000741<div>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000742
743<div class="doc_code">
Jim Laskey5dcfd562006-03-23 17:54:33 +0000744<pre>
Devang Patel80ae3492009-08-28 23:24:31 +0000745!7 = metadata !{
746 i32, ;; Tag (see below)
747 metadata, ;; Context
748 metadata, ;; Name
Devang Patel59445db2010-03-09 00:44:10 +0000749 metadata, ;; Reference to file where defined
Devang Patele1aa67c2011-03-08 16:29:40 +0000750 i32, ;; 24 bit - Line number where defined
751 ;; 8 bit - Argument number. 1 indicates 1st argument.
Devang Patelac0a1f62011-07-27 18:14:50 +0000752 metadata, ;; Type descriptor
753 i32, ;; flags
754 metadata ;; (optional) Reference to inline location
Bill Wendlinge9353d72009-05-17 05:52:39 +0000755}
Jim Laskey5dcfd562006-03-23 17:54:33 +0000756</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000757</div>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000758
759<p>These descriptors are used to define variables local to a sub program. The
Bill Wendlinge9353d72009-05-17 05:52:39 +0000760 value of the tag depends on the usage of the variable:</p>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000761
Bill Wendlinge9353d72009-05-17 05:52:39 +0000762<div class="doc_code">
Jim Laskey5dcfd562006-03-23 17:54:33 +0000763<pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000764DW_TAG_auto_variable = 256
765DW_TAG_arg_variable = 257
766DW_TAG_return_variable = 258
Jim Laskey5dcfd562006-03-23 17:54:33 +0000767</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000768</div>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000769
770<p>An auto variable is any variable declared in the body of the function. An
Bill Wendlinge9353d72009-05-17 05:52:39 +0000771 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 Laskey5dcfd562006-03-23 17:54:33 +0000774
Jim Laskey3481e122006-03-24 09:20:27 +0000775<p>The context is either the subprogram or block where the variable is defined.
Devang Pateleb1bb4e2011-08-16 22:09:43 +0000776 Name the source variable name. Context and line indicate where the
Bill Wendlinge9353d72009-05-17 05:52:39 +0000777 variable was defined. Type descriptor defines the declared type of the
778 variable.</p>
Jim Laskey5dcfd562006-03-23 17:54:33 +0000779
780</div>
781
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000782</div>
783
Jim Laskey5dcfd562006-03-23 17:54:33 +0000784<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000785<h3>
Jim Laskey14edc932006-03-14 18:08:46 +0000786 <a name="format_common_intrinsics">Debugger intrinsic functions</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000787</h3>
Jim Laskey14edc932006-03-14 18:08:46 +0000788
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000789<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000790
791<p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to
Bill Wendlinge9353d72009-05-17 05:52:39 +0000792 provide debug information at various points in generated code.</p>
Jim Laskey14edc932006-03-14 18:08:46 +0000793
Jim Laskey14edc932006-03-14 18:08:46 +0000794<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000795<h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000796 <a name="format_common_declare">llvm.dbg.declare</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000797</h4>
Jim Laskey14edc932006-03-14 18:08:46 +0000798
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000799<div>
Jim Laskey14edc932006-03-14 18:08:46 +0000800<pre>
Devang Patel6df452c2010-10-01 19:22:16 +0000801 void %<a href="#format_common_declare">llvm.dbg.declare</a>(metadata, metadata)
Jim Laskey14edc932006-03-14 18:08:46 +0000802</pre>
803
Jim Laskey3481e122006-03-24 09:20:27 +0000804<p>This intrinsic provides information about a local element (ex. variable.) The
NAKAMURA Takumi6bd36d52011-04-09 09:51:57 +0000805 first argument is metadata holding alloca for the variable. The
Devang Patel9a8539c2011-02-01 17:22:12 +0000806 second argument is metadata containing description of the variable. </p>
Jim Laskey14edc932006-03-14 18:08:46 +0000807</div>
808
809<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000810<h4>
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000811 <a name="format_common_value">llvm.dbg.value</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000812</h4>
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000813
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000814<div>
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000815<pre>
Dan Gohmand6a6f612010-05-28 17:07:41 +0000816 void %<a href="#format_common_value">llvm.dbg.value</a>(metadata, i64, metadata)
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000817</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 Patel9a8539c2011-02-01 17:22:12 +0000822 is written. The third argument is metadata containing description of the
823 user source variable. </p>
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000824</div>
825
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000826</div>
827
Victor Hernandez0b62cc62010-01-11 22:53:48 +0000828<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000829<h3>
Chris Lattner941515c2004-01-06 05:31:32 +0000830 <a name="format_common_lifetime">Object lifetimes and scoping</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000831</h3>
Chris Lattner1811fca2004-01-05 05:06:33 +0000832
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000833<div>
Bill Wendling991b84e2009-12-01 00:53:11 +0000834<p>In many languages, the local variables in functions can have their lifetimes
835 or scopes limited to a subset of a function. In the C family of languages,
Bill Wendlinge9353d72009-05-17 05:52:39 +0000836 for example, variables are only live (readable and writable) within the
837 source block that they are defined in. In functional languages, values are
838 only readable after they have been defined. Though this is a very obvious
Bill Wendling991b84e2009-12-01 00:53:11 +0000839 concept, it is non-trivial to model in LLVM, because it has no notion of
Bill Wendlinge9353d72009-05-17 05:52:39 +0000840 scoping in this sense, and does not want to be tied to a language's scoping
841 rules.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000842
Bill Wendling991b84e2009-12-01 00:53:11 +0000843<p>In order to handle this, the LLVM debug format uses the metadata attached to
Nick Lewyckya87014f2010-03-31 07:50:17 +0000844 llvm instructions to encode line number and scoping information. Consider
845 the following C fragment, for example:</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000846
Bill Wendlinge9353d72009-05-17 05:52:39 +0000847<div class="doc_code">
Misha Brukmanf91d9942004-05-12 19:21:57 +0000848<pre>
Chris Lattner1811fca2004-01-05 05:06:33 +00008491. void foo() {
Devang Patel4da997b2009-11-25 23:28:01 +00008502. int X = 21;
8513. int Y = 22;
Chris Lattner1811fca2004-01-05 05:06:33 +00008524. {
Devang Patel4da997b2009-11-25 23:28:01 +00008535. int Z = 23;
8546. Z = X;
Chris Lattner1811fca2004-01-05 05:06:33 +00008557. }
Devang Patel4da997b2009-11-25 23:28:01 +00008568. X = Y;
Chris Lattner1811fca2004-01-05 05:06:33 +00008579. }
Misha Brukmanf91d9942004-05-12 19:21:57 +0000858</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000859</div>
Chris Lattner1811fca2004-01-05 05:06:33 +0000860
Jim Laskey14edc932006-03-14 18:08:46 +0000861<p>Compiled to LLVM, this function would be represented like this:</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000862
Bill Wendlinge9353d72009-05-17 05:52:39 +0000863<div class="doc_code">
Misha Brukmanf91d9942004-05-12 19:21:57 +0000864<pre>
Bill Wendling991b84e2009-12-01 00:53:11 +0000865define void @foo() nounwind ssp {
Jim Laskey14edc932006-03-14 18:08:46 +0000866entry:
Bill Wendling05252352009-12-01 00:59:58 +0000867 %X = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
868 %Y = alloca i32, align 4 ; &lt;i32*&gt; [#uses=4]
869 %Z = alloca i32, align 4 ; &lt;i32*&gt; [#uses=3]
Dan Gohmanaabfdb32010-05-28 17:13:49 +0000870 %0 = bitcast i32* %X to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel7846c1e2011-02-03 00:22:17 +0000871 call void @llvm.dbg.declare(metadata !{i32 * %X}, metadata !0), !dbg !7
Devang Patel4da997b2009-11-25 23:28:01 +0000872 store i32 21, i32* %X, !dbg !8
Dan Gohmanaabfdb32010-05-28 17:13:49 +0000873 %1 = bitcast i32* %Y to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel7846c1e2011-02-03 00:22:17 +0000874 call void @llvm.dbg.declare(metadata !{i32 * %Y}, metadata !9), !dbg !10
Devang Patel4da997b2009-11-25 23:28:01 +0000875 store i32 22, i32* %Y, !dbg !11
Dan Gohmanaabfdb32010-05-28 17:13:49 +0000876 %2 = bitcast i32* %Z to {}* ; &lt;{}*&gt; [#uses=1]
Devang Patel7846c1e2011-02-03 00:22:17 +0000877 call void @llvm.dbg.declare(metadata !{i32 * %Z}, metadata !12), !dbg !14
Devang Patel4da997b2009-11-25 23:28:01 +0000878 store i32 23, i32* %Z, !dbg !15
Bill Wendling05252352009-12-01 00:59:58 +0000879 %tmp = load i32* %X, !dbg !16 ; &lt;i32&gt; [#uses=1]
880 %tmp1 = load i32* %Y, !dbg !16 ; &lt;i32&gt; [#uses=1]
881 %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; &lt;i32&gt; [#uses=1]
Devang Patel4da997b2009-11-25 23:28:01 +0000882 store i32 %add, i32* %Z, !dbg !16
Bill Wendling05252352009-12-01 00:59:58 +0000883 %tmp2 = load i32* %Y, !dbg !17 ; &lt;i32&gt; [#uses=1]
Devang Patel4da997b2009-11-25 23:28:01 +0000884 store i32 %tmp2, i32* %X, !dbg !17
885 ret void, !dbg !18
Chris Lattner1811fca2004-01-05 05:06:33 +0000886}
Devang Patel4da997b2009-11-25 23:28:01 +0000887
Devang Patel7846c1e2011-02-03 00:22:17 +0000888declare void @llvm.dbg.declare(metadata, metadata) nounwind readnone
Devang Patel4da997b2009-11-25 23:28:01 +0000889
890!0 = metadata !{i32 459008, metadata !1, metadata !"X",
891 metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ]
892!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
893!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", metadata !"foo",
894 metadata !"foo", metadata !3, i32 1, metadata !4,
895 i1 false, i1 true}; [DW_TAG_subprogram ]
896!3 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c",
897 metadata !"/private/tmp", metadata !"clang 1.1", i1 true,
898 i1 false, metadata !"", i32 0}; [DW_TAG_compile_unit ]
899!4 = metadata !{i32 458773, metadata !3, metadata !"", null, i32 0, i64 0, i64 0,
900 i64 0, i32 0, null, metadata !5, i32 0}; [DW_TAG_subroutine_type ]
901!5 = metadata !{null}
902!6 = metadata !{i32 458788, metadata !3, metadata !"int", metadata !3, i32 0,
903 i64 32, i64 32, i64 0, i32 0, i32 5}; [DW_TAG_base_type ]
904!7 = metadata !{i32 2, i32 7, metadata !1, null}
905!8 = metadata !{i32 2, i32 3, metadata !1, null}
906!9 = metadata !{i32 459008, metadata !1, metadata !"Y", metadata !3, i32 3,
907 metadata !6}; [ DW_TAG_auto_variable ]
908!10 = metadata !{i32 3, i32 7, metadata !1, null}
909!11 = metadata !{i32 3, i32 3, metadata !1, null}
910!12 = metadata !{i32 459008, metadata !13, metadata !"Z", metadata !3, i32 5,
911 metadata !6}; [ DW_TAG_auto_variable ]
912!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
913!14 = metadata !{i32 5, i32 9, metadata !13, null}
914!15 = metadata !{i32 5, i32 5, metadata !13, null}
915!16 = metadata !{i32 6, i32 5, metadata !13, null}
916!17 = metadata !{i32 8, i32 3, metadata !1, null}
917!18 = metadata !{i32 9, i32 1, metadata !2, null}
Misha Brukmanf91d9942004-05-12 19:21:57 +0000918</pre>
Chris Lattner1811fca2004-01-05 05:06:33 +0000919</div>
920
Bill Wendling991b84e2009-12-01 00:53:11 +0000921<p>This example illustrates a few important details about LLVM debugging
922 information. In particular, it shows how the <tt>llvm.dbg.declare</tt>
923 intrinsic and location information, which are attached to an instruction,
924 are applied together to allow a debugger to analyze the relationship between
925 statements, variable definitions, and the code used to implement the
926 function.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +0000927
Bill Wendling991b84e2009-12-01 00:53:11 +0000928<div class="doc_code">
Bill Wendling05252352009-12-01 00:59:58 +0000929<pre>
Devang Patel7846c1e2011-02-03 00:22:17 +0000930call void @llvm.dbg.declare(metadata, metadata !0), !dbg !7
Bill Wendling991b84e2009-12-01 00:53:11 +0000931</pre>
932</div>
933
934<p>The first intrinsic
Devang Patel4da997b2009-11-25 23:28:01 +0000935 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendling991b84e2009-12-01 00:53:11 +0000936 encodes debugging information for the variable <tt>X</tt>. The metadata
937 <tt>!dbg !7</tt> attached to the intrinsic provides scope information for the
938 variable <tt>X</tt>.</p>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000939
Bill Wendling991b84e2009-12-01 00:53:11 +0000940<div class="doc_code">
941<pre>
942!7 = metadata !{i32 2, i32 7, metadata !1, null}
943!1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ]
944!2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo",
945 metadata !"foo", metadata !"foo", metadata !3, i32 1,
946 metadata !4, i1 false, i1 true}; [DW_TAG_subprogram ]
947</pre>
948</div>
949
950<p>Here <tt>!7</tt> is metadata providing location information. It has four
951 fields: line number, column number, scope, and original scope. The original
952 scope represents inline location if this instruction is inlined inside a
953 caller, and is null otherwise. In this example, scope is encoded by
Devang Patel4da997b2009-11-25 23:28:01 +0000954 <tt>!1</tt>. <tt>!1</tt> represents a lexical block inside the scope
955 <tt>!2</tt>, where <tt>!2</tt> is a
Bill Wendling991b84e2009-12-01 00:53:11 +0000956 <a href="#format_subprograms">subprogram descriptor</a>. This way the
957 location information attached to the intrinsics indicates that the
958 variable <tt>X</tt> is declared at line number 2 at a function level scope in
959 function <tt>foo</tt>.</p>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000960
Devang Patel4da997b2009-11-25 23:28:01 +0000961<p>Now lets take another example.</p>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000962
Bill Wendling991b84e2009-12-01 00:53:11 +0000963<div class="doc_code">
Bill Wendling05252352009-12-01 00:59:58 +0000964<pre>
Devang Patel7846c1e2011-02-03 00:22:17 +0000965call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14
Bill Wendling991b84e2009-12-01 00:53:11 +0000966</pre>
967</div>
968
969<p>The second intrinsic
Devang Patel4da997b2009-11-25 23:28:01 +0000970 <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt>
Bill Wendling991b84e2009-12-01 00:53:11 +0000971 encodes debugging information for variable <tt>Z</tt>. The metadata
972 <tt>!dbg !14</tt> attached to the intrinsic provides scope information for
973 the variable <tt>Z</tt>.</p>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000974
Bill Wendling991b84e2009-12-01 00:53:11 +0000975<div class="doc_code">
976<pre>
977!13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ]
978!14 = metadata !{i32 5, i32 9, metadata !13, null}
979</pre>
980</div>
Bill Wendlinge9353d72009-05-17 05:52:39 +0000981
John Criswell2a4b0802010-03-17 15:01:50 +0000982<p>Here <tt>!14</tt> indicates that <tt>Z</tt> is declared at line number 5 and
Bill Wendling991b84e2009-12-01 00:53:11 +0000983 column number 9 inside of lexical scope <tt>!13</tt>. The lexical scope
984 itself resides inside of lexical scope <tt>!1</tt> described above.</p>
985
986<p>The scope information attached with each instruction provides a
987 straightforward way to find instructions covered by a scope.</p>
988
Bill Wendlinge9353d72009-05-17 05:52:39 +0000989</div>
Chris Lattner1811fca2004-01-05 05:06:33 +0000990
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000991</div>
992
Chris Lattner1811fca2004-01-05 05:06:33 +0000993<!-- *********************************************************************** -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000994<h2>
Chris Lattner941515c2004-01-06 05:31:32 +0000995 <a name="ccxx_frontend">C/C++ front-end specific debug information</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +0000996</h2>
Misha Brukmancda6a9b2004-12-09 20:27:37 +0000997<!-- *********************************************************************** -->
Chris Lattner1811fca2004-01-05 05:06:33 +0000998
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +0000999<div>
Chris Lattner1811fca2004-01-05 05:06:33 +00001000
Misha Brukmanf91d9942004-05-12 19:21:57 +00001001<p>The C and C++ front-ends represent information about the program in a format
Bill Wendlinge9353d72009-05-17 05:52:39 +00001002 that is effectively identical
1003 to <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3.0</a> in
1004 terms of information content. This allows code generators to trivially
1005 support native debuggers by generating standard dwarf information, and
1006 contains enough information for non-dwarf targets to translate it as
1007 needed.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +00001008
Jim Laskey14edc932006-03-14 18:08:46 +00001009<p>This section describes the forms used to represent C and C++ programs. Other
Bill Wendlinge9353d72009-05-17 05:52:39 +00001010 languages could pattern themselves after this (which itself is tuned to
1011 representing programs in the same way that DWARF 3 does), or they could
1012 choose to provide completely different forms if they don't fit into the DWARF
1013 model. As support for debugging information gets added to the various LLVM
1014 source-language front-ends, the information used should be documented
1015 here.</p>
Chris Lattner1811fca2004-01-05 05:06:33 +00001016
Jim Laskey14edc932006-03-14 18:08:46 +00001017<p>The following sections provide examples of various C/C++ constructs and the
Bill Wendlinge9353d72009-05-17 05:52:39 +00001018 debug information that would best describe those constructs.</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001019
Chris Lattner1811fca2004-01-05 05:06:33 +00001020<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001021<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001022 <a name="ccxx_compile_units">C/C++ source file information</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001023</h3>
Chris Lattner1811fca2004-01-05 05:06:33 +00001024
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001025<div>
Chris Lattner1811fca2004-01-05 05:06:33 +00001026
Bill Wendlinge9353d72009-05-17 05:52:39 +00001027<p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located
1028 in the directory <tt>/Users/mine/sources</tt>, the following code:</p>
Chris Lattner941515c2004-01-06 05:31:32 +00001029
Bill Wendlinge9353d72009-05-17 05:52:39 +00001030<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001031<pre>
1032#include "MyHeader.h"
Chris Lattner941515c2004-01-06 05:31:32 +00001033
Jim Laskey14edc932006-03-14 18:08:46 +00001034int main(int argc, char *argv[]) {
1035 return 0;
1036}
1037</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001038</div>
Chris Lattner941515c2004-01-06 05:31:32 +00001039
Misha Brukman39dcddf2008-12-16 02:54:22 +00001040<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001041
Bill Wendlinge9353d72009-05-17 05:52:39 +00001042<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001043<pre>
1044...
1045;;
Devang Patel59445db2010-03-09 00:44:10 +00001046;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp".
Jim Laskey14edc932006-03-14 18:08:46 +00001047;;
Devang Patel59445db2010-03-09 00:44:10 +00001048!2 = metadata !{
1049 i32 524305, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001050 i32 0, ;; Unused
1051 i32 4, ;; Language Id
1052 metadata !"MySource.cpp",
1053 metadata !"/Users/mine/sources",
1054 metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)",
1055 i1 true, ;; Main Compile Unit
1056 i1 false, ;; Optimized compile unit
1057 metadata !"", ;; Compiler flags
1058 i32 0} ;; Runtime version
1059
Jim Laskey14edc932006-03-14 18:08:46 +00001060;;
Devang Patel59445db2010-03-09 00:44:10 +00001061;; Define the file for the file "/Users/mine/sources/MySource.cpp".
Jim Laskey14edc932006-03-14 18:08:46 +00001062;;
Devang Patel80ae3492009-08-28 23:24:31 +00001063!1 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001064 i32 524329, ;; Tag
1065 metadata !"MySource.cpp",
Devang Patel80ae3492009-08-28 23:24:31 +00001066 metadata !"/Users/mine/sources",
Devang Patel4a7904d62010-07-13 16:53:20 +00001067 metadata !2 ;; Compile unit
Devang Patel59445db2010-03-09 00:44:10 +00001068}
1069
1070;;
1071;; Define the file for the file "/Users/mine/sources/Myheader.h"
1072;;
1073!3 = metadata !{
1074 i32 524329, ;; Tag
1075 metadata !"Myheader.h"
1076 metadata !"/Users/mine/sources",
Devang Patel4a7904d62010-07-13 16:53:20 +00001077 metadata !2 ;; Compile unit
Devang Patel59445db2010-03-09 00:44:10 +00001078}
Jim Laskey14edc932006-03-14 18:08:46 +00001079
Jim Laskey14edc932006-03-14 18:08:46 +00001080...
1081</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001082</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001083
Devang Patel5bc1c4b2010-03-26 19:08:36 +00001084<p>llvm::Instruction provides easy access to metadata attached with an
1085instruction. One can extract line number information encoded in LLVM IR
1086using <tt>Instruction::getMetadata()</tt> and
1087<tt>DILocation::getLineNumber()</tt>.
1088<pre>
1089 if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction
1090 DILocation Loc(N); // DILocation is in DebugInfo.h
1091 unsigned Line = Loc.getLineNumber();
1092 StringRef File = Loc.getFilename();
1093 StringRef Dir = Loc.getDirectory();
1094 }
1095</pre>
Chris Lattner941515c2004-01-06 05:31:32 +00001096</div>
1097
1098<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001099<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001100 <a name="ccxx_global_variable">C/C++ global variable information</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001101</h3>
Chris Lattner941515c2004-01-06 05:31:32 +00001102
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001103<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001104
Misha Brukman39dcddf2008-12-16 02:54:22 +00001105<p>Given an integer global variable declared as follows:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001106
Bill Wendlinge9353d72009-05-17 05:52:39 +00001107<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001108<pre>
1109int MyGlobal = 100;
1110</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001111</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001112
Misha Brukman39dcddf2008-12-16 02:54:22 +00001113<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001114
Bill Wendlinge9353d72009-05-17 05:52:39 +00001115<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001116<pre>
1117;;
Jim Laskey14edc932006-03-14 18:08:46 +00001118;; Define the global itself.
1119;;
1120%MyGlobal = global int 100
1121...
1122;;
Devang Patel80ae3492009-08-28 23:24:31 +00001123;; List of debug info of globals
Jim Laskey14edc932006-03-14 18:08:46 +00001124;;
Devang Patel80ae3492009-08-28 23:24:31 +00001125!llvm.dbg.gv = !{!0}
Jim Laskey14edc932006-03-14 18:08:46 +00001126
1127;;
1128;; Define the global variable descriptor. Note the reference to the global
1129;; variable anchor and the global variable itself.
1130;;
Devang Patel80ae3492009-08-28 23:24:31 +00001131!0 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001132 i32 524340, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001133 i32 0, ;; Unused
1134 metadata !1, ;; Context
1135 metadata !"MyGlobal", ;; Name
1136 metadata !"MyGlobal", ;; Display Name
1137 metadata !"MyGlobal", ;; Linkage Name
Devang Patel59445db2010-03-09 00:44:10 +00001138 metadata !3, ;; Compile Unit
Devang Patel80ae3492009-08-28 23:24:31 +00001139 i32 1, ;; Line Number
Devang Patel59445db2010-03-09 00:44:10 +00001140 metadata !4, ;; Type
Devang Patel80ae3492009-08-28 23:24:31 +00001141 i1 false, ;; Is a local variable
1142 i1 true, ;; Is this a definition
1143 i32* @MyGlobal ;; The global variable
1144}
1145
Jim Laskey14edc932006-03-14 18:08:46 +00001146;;
1147;; Define the basic type of 32 bit signed integer. Note that since int is an
1148;; intrinsic type the source file is NULL and line 0.
1149;;
Devang Patel59445db2010-03-09 00:44:10 +00001150!4 = metadata !{
1151 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001152 metadata !1, ;; Context
1153 metadata !"int", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001154 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001155 i32 0, ;; Line number
1156 i64 32, ;; Size in Bits
1157 i64 32, ;; Align in Bits
1158 i64 0, ;; Offset in Bits
1159 i32 0, ;; Flags
1160 i32 5 ;; Encoding
1161}
Jim Laskey14edc932006-03-14 18:08:46 +00001162
Jim Laskey14edc932006-03-14 18:08:46 +00001163</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001164</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001165
Chris Lattner941515c2004-01-06 05:31:32 +00001166</div>
Chris Lattner1811fca2004-01-05 05:06:33 +00001167
Jim Laskey14edc932006-03-14 18:08:46 +00001168<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001169<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001170 <a name="ccxx_subprogram">C/C++ function information</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001171</h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001172
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001173<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001174
Misha Brukman39dcddf2008-12-16 02:54:22 +00001175<p>Given a function declared as follows:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001176
Bill Wendlinge9353d72009-05-17 05:52:39 +00001177<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001178<pre>
1179int main(int argc, char *argv[]) {
1180 return 0;
1181}
1182</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001183</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001184
Misha Brukman39dcddf2008-12-16 02:54:22 +00001185<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001186
Bill Wendlinge9353d72009-05-17 05:52:39 +00001187<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001188<pre>
1189;;
Jim Laskey14edc932006-03-14 18:08:46 +00001190;; Define the anchor for subprograms. Note that the second field of the
1191;; anchor is 46, which is the same as the tag for subprograms
1192;; (46 = DW_TAG_subprogram.)
1193;;
Devang Patel59445db2010-03-09 00:44:10 +00001194!6 = metadata !{
1195 i32 524334, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001196 i32 0, ;; Unused
1197 metadata !1, ;; Context
1198 metadata !"main", ;; Name
1199 metadata !"main", ;; Display name
1200 metadata !"main", ;; Linkage name
Devang Patel59445db2010-03-09 00:44:10 +00001201 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001202 i32 1, ;; Line number
Devang Patel59445db2010-03-09 00:44:10 +00001203 metadata !4, ;; Type
Devang Patel80ae3492009-08-28 23:24:31 +00001204 i1 false, ;; Is local
Devang Patel9f738842011-04-05 22:52:06 +00001205 i1 true, ;; Is definition
1206 i32 0, ;; Virtuality attribute, e.g. pure virtual function
1207 i32 0, ;; Index into virtual table for C++ methods
1208 i32 0, ;; Type that holds virtual table.
1209 i32 0, ;; Flags
1210 i1 false, ;; True if this function is optimized
1211 Function *, ;; Pointer to llvm::Function
1212 null ;; Function template parameters
Devang Patel80ae3492009-08-28 23:24:31 +00001213}
Jim Laskey14edc932006-03-14 18:08:46 +00001214;;
1215;; Define the subprogram itself.
1216;;
Devang Patel80ae3492009-08-28 23:24:31 +00001217define i32 @main(i32 %argc, i8** %argv) {
Jim Laskey14edc932006-03-14 18:08:46 +00001218...
1219}
1220</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001221</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001222
1223</div>
1224
1225<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001226<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001227 <a name="ccxx_basic_types">C/C++ basic types</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001228</h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001229
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001230<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001231
Misha Brukman39dcddf2008-12-16 02:54:22 +00001232<p>The following are the basic type descriptors for C/C++ core types:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001233
Jim Laskey14edc932006-03-14 18:08:46 +00001234<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001235<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001236 <a name="ccxx_basic_type_bool">bool</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001237</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001238
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001239<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001240
Bill Wendlinge9353d72009-05-17 05:52:39 +00001241<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001242<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001243!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001244 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001245 metadata !1, ;; Context
1246 metadata !"bool", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001247 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001248 i32 0, ;; Line number
1249 i64 8, ;; Size in Bits
1250 i64 8, ;; Align in Bits
1251 i64 0, ;; Offset in Bits
1252 i32 0, ;; Flags
1253 i32 2 ;; Encoding
1254}
Jim Laskey14edc932006-03-14 18:08:46 +00001255</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001256</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001257
1258</div>
1259
1260<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001261<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001262 <a name="ccxx_basic_char">char</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001263</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001264
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001265<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001266
Bill Wendlinge9353d72009-05-17 05:52:39 +00001267<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001268<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001269!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001270 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001271 metadata !1, ;; Context
1272 metadata !"char", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001273 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001274 i32 0, ;; Line number
1275 i64 8, ;; Size in Bits
1276 i64 8, ;; Align in Bits
1277 i64 0, ;; Offset in Bits
1278 i32 0, ;; Flags
1279 i32 6 ;; Encoding
1280}
Jim Laskey14edc932006-03-14 18:08:46 +00001281</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001282</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001283
1284</div>
1285
1286<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001287<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001288 <a name="ccxx_basic_unsigned_char">unsigned char</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001289</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001290
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001291<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001292
Bill Wendlinge9353d72009-05-17 05:52:39 +00001293<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001294<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001295!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001296 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001297 metadata !1, ;; Context
1298 metadata !"unsigned char",
Devang Patel59445db2010-03-09 00:44:10 +00001299 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001300 i32 0, ;; Line number
1301 i64 8, ;; Size in Bits
1302 i64 8, ;; Align in Bits
1303 i64 0, ;; Offset in Bits
1304 i32 0, ;; Flags
1305 i32 8 ;; Encoding
1306}
Jim Laskey14edc932006-03-14 18:08:46 +00001307</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001308</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001309
1310</div>
1311
1312<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001313<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001314 <a name="ccxx_basic_short">short</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001315</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001316
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001317<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001318
Bill Wendlinge9353d72009-05-17 05:52:39 +00001319<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001320<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001321!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001322 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001323 metadata !1, ;; Context
1324 metadata !"short int",
Devang Patel59445db2010-03-09 00:44:10 +00001325 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001326 i32 0, ;; Line number
1327 i64 16, ;; Size in Bits
1328 i64 16, ;; Align in Bits
1329 i64 0, ;; Offset in Bits
1330 i32 0, ;; Flags
1331 i32 5 ;; Encoding
1332}
Jim Laskey14edc932006-03-14 18:08:46 +00001333</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001334</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001335
1336</div>
1337
1338<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001339<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001340 <a name="ccxx_basic_unsigned_short">unsigned short</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001341</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001342
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001343<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001344
Bill Wendlinge9353d72009-05-17 05:52:39 +00001345<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001346<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001347!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001348 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001349 metadata !1, ;; Context
1350 metadata !"short unsigned int",
Devang Patel59445db2010-03-09 00:44:10 +00001351 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001352 i32 0, ;; Line number
1353 i64 16, ;; Size in Bits
1354 i64 16, ;; Align in Bits
1355 i64 0, ;; Offset in Bits
1356 i32 0, ;; Flags
1357 i32 7 ;; Encoding
1358}
Jim Laskey14edc932006-03-14 18:08:46 +00001359</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001360</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001361
1362</div>
1363
1364<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001365<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001366 <a name="ccxx_basic_int">int</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001367</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001368
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001369<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001370
Bill Wendlinge9353d72009-05-17 05:52:39 +00001371<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001372<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001373!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001374 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001375 metadata !1, ;; Context
1376 metadata !"int", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001377 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001378 i32 0, ;; Line number
1379 i64 32, ;; Size in Bits
1380 i64 32, ;; Align in Bits
1381 i64 0, ;; Offset in Bits
1382 i32 0, ;; Flags
1383 i32 5 ;; Encoding
1384}
Bill Wendlinge9353d72009-05-17 05:52:39 +00001385</pre></div>
Jim Laskey14edc932006-03-14 18:08:46 +00001386
1387</div>
1388
1389<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001390<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001391 <a name="ccxx_basic_unsigned_int">unsigned int</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001392</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001393
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001394<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001395
Bill Wendlinge9353d72009-05-17 05:52:39 +00001396<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001397<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001398!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001399 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001400 metadata !1, ;; Context
1401 metadata !"unsigned int",
Devang Patel59445db2010-03-09 00:44:10 +00001402 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001403 i32 0, ;; Line number
1404 i64 32, ;; Size in Bits
1405 i64 32, ;; Align in Bits
1406 i64 0, ;; Offset in Bits
1407 i32 0, ;; Flags
1408 i32 7 ;; Encoding
1409}
Jim Laskey14edc932006-03-14 18:08:46 +00001410</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001411</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001412
1413</div>
1414
1415<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001416<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001417 <a name="ccxx_basic_long_long">long long</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001418</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001419
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001420<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001421
Bill Wendlinge9353d72009-05-17 05:52:39 +00001422<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001423<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001424!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001425 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001426 metadata !1, ;; Context
1427 metadata !"long long int",
Devang Patel59445db2010-03-09 00:44:10 +00001428 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001429 i32 0, ;; Line number
1430 i64 64, ;; Size in Bits
1431 i64 64, ;; Align in Bits
1432 i64 0, ;; Offset in Bits
1433 i32 0, ;; Flags
1434 i32 5 ;; Encoding
1435}
Jim Laskey14edc932006-03-14 18:08:46 +00001436</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001437</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001438
1439</div>
1440
1441<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001442<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001443 <a name="ccxx_basic_unsigned_long_long">unsigned long long</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001444</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001445
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001446<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001447
Bill Wendlinge9353d72009-05-17 05:52:39 +00001448<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001449<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001450!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001451 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001452 metadata !1, ;; Context
1453 metadata !"long long unsigned int",
Devang Patel59445db2010-03-09 00:44:10 +00001454 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001455 i32 0, ;; Line number
1456 i64 64, ;; Size in Bits
1457 i64 64, ;; Align in Bits
1458 i64 0, ;; Offset in Bits
1459 i32 0, ;; Flags
1460 i32 7 ;; Encoding
1461}
Jim Laskey14edc932006-03-14 18:08:46 +00001462</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001463</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001464
1465</div>
1466
1467<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001468<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001469 <a name="ccxx_basic_float">float</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001470</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001471
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001472<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001473
Bill Wendlinge9353d72009-05-17 05:52:39 +00001474<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001475<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001476!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001477 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001478 metadata !1, ;; Context
1479 metadata !"float",
Devang Patel59445db2010-03-09 00:44:10 +00001480 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001481 i32 0, ;; Line number
1482 i64 32, ;; Size in Bits
1483 i64 32, ;; Align in Bits
1484 i64 0, ;; Offset in Bits
1485 i32 0, ;; Flags
1486 i32 4 ;; Encoding
1487}
Jim Laskey14edc932006-03-14 18:08:46 +00001488</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001489</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001490
1491</div>
1492
1493<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001494<h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001495 <a name="ccxx_basic_double">double</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001496</h4>
Jim Laskey14edc932006-03-14 18:08:46 +00001497
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001498<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001499
Bill Wendlinge9353d72009-05-17 05:52:39 +00001500<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001501<pre>
Devang Patel80ae3492009-08-28 23:24:31 +00001502!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001503 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001504 metadata !1, ;; Context
1505 metadata !"double",;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001506 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001507 i32 0, ;; Line number
1508 i64 64, ;; Size in Bits
1509 i64 64, ;; Align in Bits
1510 i64 0, ;; Offset in Bits
1511 i32 0, ;; Flags
1512 i32 4 ;; Encoding
1513}
Jim Laskey14edc932006-03-14 18:08:46 +00001514</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001515</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001516
1517</div>
1518
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001519</div>
1520
Jim Laskey14edc932006-03-14 18:08:46 +00001521<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001522<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001523 <a name="ccxx_derived_types">C/C++ derived types</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001524</h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001525
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001526<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001527
Misha Brukman39dcddf2008-12-16 02:54:22 +00001528<p>Given the following as an example of C/C++ derived type:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001529
Bill Wendlinge9353d72009-05-17 05:52:39 +00001530<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001531<pre>
1532typedef const int *IntPtr;
1533</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001534</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001535
Misha Brukman39dcddf2008-12-16 02:54:22 +00001536<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001537
Bill Wendlinge9353d72009-05-17 05:52:39 +00001538<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001539<pre>
1540;;
1541;; Define the typedef "IntPtr".
1542;;
Devang Patel80ae3492009-08-28 23:24:31 +00001543!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001544 i32 524310, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001545 metadata !1, ;; Context
1546 metadata !"IntPtr", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001547 metadata !3, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001548 i32 0, ;; Line number
1549 i64 0, ;; Size in bits
1550 i64 0, ;; Align in bits
1551 i64 0, ;; Offset in bits
1552 i32 0, ;; Flags
1553 metadata !4 ;; Derived From type
1554}
Jim Laskey14edc932006-03-14 18:08:46 +00001555
1556;;
1557;; Define the pointer type.
1558;;
Devang Patel80ae3492009-08-28 23:24:31 +00001559!4 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001560 i32 524303, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001561 metadata !1, ;; Context
1562 metadata !"", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001563 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001564 i32 0, ;; Line number
1565 i64 64, ;; Size in bits
1566 i64 64, ;; Align in bits
1567 i64 0, ;; Offset in bits
1568 i32 0, ;; Flags
1569 metadata !5 ;; Derived From type
1570}
Jim Laskey14edc932006-03-14 18:08:46 +00001571;;
1572;; Define the const type.
1573;;
Devang Patel80ae3492009-08-28 23:24:31 +00001574!5 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001575 i32 524326, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001576 metadata !1, ;; Context
1577 metadata !"", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001578 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001579 i32 0, ;; Line number
1580 i64 32, ;; Size in bits
1581 i64 32, ;; Align in bits
1582 i64 0, ;; Offset in bits
1583 i32 0, ;; Flags
1584 metadata !6 ;; Derived From type
1585}
Jim Laskey14edc932006-03-14 18:08:46 +00001586;;
1587;; Define the int type.
1588;;
Devang Patel80ae3492009-08-28 23:24:31 +00001589!6 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001590 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001591 metadata !1, ;; Context
1592 metadata !"int", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001593 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001594 i32 0, ;; Line number
1595 i64 32, ;; Size in bits
1596 i64 32, ;; Align in bits
1597 i64 0, ;; Offset in bits
1598 i32 0, ;; Flags
1599 5 ;; Encoding
1600}
Jim Laskey14edc932006-03-14 18:08:46 +00001601</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001602</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001603
1604</div>
1605
1606<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001607<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001608 <a name="ccxx_composite_types">C/C++ struct/union types</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001609</h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001610
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001611<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001612
Misha Brukman39dcddf2008-12-16 02:54:22 +00001613<p>Given the following as an example of C/C++ struct type:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001614
Bill Wendlinge9353d72009-05-17 05:52:39 +00001615<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001616<pre>
1617struct Color {
1618 unsigned Red;
1619 unsigned Green;
1620 unsigned Blue;
1621};
1622</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001623</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001624
Misha Brukman39dcddf2008-12-16 02:54:22 +00001625<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001626
Bill Wendlinge9353d72009-05-17 05:52:39 +00001627<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001628<pre>
1629;;
1630;; Define basic type for unsigned int.
1631;;
Devang Patel80ae3492009-08-28 23:24:31 +00001632!5 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001633 i32 524324, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001634 metadata !1, ;; Context
1635 metadata !"unsigned int",
Devang Patel59445db2010-03-09 00:44:10 +00001636 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001637 i32 0, ;; Line number
1638 i64 32, ;; Size in Bits
1639 i64 32, ;; Align in Bits
1640 i64 0, ;; Offset in Bits
1641 i32 0, ;; Flags
1642 i32 7 ;; Encoding
1643}
Jim Laskey14edc932006-03-14 18:08:46 +00001644;;
1645;; Define composite type for struct Color.
1646;;
Devang Patel80ae3492009-08-28 23:24:31 +00001647!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001648 i32 524307, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001649 metadata !1, ;; Context
1650 metadata !"Color", ;; Name
1651 metadata !1, ;; Compile unit
1652 i32 1, ;; Line number
1653 i64 96, ;; Size in bits
1654 i64 32, ;; Align in bits
1655 i64 0, ;; Offset in bits
1656 i32 0, ;; Flags
1657 null, ;; Derived From
1658 metadata !3, ;; Elements
1659 i32 0 ;; Runtime Language
1660}
Jim Laskey14edc932006-03-14 18:08:46 +00001661
1662;;
1663;; Define the Red field.
1664;;
Devang Patel80ae3492009-08-28 23:24:31 +00001665!4 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001666 i32 524301, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001667 metadata !1, ;; Context
1668 metadata !"Red", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001669 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001670 i32 2, ;; Line number
1671 i64 32, ;; Size in bits
1672 i64 32, ;; Align in bits
1673 i64 0, ;; Offset in bits
1674 i32 0, ;; Flags
1675 metadata !5 ;; Derived From type
1676}
Jim Laskey14edc932006-03-14 18:08:46 +00001677
1678;;
1679;; Define the Green field.
1680;;
Devang Patel80ae3492009-08-28 23:24:31 +00001681!6 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001682 i32 524301, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001683 metadata !1, ;; Context
1684 metadata !"Green", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001685 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001686 i32 3, ;; Line number
1687 i64 32, ;; Size in bits
1688 i64 32, ;; Align in bits
1689 i64 32, ;; Offset in bits
1690 i32 0, ;; Flags
1691 metadata !5 ;; Derived From type
1692}
Jim Laskey14edc932006-03-14 18:08:46 +00001693
1694;;
1695;; Define the Blue field.
1696;;
Devang Patel80ae3492009-08-28 23:24:31 +00001697!7 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001698 i32 524301, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001699 metadata !1, ;; Context
1700 metadata !"Blue", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001701 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001702 i32 4, ;; Line number
1703 i64 32, ;; Size in bits
1704 i64 32, ;; Align in bits
1705 i64 64, ;; Offset in bits
1706 i32 0, ;; Flags
1707 metadata !5 ;; Derived From type
1708}
Jim Laskey14edc932006-03-14 18:08:46 +00001709
1710;;
1711;; Define the array of fields used by the composite type Color.
1712;;
Devang Patel80ae3492009-08-28 23:24:31 +00001713!3 = metadata !{metadata !4, metadata !6, metadata !7}
Jim Laskey14edc932006-03-14 18:08:46 +00001714</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001715</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001716
1717</div>
1718
1719<!-- ======================================================================= -->
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001720<h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001721 <a name="ccxx_enumeration_types">C/C++ enumeration types</a>
NAKAMURA Takumifc8d9302011-04-18 23:59:50 +00001722</h3>
Jim Laskey14edc932006-03-14 18:08:46 +00001723
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001724<div>
Jim Laskey14edc932006-03-14 18:08:46 +00001725
Misha Brukman39dcddf2008-12-16 02:54:22 +00001726<p>Given the following as an example of C/C++ enumeration type:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001727
Bill Wendlinge9353d72009-05-17 05:52:39 +00001728<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001729<pre>
1730enum Trees {
1731 Spruce = 100,
1732 Oak = 200,
1733 Maple = 300
1734};
1735</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001736</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001737
Misha Brukman39dcddf2008-12-16 02:54:22 +00001738<p>a C/C++ front-end would generate the following descriptors:</p>
Jim Laskey14edc932006-03-14 18:08:46 +00001739
Bill Wendlinge9353d72009-05-17 05:52:39 +00001740<div class="doc_code">
Jim Laskey14edc932006-03-14 18:08:46 +00001741<pre>
1742;;
1743;; Define composite type for enum Trees
1744;;
Devang Patel80ae3492009-08-28 23:24:31 +00001745!2 = metadata !{
Devang Patel59445db2010-03-09 00:44:10 +00001746 i32 524292, ;; Tag
Devang Patel80ae3492009-08-28 23:24:31 +00001747 metadata !1, ;; Context
1748 metadata !"Trees", ;; Name
Devang Patel59445db2010-03-09 00:44:10 +00001749 metadata !1, ;; File
Devang Patel80ae3492009-08-28 23:24:31 +00001750 i32 1, ;; Line number
1751 i64 32, ;; Size in bits
1752 i64 32, ;; Align in bits
1753 i64 0, ;; Offset in bits
1754 i32 0, ;; Flags
1755 null, ;; Derived From type
1756 metadata !3, ;; Elements
1757 i32 0 ;; Runtime language
1758}
Devang Patel02aac922009-08-25 05:24:07 +00001759
Devang Patelf08e35d2009-08-26 05:01:18 +00001760;;
1761;; Define the array of enumerators used by composite type Trees.
1762;;
Devang Patel80ae3492009-08-28 23:24:31 +00001763!3 = metadata !{metadata !4, metadata !5, metadata !6}
1764
1765;;
1766;; Define Spruce enumerator.
1767;;
Devang Patel59445db2010-03-09 00:44:10 +00001768!4 = metadata !{i32 524328, metadata !"Spruce", i64 100}
Devang Patel80ae3492009-08-28 23:24:31 +00001769
1770;;
1771;; Define Oak enumerator.
1772;;
Devang Patel59445db2010-03-09 00:44:10 +00001773!5 = metadata !{i32 524328, metadata !"Oak", i64 200}
Devang Patel80ae3492009-08-28 23:24:31 +00001774
1775;;
1776;; Define Maple enumerator.
1777;;
Devang Patel59445db2010-03-09 00:44:10 +00001778!6 = metadata !{i32 524328, metadata !"Maple", i64 300}
Devang Patel80ae3492009-08-28 23:24:31 +00001779
Jim Laskey14edc932006-03-14 18:08:46 +00001780</pre>
Bill Wendlinge9353d72009-05-17 05:52:39 +00001781</div>
Jim Laskey14edc932006-03-14 18:08:46 +00001782
1783</div>
Chris Lattner1811fca2004-01-05 05:06:33 +00001784
NAKAMURA Takumiaa3d6242011-04-23 00:30:22 +00001785</div>
1786
Chris Lattner1811fca2004-01-05 05:06:33 +00001787<!-- *********************************************************************** -->
Misha Brukmanf91d9942004-05-12 19:21:57 +00001788
Chris Lattner1811fca2004-01-05 05:06:33 +00001789<hr>
Misha Brukmanf91d9942004-05-12 19:21:57 +00001790<address>
1791 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +00001792 src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
Misha Brukmanf91d9942004-05-12 19:21:57 +00001793 <a href="http://validator.w3.org/check/referer"><img
Misha Brukman86242e12008-12-11 17:34:48 +00001794 src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
Misha Brukmanf91d9942004-05-12 19:21:57 +00001795
1796 <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
NAKAMURA Takumica46f5a2011-04-09 02:13:37 +00001797 <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
Chris Lattner1811fca2004-01-05 05:06:33 +00001798 Last modified: $Date$
Misha Brukmanf91d9942004-05-12 19:21:57 +00001799</address>
Chris Lattner1811fca2004-01-05 05:06:33 +00001800
1801</body>
1802</html>