hal/vulkan/status_util.h

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef IREE_HAL_VULKAN_STATUS_UTIL_H_
#define IREE_HAL_VULKAN_STATUS_UTIL_H_

#include <vulkan/vulkan.h>

#include "base/status.h"

namespace iree {
namespace hal {
namespace vulkan {

// RETURN_IF_ERROR but implicitly converts the VkResult return value to
// a Status.
//
// Usage:
//   VK_RETURN_IF_ERROR(vkDoThing(...));
#define VK_RETURN_IF_ERROR(expr) \
  RETURN_IF_ERROR(::iree::hal::vulkan::VkResultToStatus(expr))

// CHECK_OK but implicitly converts the VkResults return value to a
// Status and checks that it is OkStatus.
//
// Usage:
//   VK_CHECK_OK(vkDoThing(...));
#define VK_CHECK_OK(expr) CHECK_OK(::iree::hal::vulkan::VkResultToStatus(expr))

// Converts a VkResult to a Status object.
//
// Vulkan considers the following as "success codes" and users should ensure
// they first check the result prior to converting:
//
// - VK_SUCCESS        -> OkStatus()
// - VK_NOT_READY      -> OkStatus()
// - VK_TIMEOUT        -> OkStatus()
// - VK_EVENT_SET      -> OkStatus()
// - VK_EVENT_RESET    -> OkStatus()
// - VK_INCOMPLETE     -> OkStatus()
// - VK_SUBOPTIMAL_KHR -> OkStatus()
//
// The rest are considered as "error codes":
//
// - VK_ERROR_OUT_OF_HOST_MEMORY          -> ResourceExhaustedError("VK...")
// - VK_ERROR_OUT_OF_DEVICE_MEMORY        -> ResourceExhaustedError("VK...")
// - VK_ERROR_INITIALIZATION_FAILED       -> InternalError("VK...")
// - VK_ERROR_DEVICE_LOST                 -> InternalError("VK...")
// - VK_ERROR_MEMORY_MAP_FAILED           -> InternalError("VK...")
// - VK_ERROR_LAYER_NOT_PRESENT           -> NotFoundError("VK...")
// - VK_ERROR_EXTENSION_NOT_PRESENT       -> NotFoundError("VK...")
// - VK_ERROR_FEATURE_NOT_PRESENT         -> NotFoundError("VK...")
// - VK_ERROR_INCOMPATIBLE_DRIVER         -> FailedPreconditionError("VK...")
// - VK_ERROR_TOO_MANY_OBJECTS            -> ResourceExhaustedError("VK...")
// - VK_ERROR_FORMAT_NOT_SUPPORTED        -> UnimplementedError("VK...")
// - VK_ERROR_FRAGMENTED_POOL             -> ResourceExhaustedError("VK...")
// - VK_ERROR_OUT_OF_POOL_MEMORY          -> ResourceExhaustedError("VK...")
// - VK_ERROR_INVALID_EXTERNAL_HANDLE     -> InvalidArgumentError("VK...")
// - VK_ERROR_SURFACE_LOST_KHR            -> InternalError("VK...")
// - VK_ERROR_NATIVE_WINDOW_IN_USE_KHR    -> InternalError("VK...")
// - VK_ERROR_OUT_OF_DATE_KHR             -> InternalError("VK...")
// - VK_ERROR_INCOMPATIBLE_DISPLAY_KHR    -> InternalError("VK...")
// - VK_ERROR_VALIDATION_FAILED_EXT       -> InternalError("VK...")
// - VK_ERROR_INVALID_SHADER_NV           -> InternalError("VK...")
// - VK_ERROR_INVALID_DRM_FORMAT_MODIFIER_PLANE_LAYOUT_EXT  -> InternalError
// - VK_ERROR_FRAGMENTATION_EXT           -> ResourceExhaustedError("VK...")
// - VK_ERROR_NOT_PERMITTED_EXT           -> PermissionDeniedError("VK...")
// - VK_ERROR_INVALID_DEVICE_ADDRESS_EXT  -> OutOfRangeError("VK...")
// - VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT -> InternalError("VK...")
Status VkResultToStatus(VkResult result);

}  // namespace vulkan
}  // namespace hal
}  // namespace iree

#endif  // IREE_HAL_VULKAN_STATUS_UTIL_H_