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