summaryrefslogtreecommitdiffstats
path: root/nixos/modules/config/debug-info.nix
blob: 6119f1202af3c84b83e49a97a4807ba265a7c3a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
  config,
  lib,
  pkgs,
  ...
}:
{

  options = {

    environment.enableDebugInfo = lib.mkOption {
      type = lib.types.bool;
      default = false;
      description = ''
        Some NixOS packages provide debug symbols. However, these are
        not included in the system closure by default to save disk
        space. Enabling this option causes the debug symbols to appear
        in {file}`/run/current-system/sw/lib/debug/.build-id`,
        where tools such as {command}`gdb` can find them.
        If you need debug symbols for a package that doesn't
        provide them by default, you can enable them as follows:

            nixpkgs.config.packageOverrides = pkgs: {
              hello = pkgs.hello.overrideAttrs (oldAttrs: {
                separateDebugInfo = true;
              });
            };
      '';
    };

    environment.debuginfodServers = lib.mkOption {
      type = lib.types.listOf lib.types.str;
      default = [ ];
      description = ''
        List of urls of debuginfod servers for tools like {command}`gdb` and {command}`valgrind` to use.

        Unrelated to {option}`environment.enableDebugInfo`.
      '';
    };

  };

  config = lib.mkMerge [
    (lib.mkIf config.environment.enableDebugInfo {

      # FIXME: currently disabled because /lib is already in
      # environment.pathsToLink, and we can't have both.
      #environment.pathsToLink = [ "/lib/debug/.build-id" ];

      environment.extraOutputsToInstall = [ "debug" ];

      environment.variables.NIX_DEBUG_INFO_DIRS = [ "/run/current-system/sw/lib/debug" ];

    })
    (lib.mkIf (config.environment.debuginfodServers != [ ]) {
      environment.variables.DEBUGINFOD_URLS = lib.strings.concatStringsSep " " config.environment.debuginfodServers;

      environment.systemPackages = [
        # valgrind support requires debuginfod-find on PATH
        (lib.getBin pkgs.elfutils)
      ];

      environment.etc."gdb/gdbinit.d/nixseparatedebuginfod2.gdb".text = "set debuginfod enabled on";
    })
  ];

}