cprover
create_array_with_type_intrinsic.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Implementation of CProver.createArrayWithType intrinsic
4 
5 Author: Diffblue Ltd.
6 
7 \*******************************************************************/
8 
11 
13 
16 #include <util/fresh_symbol.h>
17 #include <util/namespace.h>
18 #include <util/symbol_table_base.h>
19 
22 {
23  static irep_idt create_array_with_type_name =
24  "java::org.cprover.CProver.createArrayWithType:"
25  "(I[Ljava/lang/Object;)[Ljava/lang/Object;";
26  return create_array_with_type_name;
27 }
28 
40  const irep_idt &function_id,
41  symbol_table_baset &symbol_table,
42  message_handlert &message_handler)
43 {
44  // Replace CProver.createArrayWithType, which uses reflection to copy the
45  // type but not the content of a given array, with a java_new_array statement
46  // followed by overwriting its element type and dimension, similar to our
47  // implementation (in java_bytecode_convert_class.cpp) of the
48  // array[reference].clone() method.
49 
51 
52  namespacet ns{symbol_table};
53 
54  const symbolt &function_symbol =
56  const auto &function_type = to_code_type(function_symbol.type);
57  const auto &length_argument = function_type.parameters().at(0);
58  symbol_exprt length_argument_symbol_expr{length_argument.get_identifier(),
59  length_argument.type()};
60  const auto &existing_array_argument = function_type.parameters().at(1);
61  symbol_exprt existing_array_argument_symbol_expr{
62  existing_array_argument.get_identifier(), existing_array_argument.type()};
63 
64  symbolt &new_array_symbol = get_fresh_aux_symbol(
65  function_type.parameters().at(1).type(),
67  "new_array",
69  ID_java,
70  symbol_table);
71  const auto new_array_symbol_expr = new_array_symbol.symbol_expr();
72 
73  code_blockt code_block;
74 
75  // Declare new_array temporary:
76  code_block.add(code_declt(new_array_symbol_expr));
77 
78  // new_array = new Object[length];
79  side_effect_exprt new_array_expr{
80  ID_java_new_array, new_array_symbol.type, source_locationt{}};
81  new_array_expr.copy_to_operands(length_argument_symbol_expr);
82  code_block.add(code_assignt(new_array_symbol_expr, new_array_expr));
83 
84  dereference_exprt existing_array(existing_array_argument_symbol_expr);
85  dereference_exprt new_array(new_array_symbol_expr);
86 
87  // new_array.@array_dimensions = existing_array.@array_dimensions
88  // new_array.@element_class_identifier =
89  // existing_array.@element_class_identifier
90  member_exprt old_array_dimension(
92  member_exprt old_array_element_classid(
94 
95  member_exprt new_array_dimension(
97  member_exprt new_array_element_classid(
99 
100  code_block.add(code_assignt(new_array_dimension, old_array_dimension));
101  code_block.add(
102  code_assignt(new_array_element_classid, old_array_element_classid));
103 
104  // return new_array
105  code_block.add(code_returnt(new_array_symbol_expr));
106 
107  return std::move(code_block);
108 }
create_array_with_type_body
codet create_array_with_type_body(const irep_idt &function_id, symbol_table_baset &symbol_table, message_handlert &message_handler)
Returns the internal implementation for org.cprover.CProver.createArrayWithType.
Definition: create_array_with_type_intrinsic.cpp:39
dstringt
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
JAVA_ARRAY_ELEMENT_CLASSID_FIELD_NAME
#define JAVA_ARRAY_ELEMENT_CLASSID_FIELD_NAME
Definition: java_types.h:673
code_blockt
A codet representing sequential composition of program statements.
Definition: std_code.h:170
symbol_table_baset::lookup_ref
const symbolt & lookup_ref(const irep_idt &name) const
Find a symbol in the symbol table for read-only access.
Definition: symbol_table_base.h:104
JAVA_ARRAY_DIMENSION_FIELD_NAME
#define JAVA_ARRAY_DIMENSION_FIELD_NAME
Definition: java_types.h:671
fresh_symbol.h
Fresh auxiliary symbol creation.
symbolt::type
typet type
Type of symbol.
Definition: symbol.h:31
dereference_exprt
Operator to dereference a pointer.
Definition: std_expr.h:2888
object_factory_parameterst::function_id
irep_idt function_id
Function id, used as a prefix for identifiers of temporaries.
Definition: object_factory_parameters.h:82
code_declt
A codet representing the declaration of a local variable.
Definition: std_code.h:402
symbol_exprt
Expression to hold a symbol (variable)
Definition: std_expr.h:82
namespace.h
namespacet
A namespacet is essentially one or two symbol tables bound together, to allow for symbol lookups in t...
Definition: namespace.h:92
to_code_type
const code_typet & to_code_type(const typet &type)
Cast a typet to a code_typet.
Definition: std_types.h:946
id2string
const std::string & id2string(const irep_idt &d)
Definition: irep.h:44
PRECONDITION
#define PRECONDITION(CONDITION)
Definition: invariant.h:464
symbol_exprt::get_identifier
const irep_idt & get_identifier() const
Definition: std_expr.h:111
symbol_table_baset
The symbol table base class interface.
Definition: symbol_table_base.h:22
create_array_with_type_intrinsic.h
Implementation of CProver.createArrayWithType intrinsic.
symbolt::symbol_expr
class symbol_exprt symbol_expr() const
Produces a symbol_exprt for a symbol.
Definition: symbol.cpp:122
message_handlert
Definition: message.h:28
code_blockt::add
void add(const codet &code)
Definition: std_code.h:208
java_int_type
signedbv_typet java_int_type()
Definition: java_types.cpp:32
source_locationt
Definition: source_location.h:20
member_exprt
Extract member of struct or union.
Definition: std_expr.h:3405
code_returnt
codet representation of a "return from a function" statement.
Definition: std_code.h:1310
symbolt
Symbol table entry.
Definition: symbol.h:28
string_typet
String type.
Definition: std_types.h:1655
class_identifier.h
Extract class identifier.
java_types.h
symbol_table_base.h
Author: Diffblue Ltd.
code_assignt
A codet representing an assignment in the program.
Definition: std_code.h:295
get_fresh_aux_symbol
symbolt & get_fresh_aux_symbol(const typet &type, const std::string &name_prefix, const std::string &basename_prefix, const source_locationt &source_location, const irep_idt &symbol_mode, const namespacet &ns, symbol_table_baset &symbol_table)
Installs a fresh-named symbol with respect to the given namespace ns with the requested name pattern ...
Definition: fresh_symbol.cpp:32
side_effect_exprt
An expression containing a side effect.
Definition: std_code.h:1866
codet
Data structure for representing an arbitrary statement in a program.
Definition: std_code.h:35
get_create_array_with_type_name
irep_idt get_create_array_with_type_name()
Returns the symbol name for org.cprover.CProver.createArrayWithType
Definition: create_array_with_type_intrinsic.cpp:21