Mon, 02 May 2011 00:55:09 -0700
6552561: MaxRecursiveInlineLevel flag doesn't operate correctly
Reviewed-by: kvn, never
1 /*
2 * Copyright (c) 1998, 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 */
25 #include "precompiled.hpp"
26 #include "classfile/systemDictionary.hpp"
27 #include "classfile/vmSymbols.hpp"
28 #include "compiler/compileBroker.hpp"
29 #include "compiler/compileLog.hpp"
30 #include "interpreter/linkResolver.hpp"
31 #include "oops/objArrayKlass.hpp"
32 #include "opto/callGenerator.hpp"
33 #include "opto/parse.hpp"
34 #include "runtime/handles.inline.hpp"
36 //=============================================================================
37 //------------------------------InlineTree-------------------------------------
38 InlineTree::InlineTree( Compile* c,
39 const InlineTree *caller_tree, ciMethod* callee,
40 JVMState* caller_jvms, int caller_bci,
41 float site_invoke_ratio, int site_depth_adjust)
42 : C(c), _caller_jvms(caller_jvms),
43 _caller_tree((InlineTree*)caller_tree),
44 _method(callee), _site_invoke_ratio(site_invoke_ratio),
45 _site_depth_adjust(site_depth_adjust),
46 _count_inline_bcs(method()->code_size())
47 {
48 NOT_PRODUCT(_count_inlines = 0;)
49 if (_caller_jvms != NULL) {
50 // Keep a private copy of the caller_jvms:
51 _caller_jvms = new (C) JVMState(caller_jvms->method(), caller_tree->caller_jvms());
52 _caller_jvms->set_bci(caller_jvms->bci());
53 assert(!caller_jvms->should_reexecute(), "there should be no reexecute bytecode with inlining");
54 }
55 assert(_caller_jvms->same_calls_as(caller_jvms), "consistent JVMS");
56 assert((caller_tree == NULL ? 0 : caller_tree->stack_depth() + 1) == stack_depth(), "correct (redundant) depth parameter");
57 assert(caller_bci == this->caller_bci(), "correct (redundant) bci parameter");
58 if (UseOldInlining) {
59 // Update hierarchical counts, count_inline_bcs() and count_inlines()
60 InlineTree *caller = (InlineTree *)caller_tree;
61 for( ; caller != NULL; caller = ((InlineTree *)(caller->caller_tree())) ) {
62 caller->_count_inline_bcs += count_inline_bcs();
63 NOT_PRODUCT(caller->_count_inlines++;)
64 }
65 }
66 }
68 InlineTree::InlineTree(Compile* c, ciMethod* callee_method, JVMState* caller_jvms,
69 float site_invoke_ratio, int site_depth_adjust)
70 : C(c), _caller_jvms(caller_jvms), _caller_tree(NULL),
71 _method(callee_method), _site_invoke_ratio(site_invoke_ratio),
72 _site_depth_adjust(site_depth_adjust),
73 _count_inline_bcs(method()->code_size())
74 {
75 NOT_PRODUCT(_count_inlines = 0;)
76 assert(!UseOldInlining, "do not use for old stuff");
77 }
79 static bool is_init_with_ea(ciMethod* callee_method,
80 ciMethod* caller_method, Compile* C) {
81 // True when EA is ON and a java constructor is called or
82 // a super constructor is called from an inlined java constructor.
83 return C->do_escape_analysis() && EliminateAllocations &&
84 ( callee_method->is_initializer() ||
85 (caller_method->is_initializer() &&
86 caller_method != C->method() &&
87 caller_method->holder()->is_subclass_of(callee_method->holder()))
88 );
89 }
91 // positive filter: should send be inlined? returns NULL, if yes, or rejection msg
92 const char* InlineTree::shouldInline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) const {
93 // Allows targeted inlining
94 if(callee_method->should_inline()) {
95 *wci_result = *(WarmCallInfo::always_hot());
96 if (PrintInlining && Verbose) {
97 CompileTask::print_inline_indent(inline_depth());
98 tty->print_cr("Inlined method is hot: ");
99 }
100 return NULL;
101 }
103 // positive filter: should send be inlined? returns NULL (--> yes)
104 // or rejection msg
105 int max_size = C->max_inline_size();
106 int size = callee_method->code_size();
108 // Check for too many throws (and not too huge)
109 if(callee_method->interpreter_throwout_count() > InlineThrowCount &&
110 size < InlineThrowMaxSize ) {
111 wci_result->set_profit(wci_result->profit() * 100);
112 if (PrintInlining && Verbose) {
113 CompileTask::print_inline_indent(inline_depth());
114 tty->print_cr("Inlined method with many throws (throws=%d):", callee_method->interpreter_throwout_count());
115 }
116 return NULL;
117 }
119 if (!UseOldInlining) {
120 return NULL; // size and frequency are represented in a new way
121 }
123 int call_site_count = method()->scale_count(profile.count());
124 int invoke_count = method()->interpreter_invocation_count();
125 assert( invoke_count != 0, "Require invokation count greater than zero");
126 int freq = call_site_count/invoke_count;
128 // bump the max size if the call is frequent
129 if ((freq >= InlineFrequencyRatio) ||
130 (call_site_count >= InlineFrequencyCount) ||
131 is_init_with_ea(callee_method, caller_method, C)) {
133 max_size = C->freq_inline_size();
134 if (size <= max_size && TraceFrequencyInlining) {
135 CompileTask::print_inline_indent(inline_depth());
136 tty->print_cr("Inlined frequent method (freq=%d count=%d):", freq, call_site_count);
137 CompileTask::print_inline_indent(inline_depth());
138 callee_method->print();
139 tty->cr();
140 }
141 } else {
142 // Not hot. Check for medium-sized pre-existing nmethod at cold sites.
143 if (callee_method->has_compiled_code() &&
144 callee_method->instructions_size(CompLevel_full_optimization) > InlineSmallCode/4)
145 return "already compiled into a medium method";
146 }
147 if (size > max_size) {
148 if (max_size > C->max_inline_size())
149 return "hot method too big";
150 return "too big";
151 }
152 return NULL;
153 }
156 // negative filter: should send NOT be inlined? returns NULL, ok to inline, or rejection msg
157 const char* InlineTree::shouldNotInline(ciMethod *callee_method, ciMethod* caller_method, WarmCallInfo* wci_result) const {
158 // negative filter: should send NOT be inlined? returns NULL (--> inline) or rejection msg
159 if (!UseOldInlining) {
160 const char* fail = NULL;
161 if (callee_method->is_abstract()) fail = "abstract method";
162 // note: we allow ik->is_abstract()
163 if (!callee_method->holder()->is_initialized()) fail = "method holder not initialized";
164 if (callee_method->is_native()) fail = "native method";
166 if (fail) {
167 *wci_result = *(WarmCallInfo::always_cold());
168 return fail;
169 }
171 if (callee_method->has_unloaded_classes_in_signature()) {
172 wci_result->set_profit(wci_result->profit() * 0.1);
173 }
175 // don't inline exception code unless the top method belongs to an
176 // exception class
177 if (callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
178 ciMethod* top_method = caller_jvms() ? caller_jvms()->of_depth(1)->method() : method();
179 if (!top_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
180 wci_result->set_profit(wci_result->profit() * 0.1);
181 }
182 }
184 if (callee_method->has_compiled_code() && callee_method->instructions_size(CompLevel_full_optimization) > InlineSmallCode) {
185 wci_result->set_profit(wci_result->profit() * 0.1);
186 // %%% adjust wci_result->size()?
187 }
189 return NULL;
190 }
192 // Always inline MethodHandle methods and generated MethodHandle adapters.
193 if (callee_method->is_method_handle_invoke() || callee_method->is_method_handle_adapter())
194 return NULL;
196 // First check all inlining restrictions which are required for correctness
197 if (callee_method->is_abstract()) return "abstract method";
198 // note: we allow ik->is_abstract()
199 if (!callee_method->holder()->is_initialized()) return "method holder not initialized";
200 if (callee_method->is_native()) return "native method";
201 if (callee_method->has_unloaded_classes_in_signature()) return "unloaded signature classes";
203 if (callee_method->should_inline()) {
204 // ignore heuristic controls on inlining
205 return NULL;
206 }
208 // Now perform checks which are heuristic
210 if( callee_method->has_compiled_code() && callee_method->instructions_size(CompLevel_full_optimization) > InlineSmallCode )
211 return "already compiled into a big method";
213 // don't inline exception code unless the top method belongs to an
214 // exception class
215 if (caller_tree() != NULL &&
216 callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
217 const InlineTree *top = this;
218 while (top->caller_tree() != NULL) top = top->caller_tree();
219 ciInstanceKlass* k = top->method()->holder();
220 if (!k->is_subclass_of(C->env()->Throwable_klass()))
221 return "exception method";
222 }
224 // use frequency-based objections only for non-trivial methods
225 if (callee_method->code_size() <= MaxTrivialSize) return NULL;
227 // don't use counts with -Xcomp or CTW
228 if (UseInterpreter && !CompileTheWorld) {
230 if (!callee_method->has_compiled_code() &&
231 !callee_method->was_executed_more_than(0)) {
232 return "never executed";
233 }
235 if (is_init_with_ea(callee_method, caller_method, C)) {
237 // Escape Analysis: inline all executed constructors
239 } else if (!callee_method->was_executed_more_than(MIN2(MinInliningThreshold,
240 CompileThreshold >> 1))) {
241 return "executed < MinInliningThreshold times";
242 }
243 }
245 if (callee_method->should_not_inline()) {
246 return "disallowed by CompilerOracle";
247 }
249 if (UseStringCache) {
250 // Do not inline StringCache::profile() method used only at the beginning.
251 if (callee_method->name() == ciSymbol::profile_name() &&
252 callee_method->holder()->name() == ciSymbol::java_lang_StringCache()) {
253 return "profiling method";
254 }
255 }
257 return NULL;
258 }
260 //-----------------------------try_to_inline-----------------------------------
261 // return NULL if ok, reason for not inlining otherwise
262 // Relocated from "InliningClosure::try_to_inline"
263 const char* InlineTree::try_to_inline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) {
265 // Old algorithm had funny accumulating BC-size counters
266 if (UseOldInlining && ClipInlining
267 && (int)count_inline_bcs() >= DesiredMethodLimit) {
268 return "size > DesiredMethodLimit";
269 }
271 const char *msg = NULL;
272 if ((msg = shouldInline(callee_method, caller_method, caller_bci,
273 profile, wci_result)) != NULL) {
274 return msg;
275 }
276 if ((msg = shouldNotInline(callee_method, caller_method,
277 wci_result)) != NULL) {
278 return msg;
279 }
281 if (InlineAccessors && callee_method->is_accessor()) {
282 // accessor methods are not subject to any of the following limits.
283 return NULL;
284 }
286 // suppress a few checks for accessors and trivial methods
287 if (callee_method->code_size() > MaxTrivialSize) {
289 // don't inline into giant methods
290 if (C->unique() > (uint)NodeCountInliningCutoff) {
291 return "NodeCountInliningCutoff";
292 }
294 if ((!UseInterpreter || CompileTheWorld) &&
295 is_init_with_ea(callee_method, caller_method, C)) {
297 // Escape Analysis stress testing when running Xcomp or CTW:
298 // inline constructors even if they are not reached.
300 } else if (profile.count() == 0) {
301 // don't inline unreached call sites
302 return "call site not reached";
303 }
304 }
306 if (!C->do_inlining() && InlineAccessors) {
307 return "not an accessor";
308 }
309 if( inline_depth() > MaxInlineLevel ) {
310 return "inlining too deep";
311 }
313 // detect direct and indirect recursive inlining
314 {
315 // count the current method and the callee
316 int inline_level = (method() == callee_method) ? 1 : 0;
317 if (inline_level > MaxRecursiveInlineLevel)
318 return "recursively inlining too deep";
319 // count callers of current method and callee
320 JVMState* jvms = caller_jvms();
321 while (jvms != NULL && jvms->has_method()) {
322 if (jvms->method() == callee_method) {
323 inline_level++;
324 if (inline_level > MaxRecursiveInlineLevel)
325 return "recursively inlining too deep";
326 }
327 jvms = jvms->caller();
328 }
329 }
331 int size = callee_method->code_size();
333 if (UseOldInlining && ClipInlining
334 && (int)count_inline_bcs() + size >= DesiredMethodLimit) {
335 return "size > DesiredMethodLimit";
336 }
338 // ok, inline this method
339 return NULL;
340 }
342 //------------------------------pass_initial_checks----------------------------
343 bool pass_initial_checks(ciMethod* caller_method, int caller_bci, ciMethod* callee_method) {
344 ciInstanceKlass *callee_holder = callee_method ? callee_method->holder() : NULL;
345 // Check if a callee_method was suggested
346 if( callee_method == NULL ) return false;
347 // Check if klass of callee_method is loaded
348 if( !callee_holder->is_loaded() ) return false;
349 if( !callee_holder->is_initialized() ) return false;
350 if( !UseInterpreter || CompileTheWorld /* running Xcomp or CTW */ ) {
351 // Checks that constant pool's call site has been visited
352 // stricter than callee_holder->is_initialized()
353 ciBytecodeStream iter(caller_method);
354 iter.force_bci(caller_bci);
355 Bytecodes::Code call_bc = iter.cur_bc();
356 // An invokedynamic instruction does not have a klass.
357 if (call_bc != Bytecodes::_invokedynamic) {
358 int index = iter.get_index_u2_cpcache();
359 if (!caller_method->is_klass_loaded(index, true)) {
360 return false;
361 }
362 // Try to do constant pool resolution if running Xcomp
363 if( !caller_method->check_call(index, call_bc == Bytecodes::_invokestatic) ) {
364 return false;
365 }
366 }
367 }
368 // We will attempt to see if a class/field/etc got properly loaded. If it
369 // did not, it may attempt to throw an exception during our probing. Catch
370 // and ignore such exceptions and do not attempt to compile the method.
371 if( callee_method->should_exclude() ) return false;
373 return true;
374 }
376 #ifndef PRODUCT
377 //------------------------------print_inlining---------------------------------
378 // Really, the failure_msg can be a success message also.
379 void InlineTree::print_inlining(ciMethod* callee_method, int caller_bci, const char* failure_msg) const {
380 CompileTask::print_inlining(callee_method, inline_depth(), caller_bci, failure_msg ? failure_msg : "inline");
381 if (callee_method == NULL) tty->print(" callee not monotonic or profiled");
382 if (Verbose && callee_method) {
383 const InlineTree *top = this;
384 while( top->caller_tree() != NULL ) { top = top->caller_tree(); }
385 tty->print(" bcs: %d+%d invoked: %d", top->count_inline_bcs(), callee_method->code_size(), callee_method->interpreter_invocation_count());
386 }
387 }
388 #endif
390 //------------------------------ok_to_inline-----------------------------------
391 WarmCallInfo* InlineTree::ok_to_inline(ciMethod* callee_method, JVMState* jvms, ciCallProfile& profile, WarmCallInfo* initial_wci) {
392 assert(callee_method != NULL, "caller checks for optimized virtual!");
393 #ifdef ASSERT
394 // Make sure the incoming jvms has the same information content as me.
395 // This means that we can eventually make this whole class AllStatic.
396 if (jvms->caller() == NULL) {
397 assert(_caller_jvms == NULL, "redundant instance state");
398 } else {
399 assert(_caller_jvms->same_calls_as(jvms->caller()), "redundant instance state");
400 }
401 assert(_method == jvms->method(), "redundant instance state");
402 #endif
403 const char *failure_msg = NULL;
404 int caller_bci = jvms->bci();
405 ciMethod *caller_method = jvms->method();
407 if( !pass_initial_checks(caller_method, caller_bci, callee_method)) {
408 if( PrintInlining ) {
409 failure_msg = "failed_initial_checks";
410 print_inlining( callee_method, caller_bci, failure_msg);
411 }
412 return NULL;
413 }
415 // Check if inlining policy says no.
416 WarmCallInfo wci = *(initial_wci);
417 failure_msg = try_to_inline(callee_method, caller_method, caller_bci, profile, &wci);
418 if (failure_msg != NULL && C->log() != NULL) {
419 C->log()->begin_elem("inline_fail reason='");
420 C->log()->text("%s", failure_msg);
421 C->log()->end_elem("'");
422 }
424 #ifndef PRODUCT
425 if (UseOldInlining && InlineWarmCalls
426 && (PrintOpto || PrintOptoInlining || PrintInlining)) {
427 bool cold = wci.is_cold();
428 bool hot = !cold && wci.is_hot();
429 bool old_cold = (failure_msg != NULL);
430 if (old_cold != cold || (Verbose || WizardMode)) {
431 tty->print(" OldInlining= %4s : %s\n WCI=",
432 old_cold ? "cold" : "hot", failure_msg ? failure_msg : "OK");
433 wci.print();
434 }
435 }
436 #endif
437 if (UseOldInlining) {
438 if (failure_msg == NULL)
439 wci = *(WarmCallInfo::always_hot());
440 else
441 wci = *(WarmCallInfo::always_cold());
442 }
443 if (!InlineWarmCalls) {
444 if (!wci.is_cold() && !wci.is_hot()) {
445 // Do not inline the warm calls.
446 wci = *(WarmCallInfo::always_cold());
447 }
448 }
450 if (!wci.is_cold()) {
451 // In -UseOldInlining, the failure_msg may also be a success message.
452 if (failure_msg == NULL) failure_msg = "inline (hot)";
454 // Inline!
455 if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg);
456 if (UseOldInlining)
457 build_inline_tree_for_callee(callee_method, jvms, caller_bci);
458 if (InlineWarmCalls && !wci.is_hot())
459 return new (C) WarmCallInfo(wci); // copy to heap
460 return WarmCallInfo::always_hot();
461 }
463 // Do not inline
464 if (failure_msg == NULL) failure_msg = "too cold to inline";
465 if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg);
466 return NULL;
467 }
469 //------------------------------compute_callee_frequency-----------------------
470 float InlineTree::compute_callee_frequency( int caller_bci ) const {
471 int count = method()->interpreter_call_site_count(caller_bci);
472 int invcnt = method()->interpreter_invocation_count();
473 float freq = (float)count/(float)invcnt;
474 // Call-site count / interpreter invocation count, scaled recursively.
475 // Always between 0.0 and 1.0. Represents the percentage of the method's
476 // total execution time used at this call site.
478 return freq;
479 }
481 //------------------------------build_inline_tree_for_callee-------------------
482 InlineTree *InlineTree::build_inline_tree_for_callee( ciMethod* callee_method, JVMState* caller_jvms, int caller_bci) {
483 float recur_frequency = _site_invoke_ratio * compute_callee_frequency(caller_bci);
484 // Attempt inlining.
485 InlineTree* old_ilt = callee_at(caller_bci, callee_method);
486 if (old_ilt != NULL) {
487 return old_ilt;
488 }
489 int new_depth_adjust = 0;
490 if (caller_jvms->method() != NULL) {
491 if (caller_jvms->method()->is_method_handle_adapter())
492 new_depth_adjust -= 1; // don't count actions in MH or indy adapter frames
493 else if (callee_method->is_method_handle_invoke()) {
494 new_depth_adjust -= 1; // don't count method handle calls from java.lang.invoke implem
495 }
496 if (new_depth_adjust != 0 && PrintInlining) {
497 stringStream nm1; caller_jvms->method()->print_name(&nm1);
498 stringStream nm2; callee_method->print_name(&nm2);
499 tty->print_cr("discounting inlining depth from %s to %s", nm1.base(), nm2.base());
500 }
501 if (new_depth_adjust != 0 && C->log()) {
502 int id1 = C->log()->identify(caller_jvms->method());
503 int id2 = C->log()->identify(callee_method);
504 C->log()->elem("inline_depth_discount caller='%d' callee='%d'", id1, id2);
505 }
506 }
507 InlineTree *ilt = new InlineTree(C, this, callee_method, caller_jvms, caller_bci, recur_frequency, _site_depth_adjust + new_depth_adjust);
508 _subtrees.append( ilt );
510 NOT_PRODUCT( _count_inlines += 1; )
512 return ilt;
513 }
516 //---------------------------------------callee_at-----------------------------
517 InlineTree *InlineTree::callee_at(int bci, ciMethod* callee) const {
518 for (int i = 0; i < _subtrees.length(); i++) {
519 InlineTree* sub = _subtrees.at(i);
520 if (sub->caller_bci() == bci && callee == sub->method()) {
521 return sub;
522 }
523 }
524 return NULL;
525 }
528 //------------------------------build_inline_tree_root-------------------------
529 InlineTree *InlineTree::build_inline_tree_root() {
530 Compile* C = Compile::current();
532 // Root of inline tree
533 InlineTree *ilt = new InlineTree(C, NULL, C->method(), NULL, -1, 1.0F, 0);
535 return ilt;
536 }
539 //-------------------------find_subtree_from_root-----------------------------
540 // Given a jvms, which determines a call chain from the root method,
541 // find the corresponding inline tree.
542 // Note: This method will be removed or replaced as InlineTree goes away.
543 InlineTree* InlineTree::find_subtree_from_root(InlineTree* root, JVMState* jvms, ciMethod* callee, bool create_if_not_found) {
544 InlineTree* iltp = root;
545 uint depth = jvms && jvms->has_method() ? jvms->depth() : 0;
546 for (uint d = 1; d <= depth; d++) {
547 JVMState* jvmsp = jvms->of_depth(d);
548 // Select the corresponding subtree for this bci.
549 assert(jvmsp->method() == iltp->method(), "tree still in sync");
550 ciMethod* d_callee = (d == depth) ? callee : jvms->of_depth(d+1)->method();
551 InlineTree* sub = iltp->callee_at(jvmsp->bci(), d_callee);
552 if (!sub) {
553 if (create_if_not_found && d == depth) {
554 return iltp->build_inline_tree_for_callee(d_callee, jvmsp, jvmsp->bci());
555 }
556 assert(sub != NULL, "should be a sub-ilt here");
557 return NULL;
558 }
559 iltp = sub;
560 }
561 return iltp;
562 }