40#define DEBUG_TYPE "asm-printer"
46 std::unique_ptr<MCStreamer> Streamer)
48 bool ModuleSectionsEmitted;
57 void outputMCInst(
MCInst &Inst);
60 void outputGlobalRequirements();
61 void outputEntryPoints();
62 void outputDebugSourceAndStrings(
const Module &M);
63 void outputOpExtInstImports(
const Module &M);
64 void outputOpMemoryModel();
65 void outputOpFunctionEnd();
66 void outputExtFuncDecls();
68 SPIRV::ExecutionMode::ExecutionMode EM);
69 void outputExecutionModeFromNumthreadsAttribute(
71 SPIRV::ExecutionMode::ExecutionMode EM);
72 void outputExecutionMode(
const Module &M);
73 void outputAnnotations(
const Module &M);
74 void outputModuleSections();
78 void emitFunctionHeader()
override;
93void SPIRVAsmPrinter::getAnalysisUsage(
AnalysisUsage &AU)
const {
100void SPIRVAsmPrinter::emitEndOfAsmFile(
Module &M) {
101 if (ModuleSectionsEmitted ==
false) {
102 outputModuleSections();
103 ModuleSectionsEmitted =
true;
107void SPIRVAsmPrinter::emitFunctionHeader() {
108 if (ModuleSectionsEmitted ==
false) {
109 outputModuleSections();
110 ModuleSectionsEmitted =
true;
114 TII =
ST->getInstrInfo();
118 OutStreamer->getCommentOS()
119 <<
"-- Begin function "
123 auto Section = getObjFileLowering().SectionForGlobal(&
F,
TM);
124 MF->setSection(Section);
127void SPIRVAsmPrinter::outputOpFunctionEnd() {
129 FunctionEndInst.
setOpcode(SPIRV::OpFunctionEnd);
130 outputMCInst(FunctionEndInst);
134void SPIRVAsmPrinter::emitFunctionBodyEnd() {
135 outputOpFunctionEnd();
136 MAI->BBNumToRegMap.clear();
143 outputMCInst(LabelInst);
153 if (
MI.getOpcode() == SPIRV::OpFunction)
161void SPIRVAsmPrinter::printOperand(
const MachineInstr *
MI,
int OpNum,
203bool SPIRVAsmPrinter::PrintAsmOperand(
const MachineInstr *
MI,
unsigned OpNo,
205 if (ExtraCode && ExtraCode[0])
214 return TII->isHeaderInstr(*
MI) ||
MI->getOpcode() == SPIRV::OpFunction ||
215 MI->getOpcode() == SPIRV::OpFunctionParameter;
218void SPIRVAsmPrinter::outputMCInst(
MCInst &Inst) {
219 OutStreamer->emitInstruction(Inst, *OutContext.getSubtargetInfo());
225 MCInstLowering.
lower(
MI, TmpInst, MAI);
226 outputMCInst(TmpInst);
230 SPIRV_MC::verifyInstructionPredicates(
MI->getOpcode(),
231 getSubtargetInfo().getFeatureBits());
233 if (!MAI->getSkipEmission(
MI))
234 outputInstruction(
MI);
240 assert(
MI->getParent()->getNumber() == MF->front().getNumber() &&
241 "OpFunction is not in the front MBB of MF");
242 emitOpLabel(*
MI->getParent());
248 outputInstruction(
MI);
251void SPIRVAsmPrinter::outputDebugSourceAndStrings(
const Module &M) {
253 for (
auto &Str : MAI->SrcExt) {
255 Inst.
setOpcode(SPIRV::OpSourceExtension);
268void SPIRVAsmPrinter::outputOpExtInstImports(
const Module &M) {
269 for (
auto &
CU : MAI->ExtInstSetMap) {
270 unsigned Set =
CU.first;
276 static_cast<SPIRV::InstructionSet::InstructionSet
>(Set)),
282void SPIRVAsmPrinter::outputOpMemoryModel() {
294void SPIRVAsmPrinter::outputEntryPoints() {
298 assert(
MI->getOpcode() == SPIRV::OpVariable);
299 auto SC =
static_cast<SPIRV::StorageClass::StorageClass
>(
300 MI->getOperand(2).getImm());
305 if (
ST->getSPIRVVersion() >= 14 ||
SC == SPIRV::StorageClass::Input ||
306 SC == SPIRV::StorageClass::Output) {
308 Register Reg = MAI->getRegisterAlias(MF,
MI->getOperand(0).getReg());
317 MCInstLowering.
lower(
MI, TmpInst, MAI);
322 outputMCInst(TmpInst);
327void SPIRVAsmPrinter::outputGlobalRequirements() {
329 MAI->Reqs.checkSatisfiable(*ST);
331 for (
const auto &Cap : MAI->Reqs.getMinimalCapabilities()) {
339 for (
const auto &Ext : MAI->Reqs.getExtensions()) {
343 SPIRV::OperandCategory::ExtensionOperand, Ext),
350void SPIRVAsmPrinter::outputExtFuncDecls() {
355 for (;
I !=
E; ++
I) {
356 outputInstruction(*
I);
357 if ((
I + 1) ==
E || (*(
I + 1))->
getOpcode() == SPIRV::OpFunction)
358 outputOpFunctionEnd();
370 if (
IntegerType *IntTy = dyn_cast<IntegerType>(Ty)) {
371 switch (IntTy->getIntegerBitWidth()) {
385 Type *EleTy = VecTy->getElementType();
386 unsigned Size = VecTy->getNumElements();
395 if (
auto *CMeta = dyn_cast<ConstantAsMetadata>(MDOp)) {
399 }
else if (
auto *CE = dyn_cast<Function>(
C)) {
408void SPIRVAsmPrinter::outputExecutionModeFromMDNode(
418void SPIRVAsmPrinter::outputExecutionModeFromNumthreadsAttribute(
420 SPIRV::ExecutionMode::ExecutionMode EM) {
421 assert(Attr.
isValid() &&
"Function called with an invalid attribute.");
430 assert(NumThreads.
size() == 3 &&
"invalid numthreads");
433 [[maybe_unused]]
bool Result = NumThreads[i].getAsInteger(10, V);
434 assert(!Result &&
"Failed to parse numthreads");
441void SPIRVAsmPrinter::outputExecutionMode(
const Module &M) {
444 for (
unsigned i = 0; i <
Node->getNumOperands(); i++) {
451 for (
auto FI =
M.begin(),
E =
M.end(); FI !=
E; ++FI) {
453 if (
F.isDeclaration())
457 if (
MDNode *
Node =
F.getMetadata(
"reqd_work_group_size"))
458 outputExecutionModeFromMDNode(FReg,
Node,
459 SPIRV::ExecutionMode::LocalSize);
461 outputExecutionModeFromNumthreadsAttribute(
462 FReg, Attr, SPIRV::ExecutionMode::LocalSize);
463 if (
MDNode *
Node =
F.getMetadata(
"work_group_size_hint"))
464 outputExecutionModeFromMDNode(FReg,
Node,
465 SPIRV::ExecutionMode::LocalSizeHint);
466 if (
MDNode *
Node =
F.getMetadata(
"intel_reqd_sub_group_size"))
467 outputExecutionModeFromMDNode(FReg,
Node,
468 SPIRV::ExecutionMode::SubgroupSize);
469 if (
MDNode *
Node =
F.getMetadata(
"vec_type_hint")) {
473 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::VecTypeHint);
479 if (
ST->isOpenCLEnv() && !
M.getNamedMetadata(
"spirv.ExecutionMode") &&
480 !
M.getNamedMetadata(
"opencl.enable.FP_CONTRACT")) {
484 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::ContractionOff);
491void SPIRVAsmPrinter::outputAnnotations(
const Module &M) {
494 for (
auto F =
M.global_begin(),
E =
M.global_end();
F !=
E; ++
F) {
495 if ((*F).getName() !=
"llvm.global.annotations")
504 if (!isa<Function>(AnnotatedVar))
518 unsigned Dec =
static_cast<unsigned>(SPIRV::Decoration::UserSemantic);
526void SPIRVAsmPrinter::outputModuleSections() {
527 const Module *
M = MMI->getModule();
530 TII =
ST->getInstrInfo();
532 assert(ST &&
TII && MAI && M &&
"Module analysis is required");
535 outputGlobalRequirements();
537 outputOpExtInstImports(*M);
539 outputOpMemoryModel();
543 outputExecutionMode(*M);
546 outputDebugSourceAndStrings(*M);
552 outputAnnotations(*M);
559 outputExtFuncDecls();
564bool SPIRVAsmPrinter::doInitialization(
Module &M) {
565 ModuleSectionsEmitted =
false;
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define LLVM_EXTERNAL_VISIBILITY
This file defines the DenseMap class.
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
const HexagonInstrInfo * TII
This file declares the MachineConstantPool class which is an abstract constant pool to keep track of ...
static GCMetadataPrinterRegistry::Add< OcamlGCMetadataPrinter > Y("ocaml", "ocaml 3.10-compatible collector")
const char LLVMTargetMachineRef TM
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
static void addOpsFromMDNode(MDNode *MDN, MCInst &Inst, SPIRV::ModuleAnalysisInfo *MAI)
LLVM_EXTERNAL_VISIBILITY void LLVMInitializeSPIRVAsmPrinter()
static bool isFuncOrHeaderInstr(const MachineInstr *MI, const SPIRVInstrInfo *TII)
static unsigned encodeVecTypeHint(Type *Ty)
static bool printOperand(raw_ostream &OS, const SelectionDAG *G, const SDValue Value)
static std::optional< unsigned > getOpcode(ArrayRef< VPValue * > Values)
Returns the opcode of Values or ~0 if they do not all agree.
Represent the analysis usage information of a pass.
AnalysisUsage & addRequired()
AnalysisUsage & addPreserved()
Add the specified Pass class to the set of analyses preserved by this pass.
This class is intended to be used as a driving class for all asm writers.
virtual void emitInstruction(const MachineInstr *)
Targets should implement this to emit instructions.
virtual void emitGlobalVariable(const GlobalVariable *GV)
Emit the specified global variable to the .s file.
virtual void emitBasicBlockEnd(const MachineBasicBlock &MBB)
Targets can override this to emit stuff at the end of a basic block.
const MCAsmInfo * MAI
Target Asm Printer information.
virtual void emitFunctionBodyStart()
Targets can override this to emit stuff before the first basic block in the function.
virtual void emitEndOfAsmFile(Module &)
This virtual method can be overridden by targets that want to emit something at the end of their file...
bool doInitialization(Module &M) override
Set up the AsmPrinter when we are working on a new module.
void getAnalysisUsage(AnalysisUsage &AU) const override
Record analysis usage.
virtual void emitBasicBlockStart(const MachineBasicBlock &MBB)
Targets can override this to emit stuff at the start of a basic block.
virtual void emitFunctionBodyEnd()
Targets can override this to emit stuff after the last basic block in the function.
virtual void emitFunctionEntryLabel()
EmitFunctionEntryLabel - Emit the label that is the entrypoint for the function.
virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS)
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant.
StringRef getValueAsString() const
Return the attribute's value as a string.
bool isValid() const
Return true if the attribute is any kind of attribute.
ConstantArray - Constant Array Declarations.
This is the shared class of boolean and integer constants.
This is an important base class in LLVM.
This class represents an Operation in the Expression.
Implements a dense probed hash-table based set.
Class to represent fixed width SIMD vectors.
static StringRef dropLLVMManglingEscape(StringRef Name)
If the given string begins with the GlobalValue name mangling escape character '\1',...
Class to represent integer types.
Instances of this class represent a single low-level machine instruction.
void addOperand(const MCOperand Op)
void setOpcode(unsigned Op)
static MCOperand createReg(unsigned Reg)
static MCOperand createImm(int64_t Val)
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
StringRef getName() const
getName - Get the symbol name.
ArrayRef< MDOperand > operands() const
Tracking metadata reference owned by Metadata.
MCSymbol * getSymbol() const
Return the MCSymbol for this basic block.
int getNumber() const
MachineBasicBlocks are uniquely numbered at the function level, unless they're not in a MachineFuncti...
Representation of each machine instruction.
MachineOperand class - Representation of each machine instruction operand.
const GlobalValue * getGlobal() const
MachineBasicBlock * getMBB() const
const BlockAddress * getBlockAddress() const
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
const char * getSymbolName() const
Register getReg() const
getReg - Returns the register number.
const ConstantFP * getFPImm() const
@ MO_Immediate
Immediate operand.
@ MO_ConstantPoolIndex
Address of indexed Constant in Constant Pool.
@ MO_GlobalAddress
Address of a global value.
@ MO_BlockAddress
Address of a basic block.
@ MO_MachineBasicBlock
MachineBasicBlock reference.
@ MO_Register
Register operand.
@ MO_ExternalSymbol
Name of external global symbol.
@ MO_JumpTableIndex
Address of indexed Jump Table for switch.
@ MO_FPImmediate
Floating-point immediate operand.
A Module instance is used to store all the information related to an LLVM module.
virtual StringRef getPassName() const
getPassName - Return a nice clean name for a pass.
Wrapper class representing virtual and physical registers.
constexpr bool isValid() const
static const char * getRegisterName(MCRegister Reg)
void lower(const MachineInstr *MI, MCInst &OutMI, SPIRV::ModuleAnalysisInfo *MAI) const
typename SuperClass::iterator iterator
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Primary interface to the complete machine description for the target machine.
The instances of the Type class are immutable: once they are created, they are never changed.
bool isFloatTy() const
Return true if this is 'float', a 32-bit IEEE fp type.
bool isHalfTy() const
Return true if this is 'half', a 16-bit IEEE fp type.
bool isDoubleTy() const
Return true if this is 'double', a 64-bit IEEE fp type.
Value * getOperand(unsigned i) const
LLVM Value Representation.
const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
std::pair< iterator, bool > insert(const ValueT &V)
This class implements an extremely fast bulk output stream that can only output to a stream.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
@ SC
CHAIN = SC CHAIN, Imm128 - System call.
@ MB_DebugModuleProcessed
Reg
All possible values of the reg field in the ModR/M byte.
NodeAddr< FuncNode * > Func
This is an optimization pass for GlobalISel generic memory operations.
Target & getTheSPIRV32Target()
bool getConstantStringInfo(const Value *V, StringRef &Str, bool TrimAtNul=true)
This function computes the length of a null-terminated C string pointed to by V.
std::string getExtInstSetName(SPIRV::InstructionSet::InstructionSet Set)
void report_fatal_error(Error Err, bool gen_crash_diag=true)
Report a serious error, calling any installed error handler.
std::string getSymbolicOperandMnemonic(SPIRV::OperandCategory::OperandCategory Category, int32_t Value)
Target & getTheSPIRV64Target()
Target & getTheSPIRVLogicalTarget()
Type * getMDOperandAsType(const MDNode *N, unsigned I)
void addStringImm(const StringRef &Str, MCInst &Inst)
RegisterAsmPrinter - Helper template for registering a target specific assembly printer,...
static struct SPIRV::ModuleAnalysisInfo MAI
Register getFuncReg(const Function *F)