1 /*
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 
11 // RTC_LOG(...) an ostream target that can be used to send formatted
12 // output to a variety of logging targets, such as debugger console, stderr,
13 // or any LogSink.
14 // The severity level passed as the first argument to the logging
15 // functions is used as a filter, to limit the verbosity of the logging.
16 // Static members of LogMessage documented below are used to control the
17 // verbosity and target of the output.
18 // There are several variations on the RTC_LOG macro which facilitate logging
19 // of common error conditions, detailed below.
20 
21 // RTC_LOG(sev) logs the given stream at severity "sev", which must be a
22 //     compile-time constant of the LoggingSeverity type, without the namespace
23 //     prefix.
24 // 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.
29 // RTC_LOG_GLE(sev [, mod]) attempt to add a string description of the
30 //     HRESULT returned by GetLastError.
31 // RTC_LOG_ERRNO(sev) attempts to add a string description of an errno-derived
32 //     error. errno and associated facilities exist on both Windows and POSIX,
33 //     but on Windows they only apply to the C/C++ runtime.
34 // RTC_LOG_ERR(sev) is an alias for the platform's normal error system, i.e.
35 //     _GLE on Windows and _ERRNO on POSIX.
36 // (The above three also all have _EX versions that let you specify the error
37 // code, rather than using the last one.)
38 // RTC_LOG_E(sev, ctx, err, ...) logs a detailed error interpreted using the
39 //     specified context.
40 // 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.
43 
44 #ifndef RTC_BASE_LOGGING_H_
45 #define RTC_BASE_LOGGING_H_
46 
47 #include <errno.h>
48 
49 #include <atomic>
50 #include <sstream>  // no-presubmit-check TODO(webrtc:8982)
51 #include <string>
52 #include <utility>
53 
54 #include "absl/meta/type_traits.h"
55 #include "absl/strings/string_view.h"
56 #include "rtc_base/constructor_magic.h"
57 #include "rtc_base/deprecation.h"
58 #include "rtc_base/strings/string_builder.h"
59 #include "rtc_base/system/inline.h"
60 
61 #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 
67 #if defined(RTC_DISABLE_LOGGING)
68 #define RTC_LOG_ENABLED() 0
69 #else
70 #define RTC_LOG_ENABLED() 1
71 #endif
72 
73 namespace rtc {
74 
75 //////////////////////////////////////////////////////////////////////
76 
77 // Note that the non-standard LoggingSeverity aliases exist because they are
78 // still in broad use.  The meanings of the levels are:
79 //  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.
86 enum LoggingSeverity {
87   LS_VERBOSE,
88   LS_INFO,
89   LS_WARNING,
90   LS_ERROR,
91   LS_NONE,
92   INFO = LS_INFO,
93   WARNING = LS_WARNING,
94   LERROR = LS_ERROR
95 };
96 
97 // LogErrorContext assists in interpreting the meaning of an error value.
98 enum LogErrorContext {
99   ERRCTX_NONE,
100   ERRCTX_ERRNO,    // System-local errno
101   ERRCTX_HRESULT,  // Windows HRESULT
102 
103   // Abbreviations for LOG_E macro
104   ERRCTX_EN = ERRCTX_ERRNO,    // LOG_E(sev, EN, x)
105   ERRCTX_HR = ERRCTX_HRESULT,  // LOG_E(sev, HR, x)
106 };
107 
108 class LogMessage;
109 // Virtual sink interface that can receive log messages.
110 class LogSink {
111  public:
LogSink()112   LogSink() {}
~LogSink()113   virtual ~LogSink() {}
114   virtual void OnLogMessage(const std::string& msg,
115                             LoggingSeverity severity,
116                             const char* tag);
117   virtual void OnLogMessage(const std::string& message,
118                             LoggingSeverity severity);
119   virtual void OnLogMessage(const std::string& message) = 0;
120 
121  private:
122   friend class ::rtc::LogMessage;
123 #if RTC_LOG_ENABLED()
124   // Members for LogMessage class to keep linked list of the registered sinks.
125   LogSink* next_ = nullptr;
126   LoggingSeverity min_severity_;
127 #endif
128 };
129 
130 namespace webrtc_logging_impl {
131 
132 class LogMetadata {
133  public:
LogMetadata(const char * file,int line,LoggingSeverity severity)134   LogMetadata(const char* file, int line, LoggingSeverity severity)
135       : file_(file),
136         line_and_sev_(static_cast<uint32_t>(line) << 3 | severity) {}
137   LogMetadata() = default;
138 
File()139   const char* File() const { return file_; }
Line()140   int Line() const { return line_and_sev_ >> 3; }
Severity()141   LoggingSeverity Severity() const {
142     return static_cast<LoggingSeverity>(line_and_sev_ & 0x7);
143   }
144 
145  private:
146   const char* file_;
147 
148   // Line number and severity, the former in the most significant 29 bits, the
149   // latter in the least significant 3 bits. (This is an optimization; since
150   // both numbers are usually compile-time constants, this way we can load them
151   // both with a single instruction.)
152   uint32_t line_and_sev_;
153 };
154 static_assert(std::is_trivial<LogMetadata>::value, "");
155 
156 struct LogMetadataErr {
157   LogMetadata meta;
158   LogErrorContext err_ctx;
159   int err;
160 };
161 
162 #ifdef WEBRTC_ANDROID
163 struct LogMetadataTag {
164   LoggingSeverity severity;
165   const char* tag;
166 };
167 #endif
168 
169 enum class LogArgType : int8_t {
170   kEnd = 0,
171   kInt,
172   kLong,
173   kLongLong,
174   kUInt,
175   kULong,
176   kULongLong,
177   kDouble,
178   kLongDouble,
179   kCharP,
180   kStdString,
181   kStringView,
182   kVoidP,
183   kLogMetadata,
184   kLogMetadataErr,
185 #ifdef WEBRTC_ANDROID
186   kLogMetadataTag,
187 #endif
188 };
189 
190 // Wrapper for log arguments. Only ever make values of this type with the
191 // MakeVal() functions.
192 template <LogArgType N, typename T>
193 struct Val {
TypeVal194   static constexpr LogArgType Type() { return N; }
GetValVal195   T GetVal() const { return val; }
196   T val;
197 };
198 
199 // Case for when we need to construct a temp string and then print that.
200 // (We can't use Val<CheckArgType::kStdString, const std::string*>
201 // because we need somewhere to store the temp string.)
202 struct ToStringVal {
TypeToStringVal203   static constexpr LogArgType Type() { return LogArgType::kStdString; }
GetValToStringVal204   const std::string* GetVal() const { return &val; }
205   std::string val;
206 };
207 
MakeVal(int x)208 inline Val<LogArgType::kInt, int> MakeVal(int x) {
209   return {x};
210 }
MakeVal(long x)211 inline Val<LogArgType::kLong, long> MakeVal(long x) {
212   return {x};
213 }
MakeVal(long long x)214 inline Val<LogArgType::kLongLong, long long> MakeVal(long long x) {
215   return {x};
216 }
MakeVal(unsigned int x)217 inline Val<LogArgType::kUInt, unsigned int> MakeVal(unsigned int x) {
218   return {x};
219 }
MakeVal(unsigned long x)220 inline Val<LogArgType::kULong, unsigned long> MakeVal(unsigned long x) {
221   return {x};
222 }
MakeVal(unsigned long long x)223 inline Val<LogArgType::kULongLong, unsigned long long> MakeVal(
224     unsigned long long x) {
225   return {x};
226 }
227 
MakeVal(double x)228 inline Val<LogArgType::kDouble, double> MakeVal(double x) {
229   return {x};
230 }
MakeVal(long double x)231 inline Val<LogArgType::kLongDouble, long double> MakeVal(long double x) {
232   return {x};
233 }
234 
MakeVal(const char * x)235 inline Val<LogArgType::kCharP, const char*> MakeVal(const char* x) {
236   return {x};
237 }
MakeVal(const std::string & x)238 inline Val<LogArgType::kStdString, const std::string*> MakeVal(
239     const std::string& x) {
240   return {&x};
241 }
MakeVal(const absl::string_view & x)242 inline Val<LogArgType::kStringView, const absl::string_view*> MakeVal(
243     const absl::string_view& x) {
244   return {&x};
245 }
246 
MakeVal(const void * x)247 inline Val<LogArgType::kVoidP, const void*> MakeVal(const void* x) {
248   return {x};
249 }
250 
MakeVal(const LogMetadata & x)251 inline Val<LogArgType::kLogMetadata, LogMetadata> MakeVal(
252     const LogMetadata& x) {
253   return {x};
254 }
MakeVal(const LogMetadataErr & x)255 inline Val<LogArgType::kLogMetadataErr, LogMetadataErr> MakeVal(
256     const LogMetadataErr& x) {
257   return {x};
258 }
259 
260 // The enum class types are not implicitly convertible to arithmetic types.
261 template <typename T,
262           absl::enable_if_t<std::is_enum<T>::value &&
263                             !std::is_arithmetic<T>::value>* = nullptr>
decltype(MakeVal (std::declval<absl::underlying_type_t<T>> ()))264 inline decltype(MakeVal(std::declval<absl::underlying_type_t<T>>())) MakeVal(
265     T x) {
266   return {static_cast<absl::underlying_type_t<T>>(x)};
267 }
268 
269 #ifdef WEBRTC_ANDROID
MakeVal(const LogMetadataTag & x)270 inline Val<LogArgType::kLogMetadataTag, LogMetadataTag> MakeVal(
271     const LogMetadataTag& x) {
272   return {x};
273 }
274 #endif
275 
276 template <typename T, class = void>
277 struct has_to_log_string : std::false_type {};
278 template <typename T>
279 struct has_to_log_string<T, decltype(ToLogString(std::declval<T>()))>
280     : std::true_type {};
281 
282 // Handle arbitrary types other than the above by falling back to stringstream.
283 // TODO(bugs.webrtc.org/9278): Get rid of this overload when callers don't need
284 // it anymore. No in-tree caller does, but some external callers still do.
285 template <
286     typename T,
287     typename T1 = absl::decay_t<T>,
288     absl::enable_if_t<std::is_class<T1>::value &&
289                       !std::is_same<T1, std::string>::value &&
290                       !std::is_same<T1, LogMetadata>::value &&
291                       !has_to_log_string<T1>::value &&
292 #ifdef WEBRTC_ANDROID
293                       !std::is_same<T1, LogMetadataTag>::value &&
294 #endif
295                       !std::is_same<T1, LogMetadataErr>::value>* = nullptr>
296 ToStringVal MakeVal(const T& x) {
297   std::ostringstream os;  // no-presubmit-check TODO(webrtc:8982)
298   os << x;
299   return {os.str()};
300 }
301 
302 template <typename T, absl::enable_if_t<has_to_log_string<T>::value>* = nullptr>
303 ToStringVal MakeVal(const T& x) {
304   return {ToLogString(x)};
305 }
306 
307 #if RTC_LOG_ENABLED()
308 void Log(const LogArgType* fmt, ...);
309 #else
310 inline void Log(const LogArgType* fmt, ...) {
311   // Do nothing, shouldn't be invoked
312 }
313 #endif
314 
315 // Ephemeral type that represents the result of the logging << operator.
316 template <typename... Ts>
317 class LogStreamer;
318 
319 // Base case: Before the first << argument.
320 template <>
321 class LogStreamer<> final {
322  public:
323   template <typename U,
324             typename V = decltype(MakeVal(std::declval<U>())),
325             absl::enable_if_t<std::is_arithmetic<U>::value ||
326                               std::is_enum<U>::value>* = nullptr>
327   RTC_FORCE_INLINE LogStreamer<V> operator<<(U arg) const {
328     return LogStreamer<V>(MakeVal(arg), this);
329   }
330 
331   template <typename U,
332             typename V = decltype(MakeVal(std::declval<U>())),
333             absl::enable_if_t<!std::is_arithmetic<U>::value &&
334                               !std::is_enum<U>::value>* = nullptr>
335   RTC_FORCE_INLINE LogStreamer<V> operator<<(const U& arg) const {
336     return LogStreamer<V>(MakeVal(arg), this);
337   }
338 
339   template <typename... Us>
340   RTC_FORCE_INLINE static void Call(const Us&... args) {
341     static constexpr LogArgType t[] = {Us::Type()..., LogArgType::kEnd};
342     Log(t, args.GetVal()...);
343   }
344 };
345 
346 // Inductive case: We've already seen at least one << argument. The most recent
347 // one had type `T`, and the earlier ones had types `Ts`.
348 template <typename T, typename... Ts>
349 class LogStreamer<T, Ts...> final {
350  public:
351   RTC_FORCE_INLINE LogStreamer(T arg, const LogStreamer<Ts...>* prior)
352       : arg_(arg), prior_(prior) {}
353 
354   template <typename U,
355             typename V = decltype(MakeVal(std::declval<U>())),
356             absl::enable_if_t<std::is_arithmetic<U>::value ||
357                               std::is_enum<U>::value>* = nullptr>
358   RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(U arg) const {
359     return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
360   }
361 
362   template <typename U,
363             typename V = decltype(MakeVal(std::declval<U>())),
364             absl::enable_if_t<!std::is_arithmetic<U>::value &&
365                               !std::is_enum<U>::value>* = nullptr>
366   RTC_FORCE_INLINE LogStreamer<V, T, Ts...> operator<<(const U& arg) const {
367     return LogStreamer<V, T, Ts...>(MakeVal(arg), this);
368   }
369 
370   template <typename... Us>
371   RTC_FORCE_INLINE void Call(const Us&... args) const {
372     prior_->Call(arg_, args...);
373   }
374 
375  private:
376   // The most recent argument.
377   T arg_;
378 
379   // Earlier arguments.
380   const LogStreamer<Ts...>* prior_;
381 };
382 
383 class LogCall final {
384  public:
385   // This can be any binary operator with precedence lower than <<.
386   // We return bool here to be able properly remove logging if
387   // RTC_DISABLE_LOGGING is defined.
388   template <typename... Ts>
389   RTC_FORCE_INLINE bool operator&(const LogStreamer<Ts...>& streamer) {
390     streamer.Call();
391     return true;
392   }
393 };
394 
395 // This class is used to explicitly ignore values in the conditional
396 // logging macros.  This avoids compiler warnings like "value computed
397 // is not used" and "statement has no effect".
398 class LogMessageVoidify {
399  public:
400   LogMessageVoidify() = default;
401   // This has to be an operator with a precedence lower than << but
402   // higher than ?:
403   template <typename... Ts>
404   void operator&(LogStreamer<Ts...>&& streamer) {}
405 };
406 
407 }  // namespace webrtc_logging_impl
408 
409 // Direct use of this class is deprecated; please use the logging macros
410 // instead.
411 // TODO(bugs.webrtc.org/9278): Move this class to an unnamed namespace in the
412 // .cc file.
413 class LogMessage {
414  public:
415   // Same as the above, but using a compile-time constant for the logging
416   // severity. This saves space at the call site, since passing an empty struct
417   // is generally the same as not passing an argument at all.
418   template <LoggingSeverity S>
419   RTC_NO_INLINE LogMessage(const char* file,
420                            int line,
421                            std::integral_constant<LoggingSeverity, S>)
422       : LogMessage(file, line, S) {}
423 
424 #if RTC_LOG_ENABLED()
425   LogMessage(const char* file, int line, LoggingSeverity sev);
426   LogMessage(const char* file,
427              int line,
428              LoggingSeverity sev,
429              LogErrorContext err_ctx,
430              int err);
431 #if defined(WEBRTC_ANDROID)
432   LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag);
433 #endif
434   // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
435   // Android code should use the 'const char*' version since tags are static
436   // and we want to avoid allocating a std::string copy per log line.
437   RTC_DEPRECATED
438   LogMessage(const char* file,
439              int line,
440              LoggingSeverity sev,
441              const std::string& tag);
442   ~LogMessage();
443 
444   void AddTag(const char* tag);
445   rtc::StringBuilder& stream();
446   // Returns the time at which this function was called for the first time.
447   // The time will be used as the logging start time.
448   // If this is not called externally, the LogMessage ctor also calls it, in
449   // which case the logging start time will be the time of the first LogMessage
450   // instance is created.
451   static int64_t LogStartTime();
452   // Returns the wall clock equivalent of |LogStartTime|, in seconds from the
453   // epoch.
454   static uint32_t WallClockStartTime();
455   //  LogThreads: Display the thread identifier of the current thread
456   static void LogThreads(bool on = true);
457   //  LogTimestamps: Display the elapsed time of the program
458   static void LogTimestamps(bool on = true);
459   // These are the available logging channels
460   //  Debug: Debug console on Windows, otherwise stderr
461   static void LogToDebug(LoggingSeverity min_sev);
462   static LoggingSeverity GetLogToDebug();
463   // Sets whether logs will be directed to stderr in debug mode.
464   static void SetLogToStderr(bool log_to_stderr);
465   // Stream: Any non-blocking stream interface.
466   // Installs the |stream| to collect logs with severtiy |min_sev| or higher.
467   // |stream| must live until deinstalled by RemoveLogToStream.
468   // If |stream| is the first stream added to the system, we might miss some
469   // early concurrent log statement happening from another thread happening near
470   // this instant.
471   static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev);
472   // Removes the specified stream, without destroying it. When the method
473   // has completed, it's guaranteed that |stream| will receive no more logging
474   // calls.
475   static void RemoveLogToStream(LogSink* stream);
476   // Returns the severity for the specified stream, of if none is specified,
477   // the minimum stream severity.
478   static int GetLogToStream(LogSink* stream = nullptr);
479   // Testing against MinLogSeverity allows code to avoid potentially expensive
480   // logging operations by pre-checking the logging level.
481   static int GetMinLogSeverity();
482   // Parses the provided parameter stream to configure the options above.
483   // Useful for configuring logging from the command line.
484   static void ConfigureLogging(const char* params);
485   // Checks the current global debug severity and if the |streams_| collection
486   // is empty. If |severity| is smaller than the global severity and if the
487   // |streams_| collection is empty, the LogMessage will be considered a noop
488   // LogMessage.
489   static bool IsNoop(LoggingSeverity severity);
490 #else
491   // Next methods do nothing; no one will call these functions.
492   LogMessage(const char* file, int line, LoggingSeverity sev) {}
493   LogMessage(const char* file,
494              int line,
495              LoggingSeverity sev,
496              LogErrorContext err_ctx,
497              int err) {}
498 #if defined(WEBRTC_ANDROID)
499   LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag) {
500   }
501 #endif
502   // DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
503   // Android code should use the 'const char*' version since tags are static
504   // and we want to avoid allocating a std::string copy per log line.
505   RTC_DEPRECATED
506   LogMessage(const char* file,
507              int line,
508              LoggingSeverity sev,
509              const std::string& tag) {}
510   ~LogMessage() = default;
511 
512   inline void AddTag(const char* tag) {}
513   inline rtc::StringBuilder& stream() { return print_stream_; }
514   inline static int64_t LogStartTime() { return 0; }
515   inline static uint32_t WallClockStartTime() { return 0; }
516   inline static void LogThreads(bool on = true) {}
517   inline static void LogTimestamps(bool on = true) {}
518   inline static void LogToDebug(LoggingSeverity min_sev) {}
519   inline static LoggingSeverity GetLogToDebug() {
520     return LoggingSeverity::LS_INFO;
521   }
522   inline static void SetLogToStderr(bool log_to_stderr) {}
523   inline static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev) {}
524   inline static void RemoveLogToStream(LogSink* stream) {}
525   inline static int GetLogToStream(LogSink* stream = nullptr) { return 0; }
526   inline static int GetMinLogSeverity() { return 0; }
527   inline static void ConfigureLogging(const char* params) {}
528   inline static bool IsNoop(LoggingSeverity severity) { return true; }
529 #endif  // RTC_LOG_ENABLED()
530 
531  private:
532   friend class LogMessageForTesting;
533 
534 #if RTC_LOG_ENABLED()
535   // Updates min_sev_ appropriately when debug sinks change.
536   static void UpdateMinLogSeverity();
537 
538 // These write out the actual log messages.
539 #if defined(WEBRTC_ANDROID)
540   static void OutputToDebug(const std::string& msg,
541                             LoggingSeverity severity,
542                             const char* tag);
543 #else
544   static void OutputToDebug(const std::string& msg, LoggingSeverity severity);
545 #endif  // defined(WEBRTC_ANDROID)
546 
547   // Called from the dtor (or from a test) to append optional extra error
548   // information to the log stream and a newline character.
549   void FinishPrintStream();
550 
551   // The severity level of this message
552   LoggingSeverity severity_;
553 
554 #if defined(WEBRTC_ANDROID)
555   // The default Android debug output tag.
556   const char* tag_ = "libjingle";
557 #endif
558 
559   // String data generated in the constructor, that should be appended to
560   // the message before output.
561   std::string extra_;
562 
563   // The output streams and their associated severities
564   static LogSink* streams_;
565 
566   // Holds true with high probability if |streams_| is empty, false with high
567   // probability otherwise. Operated on with std::memory_order_relaxed because
568   // it's ok to lose or log some additional statements near the instant streams
569   // are added/removed.
570   static std::atomic<bool> streams_empty_;
571 
572   // Flags for formatting options
573   static bool thread_, timestamp_;
574 
575   // Determines if logs will be directed to stderr in debug mode.
576   static bool log_to_stderr_;
577 #else  // RTC_LOG_ENABLED()
578   // Next methods do nothing; no one will call these functions.
579   inline static void UpdateMinLogSeverity() {}
580 #if defined(WEBRTC_ANDROID)
581   inline static void OutputToDebug(const std::string& msg,
582                                    LoggingSeverity severity,
583                                    const char* tag) {}
584 #else
585   inline static void OutputToDebug(const std::string& msg,
586                                    LoggingSeverity severity) {}
587 #endif  // defined(WEBRTC_ANDROID)
588   inline void FinishPrintStream() {}
589 #endif  // RTC_LOG_ENABLED()
590 
591   // The stringbuilder that buffers the formatted message before output
592   rtc::StringBuilder print_stream_;
593 
594   RTC_DISALLOW_COPY_AND_ASSIGN(LogMessage);
595 };
596 
597 //////////////////////////////////////////////////////////////////////
598 // Logging Helpers
599 //////////////////////////////////////////////////////////////////////
600 
601 #define RTC_LOG_FILE_LINE(sev, file, line)            \
602   RTC_LOG_ENABLED() &&                                \
603       ::rtc::webrtc_logging_impl::LogCall() &         \
604           ::rtc::webrtc_logging_impl::LogStreamer<>() \
605               << ::rtc::webrtc_logging_impl::LogMetadata(file, line, sev)
606 
607 #define RTC_LOG(sev) RTC_LOG_FILE_LINE(::rtc::sev, __FILE__, __LINE__)
608 
609 // The _V version is for when a variable is passed in.
610 #define RTC_LOG_V(sev) RTC_LOG_FILE_LINE(sev, __FILE__, __LINE__)
611 
612 // The _F version prefixes the message with the current function name.
613 #if (defined(__GNUC__) && !defined(NDEBUG)) || defined(WANT_PRETTY_LOG_F)
614 #define RTC_LOG_F(sev) RTC_LOG(sev) << __PRETTY_FUNCTION__ << ": "
615 #define RTC_LOG_T_F(sev) \
616   RTC_LOG(sev) << this << ": " << __PRETTY_FUNCTION__ << ": "
617 #else
618 #define RTC_LOG_F(sev) RTC_LOG(sev) << __FUNCTION__ << ": "
619 #define RTC_LOG_T_F(sev) RTC_LOG(sev) << this << ": " << __FUNCTION__ << ": "
620 #endif
621 
622 #define RTC_LOG_CHECK_LEVEL(sev) ::rtc::LogCheckLevel(::rtc::sev)
623 #define RTC_LOG_CHECK_LEVEL_V(sev) ::rtc::LogCheckLevel(sev)
624 
625 inline bool LogCheckLevel(LoggingSeverity sev) {
626   return (LogMessage::GetMinLogSeverity() <= sev);
627 }
628 
629 #define RTC_LOG_E(sev, ctx, err)                                               \
630   RTC_LOG_ENABLED() && ::rtc::webrtc_logging_impl::LogCall() &                 \
631                            ::rtc::webrtc_logging_impl::LogStreamer<>()         \
632                                << ::rtc::webrtc_logging_impl::LogMetadataErr { \
633     {__FILE__, __LINE__, ::rtc::sev}, ::rtc::ERRCTX_##ctx, (err)               \
634   }
635 
636 #define RTC_LOG_T(sev) RTC_LOG(sev) << this << ": "
637 
638 #define RTC_LOG_ERRNO_EX(sev, err) RTC_LOG_E(sev, ERRNO, err)
639 #define RTC_LOG_ERRNO(sev) RTC_LOG_ERRNO_EX(sev, errno)
640 
641 #if defined(WEBRTC_WIN)
642 #define RTC_LOG_GLE_EX(sev, err) RTC_LOG_E(sev, HRESULT, err)
643 #define RTC_LOG_GLE(sev) RTC_LOG_GLE_EX(sev, static_cast<int>(GetLastError()))
644 #define RTC_LOG_ERR_EX(sev, err) RTC_LOG_GLE_EX(sev, err)
645 #define RTC_LOG_ERR(sev) RTC_LOG_GLE(sev)
646 #elif defined(__native_client__) && __native_client__
647 #define RTC_LOG_ERR_EX(sev, err) RTC_LOG(sev)
648 #define RTC_LOG_ERR(sev) RTC_LOG(sev)
649 #elif defined(WEBRTC_POSIX)
650 #define RTC_LOG_ERR_EX(sev, err) RTC_LOG_ERRNO_EX(sev, err)
651 #define RTC_LOG_ERR(sev) RTC_LOG_ERRNO(sev)
652 #endif  // WEBRTC_WIN
653 
654 #ifdef WEBRTC_ANDROID
655 
656 namespace webrtc_logging_impl {
657 // TODO(kwiberg): Replace these with absl::string_view.
658 inline const char* AdaptString(const char* str) {
659   return str;
660 }
661 inline const char* AdaptString(const std::string& str) {
662   return str.c_str();
663 }
664 }  // namespace webrtc_logging_impl
665 
666 #define RTC_LOG_TAG(sev, tag)                                                  \
667   RTC_LOG_ENABLED() && ::rtc::webrtc_logging_impl::LogCall() &                 \
668                            ::rtc::webrtc_logging_impl::LogStreamer<>()         \
669                                << ::rtc::webrtc_logging_impl::LogMetadataTag { \
670     sev, ::rtc::webrtc_logging_impl::AdaptString(tag)                          \
671   }
672 
673 #else
674 
675 // DEPRECATED. This macro is only intended for Android.
676 #define RTC_LOG_TAG(sev, tag) RTC_LOG_V(sev)
677 
678 #endif
679 
680 // The RTC_DLOG macros are equivalent to their RTC_LOG counterparts except that
681 // they only generate code in debug builds.
682 #if RTC_DLOG_IS_ON
683 #define RTC_DLOG(sev) RTC_LOG(sev)
684 #define RTC_DLOG_V(sev) RTC_LOG_V(sev)
685 #define RTC_DLOG_F(sev) RTC_LOG_F(sev)
686 #else
687 #define RTC_DLOG_EAT_STREAM_PARAMS()                \
688   while (false)                                     \
689   ::rtc::webrtc_logging_impl::LogMessageVoidify() & \
690       (::rtc::webrtc_logging_impl::LogStreamer<>())
691 #define RTC_DLOG(sev) RTC_DLOG_EAT_STREAM_PARAMS()
692 #define RTC_DLOG_V(sev) RTC_DLOG_EAT_STREAM_PARAMS()
693 #define RTC_DLOG_F(sev) RTC_DLOG_EAT_STREAM_PARAMS()
694 #endif
695 
696 }  // namespace rtc
697 
698 #endif  // RTC_BASE_LOGGING_H_
699