IDxcLinker doesn't copy the module data layout, so reflection of linked StructuredBuffer elements misplaces 64-bit integer members

Open Beginner friendly
#9,015 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp
Domain
backend

Research direction

Start in lib/HLSL/DxilLinker.cpp at the two new-module creation sites that set the target triple, and compare the linked module setup with the original module. Read lib/HLSL/DxilContainerReflection.cpp to see how struct member offsets are obtained, then run the attached standalone repro and compare library versus linked reflection. Done means linked WithU64 reflection reports size 16 and member offsets 0 and 8, matching the library.

Written by the indexing model from the issue text.

Description

bug needs-triage

Description
DxilLinker creates the linked module and copies only the target triple, never the data layout (lib/HLSL/DxilLinker.cpp, the two "Create new module" / setTargetTriple sites). Reflection of a non-cbuffer struct reads member offsets from Module::getDataLayout().getStructLayout() (lib/HLSL/DxilContainerReflection.cpp). On a linked module that falls back to LLVM's default layout, where i64 is 4-byte aligned. A uint64_t member of a StructuredBuffer element therefore moves from offset 8 to 4, and the element size shrinks from 16 to 12.

double is unaffected, because f64:64 is also in LLVM's default layout. The generated code is correct either way; only the reflection is wrong, and an application that sizes or fills buffers from reflection will get it wrong.

Related: the linker also drops other module state, see #5197 (resource type annotations), #5703 (RDAT) and the cbuffer reflection issue I'm filing alongside this one.

Steps to Reproduce
Full standalone repro attached (repro_linker_datalayout.cpp).

  1. Compile with -T lib_6_3 -Zi -Qembed_debug (-Zi keeps the member types; the element size is wrong without it too):
struct WithU64 { float a; uint64_t b; };
struct WithF64 { float a; double b; };
StructuredBuffer<WithU64> sbU64;
StructuredBuffer<WithF64> sbF64;
RWByteAddressBuffer o;
[shader("compute")]
[numthreads(1, 1, 1)]
void main(uint id : SV_DispatchThreadID) { o.Store<uint>(0, (uint) sbU64[id].b + (uint) sbF64[id].b); }
  1. IDxcLinker::RegisterLibrary(L"lib", lib), then Link(L"main", L"cs_6_3", ...).
  2. Reflect the library (ID3D12LibraryReflection) and the linked shader (ID3D12ShaderReflection). For each buffer, compare D3D12_SHADER_BUFFER_DESC.Size and the element type's member offsets.

Actual Behavior

Expected for both buffers: element size 16, a at 0, b at 8

  lib     sbU64  element size 16, members at a@0 b@8
  linked  sbU64  element size 12, members at a@0 b@4

  lib     sbF64  element size 16, members at a@0 b@8
  linked  sbF64  element size 16, members at a@0 b@8

Environment

  • DXC version: <latest release, from dxc --version>; also reproduces on main, libdxcompiler.so: 1.11(5563-75fba619)(1.10.0.15563)
  • Host Operating System: Windows (release); Linux x86_64 (main)
Dominant language
C++
Stars
3.7k
Forks
918
Avg merge
3d 12h
Merged PRs (30d)
41

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/DirectXShaderCompiler

All issues in microsoft/DirectXShaderCompiler

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.