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