diff --git a/check-linuxcnc-tooldata-source-map.sh b/check-linuxcnc-tooldata-source-map.sh new file mode 100755 index 0000000..656dc85 --- /dev/null +++ b/check-linuxcnc-tooldata-source-map.sh @@ -0,0 +1,136 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "$(dirname "$0")" + +# LinuxCNC source basis: this guard ties LinuxCNC tooldata/Submakefile, +# src/emc/tooldata sources, native/WASM manifests, and wasm-safe tooldata shims +# to the tooldata source map. It validates source coverage only; it does not +# add CNC behavior or expand smoke parsing. +linuxcnc_root=${LINUXCNC_ROOT:-../linuxcnc} +linuxcnc_root=$(cd "$linuxcnc_root" && pwd) + +grep -F 'LIBTOOLDATA_SRCS += emc/tooldata/tooldata_nml.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F 'LIBTOOLDATA_SRCS += emc/tooldata/tooldata_mmap.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F 'LIBTOOLDATA_SRCS += emc/tooldata/tooldata_common.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F 'LIBTOOLDATA_SRCS += emc/tooldata/tooldata_db.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F 'TOOL_MMAP_READ_SRCS = emc/tooldata/tool_mmap_read.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F 'TOOL_WATCH_SRCS = emc/tooldata/tool_watch.cc' \ + "$linuxcnc_root/src/emc/tooldata/Submakefile" >/dev/null +grep -F '#define TOOL_MMAP_FILENAME ".tool.mmap"' \ + "$linuxcnc_root/src/emc/tooldata/tooldata_mmap.cc" >/dev/null +grep -F 'int tool_nml_register(CANON_TOOL_TABLE *tblptr)' \ + "$linuxcnc_root/src/emc/tooldata/tooldata_nml.cc" >/dev/null +grep -F 'int tooldata_db_init(char progname_plus_args[]' \ + "$linuxcnc_root/src/emc/tooldata/tooldata_db.cc" >/dev/null +grep -F 'int tooldata_read_entry(const char *input_line)' \ + "$linuxcnc_root/src/emc/tooldata/tooldata_common.cc" >/dev/null + +grep -F 'LinuxCNC tooldata source map' docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F 'must not add CNC behavior' docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F 'must not expand the temporary smoke parser' docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F '`src/emc/tooldata/Submakefile` selects `tooldata_mmap.cc`' \ + docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F 'Tool table files referenced by switchkins INI files are source coverage only' \ + docs/linuxcnc-tooldata-source-map.md >/dev/null + +grep -F 'tooldata:src/emc/tooldata/tooldata_common.cc:shared tool table parser/format logic' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'tooldata:src/emc/tooldata/tooldata_mmap.cc:native mmap implementation; replace for wasm' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'tooldata:src/emc/tooldata/tooldata_db.cc:external database integration; exclude from wasm core' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'tooldata:src/emc/tooldata/tooldata_nml.cc:NML tool table backend selected by LinuxCNC TOOL_NML_FLAG' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'header:src/emc/tooldata/tooldata.hh:LinuxCNC tooldata declarations used by RS274 and wasm-safe tooldata shims' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'metadata:src/emc/tooldata/Submakefile:LinuxCNC tooldata build metadata defining mmap and NML backend source selection' \ + linuxcnc-rs274-source-files.txt >/dev/null +grep -F 'core:src/emc/tooldata/tooldata_common.cc:shared tool table parser/format logic linked with wasm-safe mmap backend' \ + linuxcnc-rs274-wasm-source-files.txt >/dev/null +grep -F 'blocked:src/emc/tooldata/tooldata_mmap.cc:native mmap implementation' \ + linuxcnc-rs274-wasm-source-files.txt >/dev/null +grep -F 'metadata:src/emc/tooldata/tooldata_db.cc:source basis for wasm-safe tooldata runtime export shim' \ + linuxcnc-rs274-wasm-source-files.txt >/dev/null +grep -F 'metadata:src/emc/tooldata/tooldata_nml.cc:source basis for wasm-safe tooldata runtime NML export shim' \ + linuxcnc-rs274-wasm-source-files.txt >/dev/null + +grep -F 'LinuxCNC source basis: src/emc/tooldata/tooldata_mmap.cc provides these' \ + core/wasm_shims/tooldata/tooldata_mmap_backend.cc >/dev/null +grep -F 'LinuxCNC source basis: src/emc/tooldata/tooldata_nml.cc and tooldata_db.cc' \ + core/wasm_shims/tooldata/tooldata_runtime_stubs.cc >/dev/null +grep -F 'LinuxCNC source basis: src/emc/tooldata/tooldata_common.cc provides' \ + core/wasm_shims/tooldata/tooldata_common_probe_main.cc >/dev/null +grep -F 'LinuxCNC source basis: src/emc/tooldata/tooldata_mmap.cc, tooldata_nml.cc,' \ + core/wasm_shims/tooldata/tooldata_probe_main.cc >/dev/null +grep -F 'core/wasm_shims/tooldata/tooldata_mmap_backend.cc' docs/linuxcnc-wasm-shims-source-map.md >/dev/null +grep -F 'core/wasm_shims/tooldata/tooldata_runtime_stubs.cc' docs/linuxcnc-wasm-shims-source-map.md >/dev/null + +grep -F 'LinuxCNC source basis: this link probe runs the wasm-safe tooldata shim' \ + test-linuxcnc-wasm-tooldata-link.sh >/dev/null +grep -F 'LinuxCNC source basis: this link probe runs tooldata_common through the' \ + test-linuxcnc-wasm-tooldata-common-link.sh >/dev/null +grep -F 'LinuxCNC source basis: this symbol probe compares the wasm mmap backend shim' \ + test-linuxcnc-wasm-tooldata-mmap-symbols.sh >/dev/null +grep -F 'LinuxCNC source basis: this probe compares wasm-safe tooldata runtime stubs' \ + test-linuxcnc-wasm-tooldata-runtime-symbols.sh >/dev/null +grep -F 'run_parallel_wasm_probe "LinuxCNC wasm tooldata shim link probe" ./test-linuxcnc-wasm-tooldata-link.sh' \ + build-wasm.sh >/dev/null +grep -F 'run_parallel_wasm_probe "LinuxCNC wasm tooldata runtime symbol probe" ./test-linuxcnc-wasm-tooldata-runtime-symbols.sh' \ + build-wasm.sh >/dev/null + +python3 - <<'PY' +from pathlib import Path +import subprocess + +doc = Path("docs/linuxcnc-tooldata-source-map.md").read_text(encoding="utf-8") +native_tooldata = subprocess.check_output( + ["./list-linuxcnc-source-manifest-sources.sh", "linuxcnc-rs274-source-files.txt", "tooldata"], + text=True, +).splitlines() +expected_native = [ + "src/emc/tooldata/tooldata_common.cc", + "src/emc/tooldata/tooldata_mmap.cc", + "src/emc/tooldata/tooldata_db.cc", + "src/emc/tooldata/tooldata_nml.cc", + "src/emc/tooldata/tool_mmap_read.cc", + "src/emc/tooldata/tool_watch.cc", +] +for source in expected_native: + if source not in native_tooldata: + raise SystemExit(f"native RS274 manifest missing LinuxCNC tooldata source: {source}") + +kin_tooldata = subprocess.check_output( + ["./list-linuxcnc-kinematics-manifest-sources.sh", "linuxcnc-kinematics-source-files.txt", "tooldata"], + text=True, +).splitlines() +if len([source for source in kin_tooldata if source.endswith(".tbl")]) != 10: + raise SystemExit("kinematics manifest must track exactly 10 LinuxCNC TOOL_TABLE sources") + +for path in [ + "core/wasm_shims/tooldata/tooldata_mmap_backend.cc", + "core/wasm_shims/tooldata/tooldata_runtime_stubs.cc", + "test-linuxcnc-wasm-tooldata-link.sh", + "test-linuxcnc-wasm-tooldata-common-link.sh", + "test-linuxcnc-wasm-tooldata-mmap-symbols.sh", + "test-linuxcnc-wasm-tooldata-runtime-symbols.sh", +]: + if path not in doc: + raise SystemExit(f"docs/linuxcnc-tooldata-source-map.md missing coverage path: {path}") + +for phrase in [ + "must not add CNC behavior", + "must not expand the temporary smoke parser", + "source coverage only", + "must not become browser API fields", + "WASM-safe tooldata shims must preserve the LinuxCNC export surface", + "./check-linuxcnc-tooldata-source-map.sh", +]: + if phrase not in doc: + raise SystemExit(f"docs/linuxcnc-tooldata-source-map.md missing boundary phrase: {phrase}") +PY diff --git a/check-linuxcnc-workstreams-source-map.sh b/check-linuxcnc-workstreams-source-map.sh index 026a5ab..20fd160 100755 --- a/check-linuxcnc-workstreams-source-map.sh +++ b/check-linuxcnc-workstreams-source-map.sh @@ -61,9 +61,11 @@ expected = { "docs/linuxcnc-opfs-source-map.md", "docs/linuxcnc-wasm-shims-source-map.md", "docs/linuxcnc-wasm-blockers-source-map.md", + "docs/linuxcnc-tooldata-source-map.md", "check-linuxcnc-opfs-source-map.sh", "check-linuxcnc-wasm-shims-source-map.sh", "check-linuxcnc-wasm-blockers-source-map.sh", + "check-linuxcnc-tooldata-source-map.sh", ], "browser app integration": [ "docs/linuxcnc-browser-app-source-map.md", @@ -76,8 +78,10 @@ expected = { "source-link, build, and documentation constraints": [ "docs/linuxcnc-rs274-source-map.md", "docs/linuxcnc-build-source-map.md", + "docs/linuxcnc-tooldata-source-map.md", "check-linuxcnc-rs274-source-map.sh", "check-linuxcnc-build-source-map.sh", + "check-linuxcnc-tooldata-source-map.sh", ], } for workstream, paths in expected.items(): diff --git a/docs/linuxcnc-tooldata-source-map.md b/docs/linuxcnc-tooldata-source-map.md new file mode 100644 index 0000000..c5b21c3 --- /dev/null +++ b/docs/linuxcnc-tooldata-source-map.md @@ -0,0 +1,60 @@ +# LinuxCNC tooldata source map + +This map records the source basis and boundaries for LinuxCNC tooldata coverage +in native, source-link, switchkins, and WASM-safe build paths. It is a +source-link/shim guard only; it must not add CNC behavior and must not expand the temporary smoke parser. + +## LinuxCNC Source Basis + +- `src/emc/tooldata/Submakefile` selects `tooldata_mmap.cc` or + `tooldata_nml.cc`, and always includes `tooldata_common.cc`, + `tooldata_db.cc`, and `tool_watch.cc`. +- `src/emc/tooldata/tooldata_common.cc` provides tool table parsing, + formatting, load/save, and database-mode entry points. +- `src/emc/tooldata/tooldata_mmap.cc` provides native mmap tool table storage. +- `src/emc/tooldata/tooldata_nml.cc` provides the NML tool table registration + backend selected by `TOOL_NML_FLAG`. +- `src/emc/tooldata/tooldata_db.cc` provides external database entry points. +- `src/emc/tooldata/tool_mmap_read.cc` and `src/emc/tooldata/tool_watch.cc` are + utility sources from the same LinuxCNC tooldata build metadata. +- `src/emc/tooldata/tooldata.hh` declares the tooldata API used by RS274 and + WASM-safe shims. + +## Manifest And Shim Coverage + +| Coverage | Boundary | +| --- | --- | +| `linuxcnc-rs274-source-files.txt` | Tracks the full LinuxCNC `src/emc/tooldata` source directory and `tooldata.hh`. | +| `linuxcnc-rs274-wasm-source-files.txt` | Links `tooldata_common.cc`, blocks native `tooldata_mmap.cc`, and records runtime shim source bases for `tooldata_db.cc` and `tooldata_nml.cc`. | +| `linuxcnc-kinematics-source-files.txt` | Tracks 10 LinuxCNC `TOOL_TABLE` files referenced by covered M428/M429/M430 INI sources as `tooldata` source coverage only. | +| `core/wasm_shims/tooldata/tooldata_mmap_backend.cc` | Adapts LinuxCNC `tooldata_mmap.cc` exports to WASM-safe in-memory storage. | +| `core/wasm_shims/tooldata/tooldata_runtime_stubs.cc` | Adapts LinuxCNC `tooldata_nml.cc` and `tooldata_db.cc` runtime entry points without native services. | +| `test-linuxcnc-wasm-tooldata-link.sh` | Links the wasm-safe tooldata shim against LinuxCNC tooldata runtime expectations. | +| `test-linuxcnc-wasm-tooldata-common-link.sh` | Links LinuxCNC `tooldata_common.cc` through the wasm-safe standalone probe. | +| `test-linuxcnc-wasm-tooldata-mmap-symbols.sh` | Compares wasm mmap backend exports with LinuxCNC `tooldata_mmap.cc`. | +| `test-linuxcnc-wasm-tooldata-runtime-symbols.sh` | Compares runtime stub exports with LinuxCNC `tooldata_db.cc` and `tooldata_nml.cc`. | + +## Boundaries + +- Tool table files referenced by switchkins INI files are source coverage only; + they must not become browser API fields or generated switchkins aliases. +- WASM-safe tooldata shims must preserve the LinuxCNC export surface checked by + symbol probes. +- Native and source-link paths must keep the full LinuxCNC `src/emc/tooldata` + source directory tracked in the native RS274 manifest. +- `build-wasm.sh` must run tooldata link and symbol probes before copying + browser artifacts. + +## Checks + +Run: + +```bash +./check-linuxcnc-tooldata-source-map.sh +./test-native.sh +./test-linuxcnc-source-link.sh +``` + +`check-linuxcnc-tooldata-source-map.sh` keeps this document, LinuxCNC tooldata +source anchors, manifest coverage, WASM shim/probe boundaries, and switchkins +TOOL_TABLE source-only policy synchronized. diff --git a/docs/linuxcnc-workstreams-source-map.md b/docs/linuxcnc-workstreams-source-map.md index 0512e99..7a0ea72 100644 --- a/docs/linuxcnc-workstreams-source-map.md +++ b/docs/linuxcnc-workstreams-source-map.md @@ -10,10 +10,10 @@ the temporary smoke parser. | --- | --- | --- | | `switchkins/remap` generator and tables | `docs/linuxcnc-switchkins-remap-source-map.md` | `check-linuxcnc-switchkins-remap-source-map.sh` | | `linuxcnc-kinematics` source manifest | `docs/linuxcnc-kinematics-source-map.md` | `check-linuxcnc-kinematics-source-map.sh` | -| WASM filesystem and OPFS persistence | `docs/linuxcnc-opfs-source-map.md`, `docs/linuxcnc-wasm-shims-source-map.md`, `docs/linuxcnc-wasm-blockers-source-map.md` | `check-linuxcnc-opfs-source-map.sh`, `check-linuxcnc-wasm-shims-source-map.sh`, `check-linuxcnc-wasm-blockers-source-map.sh` | +| WASM filesystem and OPFS persistence | `docs/linuxcnc-opfs-source-map.md`, `docs/linuxcnc-wasm-shims-source-map.md`, `docs/linuxcnc-wasm-blockers-source-map.md`, `docs/linuxcnc-tooldata-source-map.md` | `check-linuxcnc-opfs-source-map.sh`, `check-linuxcnc-wasm-shims-source-map.sh`, `check-linuxcnc-wasm-blockers-source-map.sh`, `check-linuxcnc-tooldata-source-map.sh` | | browser app integration | `docs/linuxcnc-browser-app-source-map.md` | `check-linuxcnc-browser-app-source-map.sh` | | Node and browser smoke coverage | `docs/linuxcnc-wasm-smoke-source-map.md` | `check-linuxcnc-wasm-smoke-source-map.sh` | -| source-link, build, and documentation constraints | `docs/linuxcnc-rs274-source-map.md`, `docs/linuxcnc-build-source-map.md` | `check-linuxcnc-rs274-source-map.sh`, `check-linuxcnc-build-source-map.sh` | +| source-link, build, and documentation constraints | `docs/linuxcnc-rs274-source-map.md`, `docs/linuxcnc-build-source-map.md`, `docs/linuxcnc-tooldata-source-map.md` | `check-linuxcnc-rs274-source-map.sh`, `check-linuxcnc-build-source-map.sh`, `check-linuxcnc-tooldata-source-map.sh` | ## LinuxCNC Source Basis diff --git a/test-all-native.sh b/test-all-native.sh index 1611abf..a5a3412 100755 --- a/test-all-native.sh +++ b/test-all-native.sh @@ -162,6 +162,9 @@ grep -F './check-linuxcnc-browser-app-source-map.sh' test-linuxcnc-source-link.s grep -F 'LinuxCNC source basis: this guard ties the six active workstream contexts' check-linuxcnc-workstreams-source-map.sh >/dev/null grep -F './check-linuxcnc-workstreams-source-map.sh' test-native.sh >/dev/null grep -F './check-linuxcnc-workstreams-source-map.sh' test-linuxcnc-source-link.sh >/dev/null +grep -F 'LinuxCNC source basis: this guard ties LinuxCNC tooldata/Submakefile' check-linuxcnc-tooldata-source-map.sh >/dev/null +grep -F './check-linuxcnc-tooldata-source-map.sh' test-native.sh >/dev/null +grep -F './check-linuxcnc-tooldata-source-map.sh' test-linuxcnc-source-link.sh >/dev/null grep -F 'LinuxCNC source basis: this guard ties the documented WASM blocker map' check-linuxcnc-wasm-blockers-source-map.sh >/dev/null grep -F 'LinuxCNC source basis: this guard ties the documented wasm-safe shim map' check-linuxcnc-wasm-shims-source-map.sh >/dev/null grep -F 'LinuxCNC source basis: the cached input checker keys check-linuxcnc-inputs.sh' check-linuxcnc-inputs-cached.sh >/dev/null @@ -254,6 +257,9 @@ grep -F 'The visible backend selector must stay limited to the LinuxCNC RS274 ba grep -F 'LinuxCNC workstreams source map' docs/linuxcnc-workstreams-source-map.md >/dev/null grep -F '| `switchkins/remap` generator and tables | `docs/linuxcnc-switchkins-remap-source-map.md` |' docs/linuxcnc-workstreams-source-map.md >/dev/null grep -F 'Every active workstream must have at least one source-map document and guard' docs/linuxcnc-workstreams-source-map.md >/dev/null +grep -F 'LinuxCNC tooldata source map' docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F '`src/emc/tooldata/Submakefile` selects `tooldata_mmap.cc`' docs/linuxcnc-tooldata-source-map.md >/dev/null +grep -F 'Tool table files referenced by switchkins INI files are source coverage only' docs/linuxcnc-tooldata-source-map.md >/dev/null grep -F 'check-linuxcnc-switchkins-remap-table-cached.sh --cache-dir "$preflight_cache_dir" linuxcnc-kinematics-source-files.txt' test-native.sh >/dev/null grep -F 'check-linuxcnc-switchkins-remap-table-cached.sh --cache-dir "$preflight_cache_dir" linuxcnc-kinematics-source-files.txt' test-linuxcnc-source-link.sh >/dev/null grep -F 'check-linuxcnc-switchkins-remap-table-cached.sh --cache-dir "$preflight_cache_dir" linuxcnc-kinematics-source-files.txt' build-wasm.sh >/dev/null diff --git a/test-linuxcnc-source-link.sh b/test-linuxcnc-source-link.sh index 2adb15f..30f6f30 100755 --- a/test-linuxcnc-source-link.sh +++ b/test-linuxcnc-source-link.sh @@ -44,6 +44,7 @@ LINUXCNC_ROOT="$linuxcnc_root" ./check-linuxcnc-inputs-cached.sh --cache-dir "$p ./check-linuxcnc-build-source-map.sh ./check-linuxcnc-browser-app-source-map.sh ./check-linuxcnc-workstreams-source-map.sh +./check-linuxcnc-tooldata-source-map.sh LINUXCNC_ROOT="$linuxcnc_root" ./check-linuxcnc-switchkins-remap-table-cached.sh --cache-dir "$preflight_cache_dir" linuxcnc-kinematics-source-files.txt # The LinuxCNC source-linked dump path is not concurrency-safe under parallel execution. exec 9>"${TMPDIR:-/tmp}/cnc_sim_rs274_source_link.lock" diff --git a/test-native.sh b/test-native.sh index 98f8c83..c5d5812 100755 --- a/test-native.sh +++ b/test-native.sh @@ -42,6 +42,7 @@ preflight_cache_dir="$build_dir/preflight-cache" ./check-linuxcnc-build-source-map.sh ./check-linuxcnc-browser-app-source-map.sh ./check-linuxcnc-workstreams-source-map.sh +./check-linuxcnc-tooldata-source-map.sh ./check-linuxcnc-switchkins-remap-table-cached.sh --cache-dir "$preflight_cache_dir" linuxcnc-kinematics-source-files.txt grep -F 'tooldata:src/emc/tooldata/tooldata_nml.cc:NML tool table backend selected by LinuxCNC TOOL_NML_FLAG' linuxcnc-rs274-source-files.txt >/dev/null grep -F 'tooldata:src/emc/tooldata/tool_mmap_read.cc:LinuxCNC tooldata mmap reader utility source from tooldata Submakefile' linuxcnc-rs274-source-files.txt >/dev/null