Devang Patel
2009-Sep-10 17:48 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
Hi All, Today, debugging information is encoded in LLVM IR using various llvm.dbg intrinsics, such as llvm.dbg.stoppoint. For exmaple, !1 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", metadata !"/tmp", metadata !"clang 1.0", i1 true, i1 false, metadata !"", i32 0} ... call void @llvm.dbg.stoppoint(i32 5, i32 5, metadata !1) store i32 42, i32* %i call void @llvm.dbg.stoppoint(i32 6, i32 5, metadata !1) store i32 1, i32* %j.addr br label %if.end ... This approach has several disadvantages. - The llvm.dbg.stoppoint()s act like hurdles to the optimizer. The LLVM customers expect that the optimizer does not trip over these hurdles. They expect LLVM to produce same high quality code irrespective of the presence of debug info. It is a tedious and never ending task to ensure that the optimizer safely ignores these llvm.dbg intrinsics. - The instructions lose original location info when the optimizer moves them around. - It is extremely error prone to keep track of lexical scopes and inlined functions using a pair of llvm.dbg intrinsics. The proposed solution is to optionally attach debug information with llvm instruction directly. A new keyword 'dbg' is used to identify debugging information associated with an instruction. The debugging information, if available, is printed after the last instruction operand. The debugging information entry uses MDNode and it is not counted as an instruction operand. For example, !1 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", metadata !"/tmp", metadata !"clang 1.0", i1 true, i1 false, metadata !"", i32 0} !7 = metadata !{i32 5, i32 5, metadata !1, metadata !1} !8 = metadata !{i32 6, i32 5, metadata !1, metadata !1} ... store i32 42, i32* %i, dbg metadata !7 store i32 1, i32* %j.addr, dbg metadata !8 br label %if.end, dbg metadata !8 ... Now, the optimizer does not need to worry about those llvm.dbg hurdles. Instructions do not lose their location information when they are rearranged in instruction stream. And the stage is set to produce, preserve and emit accurate debug information for inlined functions. Any thoughts/suggestions/questions ? - Devang
Mike Stump
2009-Sep-10 18:10 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Sep 10, 2009, at 10:48 AM, Devang Patel wrote:> Any thoughts/suggestions/questions ?Sounds good to me.
Chris Lattner
2009-Sep-10 20:14 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Sep 10, 2009, at 10:48 AM, Devang Patel wrote:> Hi All, > > Today, debugging information is encoded in LLVM IR using various > llvm.dbg intrinsics, such as llvm.dbg.stoppoint. For exmaple,Right.> This approach has several disadvantages. > - The llvm.dbg.stoppoint()s act like hurdles to the optimizer. The > LLVM customers expect that the optimizer does not trip over these > hurdles. They expect LLVM to produce same high quality code > irrespective of the presence of debug info. It is a tedious and never > ending task to ensure that the optimizer safely ignores these llvm.dbg > intrinsics.This is not a problem with stoppoints. Even after we eliminate stoppoints, we'll still have the same thing for other debug info.> - The instructions lose original location info when the optimizer > moves them around. > - It is extremely error prone to keep track of lexical scopes and > inlined functions using a pair of llvm.dbg intrinsics.Right.> The proposed solution is to optionally attach debug information with > llvm instruction directly. A new keyword 'dbg' is used to identify > debugging information associated with an instruction. The debugging > information, if available, is printed after the last instruction > operand. The debugging information entry uses MDNode and it is not > counted as an instruction operand. For example, > > !1 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", metadata > !"/tmp", metadata !"clang 1.0", i1 true, i1 false, metadata !"", i32 > 0} > !7 = metadata !{i32 5, i32 5, metadata !1, metadata !1} > !8 = metadata !{i32 6, i32 5, metadata !1, metadata !1} > > ... > store i32 42, i32* %i, dbg metadata !7 > store i32 1, i32* %j.addr, dbg metadata !8 > br label %if.end, dbg metadata !8 > ...Instead of 'dbg metadata !7', is it sufficient to have 'dbg !7'? I think this is a pretty reasonable syntax, we can even get the asmprinter to handle this as a special case and print it as: store i32 42, i32* %i, dbg metadata !{i32 5, i32 5, metadata !1, metadata !1} which makes it easier to read.> Now, the optimizer does not need to worry about those llvm.dbg > hurdles. Instructions do not lose their location information when they > are rearranged in instruction stream. And the stage is set to produce, > preserve and emit accurate debug information for inlined functions.Sounds nice! -Chris
Eric Christopher
2009-Sep-10 20:33 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Sep 10, 2009, at 10:48 AM, Devang Patel wrote:> The proposed solution is to optionally attach debug information with > llvm instruction directly. A new keyword 'dbg' is used to identify > debugging information associated with an instruction. The debugging > information, if available, is printed after the last instruction > operand. The debugging information entry uses MDNode and it is not > counted as an instruction operand. For example, > > !1 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", metadata > !"/tmp", metadata !"clang 1.0", i1 true, i1 false, metadata !"", i32 > 0} > !7 = metadata !{i32 5, i32 5, metadata !1, metadata !1} > !8 = metadata !{i32 6, i32 5, metadata !1, metadata !1} > > ... > store i32 42, i32* %i, dbg metadata !7 > store i32 1, i32* %j.addr, dbg metadata !8 > br label %if.end, dbg metadata !8 > ...So, if we later wanted to attach some other metadata to an instruction it would look something like: store i32 42, i32* %i, dbg metadata !7, spork !15 or some such? And when you attach the metadata to the instruction how do you plan on making it evident as debug as opposed to spork? -eric
Török Edwin
2009-Sep-10 20:39 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On 2009-09-10 20:48, Devang Patel wrote:> Now, the optimizer does not need to worry about those llvm.dbg > hurdles. Instructions do not lose their location information when they > are rearranged in instruction stream. And the stage is set to produce, > preserve and emit accurate debug information for inlined functions. > > Any thoughts/suggestions/questions ? >Sounds good. To ease transition from LLVM 2.6->2.7, could there be a pass that adds back the llvm.dbg intrinsics based on the metadata on the instructions? No in-tree pass should need that, but it could help external projects that rely on stoppoints being present. Also would it be possible to have source:line debuginfo generated for macros (at least in clang)? The debug info generated by gcc, llvm-gcc or clang doesn't deal with macros in a way that would allow single-stepping through them. -g3 in gcc allows me to expand a macro from gcc, but thats it, as far as debugging is concerned it acts like a single instruction, not single-steppable. I generally tend to avoid the use of macros that do something non-trivial (i.e. requires debugging), but unfortunately C doesn't support templates, so in some situations I am forced to use macros, instead of functions. Best regards, --Edwin
Chris Lattner
2009-Sep-10 21:10 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Sep 10, 2009, at 1:33 PM, Eric Christopher wrote:>> store i32 42, i32* %i, dbg metadata !7 >> store i32 1, i32* %j.addr, dbg metadata !8 >> br label %if.end, dbg metadata !8 >> ... > > So, if we later wanted to attach some other metadata to an instruction > it would look something like: > > store i32 42, i32* %i, dbg metadata !7, spork !15 > > or some such? And when you attach the metadata to the instruction how > do you plan on making it evident as debug as opposed to spork?yes, I'll send out a proposal to cover this in the next couple days. -Chris
Devang Patel
2009-Sep-10 21:52 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Thu, Sep 10, 2009 at 1:14 PM, Chris Lattner <clattner at apple.com> wrote:>> ... >> store i32 42, i32* %i, dbg metadata !7 >> store i32 1, i32* %j.addr, dbg metadata !8 >> br label %if.end, dbg metadata !8 >> ... > > Instead of 'dbg metadata !7', is it sufficient to have 'dbg !7'?It is! In fact, that's what my prototype does. - Devang
Richard Pennington
2009-Sep-10 21:55 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
Devang Patel wrote:> > store i32 42, i32* %i, dbg metadata !7 > store i32 1, i32* %j.addr, dbg metadata !8 > br label %if.end, dbg metadata !8 > ... > > > Now, the optimizer does not need to worry about those llvm.dbg > hurdles. Instructions do not lose their location information when they > are rearranged in instruction stream. And the stage is set to produce, > preserve and emit accurate debug information for inlined functions. >I like this. Would it be very ugly to treat stoppoint like a pseudo op that filled in the metadata for subsequent instructions until the end of the basic block? It might help for backward compatibility. -Rich
Devang Patel
2009-Sep-10 21:56 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
2009/9/10 Török Edwin <edwintorok at gmail.com>:> On 2009-09-10 20:48, Devang Patel wrote: >> Now, the optimizer does not need to worry about those llvm.dbg >> hurdles. Instructions do not lose their location information when they >> are rearranged in instruction stream. And the stage is set to produce, >> preserve and emit accurate debug information for inlined functions. >> >> Any thoughts/suggestions/questions ? >> > > Sounds good. > > To ease transition from LLVM 2.6->2.7, could there be a pass that adds > back the llvm.dbg intrinsics based on the metadata on the instructions?I'd prefer to not overload llvm.dbg intrinsics, if possible.> No in-tree pass should need that, but it could help external projects > that rely on stoppoints being present... just during transition or forever ? - Devang
Duncan Sands
2009-Sep-11 07:15 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
> So, if we later wanted to attach some other metadata to an instruction > it would look something like:For example, we may want to attach a list of typeinfos to invokes, representing the catch clauses. Ciao, Duncan.
David Greene
2009-Sep-11 21:57 UTC
[LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
On Thursday 10 September 2009 12:48, Devang Patel wrote:> !1 = metadata !{i32 458769, i32 0, i32 12, metadata !"foo.c", metadata > !"/tmp", metadata !"clang 1.0", i1 true, i1 false, metadata !"", i32 > 0} > !7 = metadata !{i32 5, i32 5, metadata !1, metadata !1} > !8 = metadata !{i32 6, i32 5, metadata !1, metadata !1} > > ... > store i32 42, i32* %i, dbg metadata !7 > store i32 1, i32* %j.addr, dbg metadata !8 > br label %if.end, dbg metadata !8 > ...Hooray! I like this and the suggestions others have brought forward to enhance it. -Dave
Maybe Matching Threads
- [LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
- [LLVMdev] [PROPOSAL] Attach debugging information with LLVM instruction
- [LLVMdev] Optimizations and debug info
- [LLVMdev] Optimizations and debug info
- [LLVMdev] llvm-gcc: missing dbg.declare/dbg.stoppoint at optimization level > O0