cprover
allocate_objects.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module:
4 
5 Author: Daniel Kroening, kroening@kroening.com
6 
7 \*******************************************************************/
8 
9 #ifndef CPROVER_UTIL_ALLOCATE_OBJECTS_H
10 #define CPROVER_UTIL_ALLOCATE_OBJECTS_H
11 
12 #include "namespace.h"
13 #include "source_location.h"
14 #include "std_code.h"
15 
17 enum class lifetimet
18 {
20  AUTOMATIC_LOCAL,
22  STATIC_GLOBAL,
24  DYNAMIC
25 };
26 
28 {
29 public:
31  const irep_idt &symbol_mode,
33  const irep_idt &name_prefix,
40  {
41  }
42 
44  code_blockt &assignments,
45  const exprt &target_expr,
46  const typet &allocate_type,
47  const lifetimet lifetime,
48  const irep_idt &basename_prefix = "tmp");
49 
51  code_blockt &assignments,
52  const exprt &target_expr,
53  const typet &allocate_type,
54  const irep_idt &basename_prefix = "tmp");
55 
57  code_blockt &assignments,
58  const exprt &target_expr,
59  const typet &allocate_type,
60  const irep_idt &basename_prefix = "tmp");
61 
78  code_blockt &output_code,
79  const exprt &target_expr,
80  const typet &allocate_type);
81 
86  code_blockt &output_code,
87  const exprt &target_expr,
88  const typet &allocate_type);
89 
91  const typet &allocate_type,
92  const irep_idt &basename_prefix = "tmp");
93 
94  void add_created_symbol(const symbolt *symbol_ptr);
95 
96  void declare_created_symbols(code_blockt &init_code);
97 
99 
100 private:
104 
106  const namespacet ns;
107 
108  std::vector<const symbolt *> symbols_created;
109 
111  code_blockt &assignments,
112  const exprt &target_expr,
113  const typet &allocate_type,
114  const bool static_lifetime,
115  const irep_idt &basename_prefix);
116 };
117 
122 code_assignt make_allocate_code(const symbol_exprt &lhs, const exprt &size);
123 
124 #endif // CPROVER_UTIL_ALLOCATE_OBJECTS_H
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
code_blockt
A codet representing sequential composition of program statements.
Definition: std_code.h:168
lifetimet::AUTOMATIC_LOCAL
@ AUTOMATIC_LOCAL
Allocate local objects with automatic lifetime.
typet
The type of an expression, extends irept.
Definition: type.h:28
allocate_objectst::add_created_symbol
void add_created_symbol(const symbolt *symbol_ptr)
Add a pointer to a symbol to the list of pointers to symbols created so far.
Definition: allocate_objects.cpp:218
exprt
Base class for all expressions.
Definition: expr.h:54
allocate_objectst::symbol_table
symbol_table_baset & symbol_table
Definition: allocate_objects.h:105
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:80
namespace.h
allocate_objectst::symbol_mode
const irep_idt symbol_mode
Definition: allocate_objects.h:101
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:91
allocate_objectst::ns
const namespacet ns
Definition: allocate_objects.h:106
allocate_objectst::symbols_created
std::vector< const symbolt * > symbols_created
Definition: allocate_objects.h:108
allocate_objectst::allocate_dynamic_object_symbol
exprt allocate_dynamic_object_symbol(code_blockt &output_code, const exprt &target_expr, const typet &allocate_type)
Generates code for allocating a dynamic object.
Definition: allocate_objects.cpp:124
symbol_table_baset
The symbol table base class interface.
Definition: symbol_table_base.h:22
allocate_objectst::allocate_static_global_object
exprt allocate_static_global_object(code_blockt &assignments, const exprt &target_expr, const typet &allocate_type, const irep_idt &basename_prefix="tmp")
Creates a global variable with static lifetime.
Definition: allocate_objects.cpp:91
allocate_objectst::allocate_object
exprt allocate_object(code_blockt &assignments, const exprt &target_expr, const typet &allocate_type, const lifetimet lifetime, const irep_idt &basename_prefix="tmp")
Allocates a new object, either by creating a local variable with automatic lifetime,...
Definition: allocate_objects.cpp:32
source_location.h
make_allocate_code
code_assignt make_allocate_code(const symbol_exprt &lhs, const exprt &size)
Create code allocating an object of size size and assigning it to lhs
Definition: allocate_objects.cpp:255
allocate_objectst::allocate_objectst
allocate_objectst(const irep_idt &symbol_mode, const source_locationt &source_location, const irep_idt &name_prefix, symbol_table_baset &symbol_table)
Definition: allocate_objects.h:30
allocate_objectst::name_prefix
const irep_idt name_prefix
Definition: allocate_objects.h:103
std_code.h
allocate_objectst::declare_created_symbols
void declare_created_symbols(code_blockt &init_code)
Adds declarations for all non-static symbols created.
Definition: allocate_objects.cpp:226
lifetimet
lifetimet
Selects the kind of objects allocated.
Definition: allocate_objects.h:18
source_locationt
Definition: source_location.h:19
allocate_objectst::source_location
const source_locationt source_location
Definition: allocate_objects.h:102
allocate_objectst::allocate_non_dynamic_object
exprt allocate_non_dynamic_object(code_blockt &assignments, const exprt &target_expr, const typet &allocate_type, const bool static_lifetime, const irep_idt &basename_prefix)
Definition: allocate_objects.cpp:180
symbolt
Symbol table entry.
Definition: symbol.h:28
allocate_objectst
Definition: allocate_objects.h:28
allocate_objectst::allocate_dynamic_object
exprt allocate_dynamic_object(code_blockt &output_code, const exprt &target_expr, const typet &allocate_type)
Generate the same code as allocate_dynamic_object_symbol, but return a dereference_exprt that derefer...
Definition: allocate_objects.cpp:171
allocate_objectst::mark_created_symbols_as_input
void mark_created_symbols_as_input(code_blockt &init_code)
Adds code to mark the created symbols as input.
Definition: allocate_objects.cpp:244
allocate_objectst::allocate_automatic_local_object
exprt allocate_automatic_local_object(code_blockt &assignments, const exprt &target_expr, const typet &allocate_type, const irep_idt &basename_prefix="tmp")
Creates a local variable with automatic lifetime.
Definition: allocate_objects.cpp:70
code_assignt
A codet representing an assignment in the program.
Definition: std_code.h:293