Implement WebGPUQueue and device.getQueue()
[WebKit-https.git] / Source / WebCore / platform / graphics / gpu / cocoa / GPUQueueMetal.mm
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 #import "config.h"
27 #import "GPUQueue.h"
28
29 #if ENABLE(WEBGPU)
30
31 #import "GPUDevice.h"
32 #import "Logging.h"
33
34 #import <Metal/Metal.h>
35 #import <wtf/BlockObjCExceptions.h>
36 #import <wtf/text/WTFString.h>
37
38 namespace WebCore {
39
40 static NSString * const commandQueueDefaultLabel = @"com.apple.WebKit";
41 static NSString * const commandQueueLabelPrefix = @"com.apple.WebKit.";
42
43 RefPtr<GPUQueue> GPUQueue::create(const GPUDevice& device)
44 {
45     if (!device.platformDevice()) {
46         LOG(WebGPU, "GPUQueue::create(): Invalid GPUDevice.");
47         return nullptr;
48     }
49
50     PlatformQueueSmartPtr queue;
51
52     BEGIN_BLOCK_OBJC_EXCEPTIONS;
53
54     queue = adoptNS([device.platformDevice() newCommandQueue]);
55     [queue setLabel:commandQueueDefaultLabel];
56
57     END_BLOCK_OBJC_EXCEPTIONS;
58
59     if (!queue) {
60         LOG(WebGPU, "GPUQueue::create(): Unable to create MTLCommandQueue.");
61         return nullptr;
62     }
63
64     return adoptRef(new GPUQueue(WTFMove(queue)));
65 }
66
67 GPUQueue::GPUQueue(PlatformQueueSmartPtr&& queue)
68     : m_platformQueue(WTFMove(queue))
69 {
70 }
71
72 void GPUQueue::submit(Vector<Ref<const GPUCommandBuffer>>&&)
73 {
74     // FIXME: Missing implementation.
75 }
76
77 String GPUQueue::label() const
78 {
79     if (!m_platformQueue)
80         return emptyString();
81
82     NSString *prefixedLabel = [m_platformQueue label];
83
84     if ([prefixedLabel isEqualToString:commandQueueDefaultLabel])
85         return emptyString();
86
87     ASSERT(prefixedLabel.length > commandQueueLabelPrefix.length);
88     return [prefixedLabel substringFromIndex:commandQueueLabelPrefix.length];
89 }
90
91 void GPUQueue::setLabel(const String& label) const
92 {
93     if (label.isEmpty())
94         [m_platformQueue setLabel:commandQueueDefaultLabel];
95     else
96         [m_platformQueue setLabel:[commandQueueLabelPrefix stringByAppendingString:label]];
97 }
98
99 } // namespace WebCore
100
101 #endif // ENABLE(WEBGPU)