| /* |
| * Copyright (C) 2017 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 SRC_TRACING_IPC_PRODUCER_PRODUCER_IPC_CLIENT_IMPL_H_ |
| #define SRC_TRACING_IPC_PRODUCER_PRODUCER_IPC_CLIENT_IMPL_H_ |
| |
| #include <stdint.h> |
| |
| #include <set> |
| #include <vector> |
| |
| #include "perfetto/ext/base/thread_checker.h" |
| #include "perfetto/ext/base/weak_ptr.h" |
| #include "perfetto/ext/ipc/client.h" |
| #include "perfetto/ext/ipc/service_proxy.h" |
| #include "perfetto/ext/tracing/core/basic_types.h" |
| #include "perfetto/ext/tracing/core/shared_memory.h" |
| #include "perfetto/ext/tracing/core/tracing_service.h" |
| #include "perfetto/ext/tracing/ipc/producer_ipc_client.h" |
| |
| #include "protos/perfetto/ipc/producer_port.ipc.h" |
| |
| namespace perfetto { |
| |
| namespace base { |
| class TaskRunner; |
| } // namespace base |
| |
| class Producer; |
| class SharedMemoryArbiter; |
| |
| // Exposes a Service endpoint to Producer(s), proxying all requests through a |
| // IPC channel to the remote Service. This class is the glue layer between the |
| // generic Service interface exposed to the clients of the library and the |
| // actual IPC transport. |
| class ProducerIPCClientImpl : public TracingService::ProducerEndpoint, |
| public ipc::ServiceProxy::EventListener { |
| public: |
| ProducerIPCClientImpl(ipc::Client::ConnArgs, |
| Producer*, |
| const std::string& producer_name, |
| base::TaskRunner*, |
| TracingService::ProducerSMBScrapingMode, |
| size_t shared_memory_size_hint_bytes, |
| size_t shared_memory_page_size_hint_bytes, |
| std::unique_ptr<SharedMemory> shm, |
| std::unique_ptr<SharedMemoryArbiter> shm_arbiter); |
| ~ProducerIPCClientImpl() override; |
| |
| // TracingService::ProducerEndpoint implementation. |
| // These methods are invoked by the actual Producer(s) code by clients of the |
| // tracing library, which know nothing about the IPC transport. |
| void Disconnect() override; |
| void RegisterDataSource(const DataSourceDescriptor&) override; |
| void UpdateDataSource(const DataSourceDescriptor&) override; |
| void UnregisterDataSource(const std::string& name) override; |
| void RegisterTraceWriter(uint32_t writer_id, uint32_t target_buffer) override; |
| void UnregisterTraceWriter(uint32_t writer_id) override; |
| void CommitData(const CommitDataRequest&, CommitDataCallback) override; |
| void NotifyDataSourceStarted(DataSourceInstanceID) override; |
| void NotifyDataSourceStopped(DataSourceInstanceID) override; |
| void ActivateTriggers(const std::vector<std::string>&) override; |
| void Sync(std::function<void()> callback) override; |
| |
| std::unique_ptr<TraceWriter> CreateTraceWriter( |
| BufferID target_buffer, |
| BufferExhaustedPolicy) override; |
| SharedMemoryArbiter* MaybeSharedMemoryArbiter() override; |
| bool IsShmemProvidedByProducer() const override; |
| void NotifyFlushComplete(FlushRequestID) override; |
| SharedMemory* shared_memory() const override; |
| size_t shared_buffer_page_size_kb() const override; |
| |
| // ipc::ServiceProxy::EventListener implementation. |
| // These methods are invoked by the IPC layer, which knows nothing about |
| // tracing, producers and consumers. |
| void OnConnect() override; |
| void OnDisconnect() override; |
| |
| ipc::Client* GetClientForTesting() { return ipc_channel_.get(); } |
| |
| private: |
| // Drops the provider connection if a protocol error was detected while |
| // processing an IPC command. |
| void ScheduleDisconnect(); |
| |
| // Invoked soon after having established the connection with the service. |
| void OnConnectionInitialized(bool connection_succeeded, |
| bool using_shmem_provided_by_producer, |
| bool direct_smb_patching_supported); |
| |
| // Invoked when the remote Service sends an IPC to tell us to do something |
| // (e.g. start/stop a data source). |
| void OnServiceRequest(const protos::gen::GetAsyncCommandResponse&); |
| |
| // TODO think to destruction order, do we rely on any specific dtor sequence? |
| Producer* const producer_; |
| base::TaskRunner* const task_runner_; |
| |
| // A callback used to receive the shmem region out of band of the socket. |
| std::function<int(void)> receive_shmem_fd_cb_fuchsia_; |
| |
| // The object that owns the client socket and takes care of IPC traffic. |
| std::unique_ptr<ipc::Client> ipc_channel_; |
| |
| // The proxy interface for the producer port of the service. It is bound |
| // to |ipc_channel_| and (de)serializes method invocations over the wire. |
| std::unique_ptr<protos::gen::ProducerPortProxy> producer_port_; |
| |
| std::unique_ptr<SharedMemory> shared_memory_; |
| std::unique_ptr<SharedMemoryArbiter> shared_memory_arbiter_; |
| size_t shared_buffer_page_size_kb_ = 0; |
| std::set<DataSourceInstanceID> data_sources_setup_; |
| bool connected_ = false; |
| std::string const name_; |
| size_t shared_memory_page_size_hint_bytes_ = 0; |
| size_t shared_memory_size_hint_bytes_ = 0; |
| TracingService::ProducerSMBScrapingMode const smb_scraping_mode_; |
| bool is_shmem_provided_by_producer_ = false; |
| bool direct_smb_patching_supported_ = false; |
| std::vector<std::function<void()>> pending_sync_reqs_; |
| base::WeakPtrFactory<ProducerIPCClientImpl> weak_factory_{this}; |
| PERFETTO_THREAD_CHECKER(thread_checker_) |
| }; |
| |
| } // namespace perfetto |
| |
| #endif // SRC_TRACING_IPC_PRODUCER_PRODUCER_IPC_CLIENT_IMPL_H_ |