shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
llvm-project/llvm/lib/Target/DirectX/DXILPrepare.cpp
Justin Bogner 3eca15cbb9
[DirectX] Split resource info into type and binding info. NFC (#119773) 
This splits the DXILResourceAnalysis pass into TypeAnalysis and
BindingAnalysis passes. The type analysis pass is made immutable and
populated lazily so that it can be used earlier in the pipeline without
needing to carefully maintain the invariants of the binding analysis.

Fixes #118400
2024-12-18 09:02:28 -07:00

271 lines
10 KiB
C++
Raw Blame History

//===- DXILPrepare.cpp - Prepare LLVM Module for DXIL encoding ------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file This file contains pases and utilities to convert a modern LLVM
/// module into a module compatible with the LLVM 3.7-based DirectX Intermediate
/// Language (DXIL).
//===----------------------------------------------------------------------===//
#include "DXILResourceAnalysis.h"
#include "DXILShaderFlags.h"
#include "DirectX.h"
#include "DirectXIRPasses/PointerTypeAnalysis.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Analysis/DXILMetadataAnalysis.h"
#include "llvm/Analysis/DXILResource.h"
#include "llvm/CodeGen/Passes.h"
#include "llvm/IR/AttributeMask.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Module.h"
#include "llvm/InitializePasses.h"
#include "llvm/Pass.h"
#include "llvm/Support/Compiler.h"
#include "llvm/Support/VersionTuple.h"
#define DEBUG_TYPE "dxil-prepare"
using namespace llvm;
using namespace llvm::dxil;
namespace {
constexpr bool isValidForDXIL(Attribute::AttrKind Attr) {
return is_contained({Attribute::Alignment,
Attribute::AlwaysInline,
Attribute::Builtin,
Attribute::ByVal,
Attribute::InAlloca,
Attribute::Cold,
Attribute::Convergent,
Attribute::InlineHint,
Attribute::InReg,
Attribute::JumpTable,
Attribute::MinSize,
Attribute::Naked,
Attribute::Nest,
Attribute::NoAlias,
Attribute::NoBuiltin,
Attribute::NoCapture,
Attribute::NoDuplicate,
Attribute::NoImplicitFloat,
Attribute::NoInline,
Attribute::NonLazyBind,
Attribute::NonNull,
Attribute::Dereferenceable,
Attribute::DereferenceableOrNull,
Attribute::Memory,
Attribute::NoRedZone,
Attribute::NoReturn,
Attribute::NoUnwind,
Attribute::OptimizeForSize,
Attribute::OptimizeNone,
Attribute::ReadNone,
Attribute::ReadOnly,
Attribute::Returned,
Attribute::ReturnsTwice,
Attribute::SExt,
Attribute::StackAlignment,
Attribute::StackProtect,
Attribute::StackProtectReq,
Attribute::StackProtectStrong,
Attribute::SafeStack,
Attribute::StructRet,
Attribute::SanitizeAddress,
Attribute::SanitizeThread,
Attribute::SanitizeMemory,
Attribute::UWTable,
Attribute::ZExt},
Attr);
}
static void collectDeadStringAttrs(AttributeMask &DeadAttrs, AttributeSet &&AS,
const StringSet<> &LiveKeys,
bool AllowExperimental) {
for (auto &Attr : AS) {
if (!Attr.isStringAttribute())
continue;
StringRef Key = Attr.getKindAsString();
if (LiveKeys.contains(Key))
continue;
if (AllowExperimental && Key.starts_with("exp-"))
continue;
DeadAttrs.addAttribute(Key);
}
}
static void removeStringFunctionAttributes(Function &F,
bool AllowExperimental) {
AttributeList Attrs = F.getAttributes();
const StringSet<> LiveKeys = {"waveops-include-helper-lanes",
"fp32-denorm-mode"};
// Collect DeadKeys in FnAttrs.
AttributeMask DeadAttrs;
collectDeadStringAttrs(DeadAttrs, Attrs.getFnAttrs(), LiveKeys,
AllowExperimental);
collectDeadStringAttrs(DeadAttrs, Attrs.getRetAttrs(), LiveKeys,
AllowExperimental);
F.removeFnAttrs(DeadAttrs);
F.removeRetAttrs(DeadAttrs);
}
static void cleanModuleFlags(Module &M) {
NamedMDNode *MDFlags = M.getModuleFlagsMetadata();
if (!MDFlags)
return;
SmallVector<llvm::Module::ModuleFlagEntry> FlagEntries;
M.getModuleFlagsMetadata(FlagEntries);
bool Updated = false;
for (auto &Flag : FlagEntries) {
// llvm 3.7 only supports behavior up to AppendUnique.
if (Flag.Behavior <= Module::ModFlagBehavior::AppendUnique)
continue;
Flag.Behavior = Module::ModFlagBehavior::Warning;
Updated = true;
}
if (!Updated)
return;
MDFlags->eraseFromParent();
for (auto &Flag : FlagEntries)
M.addModuleFlag(Flag.Behavior, Flag.Key->getString(), Flag.Val);
}
class DXILPrepareModule : public ModulePass {
static Value *maybeGenerateBitcast(IRBuilder<> &Builder,
PointerTypeMap &PointerTypes,
Instruction &Inst, Value *Operand,
Type *Ty) {
// Omit bitcasts if the incoming value matches the instruction type.
auto It = PointerTypes.find(Operand);
if (It != PointerTypes.end())
if (cast<TypedPointerType>(It->second)->getElementType() == Ty)
return nullptr;
// Insert bitcasts where we are removing the instruction.
Builder.SetInsertPoint(&Inst);
// This code only gets hit in opaque-pointer mode, so the type of the
// pointer doesn't matter.
PointerType *PtrTy = cast<PointerType>(Operand->getType());
return Builder.Insert(
CastInst::Create(Instruction::BitCast, Operand,
Builder.getPtrTy(PtrTy->getAddressSpace())));
}
public:
bool runOnModule(Module &M) override {
PointerTypeMap PointerTypes = PointerTypeAnalysis::run(M);
AttributeMask AttrMask;
for (Attribute::AttrKind I = Attribute::None; I != Attribute::EndAttrKinds;
I = Attribute::AttrKind(I + 1)) {
if (!isValidForDXIL(I))
AttrMask.addAttribute(I);
}
const dxil::ModuleMetadataInfo MetadataInfo =
getAnalysis<DXILMetadataAnalysisWrapperPass>().getModuleMetadata();
VersionTuple ValVer = MetadataInfo.ValidatorVersion;
bool SkipValidation = ValVer.getMajor() == 0 && ValVer.getMinor() == 0;
for (auto &F : M.functions()) {
F.removeFnAttrs(AttrMask);
F.removeRetAttrs(AttrMask);
// Only remove string attributes if we are not skipping validation.
// This will reserve the experimental attributes when validation version
// is 0.0 for experiment mode.
removeStringFunctionAttributes(F, SkipValidation);
for (size_t Idx = 0, End = F.arg_size(); Idx < End; ++Idx)
F.removeParamAttrs(Idx, AttrMask);
for (auto &BB : F) {
IRBuilder<> Builder(&BB);
for (auto &I : make_early_inc_range(BB)) {
if (I.getOpcode() == Instruction::FNeg) {
Builder.SetInsertPoint(&I);
Value *In = I.getOperand(0);
Value *Zero = ConstantFP::get(In->getType(), -0.0);
I.replaceAllUsesWith(Builder.CreateFSub(Zero, In));
I.eraseFromParent();
continue;
}
// Emtting NoOp bitcast instructions allows the ValueEnumerator to be
// unmodified as it reserves instruction IDs during contruction.
if (auto LI = dyn_cast<LoadInst>(&I)) {
if (Value *NoOpBitcast = maybeGenerateBitcast(
Builder, PointerTypes, I, LI->getPointerOperand(),
LI->getType())) {
LI->replaceAllUsesWith(
Builder.CreateLoad(LI->getType(), NoOpBitcast));
LI->eraseFromParent();
}
continue;
}
if (auto SI = dyn_cast<StoreInst>(&I)) {
if (Value *NoOpBitcast = maybeGenerateBitcast(
Builder, PointerTypes, I, SI->getPointerOperand(),
SI->getValueOperand()->getType())) {
SI->replaceAllUsesWith(
Builder.CreateStore(SI->getValueOperand(), NoOpBitcast));
SI->eraseFromParent();
}
continue;
}
if (auto GEP = dyn_cast<GetElementPtrInst>(&I)) {
if (Value *NoOpBitcast = maybeGenerateBitcast(
Builder, PointerTypes, I, GEP->getPointerOperand(),
GEP->getSourceElementType()))
GEP->setOperand(0, NoOpBitcast);
continue;
}
if (auto *CB = dyn_cast<CallBase>(&I)) {
CB->removeFnAttrs(AttrMask);
CB->removeRetAttrs(AttrMask);
for (size_t Idx = 0, End = CB->arg_size(); Idx < End; ++Idx)
CB->removeParamAttrs(Idx, AttrMask);
continue;
}
}
}
}
// Remove flags not for DXIL.
cleanModuleFlags(M);
return true;
}
DXILPrepareModule() : ModulePass(ID) {}
void getAnalysisUsage(AnalysisUsage &AU) const override {
AU.addRequired<DXILMetadataAnalysisWrapperPass>();
AU.addPreserved<ShaderFlagsAnalysisWrapper>();
AU.addPreserved<DXILResourceMDWrapper>();
AU.addPreserved<DXILMetadataAnalysisWrapperPass>();
AU.addPreserved<DXILResourceBindingWrapperPass>();
}
static char ID; // Pass identification.
};
char DXILPrepareModule::ID = 0;
} // end anonymous namespace
INITIALIZE_PASS_BEGIN(DXILPrepareModule, DEBUG_TYPE, "DXIL Prepare Module",
false, false)
INITIALIZE_PASS_DEPENDENCY(DXILMetadataAnalysisWrapperPass)
INITIALIZE_PASS_END(DXILPrepareModule, DEBUG_TYPE, "DXIL Prepare Module", false,
false)
ModulePass *llvm::createDXILPrepareModulePass() {
return new DXILPrepareModule();
}
Reference in New Issue View Git Blame Copy Permalink