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)#include "base/debug/trace_event_win.h" 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/singleton.h" 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <initguid.h> // NOLINT 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace debug { 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using base::win::EtwEventType; 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)using base::win::EtwMofEvent; 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// {3DADA31D-19EF-4dc1-B345-037927193422} 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const GUID kChromeTraceProviderName = { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 0x3dada31d, 0x19ef, 0x4dc1, 0xb3, 0x45, 0x3, 0x79, 0x27, 0x19, 0x34, 0x22 }; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// {B967AE67-BB22-49d7-9406-55D91EE1D560} 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const GUID kTraceEventClass32 = { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 0xb967ae67, 0xbb22, 0x49d7, 0x94, 0x6, 0x55, 0xd9, 0x1e, 0xe1, 0xd5, 0x60 }; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// {97BE602D-2930-4ac3-8046-B6763B631DFE} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const GUID kTraceEventClass64 = { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 0x97be602d, 0x2930, 0x4ac3, 0x80, 0x46, 0xb6, 0x76, 0x3b, 0x63, 0x1d, 0xfe}; 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)TraceEventETWProvider::TraceEventETWProvider() : 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EtwTraceProvider(kChromeTraceProviderName) { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Register(); 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)TraceEventETWProvider* TraceEventETWProvider::GetInstance() { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return Singleton<TraceEventETWProvider, 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) StaticMemorySingletonTraits<TraceEventETWProvider> >::get(); 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool TraceEventETWProvider::StartTracing() { 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void TraceEventETWProvider::TraceEvent(const char* name, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t name_len, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char type, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const void* id, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* extra, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t extra_len) { 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Make sure we don't touch NULL. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (name == NULL) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name = ""; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (extra == NULL) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extra = ""; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EtwEventType etw_type = 0; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) switch (type) { 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case TRACE_EVENT_PHASE_BEGIN: 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) etw_type = kTraceEventTypeBegin; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case TRACE_EVENT_PHASE_END: 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) etw_type = kTraceEventTypeEnd; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) case TRACE_EVENT_PHASE_INSTANT: 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) etw_type = kTraceEventTypeInstant; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) default: 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NOTREACHED() << "Unknown event type"; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) etw_type = kTraceEventTypeInstant; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EtwMofEvent<5> event(kTraceEventClass32, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) etw_type, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TRACE_LEVEL_INFORMATION); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) event.SetField(0, name_len + 1, name); 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) event.SetField(1, sizeof(id), &id); 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) event.SetField(2, extra_len + 1, extra); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 814e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // These variables are declared here so that they are not out of scope when 824e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // the event is logged. 834e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) DWORD depth; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* backtrace[32]; 854e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) 864e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) // See whether we're to capture a backtrace. 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (enable_flags() & CAPTURE_STACK_TRACE) { 884e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) depth = CaptureStackBackTrace(0, 894e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) arraysize(backtrace), 904e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) backtrace, 914e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) NULL); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) event.SetField(3, sizeof(depth), &depth); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) event.SetField(4, sizeof(backtrace[0]) * depth, backtrace); 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Trace the event. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Log(event.get()); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void TraceEventETWProvider::Trace(const char* name, 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t name_len, 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char type, 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const void* id, 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* extra, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t extra_len) { 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TraceEventETWProvider* provider = TraceEventETWProvider::GetInstance(); 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (provider && provider->IsTracing()) { 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Compute the name & extra lengths if not supplied already. 109116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch if (name_len == kUseStrlen) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) name_len = (name == NULL) ? 0 : strlen(name); 111116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch if (extra_len == kUseStrlen) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extra_len = (extra == NULL) ? 0 : strlen(extra); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) provider->TraceEvent(name, name_len, type, id, extra, extra_len); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void TraceEventETWProvider::Resurrect() { 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) StaticMemorySingletonTraits<TraceEventETWProvider>::Resurrect(); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace debug 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace base 124