1/*
2 * Copyright (c) 2015, 2019, 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_LOG_HPP
25#define SHARE_LOGGING_LOG_HPP
26
27#include "logging/logLevel.hpp"
28#include "logging/logPrefix.hpp"
29#include "logging/logTagSet.hpp"
30#include "logging/logTag.hpp"
31#include "runtime/os.hpp"
32#include "utilities/debug.hpp"
33
34class LogMessageBuffer;
35
36//
37// Logging macros
38//
39// Usage:
40// log_<level>(<comma separated log tags>)(<printf-style log arguments>);
41// e.g.
42// log_debug(logging)("message %d", i);
43//
44// Note that these macros will not evaluate the arguments unless the logging is enabled.
45//
46#define log_error(...) (!log_is_enabled(Error, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Error>
47#define log_warning(...) (!log_is_enabled(Warning, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Warning>
48#define log_info(...) (!log_is_enabled(Info, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Info>
49#define log_debug(...) (!log_is_enabled(Debug, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Debug>
50#define log_trace(...) (!log_is_enabled(Trace, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Trace>
51
52// Macros for logging that should be excluded in product builds.
53// Available for levels Info, Debug and Trace. Includes test macro that
54// evaluates to false in product builds.
55#ifndef PRODUCT
56#define log_develop_info(...) (!log_is_enabled(Info, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Info>
57#define log_develop_debug(...) (!log_is_enabled(Debug, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Debug>
58#define log_develop_trace(...) (!log_is_enabled(Trace, __VA_ARGS__)) ? (void)0 : LogImpl<LOG_TAGS(__VA_ARGS__)>::write<LogLevel::Trace>
59#define log_develop_is_enabled(level, ...) log_is_enabled(level, __VA_ARGS__)
60#else
61#define DUMMY_ARGUMENT_CONSUMER(...)
62#define log_develop_info(...) DUMMY_ARGUMENT_CONSUMER
63#define log_develop_debug(...) DUMMY_ARGUMENT_CONSUMER
64#define log_develop_trace(...) DUMMY_ARGUMENT_CONSUMER
65#define log_develop_is_enabled(...) false
66#endif
67
68// Convenience macro to test if the logging is enabled on the specified level for given tags.
69#define log_is_enabled(level, ...) (LogImpl<LOG_TAGS(__VA_ARGS__)>::is_level(LogLevel::level))
70
71//
72// Log class for more advanced logging scenarios.
73// Has printf-style member functions for each log level (trace(), debug(), etc).
74//
75// Also has outputStream compatible API for the different log-levels.
76// The streams are resource allocated when requested and are accessed through
77// calls to <level>_stream() functions (trace_stream(), debug_stream(), etc).
78//
79// Example usage:
80// Log(logging) log;
81// if (log.is_debug()) {
82// ...
83// log.debug("result = %d", result).trace(" tracing info");
84// obj->print_on(log.debug_stream());
85// }
86//
87#define Log(...) LogImpl<LOG_TAGS(__VA_ARGS__)>
88
89//
90// Log class that embeds both log tags and a log level.
91//
92// The class provides a way to write the tags and log level once,
93// so that redundant specification of tags or levels can be avoided.
94//
95// Example usage:
96// LogTarget(Debug, gc) out;
97// if (out.is_enabled()) {
98// ...
99// out.print("Worker: %u", i);
100// out.print(" data: %d", x);
101// ...
102// print_stats(out.stream());
103// }
104//
105#define LogTarget(level, ...) LogTargetImpl<LogLevel::level, LOG_TAGS(__VA_ARGS__)>
106
107template <LogLevelType level, LogTagType T0, LogTagType T1, LogTagType T2, LogTagType T3, LogTagType T4, LogTagType GuardTag>
108class LogTargetImpl;
109
110template <LogTagType T0, LogTagType T1 = LogTag::__NO_TAG, LogTagType T2 = LogTag::__NO_TAG, LogTagType T3 = LogTag::__NO_TAG,
111 LogTagType T4 = LogTag::__NO_TAG, LogTagType GuardTag = LogTag::__NO_TAG>
112class LogImpl {
113 private:
114 static const size_t LogBufferSize = 512;
115 public:
116 // Make sure no more than the maximum number of tags have been given.
117 // The GuardTag allows this to be detected if/when it happens. If the GuardTag
118 // is not __NO_TAG, the number of tags given exceeds the maximum allowed.
119 STATIC_ASSERT(GuardTag == LogTag::__NO_TAG); // Number of logging tags exceeds maximum supported!
120
121 // Empty constructor to avoid warnings on MSVC about unused variables
122 // when the log instance is only used for static functions.
123 LogImpl() {
124 }
125
126 static bool is_level(LogLevelType level) {
127 return LogTagSetMapping<T0, T1, T2, T3, T4>::tagset().is_level(level);
128 }
129
130 ATTRIBUTE_PRINTF(2, 3)
131 static void write(LogLevelType level, const char* fmt, ...) {
132 va_list args;
133 va_start(args, fmt);
134 vwrite(level, fmt, args);
135 va_end(args);
136 }
137
138 static void write(const LogMessageBuffer& msg) {
139 LogTagSetMapping<T0, T1, T2, T3, T4>::tagset().log(msg);
140 };
141
142 template <LogLevelType Level>
143 ATTRIBUTE_PRINTF(1, 2)
144 static void write(const char* fmt, ...) {
145 va_list args;
146 va_start(args, fmt);
147 vwrite(Level, fmt, args);
148 va_end(args);
149 }
150
151 ATTRIBUTE_PRINTF(2, 0)
152 static void vwrite(LogLevelType level, const char* fmt, va_list args) {
153 LogTagSetMapping<T0, T1, T2, T3, T4>::tagset().vwrite(level, fmt, args);
154 }
155
156#define LOG_LEVEL(level, name) ATTRIBUTE_PRINTF(2, 0) \
157 LogImpl& v##name(const char* fmt, va_list args) { \
158 vwrite(LogLevel::level, fmt, args); \
159 return *this; \
160 } \
161 LogImpl& name(const char* fmt, ...) ATTRIBUTE_PRINTF(2, 3) { \
162 va_list args; \
163 va_start(args, fmt); \
164 vwrite(LogLevel::level, fmt, args); \
165 va_end(args); \
166 return *this; \
167 } \
168 static bool is_##name() { \
169 return is_level(LogLevel::level); \
170 } \
171 static LogTargetImpl<LogLevel::level, T0, T1, T2, T3, T4, GuardTag>* name() { \
172 return (LogTargetImpl<LogLevel::level, T0, T1, T2, T3, T4, GuardTag>*)NULL; \
173 }
174 LOG_LEVEL_LIST
175#undef LOG_LEVEL
176};
177
178// Combines logging tags and a logging level.
179template <LogLevelType level, LogTagType T0, LogTagType T1 = LogTag::__NO_TAG, LogTagType T2 = LogTag::__NO_TAG,
180 LogTagType T3 = LogTag::__NO_TAG, LogTagType T4 = LogTag::__NO_TAG, LogTagType GuardTag = LogTag::__NO_TAG>
181class LogTargetImpl {
182public:
183 // Empty constructor to avoid warnings on MSVC about unused variables
184 // when the log instance is only used for static functions.
185 LogTargetImpl() {
186 }
187
188 static bool is_enabled() {
189 return LogImpl<T0, T1, T2, T3, T4, GuardTag>::is_level(level);
190 }
191
192 static void print(const char* fmt, ...) ATTRIBUTE_PRINTF(1, 2) {
193 va_list args;
194 va_start(args, fmt);
195 LogImpl<T0, T1, T2, T3, T4, GuardTag>::vwrite(level, fmt, args);
196 va_end(args);
197 }
198
199};
200
201#endif // SHARE_LOGGING_LOG_HPP
202