1 // Copyright 2011 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifdef UNSAFE_BUFFERS_BUILD
6 // TODO(crbug.com/40284755): Remove this and spanify to fix the errors.
7 #pragma allow_unsafe_buffers
8 #endif
9
10 #include "base/logging_win.h"
11
12 #include <initguid.h>
13
14 #include "base/memory/singleton.h"
15
16 namespace logging {
17
18 using base::win::EtwEventLevel;
19 using base::win::EtwMofEvent;
20
21 DEFINE_GUID(kLogEventId,
22 0x7fe69228, 0x633e, 0x4f06, 0x80, 0xc1, 0x52, 0x7f, 0xea, 0x23, 0xe3, 0xa7);
23
LogEventProvider()24 LogEventProvider::LogEventProvider() : old_log_level_(LOG_NONE) {
25 }
26
GetInstance()27 LogEventProvider* LogEventProvider::GetInstance() {
28 return base::Singleton<LogEventProvider, base::StaticMemorySingletonTraits<
29 LogEventProvider>>::get();
30 }
31
LogMessage(logging::LogSeverity severity,const char * file,int line,size_t message_start,const std::string & message)32 bool LogEventProvider::LogMessage(logging::LogSeverity severity,
33 const char* file, int line, size_t message_start,
34 const std::string& message) {
35 EtwEventLevel level = TRACE_LEVEL_NONE;
36
37 // Convert the log severity to the most appropriate ETW trace level.
38 if (severity >= 0) {
39 switch (severity) {
40 case LOGGING_INFO:
41 level = TRACE_LEVEL_INFORMATION;
42 break;
43 case LOGGING_WARNING:
44 level = TRACE_LEVEL_WARNING;
45 break;
46 case LOGGING_ERROR:
47 level = TRACE_LEVEL_ERROR;
48 break;
49 case LOGGING_FATAL:
50 level = TRACE_LEVEL_FATAL;
51 break;
52 }
53 } else { // severity < 0 is VLOG verbosity levels.
54 level = static_cast<EtwEventLevel>(TRACE_LEVEL_INFORMATION - severity);
55 }
56
57 // Bail if we're not logging, not at that level,
58 // or if we're post-atexit handling.
59 LogEventProvider* provider = LogEventProvider::GetInstance();
60 if (provider == NULL || level > provider->enable_level())
61 return false;
62
63 // And now log the event.
64 if (provider->enable_flags() & ENABLE_LOG_MESSAGE_ONLY) {
65 EtwMofEvent<1> event(kLogEventId, LOG_MESSAGE, level);
66 event.SetField(0, message.length() + 1 - message_start,
67 message.c_str() + message_start);
68
69 provider->Log(event.get());
70 } else {
71 const size_t kMaxBacktraceDepth = 32;
72 void* backtrace[kMaxBacktraceDepth];
73 DWORD depth = 0;
74
75 // Capture a stack trace if one is requested.
76 // requested per our enable flags.
77 if (provider->enable_flags() & ENABLE_STACK_TRACE_CAPTURE)
78 depth = CaptureStackBackTrace(2, kMaxBacktraceDepth, backtrace, NULL);
79
80 EtwMofEvent<5> event(kLogEventId, LOG_MESSAGE_FULL, level);
81 if (file == NULL)
82 file = "";
83
84 // Add the stack trace.
85 event.SetField(0, sizeof(depth), &depth);
86 event.SetField(1, sizeof(backtrace[0]) * depth, &backtrace);
87 // The line.
88 event.SetField(2, sizeof(line), &line);
89 // The file.
90 event.SetField(3, strlen(file) + 1, file);
91 // And finally the message.
92 event.SetField(4, message.length() + 1 - message_start,
93 message.c_str() + message_start);
94
95 provider->Log(event.get());
96 }
97
98 // Don't increase verbosity in other log destinations.
99 if (severity < provider->old_log_level_)
100 return true;
101
102 return false;
103 }
104
Initialize(const GUID & provider_name)105 void LogEventProvider::Initialize(const GUID& provider_name) {
106 LogEventProvider* provider = LogEventProvider::GetInstance();
107
108 provider->set_provider_name(provider_name);
109 provider->Register();
110
111 // Register our message handler with logging.
112 SetLogMessageHandler(LogMessage);
113 }
114
Uninitialize()115 void LogEventProvider::Uninitialize() {
116 LogEventProvider::GetInstance()->Unregister();
117 }
118
OnEventsEnabled()119 void LogEventProvider::OnEventsEnabled() {
120 // Grab the old log level so we can restore it later.
121 old_log_level_ = GetMinLogLevel();
122
123 // Convert the new trace level to a logging severity
124 // and enable logging at that level.
125 EtwEventLevel level = enable_level();
126 if (level == TRACE_LEVEL_NONE || level == TRACE_LEVEL_FATAL) {
127 SetMinLogLevel(LOGGING_FATAL);
128 } else if (level == TRACE_LEVEL_ERROR) {
129 SetMinLogLevel(LOGGING_ERROR);
130 } else if (level == TRACE_LEVEL_WARNING) {
131 SetMinLogLevel(LOGGING_WARNING);
132 } else if (level == TRACE_LEVEL_INFORMATION) {
133 SetMinLogLevel(LOGGING_INFO);
134 } else if (level >= TRACE_LEVEL_VERBOSE) {
135 // Above INFO, we enable verbose levels with negative severities.
136 SetMinLogLevel(TRACE_LEVEL_INFORMATION - level);
137 }
138 }
139
OnEventsDisabled()140 void LogEventProvider::OnEventsDisabled() {
141 // Restore the old log level.
142 SetMinLogLevel(old_log_level_);
143 }
144
145 } // namespace logging
146