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