1 //===-- EmitAssembly.cpp - Emit Sparc Specific .s File ---------------------==//
3 // This file implements all of the stuff neccesary to output a .s file from
4 // LLVM. The code in this file assumes that the specified module has already
5 // been compiled into the internal data structures of the Module.
7 // This code largely consists of two LLVM Pass's: a FunctionPass and a Pass.
8 // The FunctionPass is pipelined together with all of the rest of the code
9 // generation stages, and the Pass runs at the end to emit code for global
10 // variables and such.
12 //===----------------------------------------------------------------------===//
14 #include "SparcInternals.h"
15 #include "llvm/CodeGen/MachineInstr.h"
16 #include "llvm/CodeGen/MachineCodeForMethod.h"
17 #include "llvm/GlobalVariable.h"
18 #include "llvm/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/BasicBlock.h"
21 #include "llvm/Function.h"
22 #include "llvm/Module.h"
23 #include "llvm/SlotCalculator.h"
24 #include "llvm/Pass.h"
25 #include "llvm/Assembly/Writer.h"
26 #include "Support/StringExtras.h"
32 class GlobalIdTable: public Annotation {
33 static AnnotationID AnnotId;
34 friend class AsmPrinter; // give access to AnnotId
36 typedef std::hash_map<const Value*, int> ValIdMap;
37 typedef ValIdMap::const_iterator ValIdMapConstIterator;
38 typedef ValIdMap:: iterator ValIdMapIterator;
40 SlotCalculator Table; // map anonymous values to unique integer IDs
41 ValIdMap valToIdMap; // used for values not handled by SlotCalculator
43 GlobalIdTable(Module* M) : Annotation(AnnotId), Table(M, true) {}
46 AnnotationID GlobalIdTable::AnnotId =
47 AnnotationManager::getID("ASM PRINTER GLOBAL TABLE ANNOT");
49 //===---------------------------------------------------------------------===//
50 // Code Shared By the two printer passes, as a mixin
51 //===---------------------------------------------------------------------===//
54 GlobalIdTable* idTable;
57 const TargetMachine &Target;
67 AsmPrinter(std::ostream &os, const TargetMachine &T)
68 : idTable(0), toAsm(os), Target(T), CurSection(Unknown) {}
70 // (start|end)(Module|Function) - Callback methods to be invoked by subclasses
71 void startModule(Module *M) {
72 // Create the global id table if it does not already exist
73 idTable = (GlobalIdTable*) M->getAnnotation(GlobalIdTable::AnnotId);
74 if (idTable == NULL) {
75 idTable = new GlobalIdTable(M);
76 M->addAnnotation(idTable);
79 void startFunction(Function *F) {
80 // Make sure the slot table has information about this function...
81 idTable->Table.incorporateFunction(F);
83 void endFunction(Function *F) {
84 idTable->Table.purgeFunction(); // Forget all about F
89 // Check if a name is external or accessible from external code.
90 // Only functions can currently be external. "main" is the only name
91 // that is visible externally.
92 bool isExternal(const Value* V) {
93 const Function *F = dyn_cast<Function>(V);
94 return F && (F->isExternal() || F->getName() == "main");
97 // enterSection - Use this method to enter a different section of the output
98 // executable. This is used to only output neccesary section transitions.
100 void enterSection(enum Sections S) {
101 if (S == CurSection) return; // Only switch section if neccesary
104 toAsm << "\n\t.section ";
107 default: assert(0 && "Bad section name!");
108 case Text: toAsm << "\".text\""; break;
109 case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
110 case InitRWData: toAsm << "\".data\",#alloc,#write"; break;
111 case UninitRWData: toAsm << "\".bss\",#alloc,#write\nBbss.bss:"; break;
116 static std::string getValidSymbolName(const string &S) {
119 // Symbol names in Sparc assembly language have these rules:
120 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
121 // (b) A name beginning in "." is treated as a local name.
122 // (c) Names beginning with "_" are reserved by ANSI C and shd not be used.
124 if (S[0] == '_' || isdigit(S[0]))
127 for (unsigned i = 0; i < S.size(); ++i)
130 if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
135 Result += char('0' + ((unsigned char)C >> 4));
136 Result += char('0' + (C & 0xF));
142 // getID - Return a valid identifier for the specified value. Base it on
143 // the name of the identifier if possible (qualified by the type), and
144 // use a numbered value based on prefix otherwise.
145 // FPrefix is always prepended to the output identifier.
147 string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
148 string Result = FPrefix ? FPrefix : ""; // "Forced prefix"
150 Result = Result + (V->hasName()? V->getName() : string(Prefix));
152 // Qualify all internal names with a unique id.
153 if (!isExternal(V)) {
154 int valId = idTable->Table.getValSlot(V);
156 GlobalIdTable::ValIdMapConstIterator I = idTable->valToIdMap.find(V);
157 if (I == idTable->valToIdMap.end())
158 valId = idTable->valToIdMap[V] = idTable->valToIdMap.size();
162 Result = Result + "_" + itostr(valId);
165 return getValidSymbolName(Result);
168 // getID Wrappers - Ensure consistent usage...
169 string getID(const Function *F) {
170 return getID(F, "LLVMFunction_");
172 string getID(const BasicBlock *BB) {
173 return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
175 string getID(const GlobalVariable *GV) {
176 return getID(GV, "LLVMGlobal_", ".G_");
178 string getID(const Constant *CV) {
179 return getID(CV, "LLVMConst_", ".C_");
185 //===----------------------------------------------------------------------===//
186 // SparcFunctionAsmPrinter Code
187 //===----------------------------------------------------------------------===//
189 struct SparcFunctionAsmPrinter : public FunctionPass, public AsmPrinter {
190 inline SparcFunctionAsmPrinter(std::ostream &os, const TargetMachine &t)
191 : AsmPrinter(os, t) {}
193 const char *getPassName() const {
194 return "Output Sparc Assembly for Functions";
197 virtual bool doInitialization(Module *M) {
202 virtual bool runOnFunction(Function *F) {
209 virtual bool doFinalization(Module *M) {
214 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
215 AU.setPreservesAll();
218 void emitFunction(const Function *F);
220 void emitBasicBlock(const BasicBlock *BB);
221 void emitMachineInst(const MachineInstr *MI);
223 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
224 void printOneOperand(const MachineOperand &Op);
226 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
227 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
229 unsigned getOperandMask(unsigned Opcode) {
231 case SUBcc: return 1 << 3; // Remove CC argument
232 case BA: return 1 << 0; // Remove Arg #0, which is always null or xcc
233 default: return 0; // By default, don't hack operands...
239 SparcFunctionAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
240 unsigned int opNum) {
241 switch (MI->getOpCode()) {
243 case JMPLRET: return (opNum == 0);
244 default: return false;
250 SparcFunctionAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
251 unsigned int opNum) {
252 if (Target.getInstrInfo().isLoad(MI->getOpCode()))
254 else if (Target.getInstrInfo().isStore(MI->getOpCode()))
261 #define PrintOp1PlusOp2(Op1, Op2) \
262 printOneOperand(Op1); \
264 printOneOperand(Op2);
267 SparcFunctionAsmPrinter::printOperands(const MachineInstr *MI,
270 const MachineOperand& Op = MI->getOperand(opNum);
272 if (OpIsBranchTargetLabel(MI, opNum))
274 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
277 else if (OpIsMemoryAddressBase(MI, opNum))
280 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
293 SparcFunctionAsmPrinter::printOneOperand(const MachineOperand &op)
295 switch (op.getOperandType())
297 case MachineOperand::MO_VirtualRegister:
298 case MachineOperand::MO_CCRegister:
299 case MachineOperand::MO_MachineRegister:
301 int RegNum = (int)op.getAllocatedRegNum();
303 // better to print code with NULL registers than to die
304 if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
305 toAsm << "<NULL VALUE>";
307 toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
312 case MachineOperand::MO_PCRelativeDisp:
314 const Value *Val = op.getVRegValue();
316 toAsm << "\t<*NULL Value*>";
317 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(Val))
319 else if (const Function *M = dyn_cast<Function>(Val))
321 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
323 else if (const Constant *CV = dyn_cast<Constant>(Val))
326 toAsm << "<unknown value=" << Val << ">";
330 case MachineOperand::MO_SignExtendedImmed:
331 case MachineOperand::MO_UnextendedImmed:
332 toAsm << (long)op.getImmedValue();
336 toAsm << op; // use dump field
343 SparcFunctionAsmPrinter::emitMachineInst(const MachineInstr *MI)
345 unsigned Opcode = MI->getOpCode();
347 if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
348 return; // IGNORE PHI NODES
350 toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
352 unsigned Mask = getOperandMask(Opcode);
354 bool NeedComma = false;
356 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
357 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
358 if (NeedComma) toAsm << ", "; // Handle comma outputing
360 N = printOperands(MI, OpNum);
369 SparcFunctionAsmPrinter::emitBasicBlock(const BasicBlock *BB)
371 // Emit a label for the basic block
372 toAsm << getID(BB) << ":\n";
374 // Get the vector of machine instructions corresponding to this bb.
375 const MachineCodeForBasicBlock &MIs = BB->getMachineInstrVec();
376 MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
378 // Loop over all of the instructions in the basic block...
379 for (; MII != MIE; ++MII)
380 emitMachineInst(*MII);
381 toAsm << "\n"; // Seperate BB's with newlines
385 SparcFunctionAsmPrinter::emitFunction(const Function *M)
387 string methName = getID(M);
388 toAsm << "!****** Outputing Function: " << methName << " ******\n";
389 enterSection(AsmPrinter::Text);
390 toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
391 //toAsm << "\t.type\t" << methName << ",#function\n";
392 toAsm << "\t.type\t" << methName << ", 2\n";
393 toAsm << methName << ":\n";
395 // Output code for all of the basic blocks in the function...
396 for (Function::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
399 // Output a .size directive so the debugger knows the extents of the function
400 toAsm << ".EndOf_" << methName << ":\n\t.size "
401 << methName << ", .EndOf_"
402 << methName << "-" << methName << "\n";
404 // Put some spaces between the functions
408 } // End anonymous namespace
410 Pass *UltraSparc::getFunctionAsmPrinterPass(PassManager &PM, std::ostream &Out){
411 return new SparcFunctionAsmPrinter(Out, *this);
418 //===----------------------------------------------------------------------===//
419 // SparcFunctionAsmPrinter Code
420 //===----------------------------------------------------------------------===//
424 class SparcModuleAsmPrinter : public Pass, public AsmPrinter {
426 SparcModuleAsmPrinter(std::ostream &os, TargetMachine &t)
427 : AsmPrinter(os, t) {}
429 const char *getPassName() const { return "Output Sparc Assembly for Module"; }
431 virtual bool run(Module *M) {
433 emitGlobalsAndConstants(M);
438 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
439 AU.setPreservesAll();
443 void emitGlobalsAndConstants(const Module *M);
445 void printGlobalVariable(const GlobalVariable *GV);
446 void printSingleConstant( const Constant* CV);
447 void printConstantValueOnly(const Constant* CV);
448 void printConstant( const Constant* CV, std::string valID = "");
450 static void FoldConstants(const Module *M,
451 std::hash_set<const Constant*> &moduleConstants);
455 // Can we treat the specified array as a string? Only if it is an array of
456 // ubytes or non-negative sbytes.
458 static bool isStringCompatible(ConstantArray *CPA) {
459 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
460 if (ETy == Type::UByteTy) return true;
461 if (ETy != Type::SByteTy) return false;
463 for (unsigned i = 0; i < CPA->getNumOperands(); ++i)
464 if (cast<ConstantSInt>(CPA->getOperand(i))->getValue() < 0)
470 // toOctal - Convert the low order bits of X into an octal letter
471 static inline char toOctal(int X) {
475 // getAsCString - Return the specified array as a C compatible string, only if
476 // the predicate isStringCompatible is true.
478 static string getAsCString(ConstantArray *CPA) {
479 assert(isStringCompatible(CPA) && "Array is not string compatible!");
482 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
484 for (unsigned i = 0; i < CPA->getNumOperands(); ++i) {
485 unsigned char C = (ETy == Type::SByteTy) ?
486 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
487 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
493 case '\a': Result += "\\a"; break;
494 case '\b': Result += "\\b"; break;
495 case '\f': Result += "\\f"; break;
496 case '\n': Result += "\\n"; break;
497 case '\r': Result += "\\r"; break;
498 case '\t': Result += "\\t"; break;
499 case '\v': Result += "\\v"; break;
502 Result += toOctal(C >> 6);
503 Result += toOctal(C >> 3);
504 Result += toOctal(C >> 0);
515 ArrayTypeIsString(ArrayType* arrayType)
517 return (arrayType->getElementType() == Type::UByteTy ||
518 arrayType->getElementType() == Type::SByteTy);
522 TypeToDataDirective(const Type* type)
524 switch(type->getPrimitiveID())
526 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
528 case Type::UShortTyID: case Type::ShortTyID:
530 case Type::UIntTyID: case Type::IntTyID:
532 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
534 case Type::FloatTyID:
536 case Type::DoubleTyID:
538 case Type::ArrayTyID:
539 if (ArrayTypeIsString((ArrayType*) type))
542 return "<InvaliDataTypeForPrinting>";
544 return "<InvaliDataTypeForPrinting>";
548 // Get the size of the constant for the given target.
549 // If this is an unsized array, return 0.
552 ConstantToSize(const Constant* CV, const TargetMachine& target)
554 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
556 ArrayType *aty = cast<ArrayType>(CPA->getType());
557 if (ArrayTypeIsString(aty))
558 return 1 + CPA->getNumOperands();
561 return target.findOptimalStorageSize(CV->getType());
566 // Align data larger than one L1 cache line on L1 cache line boundaries.
567 // Align all smaller data on the next higher 2^x boundary (4, 8, ...).
570 SizeToAlignment(unsigned int size, const TargetMachine& target)
572 unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
573 if (size > (unsigned) cacheLineSize / 2)
574 return cacheLineSize;
576 for (unsigned sz=1; /*no condition*/; sz *= 2)
581 // Get the size of the type and then use SizeToAlignment.
584 TypeToAlignment(const Type* type, const TargetMachine& target)
586 return SizeToAlignment(target.findOptimalStorageSize(type), target);
589 // Get the size of the constant and then use SizeToAlignment.
590 // Handles strings as a special case;
592 ConstantToAlignment(const Constant* CV, const TargetMachine& target)
594 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
595 if (ArrayTypeIsString(cast<ArrayType>(CPA->getType())))
596 return SizeToAlignment(1 + CPA->getNumOperands(), target);
598 return TypeToAlignment(CV->getType(), target);
602 // Print a single constant value.
604 SparcModuleAsmPrinter::printSingleConstant(const Constant* CV)
606 assert(CV->getType() != Type::VoidTy &&
607 CV->getType() != Type::TypeTy &&
608 CV->getType() != Type::LabelTy &&
609 "Unexpected type for Constant");
611 assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
612 && "Aggregate types should be handled outside this function");
614 toAsm << "\t" << TypeToDataDirective(CV->getType()) << "\t";
616 if (CV->getType()->isPrimitiveType())
618 if (CV->getType()->isFloatingPoint()) {
619 // FP Constants are printed as integer constants to avoid losing
621 double Val = cast<ConstantFP>(CV)->getValue();
622 if (CV->getType() == Type::FloatTy) {
623 float FVal = (float)Val;
624 char *ProxyPtr = (char*)&FVal; // Abide by C TBAA rules
625 toAsm << *(unsigned int*)ProxyPtr;
626 } else if (CV->getType() == Type::DoubleTy) {
627 char *ProxyPtr = (char*)&Val; // Abide by C TBAA rules
628 toAsm << *(uint64_t*)ProxyPtr;
630 assert(0 && "Unknown floating point type!");
633 toAsm << "\t! " << CV->getType()->getDescription()
634 << " value: " << Val << "\n";
636 WriteAsOperand(toAsm, CV, false, false) << "\n";
639 else if (ConstantPointer* CPP = dyn_cast<ConstantPointer>(CV))
641 assert(CPP->isNullValue() &&
642 "Cannot yet print non-null pointer constants to assembly");
645 else if (isa<ConstantPointerRef>(CV))
647 assert(0 && "Cannot yet initialize pointer refs in assembly");
651 assert(0 && "Unknown elementary type for constant");
655 // Print a constant value or values (it may be an aggregate).
656 // Uses printSingleConstant() to print each individual value.
658 SparcModuleAsmPrinter::printConstantValueOnly(const Constant* CV)
660 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
662 if (CPA && isStringCompatible(CPA))
663 { // print the string alone and return
664 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
667 { // Not a string. Print the values in successive locations
668 const std::vector<Use> &constValues = CPA->getValues();
669 for (unsigned i=1; i < constValues.size(); i++)
670 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
672 else if (ConstantStruct *CPS = dyn_cast<ConstantStruct>(CV))
673 { // Print the fields in successive locations
674 const std::vector<Use>& constValues = CPS->getValues();
675 for (unsigned i=1; i < constValues.size(); i++)
676 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
679 this->printSingleConstant(CV);
682 // Print a constant (which may be an aggregate) prefixed by all the
683 // appropriate directives. Uses printConstantValueOnly() to print the
686 SparcModuleAsmPrinter::printConstant(const Constant* CV, string valID)
688 if (valID.length() == 0)
691 toAsm << "\t.align\t" << ConstantToAlignment(CV, Target) << "\n";
693 // Print .size and .type only if it is not a string.
694 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
695 if (CPA && isStringCompatible(CPA))
696 { // print it as a string and return
697 toAsm << valID << ":\n";
698 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
702 toAsm << "\t.type" << "\t" << valID << ",#object\n";
704 unsigned int constSize = ConstantToSize(CV, Target);
706 toAsm << "\t.size" << "\t" << valID << "," << constSize << "\n";
708 toAsm << valID << ":\n";
710 printConstantValueOnly(CV);
714 void SparcModuleAsmPrinter::FoldConstants(const Module *M,
715 std::hash_set<const Constant*> &MC) {
716 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
717 if (!(*I)->isExternal()) {
718 const std::hash_set<const Constant*> &pool =
719 MachineCodeForMethod::get(*I).getConstantPoolValues();
720 MC.insert(pool.begin(), pool.end());
724 void SparcModuleAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
726 toAsm << "\t.global\t" << getID(GV) << "\n";
728 if (GV->hasInitializer())
729 printConstant(GV->getInitializer(), getID(GV));
731 toAsm << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
733 toAsm << "\t.type\t" << getID(GV) << ",#object\n";
734 toAsm << "\t.reserve\t" << getID(GV) << ","
735 << Target.findOptimalStorageSize(GV->getType()->getElementType())
741 void SparcModuleAsmPrinter::emitGlobalsAndConstants(const Module *M) {
742 // First, get the constants there were marked by the code generator for
743 // inclusion in the assembly code data area and fold them all into a
744 // single constant pool since there may be lots of duplicates. Also,
745 // lets force these constants into the slot table so that we can get
746 // unique names for unnamed constants also.
748 std::hash_set<const Constant*> moduleConstants;
749 FoldConstants(M, moduleConstants);
751 // Now, emit the three data sections separately; the cost of I/O should
752 // make up for the cost of extra passes over the globals list!
754 // Section 1 : Read-only data section (implies initialized)
755 enterSection(AsmPrinter::ReadOnlyData);
756 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
757 if ((*GI)->hasInitializer() && (*GI)->isConstant())
758 printGlobalVariable(*GI);
760 for (std::hash_set<const Constant*>::const_iterator
761 I = moduleConstants.begin(),
762 E = moduleConstants.end(); I != E; ++I)
765 // Section 2 : Initialized read-write data section
766 enterSection(AsmPrinter::InitRWData);
767 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
768 if ((*GI)->hasInitializer() && ! (*GI)->isConstant())
769 printGlobalVariable(*GI);
771 // Section 3 : Uninitialized read-write data section
772 enterSection(AsmPrinter::UninitRWData);
773 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
774 if (! (*GI)->hasInitializer())
775 printGlobalVariable(*GI);
780 } // End anonymous namespace
782 Pass *UltraSparc::getModuleAsmPrinterPass(PassManager &PM, std::ostream &Out) {
783 return new SparcModuleAsmPrinter(Out, *this);