Skip to content

Improve debug name error handling. #489

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

Merged
merged 1 commit into from
Jul 6, 2022
Merged

Improve debug name error handling. #489

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
8 changes: 3 additions & 5 deletions src/gpgmm/d3d12/JSONSerializerD3D12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,9 @@ namespace gpgmm::d3d12 {
dict.AddItem("OffsetFromResource", desc.OffsetFromResource);
dict.AddItem("Method", desc.Method);
dict.AddItem("ResourceHeap", gpgmm::JSONSerializer::Serialize(desc.ResourceHeap));
if (!desc.DebugName.empty()) {
dict.AddItem("DebugName", desc.DebugName);
}
return dict;
}

Expand All @@ -181,11 +184,6 @@ namespace gpgmm::d3d12 {
JSONDict dict;
dict.AddItem("SizeInBytes", info.SizeInBytes);
dict.AddItem("Alignment", info.Alignment);

if (!info.DebugName.empty()) {
dict.AddItem("DebugName", info.DebugName);
}

return dict;
}

Expand Down
24 changes: 23 additions & 1 deletion src/gpgmm/d3d12/ResourceAllocationD3D12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,28 @@ namespace gpgmm::d3d12 {

} // namespace

// static
HRESULT ResourceAllocation::CreateResourceAllocation(
const RESOURCE_ALLOCATION_DESC& descriptor,
ResidencyManager* residencyManager,
MemoryAllocator* allocator,
MemoryBlock* block,
ComPtr<ID3D12Resource> resource,
ResourceAllocation** ppResourceAllocationOut) {
std::unique_ptr<ResourceAllocation> resourceAllocation(new ResourceAllocation(
descriptor, residencyManager, allocator, block, std::move(resource)));

if (!descriptor.DebugName.empty()) {
ReturnIfFailed(resourceAllocation->SetDebugName(descriptor.DebugName));
}

if (ppResourceAllocationOut != nullptr) {
*ppResourceAllocationOut = resourceAllocation.release();
}

return S_OK;
}

