Use memory mapped files for D3D9 texture mapping data #2663

K0bin · 2022-06-02T00:18:39Z

In order to finally fix some of our address space problems, I took a page out of Gallium Nine's book.

Most resources require a copy in system memory that we have to keep around in order to avoid stalling in Lock* calls. Those take up a lot of address space leading to crashes when we exhaust the 2 or respectively 3GB (with LAA) of address space.

To avoid that, we need to unmap resources once the application is done with them on the CPU. In theory that is possible with Vulkan memory, there is however two problems with doing it with Vulkan memory directly:

The DXVK memory allocator and buffer system is not designed with this in mind.
Nvidia seems to map host visible Vulkan memory when it is allocated. (@DadSchoorse tested that.)

To work around those limitations, we use Win32 memory mapped files. Those can be mapped and unmapped as we please.

Allocation & Mapping

We suballocate from 64MB memory mapped files to avoid overhead of allocating those. 64MB is quite a lot so we try to lock at the level of a suballocation. There is however a problem with that: MapViewOfFile requires the offset to be aligned to the memory allocation granularity which is 65k. To avoid a lot of wasted memory and address space and lots of MapViewOfFile calls for tiny resources, there are two strategies. We try to allocate tightly packed, so we cannot guarantee the alignment. Every mem file is split up into "mapping pages" that are 1MB (+- alignment to 65k) each. When a resource gets mapped, we either map the entire page or reuse the existing pointer. If a resource is either larger than such a page or crosses from one page to another, it gets a separate mapping. We round down the offset to 65k and increase the size accordingly.

D3D resources

We use memory mapped files for all texture types, except ones placed in D3DPOOL_DEFAULT. I originally used it for buffers too but dropped that because Crysis apparently reads or writes from/to a locking pointer outside of the correct scope. That's not super rare either according to Joshua.

GPU Readback

D3DPOOL_SYSTEMMEM textures can be written by the GPU with functions like GetRenderTargetData. When that happens, we lazily create a DXVK buffer and use that instead of the memory mapped file allocation for all future locking calls. That works well because GetRendertargetData and GetFrontbufferData usually overwrite the entire image. We compare the texture sizes and when the destination texture is smaller, we copy over the data from the memory mapped file. After that, we free that and use the buffer for everything else.

Unmapping

Unmapping is done using a least recently used list. There is a configurable virtual memory budget which is set to 100MB by default. Once we cross that, we start unmapping old resources all the way until we are only using 3/4th of the budget.
We can only unmap resources that aren't currently locked, otherwise we could be potentially invalidating a pointer that the application is still going to use.

64 bit builds & DXVK Native

All of this is only enabled for 32bit Win32 builds. It gets removed by the preprocessor otherwise.

Cleanup

I removed the direct upload path and because we pretty much always use the staging buffer upload path now anyway. It's necessary for the memory mapped files to work and the direct path was only implemented because I was worried about raised address space usage. We now have a better solution for that. Along with that, there's some nice cleanup in the LockImage/LockBuffer functions.

I also removed evictManagedOnUnlock. This PR basically solves the same problem without the downsides. The option has never really been useful as pretty much all games that tended to crash also relied on the system memory copies to avoid terrible hitches.

qinlili23333 · 2022-06-02T03:06:17Z

In my own test, this PR make Saints Rows 2 even worse. In #2524 , Saints Rows 2 will stuck in new game loading screen and then crash. In this PR's artifacts , the game directly crash when choose new game in menu. And the mose weird thing is that no error can be found in log file.

sr2_pc_d3d9.log

