cprover
cover_basic_blocks.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Coverage Instrumentation
4 
5 Author: Daniel Kroening
6 
7 \*******************************************************************/
8 
11 
12 #ifndef CPROVER_GOTO_INSTRUMENT_COVER_BASIC_BLOCKS_H
13 #define CPROVER_GOTO_INSTRUMENT_COVER_BASIC_BLOCKS_H
14 
15 #include <unordered_set>
16 
17 #include <util/message.h>
18 
20 
21 #include "source_lines.h"
22 
24 {
25 public:
26  virtual ~cover_blocks_baset() = default;
29  // part of
30  virtual std::size_t block_of(goto_programt::const_targett t) const = 0;
31 
36  instruction_of(std::size_t block_nr) const = 0;
37 
41  virtual const source_locationt &
42  source_location_of(std::size_t block_nr) const = 0;
43 
45  virtual void output(std::ostream &out) const = 0;
46 
51  virtual void report_block_anomalies(
52  const irep_idt &function_id,
53  const goto_programt &goto_program,
54  message_handlert &message_handler)
55  {
56  // unused parameters
57  (void)function_id;
58  (void)goto_program;
59  (void)message_handler;
60  }
61 };
62 
64 {
65 public:
66  explicit cover_basic_blockst(const goto_programt &_goto_program);
67 
71  std::size_t block_of(goto_programt::const_targett t) const override;
72 
77  instruction_of(std::size_t block_nr) const override;
78 
82  const source_locationt &
83  source_location_of(std::size_t block_nr) const override;
84 
90  const irep_idt &function_id,
91  const goto_programt &goto_program,
92  message_handlert &message_handler) override;
93 
95  void output(std::ostream &out) const override;
96 
97 private:
98  typedef std::map<goto_programt::const_targett, std::size_t> block_mapt;
99 
100  struct block_infot
101  {
104 
109 
111  std::unordered_set<std::size_t> lines;
112 
115  };
116 
120  std::vector<block_infot> block_infos;
121 
124  static void update_covered_lines(block_infot &block_info);
125 
128  static void update_source_lines(block_infot &block_info);
129 
133  const goto_programt::const_targett &instruction,
135 };
136 
138 {
139 private:
140  // map block number to first instruction of the block
141  std::vector<goto_programt::const_targett> block_infos;
142  // map block number to its location
143  std::vector<source_locationt> block_locations;
144  // map java indexes to block indexes
145  std::unordered_map<irep_idt, std::size_t> index_to_block;
146  // map block number to its source lines
147  std::vector<source_linest> block_source_lines;
148 
149 public:
150  explicit cover_basic_blocks_javat(const goto_programt &_goto_program);
151 
154  std::size_t block_of(goto_programt::const_targett t) const override;
155 
159  instruction_of(std::size_t block_number) const override;
160 
163  const source_locationt &
164  source_location_of(std::size_t block_number) const override;
165 
167  void output(std::ostream &out) const override;
168 };
169 
170 #endif // CPROVER_GOTO_INSTRUMENT_COVER_BASIC_BLOCKS_H
cover_basic_blockst::instruction_of
optionalt< goto_programt::const_targett > instruction_of(std::size_t block_nr) const override
Definition: cover_basic_blocks.cpp:104
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
cover_basic_blocks_javat::index_to_block
std::unordered_map< irep_idt, std::size_t > index_to_block
Definition: cover_basic_blocks.h:145
cover_blocks_baset::source_location_of
virtual const source_locationt & source_location_of(std::size_t block_nr) const =0
cover_basic_blocks_javat::cover_basic_blocks_javat
cover_basic_blocks_javat(const goto_programt &_goto_program)
Definition: cover_basic_blocks.cpp:182
cover_basic_blockst::block_infot::source_location
source_locationt source_location
the source location representative for this block (we need a separate copy of source locations becaus...
Definition: cover_basic_blocks.h:108
cover_blocks_baset::output
virtual void output(std::ostream &out) const =0
Outputs the list of blocks.
cover_basic_blocks_javat::block_source_lines
std::vector< source_linest > block_source_lines
Definition: cover_basic_blocks.h:147
goto_model.h
Symbol Table + CFG.
cover_basic_blockst::report_block_anomalies
void report_block_anomalies(const irep_idt &function_id, const goto_programt &goto_program, message_handlert &message_handler) override
Output warnings about ignored blocks.
Definition: cover_basic_blocks.cpp:117
cover_basic_blockst::cover_basic_blockst
cover_basic_blockst(const goto_programt &_goto_program)
Definition: cover_basic_blocks.cpp:32
cover_basic_blockst::block_infot::source_lines
source_linest source_lines
the set of source code lines belonging to this block
Definition: cover_basic_blocks.h:114
cover_basic_blockst::block_of
std::size_t block_of(goto_programt::const_targett t) const override
Definition: cover_basic_blocks.cpp:96
source_linest
Definition: source_lines.h:30
cover_basic_blocks_javat
Definition: cover_basic_blocks.h:138
cover_basic_blockst::block_map
block_mapt block_map
map program locations to block numbers
Definition: cover_basic_blocks.h:118
cover_basic_blockst::continuation_of_block
static optionalt< std::size_t > continuation_of_block(const goto_programt::const_targett &instruction, block_mapt &block_map)
If this block is a continuation of a previous block through unconditional forward gotos,...
Definition: cover_basic_blocks.cpp:18
cover_basic_blockst::block_infos
std::vector< block_infot > block_infos
map block numbers to block information
Definition: cover_basic_blocks.h:120
source_lines.h
Set of source code lines contributing to a basic block.
cover_blocks_baset::instruction_of
virtual optionalt< goto_programt::const_targett > instruction_of(std::size_t block_nr) const =0
cover_basic_blockst::source_location_of
const source_locationt & source_location_of(std::size_t block_nr) const override
Definition: cover_basic_blocks.cpp:111
cover_blocks_baset
Definition: cover_basic_blocks.h:24
cover_basic_blocks_javat::block_of
std::size_t block_of(goto_programt::const_targett t) const override
Definition: cover_basic_blocks.cpp:215
cover_basic_blockst::update_source_lines
static void update_source_lines(block_infot &block_info)
create a string representing source lines and set as a property of source location of basic block
Definition: cover_basic_blocks.cpp:171
cover_basic_blocks_javat::block_locations
std::vector< source_locationt > block_locations
Definition: cover_basic_blocks.h:143
message_handlert
Definition: message.h:28
cover_basic_blocks_javat::block_infos
std::vector< goto_programt::const_targett > block_infos
Definition: cover_basic_blocks.h:141
cover_blocks_baset::report_block_anomalies
virtual void report_block_anomalies(const irep_idt &function_id, const goto_programt &goto_program, message_handlert &message_handler)
Output warnings about ignored blocks.
Definition: cover_basic_blocks.h:51
optionalt
nonstd::optional< T > optionalt
Definition: optional.h:35
source_locationt
Definition: source_location.h:20
cover_basic_blocks_javat::source_location_of
const source_locationt & source_location_of(std::size_t block_number) const override
Definition: cover_basic_blocks.cpp:231
cover_basic_blockst
Definition: cover_basic_blocks.h:64
cover_basic_blocks_javat::instruction_of
optionalt< goto_programt::const_targett > instruction_of(std::size_t block_number) const override
Definition: cover_basic_blocks.cpp:224
cover_basic_blockst::block_mapt
std::map< goto_programt::const_targett, std::size_t > block_mapt
Definition: cover_basic_blocks.h:98
cover_basic_blockst::block_infot::lines
std::unordered_set< std::size_t > lines
the set of lines belonging to this block
Definition: cover_basic_blocks.h:111
cover_basic_blocks_javat::output
void output(std::ostream &out) const override
Outputs the list of blocks.
Definition: cover_basic_blocks.cpp:237
cover_basic_blockst::output
void output(std::ostream &out) const override
Outputs the list of blocks.
Definition: cover_basic_blocks.cpp:151
goto_programt
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:73
cover_blocks_baset::~cover_blocks_baset
virtual ~cover_blocks_baset()=default
goto_programt::const_targett
instructionst::const_iterator const_targett
Definition: goto_program.h:580
message.h
cover_blocks_baset::block_of
virtual std::size_t block_of(goto_programt::const_targett t) const =0
cover_basic_blockst::update_covered_lines
static void update_covered_lines(block_infot &block_info)
create list of covered lines as CSV string and set as property of source location of basic block,...
Definition: cover_basic_blocks.cpp:158
cover_basic_blockst::block_infot::representative_inst
optionalt< goto_programt::const_targett > representative_inst
the program location to instrument for this block
Definition: cover_basic_blocks.h:103
cover_basic_blockst::block_infot
Definition: cover_basic_blocks.h:101