Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,14 @@ though the name in it is not.

Still true, and still how you prove a build: `.o` hashes are never evidence
— ca65 stamps build time into every object; ld65 does not propagate it, so
the PRG is deterministic and **its sha256 is the check**. One consequence
of the stamp: `CA65FLAGS` carries two `$(abspath ...)` `.incbin` roots, so
moving a checkout forces exactly one rebuild.
the PRG is deterministic and **its sha256 is the check**. The PRG is also
locale-independent (#301): make 3.81 returns `$(wildcard)` in collation
order, so `src/*.s` and `src/crypto/*.s` are `$(sort)`ed; the test pins those
two (C/en_US/cs_CZ). `src/crypto/shared/*.s`'s sort is defensive, unpinned.
`flags.stamp` carries the object list, so a changed link order relinks.
One consequence of the stamp: `CA65FLAGS` carries two
`$(abspath ...)` `.incbin` roots, so moving a checkout forces exactly one
rebuild.

Also: `$(PRG)`'s recipe `rm -f`s the target first, because ld65 writes
nothing on a memory-area overflow and every rig loads the PRG by path — an
Expand Down
13 changes: 8 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,10 @@ endif
# Paths come from LINK_OUTPUTS' variables below (lazy =, so they may follow).
LD65FLAGS = -C $(CFG) -Ln $(LABELS) -m $(LINK_MAP) --dbgfile $(LINK_DBG)

# Source inventory.
TOP_SRCS := $(wildcard src/*.s)
# Source inventory. Every wildcard here is wrapped in $(sort): make 3.81 returns
# wildcard hits in locale-collation order, and the list is the link order, so
# an unsorted one made the PRG depend on LANG (#301). $(sort) is byte order.
TOP_SRCS := $(sort $(wildcard src/*.s))
# Crypto sources: wildcard-discovered. In-tree src/crypto/x25519.s +
# src/crypto/fe25519.s are used under both backends; the Phase C.1
# libs/x25519/ overlay integration was rolled back after it broke the
Expand All @@ -279,11 +281,11 @@ TOP_SRCS := $(wildcard src/*.s)
# (build/lib/nistcurves-p256.a). The now-unused files were physically
# deleted in Phase G. ecdsa_verify.s stays — rewritten as a thin
# dispatcher that packs the BE struct + calls ecdsa_verify_256.
CRYPTO_SRCS_ALL := $(wildcard src/crypto/*.s)
CRYPTO_SRCS_ALL := $(sort $(wildcard src/crypto/*.s))
# Shared crypto infrastructure introduced in Phase C.0: canonical ZP map,
# overlay swap dispatcher, init orchestrator, shared sqtab stub. Always
# linked; sibling-lib integration (Phase C.3) hangs off these.
CRYPTO_SHARED_SRCS := $(wildcard src/crypto/shared/*.s)
CRYPTO_SHARED_SRCS := $(sort $(wildcard src/crypto/shared/*.s))
IP65_SRCS := src/net/ip65/ip65_blob.s src/net/ip65/net.s src/net/ip65/net_banner.s src/net/ip65/exports.s src/net/ip65/net_manifest.s
UCI_SRCS := src/net/uci/net.s src/net/uci/uci_cmd.s src/net/uci/net_manifest.s

Expand Down Expand Up @@ -761,6 +763,7 @@ FLAGS_STAMP_BODY := printf '%s\n' \
'CA65FLAGS=$(CA65FLAGS)' \
'LD65FLAGS=$(LD65FLAGS)' \
'CFG_SHA256=$(CFG_SHA256)' \
'OBJECTS=$(ALL_OBJS)' \
'SIBLING_LIB_ARCHIVES=$(SIBLING_LIB_ARCHIVES)' \
'X25519_SEG_FE25519=$(X25519_SEG_FE25519)' \
'X25519_SEG_LADDER=$(X25519_SEG_LADDER)' \
Expand All @@ -780,7 +783,7 @@ _ := $(shell mkdir -p build; \
else
# -n / -q / -t: compare and report, mutate nothing. See MAKE_DRY_RUN above.
ifneq ($(shell $(FLAGS_STAMP_BODY) 2>/dev/null | cmp -s - $(FLAGS_STAMP) >/dev/null 2>&1 || echo differs),)
$(warning DRY RUN (-$(MAKE_OPT_LETTERS)): build flags differ from $(FLAGS_STAMP).)
$(warning DRY RUN (-$(MAKE_OPT_LETTERS)): build inputs (flags or object list) differ from $(FLAGS_STAMP).)
$(warning A real build would rewrite the stamp and delete every object and $(LINK_OUTPUTS))
$(warning at parse time. NOTHING was deleted; the tree is untouched.)
endif
Expand Down
113 changes: 111 additions & 2 deletions tools/test_build_flags_stamp.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@
from pathlib import Path

sys.path.insert(0, str(Path(__file__).resolve().parent))
from _skip_policy import EXIT_CANNOT_RUN, cannot_run, require # noqa: E402
from _skip_policy import ( # noqa: E402
EXIT_CANNOT_RUN, VoluntarySkip, cannot_run, require)

REPO = Path(__file__).resolve().parent.parent

Expand Down Expand Up @@ -1059,6 +1060,107 @@ def test_stamp_records_the_whole_command_line():
)


LOCALES = ("C", "en_US.UTF-8", "cs_CZ.UTF-8")

CERTIFIES_LOCALE = "whether the PRG's bytes depend on the build locale (#301)"
CERTIFIES_STALE_ORDER = ("whether a tree linked in another object order is "
"rebuilt (#301)")


def _wildcard_orders(farm, pattern):
"""`$(wildcard pattern)` as the make in use returns it, per locale."""
probe = farm.path("probe.mk")
probe.write_text(f"all:\n\t@echo $(wildcard {pattern})\n")
orders = {}
for loc in LOCALES:
proc = subprocess.run(
["make", "-f", str(probe)], cwd=farm.dir, text=True,
env=dict(os.environ, LC_ALL=loc),
stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
assert proc.returncode == 0, proc.stdout
orders[loc] = proc.stdout.split()
return orders


def test_prg_is_independent_of_the_build_locale():
"""The PRG must not depend on LANG/LC_ALL (#301).

GNU make 3.81 returns `$(wildcard)` hits in the locale's collation order
and the wildcard lists are the ld65 object order. Unsorted, each of the
three wildcard-built products had three PRG hashes (C, en_US, cs_CZ).
`$(sort)` is byte order, so link order -- and the bytes -- are locale-free.

Each sorted list is pinned only if some locale pair really reorders it,
so the probe checks that per list and refuses a vacuous comparison:
* src/*.s en_US ignores the underscore (tls_record_io before
tls13); C does not.
* src/crypto/*.s cs_CZ sorts "ch" after "h" (chacha20 after hmac_drbg);
C and en_US AGREE here, so two locales are not enough.
* src/crypto/shared/*.s no locale tried reorders it (crypto_init,
mul_tables), so its `$(sort)` is defensive and NOT
pinned by this test.
"""
_require_toolchain()
with Farm() as farm:
for pattern in ("src/*.s", "src/crypto/*.s"):
orders = _wildcard_orders(farm, pattern)
assert len({tuple(sorted(o)) for o in orders.values()}) == 1, (
f"{pattern}: locales disagree on the file SET: {orders}")
if len({tuple(o) for o in orders.values()}) == 1:
require(False,
f"no locale in {LOCALES} reorders $(wildcard "
f"{pattern}) under this make; the cross-locale "
"comparison would be vacuous for that list",
executed=0, total=1, certifies=CERTIFIES_LOCALE,
opt_out_env="C64_ALLOW_SKIP")
shas = {}
for loc in LOCALES:
with Farm() as farm:
farm.make(*UCI, env={"LC_ALL": loc})
shas[loc] = farm.sha()
assert len(set(shas.values())) == 1, (
f"PRG depends on the build locale: {shas}")


def test_stale_link_order_is_rebuilt_to_the_clean_hash():
"""A tree linked in another object order must relink, not stay stale (#301).

The object list is a link input that was in neither flags.stamp nor any
prerequisite, so a build/ left by an unsorted Makefile answered "Nothing
to be done" and kept the old PRG. The stale tree here is built by a
private copy of the Makefile with the TOP_SRCS `$(sort)` removed, under a
locale that reorders it, then rebuilt with the real Makefile.
"""
_require_toolchain()
loc = {"LC_ALL": "en_US.UTF-8"}
with Farm() as clean:
clean.make(*UCI, env=loc)
oracle = clean.sha()
with Farm() as farm:
real = REPO / "Makefile"
text = real.read_text()
old = "TOP_SRCS := $(sort $(wildcard src/*.s))"
assert old in text, "TOP_SRCS line moved; re-aim this test"
os.unlink(farm.path("Makefile"))
farm.path("Makefile").write_text(
text.replace(old, "TOP_SRCS := $(wildcard src/*.s)"))
farm.make(*UCI, env=loc)
stale = farm.sha()
os.unlink(farm.path("Makefile"))
os.symlink(real, farm.path("Makefile"))
farm.make(*UCI, env=loc)
if stale == oracle:
require(False,
"this make/locale does not reorder $(wildcard src/*.s); "
"the stale tree is not actually stale, so a relink to the "
"clean hash would prove nothing",
executed=0, total=1, certifies=CERTIFIES_STALE_ORDER,
opt_out_env="C64_ALLOW_SKIP")
assert farm.sha() == oracle, (
"a changed object order did not invalidate the tree: PRG "
f"{farm.sha()} != clean build {oracle}")


def main() -> int:
print("=== build/flags.stamp ===")
tests = [(name, fn) for name, fn in sorted(globals().items())
Expand All @@ -1081,9 +1183,14 @@ def main() -> int:

failed = 0
ran = 0
skipped = 0
for name, fn in tests:
try:
fn()
except VoluntarySkip as exc: # named before Exception
skipped += 1
print(f" SKIP {name}\n {exc}")
continue
except Exception as exc: # noqa: BLE001 - a crash is a fail
failed += 1
print(f" FAIL {name}\n {type(exc).__name__}: {exc}")
Expand All @@ -1101,7 +1208,9 @@ def main() -> int:
)

print(f"\n{'FAILED' if failed else 'PASSED'}: {failed} failure(s) "
f"({ran}/{len(tests)} executed)")
f"({ran}/{len(tests)} executed"
+ (f", {skipped} skipped via C64_ALLOW_SKIP" if skipped else "")
+ ")")
return 1 if failed else 0


Expand Down