blob: 3ac12d7e6f4929765f632d4ed6bb974d992cc26a [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"
Steve Anton10542f22019-01-11 09:11:00 -080057#include "rtc_base/constructor_magic.h"
Jonas Olssond8c50782018-09-07 11:21:28 +020058#include "rtc_base/strings/string_builder.h"
Karl Wibergcefc4652018-05-23 23:20:38 +020059#include "rtc_base/system/inline.h"
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020060
Fredrik Solenbergb3d7cac2017-11-17 15:22:37 +010061#if !defined(NDEBUG) || defined(DLOG_ALWAYS_ON)
62#define RTC_DLOG_IS_ON 1
63#else
64#define RTC_DLOG_IS_ON 0
65#endif
66
Artem Titov6a4a1462019-11-26 16:24:46 +010067#if defined(RTC_DISABLE_LOGGING)
68#define RTC_LOG_ENABLED() 0
69#else
70#define RTC_LOG_ENABLED() 1
71#endif
72
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020073namespace rtc {
74
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020075//////////////////////////////////////////////////////////////////////
76
77// Note that the non-standard LoggingSeverity aliases exist because they are
78// still in broad use. The meanings of the levels are:
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020079// LS_VERBOSE: This level is for data which we do not want to appear in the
80// normal debug log, but should appear in diagnostic logs.
81// LS_INFO: Chatty level used in debugging for all sorts of things, the default
82// in debug builds.
83// LS_WARNING: Something that may warrant investigation.
84// LS_ERROR: Something that should not have occurred.
85// LS_NONE: Don't log.
86enum LoggingSeverity {
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020087 LS_VERBOSE,
88 LS_INFO,
89 LS_WARNING,
90 LS_ERROR,
91 LS_NONE,
Harald Alvestrand97597c02021-11-04 12:01:23 +000092 // Compatibility aliases, to be deleted.
93 // TODO(bugs.webrtc.org/13362): Remove usage and delete.
Harald Alvestranda18cad92021-11-23 13:53:29 +000094 INFO [[deprecated("Use LS_INFO")]] = LS_INFO,
Harald Alvestrandef5b21e2021-11-27 21:31:08 +000095 WARNING [[deprecated("Use LS_WARNING")]] = LS_WARNING,
Harald Alvestrand5f341302021-11-24 10:01:32 +000096 LERROR [[deprecated("Use LS_ERROR")]] = LS_ERROR
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +020097};
98
99// LogErrorContext assists in interpreting the meaning of an error value.
100enum LogErrorContext {
101 ERRCTX_NONE,
Jonas Olssona4d87372019-07-05 19:08:33 +0200102 ERRCTX_ERRNO, // System-local errno
103 ERRCTX_HRESULT, // Windows HRESULT
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200104
105 // Abbreviations for LOG_E macro
Jonas Olssona4d87372019-07-05 19:08:33 +0200106 ERRCTX_EN = ERRCTX_ERRNO, // LOG_E(sev, EN, x)
107 ERRCTX_HR = ERRCTX_HRESULT, // LOG_E(sev, HR, x)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200108};
109
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200110class LogMessage;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200111// Virtual sink interface that can receive log messages.
112class LogSink {
113 public:
114 LogSink() {}
115 virtual ~LogSink() {}
Paulina Hensmanf1e3cb42018-06-20 14:07:05 +0200116 virtual void OnLogMessage(const std::string& msg,
117 LoggingSeverity severity,
118 const char* tag);
Jiawei Ou3ea18782018-10-31 23:14:24 -0700119 virtual void OnLogMessage(const std::string& message,
120 LoggingSeverity severity);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200121 virtual void OnLogMessage(const std::string& message) = 0;
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200122
123 private:
124 friend class ::rtc::LogMessage;
Artem Titov6a4a1462019-11-26 16:24:46 +0100125#if RTC_LOG_ENABLED()
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200126 // Members for LogMessage class to keep linked list of the registered sinks.
127 LogSink* next_ = nullptr;
128 LoggingSeverity min_severity_;
Artem Titov6a4a1462019-11-26 16:24:46 +0100129#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200130};
131
Karl Wibergcefc4652018-05-23 23:20:38 +0200132namespace webrtc_logging_impl {
133
134class LogMetadata {
135 public:
136 LogMetadata(const char* file, int line, LoggingSeverity severity)
137 : file_(file),
138 line_and_sev_(static_cast<uint32_t>(line) << 3 | severity) {}
139 LogMetadata() = default;
140
141 const char* File() const { return file_; }
142 int Line() const { return line_and_sev_ >> 3; }
143 LoggingSeverity Severity() const {
144 return static_cast<LoggingSeverity>(line_and_sev_ & 0x7);
145 }
146
147 private:
148 const char* file_;
149
150 // Line number and severity, the former in the most significant 29 bits, the
151 // latter in the least significant 3 bits. (This is an optimization; since
152 // both numbers are usually compile-time constants, this way we can load them
153 // both with a single instruction.)
154 uint32_t line_and_sev_;
155};
156static_assert(std::is_trivial<LogMetadata>::value, "");
157
158struct LogMetadataErr {
159 LogMetadata meta;
160 LogErrorContext err_ctx;
161 int err;
162};
163
164#ifdef WEBRTC_ANDROID
165struct LogMetadataTag {
166 LoggingSeverity severity;
167 const char* tag;
168};
169#endif
170
171enum class LogArgType : int8_t {
172 kEnd = 0,
173 kInt,
174 kLong,
175 kLongLong,
176 kUInt,
177 kULong,
178 kULongLong,
179 kDouble,
180 kLongDouble,
181 kCharP,
182 kStdString,
Jonas Olssonf2ce37c2018-09-12 15:32:47 +0200183 kStringView,
Karl Wibergcefc4652018-05-23 23:20:38 +0200184 kVoidP,
185 kLogMetadata,
186 kLogMetadataErr,
187#ifdef WEBRTC_ANDROID
188 kLogMetadataTag,
189#endif
190};
191
192// Wrapper for log arguments. Only ever make values of this type with the
193// MakeVal() functions.
194template <LogArgType N, typename T>
195struct Val {
196 static constexpr LogArgType Type() { return N; }
197 T GetVal() const { return val; }
198 T val;
199};
200
Sebastian Janssonb1138622019-04-11 16:48:15 +0200201// Case for when we need to construct a temp string and then print that.
202// (We can't use Val<CheckArgType::kStdString, const std::string*>
203// because we need somewhere to store the temp string.)
204struct ToStringVal {
Karl Wibergcefc4652018-05-23 23:20:38 +0200205 static constexpr LogArgType Type() { return LogArgType::kStdString; }
206 const std::string* GetVal() const { return &val; }
207 std::string val;
208};
209
210inline Val<LogArgType::kInt, int> MakeVal(int x) {
211 return {x};
212}
213inline Val<LogArgType::kLong, long> MakeVal(long x) {
214 return {x};
215}
216inline Val<LogArgType::kLongLong, long long> MakeVal(long long x) {
217 return {x};
218}
219inline Val<LogArgType::kUInt, unsigned int> MakeVal(unsigned int x) {
220 return {x};
221}
222inline Val<LogArgType::kULong, unsigned long> MakeVal(unsigned long x) {
223 return {x};
224}
225inline Val<LogArgType::kULongLong, unsigned long long> MakeVal(
226 unsigned long long x) {
227 return {x};
228}
229
230inline Val<LogArgType::kDouble, double> MakeVal(double x) {
231 return {x};
232}
233inline Val<LogArgType::kLongDouble, long double> MakeVal(long double x) {
234 return {x};
235}
236
237inline Val<LogArgType::kCharP, const char*> MakeVal(const char* x) {
238 return {x};
239}
240inline Val<LogArgType::kStdString, const std::string*> MakeVal(
241 const std::string& x) {
242 return {&x};
243}
Jonas Olssonf2ce37c2018-09-12 15:32:47 +0200244inline Val<LogArgType::kStringView, const absl::string_view*> MakeVal(
245 const absl::string_view& x) {
246 return {&x};
247}
Karl Wibergcefc4652018-05-23 23:20:38 +0200248
249inline Val<LogArgType::kVoidP, const void*> MakeVal(const void* x) {
250 return {x};
251}
252
253inline Val<LogArgType::kLogMetadata, LogMetadata> MakeVal(
254 const LogMetadata& x) {
255 return {x};
256}
257inline Val<LogArgType::kLogMetadataErr, LogMetadataErr> MakeVal(
258 const LogMetadataErr& x) {
259 return {x};
260}
261
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700262// The enum class types are not implicitly convertible to arithmetic types.
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200263template <typename T,
264 absl::enable_if_t<std::is_enum<T>::value &&
265 !std::is_arithmetic<T>::value>* = nullptr>
266inline decltype(MakeVal(std::declval<absl::underlying_type_t<T>>())) MakeVal(
267 T x) {
268 return {static_cast<absl::underlying_type_t<T>>(x)};
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700269}
270
Karl Wibergcefc4652018-05-23 23:20:38 +0200271#ifdef WEBRTC_ANDROID
272inline Val<LogArgType::kLogMetadataTag, LogMetadataTag> MakeVal(
273 const LogMetadataTag& x) {
274 return {x};
275}
276#endif
277
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200278template <typename T, class = void>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200279struct has_to_log_string : std::false_type {};
280template <typename T>
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200281struct has_to_log_string<T, decltype(ToLogString(std::declval<T>()))>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200282 : std::true_type {};
283
Karl Wibergcefc4652018-05-23 23:20:38 +0200284// Handle arbitrary types other than the above by falling back to stringstream.
285// TODO(bugs.webrtc.org/9278): Get rid of this overload when callers don't need
286// it anymore. No in-tree caller does, but some external callers still do.
287template <
288 typename T,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200289 typename T1 = absl::decay_t<T>,
290 absl::enable_if_t<std::is_class<T1>::value &&
291 !std::is_same<T1, std::string>::value &&
292 !std::is_same<T1, LogMetadata>::value &&
293 !has_to_log_string<T1>::value &&
Karl Wibergcefc4652018-05-23 23:20:38 +0200294#ifdef WEBRTC_ANDROID
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200295 !std::is_same<T1, LogMetadataTag>::value &&
Karl Wibergcefc4652018-05-23 23:20:38 +0200296#endif
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200297 !std::is_same<T1, LogMetadataErr>::value>* = nullptr>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200298ToStringVal MakeVal(const T& x) {
Karl Wibergcefc4652018-05-23 23:20:38 +0200299 std::ostringstream os; // no-presubmit-check TODO(webrtc:8982)
300 os << x;
301 return {os.str()};
302}
303
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200304template <typename T, absl::enable_if_t<has_to_log_string<T>::value>* = nullptr>
Sebastian Janssonb1138622019-04-11 16:48:15 +0200305ToStringVal MakeVal(const T& x) {
306 return {ToLogString(x)};
307}
308
Artem Titov6a4a1462019-11-26 16:24:46 +0100309#if RTC_LOG_ENABLED()
Karl Wibergcefc4652018-05-23 23:20:38 +0200310void Log(const LogArgType* fmt, ...);
Artem Titov6a4a1462019-11-26 16:24:46 +0100311#else
312inline void Log(const LogArgType* fmt, ...) {
313 // Do nothing, shouldn't be invoked
314}
315#endif
Karl Wibergcefc4652018-05-23 23:20:38 +0200316
317// Ephemeral type that represents the result of the logging << operator.
318template <typename... Ts>
319class LogStreamer;
320
321// Base case: Before the first << argument.
322template <>
323class LogStreamer<> final {
324 public:
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700325 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200326 typename V = decltype(MakeVal(std::declval<U>())),
327 absl::enable_if_t<std::is_arithmetic<U>::value ||
328 std::is_enum<U>::value>* = nullptr>
329 RTC_FORCE_INLINE LogStreamer<V> operator<<(U arg) const {
330 return LogStreamer<V>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200331 }
332
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700333 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200334 typename V = decltype(MakeVal(std::declval<U>())),
335 absl::enable_if_t<!std::is_arithmetic<U>::value &&
336 !std::is_enum<U>::value>* = nullptr>
337 RTC_FORCE_INLINE LogStreamer<V> operator<<(const U& arg) const {
338 return LogStreamer<V>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200339 }
340
341 template <typename... Us>
342 RTC_FORCE_INLINE static void Call(const Us&... args) {
343 static constexpr LogArgType t[] = {Us::Type()..., LogArgType::kEnd};
344 Log(t, args.GetVal()...);
345 }
346};
347
348// Inductive case: We've already seen at least one << argument. The most recent
349// one had type `T`, and the earlier ones had types `Ts`.
350template <typename T, typename... Ts>
351class LogStreamer<T, Ts...> final {
352 public:
353 RTC_FORCE_INLINE LogStreamer(T arg, const LogStreamer<Ts...>* prior)
354 : arg_(arg), prior_(prior) {}
355
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700356 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200357 typename V = decltype(MakeVal(std::declval<U>())),
358 absl::enable_if_t<std::is_arithmetic<U>::value ||
359 std::is_enum<U>::value>* = nullptr>
360 RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(U arg) const {
361 return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200362 }
363
Amit Hilbuch10c5a932019-03-18 13:09:18 -0700364 template <typename U,
Sebastian Janssonf4e085a2019-05-20 18:34:07 +0200365 typename V = decltype(MakeVal(std::declval<U>())),
366 absl::enable_if_t<!std::is_arithmetic<U>::value &&
367 !std::is_enum<U>::value>* = nullptr>
368 RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(const U& arg) const {
369 return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
Karl Wibergcefc4652018-05-23 23:20:38 +0200370 }
371
372 template <typename... Us>
373 RTC_FORCE_INLINE void Call(const Us&... args) const {
374 prior_->Call(arg_, args...);
375 }
376
377 private:
378 // The most recent argument.
379 T arg_;
380
381 // Earlier arguments.
382 const LogStreamer<Ts...>* prior_;
383};
384
385class LogCall final {
386 public:
387 // This can be any binary operator with precedence lower than <<.
Artem Titov6a4a1462019-11-26 16:24:46 +0100388 // We return bool here to be able properly remove logging if
389 // RTC_DISABLE_LOGGING is defined.
Karl Wibergcefc4652018-05-23 23:20:38 +0200390 template <typename... Ts>
Artem Titov6a4a1462019-11-26 16:24:46 +0100391 RTC_FORCE_INLINE bool operator&(const LogStreamer<Ts...>& streamer) {
Karl Wibergcefc4652018-05-23 23:20:38 +0200392 streamer.Call();
Artem Titov6a4a1462019-11-26 16:24:46 +0100393 return true;
Karl Wibergcefc4652018-05-23 23:20:38 +0200394 }
395};
396
Mirko Bonadeif1df04b2020-03-23 19:53:23 +0100397// This class is used to explicitly ignore values in the conditional
398// logging macros. This avoids compiler warnings like "value computed
399// is not used" and "statement has no effect".
400class LogMessageVoidify {
401 public:
402 LogMessageVoidify() = default;
403 // This has to be an operator with a precedence lower than << but
404 // higher than ?:
405 template <typename... Ts>
406 void operator&(LogStreamer<Ts...>&& streamer) {}
407};
408
Karl Wibergcefc4652018-05-23 23:20:38 +0200409} // namespace webrtc_logging_impl
410
411// Direct use of this class is deprecated; please use the logging macros
412// instead.
413// TODO(bugs.webrtc.org/9278): Move this class to an unnamed namespace in the
414// .cc file.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200415class LogMessage {
416 public:
Karl Wiberg1ffb3742018-05-04 15:04:48 +0200417 // Same as the above, but using a compile-time constant for the logging
418 // severity. This saves space at the call site, since passing an empty struct
419 // is generally the same as not passing an argument at all.
420 template <LoggingSeverity S>
421 RTC_NO_INLINE LogMessage(const char* file,
422 int line,
423 std::integral_constant<LoggingSeverity, S>)
424 : LogMessage(file, line, S) {}
425
Artem Titov6a4a1462019-11-26 16:24:46 +0100426#if RTC_LOG_ENABLED()
427 LogMessage(const char* file, int line, LoggingSeverity sev);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200428 LogMessage(const char* file,
429 int line,
430 LoggingSeverity sev,
Karl Wibergab4f1c12018-05-04 10:42:28 +0200431 LogErrorContext err_ctx,
432 int err);
Tommie51a0a82018-02-27 15:30:29 +0100433#if defined(WEBRTC_ANDROID)
434 LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag);
435#endif
Tommie51a0a82018-02-27 15:30:29 +0100436 // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
437 // Android code should use the 'const char*' version since tags are static
438 // and we want to avoid allocating a std::string copy per log line.
Danil Chapovalove9041612021-02-22 12:43:39 +0100439 ABSL_DEPRECATED("Use RTC_LOG macros instead of accessing this class directly")
Yves Gerey665174f2018-06-19 15:03:05 +0200440 LogMessage(const char* file,
441 int line,
442 LoggingSeverity sev,
Philip Eliasson278aa422018-02-26 14:54:45 +0000443 const std::string& tag);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200444 ~LogMessage();
445
Karl Wibergcefc4652018-05-23 23:20:38 +0200446 void AddTag(const char* tag);
Jonas Olssond8c50782018-09-07 11:21:28 +0200447 rtc::StringBuilder& stream();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200448 // Returns the time at which this function was called for the first time.
449 // The time will be used as the logging start time.
450 // If this is not called externally, the LogMessage ctor also calls it, in
451 // which case the logging start time will be the time of the first LogMessage
452 // instance is created.
453 static int64_t LogStartTime();
Artem Titov96e3b992021-07-26 16:03:14 +0200454 // Returns the wall clock equivalent of `LogStartTime`, in seconds from the
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200455 // epoch.
456 static uint32_t WallClockStartTime();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200457 // LogThreads: Display the thread identifier of the current thread
458 static void LogThreads(bool on = true);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200459 // LogTimestamps: Display the elapsed time of the program
460 static void LogTimestamps(bool on = true);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200461 // These are the available logging channels
462 // Debug: Debug console on Windows, otherwise stderr
463 static void LogToDebug(LoggingSeverity min_sev);
Jonas Olsson2b6f1352018-02-15 11:57:03 +0100464 static LoggingSeverity GetLogToDebug();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200465 // Sets whether logs will be directed to stderr in debug mode.
466 static void SetLogToStderr(bool log_to_stderr);
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200467 // Stream: Any non-blocking stream interface.
Artem Titov96e3b992021-07-26 16:03:14 +0200468 // Installs the `stream` to collect logs with severtiy `min_sev` or higher.
469 // `stream` must live until deinstalled by RemoveLogToStream.
470 // If `stream` is the first stream added to the system, we might miss some
Markus Handell531bd0f2020-07-08 10:58:19 +0200471 // early concurrent log statement happening from another thread happening near
472 // this instant.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200473 static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev);
Markus Handell531bd0f2020-07-08 10:58:19 +0200474 // Removes the specified stream, without destroying it. When the method
Artem Titov96e3b992021-07-26 16:03:14 +0200475 // has completed, it's guaranteed that `stream` will receive no more logging
Markus Handell531bd0f2020-07-08 10:58:19 +0200476 // calls.
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200477 static void RemoveLogToStream(LogSink* stream);
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200478 // Returns the severity for the specified stream, of if none is specified,
479 // the minimum stream severity.
480 static int GetLogToStream(LogSink* stream = nullptr);
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200481 // Testing against MinLogSeverity allows code to avoid potentially expensive
482 // logging operations by pre-checking the logging level.
Jonas Olsson2b6f1352018-02-15 11:57:03 +0100483 static int GetMinLogSeverity();
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200484 // Parses the provided parameter stream to configure the options above.
485 // Useful for configuring logging from the command line.
486 static void ConfigureLogging(const char* params);
Artem Titov96e3b992021-07-26 16:03:14 +0200487 // Checks the current global debug severity and if the `streams_` collection
488 // is empty. If `severity` is smaller than the global severity and if the
489 // `streams_` collection is empty, the LogMessage will be considered a noop
Jonas Olssond8c50782018-09-07 11:21:28 +0200490 // LogMessage.
491 static bool IsNoop(LoggingSeverity severity);
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200492 // Version of IsNoop that uses fewer instructions at the call site, since the
493 // caller doesn't have to pass an argument.
494 template <LoggingSeverity S>
495 RTC_NO_INLINE static bool IsNoop() {
496 return IsNoop(S);
497 }
Artem Titov6a4a1462019-11-26 16:24:46 +0100498#else
499 // Next methods do nothing; no one will call these functions.
500 LogMessage(const char* file, int line, LoggingSeverity sev) {}
501 LogMessage(const char* file,
502 int line,
503 LoggingSeverity sev,
504 LogErrorContext err_ctx,
505 int err) {}
506#if defined(WEBRTC_ANDROID)
507 LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag) {
508 }
509#endif
510 // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
511 // Android code should use the 'const char*' version since tags are static
512 // and we want to avoid allocating a std::string copy per log line.
Danil Chapovalove9041612021-02-22 12:43:39 +0100513 ABSL_DEPRECATED("Use RTC_LOG macros instead of accessing this class directly")
Artem Titov6a4a1462019-11-26 16:24:46 +0100514 LogMessage(const char* file,
515 int line,
516 LoggingSeverity sev,
517 const std::string& tag) {}
518 ~LogMessage() = default;
519
520 inline void AddTag(const char* tag) {}
521 inline rtc::StringBuilder& stream() { return print_stream_; }
522 inline static int64_t LogStartTime() { return 0; }
523 inline static uint32_t WallClockStartTime() { return 0; }
524 inline static void LogThreads(bool on = true) {}
525 inline static void LogTimestamps(bool on = true) {}
526 inline static void LogToDebug(LoggingSeverity min_sev) {}
527 inline static LoggingSeverity GetLogToDebug() {
528 return LoggingSeverity::LS_INFO;
529 }
530 inline static void SetLogToStderr(bool log_to_stderr) {}
531 inline static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev) {}
532 inline static void RemoveLogToStream(LogSink* stream) {}
533 inline static int GetLogToStream(LogSink* stream = nullptr) { return 0; }
534 inline static int GetMinLogSeverity() { return 0; }
535 inline static void ConfigureLogging(const char* params) {}
Karl Wiberg0e884382020-09-22 09:34:45 +0200536 static constexpr bool IsNoop(LoggingSeverity severity) { return true; }
Karl Wibergdd7df5c2020-09-22 11:07:53 +0200537 template <LoggingSeverity S>
538 static constexpr bool IsNoop() {
539 return IsNoop(S);
540 }
Artem Titov6a4a1462019-11-26 16:24:46 +0100541#endif // RTC_LOG_ENABLED()
Jonas Olssond8c50782018-09-07 11:21:28 +0200542
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200543 private:
Tommifef05002018-02-27 13:51:08 +0100544 friend class LogMessageForTesting;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200545
Artem Titov6a4a1462019-11-26 16:24:46 +0100546#if RTC_LOG_ENABLED()
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200547 // Updates min_sev_ appropriately when debug sinks change.
548 static void UpdateMinLogSeverity();
549
Yves Gerey665174f2018-06-19 15:03:05 +0200550// These write out the actual log messages.
Tommie51a0a82018-02-27 15:30:29 +0100551#if defined(WEBRTC_ANDROID)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200552 static void OutputToDebug(const std::string& msg,
553 LoggingSeverity severity,
Tommie51a0a82018-02-27 15:30:29 +0100554 const char* tag);
555#else
556 static void OutputToDebug(const std::string& msg, LoggingSeverity severity);
Artem Titov6a4a1462019-11-26 16:24:46 +0100557#endif // defined(WEBRTC_ANDROID)
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200558
Tommifef05002018-02-27 13:51:08 +0100559 // Called from the dtor (or from a test) to append optional extra error
560 // information to the log stream and a newline character.
561 void FinishPrintStream();
562
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200563 // The severity level of this message
564 LoggingSeverity severity_;
565
Tommie51a0a82018-02-27 15:30:29 +0100566#if defined(WEBRTC_ANDROID)
Paulina Hensmanf1e3cb42018-06-20 14:07:05 +0200567 // The default Android debug output tag.
Tommie51a0a82018-02-27 15:30:29 +0100568 const char* tag_ = "libjingle";
569#endif
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200570
571 // String data generated in the constructor, that should be appended to
572 // the message before output.
573 std::string extra_;
574
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200575 // The output streams and their associated severities
Danil Chapovalovb9f69022019-10-21 09:19:10 +0200576 static LogSink* streams_;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200577
Artem Titov96e3b992021-07-26 16:03:14 +0200578 // Holds true with high probability if `streams_` is empty, false with high
Markus Handellce1ff6f2020-07-08 08:52:48 +0200579 // probability otherwise. Operated on with std::memory_order_relaxed because
Markus Handell531bd0f2020-07-08 10:58:19 +0200580 // it's ok to lose or log some additional statements near the instant streams
Markus Handellce1ff6f2020-07-08 08:52:48 +0200581 // are added/removed.
582 static std::atomic<bool> streams_empty_;
583
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200584 // Flags for formatting options
585 static bool thread_, timestamp_;
586
587 // Determines if logs will be directed to stderr in debug mode.
588 static bool log_to_stderr_;
Artem Titov6a4a1462019-11-26 16:24:46 +0100589#else // RTC_LOG_ENABLED()
590 // Next methods do nothing; no one will call these functions.
591 inline static void UpdateMinLogSeverity() {}
592#if defined(WEBRTC_ANDROID)
593 inline static void OutputToDebug(const std::string& msg,
594 LoggingSeverity severity,
595 const char* tag) {}
596#else
597 inline static void OutputToDebug(const std::string& msg,
598 LoggingSeverity severity) {}
599#endif // defined(WEBRTC_ANDROID)
600 inline void FinishPrintStream() {}
601#endif // RTC_LOG_ENABLED()
602
603 // The stringbuilder that buffers the formatted message before output
604 rtc::StringBuilder print_stream_;
Henrik Kjellanderec78f1c2017-06-29 07:52:50 +0200605
606 RTC_DISALLOW_COPY_AND_ASSIGN(LogMessage);
607};
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_