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