Members/tobaru/cbc/CbC_llvm: docs/SourceLevelDebugging.rst comparison

comparison docs/SourceLevelDebugging.rst @ 83:60c9769439b8

LLVM 3.7

author	Tatsuki IHA <e125716@ie.u-ryukyu.ac.jp>
date	Wed, 18 Feb 2015 14:55:36 +0900
parents	54457678186b
children	afa8332a0e37

comparison

equal deleted inserted replaced

-:af83660cff7b
+:60c9769439b8
 !1 = metadata !{
 i32,   ;; A tag
 ...
 }
-<a name="LLVMDebugVersion">The first field of a descriptor is always an
+Most of the string and integer fields in descriptors are packed into a single,
-``i32`` containing a tag value identifying the content of the descriptor.
+null-separated ``mdstring``.  The first field of the header is always an
-The remaining fields are specific to the descriptor.  The values of tags are
+``i32`` containing the DWARF tag value identifying the content of the
-loosely bound to the tag values of DWARF information entries.  However, that
+descriptor.
-does not restrict the use of the information supplied to DWARF targets.
+For clarity of definition in this document, these header fields are described
+below split inside an imaginary ``DIHeader`` construct.  This is invalid
+assembly syntax.  In valid IR, these fields are stringified and concatenated,
+separated by ``\00``.
 The details of the various descriptors follow.
 Compile unit descriptors
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !0 = metadata !{
-i32,       ;; Tag = 17 (DW_TAG_compile_unit)
+DIHeader(
+i32,       ;; Tag = 17 (DW_TAG_compile_unit)
+i32,       ;; DWARF language identifier (ex. DW_LANG_C89)
+mdstring,  ;; Producer (ex. "4.0.1 LLVM (LLVM research group)")
+i1,        ;; True if this is optimized.
+mdstring,  ;; Flags
+i32,       ;; Runtime version
+mdstring,  ;; Split debug filename
+i32        ;; Debug info emission kind (1 = Full Debug Info, 2 = Line Tables Only)
+),
 metadata,  ;; Source directory (including trailing slash) & file pair
-i32,       ;; DWARF language identifier (ex. DW_LANG_C89)
+metadata,  ;; List of enums types
-metadata   ;; Producer (ex. "4.0.1 LLVM (LLVM research group)")
+metadata,  ;; List of retained types
-i1,        ;; True if this is optimized.
+metadata,  ;; List of subprograms
-metadata,  ;; Flags
+metadata,  ;; List of global variables
-i32        ;; Runtime version
-metadata   ;; List of enums types
-metadata   ;; List of retained types
-metadata   ;; List of subprograms
-metadata   ;; List of global variables
 metadata   ;; List of imported entities
-metadata   ;; Split debug filename
-i32        ;; Debug info emission kind (1 = Full Debug Info, 2 = Line Tables Only)
 }
 These descriptors contain a source language ID for the file (we use the DWARF
 3.0 ID numbers, such as ``DW_LANG_C89``, ``DW_LANG_C_plus_plus``,
 ``DW_LANG_Cobol74``, etc), a reference to a metadata node containing a pair of
 ^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !0 = metadata !{
-i32,      ;; Tag = 41 (DW_TAG_file_type)
+DIHeader(
-metadata, ;; Source directory (including trailing slash) & file pair
+i32       ;; Tag = 41 (DW_TAG_file_type)
+),
+metadata  ;; Source directory (including trailing slash) & file pair
 }
 These descriptors contain information for a file.  Global variables and top
 level functions would be defined using this context.  File descriptors also
 provide context for source line correspondence.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !1 = metadata !{
-i32,      ;; Tag = 52 (DW_TAG_variable)
+DIHeader(
-i32,      ;; Unused field.
+i32,      ;; Tag = 52 (DW_TAG_variable)
+mdstring, ;; Name
+mdstring, ;; Display name (fully qualified C++ name)
+mdstring, ;; MIPS linkage name (for C++)
+i32,      ;; Line number where defined
+i1,       ;; True if the global is local to compile unit (static)
+i1        ;; True if the global is defined in the compile unit (not extern)
+),
 metadata, ;; Reference to context descriptor
-metadata, ;; Name
-metadata, ;; Display name (fully qualified C++ name)
-metadata, ;; MIPS linkage name (for C++)
 metadata, ;; Reference to file where defined
-i32,      ;; Line number where defined
 metadata, ;; Reference to type descriptor
-i1,       ;; True if the global is local to compile unit (static)
-i1,       ;; True if the global is defined in the compile unit (not extern)
 {}*,      ;; Reference to the global variable
 metadata, ;; The static member declaration, if any
 }
 These descriptors provide debug information about global variables.  They
 ^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !2 = metadata !{
-i32,      ;; Tag = 46 (DW_TAG_subprogram)
+DIHeader(
+i32,      ;; Tag = 46 (DW_TAG_subprogram)
+mdstring, ;; Name
+mdstring, ;; Display name (fully qualified C++ name)
+mdstring, ;; MIPS linkage name (for C++)
+i32,      ;; Line number where defined
+i1,       ;; True if the global is local to compile unit (static)
+i1,       ;; True if the global is defined in the compile unit (not extern)
+i32,      ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual
+i32,      ;; Index into a virtual function
+i32,      ;; Flags - Artificial, Private, Protected, Explicit, Prototyped.
+i1,       ;; isOptimized
+i32       ;; Line number where the scope of the subprogram begins
+),
 metadata, ;; Source directory (including trailing slash) & file pair
 metadata, ;; Reference to context descriptor
-metadata, ;; Name
-metadata, ;; Display name (fully qualified C++ name)
-metadata, ;; MIPS linkage name (for C++)
-i32,      ;; Line number where defined
 metadata, ;; Reference to type descriptor
-i1,       ;; True if the global is local to compile unit (static)
-i1,       ;; True if the global is defined in the compile unit (not extern)
-i32,      ;; Virtuality, e.g. dwarf::DW_VIRTUALITY__virtual
-i32,      ;; Index into a virtual function
 metadata, ;; indicates which base type contains the vtable pointer for the
 ;; derived class
-i32,      ;; Flags - Artificial, Private, Protected, Explicit, Prototyped.
-i1,       ;; isOptimized
 {}*,      ;; Reference to the LLVM function
 metadata, ;; Lists function template parameters
 metadata, ;; Function declaration descriptor
-metadata, ;; List of function variables
+metadata  ;; List of function variables
-i32       ;; Line number where the scope of the subprogram begins
 }
 These descriptors provide debug information about functions, methods and
 subprograms.  They provide details such as name, return types and the source
 location where the subprogram is defined.
 ^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !3 = metadata !{
-i32,      ;; Tag = 11 (DW_TAG_lexical_block)
+DIHeader(
+i32,      ;; Tag = 11 (DW_TAG_lexical_block)
+i32,      ;; Line number
+i32,      ;; Column number
+i32       ;; Unique ID to identify blocks from a template function
+),
 metadata, ;; Source directory (including trailing slash) & file pair
-metadata, ;; Reference to context descriptor
+metadata  ;; Reference to context descriptor
-i32,      ;; Line number
-i32,      ;; Column number
-i32       ;; Unique ID to identify blocks from a template function
 }
 This descriptor provides debug information about nested blocks within a
 subprogram.  The line number and column numbers are used to dinstinguish two
 lexical blocks at same depth.
 .. code-block:: llvm
 !3 = metadata !{
-i32,      ;; Tag = 11 (DW_TAG_lexical_block)
+DIHeader(
+i32,      ;; Tag = 11 (DW_TAG_lexical_block)
+i32       ;; DWARF path discriminator value
+),
 metadata, ;; Source directory (including trailing slash) & file pair
 metadata  ;; Reference to the scope we're annotating with a file change
-i32,      ;; DWARF path discriminator value
 }
 This descriptor provides a wrapper around a lexical scope to handle file
 changes in the middle of a lexical block.
 ^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !4 = metadata !{
-i32,      ;; Tag = 36 (DW_TAG_base_type)
+DIHeader(
+i32,      ;; Tag = 36 (DW_TAG_base_type)
+mdstring, ;; Name (may be "" for anonymous types)
+i32,      ;; Line number where defined (may be 0)
+i64,      ;; Size in bits
+i64,      ;; Alignment in bits
+i64,      ;; Offset in bits
+i32,      ;; Flags
+i32       ;; DWARF type encoding
+),
 metadata, ;; Source directory (including trailing slash) & file pair (may be null)
-metadata, ;; Reference to context
+metadata  ;; Reference to context
-metadata, ;; Name (may be "" for anonymous types)
-i32,      ;; Line number where defined (may be 0)
-i64,      ;; Size in bits
-i64,      ;; Alignment in bits
-i64,      ;; Offset in bits
-i32,      ;; Flags
-i32       ;; DWARF type encoding
 }
 These descriptors define primitive types used in the code.  Example ``int``,
 ``bool`` and ``float``.  The context provides the scope of the type, which is
 usually the top level.  Since basic types are not usually user defined the
 ^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !5 = metadata !{
-i32,      ;; Tag (see below)
+DIHeader(
+i32,      ;; Tag (see below)
+mdstring, ;; Name (may be "" for anonymous types)
+i32,      ;; Line number where defined (may be 0)
+i64,      ;; Size in bits
+i64,      ;; Alignment in bits
+i64,      ;; Offset in bits
+i32       ;; Flags to encode attributes, e.g. private
+),
 metadata, ;; Source directory (including trailing slash) & file pair (may be null)
 metadata, ;; Reference to context
-metadata, ;; Name (may be "" for anonymous types)
-i32,      ;; Line number where defined (may be 0)
-i64,      ;; Size in bits
-i64,      ;; Alignment in bits
-i64,      ;; Offset in bits
-i32,      ;; Flags to encode attributes, e.g. private
 metadata, ;; Reference to type derived from
-metadata, ;; (optional) Name of the Objective C property associated with
+metadata  ;; (optional) Objective C property node
-;; Objective-C an ivar, or the type of which this
-;; pointer-to-member is pointing to members of.
-metadata, ;; (optional) Name of the Objective C property getter selector.
-metadata, ;; (optional) Name of the Objective C property setter selector.
-i32       ;; (optional) Objective C property attributes.
 }
 These descriptors are used to define types derived from other types.  The value
 of the tag varies depending on the meaning.  The following are possible tag
 values:
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !6 = metadata !{
-i32,      ;; Tag (see below)
+DIHeader(
+i32,      ;; Tag (see below)
+mdstring, ;; Name (may be "" for anonymous types)
+i32,      ;; Line number where defined (may be 0)
+i64,      ;; Size in bits
+i64,      ;; Alignment in bits
+i64,      ;; Offset in bits
+i32,      ;; Flags
+i32       ;; Runtime languages
+),
 metadata, ;; Source directory (including trailing slash) & file pair (may be null)
 metadata, ;; Reference to context
-metadata, ;; Name (may be "" for anonymous types)
-i32,      ;; Line number where defined (may be 0)
-i64,      ;; Size in bits
-i64,      ;; Alignment in bits
-i64,      ;; Offset in bits
-i32,      ;; Flags
 metadata, ;; Reference to type derived from
 metadata, ;; Reference to array of member descriptors
-i32,      ;; Runtime languages
 metadata, ;; Base type containing the vtable pointer for this type
 metadata, ;; Template parameters
-metadata  ;; A unique identifier for type uniquing purpose (may be null)
+mdstring  ;; A unique identifier for type uniquing purpose (may be null)
 }
 These descriptors are used to define types that are composed of 0 or more
 elements.  The value of the tag varies depending on the meaning.  The following
 are possible tag values:
 ^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !42 = metadata !{
-i32,      ;; Tag = 33 (DW_TAG_subrange_type)
+DIHeader(
-i64,      ;; Low value
+i32,      ;; Tag = 33 (DW_TAG_subrange_type)
-i64       ;; High value
+i64,      ;; Low value
+i64       ;; High value
+)
 }
 These descriptors are used to define ranges of array subscripts for an array
 :ref:`composite type <format_composite_type>`.  The low value defines the lower
 bounds typically zero for C/C++.  The high value is the upper bounds.  Values
 ^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !6 = metadata !{
-i32,      ;; Tag = 40 (DW_TAG_enumerator)
+DIHeader(
-metadata, ;; Name
+i32,      ;; Tag = 40 (DW_TAG_enumerator)
-i64       ;; Value
+mdstring, ;; Name
+i64       ;; Value
+)
 }
 These descriptors are used to define members of an enumeration :ref:`composite
 type <format_composite_type>`, it associates the name to the value.
 ^^^^^^^^^^^^^^^
 .. code-block:: llvm
 !7 = metadata !{
-i32,      ;; Tag (see below)
+DIHeader(
+i32,      ;; Tag (see below)
+mdstring, ;; Name
+i32,      ;; 24 bit - Line number where defined
+;; 8 bit - Argument number. 1 indicates 1st argument.
+i32       ;; flags
+),
 metadata, ;; Context
-metadata, ;; Name
 metadata, ;; Reference to file where defined
-i32,      ;; 24 bit - Line number where defined
-;; 8 bit - Argument number. 1 indicates 1st argument.
 metadata, ;; Reference to the type descriptor
-i32,      ;; flags
 metadata  ;; (optional) Reference to inline location
-metadata  ;; (optional) Reference to a complex expression (see below)
 }
 These descriptors are used to define variables local to a sub program.  The
 value of the tag depends on the usage of the variable:
 The context is either the subprogram or block where the variable is defined.
 Name the source variable name.  Context and line indicate where the variable
 was defined.  Type descriptor defines the declared type of the variable.
