1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* 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/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
namespace ipc {
class Client;
} // namespace ipc
class Producer;
class PosixSharedMemory;
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(const char* service_sock_name,
Producer*,
const std::string& producer_name,
base::TaskRunner*,
TracingService::ProducerSMBScrapingMode,
size_t shared_memory_size_hint_bytes = 0,
size_t shared_memory_page_size_hint_bytes = 0);
~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 RegisterDataSource(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;
std::unique_ptr<TraceWriter> CreateTraceWriter(
BufferID target_buffer,
BufferExhaustedPolicy) override;
SharedMemoryArbiter* GetInProcessShmemArbiter() 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;
private:
// Invoked soon after having established the connection with the service.
void OnConnectionInitialized(bool connection_succeeded);
// 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::GetAsyncCommandResponse&);
// TODO think to destruction order, do we rely on any specific dtor sequence?
Producer* const producer_;
base::TaskRunner* const task_runner_;
// 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.
protos::ProducerPortProxy producer_port_;
std::unique_ptr<PosixSharedMemory> 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_;
PERFETTO_THREAD_CHECKER(thread_checker_)
};
} // namespace perfetto
#endif // SRC_TRACING_IPC_PRODUCER_PRODUCER_IPC_CLIENT_IMPL_H_
|
