1 /*
   2  * Copyright (c) 1998, 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_COMPILETASK_HPP
  26 #define SHARE_VM_COMPILER_COMPILETASK_HPP
  27 
  28 #include "code/nmethod.hpp"
  29 #include "ci/ciMethod.hpp"
  30 #include "compiler/compileLog.hpp"
  31 #include "memory/allocation.inline.hpp"
  32 #include "utilities/xmlstream.hpp"
  33 
  34 // CompileTask
  35 //
  36 // An entry in the compile queue.  It represents a pending or current
  37 // compilation.
  38 
  39 class CompileTask : public CHeapObj<mtCompiler> {
  40   friend class VMStructs;
  41   friend class JVMCIVMStructs;
  42 
  43  private:
  44   static CompileTask* _task_free_list;
  45 #ifdef ASSERT
  46   static int          _num_allocated_tasks;
  47 #endif
  48 
  49   Monitor*     _lock;
  50   uint         _compile_id;
  51   Method*      _method;
  52   jobject      _method_holder;
  53   int          _osr_bci;
  54   bool         _is_complete;
  55   bool         _is_success;
  56   bool         _is_blocking;
  57 #if INCLUDE_JVMCI
  58   bool         _has_waiter;
  59   // Compiler thread for a blocking JVMCI compilation
  60   CompilerThread* _jvmci_compiler_thread;
  61 #endif
  62   int          _comp_level;
  63   int          _num_inlined_bytecodes;
  64   nmethodLocker* _code_handle;  // holder of eventual result
  65   CompileTask* _next, *_prev;
  66   bool         _is_free;
  67   // Fields used for logging why the compilation was initiated:
  68   jlong        _time_queued;  // in units of os::elapsed_counter()
  69   Method*      _hot_method;   // which method actually triggered this task
  70   jobject      _hot_method_holder;
  71   int          _hot_count;    // information about its invocation counter
  72   const char*  _comment;      // more info about the task
  73   const char*  _failure_reason;
  74 
  75  public:
  76   CompileTask() {
  77     _lock = new Monitor(Mutex::nonleaf+2, "CompileTaskLock");
  78   }
  79 
  80   void initialize(int compile_id, const methodHandle& method, int osr_bci, int comp_level,
  81                   const methodHandle& hot_method, int hot_count, const char* comment,
  82                   bool is_blocking);
  83 
  84   static CompileTask* allocate();
  85   static void         free(CompileTask* task);
  86 
  87   int          compile_id() const                { return _compile_id; }
  88   Method*      method() const                    { return _method; }
  89   Method*      hot_method() const                { return _hot_method; }
  90   int          osr_bci() const                   { return _osr_bci; }
  91   bool         is_complete() const               { return _is_complete; }
  92   bool         is_blocking() const               { return _is_blocking; }
  93   bool         is_success() const                { return _is_success; }
  94 #if INCLUDE_JVMCI
  95   bool         has_waiter() const                { return _has_waiter; }
  96   void         clear_waiter()                    { _has_waiter = false; }
  97   CompilerThread* jvmci_compiler_thread() const  { return _jvmci_compiler_thread; }
  98   void         set_jvmci_compiler_thread(CompilerThread* t) {
  99     assert(is_blocking(), "must be");
 100     assert((t == NULL) != (_jvmci_compiler_thread == NULL), "must be");
 101     _jvmci_compiler_thread = t;
 102   }
 103 #endif
 104 
 105   nmethodLocker* code_handle() const             { return _code_handle; }
 106   void         set_code_handle(nmethodLocker* l) { _code_handle = l; }
 107   nmethod*     code() const;                     // _code_handle->code()
 108   void         set_code(nmethod* nm);            // _code_handle->set_code(nm)
 109 
 110   Monitor*     lock() const                      { return _lock; }
 111 
 112   void         mark_complete()                   { _is_complete = true; }
 113   void         mark_success()                    { _is_success = true; }
 114 
 115   int          comp_level()                      { return _comp_level;}
 116   void         set_comp_level(int comp_level)    { _comp_level = comp_level;}
 117 
 118   int          num_inlined_bytecodes() const     { return _num_inlined_bytecodes; }
 119   void         set_num_inlined_bytecodes(int n)  { _num_inlined_bytecodes = n; }
 120 
 121   CompileTask* next() const                      { return _next; }
 122   void         set_next(CompileTask* next)       { _next = next; }
 123   CompileTask* prev() const                      { return _prev; }
 124   void         set_prev(CompileTask* prev)       { _prev = prev; }
 125   bool         is_free() const                   { return _is_free; }
 126   void         set_is_free(bool val)             { _is_free = val; }
 127 
 128   // RedefineClasses support
 129   void         metadata_do(void f(Metadata*));
 130   void         mark_on_stack();
 131 
 132 private:
 133   static void  print_impl(outputStream* st, Method* method, int compile_id, int comp_level,
 134                                       bool is_osr_method = false, int osr_bci = -1, bool is_blocking = false,
 135                                       const char* msg = NULL, bool short_form = false, bool cr = true);
 136 
 137 public:
 138   void         print(outputStream* st = tty, const char* msg = NULL, bool short_form = false, bool cr = true);
 139   static void  print(outputStream* st, const nmethod* nm, const char* msg = NULL, bool short_form = false, bool cr = true) {
 140     print_impl(st, nm->method(), nm->compile_id(), nm->comp_level(),
 141                            nm->is_osr_method(), nm->is_osr_method() ? nm->osr_entry_bci() : -1, /*is_blocking*/ false,
 142                            msg, short_form, cr);
 143   }
 144 
 145   static void  print_inline_indent(int inline_level, outputStream* st = tty);
 146 
 147   void         print_tty();
 148   void         print_line_on_error(outputStream* st, char* buf, int buflen);
 149 
 150   void         log_task(xmlStream* log);
 151   void         log_task_queued();
 152   void         log_task_dequeued(const char* comment);
 153   void         log_task_start(CompileLog* log);
 154   void         log_task_done(CompileLog* log);
 155 
 156   void         set_failure_reason(const char* reason) {
 157     _failure_reason = reason;
 158   }
 159 
 160   bool         check_break_at_flags();
 161 
 162   static void print_inlining_inner(outputStream* st, ciMethod* method, int inline_level, int bci, const char* msg = NULL);
 163   static void print_inlining_tty(ciMethod* method, int inline_level, int bci, const char* msg = NULL) {
 164     print_inlining_inner(tty, method, inline_level, bci, msg);
 165   }
 166 };
 167 
 168 #endif // SHARE_VM_COMPILER_COMPILETASK_HPP