-The ``OpPiece`` operator is used for (typically larger aggregate)
+Complex Expressions
+^^^^^^^^^^^^^^^^^^^
+.. code-block:: llvm
+!8 = metadata !{
+i32,      ;; DW_TAG_expression
+...
+}
+Complex expressions describe variable storage locations in terms of
+prefix-notated DWARF expressions. Currently the only supported
+operators are ``DW_OP_plus``, ``DW_OP_deref``, and ``DW_OP_piece``.
+The ``DW_OP_piece`` operator is used for (typically larger aggregate)
 variables that are fragmented across several locations. It takes two
 i32 arguments, an offset and a size in bytes to describe which piece
 of the variable is at this location.
 representing programs in the same way that DWARF 3 does), or they could choose
 to provide completely different forms if they don't fit into the DWARF model.
 As support for debugging information gets added to the various LLVM
 source-language front-ends, the information used should be documented here.
-The following sections provide examples of various C/C++ constructs and the
+The following sections provide examples of a few C/C++ constructs and the debug
-debug information that would best describe those constructs.
+information that would best describe those constructs.  The canonical
+references are the ``DIDescriptor`` classes defined in
+``include/llvm/IR/DebugInfo.h`` and the implementations of the helper functions
+in ``lib/IR/DIBuilder.cpp``.
 C/C++ source file information
 -----------------------------
