lib/CodeGen/AsmPrinter/AsmPrinter.cpp

   1 //===-- AsmPrinter.cpp - Common AsmPrinter code ---------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the AsmPrinter class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/CodeGen/AsmPrinter.h"
  15 #include "llvm/Assembly/Writer.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/CodeGen/GCMetadataPrinter.h"
  20 #include "llvm/CodeGen/MachineConstantPool.h"
  21 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  22 #include "llvm/CodeGen/MachineModuleInfo.h"
  23 #include "llvm/Support/Mangler.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include "llvm/Target/TargetAsmInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetLowering.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Target/TargetOptions.h"
  30 #include "llvm/Target/TargetRegisterInfo.h"
  31 #include "llvm/ADT/SmallPtrSet.h"
  32 #include "llvm/ADT/SmallString.h"
  33 #include "llvm/ADT/StringExtras.h"
  34 #include <cerrno>
  35 using namespace llvm;
  36
  37 char AsmPrinter::ID = 0;
  38 AsmPrinter::AsmPrinter(raw_ostream &o, TargetMachine &tm,
  39                        const TargetAsmInfo *T)
  40   : MachineFunctionPass(&ID), FunctionNumber(0), O(o),
  41     TM(tm), TAI(T), TRI(tm.getRegisterInfo()),
  42     IsInTextSection(false)
  43 {}
  44
  45 AsmPrinter::~AsmPrinter() {
  46   for (gcp_iterator I = GCMetadataPrinters.begin(),
  47                     E = GCMetadataPrinters.end(); I != E; ++I)
  48     delete I->second;
  49 }
  50
  51 /// SwitchToTextSection - Switch to the specified text section of the executable
  52 /// if we are not already in it!
  53 ///
  54 void AsmPrinter::SwitchToTextSection(const char *NewSection,
  55                                      const GlobalValue *GV) {
  56   std::string NS;
  57   if (GV && GV->hasSection())
  58     NS = TAI->getSwitchToSectionDirective() + GV->getSection();
  59   else
  60     NS = NewSection;
  61
  62   // If we're already in this section, we're done.
  63   if (CurrentSection == NS) return;
  64
  65   // Close the current section, if applicable.
  66   if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
  67     O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
  68
  69   CurrentSection = NS;
  70
  71   if (!CurrentSection.empty())
  72     O << CurrentSection << TAI->getTextSectionStartSuffix() << '\n';
  73
  74   IsInTextSection = true;
  75 }
  76
  77 /// SwitchToDataSection - Switch to the specified data section of the executable
  78 /// if we are not already in it!
  79 ///
  80 void AsmPrinter::SwitchToDataSection(const char *NewSection,
  81                                      const GlobalValue *GV) {
  82   std::string NS;
  83   if (GV && GV->hasSection())
  84     NS = TAI->getSwitchToSectionDirective() + GV->getSection();
  85   else
  86     NS = NewSection;
  87
  88   // If we're already in this section, we're done.
  89   if (CurrentSection == NS) return;
  90
  91   // Close the current section, if applicable.
  92   if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
  93     O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
  94
  95   CurrentSection = NS;
  96
  97   if (!CurrentSection.empty())
  98     O << CurrentSection << TAI->getDataSectionStartSuffix() << '\n';
  99
 100   IsInTextSection = false;
 101 }
 102
 103 /// SwitchToSection - Switch to the specified section of the executable if we
 104 /// are not already in it!
 105 void AsmPrinter::SwitchToSection(const Section* NS) {
 106   const std::string& NewSection = NS->getName();
 107
 108   // If we're already in this section, we're done.
 109   if (CurrentSection == NewSection) return;
 110
 111   // Close the current section, if applicable.
 112   if (TAI->getSectionEndDirectiveSuffix() && !CurrentSection.empty())
 113     O << CurrentSection << TAI->getSectionEndDirectiveSuffix() << '\n';
 114
 115   // FIXME: Make CurrentSection a Section* in the future
 116   CurrentSection = NewSection;
 117   CurrentSection_ = NS;
 118
 119   if (!CurrentSection.empty()) {
 120     // If section is named we need to switch into it via special '.section'
 121     // directive and also append funky flags. Otherwise - section name is just
 122     // some magic assembler directive.
 123     if (NS->isNamed())
 124       O << TAI->getSwitchToSectionDirective()
 125         << CurrentSection
 126         << TAI->getSectionFlags(NS->getFlags());
 127     else
 128       O << CurrentSection;
 129     O << TAI->getDataSectionStartSuffix() << '\n';
 130   }
 131
 132   IsInTextSection = (NS->getFlags() & SectionFlags::Code);
 133 }
 134
 135 void AsmPrinter::getAnalysisUsage(AnalysisUsage &AU) const {
 136   MachineFunctionPass::getAnalysisUsage(AU);
 137   AU.addRequired<GCModuleInfo>();
 138 }
 139
 140 bool AsmPrinter::doInitialization(Module &M) {
 141   Mang = new Mangler(M, TAI->getGlobalPrefix());
 142
 143   GCModuleInfo *MI = getAnalysisToUpdate<GCModuleInfo>();
 144   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 145   for (GCModuleInfo::iterator I = MI->begin(), E = MI->end(); I != E; ++I)
 146     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*I))
 147       MP->beginAssembly(O, *this, *TAI);
 148
 149   if (!M.getModuleInlineAsm().empty())
 150     O << TAI->getCommentString() << " Start of file scope inline assembly\n"
 151       << M.getModuleInlineAsm()
 152       << '\n' << TAI->getCommentString()
 153       << " End of file scope inline assembly\n";
 154
 155   SwitchToDataSection("");   // Reset back to no section.
 156
 157   MMI = getAnalysisToUpdate<MachineModuleInfo>();
 158   if (MMI) MMI->AnalyzeModule(M);
 159
 160   return false;
 161 }
 162
 163 bool AsmPrinter::doFinalization(Module &M) {
 164   if (TAI->getWeakRefDirective()) {
 165     if (!ExtWeakSymbols.empty())
 166       SwitchToDataSection("");
 167
 168     for (std::set<const GlobalValue*>::iterator i = ExtWeakSymbols.begin(),
 169          e = ExtWeakSymbols.end(); i != e; ++i) {
 170       const GlobalValue *GV = *i;
 171       std::string Name = Mang->getValueName(GV);
 172       O << TAI->getWeakRefDirective() << Name << '\n';
 173     }
 174   }
 175
 176   if (TAI->getSetDirective()) {
 177     if (!M.alias_empty())
 178       SwitchToSection(TAI->getTextSection());
 179
 180     O << '\n';
 181     for (Module::const_alias_iterator I = M.alias_begin(), E = M.alias_end();
 182          I!=E; ++I) {
 183       std::string Name = Mang->getValueName(I);
 184       std::string Target;
 185
 186       const GlobalValue *GV = cast<GlobalValue>(I->getAliasedGlobal());
 187       Target = Mang->getValueName(GV);
 188
 189       if (I->hasExternalLinkage() || !TAI->getWeakRefDirective())
 190         O << "\t.globl\t" << Name << '\n';
 191       else if (I->hasWeakLinkage())
 192         O << TAI->getWeakRefDirective() << Name << '\n';
 193       else if (!I->hasInternalLinkage())
 194         assert(0 && "Invalid alias linkage");
 195
 196       if (I->hasHiddenVisibility()) {
 197         if (const char *Directive = TAI->getHiddenDirective())
 198           O << Directive << Name << '\n';
 199       } else if (I->hasProtectedVisibility()) {
 200         if (const char *Directive = TAI->getProtectedDirective())
 201           O << Directive << Name << '\n';
 202       }
 203
 204       O << TAI->getSetDirective() << ' ' << Name << ", " << Target << '\n';
 205
 206       // If the aliasee has external weak linkage it can be referenced only by
 207       // alias itself. In this case it can be not in ExtWeakSymbols list. Emit
 208       // weak reference in such case.
 209       if (GV->hasExternalWeakLinkage()) {
 210         if (TAI->getWeakRefDirective())
 211           O << TAI->getWeakRefDirective() << Target << '\n';
 212         else
 213           O << "\t.globl\t" << Target << '\n';
 214       }
 215     }
 216   }
 217
 218   GCModuleInfo *MI = getAnalysisToUpdate<GCModuleInfo>();
 219   assert(MI && "AsmPrinter didn't require GCModuleInfo?");
 220   for (GCModuleInfo::iterator I = MI->end(), E = MI->begin(); I != E; )
 221     if (GCMetadataPrinter *MP = GetOrCreateGCPrinter(*--I))
 222       MP->finishAssembly(O, *this, *TAI);
 223
 224   // If we don't have any trampolines, then we don't require stack memory
 225   // to be executable. Some targets have a directive to declare this.
 226   Function* InitTrampolineIntrinsic = M.getFunction("llvm.init.trampoline");
 227   if (!InitTrampolineIntrinsic || InitTrampolineIntrinsic->use_empty())
 228     if (TAI->getNonexecutableStackDirective())
 229       O << TAI->getNonexecutableStackDirective() << '\n';
 230
 231   delete Mang; Mang = 0;
 232   return false;
 233 }
 234
 235 std::string AsmPrinter::getCurrentFunctionEHName(const MachineFunction *MF) {
 236   assert(MF && "No machine function?");
 237   std::string Name = MF->getFunction()->getName();
 238   if (Name.empty())
 239     Name = Mang->getValueName(MF->getFunction());
 240   return Mang->makeNameProper(Name + ".eh", TAI->getGlobalPrefix());
 241 }
 242
 243 void AsmPrinter::SetupMachineFunction(MachineFunction &MF) {
 244   // What's my mangled name?
 245   CurrentFnName = Mang->getValueName(MF.getFunction());
 246   IncrementFunctionNumber();
 247 }
 248
 249 /// EmitConstantPool - Print to the current output stream assembly
 250 /// representations of the constants in the constant pool MCP. This is
 251 /// used to print out constants which have been "spilled to memory" by
 252 /// the code generator.
 253 ///
 254 void AsmPrinter::EmitConstantPool(MachineConstantPool *MCP) {
 255   const std::vector<MachineConstantPoolEntry> &CP = MCP->getConstants();
 256   if (CP.empty()) return;
 257
 258   // Calculate sections for constant pool entries. We collect entries to go into
 259   // the same section together to reduce amount of section switch statements.
 260   typedef
 261     std::multimap<const Section*,
 262                   std::pair<MachineConstantPoolEntry, unsigned> > CPMap;
 263   CPMap  CPs;
 264   SmallPtrSet<const Section*, 5> Sections;
 265
 266   for (unsigned i = 0, e = CP.size(); i != e; ++i) {
 267     MachineConstantPoolEntry CPE = CP[i];
 268     const Section* S = TAI->SelectSectionForMachineConst(CPE.getType());
 269     CPs.insert(std::make_pair(S, std::make_pair(CPE, i)));
 270     Sections.insert(S);
 271   }
 272
 273   // Now print stuff into the calculated sections.
 274   for (SmallPtrSet<const Section*, 5>::iterator IS = Sections.begin(),
 275          ES = Sections.end(); IS != ES; ++IS) {
 276     SwitchToSection(*IS);
 277     EmitAlignment(MCP->getConstantPoolAlignment());
 278
 279     std::pair<CPMap::iterator, CPMap::iterator> II = CPs.equal_range(*IS);
 280     for (CPMap::iterator I = II.first, E = II.second; I != E; ++I) {
 281       CPMap::iterator J = next(I);
 282       MachineConstantPoolEntry Entry = I->second.first;
 283       unsigned index = I->second.second;
 284
 285       O << TAI->getPrivateGlobalPrefix() << "CPI" << getFunctionNumber() << '_'
 286         << index << ":\t\t\t\t\t";
 287     // O << TAI->getCommentString() << ' ' <<
 288     //      WriteTypeSymbolic(O, CP[i].first.getType(), 0);
 289       O << '\n';
 290       if (Entry.isMachineConstantPoolEntry())
 291         EmitMachineConstantPoolValue(Entry.Val.MachineCPVal);
 292       else
 293         EmitGlobalConstant(Entry.Val.ConstVal);
 294
 295       // Emit inter-object padding for alignment.
 296       if (J != E) {
 297         const Type *Ty = Entry.getType();
 298         unsigned EntSize = TM.getTargetData()->getABITypeSize(Ty);
 299         unsigned ValEnd = Entry.getOffset() + EntSize;
 300         EmitZeros(J->second.first.getOffset()-ValEnd);
 301       }
 302     }
 303   }
 304 }
 305
 306 /// EmitJumpTableInfo - Print assembly representations of the jump tables used
 307 /// by the current function to the current output stream.
 308 ///
 309 void AsmPrinter::EmitJumpTableInfo(MachineJumpTableInfo *MJTI,
 310                                    MachineFunction &MF) {
 311   const std::vector<MachineJumpTableEntry> &JT = MJTI->getJumpTables();
 312   if (JT.empty()) return;
 313
 314   bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
 315
 316   // Pick the directive to use to print the jump table entries, and switch to
 317   // the appropriate section.
 318   TargetLowering *LoweringInfo = TM.getTargetLowering();
 319
 320   const char* JumpTableDataSection = TAI->getJumpTableDataSection();
 321   const Function *F = MF.getFunction();
 322   unsigned SectionFlags = TAI->SectionFlagsForGlobal(F);
 323   if ((IsPic && !(LoweringInfo && LoweringInfo->usesGlobalOffsetTable())) ||
 324      !JumpTableDataSection ||
 325       SectionFlags & SectionFlags::Linkonce) {
 326     // In PIC mode, we need to emit the jump table to the same section as the
 327     // function body itself, otherwise the label differences won't make sense.
 328     // We should also do if the section name is NULL or function is declared in
 329     // discardable section.
 330     SwitchToSection(TAI->SectionForGlobal(F));
 331   } else {
 332     SwitchToDataSection(JumpTableDataSection);
 333   }
 334
 335   EmitAlignment(Log2_32(MJTI->getAlignment()));
 336
 337   for (unsigned i = 0, e = JT.size(); i != e; ++i) {
 338     const std::vector<MachineBasicBlock*> &JTBBs = JT[i].MBBs;
 339
 340     // If this jump table was deleted, ignore it.
 341     if (JTBBs.empty()) continue;
 342
 343     // For PIC codegen, if possible we want to use the SetDirective to reduce
 344     // the number of relocations the assembler will generate for the jump table.
 345     // Set directives are all printed before the jump table itself.
 346     SmallPtrSet<MachineBasicBlock*, 16> EmittedSets;
 347     if (TAI->getSetDirective() && IsPic)
 348       for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii)
 349         if (EmittedSets.insert(JTBBs[ii]))
 350           printPICJumpTableSetLabel(i, JTBBs[ii]);
 351
 352     // On some targets (e.g. darwin) we want to emit two consequtive labels
 353     // before each jump table.  The first label is never referenced, but tells
 354     // the assembler and linker the extents of the jump table object.  The
 355     // second label is actually referenced by the code.
 356     if (const char *JTLabelPrefix = TAI->getJumpTableSpecialLabelPrefix())
 357       O << JTLabelPrefix << "JTI" << getFunctionNumber() << '_' << i << ":\n";
 358
 359     O << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
 360       << '_' << i << ":\n";
 361
 362     for (unsigned ii = 0, ee = JTBBs.size(); ii != ee; ++ii) {
 363       printPICJumpTableEntry(MJTI, JTBBs[ii], i);
 364       O << '\n';
 365     }
 366   }
 367 }
 368
 369 void AsmPrinter::printPICJumpTableEntry(const MachineJumpTableInfo *MJTI,
 370                                         const MachineBasicBlock *MBB,
 371                                         unsigned uid)  const {
 372   bool IsPic = TM.getRelocationModel() == Reloc::PIC_;
 373
 374   // Use JumpTableDirective otherwise honor the entry size from the jump table
 375   // info.
 376   const char *JTEntryDirective = TAI->getJumpTableDirective();
 377   bool HadJTEntryDirective = JTEntryDirective != NULL;
 378   if (!HadJTEntryDirective) {
 379     JTEntryDirective = MJTI->getEntrySize() == 4 ?
 380       TAI->getData32bitsDirective() : TAI->getData64bitsDirective();
 381   }
 382
 383   O << JTEntryDirective << ' ';
 384
 385   // If we have emitted set directives for the jump table entries, print
 386   // them rather than the entries themselves.  If we're emitting PIC, then
 387   // emit the table entries as differences between two text section labels.
 388   // If we're emitting non-PIC code, then emit the entries as direct
 389   // references to the target basic blocks.
 390   if (IsPic) {
 391     if (TAI->getSetDirective()) {
 392       O << TAI->getPrivateGlobalPrefix() << getFunctionNumber()
 393         << '_' << uid << "_set_" << MBB->getNumber();
 394     } else {
 395       printBasicBlockLabel(MBB, false, false, false);
 396       // If the arch uses custom Jump Table directives, don't calc relative to
 397       // JT
 398       if (!HadJTEntryDirective)
 399         O << '-' << TAI->getPrivateGlobalPrefix() << "JTI"
 400           << getFunctionNumber() << '_' << uid;
 401     }
 402   } else {
 403     printBasicBlockLabel(MBB, false, false, false);
 404   }
 405 }
 406
 407
 408 /// EmitSpecialLLVMGlobal - Check to see if the specified global is a
 409 /// special global used by LLVM.  If so, emit it and return true, otherwise
 410 /// do nothing and return false.
 411 bool AsmPrinter::EmitSpecialLLVMGlobal(const GlobalVariable *GV) {
 412   if (GV->getName() == "llvm.used") {
 413     if (TAI->getUsedDirective() != 0)    // No need to emit this at all.
 414       EmitLLVMUsedList(GV->getInitializer());
 415     return true;
 416   }
 417
 418   // Ignore debug and non-emitted data.
 419   if (GV->getSection() == "llvm.metadata") return true;
 420
 421   if (!GV->hasAppendingLinkage()) return false;
 422
 423   assert(GV->hasInitializer() && "Not a special LLVM global!");
 424
 425   const TargetData *TD = TM.getTargetData();
 426   unsigned Align = Log2_32(TD->getPointerPrefAlignment());
 427   if (GV->getName() == "llvm.global_ctors" && GV->use_empty()) {
 428     SwitchToDataSection(TAI->getStaticCtorsSection());
 429     EmitAlignment(Align, 0);
 430     EmitXXStructorList(GV->getInitializer());
 431     return true;
 432   }
 433
 434   if (GV->getName() == "llvm.global_dtors" && GV->use_empty()) {
 435     SwitchToDataSection(TAI->getStaticDtorsSection());
 436     EmitAlignment(Align, 0);
 437     EmitXXStructorList(GV->getInitializer());
 438     return true;
 439   }
 440
 441   return false;
 442 }
 443
 444 /// findGlobalValue - if CV is an expression equivalent to a single
 445 /// global value, return that value.
 446 const GlobalValue * AsmPrinter::findGlobalValue(const Constant *CV) {
 447   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
 448     return GV;
 449   else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 450     const TargetData *TD = TM.getTargetData();
 451     unsigned Opcode = CE->getOpcode();
 452     switch (Opcode) {
 453     case Instruction::GetElementPtr: {
 454       const Constant *ptrVal = CE->getOperand(0);
 455       SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
 456       if (TD->getIndexedOffset(ptrVal->getType(), &idxVec[0], idxVec.size()))
 457         return 0;
 458       return findGlobalValue(ptrVal);
 459     }
 460     case Instruction::BitCast:
 461       return findGlobalValue(CE->getOperand(0));
 462     default:
 463       return 0;
 464     }
 465   }
 466   return 0;
 467 }
 468
 469 /// EmitLLVMUsedList - For targets that define a TAI::UsedDirective, mark each
 470 /// global in the specified llvm.used list for which emitUsedDirectiveFor
 471 /// is true, as being used with this directive.
 472
 473 void AsmPrinter::EmitLLVMUsedList(Constant *List) {
 474   const char *Directive = TAI->getUsedDirective();
 475
 476   // Should be an array of 'sbyte*'.
 477   ConstantArray *InitList = dyn_cast<ConstantArray>(List);
 478   if (InitList == 0) return;
 479
 480   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i) {
 481     const GlobalValue *GV = findGlobalValue(InitList->getOperand(i));
 482     if (TAI->emitUsedDirectiveFor(GV, Mang)) {
 483       O << Directive;
 484       EmitConstantValueOnly(InitList->getOperand(i));
 485       O << '\n';
 486     }
 487   }
 488 }
 489
 490 /// EmitXXStructorList - Emit the ctor or dtor list.  This just prints out the
 491 /// function pointers, ignoring the init priority.
 492 void AsmPrinter::EmitXXStructorList(Constant *List) {
 493   // Should be an array of '{ int, void ()* }' structs.  The first value is the
 494   // init priority, which we ignore.
 495   if (!isa<ConstantArray>(List)) return;
 496   ConstantArray *InitList = cast<ConstantArray>(List);
 497   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
 498     if (ConstantStruct *CS = dyn_cast<ConstantStruct>(InitList->getOperand(i))){
 499       if (CS->getNumOperands() != 2) return;  // Not array of 2-element structs.
 500
 501       if (CS->getOperand(1)->isNullValue())
 502         return;  // Found a null terminator, exit printing.
 503       // Emit the function pointer.
 504       EmitGlobalConstant(CS->getOperand(1));
 505     }
 506 }
 507
 508 /// getGlobalLinkName - Returns the asm/link name of of the specified
 509 /// global variable.  Should be overridden by each target asm printer to
 510 /// generate the appropriate value.
 511 const std::string AsmPrinter::getGlobalLinkName(const GlobalVariable *GV) const{
 512   std::string LinkName;
 513
 514   if (isa<Function>(GV)) {
 515     LinkName += TAI->getFunctionAddrPrefix();
 516     LinkName += Mang->getValueName(GV);
 517     LinkName += TAI->getFunctionAddrSuffix();
 518   } else {
 519     LinkName += TAI->getGlobalVarAddrPrefix();
 520     LinkName += Mang->getValueName(GV);
 521     LinkName += TAI->getGlobalVarAddrSuffix();
 522   }
 523
 524   return LinkName;
 525 }
 526
 527 /// EmitExternalGlobal - Emit the external reference to a global variable.
 528 /// Should be overridden if an indirect reference should be used.
 529 void AsmPrinter::EmitExternalGlobal(const GlobalVariable *GV) {
 530   O << getGlobalLinkName(GV);
 531 }
 532
 533
 534
 535 //===----------------------------------------------------------------------===//
 536 /// LEB 128 number encoding.
 537
 538 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
 539 /// representing an unsigned leb128 value.
 540 void AsmPrinter::PrintULEB128(unsigned Value) const {
 541   do {
 542     unsigned Byte = Value & 0x7f;
 543     Value >>= 7;
 544     if (Value) Byte |= 0x80;
 545     O << "0x" <<  utohexstr(Byte);
 546     if (Value) O << ", ";
 547   } while (Value);
 548 }
 549
 550 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
 551 /// representing a signed leb128 value.
 552 void AsmPrinter::PrintSLEB128(int Value) const {
 553   int Sign = Value >> (8 * sizeof(Value) - 1);
 554   bool IsMore;
 555
 556   do {
 557     unsigned Byte = Value & 0x7f;
 558     Value >>= 7;
 559     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
 560     if (IsMore) Byte |= 0x80;
 561     O << "0x" << utohexstr(Byte);
 562     if (IsMore) O << ", ";
 563   } while (IsMore);
 564 }
 565
 566 //===--------------------------------------------------------------------===//
 567 // Emission and print routines
 568 //
 569
 570 /// PrintHex - Print a value as a hexidecimal value.
 571 ///
 572 void AsmPrinter::PrintHex(int Value) const {
 573   O << "0x" << utohexstr(static_cast<unsigned>(Value));
 574 }
 575
 576 /// EOL - Print a newline character to asm stream.  If a comment is present
 577 /// then it will be printed first.  Comments should not contain '\n'.
 578 void AsmPrinter::EOL() const {
 579   O << '\n';
 580 }
 581
 582 void AsmPrinter::EOL(const std::string &Comment) const {
 583   if (VerboseAsm && !Comment.empty()) {
 584     O << '\t'
 585       << TAI->getCommentString()
 586       << ' '
 587       << Comment;
 588   }
 589   O << '\n';
 590 }
 591
 592 void AsmPrinter::EOL(const char* Comment) const {
 593   if (VerboseAsm && *Comment) {
 594     O << '\t'
 595       << TAI->getCommentString()
 596       << ' '
 597       << Comment;
 598   }
 599   O << '\n';
 600 }
 601
 602 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
 603 /// unsigned leb128 value.
 604 void AsmPrinter::EmitULEB128Bytes(unsigned Value) const {
 605   if (TAI->hasLEB128()) {
 606     O << "\t.uleb128\t"
 607       << Value;
 608   } else {
 609     O << TAI->getData8bitsDirective();
 610     PrintULEB128(Value);
 611   }
 612 }
 613
 614 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
 615 /// signed leb128 value.
 616 void AsmPrinter::EmitSLEB128Bytes(int Value) const {
 617   if (TAI->hasLEB128()) {
 618     O << "\t.sleb128\t"
 619       << Value;
 620   } else {
 621     O << TAI->getData8bitsDirective();
 622     PrintSLEB128(Value);
 623   }
 624 }
 625
 626 /// EmitInt8 - Emit a byte directive and value.
 627 ///
 628 void AsmPrinter::EmitInt8(int Value) const {
 629   O << TAI->getData8bitsDirective();
 630   PrintHex(Value & 0xFF);
 631 }
 632
 633 /// EmitInt16 - Emit a short directive and value.
 634 ///
 635 void AsmPrinter::EmitInt16(int Value) const {
 636   O << TAI->getData16bitsDirective();
 637   PrintHex(Value & 0xFFFF);
 638 }
 639
 640 /// EmitInt32 - Emit a long directive and value.
 641 ///
 642 void AsmPrinter::EmitInt32(int Value) const {
 643   O << TAI->getData32bitsDirective();
 644   PrintHex(Value);
 645 }
 646
 647 /// EmitInt64 - Emit a long long directive and value.
 648 ///
 649 void AsmPrinter::EmitInt64(uint64_t Value) const {
 650   if (TAI->getData64bitsDirective()) {
 651     O << TAI->getData64bitsDirective();
 652     PrintHex(Value);
 653   } else {
 654     if (TM.getTargetData()->isBigEndian()) {
 655       EmitInt32(unsigned(Value >> 32)); O << '\n';
 656       EmitInt32(unsigned(Value));
 657     } else {
 658       EmitInt32(unsigned(Value)); O << '\n';
 659       EmitInt32(unsigned(Value >> 32));
 660     }
 661   }
 662 }
 663
 664 /// toOctal - Convert the low order bits of X into an octal digit.
 665 ///
 666 static inline char toOctal(int X) {
 667   return (X&7)+'0';
 668 }
 669
 670 /// printStringChar - Print a char, escaped if necessary.
 671 ///
 672 static void printStringChar(raw_ostream &O, char C) {
 673   if (C == '"') {
 674     O << "\\\"";
 675   } else if (C == '\\') {
 676     O << "\\\\";
 677   } else if (isprint(C)) {
 678     O << C;
 679   } else {
 680     switch(C) {
 681     case '\b': O << "\\b"; break;
 682     case '\f': O << "\\f"; break;
 683     case '\n': O << "\\n"; break;
 684     case '\r': O << "\\r"; break;
 685     case '\t': O << "\\t"; break;
 686     default:
 687       O << '\\';
 688       O << toOctal(C >> 6);
 689       O << toOctal(C >> 3);
 690       O << toOctal(C >> 0);
 691       break;
 692     }
 693   }
 694 }
 695
 696 /// EmitString - Emit a string with quotes and a null terminator.
 697 /// Special characters are emitted properly.
 698 /// \literal (Eg. '\t') \endliteral
 699 void AsmPrinter::EmitString(const std::string &String) const {
 700   const char* AscizDirective = TAI->getAscizDirective();
 701   if (AscizDirective)
 702     O << AscizDirective;
 703   else
 704     O << TAI->getAsciiDirective();
 705   O << '\"';
 706   for (unsigned i = 0, N = String.size(); i < N; ++i) {
 707     unsigned char C = String[i];
 708     printStringChar(O, C);
 709   }
 710   if (AscizDirective)
 711     O << '\"';
 712   else
 713     O << "\\0\"";
 714 }
 715
 716
 717 /// EmitFile - Emit a .file directive.
 718 void AsmPrinter::EmitFile(unsigned Number, const std::string &Name) const {
 719   O << "\t.file\t" << Number << " \"";
 720   for (unsigned i = 0, N = Name.size(); i < N; ++i) {
 721     unsigned char C = Name[i];
 722     printStringChar(O, C);
 723   }
 724   O << '\"';
 725 }
 726
 727
 728 //===----------------------------------------------------------------------===//
 729
 730 // EmitAlignment - Emit an alignment directive to the specified power of
 731 // two boundary.  For example, if you pass in 3 here, you will get an 8
 732 // byte alignment.  If a global value is specified, and if that global has
 733 // an explicit alignment requested, it will unconditionally override the
 734 // alignment request.  However, if ForcedAlignBits is specified, this value
 735 // has final say: the ultimate alignment will be the max of ForcedAlignBits
 736 // and the alignment computed with NumBits and the global.
 737 //
 738 // The algorithm is:
 739 //     Align = NumBits;
 740 //     if (GV && GV->hasalignment) Align = GV->getalignment();
 741 //     Align = std::max(Align, ForcedAlignBits);
 742 //
 743 void AsmPrinter::EmitAlignment(unsigned NumBits, const GlobalValue *GV,
 744                                unsigned ForcedAlignBits,
 745                                bool UseFillExpr) const {
 746   if (GV && GV->getAlignment())
 747     NumBits = Log2_32(GV->getAlignment());
 748   NumBits = std::max(NumBits, ForcedAlignBits);
 749
 750   if (NumBits == 0) return;   // No need to emit alignment.
 751   if (TAI->getAlignmentIsInBytes()) NumBits = 1 << NumBits;
 752   O << TAI->getAlignDirective() << NumBits;
 753
 754   unsigned FillValue = TAI->getTextAlignFillValue();
 755   UseFillExpr &= IsInTextSection && FillValue;
 756   if (UseFillExpr) O << ",0x" << utohexstr(FillValue);
 757   O << '\n';
 758 }
 759
 760
 761 /// EmitZeros - Emit a block of zeros.
 762 ///
 763 void AsmPrinter::EmitZeros(uint64_t NumZeros) const {
 764   if (NumZeros) {
 765     if (TAI->getZeroDirective()) {
 766       O << TAI->getZeroDirective() << NumZeros;
 767       if (TAI->getZeroDirectiveSuffix())
 768         O << TAI->getZeroDirectiveSuffix();
 769       O << '\n';
 770     } else {
 771       for (; NumZeros; --NumZeros)
 772         O << TAI->getData8bitsDirective() << "0\n";
 773     }
 774   }
 775 }
 776
 777 // Print out the specified constant, without a storage class.  Only the
 778 // constants valid in constant expressions can occur here.
 779 void AsmPrinter::EmitConstantValueOnly(const Constant *CV) {
 780   if (CV->isNullValue() || isa<UndefValue>(CV))
 781     O << '0';
 782   else if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
 783     O << CI->getZExtValue();
 784   } else if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV)) {
 785     // This is a constant address for a global variable or function. Use the
 786     // name of the variable or function as the address value, possibly
 787     // decorating it with GlobalVarAddrPrefix/Suffix or
 788     // FunctionAddrPrefix/Suffix (these all default to "" )
 789     if (isa<Function>(GV)) {
 790       O << TAI->getFunctionAddrPrefix()
 791         << Mang->getValueName(GV)
 792         << TAI->getFunctionAddrSuffix();
 793     } else {
 794       O << TAI->getGlobalVarAddrPrefix()
 795         << Mang->getValueName(GV)
 796         << TAI->getGlobalVarAddrSuffix();
 797     }
 798   } else if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(CV)) {
 799     const TargetData *TD = TM.getTargetData();
 800     unsigned Opcode = CE->getOpcode();
 801     switch (Opcode) {
 802     case Instruction::GetElementPtr: {
 803       // generate a symbolic expression for the byte address
 804       const Constant *ptrVal = CE->getOperand(0);
 805       SmallVector<Value*, 8> idxVec(CE->op_begin()+1, CE->op_end());
 806       if (int64_t Offset = TD->getIndexedOffset(ptrVal->getType(), &idxVec[0],
 807                                                 idxVec.size())) {
 808         if (Offset)
 809           O << '(';
 810         EmitConstantValueOnly(ptrVal);
 811         if (Offset > 0)
 812           O << ") + " << Offset;
 813         else if (Offset < 0)
 814           O << ") - " << -Offset;
 815       } else {
 816         EmitConstantValueOnly(ptrVal);
 817       }
 818       break;
 819     }
 820     case Instruction::Trunc:
 821     case Instruction::ZExt:
 822     case Instruction::SExt:
 823     case Instruction::FPTrunc:
 824     case Instruction::FPExt:
 825     case Instruction::UIToFP:
 826     case Instruction::SIToFP:
 827     case Instruction::FPToUI:
 828     case Instruction::FPToSI:
 829       assert(0 && "FIXME: Don't yet support this kind of constant cast expr");
 830       break;
 831     case Instruction::BitCast:
 832       return EmitConstantValueOnly(CE->getOperand(0));
 833
 834     case Instruction::IntToPtr: {
 835       // Handle casts to pointers by changing them into casts to the appropriate
 836       // integer type.  This promotes constant folding and simplifies this code.
 837       Constant *Op = CE->getOperand(0);
 838       Op = ConstantExpr::getIntegerCast(Op, TD->getIntPtrType(), false/*ZExt*/);
 839       return EmitConstantValueOnly(Op);
 840     }
 841
 842
 843     case Instruction::PtrToInt: {
 844       // Support only foldable casts to/from pointers that can be eliminated by
 845       // changing the pointer to the appropriately sized integer type.
 846       Constant *Op = CE->getOperand(0);
 847       const Type *Ty = CE->getType();
 848
 849       // We can emit the pointer value into this slot if the slot is an
 850       // integer slot greater or equal to the size of the pointer.
 851       if (TD->getABITypeSize(Ty) >= TD->getABITypeSize(Op->getType()))
 852         return EmitConstantValueOnly(Op);
 853
 854       O << "((";
 855       EmitConstantValueOnly(Op);
 856       APInt ptrMask = APInt::getAllOnesValue(TD->getABITypeSizeInBits(Ty));
 857
 858       SmallString<40> S;
 859       ptrMask.toStringUnsigned(S);
 860       O << ") & " << S.c_str() << ')';
 861       break;
 862     }
 863     case Instruction::Add:
 864     case Instruction::Sub:
 865     case Instruction::And:
 866     case Instruction::Or:
 867     case Instruction::Xor:
 868       O << '(';
 869       EmitConstantValueOnly(CE->getOperand(0));
 870       O << ')';
 871       switch (Opcode) {
 872       case Instruction::Add:
 873        O << " + ";
 874        break;
 875       case Instruction::Sub:
 876        O << " - ";
 877        break;
 878       case Instruction::And:
 879        O << " & ";
 880        break;
 881       case Instruction::Or:
 882        O << " | ";
 883        break;
 884       case Instruction::Xor:
 885        O << " ^ ";
 886        break;
 887       default:
 888        break;
 889       }
 890       O << '(';
 891       EmitConstantValueOnly(CE->getOperand(1));
 892       O << ')';
 893       break;
 894     default:
 895       assert(0 && "Unsupported operator!");
 896     }
 897   } else {
 898     assert(0 && "Unknown constant value!");
 899   }
 900 }
 901
 902 /// printAsCString - Print the specified array as a C compatible string, only if
 903 /// the predicate isString is true.
 904 ///
 905 static void printAsCString(raw_ostream &O, const ConstantArray *CVA,
 906                            unsigned LastElt) {
 907   assert(CVA->isString() && "Array is not string compatible!");
 908
 909   O << '\"';
 910   for (unsigned i = 0; i != LastElt; ++i) {
 911     unsigned char C =
 912         (unsigned char)cast<ConstantInt>(CVA->getOperand(i))->getZExtValue();
 913     printStringChar(O, C);
 914   }
 915   O << '\"';
 916 }
 917
 918 /// EmitString - Emit a zero-byte-terminated string constant.
 919 ///
 920 void AsmPrinter::EmitString(const ConstantArray *CVA) const {
 921   unsigned NumElts = CVA->getNumOperands();
 922   if (TAI->getAscizDirective() && NumElts &&
 923       cast<ConstantInt>(CVA->getOperand(NumElts-1))->getZExtValue() == 0) {
 924     O << TAI->getAscizDirective();
 925     printAsCString(O, CVA, NumElts-1);
 926   } else {
 927     O << TAI->getAsciiDirective();
 928     printAsCString(O, CVA, NumElts);
 929   }
 930   O << '\n';
 931 }
 932
 933 /// EmitGlobalConstant - Print a general LLVM constant to the .s file.
 934 void AsmPrinter::EmitGlobalConstant(const Constant *CV) {
 935   const TargetData *TD = TM.getTargetData();
 936   unsigned Size = TD->getABITypeSize(CV->getType());
 937
 938   if (CV->isNullValue() || isa<UndefValue>(CV)) {
 939     EmitZeros(Size);
 940     return;
 941   } else if (const ConstantArray *CVA = dyn_cast<ConstantArray>(CV)) {
 942     if (CVA->isString()) {
 943       EmitString(CVA);
 944     } else { // Not a string.  Print the values in successive locations
 945       for (unsigned i = 0, e = CVA->getNumOperands(); i != e; ++i)
 946         EmitGlobalConstant(CVA->getOperand(i));
 947     }
 948     return;
 949   } else if (const ConstantStruct *CVS = dyn_cast<ConstantStruct>(CV)) {
 950     // Print the fields in successive locations. Pad to align if needed!
 951     const StructLayout *cvsLayout = TD->getStructLayout(CVS->getType());
 952     uint64_t sizeSoFar = 0;
 953     for (unsigned i = 0, e = CVS->getNumOperands(); i != e; ++i) {
 954       const Constant* field = CVS->getOperand(i);
 955
 956       // Check if padding is needed and insert one or more 0s.
 957       uint64_t fieldSize = TD->getABITypeSize(field->getType());
 958       uint64_t padSize = ((i == e-1 ? Size : cvsLayout->getElementOffset(i+1))
 959                           - cvsLayout->getElementOffset(i)) - fieldSize;
 960       sizeSoFar += fieldSize + padSize;
 961
 962       // Now print the actual field value.
 963       EmitGlobalConstant(field);
 964
 965       // Insert padding - this may include padding to increase the size of the
 966       // current field up to the ABI size (if the struct is not packed) as well
 967       // as padding to ensure that the next field starts at the right offset.
 968       EmitZeros(padSize);
 969     }
 970     assert(sizeSoFar == cvsLayout->getSizeInBytes() &&
 971            "Layout of constant struct may be incorrect!");
 972     return;
 973   } else if (const ConstantFP *CFP = dyn_cast<ConstantFP>(CV)) {
 974     // FP Constants are printed as integer constants to avoid losing
 975     // precision...
 976     if (CFP->getType() == Type::DoubleTy) {
 977       double Val = CFP->getValueAPF().convertToDouble();  // for comment only
 978       uint64_t i = CFP->getValueAPF().convertToAPInt().getZExtValue();
 979       if (TAI->getData64bitsDirective())
 980         O << TAI->getData64bitsDirective() << i << '\t'
 981           << TAI->getCommentString() << " double value: " << Val << '\n';
 982       else if (TD->isBigEndian()) {
 983         O << TAI->getData32bitsDirective() << unsigned(i >> 32)
 984           << '\t' << TAI->getCommentString()
 985           << " double most significant word " << Val << '\n';
 986         O << TAI->getData32bitsDirective() << unsigned(i)
 987           << '\t' << TAI->getCommentString()
 988           << " double least significant word " << Val << '\n';
 989       } else {
 990         O << TAI->getData32bitsDirective() << unsigned(i)
 991           << '\t' << TAI->getCommentString()
 992           << " double least significant word " << Val << '\n';
 993         O << TAI->getData32bitsDirective() << unsigned(i >> 32)
 994           << '\t' << TAI->getCommentString()
 995           << " double most significant word " << Val << '\n';
 996       }
 997       return;
 998     } else if (CFP->getType() == Type::FloatTy) {
 999       float Val = CFP->getValueAPF().convertToFloat();  // for comment only
1000       O << TAI->getData32bitsDirective()
1001         << CFP->getValueAPF().convertToAPInt().getZExtValue()
1002         << '\t' << TAI->getCommentString() << " float " << Val << '\n';
1003       return;
1004     } else if (CFP->getType() == Type::X86_FP80Ty) {
1005       // all long double variants are printed as hex
1006       // api needed to prevent premature destruction
1007       APInt api = CFP->getValueAPF().convertToAPInt();
1008       const uint64_t *p = api.getRawData();
1009       APFloat DoubleVal = CFP->getValueAPF();
1010       DoubleVal.convert(APFloat::IEEEdouble, APFloat::rmNearestTiesToEven);
1011       if (TD->isBigEndian()) {
1012         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 48)
1013           << '\t' << TAI->getCommentString()
1014           << " long double most significant halfword of ~"
1015           << DoubleVal.convertToDouble() << '\n';
1016         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 32)
1017           << '\t' << TAI->getCommentString()
1018           << " long double next halfword\n";
1019         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 16)
1020           << '\t' << TAI->getCommentString()
1021           << " long double next halfword\n";
1022         O << TAI->getData16bitsDirective() << uint16_t(p[0])
1023           << '\t' << TAI->getCommentString()
1024           << " long double next halfword\n";
1025         O << TAI->getData16bitsDirective() << uint16_t(p[1])
1026           << '\t' << TAI->getCommentString()
1027           << " long double least significant halfword\n";
1028        } else {
1029         O << TAI->getData16bitsDirective() << uint16_t(p[1])
1030           << '\t' << TAI->getCommentString()
1031           << " long double least significant halfword of ~"
1032           << DoubleVal.convertToDouble() << '\n';
1033         O << TAI->getData16bitsDirective() << uint16_t(p[0])
1034           << '\t' << TAI->getCommentString()
1035           << " long double next halfword\n";
1036         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 16)
1037           << '\t' << TAI->getCommentString()
1038           << " long double next halfword\n";
1039         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 32)
1040           << '\t' << TAI->getCommentString()
1041           << " long double next halfword\n";
1042         O << TAI->getData16bitsDirective() << uint16_t(p[0] >> 48)
1043           << '\t' << TAI->getCommentString()
1044           << " long double most significant halfword\n";
1045       }
1046       EmitZeros(Size - TD->getTypeStoreSize(Type::X86_FP80Ty));
1047       return;
1048     } else if (CFP->getType() == Type::PPC_FP128Ty) {
1049       // all long double variants are printed as hex
1050       // api needed to prevent premature destruction
1051       APInt api = CFP->getValueAPF().convertToAPInt();
1052       const uint64_t *p = api.getRawData();
1053       if (TD->isBigEndian()) {
1054         O << TAI->getData32bitsDirective() << uint32_t(p[0] >> 32)
1055           << '\t' << TAI->getCommentString()
1056           << " long double most significant word\n";
1057         O << TAI->getData32bitsDirective() << uint32_t(p[0])
1058           << '\t' << TAI->getCommentString()
1059           << " long double next word\n";
1060         O << TAI->getData32bitsDirective() << uint32_t(p[1] >> 32)
1061           << '\t' << TAI->getCommentString()
1062           << " long double next word\n";
1063         O << TAI->getData32bitsDirective() << uint32_t(p[1])
1064           << '\t' << TAI->getCommentString()
1065           << " long double least significant word\n";
1066        } else {
1067         O << TAI->getData32bitsDirective() << uint32_t(p[1])
1068           << '\t' << TAI->getCommentString()
1069           << " long double least significant word\n";
1070         O << TAI->getData32bitsDirective() << uint32_t(p[1] >> 32)
1071           << '\t' << TAI->getCommentString()
1072           << " long double next word\n";
1073         O << TAI->getData32bitsDirective() << uint32_t(p[0])
1074           << '\t' << TAI->getCommentString()
1075           << " long double next word\n";
1076         O << TAI->getData32bitsDirective() << uint32_t(p[0] >> 32)
1077           << '\t' << TAI->getCommentString()
1078           << " long double most significant word\n";
1079       }
1080       return;
1081     } else assert(0 && "Floating point constant type not handled");
1082   } else if (CV->getType()->isInteger() &&
1083              cast<IntegerType>(CV->getType())->getBitWidth() >= 64) {
1084     if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1085       unsigned BitWidth = CI->getBitWidth();
1086       assert(isPowerOf2_32(BitWidth) &&
1087              "Non-power-of-2-sized integers not handled!");
1088
1089       // We don't expect assemblers to support integer data directives
1090       // for more than 64 bits, so we emit the data in at most 64-bit
1091       // quantities at a time.
1092       const uint64_t *RawData = CI->getValue().getRawData();
1093       for (unsigned i = 0, e = BitWidth / 64; i != e; ++i) {
1094         uint64_t Val;
1095         if (TD->isBigEndian())
1096           Val = RawData[e - i - 1];
1097         else
1098           Val = RawData[i];
1099
1100         if (TAI->getData64bitsDirective())
1101           O << TAI->getData64bitsDirective() << Val << '\n';
1102         else if (TD->isBigEndian()) {
1103           O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
1104             << '\t' << TAI->getCommentString()
1105             << " Double-word most significant word " << Val << '\n';
1106           O << TAI->getData32bitsDirective() << unsigned(Val)
1107             << '\t' << TAI->getCommentString()
1108             << " Double-word least significant word " << Val << '\n';
1109         } else {
1110           O << TAI->getData32bitsDirective() << unsigned(Val)
1111             << '\t' << TAI->getCommentString()
1112             << " Double-word least significant word " << Val << '\n';
1113           O << TAI->getData32bitsDirective() << unsigned(Val >> 32)
1114             << '\t' << TAI->getCommentString()
1115             << " Double-word most significant word " << Val << '\n';
1116         }
1117       }
1118       return;
1119     }
1120   } else if (const ConstantVector *CP = dyn_cast<ConstantVector>(CV)) {
1121     const VectorType *PTy = CP->getType();
1122
1123     for (unsigned I = 0, E = PTy->getNumElements(); I < E; ++I)
1124       EmitGlobalConstant(CP->getOperand(I));
1125
1126     return;
1127   }
1128
1129   const Type *type = CV->getType();
1130   printDataDirective(type);
1131   EmitConstantValueOnly(CV);
1132   if (const ConstantInt *CI = dyn_cast<ConstantInt>(CV)) {
1133     SmallString<40> S;
1134     CI->getValue().toStringUnsigned(S, 16);
1135     O << "\t\t\t" << TAI->getCommentString() << " 0x" << S.c_str();
1136   }
1137   O << '\n';
1138 }
1139
1140 void AsmPrinter::EmitMachineConstantPoolValue(MachineConstantPoolValue *MCPV) {
1141   // Target doesn't support this yet!
1142   abort();
1143 }
1144
1145 /// PrintSpecial - Print information related to the specified machine instr
1146 /// that is independent of the operand, and may be independent of the instr
1147 /// itself.  This can be useful for portably encoding the comment character
1148 /// or other bits of target-specific knowledge into the asmstrings.  The
1149 /// syntax used is ${:comment}.  Targets can override this to add support
1150 /// for their own strange codes.
1151 void AsmPrinter::PrintSpecial(const MachineInstr *MI, const char *Code) {
1152   if (!strcmp(Code, "private")) {
1153     O << TAI->getPrivateGlobalPrefix();
1154   } else if (!strcmp(Code, "comment")) {
1155     O << TAI->getCommentString();
1156   } else if (!strcmp(Code, "uid")) {
1157     // Assign a unique ID to this machine instruction.
1158     static const MachineInstr *LastMI = 0;
1159     static const Function *F = 0;
1160     static unsigned Counter = 0U-1;
1161
1162     // Comparing the address of MI isn't sufficient, because machineinstrs may
1163     // be allocated to the same address across functions.
1164     const Function *ThisF = MI->getParent()->getParent()->getFunction();
1165
1166     // If this is a new machine instruction, bump the counter.
1167     if (LastMI != MI || F != ThisF) {
1168       ++Counter;
1169       LastMI = MI;
1170       F = ThisF;
1171     }
1172     O << Counter;
1173   } else {
1174     cerr << "Unknown special formatter '" << Code
1175          << "' for machine instr: " << *MI;
1176     exit(1);
1177   }
1178 }
1179
1180
1181 /// printInlineAsm - This method formats and prints the specified machine
1182 /// instruction that is an inline asm.
1183 void AsmPrinter::printInlineAsm(const MachineInstr *MI) const {
1184   unsigned NumOperands = MI->getNumOperands();
1185
1186   // Count the number of register definitions.
1187   unsigned NumDefs = 0;
1188   for (; MI->getOperand(NumDefs).isRegister() && MI->getOperand(NumDefs).isDef();
1189        ++NumDefs)
1190     assert(NumDefs != NumOperands-1 && "No asm string?");
1191
1192   assert(MI->getOperand(NumDefs).isExternalSymbol() && "No asm string?");
1193
1194   // Disassemble the AsmStr, printing out the literal pieces, the operands, etc.
1195   const char *AsmStr = MI->getOperand(NumDefs).getSymbolName();
1196
1197   // If this asmstr is empty, just print the #APP/#NOAPP markers.
1198   // These are useful to see where empty asm's wound up.
1199   if (AsmStr[0] == 0) {
1200     O << TAI->getInlineAsmStart() << "\n\t" << TAI->getInlineAsmEnd() << '\n';
1201     return;
1202   }
1203
1204   O << TAI->getInlineAsmStart() << "\n\t";
1205
1206   // The variant of the current asmprinter.
1207   int AsmPrinterVariant = TAI->getAssemblerDialect();
1208
1209   int CurVariant = -1;            // The number of the {.|.|.} region we are in.
1210   const char *LastEmitted = AsmStr; // One past the last character emitted.
1211
1212   while (*LastEmitted) {
1213     switch (*LastEmitted) {
1214     default: {
1215       // Not a special case, emit the string section literally.
1216       const char *LiteralEnd = LastEmitted+1;
1217       while (*LiteralEnd && *LiteralEnd != '{' && *LiteralEnd != '|' &&
1218              *LiteralEnd != '}' && *LiteralEnd != '$' && *LiteralEnd != '\n')
1219         ++LiteralEnd;
1220       if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1221         O.write(LastEmitted, LiteralEnd-LastEmitted);
1222       LastEmitted = LiteralEnd;
1223       break;
1224     }
1225     case '\n':
1226       ++LastEmitted;   // Consume newline character.
1227       O << '\n';       // Indent code with newline.
1228       break;
1229     case '$': {
1230       ++LastEmitted;   // Consume '$' character.
1231       bool Done = true;
1232
1233       // Handle escapes.
1234       switch (*LastEmitted) {
1235       default: Done = false; break;
1236       case '$':     // $$ -> $
1237         if (CurVariant == -1 || CurVariant == AsmPrinterVariant)
1238           O << '$';
1239         ++LastEmitted;  // Consume second '$' character.
1240         break;
1241       case '(':             // $( -> same as GCC's { character.
1242         ++LastEmitted;      // Consume '(' character.
1243         if (CurVariant != -1) {
1244           cerr << "Nested variants found in inline asm string: '"
1245                << AsmStr << "'\n";
1246           exit(1);
1247         }
1248         CurVariant = 0;     // We're in the first variant now.
1249         break;
1250       case '|':
1251         ++LastEmitted;  // consume '|' character.
1252         if (CurVariant == -1) {
1253           cerr << "Found '|' character outside of variant in inline asm "
1254                << "string: '" << AsmStr << "'\n";
1255           exit(1);
1256         }
1257         ++CurVariant;   // We're in the next variant.
1258         break;
1259       case ')':         // $) -> same as GCC's } char.
1260         ++LastEmitted;  // consume ')' character.
1261         if (CurVariant == -1) {
1262           cerr << "Found '}' character outside of variant in inline asm "
1263                << "string: '" << AsmStr << "'\n";
1264           exit(1);
1265         }
1266         CurVariant = -1;
1267         break;
1268       }
1269       if (Done) break;
1270
1271       bool HasCurlyBraces = false;
1272       if (*LastEmitted == '{') {     // ${variable}
1273         ++LastEmitted;               // Consume '{' character.
1274         HasCurlyBraces = true;
1275       }
1276
1277       const char *IDStart = LastEmitted;
1278       char *IDEnd;
1279       errno = 0;
1280       long Val = strtol(IDStart, &IDEnd, 10); // We only accept numbers for IDs.
1281       if (!isdigit(*IDStart) || (Val == 0 && errno == EINVAL)) {
1282         cerr << "Bad $ operand number in inline asm string: '"
1283              << AsmStr << "'\n";
1284         exit(1);
1285       }
1286       LastEmitted = IDEnd;
1287
1288       char Modifier[2] = { 0, 0 };
1289
1290       if (HasCurlyBraces) {
1291         // If we have curly braces, check for a modifier character.  This
1292         // supports syntax like ${0:u}, which correspond to "%u0" in GCC asm.
1293         if (*LastEmitted == ':') {
1294           ++LastEmitted;    // Consume ':' character.
1295           if (*LastEmitted == 0) {
1296             cerr << "Bad ${:} expression in inline asm string: '"
1297                  << AsmStr << "'\n";
1298             exit(1);
1299           }
1300
1301           Modifier[0] = *LastEmitted;
1302           ++LastEmitted;    // Consume modifier character.
1303         }
1304
1305         if (*LastEmitted != '}') {
1306           cerr << "Bad ${} expression in inline asm string: '"
1307                << AsmStr << "'\n";
1308           exit(1);
1309         }
1310         ++LastEmitted;    // Consume '}' character.
1311       }
1312
1313       if ((unsigned)Val >= NumOperands-1) {
1314         cerr << "Invalid $ operand number in inline asm string: '"
1315              << AsmStr << "'\n";
1316         exit(1);
1317       }
1318
1319       // Okay, we finally have a value number.  Ask the target to print this
1320       // operand!
1321       if (CurVariant == -1 || CurVariant == AsmPrinterVariant) {
1322         unsigned OpNo = 1;
1323
1324         bool Error = false;
1325
1326         // Scan to find the machine operand number for the operand.
1327         for (; Val; --Val) {
1328           if (OpNo >= MI->getNumOperands()) break;
1329           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1330           OpNo += (OpFlags >> 3) + 1;
1331         }
1332
1333         if (OpNo >= MI->getNumOperands()) {
1334           Error = true;
1335         } else {
1336           unsigned OpFlags = MI->getOperand(OpNo).getImm();
1337           ++OpNo;  // Skip over the ID number.
1338
1339           if (Modifier[0]=='l')  // labels are target independent
1340             printBasicBlockLabel(MI->getOperand(OpNo).getMBB(),
1341                                  false, false, false);
1342           else {
1343             AsmPrinter *AP = const_cast<AsmPrinter*>(this);
1344             if ((OpFlags & 7) == 4) {
1345               Error = AP->PrintAsmMemoryOperand(MI, OpNo, AsmPrinterVariant,
1346                                                 Modifier[0] ? Modifier : 0);
1347             } else {
1348               Error = AP->PrintAsmOperand(MI, OpNo, AsmPrinterVariant,
1349                                           Modifier[0] ? Modifier : 0);
1350             }
1351           }
1352         }
1353         if (Error) {
1354           cerr << "Invalid operand found in inline asm: '"
1355                << AsmStr << "'\n";
1356           MI->dump();
1357           exit(1);
1358         }
1359       }
1360       break;
1361     }
1362     }
1363   }
1364   O << "\n\t" << TAI->getInlineAsmEnd() << '\n';
1365 }
1366
1367 /// printImplicitDef - This method prints the specified machine instruction
1368 /// that is an implicit def.
1369 void AsmPrinter::printImplicitDef(const MachineInstr *MI) const {
1370   O << '\t' << TAI->getCommentString() << " implicit-def: "
1371     << TRI->getAsmName(MI->getOperand(0).getReg()) << '\n';
1372 }
1373
1374 /// printLabel - This method prints a local label used by debug and
1375 /// exception handling tables.
1376 void AsmPrinter::printLabel(const MachineInstr *MI) const {
1377   printLabel(MI->getOperand(0).getImm());
1378 }
1379
1380 void AsmPrinter::printLabel(unsigned Id) const {
1381   O << TAI->getPrivateGlobalPrefix() << "label" << Id << ":\n";
1382 }
1383
1384 /// printDeclare - This method prints a local variable declaration used by
1385 /// debug tables.
1386 /// FIXME: It doesn't really print anything rather it inserts a DebugVariable
1387 /// entry into dwarf table.
1388 void AsmPrinter::printDeclare(const MachineInstr *MI) const {
1389   int FI = MI->getOperand(0).getIndex();
1390   GlobalValue *GV = MI->getOperand(1).getGlobal();
1391   MMI->RecordVariable(GV, FI);
1392 }
1393
1394 /// PrintAsmOperand - Print the specified operand of MI, an INLINEASM
1395 /// instruction, using the specified assembler variant.  Targets should
1396 /// overried this to format as appropriate.
1397 bool AsmPrinter::PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
1398                                  unsigned AsmVariant, const char *ExtraCode) {
1399   // Target doesn't support this yet!
1400   return true;
1401 }
1402
1403 bool AsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
1404                                        unsigned AsmVariant,
1405                                        const char *ExtraCode) {
1406   // Target doesn't support this yet!
1407   return true;
1408 }
1409
1410 /// printBasicBlockLabel - This method prints the label for the specified
1411 /// MachineBasicBlock
1412 void AsmPrinter::printBasicBlockLabel(const MachineBasicBlock *MBB,
1413                                       bool printAlign,
1414                                       bool printColon,
1415                                       bool printComment) const {
1416   if (printAlign) {
1417     unsigned Align = MBB->getAlignment();
1418     if (Align)
1419       EmitAlignment(Log2_32(Align));
1420   }
1421
1422   O << TAI->getPrivateGlobalPrefix() << "BB" << getFunctionNumber() << '_'
1423     << MBB->getNumber();
1424   if (printColon)
1425     O << ':';
1426   if (printComment && MBB->getBasicBlock())
1427     O << '\t' << TAI->getCommentString() << ' '
1428       << MBB->getBasicBlock()->getNameStart();
1429 }
1430
1431 /// printPICJumpTableSetLabel - This method prints a set label for the
1432 /// specified MachineBasicBlock for a jumptable entry.
1433 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid,
1434                                            const MachineBasicBlock *MBB) const {
1435   if (!TAI->getSetDirective())
1436     return;
1437
1438   O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1439     << getFunctionNumber() << '_' << uid << "_set_" << MBB->getNumber() << ',';
1440   printBasicBlockLabel(MBB, false, false, false);
1441   O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1442     << '_' << uid << '\n';
1443 }
1444
1445 void AsmPrinter::printPICJumpTableSetLabel(unsigned uid, unsigned uid2,
1446                                            const MachineBasicBlock *MBB) const {
1447   if (!TAI->getSetDirective())
1448     return;
1449
1450   O << TAI->getSetDirective() << ' ' << TAI->getPrivateGlobalPrefix()
1451     << getFunctionNumber() << '_' << uid << '_' << uid2
1452     << "_set_" << MBB->getNumber() << ',';
1453   printBasicBlockLabel(MBB, false, false, false);
1454   O << '-' << TAI->getPrivateGlobalPrefix() << "JTI" << getFunctionNumber()
1455     << '_' << uid << '_' << uid2 << '\n';
1456 }
1457
1458 /// printDataDirective - This method prints the asm directive for the
1459 /// specified type.
1460 void AsmPrinter::printDataDirective(const Type *type) {
1461   const TargetData *TD = TM.getTargetData();
1462   switch (type->getTypeID()) {
1463   case Type::IntegerTyID: {
1464     unsigned BitWidth = cast<IntegerType>(type)->getBitWidth();
1465     if (BitWidth <= 8)
1466       O << TAI->getData8bitsDirective();
1467     else if (BitWidth <= 16)
1468       O << TAI->getData16bitsDirective();
1469     else if (BitWidth <= 32)
1470       O << TAI->getData32bitsDirective();
1471     else if (BitWidth <= 64) {
1472       assert(TAI->getData64bitsDirective() &&
1473              "Target cannot handle 64-bit constant exprs!");
1474       O << TAI->getData64bitsDirective();
1475     } else {
1476       assert(0 && "Target cannot handle given data directive width!");
1477     }
1478     break;
1479   }
1480   case Type::PointerTyID:
1481     if (TD->getPointerSize() == 8) {
1482       assert(TAI->getData64bitsDirective() &&
1483              "Target cannot handle 64-bit pointer exprs!");
1484       O << TAI->getData64bitsDirective();
1485     } else {
1486       O << TAI->getData32bitsDirective();
1487     }
1488     break;
1489   case Type::FloatTyID: case Type::DoubleTyID:
1490   case Type::X86_FP80TyID: case Type::FP128TyID: case Type::PPC_FP128TyID:
1491     assert (0 && "Should have already output floating point constant.");
1492   default:
1493     assert (0 && "Can't handle printing this type of thing");
1494     break;
1495   }
1496 }
1497
1498 void AsmPrinter::printSuffixedName(const char *Name, const char *Suffix,
1499                                    const char *Prefix) {
1500   if (Name[0]=='\"')
1501     O << '\"';
1502   O << TAI->getPrivateGlobalPrefix();
1503   if (Prefix) O << Prefix;
1504   if (Name[0]=='\"')
1505     O << '\"';
1506   if (Name[0]=='\"')
1507     O << Name[1];
1508   else
1509     O << Name;
1510   O << Suffix;
1511   if (Name[0]=='\"')
1512     O << '\"';
1513 }
1514
1515 void AsmPrinter::printSuffixedName(const std::string &Name, const char* Suffix) {
1516   printSuffixedName(Name.c_str(), Suffix);
1517 }
1518
1519 void AsmPrinter::printVisibility(const std::string& Name,
1520                                  unsigned Visibility) const {
1521   if (Visibility == GlobalValue::HiddenVisibility) {
1522     if (const char *Directive = TAI->getHiddenDirective())
1523       O << Directive << Name << '\n';
1524   } else if (Visibility == GlobalValue::ProtectedVisibility) {
1525     if (const char *Directive = TAI->getProtectedDirective())
1526       O << Directive << Name << '\n';
1527   }
1528 }
1529
1530 GCMetadataPrinter *AsmPrinter::GetOrCreateGCPrinter(GCStrategy *S) {
1531   if (!S->usesMetadata())
1532     return 0;
1533
1534   gcp_iterator GCPI = GCMetadataPrinters.find(S);
1535   if (GCPI != GCMetadataPrinters.end())
1536     return GCPI->second;
1537
1538   const char *Name = S->getName().c_str();
1539
1540   for (GCMetadataPrinterRegistry::iterator
1541          I = GCMetadataPrinterRegistry::begin(),
1542          E = GCMetadataPrinterRegistry::end(); I != E; ++I)
1543     if (strcmp(Name, I->getName()) == 0) {
1544       GCMetadataPrinter *GMP = I->instantiate();
1545       GMP->S = S;
1546       GCMetadataPrinters.insert(std::make_pair(S, GMP));
1547       return GMP;
1548     }
1549
1550   cerr << "no GCMetadataPrinter registered for GC: " << Name << "\n";
1551   abort();
1552 }