Skip to main content

CheckRequest

Struct CheckRequest 

Source
pub struct CheckRequest {
Show 34 fields pub distributed: Option<DistributedOptions>, pub debugger: Option<Arc<dyn Observer>>, pub source_coverage: bool, pub tlc_coverage: bool, pub host_access: HostAccess, pub seen_disk: Option<SeenOptions>, pub frontier_memory_bytes: Option<usize>, pub frontier_directory: Option<PathBuf>, pub candidate_memory_bytes: Option<usize>, pub candidate_directory: Option<PathBuf>, pub store_compact_bytes: Option<usize>, pub predecessor_memory_bytes: Option<usize>, pub predecessor_directory: Option<PathBuf>, pub file: PathBuf, pub config: Option<PathBuf>, pub library_paths: Vec<PathBuf>, pub module_paths: Vec<PathBuf>, pub compat_tlc: bool, pub symmetry_liveness: Option<SymmetryLiveness>, pub action_composition: Option<ActionComposition>, pub store: Store, pub seed: Option<i64>, pub core_sample: Option<usize>, pub fp: Option<usize>, pub workers: Option<usize>, pub no_deadlock: bool, pub sequential: bool, pub chaos: Option<u64>, pub temporal: TemporalMode, pub periodic: PeriodicSchedule, pub time_limit: BudgetSetting<Duration>, pub max_memory: BudgetSetting<u64>, pub max_states: Option<u64>, pub max_depth: Option<u64>, /* private fields */
}
Expand description

What to check and how.

Fields§

§distributed: Option<DistributedOptions>

Opt-in authenticated native pure-safety workers. None is TLC-equivalent. Requires explicit Core, seed and fingerprint; secret bytes never enter reports.

use dive_api::{CheckRequest, DistributedOptions, check_file};
let request = CheckRequest {
    file: "Counter.tla".into(), seed: Some(0), fp: Some(0),
    distributed: Some(DistributedOptions::new(
        vec!["127.0.0.1:7801".parse()?, "127.0.0.1:7802".parse()?],
        "worker.key".into(),
    )),
    ..CheckRequest::default()
};
let report = check_file(&request)?;
println!("{}", report.to_json());
§debugger: Option<Arc<dyn Observer>>

Explicit producer-only Core debugger capability. None is the ordinary TLC-equivalent setting; use debug::Session for a managed session.

§source_coverage: bool

--source-coverage: native source-expression work. Core does not implement it, so true is a named refusal.

§tlc_coverage: bool

--coverage 0: TLC’s logical action-context costs. Core does not implement them, so true is a named refusal.

§host_access: HostAccess

Explicit spec host categories, default-empty in both profiles: a specification gets host access only when it is granted. The first slice supports source-binding environment and TXT/UTF-8 reads.

§seen_disk: Option<SeenOptions>

Explicit bounded transient disk seen-state route. None keeps the memory reference; disk uses reported inline fallback and is not a total-RAM budget.

§frontier_memory_bytes: Option<usize>

Opt-in encoded frontier budget per current/next queue, in bytes. This does not bound seen sets, candidates, traces, graphs or process memory.

§frontier_directory: Option<PathBuf>

Parent directory for private transient frontier spill files. Requires Self::frontier_memory_bytes; a directory alone is rejected.

§candidate_memory_bytes: Option<usize>

Encoded candidate bytes per worker for explicit Core pure safety BFS. Zero forces disk. This excludes active evaluator roots, codec scratch, accepted Store values and whole-process memory.

§candidate_directory: Option<PathBuf>

Parent directory for private candidate files; requires a candidate budget.

§store_compact_bytes: Option<usize>

Opt-in completed-level measured Store-byte trigger under pure Core safety. Zero forces every boundary. This is not a live-root or process-memory cap. The TLC-equivalent setting is None. Recovery-only is supported.

§predecessor_memory_bytes: Option<usize>

Separate retained predecessor-record capacity budget for safety BFS. Zero spills immediately; omitted preserves the in-memory counterpart. Reconstruction buffers and all other search storage are outside it.

§predecessor_directory: Option<PathBuf>

Parent of private transient log directories. Requires a budget; omitted uses the system temporary directory. Files are removed before certification.

§file: PathBuf

The root module file.

§config: Option<PathBuf>

The configuration; <file stem>.cfg beside it by default, as in TLC.

§library_paths: Vec<PathBuf>

Module directories searched before the standard modules.

§module_paths: Vec<PathBuf>

Module directories searched after the standard modules.

§compat_tlc: bool

--compat=tlc.

§symmetry_liveness: Option<SymmetryLiveness>

Whole-run symmetry/liveness policy; profile default when omitted. TLC-equivalent: Tlc, currently refused for quotient temporal checking.

§action_composition: Option<ActionComposition>

--action-composition off|tlc|tla; None is the profile’s setting: tla by default, off under --compat=tlc (TLC without -Dtlc2.tool.impl.Tool.cdot=true).

§store: Store

The store.

§seed: Option<i64>

--seed; a fresh seed otherwise (always reported).

§core_sample: Option<usize>

--core-sample N (--engine core): after the search, compare the successors of N sampled expanded states with the dive-eval evaluator’s. Diagnostic only: every result is unchanged. None samples nothing.

§fp: Option<usize>

--fp; TLC picks one at random under --compat=tlc, dive uses 0.

§workers: Option<usize>

--workers; None is the profile’s default (TLC’s 1 under --compat=tlc, the available parallelism otherwise).

§no_deadlock: bool

TLC’s -deadlock: do not check for deadlock.

§sequential: bool

--sequential: every level inline with one logical worker, as sequential mode does. Results are identical.

§chaos: Option<u64>

Test-only chaos scheduling (--chaos SEED, or DIVE_CHAOS); see dive_runtime::CheckOptions::chaos. Results must be identical.

§temporal: TemporalMode

Temporal checking strategy. Ordinary selects final analysis for eligible TLC-profile temporal roles and deterministic completed-level checks for eligible dive-profile roles. Unsupported combinations retain named refusals.

§periodic: PeriodicSchedule

Completed-level schedule for ordinary dive-profile temporal checking (TLC checks only at the end). The default is the documented PeriodicSchedule::DEFAULT; TLC-profile and explicit final requests ignore it and check once at the end.

§time_limit: BudgetSetting<Duration>

--time-limit: wall-clock time for the whole check.

§max_memory: BudgetSetting<u64>

--max-memory: the whole process’s resident-memory ceiling, in bytes.

§max_states: Option<u64>

Maximum admitted distinct in-model identities; None is TLC-equivalent.

§max_depth: Option<u64>

Maximum BFS discovery depth (Init is depth one); None is TLC-equivalent.

Trait Implementations§

Source§

impl Clone for CheckRequest

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CheckRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CheckRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.