1 /*
2 * Copyright (c) 2016, 2025, 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_INLINETYPENODE_HPP
26 #define SHARE_VM_OPTO_INLINETYPENODE_HPP
27
28 #include "gc/shared/c2/barrierSetC2.hpp"
29 #include "opto/connode.hpp"
30 #include "opto/loopnode.hpp"
31 #include "opto/node.hpp"
32
33 class GraphKit;
34
35 //------------------------------InlineTypeNode-------------------------------------
36 // Node representing an inline type in C2 IR
37 class InlineTypeNode : public TypeNode {
38 protected:
39 InlineTypeNode(ciInlineKlass* vk, Node* oop, bool null_free)
40 : TypeNode(TypeInstPtr::make(null_free ? TypePtr::NotNull : TypePtr::BotPTR, vk), Values + vk->nof_declared_nonstatic_fields()) {
41 init_class_id(Class_InlineType);
42 init_req(Oop, oop);
43 Compile::current()->add_inline_type(this);
44 _is_larval = false;
45 }
46
47 enum { Control, // Control input.
48 Oop, // Oop to heap allocated buffer.
49 IsBuffered, // True if inline type is heap allocated (or nullptr), false otherwise.
50 IsInit, // Needs to be checked for nullptr before using the field values.
51 Values // Nodes corresponding to values of the inline type's fields.
52 // Nodes are connected in increasing order of the index of the field they correspond to.
53 };
54
55 bool _is_larval;
56
57 virtual uint hash() const { return TypeNode::hash() + _is_larval; }
58 // Don't GVN larvals because the inputs might be updated
59 virtual bool cmp(const Node &n) const { return TypeNode::cmp(n) && !(n.isa_InlineType()->_is_larval || _is_larval); }
60 virtual uint size_of() const { return sizeof(*this); }
61
62 // Get the klass defining the field layout of the inline type
63 ciInlineKlass* inline_klass() const { return type()->inline_klass(); }
64
65 void make_scalar_in_safepoint(PhaseIterGVN* igvn, Unique_Node_List& worklist, SafePointNode* sfpt);
66 uint add_fields_to_safepoint(Unique_Node_List& worklist, Node_List& null_markers, SafePointNode* sfpt);
67
68 const TypePtr* field_adr_type(Node* base, int offset, ciInstanceKlass* holder, DecoratorSet decorators, PhaseGVN& gvn) const;
69
70 // Checks if the inline type fields are all set to default values
71 bool is_default(PhaseGVN* gvn) const;
72
73 // Checks if the inline type oop is an allocated buffer with larval state
74 bool is_larval(PhaseGVN* gvn) const;
75
76 // Checks if the inline type is loaded from memory and if so returns the oop
77 Node* is_loaded(PhaseGVN* phase, ciInlineKlass* vk = nullptr, Node* base = nullptr, int holder_offset = 0);
78
79 // Initialize the inline type fields with the inputs or outputs of a MultiNode
80 void initialize_fields(GraphKit* kit, MultiNode* multi, uint& base_input, bool in, bool null_free, Node* null_check_region, GrowableArray<ciType*>& visited);
81
82 InlineTypeNode* adjust_scalarization_depth_impl(GraphKit* kit, GrowableArray<ciType*>& visited);
83
84 static InlineTypeNode* make_default_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited, bool is_larval = false);
85 static InlineTypeNode* make_from_oop_impl(GraphKit* kit, Node* oop, ciInlineKlass* vk, bool null_free, GrowableArray<ciType*>& visited, bool is_larval = false);
86 static InlineTypeNode* make_null_impl(PhaseGVN& gvn, ciInlineKlass* vk, GrowableArray<ciType*>& visited, bool transform = true);
87 static InlineTypeNode* make_from_flat_impl(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, Node* idx, ciInstanceKlass* holder, int holder_offset, bool atomic, int null_marker_offset, DecoratorSet decorators, GrowableArray<ciType*>& visited);
88
89 void convert_from_payload(GraphKit* kit, BasicType bt, Node* payload, int holder_offset, bool null_free, int null_marker_offset);
90 Node* convert_to_payload(GraphKit* kit, BasicType bt, Node* payload, int holder_offset, bool null_free, int null_marker_offset, int& oop_off_1, int& oop_off_2) const;
91
92 public:
93 // Create with default field values
94 static InlineTypeNode* make_default(PhaseGVN& gvn, ciInlineKlass* vk, bool is_larval = false);
95 // Create uninitialized
96 static InlineTypeNode* make_uninitialized(PhaseGVN& gvn, ciInlineKlass* vk, bool null_free = true);
97 // Create and initialize by loading the field values from an oop
98 static InlineTypeNode* make_from_oop(GraphKit* kit, Node* oop, ciInlineKlass* vk, bool null_free = true, bool is_larval = false);
99 // Create and initialize by loading the field values from a flat field or array
100 static InlineTypeNode* make_from_flat(GraphKit* kit, ciInlineKlass* vk, Node* obj, Node* ptr, Node* idx, ciInstanceKlass* holder = nullptr, int holder_offset = 0,
101 bool atomic = false, int null_marker_offset = -1, DecoratorSet decorators = IN_HEAP | MO_UNORDERED);
102 // Create and initialize with the inputs or outputs of a MultiNode (method entry or call)
103 static InlineTypeNode* make_from_multi(GraphKit* kit, MultiNode* multi, ciInlineKlass* vk, uint& base_input, bool in, bool null_free = true);
104 // Create with null field values
105 static InlineTypeNode* make_null(PhaseGVN& gvn, ciInlineKlass* vk, bool transform = true);
106
107 // Returns the constant oop of the default inline type allocation
108 static Node* default_oop(PhaseGVN& gvn, ciInlineKlass* vk);
109
110 // Support for control flow merges
111 bool has_phi_inputs(Node* region);
112 InlineTypeNode* clone_with_phis(PhaseGVN* gvn, Node* region, SafePointNode* map = nullptr, bool is_init = false);
113 InlineTypeNode* merge_with(PhaseGVN* gvn, const InlineTypeNode* other, int pnum, bool transform);
114 void add_new_path(Node* region);
115
116 // Get oop for heap allocated inline type (may be TypePtr::NULL_PTR)
117 Node* get_oop() const { return in(Oop); }
118 void set_oop(PhaseGVN& gvn, Node* oop) { set_req_X(Oop, oop, &gvn); }
119 Node* get_is_init() const { return in(IsInit); }
120 void set_is_init(PhaseGVN& gvn, bool init = true) { set_req_X(IsInit, gvn.intcon(init ? 1 : 0), &gvn); }
121 Node* get_is_buffered() const { return in(IsBuffered); }
122 void set_is_buffered(PhaseGVN& gvn, bool buffered = true) { set_req_X(IsBuffered, gvn.intcon(buffered ? 1 : 0), &gvn); }
123
124 void set_is_larval(bool is_larval) { _is_larval = is_larval; }
125 bool is_larval() const { return _is_larval; }
126
127 // Inline type fields
128 uint field_count() const { return req() - Values; }
129 Node* field_value(uint index) const;
130 Node* field_value_by_offset(int offset, bool recursive = false, bool search_null_marker = true) const;
131 Node* null_marker_by_offset(int offset, int holder_offset = 0) const;
132 void set_field_value(uint index, Node* value);
133 void set_field_value_by_offset(int offset, Node* value);
134 int field_offset(uint index) const;
135 uint field_index(int offset) const;
136 ciType* field_type(uint index) const;
137 bool field_is_flat(uint index) const;
138 bool field_is_null_free(uint index) const;
139 bool field_is_volatile(uint index) const;
140 int field_null_marker_offset(uint index) const;
141
142 // Replace InlineTypeNodes in debug info at safepoints with SafePointScalarObjectNodes
143 void make_scalar_in_safepoints(PhaseIterGVN* igvn, bool allow_oop = true);
144
145 // Store the inline type as a flat (headerless) representation
146 void store_flat(GraphKit* kit, Node* base, Node* ptr, Node* idx, ciInstanceKlass* holder, int holder_offset, bool atomic, int null_marker_offset, DecoratorSet decorators) const;
147 // Store the field values to memory
148 void store(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, int holder_offset = 0, int offset = -1, DecoratorSet decorators = C2_TIGHTLY_COUPLED_ALLOC | IN_HEAP | MO_UNORDERED) const;
149 // Initialize the inline type by loading its field values from memory
150 void load(GraphKit* kit, Node* base, Node* ptr, ciInstanceKlass* holder, GrowableArray<ciType*>& visited, int holder_offset = 0, DecoratorSet decorators = IN_HEAP | MO_UNORDERED);
151 // Make sure that inline type is fully scalarized
152 InlineTypeNode* adjust_scalarization_depth(GraphKit* kit);
153
154 // Allocates the inline type (if not yet allocated)
155 InlineTypeNode* buffer(GraphKit* kit, bool safe_for_replace = true, bool must_init = true);
156 bool is_allocated(PhaseGVN* phase) const;
157
158 void replace_call_results(GraphKit* kit, CallNode* call, Compile* C);
159 void replace_field_projs(Compile* C, CallNode* call, uint& proj_idx);
160
161 // Allocate all non-flat inline type fields
162 Node* allocate_fields(GraphKit* kit);
163
164 Node* tagged_klass(PhaseGVN& gvn) {
165 return tagged_klass(inline_klass(), gvn);
166 }
167 static Node* tagged_klass(ciInlineKlass* vk, PhaseGVN& gvn);
168 // Pass inline type as fields at a call or return
169 void pass_fields(GraphKit* kit, Node* n, uint& base_input, bool in, bool null_free = true);
170
171 InlineTypeNode* make_larval(GraphKit* kit, bool allocate) const;
172 InlineTypeNode* finish_larval(GraphKit* kit) const;
173
174 // Allocation optimizations
175 void remove_redundant_allocations(PhaseIdealLoop* phase);
176
177 InlineTypeNode* clone_if_required(PhaseGVN* gvn, SafePointNode* map, bool safe_for_replace = true);
178
179 virtual const Type* Value(PhaseGVN* phase) const;
180
181 virtual Node* Ideal(PhaseGVN* phase, bool can_reshape);
182
183 virtual int Opcode() const;
184
185 NOT_PRODUCT(void dump_spec(outputStream* st) const;)
186 };
187
188 #endif // SHARE_VM_OPTO_INLINETYPENODE_HPP