1//===-- XCoreAsmPrinter.cpp - XCore LLVM assembly writer ------------------===//
2//
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
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains a printer that converts from our internal representation
10// of machine-dependent LLVM code to the XAS-format XCore assembly language.
11//
12//===----------------------------------------------------------------------===//
13
14#include "XCoreAsmPrinter.h"
15#include "MCTargetDesc/XCoreInstPrinter.h"
16#include "MCTargetDesc/XCoreTargetStreamer.h"
17#include "TargetInfo/XCoreTargetInfo.h"
18#include "XCore.h"
19#include "XCoreMCInstLower.h"
20#include "XCoreSubtarget.h"
21#include "XCoreTargetMachine.h"
22#include "llvm/ADT/SmallString.h"
23#include "llvm/ADT/StringExtras.h"
24#include "llvm/CodeGen/AsmPrinter.h"
25#include "llvm/CodeGen/AsmPrinterAnalysis.h"
26#include "llvm/CodeGen/MachineConstantPool.h"
27#include "llvm/CodeGen/MachineInstr.h"
28#include "llvm/CodeGen/MachineJumpTableInfo.h"
29#include "llvm/CodeGen/MachineModuleInfo.h"
30#include "llvm/IR/DataLayout.h"
31#include "llvm/IR/DerivedTypes.h"
32#include "llvm/IR/Mangler.h"
33#include "llvm/MC/MCAsmInfo.h"
34#include "llvm/MC/MCExpr.h"
35#include "llvm/MC/MCInst.h"
36#include "llvm/MC/MCStreamer.h"
37#include "llvm/MC/TargetRegistry.h"
38#include "llvm/Support/Compiler.h"
39#include "llvm/Support/ErrorHandling.h"
40#include "llvm/Support/raw_ostream.h"
41#include "llvm/Target/TargetLoweringObjectFile.h"
42#include <algorithm>
43using namespace llvm;
44
45#define DEBUG_TYPE "asm-printer"
46
47namespace {
48 class XCoreAsmPrinter : public AsmPrinter {
49 XCoreMCInstLower MCInstLowering;
50 XCoreTargetStreamer &getTargetStreamer();
51
52 public:
53 static char ID;
54
55 explicit XCoreAsmPrinter(TargetMachine &TM,
56 std::unique_ptr<MCStreamer> Streamer)
57 : AsmPrinter(TM, std::move(Streamer), ID), MCInstLowering(*this) {}
58
59 StringRef getPassName() const override { return "XCore Assembly Printer"; }
60
61 void printInlineJT(const MachineInstr *MI, int opNum, raw_ostream &O,
62 const std::string &directive = ".jmptable");
63 void printInlineJT32(const MachineInstr *MI, int opNum, raw_ostream &O) {
64 printInlineJT(MI, opNum, O, directive: ".jmptable32");
65 }
66 void printOperand(const MachineInstr *MI, int opNum, raw_ostream &O);
67 bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
68 const char *ExtraCode, raw_ostream &O) override;
69 bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNum,
70 const char *ExtraCode, raw_ostream &O) override;
71
72 void emitArrayBound(MCSymbol *Sym, const GlobalVariable *GV);
73 void emitGlobalVariable(const GlobalVariable *GV) override;
74
75 void emitFunctionEntryLabel() override;
76 void emitInstruction(const MachineInstr *MI) override;
77 void emitFunctionBodyStart() override;
78 void emitFunctionBodyEnd() override;
79 };
80} // end of anonymous namespace
81
82XCoreTargetStreamer &XCoreAsmPrinter::getTargetStreamer() {
83 return static_cast<XCoreTargetStreamer&>(*OutStreamer->getTargetStreamer());
84}
85
86void XCoreAsmPrinter::emitArrayBound(MCSymbol *Sym, const GlobalVariable *GV) {
87 assert( ( GV->hasExternalLinkage() || GV->hasWeakLinkage() ||
88 GV->hasLinkOnceLinkage() || GV->hasCommonLinkage() ) &&
89 "Unexpected linkage");
90 if (ArrayType *ATy = dyn_cast<ArrayType>(Val: GV->getValueType())) {
91
92 MCSymbol *SymGlob = OutContext.getOrCreateSymbol(
93 Name: Twine(Sym->getName() + StringRef(".globound")));
94 OutStreamer->emitSymbolAttribute(Symbol: SymGlob, Attribute: MCSA_Global);
95 OutStreamer->emitAssignment(Symbol: SymGlob,
96 Value: MCConstantExpr::create(Value: ATy->getNumElements(),
97 Ctx&: OutContext));
98 if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage() ||
99 GV->hasCommonLinkage()) {
100 OutStreamer->emitSymbolAttribute(Symbol: SymGlob, Attribute: MCSA_Weak);
101 }
102 }
103}
104
105void XCoreAsmPrinter::emitGlobalVariable(const GlobalVariable *GV) {
106 // Check to see if this is a special global used by LLVM, if so, emit it.
107 if (!GV->hasInitializer() || emitSpecialLLVMGlobal(GV))
108 return;
109
110 const DataLayout &DL = getDataLayout();
111 OutStreamer->switchSection(Section: getObjFileLowering().SectionForGlobal(GO: GV, TM));
112
113 MCSymbol *GVSym = getSymbol(GV);
114 const Constant *C = GV->getInitializer();
115 const Align Alignment = DL.getPrefTypeAlign(Ty: C->getType());
116
117 // Mark the start of the global
118 getTargetStreamer().emitCCTopData(Name: GVSym->getName());
119
120 switch (GV->getLinkage()) {
121 case GlobalValue::AppendingLinkage:
122 report_fatal_error(reason: "AppendingLinkage is not supported by this target!");
123 case GlobalValue::LinkOnceAnyLinkage:
124 case GlobalValue::LinkOnceODRLinkage:
125 case GlobalValue::WeakAnyLinkage:
126 case GlobalValue::WeakODRLinkage:
127 case GlobalValue::ExternalLinkage:
128 case GlobalValue::CommonLinkage:
129 emitArrayBound(Sym: GVSym, GV);
130 OutStreamer->emitSymbolAttribute(Symbol: GVSym, Attribute: MCSA_Global);
131
132 if (GV->hasWeakLinkage() || GV->hasLinkOnceLinkage() ||
133 GV->hasCommonLinkage())
134 OutStreamer->emitSymbolAttribute(Symbol: GVSym, Attribute: MCSA_Weak);
135 [[fallthrough]];
136 case GlobalValue::InternalLinkage:
137 case GlobalValue::PrivateLinkage:
138 break;
139 default:
140 llvm_unreachable("Unknown linkage type!");
141 }
142
143 emitAlignment(Alignment: std::max(a: Alignment, b: Align(4)), GV);
144
145 if (GV->isThreadLocal()) {
146 report_fatal_error(reason: "TLS is not supported by this target!");
147 }
148 unsigned Size = DL.getTypeAllocSize(Ty: C->getType());
149 if (MAI.hasDotTypeDotSizeDirective()) {
150 OutStreamer->emitSymbolAttribute(Symbol: GVSym, Attribute: MCSA_ELF_TypeObject);
151 OutStreamer->emitELFSize(Symbol: GVSym, Value: MCConstantExpr::create(Value: Size, Ctx&: OutContext));
152 }
153 OutStreamer->emitLabel(Symbol: GVSym);
154
155 emitGlobalConstant(DL, CV: C);
156 // The ABI requires that unsigned scalar types smaller than 32 bits
157 // are padded to 32 bits.
158 if (Size < 4)
159 OutStreamer->emitZeros(NumBytes: 4 - Size);
160
161 // Mark the end of the global
162 getTargetStreamer().emitCCBottomData(Name: GVSym->getName());
163}
164
165void XCoreAsmPrinter::emitFunctionBodyStart() {
166 MCInstLowering.Initialize(C: &MF->getContext());
167}
168
169/// EmitFunctionBodyEnd - Targets can override this to emit stuff after
170/// the last basic block in the function.
171void XCoreAsmPrinter::emitFunctionBodyEnd() {
172 // Emit function end directives
173 getTargetStreamer().emitCCBottomFunction(Name: CurrentFnSym->getName());
174}
175
176void XCoreAsmPrinter::emitFunctionEntryLabel() {
177 // Mark the start of the function
178 getTargetStreamer().emitCCTopFunction(Name: CurrentFnSym->getName());
179 OutStreamer->emitLabel(Symbol: CurrentFnSym);
180}
181
182void XCoreAsmPrinter::
183printInlineJT(const MachineInstr *MI, int opNum, raw_ostream &O,
184 const std::string &directive) {
185 unsigned JTI = MI->getOperand(i: opNum).getIndex();
186 const MachineFunction *MF = MI->getParent()->getParent();
187 const MachineJumpTableInfo *MJTI = MF->getJumpTableInfo();
188 const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
189 const std::vector<MachineBasicBlock*> &JTBBs = JT[JTI].MBBs;
190 O << "\t" << directive << " ";
191 for (unsigned i = 0, e = JTBBs.size(); i != e; ++i) {
192 MachineBasicBlock *MBB = JTBBs[i];
193 if (i > 0)
194 O << ",";
195 MBB->getSymbol()->print(OS&: O, MAI);
196 }
197}
198
199void XCoreAsmPrinter::printOperand(const MachineInstr *MI, int opNum,
200 raw_ostream &O) {
201 const DataLayout &DL = getDataLayout();
202 const MachineOperand &MO = MI->getOperand(i: opNum);
203 switch (MO.getType()) {
204 case MachineOperand::MO_Register:
205 O << XCoreInstPrinter::getRegisterName(Reg: MO.getReg());
206 break;
207 case MachineOperand::MO_Immediate:
208 O << MO.getImm();
209 break;
210 case MachineOperand::MO_MachineBasicBlock:
211 MO.getMBB()->getSymbol()->print(OS&: O, MAI);
212 break;
213 case MachineOperand::MO_GlobalAddress:
214 PrintSymbolOperand(MO, OS&: O);
215 break;
216 case MachineOperand::MO_ConstantPoolIndex:
217 O << DL.getInternalSymbolPrefix() << "CPI" << getFunctionNumber() << '_'
218 << MO.getIndex();
219 break;
220 case MachineOperand::MO_BlockAddress:
221 GetBlockAddressSymbol(BA: MO.getBlockAddress())->print(OS&: O, MAI);
222 break;
223 default:
224 llvm_unreachable("not implemented");
225 }
226}
227
228/// PrintAsmOperand - Print out an operand for an inline asm expression.
229///
230bool XCoreAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
231 const char *ExtraCode, raw_ostream &O) {
232 // Print the operand if there is no operand modifier.
233 if (!ExtraCode || !ExtraCode[0]) {
234 printOperand(MI, opNum: OpNo, O);
235 return false;
236 }
237
238 // Otherwise fallback on the default implementation.
239 return AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS&: O);
240}
241
242bool XCoreAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
243 unsigned OpNum,
244 const char *ExtraCode,
245 raw_ostream &O) {
246 if (ExtraCode && ExtraCode[0]) {
247 return true; // Unknown modifier.
248 }
249 printOperand(MI, opNum: OpNum, O);
250 O << '[';
251 printOperand(MI, opNum: OpNum + 1, O);
252 O << ']';
253 return false;
254}
255
256void XCoreAsmPrinter::emitInstruction(const MachineInstr *MI) {
257 XCore_MC::verifyInstructionPredicates(Opcode: MI->getOpcode(),
258 Features: getSubtargetInfo().getFeatureBits());
259
260 SmallString<128> Str;
261 raw_svector_ostream O(Str);
262
263 switch (MI->getOpcode()) {
264 case XCore::DBG_VALUE:
265 llvm_unreachable("Should be handled target independently");
266 case XCore::ADD_2rus:
267 if (MI->getOperand(i: 2).getImm() == 0) {
268 O << "\tmov "
269 << XCoreInstPrinter::getRegisterName(Reg: MI->getOperand(i: 0).getReg()) << ", "
270 << XCoreInstPrinter::getRegisterName(Reg: MI->getOperand(i: 1).getReg());
271 OutStreamer->emitRawText(String: O.str());
272 return;
273 }
274 break;
275 case XCore::BR_JT:
276 case XCore::BR_JT32:
277 O << "\tbru "
278 << XCoreInstPrinter::getRegisterName(Reg: MI->getOperand(i: 1).getReg()) << '\n';
279 if (MI->getOpcode() == XCore::BR_JT)
280 printInlineJT(MI, opNum: 0, O);
281 else
282 printInlineJT32(MI, opNum: 0, O);
283 O << '\n';
284 OutStreamer->emitRawText(String: O.str());
285 return;
286 }
287
288 MCInst TmpInst;
289 MCInstLowering.Lower(MI, OutMI&: TmpInst);
290
291 EmitToStreamer(S&: *OutStreamer, Inst: TmpInst);
292}
293
294char XCoreAsmPrinter::ID = 0;
295
296INITIALIZE_PASS(XCoreAsmPrinter, "xcore-asm-printer", "XCore Assembly Printer",
297 false, false)
298
299// Force static initialization.
300extern "C" LLVM_ABI LLVM_EXTERNAL_VISIBILITY void
301LLVMInitializeXCoreAsmPrinter() {
302 RegisterAsmPrinter<XCoreAsmPrinter> X(getTheXCoreTarget());
303}
304
305PreservedAnalyses XCoreAsmPrinterBeginPass::run(Module &M,
306 ModuleAnalysisManager &MAM) {
307 XCoreAsmPrinter &AsmPrinter = static_cast<XCoreAsmPrinter &>(
308 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
309 setupModuleAsmPrinter(M, MAM, AsmPrinter);
310 AsmPrinter.doInitialization(M);
311 return PreservedAnalyses::all();
312}
313
314PreservedAnalyses
315XCoreAsmPrinterPass::run(MachineFunction &MF,
316 MachineFunctionAnalysisManager &MFAM) {
317 XCoreAsmPrinter &AsmPrinter = static_cast<XCoreAsmPrinter &>(
318 MFAM.getResult<ModuleAnalysisManagerMachineFunctionProxy>(IR&: MF)
319 .getCachedResult<AsmPrinterAnalysis>(IR&: *MF.getFunction().getParent())
320 ->getPrinter());
321 setupMachineFunctionAsmPrinter(MFAM, MF, AsmPrinter);
322 AsmPrinter.runOnMachineFunction(MF);
323 return PreservedAnalyses::all();
324}
325
326PreservedAnalyses XCoreAsmPrinterEndPass::run(Module &M,
327 ModuleAnalysisManager &MAM) {
328 XCoreAsmPrinter &AsmPrinter = static_cast<XCoreAsmPrinter &>(
329 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
330 setupModuleAsmPrinter(M, MAM, AsmPrinter);
331 AsmPrinter.doFinalization(M);
332 return PreservedAnalyses::all();
333}
334