Corentin Wallez | 4a9ef4e | 2018-07-18 11:40:26 +0200 | [diff] [blame] | 1 | // Copyright 2017 The Dawn Authors |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
Corentin Wallez | ac67fec | 2019-01-04 10:30:40 +0000 | [diff] [blame] | 15 | #ifndef DAWNNATIVE_DEVICE_H_ |
| 16 | #define DAWNNATIVE_DEVICE_H_ |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 17 | |
Tomek Ponitka | d720785 | 2020-08-20 13:29:39 +0000 | [diff] [blame] | 18 | #include "dawn_native/Commands.h" |
Jiawei Shao | e0390b8 | 2021-10-13 04:19:26 +0000 | [diff] [blame] | 19 | #include "dawn_native/ComputePipeline.h" |
Corentin Wallez | d37523f | 2018-07-24 13:53:51 +0200 | [diff] [blame] | 20 | #include "dawn_native/Error.h" |
François Beaufort | 3f689a4 | 2021-10-04 11:30:02 +0000 | [diff] [blame] | 21 | #include "dawn_native/Features.h" |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 22 | #include "dawn_native/Format.h" |
Corentin Wallez | d37523f | 2018-07-24 13:53:51 +0200 | [diff] [blame] | 23 | #include "dawn_native/Forward.h" |
Austin Eng | 02fbf16 | 2021-09-13 18:49:09 +0000 | [diff] [blame] | 24 | #include "dawn_native/Limits.h" |
Corentin Wallez | 9e4518b | 2018-10-15 12:54:30 +0000 | [diff] [blame] | 25 | #include "dawn_native/ObjectBase.h" |
Loko Kung | 8d195d5 | 2021-09-28 15:40:01 +0000 | [diff] [blame] | 26 | #include "dawn_native/ObjectType_autogen.h" |
| 27 | #include "dawn_native/StagingBuffer.h" |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 28 | #include "dawn_native/Toggles.h" |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 29 | |
Jiawei Shao | 58809d4 | 2018-09-19 00:32:52 +0000 | [diff] [blame] | 30 | #include "dawn_native/DawnNative.h" |
Corentin Wallez | 36afbb6 | 2018-07-25 17:03:23 +0200 | [diff] [blame] | 31 | #include "dawn_native/dawn_platform.h" |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 32 | |
Loko Kung | 8d195d5 | 2021-09-28 15:40:01 +0000 | [diff] [blame] | 33 | #include <mutex> |
Jiawei Shao | c243f67 | 2021-04-08 01:22:22 +0000 | [diff] [blame] | 34 | #include <utility> |
Corentin Wallez | cca9c69 | 2018-09-06 15:26:48 +0200 | [diff] [blame] | 35 | |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 36 | namespace dawn_platform { |
| 37 | class WorkerTaskPool; |
| 38 | } // namespace dawn_platform |
| 39 | |
Corentin Wallez | 49a65d0 | 2018-07-24 16:45:45 +0200 | [diff] [blame] | 40 | namespace dawn_native { |
Corentin Wallez | ec18f96 | 2019-01-10 10:50:54 +0000 | [diff] [blame] | 41 | class AdapterBase; |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 42 | class AsyncTaskManager; |
Austin Eng | b98f0fa | 2019-07-26 19:08:18 +0000 | [diff] [blame] | 43 | class AttachmentState; |
Austin Eng | 8a488c1 | 2019-08-13 22:12:54 +0000 | [diff] [blame] | 44 | class AttachmentStateBlueprint; |
Austin Eng | a80993d | 2020-03-20 21:56:30 +0000 | [diff] [blame] | 45 | class BindGroupLayoutBase; |
Jiawei Shao | c74af703 | 2021-05-02 03:22:30 +0000 | [diff] [blame] | 46 | class CallbackTaskManager; |
Austin Eng | a80993d | 2020-03-20 21:56:30 +0000 | [diff] [blame] | 47 | class DynamicUploader; |
Austin Eng | ef9e441 | 2021-02-19 18:17:22 +0000 | [diff] [blame] | 48 | class ErrorScopeStack; |
Brandon Jones | 0e92e9b | 2021-04-01 20:46:42 +0000 | [diff] [blame] | 49 | class ExternalTextureBase; |
Brandon Jones | 47b6b68 | 2021-04-08 04:25:11 +0000 | [diff] [blame] | 50 | class OwnedCompilationMessages; |
Bryan Bernhart | 41b3f9c | 2020-11-20 20:38:37 +0000 | [diff] [blame] | 51 | class PersistentCache; |
Bryan Bernhart | 74e95ff | 2019-01-29 00:10:07 +0000 | [diff] [blame] | 52 | class StagingBufferBase; |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 53 | struct CallbackTask; |
Yan, Shaobo | db8766b | 2020-11-04 02:30:16 +0000 | [diff] [blame] | 54 | struct InternalPipelineStore; |
Austin Eng | 0d948f7 | 2020-12-07 18:12:13 +0000 | [diff] [blame] | 55 | struct ShaderModuleParseResult; |
Austin Eng | f0b761f | 2018-12-03 16:57:34 +0000 | [diff] [blame] | 56 | |
Corentin Wallez | 1257152 | 2021-03-25 23:50:24 +0000 | [diff] [blame] | 57 | class DeviceBase : public RefCounted { |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 58 | public: |
Austin Eng | 3482a80 | 2021-11-23 18:03:16 +0000 | [diff] [blame] | 59 | DeviceBase(AdapterBase* adapter, const DawnDeviceDescriptor* descriptor); |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 60 | virtual ~DeviceBase(); |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 61 | |
Corentin Wallez | a0afd31 | 2020-04-01 12:07:43 +0000 | [diff] [blame] | 62 | void HandleError(InternalErrorType type, const char* message); |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 63 | |
Corentin Wallez | 52f2383 | 2018-07-16 17:40:08 +0200 | [diff] [blame] | 64 | bool ConsumedError(MaybeError maybeError) { |
Corentin Wallez | 83a9c9d | 2018-07-18 13:37:54 +0200 | [diff] [blame] | 65 | if (DAWN_UNLIKELY(maybeError.IsError())) { |
Austin Eng | b11bd2d | 2019-09-18 21:03:41 +0000 | [diff] [blame] | 66 | ConsumeError(maybeError.AcquireError()); |
Corentin Wallez | 52f2383 | 2018-07-16 17:40:08 +0200 | [diff] [blame] | 67 | return true; |
| 68 | } |
| 69 | return false; |
| 70 | } |
| 71 | |
Corentin Wallez | e09869e | 2019-10-09 10:11:00 +0000 | [diff] [blame] | 72 | template <typename T> |
| 73 | bool ConsumedError(ResultOrError<T> resultOrError, T* result) { |
| 74 | if (DAWN_UNLIKELY(resultOrError.IsError())) { |
| 75 | ConsumeError(resultOrError.AcquireError()); |
| 76 | return true; |
| 77 | } |
| 78 | *result = resultOrError.AcquireSuccess(); |
| 79 | return false; |
| 80 | } |
| 81 | |
Corentin Wallez | 2bf5156 | 2021-10-01 18:15:40 +0000 | [diff] [blame] | 82 | template <typename... Args> |
| 83 | bool ConsumedError(MaybeError maybeError, const char* formatStr, const Args&... args) { |
| 84 | if (DAWN_UNLIKELY(maybeError.IsError())) { |
| 85 | std::unique_ptr<ErrorData> error = maybeError.AcquireError(); |
| 86 | if (error->GetType() == InternalErrorType::Validation) { |
| 87 | std::string out; |
| 88 | absl::UntypedFormatSpec format(formatStr); |
| 89 | if (absl::FormatUntyped(&out, format, {absl::FormatArg(args)...})) { |
| 90 | error->AppendContext(std::move(out)); |
Brandon Jones | 2514566 | 2021-11-03 01:31:19 +0000 | [diff] [blame] | 91 | } else { |
| 92 | error->AppendContext( |
| 93 | absl::StrFormat("[Failed to format error: \"%s\"]", formatStr)); |
Corentin Wallez | 2bf5156 | 2021-10-01 18:15:40 +0000 | [diff] [blame] | 94 | } |
| 95 | } |
| 96 | ConsumeError(std::move(error)); |
| 97 | return true; |
| 98 | } |
| 99 | return false; |
| 100 | } |
| 101 | |
Brandon Jones | 9b643b7 | 2021-09-29 18:39:23 +0000 | [diff] [blame] | 102 | template <typename T, typename... Args> |
| 103 | bool ConsumedError(ResultOrError<T> resultOrError, |
| 104 | T* result, |
| 105 | const char* formatStr, |
| 106 | const Args&... args) { |
| 107 | if (DAWN_UNLIKELY(resultOrError.IsError())) { |
| 108 | std::unique_ptr<ErrorData> error = resultOrError.AcquireError(); |
| 109 | if (error->GetType() == InternalErrorType::Validation) { |
| 110 | std::string out; |
| 111 | absl::UntypedFormatSpec format(formatStr); |
| 112 | if (absl::FormatUntyped(&out, format, {absl::FormatArg(args)...})) { |
| 113 | error->AppendContext(std::move(out)); |
Brandon Jones | 2514566 | 2021-11-03 01:31:19 +0000 | [diff] [blame] | 114 | } else { |
| 115 | error->AppendContext( |
| 116 | absl::StrFormat("[Failed to format error: \"%s\"]", formatStr)); |
Brandon Jones | 9b643b7 | 2021-09-29 18:39:23 +0000 | [diff] [blame] | 117 | } |
| 118 | } |
| 119 | ConsumeError(std::move(error)); |
| 120 | return true; |
| 121 | } |
| 122 | *result = resultOrError.AcquireSuccess(); |
| 123 | return false; |
| 124 | } |
| 125 | |
Loko Kung | 8d195d5 | 2021-09-28 15:40:01 +0000 | [diff] [blame] | 126 | MaybeError ValidateObject(const ApiObjectBase* object) const; |
Corentin Wallez | a594f8f | 2019-02-13 13:09:18 +0000 | [diff] [blame] | 127 | |
Corentin Wallez | d77fd5f | 2019-01-30 16:07:48 +0000 | [diff] [blame] | 128 | AdapterBase* GetAdapter() const; |
Austin Eng | d4ce736 | 2019-08-13 19:00:34 +0000 | [diff] [blame] | 129 | dawn_platform::Platform* GetPlatform() const; |
Corentin Wallez | d77fd5f | 2019-01-30 16:07:48 +0000 | [diff] [blame] | 130 | |
Corentin Wallez | 1f6c8c4 | 2019-10-23 11:57:41 +0000 | [diff] [blame] | 131 | // Returns the Format corresponding to the wgpu::TextureFormat or an error if the format |
| 132 | // isn't a valid wgpu::TextureFormat or isn't supported by this device. |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 133 | // The pointer returned has the same lifetime as the device. |
Corentin Wallez | 1f6c8c4 | 2019-10-23 11:57:41 +0000 | [diff] [blame] | 134 | ResultOrError<const Format*> GetInternalFormat(wgpu::TextureFormat format) const; |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 135 | |
Corentin Wallez | 1f6c8c4 | 2019-10-23 11:57:41 +0000 | [diff] [blame] | 136 | // Returns the Format corresponding to the wgpu::TextureFormat and assumes the format is |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 137 | // valid and supported. |
| 138 | // The reference returned has the same lifetime as the device. |
Corentin Wallez | 1f6c8c4 | 2019-10-23 11:57:41 +0000 | [diff] [blame] | 139 | const Format& GetValidInternalFormat(wgpu::TextureFormat format) const; |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 140 | |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 141 | virtual ResultOrError<Ref<CommandBufferBase>> CreateCommandBuffer( |
Corentin Wallez | 321c122 | 2019-11-13 17:00:37 +0000 | [diff] [blame] | 142 | CommandEncoder* encoder, |
Corentin Wallez | 4b90c47 | 2019-07-10 20:43:13 +0000 | [diff] [blame] | 143 | const CommandBufferDescriptor* descriptor) = 0; |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 144 | |
Corentin Wallez | 62139fc | 2020-09-28 19:35:14 +0000 | [diff] [blame] | 145 | ExecutionSerial GetCompletedCommandSerial() const; |
| 146 | ExecutionSerial GetLastSubmittedCommandSerial() const; |
Brandon Jones | 4ad3586 | 2020-10-15 16:21:03 +0000 | [diff] [blame] | 147 | ExecutionSerial GetFutureSerial() const; |
Corentin Wallez | 62139fc | 2020-09-28 19:35:14 +0000 | [diff] [blame] | 148 | ExecutionSerial GetPendingCommandSerial() const; |
Corentin Wallez | dbb5729 | 2017-06-14 13:33:45 -0400 | [diff] [blame] | 149 | |
Corentin Wallez | 9fc6534 | 2018-07-18 15:28:38 +0200 | [diff] [blame] | 150 | // Many Dawn objects are completely immutable once created which means that if two |
Corentin Wallez | 4f5fc2d | 2019-04-01 21:48:38 +0000 | [diff] [blame] | 151 | // creations are given the same arguments, they can return the same object. Reusing |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 152 | // objects will help make comparisons between objects by a single pointer comparison. |
| 153 | // |
| 154 | // Technically no object is immutable as they have a reference count, and an |
| 155 | // application with reference-counting issues could "see" that objects are reused. |
| 156 | // This is solved by automatic-reference counting, and also the fact that when using |
| 157 | // the client-server wire every creation will get a different proxy object, with a |
| 158 | // different reference count. |
| 159 | // |
Corentin Wallez | 4f5fc2d | 2019-04-01 21:48:38 +0000 | [diff] [blame] | 160 | // When trying to create an object, we give both the descriptor and an example of what |
| 161 | // the created object will be, the "blueprint". The blueprint is just a FooBase object |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 162 | // instead of a backend Foo object. If the blueprint doesn't match an object in the |
Corentin Wallez | 4f5fc2d | 2019-04-01 21:48:38 +0000 | [diff] [blame] | 163 | // cache, then the descriptor is used to make a new object. |
Tomek Ponitka | 5fb974c | 2020-07-01 13:09:46 +0000 | [diff] [blame] | 164 | ResultOrError<Ref<BindGroupLayoutBase>> GetOrCreateBindGroupLayout( |
Brandon Jones | 1f48c97 | 2021-09-01 22:15:41 +0000 | [diff] [blame] | 165 | const BindGroupLayoutDescriptor* descriptor, |
| 166 | PipelineCompatibilityToken pipelineCompatibilityToken = PipelineCompatibilityToken(0)); |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 167 | void UncacheBindGroupLayout(BindGroupLayoutBase* obj); |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 168 | |
Tomek Ponitka | 5fb974c | 2020-07-01 13:09:46 +0000 | [diff] [blame] | 169 | BindGroupLayoutBase* GetEmptyBindGroupLayout(); |
Tomek Ponitka | bf27bd7 | 2020-06-29 11:13:43 +0000 | [diff] [blame] | 170 | |
Corentin Wallez | 1152bba | 2019-05-01 13:48:47 +0000 | [diff] [blame] | 171 | void UncacheComputePipeline(ComputePipelineBase* obj); |
| 172 | |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 173 | ResultOrError<Ref<PipelineLayoutBase>> GetOrCreatePipelineLayout( |
Corentin Wallez | 0ee9859 | 2019-05-01 12:57:27 +0000 | [diff] [blame] | 174 | const PipelineLayoutDescriptor* descriptor); |
| 175 | void UncachePipelineLayout(PipelineLayoutBase* obj); |
| 176 | |
Corentin Wallez | 94274b6 | 2019-05-02 15:30:56 +0000 | [diff] [blame] | 177 | void UncacheRenderPipeline(RenderPipelineBase* obj); |
| 178 | |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 179 | ResultOrError<Ref<SamplerBase>> GetOrCreateSampler(const SamplerDescriptor* descriptor); |
Idan Raiter | 2bc3169 | 2019-05-20 18:16:34 +0000 | [diff] [blame] | 180 | void UncacheSampler(SamplerBase* obj); |
| 181 | |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 182 | ResultOrError<Ref<ShaderModuleBase>> GetOrCreateShaderModule( |
Austin Eng | 0d948f7 | 2020-12-07 18:12:13 +0000 | [diff] [blame] | 183 | const ShaderModuleDescriptor* descriptor, |
Zhaoming Jiang | fdc35e6 | 2021-06-18 13:29:39 +0000 | [diff] [blame] | 184 | ShaderModuleParseResult* parseResult, |
| 185 | OwnedCompilationMessages* compilationMessages); |
Corentin Wallez | c535198 | 2019-05-01 13:27:07 +0000 | [diff] [blame] | 186 | void UncacheShaderModule(ShaderModuleBase* obj); |
| 187 | |
Austin Eng | 8a488c1 | 2019-08-13 22:12:54 +0000 | [diff] [blame] | 188 | Ref<AttachmentState> GetOrCreateAttachmentState(AttachmentStateBlueprint* blueprint); |
| 189 | Ref<AttachmentState> GetOrCreateAttachmentState( |
| 190 | const RenderBundleEncoderDescriptor* descriptor); |
Austin Eng | bb10a91 | 2019-08-07 21:47:24 +0000 | [diff] [blame] | 191 | Ref<AttachmentState> GetOrCreateAttachmentState(const RenderPipelineDescriptor* descriptor); |
| 192 | Ref<AttachmentState> GetOrCreateAttachmentState(const RenderPassDescriptor* descriptor); |
Austin Eng | b98f0fa | 2019-07-26 19:08:18 +0000 | [diff] [blame] | 193 | void UncacheAttachmentState(AttachmentState* obj); |
| 194 | |
Corentin Wallez | 0af4a83 | 2021-04-19 08:52:35 +0000 | [diff] [blame] | 195 | // Object creation methods that be used in a reentrant manner. |
| 196 | ResultOrError<Ref<BindGroupBase>> CreateBindGroup(const BindGroupDescriptor* descriptor); |
| 197 | ResultOrError<Ref<BindGroupLayoutBase>> CreateBindGroupLayout( |
Li Hao | 551e7a1 | 2021-07-02 09:51:18 +0000 | [diff] [blame] | 198 | const BindGroupLayoutDescriptor* descriptor, |
| 199 | bool allowInternalBinding = false); |
Corentin Wallez | 0af4a83 | 2021-04-19 08:52:35 +0000 | [diff] [blame] | 200 | ResultOrError<Ref<BufferBase>> CreateBuffer(const BufferDescriptor* descriptor); |
| 201 | ResultOrError<Ref<ComputePipelineBase>> CreateComputePipeline( |
| 202 | const ComputePipelineDescriptor* descriptor); |
| 203 | MaybeError CreateComputePipelineAsync( |
| 204 | const ComputePipelineDescriptor* descriptor, |
| 205 | WGPUCreateComputePipelineAsyncCallback callback, |
| 206 | void* userdata); |
| 207 | ResultOrError<Ref<ExternalTextureBase>> CreateExternalTexture( |
| 208 | const ExternalTextureDescriptor* descriptor); |
| 209 | ResultOrError<Ref<PipelineLayoutBase>> CreatePipelineLayout( |
| 210 | const PipelineLayoutDescriptor* descriptor); |
| 211 | ResultOrError<Ref<QuerySetBase>> CreateQuerySet(const QuerySetDescriptor* descriptor); |
| 212 | ResultOrError<Ref<RenderBundleEncoder>> CreateRenderBundleEncoder( |
| 213 | const RenderBundleEncoderDescriptor* descriptor); |
| 214 | ResultOrError<Ref<RenderPipelineBase>> CreateRenderPipeline( |
Brandon Jones | 41c87d9 | 2021-05-21 05:01:38 +0000 | [diff] [blame] | 215 | const RenderPipelineDescriptor* descriptor); |
Jiawei Shao | 2aee6ee | 2021-08-26 00:39:14 +0000 | [diff] [blame] | 216 | MaybeError CreateRenderPipelineAsync(const RenderPipelineDescriptor* descriptor, |
| 217 | WGPUCreateRenderPipelineAsyncCallback callback, |
| 218 | void* userdata); |
Corentin Wallez | 0af4a83 | 2021-04-19 08:52:35 +0000 | [diff] [blame] | 219 | ResultOrError<Ref<SamplerBase>> CreateSampler(const SamplerDescriptor* descriptor); |
| 220 | ResultOrError<Ref<ShaderModuleBase>> CreateShaderModule( |
| 221 | const ShaderModuleDescriptor* descriptor, |
Zhaoming Jiang | fdc35e6 | 2021-06-18 13:29:39 +0000 | [diff] [blame] | 222 | OwnedCompilationMessages* compilationMessages = nullptr); |
Corentin Wallez | 0af4a83 | 2021-04-19 08:52:35 +0000 | [diff] [blame] | 223 | ResultOrError<Ref<SwapChainBase>> CreateSwapChain(Surface* surface, |
| 224 | const SwapChainDescriptor* descriptor); |
| 225 | ResultOrError<Ref<TextureBase>> CreateTexture(const TextureDescriptor* descriptor); |
| 226 | ResultOrError<Ref<TextureViewBase>> CreateTextureView( |
| 227 | TextureBase* texture, |
| 228 | const TextureViewDescriptor* descriptor); |
| 229 | |
| 230 | // Implementation of API object creation methods. DO NOT use them in a reentrant manner. |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 231 | BindGroupBase* APICreateBindGroup(const BindGroupDescriptor* descriptor); |
| 232 | BindGroupLayoutBase* APICreateBindGroupLayout(const BindGroupLayoutDescriptor* descriptor); |
| 233 | BufferBase* APICreateBuffer(const BufferDescriptor* descriptor); |
| 234 | CommandEncoder* APICreateCommandEncoder(const CommandEncoderDescriptor* descriptor); |
| 235 | ComputePipelineBase* APICreateComputePipeline(const ComputePipelineDescriptor* descriptor); |
| 236 | PipelineLayoutBase* APICreatePipelineLayout(const PipelineLayoutDescriptor* descriptor); |
| 237 | QuerySetBase* APICreateQuerySet(const QuerySetDescriptor* descriptor); |
| 238 | void APICreateComputePipelineAsync(const ComputePipelineDescriptor* descriptor, |
| 239 | WGPUCreateComputePipelineAsyncCallback callback, |
| 240 | void* userdata); |
Brandon Jones | 41c87d9 | 2021-05-21 05:01:38 +0000 | [diff] [blame] | 241 | void APICreateRenderPipelineAsync(const RenderPipelineDescriptor* descriptor, |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 242 | WGPUCreateRenderPipelineAsyncCallback callback, |
| 243 | void* userdata); |
| 244 | RenderBundleEncoder* APICreateRenderBundleEncoder( |
Austin Eng | 8a488c1 | 2019-08-13 22:12:54 +0000 | [diff] [blame] | 245 | const RenderBundleEncoderDescriptor* descriptor); |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 246 | RenderPipelineBase* APICreateRenderPipeline(const RenderPipelineDescriptor* descriptor); |
Brandon Jones | 0e92e9b | 2021-04-01 20:46:42 +0000 | [diff] [blame] | 247 | ExternalTextureBase* APICreateExternalTexture(const ExternalTextureDescriptor* descriptor); |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 248 | SamplerBase* APICreateSampler(const SamplerDescriptor* descriptor); |
| 249 | ShaderModuleBase* APICreateShaderModule(const ShaderModuleDescriptor* descriptor); |
| 250 | SwapChainBase* APICreateSwapChain(Surface* surface, const SwapChainDescriptor* descriptor); |
| 251 | TextureBase* APICreateTexture(const TextureDescriptor* descriptor); |
Corentin Wallez | 0af4a83 | 2021-04-19 08:52:35 +0000 | [diff] [blame] | 252 | |
Yan, Shaobo | db8766b | 2020-11-04 02:30:16 +0000 | [diff] [blame] | 253 | InternalPipelineStore* GetInternalPipelineStore(); |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 254 | |
Austin Eng | cf1fdf4 | 2020-06-15 23:42:13 +0000 | [diff] [blame] | 255 | // For Dawn Wire |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 256 | BufferBase* APICreateErrorBuffer(); |
Austin Eng | cf1fdf4 | 2020-06-15 23:42:13 +0000 | [diff] [blame] | 257 | |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 258 | QueueBase* APIGetQueue(); |
Corentin Wallez | 8a43794 | 2020-04-17 16:45:17 +0000 | [diff] [blame] | 259 | |
Austin Eng | bffc966 | 2021-09-17 15:36:00 +0000 | [diff] [blame] | 260 | bool APIGetLimits(SupportedLimits* limits); |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 261 | void APIInjectError(wgpu::ErrorType type, const char* message); |
| 262 | bool APITick(); |
Austin Eng | 8b07e43 | 2018-12-01 03:20:19 +0000 | [diff] [blame] | 263 | |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 264 | void APISetDeviceLostCallback(wgpu::DeviceLostCallback callback, void* userdata); |
| 265 | void APISetUncapturedErrorCallback(wgpu::ErrorCallback callback, void* userdata); |
Zhaoming Jiang | b44000e | 2021-06-04 07:10:56 +0000 | [diff] [blame] | 266 | void APISetLoggingCallback(wgpu::LoggingCallback callback, void* userdata); |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 267 | void APIPushErrorScope(wgpu::ErrorFilter filter); |
| 268 | bool APIPopErrorScope(wgpu::ErrorCallback callback, void* userdata); |
Natasha Lee | 0ecc48e | 2020-01-15 19:02:13 +0000 | [diff] [blame] | 269 | |
| 270 | MaybeError ValidateIsAlive() const; |
| 271 | |
Bryan Bernhart | 41b3f9c | 2020-11-20 20:38:37 +0000 | [diff] [blame] | 272 | PersistentCache* GetPersistentCache(); |
| 273 | |
Bryan Bernhart | 74e95ff | 2019-01-29 00:10:07 +0000 | [diff] [blame] | 274 | virtual ResultOrError<std::unique_ptr<StagingBufferBase>> CreateStagingBuffer( |
| 275 | size_t size) = 0; |
| 276 | virtual MaybeError CopyFromStagingToBuffer(StagingBufferBase* source, |
Austin Eng | cf52d71 | 2019-04-05 20:51:29 +0000 | [diff] [blame] | 277 | uint64_t sourceOffset, |
Bryan Bernhart | 74e95ff | 2019-01-29 00:10:07 +0000 | [diff] [blame] | 278 | BufferBase* destination, |
Austin Eng | cf52d71 | 2019-04-05 20:51:29 +0000 | [diff] [blame] | 279 | uint64_t destinationOffset, |
| 280 | uint64_t size) = 0; |
Tomek Ponitka | d720785 | 2020-08-20 13:29:39 +0000 | [diff] [blame] | 281 | virtual MaybeError CopyFromStagingToTexture(const StagingBufferBase* source, |
| 282 | const TextureDataLayout& src, |
| 283 | TextureCopy* dst, |
| 284 | const Extent3D& copySizePixels) = 0; |
Bryan Bernhart | 74e95ff | 2019-01-29 00:10:07 +0000 | [diff] [blame] | 285 | |
Bryan Bernhart | 450e212 | 2019-09-18 22:06:41 +0000 | [diff] [blame] | 286 | DynamicUploader* GetDynamicUploader() const; |
Bryan Bernhart | 67a73bd | 2019-02-15 21:18:40 +0000 | [diff] [blame] | 287 | |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 288 | // The device state which is a combination of creation state and loss state. |
| 289 | // |
| 290 | // - BeingCreated: the device didn't finish creation yet and the frontend cannot be used |
| 291 | // (both for the application calling WebGPU, or re-entrant calls). No work exists on |
| 292 | // the GPU timeline. |
| 293 | // - Alive: the device is usable and might have work happening on the GPU timeline. |
| 294 | // - BeingDisconnected: the device is no longer usable because we are waiting for all |
| 295 | // work on the GPU timeline to finish. (this is to make validation prevent the |
| 296 | // application from adding more work during the transition from Available to |
| 297 | // Disconnected) |
| 298 | // - Disconnected: there is no longer work happening on the GPU timeline and the CPU data |
| 299 | // structures can be safely destroyed without additional synchronization. |
Loko Kung | 2494c9b | 2021-12-01 17:55:30 +0000 | [diff] [blame] | 300 | // - Destroyed: the device is disconnected and resources have been reclaimed. |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 301 | enum class State { |
| 302 | BeingCreated, |
| 303 | Alive, |
| 304 | BeingDisconnected, |
| 305 | Disconnected, |
Loko Kung | 2494c9b | 2021-12-01 17:55:30 +0000 | [diff] [blame] | 306 | Destroyed, |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 307 | }; |
| 308 | State GetState() const; |
| 309 | bool IsLost() const; |
Loko Kung | fc5a7d4 | 2021-10-12 17:46:26 +0000 | [diff] [blame] | 310 | void TrackObject(ApiObjectBase* object); |
Loko Kung | 8d195d5 | 2021-09-28 15:40:01 +0000 | [diff] [blame] | 311 | std::mutex* GetObjectListMutex(ObjectType type); |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 312 | |
François Beaufort | 3f689a4 | 2021-10-04 11:30:02 +0000 | [diff] [blame] | 313 | std::vector<const char*> GetEnabledFeatures() const; |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 314 | std::vector<const char*> GetTogglesUsed() const; |
François Beaufort | 3f689a4 | 2021-10-04 11:30:02 +0000 | [diff] [blame] | 315 | bool IsFeatureEnabled(Feature feature) const; |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 316 | bool IsToggleEnabled(Toggle toggle) const; |
Austin Eng | 4d15609 | 2019-11-21 00:48:39 +0000 | [diff] [blame] | 317 | bool IsValidationEnabled() const; |
Idan Raiter | bcc65f2 | 2020-07-01 21:37:57 +0000 | [diff] [blame] | 318 | bool IsRobustnessEnabled() const; |
Natasha Lee | e69627f | 2019-07-26 17:54:48 +0000 | [diff] [blame] | 319 | size_t GetLazyClearCountForTesting(); |
| 320 | void IncrementLazyClearCountForTesting(); |
Corentin Wallez | 8a43794 | 2020-04-17 16:45:17 +0000 | [diff] [blame] | 321 | size_t GetDeprecationWarningCountForTesting(); |
| 322 | void EmitDeprecationWarning(const char* warning); |
Zhaoming Jiang | b44000e | 2021-06-04 07:10:56 +0000 | [diff] [blame] | 323 | void EmitLog(const char* message); |
| 324 | void EmitLog(WGPULoggingType loggingType, const char* message); |
Corentin Wallez | 2ce4b90 | 2021-03-29 14:02:05 +0000 | [diff] [blame] | 325 | void APILoseForTesting(); |
Corentin Wallez | e91975c | 2021-03-29 15:40:55 +0000 | [diff] [blame] | 326 | QueueBase* GetQueue() const; |
Brandon Jones | 4ad3586 | 2020-10-15 16:21:03 +0000 | [diff] [blame] | 327 | |
| 328 | // AddFutureSerial is used to update the mFutureSerial with the max serial needed to be |
| 329 | // ticked in order to clean up all pending callback work or to execute asynchronous resource |
| 330 | // writes. It should be given the serial that a callback is tracked with, so that once that |
| 331 | // serial is completed, it can be resolved and cleaned up. This is so that when there is no |
| 332 | // gpu work (the last submitted serial has not moved beyond the completed serial), Tick can |
| 333 | // still check if we have pending work to take care of, rather than hanging and never |
| 334 | // reaching the serial the work will be executed on. |
| 335 | void AddFutureSerial(ExecutionSerial serial); |
Brandon Jones | b6f4d53 | 2020-11-13 02:11:12 +0000 | [diff] [blame] | 336 | // Check for passed fences and set the new completed serial |
Corentin Wallez | 6870e6d | 2021-04-07 18:09:21 +0000 | [diff] [blame] | 337 | MaybeError CheckPassedSerials(); |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 338 | |
Corentin Wallez | 1bc1ed4 | 2021-03-30 10:21:36 +0000 | [diff] [blame] | 339 | MaybeError Tick(); |
| 340 | |
Jiawei Shao | 829d165 | 2021-11-17 05:00:44 +0000 | [diff] [blame] | 341 | // TODO(crbug.com/dawn/839): Organize the below backend-specific parameters into the struct |
| 342 | // BackendMetadata that we can query from the device. |
Tomek Ponitka | d720785 | 2020-08-20 13:29:39 +0000 | [diff] [blame] | 343 | virtual uint32_t GetOptimalBytesPerRowAlignment() const = 0; |
| 344 | virtual uint64_t GetOptimalBufferToTextureCopyOffsetAlignment() const = 0; |
| 345 | |
Hao Li | cdbd295 | 2021-01-05 02:39:18 +0000 | [diff] [blame] | 346 | virtual float GetTimestampPeriodInNS() const = 0; |
| 347 | |
Jiawei Shao | 829d165 | 2021-11-17 05:00:44 +0000 | [diff] [blame] | 348 | virtual bool ShouldDuplicateNumWorkgroupsForDispatchIndirect( |
| 349 | ComputePipelineBase* computePipeline) const; |
| 350 | |
Austin Eng | 91851e2 | 2021-10-13 18:57:18 +0000 | [diff] [blame] | 351 | const CombinedLimits& GetLimits() const; |
| 352 | |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 353 | AsyncTaskManager* GetAsyncTaskManager() const; |
| 354 | CallbackTaskManager* GetCallbackTaskManager() const; |
| 355 | dawn_platform::WorkerTaskPool* GetWorkerTaskPool() const; |
| 356 | |
| 357 | void AddComputePipelineAsyncCallbackTask(Ref<ComputePipelineBase> pipeline, |
| 358 | std::string errorMessage, |
| 359 | WGPUCreateComputePipelineAsyncCallback callback, |
Jiawei Shao | 8fd1eb5 | 2021-10-13 00:43:05 +0000 | [diff] [blame] | 360 | void* userdata); |
Jiawei Shao | 4ecfc58 | 2021-09-17 07:39:00 +0000 | [diff] [blame] | 361 | void AddRenderPipelineAsyncCallbackTask(Ref<RenderPipelineBase> pipeline, |
| 362 | std::string errorMessage, |
| 363 | WGPUCreateRenderPipelineAsyncCallback callback, |
Jiawei Shao | 3c0925b | 2021-09-29 00:49:01 +0000 | [diff] [blame] | 364 | void* userdata); |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 365 | |
Brandon Jones | 1f48c97 | 2021-09-01 22:15:41 +0000 | [diff] [blame] | 366 | PipelineCompatibilityToken GetNextPipelineCompatibilityToken(); |
| 367 | |
Brandon Jones | ba66295 | 2021-09-23 21:26:33 +0000 | [diff] [blame] | 368 | const std::string& GetLabel() const; |
| 369 | void APISetLabel(const char* label); |
Loko Kung | 2494c9b | 2021-12-01 17:55:30 +0000 | [diff] [blame] | 370 | void APIDestroy(); |
Brandon Jones | ba66295 | 2021-09-23 21:26:33 +0000 | [diff] [blame] | 371 | |
Bryan Bernhart | 67a73bd | 2019-02-15 21:18:40 +0000 | [diff] [blame] | 372 | protected: |
Loko Kung | 2f3fe95 | 2021-10-12 18:53:57 +0000 | [diff] [blame] | 373 | // Constructor used only for mocking and testing. |
| 374 | DeviceBase(); |
| 375 | |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 376 | void SetToggle(Toggle toggle, bool isEnabled); |
Corentin Wallez | 022d074 | 2020-04-06 16:55:22 +0000 | [diff] [blame] | 377 | void ForceSetToggle(Toggle toggle, bool isEnabled); |
Corentin Wallez | 09ee5eb | 2020-04-07 15:10:17 +0000 | [diff] [blame] | 378 | |
Corentin Wallez | 8a43794 | 2020-04-17 16:45:17 +0000 | [diff] [blame] | 379 | MaybeError Initialize(QueueBase* defaultQueue); |
Loko Kung | fc5a7d4 | 2021-10-12 17:46:26 +0000 | [diff] [blame] | 380 | void DestroyObjects(); |
| 381 | void Destroy(); |
Bryan Bernhart | 67a73bd | 2019-02-15 21:18:40 +0000 | [diff] [blame] | 382 | |
Natasha Lee | 351c95a | 2020-05-07 21:52:54 +0000 | [diff] [blame] | 383 | // Incrememt mLastSubmittedSerial when we submit the next serial |
| 384 | void IncrementLastSubmittedCommandSerial(); |
Natasha Lee | 351c95a | 2020-05-07 21:52:54 +0000 | [diff] [blame] | 385 | |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 386 | private: |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 387 | virtual ResultOrError<Ref<BindGroupBase>> CreateBindGroupImpl( |
Corentin Wallez | 6f9d21e | 2018-12-05 07:18:30 +0000 | [diff] [blame] | 388 | const BindGroupDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 389 | virtual ResultOrError<Ref<BindGroupLayoutBase>> CreateBindGroupLayoutImpl( |
Brandon Jones | 1f48c97 | 2021-09-01 22:15:41 +0000 | [diff] [blame] | 390 | const BindGroupLayoutDescriptor* descriptor, |
| 391 | PipelineCompatibilityToken pipelineCompatibilityToken) = 0; |
Corentin Wallez | 8a99199 | 2020-07-08 19:45:40 +0000 | [diff] [blame] | 392 | virtual ResultOrError<Ref<BufferBase>> CreateBufferImpl( |
| 393 | const BufferDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 394 | virtual ResultOrError<Ref<PipelineLayoutBase>> CreatePipelineLayoutImpl( |
Corentin Wallez | 36afbb6 | 2018-07-25 17:03:23 +0200 | [diff] [blame] | 395 | const PipelineLayoutDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 396 | virtual ResultOrError<Ref<QuerySetBase>> CreateQuerySetImpl( |
Hao Li | b6eff5a | 2020-06-11 00:34:14 +0000 | [diff] [blame] | 397 | const QuerySetDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 398 | virtual ResultOrError<Ref<SamplerBase>> CreateSamplerImpl( |
Corentin Wallez | 36afbb6 | 2018-07-25 17:03:23 +0200 | [diff] [blame] | 399 | const SamplerDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 400 | virtual ResultOrError<Ref<ShaderModuleBase>> CreateShaderModuleImpl( |
Austin Eng | 0d948f7 | 2020-12-07 18:12:13 +0000 | [diff] [blame] | 401 | const ShaderModuleDescriptor* descriptor, |
| 402 | ShaderModuleParseResult* parseResult) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 403 | virtual ResultOrError<Ref<SwapChainBase>> CreateSwapChainImpl( |
Corentin Wallez | 7be2a71 | 2019-02-15 11:15:58 +0000 | [diff] [blame] | 404 | const SwapChainDescriptor* descriptor) = 0; |
Corentin Wallez | d26ee85 | 2020-01-25 10:05:40 +0000 | [diff] [blame] | 405 | // Note that previousSwapChain may be nullptr, or come from a different backend. |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 406 | virtual ResultOrError<Ref<NewSwapChainBase>> CreateSwapChainImpl( |
Corentin Wallez | d87e676 | 2020-01-23 17:20:38 +0000 | [diff] [blame] | 407 | Surface* surface, |
Corentin Wallez | d26ee85 | 2020-01-25 10:05:40 +0000 | [diff] [blame] | 408 | NewSwapChainBase* previousSwapChain, |
Corentin Wallez | d87e676 | 2020-01-23 17:20:38 +0000 | [diff] [blame] | 409 | const SwapChainDescriptor* descriptor) = 0; |
Rafael Cintron | 0e9320b | 2020-04-23 19:47:12 +0000 | [diff] [blame] | 410 | virtual ResultOrError<Ref<TextureBase>> CreateTextureImpl( |
Jiawei Shao | 425428f | 2018-08-27 08:44:48 +0800 | [diff] [blame] | 411 | const TextureDescriptor* descriptor) = 0; |
Corentin Wallez | 50f9958 | 2021-03-31 18:36:32 +0000 | [diff] [blame] | 412 | virtual ResultOrError<Ref<TextureViewBase>> CreateTextureViewImpl( |
Jiawei Shao | 6329e5a | 2018-10-12 08:32:58 +0000 | [diff] [blame] | 413 | TextureBase* texture, |
| 414 | const TextureViewDescriptor* descriptor) = 0; |
Jiawei Shao | 8fd1eb5 | 2021-10-13 00:43:05 +0000 | [diff] [blame] | 415 | virtual Ref<ComputePipelineBase> CreateUninitializedComputePipelineImpl( |
| 416 | const ComputePipelineDescriptor* descriptor) = 0; |
| 417 | virtual Ref<RenderPipelineBase> CreateUninitializedRenderPipelineImpl( |
| 418 | const RenderPipelineDescriptor* descriptor) = 0; |
Brandon Jones | ba66295 | 2021-09-23 21:26:33 +0000 | [diff] [blame] | 419 | virtual void SetLabelImpl(); |
Corentin Wallez | 1ae19e8 | 2018-05-17 17:09:07 -0400 | [diff] [blame] | 420 | |
Corentin Wallez | 1bc1ed4 | 2021-03-30 10:21:36 +0000 | [diff] [blame] | 421 | virtual MaybeError TickImpl() = 0; |
Zhaoming Jiang | 2849712 | 2021-07-21 08:59:09 +0000 | [diff] [blame] | 422 | void FlushCallbackTaskQueue(); |
Corentin Wallez | 1bc1ed4 | 2021-03-30 10:21:36 +0000 | [diff] [blame] | 423 | |
Tomek Ponitka | 5fb974c | 2020-07-01 13:09:46 +0000 | [diff] [blame] | 424 | ResultOrError<Ref<BindGroupLayoutBase>> CreateEmptyBindGroupLayout(); |
| 425 | |
Jiawei Shao | 8fd1eb5 | 2021-10-13 00:43:05 +0000 | [diff] [blame] | 426 | Ref<ComputePipelineBase> GetCachedComputePipeline( |
| 427 | ComputePipelineBase* uninitializedComputePipeline); |
Jiawei Shao | 3c0925b | 2021-09-29 00:49:01 +0000 | [diff] [blame] | 428 | Ref<RenderPipelineBase> GetCachedRenderPipeline( |
| 429 | RenderPipelineBase* uninitializedRenderPipeline); |
Jiawei Shao | 2aee6ee | 2021-08-26 00:39:14 +0000 | [diff] [blame] | 430 | Ref<ComputePipelineBase> AddOrGetCachedComputePipeline( |
Jiawei Shao | 8fd1eb5 | 2021-10-13 00:43:05 +0000 | [diff] [blame] | 431 | Ref<ComputePipelineBase> computePipeline); |
Jiawei Shao | 3c0925b | 2021-09-29 00:49:01 +0000 | [diff] [blame] | 432 | Ref<RenderPipelineBase> AddOrGetCachedRenderPipeline( |
| 433 | Ref<RenderPipelineBase> renderPipeline); |
Jiawei Shao | 8fd1eb5 | 2021-10-13 00:43:05 +0000 | [diff] [blame] | 434 | virtual void InitializeComputePipelineAsyncImpl( |
| 435 | Ref<ComputePipelineBase> computePipeline, |
| 436 | WGPUCreateComputePipelineAsyncCallback callback, |
| 437 | void* userdata); |
Jiawei Shao | 3c0925b | 2021-09-29 00:49:01 +0000 | [diff] [blame] | 438 | virtual void InitializeRenderPipelineAsyncImpl( |
| 439 | Ref<RenderPipelineBase> renderPipeline, |
| 440 | WGPUCreateRenderPipelineAsyncCallback callback, |
| 441 | void* userdata); |
Jiawei Shao | c243f67 | 2021-04-08 01:22:22 +0000 | [diff] [blame] | 442 | |
Austin Eng | 3482a80 | 2021-11-23 18:03:16 +0000 | [diff] [blame] | 443 | void ApplyToggleOverrides(const DawnDeviceDescriptor* deviceDescriptor); |
| 444 | void ApplyFeatures(const DawnDeviceDescriptor* deviceDescriptor); |
Jiawei Shao | 574b951 | 2019-08-02 00:06:38 +0000 | [diff] [blame] | 445 | |
Natasha Lee | 28232ce | 2019-06-11 18:11:05 +0000 | [diff] [blame] | 446 | void SetDefaultToggles(); |
Corentin Wallez | 52f2383 | 2018-07-16 17:40:08 +0200 | [diff] [blame] | 447 | |
Rafael Cintron | 69c68d0 | 2020-01-10 17:58:28 +0000 | [diff] [blame] | 448 | void ConsumeError(std::unique_ptr<ErrorData> error); |
Austin Eng | b11bd2d | 2019-09-18 21:03:41 +0000 | [diff] [blame] | 449 | |
Natasha Lee | 351c95a | 2020-05-07 21:52:54 +0000 | [diff] [blame] | 450 | // Each backend should implement to check their passed fences if there are any and return a |
| 451 | // completed serial. Return 0 should indicate no fences to check. |
Corentin Wallez | 6870e6d | 2021-04-07 18:09:21 +0000 | [diff] [blame] | 452 | virtual ResultOrError<ExecutionSerial> CheckAndUpdateCompletedSerials() = 0; |
Natasha Lee | 783cd5a | 2020-06-04 02:26:46 +0000 | [diff] [blame] | 453 | // During shut down of device, some operations might have been started since the last submit |
| 454 | // and waiting on a serial that doesn't have a corresponding fence enqueued. Fake serials to |
| 455 | // make all commands look completed. |
| 456 | void AssumeCommandsComplete(); |
Brandon Jones | 4ad3586 | 2020-10-15 16:21:03 +0000 | [diff] [blame] | 457 | bool IsDeviceIdle(); |
| 458 | |
Natasha Lee | 351c95a | 2020-05-07 21:52:54 +0000 | [diff] [blame] | 459 | // mCompletedSerial tracks the last completed command serial that the fence has returned. |
| 460 | // mLastSubmittedSerial tracks the last submitted command serial. |
| 461 | // During device removal, the serials could be artificially incremented |
| 462 | // to make it appear as if commands have been compeleted. They can also be artificially |
| 463 | // incremented when no work is being done in the GPU so CPU operations don't have to wait on |
| 464 | // stale serials. |
Brandon Jones | 4ad3586 | 2020-10-15 16:21:03 +0000 | [diff] [blame] | 465 | // mFutureSerial tracks the largest serial we need to tick to for asynchronous commands or |
| 466 | // callbacks to fire |
Corentin Wallez | 62139fc | 2020-09-28 19:35:14 +0000 | [diff] [blame] | 467 | ExecutionSerial mCompletedSerial = ExecutionSerial(0); |
| 468 | ExecutionSerial mLastSubmittedSerial = ExecutionSerial(0); |
Brandon Jones | 4ad3586 | 2020-10-15 16:21:03 +0000 | [diff] [blame] | 469 | ExecutionSerial mFutureSerial = ExecutionSerial(0); |
Natasha Lee | 351c95a | 2020-05-07 21:52:54 +0000 | [diff] [blame] | 470 | |
Loko Kung | fc5a7d4 | 2021-10-12 17:46:26 +0000 | [diff] [blame] | 471 | // DestroyImpl is used to clean up and release resources used by device, does not wait for |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 472 | // GPU or check errors. |
Loko Kung | fc5a7d4 | 2021-10-12 17:46:26 +0000 | [diff] [blame] | 473 | virtual void DestroyImpl() = 0; |
Natasha Lee | 2c8a17e | 2019-12-16 23:36:16 +0000 | [diff] [blame] | 474 | |
| 475 | // WaitForIdleForDestruction waits for GPU to finish, checks errors and gets ready for |
| 476 | // destruction. This is only used when properly destructing the device. For a real |
| 477 | // device loss, this function doesn't need to be called since the driver already closed all |
| 478 | // resources. |
| 479 | virtual MaybeError WaitForIdleForDestruction() = 0; |
| 480 | |
Austin Eng | ef9e441 | 2021-02-19 18:17:22 +0000 | [diff] [blame] | 481 | wgpu::ErrorCallback mUncapturedErrorCallback = nullptr; |
| 482 | void* mUncapturedErrorUserdata = nullptr; |
| 483 | |
Zhaoming Jiang | b44000e | 2021-06-04 07:10:56 +0000 | [diff] [blame] | 484 | wgpu::LoggingCallback mLoggingCallback = nullptr; |
| 485 | void* mLoggingUserdata = nullptr; |
| 486 | |
Natasha Lee | 9bba4a9 | 2019-12-18 18:59:20 +0000 | [diff] [blame] | 487 | wgpu::DeviceLostCallback mDeviceLostCallback = nullptr; |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 488 | void* mDeviceLostUserdata = nullptr; |
Natasha Lee | 9bba4a9 | 2019-12-18 18:59:20 +0000 | [diff] [blame] | 489 | |
Austin Eng | ef9e441 | 2021-02-19 18:17:22 +0000 | [diff] [blame] | 490 | std::unique_ptr<ErrorScopeStack> mErrorScopeStack; |
| 491 | |
Austin Eng | f6ef753 | 2021-01-13 17:54:37 +0000 | [diff] [blame] | 492 | // The Device keeps a ref to the Instance so that any live Device keeps the Instance alive. |
| 493 | // The Instance shouldn't need to ref child objects so this shouldn't introduce ref cycles. |
| 494 | // The Device keeps a simple pointer to the Adapter because the Adapter is owned by the |
| 495 | // Instance. |
| 496 | Ref<InstanceBase> mInstance; |
Corentin Wallez | ec18f96 | 2019-01-10 10:50:54 +0000 | [diff] [blame] | 497 | AdapterBase* mAdapter = nullptr; |
| 498 | |
Corentin Wallez | c1400f0 | 2017-11-24 13:59:42 -0500 | [diff] [blame] | 499 | // The object caches aren't exposed in the header as they would require a lot of |
| 500 | // additional includes. |
| 501 | struct Caches; |
Corentin Wallez | cca9c69 | 2018-09-06 15:26:48 +0200 | [diff] [blame] | 502 | std::unique_ptr<Caches> mCaches; |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 503 | |
Tomek Ponitka | bf27bd7 | 2020-06-29 11:13:43 +0000 | [diff] [blame] | 504 | Ref<BindGroupLayoutBase> mEmptyBindGroupLayout; |
| 505 | |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 506 | std::unique_ptr<DynamicUploader> mDynamicUploader; |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 507 | std::unique_ptr<AsyncTaskManager> mAsyncTaskManager; |
Corentin Wallez | 6d315da | 2021-02-04 15:33:42 +0000 | [diff] [blame] | 508 | Ref<QueueBase> mQueue; |
Corentin Wallez | 8a43794 | 2020-04-17 16:45:17 +0000 | [diff] [blame] | 509 | |
| 510 | struct DeprecationWarnings; |
| 511 | std::unique_ptr<DeprecationWarnings> mDeprecationWarnings; |
Austin Eng | f0b761f | 2018-12-03 16:57:34 +0000 | [diff] [blame] | 512 | |
Corentin Wallez | 73ea1f1 | 2020-04-07 16:19:47 +0000 | [diff] [blame] | 513 | State mState = State::BeingCreated; |
Jiawei Shao | 15d4c2e | 2019-04-26 07:52:57 +0000 | [diff] [blame] | 514 | |
Loko Kung | 8d195d5 | 2021-09-28 15:40:01 +0000 | [diff] [blame] | 515 | // Encompasses the mutex and the actual list that contains all live objects "owned" by the |
| 516 | // device. |
| 517 | struct ApiObjectList { |
| 518 | std::mutex mutex; |
| 519 | LinkedList<ApiObjectBase> objects; |
| 520 | }; |
| 521 | PerObjectType<ApiObjectList> mObjectLists; |
| 522 | |
Corentin Wallez | 1546bfb | 2019-07-18 09:25:04 +0000 | [diff] [blame] | 523 | FormatTable mFormatTable; |
| 524 | |
Corentin Wallez | cb84c79 | 2020-04-06 08:32:01 +0000 | [diff] [blame] | 525 | TogglesSet mEnabledToggles; |
Corentin Wallez | 022d074 | 2020-04-06 16:55:22 +0000 | [diff] [blame] | 526 | TogglesSet mOverridenToggles; |
Natasha Lee | e69627f | 2019-07-26 17:54:48 +0000 | [diff] [blame] | 527 | size_t mLazyClearCountForTesting = 0; |
Brandon Jones | 1f48c97 | 2021-09-01 22:15:41 +0000 | [diff] [blame] | 528 | std::atomic_uint64_t mNextPipelineCompatibilityToken; |
Jiawei Shao | 574b951 | 2019-08-02 00:06:38 +0000 | [diff] [blame] | 529 | |
Austin Eng | 02fbf16 | 2021-09-13 18:49:09 +0000 | [diff] [blame] | 530 | CombinedLimits mLimits; |
François Beaufort | 3f689a4 | 2021-10-04 11:30:02 +0000 | [diff] [blame] | 531 | FeaturesSet mEnabledFeatures; |
Yan, Shaobo | db8766b | 2020-11-04 02:30:16 +0000 | [diff] [blame] | 532 | |
| 533 | std::unique_ptr<InternalPipelineStore> mInternalPipelineStore; |
Bryan Bernhart | 41b3f9c | 2020-11-20 20:38:37 +0000 | [diff] [blame] | 534 | |
| 535 | std::unique_ptr<PersistentCache> mPersistentCache; |
Jiawei Shao | 5e1ca53 | 2021-06-04 05:12:06 +0000 | [diff] [blame] | 536 | |
| 537 | std::unique_ptr<CallbackTaskManager> mCallbackTaskManager; |
| 538 | std::unique_ptr<dawn_platform::WorkerTaskPool> mWorkerTaskPool; |
Brandon Jones | ba66295 | 2021-09-23 21:26:33 +0000 | [diff] [blame] | 539 | std::string mLabel; |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 540 | }; |
| 541 | |
Corentin Wallez | 49a65d0 | 2018-07-24 16:45:45 +0200 | [diff] [blame] | 542 | } // namespace dawn_native |
Austin Eng | 376f1c6 | 2017-05-30 20:03:44 -0400 | [diff] [blame] | 543 | |
Corentin Wallez | ac67fec | 2019-01-04 10:30:40 +0000 | [diff] [blame] | 544 | #endif // DAWNNATIVE_DEVICE_H_ |