configure: keep relative paths in debug info #22409

pull S3RK wants to merge 2 commits into bitcoin:master from S3RK:debug_keep_relative_path changing 2 files +32 −2

S3RK commented at 7:22 AM on July 6, 2021: member

This is a follow-up for #20353 that fixes #21885

It also adds a small section to assist debugging without absolute paths in debug info.

configure: keep relative paths in debug info

Revert to the state prior to e507acbe and allow debugging
from project root dir with `gdb src/bitcoind`.

a8b515c317

S3RK commented at 7:22 AM on July 6, 2021: member

Thanks @ajtowns for the idea and consultation
fanquake added the label Build system on Jul 6, 2021
in doc/developer-notes.md:256 in 4f19a84a9b outdated
```
 249 | @@ -249,6 +250,23 @@ Development tips and tricks
 250 |  Run configure with `--enable-debug` to add additional compiler flags that
 251 |  produce better debugging builds.
 252 |  
 253 | +### Show sources in debugging
 254 | +
 255 | +Absolute paths are stripped from debug information with -fdebug-prefix-map and
 256 | +-fmacro-prefix-map options. In case you move binaries after compilation or use
```
ajtowns commented at 11:50 AM on July 6, 2021:

May be worth noting some or all of:

this is only when compiling with ccache enabled (and only if the compiler supports it)

that it breaks running "lldb ./bitcoind" (etc) when your cwd is the src/ directory, even if you don't move the file around (gdb magically works fine, it seems) -- and that this can be worked around by creating a "src -> ." symlink within the src/ directory.

the debugedit binary (available on debian/red hat based distros) can be used to edit the binaries to make the debug path absolute as well
S3RK commented at 7:30 AM on July 7, 2021:

Updated. Please take another look
laanwj commented at 1:44 PM on July 6, 2021: member

Concept ACK
ttloves2 changes_requested
ttloves2 commented at 5:59 AM on July 7, 2021: none

Closed???
S3RK force-pushed on Jul 7, 2021

in doc/developer-notes.md:256 in 01d049e0eb outdated

 249 | @@ -249,6 +250,35 @@ Development tips and tricks
 250 |  Run configure with `--enable-debug` to add additional compiler flags that
 251 |  produce better debugging builds.
 252 |  
 253 | +### Show sources in debugging
 254 | +
 255 | +If you have ccache enabled absolute paths are stripped from debug information
 256 | +with -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the

MarcoFalke commented at 4:32 PM on July 7, 2021:

with -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the

from the linter

S3RK commented at 6:56 AM on July 8, 2021:

Thanks for extracting this out from the logs. Fixed

S3RK force-pushed on Jul 8, 2021
practicalswift commented at 8:08 PM on July 24, 2021: contributor

Concept ACK
tryphe commented at 3:41 AM on August 1, 2021: contributor

Concept ACK
S3RK commented at 9:57 AM on August 21, 2021: member

@practicalswift @MarcoFalke @ajtowns Interested in doing a full review?
Zero-1729 commented at 11:15 AM on August 21, 2021: contributor

Concept ACK

in doc/developer-notes.md:255 in 6205f85d23 outdated

 249 | @@ -249,6 +250,35 @@ Development tips and tricks
 250 |  Run configure with `--enable-debug` to add additional compiler flags that
 251 |  produce better debugging builds.
 252 |  
 253 | +### Show sources in debugging
 254 | +
 255 | +If you have ccache enabled absolute paths are stripped from debug information

Zero-1729 commented at 12:09 PM on August 21, 2021:

