docs/SourceLevelDebugging.html

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