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 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
#![allow(dead_code)] #![allow(unused_variables)] #![allow(clippy::unreadable_literal)] #![deny(missing_debug_implementations)] #[macro_use] extern crate log; #[macro_use] extern crate lazy_static; extern crate z3_sys; #[cfg(feature = "arbitrary-size-numeral")] extern crate num; use std::ffi::CString; use std::sync::Mutex; use z3_sys::*; pub use z3_sys::{AstKind, GoalPrec, SortKind}; pub mod ast; mod config; mod context; pub mod datatype_builder; mod func_decl; mod rec_func_decl; mod goal; mod model; mod ops; mod optimize; mod params; mod pattern; mod probe; mod solver; mod sort; mod symbol; mod tactic; // Z3 appears to be only mostly-threadsafe, a few initializers // and such race; so we mutex-guard all access to the library. lazy_static! { static ref Z3_MUTEX: Mutex<()> = Mutex::new(()); } /// Configuration used to initialize [logical contexts]. /// /// [logical contexts]: struct.Context.html #[derive(Debug)] pub struct Config { kvs: Vec<(CString, CString)>, z3_cfg: Z3_config, } /// Manager of all other Z3 objects, global configuration options, etc. /// /// An application may use multiple Z3 contexts. Objects created in one context /// cannot be used in another one. However, several objects may be "translated" from /// one context to another. It is not safe to access Z3 objects from multiple threads. /// /// # Examples: /// /// Creating a context with the default configuration: /// /// ``` /// use z3::{Config, Context}; /// let cfg = Config::new(); /// let ctx = Context::new(&cfg); /// ``` /// /// [`interrupt()`]: #method.interrupt #[derive(PartialEq, Eq, Debug)] pub struct Context { z3_ctx: Z3_context, } /// Handle that can be used to interrupt a computation from another thread. #[derive(PartialEq, Eq, Debug)] pub struct ContextHandle<'ctx> { ctx: &'ctx Context, } /// Symbols are used to name several term and type constructors. #[derive(PartialEq, Eq, Clone, Debug)] pub enum Symbol { Int(u32), String(String), } /// Sorts represent the various 'types' of [`Ast`s](ast/trait.Ast.html). // // Note for in-crate users: Never construct a `Sort` directly; only use // `Sort::new()` which handles Z3 refcounting properly. pub struct Sort<'ctx> { ctx: &'ctx Context, z3_sort: Z3_sort, } /// A struct to represent when two sorts are of different types. #[derive(Debug)] pub struct SortDiffers<'ctx> { left: Sort<'ctx>, right: Sort<'ctx>, } /// A struct to represent when an ast is not a function application. #[derive(Debug)] pub struct IsNotApp { kind: AstKind, } /// (Incremental) solver, possibly specialized by a particular tactic or logic. // // Note for in-crate users: Never construct a `Solver` directly; only use // `Solver::new()` which handles Z3 refcounting properly. pub struct Solver<'ctx> { ctx: &'ctx Context, z3_slv: Z3_solver, } /// Model for the constraints inserted into the logical context. // // Note for in-crate users: Never construct a `Model` directly; only use // `Model::new()` which handles Z3 refcounting properly. pub struct Model<'ctx> { ctx: &'ctx Context, z3_mdl: Z3_model, } /// Context for solving optimization queries. // // Note for in-crate users: Never construct an `Optimize` directly; only use // `Optimize::new()` which handles Z3 refcounting properly. pub struct Optimize<'ctx> { ctx: &'ctx Context, z3_opt: Z3_optimize, } /// Function declaration. Every constant and function have an associated declaration. /// /// The declaration assigns a name, a sort (i.e., type), and for function /// the sort (i.e., type) of each of its arguments. Note that, in Z3, /// a constant is a function with 0 arguments. /// /// # See also: /// /// - [`RecFuncDecl`](struct.RecFuncDecl.html) // // Note for in-crate users: Never construct a `FuncDecl` directly; only use // `FuncDecl::new()` which handles Z3 refcounting properly. pub struct FuncDecl<'ctx> { ctx: &'ctx Context, z3_func_decl: Z3_func_decl, } /// Recursive function declaration. Every function has an associated declaration. /// /// The declaration assigns a name, a return sort (i.e., type), and /// the sort (i.e., type) of each of its arguments. This is the function declaration type /// you should use if you want to add a definition to your function, recursive or not. /// /// # See also: /// /// - [`FuncDecl::add_def`](struct.RecFuncDecl.html#method.add_def) // Note for in-crate users: Never construct a `FuncDecl` directly; only use // `FuncDecl::new()` which handles Z3 refcounting properly. pub struct RecFuncDecl<'ctx> { ctx: &'ctx Context, z3_func_decl: Z3_func_decl, } pub use z3_sys::DeclKind; /// Build a custom [datatype sort](struct.DatatypeSort.html). /// /// Example: /// ``` /// # use z3::{ast::Int, Config, Context, DatatypeAccessor, DatatypeBuilder, SatResult, Solver, Sort, ast::{Ast, Datatype}}; /// # let cfg = Config::new(); /// # let ctx = Context::new(&cfg); /// # let solver = Solver::new(&ctx); /// // Like Rust's Option<int> type /// let option_int = DatatypeBuilder::new(&ctx, "OptionInt") /// .variant("None", vec![]) /// .variant( /// "Some", /// vec![("value", DatatypeAccessor::Sort(Sort::int(&ctx)))], /// ) /// .finish(); /// /// // Assert x.is_none() /// let x = Datatype::new_const(&ctx, "x", &option_int.sort); /// solver.assert(&option_int.variants[0].tester.apply(&[&x]).as_bool().unwrap()); /// /// // Assert y == Some(3) /// let y = Datatype::new_const(&ctx, "y", &option_int.sort); /// let value = option_int.variants[1].constructor.apply(&[&Int::from_i64(&ctx, 3)]); /// solver.assert(&y._eq(&value.as_datatype().unwrap())); /// /// assert_eq!(solver.check(), SatResult::Sat); /// let model = solver.get_model().unwrap();; /// /// // Get the value out of Some(3) /// let ast = option_int.variants[1].accessors[0].apply(&[&y]); /// assert_eq!(3, model.eval(&ast.as_int().unwrap(), true).unwrap().as_i64().unwrap()); /// ``` #[derive(Debug)] pub struct DatatypeBuilder<'ctx> { ctx: &'ctx Context, name: Symbol, constructors: Vec<(String, Vec<(String, DatatypeAccessor<'ctx>)>)>, } /// Wrapper which can point to a sort (by value) or to a custom datatype (by name). #[derive(Debug)] pub enum DatatypeAccessor<'ctx> { Sort(Sort<'ctx>), Datatype(Symbol), } /// Inner variant for a custom [datatype sort](struct.DatatypeSort.html). #[derive(Debug)] pub struct DatatypeVariant<'ctx> { pub constructor: FuncDecl<'ctx>, pub tester: FuncDecl<'ctx>, pub accessors: Vec<FuncDecl<'ctx>>, } /// A custom datatype sort. #[derive(Debug)] pub struct DatatypeSort<'ctx> { ctx: &'ctx Context, pub sort: Sort<'ctx>, pub variants: Vec<DatatypeVariant<'ctx>>, } /// Parameter set used to configure many components (simplifiers, tactics, solvers, etc). pub struct Params<'ctx> { ctx: &'ctx Context, z3_params: Z3_params, } /// Result of a satisfiability query. #[derive(Copy, Clone, Debug, PartialEq, Eq)] pub enum SatResult { /// The query is unsatisfiable. Unsat, /// The query was interrupted, timed out or otherwise failed. Unknown, /// The query is satisfiable. Sat, } /// A pattern for quantifier instantiation, used to guide quantifier instantiation. pub struct Pattern<'ctx> { ctx: &'ctx Context, z3_pattern: Z3_pattern, } /// Collection of subgoals resulting from applying of a tactic to a goal. #[derive(Clone, Debug)] pub struct ApplyResult<'ctx> { ctx: &'ctx Context, z3_apply_result: Z3_apply_result, } /// Basic building block for creating custom solvers for specific problem domains. pub struct Tactic<'ctx> { ctx: &'ctx Context, z3_tactic: Z3_tactic, } /// Set of formulas that can be solved and/or transformed using tactics and solvers. pub struct Goal<'ctx> { ctx: &'ctx Context, z3_goal: Z3_goal, } /// Function/predicate used to inspect a goal and collect information /// that may be used to decide which solver and/or preprocessing step /// will be used. pub struct Probe<'ctx> { ctx: &'ctx Context, z3_probe: Z3_probe, }