Skip to content

[VK] Surface validation errors as errors #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[VK] Surface validation errors as errors #425

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
251 changes: 155 additions & 96 deletions lib/API/VK/Device.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,55 +114,9 @@ static std::string getMessageSeverityString(
static VkBool32
debugCallback(VkDebugUtilsMessageSeverityFlagBitsEXT MessageSeverity,
VkDebugUtilsMessageTypeFlagsEXT MessageType,
const VkDebugUtilsMessengerCallbackDataEXT *Data, void *) {
// Only interested in messages from the validation layers.
if (!(MessageType & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT))
return VK_FALSE;

llvm::dbgs() << "Validation " << getMessageSeverityString(MessageSeverity);
llvm::dbgs() << ": [ " << Data->pMessageIdName << " ]\n";
llvm::dbgs() << Data->pMessage;

for (uint32_t I = 0; I < Data->objectCount; I++) {
llvm::dbgs() << '\n';
if (Data->pObjects[I].pObjectName) {
llvm::dbgs() << "[" << Data->pObjects[I].pObjectName << "]";
}
}
llvm::dbgs() << '\n';
const VkDebugUtilsMessengerCallbackDataEXT *Data, void *);

// Return true to turn the validation error or warning into an error in the
// vulkan API. This should causes tests to fail.
const bool IsErrorOrWarning =
MessageSeverity & (VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT);
if (IsErrorOrWarning)
return VK_TRUE;

// Continue to run even with VERBOSE and INFO messages.
return VK_FALSE;
}

static VkDebugUtilsMessengerEXT registerDebugUtilCallback(VkInstance Instance) {
VkDebugUtilsMessengerCreateInfoEXT CreateInfo = {};
CreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
CreateInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
CreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
CreateInfo.pfnUserCallback = debugCallback;
CreateInfo.pUserData = nullptr; // Optional
auto Func = (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
Instance, "vkCreateDebugUtilsMessengerEXT");
if (Func == nullptr)
return VK_NULL_HANDLE;

VkDebugUtilsMessengerEXT DebugMessenger;
Func(Instance, &CreateInfo, nullptr, &DebugMessenger);
return DebugMessenger;
}
static VkDebugUtilsMessengerEXT registerDebugUtilCallback(VkInstance Instance);

namespace {

Expand Down Expand Up @@ -1164,57 +1118,15 @@ class VKDevice : public offloadtest::Device {
return llvm::Error::success();
}

llvm::Error executeProgram(Pipeline &P) override {
InvocationState State;
if (auto Err = createDevice(State))
return Err;
llvm::outs() << "Physical device created.\n";
if (auto Err = createCommandBuffer(State))
return Err;
llvm::outs() << "Copy command buffer created.\n";
if (auto Err = createBuffers(P, State))
return Err;
llvm::outs() << "Memory buffers created.\n";
if (auto Err = executeCommandBuffer(State))
return Err;
llvm::outs() << "Executed copy command buffer.\n";
if (auto Err = createCommandBuffer(State))
return Err;
llvm::outs() << "Execute command buffer created.\n";
if (auto Err = createDescriptorPool(P, State))
return Err;
llvm::outs() << "Descriptor pool created.\n";
if (auto Err = createDescriptorSets(P, State))
return Err;
llvm::outs() << "Descriptor sets created.\n";
if (auto Err = createShaderModule(P.Shaders[0].Shader->getBuffer(), State))
return Err;
llvm::outs() << "Shader module created.\n";
if (auto Err = createPipeline(P, State))
return Err;
llvm::outs() << "Compute pipeline created.\n";
if (auto Err = createComputeCommands(P, State))
return Err;
llvm::outs() << "Compute commands created.\n";
if (auto Err = executeCommandBuffer(State, VK_PIPELINE_STAGE_TRANSFER_BIT))
return Err;
llvm::outs() << "Executed compute command buffer.\n";
if (auto Err = readBackData(P, State))
return Err;
llvm::outs() << "Compute pipeline created.\n";

if (auto Err = cleanup(State))
return Err;
llvm::outs() << "Cleanup complete.\n";
return llvm::Error::success();
}
llvm::Error executeProgram(Pipeline &P) override;
};

