1 /*
2 * Copyright (c) 2011, 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_GC_G1_G1ERGOVERBOSE_HPP
26 #define SHARE_VM_GC_G1_G1ERGOVERBOSE_HPP
27
28 #include "memory/allocation.hpp"
29 #include "utilities/debug.hpp"
30
31 // The log of G1's heuristic decisions comprises of a series of
32 // records which have a similar format in order to maintain
33 // consistency across records and ultimately easier parsing of the
34 // output, if we ever choose to do that. Each record consists of:
35 // * A time stamp to be able to easily correlate each record with
36 // other events.
37 // * A unique string to allow us to easily identify such records.
38 // * The name of the heuristic the record corresponds to.
39 // * An action string which describes the action that G1 did or is
40 // about to do.
41 // * An optional reason string which describes the reason for the
42 // action.
43 // * An optional number of name/value pairs which contributed to the
44 // decision to take the action described in the record.
45 //
46 // Each record is associated with a "tag" which is the combination of
47 // the heuristic the record corresponds to, as well as the min level
48 // of verboseness at which the record should be printed. The tag is
49 // checked against the current settings to determine whether the record
50 // should be printed or not.
51
52 // The available verboseness levels.
53 typedef enum {
54 // Determine which part of the tag is occupied by the level.
55 ErgoLevelShift = 8,
56 ErgoLevelMask = ~((1 << ErgoLevelShift) - 1),
57
58 // ErgoLow is 0 so that we don't have to explicitly or a heuristic
59 // id with ErgoLow to keep its use simpler.
60 ErgoLow = 0,
61 ErgoHigh = 1 << ErgoLevelShift
62 } ErgoLevel;
63
64 // The available heuristics.
65 typedef enum {
66 // Determines which part of the tag is occupied by the heuristic id.
67 ErgoHeuristicMask = ~ErgoLevelMask,
68
69 ErgoHeapSizing = 0,
70 ErgoCSetConstruction,
71 ErgoConcCycles,
72 ErgoMixedGCs,
73 ErgoTiming,
74
75 ErgoHeuristicNum
76 } ErgoHeuristic;
77
78 class G1ErgoVerbose : AllStatic {
79 private:
80 // Determines the minimum verboseness level at which records will be
81 // printed.
82 static ErgoLevel _level;
83 // Determines which heuristics are currently enabled.
84 static bool _enabled[ErgoHeuristicNum];
85
86 static ErgoLevel extract_level(int tag) {
87 return (ErgoLevel) (tag & ErgoLevelMask);
88 }
89
90 static ErgoHeuristic extract_heuristic(int tag) {
91 return (ErgoHeuristic) (tag & ErgoHeuristicMask);
92 }
93
94 public:
95 // Needs to be explicitly called at GC initialization.
96 static void initialize();
97
98 static void set_level(ErgoLevel level);
99 static void set_enabled(ErgoHeuristic h, bool enabled);
100 // It is applied to all heuristics.
101 static void set_enabled(bool enabled);
102
103 static bool enabled(int tag) {
104 ErgoLevel level = extract_level(tag);
105 ErgoHeuristic n = extract_heuristic(tag);
106 return level <= _level && _enabled[n];
107 }
108
109 // Extract the heuristic id from the tag and return a string with
110 // its name.
111 static const char* to_string(int tag);
112 };
113
114 // The macros below generate the format string for values of different
115 // types and/or metrics.
116
117 // The reason for the action is optional and is handled specially: the
118 // reason string is concatenated here so it's not necessary to pass it
119 // as a parameter.
120 #define ergo_format_reason(_reason_) ", reason: " _reason_
121
122 // Single parameter format strings
123 #define ergo_format_str(_name_) ", " _name_ ": %s"
124 #define ergo_format_region(_name_) ", " _name_ ": %u regions"
125 #define ergo_format_byte(_name_) ", " _name_ ": " SIZE_FORMAT " bytes"
126 #define ergo_format_double(_name_) ", " _name_ ": %1.2f"
127 #define ergo_format_perc(_name_) ", " _name_ ": %1.2f %%"
128 #define ergo_format_ms(_name_) ", " _name_ ": %1.2f ms"
129 #define ergo_format_size(_name_) ", " _name_ ": " SIZE_FORMAT
130
131 // Double parameter format strings
132 #define ergo_format_byte_perc(_name_) \
133 ", " _name_ ": " SIZE_FORMAT " bytes (%1.2f %%)"
134
135 // Generates the format string
136 #define ergo_format(_extra_format_) \
137 " %1.3f: [G1Ergonomics (%s) %s" _extra_format_ "]"
138
139 // Conditionally, prints an ergonomic decision record. _extra_format_
140 // is the format string for the optional items we'd like to print
141 // (i.e., the decision's reason and any associated values). This
142 // string should be built up using the ergo_*_format macros (see
143 // above) to ensure consistency.
144 //
145 // Since we cannot rely on the compiler supporting variable argument
146 // macros, this macro accepts a fixed number of arguments and passes
147 // them to the print method. For convenience, we have wrapper macros
148 // below which take a specific number of arguments and set the rest to
149 // a default value.
150 #define ergo_verbose_common(_tag_, _action_, _extra_format_, \
151 _arg0_, _arg1_, _arg2_, _arg3_, _arg4_, _arg5_) \
152 do { \
153 if (G1ErgoVerbose::enabled((_tag_))) { \
154 gclog_or_tty->print_cr(ergo_format(_extra_format_), \
155 os::elapsedTime(), \
156 G1ErgoVerbose::to_string((_tag_)), \
157 (_action_), \
158 (_arg0_), (_arg1_), (_arg2_), \
159 (_arg3_), (_arg4_), (_arg5_)); \
160 } \
161 } while (0)
162
163
164 #define ergo_verbose6(_tag_, _action_, _extra_format_, \
165 _arg0_, _arg1_, _arg2_, _arg3_, _arg4_, _arg5_) \
166 ergo_verbose_common(_tag_, _action_, _extra_format_, \
167 _arg0_, _arg1_, _arg2_, _arg3_, _arg4_, _arg5_)
168
169 #define ergo_verbose5(_tag_, _action_, _extra_format_, \
170 _arg0_, _arg1_, _arg2_, _arg3_, _arg4_) \
171 ergo_verbose6(_tag_, _action_, _extra_format_ "%s", \
172 _arg0_, _arg1_, _arg2_, _arg3_, _arg4_, "")
173
174 #define ergo_verbose4(_tag_, _action_, _extra_format_, \
175 _arg0_, _arg1_, _arg2_, _arg3_) \
176 ergo_verbose5(_tag_, _action_, _extra_format_ "%s", \
177 _arg0_, _arg1_, _arg2_, _arg3_, "")
178
179 #define ergo_verbose3(_tag_, _action_, _extra_format_, \
180 _arg0_, _arg1_, _arg2_) \
181 ergo_verbose4(_tag_, _action_, _extra_format_ "%s", \
182 _arg0_, _arg1_, _arg2_, "")
183
184 #define ergo_verbose2(_tag_, _action_, _extra_format_, \
185 _arg0_, _arg1_) \
186 ergo_verbose3(_tag_, _action_, _extra_format_ "%s", \
187 _arg0_, _arg1_, "")
188
189 #define ergo_verbose1(_tag_, _action_, _extra_format_, \
190 _arg0_) \
191 ergo_verbose2(_tag_, _action_, _extra_format_ "%s", \
192 _arg0_, "")
193
194
195 #define ergo_verbose0(_tag_, _action_, _extra_format_) \
196 ergo_verbose1(_tag_, _action_, _extra_format_ "%s", \
197 "")
198
199 #define ergo_verbose(_tag_, _action_) \
200 ergo_verbose0(_tag_, _action_, "")
201
202
203 #endif // SHARE_VM_GC_G1_G1ERGOVERBOSE_HPP