1 //===-- SparcV8AsmPrinter.cpp - SparcV8 LLVM assembly writer --------------===//
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 GAS-format Sparc V8 assembly language.
13 //===----------------------------------------------------------------------===//
16 #include "SparcV8InstrInfo.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Module.h"
20 #include "llvm/Assembly/Writer.h"
21 #include "llvm/CodeGen/MachineFunctionPass.h"
22 #include "llvm/CodeGen/MachineConstantPool.h"
23 #include "llvm/CodeGen/MachineInstr.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Support/Mangler.h"
26 #include "llvm/ADT/Statistic.h"
27 #include "llvm/ADT/StringExtras.h"
28 #include "llvm/Support/CommandLine.h"
33 Statistic<> EmittedInsts("asm-printer", "Number of machine instrs printed");
35 struct V8Printer : public MachineFunctionPass {
36 /// Output stream on which we're printing assembly code.
40 /// Target machine description which we query for reg. names, data
45 /// Name-mangler for global names.
49 V8Printer(std::ostream &o, TargetMachine &tm) : O(o), TM(tm) { }
51 /// We name each basic block in a Function with a unique number, so
52 /// that we can consistently refer to them later. This is cleared
53 /// at the beginning of each call to runOnMachineFunction().
55 typedef std::map<const Value *, unsigned> ValueMapTy;
56 ValueMapTy NumberForBB;
58 /// Cache of mangled name for current function. This is
59 /// recalculated at the beginning of each call to
60 /// runOnMachineFunction().
62 std::string CurrentFnName;
64 virtual const char *getPassName() const {
65 return "SparcV8 Assembly Printer";
68 void emitConstantValueOnly(const Constant *CV);
69 void emitGlobalConstant(const Constant *CV);
70 void printConstantPool(MachineConstantPool *MCP);
71 void printOperand(const MachineInstr *MI, int opNum);
72 void printBaseOffsetPair (const MachineInstr *MI, int i, bool brackets=true);
73 void printMachineInstruction(const MachineInstr *MI);
74 bool runOnMachineFunction(MachineFunction &F);
75 bool doInitialization(Module &M);
76 bool doFinalization(Module &M);
78 } // end of anonymous namespace
80 /// createSparcV8CodePrinterPass - Returns a pass that prints the SparcV8
81 /// assembly code for a MachineFunction to the given output stream,
82 /// using the given target machine description. This should work
83 /// regardless of whether the function is in SSA form.
85 FunctionPass *llvm::createSparcV8CodePrinterPass (std::ostream &o,
87 return new V8Printer(o, tm);
90 /// toOctal - Convert the low order bits of X into an octal digit.
92 static inline char toOctal(int X) {
96 /// getAsCString - Return the specified array as a C compatible
97 /// string, only if the predicate isStringCompatible is true.
99 static void printAsCString(std::ostream &O, const ConstantArray *CVA) {
100 assert(CVA->isString() && "Array is not string compatible!");
103 for (unsigned i = 0; i != CVA->getNumOperands(); ++i) {
104 unsigned char C = cast<ConstantInt>(CVA->getOperand(i))->getRawValue();
108 } else if (C == '\\') {
110 } else if (isprint(C)) {
114 case '\b': O << "\\b"; break;
115 case '\f': O << "\\f"; break;
116 case '\n': O << "\\n"; break;
117 case '\r': O << "\\r"; break;
118 case '\t': O << "\\t"; break;
121 O << toOctal(C >> 6);
122 O << toOctal(C >> 3);
123 O << toOctal(C >> 0);
131 // Print out the specified constant, without a storage class. Only the
132 // constants valid in constant expressions can occur here.
133 void V8Printer::emitConstantValueOnly(const Constant *CV) {
134 if (CV->isNullValue() || isa<UndefValue> (CV))
136 else if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
137 assert(CB == ConstantBool::True);
139 } else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV))
140 if (((CI->getValue() << 32) >> 32) == CI->getValue())
143 O << (unsigned long long)CI->getValue();
144 else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV))
146 else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
147 // This is a constant address for a global variable or function. Use the
148 // name of the variable or function as the address value.
149 O << Mang->getValueName(GV);
150 else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
151 const TargetData &TD = TM.getTargetData();
152 switch(CE->getOpcode()) {
153 case Instruction::GetElementPtr: {
154 // generate a symbolic expression for the byte address
155 const Constant *ptrVal = CE->getOperand(0);
156 std::vector<Value*> idxVec(CE->op_begin()+1, CE->op_end());
157 if (unsigned Offset = TD.getIndexedOffset(ptrVal->getType(), idxVec)) {
159 emitConstantValueOnly(ptrVal);
160 O << ") + " << Offset;
162 emitConstantValueOnly(ptrVal);
166 case Instruction::Cast: {
167 // Support only non-converting or widening casts for now, that is, ones
168 // that do not involve a change in value. This assertion is really gross,
169 // and may not even be a complete check.
170 Constant *Op = CE->getOperand(0);
171 const Type *OpTy = Op->getType(), *Ty = CE->getType();
173 // Pointers on ILP32 machines can be losslessly converted back and
174 // forth into 32-bit or wider integers, regardless of signedness.
175 assert(((isa<PointerType>(OpTy)
176 && (Ty == Type::LongTy || Ty == Type::ULongTy
177 || Ty == Type::IntTy || Ty == Type::UIntTy))
178 || (isa<PointerType>(Ty)
179 && (OpTy == Type::LongTy || OpTy == Type::ULongTy
180 || OpTy == Type::IntTy || OpTy == Type::UIntTy))
181 || (((TD.getTypeSize(Ty) >= TD.getTypeSize(OpTy))
182 && OpTy->isLosslesslyConvertibleTo(Ty))))
183 && "FIXME: Don't yet support this kind of constant cast expr");
185 emitConstantValueOnly(Op);
189 case Instruction::Add:
191 emitConstantValueOnly(CE->getOperand(0));
193 emitConstantValueOnly(CE->getOperand(1));
197 assert(0 && "Unsupported operator!");
200 assert(0 && "Unknown constant value!");
204 // Print a constant value or values, with the appropriate storage class as a
206 void V8Printer::emitGlobalConstant(const Constant *CV) {
207 const TargetData &TD = TM.getTargetData();
209 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
210 if (CVA->isString()) {
212 printAsCString(O, CVA);
214 } else { // Not a string. Print the values in successive locations
215 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; i++)
216 emitGlobalConstant(CVA->getOperand(i));
219 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
220 // Print the fields in successive locations. Pad to align if needed!
221 const StructLayout *cvsLayout = TD.getStructLayout(CVS->getType());
222 unsigned sizeSoFar = 0;
223 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; i++) {
224 const Constant* field = CVS->getOperand(i);
226 // Check if padding is needed and insert one or more 0s.
227 unsigned fieldSize = TD.getTypeSize(field->getType());
228 unsigned padSize = ((i == e-1? cvsLayout->StructSize
229 : cvsLayout->MemberOffsets[i+1])
230 - cvsLayout->MemberOffsets[i]) - fieldSize;
231 sizeSoFar += fieldSize + padSize;
233 // Now print the actual field value
234 emitGlobalConstant(field);
236 // Insert the field padding unless it's zero bytes...
238 O << "\t.skip\t " << padSize << "\n";
240 assert(sizeSoFar == cvsLayout->StructSize &&
241 "Layout of constant struct may be incorrect!");
243 } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
244 // FP Constants are printed as integer constants to avoid losing
246 double Val = CFP->getValue();
247 switch (CFP->getType()->getTypeID()) {
248 default: assert(0 && "Unknown floating point type!");
249 case Type::FloatTyID: {
250 O << ".long\t" << FloatToBits(Val) << "\t! float " << Val << "\n";
253 case Type::DoubleTyID: {
254 O << ".word\t0x" << std::hex << (DoubleToBits(Val) >> 32) << std::dec << "\t! double " << Val << "\n";
255 O << ".word\t0x" << std::hex << (DoubleToBits(Val) & 0xffffffffUL) << std::dec << "\t! double " << Val << "\n";
259 } else if (isa<UndefValue> (CV)) {
260 unsigned size = TD.getTypeSize (CV->getType ());
261 O << "\t.skip\t " << size << "\n";
263 } else if (isa<ConstantAggregateZero> (CV)) {
264 unsigned size = TD.getTypeSize (CV->getType ());
265 for (unsigned i = 0; i < size; ++i)
270 const Type *type = CV->getType();
272 switch (type->getTypeID()) {
273 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
276 case Type::UShortTyID: case Type::ShortTyID:
279 case Type::FloatTyID: case Type::PointerTyID:
280 case Type::UIntTyID: case Type::IntTyID:
283 case Type::DoubleTyID:
284 case Type::ULongTyID: case Type::LongTyID:
288 assert (0 && "Can't handle printing this type of thing");
292 emitConstantValueOnly(CV);
296 /// printConstantPool - Print to the current output stream assembly
297 /// representations of the constants in the constant pool MCP. This is
298 /// used to print out constants which have been "spilled to memory" by
299 /// the code generator.
301 void V8Printer::printConstantPool(MachineConstantPool *MCP) {
302 const std::vector<Constant*> &CP = MCP->getConstants();
303 const TargetData &TD = TM.getTargetData();
305 if (CP.empty()) return;
307 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
308 O << "\t.section \".rodata\"\n";
309 O << "\t.align " << (unsigned)TD.getTypeAlignment(CP[i]->getType())
311 O << ".CPI" << CurrentFnName << "_" << i << ":\t\t\t\t\t!"
313 emitGlobalConstant(CP[i]);
317 /// runOnMachineFunction - This uses the printMachineInstruction()
318 /// method to print assembly for each instruction.
320 bool V8Printer::runOnMachineFunction(MachineFunction &MF) {
321 // BBNumber is used here so that a given Printer will never give two
322 // BBs the same name. (If you have a better way, please let me know!)
323 static unsigned BBNumber = 0;
326 // What's my mangled name?
327 CurrentFnName = Mang->getValueName(MF.getFunction());
329 // Print out constants referenced by the function
330 printConstantPool(MF.getConstantPool());
332 // Print out labels for the function.
334 O << "\t.align 16\n";
335 O << "\t.globl\t" << CurrentFnName << "\n";
336 O << "\t.type\t" << CurrentFnName << ", #function\n";
337 O << CurrentFnName << ":\n";
339 // Number each basic block so that we can consistently refer to them
340 // in PC-relative references.
342 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
344 NumberForBB[I->getBasicBlock()] = BBNumber++;
347 // Print out code for the function.
348 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
350 // Print a label for the basic block.
351 O << ".LBB" << Mang->getValueName(MF.getFunction ())
352 << "_" << I->getNumber () << ":\t! "
353 << I->getBasicBlock ()->getName () << "\n";
354 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
356 // Print the assembly for the instruction.
358 printMachineInstruction(II);
362 // We didn't modify anything.
366 void V8Printer::printOperand(const MachineInstr *MI, int opNum) {
367 const MachineOperand &MO = MI->getOperand (opNum);
368 const MRegisterInfo &RI = *TM.getRegisterInfo();
369 bool CloseParen = false;
370 if (MI->getOpcode() == V8::SETHIi && !MO.isRegister() && !MO.isImmediate()) {
373 } else if (MI->getOpcode() ==V8::ORri &&!MO.isRegister() &&!MO.isImmediate())
378 switch (MO.getType()) {
379 case MachineOperand::MO_VirtualRegister:
380 if (Value *V = MO.getVRegValueOrNull()) {
381 O << "<" << V->getName() << ">";
385 case MachineOperand::MO_MachineRegister:
386 if (MRegisterInfo::isPhysicalRegister(MO.getReg()))
387 O << "%" << LowercaseString (RI.get(MO.getReg()).Name);
389 O << "%reg" << MO.getReg();
392 case MachineOperand::MO_SignExtendedImmed:
393 case MachineOperand::MO_UnextendedImmed:
394 O << (int)MO.getImmedValue();
396 case MachineOperand::MO_MachineBasicBlock: {
397 MachineBasicBlock *MBBOp = MO.getMachineBasicBlock();
398 O << ".LBB" << Mang->getValueName(MBBOp->getParent()->getFunction())
399 << "_" << MBBOp->getNumber () << "\t! "
400 << MBBOp->getBasicBlock ()->getName ();
403 case MachineOperand::MO_PCRelativeDisp:
404 std::cerr << "Shouldn't use addPCDisp() when building SparcV8 MachineInstrs";
407 case MachineOperand::MO_GlobalAddress:
408 O << Mang->getValueName(MO.getGlobal());
410 case MachineOperand::MO_ExternalSymbol:
411 O << MO.getSymbolName();
413 case MachineOperand::MO_ConstantPoolIndex:
414 O << ".CPI" << CurrentFnName << "_" << MO.getConstantPoolIndex();
417 O << "<unknown operand type>"; abort (); break;
419 if (CloseParen) O << ")";
422 static bool isLoadInstruction (const MachineInstr *MI) {
423 switch (MI->getOpcode ()) {
440 static bool isStoreInstruction (const MachineInstr *MI) {
441 switch (MI->getOpcode ()) {
456 static bool isPseudoInstruction (const MachineInstr *MI) {
457 switch (MI->getOpcode ()) {
459 case V8::ADJCALLSTACKUP:
460 case V8::ADJCALLSTACKDOWN:
461 case V8::IMPLICIT_USE:
462 case V8::IMPLICIT_DEF:
469 /// printBaseOffsetPair - Print two consecutive operands of MI, starting at #i,
470 /// which form a base + offset pair (which may have brackets around it, if
471 /// brackets is true, or may be in the form base - constant, if offset is a
472 /// negative constant).
474 void V8Printer::printBaseOffsetPair (const MachineInstr *MI, int i,
476 if (brackets) O << "[";
477 printOperand (MI, i);
478 if (MI->getOperand (i + 1).isImmediate()) {
479 int Val = (int) MI->getOperand (i + 1).getImmedValue ();
481 O << ((Val >= 0) ? " + " : " - ");
482 O << ((Val >= 0) ? Val : -Val);
486 printOperand (MI, i + 1);
488 if (brackets) O << "]";
491 /// printMachineInstruction -- Print out a single SparcV8 LLVM instruction
492 /// MI in GAS syntax to the current output stream.
494 void V8Printer::printMachineInstruction(const MachineInstr *MI) {
495 unsigned Opcode = MI->getOpcode();
496 const TargetInstrInfo &TII = *TM.getInstrInfo();
497 const TargetInstrDescriptor &Desc = TII.get(Opcode);
499 // If it's a pseudo-instruction, comment it out.
500 if (isPseudoInstruction (MI))
503 O << Desc.Name << " ";
505 // Printing memory instructions is a special case.
506 // for loads: %dest = op %base, offset --> op [%base + offset], %dest
507 // for stores: op %base, offset, %src --> op %src, [%base + offset]
508 if (isLoadInstruction (MI)) {
509 printBaseOffsetPair (MI, 1);
511 printOperand (MI, 0);
514 } else if (isStoreInstruction (MI)) {
515 printOperand (MI, 2);
517 printBaseOffsetPair (MI, 0);
520 } else if (Opcode == V8::JMPLrr) {
521 printBaseOffsetPair (MI, 1, false);
523 printOperand (MI, 0);
528 // print non-immediate, non-register-def operands
529 // then print immediate operands
530 // then print register-def operands.
531 std::vector<int> print_order;
532 for (unsigned i = 0; i < MI->getNumOperands (); ++i)
533 if (!(MI->getOperand (i).isImmediate ()
534 || (MI->getOperand (i).isRegister ()
535 && MI->getOperand (i).isDef ())))
536 print_order.push_back (i);
537 for (unsigned i = 0; i < MI->getNumOperands (); ++i)
538 if (MI->getOperand (i).isImmediate ())
539 print_order.push_back (i);
540 for (unsigned i = 0; i < MI->getNumOperands (); ++i)
541 if (MI->getOperand (i).isRegister () && MI->getOperand (i).isDef ())
542 print_order.push_back (i);
543 for (unsigned i = 0, e = print_order.size (); i != e; ++i) {
544 printOperand (MI, print_order[i]);
545 if (i != (print_order.size () - 1))
551 bool V8Printer::doInitialization(Module &M) {
552 Mang = new Mangler(M);
553 return false; // success
556 // SwitchSection - Switch to the specified section of the executable if we are
557 // not already in it!
559 static void SwitchSection(std::ostream &OS, std::string &CurSection,
560 const char *NewSection) {
561 if (CurSection != NewSection) {
562 CurSection = NewSection;
563 if (!CurSection.empty())
564 OS << "\t.section \"" << NewSection << "\"\n";
568 bool V8Printer::doFinalization(Module &M) {
569 const TargetData &TD = TM.getTargetData();
570 std::string CurSection;
572 // Print out module-level global variables here.
573 for (Module::const_global_iterator I = M.global_begin(), E = M.global_end(); I != E; ++I)
574 if (I->hasInitializer()) { // External global require no code
576 std::string name = Mang->getValueName(I);
577 Constant *C = I->getInitializer();
578 unsigned Size = TD.getTypeSize(C->getType());
579 unsigned Align = TD.getTypeAlignment(C->getType());
581 if (C->isNullValue() &&
582 (I->hasLinkOnceLinkage() || I->hasInternalLinkage() ||
583 I->hasWeakLinkage() /* FIXME: Verify correct */)) {
584 SwitchSection(O, CurSection, ".data");
585 if (I->hasInternalLinkage())
586 O << "\t.local " << name << "\n";
588 O << "\t.comm " << name << "," << TD.getTypeSize(C->getType())
589 << "," << (unsigned)TD.getTypeAlignment(C->getType());
591 WriteAsOperand(O, I, true, true, &M);
594 switch (I->getLinkage()) {
595 case GlobalValue::LinkOnceLinkage:
596 case GlobalValue::WeakLinkage: // FIXME: Verify correct for weak.
597 // Nonnull linkonce -> weak
598 O << "\t.weak " << name << "\n";
599 SwitchSection(O, CurSection, "");
600 O << "\t.section\t\".llvm.linkonce.d." << name << "\",\"aw\",@progbits\n";
603 case GlobalValue::AppendingLinkage:
604 // FIXME: appending linkage variables should go into a section of
605 // their name or something. For now, just emit them as external.
606 case GlobalValue::ExternalLinkage:
607 // If external or appending, declare as a global symbol
608 O << "\t.globl " << name << "\n";
610 case GlobalValue::InternalLinkage:
611 if (C->isNullValue())
612 SwitchSection(O, CurSection, ".bss");
614 SwitchSection(O, CurSection, ".data");
616 case GlobalValue::GhostLinkage:
617 std::cerr << "Should not have any unmaterialized functions!\n";
621 O << "\t.align " << Align << "\n";
622 O << "\t.type " << name << ",#object\n";
623 O << "\t.size " << name << "," << Size << "\n";
624 O << name << ":\t\t\t\t! ";
625 WriteAsOperand(O, I, true, true, &M);
627 WriteAsOperand(O, C, false, false, &M);
629 emitGlobalConstant(C);
634 return false; // success