info:  Game: sr2_pc.exe
info:  DXVK: v1.10.1
info:  Found config file: dxvk.conf
info:  Effective configuration:
info:    d3d9.maxFrameLatency = 1
info:    dxgi.maxFrameLatency = 1
info:  Built-in extension providers:
info:    Win32 WSI
info:    OpenVR
info:    OpenXR
info:  OpenVR: could not open registry key, status 2
info:  OpenVR: Failed to locate module
info:  Enabled instance extensions:
info:    VK_KHR_get_surface_capabilities2
info:    VK_KHR_surface
info:    VK_KHR_win32_surface
info:  D3D9: VK_FORMAT_D16_UNORM_S8_UINT -> VK_FORMAT_D24_UNORM_S8_UINT
info:  NVIDIA GeForce RTX 3060 Laptop GPU:
info:    Driver: 512.96.0
info:    Vulkan: 1.3.194
info:    Memory Heap[0]: 
info:      Size: 6023 MiB
info:      Flags: 0x1
info:      Memory Type[1]: Property Flags = 0x1
info:      Memory Type[4]: Property Flags = 0x7
info:    Memory Heap[1]: 
info:      Size: 32652 MiB
info:      Flags: 0x0
info:      Memory Type[0]: Property Flags = 0x0
info:      Memory Type[2]: Property Flags = 0x6
info:      Memory Type[3]: Property Flags = 0xe
info:  D3D9: VK_FORMAT_D16_UNORM_S8_UINT -> VK_FORMAT_D24_UNORM_S8_UINT
info:  NVIDIA GeForce RTX 3060 Laptop GPU:
info:    Driver: 512.96.0
info:    Vulkan: 1.3.194
info:    Memory Heap[0]: 
info:      Size: 6023 MiB
info:      Flags: 0x1
info:      Memory Type[1]: Property Flags = 0x1
info:      Memory Type[4]: Property Flags = 0x7
info:    Memory Heap[1]: 
info:      Size: 32652 MiB
info:      Flags: 0x0
info:      Memory Type[0]: Property Flags = 0x0
info:      Memory Type[2]: Property Flags = 0x6
info:      Memory Type[3]: Property Flags = 0xe
info:  Process set as DPI aware
info:  Device properties:
info:    Device name:     : NVIDIA GeForce RTX 3060 Laptop GPU
info:    Driver version   : 512.96.0
info:  Enabled device extensions:
info:    VK_EXT_4444_formats
info:    VK_EXT_conservative_rasterization
info:    VK_EXT_custom_border_color
info:    VK_EXT_depth_clip_enable
info:    VK_EXT_extended_dynamic_state
info:    VK_EXT_full_screen_exclusive
info:    VK_EXT_host_query_reset
info:    VK_EXT_memory_priority
info:    VK_EXT_robustness2
info:    VK_EXT_shader_demote_to_helper_invocation
info:    VK_EXT_shader_viewport_index_layer
info:    VK_EXT_transform_feedback
info:    VK_EXT_vertex_attribute_divisor
info:    VK_KHR_create_renderpass2
info:    VK_KHR_depth_stencil_resolve
info:    VK_KHR_draw_indirect_count
info:    VK_KHR_driver_properties
info:    VK_KHR_external_memory_win32
info:    VK_KHR_image_format_list
info:    VK_KHR_sampler_mirror_clamp_to_edge
info:    VK_KHR_shader_float_controls
info:    VK_KHR_swapchain
info:  Device features:
info:    robustBufferAccess                     : 1
info:    fullDrawIndexUint32                    : 1
info:    imageCubeArray                         : 1
info:    independentBlend                       : 1
info:    geometryShader                         : 1
info:    tessellationShader                     : 0
info:    sampleRateShading                      : 1
info:    dualSrcBlend                           : 0
info:    logicOp                                : 0
info:    multiDrawIndirect                      : 0
info:    drawIndirectFirstInstance              : 0
info:    depthClamp                             : 1
info:    depthBiasClamp                         : 1
info:    fillModeNonSolid                       : 1
info:    depthBounds                            : 1
info:    multiViewport                          : 1
info:    samplerAnisotropy                      : 1
info:    textureCompressionBC                   : 1
info:    occlusionQueryPrecise                  : 1
info:    pipelineStatisticsQuery                : 1
info:    vertexPipelineStoresAndAtomics         : 1
info:    fragmentStoresAndAtomics               : 0
info:    shaderImageGatherExtended              : 0
info:    shaderStorageImageExtendedFormats      : 0
info:    shaderStorageImageReadWithoutFormat    : 0
info:    shaderStorageImageWriteWithoutFormat   : 1
info:    shaderClipDistance                     : 1
info:    shaderCullDistance                     : 1
info:    shaderFloat64                          : 0
info:    shaderInt64                            : 0
info:    variableMultisampleRate                : 0
info:  VK_EXT_4444_formats
info:    formatA4R4G4B4                         : 1
info:    formatA4B4G4R4                         : 1
info:  VK_EXT_custom_border_color
info:    customBorderColors                     : 1
info:    customBorderColorWithoutFormat         : 1
info:  VK_EXT_depth_clip_enable
info:    depthClipEnable                        : 1
info:  VK_EXT_extended_dynamic_state
info:    extendedDynamicState                   : 1
info:  VK_EXT_host_query_reset
info:    hostQueryReset                         : 1
info:  VK_EXT_memory_priority
info:    memoryPriority                         : 1
info:  VK_EXT_robustness2
info:    robustBufferAccess2                    : 1
info:    robustImageAccess2                     : 0
info:    nullDescriptor                         : 1
info:  VK_EXT_shader_demote_to_helper_invocation
info:    shaderDemoteToHelperInvocation         : 1
info:  VK_EXT_transform_feedback
info:    transformFeedback                      : 0
info:    geometryStreams                        : 0
info:  VK_EXT_vertex_attribute_divisor
info:    vertexAttributeInstanceRateDivisor     : 1
info:    vertexAttributeInstanceRateZeroDivisor : 1
info:  VK_KHR_buffer_device_address
info:    bufferDeviceAddress                    : 0
info:  Queue families:
info:    Graphics : 0
info:    Transfer : 1
info:  DXVK: Read 630 valid state cache entries
info:  DXVK: Using 5 compiler threads
info:  D3D9DeviceEx::ResetSwapChain:
info:    Requested Presentation Parameters
info:      - Width:              3840
info:      - Height:             2160
info:      - Format:             D3D9Format::A8R8G8B8
info:      - Auto Depth Stencil: false
info:                  ^ Format: D3D9Format::Unknown
info:      - Windowed:           false
info:  Presenter: Actual swap chain properties:
info:    Format:       VK_FORMAT_B8G8R8A8_UNORM
info:    Present mode: VK_PRESENT_MODE_IMMEDIATE_KHR
info:    Buffer size:  3834x2120
info:    Image count:  2
info:    Exclusive FS: 0
info:  Setting display mode: 3840x2160@0
info:  Presenter: Actual swap chain properties:
info:    Format:       VK_FORMAT_B8G8R8A8_UNORM
info:    Present mode: VK_PRESENT_MODE_IMMEDIATE_KHR
info:    Buffer size:  3840x2160
info:    Image count:  2
info:    Exclusive FS: 0

