lib/CodeGen/AsmPrinter.cpp

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