cprover
java_static_initializers.h File Reference
#include "java_object_factory_parameters.h"
#include "select_pointer_type.h"
#include "synthetic_methods_map.h"
#include <unordered_set>
#include <util/message.h>
#include <util/std_code.h>
#include <util/symbol_table.h>
+ Include dependency graph for java_static_initializers.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  stub_global_initializer_factoryt
 

Functions

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 initialization has already been done before invoking the real static initializer if not). More...
 
bool is_clinit_wrapper_function (const irep_idt &function_id)
 Check if function_id is a clinit wrapper. More...
 
void create_static_initializer_wrappers (symbol_tablet &symbol_table, synthetic_methods_mapt &synthetic_methods, const bool thread_safe)
 Create static initializer wrappers for all classes that need them. More...
 
code_blockt get_thread_safe_clinit_wrapper_body (const irep_idt &function_id, symbol_table_baset &symbol_table, const bool nondet_static, 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. More...
 
code_ifthenelset get_clinit_wrapper_body (const irep_idt &function_id, symbol_table_baset &symbol_table, const bool nondet_static, 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. More...
 
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)
 

Function Documentation

◆ 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 initialization has already been done before invoking the real static initializer if not).

Doesn't check whether the symbol actually exists

Parameters
class_nameclass symbol name
Returns
static initializer wrapper name

Definition at line 63 of file java_static_initializers.cpp.

◆ create_static_initializer_wrappers()

void create_static_initializer_wrappers ( symbol_tablet symbol_table,
synthetic_methods_mapt synthetic_methods,
const bool  thread_safe 
)

Create static initializer wrappers for all classes that need them.

Parameters
symbol_tableglobal symbol table
synthetic_methodssynthetic methods map. Will be extended noting that any wrapper belongs to this code, and so get_clinit_wrapper_body should be used to produce the method body when required.
thread_safeif true state variables required to make the clinit_wrapper thread safe will be created.

Definition at line 712 of file java_static_initializers.cpp.

◆ 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 
)

◆ 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 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.

Note: this version of the clinit wrapper is not thread safe.

Parameters
function_idclinit wrapper function id (the wrapper_method_symbol name created by create_clinit_wrapper_symbols)
symbol_tableglobal symbol table
nondet_statictrue if nondet-static option was given
object_factory_parametersobject factory parameters used to populate nondet-initialized globals and objects reachable from them (only needed if nondet-static is true)
pointer_type_selectorused to choose concrete types for abstract- typed globals and fields (only needed if nondet-static is true)
message_handlerlog output
Returns
the body of the static initializer wrapper

Definition at line 648 of file java_static_initializers.cpp.

◆ 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 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.

Produces the static initializer wrapper body for the given function. This static initializer implements (a simplification of) the algorithm defined in Section 5.5 of the JVM Specs. This function, or wrapper, checks whether static init has already taken place, calls the actual <clinit> method if not, and possibly recursively initializes super-classes and interfaces. Assume that C is the class to be initialized and that C extends C' and implements interfaces I1 ... In, then the algorithm is as follows:

bool init_complete;
if(java::C::__CPROVER_PREFIX_clinit_thread_local_state == INIT_COMPLETE)
{
return;
}
java::C::__CPROVER_PREFIX_clinit_thread_local_state = INIT_COMPLETE;
// This thread atomically checks and sets the global variable
// 'clinit_state' in order to ensure that only this thread runs the
// static initializer. The assume() statement below will prevent the SAT
// solver from producing a thread schedule where more than 1 thread is
// running the initializer. At the end of this function the only
// thread that runs the static initializer will update the variable.
// Alternatively we could have done a busy wait / spin-lock, but that
// would achieve the same effect and blow up the size of the SAT formula.
assume(java::C::__CPROVER_PREFIX_clinit_state != IN_PROGRESS)
if(java::C::__CPROVER_PREFIX_clinit_state == NOT_INIT)
{
java::C::__CPROVER_PREFIX_clinit_state = IN_PROGRESS
init_complete = false;
}
else if(java::C::__CPROVER_PREFIX_clinit_state == INIT_COMPLETE)
{
init_complete = true;
}
if(init_complete)
return;
java::C'::clinit_wrapper();
java::I1::clinit_wrapper();
java::I2::clinit_wrapper();
// ...
java::In::clinit_wrapper();
java::C::<clinit>(); // or nondet-initialization of all static
// variables of C if nondet-static is true
// Setting this variable to INIT_COMPLETE will let other threads "cross"
// beyond the assume() statement above in this function.
ATOMIC_START
C::__CPROVER_PREFIX_clinit_state = INIT_COMPLETE;
ATOMIC_END
return;

Note: The current implementation does not deal with exceptions.

Parameters
function_idclinit wrapper function id (the wrapper_method_symbol name created by create_clinit_wrapper_symbols)
symbol_tableglobal symbol table
nondet_statictrue if nondet-static option was given
object_factory_parametersobject factory parameters used to populate nondet-initialized globals and objects reachable from them (only needed if nondet-static is true)
pointer_type_selectorused to choose concrete types for abstract- typed globals and fields (only needed if nondet-static is true)
message_handlerlog output
Returns
the body of the static initializer wrapper

Definition at line 455 of file java_static_initializers.cpp.

◆ is_clinit_wrapper_function()

bool is_clinit_wrapper_function ( const irep_idt function_id)

Check if function_id is a clinit wrapper.

Parameters
function_idsome function identifier
Returns
true if the passed identifier is a clinit wrapper

Definition at line 71 of file java_static_initializers.cpp.