Skip to content

state_exec: a limit on native call nesting; class teardown and the closure codec without recursion - #682

Merged
transfix merged 2 commits into
masterfrom
feat/state-exec-nesting-cap
Oct 18, 2026
Merged

transfix merged 2 commits into
masterfrom
feat/state-exec-nesting-cap

Conversation

@transfix

@transfix transfix commented Oct 18, 2026 •

Copy link
Copy Markdown
Owner

The second part of finishing the deep-data work (the first is #678). A sweep of the repo for native recursion found three problems that #657/#658 left. Each can crash a process from any full-environment script.

1. Native call nesting had no limit

A native function that calls another function itself (apply, send, a class constructor running init, an inherited init running its superclass's), or runs a nested evaluator (a class method, a generator advancing), nests on the native stack. Several scripts nest without bound and crash the process:

  • (apply apply L) with L containing itself;
  • send re-sending through itself;
  • a class whose init is its own constructor;
  • a long chain of inherited inits;
  • methods calling methods;
  • generators of generators.

detail::native_nesting now counts these levels. It runs in call_function, call_here, run_data_job's job calls, the class constructor, inherited methods, class methods' nested evaluator and generator_next. A level throws "<who>: native calls nested too deeply (N levels; ...)" in either of two cases:

  • past kMaxNativeNesting (256) levels;
  • when less than kNativeStackReserve of the thread's native stack is left: 128 KiB on Windows, 32 KiB elsewhere.

native_stack.cpp asks the platform where the stack ends: VirtualQuery, pthread_getattr_np, pthread_get_stackaddr_np or emscripten_stack_get_end.

Why both checks, measured in a Release build:

Kind of level Stack per level
apply about 0.5 KiB
nested generator 2-4 KiB
class method's evaluator over 10 KiB
  • No single level count fits a 64 KiB stack with the heavy kinds, and the light kinds can still take thousands of levels on a big stack.
  • With only the stack check, a throw from about 7600 levels deep crashed on Windows. MSVC runs a catch block before unwinding the frames above it, so whoever catches the error (a scheduler killing the process) runs on top of the full stack. The level count bounds that depth; the larger Windows reserve leaves the catch block room.

DSL functions calling DSL functions are not levels; they are evaluator frames on the heap.

2. Freeing a long class chain recursed

class_constructor, class_inherited_method and class_method held their class dict or closure as a raw shared_ptr. Freeing a superclass chain therefore took a native frame per class. They now drop it through drop_owner, as value_t does. The constructor and inherited methods also call a copy of the function, not a reference into a class dict the callee may change (set-attr on __cls_dict__).

3. The snapshot codec recursed through closures, forever for a defun

The codec wrote each closure's scope chain inside the closure, and each binding with a fresh encode_value. That cost one native level per closure nesting. A function whose scope binds the function itself made encode_environment recurse forever. Any defun'd function is one, so snapshotting a paused process that had defined one overflowed the stack. (Nothing in production snapshots processes yet; tests and future migration do.)

Values, closure bodies and scopes are now one walk with one explicit stack:

  • Writing. Each scope the walk reaches is an entry of an __envs__ table under the node the walk started at, holding its bindings (sorted) and an __outer__ reference. A closure's __env__ is a reference to an entry (env_ref), or nil.
  • Reading. A referenced entry becomes one environment, so closures that shared a scope share it again. A bad reference, or an __outer__ chain that loops, throws (unlinked first, so nothing leaks).
  • Older snapshots still decode. A closure with no __env__, or an inline env_chain, is read the old way, its body expressions and bindings each with their own __spill__ table.

Tests

  • StateExecNativeNesting, 7 tests:
    • each runaway case throws on a 64 KiB stack instead of crashing, and leaves no level counted;
    • legitimate nesting still works on 1 MiB;
    • a 4 MiB stack stops at the level count;
    • FreeingALongClassChain (10000 classes on 64 KiB) crashed before fix 2 (checked by removing the destructors).
  • EnvironmentCodecTest:
    • AFunctionItsOwnScopeBinds: a defun'd factorial round-trips, keeps its scope, and runs;
    • ClosuresThatShareAScopeStillShareIt;
    • OlderSnapshotsStillDecode: the old layout built by hand, spill table included;
    • BadScopeReferencesThrow.
  • StateExecDeepDataCodec.ClosureChainRoundTrip: 10000 closures, each bound in the next one's scope, on the small stack.
  • Docs: "Native call nesting" and "Snapshots of closures" in docs/STATE_EXEC_GRAMMAR.md.

Local results (MSVC 14.38 Release, Windows)

  • All 28 state_exec, Ariadne, state, state_list and app suites pass (1671 tests).
  • state_exec_deep_data_test passes at 64 KiB.
  • clang-format 18 is clean on the changed lines.

Next (B2): class methods as closures run through call_function (frames, not a temporary evaluator), and generators advanced as data jobs. That removes the heaviest nesting levels and makes a generator body's steps sliced and counted.

…chain iteratively

A native function that calls another function itself, or runs a nested evaluator, nests on the
native stack. Several of these could ask for unbounded nesting and crash the process:
- (apply apply L) with L containing itself;
- send re-sending through itself;
- a class whose init is its own constructor;
- a long chain of inherited inits;
- methods calling methods, and generators of generators.

detail::native_nesting now counts these levels:
- where: call_function, call_here, run_data_job's job calls, the class constructor's init
  call, inherited init/finalize, class methods' nested evaluator and generator_next;
- the limit: a level throws past kMaxNativeNesting (256) levels, or when less than
  kNativeStackReserve of the thread's native stack is left;
- the reserve is 128 KiB on Windows, where MSVC runs a catch block before unwinding the
  frames above it, and 32 KiB elsewhere;
- native_stack.cpp asks the platform where the stack ends: VirtualQuery,
  pthread_getattr_np, pthread_get_stackaddr_np or emscripten_stack_get_end.

Measured per level in a Release build: about 0.5 KiB for apply, 2-4 KiB for a nested
generator, and over 10 KiB for a class method's evaluator. That spread is why a level
count alone could not fit a 64 KiB stack.

class_method, class_constructor and class_inherited_method drop what they hold through
drop_owner, as value_t does. Freeing a long superclass chain used to take a native frame
per class. The constructor and inherited methods also call a copy of the function, not a
reference into a class dict the callee may change.

Tests (StateExecNativeNesting):
- each runaway case throws on a 64 KiB stack instead of crashing, and leaves no level
  counted;
- legitimate nesting still works on 1 MiB;
- a 4 MiB stack stops at the level count;
- freeing a 10000-class chain on 64 KiB crashed before this change.
The codec wrote each closure's scope chain inside the closure, and each binding in it with a
fresh encode_value. That cost one native level per closure nesting. A function whose scope
binds the function itself made encode_environment recurse forever. Any defun'd function is
one, so a snapshot of a paused process that had defined one overflowed the stack.

Values, closure bodies and scopes are now one walk with one explicit stack (value_writer):
- each scope the walk reaches is an entry of an __envs__ table under the node it started at,
  holding the scope's bindings (sorted by name) and an __outer__ reference;
- a closure's __env__ is a reference to an entry (__type__ "env_ref") or nil;
- encode_environment writes a reference at its node, with the table under it.

value_reader decodes it the same way:
- a referenced entry becomes one environment, filled once, so closures that shared a scope
  share it again;
- a bad reference, or an __outer__ chain that loops back on itself, throws (the loop is
  unlinked first, so nothing leaks).

Older snapshots still decode. A closure whose __env__ is missing or an inline env_chain is
read the old way: its body expressions and scope bindings each with their own __spill__ table.

Tests:
- AFunctionItsOwnScopeBinds: a defun'd factorial round-trips, keeps its scope, and runs;
- ClosuresThatShareAScopeStillShareIt;
- OlderSnapshotsStillDecode: the old layout, built by hand, spill table included;
- BadScopeReferencesThrow;
- StateExecDeepDataCodec.ClosureChainRoundTrip: 10000 closures, each bound in the next one's
  scope, on the small stack.
@transfix
transfix merged commit 37a99c1 into master Oct 18, 2026
16 checks passed
transfix added a commit that referenced this pull request Oct 18, 2026
…p-finish

Conflicts: STATE_EXEC_GRAMMAR.md's native-calls list (state-json/state-from-json from #681, state-set here: both kept), and the tests #681/#682 and this branch each added to state_exec_data_steps_test.cpp and state_exec_deep_data_test.cpp (all kept). #675's pycvc tests asserted the old parser.max_depth default of 256; they now compare with pycvc.parse_options().max_depth, as agreed with the parity session.
transfix added a commit that referenced this pull request Oct 18, 2026
…-exec-no-nested-eval

Master has #682 as one squash commit; this branch had its original commits. The merge's tree is c4ca22c applied onto master: one conflict, the tests #681 and this branch each appended to state_exec_data_steps_test.cpp, both kept.
transfix added a commit that referenced this pull request Oct 18, 2026
transfix added a commit that referenced this pull request Oct 18, 2026
transfix added a commit that referenced this pull request Oct 18, 2026
…y-depth values) (#679)

* state_exec: grammar spec, conformance cases and parse corpus (grammar P0)

Declare the state_exec s-expression grammar in docs/STATE_EXEC_GRAMMAR.md
(W3C EBNF, Unicode source rules, literal tables, and a table of every
intentional change from the hand-written parser, tagged by phase P2-P4).
The parser itself is unchanged; later phases build it from this grammar.

state_exec_grammar_test tags each case with the phase it holds from:
landed cases must hold, pending cases must still differ, the doc's EBNF
must be closed, and every production needs a case. state_exec_corpus_test
pins how the 597 DSL scripts the repo carries parse today
(state_exec_corpus/, regenerated with gen_state_exec_corpus.py and
CVC_UPDATE_GOLDENS=1).

Also correct parser.h (no quasiquote) and the developer guide (false and
#f read as nil, bytes literals exist).

* state_exec grammar: make the nesting limit configurable (default 256)

Spec only: parse_options::max_depth on parse()/parse_all()/parser and execute_options::max_parse_depth for submitted scripts, both from P2. Records why the limit exists (the reader recurses on the native stack; the evaluators are stackless) and the corpus's real depths (max 13, median 2).

* state_exec grammar: parser settings live on the state tree

Spec only. max_depth resolves from state_exec.schedulers.<id>.parser.max_depth, then state_exec.defaults.parser.max_depth, then 256, matching scheduler::load_settings(); parse_options remains for callers without a tree. Drops the execute_options::max_parse_depth idea so the tree is the single source.

* state_exec: parser settings on the state tree, with a nesting limit (grammar P1b)

The parser now stops at parser.max_depth nested lists and quotes (default
256) with a parse_error, instead of recursing until the native stack
overflows. Like the scheduler's other settings, the limit lives on the
state tree: state_exec.schedulers.<id>.parser.max_depth, then
state_exec.defaults.parser.max_depth, then 256; a missing, malformed or
zero value is skipped.

- parser: parse_options (max_depth) on parse()/parse_all()/parser, a
  depth guard on lists and quotes, and parse_options_from_state().
- scheduler: load_settings() resolves parser.* and publishes the
  effective value under state_exec.schedulers.<id>.parser.max_depth;
  execute() parses with it.
- async_scheduler (the app's exec scheduler) reads the defaults key on
  every submit; Ariadne predicates read it from the app tree.
- stackless evaluators: create_state(script, env, parse_options).

The grammar test moves from a numeric kLandedPhase to named phases; the
257-deep case is P1b and holds now. Tests cover the default, a custom
depth, quotes, 100000 open parens, the error position, tree resolution,
bad values, and both schedulers.

* state_exec: make the parser stackless (explicit frame stack, resumable read)

Lists and quotes were parsed by native recursion, so input depth was
bounded by the thread's stack. The parser now keeps open lists and quotes
on a heap stack of frames and reads in a loop: native stack depth is
constant however deeply the input nests (a test reads a million open
parens and reports the unclosed list instead of crashing).

The loop is a resumable read(out, budget): it reads up to `budget` tokens
and returns datum / end / more, carrying open frames between calls, so a
scheduler can parse a script a slice at a time. parse() and parse_all()
call it with no budget.

Output is unchanged, quirks included (a stray top-level `)` still reads
as a symbol until P2): the conformance cases, the 597-script corpus and
the evaluator suites all pass. parser.max_depth stays on the state tree;
it now bounds parsed data for the code that still walks values
recursively (list destruction, the snapshot codec, to_string) rather
than the parser's own stack. parse_fib20_expr: about 3.4 us vs 3.1 us
for the recursive parser (median of 6, MSVC Release, loaded machine).

* state_exec: read submitted scripts inside the process, a slice per step

The stackless parser's state is an input position plus a heap stack of
open frames, so it can pause anywhere. New setting parser.step_tokens
(on the state tree, resolved like parser.max_depth; default 0) lets a
scheduler parse a submitted script inside the new process instead of at
submit: each scheduler step reads N tokens, and the step that reaches the
end sets up evaluation exactly as parsing up front would have.

- Reading steps are process steps: they count against max_steps and
  max_time and interleave with other processes.
- A syntax error surfaces like a runtime error: the async scheduler kills
  the process with it as the exit error; the sync scheduler throws it
  from step()/run(). With step_tokens = 0, execute() still throws.
- Signals and watch events wait until the script is read (their
  handlers run on the evaluation stack, which doesn't exist yet).
- The snapshot codec stores a mid-read process's source and settings and
  re-reads it after a restore.

Adds parse_options::step_tokens, script_reader (owns its source and
drives parser::read() a budget at a time) and evaluator_state::reading;
stackless_evaluator::step() reads until the script is read. Tests cover
the reader, the evaluator, the codec and both schedulers (results,
syntax errors, max_steps, deferred signals).

* state_exec: the app's exec scheduler reads scripts in steps (1024 tokens)

app::exec_scheduler(), which runs Ariadne's actions and residents, now
defaults parser.step_tokens to 1024, so it parses submitted scripts
inside their processes. async_scheduler gains set_parser_defaults(): the
built-in values under its watch root's state_exec.defaults.parser.* keys.
A plain async_scheduler (pycvc's Exec) and the sync scheduler stay at 0,
so they still report syntax errors at submit.

Why 1024: every script the repo carries reads in one slice (the largest
is 159 tokens, .ari scripts at most 24), so a normal action pays one
extra step of its 5000; a slice costs about 80 us at the parser's
measured ~80 ns/token, so a pathologically large script is spread over
steps and frames instead of stalling a drain.

Ariadne now says why a process died: a killed action's warning carries
its exit error, and the per-frame sweep reports a killed resident (a
syntax error in its body, a runtime error, its per-step cap) once,
instead of letting it vanish silently.

* pycvc: give Exec the same state_exec defaults as the app's exec scheduler

pycvc's Exec runs programs on a private async_scheduler that already
watches the app's state tree, but its built-in parser defaults were
plain parse_options{} while app::exec_scheduler() read scripts in
1024-token steps. Both now take async_scheduler::host_parser_defaults(),
one definition (with the reasoning for 1024) for every libcvc host, and
the app tree's state_exec.defaults.parser.* keys override both.

Exec.run() still raises a RuntimeError with the parse error's message:
from the killed process's exit error when the script is read in steps,
or from execute() when the tree sets step_tokens to 0.

Tests: test_pycvc_exec.py checks the parse error's message and that
max_depth / step_tokens on the app tree configure Exec; the integration
test pins the app scheduler to host_parser_defaults().

* pycvc: expose the state_exec parser-settings surface under its C++ names

pycvc's state_exec surface was only Exec; the parser settings these PRs
add had no Python counterpart, so the defaults weren't even observable.
In pycvc's direct-wrap style (the real C++ types, no facade):

- pycvc.parse_options: the real cvc::state_exec::parse_options struct
  (max_depth, step_tokens), C++ defaults included.
- pycvc.async_scheduler.host_parser_defaults(): the real static, declared
  to SWIG on its own (async_scheduler isn't wrapped yet, so no
  constructor).
- pycvc.parse_options_from_state(app, scheduler_id="", base=...): the C++
  resolver, taking the app where C++ takes the root (pycvc's convention).
- Exec.parser_defaults() / Exec.set_parser_defaults(): the same calls as
  the async_scheduler Exec wraps.

test_pycvc_exec.py covers each against the C++ behaviour; the README
gains a state_exec section. Built locally (SWIG 4.4.1, Python 3.11):
exec, exec_async, exec_coro and ari tests, 26 passed.

* pycvc: parse_options_from_state takes the State root, as in C++

Wrap the real cvc::state_exec::parse_options_from_state(state&, id, base)
instead of a pycvc adapter that took the app: Python passes the tree root,
pycvc.State.instance(app), exactly as C++ passes cvc::state&. This is the
first decision of the pycvc/C++ parity approach (C++ cvc::state& parameters
take a pycvc.State in Python).

* pycvc: state_exec parity part 1 (values, parsing, parse_error, value codec)

Start bringing pycvc's state_exec API to the C++ surface under the C++
names (docs/PYCVC_STATE_EXEC_PARITY.md: the audit of all 20 state_exec
headers, the agreed approach, and the PR plan).

- One strict value_t <-> Python conversion (pycvc_value.h), used by every
  API and by Exec: native types for data, pycvc.symbol (the real struct)
  for symbols, and pycvc.value (the real value_t, opaque) for closures,
  native fns, data objects and generators, which convert back unchanged.
  Non-str dict keys and unsupported types raise TypeError, ints beyond 64
  bits OverflowError, and nesting past 1000 levels or a cycle ValueError.
  This replaces the lossy converter (symbols became str, closures
  "<closure>", anything else str(obj)), which could also put a null item
  in a list on invalid UTF-8 and leave an OverflowError pending.
- pycvc.parse / parse_all, pycvc.parse_error (a RuntimeError with .line
  and .col), pycvc.script_reader, to_string, values_equal, and the value
  codec encode_value / decode_value on a State node.
- Exec.run raises pycvc.parse_error for a syntax error whether the script
  was parsed at submit or read inside the process (it re-parses a killed
  process's script to recover the position).
- The pycvc README's Status/Design sections described a v0 facade; they
  now describe the direct-wrap design.

test_pycvc_state_exec.py (13 tests) covers each against the C++
behaviour. Locally: those plus pycvc's exec, async, coro, ari, state and
core suites pass (87), except test_volume_rawiv_roundtrip, which fails
the same way on the unmodified build (a Windows temp-file lock).

* pycvc: state_exec parity part 2 (environments, builtins, schedulers)

Wrap the scheduler surface of cvc::state_exec under the C++ names:

- environment (shared, as environment_ptr) and builtins:
  make_default_environment, and register_fn taking a Python callable
  or a pycvc.value holding a native fn.
- execute_options (on_complete is a Python callable, signal_handlers a
  dict), process_info, scheduler_stats, percent_encode/percent_decode.
- process_status and scheduling_policy as enum.IntEnum classes; an enum
  argument must be a member, so to_string(process_status) and
  to_string(value_t) keep their shared name.
- scheduler and async_scheduler as real classes with their
  non-coroutine members. run/step and sync_run/sync_step release the
  GIL; Python callbacks retake it.
- Exec.scheduler() returns Exec's async_scheduler, which keeps the Exec
  alive.

Empty optionals are None, except for values: get_result,
pop_pending_message and environment.lookup raise KeyError, since None
is nil. The value_t typecheck now runs last, so execute(str) picks the
script overload.

test_pycvc_state_exec_sched.py repeats the C++ scheduler tests on both
classes. The parity doc and README are updated.

* Rerun CI on master (the merge push ran while the PR still targeted #653's branch)

* pycvc: environment.frozen (#660), and the set_existing note now that its comment is fixed

* pycvc: state_exec parity part 3 (evaluators, processes, policy, intrinsics)

Wrap the rest of cvc::state_exec's public surface under the C++ names:

- stackless_evaluator and evaluator, with evaluator_state, eval_frame,
  eval_phase (an IntEnum) and evaluation_stats; evaluation_interrupted
  and evaluation_timeout as RuntimeError subclasses. The evaluators
  release the GIL while they evaluate, so another thread can interrupt,
  pause or resume them. on_complete is a Python callable.
- The process struct (shared, as process_ptr), watch_event and
  watch_handler_entry, make_process, and the scheduler calls that take
  them: current_process() and queue_watch_event(). scheduler_base is
  the common base of the two schedulers.
- encode_/decode_environment and encode_/decode_evaluator_state.
- resource_policy (mode as an IntEnum), process_limits, validate_limits.
- intrinsics_context, channel_policy, register_intrinsics, apply_chroot,
  resolve_channel_key, make_future, future_channel_of. Every function
  register_intrinsics adds keeps its context alive, and the context
  keeps the scheduler and channel policy assigned to it.
- From #660: kDefaultMaxAllocBytes, eval_alloc_limit, eval_alloc_check,
  alloc_bytes, scheduler.max_alloc_bytes(), max_alloc_bytes_from_state.

A reference into an object (evaluator_state.stats, evaluator.stats(),
process.state) keeps its owner alive; other members read and write as
copies. evaluator_state is move-only, so it is moved into Python.

test_pycvc_state_exec_eval.py repeats the C++ tests. The parity doc,
whose inventory now includes what landed on master since the audit, and
the README are updated.

* pycvc: state_exec parity part 4 (data jobs, heap, stdlib registry, any-depth values)

- The value conversion walks with an explicit stack instead of recursing, so a value
  nested any depth crosses both ways (the parser's max_depth default is going to
  100000). A list or dict shared within a value converts to one object, both ways:
  sharing survives the trip, a shared structure converts in time proportional to its
  size, and a DSL list that holds itself becomes a Python list that holds itself. A
  Python value that holds itself still raises ValueError.
- The deep-data jobs (#658, #665): data_job, the make_*_job factories,
  run_to_completion, run_data_job (a Python callable as `then`), call_function,
  is_compound, count_data_nodes, kDataNodeBytes. A job is handed to Python owned
  (std::unique_ptr); `who` is kept for good, as C++ holds the pointer.
- The heap (#667): heap_options and its tree settings, measure_heap_share,
  make_heap_share_job, heap_remeasure_bytes, and the per-thread cycle collector;
  the heap fields on process and process_info, evaluator_state.heap_measured,
  stackless_evaluator.global_env(), eval_alloc_note.
- stdlib_registry: standard() (a copy), shared_scope(), register_function (a Python
  callable or a pycvc.value native), list_*, import_module, lookup_qualified (KeyError
  where C++ returns nullptr).
- SWIG_STD_MOVE moves on MSVC too (it reports __cplusplus 199711L without
  /Zc:__cplusplus), so a unique_ptr argument can be passed.

test_pycvc_state_exec_data.py covers the new calls, and test_pycvc_state_exec.py the
any-depth, sharing conversion. The parity doc and README are updated.

* pycvc: wrap #682/#683's call_function continuation, make_generator_job and the native nesting limits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant