duke@435: /* xdono@631: * Copyright 1998-2008 Sun Microsystems, Inc. All Rights Reserved. duke@435: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@435: * duke@435: * This code is free software; you can redistribute it and/or modify it duke@435: * under the terms of the GNU General Public License version 2 only, as duke@435: * published by the Free Software Foundation. duke@435: * duke@435: * This code is distributed in the hope that it will be useful, but WITHOUT duke@435: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@435: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@435: * version 2 for more details (a copy is included in the LICENSE file that duke@435: * accompanied this code). duke@435: * duke@435: * You should have received a copy of the GNU General Public License version duke@435: * 2 along with this work; if not, write to the Free Software Foundation, duke@435: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@435: * duke@435: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, duke@435: * CA 95054 USA or visit www.sun.com if you need additional information or duke@435: * have any questions. duke@435: * duke@435: */ duke@435: duke@435: #include "incls/_precompiled.incl" duke@435: #include "incls/_bytecodeInfo.cpp.incl" duke@435: duke@435: //============================================================================= duke@435: //------------------------------InlineTree------------------------------------- duke@435: InlineTree::InlineTree( Compile* c, const InlineTree *caller_tree, ciMethod* callee, JVMState* caller_jvms, int caller_bci, float site_invoke_ratio ) duke@435: : C(c), _caller_jvms(caller_jvms), duke@435: _caller_tree((InlineTree*)caller_tree), duke@435: _method(callee), _site_invoke_ratio(site_invoke_ratio), duke@435: _count_inline_bcs(method()->code_size()) { duke@435: NOT_PRODUCT(_count_inlines = 0;) duke@435: if (_caller_jvms != NULL) { duke@435: // Keep a private copy of the caller_jvms: duke@435: _caller_jvms = new (C) JVMState(caller_jvms->method(), caller_tree->caller_jvms()); duke@435: _caller_jvms->set_bci(caller_jvms->bci()); duke@435: } duke@435: assert(_caller_jvms->same_calls_as(caller_jvms), "consistent JVMS"); duke@435: assert((caller_tree == NULL ? 0 : caller_tree->inline_depth() + 1) == inline_depth(), "correct (redundant) depth parameter"); duke@435: assert(caller_bci == this->caller_bci(), "correct (redundant) bci parameter"); duke@435: if (UseOldInlining) { duke@435: // Update hierarchical counts, count_inline_bcs() and count_inlines() duke@435: InlineTree *caller = (InlineTree *)caller_tree; duke@435: for( ; caller != NULL; caller = ((InlineTree *)(caller->caller_tree())) ) { duke@435: caller->_count_inline_bcs += count_inline_bcs(); duke@435: NOT_PRODUCT(caller->_count_inlines++;) duke@435: } duke@435: } duke@435: } duke@435: duke@435: InlineTree::InlineTree(Compile* c, ciMethod* callee_method, JVMState* caller_jvms, float site_invoke_ratio) duke@435: : C(c), _caller_jvms(caller_jvms), _caller_tree(NULL), duke@435: _method(callee_method), _site_invoke_ratio(site_invoke_ratio), duke@435: _count_inline_bcs(method()->code_size()) { duke@435: NOT_PRODUCT(_count_inlines = 0;) duke@435: assert(!UseOldInlining, "do not use for old stuff"); duke@435: } duke@435: duke@435: duke@435: duke@435: static void print_indent(int depth) { duke@435: tty->print(" "); duke@435: for (int i = depth; i != 0; --i) tty->print(" "); duke@435: } duke@435: kvn@476: static bool is_init_with_ea(ciMethod* callee_method, kvn@476: ciMethod* caller_method, Compile* C) { kvn@476: // True when EA is ON and a java constructor is called or kvn@476: // a super constructor is called from an inlined java constructor. kvn@679: return C->do_escape_analysis() && EliminateAllocations && kvn@476: ( callee_method->is_initializer() || kvn@476: (caller_method->is_initializer() && kvn@476: caller_method != C->method() && kvn@476: caller_method->holder()->is_subclass_of(callee_method->holder())) kvn@476: ); kvn@476: } kvn@476: duke@435: // positive filter: should send be inlined? returns NULL, if yes, or rejection msg kvn@476: const char* InlineTree::shouldInline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) const { duke@435: // Allows targeted inlining duke@435: if(callee_method->should_inline()) { duke@435: *wci_result = *(WarmCallInfo::always_hot()); duke@435: if (PrintInlining && Verbose) { duke@435: print_indent(inline_depth()); duke@435: tty->print_cr("Inlined method is hot: "); duke@435: } duke@435: return NULL; duke@435: } duke@435: duke@435: // positive filter: should send be inlined? returns NULL (--> yes) duke@435: // or rejection msg duke@435: int max_size = C->max_inline_size(); duke@435: int size = callee_method->code_size(); duke@435: duke@435: // Check for too many throws (and not too huge) kvn@476: if(callee_method->interpreter_throwout_count() > InlineThrowCount && kvn@476: size < InlineThrowMaxSize ) { duke@435: wci_result->set_profit(wci_result->profit() * 100); duke@435: if (PrintInlining && Verbose) { duke@435: print_indent(inline_depth()); duke@435: tty->print_cr("Inlined method with many throws (throws=%d):", callee_method->interpreter_throwout_count()); duke@435: } duke@435: return NULL; duke@435: } duke@435: duke@435: if (!UseOldInlining) { duke@435: return NULL; // size and frequency are represented in a new way duke@435: } duke@435: duke@435: int call_site_count = method()->scale_count(profile.count()); duke@435: int invoke_count = method()->interpreter_invocation_count(); duke@435: assert( invoke_count != 0, "Require invokation count greater than zero"); duke@435: int freq = call_site_count/invoke_count; kvn@476: duke@435: // bump the max size if the call is frequent kvn@476: if ((freq >= InlineFrequencyRatio) || kvn@476: (call_site_count >= InlineFrequencyCount) || kvn@476: is_init_with_ea(callee_method, caller_method, C)) { kvn@476: duke@435: max_size = C->freq_inline_size(); duke@435: if (size <= max_size && TraceFrequencyInlining) { duke@435: print_indent(inline_depth()); duke@435: tty->print_cr("Inlined frequent method (freq=%d count=%d):", freq, call_site_count); duke@435: print_indent(inline_depth()); duke@435: callee_method->print(); duke@435: tty->cr(); duke@435: } duke@435: } else { duke@435: // Not hot. Check for medium-sized pre-existing nmethod at cold sites. kvn@476: if (callee_method->has_compiled_code() && kvn@476: callee_method->instructions_size() > InlineSmallCode/4) duke@435: return "already compiled into a medium method"; duke@435: } duke@435: if (size > max_size) { duke@435: if (max_size > C->max_inline_size()) duke@435: return "hot method too big"; duke@435: return "too big"; duke@435: } duke@435: return NULL; duke@435: } duke@435: duke@435: duke@435: // negative filter: should send NOT be inlined? returns NULL, ok to inline, or rejection msg kvn@476: const char* InlineTree::shouldNotInline(ciMethod *callee_method, ciMethod* caller_method, WarmCallInfo* wci_result) const { duke@435: // negative filter: should send NOT be inlined? returns NULL (--> inline) or rejection msg duke@435: if (!UseOldInlining) { duke@435: const char* fail = NULL; duke@435: if (callee_method->is_abstract()) fail = "abstract method"; duke@435: // note: we allow ik->is_abstract() duke@435: if (!callee_method->holder()->is_initialized()) fail = "method holder not initialized"; duke@435: if (callee_method->is_native()) fail = "native method"; duke@435: duke@435: if (fail) { duke@435: *wci_result = *(WarmCallInfo::always_cold()); duke@435: return fail; duke@435: } duke@435: duke@435: if (callee_method->has_unloaded_classes_in_signature()) { duke@435: wci_result->set_profit(wci_result->profit() * 0.1); duke@435: } duke@435: duke@435: // don't inline exception code unless the top method belongs to an duke@435: // exception class duke@435: if (callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) { duke@435: ciMethod* top_method = caller_jvms() ? caller_jvms()->of_depth(1)->method() : method(); duke@435: if (!top_method->holder()->is_subclass_of(C->env()->Throwable_klass())) { duke@435: wci_result->set_profit(wci_result->profit() * 0.1); duke@435: } duke@435: } duke@435: duke@435: if (callee_method->has_compiled_code() && callee_method->instructions_size() > InlineSmallCode) { duke@435: wci_result->set_profit(wci_result->profit() * 0.1); duke@435: // %%% adjust wci_result->size()? duke@435: } duke@435: duke@435: return NULL; duke@435: } duke@435: duke@435: // First check all inlining restrictions which are required for correctness duke@435: if (callee_method->is_abstract()) return "abstract method"; duke@435: // note: we allow ik->is_abstract() duke@435: if (!callee_method->holder()->is_initialized()) return "method holder not initialized"; duke@435: if (callee_method->is_native()) return "native method"; duke@435: if (callee_method->has_unloaded_classes_in_signature()) return "unloaded signature classes"; duke@435: duke@435: if (callee_method->should_inline()) { duke@435: // ignore heuristic controls on inlining duke@435: return NULL; duke@435: } duke@435: duke@435: // Now perform checks which are heuristic duke@435: duke@435: if( callee_method->has_compiled_code() && callee_method->instructions_size() > InlineSmallCode ) duke@435: return "already compiled into a big method"; duke@435: duke@435: // don't inline exception code unless the top method belongs to an duke@435: // exception class duke@435: if (caller_tree() != NULL && duke@435: callee_method->holder()->is_subclass_of(C->env()->Throwable_klass())) { duke@435: const InlineTree *top = this; duke@435: while (top->caller_tree() != NULL) top = top->caller_tree(); duke@435: ciInstanceKlass* k = top->method()->holder(); duke@435: if (!k->is_subclass_of(C->env()->Throwable_klass())) duke@435: return "exception method"; duke@435: } duke@435: duke@435: // use frequency-based objections only for non-trivial methods duke@435: if (callee_method->code_size() <= MaxTrivialSize) return NULL; kvn@476: kvn@476: // don't use counts with -Xcomp or CTW kvn@476: if (UseInterpreter && !CompileTheWorld) { kvn@476: kvn@476: if (!callee_method->has_compiled_code() && kvn@476: !callee_method->was_executed_more_than(0)) { kvn@476: return "never executed"; kvn@476: } kvn@476: kvn@476: if (is_init_with_ea(callee_method, caller_method, C)) { kvn@476: kvn@476: // Escape Analysis: inline all executed constructors kvn@476: kvn@476: } else if (!callee_method->was_executed_more_than(MIN2(MinInliningThreshold, kvn@476: CompileThreshold >> 1))) { kvn@476: return "executed < MinInliningThreshold times"; kvn@476: } duke@435: } duke@435: duke@435: if (callee_method->should_not_inline()) { duke@435: return "disallowed by CompilerOracle"; duke@435: } duke@435: duke@435: return NULL; duke@435: } duke@435: duke@435: //-----------------------------try_to_inline----------------------------------- duke@435: // return NULL if ok, reason for not inlining otherwise duke@435: // Relocated from "InliningClosure::try_to_inline" kvn@476: const char* InlineTree::try_to_inline(ciMethod* callee_method, ciMethod* caller_method, int caller_bci, ciCallProfile& profile, WarmCallInfo* wci_result) { duke@435: duke@435: // Old algorithm had funny accumulating BC-size counters duke@435: if (UseOldInlining && ClipInlining duke@435: && (int)count_inline_bcs() >= DesiredMethodLimit) { duke@435: return "size > DesiredMethodLimit"; duke@435: } duke@435: duke@435: const char *msg = NULL; kvn@476: if ((msg = shouldInline(callee_method, caller_method, caller_bci, kvn@476: profile, wci_result)) != NULL) { kvn@476: return msg; kvn@476: } kvn@476: if ((msg = shouldNotInline(callee_method, caller_method, kvn@476: wci_result)) != NULL) { kvn@476: return msg; kvn@476: } duke@435: duke@435: bool is_accessor = InlineAccessors && callee_method->is_accessor(); duke@435: duke@435: // suppress a few checks for accessors and trivial methods duke@435: if (!is_accessor && callee_method->code_size() > MaxTrivialSize) { kvn@476: duke@435: // don't inline into giant methods kvn@476: if (C->unique() > (uint)NodeCountInliningCutoff) { kvn@476: return "NodeCountInliningCutoff"; kvn@476: } duke@435: kvn@476: if ((!UseInterpreter || CompileTheWorld) && kvn@476: is_init_with_ea(callee_method, caller_method, C)) { kvn@476: kvn@476: // Escape Analysis stress testing when running Xcomp or CTW: kvn@476: // inline constructors even if they are not reached. kvn@476: kvn@476: } else if (profile.count() == 0) { kvn@476: // don't inline unreached call sites kvn@476: return "call site not reached"; kvn@476: } duke@435: } duke@435: kvn@476: if (!C->do_inlining() && InlineAccessors && !is_accessor) { kvn@476: return "not an accessor"; kvn@476: } kvn@476: if( inline_depth() > MaxInlineLevel ) { kvn@476: return "inlining too deep"; kvn@476: } duke@435: if( method() == callee_method && kvn@476: inline_depth() > MaxRecursiveInlineLevel ) { kvn@476: return "recursively inlining too deep"; kvn@476: } duke@435: duke@435: int size = callee_method->code_size(); duke@435: duke@435: if (UseOldInlining && ClipInlining duke@435: && (int)count_inline_bcs() + size >= DesiredMethodLimit) { duke@435: return "size > DesiredMethodLimit"; duke@435: } duke@435: duke@435: // ok, inline this method duke@435: return NULL; duke@435: } duke@435: duke@435: //------------------------------pass_initial_checks---------------------------- duke@435: bool pass_initial_checks(ciMethod* caller_method, int caller_bci, ciMethod* callee_method) { duke@435: ciInstanceKlass *callee_holder = callee_method ? callee_method->holder() : NULL; duke@435: // Check if a callee_method was suggested duke@435: if( callee_method == NULL ) return false; duke@435: // Check if klass of callee_method is loaded duke@435: if( !callee_holder->is_loaded() ) return false; duke@435: if( !callee_holder->is_initialized() ) return false; duke@435: if( !UseInterpreter || CompileTheWorld /* running Xcomp or CTW */ ) { duke@435: // Checks that constant pool's call site has been visited duke@435: // stricter than callee_holder->is_initialized() duke@435: ciBytecodeStream iter(caller_method); duke@435: iter.force_bci(caller_bci); duke@435: int index = iter.get_index_big(); duke@435: if( !caller_method->is_klass_loaded(index, true) ) { duke@435: return false; duke@435: } duke@435: // Try to do constant pool resolution if running Xcomp duke@435: Bytecodes::Code call_bc = iter.cur_bc(); duke@435: if( !caller_method->check_call(index, call_bc == Bytecodes::_invokestatic) ) { duke@435: return false; duke@435: } duke@435: } duke@435: // We will attempt to see if a class/field/etc got properly loaded. If it duke@435: // did not, it may attempt to throw an exception during our probing. Catch duke@435: // and ignore such exceptions and do not attempt to compile the method. duke@435: if( callee_method->should_exclude() ) return false; duke@435: duke@435: return true; duke@435: } duke@435: duke@435: #ifndef PRODUCT duke@435: //------------------------------print_inlining--------------------------------- duke@435: // Really, the failure_msg can be a success message also. duke@435: void InlineTree::print_inlining(ciMethod *callee_method, int caller_bci, const char *failure_msg) const { duke@435: print_indent(inline_depth()); duke@435: tty->print("@ %d ", caller_bci); duke@435: if( callee_method ) callee_method->print_short_name(); duke@435: else tty->print(" callee not monotonic or profiled"); duke@435: tty->print(" %s", (failure_msg ? failure_msg : "inline")); duke@435: if( Verbose && callee_method ) { duke@435: const InlineTree *top = this; duke@435: while( top->caller_tree() != NULL ) { top = top->caller_tree(); } duke@435: tty->print(" bcs: %d+%d invoked: %d", top->count_inline_bcs(), callee_method->code_size(), callee_method->interpreter_invocation_count()); duke@435: } duke@435: tty->cr(); duke@435: } duke@435: #endif duke@435: duke@435: //------------------------------ok_to_inline----------------------------------- duke@435: WarmCallInfo* InlineTree::ok_to_inline(ciMethod* callee_method, JVMState* jvms, ciCallProfile& profile, WarmCallInfo* initial_wci) { duke@435: assert(callee_method != NULL, "caller checks for optimized virtual!"); duke@435: #ifdef ASSERT duke@435: // Make sure the incoming jvms has the same information content as me. duke@435: // This means that we can eventually make this whole class AllStatic. duke@435: if (jvms->caller() == NULL) { duke@435: assert(_caller_jvms == NULL, "redundant instance state"); duke@435: } else { duke@435: assert(_caller_jvms->same_calls_as(jvms->caller()), "redundant instance state"); duke@435: } duke@435: assert(_method == jvms->method(), "redundant instance state"); duke@435: #endif duke@435: const char *failure_msg = NULL; duke@435: int caller_bci = jvms->bci(); duke@435: ciMethod *caller_method = jvms->method(); duke@435: duke@435: if( !pass_initial_checks(caller_method, caller_bci, callee_method)) { duke@435: if( PrintInlining ) { duke@435: failure_msg = "failed_initial_checks"; duke@435: print_inlining( callee_method, caller_bci, failure_msg); duke@435: } duke@435: return NULL; duke@435: } duke@435: duke@435: // Check if inlining policy says no. duke@435: WarmCallInfo wci = *(initial_wci); kvn@476: failure_msg = try_to_inline(callee_method, caller_method, caller_bci, profile, &wci); duke@435: if (failure_msg != NULL && C->log() != NULL) { duke@435: C->log()->begin_elem("inline_fail reason='"); duke@435: C->log()->text("%s", failure_msg); duke@435: C->log()->end_elem("'"); duke@435: } duke@435: duke@435: #ifndef PRODUCT duke@435: if (UseOldInlining && InlineWarmCalls duke@435: && (PrintOpto || PrintOptoInlining || PrintInlining)) { duke@435: bool cold = wci.is_cold(); duke@435: bool hot = !cold && wci.is_hot(); duke@435: bool old_cold = (failure_msg != NULL); duke@435: if (old_cold != cold || (Verbose || WizardMode)) { duke@435: tty->print(" OldInlining= %4s : %s\n WCI=", duke@435: old_cold ? "cold" : "hot", failure_msg ? failure_msg : "OK"); duke@435: wci.print(); duke@435: } duke@435: } duke@435: #endif duke@435: if (UseOldInlining) { duke@435: if (failure_msg == NULL) duke@435: wci = *(WarmCallInfo::always_hot()); duke@435: else duke@435: wci = *(WarmCallInfo::always_cold()); duke@435: } duke@435: if (!InlineWarmCalls) { duke@435: if (!wci.is_cold() && !wci.is_hot()) { duke@435: // Do not inline the warm calls. duke@435: wci = *(WarmCallInfo::always_cold()); duke@435: } duke@435: } duke@435: duke@435: if (!wci.is_cold()) { duke@435: // In -UseOldInlining, the failure_msg may also be a success message. duke@435: if (failure_msg == NULL) failure_msg = "inline (hot)"; duke@435: duke@435: // Inline! duke@435: if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg); duke@435: if (UseOldInlining) duke@435: build_inline_tree_for_callee(callee_method, jvms, caller_bci); duke@435: if (InlineWarmCalls && !wci.is_hot()) duke@435: return new (C) WarmCallInfo(wci); // copy to heap duke@435: return WarmCallInfo::always_hot(); duke@435: } duke@435: duke@435: // Do not inline duke@435: if (failure_msg == NULL) failure_msg = "too cold to inline"; duke@435: if( PrintInlining ) print_inlining( callee_method, caller_bci, failure_msg); duke@435: return NULL; duke@435: } duke@435: duke@435: //------------------------------compute_callee_frequency----------------------- duke@435: float InlineTree::compute_callee_frequency( int caller_bci ) const { duke@435: int count = method()->interpreter_call_site_count(caller_bci); duke@435: int invcnt = method()->interpreter_invocation_count(); duke@435: float freq = (float)count/(float)invcnt; duke@435: // Call-site count / interpreter invocation count, scaled recursively. duke@435: // Always between 0.0 and 1.0. Represents the percentage of the method's duke@435: // total execution time used at this call site. duke@435: duke@435: return freq; duke@435: } duke@435: duke@435: //------------------------------build_inline_tree_for_callee------------------- duke@435: InlineTree *InlineTree::build_inline_tree_for_callee( ciMethod* callee_method, JVMState* caller_jvms, int caller_bci) { duke@435: float recur_frequency = _site_invoke_ratio * compute_callee_frequency(caller_bci); duke@435: // Attempt inlining. duke@435: InlineTree* old_ilt = callee_at(caller_bci, callee_method); duke@435: if (old_ilt != NULL) { duke@435: return old_ilt; duke@435: } duke@435: InlineTree *ilt = new InlineTree( C, this, callee_method, caller_jvms, caller_bci, recur_frequency ); duke@435: _subtrees.append( ilt ); duke@435: duke@435: NOT_PRODUCT( _count_inlines += 1; ) duke@435: duke@435: return ilt; duke@435: } duke@435: duke@435: duke@435: //---------------------------------------callee_at----------------------------- duke@435: InlineTree *InlineTree::callee_at(int bci, ciMethod* callee) const { duke@435: for (int i = 0; i < _subtrees.length(); i++) { duke@435: InlineTree* sub = _subtrees.at(i); duke@435: if (sub->caller_bci() == bci && callee == sub->method()) { duke@435: return sub; duke@435: } duke@435: } duke@435: return NULL; duke@435: } duke@435: duke@435: duke@435: //------------------------------build_inline_tree_root------------------------- duke@435: InlineTree *InlineTree::build_inline_tree_root() { duke@435: Compile* C = Compile::current(); duke@435: duke@435: // Root of inline tree duke@435: InlineTree *ilt = new InlineTree(C, NULL, C->method(), NULL, -1, 1.0F); duke@435: duke@435: return ilt; duke@435: } duke@435: duke@435: duke@435: //-------------------------find_subtree_from_root----------------------------- duke@435: // Given a jvms, which determines a call chain from the root method, duke@435: // find the corresponding inline tree. duke@435: // Note: This method will be removed or replaced as InlineTree goes away. duke@435: InlineTree* InlineTree::find_subtree_from_root(InlineTree* root, JVMState* jvms, ciMethod* callee, bool create_if_not_found) { duke@435: InlineTree* iltp = root; duke@435: uint depth = jvms && jvms->has_method() ? jvms->depth() : 0; duke@435: for (uint d = 1; d <= depth; d++) { duke@435: JVMState* jvmsp = jvms->of_depth(d); duke@435: // Select the corresponding subtree for this bci. duke@435: assert(jvmsp->method() == iltp->method(), "tree still in sync"); duke@435: ciMethod* d_callee = (d == depth) ? callee : jvms->of_depth(d+1)->method(); duke@435: InlineTree* sub = iltp->callee_at(jvmsp->bci(), d_callee); duke@435: if (!sub) { duke@435: if (create_if_not_found && d == depth) { duke@435: return iltp->build_inline_tree_for_callee(d_callee, jvmsp, jvmsp->bci()); duke@435: } duke@435: assert(sub != NULL, "should be a sub-ilt here"); duke@435: return NULL; duke@435: } duke@435: iltp = sub; duke@435: } duke@435: return iltp; duke@435: }