Skip to content

layersvt: Key DebugMarker object names by device #46

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
olehkuznetsov wants to merge 1 commit into
base: pr-debugmarker-clock-pid
Choose a base branch
from
Open

layersvt: Key DebugMarker object names by device #46

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions layersvt/debug_marker/debug_marker.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ void DebugMarker::SetDebugObjectName(uint64_t device, int32_t type, uint64_t han
std::lock_guard<std::mutex> lock(mutex_);

std::string name_str = name ? name : "NULL";
debug_object_names_[std::make_pair(type, handle)] = DebugObjectName(device, type, handle, name_str);
debug_object_names_[std::make_tuple(device, type, handle)] = DebugObjectName(device, type, handle, name_str);
EmitDebugObjectNamePacket(device, type, handle, name_str);
}

Expand All @@ -109,9 +109,9 @@ void DebugMarker::EmitAllDebugMarkers() {
}
}

bool DebugMarker::HasDebugObjectName(int32_t type, uint64_t handle, const std::string& name) {
bool DebugMarker::HasDebugObjectName(uint64_t device, int32_t type, uint64_t handle, const std::string& name) {
std::lock_guard<std::mutex> lock(mutex_);
auto it = debug_object_names_.find(std::make_pair(type, handle));
auto it = debug_object_names_.find(std::make_tuple(device, type, handle));
if (it == debug_object_names_.end()) return false;
return it->second.name == name;
}
Expand Down
9 changes: 5 additions & 4 deletions layersvt/debug_marker/debug_marker.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

#include <map>
#include <string>
#include <tuple>
#include <vector>

#include "common/layer_base.h"
Expand Down Expand Up @@ -79,7 +80,7 @@ class DebugMarker : public layersvt::LayerBase {
* @brief Checks if a debug name is stored for a given object.
* @note This function is for testing only.
*/
bool HasDebugObjectName(int32_t type, uint64_t handle, const std::string& name);
bool HasDebugObjectName(uint64_t device, int32_t type, uint64_t handle, const std::string& name);

/**
* @brief Emulated VK_EXT_debug_utils messengers, used for instances whose downstream lacks the
Expand Down Expand Up @@ -128,10 +129,10 @@ class DebugMarker : public layersvt::LayerBase {

std::mutex mutex_;
/**
* @brief Maps a pair of (object_type, object_handle) to its debug name information.
* We use a pair as the key because handles are not guaranteed to be unique across different object types.
* @brief Maps (vk_device, object_type, object_handle) to its debug name information.
* Non-dispatchable handles are not guaranteed to be unique across object types or devices.
*/
std::map<std::pair<int32_t, uint64_t>, DebugObjectName> debug_object_names_;
std::map<std::tuple<uint64_t, int32_t, uint64_t>, DebugObjectName> debug_object_names_;

struct EmulatedMessenger {
VkInstance instance;
Expand Down
32 changes: 22 additions & 10 deletions layersvt/test/test_debugmarker.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,16 @@ TEST_F(DebugMarkerTests, CombinedTest) {
// 1. Set instance name
DebugMarker::Get().SetDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstance");

EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstance"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstance"));

// 2. Override new name
DebugMarker::Get().SetDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstanceRenamed");
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstanceRenamed"));
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstance"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstanceRenamed"));
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstance"));

// 3. Reset
layer_test::ResetLayer<DebugMarker>();
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstanceRenamed"));
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(0, VK_OBJECT_TYPE_INSTANCE, (uint64_t)instance, "MyInstanceRenamed"));
}

TEST_F(DebugMarkerTests, ManifestTest) {
Expand Down Expand Up @@ -160,18 +160,30 @@ TEST_F(DebugMarkerTests, PreDestroyDeviceCleanupTest) {
DebugMarker::Get().SetDebugObjectName((uint64_t)dev1, VK_OBJECT_TYPE_BUFFER, 0x1111, "Buffer1");
DebugMarker::Get().SetDebugObjectName((uint64_t)dev2, VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2");

EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x1111, "Buffer1"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName((uint64_t)dev1, VK_OBJECT_TYPE_BUFFER, 0x1111, "Buffer1"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName((uint64_t)dev2, VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));

// Destroy dev1 - should remove Buffer1 but keep Buffer2
layersvt::LayerBaseTestPeer::DestroyDevice(dev1, nullptr);

EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x1111, "Buffer1"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName((uint64_t)dev1, VK_OBJECT_TYPE_BUFFER, 0x1111, "Buffer1"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName((uint64_t)dev2, VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));

// Destroy dev2 - should remove Buffer2
layersvt::LayerBaseTestPeer::DestroyDevice(dev2, nullptr);
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));
EXPECT_FALSE(DebugMarker::Get().HasDebugObjectName((uint64_t)dev2, VK_OBJECT_TYPE_BUFFER, 0x2222, "Buffer2"));
}

TEST_F(DebugMarkerTests, SameHandleOnDifferentDevicesTest) {
TEST_DESCRIPTION("Verify identical handles owned by different devices keep separate names");

const uint64_t device1 = 0x1000;
const uint64_t device2 = 0x2000;
DebugMarker::Get().SetDebugObjectName(device1, VK_OBJECT_TYPE_BUFFER, 0x1, "Device1Buffer");
DebugMarker::Get().SetDebugObjectName(device2, VK_OBJECT_TYPE_BUFFER, 0x1, "Device2Buffer");

EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(device1, VK_OBJECT_TYPE_BUFFER, 0x1, "Device1Buffer"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(device2, VK_OBJECT_TYPE_BUFFER, 0x1, "Device2Buffer"));
}

TEST_F(DebugMarkerTests, TemplateMethodDispatchTest) {
Expand Down Expand Up @@ -253,7 +265,7 @@ TEST_F(DebugMarkerTests, MissingDownstreamExtensionTest) {
name_info.objectHandle = 0x4444;
name_info.pObjectName = "Buffer";
EXPECT_EQ(set_object_name(mock_device, &name_info), VK_SUCCESS);
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName(VK_OBJECT_TYPE_BUFFER, 0x4444, "Buffer"));
EXPECT_TRUE(DebugMarker::Get().HasDebugObjectName((uint64_t)mock_device, VK_OBJECT_TYPE_BUFFER, 0x4444, "Buffer"));
}

namespace {
Expand Down
Loading