42#define DEBUG_TYPE "asm-printer"
50 std::unique_ptr<MCStreamer> Streamer)
52 bool ModuleSectionsEmitted;
61 void outputMCInst(
MCInst &Inst);
64 void outputGlobalRequirements();
65 void outputEntryPoints();
66 void outputDebugSourceAndStrings(
const Module &M);
67 void outputOpExtInstImports(
const Module &M);
68 void outputOpMemoryModel();
69 void outputOpFunctionEnd();
70 void outputExtFuncDecls();
72 SPIRV::ExecutionMode::ExecutionMode EM);
73 void outputExecutionModeFromNumthreadsAttribute(
75 SPIRV::ExecutionMode::ExecutionMode EM);
76 void outputExecutionMode(
const Module &M);
77 void outputAnnotations(
const Module &M);
78 void outputModuleSections();
82 void emitFunctionHeader()
override;
97void SPIRVAsmPrinter::getAnalysisUsage(
AnalysisUsage &AU)
const {
104void SPIRVAsmPrinter::emitEndOfAsmFile(
Module &M) {
105 if (ModuleSectionsEmitted ==
false) {
106 outputModuleSections();
107 ModuleSectionsEmitted =
true;
116 unsigned Bound = 2 * (
ST->getBound() + 1) + NLabels;
117 bool FlagToRestore = OutStreamer->getUseAssemblerInfoForParsing();
118 OutStreamer->setUseAssemblerInfoForParsing(
true);
119 if (
MCAssembler *Asm = OutStreamer->getAssemblerPtr())
122 OutStreamer->setUseAssemblerInfoForParsing(FlagToRestore);
125void SPIRVAsmPrinter::emitFunctionHeader() {
126 if (ModuleSectionsEmitted ==
false) {
127 outputModuleSections();
128 ModuleSectionsEmitted =
true;
132 TII =
ST->getInstrInfo();
136 OutStreamer->getCommentOS()
137 <<
"-- Begin function "
141 auto Section = getObjFileLowering().SectionForGlobal(&
F,
TM);
142 MF->setSection(Section);
145void SPIRVAsmPrinter::outputOpFunctionEnd() {
147 FunctionEndInst.
setOpcode(SPIRV::OpFunctionEnd);
148 outputMCInst(FunctionEndInst);
152void SPIRVAsmPrinter::emitFunctionBodyEnd() {
153 outputOpFunctionEnd();
154 MAI->BBNumToRegMap.clear();
161 outputMCInst(LabelInst);
172 if (
MI.getOpcode() == SPIRV::OpFunction)
180void SPIRVAsmPrinter::printOperand(
const MachineInstr *
MI,
int OpNum,
222bool SPIRVAsmPrinter::PrintAsmOperand(
const MachineInstr *
MI,
unsigned OpNo,
224 if (ExtraCode && ExtraCode[0])
233 return TII->isHeaderInstr(*
MI) ||
MI->getOpcode() == SPIRV::OpFunction ||
234 MI->getOpcode() == SPIRV::OpFunctionParameter;
237void SPIRVAsmPrinter::outputMCInst(
MCInst &Inst) {
238 OutStreamer->emitInstruction(Inst, *OutContext.getSubtargetInfo());
244 MCInstLowering.
lower(
MI, TmpInst, MAI);
245 outputMCInst(TmpInst);
249 SPIRV_MC::verifyInstructionPredicates(
MI->getOpcode(),
250 getSubtargetInfo().getFeatureBits());
252 if (!MAI->getSkipEmission(
MI))
253 outputInstruction(
MI);
259 assert(
MI->getParent()->getNumber() == MF->front().getNumber() &&
260 "OpFunction is not in the front MBB of MF");
261 emitOpLabel(*
MI->getParent());
267 outputInstruction(
MI);
270void SPIRVAsmPrinter::outputDebugSourceAndStrings(
const Module &M) {
272 for (
auto &Str : MAI->SrcExt) {
274 Inst.
setOpcode(SPIRV::OpSourceExtension);
287void SPIRVAsmPrinter::outputOpExtInstImports(
const Module &M) {
288 for (
auto &
CU : MAI->ExtInstSetMap) {
289 unsigned Set =
CU.first;
295 static_cast<SPIRV::InstructionSet::InstructionSet
>(Set)),
301void SPIRVAsmPrinter::outputOpMemoryModel() {
313void SPIRVAsmPrinter::outputEntryPoints() {
317 assert(
MI->getOpcode() == SPIRV::OpVariable);
318 auto SC =
static_cast<SPIRV::StorageClass::StorageClass
>(
319 MI->getOperand(2).getImm());
325 SC == SPIRV::StorageClass::Input ||
SC == SPIRV::StorageClass::Output) {
327 Register Reg = MAI->getRegisterAlias(MF,
MI->getOperand(0).getReg());
336 MCInstLowering.
lower(
MI, TmpInst, MAI);
341 outputMCInst(TmpInst);
346void SPIRVAsmPrinter::outputGlobalRequirements() {
348 MAI->Reqs.checkSatisfiable(*ST);
350 for (
const auto &Cap : MAI->Reqs.getMinimalCapabilities()) {
358 for (
const auto &Ext : MAI->Reqs.getExtensions()) {
362 SPIRV::OperandCategory::ExtensionOperand, Ext),
369void SPIRVAsmPrinter::outputExtFuncDecls() {
374 for (;
I != E; ++
I) {
375 outputInstruction(*
I);
376 if ((
I + 1) == E || (*(
I + 1))->
getOpcode() == SPIRV::OpFunction)
377 outputOpFunctionEnd();
389 if (
IntegerType *IntTy = dyn_cast<IntegerType>(Ty)) {
390 switch (IntTy->getIntegerBitWidth()) {
404 Type *EleTy = VecTy->getElementType();
405 unsigned Size = VecTy->getNumElements();
414 if (
auto *CMeta = dyn_cast<ConstantAsMetadata>(MDOp)) {
418 }
else if (
auto *CE = dyn_cast<Function>(
C)) {
427void SPIRVAsmPrinter::outputExecutionModeFromMDNode(
437void SPIRVAsmPrinter::outputExecutionModeFromNumthreadsAttribute(
439 SPIRV::ExecutionMode::ExecutionMode EM) {
440 assert(Attr.
isValid() &&
"Function called with an invalid attribute.");
449 assert(NumThreads.
size() == 3 &&
"invalid numthreads");
452 [[maybe_unused]]
bool Result = NumThreads[i].getAsInteger(10, V);
453 assert(!Result &&
"Failed to parse numthreads");
460void SPIRVAsmPrinter::outputExecutionMode(
const Module &M) {
463 for (
unsigned i = 0; i <
Node->getNumOperands(); i++) {
470 for (
auto FI =
M.begin(), E =
M.end(); FI != E; ++FI) {
478 if (
MDNode *
Node =
F.getMetadata(
"reqd_work_group_size"))
479 outputExecutionModeFromMDNode(FReg,
Node,
480 SPIRV::ExecutionMode::LocalSize);
482 outputExecutionModeFromNumthreadsAttribute(
483 FReg, Attr, SPIRV::ExecutionMode::LocalSize);
484 if (
MDNode *
Node =
F.getMetadata(
"work_group_size_hint"))
485 outputExecutionModeFromMDNode(FReg,
Node,
486 SPIRV::ExecutionMode::LocalSizeHint);
487 if (
MDNode *
Node =
F.getMetadata(
"intel_reqd_sub_group_size"))
488 outputExecutionModeFromMDNode(FReg,
Node,
489 SPIRV::ExecutionMode::SubgroupSize);
490 if (
MDNode *
Node =
F.getMetadata(
"vec_type_hint")) {
494 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::VecTypeHint);
500 if (
ST->isOpenCLEnv() && !
M.getNamedMetadata(
"spirv.ExecutionMode") &&
501 !
M.getNamedMetadata(
"opencl.enable.FP_CONTRACT")) {
505 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::ContractionOff);
512void SPIRVAsmPrinter::outputAnnotations(
const Module &M) {
515 for (
auto F =
M.global_begin(), E =
M.global_end();
F != E; ++
F) {
516 if ((*F).getName() !=
"llvm.global.annotations")
525 if (!isa<Function>(AnnotatedVar))
529 if (!
Reg.isValid()) {
533 DiagMsg =
"Unknown function in llvm.global.annotations: " + DiagMsg;
546 unsigned Dec =
static_cast<unsigned>(SPIRV::Decoration::UserSemantic);
554void SPIRVAsmPrinter::outputModuleSections() {
555 const Module *
M = MMI->getModule();
558 TII =
ST->getInstrInfo();
560 assert(ST &&
TII && MAI && M &&
"Module analysis is required");
563 outputGlobalRequirements();
565 outputOpExtInstImports(*M);
567 outputOpMemoryModel();
571 outputExecutionMode(*M);
574 outputDebugSourceAndStrings(*M);
580 outputAnnotations(*M);
587 outputExtFuncDecls();
592bool SPIRVAsmPrinter::doInitialization(
Module &M) {
593 ModuleSectionsEmitted =
false;
#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.
void print(raw_ostream &O, bool IsForDebug=false) const
Implement operator<< on Value.
const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Represents a version number in the form major[.minor[.subminor[.build]]].
unsigned getMajor() const
Retrieve the major version number.
std::optional< unsigned > getMinor() const
Retrieve the minor version number, if provided.
std::pair< iterator, bool > insert(const ValueT &V)
This class implements an extremely fast bulk output stream that can only output to a stream.
A raw_ostream that writes to an std::string.
#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)
bool isEntryPoint(const Function &F)
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)