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