1 /*
2 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #ifndef SHARE_VM_OPTO_VALUETYPENODE_HPP
26 #define SHARE_VM_OPTO_VALUETYPENODE_HPP
27
28 #include "opto/node.hpp"
29 #include "opto/connode.hpp"
30
31 class GraphKit;
32
33 //------------------------------ValueTypeNode-------------------------------------
34 // Node representing a value type in C2 IR
35 class ValueTypeNode : public TypeNode {
36 private:
37 ValueTypeNode(const TypeValueType* t, Node* oop)
38 : TypeNode(t, Values + t->value_klass()->nof_declared_nonstatic_fields()) {
39 init_class_id(Class_ValueType);
40 init_req(Oop, oop);
41 }
42
43 ValueTypeNode(const TypeValueType* t, Node* oop, int field_count)
44 : TypeNode(t, Values + field_count) {
45 init_class_id(Class_ValueType);
46 init_req(Oop, oop);
47 }
48
49 // Get the klass defining the field layout of the value type
50 ciValueKlass* value_klass() const { return type()->is_valuetype()->value_klass(); }
51 // Initialize the value type by loading its field values from memory
52 void load_values(PhaseGVN& gvn, Node* mem, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0);
53
54 enum { Control, // Control input
55 Oop, // Oop of TypeValueTypePtr
56 Values // Nodes corresponding to values of the value type's fields.
57 // Nodes are connected in increasing order of the index of the field
58 // they correspond to. Field indeces are defined in ciValueKlass::_field_index_map.
59 };
60
61 public:
62 // Create a new ValueTypeNode with uninitialized values
63 static ValueTypeNode* make(PhaseGVN& gvn, ciValueKlass* klass);
64 // Create a new ValueTypeNode with default values
65 static Node* make_default(PhaseGVN& gvn, ciValueKlass* vk);
66 // Create a new ValueTypeNode and load its values from an oop
67 static Node* make(PhaseGVN& gvn, Node* mem, Node* oop);
68 // Create a new ValueTypeNode and load its values from a flattened value type field or array
69 static Node* make(PhaseGVN& gvn, ciValueKlass* vk, Node* mem, Node* obj, Node* ptr, ciInstanceKlass* holder = NULL, int holder_offset = 0);
70
71 // Support for control flow merges
72 ValueTypeNode* clone_with_phis(PhaseGVN* gvn, Node* region);
73 bool has_phi_inputs(Node* region);
74 ValueTypeNode* merge_with(PhaseGVN* gvn, const ValueTypeNode* other, int pnum, bool transform);
75
76 // Store the value type to memory if not yet allocated and returns the oop
77 Node* store_to_memory(GraphKit* kit);
78 // Store the value type to a flattened value type field or array
79 void store(GraphKit* kit, Node* obj, Node* ptr, ciInstanceKlass* holder = NULL, int holder_offset = 0) const;
80 // Store the field values to memory
81 void store_values(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0) const;
82
83 // Get oop for heap allocated value type (may be TypePtr::NULL_PTR)
84 Node* get_oop() const { return in(Oop); }
85 void set_oop(Node* oop) { set_req(Oop, oop); }
86
87 // Value type fields
88 uint field_count() const { return req() - Values; }
89 Node* field_value(uint index) const;
90 Node* field_value_by_offset(int offset, bool recursive = false) const;
91 void set_field_value(uint index, Node* value);
92 int field_offset(uint index) const;
93 ciType* field_type(uint index) const;
94
95 // Replace ValueTypeNodes in debug info at safepoints with SafePointScalarObjectNodes
96 void make_scalar_in_safepoints(Compile* C);
97 void pass_klass(Node* n, uint pos, const GraphKit& kit);
98 uint pass_fields(Node* call, int base_input, const GraphKit& kit, ciValueKlass* base_vk = NULL, int base_offset = 0);
99 void replace_call_results(Node* call, Compile* C);
100
101
102 virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
103 virtual int Opcode() const;
104
105 #ifndef PRODUCT
106 virtual void dump_spec(outputStream* st) const;
107 #endif
108 };
109
110 #endif // SHARE_VM_OPTO_VALUETYPENODE_HPP