-Given the source files ``MySource.cpp`` and ``MyHeader.h`` located in the
-directory ``/Users/mine/sources``, the following code:
-.. code-block:: c
-#include "MyHeader.h"
-int main(int argc, char *argv[]) {
-return 0;
-}
-a C/C++ front-end would generate the following descriptors:
-.. code-block:: llvm
-...
-;;
-;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp".
-;;
-!0 = metadata !{
-i32 786449,   ;; Tag
-metadata !1,  ;; File/directory name
-i32 4,        ;; Language Id
-metadata !"clang version 3.4 ",
-i1 false,     ;; Optimized compile unit
-metadata !"", ;; Compiler flags
-i32 0,        ;; Runtime version
-metadata !2,  ;; Enumeration types
-metadata !2,  ;; Retained types
-metadata !3,  ;; Subprograms
-metadata !2,  ;; Global variables
-metadata !2,  ;; Imported entities (declarations and namespaces)
-metadata !""  ;; Split debug filename
-1,            ;; Full debug info
-}
-;;
-;; Define the file for the file "/Users/mine/sources/MySource.cpp".
-;;
-!1 = metadata !{
-metadata !"MySource.cpp",
-metadata !"/Users/mine/sources"
-}
-!5 = metadata !{
-i32 786473, ;; Tag
-metadata !1
-}
-;;
-;; Define the file for the file "/Users/mine/sources/Myheader.h"
-;;
-!14 = metadata !{
-i32 786473, ;; Tag
-metadata !15
-}
-!15 = metadata !{
-metadata !"./MyHeader.h",
-metadata !"/Users/mine/sources",
-}
-...
 ``llvm::Instruction`` provides easy access to metadata attached with an
 instruction.  One can extract line number information encoded in LLVM IR using
 ``Instruction::getMetadata()`` and ``DILocation::getLineNumber()``.
 .. code-block:: llvm
 ;;
 ;; Define the global itself.
 ;;
