aquavm/crates/air-lib/trace-handler
Ivan Boldyrev 6df2b9d084
Introduce TracePos type for trace positions (#273)
Many internal structures refer to trace positions; this is an important type of values. In the code, it is sometimes `u32`, sometimes `usize`. While such variables usually have "_pos" suffix, having a dedicated type does improve code with type guarantees.
2022-06-10 12:29:56 +07:00
..
src Introduce TracePos type for trace positions (#273) 2022-06-10 12:29:56 +07:00
.rustfmt.toml Decouple log targets to a separate crate (#152) 2021-10-05 16:55:04 +03:00
Cargo.toml Update crate info; housekeeping (#153) 2021-10-05 20:08:10 +03:00
README.md Rename subtree to subgraph (#265) 2022-05-17 15:53:33 +03:00

AIR trace handler

This crate contains implementation of the CRDT-based merging data algorithm. It exposes the TraceHandler struct that based on the visitor pattern and has public methods that should be called in certain places of AIR instructions execution. Internally TraceHandler contains several FSM and each of such public methods does state transitioning of one or more these FSMs. Below are state transition sequences for all instructions that caller must follow.

Ap instruction

Expected sequence of TraceHandler calls for the ap instruction:

meet_ap_start
    -> meet_ap_end

Call instruction

Expected sequence of TraceHandler calls for the call instruction:

meet_call_start
    -> meet_call_end

Par instruction

Expected sequence of TraceHandler calls for the par instruction:

meet_par_start
    -> meet_par_subgraph_end(..., SubgraphType::Left)
    -> meet_par_subgraph_end(..., SubgraphType::Right)

Fold instruction

Expected sequence of TraceHandler calls for the fold instruction:

meet_fold_start.1 ->
    meet_generation_start.N ->
        meet_next.M ->
        meet_prev.M ->
    meet_generation_end.N ->
meet_fold_end.1

where .T means that this function should be called exactly T times.