1//===-- AVRAsmPrinter.cpp - AVR 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 GAS-format AVR assembly language.
11//
12//===----------------------------------------------------------------------===//
13
14#include "AVRAsmPrinter.h"
15#include "AVR.h"
16#include "AVRMCInstLower.h"
17#include "AVRSubtarget.h"
18#include "AVRTargetMachine.h"
19#include "MCTargetDesc/AVRInstPrinter.h"
20#include "MCTargetDesc/AVRMCAsmInfo.h"
21#include "TargetInfo/AVRTargetInfo.h"
22
23#include "llvm/CodeGen/AsmPrinter.h"
24#include "llvm/CodeGen/AsmPrinterAnalysis.h"
25#include "llvm/CodeGen/MachineFunction.h"
26#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
27#include "llvm/CodeGen/MachineInstr.h"
28#include "llvm/CodeGen/MachineModuleInfo.h"
29#include "llvm/CodeGen/TargetRegisterInfo.h"
30#include "llvm/CodeGen/TargetSubtargetInfo.h"
31#include "llvm/IR/Analysis.h"
32#include "llvm/IR/Mangler.h"
33#include "llvm/IR/Module.h"
34#include "llvm/IR/PassManager.h"
35#include "llvm/MC/MCContext.h"
36#include "llvm/MC/MCInst.h"
37#include "llvm/MC/MCSectionELF.h"
38#include "llvm/MC/MCStreamer.h"
39#include "llvm/MC/MCSymbol.h"
40#include "llvm/MC/TargetRegistry.h"
41#include "llvm/Support/Compiler.h"
42#include "llvm/Support/ErrorHandling.h"
43#include "llvm/Support/raw_ostream.h"
44#include "llvm/Target/TargetLoweringObjectFile.h"
45
46#define DEBUG_TYPE "avr-asm-printer"
47
48using namespace llvm;
49
50namespace {
51
52/// An AVR assembly code printer.
53class AVRAsmPrinter : public AsmPrinter {
54public:
55 AVRAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
56 : AsmPrinter(TM, std::move(Streamer), ID), MRI(TM.getMCRegisterInfo()) {}
57
58 StringRef getPassName() const override { return "AVR Assembly Printer"; }
59
60 void printOperand(const MachineInstr *MI, unsigned OpNo, raw_ostream &O);
61
62 bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNum,
63 const char *ExtraCode, raw_ostream &O) override;
64
65 bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNum,
66 const char *ExtraCode, raw_ostream &O) override;
67
68 void emitInstruction(const MachineInstr *MI) override;
69
70 const MCExpr *lowerConstant(const Constant *CV, const Constant *BaseCV,
71 uint64_t Offset) override;
72
73 void emitXXStructor(const DataLayout &DL, const Constant *CV) override;
74
75 bool doFinalization(Module &M) override;
76
77 void emitStartOfAsmFile(Module &M) override;
78
79 static char ID;
80
81private:
82 const MCRegisterInfo &MRI;
83 bool EmittedStructorSymbolAttrs = false;
84};
85
86} // namespace
87
88void AVRAsmPrinter::printOperand(const MachineInstr *MI, unsigned OpNo,
89 raw_ostream &O) {
90 const MachineOperand &MO = MI->getOperand(i: OpNo);
91
92 switch (MO.getType()) {
93 case MachineOperand::MO_Register:
94 O << AVRInstPrinter::getPrettyRegisterName(Reg: MO.getReg(), MRI);
95 break;
96 case MachineOperand::MO_Immediate:
97 O << MO.getImm();
98 break;
99 case MachineOperand::MO_GlobalAddress:
100 O << getSymbol(GV: MO.getGlobal());
101 break;
102 case MachineOperand::MO_ExternalSymbol:
103 O << *GetExternalSymbolSymbol(Sym: MO.getSymbolName());
104 break;
105 case MachineOperand::MO_MachineBasicBlock:
106 O << *MO.getMBB()->getSymbol();
107 break;
108 default:
109 llvm_unreachable("Not implemented yet!");
110 }
111}
112
113bool AVRAsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNum,
114 const char *ExtraCode, raw_ostream &O) {
115 // Default asm printer can only deal with some extra codes,
116 // so try it first.
117 if (!AsmPrinter::PrintAsmOperand(MI, OpNo: OpNum, ExtraCode, OS&: O))
118 return false;
119
120 const MachineOperand &MO = MI->getOperand(i: OpNum);
121
122 // Operand must be a register when using 'A' ~ 'Z' extra code.
123 if (ExtraCode && ExtraCode[0] && MO.isReg()) {
124 // Unknown extra code.
125 if (ExtraCode[1] != 0 || ExtraCode[0] < 'A' || ExtraCode[0] > 'Z')
126 return true;
127
128 Register Reg = MO.getReg();
129
130 unsigned ByteNumber = ExtraCode[0] - 'A';
131 const InlineAsm::Flag OpFlags(MI->getOperand(i: OpNum - 1).getImm());
132 const unsigned NumOpRegs = OpFlags.getNumOperandRegisters();
133
134 const AVRSubtarget &STI = MF->getSubtarget<AVRSubtarget>();
135 const TargetRegisterInfo &TRI = *STI.getRegisterInfo();
136
137 const TargetRegisterClass *RC = TRI.getMinimalPhysRegClass(Reg);
138 unsigned BytesPerReg = TRI.getRegSizeInBits(RC: *RC) / 8;
139 assert(BytesPerReg <= 2 && "Only 8 and 16 bit regs are supported.");
140
141 unsigned RegIdx = ByteNumber / BytesPerReg;
142 if (RegIdx >= NumOpRegs)
143 return true;
144 Reg = MI->getOperand(i: OpNum + RegIdx).getReg();
145
146 if (BytesPerReg == 2) {
147 Reg = TRI.getSubReg(Reg, Idx: (ByteNumber % BytesPerReg) ? AVR::sub_hi
148 : AVR::sub_lo);
149 }
150
151 O << AVRInstPrinter::getPrettyRegisterName(Reg, MRI);
152 return false;
153 }
154
155 if (MO.getType() == MachineOperand::MO_GlobalAddress)
156 PrintSymbolOperand(MO, OS&: O); // Print global symbols.
157 else
158 printOperand(MI, OpNo: OpNum, O); // Fallback to ordinary cases.
159
160 return false;
161}
162
163bool AVRAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
164 unsigned OpNum, const char *ExtraCode,
165 raw_ostream &O) {
166 if (ExtraCode && ExtraCode[0])
167 return true; // Unknown modifier
168
169 const MachineOperand &MO = MI->getOperand(i: OpNum);
170
171 // Print direct memory operands.
172 if (MO.isGlobal() || MO.isSymbol() || MO.isMCSymbol()) {
173 PrintSymbolOperand(MO, OS&: O);
174 return false;
175 }
176
177 assert(MO.isReg() && "Unexpected inline asm memory operand");
178
179 // TODO: We should be able to look up the alternative name for
180 // the register if it's given.
181 // TableGen doesn't expose a way of getting retrieving names
182 // for registers.
183 if (MI->getOperand(i: OpNum).getReg() == AVR::R31R30) {
184 O << "Z";
185 } else if (MI->getOperand(i: OpNum).getReg() == AVR::R29R28) {
186 O << "Y";
187 } else if (MI->getOperand(i: OpNum).getReg() == AVR::R27R26) {
188 O << "X";
189 } else {
190 assert(false && "Wrong register class for memory operand.");
191 }
192
193 // If NumOpRegs == 2, then we assume it is product of a FrameIndex expansion
194 // and the second operand is an Imm.
195 const InlineAsm::Flag OpFlags(MI->getOperand(i: OpNum - 1).getImm());
196 const unsigned NumOpRegs = OpFlags.getNumOperandRegisters();
197
198 if (NumOpRegs == 2) {
199 assert(MI->getOperand(OpNum).getReg() != AVR::R27R26 &&
200 "Base register X can not have offset/displacement.");
201 O << '+' << MI->getOperand(i: OpNum + 1).getImm();
202 }
203
204 return false;
205}
206
207void AVRAsmPrinter::emitInstruction(const MachineInstr *MI) {
208 AVR_MC::verifyInstructionPredicates(Opcode: MI->getOpcode(),
209 Features: getSubtargetInfo().getFeatureBits());
210
211 AVRMCInstLower MCInstLowering(OutContext, *this);
212
213 MCInst I;
214 MCInstLowering.lowerInstruction(MI: *MI, OutMI&: I);
215 EmitToStreamer(S&: *OutStreamer, Inst: I);
216}
217
218const MCExpr *AVRAsmPrinter::lowerConstant(const Constant *CV,
219 const Constant *BaseCV,
220 uint64_t Offset) {
221 MCContext &Ctx = OutContext;
222
223 if (const GlobalValue *GV = dyn_cast<GlobalValue>(Val: CV)) {
224 bool IsProgMem = GV->getAddressSpace() == AVR::ProgramMemory;
225 if (IsProgMem) {
226 const MCExpr *Expr = MCSymbolRefExpr::create(Symbol: getSymbol(GV), Ctx);
227 return AVRMCExpr::create(S: AVR::S_PM, Expr, isNegated: false, Ctx);
228 }
229 }
230
231 return AsmPrinter::lowerConstant(CV, BaseCV, Offset);
232}
233
234void AVRAsmPrinter::emitXXStructor(const DataLayout &DL, const Constant *CV) {
235 if (!EmittedStructorSymbolAttrs) {
236 OutStreamer->emitRawComment(
237 T: " Emitting these undefined symbol references causes us to link the"
238 " libgcc code that runs our constructors/destructors");
239 OutStreamer->emitRawComment(T: " This matches GCC's behavior");
240
241 MCSymbol *CtorsSym = OutContext.getOrCreateSymbol(Name: "__do_global_ctors");
242 OutStreamer->emitSymbolAttribute(Symbol: CtorsSym, Attribute: MCSA_Global);
243
244 MCSymbol *DtorsSym = OutContext.getOrCreateSymbol(Name: "__do_global_dtors");
245 OutStreamer->emitSymbolAttribute(Symbol: DtorsSym, Attribute: MCSA_Global);
246
247 EmittedStructorSymbolAttrs = true;
248 }
249
250 AsmPrinter::emitXXStructor(DL, CV);
251}
252
253bool AVRAsmPrinter::doFinalization(Module &M) {
254 const TargetLoweringObjectFile &TLOF = getObjFileLowering();
255 const AVRTargetMachine &TM = (const AVRTargetMachine &)MMI->getTarget();
256 const AVRSubtarget *SubTM = TM.getSubtargetImpl();
257
258 bool NeedsCopyData = false;
259 bool NeedsClearBSS = false;
260 for (const auto &GO : M.globals()) {
261 if (!GO.hasInitializer() || GO.hasAvailableExternallyLinkage())
262 // These globals aren't defined in the current object file.
263 continue;
264
265 if (GO.hasCommonLinkage()) {
266 // COMMON symbols are put in .bss.
267 NeedsClearBSS = true;
268 continue;
269 }
270
271 auto *Section = static_cast<MCSectionELF *>(TLOF.SectionForGlobal(GO: &GO, TM));
272 if (Section->getName().starts_with(Prefix: ".data"))
273 NeedsCopyData = true;
274 else if (Section->getName().starts_with(Prefix: ".rodata") && SubTM->hasLPM())
275 // AVRs that have a separate program memory (that's most AVRs) store
276 // .rodata sections in RAM.
277 NeedsCopyData = true;
278 else if (Section->getName().starts_with(Prefix: ".bss"))
279 NeedsClearBSS = true;
280 }
281
282 MCSymbol *DoCopyData = OutContext.getOrCreateSymbol(Name: "__do_copy_data");
283 MCSymbol *DoClearBss = OutContext.getOrCreateSymbol(Name: "__do_clear_bss");
284
285 if (NeedsCopyData) {
286 OutStreamer->emitRawComment(
287 T: " Declaring this symbol tells the CRT that it should");
288 OutStreamer->emitRawComment(
289 T: "copy all variables from program memory to RAM on startup");
290 OutStreamer->emitSymbolAttribute(Symbol: DoCopyData, Attribute: MCSA_Global);
291 }
292
293 if (NeedsClearBSS) {
294 OutStreamer->emitRawComment(
295 T: " Declaring this symbol tells the CRT that it should");
296 OutStreamer->emitRawComment(T: "clear the zeroed data section on startup");
297 OutStreamer->emitSymbolAttribute(Symbol: DoClearBss, Attribute: MCSA_Global);
298 }
299
300 return AsmPrinter::doFinalization(M);
301}
302
303void AVRAsmPrinter::emitStartOfAsmFile(Module &M) {
304 const AVRTargetMachine &TM = (const AVRTargetMachine &)MMI->getTarget();
305 const AVRSubtarget *SubTM = TM.getSubtargetImpl();
306 if (!SubTM)
307 return;
308
309 // Emit __tmp_reg__.
310 OutStreamer->emitAssignment(
311 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__tmp_reg__")),
312 Value: MCConstantExpr::create(Value: SubTM->getRegTmpIndex(), Ctx&: MMI->getContext()));
313 // Emit __zero_reg__.
314 OutStreamer->emitAssignment(
315 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__zero_reg__")),
316 Value: MCConstantExpr::create(Value: SubTM->getRegZeroIndex(), Ctx&: MMI->getContext()));
317 // Emit __SREG__.
318 OutStreamer->emitAssignment(
319 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__SREG__")),
320 Value: MCConstantExpr::create(Value: SubTM->getIORegSREG(), Ctx&: MMI->getContext()));
321 // Emit __SP_H__ if available.
322 if (!SubTM->hasSmallStack())
323 OutStreamer->emitAssignment(
324 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__SP_H__")),
325 Value: MCConstantExpr::create(Value: SubTM->getIORegSPH(), Ctx&: MMI->getContext()));
326 // Emit __SP_L__.
327 OutStreamer->emitAssignment(
328 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__SP_L__")),
329 Value: MCConstantExpr::create(Value: SubTM->getIORegSPL(), Ctx&: MMI->getContext()));
330 // Emit __EIND__ if available.
331 if (SubTM->hasEIJMPCALL())
332 OutStreamer->emitAssignment(
333 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__EIND__")),
334 Value: MCConstantExpr::create(Value: SubTM->getIORegEIND(), Ctx&: MMI->getContext()));
335 // Emit __RAMPZ__ if available.
336 if (SubTM->hasELPM())
337 OutStreamer->emitAssignment(
338 Symbol: MMI->getContext().getOrCreateSymbol(Name: StringRef("__RAMPZ__")),
339 Value: MCConstantExpr::create(Value: SubTM->getIORegRAMPZ(), Ctx&: MMI->getContext()));
340}
341
342char AVRAsmPrinter::ID = 0;
343
344INITIALIZE_PASS(AVRAsmPrinter, "avr-asm-printer", "AVR Assembly Printer", false,
345 false)
346
347extern "C" LLVM_ABI LLVM_EXTERNAL_VISIBILITY void
348LLVMInitializeAVRAsmPrinter() {
349 llvm::RegisterAsmPrinter<AVRAsmPrinter> X(getTheAVRTarget());
350}
351
352PreservedAnalyses AVRAsmPrinterBeginPass::run(Module &M,
353 ModuleAnalysisManager &MAM) {
354 AVRAsmPrinter &AsmPrinter = static_cast<AVRAsmPrinter &>(
355 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
356 setupModuleAsmPrinter(M, MAM, AsmPrinter);
357 AsmPrinter.doInitialization(M);
358 return PreservedAnalyses::all();
359}
360
361PreservedAnalyses AVRAsmPrinterPass::run(MachineFunction &MF,
362 MachineFunctionAnalysisManager &MFAM) {
363 AVRAsmPrinter &AsmPrinter = static_cast<AVRAsmPrinter &>(
364 MFAM.getResult<ModuleAnalysisManagerMachineFunctionProxy>(IR&: MF)
365 .getCachedResult<AsmPrinterAnalysis>(IR&: *MF.getFunction().getParent())
366 ->getPrinter());
367 setupMachineFunctionAsmPrinter(MFAM, MF, AsmPrinter);
368 AsmPrinter.runOnMachineFunction(MF);
369 return PreservedAnalyses::all();
370}
371
372PreservedAnalyses AVRAsmPrinterEndPass::run(Module &M,
373 ModuleAnalysisManager &MAM) {
374 AVRAsmPrinter &AsmPrinter = static_cast<AVRAsmPrinter &>(
375 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
376 setupModuleAsmPrinter(M, MAM, AsmPrinter);
377 AsmPrinter.doFinalization(M);
378 return PreservedAnalyses::all();
379}
380