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 if (
MCAssembler *Asm = OutStreamer->getAssemblerPtr())
122void SPIRVAsmPrinter::emitFunctionHeader() {
123 if (ModuleSectionsEmitted ==
false) {
124 outputModuleSections();
125 ModuleSectionsEmitted =
true;
129 TII =
ST->getInstrInfo();
133 OutStreamer->getCommentOS()
134 <<
"-- Begin function "
138 auto Section = getObjFileLowering().SectionForGlobal(&
F,
TM);
139 MF->setSection(Section);
142void SPIRVAsmPrinter::outputOpFunctionEnd() {
144 FunctionEndInst.
setOpcode(SPIRV::OpFunctionEnd);
145 outputMCInst(FunctionEndInst);
149void SPIRVAsmPrinter::emitFunctionBodyEnd() {
150 outputOpFunctionEnd();
151 MAI->BBNumToRegMap.clear();
158 outputMCInst(LabelInst);
169 if (
MI.getOpcode() == SPIRV::OpFunction)
177void SPIRVAsmPrinter::printOperand(
const MachineInstr *
MI,
int OpNum,
219bool SPIRVAsmPrinter::PrintAsmOperand(
const MachineInstr *
MI,
unsigned OpNo,
221 if (ExtraCode && ExtraCode[0])
230 return TII->isHeaderInstr(*
MI) ||
MI->getOpcode() == SPIRV::OpFunction ||
231 MI->getOpcode() == SPIRV::OpFunctionParameter;
234void SPIRVAsmPrinter::outputMCInst(
MCInst &Inst) {
235 OutStreamer->emitInstruction(Inst, *OutContext.getSubtargetInfo());
241 MCInstLowering.
lower(
MI, TmpInst, MAI);
242 outputMCInst(TmpInst);
246 SPIRV_MC::verifyInstructionPredicates(
MI->getOpcode(),
247 getSubtargetInfo().getFeatureBits());
249 if (!MAI->getSkipEmission(
MI))
250 outputInstruction(
MI);
256 assert(
MI->getParent()->getNumber() == MF->front().getNumber() &&
257 "OpFunction is not in the front MBB of MF");
258 emitOpLabel(*
MI->getParent());
264 outputInstruction(
MI);
267void SPIRVAsmPrinter::outputDebugSourceAndStrings(
const Module &M) {
269 for (
auto &Str : MAI->SrcExt) {
271 Inst.
setOpcode(SPIRV::OpSourceExtension);
284void SPIRVAsmPrinter::outputOpExtInstImports(
const Module &M) {
285 for (
auto &
CU : MAI->ExtInstSetMap) {
286 unsigned Set =
CU.first;
292 static_cast<SPIRV::InstructionSet::InstructionSet
>(Set)),
298void SPIRVAsmPrinter::outputOpMemoryModel() {
310void SPIRVAsmPrinter::outputEntryPoints() {
314 assert(
MI->getOpcode() == SPIRV::OpVariable);
315 auto SC =
static_cast<SPIRV::StorageClass::StorageClass
>(
316 MI->getOperand(2).getImm());
322 SC == SPIRV::StorageClass::Input ||
SC == SPIRV::StorageClass::Output) {
324 Register Reg = MAI->getRegisterAlias(MF,
MI->getOperand(0).getReg());
333 MCInstLowering.
lower(
MI, TmpInst, MAI);
338 outputMCInst(TmpInst);
343void SPIRVAsmPrinter::outputGlobalRequirements() {
345 MAI->Reqs.checkSatisfiable(*ST);
347 for (
const auto &Cap : MAI->Reqs.getMinimalCapabilities()) {
355 for (
const auto &Ext : MAI->Reqs.getExtensions()) {
359 SPIRV::OperandCategory::ExtensionOperand, Ext),
366void SPIRVAsmPrinter::outputExtFuncDecls() {
371 for (;
I != E; ++
I) {
372 outputInstruction(*
I);
373 if ((
I + 1) == E || (*(
I + 1))->
getOpcode() == SPIRV::OpFunction)
374 outputOpFunctionEnd();
386 if (
IntegerType *IntTy = dyn_cast<IntegerType>(Ty)) {
387 switch (IntTy->getIntegerBitWidth()) {
401 Type *EleTy = VecTy->getElementType();
402 unsigned Size = VecTy->getNumElements();
411 if (
auto *CMeta = dyn_cast<ConstantAsMetadata>(MDOp)) {
415 }
else if (
auto *CE = dyn_cast<Function>(
C)) {
424void SPIRVAsmPrinter::outputExecutionModeFromMDNode(
434void SPIRVAsmPrinter::outputExecutionModeFromNumthreadsAttribute(
436 SPIRV::ExecutionMode::ExecutionMode EM) {
437 assert(Attr.
isValid() &&
"Function called with an invalid attribute.");
446 assert(NumThreads.
size() == 3 &&
"invalid numthreads");
449 [[maybe_unused]]
bool Result = NumThreads[i].getAsInteger(10, V);
450 assert(!Result &&
"Failed to parse numthreads");
457void SPIRVAsmPrinter::outputExecutionMode(
const Module &M) {
460 for (
unsigned i = 0; i <
Node->getNumOperands(); i++) {
467 for (
auto FI =
M.begin(), E =
M.end(); FI != E; ++FI) {
475 if (
MDNode *
Node =
F.getMetadata(
"reqd_work_group_size"))
476 outputExecutionModeFromMDNode(FReg,
Node,
477 SPIRV::ExecutionMode::LocalSize);
479 outputExecutionModeFromNumthreadsAttribute(
480 FReg, Attr, SPIRV::ExecutionMode::LocalSize);
481 if (
MDNode *
Node =
F.getMetadata(
"work_group_size_hint"))
482 outputExecutionModeFromMDNode(FReg,
Node,
483 SPIRV::ExecutionMode::LocalSizeHint);
484 if (
MDNode *
Node =
F.getMetadata(
"intel_reqd_sub_group_size"))
485 outputExecutionModeFromMDNode(FReg,
Node,
486 SPIRV::ExecutionMode::SubgroupSize);
487 if (
MDNode *
Node =
F.getMetadata(
"vec_type_hint")) {
491 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::VecTypeHint);
497 if (
ST->isOpenCLEnv() && !
M.getNamedMetadata(
"spirv.ExecutionMode") &&
498 !
M.getNamedMetadata(
"opencl.enable.FP_CONTRACT")) {
502 unsigned EM =
static_cast<unsigned>(SPIRV::ExecutionMode::ContractionOff);
509void SPIRVAsmPrinter::outputAnnotations(
const Module &M) {
512 for (
auto F =
M.global_begin(), E =
M.global_end();
F != E; ++
F) {
513 if ((*F).getName() !=
"llvm.global.annotations")
522 if (!isa<Function>(AnnotatedVar))
526 if (!
Reg.isValid()) {
530 DiagMsg =
"Unknown function in llvm.global.annotations: " + DiagMsg;
543 unsigned Dec =
static_cast<unsigned>(SPIRV::Decoration::UserSemantic);
551void SPIRVAsmPrinter::outputModuleSections() {
552 const Module *
M = MMI->getModule();
555 TII =
ST->getInstrInfo();
557 assert(ST &&
TII && MAI && M &&
"Module analysis is required");
560 outputGlobalRequirements();
562 outputOpExtInstImports(*M);
564 outputOpMemoryModel();
568 outputExecutionMode(*M);
571 outputDebugSourceAndStrings(*M);
577 outputAnnotations(*M);
584 outputExtFuncDecls();
589bool SPIRVAsmPrinter::doInitialization(
Module &M) {
590 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)