smc_scan 0.3.0

Statistical model checker for large concurrent systems.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use anyhow::anyhow;
use clap::Parser;
use scan_core::{Oracle, Scan};

use super::report::Report;

const NO_PROPS_ERR: &str = "missing properties to verify.
Pass a (space-separated) list of one or more properties specified in the model to be verified.
Alternatively, use the flag --all to verify all properties at once.\n
Examples:
'scan PATH/TO/MODEL verify PROPERTY' verifies the property PROPERTY over the model
'scan PATH/TO/MODEL verify PROPERTY_1 PROPERTY_2' verifies the properties PROPERTY_1 and PROPERTY_2 together over the model
'scan PATH/TO/MODEL verify --all' verifies all specified properties together over the model";

const ALL_PROPS_ERR: &str =
    "the --all flag is incompatible with individually-specified properties.\n
Examples:
'scan PATH/TO/MODEL verify PROPERTY' verifies the property PROPERTY over the model
'scan PATH/TO/MODEL verify PROPERTY_1 PROPERTY_2' verifies the properties PROPERTY_1 and PROPERTY_2 together over the model
'scan PATH/TO/MODEL verify --all' verifies all specified properties together over the model";

const BAD_CONFIDENCE: &str =
    "confidence has to be a value strictly greater than 0 and strictly less than 1.\n
Example:
'scan PATH/TO/MODEL verify --confidence 0.98 PROPERTY' verifies the property PROPERTY with confidence 0.98 (i.e., 98%)";

const BAD_PRECISION: &str =
    "precision has to be a value strictly greater than 0 and strictly less than 1.\n
Example:
'scan PATH/TO/MODEL verify --precision 0.005 PROPERTY' verifies the property PROPERTY with precision 0.005 (i.e., 0.5%)";

/// Verify the model
#[derive(Debug, Clone, Parser)]
#[deny(missing_docs)]
pub(crate) struct VerifyArgs {
    /// Space-separated list of properties to verify.
    pub(crate) properties: Vec<String>,
    /// Verify all properties found in the model specification.
    ///
    /// It is equivalent to listing all of the properties.
    #[arg(short, long)]
    pub(crate) all: bool,
    /// Confidence.
    /// It has to be a value between 0 and 1 (bounds excluded).
    #[arg(short, long, default_value_t = 0.95)]
    pub(crate) confidence: f64,
    /// Precision or half-width parameter.
    /// It has to be a value between 0 and 1 (bounds excluded).
    #[arg(short, long, default_value_t = 0.01)]
    pub(crate) precision: f64,
    /// Run the verification on a single thread.
    ///
    /// By default, SCAN uses multi-threading.
    /// Use this flag to run verification on a single thread.
    ///
    /// WARNING: only the verification itself is guaranteed to run single-threaded.
    /// Other related functionalities, including model parsing and building,
    /// updating progress bars, etc.,
    /// might still be running multiple threads.
    #[arg(long)]
    pub(crate) single_thread: bool,
}

impl VerifyArgs {
    pub(crate) fn validate(&self) -> anyhow::Result<()> {
        if self.properties.is_empty() && !self.all {
            Err(anyhow!(NO_PROPS_ERR))
        } else if !self.properties.is_empty() && self.all {
            Err(anyhow!(ALL_PROPS_ERR))
        } else if 0f64 >= self.confidence || self.confidence >= 1f64 {
            Err(anyhow!(BAD_CONFIDENCE))
        } else if 0f64 >= self.precision || self.precision >= 1f64 {
            Err(anyhow!(BAD_PRECISION))
        } else {
            Ok(())
        }
    }

    pub(crate) fn verify<'a, O>(&self, model: String, scan: &'a Scan<O>) -> Report
    where
        O: Oracle + Clone + Sync + 'a,
    {
        let report = if self.single_thread {
            scan.adaptive(self.confidence, self.precision)
        } else {
            scan.par_adaptive(self.confidence, self.precision)
        }
        .expect("verify");
        let successes = report.successes;
        let failures = report.failures;
        let runs = successes + failures;
        let rate = successes as f64 / runs as f64;
        let property_failures = self
            .properties
            .iter()
            .cloned()
            .zip(report.violations.into_iter().chain([0].into_iter().cycle()))
            .collect::<Vec<(String, u32)>>();
        Report {
            model,
            precision: self.precision,
            confidence: self.confidence,
            rate,
            runs,
            successes,
            failures,
            property_failures,
        }
    }
}