43#define DEBUG_TYPE "asm-printer"
51 std::unique_ptr<MCStreamer> Streamer)
53 bool ModuleSectionsEmitted;
62 void outputMCInst(
MCInst &Inst);
65 void outputGlobalRequirements();
66 void outputEntryPoints();
67 void outputDebugSourceAndStrings(
const Module &M);
68 void outputOpExtInstImports(
const Module &M);
69 void outputOpMemoryModel();
70 void outputOpFunctionEnd();
71 void outputExtFuncDecls();
73 SPIRV::ExecutionMode::ExecutionMode EM,
74 unsigned ExpectMDOps, int64_t DefVal);
75 void outputExecutionModeFromNumthreadsAttribute(
77 SPIRV::ExecutionMode::ExecutionMode EM);
78 void outputExecutionMode(
const Module &M);
79 void outputAnnotations(
const Module &M);
80 void outputModuleSections();
84 void emitFunctionHeader()
override;
99void SPIRVAsmPrinter::getAnalysisUsage(
AnalysisUsage &AU)
const {
106void SPIRVAsmPrinter::emitEndOfAsmFile(
Module &M) {
107 if (ModuleSectionsEmitted ==
false) {
108 outputModuleSections();
109 ModuleSectionsEmitted =
true;
118 unsigned Bound = 2 * (
ST->getBound() + 1) + NLabels;
119 if (
MCAssembler *Asm = OutStreamer->getAssemblerPtr())
121 .setBuildVersion(Major, Minor, Bound);
124void SPIRVAsmPrinter::emitFunctionHeader() {
125 if (ModuleSectionsEmitted ==
false) {
126 outputModuleSections();
127 ModuleSectionsEmitted =
true;
131 TII =
ST->getInstrInfo();
135 OutStreamer->getCommentOS()
136 <<
"-- Begin function "
140 auto Section = getObjFileLowering().SectionForGlobal(&
F,
TM);
141 MF->setSection(Section);
144void SPIRVAsmPrinter::outputOpFunctionEnd() {
146 FunctionEndInst.
setOpcode(SPIRV::OpFunctionEnd);
147 outputMCInst(FunctionEndInst);
151void SPIRVAsmPrinter::emitFunctionBodyEnd() {
152 outputOpFunctionEnd();
153 MAI->BBNumToRegMap.clear();
160 outputMCInst(LabelInst);
171 if (
MI.getOpcode() == SPIRV::OpFunction)
179void SPIRVAsmPrinter::printOperand(
const MachineInstr *
MI,
int OpNum,
221bool SPIRVAsmPrinter::PrintAsmOperand(
const MachineInstr *
MI,
unsigned OpNo,
223 if (ExtraCode && ExtraCode[0])
232 return TII->isHeaderInstr(*
MI) ||
MI->getOpcode() == SPIRV::OpFunction ||
233 MI->getOpcode() == SPIRV::OpFunctionParameter;
236void SPIRVAsmPrinter::outputMCInst(
MCInst &Inst) {
237 OutStreamer->emitInstruction(Inst, *OutContext.getSubtargetInfo());
243 MCInstLowering.
lower(
MI, TmpInst, MAI);
244 outputMCInst(TmpInst);
248 SPIRV_MC::verifyInstructionPredicates(
MI->getOpcode(),
249 getSubtargetInfo().getFeatureBits());
251 if (!MAI->getSkipEmission(
MI))
252 outputInstruction(
MI);
258 assert(
MI->getParent()->getNumber() == MF->front().getNumber() &&
259 "OpFunction is not in the front MBB of MF");
260 emitOpLabel(*
MI->getParent());
266 outputInstruction(
MI);
269void SPIRVAsmPrinter::outputDebugSourceAndStrings(
const Module &M) {
271 for (
auto &Str : MAI->SrcExt) {
273 Inst.
setOpcode(SPIRV::OpSourceExtension);
286void SPIRVAsmPrinter::outputOpExtInstImports(
const Module &M) {
287 for (
auto &
CU : MAI->ExtInstSetMap) {
288 unsigned Set =
CU.first;
294 static_cast<SPIRV::InstructionSet::InstructionSet
>(Set)),
300void SPIRVAsmPrinter::outputOpMemoryModel() {
312void SPIRVAsmPrinter::outputEntryPoints() {
316 assert(
MI->getOpcode() == SPIRV::OpVariable);
317 auto SC =
static_cast<SPIRV::StorageClass::StorageClass
>(
318 MI->getOperand(2).getImm());
324 SC == SPIRV::StorageClass::Input ||
SC == SPIRV::StorageClass::Output) {
326 Register Reg = MAI->getRegisterAlias(MF,
MI->getOperand(0).getReg());
335 MCInstLowering.
lower(
MI, TmpInst, MAI);
340 outputMCInst(TmpInst);
345void SPIRVAsmPrinter::outputGlobalRequirements() {
347 MAI->Reqs.checkSatisfiable(*ST);
349 for (
const auto &Cap : MAI->Reqs.getMinimalCapabilities()) {
357 for (
const auto &Ext : MAI->Reqs.getExtensions()) {
361 SPIRV::OperandCategory::ExtensionOperand, Ext),
368void SPIRVAsmPrinter::outputExtFuncDecls() {
373 for (;
I != E; ++
I) {
374 outputInstruction(*
I);
375 if ((
I + 1) == E || (*(
I + 1))->
getOpcode() == SPIRV::OpFunction)
376 outputOpFunctionEnd();
388 if (
IntegerType *IntTy = dyn_cast<IntegerType>(Ty)) {
389 switch (IntTy->getIntegerBitWidth()) {
403 Type *EleTy = VecTy->getElementType();
404 unsigned Size = VecTy->getNumElements();
413 if (
auto *CMeta = dyn_cast<ConstantAsMetadata>(MDOp)) {
417 }
else if (
auto *CE = dyn_cast<Function>(
C)) {
426void SPIRVAsmPrinter::outputExecutionModeFromMDNode(
428 unsigned ExpectMDOps, int64_t DefVal) {
436 unsigned NodeSz =
Node->getNumOperands();
437 if (ExpectMDOps > 0 && NodeSz < ExpectMDOps)
438 for (
unsigned i = NodeSz; i < ExpectMDOps; ++i)
443void SPIRVAsmPrinter::outputExecutionModeFromNumthreadsAttribute(
445 SPIRV::ExecutionMode::ExecutionMode EM) {
446 assert(Attr.
isValid() &&
"Function called with an invalid attribute.");
455 assert(NumThreads.
size() == 3 &&
"invalid numthreads");
458 [[maybe_unused]]
bool Result = NumThreads[i].getAsInteger(10, V);
459 assert(!Result &&
"Failed to parse numthreads");
466void SPIRVAsmPrinter::outputExecutionMode(
const Module &M) {
469 for (
unsigned i = 0; i <
Node->getNumOperands(); i++) {
476 for (
auto FI =
M.begin(), E =
M.end(); FI != E; ++FI) {
484 if (
MDNode *
Node =
F.getMetadata(
"reqd_work_group_size"))
485 outputExecutionModeFromMDNode(FReg,
Node, SPIRV::ExecutionMode::LocalSize,
488 outputExecutionModeFromNumthreadsAttribute(
489 FReg, Attr, SPIRV::ExecutionMode::LocalSize);
490 if (
MDNode *
Node =
F.getMetadata(
"work_group_size_hint"))
491 outputExecutionModeFromMDNode(FReg,
Node,
492 SPIRV::ExecutionMode::LocalSizeHint, 3, 1);
493 if (
MDNode *
Node =
F.getMetadata(
"intel_reqd_sub_group_size"))
494 outputExecutionModeFromMDNode(FReg,
Node,
495 SPIRV::ExecutionMode::SubgroupSize, 0, 0);
496 if (
MDNode *
Node =
F.getMetadata(
"vec_type_hint")) {
500 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::VecTypeHint);
506 if (
ST->isOpenCLEnv() && !
M.getNamedMetadata(
"spirv.ExecutionMode") &&
507 !
M.getNamedMetadata(
"opencl.enable.FP_CONTRACT")) {
511 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::ContractionOff);
518void SPIRVAsmPrinter::outputAnnotations(
const Module &M) {
521 for (
auto F =
M.global_begin(), E =
M.global_end();
F != E; ++
F) {
522 if ((*F).getName() !=
"llvm.global.annotations")
531 if (!isa<Function>(AnnotatedVar))
535 if (!
Reg.isValid()) {
539 DiagMsg =
"Unknown function in llvm.global.annotations: " + DiagMsg;
552 unsigned Dec =
static_cast<unsigned>(SPIRV::Decoration::UserSemantic);
560void SPIRVAsmPrinter::outputModuleSections() {
561 const Module *
M = MMI->getModule();
564 TII =
ST->getInstrInfo();
566 assert(ST &&
TII && MAI && M &&
"Module analysis is required");
569 outputGlobalRequirements();
571 outputOpExtInstImports(*M);
573 outputOpMemoryModel();
577 outputExecutionMode(*M);
580 outputDebugSourceAndStrings(*M);
586 outputAnnotations(*M);
593 outputExtFuncDecls();
598bool SPIRVAsmPrinter::doInitialization(
Module &M) {
599 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)