Skip to content

[DXIL] Remove incompatible metadata types when preparing DXIL. #136386

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.

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 8 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions llvm/lib/Target/DirectX/DXILPrepare.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,15 @@ class DXILPrepareModule : public ModulePass {
Builder.getPtrTy(PtrTy->getAddressSpace())));
}

static std::array<unsigned, 6> getCompatibleInstructionMDs(llvm::Module &M) {
return {M.getMDKindID("dx.nonuniform"),
M.getMDKindID("dx.controlflow.hints"),
M.getMDKindID("dx.precise"),
llvm::LLVMContext::MD_range,
llvm::LLVMContext::MD_alias_scope,
llvm::LLVMContext::MD_noalias};
}

public:
bool runOnModule(Module &M) override {
PointerTypeMap PointerTypes = PointerTypeAnalysis::run(M);
Expand All @@ -176,6 +185,9 @@ class DXILPrepareModule : public ModulePass {
VersionTuple ValVer = MetadataInfo.ValidatorVersion;
bool SkipValidation = ValVer.getMajor() == 0 && ValVer.getMinor() == 0;

// construct allowlist of valid metadata node kinds
std::array<unsigned, 6> DXILCompatibleMDs = getCompatibleInstructionMDs(M);

for (auto &F : M.functions()) {
F.removeFnAttrs(AttrMask);
F.removeRetAttrs(AttrMask);
Expand All @@ -189,6 +201,9 @@ class DXILPrepareModule : public ModulePass {
for (auto &BB : F) {
IRBuilder<> Builder(&BB);
for (auto &I : make_early_inc_range(BB)) {

I.dropUnknownNonDebugMetadata(DXILCompatibleMDs);

if (I.getOpcode() == Instruction::FNeg) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DXILPrepare has a bunch of overlap with the legalization pass. Seems like MetaData might not be able to move because legalization is a function level pass and this is a module level one, but at a minimum it seems like FNeg -> FSub should move.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I think DXILPrepare should do things like translate attributes and metadata, insert no-op bitcasts to appease the bitcode writer, and that sort of thing. Replacing ops with their equivalents should squarely be a part of legalization, not here.

I've filed #137685

Builder.SetInsertPoint(&I);
Value *In = I.getOperand(0);
Expand Down
32 changes: 32 additions & 0 deletions llvm/test/CodeGen/DirectX/metadata-stripping.ll
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
; RUN: opt -S --dxil-prepare %s | FileCheck %s

; Test that only metadata nodes that are valid in DXIL are allowed through

target triple = "dxilv1.0-unknown-shadermodel6.0-compute"

; Function Attrs: noinline nounwind memory(readwrite, inaccessiblemem: none)
define void @main(i32* %ptr) {
entry:
; metadata ID changes to 0 once the current !0 and !1 are removed
; since they aren't in the allowlist. range needs a payload.
; CHECK: %val = load i32, ptr %ptr, align 4, !range [[RANGEMD:![0-9]+]]
%val = load i32, ptr %ptr, align 4, !range !2

%cmp.i = icmp ult i32 1, 2
; Ensure that the !llvm.loop metadata node gets dropped.
; CHECK: br i1 %cmp.i, label %_Z4mainDv3_j.exit, label %_Z4mainDv3_j.exit{{$}}
br i1 %cmp.i, label %_Z4mainDv3_j.exit, label %_Z4mainDv3_j.exit, !llvm.loop !0

_Z4mainDv3_j.exit: ; preds = %for.body.i, %entry
ret void
}

; These next check lines check that only the range metadata remains
; No more metadata should be necessary, the rest (the current 0 and 1)
; should be removed.
; CHECK-NOT: !{!"llvm.loop.mustprogress"}
; CHECK: [[RANGEMD]] = !{i32 1, i32 5}
; CHECK-NOT: !{!"llvm.loop.mustprogress"}
!0 = distinct !{!0, !1}
!1 = !{!"llvm.loop.mustprogress"}
!2 = !{i32 1, i32 5}
Loading