LLVM 17.0.0git
Go to the documentation of this file.
1//===-- CSKYAsmPrinter.cpp - CSKY LLVM assembly writer --------------------===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
9// This file contains a printer that converts from our internal representation
10// of machine-dependent LLVM code to the CSKY assembly language.
13#include "CSKYAsmPrinter.h"
14#include "CSKY.h"
16#include "CSKYTargetMachine.h"
21#include "llvm/ADT/Statistic.h"
25#include "llvm/IR/DataLayout.h"
26#include "llvm/MC/MCAsmInfo.h"
27#include "llvm/MC/MCContext.h"
29#include "llvm/MC/MCStreamer.h"
32using namespace llvm;
34#define DEBUG_TYPE "csky-asm-printer"
37 "Number of C-SKY Compressed instructions emitted");
40 std::unique_ptr<llvm::MCStreamer> Streamer)
41 : AsmPrinter(TM, std::move(Streamer)), MCInstLowering(OutContext, *this) {}
44 MCP = MF.getConstantPool();
47 // Set the current MCSubtargetInfo to a copy which has the correct
48 // feature bits for the current MachineFunction
49 MCSubtargetInfo &NewSTI =
50 OutStreamer->getContext().getSubtargetCopy(*TM.getMCSubtargetInfo());
52 Subtarget = &NewSTI;
58#include "CSKYGenCompressInstEmitter.inc"
60 MCInst CInst;
61 bool Res = compressInst(CInst, Inst, *Subtarget);
62 if (Res)
63 ++CSKYNumInstrsCompressed;
64 AsmPrinter::EmitToStreamer(*OutStreamer, Res ? CInst : Inst);
67// Simple pseudo-instructions have their lowering (with expansion to real
68// instructions) auto-generated.
69#include "CSKYGenMCPseudoLowering.inc"
71void CSKYAsmPrinter::expandTLSLA(const MachineInstr *MI) {
72 DebugLoc DL = MI->getDebugLoc();
76 "_" + Twine(MI->getOperand(3).getImm()));
78 OutStreamer->emitLabel(PCLabel);
80 auto Instr = BuildMI(*MF, DL, TII->get(CSKY::LRW32))
81 .add(MI->getOperand(0))
82 .add(MI->getOperand(2));
83 MCInst LRWInst;
84 MCInstLowering.Lower(Instr, LRWInst);
85 EmitToStreamer(*OutStreamer, LRWInst);
87 Instr = BuildMI(*MF, DL, TII->get(CSKY::GRS32))
88 .add(MI->getOperand(1))
89 .addSym(PCLabel);
90 MCInst GRSInst;
91 MCInstLowering.Lower(Instr, GRSInst);
92 EmitToStreamer(*OutStreamer, GRSInst);
93 return;
96void CSKYAsmPrinter::emitCustomConstantPool(const MachineInstr *MI) {
98 // This instruction represents a floating constant pool in the function.
99 // The first operand is the ID# for this instruction, the second is the
100 // index into the MachineConstantPool that this is, the third is the size
101 // in bytes of this constant pool entry.
102 // The required alignment is specified on the basic block holding this MI.
103 unsigned LabelId = (unsigned)MI->getOperand(0).getImm();
104 unsigned CPIdx = (unsigned)MI->getOperand(1).getIndex();
106 // If this is the first entry of the pool, mark it.
107 if (!InConstantPool) {
108 OutStreamer->emitValueToAlignment(Align(4));
109 InConstantPool = true;
110 }
112 OutStreamer->emitLabel(GetCPISymbol(LabelId));
114 const MachineConstantPoolEntry &MCPE = MCP->getConstants()[CPIdx];
117 else
119 return;
123 // Make sure to terminate any constant pools that were at the end
124 // of the function.
125 if (!InConstantPool)
126 return;
127 InConstantPool = false;
132 emitAttributes();
136 CSKYTargetStreamer &CTS =
137 static_cast<CSKYTargetStreamer &>(*OutStreamer->getTargetStreamer());
144 CSKY_MC::verifyInstructionPredicates(MI->getOpcode(),
145 getSubtargetInfo().getFeatureBits());
147 // Do any auto-generated pseudo lowerings.
149 return;
151 // If we just ended a constant pool, mark it as such.
152 if (InConstantPool && MI->getOpcode() != CSKY::CONSTPOOL_ENTRY) {
153 InConstantPool = false;
154 }
156 if (MI->getOpcode() == CSKY::PseudoTLSLA32)
157 return expandTLSLA(MI);
159 if (MI->getOpcode() == CSKY::CONSTPOOL_ENTRY)
160 return emitCustomConstantPool(MI);
162 MCInst TmpInst;
163 MCInstLowering.Lower(MI, TmpInst);
164 EmitToStreamer(*OutStreamer, TmpInst);
167// Convert a CSKY-specific constant pool modifier into the associated
168// MCSymbolRefExpr variant kind.
171 switch (Modifier) {
172 case CSKYCP::NO_MOD:
174 case CSKYCP::ADDR:
176 case CSKYCP::GOT:
178 case CSKYCP::GOTOFF:
180 case CSKYCP::PLT:
182 case CSKYCP::TLSGD:
184 case CSKYCP::TLSLE:
186 case CSKYCP::TLSIE:
188 }
189 llvm_unreachable("Invalid CSKYCPModifier!");
195 CSKYConstantPoolValue *CCPV = static_cast<CSKYConstantPoolValue *>(MCPV);
196 MCSymbol *MCSym;
198 if (CCPV->isBlockAddress()) {
199 const BlockAddress *BA =
200 cast<CSKYConstantPoolConstant>(CCPV)->getBlockAddress();
201 MCSym = GetBlockAddressSymbol(BA);
202 } else if (CCPV->isGlobalValue()) {
203 const GlobalValue *GV = cast<CSKYConstantPoolConstant>(CCPV)->getGV();
204 MCSym = getSymbol(GV);
205 } else if (CCPV->isMachineBasicBlock()) {
206 const MachineBasicBlock *MBB = cast<CSKYConstantPoolMBB>(CCPV)->getMBB();
207 MCSym = MBB->getSymbol();
208 } else if (CCPV->isJT()) {
209 signed JTI = cast<CSKYConstantPoolJT>(CCPV)->getJTI();
210 MCSym = GetJTISymbol(JTI);
211 } else if (CCPV->isConstPool()) {
212 const Constant *C = cast<CSKYConstantPoolConstant>(CCPV)->getConstantPool();
213 MCSym = GetCPISymbol(MCP->getConstantPoolIndex(C, Align(4)));
214 } else {
215 assert(CCPV->isExtSymbol() && "unrecognized constant pool value");
216 StringRef Sym = cast<CSKYConstantPoolSymbol>(CCPV)->getSymbol();
217 MCSym = GetExternalSymbolSymbol(Sym);
218 }
219 // Create an MCSymbol for the reference.
220 const MCExpr *Expr =
223 if (CCPV->getPCAdjustment()) {
226 Twine(MAI->getPrivateGlobalPrefix()) + "PC" +
227 Twine(getFunctionNumber()) + "_" + Twine(CCPV->getLabelID()));
229 const MCExpr *PCRelExpr = MCSymbolRefExpr::create(PCLabel, OutContext);
230 if (CCPV->mustAddCurrentAddress()) {
231 // We want "(<expr> - .)", but MC doesn't have a concept of the '.'
232 // label, so just emit a local label end reference that instead.
234 OutStreamer->emitLabel(DotSym);
235 const MCExpr *DotExpr = MCSymbolRefExpr::create(DotSym, OutContext);
236 PCRelExpr = MCBinaryExpr::createSub(PCRelExpr, DotExpr, OutContext);
237 }
238 Expr = MCBinaryExpr::createSub(Expr, PCRelExpr, OutContext);
239 }
241 // Create an MCSymbol for the reference.
243 OutContext);
245 OutStreamer->emitValue(Expr, Size);
248void CSKYAsmPrinter::emitAttributes() {
249 CSKYTargetStreamer &CTS =
250 static_cast<CSKYTargetStreamer &>(*OutStreamer->getTargetStreamer());
252 const Triple &TT = TM.getTargetTriple();
253 StringRef CPU = TM.getTargetCPU();
255 const CSKYTargetMachine &CTM = static_cast<const CSKYTargetMachine &>(TM);
256 /* TuneCPU doesn't impact emission of ELF attributes, ELF attributes only
257 care about arch related features, so we can set TuneCPU as CPU. */
258 const CSKYSubtarget STI(TT, CPU, /*TuneCPU=*/CPU, FS, CTM);
260 CTS.emitTargetAttributes(STI);
264 const char *ExtraCode, raw_ostream &OS) {
265 // First try the generic code, which knows about modifiers like 'c' and 'n'.
266 if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
267 return false;
269 const MachineOperand &MO = MI->getOperand(OpNo);
270 if (ExtraCode && ExtraCode[0]) {
271 if (ExtraCode[1] != 0)
272 return true; // Unknown modifier.
274 switch (ExtraCode[0]) {
275 default:
276 return true; // Unknown modifier.
277 case 'R':
280 return false;
281 }
282 }
283 }
285 switch (MO.getType()) {
287 OS << MO.getImm();
288 return false;
290 if (MO.getReg() == CSKY::C)
291 return false;
293 return false;
296 return false;
299 Sym->print(OS, MAI);
300 return false;
301 }
302 default:
303 break;
304 }
306 return true;
310 unsigned OpNo, const char *ExtraCode,
311 raw_ostream &OS) {
312 if (!ExtraCode) {
313 const MachineOperand &MO = MI->getOperand(OpNo);
314 // For now, we only support register memory operands in registers and
315 // assume there is no addend
316 if (!MO.isReg())
317 return true;
319 OS << "(" << CSKYInstPrinter::getRegisterName(MO.getReg()) << ", 0)";
320 return false;
321 }
323 return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
MachineBasicBlock & MBB
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
static MCSymbolRefExpr::VariantKind getModifierVariantKind(ARMCP::ARMCPModifier Modifier)
Definition: Compiler.h:127
uint64_t Size
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
IRTranslator LLVM IR MI
This file declares the MachineConstantPool class which is an abstract constant pool to keep track of ...
const char LLVMTargetMachineRef TM
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
raw_pwrite_stream & OS
This file defines the 'Statistic' class, which is designed to be an easy way to expose various metric...
Definition: Statistic.h:167
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:84
MCSymbol * getSymbol(const GlobalValue *GV) const
Definition: AsmPrinter.cpp:662
void EmitToStreamer(MCStreamer &S, const MCInst &Inst)
Definition: AsmPrinter.cpp:398
TargetMachine & TM
Target machine description.
Definition: AsmPrinter.h:87
virtual MCSymbol * GetCPISymbol(unsigned CPID) const
Return the symbol for the specified constant pool entry.
virtual void PrintSymbolOperand(const MachineOperand &MO, raw_ostream &OS)
Print the MachineOperand as a symbol.
const MCAsmInfo * MAI
Target Asm Printer information.
Definition: AsmPrinter.h:90
MachineFunction * MF
The current machine function.
Definition: AsmPrinter.h:102
MCSymbol * GetJTISymbol(unsigned JTID, bool isLinkerPrivate=false) const
Return the symbol for the specified jump table entry.
unsigned getFunctionNumber() const
Return a unique ID for the current function.
Definition: AsmPrinter.cpp:375
void emitGlobalConstant(const DataLayout &DL, const Constant *CV, AliasMapTy *AliasList=nullptr)
EmitGlobalConstant - Print a general LLVM constant to the .s file.
MCContext & OutContext
This is the context for the output file that we are streaming.
Definition: AsmPrinter.h:94
MCSymbol * GetExternalSymbolSymbol(StringRef Sym) const
Return the MCSymbol for the specified ExternalSymbol.
bool runOnMachineFunction(MachineFunction &MF) override
Emit the specified function out to the OutStreamer.
Definition: AsmPrinter.h:399
std::unique_ptr< MCStreamer > OutStreamer
This is the MCStreamer object for the file we are generating.
Definition: AsmPrinter.h:99
virtual bool PrintAsmMemoryOperand(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 as...
MCSymbol * GetBlockAddressSymbol(const BlockAddress *BA) const
Return the MCSymbol used to satisfy BlockAddress uses of the specified basic block.
const DataLayout & getDataLayout() const
Return information about data layout.
Definition: AsmPrinter.cpp:383
const MCSubtargetInfo & getSubtargetInfo() const
Return information about subtarget.
Definition: AsmPrinter.cpp:393
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.
The address of a basic block.
Definition: Constants.h:879
void emitFunctionBodyEnd() override
Targets can override this to emit stuff after the last basic block in the function.
void EmitToStreamer(MCStreamer &S, const MCInst &Inst)
CSKYAsmPrinter(TargetMachine &TM, std::unique_ptr< MCStreamer > Streamer)
bool emitPseudoExpansionLowering(MCStreamer &OutStreamer, const MachineInstr *MI)
tblgen'erated driver function for lowering simple MI->MC pseudo instructions.
bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS) override
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant.
void emitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) override
bool runOnMachineFunction(MachineFunction &MF) override
Emit the specified function out to the OutStreamer.
void emitEndOfAsmFile(Module &M) override
This virtual method can be overridden by targets that want to emit something at the end of their file...
void emitInstruction(const MachineInstr *MI) override
Targets should implement this to emit instructions.
void emitStartOfAsmFile(Module &M) override
This virtual method can be overridden by targets that want to emit something at the start of their fi...
bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS) override
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant as...
CSKYConstantPoolValue - CSKY specific constantpool value.
CSKYCP::CSKYCPModifier getModifier() const
static const char * getRegisterName(MCRegister Reg)
static const CSKYMCExpr * create(const MCExpr *Expr, VariantKind Kind, MCContext &Ctx)
Definition: CSKYMCExpr.cpp:22
void Lower(const MachineInstr *MI, MCInst &OutMI) const
virtual void emitTargetAttributes(const MCSubtargetInfo &STI)
This is an important base class in LLVM.
Definition: Constant.h:41
TypeSize getTypeAllocSize(Type *Ty) const
Returns the offset in bytes between successive objects of the specified type, including alignment pad...
Definition: DataLayout.h:500
A debug info location.
Definition: DebugLoc.h:33
StringRef getPrivateGlobalPrefix() const
Definition: MCAsmInfo.h:668
static const MCBinaryExpr * createSub(const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx)
Definition: MCExpr.h:610
MCSymbol * createTempSymbol()
Create a temporary symbol with a unique name.
Definition: MCContext.cpp:318
MCSymbol * getOrCreateSymbol(const Twine &Name)
Lookup the symbol inside with the specified Name.
Definition: MCContext.cpp:201
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
Instances of this class represent a single low-level machine instruction.
Definition: MCInst.h:184
const MCInstrDesc & get(unsigned Opcode) const
Return the machine instruction descriptor that corresponds to the specified instruction opcode.
Definition: MCInstrInfo.h:63
Streaming machine code generation interface.
Definition: MCStreamer.h:212
Generic base class for all target subtargets.
void setFeatureBits(const FeatureBitset &FeatureBits_)
const FeatureBitset & getFeatureBits() const
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx)
Definition: MCExpr.h:386
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
void print(raw_ostream &OS, const MCAsmInfo *MAI) const
print - Print the value to the stream OS.
Definition: MCSymbol.cpp:58
MCSymbol * getSymbol() const
Return the MCSymbol for this basic block.
This class is a data container for one entry in a MachineConstantPool.
bool isMachineConstantPoolEntry() const
isMachineConstantPoolEntry - Return true if the MachineConstantPoolEntry is indeed a target specific ...
MachineConstantPoolValue * MachineCPVal
union llvm::MachineConstantPoolEntry::@193 Val
The constant itself.
Abstract base class for all machine specific constantpool value subclasses.
const std::vector< MachineConstantPoolEntry > & getConstants() const
unsigned getConstantPoolIndex(const Constant *C, Align Alignment)
getConstantPoolIndex - Create a new entry in the constant pool or return an existing one.
const TargetSubtargetInfo & getSubtarget() const
getSubtarget - Return the subtarget for which this machine code is being compiled.
const DataLayout & getDataLayout() const
Return the DataLayout attached to the Module associated to this MF.
MachineConstantPool * getConstantPool()
getConstantPool - Return the constant pool object for the current function.
const MachineInstrBuilder & add(const MachineOperand &MO) const
const MachineInstrBuilder & addSym(MCSymbol *Sym, unsigned char TargetFlags=0) const
Representation of each machine instruction.
Definition: MachineInstr.h:68
MachineOperand class - Representation of each machine instruction operand.
int64_t getImm() const
bool isReg() const
isReg - Tests if this is a MO_Register operand.
const BlockAddress * getBlockAddress() const
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
Register getReg() const
getReg - Returns the register number.
@ MO_Immediate
Immediate operand.
@ MO_GlobalAddress
Address of a global value.
@ MO_BlockAddress
Address of a basic block.
@ MO_Register
Register operand.
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Primary interface to the complete machine description for the target machine.
Definition: TargetMachine.h:78
const Triple & getTargetTriple() const
const MCSubtargetInfo * getMCSubtargetInfo() const
StringRef getTargetFeatureString() const
StringRef getTargetCPU() const
virtual const TargetInstrInfo * getInstrInfo() const
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:44
bool isOSBinFormatELF() const
Tests whether the OS uses the ELF binary format.
Definition: Triple.h:675
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
MachineInstrBuilder BuildMI(MachineFunction &MF, const MIMetadata &MIMD, const MCInstrDesc &MCID)
Builder interface. Specify how to create the initial instruction itself.
Target & getTheCSKYTarget()
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1946
Definition: BitVector.h:858
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
RegisterAsmPrinter - Helper template for registering a target specific assembly printer,...