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   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 // Try to fully compute Expr to an absolute value and if that fails produce
 477 // a relocatable expr.
 478 // FIXME: Should this be the behavior of EvaluateAsRelocatable itself?
 479 static bool evaluate(const MCExpr &Expr, const MCAsmLayout &Layout,
 480                      const MCFixup &Fixup, MCValue &Target) {
 481   if (Expr.EvaluateAsValue(Target, &Layout, &Fixup)) {
 482     if (Target.isAbsolute())
 483       return true;
 484   }
 485   return Expr.EvaluateAsRelocatable(Target, &Layout, &Fixup);
 486 }
 487
 488 bool MCAssembler::evaluateFixup(const MCAsmLayout &Layout,
 489                                 const MCFixup &Fixup, const MCFragment *DF,
 490                                 MCValue &Target, uint64_t &Value) const {
 491   ++stats::evaluateFixup;
 492
 493   // FIXME: This code has some duplication with RecordRelocation. We should
 494   // probably merge the two into a single callback that tries to evaluate a
 495   // fixup and records a relocation if one is needed.
 496   const MCExpr *Expr = Fixup.getValue();
 497   if (!evaluate(*Expr, Layout, Fixup, Target))
 498     getContext().FatalError(Fixup.getLoc(), "expected relocatable expression");
 499
 500   bool IsPCRel = Backend.getFixupKindInfo(
 501     Fixup.getKind()).Flags & MCFixupKindInfo::FKF_IsPCRel;
 502
 503   bool IsResolved;
 504   if (IsPCRel) {
 505     if (Target.getSymB()) {
 506       IsResolved = false;
 507     } else if (!Target.getSymA()) {
 508       IsResolved = false;
 509     } else {
 510       const MCSymbolRefExpr *A = Target.getSymA();
 511       const MCSymbol &SA = A->getSymbol();
 512       if (A->getKind() != MCSymbolRefExpr::VK_None ||
 513           SA.AliasedSymbol().isUndefined()) {
 514         IsResolved = false;
 515       } else {
 516         const MCSymbolData &DataA = getSymbolData(SA);
 517         IsResolved =
 518           getWriter().IsSymbolRefDifferenceFullyResolvedImpl(*this, DataA,
 519                                                              *DF, false, true);
 520       }
 521     }
 522   } else {
 523     IsResolved = Target.isAbsolute();
 524   }
 525
 526   Value = Target.getConstant();
 527
 528   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 529     const MCSymbol &Sym = A->getSymbol().AliasedSymbol();
 530     if (Sym.isDefined())
 531       Value += Layout.getSymbolOffset(&getSymbolData(Sym));
 532   }
 533   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 534     const MCSymbol &Sym = B->getSymbol().AliasedSymbol();
 535     if (Sym.isDefined())
 536       Value -= Layout.getSymbolOffset(&getSymbolData(Sym));
 537   }
 538
 539
 540   bool ShouldAlignPC = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
 541                          MCFixupKindInfo::FKF_IsAlignedDownTo32Bits;
 542   assert((ShouldAlignPC ? IsPCRel : true) &&
 543     "FKF_IsAlignedDownTo32Bits is only allowed on PC-relative fixups!");
 544
 545   if (IsPCRel) {
 546     uint32_t Offset = Layout.getFragmentOffset(DF) + Fixup.getOffset();
 547
 548     // A number of ARM fixups in Thumb mode require that the effective PC
 549     // address be determined as the 32-bit aligned version of the actual offset.
 550     if (ShouldAlignPC) Offset &= ~0x3;
 551     Value -= Offset;
 552   }
 553
 554   // Let the backend adjust the fixup value if necessary, including whether
 555   // we need a relocation.
 556   Backend.processFixupValue(*this, Layout, Fixup, DF, Target, Value,
 557                             IsResolved);
 558
 559   return IsResolved;
 560 }
 561
 562 uint64_t MCAssembler::computeFragmentSize(const MCAsmLayout &Layout,
 563                                           const MCFragment &F) const {
 564   switch (F.getKind()) {
 565   case MCFragment::FT_Data:
 566   case MCFragment::FT_Relaxable:
 567   case MCFragment::FT_CompactEncodedInst:
 568     return cast<MCEncodedFragment>(F).getContents().size();
 569   case MCFragment::FT_Fill:
 570     return cast<MCFillFragment>(F).getSize();
 571
 572   case MCFragment::FT_LEB:
 573     return cast<MCLEBFragment>(F).getContents().size();
 574
 575   case MCFragment::FT_Align: {
 576     const MCAlignFragment &AF = cast<MCAlignFragment>(F);
 577     unsigned Offset = Layout.getFragmentOffset(&AF);
 578     unsigned Size = OffsetToAlignment(Offset, AF.getAlignment());
 579     // If we are padding with nops, force the padding to be larger than the
 580     // minimum nop size.
 581     if (Size > 0 && AF.hasEmitNops()) {
 582       while (Size % getBackend().getMinimumNopSize())
 583         Size += AF.getAlignment();
 584     }
 585     if (Size > AF.getMaxBytesToEmit())
 586       return 0;
 587     return Size;
 588   }
 589
 590   case MCFragment::FT_Org: {
 591     const MCOrgFragment &OF = cast<MCOrgFragment>(F);
 592     int64_t TargetLocation;
 593     if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, Layout))
 594       report_fatal_error("expected assembly-time absolute expression");
 595
 596     // FIXME: We need a way to communicate this error.
 597     uint64_t FragmentOffset = Layout.getFragmentOffset(&OF);
 598     int64_t Size = TargetLocation - FragmentOffset;
 599     if (Size < 0 || Size >= 0x40000000)
 600       report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
 601                          "' (at offset '" + Twine(FragmentOffset) + "')");
 602     return Size;
 603   }
 604
 605   case MCFragment::FT_Dwarf:
 606     return cast<MCDwarfLineAddrFragment>(F).getContents().size();
 607   case MCFragment::FT_DwarfFrame:
 608     return cast<MCDwarfCallFrameFragment>(F).getContents().size();
 609   }
 610
 611   llvm_unreachable("invalid fragment kind");
 612 }
 613
 614 void MCAsmLayout::layoutFragment(MCFragment *F) {
 615   MCFragment *Prev = F->getPrevNode();
 616
 617   // We should never try to recompute something which is valid.
 618   assert(!isFragmentValid(F) && "Attempt to recompute a valid fragment!");
 619   // We should never try to compute the fragment layout if its predecessor
 620   // isn't valid.
 621   assert((!Prev || isFragmentValid(Prev)) &&
 622          "Attempt to compute fragment before its predecessor!");
 623
 624   ++stats::FragmentLayouts;
 625
 626   // Compute fragment offset and size.
 627   if (Prev)
 628     F->Offset = Prev->Offset + getAssembler().computeFragmentSize(*this, *Prev);
 629   else
 630     F->Offset = 0;
 631   LastValidFragment[F->getParent()] = F;
 632
 633   // If bundling is enabled and this fragment has instructions in it, it has to
 634   // obey the bundling restrictions. With padding, we'll have:
 635   //
 636   //
 637   //        BundlePadding
 638   //             |||
 639   // -------------------------------------
 640   //   Prev  |##########|       F        |
 641   // -------------------------------------
 642   //                    ^
 643   //                    |
 644   //                    F->Offset
 645   //
 646   // The fragment's offset will point to after the padding, and its computed
 647   // size won't include the padding.
 648   //
 649   if (Assembler.isBundlingEnabled() && F->hasInstructions()) {
 650     assert(isa<MCEncodedFragment>(F) &&
 651            "Only MCEncodedFragment implementations have instructions");
 652     uint64_t FSize = Assembler.computeFragmentSize(*this, *F);
 653
 654     if (FSize > Assembler.getBundleAlignSize())
 655       report_fatal_error("Fragment can't be larger than a bundle size");
 656
 657     uint64_t RequiredBundlePadding = computeBundlePadding(F, F->Offset, FSize);
 658     if (RequiredBundlePadding > UINT8_MAX)
 659       report_fatal_error("Padding cannot exceed 255 bytes");
 660     F->setBundlePadding(static_cast<uint8_t>(RequiredBundlePadding));
 661     F->Offset += RequiredBundlePadding;
 662   }
 663 }
 664
 665 /// \brief Write the contents of a fragment to the given object writer. Expects
 666 ///        a MCEncodedFragment.
 667 static void writeFragmentContents(const MCFragment &F, MCObjectWriter *OW) {
 668   const MCEncodedFragment &EF = cast<MCEncodedFragment>(F);
 669   OW->WriteBytes(EF.getContents());
 670 }
 671
 672 /// \brief Write the fragment \p F to the output file.
 673 static void writeFragment(const MCAssembler &Asm, const MCAsmLayout &Layout,
 674                           const MCFragment &F) {
 675   MCObjectWriter *OW = &Asm.getWriter();
 676
 677   // FIXME: Embed in fragments instead?
 678   uint64_t FragmentSize = Asm.computeFragmentSize(Layout, F);
 679
 680   // Should NOP padding be written out before this fragment?
 681   unsigned BundlePadding = F.getBundlePadding();
 682   if (BundlePadding > 0) {
 683     assert(Asm.isBundlingEnabled() &&
 684            "Writing bundle padding with disabled bundling");
 685     assert(F.hasInstructions() &&
 686            "Writing bundle padding for a fragment without instructions");
 687
 688     unsigned TotalLength = BundlePadding + static_cast<unsigned>(FragmentSize);
 689     if (F.alignToBundleEnd() && TotalLength > Asm.getBundleAlignSize()) {
 690       // If the padding itself crosses a bundle boundary, it must be emitted
 691       // in 2 pieces, since even nop instructions must not cross boundaries.
 692       //             v--------------v   <- BundleAlignSize
 693       //        v---------v             <- BundlePadding
 694       // ----------------------------
 695       // | Prev |####|####|    F    |
 696       // ----------------------------
 697       //        ^-------------------^   <- TotalLength
 698       unsigned DistanceToBoundary = TotalLength - Asm.getBundleAlignSize();
 699       if (!Asm.getBackend().writeNopData(DistanceToBoundary, OW))
 700           report_fatal_error("unable to write NOP sequence of " +
 701                              Twine(DistanceToBoundary) + " bytes");
 702       BundlePadding -= DistanceToBoundary;
 703     }
 704     if (!Asm.getBackend().writeNopData(BundlePadding, OW))
 705       report_fatal_error("unable to write NOP sequence of " +
 706                          Twine(BundlePadding) + " bytes");
 707   }
 708
 709   // This variable (and its dummy usage) is to participate in the assert at
 710   // the end of the function.
 711   uint64_t Start = OW->getStream().tell();
 712   (void) Start;
 713
 714   ++stats::EmittedFragments;
 715
 716   switch (F.getKind()) {
 717   case MCFragment::FT_Align: {
 718     ++stats::EmittedAlignFragments;
 719     const MCAlignFragment &AF = cast<MCAlignFragment>(F);
 720     assert(AF.getValueSize() && "Invalid virtual align in concrete fragment!");
 721
 722     uint64_t Count = FragmentSize / AF.getValueSize();
 723
 724     // FIXME: This error shouldn't actually occur (the front end should emit
 725     // multiple .align directives to enforce the semantics it wants), but is
 726     // severe enough that we want to report it. How to handle this?
 727     if (Count * AF.getValueSize() != FragmentSize)
 728       report_fatal_error("undefined .align directive, value size '" +
 729                         Twine(AF.getValueSize()) +
 730                         "' is not a divisor of padding size '" +
 731                         Twine(FragmentSize) + "'");
 732
 733     // See if we are aligning with nops, and if so do that first to try to fill
 734     // the Count bytes.  Then if that did not fill any bytes or there are any
 735     // bytes left to fill use the Value and ValueSize to fill the rest.
 736     // If we are aligning with nops, ask that target to emit the right data.
 737     if (AF.hasEmitNops()) {
 738       if (!Asm.getBackend().writeNopData(Count, OW))
 739         report_fatal_error("unable to write nop sequence of " +
 740                           Twine(Count) + " bytes");
 741       break;
 742     }
 743
 744     // Otherwise, write out in multiples of the value size.
 745     for (uint64_t i = 0; i != Count; ++i) {
 746       switch (AF.getValueSize()) {
 747       default: llvm_unreachable("Invalid size!");
 748       case 1: OW->Write8 (uint8_t (AF.getValue())); break;
 749       case 2: OW->Write16(uint16_t(AF.getValue())); break;
 750       case 4: OW->Write32(uint32_t(AF.getValue())); break;
 751       case 8: OW->Write64(uint64_t(AF.getValue())); break;
 752       }
 753     }
 754     break;
 755   }
 756
 757   case MCFragment::FT_Data:
 758     ++stats::EmittedDataFragments;
 759     writeFragmentContents(F, OW);
 760     break;
 761
 762   case MCFragment::FT_Relaxable:
 763     ++stats::EmittedRelaxableFragments;
 764     writeFragmentContents(F, OW);
 765     break;
 766
 767   case MCFragment::FT_CompactEncodedInst:
 768     ++stats::EmittedCompactEncodedInstFragments;
 769     writeFragmentContents(F, OW);
 770     break;
 771
 772   case MCFragment::FT_Fill: {
 773     ++stats::EmittedFillFragments;
 774     const MCFillFragment &FF = cast<MCFillFragment>(F);
 775
 776     assert(FF.getValueSize() && "Invalid virtual align in concrete fragment!");
 777
 778     for (uint64_t i = 0, e = FF.getSize() / FF.getValueSize(); i != e; ++i) {
 779       switch (FF.getValueSize()) {
 780       default: llvm_unreachable("Invalid size!");
 781       case 1: OW->Write8 (uint8_t (FF.getValue())); break;
 782       case 2: OW->Write16(uint16_t(FF.getValue())); break;
 783       case 4: OW->Write32(uint32_t(FF.getValue())); break;
 784       case 8: OW->Write64(uint64_t(FF.getValue())); break;
 785       }
 786     }
 787     break;
 788   }
 789
 790   case MCFragment::FT_LEB: {
 791     const MCLEBFragment &LF = cast<MCLEBFragment>(F);
 792     OW->WriteBytes(LF.getContents());
 793     break;
 794   }
 795
 796   case MCFragment::FT_Org: {
 797     ++stats::EmittedOrgFragments;
 798     const MCOrgFragment &OF = cast<MCOrgFragment>(F);
 799
 800     for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
 801       OW->Write8(uint8_t(OF.getValue()));
 802
 803     break;
 804   }
 805
 806   case MCFragment::FT_Dwarf: {
 807     const MCDwarfLineAddrFragment &OF = cast<MCDwarfLineAddrFragment>(F);
 808     OW->WriteBytes(OF.getContents());
 809     break;
 810   }
 811   case MCFragment::FT_DwarfFrame: {
 812     const MCDwarfCallFrameFragment &CF = cast<MCDwarfCallFrameFragment>(F);
 813     OW->WriteBytes(CF.getContents());
 814     break;
 815   }
 816   }
 817
 818   assert(OW->getStream().tell() - Start == FragmentSize &&
 819          "The stream should advance by fragment size");
 820 }
 821
 822 void MCAssembler::writeSectionData(const MCSectionData *SD,
 823                                    const MCAsmLayout &Layout) const {
 824   // Ignore virtual sections.
 825   if (SD->getSection().isVirtualSection()) {
 826     assert(Layout.getSectionFileSize(SD) == 0 && "Invalid size for section!");
 827
 828     // Check that contents are only things legal inside a virtual section.
 829     for (MCSectionData::const_iterator it = SD->begin(),
 830            ie = SD->end(); it != ie; ++it) {
 831       switch (it->getKind()) {
 832       default: llvm_unreachable("Invalid fragment in virtual section!");
 833       case MCFragment::FT_Data: {
 834         // Check that we aren't trying to write a non-zero contents (or fixups)
 835         // into a virtual section. This is to support clients which use standard
 836         // directives to fill the contents of virtual sections.
 837         const MCDataFragment &DF = cast<MCDataFragment>(*it);
 838         assert(DF.fixup_begin() == DF.fixup_end() &&
 839                "Cannot have fixups in virtual section!");
 840         for (unsigned i = 0, e = DF.getContents().size(); i != e; ++i)
 841           if (DF.getContents()[i]) {
 842             if (auto *ELFSec = dyn_cast<const MCSectionELF>(&SD->getSection()))
 843               report_fatal_error("non-zero initializer found in section '" +
 844                   ELFSec->getSectionName() + "'");
 845             else
 846               report_fatal_error("non-zero initializer found in virtual section");
 847           }
 848         break;
 849       }
 850       case MCFragment::FT_Align:
 851         // Check that we aren't trying to write a non-zero value into a virtual
 852         // section.
 853         assert((cast<MCAlignFragment>(it)->getValueSize() == 0 ||
 854                 cast<MCAlignFragment>(it)->getValue() == 0) &&
 855                "Invalid align in virtual section!");
 856         break;
 857       case MCFragment::FT_Fill:
 858         assert((cast<MCFillFragment>(it)->getValueSize() == 0 ||
 859                 cast<MCFillFragment>(it)->getValue() == 0) &&
 860                "Invalid fill in virtual section!");
 861         break;
 862       }
 863     }
 864
 865     return;
 866   }
 867
 868   uint64_t Start = getWriter().getStream().tell();
 869   (void)Start;
 870
 871   for (MCSectionData::const_iterator it = SD->begin(), ie = SD->end();
 872        it != ie; ++it)
 873     writeFragment(*this, Layout, *it);
 874
 875   assert(getWriter().getStream().tell() - Start ==
 876          Layout.getSectionAddressSize(SD));
 877 }
 878
 879 std::pair<uint64_t, bool> MCAssembler::handleFixup(const MCAsmLayout &Layout,
 880                                                    MCFragment &F,
 881                                                    const MCFixup &Fixup) {
 882   // Evaluate the fixup.
 883   MCValue Target;
 884   uint64_t FixedValue;
 885   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
 886                  MCFixupKindInfo::FKF_IsPCRel;
 887   if (!evaluateFixup(Layout, Fixup, &F, Target, FixedValue)) {
 888     // The fixup was unresolved, we need a relocation. Inform the object
 889     // writer of the relocation, and give it an opportunity to adjust the
 890     // fixup value if need be.
 891     getWriter().RecordRelocation(*this, Layout, &F, Fixup, Target, IsPCRel,
 892                                  FixedValue);
 893   }
 894   return std::make_pair(FixedValue, IsPCRel);
 895 }
 896
 897 void MCAssembler::Finish() {
 898   DEBUG_WITH_TYPE("mc-dump", {
 899       llvm::errs() << "assembler backend - pre-layout\n--\n";
 900       dump(); });
 901
 902   // Create the layout object.
 903   MCAsmLayout Layout(*this);
 904
 905   // Create dummy fragments and assign section ordinals.
 906   unsigned SectionIndex = 0;
 907   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 908     // Create dummy fragments to eliminate any empty sections, this simplifies
 909     // layout.
 910     if (it->getFragmentList().empty())
 911       new MCDataFragment(it);
 912
 913     it->setOrdinal(SectionIndex++);
 914   }
 915
 916   // Assign layout order indices to sections and fragments.
 917   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i) {
 918     MCSectionData *SD = Layout.getSectionOrder()[i];
 919     SD->setLayoutOrder(i);
 920
 921     unsigned FragmentIndex = 0;
 922     for (MCSectionData::iterator iFrag = SD->begin(), iFragEnd = SD->end();
 923          iFrag != iFragEnd; ++iFrag)
 924       iFrag->setLayoutOrder(FragmentIndex++);
 925   }
 926
 927   // Layout until everything fits.
 928   while (layoutOnce(Layout))
 929     continue;
 930
 931   DEBUG_WITH_TYPE("mc-dump", {
 932       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 933       dump(); });
 934
 935   // Finalize the layout, including fragment lowering.
 936   finishLayout(Layout);
 937
 938   DEBUG_WITH_TYPE("mc-dump", {
 939       llvm::errs() << "assembler backend - final-layout\n--\n";
 940       dump(); });
 941
 942   uint64_t StartOffset = OS.tell();
 943
 944   // Allow the object writer a chance to perform post-layout binding (for
 945   // example, to set the index fields in the symbol data).
 946   getWriter().ExecutePostLayoutBinding(*this, Layout);
 947
 948   // Evaluate and apply the fixups, generating relocation entries as necessary.
 949   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 950     for (MCSectionData::iterator it2 = it->begin(),
 951            ie2 = it->end(); it2 != ie2; ++it2) {
 952       MCEncodedFragmentWithFixups *F =
 953         dyn_cast<MCEncodedFragmentWithFixups>(it2);
 954       if (F) {
 955         for (MCEncodedFragmentWithFixups::fixup_iterator it3 = F->fixup_begin(),
 956              ie3 = F->fixup_end(); it3 != ie3; ++it3) {
 957           MCFixup &Fixup = *it3;
 958           uint64_t FixedValue;
 959           bool IsPCRel;
 960           std::tie(FixedValue, IsPCRel) = handleFixup(Layout, *F, Fixup);
 961           getBackend().applyFixup(Fixup, F->getContents().data(),
 962                                   F->getContents().size(), FixedValue, IsPCRel);
 963         }
 964       }
 965     }
 966   }
 967
 968   // Write the object file.
 969   getWriter().WriteObject(*this, Layout);
 970
 971   stats::ObjectBytes += OS.tell() - StartOffset;
 972 }
 973
 974 bool MCAssembler::fixupNeedsRelaxation(const MCFixup &Fixup,
 975                                        const MCRelaxableFragment *DF,
 976                                        const MCAsmLayout &Layout) const {
 977   // If we cannot resolve the fixup value, it requires relaxation.
 978   MCValue Target;
 979   uint64_t Value;
 980   if (!evaluateFixup(Layout, Fixup, DF, Target, Value))
 981     return true;
 982
 983   return getBackend().fixupNeedsRelaxation(Fixup, Value, DF, Layout);
 984 }
 985
 986 bool MCAssembler::fragmentNeedsRelaxation(const MCRelaxableFragment *F,
 987                                           const MCAsmLayout &Layout) const {
 988   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 989   // are intentionally pushing out inst fragments, or because we relaxed a
 990   // previous instruction to one that doesn't need relaxation.
 991   if (!getBackend().mayNeedRelaxation(F->getInst()))
 992     return false;
 993
 994   for (MCRelaxableFragment::const_fixup_iterator it = F->fixup_begin(),
 995        ie = F->fixup_end(); it != ie; ++it)
 996     if (fixupNeedsRelaxation(*it, F, Layout))
 997       return true;
 998
 999   return false;
1000 }
1001
1002 bool MCAssembler::relaxInstruction(MCAsmLayout &Layout,
1003                                    MCRelaxableFragment &F) {
1004   if (!fragmentNeedsRelaxation(&F, Layout))
1005     return false;
1006
1007   ++stats::RelaxedInstructions;
1008
1009   // FIXME-PERF: We could immediately lower out instructions if we can tell
1010   // they are fully resolved, to avoid retesting on later passes.
1011
1012   // Relax the fragment.
1013
1014   MCInst Relaxed;
1015   getBackend().relaxInstruction(F.getInst(), Relaxed);
1016
1017   // Encode the new instruction.
1018   //
1019   // FIXME-PERF: If it matters, we could let the target do this. It can
1020   // probably do so more efficiently in many cases.
1021   SmallVector<MCFixup, 4> Fixups;
1022   SmallString<256> Code;
1023   raw_svector_ostream VecOS(Code);
1024   getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups, F.getSubtargetInfo());
1025   VecOS.flush();
1026
1027   // Update the fragment.
1028   F.setInst(Relaxed);
1029   F.getContents() = Code;
1030   F.getFixups() = Fixups;
1031
1032   return true;
1033 }
1034
1035 bool MCAssembler::relaxLEB(MCAsmLayout &Layout, MCLEBFragment &LF) {
1036   uint64_t OldSize = LF.getContents().size();
1037   int64_t Value = LF.getValue().evaluateKnownAbsolute(Layout);
1038   SmallString<8> &Data = LF.getContents();
1039   Data.clear();
1040   raw_svector_ostream OSE(Data);
1041   if (LF.isSigned())
1042     encodeSLEB128(Value, OSE);
1043   else
1044     encodeULEB128(Value, OSE);
1045   OSE.flush();
1046   return OldSize != LF.getContents().size();
1047 }
1048
1049 bool MCAssembler::relaxDwarfLineAddr(MCAsmLayout &Layout,
1050                                      MCDwarfLineAddrFragment &DF) {
1051   MCContext &Context = Layout.getAssembler().getContext();
1052   uint64_t OldSize = DF.getContents().size();
1053   int64_t AddrDelta = DF.getAddrDelta().evaluateKnownAbsolute(Layout);
1054   int64_t LineDelta;
1055   LineDelta = DF.getLineDelta();
1056   SmallString<8> &Data = DF.getContents();
1057   Data.clear();
1058   raw_svector_ostream OSE(Data);
1059   MCDwarfLineAddr::Encode(Context, LineDelta, AddrDelta, OSE);
1060   OSE.flush();
1061   return OldSize != Data.size();
1062 }
1063
1064 bool MCAssembler::relaxDwarfCallFrameFragment(MCAsmLayout &Layout,
1065                                               MCDwarfCallFrameFragment &DF) {
1066   MCContext &Context = Layout.getAssembler().getContext();
1067   uint64_t OldSize = DF.getContents().size();
1068   int64_t AddrDelta = DF.getAddrDelta().evaluateKnownAbsolute(Layout);
1069   SmallString<8> &Data = DF.getContents();
1070   Data.clear();
1071   raw_svector_ostream OSE(Data);
1072   MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OSE);
1073   OSE.flush();
1074   return OldSize != Data.size();
1075 }
1076
1077 bool MCAssembler::layoutSectionOnce(MCAsmLayout &Layout, MCSectionData &SD) {
1078   // Holds the first fragment which needed relaxing during this layout. It will
1079   // remain NULL if none were relaxed.
1080   // When a fragment is relaxed, all the fragments following it should get
1081   // invalidated because their offset is going to change.
1082   MCFragment *FirstRelaxedFragment = nullptr;
1083
1084   // Attempt to relax all the fragments in the section.
1085   for (MCSectionData::iterator I = SD.begin(), IE = SD.end(); I != IE; ++I) {
1086     // Check if this is a fragment that needs relaxation.
1087     bool RelaxedFrag = false;
1088     switch(I->getKind()) {
1089     default:
1090       break;
1091     case MCFragment::FT_Relaxable:
1092       assert(!getRelaxAll() &&
1093              "Did not expect a MCRelaxableFragment in RelaxAll mode");
1094       RelaxedFrag = relaxInstruction(Layout, *cast<MCRelaxableFragment>(I));
1095       break;
1096     case MCFragment::FT_Dwarf:
1097       RelaxedFrag = relaxDwarfLineAddr(Layout,
1098                                        *cast<MCDwarfLineAddrFragment>(I));
1099       break;
1100     case MCFragment::FT_DwarfFrame:
1101       RelaxedFrag =
1102         relaxDwarfCallFrameFragment(Layout,
1103                                     *cast<MCDwarfCallFrameFragment>(I));
1104       break;
1105     case MCFragment::FT_LEB:
1106       RelaxedFrag = relaxLEB(Layout, *cast<MCLEBFragment>(I));
1107       break;
1108     }
1109     if (RelaxedFrag && !FirstRelaxedFragment)
1110       FirstRelaxedFragment = I;
1111   }
1112   if (FirstRelaxedFragment) {
1113     Layout.invalidateFragmentsFrom(FirstRelaxedFragment);
1114     return true;
1115   }
1116   return false;
1117 }
1118
1119 bool MCAssembler::layoutOnce(MCAsmLayout &Layout) {
1120   ++stats::RelaxationSteps;
1121
1122   bool WasRelaxed = false;
1123   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1124     MCSectionData &SD = *it;
1125     while (layoutSectionOnce(Layout, SD))
1126       WasRelaxed = true;
1127   }
1128
1129   return WasRelaxed;
1130 }
1131
1132 void MCAssembler::finishLayout(MCAsmLayout &Layout) {
1133   // The layout is done. Mark every fragment as valid.
1134   for (unsigned int i = 0, n = Layout.getSectionOrder().size(); i != n; ++i) {
1135     Layout.getFragmentOffset(&*Layout.getSectionOrder()[i]->rbegin());
1136   }
1137 }
1138
1139 // Debugging methods
1140
1141 namespace llvm {
1142
1143 raw_ostream &operator<<(raw_ostream &OS, const MCFixup &AF) {
1144   OS << "<MCFixup" << " Offset:" << AF.getOffset()
1145      << " Value:" << *AF.getValue()
1146      << " Kind:" << AF.getKind() << ">";
1147   return OS;
1148 }
1149
1150 }
1151
1152 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
1153 void MCFragment::dump() {
1154   raw_ostream &OS = llvm::errs();
1155
1156   OS << "<";
1157   switch (getKind()) {
1158   case MCFragment::FT_Align: OS << "MCAlignFragment"; break;
1159   case MCFragment::FT_Data:  OS << "MCDataFragment"; break;
1160   case MCFragment::FT_CompactEncodedInst:
1161     OS << "MCCompactEncodedInstFragment"; break;
1162   case MCFragment::FT_Fill:  OS << "MCFillFragment"; break;
1163   case MCFragment::FT_Relaxable:  OS << "MCRelaxableFragment"; break;
1164   case MCFragment::FT_Org:   OS << "MCOrgFragment"; break;
1165   case MCFragment::FT_Dwarf: OS << "MCDwarfFragment"; break;
1166   case MCFragment::FT_DwarfFrame: OS << "MCDwarfCallFrameFragment"; break;
1167   case MCFragment::FT_LEB:   OS << "MCLEBFragment"; break;
1168   }
1169
1170   OS << "<MCFragment " << (void*) this << " LayoutOrder:" << LayoutOrder
1171      << " Offset:" << Offset
1172      << " HasInstructions:" << hasInstructions()
1173      << " BundlePadding:" << static_cast<unsigned>(getBundlePadding()) << ">";
1174
1175   switch (getKind()) {
1176   case MCFragment::FT_Align: {
1177     const MCAlignFragment *AF = cast<MCAlignFragment>(this);
1178     if (AF->hasEmitNops())
1179       OS << " (emit nops)";
1180     OS << "\n       ";
1181     OS << " Alignment:" << AF->getAlignment()
1182        << " Value:" << AF->getValue() << " ValueSize:" << AF->getValueSize()
1183        << " MaxBytesToEmit:" << AF->getMaxBytesToEmit() << ">";
1184     break;
1185   }
1186   case MCFragment::FT_Data:  {
1187     const MCDataFragment *DF = cast<MCDataFragment>(this);
1188     OS << "\n       ";
1189     OS << " Contents:[";
1190     const SmallVectorImpl<char> &Contents = DF->getContents();
1191     for (unsigned i = 0, e = Contents.size(); i != e; ++i) {
1192       if (i) OS << ",";
1193       OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1194     }
1195     OS << "] (" << Contents.size() << " bytes)";
1196
1197     if (DF->fixup_begin() != DF->fixup_end()) {
1198       OS << ",\n       ";
1199       OS << " Fixups:[";
1200       for (MCDataFragment::const_fixup_iterator it = DF->fixup_begin(),
1201              ie = DF->fixup_end(); it != ie; ++it) {
1202         if (it != DF->fixup_begin()) OS << ",\n                ";
1203         OS << *it;
1204       }
1205       OS << "]";
1206     }
1207     break;
1208   }
1209   case MCFragment::FT_CompactEncodedInst: {
1210     const MCCompactEncodedInstFragment *CEIF =
1211       cast<MCCompactEncodedInstFragment>(this);
1212     OS << "\n       ";
1213     OS << " Contents:[";
1214     const SmallVectorImpl<char> &Contents = CEIF->getContents();
1215     for (unsigned i = 0, e = Contents.size(); i != e; ++i) {
1216       if (i) OS << ",";
1217       OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1218     }
1219     OS << "] (" << Contents.size() << " bytes)";
1220     break;
1221   }
1222   case MCFragment::FT_Fill:  {
1223     const MCFillFragment *FF = cast<MCFillFragment>(this);
1224     OS << " Value:" << FF->getValue() << " ValueSize:" << FF->getValueSize()
1225        << " Size:" << FF->getSize();
1226     break;
1227   }
1228   case MCFragment::FT_Relaxable:  {
1229     const MCRelaxableFragment *F = cast<MCRelaxableFragment>(this);
1230     OS << "\n       ";
1231     OS << " Inst:";
1232     F->getInst().dump_pretty(OS);
1233     break;
1234   }
1235   case MCFragment::FT_Org:  {
1236     const MCOrgFragment *OF = cast<MCOrgFragment>(this);
1237     OS << "\n       ";
1238     OS << " Offset:" << OF->getOffset() << " Value:" << OF->getValue();
1239     break;
1240   }
1241   case MCFragment::FT_Dwarf:  {
1242     const MCDwarfLineAddrFragment *OF = cast<MCDwarfLineAddrFragment>(this);
1243     OS << "\n       ";
1244     OS << " AddrDelta:" << OF->getAddrDelta()
1245        << " LineDelta:" << OF->getLineDelta();
1246     break;
1247   }
1248   case MCFragment::FT_DwarfFrame:  {
1249     const MCDwarfCallFrameFragment *CF = cast<MCDwarfCallFrameFragment>(this);
1250     OS << "\n       ";
1251     OS << " AddrDelta:" << CF->getAddrDelta();
1252     break;
1253   }
1254   case MCFragment::FT_LEB: {
1255     const MCLEBFragment *LF = cast<MCLEBFragment>(this);
1256     OS << "\n       ";
1257     OS << " Value:" << LF->getValue() << " Signed:" << LF->isSigned();
1258     break;
1259   }
1260   }
1261   OS << ">";
1262 }
1263
1264 void MCSectionData::dump() {
1265   raw_ostream &OS = llvm::errs();
1266
1267   OS << "<MCSectionData";
1268   OS << " Alignment:" << getAlignment()
1269      << " Fragments:[\n      ";
1270   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1271     if (it != begin()) OS << ",\n      ";
1272     it->dump();
1273   }
1274   OS << "]>";
1275 }
1276
1277 void MCSymbolData::dump() const {
1278   raw_ostream &OS = llvm::errs();
1279
1280   OS << "<MCSymbolData Symbol:" << getSymbol()
1281      << " Fragment:" << getFragment();
1282   if (!isCommon())
1283     OS << " Offset:" << getOffset();
1284   OS << " Flags:" << getFlags() << " Index:" << getIndex();
1285   if (isCommon())
1286     OS << " (common, size:" << getCommonSize()
1287        << " align: " << getCommonAlignment() << ")";
1288   if (isExternal())
1289     OS << " (external)";
1290   if (isPrivateExtern())
1291     OS << " (private extern)";
1292   OS << ">";
1293 }
1294
1295 void MCAssembler::dump() {
1296   raw_ostream &OS = llvm::errs();
1297
1298   OS << "<MCAssembler\n";
1299   OS << "  Sections:[\n    ";
1300   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1301     if (it != begin()) OS << ",\n    ";
1302     it->dump();
1303   }
1304   OS << "],\n";
1305   OS << "  Symbols:[";
1306
1307   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
1308     if (it != symbol_begin()) OS << ",\n           ";
1309     it->dump();
1310   }
1311   OS << "]>\n";
1312 }
1313 #endif
1314
1315 // anchors for MC*Fragment vtables
1316 void MCEncodedFragment::anchor() { }
1317 void MCEncodedFragmentWithFixups::anchor() { }
1318 void MCDataFragment::anchor() { }
1319 void MCCompactEncodedInstFragment::anchor() { }
1320 void MCRelaxableFragment::anchor() { }
1321 void MCAlignFragment::anchor() { }
1322 void MCFillFragment::anchor() { }
1323 void MCOrgFragment::anchor() { }
1324 void MCLEBFragment::anchor() { }
1325 void MCDwarfLineAddrFragment::anchor() { }
1326 void MCDwarfCallFrameFragment::anchor() { }