logTag.hpp revision 10145:c5480d4abfe4 
1/*
2 * Copyright (c) 2015, 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#ifndef SHARE_VM_LOGGING_LOGTAG_HPP
25#define SHARE_VM_LOGGING_LOGTAG_HPP
26
27#include "memory/allocation.hpp"
28#include "utilities/globalDefinitions.hpp"
29
30// List of available logging tags. New tags should be added here.
31// (The tags 'all', 'disable' and 'help' are special tags that can
32// not be used in log calls, and should not be listed below.)
33#define LOG_TAG_LIST \
34  LOG_TAG(alloc) \
35  LOG_TAG(age) \
36  LOG_TAG(barrier) \
37  LOG_TAG(bot) \
38  LOG_TAG(census) \
39  LOG_TAG(classhisto) \
40  LOG_TAG(classresolve) \
41  LOG_TAG(classinit) \
42  LOG_TAG(comp) \
43  LOG_TAG(compaction) \
44  LOG_TAG(cpu) \
45  LOG_TAG(cset) \
46  LOG_TAG(defaultmethods) \
47  LOG_TAG(ergo) \
48  LOG_TAG(exceptions) \
49  LOG_TAG(exit) \
50  LOG_TAG(freelist) \
51  LOG_TAG(gc) \
52  LOG_TAG(heap) \
53  LOG_TAG(humongous) \
54  LOG_TAG(ihop) \
55  LOG_TAG(itables) \
56  LOG_TAG(jni) \
57  LOG_TAG(liveness) \
58  LOG_TAG(logging) \
59  LOG_TAG(marking) \
60  LOG_TAG(metaspace) \
61  LOG_TAG(monitorinflation) \
62  LOG_TAG(os) \
63  LOG_TAG(phases) \
64  LOG_TAG(plab) \
65  LOG_TAG(promotion) \
66  LOG_TAG(ref) \
67  LOG_TAG(refine) \
68  LOG_TAG(region) \
69  LOG_TAG(remset) \
70  LOG_TAG(rt) \
71  LOG_TAG(safepoint) \
72  LOG_TAG(scavenge) \
73  LOG_TAG(scrub) \
74  LOG_TAG(start) \
75  LOG_TAG(state) \
76  LOG_TAG(stats) \
77  LOG_TAG(stringdedup) \
78  LOG_TAG(survivor) \
79  LOG_TAG(svc) \
80  LOG_TAG(sweep) \
81  LOG_TAG(task) \
82  LOG_TAG(tlab) \
83  LOG_TAG(time) \
84  LOG_TAG(verify) \
85  LOG_TAG(vmoperation) \
86  LOG_TAG(vtables)
87
88#define PREFIX_LOG_TAG(T) (LogTag::_##T)
89
90// Expand a set of log tags to their prefixed names.
91// For error detection purposes, the macro passes one more tag than what is supported.
92// If too many tags are given, a static assert in the log class will fail.
93#define LOG_TAGS_EXPANDED(T0, T1, T2, T3, T4, T5, ...)  PREFIX_LOG_TAG(T0), PREFIX_LOG_TAG(T1), PREFIX_LOG_TAG(T2), \
94                                                        PREFIX_LOG_TAG(T3), PREFIX_LOG_TAG(T4), PREFIX_LOG_TAG(T5)
95// The EXPAND_VARARGS macro is required for MSVC, or it will resolve the LOG_TAGS_EXPANDED macro incorrectly.
96#define EXPAND_VARARGS(x) x
97#define LOG_TAGS(...) EXPAND_VARARGS(LOG_TAGS_EXPANDED(__VA_ARGS__, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG, _NO_TAG))
98
99// Log tags are used to classify log messages.
100// Each log message can be assigned between 1 to LogTag::MaxTags number of tags.
101// Specifying multiple tags for a log message means that only outputs configured
102// for those exact tags, or a subset of the tags with a wildcard, will see the logging.
103// Multiple tags should be comma separated, e.g. log_error(tag1, tag2)("msg").
104class LogTag : public AllStatic {
105 public:
106  // The maximum number of tags that a single log message can have.
107  // E.g. there might be hundreds of different tags available,
108  // but a specific log message can only be tagged with up to MaxTags of those.
109  static const size_t MaxTags = 5;
110
111  enum type {
112    __NO_TAG,
113#define LOG_TAG(name) _##name,
114    LOG_TAG_LIST
115#undef LOG_TAG
116    Count
117  };
118
119  static const char* name(LogTag::type tag) {
120    return _name[tag];
121  }
122
123  static LogTag::type from_string(const char *str);
124
125 private:
126  static const char* _name[];
127};
128
129typedef LogTag::type LogTagType;
130
131#endif // SHARE_VM_LOGGING_LOGTAG_HPP
132