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