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