1 /*
2 * Copyright (c) 2000, 2011, 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/bcEscapeAnalyzer.hpp"
27 #include "ci/ciCPCache.hpp"
28 #include "ci/ciMethodHandle.hpp"
29 #include "classfile/javaClasses.hpp"
30 #include "compiler/compileLog.hpp"
31 #include "opto/addnode.hpp"
32 #include "opto/callGenerator.hpp"
33 #include "opto/callnode.hpp"
34 #include "opto/cfgnode.hpp"
35 #include "opto/connode.hpp"
36 #include "opto/parse.hpp"
37 #include "opto/rootnode.hpp"
38 #include "opto/runtime.hpp"
39 #include "opto/subnode.hpp"
40
41 CallGenerator::CallGenerator(ciMethod* method) {
42 _method = method;
43 }
44
45 // Utility function.
46 const TypeFunc* CallGenerator::tf() const {
47 return TypeFunc::make(method());
48 }
49
50 //-----------------------------ParseGenerator---------------------------------
51 // Internal class which handles all direct bytecode traversal.
52 class ParseGenerator : public InlineCallGenerator {
53 private:
54 bool _is_osr;
55 float _expected_uses;
56
57 public:
58 ParseGenerator(ciMethod* method, float expected_uses, bool is_osr = false)
59 : InlineCallGenerator(method)
60 {
61 _is_osr = is_osr;
62 _expected_uses = expected_uses;
63 assert(can_parse(method, is_osr), "parse must be possible");
64 }
65
66 // Can we build either an OSR or a regular parser for this method?
67 static bool can_parse(ciMethod* method, int is_osr = false);
68
69 virtual bool is_parse() const { return true; }
70 virtual JVMState* generate(JVMState* jvms);
71 int is_osr() { return _is_osr; }
72
73 };
74
75 JVMState* ParseGenerator::generate(JVMState* jvms) {
76 Compile* C = Compile::current();
77
78 if (is_osr()) {
79 // The JVMS for a OSR has a single argument (see its TypeFunc).
80 assert(jvms->depth() == 1, "no inline OSR");
81 }
82
83 if (C->failing()) {
84 return NULL; // bailing out of the compile; do not try to parse
85 }
86
87 Parse parser(jvms, method(), _expected_uses);
88 // Grab signature for matching/allocation
89 #ifdef ASSERT
90 if (parser.tf() != (parser.depth() == 1 ? C->tf() : tf())) {
91 MutexLockerEx ml(Compile_lock, Mutex::_no_safepoint_check_flag);
92 assert(C->env()->system_dictionary_modification_counter_changed(),
93 "Must invalidate if TypeFuncs differ");
94 }
95 #endif
96
97 GraphKit& exits = parser.exits();
98
99 if (C->failing()) {
100 while (exits.pop_exception_state() != NULL) ;
101 return NULL;
102 }
103
104 assert(exits.jvms()->same_calls_as(jvms), "sanity");
105
106 // Simply return the exit state of the parser,
107 // augmented by any exceptional states.
108 return exits.transfer_exceptions_into_jvms();
109 }
110
111 //---------------------------DirectCallGenerator------------------------------
112 // Internal class which handles all out-of-line calls w/o receiver type checks.
113 class DirectCallGenerator : public CallGenerator {
114 private:
115 CallStaticJavaNode* _call_node;
116 // Force separate memory and I/O projections for the exceptional
117 // paths to facilitate late inlinig.
118 bool _separate_io_proj;
119
120 public:
121 DirectCallGenerator(ciMethod* method, bool separate_io_proj)
122 : CallGenerator(method),
123 _separate_io_proj(separate_io_proj)
124 {
125 }
126 virtual JVMState* generate(JVMState* jvms);
127
128 CallStaticJavaNode* call_node() const { return _call_node; }
129 };
130
131 JVMState* DirectCallGenerator::generate(JVMState* jvms) {
132 GraphKit kit(jvms);
133 bool is_static = method()->is_static();
134 address target = is_static ? SharedRuntime::get_resolve_static_call_stub()
135 : SharedRuntime::get_resolve_opt_virtual_call_stub();
136
137 if (kit.C->log() != NULL) {
138 kit.C->log()->elem("direct_call bci='%d'", jvms->bci());
139 }
140
141 CallStaticJavaNode *call = new (kit.C, tf()->domain()->cnt()) CallStaticJavaNode(tf(), target, method(), kit.bci());
142 if (!is_static) {
143 // Make an explicit receiver null_check as part of this call.
144 // Since we share a map with the caller, his JVMS gets adjusted.
145 kit.null_check_receiver(method());
146 if (kit.stopped()) {
147 // And dump it back to the caller, decorated with any exceptions:
148 return kit.transfer_exceptions_into_jvms();
149 }
150 // Mark the call node as virtual, sort of:
151 call->set_optimized_virtual(true);
152 if (method()->is_method_handle_invoke()) {
153 call->set_method_handle_invoke(true);
154 kit.C->set_has_method_handle_invokes(true);
155 }
156 }
157 kit.set_arguments_for_java_call(call);
158 kit.set_edges_for_java_call(call, false, _separate_io_proj);
159 Node* ret = kit.set_results_for_java_call(call, _separate_io_proj);
160 kit.push_node(method()->return_type()->basic_type(), ret);
161 _call_node = call; // Save the call node in case we need it later
162 return kit.transfer_exceptions_into_jvms();
163 }
164
165 //---------------------------DynamicCallGenerator-----------------------------
166 // Internal class which handles all out-of-line invokedynamic calls.
167 class DynamicCallGenerator : public CallGenerator {
168 public:
169 DynamicCallGenerator(ciMethod* method)
170 : CallGenerator(method)
171 {
172 }
173 virtual JVMState* generate(JVMState* jvms);
174 };
175
176 JVMState* DynamicCallGenerator::generate(JVMState* jvms) {
177 GraphKit kit(jvms);
178
179 if (kit.C->log() != NULL) {
180 kit.C->log()->elem("dynamic_call bci='%d'", jvms->bci());
181 }
182
183 // Get the constant pool cache from the caller class.
184 ciMethod* caller_method = jvms->method();
185 ciBytecodeStream str(caller_method);
186 str.force_bci(jvms->bci()); // Set the stream to the invokedynamic bci.
187 assert(str.cur_bc() == Bytecodes::_invokedynamic, "wrong place to issue a dynamic call!");
188 ciCPCache* cpcache = str.get_cpcache();
189
190 // Get the offset of the CallSite from the constant pool cache
191 // pointer.
192 int index = str.get_method_index();
193 size_t call_site_offset = cpcache->get_f1_offset(index);
194
195 // Load the CallSite object from the constant pool cache.
196 const TypeOopPtr* cpcache_ptr = TypeOopPtr::make_from_constant(cpcache);
197 Node* cpcache_adr = kit.makecon(cpcache_ptr);
198 Node* call_site_adr = kit.basic_plus_adr(cpcache_adr, cpcache_adr, call_site_offset);
199 Node* call_site = kit.make_load(kit.control(), call_site_adr, TypeInstPtr::BOTTOM, T_OBJECT, Compile::AliasIdxRaw);
200
201 // Load the target MethodHandle from the CallSite object.
202 Node* target_mh_adr = kit.basic_plus_adr(call_site, call_site, java_lang_invoke_CallSite::target_offset_in_bytes());
203 Node* target_mh = kit.make_load(kit.control(), target_mh_adr, TypeInstPtr::BOTTOM, T_OBJECT);
204
205 address resolve_stub = SharedRuntime::get_resolve_opt_virtual_call_stub();
206
207 CallStaticJavaNode *call = new (kit.C, tf()->domain()->cnt()) CallStaticJavaNode(tf(), resolve_stub, method(), kit.bci());
208 // invokedynamic is treated as an optimized invokevirtual.
209 call->set_optimized_virtual(true);
210 // Take extra care (in the presence of argument motion) not to trash the SP:
211 call->set_method_handle_invoke(true);
212 kit.C->set_has_method_handle_invokes(true);
213
214 // Pass the target MethodHandle as first argument and shift the
215 // other arguments.
216 call->init_req(0 + TypeFunc::Parms, target_mh);
217 uint nargs = call->method()->arg_size();
218 for (uint i = 1; i < nargs; i++) {
219 Node* arg = kit.argument(i - 1);
220 call->init_req(i + TypeFunc::Parms, arg);
221 }
222
223 kit.set_edges_for_java_call(call);
224 Node* ret = kit.set_results_for_java_call(call);
225 kit.push_node(method()->return_type()->basic_type(), ret);
226 return kit.transfer_exceptions_into_jvms();
227 }
228
229 //--------------------------VirtualCallGenerator------------------------------
230 // Internal class which handles all out-of-line calls checking receiver type.
231 class VirtualCallGenerator : public CallGenerator {
232 private:
233 int _vtable_index;
234 public:
235 VirtualCallGenerator(ciMethod* method, int vtable_index)
236 : CallGenerator(method), _vtable_index(vtable_index)
237 {
238 assert(vtable_index == methodOopDesc::invalid_vtable_index ||
239 vtable_index >= 0, "either invalid or usable");
240 }
241 virtual bool is_virtual() const { return true; }
242 virtual JVMState* generate(JVMState* jvms);
243 };
244
245 JVMState* VirtualCallGenerator::generate(JVMState* jvms) {
246 GraphKit kit(jvms);
247 Node* receiver = kit.argument(0);
248
249 if (kit.C->log() != NULL) {
250 kit.C->log()->elem("virtual_call bci='%d'", jvms->bci());
251 }
252
253 // If the receiver is a constant null, do not torture the system
254 // by attempting to call through it. The compile will proceed
255 // correctly, but may bail out in final_graph_reshaping, because
256 // the call instruction will have a seemingly deficient out-count.
257 // (The bailout says something misleading about an "infinite loop".)
258 if (kit.gvn().type(receiver)->higher_equal(TypePtr::NULL_PTR)) {
259 kit.inc_sp(method()->arg_size()); // restore arguments
260 kit.uncommon_trap(Deoptimization::Reason_null_check,
261 Deoptimization::Action_none,
262 NULL, "null receiver");
263 return kit.transfer_exceptions_into_jvms();
264 }
265
266 // Ideally we would unconditionally do a null check here and let it
267 // be converted to an implicit check based on profile information.
268 // However currently the conversion to implicit null checks in
269 // Block::implicit_null_check() only looks for loads and stores, not calls.
270 ciMethod *caller = kit.method();
271 ciMethodData *caller_md = (caller == NULL) ? NULL : caller->method_data();
272 if (!UseInlineCaches || !ImplicitNullChecks ||
273 ((ImplicitNullCheckThreshold > 0) && caller_md &&
274 (caller_md->trap_count(Deoptimization::Reason_null_check)
275 >= (uint)ImplicitNullCheckThreshold))) {
276 // Make an explicit receiver null_check as part of this call.
277 // Since we share a map with the caller, his JVMS gets adjusted.
278 receiver = kit.null_check_receiver(method());
279 if (kit.stopped()) {
280 // And dump it back to the caller, decorated with any exceptions:
281 return kit.transfer_exceptions_into_jvms();
282 }
283 }
284
285 assert(!method()->is_static(), "virtual call must not be to static");
286 assert(!method()->is_final(), "virtual call should not be to final");
287 assert(!method()->is_private(), "virtual call should not be to private");
288 assert(_vtable_index == methodOopDesc::invalid_vtable_index || !UseInlineCaches,
289 "no vtable calls if +UseInlineCaches ");
290 address target = SharedRuntime::get_resolve_virtual_call_stub();
291 // Normal inline cache used for call
292 CallDynamicJavaNode *call = new (kit.C, tf()->domain()->cnt()) CallDynamicJavaNode(tf(), target, method(), _vtable_index, kit.bci());
293 kit.set_arguments_for_java_call(call);
294 kit.set_edges_for_java_call(call);
295 Node* ret = kit.set_results_for_java_call(call);
296 kit.push_node(method()->return_type()->basic_type(), ret);
297
298 // Represent the effect of an implicit receiver null_check
299 // as part of this call. Since we share a map with the caller,
300 // his JVMS gets adjusted.
301 kit.cast_not_null(receiver);
302 return kit.transfer_exceptions_into_jvms();
303 }
304
305 bool ParseGenerator::can_parse(ciMethod* m, int entry_bci) {
306 // Certain methods cannot be parsed at all:
307 if (!m->can_be_compiled()) return false;
308 if (!m->has_balanced_monitors()) return false;
309 if (m->get_flow_analysis()->failing()) return false;
310
311 // (Methods may bail out for other reasons, after the parser is run.
312 // We try to avoid this, but if forced, we must return (Node*)NULL.
313 // The user of the CallGenerator must check for this condition.)
314 return true;
315 }
316
317 CallGenerator* CallGenerator::for_inline(ciMethod* m, float expected_uses) {
318 if (!ParseGenerator::can_parse(m)) return NULL;
319 return new ParseGenerator(m, expected_uses);
320 }
321
322 // As a special case, the JVMS passed to this CallGenerator is
323 // for the method execution already in progress, not just the JVMS
324 // of the caller. Thus, this CallGenerator cannot be mixed with others!
325 CallGenerator* CallGenerator::for_osr(ciMethod* m, int osr_bci) {
326 if (!ParseGenerator::can_parse(m, true)) return NULL;
327 float past_uses = m->interpreter_invocation_count();
328 float expected_uses = past_uses;
329 return new ParseGenerator(m, expected_uses, true);
330 }
331
332 CallGenerator* CallGenerator::for_direct_call(ciMethod* m, bool separate_io_proj) {
333 assert(!m->is_abstract(), "for_direct_call mismatch");
334 return new DirectCallGenerator(m, separate_io_proj);
335 }
336
337 CallGenerator* CallGenerator::for_dynamic_call(ciMethod* m) {
338 assert(m->is_method_handle_invoke(), "for_dynamic_call mismatch");
339 return new DynamicCallGenerator(m);
340 }
341
342 CallGenerator* CallGenerator::for_virtual_call(ciMethod* m, int vtable_index) {
343 assert(!m->is_static(), "for_virtual_call mismatch");
344 assert(!m->is_method_handle_invoke(), "should be a direct call");
345 return new VirtualCallGenerator(m, vtable_index);
346 }
347
348 // Allow inlining decisions to be delayed
349 class LateInlineCallGenerator : public DirectCallGenerator {
350 CallGenerator* _inline_cg;
351
352 public:
353 LateInlineCallGenerator(ciMethod* method, CallGenerator* inline_cg) :
354 DirectCallGenerator(method, true), _inline_cg(inline_cg) {}
355
356 virtual bool is_late_inline() const { return true; }
357
358 // Convert the CallStaticJava into an inline
359 virtual void do_late_inline();
360
361 JVMState* generate(JVMState* jvms) {
362 // Record that this call site should be revisited once the main
363 // parse is finished.
364 Compile::current()->add_late_inline(this);
365
366 // Emit the CallStaticJava and request separate projections so
367 // that the late inlining logic can distinguish between fall
368 // through and exceptional uses of the memory and io projections
369 // as is done for allocations and macro expansion.
370 return DirectCallGenerator::generate(jvms);
371 }
372
373 };
374
375
376 void LateInlineCallGenerator::do_late_inline() {
377 // Can't inline it
378 if (call_node() == NULL || call_node()->outcnt() == 0 ||
379 call_node()->in(0) == NULL || call_node()->in(0)->is_top())
380 return;
381
382 CallStaticJavaNode* call = call_node();
383
384 // Make a clone of the JVMState that appropriate to use for driving a parse
385 Compile* C = Compile::current();
386 JVMState* jvms = call->jvms()->clone_shallow(C);
387 uint size = call->req();
388 SafePointNode* map = new (C, size) SafePointNode(size, jvms);
389 for (uint i1 = 0; i1 < size; i1++) {
390 map->init_req(i1, call->in(i1));
391 }
392
393 // Make sure the state is a MergeMem for parsing.
394 if (!map->in(TypeFunc::Memory)->is_MergeMem()) {
395 map->set_req(TypeFunc::Memory, MergeMemNode::make(C, map->in(TypeFunc::Memory)));
396 }
397
398 // Make enough space for the expression stack and transfer the incoming arguments
399 int nargs = method()->arg_size();
400 jvms->set_map(map);
401 map->ensure_stack(jvms, jvms->method()->max_stack());
402 if (nargs > 0) {
403 for (int i1 = 0; i1 < nargs; i1++) {
404 map->set_req(i1 + jvms->argoff(), call->in(TypeFunc::Parms + i1));
405 }
406 }
407
408 CompileLog* log = C->log();
409 if (log != NULL) {
410 log->head("late_inline method='%d'", log->identify(method()));
411 JVMState* p = jvms;
412 while (p != NULL) {
413 log->elem("jvms bci='%d' method='%d'", p->bci(), log->identify(p->method()));
414 p = p->caller();
415 }
416 log->tail("late_inline");
417 }
418
419 // Setup default node notes to be picked up by the inlining
420 Node_Notes* old_nn = C->default_node_notes();
421 if (old_nn != NULL) {
422 Node_Notes* entry_nn = old_nn->clone(C);
423 entry_nn->set_jvms(jvms);
424 C->set_default_node_notes(entry_nn);
425 }
426
427 // Now perform the inling using the synthesized JVMState
428 JVMState* new_jvms = _inline_cg->generate(jvms);
429 if (new_jvms == NULL) return; // no change
430 if (C->failing()) return;
431
432 // Capture any exceptional control flow
433 GraphKit kit(new_jvms);
434
435 // Find the result object
436 Node* result = C->top();
437 int result_size = method()->return_type()->size();
438 if (result_size != 0 && !kit.stopped()) {
439 result = (result_size == 1) ? kit.pop() : kit.pop_pair();
440 }
441
442 kit.replace_call(call, result);
443 }
444
445
446 CallGenerator* CallGenerator::for_late_inline(ciMethod* method, CallGenerator* inline_cg) {
447 return new LateInlineCallGenerator(method, inline_cg);
448 }
449
450
451 //---------------------------WarmCallGenerator--------------------------------
452 // Internal class which handles initial deferral of inlining decisions.
453 class WarmCallGenerator : public CallGenerator {
454 WarmCallInfo* _call_info;
455 CallGenerator* _if_cold;
456 CallGenerator* _if_hot;
457 bool _is_virtual; // caches virtuality of if_cold
458 bool _is_inline; // caches inline-ness of if_hot
459
460 public:
461 WarmCallGenerator(WarmCallInfo* ci,
462 CallGenerator* if_cold,
463 CallGenerator* if_hot)
464 : CallGenerator(if_cold->method())
465 {
466 assert(method() == if_hot->method(), "consistent choices");
467 _call_info = ci;
468 _if_cold = if_cold;
469 _if_hot = if_hot;
470 _is_virtual = if_cold->is_virtual();
471 _is_inline = if_hot->is_inline();
472 }
473
474 virtual bool is_inline() const { return _is_inline; }
475 virtual bool is_virtual() const { return _is_virtual; }
476 virtual bool is_deferred() const { return true; }
477
478 virtual JVMState* generate(JVMState* jvms);
479 };
480
481
482 CallGenerator* CallGenerator::for_warm_call(WarmCallInfo* ci,
483 CallGenerator* if_cold,
484 CallGenerator* if_hot) {
485 return new WarmCallGenerator(ci, if_cold, if_hot);
486 }
487
488 JVMState* WarmCallGenerator::generate(JVMState* jvms) {
489 Compile* C = Compile::current();
490 if (C->log() != NULL) {
491 C->log()->elem("warm_call bci='%d'", jvms->bci());
492 }
493 jvms = _if_cold->generate(jvms);
494 if (jvms != NULL) {
495 Node* m = jvms->map()->control();
496 if (m->is_CatchProj()) m = m->in(0); else m = C->top();
497 if (m->is_Catch()) m = m->in(0); else m = C->top();
498 if (m->is_Proj()) m = m->in(0); else m = C->top();
499 if (m->is_CallJava()) {
500 _call_info->set_call(m->as_Call());
501 _call_info->set_hot_cg(_if_hot);
502 #ifndef PRODUCT
503 if (PrintOpto || PrintOptoInlining) {
504 tty->print_cr("Queueing for warm inlining at bci %d:", jvms->bci());
505 tty->print("WCI: ");
506 _call_info->print();
507 }
508 #endif
509 _call_info->set_heat(_call_info->compute_heat());
510 C->set_warm_calls(_call_info->insert_into(C->warm_calls()));
511 }
512 }
513 return jvms;
514 }
515
516 void WarmCallInfo::make_hot() {
517 Unimplemented();
518 }
519
520 void WarmCallInfo::make_cold() {
521 // No action: Just dequeue.
522 }
523
524
525 //------------------------PredictedCallGenerator------------------------------
526 // Internal class which handles all out-of-line calls checking receiver type.
527 class PredictedCallGenerator : public CallGenerator {
528 ciKlass* _predicted_receiver;
529 CallGenerator* _if_missed;
530 CallGenerator* _if_hit;
531 float _hit_prob;
532
533 public:
534 PredictedCallGenerator(ciKlass* predicted_receiver,
535 CallGenerator* if_missed,
536 CallGenerator* if_hit, float hit_prob)
537 : CallGenerator(if_missed->method())
538 {
539 // The call profile data may predict the hit_prob as extreme as 0 or 1.
540 // Remove the extremes values from the range.
541 if (hit_prob > PROB_MAX) hit_prob = PROB_MAX;
542 if (hit_prob < PROB_MIN) hit_prob = PROB_MIN;
543
544 _predicted_receiver = predicted_receiver;
545 _if_missed = if_missed;
546 _if_hit = if_hit;
547 _hit_prob = hit_prob;
548 }
549
550 virtual bool is_virtual() const { return true; }
551 virtual bool is_inline() const { return _if_hit->is_inline(); }
552 virtual bool is_deferred() const { return _if_hit->is_deferred(); }
553
554 virtual JVMState* generate(JVMState* jvms);
555 };
556
557
558 CallGenerator* CallGenerator::for_predicted_call(ciKlass* predicted_receiver,
559 CallGenerator* if_missed,
560 CallGenerator* if_hit,
561 float hit_prob) {
562 return new PredictedCallGenerator(predicted_receiver, if_missed, if_hit, hit_prob);
563 }
564
565
566 JVMState* PredictedCallGenerator::generate(JVMState* jvms) {
567 GraphKit kit(jvms);
568 PhaseGVN& gvn = kit.gvn();
569 // We need an explicit receiver null_check before checking its type.
570 // We share a map with the caller, so his JVMS gets adjusted.
571 Node* receiver = kit.argument(0);
572
573 CompileLog* log = kit.C->log();
574 if (log != NULL) {
575 log->elem("predicted_call bci='%d' klass='%d'",
576 jvms->bci(), log->identify(_predicted_receiver));
577 }
578
579 receiver = kit.null_check_receiver(method());
580 if (kit.stopped()) {
581 return kit.transfer_exceptions_into_jvms();
582 }
583
584 Node* exact_receiver = receiver; // will get updated in place...
585 Node* slow_ctl = kit.type_check_receiver(receiver,
586 _predicted_receiver, _hit_prob,
587 &exact_receiver);
588
589 SafePointNode* slow_map = NULL;
590 JVMState* slow_jvms;
591 { PreserveJVMState pjvms(&kit);
592 kit.set_control(slow_ctl);
593 if (!kit.stopped()) {
594 slow_jvms = _if_missed->generate(kit.sync_jvms());
595 assert(slow_jvms != NULL, "miss path must not fail to generate");
596 kit.add_exception_states_from(slow_jvms);
597 kit.set_map(slow_jvms->map());
598 if (!kit.stopped())
599 slow_map = kit.stop();
600 }
601 }
602
603 if (kit.stopped()) {
604 // Instance exactly does not matches the desired type.
605 kit.set_jvms(slow_jvms);
606 return kit.transfer_exceptions_into_jvms();
607 }
608
609 // fall through if the instance exactly matches the desired type
610 kit.replace_in_map(receiver, exact_receiver);
611
612 // Make the hot call:
613 JVMState* new_jvms = _if_hit->generate(kit.sync_jvms());
614 if (new_jvms == NULL) {
615 // Inline failed, so make a direct call.
616 assert(_if_hit->is_inline(), "must have been a failed inline");
617 CallGenerator* cg = CallGenerator::for_direct_call(_if_hit->method());
618 new_jvms = cg->generate(kit.sync_jvms());
619 }
620 kit.add_exception_states_from(new_jvms);
621 kit.set_jvms(new_jvms);
622
623 // Need to merge slow and fast?
624 if (slow_map == NULL) {
625 // The fast path is the only path remaining.
626 return kit.transfer_exceptions_into_jvms();
627 }
628
629 if (kit.stopped()) {
630 // Inlined method threw an exception, so it's just the slow path after all.
631 kit.set_jvms(slow_jvms);
632 return kit.transfer_exceptions_into_jvms();
633 }
634
635 // Finish the diamond.
636 kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
637 RegionNode* region = new (kit.C, 3) RegionNode(3);
638 region->init_req(1, kit.control());
639 region->init_req(2, slow_map->control());
640 kit.set_control(gvn.transform(region));
641 Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
642 iophi->set_req(2, slow_map->i_o());
643 kit.set_i_o(gvn.transform(iophi));
644 kit.merge_memory(slow_map->merged_memory(), region, 2);
645 uint tos = kit.jvms()->stkoff() + kit.sp();
646 uint limit = slow_map->req();
647 for (uint i = TypeFunc::Parms; i < limit; i++) {
648 // Skip unused stack slots; fast forward to monoff();
649 if (i == tos) {
650 i = kit.jvms()->monoff();
651 if( i >= limit ) break;
652 }
653 Node* m = kit.map()->in(i);
654 Node* n = slow_map->in(i);
655 if (m != n) {
656 const Type* t = gvn.type(m)->meet(gvn.type(n));
657 Node* phi = PhiNode::make(region, m, t);
658 phi->set_req(2, n);
659 kit.map()->set_req(i, gvn.transform(phi));
660 }
661 }
662 return kit.transfer_exceptions_into_jvms();
663 }
664
665
666 //------------------------PredictedDynamicCallGenerator-----------------------
667 // Internal class which handles all out-of-line calls checking receiver type.
668 class PredictedDynamicCallGenerator : public CallGenerator {
669 ciMethodHandle* _predicted_method_handle;
670 CallGenerator* _if_missed;
671 CallGenerator* _if_hit;
672 float _hit_prob;
673
674 public:
675 PredictedDynamicCallGenerator(ciMethodHandle* predicted_method_handle,
676 CallGenerator* if_missed,
677 CallGenerator* if_hit,
678 float hit_prob)
679 : CallGenerator(if_missed->method()),
680 _predicted_method_handle(predicted_method_handle),
681 _if_missed(if_missed),
682 _if_hit(if_hit),
683 _hit_prob(hit_prob)
684 {}
685
686 virtual bool is_inline() const { return _if_hit->is_inline(); }
687 virtual bool is_deferred() const { return _if_hit->is_deferred(); }
688
689 virtual JVMState* generate(JVMState* jvms);
690 };
691
692
693 CallGenerator* CallGenerator::for_predicted_dynamic_call(ciMethodHandle* predicted_method_handle,
694 CallGenerator* if_missed,
695 CallGenerator* if_hit,
696 float hit_prob) {
697 return new PredictedDynamicCallGenerator(predicted_method_handle, if_missed, if_hit, hit_prob);
698 }
699
700
701 CallGenerator* CallGenerator::for_method_handle_inline(Node* method_handle, JVMState* jvms,
702 ciMethod* caller, ciMethod* callee, ciCallProfile profile) {
703 if (method_handle->Opcode() == Op_ConP) {
704 const TypeOopPtr* oop_ptr = method_handle->bottom_type()->is_oopptr();
705 ciObject* const_oop = oop_ptr->const_oop();
706 ciMethodHandle* method_handle = const_oop->as_method_handle();
707
708 // Set the callee to have access to the class and signature in
709 // the MethodHandleCompiler.
710 method_handle->set_callee(callee);
711 method_handle->set_caller(caller);
712 method_handle->set_call_profile(profile);
713
714 // Get an adapter for the MethodHandle.
715 ciMethod* target_method = method_handle->get_method_handle_adapter();
716 if (target_method != NULL) {
717 CallGenerator* hit_cg = Compile::current()->call_generator(target_method, -1, false, jvms, true, 1);
718 if (hit_cg != NULL && hit_cg->is_inline())
719 return hit_cg;
720 }
721 } else if (method_handle->Opcode() == Op_Phi && method_handle->req() == 3 &&
722 method_handle->in(1)->Opcode() == Op_ConP && method_handle->in(2)->Opcode() == Op_ConP) {
723 // selectAlternative idiom merging two constant MethodHandles.
724 // Generate a guard so that each can be inlined. We might want to
725 // do more inputs at later point but this gets the most common
726 // case.
727 const TypeOopPtr* oop_ptr = method_handle->in(1)->bottom_type()->is_oopptr();
728 ciObject* const_oop = oop_ptr->const_oop();
729 ciMethodHandle* mh = const_oop->as_method_handle();
730
731 CallGenerator* cg1 = for_method_handle_inline(method_handle->in(1), jvms, caller, callee, profile);
732 CallGenerator* cg2 = for_method_handle_inline(method_handle->in(2), jvms, caller, callee, profile);
733 if (cg1 != NULL && cg2 != NULL) {
734 return new PredictedDynamicCallGenerator(mh, cg2, cg1, PROB_FAIR);
735 }
736 }
737 return NULL;
738 }
739
740
741 JVMState* PredictedDynamicCallGenerator::generate(JVMState* jvms) {
742 GraphKit kit(jvms);
743 PhaseGVN& gvn = kit.gvn();
744
745 CompileLog* log = kit.C->log();
746 if (log != NULL) {
747 log->elem("predicted_dynamic_call bci='%d'", jvms->bci());
748 }
749
750 const TypeOopPtr* predicted_mh_ptr = TypeOopPtr::make_from_constant(_predicted_method_handle, true);
751 Node* predicted_mh = kit.makecon(predicted_mh_ptr);
752
753 Node* bol = NULL;
754 int bc = jvms->method()->java_code_at_bci(jvms->bci());
755 if (bc == Bytecodes::_invokespecial) {
756 // This is the selectAlternative idiom for guardWithTest
757 Node* receiver = kit.argument(0);
758
759 // Check if the MethodHandle is the expected one
760 Node* cmp = gvn.transform(new(kit.C, 3) CmpPNode(receiver, predicted_mh));
761 bol = gvn.transform(new(kit.C, 2) BoolNode(cmp, BoolTest::eq) );
762 } else {
763 assert(bc == Bytecodes::_invokedynamic, "must be");
764 // Get the constant pool cache from the caller class.
765 ciMethod* caller_method = jvms->method();
766 ciBytecodeStream str(caller_method);
767 str.force_bci(jvms->bci()); // Set the stream to the invokedynamic bci.
768 ciCPCache* cpcache = str.get_cpcache();
769
770 // Get the offset of the CallSite from the constant pool cache
771 // pointer.
772 int index = str.get_method_index();
773 size_t call_site_offset = cpcache->get_f1_offset(index);
774
775 // Load the CallSite object from the constant pool cache.
776 const TypeOopPtr* cpcache_ptr = TypeOopPtr::make_from_constant(cpcache);
777 Node* cpcache_adr = kit.makecon(cpcache_ptr);
778 Node* call_site_adr = kit.basic_plus_adr(cpcache_adr, cpcache_adr, call_site_offset);
779 Node* call_site = kit.make_load(kit.control(), call_site_adr, TypeInstPtr::BOTTOM, T_OBJECT, Compile::AliasIdxRaw);
780
781 // Load the target MethodHandle from the CallSite object.
782 Node* target_adr = kit.basic_plus_adr(call_site, call_site, java_lang_invoke_CallSite::target_offset_in_bytes());
783 Node* target_mh = kit.make_load(kit.control(), target_adr, TypeInstPtr::BOTTOM, T_OBJECT);
784
785 // Check if the MethodHandle is still the same.
786 Node* cmp = gvn.transform(new(kit.C, 3) CmpPNode(target_mh, predicted_mh));
787 bol = gvn.transform(new(kit.C, 2) BoolNode(cmp, BoolTest::eq) );
788 }
789 IfNode* iff = kit.create_and_xform_if(kit.control(), bol, _hit_prob, COUNT_UNKNOWN);
790 kit.set_control( gvn.transform(new(kit.C, 1) IfTrueNode (iff)));
791 Node* slow_ctl = gvn.transform(new(kit.C, 1) IfFalseNode(iff));
792
793 SafePointNode* slow_map = NULL;
794 JVMState* slow_jvms;
795 { PreserveJVMState pjvms(&kit);
796 kit.set_control(slow_ctl);
797 if (!kit.stopped()) {
798 slow_jvms = _if_missed->generate(kit.sync_jvms());
799 assert(slow_jvms != NULL, "miss path must not fail to generate");
800 kit.add_exception_states_from(slow_jvms);
801 kit.set_map(slow_jvms->map());
802 if (!kit.stopped())
803 slow_map = kit.stop();
804 }
805 }
806
807 if (kit.stopped()) {
808 // Instance exactly does not matches the desired type.
809 kit.set_jvms(slow_jvms);
810 return kit.transfer_exceptions_into_jvms();
811 }
812
813 // Make the hot call:
814 JVMState* new_jvms = _if_hit->generate(kit.sync_jvms());
815 if (new_jvms == NULL) {
816 // Inline failed, so make a direct call.
817 assert(_if_hit->is_inline(), "must have been a failed inline");
818 CallGenerator* cg = CallGenerator::for_direct_call(_if_hit->method());
819 new_jvms = cg->generate(kit.sync_jvms());
820 }
821 kit.add_exception_states_from(new_jvms);
822 kit.set_jvms(new_jvms);
823
824 // Need to merge slow and fast?
825 if (slow_map == NULL) {
826 // The fast path is the only path remaining.
827 return kit.transfer_exceptions_into_jvms();
828 }
829
830 if (kit.stopped()) {
831 // Inlined method threw an exception, so it's just the slow path after all.
832 kit.set_jvms(slow_jvms);
833 return kit.transfer_exceptions_into_jvms();
834 }
835
836 // Finish the diamond.
837 kit.C->set_has_split_ifs(true); // Has chance for split-if optimization
838 RegionNode* region = new (kit.C, 3) RegionNode(3);
839 region->init_req(1, kit.control());
840 region->init_req(2, slow_map->control());
841 kit.set_control(gvn.transform(region));
842 Node* iophi = PhiNode::make(region, kit.i_o(), Type::ABIO);
843 iophi->set_req(2, slow_map->i_o());
844 kit.set_i_o(gvn.transform(iophi));
845 kit.merge_memory(slow_map->merged_memory(), region, 2);
846 uint tos = kit.jvms()->stkoff() + kit.sp();
847 uint limit = slow_map->req();
848 for (uint i = TypeFunc::Parms; i < limit; i++) {
849 // Skip unused stack slots; fast forward to monoff();
850 if (i == tos) {
851 i = kit.jvms()->monoff();
852 if( i >= limit ) break;
853 }
854 Node* m = kit.map()->in(i);
855 Node* n = slow_map->in(i);
856 if (m != n) {
857 const Type* t = gvn.type(m)->meet(gvn.type(n));
858 Node* phi = PhiNode::make(region, m, t);
859 phi->set_req(2, n);
860 kit.map()->set_req(i, gvn.transform(phi));
861 }
862 }
863 return kit.transfer_exceptions_into_jvms();
864 }
865
866
867 //-------------------------UncommonTrapCallGenerator-----------------------------
868 // Internal class which handles all out-of-line calls checking receiver type.
869 class UncommonTrapCallGenerator : public CallGenerator {
870 Deoptimization::DeoptReason _reason;
871 Deoptimization::DeoptAction _action;
872
873 public:
874 UncommonTrapCallGenerator(ciMethod* m,
875 Deoptimization::DeoptReason reason,
876 Deoptimization::DeoptAction action)
877 : CallGenerator(m)
878 {
879 _reason = reason;
880 _action = action;
881 }
882
883 virtual bool is_virtual() const { ShouldNotReachHere(); return false; }
884 virtual bool is_trap() const { return true; }
885
886 virtual JVMState* generate(JVMState* jvms);
887 };
888
889
890 CallGenerator*
891 CallGenerator::for_uncommon_trap(ciMethod* m,
892 Deoptimization::DeoptReason reason,
893 Deoptimization::DeoptAction action) {
894 return new UncommonTrapCallGenerator(m, reason, action);
895 }
896
897
898 JVMState* UncommonTrapCallGenerator::generate(JVMState* jvms) {
899 GraphKit kit(jvms);
900 // Take the trap with arguments pushed on the stack. (Cf. null_check_receiver).
901 int nargs = method()->arg_size();
902 kit.inc_sp(nargs);
903 assert(nargs <= kit.sp() && kit.sp() <= jvms->stk_size(), "sane sp w/ args pushed");
904 if (_reason == Deoptimization::Reason_class_check &&
905 _action == Deoptimization::Action_maybe_recompile) {
906 // Temp fix for 6529811
907 // Don't allow uncommon_trap to override our decision to recompile in the event
908 // of a class cast failure for a monomorphic call as it will never let us convert
909 // the call to either bi-morphic or megamorphic and can lead to unc-trap loops
910 bool keep_exact_action = true;
911 kit.uncommon_trap(_reason, _action, NULL, "monomorphic vcall checkcast", false, keep_exact_action);
912 } else {
913 kit.uncommon_trap(_reason, _action);
914 }
915 return kit.transfer_exceptions_into_jvms();
916 }
917
918 // (Note: Moved hook_up_call to GraphKit::set_edges_for_java_call.)
919
920 // (Node: Merged hook_up_exits into ParseGenerator::generate.)
921
922 #define NODES_OVERHEAD_PER_METHOD (30.0)
923 #define NODES_PER_BYTECODE (9.5)
924
925 void WarmCallInfo::init(JVMState* call_site, ciMethod* call_method, ciCallProfile& profile, float prof_factor) {
926 int call_count = profile.count();
927 int code_size = call_method->code_size();
928
929 // Expected execution count is based on the historical count:
930 _count = call_count < 0 ? 1 : call_site->method()->scale_count(call_count, prof_factor);
931
932 // Expected profit from inlining, in units of simple call-overheads.
933 _profit = 1.0;
934
935 // Expected work performed by the call in units of call-overheads.
936 // %%% need an empirical curve fit for "work" (time in call)
937 float bytecodes_per_call = 3;
938 _work = 1.0 + code_size / bytecodes_per_call;
939
940 // Expected size of compilation graph:
941 // -XX:+PrintParseStatistics once reported:
942 // Methods seen: 9184 Methods parsed: 9184 Nodes created: 1582391
943 // Histogram of 144298 parsed bytecodes:
944 // %%% Need an better predictor for graph size.
945 _size = NODES_OVERHEAD_PER_METHOD + (NODES_PER_BYTECODE * code_size);
946 }
947
948 // is_cold: Return true if the node should never be inlined.
949 // This is true if any of the key metrics are extreme.
950 bool WarmCallInfo::is_cold() const {
951 if (count() < WarmCallMinCount) return true;
952 if (profit() < WarmCallMinProfit) return true;
953 if (work() > WarmCallMaxWork) return true;
954 if (size() > WarmCallMaxSize) return true;
955 return false;
956 }
957
958 // is_hot: Return true if the node should be inlined immediately.
959 // This is true if any of the key metrics are extreme.
960 bool WarmCallInfo::is_hot() const {
961 assert(!is_cold(), "eliminate is_cold cases before testing is_hot");
962 if (count() >= HotCallCountThreshold) return true;
963 if (profit() >= HotCallProfitThreshold) return true;
964 if (work() <= HotCallTrivialWork) return true;
965 if (size() <= HotCallTrivialSize) return true;
966 return false;
967 }
968
969 // compute_heat:
970 float WarmCallInfo::compute_heat() const {
971 assert(!is_cold(), "compute heat only on warm nodes");
972 assert(!is_hot(), "compute heat only on warm nodes");
973 int min_size = MAX2(0, (int)HotCallTrivialSize);
974 int max_size = MIN2(500, (int)WarmCallMaxSize);
975 float method_size = (size() - min_size) / MAX2(1, max_size - min_size);
976 float size_factor;
977 if (method_size < 0.05) size_factor = 4; // 2 sigmas better than avg.
978 else if (method_size < 0.15) size_factor = 2; // 1 sigma better than avg.
979 else if (method_size < 0.5) size_factor = 1; // better than avg.
980 else size_factor = 0.5; // worse than avg.
981 return (count() * profit() * size_factor);
982 }
983
984 bool WarmCallInfo::warmer_than(WarmCallInfo* that) {
985 assert(this != that, "compare only different WCIs");
986 assert(this->heat() != 0 && that->heat() != 0, "call compute_heat 1st");
987 if (this->heat() > that->heat()) return true;
988 if (this->heat() < that->heat()) return false;
989 assert(this->heat() == that->heat(), "no NaN heat allowed");
990 // Equal heat. Break the tie some other way.
991 if (!this->call() || !that->call()) return (address)this > (address)that;
992 return this->call()->_idx > that->call()->_idx;
993 }
994
995 //#define UNINIT_NEXT ((WarmCallInfo*)badAddress)
996 #define UNINIT_NEXT ((WarmCallInfo*)NULL)
997
998 WarmCallInfo* WarmCallInfo::insert_into(WarmCallInfo* head) {
999 assert(next() == UNINIT_NEXT, "not yet on any list");
1000 WarmCallInfo* prev_p = NULL;
1001 WarmCallInfo* next_p = head;
1002 while (next_p != NULL && next_p->warmer_than(this)) {
1003 prev_p = next_p;
1004 next_p = prev_p->next();
1005 }
1006 // Install this between prev_p and next_p.
1007 this->set_next(next_p);
1008 if (prev_p == NULL)
1009 head = this;
1010 else
1011 prev_p->set_next(this);
1012 return head;
1013 }
1014
1015 WarmCallInfo* WarmCallInfo::remove_from(WarmCallInfo* head) {
1016 WarmCallInfo* prev_p = NULL;
1017 WarmCallInfo* next_p = head;
1018 while (next_p != this) {
1019 assert(next_p != NULL, "this must be in the list somewhere");
1020 prev_p = next_p;
1021 next_p = prev_p->next();
1022 }
1023 next_p = this->next();
1024 debug_only(this->set_next(UNINIT_NEXT));
1025 // Remove this from between prev_p and next_p.
1026 if (prev_p == NULL)
1027 head = next_p;
1028 else
1029 prev_p->set_next(next_p);
1030 return head;
1031 }
1032
1033 WarmCallInfo WarmCallInfo::_always_hot(WarmCallInfo::MAX_VALUE(), WarmCallInfo::MAX_VALUE(),
1034 WarmCallInfo::MIN_VALUE(), WarmCallInfo::MIN_VALUE());
1035 WarmCallInfo WarmCallInfo::_always_cold(WarmCallInfo::MIN_VALUE(), WarmCallInfo::MIN_VALUE(),
1036 WarmCallInfo::MAX_VALUE(), WarmCallInfo::MAX_VALUE());
1037
1038 WarmCallInfo* WarmCallInfo::always_hot() {
1039 assert(_always_hot.is_hot(), "must always be hot");
1040 return &_always_hot;
1041 }
1042
1043 WarmCallInfo* WarmCallInfo::always_cold() {
1044 assert(_always_cold.is_cold(), "must always be cold");
1045 return &_always_cold;
1046 }
1047
1048
1049 #ifndef PRODUCT
1050
1051 void WarmCallInfo::print() const {
1052 tty->print("%s : C=%6.1f P=%6.1f W=%6.1f S=%6.1f H=%6.1f -> %p",
1053 is_cold() ? "cold" : is_hot() ? "hot " : "warm",
1054 count(), profit(), work(), size(), compute_heat(), next());
1055 tty->cr();
1056 if (call() != NULL) call()->dump();
1057 }
1058
1059 void print_wci(WarmCallInfo* ci) {
1060 ci->print();
1061 }
1062
1063 void WarmCallInfo::print_all() const {
1064 for (const WarmCallInfo* p = this; p != NULL; p = p->next())
1065 p->print();
1066 }
1067
1068 int WarmCallInfo::count_all() const {
1069 int cnt = 0;
1070 for (const WarmCallInfo* p = this; p != NULL; p = p->next())
1071 cnt++;
1072 return cnt;
1073 }
1074
1075 #endif //PRODUCT