1 //===-- MipsAsmPrinter.cpp - Mips LLVM assembly writer --------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains a printer that converts from our internal representation
11 // of machine-dependent LLVM code to GAS-format MIPS assembly language.
13 //===----------------------------------------------------------------------===//
15 #define DEBUG_TYPE "mips-asm-printer"
18 #include "MipsInstrInfo.h"
19 #include "MipsTargetMachine.h"
20 #include "MipsMachineFunction.h"
21 #include "llvm/Constants.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/Module.h"
24 #include "llvm/CodeGen/AsmPrinter.h"
25 #include "llvm/CodeGen/MachineFunctionPass.h"
26 #include "llvm/CodeGen/MachineConstantPool.h"
27 #include "llvm/CodeGen/MachineFrameInfo.h"
28 #include "llvm/CodeGen/MachineInstr.h"
29 #include "llvm/Target/TargetAsmInfo.h"
30 #include "llvm/Target/TargetData.h"
31 #include "llvm/Target/TargetMachine.h"
32 #include "llvm/Target/TargetOptions.h"
33 #include "llvm/Support/Mangler.h"
34 #include "llvm/ADT/Statistic.h"
35 #include "llvm/ADT/SetVector.h"
36 #include "llvm/ADT/StringExtras.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/CommandLine.h"
39 #include "llvm/Support/MathExtras.h"
44 STATISTIC(EmittedInsts, "Number of machine instrs printed");
47 struct VISIBILITY_HIDDEN MipsAsmPrinter : public AsmPrinter {
48 MipsAsmPrinter(std::ostream &O, MipsTargetMachine &TM,
49 const TargetAsmInfo *T):
50 AsmPrinter(O, TM, T) {}
52 virtual const char *getPassName() const {
53 return "Mips Assembly Printer";
56 enum SetDirectiveFlags {
57 REORDER, // enables instruction reordering.
58 NOREORDER, // disables instruction reordering.
59 MACRO, // enables GAS macros.
60 NOMACRO // disables GAS macros.
63 void printOperand(const MachineInstr *MI, int opNum);
64 void printMemOperand(const MachineInstr *MI, int opNum,
65 const char *Modifier = 0);
67 unsigned int getSavedRegsBitmask(bool isFloat, MachineFunction &MF);
68 void printHex32(unsigned int Value);
70 void emitFunctionStart(MachineFunction &MF);
71 void emitFunctionEnd(MachineFunction &MF);
72 void emitFrameDirective(MachineFunction &MF);
73 void emitMaskDirective(MachineFunction &MF);
74 void emitFMaskDirective(MachineFunction &MF);
75 void emitSetDirective(SetDirectiveFlags Flag);
77 bool printInstruction(const MachineInstr *MI); // autogenerated.
78 bool runOnMachineFunction(MachineFunction &F);
79 bool doInitialization(Module &M);
80 bool doFinalization(Module &M);
82 } // end of anonymous namespace
84 #include "MipsGenAsmWriter.inc"
86 /// createMipsCodePrinterPass - Returns a pass that prints the MIPS
87 /// assembly code for a MachineFunction to the given output stream,
88 /// using the given target machine description. This should work
89 /// regardless of whether the function is in SSA form.
90 FunctionPass *llvm::createMipsCodePrinterPass(std::ostream &o,
91 MipsTargetMachine &tm)
93 return new MipsAsmPrinter(o, tm, tm.getTargetAsmInfo());
96 //===----------------------------------------------------------------------===//
98 // Mips Asm Directives
100 // -- Frame directive "frame Stackpointer, Stacksize, RARegister"
101 // Describe the stack frame.
103 // -- Mask directives "(f)mask bitmask, offset"
104 // Tells the assembler which registers are saved and where.
105 // bitmask - contain a little endian bitset indicating which registers are
106 // saved on function prologue (e.g. with a 0x80000000 mask, the
107 // assembler knows the register 31 (RA) is saved at prologue.
108 // offset - the position before stack pointer subtraction indicating where
109 // the first saved register on prologue is located. (e.g. with a
111 // Consider the following function prologue:
114 // .mask 0xc0000000,-8
115 // addiu $sp, $sp, -48
119 // With a 0xc0000000 mask, the assembler knows the register 31 (RA) and
120 // 30 (FP) are saved at prologue. As the save order on prologue is from
121 // left to right, RA is saved first. A -8 offset means that after the
122 // stack pointer subtration, the first register in the mask (RA) will be
123 // saved at address 48-8=40.
125 //===----------------------------------------------------------------------===//
127 /// Mask directive for GPR
128 void MipsAsmPrinter::
129 emitMaskDirective(MachineFunction &MF)
131 MipsFunctionInfo *MipsFI = MF.getInfo<MipsFunctionInfo>();
133 int StackSize = MF.getFrameInfo()->getStackSize();
134 int Offset = (!MipsFI->getTopSavedRegOffset()) ? 0 :
135 (-(StackSize-MipsFI->getTopSavedRegOffset()));
138 DOUT << "--> emitMaskDirective" << "\n";
139 DOUT << "StackSize : " << StackSize << "\n";
140 DOUT << "getTopSavedReg : " << MipsFI->getTopSavedRegOffset() << "\n";
141 DOUT << "Offset : " << Offset << "\n\n";
144 unsigned int Bitmask = getSavedRegsBitmask(false, MF);
147 O << "," << Offset << "\n";
150 /// TODO: Mask Directive for Float Point
151 void MipsAsmPrinter::
152 emitFMaskDirective(MachineFunction &MF)
154 unsigned int Bitmask = getSavedRegsBitmask(true, MF);
162 void MipsAsmPrinter::
163 emitFrameDirective(MachineFunction &MF)
165 const TargetRegisterInfo &RI = *TM.getRegisterInfo();
167 unsigned stackReg = RI.getFrameRegister(MF);
168 unsigned returnReg = RI.getRARegister();
169 unsigned stackSize = MF.getFrameInfo()->getStackSize();
172 O << "\t.frame\t" << "$" << LowercaseString(RI.get(stackReg).AsmName)
173 << "," << stackSize << ","
174 << "$" << LowercaseString(RI.get(returnReg).AsmName)
178 /// Emit Set directives.
179 void MipsAsmPrinter::
180 emitSetDirective(SetDirectiveFlags Flag)
184 case REORDER: O << "reorder" << "\n"; break;
185 case NOREORDER: O << "noreorder" << "\n"; break;
186 case MACRO: O << "macro" << "\n"; break;
187 case NOMACRO: O << "nomacro" << "\n"; break;
192 // Create a bitmask with all callee saved registers for CPU
193 // or Float Point registers. For CPU registers consider RA,
194 // GP and FP for saving if necessary.
195 unsigned int MipsAsmPrinter::
196 getSavedRegsBitmask(bool isFloat, MachineFunction &MF)
198 const TargetRegisterInfo &RI = *TM.getRegisterInfo();
200 // Float Point Registers, TODO
205 unsigned int Bitmask = 0;
207 MachineFrameInfo *MFI = MF.getFrameInfo();
208 const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
209 for (unsigned i = 0, e = CSI.size(); i != e; ++i)
210 Bitmask |= (1 << MipsRegisterInfo::getRegisterNumbering(CSI[i].getReg()));
213 Bitmask |= (1 << MipsRegisterInfo::
214 getRegisterNumbering(RI.getFrameRegister(MF)));
216 if (MF.getFrameInfo()->hasCalls())
217 Bitmask |= (1 << MipsRegisterInfo::
218 getRegisterNumbering(RI.getRARegister()));
223 // Print a 32 bit hex number with all numbers.
224 void MipsAsmPrinter::
225 printHex32(unsigned int Value)
227 O << "0x" << std::hex;
228 for (int i = 7; i >= 0; i--)
229 O << std::hex << ( (Value & (0xF << (i*4))) >> (i*4) );
233 /// Emit the directives used by GAS on the start of functions
234 void MipsAsmPrinter::
235 emitFunctionStart(MachineFunction &MF)
237 // Print out the label for the function.
238 const Function *F = MF.getFunction();
239 SwitchToTextSection(getSectionForFunction(*F).c_str(), F);
244 O << "\t.globl\t" << CurrentFnName << "\n";
245 O << "\t.ent\t" << CurrentFnName << "\n";
246 O << "\t.type\t" << CurrentFnName << ", @function\n";
247 O << CurrentFnName << ":\n";
249 emitFrameDirective(MF);
250 emitMaskDirective(MF);
251 emitFMaskDirective(MF);
253 if (TM.getRelocationModel() == Reloc::Static) {
254 emitSetDirective(NOREORDER);
255 emitSetDirective(NOMACRO);
261 /// Emit the directives used by GAS on the end of functions
262 void MipsAsmPrinter::
263 emitFunctionEnd(MachineFunction &MF)
265 if (TM.getRelocationModel() == Reloc::Static) {
266 emitSetDirective(MACRO);
267 emitSetDirective(REORDER);
270 O << "\t.end\t" << CurrentFnName << "\n";
273 /// runOnMachineFunction - This uses the printMachineInstruction()
274 /// method to print assembly for each instruction.
275 bool MipsAsmPrinter::
276 runOnMachineFunction(MachineFunction &MF)
278 SetupMachineFunction(MF);
280 // Print out constants referenced by the function
281 EmitConstantPool(MF.getConstantPool());
283 // Print out jump tables referenced by the function
284 EmitJumpTableInfo(MF.getJumpTableInfo(), MF);
288 // What's my mangled name?
289 CurrentFnName = Mang->getValueName(MF.getFunction());
291 // Emit the function start directives
292 emitFunctionStart(MF);
294 // Print out code for the function.
295 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
298 // Print a label for the basic block.
299 if (I != MF.begin()) {
300 printBasicBlockLabel(I, true, true);
304 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
306 // Print the assembly for the instruction.
307 printInstruction(II);
311 // Each Basic Block is separated by a newline
315 // Emit function end directives
318 // We didn't modify anything.
322 void MipsAsmPrinter::
323 printOperand(const MachineInstr *MI, int opNum)
325 const MachineOperand &MO = MI->getOperand(opNum);
326 const TargetRegisterInfo &RI = *TM.getRegisterInfo();
328 bool isPIC = (TM.getRelocationModel() == Reloc::PIC_);
329 bool isCodeLarge = (TM.getCodeModel() == CodeModel::Large);
331 // %hi and %lo used on mips gas to load global addresses on
332 // static code. %got is used to load global addresses when
333 // using PIC_. %call16 is used to load direct call targets
334 // on PIC_ and small code size. %call_lo and %call_hi load
335 // direct call targets on PIC_ and large code size.
336 if (MI->getOpcode() == Mips::LUi && !MO.isRegister()
337 && !MO.isImmediate()) {
338 if ((isPIC) && (isCodeLarge))
343 } else if ((MI->getOpcode() == Mips::ADDiu) && !MO.isRegister()
344 && !MO.isImmediate()) {
347 } else if ((isPIC) && (MI->getOpcode() == Mips::LW)
348 && (!MO.isRegister()) && (!MO.isImmediate())) {
349 const MachineOperand &firstMO = MI->getOperand(opNum-1);
350 const MachineOperand &lastMO = MI->getOperand(opNum+1);
351 if ((firstMO.isRegister()) && (lastMO.isRegister())) {
352 if ((firstMO.getReg() == Mips::T9) && (lastMO.getReg() == Mips::GP)
355 else if ((firstMO.getReg() != Mips::T9) && (lastMO.getReg() == Mips::GP))
357 else if ((firstMO.getReg() == Mips::T9) && (lastMO.getReg() != Mips::GP)
364 switch (MO.getType())
366 case MachineOperand::MO_Register:
367 if (TargetRegisterInfo::isPhysicalRegister(MO.getReg()))
368 O << "$" << LowercaseString (RI.get(MO.getReg()).AsmName);
370 O << "$" << MO.getReg();
373 case MachineOperand::MO_Immediate:
374 if ((MI->getOpcode() == Mips::SLTiu) || (MI->getOpcode() == Mips::ORi) ||
375 (MI->getOpcode() == Mips::LUi) || (MI->getOpcode() == Mips::ANDi))
376 O << (unsigned short int)MO.getImm();
378 O << (short int)MO.getImm();
381 case MachineOperand::MO_MachineBasicBlock:
382 printBasicBlockLabel(MO.getMBB());
385 case MachineOperand::MO_GlobalAddress:
386 O << Mang->getValueName(MO.getGlobal());
389 case MachineOperand::MO_ExternalSymbol:
390 O << MO.getSymbolName();
393 case MachineOperand::MO_JumpTableIndex:
394 O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
395 << '_' << MO.getIndex();
398 // FIXME: Verify correct
399 case MachineOperand::MO_ConstantPoolIndex:
400 O << TAI->getPrivateGlobalPrefix() << "CPI"
401 << getFunctionNumber() << "_" << MO.getIndex();
405 O << "<unknown operand type>"; abort (); break;
408 if (closeP) O << ")";
411 void MipsAsmPrinter::
412 printMemOperand(const MachineInstr *MI, int opNum, const char *Modifier)
414 // when using stack locations for not load/store instructions
415 // print the same way as all normal 3 operand instructions.
416 if (Modifier && !strcmp(Modifier, "stackloc")) {
417 printOperand(MI, opNum+1);
419 printOperand(MI, opNum);
423 // Load/Store memory operands -- imm($reg)
424 // If PIC target the target is loaded as the
425 // pattern lw $25,%call16($28)
426 printOperand(MI, opNum);
428 printOperand(MI, opNum+1);
432 bool MipsAsmPrinter::
433 doInitialization(Module &M)
435 Mang = new Mangler(M);
436 return false; // success
439 bool MipsAsmPrinter::
440 doFinalization(Module &M)
442 const TargetData *TD = TM.getTargetData();
444 // Print out module-level global variables here.
445 for (Module::const_global_iterator I = M.global_begin(),
446 E = M.global_end(); I != E; ++I)
448 // External global require no code
449 if (I->hasInitializer()) {
451 // Check to see if this is a special global
452 // used by LLVM, if so, emit it.
453 if (EmitSpecialLLVMGlobal(I))
457 std::string name = Mang->getValueName(I);
458 Constant *C = I->getInitializer();
459 unsigned Size = TD->getABITypeSize(C->getType());
460 unsigned Align = TD->getPreferredAlignmentLog(I);
463 if (C->isNullValue() && (I->hasLinkOnceLinkage() ||
464 I->hasInternalLinkage() || I->hasWeakLinkage()))
466 if (Size == 0) Size = 1; // .comm Foo, 0 is undefined, avoid it.
468 if (!NoZerosInBSS && TAI->getBSSSection())
469 SwitchToDataSection(TAI->getBSSSection(), I);
471 SwitchToDataSection(TAI->getDataSection(), I);
473 if (I->hasInternalLinkage()) {
474 if (TAI->getLCOMMDirective())
475 O << TAI->getLCOMMDirective() << name << "," << Size;
477 O << "\t.local\t" << name << "\n";
479 O << TAI->getCOMMDirective() << name << "," << Size;
480 // The .comm alignment in bytes.
481 if (TAI->getCOMMDirectiveTakesAlignment())
482 O << "," << (1 << Align);
487 switch (I->getLinkage())
489 case GlobalValue::LinkOnceLinkage:
490 case GlobalValue::WeakLinkage:
491 // FIXME: Verify correct for weak.
492 // Nonnull linkonce -> weak
493 O << "\t.weak " << name << "\n";
494 SwitchToDataSection("", I);
495 O << "\t.section\t\".llvm.linkonce.d." << name
496 << "\",\"aw\",@progbits\n";
498 case GlobalValue::AppendingLinkage:
499 // FIXME: appending linkage variables
500 // should go into a section of their name or
501 // something. For now, just emit them as external.
502 case GlobalValue::ExternalLinkage:
503 // If external or appending, declare as a global symbol
504 O << TAI->getGlobalDirective() << name << "\n";
506 case GlobalValue::InternalLinkage:
507 // FIXME: special handling for ".ctors" & ".dtors" sections
508 if (I->hasSection() && (I->getSection() == ".ctors" ||
509 I->getSection() == ".dtors")) {
510 std::string SectionName = ".section " + I->getSection();
511 SectionName += ",\"aw\",%progbits";
512 SwitchToDataSection(SectionName.c_str());
514 if (C->isNullValue() && !NoZerosInBSS && TAI->getBSSSection())
515 SwitchToDataSection(TAI->getBSSSection(), I);
516 else if (!I->isConstant())
517 SwitchToDataSection(TAI->getDataSection(), I);
520 if (TAI->getReadOnlySection())
521 SwitchToDataSection(TAI->getReadOnlySection(), I);
523 SwitchToDataSection(TAI->getDataSection(), I);
527 case GlobalValue::GhostLinkage:
528 cerr << "Should not have any unmaterialized functions!\n";
530 case GlobalValue::DLLImportLinkage:
531 cerr << "DLLImport linkage is not supported by this target!\n";
533 case GlobalValue::DLLExportLinkage:
534 cerr << "DLLExport linkage is not supported by this target!\n";
537 assert(0 && "Unknown linkage type!");
540 O << "\t.align " << Align << "\n";
541 O << "\t.type " << name << ",@object\n";
542 O << "\t.size " << name << "," << Size << "\n";
544 EmitGlobalConstant(C);
548 return AsmPrinter::doFinalization(M);