ResourceAllocation::ResourceAllocation(const RESOURCE_ALLOCATION_DESC& desc,
ResidencyManager* residencyManager,
MemoryAllocator* allocator,
Expand Down Expand Up @@ -145,7 +167,7 @@ namespace gpgmm::d3d12 {
}

RESOURCE_ALLOCATION_INFO ResourceAllocation::GetInfo() const {
return {GetSize(), GetAlignment(), GetDebugName()};
return {GetSize(), GetAlignment()};
}

const char* ResourceAllocation::GetTypename() const {
Expand Down
27 changes: 18 additions & 9 deletions src/gpgmm/d3d12/ResourceAllocationD3D12.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ namespace gpgmm::d3d12 {
Must be valid for the duration of the resource allocation.
*/
Heap* ResourceHeap;

/** \brief Debug name associated with the resource allocation.
*/
std::string DebugName;
};

/** \struct RESOURCE_ALLOCATION_INFO
Expand All @@ -79,10 +83,6 @@ namespace gpgmm::d3d12 {
Must be non-zero.
*/
uint64_t Alignment;

/** \brief Debug name associated with the resource allocation.
*/
std::string DebugName;
};

/** \brief ResourceAllocation is MemoryAllocation that contains a ID3D12Resource.
Expand All @@ -108,12 +108,15 @@ namespace gpgmm::d3d12 {
resource.
@param block A pointer to MemoryBlock which describes the region in Heap being allocated.
@param resource A pointer to the ID3D12Resource used for the allocation.
@param[out] ppResourceAllocationOut Pointer to a resource allocation that recieves a pointer
to the resource allocation.
*/
ResourceAllocation(const RESOURCE_ALLOCATION_DESC& desc,
ResidencyManager* residencyManager,
MemoryAllocator* allocator,
MemoryBlock* block,
ComPtr<ID3D12Resource> resource);
static HRESULT CreateResourceAllocation(const RESOURCE_ALLOCATION_DESC& desc,
ResidencyManager* residencyManager,
MemoryAllocator* allocator,
MemoryBlock* block,
ComPtr<ID3D12Resource> resource,
ResourceAllocation** ppResourceAllocationOut);

~ResourceAllocation() override;

Expand Down Expand Up @@ -195,6 +198,12 @@ namespace gpgmm::d3d12 {
Heap* GetMemory() const;

private:
ResourceAllocation(const RESOURCE_ALLOCATION_DESC& desc,
ResidencyManager* residencyManager,
MemoryAllocator* allocator,
MemoryBlock* block,
ComPtr<ID3D12Resource> resource);

// Only DebugResourceAllocator may inject itself to ensure |this| cannot leak.
friend DebugResourceAllocator;
void SetDebugAllocator(MemoryAllocator* allocator);
Expand Down
31 changes: 17 additions & 14 deletions src/gpgmm/d3d12/ResourceAllocatorD3D12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,10 +685,6 @@ namespace gpgmm::d3d12 {
initialResourceState, pClearValue,
ppResourceAllocationOut));

if (!allocationDescriptor.DebugName.empty()) {
(*ppResourceAllocationOut)->SetDebugName(allocationDescriptor.DebugName);
}

// Insert a new (debug) allocator layer into the allocation so it can report details used
// during leak checks. Since we don't want to use it unless we are debugging, we hide it
// behind a macro.
Expand Down Expand Up @@ -837,10 +833,12 @@ namespace gpgmm::d3d12 {
allocationDesc.Method = AllocationMethod::kSubAllocatedWithin;
allocationDesc.OffsetFromResource = subAllocation.GetOffset();
allocationDesc.ResourceHeap = resourceHeap;
allocationDesc.DebugName = allocationDescriptor.DebugName;

*ppResourceAllocationOut = new ResourceAllocation{
ReturnIfFailed(ResourceAllocation::CreateResourceAllocation(
allocationDesc, mResidencyManager.Get(), subAllocation.GetAllocator(),
subAllocation.GetBlock(), std::move(committedResource)};
subAllocation.GetBlock(), std::move(committedResource),
ppResourceAllocationOut));

return S_OK;
}));
Expand Down Expand Up @@ -876,10 +874,12 @@ namespace gpgmm::d3d12 {
allocationDesc.Method = subAllocation.GetMethod();
allocationDesc.OffsetFromResource = 0;
allocationDesc.ResourceHeap = resourceHeap;
allocationDesc.DebugName = allocationDescriptor.DebugName;

*ppResourceAllocationOut = new ResourceAllocation{
ReturnIfFailed(ResourceAllocation::CreateResourceAllocation(
allocationDesc, mResidencyManager.Get(), subAllocation.GetAllocator(),
subAllocation.GetBlock(), std::move(placedResource)};
subAllocation.GetBlock(), std::move(placedResource),
ppResourceAllocationOut));

return S_OK;
}));
Expand Down Expand Up @@ -915,10 +915,11 @@ namespace gpgmm::d3d12 {
allocationDesc.Method = allocation.GetMethod();
allocationDesc.OffsetFromResource = 0;
allocationDesc.ResourceHeap = resourceHeap;
allocationDesc.DebugName = allocationDescriptor.DebugName;

*ppResourceAllocationOut = new ResourceAllocation{
ReturnIfFailed(ResourceAllocation::CreateResourceAllocation(
allocationDesc, mResidencyManager.Get(), allocation.GetAllocator(),
allocation.GetBlock(), std::move(placedResource)};
allocation.GetBlock(), std::move(placedResource), ppResourceAllocationOut));

return S_OK;
}));
Expand Down Expand Up @@ -956,9 +957,11 @@ namespace gpgmm::d3d12 {
allocationDesc.Method = AllocationMethod::kStandalone;
allocationDesc.OffsetFromResource = 0;
allocationDesc.ResourceHeap = resourceHeap;
allocationDesc.DebugName = allocationDescriptor.DebugName;

*ppResourceAllocationOut = new ResourceAllocation{
allocationDesc, mResidencyManager.Get(), this, nullptr, std::move(committedResource)};
ReturnIfFailed(ResourceAllocation::CreateResourceAllocation(
allocationDesc, mResidencyManager.Get(), this, nullptr, std::move(committedResource),
ppResourceAllocationOut));

return S_OK;
}
Expand Down Expand Up @@ -1005,8 +1008,8 @@ namespace gpgmm::d3d12 {
allocationDesc.OffsetFromResource = 0;
allocationDesc.ResourceHeap = resourceHeap;

*ppResourceAllocationOut =
new ResourceAllocation{allocationDesc, nullptr, this, nullptr, std::move(resource)};
ReturnIfFailed(ResourceAllocation::CreateResourceAllocation(
allocationDesc, nullptr, this, nullptr, std::move(resource), ppResourceAllocationOut));

return S_OK;
}
Expand Down
12 changes: 12 additions & 0 deletions src/tests/end2end/D3D12ResourceAllocatorTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,18 @@ TEST_F(D3D12ResourceAllocatorTests, CreateBuffer) {
allocationDescWithInvalidHeapFlags, CreateBasicBufferDesc(kDefaultBufferSize),
D3D12_RESOURCE_STATE_COMMON, nullptr, &allocation));
}

// Creating a buffer with a name should be always specified.
{
ComPtr<ResourceAllocation> allocation;
ALLOCATION_DESC allocationDesc = {};
allocationDesc.DebugName = "Buffer";
ASSERT_SUCCEEDED(resourceAllocator->CreateResource(
allocationDesc, CreateBasicBufferDesc(kDefaultBufferSize), D3D12_RESOURCE_STATE_COMMON,
nullptr, &allocation));
ASSERT_NE(allocation, nullptr);
EXPECT_EQ(allocation->GetDebugName(), allocationDesc.DebugName);
}
}

TEST_F(D3D12ResourceAllocatorTests, CreateSmallTexture) {
Expand Down