Blisto91 · 2022-06-02T06:45:19Z

@qinlili23333 No new logging entries have been added in this pr yet (draft so i'm guessing it's not complete) from a quick code peek, if this this code specifically that causes the crash that is.
But i'm not a dev so dunno what makes sense to log and where.

Edit: great to see all the work on this btw. I will do some testing when it is deemed ready

K0bin · 2022-06-02T12:46:21Z

Saints Row 2 crashes before reaching the main menu regardless of what I do. The Linux port crashes, stable Proton crashes, Proton experimental, WineD3D crashes. I doubt that's caused by DXVK.

Blisto91 · 2022-06-02T13:04:16Z

Odd. It worked fine for me when i tested a few days ago and could only make it crash when i turned off large address aware.
But that is a talk for another place i guess.

Is this ready for testing now? 👀

pchome · 2022-06-02T18:07:47Z

dxvk.conf

+# DXVK will unmap D3D9 buffer data after a certain number of frames.
+# 0 to disable unmapping.
+
+# d3d9.bufferUnmapDelay = 16


this->bufferUnmapDelay = config.getOption<int32_t> ("d3d9.bufferUnmapDelay", 256);

so default is 256?

Also, will e.g. d3d9.presentInterval = 2 affect those delays? I didn't read the code, but delays will be 8 and 128 real frames in this case.

Also, will e.g. d3d9.presentInterval = 2 affect those delays? I didn't read the code, but delays will be 8 and 128 real frames in this case.

It should but that also shouldn't be a problem. This is just the first best thing I came up with and the values are somewhat arbitrary.

qinlili23333 · 2022-06-03T03:48:16Z

Tested on Windows 11 Preview 22621 with NVIDIA RTX 3060:
++ Most 3D D3D9 games got ~20% RAM decrease compared to 1.10.1 Release.
++ Alan Wake got ~10% performance improvement.
== 2D D3D9 games have nothing difference compared to 1.10.1 Release.
-- Saints Row 2 still crash at new game.

Edit: Finally made a Large Address Aware patched Saints Row 2 executable, can run well with 1.10.1 Release, but cannot work with this PR's artifact that will keep blink and then crash. Screen recording video provided:
https://user-images.githubusercontent.com/24567775/171790808-9f9cce84-f5ae-4851-8a3f-8d5c642215e2.mp4

K0bin · 2022-06-03T10:18:02Z

@qinlili23333

The PR can't improve performance or reduce RAM usage.

qinlili23333 · 2022-06-03T10:27:21Z

@qinlili23333

The PR can't improve performance or reduce RAM usage.

