Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <html> |
| 4 | <head> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 5 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 6 | <title>Source Level Debugging with LLVM</title> |
| 7 | <link rel="stylesheet" href="llvm.css" type="text/css"> |
| 8 | </head> |
| 9 | <body> |
| 10 | |
| 11 | <div class="doc_title">Source Level Debugging with LLVM</div> |
| 12 | |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 13 | <table class="layout" style="width:100%"> |
| 14 | <tr class="layout"> |
| 15 | <td class="left"> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 16 | <ul> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 17 | <li><a href="#introduction">Introduction</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 18 | <ol> |
| 19 | <li><a href="#phil">Philosophy behind LLVM debugging information</a></li> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 20 | <li><a href="#consumers">Debug information consumers</a></li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 21 | <li><a href="#debugopt">Debugging optimized code</a></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 22 | </ol></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 23 | <li><a href="#format">Debugging information format</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 24 | <ol> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 25 | <li><a href="#debug_info_descriptors">Debug information descriptors</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 26 | <ul> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 27 | <li><a href="#format_compile_units">Compile unit descriptors</a></li> |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 28 | <li><a href="#format_files">File descriptors</a></li> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 29 | <li><a href="#format_global_variables">Global variable descriptors</a></li> |
| 30 | <li><a href="#format_subprograms">Subprogram descriptors</a></li> |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 31 | <li><a href="#format_blocks">Block descriptors</a></li> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 32 | <li><a href="#format_basic_type">Basic type descriptors</a></li> |
| 33 | <li><a href="#format_derived_type">Derived type descriptors</a></li> |
| 34 | <li><a href="#format_composite_type">Composite type descriptors</a></li> |
| 35 | <li><a href="#format_subrange">Subrange descriptors</a></li> |
| 36 | <li><a href="#format_enumeration">Enumerator descriptors</a></li> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 37 | <li><a href="#format_variables">Local variables</a></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 38 | </ul></li> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 39 | <li><a href="#format_common_intrinsics">Debugger intrinsic functions</a> |
| 40 | <ul> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 41 | <li><a href="#format_common_declare">llvm.dbg.declare</a></li> |
Victor Hernandez | 67a1a54 | 2010-01-11 22:53:48 +0000 | [diff] [blame] | 42 | <li><a href="#format_common_value">llvm.dbg.value</a></li> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 43 | </ul></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 44 | </ol></li> |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 45 | <li><a href="#format_common_lifetime">Object lifetimes and scoping</a></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 46 | <li><a href="#ccxx_frontend">C/C++ front-end specific debug information</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 47 | <ol> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 48 | <li><a href="#ccxx_compile_units">C/C++ source file information</a></li> |
| 49 | <li><a href="#ccxx_global_variable">C/C++ global variable information</a></li> |
| 50 | <li><a href="#ccxx_subprogram">C/C++ function information</a></li> |
| 51 | <li><a href="#ccxx_basic_types">C/C++ basic types</a></li> |
| 52 | <li><a href="#ccxx_derived_types">C/C++ derived types</a></li> |
| 53 | <li><a href="#ccxx_composite_types">C/C++ struct/union types</a></li> |
| 54 | <li><a href="#ccxx_enumeration_types">C/C++ enumeration types</a></li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 55 | </ol></li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 56 | </ul> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 57 | </td> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 58 | <td class="right"> |
Misha Brukman | e849a1a | 2004-05-12 21:26:16 +0000 | [diff] [blame] | 59 | <img src="img/venusflytrap.jpg" alt="A leafy and green bug eater" width="247" |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 60 | height="369"> |
| 61 | </td> |
Reid Spencer | d3f876c | 2004-11-01 08:19:36 +0000 | [diff] [blame] | 62 | </tr></table> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 63 | |
Chris Lattner | 7911ce2 | 2004-05-23 21:07:27 +0000 | [diff] [blame] | 64 | <div class="doc_author"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 65 | <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a> |
Jim Laskey | c760a92 | 2007-03-14 19:32:21 +0000 | [diff] [blame] | 66 | and <a href="mailto:jlaskey@mac.com">Jim Laskey</a></p> |
Chris Lattner | 7911ce2 | 2004-05-23 21:07:27 +0000 | [diff] [blame] | 67 | </div> |
| 68 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 69 | |
| 70 | <!-- *********************************************************************** --> |
Misha Brukman | 94218a7 | 2004-12-09 20:27:37 +0000 | [diff] [blame] | 71 | <div class="doc_section"><a name="introduction">Introduction</a></div> |
| 72 | <!-- *********************************************************************** --> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 73 | |
| 74 | <div class="doc_text"> |
| 75 | |
| 76 | <p>This document is the central repository for all information pertaining to |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 77 | debug information in LLVM. It describes the <a href="#format">actual format |
| 78 | that the LLVM debug information</a> takes, which is useful for those |
| 79 | interested in creating front-ends or dealing directly with the information. |
Chris Lattner | 8ad2f98 | 2009-07-18 21:47:15 +0000 | [diff] [blame] | 80 | Further, this document provides specific examples of what debug information |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 81 | for C/C++.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 82 | |
| 83 | </div> |
| 84 | |
| 85 | <!-- ======================================================================= --> |
| 86 | <div class="doc_subsection"> |
| 87 | <a name="phil">Philosophy behind LLVM debugging information</a> |
| 88 | </div> |
| 89 | |
| 90 | <div class="doc_text"> |
| 91 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 92 | <p>The idea of the LLVM debugging information is to capture how the important |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 93 | pieces of the source-language's Abstract Syntax Tree map onto LLVM code. |
| 94 | Several design aspects have shaped the solution that appears here. The |
| 95 | important ones are:</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 96 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 97 | <ul> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 98 | <li>Debugging information should have very little impact on the rest of the |
| 99 | compiler. No transformations, analyses, or code generators should need to |
| 100 | be modified because of debugging information.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 101 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 102 | <li>LLVM optimizations should interact in <a href="#debugopt">well-defined and |
| 103 | easily described ways</a> with the debugging information.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 104 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 105 | <li>Because LLVM is designed to support arbitrary programming languages, |
| 106 | LLVM-to-LLVM tools should not need to know anything about the semantics of |
| 107 | the source-level-language.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 108 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 109 | <li>Source-level languages are often <b>widely</b> different from one another. |
| 110 | LLVM should not put any restrictions of the flavor of the source-language, |
| 111 | and the debugging information should work with any language.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 112 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 113 | <li>With code generator support, it should be possible to use an LLVM compiler |
| 114 | to compile a program to native machine code and standard debugging |
| 115 | formats. This allows compatibility with traditional machine-code level |
| 116 | debuggers, like GDB or DBX.</li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 117 | </ul> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 118 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 119 | <p>The approach used by the LLVM implementation is to use a small set |
| 120 | of <a href="#format_common_intrinsics">intrinsic functions</a> to define a |
| 121 | mapping between LLVM program objects and the source-level objects. The |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 122 | description of the source-level program is maintained in LLVM metadata |
| 123 | in an <a href="#ccxx_frontend">implementation-defined format</a> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 124 | (the C/C++ front-end currently uses working draft 7 of |
| 125 | the <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3 |
| 126 | standard</a>).</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 127 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 128 | <p>When a program is being debugged, a debugger interacts with the user and |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 129 | turns the stored debug information into source-language specific information. |
| 130 | As such, a debugger must be aware of the source-language, and is thus tied to |
| 131 | a specific language or family of languages.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 132 | |
| 133 | </div> |
| 134 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 135 | <!-- ======================================================================= --> |
| 136 | <div class="doc_subsection"> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 137 | <a name="consumers">Debug information consumers</a> |
| 138 | </div> |
| 139 | |
| 140 | <div class="doc_text"> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 141 | |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 142 | <p>The role of debug information is to provide meta information normally |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 143 | stripped away during the compilation process. This meta information provides |
| 144 | an LLVM user a relationship between generated code and the original program |
| 145 | source code.</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 146 | |
Chris Lattner | c310778 | 2010-04-05 04:11:11 +0000 | [diff] [blame^] | 147 | <p>Currently, debug information is consumed by DwarfDebug to produce dwarf |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 148 | information used by the gdb debugger. Other targets could use the same |
| 149 | information to produce stabs or other debug forms.</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 150 | |
| 151 | <p>It would also be reasonable to use debug information to feed profiling tools |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 152 | for analysis of generated code, or, tools for reconstructing the original |
| 153 | source from generated code.</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 154 | |
| 155 | <p>TODO - expound a bit more.</p> |
| 156 | |
| 157 | </div> |
| 158 | |
| 159 | <!-- ======================================================================= --> |
| 160 | <div class="doc_subsection"> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 161 | <a name="debugopt">Debugging optimized code</a> |
| 162 | </div> |
| 163 | |
| 164 | <div class="doc_text"> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 165 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 166 | <p>An extremely high priority of LLVM debugging information is to make it |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 167 | interact well with optimizations and analysis. In particular, the LLVM debug |
| 168 | information provides the following guarantees:</p> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 169 | |
| 170 | <ul> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 171 | <li>LLVM debug information <b>always provides information to accurately read |
| 172 | the source-level state of the program</b>, regardless of which LLVM |
| 173 | optimizations have been run, and without any modification to the |
| 174 | optimizations themselves. However, some optimizations may impact the |
| 175 | ability to modify the current state of the program with a debugger, such |
| 176 | as setting program variables, or calling functions that have been |
| 177 | deleted.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 178 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 179 | <li>LLVM optimizations gracefully interact with debugging information. If |
| 180 | they are not aware of debug information, they are automatically disabled |
| 181 | as necessary in the cases that would invalidate the debug info. This |
| 182 | retains the LLVM features, making it easy to write new |
| 183 | transformations.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 184 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 185 | <li>As desired, LLVM optimizations can be upgraded to be aware of the LLVM |
| 186 | debugging information, allowing them to update the debugging information |
| 187 | as they perform aggressive optimizations. This means that, with effort, |
| 188 | the LLVM optimizers could optimize debug code just as well as non-debug |
| 189 | code.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 190 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 191 | <li>LLVM debug information does not prevent many important optimizations from |
| 192 | happening (for example inlining, basic block reordering/merging/cleanup, |
| 193 | tail duplication, etc), further reducing the amount of the compiler that |
| 194 | eventually is "aware" of debugging information.</li> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 195 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 196 | <li>LLVM debug information is automatically optimized along with the rest of |
| 197 | the program, using existing facilities. For example, duplicate |
| 198 | information is automatically merged by the linker, and unused information |
| 199 | is automatically removed.</li> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 200 | </ul> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 201 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 202 | <p>Basically, the debug information allows you to compile a program with |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 203 | "<tt>-O0 -g</tt>" and get full debug information, allowing you to arbitrarily |
| 204 | modify the program as it executes from a debugger. Compiling a program with |
| 205 | "<tt>-O3 -g</tt>" gives you full debug information that is always available |
| 206 | and accurate for reading (e.g., you get accurate stack traces despite tail |
| 207 | call elimination and inlining), but you might lose the ability to modify the |
| 208 | program and call functions where were optimized out of the program, or |
| 209 | inlined away completely.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 210 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 211 | <p><a href="TestingGuide.html#quicktestsuite">LLVM test suite</a> provides a |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 212 | framework to test optimizer's handling of debugging information. It can be |
| 213 | run like this:</p> |
Devang Patel | a5c05aa | 2008-11-21 19:35:57 +0000 | [diff] [blame] | 214 | |
| 215 | <div class="doc_code"> |
| 216 | <pre> |
| 217 | % cd llvm/projects/test-suite/MultiSource/Benchmarks # or some other level |
| 218 | % make TEST=dbgopt |
| 219 | </pre> |
| 220 | </div> |
| 221 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 222 | <p>This will test impact of debugging information on optimization passes. If |
| 223 | debugging information influences optimization passes then it will be reported |
| 224 | as a failure. See <a href="TestingGuide.html">TestingGuide</a> for more |
| 225 | information on LLVM test infrastructure and how to run various tests.</p> |
Devang Patel | a5c05aa | 2008-11-21 19:35:57 +0000 | [diff] [blame] | 226 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 227 | </div> |
| 228 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 229 | <!-- *********************************************************************** --> |
| 230 | <div class="doc_section"> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 231 | <a name="format">Debugging information format</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 232 | </div> |
| 233 | <!-- *********************************************************************** --> |
| 234 | |
| 235 | <div class="doc_text"> |
| 236 | |
| 237 | <p>LLVM debugging information has been carefully designed to make it possible |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 238 | for the optimizer to optimize the program and debugging information without |
| 239 | necessarily having to know anything about debugging information. In |
John Criswell | b34500f | 2010-03-17 15:01:50 +0000 | [diff] [blame] | 240 | particular, the use of metadata avoids duplicated debugging information from |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 241 | the beginning, and the global dead code elimination pass automatically |
| 242 | deletes debugging information for a function if it decides to delete the |
| 243 | function. </p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 244 | |
| 245 | <p>To do this, most of the debugging information (descriptors for types, |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 246 | variables, functions, source files, etc) is inserted by the language |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 247 | front-end in the form of LLVM metadata. </p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 248 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 249 | <p>Debug information is designed to be agnostic about the target debugger and |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 250 | debugging information representation (e.g. DWARF/Stabs/etc). It uses a |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 251 | generic pass to decode the information that represents variables, types, |
| 252 | functions, namespaces, etc: this allows for arbitrary source-language |
| 253 | semantics and type-systems to be used, as long as there is a module |
| 254 | written for the target debugger to interpret the information. </p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 255 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 256 | <p>To provide basic functionality, the LLVM debugger does have to make some |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 257 | assumptions about the source-level language being debugged, though it keeps |
| 258 | these to a minimum. The only common features that the LLVM debugger assumes |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 259 | exist are <a href="#format_files">source files</a>, |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 260 | and <a href="#format_global_variables">program objects</a>. These abstract |
| 261 | objects are used by a debugger to form stack traces, show information about |
| 262 | local variables, etc.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 263 | |
| 264 | <p>This section of the documentation first describes the representation aspects |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 265 | common to any source-language. The <a href="#ccxx_frontend">next section</a> |
| 266 | describes the data layout conventions used by the C and C++ front-ends.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 267 | |
| 268 | </div> |
| 269 | |
| 270 | <!-- ======================================================================= --> |
| 271 | <div class="doc_subsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 272 | <a name="debug_info_descriptors">Debug information descriptors</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 273 | </div> |
| 274 | |
| 275 | <div class="doc_text"> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 276 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 277 | <p>In consideration of the complexity and volume of debug information, LLVM |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 278 | provides a specification for well formed debug descriptors. </p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 279 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 280 | <p>Consumers of LLVM debug information expect the descriptors for program |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 281 | objects to start in a canonical format, but the descriptors can include |
| 282 | additional information appended at the end that is source-language |
| 283 | specific. All LLVM debugging information is versioned, allowing backwards |
| 284 | compatibility in the case that the core structures need to change in some |
| 285 | way. Also, all debugging information objects start with a tag to indicate |
| 286 | what type of object it is. The source-language is allowed to define its own |
| 287 | objects, by using unreserved tag numbers. We recommend using with tags in |
Benjamin Kramer | 8040cd3 | 2009-10-12 14:46:08 +0000 | [diff] [blame] | 288 | the range 0x1000 through 0x2000 (there is a defined enum DW_TAG_user_base = |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 289 | 0x1000.)</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 290 | |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 291 | <p>The fields of debug descriptors used internally by LLVM |
Nick Lewycky | 655fd03 | 2010-03-31 07:50:17 +0000 | [diff] [blame] | 292 | are restricted to only the simple data types <tt>i32</tt>, <tt>i1</tt>, |
| 293 | <tt>float</tt>, <tt>double</tt>, <tt>mdstring</tt> and <tt>mdnode</tt>. </p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 294 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 295 | <div class="doc_code"> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 296 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 297 | !1 = metadata !{ |
Nick Lewycky | 655fd03 | 2010-03-31 07:50:17 +0000 | [diff] [blame] | 298 | i32, ;; A tag |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 299 | ... |
| 300 | } |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 301 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 302 | </div> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 303 | |
Jim Laskey | 7089f45 | 2006-06-16 13:14:03 +0000 | [diff] [blame] | 304 | <p><a name="LLVMDebugVersion">The first field of a descriptor is always an |
Nick Lewycky | 655fd03 | 2010-03-31 07:50:17 +0000 | [diff] [blame] | 305 | <tt>i32</tt> containing a tag value identifying the content of the |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 306 | descriptor. The remaining fields are specific to the descriptor. The values |
| 307 | of tags are loosely bound to the tag values of DWARF information entries. |
| 308 | However, that does not restrict the use of the information supplied to DWARF |
| 309 | targets. To facilitate versioning of debug information, the tag is augmented |
Nick Lewycky | 655fd03 | 2010-03-31 07:50:17 +0000 | [diff] [blame] | 310 | with the current debug version (LLVMDebugVersion = 8 << 16 or 0x80000 or |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 311 | 524288.)</a></p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 312 | |
Jim Laskey | 7089f45 | 2006-06-16 13:14:03 +0000 | [diff] [blame] | 313 | <p>The details of the various descriptors follow.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 314 | |
| 315 | </div> |
| 316 | |
| 317 | <!-- ======================================================================= --> |
| 318 | <div class="doc_subsubsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 319 | <a name="format_compile_units">Compile unit descriptors</a> |
| 320 | </div> |
| 321 | |
| 322 | <div class="doc_text"> |
| 323 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 324 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 325 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 326 | !0 = metadata !{ |
| 327 | i32, ;; Tag = 17 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 328 | ;; (DW_TAG_compile_unit) |
| 329 | i32, ;; Unused field. |
| 330 | i32, ;; DWARF language identifier (ex. DW_LANG_C89) |
| 331 | metadata, ;; Source file name |
| 332 | metadata, ;; Source file directory (includes trailing slash) |
| 333 | metadata ;; Producer (ex. "4.0.1 LLVM (LLVM research group)") |
| 334 | i1, ;; True if this is a main compile unit. |
| 335 | i1, ;; True if this is optimized. |
| 336 | metadata, ;; Flags |
| 337 | i32 ;; Runtime version |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 338 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 339 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 340 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 341 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 342 | <p>These descriptors contain a source language ID for the file (we use the DWARF |
| 343 | 3.0 ID numbers, such as <tt>DW_LANG_C89</tt>, <tt>DW_LANG_C_plus_plus</tt>, |
| 344 | <tt>DW_LANG_Cobol74</tt>, etc), three strings describing the filename, |
| 345 | working directory of the compiler, and an identifier string for the compiler |
| 346 | that produced it.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 347 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 348 | <p>Compile unit descriptors provide the root context for objects declared in a |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 349 | specific compilation unit. File descriptors are defined using this context.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 350 | |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 351 | </div> |
| 352 | |
| 353 | <!-- ======================================================================= --> |
| 354 | <div class="doc_subsubsection"> |
| 355 | <a name="format_files">File descriptors</a> |
| 356 | </div> |
| 357 | |
| 358 | <div class="doc_text"> |
| 359 | |
| 360 | <div class="doc_code"> |
| 361 | <pre> |
| 362 | !0 = metadata !{ |
| 363 | i32, ;; Tag = 41 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 364 | ;; (DW_TAG_file_type) |
| 365 | metadata, ;; Source file name |
| 366 | metadata, ;; Source file directory (includes trailing slash) |
| 367 | metadata ;; Reference to compile unit where defined |
| 368 | } |
| 369 | </pre> |
| 370 | </div> |
| 371 | |
John Criswell | b34500f | 2010-03-17 15:01:50 +0000 | [diff] [blame] | 372 | <p>These descriptors contain information for a file. Global variables and top |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 373 | level functions would be defined using this context.k File descriptors also |
| 374 | provide context for source line correspondence. </p> |
| 375 | |
| 376 | <p>Each input file is encoded as a separate file descriptor in LLVM debugging |
| 377 | information output. Each file descriptor would be defined using a |
| 378 | compile unit. </p> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 379 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 380 | </div> |
| 381 | |
| 382 | <!-- ======================================================================= --> |
| 383 | <div class="doc_subsubsection"> |
| 384 | <a name="format_global_variables">Global variable descriptors</a> |
| 385 | </div> |
| 386 | |
| 387 | <div class="doc_text"> |
| 388 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 389 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 390 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 391 | !1 = metadata !{ |
| 392 | i32, ;; Tag = 52 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 393 | ;; (DW_TAG_variable) |
| 394 | i32, ;; Unused field. |
| 395 | metadata, ;; Reference to context descriptor |
| 396 | metadata, ;; Name |
| 397 | metadata, ;; Display name (fully qualified C++ name) |
| 398 | metadata, ;; MIPS linkage name (for C++) |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 399 | metadata, ;; Reference to file where defined |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 400 | i32, ;; Line number where defined |
| 401 | metadata, ;; Reference to type descriptor |
| 402 | i1, ;; True if the global is local to compile unit (static) |
| 403 | i1, ;; True if the global is defined in the compile unit (not extern) |
| 404 | { }* ;; Reference to the global variable |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 405 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 406 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 407 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 408 | |
| 409 | <p>These descriptors provide debug information about globals variables. The |
| 410 | provide details such as name, type and where the variable is defined.</p> |
| 411 | |
| 412 | </div> |
| 413 | |
| 414 | <!-- ======================================================================= --> |
| 415 | <div class="doc_subsubsection"> |
| 416 | <a name="format_subprograms">Subprogram descriptors</a> |
| 417 | </div> |
| 418 | |
| 419 | <div class="doc_text"> |
| 420 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 421 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 422 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 423 | !2 = metadata !{ |
| 424 | i32, ;; Tag = 46 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 425 | ;; (DW_TAG_subprogram) |
| 426 | i32, ;; Unused field. |
| 427 | metadata, ;; Reference to context descriptor |
| 428 | metadata, ;; Name |
| 429 | metadata, ;; Display name (fully qualified C++ name) |
| 430 | metadata, ;; MIPS linkage name (for C++) |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 431 | metadata, ;; Reference to file where defined |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 432 | i32, ;; Line number where defined |
| 433 | metadata, ;; Reference to type descriptor |
| 434 | i1, ;; True if the global is local to compile unit (static) |
| 435 | i1 ;; True if the global is defined in the compile unit (not extern) |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 436 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 437 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 438 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 439 | |
| 440 | <p>These descriptors provide debug information about functions, methods and |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 441 | subprograms. They provide details such as name, return types and the source |
| 442 | location where the subprogram is defined.</p> |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 443 | |
| 444 | </div> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 445 | |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 446 | <!-- ======================================================================= --> |
| 447 | <div class="doc_subsubsection"> |
| 448 | <a name="format_blocks">Block descriptors</a> |
| 449 | </div> |
| 450 | |
| 451 | <div class="doc_text"> |
| 452 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 453 | <div class="doc_code"> |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 454 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 455 | !3 = metadata !{ |
| 456 | i32, ;; Tag = 13 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_lexical_block) |
| 457 | metadata ;; Reference to context descriptor |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 458 | } |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 459 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 460 | </div> |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 461 | |
| 462 | <p>These descriptors provide debug information about nested blocks within a |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 463 | subprogram. The array of member descriptors is used to define local |
| 464 | variables and deeper nested blocks.</p> |
Jim Laskey | 3d11bee | 2006-03-15 19:10:52 +0000 | [diff] [blame] | 465 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 466 | </div> |
| 467 | |
| 468 | <!-- ======================================================================= --> |
| 469 | <div class="doc_subsubsection"> |
| 470 | <a name="format_basic_type">Basic type descriptors</a> |
| 471 | </div> |
| 472 | |
| 473 | <div class="doc_text"> |
| 474 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 475 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 476 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 477 | !4 = metadata !{ |
| 478 | i32, ;; Tag = 36 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 479 | ;; (DW_TAG_base_type) |
| 480 | metadata, ;; Reference to context (typically a compile unit) |
| 481 | metadata, ;; Name (may be "" for anonymous types) |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 482 | metadata, ;; Reference to file where defined (may be NULL) |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 483 | i32, ;; Line number where defined (may be 0) |
| 484 | i64, ;; Size in bits |
| 485 | i64, ;; Alignment in bits |
| 486 | i64, ;; Offset in bits |
| 487 | i32, ;; Flags |
| 488 | i32 ;; DWARF type encoding |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 489 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 490 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 491 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 492 | |
| 493 | <p>These descriptors define primitive types used in the code. Example int, bool |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 494 | and float. The context provides the scope of the type, which is usually the |
| 495 | top level. Since basic types are not usually user defined the compile unit |
| 496 | and line number can be left as NULL and 0. The size, alignment and offset |
| 497 | are expressed in bits and can be 64 bit values. The alignment is used to |
| 498 | round the offset when embedded in a |
| 499 | <a href="#format_composite_type">composite type</a> (example to keep float |
| 500 | doubles on 64 bit boundaries.) The offset is the bit offset if embedded in |
| 501 | a <a href="#format_composite_type">composite type</a>.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 502 | |
| 503 | <p>The type encoding provides the details of the type. The values are typically |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 504 | one of the following:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 505 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 506 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 507 | <pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 508 | DW_ATE_address = 1 |
| 509 | DW_ATE_boolean = 2 |
| 510 | DW_ATE_float = 4 |
| 511 | DW_ATE_signed = 5 |
| 512 | DW_ATE_signed_char = 6 |
| 513 | DW_ATE_unsigned = 7 |
| 514 | DW_ATE_unsigned_char = 8 |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 515 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 516 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 517 | |
| 518 | </div> |
| 519 | |
| 520 | <!-- ======================================================================= --> |
| 521 | <div class="doc_subsubsection"> |
| 522 | <a name="format_derived_type">Derived type descriptors</a> |
| 523 | </div> |
| 524 | |
| 525 | <div class="doc_text"> |
| 526 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 527 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 528 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 529 | !5 = metadata !{ |
| 530 | i32, ;; Tag (see below) |
| 531 | metadata, ;; Reference to context |
| 532 | metadata, ;; Name (may be "" for anonymous types) |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 533 | metadata, ;; Reference to file where defined (may be NULL) |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 534 | i32, ;; Line number where defined (may be 0) |
| 535 | i32, ;; Size in bits |
| 536 | i32, ;; Alignment in bits |
| 537 | i32, ;; Offset in bits |
| 538 | metadata ;; Reference to type derived from |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 539 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 540 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 541 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 542 | |
| 543 | <p>These descriptors are used to define types derived from other types. The |
| 544 | value of the tag varies depending on the meaning. The following are possible |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 545 | tag values:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 546 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 547 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 548 | <pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 549 | DW_TAG_formal_parameter = 5 |
| 550 | DW_TAG_member = 13 |
| 551 | DW_TAG_pointer_type = 15 |
| 552 | DW_TAG_reference_type = 16 |
| 553 | DW_TAG_typedef = 22 |
| 554 | DW_TAG_const_type = 38 |
| 555 | DW_TAG_volatile_type = 53 |
| 556 | DW_TAG_restrict_type = 55 |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 557 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 558 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 559 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 560 | <p><tt>DW_TAG_member</tt> is used to define a member of |
| 561 | a <a href="#format_composite_type">composite type</a> |
| 562 | or <a href="#format_subprograms">subprogram</a>. The type of the member is |
| 563 | the <a href="#format_derived_type">derived |
| 564 | type</a>. <tt>DW_TAG_formal_parameter</tt> is used to define a member which |
| 565 | is a formal argument of a subprogram.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 566 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 567 | <p><tt>DW_TAG_typedef</tt> is used to provide a name for the derived type.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 568 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 569 | <p><tt>DW_TAG_pointer_type</tt>,<tt>DW_TAG_reference_type</tt>, |
| 570 | <tt>DW_TAG_const_type</tt>, <tt>DW_TAG_volatile_type</tt> |
| 571 | and <tt>DW_TAG_restrict_type</tt> are used to qualify |
| 572 | the <a href="#format_derived_type">derived type</a>. </p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 573 | |
| 574 | <p><a href="#format_derived_type">Derived type</a> location can be determined |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 575 | from the compile unit and line number. The size, alignment and offset are |
| 576 | expressed in bits and can be 64 bit values. The alignment is used to round |
| 577 | the offset when embedded in a <a href="#format_composite_type">composite |
| 578 | type</a> (example to keep float doubles on 64 bit boundaries.) The offset is |
| 579 | the bit offset if embedded in a <a href="#format_composite_type">composite |
| 580 | type</a>.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 581 | |
| 582 | <p>Note that the <tt>void *</tt> type is expressed as a |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 583 | <tt>llvm.dbg.derivedtype.type</tt> with tag of <tt>DW_TAG_pointer_type</tt> |
| 584 | and <tt>NULL</tt> derived type.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 585 | |
| 586 | </div> |
| 587 | |
| 588 | <!-- ======================================================================= --> |
| 589 | <div class="doc_subsubsection"> |
| 590 | <a name="format_composite_type">Composite type descriptors</a> |
| 591 | </div> |
| 592 | |
| 593 | <div class="doc_text"> |
| 594 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 595 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 596 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 597 | !6 = metadata !{ |
| 598 | i32, ;; Tag (see below) |
| 599 | metadata, ;; Reference to context |
| 600 | metadata, ;; Name (may be "" for anonymous types) |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 601 | metadata, ;; Reference to file where defined (may be NULL) |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 602 | i32, ;; Line number where defined (may be 0) |
| 603 | i64, ;; Size in bits |
| 604 | i64, ;; Alignment in bits |
| 605 | i64, ;; Offset in bits |
| 606 | i32, ;; Flags |
| 607 | metadata, ;; Reference to type derived from |
| 608 | metadata, ;; Reference to array of member descriptors |
| 609 | i32 ;; Runtime languages |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 610 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 611 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 612 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 613 | |
| 614 | <p>These descriptors are used to define types that are composed of 0 or more |
| 615 | elements. The value of the tag varies depending on the meaning. The following |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 616 | are possible tag values:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 617 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 618 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 619 | <pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 620 | DW_TAG_array_type = 1 |
| 621 | DW_TAG_enumeration_type = 4 |
| 622 | DW_TAG_structure_type = 19 |
| 623 | DW_TAG_union_type = 23 |
| 624 | DW_TAG_vector_type = 259 |
Bruno Cardoso Lopes | d80ddc0 | 2009-05-29 17:08:57 +0000 | [diff] [blame] | 625 | DW_TAG_subroutine_type = 21 |
| 626 | DW_TAG_inheritance = 28 |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 627 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 628 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 629 | |
Jim Laskey | f8a01a9 | 2006-06-15 20:51:43 +0000 | [diff] [blame] | 630 | <p>The vector flag indicates that an array type is a native packed vector.</p> |
| 631 | |
Jim Laskey | 7089f45 | 2006-06-16 13:14:03 +0000 | [diff] [blame] | 632 | <p>The members of array types (tag = <tt>DW_TAG_array_type</tt>) or vector types |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 633 | (tag = <tt>DW_TAG_vector_type</tt>) are <a href="#format_subrange">subrange |
| 634 | descriptors</a>, each representing the range of subscripts at that level of |
| 635 | indexing.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 636 | |
| 637 | <p>The members of enumeration types (tag = <tt>DW_TAG_enumeration_type</tt>) are |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 638 | <a href="#format_enumeration">enumerator descriptors</a>, each representing |
| 639 | the definition of enumeration value for the set.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 640 | |
| 641 | <p>The members of structure (tag = <tt>DW_TAG_structure_type</tt>) or union (tag |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 642 | = <tt>DW_TAG_union_type</tt>) types are any one of |
| 643 | the <a href="#format_basic_type">basic</a>, |
| 644 | <a href="#format_derived_type">derived</a> |
| 645 | or <a href="#format_composite_type">composite</a> type descriptors, each |
| 646 | representing a field member of the structure or union.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 647 | |
Jim Laskey | 4a9df24 | 2006-08-21 21:21:06 +0000 | [diff] [blame] | 648 | <p>For C++ classes (tag = <tt>DW_TAG_structure_type</tt>), member descriptors |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 649 | provide information about base classes, static members and member |
| 650 | functions. If a member is a <a href="#format_derived_type">derived type |
| 651 | descriptor</a> and has a tag of <tt>DW_TAG_inheritance</tt>, then the type |
| 652 | represents a base class. If the member of is |
| 653 | a <a href="#format_global_variables">global variable descriptor</a> then it |
| 654 | represents a static member. And, if the member is |
| 655 | a <a href="#format_subprograms">subprogram descriptor</a> then it represents |
| 656 | a member function. For static members and member |
| 657 | functions, <tt>getName()</tt> returns the members link or the C++ mangled |
| 658 | name. <tt>getDisplayName()</tt> the simplied version of the name.</p> |
Jim Laskey | 4a9df24 | 2006-08-21 21:21:06 +0000 | [diff] [blame] | 659 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 660 | <p>The first member of subroutine (tag = <tt>DW_TAG_subroutine_type</tt>) type |
| 661 | elements is the return type for the subroutine. The remaining elements are |
| 662 | the formal arguments to the subroutine.</p> |
Jim Laskey | 094ee72 | 2006-06-20 21:13:20 +0000 | [diff] [blame] | 663 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 664 | <p><a href="#format_composite_type">Composite type</a> location can be |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 665 | determined from the compile unit and line number. The size, alignment and |
| 666 | offset are expressed in bits and can be 64 bit values. The alignment is used |
| 667 | to round the offset when embedded in |
| 668 | a <a href="#format_composite_type">composite type</a> (as an example, to keep |
| 669 | float doubles on 64 bit boundaries.) The offset is the bit offset if embedded |
| 670 | in a <a href="#format_composite_type">composite type</a>.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 671 | |
| 672 | </div> |
| 673 | |
| 674 | <!-- ======================================================================= --> |
| 675 | <div class="doc_subsubsection"> |
| 676 | <a name="format_subrange">Subrange descriptors</a> |
| 677 | </div> |
| 678 | |
| 679 | <div class="doc_text"> |
| 680 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 681 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 682 | <pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 683 | %<a href="#format_subrange">llvm.dbg.subrange.type</a> = type { |
| 684 | i32, ;; Tag = 33 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> (DW_TAG_subrange_type) |
| 685 | i64, ;; Low value |
| 686 | i64 ;; High value |
| 687 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 688 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 689 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 690 | |
| 691 | <p>These descriptors are used to define ranges of array subscripts for an array |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 692 | <a href="#format_composite_type">composite type</a>. The low value defines |
| 693 | the lower bounds typically zero for C/C++. The high value is the upper |
| 694 | bounds. Values are 64 bit. High - low + 1 is the size of the array. If low |
| 695 | == high the array will be unbounded.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 696 | |
| 697 | </div> |
| 698 | |
| 699 | <!-- ======================================================================= --> |
| 700 | <div class="doc_subsubsection"> |
| 701 | <a name="format_enumeration">Enumerator descriptors</a> |
| 702 | </div> |
| 703 | |
| 704 | <div class="doc_text"> |
| 705 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 706 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 707 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 708 | !6 = metadata !{ |
| 709 | i32, ;; Tag = 40 + <a href="#LLVMDebugVersion">LLVMDebugVersion</a> |
| 710 | ;; (DW_TAG_enumerator) |
| 711 | metadata, ;; Name |
| 712 | i64 ;; Value |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 713 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 714 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 715 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 716 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 717 | <p>These descriptors are used to define members of an |
| 718 | enumeration <a href="#format_composite_type">composite type</a>, it |
| 719 | associates the name to the value.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 720 | |
| 721 | </div> |
| 722 | |
| 723 | <!-- ======================================================================= --> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 724 | <div class="doc_subsubsection"> |
| 725 | <a name="format_variables">Local variables</a> |
| 726 | </div> |
| 727 | |
| 728 | <div class="doc_text"> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 729 | |
| 730 | <div class="doc_code"> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 731 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 732 | !7 = metadata !{ |
| 733 | i32, ;; Tag (see below) |
| 734 | metadata, ;; Context |
| 735 | metadata, ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 736 | metadata, ;; Reference to file where defined |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 737 | i32, ;; Line number where defined |
| 738 | metadata ;; Type descriptor |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 739 | } |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 740 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 741 | </div> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 742 | |
| 743 | <p>These descriptors are used to define variables local to a sub program. The |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 744 | value of the tag depends on the usage of the variable:</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 745 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 746 | <div class="doc_code"> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 747 | <pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 748 | DW_TAG_auto_variable = 256 |
| 749 | DW_TAG_arg_variable = 257 |
| 750 | DW_TAG_return_variable = 258 |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 751 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 752 | </div> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 753 | |
| 754 | <p>An auto variable is any variable declared in the body of the function. An |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 755 | argument variable is any variable that appears as a formal argument to the |
| 756 | function. A return variable is used to track the result of a function and |
| 757 | has no source correspondent.</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 758 | |
Jim Laskey | 2d395d9 | 2006-03-24 09:20:27 +0000 | [diff] [blame] | 759 | <p>The context is either the subprogram or block where the variable is defined. |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 760 | Name the source variable name. Compile unit and line indicate where the |
| 761 | variable was defined. Type descriptor defines the declared type of the |
| 762 | variable.</p> |
Jim Laskey | 383e009 | 2006-03-23 17:54:33 +0000 | [diff] [blame] | 763 | |
| 764 | </div> |
| 765 | |
| 766 | <!-- ======================================================================= --> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 767 | <div class="doc_subsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 768 | <a name="format_common_intrinsics">Debugger intrinsic functions</a> |
| 769 | </div> |
| 770 | |
| 771 | <div class="doc_text"> |
| 772 | |
| 773 | <p>LLVM uses several intrinsic functions (name prefixed with "llvm.dbg") to |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 774 | provide debug information at various points in generated code.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 775 | |
| 776 | </div> |
| 777 | |
| 778 | <!-- ======================================================================= --> |
| 779 | <div class="doc_subsubsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 780 | <a name="format_common_declare">llvm.dbg.declare</a> |
| 781 | </div> |
| 782 | |
| 783 | <div class="doc_text"> |
| 784 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 785 | void %<a href="#format_common_declare">llvm.dbg.declare</a>( { } *, metadata ) |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 786 | </pre> |
| 787 | |
Jim Laskey | 2d395d9 | 2006-03-24 09:20:27 +0000 | [diff] [blame] | 788 | <p>This intrinsic provides information about a local element (ex. variable.) The |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 789 | first argument is the alloca for the variable, cast to a <tt>{ }*</tt>. The |
| 790 | second argument is |
| 791 | the <tt>%<a href="#format_variables">llvm.dbg.variable</a></tt> containing |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 792 | the description of the variable. </p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 793 | |
| 794 | </div> |
| 795 | |
| 796 | <!-- ======================================================================= --> |
Victor Hernandez | 67a1a54 | 2010-01-11 22:53:48 +0000 | [diff] [blame] | 797 | <div class="doc_subsubsection"> |
| 798 | <a name="format_common_value">llvm.dbg.value</a> |
| 799 | </div> |
| 800 | |
| 801 | <div class="doc_text"> |
| 802 | <pre> |
| 803 | void %<a href="#format_common_value">llvm.dbg.value</a>( metadata, i64, metadata ) |
| 804 | </pre> |
| 805 | |
| 806 | <p>This intrinsic provides information when a user source variable is set to a |
| 807 | new value. The first argument is the new value (wrapped as metadata). The |
| 808 | second argument is the offset in the user source variable where the new value |
| 809 | is written. The third argument is |
| 810 | the <tt>%<a href="#format_variables">llvm.dbg.variable</a></tt> containing |
| 811 | the description of the user source variable. </p> |
| 812 | |
| 813 | </div> |
| 814 | |
| 815 | <!-- ======================================================================= --> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 816 | <div class="doc_subsection"> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 817 | <a name="format_common_lifetime">Object lifetimes and scoping</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 818 | </div> |
| 819 | |
| 820 | <div class="doc_text"> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 821 | <p>In many languages, the local variables in functions can have their lifetimes |
| 822 | or scopes limited to a subset of a function. In the C family of languages, |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 823 | for example, variables are only live (readable and writable) within the |
| 824 | source block that they are defined in. In functional languages, values are |
| 825 | only readable after they have been defined. Though this is a very obvious |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 826 | concept, it is non-trivial to model in LLVM, because it has no notion of |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 827 | scoping in this sense, and does not want to be tied to a language's scoping |
| 828 | rules.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 829 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 830 | <p>In order to handle this, the LLVM debug format uses the metadata attached to |
Nick Lewycky | 655fd03 | 2010-03-31 07:50:17 +0000 | [diff] [blame] | 831 | llvm instructions to encode line number and scoping information. Consider |
| 832 | the following C fragment, for example:</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 833 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 834 | <div class="doc_code"> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 835 | <pre> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 836 | 1. void foo() { |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 837 | 2. int X = 21; |
| 838 | 3. int Y = 22; |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 839 | 4. { |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 840 | 5. int Z = 23; |
| 841 | 6. Z = X; |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 842 | 7. } |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 843 | 8. X = Y; |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 844 | 9. } |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 845 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 846 | </div> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 847 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 848 | <p>Compiled to LLVM, this function would be represented like this:</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 849 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 850 | <div class="doc_code"> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 851 | <pre> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 852 | define void @foo() nounwind ssp { |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 853 | entry: |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 854 | %X = alloca i32, align 4 ; <i32*> [#uses=4] |
| 855 | %Y = alloca i32, align 4 ; <i32*> [#uses=4] |
| 856 | %Z = alloca i32, align 4 ; <i32*> [#uses=3] |
| 857 | %0 = bitcast i32* %X to { }* ; <{ }*> [#uses=1] |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 858 | call void @llvm.dbg.declare({ }* %0, metadata !0), !dbg !7 |
| 859 | store i32 21, i32* %X, !dbg !8 |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 860 | %1 = bitcast i32* %Y to { }* ; <{ }*> [#uses=1] |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 861 | call void @llvm.dbg.declare({ }* %1, metadata !9), !dbg !10 |
| 862 | store i32 22, i32* %Y, !dbg !11 |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 863 | %2 = bitcast i32* %Z to { }* ; <{ }*> [#uses=1] |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 864 | call void @llvm.dbg.declare({ }* %2, metadata !12), !dbg !14 |
| 865 | store i32 23, i32* %Z, !dbg !15 |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 866 | %tmp = load i32* %X, !dbg !16 ; <i32> [#uses=1] |
| 867 | %tmp1 = load i32* %Y, !dbg !16 ; <i32> [#uses=1] |
| 868 | %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; <i32> [#uses=1] |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 869 | store i32 %add, i32* %Z, !dbg !16 |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 870 | %tmp2 = load i32* %Y, !dbg !17 ; <i32> [#uses=1] |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 871 | store i32 %tmp2, i32* %X, !dbg !17 |
| 872 | ret void, !dbg !18 |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 873 | } |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 874 | |
| 875 | declare void @llvm.dbg.declare({ }*, metadata) nounwind readnone |
| 876 | |
| 877 | !0 = metadata !{i32 459008, metadata !1, metadata !"X", |
| 878 | metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ] |
| 879 | !1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ] |
| 880 | !2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", metadata !"foo", |
| 881 | metadata !"foo", metadata !3, i32 1, metadata !4, |
| 882 | i1 false, i1 true}; [DW_TAG_subprogram ] |
| 883 | !3 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", |
| 884 | metadata !"/private/tmp", metadata !"clang 1.1", i1 true, |
| 885 | i1 false, metadata !"", i32 0}; [DW_TAG_compile_unit ] |
| 886 | !4 = metadata !{i32 458773, metadata !3, metadata !"", null, i32 0, i64 0, i64 0, |
| 887 | i64 0, i32 0, null, metadata !5, i32 0}; [DW_TAG_subroutine_type ] |
| 888 | !5 = metadata !{null} |
| 889 | !6 = metadata !{i32 458788, metadata !3, metadata !"int", metadata !3, i32 0, |
| 890 | i64 32, i64 32, i64 0, i32 0, i32 5}; [DW_TAG_base_type ] |
| 891 | !7 = metadata !{i32 2, i32 7, metadata !1, null} |
| 892 | !8 = metadata !{i32 2, i32 3, metadata !1, null} |
| 893 | !9 = metadata !{i32 459008, metadata !1, metadata !"Y", metadata !3, i32 3, |
| 894 | metadata !6}; [ DW_TAG_auto_variable ] |
| 895 | !10 = metadata !{i32 3, i32 7, metadata !1, null} |
| 896 | !11 = metadata !{i32 3, i32 3, metadata !1, null} |
| 897 | !12 = metadata !{i32 459008, metadata !13, metadata !"Z", metadata !3, i32 5, |
| 898 | metadata !6}; [ DW_TAG_auto_variable ] |
| 899 | !13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ] |
| 900 | !14 = metadata !{i32 5, i32 9, metadata !13, null} |
| 901 | !15 = metadata !{i32 5, i32 5, metadata !13, null} |
| 902 | !16 = metadata !{i32 6, i32 5, metadata !13, null} |
| 903 | !17 = metadata !{i32 8, i32 3, metadata !1, null} |
| 904 | !18 = metadata !{i32 9, i32 1, metadata !2, null} |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 905 | </pre> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 906 | </div> |
| 907 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 908 | <p>This example illustrates a few important details about LLVM debugging |
| 909 | information. In particular, it shows how the <tt>llvm.dbg.declare</tt> |
| 910 | intrinsic and location information, which are attached to an instruction, |
| 911 | are applied together to allow a debugger to analyze the relationship between |
| 912 | statements, variable definitions, and the code used to implement the |
| 913 | function.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 914 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 915 | <div class="doc_code"> |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 916 | <pre> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 917 | call void @llvm.dbg.declare({ }* %0, metadata !0), !dbg !7 |
| 918 | </pre> |
| 919 | </div> |
| 920 | |
| 921 | <p>The first intrinsic |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 922 | <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 923 | encodes debugging information for the variable <tt>X</tt>. The metadata |
| 924 | <tt>!dbg !7</tt> attached to the intrinsic provides scope information for the |
| 925 | variable <tt>X</tt>.</p> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 926 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 927 | <div class="doc_code"> |
| 928 | <pre> |
| 929 | !7 = metadata !{i32 2, i32 7, metadata !1, null} |
| 930 | !1 = metadata !{i32 458763, metadata !2}; [DW_TAG_lexical_block ] |
| 931 | !2 = metadata !{i32 458798, i32 0, metadata !3, metadata !"foo", |
| 932 | metadata !"foo", metadata !"foo", metadata !3, i32 1, |
| 933 | metadata !4, i1 false, i1 true}; [DW_TAG_subprogram ] |
| 934 | </pre> |
| 935 | </div> |
| 936 | |
| 937 | <p>Here <tt>!7</tt> is metadata providing location information. It has four |
| 938 | fields: line number, column number, scope, and original scope. The original |
| 939 | scope represents inline location if this instruction is inlined inside a |
| 940 | caller, and is null otherwise. In this example, scope is encoded by |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 941 | <tt>!1</tt>. <tt>!1</tt> represents a lexical block inside the scope |
| 942 | <tt>!2</tt>, where <tt>!2</tt> is a |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 943 | <a href="#format_subprograms">subprogram descriptor</a>. This way the |
| 944 | location information attached to the intrinsics indicates that the |
| 945 | variable <tt>X</tt> is declared at line number 2 at a function level scope in |
| 946 | function <tt>foo</tt>.</p> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 947 | |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 948 | <p>Now lets take another example.</p> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 949 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 950 | <div class="doc_code"> |
Bill Wendling | 02216ff | 2009-12-01 00:59:58 +0000 | [diff] [blame] | 951 | <pre> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 952 | call void @llvm.dbg.declare({ }* %2, metadata !12), !dbg !14 |
| 953 | </pre> |
| 954 | </div> |
| 955 | |
| 956 | <p>The second intrinsic |
Devang Patel | 744950d | 2009-11-25 23:28:01 +0000 | [diff] [blame] | 957 | <tt>%<a href="#format_common_declare">llvm.dbg.declare</a></tt> |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 958 | encodes debugging information for variable <tt>Z</tt>. The metadata |
| 959 | <tt>!dbg !14</tt> attached to the intrinsic provides scope information for |
| 960 | the variable <tt>Z</tt>.</p> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 961 | |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 962 | <div class="doc_code"> |
| 963 | <pre> |
| 964 | !13 = metadata !{i32 458763, metadata !1}; [DW_TAG_lexical_block ] |
| 965 | !14 = metadata !{i32 5, i32 9, metadata !13, null} |
| 966 | </pre> |
| 967 | </div> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 968 | |
John Criswell | b34500f | 2010-03-17 15:01:50 +0000 | [diff] [blame] | 969 | <p>Here <tt>!14</tt> indicates that <tt>Z</tt> is declared at line number 5 and |
Bill Wendling | cf493b8 | 2009-12-01 00:53:11 +0000 | [diff] [blame] | 970 | column number 9 inside of lexical scope <tt>!13</tt>. The lexical scope |
| 971 | itself resides inside of lexical scope <tt>!1</tt> described above.</p> |
| 972 | |
| 973 | <p>The scope information attached with each instruction provides a |
| 974 | straightforward way to find instructions covered by a scope.</p> |
| 975 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 976 | </div> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 977 | |
| 978 | <!-- *********************************************************************** --> |
| 979 | <div class="doc_section"> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 980 | <a name="ccxx_frontend">C/C++ front-end specific debug information</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 981 | </div> |
Misha Brukman | 94218a7 | 2004-12-09 20:27:37 +0000 | [diff] [blame] | 982 | <!-- *********************************************************************** --> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 983 | |
| 984 | <div class="doc_text"> |
| 985 | |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 986 | <p>The C and C++ front-ends represent information about the program in a format |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 987 | that is effectively identical |
| 988 | to <a href="http://www.eagercon.com/dwarf/dwarf3std.htm">DWARF 3.0</a> in |
| 989 | terms of information content. This allows code generators to trivially |
| 990 | support native debuggers by generating standard dwarf information, and |
| 991 | contains enough information for non-dwarf targets to translate it as |
| 992 | needed.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 993 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 994 | <p>This section describes the forms used to represent C and C++ programs. Other |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 995 | languages could pattern themselves after this (which itself is tuned to |
| 996 | representing programs in the same way that DWARF 3 does), or they could |
| 997 | choose to provide completely different forms if they don't fit into the DWARF |
| 998 | model. As support for debugging information gets added to the various LLVM |
| 999 | source-language front-ends, the information used should be documented |
| 1000 | here.</p> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1001 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1002 | <p>The following sections provide examples of various C/C++ constructs and the |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1003 | debug information that would best describe those constructs.</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1004 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1005 | </div> |
| 1006 | |
| 1007 | <!-- ======================================================================= --> |
| 1008 | <div class="doc_subsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1009 | <a name="ccxx_compile_units">C/C++ source file information</a> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1010 | </div> |
| 1011 | |
| 1012 | <div class="doc_text"> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1013 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1014 | <p>Given the source files <tt>MySource.cpp</tt> and <tt>MyHeader.h</tt> located |
| 1015 | in the directory <tt>/Users/mine/sources</tt>, the following code:</p> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1016 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1017 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1018 | <pre> |
| 1019 | #include "MyHeader.h" |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1020 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1021 | int main(int argc, char *argv[]) { |
| 1022 | return 0; |
| 1023 | } |
| 1024 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1025 | </div> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1026 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1027 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1028 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1029 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1030 | <pre> |
| 1031 | ... |
| 1032 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1033 | ;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp". |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1034 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1035 | !2 = metadata !{ |
| 1036 | i32 524305, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1037 | i32 0, ;; Unused |
| 1038 | i32 4, ;; Language Id |
| 1039 | metadata !"MySource.cpp", |
| 1040 | metadata !"/Users/mine/sources", |
| 1041 | metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)", |
| 1042 | i1 true, ;; Main Compile Unit |
| 1043 | i1 false, ;; Optimized compile unit |
| 1044 | metadata !"", ;; Compiler flags |
| 1045 | i32 0} ;; Runtime version |
| 1046 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1047 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1048 | ;; Define the file for the file "/Users/mine/sources/MySource.cpp". |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1049 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1050 | !1 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1051 | i32 524329, ;; Tag |
| 1052 | metadata !"MySource.cpp", |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1053 | metadata !"/Users/mine/sources", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1054 | metadata !3 ;; Compile unit |
| 1055 | } |
| 1056 | |
| 1057 | ;; |
| 1058 | ;; Define the file for the file "/Users/mine/sources/Myheader.h" |
| 1059 | ;; |
| 1060 | !3 = metadata !{ |
| 1061 | i32 524329, ;; Tag |
| 1062 | metadata !"Myheader.h" |
| 1063 | metadata !"/Users/mine/sources", |
| 1064 | metadata !3 ;; Compile unit |
| 1065 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1066 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1067 | ... |
| 1068 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1069 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1070 | |
Devang Patel | d98ec5f | 2010-03-26 19:08:36 +0000 | [diff] [blame] | 1071 | <p>llvm::Instruction provides easy access to metadata attached with an |
| 1072 | instruction. One can extract line number information encoded in LLVM IR |
| 1073 | using <tt>Instruction::getMetadata()</tt> and |
| 1074 | <tt>DILocation::getLineNumber()</tt>. |
| 1075 | <pre> |
| 1076 | if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction |
| 1077 | DILocation Loc(N); // DILocation is in DebugInfo.h |
| 1078 | unsigned Line = Loc.getLineNumber(); |
| 1079 | StringRef File = Loc.getFilename(); |
| 1080 | StringRef Dir = Loc.getDirectory(); |
| 1081 | } |
| 1082 | </pre> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1083 | </div> |
| 1084 | |
| 1085 | <!-- ======================================================================= --> |
| 1086 | <div class="doc_subsection"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1087 | <a name="ccxx_global_variable">C/C++ global variable information</a> |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1088 | </div> |
| 1089 | |
| 1090 | <div class="doc_text"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1091 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1092 | <p>Given an integer global variable declared as follows:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1093 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1094 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1095 | <pre> |
| 1096 | int MyGlobal = 100; |
| 1097 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1098 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1099 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1100 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1101 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1102 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1103 | <pre> |
| 1104 | ;; |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1105 | ;; Define the global itself. |
| 1106 | ;; |
| 1107 | %MyGlobal = global int 100 |
| 1108 | ... |
| 1109 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1110 | ;; List of debug info of globals |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1111 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1112 | !llvm.dbg.gv = !{!0} |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1113 | |
| 1114 | ;; |
| 1115 | ;; Define the global variable descriptor. Note the reference to the global |
| 1116 | ;; variable anchor and the global variable itself. |
| 1117 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1118 | !0 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1119 | i32 524340, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1120 | i32 0, ;; Unused |
| 1121 | metadata !1, ;; Context |
| 1122 | metadata !"MyGlobal", ;; Name |
| 1123 | metadata !"MyGlobal", ;; Display Name |
| 1124 | metadata !"MyGlobal", ;; Linkage Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1125 | metadata !3, ;; Compile Unit |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1126 | i32 1, ;; Line Number |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1127 | metadata !4, ;; Type |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1128 | i1 false, ;; Is a local variable |
| 1129 | i1 true, ;; Is this a definition |
| 1130 | i32* @MyGlobal ;; The global variable |
| 1131 | } |
| 1132 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1133 | ;; |
| 1134 | ;; Define the basic type of 32 bit signed integer. Note that since int is an |
| 1135 | ;; intrinsic type the source file is NULL and line 0. |
| 1136 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1137 | !4 = metadata !{ |
| 1138 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1139 | metadata !1, ;; Context |
| 1140 | metadata !"int", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1141 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1142 | i32 0, ;; Line number |
| 1143 | i64 32, ;; Size in Bits |
| 1144 | i64 32, ;; Align in Bits |
| 1145 | i64 0, ;; Offset in Bits |
| 1146 | i32 0, ;; Flags |
| 1147 | i32 5 ;; Encoding |
| 1148 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1149 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1150 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1151 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1152 | |
Chris Lattner | 8ff7590 | 2004-01-06 05:31:32 +0000 | [diff] [blame] | 1153 | </div> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1154 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1155 | <!-- ======================================================================= --> |
| 1156 | <div class="doc_subsection"> |
| 1157 | <a name="ccxx_subprogram">C/C++ function information</a> |
| 1158 | </div> |
| 1159 | |
| 1160 | <div class="doc_text"> |
| 1161 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1162 | <p>Given a function declared as follows:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1163 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1164 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1165 | <pre> |
| 1166 | int main(int argc, char *argv[]) { |
| 1167 | return 0; |
| 1168 | } |
| 1169 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1170 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1171 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1172 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1173 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1174 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1175 | <pre> |
| 1176 | ;; |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1177 | ;; Define the anchor for subprograms. Note that the second field of the |
| 1178 | ;; anchor is 46, which is the same as the tag for subprograms |
| 1179 | ;; (46 = DW_TAG_subprogram.) |
| 1180 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1181 | !6 = metadata !{ |
| 1182 | i32 524334, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1183 | i32 0, ;; Unused |
| 1184 | metadata !1, ;; Context |
| 1185 | metadata !"main", ;; Name |
| 1186 | metadata !"main", ;; Display name |
| 1187 | metadata !"main", ;; Linkage name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1188 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1189 | i32 1, ;; Line number |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1190 | metadata !4, ;; Type |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1191 | i1 false, ;; Is local |
| 1192 | i1 true ;; Is definition |
| 1193 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1194 | ;; |
| 1195 | ;; Define the subprogram itself. |
| 1196 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1197 | define i32 @main(i32 %argc, i8** %argv) { |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1198 | ... |
| 1199 | } |
| 1200 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1201 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1202 | |
| 1203 | </div> |
| 1204 | |
| 1205 | <!-- ======================================================================= --> |
| 1206 | <div class="doc_subsection"> |
| 1207 | <a name="ccxx_basic_types">C/C++ basic types</a> |
| 1208 | </div> |
| 1209 | |
| 1210 | <div class="doc_text"> |
| 1211 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1212 | <p>The following are the basic type descriptors for C/C++ core types:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1213 | |
| 1214 | </div> |
| 1215 | |
| 1216 | <!-- ======================================================================= --> |
| 1217 | <div class="doc_subsubsection"> |
| 1218 | <a name="ccxx_basic_type_bool">bool</a> |
| 1219 | </div> |
| 1220 | |
| 1221 | <div class="doc_text"> |
| 1222 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1223 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1224 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1225 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1226 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1227 | metadata !1, ;; Context |
| 1228 | metadata !"bool", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1229 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1230 | i32 0, ;; Line number |
| 1231 | i64 8, ;; Size in Bits |
| 1232 | i64 8, ;; Align in Bits |
| 1233 | i64 0, ;; Offset in Bits |
| 1234 | i32 0, ;; Flags |
| 1235 | i32 2 ;; Encoding |
| 1236 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1237 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1238 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1239 | |
| 1240 | </div> |
| 1241 | |
| 1242 | <!-- ======================================================================= --> |
| 1243 | <div class="doc_subsubsection"> |
| 1244 | <a name="ccxx_basic_char">char</a> |
| 1245 | </div> |
| 1246 | |
| 1247 | <div class="doc_text"> |
| 1248 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1249 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1250 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1251 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1252 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1253 | metadata !1, ;; Context |
| 1254 | metadata !"char", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1255 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1256 | i32 0, ;; Line number |
| 1257 | i64 8, ;; Size in Bits |
| 1258 | i64 8, ;; Align in Bits |
| 1259 | i64 0, ;; Offset in Bits |
| 1260 | i32 0, ;; Flags |
| 1261 | i32 6 ;; Encoding |
| 1262 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1263 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1264 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1265 | |
| 1266 | </div> |
| 1267 | |
| 1268 | <!-- ======================================================================= --> |
| 1269 | <div class="doc_subsubsection"> |
| 1270 | <a name="ccxx_basic_unsigned_char">unsigned char</a> |
| 1271 | </div> |
| 1272 | |
| 1273 | <div class="doc_text"> |
| 1274 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1275 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1276 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1277 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1278 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1279 | metadata !1, ;; Context |
| 1280 | metadata !"unsigned char", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1281 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1282 | i32 0, ;; Line number |
| 1283 | i64 8, ;; Size in Bits |
| 1284 | i64 8, ;; Align in Bits |
| 1285 | i64 0, ;; Offset in Bits |
| 1286 | i32 0, ;; Flags |
| 1287 | i32 8 ;; Encoding |
| 1288 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1289 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1290 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1291 | |
| 1292 | </div> |
| 1293 | |
| 1294 | <!-- ======================================================================= --> |
| 1295 | <div class="doc_subsubsection"> |
| 1296 | <a name="ccxx_basic_short">short</a> |
| 1297 | </div> |
| 1298 | |
| 1299 | <div class="doc_text"> |
| 1300 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1301 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1302 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1303 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1304 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1305 | metadata !1, ;; Context |
| 1306 | metadata !"short int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1307 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1308 | i32 0, ;; Line number |
| 1309 | i64 16, ;; Size in Bits |
| 1310 | i64 16, ;; Align in Bits |
| 1311 | i64 0, ;; Offset in Bits |
| 1312 | i32 0, ;; Flags |
| 1313 | i32 5 ;; Encoding |
| 1314 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1315 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1316 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1317 | |
| 1318 | </div> |
| 1319 | |
| 1320 | <!-- ======================================================================= --> |
| 1321 | <div class="doc_subsubsection"> |
| 1322 | <a name="ccxx_basic_unsigned_short">unsigned short</a> |
| 1323 | </div> |
| 1324 | |
| 1325 | <div class="doc_text"> |
| 1326 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1327 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1328 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1329 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1330 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1331 | metadata !1, ;; Context |
| 1332 | metadata !"short unsigned int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1333 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1334 | i32 0, ;; Line number |
| 1335 | i64 16, ;; Size in Bits |
| 1336 | i64 16, ;; Align in Bits |
| 1337 | i64 0, ;; Offset in Bits |
| 1338 | i32 0, ;; Flags |
| 1339 | i32 7 ;; Encoding |
| 1340 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1341 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1342 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1343 | |
| 1344 | </div> |
| 1345 | |
| 1346 | <!-- ======================================================================= --> |
| 1347 | <div class="doc_subsubsection"> |
| 1348 | <a name="ccxx_basic_int">int</a> |
| 1349 | </div> |
| 1350 | |
| 1351 | <div class="doc_text"> |
| 1352 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1353 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1354 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1355 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1356 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1357 | metadata !1, ;; Context |
| 1358 | metadata !"int", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1359 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1360 | i32 0, ;; Line number |
| 1361 | i64 32, ;; Size in Bits |
| 1362 | i64 32, ;; Align in Bits |
| 1363 | i64 0, ;; Offset in Bits |
| 1364 | i32 0, ;; Flags |
| 1365 | i32 5 ;; Encoding |
| 1366 | } |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1367 | </pre></div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1368 | |
| 1369 | </div> |
| 1370 | |
| 1371 | <!-- ======================================================================= --> |
| 1372 | <div class="doc_subsubsection"> |
| 1373 | <a name="ccxx_basic_unsigned_int">unsigned int</a> |
| 1374 | </div> |
| 1375 | |
| 1376 | <div class="doc_text"> |
| 1377 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1378 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1379 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1380 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1381 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1382 | metadata !1, ;; Context |
| 1383 | metadata !"unsigned int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1384 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1385 | i32 0, ;; Line number |
| 1386 | i64 32, ;; Size in Bits |
| 1387 | i64 32, ;; Align in Bits |
| 1388 | i64 0, ;; Offset in Bits |
| 1389 | i32 0, ;; Flags |
| 1390 | i32 7 ;; Encoding |
| 1391 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1392 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1393 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1394 | |
| 1395 | </div> |
| 1396 | |
| 1397 | <!-- ======================================================================= --> |
| 1398 | <div class="doc_subsubsection"> |
| 1399 | <a name="ccxx_basic_long_long">long long</a> |
| 1400 | </div> |
| 1401 | |
| 1402 | <div class="doc_text"> |
| 1403 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1404 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1405 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1406 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1407 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1408 | metadata !1, ;; Context |
| 1409 | metadata !"long long int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1410 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1411 | i32 0, ;; Line number |
| 1412 | i64 64, ;; Size in Bits |
| 1413 | i64 64, ;; Align in Bits |
| 1414 | i64 0, ;; Offset in Bits |
| 1415 | i32 0, ;; Flags |
| 1416 | i32 5 ;; Encoding |
| 1417 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1418 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1419 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1420 | |
| 1421 | </div> |
| 1422 | |
| 1423 | <!-- ======================================================================= --> |
| 1424 | <div class="doc_subsubsection"> |
| 1425 | <a name="ccxx_basic_unsigned_long_long">unsigned long long</a> |
| 1426 | </div> |
| 1427 | |
| 1428 | <div class="doc_text"> |
| 1429 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1430 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1431 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1432 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1433 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1434 | metadata !1, ;; Context |
| 1435 | metadata !"long long unsigned int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1436 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1437 | i32 0, ;; Line number |
| 1438 | i64 64, ;; Size in Bits |
| 1439 | i64 64, ;; Align in Bits |
| 1440 | i64 0, ;; Offset in Bits |
| 1441 | i32 0, ;; Flags |
| 1442 | i32 7 ;; Encoding |
| 1443 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1444 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1445 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1446 | |
| 1447 | </div> |
| 1448 | |
| 1449 | <!-- ======================================================================= --> |
| 1450 | <div class="doc_subsubsection"> |
| 1451 | <a name="ccxx_basic_float">float</a> |
| 1452 | </div> |
| 1453 | |
| 1454 | <div class="doc_text"> |
| 1455 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1456 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1457 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1458 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1459 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1460 | metadata !1, ;; Context |
| 1461 | metadata !"float", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1462 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1463 | i32 0, ;; Line number |
| 1464 | i64 32, ;; Size in Bits |
| 1465 | i64 32, ;; Align in Bits |
| 1466 | i64 0, ;; Offset in Bits |
| 1467 | i32 0, ;; Flags |
| 1468 | i32 4 ;; Encoding |
| 1469 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1470 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1471 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1472 | |
| 1473 | </div> |
| 1474 | |
| 1475 | <!-- ======================================================================= --> |
| 1476 | <div class="doc_subsubsection"> |
| 1477 | <a name="ccxx_basic_double">double</a> |
| 1478 | </div> |
| 1479 | |
| 1480 | <div class="doc_text"> |
| 1481 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1482 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1483 | <pre> |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1484 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1485 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1486 | metadata !1, ;; Context |
| 1487 | metadata !"double",;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1488 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1489 | i32 0, ;; Line number |
| 1490 | i64 64, ;; Size in Bits |
| 1491 | i64 64, ;; Align in Bits |
| 1492 | i64 0, ;; Offset in Bits |
| 1493 | i32 0, ;; Flags |
| 1494 | i32 4 ;; Encoding |
| 1495 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1496 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1497 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1498 | |
| 1499 | </div> |
| 1500 | |
| 1501 | <!-- ======================================================================= --> |
| 1502 | <div class="doc_subsection"> |
| 1503 | <a name="ccxx_derived_types">C/C++ derived types</a> |
| 1504 | </div> |
| 1505 | |
| 1506 | <div class="doc_text"> |
| 1507 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1508 | <p>Given the following as an example of C/C++ derived type:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1509 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1510 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1511 | <pre> |
| 1512 | typedef const int *IntPtr; |
| 1513 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1514 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1515 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1516 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1517 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1518 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1519 | <pre> |
| 1520 | ;; |
| 1521 | ;; Define the typedef "IntPtr". |
| 1522 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1523 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1524 | i32 524310, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1525 | metadata !1, ;; Context |
| 1526 | metadata !"IntPtr", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1527 | metadata !3, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1528 | i32 0, ;; Line number |
| 1529 | i64 0, ;; Size in bits |
| 1530 | i64 0, ;; Align in bits |
| 1531 | i64 0, ;; Offset in bits |
| 1532 | i32 0, ;; Flags |
| 1533 | metadata !4 ;; Derived From type |
| 1534 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1535 | |
| 1536 | ;; |
| 1537 | ;; Define the pointer type. |
| 1538 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1539 | !4 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1540 | i32 524303, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1541 | metadata !1, ;; Context |
| 1542 | metadata !"", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1543 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1544 | i32 0, ;; Line number |
| 1545 | i64 64, ;; Size in bits |
| 1546 | i64 64, ;; Align in bits |
| 1547 | i64 0, ;; Offset in bits |
| 1548 | i32 0, ;; Flags |
| 1549 | metadata !5 ;; Derived From type |
| 1550 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1551 | ;; |
| 1552 | ;; Define the const type. |
| 1553 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1554 | !5 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1555 | i32 524326, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1556 | metadata !1, ;; Context |
| 1557 | metadata !"", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1558 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1559 | i32 0, ;; Line number |
| 1560 | i64 32, ;; Size in bits |
| 1561 | i64 32, ;; Align in bits |
| 1562 | i64 0, ;; Offset in bits |
| 1563 | i32 0, ;; Flags |
| 1564 | metadata !6 ;; Derived From type |
| 1565 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1566 | ;; |
| 1567 | ;; Define the int type. |
| 1568 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1569 | !6 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1570 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1571 | metadata !1, ;; Context |
| 1572 | metadata !"int", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1573 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1574 | i32 0, ;; Line number |
| 1575 | i64 32, ;; Size in bits |
| 1576 | i64 32, ;; Align in bits |
| 1577 | i64 0, ;; Offset in bits |
| 1578 | i32 0, ;; Flags |
| 1579 | 5 ;; Encoding |
| 1580 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1581 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1582 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1583 | |
| 1584 | </div> |
| 1585 | |
| 1586 | <!-- ======================================================================= --> |
| 1587 | <div class="doc_subsection"> |
| 1588 | <a name="ccxx_composite_types">C/C++ struct/union types</a> |
| 1589 | </div> |
| 1590 | |
| 1591 | <div class="doc_text"> |
| 1592 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1593 | <p>Given the following as an example of C/C++ struct type:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1594 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1595 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1596 | <pre> |
| 1597 | struct Color { |
| 1598 | unsigned Red; |
| 1599 | unsigned Green; |
| 1600 | unsigned Blue; |
| 1601 | }; |
| 1602 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1603 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1604 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1605 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1606 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1607 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1608 | <pre> |
| 1609 | ;; |
| 1610 | ;; Define basic type for unsigned int. |
| 1611 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1612 | !5 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1613 | i32 524324, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1614 | metadata !1, ;; Context |
| 1615 | metadata !"unsigned int", |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1616 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1617 | i32 0, ;; Line number |
| 1618 | i64 32, ;; Size in Bits |
| 1619 | i64 32, ;; Align in Bits |
| 1620 | i64 0, ;; Offset in Bits |
| 1621 | i32 0, ;; Flags |
| 1622 | i32 7 ;; Encoding |
| 1623 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1624 | ;; |
| 1625 | ;; Define composite type for struct Color. |
| 1626 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1627 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1628 | i32 524307, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1629 | metadata !1, ;; Context |
| 1630 | metadata !"Color", ;; Name |
| 1631 | metadata !1, ;; Compile unit |
| 1632 | i32 1, ;; Line number |
| 1633 | i64 96, ;; Size in bits |
| 1634 | i64 32, ;; Align in bits |
| 1635 | i64 0, ;; Offset in bits |
| 1636 | i32 0, ;; Flags |
| 1637 | null, ;; Derived From |
| 1638 | metadata !3, ;; Elements |
| 1639 | i32 0 ;; Runtime Language |
| 1640 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1641 | |
| 1642 | ;; |
| 1643 | ;; Define the Red field. |
| 1644 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1645 | !4 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1646 | i32 524301, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1647 | metadata !1, ;; Context |
| 1648 | metadata !"Red", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1649 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1650 | i32 2, ;; Line number |
| 1651 | i64 32, ;; Size in bits |
| 1652 | i64 32, ;; Align in bits |
| 1653 | i64 0, ;; Offset in bits |
| 1654 | i32 0, ;; Flags |
| 1655 | metadata !5 ;; Derived From type |
| 1656 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1657 | |
| 1658 | ;; |
| 1659 | ;; Define the Green field. |
| 1660 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1661 | !6 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1662 | i32 524301, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1663 | metadata !1, ;; Context |
| 1664 | metadata !"Green", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1665 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1666 | i32 3, ;; Line number |
| 1667 | i64 32, ;; Size in bits |
| 1668 | i64 32, ;; Align in bits |
| 1669 | i64 32, ;; Offset in bits |
| 1670 | i32 0, ;; Flags |
| 1671 | metadata !5 ;; Derived From type |
| 1672 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1673 | |
| 1674 | ;; |
| 1675 | ;; Define the Blue field. |
| 1676 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1677 | !7 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1678 | i32 524301, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1679 | metadata !1, ;; Context |
| 1680 | metadata !"Blue", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1681 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1682 | i32 4, ;; Line number |
| 1683 | i64 32, ;; Size in bits |
| 1684 | i64 32, ;; Align in bits |
| 1685 | i64 64, ;; Offset in bits |
| 1686 | i32 0, ;; Flags |
| 1687 | metadata !5 ;; Derived From type |
| 1688 | } |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1689 | |
| 1690 | ;; |
| 1691 | ;; Define the array of fields used by the composite type Color. |
| 1692 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1693 | !3 = metadata !{metadata !4, metadata !6, metadata !7} |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1694 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1695 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1696 | |
| 1697 | </div> |
| 1698 | |
| 1699 | <!-- ======================================================================= --> |
| 1700 | <div class="doc_subsection"> |
| 1701 | <a name="ccxx_enumeration_types">C/C++ enumeration types</a> |
| 1702 | </div> |
| 1703 | |
| 1704 | <div class="doc_text"> |
| 1705 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1706 | <p>Given the following as an example of C/C++ enumeration type:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1707 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1708 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1709 | <pre> |
| 1710 | enum Trees { |
| 1711 | Spruce = 100, |
| 1712 | Oak = 200, |
| 1713 | Maple = 300 |
| 1714 | }; |
| 1715 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1716 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1717 | |
Misha Brukman | 96e0081 | 2008-12-16 02:54:22 +0000 | [diff] [blame] | 1718 | <p>a C/C++ front-end would generate the following descriptors:</p> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1719 | |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1720 | <div class="doc_code"> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1721 | <pre> |
| 1722 | ;; |
| 1723 | ;; Define composite type for enum Trees |
| 1724 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1725 | !2 = metadata !{ |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1726 | i32 524292, ;; Tag |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1727 | metadata !1, ;; Context |
| 1728 | metadata !"Trees", ;; Name |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1729 | metadata !1, ;; File |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1730 | i32 1, ;; Line number |
| 1731 | i64 32, ;; Size in bits |
| 1732 | i64 32, ;; Align in bits |
| 1733 | i64 0, ;; Offset in bits |
| 1734 | i32 0, ;; Flags |
| 1735 | null, ;; Derived From type |
| 1736 | metadata !3, ;; Elements |
| 1737 | i32 0 ;; Runtime language |
| 1738 | } |
Devang Patel | 2a610c7 | 2009-08-25 05:24:07 +0000 | [diff] [blame] | 1739 | |
Devang Patel | 8245988 | 2009-08-26 05:01:18 +0000 | [diff] [blame] | 1740 | ;; |
| 1741 | ;; Define the array of enumerators used by composite type Trees. |
| 1742 | ;; |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1743 | !3 = metadata !{metadata !4, metadata !5, metadata !6} |
| 1744 | |
| 1745 | ;; |
| 1746 | ;; Define Spruce enumerator. |
| 1747 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1748 | !4 = metadata !{i32 524328, metadata !"Spruce", i64 100} |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1749 | |
| 1750 | ;; |
| 1751 | ;; Define Oak enumerator. |
| 1752 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1753 | !5 = metadata !{i32 524328, metadata !"Oak", i64 200} |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1754 | |
| 1755 | ;; |
| 1756 | ;; Define Maple enumerator. |
| 1757 | ;; |
Devang Patel | 4b94550 | 2010-03-09 00:44:10 +0000 | [diff] [blame] | 1758 | !6 = metadata !{i32 524328, metadata !"Maple", i64 300} |
Devang Patel | e4b2756 | 2009-08-28 23:24:31 +0000 | [diff] [blame] | 1759 | |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1760 | </pre> |
Bill Wendling | 48839d9 | 2009-05-17 05:52:39 +0000 | [diff] [blame] | 1761 | </div> |
Jim Laskey | cec12a5 | 2006-03-14 18:08:46 +0000 | [diff] [blame] | 1762 | |
| 1763 | </div> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1764 | |
| 1765 | <!-- *********************************************************************** --> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 1766 | |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1767 | <hr> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 1768 | <address> |
| 1769 | <a href="http://jigsaw.w3.org/css-validator/check/referer"><img |
Misha Brukman | 4440870 | 2008-12-11 17:34:48 +0000 | [diff] [blame] | 1770 | src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 1771 | <a href="http://validator.w3.org/check/referer"><img |
Misha Brukman | 4440870 | 2008-12-11 17:34:48 +0000 | [diff] [blame] | 1772 | src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a> |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 1773 | |
| 1774 | <a href="mailto:sabre@nondot.org">Chris Lattner</a><br> |
Reid Spencer | 05fe4b0 | 2006-03-14 05:39:39 +0000 | [diff] [blame] | 1775 | <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1776 | Last modified: $Date$ |
Misha Brukman | 8287373 | 2004-05-12 19:21:57 +0000 | [diff] [blame] | 1777 | </address> |
Chris Lattner | bdfb339 | 2004-01-05 05:06:33 +0000 | [diff] [blame] | 1778 | |
| 1779 | </body> |
| 1780 | </html> |