Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 17 | #include "src/tracing/core/tracing_service_impl.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 18 | |
| 19 | #include <string.h> |
| 20 | |
| 21 | #include "gmock/gmock.h" |
| 22 | #include "gtest/gtest.h" |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 23 | #include "perfetto/base/file_utils.h" |
| 24 | #include "perfetto/base/temp_file.h" |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 25 | #include "perfetto/base/utils.h" |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 26 | #include "perfetto/tracing/core/consumer.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 27 | #include "perfetto/tracing/core/data_source_config.h" |
| 28 | #include "perfetto/tracing/core/data_source_descriptor.h" |
| 29 | #include "perfetto/tracing/core/producer.h" |
| 30 | #include "perfetto/tracing/core/shared_memory.h" |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 31 | #include "perfetto/tracing/core/trace_packet.h" |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 32 | #include "perfetto/tracing/core/trace_writer.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 33 | #include "src/base/test/test_task_runner.h" |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 34 | #include "src/tracing/test/mock_consumer.h" |
| 35 | #include "src/tracing/test/mock_producer.h" |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 36 | #include "src/tracing/test/test_shared_memory.h" |
| 37 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 38 | #include "perfetto/trace/test_event.pbzero.h" |
| 39 | #include "perfetto/trace/trace.pb.h" |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 40 | #include "perfetto/trace/trace_packet.pb.h" |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 41 | #include "perfetto/trace/trace_packet.pbzero.h" |
| 42 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 43 | using ::testing::_; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 44 | using ::testing::Contains; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 45 | using ::testing::ElementsAreArray; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 46 | using ::testing::Eq; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 47 | using ::testing::InSequence; |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 48 | using ::testing::Invoke; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 49 | using ::testing::InvokeWithoutArgs; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 50 | using ::testing::Mock; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 51 | using ::testing::Property; |
| 52 | using ::testing::StrictMock; |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 53 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 54 | namespace perfetto { |
Sami Kyostila | 32e0b54 | 2018-02-14 08:55:43 +0000 | [diff] [blame] | 55 | |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 56 | namespace { |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 57 | constexpr size_t kDefaultShmSizeKb = TracingServiceImpl::kDefaultShmSize / 1024; |
| 58 | constexpr size_t kMaxShmSizeKb = TracingServiceImpl::kMaxShmSize / 1024; |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 59 | } // namespace |
| 60 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 61 | class TracingServiceImplTest : public testing::Test { |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 62 | public: |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 63 | TracingServiceImplTest() { |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 64 | auto shm_factory = |
| 65 | std::unique_ptr<SharedMemory::Factory>(new TestSharedMemory::Factory()); |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 66 | svc.reset(static_cast<TracingServiceImpl*>( |
| 67 | TracingService::CreateInstance(std::move(shm_factory), &task_runner) |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 68 | .release())); |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 69 | svc->min_write_period_ms_ = 1; |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 70 | } |
| 71 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 72 | std::unique_ptr<MockProducer> CreateMockProducer() { |
| 73 | return std::unique_ptr<MockProducer>( |
| 74 | new StrictMock<MockProducer>(&task_runner)); |
| 75 | } |
| 76 | |
| 77 | std::unique_ptr<MockConsumer> CreateMockConsumer() { |
| 78 | return std::unique_ptr<MockConsumer>( |
| 79 | new StrictMock<MockConsumer>(&task_runner)); |
| 80 | } |
| 81 | |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 82 | ProducerID* last_producer_id() { return &svc->last_producer_id_; } |
| 83 | |
| 84 | uid_t GetProducerUid(ProducerID producer_id) { |
| 85 | return svc->GetProducer(producer_id)->uid_; |
| 86 | } |
| 87 | |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 88 | TracingServiceImpl::TracingSession* tracing_session() { |
| 89 | auto* session = svc->GetTracingSession(svc->last_tracing_session_id_); |
| 90 | EXPECT_NE(nullptr, session); |
| 91 | return session; |
| 92 | } |
| 93 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 94 | size_t GetNumPendingFlushes() { |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 95 | return tracing_session()->pending_flushes.size(); |
| 96 | } |
| 97 | |
| 98 | void WaitForNextSyncMarker() { |
| 99 | tracing_session()->last_snapshot_time = base::TimeMillis(0); |
| 100 | static int attempt = 0; |
| 101 | while (tracing_session()->last_snapshot_time == base::TimeMillis(0)) { |
| 102 | auto checkpoint_name = "wait_snapshot_" + std::to_string(attempt++); |
| 103 | auto timer_expired = task_runner.CreateCheckpoint(checkpoint_name); |
| 104 | task_runner.PostDelayedTask([timer_expired] { timer_expired(); }, 1); |
| 105 | task_runner.RunUntilCheckpoint(checkpoint_name); |
| 106 | } |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 107 | } |
| 108 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 109 | base::TestTaskRunner task_runner; |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 110 | std::unique_ptr<TracingServiceImpl> svc; |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 111 | }; |
| 112 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 113 | TEST_F(TracingServiceImplTest, RegisterAndUnregister) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 114 | std::unique_ptr<MockProducer> mock_producer_1 = CreateMockProducer(); |
| 115 | std::unique_ptr<MockProducer> mock_producer_2 = CreateMockProducer(); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 116 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 117 | mock_producer_1->Connect(svc.get(), "mock_producer_1", 123u /* uid */); |
| 118 | mock_producer_2->Connect(svc.get(), "mock_producer_2", 456u /* uid */); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 119 | |
| 120 | ASSERT_EQ(2u, svc->num_producers()); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 121 | ASSERT_EQ(mock_producer_1->endpoint(), svc->GetProducer(1)); |
| 122 | ASSERT_EQ(mock_producer_2->endpoint(), svc->GetProducer(2)); |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 123 | ASSERT_EQ(123u, GetProducerUid(1)); |
| 124 | ASSERT_EQ(456u, GetProducerUid(2)); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 125 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 126 | mock_producer_1->RegisterDataSource("foo"); |
| 127 | mock_producer_2->RegisterDataSource("bar"); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 128 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 129 | mock_producer_1->UnregisterDataSource("foo"); |
| 130 | mock_producer_2->UnregisterDataSource("bar"); |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 131 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 132 | mock_producer_1.reset(); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 133 | ASSERT_EQ(1u, svc->num_producers()); |
| 134 | ASSERT_EQ(nullptr, svc->GetProducer(1)); |
| 135 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 136 | mock_producer_2.reset(); |
| 137 | ASSERT_EQ(nullptr, svc->GetProducer(2)); |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 138 | |
| 139 | ASSERT_EQ(0u, svc->num_producers()); |
| 140 | } |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 141 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 142 | TEST_F(TracingServiceImplTest, EnableAndDisableTracing) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 143 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 144 | consumer->Connect(svc.get()); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 145 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 146 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 147 | producer->Connect(svc.get(), "mock_producer"); |
| 148 | producer->RegisterDataSource("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 149 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 150 | TraceConfig trace_config; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 151 | trace_config.add_buffers()->set_size_kb(128); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 152 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 153 | ds_config->set_name("data_source"); |
| 154 | consumer->EnableTracing(trace_config); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 155 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 156 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 157 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 158 | producer->WaitForDataSourceStart("data_source"); |
| 159 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 160 | // Calling StartTracing() should be a noop (% a DLOG statement) because the |
| 161 | // trace config didn't have the |deferred_start| flag set. |
| 162 | consumer->StartTracing(); |
| 163 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 164 | consumer->DisableTracing(); |
| 165 | producer->WaitForDataSourceStop("data_source"); |
| 166 | consumer->WaitForTracingDisabled(); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 167 | } |
| 168 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 169 | TEST_F(TracingServiceImplTest, LockdownMode) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 170 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 171 | consumer->Connect(svc.get()); |
| 172 | |
| 173 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 174 | producer->Connect(svc.get(), "mock_producer_sameuid", geteuid()); |
| 175 | producer->RegisterDataSource("data_source"); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 176 | |
| 177 | TraceConfig trace_config; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 178 | trace_config.add_buffers()->set_size_kb(128); |
| 179 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 180 | ds_config->set_name("data_source"); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 181 | trace_config.set_lockdown_mode( |
| 182 | TraceConfig::LockdownModeOperation::LOCKDOWN_SET); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 183 | consumer->EnableTracing(trace_config); |
| 184 | |
| 185 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 186 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 187 | producer->WaitForDataSourceStart("data_source"); |
| 188 | |
| 189 | std::unique_ptr<MockProducer> producer_otheruid = CreateMockProducer(); |
| 190 | auto x = svc->ConnectProducer(producer_otheruid.get(), geteuid() + 1, |
| 191 | "mock_producer_ouid"); |
| 192 | EXPECT_CALL(*producer_otheruid, OnConnect()).Times(0); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 193 | task_runner.RunUntilIdle(); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 194 | Mock::VerifyAndClearExpectations(producer_otheruid.get()); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 195 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 196 | consumer->DisableTracing(); |
| 197 | consumer->FreeBuffers(); |
| 198 | producer->WaitForDataSourceStop("data_source"); |
| 199 | consumer->WaitForTracingDisabled(); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 200 | |
| 201 | trace_config.set_lockdown_mode( |
| 202 | TraceConfig::LockdownModeOperation::LOCKDOWN_CLEAR); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 203 | consumer->EnableTracing(trace_config); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 204 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 205 | producer->WaitForDataSourceStart("data_source"); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 206 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 207 | std::unique_ptr<MockProducer> producer_otheruid2 = CreateMockProducer(); |
| 208 | producer_otheruid->Connect(svc.get(), "mock_producer_ouid2", geteuid() + 1); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 209 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 210 | consumer->DisableTracing(); |
| 211 | producer->WaitForDataSourceStop("data_source"); |
| 212 | consumer->WaitForTracingDisabled(); |
Florian Mayer | 61c5548 | 2018-03-06 14:43:54 +0000 | [diff] [blame] | 213 | } |
| 214 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 215 | TEST_F(TracingServiceImplTest, DisconnectConsumerWhileTracing) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 216 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 217 | consumer->Connect(svc.get()); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 218 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 219 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 220 | producer->Connect(svc.get(), "mock_producer"); |
| 221 | producer->RegisterDataSource("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 222 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 223 | TraceConfig trace_config; |
| 224 | trace_config.add_buffers()->set_size_kb(128); |
| 225 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 226 | ds_config->set_name("data_source"); |
| 227 | consumer->EnableTracing(trace_config); |
| 228 | |
| 229 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 230 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 231 | producer->WaitForDataSourceStart("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 232 | |
| 233 | // Disconnecting the consumer while tracing should trigger data source |
| 234 | // teardown. |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 235 | consumer.reset(); |
| 236 | producer->WaitForDataSourceStop("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 237 | } |
| 238 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 239 | TEST_F(TracingServiceImplTest, ReconnectProducerWhileTracing) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 240 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 241 | consumer->Connect(svc.get()); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 242 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 243 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 244 | producer->Connect(svc.get(), "mock_producer"); |
| 245 | producer->RegisterDataSource("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 246 | |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 247 | TraceConfig trace_config; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 248 | trace_config.add_buffers()->set_size_kb(128); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 249 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 250 | ds_config->set_name("data_source"); |
| 251 | consumer->EnableTracing(trace_config); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 252 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 253 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 254 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 255 | producer->WaitForDataSourceStart("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 256 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 257 | // Disconnecting and reconnecting a producer with a matching data source. |
| 258 | // The Producer should see that data source getting enabled again. |
| 259 | producer.reset(); |
| 260 | producer = CreateMockProducer(); |
| 261 | producer->Connect(svc.get(), "mock_producer_2"); |
| 262 | producer->RegisterDataSource("data_source"); |
| 263 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 264 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 265 | producer->WaitForDataSourceStart("data_source"); |
Sami Kyostila | 06487a2 | 2018-02-27 13:48:38 +0000 | [diff] [blame] | 266 | } |
| 267 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 268 | TEST_F(TracingServiceImplTest, ProducerIDWrapping) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 269 | std::vector<std::unique_ptr<MockProducer>> producers; |
| 270 | producers.push_back(nullptr); |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 271 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 272 | auto connect_producer_and_get_id = [&producers, |
| 273 | this](const std::string& name) { |
| 274 | producers.emplace_back(CreateMockProducer()); |
| 275 | producers.back()->Connect(svc.get(), "mock_producer_" + name); |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 276 | return *last_producer_id(); |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 277 | }; |
| 278 | |
| 279 | // Connect producers 1-4. |
| 280 | for (ProducerID i = 1; i <= 4; i++) |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 281 | ASSERT_EQ(i, connect_producer_and_get_id(std::to_string(i))); |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 282 | |
| 283 | // Disconnect producers 1,3. |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 284 | producers[1].reset(); |
| 285 | producers[3].reset(); |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 286 | |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 287 | *last_producer_id() = kMaxProducerID - 1; |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 288 | ASSERT_EQ(kMaxProducerID, connect_producer_and_get_id("maxid")); |
| 289 | ASSERT_EQ(1u, connect_producer_and_get_id("1_again")); |
| 290 | ASSERT_EQ(3u, connect_producer_and_get_id("3_again")); |
| 291 | ASSERT_EQ(5u, connect_producer_and_get_id("5")); |
| 292 | ASSERT_EQ(6u, connect_producer_and_get_id("6")); |
Primiano Tucci | 081d46a | 2018-02-28 11:09:43 +0000 | [diff] [blame] | 293 | } |
| 294 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 295 | TEST_F(TracingServiceImplTest, WriteIntoFileAndStopOnMaxSize) { |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 296 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 297 | consumer->Connect(svc.get()); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 298 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 299 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 300 | producer->Connect(svc.get(), "mock_producer"); |
| 301 | producer->RegisterDataSource("data_source"); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 302 | |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 303 | TraceConfig trace_config; |
| 304 | trace_config.add_buffers()->set_size_kb(4096); |
| 305 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 306 | ds_config->set_name("data_source"); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 307 | ds_config->set_target_buffer(0); |
| 308 | trace_config.set_write_into_file(true); |
| 309 | trace_config.set_file_write_period_ms(1); |
| 310 | const uint64_t kMaxFileSize = 512; |
| 311 | trace_config.set_max_file_size_bytes(kMaxFileSize); |
| 312 | base::TempFile tmp_file = base::TempFile::Create(); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 313 | consumer->EnableTracing(trace_config, base::ScopedFile(dup(tmp_file.fd()))); |
| 314 | |
| 315 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 316 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 317 | producer->WaitForDataSourceStart("data_source"); |
| 318 | |
| 319 | static const char kPayload[] = "1234567890abcdef-"; |
| 320 | static const int kNumPackets = 10; |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 321 | |
| 322 | std::unique_ptr<TraceWriter> writer = |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 323 | producer->CreateTraceWriter("data_source"); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 324 | // All these packets should fit within kMaxFileSize. |
| 325 | for (int i = 0; i < kNumPackets; i++) { |
| 326 | auto tp = writer->NewTracePacket(); |
| 327 | std::string payload(kPayload); |
| 328 | payload.append(std::to_string(i)); |
| 329 | tp->set_for_testing()->set_str(payload.c_str(), payload.size()); |
| 330 | } |
| 331 | |
| 332 | // Finally add a packet that overflows kMaxFileSize. This should cause the |
| 333 | // implicit stop of the trace and should *not* be written in the trace. |
| 334 | { |
| 335 | auto tp = writer->NewTracePacket(); |
| 336 | char big_payload[kMaxFileSize] = "BIG!"; |
| 337 | tp->set_for_testing()->set_str(big_payload, sizeof(big_payload)); |
| 338 | } |
| 339 | writer->Flush(); |
| 340 | writer.reset(); |
| 341 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 342 | consumer->DisableTracing(); |
| 343 | producer->WaitForDataSourceStop("data_source"); |
| 344 | consumer->WaitForTracingDisabled(); |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 345 | |
| 346 | // Verify the contents of the file. |
| 347 | std::string trace_raw; |
| 348 | ASSERT_TRUE(base::ReadFile(tmp_file.path().c_str(), &trace_raw)); |
| 349 | protos::Trace trace; |
| 350 | ASSERT_TRUE(trace.ParseFromString(trace_raw)); |
| 351 | ASSERT_GE(trace.packet_size(), kNumPackets); |
| 352 | int num_testing_packet = 0; |
| 353 | for (int i = 0; i < trace.packet_size(); i++) { |
| 354 | const protos::TracePacket& tp = trace.packet(i); |
| 355 | if (!tp.has_for_testing()) |
| 356 | continue; |
| 357 | ASSERT_EQ(kPayload + std::to_string(num_testing_packet++), |
| 358 | tp.for_testing().str()); |
| 359 | } |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 360 | } |
Primiano Tucci | 2ffd1a5 | 2018-03-27 01:01:30 +0100 | [diff] [blame] | 361 | |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 362 | // Test the logic that allows the trace config to set the shm total size and |
| 363 | // page size from the trace config. Also check that, if the config doesn't |
| 364 | // specify a value we fall back on the hint provided by the producer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 365 | TEST_F(TracingServiceImplTest, ProducerShmAndPageSizeOverriddenByTraceConfig) { |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 366 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 367 | consumer->Connect(svc.get()); |
| 368 | const size_t kConfigPageSizesKb[] = /****/ {16, 16, 4, 0, 16, 8, 3, 4096, 4}; |
| 369 | const size_t kExpectedPageSizesKb[] = /**/ {16, 16, 4, 4, 16, 8, 4, 64, 4}; |
| 370 | |
| 371 | const size_t kConfigSizesKb[] = /**/ {0, 16, 0, 20, 32, 7, 0, 96, 4096000}; |
| 372 | const size_t kHintSizesKb[] = /****/ {0, 0, 16, 32, 16, 0, 7, 96, 4096000}; |
| 373 | const size_t kExpectedSizesKb[] = { |
| 374 | kDefaultShmSizeKb, // Both hint and config are 0, use default. |
| 375 | 16, // Hint is 0, use config. |
| 376 | 16, // Config is 0, use hint. |
| 377 | 20, // Hint is takes precedence over the config. |
| 378 | 32, // Ditto, even if config is higher than hint. |
| 379 | kDefaultShmSizeKb, // Config is invalid and hint is 0, use default. |
| 380 | kDefaultShmSizeKb, // Config is 0 and hint is invalid, use default. |
| 381 | kDefaultShmSizeKb, // 96 KB isn't a multiple of the page size (64 KB). |
| 382 | kMaxShmSizeKb // Too big, cap at kMaxShmSize. |
| 383 | }; |
| 384 | |
| 385 | const size_t kNumProducers = base::ArraySize(kHintSizesKb); |
| 386 | std::unique_ptr<MockProducer> producer[kNumProducers]; |
| 387 | for (size_t i = 0; i < kNumProducers; i++) { |
| 388 | auto name = "mock_producer_" + std::to_string(i); |
| 389 | producer[i] = CreateMockProducer(); |
| 390 | producer[i]->Connect(svc.get(), name, geteuid(), kHintSizesKb[i] * 1024); |
| 391 | producer[i]->RegisterDataSource("data_source"); |
| 392 | } |
| 393 | |
| 394 | TraceConfig trace_config; |
| 395 | trace_config.add_buffers()->set_size_kb(128); |
| 396 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 397 | ds_config->set_name("data_source"); |
| 398 | for (size_t i = 0; i < kNumProducers; i++) { |
| 399 | auto* producer_config = trace_config.add_producers(); |
| 400 | producer_config->set_producer_name("mock_producer_" + std::to_string(i)); |
Primiano Tucci | 3cbb10a | 2018-04-10 17:52:40 +0100 | [diff] [blame] | 401 | producer_config->set_shm_size_kb(static_cast<uint32_t>(kConfigSizesKb[i])); |
| 402 | producer_config->set_page_size_kb( |
| 403 | static_cast<uint32_t>(kConfigPageSizesKb[i])); |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 404 | } |
| 405 | |
| 406 | consumer->EnableTracing(trace_config); |
| 407 | size_t actual_shm_sizes_kb[kNumProducers]{}; |
| 408 | size_t actual_page_sizes_kb[kNumProducers]{}; |
| 409 | for (size_t i = 0; i < kNumProducers; i++) { |
| 410 | producer[i]->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 411 | producer[i]->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 412 | actual_shm_sizes_kb[i] = |
| 413 | producer[i]->endpoint()->shared_memory()->size() / 1024; |
| 414 | actual_page_sizes_kb[i] = |
| 415 | producer[i]->endpoint()->shared_buffer_page_size_kb(); |
| 416 | } |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 417 | for (size_t i = 0; i < kNumProducers; i++) { |
| 418 | producer[i]->WaitForDataSourceStart("data_source"); |
| 419 | } |
Primiano Tucci | 1a1951d | 2018-04-04 21:08:16 +0200 | [diff] [blame] | 420 | ASSERT_THAT(actual_page_sizes_kb, ElementsAreArray(kExpectedPageSizesKb)); |
| 421 | ASSERT_THAT(actual_shm_sizes_kb, ElementsAreArray(kExpectedSizesKb)); |
| 422 | } |
| 423 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 424 | TEST_F(TracingServiceImplTest, ExplicitFlush) { |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 425 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 426 | consumer->Connect(svc.get()); |
| 427 | |
| 428 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 429 | producer->Connect(svc.get(), "mock_producer"); |
| 430 | producer->RegisterDataSource("data_source"); |
| 431 | |
| 432 | TraceConfig trace_config; |
| 433 | trace_config.add_buffers()->set_size_kb(128); |
| 434 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 435 | ds_config->set_name("data_source"); |
| 436 | |
| 437 | consumer->EnableTracing(trace_config); |
| 438 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 439 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 440 | producer->WaitForDataSourceStart("data_source"); |
| 441 | |
| 442 | std::unique_ptr<TraceWriter> writer = |
| 443 | producer->CreateTraceWriter("data_source"); |
| 444 | { |
| 445 | auto tp = writer->NewTracePacket(); |
| 446 | tp->set_for_testing()->set_str("payload"); |
| 447 | } |
| 448 | |
| 449 | auto flush_request = consumer->Flush(); |
| 450 | producer->WaitForFlush(writer.get()); |
| 451 | ASSERT_TRUE(flush_request.WaitForReply()); |
| 452 | |
| 453 | consumer->DisableTracing(); |
| 454 | producer->WaitForDataSourceStop("data_source"); |
| 455 | consumer->WaitForTracingDisabled(); |
| 456 | EXPECT_THAT( |
| 457 | consumer->ReadBuffers(), |
| 458 | Contains(Property(&protos::TracePacket::for_testing, |
| 459 | Property(&protos::TestEvent::str, Eq("payload"))))); |
| 460 | } |
| 461 | |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 462 | TEST_F(TracingServiceImplTest, ImplicitFlushOnTimedTraces) { |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 463 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 464 | consumer->Connect(svc.get()); |
| 465 | |
| 466 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 467 | producer->Connect(svc.get(), "mock_producer"); |
| 468 | producer->RegisterDataSource("data_source"); |
| 469 | |
| 470 | TraceConfig trace_config; |
| 471 | trace_config.add_buffers()->set_size_kb(128); |
| 472 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 473 | ds_config->set_name("data_source"); |
| 474 | trace_config.set_duration_ms(1); |
| 475 | |
| 476 | consumer->EnableTracing(trace_config); |
| 477 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 478 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 479 | producer->WaitForDataSourceStart("data_source"); |
| 480 | |
| 481 | std::unique_ptr<TraceWriter> writer = |
| 482 | producer->CreateTraceWriter("data_source"); |
| 483 | { |
| 484 | auto tp = writer->NewTracePacket(); |
| 485 | tp->set_for_testing()->set_str("payload"); |
| 486 | } |
| 487 | |
| 488 | producer->WaitForFlush(writer.get()); |
| 489 | |
| 490 | producer->WaitForDataSourceStop("data_source"); |
| 491 | consumer->WaitForTracingDisabled(); |
| 492 | |
| 493 | EXPECT_THAT( |
| 494 | consumer->ReadBuffers(), |
| 495 | Contains(Property(&protos::TracePacket::for_testing, |
| 496 | Property(&protos::TestEvent::str, Eq("payload"))))); |
| 497 | } |
| 498 | |
| 499 | // Tests the monotonic semantic of flush request IDs, i.e., once a producer |
| 500 | // acks flush request N, all flush requests <= N are considered successful and |
| 501 | // acked to the consumer. |
Florian Mayer | 6a1a4d5 | 2018-06-08 16:47:07 +0100 | [diff] [blame] | 502 | TEST_F(TracingServiceImplTest, BatchFlushes) { |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 503 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 504 | consumer->Connect(svc.get()); |
| 505 | |
| 506 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 507 | producer->Connect(svc.get(), "mock_producer"); |
| 508 | producer->RegisterDataSource("data_source"); |
| 509 | |
| 510 | TraceConfig trace_config; |
| 511 | trace_config.add_buffers()->set_size_kb(128); |
| 512 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 513 | ds_config->set_name("data_source"); |
| 514 | |
| 515 | consumer->EnableTracing(trace_config); |
| 516 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 517 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 518 | producer->WaitForDataSourceStart("data_source"); |
| 519 | |
| 520 | std::unique_ptr<TraceWriter> writer = |
| 521 | producer->CreateTraceWriter("data_source"); |
| 522 | { |
| 523 | auto tp = writer->NewTracePacket(); |
| 524 | tp->set_for_testing()->set_str("payload"); |
| 525 | } |
| 526 | |
| 527 | auto flush_req_1 = consumer->Flush(); |
| 528 | auto flush_req_2 = consumer->Flush(); |
| 529 | auto flush_req_3 = consumer->Flush(); |
| 530 | |
| 531 | // We'll deliberately let the 4th flush request timeout. Use a lower timeout |
| 532 | // to keep test time short. |
| 533 | auto flush_req_4 = consumer->Flush(/*timeout_ms=*/10); |
| 534 | ASSERT_EQ(4u, GetNumPendingFlushes()); |
| 535 | |
| 536 | // Make the producer reply only to the 3rd flush request. |
| 537 | testing::InSequence seq; |
| 538 | producer->WaitForFlush(nullptr); // Will NOT reply to flush id == 1. |
| 539 | producer->WaitForFlush(nullptr); // Will NOT reply to flush id == 2. |
| 540 | producer->WaitForFlush(writer.get()); // Will reply only to flush id == 3. |
| 541 | producer->WaitForFlush(nullptr); // Will NOT reply to flush id == 4. |
| 542 | |
| 543 | // Even if the producer explicily replied only to flush ID == 3, all the |
| 544 | // previous flushed < 3 should be implicitly acked. |
| 545 | ASSERT_TRUE(flush_req_1.WaitForReply()); |
| 546 | ASSERT_TRUE(flush_req_2.WaitForReply()); |
| 547 | ASSERT_TRUE(flush_req_3.WaitForReply()); |
| 548 | |
| 549 | // At this point flush id == 4 should still be pending and should fail because |
| 550 | // of reaching its timeout. |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 551 | ASSERT_FALSE(flush_req_4.WaitForReply()); |
| 552 | |
| 553 | consumer->DisableTracing(); |
| 554 | producer->WaitForDataSourceStop("data_source"); |
| 555 | consumer->WaitForTracingDisabled(); |
| 556 | EXPECT_THAT( |
| 557 | consumer->ReadBuffers(), |
| 558 | Contains(Property(&protos::TracePacket::for_testing, |
| 559 | Property(&protos::TestEvent::str, Eq("payload"))))); |
| 560 | } |
| 561 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 562 | // Creates a tracing session where some of the data sources set the |
| 563 | // |will_notify_on_stop| flag and checks that the OnTracingDisabled notification |
| 564 | // to the consumer is delayed until the acks are received. |
| 565 | TEST_F(TracingServiceImplTest, OnTracingDisabledWaitsForDataSourceStopAcks) { |
| 566 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 567 | consumer->Connect(svc.get()); |
| 568 | |
| 569 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 570 | producer->Connect(svc.get(), "mock_producer"); |
| 571 | producer->RegisterDataSource("ds_will_ack_1", /*ack_stop=*/true); |
| 572 | producer->RegisterDataSource("ds_wont_ack"); |
| 573 | producer->RegisterDataSource("ds_will_ack_2", /*ack_stop=*/true); |
| 574 | |
| 575 | TraceConfig trace_config; |
| 576 | trace_config.add_buffers()->set_size_kb(128); |
| 577 | trace_config.add_data_sources()->mutable_config()->set_name("ds_will_ack_1"); |
| 578 | trace_config.add_data_sources()->mutable_config()->set_name("ds_wont_ack"); |
| 579 | trace_config.add_data_sources()->mutable_config()->set_name("ds_will_ack_2"); |
| 580 | trace_config.set_duration_ms(1); |
| 581 | |
| 582 | consumer->EnableTracing(trace_config); |
| 583 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 584 | |
| 585 | producer->WaitForDataSourceSetup("ds_will_ack_1"); |
| 586 | producer->WaitForDataSourceSetup("ds_wont_ack"); |
| 587 | producer->WaitForDataSourceSetup("ds_will_ack_2"); |
| 588 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 589 | producer->WaitForDataSourceStart("ds_will_ack_1"); |
| 590 | producer->WaitForDataSourceStart("ds_wont_ack"); |
| 591 | producer->WaitForDataSourceStart("ds_will_ack_2"); |
| 592 | |
| 593 | std::unique_ptr<TraceWriter> writer = |
| 594 | producer->CreateTraceWriter("ds_wont_ack"); |
| 595 | producer->WaitForFlush(writer.get()); |
| 596 | |
| 597 | DataSourceInstanceID id1 = producer->GetDataSourceInstanceId("ds_will_ack_1"); |
| 598 | DataSourceInstanceID id2 = producer->GetDataSourceInstanceId("ds_will_ack_2"); |
| 599 | |
| 600 | producer->WaitForDataSourceStop("ds_will_ack_1"); |
| 601 | producer->WaitForDataSourceStop("ds_wont_ack"); |
| 602 | producer->WaitForDataSourceStop("ds_will_ack_2"); |
| 603 | |
| 604 | producer->endpoint()->NotifyDataSourceStopped(id1); |
| 605 | producer->endpoint()->NotifyDataSourceStopped(id2); |
| 606 | |
| 607 | // Wait for at most half of the service timeout, so that this test fails if |
| 608 | // the service falls back on calling the OnTracingDisabled() because some of |
| 609 | // the expected acks weren't received. |
| 610 | consumer->WaitForTracingDisabled( |
| 611 | TracingServiceImpl::kDataSourceStopTimeoutMs / 2); |
| 612 | } |
| 613 | |
Oystein Eftevaag | f250e1c | 2018-08-23 16:10:52 -0700 | [diff] [blame] | 614 | // Creates a tracing session where a second data source |
| 615 | // is added while the service is waiting for DisableTracing |
| 616 | // acks; the service should not enable the new datasource |
| 617 | // and should not hit any asserts when the consumer is |
| 618 | // subsequently destroyed. |
| 619 | TEST_F(TracingServiceImplTest, OnDataSourceAddedWhilePendingDisableAcks) { |
| 620 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 621 | consumer->Connect(svc.get()); |
| 622 | |
| 623 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 624 | producer->Connect(svc.get(), "mock_producer"); |
| 625 | producer->RegisterDataSource("ds_will_ack", /*ack_stop=*/true); |
| 626 | |
| 627 | TraceConfig trace_config; |
| 628 | trace_config.add_buffers()->set_size_kb(128); |
| 629 | trace_config.add_data_sources()->mutable_config()->set_name("ds_will_ack"); |
| 630 | trace_config.add_data_sources()->mutable_config()->set_name("ds_wont_ack"); |
| 631 | |
| 632 | consumer->EnableTracing(trace_config); |
| 633 | producer->WaitForTracingSetup(); |
| 634 | |
| 635 | consumer->DisableTracing(); |
| 636 | |
| 637 | producer->RegisterDataSource("ds_wont_ack"); |
| 638 | |
| 639 | consumer.reset(); |
| 640 | } |
| 641 | |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 642 | // Similar to OnTracingDisabledWaitsForDataSourceStopAcks, but deliberately |
| 643 | // skips the ack and checks that the service invokes the OnTracingDisabled() |
| 644 | // after the timeout. |
| 645 | TEST_F(TracingServiceImplTest, OnTracingDisabledCalledAnywaysInCaseOfTimeout) { |
| 646 | svc->override_data_source_test_timeout_ms_for_testing = 1; |
| 647 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 648 | consumer->Connect(svc.get()); |
| 649 | |
| 650 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 651 | producer->Connect(svc.get(), "mock_producer"); |
| 652 | producer->RegisterDataSource("data_source", /*ack_stop=*/true); |
| 653 | |
| 654 | TraceConfig trace_config; |
| 655 | trace_config.add_buffers()->set_size_kb(128); |
| 656 | trace_config.add_data_sources()->mutable_config()->set_name("data_source"); |
| 657 | trace_config.set_duration_ms(1); |
| 658 | |
| 659 | consumer->EnableTracing(trace_config); |
| 660 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 661 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | baeecf1 | 2018-07-25 12:02:20 +0100 | [diff] [blame] | 662 | producer->WaitForDataSourceStart("data_source"); |
| 663 | |
| 664 | std::unique_ptr<TraceWriter> writer = |
| 665 | producer->CreateTraceWriter("data_source"); |
| 666 | producer->WaitForFlush(writer.get()); |
| 667 | |
| 668 | producer->WaitForDataSourceStop("data_source"); |
| 669 | consumer->WaitForTracingDisabled(); |
| 670 | } |
| 671 | |
Primiano Tucci | 03de28f | 2018-08-01 11:29:46 +0100 | [diff] [blame] | 672 | // Tests the session_id logic. Two data sources in the same tracing session |
| 673 | // should see the same session id. |
| 674 | TEST_F(TracingServiceImplTest, SessionId) { |
| 675 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 676 | consumer->Connect(svc.get()); |
| 677 | |
| 678 | std::unique_ptr<MockProducer> producer1 = CreateMockProducer(); |
| 679 | producer1->Connect(svc.get(), "mock_producer1"); |
| 680 | producer1->RegisterDataSource("ds_1A"); |
| 681 | producer1->RegisterDataSource("ds_1B"); |
| 682 | |
| 683 | std::unique_ptr<MockProducer> producer2 = CreateMockProducer(); |
| 684 | producer2->Connect(svc.get(), "mock_producer2"); |
| 685 | producer2->RegisterDataSource("ds_2A"); |
| 686 | |
| 687 | testing::InSequence seq; |
| 688 | TracingSessionID last_session_id = 0; |
| 689 | for (int i = 0; i < 3; i++) { |
| 690 | TraceConfig trace_config; |
| 691 | trace_config.add_buffers()->set_size_kb(128); |
| 692 | trace_config.add_data_sources()->mutable_config()->set_name("ds_1A"); |
| 693 | trace_config.add_data_sources()->mutable_config()->set_name("ds_1B"); |
| 694 | trace_config.add_data_sources()->mutable_config()->set_name("ds_2A"); |
| 695 | trace_config.set_duration_ms(1); |
| 696 | |
| 697 | consumer->EnableTracing(trace_config); |
| 698 | |
| 699 | if (i == 0) |
| 700 | producer1->WaitForTracingSetup(); |
Primiano Tucci | 03de28f | 2018-08-01 11:29:46 +0100 | [diff] [blame] | 701 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 702 | producer1->WaitForDataSourceSetup("ds_1A"); |
| 703 | producer1->WaitForDataSourceSetup("ds_1B"); |
Primiano Tucci | 03de28f | 2018-08-01 11:29:46 +0100 | [diff] [blame] | 704 | if (i == 0) |
| 705 | producer2->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 706 | producer2->WaitForDataSourceSetup("ds_2A"); |
| 707 | |
| 708 | producer1->WaitForDataSourceStart("ds_1A"); |
| 709 | producer1->WaitForDataSourceStart("ds_1B"); |
Primiano Tucci | 03de28f | 2018-08-01 11:29:46 +0100 | [diff] [blame] | 710 | producer2->WaitForDataSourceStart("ds_2A"); |
| 711 | |
| 712 | auto* ds1 = producer1->GetDataSourceInstance("ds_1A"); |
| 713 | auto* ds2 = producer1->GetDataSourceInstance("ds_1B"); |
| 714 | auto* ds3 = producer2->GetDataSourceInstance("ds_2A"); |
| 715 | ASSERT_EQ(ds1->session_id, ds2->session_id); |
| 716 | ASSERT_EQ(ds1->session_id, ds3->session_id); |
| 717 | ASSERT_NE(ds1->session_id, last_session_id); |
| 718 | last_session_id = ds1->session_id; |
| 719 | |
| 720 | auto writer1 = producer1->CreateTraceWriter("ds_1A"); |
| 721 | producer1->WaitForFlush(writer1.get()); |
| 722 | |
| 723 | auto writer2 = producer2->CreateTraceWriter("ds_2A"); |
| 724 | producer2->WaitForFlush(writer2.get()); |
| 725 | |
| 726 | producer1->WaitForDataSourceStop("ds_1A"); |
| 727 | producer1->WaitForDataSourceStop("ds_1B"); |
| 728 | producer2->WaitForDataSourceStop("ds_2A"); |
| 729 | consumer->WaitForTracingDisabled(); |
| 730 | consumer->FreeBuffers(); |
| 731 | } |
| 732 | } |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 733 | |
| 734 | // Writes a long trace and then tests that the trace parsed in partitions |
| 735 | // derived by the synchronization markers is identical to the whole trace parsed |
| 736 | // in one go. |
| 737 | TEST_F(TracingServiceImplTest, ResynchronizeTraceStreamUsingSyncMarker) { |
| 738 | // Setup tracing. |
| 739 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 740 | consumer->Connect(svc.get()); |
| 741 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 742 | producer->Connect(svc.get(), "mock_producer"); |
| 743 | producer->RegisterDataSource("data_source"); |
| 744 | TraceConfig trace_config; |
| 745 | trace_config.add_buffers()->set_size_kb(4096); |
| 746 | auto* ds_config = trace_config.add_data_sources()->mutable_config(); |
| 747 | ds_config->set_name("data_source"); |
| 748 | trace_config.set_write_into_file(true); |
| 749 | trace_config.set_file_write_period_ms(1); |
| 750 | base::TempFile tmp_file = base::TempFile::Create(); |
| 751 | consumer->EnableTracing(trace_config, base::ScopedFile(dup(tmp_file.fd()))); |
| 752 | producer->WaitForTracingSetup(); |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 753 | producer->WaitForDataSourceSetup("data_source"); |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 754 | producer->WaitForDataSourceStart("data_source"); |
| 755 | |
| 756 | // Write some variable length payload, waiting for sync markers every now |
| 757 | // and then. |
| 758 | const int kNumMarkers = 5; |
| 759 | auto writer = producer->CreateTraceWriter("data_source"); |
| 760 | for (int i = 1; i <= 100; i++) { |
| 761 | std::string payload(i, 'A' + (i % 25)); |
| 762 | writer->NewTracePacket()->set_for_testing()->set_str(payload.c_str()); |
| 763 | if (i % (100 / kNumMarkers) == 0) { |
| 764 | writer->Flush(); |
| 765 | WaitForNextSyncMarker(); |
| 766 | } |
| 767 | } |
| 768 | writer->Flush(); |
| 769 | writer.reset(); |
| 770 | consumer->DisableTracing(); |
| 771 | producer->WaitForDataSourceStop("data_source"); |
| 772 | consumer->WaitForTracingDisabled(); |
| 773 | |
| 774 | std::string trace_raw; |
| 775 | ASSERT_TRUE(base::ReadFile(tmp_file.path().c_str(), &trace_raw)); |
| 776 | |
| 777 | const auto kMarkerSize = sizeof(TracingServiceImpl::kSyncMarker); |
| 778 | const std::string kSyncMarkerStr( |
| 779 | reinterpret_cast<const char*>(TracingServiceImpl::kSyncMarker), |
| 780 | kMarkerSize); |
| 781 | |
| 782 | // Read back the trace in partitions derived from the marker. |
| 783 | // The trace should look like this: |
| 784 | // [uid, marker] [event] [event] [uid, marker] [event] [event] |
| 785 | size_t num_markers = 0; |
| 786 | size_t start = 0; |
| 787 | size_t end = 0; |
| 788 | protos::Trace merged_trace; |
| 789 | for (size_t pos = 0; pos != std::string::npos; start = end) { |
| 790 | pos = trace_raw.find(kSyncMarkerStr, pos + 1); |
| 791 | num_markers++; |
| 792 | end = (pos == std::string::npos) ? trace_raw.size() : pos + kMarkerSize; |
| 793 | int size = static_cast<int>(end - start); |
| 794 | ASSERT_GT(size, 0); |
| 795 | protos::Trace trace_partition; |
| 796 | ASSERT_TRUE(trace_partition.ParseFromArray(trace_raw.data() + start, size)); |
| 797 | merged_trace.MergeFrom(trace_partition); |
| 798 | } |
Lalit Maganti | 9bdc7ce | 2018-09-17 15:25:11 +0100 | [diff] [blame] | 799 | EXPECT_GE(num_markers, static_cast<size_t>(kNumMarkers)); |
Primiano Tucci | 9754d0d | 2018-09-15 12:41:46 +0100 | [diff] [blame] | 800 | |
| 801 | protos::Trace whole_trace; |
| 802 | ASSERT_TRUE(whole_trace.ParseFromString(trace_raw)); |
| 803 | |
| 804 | ASSERT_EQ(whole_trace.packet_size(), merged_trace.packet_size()); |
| 805 | EXPECT_EQ(whole_trace.SerializeAsString(), merged_trace.SerializeAsString()); |
| 806 | } |
| 807 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame^] | 808 | // Creates a tracing session with |deferred_start| and checks that data sources |
| 809 | // are started only after calling StartTracing(). |
| 810 | TEST_F(TracingServiceImplTest, DeferredStart) { |
| 811 | std::unique_ptr<MockConsumer> consumer = CreateMockConsumer(); |
| 812 | consumer->Connect(svc.get()); |
| 813 | |
| 814 | std::unique_ptr<MockProducer> producer = CreateMockProducer(); |
| 815 | producer->Connect(svc.get(), "mock_producer"); |
| 816 | |
| 817 | // Create two data sources but enable only one of them. |
| 818 | producer->RegisterDataSource("ds_1"); |
| 819 | producer->RegisterDataSource("ds_2"); |
| 820 | |
| 821 | TraceConfig trace_config; |
| 822 | trace_config.add_buffers()->set_size_kb(128); |
| 823 | trace_config.add_data_sources()->mutable_config()->set_name("ds_1"); |
| 824 | trace_config.set_deferred_start(true); |
| 825 | trace_config.set_duration_ms(1); |
| 826 | |
| 827 | consumer->EnableTracing(trace_config); |
| 828 | producer->WaitForTracingSetup(); |
| 829 | |
| 830 | producer->WaitForDataSourceSetup("ds_1"); |
| 831 | |
| 832 | // Make sure we don't get unexpected DataSourceStart() notifications yet. |
| 833 | task_runner.RunUntilIdle(); |
| 834 | |
| 835 | consumer->StartTracing(); |
| 836 | |
| 837 | producer->WaitForDataSourceStart("ds_1"); |
| 838 | |
| 839 | auto writer1 = producer->CreateTraceWriter("ds_1"); |
| 840 | producer->WaitForFlush(writer1.get()); |
| 841 | |
| 842 | producer->WaitForDataSourceStop("ds_1"); |
| 843 | consumer->WaitForTracingDisabled(); |
| 844 | } |
| 845 | |
Primiano Tucci | 4f9b6d7 | 2017-12-05 20:59:16 +0000 | [diff] [blame] | 846 | } // namespace perfetto |