1 /*
   2  * Copyright (c) 1999, 2015, 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 #ifndef SHARE_VM_COMPILER_COMPILEBROKER_HPP
  26 #define SHARE_VM_COMPILER_COMPILEBROKER_HPP
  27 
  28 #include "ci/compilerInterface.hpp"
  29 #include "compiler/abstractCompiler.hpp"
  30 #include "compiler/compileTask.hpp"
  31 #include "runtime/perfData.hpp"
  32 
  33 class nmethod;
  34 class nmethodLocker;
  35 
  36 // CompilerCounters
  37 //
  38 // Per Compiler Performance Counters.
  39 //
  40 class CompilerCounters : public CHeapObj<mtCompiler> {
  41 
  42   public:
  43     enum {
  44       cmname_buffer_length = 160
  45     };
  46 
  47   private:
  48 
  49     char _current_method[cmname_buffer_length];
  50     PerfStringVariable* _perf_current_method;
  51 
  52     int  _compile_type;
  53     PerfVariable* _perf_compile_type;
  54 
  55     PerfCounter* _perf_time;
  56     PerfCounter* _perf_compiles;
  57 
  58   public:
  59     CompilerCounters(const char* name, int instance, TRAPS);
  60 
  61     // these methods should be called in a thread safe context
  62 
  63     void set_current_method(const char* method) {
  64       strncpy(_current_method, method, (size_t)cmname_buffer_length-1);
  65       _current_method[cmname_buffer_length-1] = '\0';
  66       if (UsePerfData) _perf_current_method->set_value(method);
  67     }
  68 
  69     char* current_method()                  { return _current_method; }
  70 
  71     void set_compile_type(int compile_type) {
  72       _compile_type = compile_type;
  73       if (UsePerfData) _perf_compile_type->set_value((jlong)compile_type);
  74     }
  75 
  76     int compile_type()                       { return _compile_type; }
  77 
  78     PerfCounter* time_counter()              { return _perf_time; }
  79     PerfCounter* compile_counter()           { return _perf_compiles; }
  80 };
  81 
  82 // CompileQueue
  83 //
  84 // A list of CompileTasks.
  85 class CompileQueue : public CHeapObj<mtCompiler> {
  86  private:
  87   const char* _name;
  88 
  89   CompileTask* _first;
  90   CompileTask* _last;
  91 
  92   CompileTask* _first_stale;
  93 
  94   int _size;
  95 
  96   void purge_stale_tasks();
  97  public:
  98   CompileQueue(const char* name) {
  99     _name = name;
 100     _first = NULL;
 101     _last = NULL;
 102     _size = 0;
 103     _first_stale = NULL;
 104   }
 105 
 106   const char*  name() const                      { return _name; }
 107 
 108   void         add(CompileTask* task);
 109   void         remove(CompileTask* task);
 110   void         remove_and_mark_stale(CompileTask* task);
 111   CompileTask* first()                           { return _first; }
 112   CompileTask* last()                            { return _last;  }
 113 
 114   CompileTask* get();
 115 
 116   bool         is_empty() const                  { return _first == NULL; }
 117   int          size()     const                  { return _size;          }
 118 
 119 
 120   // Redefine Classes support
 121   void mark_on_stack();
 122   void free_all();
 123   void print_tty();
 124   void print(outputStream* st = tty);
 125 
 126   ~CompileQueue() {
 127     assert (is_empty(), " Compile Queue must be empty");
 128   }
 129 };
 130 
 131 // CompileTaskWrapper
 132 //
 133 // Assign this task to the current thread.  Deallocate the task
 134 // when the compilation is complete.
 135 class CompileTaskWrapper : StackObj {
 136 public:
 137   CompileTaskWrapper(CompileTask* task);
 138   ~CompileTaskWrapper();
 139 };
 140 
 141 
 142 // Compilation
 143 //
 144 // The broker for all compilation requests.
 145 class CompileBroker: AllStatic {
 146  friend class Threads;
 147   friend class CompileTaskWrapper;
 148 
 149  public:
 150   enum {
 151     name_buffer_length = 100
 152   };
 153 
 154   // Compile type Information for print_last_compile() and CompilerCounters
 155   enum { no_compile, normal_compile, osr_compile, native_compile };
 156   static int assign_compile_id (methodHandle method, int osr_bci);
 157 
 158 
 159  private:
 160   static bool _initialized;
 161   static volatile bool _should_block;
 162 
 163   // This flag can be used to stop compilation or turn it back on
 164   static volatile jint _should_compile_new_jobs;
 165 
 166   // The installed compiler(s)
 167   static AbstractCompiler* _compilers[2];
 168 
 169   // These counters are used for assigning id's to each compilation
 170   static volatile jint _compilation_id;
 171   static volatile jint _osr_compilation_id;
 172 
 173   static int  _last_compile_type;
 174   static int  _last_compile_level;
 175   static char _last_method_compiled[name_buffer_length];
 176 
 177   static CompileQueue* _c2_compile_queue;
 178   static CompileQueue* _c1_compile_queue;
 179 
 180   // performance counters
 181   static PerfCounter* _perf_total_compilation;
 182   static PerfCounter* _perf_native_compilation;
 183   static PerfCounter* _perf_osr_compilation;
 184   static PerfCounter* _perf_standard_compilation;
 185 
 186   static PerfCounter* _perf_total_bailout_count;
 187   static PerfCounter* _perf_total_invalidated_count;
 188   static PerfCounter* _perf_total_compile_count;
 189   static PerfCounter* _perf_total_native_compile_count;
 190   static PerfCounter* _perf_total_osr_compile_count;
 191   static PerfCounter* _perf_total_standard_compile_count;
 192 
 193   static PerfCounter* _perf_sum_osr_bytes_compiled;
 194   static PerfCounter* _perf_sum_standard_bytes_compiled;
 195   static PerfCounter* _perf_sum_nmethod_size;
 196   static PerfCounter* _perf_sum_nmethod_code_size;
 197 
 198   static PerfStringVariable* _perf_last_method;
 199   static PerfStringVariable* _perf_last_failed_method;
 200   static PerfStringVariable* _perf_last_invalidated_method;
 201   static PerfVariable*       _perf_last_compile_type;
 202   static PerfVariable*       _perf_last_compile_size;
 203   static PerfVariable*       _perf_last_failed_type;
 204   static PerfVariable*       _perf_last_invalidated_type;
 205 
 206   // Timers and counters for generating statistics
 207   static elapsedTimer _t_total_compilation;
 208   static elapsedTimer _t_osr_compilation;
 209   static elapsedTimer _t_standard_compilation;
 210   static elapsedTimer _t_invalidated_compilation;
 211   static elapsedTimer _t_bailedout_compilation;
 212 
 213   static int _total_compile_count;
 214   static int _total_bailout_count;
 215   static int _total_invalidated_count;
 216   static int _total_native_compile_count;
 217   static int _total_osr_compile_count;
 218   static int _total_standard_compile_count;
 219   static int _sum_osr_bytes_compiled;
 220   static int _sum_standard_bytes_compiled;
 221   static int _sum_nmethod_size;
 222   static int _sum_nmethod_code_size;
 223   static long _peak_compilation_time;
 224 
 225   static volatile jint _print_compilation_warning;
 226 
 227   static JavaThread* make_thread(const char* name, CompileQueue* queue, CompilerCounters* counters, AbstractCompiler* comp, bool compiler_thread, TRAPS);
 228   static void init_compiler_sweeper_threads(int c1_compiler_count, int c2_compiler_count);
 229   static bool compilation_is_complete  (methodHandle method, int osr_bci, int comp_level);
 230   static bool compilation_is_prohibited(methodHandle method, int osr_bci, int comp_level);
 231   static bool is_compile_blocking();
 232   static void preload_classes          (methodHandle method, TRAPS);
 233 
 234   static CompileTask* create_compile_task(CompileQueue* queue,
 235                                           int           compile_id,
 236                                           methodHandle  method,
 237                                           int           osr_bci,
 238                                           int           comp_level,
 239                                           methodHandle  hot_method,
 240                                           int           hot_count,
 241                                           const char*   comment,
 242                                           bool          blocking);
 243   static void wait_for_completion(CompileTask* task);
 244 
 245   static void invoke_compiler_on_method(CompileTask* task);
 246   static void set_last_compile(CompilerThread *thread, methodHandle method, bool is_osr, int comp_level);
 247   static void push_jni_handle_block();
 248   static void pop_jni_handle_block();
 249   static bool check_break_at(methodHandle method, int compile_id, bool is_osr);
 250   static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task);
 251 
 252   static void compile_method_base(methodHandle method,
 253                                   int osr_bci,
 254                                   int comp_level,
 255                                   methodHandle hot_method,
 256                                   int hot_count,
 257                                   const char* comment,
 258                                   Thread* thread);
 259 
 260   static CompileQueue* compile_queue(int comp_level);
 261   static bool init_compiler_runtime();
 262   static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread);
 263 
 264  public:
 265   enum {
 266     // The entry bci used for non-OSR compilations.
 267     standard_entry_bci = InvocationEntryBci
 268   };
 269 
 270   static AbstractCompiler* compiler(int comp_level) {
 271     if (is_c2_compile(comp_level)) return _compilers[1]; // C2
 272     if (is_c1_compile(comp_level)) return _compilers[0]; // C1
 273     return NULL;
 274   }
 275 
 276   static bool compilation_is_in_queue(methodHandle method);
 277   static void print_compile_queues(outputStream* st);
 278   static int queue_size(int comp_level) {
 279     CompileQueue *q = compile_queue(comp_level);
 280     return q != NULL ? q->size() : 0;
 281   }
 282   static void compilation_init();
 283   static void init_compiler_thread_log();
 284   static nmethod* compile_method(methodHandle method,
 285                                  int osr_bci,
 286                                  int comp_level,
 287                                  methodHandle hot_method,
 288                                  int hot_count,
 289                                  const char* comment, Thread* thread);
 290 
 291   static void compiler_thread_loop();
 292   static uint get_compilation_id() { return _compilation_id; }
 293 
 294   // Set _should_block.
 295   // Call this from the VM, with Threads_lock held and a safepoint requested.
 296   static void set_should_block();
 297 
 298   // Call this from the compiler at convenient points, to poll for _should_block.
 299   static void maybe_block();
 300 
 301   enum {
 302     // Flags for toggling compiler activity
 303     stop_compilation    = 0,
 304     run_compilation     = 1,
 305     shutdown_compilaton = 2
 306   };
 307 
 308   static jint get_compilation_activity_mode() { return _should_compile_new_jobs; }
 309   static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); }
 310   static bool set_should_compile_new_jobs(jint new_state) {
 311     // Return success if the current caller set it
 312     jint old = Atomic::cmpxchg(new_state, &_should_compile_new_jobs, 1-new_state);
 313     return (old == (1-new_state));
 314   }
 315 
 316   static void disable_compilation_forever() {
 317     UseCompiler               = false;
 318     AlwaysCompileLoopMethods  = false;
 319     Atomic::xchg(shutdown_compilaton, &_should_compile_new_jobs);
 320   }
 321 
 322   static bool is_compilation_disabled_forever() {
 323     return _should_compile_new_jobs == shutdown_compilaton;
 324   }
 325   static void handle_full_code_cache(int code_blob_type);
 326   // Ensures that warning is only printed once.
 327   static bool should_print_compiler_warning() {
 328     jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0);
 329     return old == 0;
 330   }
 331   // Return total compilation ticks
 332   static jlong total_compilation_ticks() {
 333     return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0;
 334   }
 335 
 336   // Redefine Classes support
 337   static void mark_on_stack();
 338 
 339   // Print a detailed accounting of compilation time
 340   static void print_times();
 341 
 342   // Debugging output for failure
 343   static void print_last_compile();
 344 
 345   static void print_compiler_threads_on(outputStream* st);
 346 
 347   // compiler name for debugging
 348   static const char* compiler_name(int comp_level);
 349 
 350   static int get_total_compile_count() {          return _total_compile_count; }
 351   static int get_total_bailout_count() {          return _total_bailout_count; }
 352   static int get_total_invalidated_count() {      return _total_invalidated_count; }
 353   static int get_total_native_compile_count() {   return _total_native_compile_count; }
 354   static int get_total_osr_compile_count() {      return _total_osr_compile_count; }
 355   static int get_total_standard_compile_count() { return _total_standard_compile_count; }
 356   static int get_sum_osr_bytes_compiled() {       return _sum_osr_bytes_compiled; }
 357   static int get_sum_standard_bytes_compiled() {  return _sum_standard_bytes_compiled; }
 358   static int get_sum_nmethod_size() {             return _sum_nmethod_size;}
 359   static int get_sum_nmethod_code_size() {        return _sum_nmethod_code_size; }
 360   static long get_peak_compilation_time() {       return _peak_compilation_time; }
 361   static long get_total_compilation_time() {      return _t_total_compilation.milliseconds(); }
 362 
 363   // Log that compilation profiling is skipped because metaspace is full.
 364   static void log_metaspace_failure();
 365 };
 366 
 367 #endif // SHARE_VM_COMPILER_COMPILEBROKER_HPP