CBMC
Loading...
Searching...
No Matches
bmc_util.h
Go to the documentation of this file.
1/*******************************************************************\
2
3Module: Bounded Model Checking Utilities
4
5Author: Daniel Kroening, Peter Schrammel
6
7\*******************************************************************/
8
11
12#ifndef CPROVER_GOTO_CHECKER_BMC_UTIL_H
13#define CPROVER_GOTO_CHECKER_BMC_UTIL_H
14
16
18
20#include "properties.h"
21
22#include <chrono> // IWYU pragma: keep
23#include <memory>
24
27class goto_tracet;
30class namespacet;
31class optionst;
32class symex_bmct;
34struct trace_optionst;
36
38 symex_target_equationt &equation,
39 decision_proceduret &decision_procedure,
41
46
49
52 const namespacet &,
54 const decision_proceduret &,
56
58 const goto_tracet &,
59 const namespacet &,
60 const trace_optionst &,
62
63void output_graphml(const goto_tracet &, const namespacet &, const optionst &);
66 const namespacet &,
67 const optionst &);
68
69std::unique_ptr<memory_model_baset>
70get_memory_model(const optionst &options, const namespacet &);
71
73
74void slice(
75 symex_bmct &,
77 const namespacet &,
78 const optionst &,
80
86 symex_bmct &symex,
87 symex_target_equationt &equation,
88 const optionst &options,
89 const namespacet &ns,
90 ui_message_handlert &ui_message_handler);
91
100 const std::string &cov_out,
101 const abstract_goto_modelt &goto_model,
102 const symex_bmct &symex,
103 ui_message_handlert &ui_message_handler);
104
112 propertiest &properties,
113 std::unordered_set<irep_idt> &updated_properties,
114 const symex_target_equationt &equation);
115
123 propertiest &properties,
124 std::unordered_set<irep_idt> &updated_properties);
125
133 propertiest &properties,
134 std::unordered_set<irep_idt> &updated_properties);
135
145std::chrono::duration<double> prepare_property_decider(
146 propertiest &properties,
147 symex_target_equationt &equation,
148 goto_symex_property_decidert &property_decider,
149 ui_message_handlert &ui_message_handler);
150
163 propertiest &properties,
164 goto_symex_property_decidert &property_decider,
165 ui_message_handlert &ui_message_handler,
166 std::chrono::duration<double> solver_runtime,
167 bool set_pass = true);
168
169#define OPT_BMC \
170 "(program-only)" \
171 "(show-byte-ops)" \
172 "(show-vcc)" \
173 "(show-goto-symex-steps)" \
174 "(show-points-to-sets)" \
175 "(slice-formula)" \
176 "(unwinding-assertions)" \
177 "(no-unwinding-assertions)" \
178 "(no-self-loops-to-assumptions)" \
179 "(partial-loops)" \
180 "(paths):" \
181 "(show-symex-strategies)" \
182 "(depth):" \
183 "(max-field-sensitivity-array-size):" \
184 "(no-array-field-sensitivity)" \
185 "(graphml-witness):" \
186 "(symex-complexity-limit):" \
187 "(symex-complexity-failed-child-loops-limit):" \
188 "(incremental-loop):" \
189 "(unwind-min):" \
190 "(unwind-max):" \
191 "(ignore-properties-before-unwind-min)" \
192 "(symex-cache-dereferences)" OPT_UNWINDSET
193
194#define HELP_BMC \
195 " {y--paths} [strategy] \t explore paths one at a time\n" \
196 " {y--show-symex-strategies} \t list strategies for use with {y--paths}\n" \
197 " {y--show-goto-symex-steps} \t show which steps symex travels, includes " \
198 "diagnostic information\n" \
199 " {y--show-points-to-sets} \t show points-to sets for pointer dereference. " \
200 "Requires {y--json-ui}.\n" \
201 " {y--program-only} \t only show program expression\n" \
202 " {y--show-byte-ops} \t show all byte extracts and updates\n" \
203 " {y--depth} {unr} \t limit search depth\n" \
204 " {y--max-field-sensitivity-array-size} {uM} \t " \
205 "maximum size {uM} of arrays for which field sensitivity will be " \
206 "applied to array, the default is 64\n" \
207 " {y--no-array-field-sensitivity} \t " \
208 "deactivate field sensitivity for arrays, this is equivalent to setting " \
209 "the maximum field sensitivity size for arrays to 0\n" HELP_UNWINDSET \
210 " {y--incremental-loop} {uL} \t " \
211 "check properties after each unwinding of loop {uL} (use {y--show-loops} " \
212 "to get the loop IDs)\n" \
213 " {y--unwind-min} {unr} \t " \
214 "start incremental-loop after {unr} unwindings but before solving that " \
215 "iteration. If for example it is 1, then the loop will be unwound once, " \
216 "and immediately checked. Note: this means for {y--unwind-min} 1 or 0 all " \
217 "properties are checked.\n" \
218 " {y--unwind-max} {unr} \t stop incremental-loop after {unr} unwindings\n" \
219 " {y--ignore-properties-before-unwind-min} \t " \
220 "do not check properties before unwind-min when using " \
221 "{y--incremental-loop}\n" \
222 " {y--show-vcc} \t show the verification conditions\n" \
223 " {y--slice-formula} \t remove assignments unrelated to property\n" \
224 " {y--unwinding-assertions} \t generate unwinding assertions (cannot be " \
225 "used with {y--cover})\n" \
226 " {y--partial-loops} \t permit paths with partial loops\n" \
227 " {y--no-self-loops-to-assumptions} \t do not simplify while(1){ {}} to " \
228 "assume(0)\n" \
229 " {y--symex-complexity-limit} {uN} \t " \
230 "how complex ({uN}) a path can become before symex abandons it. Currently " \
231 "uses guard size to calculate complexity.\n" \
232 " {y--symex-complexity-failed-child-loops-limit} {uN} \t " \
233 "how many child branches ({uN}) in an iteration are allowed to fail due to " \
234 "complexity violations before the loop gets blacklisted\n" \
235 " {y--graphml-witness} {ufilename} \t write the witness in GraphML format " \
236 "to {ufilename}\n" \
237 " {y--symex-cache-dereferences} \t enable caching of repeated " \
238 "dereferences\n"
239
240#endif // CPROVER_GOTO_CHECKER_BMC_UTIL_H
void run_property_decider(incremental_goto_checkert::resultt &result, propertiest &properties, goto_symex_property_decidert &property_decider, ui_message_handlert &ui_message_handler, std::chrono::duration< double > solver_runtime, bool set_pass=true)
Runs the property decider to solve the equation.
Definition bmc_util.cpp:377
void slice(symex_bmct &, symex_target_equationt &symex_target_equation, const namespacet &, const optionst &, ui_message_handlert &)
Definition bmc_util.cpp:193
void output_coverage_report(const std::string &cov_out, const abstract_goto_modelt &goto_model, const symex_bmct &symex, ui_message_handlert &ui_message_handler)
Output a coverage report as generated by symex_coveraget if cov_out is non-empty.
Definition bmc_util.cpp:301
void setup_symex(symex_bmct &, const namespacet &, ui_message_handlert &)
Definition bmc_util.cpp:178
std::chrono::duration< double > prepare_property_decider(propertiest &properties, symex_target_equationt &equation, goto_symex_property_decidert &property_decider, ui_message_handlert &ui_message_handler)
Converts the equation and sets up the property decider, but does not call solve.
Definition bmc_util.cpp:353
void update_status_of_unknown_properties(propertiest &properties, std::unordered_set< irep_idt > &updated_properties)
Sets the property status of UNKNOWN properties to PASS.
Definition bmc_util.cpp:285
void output_graphml(const goto_tracet &, const namespacet &, const optionst &)
outputs an error witness in graphml format
Definition bmc_util.cpp:107
void update_properties_status_from_symex_target_equation(propertiest &properties, std::unordered_set< irep_idt > &updated_properties, const symex_target_equationt &equation)
Sets property status to PASS for properties whose conditions are constant true in the equation.
Definition bmc_util.cpp:233
void output_error_trace(const goto_tracet &, const namespacet &, const trace_optionst &, ui_message_handlert &)
Definition bmc_util.cpp:64
void message_building_error_trace(messaget &)
Outputs a message that an error trace is being built.
Definition bmc_util.cpp:35
void update_status_of_not_checked_properties(propertiest &properties, std::unordered_set< irep_idt > &updated_properties)
Sets the property status of NOT_CHECKED properties to PASS.
Definition bmc_util.cpp:269
ssa_step_predicatet ssa_step_matches_failing_property(const irep_idt &property_id)
Returns a function that checks whether an SSA step is an assertion with property_id.
Definition bmc_util.cpp:54
std::unique_ptr< memory_model_baset > get_memory_model(const optionst &options, const namespacet &)
Definition bmc_util.cpp:162
void convert_symex_target_equation(symex_target_equationt &equation, decision_proceduret &decision_procedure, message_handlert &message_handler)
Definition bmc_util.cpp:150
void postprocess_equation(symex_bmct &symex, symex_target_equationt &equation, const optionst &options, const namespacet &ns, ui_message_handlert &ui_message_handler)
Post process the equation.
Definition bmc_util.cpp:317
void build_error_trace(goto_tracet &, const namespacet &, const symex_target_equationt &, const decision_proceduret &, ui_message_handlert &)
Definition bmc_util.cpp:40
Traces of GOTO Programs.
std::function< bool(symex_target_equationt::SSA_stepst::const_iterator, const decision_proceduret &)> ssa_step_predicatet
Abstract interface to eager or lazy GOTO models.
ait supplies three of the four components needed: an abstract interpreter (in this case handling func...
Definition ai.h:562
An interface for a decision procedure for satisfiability problems.
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition dstring.h:38
Provides management of goal variables that encode properties.
Trace of a GOTO program.
Definition goto_trace.h:177
Class that provides messages with a built-in verbosity 'level'.
Definition message.h:154
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition namespace.h:91
Inheriting the interface of symex_targett this class represents the SSA form of the input program as ...
message_handlert * message_handler
Definition ui_message.h:49
Incremental Goto Checker Interface.
Properties.
std::map< irep_idt, property_infot > propertiest
A map of property IDs to property infos.
Definition properties.h:76
Options for printing the trace using show_goto_trace.
Definition goto_trace.h:221
Loop unwinding.