class VKContext {
private:
VkInstance Instance = VK_NULL_HANDLE;
VkDebugUtilsMessengerEXT DebugMessenger = VK_NULL_HANDLE;
llvm::SmallVector<std::shared_ptr<VKDevice>> Devices;
std::optional<llvm::Error> Err = std::nullopt;
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could probably just be an llvm::Error that's initialized to Error::success(). If that's more awkward to work with or less clear though this way is totally fine.


VKContext() = default;
~VKContext() { cleanup(); }
Expand All @@ -1226,6 +1138,22 @@ class VKContext {
return Ctx;
}

void raiseError(llvm::Error E) {
if (Err.has_value())
Err = llvm::joinErrors(std::move(*Err), std::move(E));
else
Err = std::move(E);
}

bool hasError() const { return Err.has_value(); }

llvm::Error takeError() {
assert(Err.has_value());
llvm::Error E = std::move(*Err);
Err = std::nullopt;
return E;
}

void cleanup() {
#ifndef NDEBUG
auto Func = (PFN_vkDestroyDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
Expand Down Expand Up @@ -1316,10 +1244,8 @@ class VKContext {
return llvm::createStringError(std::errc::no_such_device,
"Unknown Vulkan initialization error %d",
Res);

#ifndef NDEBUG
DebugMessenger = registerDebugUtilCallback(Instance);
#endif
if (Config.EnableValidationLayer || Config.EnableDebugLayer)
DebugMessenger = registerDebugUtilCallback(Instance);

DeviceCount = 0;
if (vkEnumeratePhysicalDevices(Instance, &DeviceCount, nullptr))
Expand All @@ -1346,3 +1272,136 @@ llvm::Error Device::initializeVKDevices(const DeviceConfig Config) {
}

void Device::cleanupVKDevices() { VKContext::instance().cleanup(); }

class VKValidationError : public llvm::ErrorInfo<VKValidationError> {
public:
static char ID;

VKValidationError(VkDebugUtilsMessageSeverityFlagBitsEXT Severity,
const VkDebugUtilsMessengerCallbackDataEXT *Data)
: MessageSeverity(Severity) {
MessageID = Data->pMessageIdName;
Message = Data->pMessage;
for (uint32_t I = 0; I < Data->objectCount; I++)
if (Data->pObjects[I].pObjectName)
Objects.emplace_back(std::string(Data->pObjects[I].pObjectName));
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Calling emplace_back with a temporary is silly - this should just be push_back

Suggested change
Objects.emplace_back(std::string(Data->pObjects[I].pObjectName));
Objects.push_back(std::string(Data->pObjects[I].pObjectName));

}

void log(llvm::raw_ostream &OS) const override {
OS << "Validation " << getMessageSeverityString(MessageSeverity);
OS << ": [ " << MessageID << " ]\n";
OS << Message;

for (const auto &S : Objects)
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think auto helps here.

Suggested change
for (const auto &S : Objects)
for (const std::string &S : Objects)

OS << "\n[" << S << "]";
OS << '\n';
}

std::error_code convertToErrorCode() const override {
return llvm::inconvertibleErrorCode();
}

private:
VkDebugUtilsMessageSeverityFlagBitsEXT MessageSeverity;
std::string Message;
std::string MessageID;
std::vector<std::string> Objects;
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SmallVector would be slightly more efficient here (it doesn't really matter though)

};

char VKValidationError::ID = 0;

static VkBool32
debugCallback(VkDebugUtilsMessageSeverityFlagBitsEXT MessageSeverity,
VkDebugUtilsMessageTypeFlagsEXT MessageType,
const VkDebugUtilsMessengerCallbackDataEXT *Data, void *) {
// Only interested in messages from the validation layers.
if (!(MessageType & VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT))
return VK_FALSE;

llvm::Error Err = llvm::make_error<VKValidationError>(MessageSeverity, Data);

// Return true to turn the validation error or warning into an error in the
// vulkan API. This should causes tests to fail.
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// vulkan API. This should causes tests to fail.
// vulkan API. This should cause tests to fail.

const bool IsErrorOrWarning =
MessageSeverity & (VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT);
if (IsErrorOrWarning) {
VKContext::instance().raiseError(std::move(Err));
return VK_TRUE;
}

// Log verbose an info messages and continue.
llvm::logAllUnhandledErrors(std::move(Err), llvm::dbgs());

// Continue to run even with VERBOSE and INFO messages.
return VK_FALSE;
Comment on lines +1333 to +1337
Copy link
Collaborator

@bogner bogner Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second comment here seems a bit redundant, and there's a typo in the first.

Suggested change
// Log verbose an info messages and continue.
llvm::logAllUnhandledErrors(std::move(Err), llvm::dbgs());
// Continue to run even with VERBOSE and INFO messages.
return VK_FALSE;
// Log verbose and info messages and continue.
llvm::logAllUnhandledErrors(std::move(Err), llvm::dbgs());
return VK_FALSE;

}

static VkDebugUtilsMessengerEXT registerDebugUtilCallback(VkInstance Instance) {
VkDebugUtilsMessengerCreateInfoEXT CreateInfo = {};
CreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
CreateInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT;
CreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT |
VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
CreateInfo.pfnUserCallback = debugCallback;
CreateInfo.pUserData = nullptr; // Optional
auto Func = (PFN_vkCreateDebugUtilsMessengerEXT)vkGetInstanceProcAddr(
Instance, "vkCreateDebugUtilsMessengerEXT");
if (Func == nullptr)
return VK_NULL_HANDLE;

VkDebugUtilsMessengerEXT DebugMessenger;
Func(Instance, &CreateInfo, nullptr, &DebugMessenger);
return DebugMessenger;
}

llvm::Error VKDevice::executeProgram(Pipeline &P) {
InvocationState State;
if (auto Err = createDevice(State))
return Err;
llvm::outs() << "Physical device created.\n";
if (auto Err = createCommandBuffer(State))
return Err;
llvm::outs() << "Copy command buffer created.\n";
if (auto Err = createBuffers(P, State))
return Err;
llvm::outs() << "Memory buffers created.\n";
if (auto Err = executeCommandBuffer(State))
return Err;
llvm::outs() << "Executed copy command buffer.\n";
if (auto Err = createCommandBuffer(State))
return Err;
llvm::outs() << "Execute command buffer created.\n";
if (auto Err = createDescriptorPool(P, State))
return Err;
llvm::outs() << "Descriptor pool created.\n";
if (auto Err = createDescriptorSets(P, State))
return Err;
llvm::outs() << "Descriptor sets created.\n";
if (auto Err = createShaderModule(P.Shaders[0].Shader->getBuffer(), State))
return Err;
llvm::outs() << "Shader module created.\n";
if (auto Err = createPipeline(P, State))
return Err;
llvm::outs() << "Compute pipeline created.\n";
if (auto Err = createComputeCommands(P, State))
return Err;
llvm::outs() << "Compute commands created.\n";
if (auto Err = executeCommandBuffer(State, VK_PIPELINE_STAGE_TRANSFER_BIT))
return Err;
llvm::outs() << "Executed compute command buffer.\n";
if (auto Err = readBackData(P, State))
return Err;
llvm::outs() << "Compute pipeline created.\n";

if (auto Err = cleanup(State))
return Err;
llvm::outs() << "Cleanup complete.\n";

if (VKContext::instance().hasError())
return VKContext::instance().takeError();
return llvm::Error::success();
}
Loading