[Web GPU] Indexed drawing and GPUCommandEncoder crash prevention
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / GPUBuffer.h
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(WEBGPU)
29
30 #include "DeferrableTask.h"
31 #include "GPUBufferUsage.h"
32 #include <wtf/Function.h>
33 #include <wtf/OptionSet.h>
34 #include <wtf/Ref.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/RetainPtr.h>
37 #include <wtf/Vector.h>
38
39 #if USE(METAL)
40 OBJC_PROTOCOL(MTLBuffer);
41 OBJC_PROTOCOL(MTLCommandBuffer);
42 #endif
43
44 namespace JSC {
45 class ArrayBuffer;
46 }
47
48 namespace WebCore {
49
50 class GPUDevice;
51
52 struct GPUBufferDescriptor;
53
54 #if USE(METAL)
55 using PlatformBuffer = MTLBuffer;
56 #else
57 using PlatformBuffer = void;
58 #endif
59 using PlatformBufferSmartPtr = RetainPtr<PlatformBuffer>;
60
61 class GPUBuffer : public RefCounted<GPUBuffer> {
62 public:
63     enum class State {
64         Mapped,
65         Unmapped,
66         Destroyed
67     };
68
69     ~GPUBuffer();
70
71     static RefPtr<GPUBuffer> tryCreate(Ref<GPUDevice>&&, const GPUBufferDescriptor&);
72
73     PlatformBuffer *platformBuffer() const { return m_platformBuffer.get(); }
74     uint64_t byteLength() const { return m_byteLength; }
75     bool isTransferSource() const { return m_usage.contains(GPUBufferUsage::Flags::TransferSource); }
76     bool isTransferDestination() const { return m_usage.contains(GPUBufferUsage::Flags::TransferDestination); }
77     bool isIndex() const { return m_usage.contains(GPUBufferUsage::Flags::Index); }
78     bool isVertex() const { return m_usage.contains(GPUBufferUsage::Flags::Vertex); }
79     bool isUniform() const { return m_usage.contains(GPUBufferUsage::Flags::Uniform); }
80     bool isStorage() const { return m_usage.contains(GPUBufferUsage::Flags::Storage); }
81     bool isReadOnly() const;
82     bool isMappable() const { return m_usage.containsAny({ GPUBufferUsage::Flags::MapWrite, GPUBufferUsage::Flags::MapRead }); }
83     State state() const;
84
85 #if USE(METAL)
86     void commandBufferCommitted(MTLCommandBuffer *);
87     void commandBufferCompleted();
88
89     void reuseSubDataBuffer(RetainPtr<MTLBuffer>&&);
90 #endif
91
92     void setSubData(uint64_t, const JSC::ArrayBuffer&);
93     using MappingCallback = WTF::Function<void(JSC::ArrayBuffer*)>;
94     void registerMappingCallback(MappingCallback&&, bool);
95     void unmap();
96     void destroy();
97
98 private:
99     struct PendingMappingCallback : public RefCounted<PendingMappingCallback> {
100         static Ref<PendingMappingCallback> create(MappingCallback&& callback)
101         {
102             return adoptRef(*new PendingMappingCallback(WTFMove(callback)));
103         }
104
105         MappingCallback callback;
106
107     private:
108         PendingMappingCallback(MappingCallback&&);
109     };
110
111     static bool validateBufferUsage(const GPUDevice&, OptionSet<GPUBufferUsage::Flags>);
112
113     GPUBuffer(PlatformBufferSmartPtr&&, uint64_t, OptionSet<GPUBufferUsage::Flags>, Ref<GPUDevice>&&);
114
115     JSC::ArrayBuffer* stagingBufferForRead();
116     JSC::ArrayBuffer* stagingBufferForWrite();
117     void runMappingCallback();
118
119     bool isMapWrite() const { return m_usage.contains(GPUBufferUsage::Flags::MapWrite); }
120     bool isMapRead() const { return m_usage.contains(GPUBufferUsage::Flags::MapRead); }
121     bool isMapWriteable() const { return isMapWrite() && state() == State::Unmapped; }
122     bool isMapReadable() const { return isMapRead() && state() == State::Unmapped; }
123
124     PlatformBufferSmartPtr m_platformBuffer;
125     Ref<GPUDevice> m_device;
126
127 #if USE(METAL)
128     Vector<RetainPtr<MTLBuffer>> m_subDataBuffers;
129 #endif
130
131     RefPtr<JSC::ArrayBuffer> m_stagingBuffer;
132     RefPtr<PendingMappingCallback> m_mappingCallback;
133     DeferrableTask<Timer> m_mappingCallbackTask;
134
135     uint64_t m_byteLength;
136     OptionSet<GPUBufferUsage::Flags> m_usage;
137     unsigned m_numScheduledCommandBuffers { 0 };
138 };
139
140 } // namespace WebCore
141
142 #endif // ENABLE(WEBGPU)