minor grammar nits (cont'd below), feel free to ignore:

If you have ccache enabled, absolute paths are stripped from debug information

in doc/developer-notes.md:256 in 6205f85d23 outdated

 249 | @@ -249,6 +250,35 @@ Development tips and tricks
 250 |  Run configure with `--enable-debug` to add additional compiler flags that
 251 |  produce better debugging builds.
 252 |  
 253 | +### Show sources in debugging
 254 | +
 255 | +If you have ccache enabled absolute paths are stripped from debug information
 256 | +with -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the

Zero-1729 commented at 12:09 PM on August 21, 2021:

with the -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the

in doc/developer-notes.md:258 in 6205f85d23 outdated

 249 | @@ -249,6 +250,35 @@ Development tips and tricks
 250 |  Run configure with `--enable-debug` to add additional compiler flags that
 251 |  produce better debugging builds.
 252 |  
 253 | +### Show sources in debugging
 254 | +
 255 | +If you have ccache enabled absolute paths are stripped from debug information
 256 | +with -fdebug-prefix-map and -fmacro-prefix-map options (if supported by the
 257 | +compiler). This might break source file detection in case you move binaries
 258 | +after compilation, debug from the directory other than project root or use

Zero-1729 commented at 12:09 PM on August 21, 2021:

after compilation, debug from the directory other than the project root or use

jonatack commented at 3:59 PM on August 21, 2021: member

Concept ACK
doc: add info for debugging with relative paths 0bc666b053
S3RK force-pushed on Aug 21, 2021
S3RK commented at 6:44 PM on August 21, 2021: member

Fixed grammar, thanks @Zero-1729
Zero-1729 commented at 7:12 PM on August 21, 2021: contributor

Light crACK 0bc666b053b8f4883c3f5de43959e2bbd91b95c5
MarcoFalke commented at 11:29 AM on August 25, 2021: member

The commit id you reference in the commit message is wrong.
MarcoFalke commented at 11:53 AM on August 25, 2021: member

I tested this in Clion and it didn't change anything for me: Before and After the same error:

Reverting commit e507acb was a working workaround. Maybe #21885 (comment) also works.
MarcoFalke commented at 11:55 AM on August 25, 2021: member

I tested this in Clion and it didn't change anything for me: Before and After the same error:

I guess I'll still have to apply one of the workarounds you mention in the doc?
S3RK commented at 8:02 PM on August 25, 2021: member

I referenced merge commit as it has PR number for the expanded context, can change to the other commit once I get to my laptop.

I tested this in Clion and it didn't change anything for me: Before and After the same error:

I guess I'll still have to apply one of the workarounds you mention in the doc?

Yes, unfortunately CLion uses absolute paths to set breakpoints, so you need one of the workarounds. Alternatively, you can use new "Relaxed breakpoints" feature starting from 2021.2 that uses file name only matching.

This PR makes it again possible to debug from the project root dir with gdb arc/bitcoind

kallewoof commented at 4:05 AM on September 22, 2021: member

Tested ACK 0bc666b053b8f4883c3f5de43959e2bbd91b95c5

lldb src/bitcoind on master:

* thread [#13](/bitcoin-bitcoin/13/), name = 'b-httpworker.2', stop reason = step over
    frame [#0](/bitcoin-bitcoin/0/): 0x0000000100c87baf bitcoind`LegacyScriptPubKeyMan::IsMine(this=0x000000010cbdb1e0, script=0x0000000110190988) const at scriptpubkeyman.cpp:226:1
Target 0: (bitcoind) stopped.

Using this PR:

* thread [#11](/bitcoin-bitcoin/11/), name = 'b-httpworker.0', stop reason = breakpoint 1.6
    frame [#0](/bitcoin-bitcoin/0/): 0x0000000100cfca46 bitcoind`CWallet::IsMine(this=0x000000010490e310, txout=0x00000001090052c0) const at wallet.cpp:1299:5
   1296
   1297	isminetype CWallet::IsMine(const CTxOut& txout) const
   1298	{
-> 1299	    AssertLockHeld(cs_wallet);
   1300	    return IsMine(txout.scriptPubKey);
   1301	}
   1302
Target 0: (bitcoind) stopped.

(note lack of any line numbers in master)

fanquake commented at 2:34 AM on October 11, 2021: member

Going to merge this now, as it's an improvement for debugging (the current issue has tripped up a few people), without losing the behaviour from #20353.
fanquake merged this on Oct 11, 2021
fanquake closed this on Oct 11, 2021
sidhujag referenced this in commit 553b7e7dfa on Oct 11, 2021
PastaPastaPasta referenced this in commit 87caa91a99 on Apr 3, 2022
gades referenced this in commit 3c7c32baf4 on May 9, 2022
DrahtBot locked this on Oct 30, 2022

Contributors

Labels

Linked (view graph)

#20353 configure: Support -fdebug-prefix-map and -fmacro-prefix-map #21885 Debugging does not work after commit e507acb (PR #20353)#34081 build: Fix source paths for debugging in CMake