xref: /aosp_15_r20/external/perfetto/src/ipc/service_proxy.cc (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1*6dbdd20aSAndroid Build Coastguard Worker /*
2*6dbdd20aSAndroid Build Coastguard Worker  * Copyright (C) 2017 The Android Open Source Project
3*6dbdd20aSAndroid Build Coastguard Worker  *
4*6dbdd20aSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*6dbdd20aSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*6dbdd20aSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*6dbdd20aSAndroid Build Coastguard Worker  *
8*6dbdd20aSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*6dbdd20aSAndroid Build Coastguard Worker  *
10*6dbdd20aSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*6dbdd20aSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*6dbdd20aSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*6dbdd20aSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*6dbdd20aSAndroid Build Coastguard Worker  * limitations under the License.
15*6dbdd20aSAndroid Build Coastguard Worker  */
16*6dbdd20aSAndroid Build Coastguard Worker 
17*6dbdd20aSAndroid Build Coastguard Worker #include "perfetto/ext/ipc/service_proxy.h"
18*6dbdd20aSAndroid Build Coastguard Worker 
19*6dbdd20aSAndroid Build Coastguard Worker #include <utility>
20*6dbdd20aSAndroid Build Coastguard Worker 
21*6dbdd20aSAndroid Build Coastguard Worker #include "perfetto/base/logging.h"
22*6dbdd20aSAndroid Build Coastguard Worker #include "perfetto/ext/base/weak_ptr.h"
23*6dbdd20aSAndroid Build Coastguard Worker #include "perfetto/ext/ipc/service_descriptor.h"
24*6dbdd20aSAndroid Build Coastguard Worker #include "src/ipc/client_impl.h"
25*6dbdd20aSAndroid Build Coastguard Worker 
26*6dbdd20aSAndroid Build Coastguard Worker #include "protos/perfetto/ipc/wire_protocol.gen.h"
27*6dbdd20aSAndroid Build Coastguard Worker 
28*6dbdd20aSAndroid Build Coastguard Worker namespace perfetto {
29*6dbdd20aSAndroid Build Coastguard Worker namespace ipc {
30*6dbdd20aSAndroid Build Coastguard Worker 
ServiceProxy(EventListener * event_listener)31*6dbdd20aSAndroid Build Coastguard Worker ServiceProxy::ServiceProxy(EventListener* event_listener)
32*6dbdd20aSAndroid Build Coastguard Worker     : event_listener_(event_listener), weak_ptr_factory_(this) {}
33*6dbdd20aSAndroid Build Coastguard Worker 
~ServiceProxy()34*6dbdd20aSAndroid Build Coastguard Worker ServiceProxy::~ServiceProxy() {
35*6dbdd20aSAndroid Build Coastguard Worker   if (client_ && connected())
36*6dbdd20aSAndroid Build Coastguard Worker     client_->UnbindService(service_id_);
37*6dbdd20aSAndroid Build Coastguard Worker }
38*6dbdd20aSAndroid Build Coastguard Worker 
InitializeBinding(base::WeakPtr<Client> client,ServiceID service_id,std::map<std::string,MethodID> remote_method_ids)39*6dbdd20aSAndroid Build Coastguard Worker void ServiceProxy::InitializeBinding(
40*6dbdd20aSAndroid Build Coastguard Worker     base::WeakPtr<Client> client,
41*6dbdd20aSAndroid Build Coastguard Worker     ServiceID service_id,
42*6dbdd20aSAndroid Build Coastguard Worker     std::map<std::string, MethodID> remote_method_ids) {
43*6dbdd20aSAndroid Build Coastguard Worker   client_ = std::move(client);
44*6dbdd20aSAndroid Build Coastguard Worker   service_id_ = service_id;
45*6dbdd20aSAndroid Build Coastguard Worker   remote_method_ids_ = std::move(remote_method_ids);
46*6dbdd20aSAndroid Build Coastguard Worker }
47*6dbdd20aSAndroid Build Coastguard Worker 
BeginInvoke(const std::string & method_name,const ProtoMessage & request,DeferredBase reply,int fd)48*6dbdd20aSAndroid Build Coastguard Worker void ServiceProxy::BeginInvoke(const std::string& method_name,
49*6dbdd20aSAndroid Build Coastguard Worker                                const ProtoMessage& request,
50*6dbdd20aSAndroid Build Coastguard Worker                                DeferredBase reply,
51*6dbdd20aSAndroid Build Coastguard Worker                                int fd) {
52*6dbdd20aSAndroid Build Coastguard Worker   // |reply| will auto-resolve if it gets out of scope early.
53*6dbdd20aSAndroid Build Coastguard Worker   if (!connected()) {
54*6dbdd20aSAndroid Build Coastguard Worker     PERFETTO_DFATAL("Not connected.");
55*6dbdd20aSAndroid Build Coastguard Worker     return;
56*6dbdd20aSAndroid Build Coastguard Worker   }
57*6dbdd20aSAndroid Build Coastguard Worker   if (!client_)
58*6dbdd20aSAndroid Build Coastguard Worker     return;  // The Client object has been destroyed in the meantime.
59*6dbdd20aSAndroid Build Coastguard Worker 
60*6dbdd20aSAndroid Build Coastguard Worker   auto remote_method_it = remote_method_ids_.find(method_name);
61*6dbdd20aSAndroid Build Coastguard Worker   RequestID request_id = 0;
62*6dbdd20aSAndroid Build Coastguard Worker   const bool drop_reply = !reply.IsBound();
63*6dbdd20aSAndroid Build Coastguard Worker   if (remote_method_it != remote_method_ids_.end()) {
64*6dbdd20aSAndroid Build Coastguard Worker     request_id =
65*6dbdd20aSAndroid Build Coastguard Worker         static_cast<ClientImpl*>(client_.get())
66*6dbdd20aSAndroid Build Coastguard Worker             ->BeginInvoke(service_id_, method_name, remote_method_it->second,
67*6dbdd20aSAndroid Build Coastguard Worker                           request, drop_reply, weak_ptr_factory_.GetWeakPtr(),
68*6dbdd20aSAndroid Build Coastguard Worker                           fd);
69*6dbdd20aSAndroid Build Coastguard Worker   } else {
70*6dbdd20aSAndroid Build Coastguard Worker     PERFETTO_DLOG("Cannot find method \"%s\" on the host", method_name.c_str());
71*6dbdd20aSAndroid Build Coastguard Worker   }
72*6dbdd20aSAndroid Build Coastguard Worker 
73*6dbdd20aSAndroid Build Coastguard Worker   // When passing |drop_reply| == true, the returned |request_id| should be 0.
74*6dbdd20aSAndroid Build Coastguard Worker   PERFETTO_DCHECK(!drop_reply || !request_id);
75*6dbdd20aSAndroid Build Coastguard Worker 
76*6dbdd20aSAndroid Build Coastguard Worker   if (!request_id)
77*6dbdd20aSAndroid Build Coastguard Worker     return;
78*6dbdd20aSAndroid Build Coastguard Worker   PERFETTO_DCHECK(pending_callbacks_.count(request_id) == 0);
79*6dbdd20aSAndroid Build Coastguard Worker   pending_callbacks_.emplace(request_id, std::move(reply));
80*6dbdd20aSAndroid Build Coastguard Worker }
81*6dbdd20aSAndroid Build Coastguard Worker 
EndInvoke(RequestID request_id,std::unique_ptr<ProtoMessage> result,bool has_more)82*6dbdd20aSAndroid Build Coastguard Worker void ServiceProxy::EndInvoke(RequestID request_id,
83*6dbdd20aSAndroid Build Coastguard Worker                              std::unique_ptr<ProtoMessage> result,
84*6dbdd20aSAndroid Build Coastguard Worker                              bool has_more) {
85*6dbdd20aSAndroid Build Coastguard Worker   auto callback_it = pending_callbacks_.find(request_id);
86*6dbdd20aSAndroid Build Coastguard Worker   if (callback_it == pending_callbacks_.end()) {
87*6dbdd20aSAndroid Build Coastguard Worker     // Either we are getting a reply for a method we never invoked, or we are
88*6dbdd20aSAndroid Build Coastguard Worker     // getting a reply to a method marked drop_reply (that has been invoked
89*6dbdd20aSAndroid Build Coastguard Worker     // without binding any callback in the Defererd response object).
90*6dbdd20aSAndroid Build Coastguard Worker     PERFETTO_DFATAL("Unexpected reply received.");
91*6dbdd20aSAndroid Build Coastguard Worker     return;
92*6dbdd20aSAndroid Build Coastguard Worker   }
93*6dbdd20aSAndroid Build Coastguard Worker   DeferredBase& reply_callback = callback_it->second;
94*6dbdd20aSAndroid Build Coastguard Worker   AsyncResult<ProtoMessage> reply(std::move(result), has_more);
95*6dbdd20aSAndroid Build Coastguard Worker   reply_callback.Resolve(std::move(reply));
96*6dbdd20aSAndroid Build Coastguard Worker   if (!has_more)
97*6dbdd20aSAndroid Build Coastguard Worker     pending_callbacks_.erase(callback_it);
98*6dbdd20aSAndroid Build Coastguard Worker }
99*6dbdd20aSAndroid Build Coastguard Worker 
OnConnect(bool success)100*6dbdd20aSAndroid Build Coastguard Worker void ServiceProxy::OnConnect(bool success) {
101*6dbdd20aSAndroid Build Coastguard Worker   if (success) {
102*6dbdd20aSAndroid Build Coastguard Worker     PERFETTO_DCHECK(service_id_);
103*6dbdd20aSAndroid Build Coastguard Worker     return event_listener_->OnConnect();
104*6dbdd20aSAndroid Build Coastguard Worker   }
105*6dbdd20aSAndroid Build Coastguard Worker   return event_listener_->OnDisconnect();
106*6dbdd20aSAndroid Build Coastguard Worker }
107*6dbdd20aSAndroid Build Coastguard Worker 
OnDisconnect()108*6dbdd20aSAndroid Build Coastguard Worker void ServiceProxy::OnDisconnect() {
109*6dbdd20aSAndroid Build Coastguard Worker   pending_callbacks_.clear();  // Will Reject() all the pending callbacks.
110*6dbdd20aSAndroid Build Coastguard Worker   event_listener_->OnDisconnect();
111*6dbdd20aSAndroid Build Coastguard Worker }
112*6dbdd20aSAndroid Build Coastguard Worker 
GetWeakPtr() const113*6dbdd20aSAndroid Build Coastguard Worker base::WeakPtr<ServiceProxy> ServiceProxy::GetWeakPtr() const {
114*6dbdd20aSAndroid Build Coastguard Worker   return weak_ptr_factory_.GetWeakPtr();
115*6dbdd20aSAndroid Build Coastguard Worker }
116*6dbdd20aSAndroid Build Coastguard Worker 
117*6dbdd20aSAndroid Build Coastguard Worker }  // namespace ipc
118*6dbdd20aSAndroid Build Coastguard Worker }  // namespace perfetto
119