X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FSourceLevelDebugging.html;h=f1e1cd0285d88d2d11cf6cdd2529aa5772656b79;hb=3d793962becf3a345cfff96202f3c6c27a1fb5d4;hp=93d65ccaae680646b878aa37a937a668022dadf9;hpb=cf493b89bed4b1c41e6fe4dc48d29b5bdf70a0f8;p=oota-llvm.git diff --git a/docs/SourceLevelDebugging.html b/docs/SourceLevelDebugging.html index 93d65ccaae6..f1e1cd0285d 100644 --- a/docs/SourceLevelDebugging.html +++ b/docs/SourceLevelDebugging.html @@ -25,6 +25,7 @@
Currently, debug information is consumed by the DwarfWriter to produce dwarf +
Currently, debug information is consumed by DwarfDebug to produce dwarf information used by the gdb debugger. Other targets could use the same information to produce stabs or other debug forms.
@@ -235,7 +237,7 @@ height="369">LLVM debugging information has been carefully designed to make it possible for the optimizer to optimize the program and debugging information without necessarily having to know anything about debugging information. In - particular, te use of metadadta avoids duplicated dubgging information from + particular, the use of metadata avoids duplicated debugging information from the beginning, and the global dead code elimination pass automatically deletes debugging information for a function if it decides to delete the function.
@@ -254,7 +256,7 @@ height="369">To provide basic functionality, the LLVM debugger does have to make some assumptions about the source-level language being debugged, though it keeps these to a minimum. The only common features that the LLVM debugger assumes - exist are source files, + exist are source files, and program objects. These abstract objects are used by a debugger to form stack traces, show information about local variables, etc.
@@ -287,27 +289,26 @@ height="369"> 0x1000.)The fields of debug descriptors used internally by LLVM - are restricted to only the simple data types int, uint, - bool, float, double, mdstring and - mdnode.
+ are restricted to only the simple data types i32, i1, + float, double, mdstring and mdnode.!1 = metadata !{ - uint, ;; A tag + i32, ;; A tag ... }
The details of the various descriptors follow.
@@ -345,18 +346,36 @@ height="369"> that produced it.Compile unit descriptors provide the root context for objects declared in a - specific source file. Global variables and top level functions would be - defined using this context. Compile unit descriptors also provide context - for source line correspondence.
+ specific compilation unit. File descriptors are defined using this context. -Each input file is encoded as a separate compile unit in LLVM debugging - information output. However, many target specific tool chains prefer to - encode only one compile unit in an object file. In this situation, the LLVM - code generator will include debugging information entities in the compile - unit that is marked as main compile unit. The code generator accepts maximum - one main compile unit per module. If a module does not contain any main - compile unit then the code generator will emit multiple compile units in the - output object file.
+ + + ++!0 = metadata !{ + i32, ;; Tag = 41 + LLVMDebugVersion + ;; (DW_TAG_file_type) + metadata, ;; Source file name + metadata, ;; Source file directory (includes trailing slash) + metadata ;; Reference to compile unit where defined +} ++
These descriptors contain information for a file. Global variables and top + level functions would be defined using this context.k File descriptors also + provide context for source line correspondence.
+ +Each input file is encoded as a separate file descriptor in LLVM debugging + information output. Each file descriptor would be defined using a + compile unit.
!3 = metadata !{ - i32, ;; Tag = 13 + LLVMDebugVersion (DW_TAG_lexical_block) - metadata ;; Reference to context descriptor + i32, ;; Tag = 11 + LLVMDebugVersion (DW_TAG_lexical_block) + metadata,;; Reference to context descriptor + i32, ;; Line number + i32, ;; Column number + metadata,;; Reference to source file + i32 ;; Unique ID to identify blocks from a template function }
These descriptors provide debug information about nested blocks within a - subprogram. The array of member descriptors is used to define local - variables and deeper nested blocks.
+ subprogram. The line number and column numbers are used to dinstinguish + two lexical blocks at same depth. @@ -460,7 +490,7 @@ provide details such as name, type and where the variable is defined. ;; (DW_TAG_base_type) metadata, ;; Reference to context (typically a compile unit) metadata, ;; Name (may be "" for anonymous types) - metadata, ;; Reference to compile unit where defined (may be NULL) + metadata, ;; Reference to file where defined (may be NULL) i32, ;; Line number where defined (may be 0) i64, ;; Size in bits i64, ;; Alignment in bits @@ -511,11 +541,11 @@ DW_ATE_unsigned_char = 8 i32, ;; Tag (see below) metadata, ;; Reference to context metadata, ;; Name (may be "" for anonymous types) - metadata, ;; Reference to compile unit where defined (may be NULL) + metadata, ;; Reference to file where defined (may be NULL) i32, ;; Line number where defined (may be 0) - i32, ;; Size in bits - i32, ;; Alignment in bits - i32, ;; Offset in bits + i64, ;; Size in bits + i64, ;; Alignment in bits + i64, ;; Offset in bits metadata ;; Reference to type derived from } @@ -560,9 +590,8 @@ DW_TAG_restrict_type = 55 the bit offset if embedded in a composite type. -Note that the void * type is expressed as a - llvm.dbg.derivedtype.type with tag of DW_TAG_pointer_type - and NULL derived type.
+Note that the void * type is expressed as a type derived from NULL. +
@@ -579,7 +608,7 @@ DW_TAG_restrict_type = 55 i32, ;; Tag (see below) metadata, ;; Reference to context metadata, ;; Name (may be "" for anonymous types) - metadata, ;; Reference to compile unit where defined (may be NULL) + metadata, ;; Reference to file where defined (may be NULL) i32, ;; Line number where defined (may be 0) i64, ;; Size in bits i64, ;; Alignment in bits @@ -661,7 +690,7 @@ DW_TAG_inheritance = 28-%llvm.dbg.subrange.type = type { +!42 = metadata !{ i32, ;; Tag = 33 + LLVMDebugVersion (DW_TAG_subrange_type) i64, ;; Low value i64 ;; High value @@ -714,8 +743,9 @@ DW_TAG_inheritance = 28 i32, ;; Tag (see below) metadata, ;; Context metadata, ;; Name - metadata, ;; Reference to compile unit where defined - i32, ;; Line number where defined + metadata, ;; Reference to file where defined + i32, ;; 24 bit - Line number where defined + ;; 8 bit - Argument number. 1 indicates 1st argument. metadata ;; Type descriptor }@@ -763,15 +793,29 @@ DW_TAG_return_variable = 258
- void %llvm.dbg.declare( { } *, metadata ) + void %llvm.dbg.declare(metadata, metadata)
This intrinsic provides information about a local element (ex. variable.) The - first argument is the alloca for the variable, cast to a { }*. The - second argument is - the %llvm.dbg.variable containing - the description of the variable.
+ first argument is metadata holding alloca for the variable.. The + second argument is metadata containing description of the variable. ++ void %llvm.dbg.value(metadata, i64, metadata) ++ +
This intrinsic provides information when a user source variable is set to a + new value. The first argument is the new value (wrapped as metadata). The + second argument is the offset in the user source variable where the new value + is written. The third argument is metadata containing description of the + user source variable.
In order to handle this, the LLVM debug format uses the metadata attached to - llvm instructions to encode line nuber and scoping information. Consider the - following C fragment, for example:
+ llvm instructions to encode line number and scoping information. Consider + the following C fragment, for example:@@ -813,28 +857,28 @@ DW_TAG_return_variable = 258define void @foo() nounwind ssp { entry: - %X = alloca i32, align 4 ;[#uses=4] - %Y = alloca i32, align 4 ; [#uses=4] - %Z = alloca i32, align 4 ; [#uses=3] - %0 = bitcast i32* %X to { }* ; <{ }*> [#uses=1] - call void @llvm.dbg.declare({ }* %0, metadata !0), !dbg !7 + %X = alloca i32, align 4 ; <i32*> [#uses=4] + %Y = alloca i32, align 4 ; <i32*> [#uses=4] + %Z = alloca i32, align 4 ; <i32*> [#uses=3] + %0 = bitcast i32* %X to {}* ; <{}*> [#uses=1] + call void @llvm.dbg.declare(metadata !{i32 * %X}, metadata !0), !dbg !7 store i32 21, i32* %X, !dbg !8 - %1 = bitcast i32* %Y to { }* ; <{ }*> [#uses=1] - call void @llvm.dbg.declare({ }* %1, metadata !9), !dbg !10 + %1 = bitcast i32* %Y to {}* ; <{}*> [#uses=1] + call void @llvm.dbg.declare(metadata !{i32 * %Y}, metadata !9), !dbg !10 store i32 22, i32* %Y, !dbg !11 - %2 = bitcast i32* %Z to { }* ; <{ }*> [#uses=1] - call void @llvm.dbg.declare({ }* %2, metadata !12), !dbg !14 + %2 = bitcast i32* %Z to {}* ; <{}*> [#uses=1] + call void @llvm.dbg.declare(metadata !{i32 * %Z}, metadata !12), !dbg !14 store i32 23, i32* %Z, !dbg !15 - %tmp = load i32* %X, !dbg !16 ; [#uses=1] - %tmp1 = load i32* %Y, !dbg !16 ; [#uses=1] - %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; [#uses=1] + %tmp = load i32* %X, !dbg !16 ; <i32> [#uses=1] + %tmp1 = load i32* %Y, !dbg !16 ; <i32> [#uses=1] + %add = add nsw i32 %tmp, %tmp1, !dbg !16 ; <i32> [#uses=1] store i32 %add, i32* %Z, !dbg !16 - %tmp2 = load i32* %Y, !dbg !17 ; [#uses=1] + %tmp2 = load i32* %Y, !dbg !17 ; <i32> [#uses=1] store i32 %tmp2, i32* %X, !dbg !17 ret void, !dbg !18 } -declare void @llvm.dbg.declare({ }*, metadata) nounwind readnone +declare void @llvm.dbg.declare(metadata, metadata) nounwind readnone !0 = metadata !{i32 459008, metadata !1, metadata !"X", metadata !3, i32 2, metadata !6}; [ DW_TAG_auto_variable ] @@ -875,8 +919,8 @@ declare void @llvm.dbg.declare({ }*, metadata) nounwind readnone function. -@@ -910,8 +954,8 @@ call void @llvm.dbg.declare({ }* %0, metadata !0), !dbg !7-call void @llvm.dbg.declare({ }* %0, metadata !0), !dbg !7 ++call void @llvm.dbg.declare(metadata, metadata !0), !dbg !7Now lets take another example.
-@@ -928,7 +972,7 @@ call void @llvm.dbg.declare({ }* %2, metadata !12), !dbg !14-call void @llvm.dbg.declare({ }* %2, metadata !12), !dbg !14 ++call void @llvm.dbg.declare(metadata, metadata !12), !dbg !14
Here !14 indicates that Z is declaread at line number 5 and +
Here !14 indicates that Z is declared at line number 5 and column number 9 inside of lexical scope !13. The lexical scope itself resides inside of lexical scope !1 described above.
@@ -992,10 +1036,10 @@ int main(int argc, char *argv[]) {... ;; -;; Define the compile unit for the source file "/Users/mine/sources/MySource.cpp". +;; Define the compile unit for the main source file "/Users/mine/sources/MySource.cpp". ;; -!3 = metadata !{ - i32 458769, ;; Tag +!2 = metadata !{ + i32 524305, ;; Tag i32 0, ;; Unused i32 4, ;; Language Id metadata !"MySource.cpp", @@ -1007,24 +1051,41 @@ int main(int argc, char *argv[]) { i32 0} ;; Runtime version ;; -;; Define the compile unit for the header file "/Users/mine/sources/MyHeader.h". +;; Define the file for the file "/Users/mine/sources/MySource.cpp". ;; !1 = metadata !{ - i32 458769, ;; Tag - i32 0, ;; Unused - i32 4, ;; Language Id - metadata !"MyHeader.h", + i32 524329, ;; Tag + metadata !"MySource.cpp", metadata !"/Users/mine/sources", - metadata !"4.2.1 (Based on Apple Inc. build 5649) (LLVM build 00)", - i1 false, ;; Main Compile Unit - i1 false, ;; Optimized compile unit - metadata !"", ;; Compiler flags - i32 0} ;; Runtime version + metadata !2 ;; Compile unit +} + +;; +;; Define the file for the file "/Users/mine/sources/Myheader.h" +;; +!3 = metadata !{ + i32 524329, ;; Tag + metadata !"Myheader.h" + metadata !"/Users/mine/sources", + metadata !2 ;; Compile unit +} ...
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(). +
+ if (MDNode *N = I->getMetadata("dbg")) { // Here I is an LLVM instruction + DILocation Loc(N); // DILocation is in DebugInfo.h + unsigned Line = Loc.getLineNumber(); + StringRef File = Loc.getFilename(); + StringRef Dir = Loc.getDirectory(); + } +@@ -1061,15 +1122,15 @@ int MyGlobal = 100; ;; variable anchor and the global variable itself. ;; !0 = metadata !{ - i32 458804, ;; Tag + i32 524340, ;; Tag i32 0, ;; Unused metadata !1, ;; Context metadata !"MyGlobal", ;; Name metadata !"MyGlobal", ;; Display Name metadata !"MyGlobal", ;; Linkage Name - metadata !1, ;; Compile Unit + metadata !3, ;; Compile Unit i32 1, ;; Line Number - metadata !2, ;; Type + metadata !4, ;; Type i1 false, ;; Is a local variable i1 true, ;; Is this a definition i32* @MyGlobal ;; The global variable @@ -1079,11 +1140,11 @@ int MyGlobal = 100; ;; Define the basic type of 32 bit signed integer. Note that since int is an ;; intrinsic type the source file is NULL and line 0. ;; -!2 = metadata !{ - i32 458788, ;; Tag +!4 = metadata !{ + i32 524324, ;; Tag metadata !1, ;; Context metadata !"int", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in Bits i64 32, ;; Align in Bits @@ -1123,16 +1184,16 @@ int main(int argc, char *argv[]) { ;; anchor is 46, which is the same as the tag for subprograms ;; (46 = DW_TAG_subprogram.) ;; -!0 = metadata !{ - i32 458798, ;; Tag +!6 = metadata !{ + i32 524334, ;; Tag i32 0, ;; Unused metadata !1, ;; Context metadata !"main", ;; Name metadata !"main", ;; Display name metadata !"main", ;; Linkage name - metadata !1, ;; Compile unit + metadata !1, ;; File i32 1, ;; Line number - metadata !2, ;; Type + metadata !4, ;; Type i1 false, ;; Is local i1 true ;; Is definition } @@ -1168,10 +1229,10 @@ define i32 @main(i32 %argc, i8** %argv) {
!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"bool", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 8, ;; Size in Bits i64 8, ;; Align in Bits @@ -1194,10 +1255,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"char", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 8, ;; Size in Bits i64 8, ;; Align in Bits @@ -1220,10 +1281,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"unsigned char", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 8, ;; Size in Bits i64 8, ;; Align in Bits @@ -1246,10 +1307,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"short int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 16, ;; Size in Bits i64 16, ;; Align in Bits @@ -1272,10 +1333,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"short unsigned int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 16, ;; Size in Bits i64 16, ;; Align in Bits @@ -1298,10 +1359,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"int", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in Bits i64 32, ;; Align in Bits @@ -1323,10 +1384,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"unsigned int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in Bits i64 32, ;; Align in Bits @@ -1349,10 +1410,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"long long int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 64, ;; Size in Bits i64 64, ;; Align in Bits @@ -1375,10 +1436,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"long long unsigned int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 64, ;; Size in Bits i64 64, ;; Align in Bits @@ -1401,10 +1462,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"float", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in Bits i64 32, ;; Align in Bits @@ -1427,10 +1488,10 @@ define i32 @main(i32 %argc, i8** %argv) {!2 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"double",;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 64, ;; Size in Bits i64 64, ;; Align in Bits @@ -1466,10 +1527,10 @@ typedef const int *IntPtr; ;; Define the typedef "IntPtr". ;; !2 = metadata !{ - i32 458774, ;; Tag + i32 524310, ;; Tag metadata !1, ;; Context metadata !"IntPtr", ;; Name - metadata !3, ;; Compile unit + metadata !3, ;; File i32 0, ;; Line number i64 0, ;; Size in bits i64 0, ;; Align in bits @@ -1482,10 +1543,10 @@ typedef const int *IntPtr; ;; Define the pointer type. ;; !4 = metadata !{ - i32 458767, ;; Tag + i32 524303, ;; Tag metadata !1, ;; Context metadata !"", ;; Name - metadata !1, ;; Compile unit + metadata !1, ;; File i32 0, ;; Line number i64 64, ;; Size in bits i64 64, ;; Align in bits @@ -1497,10 +1558,10 @@ typedef const int *IntPtr; ;; Define the const type. ;; !5 = metadata !{ - i32 458790, ;; Tag + i32 524326, ;; Tag metadata !1, ;; Context metadata !"", ;; Name - metadata !1, ;; Compile unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1512,10 +1573,10 @@ typedef const int *IntPtr; ;; Define the int type. ;; !6 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"int", ;; Name - metadata !1, ;; Compile unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1555,10 +1616,10 @@ struct Color { ;; Define basic type for unsigned int. ;; !5 = metadata !{ - i32 458788, ;; Tag + i32 524324, ;; Tag metadata !1, ;; Context metadata !"unsigned int", - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 0, ;; Line number i64 32, ;; Size in Bits i64 32, ;; Align in Bits @@ -1570,7 +1631,7 @@ struct Color { ;; Define composite type for struct Color. ;; !2 = metadata !{ - i32 458771, ;; Tag + i32 524307, ;; Tag metadata !1, ;; Context metadata !"Color", ;; Name metadata !1, ;; Compile unit @@ -1588,10 +1649,10 @@ struct Color { ;; Define the Red field. ;; !4 = metadata !{ - i32 458765, ;; Tag + i32 524301, ;; Tag metadata !1, ;; Context metadata !"Red", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 2, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1604,10 +1665,10 @@ struct Color { ;; Define the Green field. ;; !6 = metadata !{ - i32 458765, ;; Tag + i32 524301, ;; Tag metadata !1, ;; Context metadata !"Green", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 3, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1620,10 +1681,10 @@ struct Color { ;; Define the Blue field. ;; !7 = metadata !{ - i32 458765, ;; Tag + i32 524301, ;; Tag metadata !1, ;; Context metadata !"Blue", ;; Name - metadata !1, ;; Compile Unit + metadata !1, ;; File i32 4, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1668,10 +1729,10 @@ enum Trees { ;; Define composite type for enum Trees ;; !2 = metadata !{ - i32 458756, ;; Tag + i32 524292, ;; Tag metadata !1, ;; Context metadata !"Trees", ;; Name - metadata !1, ;; Compile unit + metadata !1, ;; File i32 1, ;; Line number i64 32, ;; Size in bits i64 32, ;; Align in bits @@ -1690,17 +1751,17 @@ enum Trees { ;; ;; Define Spruce enumerator. ;; -!4 = metadata !{i32 458792, metadata !"Spruce", i64 100} +!4 = metadata !{i32 524328, metadata !"Spruce", i64 100} ;; ;; Define Oak enumerator. ;; -!5 = metadata !{i32 458792, metadata !"Oak", i64 200} +!5 = metadata !{i32 524328, metadata !"Oak", i64 200} ;; ;; Define Maple enumerator. ;; -!6 = metadata !{i32 458792, metadata !"Maple", i64 300} +!6 = metadata !{i32 524328, metadata !"Maple", i64 300}