xref: /aosp_15_r20/external/cronet/base/win/event_trace_provider.cc (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2012 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker //
5*6777b538SAndroid Build Coastguard Worker #include "base/win/event_trace_provider.h"
6*6777b538SAndroid Build Coastguard Worker 
7*6777b538SAndroid Build Coastguard Worker #include <windows.h>
8*6777b538SAndroid Build Coastguard Worker 
9*6777b538SAndroid Build Coastguard Worker namespace base {
10*6777b538SAndroid Build Coastguard Worker namespace win {
11*6777b538SAndroid Build Coastguard Worker 
12*6777b538SAndroid Build Coastguard Worker TRACE_GUID_REGISTRATION EtwTraceProvider::obligatory_guid_registration_ = {
13*6777b538SAndroid Build Coastguard Worker     &GUID_NULL, nullptr};
14*6777b538SAndroid Build Coastguard Worker 
EtwTraceProvider(const GUID & provider_name)15*6777b538SAndroid Build Coastguard Worker EtwTraceProvider::EtwTraceProvider(const GUID& provider_name)
16*6777b538SAndroid Build Coastguard Worker     : provider_name_(provider_name) {}
17*6777b538SAndroid Build Coastguard Worker 
18*6777b538SAndroid Build Coastguard Worker EtwTraceProvider::EtwTraceProvider() = default;
19*6777b538SAndroid Build Coastguard Worker 
~EtwTraceProvider()20*6777b538SAndroid Build Coastguard Worker EtwTraceProvider::~EtwTraceProvider() {
21*6777b538SAndroid Build Coastguard Worker   Unregister();
22*6777b538SAndroid Build Coastguard Worker }
23*6777b538SAndroid Build Coastguard Worker 
EnableEvents(void * buffer)24*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::EnableEvents(void* buffer) {
25*6777b538SAndroid Build Coastguard Worker   session_handle_ = ::GetTraceLoggerHandle(buffer);
26*6777b538SAndroid Build Coastguard Worker   if (NULL == session_handle_) {
27*6777b538SAndroid Build Coastguard Worker     return ::GetLastError();
28*6777b538SAndroid Build Coastguard Worker   }
29*6777b538SAndroid Build Coastguard Worker 
30*6777b538SAndroid Build Coastguard Worker   enable_flags_ = ::GetTraceEnableFlags(session_handle_);
31*6777b538SAndroid Build Coastguard Worker   enable_level_ = ::GetTraceEnableLevel(session_handle_);
32*6777b538SAndroid Build Coastguard Worker 
33*6777b538SAndroid Build Coastguard Worker   // Give subclasses a chance to digest the state change.
34*6777b538SAndroid Build Coastguard Worker   OnEventsEnabled();
35*6777b538SAndroid Build Coastguard Worker 
36*6777b538SAndroid Build Coastguard Worker   return ERROR_SUCCESS;
37*6777b538SAndroid Build Coastguard Worker }
38*6777b538SAndroid Build Coastguard Worker 
DisableEvents()39*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::DisableEvents() {
40*6777b538SAndroid Build Coastguard Worker   // Give subclasses a chance to digest the state change.
41*6777b538SAndroid Build Coastguard Worker   OnEventsDisabled();
42*6777b538SAndroid Build Coastguard Worker 
43*6777b538SAndroid Build Coastguard Worker   enable_level_ = 0;
44*6777b538SAndroid Build Coastguard Worker   enable_flags_ = 0;
45*6777b538SAndroid Build Coastguard Worker   session_handle_ = NULL;
46*6777b538SAndroid Build Coastguard Worker 
47*6777b538SAndroid Build Coastguard Worker   PostEventsDisabled();
48*6777b538SAndroid Build Coastguard Worker 
49*6777b538SAndroid Build Coastguard Worker   return ERROR_SUCCESS;
50*6777b538SAndroid Build Coastguard Worker }
51*6777b538SAndroid Build Coastguard Worker 
Callback(WMIDPREQUESTCODE request,void * buffer)52*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Callback(WMIDPREQUESTCODE request, void* buffer) {
53*6777b538SAndroid Build Coastguard Worker   switch (request) {
54*6777b538SAndroid Build Coastguard Worker     case WMI_ENABLE_EVENTS:
55*6777b538SAndroid Build Coastguard Worker       return EnableEvents(buffer);
56*6777b538SAndroid Build Coastguard Worker     case WMI_DISABLE_EVENTS:
57*6777b538SAndroid Build Coastguard Worker       return DisableEvents();
58*6777b538SAndroid Build Coastguard Worker     default:
59*6777b538SAndroid Build Coastguard Worker       return ERROR_INVALID_PARAMETER;
60*6777b538SAndroid Build Coastguard Worker   }
61*6777b538SAndroid Build Coastguard Worker   // Not reached.
62*6777b538SAndroid Build Coastguard Worker }
63*6777b538SAndroid Build Coastguard Worker 
ControlCallback(WMIDPREQUESTCODE request,void * context,ULONG * reserved,void * buffer)64*6777b538SAndroid Build Coastguard Worker ULONG WINAPI EtwTraceProvider::ControlCallback(WMIDPREQUESTCODE request,
65*6777b538SAndroid Build Coastguard Worker                                                void* context,
66*6777b538SAndroid Build Coastguard Worker                                                ULONG* reserved,
67*6777b538SAndroid Build Coastguard Worker                                                void* buffer) {
68*6777b538SAndroid Build Coastguard Worker   EtwTraceProvider* provider = reinterpret_cast<EtwTraceProvider*>(context);
69*6777b538SAndroid Build Coastguard Worker 
70*6777b538SAndroid Build Coastguard Worker   return provider->Callback(request, buffer);
71*6777b538SAndroid Build Coastguard Worker }
72*6777b538SAndroid Build Coastguard Worker 
Register()73*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Register() {
74*6777b538SAndroid Build Coastguard Worker   if (provider_name_ == GUID_NULL)
75*6777b538SAndroid Build Coastguard Worker     return ERROR_INVALID_NAME;
76*6777b538SAndroid Build Coastguard Worker 
77*6777b538SAndroid Build Coastguard Worker   return ::RegisterTraceGuids(ControlCallback, this, &provider_name_, 1,
78*6777b538SAndroid Build Coastguard Worker                               &obligatory_guid_registration_, nullptr, nullptr,
79*6777b538SAndroid Build Coastguard Worker                               &registration_handle_);
80*6777b538SAndroid Build Coastguard Worker }
81*6777b538SAndroid Build Coastguard Worker 
Unregister()82*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Unregister() {
83*6777b538SAndroid Build Coastguard Worker   // If a session is active, notify subclasses that it's going away.
84*6777b538SAndroid Build Coastguard Worker   if (session_handle_ != NULL)
85*6777b538SAndroid Build Coastguard Worker     DisableEvents();
86*6777b538SAndroid Build Coastguard Worker 
87*6777b538SAndroid Build Coastguard Worker   ULONG ret = ::UnregisterTraceGuids(registration_handle_);
88*6777b538SAndroid Build Coastguard Worker 
89*6777b538SAndroid Build Coastguard Worker   registration_handle_ = NULL;
90*6777b538SAndroid Build Coastguard Worker 
91*6777b538SAndroid Build Coastguard Worker   return ret;
92*6777b538SAndroid Build Coastguard Worker }
93*6777b538SAndroid Build Coastguard Worker 
Log(const EtwEventClass & event_class,EtwEventType type,EtwEventLevel level,const char * message)94*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Log(const EtwEventClass& event_class,
95*6777b538SAndroid Build Coastguard Worker                             EtwEventType type,
96*6777b538SAndroid Build Coastguard Worker                             EtwEventLevel level,
97*6777b538SAndroid Build Coastguard Worker                             const char* message) {
98*6777b538SAndroid Build Coastguard Worker   if (NULL == session_handle_ || enable_level_ < level)
99*6777b538SAndroid Build Coastguard Worker     return ERROR_SUCCESS;  // No one listening.
100*6777b538SAndroid Build Coastguard Worker 
101*6777b538SAndroid Build Coastguard Worker   EtwMofEvent<1> event(event_class, type, level);
102*6777b538SAndroid Build Coastguard Worker 
103*6777b538SAndroid Build Coastguard Worker   event.fields[0].DataPtr = reinterpret_cast<ULONG64>(message);
104*6777b538SAndroid Build Coastguard Worker   event.fields[0].Length =
105*6777b538SAndroid Build Coastguard Worker       message ? static_cast<ULONG>(sizeof(message[0]) * (1 + strlen(message)))
106*6777b538SAndroid Build Coastguard Worker               : 0;
107*6777b538SAndroid Build Coastguard Worker 
108*6777b538SAndroid Build Coastguard Worker   return ::TraceEvent(session_handle_, &event.header);
109*6777b538SAndroid Build Coastguard Worker }
110*6777b538SAndroid Build Coastguard Worker 
Log(const EtwEventClass & event_class,EtwEventType type,EtwEventLevel level,const wchar_t * message)111*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Log(const EtwEventClass& event_class,
112*6777b538SAndroid Build Coastguard Worker                             EtwEventType type,
113*6777b538SAndroid Build Coastguard Worker                             EtwEventLevel level,
114*6777b538SAndroid Build Coastguard Worker                             const wchar_t* message) {
115*6777b538SAndroid Build Coastguard Worker   if (NULL == session_handle_ || enable_level_ < level)
116*6777b538SAndroid Build Coastguard Worker     return ERROR_SUCCESS;  // No one listening.
117*6777b538SAndroid Build Coastguard Worker 
118*6777b538SAndroid Build Coastguard Worker   EtwMofEvent<1> event(event_class, type, level);
119*6777b538SAndroid Build Coastguard Worker 
120*6777b538SAndroid Build Coastguard Worker   event.fields[0].DataPtr = reinterpret_cast<ULONG64>(message);
121*6777b538SAndroid Build Coastguard Worker   event.fields[0].Length =
122*6777b538SAndroid Build Coastguard Worker       message ? static_cast<ULONG>(sizeof(message[0]) * (1 + wcslen(message)))
123*6777b538SAndroid Build Coastguard Worker               : 0;
124*6777b538SAndroid Build Coastguard Worker 
125*6777b538SAndroid Build Coastguard Worker   return ::TraceEvent(session_handle_, &event.header);
126*6777b538SAndroid Build Coastguard Worker }
127*6777b538SAndroid Build Coastguard Worker 
Log(EVENT_TRACE_HEADER * event)128*6777b538SAndroid Build Coastguard Worker ULONG EtwTraceProvider::Log(EVENT_TRACE_HEADER* event) {
129*6777b538SAndroid Build Coastguard Worker   if (enable_level_ < event->Class.Level)
130*6777b538SAndroid Build Coastguard Worker     return ERROR_SUCCESS;
131*6777b538SAndroid Build Coastguard Worker 
132*6777b538SAndroid Build Coastguard Worker   return ::TraceEvent(session_handle_, event);
133*6777b538SAndroid Build Coastguard Worker }
134*6777b538SAndroid Build Coastguard Worker 
135*6777b538SAndroid Build Coastguard Worker }  // namespace win
136*6777b538SAndroid Build Coastguard Worker }  // namespace base
137