-%MyGlobal = global int 100
+@MyGlobal = global i32 100, align 4
 ...
 ;;
 ;; List of debug info of globals
 ;;
 !llvm.dbg.cu = !{!0}
 ;; Define the compile unit.
 !0 = metadata !{
-i32 786449,                       ;; Tag
+; Header(
-i32 0,                            ;; Context
+;   i32 17,                           ;; Tag
-i32 4,                            ;; Language
+;   i32 0,                            ;; Context
-metadata !"foo.cpp",              ;; File
+;   i32 4,                            ;; Language
-metadata !"/Volumes/Data/tmp",    ;; Directory
+;   metadata !"clang version 3.6.0 ", ;; Producer
-metadata !"clang version 3.1 ",   ;; Producer
+;   i1 false,                         ;; "isOptimized"?
-i1 true,                          ;; Deprecated field
+;   metadata !"",                     ;; Flags
-i1 false,                         ;; "isOptimized"?
+;   i32 0,                            ;; Runtime Version
-metadata !"",                     ;; Flags
+;   "",                               ;; Split debug filename
-i32 0,                            ;; Runtime Version
+;   1                                 ;; Full debug info
-metadata !1,                      ;; Enum Types
+; )
-metadata !1,                      ;; Retained Types
+metadata !"0x11\0012\00clang version 3.6.0 \000\00\000\00\001",
-metadata !1,                      ;; Subprograms
+metadata !1,                          ;; File
-metadata !3,                      ;; Global Variables
+metadata !2,                          ;; Enum Types
-metadata !1,                      ;; Imported entities
+metadata !2,                          ;; Retained Types
-"",                               ;; Split debug filename
+metadata !2,                          ;; Subprograms
-1,                                ;; Full debug info
+metadata !3,                          ;; Global Variables
+metadata !2                           ;; Imported entities
 } ; [ DW_TAG_compile_unit ]
