File: shared_image_interface_in_process_base.h

package info (click to toggle)
chromium 144.0.7559.109-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,915,868 kB
  • sloc: cpp: 35,866,215; ansic: 7,599,035; javascript: 3,623,761; python: 1,639,407; xml: 833,084; asm: 716,173; pascal: 185,323; sh: 88,763; perl: 88,699; objc: 79,984; sql: 58,217; cs: 42,430; fortran: 24,101; makefile: 20,747; tcl: 15,277; php: 14,022; yacc: 9,059; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,330; ada: 727; jsp: 228; sed: 36
file content (208 lines) | stat: -rw-r--r-- 9,055 bytes parent folder | download | duplicates (4)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef GPU_COMMAND_BUFFER_SERVICE_SHARED_IMAGE_INTERFACE_IN_PROCESS_BASE_H_
#define GPU_COMMAND_BUFFER_SERVICE_SHARED_IMAGE_INTERFACE_IN_PROCESS_BASE_H_

#include "base/sequence_checker.h"
#include "base/synchronization/waitable_event.h"
#include "gpu/command_buffer/client/client_shared_image.h"
#include "gpu/command_buffer/client/shared_image_interface.h"
#include "gpu/command_buffer/common/command_buffer_id.h"
#include "gpu/command_buffer/common/constants.h"
#include "gpu/command_buffer/common/shared_image_capabilities.h"
#include "gpu/gpu_gles2_export.h"

