zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add ability to strip out logging messages from the binary

Browse Source 
Bug: webrtc:11125
Change-Id: I6e1e96536502c6ae94b6061ea09951cdc2fd87ac
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/160410
Reviewed-by: Mirko Bonadei <mbonadei@webrtc.org>
Reviewed-by: Karl Wiberg <kwiberg@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#29919}
This commit is contained in:
Artem Titov
2019-11-26 16:24:46 +01:00
committed by Commit Bot
parent 68c6572980
commit 6a4a14635e
5 changed files with 124 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
BUILD.gn
View File

@ -259,6 +259,10 @@ config("common_config") {
defines += [ "WEBRTC_USE_H264" ]
}
if (rtc_disable_logging) {
defines += [ "RTC_DISABLE_LOGGING" ]
}
if (build_with_chromium) {
defines += [
# NOTICE: Since common_inherited_config is used in public_configs for our

35
rtc_base/logging.cc
View File

@ -8,6 +8,12 @@
* be found in the AUTHORS file in the root of the source tree.
*/
#include "rtc_base/logging.h"
#include <string.h>
#if RTC_LOG_ENABLED()
#if defined(WEBRTC_WIN)
#include <windows.h>
#if _MSC_VER < 1900
@ -28,7 +34,6 @@ static const int kMaxLogLineSize = 1024 - 60;
#endif // WEBRTC_MAC && !defined(WEBRTC_IOS) || WEBRTC_ANDROID
#include <stdio.h>
#include <string.h>
#include <time.h>
#include <algorithm>
@ -38,7 +43,6 @@ static const int kMaxLogLineSize = 1024 - 60;
#include "absl/base/attributes.h"
#include "rtc_base/checks.h"
#include "rtc_base/critical_section.h"
#include "rtc_base/logging.h"
#include "rtc_base/platform_thread_types.h"
#include "rtc_base/string_encode.h"
#include "rtc_base/string_utils.h"
@ -71,18 +75,6 @@ const char* FilenameFromPath(const char* file) {
CriticalSection g_log_crit;
} // namespace
// Inefficient default implementation, override is recommended.
void LogSink::OnLogMessage(const std::string& msg,
LoggingSeverity severity,
const char* tag) {
OnLogMessage(tag + (": " + msg), severity);
}
void LogSink::OnLogMessage(const std::string& msg,
LoggingSeverity /* severity */) {
OnLogMessage(msg);
}
/////////////////////////////////////////////////////////////////////////////
// LogMessage
/////////////////////////////////////////////////////////////////////////////
@ -553,3 +545,18 @@ void Log(const LogArgType* fmt, ...) {
} // namespace webrtc_logging_impl
} // namespace rtc
#endif
namespace rtc {
// Inefficient default implementation, override is recommended.
void LogSink::OnLogMessage(const std::string& msg,
LoggingSeverity severity,
const char* tag) {
OnLogMessage(tag + (": " + msg), severity);
}
void LogSink::OnLogMessage(const std::string& msg,
LoggingSeverity /* severity */) {
OnLogMessage(msg);
}
} // namespace rtc

128
rtc_base/logging.h
View File

@ -63,6 +63,12 @@
#define RTC_DLOG_IS_ON 0
#endif
#if defined(RTC_DISABLE_LOGGING)
#define RTC_LOG_ENABLED() 0
#else
#define RTC_LOG_ENABLED() 1
#endif
namespace rtc {
//////////////////////////////////////////////////////////////////////
@ -113,9 +119,11 @@ class LogSink {
private:
friend class ::rtc::LogMessage;
#if RTC_LOG_ENABLED()
// Members for LogMessage class to keep linked list of the registered sinks.
LogSink* next_ = nullptr;
LoggingSeverity min_severity_;
#endif
};
namespace webrtc_logging_impl {
@ -295,7 +303,13 @@ ToStringVal MakeVal(const T& x) {
return {ToLogString(x)};
}
#if RTC_LOG_ENABLED()
void Log(const LogArgType* fmt, ...);
#else
inline void Log(const LogArgType* fmt, ...) {
// Do nothing, shouldn't be invoked
}
#endif
// Ephemeral type that represents the result of the logging << operator.
template <typename... Ts>
@ -368,9 +382,12 @@ class LogStreamer<T, Ts...> final {
class LogCall final {
public:
// This can be any binary operator with precedence lower than <<.
// We return bool here to be able properly remove logging if
// RTC_DISABLE_LOGGING is defined.
template <typename... Ts>
RTC_FORCE_INLINE void operator&(const LogStreamer<Ts...>& streamer) {
RTC_FORCE_INLINE bool operator&(const LogStreamer<Ts...>& streamer) {
streamer.Call();
return true;
}
};
@ -382,8 +399,6 @@ class LogCall final {
// .cc file.
class LogMessage {
public:
LogMessage(const char* file, int line, LoggingSeverity sev);
// Same as the above, but using a compile-time constant for the logging
// severity. This saves space at the call site, since passing an empty struct
// is generally the same as not passing an argument at all.
@ -393,16 +408,16 @@ class LogMessage {
std::integral_constant<LoggingSeverity, S>)
: LogMessage(file, line, S) {}
#if RTC_LOG_ENABLED()
LogMessage(const char* file, int line, LoggingSeverity sev);
LogMessage(const char* file,
int line,
LoggingSeverity sev,
LogErrorContext err_ctx,
int err);
#if defined(WEBRTC_ANDROID)
LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag);
#endif
// DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
// Android code should use the 'const char*' version since tags are static
// and we want to avoid allocating a std::string copy per log line.
@ -411,38 +426,29 @@ class LogMessage {
int line,
LoggingSeverity sev,
const std::string& tag);
~LogMessage();
void AddTag(const char* tag);
rtc::StringBuilder& stream();
// Returns the time at which this function was called for the first time.
// The time will be used as the logging start time.
// If this is not called externally, the LogMessage ctor also calls it, in
// which case the logging start time will be the time of the first LogMessage
// instance is created.
static int64_t LogStartTime();
// Returns the wall clock equivalent of |LogStartTime|, in seconds from the
// epoch.
static uint32_t WallClockStartTime();
// LogThreads: Display the thread identifier of the current thread
static void LogThreads(bool on = true);
// LogTimestamps: Display the elapsed time of the program
static void LogTimestamps(bool on = true);
// These are the available logging channels
// Debug: Debug console on Windows, otherwise stderr
static void LogToDebug(LoggingSeverity min_sev);
static LoggingSeverity GetLogToDebug();
// Sets whether logs will be directed to stderr in debug mode.
static void SetLogToStderr(bool log_to_stderr);
// Stream: Any non-blocking stream interface.
// Installs the |stream| to collect logs with severtiy |min_sev| or higher.
// |stream| must live until deinstalled by RemoveLogToStream
@ -452,24 +458,62 @@ class LogMessage {
// Returns the severity for the specified stream, of if none is specified,
// the minimum stream severity.
static int GetLogToStream(LogSink* stream = nullptr);
// Testing against MinLogSeverity allows code to avoid potentially expensive
// logging operations by pre-checking the logging level.
static int GetMinLogSeverity();
// Parses the provided parameter stream to configure the options above.
// Useful for configuring logging from the command line.
static void ConfigureLogging(const char* params);
// Checks the current global debug severity and if the |streams_| collection
// is empty. If |severity| is smaller than the global severity and if the
// |streams_| collection is empty, the LogMessage will be considered a noop
// LogMessage.
static bool IsNoop(LoggingSeverity severity);
#else
// Next methods do nothing; no one will call these functions.
LogMessage(const char* file, int line, LoggingSeverity sev) {}
LogMessage(const char* file,
int line,
LoggingSeverity sev,
LogErrorContext err_ctx,
int err) {}
#if defined(WEBRTC_ANDROID)
LogMessage(const char* file, int line, LoggingSeverity sev, const char* tag) {
}
#endif
// DEPRECATED - DO NOT USE - PLEASE USE THE MACROS INSTEAD OF THE CLASS.
// Android code should use the 'const char*' version since tags are static
// and we want to avoid allocating a std::string copy per log line.
RTC_DEPRECATED
LogMessage(const char* file,
int line,
LoggingSeverity sev,
const std::string& tag) {}
~LogMessage() = default;
inline void AddTag(const char* tag) {}
inline rtc::StringBuilder& stream() { return print_stream_; }
inline static int64_t LogStartTime() { return 0; }
inline static uint32_t WallClockStartTime() { return 0; }
inline static void LogThreads(bool on = true) {}
inline static void LogTimestamps(bool on = true) {}
inline static void LogToDebug(LoggingSeverity min_sev) {}
inline static LoggingSeverity GetLogToDebug() {
return LoggingSeverity::LS_INFO;
}
inline static void SetLogToStderr(bool log_to_stderr) {}
inline static void AddLogToStream(LogSink* stream, LoggingSeverity min_sev) {}
inline static void RemoveLogToStream(LogSink* stream) {}
inline static int GetLogToStream(LogSink* stream = nullptr) { return 0; }
inline static int GetMinLogSeverity() { return 0; }
inline static void ConfigureLogging(const char* params) {}
inline static bool IsNoop(LoggingSeverity severity) { return true; }
#endif // RTC_LOG_ENABLED()
private:
friend class LogMessageForTesting;
#if RTC_LOG_ENABLED()
// Updates min_sev_ appropriately when debug sinks change.
static void UpdateMinLogSeverity();
@ -480,15 +524,12 @@ class LogMessage {
const char* tag);
#else
static void OutputToDebug(const std::string& msg, LoggingSeverity severity);
#endif
#endif // defined(WEBRTC_ANDROID)
// Called from the dtor (or from a test) to append optional extra error
// information to the log stream and a newline character.
void FinishPrintStream();
// The stringbuilder that buffers the formatted message before output
rtc::StringBuilder print_stream_;
// The severity level of this message
LoggingSeverity severity_;
@ -509,6 +550,22 @@ class LogMessage {
// Determines if logs will be directed to stderr in debug mode.
static bool log_to_stderr_;
#else // RTC_LOG_ENABLED()
// Next methods do nothing; no one will call these functions.
inline static void UpdateMinLogSeverity() {}
#if defined(WEBRTC_ANDROID)
inline static void OutputToDebug(const std::string& msg,
LoggingSeverity severity,
const char* tag) {}
#else
inline static void OutputToDebug(const std::string& msg,
LoggingSeverity severity) {}
#endif // defined(WEBRTC_ANDROID)
inline void FinishPrintStream() {}
#endif // RTC_LOG_ENABLED()
// The stringbuilder that buffers the formatted message before output
rtc::StringBuilder print_stream_;
RTC_DISALLOW_COPY_AND_ASSIGN(LogMessage);
};
@ -517,10 +574,11 @@ class LogMessage {
// Logging Helpers
//////////////////////////////////////////////////////////////////////
#define RTC_LOG_FILE_LINE(sev, file, line) \
rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadata(file, line, sev)
#define RTC_LOG_FILE_LINE(sev, file, line) \
RTC_LOG_ENABLED() && \
rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadata(file, line, sev)
#define RTC_LOG(sev) RTC_LOG_FILE_LINE(rtc::sev, __FILE__, __LINE__)
@ -544,11 +602,11 @@ inline bool LogCheckLevel(LoggingSeverity sev) {
return (LogMessage::GetMinLogSeverity() <= sev);
}
#define RTC_LOG_E(sev, ctx, err) \
rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadataErr { \
{__FILE__, __LINE__, rtc::sev}, rtc::ERRCTX_##ctx, (err) \
#define RTC_LOG_E(sev, ctx, err) \
RTC_LOG_ENABLED() && rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadataErr { \
{__FILE__, __LINE__, rtc::sev}, rtc::ERRCTX_##ctx, (err) \
}
#define RTC_LOG_T(sev) RTC_LOG(sev) << this << ": "
@ -581,11 +639,11 @@ inline const char* AdaptString(const std::string& str) {
}
} // namespace webrtc_logging_impl
#define RTC_LOG_TAG(sev, tag) \
rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadataTag { \
sev, rtc::webrtc_logging_impl::AdaptString(tag) \
#define RTC_LOG_TAG(sev, tag) \
RTC_LOG_ENABLED() && rtc::webrtc_logging_impl::LogCall() & \
rtc::webrtc_logging_impl::LogStreamer<>() \
<< rtc::webrtc_logging_impl::LogMetadataTag { \
sev, rtc::webrtc_logging_impl::AdaptString(tag) \
}
#else

3
rtc_base/logging_unittest.cc
View File

@ -10,6 +10,8 @@
#include "rtc_base/logging.h"
#if RTC_LOG_ENABLED()
#include <string.h>
#include <algorithm>
@ -384,3 +386,4 @@ TEST(LogTest, EnumsAreSupported) {
}
} // namespace rtc
#endif

3
webrtc.gni
View File

@ -242,6 +242,9 @@ declare_args() {
# Set this to false to skip building code that also requires X11 extensions
# such as Xdamage, Xfixes.
rtc_use_x11_extensions = rtc_use_x11
# Set this to true to fully remove logging from WebRTC.
rtc_disable_logging = false
}
# Make it possible to provide custom locations for some libraries (move these