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

// Copyright (c) Facebook, Inc. and its affiliates
// SPDX-License-Identifier: MIT OR Apache-2.0

//! This crate provides an experimental parser and analyzer for detailed log files produced by Z3.
//!
//! To obtain a file `z3.log`, pass the options `trace=true` and `proof=true` on the
//! command line of Z3 (for instance, `z3 trace=true proof=true file.smt2`). For large problems, you may
//! choose to limit the size of the log file by interrupting `z3` with `^C` or by setting
//! a shorter timeout. Passing only `trace=true` is also possible but it will prevent any
//! dependency analysis (see below).
//!
//! While parsing the logs, a "model" of the logs is constructed to record most operations, as
//! well as the syntactic terms under each `#NUM` notation:
//!
//! ```
//! # use std::str::FromStr;
//! # use std::collections::BTreeMap;
//! use z3tracer::{Model, syntax::{Ident, Term}};
//! # fn main() -> z3tracer::error::RawResult<()> {
//! let mut model = Model::default();
//! let input = br#"
//! [mk-app] #0 a
//! [mk-app] #1 + #0 #0
//! [eof]
//! "#;
//! model.process(None, &input[1..])?;
//! assert_eq!(model.terms().len(), 2);
//! assert!(matches!(model.term(&Ident::from_str("#1")?)?, Term::App { .. }));
//! assert_eq!(model.id_to_sexp(&BTreeMap::new(), &Ident::from_str("#1").unwrap()).unwrap(), "(+ a a)");
//! # Ok(())
//! # }
//! ```
//!
//! Besides, the library will attempt to reconstruct the following information:
//!
//! * Quantifier Instantiations (QIs), that is, which quantified formulas were instantiated by Z3 and why;
//!
//! * The successive backtracking levels during SMT solving;
//!
//! * SAT/SMT conflicts and their causal dependencies in terms of QIs;
//! ![Conflicts](https://github.com/facebookincubator/smt2utils/blob/master/z3tracer/img/z3_tracer_1.jpg?raw=true)
//!
//! * Causal dependencies between QIs.
//! ![Causal dependencies between QIs](https://github.com/facebookincubator/smt2utils/blob/master/z3tracer/img/z3_tracer_2.jpg?raw=true)
//!
//! A tool `z3tracer` based on the library is provided to process a log file `z3.log` from the
//! command line and generate charts.
//!
//! See also in the
//! [repository](https://github.com/facebookincubator/smt2utils/tree/master/z3tracer/notebooks)
//! for additional examples using Jupyter notebooks.
//!
//! Currently, this library only supports Z3 v4.8.9.
//!
//! More information about Z3 tracing logs can be found in the documentation of the
//! project [Axiom Profiler](https://github.com/viperproject/axiom-profiler).

#![forbid(unsafe_code)]

/// Error management.
pub mod error;
/// Tokenization of Z3 logs.
pub mod lexer;
/// Main analyzer module.
pub mod model;
/// Parsing of Z3 logs.
pub mod parser;
/// Terms and data structures found in Z3 logs.
pub mod syntax;

/// *Experimental* helper functions to generate reports.
#[cfg(feature = "report")]
pub mod report;

pub use error::{Error, Result};
pub use model::{Model, ModelConfig};