masi/solvecraft
1
0
Fork 0
mirror of https://github.com/bherbruck/solidcraft.git synced 2026-11-03 18:45:55 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Profiler: docs/perf.md says how to switch it on and read it

Browse Source 
What each category records, self and total time, the table and the Chrome
trace; the CLI's --profile and --profile-out on scripts, designs and STEP
files; diagnostics.profile over the control channel.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LUXeKMoxpM7Vuv8Rb6E3K2
This commit is contained in:
jyviko
2026-10-27 10:08:18 -04:00
committed by Irakli Kourtis
parent faffa66648
commit 7fde0bdffd
2 changed files with 38 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/book/src/guide/getting-started.md
+4 -1
View File
@@ -322,7 +322,10 @@ cargo run --release -p solidcraft-cli -- eval examples/bracket.json --json-out m
To find the slow steps of a script, `--timings` prints how long each command took instead of
the measurement: `{"timings": [{"index", "command", "ms"}], "total_ms"}`, with `index` counted
from 0. `--profile` adds each command's `profile: {"boolean_ms", "tessellate_ms", "other_ms"}`,
its wall time in the kernel's booleans, in tessellation and in everything else. With
its wall time in the kernel's booleans, in tessellation and in everything else, and prints the
profiler's table on stderr: where the time went, SMLib's calls to the commands
(`docs/perf.md`, "Where the time goes"); `--profile-out trace.json` also writes the spans as a
Chrome trace. `--profile` works on a design or STEP file too. With
`--results` as well, the results go in the same object as `results`; `--results` alone still
prints a plain array.
docs/perf.md
+34
View File
@@ -1,3 +1,37 @@
# Where the time goes: the profiler
Every app is built with the profiler (`crates/profile`, the apps' default `profile` feature).
It records nothing until switched on: `SOLIDCRAFT_PROFILE=1`, the CLI's `--profile`, the
**Profile operations** preference (Graphics page) or `diagnostics.profile {"enabled": true}`.
Off, a span is one relaxed atomic load.
What it records, as nested spans on each thread:
| Category | Spans |
|---|---|
| `smlib` | every SMLib C API call, timed by the C API itself (`steady_clock`) |
| `kernel` | booleans, blends, sweeps, lofts, shell/draft/offset, healing, sewing, conversions, meshing, measuring |
| `import` | the stages of a STEP or IGES import: parse, index, each solid, placement, mesh check, convert batches |
| `feature` | each feature computed, by its type; `doc evaluate` around them |
| `command` | each `Session::execute`, by command id |
| `io` | import, export, design read and write |
Self time is a span's time less the spans inside it; its total counts only its outermost run
on a thread, so a command run by a command is not counted twice. Work handed to other threads
shows under their own spans. The report is a table (the most self time first, with self time
per category) and the individual spans as a Chrome trace-event file for chrome://tracing or
ui.perfetto.dev (at most 200,000 spans; later ones still count in the table).
```sh
solidcraft-cli run part.step --profile --profile-out trace.json # table on stderr
solidcraft-cli run part.solidcraft --profile --quiet
solidcraft-cli bench-open part.step --profile
```
Over the control channel or MCP: `diagnostics.profile {"reset": true, "enabled": true}`, do the
work, then `diagnostics.profile {"top": 30, "trace": "trace.json"}`. A STEP or IGES import's
reply carries its own profile while recording.
# Design loading
## Edges made by booleans: each point evaluated once (2026-10-16)