michael@0: // Copyright (c) 2011 The Chromium Authors. All rights reserved.
michael@0: // Use of this source code is governed by a BSD-style license that can be
michael@0: // found in the LICENSE file.
michael@0: 
michael@0: #include "base/logging_win.h"
michael@0: #include "base/memory/singleton.h"
michael@0: #include <initguid.h>  // NOLINT
michael@0: 
michael@0: namespace logging {
michael@0: 
michael@0: using base::win::EtwEventLevel;
michael@0: using base::win::EtwMofEvent;
michael@0: 
michael@0: DEFINE_GUID(kLogEventId,
michael@0:     0x7fe69228, 0x633e, 0x4f06, 0x80, 0xc1, 0x52, 0x7f, 0xea, 0x23, 0xe3, 0xa7);
michael@0: 
michael@0: LogEventProvider::LogEventProvider() : old_log_level_(LOG_NONE) {
michael@0: }
michael@0: 
michael@0: LogEventProvider* LogEventProvider::GetInstance() {
michael@0:   return Singleton<LogEventProvider,
michael@0:                    StaticMemorySingletonTraits<LogEventProvider> >::get();
michael@0: }
michael@0: 
michael@0: bool LogEventProvider::LogMessage(logging::LogSeverity severity,
michael@0:     const char* file, int line, size_t message_start,
michael@0:     const std::string& message) {
michael@0:   EtwEventLevel level = TRACE_LEVEL_NONE;
michael@0: 
michael@0:   // Convert the log severity to the most appropriate ETW trace level.
michael@0:   if (severity >= 0) {
michael@0:     switch (severity) {
michael@0:       case LOG_INFO:
michael@0:         level = TRACE_LEVEL_INFORMATION;
michael@0:         break;
michael@0:       case LOG_WARNING:
michael@0:         level = TRACE_LEVEL_WARNING;
michael@0:         break;
michael@0:       case LOG_ERROR:
michael@0:       case LOG_ERROR_REPORT:
michael@0:         level = TRACE_LEVEL_ERROR;
michael@0:         break;
michael@0:       case LOG_FATAL:
michael@0:         level = TRACE_LEVEL_FATAL;
michael@0:         break;
michael@0:     }
michael@0:   } else {  // severity < 0 is VLOG verbosity levels.
michael@0:     level = TRACE_LEVEL_INFORMATION - severity;
michael@0:   }
michael@0: 
michael@0:   // Bail if we're not logging, not at that level,
michael@0:   // or if we're post-atexit handling.
michael@0:   LogEventProvider* provider = LogEventProvider::GetInstance();
michael@0:   if (provider == NULL || level > provider->enable_level())
michael@0:     return false;
michael@0: 
michael@0:   // And now log the event.
michael@0:   if (provider->enable_flags() & ENABLE_LOG_MESSAGE_ONLY) {
michael@0:     EtwMofEvent<1> event(kLogEventId, LOG_MESSAGE, level);
michael@0:     event.SetField(0, message.length() + 1 - message_start,
michael@0:         message.c_str() + message_start);
michael@0: 
michael@0:     provider->Log(event.get());
michael@0:   } else {
michael@0:     const size_t kMaxBacktraceDepth = 32;
michael@0:     void* backtrace[kMaxBacktraceDepth];
michael@0:     DWORD depth = 0;
michael@0: 
michael@0:     // Capture a stack trace if one is requested.
michael@0:     // requested per our enable flags.
michael@0:     if (provider->enable_flags() & ENABLE_STACK_TRACE_CAPTURE)
michael@0:       depth = CaptureStackBackTrace(2, kMaxBacktraceDepth, backtrace, NULL);
michael@0: 
michael@0:     EtwMofEvent<5> event(kLogEventId, LOG_MESSAGE_FULL, level);
michael@0:     if (file == NULL)
michael@0:       file = "";
michael@0: 
michael@0:     // Add the stack trace.
michael@0:     event.SetField(0, sizeof(depth), &depth);
michael@0:     event.SetField(1, sizeof(backtrace[0]) * depth, &backtrace);
michael@0:     // The line.
michael@0:     event.SetField(2, sizeof(line), &line);
michael@0:     // The file.
michael@0:     event.SetField(3, strlen(file) + 1, file);
michael@0:     // And finally the message.
michael@0:     event.SetField(4, message.length() + 1 - message_start,
michael@0:         message.c_str() + message_start);
michael@0: 
michael@0:     provider->Log(event.get());
michael@0:   }
michael@0: 
michael@0:   // Don't increase verbosity in other log destinations.
michael@0:   if (severity < provider->old_log_level_)
michael@0:     return true;
michael@0: 
michael@0:   return false;
michael@0: }
michael@0: 
michael@0: void LogEventProvider::Initialize(const GUID& provider_name) {
michael@0:   LogEventProvider* provider = LogEventProvider::GetInstance();
michael@0: 
michael@0:   provider->set_provider_name(provider_name);
michael@0:   provider->Register();
michael@0: 
michael@0:   // Register our message handler with logging.
michael@0:   SetLogMessageHandler(LogMessage);
michael@0: }
michael@0: 
michael@0: void LogEventProvider::Uninitialize() {
michael@0:   LogEventProvider::GetInstance()->Unregister();
michael@0: }
michael@0: 
michael@0: void LogEventProvider::OnEventsEnabled() {
michael@0:   // Grab the old log level so we can restore it later.
michael@0:   old_log_level_ = GetMinLogLevel();
michael@0: 
michael@0:   // Convert the new trace level to a logging severity
michael@0:   // and enable logging at that level.
michael@0:   EtwEventLevel level = enable_level();
michael@0:   if (level == TRACE_LEVEL_NONE || level == TRACE_LEVEL_FATAL) {
michael@0:     SetMinLogLevel(LOG_FATAL);
michael@0:   } else if (level == TRACE_LEVEL_ERROR) {
michael@0:     SetMinLogLevel(LOG_ERROR);
michael@0:   } else if (level == TRACE_LEVEL_WARNING) {
michael@0:     SetMinLogLevel(LOG_WARNING);
michael@0:   } else if (level == TRACE_LEVEL_INFORMATION) {
michael@0:     SetMinLogLevel(LOG_INFO);
michael@0:   } else if (level >= TRACE_LEVEL_VERBOSE) {
michael@0:     // Above INFO, we enable verbose levels with negative severities.
michael@0:     SetMinLogLevel(TRACE_LEVEL_INFORMATION - level);
michael@0:   }
michael@0: }
michael@0: 
michael@0: void LogEventProvider::OnEventsDisabled() {
michael@0:   // Restore the old log level.
michael@0:   SetMinLogLevel(old_log_level_);
michael@0: }
michael@0: 
michael@0: }  // namespace logging