+;; The file/directory pair.
+!1 = metadata !{
+metadata !"foo.c",                                 ;; Filename
+metadata !"/Users/dexonsmith/data/llvm/debug-info" ;; Directory
+}
+;; An empty array.
+!2 = metadata !{}
 ;; The Array of Global Variables
 !3 = metadata !{
 metadata !4
 }
 ;;
 ;; Define the global variable itself.
 ;;
 !4 = metadata !{
-i32 786484,                        ;; Tag
+; Header(
-i32 0,                             ;; Unused
+;   i32 52,                        ;; Tag
+;   metadata !"MyGlobal",          ;; Name
+;   metadata !"MyGlobal",          ;; Display Name
+;   metadata !"",                  ;; Linkage Name
+;   i32 1,                         ;; Line
+;   i32 0,                         ;; IsLocalToUnit
+;   i32 1                          ;; IsDefinition
+; )
+metadata !"0x34\00MyGlobal\00MyGlobal\00\001\000\001",
 null,                              ;; Unused
-metadata !"MyGlobal",              ;; Name
+metadata !5,                       ;; File
-metadata !"MyGlobal",              ;; Display Name
+metadata !6,                       ;; Type
-metadata !"",                      ;; Linkage Name
-metadata !6,                       ;; File
-i32 1,                             ;; Line
-metadata !7,                       ;; Type
-i32 0,                             ;; IsLocalToUnit
-i32 1,                             ;; IsDefinition
 i32* @MyGlobal,                    ;; LLVM-IR Value
 null                               ;; Static member declaration
 } ; [ DW_TAG_variable ]
 ;;
 ;; Define the file
 ;;
 !5 = metadata !{
-metadata !"foo.cpp",               ;; File
+; Header(
-metadata !"/Volumes/Data/tmp",     ;; Directory
+;   i32 41             ;; Tag
-}
+; )
-!6 = metadata !{
+metadata !"0x29",
-i32 786473,                        ;; Tag
+metadata !1            ;; File/directory pair
-metadata !5                        ;; Unused
 } ; [ DW_TAG_file_type ]
 ;;
 ;; Define the type
 ;;
