1 /*
   2  * Copyright (c) 1997, 2014, 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 #include "precompiled.hpp"
  26 #include "opto/callnode.hpp"
  27 #include "opto/cfgnode.hpp"
  28 #include "opto/matcher.hpp"
  29 #include "opto/mathexactnode.hpp"
  30 #include "opto/multnode.hpp"
  31 #include "opto/opcodes.hpp"
  32 #include "opto/phaseX.hpp"
  33 #include "opto/regmask.hpp"
  34 #include "opto/type.hpp"
  35 #if INCLUDE_ALL_GCS
  36 #include "gc_implementation/shenandoah/c2/shenandoahSupport.hpp"
  37 #endif
  38 
  39 //=============================================================================
  40 //------------------------------MultiNode--------------------------------------
  41 const RegMask &MultiNode::out_RegMask() const {
  42   return RegMask::Empty;
  43 }
  44 
  45 Node *MultiNode::match( const ProjNode *proj, const Matcher *m ) { return proj->clone(); }
  46 
  47 //------------------------------proj_out---------------------------------------
  48 // Get a named projection
  49 ProjNode* MultiNode::proj_out(uint which_proj) const {
  50   assert(Opcode() != Op_If || which_proj == (uint)true || which_proj == (uint)false, "must be 1 or 0");
  51   assert(Opcode() != Op_If || outcnt() == 2, "bad if #1");
  52   for( DUIterator_Fast imax, i = fast_outs(imax); i < imax; i++ ) {
  53     Node *p = fast_out(i);
  54     if (p->is_Proj()) {
  55       ProjNode *proj = p->as_Proj();
  56       if (proj->_con == which_proj) {
  57         assert(Opcode() != Op_If || proj->Opcode() == (which_proj?Op_IfTrue:Op_IfFalse), "bad if #2");
  58         return proj;
  59       }
  60     } else {
  61       assert(p == this && this->is_Start(), "else must be proj");
  62       continue;
  63     }
  64   }
  65   return NULL;
  66 }
  67 
  68 //=============================================================================
  69 //------------------------------ProjNode---------------------------------------
  70 uint ProjNode::hash() const {
  71   // only one input
  72   return (uintptr_t)in(TypeFunc::Control) + (_con << 1) + (_is_io_use ? 1 : 0);
  73 }
  74 uint ProjNode::cmp( const Node &n ) const { return _con == ((ProjNode&)n)._con && ((ProjNode&)n)._is_io_use == _is_io_use; }
  75 uint ProjNode::size_of() const { return sizeof(ProjNode); }
  76 
  77 // Test if we propagate interesting control along this projection
  78 bool ProjNode::is_CFG() const {
  79   Node *def = in(0);
  80   return (_con == TypeFunc::Control && def->is_CFG());
  81 }
  82 
  83 const Type* ProjNode::proj_type(const Type* t) const {
  84   if (t == Type::TOP) {
  85     return Type::TOP;
  86   }
  87   if (t == Type::BOTTOM) {
  88     return Type::BOTTOM;
  89   }
  90   t = t->is_tuple()->field_at(_con);
  91   Node* n = in(0);
  92   if ((_con == TypeFunc::Parms) &&
  93       n->is_CallStaticJava() && n->as_CallStaticJava()->is_boxing_method()) {
  94     // The result of autoboxing is always non-null on normal path.
  95     t = t->join_speculative(TypePtr::NOTNULL);
  96   }
  97   return t;
  98 }
  99 
 100 const Type *ProjNode::bottom_type() const {
 101   if (in(0) == NULL) return Type::TOP;
 102   return proj_type(in(0)->bottom_type());
 103 }
 104 
 105 const TypePtr *ProjNode::adr_type() const {
 106   if (bottom_type() == Type::MEMORY) {
 107     // in(0) might be a narrow MemBar; otherwise we will report TypePtr::BOTTOM
 108     const TypePtr* adr_type = in(0)->adr_type();
 109     #ifdef ASSERT
 110     if (!is_error_reported() && !Node::in_dump())
 111       assert(adr_type != NULL, "source must have adr_type");
 112     #endif
 113     return adr_type;
 114   }
 115   assert(bottom_type()->base() != Type::Memory, "no other memories?");
 116   return NULL;
 117 }
 118 
 119 bool ProjNode::pinned() const { return in(0)->pinned(); }
 120 #ifndef PRODUCT
 121 void ProjNode::dump_spec(outputStream *st) const { st->print("#%d",_con); if(_is_io_use) st->print(" (i_o_use)");}
 122 #endif
 123 
 124 //----------------------------check_con----------------------------------------
 125 void ProjNode::check_con() const {
 126   Node* n = in(0);
 127   if (n == NULL)       return;  // should be assert, but NodeHash makes bogons
 128   if (n->is_Mach())    return;  // mach. projs. are not type-safe
 129   if (n->is_Start())   return;  // alas, starts can have mach. projs. also
 130   if (_con == SCMemProjNode::SCMEMPROJCON ) return;
 131   const Type* t = n->bottom_type();
 132   if (t == Type::TOP)  return;  // multi is dead
 133   assert(_con < t->is_tuple()->cnt(), "ProjNode::_con must be in range");
 134 }
 135 
 136 //------------------------------Value------------------------------------------
 137 const Type *ProjNode::Value( PhaseTransform *phase ) const {
 138   if (in(0) == NULL) return Type::TOP;
 139   return proj_type(phase->type(in(0)));
 140 }
 141 
 142 //------------------------------out_RegMask------------------------------------
 143 // Pass the buck uphill
 144 const RegMask &ProjNode::out_RegMask() const {
 145   return RegMask::Empty;
 146 }
 147 
 148 //------------------------------ideal_reg--------------------------------------
 149 uint ProjNode::ideal_reg() const {
 150   return bottom_type()->ideal_reg();
 151 }
 152 
 153 //-------------------------------is_uncommon_trap_proj----------------------------
 154 // Return uncommon trap call node if proj is for "proj->[region->..]call_uct"
 155 // NULL otherwise
 156 CallStaticJavaNode* ProjNode::is_uncommon_trap_proj(Deoptimization::DeoptReason reason) {
 157   int path_limit = 10;
 158   Node* out = this;
 159   for (int ct = 0; ct < path_limit; ct++) {
 160     out = out->unique_ctrl_out();
 161     if (out == NULL)
 162       return NULL;
 163     if (out->is_CallStaticJava()) {
 164       CallStaticJavaNode* call = out->as_CallStaticJava();
 165       int req = call->uncommon_trap_request();
 166       if (req != 0) {
 167         Deoptimization::DeoptReason trap_reason = Deoptimization::trap_request_reason(req);
 168         if (trap_reason == reason || reason == Deoptimization::Reason_none) {
 169           return call;
 170         }
 171       }
 172       return NULL; // don't do further after call
 173     }
 174     if (out->Opcode() != Op_Region)
 175       return NULL;
 176   }
 177   return NULL;
 178 }
 179 
 180 //-------------------------------is_uncommon_trap_if_pattern-------------------------
 181 // Return uncommon trap call node for    "if(test)-> proj -> ...
 182 //                                                 |
 183 //                                                 V
 184 //                                             other_proj->[region->..]call_uct"
 185 // NULL otherwise
 186 // "must_reason_predicate" means the uct reason must be Reason_predicate
 187 CallStaticJavaNode* ProjNode::is_uncommon_trap_if_pattern(Deoptimization::DeoptReason reason) {
 188   Node *in0 = in(0);
 189   if (!in0->is_If()) return NULL;
 190   // Variation of a dead If node.
 191   if (in0->outcnt() < 2)  return NULL;
 192   IfNode* iff = in0->as_If();
 193 
 194   // we need "If(Conv2B(Opaque1(...)))" pattern for reason_predicate
 195   if (reason != Deoptimization::Reason_none) {
 196     if (iff->in(1)->Opcode() != Op_Conv2B ||
 197        iff->in(1)->in(1)->Opcode() != Op_Opaque1) {
 198       return NULL;
 199     }
 200   }
 201 
 202   ProjNode* other_proj = iff->proj_out(1-_con);
 203   if (other_proj == NULL) // Should never happen, but make Parfait happy.
 204       return NULL;
 205   CallStaticJavaNode* call = other_proj->is_uncommon_trap_proj(reason);
 206   if (call != NULL) {
 207     assert(reason == Deoptimization::Reason_none ||
 208            Compile::current()->is_predicate_opaq(iff->in(1)->in(1)), "should be on the list");
 209     return call;
 210   }
 211   return NULL;
 212 }