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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "Instance.h"
#include <optional>
#include <string_view>
#include "Adapter.h"
#include "ipc/WebGPUChild.h"
#include "ipc/WebGPUTypes.h"
#include "js/Value.h"
#include "mozilla/Assertions.h"
#include "mozilla/ErrorResult.h"
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/dom/Promise.h"
#include "mozilla/dom/WorkerPrivate.h"
#include "mozilla/gfx/CanvasManagerChild.h"
#include "mozilla/gfx/Logging.h"
#include "mozilla/gfx/gfxVars.h"
#include "mozilla/webgpu/ffi/wgpu.h"
#include "nsDebug.h"
#include "nsIGlobalObject.h"
#include "nsString.h"
#include "nsStringFwd.h"
namespace mozilla::webgpu {
GPU_IMPL_CYCLE_COLLECTION(WGSLLanguageFeatures, mParent)
GPU_IMPL_CYCLE_COLLECTION(Instance, mOwner, mWgslLanguageFeatures)
static inline nsDependentCString ToCString(const std::string_view s) {
return {s.data(), s.length()};
}
/* static */ bool Instance::PrefEnabled(JSContext* aCx, JSObject* aObj) {
if (!StaticPrefs::dom_webgpu_enabled()) {
return false;
}
if (NS_IsMainThread()) {
return true;
}
dom::WorkerPrivate* wp = dom::GetCurrentThreadWorkerPrivate();
if (wp && wp->IsServiceWorker()) {
return StaticPrefs::dom_webgpu_service_workers_enabled();
}
return true;
}
/* static */ bool Instance::ExternalTexturePrefEnabled(JSContext* aCx,
JSObject* aObj) {
return StaticPrefs::dom_webgpu_external_texture_enabled_AtStartup();
}
/*static*/
already_AddRefed<Instance> Instance::Create(nsIGlobalObject* aOwner) {
RefPtr<Instance> result = new Instance(aOwner);
return result.forget();
}
Instance::Instance(nsIGlobalObject* aOwner)
: mOwner(aOwner), mWgslLanguageFeatures(new WGSLLanguageFeatures(this)) {
// Populate `mWgslLanguageFeatures`.
IgnoredErrorResult rv;
nsCString wgslFeature;
for (size_t i = 0;; ++i) {
wgslFeature.Truncate(0);
ffi::wgpu_client_instance_get_wgsl_language_feature(&wgslFeature, i);
if (wgslFeature.IsEmpty()) {
break;
}
NS_ConvertASCIItoUTF16 feature{wgslFeature};
this->mWgslLanguageFeatures->Add(feature, rv);
if (rv.Failed()) {
if (rv.ErrorCodeIs(NS_ERROR_UNEXPECTED)) {
// This is fine; something went wrong with the JS scope we're in, and we
// can just let that happen.
NS_WARNING(
"`Instance::Instance`: failed to append WGSL language feature: got "
"`NS_ERROR_UNEXPECTED`");
} else {
MOZ_CRASH_UNSAFE_PRINTF(
"`Instance::Instance`: failed to append WGSL language feature: %d",
rv.ErrorCodeAsInt());
}
}
}
}
JSObject* Instance::WrapObject(JSContext* cx,
JS::Handle<JSObject*> givenProto) {
return dom::GPU_Binding::Wrap(cx, this, givenProto);
}
already_AddRefed<dom::Promise> Instance::RequestAdapter(
const dom::GPURequestAdapterOptions& aOptions, ErrorResult& aRv) {
RefPtr<dom::Promise> promise = dom::Promise::Create(mOwner, aRv);
if (NS_WARN_IF(aRv.Failed())) {
return nullptr;
}
// -
// Check if we should allow the request.
std::optional<std::string_view> rejectionMessage = {};
const auto rejectIf = [&rejectionMessage](bool condition,
const char* message) {
if (condition && !rejectionMessage.has_value()) {
rejectionMessage = message;
}
};
#ifndef EARLY_BETA_OR_EARLIER
if (dom::WorkerPrivate* wp = dom::GetCurrentThreadWorkerPrivate()) {
rejectIf(wp->IsServiceWorker(),
"WebGPU in service workers is not yet available in Release or "
"late Beta builds; see "
"<https://bugzilla.mozilla.org/show_bug.cgi?id=1942431>.");
}
#endif
rejectIf(!gfx::gfxVars::AllowWebGPU(), "WebGPU is disabled by blocklist.");
rejectIf(!StaticPrefs::dom_webgpu_enabled(),
"WebGPU is disabled because the `dom.webgpu.enabled` pref. is set "
"to `false`.");
#ifdef WIN32
# ifndef MOZ_DXCOMPILER
rejectIf(true,
"WebGPU is disabled because dxcompiler is unavailable with this "
"build configuration");
# endif
#endif
// Check if WebGPU is blocked for this global's domain.
{
const auto prefLock = mozilla::StaticPrefs::dom_webgpu_blocked_domains();
rejectIf(nsContentUtils::IsURIInList(mOwner->GetBaseURI(), *prefLock),
"WebGPU is blocked for this domain by the "
"`dom.webgpu.blocked-domains` pref.");
}
if (rejectionMessage) {
promise->MaybeRejectWithNotSupportedError(ToCString(*rejectionMessage));
return promise.forget();
}
// -
// Make the request.
auto* const canvasManager = gfx::CanvasManagerChild::Get();
if (!canvasManager) {
promise->MaybeRejectWithInvalidStateError(
"Failed to create CanvasManagerChild");
return promise.forget();
}
RefPtr<WebGPUChild> child = canvasManager->GetWebGPUChild();
if (!child) {
promise->MaybeRejectWithInvalidStateError("Failed to create WebGPUChild");
return promise.forget();
}
if (aOptions.mFeatureLevel.EqualsASCII("core")) {
// Good! That's all we support.
} else if (aOptions.mFeatureLevel.EqualsASCII("compatibility")) {
dom::AutoJSAPI api;
if (api.Init(mOwner)) {
JS::WarnUTF8(api.cx(),
"User requested a WebGPU adapter with `featureLevel: "
"\"compatibility\"`, which is not yet supported; returning "
"a \"core\"-defaulting adapter for now. Subscribe to "
"<https://bugzilla.mozilla.org/show_bug.cgi?id=1905951>"
" for updates on its development in Firefox.");
}
} else {
NS_ConvertUTF16toUTF8 featureLevel(aOptions.mFeatureLevel);
dom::AutoJSAPI api;
if (api.Init(mOwner)) {
JS::WarnUTF8(api.cx(),
"expected one of `\"core\"` or `\"compatibility\"` for "
"`GPUAdapter.featureLevel`, got %s",
featureLevel.get());
}
promise->MaybeResolve(JS::NullValue());
return promise.forget();
}
if (aOptions.mXrCompatible) {
dom::AutoJSAPI api;
if (api.Init(mOwner)) {
JS::WarnUTF8(
api.cx(),
"User requested a WebGPU adapter with `xrCompatible: true`, "
"but WebXR sessions are not yet supported in WebGPU. Returning "
"a regular adapter for now. Subscribe to "
"<https://bugzilla.mozilla.org/show_bug.cgi?id=1963829>"
" for updates on its development in Firefox.");
}
}
ffi::WGPUPowerPreference power_preference;
if (aOptions.mPowerPreference.WasPassed()) {
power_preference = static_cast<ffi::WGPUPowerPreference>(
aOptions.mPowerPreference.Value());
} else {
power_preference = ffi::WGPUPowerPreference_LowPower;
}
RawId adapter_id = ffi::wgpu_client_request_adapter(
child->GetClient(), power_preference, aOptions.mForceFallbackAdapter);
auto pending_promise = WebGPUChild::PendingRequestAdapterPromise{
RefPtr(promise), RefPtr(this), adapter_id};
child->mPendingRequestAdapterPromises.push_back(std::move(pending_promise));
return promise.forget();
}
} // namespace mozilla::webgpu
|