1 /*
2 * Copyright (c) 2005, 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_OPTO_MACRO_HPP
26 #define SHARE_OPTO_MACRO_HPP
27
28 #include "ci/ciInstanceKlass.hpp"
29 #include "opto/callnode.hpp"
30 #include "opto/node.hpp"
31 #include "opto/phase.hpp"
32
33 class AllocateNode;
34 class AllocateArrayNode;
35 class CallNode;
36 class SubTypeCheckNode;
37 class Node;
38 class PhaseIterGVN;
39
40 class PhaseMacroExpand : public Phase {
41 private:
42 PhaseIterGVN &_igvn;
43
44 public:
45 // Helper methods roughly modeled after GraphKit:
46 Node* basic_plus_adr(Node* base, int offset) {
47 return (offset == 0)? base: basic_plus_adr(base, MakeConX(offset));
48 }
49 Node* basic_plus_adr(Node* base, Node* ptr, int offset) {
50 return (offset == 0)? ptr: basic_plus_adr(base, ptr, MakeConX(offset));
51 }
52 Node* basic_plus_adr(Node* base, Node* offset) {
53 return basic_plus_adr(base, base, offset);
54 }
55 Node* basic_plus_adr(Node* base, Node* ptr, Node* offset) {
56 Node* adr = new AddPNode(base, ptr, offset);
57 return transform_later(adr);
58 }
59 Node* transform_later(Node* n) {
60 // equivalent to _gvn.transform in GraphKit, Ideal, etc.
61 _igvn.register_new_node_with_optimizer(n);
62 return n;
63 }
64 Node* make_load( Node* ctl, Node* mem, Node* base, int offset,
65 const Type* value_type, BasicType bt);
66 Node* make_store(Node* ctl, Node* mem, Node* base, int offset,
67 Node* value, BasicType bt);
68
69 Node* make_leaf_call(Node* ctrl, Node* mem,
70 const TypeFunc* call_type, address call_addr,
71 const char* call_name,
72 const TypePtr* adr_type,
73 Node* parm0 = nullptr, Node* parm1 = nullptr,
74 Node* parm2 = nullptr, Node* parm3 = nullptr,
75 Node* parm4 = nullptr, Node* parm5 = nullptr,
76 Node* parm6 = nullptr, Node* parm7 = nullptr);
77
78 address basictype2arraycopy(BasicType t,
79 Node* src_offset,
80 Node* dest_offset,
81 bool disjoint_bases,
82 const char* &name,
83 bool dest_uninitialized);
84
85 private:
86 // projections extracted from a call node
87 CallProjections* _callprojs;
88
89 void expand_allocate(AllocateNode *alloc);
90 void expand_allocate_array(AllocateArrayNode *alloc);
91 void expand_allocate_common(AllocateNode* alloc,
92 Node* length,
93 Node* init_val,
94 const TypeFunc* slow_call_type,
95 address slow_call_address,
96 Node* valid_length_test);
97 void yank_alloc_node(AllocateNode* alloc);
98
99 void process_field_value_at_safepoint(const Type* field_type, Node* field_val, SafePointNode* sfpt, Unique_Node_List* value_worklist);
100 bool add_array_elems_to_safepoint(AllocateNode* alloc, const TypeAryPtr* array_type, SafePointNode* sfpt, Unique_Node_List* value_worklist);
101 bool add_inst_fields_to_safepoint(ciInstanceKlass* iklass, AllocateNode* alloc, Node* base, int offset_minus_header, SafePointNode* sfpt, Unique_Node_List* value_worklist);
102 Node* value_from_mem(Node* mem, Node* ctl, BasicType ft, const Type* ftype, const TypeOopPtr* adr_t, AllocateNode* alloc);
103 Node* value_from_mem_phi(Node* mem, BasicType ft, const Type* ftype, const TypeOopPtr* adr_t, AllocateNode* alloc, Node_Stack* value_phis, int level);
104 Node* inline_type_from_mem(ciInlineKlass* vk, const TypeAryPtr* elem_adr_type, int elem_idx, int offset_in_element, bool null_free, AllocateNode* alloc, SafePointNode* sfpt);
105
106 bool eliminate_boxing_node(CallStaticJavaNode *boxing);
107 bool eliminate_allocate_node(AllocateNode *alloc);
108 void undo_previous_scalarizations(GrowableArray <SafePointNode *> safepoints_done, AllocateNode* alloc);
109 bool scalar_replacement(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints);
110 void process_users_of_allocation(CallNode *alloc, bool inline_alloc = false);
111
112 void eliminate_gc_barrier(Node *p2x);
113 void mark_eliminated_box(Node* box, Node* obj);
114 void mark_eliminated_locking_nodes(AbstractLockNode *alock);
115 bool eliminate_locking_node(AbstractLockNode *alock);
116 void expand_lock_node(LockNode *lock);
117 void expand_unlock_node(UnlockNode *unlock);
118 void expand_mh_intrinsic_return(CallStaticJavaNode* call);
119
120 // More helper methods modeled after GraphKit for array copy
121 void insert_mem_bar(Node** ctrl, Node** mem, int opcode, int alias_idx, Node* precedent = nullptr);
122 Node* array_element_address(Node* ary, Node* idx, BasicType elembt);
123 Node* ConvI2L(Node* offset);
124
125 // helper methods modeled after LibraryCallKit for array copy
126 Node* generate_guard(Node** ctrl, Node* test, RegionNode* region, float true_prob);
127 Node* generate_slow_guard(Node** ctrl, Node* test, RegionNode* region);
128 Node* generate_fair_guard(Node** ctrl, Node* test, RegionNode* region);
129
130 void generate_partial_inlining_block(Node** ctrl, MergeMemNode** mem, const TypePtr* adr_type,
131 RegionNode** exit_block, Node** result_memory, Node* length,
132 Node* src_start, Node* dst_start, BasicType type);
133
134 void generate_negative_guard(Node** ctrl, Node* index, RegionNode* region);
135 void generate_limit_guard(Node** ctrl, Node* offset, Node* subseq_length, Node* array_length, RegionNode* region);
136
137 // More helper methods for array copy
138 Node* generate_nonpositive_guard(Node** ctrl, Node* index, bool never_negative);
139 Node* mark_word_test(Node** ctrl, Node* obj, MergeMemNode* mem, uintptr_t mask_val, RegionNode* region);
140 Node* generate_flat_array_guard(Node** ctrl, Node* array, MergeMemNode* mem, RegionNode* region);
141 Node* generate_null_free_array_guard(Node** ctrl, Node* array, MergeMemNode* mem, RegionNode* region);
142
143 void finish_arraycopy_call(Node* call, Node** ctrl, MergeMemNode** mem, const TypePtr* adr_type);
144 Node* generate_arraycopy(ArrayCopyNode *ac,
145 AllocateArrayNode* alloc,
146 Node** ctrl, MergeMemNode* mem, Node** io,
147 const TypePtr* adr_type,
148 BasicType basic_elem_type,
149 Node* src, Node* src_offset,
150 Node* dest, Node* dest_offset,
151 Node* copy_length,
152 Node* dest_length,
153 bool disjoint_bases = false,
154 bool length_never_negative = false,
155 RegionNode* slow_region = nullptr);
156 void generate_clear_array(Node* ctrl, MergeMemNode* merge_mem,
157 const TypePtr* adr_type,
158 Node* dest,
159 Node* val,
160 Node* raw_val,
161 BasicType basic_elem_type,
162 Node* slice_idx,
163 Node* slice_len,
164 Node* dest_size);
165 bool generate_block_arraycopy(Node** ctrl, MergeMemNode** mem, Node* io,
166 const TypePtr* adr_type,
167 BasicType basic_elem_type,
168 AllocateNode* alloc,
169 Node* src, Node* src_offset,
170 Node* dest, Node* dest_offset,
171 Node* dest_size, bool dest_uninitialized);
172 MergeMemNode* generate_slow_arraycopy(ArrayCopyNode *ac,
173 Node** ctrl, Node* mem, Node** io,
174 const TypePtr* adr_type,
175 Node* src, Node* src_offset,
176 Node* dest, Node* dest_offset,
177 Node* copy_length, bool dest_uninitialized);
178 Node* generate_checkcast_arraycopy(Node** ctrl, MergeMemNode** mem,
179 const TypePtr* adr_type,
180 Node* dest_elem_klass,
181 Node* src, Node* src_offset,
182 Node* dest, Node* dest_offset,
183 Node* copy_length, bool dest_uninitialized);
184 Node* generate_generic_arraycopy(Node** ctrl, MergeMemNode** mem,
185 const TypePtr* adr_type,
186 Node* src, Node* src_offset,
187 Node* dest, Node* dest_offset,
188 Node* copy_length, bool dest_uninitialized);
189 void generate_unchecked_arraycopy(Node** ctrl, MergeMemNode** mem,
190 const TypePtr* adr_type,
191 BasicType basic_elem_type,
192 bool disjoint_bases,
193 Node* src, Node* src_offset,
194 Node* dest, Node* dest_offset,
195 Node* copy_length, bool dest_uninitialized);
196 const TypePtr* adjust_for_flat_array(const TypeAryPtr* top_dest, Node*& src_offset,
197 Node*& dest_offset, Node*& length, BasicType& dest_elem,
198 Node*& dest_length);
199 void expand_arraycopy_node(ArrayCopyNode *ac);
200
201 void expand_subtypecheck_node(SubTypeCheckNode *check);
202
203 void expand_flatarraycheck_node(FlatArrayCheckNode* check);
204
205 int replace_input(Node *use, Node *oldref, Node *newref);
206 void migrate_outs(Node *old, Node *target);
207 Node* opt_bits_test(Node* ctrl, Node* region, int edge, Node* word, int mask, int bits, bool return_fast_path = false);
208 void copy_predefined_input_for_runtime_call(Node * ctrl, CallNode* oldcall, CallNode* call);
209 CallNode* make_slow_call(CallNode *oldcall, const TypeFunc* slow_call_type, address slow_call,
210 const char* leaf_name, Node* slow_path, Node* parm0, Node* parm1,
211 Node* parm2);
212
213 Node* initialize_object(AllocateNode* alloc,
214 Node* control, Node* rawmem, Node* object,
215 Node* klass_node, Node* length,
216 Node* size_in_bytes);
217
218 Node* make_arraycopy_load(ArrayCopyNode* ac, intptr_t offset, Node* ctl, Node* mem, BasicType ft, const Type *ftype, AllocateNode *alloc);
219
220 public:
221 PhaseMacroExpand(PhaseIterGVN &igvn) : Phase(Macro_Expand), _igvn(igvn) {
222 _igvn.set_delay_transform(true);
223 }
224 void eliminate_macro_nodes();
225 bool expand_macro_nodes();
226
227 SafePointScalarObjectNode* create_scalarized_object_description(AllocateNode *alloc, SafePointNode* sfpt, Unique_Node_List* value_worklist);
228 static bool can_eliminate_allocation(PhaseIterGVN *igvn, AllocateNode *alloc, GrowableArray <SafePointNode *> *safepoints);
229
230
231 PhaseIterGVN &igvn() const { return _igvn; }
232
233 #ifndef PRODUCT
234 static int _objs_scalar_replaced_counter;
235 static int _monitor_objects_removed_counter;
236 static int _GC_barriers_removed_counter;
237 static int _memory_barriers_removed_counter;
238 static void print_statistics();
239 static int count_MemBar(Compile *C);
240 #endif
241
242 // Members accessed from BarrierSetC2
243 void replace_node(Node* source, Node* target) { _igvn.replace_node(source, target); }
244 Node* intcon(jint con) const { return _igvn.intcon(con); }
245 Node* longcon(jlong con) const { return _igvn.longcon(con); }
246 Node* makecon(const Type *t) const { return _igvn.makecon(t); }
247 Node* zerocon(BasicType bt) const { return _igvn.zerocon(bt); }
248 Node* top() const { return C->top(); }
249
250 Node* prefetch_allocation(Node* i_o,
251 Node*& needgc_false, Node*& contended_phi_rawmem,
252 Node* old_eden_top, Node* new_eden_top,
253 intx lines);
254 void expand_dtrace_alloc_probe(AllocateNode* alloc, Node* fast_oop, Node*&fast_oop_ctrl, Node*&fast_oop_rawmem);
255 void expand_initialize_membar(AllocateNode* alloc, InitializeNode* init, Node*&fast_oop_ctrl, Node*&fast_oop_rawmem);
256 };
257
258 #endif // SHARE_OPTO_MACRO_HPP