feat(wasm): occ-split — lazy occ_service worker; kicad_editor drops OCC (−31%)
Move OpenCASCADE out of the merged editor image into occ_service: a separate
emscripten module (-sASYNCIFY=0, MODULARIZE, in-container -Oz finalize, 2N+8
pre-warmed pthread pool) booted lazily in a dedicated Web Worker on the first
STEP export or STEP/IGES model parse. kicad_editor.wasm ~190 MB -> 130 MB;
sessions that never touch OCC never fetch its 57 MB. STEP export works in the
browser for the first time: the unchanged desktop dialog runs EXPORTER_STEP,
whose wasm shadow suspends into globalThis.occService and the export bytes go
straight to a browser download (never entering the editor heap). STEP/IGES 3D
models parse in the worker via the oce shadow (S3D WriteCache/ReadCache wire).
- wasm/occ-service/: service CMake target (hooked from the kicad fork's
top-level CMakeLists, wasm/editor pattern), embind entry
(occExport/occLoadModel), wxConfig pre-js.
- wasm/stubs/{exporter_step,oce_plugin}_stub.cpp: EM_ASYNC_JS worker bridges
(callee-shadowing; no caller #ifdefs).
- web/standalone: provider installed whenever the kicad_editor bundle boots
(cross-face safe); ONE shared worker-boot source occ-worker.js (vite ?raw;
the e2e stub reads the same file) — blob worker with locateFile absolutized
against the glue URL; export download-name guard.
- deps: OCC builds with RapidJSON so its glTF/GLB writer exists — pinned to
the vcpkg master snapshot 2025-02-26 (24b5e7a8b27f), the same code official
KiCad consumes via vcpkg.json's opencascade[rapidjson]; rapidjson's latest
tag (v1.1.0, 2016) is ill-formed under modern clang.
- tests: occ-export dialog e2e (lazy-fetch boundary + STEP download bytes),
occ-probe incl. a 9-format matrix (step/stpz/brep/xao/ply/stl/glb/u3d/pdf),
3d-viewer-models hard-asserts the worker parse; occ provider stub installed
ambiently by the kicad fixtures.
Validated against desktop kicad-cli 10.0.4: geometric exact equality (bbox
delta 0 um, volume delta 0.0000%) for STEP/GLB/STL/BREP/STPZ across three
boards and option sweeps — with desktop OCC 7.9 vs wasm OCC 7.8; PLY/XAO/PDF
structurally equal; U3D same-size (quantizer float LSBs differ). Full kicad
e2e green on Firefox and Chromium; standalone verified end to end (lazy fetch
only on the Export click; export.step 60,628 B ISO-10303-21; loadModel 700 KB
STEP -> 569 KB scenegraph cache).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Viktor Vaczi
parent
96abe5d4a5
commit
db9d6ee04b
28 changed files with 2296 additions and 23 deletions
|
|
@ -29,6 +29,13 @@ export SWIG_MIN="4.0"
|
|||
|
||||
# Recommended versions for WASM build
|
||||
export OCC_VERSION="7.8.0"
|
||||
# Header-only; OCC's glTF (GLB) writer requires it (HAVE_RAPIDJSON). RapidJSON
|
||||
# has tagged no release since 1.1.0 (2016) — whose headers are ill-formed under
|
||||
# modern clang — so, like official KiCad (whose vcpkg.json pulls opencascade's
|
||||
# rapidjson feature), we pin the dated master snapshot vcpkg ships. The
|
||||
# "version" is vcpkg's port date for that commit.
|
||||
export RAPIDJSON_VERSION="2025-02-26"
|
||||
export RAPIDJSON_COMMIT="24b5e7a8b27f42fa16b96fc70aade9106cf7102f"
|
||||
export ZSTD_VERSION="1.5.5"
|
||||
export FREETYPE_VERSION="2.13.2"
|
||||
export HARFBUZZ_VERSION="8.3.0"
|
||||
|
|
@ -43,6 +50,7 @@ export HARFBUZZ_URL="https://github.com/harfbuzz/harfbuzz/releases/download/${HA
|
|||
export CAIRO_URL="https://cairographics.org/releases/cairo-${CAIRO_VERSION}.tar.xz"
|
||||
export PIXMAN_URL="https://cairographics.org/releases/pixman-${PIXMAN_VERSION}.tar.gz"
|
||||
export OCC_URL="https://github.com/Open-Cascade-SAS/OCCT/archive/refs/tags/V${OCC_VERSION//./_}.tar.gz"
|
||||
export RAPIDJSON_URL="https://github.com/Tencent/rapidjson/archive/${RAPIDJSON_COMMIT}.tar.gz"
|
||||
export NGSPICE_URL="https://sourceforge.net/projects/ngspice/files/ng-spice-rework/${NGSPICE_VERSION}/ngspice-${NGSPICE_VERSION}.tar.gz/download"
|
||||
|
||||
# SHA256 checksums (to be filled in after first successful download)
|
||||
|
|
|
|||
|
|
@ -210,7 +210,10 @@ function main() {
|
|||
env.VITE_REPO_URL = a.repo;
|
||||
|
||||
const viteArgs = ["--dir", "web", "--filter", "@pcbjam/standalone", "dev"];
|
||||
if (a.port) viteArgs.push("--", "--port", String(a.port));
|
||||
// No "--" separator: pnpm forwards script args verbatim, so a literal "--"
|
||||
// reaches vite and makes it IGNORE the flags after it ("vite -- --port N"
|
||||
// starts on the default port). Appending directly yields "vite --port N".
|
||||
if (a.port) viteArgs.push("--port", String(a.port));
|
||||
|
||||
console.log("dev-demo: standalone in demo mode (R2-only backend, no partykit)");
|
||||
console.log(` VITE_LIBS_SOURCE=${env.VITE_LIBS_SOURCE}${env.VITE_LIBS_MANIFEST_URL ? ` (${env.VITE_LIBS_MANIFEST_URL})` : ""}`);
|
||||
|
|
|
|||
|
|
@ -34,16 +34,23 @@ import {
|
|||
// bundle, booted with a runtime --frame flag (editor-unification Part 2) — none of
|
||||
// them publishes anything of its own. The frontend maps tools onto bundles via
|
||||
// TOOL_BUNDLE. sym_convert is a node CLI, not served.
|
||||
// occ_service is the lazy OCC worker module (STEP export + STEP/IGES model
|
||||
// parsing for the PCB frames, docs/features/occ-split/) — served, but headless:
|
||||
// no wx glue, no image archive.
|
||||
const TOOLS = [
|
||||
"kicad_editor",
|
||||
"pl_editor",
|
||||
"gerbview",
|
||||
"calculator",
|
||||
"occ_service",
|
||||
];
|
||||
|
||||
// Files that make up a self-contained tool bundle. `<tool>` is substituted.
|
||||
const SHARED_FILES = ["wx.js", "wx-dom.js", "images.tar.gz"];
|
||||
const toolFiles = (tool) => [`${tool}.wasm`, `${tool}.js`, ...SHARED_FILES];
|
||||
const toolFiles = (tool) =>
|
||||
tool === "occ_service"
|
||||
? [`${tool}.wasm`, `${tool}.js`]
|
||||
: [`${tool}.wasm`, `${tool}.js`, ...SHARED_FILES];
|
||||
|
||||
// Per-file HTTP rules (see the 0001 header matrix). `compress` is whether the
|
||||
// publisher compresses + sets Content-Encoding; images.tar.gz must stay RAW
|
||||
|
|
|
|||
|
|
@ -50,6 +50,22 @@ if [ ! -d "${OCC_DIR}" ]; then
|
|||
rm "opencascade-${OCC_VERSION}.tar.gz"
|
||||
fi
|
||||
|
||||
# RapidJSON (header-only): required by OCC's glTF/GLB writer — without it the
|
||||
# writer compiles out (HAVE_RAPIDJSON undefined) and GLB export fails at
|
||||
# runtime with "glTF writer is unavailable". Pinned to the vcpkg master
|
||||
# snapshot (see versions.sh) — a commit archive extracts as rapidjson-<sha>,
|
||||
# so rename to the dated version dir.
|
||||
RAPIDJSON_DIR="${DEPS_ROOT}/rapidjson-${RAPIDJSON_VERSION}"
|
||||
if [ ! -d "${RAPIDJSON_DIR}" ]; then
|
||||
log_info "Downloading RapidJSON ${RAPIDJSON_VERSION} (master snapshot ${RAPIDJSON_COMMIT:0:12})..."
|
||||
mkdir -p "${DEPS_ROOT}"
|
||||
cd "${DEPS_ROOT}"
|
||||
download_file "${RAPIDJSON_URL}" "rapidjson-${RAPIDJSON_VERSION}.tar.gz"
|
||||
tar -xzf "rapidjson-${RAPIDJSON_VERSION}.tar.gz"
|
||||
mv "rapidjson-${RAPIDJSON_COMMIT}" "rapidjson-${RAPIDJSON_VERSION}"
|
||||
rm "rapidjson-${RAPIDJSON_VERSION}.tar.gz"
|
||||
fi
|
||||
|
||||
log_info "Building OpenCASCADE ${OCC_VERSION} for WASM..."
|
||||
log_warn "This is a large library and may take a while..."
|
||||
|
||||
|
|
@ -100,7 +116,8 @@ emcmake cmake "${OCC_DIR}" \
|
|||
-DUSE_GLES2=OFF \
|
||||
-DUSE_OPENGL=OFF \
|
||||
-DUSE_D3D=OFF \
|
||||
-DUSE_RAPIDJSON=OFF \
|
||||
-DUSE_RAPIDJSON=ON \
|
||||
-D3RDPARTY_RAPIDJSON_DIR="${RAPIDJSON_DIR}" \
|
||||
-DUSE_DRACO=OFF \
|
||||
-DBUILD_DOC_Overview=OFF \
|
||||
-DINSTALL_SAMPLES=OFF \
|
||||
|
|
|
|||
|
|
@ -73,8 +73,16 @@ case "$APP_NAME" in
|
|||
KICAD_TARGET="sym_convert"
|
||||
KICAD_SUBDIR="eeschema"
|
||||
;;
|
||||
occ_service)
|
||||
# Standalone OpenCASCADE 3D service (worker embind module). Target lives
|
||||
# in wasm/occ-service/ (added by the fork's top-level CMakeLists under
|
||||
# -DKICAD_OCC_SERVICE_WASM=ON); like kicad_editor, its binary dir
|
||||
# doubles as the artifact subdir of its own kicad-occ_service tree.
|
||||
KICAD_TARGET="occ_service"
|
||||
KICAD_SUBDIR="occ_service"
|
||||
;;
|
||||
*)
|
||||
echo "Error: unknown app '$APP_NAME' (expected: kicad_editor | pcbnew | eeschema | calculator | pl_editor | gerbview | sym_convert)" >&2
|
||||
echo "Error: unknown app '$APP_NAME' (expected: kicad_editor | pcbnew | eeschema | calculator | pl_editor | gerbview | sym_convert | occ_service)" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
|
@ -84,6 +92,10 @@ esac
|
|||
# embind symbols (kicadCollabOnSave et al.) — reuse eeschema's embind object.
|
||||
case "$APP_NAME" in
|
||||
sym_convert) EMBIND_APP="eeschema" ;;
|
||||
# occ_service links the pcbnew kiface objects → pcbnew's embind object, same
|
||||
# reason (its own embind entry points live in occ_service_main.cpp, compiled
|
||||
# inside the CMake target).
|
||||
occ_service) EMBIND_APP="pcbnew" ;;
|
||||
*) EMBIND_APP="$APP_NAME" ;;
|
||||
esac
|
||||
|
||||
|
|
@ -95,6 +107,9 @@ esac
|
|||
case "$APP_NAME" in
|
||||
sym_convert) STUB_APP="eeschema" ;;
|
||||
kicad_editor) STUB_APP="pcbnew" ;;
|
||||
# occ_service links the pcbnew kiface objects → pcbnew's stubs (frame +
|
||||
# action-plugin scripting placeholders), like the editors.
|
||||
occ_service) STUB_APP="pcbnew" ;;
|
||||
*) STUB_APP="$APP_NAME" ;;
|
||||
esac
|
||||
|
||||
|
|
@ -337,11 +352,12 @@ fi
|
|||
EMSDK_WASM_OPT="${EMSDK}/upstream/bin/wasm-opt"
|
||||
EMSDK_FINALIZE="${EMSDK}/upstream/bin/wasm-emscripten-finalize"
|
||||
|
||||
if [ "${APP_NAME}" = "sym_convert" ]; then
|
||||
# Use the real tools so the converter is fully finalized inside the container.
|
||||
if [ "${APP_NAME}" = "sym_convert" ] || [ "${APP_NAME}" = "occ_service" ]; then
|
||||
# Use the real tools so the small -g0 module is fully finalized inside the
|
||||
# container (no host post-processing / asyncify for these targets).
|
||||
[ -f "${EMSDK_WASM_OPT}.real" ] && cp "${EMSDK_WASM_OPT}.real" "${EMSDK_WASM_OPT}"
|
||||
[ -f "${EMSDK_FINALIZE}.real" ] && cp "${EMSDK_FINALIZE}.real" "${EMSDK_FINALIZE}"
|
||||
log_info "Using real wasm-opt/finalize for sym_convert (finalize in-container)"
|
||||
log_info "Using real wasm-opt/finalize for ${APP_NAME} (finalize in-container)"
|
||||
else
|
||||
if [ -f "${EMSDK_WASM_OPT}" ] && [ ! -f "${EMSDK_WASM_OPT}.real" ]; then
|
||||
log_info "Backing up real wasm-opt..."
|
||||
|
|
@ -421,6 +437,13 @@ if [ "${APP_NAME}" = "kicad_editor" ]; then
|
|||
MERGED_EDITOR_CMAKE_FLAG="-DKICAD_WASM_MERGED_EDITOR=ON"
|
||||
fi
|
||||
|
||||
# The standalone OCC 3D service (worker embind module) — gates the
|
||||
# wasm/occ-service/ subdir in the fork's top-level CMakeLists.
|
||||
OCC_SERVICE_CMAKE_FLAG=""
|
||||
if [ "${APP_NAME}" = "occ_service" ]; then
|
||||
OCC_SERVICE_CMAKE_FLAG="-DKICAD_OCC_SERVICE_WASM=ON"
|
||||
fi
|
||||
|
||||
# 3D viewer: built by DEFAULT (BUILD_3D_VIEWER=ON). Opt out with BUILD_3D_VIEWER=OFF, which links the
|
||||
# 3D stubs instead. The 3D viewer renders with the GL-free CPU raytracer (RENDER_3D_RAYTRACE_RAM)
|
||||
# blitted to the canvas through a plain WebGL2 textured quad — no -sLEGACY_GL_EMULATION. KiCad's
|
||||
|
|
@ -472,6 +495,7 @@ emcmake cmake "${KICAD_DIR}" \
|
|||
${CCACHE_OPTS} \
|
||||
${SYM_CONVERTER_CMAKE_FLAG} \
|
||||
${MERGED_EDITOR_CMAKE_FLAG} \
|
||||
${OCC_SERVICE_CMAKE_FLAG} \
|
||||
-DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
|
||||
-DCMAKE_INSTALL_PREFIX="${SYSROOT}" \
|
||||
-DCMAKE_MODULE_PATH="${WASM_LAYER}/cmake" \
|
||||
|
|
@ -582,7 +606,16 @@ elif [ -f "${EMBIND_SRC}" ]; then
|
|||
emmake make -j${JOBS} pcbcommon
|
||||
fi
|
||||
log_info "Compiling Embind bindings (${APP_NAME})..."
|
||||
compile_embind_tu "${EMBIND_SRC}" "${EMBIND_OBJ}" "${KICAD_SUBDIR}"
|
||||
# The include home is the app the BINDINGS belong to, not the artifact
|
||||
# subdir — for occ_service the two differ (bindings = pcbnew's; artifacts
|
||||
# land in the wasm/occ-service target's own occ_service/ binary dir, which
|
||||
# has no KiCad sources).
|
||||
case "${EMBIND_APP}" in
|
||||
pcbnew) EMBIND_INC_SUBDIR="pcbnew" ;;
|
||||
eeschema) EMBIND_INC_SUBDIR="eeschema" ;;
|
||||
*) EMBIND_INC_SUBDIR="${KICAD_SUBDIR}" ;;
|
||||
esac
|
||||
compile_embind_tu "${EMBIND_SRC}" "${EMBIND_OBJ}" "${EMBIND_INC_SUBDIR}"
|
||||
else
|
||||
log_info "No embind source for ${APP_NAME} (expected at ${EMBIND_SRC}); using empty placeholder"
|
||||
EMPTY_C="${STUBS_BUILD}/${APP_NAME}_embind_empty.c"
|
||||
|
|
@ -613,8 +646,8 @@ emmake make -j${JOBS} "${KICAD_TARGET}"
|
|||
|
||||
# Step 8.1: Build bitmap resources (images.tar.gz)
|
||||
# This creates the icon archive that KiCad loads at runtime. The headless
|
||||
# converter has no GUI/icons, so skip it.
|
||||
if [ "${APP_NAME}" != "sym_convert" ]; then
|
||||
# converter/service targets have no GUI/icons, so skip it.
|
||||
if [ "${APP_NAME}" != "sym_convert" ] && [ "${APP_NAME}" != "occ_service" ]; then
|
||||
kw_stage kicad-bitmaps
|
||||
log_info "Building bitmap resources..."
|
||||
emmake make bitmap_archive_build
|
||||
|
|
|
|||
8
scripts/kicad/build-occ_service.sh
Executable file
8
scripts/kicad/build-occ_service.sh
Executable file
|
|
@ -0,0 +1,8 @@
|
|||
#!/bin/bash
|
||||
# Build the standalone OpenCASCADE 3D service (occ_service) for WebAssembly —
|
||||
# a persistent Web-Worker embind module (STEP/3D export + STEP/IGES model
|
||||
# tessellation). Thin wrapper around build-kicad-target.sh — see that script
|
||||
# for options, and docs/features/occ-split/README.md for the design.
|
||||
set -e
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
exec "${SCRIPT_DIR}/build-kicad-target.sh" occ_service "$@"
|
||||
Loading…
Reference in a new issue