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
|
/*
* Copyright (c) 2021-2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#import "BindableResource.h"
#import "CommandBuffer.h"
#import "CommandsMixin.h"
#import "Device.h"
#import <WebGPU/WebGPU.h>
#import <WebGPU/WebGPUExt.h>
#import <wtf/FastMalloc.h>
#import <wtf/Function.h>
#import <wtf/Ref.h>
#import <wtf/RefCountedAndCanMakeWeakPtr.h>
#import <wtf/RetainReleaseSwift.h>
#import <wtf/SwiftCXXThunk.h>
#import <wtf/TZoneMalloc.h>
#import <wtf/TaggedPtr.h>
#import <wtf/Vector.h>
#import <wtf/WeakPtr.h>
IGNORE_CLANG_WARNINGS_BEGIN("nullability-completeness")
@interface TextureAndClearColor : NSObject
- (instancetype)initWithTexture:(id<MTLTexture> _Nonnull)texture NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
@property (nonatomic) id<MTLTexture> texture;
@property (nonatomic) MTLClearColor clearColor;
@property (nonatomic) NSUInteger depthPlane;
@end
struct WGPUCommandEncoderImpl {
};
namespace WebGPU {
class BindGroup;
class Buffer;
class CommandBuffer;
class ComputePassEncoder;
class ExternalTexture;
class QuerySet;
class RenderPassEncoder;
class Sampler;
class Texture;
class TextureView;
// https://gpuweb.github.io/gpuweb/#gpucommandencoder
class CommandEncoder : public CommandsMixin, public RefCountedAndCanMakeWeakPtr<CommandEncoder>, public WGPUCommandEncoderImpl {
WTF_MAKE_TZONE_ALLOCATED(CommandEncoder);
public:
static Ref<CommandEncoder> create(id<MTLCommandBuffer> commandBuffer, Device& device, uint64_t uniqueId)
{
return adoptRef(*new CommandEncoder(commandBuffer, device, uniqueId));
}
static Ref<CommandEncoder> createInvalid(Device& device)
{
return adoptRef(*new CommandEncoder(device));
}
#if ENABLE(WEBGPU_SWIFT)
inline Ref<CommandBuffer> createCommandBuffer(id<MTLCommandBuffer> commandBuffer, Device& device, id<MTLSharedEvent> sharedEvent, uint64_t sharedEventSignalValue)
{
return CommandBuffer::create(commandBuffer, device, sharedEvent, sharedEventSignalValue, WTF::move(m_onCommitHandlers), *this);
}
#endif
~CommandEncoder();
Ref<ComputePassEncoder> beginComputePass(const WGPUComputePassDescriptor&) HAS_SWIFTCXX_THUNK;
Ref<RenderPassEncoder> beginRenderPass(const WGPURenderPassDescriptor&) HAS_SWIFTCXX_THUNK;
void copyBufferToBuffer(const Buffer& source, uint64_t sourceOffset, Buffer& destination, uint64_t destinationOffset, uint64_t size) HAS_SWIFTCXX_THUNK;
void copyBufferToTexture(const WGPUImageCopyBuffer& source, const WGPUImageCopyTexture& destination, const WGPUExtent3D& copySize) HAS_SWIFTCXX_THUNK;
void copyTextureToBuffer(const WGPUImageCopyTexture& source, const WGPUImageCopyBuffer& destination, const WGPUExtent3D& copySize) HAS_SWIFTCXX_THUNK;
void copyTextureToTexture(const WGPUImageCopyTexture& source, const WGPUImageCopyTexture& destination, const WGPUExtent3D& copySize) HAS_SWIFTCXX_THUNK;
void runClearEncoder(NSMutableDictionary<NSNumber*, TextureAndClearColor*> *attachmentsToClear, id<MTLTexture> depthStencilAttachmentToClear, bool depthAttachmentToClear, bool stencilAttachmentToClear, float depthClearValue = 0, uint32_t stencilClearValue = 0, id<MTLRenderCommandEncoder> existingEncoder = nil) HAS_SWIFTCXX_THUNK;
void clearBuffer(Buffer&, uint64_t offset, uint64_t size);
Ref<CommandBuffer> finish(const WGPUCommandBufferDescriptor&) HAS_SWIFTCXX_THUNK;
void insertDebugMarker(String&& markerLabel);
void popDebugGroup();
void pushDebugGroup(String&& groupLabel);
void resolveQuerySet(const QuerySet&, uint32_t firstQuery, uint32_t queryCount, Buffer& destination, uint64_t destinationOffset);
void writeTimestamp(QuerySet&, uint32_t queryIndex);
void setLabel(String&&);
Device& device() const { return m_device; }
Ref<Device> protectedDevice() const { return m_device; }
bool isValid() const { return m_commandBuffer; }
void lock(bool);
bool isLocked() const { return m_state == EncoderState::Locked; }
bool isFinished() const { return m_state == EncoderState::Ended; }
#if ENABLE(WEBGPU_SWIFT)
void setEncoderState(EncoderState state) { m_state = state; }
EncoderState getEncoderState() { return m_state; }
#endif
id<MTLBlitCommandEncoder> ensureBlitCommandEncoder();
void finalizeBlitCommandEncoder();
static void clearTextureIfNeeded(const WGPUImageCopyTexture&, NSUInteger, const Device&, id<MTLBlitCommandEncoder>);
static void clearTextureIfNeeded(Texture&, NSUInteger, NSUInteger, const Device&, id<MTLBlitCommandEncoder>);
void clearTextureIfNeeded(const WGPUImageCopyTexture&, NSUInteger) HAS_SWIFTCXX_THUNK;
void makeInvalid(NSString*);
void makeSubmitInvalid(NSString* = nil);
void incrementBufferMapCount();
void decrementBufferMapCount();
void endEncoding(id<MTLCommandEncoder>);
void setLastError(NSString*);
bool waitForCommandBufferCompletion();
bool encoderIsCurrent(id<MTLCommandEncoder>) const;
bool submitWillBeInvalid() const { return m_makeSubmitInvalid; }
void addBuffer(id<MTLBuffer>);
void addBuffer(id<MTLCounterSampleBuffer>);
void addICB(id<MTLIndirectCommandBuffer>);
void addTexture(id<MTLTexture>);
void addTexture(const Texture&);
void addSampler(const Sampler&);
id<MTLCommandBuffer> _Nullable commandBuffer() const;
void setExistingEncoder(id<MTLCommandEncoder>);
void generateInvalidEncoderStateError();
bool validateClearBuffer(const Buffer&, uint64_t offset, uint64_t size);
void clearTracking();
void trackEncoderForBuffer(const Buffer&, TrackedResourceContainer&);
void trackEncoderForTexture(const Texture&, TrackedResourceContainer&);
void trackEncoderForTextureView(const TextureView&, TrackedResourceContainer&);
void trackEncoderForExternalTexture(const ExternalTexture&, TrackedResourceContainer&);
void trackEncoderForQuerySet(const QuerySet&, TrackedResourceContainer&);
static void trackEncoder(CommandEncoder&, HashSet<uint64_t, DefaultHash<uint64_t>, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>>&);
static size_t computeSize(TrackedResourceContainer&, const Device&);
uint64_t uniqueId() const { return m_uniqueId; }
NSMutableSet<id<MTLCounterSampleBuffer>> * _Nullable timestampBuffers() const { return m_retainedTimestampBuffers; };
void addOnCommitHandler(Function<bool(CommandBuffer&, CommandEncoder&)>&&);
#if ENABLE(WEBGPU_BY_DEFAULT)
bool useResidencySet(id<MTLResidencySet>);
#endif
void skippedDrawIndexedValidation(uint64_t bufferIdentifier, DrawIndexCacheContainerIterator);
void rebindSamplersPreCommit(const BindGroup&);
private:
CommandEncoder(id<MTLCommandBuffer>, Device&, uint64_t uniqueId);
CommandEncoder(Device&);
bool validatePopDebugGroup() const;
NSString * _Nullable validateFinishError() const;
NSString * _Nullable errorValidatingCopyBufferToBuffer(const Buffer& source, uint64_t sourceOffset, const Buffer& destination, uint64_t destinationOffset, uint64_t size);
NSString * _Nullable errorValidatingComputePassDescriptor(const WGPUComputePassDescriptor&) const;
NSString * _Nullable errorValidatingRenderPassDescriptor(const WGPURenderPassDescriptor&) const;
NSString * _Nullable errorValidatingImageCopyBuffer(const WGPUImageCopyBuffer&) const;
NSString * _Nullable errorValidatingCopyBufferToTexture(const WGPUImageCopyBuffer&, const WGPUImageCopyTexture&, const WGPUExtent3D&) const;
NSString * _Nullable errorValidatingCopyTextureToBuffer(const WGPUImageCopyTexture&, const WGPUImageCopyBuffer&, const WGPUExtent3D&) const;
NSString * _Nullable errorValidatingCopyTextureToTexture(const WGPUImageCopyTexture& source, const WGPUImageCopyTexture& destination, const WGPUExtent3D& copySize) const;
void trackEncoder(TrackedResourceContainer&);
void discardCommandBuffer();
RefPtr<CommandBuffer> protectedCachedCommandBuffer() const { return m_cachedCommandBuffer.get(); }
void retainTimestampsForOneUpdateLoop();
id<MTLCommandBuffer> _Nullable m_commandBuffer { nil };
id<MTLCommandEncoder> _Nullable m_existingCommandEncoder { nil };
id<MTLBlitCommandEncoder> _Nullable m_blitCommandEncoder { nil };
NSString* _Nullable m_lastErrorString { nil };
uint64_t m_debugGroupStackSize { 0 };
ThreadSafeWeakPtr<CommandBuffer> m_cachedCommandBuffer;
#if CPU(X86_64) && (PLATFORM(MAC) || PLATFORM(MACCATALYST))
NSMutableSet<id<MTLTexture>> * _Nullable m_managedTextures { nil };
NSMutableSet<id<MTLBuffer>> * _Nullable m_managedBuffers { nil };
#endif // CPU(X86_64) && (PLATFORM(MAC) || PLATFORM(MACCATALYST))
private:
NSMutableSet<id<MTLIndirectCommandBuffer>> * _Nullable m_retainedICBs { nil };
NSMutableSet<id<MTLTexture>> * _Nullable m_retainedTextures { nil };
NSMutableSet<id<MTLBuffer>> * _Nullable m_retainedBuffers { nil };
HashSet<RefPtr<const Sampler>> m_retainedSamplers;
NSMutableSet<id<MTLCounterSampleBuffer>> * _Nullable m_retainedTimestampBuffers { nil };
Vector<Function<bool(CommandBuffer&, CommandEncoder&)>> m_onCommitHandlers;
HashMap<uint64_t, Vector<std::pair<DrawIndexCacheContainerValue, uint32_t>>, DefaultHash<uint64_t>, WTF::UnsignedWithZeroKeyHashTraits<uint64_t>> m_skippedDrawIndexedValidationKeys;
Vector<Ref<const BindGroup>> m_bindGroups;
Vector<Ref<const Buffer>> m_trackedBuffers;
Vector<Ref<const Texture>> m_trackedTextures;
Vector<Ref<const TextureView>> m_trackedTextureViews;
Vector<Ref<const ExternalTexture>> m_trackedExternalTextures;
Vector<Ref<const QuerySet>> m_trackedQuerySets;
int m_bufferMapCount { 0 };
bool m_makeSubmitInvalid { false };
id<MTLSharedEvent> _Nullable m_sharedEvent { nil };
uint64_t m_sharedEventSignalValue { 0 };
const Ref<Device> m_device;
uint64_t m_uniqueId;
#if ENABLE(WEBGPU_BY_DEFAULT)
uint32_t m_currentResidencySetCount { 0 };
#endif
} SWIFT_SHARED_REFERENCE(refCommandEncoder, derefCommandEncoder) SWIFT_PRIVATE_FILEID("WebGPU/CommandEncoder.swift");
} // namespace WebGPU
inline void refCommandEncoder(WebGPU::CommandEncoder* obj)
{
WTF::ref(obj);
}
inline void derefCommandEncoder(WebGPU::CommandEncoder* obj)
{
WTF::deref(obj);
}
IGNORE_CLANG_WARNINGS_END
|
