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 // The entry point of this file is the UltraSparc::emitAssembly method.
9 //===----------------------------------------------------------------------===//
11 #include "SparcInternals.h"
12 #include "llvm/Analysis/SlotCalculator.h"
13 #include "llvm/Transforms/Linker.h"
14 #include "llvm/CodeGen/MachineInstr.h"
15 #include "llvm/GlobalVariable.h"
16 #include "llvm/GlobalValue.h"
17 #include "llvm/ConstantVals.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/BasicBlock.h"
20 #include "llvm/Method.h"
21 #include "llvm/Module.h"
22 #include "Support/StringExtras.h"
23 #include "Support/HashExtras.h"
30 class SparcAsmPrinter {
31 typedef std::hash_map<const Value*, int> ValIdMap;
32 typedef ValIdMap:: iterator ValIdMapIterator;
33 typedef ValIdMap::const_iterator ValIdMapConstIterator;
36 SlotCalculator Table; // map anonymous values to unique integer IDs
37 ValIdMap valToIdMap; // used for values not handled by SlotCalculator
38 const UltraSparc &Target;
49 inline SparcAsmPrinter(std::ostream &o, const Module *M, const UltraSparc &t)
50 : toAsm(o), Table(SlotCalculator(M, true)), Target(t), CurSection(Unknown) {
55 void emitModule(const Module *M);
56 void emitMethod(const Method *M);
57 void emitGlobalsAndConstants(const Module* module);
58 //void processMethodArgument(const MethodArgument *MA);
59 void emitBasicBlock(const BasicBlock *BB);
60 void emitMachineInst(const MachineInstr *MI);
62 void printGlobalVariable( const GlobalVariable* GV);
63 void printSingleConstant( const Constant* CV);
64 void printConstantValueOnly(const Constant* CV);
65 void printConstant( const Constant* CV, std::string valID = "");
67 unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
68 void printOneOperand(const MachineOperand &Op);
70 bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
71 bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
73 // enterSection - Use this method to enter a different section of the output
74 // executable. This is used to only output neccesary section transitions.
76 void enterSection(enum Sections S) {
77 if (S == CurSection) return; // Only switch section if neccesary
80 toAsm << "\n\t.section ";
83 default: assert(0 && "Bad section name!");
84 case Text: toAsm << "\".text\""; break;
85 case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
86 case InitRWData: toAsm << "\".data\",#alloc,#write"; break;
87 case UninitRWData: toAsm << "\".bss\",#alloc,#write\nBbss.bss:"; break;
92 std::string getValidSymbolName(const string &S) {
95 // Symbol names in Sparc assembly language have these rules:
96 // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
97 // (b) A name beginning in "." is treated as a local name.
98 // (c) Names beginning with "_" are reserved by ANSI C and shd not be used.
100 if (S[0] == '_' || isdigit(S[0]))
103 for (unsigned i = 0; i < S.size(); ++i)
106 if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
111 Result += char('0' + ((unsigned char)C >> 4));
112 Result += char('0' + (C & 0xF));
118 // getID - Return a valid identifier for the specified value. Base it on
119 // the name of the identifier if possible, use a numbered value based on
120 // prefix otherwise. FPrefix is always prepended to the output identifier.
122 string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
124 string FP(FPrefix ? FPrefix : ""); // "Forced prefix"
126 Result = FP + V->getName();
128 int valId = Table.getValSlot(V);
130 ValIdMapConstIterator I = valToIdMap.find(V);
131 valId = (I == valToIdMap.end())? (valToIdMap[V] = valToIdMap.size())
134 Result = FP + string(Prefix) + itostr(valId);
136 return getValidSymbolName(Result);
139 // getID Wrappers - Ensure consistent usage...
140 string getID(const Module *M) {
141 return getID(M, "LLVMModule_");
143 string getID(const Method *M) {
144 return getID(M, "LLVMMethod_");
146 string getID(const BasicBlock *BB) {
147 return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
149 string getID(const GlobalVariable *GV) {
150 return getID(GV, "LLVMGlobal_", ".G_");
152 string getID(const Constant *CV) {
153 return getID(CV, "LLVMConst_", ".C_");
156 unsigned getOperandMask(unsigned Opcode) {
158 case SUBcc: return 1 << 3; // Remove CC argument
159 case BA: return 1 << 0; // Remove Arg #0, which is always null or xcc
160 default: return 0; // By default, don't hack operands...
166 // Can we treat the specified array as a string? Only if it is an array of
167 // ubytes or non-negative sbytes.
169 static bool isStringCompatible(ConstantArray *CPA) {
170 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
171 if (ETy == Type::UByteTy) return true;
172 if (ETy != Type::SByteTy) return false;
174 for (unsigned i = 0; i < CPA->getNumOperands(); ++i)
175 if (cast<ConstantSInt>(CPA->getOperand(i))->getValue() < 0)
181 // toOctal - Convert the low order bits of X into an octal letter
182 static inline char toOctal(int X) {
186 // getAsCString - Return the specified array as a C compatible string, only if
187 // the predicate isStringCompatible is true.
189 static string getAsCString(ConstantArray *CPA) {
190 if (isStringCompatible(CPA)) {
192 const Type *ETy = cast<ArrayType>(CPA->getType())->getElementType();
194 for (unsigned i = 0; i < CPA->getNumOperands(); ++i) {
195 unsigned char C = (ETy == Type::SByteTy) ?
196 (unsigned char)cast<ConstantSInt>(CPA->getOperand(i))->getValue() :
197 (unsigned char)cast<ConstantUInt>(CPA->getOperand(i))->getValue();
203 case '\a': Result += "\\a"; break;
204 case '\b': Result += "\\b"; break;
205 case '\f': Result += "\\f"; break;
206 case '\n': Result += "\\n"; break;
207 case '\r': Result += "\\r"; break;
208 case '\t': Result += "\\t"; break;
209 case '\v': Result += "\\v"; break;
212 Result += toOctal(C >> 6);
213 Result += toOctal(C >> 3);
214 Result += toOctal(C >> 0);
223 return CPA->getStrValue();
229 SparcAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
230 unsigned int opNum) {
231 switch (MI->getOpCode()) {
233 case JMPLRET: return (opNum == 0);
234 default: return false;
240 SparcAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
241 unsigned int opNum) {
242 if (Target.getInstrInfo().isLoad(MI->getOpCode()))
244 else if (Target.getInstrInfo().isStore(MI->getOpCode()))
251 #define PrintOp1PlusOp2(Op1, Op2) \
252 printOneOperand(Op1); \
254 printOneOperand(Op2);
257 SparcAsmPrinter::printOperands(const MachineInstr *MI,
260 const MachineOperand& Op = MI->getOperand(opNum);
262 if (OpIsBranchTargetLabel(MI, opNum))
264 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
267 else if (OpIsMemoryAddressBase(MI, opNum))
270 PrintOp1PlusOp2(Op, MI->getOperand(opNum+1));
283 SparcAsmPrinter::printOneOperand(const MachineOperand &op)
285 switch (op.getOperandType())
287 case MachineOperand::MO_VirtualRegister:
288 case MachineOperand::MO_CCRegister:
289 case MachineOperand::MO_MachineRegister:
291 int RegNum = (int)op.getAllocatedRegNum();
293 // ****this code is temporary till NULL Values are fixed
294 if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
295 toAsm << "<NULL VALUE>";
297 toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
302 case MachineOperand::MO_PCRelativeDisp:
304 const Value *Val = op.getVRegValue();
306 toAsm << "\t<*NULL Value*>";
307 else if (const BasicBlock *BB = dyn_cast<const BasicBlock>(Val))
309 else if (const Method *M = dyn_cast<const Method>(Val))
311 else if (const GlobalVariable *GV=dyn_cast<const GlobalVariable>(Val))
313 else if (const Constant *CV = dyn_cast<const Constant>(Val))
316 toAsm << "<unknown value=" << Val << ">";
320 case MachineOperand::MO_SignExtendedImmed:
321 case MachineOperand::MO_UnextendedImmed:
322 toAsm << (long)op.getImmedValue();
326 toAsm << op; // use dump field
333 SparcAsmPrinter::emitMachineInst(const MachineInstr *MI)
335 unsigned Opcode = MI->getOpCode();
337 if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
338 return; // IGNORE PHI NODES
340 toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
342 unsigned Mask = getOperandMask(Opcode);
344 bool NeedComma = false;
346 for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
347 if (! ((1 << OpNum) & Mask)) { // Ignore this operand?
348 if (NeedComma) toAsm << ", "; // Handle comma outputing
350 N = printOperands(MI, OpNum);
359 SparcAsmPrinter::emitBasicBlock(const BasicBlock *BB)
361 // Emit a label for the basic block
362 toAsm << getID(BB) << ":\n";
364 // Get the vector of machine instructions corresponding to this bb.
365 const MachineCodeForBasicBlock &MIs = BB->getMachineInstrVec();
366 MachineCodeForBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
368 // Loop over all of the instructions in the basic block...
369 for (; MII != MIE; ++MII)
370 emitMachineInst(*MII);
371 toAsm << "\n"; // Seperate BB's with newlines
375 SparcAsmPrinter::emitMethod(const Method *M)
377 if (M->isExternal()) return;
379 // Make sure the slot table has information about this method...
380 Table.incorporateMethod(M);
382 string methName = getID(M);
383 toAsm << "!****** Outputing Method: " << methName << " ******\n";
385 toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
386 //toAsm << "\t.type\t" << methName << ",#function\n";
387 toAsm << "\t.type\t" << methName << ", 2\n";
388 toAsm << methName << ":\n";
390 // Output code for all of the basic blocks in the method...
391 for (Method::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
394 // Output a .size directive so the debugger knows the extents of the function
395 toAsm << ".EndOf_" << methName << ":\n\t.size "
396 << methName << ", .EndOf_"
397 << methName << "-" << methName << "\n";
399 // Put some spaces between the methods
402 // Forget all about M.
407 ArrayTypeIsString(ArrayType* arrayType)
409 return (arrayType->getElementType() == Type::UByteTy ||
410 arrayType->getElementType() == Type::SByteTy);
414 TypeToDataDirective(const Type* type)
416 switch(type->getPrimitiveID())
418 case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
420 case Type::UShortTyID: case Type::ShortTyID:
422 case Type::UIntTyID: case Type::IntTyID:
424 case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
426 case Type::FloatTyID:
428 case Type::DoubleTyID:
430 case Type::ArrayTyID:
431 if (ArrayTypeIsString((ArrayType*) type))
434 return "<InvaliDataTypeForPrinting>";
436 return "<InvaliDataTypeForPrinting>";
440 // Get the size of the constant for the given target.
441 // If this is an unsized array, return 0.
444 ConstantToSize(const Constant* CV, const TargetMachine& target)
446 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
448 ArrayType *aty = cast<ArrayType>(CPA->getType());
449 if (ArrayTypeIsString(aty))
450 return 1 + CPA->getNumOperands();
453 return target.findOptimalStorageSize(CV->getType());
457 unsigned int TypeToSize(const Type* type, const TargetMachine& target)
459 return target.findOptimalStorageSize(type);
463 // Align data larger than one L1 cache line on L1 cache line boundaries.
464 // Align all smaller data on the next higher 2^x boundary (4, 8, ...).
467 SizeToAlignment(unsigned int size, const TargetMachine& target)
469 unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
470 if (size > (unsigned) cacheLineSize / 2)
471 return cacheLineSize;
473 for (unsigned sz=1; /*no condition*/; sz *= 2)
478 // Get the size of the type and then use SizeToAlignment.
481 TypeToAlignment(const Type* type, const TargetMachine& target)
483 return SizeToAlignment(target.findOptimalStorageSize(type), target);
486 // Get the size of the constant and then use SizeToAlignment.
487 // Handles strings as a special case;
489 ConstantToAlignment(const Constant* CV, const TargetMachine& target)
491 if (ConstantArray* CPA = dyn_cast<ConstantArray>(CV))
492 if (ArrayTypeIsString(cast<ArrayType>(CPA->getType())))
493 return SizeToAlignment(1 + CPA->getNumOperands(), target);
495 return TypeToAlignment(CV->getType(), target);
499 // Print a single constant value.
501 SparcAsmPrinter::printSingleConstant(const Constant* CV)
503 assert(CV->getType() != Type::VoidTy &&
504 CV->getType() != Type::TypeTy &&
505 CV->getType() != Type::LabelTy &&
506 "Unexpected type for Constant");
508 assert((! isa<ConstantArray>( CV) && ! isa<ConstantStruct>(CV))
509 && "Collective types should be handled outside this function");
512 << TypeToDataDirective(CV->getType()) << "\t";
514 if (CV->getType()->isPrimitiveType())
516 if (CV->getType() == Type::FloatTy || CV->getType() == Type::DoubleTy)
517 toAsm << "0r"; // FP constants must have this prefix
518 toAsm << CV->getStrValue() << "\n";
520 else if (ConstantPointer* CPP = dyn_cast<ConstantPointer>(CV))
522 assert(CPP->isNullValue() &&
523 "Cannot yet print non-null pointer constants to assembly");
526 else if (isa<ConstantPointerRef>(CV))
528 assert(0 && "Cannot yet initialize pointer refs in assembly");
532 assert(0 && "Unknown elementary type for constant");
536 // Print a constant value or values (it may be an aggregate).
537 // Uses printSingleConstant() to print each individual value.
539 SparcAsmPrinter::printConstantValueOnly(const Constant* CV)
541 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
543 if (CPA && isStringCompatible(CPA))
544 { // print the string alone and return
545 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
548 { // Not a string. Print the values in successive locations
549 const std::vector<Use> &constValues = CPA->getValues();
550 for (unsigned i=1; i < constValues.size(); i++)
551 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
553 else if (ConstantStruct *CPS = dyn_cast<ConstantStruct>(CV))
554 { // Print the fields in successive locations
555 const std::vector<Use>& constValues = CPS->getValues();
556 for (unsigned i=1; i < constValues.size(); i++)
557 this->printConstantValueOnly(cast<Constant>(constValues[i].get()));
560 this->printSingleConstant(CV);
563 // Print a constant (which may be an aggregate) prefixed by all the
564 // appropriate directives. Uses printConstantValueOnly() to print the
567 SparcAsmPrinter::printConstant(const Constant* CV, string valID)
569 if (valID.length() == 0)
572 toAsm << "\t.align\t" << ConstantToAlignment(CV, Target)
575 // Print .size and .type only if it is not a string.
576 ConstantArray *CPA = dyn_cast<ConstantArray>(CV);
577 if (CPA && isStringCompatible(CPA))
578 { // print it as a string and return
579 toAsm << valID << ":\n";
580 toAsm << "\t" << ".ascii" << "\t" << getAsCString(CPA) << "\n";
584 toAsm << "\t.type" << "\t" << valID << ",#object\n";
586 unsigned int constSize = ConstantToSize(CV, Target);
588 toAsm << "\t.size" << "\t" << valID << ","
589 << constSize << "\n";
591 toAsm << valID << ":\n";
593 this->printConstantValueOnly(CV);
598 SparcAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
600 toAsm << "\t.global\t" << getID(GV) << "\n";
602 if (GV->hasInitializer())
603 printConstant(GV->getInitializer(), getID(GV));
605 toAsm << "\t.align\t"
606 << TypeToAlignment(GV->getType()->getElementType(), Target) << "\n";
607 toAsm << "\t.type\t" << getID(GV) << ",#object\n";
608 toAsm << "\t.reserve\t" << getID(GV) << ","
609 << TypeToSize(GV->getType()->getElementType(), Target)
616 FoldConstants(const Module *M,
617 std::hash_set<const Constant*>& moduleConstants)
619 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
620 if (! (*I)->isExternal())
622 const std::hash_set<const Constant*>& pool =
623 MachineCodeForMethod::get(*I).getConstantPoolValues();
624 moduleConstants.insert(pool.begin(), pool.end());
630 SparcAsmPrinter::emitGlobalsAndConstants(const Module *M)
632 // First, get the constants there were marked by the code generator for
633 // inclusion in the assembly code data area and fold them all into a
634 // single constant pool since there may be lots of duplicates. Also,
635 // lets force these constants into the slot table so that we can get
636 // unique names for unnamed constants also.
638 std::hash_set<const Constant*> moduleConstants;
639 FoldConstants(M, moduleConstants);
641 // Now, emit the three data sections separately; the cost of I/O should
642 // make up for the cost of extra passes over the globals list!
644 // Read-only data section (implies initialized)
645 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
647 const GlobalVariable* GV = *GI;
648 if (GV->hasInitializer() && GV->isConstant())
650 if (GI == M->gbegin())
651 enterSection(ReadOnlyData);
652 printGlobalVariable(GV);
656 for (std::hash_set<const Constant*>::const_iterator
657 I = moduleConstants.begin(),
658 E = moduleConstants.end(); I != E; ++I)
661 // Initialized read-write data section
662 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
664 const GlobalVariable* GV = *GI;
665 if (GV->hasInitializer() && ! GV->isConstant())
667 if (GI == M->gbegin())
668 enterSection(InitRWData);
669 printGlobalVariable(GV);
673 // Uninitialized read-write data section
674 for (Module::const_giterator GI=M->gbegin(), GE=M->gend(); GI != GE; ++GI)
676 const GlobalVariable* GV = *GI;
677 if (! GV->hasInitializer())
679 if (GI == M->gbegin())
680 enterSection(UninitRWData);
681 printGlobalVariable(GV);
690 SparcAsmPrinter::emitModule(const Module *M)
692 // TODO: Look for a filename annotation on M to emit a .file directive
693 for (Module::const_iterator I = M->begin(), E = M->end(); I != E; ++I)
696 emitGlobalsAndConstants(M);
699 } // End anonymous namespace
703 // emitAssembly - Output assembly language code (a .s file) for the specified
704 // method. The specified method must have been compiled before this may be
708 UltraSparc::emitAssembly(const Module *M, std::ostream &toAsm) const
710 SparcAsmPrinter Print(toAsm, M, *this);