lib/MC/MCAssembler.cpp

   1 //===- lib/MC/MCAssembler.cpp - Assembler Backend Implementation ----------===//
   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 #include "llvm/MC/MCAssembler.h"
  11 #include "llvm/ADT/Statistic.h"
  12 #include "llvm/ADT/StringExtras.h"
  13 #include "llvm/ADT/Twine.h"
  14 #include "llvm/MC/MCAsmBackend.h"
  15 #include "llvm/MC/MCAsmInfo.h"
  16 #include "llvm/MC/MCAsmLayout.h"
  17 #include "llvm/MC/MCCodeEmitter.h"
  18 #include "llvm/MC/MCContext.h"
  19 #include "llvm/MC/MCDwarf.h"
  20 #include "llvm/MC/MCExpr.h"
  21 #include "llvm/MC/MCFixupKindInfo.h"
  22 #include "llvm/MC/MCObjectWriter.h"
  23 #include "llvm/MC/MCSection.h"
  24 #include "llvm/MC/MCSectionELF.h"
  25 #include "llvm/MC/MCSymbol.h"
  26 #include "llvm/MC/MCValue.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29 #include "llvm/Support/LEB128.h"
  30 #include "llvm/Support/TargetRegistry.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include <tuple>
  33 using namespace llvm;
  34
  35 #define DEBUG_TYPE "assembler"
  36
  37 namespace {
  38 namespace stats {
  39 STATISTIC(EmittedFragments, "Number of emitted assembler fragments - total");
  40 STATISTIC(EmittedRelaxableFragments,
  41           "Number of emitted assembler fragments - relaxable");
  42 STATISTIC(EmittedDataFragments,
  43           "Number of emitted assembler fragments - data");
  44 STATISTIC(EmittedCompactEncodedInstFragments,
  45           "Number of emitted assembler fragments - compact encoded inst");
  46 STATISTIC(EmittedAlignFragments,
  47           "Number of emitted assembler fragments - align");
  48 STATISTIC(EmittedFillFragments,
  49           "Number of emitted assembler fragments - fill");
  50 STATISTIC(EmittedOrgFragments,
  51           "Number of emitted assembler fragments - org");
  52 STATISTIC(evaluateFixup, "Number of evaluated fixups");
  53 STATISTIC(FragmentLayouts, "Number of fragment layouts");
  54 STATISTIC(ObjectBytes, "Number of emitted object file bytes");
  55 STATISTIC(RelaxationSteps, "Number of assembler layout and relaxation steps");
  56 STATISTIC(RelaxedInstructions, "Number of relaxed instructions");
  57 }
  58 }
  59
  60 // FIXME FIXME FIXME: There are number of places in this file where we convert
  61 // what is a 64-bit assembler value used for computation into a value in the
  62 // object file, which may truncate it. We should detect that truncation where
  63 // invalid and report errors back.
  64
  65 /* *** */
  66
  67 MCAsmLayout::MCAsmLayout(MCAssembler &Asm)
  68   : Assembler(Asm), LastValidFragment()
  69  {
  70   // Compute the section layout order. Virtual sections must go last.
  71   for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
  72     if (!it->getSection().isVirtualSection())
  73       SectionOrder.push_back(&*it);
  74   for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
  75     if (it->getSection().isVirtualSection())
  76       SectionOrder.push_back(&*it);
  77 }
  78
  79 bool MCAsmLayout::isFragmentValid(const MCFragment *F) const {
  80   const MCSectionData &SD = *F->getParent();
  81   const MCFragment *LastValid = LastValidFragment.lookup(&SD);
  82   if (!LastValid)
  83     return false;
  84   assert(LastValid->getParent() == F->getParent());
  85   return F->getLayoutOrder() <= LastValid->getLayoutOrder();
  86 }
  87
  88 void MCAsmLayout::invalidateFragmentsFrom(MCFragment *F) {
  89   // If this fragment wasn't already valid, we don't need to do anything.
  90   if (!isFragmentValid(F))
  91     return;
  92
  93   // Otherwise, reset the last valid fragment to the previous fragment
  94   // (if this is the first fragment, it will be NULL).
  95   const MCSectionData &SD = *F->getParent();
  96   LastValidFragment[&SD] = F->getPrevNode();
  97 }
  98
  99 void MCAsmLayout::ensureValid(const MCFragment *F) const {
 100   MCSectionData &SD = *F->getParent();
 101
 102   MCFragment *Cur = LastValidFragment[&SD];
 103   if (!Cur)
 104     Cur = &*SD.begin();
 105   else
 106     Cur = Cur->getNextNode();
 107
 108   // Advance the layout position until the fragment is valid.
 109   while (!isFragmentValid(F)) {
 110     assert(Cur && "Layout bookkeeping error");
 111     const_cast<MCAsmLayout*>(this)->layoutFragment(Cur);
 112     Cur = Cur->getNextNode();
 113   }
 114 }
 115
 116 uint64_t MCAsmLayout::getFragmentOffset(const MCFragment *F) const {
 117   ensureValid(F);
 118   assert(F->Offset != ~UINT64_C(0) && "Address not set!");
 119   return F->Offset;
 120 }
 121
 122 // Simple getSymbolOffset helper for the non-varibale case.
 123 static bool getLabelOffset(const MCAsmLayout &Layout, const MCSymbolData &SD,
 124                            bool ReportError, uint64_t &Val) {
 125   if (!SD.getFragment()) {
 126     if (ReportError)
 127       report_fatal_error("unable to evaluate offset to undefined symbol '" +
 128                          SD.getSymbol().getName() + "'");
 129     return false;
 130   }
 131   Val = Layout.getFragmentOffset(SD.getFragment()) + SD.getOffset();
 132   return true;
 133 }
 134
 135 static bool getSymbolOffsetImpl(const MCAsmLayout &Layout,
 136                                 const MCSymbolData *SD, bool ReportError,
 137                                 uint64_t &Val) {
 138   const MCSymbol &S = SD->getSymbol();
 139
 140   if (!S.isVariable())
 141     return getLabelOffset(Layout, *SD, ReportError, Val);
 142
 143   // If SD is a variable, evaluate it.
 144   MCValue Target;
 145   if (!S.getVariableValue()->EvaluateAsRelocatable(Target, &Layout, nullptr))
 146     report_fatal_error("unable to evaluate offset for variable '" +
 147                        S.getName() + "'");
 148
 149   uint64_t Offset = Target.getConstant();
 150
 151   const MCAssembler &Asm = Layout.getAssembler();
 152
 153   const MCSymbolRefExpr *A = Target.getSymA();
 154   if (A) {
 155     uint64_t ValA;
 156     if (!getLabelOffset(Layout, Asm.getSymbolData(A->getSymbol()), ReportError,
 157                         ValA))
 158       return false;
 159     Offset += ValA;
 160   }
 161
 162   const MCSymbolRefExpr *B = Target.getSymB();
 163   if (B) {
 164     uint64_t ValB;
 165     if (!getLabelOffset(Layout, Asm.getSymbolData(B->getSymbol()), ReportError,
 166                         ValB))
 167       return false;
 168     Offset -= ValB;
 169   }
 170
 171   Val = Offset;
 172   return true;
 173 }
 174
 175 bool MCAsmLayout::getSymbolOffset(const MCSymbolData *SD, uint64_t &Val) const {
 176   return getSymbolOffsetImpl(*this, SD, false, Val);
 177 }
 178
 179 uint64_t MCAsmLayout::getSymbolOffset(const MCSymbolData *SD) const {
 180   uint64_t Val;
 181   getSymbolOffsetImpl(*this, SD, true, Val);
 182   return Val;
 183 }
 184
 185 const MCSymbol *MCAsmLayout::getBaseSymbol(const MCSymbol &Symbol) const {
 186   if (!Symbol.isVariable())
 187     return &Symbol;
 188
 189   const MCExpr *Expr = Symbol.getVariableValue();
 190   MCValue Value;
 191   if (!Expr->evaluateAsValue(Value, *this))
 192     llvm_unreachable("Invalid Expression");
 193
 194   const MCSymbolRefExpr *RefB = Value.getSymB();
 195   if (RefB)
 196     Assembler.getContext().FatalError(
 197         SMLoc(), Twine("symbol '") + RefB->getSymbol().getName() +
 198                      "' could not be evaluated in a subtraction expression");
 199
 200   const MCSymbolRefExpr *A = Value.getSymA();
 201   if (!A)
 202     return nullptr;
 203
 204   const MCSymbol &ASym = A->getSymbol();
 205   const MCAssembler &Asm = getAssembler();
 206   const MCSymbolData &ASD = Asm.getSymbolData(ASym);
 207   if (ASD.isCommon()) {
 208     // FIXME: we should probably add a SMLoc to MCExpr.
 209     Asm.getContext().FatalError(SMLoc(),
 210                                 "Common symbol " + ASym.getName() +
 211                                     " cannot be used in assignment expr");
 212   }
 213
 214   return &ASym;
 215 }
 216
 217 uint64_t MCAsmLayout::getSectionAddressSize(const MCSectionData *SD) const {
 218   // The size is the last fragment's end offset.
 219   const MCFragment &F = SD->getFragmentList().back();
 220   return getFragmentOffset(&F) + getAssembler().computeFragmentSize(*this, F);
 221 }
 222
 223 uint64_t MCAsmLayout::getSectionFileSize(const MCSectionData *SD) const {
 224   // Virtual sections have no file size.
 225   if (SD->getSection().isVirtualSection())
 226     return 0;
 227
 228   // Otherwise, the file size is the same as the address space size.
 229   return getSectionAddressSize(SD);
 230 }
 231
 232 uint64_t llvm::computeBundlePadding(const MCAssembler &Assembler,
 233                                     const MCFragment *F,
 234                                     uint64_t FOffset, uint64_t FSize) {
 235   uint64_t BundleSize = Assembler.getBundleAlignSize();
 236   assert(BundleSize > 0 &&
 237          "computeBundlePadding should only be called if bundling is enabled");
 238   uint64_t BundleMask = BundleSize - 1;
 239   uint64_t OffsetInBundle = FOffset & BundleMask;
 240   uint64_t EndOfFragment = OffsetInBundle + FSize;
 241
 242   // There are two kinds of bundling restrictions:
 243   //
 244   // 1) For alignToBundleEnd(), add padding to ensure that the fragment will
 245   //    *end* on a bundle boundary.
 246   // 2) Otherwise, check if the fragment would cross a bundle boundary. If it
 247   //    would, add padding until the end of the bundle so that the fragment
 248   //    will start in a new one.
 249   if (F->alignToBundleEnd()) {
 250     // Three possibilities here:
 251     //
 252     // A) The fragment just happens to end at a bundle boundary, so we're good.
 253     // B) The fragment ends before the current bundle boundary: pad it just
 254     //    enough to reach the boundary.
 255     // C) The fragment ends after the current bundle boundary: pad it until it
 256     //    reaches the end of the next bundle boundary.
 257     //
 258     // Note: this code could be made shorter with some modulo trickery, but it's
 259     // intentionally kept in its more explicit form for simplicity.
 260     if (EndOfFragment == BundleSize)
 261       return 0;
 262     else if (EndOfFragment < BundleSize)
 263       return BundleSize - EndOfFragment;
 264     else { // EndOfFragment > BundleSize
 265       return 2 * BundleSize - EndOfFragment;
 266     }
 267   } else if (EndOfFragment > BundleSize)
 268     return BundleSize - OffsetInBundle;
 269   else
 270     return 0;
 271 }
 272
 273 /* *** */
 274
 275 MCFragment::MCFragment() : Kind(FragmentType(~0)) {
 276 }
 277
 278 MCFragment::~MCFragment() {
 279 }
 280
 281 MCFragment::MCFragment(FragmentType Kind, MCSectionData *Parent)
 282     : Kind(Kind), Parent(Parent), Atom(nullptr), Offset(~UINT64_C(0)) {
 283   if (Parent)
 284     Parent->getFragmentList().push_back(this);
 285 }
 286
 287 /* *** */
 288
 289 MCEncodedFragment::~MCEncodedFragment() {
 290 }
 291
 292 /* *** */
 293
 294 MCEncodedFragmentWithFixups::~MCEncodedFragmentWithFixups() {
 295 }
 296
 297 /* *** */
 298
 299 MCSectionData::MCSectionData() : Section(nullptr) {}
 300
 301 MCSectionData::MCSectionData(const MCSection &Section, MCAssembler *A)
 302     : Section(&Section), Ordinal(~UINT32_C(0)), Alignment(1),
 303       BundleLockState(NotBundleLocked), BundleLockNestingDepth(0),
 304       BundleGroupBeforeFirstInst(false), HasInstructions(false) {
 305   if (A)
 306     A->getSectionList().push_back(this);
 307 }
 308
 309 MCSectionData::iterator
 310 MCSectionData::getSubsectionInsertionPoint(unsigned Subsection) {
 311   if (Subsection == 0 && SubsectionFragmentMap.empty())
 312     return end();
 313
 314   SmallVectorImpl<std::pair<unsigned, MCFragment *> >::iterator MI =
 315     std::lower_bound(SubsectionFragmentMap.begin(), SubsectionFragmentMap.end(),
 316                      std::make_pair(Subsection, (MCFragment *)nullptr));
 317   bool ExactMatch = false;
 318   if (MI != SubsectionFragmentMap.end()) {
 319     ExactMatch = MI->first == Subsection;
 320     if (ExactMatch)
 321       ++MI;
 322   }
 323   iterator IP;
 324   if (MI == SubsectionFragmentMap.end())
 325     IP = end();
 326   else
 327     IP = MI->second;
 328   if (!ExactMatch && Subsection != 0) {
 329     // The GNU as documentation claims that subsections have an alignment of 4,
 330     // although this appears not to be the case.
 331     MCFragment *F = new MCDataFragment();
 332     SubsectionFragmentMap.insert(MI, std::make_pair(Subsection, F));
 333     getFragmentList().insert(IP, F);
 334     F->setParent(this);
 335   }
 336
 337   return IP;
 338 }
 339
 340 void MCSectionData::setBundleLockState(BundleLockStateType NewState) {
 341   if (NewState == NotBundleLocked) {
 342     if (BundleLockNestingDepth == 0) {
 343       report_fatal_error("Mismatched bundle_lock/unlock directives");
 344     }
 345     if (--BundleLockNestingDepth == 0) {
 346       BundleLockState = NotBundleLocked;
 347     }
 348     return;
 349   }
 350
 351   // If any of the directives is an align_to_end directive, the whole nested
 352   // group is align_to_end. So don't downgrade from align_to_end to just locked.
 353   if (BundleLockState != BundleLockedAlignToEnd) {
 354     BundleLockState = NewState;
 355   }
 356   ++BundleLockNestingDepth;
 357 }
 358
 359 /* *** */
 360
 361 MCSymbolData::MCSymbolData() : Symbol(nullptr) {}
 362
 363 void MCSymbolData::initialize(const MCSymbol &Symbol, MCFragment *Fragment,
 364                               uint64_t Offset) {
 365   assert(!isInitialized() && "Expected uninitialized symbol");
 366
 367   this->Symbol = &Symbol;
 368   this->Fragment.setPointer(Fragment);
 369   this->Offset = Offset;
 370   this->SymbolSize = nullptr;
 371   this->CommonAlign = -1U;
 372   this->Flags = 0;
 373   this->Index = 0;
 374 }
 375
 376 /* *** */
 377
 378 MCAssembler::MCAssembler(MCContext &Context_, MCAsmBackend &Backend_,
 379                          MCCodeEmitter &Emitter_, MCObjectWriter &Writer_,
 380                          raw_ostream &OS_)
 381     : Context(Context_), Backend(Backend_), Emitter(Emitter_), Writer(Writer_),
 382       OS(OS_), BundleAlignSize(0), RelaxAll(false),
 383       SubsectionsViaSymbols(false), ELFHeaderEFlags(0) {
 384   VersionMinInfo.Major = 0; // Major version == 0 for "none specified"
 385 }
 386
 387 MCAssembler::~MCAssembler() {
 388 }
 389
 390 void MCAssembler::reset() {
 391   Sections.clear();
 392   Symbols.clear();
 393   SectionMap.clear();
 394   IndirectSymbols.clear();
 395   DataRegions.clear();
 396   LinkerOptions.clear();
 397   FileNames.clear();
 398   ThumbFuncs.clear();
 399   BundleAlignSize = 0;
 400   RelaxAll = false;
 401   SubsectionsViaSymbols = false;
 402   ELFHeaderEFlags = 0;
 403   LOHContainer.reset();
 404   VersionMinInfo.Major = 0;
 405
 406   // reset objects owned by us
 407   getBackend().reset();
 408   getEmitter().reset();
 409   getWriter().reset();
 410   getLOHContainer().reset();
 411 }
 412
 413 bool MCAssembler::isThumbFunc(const MCSymbol *Symbol) const {
 414   if (ThumbFuncs.count(Symbol))
 415     return true;
 416
 417   if (!Symbol->isVariable())
 418     return false;
 419
 420   // FIXME: It looks like gas supports some cases of the form "foo + 2". It
 421   // is not clear if that is a bug or a feature.
 422   const MCExpr *Expr = Symbol->getVariableValue();
 423   const MCSymbolRefExpr *Ref = dyn_cast<MCSymbolRefExpr>(Expr);
 424   if (!Ref)
 425     return false;
 426
 427   if (Ref->getKind() != MCSymbolRefExpr::VK_None)
 428     return false;
 429
 430   const MCSymbol &Sym = Ref->getSymbol();
 431   if (!isThumbFunc(&Sym))
 432     return false;
 433
 434   ThumbFuncs.insert(Symbol); // Cache it.
 435   return true;
 436 }
 437
 438 void MCAssembler::addLocalUsedInReloc(const MCSymbol &Sym) {
 439   assert(Sym.isTemporary());
 440   LocalsUsedInReloc.insert(&Sym);
 441 }
 442
 443 bool MCAssembler::isLocalUsedInReloc(const MCSymbol &Sym) const {
 444   assert(Sym.isTemporary());
 445   return LocalsUsedInReloc.count(&Sym);
 446 }
 447
 448 bool MCAssembler::isSymbolLinkerVisible(const MCSymbol &Symbol) const {
 449   // Non-temporary labels should always be visible to the linker.
 450   if (!Symbol.isTemporary())
 451     return true;
 452
 453   // Absolute temporary labels are never visible.
 454   if (!Symbol.isInSection())
 455     return false;
 456
 457   if (isLocalUsedInReloc(Symbol))
 458     return true;
 459
 460   return false;
 461 }
 462
 463 const MCSymbol *MCAssembler::getAtom(const MCSymbolData *SD) const {
 464   // Linker visible symbols define atoms.
 465   if (isSymbolLinkerVisible(SD->getSymbol()))
 466     return &SD->getSymbol();
 467
 468   // Absolute and undefined symbols have no defining atom.
 469   if (!SD->getFragment())
 470     return nullptr;
 471
 472   // Non-linker visible symbols in sections which can't be atomized have no
 473   // defining atom.
 474   if (!getContext().getAsmInfo()->isSectionAtomizableBySymbols(
 475           SD->getFragment()->getParent()->getSection()))
 476     return nullptr;
 477
 478   // Otherwise, return the atom for the containing fragment.
 479   return SD->getFragment()->getAtom();
 480 }
 481
 482 bool MCAssembler::evaluateFixup(const MCAsmLayout &Layout,
 483                                 const MCFixup &Fixup, const MCFragment *DF,
 484                                 MCValue &Target, uint64_t &Value) const {
 485   ++stats::evaluateFixup;
 486
 487   // FIXME: This code has some duplication with RecordRelocation. We should
 488   // probably merge the two into a single callback that tries to evaluate a
 489   // fixup and records a relocation if one is needed.
 490   const MCExpr *Expr = Fixup.getValue();
 491   if (!Expr->EvaluateAsRelocatable(Target, &Layout, &Fixup))
 492     getContext().FatalError(Fixup.getLoc(), "expected relocatable expression");
 493
 494   bool IsPCRel = Backend.getFixupKindInfo(
 495     Fixup.getKind()).Flags & MCFixupKindInfo::FKF_IsPCRel;
 496
 497   bool IsResolved;
 498   if (IsPCRel) {
 499     if (Target.getSymB()) {
 500       IsResolved = false;
 501     } else if (!Target.getSymA()) {
 502       IsResolved = false;
 503     } else {
 504       const MCSymbolRefExpr *A = Target.getSymA();
 505       const MCSymbol &SA = A->getSymbol();
 506       if (A->getKind() != MCSymbolRefExpr::VK_None || SA.isUndefined()) {
 507         IsResolved = false;
 508       } else {
 509         IsResolved = getWriter().IsSymbolRefDifferenceFullyResolvedImpl(
 510             *this, SA, *DF, false, true);
 511       }
 512     }
 513   } else {
 514     IsResolved = Target.isAbsolute();
 515   }
 516
 517   Value = Target.getConstant();
 518
 519   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 520     const MCSymbol &Sym = A->getSymbol();
 521     if (Sym.isDefined())
 522       Value += Layout.getSymbolOffset(&getSymbolData(Sym));
 523   }
 524   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 525     const MCSymbol &Sym = B->getSymbol();
 526     if (Sym.isDefined())
 527       Value -= Layout.getSymbolOffset(&getSymbolData(Sym));
 528   }
 529
 530
 531   bool ShouldAlignPC = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
 532                          MCFixupKindInfo::FKF_IsAlignedDownTo32Bits;
 533   assert((ShouldAlignPC ? IsPCRel : true) &&
 534     "FKF_IsAlignedDownTo32Bits is only allowed on PC-relative fixups!");
 535
 536   if (IsPCRel) {
 537     uint32_t Offset = Layout.getFragmentOffset(DF) + Fixup.getOffset();
 538
 539     // A number of ARM fixups in Thumb mode require that the effective PC
 540     // address be determined as the 32-bit aligned version of the actual offset.
 541     if (ShouldAlignPC) Offset &= ~0x3;
 542     Value -= Offset;
 543   }
 544
 545   // Let the backend adjust the fixup value if necessary, including whether
 546   // we need a relocation.
 547   Backend.processFixupValue(*this, Layout, Fixup, DF, Target, Value,
 548                             IsResolved);
 549
 550   return IsResolved;
 551 }
 552
 553 uint64_t MCAssembler::computeFragmentSize(const MCAsmLayout &Layout,
 554                                           const MCFragment &F) const {
 555   switch (F.getKind()) {
 556   case MCFragment::FT_Data:
 557   case MCFragment::FT_Relaxable:
 558   case MCFragment::FT_CompactEncodedInst:
 559     return cast<MCEncodedFragment>(F).getContents().size();
 560   case MCFragment::FT_Fill:
 561     return cast<MCFillFragment>(F).getSize();
 562
 563   case MCFragment::FT_LEB:
 564     return cast<MCLEBFragment>(F).getContents().size();
 565
 566   case MCFragment::FT_Align: {
 567     const MCAlignFragment &AF = cast<MCAlignFragment>(F);
 568     unsigned Offset = Layout.getFragmentOffset(&AF);
 569     unsigned Size = OffsetToAlignment(Offset, AF.getAlignment());
 570     // If we are padding with nops, force the padding to be larger than the
 571     // minimum nop size.
 572     if (Size > 0 && AF.hasEmitNops()) {
 573       while (Size % getBackend().getMinimumNopSize())
 574         Size += AF.getAlignment();
 575     }
 576     if (Size > AF.getMaxBytesToEmit())
 577       return 0;
 578     return Size;
 579   }
 580
 581   case MCFragment::FT_Org: {
 582     const MCOrgFragment &OF = cast<MCOrgFragment>(F);
 583     int64_t TargetLocation;
 584     if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, Layout))
 585       report_fatal_error("expected assembly-time absolute expression");
 586
 587     // FIXME: We need a way to communicate this error.
 588     uint64_t FragmentOffset = Layout.getFragmentOffset(&OF);
 589     int64_t Size = TargetLocation - FragmentOffset;
 590     if (Size < 0 || Size >= 0x40000000)
 591       report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
 592                          "' (at offset '" + Twine(FragmentOffset) + "')");
 593     return Size;
 594   }
 595
 596   case MCFragment::FT_Dwarf:
 597     return cast<MCDwarfLineAddrFragment>(F).getContents().size();
 598   case MCFragment::FT_DwarfFrame:
 599     return cast<MCDwarfCallFrameFragment>(F).getContents().size();
 600   }
 601
 602   llvm_unreachable("invalid fragment kind");
 603 }
 604
 605 void MCAsmLayout::layoutFragment(MCFragment *F) {
 606   MCFragment *Prev = F->getPrevNode();
 607
 608   // We should never try to recompute something which is valid.
 609   assert(!isFragmentValid(F) && "Attempt to recompute a valid fragment!");
 610   // We should never try to compute the fragment layout if its predecessor
 611   // isn't valid.
 612   assert((!Prev || isFragmentValid(Prev)) &&
 613          "Attempt to compute fragment before its predecessor!");
 614
 615   ++stats::FragmentLayouts;
 616
 617   // Compute fragment offset and size.
 618   if (Prev)
 619     F->Offset = Prev->Offset + getAssembler().computeFragmentSize(*this, *Prev);
 620   else
 621     F->Offset = 0;
 622   LastValidFragment[F->getParent()] = F;
 623
 624   // If bundling is enabled and this fragment has instructions in it, it has to
 625   // obey the bundling restrictions. With padding, we'll have:
 626   //
 627   //
 628   //        BundlePadding
 629   //             |||
 630   // -------------------------------------
 631   //   Prev  |##########|       F        |
 632   // -------------------------------------
 633   //                    ^
 634   //                    |
 635   //                    F->Offset
 636   //
 637   // The fragment's offset will point to after the padding, and its computed
 638   // size won't include the padding.
 639   //
 640   // When the -mc-relax-all flag is used, we optimize bundling by writting the
 641   // bundle padding directly into fragments when the instructions are emitted
 642   // inside the streamer.
 643   //
 644   if (Assembler.isBundlingEnabled() && !Assembler.getRelaxAll() &&
 645       F->hasInstructions()) {
 646     assert(isa<MCEncodedFragment>(F) &&
 647            "Only MCEncodedFragment implementations have instructions");
 648     uint64_t FSize = Assembler.computeFragmentSize(*this, *F);
 649
 650     if (FSize > Assembler.getBundleAlignSize())
 651       report_fatal_error("Fragment can't be larger than a bundle size");
 652
 653     uint64_t RequiredBundlePadding = computeBundlePadding(Assembler, F,
 654                                                           F->Offset, FSize);
 655     if (RequiredBundlePadding > UINT8_MAX)
 656       report_fatal_error("Padding cannot exceed 255 bytes");
 657     F->setBundlePadding(static_cast<uint8_t>(RequiredBundlePadding));
 658     F->Offset += RequiredBundlePadding;
 659   }
 660 }
 661
 662 /// \brief Write the contents of a fragment to the given object writer. Expects
 663 ///        a MCEncodedFragment.
 664 static void writeFragmentContents(const MCFragment &F, MCObjectWriter *OW) {
 665   const MCEncodedFragment &EF = cast<MCEncodedFragment>(F);
 666   OW->WriteBytes(EF.getContents());
 667 }
 668
 669 void MCAssembler::writeFragmentPadding(const MCFragment &F, uint64_t FSize,
 670                                        MCObjectWriter *OW) const {
 671   // Should NOP padding be written out before this fragment?
 672   unsigned BundlePadding = F.getBundlePadding();
 673   if (BundlePadding > 0) {
 674     assert(isBundlingEnabled() &&
 675            "Writing bundle padding with disabled bundling");
 676     assert(F.hasInstructions() &&
 677            "Writing bundle padding for a fragment without instructions");
 678
 679     unsigned TotalLength = BundlePadding + static_cast<unsigned>(FSize);
 680     if (F.alignToBundleEnd() && TotalLength > getBundleAlignSize()) {
 681       // If the padding itself crosses a bundle boundary, it must be emitted
 682       // in 2 pieces, since even nop instructions must not cross boundaries.
 683       //             v--------------v   <- BundleAlignSize
 684       //        v---------v             <- BundlePadding
 685       // ----------------------------
 686       // | Prev |####|####|    F    |
 687       // ----------------------------
 688       //        ^-------------------^   <- TotalLength
 689       unsigned DistanceToBoundary = TotalLength - getBundleAlignSize();
 690       if (!getBackend().writeNopData(DistanceToBoundary, OW))
 691           report_fatal_error("unable to write NOP sequence of " +
 692                              Twine(DistanceToBoundary) + " bytes");
 693       BundlePadding -= DistanceToBoundary;
 694     }
 695     if (!getBackend().writeNopData(BundlePadding, OW))
 696       report_fatal_error("unable to write NOP sequence of " +
 697                          Twine(BundlePadding) + " bytes");
 698   }
 699 }
 700
 701 /// \brief Write the fragment \p F to the output file.
 702 static void writeFragment(const MCAssembler &Asm, const MCAsmLayout &Layout,
 703                           const MCFragment &F) {
 704   MCObjectWriter *OW = &Asm.getWriter();
 705
 706   // FIXME: Embed in fragments instead?
 707   uint64_t FragmentSize = Asm.computeFragmentSize(Layout, F);
 708
 709   Asm.writeFragmentPadding(F, FragmentSize, OW);
 710
 711   // This variable (and its dummy usage) is to participate in the assert at
 712   // the end of the function.
 713   uint64_t Start = OW->getStream().tell();
 714   (void) Start;
 715
 716   ++stats::EmittedFragments;
 717
 718   switch (F.getKind()) {
 719   case MCFragment::FT_Align: {
 720     ++stats::EmittedAlignFragments;
 721     const MCAlignFragment &AF = cast<MCAlignFragment>(F);
 722     assert(AF.getValueSize() && "Invalid virtual align in concrete fragment!");
 723
 724     uint64_t Count = FragmentSize / AF.getValueSize();
 725
 726     // FIXME: This error shouldn't actually occur (the front end should emit
 727     // multiple .align directives to enforce the semantics it wants), but is
 728     // severe enough that we want to report it. How to handle this?
 729     if (Count * AF.getValueSize() != FragmentSize)
 730       report_fatal_error("undefined .align directive, value size '" +
 731                         Twine(AF.getValueSize()) +
 732                         "' is not a divisor of padding size '" +
 733                         Twine(FragmentSize) + "'");
 734
 735     // See if we are aligning with nops, and if so do that first to try to fill
 736     // the Count bytes.  Then if that did not fill any bytes or there are any
 737     // bytes left to fill use the Value and ValueSize to fill the rest.
 738     // If we are aligning with nops, ask that target to emit the right data.
 739     if (AF.hasEmitNops()) {
 740       if (!Asm.getBackend().writeNopData(Count, OW))
 741         report_fatal_error("unable to write nop sequence of " +
 742                           Twine(Count) + " bytes");
 743       break;
 744     }
 745
 746     // Otherwise, write out in multiples of the value size.
 747     for (uint64_t i = 0; i != Count; ++i) {
 748       switch (AF.getValueSize()) {
 749       default: llvm_unreachable("Invalid size!");
 750       case 1: OW->Write8 (uint8_t (AF.getValue())); break;
 751       case 2: OW->Write16(uint16_t(AF.getValue())); break;
 752       case 4: OW->Write32(uint32_t(AF.getValue())); break;
 753       case 8: OW->Write64(uint64_t(AF.getValue())); break;
 754       }
 755     }
 756     break;
 757   }
 758
 759   case MCFragment::FT_Data:
 760     ++stats::EmittedDataFragments;
 761     writeFragmentContents(F, OW);
 762     break;
 763
 764   case MCFragment::FT_Relaxable:
 765     ++stats::EmittedRelaxableFragments;
 766     writeFragmentContents(F, OW);
 767     break;
 768
 769   case MCFragment::FT_CompactEncodedInst:
 770     ++stats::EmittedCompactEncodedInstFragments;
 771     writeFragmentContents(F, OW);
 772     break;
 773
 774   case MCFragment::FT_Fill: {
 775     ++stats::EmittedFillFragments;
 776     const MCFillFragment &FF = cast<MCFillFragment>(F);
 777
 778     assert(FF.getValueSize() && "Invalid virtual align in concrete fragment!");
 779
 780     for (uint64_t i = 0, e = FF.getSize() / FF.getValueSize(); i != e; ++i) {
 781       switch (FF.getValueSize()) {
 782       default: llvm_unreachable("Invalid size!");
 783       case 1: OW->Write8 (uint8_t (FF.getValue())); break;
 784       case 2: OW->Write16(uint16_t(FF.getValue())); break;
 785       case 4: OW->Write32(uint32_t(FF.getValue())); break;
 786       case 8: OW->Write64(uint64_t(FF.getValue())); break;
 787       }
 788     }
 789     break;
 790   }
 791
 792   case MCFragment::FT_LEB: {
 793     const MCLEBFragment &LF = cast<MCLEBFragment>(F);
 794     OW->WriteBytes(LF.getContents());
 795     break;
 796   }
 797
 798   case MCFragment::FT_Org: {
 799     ++stats::EmittedOrgFragments;
 800     const MCOrgFragment &OF = cast<MCOrgFragment>(F);
 801
 802     for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
 803       OW->Write8(uint8_t(OF.getValue()));
 804
 805     break;
 806   }
 807
 808   case MCFragment::FT_Dwarf: {
 809     const MCDwarfLineAddrFragment &OF = cast<MCDwarfLineAddrFragment>(F);
 810     OW->WriteBytes(OF.getContents());
 811     break;
 812   }
 813   case MCFragment::FT_DwarfFrame: {
 814     const MCDwarfCallFrameFragment &CF = cast<MCDwarfCallFrameFragment>(F);
 815     OW->WriteBytes(CF.getContents());
 816     break;
 817   }
 818   }
 819
 820   assert(OW->getStream().tell() - Start == FragmentSize &&
 821          "The stream should advance by fragment size");
 822 }
 823
 824 void MCAssembler::writeSectionData(const MCSectionData *SD,
 825                                    const MCAsmLayout &Layout) const {
 826   // Ignore virtual sections.
 827   if (SD->getSection().isVirtualSection()) {
 828     assert(Layout.getSectionFileSize(SD) == 0 && "Invalid size for section!");
 829
 830     // Check that contents are only things legal inside a virtual section.
 831     for (MCSectionData::const_iterator it = SD->begin(),
 832            ie = SD->end(); it != ie; ++it) {
 833       switch (it->getKind()) {
 834       default: llvm_unreachable("Invalid fragment in virtual section!");
 835       case MCFragment::FT_Data: {
 836         // Check that we aren't trying to write a non-zero contents (or fixups)
 837         // into a virtual section. This is to support clients which use standard
 838         // directives to fill the contents of virtual sections.
 839         const MCDataFragment &DF = cast<MCDataFragment>(*it);
 840         assert(DF.fixup_begin() == DF.fixup_end() &&
 841                "Cannot have fixups in virtual section!");
 842         for (unsigned i = 0, e = DF.getContents().size(); i != e; ++i)
 843           if (DF.getContents()[i]) {
 844             if (auto *ELFSec = dyn_cast<const MCSectionELF>(&SD->getSection()))
 845               report_fatal_error("non-zero initializer found in section '" +
 846                   ELFSec->getSectionName() + "'");
 847             else
 848               report_fatal_error("non-zero initializer found in virtual section");
 849           }
 850         break;
 851       }
 852       case MCFragment::FT_Align:
 853         // Check that we aren't trying to write a non-zero value into a virtual
 854         // section.
 855         assert((cast<MCAlignFragment>(it)->getValueSize() == 0 ||
 856                 cast<MCAlignFragment>(it)->getValue() == 0) &&
 857                "Invalid align in virtual section!");
 858         break;
 859       case MCFragment::FT_Fill:
 860         assert((cast<MCFillFragment>(it)->getValueSize() == 0 ||
 861                 cast<MCFillFragment>(it)->getValue() == 0) &&
 862                "Invalid fill in virtual section!");
 863         break;
 864       }
 865     }
 866
 867     return;
 868   }
 869
 870   uint64_t Start = getWriter().getStream().tell();
 871   (void)Start;
 872
 873   for (MCSectionData::const_iterator it = SD->begin(), ie = SD->end();
 874        it != ie; ++it)
 875     writeFragment(*this, Layout, *it);
 876
 877   assert(getWriter().getStream().tell() - Start ==
 878          Layout.getSectionAddressSize(SD));
 879 }
 880
 881 std::pair<uint64_t, bool> MCAssembler::handleFixup(const MCAsmLayout &Layout,
 882                                                    MCFragment &F,
 883                                                    const MCFixup &Fixup) {
 884   // Evaluate the fixup.
 885   MCValue Target;
 886   uint64_t FixedValue;
 887   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
 888                  MCFixupKindInfo::FKF_IsPCRel;
 889   if (!evaluateFixup(Layout, Fixup, &F, Target, FixedValue)) {
 890     // The fixup was unresolved, we need a relocation. Inform the object
 891     // writer of the relocation, and give it an opportunity to adjust the
 892     // fixup value if need be.
 893     getWriter().RecordRelocation(*this, Layout, &F, Fixup, Target, IsPCRel,
 894                                  FixedValue);
 895   }
 896   return std::make_pair(FixedValue, IsPCRel);
 897 }
 898
 899 void MCAssembler::Finish() {
 900   DEBUG_WITH_TYPE("mc-dump", {
 901       llvm::errs() << "assembler backend - pre-layout\n--\n";
 902       dump(); });
 903
 904   // Create the layout object.
 905   MCAsmLayout Layout(*this);
 906
 907   // Create dummy fragments and assign section ordinals.
 908   unsigned SectionIndex = 0;
 909   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 910     // Create dummy fragments to eliminate any empty sections, this simplifies
 911     // layout.
 912     if (it->getFragmentList().empty())
 913       new MCDataFragment(it);
 914
 915     it->setOrdinal(SectionIndex++);
 916   }
 917
 918   // Assign layout order indices to sections and fragments.
 919   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i) {
 920     MCSectionData *SD = Layout.getSectionOrder()[i];
 921     SD->setLayoutOrder(i);
 922
 923     unsigned FragmentIndex = 0;
 924     for (MCSectionData::iterator iFrag = SD->begin(), iFragEnd = SD->end();
 925          iFrag != iFragEnd; ++iFrag)
 926       iFrag->setLayoutOrder(FragmentIndex++);
 927   }
 928
 929   // Layout until everything fits.
 930   while (layoutOnce(Layout))
 931     continue;
 932
 933   DEBUG_WITH_TYPE("mc-dump", {
 934       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 935       dump(); });
 936
 937   // Finalize the layout, including fragment lowering.
 938   finishLayout(Layout);
 939
 940   DEBUG_WITH_TYPE("mc-dump", {
 941       llvm::errs() << "assembler backend - final-layout\n--\n";
 942       dump(); });
 943
 944   uint64_t StartOffset = OS.tell();
 945
 946   // Allow the object writer a chance to perform post-layout binding (for
 947   // example, to set the index fields in the symbol data).
 948   getWriter().ExecutePostLayoutBinding(*this, Layout);
 949
 950   // Evaluate and apply the fixups, generating relocation entries as necessary.
 951   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 952     for (MCSectionData::iterator it2 = it->begin(),
 953            ie2 = it->end(); it2 != ie2; ++it2) {
 954       MCEncodedFragmentWithFixups *F =
 955         dyn_cast<MCEncodedFragmentWithFixups>(it2);
 956       if (F) {
 957         for (MCEncodedFragmentWithFixups::fixup_iterator it3 = F->fixup_begin(),
 958              ie3 = F->fixup_end(); it3 != ie3; ++it3) {
 959           MCFixup &Fixup = *it3;
 960           uint64_t FixedValue;
 961           bool IsPCRel;
 962           std::tie(FixedValue, IsPCRel) = handleFixup(Layout, *F, Fixup);
 963           getBackend().applyFixup(Fixup, F->getContents().data(),
 964                                   F->getContents().size(), FixedValue, IsPCRel);
 965         }
 966       }
 967     }
 968   }
 969
 970   // Write the object file.
 971   getWriter().WriteObject(*this, Layout);
 972
 973   stats::ObjectBytes += OS.tell() - StartOffset;
 974 }
 975
 976 bool MCAssembler::fixupNeedsRelaxation(const MCFixup &Fixup,
 977                                        const MCRelaxableFragment *DF,
 978                                        const MCAsmLayout &Layout) const {
 979   // If we cannot resolve the fixup value, it requires relaxation.
 980   MCValue Target;
 981   uint64_t Value;
 982   if (!evaluateFixup(Layout, Fixup, DF, Target, Value))
 983     return true;
 984
 985   return getBackend().fixupNeedsRelaxation(Fixup, Value, DF, Layout);
 986 }
 987
 988 bool MCAssembler::fragmentNeedsRelaxation(const MCRelaxableFragment *F,
 989                                           const MCAsmLayout &Layout) const {
 990   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 991   // are intentionally pushing out inst fragments, or because we relaxed a
 992   // previous instruction to one that doesn't need relaxation.
 993   if (!getBackend().mayNeedRelaxation(F->getInst()))
 994     return false;
 995
 996   for (MCRelaxableFragment::const_fixup_iterator it = F->fixup_begin(),
 997        ie = F->fixup_end(); it != ie; ++it)
 998     if (fixupNeedsRelaxation(*it, F, Layout))
 999       return true;
1000
1001   return false;
1002 }
1003
1004 bool MCAssembler::relaxInstruction(MCAsmLayout &Layout,
1005                                    MCRelaxableFragment &F) {
1006   if (!fragmentNeedsRelaxation(&F, Layout))
1007     return false;
1008
1009   ++stats::RelaxedInstructions;
1010
1011   // FIXME-PERF: We could immediately lower out instructions if we can tell
1012   // they are fully resolved, to avoid retesting on later passes.
1013
1014   // Relax the fragment.
1015
1016   MCInst Relaxed;
1017   getBackend().relaxInstruction(F.getInst(), Relaxed);
1018
1019   // Encode the new instruction.
1020   //
1021   // FIXME-PERF: If it matters, we could let the target do this. It can
1022   // probably do so more efficiently in many cases.
1023   SmallVector<MCFixup, 4> Fixups;
1024   SmallString<256> Code;
1025   raw_svector_ostream VecOS(Code);
1026   getEmitter().encodeInstruction(Relaxed, VecOS, Fixups, F.getSubtargetInfo());
1027   VecOS.flush();
1028
1029   // Update the fragment.
1030   F.setInst(Relaxed);
1031   F.getContents() = Code;
1032   F.getFixups() = Fixups;
1033
1034   return true;
1035 }
1036
1037 bool MCAssembler::relaxLEB(MCAsmLayout &Layout, MCLEBFragment &LF) {
1038   uint64_t OldSize = LF.getContents().size();
1039   int64_t Value;
1040   bool Abs = LF.getValue().evaluateKnownAbsolute(Value, Layout);
1041   if (!Abs)
1042     report_fatal_error("sleb128 and uleb128 expressions must be absolute");
1043   SmallString<8> &Data = LF.getContents();
1044   Data.clear();
1045   raw_svector_ostream OSE(Data);
1046   if (LF.isSigned())
1047     encodeSLEB128(Value, OSE);
1048   else
1049     encodeULEB128(Value, OSE);
1050   OSE.flush();
1051   return OldSize != LF.getContents().size();
1052 }
1053
1054 bool MCAssembler::relaxDwarfLineAddr(MCAsmLayout &Layout,
1055                                      MCDwarfLineAddrFragment &DF) {
1056   MCContext &Context = Layout.getAssembler().getContext();
1057   uint64_t OldSize = DF.getContents().size();
1058   int64_t AddrDelta;
1059   bool Abs = DF.getAddrDelta().evaluateKnownAbsolute(AddrDelta, Layout);
1060   assert(Abs && "We created a line delta with an invalid expression");
1061   (void) Abs;
1062   int64_t LineDelta;
1063   LineDelta = DF.getLineDelta();
1064   SmallString<8> &Data = DF.getContents();
1065   Data.clear();
1066   raw_svector_ostream OSE(Data);
1067   MCDwarfLineAddr::Encode(Context, LineDelta, AddrDelta, OSE);
1068   OSE.flush();
1069   return OldSize != Data.size();
1070 }
1071
1072 bool MCAssembler::relaxDwarfCallFrameFragment(MCAsmLayout &Layout,
1073                                               MCDwarfCallFrameFragment &DF) {
1074   MCContext &Context = Layout.getAssembler().getContext();
1075   uint64_t OldSize = DF.getContents().size();
1076   int64_t AddrDelta;
1077   bool Abs = DF.getAddrDelta().evaluateKnownAbsolute(AddrDelta, Layout);
1078   assert(Abs && "We created call frame with an invalid expression");
1079   (void) Abs;
1080   SmallString<8> &Data = DF.getContents();
1081   Data.clear();
1082   raw_svector_ostream OSE(Data);
1083   MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OSE);
1084   OSE.flush();
1085   return OldSize != Data.size();
1086 }
1087
1088 bool MCAssembler::layoutSectionOnce(MCAsmLayout &Layout, MCSectionData &SD) {
1089   // Holds the first fragment which needed relaxing during this layout. It will
1090   // remain NULL if none were relaxed.
1091   // When a fragment is relaxed, all the fragments following it should get
1092   // invalidated because their offset is going to change.
1093   MCFragment *FirstRelaxedFragment = nullptr;
1094
1095   // Attempt to relax all the fragments in the section.
1096   for (MCSectionData::iterator I = SD.begin(), IE = SD.end(); I != IE; ++I) {
1097     // Check if this is a fragment that needs relaxation.
1098     bool RelaxedFrag = false;
1099     switch(I->getKind()) {
1100     default:
1101       break;
1102     case MCFragment::FT_Relaxable:
1103       assert(!getRelaxAll() &&
1104              "Did not expect a MCRelaxableFragment in RelaxAll mode");
1105       RelaxedFrag = relaxInstruction(Layout, *cast<MCRelaxableFragment>(I));
1106       break;
1107     case MCFragment::FT_Dwarf:
1108       RelaxedFrag = relaxDwarfLineAddr(Layout,
1109                                        *cast<MCDwarfLineAddrFragment>(I));
1110       break;
1111     case MCFragment::FT_DwarfFrame:
1112       RelaxedFrag =
1113         relaxDwarfCallFrameFragment(Layout,
1114                                     *cast<MCDwarfCallFrameFragment>(I));
1115       break;
1116     case MCFragment::FT_LEB:
1117       RelaxedFrag = relaxLEB(Layout, *cast<MCLEBFragment>(I));
1118       break;
1119     }
1120     if (RelaxedFrag && !FirstRelaxedFragment)
1121       FirstRelaxedFragment = I;
1122   }
1123   if (FirstRelaxedFragment) {
1124     Layout.invalidateFragmentsFrom(FirstRelaxedFragment);
1125     return true;
1126   }
1127   return false;
1128 }
1129
1130 bool MCAssembler::layoutOnce(MCAsmLayout &Layout) {
1131   ++stats::RelaxationSteps;
1132
1133   bool WasRelaxed = false;
1134   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1135     MCSectionData &SD = *it;
1136     while (layoutSectionOnce(Layout, SD))
1137       WasRelaxed = true;
1138   }
1139
1140   return WasRelaxed;
1141 }
1142
1143 void MCAssembler::finishLayout(MCAsmLayout &Layout) {
1144   // The layout is done. Mark every fragment as valid.
1145   for (unsigned int i = 0, n = Layout.getSectionOrder().size(); i != n; ++i) {
1146     Layout.getFragmentOffset(&*Layout.getSectionOrder()[i]->rbegin());
1147   }
1148 }
1149
1150 // Debugging methods
1151
1152 namespace llvm {
1153
1154 raw_ostream &operator<<(raw_ostream &OS, const MCFixup &AF) {
1155   OS << "<MCFixup" << " Offset:" << AF.getOffset()
1156      << " Value:" << *AF.getValue()
1157      << " Kind:" << AF.getKind() << ">";
1158   return OS;
1159 }
1160
1161 }
1162
1163 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1164 void MCFragment::dump() {
1165   raw_ostream &OS = llvm::errs();
1166
1167   OS << "<";
1168   switch (getKind()) {
1169   case MCFragment::FT_Align: OS << "MCAlignFragment"; break;
1170   case MCFragment::FT_Data:  OS << "MCDataFragment"; break;
1171   case MCFragment::FT_CompactEncodedInst:
1172     OS << "MCCompactEncodedInstFragment"; break;
1173   case MCFragment::FT_Fill:  OS << "MCFillFragment"; break;
1174   case MCFragment::FT_Relaxable:  OS << "MCRelaxableFragment"; break;
1175   case MCFragment::FT_Org:   OS << "MCOrgFragment"; break;
1176   case MCFragment::FT_Dwarf: OS << "MCDwarfFragment"; break;
1177   case MCFragment::FT_DwarfFrame: OS << "MCDwarfCallFrameFragment"; break;
1178   case MCFragment::FT_LEB:   OS << "MCLEBFragment"; break;
1179   }
1180
1181   OS << "<MCFragment " << (void*) this << " LayoutOrder:" << LayoutOrder
1182      << " Offset:" << Offset
1183      << " HasInstructions:" << hasInstructions()
1184      << " BundlePadding:" << static_cast<unsigned>(getBundlePadding()) << ">";
1185
1186   switch (getKind()) {
1187   case MCFragment::FT_Align: {
1188     const MCAlignFragment *AF = cast<MCAlignFragment>(this);
1189     if (AF->hasEmitNops())
1190       OS << " (emit nops)";
1191     OS << "\n       ";
1192     OS << " Alignment:" << AF->getAlignment()
1193        << " Value:" << AF->getValue() << " ValueSize:" << AF->getValueSize()
1194        << " MaxBytesToEmit:" << AF->getMaxBytesToEmit() << ">";
1195     break;
1196   }
1197   case MCFragment::FT_Data:  {
1198     const MCDataFragment *DF = cast<MCDataFragment>(this);
1199     OS << "\n       ";
1200     OS << " Contents:[";
1201     const SmallVectorImpl<char> &Contents = DF->getContents();
1202     for (unsigned i = 0, e = Contents.size(); i != e; ++i) {
1203       if (i) OS << ",";
1204       OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1205     }
1206     OS << "] (" << Contents.size() << " bytes)";
1207
1208     if (DF->fixup_begin() != DF->fixup_end()) {
1209       OS << ",\n       ";
1210       OS << " Fixups:[";
1211       for (MCDataFragment::const_fixup_iterator it = DF->fixup_begin(),
1212              ie = DF->fixup_end(); it != ie; ++it) {
1213         if (it != DF->fixup_begin()) OS << ",\n                ";
1214         OS << *it;
1215       }
1216       OS << "]";
1217     }
1218     break;
1219   }
1220   case MCFragment::FT_CompactEncodedInst: {
1221     const MCCompactEncodedInstFragment *CEIF =
1222       cast<MCCompactEncodedInstFragment>(this);
1223     OS << "\n       ";
1224     OS << " Contents:[";
1225     const SmallVectorImpl<char> &Contents = CEIF->getContents();
1226     for (unsigned i = 0, e = Contents.size(); i != e; ++i) {
1227       if (i) OS << ",";
1228       OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1229     }
1230     OS << "] (" << Contents.size() << " bytes)";
1231     break;
1232   }
1233   case MCFragment::FT_Fill:  {
1234     const MCFillFragment *FF = cast<MCFillFragment>(this);
1235     OS << " Value:" << FF->getValue() << " ValueSize:" << FF->getValueSize()
1236        << " Size:" << FF->getSize();
1237     break;
1238   }
1239   case MCFragment::FT_Relaxable:  {
1240     const MCRelaxableFragment *F = cast<MCRelaxableFragment>(this);
1241     OS << "\n       ";
1242     OS << " Inst:";
1243     F->getInst().dump_pretty(OS);
1244     break;
1245   }
1246   case MCFragment::FT_Org:  {
1247     const MCOrgFragment *OF = cast<MCOrgFragment>(this);
1248     OS << "\n       ";
1249     OS << " Offset:" << OF->getOffset() << " Value:" << OF->getValue();
1250     break;
1251   }
1252   case MCFragment::FT_Dwarf:  {
1253     const MCDwarfLineAddrFragment *OF = cast<MCDwarfLineAddrFragment>(this);
1254     OS << "\n       ";
1255     OS << " AddrDelta:" << OF->getAddrDelta()
1256        << " LineDelta:" << OF->getLineDelta();
1257     break;
1258   }
1259   case MCFragment::FT_DwarfFrame:  {
1260     const MCDwarfCallFrameFragment *CF = cast<MCDwarfCallFrameFragment>(this);
1261     OS << "\n       ";
1262     OS << " AddrDelta:" << CF->getAddrDelta();
1263     break;
1264   }
1265   case MCFragment::FT_LEB: {
1266     const MCLEBFragment *LF = cast<MCLEBFragment>(this);
1267     OS << "\n       ";
1268     OS << " Value:" << LF->getValue() << " Signed:" << LF->isSigned();
1269     break;
1270   }
1271   }
1272   OS << ">";
1273 }
1274
1275 void MCSectionData::dump() {
1276   raw_ostream &OS = llvm::errs();
1277
1278   OS << "<MCSectionData";
1279   OS << " Alignment:" << getAlignment()
1280      << " Fragments:[\n      ";
1281   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1282     if (it != begin()) OS << ",\n      ";
1283     it->dump();
1284   }
1285   OS << "]>";
1286 }
1287
1288 void MCSymbolData::dump() const {
1289   raw_ostream &OS = llvm::errs();
1290
1291   OS << "<MCSymbolData Symbol:" << getSymbol()
1292      << " Fragment:" << getFragment();
1293   if (!isCommon())
1294     OS << " Offset:" << getOffset();
1295   OS << " Flags:" << getFlags() << " Index:" << getIndex();
1296   if (isCommon())
1297     OS << " (common, size:" << getCommonSize()
1298        << " align: " << getCommonAlignment() << ")";
1299   if (isExternal())
1300     OS << " (external)";
1301   if (isPrivateExtern())
1302     OS << " (private extern)";
1303   OS << ">";
1304 }
1305
1306 void MCAssembler::dump() {
1307   raw_ostream &OS = llvm::errs();
1308
1309   OS << "<MCAssembler\n";
1310   OS << "  Sections:[\n    ";
1311   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1312     if (it != begin()) OS << ",\n    ";
1313     it->dump();
1314   }
1315   OS << "],\n";
1316   OS << "  Symbols:[";
1317
1318   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
1319     if (it != symbol_begin()) OS << ",\n           ";
1320     it->dump();
1321   }
1322   OS << "]>\n";
1323 }
1324 #endif
1325
1326 // anchors for MC*Fragment vtables
1327 void MCEncodedFragment::anchor() { }
1328 void MCEncodedFragmentWithFixups::anchor() { }
1329 void MCDataFragment::anchor() { }
1330 void MCCompactEncodedInstFragment::anchor() { }
1331 void MCRelaxableFragment::anchor() { }
1332 void MCAlignFragment::anchor() { }
1333 void MCFillFragment::anchor() { }
1334 void MCOrgFragment::anchor() { }
1335 void MCLEBFragment::anchor() { }
1336 void MCDwarfLineAddrFragment::anchor() { }
1337 void MCDwarfCallFrameFragment::anchor() { }