1 /*
   2  * Copyright (c) 2010, 2016, 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 "compiler/compileBroker.hpp"
  27 #include "memory/resourceArea.hpp"
  28 #include "runtime/arguments.hpp"
  29 #include "runtime/simpleThresholdPolicy.hpp"
  30 #include "runtime/simpleThresholdPolicy.inline.hpp"
  31 #include "code/scopeDesc.hpp"
  32 #if INCLUDE_JVMCI
  33 #include "jvmci/jvmciRuntime.hpp"
  34 #endif
  35 
  36 
  37 void SimpleThresholdPolicy::print_counters(const char* prefix, methodHandle mh) {
  38   int invocation_count = mh->invocation_count();
  39   int backedge_count = mh->backedge_count();
  40   MethodData* mdh = mh->method_data();
  41   int mdo_invocations = 0, mdo_backedges = 0;
  42   int mdo_invocations_start = 0, mdo_backedges_start = 0;
  43   if (mdh != NULL) {
  44     mdo_invocations = mdh->invocation_count();
  45     mdo_backedges = mdh->backedge_count();
  46     mdo_invocations_start = mdh->invocation_count_start();
  47     mdo_backedges_start = mdh->backedge_count_start();
  48   }
  49   tty->print(" %stotal=%d,%d %smdo=%d(%d),%d(%d)", prefix,
  50       invocation_count, backedge_count, prefix,
  51       mdo_invocations, mdo_invocations_start,
  52       mdo_backedges, mdo_backedges_start);
  53   tty->print(" %smax levels=%d,%d", prefix,
  54       mh->highest_comp_level(), mh->highest_osr_comp_level());
  55 }
  56 
  57 // Print an event.
  58 void SimpleThresholdPolicy::print_event(EventType type, methodHandle mh, methodHandle imh,
  59                                         int bci, CompLevel level) {
  60   bool inlinee_event = mh() != imh();
  61 
  62   ttyLocker tty_lock;
  63   tty->print("%lf: [", os::elapsedTime());
  64 
  65   switch(type) {
  66   case CALL:
  67     tty->print("call");
  68     break;
  69   case LOOP:
  70     tty->print("loop");
  71     break;
  72   case COMPILE:
  73     tty->print("compile");
  74     break;
  75   case REMOVE_FROM_QUEUE:
  76     tty->print("remove-from-queue");
  77     break;
  78   case UPDATE_IN_QUEUE:
  79     tty->print("update-in-queue");
  80     break;
  81   case REPROFILE:
  82     tty->print("reprofile");
  83     break;
  84   case MAKE_NOT_ENTRANT:
  85     tty->print("make-not-entrant");
  86     break;
  87   default:
  88     tty->print("unknown");
  89   }
  90 
  91   tty->print(" level=%d ", level);
  92 
  93   ResourceMark rm;
  94   char *method_name = mh->name_and_sig_as_C_string();
  95   tty->print("[%s", method_name);
  96   if (inlinee_event) {
  97     char *inlinee_name = imh->name_and_sig_as_C_string();
  98     tty->print(" [%s]] ", inlinee_name);
  99   }
 100   else tty->print("] ");
 101   tty->print("@%d queues=%d,%d", bci, CompileBroker::queue_size(CompLevel_full_profile),
 102                                       CompileBroker::queue_size(CompLevel_full_optimization));
 103 
 104   print_specific(type, mh, imh, bci, level);
 105 
 106   if (type != COMPILE) {
 107     print_counters("", mh);
 108     if (inlinee_event) {
 109       print_counters("inlinee ", imh);
 110     }
 111     tty->print(" compilable=");
 112     bool need_comma = false;
 113     if (!mh->is_not_compilable(CompLevel_full_profile)) {
 114       tty->print("c1");
 115       need_comma = true;
 116     }
 117     if (!mh->is_not_osr_compilable(CompLevel_full_profile)) {
 118       if (need_comma) tty->print(",");
 119       tty->print("c1-osr");
 120       need_comma = true;
 121     }
 122     if (!mh->is_not_compilable(CompLevel_full_optimization)) {
 123       if (need_comma) tty->print(",");
 124       tty->print("c2");
 125       need_comma = true;
 126     }
 127     if (!mh->is_not_osr_compilable(CompLevel_full_optimization)) {
 128       if (need_comma) tty->print(",");
 129       tty->print("c2-osr");
 130     }
 131     tty->print(" status=");
 132     if (mh->queued_for_compilation()) {
 133       tty->print("in-queue");
 134     } else tty->print("idle");
 135   }
 136   tty->print_cr("]");
 137 }
 138 
 139 void SimpleThresholdPolicy::initialize() {
 140   if (FLAG_IS_DEFAULT(CICompilerCount)) {
 141     FLAG_SET_DEFAULT(CICompilerCount, 3);
 142   }
 143   int count = CICompilerCount;
 144 #ifdef _LP64
 145   // On 64-bit systems, scale the number of compiler threads with
 146   // the number of cores available on the system. Scaling is not
 147   // performed on 32-bit systems because it can lead to exhaustion
 148   // of the virtual memory address space available to the JVM.
 149   if (CICompilerCountPerCPU) {
 150     count = MAX2(log2_intptr(os::active_processor_count()), 1) * 3 / 2;
 151   }
 152 #endif
 153   set_c1_count(MAX2(count / 3, 1));
 154   set_c2_count(MAX2(count - c1_count(), 1));
 155   FLAG_SET_ERGO(intx, CICompilerCount, c1_count() + c2_count());
 156 }
 157 
 158 void SimpleThresholdPolicy::set_carry_if_necessary(InvocationCounter *counter) {
 159   if (!counter->carry() && counter->count() > InvocationCounter::count_limit / 2) {
 160     counter->set_carry_flag();
 161   }
 162 }
 163 
 164 // Set carry flags on the counters if necessary
 165 void SimpleThresholdPolicy::handle_counter_overflow(Method* method) {
 166   MethodCounters *mcs = method->method_counters();
 167   if (mcs != NULL) {
 168     set_carry_if_necessary(mcs->invocation_counter());
 169     set_carry_if_necessary(mcs->backedge_counter());
 170   }
 171   MethodData* mdo = method->method_data();
 172   if (mdo != NULL) {
 173     set_carry_if_necessary(mdo->invocation_counter());
 174     set_carry_if_necessary(mdo->backedge_counter());
 175   }
 176 }
 177 
 178 // Called with the queue locked and with at least one element
 179 CompileTask* SimpleThresholdPolicy::select_task(CompileQueue* compile_queue) {
 180   return select_task_helper(compile_queue);
 181 }
 182 
 183 void SimpleThresholdPolicy::reprofile(ScopeDesc* trap_scope, bool is_osr) {
 184   for (ScopeDesc* sd = trap_scope;; sd = sd->sender()) {
 185     if (PrintTieredEvents) {
 186       methodHandle mh(sd->method());
 187       print_event(REPROFILE, mh, mh, InvocationEntryBci, CompLevel_none);
 188     }
 189     MethodData* mdo = sd->method()->method_data();
 190     if (mdo != NULL) {
 191       mdo->reset_start_counters();
 192     }
 193     if (sd->is_top()) break;
 194   }
 195 }
 196 
 197 nmethod* SimpleThresholdPolicy::event(const methodHandle& method, const methodHandle& inlinee,
 198                                       int branch_bci, int bci, CompLevel comp_level, CompiledMethod* nm, JavaThread* thread) {
 199   if (comp_level == CompLevel_none &&
 200       JvmtiExport::can_post_interpreter_events() &&
 201       thread->is_interp_only_mode()) {
 202     return NULL;
 203   }
 204   if (CompileTheWorld || ReplayCompiles) {
 205     // Don't trigger other compiles in testing mode
 206     return NULL;
 207   }
 208 
 209   handle_counter_overflow(method());
 210   if (method() != inlinee()) {
 211     handle_counter_overflow(inlinee());
 212   }
 213 
 214   if (PrintTieredEvents) {
 215     print_event(bci == InvocationEntryBci ? CALL : LOOP, method, inlinee, bci, comp_level);
 216   }
 217 
 218   if (bci == InvocationEntryBci) {
 219     method_invocation_event(method, inlinee, comp_level, nm, thread);
 220   } else {
 221     // method == inlinee if the event originated in the main method
 222     method_back_branch_event(method, inlinee, bci, comp_level, nm, thread);
 223     // Check if event led to a higher level OSR compilation
 224     nmethod* osr_nm = inlinee->lookup_osr_nmethod_for(bci, comp_level, false);
 225     if (osr_nm != NULL && osr_nm->comp_level() > comp_level) {
 226       // Perform OSR with new nmethod
 227       return osr_nm;
 228     }
 229   }
 230   return NULL;
 231 }
 232 
 233 // Check if the method can be compiled, change level if necessary
 234 void SimpleThresholdPolicy::compile(const methodHandle& mh, int bci, CompLevel level, JavaThread* thread) {
 235   assert(level <= TieredStopAtLevel, "Invalid compilation level");
 236   if (level == CompLevel_none) {
 237     return;
 238   }
 239 
 240 #if INCLUDE_JVMCI
 241   // We can't compile with a JVMCI compiler until the module system is initialized past
 242   // phase 3.  The JVMCI API itself isn't available until phase 2 and ServiceLoader isn't
 243   // usable until after phase 3.
 244   if (level == CompLevel_full_optimization && UseJVMCICompiler && SystemDictionary::java_system_loader() == NULL) {
 245     assert(Universe::is_module_initialized(), "must be");
 246     return;
 247   }
 248 #endif
 249 
 250   // Check if the method can be compiled. If it cannot be compiled with C1, continue profiling
 251   // in the interpreter and then compile with C2 (the transition function will request that,
 252   // see common() ). If the method cannot be compiled with C2 but still can with C1, compile it with
 253   // pure C1.
 254   if (!can_be_compiled(mh, level)) {
 255     if (level == CompLevel_full_optimization && can_be_compiled(mh, CompLevel_simple)) {
 256         compile(mh, bci, CompLevel_simple, thread);
 257     }
 258     return;
 259   }
 260   if (bci != InvocationEntryBci && mh->is_not_osr_compilable(level)) {
 261     return;
 262   }
 263   if (!CompileBroker::compilation_is_in_queue(mh)) {
 264     if (PrintTieredEvents) {
 265       print_event(COMPILE, mh, mh, bci, level);
 266     }
 267     submit_compile(mh, bci, level, thread);
 268   }
 269 }
 270 
 271 // Tell the broker to compile the method
 272 void SimpleThresholdPolicy::submit_compile(const methodHandle& mh, int bci, CompLevel level, JavaThread* thread) {
 273   int hot_count = (bci == InvocationEntryBci) ? mh->invocation_count() : mh->backedge_count();
 274   CompileBroker::compile_method(mh, bci, level, mh, hot_count, CompileTask::Reason_Tiered, thread);
 275 }
 276 
 277 // Call and loop predicates determine whether a transition to a higher
 278 // compilation level should be performed (pointers to predicate functions
 279 // are passed to common() transition function).
 280 bool SimpleThresholdPolicy::loop_predicate(int i, int b, CompLevel cur_level, Method* method) {
 281   switch(cur_level) {
 282   case CompLevel_none:
 283   case CompLevel_limited_profile: {
 284     return loop_predicate_helper<CompLevel_none>(i, b, 1.0, method);
 285   }
 286   case CompLevel_full_profile: {
 287     return loop_predicate_helper<CompLevel_full_profile>(i, b, 1.0, method);
 288   }
 289   default:
 290     return true;
 291   }
 292 }
 293 
 294 bool SimpleThresholdPolicy::call_predicate(int i, int b, CompLevel cur_level, Method* method) {
 295   switch(cur_level) {
 296   case CompLevel_none:
 297   case CompLevel_limited_profile: {
 298     return call_predicate_helper<CompLevel_none>(i, b, 1.0, method);
 299   }
 300   case CompLevel_full_profile: {
 301     return call_predicate_helper<CompLevel_full_profile>(i, b, 1.0, method);
 302   }
 303   default:
 304     return true;
 305   }
 306 }
 307 
 308 // Determine is a method is mature.
 309 bool SimpleThresholdPolicy::is_mature(Method* method) {
 310   if (is_trivial(method)) return true;
 311   MethodData* mdo = method->method_data();
 312   if (mdo != NULL) {
 313     int i = mdo->invocation_count();
 314     int b = mdo->backedge_count();
 315     double k = ProfileMaturityPercentage / 100.0;
 316     return call_predicate_helper<CompLevel_full_profile>(i, b, k, method) ||
 317            loop_predicate_helper<CompLevel_full_profile>(i, b, k, method);
 318   }
 319   return false;
 320 }
 321 
 322 // Common transition function. Given a predicate determines if a method should transition to another level.
 323 CompLevel SimpleThresholdPolicy::common(Predicate p, Method* method, CompLevel cur_level) {
 324   CompLevel next_level = cur_level;
 325   int i = method->invocation_count();
 326   int b = method->backedge_count();
 327 
 328   if (is_trivial(method)) {
 329     next_level = CompLevel_simple;
 330   } else {
 331     switch(cur_level) {
 332     case CompLevel_none:
 333       // If we were at full profile level, would we switch to full opt?
 334       if (common(p, method, CompLevel_full_profile) == CompLevel_full_optimization) {
 335         next_level = CompLevel_full_optimization;
 336       } else if ((this->*p)(i, b, cur_level, method)) {
 337         next_level = CompLevel_full_profile;
 338       }
 339       break;
 340     case CompLevel_limited_profile:
 341     case CompLevel_full_profile:
 342       {
 343         MethodData* mdo = method->method_data();
 344         if (mdo != NULL) {
 345           if (mdo->would_profile()) {
 346             int mdo_i = mdo->invocation_count_delta();
 347             int mdo_b = mdo->backedge_count_delta();
 348             if ((this->*p)(mdo_i, mdo_b, cur_level, method)) {
 349               next_level = CompLevel_full_optimization;
 350             }
 351           } else {
 352             next_level = CompLevel_full_optimization;
 353           }
 354         }
 355       }
 356       break;
 357     }
 358   }
 359   return MIN2(next_level, (CompLevel)TieredStopAtLevel);
 360 }
 361 
 362 // Determine if a method should be compiled with a normal entry point at a different level.
 363 CompLevel SimpleThresholdPolicy::call_event(Method* method,  CompLevel cur_level, JavaThread* thread) {
 364   CompLevel osr_level = MIN2((CompLevel) method->highest_osr_comp_level(),
 365                              common(&SimpleThresholdPolicy::loop_predicate, method, cur_level));
 366   CompLevel next_level = common(&SimpleThresholdPolicy::call_predicate, method, cur_level);
 367 
 368   // If OSR method level is greater than the regular method level, the levels should be
 369   // equalized by raising the regular method level in order to avoid OSRs during each
 370   // invocation of the method.
 371   if (osr_level == CompLevel_full_optimization && cur_level == CompLevel_full_profile) {
 372     MethodData* mdo = method->method_data();
 373     guarantee(mdo != NULL, "MDO should not be NULL");
 374     if (mdo->invocation_count() >= 1) {
 375       next_level = CompLevel_full_optimization;
 376     }
 377   } else {
 378     next_level = MAX2(osr_level, next_level);
 379   }
 380 #if INCLUDE_JVMCI
 381   if (UseJVMCICompiler) {
 382     next_level = JVMCIRuntime::adjust_comp_level(method, false, next_level, thread);
 383   }
 384 #endif
 385   return next_level;
 386 }
 387 
 388 // Determine if we should do an OSR compilation of a given method.
 389 CompLevel SimpleThresholdPolicy::loop_event(Method* method, CompLevel cur_level, JavaThread* thread) {
 390   CompLevel next_level = common(&SimpleThresholdPolicy::loop_predicate, method, cur_level);
 391   if (cur_level == CompLevel_none) {
 392     // If there is a live OSR method that means that we deopted to the interpreter
 393     // for the transition.
 394     CompLevel osr_level = MIN2((CompLevel)method->highest_osr_comp_level(), next_level);
 395     if (osr_level > CompLevel_none) {
 396       return osr_level;
 397     }
 398   }
 399 #if INCLUDE_JVMCI
 400   if (UseJVMCICompiler) {
 401     next_level = JVMCIRuntime::adjust_comp_level(method, true, next_level, thread);
 402   }
 403 #endif
 404   return next_level;
 405 }
 406 
 407 
 408 // Handle the invocation event.
 409 void SimpleThresholdPolicy::method_invocation_event(const methodHandle& mh, const methodHandle& imh,
 410                                               CompLevel level, CompiledMethod* nm, JavaThread* thread) {
 411   if (is_compilation_enabled() && !CompileBroker::compilation_is_in_queue(mh)) {
 412     CompLevel next_level = call_event(mh(), level, thread);
 413     if (next_level != level) {
 414       compile(mh, InvocationEntryBci, next_level, thread);
 415     }
 416   }
 417 }
 418 
 419 // Handle the back branch event. Notice that we can compile the method
 420 // with a regular entry from here.
 421 void SimpleThresholdPolicy::method_back_branch_event(const methodHandle& mh, const methodHandle& imh,
 422                                                      int bci, CompLevel level, CompiledMethod* nm, JavaThread* thread) {
 423   // If the method is already compiling, quickly bail out.
 424   if (is_compilation_enabled() && !CompileBroker::compilation_is_in_queue(mh)) {
 425     // Use loop event as an opportunity to also check there's been
 426     // enough calls.
 427     CompLevel cur_level = comp_level(mh());
 428     CompLevel next_level = call_event(mh(), cur_level, thread);
 429     CompLevel next_osr_level = loop_event(mh(), level, thread);
 430 
 431     next_level = MAX2(next_level,
 432                       next_osr_level < CompLevel_full_optimization ? next_osr_level : cur_level);
 433     bool is_compiling = false;
 434     if (next_level != cur_level) {
 435       compile(mh, InvocationEntryBci, next_level, thread);
 436       is_compiling = true;
 437     }
 438 
 439     // Do the OSR version
 440     if (!is_compiling && next_osr_level != level) {
 441       compile(mh, bci, next_osr_level, thread);
 442     }
 443   }
 444 }