CBMC
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 <util/namespace.h>
13 #include <util/std_code.h>
14 
16 enum class lifetimet
17 {
23  DYNAMIC
24 };
25 
27 {
28 public:
30  const irep_idt &symbol_mode,
32  const irep_idt &name_prefix,
39  {
40  }
41 
43  code_blockt &assignments,
44  const exprt &target_expr,
45  const typet &allocate_type,
46  const lifetimet lifetime,
47  const irep_idt &basename_prefix = "tmp");
48 
50  code_blockt &assignments,
51  const exprt &target_expr,
52  const typet &allocate_type,
53  const irep_idt &basename_prefix = "tmp");
54 
56  code_blockt &assignments,
57  const exprt &target_expr,
58  const typet &allocate_type,
59  const irep_idt &basename_prefix = "tmp");
60 
77  code_blockt &output_code,
78  const exprt &target_expr,
79  const typet &allocate_type);
80 
85  code_blockt &output_code,
86  const exprt &target_expr,
87  const typet &allocate_type);
88 
90  const typet &allocate_type,
91  const irep_idt &basename_prefix = "tmp");
92 
93  void add_created_symbol(const symbolt &symbol);
94 
95  void declare_created_symbols(code_blockt &init_code);
96 
98 
99 private:
103 
105  const namespacet ns;
106 
107  std::vector<irep_idt> symbols_created;
108 
110  code_blockt &assignments,
111  const exprt &target_expr,
112  const typet &allocate_type,
113  const bool static_lifetime,
114  const irep_idt &basename_prefix);
115 };
116 
122 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:36
code_blockt
A codet representing sequential composition of program statements.
Definition: std_code.h:129
lifetimet::AUTOMATIC_LOCAL
@ AUTOMATIC_LOCAL
Allocate local objects with automatic lifetime.
typet
The type of an expression, extends irept.
Definition: type.h:28
make_allocate_code
code_frontend_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:261
exprt
Base class for all expressions.
Definition: expr.h:55
allocate_objectst::symbol_table
symbol_table_baset & symbol_table
Definition: allocate_objects.h:104
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:112
namespace.h
allocate_objectst::symbol_mode
const irep_idt symbol_mode
Definition: allocate_objects.h:100
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:90
allocate_objectst::add_created_symbol
void add_created_symbol(const symbolt &symbol)
Add a pointer to a symbol to the list of pointers to symbols created so far.
Definition: allocate_objects.cpp:221
allocate_objectst::ns
const namespacet ns
Definition: allocate_objects.h:105
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:126
symbol_table_baset
The symbol table base class interface.
Definition: symbol_table_base.h:21
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:93
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:34
code_frontend_assignt
A codet representing an assignment in the program.
Definition: std_code.h:23
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:29
allocate_objectst::name_prefix
const irep_idt name_prefix
Definition: allocate_objects.h:102
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:229
lifetimet
lifetimet
Selects the kind of objects allocated.
Definition: allocate_objects.h:16
source_locationt
Definition: source_location.h:18
allocate_objectst::source_location
const source_locationt source_location
Definition: allocate_objects.h:101
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:183
symbolt
Symbol table entry.
Definition: symbol.h:27
lifetimet::STATIC_GLOBAL
@ STATIC_GLOBAL
Allocate global objects with static lifetime.
lifetimet::DYNAMIC
@ DYNAMIC
Allocate dynamic objects (using ALLOCATE)
allocate_objectst
Definition: allocate_objects.h:26
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:174
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:248
allocate_objectst::symbols_created
std::vector< irep_idt > symbols_created
Definition: allocate_objects.h:107
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:72