Skip to content

Refactor ResidencyManager query info API. #574

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
Aug 24, 2022
Merged

Refactor ResidencyManager query info API. #574

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: 4 additions & 4 deletions src/fuzzers/D3D12ResidencyManagerFuzzer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ namespace {
if (residencyManager == nullptr) {
return 0;
}
DXGI_QUERY_VIDEO_MEMORY_INFO* segment =
gResidencyManager->GetVideoMemoryInfo(memorySegmentGroup);
return (segment->Budget > segment->CurrentUsage) ? (segment->Budget - segment->CurrentUsage)
: 0;
DXGI_QUERY_VIDEO_MEMORY_INFO segment = {};
gResidencyManager->QueryVideoMemoryInfo(memorySegmentGroup, &segment);
return (segment.Budget > segment.CurrentUsage) ? (segment.Budget - segment.CurrentUsage)
: 0;
}

} // namespace
Expand Down
71 changes: 41 additions & 30 deletions src/gpgmm/d3d12/ResidencyManagerD3D12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,20 @@ namespace gpgmm::d3d12 {
switch (waitedEvent) {
// mBudgetNotificationUpdateEvent
case (WAIT_OBJECT_0 + 0): {
hr = mResidencyManager->UpdateVideoMemorySegments();
if (SUCCEEDED(hr)) {
gpgmm::DebugEvent("ResidencyManager", EventMessageId::BudgetUpdate)
<< "Updated GPU budget from OS notification.";
hr =
mResidencyManager->UpdateMemorySegment(DXGI_MEMORY_SEGMENT_GROUP_LOCAL);
if (FAILED(hr)) {
break;
}

hr = mResidencyManager->UpdateMemorySegment(
DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL);
if (FAILED(hr)) {
break;
}

gpgmm::DebugEvent("ResidencyManager", EventMessageId::BudgetUpdate)
<< "Updated GPU budget from OS notification.";
break;
}
// mUnregisterAndExitEvent
Expand Down Expand Up @@ -181,7 +190,8 @@ namespace gpgmm::d3d12 {
}

// Set the initial video memory limits per segment.
ReturnIfFailed(residencyManager->UpdateVideoMemorySegments());
ReturnIfFailed(residencyManager->UpdateMemorySegment(DXGI_MEMORY_SEGMENT_GROUP_LOCAL));
ReturnIfFailed(residencyManager->UpdateMemorySegment(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL));

// D3D12 has non-zero memory usage even before any resources have been created, and this
// value can vary by OS enviroment. By adding this in addition to the artificial budget
Expand Down Expand Up @@ -381,7 +391,7 @@ namespace gpgmm::d3d12 {

videoMemorySegmentInfo->AvailableForReservation = availableForReservation;

ReturnIfFailed(QueryVideoMemoryInfo(memorySegmentGroup, videoMemorySegmentInfo));
ReturnIfFailed(UpdateMemorySegmentInternal(memorySegmentGroup));

if (pCurrentReservationOut != nullptr) {
*pCurrentReservationOut = videoMemorySegmentInfo->CurrentReservation;
Expand All @@ -390,9 +400,13 @@ namespace gpgmm::d3d12 {
return S_OK;
}

HRESULT ResidencyManager::QueryVideoMemoryInfo(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup,
DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfo) const {
HRESULT ResidencyManager::UpdateMemorySegmentInternal(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup) {
// For UMA adapters, non-local is always zero.
if (mIsUMA && memorySegmentGroup == DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL) {
return S_OK;
}

DXGI_QUERY_VIDEO_MEMORY_INFO queryVideoMemoryInfoOut;
ReturnIfFailed(
mAdapter->QueryVideoMemoryInfo(0, memorySegmentGroup, &queryVideoMemoryInfoOut));
Expand All @@ -403,6 +417,8 @@ namespace gpgmm::d3d12 {
// component from consuming a disproportionate share of memory and ensures that Dawn can
// continue to make forward progress. Note the choice to halve memory is arbitrarily chosen
// and subject to future experimentation.
DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfo = GetVideoMemoryInfo(memorySegmentGroup);

pVideoMemoryInfo->CurrentReservation =
std::min(queryVideoMemoryInfoOut.Budget / 2, pVideoMemoryInfo->AvailableForReservation);

Expand Down Expand Up @@ -448,21 +464,18 @@ namespace gpgmm::d3d12 {
return S_OK;
}

HRESULT ResidencyManager::UpdateVideoMemorySegments() {
HRESULT ResidencyManager::UpdateMemorySegment(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup) {
std::lock_guard<std::mutex> lock(mMutex);
return UpdateVideoMemorySegmentsInternal();
ReturnIfFailed(UpdateMemorySegmentInternal(memorySegmentGroup));
return S_OK;
}

HRESULT ResidencyManager::UpdateVideoMemorySegmentsInternal() {
DXGI_QUERY_VIDEO_MEMORY_INFO* queryVideoMemoryInfo =
GetVideoMemoryInfo(DXGI_MEMORY_SEGMENT_GROUP_LOCAL);

ReturnIfFailed(QueryVideoMemoryInfo(DXGI_MEMORY_SEGMENT_GROUP_LOCAL, queryVideoMemoryInfo));
if (!mIsUMA) {
queryVideoMemoryInfo = GetVideoMemoryInfo(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL);
ReturnIfFailed(
QueryVideoMemoryInfo(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL, queryVideoMemoryInfo));
}
HRESULT ResidencyManager::QueryVideoMemoryInfo(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup,
DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfoOut) {
std::lock_guard<std::mutex> lock(mMutex);
*pVideoMemoryInfoOut = *GetVideoMemoryInfo(memorySegmentGroup);
return S_OK;
}

Expand All @@ -481,19 +494,16 @@ namespace gpgmm::d3d12 {
uint64_t* bytesEvictedOut) {
TRACE_EVENT0(TraceEventCategory::Default, "ResidencyManager.Evict");

DXGI_QUERY_VIDEO_MEMORY_INFO* videoMemorySegmentInfo =
GetVideoMemoryInfo(memorySegmentGroup);

DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfo = GetVideoMemoryInfo(memorySegmentGroup);
if (IsBudgetNotificationUpdatesDisabled()) {
ReturnIfFailed(QueryVideoMemoryInfo(memorySegmentGroup, videoMemorySegmentInfo));
ReturnIfFailed(UpdateMemorySegmentInternal(memorySegmentGroup));
}

const uint64_t currentUsageAfterEvict = bytesToEvict + videoMemorySegmentInfo->CurrentUsage;
const uint64_t currentUsageAfterEvict = bytesToEvict + pVideoMemoryInfo->CurrentUsage;

// Return if we will remain under budget after evict or there is no budget to evict from.
// The latter happens if the first budget change event hasn't happened yet.
if (videoMemorySegmentInfo->Budget == 0 ||
currentUsageAfterEvict < videoMemorySegmentInfo->Budget) {
if (pVideoMemoryInfo->Budget == 0 || currentUsageAfterEvict < pVideoMemoryInfo->Budget) {
return S_OK;
}

Expand All @@ -502,7 +512,7 @@ namespace gpgmm::d3d12 {
// enough memory, we should evict until there is.
std::vector<ID3D12Pageable*> objectsToEvict;
const uint64_t bytesNeededToBeUnderBudget =
currentUsageAfterEvict - videoMemorySegmentInfo->Budget;
currentUsageAfterEvict - pVideoMemoryInfo->Budget;

// Return if nothing needs to be evicted to stay within budget.
if (bytesNeededToBeUnderBudget == 0) {
Expand Down Expand Up @@ -659,7 +669,8 @@ namespace gpgmm::d3d12 {
// never changes (ie. not manually updated or through budget change events), the
// residency manager wouldn't know what to page in or out.
if (IsBudgetNotificationUpdatesDisabled()) {
ReturnIfFailed(UpdateVideoMemorySegmentsInternal());
ReturnIfFailed(UpdateMemorySegmentInternal(DXGI_MEMORY_SEGMENT_GROUP_LOCAL));
ReturnIfFailed(UpdateMemorySegmentInternal(DXGI_MEMORY_SEGMENT_GROUP_NON_LOCAL));
}

GPGMM_TRACE_EVENT_OBJECT_CALL("ResidencyManager.ExecuteCommandLists",
Expand Down
21 changes: 11 additions & 10 deletions src/gpgmm/d3d12/ResidencyManagerD3D12.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,15 +209,16 @@ namespace gpgmm::d3d12 {
/** \brief Get the current budget and memory usage.

@param memorySegmentGroup Memory segment to retrieve info from.

\return A pointer to DXGI_QUERY_VIDEO_MEMORY_INFO struct of the video memory segment info.
@param[out] pVideoMemoryInfoOut Pointer to DXGI_QUERY_VIDEO_MEMORY_INFO to populate.
*/
DXGI_QUERY_VIDEO_MEMORY_INFO* GetVideoMemoryInfo(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup);
HRESULT QueryVideoMemoryInfo(const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup,
DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfoOut);

/** \brief Manually update the video memory budgets.
*/
HRESULT UpdateVideoMemorySegments();
/** \brief Update and retrieve the current budget and memory usage.

@param memorySegmentGroup Memory segment to update info.
*/
HRESULT UpdateMemorySegment(const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup);

/** \brief Return the current residency manager usage.

Expand Down Expand Up @@ -268,10 +269,10 @@ namespace gpgmm::d3d12 {

LRUCache* GetVideoMemorySegmentCache(const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup);

HRESULT QueryVideoMemoryInfo(const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup,
DXGI_QUERY_VIDEO_MEMORY_INFO* pVideoMemoryInfo) const;
DXGI_QUERY_VIDEO_MEMORY_INFO* GetVideoMemoryInfo(
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup);

HRESULT UpdateVideoMemorySegmentsInternal();
HRESULT UpdateMemorySegmentInternal(const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup);

HRESULT StartBudgetNotificationUpdates();
void StopBudgetNotificationUpdates();
Expand Down
8 changes: 4 additions & 4 deletions src/tests/end2end/D3D12ResidencyManagerTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ class D3D12ResidencyManagerTests : public D3D12TestBase, public ::testing::Test

uint64_t GetBudgetLeft(ResidencyManager* residencyManager,
const DXGI_MEMORY_SEGMENT_GROUP& memorySegmentGroup) {
DXGI_QUERY_VIDEO_MEMORY_INFO* segment =
residencyManager->GetVideoMemoryInfo(memorySegmentGroup);
return (segment->Budget > segment->CurrentUsage) ? (segment->Budget - segment->CurrentUsage)
: 0;
DXGI_QUERY_VIDEO_MEMORY_INFO segment = {};
residencyManager->QueryVideoMemoryInfo(memorySegmentGroup, &segment);
return (segment.Budget > segment.CurrentUsage) ? (segment.Budget - segment.CurrentUsage)
: 0;
}
};

Expand Down