1 /*
2 * Copyright (c) 2000, 2025, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
24
25 #include "ci/bcEscapeAnalyzer.hpp"
26 #include "ci/ciCallSite.hpp"
27 #include "ci/ciObjArray.hpp"
28 #include "ci/ciMemberName.hpp"
29 #include "ci/ciMethodHandle.hpp"
30 #include "classfile/javaClasses.hpp"
31 #include "compiler/compileLog.hpp"
32 #include "opto/addnode.hpp"
33 #include "opto/callGenerator.hpp"
34 #include "opto/callnode.hpp"
35 #include "opto/castnode.hpp"
36 #include "opto/cfgnode.hpp"
37 #include "opto/parse.hpp"
38 #include "opto/rootnode.hpp"
39 #include "opto/runtime.hpp"
40 #include "opto/subnode.hpp"
41 #include "runtime/os.inline.hpp"
42 #include "runtime/sharedRuntime.hpp"
43 #include "utilities/debug.hpp"
44
45 // Utility function.
46 const TypeFunc* CallGenerator::tf() const {
47 return TypeFunc::make(method());
48 }
49
50 bool CallGenerator::is_inlined_method_handle_intrinsic(JVMState* jvms, ciMethod* m) {
51 return is_inlined_method_handle_intrinsic(jvms->method(), jvms->bci(), m);
52 }
53
54 bool CallGenerator::is_inlined_method_handle_intrinsic(ciMethod* caller, int bci, ciMethod* m) {
55 ciMethod* symbolic_info = caller->get_method_at_bci(bci);
56 return is_inlined_method_handle_intrinsic(symbolic_info, m);
57 }
58
59 bool CallGenerator::is_inlined_method_handle_intrinsic(ciMethod* symbolic_info, ciMethod* m) {
60 return symbolic_info->is_method_handle_intrinsic() && !m->is_method_handle_intrinsic();
61 }
62
63 //-----------------------------ParseGenerator---------------------------------
64 // Internal class which handles all direct bytecode traversal.
65 class ParseGenerator : public InlineCallGenerator {
66 private:
67 bool _is_osr;
68 float _expected_uses;
69
70 public:
71 ParseGenerator(ciMethod* method, float expected_uses, bool is_osr = false)
72 : InlineCallGenerator(method)
73 {
74 _is_osr = is_osr;
75 _expected_uses = expected_uses;
76 assert(InlineTree::check_can_parse(method) == nullptr, "parse must be possible");
77 }
78
79 virtual bool is_parse() const { return true; }
80 virtual JVMState* generate(JVMState* jvms);
81 int is_osr() { return _is_osr; }
82
83 };
84
85 JVMState* ParseGenerator::generate(JVMState* jvms) {
86 Compile* C = Compile::current();
87
88 if (is_osr()) {
89 // The JVMS for a OSR has a single argument (see its TypeFunc).
90 assert(jvms->depth() == 1, "no inline OSR");
91 }
92
93 if (C->failing()) {
94 return nullptr; // bailing out of the compile; do not try to parse
95 }
96
97 Parse parser(jvms, method(), _expected_uses);
98 if (C->failing()) return nullptr;
99
100 // Grab signature for matching/allocation
101 GraphKit& exits = parser.exits();
102
103 if (C->failing()) {
104 while (exits.pop_exception_state() != nullptr) ;
105 return nullptr;
106 }
107
108 assert(exits.jvms()->same_calls_as(jvms), "sanity");
109
110 // Simply return the exit state of the parser,
111 // augmented by any exceptional states.
112 return exits.transfer_exceptions_into_jvms();
113 }
114
115 //---------------------------DirectCallGenerator------------------------------
116 // Internal class which handles all out-of-line calls w/o receiver type checks.
117 class DirectCallGenerator : public CallGenerator {
118 private:
119 CallStaticJavaNode* _call_node;
120 // Force separate memory and I/O projections for the exceptional
121 // paths to facilitate late inlinig.
122 bool _separate_io_proj;
123
124 protected:
125 void set_call_node(CallStaticJavaNode* call) { _call_node = call; }
126
127 public:
128 DirectCallGenerator(ciMethod* method, bool separate_io_proj)
129 : CallGenerator(method),
130 _separate_io_proj(separate_io_proj)
131 {
132 }
133 virtual JVMState* generate(JVMState* jvms);
134
135 virtual CallNode* call_node() const { return _call_node; }
136 virtual CallGenerator* with_call_node(CallNode* call) {
137 DirectCallGenerator* dcg = new DirectCallGenerator(method(), _separate_io_proj);
138 dcg->set_call_node(call->as_CallStaticJava());
139 return dcg;
140 }
141 };
142
143 JVMState* DirectCallGenerator::generate(JVMState* jvms) {
144 GraphKit kit(jvms);
145 bool is_static = method()->is_static();
146 address target = is_static ? SharedRuntime::get_resolve_static_call_stub()
147 : SharedRuntime::get_resolve_opt_virtual_call_stub();
148
149 if (kit.C->log() != nullptr) {
150 kit.C->log()->elem("direct_call bci='%d'", jvms->bci());
151 }
152
153 CallStaticJavaNode* call = new CallStaticJavaNode(kit.C, tf(), target, method());
154 if (is_inlined_method_handle_intrinsic(jvms, method())) {
155 // To be able to issue a direct call and skip a call to MH.linkTo*/invokeBasic adapter,
156 // additional information about the method being invoked should be attached
157 // to the call site to make resolution logic work
158 // (see SharedRuntime::resolve_static_call_C).
159 call->set_override_symbolic_info(true);
160 }
161 _call_node = call; // Save the call node in case we need it later
162 if (!is_static) {
163 // Make an explicit receiver null_check as part of this call.
164 // Since we share a map with the caller, his JVMS gets adjusted.
165 kit.null_check_receiver_before_call(method());
166 if (kit.stopped()) {
167 // And dump it back to the caller, decorated with any exceptions:
168 return kit.transfer_exceptions_into_jvms();
169 }
170 // Mark the call node as virtual, sort of:
171 call->set_optimized_virtual(true);
172 if (method()->is_method_handle_intrinsic() ||
173 method()->is_compiled_lambda_form()) {
174 call->set_method_handle_invoke(true);
175 }
176 }
177 kit.set_arguments_for_java_call(call);
178 kit.set_edges_for_java_call(call, false, _separate_io_proj);
179 Node* ret = kit.set_results_for_java_call(call, _separate_io_proj);
180 kit.push_node(method()->return_type()->basic_type(), ret);
181 return kit.transfer_exceptions_into_jvms();
182 }
183
184 //--------------------------VirtualCallGenerator------------------------------
185 // Internal class which handles all out-of-line calls checking receiver type.
186 class VirtualCallGenerator : public CallGenerator {
187 private:
188 int _vtable_index;
189 bool _separate_io_proj;
190 CallDynamicJavaNode* _call_node;
191
192 protected:
193 void set_call_node(CallDynamicJavaNode* call) { _call_node = call; }
194
195 public:
196 VirtualCallGenerator(ciMethod* method, int vtable_index, bool separate_io_proj)
197 : CallGenerator(method), _vtable_index(vtable_index), _separate_io_proj(separate_io_proj), _call_node(nullptr)
198 {
199 assert(vtable_index == Method::invalid_vtable_index ||
200 vtable_index >= 0, "either invalid or usable");
201 }
202 virtual bool is_virtual() const { return true; }
203 virtual JVMState* generate(JVMState* jvms);
204
205 virtual CallNode* call_node() const { return _call_node; }
206 int vtable_index() const { return _vtable_index; }
207
208 virtual CallGenerator* with_call_node(CallNode* call) {
209 VirtualCallGenerator* cg = new VirtualCallGenerator(method(), _vtable_index, _separate_io_proj);
210 cg->set_call_node(call->as_CallDynamicJava());
211 return cg;
212 }
213 };
214
215 JVMState* VirtualCallGenerator::generate(JVMState* jvms) {
216 GraphKit kit(jvms);
217 Node* receiver = kit.argument(0);
218
219 if (kit.C->log() != nullptr) {
220 kit.C->log()->elem("virtual_call bci='%d'", jvms->bci());
221 }
222
223 // If the receiver is a constant null, do not torture the system
224 // by attempting to call through it. The compile will proceed
225 // correctly, but may bail out in final_graph_reshaping, because
226 // the call instruction will have a seemingly deficient out-count.
227 // (The bailout says something misleading about an "infinite loop".)
228 if (kit.gvn().type(receiver)->higher_equal(TypePtr::NULL_PTR)) {
229 assert(Bytecodes::is_invoke(kit.java_bc()), "%d: %s", kit.java_bc(), Bytecodes::name(kit.java_bc()));
230 ciMethod* declared_method = kit.method()->get_method_at_bci(kit.bci());
231 int arg_size = declared_method->signature()->arg_size_for_bc(kit.java_bc());
232 kit.inc_sp(arg_size); // restore arguments
233 kit.uncommon_trap(Deoptimization::Reason_null_check,
234 Deoptimization::Action_none,
235 nullptr, "null receiver");
236 return kit.transfer_exceptions_into_jvms();
237 }
238
239 // Ideally we would unconditionally do a null check here and let it
240 // be converted to an implicit check based on profile information.
241 // However currently the conversion to implicit null checks in
242 // Block::implicit_null_check() only looks for loads and stores, not calls.
243 ciMethod *caller = kit.method();
244 ciMethodData *caller_md = (caller == nullptr) ? nullptr : caller->method_data();
245 if (!UseInlineCaches || !ImplicitNullChecks || !os::zero_page_read_protected() ||
246 ((ImplicitNullCheckThreshold > 0) && caller_md &&
247 (caller_md->trap_count(Deoptimization::Reason_null_check)
248 >= (uint)ImplicitNullCheckThreshold))) {
249 // Make an explicit receiver null_check as part of this call.
250 // Since we share a map with the caller, his JVMS gets adjusted.
251 receiver = kit.null_check_receiver_before_call(method());
252 if (kit.stopped()) {
253 // And dump it back to the caller, decorated with any exceptions:
254 return kit.transfer_exceptions_into_jvms();
255 }
256 }
257
258 assert(!method()->is_static(), "virtual call must not be to static");
259 assert(!method()->is_final(), "virtual call should not be to final");
260 assert(!method()->is_private(), "virtual call should not be to private");
261 assert(_vtable_index == Method::invalid_vtable_index || !UseInlineCaches,
262 "no vtable calls if +UseInlineCaches ");
263 address target = SharedRuntime::get_resolve_virtual_call_stub();
264 // Normal inline cache used for call
265 CallDynamicJavaNode* call = new CallDynamicJavaNode(tf(), target, method(), _vtable_index);
266 if (is_inlined_method_handle_intrinsic(jvms, method())) {
267 // To be able to issue a direct call (optimized virtual or virtual)
268 // and skip a call to MH.linkTo*/invokeBasic adapter, additional information
269 // about the method being invoked should be attached to the call site to
270 // make resolution logic work (see SharedRuntime::resolve_{virtual,opt_virtual}_call_C).
271 call->set_override_symbolic_info(true);
272 }
273 _call_node = call; // Save the call node in case we need it later
274
275 kit.set_arguments_for_java_call(call);
276 kit.set_edges_for_java_call(call, false /*must_throw*/, _separate_io_proj);
277 Node* ret = kit.set_results_for_java_call(call, _separate_io_proj);
278 kit.push_node(method()->return_type()->basic_type(), ret);
279
280 // Represent the effect of an implicit receiver null_check
281 // as part of this call. Since we share a map with the caller,
282 // his JVMS gets adjusted.
283 kit.cast_not_null(receiver);
284 return kit.transfer_exceptions_into_jvms();
285 }
286
287 CallGenerator* CallGenerator::for_inline(ciMethod* m, float expected_uses) {
288 if (InlineTree::check_can_parse(m) != nullptr) return nullptr;
289 return new ParseGenerator(m, expected_uses);
290 }
291
292 // As a special case, the JVMS passed to this CallGenerator is
293 // for the method execution already in progress, not just the JVMS
294 // of the caller. Thus, this CallGenerator cannot be mixed with others!
295 CallGenerator* CallGenerator::for_osr(ciMethod* m, int osr_bci) {
296 if (InlineTree::check_can_parse(m) != nullptr) return nullptr;
297 float past_uses = m->interpreter_invocation_count();
298 float expected_uses = past_uses;
299 return new ParseGenerator(m, expected_uses, true);
300 }
301
302 CallGenerator* CallGenerator::for_direct_call(ciMethod* m, bool separate_io_proj) {
303 assert(!m->is_abstract(), "for_direct_call mismatch");
304 return new DirectCallGenerator(m, separate_io_proj);
305 }
306
307 CallGenerator* CallGenerator::for_virtual_call(ciMethod* m, int vtable_index) {
308 assert(!m->is_static(), "for_virtual_call mismatch");
309 assert(!m->is_method_handle_intrinsic(), "should be a direct call");
310 return new VirtualCallGenerator(m, vtable_index, false /*separate_io_projs*/);
311 }
312
313 // Allow inlining decisions to be delayed
314 class LateInlineCallGenerator : public DirectCallGenerator {
315 private:
316 jlong _unique_id; // unique id for log compilation
317 bool _is_pure_call; // a hint that the call doesn't have important side effects to care about
318
319 protected:
320 CallGenerator* _inline_cg;
321 virtual bool do_late_inline_check(Compile* C, JVMState* jvms) { return true; }
322 virtual CallGenerator* inline_cg() const { return _inline_cg; }
323 virtual bool is_pure_call() const { return _is_pure_call; }
324
325 public:
326 LateInlineCallGenerator(ciMethod* method, CallGenerator* inline_cg, bool is_pure_call = false) :
327 DirectCallGenerator(method, true), _unique_id(0), _is_pure_call(is_pure_call), _inline_cg(inline_cg) {}
328
329 virtual bool is_late_inline() const { return true; }
330
331 // Convert the CallStaticJava into an inline
332 virtual void do_late_inline();
333
334 virtual JVMState* generate(JVMState* jvms) {
335 Compile *C = Compile::current();
336
337 C->log_inline_id(this);
338
339 // Record that this call site should be revisited once the main
340 // parse is finished.
341 if (!is_mh_late_inline()) {
342 C->add_late_inline(this);
343 }
344
345 // Emit the CallStaticJava and request separate projections so
346 // that the late inlining logic can distinguish between fall
347 // through and exceptional uses of the memory and io projections
348 // as is done for allocations and macro expansion.
349 return DirectCallGenerator::generate(jvms);
350 }
351
352 virtual void set_unique_id(jlong id) {
353 _unique_id = id;
354 }
355
356 virtual jlong unique_id() const {
357 return _unique_id;
358 }
359
360 virtual CallGenerator* with_call_node(CallNode* call) {
361 LateInlineCallGenerator* cg = new LateInlineCallGenerator(method(), _inline_cg, _is_pure_call);
362 cg->set_call_node(call->as_CallStaticJava());
363 return cg;
364 }
365 };
366
367 CallGenerator* CallGenerator::for_late_inline(ciMethod* method, CallGenerator* inline_cg) {
368 return new LateInlineCallGenerator(method, inline_cg);
369 }
370
371 class LateInlineMHCallGenerator : public LateInlineCallGenerator {
372 ciMethod* _caller;
373 bool _input_not_const;
374
375 virtual bool do_late_inline_check(Compile* C, JVMState* jvms);
376
377 public:
378 LateInlineMHCallGenerator(ciMethod* caller, ciMethod* callee, bool input_not_const) :
379 LateInlineCallGenerator(callee, nullptr), _caller(caller), _input_not_const(input_not_const) {}
380
381 virtual bool is_mh_late_inline() const { return true; }
382
383 // Convert the CallStaticJava into an inline
384 virtual void do_late_inline();
385
386 virtual JVMState* generate(JVMState* jvms) {
387 JVMState* new_jvms = LateInlineCallGenerator::generate(jvms);
388
389 Compile* C = Compile::current();
390 if (_input_not_const) {
391 // inlining won't be possible so no need to enqueue right now.
392 call_node()->set_generator(this);
393 } else {
394 C->add_late_inline(this);
395 }
396 return new_jvms;
397 }
398
399 virtual CallGenerator* with_call_node(CallNode* call) {
400 LateInlineMHCallGenerator* cg = new LateInlineMHCallGenerator(_caller, method(), _input_not_const);
401 cg->set_call_node(call->as_CallStaticJava());
402 return cg;
403 }
404 };
405
406 bool LateInlineMHCallGenerator::do_late_inline_check(Compile* C, JVMState* jvms) {
407 // When inlining a virtual call, the null check at the call and the call itself can throw. These 2 paths have different
408 // expression stacks which causes late inlining to break. The MH invoker is not expected to be called from a method with
409 // exception handlers. When there is no exception handler, GraphKit::builtin_throw() pops the stack which solves the issue
410 // of late inlining with exceptions.
411 assert(!jvms->method()->has_exception_handlers() ||
412 (method()->intrinsic_id() != vmIntrinsics::_linkToVirtual &&
413 method()->intrinsic_id() != vmIntrinsics::_linkToInterface), "no exception handler expected");
414 // Even if inlining is not allowed, a virtual call can be strength-reduced to a direct call.
415 bool allow_inline = C->inlining_incrementally();
416 bool input_not_const = true;
417 CallGenerator* cg = for_method_handle_inline(jvms, _caller, method(), allow_inline, input_not_const);
418 assert(!input_not_const, "sanity"); // shouldn't have been scheduled for inlining in the first place
419
420 if (cg != nullptr) {
421 if (!allow_inline) {
422 C->inline_printer()->record(cg->method(), call_node()->jvms(), InliningResult::FAILURE,
423 "late method handle call resolution");
424 }
425 assert(!cg->is_late_inline() || cg->is_mh_late_inline() || AlwaysIncrementalInline || StressIncrementalInlining, "we're doing late inlining");
426 _inline_cg = cg;
427 C->dec_number_of_mh_late_inlines();
428 return true;
429 } else {
430 // Method handle call which has a constant appendix argument should be either inlined or replaced with a direct call
431 // unless there's a signature mismatch between caller and callee. If the failure occurs, there's not much to be improved later,
432 // so don't reinstall the generator to avoid pushing the generator between IGVN and incremental inlining indefinitely.
433 return false;
434 }
435 }
436
437 CallGenerator* CallGenerator::for_mh_late_inline(ciMethod* caller, ciMethod* callee, bool input_not_const) {
438 assert(IncrementalInlineMH, "required");
439 Compile::current()->inc_number_of_mh_late_inlines();
440 CallGenerator* cg = new LateInlineMHCallGenerator(caller, callee, input_not_const);
441 return cg;
442 }
443
444 // Allow inlining decisions to be delayed
445 class LateInlineVirtualCallGenerator : public VirtualCallGenerator {
446 private:
447 jlong _unique_id; // unique id for log compilation
448 CallGenerator* _inline_cg;
449 ciMethod* _callee;
450 bool _is_pure_call;
451 float _prof_factor;
452
453 protected:
454 virtual bool do_late_inline_check(Compile* C, JVMState* jvms);
455 virtual CallGenerator* inline_cg() const { return _inline_cg; }
456 virtual bool is_pure_call() const { return _is_pure_call; }
457
458 public:
459 LateInlineVirtualCallGenerator(ciMethod* method, int vtable_index, float prof_factor)
460 : VirtualCallGenerator(method, vtable_index, true /*separate_io_projs*/),
461 _unique_id(0), _inline_cg(nullptr), _callee(nullptr), _is_pure_call(false), _prof_factor(prof_factor) {
462 assert(IncrementalInlineVirtual, "required");
463 }
464
465 virtual bool is_late_inline() const { return true; }
466
467 virtual bool is_virtual_late_inline() const { return true; }
468
469 // Convert the CallDynamicJava into an inline
470 virtual void do_late_inline();
471
472 virtual void set_callee_method(ciMethod* m) {
473 assert(_callee == nullptr, "repeated inlining attempt");
474 _callee = m;
475 }
476
477 virtual JVMState* generate(JVMState* jvms) {
478 // Emit the CallDynamicJava and request separate projections so
479 // that the late inlining logic can distinguish between fall
480 // through and exceptional uses of the memory and io projections
481 // as is done for allocations and macro expansion.
482 JVMState* new_jvms = VirtualCallGenerator::generate(jvms);
483 if (call_node() != nullptr) {
484 call_node()->set_generator(this);
485 }
486 return new_jvms;
487 }
488
489 virtual void set_unique_id(jlong id) {
490 _unique_id = id;
491 }
492
493 virtual jlong unique_id() const {
494 return _unique_id;
495 }
496
497 virtual CallGenerator* with_call_node(CallNode* call) {
498 LateInlineVirtualCallGenerator* cg = new LateInlineVirtualCallGenerator(method(), vtable_index(), _prof_factor);
499 cg->set_call_node(call->as_CallDynamicJava());
500 return cg;
501 }
502 };
503
504 bool LateInlineVirtualCallGenerator::do_late_inline_check(Compile* C, JVMState* jvms) {
505 // Method handle linker case is handled in CallDynamicJavaNode::Ideal().
506 // Unless inlining is performed, _override_symbolic_info bit will be set in DirectCallGenerator::generate().
507
508 // Implicit receiver null checks introduce problems when exception states are combined.
509 Node* receiver = jvms->map()->argument(jvms, 0);
510 const Type* recv_type = C->initial_gvn()->type(receiver);
511 if (recv_type->maybe_null()) {
512 C->inline_printer()->record(method(), call_node()->jvms(), InliningResult::FAILURE,
513 "late call devirtualization failed (receiver may be null)");
514 return false;
515 }
516 // Even if inlining is not allowed, a virtual call can be strength-reduced to a direct call.
517 bool allow_inline = C->inlining_incrementally();
518 if (!allow_inline && _callee->holder()->is_interface()) {
519 // Don't convert the interface call to a direct call guarded by an interface subtype check.
520 C->inline_printer()->record(method(), call_node()->jvms(), InliningResult::FAILURE,
521 "late call devirtualization failed (interface call)");
522 return false;
523 }
524 CallGenerator* cg = C->call_generator(_callee,
525 vtable_index(),
526 false /*call_does_dispatch*/,
527 jvms,
528 allow_inline,
529 _prof_factor,
530 nullptr /*speculative_receiver_type*/,
531 true /*allow_intrinsics*/);
532
533 if (cg != nullptr) {
534 if (!allow_inline) {
535 C->inline_printer()->record(cg->method(), call_node()->jvms(), InliningResult::FAILURE, "late call devirtualization");
536 }
537 assert(!cg->is_late_inline() || cg->is_mh_late_inline() || AlwaysIncrementalInline || StressIncrementalInlining, "we're doing late inlining");
538 _inline_cg = cg;
539 return true;
540 } else {
541 // Virtual call which provably doesn't dispatch should be either inlined or replaced with a direct call.
542 assert(false, "no progress");
543 return false;
544 }
545 }
546
547 CallGenerator* CallGenerator::for_late_inline_virtual(ciMethod* m, int vtable_index, float prof_factor) {
548 assert(IncrementalInlineVirtual, "required");
549 assert(!m->is_static(), "for_virtual_call mismatch");
550 assert(!m->is_method_handle_intrinsic(), "should be a direct call");
551 return new LateInlineVirtualCallGenerator(m, vtable_index, prof_factor);
552 }
553
554 void LateInlineCallGenerator::do_late_inline() {
555 CallGenerator::do_late_inline_helper();
556 }
557
558 void LateInlineMHCallGenerator::do_late_inline() {
559 CallGenerator::do_late_inline_helper();
560 }
561
562 void LateInlineVirtualCallGenerator::do_late_inline() {
563 assert(_callee != nullptr, "required"); // set up in CallDynamicJavaNode::Ideal
564 CallGenerator::do_late_inline_helper();
565 }
566
567 void CallGenerator::do_late_inline_helper() {
568 assert(is_late_inline(), "only late inline allowed");
569
570 // Can't inline it
571 CallNode* call = call_node();
572 if (call == nullptr || call->outcnt() == 0 ||
573 call->in(0) == nullptr || call->in(0)->is_top()) {
574 return;
575 }
576
577 const TypeTuple *r = call->tf()->domain();
578 for (int i1 = 0; i1 < method()->arg_size(); i1++) {
579 if (call->in(TypeFunc::Parms + i1)->is_top() && r->field_at(TypeFunc::Parms + i1) != Type::HALF) {
580 assert(Compile::current()->inlining_incrementally(), "shouldn't happen during parsing");
581 return;
582 }
583 }
584
585 if (call->in(TypeFunc::Memory)->is_top()) {
586 assert(Compile::current()->inlining_incrementally(), "shouldn't happen during parsing");
587 return;
588 }
589 if (call->in(TypeFunc::Memory)->is_MergeMem()) {
590 MergeMemNode* merge_mem = call->in(TypeFunc::Memory)->as_MergeMem();
591 if (merge_mem->base_memory() == merge_mem->empty_memory()) {
592 return; // dead path
593 }
594 }
595
596 // check for unreachable loop
597 CallProjections callprojs;
598 // Similar to incremental inlining, don't assert that all call
599 // projections are still there for post-parse call devirtualization.
600 bool do_asserts = !is_mh_late_inline() && !is_virtual_late_inline();
601 call->extract_projections(&callprojs, true, do_asserts);
602 if ((callprojs.fallthrough_catchproj == call->in(0)) ||
603 (callprojs.catchall_catchproj == call->in(0)) ||
604 (callprojs.fallthrough_memproj == call->in(TypeFunc::Memory)) ||
605 (callprojs.catchall_memproj == call->in(TypeFunc::Memory)) ||
606 (callprojs.fallthrough_ioproj == call->in(TypeFunc::I_O)) ||
607 (callprojs.catchall_ioproj == call->in(TypeFunc::I_O)) ||
608 (callprojs.resproj != nullptr && call->find_edge(callprojs.resproj) != -1) ||
609 (callprojs.exobj != nullptr && call->find_edge(callprojs.exobj) != -1)) {
610 return;
611 }
612
613 Compile* C = Compile::current();
614 // Remove inlined methods from Compiler's lists.
615 if (call->is_macro()) {
616 C->remove_macro_node(call);
617 }
618
619 // The call is marked as pure (no important side effects), but result isn't used.
620 // It's safe to remove the call.
621 bool result_not_used = (callprojs.resproj == nullptr || callprojs.resproj->outcnt() == 0);
622
623 if (is_pure_call() && result_not_used) {
624 GraphKit kit(call->jvms());
625 kit.replace_call(call, C->top(), true, do_asserts);
626 } else {
627 // Make a clone of the JVMState that appropriate to use for driving a parse
628 JVMState* old_jvms = call->jvms();
629 JVMState* jvms = old_jvms->clone_shallow(C);
630 uint size = call->req();
631 SafePointNode* map = new SafePointNode(size, jvms);
632 for (uint i1 = 0; i1 < size; i1++) {
633 map->init_req(i1, call->in(i1));
634 }
635
636 // Make sure the state is a MergeMem for parsing.
637 if (!map->in(TypeFunc::Memory)->is_MergeMem()) {
638 Node* mem = MergeMemNode::make(map->in(TypeFunc::Memory));
639 C->initial_gvn()->set_type_bottom(mem);
640 map->set_req(TypeFunc::Memory, mem);
641 }
642
643 uint nargs = method()->arg_size();
644 // blow away old call arguments
645 Node* top = C->top();
646 for (uint i1 = 0; i1 < nargs; i1++) {
647 map->set_req(TypeFunc::Parms + i1, top);
648 }
649 jvms->set_map(map);
650
651 // Make enough space in the expression stack to transfer
652 // the incoming arguments and return value.
653 map->ensure_stack(jvms, jvms->method()->max_stack());
654 for (uint i1 = 0; i1 < nargs; i1++) {
655 map->set_argument(jvms, i1, call->in(TypeFunc::Parms + i1));
656 }
657
658 C->log_late_inline(this);
659
660 // JVMState is ready, so time to perform some checks and prepare for inlining attempt.
661 if (!do_late_inline_check(C, jvms)) {
662 map->disconnect_inputs(C);
663 return;
664 }
665
666 // Setup default node notes to be picked up by the inlining
667 Node_Notes* old_nn = C->node_notes_at(call->_idx);
668 if (old_nn != nullptr) {
669 Node_Notes* entry_nn = old_nn->clone(C);
670 entry_nn->set_jvms(jvms);
671 C->set_default_node_notes(entry_nn);
672 }
673
674 // Now perform the inlining using the synthesized JVMState
675 JVMState* new_jvms = inline_cg()->generate(jvms);
676 if (new_jvms == nullptr) return; // no change
677 if (C->failing()) return;
678
679 if (is_mh_late_inline()) {
680 C->inline_printer()->record(method(), jvms, InliningResult::SUCCESS, "late inline succeeded (method handle)");
681 } else if (is_string_late_inline()) {
682 C->inline_printer()->record(method(), jvms, InliningResult::SUCCESS, "late inline succeeded (string method)");
683 } else if (is_boxing_late_inline()) {
684 C->inline_printer()->record(method(), jvms, InliningResult::SUCCESS, "late inline succeeded (boxing method)");
685 } else if (is_vector_reboxing_late_inline()) {
686 C->inline_printer()->record(method(), jvms, InliningResult::SUCCESS, "late inline succeeded (vector reboxing method)");
687 } else {
688 C->inline_printer()->record(method(), jvms, InliningResult::SUCCESS, "late inline succeeded");
689 }
690
691 // Capture any exceptional control flow
692 GraphKit kit(new_jvms);
693
694 // Find the result object
695 Node* result = C->top();
696 int result_size = method()->return_type()->size();
697 if (result_size != 0 && !kit.stopped()) {
698 result = (result_size == 1) ? kit.pop() : kit.pop_pair();
699 }
700
701 if (call->is_CallStaticJava() && call->as_CallStaticJava()->is_boxing_method()) {
702 result = kit.must_be_not_null(result, false);
703 }
704
705 if (inline_cg()->is_inline()) {
706 C->set_has_loops(C->has_loops() || inline_cg()->method()->has_loops());
707 C->env()->notice_inlined_method(inline_cg()->method());
708 }
709 C->set_inlining_progress(true);
710 C->set_do_cleanup(kit.stopped()); // path is dead; needs cleanup
711 kit.replace_call(call, result, true, do_asserts);
712 }
713 }
714
715 class LateInlineStringCallGenerator : public LateInlineCallGenerator {
716
717 public:
718 LateInlineStringCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
719 LateInlineCallGenerator(method, inline_cg) {}
720
721 virtual JVMState* generate(JVMState* jvms) {
722 Compile *C = Compile::current();
723
724 C->log_inline_id(this);
725
726 C->add_string_late_inline(this);
727
728 JVMState* new_jvms = DirectCallGenerator::generate(jvms);
729 return new_jvms;
730 }
731
732 virtual bool is_string_late_inline() const { return true; }
733
734 virtual CallGenerator* with_call_node(CallNode* call) {
735 LateInlineStringCallGenerator* cg = new LateInlineStringCallGenerator(method(), _inline_cg);
736 cg->set_call_node(call->as_CallStaticJava());
737 return cg;
738 }
739 };
740
741 CallGenerator* CallGenerator::for_string_late_inline(ciMethod* method, CallGenerator* inline_cg) {
742 return new LateInlineStringCallGenerator(method, inline_cg);
743 }
744
745 class LateInlineBoxingCallGenerator : public LateInlineCallGenerator {
746
747 public:
748 LateInlineBoxingCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
749 LateInlineCallGenerator(method, inline_cg, /*is_pure=*/true) {}
750
751 virtual JVMState* generate(JVMState* jvms) {
752 Compile *C = Compile::current();
753
754 C->log_inline_id(this);
755
756 C->add_boxing_late_inline(this);
757
758 JVMState* new_jvms = DirectCallGenerator::generate(jvms);
759 return new_jvms;
760 }
761
762 virtual bool is_boxing_late_inline() const { return true; }
763
764 virtual CallGenerator* with_call_node(CallNode* call) {
765 LateInlineBoxingCallGenerator* cg = new LateInlineBoxingCallGenerator(method(), _inline_cg);
766 cg->set_call_node(call->as_CallStaticJava());
767 return cg;
768 }
769 };
770
771 CallGenerator* CallGenerator::for_boxing_late_inline(ciMethod* method, CallGenerator* inline_cg) {
772 return new LateInlineBoxingCallGenerator(method, inline_cg);
773 }
774
775 class LateInlineVectorReboxingCallGenerator : public LateInlineCallGenerator {
776
777 public:
778 LateInlineVectorReboxingCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
779 LateInlineCallGenerator(method, inline_cg, /*is_pure=*/true) {}
780
781 virtual JVMState* generate(JVMState* jvms) {
782 Compile *C = Compile::current();
783
784 C->log_inline_id(this);
785
786 C->add_vector_reboxing_late_inline(this);
787
788 JVMState* new_jvms = DirectCallGenerator::generate(jvms);
789 return new_jvms;
790 }
791
792 virtual bool is_vector_reboxing_late_inline() const { return true; }
793
794 virtual CallGenerator* with_call_node(CallNode* call) {
795 LateInlineVectorReboxingCallGenerator* cg = new LateInlineVectorReboxingCallGenerator(method(), _inline_cg);
796 cg->set_call_node(call->as_CallStaticJava());
797 return cg;
798 }
799 };
800
801 // static CallGenerator* for_vector_reboxing_late_inline(ciMethod* m, CallGenerator* inline_cg);
802 CallGenerator* CallGenerator::for_vector_reboxing_late_inline(ciMethod* method, CallGenerator* inline_cg) {
803 return new LateInlineVectorReboxingCallGenerator(method, inline_cg);
804 }
805
806 //------------------------PredictedCallGenerator------------------------------
807 // Internal class which handles all out-of-line calls checking receiver type.
808 class PredictedCallGenerator : public CallGenerator {
809 ciKlass* _predicted_receiver;
810 CallGenerator* _if_missed;
811 CallGenerator* _if_hit;
812 float _hit_prob;
813 bool _exact_check;
814
815 public:
816 PredictedCallGenerator(ciKlass* predicted_receiver,
817 CallGenerator* if_missed,
818 CallGenerator* if_hit, bool exact_check,
819 float hit_prob)
820 : CallGenerator(if_missed->method())
821 {
822 // The call profile data may predict the hit_prob as extreme as 0 or 1.
823 // Remove the extremes values from the range.
824 if (hit_prob > PROB_MAX) hit_prob = PROB_MAX;
825 if (hit_prob < PROB_MIN) hit_prob = PROB_MIN;
826
827 _predicted_receiver = predicted_receiver;
828 _if_missed = if_missed;
829 _if_hit = if_hit;
830 _hit_prob = hit_prob;
831 _exact_check = exact_check;
832 }
833
834 virtual bool is_virtual() const { return true; }
835 virtual bool is_inline() const { return _if_hit->is_inline(); }
836 virtual bool is_deferred() const { return _if_hit->is_deferred(); }
837
838 virtual JVMState* generate(JVMState* jvms);
839 };
840
841
842 CallGenerator* CallGenerator::for_predicted_call(ciKlass* predicted_receiver,
843 CallGenerator* if_missed,
844 CallGenerator* if_hit,
845 float hit_prob) {
846 return new PredictedCallGenerator(predicted_receiver, if_missed, if_hit,
847 /*exact_check=*/true, hit_prob);
848 }
849
850 CallGenerator* CallGenerator::for_guarded_call(ciKlass* guarded_receiver,
851 CallGenerator* if_missed,
852 CallGenerator* if_hit) {
853 return new PredictedCallGenerator(guarded_receiver, if_missed, if_hit,
854 /*exact_check=*/false, PROB_ALWAYS);
855 }
856
857 JVMState* PredictedCallGenerator::generate(JVMState* jvms) {
858 GraphKit kit(jvms);
859 PhaseGVN& gvn = kit.gvn();
860 // We need an explicit receiver null_check before checking its type.
861 // We share a map with the caller, so his JVMS gets adjusted.
862 Node* receiver = kit.argument(0);
863 CompileLog* log = kit.C->log();
864 if (log != nullptr) {
865 log->elem("predicted_call bci='%d' exact='%d' klass='%d'",
866 jvms->bci(), (_exact_check ? 1 : 0), log->identify(_predicted_receiver));
867 }
868
869 receiver = kit.null_check_receiver_before_call(method());
870 if (kit.stopped()) {
871 return kit.transfer_exceptions_into_jvms();
872 }
873
874 // Make a copy of the replaced nodes in case we need to restore them
875 ReplacedNodes replaced_nodes = kit.map()->replaced_nodes();
876 replaced_nodes.clone();
877
878 Node* casted_receiver = receiver; // will get updated in place...
879 Node* slow_ctl = nullptr;
880 if (_exact_check) {
881 slow_ctl = kit.type_check_receiver(receiver, _predicted_receiver, _hit_prob,
882 &casted_receiver);
883 } else {
884 slow_ctl = kit.subtype_check_receiver(receiver, _predicted_receiver,
885 &casted_receiver);
886 }
887
888 SafePointNode* slow_map = nullptr;
889 JVMState* slow_jvms = nullptr;
890 { PreserveJVMState pjvms(&kit);
891 kit.set_control(slow_ctl);
892 if (!kit.stopped()) {
893 slow_jvms = _if_missed->generate(kit.sync_jvms());
894 if (kit.failing())
895 return nullptr; // might happen because of NodeCountInliningCutoff
896 assert(slow_jvms != nullptr, "must be");
897 kit.add_exception_states_from(slow_jvms);
898 kit.set_map(slow_jvms->map());
899 if (!kit.stopped())
900 slow_map = kit.stop();
901 }
902 }
903
904 if (kit.stopped()) {
905 // Instance does not match the predicted type.
906 kit.set_jvms(slow_jvms);
907 return kit.transfer_exceptions_into_jvms();
908 }
909
910 // Fall through if the instance matches the desired type.
911 kit.replace_in_map(receiver, casted_receiver);
912
913 // Make the hot call:
914 JVMState* new_jvms = _if_hit->generate(kit.sync_jvms());
915 if (kit.failing()) {
916 return nullptr;
917 }
918 if (new_jvms == nullptr) {
919 // Inline failed, so make a direct call.
920 assert(_if_hit->is_inline(), "must have been a failed inline");
921 CallGenerator* cg = CallGenerator::for_direct_call(_if_hit->method());
922 new_jvms = cg->generate(kit.sync_jvms());
923 }
924 kit.add_exception_states_from(new_jvms);
925 kit.set_jvms(new_jvms);
926
927 // Need to merge slow and fast?
928 if (slow_map == nullptr) {
929 // The fast path is the only path remaining.
930 return kit.transfer_exceptions_into_jvms();
931 }
932
933 if (kit.stopped()) {
934 // Inlined method threw an exception, so it's just the slow path after all.
935 kit.set_jvms(slow_jvms);
936 return kit.transfer_exceptions_into_jvms();
937 }
938
939 // There are 2 branches and the replaced nodes are only valid on
940 // one: restore the replaced nodes to what they were before the
941 // branch.
942 kit.map()->set_replaced_nodes(replaced_nodes);
943
944 // Finish the diamond.
945 kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
946 RegionNode* region = new RegionNode(3);
947 region->init_req(1, kit.control());
948 region->init_req(2, slow_map->control());
949 kit.set_control(gvn.transform(region));
950 Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
951 iophi->set_req(2, slow_map->i_o());
952 kit.set_i_o(gvn.transform(iophi));
953 // Merge memory
954 kit.merge_memory(slow_map->merged_memory(), region, 2);
955 // Transform new memory Phis.
956 for (MergeMemStream mms(kit.merged_memory()); mms.next_non_empty();) {
957 Node* phi = mms.memory();
958 if (phi->is_Phi() && phi->in(0) == region) {
959 mms.set_memory(gvn.transform(phi));
960 }
961 }
962 uint tos = kit.jvms()->stkoff() + kit.sp();
963 uint limit = slow_map->req();
964 for (uint i = TypeFunc::Parms; i < limit; i++) {
965 // Skip unused stack slots; fast forward to monoff();
966 if (i == tos) {
967 i = kit.jvms()->monoff();
968 if( i >= limit ) break;
969 }
970 Node* m = kit.map()->in(i);
971 Node* n = slow_map->in(i);
972 if (m != n) {
973 const Type* t = gvn.type(m)->meet_speculative(gvn.type(n));
974 Node* phi = PhiNode::make(region, m, t);
975 phi->set_req(2, n);
976 kit.map()->set_req(i, gvn.transform(phi));
977 }
978 }
979 return kit.transfer_exceptions_into_jvms();
980 }
981
982
983 CallGenerator* CallGenerator::for_method_handle_call(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool allow_inline) {
984 assert(callee->is_method_handle_intrinsic(), "for_method_handle_call mismatch");
985 bool input_not_const;
986 CallGenerator* cg = CallGenerator::for_method_handle_inline(jvms, caller, callee, allow_inline, input_not_const);
987 Compile* C = Compile::current();
988 bool should_delay = C->should_delay_inlining();
989 if (cg != nullptr) {
990 if (should_delay) {
991 return CallGenerator::for_late_inline(callee, cg);
992 } else {
993 return cg;
994 }
995 }
996 int bci = jvms->bci();
997 ciCallProfile profile = caller->call_profile_at_bci(bci);
998 int call_site_count = caller->scale_count(profile.count());
999
1000 if (IncrementalInlineMH && call_site_count > 0 &&
1001 (should_delay || input_not_const || !C->inlining_incrementally() || C->over_inlining_cutoff())) {
1002 return CallGenerator::for_mh_late_inline(caller, callee, input_not_const);
1003 } else {
1004 // Out-of-line call.
1005 return CallGenerator::for_direct_call(callee);
1006 }
1007 }
1008
1009 CallGenerator* CallGenerator::for_method_handle_inline(JVMState* jvms, ciMethod* caller, ciMethod* callee, bool allow_inline, bool& input_not_const) {
1010 GraphKit kit(jvms);
1011 PhaseGVN& gvn = kit.gvn();
1012 Compile* C = kit.C;
1013 vmIntrinsics::ID iid = callee->intrinsic_id();
1014 input_not_const = true;
1015 if (StressMethodHandleLinkerInlining) {
1016 allow_inline = false;
1017 }
1018 switch (iid) {
1019 case vmIntrinsics::_invokeBasic:
1020 {
1021 // Get MethodHandle receiver:
1022 Node* receiver = kit.argument(0);
1023 if (receiver->Opcode() == Op_ConP) {
1024 input_not_const = false;
1025 const TypeOopPtr* recv_toop = receiver->bottom_type()->isa_oopptr();
1026 if (recv_toop != nullptr) {
1027 ciMethod* target = recv_toop->const_oop()->as_method_handle()->get_vmtarget();
1028 const int vtable_index = Method::invalid_vtable_index;
1029
1030 if (!ciMethod::is_consistent_info(callee, target)) {
1031 print_inlining_failure(C, callee, jvms, "signatures mismatch");
1032 return nullptr;
1033 }
1034
1035 CallGenerator *cg = C->call_generator(target, vtable_index,
1036 false /* call_does_dispatch */,
1037 jvms,
1038 allow_inline,
1039 PROB_ALWAYS);
1040 return cg;
1041 } else {
1042 assert(receiver->bottom_type() == TypePtr::NULL_PTR, "not a null: %s",
1043 Type::str(receiver->bottom_type()));
1044 print_inlining_failure(C, callee, jvms, "receiver is always null");
1045 }
1046 } else {
1047 print_inlining_failure(C, callee, jvms, "receiver not constant");
1048 }
1049 } break;
1050
1051 case vmIntrinsics::_linkToVirtual:
1052 case vmIntrinsics::_linkToStatic:
1053 case vmIntrinsics::_linkToSpecial:
1054 case vmIntrinsics::_linkToInterface:
1055 {
1056 // Get MemberName argument:
1057 Node* member_name = kit.argument(callee->arg_size() - 1);
1058 if (member_name->Opcode() == Op_ConP) {
1059 input_not_const = false;
1060 const TypeOopPtr* oop_ptr = member_name->bottom_type()->is_oopptr();
1061 ciMethod* target = oop_ptr->const_oop()->as_member_name()->get_vmtarget();
1062
1063 if (!ciMethod::is_consistent_info(callee, target)) {
1064 print_inlining_failure(C, callee, jvms, "signatures mismatch");
1065 return nullptr;
1066 }
1067
1068 // In lambda forms we erase signature types to avoid resolving issues
1069 // involving class loaders. When we optimize a method handle invoke
1070 // to a direct call we must cast the receiver and arguments to its
1071 // actual types.
1072 ciSignature* signature = target->signature();
1073 const int receiver_skip = target->is_static() ? 0 : 1;
1074 // Cast receiver to its type.
1075 if (!target->is_static()) {
1076 Node* recv = kit.argument(0);
1077 Node* casted_recv = kit.maybe_narrow_object_type(recv, signature->accessing_klass());
1078 if (casted_recv->is_top()) {
1079 print_inlining_failure(C, callee, jvms, "argument types mismatch");
1080 return nullptr; // FIXME: effectively dead; issue a halt node instead
1081 } else if (casted_recv != recv) {
1082 kit.set_argument(0, casted_recv);
1083 }
1084 }
1085 // Cast reference arguments to its type.
1086 for (int i = 0, j = 0; i < signature->count(); i++) {
1087 ciType* t = signature->type_at(i);
1088 if (t->is_klass()) {
1089 Node* arg = kit.argument(receiver_skip + j);
1090 Node* casted_arg = kit.maybe_narrow_object_type(arg, t->as_klass());
1091 if (casted_arg->is_top()) {
1092 print_inlining_failure(C, callee, jvms, "argument types mismatch");
1093 return nullptr; // FIXME: effectively dead; issue a halt node instead
1094 } else if (casted_arg != arg) {
1095 kit.set_argument(receiver_skip + j, casted_arg);
1096 }
1097 }
1098 j += t->size(); // long and double take two slots
1099 }
1100
1101 // Try to get the most accurate receiver type
1102 const bool is_virtual = (iid == vmIntrinsics::_linkToVirtual);
1103 const bool is_virtual_or_interface = (is_virtual || iid == vmIntrinsics::_linkToInterface);
1104 int vtable_index = Method::invalid_vtable_index;
1105 bool call_does_dispatch = false;
1106
1107 ciKlass* speculative_receiver_type = nullptr;
1108 if (is_virtual_or_interface) {
1109 ciInstanceKlass* klass = target->holder();
1110 Node* receiver_node = kit.argument(0);
1111 const TypeOopPtr* receiver_type = gvn.type(receiver_node)->isa_oopptr();
1112 // call_does_dispatch and vtable_index are out-parameters. They might be changed.
1113 // optimize_virtual_call() takes 2 different holder
1114 // arguments for a corner case that doesn't apply here (see
1115 // Parse::do_call())
1116 target = C->optimize_virtual_call(caller, klass, klass,
1117 target, receiver_type, is_virtual,
1118 call_does_dispatch, vtable_index, // out-parameters
1119 false /* check_access */);
1120 // We lack profiling at this call but type speculation may
1121 // provide us with a type
1122 speculative_receiver_type = (receiver_type != nullptr) ? receiver_type->speculative_type() : nullptr;
1123 }
1124 CallGenerator* cg = C->call_generator(target, vtable_index, call_does_dispatch, jvms,
1125 allow_inline,
1126 PROB_ALWAYS,
1127 speculative_receiver_type);
1128 return cg;
1129 } else {
1130 print_inlining_failure(C, callee, jvms, "member_name not constant");
1131 }
1132 } break;
1133
1134 case vmIntrinsics::_linkToNative:
1135 print_inlining_failure(C, callee, jvms, "native call");
1136 break;
1137
1138 default:
1139 fatal("unexpected intrinsic %d: %s", vmIntrinsics::as_int(iid), vmIntrinsics::name_at(iid));
1140 break;
1141 }
1142 return nullptr;
1143 }
1144
1145 //------------------------PredicatedIntrinsicGenerator------------------------------
1146 // Internal class which handles all predicated Intrinsic calls.
1147 class PredicatedIntrinsicGenerator : public CallGenerator {
1148 CallGenerator* _intrinsic;
1149 CallGenerator* _cg;
1150
1151 public:
1152 PredicatedIntrinsicGenerator(CallGenerator* intrinsic,
1153 CallGenerator* cg)
1154 : CallGenerator(cg->method())
1155 {
1156 _intrinsic = intrinsic;
1157 _cg = cg;
1158 }
1159
1160 virtual bool is_virtual() const { return true; }
1161 virtual bool is_inline() const { return true; }
1162 virtual bool is_intrinsic() const { return true; }
1163
1164 virtual JVMState* generate(JVMState* jvms);
1165 };
1166
1167
1168 CallGenerator* CallGenerator::for_predicated_intrinsic(CallGenerator* intrinsic,
1169 CallGenerator* cg) {
1170 return new PredicatedIntrinsicGenerator(intrinsic, cg);
1171 }
1172
1173
1174 JVMState* PredicatedIntrinsicGenerator::generate(JVMState* jvms) {
1175 // The code we want to generate here is:
1176 // if (receiver == nullptr)
1177 // uncommon_Trap
1178 // if (predicate(0))
1179 // do_intrinsic(0)
1180 // else
1181 // if (predicate(1))
1182 // do_intrinsic(1)
1183 // ...
1184 // else
1185 // do_java_comp
1186
1187 GraphKit kit(jvms);
1188 PhaseGVN& gvn = kit.gvn();
1189
1190 CompileLog* log = kit.C->log();
1191 if (log != nullptr) {
1192 log->elem("predicated_intrinsic bci='%d' method='%d'",
1193 jvms->bci(), log->identify(method()));
1194 }
1195
1196 if (!method()->is_static()) {
1197 // We need an explicit receiver null_check before checking its type in predicate.
1198 // We share a map with the caller, so his JVMS gets adjusted.
1199 Node* receiver = kit.null_check_receiver_before_call(method());
1200 if (kit.stopped()) {
1201 return kit.transfer_exceptions_into_jvms();
1202 }
1203 }
1204
1205 int n_predicates = _intrinsic->predicates_count();
1206 assert(n_predicates > 0, "sanity");
1207
1208 JVMState** result_jvms = NEW_RESOURCE_ARRAY(JVMState*, (n_predicates+1));
1209
1210 // Region for normal compilation code if intrinsic failed.
1211 Node* slow_region = new RegionNode(1);
1212
1213 int results = 0;
1214 for (int predicate = 0; (predicate < n_predicates) && !kit.stopped(); predicate++) {
1215 #ifdef ASSERT
1216 JVMState* old_jvms = kit.jvms();
1217 SafePointNode* old_map = kit.map();
1218 Node* old_io = old_map->i_o();
1219 Node* old_mem = old_map->memory();
1220 Node* old_exc = old_map->next_exception();
1221 #endif
1222 Node* else_ctrl = _intrinsic->generate_predicate(kit.sync_jvms(), predicate);
1223 #ifdef ASSERT
1224 // Assert(no_new_memory && no_new_io && no_new_exceptions) after generate_predicate.
1225 assert(old_jvms == kit.jvms(), "generate_predicate should not change jvm state");
1226 SafePointNode* new_map = kit.map();
1227 assert(old_io == new_map->i_o(), "generate_predicate should not change i_o");
1228 assert(old_mem == new_map->memory(), "generate_predicate should not change memory");
1229 assert(old_exc == new_map->next_exception(), "generate_predicate should not add exceptions");
1230 #endif
1231 if (!kit.stopped()) {
1232 PreserveJVMState pjvms(&kit);
1233 // Generate intrinsic code:
1234 JVMState* new_jvms = _intrinsic->generate(kit.sync_jvms());
1235 if (kit.failing()) {
1236 return nullptr;
1237 }
1238 if (new_jvms == nullptr) {
1239 // Intrinsic failed, use normal compilation path for this predicate.
1240 slow_region->add_req(kit.control());
1241 } else {
1242 kit.add_exception_states_from(new_jvms);
1243 kit.set_jvms(new_jvms);
1244 if (!kit.stopped()) {
1245 result_jvms[results++] = kit.jvms();
1246 }
1247 }
1248 }
1249 if (else_ctrl == nullptr) {
1250 else_ctrl = kit.C->top();
1251 }
1252 kit.set_control(else_ctrl);
1253 }
1254 if (!kit.stopped()) {
1255 // Final 'else' after predicates.
1256 slow_region->add_req(kit.control());
1257 }
1258 if (slow_region->req() > 1) {
1259 PreserveJVMState pjvms(&kit);
1260 // Generate normal compilation code:
1261 kit.set_control(gvn.transform(slow_region));
1262 JVMState* new_jvms = _cg->generate(kit.sync_jvms());
1263 if (kit.failing())
1264 return nullptr; // might happen because of NodeCountInliningCutoff
1265 assert(new_jvms != nullptr, "must be");
1266 kit.add_exception_states_from(new_jvms);
1267 kit.set_jvms(new_jvms);
1268 if (!kit.stopped()) {
1269 result_jvms[results++] = kit.jvms();
1270 }
1271 }
1272
1273 if (results == 0) {
1274 // All paths ended in uncommon traps.
1275 (void) kit.stop();
1276 return kit.transfer_exceptions_into_jvms();
1277 }
1278
1279 if (results == 1) { // Only one path
1280 kit.set_jvms(result_jvms[0]);
1281 return kit.transfer_exceptions_into_jvms();
1282 }
1283
1284 // Merge all paths.
1285 kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
1286 RegionNode* region = new RegionNode(results + 1);
1287 Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
1288 for (int i = 0; i < results; i++) {
1289 JVMState* jvms = result_jvms[i];
1290 int path = i + 1;
1291 SafePointNode* map = jvms->map();
1292 region->init_req(path, map->control());
1293 iophi->set_req(path, map->i_o());
1294 if (i == 0) {
1295 kit.set_jvms(jvms);
1296 } else {
1297 kit.merge_memory(map->merged_memory(), region, path);
1298 }
1299 }
1300 kit.set_control(gvn.transform(region));
1301 kit.set_i_o(gvn.transform(iophi));
1302 // Transform new memory Phis.
1303 for (MergeMemStream mms(kit.merged_memory()); mms.next_non_empty();) {
1304 Node* phi = mms.memory();
1305 if (phi->is_Phi() && phi->in(0) == region) {
1306 mms.set_memory(gvn.transform(phi));
1307 }
1308 }
1309
1310 // Merge debug info.
1311 Node** ins = NEW_RESOURCE_ARRAY(Node*, results);
1312 uint tos = kit.jvms()->stkoff() + kit.sp();
1313 Node* map = kit.map();
1314 uint limit = map->req();
1315 for (uint i = TypeFunc::Parms; i < limit; i++) {
1316 // Skip unused stack slots; fast forward to monoff();
1317 if (i == tos) {
1318 i = kit.jvms()->monoff();
1319 if( i >= limit ) break;
1320 }
1321 Node* n = map->in(i);
1322 ins[0] = n;
1323 const Type* t = gvn.type(n);
1324 bool needs_phi = false;
1325 for (int j = 1; j < results; j++) {
1326 JVMState* jvms = result_jvms[j];
1327 Node* jmap = jvms->map();
1328 Node* m = nullptr;
1329 if (jmap->req() > i) {
1330 m = jmap->in(i);
1331 if (m != n) {
1332 needs_phi = true;
1333 t = t->meet_speculative(gvn.type(m));
1334 }
1335 }
1336 ins[j] = m;
1337 }
1338 if (needs_phi) {
1339 Node* phi = PhiNode::make(region, n, t);
1340 for (int j = 1; j < results; j++) {
1341 phi->set_req(j + 1, ins[j]);
1342 }
1343 map->set_req(i, gvn.transform(phi));
1344 }
1345 }
1346
1347 return kit.transfer_exceptions_into_jvms();
1348 }
1349
1350 //-------------------------UncommonTrapCallGenerator-----------------------------
1351 // Internal class which handles all out-of-line calls checking receiver type.
1352 class UncommonTrapCallGenerator : public CallGenerator {
1353 Deoptimization::DeoptReason _reason;
1354 Deoptimization::DeoptAction _action;
1355
1356 public:
1357 UncommonTrapCallGenerator(ciMethod* m,
1358 Deoptimization::DeoptReason reason,
1359 Deoptimization::DeoptAction action)
1360 : CallGenerator(m)
1361 {
1362 _reason = reason;
1363 _action = action;
1364 }
1365
1366 virtual bool is_virtual() const { ShouldNotReachHere(); return false; }
1367 virtual bool is_trap() const { return true; }
1368
1369 virtual JVMState* generate(JVMState* jvms);
1370 };
1371
1372
1373 CallGenerator*
1374 CallGenerator::for_uncommon_trap(ciMethod* m,
1375 Deoptimization::DeoptReason reason,
1376 Deoptimization::DeoptAction action) {
1377 return new UncommonTrapCallGenerator(m, reason, action);
1378 }
1379
1380
1381 JVMState* UncommonTrapCallGenerator::generate(JVMState* jvms) {
1382 GraphKit kit(jvms);
1383 // Take the trap with arguments pushed on the stack. (Cf. null_check_receiver).
1384 // Callsite signature can be different from actual method being called (i.e _linkTo* sites).
1385 // Use callsite signature always.
1386 ciMethod* declared_method = kit.method()->get_method_at_bci(kit.bci());
1387 int nargs = declared_method->arg_size();
1388 kit.inc_sp(nargs);
1389 assert(nargs <= kit.sp() && kit.sp() <= jvms->stk_size(), "sane sp w/ args pushed");
1390 if (_reason == Deoptimization::Reason_class_check &&
1391 _action == Deoptimization::Action_maybe_recompile) {
1392 // Temp fix for 6529811
1393 // Don't allow uncommon_trap to override our decision to recompile in the event
1394 // of a class cast failure for a monomorphic call as it will never let us convert
1395 // the call to either bi-morphic or megamorphic and can lead to unc-trap loops
1396 bool keep_exact_action = true;
1397 kit.uncommon_trap(_reason, _action, nullptr, "monomorphic vcall checkcast", false, keep_exact_action);
1398 } else {
1399 kit.uncommon_trap(_reason, _action);
1400 }
1401 return kit.transfer_exceptions_into_jvms();
1402 }
1403
1404 // (Note: Moved hook_up_call to GraphKit::set_edges_for_java_call.)
1405
1406 // (Node: Merged hook_up_exits into ParseGenerator::generate.)