|
| 1 | +#!/usr/bin/env nix |
| 2 | +#!nix shell --inputs-from . nixpkgs#sentry-cli --command python3 |
| 3 | + |
| 4 | +import argparse |
| 5 | +import json |
| 6 | +import os |
| 7 | +import platform |
| 8 | +import re |
| 9 | +import subprocess |
| 10 | +import sys |
| 11 | +import urllib.error |
| 12 | +import urllib.parse |
| 13 | +import urllib.request |
| 14 | + |
| 15 | +NAR_DIR = "/tmp/nars" |
| 16 | +DEBUG_INFO_DIR = "/tmp/debug-info" |
| 17 | + |
| 18 | + |
| 19 | +def get_dynamic_libraries(executable: str) -> list[str]: |
| 20 | + if platform.system() == "Darwin": |
| 21 | + result = subprocess.run(["otool", "-L", executable], capture_output=True, text=True, check=True) |
| 22 | + libs = [] |
| 23 | + for line in result.stdout.splitlines()[1:]: # skip first line (the binary path itself) |
| 24 | + # otool -L output lines look like: |
| 25 | + # /nix/store/.../libfoo.dylib (compatibility version X.Y.Z, current version A.B.C) |
| 26 | + m = re.match(r"\s+(\S+)\s+\(", line) |
| 27 | + if m: |
| 28 | + libs.append(m.group(1)) |
| 29 | + return libs |
| 30 | + else: |
| 31 | + result = subprocess.run(["ldd", executable], capture_output=True, text=True, check=True) |
| 32 | + libs = [] |
| 33 | + for line in result.stdout.splitlines(): |
| 34 | + # ldd output lines look like: |
| 35 | + # libfoo.so.1 => /nix/store/.../libfoo.so.1 (0x...) |
| 36 | + # /lib64/ld-linux-x86-64.so.2 (0x...) |
| 37 | + m = re.search(r"=> (/\S+)", line) |
| 38 | + if m: |
| 39 | + libs.append(m.group(1)) |
| 40 | + elif line.strip().startswith("/"): |
| 41 | + path = line.strip().split()[0] |
| 42 | + libs.append(path) |
| 43 | + return libs |
| 44 | + |
| 45 | + |
| 46 | +def get_build_id(path: str) -> str | None: |
| 47 | + result = subprocess.run(["readelf", "-n", path], capture_output=True, text=True) |
| 48 | + m = re.search(r"Build ID:\s+([0-9a-f]+)", result.stdout) |
| 49 | + return m.group(1) if m else None |
| 50 | + |
| 51 | + |
| 52 | +def download_nar(build_id: str, archive: str) -> str: |
| 53 | + """Download a NAR to /tmp/nars and return the local path. Skips if already present.""" |
| 54 | + base_url = f"https://cache.nixos.org/debuginfo/{build_id}" |
| 55 | + nar_url = urllib.parse.urljoin(base_url, archive) |
| 56 | + filename = nar_url.split("/")[-1] |
| 57 | + local_path = os.path.join(NAR_DIR, filename) |
| 58 | + if not os.path.exists(local_path): |
| 59 | + os.makedirs(NAR_DIR, exist_ok=True) |
| 60 | + print(f" downloading {nar_url} ...", file=sys.stderr) |
| 61 | + urllib.request.urlretrieve(nar_url, local_path) |
| 62 | + else: |
| 63 | + print(f" already have {filename}", file=sys.stderr) |
| 64 | + return local_path |
| 65 | + |
| 66 | + |
| 67 | +def extract_debug_symbols(nar_path: str, member: str, build_id: str) -> str: |
| 68 | + """Extract a member from a .nar.xz into /tmp/debug-info/<build_id>.debug. Returns the output path.""" |
| 69 | + out_path = os.path.join(DEBUG_INFO_DIR, f"{build_id}.debug") |
| 70 | + if os.path.exists(out_path): |
| 71 | + print(f" already extracted {out_path}", file=sys.stderr) |
| 72 | + return out_path |
| 73 | + os.makedirs(DEBUG_INFO_DIR, exist_ok=True) |
| 74 | + print(f" extracting {member} -> {out_path} ...", file=sys.stderr) |
| 75 | + xz = subprocess.Popen(["xz", "-d"], stdin=open(nar_path, "rb"), stdout=subprocess.PIPE) |
| 76 | + nar_cat = subprocess.run( |
| 77 | + ["nix", "nar", "cat", "/dev/stdin", member], |
| 78 | + stdin=xz.stdout, |
| 79 | + capture_output=True, |
| 80 | + check=True, |
| 81 | + ) |
| 82 | + xz.wait() |
| 83 | + with open(out_path, "wb") as f: |
| 84 | + f.write(nar_cat.stdout) |
| 85 | + return out_path |
| 86 | + |
| 87 | + |
| 88 | +def find_debug_file_in_dirs(build_id: str, debug_dirs: list[str]) -> str | None: |
| 89 | + """Look for a .debug file by build ID under <dir>/lib/debug/.build-id/NN/NNN.debug.""" |
| 90 | + subpath = os.path.join("lib", "debug", ".build-id", build_id[:2], build_id[2:] + ".debug") |
| 91 | + for d in debug_dirs: |
| 92 | + candidate = os.path.join(d, subpath) |
| 93 | + if os.path.exists(candidate): |
| 94 | + return candidate |
| 95 | + return None |
| 96 | + |
| 97 | + |
| 98 | +def fetch_debuginfo(build_id: str) -> dict | None: |
| 99 | + url = f"https://cache.nixos.org/debuginfo/{build_id}" |
| 100 | + try: |
| 101 | + with urllib.request.urlopen(url) as resp: |
| 102 | + return json.loads(resp.read()) |
| 103 | + except urllib.error.HTTPError as e: |
| 104 | + if e.code == 404: |
| 105 | + return None |
| 106 | + raise |
| 107 | + |
| 108 | + |
| 109 | +def main(): |
| 110 | + parser = argparse.ArgumentParser( |
| 111 | + description="Upload debug symbols to Sentry." |
| 112 | + ) |
| 113 | + parser.add_argument("executable", help="Path to the executable (e.g. ./result/bin/nix)") |
| 114 | + parser.add_argument("--project", help="Sentry project ID") |
| 115 | + parser.add_argument("--debug-dir", action="append", default=[], metavar="DIR", |
| 116 | + help="Directory to search for debug files (may be repeated, Linux only)") |
| 117 | + args = parser.parse_args() |
| 118 | + |
| 119 | + libs = [args.executable] + get_dynamic_libraries(args.executable) |
| 120 | + |
| 121 | + if platform.system() == "Darwin": |
| 122 | + # On macOS there are no separate debug info files; upload the binaries directly. |
| 123 | + print("Files to upload:", file=sys.stderr) |
| 124 | + for lib in libs: |
| 125 | + print(f" {lib}", file=sys.stderr) |
| 126 | + files_to_upload = libs |
| 127 | + else: |
| 128 | + debug_files = [] |
| 129 | + print("ELF files to process:", file=sys.stderr) |
| 130 | + for lib in libs: |
| 131 | + build_id = get_build_id(lib) |
| 132 | + if build_id is None: |
| 133 | + print(f" {lib} (no build ID)", file=sys.stderr) |
| 134 | + continue |
| 135 | + |
| 136 | + local = find_debug_file_in_dirs(build_id, args.debug_dir) |
| 137 | + if local: |
| 138 | + print(f" {lib} ({build_id}): found locally at {local}", file=sys.stderr) |
| 139 | + debug_files.append(local) |
| 140 | + continue |
| 141 | + |
| 142 | + debuginfo = fetch_debuginfo(build_id) |
| 143 | + if debuginfo is None: |
| 144 | + print(f" {lib} ({build_id}, no debug info in cache)", file=sys.stderr) |
| 145 | + continue |
| 146 | + print(f" {lib} ({build_id}): member={debuginfo['member']}", file=sys.stderr) |
| 147 | + nar_path = download_nar(build_id, debuginfo["archive"]) |
| 148 | + debug_file = extract_debug_symbols(nar_path, debuginfo["member"], build_id) |
| 149 | + debug_files.append(debug_file) |
| 150 | + files_to_upload = debug_files |
| 151 | + |
| 152 | + if files_to_upload: |
| 153 | + print(f"Uploading {len(files_to_upload)} file(s) to Sentry...", file=sys.stderr) |
| 154 | + cmd = ["sentry-cli", "debug-files", "upload"] |
| 155 | + if args.project: |
| 156 | + cmd += ["--project", args.project] |
| 157 | + subprocess.run(cmd + files_to_upload, check=True) |
| 158 | + |
| 159 | + |
| 160 | +if __name__ == "__main__": |
| 161 | + main() |
0 commit comments