cprover
static_lifetime_init.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module:
4 
5 Author: Daniel Kroening, kroening@kroening.com
6 
7 \*******************************************************************/
8 
9 #include "static_lifetime_init.h"
10 
11 #include <cstdlib>
12 
13 #include <util/arith_tools.h>
14 #include <util/c_types.h>
15 #include <util/expr_initializer.h>
16 #include <util/namespace.h>
17 #include <util/prefix.h>
18 #include <util/std_code.h>
19 #include <util/std_expr.h>
20 
22 
23 static optionalt<codet>
24 static_lifetime_init(const irep_idt &identifier, symbol_tablet &symbol_table)
25 {
26  const namespacet ns(symbol_table);
27  const symbolt &symbol = ns.lookup(identifier);
28 
29  if(!symbol.is_static_lifetime)
30  return {};
31 
32  if(symbol.is_type || symbol.is_macro)
33  return {};
34 
35  // special values
36  if(
37  identifier == CPROVER_PREFIX "constant_infinity_uint" ||
38  identifier == CPROVER_PREFIX "memory" || identifier == "__func__" ||
39  identifier == "__FUNCTION__" || identifier == "__PRETTY_FUNCTION__" ||
40  identifier == "argc'" || identifier == "argv'" || identifier == "envp'" ||
41  identifier == "envp_size'")
42  return {};
43 
44  // just for linking
45  if(has_prefix(id2string(identifier), CPROVER_PREFIX "architecture_"))
46  return {};
47 
48  const typet &type = ns.follow(symbol.type);
49 
50  // check type
51  if(type.id() == ID_code || type.id() == ID_empty)
52  return {};
53 
54  if(type.id() == ID_array && to_array_type(type).size().is_nil())
55  {
56  // C standard 6.9.2, paragraph 5
57  // adjust the type to an array of size 1
58  symbolt &writable_symbol = symbol_table.get_writeable_ref(identifier);
59  writable_symbol.type = type;
60  writable_symbol.type.set(ID_size, from_integer(1, size_type()));
61  }
62 
63  if(
64  (type.id() == ID_struct || type.id() == ID_union) &&
65  to_struct_union_type(type).is_incomplete())
66  {
67  return {}; // do not initialize
68  }
69 
70  exprt rhs;
71 
72  if((symbol.value.is_nil() && symbol.is_extern) ||
73  symbol.value.id() == ID_nondet)
74  {
75  // Nondet initialise if not linked, or if explicitly requested.
76  // Compilers would usually complain about the unlinked symbol case.
77  const auto nondet = nondet_initializer(symbol.type, symbol.location, ns);
78  CHECK_RETURN(nondet.has_value());
79  rhs = *nondet;
80  }
81  else if(symbol.value.is_nil())
82  {
83  const auto zero = zero_initializer(symbol.type, symbol.location, ns);
84  CHECK_RETURN(zero.has_value());
85  rhs = *zero;
86  }
87  else
88  rhs = symbol.value;
89 
90  code_assignt code(symbol.symbol_expr(), rhs);
91  code.add_source_location() = symbol.location;
92 
93  return std::move(code);
94 }
95 
97  symbol_tablet &symbol_table,
98  const source_locationt &source_location)
99 {
101 
102  const namespacet ns(symbol_table);
103 
104  symbolt &init_symbol = symbol_table.get_writeable_ref(INITIALIZE_FUNCTION);
105 
106  init_symbol.value=code_blockt();
107  init_symbol.value.add_source_location()=source_location;
108 
109  code_blockt &dest=to_code_block(to_code(init_symbol.value));
110 
111  // add the magic label to hide
112  dest.add(code_labelt(CPROVER_PREFIX "HIDE", code_skipt()));
113 
114  // do assignments based on "value"
115 
116  // sort alphabetically for reproducible results
117  std::set<std::string> symbols;
118 
119  for(const auto &symbol_pair : symbol_table.symbols)
120  {
121  symbols.insert(id2string(symbol_pair.first));
122  }
123 
124  // first do framework variables
125  for(const std::string &id : symbols)
126  if(has_prefix(id, CPROVER_PREFIX))
127  {
128  auto code = static_lifetime_init(id, symbol_table);
129  if(code.has_value())
130  dest.add(std::move(*code));
131  }
132 
133  // now all other variables
134  for(const std::string &id : symbols)
135  if(!has_prefix(id, CPROVER_PREFIX))
136  {
137  auto code = static_lifetime_init(id, symbol_table);
138  if(code.has_value())
139  dest.add(std::move(*code));
140  }
141 
142  // now call designated "initialization" functions
143 
144  for(const std::string &id : symbols)
145  {
146  const symbolt &symbol=ns.lookup(id);
147 
148  if(symbol.type.id() != ID_code)
149  continue;
150 
151  const code_typet &code_type = to_code_type(symbol.type);
152  if(
153  code_type.return_type().id() == ID_constructor &&
154  code_type.parameters().empty())
155  {
156  code_function_callt function_call(symbol.symbol_expr());
157  function_call.add_source_location()=source_location;
158  dest.add(function_call);
159  }
160  }
161 }
symbol_table_baset::has_symbol
bool has_symbol(const irep_idt &name) const
Check whether a symbol exists in the symbol table.
Definition: symbol_table_base.h:87
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:170
symbol_tablet
The symbol table.
Definition: symbol_table.h:20
arith_tools.h
symbolt::is_macro
bool is_macro
Definition: symbol.h:61
to_struct_union_type
const struct_union_typet & to_struct_union_type(const typet &type)
Cast a typet to a struct_union_typet.
Definition: std_types.h:208
CHECK_RETURN
#define CHECK_RETURN(CONDITION)
Definition: invariant.h:496
typet
The type of an expression, extends irept.
Definition: type.h:28
symbolt::type
typet type
Type of symbol.
Definition: symbol.h:31
prefix.h
nondet_initializer
optionalt< exprt > nondet_initializer(const typet &type, const source_locationt &source_location, const namespacet &ns)
Create a non-deterministic value for type type, with all subtypes independently expanded as non-deter...
Definition: expr_initializer.cpp:333
exprt
Base class for all expressions.
Definition: expr.h:54
namespace.h
zero_initializer
optionalt< exprt > zero_initializer(const typet &type, const source_locationt &source_location, const namespacet &ns)
Create the equivalent of zero for type type.
Definition: expr_initializer.cpp:318
to_code
const codet & to_code(const exprt &expr)
Definition: std_code.h:155
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:92
namespacet::lookup
bool lookup(const irep_idt &name, const symbolt *&symbol) const override
See documentation for namespace_baset::lookup().
Definition: namespace.cpp:141
code_function_callt
codet representation of a function call statement.
Definition: std_code.h:1215
to_code_type
const code_typet & to_code_type(const typet &type)
Cast a typet to a code_typet.
Definition: std_types.h:738
expr_initializer.h
Expression Initialization.
has_prefix
bool has_prefix(const std::string &s, const std::string &prefix)
Definition: converter.cpp:13
symbol_table_baset::get_writeable_ref
symbolt & get_writeable_ref(const irep_idt &name)
Find a symbol in the symbol table for read-write access.
Definition: symbol_table_base.h:121
id2string
const std::string & id2string(const irep_idt &d)
Definition: irep.h:49
code_labelt
codet representation of a label for branch targets.
Definition: std_code.h:1407
PRECONDITION
#define PRECONDITION(CONDITION)
Definition: invariant.h:464
symbolt::symbol_expr
class symbol_exprt symbol_expr() const
Produces a symbol_exprt for a symbol.
Definition: symbol.cpp:122
INITIALIZE_FUNCTION
#define INITIALIZE_FUNCTION
Definition: static_lifetime_init.h:23
code_typet
Base type of functions.
Definition: std_types.h:533
irept::is_nil
bool is_nil() const
Definition: irep.h:387
irept::id
const irep_idt & id() const
Definition: irep.h:407
code_blockt::add
void add(const codet &code)
Definition: std_code.h:208
code_typet::parameters
const parameterst & parameters() const
Definition: std_types.h:649
std_code.h
optionalt
nonstd::optional< T > optionalt
Definition: optional.h:35
source_locationt
Definition: source_location.h:20
symbolt::value
exprt value
Initial value of symbol.
Definition: symbol.h:34
code_skipt
A codet representing a skip statement.
Definition: std_code.h:270
symbolt::is_extern
bool is_extern
Definition: symbol.h:66
namespace_baset::follow
const typet & follow(const typet &) const
Resolve type symbol to the type it points to.
Definition: namespace.cpp:52
symbolt::location
source_locationt location
Source code location of definition of symbol.
Definition: symbol.h:37
symbolt
Symbol table entry.
Definition: symbol.h:28
irept::set
void set(const irep_namet &name, const irep_idt &value)
Definition: irep.h:431
from_integer
constant_exprt from_integer(const mp_integer &int_value, const typet &type)
Definition: arith_tools.cpp:100
static_lifetime_init
static optionalt< codet > static_lifetime_init(const irep_idt &identifier, symbol_tablet &symbol_table)
Definition: static_lifetime_init.cpp:24
symbol_table_baset::symbols
const symbolst & symbols
Read-only field, used to look up symbols given their names.
Definition: symbol_table_base.h:30
symbolt::is_type
bool is_type
Definition: symbol.h:61
CPROVER_PREFIX
#define CPROVER_PREFIX
Definition: cprover_prefix.h:14
to_array_type
const array_typet & to_array_type(const typet &type)
Cast a typet to an array_typet.
Definition: std_types.h:807
symbolt::is_static_lifetime
bool is_static_lifetime
Definition: symbol.h:65
goto_functions.h
Goto Programs with Functions.
code_typet::return_type
const typet & return_type() const
Definition: std_types.h:639
to_code_block
const code_blockt & to_code_block(const codet &code)
Definition: std_code.h:256
static_lifetime_init.h
exprt::add_source_location
source_locationt & add_source_location()
Definition: expr.h:243
size_type
unsignedbv_typet size_type()
Definition: c_types.cpp:58
code_assignt
A codet representing an assignment in the program.
Definition: std_code.h:295
std_expr.h
API to expression classes.
c_types.h