File: tracing_service_controller.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (89 lines) | stat: -rw-r--r-- 3,236 bytes parent folder | download | duplicates (5)
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
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_TRACING_TRACING_SERVICE_CONTROLLER_H_
#define CONTENT_BROWSER_TRACING_TRACING_SERVICE_CONTROLLER_H_

#include <map>
#include <memory>

#include "base/functional/callback.h"
#include "base/no_destructor.h"
#include "base/process/process_handle.h"
#include "base/types/pass_key.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "services/tracing/public/mojom/traced_process.mojom.h"
#include "services/tracing/public/mojom/tracing_service.mojom.h"

namespace content {

// Processes participating in tracing must register themselves with the global
// instance of this object.
class TracingServiceController {
 public:
  // An object held for the duration of any client process's registration with
  // the tracing service.
  class ClientRegistration {
   public:
    ClientRegistration(base::PassKey<TracingServiceController>,
                       base::OnceClosure unregister);
    ~ClientRegistration();

   private:
    base::OnceClosure unregister_;
  };

  TracingServiceController(const TracingServiceController&) = delete;
  ~TracingServiceController();
  TracingServiceController& operator=(const TracingServiceController&) = delete;

  // Gets the global instance of this object. Safe to call from any sequence,
  // but see individual methods for other potential constraints.
  static TracingServiceController& Get();

  // A callback each process host must provide to implement how a TracedProcess
  // interface is bound in the corresponding client process. Callbacks are
  // always called from the UI thread.
  using EnableTracingCallback = base::RepeatingCallback<void(
      mojo::PendingReceiver<tracing::mojom::TracedProcess>)>;

  // Registers a new client process with the tracing system. Any time the
  // tracing service is started, |callback| will be invoked to connect the
  // client process to the service.
  //
  // The process will remain registered as long as the returned
  // ClientRegistration object remains alive.
  //
  // Safe to call from any sequence.
  std::unique_ptr<ClientRegistration> RegisterClient(
      base::ProcessId pid,
      EnableTracingCallback callback);

  // Retrieves a remote interface to the tracing service, which is started
  // lazily if needed. Public content API consumers can use
  // |content::GetTracingService()|.
  //
  // Must only be called on the UI thread.
  tracing::mojom::TracingService& GetService();

 private:
  friend class base::NoDestructor<TracingServiceController>;

  TracingServiceController();

  // Handles disconnection by the tracing service.
  void OnTracingServiceDisconnected();
  void RegisterClientOnUIThread(base::ProcessId pid,
                                EnableTracingCallback callback);
  void RemoveClient(base::ProcessId pid);

  // NOTE: This state is accessed only from the UI thread.
  mojo::Remote<tracing::mojom::TracingService> service_;
  std::map<base::ProcessId, EnableTracingCallback> clients_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_TRACING_TRACING_SERVICE_CONTROLLER_H_