1 /* 2 * Copyright (c) 2001, 2024, 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 #ifndef SHARE_OPTO_GRAPHKIT_HPP 26 #define SHARE_OPTO_GRAPHKIT_HPP 27 28 #include "ci/ciEnv.hpp" 29 #include "ci/ciMethodData.hpp" 30 #include "gc/shared/c2/barrierSetC2.hpp" 31 #include "opto/addnode.hpp" 32 #include "opto/callnode.hpp" 33 #include "opto/cfgnode.hpp" 34 #include "opto/compile.hpp" 35 #include "opto/divnode.hpp" 36 #include "opto/inlinetypenode.hpp" 37 #include "opto/mulnode.hpp" 38 #include "opto/phaseX.hpp" 39 #include "opto/subnode.hpp" 40 #include "opto/type.hpp" 41 #include "runtime/deoptimization.hpp" 42 43 class BarrierSetC2; 44 class FastLockNode; 45 class FastUnlockNode; 46 class IdealKit; 47 class LibraryCallKit; 48 class Parse; 49 class RootNode; 50 51 //----------------------------------------------------------------------------- 52 //----------------------------GraphKit----------------------------------------- 53 // Toolkit for building the common sorts of subgraphs. 54 // Does not know about bytecode parsing or type-flow results. 55 // It is able to create graphs implementing the semantics of most 56 // or all bytecodes, so that it can expand intrinsics and calls. 57 // It may depend on JVMState structure, but it must not depend 58 // on specific bytecode streams. 59 class GraphKit : public Phase { 60 friend class PreserveJVMState; 61 62 protected: 63 ciEnv* _env; // Compilation environment 64 PhaseGVN &_gvn; // Some optimizations while parsing 65 SafePointNode* _map; // Parser map from JVM to Nodes 66 SafePointNode* _exceptions;// Parser map(s) for exception state(s) 67 int _bci; // JVM Bytecode Pointer 68 ciMethod* _method; // JVM Current Method 69 BarrierSetC2* _barrier_set; 70 #ifdef ASSERT 71 uint _worklist_size; 72 #endif 73 74 private: 75 int _sp; // JVM Expression Stack Pointer; don't modify directly! 76 77 private: 78 SafePointNode* map_not_null() const { 79 assert(_map != nullptr, "must call stopped() to test for reset compiler map"); 80 return _map; 81 } 82 83 public: 84 GraphKit(); // empty constructor 85 GraphKit(JVMState* jvms, PhaseGVN* gvn = nullptr); // the JVM state on which to operate 86 87 #ifdef ASSERT 88 ~GraphKit() { 89 assert(failing_internal() || !has_exceptions(), 90 "unless compilation failed, user must call transfer_exceptions_into_jvms"); 91 #if 0 92 // During incremental inlining, the Node_Array of the C->for_igvn() worklist and the IGVN 93 // worklist are shared but the _in_worklist VectorSet is not. To avoid inconsistencies, 94 // we should not add nodes to the _for_igvn worklist when using IGVN for the GraphKit. 95 assert((_gvn.is_IterGVN() == nullptr) || (_gvn.C->for_igvn()->size() == _worklist_size), 96 "GraphKit should not modify _for_igvn worklist after parsing"); 97 #endif 98 } 99 #endif 100 101 virtual Parse* is_Parse() const { return nullptr; } 102 virtual LibraryCallKit* is_LibraryCallKit() const { return nullptr; } 103 104 ciEnv* env() const { return _env; } 105 PhaseGVN& gvn() const { return _gvn; } 106 void* barrier_set_state() const { return C->barrier_set_state(); } 107 108 void record_for_igvn(Node* n) const { _gvn.record_for_igvn(n); } 109 void remove_for_igvn(Node* n) const { C->remove_for_igvn(n); } 110 111 // Handy well-known nodes: 112 Node* null() const { return zerocon(T_OBJECT); } 113 Node* top() const { return C->top(); } 114 RootNode* root() const { return C->root(); } 115 116 // Create or find a constant node 117 Node* intcon(jint con) const { return _gvn.intcon(con); } 118 Node* longcon(jlong con) const { return _gvn.longcon(con); } 119 Node* integercon(jlong con, BasicType bt) const { 120 if (bt == T_INT) { 121 return intcon(checked_cast<jint>(con)); 122 } 123 assert(bt == T_LONG, "basic type not an int or long"); 124 return longcon(con); 125 } 126 Node* makecon(const Type *t) const { return _gvn.makecon(t); } 127 Node* zerocon(BasicType bt) const { return _gvn.zerocon(bt); } 128 // (See also macro MakeConX in type.hpp, which uses intcon or longcon.) 129 130 jint find_int_con(Node* n, jint value_if_unknown) { 131 return _gvn.find_int_con(n, value_if_unknown); 132 } 133 jlong find_long_con(Node* n, jlong value_if_unknown) { 134 return _gvn.find_long_con(n, value_if_unknown); 135 } 136 // (See also macro find_intptr_t_con in type.hpp, which uses one of these.) 137 138 // JVM State accessors: 139 // Parser mapping from JVM indices into Nodes. 140 // Low slots are accessed by the StartNode::enum. 141 // Then come the locals at StartNode::Parms to StartNode::Parms+max_locals(); 142 // Then come JVM stack slots. 143 // Finally come the monitors, if any. 144 // See layout accessors in class JVMState. 145 146 SafePointNode* map() const { return _map; } 147 bool has_exceptions() const { return _exceptions != nullptr; } 148 JVMState* jvms() const { return map_not_null()->_jvms; } 149 int sp() const { return _sp; } 150 int bci() const { return _bci; } 151 Bytecodes::Code java_bc() const; 152 ciMethod* method() const { return _method; } 153 154 void set_jvms(JVMState* jvms) { set_map(jvms->map()); 155 assert(jvms == this->jvms(), "sanity"); 156 _sp = jvms->sp(); 157 _bci = jvms->bci(); 158 _method = jvms->has_method() ? jvms->method() : nullptr; } 159 void set_map(SafePointNode* m) { _map = m; debug_only(verify_map()); } 160 void set_sp(int sp) { assert(sp >= 0, "sp must be non-negative: %d", sp); _sp = sp; } 161 void clean_stack(int from_sp); // clear garbage beyond from_sp to top 162 163 void inc_sp(int i) { set_sp(sp() + i); } 164 void dec_sp(int i) { set_sp(sp() - i); } 165 void set_bci(int bci) { _bci = bci; } 166 167 // Make sure jvms has current bci & sp. 168 JVMState* sync_jvms() const; 169 JVMState* sync_jvms_for_reexecute(); 170 171 #ifdef ASSERT 172 // Make sure JVMS has an updated copy of bci and sp. 173 // Also sanity-check method, depth, and monitor depth. 174 bool jvms_in_sync() const; 175 176 // Make sure the map looks OK. 177 void verify_map() const; 178 179 // Make sure a proposed exception state looks OK. 180 static void verify_exception_state(SafePointNode* ex_map); 181 #endif 182 183 // Clone the existing map state. (Implements PreserveJVMState.) 184 SafePointNode* clone_map(); 185 186 // Reverses the work done by clone_map(). Should only be used when the node returned by 187 // clone_map() is ultimately not used. Calling Node::destruct directly in the previously 188 // mentioned circumstance instead of this method may result in use-after-free. 189 void destruct_map_clone(SafePointNode* sfp); 190 191 // Set the map to a clone of the given one. 192 void set_map_clone(SafePointNode* m); 193 194 // Tell if the compilation is failing. 195 bool failing() const { return C->failing(); } 196 bool failing_internal() const { return C->failing_internal(); } 197 198 // Set _map to null, signalling a stop to further bytecode execution. 199 // Preserve the map intact for future use, and return it back to the caller. 200 SafePointNode* stop() { SafePointNode* m = map(); set_map(nullptr); return m; } 201 202 // Stop, but first smash the map's inputs to null, to mark it dead. 203 void stop_and_kill_map(); 204 205 // Tell if _map is null, or control is top. 206 bool stopped(); 207 208 // Tell if this method or any caller method has exception handlers. 209 bool has_exception_handler(); 210 211 // Save an exception without blowing stack contents or other JVM state. 212 // (The extra pointer is stuck with add_req on the map, beyond the JVMS.) 213 static void set_saved_ex_oop(SafePointNode* ex_map, Node* ex_oop); 214 215 // Recover a saved exception from its map. 216 static Node* saved_ex_oop(SafePointNode* ex_map); 217 218 // Recover a saved exception from its map, and remove it from the map. 219 static Node* clear_saved_ex_oop(SafePointNode* ex_map); 220 221 #ifdef ASSERT 222 // Recover a saved exception from its map, and remove it from the map. 223 static bool has_saved_ex_oop(SafePointNode* ex_map); 224 #endif 225 226 // Push an exception in the canonical position for handlers (stack(0)). 227 void push_ex_oop(Node* ex_oop) { 228 ensure_stack(1); // ensure room to push the exception 229 set_stack(0, ex_oop); 230 set_sp(1); 231 clean_stack(1); 232 } 233 234 // Detach and return an exception state. 235 SafePointNode* pop_exception_state() { 236 SafePointNode* ex_map = _exceptions; 237 if (ex_map != nullptr) { 238 _exceptions = ex_map->next_exception(); 239 ex_map->set_next_exception(nullptr); 240 debug_only(verify_exception_state(ex_map)); 241 } 242 return ex_map; 243 } 244 245 // Add an exception, using the given JVM state, without commoning. 246 void push_exception_state(SafePointNode* ex_map) { 247 debug_only(verify_exception_state(ex_map)); 248 ex_map->set_next_exception(_exceptions); 249 _exceptions = ex_map; 250 } 251 252 // Turn the current JVM state into an exception state, appending the ex_oop. 253 SafePointNode* make_exception_state(Node* ex_oop); 254 255 // Add an exception, using the given JVM state. 256 // Combine all exceptions with a common exception type into a single state. 257 // (This is done via combine_exception_states.) 258 void add_exception_state(SafePointNode* ex_map); 259 260 // Combine all exceptions of any sort whatever into a single master state. 261 SafePointNode* combine_and_pop_all_exception_states() { 262 if (_exceptions == nullptr) return nullptr; 263 SafePointNode* phi_map = pop_exception_state(); 264 SafePointNode* ex_map; 265 while ((ex_map = pop_exception_state()) != nullptr) { 266 combine_exception_states(ex_map, phi_map); 267 } 268 return phi_map; 269 } 270 271 // Combine the two exception states, building phis as necessary. 272 // The second argument is updated to include contributions from the first. 273 void combine_exception_states(SafePointNode* ex_map, SafePointNode* phi_map); 274 275 // Reset the map to the given state. If there are any half-finished phis 276 // in it (created by combine_exception_states), transform them now. 277 // Returns the exception oop. (Caller must call push_ex_oop if required.) 278 Node* use_exception_state(SafePointNode* ex_map); 279 280 // Collect exceptions from a given JVM state into my exception list. 281 void add_exception_states_from(JVMState* jvms); 282 283 // Collect all raised exceptions into the current JVM state. 284 // Clear the current exception list and map, returns the combined states. 285 JVMState* transfer_exceptions_into_jvms(); 286 287 // Helper to throw a built-in exception. 288 // The JVMS must allow the bytecode to be re-executed via an uncommon trap. 289 void builtin_throw(Deoptimization::DeoptReason reason); 290 291 // Helper to check the JavaThread::_should_post_on_exceptions flag 292 // and branch to an uncommon_trap if it is true (with the specified reason and must_throw) 293 void uncommon_trap_if_should_post_on_exceptions(Deoptimization::DeoptReason reason, 294 bool must_throw) ; 295 296 // Helper Functions for adding debug information 297 void kill_dead_locals(); 298 #ifdef ASSERT 299 bool dead_locals_are_killed(); 300 #endif 301 // The call may deoptimize. Supply required JVM state as debug info. 302 // If must_throw is true, the call is guaranteed not to return normally. 303 void add_safepoint_edges(SafePointNode* call, 304 bool must_throw = false); 305 306 // How many stack inputs does the current BC consume? 307 // And, how does the stack change after the bytecode? 308 // Returns false if unknown. 309 bool compute_stack_effects(int& inputs, int& depth); 310 311 // Add a fixed offset to a pointer 312 Node* basic_plus_adr(Node* base, Node* ptr, intptr_t offset) { 313 return basic_plus_adr(base, ptr, MakeConX(offset)); 314 } 315 Node* basic_plus_adr(Node* base, intptr_t offset) { 316 return basic_plus_adr(base, base, MakeConX(offset)); 317 } 318 // Add a variable offset to a pointer 319 Node* basic_plus_adr(Node* base, Node* offset) { 320 return basic_plus_adr(base, base, offset); 321 } 322 Node* basic_plus_adr(Node* base, Node* ptr, Node* offset); 323 324 325 // Some convenient shortcuts for common nodes 326 Node* IfTrue(IfNode* iff) { return _gvn.transform(new IfTrueNode(iff)); } 327 Node* IfFalse(IfNode* iff) { return _gvn.transform(new IfFalseNode(iff)); } 328 329 Node* AddI(Node* l, Node* r) { return _gvn.transform(new AddINode(l, r)); } 330 Node* SubI(Node* l, Node* r) { return _gvn.transform(new SubINode(l, r)); } 331 Node* MulI(Node* l, Node* r) { return _gvn.transform(new MulINode(l, r)); } 332 Node* DivI(Node* ctl, Node* l, Node* r) { return _gvn.transform(new DivINode(ctl, l, r)); } 333 334 Node* AndI(Node* l, Node* r) { return _gvn.transform(new AndINode(l, r)); } 335 Node* OrI(Node* l, Node* r) { return _gvn.transform(new OrINode(l, r)); } 336 Node* XorI(Node* l, Node* r) { return _gvn.transform(new XorINode(l, r)); } 337 338 Node* MaxI(Node* l, Node* r) { return _gvn.transform(new MaxINode(l, r)); } 339 Node* MinI(Node* l, Node* r) { return _gvn.transform(new MinINode(l, r)); } 340 341 Node* LShiftI(Node* l, Node* r) { return _gvn.transform(new LShiftINode(l, r)); } 342 Node* RShiftI(Node* l, Node* r) { return _gvn.transform(new RShiftINode(l, r)); } 343 Node* URShiftI(Node* l, Node* r) { return _gvn.transform(new URShiftINode(l, r)); } 344 345 Node* CmpI(Node* l, Node* r) { return _gvn.transform(new CmpINode(l, r)); } 346 Node* CmpL(Node* l, Node* r) { return _gvn.transform(new CmpLNode(l, r)); } 347 Node* CmpP(Node* l, Node* r) { return _gvn.transform(new CmpPNode(l, r)); } 348 Node* Bool(Node* cmp, BoolTest::mask relop) { return _gvn.transform(new BoolNode(cmp, relop)); } 349 350 Node* AddP(Node* b, Node* a, Node* o) { return _gvn.transform(new AddPNode(b, a, o)); } 351 352 // Convert between int and long, and size_t. 353 // (See macros ConvI2X, etc., in type.hpp for ConvI2X, etc.) 354 Node* ConvI2L(Node* offset); 355 Node* ConvI2UL(Node* offset); 356 Node* ConvL2I(Node* offset); 357 // Find out the klass of an object. 358 Node* load_object_klass(Node* object); 359 // Find out the length of an array. 360 Node* load_array_length(Node* array); 361 // Cast array allocation's length as narrow as possible. 362 // If replace_length_in_map is true, replace length with CastIINode in map. 363 // This method is invoked after creating/moving ArrayAllocationNode or in load_array_length 364 Node* array_ideal_length(AllocateArrayNode* alloc, 365 const TypeOopPtr* oop_type, 366 bool replace_length_in_map); 367 368 369 // Helper function to do a null pointer check or ZERO check based on type. 370 // Throw an exception if a given value is null. 371 // Return the value cast to not-null. 372 // Be clever about equivalent dominating null checks. 373 Node* null_check_common(Node* value, BasicType type, 374 bool assert_null = false, 375 Node* *null_control = nullptr, 376 bool speculative = false, 377 bool is_init_check = false); 378 Node* null_check(Node* value, BasicType type = T_OBJECT) { 379 return null_check_common(value, type, false, nullptr, !_gvn.type(value)->speculative_maybe_null()); 380 } 381 Node* null_check_receiver() { 382 return null_check(argument(0)); 383 } 384 Node* zero_check_int(Node* value) { 385 assert(value->bottom_type()->basic_type() == T_INT, 386 "wrong type: %s", type2name(value->bottom_type()->basic_type())); 387 return null_check_common(value, T_INT); 388 } 389 Node* zero_check_long(Node* value) { 390 assert(value->bottom_type()->basic_type() == T_LONG, 391 "wrong type: %s", type2name(value->bottom_type()->basic_type())); 392 return null_check_common(value, T_LONG); 393 } 394 // Throw an uncommon trap if a given value is __not__ null. 395 // Return the value cast to null, and be clever about dominating checks. 396 Node* null_assert(Node* value, BasicType type = T_OBJECT) { 397 return null_check_common(value, type, true, nullptr, _gvn.type(value)->speculative_always_null()); 398 } 399 400 // Check if value is null and abort if it is 401 Node* must_be_not_null(Node* value, bool do_replace_in_map); 402 403 // Null check oop. Return null-path control into (*null_control). 404 // Return a cast-not-null node which depends on the not-null control. 405 // If never_see_null, use an uncommon trap (*null_control sees a top). 406 // The cast is not valid along the null path; keep a copy of the original. 407 // If safe_for_replace, then we can replace the value with the cast 408 // in the parsing map (the cast is guaranteed to dominate the map) 409 Node* null_check_oop(Node* value, Node* *null_control, 410 bool never_see_null = false, 411 bool safe_for_replace = false, 412 bool speculative = false); 413 414 // Check the null_seen bit. 415 bool seems_never_null(Node* obj, ciProfileData* data, bool& speculating); 416 417 void guard_klass_being_initialized(Node* klass); 418 void guard_init_thread(Node* klass); 419 420 void clinit_barrier(ciInstanceKlass* ik, ciMethod* context); 421 422 // Check for unique class for receiver at call 423 ciKlass* profile_has_unique_klass() { 424 ciCallProfile profile = method()->call_profile_at_bci(bci()); 425 if (profile.count() >= 0 && // no cast failures here 426 profile.has_receiver(0) && 427 profile.morphism() == 1) { 428 return profile.receiver(0); 429 } 430 return nullptr; 431 } 432 433 // record type from profiling with the type system 434 Node* record_profile_for_speculation(Node* n, ciKlass* exact_kls, ProfilePtrKind ptr_kind); 435 void record_profiled_arguments_for_speculation(ciMethod* dest_method, Bytecodes::Code bc); 436 void record_profiled_parameters_for_speculation(); 437 void record_profiled_return_for_speculation(); 438 Node* record_profiled_receiver_for_speculation(Node* n); 439 440 // Use the type profile to narrow an object type. 441 Node* maybe_cast_profiled_receiver(Node* not_null_obj, 442 const TypeKlassPtr* require_klass, 443 ciKlass* spec, 444 bool safe_for_replace); 445 446 // Cast obj to type and emit guard unless we had too many traps here already 447 Node* maybe_cast_profiled_obj(Node* obj, 448 ciKlass* type, 449 bool not_null = false); 450 451 // Cast obj to not-null on this path 452 Node* cast_not_null(Node* obj, bool do_replace_in_map = true); 453 // Replace all occurrences of one node by another. 454 void replace_in_map(Node* old, Node* neww); 455 456 Node* maybe_narrow_object_type(Node* obj, ciKlass* type); 457 458 void push(Node* n) { map_not_null(); _map->set_stack(_map->_jvms, _sp++ , n); } 459 Node* pop() { map_not_null(); return _map->stack( _map->_jvms, --_sp ); } 460 Node* peek(int off = 0) { map_not_null(); return _map->stack( _map->_jvms, _sp - off - 1 ); } 461 462 void push_pair(Node* ldval) { 463 push(ldval); 464 push(top()); // the halfword is merely a placeholder 465 } 466 void push_pair_local(int i) { 467 // longs are stored in locals in "push" order 468 push( local(i+0) ); // the real value 469 assert(local(i+1) == top(), ""); 470 push(top()); // halfword placeholder 471 } 472 Node* pop_pair() { 473 // the second half is pushed last & popped first; it contains exactly nothing 474 Node* halfword = pop(); 475 assert(halfword == top(), ""); 476 // the long bits are pushed first & popped last: 477 return pop(); 478 } 479 void set_pair_local(int i, Node* lval) { 480 // longs are stored in locals as a value/half pair (like doubles) 481 set_local(i+0, lval); 482 set_local(i+1, top()); 483 } 484 485 // Push the node, which may be zero, one, or two words. 486 void push_node(BasicType n_type, Node* n) { 487 int n_size = type2size[n_type]; 488 if (n_size == 1) push( n ); // T_INT, ... 489 else if (n_size == 2) push_pair( n ); // T_DOUBLE, T_LONG 490 else { assert(n_size == 0, "must be T_VOID"); } 491 } 492 493 Node* pop_node(BasicType n_type) { 494 int n_size = type2size[n_type]; 495 if (n_size == 1) return pop(); 496 else if (n_size == 2) return pop_pair(); 497 else return nullptr; 498 } 499 500 Node* control() const { return map_not_null()->control(); } 501 Node* i_o() const { return map_not_null()->i_o(); } 502 Node* returnadr() const { return map_not_null()->returnadr(); } 503 Node* frameptr() const { return map_not_null()->frameptr(); } 504 Node* local(uint idx) const { map_not_null(); return _map->local( _map->_jvms, idx); } 505 Node* stack(uint idx) const { map_not_null(); return _map->stack( _map->_jvms, idx); } 506 Node* argument(uint idx) const { map_not_null(); return _map->argument( _map->_jvms, idx); } 507 Node* monitor_box(uint idx) const { map_not_null(); return _map->monitor_box(_map->_jvms, idx); } 508 Node* monitor_obj(uint idx) const { map_not_null(); return _map->monitor_obj(_map->_jvms, idx); } 509 510 void set_control (Node* c) { map_not_null()->set_control(c); } 511 void set_i_o (Node* c) { map_not_null()->set_i_o(c); } 512 void set_local(uint idx, Node* c) { map_not_null(); _map->set_local( _map->_jvms, idx, c); } 513 void set_stack(uint idx, Node* c) { map_not_null(); _map->set_stack( _map->_jvms, idx, c); } 514 void set_argument(uint idx, Node* c){ map_not_null(); _map->set_argument(_map->_jvms, idx, c); } 515 void ensure_stack(uint stk_size) { map_not_null(); _map->ensure_stack(_map->_jvms, stk_size); } 516 517 // Access unaliased memory 518 Node* memory(uint alias_idx); 519 Node* memory(const TypePtr *tp) { return memory(C->get_alias_index(tp)); } 520 Node* memory(Node* adr) { return memory(_gvn.type(adr)->is_ptr()); } 521 522 // Access immutable memory 523 Node* immutable_memory() { return C->immutable_memory(); } 524 525 // Set unaliased memory 526 void set_memory(Node* c, uint alias_idx) { merged_memory()->set_memory_at(alias_idx, c); } 527 void set_memory(Node* c, const TypePtr *tp) { set_memory(c,C->get_alias_index(tp)); } 528 void set_memory(Node* c, Node* adr) { set_memory(c,_gvn.type(adr)->is_ptr()); } 529 530 // Get the entire memory state (probably a MergeMemNode), and reset it 531 // (The resetting prevents somebody from using the dangling Node pointer.) 532 Node* reset_memory(); 533 534 // Get the entire memory state, asserted to be a MergeMemNode. 535 MergeMemNode* merged_memory() { 536 Node* mem = map_not_null()->memory(); 537 assert(mem->is_MergeMem(), "parse memory is always pre-split"); 538 return mem->as_MergeMem(); 539 } 540 541 // Set the entire memory state; produce a new MergeMemNode. 542 void set_all_memory(Node* newmem); 543 544 // Create a memory projection from the call, then set_all_memory. 545 void set_all_memory_call(Node* call, bool separate_io_proj = false); 546 547 // Create a LoadNode, reading from the parser's memory state. 548 // (Note: require_atomic_access is useful only with T_LONG.) 549 // 550 // We choose the unordered semantics by default because we have 551 // adapted the `do_put_xxx' and `do_get_xxx' procedures for the case 552 // of volatile fields. 553 Node* make_load(Node* ctl, Node* adr, const Type* t, BasicType bt, 554 MemNode::MemOrd mo, LoadNode::ControlDependency control_dependency = LoadNode::DependsOnlyOnTest, 555 bool require_atomic_access = false, bool unaligned = false, 556 bool mismatched = false, bool unsafe = false, uint8_t barrier_data = 0); 557 558 // Create & transform a StoreNode and store the effect into the 559 // parser's memory state. 560 // 561 // We must ensure that stores of object references will be visible 562 // only after the object's initialization. So the clients of this 563 // procedure must indicate that the store requires `release' 564 // semantics, if the stored value is an object reference that might 565 // point to a new object and may become externally visible. 566 // Return the new StoreXNode 567 Node* store_to_memory(Node* ctl, Node* adr, Node* val, BasicType bt, 568 MemNode::MemOrd, 569 bool require_atomic_access = false, 570 bool unaligned = false, 571 bool mismatched = false, 572 bool unsafe = false, 573 int barrier_data = 0); 574 575 // Perform decorated accesses 576 577 Node* access_store_at(Node* obj, // containing obj 578 Node* adr, // actual address to store val at 579 const TypePtr* adr_type, 580 Node* val, 581 const Type* val_type, 582 BasicType bt, 583 DecoratorSet decorators, 584 bool safe_for_replace = true, 585 const InlineTypeNode* vt = nullptr); 586 587 Node* access_load_at(Node* obj, // containing obj 588 Node* adr, // actual address to load val at 589 const TypePtr* adr_type, 590 const Type* val_type, 591 BasicType bt, 592 DecoratorSet decorators, 593 Node* ctl = nullptr); 594 595 Node* access_load(Node* adr, // actual address to load val at 596 const Type* val_type, 597 BasicType bt, 598 DecoratorSet decorators); 599 600 Node* access_atomic_cmpxchg_val_at(Node* obj, 601 Node* adr, 602 const TypePtr* adr_type, 603 int alias_idx, 604 Node* expected_val, 605 Node* new_val, 606 const Type* value_type, 607 BasicType bt, 608 DecoratorSet decorators); 609 610 Node* access_atomic_cmpxchg_bool_at(Node* obj, 611 Node* adr, 612 const TypePtr* adr_type, 613 int alias_idx, 614 Node* expected_val, 615 Node* new_val, 616 const Type* value_type, 617 BasicType bt, 618 DecoratorSet decorators); 619 620 Node* access_atomic_xchg_at(Node* obj, 621 Node* adr, 622 const TypePtr* adr_type, 623 int alias_idx, 624 Node* new_val, 625 const Type* value_type, 626 BasicType bt, 627 DecoratorSet decorators); 628 629 Node* access_atomic_add_at(Node* obj, 630 Node* adr, 631 const TypePtr* adr_type, 632 int alias_idx, 633 Node* new_val, 634 const Type* value_type, 635 BasicType bt, 636 DecoratorSet decorators); 637 638 void access_clone(Node* src, Node* dst, Node* size, bool is_array); 639 640 // Return addressing for an array element. 641 Node* array_element_address(Node* ary, Node* idx, BasicType elembt, 642 // Optional constraint on the array size: 643 const TypeInt* sizetype = nullptr, 644 // Optional control dependency (for example, on range check) 645 Node* ctrl = nullptr); 646 Node* flat_array_element_address(Node*& array, Node* idx, ciInlineKlass* vk, bool is_null_free, 647 bool is_not_null_free, bool is_atomic); 648 649 // Return a load of array element at idx. 650 Node* load_array_element(Node* ary, Node* idx, const TypeAryPtr* arytype, bool set_ctrl); 651 652 //---------------- Dtrace support -------------------- 653 void make_dtrace_method_entry_exit(ciMethod* method, bool is_entry); 654 void make_dtrace_method_entry(ciMethod* method) { 655 make_dtrace_method_entry_exit(method, true); 656 } 657 void make_dtrace_method_exit(ciMethod* method) { 658 make_dtrace_method_entry_exit(method, false); 659 } 660 661 //--------------- stub generation ------------------- 662 public: 663 void gen_stub(address C_function, 664 const char *name, 665 int is_fancy_jump, 666 bool pass_tls, 667 bool return_pc); 668 669 //---------- help for generating calls -------------- 670 671 // Do a null check on the receiver as it would happen before the call to 672 // callee (with all arguments still on the stack). 673 Node* null_check_receiver_before_call(ciMethod* callee) { 674 assert(!callee->is_static(), "must be a virtual method"); 675 // Callsite signature can be different from actual method being called (i.e _linkTo* sites). 676 // Use callsite signature always. 677 ciMethod* declared_method = method()->get_method_at_bci(bci()); 678 const int nargs = declared_method->arg_size(); 679 inc_sp(nargs); 680 Node* n = null_check_receiver(); 681 dec_sp(nargs); 682 return n; 683 } 684 685 // Fill in argument edges for the call from argument(0), argument(1), ... 686 // (The next step is to call set_edges_for_java_call.) 687 void set_arguments_for_java_call(CallJavaNode* call, bool is_late_inline = false); 688 689 // Fill in non-argument edges for the call. 690 // Transform the call, and update the basics: control, i_o, memory. 691 // (The next step is usually to call set_results_for_java_call.) 692 void set_edges_for_java_call(CallJavaNode* call, 693 bool must_throw = false, bool separate_io_proj = false); 694 695 // Finish up a java call that was started by set_edges_for_java_call. 696 // Call add_exception on any throw arising from the call. 697 // Return the call result (transformed). 698 Node* set_results_for_java_call(CallJavaNode* call, bool separate_io_proj = false, bool deoptimize = false); 699 700 // Similar to set_edges_for_java_call, but simplified for runtime calls. 701 void set_predefined_output_for_runtime_call(Node* call) { 702 set_predefined_output_for_runtime_call(call, nullptr, nullptr); 703 } 704 void set_predefined_output_for_runtime_call(Node* call, 705 Node* keep_mem, 706 const TypePtr* hook_mem); 707 Node* set_predefined_input_for_runtime_call(SafePointNode* call, Node* narrow_mem = nullptr); 708 709 // Replace the call with the current state of the kit. Requires 710 // that the call was generated with separate io_projs so that 711 // exceptional control flow can be handled properly. 712 void replace_call(CallNode* call, Node* result, bool do_replaced_nodes = false, bool do_asserts = true); 713 714 // helper functions for statistics 715 void increment_counter(address counter_addr); // increment a debug counter 716 void increment_counter(Node* counter_addr); // increment a debug counter 717 718 // Bail out to the interpreter right now 719 // The optional klass is the one causing the trap. 720 // The optional reason is debug information written to the compile log. 721 // Optional must_throw is the same as with add_safepoint_edges. 722 Node* uncommon_trap(int trap_request, 723 ciKlass* klass = nullptr, const char* reason_string = nullptr, 724 bool must_throw = false, bool keep_exact_action = false); 725 726 // Shorthand, to avoid saying "Deoptimization::" so many times. 727 Node* uncommon_trap(Deoptimization::DeoptReason reason, 728 Deoptimization::DeoptAction action, 729 ciKlass* klass = nullptr, const char* reason_string = nullptr, 730 bool must_throw = false, bool keep_exact_action = false) { 731 return uncommon_trap(Deoptimization::make_trap_request(reason, action), 732 klass, reason_string, must_throw, keep_exact_action); 733 } 734 735 // Bail out to the interpreter and keep exact action (avoid switching to Action_none). 736 Node* uncommon_trap_exact(Deoptimization::DeoptReason reason, 737 Deoptimization::DeoptAction action, 738 ciKlass* klass = nullptr, const char* reason_string = nullptr, 739 bool must_throw = false) { 740 return uncommon_trap(Deoptimization::make_trap_request(reason, action), 741 klass, reason_string, must_throw, /*keep_exact_action=*/true); 742 } 743 744 // SP when bytecode needs to be reexecuted. 745 virtual int reexecute_sp() { return sp(); } 746 747 // Report if there were too many traps at the current method and bci. 748 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded. 749 // If there is no MDO at all, report no trap unless told to assume it. 750 bool too_many_traps(Deoptimization::DeoptReason reason) { 751 return C->too_many_traps(method(), bci(), reason); 752 } 753 754 // Report if there were too many recompiles at the current method and bci. 755 bool too_many_recompiles(Deoptimization::DeoptReason reason) { 756 return C->too_many_recompiles(method(), bci(), reason); 757 } 758 759 bool too_many_traps_or_recompiles(Deoptimization::DeoptReason reason) { 760 return C->too_many_traps_or_recompiles(method(), bci(), reason); 761 } 762 763 // Returns the object (if any) which was created the moment before. 764 Node* just_allocated_object(Node* current_control); 765 766 // Sync Ideal and Graph kits. 767 void sync_kit(IdealKit& ideal); 768 void final_sync(IdealKit& ideal); 769 770 public: 771 // Helper function to round double arguments before a call 772 void round_double_arguments(ciMethod* dest_method); 773 774 // rounding for strict float precision conformance 775 Node* precision_rounding(Node* n); 776 777 // rounding for strict double precision conformance 778 Node* dprecision_rounding(Node* n); 779 780 // Helper functions for fast/slow path codes 781 Node* opt_iff(Node* region, Node* iff); 782 Node* make_runtime_call(int flags, 783 const TypeFunc* call_type, address call_addr, 784 const char* call_name, 785 const TypePtr* adr_type, // null if no memory effects 786 Node* parm0 = nullptr, Node* parm1 = nullptr, 787 Node* parm2 = nullptr, Node* parm3 = nullptr, 788 Node* parm4 = nullptr, Node* parm5 = nullptr, 789 Node* parm6 = nullptr, Node* parm7 = nullptr); 790 791 Node* sign_extend_byte(Node* in); 792 Node* sign_extend_short(Node* in); 793 794 enum { // flag values for make_runtime_call 795 RC_NO_FP = 1, // CallLeafNoFPNode 796 RC_NO_IO = 2, // do not hook IO edges 797 RC_NO_LEAF = 4, // CallStaticJavaNode 798 RC_MUST_THROW = 8, // flag passed to add_safepoint_edges 799 RC_NARROW_MEM = 16, // input memory is same as output 800 RC_UNCOMMON = 32, // freq. expected to be like uncommon trap 801 RC_VECTOR = 64, // CallLeafVectorNode 802 RC_LEAF = 0 // null value: no flags set 803 }; 804 805 // merge in all memory slices from new_mem, along the given path 806 void merge_memory(Node* new_mem, Node* region, int new_path); 807 void make_slow_call_ex(Node* call, ciInstanceKlass* ex_klass, bool separate_io_proj, bool deoptimize = false); 808 809 // Helper functions to build synchronizations 810 int next_monitor(); 811 Node* insert_mem_bar(int opcode, Node* precedent = nullptr); 812 Node* insert_mem_bar_volatile(int opcode, int alias_idx, Node* precedent = nullptr); 813 // Optional 'precedent' is appended as an extra edge, to force ordering. 814 FastLockNode* shared_lock(Node* obj); 815 void shared_unlock(Node* box, Node* obj); 816 817 // helper functions for the fast path/slow path idioms 818 Node* fast_and_slow(Node* in, const Type *result_type, Node* null_result, IfNode* fast_test, Node* fast_result, address slow_call, const TypeFunc *slow_call_type, Node* slow_arg, Klass* ex_klass, Node* slow_result); 819 820 // Generate an instance-of idiom. Used by both the instance-of bytecode 821 // and the reflective instance-of call. 822 Node* gen_instanceof(Node *subobj, Node* superkls, bool safe_for_replace = false); 823 824 // Generate a check-cast idiom. Used by both the check-cast bytecode 825 // and the array-store bytecode 826 Node* gen_checkcast(Node *subobj, Node* superkls, Node* *failure_control = nullptr, bool null_free = false); 827 828 // Inline types 829 Node* mark_word_test(Node* obj, uintptr_t mask_val, bool eq, bool check_lock = true); 830 Node* inline_type_test(Node* obj, bool is_inline = true); 831 Node* flat_array_test(Node* array_or_klass, bool flat = true); 832 Node* null_free_array_test(Node* array, bool null_free = true); 833 Node* null_free_atomic_array_test(Node* array, ciInlineKlass* vk); 834 Node* inline_array_null_guard(Node* ary, Node* val, int nargs, bool safe_for_replace = false); 835 836 Node* gen_subtype_check(Node* obj, Node* superklass); 837 838 // Exact type check used for predicted calls and casts. 839 // Rewrites (*casted_receiver) to be casted to the stronger type. 840 // (Caller is responsible for doing replace_in_map.) 841 Node* type_check_receiver(Node* receiver, ciKlass* klass, float prob, 842 Node* *casted_receiver); 843 Node* type_check(Node* recv_klass, const TypeKlassPtr* tklass, float prob); 844 845 // Inexact type check used for predicted calls. 846 Node* subtype_check_receiver(Node* receiver, ciKlass* klass, 847 Node** casted_receiver); 848 849 // implementation of object creation 850 Node* set_output_for_allocation(AllocateNode* alloc, 851 const TypeOopPtr* oop_type, 852 bool deoptimize_on_exception=false); 853 Node* get_layout_helper(Node* klass_node, jint& constant_value); 854 Node* new_instance(Node* klass_node, 855 Node* slow_test = nullptr, 856 Node* *return_size_val = nullptr, 857 bool deoptimize_on_exception = false, 858 InlineTypeNode* inline_type_node = nullptr); 859 Node* new_array(Node* klass_node, Node* count_val, int nargs, 860 Node* *return_size_val = nullptr, 861 bool deoptimize_on_exception = false); 862 863 // java.lang.String helpers 864 Node* load_String_length(Node* str, bool set_ctrl); 865 Node* load_String_value(Node* str, bool set_ctrl); 866 Node* load_String_coder(Node* str, bool set_ctrl); 867 void store_String_value(Node* str, Node* value); 868 void store_String_coder(Node* str, Node* value); 869 Node* capture_memory(const TypePtr* src_type, const TypePtr* dst_type); 870 Node* compress_string(Node* src, const TypeAryPtr* src_type, Node* dst, Node* count); 871 void inflate_string(Node* src, Node* dst, const TypeAryPtr* dst_type, Node* count); 872 void inflate_string_slow(Node* src, Node* dst, Node* start, Node* count); 873 874 // Handy for making control flow 875 IfNode* create_and_map_if(Node* ctrl, Node* tst, float prob, float cnt) { 876 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's 877 _gvn.set_type(iff, iff->Value(&_gvn)); // Value may be known at parse-time 878 // Place 'if' on worklist if it will be in graph 879 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later 880 return iff; 881 } 882 883 IfNode* create_and_xform_if(Node* ctrl, Node* tst, float prob, float cnt) { 884 IfNode* iff = new IfNode(ctrl, tst, prob, cnt);// New IfNode's 885 _gvn.transform(iff); // Value may be known at parse-time 886 // Place 'if' on worklist if it will be in graph 887 if (!tst->is_Con()) record_for_igvn(iff); // Range-check and Null-check removal is later 888 return iff; 889 } 890 891 void add_parse_predicates(int nargs = 0); 892 void add_parse_predicate(Deoptimization::DeoptReason reason, int nargs); 893 894 Node* make_constant_from_field(ciField* field, Node* obj); 895 Node* load_mirror_from_klass(Node* klass); 896 897 // Vector API support (implemented in vectorIntrinsics.cpp) 898 Node* box_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem, bool deoptimize_on_exception = false); 899 Node* unbox_vector(Node* in, const TypeInstPtr* vbox_type, BasicType elem_bt, int num_elem); 900 Node* vector_shift_count(Node* cnt, int shift_op, BasicType bt, int num_elem); 901 }; 902 903 // Helper class to support building of control flow branches. Upon 904 // creation the map and sp at bci are cloned and restored upon de- 905 // struction. Typical use: 906 // 907 // { PreserveJVMState pjvms(this); 908 // // code of new branch 909 // } 910 // // here the JVM state at bci is established 911 912 class PreserveJVMState: public StackObj { 913 protected: 914 GraphKit* _kit; 915 #ifdef ASSERT 916 int _block; // PO of current block, if a Parse 917 int _bci; 918 #endif 919 SafePointNode* _map; 920 uint _sp; 921 922 public: 923 PreserveJVMState(GraphKit* kit, bool clone_map = true); 924 ~PreserveJVMState(); 925 }; 926 927 // Helper class to build cutouts of the form if (p) ; else {x...}. 928 // The code {x...} must not fall through. 929 // The kit's main flow of control is set to the "then" continuation of if(p). 930 class BuildCutout: public PreserveJVMState { 931 public: 932 BuildCutout(GraphKit* kit, Node* p, float prob, float cnt = COUNT_UNKNOWN); 933 ~BuildCutout(); 934 }; 935 936 // Helper class to preserve the original _reexecute bit and _sp and restore 937 // them back 938 class PreserveReexecuteState: public StackObj { 939 protected: 940 GraphKit* _kit; 941 uint _sp; 942 JVMState::ReexecuteState _reexecute; 943 944 public: 945 PreserveReexecuteState(GraphKit* kit); 946 ~PreserveReexecuteState(); 947 }; 948 949 #endif // SHARE_OPTO_GRAPHKIT_HPP