Skip to content

perf(desktop): strip local symbols from the bundled macOS ONNX Runtime #2765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
richiemcilroy wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −2
Open

perf(desktop): strip local symbols from the bundled macOS ONNX Runtime #2765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ jobs:
- 'Cargo.lock'
gpui:
- '.gitattributes'
- 'scripts/setup.js'
- 'apps/desktop-gpui/**'
- 'apps/desktop/src/assets/**'
- 'apps/desktop/src-tauri/src/recording_start_sound.rs'
Expand Down Expand Up @@ -340,6 +341,18 @@ jobs:
env:
RUST_TARGET_TRIPLE: ${{ matrix.settings.target }}

# setup.js strips the local symbols from Microsoft's ONNX Runtime dylib
# before Cap bundles it; the C API ort loads through must still resolve
# and run a real inference.
- name: Test the prepared ONNX Runtime
if: ${{ runner.os == 'macOS' }}
shell: bash
run: |
set -euo pipefail
dylib=target/native-deps/onnxruntime/lib/libonnxruntime.dylib
nm -gU "$dylib" | grep -q OrtGetApiBase
cargo test --locked -p cap-camera-effects --lib segmentation::tests::inference_runs_from_a_caller_with_a_tiny_stack -- --ignored --exact

# The test build compiles every line the binary build does (the app has
# no cfg(not(test)) code), so a separate binary build only repeated the
# app crate's compile and link. Release builds still produce the binary.
Expand Down
10 changes: 8 additions & 2 deletions scripts/setup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,9 @@ async function setupMacOSOnnxRuntime() {
const outputDir = path.join(targetDir, "native-deps", "onnxruntime", "lib");
const outputPath = path.join(outputDir, "libonnxruntime.dylib");
const markerPath = path.join(outputDir, "asset.txt");
// Microsoft's dylib keeps ~12 MB of local symbols nothing in Cap reads; the
// marker changes with the preparation so a cached unstripped copy is redone.
const preparedMarker = `${asset.name}:stripped`;
const marker = await fs
.readFile(markerPath, "utf-8")
.then((value) => value.trim())
Expand All @@ -448,16 +451,19 @@ async function setupMacOSOnnxRuntime() {
console.log(`Downloaded ${asset.name}`);
} else console.log(`Using cached ${asset.name}`);

if (!(await fileExists(outputPath)) || marker !== asset.name) {
if (!(await fileExists(outputPath)) || marker !== preparedMarker) {
await fs.rm(extractDir, { recursive: true, force: true }).catch(() => {});
await execFile("tar", ["xf", archivePath, "-C", targetDir]);
await fs.mkdir(outputDir, { recursive: true });
await fs.copyFile(
path.join(extractDir, "lib", "libonnxruntime.dylib"),
outputPath,
);
// Local symbols only: the exported C API (OrtGetApiBase) that ort loads
// through is unchanged.
await execFile("strip", ["-x", outputPath]);
await signMacOSDylib(outputPath);
await fs.writeFile(markerPath, asset.name);
await fs.writeFile(markerPath, preparedMarker);
console.log("Prepared ONNX Runtime dylib");
} else {
console.log("Using cached ONNX Runtime dylib");
Expand Down
Loading