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