1 /*
  2  * Copyright (c) 2005, 2015, 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_MACRO_HPP
 26 #define SHARE_VM_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 
 89   bool eliminate_boxing_node(CallStaticJavaNode *boxing);
 90   bool eliminate_allocate_node(AllocateNode *alloc);
 91   bool can_eliminate_allocation(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints);
 92   bool scalar_replacement(AllocateNode *alloc, GrowableArray <SafePointNode *>& safepoints_done);
 93   void process_users_of_allocation(CallNode *alloc);
 94 
 95   void eliminate_gc_barrier(Node *p2x);
 96   void mark_eliminated_box(Node* box, Node* obj);
 97   void mark_eliminated_locking_nodes(AbstractLockNode *alock);
 98   bool eliminate_locking_node(AbstractLockNode *alock);
 99   void expand_lock_node(LockNode *lock);
100   void expand_unlock_node(UnlockNode *unlock);
101 
102   // More helper methods modeled after GraphKit for array copy
103   void insert_mem_bar(Node** ctrl, Node** mem, int opcode, Node* precedent = NULL);
104   Node* array_element_address(Node* ary, Node* idx, BasicType elembt);
105   Node* ConvI2L(Node* offset);
106   Node* make_leaf_call(Node* ctrl, Node* mem,
107                        const TypeFunc* call_type, address call_addr,
108                        const char* call_name,
109                        const TypePtr* adr_type,
110                        Node* parm0 = NULL, Node* parm1 = NULL,
111                        Node* parm2 = NULL, Node* parm3 = NULL,
112                        Node* parm4 = NULL, Node* parm5 = NULL,
113                        Node* parm6 = NULL, Node* parm7 = NULL);
114 
115   // helper methods modeled after LibraryCallKit for array copy
116   Node* generate_guard(Node** ctrl, Node* test, RegionNode* region, float true_prob);
117   Node* generate_slow_guard(Node** ctrl, Node* test, RegionNode* region);
118   void generate_negative_guard(Node** ctrl, Node* index, RegionNode* region);
119   void generate_limit_guard(Node** ctrl, Node* offset, Node* subseq_length, Node* array_length, RegionNode* region);
120 
121   // More helper methods for array copy
122   Node* generate_nonpositive_guard(Node** ctrl, Node* index, bool never_negative);
123   void finish_arraycopy_call(Node* call, Node** ctrl, MergeMemNode** mem, const TypePtr* adr_type);
124   address basictype2arraycopy(BasicType t,
125                               Node* src_offset,
126                               Node* dest_offset,
127                               bool disjoint_bases,
128                               const char* &name,
129                               bool dest_uninitialized);
130   Node* generate_arraycopy(ArrayCopyNode *ac,
131                            AllocateArrayNode* alloc,
132                            Node** ctrl, MergeMemNode* mem, Node** io,
133                            const TypePtr* adr_type,
134                            BasicType basic_elem_type,
135                            Node* src,  Node* src_offset,
136                            Node* dest, Node* dest_offset,
137                            Node* copy_length,
138                            bool disjoint_bases = false,
139                            bool length_never_negative = false,
140                            RegionNode* slow_region = NULL);
141   void generate_clear_array(Node* ctrl, MergeMemNode* merge_mem,
142                             const TypePtr* adr_type,
143                             Node* dest,
144                             BasicType basic_elem_type,
145                             Node* slice_idx,
146                             Node* slice_len,
147                             Node* dest_size);
148   bool generate_block_arraycopy(Node** ctrl, MergeMemNode** mem, Node* io,
149                                 const TypePtr* adr_type,
150                                 BasicType basic_elem_type,
151                                 AllocateNode* alloc,
152                                 Node* src,  Node* src_offset,
153                                 Node* dest, Node* dest_offset,
154                                 Node* dest_size, bool dest_uninitialized);
155   MergeMemNode* generate_slow_arraycopy(ArrayCopyNode *ac,
156                                         Node** ctrl, Node* mem, Node** io,
157                                         const TypePtr* adr_type,
158                                         Node* src,  Node* src_offset,
159                                         Node* dest, Node* dest_offset,
160                                         Node* copy_length, bool dest_uninitialized);
161   Node* generate_checkcast_arraycopy(Node** ctrl, MergeMemNode** mem,
162                                      const TypePtr* adr_type,
163                                      Node* dest_elem_klass,
164                                      Node* src,  Node* src_offset,
165                                      Node* dest, Node* dest_offset,
166                                      Node* copy_length, bool dest_uninitialized);
167   Node* generate_generic_arraycopy(Node** ctrl, MergeMemNode** mem,
168                                    const TypePtr* adr_type,
169                                    Node* src,  Node* src_offset,
170                                    Node* dest, Node* dest_offset,
171                                    Node* copy_length, bool dest_uninitialized);
172   void generate_unchecked_arraycopy(Node** ctrl, MergeMemNode** mem,
173                                     const TypePtr* adr_type,
174                                     BasicType basic_elem_type,
175                                     bool disjoint_bases,
176                                     Node* src,  Node* src_offset,
177                                     Node* dest, Node* dest_offset,
178                                     Node* copy_length, bool dest_uninitialized);
179 
180   void expand_arraycopy_node(ArrayCopyNode *ac);
181 
182   int replace_input(Node *use, Node *oldref, Node *newref);
183   void copy_call_debug_info(CallNode *oldcall, CallNode * newcall);
184   Node* opt_bits_test(Node* ctrl, Node* region, int edge, Node* word, int mask, int bits, bool return_fast_path = false);
185   void copy_predefined_input_for_runtime_call(Node * ctrl, CallNode* oldcall, CallNode* call);
186   CallNode* make_slow_call(CallNode *oldcall, const TypeFunc* slow_call_type, address slow_call,
187                            const char* leaf_name, Node* slow_path, Node* parm0, Node* parm1,
188                            Node* parm2);
189   void extract_call_projections(CallNode *call);
190 
191   Node* initialize_object(AllocateNode* alloc,
192                           Node* control, Node* rawmem, Node* object,
193                           Node* klass_node, Node* length,
194                           Node* size_in_bytes);
195 
196   Node* prefetch_allocation(Node* i_o,
197                             Node*& needgc_false, Node*& contended_phi_rawmem,
198                             Node* old_eden_top, Node* new_eden_top,
199                             Node* length);
200 
201   Node* make_arraycopy_load(ArrayCopyNode* ac, intptr_t offset, Node* ctl, Node* mem, BasicType ft, const Type *ftype, AllocateNode *alloc);
202 
203 public:
204   PhaseMacroExpand(PhaseIterGVN &igvn) : Phase(Macro_Expand), _igvn(igvn), _has_locks(false) {
205     _igvn.set_delay_transform(true);
206   }
207   void eliminate_macro_nodes();
208   bool expand_macro_nodes();
209 
210   PhaseIterGVN &igvn() const { return _igvn; }
211 
212   // Members accessed from BarrierSetC2
213   void replace_node(Node* source, Node* target) { _igvn.replace_node(source, target); }
214   Node* intcon(jint con)        const { return _igvn.intcon(con); }
215   Node* longcon(jlong con)      const { return _igvn.longcon(con); }
216   Node* makecon(const Type *t)  const { return _igvn.makecon(t); }
217   Node* top()                   const { return C->top(); }
218 };
219 
220 #endif // SHARE_VM_OPTO_MACRO_HPP