1 /*
   2  * Copyright (c) 2013, 2016, 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_OOPS_METHODCOUNTERS_HPP
  26 #define SHARE_VM_OOPS_METHODCOUNTERS_HPP
  27 
  28 #include "oops/metadata.hpp"
  29 #include "compiler/compilerOracle.hpp"
  30 #include "interpreter/invocationCounter.hpp"
  31 #include "runtime/arguments.hpp"
  32 #include "utilities/align.hpp"
  33 
  34 class MethodCounters : public Metadata {
  35  friend class VMStructs;
  36  friend class JVMCIVMStructs;
  37  private:
  38 #if INCLUDE_AOT
  39   Method*           _method;                     // Back link to Method
  40 #endif
  41 #if defined(COMPILER2) || INCLUDE_JVMCI
  42   int               _interpreter_invocation_count; // Count of times invoked (reused as prev_event_count in tiered)
  43   u2                _interpreter_throwout_count; // Count of times method was exited via exception while interpreting
  44 #endif
  45 #if INCLUDE_JVMTI
  46   u2                _number_of_breakpoints;      // fullspeed debugging support
  47 #endif
  48   InvocationCounter _invocation_counter;         // Incremented before each activation of the method - used to trigger frequency-based optimizations
  49   InvocationCounter _backedge_counter;           // Incremented before each backedge taken - used to trigger frequencey-based optimizations
  50   // NMethod age is a counter for warm methods detection in the code cache sweeper.
  51   // The counter is reset by the sweeper and is decremented by some of the compiled
  52   // code. The counter values are interpreted as follows:
  53   // 1. (HotMethodDetection..INT_MAX] - initial value, no counters inserted
  54   // 2. [1..HotMethodDetectionLimit)  - the method is warm, the counter is used
  55   //                                    to figure out which methods can be flushed.
  56   // 3. (INT_MIN..0]                  - method is hot and will deopt and get
  57   //                                    recompiled without the counters
  58   int               _nmethod_age;
  59   int               _interpreter_invocation_limit;        // per-method InterpreterInvocationLimit
  60   int               _interpreter_backward_branch_limit;   // per-method InterpreterBackwardBranchLimit
  61   int               _interpreter_profile_limit;           // per-method InterpreterProfileLimit
  62   int               _invoke_mask;                         // per-method Tier0InvokeNotifyFreqLog
  63   int               _backedge_mask;                       // per-method Tier0BackedgeNotifyFreqLog
  64 #ifdef TIERED
  65   float             _rate;                        // Events (invocation and backedge counter increments) per millisecond
  66   jlong             _prev_time;                   // Previous time the rate was acquired
  67   u1                _highest_comp_level;          // Highest compile level this method has ever seen.
  68   u1                _highest_osr_comp_level;      // Same for OSR level
  69 #endif
  70 
  71   MethodCounters(methodHandle mh) :
  72 #if INCLUDE_AOT
  73                                     _method(mh()),
  74 #endif
  75                                     _nmethod_age(INT_MAX)
  76 #ifdef TIERED
  77                                  , _rate(0),
  78                                    _prev_time(0),
  79                                    _highest_comp_level(0),
  80                                    _highest_osr_comp_level(0)
  81 #endif
  82   {
  83     set_interpreter_invocation_count(0);
  84     set_interpreter_throwout_count(0);
  85     JVMTI_ONLY(clear_number_of_breakpoints());
  86     invocation_counter()->init();
  87     backedge_counter()->init();
  88 
  89     if (StressCodeAging) {
  90       set_nmethod_age(HotMethodDetectionLimit);
  91     }
  92 
  93     // Set per-method thresholds.
  94     double scale = 1.0;
  95     CompilerOracle::has_option_value(mh, "CompileThresholdScaling", scale);
  96 
  97     int compile_threshold = Arguments::scaled_compile_threshold(CompileThreshold, scale);
  98     _interpreter_invocation_limit = compile_threshold << InvocationCounter::count_shift;
  99     if (ProfileInterpreter) {
 100       // If interpreter profiling is enabled, the backward branch limit
 101       // is compared against the method data counter rather than an invocation
 102       // counter, therefore no shifting of bits is required.
 103       _interpreter_backward_branch_limit = (compile_threshold * (OnStackReplacePercentage - InterpreterProfilePercentage)) / 100;
 104     } else {
 105       _interpreter_backward_branch_limit = ((compile_threshold * OnStackReplacePercentage) / 100) << InvocationCounter::count_shift;
 106     }
 107     _interpreter_profile_limit = ((compile_threshold * InterpreterProfilePercentage) / 100) << InvocationCounter::count_shift;
 108     _invoke_mask = right_n_bits(Arguments::scaled_freq_log(Tier0InvokeNotifyFreqLog, scale)) << InvocationCounter::count_shift;
 109     _backedge_mask = right_n_bits(Arguments::scaled_freq_log(Tier0BackedgeNotifyFreqLog, scale)) << InvocationCounter::count_shift;
 110   }
 111 
 112  public:
 113   virtual bool is_methodCounters() const volatile { return true; }
 114 
 115   static MethodCounters* allocate(methodHandle mh, TRAPS);
 116 
 117   void deallocate_contents(ClassLoaderData* loader_data) {}
 118 
 119   AOT_ONLY(Method* method() const { return _method; })
 120 
 121   static int size() {
 122     return align_up((int)sizeof(MethodCounters), wordSize) / wordSize;
 123   }
 124 
 125   void clear_counters();
 126 
 127 #if defined(COMPILER2) || INCLUDE_JVMCI
 128 
 129   int interpreter_invocation_count() {
 130     return _interpreter_invocation_count;
 131   }
 132   void set_interpreter_invocation_count(int count) {
 133     _interpreter_invocation_count = count;
 134   }
 135   int increment_interpreter_invocation_count() {
 136     return ++_interpreter_invocation_count;
 137   }
 138 
 139   void interpreter_throwout_increment() {
 140     if (_interpreter_throwout_count < 65534) {
 141       _interpreter_throwout_count++;
 142     }
 143   }
 144   int  interpreter_throwout_count() const {
 145     return _interpreter_throwout_count;
 146   }
 147   void set_interpreter_throwout_count(int count) {
 148     _interpreter_throwout_count = count;
 149   }
 150 
 151 #else // defined(COMPILER2) || INCLUDE_JVMCI
 152 
 153   int interpreter_invocation_count() {
 154     return 0;
 155   }
 156   void set_interpreter_invocation_count(int count) {
 157     assert(count == 0, "count must be 0");
 158   }
 159 
 160   int  interpreter_throwout_count() const {
 161     return 0;
 162   }
 163   void set_interpreter_throwout_count(int count) {
 164     assert(count == 0, "count must be 0");
 165   }
 166 
 167 #endif // defined(COMPILER2) || INCLUDE_JVMCI
 168 
 169 #if INCLUDE_JVMTI
 170   u2   number_of_breakpoints() const   { return _number_of_breakpoints; }
 171   void incr_number_of_breakpoints()    { ++_number_of_breakpoints; }
 172   void decr_number_of_breakpoints()    { --_number_of_breakpoints; }
 173   void clear_number_of_breakpoints()   { _number_of_breakpoints = 0; }
 174 #endif
 175 
 176 #ifdef TIERED
 177   jlong prev_time() const                        { return _prev_time; }
 178   void set_prev_time(jlong time)                 { _prev_time = time; }
 179   float rate() const                             { return _rate; }
 180   void set_rate(float rate)                      { _rate = rate; }
 181 #endif
 182 
 183   int highest_comp_level() const;
 184   void set_highest_comp_level(int level);
 185   int highest_osr_comp_level() const;
 186   void set_highest_osr_comp_level(int level);
 187 
 188   // invocation counter
 189   InvocationCounter* invocation_counter() { return &_invocation_counter; }
 190   InvocationCounter* backedge_counter()   { return &_backedge_counter; }
 191 
 192   int nmethod_age() {
 193     return _nmethod_age;
 194   }
 195   void set_nmethod_age(int age) {
 196     _nmethod_age = age;
 197   }
 198   void reset_nmethod_age() {
 199     set_nmethod_age(HotMethodDetectionLimit);
 200   }
 201 
 202   static bool is_nmethod_hot(int age)       { return age <= 0; }
 203   static bool is_nmethod_warm(int age)      { return age < HotMethodDetectionLimit; }
 204   static bool is_nmethod_age_unset(int age) { return age > HotMethodDetectionLimit; }
 205 
 206   static ByteSize nmethod_age_offset() {
 207     return byte_offset_of(MethodCounters, _nmethod_age);
 208   }
 209 
 210 #if defined(COMPILER2) || INCLUDE_JVMCI
 211 
 212   static ByteSize interpreter_invocation_counter_offset() {
 213     return byte_offset_of(MethodCounters, _interpreter_invocation_count);
 214   }
 215 
 216   static int interpreter_invocation_counter_offset_in_bytes() {
 217     return offset_of(MethodCounters, _interpreter_invocation_count);
 218   }
 219 
 220 #else // defined(COMPILER2) || INCLUDE_JVMCI
 221 
 222   static ByteSize interpreter_invocation_counter_offset() {
 223     ShouldNotReachHere();
 224     return in_ByteSize(0);
 225   }
 226 
 227 #endif // defined(COMPILER2) || INCLUDE_JVMCI
 228 
 229   static ByteSize invocation_counter_offset()    {
 230     return byte_offset_of(MethodCounters, _invocation_counter);
 231   }
 232 
 233   static ByteSize backedge_counter_offset()      {
 234     return byte_offset_of(MethodCounters, _backedge_counter);
 235   }
 236 
 237   static ByteSize interpreter_invocation_limit_offset() {
 238     return byte_offset_of(MethodCounters, _interpreter_invocation_limit);
 239   }
 240 
 241   static ByteSize interpreter_backward_branch_limit_offset() {
 242     return byte_offset_of(MethodCounters, _interpreter_backward_branch_limit);
 243   }
 244 
 245   static ByteSize interpreter_profile_limit_offset() {
 246     return byte_offset_of(MethodCounters, _interpreter_profile_limit);
 247   }
 248 
 249   static ByteSize invoke_mask_offset() {
 250     return byte_offset_of(MethodCounters, _invoke_mask);
 251   }
 252 
 253   static ByteSize backedge_mask_offset() {
 254     return byte_offset_of(MethodCounters, _backedge_mask);
 255   }
 256 
 257   virtual const char* internal_name() const { return "{method counters}"; }
 258   virtual void print_value_on(outputStream* st) const;
 259 
 260 };
 261 #endif //SHARE_VM_OOPS_METHODCOUNTERS_HPP