1 /*
   2  * Copyright 1997-2007 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 // Portions of code courtesy of Clifford Click
  26 
  27 // Optimization - Graph Style
  28 
  29 #include "incls/_precompiled.incl"
  30 #include "incls/_cfgnode.cpp.incl"
  31 
  32 //=============================================================================
  33 //------------------------------Value------------------------------------------
  34 // Compute the type of the RegionNode.
  35 const Type *RegionNode::Value( PhaseTransform *phase ) const {
  36   for( uint i=1; i<req(); ++i ) {       // For all paths in
  37     Node *n = in(i);            // Get Control source
  38     if( !n ) continue;          // Missing inputs are TOP
  39     if( phase->type(n) == Type::CONTROL )
  40       return Type::CONTROL;
  41   }
  42   return Type::TOP;             // All paths dead?  Then so are we
  43 }
  44 
  45 //------------------------------Identity---------------------------------------
  46 // Check for Region being Identity.
  47 Node *RegionNode::Identity( PhaseTransform *phase ) {
  48   // Cannot have Region be an identity, even if it has only 1 input.
  49   // Phi users cannot have their Region input folded away for them,
  50   // since they need to select the proper data input
  51   return this;
  52 }
  53 
  54 //------------------------------merge_region-----------------------------------
  55 // If a Region flows into a Region, merge into one big happy merge.  This is
  56 // hard to do if there is stuff that has to happen
  57 static Node *merge_region(RegionNode *region, PhaseGVN *phase) {
  58   if( region->Opcode() != Op_Region ) // Do not do to LoopNodes
  59     return NULL;
  60   Node *progress = NULL;        // Progress flag
  61   PhaseIterGVN *igvn = phase->is_IterGVN();
  62 
  63   uint rreq = region->req();
  64   for( uint i = 1; i < rreq; i++ ) {
  65     Node *r = region->in(i);
  66     if( r && r->Opcode() == Op_Region && // Found a region?
  67         r->in(0) == r &&        // Not already collapsed?
  68         r != region &&          // Avoid stupid situations
  69         r->outcnt() == 2 ) {    // Self user and 'region' user only?
  70       assert(!r->as_Region()->has_phi(), "no phi users");
  71       if( !progress ) {         // No progress
  72         if (region->has_phi()) {
  73           return NULL;        // Only flatten if no Phi users
  74           // igvn->hash_delete( phi );
  75         }
  76         igvn->hash_delete( region );
  77         progress = region;      // Making progress
  78       }
  79       igvn->hash_delete( r );
  80 
  81       // Append inputs to 'r' onto 'region'
  82       for( uint j = 1; j < r->req(); j++ ) {
  83         // Move an input from 'r' to 'region'
  84         region->add_req(r->in(j));
  85         r->set_req(j, phase->C->top());
  86         // Update phis of 'region'
  87         //for( uint k = 0; k < max; k++ ) {
  88         //  Node *phi = region->out(k);
  89         //  if( phi->is_Phi() ) {
  90         //    phi->add_req(phi->in(i));
  91         //  }
  92         //}
  93 
  94         rreq++;                 // One more input to Region
  95       } // Found a region to merge into Region
  96       // Clobber pointer to the now dead 'r'
  97       region->set_req(i, phase->C->top());
  98     }
  99   }
 100 
 101   return progress;
 102 }
 103 
 104 
 105 
 106 //--------------------------------has_phi--------------------------------------
 107 // Helper function: Return any PhiNode that uses this region or NULL
 108 PhiNode* RegionNode::has_phi() const {
 109   for (DUIterator_Fast imax, i = fast_outs(imax); i < imax; i++) {
 110     Node* phi = fast_out(i);
 111     if (phi->is_Phi()) {   // Check for Phi users
 112       assert(phi->in(0) == (Node*)this, "phi uses region only via in(0)");
 113       return phi->as_Phi();  // this one is good enough
 114     }
 115   }
 116 
 117   return NULL;
 118 }
 119 
 120 
 121 //-----------------------------has_unique_phi----------------------------------
 122 // Helper function: Return the only PhiNode that uses this region or NULL
 123 PhiNode* RegionNode::has_unique_phi() const {
 124   // Check that only one use is a Phi
 125   PhiNode* only_phi = NULL;
 126   for (DUIterator_Fast imax, i = fast_outs(imax); i < imax; i++) {
 127     Node* phi = fast_out(i);
 128     if (phi->is_Phi()) {   // Check for Phi users
 129       assert(phi->in(0) == (Node*)this, "phi uses region only via in(0)");
 130       if (only_phi == NULL) {
 131         only_phi = phi->as_Phi();
 132       } else {
 133         return NULL;  // multiple phis
 134       }
 135     }
 136   }
 137 
 138   return only_phi;
 139 }
 140 
 141 
 142 //------------------------------check_phi_clipping-----------------------------
 143 // Helper function for RegionNode's identification of FP clipping
 144 // Check inputs to the Phi
 145 static bool check_phi_clipping( PhiNode *phi, ConNode * &min, uint &min_idx, ConNode * &max, uint &max_idx, Node * &val, uint &val_idx ) {
 146   min     = NULL;
 147   max     = NULL;
 148   val     = NULL;
 149   min_idx = 0;
 150   max_idx = 0;
 151   val_idx = 0;
 152   uint  phi_max = phi->req();
 153   if( phi_max == 4 ) {
 154     for( uint j = 1; j < phi_max; ++j ) {
 155       Node *n = phi->in(j);
 156       int opcode = n->Opcode();
 157       switch( opcode ) {
 158       case Op_ConI:
 159         {
 160           if( min == NULL ) {
 161             min     = n->Opcode() == Op_ConI ? (ConNode*)n : NULL;
 162             min_idx = j;
 163           } else {
 164             max     = n->Opcode() == Op_ConI ? (ConNode*)n : NULL;
 165             max_idx = j;
 166             if( min->get_int() > max->get_int() ) {
 167               // Swap min and max
 168               ConNode *temp;
 169               uint     temp_idx;
 170               temp     = min;     min     = max;     max     = temp;
 171               temp_idx = min_idx; min_idx = max_idx; max_idx = temp_idx;
 172             }
 173           }
 174         }
 175         break;
 176       default:
 177         {
 178           val = n;
 179           val_idx = j;
 180         }
 181         break;
 182       }
 183     }
 184   }
 185   return ( min && max && val && (min->get_int() <= 0) && (max->get_int() >=0) );
 186 }
 187 
 188 
 189 //------------------------------check_if_clipping------------------------------
 190 // Helper function for RegionNode's identification of FP clipping
 191 // Check that inputs to Region come from two IfNodes,
 192 //
 193 //            If
 194 //      False    True
 195 //       If        |
 196 //  False  True    |
 197 //    |      |     |
 198 //  RegionNode_inputs
 199 //
 200 static bool check_if_clipping( const RegionNode *region, IfNode * &bot_if, IfNode * &top_if ) {
 201   top_if = NULL;
 202   bot_if = NULL;
 203 
 204   // Check control structure above RegionNode for (if  ( if  ) )
 205   Node *in1 = region->in(1);
 206   Node *in2 = region->in(2);
 207   Node *in3 = region->in(3);
 208   // Check that all inputs are projections
 209   if( in1->is_Proj() && in2->is_Proj() && in3->is_Proj() ) {
 210     Node *in10 = in1->in(0);
 211     Node *in20 = in2->in(0);
 212     Node *in30 = in3->in(0);
 213     // Check that #1 and #2 are ifTrue and ifFalse from same If
 214     if( in10 != NULL && in10->is_If() &&
 215         in20 != NULL && in20->is_If() &&
 216         in30 != NULL && in30->is_If() && in10 == in20 &&
 217         (in1->Opcode() != in2->Opcode()) ) {
 218       Node  *in100 = in10->in(0);
 219       Node *in1000 = (in100 != NULL && in100->is_Proj()) ? in100->in(0) : NULL;
 220       // Check that control for in10 comes from other branch of IF from in3
 221       if( in1000 != NULL && in1000->is_If() &&
 222           in30 == in1000 && (in3->Opcode() != in100->Opcode()) ) {
 223         // Control pattern checks
 224         top_if = (IfNode*)in1000;
 225         bot_if = (IfNode*)in10;
 226       }
 227     }
 228   }
 229 
 230   return (top_if != NULL);
 231 }
 232 
 233 
 234 //------------------------------check_convf2i_clipping-------------------------
 235 // Helper function for RegionNode's identification of FP clipping
 236 // Verify that the value input to the phi comes from "ConvF2I; LShift; RShift"
 237 static bool check_convf2i_clipping( PhiNode *phi, uint idx, ConvF2INode * &convf2i, Node *min, Node *max) {
 238   convf2i = NULL;
 239 
 240   // Check for the RShiftNode
 241   Node *rshift = phi->in(idx);
 242   assert( rshift, "Previous checks ensure phi input is present");
 243   if( rshift->Opcode() != Op_RShiftI )  { return false; }
 244 
 245   // Check for the LShiftNode
 246   Node *lshift = rshift->in(1);
 247   assert( lshift, "Previous checks ensure phi input is present");
 248   if( lshift->Opcode() != Op_LShiftI )  { return false; }
 249 
 250   // Check for the ConvF2INode
 251   Node *conv = lshift->in(1);
 252   if( conv->Opcode() != Op_ConvF2I ) { return false; }
 253 
 254   // Check that shift amounts are only to get sign bits set after F2I
 255   jint max_cutoff     = max->get_int();
 256   jint min_cutoff     = min->get_int();
 257   jint left_shift     = lshift->in(2)->get_int();
 258   jint right_shift    = rshift->in(2)->get_int();
 259   jint max_post_shift = nth_bit(BitsPerJavaInteger - left_shift - 1);
 260   if( left_shift != right_shift ||
 261       0 > left_shift || left_shift >= BitsPerJavaInteger ||
 262       max_post_shift < max_cutoff ||
 263       max_post_shift < -min_cutoff ) {
 264     // Shifts are necessary but current transformation eliminates them
 265     return false;
 266   }
 267 
 268   // OK to return the result of ConvF2I without shifting
 269   convf2i = (ConvF2INode*)conv;
 270   return true;
 271 }
 272 
 273 
 274 //------------------------------check_compare_clipping-------------------------
 275 // Helper function for RegionNode's identification of FP clipping
 276 static bool check_compare_clipping( bool less_than, IfNode *iff, ConNode *limit, Node * & input ) {
 277   Node *i1 = iff->in(1);
 278   if ( !i1->is_Bool() ) { return false; }
 279   BoolNode *bool1 = i1->as_Bool();
 280   if(       less_than && bool1->_test._test != BoolTest::le ) { return false; }
 281   else if( !less_than && bool1->_test._test != BoolTest::lt ) { return false; }
 282   const Node *cmpF = bool1->in(1);
 283   if( cmpF->Opcode() != Op_CmpF )      { return false; }
 284   // Test that the float value being compared against
 285   // is equivalent to the int value used as a limit
 286   Node *nodef = cmpF->in(2);
 287   if( nodef->Opcode() != Op_ConF ) { return false; }
 288   jfloat conf = nodef->getf();
 289   jint   coni = limit->get_int();
 290   if( ((int)conf) != coni )        { return false; }
 291   input = cmpF->in(1);
 292   return true;
 293 }
 294 
 295 //------------------------------is_unreachable_region--------------------------
 296 // Find if the Region node is reachable from the root.
 297 bool RegionNode::is_unreachable_region(PhaseGVN *phase) const {
 298   assert(req() == 2, "");
 299 
 300   // First, cut the simple case of fallthrough region when NONE of
 301   // region's phis references itself directly or through a data node.
 302   uint max = outcnt();
 303   uint i;
 304   for (i = 0; i < max; i++) {
 305     Node* phi = raw_out(i);
 306     if (phi != NULL && phi->is_Phi()) {
 307       assert(phase->eqv(phi->in(0), this) && phi->req() == 2, "");
 308       if (phi->outcnt() == 0)
 309         continue; // Safe case - no loops
 310       if (phi->outcnt() == 1) {
 311         Node* u = phi->raw_out(0);
 312         // Skip if only one use is an other Phi or Call or Uncommon trap.
 313         // It is safe to consider this case as fallthrough.
 314         if (u != NULL && (u->is_Phi() || u->is_CFG()))
 315           continue;
 316       }
 317       // Check when phi references itself directly or through an other node.
 318       if (phi->as_Phi()->simple_data_loop_check(phi->in(1)) >= PhiNode::Unsafe)
 319         break; // Found possible unsafe data loop.
 320     }
 321   }
 322   if (i >= max)
 323     return false; // An unsafe case was NOT found - don't need graph walk.
 324 
 325   // Unsafe case - check if the Region node is reachable from root.
 326   ResourceMark rm;
 327 
 328   Arena *a = Thread::current()->resource_area();
 329   Node_List nstack(a);
 330   VectorSet visited(a);
 331 
 332   // Mark all control nodes reachable from root outputs
 333   Node *n = (Node*)phase->C->root();
 334   nstack.push(n);
 335   visited.set(n->_idx);
 336   while (nstack.size() != 0) {
 337     n = nstack.pop();
 338     uint max = n->outcnt();
 339     for (uint i = 0; i < max; i++) {
 340       Node* m = n->raw_out(i);
 341       if (m != NULL && m->is_CFG()) {
 342         if (phase->eqv(m, this)) {
 343           return false; // We reached the Region node - it is not dead.
 344         }
 345         if (!visited.test_set(m->_idx))
 346           nstack.push(m);
 347       }
 348     }
 349   }
 350 
 351   return true; // The Region node is unreachable - it is dead.
 352 }
 353 
 354 //------------------------------Ideal------------------------------------------
 355 // Return a node which is more "ideal" than the current node.  Must preserve
 356 // the CFG, but we can still strip out dead paths.
 357 Node *RegionNode::Ideal(PhaseGVN *phase, bool can_reshape) {
 358   if( !can_reshape && !in(0) ) return NULL;     // Already degraded to a Copy
 359   assert(!in(0) || !in(0)->is_Root(), "not a specially hidden merge");
 360 
 361   // Check for RegionNode with no Phi users and both inputs come from either
 362   // arm of the same IF.  If found, then the control-flow split is useless.
 363   bool has_phis = false;
 364   if (can_reshape) {            // Need DU info to check for Phi users
 365     has_phis = (has_phi() != NULL);       // Cache result
 366     if (!has_phis) {            // No Phi users?  Nothing merging?
 367       for (uint i = 1; i < req()-1; i++) {
 368         Node *if1 = in(i);
 369         if( !if1 ) continue;
 370         Node *iff = if1->in(0);
 371         if( !iff || !iff->is_If() ) continue;
 372         for( uint j=i+1; j<req(); j++ ) {
 373           if( in(j) && in(j)->in(0) == iff &&
 374               if1->Opcode() != in(j)->Opcode() ) {
 375             // Add the IF Projections to the worklist. They (and the IF itself)
 376             // will be eliminated if dead.
 377             phase->is_IterGVN()->add_users_to_worklist(iff);
 378             set_req(i, iff->in(0));// Skip around the useless IF diamond
 379             set_req(j, NULL);
 380             return this;      // Record progress
 381           }
 382         }
 383       }
 384     }
 385   }
 386 
 387   // Remove TOP or NULL input paths. If only 1 input path remains, this Region
 388   // degrades to a copy.
 389   bool add_to_worklist = false;
 390   int cnt = 0;                  // Count of values merging
 391   DEBUG_ONLY( int cnt_orig = req(); ) // Save original inputs count
 392   int del_it = 0;               // The last input path we delete
 393   // For all inputs...
 394   for( uint i=1; i<req(); ++i ){// For all paths in
 395     Node *n = in(i);            // Get the input
 396     if( n != NULL ) {
 397       // Remove useless control copy inputs
 398       if( n->is_Region() && n->as_Region()->is_copy() ) {
 399         set_req(i, n->nonnull_req());
 400         i--;
 401         continue;
 402       }
 403       if( n->is_Proj() ) {      // Remove useless rethrows
 404         Node *call = n->in(0);
 405         if (call->is_Call() && call->as_Call()->entry_point() == OptoRuntime::rethrow_stub()) {
 406           set_req(i, call->in(0));
 407           i--;
 408           continue;
 409         }
 410       }
 411       if( phase->type(n) == Type::TOP ) {
 412         set_req(i, NULL);       // Ignore TOP inputs
 413         i--;
 414         continue;
 415       }
 416       cnt++;                    // One more value merging
 417 
 418     } else if (can_reshape) {   // Else found dead path with DU info
 419       PhaseIterGVN *igvn = phase->is_IterGVN();
 420       del_req(i);               // Yank path from self
 421       del_it = i;
 422       uint max = outcnt();
 423       DUIterator j;
 424       bool progress = true;
 425       while(progress) {         // Need to establish property over all users
 426         progress = false;
 427         for (j = outs(); has_out(j); j++) {
 428           Node *n = out(j);
 429           if( n->req() != req() && n->is_Phi() ) {
 430             assert( n->in(0) == this, "" );
 431             igvn->hash_delete(n); // Yank from hash before hacking edges
 432             n->set_req_X(i,NULL,igvn);// Correct DU info
 433             n->del_req(i);        // Yank path from Phis
 434             if( max != outcnt() ) {
 435               progress = true;
 436               j = refresh_out_pos(j);
 437               max = outcnt();
 438             }
 439           }
 440         }
 441       }
 442       add_to_worklist = true;
 443       i--;
 444     }
 445   }
 446 
 447   if (can_reshape && cnt == 1) {
 448     // Is it dead loop?
 449     // If it is LoopNopde it had 2 (+1 itself) inputs and
 450     // one of them was cut. The loop is dead if it was EntryContol.
 451     assert(!this->is_Loop() || cnt_orig == 3, "Loop node should have 3 inputs");
 452     if (this->is_Loop() && del_it == LoopNode::EntryControl ||
 453        !this->is_Loop() && has_phis && is_unreachable_region(phase)) {
 454       // Yes,  the region will be removed during the next step below.
 455       // Cut the backedge input and remove phis since no data paths left.
 456       // We don't cut outputs to other nodes here since we need to put them
 457       // on the worklist.
 458       del_req(1);
 459       cnt = 0;
 460       assert( req() == 1, "no more inputs expected" );
 461       uint max = outcnt();
 462       bool progress = true;
 463       Node *top = phase->C->top();
 464       PhaseIterGVN *igvn = phase->is_IterGVN();
 465       DUIterator j;
 466       while(progress) {
 467         progress = false;
 468         for (j = outs(); has_out(j); j++) {
 469           Node *n = out(j);
 470           if( n->is_Phi() ) {
 471             assert( igvn->eqv(n->in(0), this), "" );
 472             assert( n->req() == 2 &&  n->in(1) != NULL, "Only one data input expected" );
 473             // Break dead loop data path.
 474             // Eagerly replace phis with top to avoid phis copies generation.
 475             igvn->add_users_to_worklist(n);
 476             igvn->hash_delete(n); // Yank from hash before hacking edges
 477             igvn->subsume_node(n, top);
 478             if( max != outcnt() ) {
 479               progress = true;
 480               j = refresh_out_pos(j);
 481               max = outcnt();
 482             }
 483           }
 484         }
 485       }
 486       add_to_worklist = true;
 487     }
 488   }
 489   if (add_to_worklist) {
 490     phase->is_IterGVN()->add_users_to_worklist(this); // Revisit collapsed Phis
 491   }
 492 
 493   if( cnt <= 1 ) {              // Only 1 path in?
 494     set_req(0, NULL);           // Null control input for region copy
 495     if( cnt == 0 && !can_reshape) { // Parse phase - leave the node as it is.
 496       // No inputs or all inputs are NULL.
 497       return NULL;
 498     } else if (can_reshape) {   // Optimization phase - remove the node
 499       PhaseIterGVN *igvn = phase->is_IterGVN();
 500       Node *parent_ctrl;
 501       if( cnt == 0 ) {
 502         assert( req() == 1, "no inputs expected" );
 503         // During IGVN phase such region will be subsumed by TOP node
 504         // so region's phis will have TOP as control node.
 505         // Kill phis here to avoid it. PhiNode::is_copy() will be always false.
 506         // Also set other user's input to top.
 507         parent_ctrl = phase->C->top();
 508       } else {
 509         // The fallthrough case since we already checked dead loops above.
 510         parent_ctrl = in(1);
 511         assert(parent_ctrl != NULL, "Region is a copy of some non-null control");
 512         assert(!igvn->eqv(parent_ctrl, this), "Close dead loop");
 513       }
 514       if (!add_to_worklist)
 515         igvn->add_users_to_worklist(this); // Check for further allowed opts
 516       for (DUIterator_Last imin, i = last_outs(imin); i >= imin; --i) {
 517         Node* n = last_out(i);
 518         igvn->hash_delete(n); // Remove from worklist before modifying edges
 519         if( n->is_Phi() ) {   // Collapse all Phis
 520           // Eagerly replace phis to avoid copies generation.
 521           igvn->add_users_to_worklist(n);
 522           igvn->hash_delete(n); // Yank from hash before hacking edges
 523           if( cnt == 0 ) {
 524             assert( n->req() == 1, "No data inputs expected" );
 525             igvn->subsume_node(n, parent_ctrl); // replaced by top
 526           } else {
 527             assert( n->req() == 2 &&  n->in(1) != NULL, "Only one data input expected" );
 528             Node* in1 = n->in(1);               // replaced by unique input
 529             if( n->as_Phi()->is_unsafe_data_reference(in1) )
 530               in1 = phase->C->top();            // replaced by top
 531             igvn->subsume_node(n, in1);
 532           }
 533         }
 534         else if( n->is_Region() ) { // Update all incoming edges
 535           assert( !igvn->eqv(n, this), "Must be removed from DefUse edges");
 536           uint uses_found = 0;
 537           for( uint k=1; k < n->req(); k++ ) {
 538             if( n->in(k) == this ) {
 539               n->set_req(k, parent_ctrl);
 540               uses_found++;
 541             }
 542           }
 543           if( uses_found > 1 ) { // (--i) done at the end of the loop.
 544             i -= (uses_found - 1);
 545           }
 546         }
 547         else {
 548           assert( igvn->eqv(n->in(0), this), "Expect RegionNode to be control parent");
 549           n->set_req(0, parent_ctrl);
 550         }
 551 #ifdef ASSERT
 552         for( uint k=0; k < n->req(); k++ ) {
 553           assert( !igvn->eqv(n->in(k), this), "All uses of RegionNode should be gone");
 554         }
 555 #endif
 556       }
 557       // Remove the RegionNode itself from DefUse info
 558       igvn->remove_dead_node(this);
 559       return NULL;
 560     }
 561     return this;                // Record progress
 562   }
 563 
 564 
 565   // If a Region flows into a Region, merge into one big happy merge.
 566   if (can_reshape) {
 567     Node *m = merge_region(this, phase);
 568     if (m != NULL)  return m;
 569   }
 570 
 571   // Check if this region is the root of a clipping idiom on floats
 572   if( ConvertFloat2IntClipping && can_reshape && req() == 4 ) {
 573     // Check that only one use is a Phi and that it simplifies to two constants +
 574     PhiNode* phi = has_unique_phi();
 575     if (phi != NULL) {          // One Phi user
 576       // Check inputs to the Phi
 577       ConNode *min;
 578       ConNode *max;
 579       Node    *val;
 580       uint     min_idx;
 581       uint     max_idx;
 582       uint     val_idx;
 583       if( check_phi_clipping( phi, min, min_idx, max, max_idx, val, val_idx )  ) {
 584         IfNode *top_if;
 585         IfNode *bot_if;
 586         if( check_if_clipping( this, bot_if, top_if ) ) {
 587           // Control pattern checks, now verify compares
 588           Node   *top_in = NULL;   // value being compared against
 589           Node   *bot_in = NULL;
 590           if( check_compare_clipping( true,  bot_if, min, bot_in ) &&
 591               check_compare_clipping( false, top_if, max, top_in ) ) {
 592             if( bot_in == top_in ) {
 593               PhaseIterGVN *gvn = phase->is_IterGVN();
 594               assert( gvn != NULL, "Only had DefUse info in IterGVN");
 595               // Only remaining check is that bot_in == top_in == (Phi's val + mods)
 596 
 597               // Check for the ConvF2INode
 598               ConvF2INode *convf2i;
 599               if( check_convf2i_clipping( phi, val_idx, convf2i, min, max ) &&
 600                 convf2i->in(1) == bot_in ) {
 601                 // Matched pattern, including LShiftI; RShiftI, replace with integer compares
 602                 // max test
 603                 Node *cmp   = gvn->register_new_node_with_optimizer(new (phase->C, 3) CmpINode( convf2i, min ));
 604                 Node *boo   = gvn->register_new_node_with_optimizer(new (phase->C, 2) BoolNode( cmp, BoolTest::lt ));
 605                 IfNode *iff = (IfNode*)gvn->register_new_node_with_optimizer(new (phase->C, 2) IfNode( top_if->in(0), boo, PROB_UNLIKELY_MAG(5), top_if->_fcnt ));
 606                 Node *if_min= gvn->register_new_node_with_optimizer(new (phase->C, 1) IfTrueNode (iff));
 607                 Node *ifF   = gvn->register_new_node_with_optimizer(new (phase->C, 1) IfFalseNode(iff));
 608                 // min test
 609                 cmp         = gvn->register_new_node_with_optimizer(new (phase->C, 3) CmpINode( convf2i, max ));
 610                 boo         = gvn->register_new_node_with_optimizer(new (phase->C, 2) BoolNode( cmp, BoolTest::gt ));
 611                 iff         = (IfNode*)gvn->register_new_node_with_optimizer(new (phase->C, 2) IfNode( ifF, boo, PROB_UNLIKELY_MAG(5), bot_if->_fcnt ));
 612                 Node *if_max= gvn->register_new_node_with_optimizer(new (phase->C, 1) IfTrueNode (iff));
 613                 ifF         = gvn->register_new_node_with_optimizer(new (phase->C, 1) IfFalseNode(iff));
 614                 // update input edges to region node
 615                 set_req_X( min_idx, if_min, gvn );
 616                 set_req_X( max_idx, if_max, gvn );
 617                 set_req_X( val_idx, ifF,    gvn );
 618                 // remove unnecessary 'LShiftI; RShiftI' idiom
 619                 gvn->hash_delete(phi);
 620                 phi->set_req_X( val_idx, convf2i, gvn );
 621                 gvn->hash_find_insert(phi);
 622                 // Return transformed region node
 623                 return this;
 624               }
 625             }
 626           }
 627         }
 628       }
 629     }
 630   }
 631 
 632   return NULL;
 633 }
 634 
 635 
 636 
 637 const RegMask &RegionNode::out_RegMask() const {
 638   return RegMask::Empty;
 639 }
 640 
 641 // Find the one non-null required input.  RegionNode only
 642 Node *Node::nonnull_req() const {
 643   assert( is_Region(), "" );
 644   for( uint i = 1; i < _cnt; i++ )
 645     if( in(i) )
 646       return in(i);
 647   ShouldNotReachHere();
 648   return NULL;
 649 }
 650 
 651 
 652 //=============================================================================
 653 // note that these functions assume that the _adr_type field is flattened
 654 uint PhiNode::hash() const {
 655   const Type* at = _adr_type;
 656   return TypeNode::hash() + (at ? at->hash() : 0);
 657 }
 658 uint PhiNode::cmp( const Node &n ) const {
 659   return TypeNode::cmp(n) && _adr_type == ((PhiNode&)n)._adr_type;
 660 }
 661 static inline
 662 const TypePtr* flatten_phi_adr_type(const TypePtr* at) {
 663   if (at == NULL || at == TypePtr::BOTTOM)  return at;
 664   return Compile::current()->alias_type(at)->adr_type();
 665 }
 666 
 667 //----------------------------make---------------------------------------------
 668 // create a new phi with edges matching r and set (initially) to x
 669 PhiNode* PhiNode::make(Node* r, Node* x, const Type *t, const TypePtr* at) {
 670   uint preds = r->req();   // Number of predecessor paths
 671   assert(t != Type::MEMORY || at == flatten_phi_adr_type(at), "flatten at");
 672   PhiNode* p = new (Compile::current(), preds) PhiNode(r, t, at);
 673   for (uint j = 1; j < preds; j++) {
 674     // Fill in all inputs, except those which the region does not yet have
 675     if (r->in(j) != NULL)
 676       p->init_req(j, x);
 677   }
 678   return p;
 679 }
 680 PhiNode* PhiNode::make(Node* r, Node* x) {
 681   const Type*    t  = x->bottom_type();
 682   const TypePtr* at = NULL;
 683   if (t == Type::MEMORY)  at = flatten_phi_adr_type(x->adr_type());
 684   return make(r, x, t, at);
 685 }
 686 PhiNode* PhiNode::make_blank(Node* r, Node* x) {
 687   const Type*    t  = x->bottom_type();
 688   const TypePtr* at = NULL;
 689   if (t == Type::MEMORY)  at = flatten_phi_adr_type(x->adr_type());
 690   return new (Compile::current(), r->req()) PhiNode(r, t, at);
 691 }
 692 
 693 
 694 //------------------------slice_memory-----------------------------------------
 695 // create a new phi with narrowed memory type
 696 PhiNode* PhiNode::slice_memory(const TypePtr* adr_type) const {
 697   PhiNode* mem = (PhiNode*) clone();
 698   *(const TypePtr**)&mem->_adr_type = adr_type;
 699   // convert self-loops, or else we get a bad graph
 700   for (uint i = 1; i < req(); i++) {
 701     if ((const Node*)in(i) == this)  mem->set_req(i, mem);
 702   }
 703   mem->verify_adr_type();
 704   return mem;
 705 }
 706 
 707 //------------------------split_out_instance-----------------------------------
 708 // Split out an instance type from a bottom phi.
 709 PhiNode* PhiNode::split_out_instance(const TypePtr* at, PhaseIterGVN *igvn) const {
 710   assert(type() == Type::MEMORY && (adr_type() == TypePtr::BOTTOM ||
 711          adr_type() == TypeRawPtr::BOTTOM) , "bottom or raw memory required");
 712 
 713   // Check if an appropriate node already exists.
 714   Node *region = in(0);
 715   for (DUIterator_Fast kmax, k = region->fast_outs(kmax); k < kmax; k++) {
 716     Node* use = region->fast_out(k);
 717     if( use->is_Phi()) {
 718       PhiNode *phi2 = use->as_Phi();
 719       if (phi2->type() == Type::MEMORY && phi2->adr_type() == at) {
 720         return phi2;
 721       }
 722     }
 723   }
 724   Compile *C = igvn->C;
 725   Arena *a = Thread::current()->resource_area();
 726   Node_Array node_map = new Node_Array(a);
 727   Node_Stack stack(a, C->unique() >> 4);
 728   PhiNode *nphi = slice_memory(at);
 729   igvn->register_new_node_with_optimizer( nphi );
 730   node_map.map(_idx, nphi);
 731   stack.push((Node *)this, 1);
 732   while(!stack.is_empty()) {
 733     PhiNode *ophi = stack.node()->as_Phi();
 734     uint i = stack.index();
 735     assert(i >= 1, "not control edge");
 736     stack.pop();
 737     nphi = node_map[ophi->_idx]->as_Phi();
 738     for (; i < ophi->req(); i++) {
 739       Node *in = ophi->in(i);
 740       if (in == NULL || igvn->type(in) == Type::TOP)
 741         continue;
 742       Node *opt = MemNode::optimize_simple_memory_chain(in, at, igvn);
 743       PhiNode *optphi = opt->is_Phi() ? opt->as_Phi() : NULL;
 744       if (optphi != NULL && optphi->adr_type() == TypePtr::BOTTOM) {
 745         opt = node_map[optphi->_idx];
 746         if (opt == NULL) {
 747           stack.push(ophi, i);
 748           nphi = optphi->slice_memory(at);
 749           igvn->register_new_node_with_optimizer( nphi );
 750           node_map.map(optphi->_idx, nphi);
 751           ophi = optphi;
 752           i = 0; // will get incremented at top of loop
 753           continue;
 754         }
 755       }
 756       nphi->set_req(i, opt);
 757     }
 758   }
 759   return nphi;
 760 }
 761 
 762 //------------------------verify_adr_type--------------------------------------
 763 #ifdef ASSERT
 764 void PhiNode::verify_adr_type(VectorSet& visited, const TypePtr* at) const {
 765   if (visited.test_set(_idx))  return;  //already visited
 766 
 767   // recheck constructor invariants:
 768   verify_adr_type(false);
 769 
 770   // recheck local phi/phi consistency:
 771   assert(_adr_type == at || _adr_type == TypePtr::BOTTOM,
 772          "adr_type must be consistent across phi nest");
 773 
 774   // walk around
 775   for (uint i = 1; i < req(); i++) {
 776     Node* n = in(i);
 777     if (n == NULL)  continue;
 778     const Node* np = in(i);
 779     if (np->is_Phi()) {
 780       np->as_Phi()->verify_adr_type(visited, at);
 781     } else if (n->bottom_type() == Type::TOP
 782                || (n->is_Mem() && n->in(MemNode::Address)->bottom_type() == Type::TOP)) {
 783       // ignore top inputs
 784     } else {
 785       const TypePtr* nat = flatten_phi_adr_type(n->adr_type());
 786       // recheck phi/non-phi consistency at leaves:
 787       assert((nat != NULL) == (at != NULL), "");
 788       assert(nat == at || nat == TypePtr::BOTTOM,
 789              "adr_type must be consistent at leaves of phi nest");
 790     }
 791   }
 792 }
 793 
 794 // Verify a whole nest of phis rooted at this one.
 795 void PhiNode::verify_adr_type(bool recursive) const {
 796   if (is_error_reported())  return;  // muzzle asserts when debugging an error
 797   if (Node::in_dump())      return;  // muzzle asserts when printing
 798 
 799   assert((_type == Type::MEMORY) == (_adr_type != NULL), "adr_type for memory phis only");
 800 
 801   if (!VerifyAliases)       return;  // verify thoroughly only if requested
 802 
 803   assert(_adr_type == flatten_phi_adr_type(_adr_type),
 804          "Phi::adr_type must be pre-normalized");
 805 
 806   if (recursive) {
 807     VectorSet visited(Thread::current()->resource_area());
 808     verify_adr_type(visited, _adr_type);
 809   }
 810 }
 811 #endif
 812 
 813 
 814 //------------------------------Value------------------------------------------
 815 // Compute the type of the PhiNode
 816 const Type *PhiNode::Value( PhaseTransform *phase ) const {
 817   Node *r = in(0);              // RegionNode
 818   if( !r )                      // Copy or dead
 819     return in(1) ? phase->type(in(1)) : Type::TOP;
 820 
 821   // Note: During parsing, phis are often transformed before their regions.
 822   // This means we have to use type_or_null to defend against untyped regions.
 823   if( phase->type_or_null(r) == Type::TOP )  // Dead code?
 824     return Type::TOP;
 825 
 826   // Check for trip-counted loop.  If so, be smarter.
 827   CountedLoopNode *l = r->is_CountedLoop() ? r->as_CountedLoop() : NULL;
 828   if( l && l->can_be_counted_loop(phase) &&
 829       ((const Node*)l->phi() == this) ) { // Trip counted loop!
 830     // protect against init_trip() or limit() returning NULL
 831     const Node *init   = l->init_trip();
 832     const Node *limit  = l->limit();
 833     if( init != NULL && limit != NULL && l->stride_is_con() ) {
 834       const TypeInt *lo = init ->bottom_type()->isa_int();
 835       const TypeInt *hi = limit->bottom_type()->isa_int();
 836       if( lo && hi ) {            // Dying loops might have TOP here
 837         int stride = l->stride_con();
 838         if( stride < 0 ) {          // Down-counter loop
 839           const TypeInt *tmp = lo; lo = hi; hi = tmp;
 840           stride = -stride;
 841         }
 842         if( lo->_hi < hi->_lo )     // Reversed endpoints are well defined :-(
 843           return TypeInt::make(lo->_lo,hi->_hi,3);
 844       }
 845     }
 846   }
 847 
 848   // Until we have harmony between classes and interfaces in the type
 849   // lattice, we must tread carefully around phis which implicitly
 850   // convert the one to the other.
 851   const TypeInstPtr* ttip = _type->isa_narrowoop() ? _type->isa_narrowoop()->make_oopptr()->isa_instptr() :_type->isa_instptr();
 852   bool is_intf = false;
 853   if (ttip != NULL) {
 854     ciKlass* k = ttip->klass();
 855     if (k->is_loaded() && k->is_interface())
 856       is_intf = true;
 857   }
 858 
 859   // Default case: merge all inputs
 860   const Type *t = Type::TOP;        // Merged type starting value
 861   for (uint i = 1; i < req(); ++i) {// For all paths in
 862     // Reachable control path?
 863     if (r->in(i) && phase->type(r->in(i)) == Type::CONTROL) {
 864       const Type* ti = phase->type(in(i));
 865       // We assume that each input of an interface-valued Phi is a true
 866       // subtype of that interface.  This might not be true of the meet
 867       // of all the input types.  The lattice is not distributive in
 868       // such cases.  Ward off asserts in type.cpp by refusing to do
 869       // meets between interfaces and proper classes.
 870       const TypeInstPtr* tiip = ti->isa_narrowoop() ? ti->is_narrowoop()->make_oopptr()->isa_instptr() : ti->isa_instptr();
 871       if (tiip) {
 872         bool ti_is_intf = false;
 873         ciKlass* k = tiip->klass();
 874         if (k->is_loaded() && k->is_interface())
 875           ti_is_intf = true;
 876         if (is_intf != ti_is_intf)
 877           { t = _type; break; }
 878       }
 879       t = t->meet(ti);
 880     }
 881   }
 882 
 883   // The worst-case type (from ciTypeFlow) should be consistent with "t".
 884   // That is, we expect that "t->higher_equal(_type)" holds true.
 885   // There are various exceptions:
 886   // - Inputs which are phis might in fact be widened unnecessarily.
 887   //   For example, an input might be a widened int while the phi is a short.
 888   // - Inputs might be BotPtrs but this phi is dependent on a null check,
 889   //   and postCCP has removed the cast which encodes the result of the check.
 890   // - The type of this phi is an interface, and the inputs are classes.
 891   // - Value calls on inputs might produce fuzzy results.
 892   //   (Occurrences of this case suggest improvements to Value methods.)
 893   //
 894   // It is not possible to see Type::BOTTOM values as phi inputs,
 895   // because the ciTypeFlow pre-pass produces verifier-quality types.
 896   const Type* ft = t->filter(_type);  // Worst case type
 897 
 898 #ifdef ASSERT
 899   // The following logic has been moved into TypeOopPtr::filter.
 900   const Type* jt = t->join(_type);
 901   if( jt->empty() ) {           // Emptied out???
 902 
 903     // Check for evil case of 't' being a class and '_type' expecting an
 904     // interface.  This can happen because the bytecodes do not contain
 905     // enough type info to distinguish a Java-level interface variable
 906     // from a Java-level object variable.  If we meet 2 classes which
 907     // both implement interface I, but their meet is at 'j/l/O' which
 908     // doesn't implement I, we have no way to tell if the result should
 909     // be 'I' or 'j/l/O'.  Thus we'll pick 'j/l/O'.  If this then flows
 910     // into a Phi which "knows" it's an Interface type we'll have to
 911     // uplift the type.
 912     if( !t->empty() && ttip && ttip->is_loaded() && ttip->klass()->is_interface() )
 913       { assert(ft == _type, ""); } // Uplift to interface
 914     // Otherwise it's something stupid like non-overlapping int ranges
 915     // found on dying counted loops.
 916     else
 917       { assert(ft == Type::TOP, ""); } // Canonical empty value
 918   }
 919 
 920   else {
 921 
 922     // If we have an interface-typed Phi and we narrow to a class type, the join
 923     // should report back the class.  However, if we have a J/L/Object
 924     // class-typed Phi and an interface flows in, it's possible that the meet &
 925     // join report an interface back out.  This isn't possible but happens
 926     // because the type system doesn't interact well with interfaces.
 927     const TypeInstPtr *jtip = jt->isa_narrowoop() ? jt->isa_narrowoop()->make_oopptr()->isa_instptr() : jt->isa_instptr();
 928     if( jtip && ttip ) {
 929       if( jtip->is_loaded() &&  jtip->klass()->is_interface() &&
 930           ttip->is_loaded() && !ttip->klass()->is_interface() ) {
 931         // Happens in a CTW of rt.jar, 320-341, no extra flags
 932         assert(ft == ttip->cast_to_ptr_type(jtip->ptr()) ||
 933                ft->isa_narrowoop() && ft->isa_narrowoop()->make_oopptr() == ttip->cast_to_ptr_type(jtip->ptr()), "");
 934         jt = ft;
 935       }
 936     }
 937     if (jt != ft && jt->base() == ft->base()) {
 938       if (jt->isa_int() &&
 939           jt->is_int()->_lo == ft->is_int()->_lo &&
 940           jt->is_int()->_hi == ft->is_int()->_hi)
 941         jt = ft;
 942       if (jt->isa_long() &&
 943           jt->is_long()->_lo == ft->is_long()->_lo &&
 944           jt->is_long()->_hi == ft->is_long()->_hi)
 945         jt = ft;
 946     }
 947     if (jt != ft) {
 948       tty->print("merge type:  "); t->dump(); tty->cr();
 949       tty->print("kill type:   "); _type->dump(); tty->cr();
 950       tty->print("join type:   "); jt->dump(); tty->cr();
 951       tty->print("filter type: "); ft->dump(); tty->cr();
 952     }
 953     assert(jt == ft, "");
 954   }
 955 #endif //ASSERT
 956 
 957   // Deal with conversion problems found in data loops.
 958   ft = phase->saturate(ft, phase->type_or_null(this), _type);
 959 
 960   return ft;
 961 }
 962 
 963 
 964 //------------------------------is_diamond_phi---------------------------------
 965 // Does this Phi represent a simple well-shaped diamond merge?  Return the
 966 // index of the true path or 0 otherwise.
 967 int PhiNode::is_diamond_phi() const {
 968   // Check for a 2-path merge
 969   Node *region = in(0);
 970   if( !region ) return 0;
 971   if( region->req() != 3 ) return 0;
 972   if(         req() != 3 ) return 0;
 973   // Check that both paths come from the same If
 974   Node *ifp1 = region->in(1);
 975   Node *ifp2 = region->in(2);
 976   if( !ifp1 || !ifp2 ) return 0;
 977   Node *iff = ifp1->in(0);
 978   if( !iff || !iff->is_If() ) return 0;
 979   if( iff != ifp2->in(0) ) return 0;
 980   // Check for a proper bool/cmp
 981   const Node *b = iff->in(1);
 982   if( !b->is_Bool() ) return 0;
 983   const Node *cmp = b->in(1);
 984   if( !cmp->is_Cmp() ) return 0;
 985 
 986   // Check for branching opposite expected
 987   if( ifp2->Opcode() == Op_IfTrue ) {
 988     assert( ifp1->Opcode() == Op_IfFalse, "" );
 989     return 2;
 990   } else {
 991     assert( ifp1->Opcode() == Op_IfTrue, "" );
 992     return 1;
 993   }
 994 }
 995 
 996 //----------------------------check_cmove_id-----------------------------------
 997 // Check for CMove'ing a constant after comparing against the constant.
 998 // Happens all the time now, since if we compare equality vs a constant in
 999 // the parser, we "know" the variable is constant on one path and we force
1000 // it.  Thus code like "if( x==0 ) {/*EMPTY*/}" ends up inserting a
1001 // conditional move: "x = (x==0)?0:x;".  Yucko.  This fix is slightly more
1002 // general in that we don't need constants.  Since CMove's are only inserted
1003 // in very special circumstances, we do it here on generic Phi's.
1004 Node* PhiNode::is_cmove_id(PhaseTransform* phase, int true_path) {
1005   assert(true_path !=0, "only diamond shape graph expected");
1006 
1007   // is_diamond_phi() has guaranteed the correctness of the nodes sequence:
1008   // phi->region->if_proj->ifnode->bool->cmp
1009   Node*     region = in(0);
1010   Node*     iff    = region->in(1)->in(0);
1011   BoolNode* b      = iff->in(1)->as_Bool();
1012   Node*     cmp    = b->in(1);
1013   Node*     tval   = in(true_path);
1014   Node*     fval   = in(3-true_path);
1015   Node*     id     = CMoveNode::is_cmove_id(phase, cmp, tval, fval, b);
1016   if (id == NULL)
1017     return NULL;
1018 
1019   // Either value might be a cast that depends on a branch of 'iff'.
1020   // Since the 'id' value will float free of the diamond, either
1021   // decast or return failure.
1022   Node* ctl = id->in(0);
1023   if (ctl != NULL && ctl->in(0) == iff) {
1024     if (id->is_ConstraintCast()) {
1025       return id->in(1);
1026     } else {
1027       // Don't know how to disentangle this value.
1028       return NULL;
1029     }
1030   }
1031 
1032   return id;
1033 }
1034 
1035 //------------------------------Identity---------------------------------------
1036 // Check for Region being Identity.
1037 Node *PhiNode::Identity( PhaseTransform *phase ) {
1038   // Check for no merging going on
1039   // (There used to be special-case code here when this->region->is_Loop.
1040   // It would check for a tributary phi on the backedge that the main phi
1041   // trivially, perhaps with a single cast.  The unique_input method
1042   // does all this and more, by reducing such tributaries to 'this'.)
1043   Node* uin = unique_input(phase);
1044   if (uin != NULL) {
1045     return uin;
1046   }
1047 
1048   int true_path = is_diamond_phi();
1049   if (true_path != 0) {
1050     Node* id = is_cmove_id(phase, true_path);
1051     if (id != NULL)  return id;
1052   }
1053 
1054   return this;                     // No identity
1055 }
1056 
1057 //-----------------------------unique_input------------------------------------
1058 // Find the unique value, discounting top, self-loops, and casts.
1059 // Return top if there are no inputs, and self if there are multiple.
1060 Node* PhiNode::unique_input(PhaseTransform* phase) {
1061   //  1) One unique direct input, or
1062   //  2) some of the inputs have an intervening ConstraintCast and
1063   //     the type of input is the same or sharper (more specific)
1064   //     than the phi's type.
1065   //  3) an input is a self loop
1066   //
1067   //  1) input   or   2) input     or   3) input __
1068   //     /   \           /   \               \  /  \
1069   //     \   /          |    cast             phi  cast
1070   //      phi            \   /               /  \  /
1071   //                      phi               /    --
1072 
1073   Node* r = in(0);                      // RegionNode
1074   if (r == NULL)  return in(1);         // Already degraded to a Copy
1075   Node* uncasted_input = NULL; // The unique uncasted input (ConstraintCasts removed)
1076   Node* direct_input   = NULL; // The unique direct input
1077 
1078   for (uint i = 1, cnt = req(); i < cnt; ++i) {
1079     Node* rc = r->in(i);
1080     if (rc == NULL || phase->type(rc) == Type::TOP)
1081       continue;                 // ignore unreachable control path
1082     Node* n = in(i);
1083     Node* un = n->uncast();
1084     if (un == NULL || un == this || phase->type(un) == Type::TOP) {
1085       continue; // ignore if top, or in(i) and "this" are in a data cycle
1086     }
1087     // Check for a unique uncasted input
1088     if (uncasted_input == NULL) {
1089       uncasted_input = un;
1090     } else if (uncasted_input != un) {
1091       uncasted_input = NodeSentinel; // no unique uncasted input
1092     }
1093     // Check for a unique direct input
1094     if (direct_input == NULL) {
1095       direct_input = n;
1096     } else if (direct_input != n) {
1097       direct_input = NodeSentinel; // no unique direct input
1098     }
1099   }
1100   if (direct_input == NULL) {
1101     return phase->C->top();        // no inputs
1102   }
1103   assert(uncasted_input != NULL,"");
1104 
1105   if (direct_input != NodeSentinel) {
1106     return direct_input;           // one unique direct input
1107   }
1108   if (uncasted_input != NodeSentinel &&
1109       phase->type(uncasted_input)->higher_equal(type())) {
1110     return uncasted_input;         // one unique uncasted input
1111   }
1112 
1113   // Nothing.
1114   return NULL;
1115 }
1116 
1117 //------------------------------is_x2logic-------------------------------------
1118 // Check for simple convert-to-boolean pattern
1119 // If:(C Bool) Region:(IfF IfT) Phi:(Region 0 1)
1120 // Convert Phi to an ConvIB.
1121 static Node *is_x2logic( PhaseGVN *phase, PhiNode *phi, int true_path ) {
1122   assert(true_path !=0, "only diamond shape graph expected");
1123   // Convert the true/false index into an expected 0/1 return.
1124   // Map 2->0 and 1->1.
1125   int flipped = 2-true_path;
1126 
1127   // is_diamond_phi() has guaranteed the correctness of the nodes sequence:
1128   // phi->region->if_proj->ifnode->bool->cmp
1129   Node *region = phi->in(0);
1130   Node *iff = region->in(1)->in(0);
1131   BoolNode *b = (BoolNode*)iff->in(1);
1132   const CmpNode *cmp = (CmpNode*)b->in(1);
1133 
1134   Node *zero = phi->in(1);
1135   Node *one  = phi->in(2);
1136   const Type *tzero = phase->type( zero );
1137   const Type *tone  = phase->type( one  );
1138 
1139   // Check for compare vs 0
1140   const Type *tcmp = phase->type(cmp->in(2));
1141   if( tcmp != TypeInt::ZERO && tcmp != TypePtr::NULL_PTR ) {
1142     // Allow cmp-vs-1 if the other input is bounded by 0-1
1143     if( !(tcmp == TypeInt::ONE && phase->type(cmp->in(1)) == TypeInt::BOOL) )
1144       return NULL;
1145     flipped = 1-flipped;        // Test is vs 1 instead of 0!
1146   }
1147 
1148   // Check for setting zero/one opposite expected
1149   if( tzero == TypeInt::ZERO ) {
1150     if( tone == TypeInt::ONE ) {
1151     } else return NULL;
1152   } else if( tzero == TypeInt::ONE ) {
1153     if( tone == TypeInt::ZERO ) {
1154       flipped = 1-flipped;
1155     } else return NULL;
1156   } else return NULL;
1157 
1158   // Check for boolean test backwards
1159   if( b->_test._test == BoolTest::ne ) {
1160   } else if( b->_test._test == BoolTest::eq ) {
1161     flipped = 1-flipped;
1162   } else return NULL;
1163 
1164   // Build int->bool conversion
1165   Node *n = new (phase->C, 2) Conv2BNode( cmp->in(1) );
1166   if( flipped )
1167     n = new (phase->C, 3) XorINode( phase->transform(n), phase->intcon(1) );
1168 
1169   return n;
1170 }
1171 
1172 //------------------------------is_cond_add------------------------------------
1173 // Check for simple conditional add pattern:  "(P < Q) ? X+Y : X;"
1174 // To be profitable the control flow has to disappear; there can be no other
1175 // values merging here.  We replace the test-and-branch with:
1176 // "(sgn(P-Q))&Y) + X".  Basically, convert "(P < Q)" into 0 or -1 by
1177 // moving the carry bit from (P-Q) into a register with 'sbb EAX,EAX'.
1178 // Then convert Y to 0-or-Y and finally add.
1179 // This is a key transform for SpecJava _201_compress.
1180 static Node* is_cond_add(PhaseGVN *phase, PhiNode *phi, int true_path) {
1181   assert(true_path !=0, "only diamond shape graph expected");
1182 
1183   // is_diamond_phi() has guaranteed the correctness of the nodes sequence:
1184   // phi->region->if_proj->ifnode->bool->cmp
1185   RegionNode *region = (RegionNode*)phi->in(0);
1186   Node *iff = region->in(1)->in(0);
1187   BoolNode* b = iff->in(1)->as_Bool();
1188   const CmpNode *cmp = (CmpNode*)b->in(1);
1189 
1190   // Make sure only merging this one phi here
1191   if (region->has_unique_phi() != phi)  return NULL;
1192 
1193   // Make sure each arm of the diamond has exactly one output, which we assume
1194   // is the region.  Otherwise, the control flow won't disappear.
1195   if (region->in(1)->outcnt() != 1) return NULL;
1196   if (region->in(2)->outcnt() != 1) return NULL;
1197 
1198   // Check for "(P < Q)" of type signed int
1199   if (b->_test._test != BoolTest::lt)  return NULL;
1200   if (cmp->Opcode() != Op_CmpI)        return NULL;
1201 
1202   Node *p = cmp->in(1);
1203   Node *q = cmp->in(2);
1204   Node *n1 = phi->in(  true_path);
1205   Node *n2 = phi->in(3-true_path);
1206 
1207   int op = n1->Opcode();
1208   if( op != Op_AddI           // Need zero as additive identity
1209       /*&&op != Op_SubI &&
1210       op != Op_AddP &&
1211       op != Op_XorI &&
1212       op != Op_OrI*/ )
1213     return NULL;
1214 
1215   Node *x = n2;
1216   Node *y = n1->in(1);
1217   if( n2 == n1->in(1) ) {
1218     y = n1->in(2);
1219   } else if( n2 == n1->in(1) ) {
1220   } else return NULL;
1221 
1222   // Not so profitable if compare and add are constants
1223   if( q->is_Con() && phase->type(q) != TypeInt::ZERO && y->is_Con() )
1224     return NULL;
1225 
1226   Node *cmplt = phase->transform( new (phase->C, 3) CmpLTMaskNode(p,q) );
1227   Node *j_and   = phase->transform( new (phase->C, 3) AndINode(cmplt,y) );
1228   return new (phase->C, 3) AddINode(j_and,x);
1229 }
1230 
1231 //------------------------------is_absolute------------------------------------
1232 // Check for absolute value.
1233 static Node* is_absolute( PhaseGVN *phase, PhiNode *phi_root, int true_path) {
1234   assert(true_path !=0, "only diamond shape graph expected");
1235 
1236   int  cmp_zero_idx = 0;        // Index of compare input where to look for zero
1237   int  phi_x_idx = 0;           // Index of phi input where to find naked x
1238 
1239   // ABS ends with the merge of 2 control flow paths.
1240   // Find the false path from the true path. With only 2 inputs, 3 - x works nicely.
1241   int false_path = 3 - true_path;
1242 
1243   // is_diamond_phi() has guaranteed the correctness of the nodes sequence:
1244   // phi->region->if_proj->ifnode->bool->cmp
1245   BoolNode *bol = phi_root->in(0)->in(1)->in(0)->in(1)->as_Bool();
1246 
1247   // Check bool sense
1248   switch( bol->_test._test ) {
1249   case BoolTest::lt: cmp_zero_idx = 1; phi_x_idx = true_path;  break;
1250   case BoolTest::le: cmp_zero_idx = 2; phi_x_idx = false_path; break;
1251   case BoolTest::gt: cmp_zero_idx = 2; phi_x_idx = true_path;  break;
1252   case BoolTest::ge: cmp_zero_idx = 1; phi_x_idx = false_path; break;
1253   default:           return NULL;                              break;
1254   }
1255 
1256   // Test is next
1257   Node *cmp = bol->in(1);
1258   const Type *tzero = NULL;
1259   switch( cmp->Opcode() ) {
1260   case Op_CmpF:    tzero = TypeF::ZERO; break; // Float ABS
1261   case Op_CmpD:    tzero = TypeD::ZERO; break; // Double ABS
1262   default: return NULL;
1263   }
1264 
1265   // Find zero input of compare; the other input is being abs'd
1266   Node *x = NULL;
1267   bool flip = false;
1268   if( phase->type(cmp->in(cmp_zero_idx)) == tzero ) {
1269     x = cmp->in(3 - cmp_zero_idx);
1270   } else if( phase->type(cmp->in(3 - cmp_zero_idx)) == tzero ) {
1271     // The test is inverted, we should invert the result...
1272     x = cmp->in(cmp_zero_idx);
1273     flip = true;
1274   } else {
1275     return NULL;
1276   }
1277 
1278   // Next get the 2 pieces being selected, one is the original value
1279   // and the other is the negated value.
1280   if( phi_root->in(phi_x_idx) != x ) return NULL;
1281 
1282   // Check other phi input for subtract node
1283   Node *sub = phi_root->in(3 - phi_x_idx);
1284 
1285   // Allow only Sub(0,X) and fail out for all others; Neg is not OK
1286   if( tzero == TypeF::ZERO ) {
1287     if( sub->Opcode() != Op_SubF ||
1288         sub->in(2) != x ||
1289         phase->type(sub->in(1)) != tzero ) return NULL;
1290     x = new (phase->C, 2) AbsFNode(x);
1291     if (flip) {
1292       x = new (phase->C, 3) SubFNode(sub->in(1), phase->transform(x));
1293     }
1294   } else {
1295     if( sub->Opcode() != Op_SubD ||
1296         sub->in(2) != x ||
1297         phase->type(sub->in(1)) != tzero ) return NULL;
1298     x = new (phase->C, 2) AbsDNode(x);
1299     if (flip) {
1300       x = new (phase->C, 3) SubDNode(sub->in(1), phase->transform(x));
1301     }
1302   }
1303 
1304   return x;
1305 }
1306 
1307 //------------------------------split_once-------------------------------------
1308 // Helper for split_flow_path
1309 static void split_once(PhaseIterGVN *igvn, Node *phi, Node *val, Node *n, Node *newn) {
1310   igvn->hash_delete(n);         // Remove from hash before hacking edges
1311 
1312   uint j = 1;
1313   for( uint i = phi->req()-1; i > 0; i-- ) {
1314     if( phi->in(i) == val ) {   // Found a path with val?
1315       // Add to NEW Region/Phi, no DU info
1316       newn->set_req( j++, n->in(i) );
1317       // Remove from OLD Region/Phi
1318       n->del_req(i);
1319     }
1320   }
1321 
1322   // Register the new node but do not transform it.  Cannot transform until the
1323   // entire Region/Phi conglerate has been hacked as a single huge transform.
1324   igvn->register_new_node_with_optimizer( newn );
1325   // Now I can point to the new node.
1326   n->add_req(newn);
1327   igvn->_worklist.push(n);
1328 }
1329 
1330 //------------------------------split_flow_path--------------------------------
1331 // Check for merging identical values and split flow paths
1332 static Node* split_flow_path(PhaseGVN *phase, PhiNode *phi) {
1333   BasicType bt = phi->type()->basic_type();
1334   if( bt == T_ILLEGAL || type2size[bt] <= 0 )
1335     return NULL;                // Bail out on funny non-value stuff
1336   if( phi->req() <= 3 )         // Need at least 2 matched inputs and a
1337     return NULL;                // third unequal input to be worth doing
1338 
1339   // Scan for a constant
1340   uint i;
1341   for( i = 1; i < phi->req()-1; i++ ) {
1342     Node *n = phi->in(i);
1343     if( !n ) return NULL;
1344     if( phase->type(n) == Type::TOP ) return NULL;
1345     if( n->Opcode() == Op_ConP )
1346       break;
1347   }
1348   if( i >= phi->req() )         // Only split for constants
1349     return NULL;
1350 
1351   Node *val = phi->in(i);       // Constant to split for
1352   uint hit = 0;                 // Number of times it occurs
1353 
1354   for( ; i < phi->req(); i++ ){ // Count occurances of constant
1355     Node *n = phi->in(i);
1356     if( !n ) return NULL;
1357     if( phase->type(n) == Type::TOP ) return NULL;
1358     if( phi->in(i) == val )
1359       hit++;
1360   }
1361 
1362   if( hit <= 1 ||               // Make sure we find 2 or more
1363       hit == phi->req()-1 )     // and not ALL the same value
1364     return NULL;
1365 
1366   // Now start splitting out the flow paths that merge the same value.
1367   // Split first the RegionNode.
1368   PhaseIterGVN *igvn = phase->is_IterGVN();
1369   Node *r = phi->region();
1370   RegionNode *newr = new (phase->C, hit+1) RegionNode(hit+1);
1371   split_once(igvn, phi, val, r, newr);
1372 
1373   // Now split all other Phis than this one
1374   for (DUIterator_Fast kmax, k = r->fast_outs(kmax); k < kmax; k++) {
1375     Node* phi2 = r->fast_out(k);
1376     if( phi2->is_Phi() && phi2->as_Phi() != phi ) {
1377       PhiNode *newphi = PhiNode::make_blank(newr, phi2);
1378       split_once(igvn, phi, val, phi2, newphi);
1379     }
1380   }
1381 
1382   // Clean up this guy
1383   igvn->hash_delete(phi);
1384   for( i = phi->req()-1; i > 0; i-- ) {
1385     if( phi->in(i) == val ) {
1386       phi->del_req(i);
1387     }
1388   }
1389   phi->add_req(val);
1390 
1391   return phi;
1392 }
1393 
1394 //=============================================================================
1395 //------------------------------simple_data_loop_check-------------------------
1396 //  Try to determing if the phi node in a simple safe/unsafe data loop.
1397 //  Returns:
1398 // enum LoopSafety { Safe = 0, Unsafe, UnsafeLoop };
1399 // Safe       - safe case when the phi and it's inputs reference only safe data
1400 //              nodes;
1401 // Unsafe     - the phi and it's inputs reference unsafe data nodes but there
1402 //              is no reference back to the phi - need a graph walk
1403 //              to determine if it is in a loop;
1404 // UnsafeLoop - unsafe case when the phi references itself directly or through
1405 //              unsafe data node.
1406 //  Note: a safe data node is a node which could/never reference itself during
1407 //  GVN transformations. For now it is Con, Proj, Phi, CastPP, CheckCastPP.
1408 //  I mark Phi nodes as safe node not only because they can reference itself
1409 //  but also to prevent mistaking the fallthrough case inside an outer loop
1410 //  as dead loop when the phi references itselfs through an other phi.
1411 PhiNode::LoopSafety PhiNode::simple_data_loop_check(Node *in) const {
1412   // It is unsafe loop if the phi node references itself directly.
1413   if (in == (Node*)this)
1414     return UnsafeLoop; // Unsafe loop
1415   // Unsafe loop if the phi node references itself through an unsafe data node.
1416   // Exclude cases with null inputs or data nodes which could reference
1417   // itself (safe for dead loops).
1418   if (in != NULL && !in->is_dead_loop_safe()) {
1419     // Check inputs of phi's inputs also.
1420     // It is much less expensive then full graph walk.
1421     uint cnt = in->req();
1422     for (uint i = 1; i < cnt; ++i) {
1423       Node* m = in->in(i);
1424       if (m == (Node*)this)
1425         return UnsafeLoop; // Unsafe loop
1426       if (m != NULL && !m->is_dead_loop_safe()) {
1427         // Check the most common case (about 30% of all cases):
1428         // phi->Load/Store->AddP->(ConP ConP Con)/(Parm Parm Con).
1429         Node *m1 = (m->is_AddP() && m->req() > 3) ? m->in(1) : NULL;
1430         if (m1 == (Node*)this)
1431           return UnsafeLoop; // Unsafe loop
1432         if (m1 != NULL && m1 == m->in(2) &&
1433             m1->is_dead_loop_safe() && m->in(3)->is_Con()) {
1434           continue; // Safe case
1435         }
1436         // The phi references an unsafe node - need full analysis.
1437         return Unsafe;
1438       }
1439     }
1440   }
1441   return Safe; // Safe case - we can optimize the phi node.
1442 }
1443 
1444 //------------------------------is_unsafe_data_reference-----------------------
1445 // If phi can be reached through the data input - it is data loop.
1446 bool PhiNode::is_unsafe_data_reference(Node *in) const {
1447   assert(req() > 1, "");
1448   // First, check simple cases when phi references itself directly or
1449   // through an other node.
1450   LoopSafety safety = simple_data_loop_check(in);
1451   if (safety == UnsafeLoop)
1452     return true;  // phi references itself - unsafe loop
1453   else if (safety == Safe)
1454     return false; // Safe case - phi could be replaced with the unique input.
1455 
1456   // Unsafe case when we should go through data graph to determine
1457   // if the phi references itself.
1458 
1459   ResourceMark rm;
1460 
1461   Arena *a = Thread::current()->resource_area();
1462   Node_List nstack(a);
1463   VectorSet visited(a);
1464 
1465   nstack.push(in); // Start with unique input.
1466   visited.set(in->_idx);
1467   while (nstack.size() != 0) {
1468     Node* n = nstack.pop();
1469     uint cnt = n->req();
1470     for (uint i = 1; i < cnt; i++) { // Only data paths
1471       Node* m = n->in(i);
1472       if (m == (Node*)this) {
1473         return true;    // Data loop
1474       }
1475       if (m != NULL && !m->is_dead_loop_safe()) { // Only look for unsafe cases.
1476         if (!visited.test_set(m->_idx))
1477           nstack.push(m);
1478       }
1479     }
1480   }
1481   return false; // The phi is not reachable from its inputs
1482 }
1483 
1484 
1485 //------------------------------Ideal------------------------------------------
1486 // Return a node which is more "ideal" than the current node.  Must preserve
1487 // the CFG, but we can still strip out dead paths.
1488 Node *PhiNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1489   // The next should never happen after 6297035 fix.
1490   if( is_copy() )               // Already degraded to a Copy ?
1491     return NULL;                // No change
1492 
1493   Node *r = in(0);              // RegionNode
1494   assert(r->in(0) == NULL || !r->in(0)->is_Root(), "not a specially hidden merge");
1495 
1496   // Note: During parsing, phis are often transformed before their regions.
1497   // This means we have to use type_or_null to defend against untyped regions.
1498   if( phase->type_or_null(r) == Type::TOP ) // Dead code?
1499     return NULL;                // No change
1500 
1501   Node *top = phase->C->top();
1502 
1503   // The are 2 situations when only one valid phi's input is left
1504   // (in addition to Region input).
1505   // One: region is not loop - replace phi with this input.
1506   // Two: region is loop - replace phi with top since this data path is dead
1507   //                       and we need to break the dead data loop.
1508   Node* progress = NULL;        // Record if any progress made
1509   for( uint j = 1; j < req(); ++j ){ // For all paths in
1510     // Check unreachable control paths
1511     Node* rc = r->in(j);
1512     Node* n = in(j);            // Get the input
1513     if (rc == NULL || phase->type(rc) == Type::TOP) {
1514       if (n != top) {           // Not already top?
1515         set_req(j, top);        // Nuke it down
1516         progress = this;        // Record progress
1517       }
1518     }
1519   }
1520 
1521   Node* uin = unique_input(phase);
1522   if (uin == top) {             // Simplest case: no alive inputs.
1523     if (can_reshape)            // IGVN transformation
1524       return top;
1525     else
1526       return NULL;              // Identity will return TOP
1527   } else if (uin != NULL) {
1528     // Only one not-NULL unique input path is left.
1529     // Determine if this input is backedge of a loop.
1530     // (Skip new phis which have no uses and dead regions).
1531     if( outcnt() > 0 && r->in(0) != NULL ) {
1532       // First, take the short cut when we know it is a loop and
1533       // the EntryControl data path is dead.
1534       assert(!r->is_Loop() || r->req() == 3, "Loop node should have 3 inputs");
1535       // Then, check if there is a data loop when phi references itself directly
1536       // or through other data nodes.
1537       if( r->is_Loop() && !phase->eqv_uncast(uin, in(LoopNode::EntryControl)) ||
1538          !r->is_Loop() && is_unsafe_data_reference(uin) ) {
1539         // Break this data loop to avoid creation of a dead loop.
1540         if (can_reshape) {
1541           return top;
1542         } else {
1543           // We can't return top if we are in Parse phase - cut inputs only
1544           // let Identity to handle the case.
1545           replace_edge(uin, top);
1546           return NULL;
1547         }
1548       }
1549     }
1550 
1551     // One unique input.
1552     debug_only(Node* ident = Identity(phase));
1553     // The unique input must eventually be detected by the Identity call.
1554 #ifdef ASSERT
1555     if (ident != uin && !ident->is_top()) {
1556       // print this output before failing assert
1557       r->dump(3);
1558       this->dump(3);
1559       ident->dump();
1560       uin->dump();
1561     }
1562 #endif
1563     assert(ident == uin || ident->is_top(), "Identity must clean this up");
1564     return NULL;
1565   }
1566 
1567 
1568   Node* opt = NULL;
1569   int true_path = is_diamond_phi();
1570   if( true_path != 0 ) {
1571     // Check for CMove'ing identity. If it would be unsafe,
1572     // handle it here. In the safe case, let Identity handle it.
1573     Node* unsafe_id = is_cmove_id(phase, true_path);
1574     if( unsafe_id != NULL && is_unsafe_data_reference(unsafe_id) )
1575       opt = unsafe_id;
1576 
1577     // Check for simple convert-to-boolean pattern
1578     if( opt == NULL )
1579       opt = is_x2logic(phase, this, true_path);
1580 
1581     // Check for absolute value
1582     if( opt == NULL )
1583       opt = is_absolute(phase, this, true_path);
1584 
1585     // Check for conditional add
1586     if( opt == NULL && can_reshape )
1587       opt = is_cond_add(phase, this, true_path);
1588 
1589     // These 4 optimizations could subsume the phi:
1590     // have to check for a dead data loop creation.
1591     if( opt != NULL ) {
1592       if( opt == unsafe_id || is_unsafe_data_reference(opt) ) {
1593         // Found dead loop.
1594         if( can_reshape )
1595           return top;
1596         // We can't return top if we are in Parse phase - cut inputs only
1597         // to stop further optimizations for this phi. Identity will return TOP.
1598         assert(req() == 3, "only diamond merge phi here");
1599         set_req(1, top);
1600         set_req(2, top);
1601         return NULL;
1602       } else {
1603         return opt;
1604       }
1605     }
1606   }
1607 
1608   // Check for merging identical values and split flow paths
1609   if (can_reshape) {
1610     opt = split_flow_path(phase, this);
1611     // This optimization only modifies phi - don't need to check for dead loop.
1612     assert(opt == NULL || phase->eqv(opt, this), "do not elide phi");
1613     if (opt != NULL)  return opt;
1614   }
1615 
1616   if (in(1) != NULL && in(1)->Opcode() == Op_AddP && can_reshape) {
1617     // Try to undo Phi of AddP:
1618     //   (Phi (AddP base base y) (AddP base2 base2 y))
1619     // becomes:
1620     //   newbase := (Phi base base2)
1621     //   (AddP newbase newbase y)
1622     //
1623     // This occurs as a result of unsuccessful split_thru_phi and
1624     // interferes with taking advantage of addressing modes.  See the
1625     // clone_shift_expressions code in matcher.cpp
1626     Node* addp = in(1);
1627     const Type* type = addp->in(AddPNode::Base)->bottom_type();
1628     Node* y = addp->in(AddPNode::Offset);
1629     if (y != NULL && addp->in(AddPNode::Base) == addp->in(AddPNode::Address)) {
1630       // make sure that all the inputs are similar to the first one,
1631       // i.e. AddP with base == address and same offset as first AddP
1632       bool doit = true;
1633       for (uint i = 2; i < req(); i++) {
1634         if (in(i) == NULL ||
1635             in(i)->Opcode() != Op_AddP ||
1636             in(i)->in(AddPNode::Base) != in(i)->in(AddPNode::Address) ||
1637             in(i)->in(AddPNode::Offset) != y) {
1638           doit = false;
1639           break;
1640         }
1641         // Accumulate type for resulting Phi
1642         type = type->meet(in(i)->in(AddPNode::Base)->bottom_type());
1643       }
1644       Node* base = NULL;
1645       if (doit) {
1646         // Check for neighboring AddP nodes in a tree.
1647         // If they have a base, use that it.
1648         for (DUIterator_Fast kmax, k = this->fast_outs(kmax); k < kmax; k++) {
1649           Node* u = this->fast_out(k);
1650           if (u->is_AddP()) {
1651             Node* base2 = u->in(AddPNode::Base);
1652             if (base2 != NULL && !base2->is_top()) {
1653               if (base == NULL)
1654                 base = base2;
1655               else if (base != base2)
1656                 { doit = false; break; }
1657             }
1658           }
1659         }
1660       }
1661       if (doit) {
1662         if (base == NULL) {
1663           base = new (phase->C, in(0)->req()) PhiNode(in(0), type, NULL);
1664           for (uint i = 1; i < req(); i++) {
1665             base->init_req(i, in(i)->in(AddPNode::Base));
1666           }
1667           phase->is_IterGVN()->register_new_node_with_optimizer(base);
1668         }
1669         return new (phase->C, 4) AddPNode(base, base, y);
1670       }
1671     }
1672   }
1673 
1674   // Split phis through memory merges, so that the memory merges will go away.
1675   // Piggy-back this transformation on the search for a unique input....
1676   // It will be as if the merged memory is the unique value of the phi.
1677   // (Do not attempt this optimization unless parsing is complete.
1678   // It would make the parser's memory-merge logic sick.)
1679   // (MergeMemNode is not dead_loop_safe - need to check for dead loop.)
1680   if (progress == NULL && can_reshape && type() == Type::MEMORY) {
1681     // see if this phi should be sliced
1682     uint merge_width = 0;
1683     bool saw_self = false;
1684     for( uint i=1; i<req(); ++i ) {// For all paths in
1685       Node *ii = in(i);
1686       if (ii->is_MergeMem()) {
1687         MergeMemNode* n = ii->as_MergeMem();
1688         merge_width = MAX2(merge_width, n->req());
1689         saw_self = saw_self || phase->eqv(n->base_memory(), this);
1690       }
1691     }
1692 
1693     // This restriction is temporarily necessary to ensure termination:
1694     if (!saw_self && adr_type() == TypePtr::BOTTOM)  merge_width = 0;
1695 
1696     if (merge_width > Compile::AliasIdxRaw) {
1697       // found at least one non-empty MergeMem
1698       const TypePtr* at = adr_type();
1699       if (at != TypePtr::BOTTOM) {
1700         // Patch the existing phi to select an input from the merge:
1701         // Phi:AT1(...MergeMem(m0, m1, m2)...) into
1702         //     Phi:AT1(...m1...)
1703         int alias_idx = phase->C->get_alias_index(at);
1704         for (uint i=1; i<req(); ++i) {
1705           Node *ii = in(i);
1706           if (ii->is_MergeMem()) {
1707             MergeMemNode* n = ii->as_MergeMem();
1708             // compress paths and change unreachable cycles to TOP
1709             // If not, we can update the input infinitely along a MergeMem cycle
1710             // Equivalent code is in MemNode::Ideal_common
1711             Node         *m  = phase->transform(n);
1712             // If tranformed to a MergeMem, get the desired slice
1713             // Otherwise the returned node represents memory for every slice
1714             Node *new_mem = (m->is_MergeMem()) ?
1715                              m->as_MergeMem()->memory_at(alias_idx) : m;
1716             // Update input if it is progress over what we have now
1717             if (new_mem != ii) {
1718               set_req(i, new_mem);
1719               progress = this;
1720             }
1721           }
1722         }
1723       } else {
1724         // We know that at least one MergeMem->base_memory() == this
1725         // (saw_self == true). If all other inputs also references this phi
1726         // (directly or through data nodes) - it is dead loop.
1727         bool saw_safe_input = false;
1728         for (uint j = 1; j < req(); ++j) {
1729           Node *n = in(j);
1730           if (n->is_MergeMem() && n->as_MergeMem()->base_memory() == this)
1731             continue;              // skip known cases
1732           if (!is_unsafe_data_reference(n)) {
1733             saw_safe_input = true; // found safe input
1734             break;
1735           }
1736         }
1737         if (!saw_safe_input)
1738           return top; // all inputs reference back to this phi - dead loop
1739 
1740         // Phi(...MergeMem(m0, m1:AT1, m2:AT2)...) into
1741         //     MergeMem(Phi(...m0...), Phi:AT1(...m1...), Phi:AT2(...m2...))
1742         PhaseIterGVN *igvn = phase->is_IterGVN();
1743         Node* hook = new (phase->C, 1) Node(1);
1744         PhiNode* new_base = (PhiNode*) clone();
1745         // Must eagerly register phis, since they participate in loops.
1746         if (igvn) {
1747           igvn->register_new_node_with_optimizer(new_base);
1748           hook->add_req(new_base);
1749         }
1750         MergeMemNode* result = MergeMemNode::make(phase->C, new_base);
1751         for (uint i = 1; i < req(); ++i) {
1752           Node *ii = in(i);
1753           if (ii->is_MergeMem()) {
1754             MergeMemNode* n = ii->as_MergeMem();
1755             for (MergeMemStream mms(result, n); mms.next_non_empty2(); ) {
1756               // If we have not seen this slice yet, make a phi for it.
1757               bool made_new_phi = false;
1758               if (mms.is_empty()) {
1759                 Node* new_phi = new_base->slice_memory(mms.adr_type(phase->C));
1760                 made_new_phi = true;
1761                 if (igvn) {
1762                   igvn->register_new_node_with_optimizer(new_phi);
1763                   hook->add_req(new_phi);
1764                 }
1765                 mms.set_memory(new_phi);
1766               }
1767               Node* phi = mms.memory();
1768               assert(made_new_phi || phi->in(i) == n, "replace the i-th merge by a slice");
1769               phi->set_req(i, mms.memory2());
1770             }
1771           }
1772         }
1773         // Distribute all self-loops.
1774         { // (Extra braces to hide mms.)
1775           for (MergeMemStream mms(result); mms.next_non_empty(); ) {
1776             Node* phi = mms.memory();
1777             for (uint i = 1; i < req(); ++i) {
1778               if (phi->in(i) == this)  phi->set_req(i, phi);
1779             }
1780           }
1781         }
1782         // now transform the new nodes, and return the mergemem
1783         for (MergeMemStream mms(result); mms.next_non_empty(); ) {
1784           Node* phi = mms.memory();
1785           mms.set_memory(phase->transform(phi));
1786         }
1787         if (igvn) { // Unhook.
1788           igvn->hash_delete(hook);
1789           for (uint i = 1; i < hook->req(); i++) {
1790             hook->set_req(i, NULL);
1791           }
1792         }
1793         // Replace self with the result.
1794         return result;
1795       }
1796     }
1797     //
1798     // Other optimizations on the memory chain
1799     //
1800     const TypePtr* at = adr_type();
1801     for( uint i=1; i<req(); ++i ) {// For all paths in
1802       Node *ii = in(i);
1803       Node *new_in = MemNode::optimize_memory_chain(ii, at, phase);
1804       if (ii != new_in ) {
1805         set_req(i, new_in);
1806         progress = this;
1807       }
1808     }
1809   }
1810 
1811   return progress;              // Return any progress
1812 }
1813 
1814 //------------------------------out_RegMask------------------------------------
1815 const RegMask &PhiNode::in_RegMask(uint i) const {
1816   return i ? out_RegMask() : RegMask::Empty;
1817 }
1818 
1819 const RegMask &PhiNode::out_RegMask() const {
1820   uint ideal_reg = Matcher::base2reg[_type->base()];
1821   assert( ideal_reg != Node::NotAMachineReg, "invalid type at Phi" );
1822   if( ideal_reg == 0 ) return RegMask::Empty;
1823   return *(Compile::current()->matcher()->idealreg2spillmask[ideal_reg]);
1824 }
1825 
1826 #ifndef PRODUCT
1827 void PhiNode::dump_spec(outputStream *st) const {
1828   TypeNode::dump_spec(st);
1829   if (in(0) != NULL &&
1830       in(0)->is_CountedLoop() &&
1831       in(0)->as_CountedLoop()->phi() == this) {
1832     st->print(" #tripcount");
1833   }
1834 }
1835 #endif
1836 
1837 
1838 //=============================================================================
1839 const Type *GotoNode::Value( PhaseTransform *phase ) const {
1840   // If the input is reachable, then we are executed.
1841   // If the input is not reachable, then we are not executed.
1842   return phase->type(in(0));
1843 }
1844 
1845 Node *GotoNode::Identity( PhaseTransform *phase ) {
1846   return in(0);                // Simple copy of incoming control
1847 }
1848 
1849 const RegMask &GotoNode::out_RegMask() const {
1850   return RegMask::Empty;
1851 }
1852 
1853 //=============================================================================
1854 const RegMask &JumpNode::out_RegMask() const {
1855   return RegMask::Empty;
1856 }
1857 
1858 //=============================================================================
1859 const RegMask &JProjNode::out_RegMask() const {
1860   return RegMask::Empty;
1861 }
1862 
1863 //=============================================================================
1864 const RegMask &CProjNode::out_RegMask() const {
1865   return RegMask::Empty;
1866 }
1867 
1868 
1869 
1870 //=============================================================================
1871 
1872 uint PCTableNode::hash() const { return Node::hash() + _size; }
1873 uint PCTableNode::cmp( const Node &n ) const
1874 { return _size == ((PCTableNode&)n)._size; }
1875 
1876 const Type *PCTableNode::bottom_type() const {
1877   const Type** f = TypeTuple::fields(_size);
1878   for( uint i = 0; i < _size; i++ ) f[i] = Type::CONTROL;
1879   return TypeTuple::make(_size, f);
1880 }
1881 
1882 //------------------------------Value------------------------------------------
1883 // Compute the type of the PCTableNode.  If reachable it is a tuple of
1884 // Control, otherwise the table targets are not reachable
1885 const Type *PCTableNode::Value( PhaseTransform *phase ) const {
1886   if( phase->type(in(0)) == Type::CONTROL )
1887     return bottom_type();
1888   return Type::TOP;             // All paths dead?  Then so are we
1889 }
1890 
1891 //------------------------------Ideal------------------------------------------
1892 // Return a node which is more "ideal" than the current node.  Strip out
1893 // control copies
1894 Node *PCTableNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1895   return remove_dead_region(phase, can_reshape) ? this : NULL;
1896 }
1897 
1898 //=============================================================================
1899 uint JumpProjNode::hash() const {
1900   return Node::hash() + _dest_bci;
1901 }
1902 
1903 uint JumpProjNode::cmp( const Node &n ) const {
1904   return ProjNode::cmp(n) &&
1905     _dest_bci == ((JumpProjNode&)n)._dest_bci;
1906 }
1907 
1908 #ifndef PRODUCT
1909 void JumpProjNode::dump_spec(outputStream *st) const {
1910   ProjNode::dump_spec(st);
1911    st->print("@bci %d ",_dest_bci);
1912 }
1913 #endif
1914 
1915 //=============================================================================
1916 //------------------------------Value------------------------------------------
1917 // Check for being unreachable, or for coming from a Rethrow.  Rethrow's cannot
1918 // have the default "fall_through_index" path.
1919 const Type *CatchNode::Value( PhaseTransform *phase ) const {
1920   // Unreachable?  Then so are all paths from here.
1921   if( phase->type(in(0)) == Type::TOP ) return Type::TOP;
1922   // First assume all paths are reachable
1923   const Type** f = TypeTuple::fields(_size);
1924   for( uint i = 0; i < _size; i++ ) f[i] = Type::CONTROL;
1925   // Identify cases that will always throw an exception
1926   // () rethrow call
1927   // () virtual or interface call with NULL receiver
1928   // () call is a check cast with incompatible arguments
1929   if( in(1)->is_Proj() ) {
1930     Node *i10 = in(1)->in(0);
1931     if( i10->is_Call() ) {
1932       CallNode *call = i10->as_Call();
1933       // Rethrows always throw exceptions, never return
1934       if (call->entry_point() == OptoRuntime::rethrow_stub()) {
1935         f[CatchProjNode::fall_through_index] = Type::TOP;
1936       } else if( call->req() > TypeFunc::Parms ) {
1937         const Type *arg0 = phase->type( call->in(TypeFunc::Parms) );
1938         // Check for null reciever to virtual or interface calls
1939         if( call->is_CallDynamicJava() &&
1940             arg0->higher_equal(TypePtr::NULL_PTR) ) {
1941           f[CatchProjNode::fall_through_index] = Type::TOP;
1942         }
1943       } // End of if not a runtime stub
1944     } // End of if have call above me
1945   } // End of slot 1 is not a projection
1946   return TypeTuple::make(_size, f);
1947 }
1948 
1949 //=============================================================================
1950 uint CatchProjNode::hash() const {
1951   return Node::hash() + _handler_bci;
1952 }
1953 
1954 
1955 uint CatchProjNode::cmp( const Node &n ) const {
1956   return ProjNode::cmp(n) &&
1957     _handler_bci == ((CatchProjNode&)n)._handler_bci;
1958 }
1959 
1960 
1961 //------------------------------Identity---------------------------------------
1962 // If only 1 target is possible, choose it if it is the main control
1963 Node *CatchProjNode::Identity( PhaseTransform *phase ) {
1964   // If my value is control and no other value is, then treat as ID
1965   const TypeTuple *t = phase->type(in(0))->is_tuple();
1966   if (t->field_at(_con) != Type::CONTROL)  return this;
1967   // If we remove the last CatchProj and elide the Catch/CatchProj, then we
1968   // also remove any exception table entry.  Thus we must know the call
1969   // feeding the Catch will not really throw an exception.  This is ok for
1970   // the main fall-thru control (happens when we know a call can never throw
1971   // an exception) or for "rethrow", because a further optimnization will
1972   // yank the rethrow (happens when we inline a function that can throw an
1973   // exception and the caller has no handler).  Not legal, e.g., for passing
1974   // a NULL receiver to a v-call, or passing bad types to a slow-check-cast.
1975   // These cases MUST throw an exception via the runtime system, so the VM
1976   // will be looking for a table entry.
1977   Node *proj = in(0)->in(1);    // Expect a proj feeding CatchNode
1978   CallNode *call;
1979   if (_con != TypeFunc::Control && // Bail out if not the main control.
1980       !(proj->is_Proj() &&      // AND NOT a rethrow
1981         proj->in(0)->is_Call() &&
1982         (call = proj->in(0)->as_Call()) &&
1983         call->entry_point() == OptoRuntime::rethrow_stub()))
1984     return this;
1985 
1986   // Search for any other path being control
1987   for (uint i = 0; i < t->cnt(); i++) {
1988     if (i != _con && t->field_at(i) == Type::CONTROL)
1989       return this;
1990   }
1991   // Only my path is possible; I am identity on control to the jump
1992   return in(0)->in(0);
1993 }
1994 
1995 
1996 #ifndef PRODUCT
1997 void CatchProjNode::dump_spec(outputStream *st) const {
1998   ProjNode::dump_spec(st);
1999   st->print("@bci %d ",_handler_bci);
2000 }
2001 #endif
2002 
2003 //=============================================================================
2004 //------------------------------Identity---------------------------------------
2005 // Check for CreateEx being Identity.
2006 Node *CreateExNode::Identity( PhaseTransform *phase ) {
2007   if( phase->type(in(1)) == Type::TOP ) return in(1);
2008   if( phase->type(in(0)) == Type::TOP ) return in(0);
2009   // We only come from CatchProj, unless the CatchProj goes away.
2010   // If the CatchProj is optimized away, then we just carry the
2011   // exception oop through.
2012   CallNode *call = in(1)->in(0)->as_Call();
2013 
2014   return ( in(0)->is_CatchProj() && in(0)->in(0)->in(1) == in(1) )
2015     ? this
2016     : call->in(TypeFunc::Parms);
2017 }
2018 
2019 //=============================================================================
2020 #ifndef PRODUCT
2021 void NeverBranchNode::format( PhaseRegAlloc *ra_, outputStream *st) const {
2022   st->print("%s", Name());
2023 }
2024 #endif