CBMC
add_failed_symbols.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Pointer Dereferencing
4 
5 Author: Daniel Kroening, kroening@kroening.com
6 
7 \*******************************************************************/
8 
11 
12 #include "add_failed_symbols.h"
13 
14 #include <util/namespace.h>
15 #include <util/pointer_expr.h>
16 #include <util/std_expr.h>
17 #include <util/symbol.h>
18 #include <util/symbol_table_base.h>
19 
20 #include <list>
21 
27 {
28  return id2string(id)+"$object";
29 }
30 
35 void add_failed_symbol(symbolt &symbol, symbol_table_baset &symbol_table)
36 {
37  if(symbol.type.id()==ID_pointer)
38  {
39  symbolt new_symbol{
40  failed_symbol_id(symbol.name),
41  to_pointer_type(symbol.type).base_type(),
42  symbol.mode};
43  new_symbol.is_lvalue=true;
44  new_symbol.module=symbol.module;
45  new_symbol.base_name=failed_symbol_id(symbol.base_name);
46  new_symbol.type.set(ID_C_is_failed_symbol, true);
47 
48  symbol.type.set(ID_C_failed_symbol, new_symbol.name);
49 
50  if(new_symbol.type.id()==ID_pointer)
51  add_failed_symbol(new_symbol, symbol_table); // recursive call
52 
53  symbol_table.insert(std::move(new_symbol));
54  }
55 }
56 
63  const symbolt &symbol, symbol_table_baset &symbol_table)
64 {
65  if(!symbol.is_lvalue)
66  return;
67 
68  if(!symbol.type.get(ID_C_failed_symbol).empty())
69  return;
70 
71  add_failed_symbol(symbol_table.get_writeable_ref(symbol.name), symbol_table);
72 }
73 
78 {
79  // the symbol table iterators are not stable, and
80  // we are adding new symbols, this
81  // is why we need a list of pointers
82  std::list<const symbolt *> symbol_list;
83  for(auto &named_symbol : symbol_table.symbols)
84  symbol_list.push_back(&(named_symbol.second));
85 
86  for(const symbolt *symbol : symbol_list)
87  add_failed_symbol_if_needed(*symbol, symbol_table);
88 }
89 
90 std::optional<symbol_exprt>
91 get_failed_symbol(const symbol_exprt &expr, const namespacet &ns)
92 {
93  const symbolt &symbol=ns.lookup(expr);
94  irep_idt failed_symbol_id=symbol.type.get(ID_C_failed_symbol);
95 
97  return {};
98 
99  const symbolt &failed_symbol=ns.lookup(failed_symbol_id);
100 
101  return symbol_exprt(failed_symbol_id, failed_symbol.type);
102 }
void add_failed_symbol_if_needed(const symbolt &symbol, symbol_table_baset &symbol_table)
Create a failed-dereference symbol for the given base symbol if it is pointer-typed,...
void add_failed_symbols(symbol_table_baset &symbol_table)
Create a failed-dereference symbol for all symbols in the given table that need one (i....
std::optional< symbol_exprt > get_failed_symbol(const symbol_exprt &expr, const namespacet &ns)
Get the failed-dereference symbol for the given symbol.
void add_failed_symbol(symbolt &symbol, symbol_table_baset &symbol_table)
Create a failed-dereference symbol for the given base symbol if it is pointer-typed; if not,...
irep_idt failed_symbol_id(const irep_idt &id)
Get the name of the special symbol used to denote an unknown referee pointed to by a given pointer-ty...
Pointer Dereferencing.
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:38
bool empty() const
Definition: dstring.h:89
const irep_idt & get(const irep_idt &name) const
Definition: irep.cpp:44
void set(const irep_idt &name, const irep_idt &value)
Definition: irep.h:408
const irep_idt & id() const
Definition: irep.h:384
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:94
bool lookup(const irep_idt &name, const symbolt *&symbol) const override
See documentation for namespace_baset::lookup().
Definition: namespace.cpp:148
const typet & base_type() const
The type of the data what we point to.
Definition: pointer_expr.h:35
Expression to hold a symbol (variable)
Definition: std_expr.h:131
The symbol table base class interface.
symbolt & get_writeable_ref(const irep_idt &name)
Find a symbol in the symbol table for read-write access.
const symbolst & symbols
Read-only field, used to look up symbols given their names.
virtual std::pair< symbolt &, bool > insert(symbolt symbol)=0
Move or copy a new symbol to the symbol table.
Symbol table entry.
Definition: symbol.h:28
irep_idt base_name
Base (non-scoped) name.
Definition: symbol.h:46
irep_idt module
Name of module the symbol belongs to.
Definition: symbol.h:43
typet type
Type of symbol.
Definition: symbol.h:31
irep_idt name
The unique identifier.
Definition: symbol.h:40
bool is_lvalue
Definition: symbol.h:72
irep_idt mode
Language mode.
Definition: symbol.h:49
const std::string & id2string(const irep_idt &d)
Definition: irep.h:40
API to expression classes for Pointers.
const pointer_typet & to_pointer_type(const typet &type)
Cast a typet to a pointer_typet.
Definition: pointer_expr.h:93
API to expression classes.
Symbol table entry.
Author: Diffblue Ltd.