Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 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 | |
| 17 | #include "test/fake_producer.h" |
| 18 | |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 19 | #include <mutex> |
Primiano Tucci | 10c9e9e | 2021-01-08 13:04:40 +0100 | [diff] [blame] | 20 | #include <thread> |
Lalit Maganti | 3f5705c | 2018-03-09 12:09:44 +0000 | [diff] [blame] | 21 | |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 22 | #include "perfetto/base/logging.h" |
Eric Seckler | 83dcc8c | 2019-08-21 12:18:43 +0100 | [diff] [blame] | 23 | #include "perfetto/base/time.h" |
Primiano Tucci | 2c5488f | 2019-06-01 03:27:28 +0100 | [diff] [blame] | 24 | #include "perfetto/ext/base/utils.h" |
Primiano Tucci | 9c41ceb | 2020-04-14 13:23:01 +0100 | [diff] [blame] | 25 | #include "perfetto/ext/tracing/core/commit_data_request.h" |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 26 | #include "perfetto/ext/tracing/core/shared_memory_arbiter.h" |
Primiano Tucci | 2c5488f | 2019-06-01 03:27:28 +0100 | [diff] [blame] | 27 | #include "perfetto/ext/tracing/core/trace_packet.h" |
| 28 | #include "perfetto/ext/tracing/core/trace_writer.h" |
Primiano Tucci | 3b39fc7 | 2019-06-22 19:05:23 +0100 | [diff] [blame] | 29 | #include "perfetto/tracing/core/data_source_config.h" |
Stephen Nusko | 1af720e | 2020-11-18 14:04:16 -0500 | [diff] [blame] | 30 | #include "src/ipc/client_impl.h" |
| 31 | #include "src/tracing/ipc/producer/producer_ipc_client_impl.h" |
Primiano Tucci | 57dd66b | 2019-10-15 23:09:04 +0100 | [diff] [blame] | 32 | |
| 33 | #include "protos/perfetto/config/test_config.gen.h" |
Primiano Tucci | 355b8c8 | 2019-08-29 08:37:51 +0200 | [diff] [blame] | 34 | #include "protos/perfetto/trace/test_event.pbzero.h" |
| 35 | #include "protos/perfetto/trace/trace_packet.pbzero.h" |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 36 | |
| 37 | namespace perfetto { |
| 38 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 39 | namespace { |
| 40 | const MaybeUnboundBufferID kStartupTargetBufferReservationId = 1; |
| 41 | } // namespace |
| 42 | |
| 43 | FakeProducer::FakeProducer(const std::string& name, |
| 44 | base::TaskRunner* task_runner) |
| 45 | : name_(name), task_runner_(task_runner) {} |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 46 | FakeProducer::~FakeProducer() = default; |
| 47 | |
Eric Seckler | 326a3d3 | 2020-02-04 11:24:56 +0000 | [diff] [blame] | 48 | void FakeProducer::Connect(const char* socket_name, |
Primiano Tucci | bbe68be | 2020-04-16 22:17:12 +0100 | [diff] [blame] | 49 | std::function<void()> on_connect, |
Eric Seckler | 326a3d3 | 2020-02-04 11:24:56 +0000 | [diff] [blame] | 50 | std::function<void()> on_setup_data_source_instance, |
| 51 | std::function<void()> on_create_data_source_instance, |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 52 | std::unique_ptr<SharedMemory> shm, |
| 53 | std::unique_ptr<SharedMemoryArbiter> shm_arbiter) { |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 54 | PERFETTO_DCHECK_THREAD(thread_checker_); |
Isabelle Taylor | 86262cb | 2018-03-27 16:00:54 +0100 | [diff] [blame] | 55 | endpoint_ = ProducerIPCClient::Connect( |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 56 | socket_name, this, "android.perfetto.FakeProducer", task_runner_, |
Eric Seckler | 326a3d3 | 2020-02-04 11:24:56 +0000 | [diff] [blame] | 57 | TracingService::ProducerSMBScrapingMode::kDefault, |
| 58 | /*shared_memory_size_hint_bytes=*/0, |
Primiano Tucci | 90d6930 | 2020-08-20 17:22:12 +0200 | [diff] [blame] | 59 | /*shared_memory_page_size_hint_bytes=*/4096, std::move(shm), |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 60 | std::move(shm_arbiter)); |
Primiano Tucci | bbe68be | 2020-04-16 22:17:12 +0100 | [diff] [blame] | 61 | on_connect_ = std::move(on_connect); |
Stephen Nusko | e823811 | 2019-04-09 18:37:00 +0100 | [diff] [blame] | 62 | on_setup_data_source_instance_ = std::move(on_setup_data_source_instance); |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 63 | on_create_data_source_instance_ = std::move(on_create_data_source_instance); |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | void FakeProducer::OnConnect() { |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 67 | PERFETTO_DCHECK_THREAD(thread_checker_); |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 68 | DataSourceDescriptor descriptor; |
| 69 | descriptor.set_name(name_); |
Primiano Tucci | 9daa483 | 2018-03-28 23:28:17 +0100 | [diff] [blame] | 70 | endpoint_->RegisterDataSource(descriptor); |
Primiano Tucci | bbe68be | 2020-04-16 22:17:12 +0100 | [diff] [blame] | 71 | auto on_connect_callback = std::move(on_connect_); |
| 72 | auto task_runner = task_runner_; |
| 73 | endpoint_->Sync([task_runner, on_connect_callback] { |
| 74 | task_runner->PostTask(on_connect_callback); |
| 75 | }); |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 76 | } |
| 77 | |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 78 | void FakeProducer::OnDisconnect() { |
| 79 | PERFETTO_DCHECK_THREAD(thread_checker_); |
Primiano Tucci | 008cdb9 | 2019-07-19 19:52:41 +0100 | [diff] [blame] | 80 | PERFETTO_FATAL("Producer unexpectedly disconnected from the service"); |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 81 | } |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 82 | |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 83 | void FakeProducer::SetupDataSource(DataSourceInstanceID, |
Stephen Nusko | e823811 | 2019-04-09 18:37:00 +0100 | [diff] [blame] | 84 | const DataSourceConfig&) { |
| 85 | task_runner_->PostTask(on_setup_data_source_instance_); |
| 86 | } |
Primiano Tucci | 674076d | 2018-10-01 10:41:09 +0100 | [diff] [blame] | 87 | |
Primiano Tucci | afb72b5 | 2018-09-25 09:37:24 +0100 | [diff] [blame] | 88 | void FakeProducer::StartDataSource(DataSourceInstanceID, |
| 89 | const DataSourceConfig& source_config) { |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 90 | PERFETTO_DCHECK_THREAD(thread_checker_); |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 91 | if (trace_writer_) { |
| 92 | // Startup tracing was already active, just bind the target buffer. |
| 93 | endpoint_->MaybeSharedMemoryArbiter()->BindStartupTargetBuffer( |
| 94 | kStartupTargetBufferReservationId, |
| 95 | static_cast<BufferID>(source_config.target_buffer())); |
| 96 | } else { |
| 97 | // Common case: Start tracing now. |
| 98 | trace_writer_ = endpoint_->CreateTraceWriter( |
| 99 | static_cast<BufferID>(source_config.target_buffer())); |
| 100 | SetupFromConfig(source_config.for_testing()); |
| 101 | } |
Lalit Maganti | 36557d8 | 2018-04-11 14:36:17 +0100 | [diff] [blame] | 102 | if (source_config.for_testing().send_batch_on_register()) { |
| 103 | ProduceEventBatch(on_create_data_source_instance_); |
| 104 | } else { |
| 105 | task_runner_->PostTask(on_create_data_source_instance_); |
| 106 | } |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 107 | } |
| 108 | |
Primiano Tucci | afb72b5 | 2018-09-25 09:37:24 +0100 | [diff] [blame] | 109 | void FakeProducer::StopDataSource(DataSourceInstanceID) { |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 110 | PERFETTO_DCHECK_THREAD(thread_checker_); |
| 111 | trace_writer_.reset(); |
| 112 | } |
| 113 | |
Lalit Maganti | 36557d8 | 2018-04-11 14:36:17 +0100 | [diff] [blame] | 114 | // Note: this can be called on a different thread. |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 115 | void FakeProducer::ProduceStartupEventBatch( |
| 116 | const protos::gen::TestConfig& config, |
| 117 | SharedMemoryArbiter* arbiter, |
| 118 | std::function<void()> callback) { |
| 119 | task_runner_->PostTask([this, config, arbiter, callback] { |
| 120 | SetupFromConfig(config); |
Lalit Maganti | 131b6e5 | 2018-03-29 18:29:31 +0100 | [diff] [blame] | 121 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 122 | PERFETTO_CHECK(!trace_writer_); |
| 123 | trace_writer_ = |
| 124 | arbiter->CreateStartupTraceWriter(kStartupTargetBufferReservationId); |
Lalit Maganti | 131b6e5 | 2018-03-29 18:29:31 +0100 | [diff] [blame] | 125 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 126 | EmitEventBatchOnTaskRunner({}); |
Lalit Maganti | 131b6e5 | 2018-03-29 18:29:31 +0100 | [diff] [blame] | 127 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 128 | // Issue callback right after writing - cannot wait for flush yet because |
| 129 | // we're not connected yet. |
| 130 | callback(); |
Lalit Maganti | bfc3d3e | 2018-03-22 20:28:38 +0000 | [diff] [blame] | 131 | }); |
| 132 | } |
Primiano Tucci | 9c41ceb | 2020-04-14 13:23:01 +0100 | [diff] [blame] | 133 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 134 | // Note: this can be called on a different thread. |
| 135 | void FakeProducer::ProduceEventBatch(std::function<void()> callback) { |
| 136 | task_runner_->PostTask( |
| 137 | [this, callback] { EmitEventBatchOnTaskRunner(callback); }); |
| 138 | } |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 139 | |
Primiano Tucci | 9c41ceb | 2020-04-14 13:23:01 +0100 | [diff] [blame] | 140 | void FakeProducer::RegisterDataSource(const DataSourceDescriptor& desc) { |
| 141 | task_runner_->PostTask([this, desc] { endpoint_->RegisterDataSource(desc); }); |
| 142 | } |
| 143 | |
| 144 | void FakeProducer::CommitData(const CommitDataRequest& req, |
| 145 | std::function<void()> callback) { |
| 146 | task_runner_->PostTask( |
| 147 | [this, req, callback] { endpoint_->CommitData(req, callback); }); |
| 148 | } |
| 149 | |
Primiano Tucci | bbe68be | 2020-04-16 22:17:12 +0100 | [diff] [blame] | 150 | void FakeProducer::Sync(std::function<void()> callback) { |
| 151 | task_runner_->PostTask([this, callback] { endpoint_->Sync(callback); }); |
| 152 | } |
| 153 | |
Primiano Tucci | dca727d | 2018-04-04 11:31:55 +0200 | [diff] [blame] | 154 | void FakeProducer::OnTracingSetup() {} |
Isabelle Taylor | 69faa90 | 2018-03-21 15:42:03 +0000 | [diff] [blame] | 155 | |
Primiano Tucci | d52e627 | 2018-04-06 19:06:53 +0200 | [diff] [blame] | 156 | void FakeProducer::Flush(FlushRequestID flush_request_id, |
| 157 | const DataSourceInstanceID*, |
| 158 | size_t num_data_sources) { |
| 159 | PERFETTO_DCHECK(num_data_sources > 0); |
| 160 | if (trace_writer_) |
| 161 | trace_writer_->Flush(); |
| 162 | endpoint_->NotifyFlushComplete(flush_request_id); |
| 163 | } |
| 164 | |
Primiano Tucci | 10c9e9e | 2021-01-08 13:04:40 +0100 | [diff] [blame] | 165 | base::SocketHandle FakeProducer::unix_socket_fd() { |
Stephen Nusko | 1af720e | 2020-11-18 14:04:16 -0500 | [diff] [blame] | 166 | // Since FakeProducer is only used in tests we can include and assume the |
| 167 | // implementation. |
| 168 | auto* producer = static_cast<ProducerIPCClientImpl*>(endpoint_.get()); |
| 169 | auto* ipc_client = |
| 170 | static_cast<ipc::ClientImpl*>(producer->GetClientForTesting()); |
| 171 | return ipc_client->GetUnixSocketForTesting()->fd(); |
| 172 | } |
| 173 | |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 174 | void FakeProducer::SetupFromConfig(const protos::gen::TestConfig& config) { |
| 175 | rnd_engine_ = std::minstd_rand0(config.seed()); |
| 176 | message_count_ = config.message_count(); |
| 177 | message_size_ = config.message_size(); |
| 178 | max_messages_per_second_ = config.max_messages_per_second(); |
| 179 | } |
| 180 | |
| 181 | void FakeProducer::EmitEventBatchOnTaskRunner(std::function<void()> callback) { |
| 182 | PERFETTO_CHECK(trace_writer_); |
| 183 | PERFETTO_CHECK(message_size_ > 1); |
| 184 | std::unique_ptr<char, base::FreeDeleter> payload( |
| 185 | static_cast<char*>(malloc(message_size_))); |
| 186 | memset(payload.get(), '.', message_size_); |
| 187 | payload.get()[message_size_ - 1] = 0; |
| 188 | |
| 189 | base::TimeMillis start = base::GetWallTimeMs(); |
| 190 | int64_t iterations = 0; |
| 191 | uint32_t messages_to_emit = message_count_; |
| 192 | while (messages_to_emit > 0) { |
| 193 | uint32_t messages_in_minibatch = |
| 194 | max_messages_per_second_ == 0 |
| 195 | ? messages_to_emit |
| 196 | : std::min(max_messages_per_second_, messages_to_emit); |
| 197 | PERFETTO_DCHECK(messages_to_emit >= messages_in_minibatch); |
| 198 | |
| 199 | for (uint32_t i = 0; i < messages_in_minibatch; i++) { |
| 200 | auto handle = trace_writer_->NewTracePacket(); |
| 201 | handle->set_for_testing()->set_seq_value( |
| 202 | static_cast<uint32_t>(rnd_engine_())); |
| 203 | handle->set_for_testing()->set_str(payload.get(), message_size_); |
| 204 | } |
| 205 | messages_to_emit -= messages_in_minibatch; |
| 206 | iterations++; |
| 207 | |
| 208 | // Pause until the second boundary to make sure that we are adhering to |
| 209 | // the speed limitation. |
| 210 | if (max_messages_per_second_ > 0) { |
| 211 | int64_t expected_time_taken = iterations * 1000; |
| 212 | base::TimeMillis time_taken = base::GetWallTimeMs() - start; |
| 213 | while (time_taken.count() < expected_time_taken) { |
Primiano Tucci | 10c9e9e | 2021-01-08 13:04:40 +0100 | [diff] [blame] | 214 | std::this_thread::sleep_for( |
| 215 | base::TimeMillis(expected_time_taken - time_taken.count())); |
Eric Seckler | 526921b | 2020-02-18 11:44:30 +0000 | [diff] [blame] | 216 | time_taken = base::GetWallTimeMs() - start; |
| 217 | } |
| 218 | } |
| 219 | trace_writer_->Flush(messages_to_emit > 0 ? [] {} : callback); |
| 220 | } |
| 221 | } |
| 222 | |
Lalit Maganti | 79f2d7b | 2018-01-23 18:27:33 +0000 | [diff] [blame] | 223 | } // namespace perfetto |