1 /*
   2  * Copyright (c) 2011, 2018, 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/loopnode.hpp"
  27 #include "opto/addnode.hpp"
  28 #include "opto/callnode.hpp"
  29 #include "opto/connode.hpp"
  30 #include "opto/convertnode.hpp"
  31 #include "opto/loopnode.hpp"
  32 #include "opto/matcher.hpp"
  33 #include "opto/mulnode.hpp"
  34 #include "opto/opaquenode.hpp"
  35 #include "opto/rootnode.hpp"
  36 #include "opto/subnode.hpp"
  37 #include <fenv.h>
  38 #include <math.h>
  39 
  40 /*
  41  * The general idea of Loop Predication is to insert a predicate on the entry
  42  * path to a loop, and raise a uncommon trap if the check of the condition fails.
  43  * The condition checks are promoted from inside the loop body, and thus
  44  * the checks inside the loop could be eliminated. Currently, loop predication
  45  * optimization has been applied to remove array range check and loop invariant
  46  * checks (such as null checks).
  47 */
  48 
  49 //-------------------------------register_control-------------------------
  50 void PhaseIdealLoop::register_control(Node* n, IdealLoopTree *loop, Node* pred) {
  51   assert(n->is_CFG(), "must be control node");
  52   _igvn.register_new_node_with_optimizer(n);
  53   loop->_body.push(n);
  54   set_loop(n, loop);
  55   // When called from beautify_loops() idom is not constructed yet.
  56   if (_idom != NULL) {
  57     set_idom(n, pred, dom_depth(pred));
  58   }
  59 }
  60 
  61 //------------------------------create_new_if_for_predicate------------------------
  62 // create a new if above the uct_if_pattern for the predicate to be promoted.
  63 //
  64 //          before                                after
  65 //        ----------                           ----------
  66 //           ctrl                                 ctrl
  67 //            |                                     |
  68 //            |                                     |
  69 //            v                                     v
  70 //           iff                                 new_iff
  71 //          /    \                                /      \
  72 //         /      \                              /        \
  73 //        v        v                            v          v
  74 //  uncommon_proj cont_proj                   if_uct     if_cont
  75 // \      |        |                           |          |
  76 //  \     |        |                           |          |
  77 //   v    v        v                           |          v
  78 //     rgn       loop                          |         iff
  79 //      |                                      |        /     \
  80 //      |                                      |       /       \
  81 //      v                                      |      v         v
  82 // uncommon_trap                               | uncommon_proj cont_proj
  83 //                                           \  \    |           |
  84 //                                            \  \   |           |
  85 //                                             v  v  v           v
  86 //                                               rgn           loop
  87 //                                                |
  88 //                                                |
  89 //                                                v
  90 //                                           uncommon_trap
  91 //
  92 //
  93 // We will create a region to guard the uct call if there is no one there.
  94 // The true projection (if_cont) of the new_iff is returned.
  95 // This code is also used to clone predicates to cloned loops.
  96 ProjNode* PhaseIdealLoop::create_new_if_for_predicate(ProjNode* cont_proj, Node* new_entry,
  97                                                       Deoptimization::DeoptReason reason,
  98                                                       int opcode) {
  99   assert(cont_proj->is_uncommon_trap_if_pattern(reason), "must be a uct if pattern!");
 100   IfNode* iff = cont_proj->in(0)->as_If();
 101 
 102   ProjNode *uncommon_proj = iff->proj_out(1 - cont_proj->_con);
 103   Node     *rgn   = uncommon_proj->unique_ctrl_out();
 104   assert(rgn->is_Region() || rgn->is_Call(), "must be a region or call uct");
 105 
 106   uint proj_index = 1; // region's edge corresponding to uncommon_proj
 107   if (!rgn->is_Region()) { // create a region to guard the call
 108     assert(rgn->is_Call(), "must be call uct");
 109     CallNode* call = rgn->as_Call();
 110     IdealLoopTree* loop = get_loop(call);
 111     rgn = new RegionNode(1);
 112     rgn->add_req(uncommon_proj);
 113     register_control(rgn, loop, uncommon_proj);
 114     _igvn.replace_input_of(call, 0, rgn);
 115     // When called from beautify_loops() idom is not constructed yet.
 116     if (_idom != NULL) {
 117       set_idom(call, rgn, dom_depth(rgn));
 118     }
 119     for (DUIterator_Fast imax, i = uncommon_proj->fast_outs(imax); i < imax; i++) {
 120       Node* n = uncommon_proj->fast_out(i);
 121       if (n->is_Load() || n->is_Store()) {
 122         _igvn.replace_input_of(n, 0, rgn);
 123         --i; --imax;
 124       }
 125     }
 126   } else {
 127     // Find region's edge corresponding to uncommon_proj
 128     for (; proj_index < rgn->req(); proj_index++)
 129       if (rgn->in(proj_index) == uncommon_proj) break;
 130     assert(proj_index < rgn->req(), "sanity");
 131   }
 132 
 133   Node* entry = iff->in(0);
 134   if (new_entry != NULL) {
 135     // Clonning the predicate to new location.
 136     entry = new_entry;
 137   }
 138   // Create new_iff
 139   IdealLoopTree* lp = get_loop(entry);
 140   IfNode* new_iff = NULL;
 141   if (opcode == Op_If) {
 142     new_iff = new IfNode(entry, iff->in(1), iff->_prob, iff->_fcnt);
 143   } else {
 144     assert(opcode == Op_RangeCheck, "no other if variant here");
 145     new_iff = new RangeCheckNode(entry, iff->in(1), iff->_prob, iff->_fcnt);
 146   }
 147   register_control(new_iff, lp, entry);
 148   Node *if_cont = new IfTrueNode(new_iff);
 149   Node *if_uct  = new IfFalseNode(new_iff);
 150   if (cont_proj->is_IfFalse()) {
 151     // Swap
 152     Node* tmp = if_uct; if_uct = if_cont; if_cont = tmp;
 153   }
 154   register_control(if_cont, lp, new_iff);
 155   register_control(if_uct, get_loop(rgn), new_iff);
 156 
 157   // if_uct to rgn
 158   _igvn.hash_delete(rgn);
 159   rgn->add_req(if_uct);
 160   // When called from beautify_loops() idom is not constructed yet.
 161   if (_idom != NULL) {
 162     Node* ridom = idom(rgn);
 163     Node* nrdom = dom_lca_internal(ridom, new_iff);
 164     set_idom(rgn, nrdom, dom_depth(rgn));
 165   }
 166 
 167   // If rgn has phis add new edges which has the same
 168   // value as on original uncommon_proj pass.
 169   assert(rgn->in(rgn->req() -1) == if_uct, "new edge should be last");
 170   bool has_phi = false;
 171   for (DUIterator_Fast imax, i = rgn->fast_outs(imax); i < imax; i++) {
 172     Node* use = rgn->fast_out(i);
 173     if (use->is_Phi() && use->outcnt() > 0) {
 174       assert(use->in(0) == rgn, "");
 175       _igvn.rehash_node_delayed(use);
 176       use->add_req(use->in(proj_index));
 177       has_phi = true;
 178     }
 179   }
 180   assert(!has_phi || rgn->req() > 3, "no phis when region is created");
 181 
 182   if (new_entry == NULL) {
 183     // Attach if_cont to iff
 184     _igvn.replace_input_of(iff, 0, if_cont);
 185     if (_idom != NULL) {
 186       set_idom(iff, if_cont, dom_depth(iff));
 187     }
 188   }
 189   return if_cont->as_Proj();
 190 }
 191 
 192 //------------------------------create_new_if_for_predicate------------------------
 193 // Create a new if below new_entry for the predicate to be cloned (IGVN optimization)
 194 ProjNode* PhaseIterGVN::create_new_if_for_predicate(ProjNode* cont_proj, Node* new_entry,
 195                                                     Deoptimization::DeoptReason reason,
 196                                                     int opcode) {
 197   assert(new_entry != 0, "only used for clone predicate");
 198   assert(cont_proj->is_uncommon_trap_if_pattern(reason), "must be a uct if pattern!");
 199   IfNode* iff = cont_proj->in(0)->as_If();
 200 
 201   ProjNode *uncommon_proj = iff->proj_out(1 - cont_proj->_con);
 202   Node     *rgn   = uncommon_proj->unique_ctrl_out();
 203   assert(rgn->is_Region() || rgn->is_Call(), "must be a region or call uct");
 204 
 205   uint proj_index = 1; // region's edge corresponding to uncommon_proj
 206   if (!rgn->is_Region()) { // create a region to guard the call
 207     assert(rgn->is_Call(), "must be call uct");
 208     CallNode* call = rgn->as_Call();
 209     rgn = new RegionNode(1);
 210     register_new_node_with_optimizer(rgn);
 211     rgn->add_req(uncommon_proj);
 212     replace_input_of(call, 0, rgn);
 213   } else {
 214     // Find region's edge corresponding to uncommon_proj
 215     for (; proj_index < rgn->req(); proj_index++)
 216       if (rgn->in(proj_index) == uncommon_proj) break;
 217     assert(proj_index < rgn->req(), "sanity");
 218   }
 219 
 220   // Create new_iff in new location.
 221   IfNode* new_iff = NULL;
 222   if (opcode == Op_If) {
 223     new_iff = new IfNode(new_entry, iff->in(1), iff->_prob, iff->_fcnt);
 224   } else {
 225     assert(opcode == Op_RangeCheck, "no other if variant here");
 226     new_iff = new RangeCheckNode(new_entry, iff->in(1), iff->_prob, iff->_fcnt);
 227   }
 228 
 229   register_new_node_with_optimizer(new_iff);
 230   Node *if_cont = new IfTrueNode(new_iff);
 231   Node *if_uct  = new IfFalseNode(new_iff);
 232   if (cont_proj->is_IfFalse()) {
 233     // Swap
 234     Node* tmp = if_uct; if_uct = if_cont; if_cont = tmp;
 235   }
 236   register_new_node_with_optimizer(if_cont);
 237   register_new_node_with_optimizer(if_uct);
 238 
 239   // if_uct to rgn
 240   hash_delete(rgn);
 241   rgn->add_req(if_uct);
 242 
 243   // If rgn has phis add corresponding new edges which has the same
 244   // value as on original uncommon_proj pass.
 245   assert(rgn->in(rgn->req() -1) == if_uct, "new edge should be last");
 246   bool has_phi = false;
 247   for (DUIterator_Fast imax, i = rgn->fast_outs(imax); i < imax; i++) {
 248     Node* use = rgn->fast_out(i);
 249     if (use->is_Phi() && use->outcnt() > 0) {
 250       rehash_node_delayed(use);
 251       use->add_req(use->in(proj_index));
 252       has_phi = true;
 253     }
 254   }
 255   assert(!has_phi || rgn->req() > 3, "no phis when region is created");
 256 
 257   return if_cont->as_Proj();
 258 }
 259 
 260 //--------------------------clone_predicate-----------------------
 261 ProjNode* PhaseIdealLoop::clone_predicate(ProjNode* predicate_proj, Node* new_entry,
 262                                           Deoptimization::DeoptReason reason,
 263                                           PhaseIdealLoop* loop_phase,
 264                                           PhaseIterGVN* igvn) {
 265   ProjNode* new_predicate_proj;
 266   if (loop_phase != NULL) {
 267     new_predicate_proj = loop_phase->create_new_if_for_predicate(predicate_proj, new_entry, reason, Op_If);
 268   } else {
 269     new_predicate_proj =       igvn->create_new_if_for_predicate(predicate_proj, new_entry, reason, Op_If);
 270   }
 271   IfNode* iff = new_predicate_proj->in(0)->as_If();
 272   Node* ctrl  = iff->in(0);
 273 
 274   // Match original condition since predicate's projections could be swapped.
 275   assert(predicate_proj->in(0)->in(1)->in(1)->Opcode()==Op_Opaque1, "must be");
 276   Node* opq = new Opaque1Node(igvn->C, predicate_proj->in(0)->in(1)->in(1)->in(1));
 277   igvn->C->add_predicate_opaq(opq);
 278 
 279   Node* bol = new Conv2BNode(opq);
 280   if (loop_phase != NULL) {
 281     loop_phase->register_new_node(opq, ctrl);
 282     loop_phase->register_new_node(bol, ctrl);
 283   } else {
 284     igvn->register_new_node_with_optimizer(opq);
 285     igvn->register_new_node_with_optimizer(bol);
 286   }
 287   igvn->hash_delete(iff);
 288   iff->set_req(1, bol);
 289   return new_predicate_proj;
 290 }
 291 
 292 
 293 //--------------------------clone_loop_predicates-----------------------
 294 // Interface from IGVN
 295 Node* PhaseIterGVN::clone_loop_predicates(Node* old_entry, Node* new_entry, bool clone_limit_check) {
 296   return PhaseIdealLoop::clone_loop_predicates(old_entry, new_entry, clone_limit_check, NULL, this);
 297 }
 298 
 299 // Interface from PhaseIdealLoop
 300 Node* PhaseIdealLoop::clone_loop_predicates(Node* old_entry, Node* new_entry, bool clone_limit_check) {
 301   return clone_loop_predicates(old_entry, new_entry, clone_limit_check, this, &this->_igvn);
 302 }
 303 
 304 // Clone loop predicates to cloned loops (peeled, unswitched, split_if).
 305 Node* PhaseIdealLoop::clone_loop_predicates(Node* old_entry, Node* new_entry,
 306                                             bool clone_limit_check,
 307                                             PhaseIdealLoop* loop_phase,
 308                                             PhaseIterGVN* igvn) {
 309 #ifdef ASSERT
 310   if (new_entry == NULL || !(new_entry->is_Proj() || new_entry->is_Region() || new_entry->is_SafePoint())) {
 311     if (new_entry != NULL)
 312       new_entry->dump();
 313     assert(false, "not IfTrue, IfFalse, Region or SafePoint");
 314   }
 315 #endif
 316   // Search original predicates
 317   Node* entry = old_entry;
 318   ProjNode* limit_check_proj = NULL;
 319   limit_check_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_loop_limit_check);
 320   if (limit_check_proj != NULL) {
 321     entry = skip_loop_predicates(entry);
 322   }
 323   ProjNode* profile_predicate_proj = NULL;
 324   ProjNode* predicate_proj = NULL;
 325   if (UseProfiledLoopPredicate) {
 326     profile_predicate_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_profile_predicate);
 327     if (profile_predicate_proj != NULL) {
 328       entry = skip_loop_predicates(entry);
 329     }
 330   }
 331   if (UseLoopPredicate) {
 332     predicate_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_predicate);
 333   }
 334   if (predicate_proj != NULL) { // right pattern that can be used by loop predication
 335     // clone predicate
 336     new_entry = clone_predicate(predicate_proj, new_entry,
 337                                 Deoptimization::Reason_predicate,
 338                                 loop_phase, igvn);
 339     assert(new_entry != NULL && new_entry->is_Proj(), "IfTrue or IfFalse after clone predicate");
 340     if (TraceLoopPredicate) {
 341       tty->print("Loop Predicate cloned: ");
 342       debug_only( new_entry->in(0)->dump(); );
 343     }
 344   }
 345   if (profile_predicate_proj != NULL) { // right pattern that can be used by loop predication
 346     // clone predicate
 347     new_entry = clone_predicate(profile_predicate_proj, new_entry,
 348                                 Deoptimization::Reason_profile_predicate,
 349                                 loop_phase, igvn);
 350     assert(new_entry != NULL && new_entry->is_Proj(), "IfTrue or IfFalse after clone predicate");
 351     if (TraceLoopPredicate) {
 352       tty->print("Loop Predicate cloned: ");
 353       debug_only( new_entry->in(0)->dump(); );
 354     }
 355   }
 356   if (limit_check_proj != NULL && clone_limit_check) {
 357     // Clone loop limit check last to insert it before loop.
 358     // Don't clone a limit check which was already finalized
 359     // for this counted loop (only one limit check is needed).
 360     new_entry = clone_predicate(limit_check_proj, new_entry,
 361                                 Deoptimization::Reason_loop_limit_check,
 362                                 loop_phase, igvn);
 363     assert(new_entry != NULL && new_entry->is_Proj(), "IfTrue or IfFalse after clone limit check");
 364     if (TraceLoopLimitCheck) {
 365       tty->print("Loop Limit Check cloned: ");
 366       debug_only( new_entry->in(0)->dump(); )
 367     }
 368   }
 369   return new_entry;
 370 }
 371 
 372 //--------------------------skip_loop_predicates------------------------------
 373 // Skip related predicates.
 374 Node* PhaseIdealLoop::skip_loop_predicates(Node* entry) {
 375   IfNode* iff = entry->in(0)->as_If();
 376   ProjNode* uncommon_proj = iff->proj_out(1 - entry->as_Proj()->_con);
 377   Node* rgn = uncommon_proj->unique_ctrl_out();
 378   assert(rgn->is_Region() || rgn->is_Call(), "must be a region or call uct");
 379   entry = entry->in(0)->in(0);
 380   while (entry != NULL && entry->is_Proj() && entry->in(0)->is_If()) {
 381     uncommon_proj = entry->in(0)->as_If()->proj_out(1 - entry->as_Proj()->_con);
 382     if (uncommon_proj->unique_ctrl_out() != rgn)
 383       break;
 384     entry = entry->in(0)->in(0);
 385   }
 386   return entry;
 387 }
 388 
 389 Node* PhaseIdealLoop::skip_all_loop_predicates(Node* entry) {
 390   Node* predicate = NULL;
 391   predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_loop_limit_check);
 392   if (predicate != NULL) {
 393     entry = skip_loop_predicates(entry);
 394   }
 395   if (UseProfiledLoopPredicate) {
 396     predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_profile_predicate);
 397     if (predicate != NULL) { // right pattern that can be used by loop predication
 398       entry = skip_loop_predicates(entry);
 399     }
 400   }
 401   if (UseLoopPredicate) {
 402     predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_predicate);
 403     if (predicate != NULL) { // right pattern that can be used by loop predication
 404       entry = skip_loop_predicates(entry);
 405     }
 406   }
 407   return entry;
 408 }
 409 
 410 //--------------------------find_predicate_insertion_point-------------------
 411 // Find a good location to insert a predicate
 412 ProjNode* PhaseIdealLoop::find_predicate_insertion_point(Node* start_c, Deoptimization::DeoptReason reason) {
 413   if (start_c == NULL || !start_c->is_Proj())
 414     return NULL;
 415   if (start_c->as_Proj()->is_uncommon_trap_if_pattern(reason)) {
 416     return start_c->as_Proj();
 417   }
 418   return NULL;
 419 }
 420 
 421 //--------------------------find_predicate------------------------------------
 422 // Find a predicate
 423 Node* PhaseIdealLoop::find_predicate(Node* entry) {
 424   Node* predicate = NULL;
 425   predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_loop_limit_check);
 426   if (predicate != NULL) { // right pattern that can be used by loop predication
 427     return entry;
 428   }
 429   if (UseLoopPredicate) {
 430     predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_predicate);
 431     if (predicate != NULL) { // right pattern that can be used by loop predication
 432       return entry;
 433     }
 434   }
 435   if (UseProfiledLoopPredicate) {
 436     predicate = find_predicate_insertion_point(entry, Deoptimization::Reason_profile_predicate);
 437     if (predicate != NULL) { // right pattern that can be used by loop predication
 438       return entry;
 439     }
 440   }
 441   return NULL;
 442 }
 443 
 444 //------------------------------Invariance-----------------------------------
 445 // Helper class for loop_predication_impl to compute invariance on the fly and
 446 // clone invariants.
 447 class Invariance : public StackObj {
 448   VectorSet _visited, _invariant;
 449   Node_Stack _stack;
 450   VectorSet _clone_visited;
 451   Node_List _old_new; // map of old to new (clone)
 452   IdealLoopTree* _lpt;
 453   PhaseIdealLoop* _phase;
 454 
 455   // Helper function to set up the invariance for invariance computation
 456   // If n is a known invariant, set up directly. Otherwise, look up the
 457   // the possibility to push n onto the stack for further processing.
 458   void visit(Node* use, Node* n) {
 459     if (_lpt->is_invariant(n)) { // known invariant
 460       _invariant.set(n->_idx);
 461     } else if (!n->is_CFG()) {
 462       Node *n_ctrl = _phase->ctrl_or_self(n);
 463       Node *u_ctrl = _phase->ctrl_or_self(use); // self if use is a CFG
 464       if (_phase->is_dominator(n_ctrl, u_ctrl)) {
 465         _stack.push(n, n->in(0) == NULL ? 1 : 0);
 466       }
 467     }
 468   }
 469 
 470   // Compute invariance for "the_node" and (possibly) all its inputs recursively
 471   // on the fly
 472   void compute_invariance(Node* n) {
 473     assert(_visited.test(n->_idx), "must be");
 474     visit(n, n);
 475     while (_stack.is_nonempty()) {
 476       Node*  n = _stack.node();
 477       uint idx = _stack.index();
 478       if (idx == n->req()) { // all inputs are processed
 479         _stack.pop();
 480         // n is invariant if it's inputs are all invariant
 481         bool all_inputs_invariant = true;
 482         for (uint i = 0; i < n->req(); i++) {
 483           Node* in = n->in(i);
 484           if (in == NULL) continue;
 485           assert(_visited.test(in->_idx), "must have visited input");
 486           if (!_invariant.test(in->_idx)) { // bad guy
 487             all_inputs_invariant = false;
 488             break;
 489           }
 490         }
 491         if (all_inputs_invariant) {
 492           // If n's control is a predicate that was moved out of the
 493           // loop, it was marked invariant but n is only invariant if
 494           // it depends only on that test. Otherwise, unless that test
 495           // is out of the loop, it's not invariant.
 496           if (n->is_CFG() || n->depends_only_on_test() || n->in(0) == NULL || !_phase->is_member(_lpt, n->in(0))) {
 497             _invariant.set(n->_idx); // I am a invariant too
 498           }
 499         }
 500       } else { // process next input
 501         _stack.set_index(idx + 1);
 502         Node* m = n->in(idx);
 503         if (m != NULL && !_visited.test_set(m->_idx)) {
 504           visit(n, m);
 505         }
 506       }
 507     }
 508   }
 509 
 510   // Helper function to set up _old_new map for clone_nodes.
 511   // If n is a known invariant, set up directly ("clone" of n == n).
 512   // Otherwise, push n onto the stack for real cloning.
 513   void clone_visit(Node* n) {
 514     assert(_invariant.test(n->_idx), "must be invariant");
 515     if (_lpt->is_invariant(n)) { // known invariant
 516       _old_new.map(n->_idx, n);
 517     } else { // to be cloned
 518       assert(!n->is_CFG(), "should not see CFG here");
 519       _stack.push(n, n->in(0) == NULL ? 1 : 0);
 520     }
 521   }
 522 
 523   // Clone "n" and (possibly) all its inputs recursively
 524   void clone_nodes(Node* n, Node* ctrl) {
 525     clone_visit(n);
 526     while (_stack.is_nonempty()) {
 527       Node*  n = _stack.node();
 528       uint idx = _stack.index();
 529       if (idx == n->req()) { // all inputs processed, clone n!
 530         _stack.pop();
 531         // clone invariant node
 532         Node* n_cl = n->clone();
 533         _old_new.map(n->_idx, n_cl);
 534         _phase->register_new_node(n_cl, ctrl);
 535         for (uint i = 0; i < n->req(); i++) {
 536           Node* in = n_cl->in(i);
 537           if (in == NULL) continue;
 538           n_cl->set_req(i, _old_new[in->_idx]);
 539         }
 540       } else { // process next input
 541         _stack.set_index(idx + 1);
 542         Node* m = n->in(idx);
 543         if (m != NULL && !_clone_visited.test_set(m->_idx)) {
 544           clone_visit(m); // visit the input
 545         }
 546       }
 547     }
 548   }
 549 
 550  public:
 551   Invariance(Arena* area, IdealLoopTree* lpt) :
 552     _visited(area), _invariant(area),
 553     _stack(area, 10 /* guess */),
 554     _clone_visited(area), _old_new(area),
 555     _lpt(lpt), _phase(lpt->_phase)
 556   {
 557     LoopNode* head = _lpt->_head->as_Loop();
 558     Node* entry = head->skip_strip_mined()->in(LoopNode::EntryControl);
 559     if (entry->outcnt() != 1) {
 560       // If a node is pinned between the predicates and the loop
 561       // entry, we won't be able to move any node in the loop that
 562       // depends on it above it in a predicate. Mark all those nodes
 563       // as non loop invariatnt.
 564       Unique_Node_List wq;
 565       wq.push(entry);
 566       for (uint next = 0; next < wq.size(); ++next) {
 567         Node *n = wq.at(next);
 568         for (DUIterator_Fast imax, i = n->fast_outs(imax); i < imax; i++) {
 569           Node* u = n->fast_out(i);
 570           if (!u->is_CFG()) {
 571             Node* c = _phase->get_ctrl(u);
 572             if (_lpt->is_member(_phase->get_loop(c)) || _phase->is_dominator(c, head)) {
 573               _visited.set(u->_idx);
 574               wq.push(u);
 575             }
 576           }
 577         }
 578       }
 579     }
 580   }
 581 
 582   // Map old to n for invariance computation and clone
 583   void map_ctrl(Node* old, Node* n) {
 584     assert(old->is_CFG() && n->is_CFG(), "must be");
 585     _old_new.map(old->_idx, n); // "clone" of old is n
 586     _invariant.set(old->_idx);  // old is invariant
 587     _clone_visited.set(old->_idx);
 588   }
 589 
 590   // Driver function to compute invariance
 591   bool is_invariant(Node* n) {
 592     if (!_visited.test_set(n->_idx))
 593       compute_invariance(n);
 594     return (_invariant.test(n->_idx) != 0);
 595   }
 596 
 597   // Driver function to clone invariant
 598   Node* clone(Node* n, Node* ctrl) {
 599     assert(ctrl->is_CFG(), "must be");
 600     assert(_invariant.test(n->_idx), "must be an invariant");
 601     if (!_clone_visited.test(n->_idx))
 602       clone_nodes(n, ctrl);
 603     return _old_new[n->_idx];
 604   }
 605 };
 606 
 607 //------------------------------is_range_check_if -----------------------------------
 608 // Returns true if the predicate of iff is in "scale*iv + offset u< load_range(ptr)" format
 609 // Note: this function is particularly designed for loop predication. We require load_range
 610 //       and offset to be loop invariant computed on the fly by "invar"
 611 bool IdealLoopTree::is_range_check_if(IfNode *iff, PhaseIdealLoop *phase, Invariance& invar) const {
 612   if (!is_loop_exit(iff)) {
 613     return false;
 614   }
 615   if (!iff->in(1)->is_Bool()) {
 616     return false;
 617   }
 618   const BoolNode *bol = iff->in(1)->as_Bool();
 619   if (bol->_test._test != BoolTest::lt) {
 620     return false;
 621   }
 622   if (!bol->in(1)->is_Cmp()) {
 623     return false;
 624   }
 625   const CmpNode *cmp = bol->in(1)->as_Cmp();
 626   if (cmp->Opcode() != Op_CmpU) {
 627     return false;
 628   }
 629   Node* range = cmp->in(2);
 630   if (range->Opcode() != Op_LoadRange && !iff->is_RangeCheck()) {
 631     const TypeInt* tint = phase->_igvn.type(range)->isa_int();
 632     if (tint == NULL || tint->empty() || tint->_lo < 0) {
 633       // Allow predication on positive values that aren't LoadRanges.
 634       // This allows optimization of loops where the length of the
 635       // array is a known value and doesn't need to be loaded back
 636       // from the array.
 637       return false;
 638     }
 639   }
 640   if (!invar.is_invariant(range)) {
 641     return false;
 642   }
 643   Node *iv     = _head->as_CountedLoop()->phi();
 644   int   scale  = 0;
 645   Node *offset = NULL;
 646   if (!phase->is_scaled_iv_plus_offset(cmp->in(1), iv, &scale, &offset)) {
 647     return false;
 648   }
 649   if (offset && !invar.is_invariant(offset)) { // offset must be invariant
 650     return false;
 651   }
 652   return true;
 653 }
 654 
 655 //------------------------------rc_predicate-----------------------------------
 656 // Create a range check predicate
 657 //
 658 // for (i = init; i < limit; i += stride) {
 659 //    a[scale*i+offset]
 660 // }
 661 //
 662 // Compute max(scale*i + offset) for init <= i < limit and build the predicate
 663 // as "max(scale*i + offset) u< a.length".
 664 //
 665 // There are two cases for max(scale*i + offset):
 666 // (1) stride*scale > 0
 667 //   max(scale*i + offset) = scale*(limit-stride) + offset
 668 // (2) stride*scale < 0
 669 //   max(scale*i + offset) = scale*init + offset
 670 BoolNode* PhaseIdealLoop::rc_predicate(IdealLoopTree *loop, Node* ctrl,
 671                                        int scale, Node* offset,
 672                                        Node* init, Node* limit, jint stride,
 673                                        Node* range, bool upper, bool &overflow) {
 674   jint con_limit  = (limit != NULL && limit->is_Con())  ? limit->get_int()  : 0;
 675   jint con_init   = init->is_Con()   ? init->get_int()   : 0;
 676   jint con_offset = offset->is_Con() ? offset->get_int() : 0;
 677 
 678   stringStream* predString = NULL;
 679   if (TraceLoopPredicate) {
 680     predString = new stringStream();
 681     predString->print("rc_predicate ");
 682   }
 683 
 684   overflow = false;
 685   Node* max_idx_expr = NULL;
 686   const TypeInt* idx_type = TypeInt::INT;
 687   if ((stride > 0) == (scale > 0) == upper) {
 688     guarantee(limit != NULL, "sanity");
 689     if (TraceLoopPredicate) {
 690       if (limit->is_Con()) {
 691         predString->print("(%d ", con_limit);
 692       } else {
 693         predString->print("(limit ");
 694       }
 695       predString->print("- %d) ", stride);
 696     }
 697     // Check if (limit - stride) may overflow
 698     const TypeInt* limit_type = _igvn.type(limit)->isa_int();
 699     jint limit_lo = limit_type->_lo;
 700     jint limit_hi = limit_type->_hi;
 701     if ((stride > 0 && (java_subtract(limit_lo, stride) < limit_lo)) ||
 702         (stride < 0 && (java_subtract(limit_hi, stride) > limit_hi))) {
 703       // No overflow possible
 704       ConINode* con_stride = _igvn.intcon(stride);
 705       set_ctrl(con_stride, C->root());
 706       max_idx_expr = new SubINode(limit, con_stride);
 707       idx_type = TypeInt::make(limit_lo - stride, limit_hi - stride, limit_type->_widen);
 708     } else {
 709       // May overflow
 710       overflow = true;
 711       limit = new ConvI2LNode(limit);
 712       register_new_node(limit, ctrl);
 713       ConLNode* con_stride = _igvn.longcon(stride);
 714       set_ctrl(con_stride, C->root());
 715       max_idx_expr = new SubLNode(limit, con_stride);
 716     }
 717     register_new_node(max_idx_expr, ctrl);
 718   } else {
 719     if (TraceLoopPredicate) {
 720       if (init->is_Con()) {
 721         predString->print("%d ", con_init);
 722       } else {
 723         predString->print("init ");
 724       }
 725     }
 726     idx_type = _igvn.type(init)->isa_int();
 727     max_idx_expr = init;
 728   }
 729 
 730   if (scale != 1) {
 731     ConNode* con_scale = _igvn.intcon(scale);
 732     set_ctrl(con_scale, C->root());
 733     if (TraceLoopPredicate) {
 734       predString->print("* %d ", scale);
 735     }
 736     // Check if (scale * max_idx_expr) may overflow
 737     const TypeInt* scale_type = TypeInt::make(scale);
 738     MulINode* mul = new MulINode(max_idx_expr, con_scale);
 739     idx_type = (TypeInt*)mul->mul_ring(idx_type, scale_type);
 740     if (overflow || TypeInt::INT->higher_equal(idx_type)) {
 741       // May overflow
 742       mul->destruct();
 743       if (!overflow) {
 744         max_idx_expr = new ConvI2LNode(max_idx_expr);
 745         register_new_node(max_idx_expr, ctrl);
 746       }
 747       overflow = true;
 748       con_scale = _igvn.longcon(scale);
 749       set_ctrl(con_scale, C->root());
 750       max_idx_expr = new MulLNode(max_idx_expr, con_scale);
 751     } else {
 752       // No overflow possible
 753       max_idx_expr = mul;
 754     }
 755     register_new_node(max_idx_expr, ctrl);
 756   }
 757 
 758   if (offset && (!offset->is_Con() || con_offset != 0)){
 759     if (TraceLoopPredicate) {
 760       if (offset->is_Con()) {
 761         predString->print("+ %d ", con_offset);
 762       } else {
 763         predString->print("+ offset");
 764       }
 765     }
 766     // Check if (max_idx_expr + offset) may overflow
 767     const TypeInt* offset_type = _igvn.type(offset)->isa_int();
 768     jint lo = java_add(idx_type->_lo, offset_type->_lo);
 769     jint hi = java_add(idx_type->_hi, offset_type->_hi);
 770     if (overflow || (lo > hi) ||
 771         ((idx_type->_lo & offset_type->_lo) < 0 && lo >= 0) ||
 772         ((~(idx_type->_hi | offset_type->_hi)) < 0 && hi < 0)) {
 773       // May overflow
 774       if (!overflow) {
 775         max_idx_expr = new ConvI2LNode(max_idx_expr);
 776         register_new_node(max_idx_expr, ctrl);
 777       }
 778       overflow = true;
 779       offset = new ConvI2LNode(offset);
 780       register_new_node(offset, ctrl);
 781       max_idx_expr = new AddLNode(max_idx_expr, offset);
 782     } else {
 783       // No overflow possible
 784       max_idx_expr = new AddINode(max_idx_expr, offset);
 785     }
 786     register_new_node(max_idx_expr, ctrl);
 787   }
 788 
 789   CmpNode* cmp = NULL;
 790   if (overflow) {
 791     // Integer expressions may overflow, do long comparison
 792     range = new ConvI2LNode(range);
 793     register_new_node(range, ctrl);
 794     cmp = new CmpULNode(max_idx_expr, range);
 795   } else {
 796     cmp = new CmpUNode(max_idx_expr, range);
 797   }
 798   register_new_node(cmp, ctrl);
 799   BoolNode* bol = new BoolNode(cmp, BoolTest::lt);
 800   register_new_node(bol, ctrl);
 801 
 802   if (TraceLoopPredicate) {
 803     predString->print_cr("<u range");
 804     tty->print("%s", predString->as_string());
 805   }
 806   return bol;
 807 }
 808 
 809 // Should loop predication look not only in the path from tail to head
 810 // but also in branches of the loop body?
 811 bool PhaseIdealLoop::loop_predication_should_follow_branches(IdealLoopTree *loop, ProjNode *predicate_proj, float& loop_trip_cnt) {
 812   if (!UseProfiledLoopPredicate) {
 813     return false;
 814   }
 815 
 816   if (predicate_proj == NULL) {
 817     return false;
 818   }
 819 
 820   LoopNode* head = loop->_head->as_Loop();
 821   bool follow_branches = true;
 822   IdealLoopTree* l = loop->_child;
 823   // For leaf loops and loops with a single inner loop
 824   while (l != NULL && follow_branches) {
 825     IdealLoopTree* child = l;
 826     if (child->_child != NULL &&
 827         child->_head->is_OuterStripMinedLoop()) {
 828       assert(child->_child->_next == NULL, "only one inner loop for strip mined loop");
 829       assert(child->_child->_head->is_CountedLoop() && child->_child->_head->as_CountedLoop()->is_strip_mined(), "inner loop should be strip mined");
 830       child = child->_child;
 831     }
 832     if (child->_child != NULL || child->_irreducible) {
 833       follow_branches = false;
 834     }
 835     l = l->_next;
 836   }
 837   if (follow_branches) {
 838     loop->compute_profile_trip_cnt(this);
 839     if (head->is_profile_trip_failed()) {
 840       follow_branches = false;
 841     } else {
 842       loop_trip_cnt = head->profile_trip_cnt();
 843       if (head->is_CountedLoop()) {
 844         CountedLoopNode* cl = head->as_CountedLoop();
 845         if (cl->phi() != NULL) {
 846           const TypeInt* t = _igvn.type(cl->phi())->is_int();
 847           float worst_case_trip_cnt = ((float)t->_hi - t->_lo) / ABS(cl->stride_con());
 848           if (worst_case_trip_cnt < loop_trip_cnt) {
 849             loop_trip_cnt = worst_case_trip_cnt;
 850           }
 851         }
 852       }
 853     }
 854   }
 855   return follow_branches;
 856 }
 857 
 858 // Compute probability of reaching some CFG node from a fixed
 859 // dominating CFG node
 860 class PathFrequency {
 861 private:
 862   Node* _dom; // frequencies are computed relative to this node
 863   Node_Stack _stack;
 864   GrowableArray<float> _freqs_stack; // keep track of intermediate result at regions
 865   GrowableArray<float> _freqs; // cache frequencies
 866   PhaseIdealLoop* _phase;
 867 
 868   void set_rounding(int mode) {
 869     // fesetround is broken on windows
 870     NOT_WINDOWS(fesetround(mode);)
 871   }
 872 
 873   void check_frequency(float f) {
 874     NOT_WINDOWS(assert(f <= 1 && f >= 0, "Incorrect frequency");)
 875   }
 876 
 877 public:
 878   PathFrequency(Node* dom, PhaseIdealLoop* phase)
 879     : _dom(dom), _stack(0), _phase(phase) {
 880   }
 881 
 882   float to(Node* n) {
 883     // post order walk on the CFG graph from n to _dom
 884     set_rounding(FE_TOWARDZERO); // make sure rounding doesn't push frequency above 1
 885     IdealLoopTree* loop = _phase->get_loop(_dom);
 886     Node* c = n;
 887     for (;;) {
 888       assert(_phase->get_loop(c) == loop, "have to be in the same loop");
 889       if (c == _dom || _freqs.at_grow(c->_idx, -1) >= 0) {
 890         float f = c == _dom ? 1 : _freqs.at(c->_idx);
 891         Node* prev = c;
 892         while (_stack.size() > 0 && prev == c) {
 893           Node* n = _stack.node();
 894           if (!n->is_Region()) {
 895             if (_phase->get_loop(n) != _phase->get_loop(n->in(0))) {
 896               // Found an inner loop: compute frequency of reaching this
 897               // exit from the loop head by looking at the number of
 898               // times each loop exit was taken
 899               IdealLoopTree* inner_loop = _phase->get_loop(n->in(0));
 900               LoopNode* inner_head = inner_loop->_head->as_Loop();
 901               assert(_phase->get_loop(n) == loop, "only 1 inner loop");
 902               if (inner_head->is_OuterStripMinedLoop()) {
 903                 inner_head->verify_strip_mined(1);
 904                 if (n->in(0) == inner_head->in(LoopNode::LoopBackControl)->in(0)) {
 905                   n = n->in(0)->in(0)->in(0);
 906                 }
 907                 inner_loop = inner_loop->_child;
 908                 inner_head = inner_loop->_head->as_Loop();
 909                 inner_head->verify_strip_mined(1);
 910               }
 911               set_rounding(FE_UPWARD);  // make sure rounding doesn't push frequency above 1
 912               float loop_exit_cnt = 0.0f;
 913               for (uint i = 0; i < inner_loop->_body.size(); i++) {
 914                 Node *n = inner_loop->_body[i];
 915                 float c = inner_loop->compute_profile_trip_cnt_helper(n);
 916                 loop_exit_cnt += c;
 917               }
 918               set_rounding(FE_TOWARDZERO);
 919               float cnt = -1;
 920               if (n->in(0)->is_If()) {
 921                 IfNode* iff = n->in(0)->as_If();
 922                 float p = n->in(0)->as_If()->_prob;
 923                 if (n->Opcode() == Op_IfFalse) {
 924                   p = 1 - p;
 925                 }
 926                 if (p > PROB_MIN) {
 927                   cnt = p * iff->_fcnt;
 928                 } else {
 929                   cnt = 0;
 930                 }
 931               } else {
 932                 assert(n->in(0)->is_Jump(), "unsupported node kind");
 933                 JumpNode* jmp = n->in(0)->as_Jump();
 934                 float p = n->in(0)->as_Jump()->_probs[n->as_JumpProj()->_con];
 935                 cnt = p * jmp->_fcnt;
 936               }
 937               float this_exit_f = cnt > 0 ? cnt / loop_exit_cnt : 0;
 938               check_frequency(this_exit_f);
 939               f = f * this_exit_f;
 940               check_frequency(f);
 941             } else {
 942               float p = -1;
 943               if (n->in(0)->is_If()) {
 944                 p = n->in(0)->as_If()->_prob;
 945                 if (n->Opcode() == Op_IfFalse) {
 946                   p = 1 - p;
 947                 }
 948               } else {
 949                 assert(n->in(0)->is_Jump(), "unsupported node kind");
 950                 p = n->in(0)->as_Jump()->_probs[n->as_JumpProj()->_con];
 951               }
 952               f = f * p;
 953               check_frequency(f);
 954             }
 955             _freqs.at_put_grow(n->_idx, (float)f, -1);
 956             _stack.pop();
 957           } else {
 958             float prev_f = _freqs_stack.pop();
 959             float new_f = f;
 960             f = new_f + prev_f;
 961             check_frequency(f);
 962             uint i = _stack.index();
 963             if (i < n->req()) {
 964               c = n->in(i);
 965               _stack.set_index(i+1);
 966               _freqs_stack.push(f);
 967             } else {
 968               _freqs.at_put_grow(n->_idx, f, -1);
 969               _stack.pop();
 970             }
 971           }
 972         }
 973         if (_stack.size() == 0) {
 974           set_rounding(FE_TONEAREST);
 975           check_frequency(f);
 976           return f;
 977         }
 978       } else if (c->is_Loop()) {
 979         ShouldNotReachHere();
 980         c = c->in(LoopNode::EntryControl);
 981       } else if (c->is_Region()) {
 982         _freqs_stack.push(0);
 983         _stack.push(c, 2);
 984         c = c->in(1);
 985       } else {
 986         if (c->is_IfProj()) {
 987           IfNode* iff = c->in(0)->as_If();
 988           if (iff->_prob == PROB_UNKNOWN) {
 989             // assume never taken
 990             _freqs.at_put_grow(c->_idx, 0, -1);
 991           } else if (_phase->get_loop(c) != _phase->get_loop(iff)) {
 992             if (iff->_fcnt == COUNT_UNKNOWN) {
 993               // assume never taken
 994               _freqs.at_put_grow(c->_idx, 0, -1);
 995             } else {
 996               // skip over loop
 997               _stack.push(c, 1);
 998               c = _phase->get_loop(c->in(0))->_head->as_Loop()->skip_strip_mined()->in(LoopNode::EntryControl);
 999             }
1000           } else {
1001             _stack.push(c, 1);
1002             c = iff;
1003           }
1004         } else if (c->is_JumpProj()) {
1005           JumpNode* jmp = c->in(0)->as_Jump();
1006           if (_phase->get_loop(c) != _phase->get_loop(jmp)) {
1007             if (jmp->_fcnt == COUNT_UNKNOWN) {
1008               // assume never taken
1009               _freqs.at_put_grow(c->_idx, 0, -1);
1010             } else {
1011               // skip over loop
1012               _stack.push(c, 1);
1013               c = _phase->get_loop(c->in(0))->_head->as_Loop()->skip_strip_mined()->in(LoopNode::EntryControl);
1014             }
1015           } else {
1016             _stack.push(c, 1);
1017             c = jmp;
1018           }
1019         } else if (c->Opcode() == Op_CatchProj &&
1020                    c->in(0)->Opcode() == Op_Catch &&
1021                    c->in(0)->in(0)->is_Proj() &&
1022                    c->in(0)->in(0)->in(0)->is_Call()) {
1023           // assume exceptions are never thrown
1024           uint con = c->as_Proj()->_con;
1025           if (con == CatchProjNode::fall_through_index) {
1026             Node* call = c->in(0)->in(0)->in(0)->in(0);
1027             if (_phase->get_loop(call) != _phase->get_loop(c)) {
1028               _freqs.at_put_grow(c->_idx, 0, -1);
1029             } else {
1030               c = call;
1031             }
1032           } else {
1033             assert(con >= CatchProjNode::catch_all_index, "what else?");
1034             _freqs.at_put_grow(c->_idx, 0, -1);
1035           }
1036         } else if (c->unique_ctrl_out() == NULL && !c->is_If() && !c->is_Jump()) {
1037           ShouldNotReachHere();
1038         } else {
1039           c = c->in(0);
1040         }
1041       }
1042     }
1043     ShouldNotReachHere();
1044     return -1;
1045   }
1046 };
1047 
1048 void PhaseIdealLoop::loop_predication_follow_branches(Node *n, IdealLoopTree *loop, float loop_trip_cnt,
1049                                                       PathFrequency& pf, Node_Stack& stack, VectorSet& seen,
1050                                                       Node_List& if_proj_list) {
1051   assert(n->is_Region(), "start from a region");
1052   Node* tail = loop->tail();
1053   stack.push(n, 1);
1054   do {
1055     Node* c = stack.node();
1056     assert(c->is_Region() || c->is_IfProj(), "only region here");
1057     uint i = stack.index();
1058 
1059     if (i < c->req()) {
1060       stack.set_index(i+1);
1061       Node* in = c->in(i);
1062       while (!is_dominator(in, tail) && !seen.test_set(in->_idx)) {
1063         IdealLoopTree* in_loop = get_loop(in);
1064         if (in_loop != loop) {
1065           in = in_loop->_head->in(LoopNode::EntryControl);
1066         } else if (in->is_Region()) {
1067           stack.push(in, 1);
1068           break;
1069         } else if (in->is_IfProj() &&
1070                    in->as_Proj()->is_uncommon_trap_if_pattern(Deoptimization::Reason_none) &&
1071                    (in->in(0)->Opcode() == Op_If ||
1072                     in->in(0)->Opcode() == Op_RangeCheck)) {
1073           if (pf.to(in) * loop_trip_cnt >= 1) {
1074             stack.push(in, 1);
1075           }
1076           in = in->in(0);
1077         } else {
1078           in = in->in(0);
1079         }
1080       }
1081     } else {
1082       if (c->is_IfProj()) {
1083         if_proj_list.push(c);
1084       }
1085       stack.pop();
1086     }
1087 
1088   } while (stack.size() > 0);
1089 }
1090 
1091 
1092 bool PhaseIdealLoop::loop_predication_impl_helper(IdealLoopTree *loop, ProjNode* proj, ProjNode *predicate_proj,
1093                                                   CountedLoopNode *cl, ConNode* zero, Invariance& invar,
1094                                                   Deoptimization::DeoptReason reason) {
1095   // Following are changed to nonnull when a predicate can be hoisted
1096   ProjNode* new_predicate_proj = NULL;
1097   IfNode*   iff  = proj->in(0)->as_If();
1098   Node*     test = iff->in(1);
1099   if (!test->is_Bool()){ //Conv2B, ...
1100     return false;
1101   }
1102   BoolNode* bol = test->as_Bool();
1103   if (invar.is_invariant(bol)) {
1104     // Invariant test
1105     new_predicate_proj = create_new_if_for_predicate(predicate_proj, NULL,
1106                                                      reason,
1107                                                      iff->Opcode());
1108     Node* ctrl = new_predicate_proj->in(0)->as_If()->in(0);
1109     BoolNode* new_predicate_bol = invar.clone(bol, ctrl)->as_Bool();
1110 
1111     // Negate test if necessary
1112     bool negated = false;
1113     if (proj->_con != predicate_proj->_con) {
1114       new_predicate_bol = new BoolNode(new_predicate_bol->in(1), new_predicate_bol->_test.negate());
1115       register_new_node(new_predicate_bol, ctrl);
1116       negated = true;
1117     }
1118     IfNode* new_predicate_iff = new_predicate_proj->in(0)->as_If();
1119     _igvn.hash_delete(new_predicate_iff);
1120     new_predicate_iff->set_req(1, new_predicate_bol);
1121 #ifndef PRODUCT
1122     if (TraceLoopPredicate) {
1123       tty->print("Predicate invariant if%s: %d ", negated ? " negated" : "", new_predicate_iff->_idx);
1124       loop->dump_head();
1125     } else if (TraceLoopOpts) {
1126       tty->print("Predicate IC ");
1127       loop->dump_head();
1128     }
1129 #endif
1130   } else if (cl != NULL && loop->is_range_check_if(iff, this, invar)) {
1131     // Range check for counted loops
1132     const Node*    cmp    = bol->in(1)->as_Cmp();
1133     Node*          idx    = cmp->in(1);
1134     assert(!invar.is_invariant(idx), "index is variant");
1135     Node* rng = cmp->in(2);
1136     assert(rng->Opcode() == Op_LoadRange || iff->is_RangeCheck() || _igvn.type(rng)->is_int()->_lo >= 0, "must be");
1137     assert(invar.is_invariant(rng), "range must be invariant");
1138     int scale    = 1;
1139     Node* offset = zero;
1140     bool ok = is_scaled_iv_plus_offset(idx, cl->phi(), &scale, &offset);
1141     assert(ok, "must be index expression");
1142 
1143     Node* init    = cl->init_trip();
1144     // Limit is not exact.
1145     // Calculate exact limit here.
1146     // Note, counted loop's test is '<' or '>'.
1147     Node* limit   = exact_limit(loop);
1148     int  stride   = cl->stride()->get_int();
1149 
1150     // Build if's for the upper and lower bound tests.  The
1151     // lower_bound test will dominate the upper bound test and all
1152     // cloned or created nodes will use the lower bound test as
1153     // their declared control.
1154 
1155     // Perform cloning to keep Invariance state correct since the
1156     // late schedule will place invariant things in the loop.
1157     Node *ctrl = predicate_proj->in(0)->as_If()->in(0);
1158     rng = invar.clone(rng, ctrl);
1159     if (offset && offset != zero) {
1160       assert(invar.is_invariant(offset), "offset must be loop invariant");
1161       offset = invar.clone(offset, ctrl);
1162     }
1163     // If predicate expressions may overflow in the integer range, longs are used.
1164     bool overflow = false;
1165 
1166     // Test the lower bound
1167     BoolNode* lower_bound_bol = rc_predicate(loop, ctrl, scale, offset, init, limit, stride, rng, false, overflow);
1168     // Negate test if necessary
1169     bool negated = false;
1170     if (proj->_con != predicate_proj->_con) {
1171       lower_bound_bol = new BoolNode(lower_bound_bol->in(1), lower_bound_bol->_test.negate());
1172       register_new_node(lower_bound_bol, ctrl);
1173       negated = true;
1174     }
1175     ProjNode* lower_bound_proj = create_new_if_for_predicate(predicate_proj, NULL, reason, overflow ? Op_If : iff->Opcode());
1176     IfNode* lower_bound_iff = lower_bound_proj->in(0)->as_If();
1177     _igvn.hash_delete(lower_bound_iff);
1178     lower_bound_iff->set_req(1, lower_bound_bol);
1179     if (TraceLoopPredicate) tty->print_cr("lower bound check if: %s %d ", negated ? " negated" : "", lower_bound_iff->_idx);
1180 
1181     // Test the upper bound
1182     BoolNode* upper_bound_bol = rc_predicate(loop, lower_bound_proj, scale, offset, init, limit, stride, rng, true, overflow);
1183     negated = false;
1184     if (proj->_con != predicate_proj->_con) {
1185       upper_bound_bol = new BoolNode(upper_bound_bol->in(1), upper_bound_bol->_test.negate());
1186       register_new_node(upper_bound_bol, ctrl);
1187       negated = true;
1188     }
1189     ProjNode* upper_bound_proj = create_new_if_for_predicate(predicate_proj, NULL, reason, overflow ? Op_If : iff->Opcode());
1190     assert(upper_bound_proj->in(0)->as_If()->in(0) == lower_bound_proj, "should dominate");
1191     IfNode* upper_bound_iff = upper_bound_proj->in(0)->as_If();
1192     _igvn.hash_delete(upper_bound_iff);
1193     upper_bound_iff->set_req(1, upper_bound_bol);
1194     if (TraceLoopPredicate) tty->print_cr("upper bound check if: %s %d ", negated ? " negated" : "", lower_bound_iff->_idx);
1195 
1196     // Fall through into rest of the clean up code which will move
1197     // any dependent nodes onto the upper bound test.
1198     new_predicate_proj = upper_bound_proj;
1199 
1200     if (iff->is_RangeCheck()) {
1201       new_predicate_proj = insert_skeleton_predicate(iff, loop, proj, predicate_proj, upper_bound_proj, scale, offset, init, limit, stride, rng, overflow, reason);
1202     }
1203 
1204 #ifndef PRODUCT
1205     if (TraceLoopOpts && !TraceLoopPredicate) {
1206       tty->print("Predicate RC ");
1207       loop->dump_head();
1208     }
1209 #endif
1210   } else {
1211     // Loop variant check (for example, range check in non-counted loop)
1212     // with uncommon trap.
1213     return false;
1214   }
1215   assert(new_predicate_proj != NULL, "sanity");
1216   // Success - attach condition (new_predicate_bol) to predicate if
1217   invar.map_ctrl(proj, new_predicate_proj); // so that invariance test can be appropriate
1218 
1219   // Eliminate the old If in the loop body
1220   dominated_by( new_predicate_proj, iff, proj->_con != new_predicate_proj->_con );
1221 
1222   C->set_major_progress();
1223   return true;
1224 }
1225 
1226 
1227 // After pre/main/post loops are created, we'll put a copy of some
1228 // range checks between the pre and main loop to validate the value
1229 // of the main loop induction variable. Make a copy of the predicates
1230 // here with an opaque node as a place holder for the value (will be
1231 // updated by PhaseIdealLoop::clone_skeleton_predicate()).
1232 ProjNode* PhaseIdealLoop::insert_skeleton_predicate(IfNode* iff, IdealLoopTree *loop,
1233                                                     ProjNode* proj, ProjNode *predicate_proj,
1234                                                     ProjNode* upper_bound_proj,
1235                                                     int scale, Node* offset,
1236                                                     Node* init, Node* limit, jint stride,
1237                                                     Node* rng, bool &overflow,
1238                                                     Deoptimization::DeoptReason reason) {
1239   assert(proj->_con && predicate_proj->_con, "not a range check?");
1240   Node* opaque_init = new Opaque1Node(C, init);
1241   register_new_node(opaque_init, upper_bound_proj);
1242   BoolNode* bol = rc_predicate(loop, upper_bound_proj, scale, offset, opaque_init, limit, stride, rng, (stride > 0) != (scale > 0), overflow);
1243   Node* opaque_bol = new Opaque4Node(C, bol, _igvn.intcon(1)); // This will go away once loop opts are over
1244   register_new_node(opaque_bol, upper_bound_proj);
1245   ProjNode* new_proj = create_new_if_for_predicate(predicate_proj, NULL, reason, overflow ? Op_If : iff->Opcode());
1246   _igvn.replace_input_of(new_proj->in(0), 1, opaque_bol);
1247   assert(opaque_init->outcnt() > 0, "should be used");
1248   return new_proj;
1249 }
1250 
1251 //------------------------------ loop_predication_impl--------------------------
1252 // Insert loop predicates for null checks and range checks
1253 bool PhaseIdealLoop::loop_predication_impl(IdealLoopTree *loop) {
1254   if (!UseLoopPredicate) return false;
1255 
1256   if (!loop->_head->is_Loop()) {
1257     // Could be a simple region when irreducible loops are present.
1258     return false;
1259   }
1260   LoopNode* head = loop->_head->as_Loop();
1261 
1262   if (head->unique_ctrl_out()->Opcode() == Op_NeverBranch) {
1263     // do nothing for infinite loops
1264     return false;
1265   }
1266 
1267   if (head->is_OuterStripMinedLoop()) {
1268     return false;
1269   }
1270 
1271   CountedLoopNode *cl = NULL;
1272   if (head->is_valid_counted_loop()) {
1273     cl = head->as_CountedLoop();
1274     // do nothing for iteration-splitted loops
1275     if (!cl->is_normal_loop()) return false;
1276     // Avoid RCE if Counted loop's test is '!='.
1277     BoolTest::mask bt = cl->loopexit()->test_trip();
1278     if (bt != BoolTest::lt && bt != BoolTest::gt)
1279       cl = NULL;
1280   }
1281 
1282   Node* entry = head->skip_strip_mined()->in(LoopNode::EntryControl);
1283   ProjNode *loop_limit_proj = NULL;
1284   ProjNode *predicate_proj = NULL;
1285   ProjNode *profile_predicate_proj = NULL;
1286   // Loop limit check predicate should be near the loop.
1287   loop_limit_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_loop_limit_check);
1288   if (loop_limit_proj != NULL) {
1289     entry = skip_loop_predicates(loop_limit_proj);
1290   }
1291   bool has_profile_predicates = false;
1292   profile_predicate_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_profile_predicate);
1293   if (profile_predicate_proj != NULL) {
1294     Node* n = skip_loop_predicates(entry);
1295     // Check if predicates were already added to the profile predicate
1296     // block
1297     if (n != entry->in(0)->in(0) || n->outcnt() != 1) {
1298       has_profile_predicates = true;
1299     }
1300     entry = n;
1301   }
1302   predicate_proj = find_predicate_insertion_point(entry, Deoptimization::Reason_predicate);
1303 
1304   float loop_trip_cnt = -1;
1305   bool follow_branches = loop_predication_should_follow_branches(loop, profile_predicate_proj, loop_trip_cnt);
1306   assert(!follow_branches || loop_trip_cnt >= 0, "negative trip count?");
1307 
1308   if (predicate_proj == NULL && !follow_branches) {
1309 #ifndef PRODUCT
1310     if (TraceLoopPredicate) {
1311       tty->print("missing predicate:");
1312       loop->dump_head();
1313       head->dump(1);
1314     }
1315 #endif
1316     return false;
1317   }
1318   ConNode* zero = _igvn.intcon(0);
1319   set_ctrl(zero, C->root());
1320 
1321   ResourceArea *area = Thread::current()->resource_area();
1322   Invariance invar(area, loop);
1323 
1324   // Create list of if-projs such that a newer proj dominates all older
1325   // projs in the list, and they all dominate loop->tail()
1326   Node_List if_proj_list(area);
1327   Node_List regions(area);
1328   Node *current_proj = loop->tail(); //start from tail
1329 
1330 
1331   Node_List controls(area);
1332   while (current_proj != head) {
1333     if (loop == get_loop(current_proj) && // still in the loop ?
1334         current_proj->is_Proj()        && // is a projection  ?
1335         (current_proj->in(0)->Opcode() == Op_If ||
1336          current_proj->in(0)->Opcode() == Op_RangeCheck)) { // is a if projection ?
1337       if_proj_list.push(current_proj);
1338     }
1339     if (follow_branches &&
1340         current_proj->Opcode() == Op_Region &&
1341         loop == get_loop(current_proj)) {
1342       regions.push(current_proj);
1343     }
1344     current_proj = idom(current_proj);
1345   }
1346 
1347   bool hoisted = false; // true if at least one proj is promoted
1348 
1349   if (!has_profile_predicates) {
1350     while (if_proj_list.size() > 0) {
1351       Node* n = if_proj_list.pop();
1352 
1353       ProjNode* proj = n->as_Proj();
1354       IfNode*   iff  = proj->in(0)->as_If();
1355 
1356       CallStaticJavaNode* call = proj->is_uncommon_trap_if_pattern(Deoptimization::Reason_none);
1357       if (call == NULL) {
1358         if (loop->is_loop_exit(iff)) {
1359           // stop processing the remaining projs in the list because the execution of them
1360           // depends on the condition of "iff" (iff->in(1)).
1361           break;
1362         } else {
1363           // Both arms are inside the loop. There are two cases:
1364           // (1) there is one backward branch. In this case, any remaining proj
1365           //     in the if_proj list post-dominates "iff". So, the condition of "iff"
1366           //     does not determine the execution the remining projs directly, and we
1367           //     can safely continue.
1368           // (2) both arms are forwarded, i.e. a diamond shape. In this case, "proj"
1369           //     does not dominate loop->tail(), so it can not be in the if_proj list.
1370           continue;
1371         }
1372       }
1373       Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(call->uncommon_trap_request());
1374       if (reason == Deoptimization::Reason_predicate) {
1375         break;
1376       }
1377 
1378       if (predicate_proj != NULL) {
1379         hoisted = loop_predication_impl_helper(loop, proj, predicate_proj, cl, zero, invar, Deoptimization::Reason_predicate) | hoisted;
1380       }
1381     } // end while
1382   }
1383 
1384   if (follow_branches) {
1385     PathFrequency pf(loop->_head, this);
1386 
1387     // Some projections were skipped by regular predicates because of
1388     // an early loop exit. Try them with profile data.
1389     while (if_proj_list.size() > 0) {
1390       Node* proj = if_proj_list.pop();
1391       if (proj->as_Proj()->is_uncommon_trap_if_pattern(Deoptimization::Reason_none) &&
1392           pf.to(proj) * loop_trip_cnt >= 1) {
1393         hoisted = loop_predication_impl_helper(loop, proj->as_Proj(), profile_predicate_proj, cl, zero, invar, Deoptimization::Reason_profile_predicate) | hoisted;
1394       }
1395     }
1396 
1397     // And look into all branches
1398     Node_Stack stack(0);
1399     VectorSet seen(Thread::current()->resource_area());
1400     Node_List if_proj_list_freq(area);
1401     while (regions.size() > 0) {
1402       Node* c = regions.pop();
1403       loop_predication_follow_branches(c, loop, loop_trip_cnt, pf, stack, seen, if_proj_list_freq);
1404     }
1405 
1406     for (uint i = 0; i < if_proj_list_freq.size(); i++) {
1407       ProjNode* proj = if_proj_list_freq.at(i)->as_Proj();
1408       hoisted = loop_predication_impl_helper(loop, proj, profile_predicate_proj, cl, zero, invar, Deoptimization::Reason_profile_predicate) | hoisted;
1409     }
1410   }
1411 
1412 #ifndef PRODUCT
1413   // report that the loop predication has been actually performed
1414   // for this loop
1415   if (TraceLoopPredicate && hoisted) {
1416     tty->print("Loop Predication Performed:");
1417     loop->dump_head();
1418   }
1419 #endif
1420 
1421   head->verify_strip_mined(1);
1422 
1423   return hoisted;
1424 }
1425 
1426 //------------------------------loop_predication--------------------------------
1427 // driver routine for loop predication optimization
1428 bool IdealLoopTree::loop_predication( PhaseIdealLoop *phase) {
1429   bool hoisted = false;
1430   // Recursively promote predicates
1431   if (_child) {
1432     hoisted = _child->loop_predication( phase);
1433   }
1434 
1435   // self
1436   if (!_irreducible && !tail()->is_top()) {
1437     hoisted |= phase->loop_predication_impl(this);
1438   }
1439 
1440   if (_next) { //sibling
1441     hoisted |= _next->loop_predication( phase);
1442   }
1443 
1444   return hoisted;
1445 }