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