1 /*
2 * Copyright (c) 2015, 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 #ifndef SHARE_LOGGING_LOGTAG_HPP
25 #define SHARE_LOGGING_LOGTAG_HPP
26
27 #include "memory/allStatic.hpp"
28 #include "utilities/globalDefinitions.hpp"
29
30 class outputStream;
31
32 // List of available logging tags. New tags should be added here, in
33 // alphabetical order.
34 // (The tags 'all', 'disable' and 'help' are special tags that can
35 // not be used in log calls, and should not be listed below.)
36 #define LOG_TAG_LIST \
37 LOG_TAG(add) \
38 LOG_TAG(age) \
39 LOG_TAG(alloc) \
40 LOG_TAG(annotation) \
41 LOG_TAG(aot) \
42 LOG_TAG(arguments) \
43 LOG_TAG(array) \
44 LOG_TAG(attach) \
45 LOG_TAG(barrier) \
46 LOG_TAG(blocks) \
47 LOG_TAG(bot) \
48 LOG_TAG(breakpoint) \
49 LOG_TAG(bytecode) \
50 LOG_TAG(cause) \
51 LOG_TAG(cds) \
52 LOG_TAG(census) \
53 LOG_TAG(class) \
54 LOG_TAG(classhisto) \
55 LOG_TAG(cleanup) \
56 LOG_TAG(codecache) \
57 NOT_PRODUCT(LOG_TAG(codestrings)) \
58 LOG_TAG(compaction) \
59 LOG_TAG(compilation) \
60 LOG_TAG(condy) \
61 LOG_TAG(constantpool) \
62 LOG_TAG(constraints) \
63 LOG_TAG(container) \
64 LOG_TAG(continuations) \
65 LOG_TAG(coops) \
66 LOG_TAG(cpu) \
67 LOG_TAG(cset) \
68 LOG_TAG(data) \
69 LOG_TAG(datacreation) \
70 LOG_TAG(dcmd) \
71 LOG_TAG(decoder) \
72 LOG_TAG(defaultmethods) \
73 LOG_TAG(deoptimization) \
74 LOG_TAG(dependencies) \
75 LOG_TAG(director) \
76 NOT_PRODUCT(LOG_TAG(downcall)) \
77 LOG_TAG(dump) \
78 LOG_TAG(dynamic) \
79 LOG_TAG(ergo) \
80 LOG_TAG(event) \
81 LOG_TAG(exceptions) \
82 LOG_TAG(exit) \
83 LOG_TAG(fastlock) \
84 LOG_TAG(finalizer) \
85 LOG_TAG(fingerprint) \
86 NOT_PRODUCT(LOG_TAG(foreign)) \
87 LOG_TAG(free) \
88 LOG_TAG(freelist) \
89 LOG_TAG(gc) \
90 NOT_PRODUCT(LOG_TAG(generate)) \
91 LOG_TAG(handshake) \
92 LOG_TAG(hashtables) \
93 LOG_TAG(heap) \
94 LOG_TAG(heapdump) \
95 NOT_PRODUCT(LOG_TAG(heapsampling)) \
96 LOG_TAG(humongous) \
97 LOG_TAG(ihop) \
98 LOG_TAG(iklass) \
99 LOG_TAG(indy) \
100 LOG_TAG(init) \
101 LOG_TAG(inlinecache)\
102 LOG_TAG(inlining) \
103 LOG_TAG(install) \
104 LOG_TAG(interpreter) \
105 LOG_TAG(itables) \
106 LOG_TAG(jfr) \
107 LOG_TAG(jit) \
108 LOG_TAG(jmethod) \
109 LOG_TAG(jni) \
110 LOG_TAG(jvmci) \
111 LOG_TAG(jvmti) \
112 LOG_TAG(lambda) \
113 LOG_TAG(library) \
114 LOG_TAG(link) \
115 LOG_TAG(liveness) \
116 LOG_TAG(load) /* Trace all classes loaded */ \
117 LOG_TAG(loader) \
118 LOG_TAG(logging) \
119 LOG_TAG(malloc) \
120 LOG_TAG(map) \
121 LOG_TAG(mark) \
122 LOG_TAG(marking) \
123 LOG_TAG(membername) \
124 LOG_TAG(memops) \
125 LOG_TAG(metadata) \
126 LOG_TAG(metaspace) \
127 LOG_TAG(methodcomparator) \
128 LOG_TAG(methodhandles) \
129 LOG_TAG(mirror) \
130 LOG_TAG(mmu) \
131 LOG_TAG(module) \
132 LOG_TAG(monitorinflation) \
133 LOG_TAG(monitormismatch) \
134 LOG_TAG(monitortable) \
135 LOG_TAG(native) \
136 LOG_TAG(nestmates) \
137 LOG_TAG(nmethod) \
138 LOG_TAG(nmt) \
139 LOG_TAG(normalize) \
140 LOG_TAG(numa) \
141 LOG_TAG(objecttagging) \
142 LOG_TAG(obsolete) \
143 LOG_TAG(oldobject) \
144 LOG_TAG(oom) \
145 LOG_TAG(oopmap) \
146 LOG_TAG(oops) \
147 LOG_TAG(oopstorage) \
148 LOG_TAG(os) \
149 LOG_TAG(owner) \
150 LOG_TAG(page) \
151 LOG_TAG(pagesize) \
152 LOG_TAG(parser) \
153 LOG_TAG(patch) \
154 LOG_TAG(path) \
155 LOG_TAG(perf) \
156 LOG_TAG(periodic) \
157 LOG_TAG(phases) \
158 LOG_TAG(plab) \
159 LOG_TAG(placeholders) \
160 LOG_TAG(preempt) \
161 LOG_TAG(preorder) /* Trace all classes loaded in order referenced (not loaded) */ \
162 LOG_TAG(preview) /* Trace loading of preview feature types */ \
163 LOG_TAG(promotion) \
164 LOG_TAG(protectiondomain) /* "Trace protection domain verification" */ \
165 LOG_TAG(ptrqueue) \
166 LOG_TAG(purge) \
167 LOG_TAG(record) \
168 LOG_TAG(redefine) \
169 LOG_TAG(ref) \
170 LOG_TAG(refine) \
171 LOG_TAG(region) \
172 LOG_TAG(reloc) \
173 LOG_TAG(remset) \
174 LOG_TAG(resolve) \
175 LOG_TAG(safepoint) \
176 LOG_TAG(sampling) \
177 LOG_TAG(scavenge) \
178 LOG_TAG(sealed) \
179 LOG_TAG(setting) \
180 LOG_TAG(smr) \
181 LOG_TAG(stackbarrier) \
182 LOG_TAG(stackmap) \
183 LOG_TAG(stacktrace) \
184 LOG_TAG(stackwalk) \
185 LOG_TAG(start) \
186 LOG_TAG(startup) \
187 LOG_TAG(startuptime) \
188 LOG_TAG(state) \
189 LOG_TAG(stats) \
190 LOG_TAG(streaming) \
191 LOG_TAG(stringdedup) \
192 LOG_TAG(stringtable) \
193 LOG_TAG(stubs) \
194 LOG_TAG(subclass) \
195 LOG_TAG(survivor) \
196 LOG_TAG(suspend) \
197 LOG_TAG(sweep) \
198 LOG_TAG(symboltable) \
199 LOG_TAG(system) \
200 LOG_TAG(table) \
201 LOG_TAG(task) \
202 DEBUG_ONLY(LOG_TAG(test)) \
203 LOG_TAG(thread) \
204 LOG_TAG(throttle) \
205 LOG_TAG(timer) \
206 LOG_TAG(tlab) \
207 LOG_TAG(tracking) \
208 LOG_TAG(trimnative) /* trim native heap */ \
209 LOG_TAG(unload) /* Trace unloading of classes */ \
210 LOG_TAG(unmap) \
211 LOG_TAG(unshareable) \
212 NOT_PRODUCT(LOG_TAG(upcall)) \
213 LOG_TAG(update) \
214 LOG_TAG(valuebasedclasses) \
215 LOG_TAG(verification) \
216 LOG_TAG(verify) \
217 LOG_TAG(vmmutex) \
218 LOG_TAG(vmoperation) \
219 LOG_TAG(vmthread) \
220 LOG_TAG(vtables) \
221 LOG_TAG(vtablestubs)
222
223 #define PREFIX_LOG_TAG(T) (LogTag::_##T)
224
225 // Expand a set of log tags to their prefixed names.
226 // For error detection purposes, the macro passes one more tag than what is supported.
227 // If too many tags are given, a static assert in the log class will fail.
228 #define LOG_TAGS_EXPANDED(T0, T1, T2, T3, T4, T5, ...) PREFIX_LOG_TAG(T0), PREFIX_LOG_TAG(T1), PREFIX_LOG_TAG(T2), \
229 PREFIX_LOG_TAG(T3), PREFIX_LOG_TAG(T4), PREFIX_LOG_TAG(T5)
230 // The EXPAND_VARARGS macro is required for MSVC, or it will resolve the LOG_TAGS_EXPANDED macro incorrectly.
231 #define EXPAND_VARARGS(x) x
232 #define LOG_TAGS(...) EXPAND_VARARGS(LOG_TAGS_EXPANDED(__VA_ARGS__, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG))
233
234 // Log tags are used to classify log messages.
235 // Each log message can be assigned between 1 to LogTag::MaxTags number of tags.
236 // Specifying multiple tags for a log message means that only outputs configured
237 // for those exact tags, or a subset of the tags with a wildcard, will see the logging.
238 // Multiple tags should be comma separated, e.g. log_error(tag1, tag2)("msg").
239 class LogTag : public AllStatic {
240 public:
241 // The maximum number of tags that a single log message can have.
242 // E.g. there might be hundreds of different tags available,
243 // but a specific log message can only be tagged with up to MaxTags of those.
244 static const size_t MaxTags = 5;
245
246 enum type {
247 __NO_TAG,
248 #define LOG_TAG(name) _##name,
249 LOG_TAG_LIST
250 #undef LOG_TAG
251 Count
252 };
253
254 static const char* name(LogTag::type tag) {
255 return _name[tag];
256 }
257
258 static LogTag::type from_string(const char *str);
259 static LogTag::type fuzzy_match(const char *tag);
260 static void list_tags(outputStream* out);
261
262 private:
263 static const char* const _name[];
264 };
265
266 typedef LogTag::type LogTagType;
267
268 #endif // SHARE_LOGGING_LOGTAG_HPP