DirectXShaderCompiler/lib/HLSL/DxilGenerationPass.cpp

1111 строки
40 KiB
C++

///////////////////////////////////////////////////////////////////////////////
// //
// DxilGenerationPass.cpp //
// Copyright (C) Microsoft Corporation. All rights reserved. //
// This file is distributed under the University of Illinois Open Source //
// License. See LICENSE.TXT for details. //
// //
// DxilGenerationPass implementation. //
// //
///////////////////////////////////////////////////////////////////////////////
#include "dxc/HLSL/DxilGenerationPass.h"
#include "HLSignatureLower.h"
#include "dxc/DXIL/DxilEntryProps.h"
#include "dxc/DXIL/DxilInstructions.h"
#include "dxc/DXIL/DxilModule.h"
#include "dxc/DXIL/DxilOperations.h"
#include "dxc/DXIL/DxilUtil.h"
#include "dxc/HLSL/HLModule.h"
#include "dxc/HLSL/HLOperationLower.h"
#include "dxc/HLSL/HLOperations.h"
#include "dxc/HLSL/HLSLExtensionsCodegenHelper.h"
#include "dxc/Support/Global.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/Analysis/AssumptionCache.h"
#include "llvm/IR/DebugInfo.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Operator.h"
#include "llvm/Pass.h"
#include "llvm/Support/Casting.h"
#include "llvm/Transforms/Utils/SSAUpdater.h"
#include <unordered_map>
#include <unordered_set>
#include <vector>
using namespace llvm;
using namespace hlsl;
// TODO: use hlsl namespace for the most of this file.
namespace {
void SimplifyGlobalSymbol(GlobalVariable *GV) {
Type *Ty = GV->getType()->getElementType();
if (!Ty->isArrayTy()) {
// Make sure only 1 load of GV in each function.
std::unordered_map<Function *, Instruction *> handleMapOnFunction;
for (User *U : GV->users()) {
if (LoadInst *LI = dyn_cast<LoadInst>(U)) {
Function *F = LI->getParent()->getParent();
auto it = handleMapOnFunction.find(F);
if (it == handleMapOnFunction.end()) {
LI->moveBefore(dxilutil::FindAllocaInsertionPt(F));
handleMapOnFunction[F] = LI;
} else {
LI->replaceAllUsesWith(it->second);
}
}
}
}
}
void InitResourceBase(const DxilResourceBase *pSource,
DxilResourceBase *pDest) {
DXASSERT_NOMSG(pSource->GetClass() == pDest->GetClass());
pDest->SetKind(pSource->GetKind());
pDest->SetID(pSource->GetID());
pDest->SetSpaceID(pSource->GetSpaceID());
pDest->SetLowerBound(pSource->GetLowerBound());
pDest->SetRangeSize(pSource->GetRangeSize());
pDest->SetGlobalSymbol(pSource->GetGlobalSymbol());
pDest->SetGlobalName(pSource->GetGlobalName());
pDest->SetHandle(pSource->GetHandle());
pDest->SetHLSLType(pSource->GetHLSLType());
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(pSource->GetGlobalSymbol()))
SimplifyGlobalSymbol(GV);
}
void InitResource(const DxilResource *pSource, DxilResource *pDest) {
pDest->SetCompType(pSource->GetCompType());
pDest->SetSamplerFeedbackType(pSource->GetSamplerFeedbackType());
pDest->SetSampleCount(pSource->GetSampleCount());
pDest->SetElementStride(pSource->GetElementStride());
pDest->SetGloballyCoherent(pSource->IsGloballyCoherent());
pDest->SetHasCounter(pSource->HasCounter());
pDest->SetRW(pSource->IsRW());
pDest->SetROV(pSource->IsROV());
InitResourceBase(pSource, pDest);
}
void InitDxilModuleFromHLModule(HLModule &H, DxilModule &M, bool HasDebugInfo) {
// Subsystems.
unsigned ValMajor, ValMinor;
H.GetValidatorVersion(ValMajor, ValMinor);
M.SetValidatorVersion(ValMajor, ValMinor);
M.SetShaderModel(H.GetShaderModel(), H.GetHLOptions().bUseMinPrecision);
M.SetForceZeroStoreLifetimes(H.GetHLOptions().bForceZeroStoreLifetimes);
// Entry function.
if (!M.GetShaderModel()->IsLib()) {
Function *EntryFn = H.GetEntryFunction();
M.SetEntryFunction(EntryFn);
M.SetEntryFunctionName(H.GetEntryFunctionName());
}
std::vector<GlobalVariable *> &LLVMUsed = M.GetLLVMUsed();
// Resources
for (auto &&C : H.GetCBuffers()) {
auto b = llvm::make_unique<DxilCBuffer>();
InitResourceBase(C.get(), b.get());
b->SetSize(C->GetSize());
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(b->GetGlobalSymbol()))
LLVMUsed.emplace_back(GV);
M.AddCBuffer(std::move(b));
}
for (auto &&C : H.GetUAVs()) {
auto b = llvm::make_unique<DxilResource>();
InitResource(C.get(), b.get());
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(b->GetGlobalSymbol()))
LLVMUsed.emplace_back(GV);
M.AddUAV(std::move(b));
}
for (auto &&C : H.GetSRVs()) {
auto b = llvm::make_unique<DxilResource>();
InitResource(C.get(), b.get());
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(b->GetGlobalSymbol()))
LLVMUsed.emplace_back(GV);
M.AddSRV(std::move(b));
}
for (auto &&C : H.GetSamplers()) {
auto b = llvm::make_unique<DxilSampler>();
InitResourceBase(C.get(), b.get());
b->SetSamplerKind(C->GetSamplerKind());
if (GlobalVariable *GV = dyn_cast<GlobalVariable>(b->GetGlobalSymbol()))
LLVMUsed.emplace_back(GV);
M.AddSampler(std::move(b));
}
// Signatures.
M.ResetSerializedRootSignature(H.GetSerializedRootSignature());
// Subobjects.
M.ResetSubobjects(H.ReleaseSubobjects());
// Shader properties.
// bool m_bDisableOptimizations;
M.SetDisableOptimization(H.GetHLOptions().bDisableOptimizations);
M.SetLegacyResourceReservation(H.GetHLOptions().bLegacyResourceReservation);
// bool m_bDisableMathRefactoring;
// bool m_bEnableDoublePrecision;
// bool m_bEnableDoubleExtensions;
// M.CollectShaderFlags();
// bool m_bForceEarlyDepthStencil;
// bool m_bEnableRawAndStructuredBuffers;
// bool m_bEnableMSAD;
// M.m_ShaderFlags.SetAllResourcesBound(H.GetHLOptions().bAllResourcesBound);
// DXIL type system.
M.ResetTypeSystem(H.ReleaseTypeSystem());
// Dxil OP.
M.ResetOP(H.ReleaseOP());
// Keep llvm used.
M.EmitLLVMUsed();
M.SetAllResourcesBound(H.GetHLOptions().bAllResourcesBound);
M.SetResMayAlias(H.GetHLOptions().bResMayAlias);
M.SetAutoBindingSpace(H.GetAutoBindingSpace());
// Update Validator Version
M.UpgradeToMinValidatorVersion();
}
class DxilGenerationPass : public ModulePass {
HLModule *m_pHLModule;
bool m_HasDbgInfo;
HLSLExtensionsCodegenHelper *m_extensionsCodegenHelper;
public:
static char ID; // Pass identification, replacement for typeid
explicit DxilGenerationPass(bool NoOpt = false)
: ModulePass(ID), m_pHLModule(nullptr),
m_extensionsCodegenHelper(nullptr), NotOptimized(NoOpt) {}
StringRef getPassName() const override { return "DXIL Generator"; }
void SetExtensionsHelper(HLSLExtensionsCodegenHelper *helper) {
m_extensionsCodegenHelper = helper;
}
bool runOnModule(Module &M) override {
m_pHLModule = &M.GetOrCreateHLModule();
const ShaderModel *SM = m_pHLModule->GetShaderModel();
// Load up debug information, to cross-reference values and the instructions
// used to load them.
m_HasDbgInfo = hasDebugInfo(M);
// EntrySig for shader functions.
DxilEntryPropsMap EntryPropsMap;
if (!SM->IsLib()) {
Function *EntryFn = m_pHLModule->GetEntryFunction();
if (!m_pHLModule->HasDxilFunctionProps(EntryFn)) {
llvm_unreachable("Entry function doesn't have any properties.");
return false;
}
DxilFunctionProps &props = m_pHLModule->GetDxilFunctionProps(EntryFn);
std::unique_ptr<DxilEntryProps> pProps =
llvm::make_unique<DxilEntryProps>(
props, m_pHLModule->GetHLOptions().bUseMinPrecision);
HLSignatureLower sigLower(m_pHLModule->GetEntryFunction(), *m_pHLModule,
pProps->sig);
sigLower.Run();
EntryPropsMap[EntryFn] = std::move(pProps);
} else {
for (auto It = M.begin(); It != M.end();) {
Function &F = *(It++);
// Lower signature for each graphics or compute entry function.
if (m_pHLModule->HasDxilFunctionProps(&F)) {
DxilFunctionProps &props = m_pHLModule->GetDxilFunctionProps(&F);
std::unique_ptr<DxilEntryProps> pProps =
llvm::make_unique<DxilEntryProps>(
props, m_pHLModule->GetHLOptions().bUseMinPrecision);
if (m_pHLModule->IsGraphicsShader(&F) ||
m_pHLModule->IsComputeShader(&F) ||
m_pHLModule->IsNodeShader(&F)) {
HLSignatureLower sigLower(&F, *m_pHLModule, pProps->sig);
// TODO: BUG: This will lower patch constant function sigs twice if
// used by two hull shaders!
sigLower.Run();
}
EntryPropsMap[&F] = std::move(pProps);
}
}
}
std::unordered_set<Instruction *> UpdateCounterSet;
LowerRecordAccessToGetNodeRecordPtr(*m_pHLModule);
GenerateDxilOperations(M, UpdateCounterSet);
GenerateDxilCBufferHandles();
std::unordered_map<CallInst *, Type *> HandleToResTypeMap;
LowerHLCreateHandle(HandleToResTypeMap);
MarkUpdateCounter(UpdateCounterSet);
// LowerHLCreateHandle() should have translated HLCreateHandle to
// CreateHandleForLib. Clean up HLCreateHandle functions.
for (auto It = M.begin(); It != M.end();) {
Function &F = *(It++);
if (!F.isDeclaration()) {
if (hlsl::GetHLOpcodeGroupByName(&F) == HLOpcodeGroup::HLCreateHandle) {
if (F.user_empty()) {
F.eraseFromParent();
} else {
llvm_unreachable("Fail to lower createHandle.");
}
}
}
}
// Translate precise on allocas into function call to keep the information
// after mem2reg. The function calls will be removed after propagate precise
// attribute.
TranslatePreciseAttribute();
// High-level metadata should now be turned into low-level metadata.
DxilFunctionProps *pProps = nullptr;
if (!SM->IsLib()) {
pProps = &EntryPropsMap.begin()->second->props;
}
const bool SkipInit = true;
hlsl::DxilModule &DxilMod = M.GetOrCreateDxilModule(SkipInit);
InitDxilModuleFromHLModule(*m_pHLModule, DxilMod, m_HasDbgInfo);
DxilMod.ResetEntryPropsMap(std::move(EntryPropsMap));
if (!SM->IsLib()) {
DxilMod.SetShaderProperties(pProps);
}
HLModule::ClearHLMetadata(M);
M.ResetHLModule();
if (SM->IsSM62Plus() && DxilMod.GetUseMinPrecision()) {
TranslateMinPrecisionRawBuffer(DxilMod, HandleToResTypeMap);
}
// We now have a DXIL representation - record this.
SetPauseResumePasses(M, "hlsl-dxilemit", "hlsl-dxilload");
(void)NotOptimized; // Dummy out unused member to silence warnings
return true;
}
private:
void MarkUpdateCounter(std::unordered_set<Instruction *> &UpdateCounterSet);
// Generate DXIL cbuffer handles.
void GenerateDxilCBufferHandles();
// change built-in funtion into DXIL operations
void
GenerateDxilOperations(Module &M,
std::unordered_set<Instruction *> &UpdateCounterSet);
void LowerHLCreateHandle(
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap);
// Translate precise attribute into HL function call.
void TranslatePreciseAttribute();
// Translate RawBufferLoad/RawBufferStore
// For DXIL >= 1.2, if min precision is enabled, currently generation pass is
// producing i16/f16 return type for min precisions. For rawBuffer, we will
// change this so that min precisions are returning its actual scalar type
// (i32/f32) and will be truncated to their corresponding types after loading
// / before storing.
void TranslateMinPrecisionRawBuffer(
DxilModule &DM,
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap);
// Input module is not optimized.
bool NotOptimized;
};
} // namespace
namespace {
void TranslateHLCreateHandle(Function *F, hlsl::OP &hlslOP) {
Value *opArg = hlslOP.GetU32Const((unsigned)DXIL::OpCode::CreateHandleForLib);
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(user);
Value *res = CI->getArgOperand(HLOperandIndex::kUnaryOpSrc0Idx);
Value *newHandle = nullptr;
IRBuilder<> Builder(CI);
// Res could be ld/phi/select. Will be removed in
// DxilLowerCreateHandleForLib.
Function *createHandle =
hlslOP.GetOpFunc(DXIL::OpCode::CreateHandleForLib, res->getType());
newHandle = Builder.CreateCall(createHandle, {opArg, res});
CI->replaceAllUsesWith(newHandle);
if (res->user_empty()) {
if (Instruction *I = dyn_cast<Instruction>(res))
I->eraseFromParent();
}
CI->eraseFromParent();
}
}
void TranslateHLCreateNodeOutputHandle(Function *F, hlsl::OP &hlslOP) {
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(user);
Value *idx = CI->getArgOperand(HLOperandIndex::kNodeOutputMetadataIDIdx);
auto DxilOpcode = DXIL::OpCode::CreateNodeOutputHandle;
Value *opArg =
hlslOP.GetU32Const((unsigned)DXIL::OpCode::CreateNodeOutputHandle);
IRBuilder<> Builder(CI);
Function *createHandle = hlslOP.GetOpFunc(DxilOpcode, Builder.getVoidTy());
Value *newHandle = Builder.CreateCall(createHandle, {opArg, idx});
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLIndexNodeHandle(Function *F, hlsl::OP &hlslOP) {
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
CallInst *CI = cast<CallInst>(user);
Value *handle = CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Value *arrayidx =
CI->getArgOperand(HLOperandIndex::kIndexNodeHandleArrayIDIdx);
auto DxilOpcode = DXIL::OpCode::IndexNodeHandle;
Value *opArg = hlslOP.GetU32Const((unsigned)DXIL::OpCode::IndexNodeHandle);
IRBuilder<> Builder(CI);
Function *createHandle = hlslOP.GetOpFunc(DxilOpcode, Builder.getVoidTy());
Value *newHandle =
Builder.CreateCall(createHandle, {opArg, handle, arrayidx});
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLCreateNodeInputRecordHandle(Function *F, hlsl::OP &hlslOP) {
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be a call inst
CallInst *CI = cast<CallInst>(user);
Value *idx =
CI->getArgOperand(HLOperandIndex::kNodeInputRecordMetadataIDIdx);
auto DxilOpcode = DXIL::OpCode::CreateNodeInputRecordHandle;
Value *opArg =
hlslOP.GetU32Const((unsigned)DXIL::OpCode::CreateNodeInputRecordHandle);
IRBuilder<> Builder(CI);
Function *createHandle = hlslOP.GetOpFunc(DxilOpcode, Builder.getVoidTy());
Value *newHandle = Builder.CreateCall(createHandle, {opArg, idx});
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLAnnotateNodeRecordHandle(Function *F, hlsl::OP &hlslOP) {
Value *opArg =
hlslOP.GetU32Const((unsigned)DXIL::OpCode::AnnotateNodeRecordHandle);
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(user);
Value *handle = CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Value *NP = CI->getArgOperand(
HLOperandIndex::kAnnotateNodeRecordHandleNodeRecordPropIdx);
IRBuilder<> Builder(CI);
// put annotateHandle near the Handle it annotated.
if (Instruction *I = dyn_cast<Instruction>(handle)) {
if (isa<PHINode>(I))
Builder.SetInsertPoint(I->getParent()->getFirstInsertionPt());
else
Builder.SetInsertPoint(I->getNextNode());
} else if (Argument *Arg = dyn_cast<Argument>(handle)) {
Builder.SetInsertPoint(
Arg->getParent()->getEntryBlock().getFirstInsertionPt());
}
Function *annotateHandle = hlslOP.GetOpFunc(
DXIL::OpCode::AnnotateNodeRecordHandle, Builder.getVoidTy());
CallInst *newHandle =
Builder.CreateCall(annotateHandle, {opArg, handle, NP});
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLAnnotateHandle(
Function *F, hlsl::OP &hlslOP,
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap) {
Value *opArg = hlslOP.GetU32Const((unsigned)DXIL::OpCode::AnnotateHandle);
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(user);
Value *handle = CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Value *RP = CI->getArgOperand(
HLOperandIndex::kAnnotateHandleResourcePropertiesOpIdx);
Type *ResTy =
CI->getArgOperand(HLOperandIndex::kAnnotateHandleResourceTypeOpIdx)
->getType();
IRBuilder<> Builder(CI);
// put annotateHandle near the Handle it annotated.
if (Instruction *I = dyn_cast<Instruction>(handle)) {
if (isa<PHINode>(I)) {
Builder.SetInsertPoint(I->getParent()->getFirstInsertionPt());
} else {
Builder.SetInsertPoint(I->getNextNode());
}
} else if (Argument *Arg = dyn_cast<Argument>(handle)) {
Builder.SetInsertPoint(
Arg->getParent()->getEntryBlock().getFirstInsertionPt());
}
Function *annotateHandle =
hlslOP.GetOpFunc(DXIL::OpCode::AnnotateHandle, Builder.getVoidTy());
CallInst *newHandle =
Builder.CreateCall(annotateHandle, {opArg, handle, RP});
HandleToResTypeMap[newHandle] = ResTy;
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLAnnotateNodeHandle(Function *F, hlsl::OP &hlslOP) {
Value *opArg = hlslOP.GetU32Const((unsigned)DXIL::OpCode::AnnotateNodeHandle);
for (auto U = F->user_begin(); U != F->user_end();) {
Value *user = *(U++);
if (!isa<Instruction>(user))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(user);
Value *handle = CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Value *NP =
CI->getArgOperand(HLOperandIndex::kAnnotateNodeHandleNodePropIdx);
IRBuilder<> Builder(CI);
// put AnnotateNodeHandle near the Handle it annotated.
if (Instruction *I = dyn_cast<Instruction>(handle)) {
if (isa<PHINode>(I))
Builder.SetInsertPoint(I->getParent()->getFirstInsertionPt());
else
Builder.SetInsertPoint(I->getNextNode());
} else if (Argument *Arg = dyn_cast<Argument>(handle)) {
Builder.SetInsertPoint(
Arg->getParent()->getEntryBlock().getFirstInsertionPt());
}
Function *annotateHandle =
hlslOP.GetOpFunc(DXIL::OpCode::AnnotateNodeHandle, Builder.getVoidTy());
CallInst *newHandle =
Builder.CreateCall(annotateHandle, {opArg, handle, NP});
CI->replaceAllUsesWith(newHandle);
CI->eraseFromParent();
}
}
void TranslateHLCastHandleToRes(Function *F, hlsl::OP &hlslOP,
const llvm::DataLayout &DL) {
for (auto U = F->user_begin(); U != F->user_end();) {
Value *User = *(U++);
if (!isa<Instruction>(User))
continue;
// must be call inst
CallInst *CI = cast<CallInst>(User);
IRBuilder<> Builder(CI);
HLCastOpcode opcode = static_cast<HLCastOpcode>(hlsl::GetHLOpcode(CI));
switch (opcode) {
case HLCastOpcode::HandleToNodeOutputCast: {
// Do Nothing for now
// Perhaps we need to replace the recordtohandle cast users
// with the handle argument here.
} break;
case HLCastOpcode::NodeOutputToHandleCast: {
Value *NodeOutputHandle = CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Constant *C = dyn_cast<Constant>(NodeOutputHandle);
if (C && C->isZeroValue()) {
NodeOutputHandle = Constant::getNullValue(hlslOP.GetNodeHandleType());
} else if (auto *CastI = dyn_cast<CallInst>(NodeOutputHandle)) {
DXASSERT_NOMSG(hlsl::GetHLOpcodeGroup(CastI->getCalledFunction()) ==
HLOpcodeGroup::HLCast);
NodeOutputHandle = CastI->getArgOperand(HLOperandIndex::kHandleOpIdx);
}
CI->replaceAllUsesWith(NodeOutputHandle);
} break;
case HLCastOpcode::NodeRecordToHandleCast: {
Value *OutputRecordHandle =
CI->getArgOperand(HLOperandIndex::kHandleOpIdx);
Constant *C = dyn_cast<Constant>(OutputRecordHandle);
if (C && C->isZeroValue()) {
OutputRecordHandle =
Constant::getNullValue(hlslOP.GetNodeRecordHandleType());
} else if (auto *CastI = dyn_cast<CallInst>(OutputRecordHandle)) {
DXASSERT_NOMSG(hlsl::GetHLOpcodeGroup(CastI->getCalledFunction()) ==
HLOpcodeGroup::HLCast);
OutputRecordHandle = CastI->getArgOperand(HLOperandIndex::kHandleOpIdx);
}
CI->replaceAllUsesWith(OutputRecordHandle);
} break;
case HLCastOpcode::HandleToResCast: {
Value *Handle = CI->getArgOperand(HLOperandIndex::kUnaryOpSrc0Idx);
for (auto HandleU = CI->user_begin(); HandleU != CI->user_end();) {
Value *HandleUser = *(HandleU++);
CallInst *HandleCI = dyn_cast<CallInst>(HandleUser);
if (!HandleCI)
continue;
hlsl::HLOpcodeGroup handleGroup =
hlsl::GetHLOpcodeGroup(HandleCI->getCalledFunction());
if (handleGroup == HLOpcodeGroup::HLCreateHandle) {
HandleCI->replaceAllUsesWith(Handle);
HandleCI->eraseFromParent();
}
}
} break;
}
if (CI->user_empty()) {
CI->eraseFromParent();
}
}
}
} // namespace
void DxilGenerationPass::LowerHLCreateHandle(
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap) {
Module *M = m_pHLModule->GetModule();
hlsl::OP &hlslOP = *m_pHLModule->GetOP();
// Lower cast handle to res/node used by hl.createhandle.
for (iplist<Function>::iterator F : M->getFunctionList()) {
if (F->user_empty())
continue;
hlsl::HLOpcodeGroup group = hlsl::GetHLOpcodeGroup(F);
if (group == HLOpcodeGroup::HLCast) {
auto DL = M->getDataLayout();
TranslateHLCastHandleToRes(F, hlslOP, DL);
}
}
// generate dxil operation
for (iplist<Function>::iterator F : M->getFunctionList()) {
if (F->user_empty())
continue;
hlsl::HLOpcodeGroup group = hlsl::GetHLOpcodeGroup(F);
switch (group) {
default:
break;
case HLOpcodeGroup::HLCreateHandle:
TranslateHLCreateHandle(F, hlslOP);
break;
case HLOpcodeGroup::HLCreateNodeOutputHandle:
TranslateHLCreateNodeOutputHandle(F, hlslOP);
break;
case HLOpcodeGroup::HLIndexNodeHandle:
TranslateHLIndexNodeHandle(F, hlslOP);
break;
case HLOpcodeGroup::HLCreateNodeInputRecordHandle:
TranslateHLCreateNodeInputRecordHandle(F, hlslOP);
break;
case HLOpcodeGroup::HLAnnotateHandle:
TranslateHLAnnotateHandle(F, hlslOP, HandleToResTypeMap);
break;
case HLOpcodeGroup::HLAnnotateNodeHandle:
TranslateHLAnnotateNodeHandle(F, hlslOP);
break;
case HLOpcodeGroup::HLAnnotateNodeRecordHandle:
TranslateHLAnnotateNodeRecordHandle(F, hlslOP);
break;
}
}
}
static void
MarkUavUpdateCounter(Value *LoadOrGEP, DxilResource &res,
std::unordered_set<Instruction *> &UpdateCounterSet) {
if (LoadInst *ldInst = dyn_cast<LoadInst>(LoadOrGEP)) {
if (UpdateCounterSet.count(ldInst)) {
DXASSERT_NOMSG(res.GetClass() == DXIL::ResourceClass::UAV);
res.SetHasCounter(true);
}
} else {
DXASSERT(dyn_cast<GEPOperator>(LoadOrGEP) != nullptr,
"else AddOpcodeParamForIntrinsic in CodeGen did not patch uses "
"to only have ld/st refer to temp object");
GEPOperator *GEP = cast<GEPOperator>(LoadOrGEP);
for (auto GEPU : GEP->users()) {
MarkUavUpdateCounter(GEPU, res, UpdateCounterSet);
}
}
}
static void
MarkUavUpdateCounter(DxilResource &res,
std::unordered_set<Instruction *> &UpdateCounterSet) {
Value *V = res.GetGlobalSymbol();
for (auto U = V->user_begin(), E = V->user_end(); U != E;) {
User *user = *(U++);
// Skip unused user.
if (user->user_empty())
continue;
MarkUavUpdateCounter(user, res, UpdateCounterSet);
}
}
static void MarkUavUpdateCounterForDynamicResource(CallInst &createHdlFromHeap,
const ShaderModel &SM) {
for (User *U : createHdlFromHeap.users()) {
CallInst *CI = dyn_cast<CallInst>(U);
if (!CI)
continue;
DxilInst_AnnotateHandle annotHdl(CI);
if (!annotHdl)
continue;
auto RP = hlsl::resource_helper::loadPropsFromAnnotateHandle(annotHdl, SM);
RP.Basic.SamplerCmpOrHasCounter = true;
Value *originRP = annotHdl.get_props();
Value *updatedRP =
hlsl::resource_helper::getAsConstant(RP, originRP->getType(), SM);
annotHdl.set_props(updatedRP);
}
}
void DxilGenerationPass::MarkUpdateCounter(
std::unordered_set<Instruction *> &UpdateCounterSet) {
for (size_t i = 0; i < m_pHLModule->GetUAVs().size(); i++) {
HLResource &UAV = m_pHLModule->GetUAV(i);
MarkUavUpdateCounter(UAV, UpdateCounterSet);
}
auto *hlslOP = m_pHLModule->GetOP();
if (hlslOP->IsDxilOpUsed(DXIL::OpCode::CreateHandleFromHeap)) {
const ShaderModel *pSM = m_pHLModule->GetShaderModel();
Function *hdlFromHeap =
hlslOP->GetOpFunc(DXIL::OpCode::CreateHandleFromHeap,
Type::getVoidTy(m_pHLModule->GetCtx()));
for (User *U : hdlFromHeap->users()) {
CallInst *CI = cast<CallInst>(U);
if (UpdateCounterSet.count(CI) == 0)
continue;
MarkUavUpdateCounterForDynamicResource(*CI, *pSM);
}
}
}
void DxilGenerationPass::GenerateDxilCBufferHandles() {
// For CBuffer, handle are mapped to HLCreateHandle.
OP *hlslOP = m_pHLModule->GetOP();
Value *opArg = hlslOP->GetU32Const((unsigned)OP::OpCode::CreateHandleForLib);
LLVMContext &Ctx = hlslOP->GetCtx();
Value *zeroIdx = hlslOP->GetU32Const(0);
for (size_t i = 0; i < m_pHLModule->GetCBuffers().size(); i++) {
DxilCBuffer &CB = m_pHLModule->GetCBuffer(i);
GlobalVariable *GV = dyn_cast<GlobalVariable>(CB.GetGlobalSymbol());
if (GV == nullptr)
continue;
// Remove GEP created in HLObjectOperationLowerHelper::UniformCbPtr.
GV->removeDeadConstantUsers();
std::string handleName = std::string(GV->getName());
DIVariable *DIV = nullptr;
DILocation *DL = nullptr;
if (m_HasDbgInfo) {
DebugInfoFinder &Finder = m_pHLModule->GetOrCreateDebugInfoFinder();
DIV = dxilutil::FindGlobalVariableDebugInfo(GV, Finder);
if (DIV)
// TODO: how to get col?
DL = DILocation::get(Ctx, DIV->getLine(), 1, DIV->getScope());
}
if (CB.GetRangeSize() == 1 &&
!GV->getType()->getElementType()->isArrayTy()) {
Function *createHandle = hlslOP->GetOpFunc(
OP::OpCode::CreateHandleForLib, GV->getType()->getElementType());
for (auto U = GV->user_begin(); U != GV->user_end();) {
// Must HLCreateHandle.
CallInst *CI = cast<CallInst>(*(U++));
// Put createHandle to entry block.
IRBuilder<> Builder(dxilutil::FirstNonAllocaInsertionPt(CI));
Value *V = Builder.CreateLoad(GV);
CallInst *handle =
Builder.CreateCall(createHandle, {opArg, V}, handleName);
if (m_HasDbgInfo) {
// TODO: add debug info.
// handle->setDebugLoc(DL);
(void)(DL);
}
CI->replaceAllUsesWith(handle);
CI->eraseFromParent();
}
} else {
PointerType *Ty = GV->getType();
Type *EltTy = Ty->getElementType()->getArrayElementType()->getPointerTo(
Ty->getAddressSpace());
Function *createHandle = hlslOP->GetOpFunc(
OP::OpCode::CreateHandleForLib, EltTy->getPointerElementType());
for (auto U = GV->user_begin(); U != GV->user_end();) {
// Must HLCreateHandle.
CallInst *CI = cast<CallInst>(*(U++));
IRBuilder<> Builder(CI);
Value *CBIndex =
CI->getArgOperand(HLOperandIndex::kCreateHandleIndexOpIdx);
if (isa<ConstantInt>(CBIndex)) {
// Put createHandle to entry block for const index.
Builder.SetInsertPoint(dxilutil::FirstNonAllocaInsertionPt(CI));
}
// Add GEP for cbv array use.
Value *GEP = Builder.CreateGEP(GV, {zeroIdx, CBIndex});
if (DxilMDHelper::IsMarkedNonUniform(CI)) {
DxilMDHelper::MarkNonUniform(cast<Instruction>(GEP));
}
Value *V = Builder.CreateLoad(GEP);
CallInst *handle =
Builder.CreateCall(createHandle, {opArg, V}, handleName);
CI->replaceAllUsesWith(handle);
CI->eraseFromParent();
}
}
}
}
void DxilGenerationPass::GenerateDxilOperations(
Module &M, std::unordered_set<Instruction *> &UpdateCounterSet) {
// remove all functions except entry function
Function *entry = m_pHLModule->GetEntryFunction();
const ShaderModel *pSM = m_pHLModule->GetShaderModel();
Function *patchConstantFunc = nullptr;
if (pSM->IsHS()) {
DxilFunctionProps &funcProps = m_pHLModule->GetDxilFunctionProps(entry);
patchConstantFunc = funcProps.ShaderProps.HS.patchConstantFunc;
}
if (!pSM->IsLib()) {
for (auto F = M.begin(); F != M.end();) {
Function *func = F++;
if (func->isDeclaration())
continue;
if (func == entry)
continue;
if (func == patchConstantFunc)
continue;
if (func->user_empty())
func->eraseFromParent();
}
}
TranslateBuiltinOperations(*m_pHLModule, m_extensionsCodegenHelper,
UpdateCounterSet);
// Remove unused HL Operation functions.
std::vector<Function *> deadList;
for (iplist<Function>::iterator F : M.getFunctionList()) {
hlsl::HLOpcodeGroup group = hlsl::GetHLOpcodeGroupByName(F);
if (group != HLOpcodeGroup::NotHL || F->isIntrinsic())
if (F->user_empty())
deadList.emplace_back(F);
}
for (Function *F : deadList)
F->eraseFromParent();
}
static void TranslatePreciseAttributeOnFunction(Function &F, Module &M) {
BasicBlock &BB = F.getEntryBlock(); // Get the entry node for the function
// Find allocas that has precise attribute, by looking at all instructions in
// the entry node
for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E;) {
Instruction *Inst = (I++);
if (AllocaInst *AI = dyn_cast<AllocaInst>(Inst)) {
if (HLModule::HasPreciseAttributeWithMetadata(AI)) {
HLModule::MarkPreciseAttributeOnPtrWithFunctionCall(AI, M);
}
} else {
DXASSERT(!HLModule::HasPreciseAttributeWithMetadata(Inst),
"Only alloca can has precise metadata.");
}
}
FastMathFlags FMF;
FMF.setUnsafeAlgebra();
// Set fast math for all FPMathOperators.
// Already set FastMath in options. But that only enable things like fadd.
// Every inst which type is float can be cast to FPMathOperator.
for (Function::iterator BBI = F.begin(), BBE = F.end(); BBI != BBE; ++BBI) {
BasicBlock *BB = BBI;
for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
if (dyn_cast<FPMathOperator>(I)) {
// Set precise fast math on those instructions that support it.
if (DxilModule::PreservesFastMathFlags(I))
I->copyFastMathFlags(FMF);
}
}
}
}
void DxilGenerationPass::TranslatePreciseAttribute() {
bool bIEEEStrict = m_pHLModule->GetHLOptions().bIEEEStrict;
if (bIEEEStrict) {
// mark precise on dxil operations.
Module &M = *m_pHLModule->GetModule();
for (Function &F : M) {
if (!hlsl::OP::IsDxilOpFunc(&F))
continue;
if (!F.getReturnType()->isFPOrFPVectorTy())
continue;
for (User *U : F.users()) {
Instruction *I = dyn_cast<Instruction>(U);
if (!I)
continue;
IRBuilder<> B(I);
HLModule::MarkPreciseAttributeOnValWithFunctionCall(I, B, M);
}
}
return;
}
Module &M = *m_pHLModule->GetModule();
// TODO: If not inline every function, for function has call site with precise
// argument and call site without precise argument, need to clone the function
// to propagate the precise for the precise call site.
// This should be done at CGMSHLSLRuntime::FinishCodeGen.
if (m_pHLModule->GetShaderModel()->IsLib()) {
// TODO: If all functions have been inlined, and unreferenced functions
// removed,
// it should make sense to run on all funciton bodies,
// even when not processing a library.
for (Function &F : M.functions()) {
if (!F.isDeclaration())
TranslatePreciseAttributeOnFunction(F, M);
}
} else {
Function *EntryFn = m_pHLModule->GetEntryFunction();
TranslatePreciseAttributeOnFunction(*EntryFn, M);
if (m_pHLModule->GetShaderModel()->IsHS()) {
DxilFunctionProps &EntryQual = m_pHLModule->GetDxilFunctionProps(EntryFn);
Function *patchConstantFunc = EntryQual.ShaderProps.HS.patchConstantFunc;
TranslatePreciseAttributeOnFunction(*patchConstantFunc, M);
}
}
}
namespace {
void ReplaceMinPrecisionRawBufferLoadByType(Function *F, Type *FromTy,
Type *ToTy, OP *Op,
const DataLayout &DL) {
Function *newFunction = Op->GetOpFunc(DXIL::OpCode::RawBufferLoad, ToTy);
for (auto FUser = F->user_begin(), FEnd = F->user_end(); FUser != FEnd;) {
User *UserCI = *(FUser++);
if (CallInst *CI = dyn_cast<CallInst>(UserCI)) {
IRBuilder<> CIBuilder(CI);
SmallVector<Value *, 5> newFuncArgs;
// opcode, handle, index, elementOffset, mask
// Compiler is generating correct element offset even for min precision
// types So no need to recalculate here
for (unsigned i = 0; i < 5; ++i) {
newFuncArgs.emplace_back(CI->getArgOperand(i));
}
// new alignment for new type
newFuncArgs.emplace_back(Op->GetI32Const(DL.getTypeAllocSize(ToTy)));
CallInst *newCI = CIBuilder.CreateCall(newFunction, newFuncArgs);
for (auto CIUser = CI->user_begin(), CIEnd = CI->user_end();
CIUser != CIEnd;) {
User *UserEV = *(CIUser++);
if (ExtractValueInst *EV = dyn_cast<ExtractValueInst>(UserEV)) {
IRBuilder<> EVBuilder(EV);
ArrayRef<unsigned> Indices = EV->getIndices();
DXASSERT(Indices.size() == 1,
"Otherwise we have wrong extract value.");
Value *newEV = EVBuilder.CreateExtractValue(newCI, Indices);
Value *newTruncV = nullptr;
if (4 == Indices[0]) { // Don't truncate status
newTruncV = newEV;
} else if (FromTy->isHalfTy()) {
newTruncV = EVBuilder.CreateFPTrunc(newEV, FromTy);
} else if (FromTy->isIntegerTy()) {
newTruncV = EVBuilder.CreateTrunc(newEV, FromTy);
} else {
DXASSERT(false, "unexpected type conversion");
}
EV->replaceAllUsesWith(newTruncV);
EV->eraseFromParent();
}
}
CI->eraseFromParent();
}
}
F->eraseFromParent();
}
void ReplaceMinPrecisionRawBufferStoreByType(
Function *F, Type *FromTy, Type *ToTy, OP *Op,
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap,
DxilTypeSystem &typeSys, const DataLayout &DL) {
Function *newFunction = Op->GetOpFunc(DXIL::OpCode::RawBufferStore, ToTy);
// for each function
// add argument 4-7 to its upconverted values
// replace function call
for (auto FuncUser = F->user_begin(), FuncEnd = F->user_end();
FuncUser != FuncEnd;) {
CallInst *CI = dyn_cast<CallInst>(*(FuncUser++));
DXASSERT(CI, "function user must be a call instruction.");
IRBuilder<> CIBuilder(CI);
SmallVector<Value *, 9> Args;
for (unsigned i = 0; i < 4; ++i) {
Args.emplace_back(CI->getArgOperand(i));
}
// values to store should be converted to its higher precision types
if (FromTy->isHalfTy()) {
for (unsigned i = 4; i < 8; ++i) {
Value *NewV = CIBuilder.CreateFPExt(CI->getArgOperand(i), ToTy);
Args.emplace_back(NewV);
}
} else if (FromTy->isIntegerTy()) {
// This case only applies to typed buffer since Store operation of byte
// address buffer for min precision is handled by implicit conversion on
// intrinsic call. Since we are extending integer, we have to know if we
// should sign ext or zero ext. We can do this by iterating checking the
// size of the element at struct type and comp type at type annotation
CallInst *handleCI = dyn_cast<CallInst>(
CI->getArgOperand(DxilInst_RawBufferStore::arg_uav));
DXASSERT(handleCI,
"otherwise handle was not an argument to buffer store.");
auto resTyIt = HandleToResTypeMap.find(handleCI);
DXASSERT(resTyIt != HandleToResTypeMap.end(),
"otherwise fail to handle for buffer store lost its retTy");
StructType *STy = dyn_cast<StructType>(resTyIt->second);
STy = cast<StructType>(STy->getElementType(0));
DxilStructAnnotation *SAnnot = typeSys.GetStructAnnotation(STy);
ConstantInt *offsetInt = dyn_cast<ConstantInt>(
CI->getArgOperand(DxilInst_RawBufferStore::arg_elementOffset));
unsigned offset = offsetInt->getSExtValue();
unsigned currentOffset = 0;
for (DxilStructTypeIterator iter = begin(STy, SAnnot),
ItEnd = end(STy, SAnnot);
iter != ItEnd; ++iter) {
std::pair<Type *, DxilFieldAnnotation *> pair = *iter;
currentOffset += DL.getTypeAllocSize(pair.first);
if (currentOffset > offset) {
if (pair.second->GetCompType().IsUIntTy()) {
for (unsigned i = 4; i < 8; ++i) {
Value *NewV = CIBuilder.CreateZExt(CI->getArgOperand(i), ToTy);
Args.emplace_back(NewV);
}
break;
} else if (pair.second->GetCompType().IsIntTy()) {
for (unsigned i = 4; i < 8; ++i) {
Value *NewV = CIBuilder.CreateSExt(CI->getArgOperand(i), ToTy);
Args.emplace_back(NewV);
}
break;
} else {
DXASSERT(false, "Invalid comp type");
}
}
}
}
// mask
Args.emplace_back(CI->getArgOperand(8));
// alignment
Args.emplace_back(CIBuilder.getInt32(DL.getTypeAllocSize(ToTy)));
CIBuilder.CreateCall(newFunction, Args);
CI->eraseFromParent();
}
}
} // namespace
void DxilGenerationPass::TranslateMinPrecisionRawBuffer(
DxilModule &DM,
std::unordered_map<CallInst *, Type *> &HandleToResTypeMap) {
hlsl::OP *hlslOP = DM.GetOP();
LLVMContext &Ctx = DM.GetCtx();
Type *I32Ty = Type::getInt32Ty(Ctx);
Type *I16Ty = Type::getInt16Ty(Ctx);
Type *F32Ty = Type::getFloatTy(Ctx);
Type *F16Ty = Type::getHalfTy(Ctx);
const DataLayout &DL = DM.GetModule()->getDataLayout();
DxilTypeSystem &typeSys = DM.GetTypeSystem();
SmallVector<Function *, 2> rawBufLoads;
for (auto it : hlslOP->GetOpFuncList(DXIL::OpCode::RawBufferLoad)) {
Function *F = it.second;
if (!F)
continue;
rawBufLoads.emplace_back(F);
}
for (Function *F : rawBufLoads) {
StructType *RetTy = cast<StructType>(F->getReturnType());
Type *EltTy = RetTy->getElementType(0);
if (EltTy->isHalfTy()) {
ReplaceMinPrecisionRawBufferLoadByType(F, F16Ty, F32Ty, hlslOP, DL);
} else if (EltTy == I16Ty) {
ReplaceMinPrecisionRawBufferLoadByType(F, I16Ty, I32Ty, hlslOP, DL);
}
}
SmallVector<Function *, 2> rawBufStores;
for (auto it : hlslOP->GetOpFuncList(DXIL::OpCode::RawBufferStore)) {
Function *F = it.second;
if (!F)
continue;
rawBufStores.emplace_back(F);
}
for (Function *F : rawBufStores) {
Type *EltTy =
F->getFunctionType()->getParamType(DxilInst_RawBufferStore::arg_value0);
if (EltTy->isHalfTy()) {
ReplaceMinPrecisionRawBufferStoreByType(F, F16Ty, F32Ty, hlslOP,
HandleToResTypeMap, typeSys, DL);
} else if (EltTy == I16Ty) {
ReplaceMinPrecisionRawBufferStoreByType(F, I16Ty, I32Ty, hlslOP,
HandleToResTypeMap, typeSys, DL);
}
}
}
char DxilGenerationPass::ID = 0;
ModulePass *llvm::createDxilGenerationPass(
bool NotOptimized, hlsl::HLSLExtensionsCodegenHelper *extensionsHelper) {
DxilGenerationPass *dxilPass = new DxilGenerationPass(NotOptimized);
dxilPass->SetExtensionsHelper(extensionsHelper);
return dxilPass;
}
INITIALIZE_PASS(DxilGenerationPass, "dxilgen", "HLSL DXIL Generation", false,
false)