blob: ee4d410bf49861abea48728119a411500757af46 [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001/*
2 * Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020011// RTC_LOG(...) an ostream target that can be used to send formatted
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000012// output to a variety of logging targets, such as debugger console, stderr,
Tommi0eefb4d2015-05-23 09:54:07 +020013// or any LogSink.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020014// The severity level passed as the first argument to the logging
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000015// functions is used as a filter, to limit the verbosity of the logging.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020016// Static members of LogMessage documented below are used to control the
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000017// verbosity and target of the output.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020018// There are several variations on the RTC_LOG macro which facilitate logging
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000019// of common error conditions, detailed below.
20
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020021// RTC_LOG(sev) logs the given stream at severity "sev", which must be a
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000022// compile-time constant of the LoggingSeverity type, without the namespace
23// prefix.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020024// RTC_LOG_V(sev) Like RTC_LOG(), but sev is a run-time variable of the
25// LoggingSeverity type (basically, it just doesn't prepend the namespace).
26// RTC_LOG_F(sev) Like RTC_LOG(), but includes the name of the current function.
27// RTC_LOG_T(sev) Like RTC_LOG(), but includes the this pointer.
28// RTC_LOG_T_F(sev) Like RTC_LOG_F(), but includes the this pointer.
Tommie51a0a82018-02-27 15:30:29 +010029// RTC_LOG_GLE(sev [, mod]) attempt to add a string description of the
30// HRESULT returned by GetLastError.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020031// RTC_LOG_ERRNO(sev) attempts to add a string description of an errno-derived
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000032// error. errno and associated facilities exist on both Windows and POSIX,
33// but on Windows they only apply to the C/C++ runtime.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020034// RTC_LOG_ERR(sev) is an alias for the platform's normal error system, i.e.
35// _GLE on Windows and _ERRNO on POSIX.
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000036// (The above three also all have _EX versions that let you specify the error
37// code, rather than using the last one.)
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020038// RTC_LOG_E(sev, ctx, err, ...) logs a detailed error interpreted using the
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000039// specified context.
Mirko Bonadei8ed8e562017-10-27 09:43:53 +020040// RTC_LOG_CHECK_LEVEL(sev) (and RTC_LOG_CHECK_LEVEL_V(sev)) can be used as a
41// test before performing expensive or sensitive operations whose sole
42// purpose is to output logging data at the desired level.
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000043
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020044#ifndef RTC_BASE_LOGGING_H_
45#define RTC_BASE_LOGGING_H_
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000046
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020047#include <errno.h>
mostynbe38e4f62016-05-12 01:08:20 -070048
Markus Handellce1ff6f2020-07-08 08:52:48 +020049#include <atomic>
Jonas Olsson941a07c2018-09-13 10:07:07 +020050#include <sstream> // no-presubmit-check TODO(webrtc:8982)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020051#include <string>
52#include <utility>
53
Danil Chapovalove9041612021-02-22 12:43:39 +010054#include "absl/base/attributes.h"
Sebastian Janssonf4e085a2019-05-20 18:34:07 +020055#include "absl/meta/type_traits.h"
Jonas Olssonf2ce37c2018-09-12 15:32:47 +020056#include "absl/strings/string_view.h"
Jonas Olssond8c50782018-09-07 11:21:28 +020057#include "rtc_base/strings/string_builder.h"
Karl Wibergcefc4652018-05-23 23:20:38 +020058#include "rtc_base/system/inline.h"
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020059
Fredrik Solenbergb3d7cac2017-11-17 15:22:37 +010060#if !defined(NDEBUG) || defined(DLOG_ALWAYS_ON)
61#define RTC_DLOG_IS_ON 1
62#else
63#define RTC_DLOG_IS_ON 0
64#endif
65
Artem Titov6a4a1462019-11-26 16:24:46 +010066#if defined(RTC_DISABLE_LOGGING)
67#define RTC_LOG_ENABLED() 0
68#else
69#define RTC_LOG_ENABLED() 1
70#endif
71
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020072namespace rtc {
73
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020074//////////////////////////////////////////////////////////////////////
Harald Alvestrand57869da2022-03-09 10:52:14 +000075// The meanings of the levels are:
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020076// LS_VERBOSE: This level is for data which we do not want to appear in the
77// normal debug log, but should appear in diagnostic logs.
78// LS_INFO: Chatty level used in debugging for all sorts of things, the default
79// in debug builds.
80// LS_WARNING: Something that may warrant investigation.
81// LS_ERROR: Something that should not have occurred.
82// LS_NONE: Don't log.
83enum LoggingSeverity {
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020084 LS_VERBOSE,
85 LS_INFO,
86 LS_WARNING,
87 LS_ERROR,
88 LS_NONE,
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020089};
90
91// LogErrorContext assists in interpreting the meaning of an error value.
92enum LogErrorContext {
93 ERRCTX_NONE,
Jonas Olssona4d87372019-07-05 19:08:33 +020094 ERRCTX_ERRNO, // System-local errno
95 ERRCTX_HRESULT, // Windows HRESULT
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020096
97 // Abbreviations for LOG_E macro
Jonas Olssona4d87372019-07-05 19:08:33 +020098 ERRCTX_EN = ERRCTX_ERRNO, // LOG_E(sev, EN, x)
99 ERRCTX_HR = ERRCTX_HRESULT, // LOG_E(sev, HR, x)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200100};
101
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200102class LogMessage;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200103// Virtual sink interface that can receive log messages.
104class LogSink {
105 public:
106 LogSink() {}
107 virtual ~LogSink() {}
Paulina Hensmanf1e3cb42018-06-20 14:07:05 +0200108 virtual void OnLogMessage(const std::string& msg,
109 LoggingSeverity severity,
110 const char* tag);
Jiawei Ou3ea18782018-10-31 23:14:24 -0700111 virtual void OnLogMessage(const std::string& message,
112 LoggingSeverity severity);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200113 virtual void OnLogMessage(const std::string& message) = 0;
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200114
Ali Tofigh6364d082022-03-14 13:32:04 +0100115 virtual void OnLogMessage(absl::string_view msg,
116 LoggingSeverity severity,
117 const char* tag);
118 virtual void OnLogMessage(absl::string_view message,
119 LoggingSeverity severity);
120 virtual void OnLogMessage(absl::string_view message);
121
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200122 private:
123 friend class ::rtc::LogMessage;
Artem Titov6a4a1462019-11-26 16:24:46 +0100124#if RTC_LOG_ENABLED()
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200125 // Members for LogMessage class to keep linked list of the registered sinks.
126 LogSink* next_ = nullptr;
127 LoggingSeverity min_severity_;
Artem Titov6a4a1462019-11-26 16:24:46 +0100128#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200129};
130
Karl Wibergcefc4652018-05-23 23:20:38 +0200131namespace webrtc_logging_impl {
132
133class LogMetadata {
134 public:
135 LogMetadata(const char* file, int line, LoggingSeverity severity)
136 : file_(file),
137 line_and_sev_(static_cast<uint32_t>(line) << 3 | severity) {}
138 LogMetadata() = default;
139
140 const char* File() const { return file_; }
141 int Line() const { return line_and_sev_ >> 3; }
142 LoggingSeverity Severity() const {
143 return static_cast<LoggingSeverity>(line_and_sev_ & 0x7);
144 }
145
146 private:
147 const char* file_;
148
149 // Line number and severity, the former in the most significant 29 bits, the
150 // latter in the least significant 3 bits. (This is an optimization; since
151 // both numbers are usually compile-time constants, this way we can load them
152 // both with a single instruction.)
153 uint32_t line_and_sev_;
154};
155static_assert(std::is_trivial<LogMetadata>::value, "");
156
157struct LogMetadataErr {
158 LogMetadata meta;
159 LogErrorContext err_ctx;
160 int err;
161};
162
163#ifdef WEBRTC_ANDROID
164struct LogMetadataTag {
165 LoggingSeverity severity;
166 const char* tag;
167};
168#endif
169
170enum class LogArgType : int8_t {
171 kEnd = 0,
172 kInt,
173 kLong,
174 kLongLong,
175 kUInt,
176 kULong,
177 kULongLong,
178 kDouble,
179 kLongDouble,
180 kCharP,
181 kStdString,
Jonas Olssonf2ce37c2018-09-12 15:32:47 +0200182 kStringView,
Karl Wibergcefc4652018-05-23 23:20:38 +0200183 kVoidP,
184 kLogMetadata,
185 kLogMetadataErr,
186#ifdef WEBRTC_ANDROID
187 kLogMetadataTag,
188#endif
189};
190
191// Wrapper for log arguments. Only ever make values of this type with the
192// MakeVal() functions.
193template <LogArgType N, typename T>
194struct Val {
195 static constexpr LogArgType Type() { return N; }
196 T GetVal() const { return val; }
197 T val;
198};
199
Sebastian Janssonb1138622019-04-11 16:48:15 +0200200// Case for when we need to construct a temp string and then print that.
201// (We can't use Val<CheckArgType::kStdString, const std::string*>
202// because we need somewhere to store the temp string.)
203struct ToStringVal {
Karl Wibergcefc4652018-05-23 23:20:38 +0200204 static constexpr LogArgType Type() { return LogArgType::kStdString; }
205 const std::string* GetVal() const { return &val; }
206 std::string val;
207};
208
209inline Val<LogArgType::kInt, int> MakeVal(int x) {
210 return {x};
211}
212inline Val<LogArgType::kLong, long> MakeVal(long x) {
213 return {x};
214}
215inline Val<LogArgType::kLongLong, long long> MakeVal(long long x) {
216 return {x};
217}
218inline Val<LogArgType::kUInt, unsigned int> MakeVal(unsigned int x) {
219 return {x};
220}
221inline Val<LogArgType::kULong, unsigned long> MakeVal(unsigned long x) {
222 return {x};
223}
224inline Val<LogArgType::kULongLong, unsigned long long> MakeVal(
225 unsigned long long x) {
226 return {x};
227}
228
229inline Val<LogArgType::kDouble, double> MakeVal(double x) {
230 return {x};
231}
232inline Val<LogArgType::kLongDouble, long double> MakeVal(long double x) {
233 return {x};
234}
235
236inline Val<LogArgType::kCharP, const char*> MakeVal(const char* x) {
237 return {x};
238}
239inline Val<LogArgType::kStdString, const std::string*> MakeVal(
240 const std::string& x) {
241 return {&x};
242}
Jonas Olssonf2ce37c2018-09-12 15:32:47 +0200243inline Val<LogArgType::kStringView, const absl::string_view*> MakeVal(
244 const absl::string_view& x) {
245 return {&x};
246}
Karl Wibergcefc4652018-05-23 23:20:38 +0200247
248inline Val<LogArgType::kVoidP, const void*> MakeVal(const void* x) {
249 return {x};
250}
251
252inline Val<LogArgType::kLogMetadata, LogMetadata> MakeVal(
253 const LogMetadata& x) {
254 return {x};
255}
256inline Val<LogArgType::kLogMetadataErr, LogMetadataErr> MakeVal(
257 const LogMetadataErr& x) {
258 return {x};
259}
260
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700261// The enum class types are not implicitly convertible to arithmetic types.
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200262template <typename T,
263 absl::enable_if_t<std::is_enum<T>::value &&
264 !std::is_arithmetic<T>::value>* = nullptr>
265inline decltype(MakeVal(std::declval<absl::underlying_type_t<T>>())) MakeVal(
266 T x) {
267 return {static_cast<absl::underlying_type_t<T>>(x)};
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700268}
269
Karl Wibergcefc4652018-05-23 23:20:38 +0200270#ifdef WEBRTC_ANDROID
271inline Val<LogArgType::kLogMetadataTag, LogMetadataTag> MakeVal(
272 const LogMetadataTag& x) {
273 return {x};
274}
275#endif
276
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200277template <typename T, class = void>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200278struct has_to_log_string : std::false_type {};
279template <typename T>
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200280struct has_to_log_string<T, decltype(ToLogString(std::declval<T>()))>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200281 : std::true_type {};
282
Karl Wibergcefc4652018-05-23 23:20:38 +0200283// Handle arbitrary types other than the above by falling back to stringstream.
284// TODO(bugs.webrtc.org/9278): Get rid of this overload when callers don't need
285// it anymore. No in-tree caller does, but some external callers still do.
286template <
287 typename T,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200288 typename T1 = absl::decay_t<T>,
289 absl::enable_if_t<std::is_class<T1>::value &&
290 !std::is_same<T1, std::string>::value &&
291 !std::is_same<T1, LogMetadata>::value &&
292 !has_to_log_string<T1>::value &&
Karl Wibergcefc4652018-05-23 23:20:38 +0200293#ifdef WEBRTC_ANDROID
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200294 !std::is_same<T1, LogMetadataTag>::value &&
Karl Wibergcefc4652018-05-23 23:20:38 +0200295#endif
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200296 !std::is_same<T1, LogMetadataErr>::value>* = nullptr>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200297ToStringVal MakeVal(const T& x) {
Karl Wibergcefc4652018-05-23 23:20:38 +0200298 std::ostringstream os; // no-presubmit-check TODO(webrtc:8982)
299 os << x;
300 return {os.str()};
301}
302
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200303template <typename T, absl::enable_if_t<has_to_log_string<T>::value>* = nullptr>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200304ToStringVal MakeVal(const T& x) {
305 return {ToLogString(x)};
306}
307
Artem Titov6a4a1462019-11-26 16:24:46 +0100308#if RTC_LOG_ENABLED()
Karl Wibergcefc4652018-05-23 23:20:38 +0200309void Log(const LogArgType* fmt, ...);
Artem Titov6a4a1462019-11-26 16:24:46 +0100310#else
311inline void Log(const LogArgType* fmt, ...) {
312 // Do nothing, shouldn't be invoked
313}
314#endif
Karl Wibergcefc4652018-05-23 23:20:38 +0200315
316// Ephemeral type that represents the result of the logging << operator.
317template <typename... Ts>
318class LogStreamer;
319
320// Base case: Before the first << argument.
321template <>
322class LogStreamer<> final {
323 public:
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700324 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200325 typename V = decltype(MakeVal(std::declval<U>())),
326 absl::enable_if_t<std::is_arithmetic<U>::value ||
327 std::is_enum<U>::value>* = nullptr>
328 RTC_FORCE_INLINE LogStreamer<V> operator<<(U arg) const {
329 return LogStreamer<V>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200330 }
331
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700332 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200333 typename V = decltype(MakeVal(std::declval<U>())),
334 absl::enable_if_t<!std::is_arithmetic<U>::value &&
335 !std::is_enum<U>::value>* = nullptr>
336 RTC_FORCE_INLINE LogStreamer<V> operator<<(const U& arg) const {
337 return LogStreamer<V>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200338 }
339
340 template <typename... Us>
341 RTC_FORCE_INLINE static void Call(const Us&... args) {
342 static constexpr LogArgType t[] = {Us::Type()..., LogArgType::kEnd};
343 Log(t, args.GetVal()...);
344 }
345};
346
347// Inductive case: We've already seen at least one << argument. The most recent
348// one had type `T`, and the earlier ones had types `Ts`.
349template <typename T, typename... Ts>
350class LogStreamer<T, Ts...> final {
351 public:
352 RTC_FORCE_INLINE LogStreamer(T arg, const LogStreamer<Ts...>* prior)
353 : arg_(arg), prior_(prior) {}
354
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700355 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200356 typename V = decltype(MakeVal(std::declval<U>())),
357 absl::enable_if_t<std::is_arithmetic<U>::value ||
358 std::is_enum<U>::value>* = nullptr>
359 RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(U arg) const {
360 return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200361 }
362
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700363 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200364 typename V = decltype(MakeVal(std::declval<U>())),
365 absl::enable_if_t<!std::is_arithmetic<U>::value &&
366 !std::is_enum<U>::value>* = nullptr>
367 RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(const U& arg) const {
368 return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200369 }
370
371 template <typename... Us>
372 RTC_FORCE_INLINE void Call(const Us&... args) const {
373 prior_->Call(arg_, args...);
374 }
375
376 private:
377 // The most recent argument.
378 T arg_;
379
380 // Earlier arguments.
381 const LogStreamer<Ts...>* prior_;
382};
383
384class LogCall final {
385 public:
386 // This can be any binary operator with precedence lower than <<.
Artem Titov6a4a1462019-11-26 16:24:46 +0100387 // We return bool here to be able properly remove logging if
388 // RTC_DISABLE_LOGGING is defined.
Karl Wibergcefc4652018-05-23 23:20:38 +0200389 template <typename... Ts>
Artem Titov6a4a1462019-11-26 16:24:46 +0100390 RTC_FORCE_INLINE bool operator&(const LogStreamer<Ts...>& streamer) {
Karl Wibergcefc4652018-05-23 23:20:38 +0200391 streamer.Call();
Artem Titov6a4a1462019-11-26 16:24:46 +0100392 return true;
Karl Wibergcefc4652018-05-23 23:20:38 +0200393 }
394};
395
Mirko Bonadeif1df04b2020-03-23 19:53:23 +0100396// This class is used to explicitly ignore values in the conditional
397// logging macros. This avoids compiler warnings like "value computed
398// is not used" and "statement has no effect".
399class LogMessageVoidify {
400 public:
401 LogMessageVoidify() = default;
402 // This has to be an operator with a precedence lower than << but
403 // higher than ?:
404 template <typename... Ts>
405 void operator&(LogStreamer<Ts...>&& streamer) {}
406};
407
Karl Wibergcefc4652018-05-23 23:20:38 +0200408} // namespace webrtc_logging_impl
409
410// Direct use of this class is deprecated; please use the logging macros
411// instead.
412// TODO(bugs.webrtc.org/9278): Move this class to an unnamed namespace in the
413// .cc file.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200414class LogMessage {
415 public:
Karl Wiberg1ffb3742018-05-04 15:04:48 +0200416 // Same as the above, but using a compile-time constant for the logging
417 // severity. This saves space at the call site, since passing an empty struct
418 // is generally the same as not passing an argument at all.
419 template <LoggingSeverity S>
420 RTC_NO_INLINE LogMessage(const char* file,
421 int line,
422 std::integral_constant<LoggingSeverity, S>)
423 : LogMessage(file, line, S) {}
424
Artem Titov6a4a1462019-11-26 16:24:46 +0100425#if RTC_LOG_ENABLED()
426 LogMessage(const char* file, int line, LoggingSeverity sev);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200427 LogMessage(const char* file,
428 int line,
429 LoggingSeverity sev,
Karl Wibergab4f1c12018-05-04 10:42:28 +0200430 LogErrorContext err_ctx,
431 int err);
Tommie51a0a82018-02-27 15:30:29 +0100432#if defined(WEBRTC_ANDROID)
433 LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag);
434#endif
Tommie51a0a82018-02-27 15:30:29 +0100435 // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
436 // Android code should use the 'const char*' version since tags are static
437 // and we want to avoid allocating a std::string copy per log line.
Danil Chapovalove9041612021-02-22 12:43:39 +0100438 ABSL_DEPRECATED("Use RTC_LOG macros instead of accessing this class directly")
Yves Gerey665174f2018-06-19 15:03:05 +0200439 LogMessage(const char* file,
440 int line,
441 LoggingSeverity sev,
Philip Eliasson278aa422018-02-26 14:54:45 +0000442 const std::string& tag);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200443 ~LogMessage();
444
Byoungchan Lee14af7622022-01-12 05:24:58 +0900445 LogMessage(const LogMessage&) = delete;
446 LogMessage& operator=(const LogMessage&) = delete;
447
Karl Wibergcefc4652018-05-23 23:20:38 +0200448 void AddTag(const char* tag);
Jonas Olssond8c50782018-09-07 11:21:28 +0200449 rtc::StringBuilder& stream();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200450 // Returns the time at which this function was called for the first time.
451 // The time will be used as the logging start time.
452 // If this is not called externally, the LogMessage ctor also calls it, in
453 // which case the logging start time will be the time of the first LogMessage
454 // instance is created.
455 static int64_t LogStartTime();
Artem Titov96e3b992021-07-26 16:03:14 +0200456 // Returns the wall clock equivalent of `LogStartTime`, in seconds from the
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200457 // epoch.
458 static uint32_t WallClockStartTime();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200459 // LogThreads: Display the thread identifier of the current thread
460 static void LogThreads(bool on = true);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200461 // LogTimestamps: Display the elapsed time of the program
462 static void LogTimestamps(bool on = true);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200463 // These are the available logging channels
464 // Debug: Debug console on Windows, otherwise stderr
465 static void LogToDebug(LoggingSeverity min_sev);
Jonas Olsson2b6f1352018-02-15 11:57:03 +0100466 static LoggingSeverity GetLogToDebug();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200467 // Sets whether logs will be directed to stderr in debug mode.
468 static void SetLogToStderr(bool log_to_stderr);
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200469 // Stream: Any non-blocking stream interface.
Artem Titov96e3b992021-07-26 16:03:14 +0200470 // Installs the `stream` to collect logs with severtiy `min_sev` or higher.
471 // `stream` must live until deinstalled by RemoveLogToStream.
472 // If `stream` is the first stream added to the system, we might miss some
Markus Handell531bd0f2020-07-08 10:58:19 +0200473 // early concurrent log statement happening from another thread happening near
474 // this instant.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200475 static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev);
Markus Handell531bd0f2020-07-08 10:58:19 +0200476 // Removes the specified stream, without destroying it. When the method
Artem Titov96e3b992021-07-26 16:03:14 +0200477 // has completed, it's guaranteed that `stream` will receive no more logging
Markus Handell531bd0f2020-07-08 10:58:19 +0200478 // calls.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200479 static void RemoveLogToStream(LogSink* stream);
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200480 // Returns the severity for the specified stream, of if none is specified,
481 // the minimum stream severity.
482 static int GetLogToStream(LogSink* stream = nullptr);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200483 // Testing against MinLogSeverity allows code to avoid potentially expensive
484 // logging operations by pre-checking the logging level.
Jonas Olsson2b6f1352018-02-15 11:57:03 +0100485 static int GetMinLogSeverity();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200486 // Parses the provided parameter stream to configure the options above.
487 // Useful for configuring logging from the command line.
488 static void ConfigureLogging(const char* params);
Artem Titov96e3b992021-07-26 16:03:14 +0200489 // Checks the current global debug severity and if the `streams_` collection
490 // is empty. If `severity` is smaller than the global severity and if the
491 // `streams_` collection is empty, the LogMessage will be considered a noop
Jonas Olssond8c50782018-09-07 11:21:28 +0200492 // LogMessage.
493 static bool IsNoop(LoggingSeverity severity);
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200494 // Version of IsNoop that uses fewer instructions at the call site, since the
495 // caller doesn't have to pass an argument.
496 template <LoggingSeverity S>
497 RTC_NO_INLINE static bool IsNoop() {
498 return IsNoop(S);
499 }
Artem Titov6a4a1462019-11-26 16:24:46 +0100500#else
501 // Next methods do nothing; no one will call these functions.
502 LogMessage(const char* file, int line, LoggingSeverity sev) {}
503 LogMessage(const char* file,
504 int line,
505 LoggingSeverity sev,
506 LogErrorContext err_ctx,
507 int err) {}
508#if defined(WEBRTC_ANDROID)
509 LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag) {
510 }
511#endif
512 // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
513 // Android code should use the 'const char*' version since tags are static
514 // and we want to avoid allocating a std::string copy per log line.
Danil Chapovalove9041612021-02-22 12:43:39 +0100515 ABSL_DEPRECATED("Use RTC_LOG macros instead of accessing this class directly")
Artem Titov6a4a1462019-11-26 16:24:46 +0100516 LogMessage(const char* file,
517 int line,
518 LoggingSeverity sev,
519 const std::string& tag) {}
520 ~LogMessage() = default;
521
522 inline void AddTag(const char* tag) {}
523 inline rtc::StringBuilder& stream() { return print_stream_; }
524 inline static int64_t LogStartTime() { return 0; }
525 inline static uint32_t WallClockStartTime() { return 0; }
526 inline static void LogThreads(bool on = true) {}
527 inline static void LogTimestamps(bool on = true) {}
528 inline static void LogToDebug(LoggingSeverity min_sev) {}
529 inline static LoggingSeverity GetLogToDebug() {
530 return LoggingSeverity::LS_INFO;
531 }
532 inline static void SetLogToStderr(bool log_to_stderr) {}
533 inline static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev) {}
534 inline static void RemoveLogToStream(LogSink* stream) {}
535 inline static int GetLogToStream(LogSink* stream = nullptr) { return 0; }
536 inline static int GetMinLogSeverity() { return 0; }
537 inline static void ConfigureLogging(const char* params) {}
Karl Wiberg0e884382020-09-22 09:34:45 +0200538 static constexpr bool IsNoop(LoggingSeverity severity) { return true; }
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200539 template <LoggingSeverity S>
540 static constexpr bool IsNoop() {
541 return IsNoop(S);
542 }
Artem Titov6a4a1462019-11-26 16:24:46 +0100543#endif // RTC_LOG_ENABLED()
Jonas Olssond8c50782018-09-07 11:21:28 +0200544
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200545 private:
Tommifef05002018-02-27 13:51:08 +0100546 friend class LogMessageForTesting;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200547
Artem Titov6a4a1462019-11-26 16:24:46 +0100548#if RTC_LOG_ENABLED()
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200549 // Updates min_sev_ appropriately when debug sinks change.
550 static void UpdateMinLogSeverity();
551
Yves Gerey665174f2018-06-19 15:03:05 +0200552// These write out the actual log messages.
Tommie51a0a82018-02-27 15:30:29 +0100553#if defined(WEBRTC_ANDROID)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200554 static void OutputToDebug(const std::string& msg,
555 LoggingSeverity severity,
Tommie51a0a82018-02-27 15:30:29 +0100556 const char* tag);
557#else
558 static void OutputToDebug(const std::string& msg, LoggingSeverity severity);
Artem Titov6a4a1462019-11-26 16:24:46 +0100559#endif // defined(WEBRTC_ANDROID)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200560
Tommifef05002018-02-27 13:51:08 +0100561 // Called from the dtor (or from a test) to append optional extra error
562 // information to the log stream and a newline character.
563 void FinishPrintStream();
564
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200565 // The severity level of this message
566 LoggingSeverity severity_;
567
Tommie51a0a82018-02-27 15:30:29 +0100568#if defined(WEBRTC_ANDROID)
Paulina Hensmanf1e3cb42018-06-20 14:07:05 +0200569 // The default Android debug output tag.
Tommie51a0a82018-02-27 15:30:29 +0100570 const char* tag_ = "libjingle";
571#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200572
573 // String data generated in the constructor, that should be appended to
574 // the message before output.
575 std::string extra_;
576
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200577 // The output streams and their associated severities
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200578 static LogSink* streams_;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200579
Artem Titov96e3b992021-07-26 16:03:14 +0200580 // Holds true with high probability if `streams_` is empty, false with high
Markus Handellce1ff6f2020-07-08 08:52:48 +0200581 // probability otherwise. Operated on with std::memory_order_relaxed because
Markus Handell531bd0f2020-07-08 10:58:19 +0200582 // it's ok to lose or log some additional statements near the instant streams
Markus Handellce1ff6f2020-07-08 08:52:48 +0200583 // are added/removed.
584 static std::atomic<bool> streams_empty_;
585
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200586 // Flags for formatting options
587 static bool thread_, timestamp_;
588
589 // Determines if logs will be directed to stderr in debug mode.
590 static bool log_to_stderr_;
Artem Titov6a4a1462019-11-26 16:24:46 +0100591#else // RTC_LOG_ENABLED()
592 // Next methods do nothing; no one will call these functions.
593 inline static void UpdateMinLogSeverity() {}
594#if defined(WEBRTC_ANDROID)
595 inline static void OutputToDebug(const std::string& msg,
596 LoggingSeverity severity,
597 const char* tag) {}
598#else
599 inline static void OutputToDebug(const std::string& msg,
600 LoggingSeverity severity) {}
601#endif // defined(WEBRTC_ANDROID)
602 inline void FinishPrintStream() {}
603#endif // RTC_LOG_ENABLED()
604
605 // The stringbuilder that buffers the formatted message before output
606 rtc::StringBuilder print_stream_;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200607};
608
609//////////////////////////////////////////////////////////////////////
610// Logging Helpers
611//////////////////////////////////////////////////////////////////////
612
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200613#define RTC_LOG_FILE_LINE(sev, file, line) \
614 ::rtc::webrtc_logging_impl::LogCall() & \
615 ::rtc::webrtc_logging_impl::LogStreamer<>() \
616 << ::rtc::webrtc_logging_impl::LogMetadata(file, line, sev)
Jonas Olsson8a7916b2018-09-06 09:50:23 +0200617
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200618#define RTC_LOG(sev) \
619 !rtc::LogMessage::IsNoop<::rtc::sev>() && \
620 RTC_LOG_FILE_LINE(::rtc::sev, __FILE__, __LINE__)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200621
Karl Wibergcefc4652018-05-23 23:20:38 +0200622// The _V version is for when a variable is passed in.
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200623#define RTC_LOG_V(sev) \
624 !rtc::LogMessage::IsNoop(sev) && RTC_LOG_FILE_LINE(sev, __FILE__, __LINE__)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200625
626// The _F version prefixes the message with the current function name.
627#if (defined(__GNUC__) && !defined(NDEBUG)) || defined(WANT_PRETTY_LOG_F)
Mirko Bonadei8ed8e562017-10-27 09:43:53 +0200628#define RTC_LOG_F(sev) RTC_LOG(sev) << __PRETTY_FUNCTION__ << ": "
Yves Gerey665174f2018-06-19 15:03:05 +0200629#define RTC_LOG_T_F(sev) \
630 RTC_LOG(sev) << this << ": " << __PRETTY_FUNCTION__ << ": "
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200631#else
Mirko Bonadei8ed8e562017-10-27 09:43:53 +0200632#define RTC_LOG_F(sev) RTC_LOG(sev) << __FUNCTION__ << ": "
Patrik Höglundc2962552017-11-17 13:40:22 +0000633#define RTC_LOG_T_F(sev) RTC_LOG(sev) << this << ": " << __FUNCTION__ << ": "
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200634#endif
635
Jiawei Ou14e5f0b2020-03-04 13:38:02 -0800636#define RTC_LOG_CHECK_LEVEL(sev) ::rtc::LogCheckLevel(::rtc::sev)
637#define RTC_LOG_CHECK_LEVEL_V(sev) ::rtc::LogCheckLevel(sev)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200638
639inline bool LogCheckLevel(LoggingSeverity sev) {
640 return (LogMessage::GetMinLogSeverity() <= sev);
641}
642
Karl Wiberg92e37962020-09-22 13:22:20 +0200643#define RTC_LOG_E(sev, ctx, err) \
644 !rtc::LogMessage::IsNoop<::rtc::sev>() && \
645 ::rtc::webrtc_logging_impl::LogCall() & \
646 ::rtc::webrtc_logging_impl::LogStreamer<>() \
647 << ::rtc::webrtc_logging_impl::LogMetadataErr { \
648 {__FILE__, __LINE__, ::rtc::sev}, ::rtc::ERRCTX_##ctx, (err) \
Jonas Olssona4d87372019-07-05 19:08:33 +0200649 }
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200650
Mirko Bonadei8ed8e562017-10-27 09:43:53 +0200651#define RTC_LOG_T(sev) RTC_LOG(sev) << this << ": "
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200652
Yves Gerey665174f2018-06-19 15:03:05 +0200653#define RTC_LOG_ERRNO_EX(sev, err) RTC_LOG_E(sev, ERRNO, err)
654#define RTC_LOG_ERRNO(sev) RTC_LOG_ERRNO_EX(sev, errno)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200655
656#if defined(WEBRTC_WIN)
Yves Gerey665174f2018-06-19 15:03:05 +0200657#define RTC_LOG_GLE_EX(sev, err) RTC_LOG_E(sev, HRESULT, err)
Karl Wibergcefc4652018-05-23 23:20:38 +0200658#define RTC_LOG_GLE(sev) RTC_LOG_GLE_EX(sev, static_cast<int>(GetLastError()))
Yves Gerey665174f2018-06-19 15:03:05 +0200659#define RTC_LOG_ERR_EX(sev, err) RTC_LOG_GLE_EX(sev, err)
660#define RTC_LOG_ERR(sev) RTC_LOG_GLE(sev)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200661#elif defined(__native_client__) && __native_client__
Yves Gerey665174f2018-06-19 15:03:05 +0200662#define RTC_LOG_ERR_EX(sev, err) RTC_LOG(sev)
663#define RTC_LOG_ERR(sev) RTC_LOG(sev)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200664#elif defined(WEBRTC_POSIX)
Yves Gerey665174f2018-06-19 15:03:05 +0200665#define RTC_LOG_ERR_EX(sev, err) RTC_LOG_ERRNO_EX(sev, err)
666#define RTC_LOG_ERR(sev) RTC_LOG_ERRNO(sev)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200667#endif // WEBRTC_WIN
668
Karl Wibergcefc4652018-05-23 23:20:38 +0200669#ifdef WEBRTC_ANDROID
670
671namespace webrtc_logging_impl {
672// TODO(kwiberg): Replace these with absl::string_view.
Yves Gerey665174f2018-06-19 15:03:05 +0200673inline const char* AdaptString(const char* str) {
674 return str;
675}
676inline const char* AdaptString(const std::string& str) {
677 return str.c_str();
678}
Karl Wibergcefc4652018-05-23 23:20:38 +0200679} // namespace webrtc_logging_impl
680
Karl Wiberg92e37962020-09-22 13:22:20 +0200681#define RTC_LOG_TAG(sev, tag) \
682 !rtc::LogMessage::IsNoop(sev) && \
683 ::rtc::webrtc_logging_impl::LogCall() & \
684 ::rtc::webrtc_logging_impl::LogStreamer<>() \
685 << ::rtc::webrtc_logging_impl::LogMetadataTag { \
686 sev, ::rtc::webrtc_logging_impl::AdaptString(tag) \
Jonas Olssona4d87372019-07-05 19:08:33 +0200687 }
Karl Wibergcefc4652018-05-23 23:20:38 +0200688
Tommie51a0a82018-02-27 15:30:29 +0100689#else
Karl Wibergcefc4652018-05-23 23:20:38 +0200690
Tommie51a0a82018-02-27 15:30:29 +0100691// DEPRECATED. This macro is only intended for Android.
Karl Wibergcefc4652018-05-23 23:20:38 +0200692#define RTC_LOG_TAG(sev, tag) RTC_LOG_V(sev)
693
Tommie51a0a82018-02-27 15:30:29 +0100694#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200695
Fredrik Solenbergb3d7cac2017-11-17 15:22:37 +0100696// The RTC_DLOG macros are equivalent to their RTC_LOG counterparts except that
697// they only generate code in debug builds.
698#if RTC_DLOG_IS_ON
699#define RTC_DLOG(sev) RTC_LOG(sev)
700#define RTC_DLOG_V(sev) RTC_LOG_V(sev)
701#define RTC_DLOG_F(sev) RTC_LOG_F(sev)
702#else
Mirko Bonadeif1df04b2020-03-23 19:53:23 +0100703#define RTC_DLOG_EAT_STREAM_PARAMS() \
704 while (false) \
705 ::rtc::webrtc_logging_impl::LogMessageVoidify() & \
706 (::rtc::webrtc_logging_impl::LogStreamer<>())
Karl Wibergcefc4652018-05-23 23:20:38 +0200707#define RTC_DLOG(sev) RTC_DLOG_EAT_STREAM_PARAMS()
708#define RTC_DLOG_V(sev) RTC_DLOG_EAT_STREAM_PARAMS()
709#define RTC_DLOG_F(sev) RTC_DLOG_EAT_STREAM_PARAMS()
Fredrik Solenbergb3d7cac2017-11-17 15:22:37 +0100710#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200711
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200712} // namespace rtc
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000713
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200714#endif // RTC_BASE_LOGGING_H_