src/dawn/native/webgpu/WebGPUError.h

// Copyright 2025 The Dawn & Tint Authors
//
// 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.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER 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.

#ifndef SRC_DAWN_NATIVE_WEBGPU_WEBGPUERROR_H_
#define SRC_DAWN_NATIVE_WEBGPU_WEBGPUERROR_H_

#include <string>

#include "dawn/native/Error.h"

namespace dawn::native::webgpu {

template <typename CEnum>
MaybeError CheckWGPUSuccessImpl(CEnum result, const char* context) {
    using CppEnum = decltype(FromAPI(result));
    const CEnum successValue = ToAPI(CppEnum::Success);
    if (result == successValue) [[likely]] {
        return {};
    }

    return DAWN_FORMAT_INTERNAL_ERROR(" %s failed with (%s)", context, FromAPI(result));
}

// Returns a success only if resultIn is "success", otherwise returns an error with the context and
// stringified resultIn value instead. Can be used like this:
//
//   DAWN_TRY(CheckWGPUSuccess(wgpuDoSomething, "doing something"));
#define CheckWGPUSuccess(resultIn, contextIn) \
    ::dawn::native::webgpu::CheckWGPUSuccessImpl(resultIn, contextIn)

}  // namespace dawn::native::webgpu

#endif  // SRC_DAWN_NATIVE_WEBGPU_WEBGPUERROR_H_