-!7 = metadata !{
+!6 = metadata !{
-i32 786468,                         ;; Tag
+; Header(
-null,                               ;; Unused
+;   i32 36,                       ;; Tag
-null,                               ;; Unused
+;   metadata !"int",              ;; Name
-metadata !"int",                    ;; Name
+;   i32 0,                        ;; Line
-i32 0,                              ;; Line
+;   i64 32,                       ;; Size in Bits
-i64 32,                             ;; Size in Bits
+;   i64 32,                       ;; Align in Bits
-i64 32,                             ;; Align in Bits
+;   i64 0,                        ;; Offset
-i64 0,                              ;; Offset
+;   i32 0,                        ;; Flags
-i32 0,                              ;; Flags
+;   i32 5                         ;; Encoding
-i32 5                               ;; Encoding
+; )
+metadata !"0x24\00int\000\0032\0032\000\000\005",
+null,                             ;; Unused
+null                              ;; Unused
 } ; [ DW_TAG_base_type ]
 C/C++ function information
 --------------------------
 ;;
 ;; Define the anchor for subprograms.
 ;;
 !6 = metadata !{
-i32 786484,        ;; Tag
+; Header(
-metadata !1,       ;; File
+;   i32 46,             ;; Tag
-metadata !1,       ;; Context
+;   metadata !"main",   ;; Name
-metadata !"main",  ;; Name
+;   metadata !"main",   ;; Display name
-metadata !"main",  ;; Display name
+;   metadata !"",       ;; Linkage name
-metadata !"main",  ;; Linkage name
+;   i32 1,              ;; Line number
-i32 1,             ;; Line number
+;   i1 false,           ;; Is local
-metadata !4,       ;; Type
+;   i1 true,            ;; Is definition
-i1 false,          ;; Is local
+;   i32 0,              ;; Virtuality attribute, e.g. pure virtual function
-i1 true,           ;; Is definition
+;   i32 0,              ;; Index into virtual table for C++ methods
-i32 0,             ;; Virtuality attribute, e.g. pure virtual function
+;   i32 256,            ;; Flags
-i32 0,             ;; Index into virtual table for C++ methods
+;   i1 0,               ;; True if this function is optimized
-i32 0,             ;; Type that holds virtual table.
+;   1                   ;; Line number of the opening '{' of the function
-i32 0,             ;; Flags
+; )
-i1 false,          ;; True if this function is optimized
+metadata !"0x2e\00main\00main\00\001\000\001\000\000\00256\000\001",
-Function *,        ;; Pointer to llvm::Function
+metadata !1,            ;; File
-null,              ;; Function template parameters
+metadata !5,            ;; Context
-null,              ;; List of function variables (emitted when optimizing)
+metadata !6,            ;; Type
-1                  ;; Line number of the opening '{' of the function
+null,                   ;; Containing type
-}
+i32 (i32, i8**)* @main, ;; Pointer to llvm::Function
+null,                   ;; Function template parameters
+null,                   ;; Function declaration
+metadata !2             ;; List of function variables (emitted when optimizing)
+}
 ;;
 ;; Define the subprogram itself.
 ;;
 define i32 @main(i32 %argc, i8** %argv) {
 ...
 }
