1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef BASE_LOGGING_WIN_H_
6 #define BASE_LOGGING_WIN_H_
12 #include "base/base_export.h"
13 #include "base/logging.h"
14 #include "base/macros.h"
15 #include "base/win/event_trace_provider.h"
18 template <typename Type>
19 struct StaticMemorySingletonTraits;
24 // Event ID for the log messages we generate.
25 EXTERN_C BASE_EXPORT const GUID kLogEventId;
27 // Feature enable mask for LogEventProvider.
29 // If this bit is set in our provider enable mask, we will include
30 // a stack trace with every log message.
31 ENABLE_STACK_TRACE_CAPTURE = 0x0001,
32 // If this bit is set in our provider enable mask, the provider will log
33 // a LOG message with only the textual content of the message, and no
35 ENABLE_LOG_MESSAGE_ONLY = 0x0002,
38 // The message types our log event provider generates.
39 // ETW likes user message types to start at 10.
40 enum LogMessageTypes {
41 // A textual only log message, contains a zero-terminated string.
43 // A message with a stack trace, followed by the zero-terminated
45 LOG_MESSAGE_WITH_STACKTRACE = 11,
48 // the line number as a four byte integer,
49 // the file as a zero terminated UTF8 string,
50 // the zero-terminated UTF8 message text.
51 LOG_MESSAGE_FULL = 12,
54 // Trace provider class to drive log control and transport
55 // with Event Tracing for Windows.
56 class BASE_EXPORT LogEventProvider : public base::win::EtwTraceProvider {
58 static LogEventProvider* GetInstance();
60 static bool LogMessage(logging::LogSeverity severity, const char* file,
61 int line, size_t message_start, const std::string& str);
63 static void Initialize(const GUID& provider_name);
64 static void Uninitialize();
67 // Overridden to manipulate the log level on ETW control callbacks.
68 void OnEventsEnabled() override;
69 void OnEventsDisabled() override;
74 // The log severity prior to OnEventsEnabled,
75 // restored in OnEventsDisabled.
76 logging::LogSeverity old_log_level_;
78 friend struct base::StaticMemorySingletonTraits<LogEventProvider>;
79 DISALLOW_COPY_AND_ASSIGN(LogEventProvider);
82 } // namespace logging
84 #endif // BASE_LOGGING_WIN_H_