That's weird. My test shows that Alan Wake got performance improvement and less memory usage. In my test scene that 1.10.1 Release used about 730M and this PR 's version used only about 510M.

Blisto91 · 2022-06-03T10:36:23Z

@qinlili23333 This is the master build this PR is built on, it's better to compare it to that to see if anything has changed.
https://github.com/doitsujin/dxvk/actions/runs/2415391587

qinlili23333 · 2022-06-03T12:01:43Z

@qinlili23333 This is the master build this PR is built on, it's better to compare it to that to see if anything has changed. https://github.com/doitsujin/dxvk/actions/runs/2415391587

I compared with this build. Master build used the same memory but there exist performance difference. This PR really got ~5-10 more performance than master build in Alan Wake.
When force VSYNC at 2160P 60HZ master build will use 80% GPU in average, this PR will use 73% GPU in average.
I'll test in lower resolution then.

Blisto91 · 2022-07-17T16:18:59Z

I am sadly not able to test this on windows since my card is too old for the new driver requirements there.
The crashes that happen with d3d9.resourceMemory = 0 have you still observed the graphics bug out just before?

Could you make a apitrace of a npc conversation where it usually happens? 🙂
Might also be worth testing that with master since this pr have been updated to include most of the latest changes there.
https://github.com/doitsujin/dxvk/actions/runs/2685945402

jochuan · 2022-07-17T16:54:41Z

I am sadly not able to test this on windows since my card is too old for the new driver requirements there. The crashes that happen with d3d9.resourceMemory = 0 have you still observed the graphics bug out just before?

Could you make a apitrace of a npc conversation where it usually happens? 🙂 Might also be worth testing that with master since this pr have been updated to include most of the latest changes there. https://github.com/doitsujin/dxvk/actions/runs/2685945402

Before using d3d9.resourceMemory = 0 this graphics bug still happened but not in the old version of this PR that i was using before and i also tested master and this doesn't happen there.
apitrace:
https://mega.nz/file/vkYzyRyK#wxK7pYAzQHMePXoyywJ6YtOgs0rBxozabxL8Wpl_I_k

This is annoying to maintain and hopefully won't be necessary anymore.

doitsujin

Mostly nits, some questions about the allocation logic.

src/d3d9/d3d9_device.cpp

src/d3d9/d3d9_mem.cpp

src/util/util_lru.h

src/d3d9/d3d9_device.cpp

Blisto91 · 2022-07-21T10:44:21Z

@jochuan Try again with the latest changes if you can. I wasn't able to reproduce your issue on linux with mesa drivers.
Part of the pr was pulled out since it was causing trouble for some games and it's probably soon gonna get merged into master so more will test it.

K0bin · 2022-07-28T13:36:29Z

Found & fixed a bug with Shogun 2

And remove some tracking that will no longer be necessary.

Otherwise D3DPOOL_DEFAULT can hit the draw time late upload path.

K0bin added d3d9 32-bit labels Jun 2, 2022

K0bin marked this pull request as draft June 2, 2022 00:55

K0bin force-pushed the unmap-all branch 2 times, most recently from ce474f0 to 30966e4 Compare June 2, 2022 01:32

K0bin force-pushed the unmap-all branch 3 times, most recently from 1d8af34 to 486afe2 Compare June 2, 2022 12:13

This was referenced Jun 2, 2022

Out of Address Space Megaissue #1318

Closed

DXVK Skyrim LE memory allocate crash #2651

Closed

Use memory mapped files for managed textures #2524

Closed

K0bin marked this pull request as ready for review June 2, 2022 12:54

K0bin force-pushed the unmap-all branch from 486afe2 to 3e39653 Compare June 2, 2022 15:50

This was referenced Jun 2, 2022

Return of Reckoning Hitching. #2568

Closed

Crash in The witcher game (in prolog) #1763

Closed

K0bin force-pushed the unmap-all branch from 3e39653 to 6f68ab0 Compare June 2, 2022 16:29

pchome reviewed Jun 2, 2022

View reviewed changes

[d3d9] Remove evictManagedOnUnlock

f02a9ac

This is annoying to maintain and hopefully won't be necessary anymore.

K0bin force-pushed the unmap-all branch 2 times, most recently from fd4430f to feb04f8 Compare July 20, 2022 14:18

K0bin changed the title ~~Use memory mapped files for D3D9 mapping data~~ Use memory mapped files for D3D9 texture mapping data Jul 20, 2022

