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 */
24
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"
35
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 }
67
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 }
78
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 }
90
91 // positive filter: should send be inlined? returns NULL, if yes, or rejection msg
92 const char* InlineTree::should_inline(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 }
102
103 // positive filter: should send be inlined? returns NULL (--> yes)
104 // or rejection msg
105 int size = callee_method->code_size();
106
107 // Check for too many throws (and not too huge)
108 if(callee_method->interpreter_throwout_count() > InlineThrowCount &&
109 size < InlineThrowMaxSize ) {
110 wci_result->set_profit(wci_result->profit() * 100);
111 if (PrintInlining && Verbose) {
112 CompileTask::print_inline_indent(inline_depth());
113 tty->print_cr("Inlined method with many throws (throws=%d):", callee_method->interpreter_throwout_count());
114 }
115 return NULL;
116 }
117
118 if (!UseOldInlining) {
119 return NULL; // size and frequency are represented in a new way
120 }
121
122 int default_max_inline_size = C->max_inline_size();
123 int inline_small_code_size = InlineSmallCode / 4;
124 int max_inline_size = default_max_inline_size;
125
126 int call_site_count = method()->scale_count(profile.count());
127 int invoke_count = method()->interpreter_invocation_count();
128
129 // Bytecoded method handle adapters do not have interpreter
130 // profiling data but only made up MDO data. Get the counter from
131 // there.
132 if (caller_method->is_method_handle_adapter()) {
133 assert(method()->method_data_or_null(), "must have an MDO");
134 ciMethodData* mdo = method()->method_data();
135 ciProfileData* mha_profile = mdo->bci_to_data(caller_bci);
136 assert(mha_profile, "must exist");
137 CounterData* cd = mha_profile->as_CounterData();
138 invoke_count = cd->count();
139 call_site_count = invoke_count; // use the same value
140 }
141
142 assert(invoke_count != 0, "require invocation count greater than zero");
143 int freq = call_site_count / invoke_count;
144
145 // bump the max size if the call is frequent
146 if ((freq >= InlineFrequencyRatio) ||
147 (call_site_count >= InlineFrequencyCount) ||
148 is_init_with_ea(callee_method, caller_method, C)) {
149
150 max_inline_size = C->freq_inline_size();
151 if (size <= max_inline_size && TraceFrequencyInlining) {
152 CompileTask::print_inline_indent(inline_depth());
153 tty->print_cr("Inlined frequent method (freq=%d count=%d):", freq, call_site_count);
154 CompileTask::print_inline_indent(inline_depth());
155 callee_method->print();
156 tty->cr();
157 }
158 } else {
159 // Not hot. Check for medium-sized pre-existing nmethod at cold sites.
160 if (callee_method->has_compiled_code() &&
161 callee_method->instructions_size(CompLevel_full_optimization) > inline_small_code_size)
162 return "already compiled into a medium method";
163 }
164 if (size > max_inline_size) {
165 if (max_inline_size > default_max_inline_size)
166 return "hot method too big";
167 return "too big";
168 }
169 return NULL;
170 }
171
172
173 // negative filter: should send NOT be inlined? returns NULL, ok to inline, or rejection msg
174 const char* InlineTree::should_not_inline(ciMethod *callee_method, ciMethod* caller_method, WarmCallInfo* wci_result) const {
175 // negative filter: should send NOT be inlined? returns NULL (--> inline) or rejection msg
176 if (!UseOldInlining) {
177 const char* fail = NULL;
178 if (callee_method->is_abstract()) fail = "abstract method";
179 // note: we allow ik->is_abstract()
180 if (!callee_method->holder()->is_initialized()) fail = "method holder not initialized";
181 if (callee_method->is_native()) fail = "native method";
182
183 if (fail) {
184 *wci_result = *(WarmCallInfo::always_cold());
185 return fail;
186 }
187
188 if (callee_method->has_unloaded_classes_in_signature()) {
189 wci_result->set_profit(wci_result->profit() * 0.1);
190 }
191
192 // don't inline exception code unless the top method belongs to an
193 // exception class
194 if (callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
195 ciMethod* top_method = caller_jvms() ? caller_jvms()->of_depth(1)->method() : method();
196 if (!top_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
197 wci_result->set_profit(wci_result->profit() * 0.1);
198 }
199 }
200
201 if (callee_method->has_compiled_code() && callee_method->instructions_size(CompLevel_full_optimization) > InlineSmallCode) {
202 wci_result->set_profit(wci_result->profit() * 0.1);
203 // %%% adjust wci_result->size()?
204 }
205
206 return NULL;
207 }
208
209 // Always inline MethodHandle methods and generated MethodHandle adapters.
210 if (callee_method->is_method_handle_invoke() || callee_method->is_method_handle_adapter())
211 return NULL;
212
213 // First check all inlining restrictions which are required for correctness
214 if (callee_method->is_abstract()) return "abstract method";
215 // note: we allow ik->is_abstract()
216 if (!callee_method->holder()->is_initialized()) return "method holder not initialized";
217 if (callee_method->is_native()) return "native method";
218 if (callee_method->has_unloaded_classes_in_signature()) return "unloaded signature classes";
219
220 if (callee_method->should_inline()) {
221 // ignore heuristic controls on inlining
222 return NULL;
223 }
224
225 // Now perform checks which are heuristic
226
227 if( callee_method->has_compiled_code() && callee_method->instructions_size(CompLevel_full_optimization) > InlineSmallCode )
228 return "already compiled into a big method";
229
230 // don't inline exception code unless the top method belongs to an
231 // exception class
232 if (caller_tree() != NULL &&
233 callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) {
234 const InlineTree *top = this;
235 while (top->caller_tree() != NULL) top = top->caller_tree();
236 ciInstanceKlass* k = top->method()->holder();
237 if (!k->is_subclass_of(C->env()->Throwable_klass()))
238 return "exception method";
239 }
240
241 // use frequency-based objections only for non-trivial methods
242 if (callee_method->code_size() <= MaxTrivialSize) return NULL;
243
244 // don't use counts with -Xcomp or CTW
245 if (UseInterpreter && !CompileTheWorld) {
246
247 if (!callee_method->has_compiled_code() &&
248 !callee_method->was_executed_more_than(0)) {
249 return "never executed";
250 }
251
252 if (is_init_with_ea(callee_method, caller_method, C)) {
253
254 // Escape Analysis: inline all executed constructors
255
256 } else if (!callee_method->was_executed_more_than(MIN2(MinInliningThreshold,
257 CompileThreshold >> 1))) {
258 return "executed < MinInliningThreshold times";
259 }
260 }
261
262 if (callee_method->should_not_inline()) {
263 return "disallowed by CompilerOracle";
264 }
265
266 if (UseStringCache) {
267 // Do not inline StringCache::profile() method used only at the beginning.
268 if (callee_method->name() == ciSymbol::profile_name() &&
269 callee_method->holder()->name() == ciSymbol::java_lang_StringCache()) {
270 return "profiling method";
271 }
272 }
273
274 return NULL;
275 }
276
277 //-----------------------------try_to_inline-----------------------------------
278 // return NULL if ok, reason for not inlining otherwise
279 // Relocated from "InliningClosure::try_to_inline"
280 const char* InlineTree::try_to_inline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) {
281
282 // Old algorithm had funny accumulating BC-size counters
283 if (UseOldInlining && ClipInlining
284 && (int)count_inline_bcs() >= DesiredMethodLimit) {
285 return "size > DesiredMethodLimit";
286 }
287
288 const char *msg = NULL;
289 msg = should_inline(callee_method, caller_method, caller_bci, profile, wci_result);
290 if (msg != NULL)
291 return msg;
292
293 msg = should_not_inline(callee_method, caller_method, wci_result);
294 if (msg != NULL)
295 return msg;
296
297 if (InlineAccessors && callee_method->is_accessor()) {
298 // accessor methods are not subject to any of the following limits.
299 return NULL;
300 }
301
302 // suppress a few checks for accessors and trivial methods
303 if (callee_method->code_size() > MaxTrivialSize) {
304
305 // don't inline into giant methods
306 if (C->unique() > (uint)NodeCountInliningCutoff) {
307 return "NodeCountInliningCutoff";
308 }
309
310 if ((!UseInterpreter || CompileTheWorld) &&
311 is_init_with_ea(callee_method, caller_method, C)) {
312
313 // Escape Analysis stress testing when running Xcomp or CTW:
314 // inline constructors even if they are not reached.
315
316 } else if (profile.count() == 0) {
317 // don't inline unreached call sites
318 return "call site not reached";
319 }
320 }
321
322 if (!C->do_inlining() && InlineAccessors) {
323 return "not an accessor";
324 }
325 if( inline_depth() > MaxInlineLevel ) {
326 return "inlining too deep";
327 }
328
329 // detect direct and indirect recursive inlining
330 {
331 // count the current method and the callee
332 int inline_level = (method() == callee_method) ? 1 : 0;
333 if (inline_level > MaxRecursiveInlineLevel)
334 return "recursively inlining too deep";
335 // count callers of current method and callee
336 JVMState* jvms = caller_jvms();
337 while (jvms != NULL && jvms->has_method()) {
338 if (jvms->method() == callee_method) {
339 inline_level++;
340 if (inline_level > MaxRecursiveInlineLevel)
341 return "recursively inlining too deep";
342 }
343 jvms = jvms->caller();
344 }
345 }
346
347 int size = callee_method->code_size();
348
349 if (UseOldInlining && ClipInlining
350 && (int)count_inline_bcs() + size >= DesiredMethodLimit) {
351 return "size > DesiredMethodLimit";
352 }
353
354 // ok, inline this method
355 return NULL;
356 }
357
358 //------------------------------pass_initial_checks----------------------------
359 bool pass_initial_checks(ciMethod* caller_method, int caller_bci, ciMethod* callee_method) {
360 ciInstanceKlass *callee_holder = callee_method ? callee_method->holder() : NULL;
361 // Check if a callee_method was suggested
362 if( callee_method == NULL ) return false;
363 // Check if klass of callee_method is loaded
364 if( !callee_holder->is_loaded() ) return false;
365 if( !callee_holder->is_initialized() ) return false;
366 if( !UseInterpreter || CompileTheWorld /* running Xcomp or CTW */ ) {
367 // Checks that constant pool's call site has been visited
368 // stricter than callee_holder->is_initialized()
369 ciBytecodeStream iter(caller_method);
370 iter.force_bci(caller_bci);
371 Bytecodes::Code call_bc = iter.cur_bc();
372 // An invokedynamic instruction does not have a klass.
373 if (call_bc != Bytecodes::_invokedynamic) {
374 int index = iter.get_index_u2_cpcache();
375 if (!caller_method->is_klass_loaded(index, true)) {
376 return false;
377 }
378 // Try to do constant pool resolution if running Xcomp
379 if( !caller_method->check_call(index, call_bc == Bytecodes::_invokestatic) ) {
380 return false;
381 }
382 }
383 }
384 // We will attempt to see if a class/field/etc got properly loaded. If it
385 // did not, it may attempt to throw an exception during our probing. Catch
386 // and ignore such exceptions and do not attempt to compile the method.
387 if( callee_method->should_exclude() ) return false;
388
389 return true;
390 }
391
392 //------------------------------print_inlining---------------------------------
393 // Really, the failure_msg can be a success message also.
394 void InlineTree::print_inlining(ciMethod* callee_method, int caller_bci, const char* failure_msg) const {
395 CompileTask::print_inlining(callee_method, inline_depth(), caller_bci, failure_msg ? failure_msg : "inline");
396 if (callee_method == NULL) tty->print(" callee not monotonic or profiled");
397 if (Verbose && callee_method) {
398 const InlineTree *top = this;
399 while( top->caller_tree() != NULL ) { top = top->caller_tree(); }
400 tty->print(" bcs: %d+%d invoked: %d", top->count_inline_bcs(), callee_method->code_size(), callee_method->interpreter_invocation_count());
401 }
402 }
403
404 //------------------------------ok_to_inline-----------------------------------
405 WarmCallInfo* InlineTree::ok_to_inline(ciMethod* callee_method, JVMState* jvms, ciCallProfile& profile, WarmCallInfo* initial_wci) {
406 assert(callee_method != NULL, "caller checks for optimized virtual!");
407 #ifdef ASSERT
408 // Make sure the incoming jvms has the same information content as me.
409 // This means that we can eventually make this whole class AllStatic.
410 if (jvms->caller() == NULL) {
411 assert(_caller_jvms == NULL, "redundant instance state");
412 } else {
413 assert(_caller_jvms->same_calls_as(jvms->caller()), "redundant instance state");
414 }
415 assert(_method == jvms->method(), "redundant instance state");
416 #endif
417 const char *failure_msg = NULL;
418 int caller_bci = jvms->bci();
419 ciMethod *caller_method = jvms->method();
420
421 if( !pass_initial_checks(caller_method, caller_bci, callee_method)) {
422 if( PrintInlining ) {
423 failure_msg = "failed_initial_checks";
424 print_inlining( callee_method, caller_bci, failure_msg);
425 }
426 return NULL;
427 }
428
429 // Check if inlining policy says no.
430 WarmCallInfo wci = *(initial_wci);
431 failure_msg = try_to_inline(callee_method, caller_method, caller_bci, profile, &wci);
432 if (failure_msg != NULL && C->log() != NULL) {
433 C->log()->begin_elem("inline_fail reason='");
434 C->log()->text("%s", failure_msg);
435 C->log()->end_elem("'");
436 }
437
438 #ifndef PRODUCT
439 if (UseOldInlining && InlineWarmCalls
440 && (PrintOpto || PrintOptoInlining || PrintInlining)) {
441 bool cold = wci.is_cold();
442 bool hot = !cold && wci.is_hot();
443 bool old_cold = (failure_msg != NULL);
444 if (old_cold != cold || (Verbose || WizardMode)) {
445 tty->print(" OldInlining= %4s : %s\n WCI=",
446 old_cold ? "cold" : "hot", failure_msg ? failure_msg : "OK");
447 wci.print();
448 }
449 }
450 #endif
451 if (UseOldInlining) {
452 if (failure_msg == NULL)
453 wci = *(WarmCallInfo::always_hot());
454 else
455 wci = *(WarmCallInfo::always_cold());
456 }
457 if (!InlineWarmCalls) {
458 if (!wci.is_cold() && !wci.is_hot()) {
459 // Do not inline the warm calls.
460 wci = *(WarmCallInfo::always_cold());
461 }
462 }
463
464 if (!wci.is_cold()) {
465 // In -UseOldInlining, the failure_msg may also be a success message.
466 if (failure_msg == NULL) failure_msg = "inline (hot)";
467
468 // Inline!
469 if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg);
470 if (UseOldInlining)
471 build_inline_tree_for_callee(callee_method, jvms, caller_bci);
472 if (InlineWarmCalls && !wci.is_hot())
473 return new (C) WarmCallInfo(wci); // copy to heap
474 return WarmCallInfo::always_hot();
475 }
476
477 // Do not inline
478 if (failure_msg == NULL) failure_msg = "too cold to inline";
479 if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg);
480 return NULL;
481 }
482
483 //------------------------------compute_callee_frequency-----------------------
484 float InlineTree::compute_callee_frequency( int caller_bci ) const {
485 int count = method()->interpreter_call_site_count(caller_bci);
486 int invcnt = method()->interpreter_invocation_count();
487 float freq = (float)count/(float)invcnt;
488 // Call-site count / interpreter invocation count, scaled recursively.
489 // Always between 0.0 and 1.0. Represents the percentage of the method's
490 // total execution time used at this call site.
491
492 return freq;
493 }
494
495 //------------------------------build_inline_tree_for_callee-------------------
496 InlineTree *InlineTree::build_inline_tree_for_callee( ciMethod* callee_method, JVMState* caller_jvms, int caller_bci) {
497 float recur_frequency = _site_invoke_ratio * compute_callee_frequency(caller_bci);
498 // Attempt inlining.
499 InlineTree* old_ilt = callee_at(caller_bci, callee_method);
500 if (old_ilt != NULL) {
501 return old_ilt;
502 }
503 int new_depth_adjust = 0;
504 if (caller_jvms->method() != NULL) {
505 if (caller_jvms->method()->is_method_handle_adapter())
506 new_depth_adjust -= 1; // don't count actions in MH or indy adapter frames
507 else if (callee_method->is_method_handle_invoke()) {
508 new_depth_adjust -= 1; // don't count method handle calls from java.lang.invoke implem
509 }
510 if (new_depth_adjust != 0 && PrintInlining) {
511 CompileTask::print_inline_indent(inline_depth());
512 tty->print_cr(" \\-> discounting inline depth");
513 }
514 if (new_depth_adjust != 0 && C->log()) {
515 int id1 = C->log()->identify(caller_jvms->method());
516 int id2 = C->log()->identify(callee_method);
517 C->log()->elem("inline_depth_discount caller='%d' callee='%d'", id1, id2);
518 }
519 }
520 InlineTree *ilt = new InlineTree(C, this, callee_method, caller_jvms, caller_bci, recur_frequency, _site_depth_adjust + new_depth_adjust);
521 _subtrees.append( ilt );
522
523 NOT_PRODUCT( _count_inlines += 1; )
524
525 return ilt;
526 }
527
528
529 //---------------------------------------callee_at-----------------------------
530 InlineTree *InlineTree::callee_at(int bci, ciMethod* callee) const {
531 for (int i = 0; i < _subtrees.length(); i++) {
532 InlineTree* sub = _subtrees.at(i);
533 if (sub->caller_bci() == bci && callee == sub->method()) {
534 return sub;
535 }
536 }
537 return NULL;
538 }
539
540
541 //------------------------------build_inline_tree_root-------------------------
542 InlineTree *InlineTree::build_inline_tree_root() {
543 Compile* C = Compile::current();
544
545 // Root of inline tree
546 InlineTree *ilt = new InlineTree(C, NULL, C->method(), NULL, -1, 1.0F, 0);
547
548 return ilt;
549 }
550
551
552 //-------------------------find_subtree_from_root-----------------------------
553 // Given a jvms, which determines a call chain from the root method,
554 // find the corresponding inline tree.
555 // Note: This method will be removed or replaced as InlineTree goes away.
556 InlineTree* InlineTree::find_subtree_from_root(InlineTree* root, JVMState* jvms, ciMethod* callee, bool create_if_not_found) {
557 InlineTree* iltp = root;
558 uint depth = jvms && jvms->has_method() ? jvms->depth() : 0;
559 for (uint d = 1; d <= depth; d++) {
560 JVMState* jvmsp = jvms->of_depth(d);
561 // Select the corresponding subtree for this bci.
562 assert(jvmsp->method() == iltp->method(), "tree still in sync");
563 ciMethod* d_callee = (d == depth) ? callee : jvms->of_depth(d+1)->method();
564 InlineTree* sub = iltp->callee_at(jvmsp->bci(), d_callee);
565 if (!sub) {
566 if (create_if_not_found && d == depth) {
567 return iltp->build_inline_tree_for_callee(d_callee, jvmsp, jvmsp->bci());
568 }
569 assert(sub != NULL, "should be a sub-ilt here");
570 return NULL;
571 }
572 iltp = sub;
573 }
574 return iltp;
575 }