Add KiCad WASM build infrastructure and dependency scripts
- Add build environment setup (scripts/common/env.sh, versions.sh, functions.sh)
- Add dependency build scripts for Zstd, GLM, FreeType, HarfBuzz, Pixman, Cairo
- Add placeholder scripts for OpenCASCADE, ngspice, protobuf
- Add WASM compatibility layer (wasm/kiplatform/, wasm/libcontext/)
- Add CMake modules for KiCad WASM cross-compilation
- Add PCBnew test infrastructure (tests/kicad/)
- Add build plan documentation
Successfully tested builds: Zstd 1.5.5, GLM 0.9.9.8, FreeType 2.13.2,
HarfBuzz 8.3.0, Pixman 0.42.2, Cairo 1.18.0
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 13:15:04 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
# Environment setup for KiCad WASM build scripts
|
|
|
|
|
|
|
|
|
|
# Get script and project directories using unique names to avoid conflicts
|
|
|
|
|
_KICAD_WASM_COMMON_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
|
|
|
_KICAD_WASM_SCRIPTS_DIR="$(dirname "$_KICAD_WASM_COMMON_DIR")"
|
|
|
|
|
_KICAD_WASM_PROJECT_ROOT="$(dirname "$_KICAD_WASM_SCRIPTS_DIR")"
|
|
|
|
|
|
|
|
|
|
# Export paths
|
|
|
|
|
export PROJECT_ROOT="$_KICAD_WASM_PROJECT_ROOT"
|
|
|
|
|
export SCRIPTS_DIR="$_KICAD_WASM_SCRIPTS_DIR"
|
|
|
|
|
export COMMON_DIR="$_KICAD_WASM_COMMON_DIR"
|
|
|
|
|
|
2025-12-27 01:07:44 +01:00
|
|
|
# Use our config.sub wrapper for autoconf projects (emconfigure)
|
|
|
|
|
# This intercepts config.sub calls to use our version with emscripten/wasm32 support
|
|
|
|
|
# CONFIG_SHELL is critical: nested configures do SHELL=${CONFIG_SHELL-/bin/sh}
|
|
|
|
|
export SHELL="$SCRIPTS_DIR/config/config-sub-wrapper.sh"
|
|
|
|
|
export CONFIG_SHELL="$SCRIPTS_DIR/config/config-sub-wrapper.sh"
|
|
|
|
|
|
Add KiCad WASM build infrastructure and dependency scripts
- Add build environment setup (scripts/common/env.sh, versions.sh, functions.sh)
- Add dependency build scripts for Zstd, GLM, FreeType, HarfBuzz, Pixman, Cairo
- Add placeholder scripts for OpenCASCADE, ngspice, protobuf
- Add WASM compatibility layer (wasm/kiplatform/, wasm/libcontext/)
- Add CMake modules for KiCad WASM cross-compilation
- Add PCBnew test infrastructure (tests/kicad/)
- Add build plan documentation
Successfully tested builds: Zstd 1.5.5, GLM 0.9.9.8, FreeType 2.13.2,
HarfBuzz 8.3.0, Pixman 0.42.2, Cairo 1.18.0
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 13:15:04 +01:00
|
|
|
# Build output directories (inside the project)
|
|
|
|
|
export BUILD_ROOT="$PROJECT_ROOT/build-wasm"
|
|
|
|
|
export DEPS_ROOT="$BUILD_ROOT/deps"
|
|
|
|
|
export SYSROOT="$BUILD_ROOT/sysroot"
|
|
|
|
|
export STAMPS_DIR="$BUILD_ROOT/stamps"
|
|
|
|
|
|
|
|
|
|
# Source directories
|
|
|
|
|
export KICAD_SOURCE="$PROJECT_ROOT/kicad"
|
|
|
|
|
export WXWIDGETS_SOURCE="$PROJECT_ROOT/wxwidgets"
|
|
|
|
|
export WASM_COMPAT="$PROJECT_ROOT/wasm"
|
|
|
|
|
export STUBS_DIR="$PROJECT_ROOT/stubs"
|
|
|
|
|
export CMAKE_MODULES="$PROJECT_ROOT/cmake"
|
|
|
|
|
|
|
|
|
|
# wxWidgets build location
|
2026-06-12 10:18:16 +02:00
|
|
|
export WX_BUILD="$BUILD_ROOT/wxwidgets"
|
Add KiCad WASM build infrastructure and dependency scripts
- Add build environment setup (scripts/common/env.sh, versions.sh, functions.sh)
- Add dependency build scripts for Zstd, GLM, FreeType, HarfBuzz, Pixman, Cairo
- Add placeholder scripts for OpenCASCADE, ngspice, protobuf
- Add WASM compatibility layer (wasm/kiplatform/, wasm/libcontext/)
- Add CMake modules for KiCad WASM cross-compilation
- Add PCBnew test infrastructure (tests/kicad/)
- Add build plan documentation
Successfully tested builds: Zstd 1.5.5, GLM 0.9.9.8, FreeType 2.13.2,
HarfBuzz 8.3.0, Pixman 0.42.2, Cairo 1.18.0
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 13:15:04 +01:00
|
|
|
|
|
|
|
|
# Emscripten settings
|
|
|
|
|
export EMSDK_QUIET=1
|
|
|
|
|
|
2026-06-29 19:50:18 +02:00
|
|
|
# Exception model for ALL WASM translation units — the C/C++ dependencies, wxWidgets, and KiCad
|
|
|
|
|
# (build-wx-wasm.sh and build-kicad-target.sh source this file and reuse DEPS_EH_FLAGS). Native
|
|
|
|
|
# WebAssembly exceptions (legacy binary encoding) are the only build mode. -sSUPPORT_LONGJMP=wasm is
|
|
|
|
|
# required because the deps that use setjmp/longjmp (freetype, cairo, OpenCASCADE) must use wasm
|
|
|
|
|
# setjmp — emscripten's JS-longjmp implementation cannot coexist with -fwasm-exceptions (it would
|
jspi cleanup: remove the asyncify-era residue — dead code, conditionals, pipeline scaffolding, stale prose
The runtime is JSPI-only; this removes everything that still pretended
otherwise. Three exhaustive sweeps (C++/JS+build+CI/tests+docs) drove
the inventory; every deletion verified by grep closure + full gates.
Broken-right-now fixes:
- deploy-staging.yml passed the retired opt_level input — the workflow
could not even start. Removed.
- env.sh carried dead exports with a live -sASYNCIFY=1 inside
(WASM_LDFLAGS/PTHREAD_LDFLAGS, zero consumers). Removed; the
WASM_LEGACY_EXCEPTIONS rationale rewritten to the real reason.
- docker/build.sh exported PCBJAM_ASYNC_BACKEND (read nowhere). Gone.
Dead weight removed:
- binaryen submodule (nothing builds or invokes it), wasm-opt-bench
workflow + scripts/bench/, get-wasm-opt.sh, diagnostics.js (242 lines
of Asyncify-API-only code), the KICAD_PIPELINE background-postprocess
scaffolding (existed to parallelize the deleted wasm-opt phase; the
postprocess is a seconds-long node script and now runs inline),
build-monitor's dead asyncify rows, sched-context orphan build
output, dead .gitignore entries, the .jspi-assets spike dir (the two
wf-result research JSONs moved to docs/features/async/migration-evidence/).
- bindings: fiber_park.h + its 12 embind registrations (broken-if-
called under JSPI), the kicadOpenFileStart/OPEN_JOB starter route,
main_stack_runner.h + 5 includes, the always-null context-sleep weak
hook in nanosleep_yield.c.
- shim: the backend field (installed-flag idempotency instead),
noteContextWait (dead both sides), the __wxAsyncifyDump alias (+ the
WasmTool fallback and string-dump normalize branch).
- web: the emscripten-6-ignored mainScriptUrlOrBlob option in boot.ts
(gerber-demo keeps it: it loads the deployed CDN release, which
predates emscripten 6 — noted inline).
Conditionals: all 'backend === jspi' checks reduced to scheduler-
presence checks; races_quiescent re-keyed from Asyncify.state (vacuous)
to real backlog quiescence (resumeReady/mutatorQueue — NOT _windowLive,
which is the probing activation's own window by definition).
Renames (identifiers only, no file renames): ASYNC_LINK_FLAGS→
JSPI_LINK_FLAGS and Makefile ASYNC_LDFLAGS→JSPI_LDFLAGS,
kicadCollabFiberBusy→kicadCollabBusy (embind + web + tests),
collab_common.h fiber*→apply*/coroutine naming, asyncifySignatures→
wasmTrapSignatures (lists byte-identical).
Tests: the two remaining vacuous [wx-asyncify]/fiber-resume-refused
asserts re-keyed to live JSPI beacons; eeschema-load's failure message
no longer sends the developer to a deleted script; wait-beacons' dead
families/parser deleted; lane-0 legacy-glue guards removed (lane 0 is
unconstructible); the embind test.fail re-gated with the JSPI reason
(plain embind invokers cannot suspend — verified still failing);
lint-determinism now scans tests/jspi (166 files clean);
eeschema-collab local-move gated to chromium (~50% flaky on FF even
solo; pcbnew twin covers both engines).
Docs: DEBUG.md rewritten as the JSPI debugging guide; build.md
describes the single-phase build; docs/features/async/README.md
banner-marked historical and repointed at the NEW
23-jspi-runtime.md (current architecture: export census, turnstile,
libcontext ownership + refusal contract, embind call shapes, the
em-pthread service-wrapper trick, exception policy, known gaps).
Gates on the cleaned tree: test:e2e 725 passed / 0 failed (after the
quiescence-probe fix; the 3 other reds were verified contention flakes
solo-green or the documented FF gate), web 76/0, jspi 18/18 both
engines, vitest 295/295 + 17/17, all lints green, live-app census
clean.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016X9eh1s5sTx1o9Em9KBuwR
2026-08-14 09:25:32 +02:00
|
|
|
# leave emscripten_longjmp undefined). -sWASM_LEGACY_EXCEPTIONS=1 pins the legacy EH binary encoding:
|
|
|
|
|
# the exnref encoding is not adopted across our pinned emsdk toolchain and target browsers.
|
2026-06-29 19:50:18 +02:00
|
|
|
export DEPS_EH_FLAGS="-fwasm-exceptions -sSUPPORT_LONGJMP=wasm -sWASM_LEGACY_EXCEPTIONS=1"
|
|
|
|
|
|
2026-03-19 12:44:26 +01:00
|
|
|
# Emscripten SDK setup
|
|
|
|
|
# If EMSDK is already set (e.g. Docker entrypoint sourced emsdk_env.sh), use it.
|
|
|
|
|
# Otherwise auto-install a local copy under tools/emsdk/.
|
|
|
|
|
if [ -n "$EMSDK" ] && [ -f "$EMSDK/emsdk_env.sh" ]; then
|
|
|
|
|
# emsdk already active (e.g., Docker entrypoint sourced it)
|
|
|
|
|
source "$EMSDK/emsdk_env.sh" 2>/dev/null
|
|
|
|
|
else
|
|
|
|
|
# Local emsdk: auto-install if missing, then source its environment
|
|
|
|
|
# The emsdk bundles its own Python, Node, and LLVM — no Homebrew needed
|
|
|
|
|
_EMSDK_DIR="$_KICAD_WASM_PROJECT_ROOT/tools/emsdk"
|
|
|
|
|
_EMSDK_ENV="$_EMSDK_DIR/emsdk_env.sh"
|
|
|
|
|
|
|
|
|
|
if [ ! -f "$_EMSDK_ENV" ]; then
|
|
|
|
|
echo "Emscripten SDK not found. Installing..."
|
|
|
|
|
"$_KICAD_WASM_SCRIPTS_DIR/setup-emsdk.sh"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
if [ -f "$_EMSDK_ENV" ]; then
|
|
|
|
|
source "$_EMSDK_ENV" 2>/dev/null
|
|
|
|
|
fi
|
2026-01-07 16:11:31 +01:00
|
|
|
fi
|
|
|
|
|
|
2026-06-16 08:14:35 +02:00
|
|
|
# --- Ensure a working `python` command for build codegen steps --------------
|
|
|
|
|
# Some build steps run scripts via a `#!/usr/bin/env python` shebang (e.g.
|
|
|
|
|
# wxWidgets' src/stc/gen_iface.py, which regenerates wx/stc/stc.h). The bundled
|
|
|
|
|
# emsdk ships only `python3`; modern macOS has no system `python`; and a pyenv
|
|
|
|
|
# shim with no configured version silently shadows PATH and aborts the build
|
|
|
|
|
# with "pyenv: python: command not found". Guard on actually *running* python
|
|
|
|
|
# (the pyenv shim exists but fails), and shim `python` -> python3 so this can't
|
|
|
|
|
# break across machines/CI.
|
|
|
|
|
if ! python -c '' >/dev/null 2>&1; then
|
|
|
|
|
# Prefer emsdk's bundled python3, fall back to any python3 on PATH.
|
|
|
|
|
_PY3="$(ls "$_KICAD_WASM_PROJECT_ROOT"/tools/emsdk/python/*/bin/python3 2>/dev/null | head -n1)"
|
|
|
|
|
[ -x "$_PY3" ] || _PY3="$(command -v python3 || true)"
|
|
|
|
|
if [ -n "$_PY3" ]; then
|
|
|
|
|
_PY_SHIM_DIR="$BUILD_ROOT/python-shim"
|
|
|
|
|
mkdir -p "$_PY_SHIM_DIR"
|
|
|
|
|
ln -sf "$_PY3" "$_PY_SHIM_DIR/python"
|
|
|
|
|
export PATH="$_PY_SHIM_DIR:$PATH"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
Add KiCad WASM build infrastructure and dependency scripts
- Add build environment setup (scripts/common/env.sh, versions.sh, functions.sh)
- Add dependency build scripts for Zstd, GLM, FreeType, HarfBuzz, Pixman, Cairo
- Add placeholder scripts for OpenCASCADE, ngspice, protobuf
- Add WASM compatibility layer (wasm/kiplatform/, wasm/libcontext/)
- Add CMake modules for KiCad WASM cross-compilation
- Add PCBnew test infrastructure (tests/kicad/)
- Add build plan documentation
Successfully tested builds: Zstd 1.5.5, GLM 0.9.9.8, FreeType 2.13.2,
HarfBuzz 8.3.0, Pixman 0.42.2, Cairo 1.18.0
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 13:15:04 +01:00
|
|
|
# Common compiler flags
|
|
|
|
|
export EMCC_CFLAGS="-fPIC -DEMSCRIPTEN"
|
|
|
|
|
export EMCC_CXXFLAGS="-fPIC -DEMSCRIPTEN -std=c++17"
|
|
|
|
|
|
2025-12-26 20:51:58 +01:00
|
|
|
# Use ccache if available for faster rebuilds
|
|
|
|
|
if command -v ccache &> /dev/null; then
|
|
|
|
|
export CC="ccache emcc"
|
|
|
|
|
export CXX="ccache em++"
|
|
|
|
|
fi
|
|
|
|
|
|
2025-12-12 14:51:38 +01:00
|
|
|
# Debug mode (default: ON, use --release to disable)
|
|
|
|
|
# This can be overridden by setting DEBUG_BUILD=0 before sourcing this file
|
|
|
|
|
DEBUG_BUILD="${DEBUG_BUILD:-1}"
|
|
|
|
|
|
|
|
|
|
if [ "$DEBUG_BUILD" = "1" ]; then
|
|
|
|
|
export BUILD_TYPE="Debug"
|
2025-12-22 16:30:53 +01:00
|
|
|
export DEBUG_CFLAGS="-g -O1"
|
2025-12-12 14:51:38 +01:00
|
|
|
export DEBUG_LDFLAGS="-g -gsource-map"
|
|
|
|
|
else
|
|
|
|
|
export BUILD_TYPE="Release"
|
|
|
|
|
export DEBUG_CFLAGS="-O2"
|
|
|
|
|
export DEBUG_LDFLAGS=""
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
export DEBUG_BUILD BUILD_TYPE DEBUG_CFLAGS DEBUG_LDFLAGS
|
|
|
|
|
|
|
|
|
|
# Parallel jobs (default to 1 for memory-constrained environments like Docker)
|
|
|
|
|
# Can be overridden with -j N flag or by setting JOBS/PARALLEL_JOBS env vars
|
|
|
|
|
if [ -n "$PARALLEL_JOBS" ]; then
|
|
|
|
|
export JOBS="$PARALLEL_JOBS"
|
|
|
|
|
elif [ -z "$JOBS" ]; then
|
|
|
|
|
# Default to 1 for sequential builds (safer for memory)
|
|
|
|
|
# Use -j N to override for faster builds on machines with more RAM
|
|
|
|
|
export JOBS=1
|
|
|
|
|
fi
|
|
|
|
|
|
Add KiCad WASM build infrastructure and dependency scripts
- Add build environment setup (scripts/common/env.sh, versions.sh, functions.sh)
- Add dependency build scripts for Zstd, GLM, FreeType, HarfBuzz, Pixman, Cairo
- Add placeholder scripts for OpenCASCADE, ngspice, protobuf
- Add WASM compatibility layer (wasm/kiplatform/, wasm/libcontext/)
- Add CMake modules for KiCad WASM cross-compilation
- Add PCBnew test infrastructure (tests/kicad/)
- Add build plan documentation
Successfully tested builds: Zstd 1.5.5, GLM 0.9.9.8, FreeType 2.13.2,
HarfBuzz 8.3.0, Pixman 0.42.2, Cairo 1.18.0
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 13:15:04 +01:00
|
|
|
# Create output directories
|
|
|
|
|
mkdir -p "$BUILD_ROOT" "$DEPS_ROOT" "$SYSROOT"/{lib,include,share} "$STAMPS_DIR"
|
|
|
|
|
|
|
|
|
|
# Source other common files
|
|
|
|
|
source "$COMMON_DIR/versions.sh"
|
|
|
|
|
source "$COMMON_DIR/functions.sh"
|
|
|
|
|
|
|
|
|
|
# Print environment info (only if not in quiet mode)
|
|
|
|
|
if [ "${QUIET:-0}" != "1" ]; then
|
|
|
|
|
echo "KiCad WASM Build Environment"
|
|
|
|
|
echo " Project root: $PROJECT_ROOT"
|
|
|
|
|
echo " Build root: $BUILD_ROOT"
|
|
|
|
|
echo " Sysroot: $SYSROOT"
|
|
|
|
|
fi
|