-C/C++ basic types
------------------
-The following are the basic type descriptors for C/C++ core types:
-bool
-^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"bool",  ;; Name
-i32 0,             ;; Line number
-i64 8,             ;; Size in Bits
-i64 8,             ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 2              ;; Encoding
-}
-char
-^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"char",  ;; Name
-i32 0,             ;; Line number
-i64 8,             ;; Size in Bits
-i64 8,             ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 6              ;; Encoding
-}
-unsigned char
-^^^^^^^^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"unsigned char",
-i32 0,             ;; Line number
-i64 8,             ;; Size in Bits
-i64 8,             ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 8              ;; Encoding
-}
-short
-^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"short int",
-i32 0,             ;; Line number
-i64 16,            ;; Size in Bits
-i64 16,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 5              ;; Encoding
-}
-unsigned short
-^^^^^^^^^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"short unsigned int",
-i32 0,             ;; Line number
-i64 16,            ;; Size in Bits
-i64 16,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 7              ;; Encoding
-}
-int
-^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"int",   ;; Name
-i32 0,             ;; Line number
-i64 32,            ;; Size in Bits
-i64 32,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 5              ;; Encoding
-}
-unsigned int
-^^^^^^^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"unsigned int",
-i32 0,             ;; Line number
-i64 32,            ;; Size in Bits
-i64 32,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 7              ;; Encoding
-}
-long long
-^^^^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"long long int",
-i32 0,             ;; Line number
-i64 64,            ;; Size in Bits
-i64 64,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 5              ;; Encoding
-}
-unsigned long long
-^^^^^^^^^^^^^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"long long unsigned int",
-i32 0,             ;; Line number
-i64 64,            ;; Size in Bits
-i64 64,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 7              ;; Encoding
-}
-float
-^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"float",
-i32 0,             ;; Line number
-i64 32,            ;; Size in Bits
-i64 32,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 4              ;; Encoding
-}
-double
-^^^^^^
-.. code-block:: llvm
-!2 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"double",;; Name
-i32 0,             ;; Line number
-i64 64,            ;; Size in Bits
-i64 64,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 4              ;; Encoding
-}
-C/C++ derived types
--------------------
-Given the following as an example of C/C++ derived type:
-.. code-block:: c
-typedef const int *IntPtr;
-a C/C++ front-end would generate the following descriptors:
-.. code-block:: llvm
-;;
-;; Define the typedef "IntPtr".
-;;
-!2 = metadata !{
-i32 786454,          ;; Tag
-metadata !3,         ;; File
-metadata !1,         ;; Context
-metadata !"IntPtr",  ;; Name
-i32 0,               ;; Line number
-i64 0,               ;; Size in bits
-i64 0,               ;; Align in bits
-i64 0,               ;; Offset in bits
-i32 0,               ;; Flags
-metadata !4          ;; Derived From type
-}
-;;
-;; Define the pointer type.
-;;
-!4 = metadata !{
-i32 786447,          ;; Tag
-null,                ;; File
-null,                ;; Context
-metadata !"",        ;; Name
-i32 0,               ;; Line number
-i64 64,              ;; Size in bits
-i64 64,              ;; Align in bits
-i64 0,               ;; Offset in bits
-i32 0,               ;; Flags
-metadata !5          ;; Derived From type
-}
-;;
-;; Define the const type.
-;;
-!5 = metadata !{
-i32 786470,          ;; Tag
-null,                ;; File
-null,                ;; Context
-metadata !"",        ;; Name
-i32 0,               ;; Line number
-i64 0,               ;; Size in bits
-i64 0,               ;; Align in bits
-i64 0,               ;; Offset in bits
-i32 0,               ;; Flags
-metadata !6          ;; Derived From type
-}
-;;
-;; Define the int type.
-;;
-!6 = metadata !{
-i32 786468,          ;; Tag
-null,                ;; File
-null,                ;; Context
-metadata !"int",     ;; Name
-i32 0,               ;; Line number
-i64 32,              ;; Size in bits
-i64 32,              ;; Align in bits
-i64 0,               ;; Offset in bits
-i32 0,               ;; Flags
-i32 5                ;; Encoding
-}
-C/C++ struct/union types
-------------------------
-Given the following as an example of C/C++ struct type:
-.. code-block:: c
-struct Color {
-unsigned Red;
-unsigned Green;
-unsigned Blue;
-};
-a C/C++ front-end would generate the following descriptors:
-.. code-block:: llvm
-;;
-;; Define basic type for unsigned int.
-;;
-!5 = metadata !{
-i32 786468,        ;; Tag
-null,              ;; File
-null,              ;; Context
-metadata !"unsigned int",
-i32 0,             ;; Line number
-i64 32,            ;; Size in Bits
-i64 32,            ;; Align in Bits
-i64 0,             ;; Offset in Bits
-i32 0,             ;; Flags
-i32 7              ;; Encoding
-}
-;;
-;; Define composite type for struct Color.
-;;
-!2 = metadata !{
-i32 786451,        ;; Tag
-metadata !1,       ;; Compile unit
-null,              ;; Context
-metadata !"Color", ;; Name
-i32 1,             ;; Line number
-i64 96,            ;; Size in bits
-i64 32,            ;; Align in bits
-i64 0,             ;; Offset in bits
-i32 0,             ;; Flags
-null,              ;; Derived From
-metadata !3,       ;; Elements
-i32 0,             ;; Runtime Language
-null,              ;; Base type containing the vtable pointer for this type
-null               ;; Template parameters
-}
-;;
-;; Define the Red field.
-;;
-!4 = metadata !{
-i32 786445,        ;; Tag
-metadata !1,       ;; File
-metadata !1,       ;; Context
-metadata !"Red",   ;; Name
-i32 2,             ;; Line number
-i64 32,            ;; Size in bits
-i64 32,            ;; Align in bits
-i64 0,             ;; Offset in bits
-i32 0,             ;; Flags
-metadata !5        ;; Derived From type
-}
-;;
-;; Define the Green field.
-;;
-!6 = metadata !{
-i32 786445,        ;; Tag
-metadata !1,       ;; File
-metadata !1,       ;; Context
-metadata !"Green", ;; Name
-i32 3,             ;; Line number
-i64 32,            ;; Size in bits
-i64 32,            ;; Align in bits
-i64 32,             ;; Offset in bits
-i32 0,             ;; Flags
-metadata !5        ;; Derived From type
-}
-;;
-;; Define the Blue field.
-;;
-!7 = metadata !{
-i32 786445,        ;; Tag
-metadata !1,       ;; File
-metadata !1,       ;; Context
-metadata !"Blue",  ;; Name
-i32 4,             ;; Line number
-i64 32,            ;; Size in bits
-i64 32,            ;; Align in bits
-i64 64,             ;; Offset in bits
-i32 0,             ;; Flags
-metadata !5        ;; Derived From type
-}
-;;
-;; Define the array of fields used by the composite type Color.
-;;
-!3 = metadata !{metadata !4, metadata !6, metadata !7}
-C/C++ enumeration types
------------------------
-Given the following as an example of C/C++ enumeration type:
-.. code-block:: c
-enum Trees {
-Spruce = 100,
-Oak = 200,
-Maple = 300
-};
-a C/C++ front-end would generate the following descriptors:
-.. code-block:: llvm
-;;
-;; Define composite type for enum Trees
-;;
-!2 = metadata !{
-i32 786436,        ;; Tag
-metadata !1,       ;; File
-metadata !1,       ;; Context
-metadata !"Trees", ;; Name
-i32 1,             ;; Line number
-i64 32,            ;; Size in bits
-i64 32,            ;; Align in bits
-i64 0,             ;; Offset in bits
-i32 0,             ;; Flags
-null,              ;; Derived From type
-metadata !3,       ;; Elements
-i32 0              ;; Runtime language
-}
-;;
-;; Define the array of enumerators used by composite type Trees.
-;;
-!3 = metadata !{metadata !4, metadata !5, metadata !6}
-;;
-;; Define Spruce enumerator.
-;;
-!4 = metadata !{i32 786472, metadata !"Spruce", i64 100}
-;;
-;; Define Oak enumerator.
-;;
-!5 = metadata !{i32 786472, metadata !"Oak", i64 200}
-;;
-;; Define Maple enumerator.
-;;
-!6 = metadata !{i32 786472, metadata !"Maple", i64 300}
 Debugging information format
 ============================
 Debugging Information Extension for Objective C Properties
 +--------------------------------+--------+-----------+
 New DWARF Constants
 ^^^^^^^^^^^^^^^^^^^
