1 /*
   2  * Copyright 2001-2008 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 #include "incls/_precompiled.incl"
  26 #include "incls/_graphKit.cpp.incl"
  27 
  28 //----------------------------GraphKit-----------------------------------------
  29 // Main utility constructor.
  30 GraphKit::GraphKit(JVMState* jvms)
  31   : Phase(Phase::Parser),
  32     _env(C->env()),
  33     _gvn(*C->initial_gvn())
  34 {
  35   _exceptions = jvms->map()->next_exception();
  36   if (_exceptions != NULL)  jvms->map()->set_next_exception(NULL);
  37   set_jvms(jvms);
  38 }
  39 
  40 // Private constructor for parser.
  41 GraphKit::GraphKit()
  42   : Phase(Phase::Parser),
  43     _env(C->env()),
  44     _gvn(*C->initial_gvn())
  45 {
  46   _exceptions = NULL;
  47   set_map(NULL);
  48   debug_only(_sp = -99);
  49   debug_only(set_bci(-99));
  50 }
  51 
  52 
  53 
  54 //---------------------------clean_stack---------------------------------------
  55 // Clear away rubbish from the stack area of the JVM state.
  56 // This destroys any arguments that may be waiting on the stack.
  57 void GraphKit::clean_stack(int from_sp) {
  58   SafePointNode* map      = this->map();
  59   JVMState*      jvms     = this->jvms();
  60   int            stk_size = jvms->stk_size();
  61   int            stkoff   = jvms->stkoff();
  62   Node*          top      = this->top();
  63   for (int i = from_sp; i < stk_size; i++) {
  64     if (map->in(stkoff + i) != top) {
  65       map->set_req(stkoff + i, top);
  66     }
  67   }
  68 }
  69 
  70 
  71 //--------------------------------sync_jvms-----------------------------------
  72 // Make sure our current jvms agrees with our parse state.
  73 JVMState* GraphKit::sync_jvms() const {
  74   JVMState* jvms = this->jvms();
  75   jvms->set_bci(bci());       // Record the new bci in the JVMState
  76   jvms->set_sp(sp());         // Record the new sp in the JVMState
  77   assert(jvms_in_sync(), "jvms is now in sync");
  78   return jvms;
  79 }
  80 
  81 #ifdef ASSERT
  82 bool GraphKit::jvms_in_sync() const {
  83   Parse* parse = is_Parse();
  84   if (parse == NULL) {
  85     if (bci() !=      jvms()->bci())          return false;
  86     if (sp()  != (int)jvms()->sp())           return false;
  87     return true;
  88   }
  89   if (jvms()->method() != parse->method())    return false;
  90   if (jvms()->bci()    != parse->bci())       return false;
  91   int jvms_sp = jvms()->sp();
  92   if (jvms_sp          != parse->sp())        return false;
  93   int jvms_depth = jvms()->depth();
  94   if (jvms_depth       != parse->depth())     return false;
  95   return true;
  96 }
  97 
  98 // Local helper checks for special internal merge points
  99 // used to accumulate and merge exception states.
 100 // They are marked by the region's in(0) edge being the map itself.
 101 // Such merge points must never "escape" into the parser at large,
 102 // until they have been handed to gvn.transform.
 103 static bool is_hidden_merge(Node* reg) {
 104   if (reg == NULL)  return false;
 105   if (reg->is_Phi()) {
 106     reg = reg->in(0);
 107     if (reg == NULL)  return false;
 108   }
 109   return reg->is_Region() && reg->in(0) != NULL && reg->in(0)->is_Root();
 110 }
 111 
 112 void GraphKit::verify_map() const {
 113   if (map() == NULL)  return;  // null map is OK
 114   assert(map()->req() <= jvms()->endoff(), "no extra garbage on map");
 115   assert(!map()->has_exceptions(),    "call add_exception_states_from 1st");
 116   assert(!is_hidden_merge(control()), "call use_exception_state, not set_map");
 117 }
 118 
 119 void GraphKit::verify_exception_state(SafePointNode* ex_map) {
 120   assert(ex_map->next_exception() == NULL, "not already part of a chain");
 121   assert(has_saved_ex_oop(ex_map), "every exception state has an ex_oop");
 122 }
 123 #endif
 124 
 125 //---------------------------stop_and_kill_map---------------------------------
 126 // Set _map to NULL, signalling a stop to further bytecode execution.
 127 // First smash the current map's control to a constant, to mark it dead.
 128 void GraphKit::stop_and_kill_map() {
 129   SafePointNode* dead_map = stop();
 130   if (dead_map != NULL) {
 131     dead_map->disconnect_inputs(NULL); // Mark the map as killed.
 132     assert(dead_map->is_killed(), "must be so marked");
 133   }
 134 }
 135 
 136 
 137 //--------------------------------stopped--------------------------------------
 138 // Tell if _map is NULL, or control is top.
 139 bool GraphKit::stopped() {
 140   if (map() == NULL)           return true;
 141   else if (control() == top()) return true;
 142   else                         return false;
 143 }
 144 
 145 
 146 //-----------------------------has_ex_handler----------------------------------
 147 // Tell if this method or any caller method has exception handlers.
 148 bool GraphKit::has_ex_handler() {
 149   for (JVMState* jvmsp = jvms(); jvmsp != NULL; jvmsp = jvmsp->caller()) {
 150     if (jvmsp->has_method() && jvmsp->method()->has_exception_handlers()) {
 151       return true;
 152     }
 153   }
 154   return false;
 155 }
 156 
 157 //------------------------------save_ex_oop------------------------------------
 158 // Save an exception without blowing stack contents or other JVM state.
 159 void GraphKit::set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop) {
 160   assert(!has_saved_ex_oop(ex_map), "clear ex-oop before setting again");
 161   ex_map->add_req(ex_oop);
 162   debug_only(verify_exception_state(ex_map));
 163 }
 164 
 165 inline static Node* common_saved_ex_oop(SafePointNode* ex_map, bool clear_it) {
 166   assert(GraphKit::has_saved_ex_oop(ex_map), "ex_oop must be there");
 167   Node* ex_oop = ex_map->in(ex_map->req()-1);
 168   if (clear_it)  ex_map->del_req(ex_map->req()-1);
 169   return ex_oop;
 170 }
 171 
 172 //-----------------------------saved_ex_oop------------------------------------
 173 // Recover a saved exception from its map.
 174 Node* GraphKit::saved_ex_oop(SafePointNode* ex_map) {
 175   return common_saved_ex_oop(ex_map, false);
 176 }
 177 
 178 //--------------------------clear_saved_ex_oop---------------------------------
 179 // Erase a previously saved exception from its map.
 180 Node* GraphKit::clear_saved_ex_oop(SafePointNode* ex_map) {
 181   return common_saved_ex_oop(ex_map, true);
 182 }
 183 
 184 #ifdef ASSERT
 185 //---------------------------has_saved_ex_oop----------------------------------
 186 // Erase a previously saved exception from its map.
 187 bool GraphKit::has_saved_ex_oop(SafePointNode* ex_map) {
 188   return ex_map->req() == ex_map->jvms()->endoff()+1;
 189 }
 190 #endif
 191 
 192 //-------------------------make_exception_state--------------------------------
 193 // Turn the current JVM state into an exception state, appending the ex_oop.
 194 SafePointNode* GraphKit::make_exception_state(Node* ex_oop) {
 195   sync_jvms();
 196   SafePointNode* ex_map = stop();  // do not manipulate this map any more
 197   set_saved_ex_oop(ex_map, ex_oop);
 198   return ex_map;
 199 }
 200 
 201 
 202 //--------------------------add_exception_state--------------------------------
 203 // Add an exception to my list of exceptions.
 204 void GraphKit::add_exception_state(SafePointNode* ex_map) {
 205   if (ex_map == NULL || ex_map->control() == top()) {
 206     return;
 207   }
 208 #ifdef ASSERT
 209   verify_exception_state(ex_map);
 210   if (has_exceptions()) {
 211     assert(ex_map->jvms()->same_calls_as(_exceptions->jvms()), "all collected exceptions must come from the same place");
 212   }
 213 #endif
 214 
 215   // If there is already an exception of exactly this type, merge with it.
 216   // In particular, null-checks and other low-level exceptions common up here.
 217   Node*       ex_oop  = saved_ex_oop(ex_map);
 218   const Type* ex_type = _gvn.type(ex_oop);
 219   if (ex_oop == top()) {
 220     // No action needed.
 221     return;
 222   }
 223   assert(ex_type->isa_instptr(), "exception must be an instance");
 224   for (SafePointNode* e2 = _exceptions; e2 != NULL; e2 = e2->next_exception()) {
 225     const Type* ex_type2 = _gvn.type(saved_ex_oop(e2));
 226     // We check sp also because call bytecodes can generate exceptions
 227     // both before and after arguments are popped!
 228     if (ex_type2 == ex_type
 229         && e2->_jvms->sp() == ex_map->_jvms->sp()) {
 230       combine_exception_states(ex_map, e2);
 231       return;
 232     }
 233   }
 234 
 235   // No pre-existing exception of the same type.  Chain it on the list.
 236   push_exception_state(ex_map);
 237 }
 238 
 239 //-----------------------add_exception_states_from-----------------------------
 240 void GraphKit::add_exception_states_from(JVMState* jvms) {
 241   SafePointNode* ex_map = jvms->map()->next_exception();
 242   if (ex_map != NULL) {
 243     jvms->map()->set_next_exception(NULL);
 244     for (SafePointNode* next_map; ex_map != NULL; ex_map = next_map) {
 245       next_map = ex_map->next_exception();
 246       ex_map->set_next_exception(NULL);
 247       add_exception_state(ex_map);
 248     }
 249   }
 250 }
 251 
 252 //-----------------------transfer_exceptions_into_jvms-------------------------
 253 JVMState* GraphKit::transfer_exceptions_into_jvms() {
 254   if (map() == NULL) {
 255     // We need a JVMS to carry the exceptions, but the map has gone away.
 256     // Create a scratch JVMS, cloned from any of the exception states...
 257     if (has_exceptions()) {
 258       _map = _exceptions;
 259       _map = clone_map();
 260       _map->set_next_exception(NULL);
 261       clear_saved_ex_oop(_map);
 262       debug_only(verify_map());
 263     } else {
 264       // ...or created from scratch
 265       JVMState* jvms = new (C) JVMState(_method, NULL);
 266       jvms->set_bci(_bci);
 267       jvms->set_sp(_sp);
 268       jvms->set_map(new (C, TypeFunc::Parms) SafePointNode(TypeFunc::Parms, jvms));
 269       set_jvms(jvms);
 270       for (uint i = 0; i < map()->req(); i++)  map()->init_req(i, top());
 271       set_all_memory(top());
 272       while (map()->req() < jvms->endoff())  map()->add_req(top());
 273     }
 274     // (This is a kludge, in case you didn't notice.)
 275     set_control(top());
 276   }
 277   JVMState* jvms = sync_jvms();
 278   assert(!jvms->map()->has_exceptions(), "no exceptions on this map yet");
 279   jvms->map()->set_next_exception(_exceptions);
 280   _exceptions = NULL;   // done with this set of exceptions
 281   return jvms;
 282 }
 283 
 284 static inline void add_n_reqs(Node* dstphi, Node* srcphi) {
 285   assert(is_hidden_merge(dstphi), "must be a special merge node");
 286   assert(is_hidden_merge(srcphi), "must be a special merge node");
 287   uint limit = srcphi->req();
 288   for (uint i = PhiNode::Input; i < limit; i++) {
 289     dstphi->add_req(srcphi->in(i));
 290   }
 291 }
 292 static inline void add_one_req(Node* dstphi, Node* src) {
 293   assert(is_hidden_merge(dstphi), "must be a special merge node");
 294   assert(!is_hidden_merge(src), "must not be a special merge node");
 295   dstphi->add_req(src);
 296 }
 297 
 298 //-----------------------combine_exception_states------------------------------
 299 // This helper function combines exception states by building phis on a
 300 // specially marked state-merging region.  These regions and phis are
 301 // untransformed, and can build up gradually.  The region is marked by
 302 // having a control input of its exception map, rather than NULL.  Such
 303 // regions do not appear except in this function, and in use_exception_state.
 304 void GraphKit::combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map) {
 305   if (failing())  return;  // dying anyway...
 306   JVMState* ex_jvms = ex_map->_jvms;
 307   assert(ex_jvms->same_calls_as(phi_map->_jvms), "consistent call chains");
 308   assert(ex_jvms->stkoff() == phi_map->_jvms->stkoff(), "matching locals");
 309   assert(ex_jvms->sp() == phi_map->_jvms->sp(), "matching stack sizes");
 310   assert(ex_jvms->monoff() == phi_map->_jvms->monoff(), "matching JVMS");
 311   assert(ex_map->req() == phi_map->req(), "matching maps");
 312   uint tos = ex_jvms->stkoff() + ex_jvms->sp();
 313   Node*         hidden_merge_mark = root();
 314   Node*         region  = phi_map->control();
 315   MergeMemNode* phi_mem = phi_map->merged_memory();
 316   MergeMemNode* ex_mem  = ex_map->merged_memory();
 317   if (region->in(0) != hidden_merge_mark) {
 318     // The control input is not (yet) a specially-marked region in phi_map.
 319     // Make it so, and build some phis.
 320     region = new (C, 2) RegionNode(2);
 321     _gvn.set_type(region, Type::CONTROL);
 322     region->set_req(0, hidden_merge_mark);  // marks an internal ex-state
 323     region->init_req(1, phi_map->control());
 324     phi_map->set_control(region);
 325     Node* io_phi = PhiNode::make(region, phi_map->i_o(), Type::ABIO);
 326     record_for_igvn(io_phi);
 327     _gvn.set_type(io_phi, Type::ABIO);
 328     phi_map->set_i_o(io_phi);
 329     for (MergeMemStream mms(phi_mem); mms.next_non_empty(); ) {
 330       Node* m = mms.memory();
 331       Node* m_phi = PhiNode::make(region, m, Type::MEMORY, mms.adr_type(C));
 332       record_for_igvn(m_phi);
 333       _gvn.set_type(m_phi, Type::MEMORY);
 334       mms.set_memory(m_phi);
 335     }
 336   }
 337 
 338   // Either or both of phi_map and ex_map might already be converted into phis.
 339   Node* ex_control = ex_map->control();
 340   // if there is special marking on ex_map also, we add multiple edges from src
 341   bool add_multiple = (ex_control->in(0) == hidden_merge_mark);
 342   // how wide was the destination phi_map, originally?
 343   uint orig_width = region->req();
 344 
 345   if (add_multiple) {
 346     add_n_reqs(region, ex_control);
 347     add_n_reqs(phi_map->i_o(), ex_map->i_o());
 348   } else {
 349     // ex_map has no merges, so we just add single edges everywhere
 350     add_one_req(region, ex_control);
 351     add_one_req(phi_map->i_o(), ex_map->i_o());
 352   }
 353   for (MergeMemStream mms(phi_mem, ex_mem); mms.next_non_empty2(); ) {
 354     if (mms.is_empty()) {
 355       // get a copy of the base memory, and patch some inputs into it
 356       const TypePtr* adr_type = mms.adr_type(C);
 357       Node* phi = mms.force_memory()->as_Phi()->slice_memory(adr_type);
 358       assert(phi->as_Phi()->region() == mms.base_memory()->in(0), "");
 359       mms.set_memory(phi);
 360       // Prepare to append interesting stuff onto the newly sliced phi:
 361       while (phi->req() > orig_width)  phi->del_req(phi->req()-1);
 362     }
 363     // Append stuff from ex_map:
 364     if (add_multiple) {
 365       add_n_reqs(mms.memory(), mms.memory2());
 366     } else {
 367       add_one_req(mms.memory(), mms.memory2());
 368     }
 369   }
 370   uint limit = ex_map->req();
 371   for (uint i = TypeFunc::Parms; i < limit; i++) {
 372     // Skip everything in the JVMS after tos.  (The ex_oop follows.)
 373     if (i == tos)  i = ex_jvms->monoff();
 374     Node* src = ex_map->in(i);
 375     Node* dst = phi_map->in(i);
 376     if (src != dst) {
 377       PhiNode* phi;
 378       if (dst->in(0) != region) {
 379         dst = phi = PhiNode::make(region, dst, _gvn.type(dst));
 380         record_for_igvn(phi);
 381         _gvn.set_type(phi, phi->type());
 382         phi_map->set_req(i, dst);
 383         // Prepare to append interesting stuff onto the new phi:
 384         while (dst->req() > orig_width)  dst->del_req(dst->req()-1);
 385       } else {
 386         assert(dst->is_Phi(), "nobody else uses a hidden region");
 387         phi = (PhiNode*)dst;
 388       }
 389       if (add_multiple && src->in(0) == ex_control) {
 390         // Both are phis.
 391         add_n_reqs(dst, src);
 392       } else {
 393         while (dst->req() < region->req())  add_one_req(dst, src);
 394       }
 395       const Type* srctype = _gvn.type(src);
 396       if (phi->type() != srctype) {
 397         const Type* dsttype = phi->type()->meet(srctype);
 398         if (phi->type() != dsttype) {
 399           phi->set_type(dsttype);
 400           _gvn.set_type(phi, dsttype);
 401         }
 402       }
 403     }
 404   }
 405 }
 406 
 407 //--------------------------use_exception_state--------------------------------
 408 Node* GraphKit::use_exception_state(SafePointNode* phi_map) {
 409   if (failing()) { stop(); return top(); }
 410   Node* region = phi_map->control();
 411   Node* hidden_merge_mark = root();
 412   assert(phi_map->jvms()->map() == phi_map, "sanity: 1-1 relation");
 413   Node* ex_oop = clear_saved_ex_oop(phi_map);
 414   if (region->in(0) == hidden_merge_mark) {
 415     // Special marking for internal ex-states.  Process the phis now.
 416     region->set_req(0, region);  // now it's an ordinary region
 417     set_jvms(phi_map->jvms());   // ...so now we can use it as a map
 418     // Note: Setting the jvms also sets the bci and sp.
 419     set_control(_gvn.transform(region));
 420     uint tos = jvms()->stkoff() + sp();
 421     for (uint i = 1; i < tos; i++) {
 422       Node* x = phi_map->in(i);
 423       if (x->in(0) == region) {
 424         assert(x->is_Phi(), "expected a special phi");
 425         phi_map->set_req(i, _gvn.transform(x));
 426       }
 427     }
 428     for (MergeMemStream mms(merged_memory()); mms.next_non_empty(); ) {
 429       Node* x = mms.memory();
 430       if (x->in(0) == region) {
 431         assert(x->is_Phi(), "nobody else uses a hidden region");
 432         mms.set_memory(_gvn.transform(x));
 433       }
 434     }
 435     if (ex_oop->in(0) == region) {
 436       assert(ex_oop->is_Phi(), "expected a special phi");
 437       ex_oop = _gvn.transform(ex_oop);
 438     }
 439   } else {
 440     set_jvms(phi_map->jvms());
 441   }
 442 
 443   assert(!is_hidden_merge(phi_map->control()), "hidden ex. states cleared");
 444   assert(!is_hidden_merge(phi_map->i_o()), "hidden ex. states cleared");
 445   return ex_oop;
 446 }
 447 
 448 //---------------------------------java_bc-------------------------------------
 449 Bytecodes::Code GraphKit::java_bc() const {
 450   ciMethod* method = this->method();
 451   int       bci    = this->bci();
 452   if (method != NULL && bci != InvocationEntryBci)
 453     return method->java_code_at_bci(bci);
 454   else
 455     return Bytecodes::_illegal;
 456 }
 457 
 458 //------------------------------builtin_throw----------------------------------
 459 void GraphKit::builtin_throw(Deoptimization::DeoptReason reason, Node* arg) {
 460   bool must_throw = true;
 461 
 462   if (JvmtiExport::can_post_exceptions()) {
 463     // Do not try anything fancy if we're notifying the VM on every throw.
 464     // Cf. case Bytecodes::_athrow in parse2.cpp.
 465     uncommon_trap(reason, Deoptimization::Action_none,
 466                   (ciKlass*)NULL, (char*)NULL, must_throw);
 467     return;
 468   }
 469 
 470   // If this particular condition has not yet happened at this
 471   // bytecode, then use the uncommon trap mechanism, and allow for
 472   // a future recompilation if several traps occur here.
 473   // If the throw is hot, try to use a more complicated inline mechanism
 474   // which keeps execution inside the compiled code.
 475   bool treat_throw_as_hot = false;
 476   ciMethodData* md = method()->method_data();
 477 
 478   if (ProfileTraps) {
 479     if (too_many_traps(reason)) {
 480       treat_throw_as_hot = true;
 481     }
 482     // (If there is no MDO at all, assume it is early in
 483     // execution, and that any deopts are part of the
 484     // startup transient, and don't need to be remembered.)
 485 
 486     // Also, if there is a local exception handler, treat all throws
 487     // as hot if there has been at least one in this method.
 488     if (C->trap_count(reason) != 0
 489         && method()->method_data()->trap_count(reason) != 0
 490         && has_ex_handler()) {
 491         treat_throw_as_hot = true;
 492     }
 493   }
 494 
 495   // If this throw happens frequently, an uncommon trap might cause
 496   // a performance pothole.  If there is a local exception handler,
 497   // and if this particular bytecode appears to be deoptimizing often,
 498   // let us handle the throw inline, with a preconstructed instance.
 499   // Note:   If the deopt count has blown up, the uncommon trap
 500   // runtime is going to flush this nmethod, not matter what.
 501   if (treat_throw_as_hot
 502       && (!StackTraceInThrowable || OmitStackTraceInFastThrow)) {
 503     // If the throw is local, we use a pre-existing instance and
 504     // punt on the backtrace.  This would lead to a missing backtrace
 505     // (a repeat of 4292742) if the backtrace object is ever asked
 506     // for its backtrace.
 507     // Fixing this remaining case of 4292742 requires some flavor of
 508     // escape analysis.  Leave that for the future.
 509     ciInstance* ex_obj = NULL;
 510     switch (reason) {
 511     case Deoptimization::Reason_null_check:
 512       ex_obj = env()->NullPointerException_instance();
 513       break;
 514     case Deoptimization::Reason_div0_check:
 515       ex_obj = env()->ArithmeticException_instance();
 516       break;
 517     case Deoptimization::Reason_range_check:
 518       ex_obj = env()->ArrayIndexOutOfBoundsException_instance();
 519       break;
 520     case Deoptimization::Reason_class_check:
 521       if (java_bc() == Bytecodes::_aastore) {
 522         ex_obj = env()->ArrayStoreException_instance();
 523       } else {
 524         ex_obj = env()->ClassCastException_instance();
 525       }
 526       break;
 527     }
 528     if (failing()) { stop(); return; }  // exception allocation might fail
 529     if (ex_obj != NULL) {
 530       // Cheat with a preallocated exception object.
 531       if (C->log() != NULL)
 532         C->log()->elem("hot_throw preallocated='1' reason='%s'",
 533                        Deoptimization::trap_reason_name(reason));
 534       const TypeInstPtr* ex_con  = TypeInstPtr::make(ex_obj);
 535       Node*              ex_node = _gvn.transform( ConNode::make(C, ex_con) );
 536 
 537       // Clear the detail message of the preallocated exception object.
 538       // Weblogic sometimes mutates the detail message of exceptions
 539       // using reflection.
 540       int offset = java_lang_Throwable::get_detailMessage_offset();
 541       const TypePtr* adr_typ = ex_con->add_offset(offset);
 542 
 543       Node *adr = basic_plus_adr(ex_node, ex_node, offset);
 544       Node *store = store_oop_to_object(control(), ex_node, adr, adr_typ, null(), ex_con, T_OBJECT);
 545 
 546       add_exception_state(make_exception_state(ex_node));
 547       return;
 548     }
 549   }
 550 
 551   // %%% Maybe add entry to OptoRuntime which directly throws the exc.?
 552   // It won't be much cheaper than bailing to the interp., since we'll
 553   // have to pass up all the debug-info, and the runtime will have to
 554   // create the stack trace.
 555 
 556   // Usual case:  Bail to interpreter.
 557   // Reserve the right to recompile if we haven't seen anything yet.
 558 
 559   Deoptimization::DeoptAction action = Deoptimization::Action_maybe_recompile;
 560   if (treat_throw_as_hot
 561       && (method()->method_data()->trap_recompiled_at(bci())
 562           || C->too_many_traps(reason))) {
 563     // We cannot afford to take more traps here.  Suffer in the interpreter.
 564     if (C->log() != NULL)
 565       C->log()->elem("hot_throw preallocated='0' reason='%s' mcount='%d'",
 566                      Deoptimization::trap_reason_name(reason),
 567                      C->trap_count(reason));
 568     action = Deoptimization::Action_none;
 569   }
 570 
 571   // "must_throw" prunes the JVM state to include only the stack, if there
 572   // are no local exception handlers.  This should cut down on register
 573   // allocation time and code size, by drastically reducing the number
 574   // of in-edges on the call to the uncommon trap.
 575 
 576   uncommon_trap(reason, action, (ciKlass*)NULL, (char*)NULL, must_throw);
 577 }
 578 
 579 
 580 //----------------------------PreserveJVMState---------------------------------
 581 PreserveJVMState::PreserveJVMState(GraphKit* kit, bool clone_map) {
 582   debug_only(kit->verify_map());
 583   _kit    = kit;
 584   _map    = kit->map();   // preserve the map
 585   _sp     = kit->sp();
 586   kit->set_map(clone_map ? kit->clone_map() : NULL);
 587 #ifdef ASSERT
 588   _bci    = kit->bci();
 589   Parse* parser = kit->is_Parse();
 590   int block = (parser == NULL || parser->block() == NULL) ? -1 : parser->block()->pre_order();
 591   _block  = block;
 592 #endif
 593 }
 594 PreserveJVMState::~PreserveJVMState() {
 595   GraphKit* kit = _kit;
 596 #ifdef ASSERT
 597   assert(kit->bci() == _bci, "bci must not shift");
 598   Parse* parser = kit->is_Parse();
 599   int block = (parser == NULL || parser->block() == NULL) ? -1 : parser->block()->pre_order();
 600   assert(block == _block,    "block must not shift");
 601 #endif
 602   kit->set_map(_map);
 603   kit->set_sp(_sp);
 604 }
 605 
 606 
 607 //-----------------------------BuildCutout-------------------------------------
 608 BuildCutout::BuildCutout(GraphKit* kit, Node* p, float prob, float cnt)
 609   : PreserveJVMState(kit)
 610 {
 611   assert(p->is_Con() || p->is_Bool(), "test must be a bool");
 612   SafePointNode* outer_map = _map;   // preserved map is caller's
 613   SafePointNode* inner_map = kit->map();
 614   IfNode* iff = kit->create_and_map_if(outer_map->control(), p, prob, cnt);
 615   outer_map->set_control(kit->gvn().transform( new (kit->C, 1) IfTrueNode(iff) ));
 616   inner_map->set_control(kit->gvn().transform( new (kit->C, 1) IfFalseNode(iff) ));
 617 }
 618 BuildCutout::~BuildCutout() {
 619   GraphKit* kit = _kit;
 620   assert(kit->stopped(), "cutout code must stop, throw, return, etc.");
 621 }
 622 
 623 
 624 //------------------------------clone_map--------------------------------------
 625 // Implementation of PreserveJVMState
 626 //
 627 // Only clone_map(...) here. If this function is only used in the
 628 // PreserveJVMState class we may want to get rid of this extra
 629 // function eventually and do it all there.
 630 
 631 SafePointNode* GraphKit::clone_map() {
 632   if (map() == NULL)  return NULL;
 633 
 634   // Clone the memory edge first
 635   Node* mem = MergeMemNode::make(C, map()->memory());
 636   gvn().set_type_bottom(mem);
 637 
 638   SafePointNode *clonemap = (SafePointNode*)map()->clone();
 639   JVMState* jvms = this->jvms();
 640   JVMState* clonejvms = jvms->clone_shallow(C);
 641   clonemap->set_memory(mem);
 642   clonemap->set_jvms(clonejvms);
 643   clonejvms->set_map(clonemap);
 644   record_for_igvn(clonemap);
 645   gvn().set_type_bottom(clonemap);
 646   return clonemap;
 647 }
 648 
 649 
 650 //-----------------------------set_map_clone-----------------------------------
 651 void GraphKit::set_map_clone(SafePointNode* m) {
 652   _map = m;
 653   _map = clone_map();
 654   _map->set_next_exception(NULL);
 655   debug_only(verify_map());
 656 }
 657 
 658 
 659 //----------------------------kill_dead_locals---------------------------------
 660 // Detect any locals which are known to be dead, and force them to top.
 661 void GraphKit::kill_dead_locals() {
 662   // Consult the liveness information for the locals.  If any
 663   // of them are unused, then they can be replaced by top().  This
 664   // should help register allocation time and cut down on the size
 665   // of the deoptimization information.
 666 
 667   // This call is made from many of the bytecode handling
 668   // subroutines called from the Big Switch in do_one_bytecode.
 669   // Every bytecode which might include a slow path is responsible
 670   // for killing its dead locals.  The more consistent we
 671   // are about killing deads, the fewer useless phis will be
 672   // constructed for them at various merge points.
 673 
 674   // bci can be -1 (InvocationEntryBci).  We return the entry
 675   // liveness for the method.
 676 
 677   if (method() == NULL || method()->code_size() == 0) {
 678     // We are building a graph for a call to a native method.
 679     // All locals are live.
 680     return;
 681   }
 682 
 683   ResourceMark rm;
 684 
 685   // Consult the liveness information for the locals.  If any
 686   // of them are unused, then they can be replaced by top().  This
 687   // should help register allocation time and cut down on the size
 688   // of the deoptimization information.
 689   MethodLivenessResult live_locals = method()->liveness_at_bci(bci());
 690 
 691   int len = (int)live_locals.size();
 692   assert(len <= jvms()->loc_size(), "too many live locals");
 693   for (int local = 0; local < len; local++) {
 694     if (!live_locals.at(local)) {
 695       set_local(local, top());
 696     }
 697   }
 698 }
 699 
 700 #ifdef ASSERT
 701 //-------------------------dead_locals_are_killed------------------------------
 702 // Return true if all dead locals are set to top in the map.
 703 // Used to assert "clean" debug info at various points.
 704 bool GraphKit::dead_locals_are_killed() {
 705   if (method() == NULL || method()->code_size() == 0) {
 706     // No locals need to be dead, so all is as it should be.
 707     return true;
 708   }
 709 
 710   // Make sure somebody called kill_dead_locals upstream.
 711   ResourceMark rm;
 712   for (JVMState* jvms = this->jvms(); jvms != NULL; jvms = jvms->caller()) {
 713     if (jvms->loc_size() == 0)  continue;  // no locals to consult
 714     SafePointNode* map = jvms->map();
 715     ciMethod* method = jvms->method();
 716     int       bci    = jvms->bci();
 717     if (jvms == this->jvms()) {
 718       bci = this->bci();  // it might not yet be synched
 719     }
 720     MethodLivenessResult live_locals = method->liveness_at_bci(bci);
 721     int len = (int)live_locals.size();
 722     if (!live_locals.is_valid() || len == 0)
 723       // This method is trivial, or is poisoned by a breakpoint.
 724       return true;
 725     assert(len == jvms->loc_size(), "live map consistent with locals map");
 726     for (int local = 0; local < len; local++) {
 727       if (!live_locals.at(local) && map->local(jvms, local) != top()) {
 728         if (PrintMiscellaneous && (Verbose || WizardMode)) {
 729           tty->print_cr("Zombie local %d: ", local);
 730           jvms->dump();
 731         }
 732         return false;
 733       }
 734     }
 735   }
 736   return true;
 737 }
 738 
 739 #endif //ASSERT
 740 
 741 // Helper function for adding JVMState and debug information to node
 742 void GraphKit::add_safepoint_edges(SafePointNode* call, bool must_throw) {
 743   // Add the safepoint edges to the call (or other safepoint).
 744 
 745   // Make sure dead locals are set to top.  This
 746   // should help register allocation time and cut down on the size
 747   // of the deoptimization information.
 748   assert(dead_locals_are_killed(), "garbage in debug info before safepoint");
 749 
 750   // Walk the inline list to fill in the correct set of JVMState's
 751   // Also fill in the associated edges for each JVMState.
 752 
 753   JVMState* youngest_jvms = sync_jvms();
 754 
 755   // Do we need debug info here?  If it is a SafePoint and this method
 756   // cannot de-opt, then we do NOT need any debug info.
 757   bool full_info = (C->deopt_happens() || call->Opcode() != Op_SafePoint);
 758 
 759   // If we are guaranteed to throw, we can prune everything but the
 760   // input to the current bytecode.
 761   bool can_prune_locals = false;
 762   uint stack_slots_not_pruned = 0;
 763   int inputs = 0, depth = 0;
 764   if (must_throw) {
 765     assert(method() == youngest_jvms->method(), "sanity");
 766     if (compute_stack_effects(inputs, depth)) {
 767       can_prune_locals = true;
 768       stack_slots_not_pruned = inputs;
 769     }
 770   }
 771 
 772   if (JvmtiExport::can_examine_or_deopt_anywhere()) {
 773     // At any safepoint, this method can get breakpointed, which would
 774     // then require an immediate deoptimization.
 775     full_info = true;
 776     can_prune_locals = false;  // do not prune locals
 777     stack_slots_not_pruned = 0;
 778   }
 779 
 780   // do not scribble on the input jvms
 781   JVMState* out_jvms = youngest_jvms->clone_deep(C);
 782   call->set_jvms(out_jvms); // Start jvms list for call node
 783 
 784   // Presize the call:
 785   debug_only(uint non_debug_edges = call->req());
 786   call->add_req_batch(top(), youngest_jvms->debug_depth());
 787   assert(call->req() == non_debug_edges + youngest_jvms->debug_depth(), "");
 788 
 789   // Set up edges so that the call looks like this:
 790   //  Call [state:] ctl io mem fptr retadr
 791   //       [parms:] parm0 ... parmN
 792   //       [root:]  loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
 793   //    [...mid:]   loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN [...]
 794   //       [young:] loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
 795   // Note that caller debug info precedes callee debug info.
 796 
 797   // Fill pointer walks backwards from "young:" to "root:" in the diagram above:
 798   uint debug_ptr = call->req();
 799 
 800   // Loop over the map input edges associated with jvms, add them
 801   // to the call node, & reset all offsets to match call node array.
 802   for (JVMState* in_jvms = youngest_jvms; in_jvms != NULL; ) {
 803     uint debug_end   = debug_ptr;
 804     uint debug_start = debug_ptr - in_jvms->debug_size();
 805     debug_ptr = debug_start;  // back up the ptr
 806 
 807     uint p = debug_start;  // walks forward in [debug_start, debug_end)
 808     uint j, k, l;
 809     SafePointNode* in_map = in_jvms->map();
 810     out_jvms->set_map(call);
 811 
 812     if (can_prune_locals) {
 813       assert(in_jvms->method() == out_jvms->method(), "sanity");
 814       // If the current throw can reach an exception handler in this JVMS,
 815       // then we must keep everything live that can reach that handler.
 816       // As a quick and dirty approximation, we look for any handlers at all.
 817       if (in_jvms->method()->has_exception_handlers()) {
 818         can_prune_locals = false;
 819       }
 820     }
 821 
 822     // Add the Locals
 823     k = in_jvms->locoff();
 824     l = in_jvms->loc_size();
 825     out_jvms->set_locoff(p);
 826     if (full_info && !can_prune_locals) {
 827       for (j = 0; j < l; j++)
 828         call->set_req(p++, in_map->in(k+j));
 829     } else {
 830       p += l;  // already set to top above by add_req_batch
 831     }
 832 
 833     // Add the Expression Stack
 834     k = in_jvms->stkoff();
 835     l = in_jvms->sp();
 836     out_jvms->set_stkoff(p);
 837     if (full_info && !can_prune_locals) {
 838       for (j = 0; j < l; j++)
 839         call->set_req(p++, in_map->in(k+j));
 840     } else if (can_prune_locals && stack_slots_not_pruned != 0) {
 841       // Divide stack into {S0,...,S1}, where S0 is set to top.
 842       uint s1 = stack_slots_not_pruned;
 843       stack_slots_not_pruned = 0;  // for next iteration
 844       if (s1 > l)  s1 = l;
 845       uint s0 = l - s1;
 846       p += s0;  // skip the tops preinstalled by add_req_batch
 847       for (j = s0; j < l; j++)
 848         call->set_req(p++, in_map->in(k+j));
 849     } else {
 850       p += l;  // already set to top above by add_req_batch
 851     }
 852 
 853     // Add the Monitors
 854     k = in_jvms->monoff();
 855     l = in_jvms->mon_size();
 856     out_jvms->set_monoff(p);
 857     for (j = 0; j < l; j++)
 858       call->set_req(p++, in_map->in(k+j));
 859 
 860     // Copy any scalar object fields.
 861     k = in_jvms->scloff();
 862     l = in_jvms->scl_size();
 863     out_jvms->set_scloff(p);
 864     for (j = 0; j < l; j++)
 865       call->set_req(p++, in_map->in(k+j));
 866 
 867     // Finish the new jvms.
 868     out_jvms->set_endoff(p);
 869 
 870     assert(out_jvms->endoff()     == debug_end,             "fill ptr must match");
 871     assert(out_jvms->depth()      == in_jvms->depth(),      "depth must match");
 872     assert(out_jvms->loc_size()   == in_jvms->loc_size(),   "size must match");
 873     assert(out_jvms->mon_size()   == in_jvms->mon_size(),   "size must match");
 874     assert(out_jvms->scl_size()   == in_jvms->scl_size(),   "size must match");
 875     assert(out_jvms->debug_size() == in_jvms->debug_size(), "size must match");
 876 
 877     // Update the two tail pointers in parallel.
 878     out_jvms = out_jvms->caller();
 879     in_jvms  = in_jvms->caller();
 880   }
 881 
 882   assert(debug_ptr == non_debug_edges, "debug info must fit exactly");
 883 
 884   // Test the correctness of JVMState::debug_xxx accessors:
 885   assert(call->jvms()->debug_start() == non_debug_edges, "");
 886   assert(call->jvms()->debug_end()   == call->req(), "");
 887   assert(call->jvms()->debug_depth() == call->req() - non_debug_edges, "");
 888 }
 889 
 890 bool GraphKit::compute_stack_effects(int& inputs, int& depth) {
 891   Bytecodes::Code code = java_bc();
 892   if (code == Bytecodes::_wide) {
 893     code = method()->java_code_at_bci(bci() + 1);
 894   }
 895 
 896   BasicType rtype = T_ILLEGAL;
 897   int       rsize = 0;
 898 
 899   if (code != Bytecodes::_illegal) {
 900     depth = Bytecodes::depth(code); // checkcast=0, athrow=-1
 901     rtype = Bytecodes::result_type(code); // checkcast=P, athrow=V
 902     if (rtype < T_CONFLICT)
 903       rsize = type2size[rtype];
 904   }
 905 
 906   switch (code) {
 907   case Bytecodes::_illegal:
 908     return false;
 909 
 910   case Bytecodes::_ldc:
 911   case Bytecodes::_ldc_w:
 912   case Bytecodes::_ldc2_w:
 913     inputs = 0;
 914     break;
 915 
 916   case Bytecodes::_dup:         inputs = 1;  break;
 917   case Bytecodes::_dup_x1:      inputs = 2;  break;
 918   case Bytecodes::_dup_x2:      inputs = 3;  break;
 919   case Bytecodes::_dup2:        inputs = 2;  break;
 920   case Bytecodes::_dup2_x1:     inputs = 3;  break;
 921   case Bytecodes::_dup2_x2:     inputs = 4;  break;
 922   case Bytecodes::_swap:        inputs = 2;  break;
 923   case Bytecodes::_arraylength: inputs = 1;  break;
 924 
 925   case Bytecodes::_getstatic:
 926   case Bytecodes::_putstatic:
 927   case Bytecodes::_getfield:
 928   case Bytecodes::_putfield:
 929     {
 930       bool is_get = (depth >= 0), is_static = (depth & 1);
 931       bool ignore;
 932       ciBytecodeStream iter(method());
 933       iter.reset_to_bci(bci());
 934       iter.next();
 935       ciField* field = iter.get_field(ignore);
 936       int      size  = field->type()->size();
 937       inputs  = (is_static ? 0 : 1);
 938       if (is_get) {
 939         depth = size - inputs;
 940       } else {
 941         inputs += size;        // putxxx pops the value from the stack
 942         depth = - inputs;
 943       }
 944     }
 945     break;
 946 
 947   case Bytecodes::_invokevirtual:
 948   case Bytecodes::_invokespecial:
 949   case Bytecodes::_invokestatic:
 950   case Bytecodes::_invokeinterface:
 951     {
 952       bool is_static = (depth == 0);
 953       bool ignore;
 954       ciBytecodeStream iter(method());
 955       iter.reset_to_bci(bci());
 956       iter.next();
 957       ciMethod* method = iter.get_method(ignore);
 958       inputs = method->arg_size_no_receiver();
 959       if (!is_static)  inputs += 1;
 960       int size = method->return_type()->size();
 961       depth = size - inputs;
 962     }
 963     break;
 964 
 965   case Bytecodes::_multianewarray:
 966     {
 967       ciBytecodeStream iter(method());
 968       iter.reset_to_bci(bci());
 969       iter.next();
 970       inputs = iter.get_dimensions();
 971       assert(rsize == 1, "");
 972       depth = rsize - inputs;
 973     }
 974     break;
 975 
 976   case Bytecodes::_ireturn:
 977   case Bytecodes::_lreturn:
 978   case Bytecodes::_freturn:
 979   case Bytecodes::_dreturn:
 980   case Bytecodes::_areturn:
 981     assert(rsize = -depth, "");
 982     inputs = rsize;
 983     break;
 984 
 985   case Bytecodes::_jsr:
 986   case Bytecodes::_jsr_w:
 987     inputs = 0;
 988     depth  = 1;                  // S.B. depth=1, not zero
 989     break;
 990 
 991   default:
 992     // bytecode produces a typed result
 993     inputs = rsize - depth;
 994     assert(inputs >= 0, "");
 995     break;
 996   }
 997 
 998 #ifdef ASSERT
 999   // spot check
1000   int outputs = depth + inputs;
1001   assert(outputs >= 0, "sanity");
1002   switch (code) {
1003   case Bytecodes::_checkcast: assert(inputs == 1 && outputs == 1, ""); break;
1004   case Bytecodes::_athrow:    assert(inputs == 1 && outputs == 0, ""); break;
1005   case Bytecodes::_aload_0:   assert(inputs == 0 && outputs == 1, ""); break;
1006   case Bytecodes::_return:    assert(inputs == 0 && outputs == 0, ""); break;
1007   case Bytecodes::_drem:      assert(inputs == 4 && outputs == 2, ""); break;
1008   }
1009 #endif //ASSERT
1010 
1011   return true;
1012 }
1013 
1014 
1015 
1016 //------------------------------basic_plus_adr---------------------------------
1017 Node* GraphKit::basic_plus_adr(Node* base, Node* ptr, Node* offset) {
1018   // short-circuit a common case
1019   if (offset == intcon(0))  return ptr;
1020   return _gvn.transform( new (C, 4) AddPNode(base, ptr, offset) );
1021 }
1022 
1023 Node* GraphKit::ConvI2L(Node* offset) {
1024   // short-circuit a common case
1025   jint offset_con = find_int_con(offset, Type::OffsetBot);
1026   if (offset_con != Type::OffsetBot) {
1027     return longcon((long) offset_con);
1028   }
1029   return _gvn.transform( new (C, 2) ConvI2LNode(offset));
1030 }
1031 Node* GraphKit::ConvL2I(Node* offset) {
1032   // short-circuit a common case
1033   jlong offset_con = find_long_con(offset, (jlong)Type::OffsetBot);
1034   if (offset_con != (jlong)Type::OffsetBot) {
1035     return intcon((int) offset_con);
1036   }
1037   return _gvn.transform( new (C, 2) ConvL2INode(offset));
1038 }
1039 
1040 //-------------------------load_object_klass-----------------------------------
1041 Node* GraphKit::load_object_klass(Node* obj) {
1042   // Special-case a fresh allocation to avoid building nodes:
1043   Node* akls = AllocateNode::Ideal_klass(obj, &_gvn);
1044   if (akls != NULL)  return akls;
1045   Node* k_adr = basic_plus_adr(obj, oopDesc::klass_offset_in_bytes());
1046   return _gvn.transform( LoadKlassNode::make(_gvn, immutable_memory(), k_adr, TypeInstPtr::KLASS) );
1047 }
1048 
1049 //-------------------------load_array_length-----------------------------------
1050 Node* GraphKit::load_array_length(Node* array) {
1051   // Special-case a fresh allocation to avoid building nodes:
1052   Node* alen = AllocateArrayNode::Ideal_length(array, &_gvn);
1053   if (alen != NULL)  return alen;
1054   Node *r_adr = basic_plus_adr(array, arrayOopDesc::length_offset_in_bytes());
1055   return _gvn.transform( new (C, 3) LoadRangeNode(0, immutable_memory(), r_adr, TypeInt::POS));
1056 }
1057 
1058 //------------------------------do_null_check----------------------------------
1059 // Helper function to do a NULL pointer check.  Returned value is
1060 // the incoming address with NULL casted away.  You are allowed to use the
1061 // not-null value only if you are control dependent on the test.
1062 extern int explicit_null_checks_inserted,
1063            explicit_null_checks_elided;
1064 Node* GraphKit::null_check_common(Node* value, BasicType type,
1065                                   // optional arguments for variations:
1066                                   bool assert_null,
1067                                   Node* *null_control) {
1068   assert(!assert_null || null_control == NULL, "not both at once");
1069   if (stopped())  return top();
1070   if (!GenerateCompilerNullChecks && !assert_null && null_control == NULL) {
1071     // For some performance testing, we may wish to suppress null checking.
1072     value = cast_not_null(value);   // Make it appear to be non-null (4962416).
1073     return value;
1074   }
1075   explicit_null_checks_inserted++;
1076 
1077   // Construct NULL check
1078   Node *chk = NULL;
1079   switch(type) {
1080     case T_LONG   : chk = new (C, 3) CmpLNode(value, _gvn.zerocon(T_LONG)); break;
1081     case T_INT    : chk = new (C, 3) CmpINode( value, _gvn.intcon(0)); break;
1082     case T_ARRAY  : // fall through
1083       type = T_OBJECT;  // simplify further tests
1084     case T_OBJECT : {
1085       const Type *t = _gvn.type( value );
1086 
1087       const TypeInstPtr* tp = t->isa_instptr();
1088       if (tp != NULL && !tp->klass()->is_loaded()
1089           // Only for do_null_check, not any of its siblings:
1090           && !assert_null && null_control == NULL) {
1091         // Usually, any field access or invocation on an unloaded oop type
1092         // will simply fail to link, since the statically linked class is
1093         // likely also to be unloaded.  However, in -Xcomp mode, sometimes
1094         // the static class is loaded but the sharper oop type is not.
1095         // Rather than checking for this obscure case in lots of places,
1096         // we simply observe that a null check on an unloaded class
1097         // will always be followed by a nonsense operation, so we
1098         // can just issue the uncommon trap here.
1099         // Our access to the unloaded class will only be correct
1100         // after it has been loaded and initialized, which requires
1101         // a trip through the interpreter.
1102 #ifndef PRODUCT
1103         if (WizardMode) { tty->print("Null check of unloaded "); tp->klass()->print(); tty->cr(); }
1104 #endif
1105         uncommon_trap(Deoptimization::Reason_unloaded,
1106                       Deoptimization::Action_reinterpret,
1107                       tp->klass(), "!loaded");
1108         return top();
1109       }
1110 
1111       if (assert_null) {
1112         // See if the type is contained in NULL_PTR.
1113         // If so, then the value is already null.
1114         if (t->higher_equal(TypePtr::NULL_PTR)) {
1115           explicit_null_checks_elided++;
1116           return value;           // Elided null assert quickly!
1117         }
1118       } else {
1119         // See if mixing in the NULL pointer changes type.
1120         // If so, then the NULL pointer was not allowed in the original
1121         // type.  In other words, "value" was not-null.
1122         if (t->meet(TypePtr::NULL_PTR) != t) {
1123           // same as: if (!TypePtr::NULL_PTR->higher_equal(t)) ...
1124           explicit_null_checks_elided++;
1125           return value;           // Elided null check quickly!
1126         }
1127       }
1128       chk = new (C, 3) CmpPNode( value, null() );
1129       break;
1130     }
1131 
1132     default      : ShouldNotReachHere();
1133   }
1134   assert(chk != NULL, "sanity check");
1135   chk = _gvn.transform(chk);
1136 
1137   BoolTest::mask btest = assert_null ? BoolTest::eq : BoolTest::ne;
1138   BoolNode *btst = new (C, 2) BoolNode( chk, btest);
1139   Node   *tst = _gvn.transform( btst );
1140 
1141   //-----------
1142   // if peephole optimizations occured, a prior test existed.
1143   // If a prior test existed, maybe it dominates as we can avoid this test.
1144   if (tst != btst && type == T_OBJECT) {
1145     // At this point we want to scan up the CFG to see if we can
1146     // find an identical test (and so avoid this test altogether).
1147     Node *cfg = control();
1148     int depth = 0;
1149     while( depth < 16 ) {       // Limit search depth for speed
1150       if( cfg->Opcode() == Op_IfTrue &&
1151           cfg->in(0)->in(1) == tst ) {
1152         // Found prior test.  Use "cast_not_null" to construct an identical
1153         // CastPP (and hence hash to) as already exists for the prior test.
1154         // Return that casted value.
1155         if (assert_null) {
1156           replace_in_map(value, null());
1157           return null();  // do not issue the redundant test
1158         }
1159         Node *oldcontrol = control();
1160         set_control(cfg);
1161         Node *res = cast_not_null(value);
1162         set_control(oldcontrol);
1163         explicit_null_checks_elided++;
1164         return res;
1165       }
1166       cfg = IfNode::up_one_dom(cfg, /*linear_only=*/ true);
1167       if (cfg == NULL)  break;  // Quit at region nodes
1168       depth++;
1169     }
1170   }
1171 
1172   //-----------
1173   // Branch to failure if null
1174   float ok_prob = PROB_MAX;  // a priori estimate:  nulls never happen
1175   Deoptimization::DeoptReason reason;
1176   if (assert_null)
1177     reason = Deoptimization::Reason_null_assert;
1178   else if (type == T_OBJECT)
1179     reason = Deoptimization::Reason_null_check;
1180   else
1181     reason = Deoptimization::Reason_div0_check;
1182 
1183   // To cause an implicit null check, we set the not-null probability
1184   // to the maximum (PROB_MAX).  For an explicit check the probablity
1185   // is set to a smaller value.
1186   if (null_control != NULL || too_many_traps(reason)) {
1187     // probability is less likely
1188     ok_prob =  PROB_LIKELY_MAG(3);
1189   } else if (!assert_null &&
1190              (ImplicitNullCheckThreshold > 0) &&
1191              method() != NULL &&
1192              (method()->method_data()->trap_count(reason)
1193               >= (uint)ImplicitNullCheckThreshold)) {
1194     ok_prob =  PROB_LIKELY_MAG(3);
1195   }
1196 
1197   if (null_control != NULL) {
1198     IfNode* iff = create_and_map_if(control(), tst, ok_prob, COUNT_UNKNOWN);
1199     Node* null_true = _gvn.transform( new (C, 1) IfFalseNode(iff));
1200     set_control(      _gvn.transform( new (C, 1) IfTrueNode(iff)));
1201     if (null_true == top())
1202       explicit_null_checks_elided++;
1203     (*null_control) = null_true;
1204   } else {
1205     BuildCutout unless(this, tst, ok_prob);
1206     // Check for optimizer eliding test at parse time
1207     if (stopped()) {
1208       // Failure not possible; do not bother making uncommon trap.
1209       explicit_null_checks_elided++;
1210     } else if (assert_null) {
1211       uncommon_trap(reason,
1212                     Deoptimization::Action_make_not_entrant,
1213                     NULL, "assert_null");
1214     } else {
1215       replace_in_map(value, zerocon(type));
1216       builtin_throw(reason);
1217     }
1218   }
1219 
1220   // Must throw exception, fall-thru not possible?
1221   if (stopped()) {
1222     return top();               // No result
1223   }
1224 
1225   if (assert_null) {
1226     // Cast obj to null on this path.
1227     replace_in_map(value, zerocon(type));
1228     return zerocon(type);
1229   }
1230 
1231   // Cast obj to not-null on this path, if there is no null_control.
1232   // (If there is a null_control, a non-null value may come back to haunt us.)
1233   if (type == T_OBJECT) {
1234     Node* cast = cast_not_null(value, false);
1235     if (null_control == NULL || (*null_control) == top())
1236       replace_in_map(value, cast);
1237     value = cast;
1238   }
1239 
1240   return value;
1241 }
1242 
1243 
1244 //------------------------------cast_not_null----------------------------------
1245 // Cast obj to not-null on this path
1246 Node* GraphKit::cast_not_null(Node* obj, bool do_replace_in_map) {
1247   const Type *t = _gvn.type(obj);
1248   const Type *t_not_null = t->join(TypePtr::NOTNULL);
1249   // Object is already not-null?
1250   if( t == t_not_null ) return obj;
1251 
1252   Node *cast = new (C, 2) CastPPNode(obj,t_not_null);
1253   cast->init_req(0, control());
1254   cast = _gvn.transform( cast );
1255 
1256   // Scan for instances of 'obj' in the current JVM mapping.
1257   // These instances are known to be not-null after the test.
1258   if (do_replace_in_map)
1259     replace_in_map(obj, cast);
1260 
1261   return cast;                  // Return casted value
1262 }
1263 
1264 
1265 //--------------------------replace_in_map-------------------------------------
1266 void GraphKit::replace_in_map(Node* old, Node* neww) {
1267   this->map()->replace_edge(old, neww);
1268 
1269   // Note: This operation potentially replaces any edge
1270   // on the map.  This includes locals, stack, and monitors
1271   // of the current (innermost) JVM state.
1272 
1273   // We can consider replacing in caller maps.
1274   // The idea would be that an inlined function's null checks
1275   // can be shared with the entire inlining tree.
1276   // The expense of doing this is that the PreserveJVMState class
1277   // would have to preserve caller states too, with a deep copy.
1278 }
1279 
1280 
1281 
1282 //=============================================================================
1283 //--------------------------------memory---------------------------------------
1284 Node* GraphKit::memory(uint alias_idx) {
1285   MergeMemNode* mem = merged_memory();
1286   Node* p = mem->memory_at(alias_idx);
1287   _gvn.set_type(p, Type::MEMORY);  // must be mapped
1288   return p;
1289 }
1290 
1291 //-----------------------------reset_memory------------------------------------
1292 Node* GraphKit::reset_memory() {
1293   Node* mem = map()->memory();
1294   // do not use this node for any more parsing!
1295   debug_only( map()->set_memory((Node*)NULL) );
1296   return _gvn.transform( mem );
1297 }
1298 
1299 //------------------------------set_all_memory---------------------------------
1300 void GraphKit::set_all_memory(Node* newmem) {
1301   Node* mergemem = MergeMemNode::make(C, newmem);
1302   gvn().set_type_bottom(mergemem);
1303   map()->set_memory(mergemem);
1304 }
1305 
1306 //------------------------------set_all_memory_call----------------------------
1307 void GraphKit::set_all_memory_call(Node* call) {
1308   Node* newmem = _gvn.transform( new (C, 1) ProjNode(call, TypeFunc::Memory) );
1309   set_all_memory(newmem);
1310 }
1311 
1312 //=============================================================================
1313 //
1314 // parser factory methods for MemNodes
1315 //
1316 // These are layered on top of the factory methods in LoadNode and StoreNode,
1317 // and integrate with the parser's memory state and _gvn engine.
1318 //
1319 
1320 // factory methods in "int adr_idx"
1321 Node* GraphKit::make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
1322                           int adr_idx,
1323                           bool require_atomic_access) {
1324   assert(adr_idx != Compile::AliasIdxTop, "use other make_load factory" );
1325   const TypePtr* adr_type = NULL; // debug-mode-only argument
1326   debug_only(adr_type = C->get_adr_type(adr_idx));
1327   Node* mem = memory(adr_idx);
1328   Node* ld;
1329   if (require_atomic_access && bt == T_LONG) {
1330     ld = LoadLNode::make_atomic(C, ctl, mem, adr, adr_type, t);
1331   } else {
1332     ld = LoadNode::make(_gvn, ctl, mem, adr, adr_type, t, bt);
1333   }
1334   return _gvn.transform(ld);
1335 }
1336 
1337 Node* GraphKit::store_to_memory(Node* ctl, Node* adr, Node *val, BasicType bt,
1338                                 int adr_idx,
1339                                 bool require_atomic_access) {
1340   assert(adr_idx != Compile::AliasIdxTop, "use other store_to_memory factory" );
1341   const TypePtr* adr_type = NULL;
1342   debug_only(adr_type = C->get_adr_type(adr_idx));
1343   Node *mem = memory(adr_idx);
1344   Node* st;
1345   if (require_atomic_access && bt == T_LONG) {
1346     st = StoreLNode::make_atomic(C, ctl, mem, adr, adr_type, val);
1347   } else {
1348     st = StoreNode::make(_gvn, ctl, mem, adr, adr_type, val, bt);
1349   }
1350   st = _gvn.transform(st);
1351   set_memory(st, adr_idx);
1352   // Back-to-back stores can only remove intermediate store with DU info
1353   // so push on worklist for optimizer.
1354   if (mem->req() > MemNode::Address && adr == mem->in(MemNode::Address))
1355     record_for_igvn(st);
1356 
1357   return st;
1358 }
1359 
1360 void GraphKit::pre_barrier(Node* ctl,
1361                            Node* obj,
1362                            Node* adr,
1363                            uint adr_idx,
1364                            Node *val,
1365                            const Type* val_type,
1366                            BasicType bt) {
1367   BarrierSet* bs = Universe::heap()->barrier_set();
1368   set_control(ctl);
1369   switch (bs->kind()) {
1370 
1371     case BarrierSet::CardTableModRef:
1372     case BarrierSet::CardTableExtension:
1373     case BarrierSet::ModRef:
1374       break;
1375 
1376     case BarrierSet::Other:
1377     default      :
1378       ShouldNotReachHere();
1379 
1380   }
1381 }
1382 
1383 void GraphKit::post_barrier(Node* ctl,
1384                             Node* store,
1385                             Node* obj,
1386                             Node* adr,
1387                             uint adr_idx,
1388                             Node *val,
1389                             BasicType bt,
1390                             bool use_precise) {
1391   BarrierSet* bs = Universe::heap()->barrier_set();
1392   set_control(ctl);
1393   switch (bs->kind()) {
1394 
1395     case BarrierSet::CardTableModRef:
1396     case BarrierSet::CardTableExtension:
1397       write_barrier_post(store, obj, adr, val, use_precise);
1398       break;
1399 
1400     case BarrierSet::ModRef:
1401       break;
1402 
1403     case BarrierSet::Other:
1404     default      :
1405       ShouldNotReachHere();
1406 
1407   }
1408 }
1409 
1410 Node* GraphKit::store_oop_to_object(Node* ctl,
1411                                     Node* obj,
1412                                     Node* adr,
1413                                     const TypePtr* adr_type,
1414                                     Node *val,
1415                                     const Type* val_type,
1416                                     BasicType bt) {
1417   uint adr_idx = C->get_alias_index(adr_type);
1418   Node* store;
1419   pre_barrier(ctl, obj, adr, adr_idx, val, val_type, bt);
1420   store = store_to_memory(control(), adr, val, bt, adr_idx);
1421   post_barrier(control(), store, obj, adr, adr_idx, val, bt, false);
1422   return store;
1423 }
1424 
1425 Node* GraphKit::store_oop_to_array(Node* ctl,
1426                                    Node* obj,
1427                                    Node* adr,
1428                                    const TypePtr* adr_type,
1429                                    Node *val,
1430                                    const Type* val_type,
1431                                    BasicType bt) {
1432   uint adr_idx = C->get_alias_index(adr_type);
1433   Node* store;
1434   pre_barrier(ctl, obj, adr, adr_idx, val, val_type, bt);
1435   store = store_to_memory(control(), adr, val, bt, adr_idx);
1436   post_barrier(control(), store, obj, adr, adr_idx, val, bt, true);
1437   return store;
1438 }
1439 
1440 Node* GraphKit::store_oop_to_unknown(Node* ctl,
1441                                      Node* obj,
1442                                      Node* adr,
1443                                      const TypePtr* adr_type,
1444                                      Node *val,
1445                                      const Type* val_type,
1446                                      BasicType bt) {
1447   uint adr_idx = C->get_alias_index(adr_type);
1448   Node* store;
1449   pre_barrier(ctl, obj, adr, adr_idx, val, val_type, bt);
1450   store = store_to_memory(control(), adr, val, bt, adr_idx);
1451   post_barrier(control(), store, obj, adr, adr_idx, val, bt, true);
1452   return store;
1453 }
1454 
1455 
1456 //-------------------------array_element_address-------------------------
1457 Node* GraphKit::array_element_address(Node* ary, Node* idx, BasicType elembt,
1458                                       const TypeInt* sizetype) {
1459   uint shift  = exact_log2(type2aelembytes(elembt));
1460   uint header = arrayOopDesc::base_offset_in_bytes(elembt);
1461 
1462   // short-circuit a common case (saves lots of confusing waste motion)
1463   jint idx_con = find_int_con(idx, -1);
1464   if (idx_con >= 0) {
1465     intptr_t offset = header + ((intptr_t)idx_con << shift);
1466     return basic_plus_adr(ary, offset);
1467   }
1468 
1469   // must be correct type for alignment purposes
1470   Node* base  = basic_plus_adr(ary, header);
1471 #ifdef _LP64
1472   // The scaled index operand to AddP must be a clean 64-bit value.
1473   // Java allows a 32-bit int to be incremented to a negative
1474   // value, which appears in a 64-bit register as a large
1475   // positive number.  Using that large positive number as an
1476   // operand in pointer arithmetic has bad consequences.
1477   // On the other hand, 32-bit overflow is rare, and the possibility
1478   // can often be excluded, if we annotate the ConvI2L node with
1479   // a type assertion that its value is known to be a small positive
1480   // number.  (The prior range check has ensured this.)
1481   // This assertion is used by ConvI2LNode::Ideal.
1482   int index_max = max_jint - 1;  // array size is max_jint, index is one less
1483   if (sizetype != NULL)  index_max = sizetype->_hi - 1;
1484   const TypeLong* lidxtype = TypeLong::make(CONST64(0), index_max, Type::WidenMax);
1485   idx = _gvn.transform( new (C, 2) ConvI2LNode(idx, lidxtype) );
1486 #endif
1487   Node* scale = _gvn.transform( new (C, 3) LShiftXNode(idx, intcon(shift)) );
1488   return basic_plus_adr(ary, base, scale);
1489 }
1490 
1491 //-------------------------load_array_element-------------------------
1492 Node* GraphKit::load_array_element(Node* ctl, Node* ary, Node* idx, const TypeAryPtr* arytype) {
1493   const Type* elemtype = arytype->elem();
1494   BasicType elembt = elemtype->array_element_basic_type();
1495   Node* adr = array_element_address(ary, idx, elembt, arytype->size());
1496   Node* ld = make_load(ctl, adr, elemtype, elembt, arytype);
1497   return ld;
1498 }
1499 
1500 //-------------------------set_arguments_for_java_call-------------------------
1501 // Arguments (pre-popped from the stack) are taken from the JVMS.
1502 void GraphKit::set_arguments_for_java_call(CallJavaNode* call) {
1503   // Add the call arguments:
1504   uint nargs = call->method()->arg_size();
1505   for (uint i = 0; i < nargs; i++) {
1506     Node* arg = argument(i);
1507     call->init_req(i + TypeFunc::Parms, arg);
1508   }
1509 }
1510 
1511 //---------------------------set_edges_for_java_call---------------------------
1512 // Connect a newly created call into the current JVMS.
1513 // A return value node (if any) is returned from set_edges_for_java_call.
1514 void GraphKit::set_edges_for_java_call(CallJavaNode* call, bool must_throw) {
1515 
1516   // Add the predefined inputs:
1517   call->init_req( TypeFunc::Control, control() );
1518   call->init_req( TypeFunc::I_O    , i_o() );
1519   call->init_req( TypeFunc::Memory , reset_memory() );
1520   call->init_req( TypeFunc::FramePtr, frameptr() );
1521   call->init_req( TypeFunc::ReturnAdr, top() );
1522 
1523   add_safepoint_edges(call, must_throw);
1524 
1525   Node* xcall = _gvn.transform(call);
1526 
1527   if (xcall == top()) {
1528     set_control(top());
1529     return;
1530   }
1531   assert(xcall == call, "call identity is stable");
1532 
1533   // Re-use the current map to produce the result.
1534 
1535   set_control(_gvn.transform(new (C, 1) ProjNode(call, TypeFunc::Control)));
1536   set_i_o(    _gvn.transform(new (C, 1) ProjNode(call, TypeFunc::I_O    )));
1537   set_all_memory_call(xcall);
1538 
1539   //return xcall;   // no need, caller already has it
1540 }
1541 
1542 Node* GraphKit::set_results_for_java_call(CallJavaNode* call) {
1543   if (stopped())  return top();  // maybe the call folded up?
1544 
1545   // Capture the return value, if any.
1546   Node* ret;
1547   if (call->method() == NULL ||
1548       call->method()->return_type()->basic_type() == T_VOID)
1549         ret = top();
1550   else  ret = _gvn.transform(new (C, 1) ProjNode(call, TypeFunc::Parms));
1551 
1552   // Note:  Since any out-of-line call can produce an exception,
1553   // we always insert an I_O projection from the call into the result.
1554 
1555   make_slow_call_ex(call, env()->Throwable_klass(), false);
1556 
1557   return ret;
1558 }
1559 
1560 //--------------------set_predefined_input_for_runtime_call--------------------
1561 // Reading and setting the memory state is way conservative here.
1562 // The real problem is that I am not doing real Type analysis on memory,
1563 // so I cannot distinguish card mark stores from other stores.  Across a GC
1564 // point the Store Barrier and the card mark memory has to agree.  I cannot
1565 // have a card mark store and its barrier split across the GC point from
1566 // either above or below.  Here I get that to happen by reading ALL of memory.
1567 // A better answer would be to separate out card marks from other memory.
1568 // For now, return the input memory state, so that it can be reused
1569 // after the call, if this call has restricted memory effects.
1570 Node* GraphKit::set_predefined_input_for_runtime_call(SafePointNode* call) {
1571   // Set fixed predefined input arguments
1572   Node* memory = reset_memory();
1573   call->init_req( TypeFunc::Control,   control()  );
1574   call->init_req( TypeFunc::I_O,       top()      ); // does no i/o
1575   call->init_req( TypeFunc::Memory,    memory     ); // may gc ptrs
1576   call->init_req( TypeFunc::FramePtr,  frameptr() );
1577   call->init_req( TypeFunc::ReturnAdr, top()      );
1578   return memory;
1579 }
1580 
1581 //-------------------set_predefined_output_for_runtime_call--------------------
1582 // Set control and memory (not i_o) from the call.
1583 // If keep_mem is not NULL, use it for the output state,
1584 // except for the RawPtr output of the call, if hook_mem is TypeRawPtr::BOTTOM.
1585 // If hook_mem is NULL, this call produces no memory effects at all.
1586 // If hook_mem is a Java-visible memory slice (such as arraycopy operands),
1587 // then only that memory slice is taken from the call.
1588 // In the last case, we must put an appropriate memory barrier before
1589 // the call, so as to create the correct anti-dependencies on loads
1590 // preceding the call.
1591 void GraphKit::set_predefined_output_for_runtime_call(Node* call,
1592                                                       Node* keep_mem,
1593                                                       const TypePtr* hook_mem) {
1594   // no i/o
1595   set_control(_gvn.transform( new (C, 1) ProjNode(call,TypeFunc::Control) ));
1596   if (keep_mem) {
1597     // First clone the existing memory state
1598     set_all_memory(keep_mem);
1599     if (hook_mem != NULL) {
1600       // Make memory for the call
1601       Node* mem = _gvn.transform( new (C, 1) ProjNode(call, TypeFunc::Memory) );
1602       // Set the RawPtr memory state only.  This covers all the heap top/GC stuff
1603       // We also use hook_mem to extract specific effects from arraycopy stubs.
1604       set_memory(mem, hook_mem);
1605     }
1606     // ...else the call has NO memory effects.
1607 
1608     // Make sure the call advertises its memory effects precisely.
1609     // This lets us build accurate anti-dependences in gcm.cpp.
1610     assert(C->alias_type(call->adr_type()) == C->alias_type(hook_mem),
1611            "call node must be constructed correctly");
1612   } else {
1613     assert(hook_mem == NULL, "");
1614     // This is not a "slow path" call; all memory comes from the call.
1615     set_all_memory_call(call);
1616   }
1617 }
1618 
1619 //------------------------------increment_counter------------------------------
1620 // for statistics: increment a VM counter by 1
1621 
1622 void GraphKit::increment_counter(address counter_addr) {
1623   Node* adr1 = makecon(TypeRawPtr::make(counter_addr));
1624   increment_counter(adr1);
1625 }
1626 
1627 void GraphKit::increment_counter(Node* counter_addr) {
1628   int adr_type = Compile::AliasIdxRaw;
1629   Node* cnt  = make_load(NULL, counter_addr, TypeInt::INT, T_INT, adr_type);
1630   Node* incr = _gvn.transform(new (C, 3) AddINode(cnt, _gvn.intcon(1)));
1631   store_to_memory( NULL, counter_addr, incr, T_INT, adr_type );
1632 }
1633 
1634 
1635 //------------------------------uncommon_trap----------------------------------
1636 // Bail out to the interpreter in mid-method.  Implemented by calling the
1637 // uncommon_trap blob.  This helper function inserts a runtime call with the
1638 // right debug info.
1639 void GraphKit::uncommon_trap(int trap_request,
1640                              ciKlass* klass, const char* comment,
1641                              bool must_throw,
1642                              bool keep_exact_action) {
1643   if (failing())  stop();
1644   if (stopped())  return; // trap reachable?
1645 
1646   // Note:  If ProfileTraps is true, and if a deopt. actually
1647   // occurs here, the runtime will make sure an MDO exists.  There is
1648   // no need to call method()->build_method_data() at this point.
1649 
1650 #ifdef ASSERT
1651   if (!must_throw) {
1652     // Make sure the stack has at least enough depth to execute
1653     // the current bytecode.
1654     int inputs, ignore;
1655     if (compute_stack_effects(inputs, ignore)) {
1656       assert(sp() >= inputs, "must have enough JVMS stack to execute");
1657       // It is a frequent error in library_call.cpp to issue an
1658       // uncommon trap with the _sp value already popped.
1659     }
1660   }
1661 #endif
1662 
1663   Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(trap_request);
1664   Deoptimization::DeoptAction action = Deoptimization::trap_request_action(trap_request);
1665 
1666   switch (action) {
1667   case Deoptimization::Action_maybe_recompile:
1668   case Deoptimization::Action_reinterpret:
1669     // Temporary fix for 6529811 to allow virtual calls to be sure they
1670     // get the chance to go from mono->bi->mega
1671     if (!keep_exact_action &&
1672         Deoptimization::trap_request_index(trap_request) < 0 &&
1673         too_many_recompiles(reason)) {
1674       // This BCI is causing too many recompilations.
1675       action = Deoptimization::Action_none;
1676       trap_request = Deoptimization::make_trap_request(reason, action);
1677     } else {
1678       C->set_trap_can_recompile(true);
1679     }
1680     break;
1681   case Deoptimization::Action_make_not_entrant:
1682     C->set_trap_can_recompile(true);
1683     break;
1684 #ifdef ASSERT
1685   case Deoptimization::Action_none:
1686   case Deoptimization::Action_make_not_compilable:
1687     break;
1688   default:
1689     assert(false, "bad action");
1690 #endif
1691   }
1692 
1693   if (TraceOptoParse) {
1694     char buf[100];
1695     tty->print_cr("Uncommon trap %s at bci:%d",
1696                   Deoptimization::format_trap_request(buf, sizeof(buf),
1697                                                       trap_request), bci());
1698   }
1699 
1700   CompileLog* log = C->log();
1701   if (log != NULL) {
1702     int kid = (klass == NULL)? -1: log->identify(klass);
1703     log->begin_elem("uncommon_trap bci='%d'", bci());
1704     char buf[100];
1705     log->print(" %s", Deoptimization::format_trap_request(buf, sizeof(buf),
1706                                                           trap_request));
1707     if (kid >= 0)         log->print(" klass='%d'", kid);
1708     if (comment != NULL)  log->print(" comment='%s'", comment);
1709     log->end_elem();
1710   }
1711 
1712   // Make sure any guarding test views this path as very unlikely
1713   Node *i0 = control()->in(0);
1714   if (i0 != NULL && i0->is_If()) {        // Found a guarding if test?
1715     IfNode *iff = i0->as_If();
1716     float f = iff->_prob;   // Get prob
1717     if (control()->Opcode() == Op_IfTrue) {
1718       if (f > PROB_UNLIKELY_MAG(4))
1719         iff->_prob = PROB_MIN;
1720     } else {
1721       if (f < PROB_LIKELY_MAG(4))
1722         iff->_prob = PROB_MAX;
1723     }
1724   }
1725 
1726   // Clear out dead values from the debug info.
1727   kill_dead_locals();
1728 
1729   // Now insert the uncommon trap subroutine call
1730   address call_addr = SharedRuntime::uncommon_trap_blob()->instructions_begin();
1731   const TypePtr* no_memory_effects = NULL;
1732   // Pass the index of the class to be loaded
1733   Node* call = make_runtime_call(RC_NO_LEAF | RC_UNCOMMON |
1734                                  (must_throw ? RC_MUST_THROW : 0),
1735                                  OptoRuntime::uncommon_trap_Type(),
1736                                  call_addr, "uncommon_trap", no_memory_effects,
1737                                  intcon(trap_request));
1738   assert(call->as_CallStaticJava()->uncommon_trap_request() == trap_request,
1739          "must extract request correctly from the graph");
1740   assert(trap_request != 0, "zero value reserved by uncommon_trap_request");
1741 
1742   call->set_req(TypeFunc::ReturnAdr, returnadr());
1743   // The debug info is the only real input to this call.
1744 
1745   // Halt-and-catch fire here.  The above call should never return!
1746   HaltNode* halt = new(C, TypeFunc::Parms) HaltNode(control(), frameptr());
1747   _gvn.set_type_bottom(halt);
1748   root()->add_req(halt);
1749 
1750   stop_and_kill_map();
1751 }
1752 
1753 
1754 //--------------------------just_allocated_object------------------------------
1755 // Report the object that was just allocated.
1756 // It must be the case that there are no intervening safepoints.
1757 // We use this to determine if an object is so "fresh" that
1758 // it does not require card marks.
1759 Node* GraphKit::just_allocated_object(Node* current_control) {
1760   if (C->recent_alloc_ctl() == current_control)
1761     return C->recent_alloc_obj();
1762   return NULL;
1763 }
1764 
1765 
1766 //------------------------------store_barrier----------------------------------
1767 // Insert a write-barrier store.  This is to let generational GC work; we have
1768 // to flag all oop-stores before the next GC point.
1769 void GraphKit::write_barrier_post(Node* oop_store, Node* obj, Node* adr,
1770                                   Node* val, bool use_precise) {
1771   // No store check needed if we're storing a NULL or an old object
1772   // (latter case is probably a string constant). The concurrent
1773   // mark sweep garbage collector, however, needs to have all nonNull
1774   // oop updates flagged via card-marks.
1775   if (val != NULL && val->is_Con()) {
1776     // must be either an oop or NULL
1777     const Type* t = val->bottom_type();
1778     if (t == TypePtr::NULL_PTR || t == Type::TOP)
1779       // stores of null never (?) need barriers
1780       return;
1781     ciObject* con = t->is_oopptr()->const_oop();
1782     if (con != NULL
1783         && con->is_perm()
1784         && Universe::heap()->can_elide_permanent_oop_store_barriers())
1785       // no store barrier needed, because no old-to-new ref created
1786       return;
1787   }
1788 
1789   if (use_ReduceInitialCardMarks()
1790       && obj == just_allocated_object(control())) {
1791     // We can skip marks on a freshly-allocated object.
1792     // Keep this code in sync with do_eager_card_mark in runtime.cpp.
1793     // That routine eagerly marks the occasional object which is produced
1794     // by the slow path, so that we don't have to do it here.
1795     return;
1796   }
1797 
1798   if (!use_precise) {
1799     // All card marks for a (non-array) instance are in one place:
1800     adr = obj;
1801   }
1802   // (Else it's an array (or unknown), and we want more precise card marks.)
1803   assert(adr != NULL, "");
1804 
1805   // Get the alias_index for raw card-mark memory
1806   int adr_type = Compile::AliasIdxRaw;
1807   // Convert the pointer to an int prior to doing math on it
1808   Node* cast = _gvn.transform(new (C, 2) CastP2XNode(control(), adr));
1809   // Divide by card size
1810   assert(Universe::heap()->barrier_set()->kind() == BarrierSet::CardTableModRef,
1811          "Only one we handle so far.");
1812   CardTableModRefBS* ct =
1813     (CardTableModRefBS*)(Universe::heap()->barrier_set());
1814   Node *b = _gvn.transform(new (C, 3) URShiftXNode( cast, _gvn.intcon(CardTableModRefBS::card_shift) ));
1815   // We store into a byte array, so do not bother to left-shift by zero
1816   // Get base of card map
1817   assert(sizeof(*ct->byte_map_base) == sizeof(jbyte),
1818          "adjust this code");
1819   Node *c = makecon(TypeRawPtr::make((address)ct->byte_map_base));
1820   // Combine
1821   Node *sb_ctl = control();
1822   Node *sb_adr = _gvn.transform(new (C, 4) AddPNode( top()/*no base ptr*/, c, b ));
1823   Node *sb_val = _gvn.intcon(0);
1824   // Smash zero into card
1825   if( !UseConcMarkSweepGC ) {
1826     BasicType bt = T_BYTE;
1827     store_to_memory(sb_ctl, sb_adr, sb_val, bt, adr_type);
1828   } else {
1829     // Specialized path for CM store barrier
1830     cms_card_mark( sb_ctl, sb_adr, sb_val, oop_store);
1831   }
1832 }
1833 
1834 // Specialized path for CMS store barrier
1835 void GraphKit::cms_card_mark(Node* ctl, Node* adr, Node* val, Node *oop_store) {
1836   BasicType bt = T_BYTE;
1837   int adr_idx = Compile::AliasIdxRaw;
1838   Node* mem = memory(adr_idx);
1839 
1840   // The type input is NULL in PRODUCT builds
1841   const TypePtr* type = NULL;
1842   debug_only(type = C->get_adr_type(adr_idx));
1843 
1844   // Add required edge to oop_store, optimizer does not support precedence edges.
1845   // Convert required edge to precedence edge before allocation.
1846   Node *store = _gvn.transform( new (C, 5) StoreCMNode(ctl, mem, adr, type, val, oop_store) );
1847   set_memory(store, adr_idx);
1848 
1849   // For CMS, back-to-back card-marks can only remove the first one
1850   // and this requires DU info.  Push on worklist for optimizer.
1851   if (mem->req() > MemNode::Address && adr == mem->in(MemNode::Address))
1852     record_for_igvn(store);
1853 }
1854 
1855 
1856 void GraphKit::round_double_arguments(ciMethod* dest_method) {
1857   // (Note:  TypeFunc::make has a cache that makes this fast.)
1858   const TypeFunc* tf    = TypeFunc::make(dest_method);
1859   int             nargs = tf->_domain->_cnt - TypeFunc::Parms;
1860   for (int j = 0; j < nargs; j++) {
1861     const Type *targ = tf->_domain->field_at(j + TypeFunc::Parms);
1862     if( targ->basic_type() == T_DOUBLE ) {
1863       // If any parameters are doubles, they must be rounded before
1864       // the call, dstore_rounding does gvn.transform
1865       Node *arg = argument(j);
1866       arg = dstore_rounding(arg);
1867       set_argument(j, arg);
1868     }
1869   }
1870 }
1871 
1872 void GraphKit::round_double_result(ciMethod* dest_method) {
1873   // A non-strict method may return a double value which has an extended
1874   // exponent, but this must not be visible in a caller which is 'strict'
1875   // If a strict caller invokes a non-strict callee, round a double result
1876 
1877   BasicType result_type = dest_method->return_type()->basic_type();
1878   assert( method() != NULL, "must have caller context");
1879   if( result_type == T_DOUBLE && method()->is_strict() && !dest_method->is_strict() ) {
1880     // Destination method's return value is on top of stack
1881     // dstore_rounding() does gvn.transform
1882     Node *result = pop_pair();
1883     result = dstore_rounding(result);
1884     push_pair(result);
1885   }
1886 }
1887 
1888 // rounding for strict float precision conformance
1889 Node* GraphKit::precision_rounding(Node* n) {
1890   return UseStrictFP && _method->flags().is_strict()
1891     && UseSSE == 0 && Matcher::strict_fp_requires_explicit_rounding
1892     ? _gvn.transform( new (C, 2) RoundFloatNode(0, n) )
1893     : n;
1894 }
1895 
1896 // rounding for strict double precision conformance
1897 Node* GraphKit::dprecision_rounding(Node *n) {
1898   return UseStrictFP && _method->flags().is_strict()
1899     && UseSSE <= 1 && Matcher::strict_fp_requires_explicit_rounding
1900     ? _gvn.transform( new (C, 2) RoundDoubleNode(0, n) )
1901     : n;
1902 }
1903 
1904 // rounding for non-strict double stores
1905 Node* GraphKit::dstore_rounding(Node* n) {
1906   return Matcher::strict_fp_requires_explicit_rounding
1907     && UseSSE <= 1
1908     ? _gvn.transform( new (C, 2) RoundDoubleNode(0, n) )
1909     : n;
1910 }
1911 
1912 //=============================================================================
1913 // Generate a fast path/slow path idiom.  Graph looks like:
1914 // [foo] indicates that 'foo' is a parameter
1915 //
1916 //              [in]     NULL
1917 //                 \    /
1918 //                  CmpP
1919 //                  Bool ne
1920 //                   If
1921 //                  /  \
1922 //              True    False-<2>
1923 //              / |
1924 //             /  cast_not_null
1925 //           Load  |    |   ^
1926 //        [fast_test]   |   |
1927 // gvn to   opt_test    |   |
1928 //          /    \      |  <1>
1929 //      True     False  |
1930 //        |         \\  |
1931 //   [slow_call]     \[fast_result]
1932 //    Ctl   Val       \      \
1933 //     |               \      \
1934 //    Catch       <1>   \      \
1935 //   /    \        ^     \      \
1936 //  Ex    No_Ex    |      \      \
1937 //  |       \   \  |       \ <2>  \
1938 //  ...      \  [slow_res] |  |    \   [null_result]
1939 //            \         \--+--+---  |  |
1940 //             \           | /    \ | /
1941 //              --------Region     Phi
1942 //
1943 //=============================================================================
1944 // Code is structured as a series of driver functions all called 'do_XXX' that
1945 // call a set of helper functions.  Helper functions first, then drivers.
1946 
1947 //------------------------------null_check_oop---------------------------------
1948 // Null check oop.  Set null-path control into Region in slot 3.
1949 // Make a cast-not-nullness use the other not-null control.  Return cast.
1950 Node* GraphKit::null_check_oop(Node* value, Node* *null_control,
1951                                bool never_see_null) {
1952   // Initial NULL check taken path
1953   (*null_control) = top();
1954   Node* cast = null_check_common(value, T_OBJECT, false, null_control);
1955 
1956   // Generate uncommon_trap:
1957   if (never_see_null && (*null_control) != top()) {
1958     // If we see an unexpected null at a check-cast we record it and force a
1959     // recompile; the offending check-cast will be compiled to handle NULLs.
1960     // If we see more than one offending BCI, then all checkcasts in the
1961     // method will be compiled to handle NULLs.
1962     PreserveJVMState pjvms(this);
1963     set_control(*null_control);
1964     replace_in_map(value, null());
1965     uncommon_trap(Deoptimization::Reason_null_check,
1966                   Deoptimization::Action_make_not_entrant);
1967     (*null_control) = top();    // NULL path is dead
1968   }
1969 
1970   // Cast away null-ness on the result
1971   return cast;
1972 }
1973 
1974 //------------------------------opt_iff----------------------------------------
1975 // Optimize the fast-check IfNode.  Set the fast-path region slot 2.
1976 // Return slow-path control.
1977 Node* GraphKit::opt_iff(Node* region, Node* iff) {
1978   IfNode *opt_iff = _gvn.transform(iff)->as_If();
1979 
1980   // Fast path taken; set region slot 2
1981   Node *fast_taken = _gvn.transform( new (C, 1) IfFalseNode(opt_iff) );
1982   region->init_req(2,fast_taken); // Capture fast-control
1983 
1984   // Fast path not-taken, i.e. slow path
1985   Node *slow_taken = _gvn.transform( new (C, 1) IfTrueNode(opt_iff) );
1986   return slow_taken;
1987 }
1988 
1989 //-----------------------------make_runtime_call-------------------------------
1990 Node* GraphKit::make_runtime_call(int flags,
1991                                   const TypeFunc* call_type, address call_addr,
1992                                   const char* call_name,
1993                                   const TypePtr* adr_type,
1994                                   // The following parms are all optional.
1995                                   // The first NULL ends the list.
1996                                   Node* parm0, Node* parm1,
1997                                   Node* parm2, Node* parm3,
1998                                   Node* parm4, Node* parm5,
1999                                   Node* parm6, Node* parm7) {
2000   // Slow-path call
2001   int size = call_type->domain()->cnt();
2002   bool is_leaf = !(flags & RC_NO_LEAF);
2003   bool has_io  = (!is_leaf && !(flags & RC_NO_IO));
2004   if (call_name == NULL) {
2005     assert(!is_leaf, "must supply name for leaf");
2006     call_name = OptoRuntime::stub_name(call_addr);
2007   }
2008   CallNode* call;
2009   if (!is_leaf) {
2010     call = new(C, size) CallStaticJavaNode(call_type, call_addr, call_name,
2011                                            bci(), adr_type);
2012   } else if (flags & RC_NO_FP) {
2013     call = new(C, size) CallLeafNoFPNode(call_type, call_addr, call_name, adr_type);
2014   } else {
2015     call = new(C, size) CallLeafNode(call_type, call_addr, call_name, adr_type);
2016   }
2017 
2018   // The following is similar to set_edges_for_java_call,
2019   // except that the memory effects of the call are restricted to AliasIdxRaw.
2020 
2021   // Slow path call has no side-effects, uses few values
2022   bool wide_in  = !(flags & RC_NARROW_MEM);
2023   bool wide_out = (C->get_alias_index(adr_type) == Compile::AliasIdxBot);
2024 
2025   Node* prev_mem = NULL;
2026   if (wide_in) {
2027     prev_mem = set_predefined_input_for_runtime_call(call);
2028   } else {
2029     assert(!wide_out, "narrow in => narrow out");
2030     Node* narrow_mem = memory(adr_type);
2031     prev_mem = reset_memory();
2032     map()->set_memory(narrow_mem);
2033     set_predefined_input_for_runtime_call(call);
2034   }
2035 
2036   // Hook each parm in order.  Stop looking at the first NULL.
2037   if (parm0 != NULL) { call->init_req(TypeFunc::Parms+0, parm0);
2038   if (parm1 != NULL) { call->init_req(TypeFunc::Parms+1, parm1);
2039   if (parm2 != NULL) { call->init_req(TypeFunc::Parms+2, parm2);
2040   if (parm3 != NULL) { call->init_req(TypeFunc::Parms+3, parm3);
2041   if (parm4 != NULL) { call->init_req(TypeFunc::Parms+4, parm4);
2042   if (parm5 != NULL) { call->init_req(TypeFunc::Parms+5, parm5);
2043   if (parm6 != NULL) { call->init_req(TypeFunc::Parms+6, parm6);
2044   if (parm7 != NULL) { call->init_req(TypeFunc::Parms+7, parm7);
2045     /* close each nested if ===> */  } } } } } } } }
2046   assert(call->in(call->req()-1) != NULL, "must initialize all parms");
2047 
2048   if (!is_leaf) {
2049     // Non-leaves can block and take safepoints:
2050     add_safepoint_edges(call, ((flags & RC_MUST_THROW) != 0));
2051   }
2052   // Non-leaves can throw exceptions:
2053   if (has_io) {
2054     call->set_req(TypeFunc::I_O, i_o());
2055   }
2056 
2057   if (flags & RC_UNCOMMON) {
2058     // Set the count to a tiny probability.  Cf. Estimate_Block_Frequency.
2059     // (An "if" probability corresponds roughly to an unconditional count.
2060     // Sort of.)
2061     call->set_cnt(PROB_UNLIKELY_MAG(4));
2062   }
2063 
2064   Node* c = _gvn.transform(call);
2065   assert(c == call, "cannot disappear");
2066 
2067   if (wide_out) {
2068     // Slow path call has full side-effects.
2069     set_predefined_output_for_runtime_call(call);
2070   } else {
2071     // Slow path call has few side-effects, and/or sets few values.
2072     set_predefined_output_for_runtime_call(call, prev_mem, adr_type);
2073   }
2074 
2075   if (has_io) {
2076     set_i_o(_gvn.transform(new (C, 1) ProjNode(call, TypeFunc::I_O)));
2077   }
2078   return call;
2079 
2080 }
2081 
2082 //------------------------------merge_memory-----------------------------------
2083 // Merge memory from one path into the current memory state.
2084 void GraphKit::merge_memory(Node* new_mem, Node* region, int new_path) {
2085   for (MergeMemStream mms(merged_memory(), new_mem->as_MergeMem()); mms.next_non_empty2(); ) {
2086     Node* old_slice = mms.force_memory();
2087     Node* new_slice = mms.memory2();
2088     if (old_slice != new_slice) {
2089       PhiNode* phi;
2090       if (new_slice->is_Phi() && new_slice->as_Phi()->region() == region) {
2091         phi = new_slice->as_Phi();
2092         #ifdef ASSERT
2093         if (old_slice->is_Phi() && old_slice->as_Phi()->region() == region)
2094           old_slice = old_slice->in(new_path);
2095         // Caller is responsible for ensuring that any pre-existing
2096         // phis are already aware of old memory.
2097         int old_path = (new_path > 1) ? 1 : 2;  // choose old_path != new_path
2098         assert(phi->in(old_path) == old_slice, "pre-existing phis OK");
2099         #endif
2100         mms.set_memory(phi);
2101       } else {
2102         phi = PhiNode::make(region, old_slice, Type::MEMORY, mms.adr_type(C));
2103         _gvn.set_type(phi, Type::MEMORY);
2104         phi->set_req(new_path, new_slice);
2105         mms.set_memory(_gvn.transform(phi));  // assume it is complete
2106       }
2107     }
2108   }
2109 }
2110 
2111 //------------------------------make_slow_call_ex------------------------------
2112 // Make the exception handler hookups for the slow call
2113 void GraphKit::make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj) {
2114   if (stopped())  return;
2115 
2116   // Make a catch node with just two handlers:  fall-through and catch-all
2117   Node* i_o  = _gvn.transform( new (C, 1) ProjNode(call, TypeFunc::I_O, separate_io_proj) );
2118   Node* catc = _gvn.transform( new (C, 2) CatchNode(control(), i_o, 2) );
2119   Node* norm = _gvn.transform( new (C, 1) CatchProjNode(catc, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci) );
2120   Node* excp = _gvn.transform( new (C, 1) CatchProjNode(catc, CatchProjNode::catch_all_index,    CatchProjNode::no_handler_bci) );
2121 
2122   { PreserveJVMState pjvms(this);
2123     set_control(excp);
2124     set_i_o(i_o);
2125 
2126     if (excp != top()) {
2127       // Create an exception state also.
2128       // Use an exact type if the caller has specified a specific exception.
2129       const Type* ex_type = TypeOopPtr::make_from_klass_unique(ex_klass)->cast_to_ptr_type(TypePtr::NotNull);
2130       Node*       ex_oop  = new (C, 2) CreateExNode(ex_type, control(), i_o);
2131       add_exception_state(make_exception_state(_gvn.transform(ex_oop)));
2132     }
2133   }
2134 
2135   // Get the no-exception control from the CatchNode.
2136   set_control(norm);
2137 }
2138 
2139 
2140 //-------------------------------gen_subtype_check-----------------------------
2141 // Generate a subtyping check.  Takes as input the subtype and supertype.
2142 // Returns 2 values: sets the default control() to the true path and returns
2143 // the false path.  Only reads invariant memory; sets no (visible) memory.
2144 // The PartialSubtypeCheckNode sets the hidden 1-word cache in the encoding
2145 // but that's not exposed to the optimizer.  This call also doesn't take in an
2146 // Object; if you wish to check an Object you need to load the Object's class
2147 // prior to coming here.
2148 Node* GraphKit::gen_subtype_check(Node* subklass, Node* superklass) {
2149   // Fast check for identical types, perhaps identical constants.
2150   // The types can even be identical non-constants, in cases
2151   // involving Array.newInstance, Object.clone, etc.
2152   if (subklass == superklass)
2153     return top();             // false path is dead; no test needed.
2154 
2155   if (_gvn.type(superklass)->singleton()) {
2156     ciKlass* superk = _gvn.type(superklass)->is_klassptr()->klass();
2157     ciKlass* subk   = _gvn.type(subklass)->is_klassptr()->klass();
2158 
2159     // In the common case of an exact superklass, try to fold up the
2160     // test before generating code.  You may ask, why not just generate
2161     // the code and then let it fold up?  The answer is that the generated
2162     // code will necessarily include null checks, which do not always
2163     // completely fold away.  If they are also needless, then they turn
2164     // into a performance loss.  Example:
2165     //    Foo[] fa = blah(); Foo x = fa[0]; fa[1] = x;
2166     // Here, the type of 'fa' is often exact, so the store check
2167     // of fa[1]=x will fold up, without testing the nullness of x.
2168     switch (static_subtype_check(superk, subk)) {
2169     case SSC_always_false:
2170       {
2171         Node* always_fail = control();
2172         set_control(top());
2173         return always_fail;
2174       }
2175     case SSC_always_true:
2176       return top();
2177     case SSC_easy_test:
2178       {
2179         // Just do a direct pointer compare and be done.
2180         Node* cmp = _gvn.transform( new(C, 3) CmpPNode(subklass, superklass) );
2181         Node* bol = _gvn.transform( new(C, 2) BoolNode(cmp, BoolTest::eq) );
2182         IfNode* iff = create_and_xform_if(control(), bol, PROB_STATIC_FREQUENT, COUNT_UNKNOWN);
2183         set_control( _gvn.transform( new(C, 1) IfTrueNode (iff) ) );
2184         return       _gvn.transform( new(C, 1) IfFalseNode(iff) );
2185       }
2186     case SSC_full_test:
2187       break;
2188     default:
2189       ShouldNotReachHere();
2190     }
2191   }
2192 
2193   // %%% Possible further optimization:  Even if the superklass is not exact,
2194   // if the subklass is the unique subtype of the superklass, the check
2195   // will always succeed.  We could leave a dependency behind to ensure this.
2196 
2197   // First load the super-klass's check-offset
2198   Node *p1 = basic_plus_adr( superklass, superklass, sizeof(oopDesc) + Klass::super_check_offset_offset_in_bytes() );
2199   Node *chk_off = _gvn.transform( new (C, 3) LoadINode( NULL, memory(p1), p1, _gvn.type(p1)->is_ptr() ) );
2200   int cacheoff_con = sizeof(oopDesc) + Klass::secondary_super_cache_offset_in_bytes();
2201   bool might_be_cache = (find_int_con(chk_off, cacheoff_con) == cacheoff_con);
2202 
2203   // Load from the sub-klass's super-class display list, or a 1-word cache of
2204   // the secondary superclass list, or a failing value with a sentinel offset
2205   // if the super-klass is an interface or exceptionally deep in the Java
2206   // hierarchy and we have to scan the secondary superclass list the hard way.
2207   // Worst-case type is a little odd: NULL is allowed as a result (usually
2208   // klass loads can never produce a NULL).
2209   Node *chk_off_X = ConvI2X(chk_off);
2210   Node *p2 = _gvn.transform( new (C, 4) AddPNode(subklass,subklass,chk_off_X) );
2211   // For some types like interfaces the following loadKlass is from a 1-word
2212   // cache which is mutable so can't use immutable memory.  Other
2213   // types load from the super-class display table which is immutable.
2214   Node *kmem = might_be_cache ? memory(p2) : immutable_memory();
2215   Node *nkls = _gvn.transform( LoadKlassNode::make( _gvn, kmem, p2, _gvn.type(p2)->is_ptr(), TypeKlassPtr::OBJECT_OR_NULL ) );
2216 
2217   // Compile speed common case: ARE a subtype and we canNOT fail
2218   if( superklass == nkls )
2219     return top();             // false path is dead; no test needed.
2220 
2221   // See if we get an immediate positive hit.  Happens roughly 83% of the
2222   // time.  Test to see if the value loaded just previously from the subklass
2223   // is exactly the superklass.
2224   Node *cmp1 = _gvn.transform( new (C, 3) CmpPNode( superklass, nkls ) );
2225   Node *bol1 = _gvn.transform( new (C, 2) BoolNode( cmp1, BoolTest::eq ) );
2226   IfNode *iff1 = create_and_xform_if( control(), bol1, PROB_LIKELY(0.83f), COUNT_UNKNOWN );
2227   Node *iftrue1 = _gvn.transform( new (C, 1) IfTrueNode ( iff1 ) );
2228   set_control(    _gvn.transform( new (C, 1) IfFalseNode( iff1 ) ) );
2229 
2230   // Compile speed common case: Check for being deterministic right now.  If
2231   // chk_off is a constant and not equal to cacheoff then we are NOT a
2232   // subklass.  In this case we need exactly the 1 test above and we can
2233   // return those results immediately.
2234   if (!might_be_cache) {
2235     Node* not_subtype_ctrl = control();
2236     set_control(iftrue1); // We need exactly the 1 test above
2237     return not_subtype_ctrl;
2238   }
2239 
2240   // Gather the various success & failures here
2241   RegionNode *r_ok_subtype = new (C, 4) RegionNode(4);
2242   record_for_igvn(r_ok_subtype);
2243   RegionNode *r_not_subtype = new (C, 3) RegionNode(3);
2244   record_for_igvn(r_not_subtype);
2245 
2246   r_ok_subtype->init_req(1, iftrue1);
2247 
2248   // Check for immediate negative hit.  Happens roughly 11% of the time (which
2249   // is roughly 63% of the remaining cases).  Test to see if the loaded
2250   // check-offset points into the subklass display list or the 1-element
2251   // cache.  If it points to the display (and NOT the cache) and the display
2252   // missed then it's not a subtype.
2253   Node *cacheoff = _gvn.intcon(cacheoff_con);
2254   Node *cmp2 = _gvn.transform( new (C, 3) CmpINode( chk_off, cacheoff ) );
2255   Node *bol2 = _gvn.transform( new (C, 2) BoolNode( cmp2, BoolTest::ne ) );
2256   IfNode *iff2 = create_and_xform_if( control(), bol2, PROB_LIKELY(0.63f), COUNT_UNKNOWN );
2257   r_not_subtype->init_req(1, _gvn.transform( new (C, 1) IfTrueNode (iff2) ) );
2258   set_control(                _gvn.transform( new (C, 1) IfFalseNode(iff2) ) );
2259 
2260   // Check for self.  Very rare to get here, but its taken 1/3 the time.
2261   // No performance impact (too rare) but allows sharing of secondary arrays
2262   // which has some footprint reduction.
2263   Node *cmp3 = _gvn.transform( new (C, 3) CmpPNode( subklass, superklass ) );
2264   Node *bol3 = _gvn.transform( new (C, 2) BoolNode( cmp3, BoolTest::eq ) );
2265   IfNode *iff3 = create_and_xform_if( control(), bol3, PROB_LIKELY(0.36f), COUNT_UNKNOWN );
2266   r_ok_subtype->init_req(2, _gvn.transform( new (C, 1) IfTrueNode ( iff3 ) ) );
2267   set_control(               _gvn.transform( new (C, 1) IfFalseNode( iff3 ) ) );
2268 
2269   // Now do a linear scan of the secondary super-klass array.  Again, no real
2270   // performance impact (too rare) but it's gotta be done.
2271   // (The stub also contains the self-check of subklass == superklass.
2272   // Since the code is rarely used, there is no penalty for moving it
2273   // out of line, and it can only improve I-cache density.)
2274   Node* psc = _gvn.transform(
2275     new (C, 3) PartialSubtypeCheckNode(control(), subklass, superklass) );
2276 
2277   Node *cmp4 = _gvn.transform( new (C, 3) CmpPNode( psc, null() ) );
2278   Node *bol4 = _gvn.transform( new (C, 2) BoolNode( cmp4, BoolTest::ne ) );
2279   IfNode *iff4 = create_and_xform_if( control(), bol4, PROB_FAIR, COUNT_UNKNOWN );
2280   r_not_subtype->init_req(2, _gvn.transform( new (C, 1) IfTrueNode (iff4) ) );
2281   r_ok_subtype ->init_req(3, _gvn.transform( new (C, 1) IfFalseNode(iff4) ) );
2282 
2283   // Return false path; set default control to true path.
2284   set_control( _gvn.transform(r_ok_subtype) );
2285   return _gvn.transform(r_not_subtype);
2286 }
2287 
2288 //----------------------------static_subtype_check-----------------------------
2289 // Shortcut important common cases when superklass is exact:
2290 // (0) superklass is java.lang.Object (can occur in reflective code)
2291 // (1) subklass is already limited to a subtype of superklass => always ok
2292 // (2) subklass does not overlap with superklass => always fail
2293 // (3) superklass has NO subtypes and we can check with a simple compare.
2294 int GraphKit::static_subtype_check(ciKlass* superk, ciKlass* subk) {
2295   if (StressReflectiveCode) {
2296     return SSC_full_test;       // Let caller generate the general case.
2297   }
2298 
2299   if (superk == env()->Object_klass()) {
2300     return SSC_always_true;     // (0) this test cannot fail
2301   }
2302 
2303   ciType* superelem = superk;
2304   if (superelem->is_array_klass())
2305     superelem = superelem->as_array_klass()->base_element_type();
2306 
2307   if (!subk->is_interface()) {  // cannot trust static interface types yet
2308     if (subk->is_subtype_of(superk)) {
2309       return SSC_always_true;   // (1) false path dead; no dynamic test needed
2310     }
2311     if (!(superelem->is_klass() && superelem->as_klass()->is_interface()) &&
2312         !superk->is_subtype_of(subk)) {
2313       return SSC_always_false;
2314     }
2315   }
2316 
2317   // If casting to an instance klass, it must have no subtypes
2318   if (superk->is_interface()) {
2319     // Cannot trust interfaces yet.
2320     // %%% S.B. superk->nof_implementors() == 1
2321   } else if (superelem->is_instance_klass()) {
2322     ciInstanceKlass* ik = superelem->as_instance_klass();
2323     if (!ik->has_subklass() && !ik->is_interface()) {
2324       if (!ik->is_final()) {
2325         // Add a dependency if there is a chance of a later subclass.
2326         C->dependencies()->assert_leaf_type(ik);
2327       }
2328       return SSC_easy_test;     // (3) caller can do a simple ptr comparison
2329     }
2330   } else {
2331     // A primitive array type has no subtypes.
2332     return SSC_easy_test;       // (3) caller can do a simple ptr comparison
2333   }
2334 
2335   return SSC_full_test;
2336 }
2337 
2338 // Profile-driven exact type check:
2339 Node* GraphKit::type_check_receiver(Node* receiver, ciKlass* klass,
2340                                     float prob,
2341                                     Node* *casted_receiver) {
2342   const TypeKlassPtr* tklass = TypeKlassPtr::make(klass);
2343   Node* recv_klass = load_object_klass(receiver);
2344   Node* want_klass = makecon(tklass);
2345   Node* cmp = _gvn.transform( new(C, 3) CmpPNode(recv_klass, want_klass) );
2346   Node* bol = _gvn.transform( new(C, 2) BoolNode(cmp, BoolTest::eq) );
2347   IfNode* iff = create_and_xform_if(control(), bol, prob, COUNT_UNKNOWN);
2348   set_control( _gvn.transform( new(C, 1) IfTrueNode (iff) ));
2349   Node* fail = _gvn.transform( new(C, 1) IfFalseNode(iff) );
2350 
2351   const TypeOopPtr* recv_xtype = tklass->as_instance_type();
2352   assert(recv_xtype->klass_is_exact(), "");
2353 
2354   // Subsume downstream occurrences of receiver with a cast to
2355   // recv_xtype, since now we know what the type will be.
2356   Node* cast = new(C, 2) CheckCastPPNode(control(), receiver, recv_xtype);
2357   (*casted_receiver) = _gvn.transform(cast);
2358   // (User must make the replace_in_map call.)
2359 
2360   return fail;
2361 }
2362 
2363 
2364 //-------------------------------gen_instanceof--------------------------------
2365 // Generate an instance-of idiom.  Used by both the instance-of bytecode
2366 // and the reflective instance-of call.
2367 Node* GraphKit::gen_instanceof( Node *subobj, Node* superklass ) {
2368   C->set_has_split_ifs(true); // Has chance for split-if optimization
2369   assert( !stopped(), "dead parse path should be checked in callers" );
2370   assert(!TypePtr::NULL_PTR->higher_equal(_gvn.type(superklass)->is_klassptr()),
2371          "must check for not-null not-dead klass in callers");
2372 
2373   // Make the merge point
2374   enum { _obj_path = 1, _fail_path, _null_path, PATH_LIMIT };
2375   RegionNode* region = new(C, PATH_LIMIT) RegionNode(PATH_LIMIT);
2376   Node*       phi    = new(C, PATH_LIMIT) PhiNode(region, TypeInt::BOOL);
2377   C->set_has_split_ifs(true); // Has chance for split-if optimization
2378 
2379   // Null check; get casted pointer; set region slot 3
2380   Node* null_ctl = top();
2381   Node* not_null_obj = null_check_oop(subobj, &null_ctl);
2382 
2383   // If not_null_obj is dead, only null-path is taken
2384   if (stopped()) {              // Doing instance-of on a NULL?
2385     set_control(null_ctl);
2386     return intcon(0);
2387   }
2388   region->init_req(_null_path, null_ctl);
2389   phi   ->init_req(_null_path, intcon(0)); // Set null path value
2390 
2391   // Load the object's klass
2392   Node* obj_klass = load_object_klass(not_null_obj);
2393 
2394   // Generate the subtype check
2395   Node* not_subtype_ctrl = gen_subtype_check(obj_klass, superklass);
2396 
2397   // Plug in the success path to the general merge in slot 1.
2398   region->init_req(_obj_path, control());
2399   phi   ->init_req(_obj_path, intcon(1));
2400 
2401   // Plug in the failing path to the general merge in slot 2.
2402   region->init_req(_fail_path, not_subtype_ctrl);
2403   phi   ->init_req(_fail_path, intcon(0));
2404 
2405   // Return final merged results
2406   set_control( _gvn.transform(region) );
2407   record_for_igvn(region);
2408   return _gvn.transform(phi);
2409 }
2410 
2411 //-------------------------------gen_checkcast---------------------------------
2412 // Generate a checkcast idiom.  Used by both the checkcast bytecode and the
2413 // array store bytecode.  Stack must be as-if BEFORE doing the bytecode so the
2414 // uncommon-trap paths work.  Adjust stack after this call.
2415 // If failure_control is supplied and not null, it is filled in with
2416 // the control edge for the cast failure.  Otherwise, an appropriate
2417 // uncommon trap or exception is thrown.
2418 Node* GraphKit::gen_checkcast(Node *obj, Node* superklass,
2419                               Node* *failure_control) {
2420   kill_dead_locals();           // Benefit all the uncommon traps
2421   const TypeKlassPtr *tk = _gvn.type(superklass)->is_klassptr();
2422   const Type *toop = TypeOopPtr::make_from_klass(tk->klass());
2423 
2424   // Fast cutout:  Check the case that the cast is vacuously true.
2425   // This detects the common cases where the test will short-circuit
2426   // away completely.  We do this before we perform the null check,
2427   // because if the test is going to turn into zero code, we don't
2428   // want a residual null check left around.  (Causes a slowdown,
2429   // for example, in some objArray manipulations, such as a[i]=a[j].)
2430   if (tk->singleton()) {
2431     const TypeOopPtr* objtp = _gvn.type(obj)->isa_oopptr();
2432     if (objtp != NULL && objtp->klass() != NULL) {
2433       switch (static_subtype_check(tk->klass(), objtp->klass())) {
2434       case SSC_always_true:
2435         return obj;
2436       case SSC_always_false:
2437         // It needs a null check because a null will *pass* the cast check.
2438         // A non-null value will always produce an exception.
2439         return do_null_assert(obj, T_OBJECT);
2440       }
2441     }
2442   }
2443 
2444   ciProfileData* data = NULL;
2445   if (failure_control == NULL) {        // use MDO in regular case only
2446     assert(java_bc() == Bytecodes::_aastore ||
2447            java_bc() == Bytecodes::_checkcast,
2448            "interpreter profiles type checks only for these BCs");
2449     data = method()->method_data()->bci_to_data(bci());
2450   }
2451 
2452   // Make the merge point
2453   enum { _obj_path = 1, _null_path, PATH_LIMIT };
2454   RegionNode* region = new (C, PATH_LIMIT) RegionNode(PATH_LIMIT);
2455   Node*       phi    = new (C, PATH_LIMIT) PhiNode(region, toop);
2456   C->set_has_split_ifs(true); // Has chance for split-if optimization
2457 
2458   // Use null-cast information if it is available
2459   bool never_see_null = false;
2460   // If we see an unexpected null at a check-cast we record it and force a
2461   // recompile; the offending check-cast will be compiled to handle NULLs.
2462   // If we see several offending BCIs, then all checkcasts in the
2463   // method will be compiled to handle NULLs.
2464   if (UncommonNullCast            // Cutout for this technique
2465       && failure_control == NULL  // regular case
2466       && obj != null()            // And not the -Xcomp stupid case?
2467       && !too_many_traps(Deoptimization::Reason_null_check)) {
2468     // Finally, check the "null_seen" bit from the interpreter.
2469     if (data == NULL || !data->as_BitData()->null_seen()) {
2470       never_see_null = true;
2471     }
2472   }
2473 
2474   // Null check; get casted pointer; set region slot 3
2475   Node* null_ctl = top();
2476   Node* not_null_obj = null_check_oop(obj, &null_ctl, never_see_null);
2477 
2478   // If not_null_obj is dead, only null-path is taken
2479   if (stopped()) {              // Doing instance-of on a NULL?
2480     set_control(null_ctl);
2481     return null();
2482   }
2483   region->init_req(_null_path, null_ctl);
2484   phi   ->init_req(_null_path, null());  // Set null path value
2485 
2486   Node* cast_obj = NULL;        // the casted version of the object
2487 
2488   // If the profile has seen exactly one type, narrow to that type.
2489   // (The subsequent subtype check will always fold up.)
2490   if (UseTypeProfile && TypeProfileCasts && data != NULL &&
2491       // Counter has never been decremented (due to cast failure).
2492       // ...This is a reasonable thing to expect.  It is true of
2493       // all casts inserted by javac to implement generic types.
2494       data->as_CounterData()->count() >= 0 &&
2495       !too_many_traps(Deoptimization::Reason_class_check)) {
2496     // (No, this isn't a call, but it's enough like a virtual call
2497     // to use the same ciMethod accessor to get the profile info...)
2498     ciCallProfile profile = method()->call_profile_at_bci(bci());
2499     if (profile.count() >= 0 &&         // no cast failures here
2500         profile.has_receiver(0) &&
2501         profile.morphism() == 1) {
2502       ciKlass* exact_kls = profile.receiver(0);
2503       int ssc = static_subtype_check(tk->klass(), exact_kls);
2504       if (ssc == SSC_always_true) {
2505         // If we narrow the type to match what the type profile sees,
2506         // we can then remove the rest of the cast.
2507         // This is a win, even if the exact_kls is very specific,
2508         // because downstream operations, such as method calls,
2509         // will often benefit from the sharper type.
2510         Node* exact_obj = not_null_obj; // will get updated in place...
2511         Node* slow_ctl  = type_check_receiver(exact_obj, exact_kls, 1.0,
2512                                               &exact_obj);
2513         { PreserveJVMState pjvms(this);
2514           set_control(slow_ctl);
2515           uncommon_trap(Deoptimization::Reason_class_check,
2516                         Deoptimization::Action_maybe_recompile);
2517         }
2518         if (failure_control != NULL) // failure is now impossible
2519           (*failure_control) = top();
2520         replace_in_map(not_null_obj, exact_obj);
2521         // adjust the type of the phi to the exact klass:
2522         phi->raise_bottom_type(_gvn.type(exact_obj)->meet(TypePtr::NULL_PTR));
2523         cast_obj = exact_obj;
2524       }
2525       // assert(cast_obj != NULL)... except maybe the profile lied to us.
2526     }
2527   }
2528 
2529   if (cast_obj == NULL) {
2530     // Load the object's klass
2531     Node* obj_klass = load_object_klass(not_null_obj);
2532 
2533     // Generate the subtype check
2534     Node* not_subtype_ctrl = gen_subtype_check( obj_klass, superklass );
2535 
2536     // Plug in success path into the merge
2537     cast_obj = _gvn.transform(new (C, 2) CheckCastPPNode(control(),
2538                                                          not_null_obj, toop));
2539     // Failure path ends in uncommon trap (or may be dead - failure impossible)
2540     if (failure_control == NULL) {
2541       if (not_subtype_ctrl != top()) { // If failure is possible
2542         PreserveJVMState pjvms(this);
2543         set_control(not_subtype_ctrl);
2544         builtin_throw(Deoptimization::Reason_class_check, obj_klass);
2545       }
2546     } else {
2547       (*failure_control) = not_subtype_ctrl;
2548     }
2549   }
2550 
2551   region->init_req(_obj_path, control());
2552   phi   ->init_req(_obj_path, cast_obj);
2553 
2554   // A merge of NULL or Casted-NotNull obj
2555   Node* res = _gvn.transform(phi);
2556 
2557   // Note I do NOT always 'replace_in_map(obj,result)' here.
2558   //  if( tk->klass()->can_be_primary_super()  )
2559     // This means that if I successfully store an Object into an array-of-String
2560     // I 'forget' that the Object is really now known to be a String.  I have to
2561     // do this because we don't have true union types for interfaces - if I store
2562     // a Baz into an array-of-Interface and then tell the optimizer it's an
2563     // Interface, I forget that it's also a Baz and cannot do Baz-like field
2564     // references to it.  FIX THIS WHEN UNION TYPES APPEAR!
2565   //  replace_in_map( obj, res );
2566 
2567   // Return final merged results
2568   set_control( _gvn.transform(region) );
2569   record_for_igvn(region);
2570   return res;
2571 }
2572 
2573 //------------------------------next_monitor-----------------------------------
2574 // What number should be given to the next monitor?
2575 int GraphKit::next_monitor() {
2576   int current = jvms()->monitor_depth()* C->sync_stack_slots();
2577   int next = current + C->sync_stack_slots();
2578   // Keep the toplevel high water mark current:
2579   if (C->fixed_slots() < next)  C->set_fixed_slots(next);
2580   return current;
2581 }
2582 
2583 //------------------------------insert_mem_bar---------------------------------
2584 // Memory barrier to avoid floating things around
2585 // The membar serves as a pinch point between both control and all memory slices.
2586 Node* GraphKit::insert_mem_bar(int opcode, Node* precedent) {
2587   MemBarNode* mb = MemBarNode::make(C, opcode, Compile::AliasIdxBot, precedent);
2588   mb->init_req(TypeFunc::Control, control());
2589   mb->init_req(TypeFunc::Memory,  reset_memory());
2590   Node* membar = _gvn.transform(mb);
2591   set_control(_gvn.transform(new (C, 1) ProjNode(membar,TypeFunc::Control) ));
2592   set_all_memory_call(membar);
2593   return membar;
2594 }
2595 
2596 //-------------------------insert_mem_bar_volatile----------------------------
2597 // Memory barrier to avoid floating things around
2598 // The membar serves as a pinch point between both control and memory(alias_idx).
2599 // If you want to make a pinch point on all memory slices, do not use this
2600 // function (even with AliasIdxBot); use insert_mem_bar() instead.
2601 Node* GraphKit::insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent) {
2602   // When Parse::do_put_xxx updates a volatile field, it appends a series
2603   // of MemBarVolatile nodes, one for *each* volatile field alias category.
2604   // The first membar is on the same memory slice as the field store opcode.
2605   // This forces the membar to follow the store.  (Bug 6500685 broke this.)
2606   // All the other membars (for other volatile slices, including AliasIdxBot,
2607   // which stands for all unknown volatile slices) are control-dependent
2608   // on the first membar.  This prevents later volatile loads or stores
2609   // from sliding up past the just-emitted store.
2610 
2611   MemBarNode* mb = MemBarNode::make(C, opcode, alias_idx, precedent);
2612   mb->set_req(TypeFunc::Control,control());
2613   if (alias_idx == Compile::AliasIdxBot) {
2614     mb->set_req(TypeFunc::Memory, merged_memory()->base_memory());
2615   } else {
2616     assert(!(opcode == Op_Initialize && alias_idx != Compile::AliasIdxRaw), "fix caller");
2617     mb->set_req(TypeFunc::Memory, memory(alias_idx));
2618   }
2619   Node* membar = _gvn.transform(mb);
2620   set_control(_gvn.transform(new (C, 1) ProjNode(membar, TypeFunc::Control)));
2621   if (alias_idx == Compile::AliasIdxBot) {
2622     merged_memory()->set_base_memory(_gvn.transform(new (C, 1) ProjNode(membar, TypeFunc::Memory)));
2623   } else {
2624     set_memory(_gvn.transform(new (C, 1) ProjNode(membar, TypeFunc::Memory)),alias_idx);
2625   }
2626   return membar;
2627 }
2628 
2629 //------------------------------shared_lock------------------------------------
2630 // Emit locking code.
2631 FastLockNode* GraphKit::shared_lock(Node* obj) {
2632   // bci is either a monitorenter bc or InvocationEntryBci
2633   // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
2634   assert(SynchronizationEntryBCI == InvocationEntryBci, "");
2635 
2636   if( !GenerateSynchronizationCode )
2637     return NULL;                // Not locking things?
2638   if (stopped())                // Dead monitor?
2639     return NULL;
2640 
2641   assert(dead_locals_are_killed(), "should kill locals before sync. point");
2642 
2643   // Box the stack location
2644   Node* box = _gvn.transform(new (C, 1) BoxLockNode(next_monitor()));
2645   Node* mem = reset_memory();
2646 
2647   FastLockNode * flock = _gvn.transform(new (C, 3) FastLockNode(0, obj, box) )->as_FastLock();
2648   if (PrintPreciseBiasedLockingStatistics) {
2649     // Create the counters for this fast lock.
2650     flock->create_lock_counter(sync_jvms()); // sync_jvms used to get current bci
2651   }
2652   // Add monitor to debug info for the slow path.  If we block inside the
2653   // slow path and de-opt, we need the monitor hanging around
2654   map()->push_monitor( flock );
2655 
2656   const TypeFunc *tf = LockNode::lock_type();
2657   LockNode *lock = new (C, tf->domain()->cnt()) LockNode(C, tf);
2658 
2659   lock->init_req( TypeFunc::Control, control() );
2660   lock->init_req( TypeFunc::Memory , mem );
2661   lock->init_req( TypeFunc::I_O    , top() )     ;   // does no i/o
2662   lock->init_req( TypeFunc::FramePtr, frameptr() );
2663   lock->init_req( TypeFunc::ReturnAdr, top() );
2664 
2665   lock->init_req(TypeFunc::Parms + 0, obj);
2666   lock->init_req(TypeFunc::Parms + 1, box);
2667   lock->init_req(TypeFunc::Parms + 2, flock);
2668   add_safepoint_edges(lock);
2669 
2670   lock = _gvn.transform( lock )->as_Lock();
2671 
2672   // lock has no side-effects, sets few values
2673   set_predefined_output_for_runtime_call(lock, mem, TypeRawPtr::BOTTOM);
2674 
2675   insert_mem_bar(Op_MemBarAcquire);
2676 
2677   // Add this to the worklist so that the lock can be eliminated
2678   record_for_igvn(lock);
2679 
2680 #ifndef PRODUCT
2681   if (PrintLockStatistics) {
2682     // Update the counter for this lock.  Don't bother using an atomic
2683     // operation since we don't require absolute accuracy.
2684     lock->create_lock_counter(map()->jvms());
2685     int adr_type = Compile::AliasIdxRaw;
2686     Node* counter_addr = makecon(TypeRawPtr::make(lock->counter()->addr()));
2687     Node* cnt  = make_load(NULL, counter_addr, TypeInt::INT, T_INT, adr_type);
2688     Node* incr = _gvn.transform(new (C, 3) AddINode(cnt, _gvn.intcon(1)));
2689     store_to_memory(control(), counter_addr, incr, T_INT, adr_type);
2690   }
2691 #endif
2692 
2693   return flock;
2694 }
2695 
2696 
2697 //------------------------------shared_unlock----------------------------------
2698 // Emit unlocking code.
2699 void GraphKit::shared_unlock(Node* box, Node* obj) {
2700   // bci is either a monitorenter bc or InvocationEntryBci
2701   // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
2702   assert(SynchronizationEntryBCI == InvocationEntryBci, "");
2703 
2704   if( !GenerateSynchronizationCode )
2705     return;
2706   if (stopped()) {               // Dead monitor?
2707     map()->pop_monitor();        // Kill monitor from debug info
2708     return;
2709   }
2710 
2711   // Memory barrier to avoid floating things down past the locked region
2712   insert_mem_bar(Op_MemBarRelease);
2713 
2714   const TypeFunc *tf = OptoRuntime::complete_monitor_exit_Type();
2715   UnlockNode *unlock = new (C, tf->domain()->cnt()) UnlockNode(C, tf);
2716   uint raw_idx = Compile::AliasIdxRaw;
2717   unlock->init_req( TypeFunc::Control, control() );
2718   unlock->init_req( TypeFunc::Memory , memory(raw_idx) );
2719   unlock->init_req( TypeFunc::I_O    , top() )     ;   // does no i/o
2720   unlock->init_req( TypeFunc::FramePtr, frameptr() );
2721   unlock->init_req( TypeFunc::ReturnAdr, top() );
2722 
2723   unlock->init_req(TypeFunc::Parms + 0, obj);
2724   unlock->init_req(TypeFunc::Parms + 1, box);
2725   unlock = _gvn.transform(unlock)->as_Unlock();
2726 
2727   Node* mem = reset_memory();
2728 
2729   // unlock has no side-effects, sets few values
2730   set_predefined_output_for_runtime_call(unlock, mem, TypeRawPtr::BOTTOM);
2731 
2732   // Kill monitor from debug info
2733   map()->pop_monitor( );
2734 }
2735 
2736 //-------------------------------get_layout_helper-----------------------------
2737 // If the given klass is a constant or known to be an array,
2738 // fetch the constant layout helper value into constant_value
2739 // and return (Node*)NULL.  Otherwise, load the non-constant
2740 // layout helper value, and return the node which represents it.
2741 // This two-faced routine is useful because allocation sites
2742 // almost always feature constant types.
2743 Node* GraphKit::get_layout_helper(Node* klass_node, jint& constant_value) {
2744   const TypeKlassPtr* inst_klass = _gvn.type(klass_node)->isa_klassptr();
2745   if (!StressReflectiveCode && inst_klass != NULL) {
2746     ciKlass* klass = inst_klass->klass();
2747     bool    xklass = inst_klass->klass_is_exact();
2748     if (xklass || klass->is_array_klass()) {
2749       jint lhelper = klass->layout_helper();
2750       if (lhelper != Klass::_lh_neutral_value) {
2751         constant_value = lhelper;
2752         return (Node*) NULL;
2753       }
2754     }
2755   }
2756   constant_value = Klass::_lh_neutral_value;  // put in a known value
2757   Node* lhp = basic_plus_adr(klass_node, klass_node, Klass::layout_helper_offset_in_bytes() + sizeof(oopDesc));
2758   return make_load(NULL, lhp, TypeInt::INT, T_INT);
2759 }
2760 
2761 // We just put in an allocate/initialize with a big raw-memory effect.
2762 // Hook selected additional alias categories on the initialization.
2763 static void hook_memory_on_init(GraphKit& kit, int alias_idx,
2764                                 MergeMemNode* init_in_merge,
2765                                 Node* init_out_raw) {
2766   DEBUG_ONLY(Node* init_in_raw = init_in_merge->base_memory());
2767   assert(init_in_merge->memory_at(alias_idx) == init_in_raw, "");
2768 
2769   Node* prevmem = kit.memory(alias_idx);
2770   init_in_merge->set_memory_at(alias_idx, prevmem);
2771   kit.set_memory(init_out_raw, alias_idx);
2772 }
2773 
2774 //---------------------------set_output_for_allocation-------------------------
2775 Node* GraphKit::set_output_for_allocation(AllocateNode* alloc,
2776                                           const TypeOopPtr* oop_type,
2777                                           bool raw_mem_only) {
2778   int rawidx = Compile::AliasIdxRaw;
2779   alloc->set_req( TypeFunc::FramePtr, frameptr() );
2780   add_safepoint_edges(alloc);
2781   Node* allocx = _gvn.transform(alloc);
2782   set_control( _gvn.transform(new (C, 1) ProjNode(allocx, TypeFunc::Control) ) );
2783   // create memory projection for i_o
2784   set_memory ( _gvn.transform( new (C, 1) ProjNode(allocx, TypeFunc::Memory, true) ), rawidx );
2785   make_slow_call_ex(allocx, env()->OutOfMemoryError_klass(), true);
2786 
2787   // create a memory projection as for the normal control path
2788   Node* malloc = _gvn.transform(new (C, 1) ProjNode(allocx, TypeFunc::Memory));
2789   set_memory(malloc, rawidx);
2790 
2791   // a normal slow-call doesn't change i_o, but an allocation does
2792   // we create a separate i_o projection for the normal control path
2793   set_i_o(_gvn.transform( new (C, 1) ProjNode(allocx, TypeFunc::I_O, false) ) );
2794   Node* rawoop = _gvn.transform( new (C, 1) ProjNode(allocx, TypeFunc::Parms) );
2795 
2796   // put in an initialization barrier
2797   InitializeNode* init = insert_mem_bar_volatile(Op_Initialize, rawidx,
2798                                                  rawoop)->as_Initialize();
2799   assert(alloc->initialization() == init,  "2-way macro link must work");
2800   assert(init ->allocation()     == alloc, "2-way macro link must work");
2801   if (ReduceFieldZeroing && !raw_mem_only) {
2802     // Extract memory strands which may participate in the new object's
2803     // initialization, and source them from the new InitializeNode.
2804     // This will allow us to observe initializations when they occur,
2805     // and link them properly (as a group) to the InitializeNode.
2806     assert(init->in(InitializeNode::Memory) == malloc, "");
2807     MergeMemNode* minit_in = MergeMemNode::make(C, malloc);
2808     init->set_req(InitializeNode::Memory, minit_in);
2809     record_for_igvn(minit_in); // fold it up later, if possible
2810     Node* minit_out = memory(rawidx);
2811     assert(minit_out->is_Proj() && minit_out->in(0) == init, "");
2812     if (oop_type->isa_aryptr()) {
2813       const TypePtr* telemref = oop_type->add_offset(Type::OffsetBot);
2814       int            elemidx  = C->get_alias_index(telemref);
2815       hook_memory_on_init(*this, elemidx, minit_in, minit_out);
2816     } else if (oop_type->isa_instptr()) {
2817       ciInstanceKlass* ik = oop_type->klass()->as_instance_klass();
2818       for (int i = 0, len = ik->nof_nonstatic_fields(); i < len; i++) {
2819         ciField* field = ik->nonstatic_field_at(i);
2820         if (field->offset() >= TrackedInitializationLimit * HeapWordSize)
2821           continue;  // do not bother to track really large numbers of fields
2822         // Find (or create) the alias category for this field:
2823         int fieldidx = C->alias_type(field)->index();
2824         hook_memory_on_init(*this, fieldidx, minit_in, minit_out);
2825       }
2826     }
2827   }
2828 
2829   // Cast raw oop to the real thing...
2830   Node* javaoop = new (C, 2) CheckCastPPNode(control(), rawoop, oop_type);
2831   javaoop = _gvn.transform(javaoop);
2832   C->set_recent_alloc(control(), javaoop);
2833   assert(just_allocated_object(control()) == javaoop, "just allocated");
2834 
2835 #ifdef ASSERT
2836   { // Verify that the AllocateNode::Ideal_foo recognizers work:
2837     Node* kn = alloc->in(AllocateNode::KlassNode);
2838     Node* ln = alloc->in(AllocateNode::ALength);
2839     assert(AllocateNode::Ideal_klass(rawoop, &_gvn) == kn,
2840            "Ideal_klass works");
2841     assert(AllocateNode::Ideal_klass(javaoop, &_gvn) == kn,
2842            "Ideal_klass works");
2843     if (alloc->is_AllocateArray()) {
2844       assert(AllocateArrayNode::Ideal_length(rawoop, &_gvn) == ln,
2845              "Ideal_length works");
2846       assert(AllocateArrayNode::Ideal_length(javaoop, &_gvn) == ln,
2847              "Ideal_length works");
2848     } else {
2849       assert(ln->is_top(), "no length, please");
2850     }
2851   }
2852 #endif //ASSERT
2853 
2854   return javaoop;
2855 }
2856 
2857 //---------------------------new_instance--------------------------------------
2858 // This routine takes a klass_node which may be constant (for a static type)
2859 // or may be non-constant (for reflective code).  It will work equally well
2860 // for either, and the graph will fold nicely if the optimizer later reduces
2861 // the type to a constant.
2862 // The optional arguments are for specialized use by intrinsics:
2863 //  - If 'extra_slow_test' if not null is an extra condition for the slow-path.
2864 //  - If 'raw_mem_only', do not cast the result to an oop.
2865 //  - If 'return_size_val', report the the total object size to the caller.
2866 Node* GraphKit::new_instance(Node* klass_node,
2867                              Node* extra_slow_test,
2868                              bool raw_mem_only, // affect only raw memory
2869                              Node* *return_size_val) {
2870   // Compute size in doublewords
2871   // The size is always an integral number of doublewords, represented
2872   // as a positive bytewise size stored in the klass's layout_helper.
2873   // The layout_helper also encodes (in a low bit) the need for a slow path.
2874   jint  layout_con = Klass::_lh_neutral_value;
2875   Node* layout_val = get_layout_helper(klass_node, layout_con);
2876   int   layout_is_con = (layout_val == NULL);
2877 
2878   if (extra_slow_test == NULL)  extra_slow_test = intcon(0);
2879   // Generate the initial go-slow test.  It's either ALWAYS (return a
2880   // Node for 1) or NEVER (return a NULL) or perhaps (in the reflective
2881   // case) a computed value derived from the layout_helper.
2882   Node* initial_slow_test = NULL;
2883   if (layout_is_con) {
2884     assert(!StressReflectiveCode, "stress mode does not use these paths");
2885     bool must_go_slow = Klass::layout_helper_needs_slow_path(layout_con);
2886     initial_slow_test = must_go_slow? intcon(1): extra_slow_test;
2887 
2888   } else {   // reflective case
2889     // This reflective path is used by Unsafe.allocateInstance.
2890     // (It may be stress-tested by specifying StressReflectiveCode.)
2891     // Basically, we want to get into the VM is there's an illegal argument.
2892     Node* bit = intcon(Klass::_lh_instance_slow_path_bit);
2893     initial_slow_test = _gvn.transform( new (C, 3) AndINode(layout_val, bit) );
2894     if (extra_slow_test != intcon(0)) {
2895       initial_slow_test = _gvn.transform( new (C, 3) OrINode(initial_slow_test, extra_slow_test) );
2896     }
2897     // (Macro-expander will further convert this to a Bool, if necessary.)
2898   }
2899 
2900   // Find the size in bytes.  This is easy; it's the layout_helper.
2901   // The size value must be valid even if the slow path is taken.
2902   Node* size = NULL;
2903   if (layout_is_con) {
2904     size = MakeConX(Klass::layout_helper_size_in_bytes(layout_con));
2905   } else {   // reflective case
2906     // This reflective path is used by clone and Unsafe.allocateInstance.
2907     size = ConvI2X(layout_val);
2908 
2909     // Clear the low bits to extract layout_helper_size_in_bytes:
2910     assert((int)Klass::_lh_instance_slow_path_bit < BytesPerLong, "clear bit");
2911     Node* mask = MakeConX(~ (intptr_t)right_n_bits(LogBytesPerLong));
2912     size = _gvn.transform( new (C, 3) AndXNode(size, mask) );
2913   }
2914   if (return_size_val != NULL) {
2915     (*return_size_val) = size;
2916   }
2917 
2918   // This is a precise notnull oop of the klass.
2919   // (Actually, it need not be precise if this is a reflective allocation.)
2920   // It's what we cast the result to.
2921   const TypeKlassPtr* tklass = _gvn.type(klass_node)->isa_klassptr();
2922   if (!tklass)  tklass = TypeKlassPtr::OBJECT;
2923   const TypeOopPtr* oop_type = tklass->as_instance_type();
2924 
2925   // Now generate allocation code
2926 
2927   // With escape analysis, the entire memory state is needed to be able to
2928   // eliminate the allocation.  If the allocations cannot be eliminated, this
2929   // will be optimized to the raw slice when the allocation is expanded.
2930   Node *mem;
2931   if (C->do_escape_analysis()) {
2932     mem = reset_memory();
2933     set_all_memory(mem);
2934   } else {
2935     mem = memory(Compile::AliasIdxRaw);
2936   }
2937 
2938   AllocateNode* alloc
2939     = new (C, AllocateNode::ParmLimit)
2940         AllocateNode(C, AllocateNode::alloc_type(),
2941                      control(), mem, i_o(),
2942                      size, klass_node,
2943                      initial_slow_test);
2944 
2945   return set_output_for_allocation(alloc, oop_type, raw_mem_only);
2946 }
2947 
2948 //-------------------------------new_array-------------------------------------
2949 // helper for both newarray and anewarray
2950 // The 'length' parameter is (obviously) the length of the array.
2951 // See comments on new_instance for the meaning of the other arguments.
2952 Node* GraphKit::new_array(Node* klass_node,     // array klass (maybe variable)
2953                           Node* length,         // number of array elements
2954                           bool raw_mem_only,    // affect only raw memory
2955                           Node* *return_size_val) {
2956   jint  layout_con = Klass::_lh_neutral_value;
2957   Node* layout_val = get_layout_helper(klass_node, layout_con);
2958   int   layout_is_con = (layout_val == NULL);
2959 
2960   if (!layout_is_con && !StressReflectiveCode &&
2961       !too_many_traps(Deoptimization::Reason_class_check)) {
2962     // This is a reflective array creation site.
2963     // Optimistically assume that it is a subtype of Object[],
2964     // so that we can fold up all the address arithmetic.
2965     layout_con = Klass::array_layout_helper(T_OBJECT);
2966     Node* cmp_lh = _gvn.transform( new(C, 3) CmpINode(layout_val, intcon(layout_con)) );
2967     Node* bol_lh = _gvn.transform( new(C, 2) BoolNode(cmp_lh, BoolTest::eq) );
2968     { BuildCutout unless(this, bol_lh, PROB_MAX);
2969       uncommon_trap(Deoptimization::Reason_class_check,
2970                     Deoptimization::Action_maybe_recompile);
2971     }
2972     layout_val = NULL;
2973     layout_is_con = true;
2974   }
2975 
2976   // Generate the initial go-slow test.  Make sure we do not overflow
2977   // if length is huge (near 2Gig) or negative!  We do not need
2978   // exact double-words here, just a close approximation of needed
2979   // double-words.  We can't add any offset or rounding bits, lest we
2980   // take a size -1 of bytes and make it positive.  Use an unsigned
2981   // compare, so negative sizes look hugely positive.
2982   int fast_size_limit = FastAllocateSizeLimit;
2983   if (layout_is_con) {
2984     assert(!StressReflectiveCode, "stress mode does not use these paths");
2985     // Increase the size limit if we have exact knowledge of array type.
2986     int log2_esize = Klass::layout_helper_log2_element_size(layout_con);
2987     fast_size_limit <<= (LogBytesPerLong - log2_esize);
2988   }
2989 
2990   Node* initial_slow_cmp  = _gvn.transform( new (C, 3) CmpUNode( length, intcon( fast_size_limit ) ) );
2991   Node* initial_slow_test = _gvn.transform( new (C, 2) BoolNode( initial_slow_cmp, BoolTest::gt ) );
2992   if (initial_slow_test->is_Bool()) {
2993     // Hide it behind a CMoveI, or else PhaseIdealLoop::split_up will get sick.
2994     initial_slow_test = initial_slow_test->as_Bool()->as_int_value(&_gvn);
2995   }
2996 
2997   // --- Size Computation ---
2998   // array_size = round_to_heap(array_header + (length << elem_shift));
2999   // where round_to_heap(x) == round_to(x, MinObjAlignmentInBytes)
3000   // and round_to(x, y) == ((x + y-1) & ~(y-1))
3001   // The rounding mask is strength-reduced, if possible.
3002   int round_mask = MinObjAlignmentInBytes - 1;
3003   Node* header_size = NULL;
3004   int   header_size_min  = arrayOopDesc::base_offset_in_bytes(T_BYTE);
3005   // (T_BYTE has the weakest alignment and size restrictions...)
3006   if (layout_is_con) {
3007     int       hsize  = Klass::layout_helper_header_size(layout_con);
3008     int       eshift = Klass::layout_helper_log2_element_size(layout_con);
3009     BasicType etype  = Klass::layout_helper_element_type(layout_con);
3010     if ((round_mask & ~right_n_bits(eshift)) == 0)
3011       round_mask = 0;  // strength-reduce it if it goes away completely
3012     assert((hsize & right_n_bits(eshift)) == 0, "hsize is pre-rounded");
3013     assert(header_size_min <= hsize, "generic minimum is smallest");
3014     header_size_min = hsize;
3015     header_size = intcon(hsize + round_mask);
3016   } else {
3017     Node* hss   = intcon(Klass::_lh_header_size_shift);
3018     Node* hsm   = intcon(Klass::_lh_header_size_mask);
3019     Node* hsize = _gvn.transform( new(C, 3) URShiftINode(layout_val, hss) );
3020     hsize       = _gvn.transform( new(C, 3) AndINode(hsize, hsm) );
3021     Node* mask  = intcon(round_mask);
3022     header_size = _gvn.transform( new(C, 3) AddINode(hsize, mask) );
3023   }
3024 
3025   Node* elem_shift = NULL;
3026   if (layout_is_con) {
3027     int eshift = Klass::layout_helper_log2_element_size(layout_con);
3028     if (eshift != 0)
3029       elem_shift = intcon(eshift);
3030   } else {
3031     // There is no need to mask or shift this value.
3032     // The semantics of LShiftINode include an implicit mask to 0x1F.
3033     assert(Klass::_lh_log2_element_size_shift == 0, "use shift in place");
3034     elem_shift = layout_val;
3035   }
3036 
3037   // Transition to native address size for all offset calculations:
3038   Node* lengthx = ConvI2X(length);
3039   Node* headerx = ConvI2X(header_size);
3040 #ifdef _LP64
3041   { const TypeLong* tllen = _gvn.find_long_type(lengthx);
3042     if (tllen != NULL && tllen->_lo < 0) {
3043       // Add a manual constraint to a positive range.  Cf. array_element_address.
3044       jlong size_max = arrayOopDesc::max_array_length(T_BYTE);
3045       if (size_max > tllen->_hi)  size_max = tllen->_hi;
3046       const TypeLong* tlcon = TypeLong::make(CONST64(0), size_max, Type::WidenMin);
3047       lengthx = _gvn.transform( new (C, 2) ConvI2LNode(length, tlcon));
3048     }
3049   }
3050 #endif
3051 
3052   // Combine header size (plus rounding) and body size.  Then round down.
3053   // This computation cannot overflow, because it is used only in two
3054   // places, one where the length is sharply limited, and the other
3055   // after a successful allocation.
3056   Node* abody = lengthx;
3057   if (elem_shift != NULL)
3058     abody     = _gvn.transform( new(C, 3) LShiftXNode(lengthx, elem_shift) );
3059   Node* size  = _gvn.transform( new(C, 3) AddXNode(headerx, abody) );
3060   if (round_mask != 0) {
3061     Node* mask = MakeConX(~round_mask);
3062     size       = _gvn.transform( new(C, 3) AndXNode(size, mask) );
3063   }
3064   // else if round_mask == 0, the size computation is self-rounding
3065 
3066   if (return_size_val != NULL) {
3067     // This is the size
3068     (*return_size_val) = size;
3069   }
3070 
3071   // Now generate allocation code
3072 
3073   // With escape analysis, the entire memory state is needed to be able to
3074   // eliminate the allocation.  If the allocations cannot be eliminated, this
3075   // will be optimized to the raw slice when the allocation is expanded.
3076   Node *mem;
3077   if (C->do_escape_analysis()) {
3078     mem = reset_memory();
3079     set_all_memory(mem);
3080   } else {
3081     mem = memory(Compile::AliasIdxRaw);
3082   }
3083 
3084   // Create the AllocateArrayNode and its result projections
3085   AllocateArrayNode* alloc
3086     = new (C, AllocateArrayNode::ParmLimit)
3087         AllocateArrayNode(C, AllocateArrayNode::alloc_type(),
3088                           control(), mem, i_o(),
3089                           size, klass_node,
3090                           initial_slow_test,
3091                           length);
3092 
3093   // Cast to correct type.  Note that the klass_node may be constant or not,
3094   // and in the latter case the actual array type will be inexact also.
3095   // (This happens via a non-constant argument to inline_native_newArray.)
3096   // In any case, the value of klass_node provides the desired array type.
3097   const TypeInt* length_type = _gvn.find_int_type(length);
3098   const TypeInt* narrow_length_type = NULL;
3099   const TypeOopPtr* ary_type = _gvn.type(klass_node)->is_klassptr()->as_instance_type();
3100   if (ary_type->isa_aryptr() && length_type != NULL) {
3101     // Try to get a better type than POS for the size
3102     ary_type = ary_type->is_aryptr()->cast_to_size(length_type);
3103     narrow_length_type = ary_type->is_aryptr()->size();
3104     if (narrow_length_type == length_type)
3105       narrow_length_type = NULL;
3106   }
3107 
3108   Node* javaoop = set_output_for_allocation(alloc, ary_type, raw_mem_only);
3109 
3110   // Cast length on remaining path to be positive:
3111   if (narrow_length_type != NULL) {
3112     Node* ccast = new (C, 2) CastIINode(length, narrow_length_type);
3113     ccast->set_req(0, control());
3114     _gvn.set_type_bottom(ccast);
3115     record_for_igvn(ccast);
3116     if (map()->find_edge(length) >= 0) {
3117       replace_in_map(length, ccast);
3118     }
3119   }
3120 
3121   return javaoop;
3122 }
3123 
3124 // The following "Ideal_foo" functions are placed here because they recognize
3125 // the graph shapes created by the functions immediately above.
3126 
3127 //---------------------------Ideal_allocation----------------------------------
3128 // Given an oop pointer or raw pointer, see if it feeds from an AllocateNode.
3129 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr, PhaseTransform* phase) {
3130   if (ptr == NULL) {     // reduce dumb test in callers
3131     return NULL;
3132   }
3133   if (ptr->is_CheckCastPP()) {  // strip a raw-to-oop cast
3134     ptr = ptr->in(1);
3135     if (ptr == NULL)  return NULL;
3136   }
3137   if (ptr->is_Proj()) {
3138     Node* allo = ptr->in(0);
3139     if (allo != NULL && allo->is_Allocate()) {
3140       return allo->as_Allocate();
3141     }
3142   }
3143   // Report failure to match.
3144   return NULL;
3145 }
3146 
3147 // Fancy version which also strips off an offset (and reports it to caller).
3148 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr, PhaseTransform* phase,
3149                                              intptr_t& offset) {
3150   Node* base = AddPNode::Ideal_base_and_offset(ptr, phase, offset);
3151   if (base == NULL)  return NULL;
3152   return Ideal_allocation(base, phase);
3153 }
3154 
3155 // Trace Initialize <- Proj[Parm] <- Allocate
3156 AllocateNode* InitializeNode::allocation() {
3157   Node* rawoop = in(InitializeNode::RawAddress);
3158   if (rawoop->is_Proj()) {
3159     Node* alloc = rawoop->in(0);
3160     if (alloc->is_Allocate()) {
3161       return alloc->as_Allocate();
3162     }
3163   }
3164   return NULL;
3165 }
3166 
3167 // Trace Allocate -> Proj[Parm] -> Initialize
3168 InitializeNode* AllocateNode::initialization() {
3169   ProjNode* rawoop = proj_out(AllocateNode::RawAddress);
3170   if (rawoop == NULL)  return NULL;
3171   for (DUIterator_Fast imax, i = rawoop->fast_outs(imax); i < imax; i++) {
3172     Node* init = rawoop->fast_out(i);
3173     if (init->is_Initialize()) {
3174       assert(init->as_Initialize()->allocation() == this, "2-way link");
3175       return init->as_Initialize();
3176     }
3177   }
3178   return NULL;
3179 }