1 //===-- PPC32AsmPrinter.cpp - Print machine instrs to PowerPC assembly ----===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 PowerPC assembly language. This printer is
12 // the output mechanism used by `llc'.
14 // Documentation at http://developer.apple.com/documentation/DeveloperTools/
15 // Reference/Assembler/ASMIntroduction/chapter_1_section_1.html
17 //===----------------------------------------------------------------------===//
19 #define DEBUG_TYPE "asmprinter"
21 #include "PPC32TargetMachine.h"
22 #include "llvm/Constants.h"
23 #include "llvm/DerivedTypes.h"
24 #include "llvm/Module.h"
25 #include "llvm/Assembly/Writer.h"
26 #include "llvm/CodeGen/AsmPrinter.h"
27 #include "llvm/CodeGen/MachineConstantPool.h"
28 #include "llvm/CodeGen/MachineFunctionPass.h"
29 #include "llvm/CodeGen/MachineInstr.h"
30 #include "llvm/CodeGen/ValueTypes.h"
31 #include "llvm/Support/Mangler.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/ADT/Statistic.h"
35 #include "llvm/ADT/StringExtras.h"
40 Statistic<> EmittedInsts("asm-printer", "Number of machine instrs printed");
42 struct PPC32AsmPrinter : public AsmPrinter {
43 std::set<std::string> FnStubs, GVStubs, LinkOnceStubs;
44 std::set<std::string> Strings;
46 PPC32AsmPrinter(std::ostream &O, TargetMachine &TM)
47 : AsmPrinter(O, TM), LabelNumber(0) {
50 ZeroDirective = "\t.space\t"; // ".space N" emits N zeros.
51 Data64bitsDirective = 0; // we can't emit a 64-bit unit
52 AlignmentIsInBytes = false; // Alignment is by power of 2.
55 /// Unique incrementer for label values for referencing Global values.
59 virtual const char *getPassName() const {
60 return "PPC32 Assembly Printer";
63 PPC32TargetMachine &getTM() {
64 return static_cast<PPC32TargetMachine&>(TM);
67 /// printInstruction - This method is automatically generated by tablegen
68 /// from the instruction set description. This method returns true if the
69 /// machine instruction was sufficiently described to print it, otherwise it
71 bool printInstruction(const MachineInstr *MI);
73 void printMachineInstruction(const MachineInstr *MI);
74 void printOp(const MachineOperand &MO, bool LoadAddrOp = false);
75 void printImmOp(const MachineOperand &MO, unsigned ArgType);
77 void printOperand(const MachineInstr *MI, unsigned OpNo, MVT::ValueType VT){
78 const MachineOperand &MO = MI->getOperand(OpNo);
79 if (MO.getType() == MachineOperand::MO_MachineRegister) {
80 assert(MRegisterInfo::isPhysicalRegister(MO.getReg())&&"Not physreg??");
81 O << LowercaseString(TM.getRegisterInfo()->get(MO.getReg()).Name);
82 } else if (MO.isImmediate()) {
83 O << MO.getImmedValue();
89 void printU5ImmOperand(const MachineInstr *MI, unsigned OpNo,
91 unsigned char value = MI->getOperand(OpNo).getImmedValue();
92 assert(value <= 31 && "Invalid u5imm argument!");
93 O << (unsigned int)value;
95 void printU6ImmOperand(const MachineInstr *MI, unsigned OpNo,
97 unsigned char value = MI->getOperand(OpNo).getImmedValue();
98 assert(value <= 63 && "Invalid u6imm argument!");
99 O << (unsigned int)value;
101 void printU16ImmOperand(const MachineInstr *MI, unsigned OpNo,
103 O << (unsigned short)MI->getOperand(OpNo).getImmedValue();
106 void printConstantPool(MachineConstantPool *MCP);
107 bool runOnMachineFunction(MachineFunction &F);
108 bool doFinalization(Module &M);
110 } // end of anonymous namespace
112 /// createPPC32AsmPrinterPass - Returns a pass that prints the PPC
113 /// assembly code for a MachineFunction to the given output stream,
114 /// using the given target machine description. This should work
115 /// regardless of whether the function is in SSA form or not.
117 FunctionPass *llvm::createPPC32AsmPrinter(std::ostream &o, TargetMachine &tm) {
118 return new PPC32AsmPrinter(o, tm);
121 // Include the auto-generated portion of the assembly writer
122 #include "PowerPCGenAsmWriter.inc"
124 /// printConstantPool - Print to the current output stream assembly
125 /// representations of the constants in the constant pool MCP. This is
126 /// used to print out constants which have been "spilled to memory" by
127 /// the code generator.
129 void PPC32AsmPrinter::printConstantPool(MachineConstantPool *MCP) {
130 const std::vector<Constant*> &CP = MCP->getConstants();
131 const TargetData &TD = TM.getTargetData();
133 if (CP.empty()) return;
135 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
137 emitAlignment(TD.getTypeAlignmentShift(CP[i]->getType()));
138 O << ".CPI" << CurrentFnName << "_" << i << ":\t\t\t\t\t" << CommentString
140 emitGlobalConstant(CP[i]);
144 /// runOnMachineFunction - This uses the printMachineInstruction()
145 /// method to print assembly for each instruction.
147 bool PPC32AsmPrinter::runOnMachineFunction(MachineFunction &MF) {
148 setupMachineFunction(MF);
151 // Print out constants referenced by the function
152 printConstantPool(MF.getConstantPool());
154 // Print out labels for the function.
157 O << "\t.globl\t" << CurrentFnName << "\n";
158 O << CurrentFnName << ":\n";
160 // Print out code for the function.
161 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
163 // Print a label for the basic block.
164 O << ".LBB" << CurrentFnName << "_" << I->getNumber() << ":\t"
165 << CommentString << " " << I->getBasicBlock()->getName() << "\n";
166 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
168 // Print the assembly for the instruction.
170 printMachineInstruction(II);
175 // We didn't modify anything.
179 void PPC32AsmPrinter::printOp(const MachineOperand &MO,
180 bool LoadAddrOp /* = false */) {
181 const MRegisterInfo &RI = *TM.getRegisterInfo();
184 switch (MO.getType()) {
185 case MachineOperand::MO_VirtualRegister:
186 if (Value *V = MO.getVRegValueOrNull()) {
187 O << "<" << V->getName() << ">";
191 case MachineOperand::MO_MachineRegister:
192 case MachineOperand::MO_CCRegister:
193 O << LowercaseString(RI.get(MO.getReg()).Name);
196 case MachineOperand::MO_SignExtendedImmed:
197 case MachineOperand::MO_UnextendedImmed:
198 std::cerr << "printOp() does not handle immediate values\n";
202 case MachineOperand::MO_PCRelativeDisp:
203 std::cerr << "Shouldn't use addPCDisp() when building PPC MachineInstrs";
207 case MachineOperand::MO_MachineBasicBlock: {
208 MachineBasicBlock *MBBOp = MO.getMachineBasicBlock();
209 O << ".LBB" << Mang->getValueName(MBBOp->getParent()->getFunction())
210 << "_" << MBBOp->getNumber() << "\t; "
211 << MBBOp->getBasicBlock()->getName();
215 case MachineOperand::MO_ConstantPoolIndex:
216 O << ".CPI" << CurrentFnName << "_" << MO.getConstantPoolIndex();
219 case MachineOperand::MO_ExternalSymbol:
220 O << MO.getSymbolName();
223 case MachineOperand::MO_GlobalAddress: {
224 GlobalValue *GV = MO.getGlobal();
225 std::string Name = Mang->getValueName(GV);
227 // Dynamically-resolved functions need a stub for the function. Be
228 // wary however not to output $stub for external functions whose addresses
229 // are taken. Those should be emitted as $non_lazy_ptr below.
230 Function *F = dyn_cast<Function>(GV);
231 if (F && F->isExternal() && !LoadAddrOp &&
232 getTM().CalledFunctions.count(F)) {
233 FnStubs.insert(Name);
234 O << "L" << Name << "$stub";
238 // External global variables need a non-lazily-resolved stub
239 if (GV->isExternal() && getTM().AddressTaken.count(GV)) {
240 GVStubs.insert(Name);
241 O << "L" << Name << "$non_lazy_ptr";
245 if (F && LoadAddrOp && getTM().AddressTaken.count(GV)) {
246 LinkOnceStubs.insert(Name);
247 O << "L" << Name << "$non_lazy_ptr";
251 O << Mang->getValueName(GV);
256 O << "<unknown operand type: " << MO.getType() << ">";
261 void PPC32AsmPrinter::printImmOp(const MachineOperand &MO, unsigned ArgType) {
262 int Imm = MO.getImmedValue();
263 if (ArgType == PPCII::Simm16 || ArgType == PPCII::Disimm16) {
270 /// printMachineInstruction -- Print out a single PowerPC MI in Darwin syntax to
271 /// the current output stream.
273 void PPC32AsmPrinter::printMachineInstruction(const MachineInstr *MI) {
275 if (printInstruction(MI))
276 return; // Printer was automatically generated
278 unsigned Opcode = MI->getOpcode();
279 const TargetInstrInfo &TII = *TM.getInstrInfo();
280 const TargetInstrDescriptor &Desc = TII.get(Opcode);
283 unsigned ArgCount = MI->getNumOperands();
284 unsigned ArgType[] = {
285 (Desc.TSFlags >> PPCII::Arg0TypeShift) & PPCII::ArgTypeMask,
286 (Desc.TSFlags >> PPCII::Arg1TypeShift) & PPCII::ArgTypeMask,
287 (Desc.TSFlags >> PPCII::Arg2TypeShift) & PPCII::ArgTypeMask,
288 (Desc.TSFlags >> PPCII::Arg3TypeShift) & PPCII::ArgTypeMask,
289 (Desc.TSFlags >> PPCII::Arg4TypeShift) & PPCII::ArgTypeMask
291 assert(((Desc.TSFlags & PPCII::VMX) == 0) &&
292 "Instruction requires VMX support");
293 assert(((Desc.TSFlags & PPCII::PPC64) == 0) &&
294 "Instruction requires 64 bit support");
296 // CALLpcrel and CALLindirect are handled specially here to print only the
297 // appropriate number of args that the assembler expects. This is because
298 // may have many arguments appended to record the uses of registers that are
299 // holding arguments to the called function.
300 if (Opcode == PPC::COND_BRANCH) {
301 std::cerr << "Error: untranslated conditional branch psuedo instruction!\n";
303 } else if (Opcode == PPC::IMPLICIT_DEF) {
304 --EmittedInsts; // Not an actual machine instruction
305 O << "; IMPLICIT DEF ";
306 printOp(MI->getOperand(0));
309 } else if (Opcode == PPC::CALLpcrel) {
310 O << TII.getName(Opcode) << " ";
311 printOp(MI->getOperand(0));
314 } else if (Opcode == PPC::CALLindirect) {
315 O << TII.getName(Opcode) << " ";
316 printImmOp(MI->getOperand(0), ArgType[0]);
318 printImmOp(MI->getOperand(1), ArgType[0]);
321 } else if (Opcode == PPC::MovePCtoLR) {
322 ++EmittedInsts; // Actually two machine instructions
323 // FIXME: should probably be converted to cout.width and cout.fill
324 O << "bl \"L0000" << LabelNumber << "$pb\"\n";
325 O << "\"L0000" << LabelNumber << "$pb\":\n";
327 printOp(MI->getOperand(0));
332 O << TII.getName(Opcode) << " ";
333 if (Opcode == PPC::LOADHiAddr) {
334 printOp(MI->getOperand(0));
336 if (MI->getOperand(1).getReg() == PPC::R0)
339 printOp(MI->getOperand(1));
341 printOp(MI->getOperand(2), true /* LoadAddrOp */);
342 O << "-\"L0000" << LabelNumber << "$pb\")\n";
343 } else if (ArgCount == 3 && (MI->getOperand(2).isConstantPoolIndex()
344 || MI->getOperand(2).isGlobalAddress())) {
345 printOp(MI->getOperand(0));
347 printOp(MI->getOperand(2), true /* LoadAddrOp */);
348 O << "-\"L0000" << LabelNumber << "$pb\")";
350 if (MI->getOperand(1).getReg() == PPC::R0)
353 printOp(MI->getOperand(1));
355 } else if (ArgCount == 3 && ArgType[1] == PPCII::Disimm16) {
356 printOp(MI->getOperand(0));
358 printImmOp(MI->getOperand(1), ArgType[1]);
360 if (MI->getOperand(2).hasAllocatedReg() &&
361 MI->getOperand(2).getReg() == PPC::R0)
364 printOp(MI->getOperand(2));
367 for (i = 0; i < ArgCount; ++i) {
369 if (i == 1 && ArgCount == 3 && ArgType[2] == PPCII::Simm16 &&
370 MI->getOperand(1).hasAllocatedReg() &&
371 MI->getOperand(1).getReg() == PPC::R0) {
373 // for long branch support, bc $+8
374 } else if (i == 1 && ArgCount == 2 && MI->getOperand(1).isImmediate() &&
375 TII.isBranch(MI->getOpcode())) {
377 assert(8 == MI->getOperand(i).getImmedValue()
378 && "branch off PC not to pc+8?");
379 //printOp(MI->getOperand(i));
380 } else if (MI->getOperand(i).isImmediate()) {
381 printImmOp(MI->getOperand(i), ArgType[i]);
383 printOp(MI->getOperand(i));
385 if (ArgCount - 1 == i)
394 // SwitchSection - Switch to the specified section of the executable if we are
395 // not already in it!
397 static void SwitchSection(std::ostream &OS, std::string &CurSection,
398 const char *NewSection) {
399 if (CurSection != NewSection) {
400 CurSection = NewSection;
401 if (!CurSection.empty())
402 OS << "\t" << NewSection << "\n";
406 bool PPC32AsmPrinter::doFinalization(Module &M) {
407 const TargetData &TD = TM.getTargetData();
408 std::string CurSection;
410 // Print out module-level global variables here.
411 for (Module::const_giterator I = M.gbegin(), E = M.gend(); I != E; ++I)
412 if (I->hasInitializer()) { // External global require no code
414 std::string name = Mang->getValueName(I);
415 Constant *C = I->getInitializer();
416 unsigned Size = TD.getTypeSize(C->getType());
417 unsigned Align = TD.getTypeAlignmentShift(C->getType());
419 if (C->isNullValue() && /* FIXME: Verify correct */
420 (I->hasInternalLinkage() || I->hasWeakLinkage())) {
421 SwitchSection(O, CurSection, ".data");
422 if (I->hasInternalLinkage())
423 O << ".lcomm " << name << "," << TD.getTypeSize(C->getType())
426 O << ".comm " << name << "," << TD.getTypeSize(C->getType());
428 WriteAsOperand(O, I, true, true, &M);
431 switch (I->getLinkage()) {
432 case GlobalValue::LinkOnceLinkage:
433 O << ".section __TEXT,__textcoal_nt,coalesced,no_toc\n"
434 << ".weak_definition " << name << '\n'
435 << ".private_extern " << name << '\n'
436 << ".section __DATA,__datacoal_nt,coalesced,no_toc\n";
437 LinkOnceStubs.insert(name);
439 case GlobalValue::WeakLinkage: // FIXME: Verify correct for weak.
440 // Nonnull linkonce -> weak
441 O << "\t.weak " << name << "\n";
442 SwitchSection(O, CurSection, "");
443 O << "\t.section\t.llvm.linkonce.d." << name << ",\"aw\",@progbits\n";
445 case GlobalValue::AppendingLinkage:
446 // FIXME: appending linkage variables should go into a section of
447 // their name or something. For now, just emit them as external.
448 case GlobalValue::ExternalLinkage:
449 // If external or appending, declare as a global symbol
450 O << "\t.globl " << name << "\n";
452 case GlobalValue::InternalLinkage:
453 SwitchSection(O, CurSection, ".data");
457 emitAlignment(Align);
458 O << name << ":\t\t\t\t; ";
459 WriteAsOperand(O, I, true, true, &M);
461 WriteAsOperand(O, C, false, false, &M);
463 emitGlobalConstant(C);
467 // Output stubs for dynamically-linked functions
468 for (std::set<std::string>::iterator i = FnStubs.begin(), e = FnStubs.end();
472 O << ".section __TEXT,__picsymbolstub1,symbol_stubs,pure_instructions,32\n";
474 O << "L" << *i << "$stub:\n";
475 O << "\t.indirect_symbol " << *i << "\n";
477 O << "\tbcl 20,31,L0$" << *i << "\n";
478 O << "L0$" << *i << ":\n";
480 O << "\taddis r11,r11,ha16(L" << *i << "$lazy_ptr-L0$" << *i << ")\n";
482 O << "\tlwzu r12,lo16(L" << *i << "$lazy_ptr-L0$" << *i << ")(r11)\n";
483 O << "\tmtctr r12\n";
486 O << ".lazy_symbol_pointer\n";
487 O << "L" << *i << "$lazy_ptr:\n";
488 O << "\t.indirect_symbol " << *i << "\n";
489 O << "\t.long dyld_stub_binding_helper\n";
494 // Output stubs for external global variables
495 if (GVStubs.begin() != GVStubs.end())
496 O << ".data\n.non_lazy_symbol_pointer\n";
497 for (std::set<std::string>::iterator i = GVStubs.begin(), e = GVStubs.end();
499 O << "L" << *i << "$non_lazy_ptr:\n";
500 O << "\t.indirect_symbol " << *i << "\n";
504 // Output stubs for link-once variables
505 if (LinkOnceStubs.begin() != LinkOnceStubs.end())
506 O << ".data\n.align 2\n";
507 for (std::set<std::string>::iterator i = LinkOnceStubs.begin(),
508 e = LinkOnceStubs.end(); i != e; ++i) {
509 O << "L" << *i << "$non_lazy_ptr:\n"
510 << "\t.long\t" << *i << '\n';
513 AsmPrinter::doFinalization(M);
514 return false; // success