[bug#42882] [PATCH] system: Modify GDB skeleton to find debug files for any profile.

[bug#42882] [PATCH] system: Modify GDB skeleton to find debug files for any profile.

[Maxim Cournoyer]

Instead of hard coding the debug directory to that of the user profile, use
Guile scripting to derive the debug file directories from the LIBRARY_PATH
environment variable.

* gnu/system/shadow.scm (default-skeletons)[gdbinit]: Derive the value of
DEBUG-FILE-DIRECTORY via the environment variable LIBRARY_PATH, so that debug
files from any profile can be found.
* doc/guix.texi (Installing Debugging Files): Document it.
---
 doc/guix.texi         | 17 +++++++++++++++++
 gnu/system/shadow.scm | 11 ++++++++++-
 2 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 587c004bee..53b85418fb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -30145,6 +30145,23 @@ GDB}):
 From there on, GDB will pick up debugging information from the
 @file{.debug} files under @file{~/.guix-profile/lib/debug}.
 
+Below is an alternative GDB script that can be useful when working with
+other profiles.  It takes advantage of the Guile integration available
+in GDB.
+
+@example
+guile
+(begin
+  (use-modules (gdb)
+               (srfi srfi-26))
+  (let* ((library-paths (string-split (getenv "LIBRARY_PATH") #\:))
+         (debug-paths (map (cut string-append <> "/debug")
+                           library-paths)))
+    (execute (format #f "set debug-file-directory ~a"
+                     (string-join debug-paths ":")))))
+end
+@example
+
 In addition, you will most likely want GDB to be able to show the source
 code being debugged.  To do that, you will have to unpack the source
 code of the package of interest (obtained with @code{guix build
diff --git a/gnu/system/shadow.scm b/gnu/system/shadow.scm
index a69339bc07..d31cd37077 100644
--- a/gnu/system/shadow.scm
+++ b/gnu/system/shadow.scm
@@ -162,7 +162,16 @@ XTerm*utf8: always
 XTerm*metaSendsEscape: true\n"))
         (gdbinit   (plain-file "gdbinit" "\
 # Tell GDB where to look for separate debugging files.
-set debug-file-directory ~/.guix-profile/lib/debug
+guile
+(begin
+  (use-modules (gdb)
+               (srfi srfi-26))
+  (let* ((library-paths (string-split (getenv \"LIBRARY_PATH\") #\\:))
+         (debug-paths (map (cut string-append <> \"/debug\")
+                           library-paths)))
+    (execute (format #f \"set debug-file-directory ~a\"
+                     (string-join debug-paths \":\")))))
+end
 
 # Authorize extensions found in the store, such as the
 # pretty-printers of libstdc++.
-- 
2.27.0

[bug#42882] [PATCH] system: Modify GDB skeleton to find debug files for any profile.

[Mathieu Othacehe]

Hello Maxim,

> +Below is an alternative GDB script that can be useful when working with
> +other profiles.  It takes advantage of the Guile integration available
> +in GDB.

You could say the "optional Guile integration", because it is (sadly)
disabled on Ubuntu's gdb build for instance.

> +
> +@example
> +guile
> +(begin
> +  (use-modules (gdb)
> +               (srfi srfi-26))
> +  (let* ((library-paths (string-split (getenv "LIBRARY_PATH") #\:))
> +         (debug-paths (map (cut string-append <> "/debug")
> +                           library-paths)))
> +    (execute (format #f "set debug-file-directory ~a"
> +                     (string-join debug-paths ":")))))
> +end
> +@example

And maybe precise that this very snippet will be installed by default as
.gdbinit on Guix System?

Otherwise it looks fine to me.

Thanks,

Mathieu

[bug#42882]

[Maxim Cournoyer]

Hello Mathieu,

Thanks for the review!  I've taken into account your suggestions and improved
the mechanism a bit, so that we can now simply use the
GDB_DEBUG_FILE_DIRECTORY environment variable (which is set up by a new search
path specification defined on the gdb package). I think this is better as
otherwise you'd need to ensure the gcc-toolchain is installed in the profile
you want GDB to find the debug files (because GCC is responsible for setting
the LIBRARY_PATH environment variable).

I hope it makes sense :-).

This will need to go to core-updates as gdb is has about 1500 dependents.

Thanks!

Maxim

[bug#42882] [PATCH v3] system: Modify GDB skeleton to find debug files for any profile.

[Maxim Cournoyer]

Instead of hard coding the debug directory to that of the user profile, use
Guile scripting in combination with a new search path specification on GDB to
specify the debug file directories.

* gnu/packages/gdb.scm (gdb-9.1): Add a search path specification for the
GDB_DEBUG_FILE_DIRECTORY environment variable.
* gnu/system/shadow.scm (default-skeletons)[gdbinit]: Derive the value of
DEBUG-FILE-DIRECTORY via the GDB_DEBUG_FILE_DIRECTORY environment variable.
* doc/guix.texi (Installing Debugging Files): Document it.
---
 doc/guix.texi         | 14 ++++++++++++++
 gnu/packages/gdb.scm  |  7 +++++++
 gnu/system/shadow.scm |  8 +++++++-
 3 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 587c004bee..a066cddfe5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -30145,6 +30145,20 @@ GDB}):
 From there on, GDB will pick up debugging information from the
 @file{.debug} files under @file{~/.guix-profile/lib/debug}.
 
+Below is an alternative GDB script which is useful when working with
+other profiles.  It takes advantage of the optional Guile integration in
+GDB.  This snippet is included by default on Guix System in the
+@file{~/.gdbinit} file.
+
+@example
+guile
+(use-modules (gdb))
+(execute (string-append "set debug-file-directory "
+                        (or (getenv "GDB_DEBUG_FILE_DIRECTORY")
+                            "~/.guix-profile/lib/debug")))
+end
+@end example
+
 In addition, you will most likely want GDB to be able to show the source
 code being debugged.  To do that, you will have to unpack the source
 code of the package of interest (obtained with @code{guix build
diff --git a/gnu/packages/gdb.scm b/gnu/packages/gdb.scm
index 830121751f..11e0bb3e76 100644
--- a/gnu/packages/gdb.scm
+++ b/gnu/packages/gdb.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
 ;;; Copyright © 2020 Vincent Legoll <vincent.legoll@gmail.com>
 ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -117,6 +118,12 @@
         ("dejagnu" ,dejagnu)
         ("pkg-config" ,pkg-config)
         ,@(if (hurd-target?) `(("mig" ,mig)) '())))
+    ;; TODO: Add support for the GDB_DEBUG_FILE_DIRECTORY environment variable
+    ;; in GDB itself instead of relying on some glue code in the Guix-provided
+    ;; .gdbinit file.
+    (native-search-paths (list (search-path-specification
+                                (variable "GDB_DEBUG_FILE_DIRECTORY")
+                                (files '("lib/debug")))))
     (home-page "https://www.gnu.org/software/gdb/")
     (synopsis "The GNU debugger")
     (description
diff --git a/gnu/system/shadow.scm b/gnu/system/shadow.scm
index a69339bc07..8c76bc2b11 100644
--- a/gnu/system/shadow.scm
+++ b/gnu/system/shadow.scm
@@ -3,6 +3,7 @@
 ;;; Copyright © 2016 Alex Griffin <a@ajgrf.com>
 ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
 ;;; Copyright © 2020 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,7 +163,12 @@ XTerm*utf8: always
 XTerm*metaSendsEscape: true\n"))
         (gdbinit   (plain-file "gdbinit" "\
 # Tell GDB where to look for separate debugging files.
-set debug-file-directory ~/.guix-profile/lib/debug
+guile
+(use-modules (gdb))
+(execute (string-append \"set debug-file-directory \"
+                        (or (getenv \"GDB_DEBUG_FILE_DIRECTORY\")
+                            \"~/.guix-profile/lib/debug\")))
+end
 
 # Authorize extensions found in the store, such as the
 # pretty-printers of libstdc++.
-- 
2.27.0

[bug#42882]

[Mathieu Othacehe]

Hey Maxim,

> Thanks for the review!  I've taken into account your suggestions and improved
> the mechanism a bit, so that we can now simply use the
> GDB_DEBUG_FILE_DIRECTORY environment variable (which is set up by a new search
> path specification defined on the gdb package). I think this is better as
> otherwise you'd need to ensure the gcc-toolchain is installed in the profile
> you want GDB to find the debug files (because GCC is responsible for setting
> the LIBRARY_PATH environment variable).
>
> I hope it makes sense :-).

I think it makes! Your last revision seems fine to me.

Thanks,

Mathieu

bug#42882:

[Maxim Cournoyer]

Mathieu Othacehe <othacehe@gnu.org> writes:

> Hey Maxim,
>
>> Thanks for the review!  I've taken into account your suggestions and improved
>> the mechanism a bit, so that we can now simply use the
>> GDB_DEBUG_FILE_DIRECTORY environment variable (which is set up by a new search
>> path specification defined on the gdb package). I think this is better as
>> otherwise you'd need to ensure the gcc-toolchain is installed in the profile
>> you want GDB to find the debug files (because GCC is responsible for setting
>> the LIBRARY_PATH environment variable).
>>
>> I hope it makes sense :-).
>
> I think it makes! Your last revision seems fine to me.
>
> Thanks,
>
> Mathieu

Thanks for taking a look!  I've now pushed this change into the
core-updates branch as commit 720a4adc91.

Thank you,

Maxim

[bug#42882] [PATCH] system: Modify GDB skeleton to find debug files for any profile.

[Maxim Cournoyer]

Instead of hard coding the debug directory to that of the user profile, use
Guile scripting in combination with a new search path specification on GDB to
specify the debug file directories.

* gnu/packages/gdb.scm (gdb-9.1): Add a search path specification for the
GDB_DEBUG_FILE_DIRECTORY environment variable.
* gnu/system/shadow.scm (default-skeletons)[gdbinit]: Derive the value of
DEBUG-FILE-DIRECTORY via the GDB_DEBUG_FILE_DIRECTORY environment variable.
* doc/guix.texi (Installing Debugging Files): Document it.
---
 doc/guix.texi         | 12 ++++++++++++
 gnu/packages/gdb.scm  |  7 +++++++
 gnu/system/shadow.scm |  8 +++++++-
 3 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 587c004bee..2118c6ae16 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -30145,6 +30145,18 @@ GDB}):
 From there on, GDB will pick up debugging information from the
 @file{.debug} files under @file{~/.guix-profile/lib/debug}.
 
+Below is an alternative GDB script that can be useful when working with
+other profiles.  It takes advantage of the Guile integration available
+in GDB.
+
+@example
+guile
+(use-modules (gdb))
+(execute (string-append "set debug-file-directory "
+                        (getenv "GDB_DEBUG_FILE_DIRECTORY")))
+end
+@end example
+
 In addition, you will most likely want GDB to be able to show the source
 code being debugged.  To do that, you will have to unpack the source
 code of the package of interest (obtained with @code{guix build
diff --git a/gnu/packages/gdb.scm b/gnu/packages/gdb.scm
index 830121751f..11e0bb3e76 100644
--- a/gnu/packages/gdb.scm
+++ b/gnu/packages/gdb.scm
@@ -5,6 +5,7 @@
 ;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
 ;;; Copyright © 2020 Vincent Legoll <vincent.legoll@gmail.com>
 ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -117,6 +118,12 @@
         ("dejagnu" ,dejagnu)
         ("pkg-config" ,pkg-config)
         ,@(if (hurd-target?) `(("mig" ,mig)) '())))
+    ;; TODO: Add support for the GDB_DEBUG_FILE_DIRECTORY environment variable
+    ;; in GDB itself instead of relying on some glue code in the Guix-provided
+    ;; .gdbinit file.
+    (native-search-paths (list (search-path-specification
+                                (variable "GDB_DEBUG_FILE_DIRECTORY")
+                                (files '("lib/debug")))))
     (home-page "https://www.gnu.org/software/gdb/")
     (synopsis "The GNU debugger")
     (description
diff --git a/gnu/system/shadow.scm b/gnu/system/shadow.scm
index a69339bc07..8c76bc2b11 100644
--- a/gnu/system/shadow.scm
+++ b/gnu/system/shadow.scm
@@ -3,6 +3,7 @@
 ;;; Copyright © 2016 Alex Griffin <a@ajgrf.com>
 ;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
 ;;; Copyright © 2020 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -162,7 +163,12 @@ XTerm*utf8: always
 XTerm*metaSendsEscape: true\n"))
         (gdbinit   (plain-file "gdbinit" "\
 # Tell GDB where to look for separate debugging files.
-set debug-file-directory ~/.guix-profile/lib/debug
+guile
+(use-modules (gdb))
+(execute (string-append \"set debug-file-directory \"
+                        (or (getenv \"GDB_DEBUG_FILE_DIRECTORY\")
+                            \"~/.guix-profile/lib/debug\")))
+end
 
 # Authorize extensions found in the store, such as the
 # pretty-printers of libstdc++.
-- 
2.27.0