lib/Target/SparcV9/SparcV9AsmPrinter.cpp

   1 //===-- EmitAssembly.cpp - Emit Sparc Specific .s File ---------------------==//
   2 //
   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.
   6 //
   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.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "SparcInternals.h"
  15 #include "llvm/CodeGen/MachineInstr.h"
  16 #include "llvm/CodeGen/MachineBasicBlock.h"
  17 #include "llvm/CodeGen/MachineFunction.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Module.h"
  21 #include "llvm/SlotCalculator.h"
  22 #include "llvm/Pass.h"
  23 #include "llvm/Assembly/Writer.h"
  24 #include "Support/StringExtras.h"
  25 using std::string;
  26
  27 namespace {
  28
  29 class GlobalIdTable: public Annotation {
  30   static AnnotationID AnnotId;
  31   friend class AsmPrinter;              // give access to AnnotId
  32
  33   typedef hash_map<const Value*, int> ValIdMap;
  34   typedef ValIdMap::const_iterator ValIdMapConstIterator;
  35   typedef ValIdMap::      iterator ValIdMapIterator;
  36 public:
  37   SlotCalculator Table;    // map anonymous values to unique integer IDs
  38   ValIdMap valToIdMap;     // used for values not handled by SlotCalculator
  39
  40   GlobalIdTable(Module* M) : Annotation(AnnotId), Table(M, true) {}
  41 };
  42
  43 AnnotationID GlobalIdTable::AnnotId =
  44   AnnotationManager::getID("ASM PRINTER GLOBAL TABLE ANNOT");
  45
  46 //===---------------------------------------------------------------------===//
  47 //   Code Shared By the two printer passes, as a mixin
  48 //===---------------------------------------------------------------------===//
  49
  50 class AsmPrinter {
  51   GlobalIdTable* idTable;
  52 public:
  53   std::ostream &toAsm;
  54   const TargetMachine &Target;
  55
  56   enum Sections {
  57     Unknown,
  58     Text,
  59     ReadOnlyData,
  60     InitRWData,
  61     ZeroInitRWData,
  62   } CurSection;
  63
  64   AsmPrinter(std::ostream &os, const TargetMachine &T)
  65     : idTable(0), toAsm(os), Target(T), CurSection(Unknown) {}
  66
  67   // (start|end)(Module|Function) - Callback methods to be invoked by subclasses
  68   void startModule(Module &M) {
  69     // Create the global id table if it does not already exist
  70     idTable = (GlobalIdTable*)M.getAnnotation(GlobalIdTable::AnnotId);
  71     if (idTable == NULL) {
  72       idTable = new GlobalIdTable(&M);
  73       M.addAnnotation(idTable);
  74     }
  75   }
  76   void startFunction(Function &F) {
  77     // Make sure the slot table has information about this function...
  78     idTable->Table.incorporateFunction(&F);
  79   }
  80   void endFunction(Function &) {
  81     idTable->Table.purgeFunction();  // Forget all about F
  82   }
  83   void endModule() {
  84   }
  85
  86   // Check if a value is external or accessible from external code.
  87   bool isExternal(const Value* V) {
  88     const GlobalValue *GV = dyn_cast<GlobalValue>(V);
  89     return GV && GV->hasExternalLinkage();
  90   }
  91
  92   // enterSection - Use this method to enter a different section of the output
  93   // executable.  This is used to only output neccesary section transitions.
  94   //
  95   void enterSection(enum Sections S) {
  96     if (S == CurSection) return;        // Only switch section if neccesary
  97     CurSection = S;
  98
  99     toAsm << "\n\t.section ";
 100     switch (S)
 101       {
 102       default: assert(0 && "Bad section name!");
 103       case Text:         toAsm << "\".text\""; break;
 104       case ReadOnlyData: toAsm << "\".rodata\",#alloc"; break;
 105       case InitRWData:   toAsm << "\".data\",#alloc,#write"; break;
 106       case ZeroInitRWData: toAsm << "\".bss\",#alloc,#write"; break;
 107       }
 108     toAsm << "\n";
 109   }
 110
 111   static string getValidSymbolName(const string &S) {
 112     string Result;
 113
 114     // Symbol names in Sparc assembly language have these rules:
 115     // (a) Must match { letter | _ | . | $ } { letter | _ | . | $ | digit }*
 116     // (b) A name beginning in "." is treated as a local name.
 117     //
 118     if (isdigit(S[0]))
 119       Result = "ll";
 120
 121     for (unsigned i = 0; i < S.size(); ++i)
 122       {
 123         char C = S[i];
 124         if (C == '_' || C == '.' || C == '$' || isalpha(C) || isdigit(C))
 125           Result += C;
 126         else
 127           {
 128             Result += '_';
 129             Result += char('0' + ((unsigned char)C >> 4));
 130             Result += char('0' + (C & 0xF));
 131           }
 132       }
 133     return Result;
 134   }
 135
 136   // getID - Return a valid identifier for the specified value.  Base it on
 137   // the name of the identifier if possible (qualified by the type), and
 138   // use a numbered value based on prefix otherwise.
 139   // FPrefix is always prepended to the output identifier.
 140   //
 141   string getID(const Value *V, const char *Prefix, const char *FPrefix = 0) {
 142     string Result = FPrefix ? FPrefix : "";  // "Forced prefix"
 143
 144     Result +=  V->hasName() ? V->getName() : string(Prefix);
 145
 146     // Qualify all internal names with a unique id.
 147     if (!isExternal(V)) {
 148       int valId = idTable->Table.getValSlot(V);
 149       if (valId == -1) {
 150         GlobalIdTable::ValIdMapConstIterator I = idTable->valToIdMap.find(V);
 151         if (I == idTable->valToIdMap.end())
 152           valId = idTable->valToIdMap[V] = idTable->valToIdMap.size();
 153         else
 154           valId = I->second;
 155       }
 156       Result = Result + "_" + itostr(valId);
 157     }
 158
 159     return getValidSymbolName(Result);
 160   }
 161
 162   // getID Wrappers - Ensure consistent usage...
 163   string getID(const Function *F) {
 164     return getID(F, "LLVMFunction_");
 165   }
 166   string getID(const BasicBlock *BB) {
 167     return getID(BB, "LL", (".L_"+getID(BB->getParent())+"_").c_str());
 168   }
 169   string getID(const GlobalVariable *GV) {
 170     return getID(GV, "LLVMGlobal_");
 171   }
 172   string getID(const Constant *CV) {
 173     return getID(CV, "LLVMConst_", ".C_");
 174   }
 175   string getID(const GlobalValue *GV) {
 176     if (const GlobalVariable *V = dyn_cast<GlobalVariable>(GV))
 177       return getID(V);
 178     else if (const Function *F = dyn_cast<Function>(GV))
 179       return getID(F);
 180     assert(0 && "Unexpected type of GlobalValue!");
 181     return "";
 182   }
 183
 184   // ConstantExprToString() - Convert a ConstantExpr to an asm expression
 185   // and return this as a string.
 186   string ConstantExprToString(const ConstantExpr* CE,
 187                               const TargetMachine& target) {
 188     string S;
 189     switch(CE->getOpcode()) {
 190     case Instruction::GetElementPtr:
 191       { // generate a symbolic expression for the byte address
 192         const Value* ptrVal = CE->getOperand(0);
 193         std::vector<Value*> idxVec(CE->op_begin()+1, CE->op_end());
 194         S += "(" + valToExprString(ptrVal, target) + ") + ("
 195           + utostr(target.DataLayout.getIndexedOffset(ptrVal->getType(),idxVec))
 196           + ")";
 197         break;
 198       }
 199
 200     case Instruction::Cast:
 201       // Support only non-converting casts for now, i.e., a no-op.
 202       // This assertion is not a complete check.
 203       assert(target.DataLayout.getTypeSize(CE->getType()) ==
 204              target.DataLayout.getTypeSize(CE->getOperand(0)->getType()));
 205       S += "(" + valToExprString(CE->getOperand(0), target) + ")";
 206       break;
 207
 208     case Instruction::Add:
 209       S += "(" + valToExprString(CE->getOperand(0), target) + ") + ("
 210                + valToExprString(CE->getOperand(1), target) + ")";
 211       break;
 212
 213     default:
 214       assert(0 && "Unsupported operator in ConstantExprToString()");
 215       break;
 216     }
 217
 218     return S;
 219   }
 220
 221   // valToExprString - Helper function for ConstantExprToString().
 222   // Appends result to argument string S.
 223   //
 224   string valToExprString(const Value* V, const TargetMachine& target) {
 225     string S;
 226     bool failed = false;
 227     if (const Constant* CV = dyn_cast<Constant>(V)) { // symbolic or known
 228
 229       if (const ConstantBool *CB = dyn_cast<ConstantBool>(CV))
 230         S += string(CB == ConstantBool::True ? "1" : "0");
 231       else if (const ConstantSInt *CI = dyn_cast<ConstantSInt>(CV))
 232         S += itostr(CI->getValue());
 233       else if (const ConstantUInt *CI = dyn_cast<ConstantUInt>(CV))
 234         S += utostr(CI->getValue());
 235       else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV))
 236         S += ftostr(CFP->getValue());
 237       else if (isa<ConstantPointerNull>(CV))
 238         S += "0";
 239       else if (const ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(CV))
 240         S += valToExprString(CPR->getValue(), target);
 241       else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV))
 242         S += ConstantExprToString(CE, target);
 243       else
 244         failed = true;
 245
 246     } else if (const GlobalValue* GV = dyn_cast<GlobalValue>(V)) {
 247       S += getID(GV);
 248     }
 249     else
 250       failed = true;
 251
 252     if (failed) {
 253       assert(0 && "Cannot convert value to string");
 254       S += "<illegal-value>";
 255     }
 256     return S;
 257   }
 258
 259 };
 260
 261
 262
 263 //===----------------------------------------------------------------------===//
 264 //   SparcFunctionAsmPrinter Code
 265 //===----------------------------------------------------------------------===//
 266
 267 struct SparcFunctionAsmPrinter : public FunctionPass, public AsmPrinter {
 268   inline SparcFunctionAsmPrinter(std::ostream &os, const TargetMachine &t)
 269     : AsmPrinter(os, t) {}
 270
 271   const char *getPassName() const {
 272     return "Output Sparc Assembly for Functions";
 273   }
 274
 275   virtual bool doInitialization(Module &M) {
 276     startModule(M);
 277     return false;
 278   }
 279
 280   virtual bool runOnFunction(Function &F) {
 281     startFunction(F);
 282     emitFunction(F);
 283     endFunction(F);
 284     return false;
 285   }
 286
 287   virtual bool doFinalization(Module &M) {
 288     endModule();
 289     return false;
 290   }
 291
 292   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 293     AU.setPreservesAll();
 294   }
 295
 296   void emitFunction(const Function &F);
 297 private :
 298   void emitBasicBlock(const BasicBlock *BB);
 299   void emitMachineInst(const MachineInstr *MI);
 300
 301   unsigned int printOperands(const MachineInstr *MI, unsigned int opNum);
 302   void printOneOperand(const MachineOperand &Op);
 303
 304   bool OpIsBranchTargetLabel(const MachineInstr *MI, unsigned int opNum);
 305   bool OpIsMemoryAddressBase(const MachineInstr *MI, unsigned int opNum);
 306
 307   unsigned getOperandMask(unsigned Opcode) {
 308     switch (Opcode) {
 309     case SUBcc:   return 1 << 3;  // Remove CC argument
 310   //case BA:      return 1 << 0;  // Remove Arg #0, which is always null or xcc
 311     default:      return 0;       // By default, don't hack operands...
 312     }
 313   }
 314 };
 315
 316 inline bool
 317 SparcFunctionAsmPrinter::OpIsBranchTargetLabel(const MachineInstr *MI,
 318                                                unsigned int opNum) {
 319   switch (MI->getOpCode()) {
 320   case JMPLCALL:
 321   case JMPLRET: return (opNum == 0);
 322   default:      return false;
 323   }
 324 }
 325
 326
 327 inline bool
 328 SparcFunctionAsmPrinter::OpIsMemoryAddressBase(const MachineInstr *MI,
 329                                                unsigned int opNum) {
 330   if (Target.getInstrInfo().isLoad(MI->getOpCode()))
 331     return (opNum == 0);
 332   else if (Target.getInstrInfo().isStore(MI->getOpCode()))
 333     return (opNum == 1);
 334   else
 335     return false;
 336 }
 337
 338
 339 #define PrintOp1PlusOp2(mop1, mop2) \
 340   printOneOperand(mop1); \
 341   toAsm << "+"; \
 342   printOneOperand(mop2);
 343
 344 unsigned int
 345 SparcFunctionAsmPrinter::printOperands(const MachineInstr *MI,
 346                                unsigned int opNum)
 347 {
 348   const MachineOperand& mop = MI->getOperand(opNum);
 349
 350   if (OpIsBranchTargetLabel(MI, opNum))
 351     {
 352       PrintOp1PlusOp2(mop, MI->getOperand(opNum+1));
 353       return 2;
 354     }
 355   else if (OpIsMemoryAddressBase(MI, opNum))
 356     {
 357       toAsm << "[";
 358       PrintOp1PlusOp2(mop, MI->getOperand(opNum+1));
 359       toAsm << "]";
 360       return 2;
 361     }
 362   else
 363     {
 364       printOneOperand(mop);
 365       return 1;
 366     }
 367 }
 368
 369
 370 void
 371 SparcFunctionAsmPrinter::printOneOperand(const MachineOperand &mop)
 372 {
 373   bool needBitsFlag = true;
 374
 375   if (mop.opHiBits32())
 376     toAsm << "%lm(";
 377   else if (mop.opLoBits32())
 378     toAsm << "%lo(";
 379   else if (mop.opHiBits64())
 380     toAsm << "%hh(";
 381   else if (mop.opLoBits64())
 382     toAsm << "%hm(";
 383   else
 384     needBitsFlag = false;
 385
 386   switch (mop.getOperandType())
 387     {
 388     case MachineOperand::MO_VirtualRegister:
 389     case MachineOperand::MO_CCRegister:
 390     case MachineOperand::MO_MachineRegister:
 391       {
 392         int RegNum = (int)mop.getAllocatedRegNum();
 393
 394         // better to print code with NULL registers than to die
 395         if (RegNum == Target.getRegInfo().getInvalidRegNum()) {
 396           toAsm << "<NULL VALUE>";
 397         } else {
 398           toAsm << "%" << Target.getRegInfo().getUnifiedRegName(RegNum);
 399         }
 400         break;
 401       }
 402
 403     case MachineOperand::MO_PCRelativeDisp:
 404       {
 405         const Value *Val = mop.getVRegValue();
 406         assert(Val && "\tNULL Value in SparcFunctionAsmPrinter");
 407
 408         if (const BasicBlock *BB = dyn_cast<const BasicBlock>(Val))
 409           toAsm << getID(BB);
 410         else if (const Function *M = dyn_cast<Function>(Val))
 411           toAsm << getID(M);
 412         else if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(Val))
 413           toAsm << getID(GV);
 414         else if (const Constant *CV = dyn_cast<Constant>(Val))
 415           toAsm << getID(CV);
 416         else
 417           assert(0 && "Unrecognized value in SparcFunctionAsmPrinter");
 418         break;
 419       }
 420
 421     case MachineOperand::MO_SignExtendedImmed:
 422       toAsm << mop.getImmedValue();
 423       break;
 424
 425     case MachineOperand::MO_UnextendedImmed:
 426       toAsm << (uint64_t) mop.getImmedValue();
 427       break;
 428
 429     default:
 430       toAsm << mop;      // use dump field
 431       break;
 432     }
 433
 434   if (needBitsFlag)
 435     toAsm << ")";
 436 }
 437
 438
 439 void
 440 SparcFunctionAsmPrinter::emitMachineInst(const MachineInstr *MI)
 441 {
 442   unsigned Opcode = MI->getOpCode();
 443
 444   if (TargetInstrDescriptors[Opcode].iclass & M_DUMMY_PHI_FLAG)
 445     return;  // IGNORE PHI NODES
 446
 447   toAsm << "\t" << TargetInstrDescriptors[Opcode].opCodeString << "\t";
 448
 449   unsigned Mask = getOperandMask(Opcode);
 450
 451   bool NeedComma = false;
 452   unsigned N = 1;
 453   for (unsigned OpNum = 0; OpNum < MI->getNumOperands(); OpNum += N)
 454     if (! ((1 << OpNum) & Mask)) {        // Ignore this operand?
 455       if (NeedComma) toAsm << ", ";         // Handle comma outputing
 456       NeedComma = true;
 457       N = printOperands(MI, OpNum);
 458     }
 459   else
 460     N = 1;
 461
 462   toAsm << "\n";
 463 }
 464
 465 void
 466 SparcFunctionAsmPrinter::emitBasicBlock(const BasicBlock *BB)
 467 {
 468   // Emit a label for the basic block
 469   toAsm << getID(BB) << ":\n";
 470
 471   // Get the vector of machine instructions corresponding to this bb.
 472   const MachineBasicBlock &MIs = MachineBasicBlock::get(BB);
 473
 474   // Loop over all of the instructions in the basic block...
 475   for (MachineBasicBlock::const_iterator MII = MIs.begin(), MIE = MIs.end();
 476        MII != MIE; ++MII)
 477     emitMachineInst(*MII);
 478   toAsm << "\n";  // Seperate BB's with newlines
 479 }
 480
 481 void
 482 SparcFunctionAsmPrinter::emitFunction(const Function &F)
 483 {
 484   string methName = getID(&F);
 485   toAsm << "!****** Outputing Function: " << methName << " ******\n";
 486   enterSection(AsmPrinter::Text);
 487   toAsm << "\t.align\t4\n\t.global\t" << methName << "\n";
 488   //toAsm << "\t.type\t" << methName << ",#function\n";
 489   toAsm << "\t.type\t" << methName << ", 2\n";
 490   toAsm << methName << ":\n";
 491
 492   // Output code for all of the basic blocks in the function...
 493   for (Function::const_iterator I = F.begin(), E = F.end(); I != E; ++I)
 494     emitBasicBlock(I);
 495
 496   // Output a .size directive so the debugger knows the extents of the function
 497   toAsm << ".EndOf_" << methName << ":\n\t.size "
 498            << methName << ", .EndOf_"
 499            << methName << "-" << methName << "\n";
 500
 501   // Put some spaces between the functions
 502   toAsm << "\n\n";
 503 }
 504
 505 }  // End anonymous namespace
 506
 507 Pass *UltraSparc::getFunctionAsmPrinterPass(std::ostream &Out) {
 508   return new SparcFunctionAsmPrinter(Out, *this);
 509 }
 510
 511
 512
 513
 514
 515 //===----------------------------------------------------------------------===//
 516 //   SparcFunctionAsmPrinter Code
 517 //===----------------------------------------------------------------------===//
 518
 519 namespace {
 520
 521 class SparcModuleAsmPrinter : public Pass, public AsmPrinter {
 522 public:
 523   SparcModuleAsmPrinter(std::ostream &os, TargetMachine &t)
 524     : AsmPrinter(os, t) {}
 525
 526   const char *getPassName() const { return "Output Sparc Assembly for Module"; }
 527
 528   virtual bool run(Module &M) {
 529     startModule(M);
 530     emitGlobalsAndConstants(M);
 531     endModule();
 532     return false;
 533   }
 534
 535   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 536     AU.setPreservesAll();
 537   }
 538
 539 private:
 540   void emitGlobalsAndConstants  (const Module &M);
 541
 542   void printGlobalVariable      (const GlobalVariable *GV);
 543   void PrintZeroBytesToPad      (int numBytes);
 544   void printSingleConstantValue (const Constant* CV);
 545   void printConstantValueOnly   (const Constant* CV, int numPadBytes = 0);
 546   void printConstant            (const Constant* CV, string valID = "");
 547
 548   static void FoldConstants     (const Module &M,
 549                                  hash_set<const Constant*> &moduleConstants);
 550 };
 551
 552
 553 // Can we treat the specified array as a string?  Only if it is an array of
 554 // ubytes or non-negative sbytes.
 555 //
 556 static bool isStringCompatible(const ConstantArray *CVA) {
 557   const Type *ETy = cast<ArrayType>(CVA->getType())->getElementType();
 558   if (ETy == Type::UByteTy) return true;
 559   if (ETy != Type::SByteTy) return false;
 560
 561   for (unsigned i = 0; i < CVA->getNumOperands(); ++i)
 562     if (cast<ConstantSInt>(CVA->getOperand(i))->getValue() < 0)
 563       return false;
 564
 565   return true;
 566 }
 567
 568 // toOctal - Convert the low order bits of X into an octal letter
 569 static inline char toOctal(int X) {
 570   return (X&7)+'0';
 571 }
 572
 573 // getAsCString - Return the specified array as a C compatible string, only if
 574 // the predicate isStringCompatible is true.
 575 //
 576 static string getAsCString(const ConstantArray *CVA) {
 577   assert(isStringCompatible(CVA) && "Array is not string compatible!");
 578
 579   string Result;
 580   const Type *ETy = cast<ArrayType>(CVA->getType())->getElementType();
 581   Result = "\"";
 582   for (unsigned i = 0; i < CVA->getNumOperands(); ++i) {
 583     unsigned char C = (ETy == Type::SByteTy) ?
 584       (unsigned char)cast<ConstantSInt>(CVA->getOperand(i))->getValue() :
 585       (unsigned char)cast<ConstantUInt>(CVA->getOperand(i))->getValue();
 586
 587     if (C == '"') {
 588       Result += "\\\"";
 589     } else if (C == '\\') {
 590       Result += "\\\\";
 591     } else if (isprint(C)) {
 592       Result += C;
 593     } else {
 594       switch(C) {
 595       case '\a': Result += "\\a"; break;
 596       case '\b': Result += "\\b"; break;
 597       case '\f': Result += "\\f"; break;
 598       case '\n': Result += "\\n"; break;
 599       case '\r': Result += "\\r"; break;
 600       case '\t': Result += "\\t"; break;
 601       case '\v': Result += "\\v"; break;
 602       default:
 603         Result += '\\';
 604         Result += toOctal(C >> 6);
 605         Result += toOctal(C >> 3);
 606         Result += toOctal(C >> 0);
 607         break;
 608       }
 609     }
 610   }
 611   Result += "\"";
 612
 613   return Result;
 614 }
 615
 616 inline bool
 617 ArrayTypeIsString(const ArrayType* arrayType)
 618 {
 619   return (arrayType->getElementType() == Type::UByteTy ||
 620           arrayType->getElementType() == Type::SByteTy);
 621 }
 622
 623
 624 inline const string
 625 TypeToDataDirective(const Type* type)
 626 {
 627   switch(type->getPrimitiveID())
 628     {
 629     case Type::BoolTyID: case Type::UByteTyID: case Type::SByteTyID:
 630       return ".byte";
 631     case Type::UShortTyID: case Type::ShortTyID:
 632       return ".half";
 633     case Type::UIntTyID: case Type::IntTyID:
 634       return ".word";
 635     case Type::ULongTyID: case Type::LongTyID: case Type::PointerTyID:
 636       return ".xword";
 637     case Type::FloatTyID:
 638       return ".word";
 639     case Type::DoubleTyID:
 640       return ".xword";
 641     case Type::ArrayTyID:
 642       if (ArrayTypeIsString((ArrayType*) type))
 643         return ".ascii";
 644       else
 645         return "<InvaliDataTypeForPrinting>";
 646     default:
 647       return "<InvaliDataTypeForPrinting>";
 648     }
 649 }
 650
 651 // Get the size of the type
 652 //
 653 inline unsigned int
 654 TypeToSize(const Type* type, const TargetMachine& target)
 655 {
 656   return target.findOptimalStorageSize(type);
 657 }
 658
 659 // Get the size of the constant for the given target.
 660 // If this is an unsized array, return 0.
 661 //
 662 inline unsigned int
 663 ConstantToSize(const Constant* CV, const TargetMachine& target)
 664 {
 665   if (const ConstantArray* CVA = dyn_cast<ConstantArray>(CV))
 666     {
 667       const ArrayType *aty = cast<ArrayType>(CVA->getType());
 668       if (ArrayTypeIsString(aty))
 669         return 1 + CVA->getNumOperands();
 670     }
 671
 672   return TypeToSize(CV->getType(), target);
 673 }
 674
 675 // Align data larger than one L1 cache line on L1 cache line boundaries.
 676 // Align all smaller data on the next higher 2^x boundary (4, 8, ...).
 677 //
 678 inline unsigned int
 679 SizeToAlignment(unsigned int size, const TargetMachine& target)
 680 {
 681   unsigned short cacheLineSize = target.getCacheInfo().getCacheLineSize(1);
 682   if (size > (unsigned) cacheLineSize / 2)
 683     return cacheLineSize;
 684   else
 685     for (unsigned sz=1; /*no condition*/; sz *= 2)
 686       if (sz >= size)
 687         return sz;
 688 }
 689
 690 // Get the size of the type and then use SizeToAlignment.
 691 //
 692 inline unsigned int
 693 TypeToAlignment(const Type* type, const TargetMachine& target)
 694 {
 695   return SizeToAlignment(TypeToSize(type, target), target);
 696 }
 697
 698 // Get the size of the constant and then use SizeToAlignment.
 699 // Handles strings as a special case;
 700 inline unsigned int
 701 ConstantToAlignment(const Constant* CV, const TargetMachine& target)
 702 {
 703   if (const ConstantArray* CVA = dyn_cast<ConstantArray>(CV))
 704     if (ArrayTypeIsString(cast<ArrayType>(CVA->getType())))
 705       return SizeToAlignment(1 + CVA->getNumOperands(), target);
 706
 707   return TypeToAlignment(CV->getType(), target);
 708 }
 709
 710
 711 // Print a single constant value.
 712 void
 713 SparcModuleAsmPrinter::printSingleConstantValue(const Constant* CV)
 714 {
 715   assert(CV->getType() != Type::VoidTy &&
 716          CV->getType() != Type::TypeTy &&
 717          CV->getType() != Type::LabelTy &&
 718          "Unexpected type for Constant");
 719
 720   assert((!isa<ConstantArray>(CV) && ! isa<ConstantStruct>(CV))
 721          && "Aggregate types should be handled outside this function");
 722
 723   toAsm << "\t" << TypeToDataDirective(CV->getType()) << "\t";
 724
 725   if (CV->getType()->isPrimitiveType())
 726     {
 727       if (CV->getType()->isFloatingPoint()) {
 728         // FP Constants are printed as integer constants to avoid losing
 729         // precision...
 730         double Val = cast<ConstantFP>(CV)->getValue();
 731         if (CV->getType() == Type::FloatTy) {
 732           float FVal = (float)Val;
 733           char *ProxyPtr = (char*)&FVal;        // Abide by C TBAA rules
 734           toAsm << *(unsigned int*)ProxyPtr;
 735         } else if (CV->getType() == Type::DoubleTy) {
 736           char *ProxyPtr = (char*)&Val;         // Abide by C TBAA rules
 737           toAsm << *(uint64_t*)ProxyPtr;
 738         } else {
 739           assert(0 && "Unknown floating point type!");
 740         }
 741
 742         toAsm << "\t! " << CV->getType()->getDescription()
 743               << " value: " << Val << "\n";
 744       } else {
 745         WriteAsOperand(toAsm, CV, false, false) << "\n";
 746       }
 747     }
 748   else if (const ConstantPointerRef* CPR = dyn_cast<ConstantPointerRef>(CV))
 749     { // This is a constant address for a global variable or method.
 750       // Use the name of the variable or method as the address value.
 751       toAsm << getID(CPR->getValue()) << "\n";
 752     }
 753   else if (isa<ConstantPointerNull>(CV))
 754     { // Null pointer value
 755       toAsm << "0\n";
 756     }
 757   else if (const ConstantExpr* CE = dyn_cast<ConstantExpr>(CV))
 758     { // Constant expression built from operators, constants, and symbolic addrs
 759       toAsm << ConstantExprToString(CE, Target) << "\n";
 760     }
 761   else
 762     {
 763       assert(0 && "Unknown elementary type for constant");
 764     }
 765 }
 766
 767 void
 768 SparcModuleAsmPrinter::PrintZeroBytesToPad(int numBytes)
 769 {
 770   for ( ; numBytes >= 8; numBytes -= 8)
 771     printSingleConstantValue(Constant::getNullValue(Type::ULongTy));
 772
 773   if (numBytes >= 4)
 774     {
 775       printSingleConstantValue(Constant::getNullValue(Type::UIntTy));
 776       numBytes -= 4;
 777     }
 778
 779   while (numBytes--)
 780     printSingleConstantValue(Constant::getNullValue(Type::UByteTy));
 781 }
 782
 783 // Print a constant value or values (it may be an aggregate).
 784 // Uses printSingleConstantValue() to print each individual value.
 785 void
 786 SparcModuleAsmPrinter::printConstantValueOnly(const Constant* CV,
 787                                               int numPadBytes /* = 0*/)
 788 {
 789   const ConstantArray *CVA = dyn_cast<ConstantArray>(CV);
 790
 791   if (numPadBytes)
 792     PrintZeroBytesToPad(numPadBytes);
 793
 794   if (CVA && isStringCompatible(CVA))
 795     { // print the string alone and return
 796       toAsm << "\t" << ".ascii" << "\t" << getAsCString(CVA) << "\n";
 797     }
 798   else if (CVA)
 799     { // Not a string.  Print the values in successive locations
 800       const std::vector<Use> &constValues = CVA->getValues();
 801       for (unsigned i=0; i < constValues.size(); i++)
 802         printConstantValueOnly(cast<Constant>(constValues[i].get()));
 803     }
 804   else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV))
 805     { // Print the fields in successive locations. Pad to align if needed!
 806       const StructLayout *cvsLayout =
 807         Target.DataLayout.getStructLayout(CVS->getType());
 808       const std::vector<Use>& constValues = CVS->getValues();
 809       unsigned sizeSoFar = 0;
 810       for (unsigned i=0, N = constValues.size(); i < N; i++)
 811         {
 812           const Constant* field = cast<Constant>(constValues[i].get());
 813
 814           // Check if padding is needed and insert one or more 0s.
 815           unsigned fieldSize = Target.DataLayout.getTypeSize(field->getType());
 816           int padSize = ((i == N-1? cvsLayout->StructSize
 817                                   : cvsLayout->MemberOffsets[i+1])
 818                          - cvsLayout->MemberOffsets[i]) - fieldSize;
 819           sizeSoFar += (fieldSize + padSize);
 820
 821           // Now print the actual field value
 822           printConstantValueOnly(field, padSize);
 823         }
 824       assert(sizeSoFar == cvsLayout->StructSize &&
 825              "Layout of constant struct may be incorrect!");
 826     }
 827   else
 828     printSingleConstantValue(CV);
 829 }
 830
 831 // Print a constant (which may be an aggregate) prefixed by all the
 832 // appropriate directives.  Uses printConstantValueOnly() to print the
 833 // value or values.
 834 void
 835 SparcModuleAsmPrinter::printConstant(const Constant* CV, string valID)
 836 {
 837   if (valID.length() == 0)
 838     valID = getID(CV);
 839
 840   toAsm << "\t.align\t" << ConstantToAlignment(CV, Target) << "\n";
 841
 842   // Print .size and .type only if it is not a string.
 843   const ConstantArray *CVA = dyn_cast<ConstantArray>(CV);
 844   if (CVA && isStringCompatible(CVA))
 845     { // print it as a string and return
 846       toAsm << valID << ":\n";
 847       toAsm << "\t" << ".ascii" << "\t" << getAsCString(CVA) << "\n";
 848       return;
 849     }
 850
 851   toAsm << "\t.type" << "\t" << valID << ",#object\n";
 852
 853   unsigned int constSize = ConstantToSize(CV, Target);
 854   if (constSize)
 855     toAsm << "\t.size" << "\t" << valID << "," << constSize << "\n";
 856
 857   toAsm << valID << ":\n";
 858
 859   printConstantValueOnly(CV);
 860 }
 861
 862
 863 void SparcModuleAsmPrinter::FoldConstants(const Module &M,
 864                                           hash_set<const Constant*> &MC) {
 865   for (Module::const_iterator I = M.begin(), E = M.end(); I != E; ++I)
 866     if (!I->isExternal()) {
 867       const hash_set<const Constant*> &pool =
 868         MachineFunction::get(I).getConstantPoolValues();
 869       MC.insert(pool.begin(), pool.end());
 870     }
 871 }
 872
 873 void SparcModuleAsmPrinter::printGlobalVariable(const GlobalVariable* GV)
 874 {
 875   if (GV->hasExternalLinkage())
 876     toAsm << "\t.global\t" << getID(GV) << "\n";
 877
 878   if (GV->hasInitializer() && ! GV->getInitializer()->isNullValue())
 879     printConstant(GV->getInitializer(), getID(GV));
 880   else {
 881     toAsm << "\t.align\t" << TypeToAlignment(GV->getType()->getElementType(),
 882                                                 Target) << "\n";
 883     toAsm << "\t.type\t" << getID(GV) << ",#object\n";
 884     toAsm << "\t.reserve\t" << getID(GV) << ","
 885           << TypeToSize(GV->getType()->getElementType(), Target)
 886           << "\n";
 887   }
 888 }
 889
 890
 891 void SparcModuleAsmPrinter::emitGlobalsAndConstants(const Module &M) {
 892   // First, get the constants there were marked by the code generator for
 893   // inclusion in the assembly code data area and fold them all into a
 894   // single constant pool since there may be lots of duplicates.  Also,
 895   // lets force these constants into the slot table so that we can get
 896   // unique names for unnamed constants also.
 897   //
 898   hash_set<const Constant*> moduleConstants;
 899   FoldConstants(M, moduleConstants);
 900
 901   // Output constants spilled to memory
 902   enterSection(AsmPrinter::ReadOnlyData);
 903   for (hash_set<const Constant*>::const_iterator I = moduleConstants.begin(),
 904          E = moduleConstants.end();  I != E; ++I)
 905     printConstant(*I);
 906
 907   // Output global variables...
 908   for (Module::const_giterator GI = M.gbegin(), GE = M.gend(); GI != GE; ++GI)
 909     if (! GI->isExternal()) {
 910       assert(GI->hasInitializer());
 911       if (GI->isConstant())
 912         enterSection(AsmPrinter::ReadOnlyData);   // read-only, initialized data
 913       else if (GI->getInitializer()->isNullValue())
 914         enterSection(AsmPrinter::ZeroInitRWData); // read-write zero data
 915       else
 916         enterSection(AsmPrinter::InitRWData);     // read-write non-zero data
 917
 918       printGlobalVariable(GI);
 919     }
 920
 921   toAsm << "\n";
 922 }
 923
 924 }  // End anonymous namespace
 925
 926 Pass *UltraSparc::getModuleAsmPrinterPass(std::ostream &Out) {
 927   return new SparcModuleAsmPrinter(Out, *this);
 928 }