1 /*
   2  * Copyright (c) 1999, 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 #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 "runtime/perfData.hpp"
  31 
  32 class nmethod;
  33 class nmethodLocker;
  34 
  35 // CompileTask
  36 //
  37 // An entry in the compile queue.  It represents a pending or current
  38 // compilation.
  39 class CompileTask : public CHeapObj<mtCompiler> {
  40   friend class VMStructs;
  41 
  42  private:
  43   static CompileTask* _task_free_list;
  44 #ifdef ASSERT
  45   static int          _num_allocated_tasks;
  46 #endif
  47 
  48   Monitor*     _lock;
  49   uint         _compile_id;
  50   Method*      _method;
  51   jobject      _method_holder;
  52   int          _osr_bci;
  53   bool         _is_complete;
  54   bool         _is_success;
  55   bool         _is_blocking;
  56   int          _comp_level;
  57   int          _num_inlined_bytecodes;
  58   nmethodLocker* _code_handle;  // holder of eventual result
  59   CompileTask* _next, *_prev;
  60   bool         _is_free;
  61   // Fields used for logging why the compilation was initiated:
  62   jlong        _time_queued;  // in units of os::elapsed_counter()
  63   Method*      _hot_method;   // which method actually triggered this task
  64   jobject      _hot_method_holder;
  65   int          _hot_count;    // information about its invocation counter
  66   const char*  _comment;      // more info about the task
  67   const char*  _failure_reason;
  68 
  69  public:
  70   CompileTask() {
  71     _lock = new Monitor(Mutex::nonleaf+2, "CompileTaskLock");
  72   }
  73 
  74   void initialize(int compile_id, methodHandle method, int osr_bci, int comp_level,
  75                   methodHandle hot_method, int hot_count, const char* comment,
  76                   bool is_blocking);
  77 
  78   static CompileTask* allocate();
  79   static void         free(CompileTask* task);
  80 
  81   int          compile_id() const                { return _compile_id; }
  82   Method*      method() const                    { return _method; }
  83   int          osr_bci() const                   { return _osr_bci; }
  84   bool         is_complete() const               { return _is_complete; }
  85   bool         is_blocking() const               { return _is_blocking; }
  86   bool         is_success() const                { return _is_success; }
  87 
  88   nmethodLocker* code_handle() const             { return _code_handle; }
  89   void         set_code_handle(nmethodLocker* l) { _code_handle = l; }
  90   nmethod*     code() const;                     // _code_handle->code()
  91   void         set_code(nmethod* nm);            // _code_handle->set_code(nm)
  92 
  93   Monitor*     lock() const                      { return _lock; }
  94 
  95   void         mark_complete()                   { _is_complete = true; }
  96   void         mark_success()                    { _is_success = true; }
  97 
  98   int          comp_level()                      { return _comp_level;}
  99   void         set_comp_level(int comp_level)    { _comp_level = comp_level;}
 100 
 101   int          num_inlined_bytecodes() const     { return _num_inlined_bytecodes; }
 102   void         set_num_inlined_bytecodes(int n)  { _num_inlined_bytecodes = n; }
 103 
 104   CompileTask* next() const                      { return _next; }
 105   void         set_next(CompileTask* next)       { _next = next; }
 106   CompileTask* prev() const                      { return _prev; }
 107   void         set_prev(CompileTask* prev)       { _prev = prev; }
 108   bool         is_free() const                   { return _is_free; }
 109   void         set_is_free(bool val)             { _is_free = val; }
 110 
 111 private:
 112   static void  print_compilation_impl(outputStream* st, Method* method, int compile_id, int comp_level,
 113                                       bool is_osr_method = false, int osr_bci = -1, bool is_blocking = false,
 114                                       const char* msg = NULL, bool short_form = false, bool cr = true);
 115 
 116 public:
 117   void         print_compilation(outputStream* st = tty, const char* msg = NULL, bool short_form = false, bool cr = true);
 118   static void  print_compilation(outputStream* st, const nmethod* nm, const char* msg = NULL, bool short_form = false, bool cr = true) {
 119     print_compilation_impl(st, nm->method(), nm->compile_id(), nm->comp_level(),
 120                            nm->is_osr_method(), nm->is_osr_method() ? nm->osr_entry_bci() : -1, /*is_blocking*/ false,
 121                            msg, short_form, cr);
 122   }
 123 
 124   static void  print_inlining(outputStream* st, ciMethod* method, int inline_level, int bci, const char* msg = NULL);
 125   static void  print_inlining(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
 126     print_inlining(tty, method, inline_level, bci, msg);
 127   }
 128 
 129   // Redefine Classes support
 130   void mark_on_stack();
 131 
 132   static void  print_inline_indent(int inline_level, outputStream* st = tty);
 133 
 134   void         print_tty();
 135   void         print_line_on_error(outputStream* st, char* buf, int buflen);
 136 
 137   void         log_task(xmlStream* log);
 138   void         log_task_queued();
 139   void         log_task_start(CompileLog* log);
 140   void         log_task_done(CompileLog* log);
 141 
 142   void         set_failure_reason(const char* reason) {
 143     _failure_reason = reason;
 144   }
 145 };
 146 
 147 // CompilerCounters
 148 //
 149 // Per Compiler Performance Counters.
 150 //
 151 class CompilerCounters : public CHeapObj<mtCompiler> {
 152 
 153   public:
 154     enum {
 155       cmname_buffer_length = 160
 156     };
 157 
 158   private:
 159 
 160     char _current_method[cmname_buffer_length];
 161     PerfStringVariable* _perf_current_method;
 162 
 163     int  _compile_type;
 164     PerfVariable* _perf_compile_type;
 165 
 166     PerfCounter* _perf_time;
 167     PerfCounter* _perf_compiles;
 168 
 169   public:
 170     CompilerCounters(const char* name, int instance, TRAPS);
 171 
 172     // these methods should be called in a thread safe context
 173 
 174     void set_current_method(const char* method) {
 175       strncpy(_current_method, method, (size_t)cmname_buffer_length);
 176       if (UsePerfData) _perf_current_method->set_value(method);
 177     }
 178 
 179     char* current_method()                  { return _current_method; }
 180 
 181     void set_compile_type(int compile_type) {
 182       _compile_type = compile_type;
 183       if (UsePerfData) _perf_compile_type->set_value((jlong)compile_type);
 184     }
 185 
 186     int compile_type()                       { return _compile_type; }
 187 
 188     PerfCounter* time_counter()              { return _perf_time; }
 189     PerfCounter* compile_counter()           { return _perf_compiles; }
 190 };
 191 
 192 // CompileQueue
 193 //
 194 // A list of CompileTasks.
 195 class CompileQueue : public CHeapObj<mtCompiler> {
 196  private:
 197   const char* _name;
 198   Monitor*    _lock;
 199 
 200   CompileTask* _first;
 201   CompileTask* _last;
 202 
 203   CompileTask* _first_stale;
 204 
 205   int _size;
 206 
 207   void purge_stale_tasks();
 208  public:
 209   CompileQueue(const char* name, Monitor* lock) {
 210     _name = name;
 211     _lock = lock;
 212     _first = NULL;
 213     _last = NULL;
 214     _size = 0;
 215     _first_stale = NULL;
 216   }
 217 
 218   const char*  name() const                      { return _name; }
 219   Monitor*     lock() const                      { return _lock; }
 220 
 221   void         add(CompileTask* task);
 222   void         remove(CompileTask* task);
 223   void         remove_and_mark_stale(CompileTask* task);
 224   CompileTask* first()                           { return _first; }
 225   CompileTask* last()                            { return _last;  }
 226 
 227   CompileTask* get();
 228 
 229   bool         is_empty() const                  { return _first == NULL; }
 230   int          size()     const                  { return _size;          }
 231 
 232 
 233   // Redefine Classes support
 234   void mark_on_stack();
 235   void free_all();
 236   void print_tty();
 237   void print(outputStream* st = tty);
 238 
 239   ~CompileQueue() {
 240     assert (is_empty(), " Compile Queue must be empty");
 241   }
 242 };
 243 
 244 // CompileTaskWrapper
 245 //
 246 // Assign this task to the current thread.  Deallocate the task
 247 // when the compilation is complete.
 248 class CompileTaskWrapper : StackObj {
 249 public:
 250   CompileTaskWrapper(CompileTask* task);
 251   ~CompileTaskWrapper();
 252 };
 253 
 254 
 255 // Compilation
 256 //
 257 // The broker for all compilation requests.
 258 class CompileBroker: AllStatic {
 259  friend class Threads;
 260   friend class CompileTaskWrapper;
 261 
 262  public:
 263   enum {
 264     name_buffer_length = 100
 265   };
 266 
 267   // Compile type Information for print_last_compile() and CompilerCounters
 268   enum { no_compile, normal_compile, osr_compile, native_compile };
 269   static int assign_compile_id (methodHandle method, int osr_bci);
 270 
 271 
 272  private:
 273   static bool _initialized;
 274   static volatile bool _should_block;
 275 
 276   // This flag can be used to stop compilation or turn it back on
 277   static volatile jint _should_compile_new_jobs;
 278 
 279   // The installed compiler(s)
 280   static AbstractCompiler* _compilers[2];
 281 
 282   // These counters are used for assigning id's to each compilation
 283   static volatile jint _compilation_id;
 284   static volatile jint _osr_compilation_id;
 285 
 286   static int  _last_compile_type;
 287   static int  _last_compile_level;
 288   static char _last_method_compiled[name_buffer_length];
 289 
 290   static CompileQueue* _c2_compile_queue;
 291   static CompileQueue* _c1_compile_queue;
 292 
 293   static GrowableArray<CompilerThread*>* _compiler_threads;
 294 
 295   // performance counters
 296   static PerfCounter* _perf_total_compilation;
 297   static PerfCounter* _perf_native_compilation;
 298   static PerfCounter* _perf_osr_compilation;
 299   static PerfCounter* _perf_standard_compilation;
 300 
 301   static PerfCounter* _perf_total_bailout_count;
 302   static PerfCounter* _perf_total_invalidated_count;
 303   static PerfCounter* _perf_total_compile_count;
 304   static PerfCounter* _perf_total_native_compile_count;
 305   static PerfCounter* _perf_total_osr_compile_count;
 306   static PerfCounter* _perf_total_standard_compile_count;
 307 
 308   static PerfCounter* _perf_sum_osr_bytes_compiled;
 309   static PerfCounter* _perf_sum_standard_bytes_compiled;
 310   static PerfCounter* _perf_sum_nmethod_size;
 311   static PerfCounter* _perf_sum_nmethod_code_size;
 312 
 313   static PerfStringVariable* _perf_last_method;
 314   static PerfStringVariable* _perf_last_failed_method;
 315   static PerfStringVariable* _perf_last_invalidated_method;
 316   static PerfVariable*       _perf_last_compile_type;
 317   static PerfVariable*       _perf_last_compile_size;
 318   static PerfVariable*       _perf_last_failed_type;
 319   static PerfVariable*       _perf_last_invalidated_type;
 320 
 321   // Timers and counters for generating statistics
 322   static elapsedTimer _t_total_compilation;
 323   static elapsedTimer _t_osr_compilation;
 324   static elapsedTimer _t_standard_compilation;
 325   static elapsedTimer _t_invalidated_compilation;
 326   static elapsedTimer _t_bailedout_compilation;
 327 
 328 
 329   static int _total_compile_count;
 330   static int _total_bailout_count;
 331   static int _total_invalidated_count;
 332   static int _total_native_compile_count;
 333   static int _total_osr_compile_count;
 334   static int _total_standard_compile_count;
 335   static int _sum_osr_bytes_compiled;
 336   static int _sum_standard_bytes_compiled;
 337   static int _sum_nmethod_size;
 338   static int _sum_nmethod_code_size;
 339   static long _peak_compilation_time;
 340 
 341   static volatile jint _print_compilation_warning;
 342 
 343   static CompilerThread* make_compiler_thread(const char* name, CompileQueue* queue, CompilerCounters* counters, AbstractCompiler* comp, TRAPS);
 344   static void init_compiler_threads(int c1_compiler_count, int c2_compiler_count);
 345   static bool compilation_is_complete  (methodHandle method, int osr_bci, int comp_level);
 346   static bool compilation_is_prohibited(methodHandle method, int osr_bci, int comp_level);
 347   static bool is_compile_blocking();
 348   static void preload_classes          (methodHandle method, TRAPS);
 349 
 350   static CompileTask* create_compile_task(CompileQueue* queue,
 351                                           int           compile_id,
 352                                           methodHandle  method,
 353                                           int           osr_bci,
 354                                           int           comp_level,
 355                                           methodHandle  hot_method,
 356                                           int           hot_count,
 357                                           const char*   comment,
 358                                           bool          blocking);
 359   static void wait_for_completion(CompileTask* task);
 360 
 361   static void invoke_compiler_on_method(CompileTask* task);
 362   static void set_last_compile(CompilerThread *thread, methodHandle method, bool is_osr, int comp_level);
 363   static void push_jni_handle_block();
 364   static void pop_jni_handle_block();
 365   static bool check_break_at(methodHandle method, int compile_id, bool is_osr);
 366   static void collect_statistics(CompilerThread* thread, elapsedTimer time, CompileTask* task);
 367 
 368   static void compile_method_base(methodHandle method,
 369                                   int osr_bci,
 370                                   int comp_level,
 371                                   methodHandle hot_method,
 372                                   int hot_count,
 373                                   const char* comment,
 374                                   Thread* thread);
 375 
 376   static CompileQueue* compile_queue(int comp_level);
 377   static bool init_compiler_runtime();
 378   static void shutdown_compiler_runtime(AbstractCompiler* comp, CompilerThread* thread);
 379 
 380  public:
 381   enum {
 382     // The entry bci used for non-OSR compilations.
 383     standard_entry_bci = InvocationEntryBci
 384   };
 385 
 386   static AbstractCompiler* compiler(int comp_level) {
 387     if (is_c2_compile(comp_level)) return _compilers[1]; // C2
 388     if (is_c1_compile(comp_level)) return _compilers[0]; // C1
 389     return NULL;
 390   }
 391 
 392   static bool compilation_is_in_queue(methodHandle method);
 393   static void print_compile_queues(outputStream* st);
 394   static int queue_size(int comp_level) {
 395     CompileQueue *q = compile_queue(comp_level);
 396     return q != NULL ? q->size() : 0;
 397   }
 398   static void compilation_init();
 399   static void init_compiler_thread_log();
 400   static nmethod* compile_method(methodHandle method,
 401                                  int osr_bci,
 402                                  int comp_level,
 403                                  methodHandle hot_method,
 404                                  int hot_count,
 405                                  const char* comment, Thread* thread);
 406 
 407   static void compiler_thread_loop();
 408   static uint get_compilation_id() { return _compilation_id; }
 409 
 410   // Set _should_block.
 411   // Call this from the VM, with Threads_lock held and a safepoint requested.
 412   static void set_should_block();
 413 
 414   // Call this from the compiler at convenient points, to poll for _should_block.
 415   static void maybe_block();
 416 
 417   enum {
 418     // Flags for toggling compiler activity
 419     stop_compilation    = 0,
 420     run_compilation     = 1,
 421     shutdown_compilaton = 2
 422   };
 423 
 424   static bool should_compile_new_jobs() { return UseCompiler && (_should_compile_new_jobs == run_compilation); }
 425   static bool set_should_compile_new_jobs(jint new_state) {
 426     // Return success if the current caller set it
 427     jint old = Atomic::cmpxchg(new_state, &_should_compile_new_jobs, 1-new_state);
 428     return (old == (1-new_state));
 429   }
 430 
 431   static void disable_compilation_forever() {
 432     UseCompiler               = false;
 433     AlwaysCompileLoopMethods  = false;
 434     Atomic::xchg(shutdown_compilaton, &_should_compile_new_jobs);
 435   }
 436 
 437   static bool is_compilation_disabled_forever() {
 438     return _should_compile_new_jobs == shutdown_compilaton;
 439   }
 440   static void handle_full_code_cache();
 441   // Ensures that warning is only printed once.
 442   static bool should_print_compiler_warning() {
 443     jint old = Atomic::cmpxchg(1, &_print_compilation_warning, 0);
 444     return old == 0;
 445   }
 446   // Return total compilation ticks
 447   static jlong total_compilation_ticks() {
 448     return _perf_total_compilation != NULL ? _perf_total_compilation->get_value() : 0;
 449   }
 450 
 451   // Redefine Classes support
 452   static void mark_on_stack();
 453 
 454   // Print a detailed accounting of compilation time
 455   static void print_times();
 456 
 457   // Debugging output for failure
 458   static void print_last_compile();
 459 
 460   static void print_compiler_threads_on(outputStream* st);
 461 
 462   // compiler name for debugging
 463   static const char* compiler_name(int comp_level);
 464 
 465   static int get_total_compile_count() {          return _total_compile_count; }
 466   static int get_total_bailout_count() {          return _total_bailout_count; }
 467   static int get_total_invalidated_count() {      return _total_invalidated_count; }
 468   static int get_total_native_compile_count() {   return _total_native_compile_count; }
 469   static int get_total_osr_compile_count() {      return _total_osr_compile_count; }
 470   static int get_total_standard_compile_count() { return _total_standard_compile_count; }
 471   static int get_sum_osr_bytes_compiled() {       return _sum_osr_bytes_compiled; }
 472   static int get_sum_standard_bytes_compiled() {  return _sum_standard_bytes_compiled; }
 473   static int get_sum_nmethod_size() {             return _sum_nmethod_size;}
 474   static int get_sum_nmethod_code_size() {        return _sum_nmethod_code_size; }
 475   static long get_peak_compilation_time() {       return _peak_compilation_time; }
 476   static long get_total_compilation_time() {      return _t_total_compilation.milliseconds(); }
 477 };
 478 
 479 #endif // SHARE_VM_COMPILER_COMPILEBROKER_HPP