File: nearby_process_manager_impl.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (349 lines) | stat: -rw-r--r-- 13,504 bytes parent folder | download | duplicates (7)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/nearby/nearby_process_manager_impl.h"

#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_functions.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "chrome/browser/ash/nearby/bluetooth_adapter_manager.h"
#include "chrome/browser/ash/nearby/nearby_dependencies_provider.h"
#include "chrome/browser/nearby_sharing/sharing_mojo_service.h"
#include "chromeos/ash/services/nearby/public/mojom/nearby_decoder.mojom.h"
#include "chromeos/ash/services/nearby/public/mojom/quick_start_decoder.mojom.h"
#include "components/cross_device/logging/logging.h"
#include "components/keyed_service/core/keyed_service.h"

namespace ash {
namespace nearby {
namespace {

NearbyProcessManagerImpl::Factory* g_test_factory = nullptr;

constexpr base::TimeDelta kProcessCleanupTimeout = base::Seconds(5);

void OnSharingShutDownComplete(
    mojo::Remote<sharing::mojom::Sharing> sharing,
    mojo::SharedRemote<::nearby::connections::mojom::NearbyConnections>
        connections,
    mojo::SharedRemote<::ash::nearby::presence::mojom::NearbyPresence> presence,
    mojo::SharedRemote<sharing::mojom::NearbySharingDecoder> decoder) {
  CD_LOG(INFO, Feature::NS) << "Asynchronous process shutdown complete.";
  // Note: Let the parameters go out of scope, which will disconnect them.
}

}  // namespace

// static
std::unique_ptr<NearbyProcessManager> NearbyProcessManagerImpl::Factory::Create(
    NearbyDependenciesProvider* nearby_dependencies_provider,
    std::unique_ptr<base::OneShotTimer> timer) {
  if (g_test_factory) {
    return g_test_factory->BuildInstance(nearby_dependencies_provider,
                                         std::move(timer));
  }

  return base::WrapUnique(new NearbyProcessManagerImpl(
      nearby_dependencies_provider, std::move(timer),
      base::BindRepeating(&sharing::LaunchSharing)));
}

// static
void NearbyProcessManagerImpl::Factory::SetFactoryForTesting(Factory* factory) {
  g_test_factory = factory;
}

NearbyProcessManagerImpl::NearbyReferenceImpl::NearbyReferenceImpl(
    const mojo::SharedRemote<::nearby::connections::mojom::NearbyConnections>&
        connections,
    const mojo::SharedRemote<::ash::nearby::presence::mojom::NearbyPresence>&
        presence,
    const mojo::SharedRemote<sharing::mojom::NearbySharingDecoder>& decoder,
    const mojo::SharedRemote<quick_start::mojom::QuickStartDecoder>&
        quick_start_decoder,
    base::OnceClosure destructor_callback)
    : connections_(connections),
      presence_(presence),
      decoder_(decoder),
      quick_start_decoder_(quick_start_decoder),
      destructor_callback_(std::move(destructor_callback)) {}

NearbyProcessManagerImpl::NearbyReferenceImpl::~NearbyReferenceImpl() {
  // Reset the SharedRemotes before the destructor callback is run to ensure
  // that all connections to the utility process are destroyed before we attempt
  // to tear the process down.
  connections_.reset();
  presence_.reset();
  decoder_.reset();

  std::move(destructor_callback_).Run();
}

const mojo::SharedRemote<::nearby::connections::mojom::NearbyConnections>&
NearbyProcessManagerImpl::NearbyReferenceImpl::GetNearbyConnections() const {
  return connections_;
}

const mojo::SharedRemote<::ash::nearby::presence::mojom::NearbyPresence>&
NearbyProcessManagerImpl::NearbyReferenceImpl::GetNearbyPresence() const {
  return presence_;
}

const mojo::SharedRemote<sharing::mojom::NearbySharingDecoder>&
NearbyProcessManagerImpl::NearbyReferenceImpl::GetNearbySharingDecoder() const {
  return decoder_;
}

const mojo::SharedRemote<quick_start::mojom::QuickStartDecoder>&
NearbyProcessManagerImpl::NearbyReferenceImpl::GetQuickStartDecoder() const {
  return quick_start_decoder_;
}

NearbyProcessManagerImpl::NearbyProcessManagerImpl(
    NearbyDependenciesProvider* nearby_dependencies_provider,
    std::unique_ptr<base::OneShotTimer> timer,
    const base::RepeatingCallback<
        mojo::PendingRemote<sharing::mojom::Sharing>()>& sharing_binder)
    : nearby_dependencies_provider_(nearby_dependencies_provider),
      shutdown_debounce_timer_(std::move(timer)),
      sharing_binder_(sharing_binder) {}

NearbyProcessManagerImpl::~NearbyProcessManagerImpl() = default;

std::unique_ptr<NearbyProcessManager::NearbyProcessReference>
NearbyProcessManagerImpl::GetNearbyProcessReference(
    NearbyProcessStoppedCallback on_process_stopped_callback) {
  if (shut_down_) {
    return nullptr;
  }

  if (!sharing_ || !connections_ || !presence_ || !decoder_) {
    if (!AttemptToBindToUtilityProcess()) {
      CD_LOG(WARNING, Feature::NS)
          << "Could not connect to Nearby utility process; this "
          << "likely means that the attempt was during shutdown.";
      return nullptr;
    }
  }

  CD_LOG(VERBOSE, Feature::NS) << "New Nearby process reference requested.";
  auto reference_id = base::UnguessableToken::Create();
  id_to_process_stopped_callback_map_.emplace(
      reference_id, std::move(on_process_stopped_callback));

  // If we were waiting to shut down the process but a new client was added,
  // stop the timer since the process needs to be kept alive for this new
  // client.
  shutdown_debounce_timer_->Stop();

  return std::make_unique<NearbyReferenceImpl>(
      connections_, presence_, decoder_, quick_start_decoder_,
      base::BindOnce(&NearbyProcessManagerImpl::OnReferenceDeleted,
                     weak_ptr_factory_.GetWeakPtr(), reference_id));
}

void NearbyProcessManagerImpl::ShutDownProcess() {
  DoShutDownProcess(NearbyProcessShutdownReason::kNormal);
}

void NearbyProcessManagerImpl::Shutdown() {
  if (shut_down_) {
    return;
  }

  shut_down_ = true;

  NearbyProcessShutdownReason shutdown_reason =
      NearbyProcessShutdownReason::kNormal;

  DoShutDownProcess(shutdown_reason);
  NotifyProcessStopped(shutdown_reason);
}

bool NearbyProcessManagerImpl::AttemptToBindToUtilityProcess() {
  CHECK(!sharing_ && !connections_ && !presence_ && !decoder_);

  sharing::mojom::NearbyDependenciesPtr deps =
      nearby_dependencies_provider_->GetDependencies();

  if (!deps) {
    return false;
  }

  CD_LOG(INFO, Feature::NS) << "Starting up Nearby utility process.";

  // Bind to the Sharing interface, which launches the process.
  sharing_.Bind(sharing_binder_.Run());
  sharing_.set_disconnect_handler(
      base::BindOnce(&NearbyProcessManagerImpl::OnSharingProcessCrash,
                     weak_ptr_factory_.GetWeakPtr()));

  // Remotes for NearbyConnections and NearbySharingDecoder are bound on the
  // calling sequence by providing a null |bind_task_runner|.
  mojo::PendingRemote<::nearby::connections::mojom::NearbyConnections>
      connections;
  mojo::PendingReceiver<::nearby::connections::mojom::NearbyConnections>
      connections_receiver = connections.InitWithNewPipeAndPassReceiver();
  connections_.Bind(std::move(connections), /*bind_task_runner=*/nullptr);
  connections_.set_disconnect_handler(
      base::BindOnce(
          &NearbyProcessManagerImpl::OnMojoPipeDisconnect,
          weak_ptr_factory_.GetWeakPtr(),
          NearbyProcessShutdownReason::kConnectionsMojoPipeDisconnection),
      base::SequencedTaskRunner::GetCurrentDefault());

  mojo::PendingRemote<::ash::nearby::presence::mojom::NearbyPresence> presence;
  mojo::PendingReceiver<::ash::nearby::presence::mojom::NearbyPresence>
      presence_receiver = presence.InitWithNewPipeAndPassReceiver();
  presence_.Bind(std::move(presence), /*bind_task_runner=*/nullptr);
  presence_.set_disconnect_handler(
      base::BindOnce(
          &NearbyProcessManagerImpl::OnMojoPipeDisconnect,
          weak_ptr_factory_.GetWeakPtr(),
          NearbyProcessShutdownReason::kPresenceMojoPipeDisconnection),
      base::SequencedTaskRunner::GetCurrentDefault());

  mojo::PendingRemote<sharing::mojom::NearbySharingDecoder> decoder;
  mojo::PendingReceiver<sharing::mojom::NearbySharingDecoder> decoder_receiver =
      decoder.InitWithNewPipeAndPassReceiver();
  decoder_.Bind(std::move(decoder), /*bind_task_runner=*/nullptr);
  decoder_.set_disconnect_handler(
      base::BindOnce(
          &NearbyProcessManagerImpl::OnMojoPipeDisconnect,
          weak_ptr_factory_.GetWeakPtr(),
          NearbyProcessShutdownReason::kDecoderMojoPipeDisconnection),
      base::SequencedTaskRunner::GetCurrentDefault());

  mojo::PendingRemote<quick_start::mojom::QuickStartDecoder>
      quick_start_decoder;
  mojo::PendingReceiver<quick_start::mojom::QuickStartDecoder>
      quick_start_decoder_receiver =
          quick_start_decoder.InitWithNewPipeAndPassReceiver();
  quick_start_decoder_.Bind(std::move(quick_start_decoder),
                            /*bind_task_runner=*/nullptr);
  quick_start_decoder_.set_disconnect_handler(
      base::BindOnce(
          &NearbyProcessManagerImpl::OnMojoPipeDisconnect,
          weak_ptr_factory_.GetWeakPtr(),
          NearbyProcessShutdownReason::kDecoderMojoPipeDisconnection),
      base::SequencedTaskRunner::GetCurrentDefault());

  // Pass these references to Connect() to start up the process.
  sharing_->Connect(std::move(deps), std::move(connections_receiver),
                    std::move(presence_receiver), std::move(decoder_receiver),
                    std::move(quick_start_decoder_receiver));

  return true;
}

void NearbyProcessManagerImpl::OnSharingProcessCrash() {
  CD_LOG(ERROR, Feature::NS) << "The utility process has crashed.";

  NearbyProcessShutdownReason shutdown_reason =
      NearbyProcessShutdownReason::kCrash;

  DoShutDownProcess(shutdown_reason);
  NotifyProcessStopped(shutdown_reason);
}

void NearbyProcessManagerImpl::OnMojoPipeDisconnect(
    NearbyProcessShutdownReason shutdown_reason) {
  CD_LOG(ERROR, Feature::NS)
      << "The browser process has detected that the utility process "
         "disconnected from a mojo pipe. ["
      << shutdown_reason << "]";

  DoShutDownProcess(shutdown_reason);
  NotifyProcessStopped(shutdown_reason);
}

void NearbyProcessManagerImpl::OnReferenceDeleted(
    const base::UnguessableToken& reference_id) {
  auto it = id_to_process_stopped_callback_map_.find(reference_id);
  DCHECK(it != id_to_process_stopped_callback_map_.end());

  // Do not call the callback because its owner has already explicitly deleted
  // its reference.
  id_to_process_stopped_callback_map_.erase(it);

  // If there are still active references, the process should be kept alive, so
  // return early.
  if (!id_to_process_stopped_callback_map_.empty()) {
    return;
  }

  CD_LOG(VERBOSE, Feature::NS)
      << "All Nearby references have been released; will shut down "
      << "process in " << kProcessCleanupTimeout << " unless a new "
      << "reference is obtained.";

  // Stop the process, but wait |kProcessCleanupTimeout| before doing so. Adding
  // this additional timeout works around issues during Nearby shutdown
  // (see https://crbug.com/1152609).
  // TODO(https://crbug.com/1152892): Remove this timeout.
  shutdown_debounce_timer_->Start(
      FROM_HERE, kProcessCleanupTimeout,
      base::BindOnce(&NearbyProcessManagerImpl::DoShutDownProcess,
                     weak_ptr_factory_.GetWeakPtr(),
                     NearbyProcessShutdownReason::kNormal));
}

void NearbyProcessManagerImpl::DoShutDownProcess(
    NearbyProcessShutdownReason shutdown_reason) {
  if (!sharing_ && !connections_ && !decoder_) {
    return;
  }

  // Ensure that we don't try to stop the process again.
  shutdown_debounce_timer_->Stop();

  CD_LOG(INFO, Feature::NS) << "Shutting down Nearby utility process.";

  base::UmaHistogramEnumeration(
      "Nearby.Connections.UtilityProcessShutdownReason", shutdown_reason);

  // Prevent the Remotes' disconnect handler callbacks from firing.
  weak_ptr_factory_.InvalidateWeakPtrs();

  if (!sharing_) {
    sharing_.reset();
    connections_.reset();
    presence_.reset();
    decoder_.reset();
    return;
  }

  // Start the asynchronous shutdown flow, and pass ownership of the existing
  // Remote and SharedRemotes to the callback. These instance fields will stay
  // alive until ShutDown() is complete, at which time they will go out of
  // scope and become disconnected in OnSharingShutDownComplete().
  sharing::mojom::Sharing* sharing = sharing_.get();
  sharing->ShutDown(base::BindOnce(&OnSharingShutDownComplete,
                                   std::move(sharing_), std::move(connections_),
                                   std::move(presence_), std::move(decoder_)));
  nearby_dependencies_provider_->PrepareForShutdown();
}

void NearbyProcessManagerImpl::NotifyProcessStopped(
    NearbyProcessShutdownReason shutdown_reason) {
  // We are notifying clients that references are no longer active, so
  // invalidate WeakPtrs so that OnReferenceDeleted() is not invoked when
  // clients respond to the callback by releasing their references.
  weak_ptr_factory_.InvalidateWeakPtrs();

  // Move the map to a local variable to ensure that the instance field is
  // empty before any callbacks are made.
  auto old_map = std::move(id_to_process_stopped_callback_map_);
  id_to_process_stopped_callback_map_.clear();

  // Invoke the "process stopped" callback for each client.
  for (auto& it : old_map) {
    std::move(it.second).Run(shutdown_reason);
  }
}

}  // namespace nearby
}  // namespace ash