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 class ValueTypeBaseNode : public TypeNode {
34 protected:
35 ValueTypeBaseNode(const Type* t, int nb_fields)
36 : TypeNode(t, nb_fields) {
37 init_class_id(Class_ValueTypeBase);
38 Compile::current()->add_value_type(this);
39 }
40
41 enum { Control, // Control input
42 Oop, // Oop of TypeValueTypePtr
43 Values // Nodes corresponding to values of the value type's fields.
44 // Nodes are connected in increasing order of the index of the field they correspond to.
45 };
46
47 virtual const TypeValueTypePtr* value_type_ptr() const = 0;
48 // Get the klass defining the field layout of the value type
49 virtual ciValueKlass* value_klass() const = 0;
50
51 int make_scalar_in_safepoint(Unique_Node_List& worklist, SafePointNode* sfpt, Node* root, PhaseGVN* gvn);
52
53 // Initialize the value type fields with the inputs or outputs of a MultiNode
54 void initialize(PhaseGVN* gvn, Node*& ctl, Node* mem, MultiNode* multi, ciValueKlass* vk, int base_offset = 0, int base_input = TypeFunc::Parms+1, bool in = false);
55
56 public:
57 // Support for control flow merges
58 bool has_phi_inputs(Node* region);
59 ValueTypeBaseNode* clone_with_phis(PhaseGVN* gvn, Node* region);
60 ValueTypeBaseNode* merge_with(PhaseGVN* gvn, const ValueTypeBaseNode* other, int pnum, bool transform);
61
62 // Get oop for heap allocated value type (may be TypePtr::NULL_PTR)
63 Node* get_oop() const { return in(Oop); }
64 void set_oop(Node* oop) { set_req(Oop, oop); }
65
66 // Value type fields
67 uint field_count() const { return req() - Values; }
68 Node* field_value(uint index) const;
69 Node* field_value_by_offset(int offset, bool recursive = false) const;
70 void set_field_value(uint index, Node* value);
71 int field_offset(uint index) const;
72 ciType* field_type(uint index) const;
73 bool field_is_flattened(uint index) const;
74
75 // Replace ValueTypeNodes in debug info at safepoints with SafePointScalarObjectNodes
76 void make_scalar_in_safepoints(Node* root, PhaseGVN* gvn);
77
78 // Store the value type as a flattened (headerless) representation
79 void store_flattened(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder = NULL, int holder_offset = 0) const;
80 // Store the field values to memory
81 void store(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0) const;
82 // Initialize the value type by loading its field values from memory
83 void load(PhaseGVN& gvn, Node*& ctl, Node* mem, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0);
84
85 // Allocates the value type (if not yet allocated)
86 ValueTypeBaseNode* allocate(GraphKit* kit);
87 bool is_allocated(PhaseGVN* phase) const;
88
89 void replace_call_results(GraphKit* kit, Node* call, Compile* C);
90 };
91
92 //------------------------------ValueTypeNode-------------------------------------
93 // Node representing a value type in C2 IR
94 class ValueTypeNode : public ValueTypeBaseNode {
95 friend class ValueTypeBaseNode;
96 friend class ValueTypePtrNode;
97 private:
98 ValueTypeNode(const TypeValueType* t, Node* oop)
99 : ValueTypeBaseNode(t, Values + t->value_klass()->nof_declared_nonstatic_fields()) {
100 init_class_id(Class_ValueType);
101 init_req(Oop, oop);
102 }
103
104 // Checks if the value type is loaded from memory and if so returns the oop
105 Node* is_loaded(PhaseGVN* phase, ciValueKlass* vk = NULL, Node* base = NULL, int holder_offset = 0);
106
107 const TypeValueTypePtr* value_type_ptr() const { return TypeValueTypePtr::make(TypePtr::BotPTR, value_klass()); }
108 ciValueKlass* value_klass() const { return type()->is_valuetype()->value_klass(); }
109
110 public:
111 // Create uninitialized
112 static ValueTypeNode* make_uninitialized(PhaseGVN& gvn, ciValueKlass* klass);
113 // Create with default field values
114 static ValueTypeNode* make_default(PhaseGVN& gvn, ciValueKlass* vk);
115 // Create and initialize by loading the field values from an oop
116 static ValueTypeNode* make_from_oop(GraphKit* kit, Node* oop, bool null_check = false);
117 static ValueTypeNode* make_from_oop(PhaseGVN& gvn, Node*& ctl, Node* mem, Node* oop, bool null_check = false);
118 // Create and initialize by loading the field values from a flattened field or array
119 static ValueTypeNode* make_from_flattened(GraphKit* kit, ciValueKlass* vk, Node* obj, Node* ptr, ciInstanceKlass* holder = NULL, int holder_offset = 0);
120 static ValueTypeNode* make_from_flattened(PhaseGVN& gvn, ciValueKlass* vk, Node*& ctl, Node* mem, Node* obj, Node* ptr, ciInstanceKlass* holder = NULL, int holder_offset = 0);
121 // Create and initialize with the inputs or outputs of a MultiNode (method entry or call)
122 static ValueTypeNode* make_from_multi(PhaseGVN& gvn, Node*& ctl, Node* mem, MultiNode* multi, ciValueKlass* vk, int base_input, bool in);
123
124 // Allocate all non-flattened value type fields
125 Node* allocate_fields(GraphKit* kit);
126
127 Node* tagged_klass(PhaseGVN& gvn);
128 void pass_klass(Node* n, uint pos, const GraphKit& kit);
129 uint pass_fields(Node* call, int base_input, GraphKit& kit, bool assert_allocated = false, ciValueKlass* base_vk = NULL, int base_offset = 0);
130
131 // Allocation optimizations
132 void remove_redundant_allocations(PhaseIterGVN* igvn, PhaseIdealLoop* phase);
133
134 virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
135 virtual int Opcode() const;
136 };
137
138 //------------------------------ValueTypePtrNode-------------------------------------
139 // Node representing a value type as a pointer in C2 IR
140 class ValueTypePtrNode : public ValueTypeBaseNode {
141 private:
142 const TypeValueTypePtr* value_type_ptr() const { return type()->isa_valuetypeptr(); }
143 ciValueKlass* value_klass() const { return value_type_ptr()->value_klass(); }
144
145 ValueTypePtrNode(ciValueKlass* vk, Node* oop)
146 : ValueTypeBaseNode(TypeValueTypePtr::make(TypePtr::NotNull, vk), Values + vk->nof_declared_nonstatic_fields()) {
147 init_class_id(Class_ValueTypePtr);
148 init_req(Oop, oop);
149 }
150
151 public:
152 // Create and initialize with the values of a ValueTypeNode
153 static ValueTypePtrNode* make_from_value_type(PhaseGVN& gvn, ValueTypeNode* vt);
154 // Create and initialize with the result values of a call
155 static ValueTypePtrNode* make_from_call(GraphKit* kit, ciValueKlass* vk, CallNode* call);
156 // Create and initialize by loading the field values from an oop
157 static ValueTypePtrNode* make_from_oop(PhaseGVN& gvn, Node*& ctl, Node* mem, Node* oop);
158
159 virtual int Opcode() const;
160 };
161
162 #endif // SHARE_VM_OPTO_VALUETYPENODE_HPP