mirror of
https://github.com/MobileGL-Dev/MobileGL
synced 2026-09-07 19:58:32 +09:00
[Tooling] (Purity): add scripts/symbol_report.py - per-symbol nm/.text attribution between two libMobileGL.so builds
- P0.5's acceptance gate requires every `nm --defined-only -S` delta to be explainable per symbol, and nothing in the tree reads nm or size today. - The problem the tool exists to solve: de-nesting a type renames every mangled name that mentions it, including inside template arguments, so a raw nm diff of a pure move looks catastrophic. --strip-scope 'A::B::C::' rewrites 'A::B::C::X' to 'A::B::X' on the demangled name before comparing, which folds those into a renamed-only bucket - same normalised name, byte-identical size - and leaves the real churn visible. - Buckets sorted by |delta|: removed, added, resized, renamed-only, unchanged, plus .text/.data/.bss/Total from `size --format=sysv`; --only-names narrows the listing, --markdown/--json write the report the integrator pastes into the merge commit. - Always exits 0 (this is informational, ARCHITECTURE.md:507); --fail-on-added-bytes is accepted and documented as reserved for the day it becomes a hard gate. - The docstring carries the guard rails a reader would otherwise supply by assumption: same CMAKE_BUILD_TYPE (the visibility presets differ per configuration), LTO off on both sides, same compiler - and every report prints both paths and their byte sizes. - --self-test runs two canned nm/size transcripts through the same parser and bucketer and pins all five buckets, including that a de-nested member folds to renamed rather than to an added+removed pair.
This commit is contained in:
Executable
+386
@@ -0,0 +1,386 @@
|
||||
#!/usr/bin/env python3
|
||||
# MobileGL - scripts/symbol_report.py
|
||||
# Copyright (c) 2025-2026 MobileGL-Dev
|
||||
# Licensed under the GNU Lesser General Public License v3.0:
|
||||
# https://www.gnu.org/licenses/gpl-3.0.txt
|
||||
# https://www.gnu.org/licenses/lgpl-3.0.txt
|
||||
# SPDX-License-Identifier: LGPL-3.0-only
|
||||
# End of Source File Header
|
||||
"""Per-symbol nm/.text attribution between two libMobileGL.so builds.
|
||||
|
||||
P0.5's acceptance gate says every `nm --defined-only -S` delta has to be explainable per
|
||||
symbol (ROADMAP.md:16). The awkward part is that de-nesting a type renames every mangled
|
||||
name that mentions it - `ProgramObject::LinkArtifacts` -> `LinkArtifacts` shows up inside
|
||||
every `std::vector<...>` instantiation too - so a raw nm diff of a pure move looks
|
||||
catastrophic. `--strip-scope` folds those into a "renamed-only" bucket: same normalised
|
||||
demangled name, byte-identical size. What is left over is the report's real content.
|
||||
|
||||
python3 scripts/symbol_report.py --before old.so --after new.so
|
||||
python3 scripts/symbol_report.py --before old.so --after new.so \\
|
||||
--strip-scope 'MobileGL::MG_State::GLState::ProgramObject::' \\
|
||||
--only-names 'TypeFacts,ResourceReflection,XfbVarying,LinkArtifacts,SpirvArtifacts' \\
|
||||
--markdown ~/w7/p05-symbol-report.md
|
||||
|
||||
GUARD RAILS - the comparison is meaningless unless both .so files were built with:
|
||||
* the same CMAKE_BUILD_TYPE (the visibility presets differ between configurations,
|
||||
CMakeLists.txt:578-598, so a Debug/Release pair "adds" thousands of symbols),
|
||||
* MOBILEGL_ENABLE_LTO OFF on both sides (CMakeLists.txt:108,137-146 - LTO merges and
|
||||
renames at will and nothing here is attributable afterwards),
|
||||
* the same compiler and standard library.
|
||||
The header of every report prints both paths and their byte sizes so a mismatched pair is
|
||||
visible in the output rather than only in the reader's assumptions.
|
||||
|
||||
This tool is informational (ARCHITECTURE.md:507, job name `monolith-symbol-report`
|
||||
ARCHITECTURE.md:568) and always exits 0; `--fail-on-added-bytes` is reserved for the day
|
||||
it becomes a hard gate.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
PREFIX = "symbol-report: "
|
||||
|
||||
# `nm --defined-only -S` prints "<addr> <size> <type> <name>", and "<addr> <type> <name>"
|
||||
# for a defined symbol whose size the object file does not carry (absolute symbols,
|
||||
# assembler labels).
|
||||
NM_SIZED_RE = re.compile(r"^([0-9a-fA-F]+)\s+([0-9a-fA-F]+)\s+(\S)\s+(.+)$")
|
||||
NM_UNSIZED_RE = re.compile(r"^([0-9a-fA-F]+)\s+(\S)\s+(.+)$")
|
||||
|
||||
# `size --format=sysv` prints "section size addr" rows plus a Total row.
|
||||
SIZE_ROW_RE = re.compile(r"^(\S+)\s+(\d+)(?:\s+(\d+))?\s*$")
|
||||
|
||||
INTERESTING_SECTIONS = (".text", ".data", ".bss", ".rodata", "Total")
|
||||
|
||||
|
||||
def say(message):
|
||||
print(PREFIX + message)
|
||||
|
||||
|
||||
def parse_nm(text):
|
||||
"""nm --defined-only -S transcript -> {mangled: (type, size_or_None)}."""
|
||||
symbols = {}
|
||||
for line in text.splitlines():
|
||||
line = line.rstrip()
|
||||
if not line:
|
||||
continue
|
||||
match = NM_SIZED_RE.match(line)
|
||||
if match:
|
||||
symbols[match.group(4)] = (match.group(3), int(match.group(2), 16))
|
||||
continue
|
||||
match = NM_UNSIZED_RE.match(line)
|
||||
if match:
|
||||
symbols[match.group(3)] = (match.group(2), None)
|
||||
return symbols
|
||||
|
||||
|
||||
def parse_size(text):
|
||||
"""size --format=sysv transcript -> {section: bytes}."""
|
||||
sections = {}
|
||||
for line in text.splitlines():
|
||||
stripped = line.strip()
|
||||
if not stripped or stripped.startswith("section"):
|
||||
continue
|
||||
match = SIZE_ROW_RE.match(stripped)
|
||||
if not match:
|
||||
continue
|
||||
sections[match.group(1)] = int(match.group(2))
|
||||
return sections
|
||||
|
||||
|
||||
def demangle(names, cxxfilt):
|
||||
"""Batch-demangle through c++filt; a plain identifier passes through unchanged."""
|
||||
ordered = list(names)
|
||||
if not ordered:
|
||||
return {}
|
||||
if not cxxfilt or not (shutil.which(cxxfilt) or os.path.isfile(cxxfilt)):
|
||||
return {name: name for name in ordered}
|
||||
completed = subprocess.run([cxxfilt], input="\n".join(ordered) + "\n",
|
||||
stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, text=True)
|
||||
lines = completed.stdout.splitlines()
|
||||
if len(lines) != len(ordered):
|
||||
return {name: name for name in ordered}
|
||||
return dict(zip(ordered, lines))
|
||||
|
||||
|
||||
def parent_scope(prefix):
|
||||
"""`A::B::C::` -> `A::B::` (drop the last named component, keep the enclosing scope).
|
||||
|
||||
A de-nesting moves `A::B::C::X` to `A::B::X`, so folding the two spellings together
|
||||
means deleting the `C::` component, NOT the whole prefix - deleting the whole prefix
|
||||
would turn the before side into a bare `X` that no after-side name matches.
|
||||
"""
|
||||
body = prefix[:-2] if prefix.endswith("::") else prefix
|
||||
cut = body.rfind("::")
|
||||
return body[:cut + 2] if cut >= 0 else ""
|
||||
|
||||
|
||||
def normalise(name, strip_scopes, rename_map):
|
||||
"""Textual folding of the demangled name: this is what makes a de-nesting a rename."""
|
||||
for scope in strip_scopes:
|
||||
name = name.replace(scope, parent_scope(scope))
|
||||
for old, new in rename_map:
|
||||
name = name.replace(old, new)
|
||||
return name
|
||||
|
||||
|
||||
def build_side(path, nm_tool, size_tool, cxxfilt, strip_scopes, rename_map, canned=None):
|
||||
if canned is None:
|
||||
nm_text = subprocess.run([nm_tool, "--defined-only", "-S", path],
|
||||
stdout=subprocess.PIPE, stderr=subprocess.PIPE,
|
||||
text=True, check=True).stdout
|
||||
size_text = subprocess.run([size_tool, "--format=sysv", path],
|
||||
stdout=subprocess.PIPE, stderr=subprocess.PIPE,
|
||||
text=True, check=True).stdout
|
||||
else:
|
||||
nm_text, size_text = canned
|
||||
|
||||
raw = parse_nm(nm_text)
|
||||
demangled = demangle(raw.keys(), cxxfilt)
|
||||
table = {}
|
||||
for mangled, (kind, size) in raw.items():
|
||||
key = normalise(demangled.get(mangled, mangled), strip_scopes, rename_map)
|
||||
table.setdefault(key, []).append({"mangled": mangled, "type": kind,
|
||||
"size": size or 0,
|
||||
"demangled": demangled.get(mangled, mangled)})
|
||||
folded = {}
|
||||
for key, entries in table.items():
|
||||
folded[key] = {
|
||||
"size": sum(e["size"] for e in entries),
|
||||
"count": len(entries),
|
||||
"mangled": sorted(e["mangled"] for e in entries),
|
||||
"type": entries[0]["type"],
|
||||
}
|
||||
return folded, parse_size(size_text), len(raw)
|
||||
|
||||
|
||||
def bucket(before, after, only_names, threshold):
|
||||
def wanted(name):
|
||||
return not only_names or any(n in name for n in only_names)
|
||||
|
||||
removed, added, resized, renamed, unchanged = [], [], [], [], 0
|
||||
for name in sorted(set(before) | set(after)):
|
||||
b = before.get(name)
|
||||
a = after.get(name)
|
||||
if b is None:
|
||||
if wanted(name):
|
||||
added.append({"name": name, "delta": a["size"], "before": 0, "after": a["size"]})
|
||||
continue
|
||||
if a is None:
|
||||
if wanted(name):
|
||||
removed.append({"name": name, "delta": -b["size"], "before": b["size"], "after": 0})
|
||||
continue
|
||||
if a["size"] != b["size"] and abs(a["size"] - b["size"]) > threshold:
|
||||
if wanted(name):
|
||||
resized.append({"name": name, "delta": a["size"] - b["size"],
|
||||
"before": b["size"], "after": a["size"]})
|
||||
continue
|
||||
if a["mangled"] != b["mangled"]:
|
||||
# same normalised name, byte-identical size: the pure-move signature
|
||||
if wanted(name):
|
||||
renamed.append({"name": name, "delta": 0,
|
||||
"before": b["mangled"][0], "after": a["mangled"][0]})
|
||||
continue
|
||||
unchanged += 1
|
||||
for group in (removed, added, resized):
|
||||
group.sort(key=lambda row: (-abs(row["delta"]), row["name"]))
|
||||
renamed.sort(key=lambda row: row["name"])
|
||||
return removed, added, resized, renamed, unchanged
|
||||
|
||||
|
||||
def markdown_table(title, rows, columns):
|
||||
lines = ["", "### {} ({})".format(title, len(rows)), ""]
|
||||
if not rows:
|
||||
lines.append("_none_")
|
||||
lines.append("")
|
||||
return lines
|
||||
lines.append("| " + " | ".join(columns) + " |")
|
||||
lines.append("|" + "|".join(["---"] * len(columns)) + "|")
|
||||
for row in rows:
|
||||
lines.append("| " + " | ".join(str(cell).replace("|", "\\|") for cell in row) + " |")
|
||||
lines.append("")
|
||||
return lines
|
||||
|
||||
|
||||
CANNED_BEFORE = ("""0000000000001000 0000000000000010 T MobileGL::MG_State::GLState::ProgramObject::LinkArtifacts::Reset()
|
||||
0000000000002000 0000000000000020 T MobileGL::MG_State::GLState::ProgramObject::Link()
|
||||
0000000000003000 0000000000000030 T MobileGL::Gone()
|
||||
0000000000004000 0000000000000040 T MobileGL::Grew()
|
||||
0000000000005000 T MobileGL::NoSize()
|
||||
""", """libBefore.so :
|
||||
section size addr
|
||||
.text 1000 100
|
||||
.data 200 2000
|
||||
.bss 300 3000
|
||||
Total 1500
|
||||
""")
|
||||
|
||||
CANNED_AFTER = ("""0000000000001000 0000000000000010 T MobileGL::MG_State::GLState::LinkArtifacts::Reset()
|
||||
0000000000002000 0000000000000020 T MobileGL::MG_State::GLState::ProgramObject::Link()
|
||||
0000000000004000 0000000000000050 T MobileGL::Grew()
|
||||
0000000000006000 0000000000000060 T MobileGL::BrandNew()
|
||||
0000000000005000 T MobileGL::NoSize()
|
||||
""", """libAfter.so :
|
||||
section size addr
|
||||
.text 1100 100
|
||||
.data 200 2000
|
||||
.bss 300 3000
|
||||
Total 1600
|
||||
""")
|
||||
|
||||
|
||||
def self_test():
|
||||
strip = ["MobileGL::MG_State::GLState::ProgramObject::"]
|
||||
before, before_sections, before_count = build_side(None, None, None, None, strip, [],
|
||||
canned=CANNED_BEFORE)
|
||||
after, after_sections, after_count = build_side(None, None, None, None, strip, [],
|
||||
canned=CANNED_AFTER)
|
||||
removed, added, resized, renamed, unchanged = bucket(before, after, [], 0)
|
||||
problems = []
|
||||
if before_count != 5 or after_count != 5:
|
||||
problems.append("nm parse counts: {} / {} (expected 5 / 5)".format(before_count, after_count))
|
||||
if [r["name"] for r in removed] != ["MobileGL::Gone()"]:
|
||||
problems.append("removed bucket: {}".format([r["name"] for r in removed]))
|
||||
if [r["name"] for r in added] != ["MobileGL::BrandNew()"]:
|
||||
problems.append("added bucket: {}".format([r["name"] for r in added]))
|
||||
if [(r["name"], r["delta"]) for r in resized] != [("MobileGL::Grew()", 0x10)]:
|
||||
problems.append("resized bucket: {}".format([(r["name"], r["delta"]) for r in resized]))
|
||||
# `ProgramObject::LinkArtifacts::Reset` -> `LinkArtifacts::Reset` folds to the same
|
||||
# normalised name at the same size: renamed-only, not added+removed.
|
||||
if [r["name"] for r in renamed] != ["MobileGL::MG_State::GLState::LinkArtifacts::Reset()"]:
|
||||
problems.append("renamed bucket: {}".format([r["name"] for r in renamed]))
|
||||
if unchanged != 2: # ProgramObject::Link() and NoSize()
|
||||
problems.append("unchanged count: {} (expected 2)".format(unchanged))
|
||||
if before_sections.get(".text") != 1000 or after_sections.get("Total") != 1600:
|
||||
problems.append("size --format=sysv parse: {} / {}".format(before_sections, after_sections))
|
||||
for problem in problems:
|
||||
say("self-test: " + problem)
|
||||
say("self-test: " + ("OK (2 canned transcripts, 5 buckets)" if not problems else "FAILED"))
|
||||
return 0 if not problems else 1
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(description=__doc__,
|
||||
formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||
parser.add_argument("--before", help="the baseline libMobileGL.so")
|
||||
parser.add_argument("--after", help="the libMobileGL.so under test")
|
||||
parser.add_argument("--nm", default="nm")
|
||||
parser.add_argument("--size", default="size")
|
||||
parser.add_argument("--cxxfilt", default="c++filt")
|
||||
parser.add_argument("--markdown", default=None, help="write the Markdown report here")
|
||||
parser.add_argument("--json", default=None, help="write the machine-readable result here")
|
||||
parser.add_argument("--strip-scope", action="append", default=[], metavar="PREFIX",
|
||||
help="de-nest this scope in demangled names before comparing: PREFIX "
|
||||
"'A::B::C::' rewrites every 'A::B::C::X' to 'A::B::X' (repeatable). "
|
||||
"This is what folds a de-nesting into a rename instead of an "
|
||||
"added+removed pair, including inside template arguments.")
|
||||
parser.add_argument("--rename-map", action="append", default=[], metavar="OLD=NEW",
|
||||
help="textual OLD=NEW substitution on demangled names (repeatable)")
|
||||
parser.add_argument("--only-names", default=None,
|
||||
help="comma-separated: list only symbols whose demangled text contains one")
|
||||
parser.add_argument("--threshold", type=int, default=0,
|
||||
help="ignore size deltas of at most this many bytes")
|
||||
parser.add_argument("--fail-on-added-bytes", type=int, default=None,
|
||||
help="reserved for a future hard gate; currently informational only")
|
||||
parser.add_argument("--self-test", action="store_true")
|
||||
args = parser.parse_args()
|
||||
|
||||
if args.self_test:
|
||||
return self_test()
|
||||
|
||||
if not args.before or not args.after:
|
||||
parser.error("--before and --after are required (or use --self-test)")
|
||||
|
||||
rename_map = []
|
||||
for entry in args.rename_map:
|
||||
if "=" not in entry:
|
||||
parser.error("--rename-map expects OLD=NEW, got " + entry)
|
||||
old, new = entry.split("=", 1)
|
||||
rename_map.append((old, new))
|
||||
only_names = [n.strip() for n in args.only_names.split(",")] if args.only_names else []
|
||||
|
||||
before, before_sections, before_count = build_side(
|
||||
args.before, args.nm, args.size, args.cxxfilt, args.strip_scope, rename_map)
|
||||
after, after_sections, after_count = build_side(
|
||||
args.after, args.nm, args.size, args.cxxfilt, args.strip_scope, rename_map)
|
||||
|
||||
removed, added, resized, renamed, unchanged = bucket(before, after, only_names, args.threshold)
|
||||
|
||||
before_text = before_sections.get(".text", 0)
|
||||
after_text = after_sections.get(".text", 0)
|
||||
delta = after_text - before_text
|
||||
percent = (100.0 * delta / before_text) if before_text else 0.0
|
||||
|
||||
say("before: {} ({} bytes on disk)".format(args.before, os.path.getsize(args.before)))
|
||||
say("after : {} ({} bytes on disk)".format(args.after, os.path.getsize(args.after)))
|
||||
if args.strip_scope:
|
||||
say("strip-scope: " + " ; ".join(args.strip_scope))
|
||||
if rename_map:
|
||||
say("rename-map: " + " ; ".join("{}={}".format(o, n) for o, n in rename_map))
|
||||
say(".text {} -> {} ({:+d}, {:+.3f}%)".format(before_text, after_text, delta, percent))
|
||||
for section in INTERESTING_SECTIONS:
|
||||
if section == ".text":
|
||||
continue
|
||||
b = before_sections.get(section)
|
||||
a = after_sections.get(section)
|
||||
if b is None and a is None:
|
||||
continue
|
||||
say("{} {} -> {} ({:+d})".format(section, b or 0, a or 0, (a or 0) - (b or 0)))
|
||||
say("{} -> {} defined symbols: {} added, {} removed, {} resized, {} renamed".format(
|
||||
before_count, after_count, len(added), len(removed), len(resized), len(renamed)))
|
||||
# The two counts differ by the folding: several mangled symbols can share one
|
||||
# normalised demangled name (local aliases, `.cold` parts, identical-COMDAT clones).
|
||||
say("{} -> {} normalised names, {} unchanged (name, size and mangling all identical)".format(
|
||||
len(before), len(after), unchanged))
|
||||
if only_names:
|
||||
say("listing restricted to names containing: " + ", ".join(only_names))
|
||||
if args.fail_on_added_bytes is not None:
|
||||
say("--fail-on-added-bytes is reserved; this run stays informational")
|
||||
|
||||
lines = ["# MobileGL symbol report", "",
|
||||
"| side | path | file bytes | .text |",
|
||||
"|---|---|---|---|",
|
||||
"| before | `{}` | {} | {} |".format(args.before, os.path.getsize(args.before), before_text),
|
||||
"| after | `{}` | {} | {} |".format(args.after, os.path.getsize(args.after), after_text),
|
||||
"",
|
||||
"`.text` {} -> {} ({:+d}, {:+.3f}%). {} -> {} defined symbols: "
|
||||
"{} added, {} removed, {} resized, {} renamed, {} unchanged.".format(
|
||||
before_text, after_text, delta, percent, before_count, after_count,
|
||||
len(added), len(removed), len(resized), len(renamed), unchanged)]
|
||||
lines += markdown_table("Removed", [(r["name"], r["before"]) for r in removed],
|
||||
["symbol", "bytes"])
|
||||
lines += markdown_table("Added", [(r["name"], r["after"]) for r in added],
|
||||
["symbol", "bytes"])
|
||||
lines += markdown_table("Resized", [(r["name"], r["before"], r["after"], "{:+d}".format(r["delta"]))
|
||||
for r in resized],
|
||||
["symbol", "before", "after", "delta"])
|
||||
lines += markdown_table("Renamed only (same size)",
|
||||
[(r["name"], r["before"], r["after"]) for r in renamed],
|
||||
["normalised symbol", "before mangling", "after mangling"])
|
||||
report = "\n".join(lines) + "\n"
|
||||
|
||||
if args.markdown:
|
||||
with open(args.markdown, "w", encoding="utf-8", newline="\n") as handle:
|
||||
handle.write(report)
|
||||
say("markdown written to " + args.markdown)
|
||||
else:
|
||||
print(report)
|
||||
|
||||
if args.json:
|
||||
with open(args.json, "w", encoding="utf-8", newline="\n") as handle:
|
||||
json.dump({"before": args.before, "after": args.after,
|
||||
"sections_before": before_sections, "sections_after": after_sections,
|
||||
"removed": removed, "added": added, "resized": resized,
|
||||
"renamed": renamed, "unchanged": unchanged}, handle, indent=2)
|
||||
handle.write("\n")
|
||||
say("json written to " + args.json)
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Reference in New Issue
Block a user