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/Annotation.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"
28 #include "Support/HashExtras.h"
34 class GlobalIdTable: public Annotation {
35 static AnnotationID AnnotId;
36 friend class AsmPrinter; // give access to AnnotId
38 typedef std::hash_map<const Value*, int> ValIdMap;
39 typedef ValIdMap::const_iterator ValIdMapConstIterator;
40 typedef ValIdMap:: iterator ValIdMapIterator;
42 SlotCalculator Table; // map anonymous values to unique integer IDs
43 ValIdMap valToIdMap; // used for values not handled by SlotCalculator
45 GlobalIdTable(Module* M) : Annotation(AnnotId), Table(M, true) {}
48 AnnotationID GlobalIdTable::AnnotId =
49 AnnotationManager::getID("ASM PRINTER GLOBAL TABLE ANNOT");
51 //===---------------------------------------------------------------------===//
52 // Code Shared By the two printer passes, as a mixin
53 //===---------------------------------------------------------------------===//
56 GlobalIdTable* idTable;
59 const TargetMachine &Target;
69 AsmPrinter(std::ostream &os, const TargetMachine &T)
70 : idTable(0), toAsm(os), Target(T), CurSection(Unknown) {}
72 // (start|end)(Module|Function) - Callback methods to be invoked by subclasses
73 void startModule(Module *M) {
74 // Create the global id table if it does not already exist
75 idTable = (GlobalIdTable*) M->getAnnotation(GlobalIdTable::AnnotId);
76 if (idTable == NULL) {
77 idTable = new GlobalIdTable(M);
78 M->addAnnotation(idTable);
81 void startFunction(Function *F) {
82 // Make sure the slot table has information about this function...
83 idTable->Table.incorporateFunction(F);
85 void endFunction(Function *F) {
86 idTable->Table.purgeFunction(); // Forget all about F
91 // Check if a name is external or accessible from external code.
92 // Only functions can currently be external. "main" is the only name
93 // that is visible externally.
94 bool isExternal(const Value* V) {
95 const Function *F = dyn_cast<Function>(V);
96 return F && (F->isExternal() || F->getName() == "main");
99 // enterSection - Use this method to enter a different section of the output
100 // executable. This is used to only output neccesary section transitions.
102 void enterSection(enum Sections S) {
103 if (S == CurSection) return; // Only switch section if neccesary
106 toAsm << "\n\t.section ";
109 default: assert(0 && "Bad section name!");
110 case Text: toAsm << "\".text\""; break;
111 case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
112 case InitRWData: toAsm << "\".data\",#alloc,#write"; break;
113 case UninitRWData: toAsm << "\".bss\",#alloc,#write\nBbss.bss:"; break;
118 static std::string getValidSymbolName(const string &S) {
121 // Symbol names in Sparc assembly language have these rules:
122 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
123 // (b) A name beginning in "." is treated as a local name.
124 // (c) Names beginning with "_" are reserved by ANSI C and shd not be used.
126 if (S[0] == '_' || isdigit(S[0]))
129 for (unsigned i = 0; i < S.size(); ++i)
132 if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
137 Result += char('0' + ((unsigned char)C >> 4));
138 Result += char('0' + (C & 0xF));
144 // getID - Return a valid identifier for the specified value. Base it on
145 // the name of the identifier if possible (qualified by the type), and
146 // use a numbered value based on prefix otherwise.
147 // FPrefix is always prepended to the output identifier.
149 string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
150 string Result = FPrefix ? FPrefix : ""; // "Forced prefix"
152 Result = Result + (V->hasName()? V->getName() : string(Prefix));
154 // Qualify all internal names with a unique id.
155 if (!isExternal(V)) {
156 int valId = idTable->Table.getValSlot(V);
158 GlobalIdTable::ValIdMapConstIterator I = idTable->valToIdMap.find(V);
159 if (I == idTable->valToIdMap.end())
160 valId = idTable->valToIdMap[V] = idTable->valToIdMap.size();
164 Result = Result + "_" + itostr(valId);
167 return getValidSymbolName(Result);
170 // getID Wrappers - Ensure consistent usage...
171 string getID(const Function *F) {
172 return getID(F, "LLVMFunction_");
174 string getID(const BasicBlock *BB) {
175 return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
177 string getID(const GlobalVariable *GV) {
178 return getID(GV, "LLVMGlobal_", ".G_");
180 string getID(const Constant *CV) {
181 return getID(CV, "LLVMConst_", ".C_");
187 //===----------------------------------------------------------------------===//
188 // SparcFunctionAsmPrinter Code
189 //===----------------------------------------------------------------------===//
191 struct SparcFunctionAsmPrinter : public FunctionPass, public AsmPrinter {
192 inline SparcFunctionAsmPrinter(std::ostream &os, const TargetMachine &t)
193 : AsmPrinter(os, t) {}
195 virtual bool doInitialization(Module *M) {
200 virtual bool runOnFunction(Function *F) {
207 virtual bool doFinalization(Module *M) {
212 void emitFunction(const Function *F);
214 void emitBasicBlock(const BasicBlock *BB);
215 void emitMachineInst(const MachineInstr *MI);
217 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
218 void printOneOperand(const MachineOperand &Op);
220 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
221 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
223 unsigned getOperandMask(unsigned Opcode) {
225 case SUBcc: return 1 << 3; // Remove CC argument
226 case BA: return 1 << 0; // Remove Arg #0, which is always null or xcc
227 default: return 0; // By default, don't hack operands...
233 SparcFunctionAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
234 unsigned int opNum) {
235 switch (MI->getOpCode()) {
237 case JMPLRET: return (opNum == 0);
238 default: return false;
244 SparcFunctionAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
245 unsigned int opNum) {
246 if (Target.getInstrInfo().isLoad(MI->getOpCode()))
248 else if (Target.getInstrInfo().isStore(MI->getOpCode()))
255 #define PrintOp1PlusOp2(Op1, Op2) \
256 printOneOperand(Op1); \
258 printOneOperand(Op2);
261 SparcFunctionAsmPrinter::printOperands(const MachineInstr *MI,
264 const MachineOperand& Op = MI->getOperand(opNum);
266 if (OpIsBranchTargetLabel(MI, opNum))
268 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
271 else if (OpIsMemoryAddressBase(MI, opNum))
274 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
287 SparcFunctionAsmPrinter::printOneOperand(const MachineOperand &op)
289 switch (op.getOperandType())
291 case MachineOperand::MO_VirtualRegister:
292 case MachineOperand::MO_CCRegister:
293 case MachineOperand::MO_MachineRegister:
295 int RegNum = (int)op.getAllocatedRegNum();
297 // better to print code with NULL registers than to die
298 if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
299 toAsm << "<NULL VALUE>";
301 toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
306 case MachineOperand::MO_PCRelativeDisp:
308 const Value *Val = op.getVRegValue();
310 toAsm << "\t<*NULL Value*>";
311 else if (const BasicBlock *BB = dyn_cast<BasicBlock>(Val))
313 else if (const Function *M = dyn_cast<Function>(Val))
315 else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
317 else if (const Constant *CV = dyn_cast<Constant>(Val))
320 toAsm << "<unknown value=" << Val << ">";
324 case MachineOperand::MO_SignExtendedImmed:
325 case MachineOperand::MO_UnextendedImmed:
326 toAsm << (long)op.getImmedValue();
330 toAsm << op; // use dump field
337 SparcFunctionAsmPrinter::emitMachineInst(const MachineInstr *MI)
339 unsigned Opcode = MI->getOpCode();
341 if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
342 return; // IGNORE PHI NODES
344 toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
346 unsigned Mask = getOperandMask(Opcode);
348 bool NeedComma = false;
350 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
351 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
352 if (NeedComma) toAsm << ", "; // Handle comma outputing
354 N = printOperands(MI, OpNum);
363 SparcFunctionAsmPrinter::emitBasicBlock(const BasicBlock *BB)
365 // Emit a label for the basic block
366 toAsm << getID(BB) << ":\n";
368 // Get the vector of machine instructions corresponding to this bb.
369 const MachineCodeForBasicBlock &MIs = BB->getMachineInstrVec();
370 MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
372 // Loop over all of the instructions in the basic block...
373 for (; MII != MIE; ++MII)
374 emitMachineInst(*MII);
375 toAsm << "\n"; // Seperate BB's with newlines
379 SparcFunctionAsmPrinter::emitFunction(const Function *M)
381 string methName = getID(M);
382 toAsm << "!****** Outputing Function: " << methName << " ******\n";
383 enterSection(AsmPrinter::Text);
384 toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
385 //toAsm << "\t.type\t" << methName << ",#function\n";
386 toAsm << "\t.type\t" << methName << ", 2\n";
387 toAsm << methName << ":\n";
389 // Output code for all of the basic blocks in the function...
390 for (Function::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
393 // Output a .size directive so the debugger knows the extents of the function
394 toAsm << ".EndOf_" << methName << ":\n\t.size "
395 << methName << ", .EndOf_"
396 << methName << "-" << methName << "\n";
398 // Put some spaces between the functions
402 } // End anonymous namespace
404 Pass *UltraSparc::getFunctionAsmPrinterPass(PassManager &PM, std::ostream &Out){
405 return new SparcFunctionAsmPrinter(Out, *this);
412 //===----------------------------------------------------------------------===//
413 // SparcFunctionAsmPrinter Code
414 //===----------------------------------------------------------------------===//
418 class SparcModuleAsmPrinter : public Pass, public AsmPrinter {
420 SparcModuleAsmPrinter(std::ostream &os, TargetMachine &t)
421 : AsmPrinter(os, t) {}
423 virtual bool run(Module *M) {
425 emitGlobalsAndConstants(M);
430 void emitGlobalsAndConstants(const Module *M);
432 void printGlobalVariable(const GlobalVariable *GV);
433 void printSingleConstant( const Constant* CV);
434 void printConstantValueOnly(const Constant* CV);
435 void printConstant( const Constant* CV, std::string valID = "");
437 static void FoldConstants(const Module *M,
438 std::hash_set<const Constant*> &moduleConstants);
443 // Can we treat the specified array as a string? Only if it is an array of
444 // ubytes or non-negative sbytes.
446 static bool isStringCompatible(ConstantArray *CPA) {
447 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
448 if (ETy == Type::UByteTy) return true;
449 if (ETy != Type::SByteTy) return false;
451 for (unsigned i = 0; i < CPA->getNumOperands(); ++i)
452 if (cast<ConstantSInt>(CPA->getOperand(i))->getValue() < 0)
458 // toOctal - Convert the low order bits of X into an octal letter
459 static inline char toOctal(int X) {
463 // getAsCString - Return the specified array as a C compatible string, only if
464 // the predicate isStringCompatible is true.
466 static string getAsCString(ConstantArray *CPA) {
467 assert(isStringCompatible(CPA) && "Array is not string compatible!");
470 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
472 for (unsigned i = 0; i < CPA->getNumOperands(); ++i) {
473 unsigned char C = (ETy == Type::SByteTy) ?
474 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
475 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
481 case '\a': Result += "\\a"; break;
482 case '\b': Result += "\\b"; break;
483 case '\f': Result += "\\f"; break;
484 case '\n': Result += "\\n"; break;
485 case '\r': Result += "\\r"; break;
486 case '\t': Result += "\\t"; break;
487 case '\v': Result += "\\v"; break;
490 Result += toOctal(C >> 6);
491 Result += toOctal(C >> 3);
492 Result += toOctal(C >> 0);
503 ArrayTypeIsString(ArrayType* arrayType)
505 return (arrayType->getElementType() == Type::UByteTy ||
506 arrayType->getElementType() == Type::SByteTy);
510 TypeToDataDirective(const Type* type)
512 switch(type->getPrimitiveID())
514 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
516 case Type::UShortTyID: case Type::ShortTyID:
518 case Type::UIntTyID: case Type::IntTyID:
520 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
522 case Type::FloatTyID:
524 case Type::DoubleTyID:
526 case Type::ArrayTyID:
527 if (ArrayTypeIsString((ArrayType*) type))
530 return "<InvaliDataTypeForPrinting>";
532 return "<InvaliDataTypeForPrinting>";
536 // Get the size of the constant for the given target.
537 // If this is an unsized array, return 0.
540 ConstantToSize(const Constant* CV, const TargetMachine& target)
542 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
544 ArrayType *aty = cast<ArrayType>(CPA->getType());
545 if (ArrayTypeIsString(aty))
546 return 1 + CPA->getNumOperands();
549 return target.findOptimalStorageSize(CV->getType());
554 // Align data larger than one L1 cache line on L1 cache line boundaries.
555 // Align all smaller data on the next higher 2^x boundary (4, 8, ...).
558 SizeToAlignment(unsigned int size, const TargetMachine& target)
560 unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
561 if (size > (unsigned) cacheLineSize / 2)
562 return cacheLineSize;
564 for (unsigned sz=1; /*no condition*/; sz *= 2)
569 // Get the size of the type and then use SizeToAlignment.
572 TypeToAlignment(const Type* type, const TargetMachine& target)
574 return SizeToAlignment(target.findOptimalStorageSize(type), target);
577 // Get the size of the constant and then use SizeToAlignment.
578 // Handles strings as a special case;
580 ConstantToAlignment(const Constant* CV, const TargetMachine& target)
582 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
583 if (ArrayTypeIsString(cast<ArrayType>(CPA->getType())))
584 return SizeToAlignment(1 + CPA->getNumOperands(), target);
586 return TypeToAlignment(CV->getType(), target);
590 // Print a single constant value.
592 SparcModuleAsmPrinter::printSingleConstant(const Constant* CV)
594 assert(CV->getType() != Type::VoidTy &&
595 CV->getType() != Type::TypeTy &&
596 CV->getType() != Type::LabelTy &&
597 "Unexpected type for Constant");
599 assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
600 && "Aggregate types should be handled outside this function");
602 toAsm << "\t" << TypeToDataDirective(CV->getType()) << "\t";
604 if (CV->getType()->isPrimitiveType())
606 if (CV->getType()->isFloatingPoint()) {
607 // FP Constants are printed as integer constants to avoid losing
609 double Val = cast<ConstantFP>(CV)->getValue();
610 if (CV->getType() == Type::FloatTy) {
611 float FVal = (float)Val;
612 char *ProxyPtr = (char*)&FVal; // Abide by C TBAA rules
613 toAsm << *(unsigned int*)ProxyPtr;
614 } else if (CV->getType() == Type::DoubleTy) {
615 char *ProxyPtr = (char*)&Val; // Abide by C TBAA rules
616 toAsm << *(uint64_t*)ProxyPtr;
618 assert(0 && "Unknown floating point type!");
621 toAsm << "\t! " << CV->getType()->getDescription()
622 << " value: " << Val << "\n";
624 WriteAsOperand(toAsm, CV, false, false) << "\n";
627 else if (ConstantPointer* CPP = dyn_cast<ConstantPointer>(CV))
629 assert(CPP->isNullValue() &&
630 "Cannot yet print non-null pointer constants to assembly");
633 else if (isa<ConstantPointerRef>(CV))
635 assert(0 && "Cannot yet initialize pointer refs in assembly");
639 assert(0 && "Unknown elementary type for constant");
643 // Print a constant value or values (it may be an aggregate).
644 // Uses printSingleConstant() to print each individual value.
646 SparcModuleAsmPrinter::printConstantValueOnly(const Constant* CV)
648 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
650 if (CPA && isStringCompatible(CPA))
651 { // print the string alone and return
652 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
655 { // Not a string. Print the values in successive locations
656 const std::vector<Use> &constValues = CPA->getValues();
657 for (unsigned i=1; i < constValues.size(); i++)
658 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
660 else if (ConstantStruct *CPS = dyn_cast<ConstantStruct>(CV))
661 { // Print the fields in successive locations
662 const std::vector<Use>& constValues = CPS->getValues();
663 for (unsigned i=1; i < constValues.size(); i++)
664 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
667 this->printSingleConstant(CV);
670 // Print a constant (which may be an aggregate) prefixed by all the
671 // appropriate directives. Uses printConstantValueOnly() to print the
674 SparcModuleAsmPrinter::printConstant(const Constant* CV, string valID)
676 if (valID.length() == 0)
679 toAsm << "\t.align\t" << ConstantToAlignment(CV, Target) << "\n";
681 // Print .size and .type only if it is not a string.
682 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
683 if (CPA && isStringCompatible(CPA))
684 { // print it as a string and return
685 toAsm << valID << ":\n";
686 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
690 toAsm << "\t.type" << "\t" << valID << ",#object\n";
692 unsigned int constSize = ConstantToSize(CV, Target);
694 toAsm << "\t.size" << "\t" << valID << "," << constSize << "\n";
696 toAsm << valID << ":\n";
698 printConstantValueOnly(CV);
702 void SparcModuleAsmPrinter::FoldConstants(const Module *M,
703 std::hash_set<const Constant*> &MC) {
704 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
705 if (!(*I)->isExternal()) {
706 const std::hash_set<const Constant*> &pool =
707 MachineCodeForMethod::get(*I).getConstantPoolValues();
708 MC.insert(pool.begin(), pool.end());
712 void SparcModuleAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
714 toAsm << "\t.global\t" << getID(GV) << "\n";
716 if (GV->hasInitializer())
717 printConstant(GV->getInitializer(), getID(GV));
719 toAsm << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
721 toAsm << "\t.type\t" << getID(GV) << ",#object\n";
722 toAsm << "\t.reserve\t" << getID(GV) << ","
723 << Target.findOptimalStorageSize(GV->getType()->getElementType())
729 void SparcModuleAsmPrinter::emitGlobalsAndConstants(const Module *M) {
730 // First, get the constants there were marked by the code generator for
731 // inclusion in the assembly code data area and fold them all into a
732 // single constant pool since there may be lots of duplicates. Also,
733 // lets force these constants into the slot table so that we can get
734 // unique names for unnamed constants also.
736 std::hash_set<const Constant*> moduleConstants;
737 FoldConstants(M, moduleConstants);
739 // Now, emit the three data sections separately; the cost of I/O should
740 // make up for the cost of extra passes over the globals list!
742 // Section 1 : Read-only data section (implies initialized)
743 enterSection(AsmPrinter::ReadOnlyData);
744 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
745 if ((*GI)->hasInitializer() && (*GI)->isConstant())
746 printGlobalVariable(*GI);
748 for (std::hash_set<const Constant*>::const_iterator
749 I = moduleConstants.begin(),
750 E = moduleConstants.end(); I != E; ++I)
753 // Section 2 : Initialized read-write data section
754 enterSection(AsmPrinter::InitRWData);
755 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
756 if ((*GI)->hasInitializer() && ! (*GI)->isConstant())
757 printGlobalVariable(*GI);
759 // Section 3 : Uninitialized read-write data section
760 enterSection(AsmPrinter::UninitRWData);
761 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
762 if (! (*GI)->hasInitializer())
763 printGlobalVariable(*GI);
768 } // End anonymous namespace
770 Pass *UltraSparc::getModuleAsmPrinterPass(PassManager &PM, std::ostream &Out) {
771 return new SparcModuleAsmPrinter(Out, *this);