1 /*
   2  * Copyright (c) 2000, 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_RUNTIME_COMPILATIONPOLICY_HPP
  26 #define SHARE_VM_RUNTIME_COMPILATIONPOLICY_HPP
  27 
  28 #include "code/nmethod.hpp"
  29 #include "compiler/compileBroker.hpp"
  30 #include "memory/allocation.hpp"
  31 #include "runtime/vm_operations.hpp"
  32 #include "utilities/growableArray.hpp"
  33 
  34 // The CompilationPolicy selects which method (if any) should be compiled.
  35 // It also decides which methods must always be compiled (i.e., are never
  36 // interpreted).
  37 class CompileTask;
  38 class CompileQueue;
  39 
  40 class CompilationPolicy : public CHeapObj<mtCompiler> {
  41   static CompilationPolicy* _policy;
  42   // Accumulated time
  43   static elapsedTimer       _accumulated_time;
  44 
  45   static bool               _in_vm_startup;
  46 public:
  47   static  void set_in_vm_startup(bool in_vm_startup) { _in_vm_startup = in_vm_startup; }
  48   static  void completed_vm_startup();
  49   static  bool delay_compilation_during_startup()    { return _in_vm_startup; }
  50 
  51   // m must be compiled before executing it
  52   static bool must_be_compiled(methodHandle m, int comp_level = CompLevel_all);
  53   // m is allowed to be compiled
  54   static bool can_be_compiled(methodHandle m, int comp_level = CompLevel_all);
  55   // m is allowed to be osr compiled
  56   static bool can_be_osr_compiled(methodHandle m, int comp_level = CompLevel_all);
  57   static bool is_compilation_enabled();
  58   static void set_policy(CompilationPolicy* policy) { _policy = policy; }
  59   static CompilationPolicy* policy()                { return _policy; }
  60 
  61   static CompileTask* select_task_helper(CompileQueue* compile_queue);
  62 
  63   // Profiling
  64   elapsedTimer* accumulated_time() { return &_accumulated_time; }
  65   void print_time() PRODUCT_RETURN;
  66   // Return initial compile level that is used with Xcomp
  67   virtual CompLevel initial_compile_level() = 0;
  68   virtual int compiler_count(CompLevel comp_level) = 0;
  69   // main notification entry, return a pointer to an nmethod if the OSR is required,
  70   // returns NULL otherwise.
  71   virtual nmethod* event(const methodHandle& method, const methodHandle& inlinee, int branch_bci, int bci, CompLevel comp_level, nmethod* nm, JavaThread* thread) = 0;
  72   // safepoint() is called at the end of the safepoint
  73   virtual void do_safepoint_work() = 0;
  74   // reprofile request
  75   virtual void reprofile(ScopeDesc* trap_scope, bool is_osr) = 0;
  76   // delay_compilation(method) can be called by any component of the runtime to notify the policy
  77   // that it's recommended to delay the compilation of this method.
  78   virtual void delay_compilation(Method* method) = 0;
  79   // disable_compilation() is called whenever the runtime decides to disable compilation of the
  80   // specified method.
  81   virtual void disable_compilation(Method* method) = 0;
  82   // Select task is called by CompileBroker. The queue is guaranteed to have at least one
  83   // element and is locked. The function should select one and return it.
  84   virtual CompileTask* select_task(CompileQueue* compile_queue) = 0;
  85   // Tell the runtime if we think a given method is adequately profiled.
  86   virtual bool is_mature(Method* method) = 0;
  87   // Do policy initialization
  88   virtual void initialize() = 0;
  89   virtual bool should_not_inline(ciEnv* env, ciMethod* method) { return false; }
  90 };
  91 
  92 // A base class for baseline policies.
  93 class NonTieredCompPolicy : public CompilationPolicy {
  94   int _compiler_count;
  95 protected:
  96   static void trace_frequency_counter_overflow(const methodHandle& m, int branch_bci, int bci);
  97   static void trace_osr_request(const methodHandle& method, nmethod* osr, int bci);
  98   static void trace_osr_completion(nmethod* osr_nm);
  99   void reset_counter_for_invocation_event(const methodHandle& method);
 100   void reset_counter_for_back_branch_event(const methodHandle& method);
 101 public:
 102   NonTieredCompPolicy() : _compiler_count(0) { }
 103   virtual CompLevel initial_compile_level() { return CompLevel_highest_tier; }
 104   virtual int compiler_count(CompLevel comp_level);
 105   virtual void do_safepoint_work();
 106   virtual void reprofile(ScopeDesc* trap_scope, bool is_osr);
 107   virtual void delay_compilation(Method* method);
 108   virtual void disable_compilation(Method* method);
 109   virtual bool is_mature(Method* method);
 110   virtual void initialize();
 111   virtual CompileTask* select_task(CompileQueue* compile_queue);
 112   virtual nmethod* event(const methodHandle& method, const methodHandle& inlinee, int branch_bci, int bci, CompLevel comp_level, nmethod* nm, JavaThread* thread);
 113   virtual void method_invocation_event(const methodHandle& m, JavaThread* thread) = 0;
 114   virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread) = 0;
 115 };
 116 
 117 class SimpleCompPolicy : public NonTieredCompPolicy {
 118  public:
 119   virtual void method_invocation_event(const methodHandle& m, JavaThread* thread);
 120   virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread);
 121 };
 122 
 123 // StackWalkCompPolicy - existing C2 policy
 124 
 125 #ifdef COMPILER2
 126 class StackWalkCompPolicy : public NonTieredCompPolicy {
 127  public:
 128   virtual void method_invocation_event(const methodHandle& m, JavaThread* thread);
 129   virtual void method_back_branch_event(const methodHandle& m, int bci, JavaThread* thread);
 130 
 131  private:
 132   RFrame* findTopInlinableFrame(GrowableArray<RFrame*>* stack);
 133   RFrame* senderOf(RFrame* rf, GrowableArray<RFrame*>* stack);
 134 
 135   // the following variables hold values computed by the last inlining decision
 136   // they are used for performance debugging only (print better messages)
 137   static const char* _msg;            // reason for not inlining
 138 
 139   static const char* shouldInline   (const methodHandle& callee, float frequency, int cnt);
 140   // positive filter: should send be inlined?  returns NULL (--> yes) or rejection msg
 141   static const char* shouldNotInline(const methodHandle& callee);
 142   // negative filter: should send NOT be inlined?  returns NULL (--> inline) or rejection msg
 143 
 144 };
 145 #endif
 146 
 147 #endif // SHARE_VM_RUNTIME_COMPILATIONPOLICY_HPP