1 /*
2 * Copyright (c) 1998, 2012, 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 "precompiled.hpp"
26 #include "ci/ciCallSite.hpp"
27 #include "ci/ciMethodHandle.hpp"
28 #include "classfile/vmSymbols.hpp"
29 #include "compiler/compileBroker.hpp"
30 #include "compiler/compileLog.hpp"
31 #include "interpreter/linkResolver.hpp"
32 #include "opto/addnode.hpp"
33 #include "opto/callGenerator.hpp"
34 #include "opto/cfgnode.hpp"
35 #include "opto/mulnode.hpp"
36 #include "opto/parse.hpp"
37 #include "opto/rootnode.hpp"
38 #include "opto/runtime.hpp"
39 #include "opto/subnode.hpp"
40 #include "prims/nativeLookup.hpp"
41 #include "runtime/sharedRuntime.hpp"
42
43 void trace_type_profile(Compile* C, ciMethod *method, int depth, int bci, ciMethod *prof_method, ciKlass *prof_klass, int site_count, int receiver_count) {
44 if (TraceTypeProfile || C->print_inlining()) {
45 outputStream* out = tty;
46 if (!C->print_inlining()) {
47 if (NOT_PRODUCT(!PrintOpto &&) !PrintCompilation) {
48 method->print_short_name();
49 tty->cr();
50 }
51 CompileTask::print_inlining(prof_method, depth, bci);
52 } else {
53 out = C->print_inlining_stream();
54 }
55 CompileTask::print_inline_indent(depth, out);
56 out->print(" \\-> TypeProfile (%d/%d counts) = ", receiver_count, site_count);
57 stringStream ss;
58 prof_klass->name()->print_symbol_on(&ss);
59 out->print(ss.as_string());
60 out->cr();
61 }
62 }
63
64 CallGenerator* Compile::call_generator(ciMethod* callee, int vtable_index, bool call_does_dispatch,
65 JVMState* jvms, bool allow_inline,
66 float prof_factor, ciKlass* spec_rcvr_type,
67 bool allow_intrinsics, bool delayed_forbidden) {
68 ciMethod* caller = jvms->method();
69 int bci = jvms->bci();
70 Bytecodes::Code bytecode = caller->java_code_at_bci(bci);
71 guarantee(callee != NULL, "failed method resolution");
72
73 // Dtrace currently doesn't work unless all calls are vanilla
74 if (env()->dtrace_method_probes()) {
75 allow_inline = false;
76 }
77
78 // Note: When we get profiling during stage-1 compiles, we want to pull
79 // from more specific profile data which pertains to this inlining.
80 // Right now, ignore the information in jvms->caller(), and do method[bci].
81 ciCallProfile profile = caller->call_profile_at_bci(bci);
82
83 // See how many times this site has been invoked.
84 int site_count = profile.count();
85 int receiver_count = -1;
86 if (call_does_dispatch && UseTypeProfile && profile.has_receiver(0)) {
87 // Receivers in the profile structure are ordered by call counts
88 // so that the most called (major) receiver is profile.receiver(0).
89 receiver_count = profile.receiver_count(0);
90 }
91
92 CompileLog* log = this->log();
93 if (log != NULL) {
94 int rid = (receiver_count >= 0)? log->identify(profile.receiver(0)): -1;
95 int r2id = (rid != -1 && profile.has_receiver(1))? log->identify(profile.receiver(1)):-1;
96 log->begin_elem("call method='%d' count='%d' prof_factor='%g'",
97 log->identify(callee), site_count, prof_factor);
98 if (call_does_dispatch) log->print(" virtual='1'");
99 if (allow_inline) log->print(" inline='1'");
100 if (receiver_count >= 0) {
101 log->print(" receiver='%d' receiver_count='%d'", rid, receiver_count);
102 if (profile.has_receiver(1)) {
103 log->print(" receiver2='%d' receiver2_count='%d'", r2id, profile.receiver_count(1));
104 }
105 }
106 log->end_elem();
107 }
108
109 // Special case the handling of certain common, profitable library
110 // methods. If these methods are replaced with specialized code,
111 // then we return it as the inlined version of the call.
112 // We do this before the strict f.p. check below because the
113 // intrinsics handle strict f.p. correctly.
114 CallGenerator* cg_intrinsic = NULL;
115 if (allow_inline && allow_intrinsics) {
116 CallGenerator* cg = find_intrinsic(callee, call_does_dispatch);
117 if (cg != NULL) {
118 if (cg->is_predicted()) {
119 // Code without intrinsic but, hopefully, inlined.
120 CallGenerator* inline_cg = this->call_generator(callee,
121 vtable_index, call_does_dispatch, jvms, allow_inline, prof_factor, spec_rcvr_type, false);
122 if (inline_cg != NULL) {
123 cg = CallGenerator::for_predicted_intrinsic(cg, inline_cg);
124 }
125 }
126
127 // If intrinsic does the virtual dispatch, we try to use the type profile
128 // first, and hopefully inline it as the regular virtual call below.
129 // We will retry the intrinsic if nothing had claimed it afterwards.
130 if (cg->does_virtual_dispatch()) {
131 cg_intrinsic = cg;
132 cg = NULL;
133 } else {
134 return cg;
135 }
136 }
137 }
138
139 // Do method handle calls.
140 // NOTE: This must happen before normal inlining logic below since
141 // MethodHandle.invoke* are native methods which obviously don't
142 // have bytecodes and so normal inlining fails.
143 if (callee->is_method_handle_intrinsic()) {
144 CallGenerator* cg = CallGenerator::for_method_handle_call(jvms, caller, callee, delayed_forbidden);
145 assert(cg == NULL || !delayed_forbidden || !cg->is_late_inline() || cg->is_mh_late_inline(), "unexpected CallGenerator");
146 return cg;
147 }
148
149 // Do not inline strict fp into non-strict code, or the reverse
150 if (caller->is_strict() ^ callee->is_strict()) {
151 allow_inline = false;
152 }
153
154 // Attempt to inline...
155 if (allow_inline) {
156 // The profile data is only partly attributable to this caller,
157 // scale back the call site information.
158 float past_uses = jvms->method()->scale_count(site_count, prof_factor);
159 // This is the number of times we expect the call code to be used.
160 float expected_uses = past_uses;
161
162 // Try inlining a bytecoded method:
163 if (!call_does_dispatch) {
164 InlineTree* ilt;
165 if (UseOldInlining) {
166 ilt = InlineTree::find_subtree_from_root(this->ilt(), jvms->caller(), jvms->method());
167 } else {
168 // Make a disembodied, stateless ILT.
169 // TO DO: When UseOldInlining is removed, copy the ILT code elsewhere.
170 float site_invoke_ratio = prof_factor;
171 // Note: ilt is for the root of this parse, not the present call site.
172 ilt = new InlineTree(this, jvms->method(), jvms->caller(), site_invoke_ratio, MaxInlineLevel);
173 }
174 WarmCallInfo scratch_ci;
175 if (!UseOldInlining)
176 scratch_ci.init(jvms, callee, profile, prof_factor);
177 bool should_delay = false;
178 WarmCallInfo* ci = ilt->ok_to_inline(callee, jvms, profile, &scratch_ci, should_delay);
179 assert(ci != &scratch_ci, "do not let this pointer escape");
180 bool allow_inline = (ci != NULL && !ci->is_cold());
181 bool require_inline = (allow_inline && ci->is_hot());
182
183 if (allow_inline) {
184 CallGenerator* cg = CallGenerator::for_inline(callee, expected_uses);
185
186 if (require_inline && cg != NULL) {
187 // Delay the inlining of this method to give us the
188 // opportunity to perform some high level optimizations
189 // first.
190 if (should_delay_string_inlining(callee, jvms)) {
191 assert(!delayed_forbidden, "strange");
192 return CallGenerator::for_string_late_inline(callee, cg);
193 } else if (should_delay_boxing_inlining(callee, jvms)) {
194 assert(!delayed_forbidden, "strange");
195 return CallGenerator::for_boxing_late_inline(callee, cg);
196 } else if ((should_delay || AlwaysIncrementalInline) && !delayed_forbidden) {
197 return CallGenerator::for_late_inline(callee, cg);
198 }
199 }
200 if (cg == NULL || should_delay) {
201 // Fall through.
202 } else if (require_inline || !InlineWarmCalls) {
203 return cg;
204 } else {
205 CallGenerator* cold_cg = call_generator(callee, vtable_index, call_does_dispatch, jvms, false, prof_factor);
206 return CallGenerator::for_warm_call(ci, cold_cg, cg);
207 }
208 }
209 }
210
211 // Try using the type profile.
212 if (call_does_dispatch && site_count > 0 && receiver_count > 0) {
213 // The major receiver's count >= TypeProfileMajorReceiverPercent of site_count.
214 bool have_major_receiver = (100.*profile.receiver_prob(0) >= (float)TypeProfileMajorReceiverPercent);
215 ciMethod* receiver_method = NULL;
216
217 if (spec_rcvr_type != NULL) {
218 // We have a speculative type, we should be able to resolve
219 // the call. We do that before looking at the profiling at
220 // this invoke because it may lead to bimorphic inlining which
221 // a speculative type should help us avoid.
222 receiver_method = callee->resolve_invoke(jvms->method()->holder(),
223 spec_rcvr_type);
224 if (receiver_method == NULL) {
225 spec_rcvr_type = NULL;
226 }
227 }
228 if (receiver_method == NULL &&
229 (have_major_receiver || profile.morphism() == 1 ||
230 (profile.morphism() == 2 && UseBimorphicInlining))) {
231 // receiver_method = profile.method();
232 // Profiles do not suggest methods now. Look it up in the major receiver.
233 receiver_method = callee->resolve_invoke(jvms->method()->holder(),
234 profile.receiver(0));
235 }
236 if (receiver_method != NULL) {
237 // The single majority receiver sufficiently outweighs the minority.
238 CallGenerator* hit_cg = this->call_generator(receiver_method,
239 vtable_index, !call_does_dispatch, jvms, allow_inline, prof_factor);
240 if (hit_cg != NULL) {
241 // Look up second receiver.
242 CallGenerator* next_hit_cg = NULL;
243 ciMethod* next_receiver_method = NULL;
244 if (spec_rcvr_type == NULL && profile.morphism() == 2 && UseBimorphicInlining) {
245 next_receiver_method = callee->resolve_invoke(jvms->method()->holder(),
246 profile.receiver(1));
247 if (next_receiver_method != NULL) {
248 next_hit_cg = this->call_generator(next_receiver_method,
249 vtable_index, !call_does_dispatch, jvms,
250 allow_inline, prof_factor);
251 if (next_hit_cg != NULL && !next_hit_cg->is_inline() &&
252 have_major_receiver && UseOnlyInlinedBimorphic) {
253 // Skip if we can't inline second receiver's method
254 next_hit_cg = NULL;
255 }
256 }
257 }
258 CallGenerator* miss_cg;
259 Deoptimization::DeoptReason reason = (spec_rcvr_type == NULL && profile.morphism() == 2) ?
260 Deoptimization::Reason_bimorphic :
261 Deoptimization::Reason_class_check;
262 if ((spec_rcvr_type != NULL || profile.morphism() == 1 ||
263 (profile.morphism() == 2 && next_hit_cg != NULL)) &&
264 !too_many_traps(jvms->method(), jvms->bci(), reason)
265 ) {
266 // Generate uncommon trap for class check failure path
267 // in case of monomorphic or bimorphic virtual call site.
268 miss_cg = CallGenerator::for_uncommon_trap(callee, reason,
269 Deoptimization::Action_maybe_recompile);
270 } else {
271 // Generate virtual call for class check failure path
272 // in case of polymorphic virtual call site.
273 miss_cg = CallGenerator::for_virtual_call(callee, vtable_index);
274 }
275 if (miss_cg != NULL) {
276 if (next_hit_cg != NULL) {
277 assert(spec_rcvr_type == NULL, "shouldn't end up here if we used speculation");
278 trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), next_receiver_method, profile.receiver(1), site_count, profile.receiver_count(1));
279 // We don't need to record dependency on a receiver here and below.
280 // Whenever we inline, the dependency is added by Parse::Parse().
281 miss_cg = CallGenerator::for_predicted_call(profile.receiver(1), miss_cg, next_hit_cg, PROB_MAX);
282 }
283 if (miss_cg != NULL) {
284 trace_type_profile(C, jvms->method(), jvms->depth() - 1, jvms->bci(), receiver_method, profile.receiver(0), site_count, receiver_count);
285 ciKlass *k = spec_rcvr_type != NULL ? spec_rcvr_type : profile.receiver(0);
286 float hit_prob = spec_rcvr_type != NULL ? 1.0 : profile.receiver_prob(0);
287 CallGenerator* cg = CallGenerator::for_predicted_call(k, miss_cg, hit_cg, hit_prob);
288 if (cg != NULL) return cg;
289 }
290 }
291 }
292 }
293 }
294 }
295
296 // Nothing claimed the intrinsic, we go with straight-forward inlining
297 // for already discovered intrinsic.
298 if (allow_inline && allow_intrinsics && cg_intrinsic != NULL) {
299 assert(cg_intrinsic->does_virtual_dispatch(), "sanity");
300 return cg_intrinsic;
301 }
302
303 // There was no special inlining tactic, or it bailed out.
304 // Use a more generic tactic, like a simple call.
305 if (call_does_dispatch) {
306 return CallGenerator::for_virtual_call(callee, vtable_index);
307 } else {
308 // Class Hierarchy Analysis or Type Profile reveals a unique target,
309 // or it is a static or special call.
310 return CallGenerator::for_direct_call(callee, should_delay_inlining(callee, jvms));
311 }
312 }
313
314 // Return true for methods that shouldn't be inlined early so that
315 // they are easier to analyze and optimize as intrinsics.
316 bool Compile::should_delay_string_inlining(ciMethod* call_method, JVMState* jvms) {
317 if (has_stringbuilder()) {
318
319 if ((call_method->holder() == C->env()->StringBuilder_klass() ||
320 call_method->holder() == C->env()->StringBuffer_klass()) &&
321 (jvms->method()->holder() == C->env()->StringBuilder_klass() ||
322 jvms->method()->holder() == C->env()->StringBuffer_klass())) {
323 // Delay SB calls only when called from non-SB code
324 return false;
325 }
326
327 switch (call_method->intrinsic_id()) {
328 case vmIntrinsics::_StringBuilder_void:
329 case vmIntrinsics::_StringBuilder_int:
330 case vmIntrinsics::_StringBuilder_String:
331 case vmIntrinsics::_StringBuilder_append_char:
332 case vmIntrinsics::_StringBuilder_append_int:
333 case vmIntrinsics::_StringBuilder_append_String:
334 case vmIntrinsics::_StringBuilder_toString:
335 case vmIntrinsics::_StringBuffer_void:
336 case vmIntrinsics::_StringBuffer_int:
337 case vmIntrinsics::_StringBuffer_String:
338 case vmIntrinsics::_StringBuffer_append_char:
339 case vmIntrinsics::_StringBuffer_append_int:
340 case vmIntrinsics::_StringBuffer_append_String:
341 case vmIntrinsics::_StringBuffer_toString:
342 case vmIntrinsics::_Integer_toString:
343 return true;
344
345 case vmIntrinsics::_String_String:
346 {
347 Node* receiver = jvms->map()->in(jvms->argoff() + 1);
348 if (receiver->is_Proj() && receiver->in(0)->is_CallStaticJava()) {
349 CallStaticJavaNode* csj = receiver->in(0)->as_CallStaticJava();
350 ciMethod* m = csj->method();
351 if (m != NULL &&
352 (m->intrinsic_id() == vmIntrinsics::_StringBuffer_toString ||
353 m->intrinsic_id() == vmIntrinsics::_StringBuilder_toString))
354 // Delay String.<init>(new SB())
355 return true;
356 }
357 return false;
358 }
359
360 default:
361 return false;
362 }
363 }
364 return false;
365 }
366
367 bool Compile::should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms) {
368 if (eliminate_boxing() && call_method->is_boxing_method()) {
369 set_has_boxed_value(true);
370 return true;
371 }
372 return false;
373 }
374
375 // uncommon-trap call-sites where callee is unloaded, uninitialized or will not link
376 bool Parse::can_not_compile_call_site(ciMethod *dest_method, ciInstanceKlass* klass) {
377 // Additional inputs to consider...
378 // bc = bc()
379 // caller = method()
380 // iter().get_method_holder_index()
381 assert( dest_method->is_loaded(), "ciTypeFlow should not let us get here" );
382 // Interface classes can be loaded & linked and never get around to
383 // being initialized. Uncommon-trap for not-initialized static or
384 // v-calls. Let interface calls happen.
385 ciInstanceKlass* holder_klass = dest_method->holder();
386 if (!holder_klass->is_being_initialized() &&
387 !holder_klass->is_initialized() &&
388 !holder_klass->is_interface()) {
389 uncommon_trap(Deoptimization::Reason_uninitialized,
390 Deoptimization::Action_reinterpret,
391 holder_klass);
392 return true;
393 }
394
395 assert(dest_method->is_loaded(), "dest_method: typeflow responsibility");
396 return false;
397 }
398
399
400 //------------------------------do_call----------------------------------------
401 // Handle your basic call. Inline if we can & want to, else just setup call.
402 void Parse::do_call() {
403 // It's likely we are going to add debug info soon.
404 // Also, if we inline a guy who eventually needs debug info for this JVMS,
405 // our contribution to it is cleaned up right here.
406 kill_dead_locals();
407
408 // Set frequently used booleans
409 const bool is_virtual = bc() == Bytecodes::_invokevirtual;
410 const bool is_virtual_or_interface = is_virtual || bc() == Bytecodes::_invokeinterface;
411 const bool has_receiver = Bytecodes::has_receiver(bc());
412
413 // Find target being called
414 bool will_link;
415 ciSignature* declared_signature = NULL;
416 ciMethod* orig_callee = iter().get_method(will_link, &declared_signature); // callee in the bytecode
417 ciInstanceKlass* holder_klass = orig_callee->holder();
418 ciKlass* holder = iter().get_declared_method_holder();
419 ciInstanceKlass* klass = ciEnv::get_instance_klass_for_declared_method_holder(holder);
420 assert(declared_signature != NULL, "cannot be null");
421
422 // uncommon-trap when callee is unloaded, uninitialized or will not link
423 // bailout when too many arguments for register representation
424 if (!will_link || can_not_compile_call_site(orig_callee, klass)) {
425 #ifndef PRODUCT
426 if (PrintOpto && (Verbose || WizardMode)) {
427 method()->print_name(); tty->print_cr(" can not compile call at bci %d to:", bci());
428 orig_callee->print_name(); tty->cr();
429 }
430 #endif
431 return;
432 }
433 assert(holder_klass->is_loaded(), "");
434 //assert((bc_callee->is_static() || is_invokedynamic) == !has_receiver , "must match bc"); // XXX invokehandle (cur_bc_raw)
435 // Note: this takes into account invokeinterface of methods declared in java/lang/Object,
436 // which should be invokevirtuals but according to the VM spec may be invokeinterfaces
437 assert(holder_klass->is_interface() || holder_klass->super() == NULL || (bc() != Bytecodes::_invokeinterface), "must match bc");
438 // Note: In the absence of miranda methods, an abstract class K can perform
439 // an invokevirtual directly on an interface method I.m if K implements I.
440
441 // orig_callee is the resolved callee which's signature includes the
442 // appendix argument.
443 const int nargs = orig_callee->arg_size();
444 const bool is_signature_polymorphic = MethodHandles::is_signature_polymorphic(orig_callee->intrinsic_id());
445
446 // Push appendix argument (MethodType, CallSite, etc.), if one.
447 if (iter().has_appendix()) {
448 ciObject* appendix_arg = iter().get_appendix();
449 const TypeOopPtr* appendix_arg_type = TypeOopPtr::make_from_constant(appendix_arg);
450 Node* appendix_arg_node = _gvn.makecon(appendix_arg_type);
451 push(appendix_arg_node);
452 }
453
454 // ---------------------
455 // Does Class Hierarchy Analysis reveal only a single target of a v-call?
456 // Then we may inline or make a static call, but become dependent on there being only 1 target.
457 // Does the call-site type profile reveal only one receiver?
458 // Then we may introduce a run-time check and inline on the path where it succeeds.
459 // The other path may uncommon_trap, check for another receiver, or do a v-call.
460
461 // Try to get the most accurate receiver type
462 ciMethod* callee = orig_callee;
463 int vtable_index = Method::invalid_vtable_index;
464 bool call_does_dispatch = false;
465
466 // Speculative type of the receiver if any
467 ciKlass* spec_receiver_type = NULL;
468 if (is_virtual_or_interface) {
469 Node* receiver_node = stack(sp() - nargs);
470 const TypeOopPtr* receiver_type = _gvn.type(receiver_node)->isa_oopptr();
471 // call_does_dispatch and vtable_index are out-parameters. They might be changed.
472 callee = C->optimize_virtual_call(method(), bci(), klass, orig_callee, receiver_type,
473 is_virtual,
474 call_does_dispatch, vtable_index); // out-parameters
475 spec_receiver_type = receiver_type != NULL ? receiver_type->speculative_type() : NULL;
476 }
477
478 // Note: It's OK to try to inline a virtual call.
479 // The call generator will not attempt to inline a polymorphic call
480 // unless it knows how to optimize the receiver dispatch.
481 bool try_inline = (C->do_inlining() || InlineAccessors);
482
483 // ---------------------
484 dec_sp(nargs); // Temporarily pop args for JVM state of call
485 JVMState* jvms = sync_jvms();
486
487 // ---------------------
488 // Decide call tactic.
489 // This call checks with CHA, the interpreter profile, intrinsics table, etc.
490 // It decides whether inlining is desirable or not.
491 CallGenerator* cg = C->call_generator(callee, vtable_index, call_does_dispatch, jvms, try_inline, prof_factor(), spec_receiver_type);
492
493 // NOTE: Don't use orig_callee and callee after this point! Use cg->method() instead.
494 orig_callee = callee = NULL;
495
496 // ---------------------
497 // Round double arguments before call
498 round_double_arguments(cg->method());
499
500 // Feed profiling data for arguments to the type system so it can
501 // propagate it as speculative types
502 record_profiled_arguments_for_speculation(cg->method(), bc());
503
504 #ifndef PRODUCT
505 // bump global counters for calls
506 count_compiled_calls(/*at_method_entry*/ false, cg->is_inline());
507
508 // Record first part of parsing work for this call
509 parse_histogram()->record_change();
510 #endif // not PRODUCT
511
512 assert(jvms == this->jvms(), "still operating on the right JVMS");
513 assert(jvms_in_sync(), "jvms must carry full info into CG");
514
515 // save across call, for a subsequent cast_not_null.
516 Node* receiver = has_receiver ? argument(0) : NULL;
517
518 // The extra CheckCastPP for speculative types mess with PhaseStringOpts
519 if (receiver != NULL && !call_does_dispatch && !cg->is_string_late_inline()) {
520 // Feed profiling data for a single receiver to the type system so
521 // it can propagate it as a speculative type
522 receiver = record_profiled_receiver_for_speculation(receiver);
523 }
524
525 // Bump method data counters (We profile *before* the call is made
526 // because exceptions don't return to the call site.)
527 profile_call(receiver);
528
529 JVMState* new_jvms = cg->generate(jvms, this);
530 if (new_jvms == NULL) {
531 // When inlining attempt fails (e.g., too many arguments),
532 // it may contaminate the current compile state, making it
533 // impossible to pull back and try again. Once we call
534 // cg->generate(), we are committed. If it fails, the whole
535 // compilation task is compromised.
536 if (failing()) return;
537
538 // This can happen if a library intrinsic is available, but refuses
539 // the call site, perhaps because it did not match a pattern the
540 // intrinsic was expecting to optimize. Should always be possible to
541 // get a normal java call that may inline in that case
542 cg = C->call_generator(cg->method(), vtable_index, call_does_dispatch, jvms, try_inline, prof_factor(), spec_receiver_type, /* allow_intrinsics= */ false);
543 if ((new_jvms = cg->generate(jvms, this)) == NULL) {
544 guarantee(failing(), "call failed to generate: calls should work");
545 return;
546 }
547 }
548
549 if (cg->is_inline()) {
550 // Accumulate has_loops estimate
551 C->set_has_loops(C->has_loops() || cg->method()->has_loops());
552 C->env()->notice_inlined_method(cg->method());
553 }
554
555 // Reset parser state from [new_]jvms, which now carries results of the call.
556 // Return value (if any) is already pushed on the stack by the cg.
557 add_exception_states_from(new_jvms);
558 if (new_jvms->map()->control() == top()) {
559 stop_and_kill_map();
560 } else {
561 assert(new_jvms->same_calls_as(jvms), "method/bci left unchanged");
562 set_jvms(new_jvms);
563 }
564
565 if (!stopped()) {
566 // This was some sort of virtual call, which did a null check for us.
567 // Now we can assert receiver-not-null, on the normal return path.
568 if (receiver != NULL && cg->is_virtual()) {
569 Node* cast = cast_not_null(receiver);
570 // %%% assert(receiver == cast, "should already have cast the receiver");
571 }
572
573 // Round double result after a call from strict to non-strict code
574 round_double_result(cg->method());
575
576 ciType* rtype = cg->method()->return_type();
577 ciType* ctype = declared_signature->return_type();
578
579 if (Bytecodes::has_optional_appendix(iter().cur_bc_raw()) || is_signature_polymorphic) {
580 // Be careful here with return types.
581 if (ctype != rtype) {
582 BasicType rt = rtype->basic_type();
583 BasicType ct = ctype->basic_type();
584 if (ct == T_VOID) {
585 // It's OK for a method to return a value that is discarded.
586 // The discarding does not require any special action from the caller.
587 // The Java code knows this, at VerifyType.isNullConversion.
588 pop_node(rt); // whatever it was, pop it
589 } else if (rt == T_INT || is_subword_type(rt)) {
590 // Nothing. These cases are handled in lambda form bytecode.
591 assert(ct == T_INT || is_subword_type(ct), err_msg_res("must match: rt=%s, ct=%s", type2name(rt), type2name(ct)));
592 } else if (rt == T_OBJECT || rt == T_ARRAY) {
593 assert(ct == T_OBJECT || ct == T_ARRAY, err_msg_res("rt=%s, ct=%s", type2name(rt), type2name(ct)));
594 if (ctype->is_loaded()) {
595 const TypeOopPtr* arg_type = TypeOopPtr::make_from_klass(rtype->as_klass());
596 const Type* sig_type = TypeOopPtr::make_from_klass(ctype->as_klass());
597 if (arg_type != NULL && !arg_type->higher_equal(sig_type)) {
598 Node* retnode = pop();
599 Node* cast_obj = _gvn.transform(new (C) CheckCastPPNode(control(), retnode, sig_type));
600 push(cast_obj);
601 }
602 }
603 } else {
604 assert(rt == ct, err_msg_res("unexpected mismatch: rt=%s, ct=%s", type2name(rt), type2name(ct)));
605 // push a zero; it's better than getting an oop/int mismatch
606 pop_node(rt);
607 Node* retnode = zerocon(ct);
608 push_node(ct, retnode);
609 }
610 // Now that the value is well-behaved, continue with the call-site type.
611 rtype = ctype;
612 }
613 } else {
614 // Symbolic resolution enforces the types to be the same.
615 // NOTE: We must relax the assert for unloaded types because two
616 // different ciType instances of the same unloaded class type
617 // can appear to be "loaded" by different loaders (depending on
618 // the accessing class).
619 assert(!rtype->is_loaded() || !ctype->is_loaded() || rtype == ctype,
620 err_msg_res("mismatched return types: rtype=%s, ctype=%s", rtype->name(), ctype->name()));
621 }
622
623 // If the return type of the method is not loaded, assert that the
624 // value we got is a null. Otherwise, we need to recompile.
625 if (!rtype->is_loaded()) {
626 #ifndef PRODUCT
627 if (PrintOpto && (Verbose || WizardMode)) {
628 method()->print_name(); tty->print_cr(" asserting nullness of result at bci: %d", bci());
629 cg->method()->print_name(); tty->cr();
630 }
631 #endif
632 if (C->log() != NULL) {
633 C->log()->elem("assert_null reason='return' klass='%d'",
634 C->log()->identify(rtype));
635 }
636 // If there is going to be a trap, put it at the next bytecode:
637 set_bci(iter().next_bci());
638 null_assert(peek());
639 set_bci(iter().cur_bci()); // put it back
640 }
641 BasicType ct = ctype->basic_type();
642 if (ct == T_OBJECT || ct == T_ARRAY) {
643 ciKlass* better_type = NULL;
644 if (UseTypeSpeculation && method()->return_profiled_type(bci(), better_type)) {
645 // If profiling reports a single type for the return value,
646 // feed it to the type system so it can propagate it as a
647 // speculative type
648 record_profile_for_speculation(stack(sp()-1), better_type);
649 }
650 }
651 }
652
653 // Restart record of parsing work after possible inlining of call
654 #ifndef PRODUCT
655 parse_histogram()->set_initial_state(bc());
656 #endif
657 }
658
659 //---------------------------catch_call_exceptions-----------------------------
660 // Put a Catch and CatchProj nodes behind a just-created call.
661 // Send their caught exceptions to the proper handler.
662 // This may be used after a call to the rethrow VM stub,
663 // when it is needed to process unloaded exception classes.
664 void Parse::catch_call_exceptions(ciExceptionHandlerStream& handlers) {
665 // Exceptions are delivered through this channel:
666 Node* i_o = this->i_o();
667
668 // Add a CatchNode.
669 GrowableArray<int>* bcis = new (C->node_arena()) GrowableArray<int>(C->node_arena(), 8, 0, -1);
670 GrowableArray<const Type*>* extypes = new (C->node_arena()) GrowableArray<const Type*>(C->node_arena(), 8, 0, NULL);
671 GrowableArray<int>* saw_unloaded = new (C->node_arena()) GrowableArray<int>(C->node_arena(), 8, 0, 0);
672
673 for (; !handlers.is_done(); handlers.next()) {
674 ciExceptionHandler* h = handlers.handler();
675 int h_bci = h->handler_bci();
676 ciInstanceKlass* h_klass = h->is_catch_all() ? env()->Throwable_klass() : h->catch_klass();
677 // Do not introduce unloaded exception types into the graph:
678 if (!h_klass->is_loaded()) {
679 if (saw_unloaded->contains(h_bci)) {
680 /* We've already seen an unloaded exception with h_bci,
681 so don't duplicate. Duplication will cause the CatchNode to be
682 unnecessarily large. See 4713716. */
683 continue;
684 } else {
685 saw_unloaded->append(h_bci);
686 }
687 }
688 const Type* h_extype = TypeOopPtr::make_from_klass(h_klass);
689 // (We use make_from_klass because it respects UseUniqueSubclasses.)
690 h_extype = h_extype->join(TypeInstPtr::NOTNULL);
691 assert(!h_extype->empty(), "sanity");
692 // Note: It's OK if the BCIs repeat themselves.
693 bcis->append(h_bci);
694 extypes->append(h_extype);
695 }
696
697 int len = bcis->length();
698 CatchNode *cn = new (C) CatchNode(control(), i_o, len+1);
699 Node *catch_ = _gvn.transform(cn);
700
701 // now branch with the exception state to each of the (potential)
702 // handlers
703 for(int i=0; i < len; i++) {
704 // Setup JVM state to enter the handler.
705 PreserveJVMState pjvms(this);
706 // Locals are just copied from before the call.
707 // Get control from the CatchNode.
708 int handler_bci = bcis->at(i);
709 Node* ctrl = _gvn.transform( new (C) CatchProjNode(catch_, i+1,handler_bci));
710 // This handler cannot happen?
711 if (ctrl == top()) continue;
712 set_control(ctrl);
713
714 // Create exception oop
715 const TypeInstPtr* extype = extypes->at(i)->is_instptr();
716 Node *ex_oop = _gvn.transform(new (C) CreateExNode(extypes->at(i), ctrl, i_o));
717
718 // Handle unloaded exception classes.
719 if (saw_unloaded->contains(handler_bci)) {
720 // An unloaded exception type is coming here. Do an uncommon trap.
721 #ifndef PRODUCT
722 // We do not expect the same handler bci to take both cold unloaded
723 // and hot loaded exceptions. But, watch for it.
724 if ((Verbose || WizardMode) && extype->is_loaded()) {
725 tty->print("Warning: Handler @%d takes mixed loaded/unloaded exceptions in ", bci());
726 method()->print_name(); tty->cr();
727 } else if (PrintOpto && (Verbose || WizardMode)) {
728 tty->print("Bailing out on unloaded exception type ");
729 extype->klass()->print_name();
730 tty->print(" at bci:%d in ", bci());
731 method()->print_name(); tty->cr();
732 }
733 #endif
734 // Emit an uncommon trap instead of processing the block.
735 set_bci(handler_bci);
736 push_ex_oop(ex_oop);
737 uncommon_trap(Deoptimization::Reason_unloaded,
738 Deoptimization::Action_reinterpret,
739 extype->klass(), "!loaded exception");
740 set_bci(iter().cur_bci()); // put it back
741 continue;
742 }
743
744 // go to the exception handler
745 if (handler_bci < 0) { // merge with corresponding rethrow node
746 throw_to_exit(make_exception_state(ex_oop));
747 } else { // Else jump to corresponding handle
748 push_ex_oop(ex_oop); // Clear stack and push just the oop.
749 merge_exception(handler_bci);
750 }
751 }
752
753 // The first CatchProj is for the normal return.
754 // (Note: If this is a call to rethrow_Java, this node goes dead.)
755 set_control(_gvn.transform( new (C) CatchProjNode(catch_, CatchProjNode::fall_through_index, CatchProjNode::no_handler_bci)));
756 }
757
758
759 //----------------------------catch_inline_exceptions--------------------------
760 // Handle all exceptions thrown by an inlined method or individual bytecode.
761 // Common case 1: we have no handler, so all exceptions merge right into
762 // the rethrow case.
763 // Case 2: we have some handlers, with loaded exception klasses that have
764 // no subklasses. We do a Deutsch-Shiffman style type-check on the incoming
765 // exception oop and branch to the handler directly.
766 // Case 3: We have some handlers with subklasses or are not loaded at
767 // compile-time. We have to call the runtime to resolve the exception.
768 // So we insert a RethrowCall and all the logic that goes with it.
769 void Parse::catch_inline_exceptions(SafePointNode* ex_map) {
770 // Caller is responsible for saving away the map for normal control flow!
771 assert(stopped(), "call set_map(NULL) first");
772 assert(method()->has_exception_handlers(), "don't come here w/o work to do");
773
774 Node* ex_node = saved_ex_oop(ex_map);
775 if (ex_node == top()) {
776 // No action needed.
777 return;
778 }
779 const TypeInstPtr* ex_type = _gvn.type(ex_node)->isa_instptr();
780 NOT_PRODUCT(if (ex_type==NULL) tty->print_cr("*** Exception not InstPtr"));
781 if (ex_type == NULL)
782 ex_type = TypeOopPtr::make_from_klass(env()->Throwable_klass())->is_instptr();
783
784 // determine potential exception handlers
785 ciExceptionHandlerStream handlers(method(), bci(),
786 ex_type->klass()->as_instance_klass(),
787 ex_type->klass_is_exact());
788
789 // Start executing from the given throw state. (Keep its stack, for now.)
790 // Get the exception oop as known at compile time.
791 ex_node = use_exception_state(ex_map);
792
793 // Get the exception oop klass from its header
794 Node* ex_klass_node = NULL;
795 if (has_ex_handler() && !ex_type->klass_is_exact()) {
796 Node* p = basic_plus_adr( ex_node, ex_node, oopDesc::klass_offset_in_bytes());
797 ex_klass_node = _gvn.transform( LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeKlassPtr::OBJECT) );
798
799 // Compute the exception klass a little more cleverly.
800 // Obvious solution is to simple do a LoadKlass from the 'ex_node'.
801 // However, if the ex_node is a PhiNode, I'm going to do a LoadKlass for
802 // each arm of the Phi. If I know something clever about the exceptions
803 // I'm loading the class from, I can replace the LoadKlass with the
804 // klass constant for the exception oop.
805 if( ex_node->is_Phi() ) {
806 ex_klass_node = new (C) PhiNode( ex_node->in(0), TypeKlassPtr::OBJECT );
807 for( uint i = 1; i < ex_node->req(); i++ ) {
808 Node* p = basic_plus_adr( ex_node->in(i), ex_node->in(i), oopDesc::klass_offset_in_bytes() );
809 Node* k = _gvn.transform( LoadKlassNode::make(_gvn, immutable_memory(), p, TypeInstPtr::KLASS, TypeKlassPtr::OBJECT) );
810 ex_klass_node->init_req( i, k );
811 }
812 _gvn.set_type(ex_klass_node, TypeKlassPtr::OBJECT);
813
814 }
815 }
816
817 // Scan the exception table for applicable handlers.
818 // If none, we can call rethrow() and be done!
819 // If precise (loaded with no subklasses), insert a D.S. style
820 // pointer compare to the correct handler and loop back.
821 // If imprecise, switch to the Rethrow VM-call style handling.
822
823 int remaining = handlers.count_remaining();
824
825 // iterate through all entries sequentially
826 for (;!handlers.is_done(); handlers.next()) {
827 ciExceptionHandler* handler = handlers.handler();
828
829 if (handler->is_rethrow()) {
830 // If we fell off the end of the table without finding an imprecise
831 // exception klass (and without finding a generic handler) then we
832 // know this exception is not handled in this method. We just rethrow
833 // the exception into the caller.
834 throw_to_exit(make_exception_state(ex_node));
835 return;
836 }
837
838 // exception handler bci range covers throw_bci => investigate further
839 int handler_bci = handler->handler_bci();
840
841 if (remaining == 1) {
842 push_ex_oop(ex_node); // Push exception oop for handler
843 #ifndef PRODUCT
844 if (PrintOpto && WizardMode) {
845 tty->print_cr(" Catching every inline exception bci:%d -> handler_bci:%d", bci(), handler_bci);
846 }
847 #endif
848 merge_exception(handler_bci); // jump to handler
849 return; // No more handling to be done here!
850 }
851
852 // Get the handler's klass
853 ciInstanceKlass* klass = handler->catch_klass();
854
855 if (!klass->is_loaded()) { // klass is not loaded?
856 // fall through into catch_call_exceptions which will emit a
857 // handler with an uncommon trap.
858 break;
859 }
860
861 if (klass->is_interface()) // should not happen, but...
862 break; // bail out
863
864 // Check the type of the exception against the catch type
865 const TypeKlassPtr *tk = TypeKlassPtr::make(klass);
866 Node* con = _gvn.makecon(tk);
867 Node* not_subtype_ctrl = gen_subtype_check(ex_klass_node, con);
868 if (!stopped()) {
869 PreserveJVMState pjvms(this);
870 const TypeInstPtr* tinst = TypeOopPtr::make_from_klass_unique(klass)->cast_to_ptr_type(TypePtr::NotNull)->is_instptr();
871 assert(klass->has_subklass() || tinst->klass_is_exact(), "lost exactness");
872 Node* ex_oop = _gvn.transform(new (C) CheckCastPPNode(control(), ex_node, tinst));
873 push_ex_oop(ex_oop); // Push exception oop for handler
874 #ifndef PRODUCT
875 if (PrintOpto && WizardMode) {
876 tty->print(" Catching inline exception bci:%d -> handler_bci:%d -- ", bci(), handler_bci);
877 klass->print_name();
878 tty->cr();
879 }
880 #endif
881 merge_exception(handler_bci);
882 }
883 set_control(not_subtype_ctrl);
884
885 // Come here if exception does not match handler.
886 // Carry on with more handler checks.
887 --remaining;
888 }
889
890 assert(!stopped(), "you should return if you finish the chain");
891
892 // Oops, need to call into the VM to resolve the klasses at runtime.
893 // Note: This call must not deoptimize, since it is not a real at this bci!
894 kill_dead_locals();
895
896 make_runtime_call(RC_NO_LEAF | RC_MUST_THROW,
897 OptoRuntime::rethrow_Type(),
898 OptoRuntime::rethrow_stub(),
899 NULL, NULL,
900 ex_node);
901
902 // Rethrow is a pure call, no side effects, only a result.
903 // The result cannot be allocated, so we use I_O
904
905 // Catch exceptions from the rethrow
906 catch_call_exceptions(handlers);
907 }
908
909
910 // (Note: Moved add_debug_info into GraphKit::add_safepoint_edges.)
911
912
913 #ifndef PRODUCT
914 void Parse::count_compiled_calls(bool at_method_entry, bool is_inline) {
915 if( CountCompiledCalls ) {
916 if( at_method_entry ) {
917 // bump invocation counter if top method (for statistics)
918 if (CountCompiledCalls && depth() == 1) {
919 const TypePtr* addr_type = TypeMetadataPtr::make(method());
920 Node* adr1 = makecon(addr_type);
921 Node* adr2 = basic_plus_adr(adr1, adr1, in_bytes(Method::compiled_invocation_counter_offset()));
922 increment_counter(adr2);
923 }
924 } else if (is_inline) {
925 switch (bc()) {
926 case Bytecodes::_invokevirtual: increment_counter(SharedRuntime::nof_inlined_calls_addr()); break;
927 case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_inlined_interface_calls_addr()); break;
928 case Bytecodes::_invokestatic:
929 case Bytecodes::_invokedynamic:
930 case Bytecodes::_invokespecial: increment_counter(SharedRuntime::nof_inlined_static_calls_addr()); break;
931 default: fatal("unexpected call bytecode");
932 }
933 } else {
934 switch (bc()) {
935 case Bytecodes::_invokevirtual: increment_counter(SharedRuntime::nof_normal_calls_addr()); break;
936 case Bytecodes::_invokeinterface: increment_counter(SharedRuntime::nof_interface_calls_addr()); break;
937 case Bytecodes::_invokestatic:
938 case Bytecodes::_invokedynamic:
939 case Bytecodes::_invokespecial: increment_counter(SharedRuntime::nof_static_calls_addr()); break;
940 default: fatal("unexpected call bytecode");
941 }
942 }
943 }
944 }
945 #endif //PRODUCT
946
947
948 ciMethod* Compile::optimize_virtual_call(ciMethod* caller, int bci, ciInstanceKlass* klass,
949 ciMethod* callee, const TypeOopPtr* receiver_type,
950 bool is_virtual,
951 bool& call_does_dispatch, int& vtable_index) {
952 // Set default values for out-parameters.
953 call_does_dispatch = true;
954 vtable_index = Method::invalid_vtable_index;
955
956 // Choose call strategy.
957 ciMethod* optimized_virtual_method = optimize_inlining(caller, bci, klass, callee, receiver_type);
958
959 // Have the call been sufficiently improved such that it is no longer a virtual?
960 if (optimized_virtual_method != NULL) {
961 callee = optimized_virtual_method;
962 call_does_dispatch = false;
963 } else if (!UseInlineCaches && is_virtual && callee->is_loaded()) {
964 // We can make a vtable call at this site
965 vtable_index = callee->resolve_vtable_index(caller->holder(), klass);
966 }
967 return callee;
968 }
969
970 // Identify possible target method and inlining style
971 ciMethod* Compile::optimize_inlining(ciMethod* caller, int bci, ciInstanceKlass* klass,
972 ciMethod* callee, const TypeOopPtr* receiver_type) {
973 // only use for virtual or interface calls
974
975 // If it is obviously final, do not bother to call find_monomorphic_target,
976 // because the class hierarchy checks are not needed, and may fail due to
977 // incompletely loaded classes. Since we do our own class loading checks
978 // in this module, we may confidently bind to any method.
979 if (callee->can_be_statically_bound()) {
980 return callee;
981 }
982
983 // Attempt to improve the receiver
984 bool actual_receiver_is_exact = false;
985 ciInstanceKlass* actual_receiver = klass;
986 if (receiver_type != NULL) {
987 // Array methods are all inherited from Object, and are monomorphic.
988 if (receiver_type->isa_aryptr() &&
989 callee->holder() == env()->Object_klass()) {
990 return callee;
991 }
992
993 // All other interesting cases are instance klasses.
994 if (!receiver_type->isa_instptr()) {
995 return NULL;
996 }
997
998 ciInstanceKlass *ikl = receiver_type->klass()->as_instance_klass();
999 if (ikl->is_loaded() && ikl->is_initialized() && !ikl->is_interface() &&
1000 (ikl == actual_receiver || ikl->is_subtype_of(actual_receiver))) {
1001 // ikl is a same or better type than the original actual_receiver,
1002 // e.g. static receiver from bytecodes.
1003 actual_receiver = ikl;
1004 // Is the actual_receiver exact?
1005 actual_receiver_is_exact = receiver_type->klass_is_exact();
1006 }
1007 }
1008
1009 ciInstanceKlass* calling_klass = caller->holder();
1010 ciMethod* cha_monomorphic_target = callee->find_monomorphic_target(calling_klass, klass, actual_receiver);
1011 if (cha_monomorphic_target != NULL) {
1012 assert(!cha_monomorphic_target->is_abstract(), "");
1013 // Look at the method-receiver type. Does it add "too much information"?
1014 ciKlass* mr_klass = cha_monomorphic_target->holder();
1015 const Type* mr_type = TypeInstPtr::make(TypePtr::BotPTR, mr_klass);
1016 if (receiver_type == NULL || !receiver_type->higher_equal(mr_type)) {
1017 // Calling this method would include an implicit cast to its holder.
1018 // %%% Not yet implemented. Would throw minor asserts at present.
1019 // %%% The most common wins are already gained by +UseUniqueSubclasses.
1020 // To fix, put the higher_equal check at the call of this routine,
1021 // and add a CheckCastPP to the receiver.
1022 if (TraceDependencies) {
1023 tty->print_cr("found unique CHA method, but could not cast up");
1024 tty->print(" method = ");
1025 cha_monomorphic_target->print();
1026 tty->cr();
1027 }
1028 if (log() != NULL) {
1029 log()->elem("missed_CHA_opportunity klass='%d' method='%d'",
1030 log()->identify(klass),
1031 log()->identify(cha_monomorphic_target));
1032 }
1033 cha_monomorphic_target = NULL;
1034 }
1035 }
1036 if (cha_monomorphic_target != NULL) {
1037 // Hardwiring a virtual.
1038 // If we inlined because CHA revealed only a single target method,
1039 // then we are dependent on that target method not getting overridden
1040 // by dynamic class loading. Be sure to test the "static" receiver
1041 // dest_method here, as opposed to the actual receiver, which may
1042 // falsely lead us to believe that the receiver is final or private.
1043 dependencies()->assert_unique_concrete_method(actual_receiver, cha_monomorphic_target);
1044 return cha_monomorphic_target;
1045 }
1046
1047 // If the type is exact, we can still bind the method w/o a vcall.
1048 // (This case comes after CHA so we can see how much extra work it does.)
1049 if (actual_receiver_is_exact) {
1050 // In case of evolution, there is a dependence on every inlined method, since each
1051 // such method can be changed when its class is redefined.
1052 ciMethod* exact_method = callee->resolve_invoke(calling_klass, actual_receiver);
1053 if (exact_method != NULL) {
1054 #ifndef PRODUCT
1055 if (PrintOpto) {
1056 tty->print(" Calling method via exact type @%d --- ", bci);
1057 exact_method->print_name();
1058 tty->cr();
1059 }
1060 #endif
1061 return exact_method;
1062 }
1063 }
1064
1065 return NULL;
1066 }