1 /*
2 * Copyright (c) 2013, 2024, 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 "oops/metadata.hpp"
29 #include "compiler/compilerDefinitions.hpp"
30 #include "interpreter/invocationCounter.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 // Back pointer to the Method*
49 Method* _method;
50
51 Metadata* _method_training_data;
52 jlong _prev_time; // Previous time the rate was acquired
53 float _rate; // Events (invocation and backedge counter increments) per millisecond
54 int _invoke_mask; // per-method Tier0InvokeNotifyFreqLog
55 int _backedge_mask; // per-method Tier0BackedgeNotifyFreqLog
56 int _prev_event_count; // Total number of events saved at previous callback
57 #if COMPILER2_OR_JVMCI
58 u2 _interpreter_throwout_count; // Count of times method was exited via exception while interpreting
59 #endif
60 #if INCLUDE_JVMTI
61 u2 _number_of_breakpoints; // fullspeed debugging support
62 #endif
63 u1 _highest_comp_level; // Highest compile level this method has ever seen.
64 u1 _highest_osr_comp_level; // Same for OSR level
65
66 MethodCounters(const methodHandle& mh);
67 MethodCounters();
68
69 public:
70 virtual bool is_methodCounters() const { return true; }
71 Method* method() const { return _method; }
72 static MethodCounters* allocate_no_exception(const methodHandle& mh);
73 static MethodCounters* allocate_with_exception(const methodHandle& mh, TRAPS);
74
75 void deallocate_contents(ClassLoaderData* loader_data) {}
76
77 static int method_counters_size() {
78 return align_up((int)sizeof(MethodCounters), wordSize) / wordSize;
79 }
80 virtual int size() const {
81 return method_counters_size();
82 }
83
84 MetaspaceObj::Type type() const { return MethodCountersType; }
85 void metaspace_pointers_do(MetaspaceClosure* iter);
86
87 void clear_counters();
88
89 #if COMPILER2_OR_JVMCI
90 void interpreter_throwout_increment() {
91 if (_interpreter_throwout_count < 65534) {
92 _interpreter_throwout_count++;
93 }
94 }
95 u2 interpreter_throwout_count() const {
96 return _interpreter_throwout_count;
97 }
98 void set_interpreter_throwout_count(u2 count) {
99 _interpreter_throwout_count = count;
100 }
101 #else // COMPILER2_OR_JVMCI
102 u2 interpreter_throwout_count() const {
103 return 0;
104 }
105 void set_interpreter_throwout_count(u2 count) {
106 assert(count == 0, "count must be 0");
107 }
108 #endif // COMPILER2_OR_JVMCI
109
110 #if INCLUDE_JVMTI
111 u2 number_of_breakpoints() const { return _number_of_breakpoints; }
112 void incr_number_of_breakpoints() { ++_number_of_breakpoints; }
113 void decr_number_of_breakpoints() { --_number_of_breakpoints; }
114 void clear_number_of_breakpoints() { _number_of_breakpoints = 0; }
115 #endif
116
117 int prev_event_count() const { return _prev_event_count; }
118 void set_prev_event_count(int count) { _prev_event_count = count; }
119 jlong prev_time() const { return _prev_time; }
120 void set_prev_time(jlong time) { _prev_time = time; }
121 float rate() const { return _rate; }
122 void set_rate(float rate) { _rate = rate; }
123
124 int highest_comp_level() const { return _highest_comp_level; }
125 void set_highest_comp_level(int level) { _highest_comp_level = (u1)level; }
126 int highest_osr_comp_level() const { return _highest_osr_comp_level; }
127 void set_highest_osr_comp_level(int level) { _highest_osr_comp_level = (u1)level; }
128
129
130 // invocation counter
131 InvocationCounter* invocation_counter() { return &_invocation_counter; }
132 InvocationCounter* backedge_counter() { return &_backedge_counter; }
133
134 static ByteSize invocation_counter_offset() {
135 return byte_offset_of(MethodCounters, _invocation_counter);
136 }
137
138 static ByteSize backedge_counter_offset() {
139 return byte_offset_of(MethodCounters, _backedge_counter);
140 }
141
142 static ByteSize invoke_mask_offset() {
143 return byte_offset_of(MethodCounters, _invoke_mask);
144 }
145
146 static ByteSize backedge_mask_offset() {
147 return byte_offset_of(MethodCounters, _backedge_mask);
148 }
149
150 virtual const char* internal_name() const { return "{method counters}"; }
151
152 Metadata* method_training_data_sentinel() {
153 return this;
154 }
155 MethodTrainingData* method_training_data() const {
156 return reinterpret_cast<MethodTrainingData*>(_method_training_data);
157 }
158 bool init_method_training_data(MethodTrainingData* td) {
159 MethodTrainingData* cur = method_training_data();
160 if (cur == td) {
161 return true;
162 }
163 if (cur == nullptr || cur == reinterpret_cast<MethodTrainingData*>(method_training_data_sentinel())) {
164 return Atomic::cmpxchg(reinterpret_cast<MethodTrainingData**>(&_method_training_data), cur, td) == cur;
165 }
166 return false;
167 }
168
169 #if INCLUDE_CDS
170 void remove_unshareable_info();
171 void restore_unshareable_info(TRAPS);
172 #endif
173
174 // Printing
175 void print_on (outputStream* st) const;
176 void print_value_on(outputStream* st) const;
177 void print_data_on(outputStream* st) const;
178 };
179 #endif // SHARE_OOPS_METHODCOUNTERS_HPP