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