CBMC
java_static_initializers.h
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Java Static Initializers
4 
5 Author: Chris Smowton, chris.smowton@diffblue.com
6 
7 \*******************************************************************/
8 
9 #ifndef CPROVER_JAVA_BYTECODE_JAVA_STATIC_INITIALIZERS_H
10 #define CPROVER_JAVA_BYTECODE_JAVA_STATIC_INITIALIZERS_H
11 
12 #include "synthetic_methods_map.h"
13 
14 #include <unordered_set>
15 
16 #include <util/std_code.h>
17 #include <util/symbol.h>
18 
19 #include "code_with_references.h"
20 
22 class json_objectt;
23 class message_handlert;
25 class symbol_table_baset;
26 class symbol_tablet;
28 
29 irep_idt clinit_wrapper_name(const irep_idt &class_name);
31 
35 
37  symbol_tablet &symbol_table,
38  synthetic_methods_mapt &synthetic_methods,
39  const bool thread_safe,
40  const bool is_user_clinit_needed);
41 
43  const irep_idt &function_id,
44  symbol_table_baset &symbol_table,
45  const bool nondet_static,
46  const bool replace_clinit,
47  const java_object_factory_parameterst &object_factory_parameters,
48  const select_pointer_typet &pointer_type_selector,
49  message_handlert &message_handler);
50 
52  const irep_idt &function_id,
53  symbol_table_baset &symbol_table,
54  const bool nondet_static,
55  const bool replace_clinit,
56  const java_object_factory_parameterst &object_factory_parameters,
57  const select_pointer_typet &pointer_type_selector,
58  message_handlert &message_handler);
59 
61 std::unordered_multimap<irep_idt, symbolt>
62 class_to_declared_symbols(const symbol_tablet &symbol_table);
63 
88  const irep_idt &class_id,
89  const json_objectt &static_values_json,
90  symbol_table_baset &symbol_table,
91  optionalt<ci_lazy_methods_neededt> needed_lazy_methods,
92  size_t max_user_array_length,
93  std::unordered_map<std::string, object_creation_referencet> &references,
94  const std::unordered_multimap<irep_idt, symbolt>
95  &class_to_declared_symbols_map);
96 
98 {
100  typedef std::unordered_multimap<irep_idt, irep_idt> stub_globals_by_classt;
102 
103 public:
105  symbol_tablet &symbol_table,
106  const std::unordered_set<irep_idt> &stub_globals_set,
107  synthetic_methods_mapt &synthetic_methods);
108 
110  const irep_idt &function_id,
111  symbol_table_baset &symbol_table,
112  const java_object_factory_parameterst &object_factory_parameters,
113  const select_pointer_typet &pointer_type_selector,
114  message_handlert &message_handler);
115 };
116 
118  symbol_tablet &symbol_table,
119  const std::unordered_set<irep_idt> &stub_globals_set,
120  const java_object_factory_parameterst &object_factory_parameters,
121  const select_pointer_typet &pointer_type_selector);
122 
123 #endif
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:36
class_to_declared_symbols
std::unordered_multimap< irep_idt, symbolt > class_to_declared_symbols(const symbol_tablet &symbol_table)
Definition: java_static_initializers.cpp:783
code_blockt
A codet representing sequential composition of program statements.
Definition: std_code.h:129
symbol_tablet
The symbol table.
Definition: symbol_table.h:13
clinit_wrapper_name
irep_idt clinit_wrapper_name(const irep_idt &class_name)
Get the Java static initializer wrapper name for a given class (the wrapper checks if static initiali...
Definition: java_static_initializers.cpp:73
stub_global_initializer_factoryt::get_stub_initializer_body
code_blockt get_stub_initializer_body(const irep_idt &function_id, symbol_table_baset &symbol_table, const java_object_factory_parameterst &object_factory_parameters, const select_pointer_typet &pointer_type_selector, message_handlert &message_handler)
Create the body of a synthetic static initializer (clinit method), which initialise stub globals in t...
Definition: java_static_initializers.cpp:1010
nondet_static
static void nondet_static(const namespacet &ns, goto_functionst &goto_functions, const irep_idt &fct_name)
Nondeterministically initializes global scope variables in a goto-function.
Definition: nondet_static.cpp:80
code_with_references.h
object_factory_parameterst::function_id
irep_idt function_id
Function id, used as a prefix for identifiers of temporaries.
Definition: object_factory_parameters.h:79
is_clinit_wrapper_function
bool is_clinit_wrapper_function(const irep_idt &function_id)
Check if function_id is a clinit wrapper.
Definition: java_static_initializers.cpp:86
synthetic_methods_mapt
std::unordered_map< irep_idt, synthetic_method_typet > synthetic_methods_mapt
Maps method names on to a synthetic method kind.
Definition: synthetic_methods_map.h:57
stub_global_initializer_factoryt
Definition: java_static_initializers.h:97
code_ifthenelset
codet representation of an if-then-else statement.
Definition: std_code.h:459
json_objectt
Definition: json.h:299
symbol_table_baset
The symbol table base class interface.
Definition: symbol_table_base.h:21
select_pointer_typet
Definition: select_pointer_type.h:22
create_static_initializer_symbols
void create_static_initializer_symbols(symbol_tablet &symbol_table, synthetic_methods_mapt &synthetic_methods, const bool thread_safe, const bool is_user_clinit_needed)
Create static initializer wrappers and possibly user-specified functions for initial static field val...
Definition: java_static_initializers.cpp:878
symbol.h
Symbol table entry.
create_stub_global_initializers
void create_stub_global_initializers(symbol_tablet &symbol_table, const std::unordered_set< irep_idt > &stub_globals_set, const java_object_factory_parameterst &object_factory_parameters, const select_pointer_typet &pointer_type_selector)
message_handlert
Definition: message.h:27
get_user_specified_clinit_body
code_blockt get_user_specified_clinit_body(const irep_idt &class_id, const json_objectt &static_values_json, symbol_table_baset &symbol_table, optionalt< ci_lazy_methods_neededt > needed_lazy_methods, size_t max_user_array_length, std::unordered_map< std::string, object_creation_referencet > &references, const std::unordered_multimap< irep_idt, symbolt > &class_to_declared_symbols_map)
Create the body of a user_specified_clinit function for a given class, which includes assignments for...
Definition: java_static_initializers.cpp:795
user_specified_clinit_name
irep_idt user_specified_clinit_name(const irep_idt &class_name)
Definition: java_static_initializers.cpp:78
std_code.h
optionalt
nonstd::optional< T > optionalt
Definition: optional.h:35
get_clinit_wrapper_body
code_ifthenelset get_clinit_wrapper_body(const irep_idt &function_id, symbol_table_baset &symbol_table, const bool nondet_static, const bool replace_clinit, const java_object_factory_parameterst &object_factory_parameters, const select_pointer_typet &pointer_type_selector, message_handlert &message_handler)
Produces the static initializer wrapper body for the given function.
Definition: java_static_initializers.cpp:722
stub_global_initializer_factoryt::create_stub_global_initializer_symbols
void create_stub_global_initializer_symbols(symbol_tablet &symbol_table, const std::unordered_set< irep_idt > &stub_globals_set, synthetic_methods_mapt &synthetic_methods)
Create static initializer symbols for each distinct class that has stub globals.
Definition: java_static_initializers.cpp:929
is_clinit_function
bool is_clinit_function(const irep_idt &function_id)
Check if function_id is a clinit.
Definition: java_static_initializers.cpp:94
stub_global_initializer_factoryt::stub_globals_by_class
stub_globals_by_classt stub_globals_by_class
Definition: java_static_initializers.h:101
is_user_specified_clinit_function
bool is_user_specified_clinit_function(const irep_idt &function_id)
Check if function_id is a user-specified clinit.
Definition: java_static_initializers.cpp:102
ci_lazy_methods_neededt
Definition: ci_lazy_methods_needed.h:25
stub_global_initializer_factoryt::stub_globals_by_classt
std::unordered_multimap< irep_idt, irep_idt > stub_globals_by_classt
Maps class symbols onto the stub globals that belong to them.
Definition: java_static_initializers.h:100
get_thread_safe_clinit_wrapper_body
code_blockt get_thread_safe_clinit_wrapper_body(const irep_idt &function_id, symbol_table_baset &symbol_table, const bool nondet_static, const bool replace_clinit, const java_object_factory_parameterst &object_factory_parameters, const select_pointer_typet &pointer_type_selector, message_handlert &message_handler)
Thread safe version of the static initializer.
Definition: java_static_initializers.cpp:524
java_object_factory_parameterst
Definition: java_object_factory_parameters.h:15
synthetic_methods_map.h