| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #ifndef TEST_TEST_HELPER_H_ |
| #define TEST_TEST_HELPER_H_ |
| |
| #include "perfetto/ext/base/scoped_file.h" |
| #include "perfetto/ext/base/thread_task_runner.h" |
| #include "perfetto/ext/tracing/core/consumer.h" |
| #include "perfetto/ext/tracing/core/shared_memory_arbiter.h" |
| #include "perfetto/ext/tracing/core/trace_packet.h" |
| #include "perfetto/ext/tracing/ipc/consumer_ipc_client.h" |
| #include "perfetto/ext/tracing/ipc/service_ipc_host.h" |
| #include "perfetto/tracing/core/trace_config.h" |
| #include "src/base/test/test_task_runner.h" |
| #include "src/traced/probes/probes_producer.h" |
| #include "src/tracing/ipc/posix_shared_memory.h" |
| #include "test/fake_producer.h" |
| |
| #include "protos/perfetto/trace/trace_packet.gen.h" |
| |
| namespace perfetto { |
| |
| // This value has been bumped to 10s in Oct 2020 because the x86 cuttlefish |
| // emulator is sensibly slower (up to 10x) than real hw and caused flakes. |
| // See bugs duped against b/171771440. |
| constexpr uint32_t kDefaultTestTimeoutMs = 10000; |
| |
| // This is used only in daemon starting integrations tests. |
| class ServiceThread { |
| public: |
| ServiceThread(const std::string& producer_socket, |
| const std::string& consumer_socket) |
| : producer_socket_(producer_socket), consumer_socket_(consumer_socket) {} |
| |
| ~ServiceThread() { |
| if (!runner_) |
| return; |
| runner_->PostTaskAndWaitForTesting([this]() { svc_.reset(); }); |
| } |
| |
| void Start() { |
| runner_ = base::ThreadTaskRunner::CreateAndStart("perfetto.svc"); |
| runner_->PostTaskAndWaitForTesting([this]() { |
| svc_ = ServiceIPCHost::CreateInstance(runner_->get()); |
| unlink(producer_socket_.c_str()); |
| unlink(consumer_socket_.c_str()); |
| setenv("PERFETTO_PRODUCER_SOCK_NAME", producer_socket_.c_str(), |
| /*overwrite=*/true); |
| setenv("PERFETTO_CONSUMER_SOCK_NAME", consumer_socket_.c_str(), |
| /*overwrite=*/true); |
| bool res = |
| svc_->Start(producer_socket_.c_str(), consumer_socket_.c_str()); |
| PERFETTO_CHECK(res); |
| }); |
| } |
| |
| base::ThreadTaskRunner* runner() { return runner_ ? &*runner_ : nullptr; } |
| |
| private: |
| base::Optional<base::ThreadTaskRunner> runner_; // Keep first. |
| |
| std::string producer_socket_; |
| std::string consumer_socket_; |
| std::unique_ptr<ServiceIPCHost> svc_; |
| }; |
| |
| // This is used only in daemon starting integrations tests. |
| class ProbesProducerThread { |
| public: |
| ProbesProducerThread(const std::string& producer_socket) |
| : producer_socket_(producer_socket) {} |
| |
| ~ProbesProducerThread() { |
| if (!runner_) |
| return; |
| runner_->PostTaskAndWaitForTesting([this]() { producer_.reset(); }); |
| } |
| |
| void Connect() { |
| runner_ = base::ThreadTaskRunner::CreateAndStart("perfetto.prd.probes"); |
| runner_->PostTaskAndWaitForTesting([this]() { |
| producer_.reset(new ProbesProducer()); |
| producer_->ConnectWithRetries(producer_socket_.c_str(), runner_->get()); |
| }); |
| } |
| |
| private: |
| base::Optional<base::ThreadTaskRunner> runner_; // Keep first. |
| |
| std::string producer_socket_; |
| std::unique_ptr<ProbesProducer> producer_; |
| }; |
| |
| class FakeProducerThread { |
| public: |
| FakeProducerThread(const std::string& producer_socket, |
| std::function<void()> connect_callback, |
| std::function<void()> setup_callback, |
| std::function<void()> start_callback) |
| : producer_socket_(producer_socket), |
| connect_callback_(std::move(connect_callback)), |
| setup_callback_(std::move(setup_callback)), |
| start_callback_(std::move(start_callback)) { |
| runner_ = base::ThreadTaskRunner::CreateAndStart("perfetto.prd.fake"); |
| runner_->PostTaskAndWaitForTesting([this]() { |
| producer_.reset( |
| new FakeProducer("android.perfetto.FakeProducer", runner_->get())); |
| }); |
| } |
| |
| ~FakeProducerThread() { |
| runner_->PostTaskAndWaitForTesting([this]() { producer_.reset(); }); |
| } |
| |
| void Connect() { |
| runner_->PostTaskAndWaitForTesting([this]() { |
| producer_->Connect(producer_socket_.c_str(), std::move(connect_callback_), |
| std::move(setup_callback_), std::move(start_callback_), |
| std::move(shm_), std::move(shm_arbiter_)); |
| }); |
| } |
| |
| base::ThreadTaskRunner* runner() { return runner_ ? &*runner_ : nullptr; } |
| |
| FakeProducer* producer() { return producer_.get(); } |
| |
| void CreateProducerProvidedSmb() { |
| PosixSharedMemory::Factory factory; |
| shm_ = factory.CreateSharedMemory(1024 * 1024); |
| shm_arbiter_ = SharedMemoryArbiter::CreateUnboundInstance(shm_.get(), 4096); |
| } |
| |
| void ProduceStartupEventBatch(const protos::gen::TestConfig& config, |
| std::function<void()> callback) { |
| PERFETTO_CHECK(shm_arbiter_); |
| producer_->ProduceStartupEventBatch(config, shm_arbiter_.get(), callback); |
| } |
| |
| private: |
| base::Optional<base::ThreadTaskRunner> runner_; // Keep first. |
| |
| std::string producer_socket_; |
| std::unique_ptr<FakeProducer> producer_; |
| std::function<void()> connect_callback_; |
| std::function<void()> setup_callback_; |
| std::function<void()> start_callback_; |
| std::unique_ptr<SharedMemory> shm_; |
| std::unique_ptr<SharedMemoryArbiter> shm_arbiter_; |
| }; |
| |
| class TestHelper : public Consumer { |
| public: |
| static const char* GetConsumerSocketName(); |
| static const char* GetProducerSocketName(); |
| |
| explicit TestHelper(base::TestTaskRunner* task_runner); |
| |
| // Consumer implementation. |
| void OnConnect() override; |
| void OnDisconnect() override; |
| void OnTracingDisabled(const std::string& error) override; |
| void OnTraceData(std::vector<TracePacket> packets, bool has_more) override; |
| void OnDetach(bool) override; |
| void OnAttach(bool, const TraceConfig&) override; |
| void OnTraceStats(bool, const TraceStats&) override; |
| void OnObservableEvents(const ObservableEvents&) override; |
| |
| // Starts the tracing service unconditionally. |
| void StartService(); |
| |
| // Starts the tracing service unless the build was configured to use an |
| // existing one running on the system. |
| void StartServiceIfRequired(); |
| |
| // Connects the producer and waits that the service has seen the |
| // RegisterDataSource() call. |
| FakeProducer* ConnectFakeProducer(); |
| |
| void ConnectConsumer(); |
| void StartTracing(const TraceConfig& config, |
| base::ScopedFile = base::ScopedFile()); |
| void DisableTracing(); |
| void FlushAndWait(uint32_t timeout_ms); |
| void ReadData(uint32_t read_count = 0); |
| void DetachConsumer(const std::string& key); |
| bool AttachConsumer(const std::string& key); |
| void CreateProducerProvidedSmb(); |
| bool IsShmemProvidedByProducer(); |
| void ProduceStartupEventBatch(const protos::gen::TestConfig& config); |
| |
| void WaitForConsumerConnect(); |
| void WaitForProducerSetup(); |
| void WaitForProducerEnabled(); |
| void WaitForTracingDisabled(uint32_t timeout_ms = kDefaultTestTimeoutMs); |
| void WaitForReadData(uint32_t read_count = 0, |
| uint32_t timeout_ms = kDefaultTestTimeoutMs); |
| void SyncAndWaitProducer(); |
| TracingServiceState QueryServiceStateAndWait(); |
| |
| std::string AddID(const std::string& checkpoint) { |
| return checkpoint + "." + std::to_string(instance_num_); |
| } |
| |
| std::function<void()> CreateCheckpoint(const std::string& checkpoint) { |
| return task_runner_->CreateCheckpoint(AddID(checkpoint)); |
| } |
| |
| void RunUntilCheckpoint(const std::string& checkpoint, |
| uint32_t timeout_ms = kDefaultTestTimeoutMs) { |
| return task_runner_->RunUntilCheckpoint(AddID(checkpoint), timeout_ms); |
| } |
| |
| std::function<void()> WrapTask(const std::function<void()>& function); |
| |
| base::ThreadTaskRunner* service_thread() { return service_thread_.runner(); } |
| base::ThreadTaskRunner* producer_thread() { |
| return fake_producer_thread_.runner(); |
| } |
| const std::vector<protos::gen::TracePacket>& full_trace() { |
| return full_trace_; |
| } |
| const std::vector<protos::gen::TracePacket>& trace() { return trace_; } |
| |
| private: |
| static uint64_t next_instance_num_; |
| uint64_t instance_num_; |
| base::TestTaskRunner* task_runner_ = nullptr; |
| int cur_consumer_num_ = 0; |
| |
| std::function<void()> on_connect_callback_; |
| std::function<void()> on_packets_finished_callback_; |
| std::function<void()> on_stop_tracing_callback_; |
| std::function<void()> on_detach_callback_; |
| std::function<void(bool)> on_attach_callback_; |
| |
| std::vector<protos::gen::TracePacket> full_trace_; |
| std::vector<protos::gen::TracePacket> trace_; |
| |
| ServiceThread service_thread_; |
| FakeProducerThread fake_producer_thread_; |
| |
| std::unique_ptr<TracingService::ConsumerEndpoint> endpoint_; // Keep last. |
| }; |
| |
| } // namespace perfetto |
| |
| #endif // TEST_TEST_HELPER_H_ |