Something went wrong. Try again.
Personal fork of prime agent. Mirror of: https://mnemosyne.sigilzero.dev/sigilzero/prime-agent
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136#!/usr/bin/env python3"""Produce the shipped binary and its split-debug decoder from one build.
Kevin's Option C shipping posture: the release build emits line tables anddoes not strip at link (see [profile.release] in Cargo.toml). This stepsplits that ONE linked image so the decoder's DWARF addresses match theshipped binary exactly:
- decoder: ``objcopy --only-keep-debug`` of the unstripped image, gzipped (~3x on DWARF), named ``prime-agent-<version>-<platform>.debug.gz`` — a SEPARATE release asset for offline symbolication, NEVER install payload (assemble_artifacts.py hard-fails if one enters a tarball). - shipped: ``objcopy --strip-debug`` into the separate ``--shipped`` path. The Cargo output stays unstripped so a no-op cached build can split again. The shipped image keeps the static symbol table (panic backtraces) and .dynsym (dynamic linking, the GLIBC baseline gate).
Symbolication round-trip: ``gunzip`` the decoder, then``llvm-symbolizer --obj <decoder-file> <addr...>`` with addresses from theshipped binary's backtraces or ``nm``/``objdump -t``.
Usage: python3 scripts/release/split_debug.py \ --binary target/x86_64-unknown-linux-gnu/release/prime-agent \ --shipped target/x86_64-unknown-linux-gnu/dist/prime-agent \ --out target/x86_64-unknown-linux-gnu/dist \ --version 0.1.0 --target x86_64-unknown-linux-gnu
The unstripped Cargo binary is never modified. The decoder and shipped ELFland in --out. The assembler records their SHA-256s and shared GNU build IDin a per-target manifest for promotion integrity checking."""
from __future__ import annotations
import argparseimport gzipimport hashlibimport osimport shutilimport subprocessimport sysimport tempfilefrom pathlib import Path
# Same platform alias map the assembler uses, so the decoder file name# matches the release naming convention exactly.from assemble_artifacts import TARGET_ALIASES, debug_sections
def fail(message: str) -> None: print(f"error: {message}", file=sys.stderr) sys.exit(1)
def run(args: list[str]) -> None: result = subprocess.run(args, capture_output=True, text=True) if result.returncode != 0: fail(f"{' '.join(args)} failed: {result.stderr.strip() or result.returncode}")
def sha256_file(path: Path) -> str: digest = hashlib.sha256() with path.open("rb") as handle: for chunk in iter(lambda: handle.read(1024 * 1024), b""): digest.update(chunk) return digest.hexdigest()
def main() -> int: parser = argparse.ArgumentParser(description=__doc__) parser.add_argument("--binary", required=True, type=Path) parser.add_argument("--shipped", required=True, type=Path, help="separate stripped ELF; never overwrite Cargo output") parser.add_argument("--out", required=True, type=Path) parser.add_argument("--version", required=True, help="bare release version, e.g. 0.1.0") parser.add_argument("--target", required=True, help="rust target triple (must be a known alias)") args = parser.parse_args() if args.target not in TARGET_ALIASES: fail(f"unknown release target {args.target!r} (known: {', '.join(TARGET_ALIASES)})") decoder_name = f"prime-agent-{args.version}-{TARGET_ALIASES[args.target]}.debug.gz"
binary = args.binary if not binary.is_file() or not os.access(binary, os.X_OK): fail(f"no executable binary at {binary}") before = debug_sections(binary) if not before: fail(f"{binary} carries no .debug_* sections - build it with the " "line-tables profile before splitting (a stripped-at-link build " "has no DWARF to keep)")
args.out.mkdir(parents=True, exist_ok=True) shipped = args.shipped if shipped.resolve() == binary.resolve(): fail("--shipped must not overwrite the Cargo --binary input") shipped.parent.mkdir(parents=True, exist_ok=True) decoder = args.out / decoder_name with tempfile.TemporaryDirectory(prefix="split-debug-") as tmp: keep = Path(tmp) / "keep-debug" # only-keep-debug keeps section headers and every DWARF section and # drops the loaded contents — the decoder file, symbolization-wise # equivalent to the original for addr2line/llvm-symbolizer. run(["objcopy", "--only-keep-debug", str(binary), str(keep)]) if not keep.is_file() or keep.stat().st_size == 0: fail("objcopy --only-keep-debug produced no decoder file") # gzip -n: no timestamp, deterministic asset bytes with keep.open("rb") as src, gzip.GzipFile(filename="", mode="wb", fileobj=decoder.open("wb"), mtime=0) as gz: shutil.copyfileobj(src, gz)
stripped_tmp = shipped.with_suffix(shipped.suffix + ".stripped") # --strip-debug drops the .debug_* DWARF sections but leaves the # binutils-emitted .debug_gdb_scripts auto-load marker (34 bytes); it # is removed explicitly so the shipped image carries NO .debug_* # section at all (--remove-section is a no-op when absent). run(["objcopy", "--strip-debug", "--remove-section=.debug_gdb_scripts", str(binary), str(stripped_tmp)]) after = debug_sections(stripped_tmp) if after: fail(f"--strip-debug left .debug_* sections behind: {after}") shipped_sha = sha256_file(stripped_tmp) os.replace(stripped_tmp, shipped) shipped.chmod(binary.stat().st_mode)
print("split_debug:") print(f" shipped: {shipped} {shipped.stat().st_size} bytes sha256 {shipped_sha}") print(f" decoder: {decoder} {decoder.stat().st_size} bytes sha256 {sha256_file(decoder)}") return 0
if __name__ == "__main__": raise SystemExit(main())