15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_LOGGING_WIN_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_LOGGING_WIN_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/base_export.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/win/event_trace_provider.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename Type> 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct StaticMemorySingletonTraits; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace logging { 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Event ID for the log messages we generate. 21eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen MurdochEXTERN_C BASE_EXPORT const GUID kLogEventId; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Feature enable mask for LogEventProvider. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum LogEnableMask { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this bit is set in our provider enable mask, we will include 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a stack trace with every log message. 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ENABLE_STACK_TRACE_CAPTURE = 0x0001, 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If this bit is set in our provider enable mask, the provider will log 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a LOG message with only the textual content of the message, and no 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // stack trace. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ENABLE_LOG_MESSAGE_ONLY = 0x0002, 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The message types our log event provider generates. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ETW likes user message types to start at 10. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum LogMessageTypes { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A textual only log message, contains a zero-terminated string. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG_MESSAGE = 10, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A message with a stack trace, followed by the zero-terminated 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message text. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG_MESSAGE_WITH_STACKTRACE = 11, 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A message with: 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a stack trace, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the line number as a four byte integer, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the file as a zero terminated UTF8 string, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the zero-terminated UTF8 message text. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LOG_MESSAGE_FULL = 12, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Trace provider class to drive log control and transport 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// with Event Tracing for Windows. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_EXPORT LogEventProvider : public base::win::EtwTraceProvider { 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static LogEventProvider* GetInstance(); 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool LogMessage(logging::LogSeverity severity, const char* file, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int line, size_t message_start, const std::string& str); 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void Initialize(const GUID& provider_name); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void Uninitialize(); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Overridden to manipulate the log level on ETW control callbacks. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnEventsEnabled(); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnEventsDisabled(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LogEventProvider(); 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The log severity prior to OnEventsEnabled, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // restored in OnEventsDisabled. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) logging::LogSeverity old_log_level_; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend struct StaticMemorySingletonTraits<LogEventProvider>; 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(LogEventProvider); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace logging 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_LOGGING_WIN_H_ 81