1//===- DXILCBufferAccess.cpp - Translate CBuffer Loads --------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "DirectX.h"
10#include "llvm/Analysis/DXILResource.h"
11#include "llvm/Frontend/HLSL/CBuffer.h"
12#include "llvm/Frontend/HLSL/HLSLResource.h"
13#include "llvm/IR/IRBuilder.h"
14#include "llvm/IR/IntrinsicsDirectX.h"
15#include "llvm/IR/ReplaceConstant.h"
16#include "llvm/Pass.h"
17#include "llvm/Transforms/Utils/Local.h"
18#include "llvm/Transforms/Utils/ModuleUtils.h"
19
20#define DEBUG_TYPE "dxil-cbuffer-access"
21using namespace llvm;
22
23static void replaceUsersOfGlobal(GlobalVariable *Global,
24 GlobalVariable *HandleGV, size_t Offset) {
25 for (Use &U : make_early_inc_range(Range: Global->uses())) {
26 auto UseInst = dyn_cast<Instruction>(Val: U.getUser());
27 // TODO: Constants? Metadata?
28 assert(UseInst && "Non-instruction use of cbuffer");
29
30 IRBuilder<> Builder(UseInst);
31 LoadInst *Handle = Builder.CreateLoad(Ty: HandleGV->getValueType(), Ptr: HandleGV,
32 Name: HandleGV->getName());
33 Value *Ptr = Builder.CreateIntrinsic(
34 RetTy: Global->getType(), ID: Intrinsic::dx_resource_getpointer,
35 Args: ArrayRef<Value *>{Handle,
36 ConstantInt::get(Ty: Builder.getInt32Ty(), V: Offset)});
37 U.set(Ptr);
38 }
39
40 Global->eraseFromParent();
41}
42
43static bool replaceCBufferAccesses(Module &M) {
44 std::optional<hlsl::CBufferMetadata> CBufMD = hlsl::CBufferMetadata::get(
45 M, IsPadding: [](Type *Ty) { return isa<llvm::dxil::PaddingExtType>(Val: Ty); });
46 if (!CBufMD)
47 return false;
48
49 SmallVector<Constant *> CBufferGlobals;
50 SmallPtrSet<GlobalVariable *, 8> CBufferHandles;
51 for (const hlsl::CBufferMapping &Mapping : *CBufMD) {
52 CBufferHandles.insert(Ptr: Mapping.Handle);
53 for (const hlsl::CBufferMember &Member : Mapping.Members)
54 CBufferGlobals.push_back(Elt: Member.GV);
55 }
56 convertUsersOfConstantsToInstructions(Consts: CBufferGlobals);
57
58 for (const hlsl::CBufferMapping &Mapping : *CBufMD)
59 for (const hlsl::CBufferMember &Member : Mapping.Members)
60 replaceUsersOfGlobal(Global: Member.GV, HandleGV: Mapping.Handle, Offset: Member.Offset);
61
62 // Remove cbuffer handle globals from @llvm.compiler.used list.
63 llvm::removeFromUsedLists(M, ShouldRemove: [&](Constant *C) -> bool {
64 auto *GV = dyn_cast<GlobalVariable>(Val: C);
65 return GV && CBufferHandles.contains(Ptr: GV);
66 });
67 for (GlobalVariable *HandleGV : CBufferHandles)
68 HandleGV->removeDeadConstantUsers();
69
70 CBufMD->eraseFromModule();
71 return true;
72}
73
74PreservedAnalyses DXILCBufferAccessPass::run(Module &M,
75 ModuleAnalysisManager &AM) {
76 PreservedAnalyses PA;
77 bool Changed = replaceCBufferAccesses(M);
78
79 if (!Changed)
80 return PreservedAnalyses::all();
81 return PA;
82}
83
84namespace {
85class DXILCBufferAccessLegacy : public ModulePass {
86public:
87 bool runOnModule(Module &M) override { return replaceCBufferAccesses(M); }
88 StringRef getPassName() const override { return "DXIL CBuffer Access"; }
89 DXILCBufferAccessLegacy() : ModulePass(ID) {}
90
91 static char ID; // Pass identification.
92};
93char DXILCBufferAccessLegacy::ID = 0;
94} // end anonymous namespace
95
96INITIALIZE_PASS(DXILCBufferAccessLegacy, DEBUG_TYPE, "DXIL CBuffer Access",
97 false, false)
98
99ModulePass *llvm::createDXILCBufferAccessLegacyPass() {
100 return new DXILCBufferAccessLegacy();
101}
102