1 /*
   2  * Copyright (c) 2001, 2025, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "asm/register.hpp"
  26 #include "ci/ciFlatArrayKlass.hpp"
  27 #include "ci/ciInlineKlass.hpp"
  28 #include "ci/ciObjArray.hpp"
  29 #include "ci/ciUtilities.hpp"
  30 #include "classfile/javaClasses.hpp"
  31 #include "compiler/compileLog.hpp"
  32 #include "gc/shared/barrierSet.hpp"
  33 #include "gc/shared/c2/barrierSetC2.hpp"
  34 #include "interpreter/interpreter.hpp"
  35 #include "memory/resourceArea.hpp"
  36 #include "oops/flatArrayKlass.hpp"
  37 #include "opto/addnode.hpp"
  38 #include "opto/castnode.hpp"
  39 #include "opto/convertnode.hpp"
  40 #include "opto/graphKit.hpp"
  41 #include "opto/idealKit.hpp"
  42 #include "opto/inlinetypenode.hpp"
  43 #include "opto/intrinsicnode.hpp"
  44 #include "opto/locknode.hpp"
  45 #include "opto/machnode.hpp"
  46 #include "opto/narrowptrnode.hpp"
  47 #include "opto/opaquenode.hpp"
  48 #include "opto/parse.hpp"
  49 #include "opto/rootnode.hpp"
  50 #include "opto/runtime.hpp"
  51 #include "opto/subtypenode.hpp"
  52 #include "runtime/deoptimization.hpp"
  53 #include "runtime/sharedRuntime.hpp"
  54 #include "runtime/stubRoutines.hpp"
  55 #include "utilities/bitMap.inline.hpp"
  56 #include "utilities/growableArray.hpp"
  57 #include "utilities/powerOfTwo.hpp"
  58 
  59 //----------------------------GraphKit-----------------------------------------
  60 // Main utility constructor.
  61 GraphKit::GraphKit(JVMState* jvms, PhaseGVN* gvn)
  62   : Phase(Phase::Parser),
  63     _env(C->env()),
  64     _gvn((gvn != nullptr) ? *gvn : *C->initial_gvn()),
  65     _barrier_set(BarrierSet::barrier_set()->barrier_set_c2())
  66 {
  67   assert(gvn == nullptr || !gvn->is_IterGVN() || gvn->is_IterGVN()->delay_transform(), "delay transform should be enabled");
  68   _exceptions = jvms->map()->next_exception();
  69   if (_exceptions != nullptr)  jvms->map()->set_next_exception(nullptr);
  70   set_jvms(jvms);
  71 #ifdef ASSERT
  72   if (_gvn.is_IterGVN() != nullptr) {
  73     assert(_gvn.is_IterGVN()->delay_transform(), "Transformation must be delayed if IterGVN is used");
  74     // Save the initial size of _for_igvn worklist for verification (see ~GraphKit)
  75     _worklist_size = _gvn.C->igvn_worklist()->size();
  76   }
  77 #endif
  78 }
  79 
  80 // Private constructor for parser.
  81 GraphKit::GraphKit()
  82   : Phase(Phase::Parser),
  83     _env(C->env()),
  84     _gvn(*C->initial_gvn()),
  85     _barrier_set(BarrierSet::barrier_set()->barrier_set_c2())
  86 {
  87   _exceptions = nullptr;
  88   set_map(nullptr);
  89   DEBUG_ONLY(_sp = -99);
  90   DEBUG_ONLY(set_bci(-99));
  91 }
  92 
  93 
  94 
  95 //---------------------------clean_stack---------------------------------------
  96 // Clear away rubbish from the stack area of the JVM state.
  97 // This destroys any arguments that may be waiting on the stack.
  98 void GraphKit::clean_stack(int from_sp) {
  99   SafePointNode* map      = this->map();
 100   JVMState*      jvms     = this->jvms();
 101   int            stk_size = jvms->stk_size();
 102   int            stkoff   = jvms->stkoff();
 103   Node*          top      = this->top();
 104   for (int i = from_sp; i < stk_size; i++) {
 105     if (map->in(stkoff + i) != top) {
 106       map->set_req(stkoff + i, top);
 107     }
 108   }
 109 }
 110 
 111 
 112 //--------------------------------sync_jvms-----------------------------------
 113 // Make sure our current jvms agrees with our parse state.
 114 JVMState* GraphKit::sync_jvms() const {
 115   JVMState* jvms = this->jvms();
 116   jvms->set_bci(bci());       // Record the new bci in the JVMState
 117   jvms->set_sp(sp());         // Record the new sp in the JVMState
 118   assert(jvms_in_sync(), "jvms is now in sync");
 119   return jvms;
 120 }
 121 
 122 //--------------------------------sync_jvms_for_reexecute---------------------
 123 // Make sure our current jvms agrees with our parse state.  This version
 124 // uses the reexecute_sp for reexecuting bytecodes.
 125 JVMState* GraphKit::sync_jvms_for_reexecute() {
 126   JVMState* jvms = this->jvms();
 127   jvms->set_bci(bci());          // Record the new bci in the JVMState
 128   jvms->set_sp(reexecute_sp());  // Record the new sp in the JVMState
 129   return jvms;
 130 }
 131 
 132 #ifdef ASSERT
 133 bool GraphKit::jvms_in_sync() const {
 134   Parse* parse = is_Parse();
 135   if (parse == nullptr) {
 136     if (bci() !=      jvms()->bci())          return false;
 137     if (sp()  != (int)jvms()->sp())           return false;
 138     return true;
 139   }
 140   if (jvms()->method() != parse->method())    return false;
 141   if (jvms()->bci()    != parse->bci())       return false;
 142   int jvms_sp = jvms()->sp();
 143   if (jvms_sp          != parse->sp())        return false;
 144   int jvms_depth = jvms()->depth();
 145   if (jvms_depth       != parse->depth())     return false;
 146   return true;
 147 }
 148 
 149 // Local helper checks for special internal merge points
 150 // used to accumulate and merge exception states.
 151 // They are marked by the region's in(0) edge being the map itself.
 152 // Such merge points must never "escape" into the parser at large,
 153 // until they have been handed to gvn.transform.
 154 static bool is_hidden_merge(Node* reg) {
 155   if (reg == nullptr)  return false;
 156   if (reg->is_Phi()) {
 157     reg = reg->in(0);
 158     if (reg == nullptr)  return false;
 159   }
 160   return reg->is_Region() && reg->in(0) != nullptr && reg->in(0)->is_Root();
 161 }
 162 
 163 void GraphKit::verify_map() const {
 164   if (map() == nullptr)  return;  // null map is OK
 165   assert(map()->req() <= jvms()->endoff(), "no extra garbage on map");
 166   assert(!map()->has_exceptions(),    "call add_exception_states_from 1st");
 167   assert(!is_hidden_merge(control()), "call use_exception_state, not set_map");
 168 }
 169 
 170 void GraphKit::verify_exception_state(SafePointNode* ex_map) {
 171   assert(ex_map->next_exception() == nullptr, "not already part of a chain");
 172   assert(has_saved_ex_oop(ex_map), "every exception state has an ex_oop");
 173 }
 174 #endif
 175 
 176 //---------------------------stop_and_kill_map---------------------------------
 177 // Set _map to null, signalling a stop to further bytecode execution.
 178 // First smash the current map's control to a constant, to mark it dead.
 179 void GraphKit::stop_and_kill_map() {
 180   SafePointNode* dead_map = stop();
 181   if (dead_map != nullptr) {
 182     dead_map->disconnect_inputs(C); // Mark the map as killed.
 183     assert(dead_map->is_killed(), "must be so marked");
 184   }
 185 }
 186 
 187 
 188 //--------------------------------stopped--------------------------------------
 189 // Tell if _map is null, or control is top.
 190 bool GraphKit::stopped() {
 191   if (map() == nullptr)        return true;
 192   else if (control() == top()) return true;
 193   else                         return false;
 194 }
 195 
 196 
 197 //-----------------------------has_exception_handler----------------------------------
 198 // Tell if this method or any caller method has exception handlers.
 199 bool GraphKit::has_exception_handler() {
 200   for (JVMState* jvmsp = jvms(); jvmsp != nullptr; jvmsp = jvmsp->caller()) {
 201     if (jvmsp->has_method() && jvmsp->method()->has_exception_handlers()) {
 202       return true;
 203     }
 204   }
 205   return false;
 206 }
 207 
 208 //------------------------------save_ex_oop------------------------------------
 209 // Save an exception without blowing stack contents or other JVM state.
 210 void GraphKit::set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop) {
 211   assert(!has_saved_ex_oop(ex_map), "clear ex-oop before setting again");
 212   ex_map->add_req(ex_oop);
 213   DEBUG_ONLY(verify_exception_state(ex_map));
 214 }
 215 
 216 inline static Node* common_saved_ex_oop(SafePointNode* ex_map, bool clear_it) {
 217   assert(GraphKit::has_saved_ex_oop(ex_map), "ex_oop must be there");
 218   Node* ex_oop = ex_map->in(ex_map->req()-1);
 219   if (clear_it)  ex_map->del_req(ex_map->req()-1);
 220   return ex_oop;
 221 }
 222 
 223 //-----------------------------saved_ex_oop------------------------------------
 224 // Recover a saved exception from its map.
 225 Node* GraphKit::saved_ex_oop(SafePointNode* ex_map) {
 226   return common_saved_ex_oop(ex_map, false);
 227 }
 228 
 229 //--------------------------clear_saved_ex_oop---------------------------------
 230 // Erase a previously saved exception from its map.
 231 Node* GraphKit::clear_saved_ex_oop(SafePointNode* ex_map) {
 232   return common_saved_ex_oop(ex_map, true);
 233 }
 234 
 235 #ifdef ASSERT
 236 //---------------------------has_saved_ex_oop----------------------------------
 237 // Erase a previously saved exception from its map.
 238 bool GraphKit::has_saved_ex_oop(SafePointNode* ex_map) {
 239   return ex_map->req() == ex_map->jvms()->endoff()+1;
 240 }
 241 #endif
 242 
 243 //-------------------------make_exception_state--------------------------------
 244 // Turn the current JVM state into an exception state, appending the ex_oop.
 245 SafePointNode* GraphKit::make_exception_state(Node* ex_oop) {
 246   sync_jvms();
 247   SafePointNode* ex_map = stop();  // do not manipulate this map any more
 248   set_saved_ex_oop(ex_map, ex_oop);
 249   return ex_map;
 250 }
 251 
 252 
 253 //--------------------------add_exception_state--------------------------------
 254 // Add an exception to my list of exceptions.
 255 void GraphKit::add_exception_state(SafePointNode* ex_map) {
 256   if (ex_map == nullptr || ex_map->control() == top()) {
 257     return;
 258   }
 259 #ifdef ASSERT
 260   verify_exception_state(ex_map);
 261   if (has_exceptions()) {
 262     assert(ex_map->jvms()->same_calls_as(_exceptions->jvms()), "all collected exceptions must come from the same place");
 263   }
 264 #endif
 265 
 266   // If there is already an exception of exactly this type, merge with it.
 267   // In particular, null-checks and other low-level exceptions common up here.
 268   Node*       ex_oop  = saved_ex_oop(ex_map);
 269   const Type* ex_type = _gvn.type(ex_oop);
 270   if (ex_oop == top()) {
 271     // No action needed.
 272     return;
 273   }
 274   assert(ex_type->isa_instptr(), "exception must be an instance");
 275   for (SafePointNode* e2 = _exceptions; e2 != nullptr; e2 = e2->next_exception()) {
 276     const Type* ex_type2 = _gvn.type(saved_ex_oop(e2));
 277     // We check sp also because call bytecodes can generate exceptions
 278     // both before and after arguments are popped!
 279     if (ex_type2 == ex_type
 280         && e2->_jvms->sp() == ex_map->_jvms->sp()) {
 281       combine_exception_states(ex_map, e2);
 282       return;
 283     }
 284   }
 285 
 286   // No pre-existing exception of the same type.  Chain it on the list.
 287   push_exception_state(ex_map);
 288 }
 289 
 290 //-----------------------add_exception_states_from-----------------------------
 291 void GraphKit::add_exception_states_from(JVMState* jvms) {
 292   SafePointNode* ex_map = jvms->map()->next_exception();
 293   if (ex_map != nullptr) {
 294     jvms->map()->set_next_exception(nullptr);
 295     for (SafePointNode* next_map; ex_map != nullptr; ex_map = next_map) {
 296       next_map = ex_map->next_exception();
 297       ex_map->set_next_exception(nullptr);
 298       add_exception_state(ex_map);
 299     }
 300   }
 301 }
 302 
 303 //-----------------------transfer_exceptions_into_jvms-------------------------
 304 JVMState* GraphKit::transfer_exceptions_into_jvms() {
 305   if (map() == nullptr) {
 306     // We need a JVMS to carry the exceptions, but the map has gone away.
 307     // Create a scratch JVMS, cloned from any of the exception states...
 308     if (has_exceptions()) {
 309       _map = _exceptions;
 310       _map = clone_map();
 311       _map->set_next_exception(nullptr);
 312       clear_saved_ex_oop(_map);
 313       DEBUG_ONLY(verify_map());
 314     } else {
 315       // ...or created from scratch
 316       JVMState* jvms = new (C) JVMState(_method, nullptr);
 317       jvms->set_bci(_bci);
 318       jvms->set_sp(_sp);
 319       jvms->set_map(new SafePointNode(TypeFunc::Parms, jvms));
 320       set_jvms(jvms);
 321       for (uint i = 0; i < map()->req(); i++)  map()->init_req(i, top());
 322       set_all_memory(top());
 323       while (map()->req() < jvms->endoff())  map()->add_req(top());
 324     }
 325     // (This is a kludge, in case you didn't notice.)
 326     set_control(top());
 327   }
 328   JVMState* jvms = sync_jvms();
 329   assert(!jvms->map()->has_exceptions(), "no exceptions on this map yet");
 330   jvms->map()->set_next_exception(_exceptions);
 331   _exceptions = nullptr;   // done with this set of exceptions
 332   return jvms;
 333 }
 334 
 335 static inline void add_n_reqs(Node* dstphi, Node* srcphi) {
 336   assert(is_hidden_merge(dstphi), "must be a special merge node");
 337   assert(is_hidden_merge(srcphi), "must be a special merge node");
 338   uint limit = srcphi->req();
 339   for (uint i = PhiNode::Input; i < limit; i++) {
 340     dstphi->add_req(srcphi->in(i));
 341   }
 342 }
 343 static inline void add_one_req(Node* dstphi, Node* src) {
 344   assert(is_hidden_merge(dstphi), "must be a special merge node");
 345   assert(!is_hidden_merge(src), "must not be a special merge node");
 346   dstphi->add_req(src);
 347 }
 348 
 349 //-----------------------combine_exception_states------------------------------
 350 // This helper function combines exception states by building phis on a
 351 // specially marked state-merging region.  These regions and phis are
 352 // untransformed, and can build up gradually.  The region is marked by
 353 // having a control input of its exception map, rather than null.  Such
 354 // regions do not appear except in this function, and in use_exception_state.
 355 void GraphKit::combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map) {
 356   if (failing_internal()) {
 357     return;  // dying anyway...
 358   }
 359   JVMState* ex_jvms = ex_map->_jvms;
 360   assert(ex_jvms->same_calls_as(phi_map->_jvms), "consistent call chains");
 361   assert(ex_jvms->stkoff() == phi_map->_jvms->stkoff(), "matching locals");
 362   // TODO 8325632 Re-enable
 363   // assert(ex_jvms->sp() == phi_map->_jvms->sp(), "matching stack sizes");
 364   assert(ex_jvms->monoff() == phi_map->_jvms->monoff(), "matching JVMS");
 365   assert(ex_jvms->scloff() == phi_map->_jvms->scloff(), "matching scalar replaced objects");
 366   assert(ex_map->req() == phi_map->req(), "matching maps");
 367   uint tos = ex_jvms->stkoff() + ex_jvms->sp();
 368   Node*         hidden_merge_mark = root();
 369   Node*         region  = phi_map->control();
 370   MergeMemNode* phi_mem = phi_map->merged_memory();
 371   MergeMemNode* ex_mem  = ex_map->merged_memory();
 372   if (region->in(0) != hidden_merge_mark) {
 373     // The control input is not (yet) a specially-marked region in phi_map.
 374     // Make it so, and build some phis.
 375     region = new RegionNode(2);
 376     _gvn.set_type(region, Type::CONTROL);
 377     region->set_req(0, hidden_merge_mark);  // marks an internal ex-state
 378     region->init_req(1, phi_map->control());
 379     phi_map->set_control(region);
 380     Node* io_phi = PhiNode::make(region, phi_map->i_o(), Type::ABIO);
 381     record_for_igvn(io_phi);
 382     _gvn.set_type(io_phi, Type::ABIO);
 383     phi_map->set_i_o(io_phi);
 384     for (MergeMemStream mms(phi_mem); mms.next_non_empty(); ) {
 385       Node* m = mms.memory();
 386       Node* m_phi = PhiNode::make(region, m, Type::MEMORY, mms.adr_type(C));
 387       record_for_igvn(m_phi);
 388       _gvn.set_type(m_phi, Type::MEMORY);
 389       mms.set_memory(m_phi);
 390     }
 391   }
 392 
 393   // Either or both of phi_map and ex_map might already be converted into phis.
 394   Node* ex_control = ex_map->control();
 395   // if there is special marking on ex_map also, we add multiple edges from src
 396   bool add_multiple = (ex_control->in(0) == hidden_merge_mark);
 397   // how wide was the destination phi_map, originally?
 398   uint orig_width = region->req();
 399 
 400   if (add_multiple) {
 401     add_n_reqs(region, ex_control);
 402     add_n_reqs(phi_map->i_o(), ex_map->i_o());
 403   } else {
 404     // ex_map has no merges, so we just add single edges everywhere
 405     add_one_req(region, ex_control);
 406     add_one_req(phi_map->i_o(), ex_map->i_o());
 407   }
 408   for (MergeMemStream mms(phi_mem, ex_mem); mms.next_non_empty2(); ) {
 409     if (mms.is_empty()) {
 410       // get a copy of the base memory, and patch some inputs into it
 411       const TypePtr* adr_type = mms.adr_type(C);
 412       Node* phi = mms.force_memory()->as_Phi()->slice_memory(adr_type);
 413       assert(phi->as_Phi()->region() == mms.base_memory()->in(0), "");
 414       mms.set_memory(phi);
 415       // Prepare to append interesting stuff onto the newly sliced phi:
 416       while (phi->req() > orig_width)  phi->del_req(phi->req()-1);
 417     }
 418     // Append stuff from ex_map:
 419     if (add_multiple) {
 420       add_n_reqs(mms.memory(), mms.memory2());
 421     } else {
 422       add_one_req(mms.memory(), mms.memory2());
 423     }
 424   }
 425   uint limit = ex_map->req();
 426   for (uint i = TypeFunc::Parms; i < limit; i++) {
 427     // Skip everything in the JVMS after tos.  (The ex_oop follows.)
 428     if (i == tos)  i = ex_jvms->monoff();
 429     Node* src = ex_map->in(i);
 430     Node* dst = phi_map->in(i);
 431     if (src != dst) {
 432       PhiNode* phi;
 433       if (dst->in(0) != region) {
 434         dst = phi = PhiNode::make(region, dst, _gvn.type(dst));
 435         record_for_igvn(phi);
 436         _gvn.set_type(phi, phi->type());
 437         phi_map->set_req(i, dst);
 438         // Prepare to append interesting stuff onto the new phi:
 439         while (dst->req() > orig_width)  dst->del_req(dst->req()-1);
 440       } else {
 441         assert(dst->is_Phi(), "nobody else uses a hidden region");
 442         phi = dst->as_Phi();
 443       }
 444       if (add_multiple && src->in(0) == ex_control) {
 445         // Both are phis.
 446         add_n_reqs(dst, src);
 447       } else {
 448         while (dst->req() < region->req())  add_one_req(dst, src);
 449       }
 450       const Type* srctype = _gvn.type(src);
 451       if (phi->type() != srctype) {
 452         const Type* dsttype = phi->type()->meet_speculative(srctype);
 453         if (phi->type() != dsttype) {
 454           phi->set_type(dsttype);
 455           _gvn.set_type(phi, dsttype);
 456         }
 457       }
 458     }
 459   }
 460   phi_map->merge_replaced_nodes_with(ex_map);
 461 }
 462 
 463 //--------------------------use_exception_state--------------------------------
 464 Node* GraphKit::use_exception_state(SafePointNode* phi_map) {
 465   if (failing_internal()) { stop(); return top(); }
 466   Node* region = phi_map->control();
 467   Node* hidden_merge_mark = root();
 468   assert(phi_map->jvms()->map() == phi_map, "sanity: 1-1 relation");
 469   Node* ex_oop = clear_saved_ex_oop(phi_map);
 470   if (region->in(0) == hidden_merge_mark) {
 471     // Special marking for internal ex-states.  Process the phis now.
 472     region->set_req(0, region);  // now it's an ordinary region
 473     set_jvms(phi_map->jvms());   // ...so now we can use it as a map
 474     // Note: Setting the jvms also sets the bci and sp.
 475     set_control(_gvn.transform(region));
 476     uint tos = jvms()->stkoff() + sp();
 477     for (uint i = 1; i < tos; i++) {
 478       Node* x = phi_map->in(i);
 479       if (x->in(0) == region) {
 480         assert(x->is_Phi(), "expected a special phi");
 481         phi_map->set_req(i, _gvn.transform(x));
 482       }
 483     }
 484     for (MergeMemStream mms(merged_memory()); mms.next_non_empty(); ) {
 485       Node* x = mms.memory();
 486       if (x->in(0) == region) {
 487         assert(x->is_Phi(), "nobody else uses a hidden region");
 488         mms.set_memory(_gvn.transform(x));
 489       }
 490     }
 491     if (ex_oop->in(0) == region) {
 492       assert(ex_oop->is_Phi(), "expected a special phi");
 493       ex_oop = _gvn.transform(ex_oop);
 494     }
 495   } else {
 496     set_jvms(phi_map->jvms());
 497   }
 498 
 499   assert(!is_hidden_merge(phi_map->control()), "hidden ex. states cleared");
 500   assert(!is_hidden_merge(phi_map->i_o()), "hidden ex. states cleared");
 501   return ex_oop;
 502 }
 503 
 504 //---------------------------------java_bc-------------------------------------
 505 Bytecodes::Code GraphKit::java_bc() const {
 506   ciMethod* method = this->method();
 507   int       bci    = this->bci();
 508   if (method != nullptr && bci != InvocationEntryBci)
 509     return method->java_code_at_bci(bci);
 510   else
 511     return Bytecodes::_illegal;
 512 }
 513 
 514 void GraphKit::uncommon_trap_if_should_post_on_exceptions(Deoptimization::DeoptReason reason,
 515                                                           bool must_throw) {
 516     // if the exception capability is set, then we will generate code
 517     // to check the JavaThread.should_post_on_exceptions flag to see
 518     // if we actually need to report exception events (for this
 519     // thread).  If we don't need to report exception events, we will
 520     // take the normal fast path provided by add_exception_events.  If
 521     // exception event reporting is enabled for this thread, we will
 522     // take the uncommon_trap in the BuildCutout below.
 523 
 524     // first must access the should_post_on_exceptions_flag in this thread's JavaThread
 525     Node* jthread = _gvn.transform(new ThreadLocalNode());
 526     Node* adr = basic_plus_adr(top(), jthread, in_bytes(JavaThread::should_post_on_exceptions_flag_offset()));
 527     Node* should_post_flag = make_load(control(), adr, TypeInt::INT, T_INT, MemNode::unordered);
 528 
 529     // Test the should_post_on_exceptions_flag vs. 0
 530     Node* chk = _gvn.transform( new CmpINode(should_post_flag, intcon(0)) );
 531     Node* tst = _gvn.transform( new BoolNode(chk, BoolTest::eq) );
 532 
 533     // Branch to slow_path if should_post_on_exceptions_flag was true
 534     { BuildCutout unless(this, tst, PROB_MAX);
 535       // Do not try anything fancy if we're notifying the VM on every throw.
 536       // Cf. case Bytecodes::_athrow in parse2.cpp.
 537       uncommon_trap(reason, Deoptimization::Action_none,
 538                     (ciKlass*)nullptr, (char*)nullptr, must_throw);
 539     }
 540 
 541 }
 542 
 543 //------------------------------builtin_throw----------------------------------
 544 void GraphKit::builtin_throw(Deoptimization::DeoptReason reason) {
 545   builtin_throw(reason, builtin_throw_exception(reason), /*allow_too_many_traps*/ true);
 546 }
 547 
 548 void GraphKit::builtin_throw(Deoptimization::DeoptReason reason,
 549                              ciInstance* ex_obj,
 550                              bool allow_too_many_traps) {
 551   // If this throw happens frequently, an uncommon trap might cause
 552   // a performance pothole.  If there is a local exception handler,
 553   // and if this particular bytecode appears to be deoptimizing often,
 554   // let us handle the throw inline, with a preconstructed instance.
 555   // Note:   If the deopt count has blown up, the uncommon trap
 556   // runtime is going to flush this nmethod, not matter what.
 557   if (is_builtin_throw_hot(reason)) {
 558     if (method()->can_omit_stack_trace() && ex_obj != nullptr) {
 559       // If the throw is local, we use a pre-existing instance and
 560       // punt on the backtrace.  This would lead to a missing backtrace
 561       // (a repeat of 4292742) if the backtrace object is ever asked
 562       // for its backtrace.
 563       // Fixing this remaining case of 4292742 requires some flavor of
 564       // escape analysis.  Leave that for the future.
 565       if (env()->jvmti_can_post_on_exceptions()) {
 566         // check if we must post exception events, take uncommon trap if so
 567         uncommon_trap_if_should_post_on_exceptions(reason, true /*must_throw*/);
 568         // here if should_post_on_exceptions is false
 569         // continue on with the normal codegen
 570       }
 571 
 572       // Cheat with a preallocated exception object.
 573       if (C->log() != nullptr)
 574         C->log()->elem("hot_throw preallocated='1' reason='%s'",
 575                        Deoptimization::trap_reason_name(reason));
 576       const TypeInstPtr* ex_con  = TypeInstPtr::make(ex_obj);
 577       Node*              ex_node = _gvn.transform(ConNode::make(ex_con));
 578 
 579       // Clear the detail message of the preallocated exception object.
 580       // Weblogic sometimes mutates the detail message of exceptions
 581       // using reflection.
 582       int offset = java_lang_Throwable::get_detailMessage_offset();
 583       const TypePtr* adr_typ = ex_con->add_offset(offset);
 584 
 585       Node *adr = basic_plus_adr(ex_node, ex_node, offset);
 586       const TypeOopPtr* val_type = TypeOopPtr::make_from_klass(env()->String_klass());
 587       Node *store = access_store_at(ex_node, adr, adr_typ, null(), val_type, T_OBJECT, IN_HEAP);
 588 
 589       if (!method()->has_exception_handlers()) {
 590         // We don't need to preserve the stack if there's no handler as the entire frame is going to be popped anyway.
 591         // This prevents issues with exception handling and late inlining.
 592         set_sp(0);
 593         clean_stack(0);
 594       }
 595 
 596       add_exception_state(make_exception_state(ex_node));
 597       return;
 598     } else if (builtin_throw_too_many_traps(reason, ex_obj)) {
 599       // We cannot afford to take too many traps here. Suffer in the interpreter instead.
 600       assert(allow_too_many_traps, "not allowed");
 601       if (C->log() != nullptr) {
 602         C->log()->elem("hot_throw preallocated='0' reason='%s' mcount='%d'",
 603                        Deoptimization::trap_reason_name(reason),
 604                        C->trap_count(reason));
 605       }
 606       uncommon_trap(reason, Deoptimization::Action_none,
 607                     (ciKlass*) nullptr, (char*) nullptr,
 608                     true /*must_throw*/);
 609       return;
 610     }
 611   }
 612 
 613   // %%% Maybe add entry to OptoRuntime which directly throws the exc.?
 614   // It won't be much cheaper than bailing to the interp., since we'll
 615   // have to pass up all the debug-info, and the runtime will have to
 616   // create the stack trace.
 617 
 618   // Usual case:  Bail to interpreter.
 619   // Reserve the right to recompile if we haven't seen anything yet.
 620 
 621   // "must_throw" prunes the JVM state to include only the stack, if there
 622   // are no local exception handlers.  This should cut down on register
 623   // allocation time and code size, by drastically reducing the number
 624   // of in-edges on the call to the uncommon trap.
 625   uncommon_trap(reason, Deoptimization::Action_maybe_recompile,
 626                 (ciKlass*) nullptr, (char*) nullptr,
 627                 true /*must_throw*/);
 628 }
 629 
 630 bool GraphKit::is_builtin_throw_hot(Deoptimization::DeoptReason reason) {
 631   // If this particular condition has not yet happened at this
 632   // bytecode, then use the uncommon trap mechanism, and allow for
 633   // a future recompilation if several traps occur here.
 634   // If the throw is hot, try to use a more complicated inline mechanism
 635   // which keeps execution inside the compiled code.
 636   if (ProfileTraps) {
 637     if (too_many_traps(reason)) {
 638       return true;
 639     }
 640     // (If there is no MDO at all, assume it is early in
 641     // execution, and that any deopts are part of the
 642     // startup transient, and don't need to be remembered.)
 643 
 644     // Also, if there is a local exception handler, treat all throws
 645     // as hot if there has been at least one in this method.
 646     if (C->trap_count(reason) != 0 &&
 647         method()->method_data()->trap_count(reason) != 0 &&
 648         has_exception_handler()) {
 649       return true;
 650     }
 651   }
 652   return false;
 653 }
 654 
 655 bool GraphKit::builtin_throw_too_many_traps(Deoptimization::DeoptReason reason,
 656                                             ciInstance* ex_obj) {
 657   if (is_builtin_throw_hot(reason)) {
 658     if (method()->can_omit_stack_trace() && ex_obj != nullptr) {
 659       return false; // no traps; throws preallocated exception instead
 660     }
 661     ciMethod* m = Deoptimization::reason_is_speculate(reason) ? C->method() : nullptr;
 662     if (method()->method_data()->trap_recompiled_at(bci(), m) ||
 663         C->too_many_traps(reason)) {
 664       return true;
 665     }
 666   }
 667   return false;
 668 }
 669 
 670 ciInstance* GraphKit::builtin_throw_exception(Deoptimization::DeoptReason reason) const {
 671   // Preallocated exception objects to use when we don't need the backtrace.
 672   switch (reason) {
 673   case Deoptimization::Reason_null_check:
 674     return env()->NullPointerException_instance();
 675   case Deoptimization::Reason_div0_check:
 676     return env()->ArithmeticException_instance();
 677   case Deoptimization::Reason_range_check:
 678     return env()->ArrayIndexOutOfBoundsException_instance();
 679   case Deoptimization::Reason_class_check:
 680     return env()->ClassCastException_instance();
 681   case Deoptimization::Reason_array_check:
 682     return env()->ArrayStoreException_instance();
 683   default:
 684     return nullptr;
 685   }
 686 }
 687 
 688 //----------------------------PreserveJVMState---------------------------------
 689 PreserveJVMState::PreserveJVMState(GraphKit* kit, bool clone_map) {
 690   DEBUG_ONLY(kit->verify_map());
 691   _kit    = kit;
 692   _map    = kit->map();   // preserve the map
 693   _sp     = kit->sp();
 694   kit->set_map(clone_map ? kit->clone_map() : nullptr);
 695 #ifdef ASSERT
 696   _bci    = kit->bci();
 697   Parse* parser = kit->is_Parse();
 698   int block = (parser == nullptr || parser->block() == nullptr) ? -1 : parser->block()->rpo();
 699   _block  = block;
 700 #endif
 701 }
 702 PreserveJVMState::~PreserveJVMState() {
 703   GraphKit* kit = _kit;
 704 #ifdef ASSERT
 705   assert(kit->bci() == _bci, "bci must not shift");
 706   Parse* parser = kit->is_Parse();
 707   int block = (parser == nullptr || parser->block() == nullptr) ? -1 : parser->block()->rpo();
 708   assert(block == _block,    "block must not shift");
 709 #endif
 710   kit->set_map(_map);
 711   kit->set_sp(_sp);
 712 }
 713 
 714 
 715 //-----------------------------BuildCutout-------------------------------------
 716 BuildCutout::BuildCutout(GraphKit* kit, Node* p, float prob, float cnt)
 717   : PreserveJVMState(kit)
 718 {
 719   assert(p->is_Con() || p->is_Bool(), "test must be a bool");
 720   SafePointNode* outer_map = _map;   // preserved map is caller's
 721   SafePointNode* inner_map = kit->map();
 722   IfNode* iff = kit->create_and_map_if(outer_map->control(), p, prob, cnt);
 723   outer_map->set_control(kit->gvn().transform( new IfTrueNode(iff) ));
 724   inner_map->set_control(kit->gvn().transform( new IfFalseNode(iff) ));
 725 }
 726 BuildCutout::~BuildCutout() {
 727   GraphKit* kit = _kit;
 728   assert(kit->stopped(), "cutout code must stop, throw, return, etc.");
 729 }
 730 
 731 //---------------------------PreserveReexecuteState----------------------------
 732 PreserveReexecuteState::PreserveReexecuteState(GraphKit* kit) {
 733   assert(!kit->stopped(), "must call stopped() before");
 734   _kit    =    kit;
 735   _sp     =    kit->sp();
 736   _reexecute = kit->jvms()->_reexecute;
 737 }
 738 PreserveReexecuteState::~PreserveReexecuteState() {
 739   if (_kit->stopped()) return;
 740   _kit->jvms()->_reexecute = _reexecute;
 741   _kit->set_sp(_sp);
 742 }
 743 
 744 //------------------------------clone_map--------------------------------------
 745 // Implementation of PreserveJVMState
 746 //
 747 // Only clone_map(...) here. If this function is only used in the
 748 // PreserveJVMState class we may want to get rid of this extra
 749 // function eventually and do it all there.
 750 
 751 SafePointNode* GraphKit::clone_map() {
 752   if (map() == nullptr)  return nullptr;
 753 
 754   // Clone the memory edge first
 755   Node* mem = MergeMemNode::make(map()->memory());
 756   gvn().set_type_bottom(mem);
 757 
 758   SafePointNode *clonemap = (SafePointNode*)map()->clone();
 759   JVMState* jvms = this->jvms();
 760   JVMState* clonejvms = jvms->clone_shallow(C);
 761   clonemap->set_memory(mem);
 762   clonemap->set_jvms(clonejvms);
 763   clonejvms->set_map(clonemap);
 764   record_for_igvn(clonemap);
 765   gvn().set_type_bottom(clonemap);
 766   return clonemap;
 767 }
 768 
 769 //-----------------------------destruct_map_clone------------------------------
 770 //
 771 // Order of destruct is important to increase the likelyhood that memory can be re-used. We need
 772 // to destruct/free/delete in the exact opposite order as clone_map().
 773 void GraphKit::destruct_map_clone(SafePointNode* sfp) {
 774   if (sfp == nullptr) return;
 775 
 776   Node* mem = sfp->memory();
 777   JVMState* jvms = sfp->jvms();
 778 
 779   if (jvms != nullptr) {
 780     delete jvms;
 781   }
 782 
 783   remove_for_igvn(sfp);
 784   gvn().clear_type(sfp);
 785   sfp->destruct(&_gvn);
 786 
 787   if (mem != nullptr) {
 788     gvn().clear_type(mem);
 789     mem->destruct(&_gvn);
 790   }
 791 }
 792 
 793 //-----------------------------set_map_clone-----------------------------------
 794 void GraphKit::set_map_clone(SafePointNode* m) {
 795   _map = m;
 796   _map = clone_map();
 797   _map->set_next_exception(nullptr);
 798   DEBUG_ONLY(verify_map());
 799 }
 800 
 801 
 802 //----------------------------kill_dead_locals---------------------------------
 803 // Detect any locals which are known to be dead, and force them to top.
 804 void GraphKit::kill_dead_locals() {
 805   // Consult the liveness information for the locals.  If any
 806   // of them are unused, then they can be replaced by top().  This
 807   // should help register allocation time and cut down on the size
 808   // of the deoptimization information.
 809 
 810   // This call is made from many of the bytecode handling
 811   // subroutines called from the Big Switch in do_one_bytecode.
 812   // Every bytecode which might include a slow path is responsible
 813   // for killing its dead locals.  The more consistent we
 814   // are about killing deads, the fewer useless phis will be
 815   // constructed for them at various merge points.
 816 
 817   // bci can be -1 (InvocationEntryBci).  We return the entry
 818   // liveness for the method.
 819 
 820   if (method() == nullptr || method()->code_size() == 0) {
 821     // We are building a graph for a call to a native method.
 822     // All locals are live.
 823     return;
 824   }
 825 
 826   ResourceMark rm;
 827 
 828   // Consult the liveness information for the locals.  If any
 829   // of them are unused, then they can be replaced by top().  This
 830   // should help register allocation time and cut down on the size
 831   // of the deoptimization information.
 832   MethodLivenessResult live_locals = method()->liveness_at_bci(bci());
 833 
 834   int len = (int)live_locals.size();
 835   assert(len <= jvms()->loc_size(), "too many live locals");
 836   for (int local = 0; local < len; local++) {
 837     if (!live_locals.at(local)) {
 838       set_local(local, top());
 839     }
 840   }
 841 }
 842 
 843 #ifdef ASSERT
 844 //-------------------------dead_locals_are_killed------------------------------
 845 // Return true if all dead locals are set to top in the map.
 846 // Used to assert "clean" debug info at various points.
 847 bool GraphKit::dead_locals_are_killed() {
 848   if (method() == nullptr || method()->code_size() == 0) {
 849     // No locals need to be dead, so all is as it should be.
 850     return true;
 851   }
 852 
 853   // Make sure somebody called kill_dead_locals upstream.
 854   ResourceMark rm;
 855   for (JVMState* jvms = this->jvms(); jvms != nullptr; jvms = jvms->caller()) {
 856     if (jvms->loc_size() == 0)  continue;  // no locals to consult
 857     SafePointNode* map = jvms->map();
 858     ciMethod* method = jvms->method();
 859     int       bci    = jvms->bci();
 860     if (jvms == this->jvms()) {
 861       bci = this->bci();  // it might not yet be synched
 862     }
 863     MethodLivenessResult live_locals = method->liveness_at_bci(bci);
 864     int len = (int)live_locals.size();
 865     if (!live_locals.is_valid() || len == 0)
 866       // This method is trivial, or is poisoned by a breakpoint.
 867       return true;
 868     assert(len == jvms->loc_size(), "live map consistent with locals map");
 869     for (int local = 0; local < len; local++) {
 870       if (!live_locals.at(local) && map->local(jvms, local) != top()) {
 871         if (PrintMiscellaneous && (Verbose || WizardMode)) {
 872           tty->print_cr("Zombie local %d: ", local);
 873           jvms->dump();
 874         }
 875         return false;
 876       }
 877     }
 878   }
 879   return true;
 880 }
 881 
 882 #endif //ASSERT
 883 
 884 // Helper function for enforcing certain bytecodes to reexecute if deoptimization happens.
 885 static bool should_reexecute_implied_by_bytecode(JVMState *jvms, bool is_anewarray) {
 886   ciMethod* cur_method = jvms->method();
 887   int       cur_bci   = jvms->bci();
 888   if (cur_method != nullptr && cur_bci != InvocationEntryBci) {
 889     Bytecodes::Code code = cur_method->java_code_at_bci(cur_bci);
 890     return Interpreter::bytecode_should_reexecute(code) ||
 891            (is_anewarray && (code == Bytecodes::_multianewarray));
 892     // Reexecute _multianewarray bytecode which was replaced with
 893     // sequence of [a]newarray. See Parse::do_multianewarray().
 894     //
 895     // Note: interpreter should not have it set since this optimization
 896     // is limited by dimensions and guarded by flag so in some cases
 897     // multianewarray() runtime calls will be generated and
 898     // the bytecode should not be reexecutes (stack will not be reset).
 899   } else {
 900     return false;
 901   }
 902 }
 903 
 904 // Helper function for adding JVMState and debug information to node
 905 void GraphKit::add_safepoint_edges(SafePointNode* call, bool must_throw) {
 906   // Add the safepoint edges to the call (or other safepoint).
 907 
 908   // Make sure dead locals are set to top.  This
 909   // should help register allocation time and cut down on the size
 910   // of the deoptimization information.
 911   assert(dead_locals_are_killed(), "garbage in debug info before safepoint");
 912 
 913   // Walk the inline list to fill in the correct set of JVMState's
 914   // Also fill in the associated edges for each JVMState.
 915 
 916   // If the bytecode needs to be reexecuted we need to put
 917   // the arguments back on the stack.
 918   const bool should_reexecute = jvms()->should_reexecute();
 919   JVMState* youngest_jvms = should_reexecute ? sync_jvms_for_reexecute() : sync_jvms();
 920 
 921   // NOTE: set_bci (called from sync_jvms) might reset the reexecute bit to
 922   // undefined if the bci is different.  This is normal for Parse but it
 923   // should not happen for LibraryCallKit because only one bci is processed.
 924   assert(!is_LibraryCallKit() || (jvms()->should_reexecute() == should_reexecute),
 925          "in LibraryCallKit the reexecute bit should not change");
 926 
 927   // If we are guaranteed to throw, we can prune everything but the
 928   // input to the current bytecode.
 929   bool can_prune_locals = false;
 930   uint stack_slots_not_pruned = 0;
 931   int inputs = 0, depth = 0;
 932   if (must_throw) {
 933     assert(method() == youngest_jvms->method(), "sanity");
 934     if (compute_stack_effects(inputs, depth)) {
 935       can_prune_locals = true;
 936       stack_slots_not_pruned = inputs;
 937     }
 938   }
 939 
 940   if (env()->should_retain_local_variables()) {
 941     // At any safepoint, this method can get breakpointed, which would
 942     // then require an immediate deoptimization.
 943     can_prune_locals = false;  // do not prune locals
 944     stack_slots_not_pruned = 0;
 945   }
 946 
 947   // do not scribble on the input jvms
 948   JVMState* out_jvms = youngest_jvms->clone_deep(C);
 949   call->set_jvms(out_jvms); // Start jvms list for call node
 950 
 951   // For a known set of bytecodes, the interpreter should reexecute them if
 952   // deoptimization happens. We set the reexecute state for them here
 953   if (out_jvms->is_reexecute_undefined() && //don't change if already specified
 954       should_reexecute_implied_by_bytecode(out_jvms, call->is_AllocateArray())) {
 955 #ifdef ASSERT
 956     int inputs = 0, not_used; // initialized by GraphKit::compute_stack_effects()
 957     assert(method() == youngest_jvms->method(), "sanity");
 958     assert(compute_stack_effects(inputs, not_used), "unknown bytecode: %s", Bytecodes::name(java_bc()));
 959     // TODO 8371125
 960     // assert(out_jvms->sp() >= (uint)inputs, "not enough operands for reexecution");
 961 #endif // ASSERT
 962     out_jvms->set_should_reexecute(true); //NOTE: youngest_jvms not changed
 963   }
 964 
 965   // Presize the call:
 966   DEBUG_ONLY(uint non_debug_edges = call->req());
 967   call->add_req_batch(top(), youngest_jvms->debug_depth());
 968   assert(call->req() == non_debug_edges + youngest_jvms->debug_depth(), "");
 969 
 970   // Set up edges so that the call looks like this:
 971   //  Call [state:] ctl io mem fptr retadr
 972   //       [parms:] parm0 ... parmN
 973   //       [root:]  loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
 974   //    [...mid:]   loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN [...]
 975   //       [young:] loc0 ... locN stk0 ... stkSP mon0 obj0 ... monN objN
 976   // Note that caller debug info precedes callee debug info.
 977 
 978   // Fill pointer walks backwards from "young:" to "root:" in the diagram above:
 979   uint debug_ptr = call->req();
 980 
 981   // Loop over the map input edges associated with jvms, add them
 982   // to the call node, & reset all offsets to match call node array.
 983 
 984   JVMState* callee_jvms = nullptr;
 985   for (JVMState* in_jvms = youngest_jvms; in_jvms != nullptr; ) {
 986     uint debug_end   = debug_ptr;
 987     uint debug_start = debug_ptr - in_jvms->debug_size();
 988     debug_ptr = debug_start;  // back up the ptr
 989 
 990     uint p = debug_start;  // walks forward in [debug_start, debug_end)
 991     uint j, k, l;
 992     SafePointNode* in_map = in_jvms->map();
 993     out_jvms->set_map(call);
 994 
 995     if (can_prune_locals) {
 996       assert(in_jvms->method() == out_jvms->method(), "sanity");
 997       // If the current throw can reach an exception handler in this JVMS,
 998       // then we must keep everything live that can reach that handler.
 999       // As a quick and dirty approximation, we look for any handlers at all.
1000       if (in_jvms->method()->has_exception_handlers()) {
1001         can_prune_locals = false;
1002       }
1003     }
1004 
1005     // Add the Locals
1006     k = in_jvms->locoff();
1007     l = in_jvms->loc_size();
1008     out_jvms->set_locoff(p);
1009     if (!can_prune_locals) {
1010       for (j = 0; j < l; j++) {
1011         call->set_req(p++, in_map->in(k + j));
1012       }
1013     } else {
1014       p += l;  // already set to top above by add_req_batch
1015     }
1016 
1017     // Add the Expression Stack
1018     k = in_jvms->stkoff();
1019     l = in_jvms->sp();
1020     out_jvms->set_stkoff(p);
1021     if (!can_prune_locals) {
1022       for (j = 0; j < l; j++) {
1023         call->set_req(p++, in_map->in(k + j));
1024       }
1025     } else if (can_prune_locals && stack_slots_not_pruned != 0) {
1026       // Divide stack into {S0,...,S1}, where S0 is set to top.
1027       uint s1 = stack_slots_not_pruned;
1028       stack_slots_not_pruned = 0;  // for next iteration
1029       if (s1 > l)  s1 = l;
1030       uint s0 = l - s1;
1031       p += s0;  // skip the tops preinstalled by add_req_batch
1032       for (j = s0; j < l; j++)
1033         call->set_req(p++, in_map->in(k+j));
1034     } else {
1035       p += l;  // already set to top above by add_req_batch
1036     }
1037 
1038     // Add the Monitors
1039     k = in_jvms->monoff();
1040     l = in_jvms->mon_size();
1041     out_jvms->set_monoff(p);
1042     for (j = 0; j < l; j++)
1043       call->set_req(p++, in_map->in(k+j));
1044 
1045     // Copy any scalar object fields.
1046     k = in_jvms->scloff();
1047     l = in_jvms->scl_size();
1048     out_jvms->set_scloff(p);
1049     for (j = 0; j < l; j++)
1050       call->set_req(p++, in_map->in(k+j));
1051 
1052     // Finish the new jvms.
1053     out_jvms->set_endoff(p);
1054 
1055     assert(out_jvms->endoff()     == debug_end,             "fill ptr must match");
1056     assert(out_jvms->depth()      == in_jvms->depth(),      "depth must match");
1057     assert(out_jvms->loc_size()   == in_jvms->loc_size(),   "size must match");
1058     assert(out_jvms->mon_size()   == in_jvms->mon_size(),   "size must match");
1059     assert(out_jvms->scl_size()   == in_jvms->scl_size(),   "size must match");
1060     assert(out_jvms->debug_size() == in_jvms->debug_size(), "size must match");
1061 
1062     // Update the two tail pointers in parallel.
1063     callee_jvms = out_jvms;
1064     out_jvms = out_jvms->caller();
1065     in_jvms  = in_jvms->caller();
1066   }
1067 
1068   assert(debug_ptr == non_debug_edges, "debug info must fit exactly");
1069 
1070   // Test the correctness of JVMState::debug_xxx accessors:
1071   assert(call->jvms()->debug_start() == non_debug_edges, "");
1072   assert(call->jvms()->debug_end()   == call->req(), "");
1073   assert(call->jvms()->debug_depth() == call->req() - non_debug_edges, "");
1074 }
1075 
1076 bool GraphKit::compute_stack_effects(int& inputs, int& depth) {
1077   Bytecodes::Code code = java_bc();
1078   if (code == Bytecodes::_wide) {
1079     code = method()->java_code_at_bci(bci() + 1);
1080   }
1081 
1082   if (code != Bytecodes::_illegal) {
1083     depth = Bytecodes::depth(code); // checkcast=0, athrow=-1
1084   }
1085 
1086   auto rsize = [&]() {
1087     assert(code != Bytecodes::_illegal, "code is illegal!");
1088     BasicType rtype = Bytecodes::result_type(code); // checkcast=P, athrow=V
1089     return (rtype < T_CONFLICT) ? type2size[rtype] : 0;
1090   };
1091 
1092   switch (code) {
1093   case Bytecodes::_illegal:
1094     return false;
1095 
1096   case Bytecodes::_ldc:
1097   case Bytecodes::_ldc_w:
1098   case Bytecodes::_ldc2_w:
1099     inputs = 0;
1100     break;
1101 
1102   case Bytecodes::_dup:         inputs = 1;  break;
1103   case Bytecodes::_dup_x1:      inputs = 2;  break;
1104   case Bytecodes::_dup_x2:      inputs = 3;  break;
1105   case Bytecodes::_dup2:        inputs = 2;  break;
1106   case Bytecodes::_dup2_x1:     inputs = 3;  break;
1107   case Bytecodes::_dup2_x2:     inputs = 4;  break;
1108   case Bytecodes::_swap:        inputs = 2;  break;
1109   case Bytecodes::_arraylength: inputs = 1;  break;
1110 
1111   case Bytecodes::_getstatic:
1112   case Bytecodes::_putstatic:
1113   case Bytecodes::_getfield:
1114   case Bytecodes::_putfield:
1115     {
1116       bool ignored_will_link;
1117       ciField* field = method()->get_field_at_bci(bci(), ignored_will_link);
1118       int      size  = field->type()->size();
1119       bool is_get = (depth >= 0), is_static = (depth & 1);
1120       inputs = (is_static ? 0 : 1);
1121       if (is_get) {
1122         depth = size - inputs;
1123       } else {
1124         inputs += size;        // putxxx pops the value from the stack
1125         depth = - inputs;
1126       }
1127     }
1128     break;
1129 
1130   case Bytecodes::_invokevirtual:
1131   case Bytecodes::_invokespecial:
1132   case Bytecodes::_invokestatic:
1133   case Bytecodes::_invokedynamic:
1134   case Bytecodes::_invokeinterface:
1135     {
1136       bool ignored_will_link;
1137       ciSignature* declared_signature = nullptr;
1138       ciMethod* ignored_callee = method()->get_method_at_bci(bci(), ignored_will_link, &declared_signature);
1139       assert(declared_signature != nullptr, "cannot be null");
1140       inputs   = declared_signature->arg_size_for_bc(code);
1141       int size = declared_signature->return_type()->size();
1142       depth = size - inputs;
1143     }
1144     break;
1145 
1146   case Bytecodes::_multianewarray:
1147     {
1148       ciBytecodeStream iter(method());
1149       iter.reset_to_bci(bci());
1150       iter.next();
1151       inputs = iter.get_dimensions();
1152       assert(rsize() == 1, "");
1153       depth = 1 - inputs;
1154     }
1155     break;
1156 
1157   case Bytecodes::_ireturn:
1158   case Bytecodes::_lreturn:
1159   case Bytecodes::_freturn:
1160   case Bytecodes::_dreturn:
1161   case Bytecodes::_areturn:
1162     assert(rsize() == -depth, "");
1163     inputs = -depth;
1164     break;
1165 
1166   case Bytecodes::_jsr:
1167   case Bytecodes::_jsr_w:
1168     inputs = 0;
1169     depth  = 1;                  // S.B. depth=1, not zero
1170     break;
1171 
1172   default:
1173     // bytecode produces a typed result
1174     inputs = rsize() - depth;
1175     assert(inputs >= 0, "");
1176     break;
1177   }
1178 
1179 #ifdef ASSERT
1180   // spot check
1181   int outputs = depth + inputs;
1182   assert(outputs >= 0, "sanity");
1183   switch (code) {
1184   case Bytecodes::_checkcast: assert(inputs == 1 && outputs == 1, ""); break;
1185   case Bytecodes::_athrow:    assert(inputs == 1 && outputs == 0, ""); break;
1186   case Bytecodes::_aload_0:   assert(inputs == 0 && outputs == 1, ""); break;
1187   case Bytecodes::_return:    assert(inputs == 0 && outputs == 0, ""); break;
1188   case Bytecodes::_drem:      assert(inputs == 4 && outputs == 2, ""); break;
1189   default:                    break;
1190   }
1191 #endif //ASSERT
1192 
1193   return true;
1194 }
1195 
1196 
1197 
1198 //------------------------------basic_plus_adr---------------------------------
1199 Node* GraphKit::basic_plus_adr(Node* base, Node* ptr, Node* offset) {
1200   // short-circuit a common case
1201   if (offset == intcon(0))  return ptr;
1202   return _gvn.transform( new AddPNode(base, ptr, offset) );
1203 }
1204 
1205 Node* GraphKit::ConvI2L(Node* offset) {
1206   // short-circuit a common case
1207   jint offset_con = find_int_con(offset, Type::OffsetBot);
1208   if (offset_con != Type::OffsetBot) {
1209     return longcon((jlong) offset_con);
1210   }
1211   return _gvn.transform( new ConvI2LNode(offset));
1212 }
1213 
1214 Node* GraphKit::ConvI2UL(Node* offset) {
1215   juint offset_con = (juint) find_int_con(offset, Type::OffsetBot);
1216   if (offset_con != (juint) Type::OffsetBot) {
1217     return longcon((julong) offset_con);
1218   }
1219   Node* conv = _gvn.transform( new ConvI2LNode(offset));
1220   Node* mask = _gvn.transform(ConLNode::make((julong) max_juint));
1221   return _gvn.transform( new AndLNode(conv, mask) );
1222 }
1223 
1224 Node* GraphKit::ConvL2I(Node* offset) {
1225   // short-circuit a common case
1226   jlong offset_con = find_long_con(offset, (jlong)Type::OffsetBot);
1227   if (offset_con != (jlong)Type::OffsetBot) {
1228     return intcon((int) offset_con);
1229   }
1230   return _gvn.transform( new ConvL2INode(offset));
1231 }
1232 
1233 //-------------------------load_object_klass-----------------------------------
1234 Node* GraphKit::load_object_klass(Node* obj) {
1235   // Special-case a fresh allocation to avoid building nodes:
1236   Node* akls = AllocateNode::Ideal_klass(obj, &_gvn);
1237   if (akls != nullptr)  return akls;
1238   Node* k_adr = basic_plus_adr(obj, oopDesc::klass_offset_in_bytes());
1239   return _gvn.transform(LoadKlassNode::make(_gvn, immutable_memory(), k_adr, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
1240 }
1241 
1242 //-------------------------load_array_length-----------------------------------
1243 Node* GraphKit::load_array_length(Node* array) {
1244   // Special-case a fresh allocation to avoid building nodes:
1245   AllocateArrayNode* alloc = AllocateArrayNode::Ideal_array_allocation(array);
1246   Node *alen;
1247   if (alloc == nullptr) {
1248     Node *r_adr = basic_plus_adr(array, arrayOopDesc::length_offset_in_bytes());
1249     alen = _gvn.transform( new LoadRangeNode(nullptr, immutable_memory(), r_adr, TypeInt::POS));
1250   } else {
1251     alen = array_ideal_length(alloc, _gvn.type(array)->is_oopptr(), false);
1252   }
1253   return alen;
1254 }
1255 
1256 Node* GraphKit::array_ideal_length(AllocateArrayNode* alloc,
1257                                    const TypeOopPtr* oop_type,
1258                                    bool replace_length_in_map) {
1259   Node* length = alloc->Ideal_length();
1260   if (replace_length_in_map == false || map()->find_edge(length) >= 0) {
1261     Node* ccast = alloc->make_ideal_length(oop_type, &_gvn);
1262     if (ccast != length) {
1263       // do not transform ccast here, it might convert to top node for
1264       // negative array length and break assumptions in parsing stage.
1265       _gvn.set_type_bottom(ccast);
1266       record_for_igvn(ccast);
1267       if (replace_length_in_map) {
1268         replace_in_map(length, ccast);
1269       }
1270       return ccast;
1271     }
1272   }
1273   return length;
1274 }
1275 
1276 //------------------------------do_null_check----------------------------------
1277 // Helper function to do a null pointer check.  Returned value is
1278 // the incoming address with null casted away.  You are allowed to use the
1279 // not-null value only if you are control dependent on the test.
1280 #ifndef PRODUCT
1281 extern uint explicit_null_checks_inserted,
1282             explicit_null_checks_elided;
1283 #endif
1284 Node* GraphKit::null_check_common(Node* value, BasicType type,
1285                                   // optional arguments for variations:
1286                                   bool assert_null,
1287                                   Node* *null_control,
1288                                   bool speculative,
1289                                   bool null_marker_check) {
1290   assert(!assert_null || null_control == nullptr, "not both at once");
1291   if (stopped())  return top();
1292   NOT_PRODUCT(explicit_null_checks_inserted++);
1293 
1294   if (value->is_InlineType()) {
1295     // Null checking a scalarized but nullable inline type. Check the null marker
1296     // input instead of the oop input to avoid keeping buffer allocations alive.
1297     InlineTypeNode* vtptr = value->as_InlineType();
1298     while (vtptr->get_oop()->is_InlineType()) {
1299       vtptr = vtptr->get_oop()->as_InlineType();
1300     }
1301     null_check_common(vtptr->get_null_marker(), T_INT, assert_null, null_control, speculative, true);
1302     if (stopped()) {
1303       return top();
1304     }
1305     if (assert_null) {
1306       // TODO 8284443 Scalarize here (this currently leads to compilation bailouts)
1307       // vtptr = InlineTypeNode::make_null(_gvn, vtptr->type()->inline_klass());
1308       // replace_in_map(value, vtptr);
1309       // return vtptr;
1310       replace_in_map(value, null());
1311       return null();
1312     }
1313     bool do_replace_in_map = (null_control == nullptr || (*null_control) == top());
1314     return cast_not_null(value, do_replace_in_map);
1315   }
1316 
1317   // Construct null check
1318   Node *chk = nullptr;
1319   switch(type) {
1320     case T_LONG   : chk = new CmpLNode(value, _gvn.zerocon(T_LONG)); break;
1321     case T_INT    : chk = new CmpINode(value, _gvn.intcon(0)); break;
1322     case T_ARRAY  : // fall through
1323       type = T_OBJECT;  // simplify further tests
1324     case T_OBJECT : {
1325       const Type *t = _gvn.type( value );
1326 
1327       const TypeOopPtr* tp = t->isa_oopptr();
1328       if (tp != nullptr && !tp->is_loaded()
1329           // Only for do_null_check, not any of its siblings:
1330           && !assert_null && null_control == nullptr) {
1331         // Usually, any field access or invocation on an unloaded oop type
1332         // will simply fail to link, since the statically linked class is
1333         // likely also to be unloaded.  However, in -Xcomp mode, sometimes
1334         // the static class is loaded but the sharper oop type is not.
1335         // Rather than checking for this obscure case in lots of places,
1336         // we simply observe that a null check on an unloaded class
1337         // will always be followed by a nonsense operation, so we
1338         // can just issue the uncommon trap here.
1339         // Our access to the unloaded class will only be correct
1340         // after it has been loaded and initialized, which requires
1341         // a trip through the interpreter.
1342         ciKlass* klass = tp->unloaded_klass();
1343 #ifndef PRODUCT
1344         if (WizardMode) { tty->print("Null check of unloaded "); klass->print(); tty->cr(); }
1345 #endif
1346         uncommon_trap(Deoptimization::Reason_unloaded,
1347                       Deoptimization::Action_reinterpret,
1348                       klass, "!loaded");
1349         return top();
1350       }
1351 
1352       if (assert_null) {
1353         // See if the type is contained in NULL_PTR.
1354         // If so, then the value is already null.
1355         if (t->higher_equal(TypePtr::NULL_PTR)) {
1356           NOT_PRODUCT(explicit_null_checks_elided++);
1357           return value;           // Elided null assert quickly!
1358         }
1359       } else {
1360         // See if mixing in the null pointer changes type.
1361         // If so, then the null pointer was not allowed in the original
1362         // type.  In other words, "value" was not-null.
1363         if (t->meet(TypePtr::NULL_PTR) != t->remove_speculative()) {
1364           // same as: if (!TypePtr::NULL_PTR->higher_equal(t)) ...
1365           NOT_PRODUCT(explicit_null_checks_elided++);
1366           return value;           // Elided null check quickly!
1367         }
1368       }
1369       chk = new CmpPNode( value, null() );
1370       break;
1371     }
1372 
1373     default:
1374       fatal("unexpected type: %s", type2name(type));
1375   }
1376   assert(chk != nullptr, "sanity check");
1377   chk = _gvn.transform(chk);
1378 
1379   BoolTest::mask btest = assert_null ? BoolTest::eq : BoolTest::ne;
1380   BoolNode *btst = new BoolNode( chk, btest);
1381   Node   *tst = _gvn.transform( btst );
1382 
1383   //-----------
1384   // if peephole optimizations occurred, a prior test existed.
1385   // If a prior test existed, maybe it dominates as we can avoid this test.
1386   if (tst != btst && type == T_OBJECT) {
1387     // At this point we want to scan up the CFG to see if we can
1388     // find an identical test (and so avoid this test altogether).
1389     Node *cfg = control();
1390     int depth = 0;
1391     while( depth < 16 ) {       // Limit search depth for speed
1392       if( cfg->Opcode() == Op_IfTrue &&
1393           cfg->in(0)->in(1) == tst ) {
1394         // Found prior test.  Use "cast_not_null" to construct an identical
1395         // CastPP (and hence hash to) as already exists for the prior test.
1396         // Return that casted value.
1397         if (assert_null) {
1398           replace_in_map(value, null());
1399           return null();  // do not issue the redundant test
1400         }
1401         Node *oldcontrol = control();
1402         set_control(cfg);
1403         Node *res = cast_not_null(value);
1404         set_control(oldcontrol);
1405         NOT_PRODUCT(explicit_null_checks_elided++);
1406         return res;
1407       }
1408       cfg = IfNode::up_one_dom(cfg, /*linear_only=*/ true);
1409       if (cfg == nullptr)  break;  // Quit at region nodes
1410       depth++;
1411     }
1412   }
1413 
1414   //-----------
1415   // Branch to failure if null
1416   float ok_prob = PROB_MAX;  // a priori estimate:  nulls never happen
1417   Deoptimization::DeoptReason reason;
1418   if (assert_null) {
1419     reason = Deoptimization::reason_null_assert(speculative);
1420   } else if (type == T_OBJECT || null_marker_check) {
1421     reason = Deoptimization::reason_null_check(speculative);
1422   } else {
1423     reason = Deoptimization::Reason_div0_check;
1424   }
1425   // %%% Since Reason_unhandled is not recorded on a per-bytecode basis,
1426   // ciMethodData::has_trap_at will return a conservative -1 if any
1427   // must-be-null assertion has failed.  This could cause performance
1428   // problems for a method after its first do_null_assert failure.
1429   // Consider using 'Reason_class_check' instead?
1430 
1431   // To cause an implicit null check, we set the not-null probability
1432   // to the maximum (PROB_MAX).  For an explicit check the probability
1433   // is set to a smaller value.
1434   if (null_control != nullptr || too_many_traps(reason)) {
1435     // probability is less likely
1436     ok_prob =  PROB_LIKELY_MAG(3);
1437   } else if (!assert_null &&
1438              (ImplicitNullCheckThreshold > 0) &&
1439              method() != nullptr &&
1440              (method()->method_data()->trap_count(reason)
1441               >= (uint)ImplicitNullCheckThreshold)) {
1442     ok_prob =  PROB_LIKELY_MAG(3);
1443   }
1444 
1445   if (null_control != nullptr) {
1446     IfNode* iff = create_and_map_if(control(), tst, ok_prob, COUNT_UNKNOWN);
1447     Node* null_true = _gvn.transform( new IfFalseNode(iff));
1448     set_control(      _gvn.transform( new IfTrueNode(iff)));
1449 #ifndef PRODUCT
1450     if (null_true == top()) {
1451       explicit_null_checks_elided++;
1452     }
1453 #endif
1454     (*null_control) = null_true;
1455   } else {
1456     BuildCutout unless(this, tst, ok_prob);
1457     // Check for optimizer eliding test at parse time
1458     if (stopped()) {
1459       // Failure not possible; do not bother making uncommon trap.
1460       NOT_PRODUCT(explicit_null_checks_elided++);
1461     } else if (assert_null) {
1462       uncommon_trap(reason,
1463                     Deoptimization::Action_make_not_entrant,
1464                     nullptr, "assert_null");
1465     } else {
1466       replace_in_map(value, zerocon(type));
1467       builtin_throw(reason);
1468     }
1469   }
1470 
1471   // Must throw exception, fall-thru not possible?
1472   if (stopped()) {
1473     return top();               // No result
1474   }
1475 
1476   if (assert_null) {
1477     // Cast obj to null on this path.
1478     replace_in_map(value, zerocon(type));
1479     return zerocon(type);
1480   }
1481 
1482   // Cast obj to not-null on this path, if there is no null_control.
1483   // (If there is a null_control, a non-null value may come back to haunt us.)
1484   if (type == T_OBJECT) {
1485     Node* cast = cast_not_null(value, false);
1486     if (null_control == nullptr || (*null_control) == top())
1487       replace_in_map(value, cast);
1488     value = cast;
1489   }
1490 
1491   return value;
1492 }
1493 
1494 //------------------------------cast_not_null----------------------------------
1495 // Cast obj to not-null on this path
1496 Node* GraphKit::cast_not_null(Node* obj, bool do_replace_in_map) {
1497   if (obj->is_InlineType()) {
1498     Node* vt = obj->isa_InlineType()->clone_if_required(&gvn(), map(), do_replace_in_map);
1499     vt->as_InlineType()->set_null_marker(_gvn);
1500     vt = _gvn.transform(vt);
1501     if (do_replace_in_map) {
1502       replace_in_map(obj, vt);
1503     }
1504     return vt;
1505   }
1506   const Type *t = _gvn.type(obj);
1507   const Type *t_not_null = t->join_speculative(TypePtr::NOTNULL);
1508   // Object is already not-null?
1509   if( t == t_not_null ) return obj;
1510 
1511   Node* cast = new CastPPNode(control(), obj,t_not_null);
1512   cast = _gvn.transform( cast );
1513 
1514   // Scan for instances of 'obj' in the current JVM mapping.
1515   // These instances are known to be not-null after the test.
1516   if (do_replace_in_map)
1517     replace_in_map(obj, cast);
1518 
1519   return cast;                  // Return casted value
1520 }
1521 
1522 Node* GraphKit::cast_to_non_larval(Node* obj) {
1523   const Type* obj_type = gvn().type(obj);
1524   if (obj->is_InlineType() || !obj_type->is_inlinetypeptr()) {
1525     return obj;
1526   }
1527 
1528   Node* new_obj = InlineTypeNode::make_from_oop(this, obj, obj_type->inline_klass());
1529   replace_in_map(obj, new_obj);
1530   return new_obj;
1531 }
1532 
1533 // Sometimes in intrinsics, we implicitly know an object is not null
1534 // (there's no actual null check) so we can cast it to not null. In
1535 // the course of optimizations, the input to the cast can become null.
1536 // In that case that data path will die and we need the control path
1537 // to become dead as well to keep the graph consistent. So we have to
1538 // add a check for null for which one branch can't be taken. It uses
1539 // an OpaqueNotNull node that will cause the check to be removed after loop
1540 // opts so the test goes away and the compiled code doesn't execute a
1541 // useless check.
1542 Node* GraphKit::must_be_not_null(Node* value, bool do_replace_in_map) {
1543   if (!TypePtr::NULL_PTR->higher_equal(_gvn.type(value))) {
1544     return value;
1545   }
1546   Node* chk = _gvn.transform(new CmpPNode(value, null()));
1547   Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::ne));
1548   Node* opaq = _gvn.transform(new OpaqueNotNullNode(C, tst));
1549   IfNode* iff = new IfNode(control(), opaq, PROB_MAX, COUNT_UNKNOWN);
1550   _gvn.set_type(iff, iff->Value(&_gvn));
1551   if (!tst->is_Con()) {
1552     record_for_igvn(iff);
1553   }
1554   Node *if_f = _gvn.transform(new IfFalseNode(iff));
1555   Node *frame = _gvn.transform(new ParmNode(C->start(), TypeFunc::FramePtr));
1556   Node* halt = _gvn.transform(new HaltNode(if_f, frame, "unexpected null in intrinsic"));
1557   C->root()->add_req(halt);
1558   Node *if_t = _gvn.transform(new IfTrueNode(iff));
1559   set_control(if_t);
1560   return cast_not_null(value, do_replace_in_map);
1561 }
1562 
1563 
1564 //--------------------------replace_in_map-------------------------------------
1565 void GraphKit::replace_in_map(Node* old, Node* neww) {
1566   if (old == neww) {
1567     return;
1568   }
1569 
1570   map()->replace_edge(old, neww);
1571 
1572   // Note: This operation potentially replaces any edge
1573   // on the map.  This includes locals, stack, and monitors
1574   // of the current (innermost) JVM state.
1575 
1576   // don't let inconsistent types from profiling escape this
1577   // method
1578 
1579   const Type* told = _gvn.type(old);
1580   const Type* tnew = _gvn.type(neww);
1581 
1582   if (!tnew->higher_equal(told)) {
1583     return;
1584   }
1585 
1586   map()->record_replaced_node(old, neww);
1587 }
1588 
1589 
1590 //=============================================================================
1591 //--------------------------------memory---------------------------------------
1592 Node* GraphKit::memory(uint alias_idx) {
1593   MergeMemNode* mem = merged_memory();
1594   Node* p = mem->memory_at(alias_idx);
1595   assert(p != mem->empty_memory(), "empty");
1596   _gvn.set_type(p, Type::MEMORY);  // must be mapped
1597   return p;
1598 }
1599 
1600 //-----------------------------reset_memory------------------------------------
1601 Node* GraphKit::reset_memory() {
1602   Node* mem = map()->memory();
1603   // do not use this node for any more parsing!
1604   DEBUG_ONLY( map()->set_memory((Node*)nullptr) );
1605   return _gvn.transform( mem );
1606 }
1607 
1608 //------------------------------set_all_memory---------------------------------
1609 void GraphKit::set_all_memory(Node* newmem) {
1610   Node* mergemem = MergeMemNode::make(newmem);
1611   gvn().set_type_bottom(mergemem);
1612   map()->set_memory(mergemem);
1613 }
1614 
1615 //------------------------------set_all_memory_call----------------------------
1616 void GraphKit::set_all_memory_call(Node* call, bool separate_io_proj) {
1617   Node* newmem = _gvn.transform( new ProjNode(call, TypeFunc::Memory, separate_io_proj) );
1618   set_all_memory(newmem);
1619 }
1620 
1621 //=============================================================================
1622 //
1623 // parser factory methods for MemNodes
1624 //
1625 // These are layered on top of the factory methods in LoadNode and StoreNode,
1626 // and integrate with the parser's memory state and _gvn engine.
1627 //
1628 
1629 // factory methods in "int adr_idx"
1630 Node* GraphKit::make_load(Node* ctl, Node* adr, const Type* t, BasicType bt,
1631                           MemNode::MemOrd mo,
1632                           LoadNode::ControlDependency control_dependency,
1633                           bool require_atomic_access,
1634                           bool unaligned,
1635                           bool mismatched,
1636                           bool unsafe,
1637                           uint8_t barrier_data) {
1638   int adr_idx = C->get_alias_index(_gvn.type(adr)->isa_ptr());
1639   assert(adr_idx != Compile::AliasIdxTop, "use other make_load factory" );
1640   const TypePtr* adr_type = nullptr; // debug-mode-only argument
1641   DEBUG_ONLY(adr_type = C->get_adr_type(adr_idx));
1642   Node* mem = memory(adr_idx);
1643   Node* ld = LoadNode::make(_gvn, ctl, mem, adr, adr_type, t, bt, mo, control_dependency, require_atomic_access, unaligned, mismatched, unsafe, barrier_data);
1644   ld = _gvn.transform(ld);
1645 
1646   if (((bt == T_OBJECT) && C->do_escape_analysis()) || C->eliminate_boxing()) {
1647     // Improve graph before escape analysis and boxing elimination.
1648     record_for_igvn(ld);
1649     if (ld->is_DecodeN()) {
1650       // Also record the actual load (LoadN) in case ld is DecodeN. In some
1651       // rare corner cases, ld->in(1) can be something other than LoadN (e.g.,
1652       // a Phi). Recording such cases is still perfectly sound, but may be
1653       // unnecessary and result in some minor IGVN overhead.
1654       record_for_igvn(ld->in(1));
1655     }
1656   }
1657   return ld;
1658 }
1659 
1660 Node* GraphKit::store_to_memory(Node* ctl, Node* adr, Node *val, BasicType bt,
1661                                 MemNode::MemOrd mo,
1662                                 bool require_atomic_access,
1663                                 bool unaligned,
1664                                 bool mismatched,
1665                                 bool unsafe,
1666                                 int barrier_data) {
1667   int adr_idx = C->get_alias_index(_gvn.type(adr)->isa_ptr());
1668   assert(adr_idx != Compile::AliasIdxTop, "use other store_to_memory factory" );
1669   const TypePtr* adr_type = nullptr;
1670   DEBUG_ONLY(adr_type = C->get_adr_type(adr_idx));
1671   Node *mem = memory(adr_idx);
1672   Node* st = StoreNode::make(_gvn, ctl, mem, adr, adr_type, val, bt, mo, require_atomic_access);
1673   if (unaligned) {
1674     st->as_Store()->set_unaligned_access();
1675   }
1676   if (mismatched) {
1677     st->as_Store()->set_mismatched_access();
1678   }
1679   if (unsafe) {
1680     st->as_Store()->set_unsafe_access();
1681   }
1682   st->as_Store()->set_barrier_data(barrier_data);
1683   st = _gvn.transform(st);
1684   set_memory(st, adr_idx);
1685   // Back-to-back stores can only remove intermediate store with DU info
1686   // so push on worklist for optimizer.
1687   if (mem->req() > MemNode::Address && adr == mem->in(MemNode::Address))
1688     record_for_igvn(st);
1689 
1690   return st;
1691 }
1692 
1693 Node* GraphKit::access_store_at(Node* obj,
1694                                 Node* adr,
1695                                 const TypePtr* adr_type,
1696                                 Node* val,
1697                                 const Type* val_type,
1698                                 BasicType bt,
1699                                 DecoratorSet decorators,
1700                                 bool safe_for_replace,
1701                                 const InlineTypeNode* vt) {
1702   // Transformation of a value which could be null pointer (CastPP #null)
1703   // could be delayed during Parse (for example, in adjust_map_after_if()).
1704   // Execute transformation here to avoid barrier generation in such case.
1705   if (_gvn.type(val) == TypePtr::NULL_PTR) {
1706     val = _gvn.makecon(TypePtr::NULL_PTR);
1707   }
1708 
1709   if (stopped()) {
1710     return top(); // Dead path ?
1711   }
1712 
1713   assert(val != nullptr, "not dead path");
1714   if (val->is_InlineType()) {
1715     // Store to non-flat field. Buffer the inline type and make sure
1716     // the store is re-executed if the allocation triggers deoptimization.
1717     PreserveReexecuteState preexecs(this);
1718     jvms()->set_should_reexecute(true);
1719     val = val->as_InlineType()->buffer(this, safe_for_replace);
1720   }
1721 
1722   C2AccessValuePtr addr(adr, adr_type);
1723   C2AccessValue value(val, val_type);
1724   C2ParseAccess access(this, decorators | C2_WRITE_ACCESS, bt, obj, addr, nullptr, vt);
1725   if (access.is_raw()) {
1726     return _barrier_set->BarrierSetC2::store_at(access, value);
1727   } else {
1728     return _barrier_set->store_at(access, value);
1729   }
1730 }
1731 
1732 Node* GraphKit::access_load_at(Node* obj,   // containing obj
1733                                Node* adr,   // actual address to store val at
1734                                const TypePtr* adr_type,
1735                                const Type* val_type,
1736                                BasicType bt,
1737                                DecoratorSet decorators,
1738                                Node* ctl) {
1739   if (stopped()) {
1740     return top(); // Dead path ?
1741   }
1742 
1743   C2AccessValuePtr addr(adr, adr_type);
1744   C2ParseAccess access(this, decorators | C2_READ_ACCESS, bt, obj, addr, ctl);
1745   if (access.is_raw()) {
1746     return _barrier_set->BarrierSetC2::load_at(access, val_type);
1747   } else {
1748     return _barrier_set->load_at(access, val_type);
1749   }
1750 }
1751 
1752 Node* GraphKit::access_load(Node* adr,   // actual address to load val at
1753                             const Type* val_type,
1754                             BasicType bt,
1755                             DecoratorSet decorators) {
1756   if (stopped()) {
1757     return top(); // Dead path ?
1758   }
1759 
1760   C2AccessValuePtr addr(adr, adr->bottom_type()->is_ptr());
1761   C2ParseAccess access(this, decorators | C2_READ_ACCESS, bt, nullptr, addr);
1762   if (access.is_raw()) {
1763     return _barrier_set->BarrierSetC2::load_at(access, val_type);
1764   } else {
1765     return _barrier_set->load_at(access, val_type);
1766   }
1767 }
1768 
1769 Node* GraphKit::access_atomic_cmpxchg_val_at(Node* obj,
1770                                              Node* adr,
1771                                              const TypePtr* adr_type,
1772                                              int alias_idx,
1773                                              Node* expected_val,
1774                                              Node* new_val,
1775                                              const Type* value_type,
1776                                              BasicType bt,
1777                                              DecoratorSet decorators) {
1778   C2AccessValuePtr addr(adr, adr_type);
1779   C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1780                         bt, obj, addr, alias_idx);
1781   if (access.is_raw()) {
1782     return _barrier_set->BarrierSetC2::atomic_cmpxchg_val_at(access, expected_val, new_val, value_type);
1783   } else {
1784     return _barrier_set->atomic_cmpxchg_val_at(access, expected_val, new_val, value_type);
1785   }
1786 }
1787 
1788 Node* GraphKit::access_atomic_cmpxchg_bool_at(Node* obj,
1789                                               Node* adr,
1790                                               const TypePtr* adr_type,
1791                                               int alias_idx,
1792                                               Node* expected_val,
1793                                               Node* new_val,
1794                                               const Type* value_type,
1795                                               BasicType bt,
1796                                               DecoratorSet decorators) {
1797   C2AccessValuePtr addr(adr, adr_type);
1798   C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1799                         bt, obj, addr, alias_idx);
1800   if (access.is_raw()) {
1801     return _barrier_set->BarrierSetC2::atomic_cmpxchg_bool_at(access, expected_val, new_val, value_type);
1802   } else {
1803     return _barrier_set->atomic_cmpxchg_bool_at(access, expected_val, new_val, value_type);
1804   }
1805 }
1806 
1807 Node* GraphKit::access_atomic_xchg_at(Node* obj,
1808                                       Node* adr,
1809                                       const TypePtr* adr_type,
1810                                       int alias_idx,
1811                                       Node* new_val,
1812                                       const Type* value_type,
1813                                       BasicType bt,
1814                                       DecoratorSet decorators) {
1815   C2AccessValuePtr addr(adr, adr_type);
1816   C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS,
1817                         bt, obj, addr, alias_idx);
1818   if (access.is_raw()) {
1819     return _barrier_set->BarrierSetC2::atomic_xchg_at(access, new_val, value_type);
1820   } else {
1821     return _barrier_set->atomic_xchg_at(access, new_val, value_type);
1822   }
1823 }
1824 
1825 Node* GraphKit::access_atomic_add_at(Node* obj,
1826                                      Node* adr,
1827                                      const TypePtr* adr_type,
1828                                      int alias_idx,
1829                                      Node* new_val,
1830                                      const Type* value_type,
1831                                      BasicType bt,
1832                                      DecoratorSet decorators) {
1833   C2AccessValuePtr addr(adr, adr_type);
1834   C2AtomicParseAccess access(this, decorators | C2_READ_ACCESS | C2_WRITE_ACCESS, bt, obj, addr, alias_idx);
1835   if (access.is_raw()) {
1836     return _barrier_set->BarrierSetC2::atomic_add_at(access, new_val, value_type);
1837   } else {
1838     return _barrier_set->atomic_add_at(access, new_val, value_type);
1839   }
1840 }
1841 
1842 void GraphKit::access_clone(Node* src, Node* dst, Node* size, bool is_array) {
1843   return _barrier_set->clone(this, src, dst, size, is_array);
1844 }
1845 
1846 //-------------------------array_element_address-------------------------
1847 Node* GraphKit::array_element_address(Node* ary, Node* idx, BasicType elembt,
1848                                       const TypeInt* sizetype, Node* ctrl) {
1849   const TypeAryPtr* arytype = _gvn.type(ary)->is_aryptr();
1850   uint shift;
1851   uint header;
1852   if (arytype->is_flat() && arytype->klass_is_exact()) {
1853     // We can only determine the flat array layout statically if the klass is exact. Otherwise, we could have different
1854     // value classes at runtime with a potentially different layout. The caller needs to fall back to call
1855     // load/store_unknown_inline_Type() at runtime. We could return a sentinel node for the non-exact case but that
1856     // might mess with other GVN transformations in between. Thus, we just continue in the else branch normally, even
1857     // though we don't need the address node in this case and throw it away again.
1858     shift = arytype->flat_log_elem_size();
1859     header = arrayOopDesc::base_offset_in_bytes(T_FLAT_ELEMENT);
1860   } else {
1861     shift = exact_log2(type2aelembytes(elembt));
1862     header = arrayOopDesc::base_offset_in_bytes(elembt);
1863   }
1864 
1865   // short-circuit a common case (saves lots of confusing waste motion)
1866   jint idx_con = find_int_con(idx, -1);
1867   if (idx_con >= 0) {
1868     intptr_t offset = header + ((intptr_t)idx_con << shift);
1869     return basic_plus_adr(ary, offset);
1870   }
1871 
1872   // must be correct type for alignment purposes
1873   Node* base  = basic_plus_adr(ary, header);
1874   idx = Compile::conv_I2X_index(&_gvn, idx, sizetype, ctrl);
1875   Node* scale = _gvn.transform( new LShiftXNode(idx, intcon(shift)) );
1876   return basic_plus_adr(ary, base, scale);
1877 }
1878 
1879 Node* GraphKit::cast_to_flat_array(Node* array, ciInlineKlass* vk, bool is_null_free, bool is_not_null_free, bool is_atomic) {
1880   assert(vk->maybe_flat_in_array(), "element of type %s cannot be flat in array", vk->name()->as_utf8());
1881   if (!vk->has_nullable_atomic_layout()) {
1882     // Element does not have a nullable flat layout, cannot be nullable
1883     is_null_free = true;
1884   }
1885   if (!vk->has_atomic_layout() && !vk->has_non_atomic_layout()) {
1886     // Element does not have a null-free flat layout, cannot be null-free
1887     is_not_null_free = true;
1888   }
1889   if (is_null_free) {
1890     // TODO 8350865 Impossible type
1891     is_not_null_free = false;
1892   }
1893 
1894   bool is_exact = is_null_free || is_not_null_free;
1895   ciArrayKlass* array_klass = ciArrayKlass::make(vk, is_null_free, is_atomic, true);
1896   assert(array_klass->is_elem_null_free() == is_null_free, "inconsistency");
1897   assert(array_klass->is_elem_atomic() == is_atomic, "inconsistency");
1898   const TypeAryPtr* arytype = TypeOopPtr::make_from_klass(array_klass)->isa_aryptr();
1899   arytype = arytype->cast_to_exactness(is_exact);
1900   arytype = arytype->cast_to_not_null_free(is_not_null_free);
1901   assert(arytype->is_null_free() == is_null_free, "inconsistency");
1902   assert(arytype->is_not_null_free() == is_not_null_free, "inconsistency");
1903   assert(arytype->is_atomic() == is_atomic, "inconsistency");
1904   return _gvn.transform(new CastPPNode(control(), array, arytype, ConstraintCastNode::StrongDependency));
1905 }
1906 
1907 //-------------------------load_array_element-------------------------
1908 Node* GraphKit::load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl) {
1909   const Type* elemtype = arytype->elem();
1910   BasicType elembt = elemtype->array_element_basic_type();
1911   Node* adr = array_element_address(ary, idx, elembt, arytype->size());
1912   if (elembt == T_NARROWOOP) {
1913     elembt = T_OBJECT; // To satisfy switch in LoadNode::make()
1914   }
1915   Node* ld = access_load_at(ary, adr, arytype, elemtype, elembt,
1916                             IN_HEAP | IS_ARRAY | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0));
1917   return ld;
1918 }
1919 
1920 //-------------------------set_arguments_for_java_call-------------------------
1921 // Arguments (pre-popped from the stack) are taken from the JVMS.
1922 void GraphKit::set_arguments_for_java_call(CallJavaNode* call, bool is_late_inline) {
1923   PreserveReexecuteState preexecs(this);
1924   if (EnableValhalla) {
1925     // Make sure the call is "re-executed", if buffering of inline type arguments triggers deoptimization.
1926     // At this point, the call hasn't been executed yet, so we will only ever execute the call once.
1927     jvms()->set_should_reexecute(true);
1928     int arg_size = method()->get_declared_signature_at_bci(bci())->arg_size_for_bc(java_bc());
1929     inc_sp(arg_size);
1930   }
1931   // Add the call arguments
1932   const TypeTuple* domain = call->tf()->domain_sig();
1933   uint nargs = domain->cnt();
1934   int arg_num = 0;
1935   for (uint i = TypeFunc::Parms, idx = TypeFunc::Parms; i < nargs; i++) {
1936     Node* arg = argument(i-TypeFunc::Parms);
1937     const Type* t = domain->field_at(i);
1938     // TODO 8284443 A static call to a mismatched method should still be scalarized
1939     if (t->is_inlinetypeptr() && !call->method()->get_Method()->mismatch() && call->method()->is_scalarized_arg(arg_num)) {
1940       // We don't pass inline type arguments by reference but instead pass each field of the inline type
1941       if (!arg->is_InlineType()) {
1942         assert(_gvn.type(arg)->is_zero_type() && !t->inline_klass()->is_null_free(), "Unexpected argument type");
1943         arg = InlineTypeNode::make_from_oop(this, arg, t->inline_klass());
1944       }
1945       InlineTypeNode* vt = arg->as_InlineType();
1946       vt->pass_fields(this, call, idx, true, !t->maybe_null());
1947       // If an inline type argument is passed as fields, attach the Method* to the call site
1948       // to be able to access the extended signature later via attached_method_before_pc().
1949       // For example, see CompiledMethod::preserve_callee_argument_oops().
1950       call->set_override_symbolic_info(true);
1951       // Register an calling convention dependency on the callee method to make sure that this method is deoptimized and
1952       // re-compiled with a non-scalarized calling convention if the callee method is later marked as mismatched.
1953       C->dependencies()->assert_mismatch_calling_convention(call->method());
1954       arg_num++;
1955       continue;
1956     } else if (arg->is_InlineType()) {
1957       // Pass inline type argument via oop to callee
1958       arg = arg->as_InlineType()->buffer(this, true);
1959     }
1960     if (t != Type::HALF) {
1961       arg_num++;
1962     }
1963     call->init_req(idx++, arg);
1964   }
1965 }
1966 
1967 //---------------------------set_edges_for_java_call---------------------------
1968 // Connect a newly created call into the current JVMS.
1969 // A return value node (if any) is returned from set_edges_for_java_call.
1970 void GraphKit::set_edges_for_java_call(CallJavaNode* call, bool must_throw, bool separate_io_proj) {
1971 
1972   // Add the predefined inputs:
1973   call->init_req( TypeFunc::Control, control() );
1974   call->init_req( TypeFunc::I_O    , i_o() );
1975   call->init_req( TypeFunc::Memory , reset_memory() );
1976   call->init_req( TypeFunc::FramePtr, frameptr() );
1977   call->init_req( TypeFunc::ReturnAdr, top() );
1978 
1979   add_safepoint_edges(call, must_throw);
1980 
1981   Node* xcall = _gvn.transform(call);
1982 
1983   if (xcall == top()) {
1984     set_control(top());
1985     return;
1986   }
1987   assert(xcall == call, "call identity is stable");
1988 
1989   // Re-use the current map to produce the result.
1990 
1991   set_control(_gvn.transform(new ProjNode(call, TypeFunc::Control)));
1992   set_i_o(    _gvn.transform(new ProjNode(call, TypeFunc::I_O    , separate_io_proj)));
1993   set_all_memory_call(xcall, separate_io_proj);
1994 
1995   //return xcall;   // no need, caller already has it
1996 }
1997 
1998 Node* GraphKit::set_results_for_java_call(CallJavaNode* call, bool separate_io_proj, bool deoptimize) {
1999   if (stopped())  return top();  // maybe the call folded up?
2000 
2001   // Note:  Since any out-of-line call can produce an exception,
2002   // we always insert an I_O projection from the call into the result.
2003 
2004   make_slow_call_ex(call, env()->Throwable_klass(), separate_io_proj, deoptimize);
2005 
2006   if (separate_io_proj) {
2007     // The caller requested separate projections be used by the fall
2008     // through and exceptional paths, so replace the projections for
2009     // the fall through path.
2010     set_i_o(_gvn.transform( new ProjNode(call, TypeFunc::I_O) ));
2011     set_all_memory(_gvn.transform( new ProjNode(call, TypeFunc::Memory) ));
2012   }
2013 
2014   // Capture the return value, if any.
2015   Node* ret;
2016   if (call->method() == nullptr || call->method()->return_type()->basic_type() == T_VOID) {
2017     ret = top();
2018   } else if (call->tf()->returns_inline_type_as_fields()) {
2019     // Return of multiple values (inline type fields): we create a
2020     // InlineType node, each field is a projection from the call.
2021     ciInlineKlass* vk = call->method()->return_type()->as_inline_klass();
2022     uint base_input = TypeFunc::Parms;
2023     ret = InlineTypeNode::make_from_multi(this, call, vk, base_input, false, false);
2024   } else {
2025     ret = _gvn.transform(new ProjNode(call, TypeFunc::Parms));
2026     ciType* t = call->method()->return_type();
2027     if (!t->is_loaded() && InlineTypeReturnedAsFields) {
2028       // The return type is unloaded but the callee might later be C2 compiled and then return
2029       // in scalarized form when the return type is loaded. Handle this similar to what we do in
2030       // PhaseMacroExpand::expand_mh_intrinsic_return by calling into the runtime to buffer.
2031       // It's a bit unfortunate because we will deopt anyway but the interpreter needs an oop.
2032       IdealKit ideal(this);
2033       IdealVariable res(ideal);
2034       ideal.declarations_done();
2035       ideal.if_then(ret, BoolTest::eq, ideal.makecon(TypePtr::NULL_PTR)); {
2036         // Return value is null
2037         ideal.set(res, makecon(TypePtr::NULL_PTR));
2038       } ideal.else_(); {
2039         // Return value is non-null
2040         sync_kit(ideal);
2041 
2042         // Change return type of call to scalarized return
2043         const TypeFunc* tf = call->_tf;
2044         const TypeTuple* domain = OptoRuntime::store_inline_type_fields_Type()->domain_cc();
2045         const TypeFunc* new_tf = TypeFunc::make(tf->domain_sig(), tf->domain_cc(), tf->range_sig(), domain);
2046         call->_tf = new_tf;
2047         _gvn.set_type(call, call->Value(&_gvn));
2048         _gvn.set_type(ret, ret->Value(&_gvn));
2049 
2050         Node* store_to_buf_call = make_runtime_call(RC_NO_LEAF | RC_NO_IO,
2051                                                     OptoRuntime::store_inline_type_fields_Type(),
2052                                                     StubRoutines::store_inline_type_fields_to_buf(),
2053                                                     nullptr, TypePtr::BOTTOM, ret);
2054 
2055         // We don't know how many values are returned. This assumes the
2056         // worst case, that all available registers are used.
2057         for (uint i = TypeFunc::Parms+1; i < domain->cnt(); i++) {
2058           if (domain->field_at(i) == Type::HALF) {
2059             store_to_buf_call->init_req(i, top());
2060             continue;
2061           }
2062           Node* proj =_gvn.transform(new ProjNode(call, i));
2063           store_to_buf_call->init_req(i, proj);
2064         }
2065         make_slow_call_ex(store_to_buf_call, env()->Throwable_klass(), false);
2066 
2067         Node* buf = _gvn.transform(new ProjNode(store_to_buf_call, TypeFunc::Parms));
2068         const Type* buf_type = TypeOopPtr::make_from_klass(t->as_klass())->join_speculative(TypePtr::NOTNULL);
2069         buf = _gvn.transform(new CheckCastPPNode(control(), buf, buf_type));
2070 
2071         ideal.set(res, buf);
2072         ideal.sync_kit(this);
2073       } ideal.end_if();
2074       sync_kit(ideal);
2075       ret = _gvn.transform(ideal.value(res));
2076     }
2077     if (t->is_klass()) {
2078       const Type* type = TypeOopPtr::make_from_klass(t->as_klass());
2079       if (type->is_inlinetypeptr()) {
2080         ret = InlineTypeNode::make_from_oop(this, ret, type->inline_klass());
2081       }
2082     }
2083   }
2084 
2085   return ret;
2086 }
2087 
2088 //--------------------set_predefined_input_for_runtime_call--------------------
2089 // Reading and setting the memory state is way conservative here.
2090 // The real problem is that I am not doing real Type analysis on memory,
2091 // so I cannot distinguish card mark stores from other stores.  Across a GC
2092 // point the Store Barrier and the card mark memory has to agree.  I cannot
2093 // have a card mark store and its barrier split across the GC point from
2094 // either above or below.  Here I get that to happen by reading ALL of memory.
2095 // A better answer would be to separate out card marks from other memory.
2096 // For now, return the input memory state, so that it can be reused
2097 // after the call, if this call has restricted memory effects.
2098 Node* GraphKit::set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem) {
2099   // Set fixed predefined input arguments
2100   call->init_req(TypeFunc::Control, control());
2101   call->init_req(TypeFunc::I_O, top()); // does no i/o
2102   call->init_req(TypeFunc::ReturnAdr, top());
2103   if (call->is_CallLeafPure()) {
2104     call->init_req(TypeFunc::Memory, top());
2105     call->init_req(TypeFunc::FramePtr, top());
2106     return nullptr;
2107   } else {
2108     Node* memory = reset_memory();
2109     Node* m = narrow_mem == nullptr ? memory : narrow_mem;
2110     call->init_req(TypeFunc::Memory, m); // may gc ptrs
2111     call->init_req(TypeFunc::FramePtr, frameptr());
2112     return memory;
2113   }
2114 }
2115 
2116 //-------------------set_predefined_output_for_runtime_call--------------------
2117 // Set control and memory (not i_o) from the call.
2118 // If keep_mem is not null, use it for the output state,
2119 // except for the RawPtr output of the call, if hook_mem is TypeRawPtr::BOTTOM.
2120 // If hook_mem is null, this call produces no memory effects at all.
2121 // If hook_mem is a Java-visible memory slice (such as arraycopy operands),
2122 // then only that memory slice is taken from the call.
2123 // In the last case, we must put an appropriate memory barrier before
2124 // the call, so as to create the correct anti-dependencies on loads
2125 // preceding the call.
2126 void GraphKit::set_predefined_output_for_runtime_call(Node* call,
2127                                                       Node* keep_mem,
2128                                                       const TypePtr* hook_mem) {
2129   // no i/o
2130   set_control(_gvn.transform( new ProjNode(call,TypeFunc::Control) ));
2131   if (call->is_CallLeafPure()) {
2132     // Pure function have only control (for now) and data output, in particular
2133     // they don't touch the memory, so we don't want a memory proj that is set after.
2134     return;
2135   }
2136   if (keep_mem) {
2137     // First clone the existing memory state
2138     set_all_memory(keep_mem);
2139     if (hook_mem != nullptr) {
2140       // Make memory for the call
2141       Node* mem = _gvn.transform( new ProjNode(call, TypeFunc::Memory) );
2142       // Set the RawPtr memory state only.  This covers all the heap top/GC stuff
2143       // We also use hook_mem to extract specific effects from arraycopy stubs.
2144       set_memory(mem, hook_mem);
2145     }
2146     // ...else the call has NO memory effects.
2147 
2148     // Make sure the call advertises its memory effects precisely.
2149     // This lets us build accurate anti-dependences in gcm.cpp.
2150     assert(C->alias_type(call->adr_type()) == C->alias_type(hook_mem),
2151            "call node must be constructed correctly");
2152   } else {
2153     assert(hook_mem == nullptr, "");
2154     // This is not a "slow path" call; all memory comes from the call.
2155     set_all_memory_call(call);
2156   }
2157 }
2158 
2159 // Keep track of MergeMems feeding into other MergeMems
2160 static void add_mergemem_users_to_worklist(Unique_Node_List& wl, Node* mem) {
2161   if (!mem->is_MergeMem()) {
2162     return;
2163   }
2164   for (SimpleDUIterator i(mem); i.has_next(); i.next()) {
2165     Node* use = i.get();
2166     if (use->is_MergeMem()) {
2167       wl.push(use);
2168     }
2169   }
2170 }
2171 
2172 // Replace the call with the current state of the kit.
2173 void GraphKit::replace_call(CallNode* call, Node* result, bool do_replaced_nodes, bool do_asserts) {
2174   JVMState* ejvms = nullptr;
2175   if (has_exceptions()) {
2176     ejvms = transfer_exceptions_into_jvms();
2177   }
2178 
2179   ReplacedNodes replaced_nodes = map()->replaced_nodes();
2180   ReplacedNodes replaced_nodes_exception;
2181   Node* ex_ctl = top();
2182 
2183   SafePointNode* final_state = stop();
2184 
2185   // Find all the needed outputs of this call
2186   CallProjections* callprojs = call->extract_projections(true, do_asserts);
2187 
2188   Unique_Node_List wl;
2189   Node* init_mem = call->in(TypeFunc::Memory);
2190   Node* final_mem = final_state->in(TypeFunc::Memory);
2191   Node* final_ctl = final_state->in(TypeFunc::Control);
2192   Node* final_io = final_state->in(TypeFunc::I_O);
2193 
2194   // Replace all the old call edges with the edges from the inlining result
2195   if (callprojs->fallthrough_catchproj != nullptr) {
2196     C->gvn_replace_by(callprojs->fallthrough_catchproj, final_ctl);
2197   }
2198   if (callprojs->fallthrough_memproj != nullptr) {
2199     if (final_mem->is_MergeMem()) {
2200       // Parser's exits MergeMem was not transformed but may be optimized
2201       final_mem = _gvn.transform(final_mem);
2202     }
2203     C->gvn_replace_by(callprojs->fallthrough_memproj,   final_mem);
2204     add_mergemem_users_to_worklist(wl, final_mem);
2205   }
2206   if (callprojs->fallthrough_ioproj != nullptr) {
2207     C->gvn_replace_by(callprojs->fallthrough_ioproj,    final_io);
2208   }
2209 
2210   // Replace the result with the new result if it exists and is used
2211   if (callprojs->resproj[0] != nullptr && result != nullptr) {
2212     // If the inlined code is dead, the result projections for an inline type returned as
2213     // fields have not been replaced. They will go away once the call is replaced by TOP below.
2214     assert(callprojs->nb_resproj == 1 || (call->tf()->returns_inline_type_as_fields() && stopped()),
2215            "unexpected number of results");
2216     C->gvn_replace_by(callprojs->resproj[0], result);
2217   }
2218 
2219   if (ejvms == nullptr) {
2220     // No exception edges to simply kill off those paths
2221     if (callprojs->catchall_catchproj != nullptr) {
2222       C->gvn_replace_by(callprojs->catchall_catchproj, C->top());
2223     }
2224     if (callprojs->catchall_memproj != nullptr) {
2225       C->gvn_replace_by(callprojs->catchall_memproj,   C->top());
2226     }
2227     if (callprojs->catchall_ioproj != nullptr) {
2228       C->gvn_replace_by(callprojs->catchall_ioproj,    C->top());
2229     }
2230     // Replace the old exception object with top
2231     if (callprojs->exobj != nullptr) {
2232       C->gvn_replace_by(callprojs->exobj, C->top());
2233     }
2234   } else {
2235     GraphKit ekit(ejvms);
2236 
2237     // Load my combined exception state into the kit, with all phis transformed:
2238     SafePointNode* ex_map = ekit.combine_and_pop_all_exception_states();
2239     replaced_nodes_exception = ex_map->replaced_nodes();
2240 
2241     Node* ex_oop = ekit.use_exception_state(ex_map);
2242 
2243     if (callprojs->catchall_catchproj != nullptr) {
2244       C->gvn_replace_by(callprojs->catchall_catchproj, ekit.control());
2245       ex_ctl = ekit.control();
2246     }
2247     if (callprojs->catchall_memproj != nullptr) {
2248       Node* ex_mem = ekit.reset_memory();
2249       C->gvn_replace_by(callprojs->catchall_memproj,   ex_mem);
2250       add_mergemem_users_to_worklist(wl, ex_mem);
2251     }
2252     if (callprojs->catchall_ioproj != nullptr) {
2253       C->gvn_replace_by(callprojs->catchall_ioproj,    ekit.i_o());
2254     }
2255 
2256     // Replace the old exception object with the newly created one
2257     if (callprojs->exobj != nullptr) {
2258       C->gvn_replace_by(callprojs->exobj, ex_oop);
2259     }
2260   }
2261 
2262   // Disconnect the call from the graph
2263   call->disconnect_inputs(C);
2264   C->gvn_replace_by(call, C->top());
2265 
2266   // Clean up any MergeMems that feed other MergeMems since the
2267   // optimizer doesn't like that.
2268   while (wl.size() > 0) {
2269     _gvn.transform(wl.pop());
2270   }
2271 
2272   if (callprojs->fallthrough_catchproj != nullptr && !final_ctl->is_top() && do_replaced_nodes) {
2273     replaced_nodes.apply(C, final_ctl);
2274   }
2275   if (!ex_ctl->is_top() && do_replaced_nodes) {
2276     replaced_nodes_exception.apply(C, ex_ctl);
2277   }
2278 }
2279 
2280 
2281 //------------------------------increment_counter------------------------------
2282 // for statistics: increment a VM counter by 1
2283 
2284 void GraphKit::increment_counter(address counter_addr) {
2285   Node* adr1 = makecon(TypeRawPtr::make(counter_addr));
2286   increment_counter(adr1);
2287 }
2288 
2289 void GraphKit::increment_counter(Node* counter_addr) {
2290   Node* ctrl = control();
2291   Node* cnt  = make_load(ctrl, counter_addr, TypeLong::LONG, T_LONG, MemNode::unordered);
2292   Node* incr = _gvn.transform(new AddLNode(cnt, _gvn.longcon(1)));
2293   store_to_memory(ctrl, counter_addr, incr, T_LONG, MemNode::unordered);
2294 }
2295 
2296 
2297 //------------------------------uncommon_trap----------------------------------
2298 // Bail out to the interpreter in mid-method.  Implemented by calling the
2299 // uncommon_trap blob.  This helper function inserts a runtime call with the
2300 // right debug info.
2301 Node* GraphKit::uncommon_trap(int trap_request,
2302                              ciKlass* klass, const char* comment,
2303                              bool must_throw,
2304                              bool keep_exact_action) {
2305   if (failing_internal()) {
2306     stop();
2307   }
2308   if (stopped())  return nullptr; // trap reachable?
2309 
2310   // Note:  If ProfileTraps is true, and if a deopt. actually
2311   // occurs here, the runtime will make sure an MDO exists.  There is
2312   // no need to call method()->ensure_method_data() at this point.
2313 
2314   // Set the stack pointer to the right value for reexecution:
2315   set_sp(reexecute_sp());
2316 
2317 #ifdef ASSERT
2318   if (!must_throw) {
2319     // Make sure the stack has at least enough depth to execute
2320     // the current bytecode.
2321     int inputs, ignored_depth;
2322     if (compute_stack_effects(inputs, ignored_depth)) {
2323       assert(sp() >= inputs, "must have enough JVMS stack to execute %s: sp=%d, inputs=%d",
2324              Bytecodes::name(java_bc()), sp(), inputs);
2325     }
2326   }
2327 #endif
2328 
2329   Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(trap_request);
2330   Deoptimization::DeoptAction action = Deoptimization::trap_request_action(trap_request);
2331 
2332   switch (action) {
2333   case Deoptimization::Action_maybe_recompile:
2334   case Deoptimization::Action_reinterpret:
2335     // Temporary fix for 6529811 to allow virtual calls to be sure they
2336     // get the chance to go from mono->bi->mega
2337     if (!keep_exact_action &&
2338         Deoptimization::trap_request_index(trap_request) < 0 &&
2339         too_many_recompiles(reason)) {
2340       // This BCI is causing too many recompilations.
2341       if (C->log() != nullptr) {
2342         C->log()->elem("observe that='trap_action_change' reason='%s' from='%s' to='none'",
2343                 Deoptimization::trap_reason_name(reason),
2344                 Deoptimization::trap_action_name(action));
2345       }
2346       action = Deoptimization::Action_none;
2347       trap_request = Deoptimization::make_trap_request(reason, action);
2348     } else {
2349       C->set_trap_can_recompile(true);
2350     }
2351     break;
2352   case Deoptimization::Action_make_not_entrant:
2353     C->set_trap_can_recompile(true);
2354     break;
2355   case Deoptimization::Action_none:
2356   case Deoptimization::Action_make_not_compilable:
2357     break;
2358   default:
2359 #ifdef ASSERT
2360     fatal("unknown action %d: %s", action, Deoptimization::trap_action_name(action));
2361 #endif
2362     break;
2363   }
2364 
2365   if (TraceOptoParse) {
2366     char buf[100];
2367     tty->print_cr("Uncommon trap %s at bci:%d",
2368                   Deoptimization::format_trap_request(buf, sizeof(buf),
2369                                                       trap_request), bci());
2370   }
2371 
2372   CompileLog* log = C->log();
2373   if (log != nullptr) {
2374     int kid = (klass == nullptr)? -1: log->identify(klass);
2375     log->begin_elem("uncommon_trap bci='%d'", bci());
2376     char buf[100];
2377     log->print(" %s", Deoptimization::format_trap_request(buf, sizeof(buf),
2378                                                           trap_request));
2379     if (kid >= 0)         log->print(" klass='%d'", kid);
2380     if (comment != nullptr)  log->print(" comment='%s'", comment);
2381     log->end_elem();
2382   }
2383 
2384   // Make sure any guarding test views this path as very unlikely
2385   Node *i0 = control()->in(0);
2386   if (i0 != nullptr && i0->is_If()) {        // Found a guarding if test?
2387     IfNode *iff = i0->as_If();
2388     float f = iff->_prob;   // Get prob
2389     if (control()->Opcode() == Op_IfTrue) {
2390       if (f > PROB_UNLIKELY_MAG(4))
2391         iff->_prob = PROB_MIN;
2392     } else {
2393       if (f < PROB_LIKELY_MAG(4))
2394         iff->_prob = PROB_MAX;
2395     }
2396   }
2397 
2398   // Clear out dead values from the debug info.
2399   kill_dead_locals();
2400 
2401   // Now insert the uncommon trap subroutine call
2402   address call_addr = OptoRuntime::uncommon_trap_blob()->entry_point();
2403   const TypePtr* no_memory_effects = nullptr;
2404   // Pass the index of the class to be loaded
2405   Node* call = make_runtime_call(RC_NO_LEAF | RC_UNCOMMON |
2406                                  (must_throw ? RC_MUST_THROW : 0),
2407                                  OptoRuntime::uncommon_trap_Type(),
2408                                  call_addr, "uncommon_trap", no_memory_effects,
2409                                  intcon(trap_request));
2410   assert(call->as_CallStaticJava()->uncommon_trap_request() == trap_request,
2411          "must extract request correctly from the graph");
2412   assert(trap_request != 0, "zero value reserved by uncommon_trap_request");
2413 
2414   call->set_req(TypeFunc::ReturnAdr, returnadr());
2415   // The debug info is the only real input to this call.
2416 
2417   // Halt-and-catch fire here.  The above call should never return!
2418   HaltNode* halt = new HaltNode(control(), frameptr(), "uncommon trap returned which should never happen"
2419                                                        PRODUCT_ONLY(COMMA /*reachable*/false));
2420   _gvn.set_type_bottom(halt);
2421   root()->add_req(halt);
2422 
2423   stop_and_kill_map();
2424   return call;
2425 }
2426 
2427 
2428 //--------------------------just_allocated_object------------------------------
2429 // Report the object that was just allocated.
2430 // It must be the case that there are no intervening safepoints.
2431 // We use this to determine if an object is so "fresh" that
2432 // it does not require card marks.
2433 Node* GraphKit::just_allocated_object(Node* current_control) {
2434   Node* ctrl = current_control;
2435   // Object::<init> is invoked after allocation, most of invoke nodes
2436   // will be reduced, but a region node is kept in parse time, we check
2437   // the pattern and skip the region node if it degraded to a copy.
2438   if (ctrl != nullptr && ctrl->is_Region() && ctrl->req() == 2 &&
2439       ctrl->as_Region()->is_copy()) {
2440     ctrl = ctrl->as_Region()->is_copy();
2441   }
2442   if (C->recent_alloc_ctl() == ctrl) {
2443    return C->recent_alloc_obj();
2444   }
2445   return nullptr;
2446 }
2447 
2448 
2449 /**
2450  * Record profiling data exact_kls for Node n with the type system so
2451  * that it can propagate it (speculation)
2452  *
2453  * @param n          node that the type applies to
2454  * @param exact_kls  type from profiling
2455  * @param maybe_null did profiling see null?
2456  *
2457  * @return           node with improved type
2458  */
2459 Node* GraphKit::record_profile_for_speculation(Node* n, ciKlass* exact_kls, ProfilePtrKind ptr_kind) {
2460   const Type* current_type = _gvn.type(n);
2461   assert(UseTypeSpeculation, "type speculation must be on");
2462 
2463   const TypePtr* speculative = current_type->speculative();
2464 
2465   // Should the klass from the profile be recorded in the speculative type?
2466   if (current_type->would_improve_type(exact_kls, jvms()->depth())) {
2467     const TypeKlassPtr* tklass = TypeKlassPtr::make(exact_kls, Type::trust_interfaces);
2468     const TypeOopPtr* xtype = tklass->as_instance_type();
2469     assert(xtype->klass_is_exact(), "Should be exact");
2470     // Any reason to believe n is not null (from this profiling or a previous one)?
2471     assert(ptr_kind != ProfileAlwaysNull, "impossible here");
2472     const TypePtr* ptr = (ptr_kind != ProfileNeverNull && current_type->speculative_maybe_null()) ? TypePtr::BOTTOM : TypePtr::NOTNULL;
2473     // record the new speculative type's depth
2474     speculative = xtype->cast_to_ptr_type(ptr->ptr())->is_ptr();
2475     speculative = speculative->with_inline_depth(jvms()->depth());
2476   } else if (current_type->would_improve_ptr(ptr_kind)) {
2477     // Profiling report that null was never seen so we can change the
2478     // speculative type to non null ptr.
2479     if (ptr_kind == ProfileAlwaysNull) {
2480       speculative = TypePtr::NULL_PTR;
2481     } else {
2482       assert(ptr_kind == ProfileNeverNull, "nothing else is an improvement");
2483       const TypePtr* ptr = TypePtr::NOTNULL;
2484       if (speculative != nullptr) {
2485         speculative = speculative->cast_to_ptr_type(ptr->ptr())->is_ptr();
2486       } else {
2487         speculative = ptr;
2488       }
2489     }
2490   }
2491 
2492   if (speculative != current_type->speculative()) {
2493     // Build a type with a speculative type (what we think we know
2494     // about the type but will need a guard when we use it)
2495     const TypeOopPtr* spec_type = TypeOopPtr::make(TypePtr::BotPTR, Type::Offset::bottom, TypeOopPtr::InstanceBot, speculative);
2496     // We're changing the type, we need a new CheckCast node to carry
2497     // the new type. The new type depends on the control: what
2498     // profiling tells us is only valid from here as far as we can
2499     // tell.
2500     Node* cast = new CheckCastPPNode(control(), n, current_type->remove_speculative()->join_speculative(spec_type));
2501     cast = _gvn.transform(cast);
2502     replace_in_map(n, cast);
2503     n = cast;
2504   }
2505 
2506   return n;
2507 }
2508 
2509 /**
2510  * Record profiling data from receiver profiling at an invoke with the
2511  * type system so that it can propagate it (speculation)
2512  *
2513  * @param n  receiver node
2514  *
2515  * @return   node with improved type
2516  */
2517 Node* GraphKit::record_profiled_receiver_for_speculation(Node* n) {
2518   if (!UseTypeSpeculation) {
2519     return n;
2520   }
2521   ciKlass* exact_kls = profile_has_unique_klass();
2522   ProfilePtrKind ptr_kind = ProfileMaybeNull;
2523   if ((java_bc() == Bytecodes::_checkcast ||
2524        java_bc() == Bytecodes::_instanceof ||
2525        java_bc() == Bytecodes::_aastore) &&
2526       method()->method_data()->is_mature()) {
2527     ciProfileData* data = method()->method_data()->bci_to_data(bci());
2528     if (data != nullptr) {
2529       if (java_bc() == Bytecodes::_aastore) {
2530         ciKlass* array_type = nullptr;
2531         ciKlass* element_type = nullptr;
2532         ProfilePtrKind element_ptr = ProfileMaybeNull;
2533         bool flat_array = true;
2534         bool null_free_array = true;
2535         method()->array_access_profiled_type(bci(), array_type, element_type, element_ptr, flat_array, null_free_array);
2536         exact_kls = element_type;
2537         ptr_kind = element_ptr;
2538       } else {
2539         if (!data->as_BitData()->null_seen()) {
2540           ptr_kind = ProfileNeverNull;
2541         } else {
2542           if (TypeProfileCasts) {
2543             assert(data->is_ReceiverTypeData(), "bad profile data type");
2544             ciReceiverTypeData* call = (ciReceiverTypeData*)data->as_ReceiverTypeData();
2545             uint i = 0;
2546             for (; i < call->row_limit(); i++) {
2547               ciKlass* receiver = call->receiver(i);
2548               if (receiver != nullptr) {
2549                 break;
2550               }
2551             }
2552             ptr_kind = (i == call->row_limit()) ? ProfileAlwaysNull : ProfileMaybeNull;
2553           }
2554         }
2555       }
2556     }
2557   }
2558   return record_profile_for_speculation(n, exact_kls, ptr_kind);
2559 }
2560 
2561 /**
2562  * Record profiling data from argument profiling at an invoke with the
2563  * type system so that it can propagate it (speculation)
2564  *
2565  * @param dest_method  target method for the call
2566  * @param bc           what invoke bytecode is this?
2567  */
2568 void GraphKit::record_profiled_arguments_for_speculation(ciMethod* dest_method, Bytecodes::Code bc) {
2569   if (!UseTypeSpeculation) {
2570     return;
2571   }
2572   const TypeFunc* tf    = TypeFunc::make(dest_method);
2573   int             nargs = tf->domain_sig()->cnt() - TypeFunc::Parms;
2574   int skip = Bytecodes::has_receiver(bc) ? 1 : 0;
2575   for (int j = skip, i = 0; j < nargs && i < TypeProfileArgsLimit; j++) {
2576     const Type *targ = tf->domain_sig()->field_at(j + TypeFunc::Parms);
2577     if (is_reference_type(targ->basic_type())) {
2578       ProfilePtrKind ptr_kind = ProfileMaybeNull;
2579       ciKlass* better_type = nullptr;
2580       if (method()->argument_profiled_type(bci(), i, better_type, ptr_kind)) {
2581         record_profile_for_speculation(argument(j), better_type, ptr_kind);
2582       }
2583       i++;
2584     }
2585   }
2586 }
2587 
2588 /**
2589  * Record profiling data from parameter profiling at an invoke with
2590  * the type system so that it can propagate it (speculation)
2591  */
2592 void GraphKit::record_profiled_parameters_for_speculation() {
2593   if (!UseTypeSpeculation) {
2594     return;
2595   }
2596   for (int i = 0, j = 0; i < method()->arg_size() ; i++) {
2597     if (_gvn.type(local(i))->isa_oopptr()) {
2598       ProfilePtrKind ptr_kind = ProfileMaybeNull;
2599       ciKlass* better_type = nullptr;
2600       if (method()->parameter_profiled_type(j, better_type, ptr_kind)) {
2601         record_profile_for_speculation(local(i), better_type, ptr_kind);
2602       }
2603       j++;
2604     }
2605   }
2606 }
2607 
2608 /**
2609  * Record profiling data from return value profiling at an invoke with
2610  * the type system so that it can propagate it (speculation)
2611  */
2612 void GraphKit::record_profiled_return_for_speculation() {
2613   if (!UseTypeSpeculation) {
2614     return;
2615   }
2616   ProfilePtrKind ptr_kind = ProfileMaybeNull;
2617   ciKlass* better_type = nullptr;
2618   if (method()->return_profiled_type(bci(), better_type, ptr_kind)) {
2619     // If profiling reports a single type for the return value,
2620     // feed it to the type system so it can propagate it as a
2621     // speculative type
2622     record_profile_for_speculation(stack(sp()-1), better_type, ptr_kind);
2623   }
2624 }
2625 
2626 
2627 //=============================================================================
2628 // Generate a fast path/slow path idiom.  Graph looks like:
2629 // [foo] indicates that 'foo' is a parameter
2630 //
2631 //              [in]     null
2632 //                 \    /
2633 //                  CmpP
2634 //                  Bool ne
2635 //                   If
2636 //                  /  \
2637 //              True    False-<2>
2638 //              / |
2639 //             /  cast_not_null
2640 //           Load  |    |   ^
2641 //        [fast_test]   |   |
2642 // gvn to   opt_test    |   |
2643 //          /    \      |  <1>
2644 //      True     False  |
2645 //        |         \\  |
2646 //   [slow_call]     \[fast_result]
2647 //    Ctl   Val       \      \
2648 //     |               \      \
2649 //    Catch       <1>   \      \
2650 //   /    \        ^     \      \
2651 //  Ex    No_Ex    |      \      \
2652 //  |       \   \  |       \ <2>  \
2653 //  ...      \  [slow_res] |  |    \   [null_result]
2654 //            \         \--+--+---  |  |
2655 //             \           | /    \ | /
2656 //              --------Region     Phi
2657 //
2658 //=============================================================================
2659 // Code is structured as a series of driver functions all called 'do_XXX' that
2660 // call a set of helper functions.  Helper functions first, then drivers.
2661 
2662 //------------------------------null_check_oop---------------------------------
2663 // Null check oop.  Set null-path control into Region in slot 3.
2664 // Make a cast-not-nullness use the other not-null control.  Return cast.
2665 Node* GraphKit::null_check_oop(Node* value, Node* *null_control,
2666                                bool never_see_null,
2667                                bool safe_for_replace,
2668                                bool speculative) {
2669   // Initial null check taken path
2670   (*null_control) = top();
2671   Node* cast = null_check_common(value, T_OBJECT, false, null_control, speculative);
2672 
2673   // Generate uncommon_trap:
2674   if (never_see_null && (*null_control) != top()) {
2675     // If we see an unexpected null at a check-cast we record it and force a
2676     // recompile; the offending check-cast will be compiled to handle nulls.
2677     // If we see more than one offending BCI, then all checkcasts in the
2678     // method will be compiled to handle nulls.
2679     PreserveJVMState pjvms(this);
2680     set_control(*null_control);
2681     replace_in_map(value, null());
2682     Deoptimization::DeoptReason reason = Deoptimization::reason_null_check(speculative);
2683     uncommon_trap(reason,
2684                   Deoptimization::Action_make_not_entrant);
2685     (*null_control) = top();    // null path is dead
2686   }
2687   if ((*null_control) == top() && safe_for_replace) {
2688     replace_in_map(value, cast);
2689   }
2690 
2691   // Cast away null-ness on the result
2692   return cast;
2693 }
2694 
2695 //------------------------------opt_iff----------------------------------------
2696 // Optimize the fast-check IfNode.  Set the fast-path region slot 2.
2697 // Return slow-path control.
2698 Node* GraphKit::opt_iff(Node* region, Node* iff) {
2699   IfNode *opt_iff = _gvn.transform(iff)->as_If();
2700 
2701   // Fast path taken; set region slot 2
2702   Node *fast_taken = _gvn.transform( new IfFalseNode(opt_iff) );
2703   region->init_req(2,fast_taken); // Capture fast-control
2704 
2705   // Fast path not-taken, i.e. slow path
2706   Node *slow_taken = _gvn.transform( new IfTrueNode(opt_iff) );
2707   return slow_taken;
2708 }
2709 
2710 //-----------------------------make_runtime_call-------------------------------
2711 Node* GraphKit::make_runtime_call(int flags,
2712                                   const TypeFunc* call_type, address call_addr,
2713                                   const char* call_name,
2714                                   const TypePtr* adr_type,
2715                                   // The following parms are all optional.
2716                                   // The first null ends the list.
2717                                   Node* parm0, Node* parm1,
2718                                   Node* parm2, Node* parm3,
2719                                   Node* parm4, Node* parm5,
2720                                   Node* parm6, Node* parm7) {
2721   assert(call_addr != nullptr, "must not call null targets");
2722 
2723   // Slow-path call
2724   bool is_leaf = !(flags & RC_NO_LEAF);
2725   bool has_io  = (!is_leaf && !(flags & RC_NO_IO));
2726   if (call_name == nullptr) {
2727     assert(!is_leaf, "must supply name for leaf");
2728     call_name = OptoRuntime::stub_name(call_addr);
2729   }
2730   CallNode* call;
2731   if (!is_leaf) {
2732     call = new CallStaticJavaNode(call_type, call_addr, call_name, adr_type);
2733   } else if (flags & RC_NO_FP) {
2734     call = new CallLeafNoFPNode(call_type, call_addr, call_name, adr_type);
2735   } else  if (flags & RC_VECTOR){
2736     uint num_bits = call_type->range_sig()->field_at(TypeFunc::Parms)->is_vect()->length_in_bytes() * BitsPerByte;
2737     call = new CallLeafVectorNode(call_type, call_addr, call_name, adr_type, num_bits);
2738   } else if (flags & RC_PURE) {
2739     call = new CallLeafPureNode(call_type, call_addr, call_name, adr_type);
2740   } else {
2741     call = new CallLeafNode(call_type, call_addr, call_name, adr_type);
2742   }
2743 
2744   // The following is similar to set_edges_for_java_call,
2745   // except that the memory effects of the call are restricted to AliasIdxRaw.
2746 
2747   // Slow path call has no side-effects, uses few values
2748   bool wide_in  = !(flags & RC_NARROW_MEM);
2749   bool wide_out = (C->get_alias_index(adr_type) == Compile::AliasIdxBot);
2750 
2751   Node* prev_mem = nullptr;
2752   if (wide_in) {
2753     prev_mem = set_predefined_input_for_runtime_call(call);
2754   } else {
2755     assert(!wide_out, "narrow in => narrow out");
2756     Node* narrow_mem = memory(adr_type);
2757     prev_mem = set_predefined_input_for_runtime_call(call, narrow_mem);
2758   }
2759 
2760   // Hook each parm in order.  Stop looking at the first null.
2761   if (parm0 != nullptr) { call->init_req(TypeFunc::Parms+0, parm0);
2762   if (parm1 != nullptr) { call->init_req(TypeFunc::Parms+1, parm1);
2763   if (parm2 != nullptr) { call->init_req(TypeFunc::Parms+2, parm2);
2764   if (parm3 != nullptr) { call->init_req(TypeFunc::Parms+3, parm3);
2765   if (parm4 != nullptr) { call->init_req(TypeFunc::Parms+4, parm4);
2766   if (parm5 != nullptr) { call->init_req(TypeFunc::Parms+5, parm5);
2767   if (parm6 != nullptr) { call->init_req(TypeFunc::Parms+6, parm6);
2768   if (parm7 != nullptr) { call->init_req(TypeFunc::Parms+7, parm7);
2769   /* close each nested if ===> */  } } } } } } } }
2770   assert(call->in(call->req()-1) != nullptr || (call->req()-1) > (TypeFunc::Parms+7), "must initialize all parms");
2771 
2772   if (!is_leaf) {
2773     // Non-leaves can block and take safepoints:
2774     add_safepoint_edges(call, ((flags & RC_MUST_THROW) != 0));
2775   }
2776   // Non-leaves can throw exceptions:
2777   if (has_io) {
2778     call->set_req(TypeFunc::I_O, i_o());
2779   }
2780 
2781   if (flags & RC_UNCOMMON) {
2782     // Set the count to a tiny probability.  Cf. Estimate_Block_Frequency.
2783     // (An "if" probability corresponds roughly to an unconditional count.
2784     // Sort of.)
2785     call->set_cnt(PROB_UNLIKELY_MAG(4));
2786   }
2787 
2788   Node* c = _gvn.transform(call);
2789   assert(c == call, "cannot disappear");
2790 
2791   if (wide_out) {
2792     // Slow path call has full side-effects.
2793     set_predefined_output_for_runtime_call(call);
2794   } else {
2795     // Slow path call has few side-effects, and/or sets few values.
2796     set_predefined_output_for_runtime_call(call, prev_mem, adr_type);
2797   }
2798 
2799   if (has_io) {
2800     set_i_o(_gvn.transform(new ProjNode(call, TypeFunc::I_O)));
2801   }
2802   return call;
2803 
2804 }
2805 
2806 // i2b
2807 Node* GraphKit::sign_extend_byte(Node* in) {
2808   Node* tmp = _gvn.transform(new LShiftINode(in, _gvn.intcon(24)));
2809   return _gvn.transform(new RShiftINode(tmp, _gvn.intcon(24)));
2810 }
2811 
2812 // i2s
2813 Node* GraphKit::sign_extend_short(Node* in) {
2814   Node* tmp = _gvn.transform(new LShiftINode(in, _gvn.intcon(16)));
2815   return _gvn.transform(new RShiftINode(tmp, _gvn.intcon(16)));
2816 }
2817 
2818 
2819 //------------------------------merge_memory-----------------------------------
2820 // Merge memory from one path into the current memory state.
2821 void GraphKit::merge_memory(Node* new_mem, Node* region, int new_path) {
2822   for (MergeMemStream mms(merged_memory(), new_mem->as_MergeMem()); mms.next_non_empty2(); ) {
2823     Node* old_slice = mms.force_memory();
2824     Node* new_slice = mms.memory2();
2825     if (old_slice != new_slice) {
2826       PhiNode* phi;
2827       if (old_slice->is_Phi() && old_slice->as_Phi()->region() == region) {
2828         if (mms.is_empty()) {
2829           // clone base memory Phi's inputs for this memory slice
2830           assert(old_slice == mms.base_memory(), "sanity");
2831           phi = PhiNode::make(region, nullptr, Type::MEMORY, mms.adr_type(C));
2832           _gvn.set_type(phi, Type::MEMORY);
2833           for (uint i = 1; i < phi->req(); i++) {
2834             phi->init_req(i, old_slice->in(i));
2835           }
2836         } else {
2837           phi = old_slice->as_Phi(); // Phi was generated already
2838         }
2839       } else {
2840         phi = PhiNode::make(region, old_slice, Type::MEMORY, mms.adr_type(C));
2841         _gvn.set_type(phi, Type::MEMORY);
2842       }
2843       phi->set_req(new_path, new_slice);
2844       mms.set_memory(phi);
2845     }
2846   }
2847 }
2848 
2849 //------------------------------make_slow_call_ex------------------------------
2850 // Make the exception handler hookups for the slow call
2851 void GraphKit::make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize) {
2852   if (stopped())  return;
2853 
2854   // Make a catch node with just two handlers:  fall-through and catch-all
2855   Node* i_o  = _gvn.transform( new ProjNode(call, TypeFunc::I_O, separate_io_proj) );
2856   Node* catc = _gvn.transform( new CatchNode(control(), i_o, 2) );
2857   Node* norm = new CatchProjNode(catc, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci);
2858   _gvn.set_type_bottom(norm);
2859   C->record_for_igvn(norm);
2860   Node* excp = _gvn.transform( new CatchProjNode(catc, CatchProjNode::catch_all_index,    CatchProjNode::no_handler_bci) );
2861 
2862   { PreserveJVMState pjvms(this);
2863     set_control(excp);
2864     set_i_o(i_o);
2865 
2866     if (excp != top()) {
2867       if (deoptimize) {
2868         // Deoptimize if an exception is caught. Don't construct exception state in this case.
2869         uncommon_trap(Deoptimization::Reason_unhandled,
2870                       Deoptimization::Action_none);
2871       } else {
2872         // Create an exception state also.
2873         // Use an exact type if the caller has a specific exception.
2874         const Type* ex_type = TypeOopPtr::make_from_klass_unique(ex_klass)->cast_to_ptr_type(TypePtr::NotNull);
2875         Node*       ex_oop  = new CreateExNode(ex_type, control(), i_o);
2876         add_exception_state(make_exception_state(_gvn.transform(ex_oop)));
2877       }
2878     }
2879   }
2880 
2881   // Get the no-exception control from the CatchNode.
2882   set_control(norm);
2883 }
2884 
2885 static IfNode* gen_subtype_check_compare(Node* ctrl, Node* in1, Node* in2, BoolTest::mask test, float p, PhaseGVN& gvn, BasicType bt) {
2886   Node* cmp = nullptr;
2887   switch(bt) {
2888   case T_INT: cmp = new CmpINode(in1, in2); break;
2889   case T_ADDRESS: cmp = new CmpPNode(in1, in2); break;
2890   default: fatal("unexpected comparison type %s", type2name(bt));
2891   }
2892   cmp = gvn.transform(cmp);
2893   Node* bol = gvn.transform(new BoolNode(cmp, test));
2894   IfNode* iff = new IfNode(ctrl, bol, p, COUNT_UNKNOWN);
2895   gvn.transform(iff);
2896   if (!bol->is_Con()) gvn.record_for_igvn(iff);
2897   return iff;
2898 }
2899 
2900 //-------------------------------gen_subtype_check-----------------------------
2901 // Generate a subtyping check.  Takes as input the subtype and supertype.
2902 // Returns 2 values: sets the default control() to the true path and returns
2903 // the false path.  Only reads invariant memory; sets no (visible) memory.
2904 // The PartialSubtypeCheckNode sets the hidden 1-word cache in the encoding
2905 // but that's not exposed to the optimizer.  This call also doesn't take in an
2906 // Object; if you wish to check an Object you need to load the Object's class
2907 // prior to coming here.
2908 Node* Phase::gen_subtype_check(Node* subklass, Node* superklass, Node** ctrl, Node* mem, PhaseGVN& gvn,
2909                                ciMethod* method, int bci) {
2910   Compile* C = gvn.C;
2911   if ((*ctrl)->is_top()) {
2912     return C->top();
2913   }
2914 
2915   const TypeKlassPtr* klass_ptr_type = gvn.type(superklass)->is_klassptr();
2916   // For a direct pointer comparison, we need the refined array klass pointer
2917   Node* vm_superklass = superklass;
2918   if (klass_ptr_type->isa_aryklassptr() && klass_ptr_type->klass_is_exact()) {
2919     assert(!klass_ptr_type->is_aryklassptr()->is_refined_type(), "Unexpected refined array klass pointer");
2920     vm_superklass = gvn.makecon(klass_ptr_type->is_aryklassptr()->cast_to_refined_array_klass_ptr());
2921   }
2922 
2923   // Fast check for identical types, perhaps identical constants.
2924   // The types can even be identical non-constants, in cases
2925   // involving Array.newInstance, Object.clone, etc.
2926   if (subklass == superklass)
2927     return C->top();             // false path is dead; no test needed.
2928 
2929   if (gvn.type(superklass)->singleton()) {
2930     const TypeKlassPtr* superk = gvn.type(superklass)->is_klassptr();
2931     const TypeKlassPtr* subk   = gvn.type(subklass)->is_klassptr();
2932 
2933     // In the common case of an exact superklass, try to fold up the
2934     // test before generating code.  You may ask, why not just generate
2935     // the code and then let it fold up?  The answer is that the generated
2936     // code will necessarily include null checks, which do not always
2937     // completely fold away.  If they are also needless, then they turn
2938     // into a performance loss.  Example:
2939     //    Foo[] fa = blah(); Foo x = fa[0]; fa[1] = x;
2940     // Here, the type of 'fa' is often exact, so the store check
2941     // of fa[1]=x will fold up, without testing the nullness of x.
2942     //
2943     // At macro expansion, we would have already folded the SubTypeCheckNode
2944     // being expanded here because we always perform the static sub type
2945     // check in SubTypeCheckNode::sub() regardless of whether
2946     // StressReflectiveCode is set or not. We can therefore skip this
2947     // static check when StressReflectiveCode is on.
2948     switch (C->static_subtype_check(superk, subk)) {
2949     case Compile::SSC_always_false:
2950       {
2951         Node* always_fail = *ctrl;
2952         *ctrl = gvn.C->top();
2953         return always_fail;
2954       }
2955     case Compile::SSC_always_true:
2956       return C->top();
2957     case Compile::SSC_easy_test:
2958       {
2959         // Just do a direct pointer compare and be done.
2960         IfNode* iff = gen_subtype_check_compare(*ctrl, subklass, vm_superklass, BoolTest::eq, PROB_STATIC_FREQUENT, gvn, T_ADDRESS);
2961         *ctrl = gvn.transform(new IfTrueNode(iff));
2962         return gvn.transform(new IfFalseNode(iff));
2963       }
2964     case Compile::SSC_full_test:
2965       break;
2966     default:
2967       ShouldNotReachHere();
2968     }
2969   }
2970 
2971   // %%% Possible further optimization:  Even if the superklass is not exact,
2972   // if the subklass is the unique subtype of the superklass, the check
2973   // will always succeed.  We could leave a dependency behind to ensure this.
2974 
2975   // First load the super-klass's check-offset
2976   Node *p1 = gvn.transform(new AddPNode(superklass, superklass, gvn.MakeConX(in_bytes(Klass::super_check_offset_offset()))));
2977   Node* m = C->immutable_memory();
2978   Node *chk_off = gvn.transform(new LoadINode(nullptr, m, p1, gvn.type(p1)->is_ptr(), TypeInt::INT, MemNode::unordered));
2979   int cacheoff_con = in_bytes(Klass::secondary_super_cache_offset());
2980   const TypeInt* chk_off_t = chk_off->Value(&gvn)->isa_int();
2981   int chk_off_con = (chk_off_t != nullptr && chk_off_t->is_con()) ? chk_off_t->get_con() : cacheoff_con;
2982   bool might_be_cache = (chk_off_con == cacheoff_con);
2983 
2984   // Load from the sub-klass's super-class display list, or a 1-word cache of
2985   // the secondary superclass list, or a failing value with a sentinel offset
2986   // if the super-klass is an interface or exceptionally deep in the Java
2987   // hierarchy and we have to scan the secondary superclass list the hard way.
2988   // Worst-case type is a little odd: null is allowed as a result (usually
2989   // klass loads can never produce a null).
2990   Node *chk_off_X = chk_off;
2991 #ifdef _LP64
2992   chk_off_X = gvn.transform(new ConvI2LNode(chk_off_X));
2993 #endif
2994   Node *p2 = gvn.transform(new AddPNode(subklass,subklass,chk_off_X));
2995   // For some types like interfaces the following loadKlass is from a 1-word
2996   // cache which is mutable so can't use immutable memory.  Other
2997   // types load from the super-class display table which is immutable.
2998   Node *kmem = C->immutable_memory();
2999   // secondary_super_cache is not immutable but can be treated as such because:
3000   // - no ideal node writes to it in a way that could cause an
3001   //   incorrect/missed optimization of the following Load.
3002   // - it's a cache so, worse case, not reading the latest value
3003   //   wouldn't cause incorrect execution
3004   if (might_be_cache && mem != nullptr) {
3005     kmem = mem->is_MergeMem() ? mem->as_MergeMem()->memory_at(C->get_alias_index(gvn.type(p2)->is_ptr())) : mem;
3006   }
3007   Node* nkls = gvn.transform(LoadKlassNode::make(gvn, kmem, p2, gvn.type(p2)->is_ptr(), TypeInstKlassPtr::OBJECT_OR_NULL));
3008 
3009   // Compile speed common case: ARE a subtype and we canNOT fail
3010   if (superklass == nkls) {
3011     return C->top();             // false path is dead; no test needed.
3012   }
3013 
3014   // Gather the various success & failures here
3015   RegionNode* r_not_subtype = new RegionNode(3);
3016   gvn.record_for_igvn(r_not_subtype);
3017   RegionNode* r_ok_subtype = new RegionNode(4);
3018   gvn.record_for_igvn(r_ok_subtype);
3019 
3020   // If we might perform an expensive check, first try to take advantage of profile data that was attached to the
3021   // SubTypeCheck node
3022   if (might_be_cache && method != nullptr && VM_Version::profile_all_receivers_at_type_check()) {
3023     ciCallProfile profile = method->call_profile_at_bci(bci);
3024     float total_prob = 0;
3025     for (int i = 0; profile.has_receiver(i); ++i) {
3026       float prob = profile.receiver_prob(i);
3027       total_prob += prob;
3028     }
3029     if (total_prob * 100. >= TypeProfileSubTypeCheckCommonThreshold) {
3030       const TypeKlassPtr* superk = gvn.type(superklass)->is_klassptr();
3031       for (int i = 0; profile.has_receiver(i); ++i) {
3032         ciKlass* klass = profile.receiver(i);
3033         const TypeKlassPtr* klass_t = TypeKlassPtr::make(klass);
3034         Compile::SubTypeCheckResult result = C->static_subtype_check(superk, klass_t);
3035         if (result != Compile::SSC_always_true && result != Compile::SSC_always_false) {
3036           continue;
3037         }
3038         if (klass_t->isa_aryklassptr()) {
3039           // For a direct pointer comparison, we need the refined array klass pointer
3040           klass_t = klass_t->is_aryklassptr()->cast_to_refined_array_klass_ptr();
3041         }
3042         float prob = profile.receiver_prob(i);
3043         ConNode* klass_node = gvn.makecon(klass_t);
3044         IfNode* iff = gen_subtype_check_compare(*ctrl, subklass, klass_node, BoolTest::eq, prob, gvn, T_ADDRESS);
3045         Node* iftrue = gvn.transform(new IfTrueNode(iff));
3046 
3047         if (result == Compile::SSC_always_true) {
3048           r_ok_subtype->add_req(iftrue);
3049         } else {
3050           assert(result == Compile::SSC_always_false, "");
3051           r_not_subtype->add_req(iftrue);
3052         }
3053         *ctrl = gvn.transform(new IfFalseNode(iff));
3054       }
3055     }
3056   }
3057 
3058   // See if we get an immediate positive hit.  Happens roughly 83% of the
3059   // time.  Test to see if the value loaded just previously from the subklass
3060   // is exactly the superklass.
3061   IfNode *iff1 = gen_subtype_check_compare(*ctrl, superklass, nkls, BoolTest::eq, PROB_LIKELY(0.83f), gvn, T_ADDRESS);
3062   Node *iftrue1 = gvn.transform( new IfTrueNode (iff1));
3063   *ctrl = gvn.transform(new IfFalseNode(iff1));
3064 
3065   // Compile speed common case: Check for being deterministic right now.  If
3066   // chk_off is a constant and not equal to cacheoff then we are NOT a
3067   // subklass.  In this case we need exactly the 1 test above and we can
3068   // return those results immediately.
3069   if (!might_be_cache) {
3070     Node* not_subtype_ctrl = *ctrl;
3071     *ctrl = iftrue1; // We need exactly the 1 test above
3072     PhaseIterGVN* igvn = gvn.is_IterGVN();
3073     if (igvn != nullptr) {
3074       igvn->remove_globally_dead_node(r_ok_subtype);
3075       igvn->remove_globally_dead_node(r_not_subtype);
3076     }
3077     return not_subtype_ctrl;
3078   }
3079 
3080   r_ok_subtype->init_req(1, iftrue1);
3081 
3082   // Check for immediate negative hit.  Happens roughly 11% of the time (which
3083   // is roughly 63% of the remaining cases).  Test to see if the loaded
3084   // check-offset points into the subklass display list or the 1-element
3085   // cache.  If it points to the display (and NOT the cache) and the display
3086   // missed then it's not a subtype.
3087   Node *cacheoff = gvn.intcon(cacheoff_con);
3088   IfNode *iff2 = gen_subtype_check_compare(*ctrl, chk_off, cacheoff, BoolTest::ne, PROB_LIKELY(0.63f), gvn, T_INT);
3089   r_not_subtype->init_req(1, gvn.transform(new IfTrueNode (iff2)));
3090   *ctrl = gvn.transform(new IfFalseNode(iff2));
3091 
3092   // Check for self.  Very rare to get here, but it is taken 1/3 the time.
3093   // No performance impact (too rare) but allows sharing of secondary arrays
3094   // which has some footprint reduction.
3095   IfNode *iff3 = gen_subtype_check_compare(*ctrl, subklass, vm_superklass, BoolTest::eq, PROB_LIKELY(0.36f), gvn, T_ADDRESS);
3096   r_ok_subtype->init_req(2, gvn.transform(new IfTrueNode(iff3)));
3097   *ctrl = gvn.transform(new IfFalseNode(iff3));
3098 
3099   // -- Roads not taken here: --
3100   // We could also have chosen to perform the self-check at the beginning
3101   // of this code sequence, as the assembler does.  This would not pay off
3102   // the same way, since the optimizer, unlike the assembler, can perform
3103   // static type analysis to fold away many successful self-checks.
3104   // Non-foldable self checks work better here in second position, because
3105   // the initial primary superclass check subsumes a self-check for most
3106   // types.  An exception would be a secondary type like array-of-interface,
3107   // which does not appear in its own primary supertype display.
3108   // Finally, we could have chosen to move the self-check into the
3109   // PartialSubtypeCheckNode, and from there out-of-line in a platform
3110   // dependent manner.  But it is worthwhile to have the check here,
3111   // where it can be perhaps be optimized.  The cost in code space is
3112   // small (register compare, branch).
3113 
3114   // Now do a linear scan of the secondary super-klass array.  Again, no real
3115   // performance impact (too rare) but it's gotta be done.
3116   // Since the code is rarely used, there is no penalty for moving it
3117   // out of line, and it can only improve I-cache density.
3118   // The decision to inline or out-of-line this final check is platform
3119   // dependent, and is found in the AD file definition of PartialSubtypeCheck.
3120   Node* psc = gvn.transform(
3121     new PartialSubtypeCheckNode(*ctrl, subklass, superklass));
3122 
3123   IfNode *iff4 = gen_subtype_check_compare(*ctrl, psc, gvn.zerocon(T_OBJECT), BoolTest::ne, PROB_FAIR, gvn, T_ADDRESS);
3124   r_not_subtype->init_req(2, gvn.transform(new IfTrueNode (iff4)));
3125   r_ok_subtype ->init_req(3, gvn.transform(new IfFalseNode(iff4)));
3126 
3127   // Return false path; set default control to true path.
3128   *ctrl = gvn.transform(r_ok_subtype);
3129   return gvn.transform(r_not_subtype);
3130 }
3131 
3132 Node* GraphKit::gen_subtype_check(Node* obj_or_subklass, Node* superklass) {
3133   const Type* sub_t = _gvn.type(obj_or_subklass);
3134   if (sub_t->make_oopptr() != nullptr && sub_t->make_oopptr()->is_inlinetypeptr()) {
3135     sub_t = TypeKlassPtr::make(sub_t->inline_klass());
3136     obj_or_subklass = makecon(sub_t);
3137   }
3138   bool expand_subtype_check = C->post_loop_opts_phase(); // macro node expansion is over
3139   if (expand_subtype_check) {
3140     MergeMemNode* mem = merged_memory();
3141     Node* ctrl = control();
3142     Node* subklass = obj_or_subklass;
3143     if (!sub_t->isa_klassptr()) {
3144       subklass = load_object_klass(obj_or_subklass);
3145     }
3146 
3147     Node* n = Phase::gen_subtype_check(subklass, superklass, &ctrl, mem, _gvn, method(), bci());
3148     set_control(ctrl);
3149     return n;
3150   }
3151 
3152   Node* check = _gvn.transform(new SubTypeCheckNode(C, obj_or_subklass, superklass, method(), bci()));
3153   Node* bol = _gvn.transform(new BoolNode(check, BoolTest::eq));
3154   IfNode* iff = create_and_xform_if(control(), bol, PROB_STATIC_FREQUENT, COUNT_UNKNOWN);
3155   set_control(_gvn.transform(new IfTrueNode(iff)));
3156   return _gvn.transform(new IfFalseNode(iff));
3157 }
3158 
3159 // Profile-driven exact type check:
3160 Node* GraphKit::type_check_receiver(Node* receiver, ciKlass* klass,
3161                                     float prob, Node* *casted_receiver) {
3162   assert(!klass->is_interface(), "no exact type check on interfaces");
3163   Node* fail = top();
3164   const Type* rec_t = _gvn.type(receiver);
3165   if (rec_t->is_inlinetypeptr()) {
3166     if (klass->equals(rec_t->inline_klass())) {
3167       (*casted_receiver) = receiver; // Always passes
3168     } else {
3169       (*casted_receiver) = top();    // Always fails
3170       fail = control();
3171       set_control(top());
3172     }
3173     return fail;
3174   }
3175   const TypeKlassPtr* tklass = TypeKlassPtr::make(klass, Type::trust_interfaces);
3176   if (tklass->isa_aryklassptr()) {
3177     // For a direct pointer comparison, we need the refined array klass pointer
3178     tklass = tklass->is_aryklassptr()->cast_to_refined_array_klass_ptr();
3179   }
3180   Node* recv_klass = load_object_klass(receiver);
3181   fail = type_check(recv_klass, tklass, prob);
3182 
3183   if (!stopped()) {
3184     const TypeOopPtr* receiver_type = _gvn.type(receiver)->isa_oopptr();
3185     const TypeOopPtr* recv_xtype = tklass->as_instance_type();
3186     assert(recv_xtype->klass_is_exact(), "");
3187 
3188     if (!receiver_type->higher_equal(recv_xtype)) { // ignore redundant casts
3189       // Subsume downstream occurrences of receiver with a cast to
3190       // recv_xtype, since now we know what the type will be.
3191       Node* cast = new CheckCastPPNode(control(), receiver, recv_xtype);
3192       Node* res = _gvn.transform(cast);
3193       if (recv_xtype->is_inlinetypeptr()) {
3194         assert(!gvn().type(res)->maybe_null(), "receiver should never be null");
3195         res = InlineTypeNode::make_from_oop(this, res, recv_xtype->inline_klass());
3196       }
3197       (*casted_receiver) = res;
3198       assert(!(*casted_receiver)->is_top(), "that path should be unreachable");
3199       // (User must make the replace_in_map call.)
3200     }
3201   }
3202 
3203   return fail;
3204 }
3205 
3206 Node* GraphKit::type_check(Node* recv_klass, const TypeKlassPtr* tklass,
3207                            float prob) {
3208   Node* want_klass = makecon(tklass);
3209   Node* cmp = _gvn.transform(new CmpPNode(recv_klass, want_klass));
3210   Node* bol = _gvn.transform(new BoolNode(cmp, BoolTest::eq));
3211   IfNode* iff = create_and_xform_if(control(), bol, prob, COUNT_UNKNOWN);
3212   set_control(_gvn.transform(new IfTrueNode (iff)));
3213   Node* fail = _gvn.transform(new IfFalseNode(iff));
3214   return fail;
3215 }
3216 
3217 //------------------------------subtype_check_receiver-------------------------
3218 Node* GraphKit::subtype_check_receiver(Node* receiver, ciKlass* klass,
3219                                        Node** casted_receiver) {
3220   const TypeKlassPtr* tklass = TypeKlassPtr::make(klass, Type::trust_interfaces)->try_improve();
3221   Node* want_klass = makecon(tklass);
3222 
3223   Node* slow_ctl = gen_subtype_check(receiver, want_klass);
3224 
3225   // Ignore interface type information until interface types are properly tracked.
3226   if (!stopped() && !klass->is_interface()) {
3227     const TypeOopPtr* receiver_type = _gvn.type(receiver)->isa_oopptr();
3228     const TypeOopPtr* recv_type = tklass->cast_to_exactness(false)->is_klassptr()->as_instance_type();
3229     if (receiver_type != nullptr && !receiver_type->higher_equal(recv_type)) { // ignore redundant casts
3230       Node* cast = _gvn.transform(new CheckCastPPNode(control(), receiver, recv_type));
3231       if (recv_type->is_inlinetypeptr()) {
3232         cast = InlineTypeNode::make_from_oop(this, cast, recv_type->inline_klass());
3233       }
3234       (*casted_receiver) = cast;
3235     }
3236   }
3237 
3238   return slow_ctl;
3239 }
3240 
3241 //------------------------------seems_never_null-------------------------------
3242 // Use null_seen information if it is available from the profile.
3243 // If we see an unexpected null at a type check we record it and force a
3244 // recompile; the offending check will be recompiled to handle nulls.
3245 // If we see several offending BCIs, then all checks in the
3246 // method will be recompiled.
3247 bool GraphKit::seems_never_null(Node* obj, ciProfileData* data, bool& speculating) {
3248   speculating = !_gvn.type(obj)->speculative_maybe_null();
3249   Deoptimization::DeoptReason reason = Deoptimization::reason_null_check(speculating);
3250   if (UncommonNullCast               // Cutout for this technique
3251       && obj != null()               // And not the -Xcomp stupid case?
3252       && !too_many_traps(reason)
3253       ) {
3254     if (speculating) {
3255       return true;
3256     }
3257     if (data == nullptr)
3258       // Edge case:  no mature data.  Be optimistic here.
3259       return true;
3260     // If the profile has not seen a null, assume it won't happen.
3261     assert(java_bc() == Bytecodes::_checkcast ||
3262            java_bc() == Bytecodes::_instanceof ||
3263            java_bc() == Bytecodes::_aastore, "MDO must collect null_seen bit here");
3264     return !data->as_BitData()->null_seen();
3265   }
3266   speculating = false;
3267   return false;
3268 }
3269 
3270 void GraphKit::guard_klass_being_initialized(Node* klass) {
3271   int init_state_off = in_bytes(InstanceKlass::init_state_offset());
3272   Node* adr = basic_plus_adr(top(), klass, init_state_off);
3273   Node* init_state = LoadNode::make(_gvn, nullptr, immutable_memory(), adr,
3274                                     adr->bottom_type()->is_ptr(), TypeInt::BYTE,
3275                                     T_BYTE, MemNode::acquire);
3276   init_state = _gvn.transform(init_state);
3277 
3278   Node* being_initialized_state = makecon(TypeInt::make(InstanceKlass::being_initialized));
3279 
3280   Node* chk = _gvn.transform(new CmpINode(being_initialized_state, init_state));
3281   Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::eq));
3282 
3283   { BuildCutout unless(this, tst, PROB_MAX);
3284     uncommon_trap(Deoptimization::Reason_initialized, Deoptimization::Action_reinterpret);
3285   }
3286 }
3287 
3288 void GraphKit::guard_init_thread(Node* klass) {
3289   int init_thread_off = in_bytes(InstanceKlass::init_thread_offset());
3290   Node* adr = basic_plus_adr(top(), klass, init_thread_off);
3291 
3292   Node* init_thread = LoadNode::make(_gvn, nullptr, immutable_memory(), adr,
3293                                      adr->bottom_type()->is_ptr(), TypePtr::NOTNULL,
3294                                      T_ADDRESS, MemNode::unordered);
3295   init_thread = _gvn.transform(init_thread);
3296 
3297   Node* cur_thread = _gvn.transform(new ThreadLocalNode());
3298 
3299   Node* chk = _gvn.transform(new CmpPNode(cur_thread, init_thread));
3300   Node* tst = _gvn.transform(new BoolNode(chk, BoolTest::eq));
3301 
3302   { BuildCutout unless(this, tst, PROB_MAX);
3303     uncommon_trap(Deoptimization::Reason_uninitialized, Deoptimization::Action_none);
3304   }
3305 }
3306 
3307 void GraphKit::clinit_barrier(ciInstanceKlass* ik, ciMethod* context) {
3308   if (ik->is_being_initialized()) {
3309     if (C->needs_clinit_barrier(ik, context)) {
3310       Node* klass = makecon(TypeKlassPtr::make(ik));
3311       guard_klass_being_initialized(klass);
3312       guard_init_thread(klass);
3313       insert_mem_bar(Op_MemBarCPUOrder);
3314     }
3315   } else if (ik->is_initialized()) {
3316     return; // no barrier needed
3317   } else {
3318     uncommon_trap(Deoptimization::Reason_uninitialized,
3319                   Deoptimization::Action_reinterpret,
3320                   nullptr);
3321   }
3322 }
3323 
3324 //------------------------maybe_cast_profiled_receiver-------------------------
3325 // If the profile has seen exactly one type, narrow to exactly that type.
3326 // Subsequent type checks will always fold up.
3327 Node* GraphKit::maybe_cast_profiled_receiver(Node* not_null_obj,
3328                                              const TypeKlassPtr* require_klass,
3329                                              ciKlass* spec_klass,
3330                                              bool safe_for_replace) {
3331   if (!UseTypeProfile || !TypeProfileCasts) return nullptr;
3332 
3333   Deoptimization::DeoptReason reason = Deoptimization::reason_class_check(spec_klass != nullptr);
3334 
3335   // Make sure we haven't already deoptimized from this tactic.
3336   if (too_many_traps_or_recompiles(reason))
3337     return nullptr;
3338 
3339   // (No, this isn't a call, but it's enough like a virtual call
3340   // to use the same ciMethod accessor to get the profile info...)
3341   // If we have a speculative type use it instead of profiling (which
3342   // may not help us)
3343   ciKlass* exact_kls = spec_klass;
3344   if (exact_kls == nullptr) {
3345     if (java_bc() == Bytecodes::_aastore) {
3346       ciKlass* array_type = nullptr;
3347       ciKlass* element_type = nullptr;
3348       ProfilePtrKind element_ptr = ProfileMaybeNull;
3349       bool flat_array = true;
3350       bool null_free_array = true;
3351       method()->array_access_profiled_type(bci(), array_type, element_type, element_ptr, flat_array, null_free_array);
3352       exact_kls = element_type;
3353     } else {
3354       exact_kls = profile_has_unique_klass();
3355     }
3356   }
3357   if (exact_kls != nullptr) {// no cast failures here
3358     if (require_klass == nullptr ||
3359         C->static_subtype_check(require_klass, TypeKlassPtr::make(exact_kls, Type::trust_interfaces)) == Compile::SSC_always_true) {
3360       // If we narrow the type to match what the type profile sees or
3361       // the speculative type, we can then remove the rest of the
3362       // cast.
3363       // This is a win, even if the exact_kls is very specific,
3364       // because downstream operations, such as method calls,
3365       // will often benefit from the sharper type.
3366       Node* exact_obj = not_null_obj; // will get updated in place...
3367       Node* slow_ctl  = type_check_receiver(exact_obj, exact_kls, 1.0,
3368                                             &exact_obj);
3369       { PreserveJVMState pjvms(this);
3370         set_control(slow_ctl);
3371         uncommon_trap_exact(reason, Deoptimization::Action_maybe_recompile);
3372       }
3373       if (safe_for_replace) {
3374         replace_in_map(not_null_obj, exact_obj);
3375       }
3376       return exact_obj;
3377     }
3378     // assert(ssc == Compile::SSC_always_true)... except maybe the profile lied to us.
3379   }
3380 
3381   return nullptr;
3382 }
3383 
3384 /**
3385  * Cast obj to type and emit guard unless we had too many traps here
3386  * already
3387  *
3388  * @param obj       node being casted
3389  * @param type      type to cast the node to
3390  * @param not_null  true if we know node cannot be null
3391  */
3392 Node* GraphKit::maybe_cast_profiled_obj(Node* obj,
3393                                         ciKlass* type,
3394                                         bool not_null) {
3395   if (stopped()) {
3396     return obj;
3397   }
3398 
3399   // type is null if profiling tells us this object is always null
3400   if (type != nullptr) {
3401     Deoptimization::DeoptReason class_reason = Deoptimization::Reason_speculate_class_check;
3402     Deoptimization::DeoptReason null_reason = Deoptimization::Reason_speculate_null_check;
3403 
3404     if (!too_many_traps_or_recompiles(null_reason) &&
3405         !too_many_traps_or_recompiles(class_reason)) {
3406       Node* not_null_obj = nullptr;
3407       // not_null is true if we know the object is not null and
3408       // there's no need for a null check
3409       if (!not_null) {
3410         Node* null_ctl = top();
3411         not_null_obj = null_check_oop(obj, &null_ctl, true, true, true);
3412         assert(null_ctl->is_top(), "no null control here");
3413       } else {
3414         not_null_obj = obj;
3415       }
3416 
3417       Node* exact_obj = not_null_obj;
3418       ciKlass* exact_kls = type;
3419       Node* slow_ctl  = type_check_receiver(exact_obj, exact_kls, 1.0,
3420                                             &exact_obj);
3421       {
3422         PreserveJVMState pjvms(this);
3423         set_control(slow_ctl);
3424         uncommon_trap_exact(class_reason, Deoptimization::Action_maybe_recompile);
3425       }
3426       replace_in_map(not_null_obj, exact_obj);
3427       obj = exact_obj;
3428     }
3429   } else {
3430     if (!too_many_traps_or_recompiles(Deoptimization::Reason_null_assert)) {
3431       Node* exact_obj = null_assert(obj);
3432       replace_in_map(obj, exact_obj);
3433       obj = exact_obj;
3434     }
3435   }
3436   return obj;
3437 }
3438 
3439 //-------------------------------gen_instanceof--------------------------------
3440 // Generate an instance-of idiom.  Used by both the instance-of bytecode
3441 // and the reflective instance-of call.
3442 Node* GraphKit::gen_instanceof(Node* obj, Node* superklass, bool safe_for_replace) {
3443   kill_dead_locals();           // Benefit all the uncommon traps
3444   assert( !stopped(), "dead parse path should be checked in callers" );
3445   assert(!TypePtr::NULL_PTR->higher_equal(_gvn.type(superklass)->is_klassptr()),
3446          "must check for not-null not-dead klass in callers");
3447 
3448   // Make the merge point
3449   enum { _obj_path = 1, _fail_path, _null_path, PATH_LIMIT };
3450   RegionNode* region = new RegionNode(PATH_LIMIT);
3451   Node*       phi    = new PhiNode(region, TypeInt::BOOL);
3452   C->set_has_split_ifs(true); // Has chance for split-if optimization
3453 
3454   ciProfileData* data = nullptr;
3455   if (java_bc() == Bytecodes::_instanceof) {  // Only for the bytecode
3456     data = method()->method_data()->bci_to_data(bci());
3457   }
3458   bool speculative_not_null = false;
3459   bool never_see_null = (ProfileDynamicTypes  // aggressive use of profile
3460                          && seems_never_null(obj, data, speculative_not_null));
3461 
3462   // Null check; get casted pointer; set region slot 3
3463   Node* null_ctl = top();
3464   Node* not_null_obj = null_check_oop(obj, &null_ctl, never_see_null, safe_for_replace, speculative_not_null);
3465 
3466   // If not_null_obj is dead, only null-path is taken
3467   if (stopped()) {              // Doing instance-of on a null?
3468     set_control(null_ctl);
3469     return intcon(0);
3470   }
3471   region->init_req(_null_path, null_ctl);
3472   phi   ->init_req(_null_path, intcon(0)); // Set null path value
3473   if (null_ctl == top()) {
3474     // Do this eagerly, so that pattern matches like is_diamond_phi
3475     // will work even during parsing.
3476     assert(_null_path == PATH_LIMIT-1, "delete last");
3477     region->del_req(_null_path);
3478     phi   ->del_req(_null_path);
3479   }
3480 
3481   // Do we know the type check always succeed?
3482   bool known_statically = false;
3483   if (_gvn.type(superklass)->singleton()) {
3484     const TypeKlassPtr* superk = _gvn.type(superklass)->is_klassptr();
3485     const TypeKlassPtr* subk = _gvn.type(obj)->is_oopptr()->as_klass_type();
3486     if (subk != nullptr && subk->is_loaded()) {
3487       int static_res = C->static_subtype_check(superk, subk);
3488       known_statically = (static_res == Compile::SSC_always_true || static_res == Compile::SSC_always_false);
3489     }
3490   }
3491 
3492   if (!known_statically) {
3493     const TypeOopPtr* obj_type = _gvn.type(obj)->is_oopptr();
3494     // We may not have profiling here or it may not help us. If we
3495     // have a speculative type use it to perform an exact cast.
3496     ciKlass* spec_obj_type = obj_type->speculative_type();
3497     if (spec_obj_type != nullptr || (ProfileDynamicTypes && data != nullptr)) {
3498       Node* cast_obj = maybe_cast_profiled_receiver(not_null_obj, nullptr, spec_obj_type, safe_for_replace);
3499       if (stopped()) {            // Profile disagrees with this path.
3500         set_control(null_ctl);    // Null is the only remaining possibility.
3501         return intcon(0);
3502       }
3503       if (cast_obj != nullptr) {
3504         not_null_obj = cast_obj;
3505       }
3506     }
3507   }
3508 
3509   // Generate the subtype check
3510   Node* not_subtype_ctrl = gen_subtype_check(not_null_obj, superklass);
3511 
3512   // Plug in the success path to the general merge in slot 1.
3513   region->init_req(_obj_path, control());
3514   phi   ->init_req(_obj_path, intcon(1));
3515 
3516   // Plug in the failing path to the general merge in slot 2.
3517   region->init_req(_fail_path, not_subtype_ctrl);
3518   phi   ->init_req(_fail_path, intcon(0));
3519 
3520   // Return final merged results
3521   set_control( _gvn.transform(region) );
3522   record_for_igvn(region);
3523 
3524   // If we know the type check always succeeds then we don't use the
3525   // profiling data at this bytecode. Don't lose it, feed it to the
3526   // type system as a speculative type.
3527   if (safe_for_replace) {
3528     Node* casted_obj = record_profiled_receiver_for_speculation(obj);
3529     replace_in_map(obj, casted_obj);
3530   }
3531 
3532   return _gvn.transform(phi);
3533 }
3534 
3535 //-------------------------------gen_checkcast---------------------------------
3536 // Generate a checkcast idiom.  Used by both the checkcast bytecode and the
3537 // array store bytecode.  Stack must be as-if BEFORE doing the bytecode so the
3538 // uncommon-trap paths work.  Adjust stack after this call.
3539 // If failure_control is supplied and not null, it is filled in with
3540 // the control edge for the cast failure.  Otherwise, an appropriate
3541 // uncommon trap or exception is thrown.
3542 Node* GraphKit::gen_checkcast(Node* obj, Node* superklass, Node* *failure_control, bool null_free, bool maybe_larval) {
3543   kill_dead_locals();           // Benefit all the uncommon traps
3544   const TypeKlassPtr* klass_ptr_type = _gvn.type(superklass)->is_klassptr();
3545   const Type* obj_type = _gvn.type(obj);
3546   if (obj_type->is_inlinetypeptr() && !obj_type->maybe_null() && klass_ptr_type->klass_is_exact() && obj_type->inline_klass() == klass_ptr_type->exact_klass(true)) {
3547     // Special case: larval inline objects must not be scalarized. They are also generally not
3548     // allowed to participate in most operations except as the first operand of putfield, or as an
3549     // argument to a constructor invocation with it being a receiver, Unsafe::putXXX with it being
3550     // the first argument, or Unsafe::finishPrivateBuffer. This allows us to aggressively scalarize
3551     // value objects in all other places. This special case comes from the limitation of the Java
3552     // language, Unsafe::makePrivateBuffer returns an Object that is checkcast-ed to the concrete
3553     // value type. We must do this first because C->static_subtype_check may do nothing when
3554     // StressReflectiveCode is set.
3555     return obj;
3556   }
3557 
3558   // Else it must be a non-larval object
3559   obj = cast_to_non_larval(obj);
3560 
3561   const TypeKlassPtr* improved_klass_ptr_type = klass_ptr_type->try_improve();
3562   const TypeOopPtr* toop = improved_klass_ptr_type->cast_to_exactness(false)->as_instance_type();
3563   bool safe_for_replace = (failure_control == nullptr);
3564   assert(!null_free || toop->can_be_inline_type(), "must be an inline type pointer");
3565 
3566   // Fast cutout:  Check the case that the cast is vacuously true.
3567   // This detects the common cases where the test will short-circuit
3568   // away completely.  We do this before we perform the null check,
3569   // because if the test is going to turn into zero code, we don't
3570   // want a residual null check left around.  (Causes a slowdown,
3571   // for example, in some objArray manipulations, such as a[i]=a[j].)
3572   if (improved_klass_ptr_type->singleton()) {
3573     const TypeKlassPtr* kptr = nullptr;
3574     if (obj_type->isa_oop_ptr()) {
3575       kptr = obj_type->is_oopptr()->as_klass_type();
3576     } else if (obj->is_InlineType()) {
3577       ciInlineKlass* vk = obj_type->inline_klass();
3578       kptr = TypeInstKlassPtr::make(TypePtr::NotNull, vk, Type::Offset(0));
3579     }
3580 
3581     if (kptr != nullptr) {
3582       switch (C->static_subtype_check(improved_klass_ptr_type, kptr)) {
3583       case Compile::SSC_always_true:
3584         // If we know the type check always succeed then we don't use
3585         // the profiling data at this bytecode. Don't lose it, feed it
3586         // to the type system as a speculative type.
3587         obj = record_profiled_receiver_for_speculation(obj);
3588         if (null_free) {
3589           assert(safe_for_replace, "must be");
3590           obj = null_check(obj);
3591         }
3592         assert(stopped() || !toop->is_inlinetypeptr() || obj->is_InlineType(), "should have been scalarized");
3593         return obj;
3594       case Compile::SSC_always_false:
3595         if (null_free) {
3596           assert(safe_for_replace, "must be");
3597           obj = null_check(obj);
3598         }
3599         // It needs a null check because a null will *pass* the cast check.
3600         if (obj_type->isa_oopptr() != nullptr && !obj_type->is_oopptr()->maybe_null()) {
3601           bool is_aastore = (java_bc() == Bytecodes::_aastore);
3602           Deoptimization::DeoptReason reason = is_aastore ?
3603             Deoptimization::Reason_array_check : Deoptimization::Reason_class_check;
3604           builtin_throw(reason);
3605           return top();
3606         } else if (!too_many_traps_or_recompiles(Deoptimization::Reason_null_assert)) {
3607           return null_assert(obj);
3608         }
3609         break; // Fall through to full check
3610       default:
3611         break;
3612       }
3613     }
3614   }
3615 
3616   ciProfileData* data = nullptr;
3617   if (failure_control == nullptr) {        // use MDO in regular case only
3618     assert(java_bc() == Bytecodes::_aastore ||
3619            java_bc() == Bytecodes::_checkcast,
3620            "interpreter profiles type checks only for these BCs");
3621     if (method()->method_data()->is_mature()) {
3622       data = method()->method_data()->bci_to_data(bci());
3623     }
3624   }
3625 
3626   // Make the merge point
3627   enum { _obj_path = 1, _null_path, PATH_LIMIT };
3628   RegionNode* region = new RegionNode(PATH_LIMIT);
3629   Node*       phi    = new PhiNode(region, toop);
3630   _gvn.set_type(region, Type::CONTROL);
3631   _gvn.set_type(phi, toop);
3632 
3633   C->set_has_split_ifs(true); // Has chance for split-if optimization
3634 
3635   // Use null-cast information if it is available
3636   bool speculative_not_null = false;
3637   bool never_see_null = ((failure_control == nullptr)  // regular case only
3638                          && seems_never_null(obj, data, speculative_not_null));
3639 
3640   if (obj->is_InlineType()) {
3641     // Re-execute if buffering during triggers deoptimization
3642     PreserveReexecuteState preexecs(this);
3643     jvms()->set_should_reexecute(true);
3644     obj = obj->as_InlineType()->buffer(this, safe_for_replace);
3645   }
3646 
3647   // Null check; get casted pointer; set region slot 3
3648   Node* null_ctl = top();
3649   Node* not_null_obj = nullptr;
3650   if (null_free) {
3651     assert(safe_for_replace, "must be");
3652     not_null_obj = null_check(obj);
3653   } else {
3654     not_null_obj = null_check_oop(obj, &null_ctl, never_see_null, safe_for_replace, speculative_not_null);
3655   }
3656 
3657   // If not_null_obj is dead, only null-path is taken
3658   if (stopped()) {              // Doing instance-of on a null?
3659     set_control(null_ctl);
3660     if (toop->is_inlinetypeptr()) {
3661       return InlineTypeNode::make_null(_gvn, toop->inline_klass());
3662     }
3663     return null();
3664   }
3665   region->init_req(_null_path, null_ctl);
3666   phi   ->init_req(_null_path, null());  // Set null path value
3667   if (null_ctl == top()) {
3668     // Do this eagerly, so that pattern matches like is_diamond_phi
3669     // will work even during parsing.
3670     assert(_null_path == PATH_LIMIT-1, "delete last");
3671     region->del_req(_null_path);
3672     phi   ->del_req(_null_path);
3673   }
3674 
3675   Node* cast_obj = nullptr;
3676   if (improved_klass_ptr_type->klass_is_exact()) {
3677     // The following optimization tries to statically cast the speculative type of the object
3678     // (for example obtained during profiling) to the type of the superklass and then do a
3679     // dynamic check that the type of the object is what we expect. To work correctly
3680     // for checkcast and aastore the type of superklass should be exact.
3681     const TypeOopPtr* obj_type = _gvn.type(obj)->is_oopptr();
3682     // We may not have profiling here or it may not help us. If we have
3683     // a speculative type use it to perform an exact cast.
3684     ciKlass* spec_obj_type = obj_type->speculative_type();
3685     if (spec_obj_type != nullptr || data != nullptr) {
3686       cast_obj = maybe_cast_profiled_receiver(not_null_obj, improved_klass_ptr_type, spec_obj_type, safe_for_replace);
3687       if (cast_obj != nullptr) {
3688         if (failure_control != nullptr) // failure is now impossible
3689           (*failure_control) = top();
3690         // adjust the type of the phi to the exact klass:
3691         phi->raise_bottom_type(_gvn.type(cast_obj)->meet_speculative(TypePtr::NULL_PTR));
3692       }
3693     }
3694   }
3695 
3696   if (cast_obj == nullptr) {
3697     // Generate the subtype check
3698     Node* improved_superklass = superklass;
3699     if (improved_klass_ptr_type != klass_ptr_type && improved_klass_ptr_type->singleton()) {
3700       // Only improve the super class for constants which allows subsequent sub type checks to possibly be commoned up.
3701       // The other non-constant cases cannot be improved with a cast node here since they could be folded to top.
3702       // Additionally, the benefit would only be minor in non-constant cases.
3703       improved_superklass = makecon(improved_klass_ptr_type);
3704     }
3705     Node* not_subtype_ctrl = gen_subtype_check(not_null_obj, improved_superklass);
3706     // Plug in success path into the merge
3707     cast_obj = _gvn.transform(new CheckCastPPNode(control(), not_null_obj, toop));
3708     // Failure path ends in uncommon trap (or may be dead - failure impossible)
3709     if (failure_control == nullptr) {
3710       if (not_subtype_ctrl != top()) { // If failure is possible
3711         PreserveJVMState pjvms(this);
3712         set_control(not_subtype_ctrl);
3713         bool is_aastore = (java_bc() == Bytecodes::_aastore);
3714         Deoptimization::DeoptReason reason = is_aastore ?
3715           Deoptimization::Reason_array_check : Deoptimization::Reason_class_check;
3716         builtin_throw(reason);
3717       }
3718     } else {
3719       (*failure_control) = not_subtype_ctrl;
3720     }
3721   }
3722 
3723   region->init_req(_obj_path, control());
3724   phi   ->init_req(_obj_path, cast_obj);
3725 
3726   // A merge of null or Casted-NotNull obj
3727   Node* res = _gvn.transform(phi);
3728 
3729   // Note I do NOT always 'replace_in_map(obj,result)' here.
3730   //  if( tk->klass()->can_be_primary_super()  )
3731     // This means that if I successfully store an Object into an array-of-String
3732     // I 'forget' that the Object is really now known to be a String.  I have to
3733     // do this because we don't have true union types for interfaces - if I store
3734     // a Baz into an array-of-Interface and then tell the optimizer it's an
3735     // Interface, I forget that it's also a Baz and cannot do Baz-like field
3736     // references to it.  FIX THIS WHEN UNION TYPES APPEAR!
3737   //  replace_in_map( obj, res );
3738 
3739   // Return final merged results
3740   set_control( _gvn.transform(region) );
3741   record_for_igvn(region);
3742 
3743   bool not_inline = !toop->can_be_inline_type();
3744   bool not_flat_in_array = !UseArrayFlattening || not_inline || (toop->is_inlinetypeptr() && !toop->inline_klass()->maybe_flat_in_array());
3745   if (EnableValhalla && (not_inline || not_flat_in_array)) {
3746     // Check if obj has been loaded from an array
3747     obj = obj->isa_DecodeN() ? obj->in(1) : obj;
3748     Node* array = nullptr;
3749     if (obj->isa_Load()) {
3750       Node* address = obj->in(MemNode::Address);
3751       if (address->isa_AddP()) {
3752         array = address->as_AddP()->in(AddPNode::Base);
3753       }
3754     } else if (obj->is_Phi()) {
3755       Node* region = obj->in(0);
3756       // TODO make this more robust (see JDK-8231346)
3757       if (region->req() == 3 && region->in(2) != nullptr && region->in(2)->in(0) != nullptr) {
3758         IfNode* iff = region->in(2)->in(0)->isa_If();
3759         if (iff != nullptr) {
3760           iff->is_flat_array_check(&_gvn, &array);
3761         }
3762       }
3763     }
3764     if (array != nullptr) {
3765       const TypeAryPtr* ary_t = _gvn.type(array)->isa_aryptr();
3766       if (ary_t != nullptr) {
3767         if (!ary_t->is_not_null_free() && !ary_t->is_null_free() && not_inline) {
3768           // Casting array element to a non-inline-type, mark array as not null-free.
3769           Node* cast = _gvn.transform(new CheckCastPPNode(control(), array, ary_t->cast_to_not_null_free()));
3770           replace_in_map(array, cast);
3771           array = cast;
3772         }
3773         if (!ary_t->is_not_flat() && !ary_t->is_flat() && not_flat_in_array) {
3774           // Casting array element to a non-flat-in-array type, mark array as not flat.
3775           Node* cast = _gvn.transform(new CheckCastPPNode(control(), array, ary_t->cast_to_not_flat()));
3776           replace_in_map(array, cast);
3777           array = cast;
3778         }
3779       }
3780     }
3781   }
3782 
3783   if (!stopped() && !res->is_InlineType()) {
3784     res = record_profiled_receiver_for_speculation(res);
3785     if (toop->is_inlinetypeptr() && !maybe_larval) {
3786       Node* vt = InlineTypeNode::make_from_oop(this, res, toop->inline_klass());
3787       res = vt;
3788       if (safe_for_replace) {
3789         replace_in_map(obj, vt);
3790         replace_in_map(not_null_obj, vt);
3791         replace_in_map(res, vt);
3792       }
3793     }
3794   }
3795   return res;
3796 }
3797 
3798 Node* GraphKit::mark_word_test(Node* obj, uintptr_t mask_val, bool eq, bool check_lock) {
3799   // Load markword
3800   Node* mark_adr = basic_plus_adr(obj, oopDesc::mark_offset_in_bytes());
3801   Node* mark = make_load(nullptr, mark_adr, TypeX_X, TypeX_X->basic_type(), MemNode::unordered);
3802   if (check_lock && !UseCompactObjectHeaders) {
3803     // COH: Locking does not override the markword with a tagged pointer. We can directly read from the markword.
3804     // Check if obj is locked
3805     Node* locked_bit = MakeConX(markWord::unlocked_value);
3806     locked_bit = _gvn.transform(new AndXNode(locked_bit, mark));
3807     Node* cmp = _gvn.transform(new CmpXNode(locked_bit, MakeConX(0)));
3808     Node* is_unlocked = _gvn.transform(new BoolNode(cmp, BoolTest::ne));
3809     IfNode* iff = new IfNode(control(), is_unlocked, PROB_MAX, COUNT_UNKNOWN);
3810     _gvn.transform(iff);
3811     Node* locked_region = new RegionNode(3);
3812     Node* mark_phi = new PhiNode(locked_region, TypeX_X);
3813 
3814     // Unlocked: Use bits from mark word
3815     locked_region->init_req(1, _gvn.transform(new IfTrueNode(iff)));
3816     mark_phi->init_req(1, mark);
3817 
3818     // Locked: Load prototype header from klass
3819     set_control(_gvn.transform(new IfFalseNode(iff)));
3820     // Make loads control dependent to make sure they are only executed if array is locked
3821     Node* klass_adr = basic_plus_adr(obj, oopDesc::klass_offset_in_bytes());
3822     Node* klass = _gvn.transform(LoadKlassNode::make(_gvn, C->immutable_memory(), klass_adr, TypeInstPtr::KLASS, TypeInstKlassPtr::OBJECT));
3823     Node* proto_adr = basic_plus_adr(klass, in_bytes(Klass::prototype_header_offset()));
3824     Node* proto = _gvn.transform(LoadNode::make(_gvn, control(), C->immutable_memory(), proto_adr, proto_adr->bottom_type()->is_ptr(), TypeX_X, TypeX_X->basic_type(), MemNode::unordered));
3825 
3826     locked_region->init_req(2, control());
3827     mark_phi->init_req(2, proto);
3828     set_control(_gvn.transform(locked_region));
3829     record_for_igvn(locked_region);
3830 
3831     mark = mark_phi;
3832   }
3833 
3834   // Now check if mark word bits are set
3835   Node* mask = MakeConX(mask_val);
3836   Node* masked = _gvn.transform(new AndXNode(_gvn.transform(mark), mask));
3837   record_for_igvn(masked); // Give it a chance to be optimized out by IGVN
3838   Node* cmp = _gvn.transform(new CmpXNode(masked, mask));
3839   return _gvn.transform(new BoolNode(cmp, eq ? BoolTest::eq : BoolTest::ne));
3840 }
3841 
3842 Node* GraphKit::inline_type_test(Node* obj, bool is_inline) {
3843   return mark_word_test(obj, markWord::inline_type_pattern, is_inline, /* check_lock = */ false);
3844 }
3845 
3846 Node* GraphKit::flat_array_test(Node* array_or_klass, bool flat) {
3847   // We can't use immutable memory here because the mark word is mutable.
3848   // PhaseIdealLoop::move_flat_array_check_out_of_loop will make sure the
3849   // check is moved out of loops (mainly to enable loop unswitching).
3850   Node* cmp = _gvn.transform(new FlatArrayCheckNode(C, memory(Compile::AliasIdxRaw), array_or_klass));
3851   record_for_igvn(cmp); // Give it a chance to be optimized out by IGVN
3852   return _gvn.transform(new BoolNode(cmp, flat ? BoolTest::eq : BoolTest::ne));
3853 }
3854 
3855 Node* GraphKit::null_free_array_test(Node* array, bool null_free) {
3856   return mark_word_test(array, markWord::null_free_array_bit_in_place, null_free);
3857 }
3858 
3859 Node* GraphKit::null_free_atomic_array_test(Node* array, ciInlineKlass* vk) {
3860   assert(vk->has_atomic_layout() || vk->has_non_atomic_layout(), "Can't be null-free and flat");
3861 
3862   // TODO 8350865 Add a stress flag to always access atomic if layout exists?
3863   if (!vk->has_non_atomic_layout()) {
3864     return intcon(1); // Always atomic
3865   } else if (!vk->has_atomic_layout()) {
3866     return intcon(0); // Never atomic
3867   }
3868 
3869   Node* array_klass = load_object_klass(array);
3870   int layout_kind_offset = in_bytes(FlatArrayKlass::layout_kind_offset());
3871   Node* layout_kind_addr = basic_plus_adr(array_klass, array_klass, layout_kind_offset);
3872   Node* layout_kind = make_load(nullptr, layout_kind_addr, TypeInt::INT, T_INT, MemNode::unordered);
3873   Node* cmp = _gvn.transform(new CmpINode(layout_kind, intcon((int)LayoutKind::ATOMIC_FLAT)));
3874   return _gvn.transform(new BoolNode(cmp, BoolTest::eq));
3875 }
3876 
3877 // Deoptimize if 'ary' is a null-free inline type array and 'val' is null
3878 Node* GraphKit::inline_array_null_guard(Node* ary, Node* val, int nargs, bool safe_for_replace) {
3879   RegionNode* region = new RegionNode(3);
3880   Node* null_ctl = top();
3881   null_check_oop(val, &null_ctl);
3882   if (null_ctl != top()) {
3883     PreserveJVMState pjvms(this);
3884     set_control(null_ctl);
3885     {
3886       // Deoptimize if null-free array
3887       BuildCutout unless(this, null_free_array_test(ary, /* null_free = */ false), PROB_MAX);
3888       inc_sp(nargs);
3889       uncommon_trap(Deoptimization::Reason_null_check,
3890                     Deoptimization::Action_none);
3891     }
3892     region->init_req(1, control());
3893   }
3894   region->init_req(2, control());
3895   set_control(_gvn.transform(region));
3896   record_for_igvn(region);
3897   if (_gvn.type(val) == TypePtr::NULL_PTR) {
3898     // Since we were just successfully storing null, the array can't be null free.
3899     const TypeAryPtr* ary_t = _gvn.type(ary)->is_aryptr();
3900     ary_t = ary_t->cast_to_not_null_free();
3901     Node* cast = _gvn.transform(new CheckCastPPNode(control(), ary, ary_t));
3902     if (safe_for_replace) {
3903       replace_in_map(ary, cast);
3904     }
3905     ary = cast;
3906   }
3907   return ary;
3908 }
3909 
3910 //------------------------------next_monitor-----------------------------------
3911 // What number should be given to the next monitor?
3912 int GraphKit::next_monitor() {
3913   int current = jvms()->monitor_depth()* C->sync_stack_slots();
3914   int next = current + C->sync_stack_slots();
3915   // Keep the toplevel high water mark current:
3916   if (C->fixed_slots() < next)  C->set_fixed_slots(next);
3917   return current;
3918 }
3919 
3920 //------------------------------insert_mem_bar---------------------------------
3921 // Memory barrier to avoid floating things around
3922 // The membar serves as a pinch point between both control and all memory slices.
3923 Node* GraphKit::insert_mem_bar(int opcode, Node* precedent) {
3924   MemBarNode* mb = MemBarNode::make(C, opcode, Compile::AliasIdxBot, precedent);
3925   mb->init_req(TypeFunc::Control, control());
3926   mb->init_req(TypeFunc::Memory,  reset_memory());
3927   Node* membar = _gvn.transform(mb);
3928   set_control(_gvn.transform(new ProjNode(membar, TypeFunc::Control)));
3929   set_all_memory_call(membar);
3930   return membar;
3931 }
3932 
3933 //-------------------------insert_mem_bar_volatile----------------------------
3934 // Memory barrier to avoid floating things around
3935 // The membar serves as a pinch point between both control and memory(alias_idx).
3936 // If you want to make a pinch point on all memory slices, do not use this
3937 // function (even with AliasIdxBot); use insert_mem_bar() instead.
3938 Node* GraphKit::insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent) {
3939   // When Parse::do_put_xxx updates a volatile field, it appends a series
3940   // of MemBarVolatile nodes, one for *each* volatile field alias category.
3941   // The first membar is on the same memory slice as the field store opcode.
3942   // This forces the membar to follow the store.  (Bug 6500685 broke this.)
3943   // All the other membars (for other volatile slices, including AliasIdxBot,
3944   // which stands for all unknown volatile slices) are control-dependent
3945   // on the first membar.  This prevents later volatile loads or stores
3946   // from sliding up past the just-emitted store.
3947 
3948   MemBarNode* mb = MemBarNode::make(C, opcode, alias_idx, precedent);
3949   mb->set_req(TypeFunc::Control,control());
3950   if (alias_idx == Compile::AliasIdxBot) {
3951     mb->set_req(TypeFunc::Memory, merged_memory()->base_memory());
3952   } else {
3953     assert(!(opcode == Op_Initialize && alias_idx != Compile::AliasIdxRaw), "fix caller");
3954     mb->set_req(TypeFunc::Memory, memory(alias_idx));
3955   }
3956   Node* membar = _gvn.transform(mb);
3957   set_control(_gvn.transform(new ProjNode(membar, TypeFunc::Control)));
3958   if (alias_idx == Compile::AliasIdxBot) {
3959     merged_memory()->set_base_memory(_gvn.transform(new ProjNode(membar, TypeFunc::Memory)));
3960   } else {
3961     set_memory(_gvn.transform(new ProjNode(membar, TypeFunc::Memory)),alias_idx);
3962   }
3963   return membar;
3964 }
3965 
3966 //------------------------------shared_lock------------------------------------
3967 // Emit locking code.
3968 FastLockNode* GraphKit::shared_lock(Node* obj) {
3969   // bci is either a monitorenter bc or InvocationEntryBci
3970   // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
3971   assert(SynchronizationEntryBCI == InvocationEntryBci, "");
3972 
3973   if (stopped())                // Dead monitor?
3974     return nullptr;
3975 
3976   assert(dead_locals_are_killed(), "should kill locals before sync. point");
3977 
3978   // Box the stack location
3979   Node* box = new BoxLockNode(next_monitor());
3980   // Check for bailout after new BoxLockNode
3981   if (failing()) { return nullptr; }
3982   box = _gvn.transform(box);
3983   Node* mem = reset_memory();
3984 
3985   FastLockNode * flock = _gvn.transform(new FastLockNode(nullptr, obj, box) )->as_FastLock();
3986 
3987   // Add monitor to debug info for the slow path.  If we block inside the
3988   // slow path and de-opt, we need the monitor hanging around
3989   map()->push_monitor( flock );
3990 
3991   const TypeFunc *tf = LockNode::lock_type();
3992   LockNode *lock = new LockNode(C, tf);
3993 
3994   lock->init_req( TypeFunc::Control, control() );
3995   lock->init_req( TypeFunc::Memory , mem );
3996   lock->init_req( TypeFunc::I_O    , top() )     ;   // does no i/o
3997   lock->init_req( TypeFunc::FramePtr, frameptr() );
3998   lock->init_req( TypeFunc::ReturnAdr, top() );
3999 
4000   lock->init_req(TypeFunc::Parms + 0, obj);
4001   lock->init_req(TypeFunc::Parms + 1, box);
4002   lock->init_req(TypeFunc::Parms + 2, flock);
4003   add_safepoint_edges(lock);
4004 
4005   lock = _gvn.transform( lock )->as_Lock();
4006 
4007   // lock has no side-effects, sets few values
4008   set_predefined_output_for_runtime_call(lock, mem, TypeRawPtr::BOTTOM);
4009 
4010   insert_mem_bar(Op_MemBarAcquireLock);
4011 
4012   // Add this to the worklist so that the lock can be eliminated
4013   record_for_igvn(lock);
4014 
4015 #ifndef PRODUCT
4016   if (PrintLockStatistics) {
4017     // Update the counter for this lock.  Don't bother using an atomic
4018     // operation since we don't require absolute accuracy.
4019     lock->create_lock_counter(map()->jvms());
4020     increment_counter(lock->counter()->addr());
4021   }
4022 #endif
4023 
4024   return flock;
4025 }
4026 
4027 
4028 //------------------------------shared_unlock----------------------------------
4029 // Emit unlocking code.
4030 void GraphKit::shared_unlock(Node* box, Node* obj) {
4031   // bci is either a monitorenter bc or InvocationEntryBci
4032   // %%% SynchronizationEntryBCI is redundant; use InvocationEntryBci in interfaces
4033   assert(SynchronizationEntryBCI == InvocationEntryBci, "");
4034 
4035   if (stopped()) {               // Dead monitor?
4036     map()->pop_monitor();        // Kill monitor from debug info
4037     return;
4038   }
4039   assert(!obj->is_InlineType(), "should not unlock on inline type");
4040 
4041   // Memory barrier to avoid floating things down past the locked region
4042   insert_mem_bar(Op_MemBarReleaseLock);
4043 
4044   const TypeFunc *tf = OptoRuntime::complete_monitor_exit_Type();
4045   UnlockNode *unlock = new UnlockNode(C, tf);
4046 #ifdef ASSERT
4047   unlock->set_dbg_jvms(sync_jvms());
4048 #endif
4049   uint raw_idx = Compile::AliasIdxRaw;
4050   unlock->init_req( TypeFunc::Control, control() );
4051   unlock->init_req( TypeFunc::Memory , memory(raw_idx) );
4052   unlock->init_req( TypeFunc::I_O    , top() )     ;   // does no i/o
4053   unlock->init_req( TypeFunc::FramePtr, frameptr() );
4054   unlock->init_req( TypeFunc::ReturnAdr, top() );
4055 
4056   unlock->init_req(TypeFunc::Parms + 0, obj);
4057   unlock->init_req(TypeFunc::Parms + 1, box);
4058   unlock = _gvn.transform(unlock)->as_Unlock();
4059 
4060   Node* mem = reset_memory();
4061 
4062   // unlock has no side-effects, sets few values
4063   set_predefined_output_for_runtime_call(unlock, mem, TypeRawPtr::BOTTOM);
4064 
4065   // Kill monitor from debug info
4066   map()->pop_monitor( );
4067 }
4068 
4069 //-------------------------------get_layout_helper-----------------------------
4070 // If the given klass is a constant or known to be an array,
4071 // fetch the constant layout helper value into constant_value
4072 // and return null.  Otherwise, load the non-constant
4073 // layout helper value, and return the node which represents it.
4074 // This two-faced routine is useful because allocation sites
4075 // almost always feature constant types.
4076 Node* GraphKit::get_layout_helper(Node* klass_node, jint& constant_value) {
4077   const TypeKlassPtr* klass_t = _gvn.type(klass_node)->isa_klassptr();
4078   if (!StressReflectiveCode && klass_t != nullptr) {
4079     bool xklass = klass_t->klass_is_exact();
4080     bool can_be_flat = false;
4081     const TypeAryPtr* ary_type = klass_t->as_instance_type()->isa_aryptr();
4082     if (UseArrayFlattening && !xklass && ary_type != nullptr && !ary_type->is_null_free()) {
4083       // Don't constant fold if the runtime type might be a flat array but the static type is not.
4084       const TypeOopPtr* elem = ary_type->elem()->make_oopptr();
4085       can_be_flat = ary_type->can_be_inline_array() && (!elem->is_inlinetypeptr() || elem->inline_klass()->maybe_flat_in_array());
4086     }
4087     if (!can_be_flat && (xklass || (klass_t->isa_aryklassptr() && klass_t->is_aryklassptr()->elem() != Type::BOTTOM))) {
4088       jint lhelper;
4089       if (klass_t->is_flat()) {
4090         lhelper = ary_type->flat_layout_helper();
4091       } else if (klass_t->isa_aryklassptr()) {
4092         BasicType elem = ary_type->elem()->array_element_basic_type();
4093         if (is_reference_type(elem, true)) {
4094           elem = T_OBJECT;
4095         }
4096         lhelper = Klass::array_layout_helper(elem);
4097       } else {
4098         lhelper = klass_t->is_instklassptr()->exact_klass()->layout_helper();
4099       }
4100       if (lhelper != Klass::_lh_neutral_value) {
4101         constant_value = lhelper;
4102         return (Node*) nullptr;
4103       }
4104     }
4105   }
4106   constant_value = Klass::_lh_neutral_value;  // put in a known value
4107   Node* lhp = basic_plus_adr(klass_node, klass_node, in_bytes(Klass::layout_helper_offset()));
4108   return make_load(nullptr, lhp, TypeInt::INT, T_INT, MemNode::unordered);
4109 }
4110 
4111 // We just put in an allocate/initialize with a big raw-memory effect.
4112 // Hook selected additional alias categories on the initialization.
4113 static void hook_memory_on_init(GraphKit& kit, int alias_idx,
4114                                 MergeMemNode* init_in_merge,
4115                                 Node* init_out_raw) {
4116   DEBUG_ONLY(Node* init_in_raw = init_in_merge->base_memory());
4117   assert(init_in_merge->memory_at(alias_idx) == init_in_raw, "");
4118 
4119   Node* prevmem = kit.memory(alias_idx);
4120   init_in_merge->set_memory_at(alias_idx, prevmem);
4121   if (init_out_raw != nullptr) {
4122     kit.set_memory(init_out_raw, alias_idx);
4123   }
4124 }
4125 
4126 //---------------------------set_output_for_allocation-------------------------
4127 Node* GraphKit::set_output_for_allocation(AllocateNode* alloc,
4128                                           const TypeOopPtr* oop_type,
4129                                           bool deoptimize_on_exception) {
4130   int rawidx = Compile::AliasIdxRaw;
4131   alloc->set_req( TypeFunc::FramePtr, frameptr() );
4132   add_safepoint_edges(alloc);
4133   Node* allocx = _gvn.transform(alloc);
4134   set_control( _gvn.transform(new ProjNode(allocx, TypeFunc::Control) ) );
4135   // create memory projection for i_o
4136   set_memory ( _gvn.transform( new ProjNode(allocx, TypeFunc::Memory, true) ), rawidx );
4137   make_slow_call_ex(allocx, env()->Throwable_klass(), true, deoptimize_on_exception);
4138 
4139   // create a memory projection as for the normal control path
4140   Node* malloc = _gvn.transform(new ProjNode(allocx, TypeFunc::Memory));
4141   set_memory(malloc, rawidx);
4142 
4143   // a normal slow-call doesn't change i_o, but an allocation does
4144   // we create a separate i_o projection for the normal control path
4145   set_i_o(_gvn.transform( new ProjNode(allocx, TypeFunc::I_O, false) ) );
4146   Node* rawoop = _gvn.transform( new ProjNode(allocx, TypeFunc::Parms) );
4147 
4148   // put in an initialization barrier
4149   InitializeNode* init = insert_mem_bar_volatile(Op_Initialize, rawidx,
4150                                                  rawoop)->as_Initialize();
4151   assert(alloc->initialization() == init,  "2-way macro link must work");
4152   assert(init ->allocation()     == alloc, "2-way macro link must work");
4153   {
4154     // Extract memory strands which may participate in the new object's
4155     // initialization, and source them from the new InitializeNode.
4156     // This will allow us to observe initializations when they occur,
4157     // and link them properly (as a group) to the InitializeNode.
4158     assert(init->in(InitializeNode::Memory) == malloc, "");
4159     MergeMemNode* minit_in = MergeMemNode::make(malloc);
4160     init->set_req(InitializeNode::Memory, minit_in);
4161     record_for_igvn(minit_in); // fold it up later, if possible
4162     _gvn.set_type(minit_in, Type::MEMORY);
4163     Node* minit_out = memory(rawidx);
4164     assert(minit_out->is_Proj() && minit_out->in(0) == init, "");
4165     // Add an edge in the MergeMem for the header fields so an access
4166     // to one of those has correct memory state
4167     set_memory(minit_out, C->get_alias_index(oop_type->add_offset(oopDesc::mark_offset_in_bytes())));
4168     set_memory(minit_out, C->get_alias_index(oop_type->add_offset(oopDesc::klass_offset_in_bytes())));
4169     if (oop_type->isa_aryptr()) {
4170       const TypeAryPtr* arytype = oop_type->is_aryptr();
4171       if (arytype->is_flat()) {
4172         // Initially all flat array accesses share a single slice
4173         // but that changes after parsing. Prepare the memory graph so
4174         // it can optimize flat array accesses properly once they
4175         // don't share a single slice.
4176         assert(C->flat_accesses_share_alias(), "should be set at parse time");
4177         C->set_flat_accesses_share_alias(false);
4178         ciInlineKlass* vk = arytype->elem()->inline_klass();
4179         for (int i = 0, len = vk->nof_nonstatic_fields(); i < len; i++) {
4180           ciField* field = vk->nonstatic_field_at(i);
4181           if (field->offset_in_bytes() >= TrackedInitializationLimit * HeapWordSize)
4182             continue;  // do not bother to track really large numbers of fields
4183           int off_in_vt = field->offset_in_bytes() - vk->payload_offset();
4184           const TypePtr* adr_type = arytype->with_field_offset(off_in_vt)->add_offset(Type::OffsetBot);
4185           int fieldidx = C->get_alias_index(adr_type, true);
4186           // Pass nullptr for init_out. Having per flat array element field memory edges as uses of the Initialize node
4187           // can result in per flat array field Phis to be created which confuses the logic of
4188           // Compile::adjust_flat_array_access_aliases().
4189           hook_memory_on_init(*this, fieldidx, minit_in, nullptr);
4190         }
4191         C->set_flat_accesses_share_alias(true);
4192         hook_memory_on_init(*this, C->get_alias_index(TypeAryPtr::INLINES), minit_in, minit_out);
4193       } else {
4194         const TypePtr* telemref = oop_type->add_offset(Type::OffsetBot);
4195         int            elemidx  = C->get_alias_index(telemref);
4196         hook_memory_on_init(*this, elemidx, minit_in, minit_out);
4197       }
4198     } else if (oop_type->isa_instptr()) {
4199       set_memory(minit_out, C->get_alias_index(oop_type)); // mark word
4200       ciInstanceKlass* ik = oop_type->is_instptr()->instance_klass();
4201       for (int i = 0, len = ik->nof_nonstatic_fields(); i < len; i++) {
4202         ciField* field = ik->nonstatic_field_at(i);
4203         if (field->offset_in_bytes() >= TrackedInitializationLimit * HeapWordSize)
4204           continue;  // do not bother to track really large numbers of fields
4205         // Find (or create) the alias category for this field:
4206         int fieldidx = C->alias_type(field)->index();
4207         hook_memory_on_init(*this, fieldidx, minit_in, minit_out);
4208       }
4209     }
4210   }
4211 
4212   // Cast raw oop to the real thing...
4213   Node* javaoop = new CheckCastPPNode(control(), rawoop, oop_type);
4214   javaoop = _gvn.transform(javaoop);
4215   C->set_recent_alloc(control(), javaoop);
4216   assert(just_allocated_object(control()) == javaoop, "just allocated");
4217 
4218 #ifdef ASSERT
4219   { // Verify that the AllocateNode::Ideal_allocation recognizers work:
4220     assert(AllocateNode::Ideal_allocation(rawoop) == alloc,
4221            "Ideal_allocation works");
4222     assert(AllocateNode::Ideal_allocation(javaoop) == alloc,
4223            "Ideal_allocation works");
4224     if (alloc->is_AllocateArray()) {
4225       assert(AllocateArrayNode::Ideal_array_allocation(rawoop) == alloc->as_AllocateArray(),
4226              "Ideal_allocation works");
4227       assert(AllocateArrayNode::Ideal_array_allocation(javaoop) == alloc->as_AllocateArray(),
4228              "Ideal_allocation works");
4229     } else {
4230       assert(alloc->in(AllocateNode::ALength)->is_top(), "no length, please");
4231     }
4232   }
4233 #endif //ASSERT
4234 
4235   return javaoop;
4236 }
4237 
4238 //---------------------------new_instance--------------------------------------
4239 // This routine takes a klass_node which may be constant (for a static type)
4240 // or may be non-constant (for reflective code).  It will work equally well
4241 // for either, and the graph will fold nicely if the optimizer later reduces
4242 // the type to a constant.
4243 // The optional arguments are for specialized use by intrinsics:
4244 //  - If 'extra_slow_test' if not null is an extra condition for the slow-path.
4245 //  - If 'return_size_val', report the total object size to the caller.
4246 //  - deoptimize_on_exception controls how Java exceptions are handled (rethrow vs deoptimize)
4247 Node* GraphKit::new_instance(Node* klass_node,
4248                              Node* extra_slow_test,
4249                              Node* *return_size_val,
4250                              bool deoptimize_on_exception,
4251                              InlineTypeNode* inline_type_node) {
4252   // Compute size in doublewords
4253   // The size is always an integral number of doublewords, represented
4254   // as a positive bytewise size stored in the klass's layout_helper.
4255   // The layout_helper also encodes (in a low bit) the need for a slow path.
4256   jint  layout_con = Klass::_lh_neutral_value;
4257   Node* layout_val = get_layout_helper(klass_node, layout_con);
4258   bool  layout_is_con = (layout_val == nullptr);
4259 
4260   if (extra_slow_test == nullptr)  extra_slow_test = intcon(0);
4261   // Generate the initial go-slow test.  It's either ALWAYS (return a
4262   // Node for 1) or NEVER (return a null) or perhaps (in the reflective
4263   // case) a computed value derived from the layout_helper.
4264   Node* initial_slow_test = nullptr;
4265   if (layout_is_con) {
4266     assert(!StressReflectiveCode, "stress mode does not use these paths");
4267     bool must_go_slow = Klass::layout_helper_needs_slow_path(layout_con);
4268     initial_slow_test = must_go_slow ? intcon(1) : extra_slow_test;
4269   } else {   // reflective case
4270     // This reflective path is used by Unsafe.allocateInstance.
4271     // (It may be stress-tested by specifying StressReflectiveCode.)
4272     // Basically, we want to get into the VM is there's an illegal argument.
4273     Node* bit = intcon(Klass::_lh_instance_slow_path_bit);
4274     initial_slow_test = _gvn.transform( new AndINode(layout_val, bit) );
4275     if (extra_slow_test != intcon(0)) {
4276       initial_slow_test = _gvn.transform( new OrINode(initial_slow_test, extra_slow_test) );
4277     }
4278     // (Macro-expander will further convert this to a Bool, if necessary.)
4279   }
4280 
4281   // Find the size in bytes.  This is easy; it's the layout_helper.
4282   // The size value must be valid even if the slow path is taken.
4283   Node* size = nullptr;
4284   if (layout_is_con) {
4285     size = MakeConX(Klass::layout_helper_size_in_bytes(layout_con));
4286   } else {   // reflective case
4287     // This reflective path is used by clone and Unsafe.allocateInstance.
4288     size = ConvI2X(layout_val);
4289 
4290     // Clear the low bits to extract layout_helper_size_in_bytes:
4291     assert((int)Klass::_lh_instance_slow_path_bit < BytesPerLong, "clear bit");
4292     Node* mask = MakeConX(~ (intptr_t)right_n_bits(LogBytesPerLong));
4293     size = _gvn.transform( new AndXNode(size, mask) );
4294   }
4295   if (return_size_val != nullptr) {
4296     (*return_size_val) = size;
4297   }
4298 
4299   // This is a precise notnull oop of the klass.
4300   // (Actually, it need not be precise if this is a reflective allocation.)
4301   // It's what we cast the result to.
4302   const TypeKlassPtr* tklass = _gvn.type(klass_node)->isa_klassptr();
4303   if (!tklass)  tklass = TypeInstKlassPtr::OBJECT;
4304   const TypeOopPtr* oop_type = tklass->as_instance_type();
4305 
4306   // Now generate allocation code
4307 
4308   // The entire memory state is needed for slow path of the allocation
4309   // since GC and deoptimization can happen.
4310   Node *mem = reset_memory();
4311   set_all_memory(mem); // Create new memory state
4312 
4313   AllocateNode* alloc = new AllocateNode(C, AllocateNode::alloc_type(Type::TOP),
4314                                          control(), mem, i_o(),
4315                                          size, klass_node,
4316                                          initial_slow_test, inline_type_node);
4317 
4318   return set_output_for_allocation(alloc, oop_type, deoptimize_on_exception);
4319 }
4320 
4321 //-------------------------------new_array-------------------------------------
4322 // helper for newarray and anewarray
4323 // The 'length' parameter is (obviously) the length of the array.
4324 // The optional arguments are for specialized use by intrinsics:
4325 //  - If 'return_size_val', report the non-padded array size (sum of header size
4326 //    and array body) to the caller.
4327 //  - deoptimize_on_exception controls how Java exceptions are handled (rethrow vs deoptimize)
4328 Node* GraphKit::new_array(Node* klass_node,     // array klass (maybe variable)
4329                           Node* length,         // number of array elements
4330                           int   nargs,          // number of arguments to push back for uncommon trap
4331                           Node* *return_size_val,
4332                           bool deoptimize_on_exception,
4333                           Node* init_val) {
4334   jint  layout_con = Klass::_lh_neutral_value;
4335   Node* layout_val = get_layout_helper(klass_node, layout_con);
4336   bool  layout_is_con = (layout_val == nullptr);
4337 
4338   if (!layout_is_con && !StressReflectiveCode &&
4339       !too_many_traps(Deoptimization::Reason_class_check)) {
4340     // This is a reflective array creation site.
4341     // Optimistically assume that it is a subtype of Object[],
4342     // so that we can fold up all the address arithmetic.
4343     layout_con = Klass::array_layout_helper(T_OBJECT);
4344     Node* cmp_lh = _gvn.transform( new CmpINode(layout_val, intcon(layout_con)) );
4345     Node* bol_lh = _gvn.transform( new BoolNode(cmp_lh, BoolTest::eq) );
4346     { BuildCutout unless(this, bol_lh, PROB_MAX);
4347       inc_sp(nargs);
4348       uncommon_trap(Deoptimization::Reason_class_check,
4349                     Deoptimization::Action_maybe_recompile);
4350     }
4351     layout_val = nullptr;
4352     layout_is_con = true;
4353   }
4354 
4355   // Generate the initial go-slow test.  Make sure we do not overflow
4356   // if length is huge (near 2Gig) or negative!  We do not need
4357   // exact double-words here, just a close approximation of needed
4358   // double-words.  We can't add any offset or rounding bits, lest we
4359   // take a size -1 of bytes and make it positive.  Use an unsigned
4360   // compare, so negative sizes look hugely positive.
4361   int fast_size_limit = FastAllocateSizeLimit;
4362   if (layout_is_con) {
4363     assert(!StressReflectiveCode, "stress mode does not use these paths");
4364     // Increase the size limit if we have exact knowledge of array type.
4365     int log2_esize = Klass::layout_helper_log2_element_size(layout_con);
4366     fast_size_limit <<= MAX2(LogBytesPerLong - log2_esize, 0);
4367   }
4368 
4369   Node* initial_slow_cmp  = _gvn.transform( new CmpUNode( length, intcon( fast_size_limit ) ) );
4370   Node* initial_slow_test = _gvn.transform( new BoolNode( initial_slow_cmp, BoolTest::gt ) );
4371 
4372   // --- Size Computation ---
4373   // array_size = round_to_heap(array_header + (length << elem_shift));
4374   // where round_to_heap(x) == align_to(x, MinObjAlignmentInBytes)
4375   // and align_to(x, y) == ((x + y-1) & ~(y-1))
4376   // The rounding mask is strength-reduced, if possible.
4377   int round_mask = MinObjAlignmentInBytes - 1;
4378   Node* header_size = nullptr;
4379   // (T_BYTE has the weakest alignment and size restrictions...)
4380   if (layout_is_con) {
4381     int       hsize  = Klass::layout_helper_header_size(layout_con);
4382     int       eshift = Klass::layout_helper_log2_element_size(layout_con);
4383     bool is_flat_array = Klass::layout_helper_is_flatArray(layout_con);
4384     if ((round_mask & ~right_n_bits(eshift)) == 0)
4385       round_mask = 0;  // strength-reduce it if it goes away completely
4386     assert(is_flat_array || (hsize & right_n_bits(eshift)) == 0, "hsize is pre-rounded");
4387     int header_size_min = arrayOopDesc::base_offset_in_bytes(T_BYTE);
4388     assert(header_size_min <= hsize, "generic minimum is smallest");
4389     header_size = intcon(hsize);
4390   } else {
4391     Node* hss   = intcon(Klass::_lh_header_size_shift);
4392     Node* hsm   = intcon(Klass::_lh_header_size_mask);
4393     header_size = _gvn.transform(new URShiftINode(layout_val, hss));
4394     header_size = _gvn.transform(new AndINode(header_size, hsm));
4395   }
4396 
4397   Node* elem_shift = nullptr;
4398   if (layout_is_con) {
4399     int eshift = Klass::layout_helper_log2_element_size(layout_con);
4400     if (eshift != 0)
4401       elem_shift = intcon(eshift);
4402   } else {
4403     // There is no need to mask or shift this value.
4404     // The semantics of LShiftINode include an implicit mask to 0x1F.
4405     assert(Klass::_lh_log2_element_size_shift == 0, "use shift in place");
4406     elem_shift = layout_val;
4407   }
4408 
4409   // Transition to native address size for all offset calculations:
4410   Node* lengthx = ConvI2X(length);
4411   Node* headerx = ConvI2X(header_size);
4412 #ifdef _LP64
4413   { const TypeInt* tilen = _gvn.find_int_type(length);
4414     if (tilen != nullptr && tilen->_lo < 0) {
4415       // Add a manual constraint to a positive range.  Cf. array_element_address.
4416       jint size_max = fast_size_limit;
4417       if (size_max > tilen->_hi && tilen->_hi >= 0) {
4418         size_max = tilen->_hi;
4419       }
4420       const TypeInt* tlcon = TypeInt::make(0, size_max, Type::WidenMin);
4421 
4422       // Only do a narrow I2L conversion if the range check passed.
4423       IfNode* iff = new IfNode(control(), initial_slow_test, PROB_MIN, COUNT_UNKNOWN);
4424       _gvn.transform(iff);
4425       RegionNode* region = new RegionNode(3);
4426       _gvn.set_type(region, Type::CONTROL);
4427       lengthx = new PhiNode(region, TypeLong::LONG);
4428       _gvn.set_type(lengthx, TypeLong::LONG);
4429 
4430       // Range check passed. Use ConvI2L node with narrow type.
4431       Node* passed = IfFalse(iff);
4432       region->init_req(1, passed);
4433       // Make I2L conversion control dependent to prevent it from
4434       // floating above the range check during loop optimizations.
4435       lengthx->init_req(1, C->constrained_convI2L(&_gvn, length, tlcon, passed));
4436 
4437       // Range check failed. Use ConvI2L with wide type because length may be invalid.
4438       region->init_req(2, IfTrue(iff));
4439       lengthx->init_req(2, ConvI2X(length));
4440 
4441       set_control(region);
4442       record_for_igvn(region);
4443       record_for_igvn(lengthx);
4444     }
4445   }
4446 #endif
4447 
4448   // Combine header size and body size for the array copy part, then align (if
4449   // necessary) for the allocation part. This computation cannot overflow,
4450   // because it is used only in two places, one where the length is sharply
4451   // limited, and the other after a successful allocation.
4452   Node* abody = lengthx;
4453   if (elem_shift != nullptr) {
4454     abody = _gvn.transform(new LShiftXNode(lengthx, elem_shift));
4455   }
4456   Node* non_rounded_size = _gvn.transform(new AddXNode(headerx, abody));
4457 
4458   if (return_size_val != nullptr) {
4459     // This is the size
4460     (*return_size_val) = non_rounded_size;
4461   }
4462 
4463   Node* size = non_rounded_size;
4464   if (round_mask != 0) {
4465     Node* mask1 = MakeConX(round_mask);
4466     size = _gvn.transform(new AddXNode(size, mask1));
4467     Node* mask2 = MakeConX(~round_mask);
4468     size = _gvn.transform(new AndXNode(size, mask2));
4469   }
4470   // else if round_mask == 0, the size computation is self-rounding
4471 
4472   // Now generate allocation code
4473 
4474   // The entire memory state is needed for slow path of the allocation
4475   // since GC and deoptimization can happen.
4476   Node *mem = reset_memory();
4477   set_all_memory(mem); // Create new memory state
4478 
4479   if (initial_slow_test->is_Bool()) {
4480     // Hide it behind a CMoveI, or else PhaseIdealLoop::split_up will get sick.
4481     initial_slow_test = initial_slow_test->as_Bool()->as_int_value(&_gvn);
4482   }
4483 
4484   const TypeKlassPtr* ary_klass = _gvn.type(klass_node)->isa_klassptr();
4485   const TypeOopPtr* ary_type = ary_klass->as_instance_type();
4486 
4487   Node* raw_init_value = nullptr;
4488   if (init_val != nullptr) {
4489     // TODO 8350865 Fast non-zero init not implemented yet for flat, null-free arrays
4490     if (ary_type->is_flat()) {
4491       initial_slow_test = intcon(1);
4492     }
4493 
4494     if (UseCompressedOops) {
4495       // With compressed oops, the 64-bit init value is built from two 32-bit compressed oops
4496       init_val = _gvn.transform(new EncodePNode(init_val, init_val->bottom_type()->make_narrowoop()));
4497       Node* lower = _gvn.transform(new CastP2XNode(control(), init_val));
4498       Node* upper = _gvn.transform(new LShiftLNode(lower, intcon(32)));
4499       raw_init_value = _gvn.transform(new OrLNode(lower, upper));
4500     } else {
4501       raw_init_value = _gvn.transform(new CastP2XNode(control(), init_val));
4502     }
4503   }
4504 
4505   Node* valid_length_test = _gvn.intcon(1);
4506   if (ary_type->isa_aryptr()) {
4507     BasicType bt = ary_type->isa_aryptr()->elem()->array_element_basic_type();
4508     jint max = TypeAryPtr::max_array_length(bt);
4509     Node* valid_length_cmp  = _gvn.transform(new CmpUNode(length, intcon(max)));
4510     valid_length_test = _gvn.transform(new BoolNode(valid_length_cmp, BoolTest::le));
4511   }
4512 
4513   // Create the AllocateArrayNode and its result projections
4514   AllocateArrayNode* alloc
4515     = new AllocateArrayNode(C, AllocateArrayNode::alloc_type(TypeInt::INT),
4516                             control(), mem, i_o(),
4517                             size, klass_node,
4518                             initial_slow_test,
4519                             length, valid_length_test,
4520                             init_val, raw_init_value);
4521   // Cast to correct type.  Note that the klass_node may be constant or not,
4522   // and in the latter case the actual array type will be inexact also.
4523   // (This happens via a non-constant argument to inline_native_newArray.)
4524   // In any case, the value of klass_node provides the desired array type.
4525   const TypeInt* length_type = _gvn.find_int_type(length);
4526   if (ary_type->isa_aryptr() && length_type != nullptr) {
4527     // Try to get a better type than POS for the size
4528     ary_type = ary_type->is_aryptr()->cast_to_size(length_type);
4529   }
4530 
4531   Node* javaoop = set_output_for_allocation(alloc, ary_type, deoptimize_on_exception);
4532 
4533   array_ideal_length(alloc, ary_type, true);
4534   return javaoop;
4535 }
4536 
4537 // The following "Ideal_foo" functions are placed here because they recognize
4538 // the graph shapes created by the functions immediately above.
4539 
4540 //---------------------------Ideal_allocation----------------------------------
4541 // Given an oop pointer or raw pointer, see if it feeds from an AllocateNode.
4542 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr) {
4543   if (ptr == nullptr) {     // reduce dumb test in callers
4544     return nullptr;
4545   }
4546 
4547   BarrierSetC2* bs = BarrierSet::barrier_set()->barrier_set_c2();
4548   ptr = bs->step_over_gc_barrier(ptr);
4549 
4550   if (ptr->is_CheckCastPP()) { // strip only one raw-to-oop cast
4551     ptr = ptr->in(1);
4552     if (ptr == nullptr) return nullptr;
4553   }
4554   // Return null for allocations with several casts:
4555   //   j.l.reflect.Array.newInstance(jobject, jint)
4556   //   Object.clone()
4557   // to keep more precise type from last cast.
4558   if (ptr->is_Proj()) {
4559     Node* allo = ptr->in(0);
4560     if (allo != nullptr && allo->is_Allocate()) {
4561       return allo->as_Allocate();
4562     }
4563   }
4564   // Report failure to match.
4565   return nullptr;
4566 }
4567 
4568 // Fancy version which also strips off an offset (and reports it to caller).
4569 AllocateNode* AllocateNode::Ideal_allocation(Node* ptr, PhaseValues* phase,
4570                                              intptr_t& offset) {
4571   Node* base = AddPNode::Ideal_base_and_offset(ptr, phase, offset);
4572   if (base == nullptr)  return nullptr;
4573   return Ideal_allocation(base);
4574 }
4575 
4576 // Trace Initialize <- Proj[Parm] <- Allocate
4577 AllocateNode* InitializeNode::allocation() {
4578   Node* rawoop = in(InitializeNode::RawAddress);
4579   if (rawoop->is_Proj()) {
4580     Node* alloc = rawoop->in(0);
4581     if (alloc->is_Allocate()) {
4582       return alloc->as_Allocate();
4583     }
4584   }
4585   return nullptr;
4586 }
4587 
4588 // Trace Allocate -> Proj[Parm] -> Initialize
4589 InitializeNode* AllocateNode::initialization() {
4590   ProjNode* rawoop = proj_out_or_null(AllocateNode::RawAddress);
4591   if (rawoop == nullptr)  return nullptr;
4592   for (DUIterator_Fast imax, i = rawoop->fast_outs(imax); i < imax; i++) {
4593     Node* init = rawoop->fast_out(i);
4594     if (init->is_Initialize()) {
4595       assert(init->as_Initialize()->allocation() == this, "2-way link");
4596       return init->as_Initialize();
4597     }
4598   }
4599   return nullptr;
4600 }
4601 
4602 // Add a Parse Predicate with an uncommon trap on the failing/false path. Normal control will continue on the true path.
4603 void GraphKit::add_parse_predicate(Deoptimization::DeoptReason reason, const int nargs) {
4604   // Too many traps seen?
4605   if (too_many_traps(reason)) {
4606 #ifdef ASSERT
4607     if (TraceLoopPredicate) {
4608       int tc = C->trap_count(reason);
4609       tty->print("too many traps=%s tcount=%d in ",
4610                     Deoptimization::trap_reason_name(reason), tc);
4611       method()->print(); // which method has too many predicate traps
4612       tty->cr();
4613     }
4614 #endif
4615     // We cannot afford to take more traps here,
4616     // do not generate Parse Predicate.
4617     return;
4618   }
4619 
4620   ParsePredicateNode* parse_predicate = new ParsePredicateNode(control(), reason, &_gvn);
4621   _gvn.set_type(parse_predicate, parse_predicate->Value(&_gvn));
4622   Node* if_false = _gvn.transform(new IfFalseNode(parse_predicate));
4623   {
4624     PreserveJVMState pjvms(this);
4625     set_control(if_false);
4626     inc_sp(nargs);
4627     uncommon_trap(reason, Deoptimization::Action_maybe_recompile);
4628   }
4629   Node* if_true = _gvn.transform(new IfTrueNode(parse_predicate));
4630   set_control(if_true);
4631 }
4632 
4633 // Add Parse Predicates which serve as placeholders to create new Runtime Predicates above them. All
4634 // Runtime Predicates inside a Runtime Predicate block share the same uncommon trap as the Parse Predicate.
4635 void GraphKit::add_parse_predicates(int nargs) {
4636   if (ShortRunningLongLoop) {
4637     // Will narrow the limit down with a cast node. Predicates added later may depend on the cast so should be last when
4638     // walking up from the loop.
4639     add_parse_predicate(Deoptimization::Reason_short_running_long_loop, nargs);
4640   }
4641   if (UseLoopPredicate) {
4642     add_parse_predicate(Deoptimization::Reason_predicate, nargs);
4643     if (UseProfiledLoopPredicate) {
4644       add_parse_predicate(Deoptimization::Reason_profile_predicate, nargs);
4645     }
4646   }
4647   if (UseAutoVectorizationPredicate) {
4648     add_parse_predicate(Deoptimization::Reason_auto_vectorization_check, nargs);
4649   }
4650   // Loop Limit Check Predicate should be near the loop.
4651   add_parse_predicate(Deoptimization::Reason_loop_limit_check, nargs);
4652 }
4653 
4654 void GraphKit::sync_kit(IdealKit& ideal) {
4655   reset_memory();
4656   set_all_memory(ideal.merged_memory());
4657   set_i_o(ideal.i_o());
4658   set_control(ideal.ctrl());
4659 }
4660 
4661 void GraphKit::final_sync(IdealKit& ideal) {
4662   // Final sync IdealKit and graphKit.
4663   sync_kit(ideal);
4664 }
4665 
4666 Node* GraphKit::load_String_length(Node* str, bool set_ctrl) {
4667   Node* len = load_array_length(load_String_value(str, set_ctrl));
4668   Node* coder = load_String_coder(str, set_ctrl);
4669   // Divide length by 2 if coder is UTF16
4670   return _gvn.transform(new RShiftINode(len, coder));
4671 }
4672 
4673 Node* GraphKit::load_String_value(Node* str, bool set_ctrl) {
4674   int value_offset = java_lang_String::value_offset();
4675   const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4676                                                      false, nullptr, Type::Offset(0));
4677   const TypePtr* value_field_type = string_type->add_offset(value_offset);
4678   const TypeAryPtr* value_type = TypeAryPtr::make(TypePtr::NotNull,
4679                                                   TypeAry::make(TypeInt::BYTE, TypeInt::POS, false, false, true, true),
4680                                                   ciTypeArrayKlass::make(T_BYTE), true, Type::Offset(0));
4681   Node* p = basic_plus_adr(str, str, value_offset);
4682   Node* load = access_load_at(str, p, value_field_type, value_type, T_OBJECT,
4683                               IN_HEAP | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0) | MO_UNORDERED);
4684   return load;
4685 }
4686 
4687 Node* GraphKit::load_String_coder(Node* str, bool set_ctrl) {
4688   if (!CompactStrings) {
4689     return intcon(java_lang_String::CODER_UTF16);
4690   }
4691   int coder_offset = java_lang_String::coder_offset();
4692   const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4693                                                      false, nullptr, Type::Offset(0));
4694   const TypePtr* coder_field_type = string_type->add_offset(coder_offset);
4695 
4696   Node* p = basic_plus_adr(str, str, coder_offset);
4697   Node* load = access_load_at(str, p, coder_field_type, TypeInt::BYTE, T_BYTE,
4698                               IN_HEAP | (set_ctrl ? C2_CONTROL_DEPENDENT_LOAD : 0) | MO_UNORDERED);
4699   return load;
4700 }
4701 
4702 void GraphKit::store_String_value(Node* str, Node* value) {
4703   int value_offset = java_lang_String::value_offset();
4704   const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4705                                                      false, nullptr, Type::Offset(0));
4706   const TypePtr* value_field_type = string_type->add_offset(value_offset);
4707 
4708   access_store_at(str,  basic_plus_adr(str, value_offset), value_field_type,
4709                   value, TypeAryPtr::BYTES, T_OBJECT, IN_HEAP | MO_UNORDERED);
4710 }
4711 
4712 void GraphKit::store_String_coder(Node* str, Node* value) {
4713   int coder_offset = java_lang_String::coder_offset();
4714   const TypeInstPtr* string_type = TypeInstPtr::make(TypePtr::NotNull, C->env()->String_klass(),
4715                                                      false, nullptr, Type::Offset(0));
4716   const TypePtr* coder_field_type = string_type->add_offset(coder_offset);
4717 
4718   access_store_at(str, basic_plus_adr(str, coder_offset), coder_field_type,
4719                   value, TypeInt::BYTE, T_BYTE, IN_HEAP | MO_UNORDERED);
4720 }
4721 
4722 // Capture src and dst memory state with a MergeMemNode
4723 Node* GraphKit::capture_memory(const TypePtr* src_type, const TypePtr* dst_type) {
4724   if (src_type == dst_type) {
4725     // Types are equal, we don't need a MergeMemNode
4726     return memory(src_type);
4727   }
4728   MergeMemNode* merge = MergeMemNode::make(map()->memory());
4729   record_for_igvn(merge); // fold it up later, if possible
4730   int src_idx = C->get_alias_index(src_type);
4731   int dst_idx = C->get_alias_index(dst_type);
4732   merge->set_memory_at(src_idx, memory(src_idx));
4733   merge->set_memory_at(dst_idx, memory(dst_idx));
4734   return merge;
4735 }
4736 
4737 Node* GraphKit::compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count) {
4738   assert(Matcher::match_rule_supported(Op_StrCompressedCopy), "Intrinsic not supported");
4739   assert(src_type == TypeAryPtr::BYTES || src_type == TypeAryPtr::CHARS, "invalid source type");
4740   // If input and output memory types differ, capture both states to preserve
4741   // the dependency between preceding and subsequent loads/stores.
4742   // For example, the following program:
4743   //  StoreB
4744   //  compress_string
4745   //  LoadB
4746   // has this memory graph (use->def):
4747   //  LoadB -> compress_string -> CharMem
4748   //             ... -> StoreB -> ByteMem
4749   // The intrinsic hides the dependency between LoadB and StoreB, causing
4750   // the load to read from memory not containing the result of the StoreB.
4751   // The correct memory graph should look like this:
4752   //  LoadB -> compress_string -> MergeMem(CharMem, StoreB(ByteMem))
4753   Node* mem = capture_memory(src_type, TypeAryPtr::BYTES);
4754   StrCompressedCopyNode* str = new StrCompressedCopyNode(control(), mem, src, dst, count);
4755   Node* res_mem = _gvn.transform(new SCMemProjNode(_gvn.transform(str)));
4756   set_memory(res_mem, TypeAryPtr::BYTES);
4757   return str;
4758 }
4759 
4760 void GraphKit::inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count) {
4761   assert(Matcher::match_rule_supported(Op_StrInflatedCopy), "Intrinsic not supported");
4762   assert(dst_type == TypeAryPtr::BYTES || dst_type == TypeAryPtr::CHARS, "invalid dest type");
4763   // Capture src and dst memory (see comment in 'compress_string').
4764   Node* mem = capture_memory(TypeAryPtr::BYTES, dst_type);
4765   StrInflatedCopyNode* str = new StrInflatedCopyNode(control(), mem, src, dst, count);
4766   set_memory(_gvn.transform(str), dst_type);
4767 }
4768 
4769 void GraphKit::inflate_string_slow(Node* src, Node* dst, Node* start, Node* count) {
4770   /**
4771    * int i_char = start;
4772    * for (int i_byte = 0; i_byte < count; i_byte++) {
4773    *   dst[i_char++] = (char)(src[i_byte] & 0xff);
4774    * }
4775    */
4776   add_parse_predicates();
4777   C->set_has_loops(true);
4778 
4779   RegionNode* head = new RegionNode(3);
4780   head->init_req(1, control());
4781   gvn().set_type(head, Type::CONTROL);
4782   record_for_igvn(head);
4783 
4784   Node* i_byte = new PhiNode(head, TypeInt::INT);
4785   i_byte->init_req(1, intcon(0));
4786   gvn().set_type(i_byte, TypeInt::INT);
4787   record_for_igvn(i_byte);
4788 
4789   Node* i_char = new PhiNode(head, TypeInt::INT);
4790   i_char->init_req(1, start);
4791   gvn().set_type(i_char, TypeInt::INT);
4792   record_for_igvn(i_char);
4793 
4794   Node* mem = PhiNode::make(head, memory(TypeAryPtr::BYTES), Type::MEMORY, TypeAryPtr::BYTES);
4795   gvn().set_type(mem, Type::MEMORY);
4796   record_for_igvn(mem);
4797   set_control(head);
4798   set_memory(mem, TypeAryPtr::BYTES);
4799   Node* ch = load_array_element(src, i_byte, TypeAryPtr::BYTES, /* set_ctrl */ true);
4800   Node* st = store_to_memory(control(), array_element_address(dst, i_char, T_BYTE),
4801                              AndI(ch, intcon(0xff)), T_CHAR, MemNode::unordered, false,
4802                              false, true /* mismatched */);
4803 
4804   IfNode* iff = create_and_map_if(head, Bool(CmpI(i_byte, count), BoolTest::lt), PROB_FAIR, COUNT_UNKNOWN);
4805   head->init_req(2, IfTrue(iff));
4806   mem->init_req(2, st);
4807   i_byte->init_req(2, AddI(i_byte, intcon(1)));
4808   i_char->init_req(2, AddI(i_char, intcon(2)));
4809 
4810   set_control(IfFalse(iff));
4811   set_memory(st, TypeAryPtr::BYTES);
4812 }
4813 
4814 Node* GraphKit::make_constant_from_field(ciField* field, Node* obj) {
4815   if (!field->is_constant()) {
4816     return nullptr; // Field not marked as constant.
4817   }
4818   ciInstance* holder = nullptr;
4819   if (!field->is_static()) {
4820     ciObject* const_oop = obj->bottom_type()->is_oopptr()->const_oop();
4821     if (const_oop != nullptr && const_oop->is_instance()) {
4822       holder = const_oop->as_instance();
4823     }
4824   }
4825   const Type* con_type = Type::make_constant_from_field(field, holder, field->layout_type(),
4826                                                         /*is_unsigned_load=*/false);
4827   if (con_type != nullptr) {
4828     Node* con = makecon(con_type);
4829     if (field->type()->is_inlinetype()) {
4830       con = InlineTypeNode::make_from_oop(this, con, field->type()->as_inline_klass());
4831     } else if (con_type->is_inlinetypeptr()) {
4832       con = InlineTypeNode::make_from_oop(this, con, con_type->inline_klass());
4833     }
4834     return con;
4835   }
4836   return nullptr;
4837 }
4838 
4839 //---------------------------load_mirror_from_klass----------------------------
4840 // Given a klass oop, load its java mirror (a java.lang.Class oop).
4841 Node* GraphKit::load_mirror_from_klass(Node* klass) {
4842   Node* p = basic_plus_adr(klass, in_bytes(Klass::java_mirror_offset()));
4843   Node* load = make_load(nullptr, p, TypeRawPtr::NOTNULL, T_ADDRESS, MemNode::unordered);
4844   // mirror = ((OopHandle)mirror)->resolve();
4845   return access_load(load, TypeInstPtr::MIRROR, T_OBJECT, IN_NATIVE);
4846 }
4847 
4848 Node* GraphKit::maybe_narrow_object_type(Node* obj, ciKlass* type) {
4849   const Type* obj_type = obj->bottom_type();
4850   const TypeOopPtr* sig_type = TypeOopPtr::make_from_klass(type);
4851   if (obj_type->isa_oopptr() && sig_type->is_loaded() && !obj_type->higher_equal(sig_type)) {
4852     const Type* narrow_obj_type = obj_type->filter_speculative(sig_type); // keep speculative part
4853     Node* casted_obj = gvn().transform(new CheckCastPPNode(control(), obj, narrow_obj_type));
4854     obj = casted_obj;
4855   }
4856   if (sig_type->is_inlinetypeptr()) {
4857     obj = InlineTypeNode::make_from_oop(this, obj, sig_type->inline_klass());
4858   }
4859   return obj;
4860 }