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