1 /*
2 * Copyright (c) 2013, 2025, 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_OOPS_METHODCOUNTERS_HPP
26 #define SHARE_OOPS_METHODCOUNTERS_HPP
27
28 #include "compiler/compilerDefinitions.hpp"
29 #include "interpreter/invocationCounter.hpp"
30 #include "oops/metadata.hpp"
31 #include "utilities/align.hpp"
32
33 class MethodTrainingData;
34
35 class MethodCounters : public Metadata {
36 friend class VMStructs;
37 friend class JVMCIVMStructs;
38
39 // Used by CDS. These classes need to access the private default constructor.
40 template <class T> friend class CppVtableTesterA;
41 template <class T> friend class CppVtableTesterB;
42 template <class T> friend class CppVtableCloner;
43
44 private:
45 InvocationCounter _invocation_counter; // Incremented before each activation of the method - used to trigger frequency-based optimizations
46 InvocationCounter _backedge_counter; // Incremented before each backedge taken - used to trigger frequency-based optimizations
47
48 int64_t _jit_code_invocation_count; // C2 code invocations count during training used as limit for AOT code invocation
49 int _aot_code_invocation_count; // C2 AOT code invocations count
50 int _aot_code_recompile_requested; // Request for JIT compilation to replace AOT code was made
51
52 // Back pointer to the Method*
53 Method* _method;
54
55 Metadata* _method_training_data;
56 jlong _prev_time; // Previous time the rate was acquired
57 float _rate; // Events (invocation and backedge counter increments) per millisecond
58 int _invoke_mask; // per-method Tier0InvokeNotifyFreqLog
59 int _backedge_mask; // per-method Tier0BackedgeNotifyFreqLog
60 int _prev_event_count; // Total number of events saved at previous callback
61 #if COMPILER2_OR_JVMCI
62 u2 _interpreter_throwout_count; // Count of times method was exited via exception while interpreting
63 #endif
64 #if INCLUDE_JVMTI
65 u2 _number_of_breakpoints; // fullspeed debugging support
66 #endif
67 u1 _highest_comp_level; // Highest compile level this method has ever seen.
68 u1 _highest_osr_comp_level; // Same for OSR level
69
70 MethodCounters(const methodHandle& mh);
71 MethodCounters();
72
73 public:
74 virtual bool is_methodCounters() const { return true; }
75 Method* method() const { return _method; }
76 static MethodCounters* allocate_no_exception(const methodHandle& mh);
77 static MethodCounters* allocate_with_exception(const methodHandle& mh, TRAPS);
78
79 void deallocate_contents(ClassLoaderData* loader_data) {}
80
81 static int method_counters_size() {
82 return align_up((int)sizeof(MethodCounters), wordSize) / wordSize;
83 }
84 virtual int size() const {
85 return method_counters_size();
86 }
87
88 MetaspaceObj::Type type() const { return MethodCountersType; }
89 void metaspace_pointers_do(MetaspaceClosure* iter);
90
91 void clear_counters();
92
93 #if COMPILER2_OR_JVMCI
94 void interpreter_throwout_increment() {
95 if (_interpreter_throwout_count < 65534) {
96 _interpreter_throwout_count++;
97 }
98 }
99 u2 interpreter_throwout_count() const {
100 return _interpreter_throwout_count;
101 }
102 void set_interpreter_throwout_count(u2 count) {
103 _interpreter_throwout_count = count;
104 }
105 #else // COMPILER2_OR_JVMCI
106 u2 interpreter_throwout_count() const {
107 return 0;
108 }
109 void set_interpreter_throwout_count(u2 count) {
110 assert(count == 0, "count must be 0");
111 }
112 #endif // COMPILER2_OR_JVMCI
113
114 #if INCLUDE_JVMTI
115 u2 number_of_breakpoints() const { return _number_of_breakpoints; }
116 void incr_number_of_breakpoints() { ++_number_of_breakpoints; }
117 void decr_number_of_breakpoints() { --_number_of_breakpoints; }
118 void clear_number_of_breakpoints() { _number_of_breakpoints = 0; }
119 #endif
120
121 int prev_event_count() const { return _prev_event_count; }
122 void set_prev_event_count(int count) { _prev_event_count = count; }
123 jlong prev_time() const { return _prev_time; }
124 void set_prev_time(jlong time) { _prev_time = time; }
125 float rate() const { return _rate; }
126 void set_rate(float rate) { _rate = rate; }
127
128 int highest_comp_level() const { return _highest_comp_level; }
129 void set_highest_comp_level(int level) { _highest_comp_level = (u1)level; }
130 int highest_osr_comp_level() const { return _highest_osr_comp_level; }
131 void set_highest_osr_comp_level(int level) { _highest_osr_comp_level = (u1)level; }
132
133 // invocation counter
134 InvocationCounter* invocation_counter() { return &_invocation_counter; }
135 InvocationCounter* backedge_counter() { return &_backedge_counter; }
136
137 int64_t jit_code_invocation_count() const { return _jit_code_invocation_count; }
138 int aot_code_invocation_count() const { return _aot_code_invocation_count;}
139 int aot_code_recompile_requested() const { return _aot_code_recompile_requested;}
140
141 static ByteSize invocation_counter_offset() {
142 return byte_offset_of(MethodCounters, _invocation_counter);
143 }
144
145 static ByteSize backedge_counter_offset() {
146 return byte_offset_of(MethodCounters, _backedge_counter);
147 }
148
149 static ByteSize invoke_mask_offset() {
150 return byte_offset_of(MethodCounters, _invoke_mask);
151 }
152
153 static ByteSize backedge_mask_offset() {
154 return byte_offset_of(MethodCounters, _backedge_mask);
155 }
156
157 static ByteSize jit_code_invocation_counter_offset() {
158 return byte_offset_of(MethodCounters, _jit_code_invocation_count);
159 }
160
161 static ByteSize aot_code_invocation_counter_offset() {
162 return byte_offset_of(MethodCounters, _aot_code_invocation_count);
163 }
164
165 static ByteSize aot_code_recompile_requested_offset() {
166 return byte_offset_of(MethodCounters, _aot_code_recompile_requested);
167 }
168
169 virtual const char* internal_name() const { return "{method counters}"; }
170
171 Metadata* method_training_data_sentinel() {
172 return this;
173 }
174 MethodTrainingData* method_training_data() const {
175 return reinterpret_cast<MethodTrainingData*>(_method_training_data);
176 }
177 bool init_method_training_data(MethodTrainingData* td) {
178 MethodTrainingData* cur = method_training_data();
179 if (cur == td) {
180 return true;
181 }
182 if (cur == nullptr || cur == reinterpret_cast<MethodTrainingData*>(method_training_data_sentinel())) {
183 return AtomicAccess::cmpxchg(reinterpret_cast<MethodTrainingData**>(&_method_training_data), cur, td) == cur;
184 }
185 return false;
186 }
187
188 #if INCLUDE_CDS
189 void remove_unshareable_info();
190 void restore_unshareable_info(TRAPS);
191 #endif
192
193 // Printing
194 void print_on (outputStream* st) const;
195 void print_value_on(outputStream* st) const;
196 void print_data_on(outputStream* st) const;
197 };
198 #endif // SHARE_OOPS_METHODCOUNTERS_HPP