1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "runtime/advancedThresholdPolicy.hpp"
  27 #include "runtime/simpleThresholdPolicy.inline.hpp"
  28 
  29 #ifdef TIERED
  30 // Print an event.
  31 void AdvancedThresholdPolicy::print_specific(EventType type, methodHandle mh, methodHandle imh,
  32                                              int bci, CompLevel level) {
  33   tty->print(" rate=");
  34   if (mh->prev_time() == 0) tty->print("n/a");
  35   else tty->print("%f", mh->rate());
  36 
  37   tty->print(" k=%.2lf,%.2lf", threshold_scale(CompLevel_full_profile, Tier3LoadFeedback),
  38                                threshold_scale(CompLevel_full_optimization, Tier4LoadFeedback));
  39 
  40 }
  41 
  42 void AdvancedThresholdPolicy::initialize() {
  43   // Turn on ergonomic compiler count selection
  44   if (FLAG_IS_DEFAULT(CICompilerCountPerCPU) && FLAG_IS_DEFAULT(CICompilerCount)) {
  45     FLAG_SET_DEFAULT(CICompilerCountPerCPU, true);
  46   }
  47   int count = CICompilerCount;
  48   if (CICompilerCountPerCPU) {
  49     // Simple log n seems to grow too slowly for tiered, try something faster: log n * log log n
  50     int log_cpu = log2_intptr(os::active_processor_count());
  51     int loglog_cpu = log2_intptr(MAX2(log_cpu, 1));
  52     count = MAX2(log_cpu * loglog_cpu, 1) * 3 / 2;
  53   }
  54 
  55   set_c1_count(MAX2(count / 3, 1));
  56   set_c2_count(MAX2(count - count / 3, 1));
  57 
  58   // Some inlining tuning
  59 #ifdef X86
  60   if (FLAG_IS_DEFAULT(InlineSmallCode)) {
  61     FLAG_SET_DEFAULT(InlineSmallCode, 2000);
  62   }
  63 #endif
  64 
  65 #ifdef SPARC
  66   if (FLAG_IS_DEFAULT(InlineSmallCode)) {
  67     FLAG_SET_DEFAULT(InlineSmallCode, 2500);
  68   }
  69 #endif
  70 
  71   set_reverse_cmdline_free_ratio();
  72   set_start_time(os::javaTimeMillis());
  73 }
  74 
  75 // update_rate() is called from select_task() while holding a compile queue lock.
  76 void AdvancedThresholdPolicy::update_rate(jlong t, Method* m) {
  77   JavaThread* THREAD = JavaThread::current();
  78   if (is_old(m)) {
  79     // We don't remove old methods from the queue,
  80     // so we can just zero the rate.
  81     m->set_rate(0, THREAD);
  82     return;
  83   }
  84 
  85   // We don't update the rate if we've just came out of a safepoint.
  86   // delta_s is the time since last safepoint in milliseconds.
  87   jlong delta_s = t - SafepointSynchronize::end_of_last_safepoint();
  88   jlong delta_t = t - (m->prev_time() != 0 ? m->prev_time() : start_time()); // milliseconds since the last measurement
  89   // How many events were there since the last time?
  90   int event_count = m->invocation_count() + m->backedge_count();
  91   int delta_e = event_count - m->prev_event_count();
  92 
  93   // We should be running for at least 1ms.
  94   if (delta_s >= TieredRateUpdateMinTime) {
  95     // And we must've taken the previous point at least 1ms before.
  96     if (delta_t >= TieredRateUpdateMinTime && delta_e > 0) {
  97       m->set_prev_time(t, THREAD);
  98       m->set_prev_event_count(event_count, THREAD);
  99       m->set_rate((float)delta_e / (float)delta_t, THREAD); // Rate is events per millisecond
 100     } else
 101       if (delta_t > TieredRateUpdateMaxTime && delta_e == 0) {
 102         // If nothing happened for 25ms, zero the rate. Don't modify prev values.
 103         m->set_rate(0, THREAD);
 104       }
 105   }
 106 }
 107 
 108 // Check if this method has been stale from a given number of milliseconds.
 109 // See select_task().
 110 bool AdvancedThresholdPolicy::is_stale(jlong t, jlong timeout, Method* m) {
 111   jlong delta_s = t - SafepointSynchronize::end_of_last_safepoint();
 112   jlong delta_t = t - m->prev_time();
 113   if (delta_t > timeout && delta_s > timeout) {
 114     int event_count = m->invocation_count() + m->backedge_count();
 115     int delta_e = event_count - m->prev_event_count();
 116     // Return true if there were no events.
 117     return delta_e == 0;
 118   }
 119   return false;
 120 }
 121 
 122 // We don't remove old methods from the compile queue even if they have
 123 // very low activity. See select_task().
 124 bool AdvancedThresholdPolicy::is_old(Method* method) {
 125   return method->invocation_count() > 50000 || method->backedge_count() > 500000;
 126 }
 127 
 128 double AdvancedThresholdPolicy::weight(Method* method) {
 129   return (method->rate() + 1) * ((method->invocation_count() + 1) *  (method->backedge_count() + 1));
 130 }
 131 
 132 // Apply heuristics and return true if x should be compiled before y
 133 bool AdvancedThresholdPolicy::compare_methods(Method* x, Method* y) {
 134   if (x->highest_comp_level() > y->highest_comp_level()) {
 135     // recompilation after deopt
 136     return true;
 137   } else
 138     if (x->highest_comp_level() == y->highest_comp_level()) {
 139       if (weight(x) > weight(y)) {
 140         return true;
 141       }
 142     }
 143   return false;
 144 }
 145 
 146 // Is method profiled enough?
 147 bool AdvancedThresholdPolicy::is_method_profiled(Method* method) {
 148   MethodData* mdo = method->method_data();
 149   if (mdo != NULL) {
 150     int i = mdo->invocation_count_delta();
 151     int b = mdo->backedge_count_delta();
 152     return call_predicate_helper<CompLevel_full_profile>(i, b, 1);
 153   }
 154   return false;
 155 }
 156 
 157 // Called with the queue locked and with at least one element
 158 CompileTask* AdvancedThresholdPolicy::select_task(CompileQueue* compile_queue) {
 159   CompileTask *max_task = NULL;
 160   Method* max_method = NULL;
 161   jlong t = os::javaTimeMillis();
 162   // Iterate through the queue and find a method with a maximum rate.
 163   for (CompileTask* task = compile_queue->first(); task != NULL;) {
 164     CompileTask* next_task = task->next();
 165     Method* method = task->method();
 166     MethodData* mdo = method->method_data();
 167     update_rate(t, method);
 168     if (max_task == NULL) {
 169       max_task = task;
 170       max_method = method;
 171     } else {
 172       // If a method has been stale for some time, remove it from the queue.
 173       if (is_stale(t, TieredCompileTaskTimeout, method) && !is_old(method)) {
 174         if (PrintTieredEvents) {
 175           print_event(REMOVE_FROM_QUEUE, method, method, task->osr_bci(), (CompLevel)task->comp_level());
 176         }
 177         CompileTaskWrapper ctw(task); // Frees the task
 178         compile_queue->remove(task);
 179         method->clear_queued_for_compilation();
 180         task = next_task;
 181         continue;
 182       }
 183 
 184       // Select a method with a higher rate
 185       if (compare_methods(method, max_method)) {
 186         max_task = task;
 187         max_method = method;
 188       }
 189     }
 190     task = next_task;
 191   }
 192 
 193   if (max_task->comp_level() == CompLevel_full_profile && TieredStopAtLevel > CompLevel_full_profile
 194       && is_method_profiled(max_method)) {
 195     max_task->set_comp_level(CompLevel_limited_profile);
 196     if (PrintTieredEvents) {
 197       print_event(UPDATE_IN_QUEUE, max_method, max_method, max_task->osr_bci(), (CompLevel)max_task->comp_level());
 198     }
 199   }
 200 
 201   return max_task;
 202 }
 203 
 204 double AdvancedThresholdPolicy::threshold_scale(CompLevel level, int feedback_k) {
 205   double queue_size = CompileBroker::queue_size(level);
 206   int comp_count = compiler_count(level);
 207   double k = queue_size / (feedback_k * comp_count) + 1;
 208 
 209   double reverse_free_ratio = CodeCache::reverse_free_ratio();
 210   // E.g., 4 means that 25% (1/4) of the code cache is free
 211   if (level != CompLevel_full_optimization)  {
 212     if (reverse_free_ratio > _reverse_cmdline_free_ratio) {
 213       k *= exp(reverse_free_ratio - _reverse_cmdline_free_ratio);
 214     }
 215   }
 216   return k;
 217 }
 218 
 219 // Call and loop predicates determine whether a transition to a higher
 220 // compilation level should be performed (pointers to predicate functions
 221 // are passed to common()).
 222 // Tier?LoadFeedback is basically a coefficient that determines of
 223 // how many methods per compiler thread can be in the queue before
 224 // the threshold values double.
 225 bool AdvancedThresholdPolicy::loop_predicate(int i, int b, CompLevel cur_level) {
 226   switch(cur_level) {
 227   case CompLevel_none:
 228   case CompLevel_limited_profile: {
 229     double k = threshold_scale(CompLevel_full_profile, Tier3LoadFeedback);
 230     return loop_predicate_helper<CompLevel_none>(i, b, k);
 231   }
 232   case CompLevel_full_profile: {
 233     double k = threshold_scale(CompLevel_full_optimization, Tier4LoadFeedback);
 234     return loop_predicate_helper<CompLevel_full_profile>(i, b, k);
 235   }
 236   default:
 237     return true;
 238   }
 239 }
 240 
 241 bool AdvancedThresholdPolicy::call_predicate(int i, int b, CompLevel cur_level) {
 242   switch(cur_level) {
 243   case CompLevel_none:
 244   case CompLevel_limited_profile: {
 245     double k = threshold_scale(CompLevel_full_profile, Tier3LoadFeedback);
 246     return call_predicate_helper<CompLevel_none>(i, b, k);
 247   }
 248   case CompLevel_full_profile: {
 249     double k = threshold_scale(CompLevel_full_optimization, Tier4LoadFeedback);
 250     return call_predicate_helper<CompLevel_full_profile>(i, b, k);
 251   }
 252   default:
 253     return true;
 254   }
 255 }
 256 
 257 // If a method is old enough and is still in the interpreter we would want to
 258 // start profiling without waiting for the compiled method to arrive.
 259 // We also take the load on compilers into the account.
 260 bool AdvancedThresholdPolicy::should_create_mdo(Method* method, CompLevel cur_level) {
 261   if (cur_level == CompLevel_none &&
 262       CompileBroker::queue_size(CompLevel_full_optimization) <=
 263       Tier3DelayOn * compiler_count(CompLevel_full_optimization)) {
 264     int i = method->invocation_count();
 265     int b = method->backedge_count();
 266     double k = Tier0ProfilingStartPercentage / 100.0;
 267     return call_predicate_helper<CompLevel_none>(i, b, k) || loop_predicate_helper<CompLevel_none>(i, b, k);
 268   }
 269   return false;
 270 }
 271 
 272 // Inlining control: if we're compiling a profiled method with C1 and the callee
 273 // is known to have OSRed in a C2 version, don't inline it.
 274 bool AdvancedThresholdPolicy::should_not_inline(ciEnv* env, ciMethod* callee) {
 275   CompLevel comp_level = (CompLevel)env->comp_level();
 276   if (comp_level == CompLevel_full_profile ||
 277       comp_level == CompLevel_limited_profile) {
 278     return callee->highest_osr_comp_level() == CompLevel_full_optimization;
 279   }
 280   return false;
 281 }
 282 
 283 // Create MDO if necessary.
 284 void AdvancedThresholdPolicy::create_mdo(methodHandle mh, JavaThread* THREAD) {
 285   if (mh->is_native() || mh->is_abstract() || mh->is_accessor()) return;
 286   if (mh->method_data() == NULL) {
 287     Method::build_interpreter_method_data(mh, CHECK_AND_CLEAR);
 288   }
 289 }
 290 
 291 
 292 /*
 293  * Method states:
 294  *   0 - interpreter (CompLevel_none)
 295  *   1 - pure C1 (CompLevel_simple)
 296  *   2 - C1 with invocation and backedge counting (CompLevel_limited_profile)
 297  *   3 - C1 with full profiling (CompLevel_full_profile)
 298  *   4 - C2 (CompLevel_full_optimization)
 299  *
 300  * Common state transition patterns:
 301  * a. 0 -> 3 -> 4.
 302  *    The most common path. But note that even in this straightforward case
 303  *    profiling can start at level 0 and finish at level 3.
 304  *
 305  * b. 0 -> 2 -> 3 -> 4.
 306  *    This case occures when the load on C2 is deemed too high. So, instead of transitioning
 307  *    into state 3 directly and over-profiling while a method is in the C2 queue we transition to
 308  *    level 2 and wait until the load on C2 decreases. This path is disabled for OSRs.
 309  *
 310  * c. 0 -> (3->2) -> 4.
 311  *    In this case we enqueue a method for compilation at level 3, but the C1 queue is long enough
 312  *    to enable the profiling to fully occur at level 0. In this case we change the compilation level
 313  *    of the method to 2, because it'll allow it to run much faster without full profiling while c2
 314  *    is compiling.
 315  *
 316  * d. 0 -> 3 -> 1 or 0 -> 2 -> 1.
 317  *    After a method was once compiled with C1 it can be identified as trivial and be compiled to
 318  *    level 1. These transition can also occur if a method can't be compiled with C2 but can with C1.
 319  *
 320  * e. 0 -> 4.
 321  *    This can happen if a method fails C1 compilation (it will still be profiled in the interpreter)
 322  *    or because of a deopt that didn't require reprofiling (compilation won't happen in this case because
 323  *    the compiled version already exists).
 324  *
 325  * Note that since state 0 can be reached from any other state via deoptimization different loops
 326  * are possible.
 327  *
 328  */
 329 
 330 // Common transition function. Given a predicate determines if a method should transition to another level.
 331 CompLevel AdvancedThresholdPolicy::common(Predicate p, Method* method, CompLevel cur_level, bool disable_feedback) {
 332   CompLevel next_level = cur_level;
 333   int i = method->invocation_count();
 334   int b = method->backedge_count();
 335 
 336   if (is_trivial(method)) {
 337     next_level = CompLevel_simple;
 338   } else {
 339     switch(cur_level) {
 340     case CompLevel_none:
 341       // If we were at full profile level, would we switch to full opt?
 342       if (common(p, method, CompLevel_full_profile, disable_feedback) == CompLevel_full_optimization) {
 343         next_level = CompLevel_full_optimization;
 344       } else if ((this->*p)(i, b, cur_level)) {
 345         // C1-generated fully profiled code is about 30% slower than the limited profile
 346         // code that has only invocation and backedge counters. The observation is that
 347         // if C2 queue is large enough we can spend too much time in the fully profiled code
 348         // while waiting for C2 to pick the method from the queue. To alleviate this problem
 349         // we introduce a feedback on the C2 queue size. If the C2 queue is sufficiently long
 350         // we choose to compile a limited profiled version and then recompile with full profiling
 351         // when the load on C2 goes down.
 352         if (!disable_feedback && CompileBroker::queue_size(CompLevel_full_optimization) >
 353                                  Tier3DelayOn * compiler_count(CompLevel_full_optimization)) {
 354           next_level = CompLevel_limited_profile;
 355         } else {
 356           next_level = CompLevel_full_profile;
 357         }
 358       }
 359       break;
 360     case CompLevel_limited_profile:
 361       if (is_method_profiled(method)) {
 362         // Special case: we got here because this method was fully profiled in the interpreter.
 363         next_level = CompLevel_full_optimization;
 364       } else {
 365         MethodData* mdo = method->method_data();
 366         if (mdo != NULL) {
 367           if (mdo->would_profile()) {
 368             if (disable_feedback || (CompileBroker::queue_size(CompLevel_full_optimization) <=
 369                                      Tier3DelayOff * compiler_count(CompLevel_full_optimization) &&
 370                                      (this->*p)(i, b, cur_level))) {
 371               next_level = CompLevel_full_profile;
 372             }
 373           } else {
 374             next_level = CompLevel_full_optimization;
 375           }
 376         }
 377       }
 378       break;
 379     case CompLevel_full_profile:
 380       {
 381         MethodData* mdo = method->method_data();
 382         if (mdo != NULL) {
 383           if (mdo->would_profile()) {
 384             int mdo_i = mdo->invocation_count_delta();
 385             int mdo_b = mdo->backedge_count_delta();
 386             if ((this->*p)(mdo_i, mdo_b, cur_level)) {
 387               next_level = CompLevel_full_optimization;
 388             }
 389           } else {
 390             next_level = CompLevel_full_optimization;
 391           }
 392         }
 393       }
 394       break;
 395     }
 396   }
 397   return MIN2(next_level, (CompLevel)TieredStopAtLevel);
 398 }
 399 
 400 // Determine if a method should be compiled with a normal entry point at a different level.
 401 CompLevel AdvancedThresholdPolicy::call_event(Method* method, CompLevel cur_level) {
 402   CompLevel osr_level = MIN2((CompLevel) method->highest_osr_comp_level(),
 403                              common(&AdvancedThresholdPolicy::loop_predicate, method, cur_level, true));
 404   CompLevel next_level = common(&AdvancedThresholdPolicy::call_predicate, method, cur_level);
 405 
 406   // If OSR method level is greater than the regular method level, the levels should be
 407   // equalized by raising the regular method level in order to avoid OSRs during each
 408   // invocation of the method.
 409   if (osr_level == CompLevel_full_optimization && cur_level == CompLevel_full_profile) {
 410     MethodData* mdo = method->method_data();
 411     guarantee(mdo != NULL, "MDO should not be NULL");
 412     if (mdo->invocation_count() >= 1) {
 413       next_level = CompLevel_full_optimization;
 414     }
 415   } else {
 416     next_level = MAX2(osr_level, next_level);
 417   }
 418   return next_level;
 419 }
 420 
 421 // Determine if we should do an OSR compilation of a given method.
 422 CompLevel AdvancedThresholdPolicy::loop_event(Method* method, CompLevel cur_level) {
 423   CompLevel next_level = common(&AdvancedThresholdPolicy::loop_predicate, method, cur_level, true);
 424   if (cur_level == CompLevel_none) {
 425     // If there is a live OSR method that means that we deopted to the interpreter
 426     // for the transition.
 427     CompLevel osr_level = MIN2((CompLevel)method->highest_osr_comp_level(), next_level);
 428     if (osr_level > CompLevel_none) {
 429       return osr_level;
 430     }
 431   }
 432   return next_level;
 433 }
 434 
 435 // Update the rate and submit compile
 436 void AdvancedThresholdPolicy::submit_compile(methodHandle mh, int bci, CompLevel level, JavaThread* thread) {
 437   int hot_count = (bci == InvocationEntryBci) ? mh->invocation_count() : mh->backedge_count();
 438   update_rate(os::javaTimeMillis(), mh());
 439   CompileBroker::compile_method(mh, bci, level, mh, hot_count, "tiered", thread);
 440 }
 441 
 442 // Handle the invocation event.
 443 void AdvancedThresholdPolicy::method_invocation_event(methodHandle mh, methodHandle imh,
 444                                                       CompLevel level, nmethod* nm, JavaThread* thread) {
 445   if (should_create_mdo(mh(), level)) {
 446     create_mdo(mh, thread);
 447   }
 448   if (is_compilation_enabled() && !CompileBroker::compilation_is_in_queue(mh, InvocationEntryBci)) {
 449     CompLevel next_level = call_event(mh(), level);
 450     if (next_level != level) {
 451       compile(mh, InvocationEntryBci, next_level, thread);
 452     }
 453   }
 454 }
 455 
 456 // Handle the back branch event. Notice that we can compile the method
 457 // with a regular entry from here.
 458 void AdvancedThresholdPolicy::method_back_branch_event(methodHandle mh, methodHandle imh,
 459                                                        int bci, CompLevel level, nmethod* nm, JavaThread* thread) {
 460   if (should_create_mdo(mh(), level)) {
 461     create_mdo(mh, thread);
 462   }
 463   // Check if MDO should be created for the inlined method
 464   if (should_create_mdo(imh(), level)) {
 465     create_mdo(imh, thread);
 466   }
 467 
 468   if (is_compilation_enabled()) {
 469     CompLevel next_osr_level = loop_event(imh(), level);
 470     CompLevel max_osr_level = (CompLevel)imh->highest_osr_comp_level();
 471     // At the very least compile the OSR version
 472     if (!CompileBroker::compilation_is_in_queue(imh, bci) && next_osr_level != level) {
 473       compile(imh, bci, next_osr_level, thread);
 474     }
 475 
 476     // Use loop event as an opportunity to also check if there's been
 477     // enough calls.
 478     CompLevel cur_level, next_level;
 479     if (mh() != imh()) { // If there is an enclosing method
 480       guarantee(nm != NULL, "Should have nmethod here");
 481       cur_level = comp_level(mh());
 482       next_level = call_event(mh(), cur_level);
 483 
 484       if (max_osr_level == CompLevel_full_optimization) {
 485         // The inlinee OSRed to full opt, we need to modify the enclosing method to avoid deopts
 486         bool make_not_entrant = false;
 487         if (nm->is_osr_method()) {
 488           // This is an osr method, just make it not entrant and recompile later if needed
 489           make_not_entrant = true;
 490         } else {
 491           if (next_level != CompLevel_full_optimization) {
 492             // next_level is not full opt, so we need to recompile the
 493             // enclosing method without the inlinee
 494             cur_level = CompLevel_none;
 495             make_not_entrant = true;
 496           }
 497         }
 498         if (make_not_entrant) {
 499           if (PrintTieredEvents) {
 500             int osr_bci = nm->is_osr_method() ? nm->osr_entry_bci() : InvocationEntryBci;
 501             print_event(MAKE_NOT_ENTRANT, mh(), mh(), osr_bci, level);
 502           }
 503           nm->make_not_entrant();
 504         }
 505       }
 506       if (!CompileBroker::compilation_is_in_queue(mh, InvocationEntryBci)) {
 507         // Fix up next_level if necessary to avoid deopts
 508         if (next_level == CompLevel_limited_profile && max_osr_level == CompLevel_full_profile) {
 509           next_level = CompLevel_full_profile;
 510         }
 511         if (cur_level != next_level) {
 512           compile(mh, InvocationEntryBci, next_level, thread);
 513         }
 514       }
 515     } else {
 516       cur_level = comp_level(imh());
 517       next_level = call_event(imh(), cur_level);
 518       if (!CompileBroker::compilation_is_in_queue(imh, bci) && next_level != cur_level) {
 519         compile(imh, InvocationEntryBci, next_level, thread);
 520       }
 521     }
 522   }
 523 }
 524 
 525 #endif // TIERED