K0bin force-pushed the unmap-all branch from feb04f8 to a4f83a5 Compare July 20, 2022 15:08

K0bin mentioned this pull request Jul 20, 2022

[Windows D3D9] Guitar Hero World Tour crash after intro videos (before main menu) #2730

Closed

doitsujin requested changes Jul 20, 2022

View reviewed changes

K0bin force-pushed the unmap-all branch 2 times, most recently from f45791e to 2ec6dea Compare July 20, 2022 21:19

doitsujin approved these changes Jul 20, 2022

View reviewed changes

Blisto91 mentioned this pull request Jul 22, 2022

Test Drive Unlimited 2 crashes #2391

Open

K0bin force-pushed the unmap-all branch 3 times, most recently from 7e480c4 to acfca06 Compare July 28, 2022 13:31

K0bin added 2 commits July 28, 2022 15:40

[d3d9] Remove direct upload path

67a12ce

And remove some tracking that will no longer be necessary.

[d3d9] Only set upload bit for managed textures

286361b

Otherwise D3DPOOL_DEFAULT can hit the draw time late upload path.

K0bin force-pushed the unmap-all branch from acfca06 to a634a92 Compare July 28, 2022 13:41

K0bin added 5 commits July 28, 2022 16:43

[d3d9] Implement memory allocator for memory mapped files

6ca7e2a

[d3d9] Add HUD item for unmappable memory

ca90648

[d3d9] Use memory mapped files for textures

2ce06e2

[util] Implement LRU list

69c3079

[d3d9] Unmap unused resources

2676d1e

K0bin force-pushed the unmap-all branch from a634a92 to 2676d1e Compare July 28, 2022 14:45

misyltoad merged commit ea76bfd into doitsujin:master Jul 29, 2022

K0bin deleted the unmap-all branch August 2, 2022 12:13

Blisto91 mentioned this pull request Dec 26, 2023

[d3d9] GTA IV, different game versions, stutters and Mappable & Mapped amount. #3768

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use memory mapped files for D3D9 texture mapping data #2663

Use memory mapped files for D3D9 texture mapping data #2663

K0bin commented Jun 2, 2022 •

edited

Loading

qinlili23333 commented Jun 2, 2022

Blisto91 commented Jun 2, 2022 •

edited

Loading

K0bin commented Jun 2, 2022 •

edited

Loading

Blisto91 commented Jun 2, 2022

pchome Jun 2, 2022 •

edited

Loading

K0bin Jun 2, 2022

qinlili23333 commented Jun 3, 2022 •

edited

Loading

K0bin commented Jun 3, 2022

qinlili23333 commented Jun 3, 2022

Blisto91 commented Jun 3, 2022

qinlili23333 commented Jun 3, 2022

Blisto91 commented Jul 17, 2022 •

edited

Loading

jochuan commented Jul 17, 2022

doitsujin left a comment

Blisto91 commented Jul 21, 2022

K0bin commented Jul 28, 2022

Use memory mapped files for D3D9 texture mapping data #2663

Use memory mapped files for D3D9 texture mapping data #2663

Conversation

K0bin commented Jun 2, 2022 • edited Loading

Allocation & Mapping

D3D resources

GPU Readback

Unmapping

64 bit builds & DXVK Native

Cleanup

qinlili23333 commented Jun 2, 2022

Blisto91 commented Jun 2, 2022 • edited Loading

K0bin commented Jun 2, 2022 • edited Loading

Blisto91 commented Jun 2, 2022

pchome Jun 2, 2022 • edited Loading

Choose a reason for hiding this comment

K0bin Jun 2, 2022

Choose a reason for hiding this comment

qinlili23333 commented Jun 3, 2022 • edited Loading

K0bin commented Jun 3, 2022

qinlili23333 commented Jun 3, 2022

Blisto91 commented Jun 3, 2022

qinlili23333 commented Jun 3, 2022

Blisto91 commented Jul 17, 2022 • edited Loading

jochuan commented Jul 17, 2022

doitsujin left a comment

Choose a reason for hiding this comment

Blisto91 commented Jul 21, 2022

K0bin commented Jul 28, 2022

K0bin commented Jun 2, 2022 •

edited

Loading

Blisto91 commented Jun 2, 2022 •

edited

Loading

K0bin commented Jun 2, 2022 •

edited

Loading

pchome Jun 2, 2022 •

edited

Loading

qinlili23333 commented Jun 3, 2022 •

edited

Loading

Blisto91 commented Jul 17, 2022 •

edited

Loading