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