-+--------------------------------+-------+
++--------------------------------------+-------+
-| Name                           | Value |
+| Name                                 | Value |
-+================================+=======+
++======================================+=======+
-| DW_AT_APPLE_PROPERTY_readonly  | 0x1   |
+| DW_APPLE_PROPERTY_readonly           | 0x01  |
-+--------------------------------+-------+
++--------------------------------------+-------+
-| DW_AT_APPLE_PROPERTY_readwrite | 0x2   |
+| DW_APPLE_PROPERTY_getter             | 0x02  |
-+--------------------------------+-------+
++--------------------------------------+-------+
-| DW_AT_APPLE_PROPERTY_assign    | 0x4   |
+| DW_APPLE_PROPERTY_assign             | 0x04  |
-+--------------------------------+-------+
++--------------------------------------+-------+
-| DW_AT_APPLE_PROPERTY_retain    | 0x8   |
+| DW_APPLE_PROPERTY_readwrite          | 0x08  |
-+--------------------------------+-------+
++--------------------------------------+-------+
-| DW_AT_APPLE_PROPERTY_copy      | 0x10  |
+| DW_APPLE_PROPERTY_retain             | 0x10  |
-+--------------------------------+-------+
++--------------------------------------+-------+
-| DW_AT_APPLE_PROPERTY_nonatomic | 0x20  |
+| DW_APPLE_PROPERTY_copy               | 0x20  |
-+--------------------------------+-------+
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_nonatomic          | 0x40  |
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_setter             | 0x80  |
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_atomic             | 0x100 |
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_weak               | 0x200 |
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_strong             | 0x400 |
++--------------------------------------+-------+
+| DW_APPLE_PROPERTY_unsafe_unretained  | 0x800 |
++--------------------------------+-----+-------+
 Name Accelerator Tables
 -----------------------
 Introduction
 * DW_TAG_ptr_to_member_type
 * DW_TAG_set_type
 * DW_TAG_subrange_type
 * DW_TAG_base_type
 * DW_TAG_const_type
-* DW_TAG_constant
 * DW_TAG_file_type
 * DW_TAG_namelist
 * DW_TAG_packed_type
 * DW_TAG_volatile_type
 * DW_TAG_restrict_type

Mercurial > hg > Members > tobaru > cbc > CbC_llvm

comparison docs/SourceLevelDebugging.rst @ 83:60c9769439b8