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  SubTypeCheckNode;
34 class  Node;
35 class  PhaseIterGVN;
36 
37 class PhaseMacroExpand : public Phase {
38 private:
39   PhaseIterGVN &_igvn;
40 
41 public:
42   // Helper methods roughly modeled after GraphKit:
basic_plus_adr(Node * base,int offset)43   Node* basic_plus_adr(Node* base, int offset) {
44     return (offset == 0)? base: basic_plus_adr(base, MakeConX(offset));
45   }
basic_plus_adr(Node * base,Node * ptr,int offset)46   Node* basic_plus_adr(Node* base, Node* ptr, int offset) {
47     return (offset == 0)? ptr: basic_plus_adr(base, ptr, MakeConX(offset));
48   }
basic_plus_adr(Node * base,Node * offset)49   Node* basic_plus_adr(Node* base, Node* offset) {
50     return basic_plus_adr(base, base, offset);
51   }
basic_plus_adr(Node * base,Node * ptr,Node * offset)52   Node* basic_plus_adr(Node* base, Node* ptr, Node* offset) {
53     Node* adr = new AddPNode(base, ptr, offset);
54     return transform_later(adr);
55   }
transform_later(Node * n)56   Node* transform_later(Node* n) {
57     // equivalent to _gvn.transform in GraphKit, Ideal, etc.
58     _igvn.register_new_node_with_optimizer(n);
59     return n;
60   }
61   void set_eden_pointers(Node* &eden_top_adr, Node* &eden_end_adr);
62   Node* make_load( Node* ctl, Node* mem, Node* base, int offset,
63                    const Type* value_type, BasicType bt);
64   Node* make_store(Node* ctl, Node* mem, Node* base, int offset,
65                    Node* value, BasicType bt);
66 
67   Node* make_leaf_call(Node* ctrl, Node* mem,
68                        const TypeFunc* call_type, address call_addr,
69                        const char* call_name,
70                        const TypePtr* adr_type,
71                        Node* parm0 = NULL, Node* parm1 = NULL,
72                        Node* parm2 = NULL, Node* parm3 = NULL,
73                        Node* parm4 = NULL, Node* parm5 = NULL,
74                        Node* parm6 = NULL, Node* parm7 = NULL);
75 
76   address basictype2arraycopy(BasicType t,
77                               Node* src_offset,
78                               Node* dest_offset,
79                               bool disjoint_bases,
80                               const char* &name,
81                               bool dest_uninitialized);
82 
83 private:
84   // projections extracted from a call node
85   ProjNode *_fallthroughproj;
86   ProjNode *_fallthroughcatchproj;
87   ProjNode *_ioproj_fallthrough;
88   ProjNode *_ioproj_catchall;
89   ProjNode *_catchallcatchproj;
90   ProjNode *_memproj_fallthrough;
91   ProjNode *_memproj_catchall;
92   ProjNode *_resproj;
93 
94   // Additional data collected during macro expansion
95   bool _has_locks;
96 
97   void expand_allocate(AllocateNode *alloc);
98   void expand_allocate_array(AllocateArrayNode *alloc);
99   void expand_allocate_common(AllocateNode* alloc,
100                               Node* length,
101                               const TypeFunc* slow_call_type,
102                               address slow_call_address);
103   void yank_initalize_node(InitializeNode* node);
104   void yank_alloc_node(AllocateNode* alloc);
105   Node *value_from_mem(Node *mem, Node *ctl, BasicType ft, const Type *ftype, const TypeOopPtr *adr_t, AllocateNode *alloc);
106   Node *value_from_mem_phi(Node *mem, BasicType ft, const Type *ftype, const TypeOopPtr *adr_t, AllocateNode *alloc, Node_Stack *value_phis, int level);
107 
108   bool eliminate_boxing_node(CallStaticJavaNode *boxing);
109   bool eliminate_allocate_node(AllocateNode *alloc);
110   bool can_eliminate_allocation(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints);
111   bool scalar_replacement(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints_done);
112   void process_users_of_allocation(CallNode *alloc);
113 
114   void eliminate_gc_barrier(Node *p2x);
115   void mark_eliminated_box(Node* box, Node* obj);
116   void mark_eliminated_locking_nodes(AbstractLockNode *alock);
117   bool eliminate_locking_node(AbstractLockNode *alock);
118   void expand_lock_node(LockNode *lock);
119   void expand_unlock_node(UnlockNode *unlock);
120 
121   // More helper methods modeled after GraphKit for array copy
122   void insert_mem_bar(Node** ctrl, Node** mem, int opcode, Node* precedent = NULL);
123   Node* array_element_address(Node* ary, Node* idx, BasicType elembt);
124   Node* ConvI2L(Node* offset);
125 
126   // helper methods modeled after LibraryCallKit for array copy
127   Node* generate_guard(Node** ctrl, Node* test, RegionNode* region, float true_prob);
128   Node* generate_slow_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   void finish_arraycopy_call(Node* call, Node** ctrl, MergeMemNode** mem, const TypePtr* adr_type);
140   Node* generate_arraycopy(ArrayCopyNode *ac,
141                            AllocateArrayNode* alloc,
142                            Node** ctrl, MergeMemNode* mem, Node** io,
143                            const TypePtr* adr_type,
144                            BasicType basic_elem_type,
145                            Node* src,  Node* src_offset,
146                            Node* dest, Node* dest_offset,
147                            Node* copy_length,
148                            bool disjoint_bases = false,
149                            bool length_never_negative = false,
150                            RegionNode* slow_region = NULL);
151   void generate_clear_array(Node* ctrl, MergeMemNode* merge_mem,
152                             const TypePtr* adr_type,
153                             Node* dest,
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   bool 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 
190   void expand_arraycopy_node(ArrayCopyNode *ac);
191 
192   void expand_subtypecheck_node(SubTypeCheckNode *check);
193 
194   int replace_input(Node *use, Node *oldref, Node *newref);
195   void migrate_outs(Node *old, Node *target);
196   void copy_call_debug_info(CallNode *oldcall, CallNode * newcall);
197   Node* opt_bits_test(Node* ctrl, Node* region, int edge, Node* word, int mask, int bits, bool return_fast_path = false);
198   void copy_predefined_input_for_runtime_call(Node * ctrl, CallNode* oldcall, CallNode* call);
199   CallNode* make_slow_call(CallNode *oldcall, const TypeFunc* slow_call_type, address slow_call,
200                            const char* leaf_name, Node* slow_path, Node* parm0, Node* parm1,
201                            Node* parm2);
202   void extract_call_projections(CallNode *call);
203 
204   Node* initialize_object(AllocateNode* alloc,
205                           Node* control, Node* rawmem, Node* object,
206                           Node* klass_node, Node* length,
207                           Node* size_in_bytes);
208 
209   Node* make_arraycopy_load(ArrayCopyNode* ac, intptr_t offset, Node* ctl, Node* mem, BasicType ft, const Type *ftype, AllocateNode *alloc);
210 
211 public:
PhaseMacroExpand(PhaseIterGVN & igvn)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 
igvn() const218   PhaseIterGVN &igvn() const { return _igvn; }
219 
220   // Members accessed from BarrierSetC2
replace_node(Node * source,Node * target)221   void replace_node(Node* source, Node* target) { _igvn.replace_node(source, target); }
intcon(jint con) const222   Node* intcon(jint con)        const { return _igvn.intcon(con); }
longcon(jlong con) const223   Node* longcon(jlong con)      const { return _igvn.longcon(con); }
makecon(const Type * t) const224   Node* makecon(const Type *t)  const { return _igvn.makecon(t); }
top() const225   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   void expand_dtrace_alloc_probe(AllocateNode* alloc, Node* fast_oop, Node*&fast_oop_ctrl, Node*&fast_oop_rawmem);
232   void expand_initialize_membar(AllocateNode* alloc, InitializeNode* init, Node*&fast_oop_ctrl, Node*&fast_oop_rawmem);
233 };
234 
235 #endif // SHARE_OPTO_MACRO_HPP
236