cprover
cover_instrument_other.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Coverage Instrumentation
4 
5 Author: Daniel Kroening
6 
7 \*******************************************************************/
8 
11 
12 #include "cover_instrument.h"
13 
14 #include <langapi/language_util.h>
15 
16 #include "cover_util.h"
17 
19  const irep_idt &,
20  goto_programt &,
22  const cover_blocks_baset &,
23  const assertion_factoryt &) const
24 {
25  if(is_non_cover_assertion(i_it))
26  i_it->turn_into_skip();
27 
28  // TODO: implement
29 }
30 
32  const irep_idt &function_id,
33  goto_programt &,
35  const cover_blocks_baset &,
36  const assertion_factoryt &) const
37 {
38  // turn into 'assert(false)' to avoid simplification
39  if(is_non_cover_assertion(i_it))
40  {
41  i_it->guard = false_exprt();
43  i_it, id2string(i_it->source_location.get_comment()), function_id);
44  }
45 }
46 
48  const irep_idt &function_id,
49  goto_programt &,
51  const cover_blocks_baset &,
52  const assertion_factoryt &make_assertion) const
53 {
54  // turn __CPROVER_cover(x) into 'assert(!x)'
55  if(i_it->is_function_call())
56  {
57  const code_function_callt &code_function_call =
58  to_code_function_call(i_it->code);
59  if(
60  code_function_call.function().id() == ID_symbol &&
61  to_symbol_expr(code_function_call.function()).get_identifier() ==
62  CPROVER_PREFIX "cover" &&
63  code_function_call.arguments().size() == 1)
64  {
65  const exprt c = code_function_call.arguments()[0];
66  *i_it = make_assertion(not_exprt(c), i_it->source_location);
67  std::string comment = "condition '" + from_expr(ns, function_id, c) + "'";
68  initialize_source_location(i_it, comment, function_id);
69  }
70  }
71  else if(is_non_cover_assertion(i_it))
72  i_it->turn_into_skip();
73 }
74 
76  const irep_idt &function_id,
77  goto_programt &goto_program,
79 {
80  const auto last_function_call = std::find_if(
81  goto_program.instructions.rbegin(),
82  goto_program.instructions.rend(),
83  [](const goto_programt::instructiont &instruction) {
84  return instruction.is_function_call();
85  });
86  INVARIANT(
87  last_function_call != goto_program.instructions.rend(),
88  "Goto program should have at least one function call");
89  INVARIANT(
90  last_function_call != goto_program.instructions.rbegin(),
91  "Goto program shouldn't end with a function call");
92  const auto if_it = last_function_call.base();
93  const auto location = if_it->source_location;
94  const std::string &comment =
95  "additional goal to ensure reachability of end of function";
96  goto_program.insert_before_swap(if_it);
97  *if_it = make_assertion(false_exprt(), location);
98  if_it->source_location.set_comment(comment);
99  if_it->source_location.set_property_class("reachability_constraint");
100  if_it->source_location.set_function(function_id);
101 }
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
cover_instrumenter_baset::is_non_cover_assertion
bool is_non_cover_assertion(goto_programt::const_targett t) const
Definition: cover_instrument.h:93
cover_instrumenter_baset::initialize_source_location
void initialize_source_location(goto_programt::targett t, const std::string &comment, const irep_idt &function_id) const
Definition: cover_instrument.h:82
cover_instrument_end_of_function
void cover_instrument_end_of_function(const irep_idt &function_id, goto_programt &goto_program, const cover_instrumenter_baset::assertion_factoryt &make_assertion)
Definition: cover_instrument_other.cpp:75
cover_instrumenter_baset::ns
const namespacet ns
Definition: cover_instrument.h:71
exprt
Base class for all expressions.
Definition: expr.h:53
code_function_callt
codet representation of a function call statement.
Definition: std_code.h:1183
cover_cover_instrumentert::instrument
void instrument(const irep_idt &function_id, goto_programt &, goto_programt::targett &, const cover_blocks_baset &, const assertion_factoryt &) const override
Override this method to implement an instrumenter.
Definition: cover_instrument_other.cpp:47
id2string
const std::string & id2string(const irep_idt &d)
Definition: irep.h:44
language_util.h
cover_assertion_instrumentert::instrument
void instrument(const irep_idt &function_id, goto_programt &, goto_programt::targett &, const cover_blocks_baset &, const assertion_factoryt &) const override
Override this method to implement an instrumenter.
Definition: cover_instrument_other.cpp:31
cover_instrument.h
Coverage Instrumentation.
symbol_exprt::get_identifier
const irep_idt & get_identifier() const
Definition: std_expr.h:111
cover_blocks_baset
Definition: cover_basic_blocks.h:24
to_symbol_expr
const symbol_exprt & to_symbol_expr(const exprt &expr)
Cast an exprt to a symbol_exprt.
Definition: std_expr.h:177
irept::id
const irep_idt & id() const
Definition: irep.h:418
to_code_function_call
const code_function_callt & to_code_function_call(const codet &code)
Definition: std_code.h:1294
false_exprt
The Boolean constant false.
Definition: std_expr.h:3964
code_function_callt::arguments
argumentst & arguments()
Definition: std_code.h:1228
cover_instrumenter_baset::assertion_factoryt
std::function< goto_programt::instructiont(const exprt &, const source_locationt &)> assertion_factoryt
The type of function used to make goto_program assertions.
Definition: cover_instrument.h:41
goto_programt::instructions
instructionst instructions
The list of instructions in the goto program.
Definition: goto_program.h:585
CPROVER_PREFIX
#define CPROVER_PREFIX
Definition: cprover_prefix.h:14
goto_programt
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:73
cover_path_instrumentert::instrument
void instrument(const irep_idt &function_id, goto_programt &, goto_programt::targett &, const cover_blocks_baset &, const assertion_factoryt &) const override
Override this method to implement an instrumenter.
Definition: cover_instrument_other.cpp:18
INVARIANT
#define INVARIANT(CONDITION, REASON)
This macro uses the wrapper function 'invariant_violated_string'.
Definition: invariant.h:424
goto_programt::insert_before_swap
void insert_before_swap(targett target)
Insertion that preserves jumps to "target".
Definition: goto_program.h:606
cover_util.h
Coverage Instrumentation Utilities.
comment
static std::string comment(const rw_set_baset::entryt &entry, bool write)
Definition: race_check.cpp:109
goto_programt::instructiont
This class represents an instruction in the GOTO intermediate representation.
Definition: goto_program.h:179
exprt::source_location
const source_locationt & source_location() const
Definition: expr.h:254
from_expr
std::string from_expr(const namespacet &ns, const irep_idt &identifier, const exprt &expr)
Definition: language_util.cpp:20
goto_programt::targett
instructionst::iterator targett
Definition: goto_program.h:579
code_function_callt::function
exprt & function()
Definition: std_code.h:1218
not_exprt
Boolean negation.
Definition: std_expr.h:2843