1 //===-- EmitAssembly.cpp - Emit SparcV9 Specific .s File -------------------==//
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 implements all of the stuff necessary to output a .s file from
11 // LLVM. The code in this file assumes that the specified module has already
12 // been compiled into the internal data structures of the Module.
14 // This code largely consists of two LLVM Pass's: a FunctionPass and a Pass.
15 // The FunctionPass is pipelined together with all of the rest of the code
16 // generation stages, and the Pass runs at the end to emit code for global
17 // variables and such.
19 //===----------------------------------------------------------------------===//
21 #include "llvm/Constants.h"
22 #include "llvm/DerivedTypes.h"
23 #include "llvm/Module.h"
24 #include "llvm/Pass.h"
25 #include "llvm/Assembly/Writer.h"
26 #include "llvm/CodeGen/MachineConstantPool.h"
27 #include "llvm/CodeGen/MachineFunction.h"
28 #include "llvm/CodeGen/MachineInstr.h"
29 #include "llvm/Support/Mangler.h"
30 #include "llvm/ADT/StringExtras.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "SparcV9Internals.h"
33 #include "MachineFunctionInfo.h"
38 Statistic<> EmittedInsts("asm-printer", "Number of machine instrs printed");
40 //===--------------------------------------------------------------------===//
43 /// getAsCString - Return the specified array as a C compatible string, only
44 /// if the predicate isString() is true.
46 std::string getAsCString(const ConstantArray *CVA) {
47 assert(CVA->isString() && "Array is not string compatible!");
49 std::string Result = "\"";
50 for (unsigned i = 0; i != CVA->getNumOperands(); ++i) {
51 unsigned char C = cast<ConstantInt>(CVA->getOperand(i))->getRawValue();
55 } else if (C == '\\') {
57 } else if (isprint(C)) {
60 Result += '\\'; // print all other chars as octal value
61 // Convert C to octal representation
62 Result += ((C >> 6) & 7) + '0';
63 Result += ((C >> 3) & 7) + '0';
64 Result += ((C >> 0) & 7) + '0';
72 inline bool ArrayTypeIsString(const ArrayType* arrayType) {
73 return (arrayType->getElementType() == Type::UByteTy ||
74 arrayType->getElementType() == Type::SByteTy);
77 unsigned findOptimalStorageSize(const TargetMachine &TM, const Type *Ty) {
78 // All integer types smaller than ints promote to 4 byte integers.
79 if (Ty->isIntegral() && Ty->getPrimitiveSize() < 4)
82 return TM.getTargetData().getTypeSize(Ty);
86 inline const std::string
87 TypeToDataDirective(const Type* type) {
88 switch(type->getTypeID()) {
89 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
91 case Type::UShortTyID: case Type::ShortTyID:
93 case Type::UIntTyID: case Type::IntTyID:
95 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
99 case Type::DoubleTyID:
101 case Type::ArrayTyID:
102 if (ArrayTypeIsString((ArrayType*) type))
105 return "<InvaliDataTypeForPrinting>";
107 return "<InvaliDataTypeForPrinting>";
111 /// Get the size of the constant for the given target.
112 /// If this is an unsized array, return 0.
115 ConstantToSize(const Constant* CV, const TargetMachine& target) {
116 if (const ConstantArray* CVA = dyn_cast<ConstantArray>(CV)) {
117 const ArrayType *aty = cast<ArrayType>(CVA->getType());
118 if (ArrayTypeIsString(aty))
119 return 1 + CVA->getNumOperands();
122 return findOptimalStorageSize(target, CV->getType());
125 /// Align data larger than one L1 cache line on L1 cache line boundaries.
126 /// Align all smaller data on the next higher 2^x boundary (4, 8, ...).
129 SizeToAlignment(unsigned int size, const TargetMachine& target) {
130 const unsigned short cacheLineSize = 16;
131 if (size > (unsigned) cacheLineSize / 2)
132 return cacheLineSize;
134 for (unsigned sz=1; /*no condition*/; sz *= 2)
139 /// Get the size of the type and then use SizeToAlignment.
142 TypeToAlignment(const Type* type, const TargetMachine& target) {
143 return SizeToAlignment(findOptimalStorageSize(target, type), target);
146 /// Get the size of the constant and then use SizeToAlignment.
147 /// Handles strings as a special case;
149 ConstantToAlignment(const Constant* CV, const TargetMachine& target) {
150 if (const ConstantArray* CVA = dyn_cast<ConstantArray>(CV))
151 if (ArrayTypeIsString(cast<ArrayType>(CVA->getType())))
152 return SizeToAlignment(1 + CVA->getNumOperands(), target);
154 return TypeToAlignment(CV->getType(), target);
157 } // End anonymous namespace
169 // Mangle symbol names appropriately
174 const TargetMachine &TM;
176 enum Sections CurSection;
178 AsmPrinter(std::ostream &os, const TargetMachine &T)
179 : /* idTable(0), */ O(os), TM(T), CurSection(Unknown) {}
185 // (start|end)(Module|Function) - Callback methods invoked by subclasses
186 void startModule(Module &M) {
187 Mang = new Mangler(M);
190 void PrintZeroBytesToPad(int numBytes) {
192 // Always use single unsigned bytes for padding. We don't know upon
193 // what data size the beginning address is aligned, so using anything
194 // other than a byte may cause alignment errors in the assembler.
197 printSingleConstantValue(Constant::getNullValue(Type::UByteTy));
200 /// Print a single constant value.
202 void printSingleConstantValue(const Constant* CV);
204 /// Print a constant value or values (it may be an aggregate).
205 /// Uses printSingleConstantValue() to print each individual value.
207 void printConstantValueOnly(const Constant* CV, int numPadBytesAfter = 0);
209 // Print a constant (which may be an aggregate) prefixed by all the
210 // appropriate directives. Uses printConstantValueOnly() to print the
212 void printConstant(const Constant* CV, std::string valID = "") {
213 if (valID.length() == 0)
216 O << "\t.align\t" << ConstantToAlignment(CV, TM) << "\n";
218 // Print .size and .type only if it is not a string.
219 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV))
220 if (CVA->isString()) {
221 // print it as a string and return
223 O << "\t" << ".ascii" << "\t" << getAsCString(CVA) << "\n";
227 O << "\t.type" << "\t" << valID << ",#object\n";
229 unsigned int constSize = ConstantToSize(CV, TM);
231 O << "\t.size" << "\t" << valID << "," << constSize << "\n";
235 printConstantValueOnly(CV);
238 // enterSection - Use this method to enter a different section of the output
239 // executable. This is used to only output necessary section transitions.
241 void enterSection(enum Sections S) {
242 if (S == CurSection) return; // Only switch section if necessary
245 O << "\n\t.section ";
248 default: assert(0 && "Bad section name!");
249 case Text: O << "\".text\""; break;
250 case ReadOnlyData: O << "\".rodata\",#alloc"; break;
251 case InitRWData: O << "\".data\",#alloc,#write"; break;
252 case ZeroInitRWData: O << "\".bss\",#alloc,#write"; break;
257 // getID Wrappers - Ensure consistent usage
258 // Symbol names in SparcV9 assembly language have these rules:
259 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
260 // (b) A name beginning in "." is treated as a local name.
261 std::string getID(const Function *F) {
262 return Mang->getValueName(F);
264 std::string getID(const BasicBlock *BB) {
265 return ".L_" + getID(BB->getParent()) + "_" + Mang->getValueName(BB);
267 std::string getID(const GlobalVariable *GV) {
268 return Mang->getValueName(GV);
270 std::string getID(const Constant *CV) {
271 return ".C_" + Mang->getValueName(CV);
273 std::string getID(const GlobalValue *GV) {
274 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
276 else if (const Function *F = dyn_cast<Function>(GV))
278 assert(0 && "Unexpected type of GlobalValue!");
282 // Combines expressions
283 inline std::string ConstantArithExprToString(const ConstantExpr* CE,
284 const TargetMachine &TM,
285 const std::string &op) {
286 return "(" + valToExprString(CE->getOperand(0), TM) + op
287 + valToExprString(CE->getOperand(1), TM) + ")";
290 /// ConstantExprToString() - Convert a ConstantExpr to an asm expression
291 /// and return this as a string.
293 std::string ConstantExprToString(const ConstantExpr* CE,
294 const TargetMachine& target);
296 /// valToExprString - Helper function for ConstantExprToString().
297 /// Appends result to argument string S.
299 std::string valToExprString(const Value* V, const TargetMachine& target);
301 } // End anonymous namespace
304 /// Print a single constant value.
306 void AsmPrinter::printSingleConstantValue(const Constant* CV) {
307 assert(CV->getType() != Type::VoidTy &&
308 CV->getType() != Type::LabelTy &&
309 "Unexpected type for Constant");
311 assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
312 && "Aggregate types should be handled outside this function");
314 O << "\t" << TypeToDataDirective(CV->getType()) << "\t";
316 if (const GlobalValue* GV = dyn_cast<GlobalValue>(CV)) {
317 O << getID(GV) << "\n";
318 } else if (isa<ConstantPointerNull>(CV) || isa<UndefValue>(CV)) {
319 // Null pointer value
321 } else if (const ConstantExpr* CE = dyn_cast<ConstantExpr>(CV)) {
322 // Constant expression built from operators, constants, and symbolic addrs
323 O << ConstantExprToString(CE, TM) << "\n";
324 } else if (CV->getType()->isPrimitiveType()) {
325 // Check primitive types last
326 if (isa<UndefValue>(CV)) {
328 } else if (CV->getType()->isFloatingPoint()) {
329 // FP Constants are printed as integer constants to avoid losing
331 double Val = cast<ConstantFP>(CV)->getValue();
332 if (CV->getType() == Type::FloatTy) {
333 float FVal = (float)Val;
334 char *ProxyPtr = (char*)&FVal; // Abide by C TBAA rules
335 O << *(unsigned int*)ProxyPtr;
336 } else if (CV->getType() == Type::DoubleTy) {
337 char *ProxyPtr = (char*)&Val; // Abide by C TBAA rules
338 O << *(uint64_t*)ProxyPtr;
340 assert(0 && "Unknown floating point type!");
343 O << "\t! " << CV->getType()->getDescription()
344 << " value: " << Val << "\n";
345 } else if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV)) {
346 O << (int)CB->getValue() << "\n";
348 WriteAsOperand(O, CV, false, false) << "\n";
351 assert(0 && "Unknown elementary type for constant");
355 /// Print a constant value or values (it may be an aggregate).
356 /// Uses printSingleConstantValue() to print each individual value.
358 void AsmPrinter::printConstantValueOnly(const Constant* CV,
359 int numPadBytesAfter) {
360 if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
361 if (CVA->isString()) {
362 // print the string alone and return
363 O << "\t" << ".ascii" << "\t" << getAsCString(CVA) << "\n";
365 // Not a string. Print the values in successive locations
366 for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
367 printConstantValueOnly(CVA->getOperand(i));
369 } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
370 // Print the fields in successive locations. Pad to align if needed!
371 const StructLayout *cvsLayout =
372 TM.getTargetData().getStructLayout(CVS->getType());
373 unsigned sizeSoFar = 0;
374 for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
375 const Constant* field = CVS->getOperand(i);
377 // Check if padding is needed and insert one or more 0s.
379 TM.getTargetData().getTypeSize(field->getType());
380 int padSize = ((i == e-1? cvsLayout->StructSize
381 : cvsLayout->MemberOffsets[i+1])
382 - cvsLayout->MemberOffsets[i]) - fieldSize;
383 sizeSoFar += (fieldSize + padSize);
385 // Now print the actual field value
386 printConstantValueOnly(field, padSize);
388 assert(sizeSoFar == cvsLayout->StructSize &&
389 "Layout of constant struct may be incorrect!");
390 } else if (isa<ConstantAggregateZero>(CV) || isa<UndefValue>(CV)) {
391 PrintZeroBytesToPad(TM.getTargetData().getTypeSize(CV->getType()));
393 printSingleConstantValue(CV);
395 if (numPadBytesAfter)
396 PrintZeroBytesToPad(numPadBytesAfter);
399 /// ConstantExprToString() - Convert a ConstantExpr to an asm expression
400 /// and return this as a string.
402 std::string AsmPrinter::ConstantExprToString(const ConstantExpr* CE,
403 const TargetMachine& target) {
405 switch(CE->getOpcode()) {
406 case Instruction::GetElementPtr:
407 { // generate a symbolic expression for the byte address
408 const Value* ptrVal = CE->getOperand(0);
409 std::vector<Value*> idxVec(CE->op_begin()+1, CE->op_end());
410 const TargetData &TD = target.getTargetData();
411 S += "(" + valToExprString(ptrVal, target) + ") + ("
412 + utostr(TD.getIndexedOffset(ptrVal->getType(),idxVec)) + ")";
416 case Instruction::Cast:
417 // Support only non-converting casts for now, i.e., a no-op.
418 // This assertion is not a complete check.
419 assert(target.getTargetData().getTypeSize(CE->getType()) ==
420 target.getTargetData().getTypeSize(CE->getOperand(0)->getType()));
421 S += "(" + valToExprString(CE->getOperand(0), target) + ")";
424 case Instruction::Add:
425 S += ConstantArithExprToString(CE, target, ") + (");
428 case Instruction::Sub:
429 S += ConstantArithExprToString(CE, target, ") - (");
432 case Instruction::Mul:
433 S += ConstantArithExprToString(CE, target, ") * (");
436 case Instruction::Div:
437 S += ConstantArithExprToString(CE, target, ") / (");
440 case Instruction::Rem:
441 S += ConstantArithExprToString(CE, target, ") % (");
444 case Instruction::And:
445 // Logical && for booleans; bitwise & otherwise
446 S += ConstantArithExprToString(CE, target,
447 ((CE->getType() == Type::BoolTy)? ") && (" : ") & ("));
450 case Instruction::Or:
451 // Logical || for booleans; bitwise | otherwise
452 S += ConstantArithExprToString(CE, target,
453 ((CE->getType() == Type::BoolTy)? ") || (" : ") | ("));
456 case Instruction::Xor:
457 // Bitwise ^ for all types
458 S += ConstantArithExprToString(CE, target, ") ^ (");
462 assert(0 && "Unsupported operator in ConstantExprToString()");
469 /// valToExprString - Helper function for ConstantExprToString().
470 /// Appends result to argument string S.
472 std::string AsmPrinter::valToExprString(const Value* V,
473 const TargetMachine& target) {
476 if (const GlobalValue* GV = dyn_cast<GlobalValue>(V)) {
478 } else if (const Constant* CV = dyn_cast<Constant>(V)) { // symbolic or known
479 if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV))
480 S += std::string(CB == ConstantBool::True ? "1" : "0");
481 else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV))
482 S += itostr(CI->getValue());
483 else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV))
484 S += utostr(CI->getValue());
485 else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
486 S += ftostr(CFP->getValue());
487 else if (isa<ConstantPointerNull>(CV) || isa<UndefValue>(CV))
489 else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV))
490 S += ConstantExprToString(CE, target);
497 assert(0 && "Cannot convert value to string");
498 S += "<illegal-value>";
505 struct SparcV9AsmPrinter : public FunctionPass, public AsmPrinter {
506 inline SparcV9AsmPrinter(std::ostream &os, const TargetMachine &t)
507 : AsmPrinter(os, t) {}
509 const Function *currFunction;
511 const char *getPassName() const {
512 return "Output SparcV9 Assembly for Functions";
515 virtual bool doInitialization(Module &M) {
520 virtual bool runOnFunction(Function &F) {
526 virtual bool doFinalization(Module &M) {
531 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
532 AU.setPreservesAll();
535 void emitFunction(const Function &F);
537 void emitBasicBlock(const MachineBasicBlock &MBB);
538 void emitMachineInst(const MachineInstr *MI);
540 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
541 void printOneOperand(const MachineOperand &Op, MachineOpCode opCode);
543 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
544 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
546 unsigned getOperandMask(unsigned Opcode) {
549 case V9::SUBcci: return 1 << 3; // Remove CC argument
550 default: return 0; // By default, don't hack operands...
554 void emitGlobals(const Module &M);
555 void printGlobalVariable(const GlobalVariable *GV);
558 } // End anonymous namespace
561 SparcV9AsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
562 unsigned int opNum) {
563 switch (MI->getOpcode()) {
575 SparcV9AsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
576 unsigned int opNum) {
577 if (TM.getInstrInfo()->isLoad(MI->getOpcode()))
579 else if (TM.getInstrInfo()->isStore(MI->getOpcode()))
586 SparcV9AsmPrinter::printOperands(const MachineInstr *MI, unsigned opNum) {
587 const MachineOperand& mop = MI->getOperand(opNum);
588 if (OpIsBranchTargetLabel(MI, opNum)) {
589 printOneOperand(mop, MI->getOpcode());
591 printOneOperand(MI->getOperand(opNum+1), MI->getOpcode());
593 } else if (OpIsMemoryAddressBase(MI, opNum)) {
595 printOneOperand(mop, MI->getOpcode());
597 printOneOperand(MI->getOperand(opNum+1), MI->getOpcode());
601 printOneOperand(mop, MI->getOpcode());
607 SparcV9AsmPrinter::printOneOperand(const MachineOperand &mop,
608 MachineOpCode opCode)
610 bool needBitsFlag = true;
612 if (mop.isHiBits32())
614 else if (mop.isLoBits32())
616 else if (mop.isHiBits64())
618 else if (mop.isLoBits64())
621 needBitsFlag = false;
623 switch (mop.getType())
625 case MachineOperand::MO_VirtualRegister:
626 case MachineOperand::MO_CCRegister:
627 case MachineOperand::MO_MachineRegister:
629 int regNum = (int)mop.getReg();
631 if (regNum == TM.getRegInfo()->getInvalidRegNum()) {
632 // better to print code with NULL registers than to die
635 O << "%" << TM.getRegInfo()->getUnifiedRegName(regNum);
640 case MachineOperand::MO_ConstantPoolIndex:
642 O << ".CPI_" << getID(currFunction)
643 << "_" << mop.getConstantPoolIndex();
647 case MachineOperand::MO_PCRelativeDisp:
649 const Value *Val = mop.getVRegValue();
650 assert(Val && "\tNULL Value in SparcV9AsmPrinter");
652 if (const BasicBlock *BB = dyn_cast<BasicBlock>(Val))
654 else if (const Function *F = dyn_cast<Function>(Val))
656 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
658 else if (const Constant *CV = dyn_cast<Constant>(Val))
661 assert(0 && "Unrecognized value in SparcV9AsmPrinter");
665 case MachineOperand::MO_SignExtendedImmed:
666 O << mop.getImmedValue();
669 case MachineOperand::MO_UnextendedImmed:
670 O << (uint64_t) mop.getImmedValue();
674 O << mop; // use dump field
682 void SparcV9AsmPrinter::emitMachineInst(const MachineInstr *MI) {
683 unsigned Opcode = MI->getOpcode();
685 if (Opcode == V9::PHI)
686 return; // Ignore Machine-PHI nodes.
688 O << "\t" << TM.getInstrInfo()->getName(Opcode) << "\t";
690 unsigned Mask = getOperandMask(Opcode);
692 bool NeedComma = false;
694 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
695 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
696 if (NeedComma) O << ", "; // Handle comma outputting
698 N = printOperands(MI, OpNum);
706 void SparcV9AsmPrinter::emitBasicBlock(const MachineBasicBlock &MBB) {
707 // Emit a label for the basic block
708 O << getID(MBB.getBasicBlock()) << ":\n";
710 // Loop over all of the instructions in the basic block...
711 for (MachineBasicBlock::const_iterator MII = MBB.begin(), MIE = MBB.end();
713 emitMachineInst(MII);
714 O << "\n"; // Separate BB's with newlines
717 void SparcV9AsmPrinter::emitFunction(const Function &F) {
718 std::string CurrentFnName = getID(&F);
719 MachineFunction &MF = MachineFunction::get(&F);
720 O << "!****** Outputing Function: " << CurrentFnName << " ******\n";
722 // Emit constant pool for this function
723 const MachineConstantPool *MCP = MF.getConstantPool();
724 const std::vector<Constant*> &CP = MCP->getConstants();
726 enterSection(ReadOnlyData);
727 for (unsigned i = 0, e = CP.size(); i != e; ++i) {
728 std::string cpiName = ".CPI_" + CurrentFnName + "_" + utostr(i);
729 printConstant(CP[i], cpiName);
733 O << "\t.align\t4\n\t.global\t" << CurrentFnName << "\n";
734 //O << "\t.type\t" << CurrentFnName << ",#function\n";
735 O << "\t.type\t" << CurrentFnName << ", 2\n";
736 O << CurrentFnName << ":\n";
738 // Output code for all of the basic blocks in the function...
739 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end(); I != E;++I)
742 // Output a .size directive so the debugger knows the extents of the function
743 O << ".EndOf_" << CurrentFnName << ":\n\t.size "
744 << CurrentFnName << ", .EndOf_"
745 << CurrentFnName << "-" << CurrentFnName << "\n";
747 // Put some spaces between the functions
751 void SparcV9AsmPrinter::printGlobalVariable(const GlobalVariable* GV) {
752 if (GV->hasExternalLinkage())
753 O << "\t.global\t" << getID(GV) << "\n";
755 if (GV->hasInitializer() &&
756 !(GV->getInitializer()->isNullValue() ||
757 isa<UndefValue>(GV->getInitializer()))) {
758 printConstant(GV->getInitializer(), getID(GV));
760 O << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
762 O << "\t.type\t" << getID(GV) << ",#object\n";
763 O << "\t.reserve\t" << getID(GV) << ","
764 << findOptimalStorageSize(TM, GV->getType()->getElementType())
769 void SparcV9AsmPrinter::emitGlobals(const Module &M) {
770 // Output global variables...
771 for (Module::const_giterator GI = M.gbegin(), GE = M.gend(); GI != GE; ++GI)
772 if (! GI->isExternal()) {
773 assert(GI->hasInitializer());
774 if (GI->isConstant())
775 enterSection(ReadOnlyData); // read-only, initialized data
776 else if (GI->getInitializer()->isNullValue() ||
777 isa<UndefValue>(GI->getInitializer()))
778 enterSection(ZeroInitRWData); // read-write zero data
780 enterSection(InitRWData); // read-write non-zero data
782 printGlobalVariable(GI);
788 FunctionPass *llvm::createAsmPrinterPass(std::ostream &Out, TargetMachine &TM) {
789 return new SparcV9AsmPrinter(Out, TM);