1c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch// Copyright (c) 2010 The Chromium Authors. All rights reserved. 2c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Use of this source code is governed by a BSD-style license that can be 3c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// found in the LICENSE file. 4c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// 5c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// Unit tests for event trace provider. 6513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch#include "base/win/event_trace_provider.h" 7c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <new> 8c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include "testing/gtest/include/gtest/gtest.h" 9c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott#include <initguid.h> // NOLINT - has to be last 10c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 11c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scottnamespace { 12c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 13513209b27ff55e2841eac0e4120199c23acce758Ben Murdochusing base::win::EtwTraceProvider; 14513209b27ff55e2841eac0e4120199c23acce758Ben Murdochusing base::win::EtwMofEvent; 15513209b27ff55e2841eac0e4120199c23acce758Ben Murdoch 16c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// {7F0FD37F-FA3C-4cd6-9242-DF60967A2CB2} 17c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_GUID(kTestProvider, 18c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 0x7f0fd37f, 0xfa3c, 0x4cd6, 0x92, 0x42, 0xdf, 0x60, 0x96, 0x7a, 0x2c, 0xb2); 19c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 20c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott// {7F0FD37F-FA3C-4cd6-9242-DF60967A2CB2} 21c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottDEFINE_GUID(kTestEventClass, 22c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 0x7f0fd37f, 0xfa3c, 0x4cd6, 0x92, 0x42, 0xdf, 0x60, 0x96, 0x7a, 0x2c, 0xb2); 23c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 24c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} // namespace 25c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 26c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottTEST(EtwTraceProviderTest, ToleratesPreCreateInvocations) { 27c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Because the trace provider is used in logging, it's important that 28c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // it be possible to use static provider instances without regard to 29c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // whether they've been constructed or destructed. 30c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // The interface of the class is designed to tolerate this usage. 31c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott char buf[sizeof(EtwTraceProvider)] = {0}; 32c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwTraceProvider& provider = reinterpret_cast<EtwTraceProvider&>(buf); 33c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 34c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.registration_handle()); 35c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.session_handle()); 36c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_flags()); 37c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_level()); 38c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 39c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_FALSE(provider.ShouldLog(TRACE_LEVEL_FATAL, 0xfffffff)); 40c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 41c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // We expect these not to crash. 42c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(kTestEventClass, 0, TRACE_LEVEL_FATAL, "foo"); 43c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(kTestEventClass, 0, TRACE_LEVEL_FATAL, L"foo"); 44c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 45c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwMofEvent<1> dummy(kTestEventClass, 0, TRACE_LEVEL_FATAL); 46c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott DWORD data = 0; 47c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott dummy.SetField(0, sizeof(data), &data); 48c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(dummy.get()); 49c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 50c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Placement-new the provider into our buffer. 51c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott new (buf) EtwTraceProvider(kTestProvider); 52c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 53c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Registration is now safe. 54c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(ERROR_SUCCESS, provider.Register()); 55c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 56c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // Destruct the instance, this should unregister it. 57c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.EtwTraceProvider::~EtwTraceProvider(); 58c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 59c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // And post-destruction, all of the above should still be safe. 60c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.registration_handle()); 61c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.session_handle()); 62c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_flags()); 63c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_level()); 64c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 65c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_FALSE(provider.ShouldLog(TRACE_LEVEL_FATAL, 0xfffffff)); 66c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 67c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // We expect these not to crash. 68c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(kTestEventClass, 0, TRACE_LEVEL_FATAL, "foo"); 69c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(kTestEventClass, 0, TRACE_LEVEL_FATAL, L"foo"); 70c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott provider.Log(dummy.get()); 71c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 72c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 73c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottTEST(EtwTraceProviderTest, Initialize) { 74c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwTraceProvider provider(kTestProvider); 75c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 76c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.registration_handle()); 77c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.session_handle()); 78c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_flags()); 79c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_level()); 80c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 81c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 82c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottTEST(EtwTraceProviderTest, Register) { 83c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwTraceProvider provider(kTestProvider); 84c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 85c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ASSERT_EQ(ERROR_SUCCESS, provider.Register()); 86c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_NE(NULL, provider.registration_handle()); 87c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ASSERT_EQ(ERROR_SUCCESS, provider.Unregister()); 88c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.registration_handle()); 89c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 90c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 91c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottTEST(EtwTraceProviderTest, RegisterWithNoNameFails) { 92c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwTraceProvider provider; 93c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 94c407dc5cd9bdc5668497f21b26b09d988ab439deBen Murdoch EXPECT_TRUE(provider.Register() != ERROR_SUCCESS); 95c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 96c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 97c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick ScottTEST(EtwTraceProviderTest, Enable) { 98c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EtwTraceProvider provider(kTestProvider); 99c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 100c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ASSERT_EQ(ERROR_SUCCESS, provider.Register()); 101c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_NE(NULL, provider.registration_handle()); 102c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 103c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott // No session so far. 104c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.session_handle()); 105c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_flags()); 106c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(0, provider.enable_level()); 107c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott 108c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott ASSERT_EQ(ERROR_SUCCESS, provider.Unregister()); 109c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott EXPECT_EQ(NULL, provider.registration_handle()); 110c7f5f8508d98d5952d42ed7648c2a8f30a4da156Patrick Scott} 111