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/MachineCodeForBasicBlock.h"
17 #include "llvm/CodeGen/MachineCodeForMethod.h"
18 #include "llvm/GlobalVariable.h"
19 #include "llvm/Constants.h"
20 #include "llvm/DerivedTypes.h"
21 #include "llvm/BasicBlock.h"
22 #include "llvm/Function.h"
23 #include "llvm/Module.h"
24 #include "llvm/SlotCalculator.h"
25 #include "llvm/Pass.h"
26 #include "llvm/Assembly/Writer.h"
27 #include "Support/StringExtras.h"
33 class GlobalIdTable: public Annotation {
34 static AnnotationID AnnotId;
35 friend class AsmPrinter; // give access to AnnotId
37 typedef hash_map<const Value*, int> ValIdMap;
38 typedef ValIdMap::const_iterator ValIdMapConstIterator;
39 typedef ValIdMap:: iterator ValIdMapIterator;
41 SlotCalculator Table; // map anonymous values to unique integer IDs
42 ValIdMap valToIdMap; // used for values not handled by SlotCalculator
44 GlobalIdTable(Module* M) : Annotation(AnnotId), Table(M, true) {}
47 AnnotationID GlobalIdTable::AnnotId =
48 AnnotationManager::getID("ASM PRINTER GLOBAL TABLE ANNOT");
50 //===---------------------------------------------------------------------===//
51 // Code Shared By the two printer passes, as a mixin
52 //===---------------------------------------------------------------------===//
55 GlobalIdTable* idTable;
58 const TargetMachine &Target;
68 AsmPrinter(std::ostream &os, const TargetMachine &T)
69 : idTable(0), toAsm(os), Target(T), CurSection(Unknown) {}
71 // (start|end)(Module|Function) - Callback methods to be invoked by subclasses
72 void startModule(Module &M) {
73 // Create the global id table if it does not already exist
74 idTable = (GlobalIdTable*)M.getAnnotation(GlobalIdTable::AnnotId);
75 if (idTable == NULL) {
76 idTable = new GlobalIdTable(&M);
77 M.addAnnotation(idTable);
80 void startFunction(Function &F) {
81 // Make sure the slot table has information about this function...
82 idTable->Table.incorporateFunction(&F);
84 void endFunction(Function &) {
85 idTable->Table.purgeFunction(); // Forget all about F
90 // Check if a value is external or accessible from external code.
91 bool isExternal(const Value* V) {
92 const GlobalValue *GV = dyn_cast<GlobalValue>(V);
93 return GV && GV->hasExternalLinkage();
96 // enterSection - Use this method to enter a different section of the output
97 // executable. This is used to only output neccesary section transitions.
99 void enterSection(enum Sections S) {
100 if (S == CurSection) return; // Only switch section if neccesary
103 toAsm << "\n\t.section ";
106 default: assert(0 && "Bad section name!");
107 case Text: toAsm << "\".text\""; break;
108 case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
109 case InitRWData: toAsm << "\".data\",#alloc,#write"; break;
110 case UninitRWData: toAsm << "\".bss\",#alloc,#write\nBbss.bss:"; break;
115 static std::string getValidSymbolName(const string &S) {
118 // Symbol names in Sparc assembly language have these rules:
119 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
120 // (b) A name beginning in "." is treated as a local name.
121 // (c) Names beginning with "_" are reserved by ANSI C and shd not be used.
123 if (S[0] == '_' || isdigit(S[0]))
126 for (unsigned i = 0; i < S.size(); ++i)
129 if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
134 Result += char('0' + ((unsigned char)C >> 4));
135 Result += char('0' + (C & 0xF));
141 // getID - Return a valid identifier for the specified value. Base it on
142 // the name of the identifier if possible (qualified by the type), and
143 // use a numbered value based on prefix otherwise.
144 // FPrefix is always prepended to the output identifier.
146 string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
147 string Result = FPrefix ? FPrefix : ""; // "Forced prefix"
149 Result += V->hasName() ? V->getName() : string(Prefix);
151 // Qualify all internal names with a unique id.
152 if (!isExternal(V)) {
153 int valId = idTable->Table.getValSlot(V);
155 GlobalIdTable::ValIdMapConstIterator I = idTable->valToIdMap.find(V);
156 if (I == idTable->valToIdMap.end())
157 valId = idTable->valToIdMap[V] = idTable->valToIdMap.size();
161 Result = Result + "_" + itostr(valId);
164 return getValidSymbolName(Result);
167 // getID Wrappers - Ensure consistent usage...
168 string getID(const Function *F) {
169 return getID(F, "LLVMFunction_");
171 string getID(const BasicBlock *BB) {
172 return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
174 string getID(const GlobalVariable *GV) {
175 return getID(GV, "LLVMGlobal_");
177 string getID(const Constant *CV) {
178 return getID(CV, "LLVMConst_", ".C_");
180 string getID(const GlobalValue *GV) {
181 if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
183 else if (const Function *F = dyn_cast<Function>(GV))
185 assert(0 && "Unexpected type of GlobalValue!");
192 //===----------------------------------------------------------------------===//
193 // SparcFunctionAsmPrinter Code
194 //===----------------------------------------------------------------------===//
196 struct SparcFunctionAsmPrinter : public FunctionPass, public AsmPrinter {
197 inline SparcFunctionAsmPrinter(std::ostream &os, const TargetMachine &t)
198 : AsmPrinter(os, t) {}
200 const char *getPassName() const {
201 return "Output Sparc Assembly for Functions";
204 virtual bool doInitialization(Module &M) {
209 virtual bool runOnFunction(Function &F) {
216 virtual bool doFinalization(Module &M) {
221 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
222 AU.setPreservesAll();
225 void emitFunction(const Function &F);
227 void emitBasicBlock(const BasicBlock *BB);
228 void emitMachineInst(const MachineInstr *MI);
230 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
231 void printOneOperand(const MachineOperand &Op);
233 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
234 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
236 unsigned getOperandMask(unsigned Opcode) {
238 case SUBcc: return 1 << 3; // Remove CC argument
239 //case BA: return 1 << 0; // Remove Arg #0, which is always null or xcc
240 default: return 0; // By default, don't hack operands...
246 SparcFunctionAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
247 unsigned int opNum) {
248 switch (MI->getOpCode()) {
250 case JMPLRET: return (opNum == 0);
251 default: return false;
257 SparcFunctionAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
258 unsigned int opNum) {
259 if (Target.getInstrInfo().isLoad(MI->getOpCode()))
261 else if (Target.getInstrInfo().isStore(MI->getOpCode()))
268 #define PrintOp1PlusOp2(mop1, mop2) \
269 printOneOperand(mop1); \
271 printOneOperand(mop2);
274 SparcFunctionAsmPrinter::printOperands(const MachineInstr *MI,
277 const MachineOperand& mop = MI->getOperand(opNum);
279 if (OpIsBranchTargetLabel(MI, opNum))
281 PrintOp1PlusOp2(mop, MI->getOperand(opNum+1));
284 else if (OpIsMemoryAddressBase(MI, opNum))
287 PrintOp1PlusOp2(mop, MI->getOperand(opNum+1));
293 printOneOperand(mop);
300 SparcFunctionAsmPrinter::printOneOperand(const MachineOperand &mop)
302 bool needBitsFlag = true;
304 if (mop.opHiBits32())
306 else if (mop.opLoBits32())
308 else if (mop.opHiBits64())
310 else if (mop.opLoBits64())
313 needBitsFlag = false;
315 switch (mop.getOperandType())
317 case MachineOperand::MO_VirtualRegister:
318 case MachineOperand::MO_CCRegister:
319 case MachineOperand::MO_MachineRegister:
321 int RegNum = (int)mop.getAllocatedRegNum();
323 // better to print code with NULL registers than to die
324 if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
325 toAsm << "<NULL VALUE>";
327 toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
332 case MachineOperand::MO_PCRelativeDisp:
334 const Value *Val = mop.getVRegValue();
335 assert(Val && "\tNULL Value in SparcFunctionAsmPrinter");
337 if (const BasicBlock *BB = dyn_cast<const BasicBlock>(Val))
339 else if (const Function *M = dyn_cast<Function>(Val))
341 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
343 else if (const Constant *CV = dyn_cast<Constant>(Val))
346 assert(0 && "Unrecognized value in SparcFunctionAsmPrinter");
350 case MachineOperand::MO_SignExtendedImmed:
351 toAsm << mop.getImmedValue();
354 case MachineOperand::MO_UnextendedImmed:
355 toAsm << (uint64_t) mop.getImmedValue();
359 toAsm << mop; // use dump field
369 SparcFunctionAsmPrinter::emitMachineInst(const MachineInstr *MI)
371 unsigned Opcode = MI->getOpCode();
373 if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
374 return; // IGNORE PHI NODES
376 toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
378 unsigned Mask = getOperandMask(Opcode);
380 bool NeedComma = false;
382 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
383 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
384 if (NeedComma) toAsm << ", "; // Handle comma outputing
386 N = printOperands(MI, OpNum);
395 SparcFunctionAsmPrinter::emitBasicBlock(const BasicBlock *BB)
397 // Emit a label for the basic block
398 toAsm << getID(BB) << ":\n";
400 // Get the vector of machine instructions corresponding to this bb.
401 const MachineCodeForBasicBlock &MIs = MachineCodeForBasicBlock::get(BB);
402 MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
404 // Loop over all of the instructions in the basic block...
405 for (; MII != MIE; ++MII)
406 emitMachineInst(*MII);
407 toAsm << "\n"; // Seperate BB's with newlines
411 SparcFunctionAsmPrinter::emitFunction(const Function &F)
413 string methName = getID(&F);
414 toAsm << "!****** Outputing Function: " << methName << " ******\n";
415 enterSection(AsmPrinter::Text);
416 toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
417 //toAsm << "\t.type\t" << methName << ",#function\n";
418 toAsm << "\t.type\t" << methName << ", 2\n";
419 toAsm << methName << ":\n";
421 // Output code for all of the basic blocks in the function...
422 for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I)
425 // Output a .size directive so the debugger knows the extents of the function
426 toAsm << ".EndOf_" << methName << ":\n\t.size "
427 << methName << ", .EndOf_"
428 << methName << "-" << methName << "\n";
430 // Put some spaces between the functions
434 } // End anonymous namespace
436 Pass *UltraSparc::getFunctionAsmPrinterPass(PassManager &PM, std::ostream &Out){
437 return new SparcFunctionAsmPrinter(Out, *this);
444 //===----------------------------------------------------------------------===//
445 // SparcFunctionAsmPrinter Code
446 //===----------------------------------------------------------------------===//
450 class SparcModuleAsmPrinter : public Pass, public AsmPrinter {
452 SparcModuleAsmPrinter(std::ostream &os, TargetMachine &t)
453 : AsmPrinter(os, t) {}
455 const char *getPassName() const { return "Output Sparc Assembly for Module"; }
457 virtual bool run(Module &M) {
459 emitGlobalsAndConstants(M);
464 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
465 AU.setPreservesAll();
469 void emitGlobalsAndConstants(const Module &M);
471 void printGlobalVariable(const GlobalVariable *GV);
472 void printSingleConstant( const Constant* CV);
473 void printConstantValueOnly(const Constant* CV);
474 void printConstant( const Constant* CV, std::string valID = "");
476 static void FoldConstants(const Module &M,
477 hash_set<const Constant*> &moduleConstants);
481 // Can we treat the specified array as a string? Only if it is an array of
482 // ubytes or non-negative sbytes.
484 static bool isStringCompatible(const ConstantArray *CPA) {
485 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
486 if (ETy == Type::UByteTy) return true;
487 if (ETy != Type::SByteTy) return false;
489 for (unsigned i = 0; i < CPA->getNumOperands(); ++i)
490 if (cast<ConstantSInt>(CPA->getOperand(i))->getValue() < 0)
496 // toOctal - Convert the low order bits of X into an octal letter
497 static inline char toOctal(int X) {
501 // getAsCString - Return the specified array as a C compatible string, only if
502 // the predicate isStringCompatible is true.
504 static string getAsCString(const ConstantArray *CPA) {
505 assert(isStringCompatible(CPA) && "Array is not string compatible!");
508 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
510 for (unsigned i = 0; i < CPA->getNumOperands(); ++i) {
511 unsigned char C = (ETy == Type::SByteTy) ?
512 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
513 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
517 } else if (isprint(C)) {
521 case '\a': Result += "\\a"; break;
522 case '\b': Result += "\\b"; break;
523 case '\f': Result += "\\f"; break;
524 case '\n': Result += "\\n"; break;
525 case '\r': Result += "\\r"; break;
526 case '\t': Result += "\\t"; break;
527 case '\v': Result += "\\v"; break;
530 Result += toOctal(C >> 6);
531 Result += toOctal(C >> 3);
532 Result += toOctal(C >> 0);
543 ArrayTypeIsString(const ArrayType* arrayType)
545 return (arrayType->getElementType() == Type::UByteTy ||
546 arrayType->getElementType() == Type::SByteTy);
550 TypeToDataDirective(const Type* type)
552 switch(type->getPrimitiveID())
554 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
556 case Type::UShortTyID: case Type::ShortTyID:
558 case Type::UIntTyID: case Type::IntTyID:
560 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
562 case Type::FloatTyID:
564 case Type::DoubleTyID:
566 case Type::ArrayTyID:
567 if (ArrayTypeIsString((ArrayType*) type))
570 return "<InvaliDataTypeForPrinting>";
572 return "<InvaliDataTypeForPrinting>";
576 // Get the size of the constant for the given target.
577 // If this is an unsized array, return 0.
580 ConstantToSize(const Constant* CV, const TargetMachine& target)
582 if (const ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
584 const ArrayType *aty = cast<ArrayType>(CPA->getType());
585 if (ArrayTypeIsString(aty))
586 return 1 + CPA->getNumOperands();
589 return target.findOptimalStorageSize(CV->getType());
594 // Align data larger than one L1 cache line on L1 cache line boundaries.
595 // Align all smaller data on the next higher 2^x boundary (4, 8, ...).
598 SizeToAlignment(unsigned int size, const TargetMachine& target)
600 unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
601 if (size > (unsigned) cacheLineSize / 2)
602 return cacheLineSize;
604 for (unsigned sz=1; /*no condition*/; sz *= 2)
609 // Get the size of the type and then use SizeToAlignment.
612 TypeToAlignment(const Type* type, const TargetMachine& target)
614 return SizeToAlignment(target.findOptimalStorageSize(type), target);
617 // Get the size of the constant and then use SizeToAlignment.
618 // Handles strings as a special case;
620 ConstantToAlignment(const Constant* CV, const TargetMachine& target)
622 if (const ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
623 if (ArrayTypeIsString(cast<ArrayType>(CPA->getType())))
624 return SizeToAlignment(1 + CPA->getNumOperands(), target);
626 return TypeToAlignment(CV->getType(), target);
630 // Print a single constant value.
632 SparcModuleAsmPrinter::printSingleConstant(const Constant* CV)
634 assert(CV->getType() != Type::VoidTy &&
635 CV->getType() != Type::TypeTy &&
636 CV->getType() != Type::LabelTy &&
637 "Unexpected type for Constant");
639 assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
640 && "Aggregate types should be handled outside this function");
642 toAsm << "\t" << TypeToDataDirective(CV->getType()) << "\t";
644 if (CV->getType()->isPrimitiveType())
646 if (CV->getType()->isFloatingPoint()) {
647 // FP Constants are printed as integer constants to avoid losing
649 double Val = cast<ConstantFP>(CV)->getValue();
650 if (CV->getType() == Type::FloatTy) {
651 float FVal = (float)Val;
652 char *ProxyPtr = (char*)&FVal; // Abide by C TBAA rules
653 toAsm << *(unsigned int*)ProxyPtr;
654 } else if (CV->getType() == Type::DoubleTy) {
655 char *ProxyPtr = (char*)&Val; // Abide by C TBAA rules
656 toAsm << *(uint64_t*)ProxyPtr;
658 assert(0 && "Unknown floating point type!");
661 toAsm << "\t! " << CV->getType()->getDescription()
662 << " value: " << Val << "\n";
664 WriteAsOperand(toAsm, CV, false, false) << "\n";
667 else if (const ConstantPointerRef* CPR = dyn_cast<ConstantPointerRef>(CV))
668 { // This is a constant address for a global variable or method.
669 // Use the name of the variable or method as the address value.
670 toAsm << getID(CPR->getValue()) << "\n";
672 else if (isa<ConstantPointerNull>(CV))
678 assert(0 && "Unknown elementary type for constant");
682 // Print a constant value or values (it may be an aggregate).
683 // Uses printSingleConstant() to print each individual value.
685 SparcModuleAsmPrinter::printConstantValueOnly(const Constant* CV)
687 const ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
689 if (CPA && isStringCompatible(CPA))
690 { // print the string alone and return
691 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
694 { // Not a string. Print the values in successive locations
695 const std::vector<Use> &constValues = CPA->getValues();
696 for (unsigned i=0; i < constValues.size(); i++)
697 printConstantValueOnly(cast<Constant>(constValues[i].get()));
699 else if (const ConstantStruct *CPS = dyn_cast<ConstantStruct>(CV))
700 { // Print the fields in successive locations
701 const std::vector<Use>& constValues = CPS->getValues();
702 for (unsigned i=0; i < constValues.size(); i++)
703 printConstantValueOnly(cast<Constant>(constValues[i].get()));
706 printSingleConstant(CV);
709 // Print a constant (which may be an aggregate) prefixed by all the
710 // appropriate directives. Uses printConstantValueOnly() to print the
713 SparcModuleAsmPrinter::printConstant(const Constant* CV, string valID)
715 if (valID.length() == 0)
718 toAsm << "\t.align\t" << ConstantToAlignment(CV, Target) << "\n";
720 // Print .size and .type only if it is not a string.
721 const ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
722 if (CPA && isStringCompatible(CPA))
723 { // print it as a string and return
724 toAsm << valID << ":\n";
725 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
729 toAsm << "\t.type" << "\t" << valID << ",#object\n";
731 unsigned int constSize = ConstantToSize(CV, Target);
733 toAsm << "\t.size" << "\t" << valID << "," << constSize << "\n";
735 toAsm << valID << ":\n";
737 printConstantValueOnly(CV);
741 void SparcModuleAsmPrinter::FoldConstants(const Module &M,
742 hash_set<const Constant*> &MC) {
743 for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
744 if (!I->isExternal()) {
745 const hash_set<const Constant*> &pool =
746 MachineCodeForMethod::get(I).getConstantPoolValues();
747 MC.insert(pool.begin(), pool.end());
751 void SparcModuleAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
753 toAsm << "\t.global\t" << getID(GV) << "\n";
755 if (GV->hasInitializer())
756 printConstant(GV->getInitializer(), getID(GV));
758 toAsm << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
760 toAsm << "\t.type\t" << getID(GV) << ",#object\n";
761 toAsm << "\t.reserve\t" << getID(GV) << ","
762 << Target.findOptimalStorageSize(GV->getType()->getElementType())
768 void SparcModuleAsmPrinter::emitGlobalsAndConstants(const Module &M) {
769 // First, get the constants there were marked by the code generator for
770 // inclusion in the assembly code data area and fold them all into a
771 // single constant pool since there may be lots of duplicates. Also,
772 // lets force these constants into the slot table so that we can get
773 // unique names for unnamed constants also.
775 hash_set<const Constant*> moduleConstants;
776 FoldConstants(M, moduleConstants);
778 // Output constants spilled to memory
779 enterSection(AsmPrinter::ReadOnlyData);
780 for (hash_set<const Constant*>::const_iterator I = moduleConstants.begin(),
781 E = moduleConstants.end(); I != E; ++I)
784 // Output global variables...
785 for (Module::const_giterator GI = M.gbegin(), GE = M.gend(); GI != GE; ++GI) {
786 if (GI->hasInitializer() && GI->isConstant()) {
787 enterSection(AsmPrinter::ReadOnlyData); // read-only, initialized data
788 } else if (GI->hasInitializer() && !GI->isConstant()) { // read-write data
789 enterSection(AsmPrinter::ReadOnlyData); // read-only, initialized data
790 } else if (GI->hasInitializer() && !GI->isConstant()) { // read-write data
791 enterSection(AsmPrinter::InitRWData);
793 assert (!GI->hasInitializer() && "Unexpected global variable type found");
794 enterSection(AsmPrinter::UninitRWData); // Uninitialized data
796 printGlobalVariable(GI);
802 } // End anonymous namespace
804 Pass *UltraSparc::getModuleAsmPrinterPass(PassManager &PM, std::ostream &Out) {
805 return new SparcModuleAsmPrinter(Out, *this);