namespace gpu {
class SharedImageFactory;

// Common base implementation for in-process `SharedImageInterface`
// Note: `SharedImageInterface` requires //gpu OWNERS approval for new
// implementations by use of a private constructor; this subclass does not
// enforce the same visibility restrictions on its own subclasses, but does
// mark all non-trivial overrides `final` to ensure subclasses restrict
// themselves to expected extension points; `override`-qualified methods here
// are generally implemented as `NOTREACHED()`.
class GPU_GLES2_EXPORT SharedImageInterfaceInProcessBase
    : public SharedImageInterface {
 public:
  // Generate the next sequence token in the process's sequence
  SyncToken GenNextSyncToken();

  // Include default-args overloads from superclass.
  using SharedImageInterface::CreateSharedImage;

  // SharedImageInterface:
  scoped_refptr<ClientSharedImage> CreateSharedImage(
      const SharedImageInfo& si_info,
      gpu::SurfaceHandle surface_handle,
      std::optional<SharedImagePoolId> pool_id) final;
  scoped_refptr<ClientSharedImage> CreateSharedImage(
      const SharedImageInfo& si_info,
      base::span<const uint8_t> pixel_data) final;
  scoped_refptr<ClientSharedImage> CreateSharedImage(
      const SharedImageInfo& si_info,
      SurfaceHandle surface_handle,
      gfx::BufferUsage buffer_usage,
      std::optional<SharedImagePoolId> pool_id) override;
  scoped_refptr<ClientSharedImage> CreateSharedImage(
      const SharedImageInfo& si_info,
      gpu::SurfaceHandle surface_handle,
      gfx::BufferUsage buffer_usage,
      gfx::GpuMemoryBufferHandle buffer_handle) final;
  scoped_refptr<ClientSharedImage> CreateSharedImage(
      const SharedImageInfo& si_info,
      gfx::GpuMemoryBufferHandle buffer_handle) final;
  scoped_refptr<ClientSharedImage> CreateSharedImageForMLTensor(
      std::string debug_label,
      viz::SharedImageFormat format,
      const gfx::Size& size,
      gpu::SharedImageUsageSet usage) override;
  scoped_refptr<ClientSharedImage> CreateSharedImageForSoftwareCompositor(
      const SharedImageInfo& si_info) final;
  void UpdateSharedImage(const SyncToken& sync_token,
                         const Mailbox& mailbox) final;
  void UpdateSharedImage(const SyncToken& sync_token,
                         std::unique_ptr<gfx::GpuFence> acquire_fence,
                         const Mailbox& mailbox) final;
  void DestroySharedImage(const SyncToken& sync_token,
                          const Mailbox& mailbox) final;
  void DestroySharedImage(
      const SyncToken& sync_token,
      scoped_refptr<ClientSharedImage> client_shared_image) final;
  scoped_refptr<ClientSharedImage> ImportSharedImage(
      ExportedSharedImage exported_shared_image) override;
#if BUILDFLAG(IS_FUCHSIA)
  void RegisterSysmemBufferCollection(zx::eventpair service_handle,
                                      zx::channel sysmem_token,
                                      const viz::SharedImageFormat& format,
                                      gfx::BufferUsage usage,
                                      bool register_with_image_pipe) override;
#endif  // BUILDFLAG(IS_FUCHSIA)
  SyncToken GenUnverifiedSyncToken() final;
  SyncToken GenVerifiedSyncToken() final;
  void VerifySyncToken(SyncToken& sync_token) final;
  bool CanVerifySyncToken(const gpu::SyncToken& sync_token) final;
  void VerifyFlush() final;
  void WaitSyncToken(const SyncToken& sync_token) final;
  const SharedImageCapabilities& GetCapabilities() final;

 protected:
  // `MakeSyncToken()` creates a sync token with `namespace_id` and
  // `command_buffer_id`; `GenCreationSyncToken()` verifies that sync token
  // or not based on `verify_creation_sync_token`. If
  // `shared_image_capabilities` is not provided to the constructor it will be
  // lazily-created on the GPU thread.
  SharedImageInterfaceInProcessBase(
      CommandBufferNamespace namespace_id,
      CommandBufferId command_buffer_id,
      bool verify_creation_sync_token,
      SharedImageCapabilities shared_image_capabilities);
  SharedImageInterfaceInProcessBase(CommandBufferNamespace namespace_id,
                                    CommandBufferId command_buffer_id,
                                    bool verify_creation_sync_token);

  ~SharedImageInterfaceInProcessBase() override;

  // Schedule the `task` on the GPU, waiting on `sync_token_fences` and
  // signalling `release` when done.
  // The GPU expects monotonically increasing release IDs of the `release` sync
  // token, generally accomplished in this class by initializing `release` from
  // `GenNextSyncTokenLocked()` and calling `ScheduleGpuTask()` in the same
  // `lock_`-guarded critical section. Given the critical-section call,
  // subclass implementations of `ScheduleGpuTask()` should perform a small and
  // bounded amount of work.
  virtual void ScheduleGpuTask(base::OnceClosure task,
                               std::vector<SyncToken> sync_token_fences,
                               const SyncToken& release) = 0;

  // Get a reference to a valid `SharedImageFactory`, null if not available.
  // This should only be called on the GPU thread.
  virtual SharedImageFactory* GetSharedImageFactoryOnGpuThread() = 0;

  // Returns `false` if cannot make context current.
  // This should only be called on the GPU thread.
  virtual bool MakeContextCurrentOnGpuThread(bool needs_gl /* = false*/) = 0;

  bool MakeContextCurrentOnGpuThread() {
    return MakeContextCurrentOnGpuThread(false);
  }

  // Mark context lost if shared image cannot be created.
  // This should only be called on the GPU thread.
  virtual void MarkContextLostOnGpuThread() = 0;

  CommandBufferId command_buffer_id() const { return command_buffer_id_; }

  // Sequence checker for tasks that run on the gpu thread.
  SEQUENCE_CHECKER(gpu_sequence_checker_);

 private:
  void CreateSharedImageOnGpuThread(const Mailbox& mailbox,
                                    SharedImageInfo si_info,
                                    gpu::SurfaceHandle surface_handle);

  void CreateSharedImageWithDataOnGpuThread(const Mailbox& mailbox,
                                            SharedImageInfo si_info,
                                            std::vector<uint8_t> pixel_data);

  void CreateSharedImageWithBufferUsageOnGpuThread(
      const Mailbox& mailbox,
      SharedImageInfo si_info,
      SurfaceHandle surface_handle,
      gfx::BufferUsage buffer_usage);

  void GetGpuMemoryBufferHandleInfoOnGpuThread(
      const Mailbox& mailbox,
      gfx::GpuMemoryBufferHandle* handle,
      gfx::BufferUsage* buffer_usage,
      base::WaitableEvent* completion);

  void CreateSharedImageWithBufferOnGpuThread(
      const Mailbox& mailbox,
      SharedImageInfo si_info,
      gfx::GpuMemoryBufferHandle buffer_handle);

  // Blocks and waits for a response from the GPU main thread
  GpuMemoryBufferHandleInfo GetGpuMemoryBufferHandleInfo(
      const Mailbox& mailbox);

  void UpdateSharedImageOnGpuThread(const Mailbox& mailbox);

  void DestroySharedImageOnGpuThread(const Mailbox& mailbox);

  void GetCapabilitiesOnGpuThread();

  SyncToken MakeSyncToken(uint64_t release_id) {
    return {namespace_id_, command_buffer_id_, release_id};
  }

  // Internal version of `GenNextSyncToken()` for when `lock_` is already held
  SyncToken GenNextSyncTokenLocked() EXCLUSIVE_LOCKS_REQUIRED(lock_);

  // Generate a sync token for `CreateSharedImage()`, with verification
  // dependent on `verify_creation_sync_token_`
  SyncToken GenCreationSyncToken() {
    return verify_creation_sync_token_ ? GenVerifiedSyncToken()
                                       : GenUnverifiedSyncToken();
  }

  // Accessed on any thread.
  base::Lock lock_;
  uint64_t next_fence_sync_release_ GUARDED_BY(lock_) = 1;

  const CommandBufferNamespace namespace_id_;
  const CommandBufferId command_buffer_id_;
  const bool verify_creation_sync_token_;

  // This should only be non-default initialized at construction or from the GPU
  // thread. `shared_image_capabilities_ready_.IsSignalled()` indicates that it
  // is safe to read from.
  SharedImageCapabilities shared_image_capabilities_;
  base::WaitableEvent shared_image_capabilities_ready_;
};

}  // namespace gpu

#endif  // GPU_COMMAND_BUFFER_SERVICE_SHARED_IMAGE_INTERFACE_IN_PROCESS_BASE_H_