1 /*
2 * Copyright (c) 2005, 2019, 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 "opto/phase.hpp"
29
30 class AllocateNode;
31 class AllocateArrayNode;
32 class CallNode;
33 class Node;
34 class PhaseIterGVN;
35
36 class PhaseMacroExpand : public Phase {
37 private:
38 PhaseIterGVN &_igvn;
39
40 public:
41 // Helper methods roughly modeled after GraphKit:
42 Node* basic_plus_adr(Node* base, int offset) {
43 return (offset == 0)? base: basic_plus_adr(base, MakeConX(offset));
44 }
45 Node* basic_plus_adr(Node* base, Node* ptr, int offset) {
46 return (offset == 0)? ptr: basic_plus_adr(base, ptr, MakeConX(offset));
47 }
48 Node* basic_plus_adr(Node* base, Node* offset) {
49 return basic_plus_adr(base, base, offset);
50 }
51 Node* basic_plus_adr(Node* base, Node* ptr, Node* offset) {
52 Node* adr = new AddPNode(base, ptr, offset);
53 return transform_later(adr);
54 }
55 Node* transform_later(Node* n) {
56 // equivalent to _gvn.transform in GraphKit, Ideal, etc.
57 _igvn.register_new_node_with_optimizer(n);
58 return n;
59 }
60 void set_eden_pointers(Node* &eden_top_adr, Node* &eden_end_adr);
61 Node* make_load( Node* ctl, Node* mem, Node* base, int offset,
62 const Type* value_type, BasicType bt);
63 Node* make_store(Node* ctl, Node* mem, Node* base, int offset,
64 Node* value, BasicType bt);
65
66 private:
67 // projections extracted from a call node
68 ProjNode *_fallthroughproj;
69 ProjNode *_fallthroughcatchproj;
70 ProjNode *_ioproj_fallthrough;
71 ProjNode *_ioproj_catchall;
72 ProjNode *_catchallcatchproj;
73 ProjNode *_memproj_fallthrough;
74 ProjNode *_memproj_catchall;
75 ProjNode *_resproj;
76
77 // Additional data collected during macro expansion
78 bool _has_locks;
79
80 void expand_allocate(AllocateNode *alloc);
81 void expand_allocate_array(AllocateArrayNode *alloc);
82 void expand_allocate_common(AllocateNode* alloc,
83 Node* length,
84 const TypeFunc* slow_call_type,
85 address slow_call_address);
86 Node *value_from_mem(Node *mem, Node *ctl, BasicType ft, const Type *ftype, const TypeOopPtr *adr_t, AllocateNode *alloc);
87 Node *value_from_mem_phi(Node *mem, BasicType ft, const Type *ftype, const TypeOopPtr *adr_t, AllocateNode *alloc, Node_Stack *value_phis, int level);
88 Node* value_type_from_mem(Node* mem, Node* ctl, ciValueKlass* vk, const TypeAryPtr* adr_type, int offset, AllocateNode* alloc);
89
90 bool eliminate_boxing_node(CallStaticJavaNode *boxing);
91 bool eliminate_allocate_node(AllocateNode *alloc);
92 bool can_eliminate_allocation(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints);
93 bool scalar_replacement(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints_done);
94 void process_users_of_allocation(CallNode *alloc);
95
96 void eliminate_gc_barrier(Node *p2x);
97 void mark_eliminated_box(Node* box, Node* obj);
98 void mark_eliminated_locking_nodes(AbstractLockNode *alock);
99 bool eliminate_locking_node(AbstractLockNode *alock);
100 void expand_lock_node(LockNode *lock);
101 void expand_unlock_node(UnlockNode *unlock);
102 void expand_mh_intrinsic_return(CallStaticJavaNode* call);
103
104 // More helper methods modeled after GraphKit for array copy
105 void insert_mem_bar(Node** ctrl, Node** mem, int opcode, Node* precedent = NULL);
106 Node* array_element_address(Node* ary, Node* idx, BasicType elembt);
107 Node* ConvI2L(Node* offset);
108 Node* make_leaf_call(Node* ctrl, Node* mem,
109 const TypeFunc* call_type, address call_addr,
110 const char* call_name,
111 const TypePtr* adr_type,
112 Node* parm0 = NULL, Node* parm1 = NULL,
113 Node* parm2 = NULL, Node* parm3 = NULL,
114 Node* parm4 = NULL, Node* parm5 = NULL,
115 Node* parm6 = NULL, Node* parm7 = NULL);
116
117 // helper methods modeled after LibraryCallKit for array copy
118 Node* generate_guard(Node** ctrl, Node* test, RegionNode* region, float true_prob);
119 Node* generate_slow_guard(Node** ctrl, Node* test, RegionNode* region);
120 Node* generate_fair_guard(Node** ctrl, Node* test, RegionNode* region);
121 void generate_negative_guard(Node** ctrl, Node* index, RegionNode* region);
122 void generate_limit_guard(Node** ctrl, Node* offset, Node* subseq_length, Node* array_length, RegionNode* region);
123
124 // More helper methods for array copy
125 Node* generate_nonpositive_guard(Node** ctrl, Node* index, bool never_negative);
126 Node* generate_flattened_array_guard(Node** ctrl, Node* mem, Node* obj, RegionNode* region);
127 Node* generate_object_array_guard(Node** ctrl, Node* mem, Node* obj, RegionNode* region);
128 Node* generate_array_guard(Node** ctrl, Node* mem, Node* obj, RegionNode* region, jint lh_con);
129
130 void finish_arraycopy_call(Node* call, Node** ctrl, MergeMemNode** mem, const TypePtr* adr_type);
131 address basictype2arraycopy(BasicType t,
132 Node* src_offset,
133 Node* dest_offset,
134 bool disjoint_bases,
135 const char* &name,
136 bool dest_uninitialized);
137 Node* generate_arraycopy(ArrayCopyNode *ac,
138 AllocateArrayNode* alloc,
139 Node** ctrl, MergeMemNode* mem, Node** io,
140 const TypePtr* adr_type,
141 BasicType basic_elem_type,
142 Node* src, Node* src_offset,
143 Node* dest, Node* dest_offset,
144 Node* copy_length,
145 Node* dest_length,
146 bool disjoint_bases = false,
147 bool length_never_negative = false,
148 RegionNode* slow_region = NULL);
149 void generate_clear_array(Node* ctrl, MergeMemNode* merge_mem,
150 const TypePtr* adr_type,
151 Node* dest,
152 Node* val,
153 Node* raw_val,
154 BasicType basic_elem_type,
155 Node* slice_idx,
156 Node* slice_len,
157 Node* dest_size);
158 bool generate_block_arraycopy(Node** ctrl, MergeMemNode** mem, Node* io,
159 const TypePtr* adr_type,
160 BasicType basic_elem_type,
161 AllocateNode* alloc,
162 Node* src, Node* src_offset,
163 Node* dest, Node* dest_offset,
164 Node* dest_size, bool dest_uninitialized);
165 MergeMemNode* generate_slow_arraycopy(ArrayCopyNode *ac,
166 Node** ctrl, Node* mem, Node** io,
167 const TypePtr* adr_type,
168 Node* src, Node* src_offset,
169 Node* dest, Node* dest_offset,
170 Node* copy_length, bool dest_uninitialized);
171 Node* generate_checkcast_arraycopy(Node** ctrl, MergeMemNode** mem,
172 const TypePtr* adr_type,
173 Node* dest_elem_klass,
174 Node* src, Node* src_offset,
175 Node* dest, Node* dest_offset,
176 Node* copy_length, bool dest_uninitialized);
177 Node* generate_generic_arraycopy(Node** ctrl, MergeMemNode** mem,
178 const TypePtr* adr_type,
179 Node* src, Node* src_offset,
180 Node* dest, Node* dest_offset,
181 Node* copy_length, bool dest_uninitialized);
182 void generate_unchecked_arraycopy(Node** ctrl, MergeMemNode** mem,
183 const TypePtr* adr_type,
184 BasicType basic_elem_type,
185 bool disjoint_bases,
186 Node* src, Node* src_offset,
187 Node* dest, Node* dest_offset,
188 Node* copy_length, bool dest_uninitialized);
189 const TypePtr* adjust_parameters_for_vt(const TypeAryPtr* top_dest, Node*& src_offset,
190 Node*& dest_offset, Node*& length, BasicType& dest_elem,
191 Node*& dest_length);
192 void expand_arraycopy_node(ArrayCopyNode *ac);
193
194 int replace_input(Node *use, Node *oldref, Node *newref);
195 Node* opt_bits_test(Node* ctrl, Node* region, int edge, Node* word, int mask, int bits, bool return_fast_path = false);
196 void copy_predefined_input_for_runtime_call(Node * ctrl, CallNode* oldcall, CallNode* call);
197 CallNode* make_slow_call(CallNode *oldcall, const TypeFunc* slow_call_type, address slow_call,
198 const char* leaf_name, Node* slow_path, Node* parm0, Node* parm1,
199 Node* parm2);
200 void extract_call_projections(CallNode *call);
201
202 Node* initialize_object(AllocateNode* alloc,
203 Node* control, Node* rawmem, Node* object,
204 Node* klass_node, Node* length,
205 Node* size_in_bytes);
206
207 Node* make_arraycopy_load(ArrayCopyNode* ac, intptr_t offset, Node* ctl, Node* mem, BasicType ft, const Type *ftype, AllocateNode *alloc);
208
209 bool can_try_zeroing_elimination(AllocateArrayNode* alloc, Node* src, Node* dest) const;
210
211 public:
212 PhaseMacroExpand(PhaseIterGVN &igvn) : Phase(Macro_Expand), _igvn(igvn), _has_locks(false) {
213 _igvn.set_delay_transform(true);
214 }
215 void eliminate_macro_nodes();
216 bool expand_macro_nodes();
217
218 PhaseIterGVN &igvn() const { return _igvn; }
219
220 // Members accessed from BarrierSetC2
221 void replace_node(Node* source, Node* target) { _igvn.replace_node(source, target); }
222 Node* intcon(jint con) const { return _igvn.intcon(con); }
223 Node* longcon(jlong con) const { return _igvn.longcon(con); }
224 Node* makecon(const Type *t) const { return _igvn.makecon(t); }
225 Node* top() const { return C->top(); }
226
227 Node* prefetch_allocation(Node* i_o,
228 Node*& needgc_false, Node*& contended_phi_rawmem,
229 Node* old_eden_top, Node* new_eden_top,
230 intx lines);
231 };
232
233 #endif // SHARE_OPTO_MACRO_HPP