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 #define DEBUG_TYPE "assembler"
  11 #include "llvm/MC/MCAssembler.h"
  12 #include "llvm/MC/MCAsmLayout.h"
  13 #include "llvm/MC/MCCodeEmitter.h"
  14 #include "llvm/MC/MCExpr.h"
  15 #include "llvm/MC/MCObjectWriter.h"
  16 #include "llvm/MC/MCSymbol.h"
  17 #include "llvm/MC/MCValue.h"
  18 #include "llvm/ADT/OwningPtr.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/ADT/StringExtras.h"
  21 #include "llvm/ADT/Twine.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Target/TargetRegistry.h"
  26 #include "llvm/Target/TargetAsmBackend.h"
  27
  28 #include <vector>
  29 using namespace llvm;
  30
  31 namespace {
  32 namespace stats {
  33 STATISTIC(RelaxedInstructions, "Number of relaxed instructions");
  34 STATISTIC(RelaxationSteps, "Number of assembler layout and relaxation steps");
  35 STATISTIC(EmittedFragments, "Number of emitted assembler fragments");
  36 STATISTIC(EvaluateFixup, "Number of evaluated fixups");
  37 STATISTIC(ObjectBytes, "Number of emitted object file bytes");
  38 }
  39 }
  40
  41 // FIXME FIXME FIXME: There are number of places in this file where we convert
  42 // what is a 64-bit assembler value used for computation into a value in the
  43 // object file, which may truncate it. We should detect that truncation where
  44 // invalid and report errors back.
  45
  46 /* *** */
  47
  48 uint64_t MCAsmLayout::getFragmentAddress(const MCFragment *F) const {
  49   assert(F->getParent() && "Missing section()!");
  50   return getSectionAddress(F->getParent()) + getFragmentOffset(F);
  51 }
  52
  53 uint64_t MCAsmLayout::getFragmentEffectiveSize(const MCFragment *F) const {
  54   assert(F->EffectiveSize != ~UINT64_C(0) && "Address not set!");
  55   return F->EffectiveSize;
  56 }
  57
  58 void MCAsmLayout::setFragmentEffectiveSize(MCFragment *F, uint64_t Value) {
  59   F->EffectiveSize = Value;
  60 }
  61
  62 uint64_t MCAsmLayout::getFragmentOffset(const MCFragment *F) const {
  63   assert(F->Offset != ~UINT64_C(0) && "Address not set!");
  64   return F->Offset;
  65 }
  66
  67 void MCAsmLayout::setFragmentOffset(MCFragment *F, uint64_t Value) {
  68   F->Offset = Value;
  69 }
  70
  71 uint64_t MCAsmLayout::getSymbolAddress(const MCSymbolData *SD) const {
  72   assert(SD->getFragment() && "Invalid getAddress() on undefined symbol!");
  73   return getFragmentAddress(SD->getFragment()) + SD->getOffset();
  74 }
  75
  76 uint64_t MCAsmLayout::getSectionAddress(const MCSectionData *SD) const {
  77   assert(SD->Address != ~UINT64_C(0) && "Address not set!");
  78   return SD->Address;
  79 }
  80
  81 void MCAsmLayout::setSectionAddress(MCSectionData *SD, uint64_t Value) {
  82   SD->Address = Value;
  83 }
  84
  85 uint64_t MCAsmLayout::getSectionSize(const MCSectionData *SD) const {
  86   assert(SD->Size != ~UINT64_C(0) && "File size not set!");
  87   return SD->Size;
  88 }
  89 void MCAsmLayout::setSectionSize(MCSectionData *SD, uint64_t Value) {
  90   SD->Size = Value;
  91 }
  92
  93 uint64_t MCAsmLayout::getSectionFileSize(const MCSectionData *SD) const {
  94   assert(SD->FileSize != ~UINT64_C(0) && "File size not set!");
  95   return SD->FileSize;
  96 }
  97 void MCAsmLayout::setSectionFileSize(MCSectionData *SD, uint64_t Value) {
  98   SD->FileSize = Value;
  99 }
 100
 101   /// @}
 102
 103 /* *** */
 104
 105 MCFragment::MCFragment() : Kind(FragmentType(~0)) {
 106 }
 107
 108 MCFragment::MCFragment(FragmentType _Kind, MCSectionData *_Parent)
 109   : Kind(_Kind),
 110     Parent(_Parent),
 111     EffectiveSize(~UINT64_C(0))
 112 {
 113   if (Parent)
 114     Parent->getFragmentList().push_back(this);
 115 }
 116
 117 MCFragment::~MCFragment() {
 118 }
 119
 120 /* *** */
 121
 122 MCSectionData::MCSectionData() : Section(0) {}
 123
 124 MCSectionData::MCSectionData(const MCSection &_Section, MCAssembler *A)
 125   : Section(&_Section),
 126     Alignment(1),
 127     Address(~UINT64_C(0)),
 128     Size(~UINT64_C(0)),
 129     FileSize(~UINT64_C(0)),
 130     HasInstructions(false)
 131 {
 132   if (A)
 133     A->getSectionList().push_back(this);
 134 }
 135
 136 /* *** */
 137
 138 MCSymbolData::MCSymbolData() : Symbol(0) {}
 139
 140 MCSymbolData::MCSymbolData(const MCSymbol &_Symbol, MCFragment *_Fragment,
 141                            uint64_t _Offset, MCAssembler *A)
 142   : Symbol(&_Symbol), Fragment(_Fragment), Offset(_Offset),
 143     IsExternal(false), IsPrivateExtern(false),
 144     CommonSize(0), CommonAlign(0), Flags(0), Index(0)
 145 {
 146   if (A)
 147     A->getSymbolList().push_back(this);
 148 }
 149
 150 /* *** */
 151
 152 MCAssembler::MCAssembler(MCContext &_Context, TargetAsmBackend &_Backend,
 153                          MCCodeEmitter &_Emitter, raw_ostream &_OS)
 154   : Context(_Context), Backend(_Backend), Emitter(_Emitter),
 155     OS(_OS), SubsectionsViaSymbols(false)
 156 {
 157 }
 158
 159 MCAssembler::~MCAssembler() {
 160 }
 161
 162 static bool isScatteredFixupFullyResolvedSimple(const MCAssembler &Asm,
 163                                                 const MCAsmFixup &Fixup,
 164                                                 const MCValue Target,
 165                                                 const MCSection *BaseSection) {
 166   // The effective fixup address is
 167   //     addr(atom(A)) + offset(A)
 168   //   - addr(atom(B)) - offset(B)
 169   //   - addr(<base symbol>) + <fixup offset from base symbol>
 170   // and the offsets are not relocatable, so the fixup is fully resolved when
 171   //  addr(atom(A)) - addr(atom(B)) - addr(<base symbol>)) == 0.
 172   //
 173   // The simple (Darwin, except on x86_64) way of dealing with this was to
 174   // assume that any reference to a temporary symbol *must* be a temporary
 175   // symbol in the same atom, unless the sections differ. Therefore, any PCrel
 176   // relocation to a temporary symbol (in the same section) is fully
 177   // resolved. This also works in conjunction with absolutized .set, which
 178   // requires the compiler to use .set to absolutize the differences between
 179   // symbols which the compiler knows to be assembly time constants, so we don't
 180   // need to worry about consider symbol differences fully resolved.
 181
 182   // Non-relative fixups are only resolved if constant.
 183   if (!BaseSection)
 184     return Target.isAbsolute();
 185
 186   // Otherwise, relative fixups are only resolved if not a difference and the
 187   // target is a temporary in the same section.
 188   if (Target.isAbsolute() || Target.getSymB())
 189     return false;
 190
 191   const MCSymbol *A = &Target.getSymA()->getSymbol();
 192   if (!A->isTemporary() || !A->isInSection() ||
 193       &A->getSection() != BaseSection)
 194     return false;
 195
 196   return true;
 197 }
 198
 199 static bool isScatteredFixupFullyResolved(const MCAssembler &Asm,
 200                                           const MCAsmLayout &Layout,
 201                                           const MCAsmFixup &Fixup,
 202                                           const MCValue Target,
 203                                           const MCSymbolData *BaseSymbol) {
 204   // The effective fixup address is
 205   //     addr(atom(A)) + offset(A)
 206   //   - addr(atom(B)) - offset(B)
 207   //   - addr(BaseSymbol) + <fixup offset from base symbol>
 208   // and the offsets are not relocatable, so the fixup is fully resolved when
 209   //  addr(atom(A)) - addr(atom(B)) - addr(BaseSymbol) == 0.
 210   //
 211   // Note that "false" is almost always conservatively correct (it means we emit
 212   // a relocation which is unnecessary), except when it would force us to emit a
 213   // relocation which the target cannot encode.
 214
 215   const MCSymbolData *A_Base = 0, *B_Base = 0;
 216   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 217     // Modified symbol references cannot be resolved.
 218     if (A->getKind() != MCSymbolRefExpr::VK_None)
 219       return false;
 220
 221     A_Base = Asm.getAtom(Layout, &Asm.getSymbolData(A->getSymbol()));
 222     if (!A_Base)
 223       return false;
 224   }
 225
 226   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 227     // Modified symbol references cannot be resolved.
 228     if (B->getKind() != MCSymbolRefExpr::VK_None)
 229       return false;
 230
 231     B_Base = Asm.getAtom(Layout, &Asm.getSymbolData(B->getSymbol()));
 232     if (!B_Base)
 233       return false;
 234   }
 235
 236   // If there is no base, A and B have to be the same atom for this fixup to be
 237   // fully resolved.
 238   if (!BaseSymbol)
 239     return A_Base == B_Base;
 240
 241   // Otherwise, B must be missing and A must be the base.
 242   return !B_Base && BaseSymbol == A_Base;
 243 }
 244
 245 bool MCAssembler::isSymbolLinkerVisible(const MCSymbolData *SD) const {
 246   // Non-temporary labels should always be visible to the linker.
 247   if (!SD->getSymbol().isTemporary())
 248     return true;
 249
 250   // Absolute temporary labels are never visible.
 251   if (!SD->getFragment())
 252     return false;
 253
 254   // Otherwise, check if the section requires symbols even for temporary labels.
 255   return getBackend().doesSectionRequireSymbols(
 256     SD->getFragment()->getParent()->getSection());
 257 }
 258
 259 // FIXME-PERF: This routine is really slow.
 260 const MCSymbolData *MCAssembler::getAtomForAddress(const MCAsmLayout &Layout,
 261                                                    const MCSectionData *Section,
 262                                                    uint64_t Address) const {
 263   const MCSymbolData *Best = 0;
 264   uint64_t BestAddress = 0;
 265
 266   for (MCAssembler::const_symbol_iterator it = symbol_begin(),
 267          ie = symbol_end(); it != ie; ++it) {
 268     // Ignore non-linker visible symbols.
 269     if (!isSymbolLinkerVisible(it))
 270       continue;
 271
 272     // Ignore symbols not in the same section.
 273     if (!it->getFragment() || it->getFragment()->getParent() != Section)
 274       continue;
 275
 276     // Otherwise, find the closest symbol preceding this address (ties are
 277     // resolved in favor of the last defined symbol).
 278     uint64_t SymbolAddress = Layout.getSymbolAddress(it);
 279     if (SymbolAddress <= Address && (!Best || SymbolAddress >= BestAddress)) {
 280       Best = it;
 281       BestAddress = SymbolAddress;
 282     }
 283   }
 284
 285   return Best;
 286 }
 287
 288 // FIXME-PERF: This routine is really slow.
 289 const MCSymbolData *MCAssembler::getAtom(const MCAsmLayout &Layout,
 290                                          const MCSymbolData *SD) const {
 291   // Linker visible symbols define atoms.
 292   if (isSymbolLinkerVisible(SD))
 293     return SD;
 294
 295   // Absolute and undefined symbols have no defining atom.
 296   if (!SD->getFragment())
 297     return 0;
 298
 299   // Otherwise, search by address.
 300   return getAtomForAddress(Layout, SD->getFragment()->getParent(),
 301                            Layout.getSymbolAddress(SD));
 302 }
 303
 304 bool MCAssembler::EvaluateFixup(const MCAsmLayout &Layout,
 305                                 const MCAsmFixup &Fixup, const MCFragment *DF,
 306                                 MCValue &Target, uint64_t &Value) const {
 307   ++stats::EvaluateFixup;
 308
 309   if (!Fixup.Value->EvaluateAsRelocatable(Target, &Layout))
 310     llvm_report_error("expected relocatable expression");
 311
 312   // FIXME: How do non-scattered symbols work in ELF? I presume the linker
 313   // doesn't support small relocations, but then under what criteria does the
 314   // assembler allow symbol differences?
 315
 316   Value = Target.getConstant();
 317
 318   bool IsPCRel =
 319     Emitter.getFixupKindInfo(Fixup.Kind).Flags & MCFixupKindInfo::FKF_IsPCRel;
 320   bool IsResolved = true;
 321   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 322     if (A->getSymbol().isDefined())
 323       Value += Layout.getSymbolAddress(&getSymbolData(A->getSymbol()));
 324     else
 325       IsResolved = false;
 326   }
 327   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 328     if (B->getSymbol().isDefined())
 329       Value -= Layout.getSymbolAddress(&getSymbolData(B->getSymbol()));
 330     else
 331       IsResolved = false;
 332   }
 333
 334   // If we are using scattered symbols, determine whether this value is actually
 335   // resolved; scattering may cause atoms to move.
 336   if (IsResolved && getBackend().hasScatteredSymbols()) {
 337     if (getBackend().hasReliableSymbolDifference()) {
 338       // If this is a PCrel relocation, find the base atom (identified by its
 339       // symbol) that the fixup value is relative to.
 340       const MCSymbolData *BaseSymbol = 0;
 341       if (IsPCRel) {
 342         BaseSymbol = getAtomForAddress(
 343           Layout, DF->getParent(), Layout.getFragmentAddress(DF)+Fixup.Offset);
 344         if (!BaseSymbol)
 345           IsResolved = false;
 346       }
 347
 348       if (IsResolved)
 349         IsResolved = isScatteredFixupFullyResolved(*this, Layout, Fixup, Target,
 350                                                    BaseSymbol);
 351     } else {
 352       const MCSection *BaseSection = 0;
 353       if (IsPCRel)
 354         BaseSection = &DF->getParent()->getSection();
 355
 356       IsResolved = isScatteredFixupFullyResolvedSimple(*this, Fixup, Target,
 357                                                        BaseSection);
 358     }
 359   }
 360
 361   if (IsPCRel)
 362     Value -= Layout.getFragmentAddress(DF) + Fixup.Offset;
 363
 364   return IsResolved;
 365 }
 366
 367 void MCAssembler::LayoutSection(MCSectionData &SD,
 368                                 MCAsmLayout &Layout) {
 369   uint64_t Address, StartAddress = Address = Layout.getSectionAddress(&SD);
 370
 371   for (MCSectionData::iterator it = SD.begin(), ie = SD.end(); it != ie; ++it) {
 372     MCFragment &F = *it;
 373
 374     uint64_t FragmentOffset = Address - StartAddress;
 375     Layout.setFragmentOffset(&F, FragmentOffset);
 376
 377     // Evaluate fragment size.
 378     uint64_t EffectiveSize = 0;
 379     switch (F.getKind()) {
 380     case MCFragment::FT_Align: {
 381       MCAlignFragment &AF = cast<MCAlignFragment>(F);
 382
 383       EffectiveSize = OffsetToAlignment(Address, AF.getAlignment());
 384       if (EffectiveSize > AF.getMaxBytesToEmit())
 385         EffectiveSize = 0;
 386       break;
 387     }
 388
 389     case MCFragment::FT_Data:
 390       EffectiveSize = cast<MCDataFragment>(F).getContents().size();
 391       break;
 392
 393     case MCFragment::FT_Fill: {
 394       MCFillFragment &FF = cast<MCFillFragment>(F);
 395       EffectiveSize = FF.getValueSize() * FF.getCount();
 396       break;
 397     }
 398
 399     case MCFragment::FT_Inst:
 400       EffectiveSize = cast<MCInstFragment>(F).getInstSize();
 401       break;
 402
 403     case MCFragment::FT_Org: {
 404       MCOrgFragment &OF = cast<MCOrgFragment>(F);
 405
 406       int64_t TargetLocation;
 407       if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
 408         llvm_report_error("expected assembly-time absolute expression");
 409
 410       // FIXME: We need a way to communicate this error.
 411       int64_t Offset = TargetLocation - FragmentOffset;
 412       if (Offset < 0)
 413         llvm_report_error("invalid .org offset '" + Twine(TargetLocation) +
 414                           "' (at offset '" + Twine(FragmentOffset) + "'");
 415
 416       EffectiveSize = Offset;
 417       break;
 418     }
 419
 420     case MCFragment::FT_ZeroFill: {
 421       MCZeroFillFragment &ZFF = cast<MCZeroFillFragment>(F);
 422
 423       // Align the fragment offset; it is safe to adjust the offset freely since
 424       // this is only in virtual sections.
 425       //
 426       // FIXME: We shouldn't be doing this here.
 427       Address = RoundUpToAlignment(Address, ZFF.getAlignment());
 428       Layout.setFragmentOffset(&F, Address - StartAddress);
 429
 430       EffectiveSize = ZFF.getSize();
 431       break;
 432     }
 433     }
 434
 435     Layout.setFragmentEffectiveSize(&F, EffectiveSize);
 436     Address += EffectiveSize;
 437   }
 438
 439   // Set the section sizes.
 440   Layout.setSectionSize(&SD, Address - StartAddress);
 441   if (getBackend().isVirtualSection(SD.getSection()))
 442     Layout.setSectionFileSize(&SD, 0);
 443   else
 444     Layout.setSectionFileSize(&SD, Address - StartAddress);
 445 }
 446
 447 /// WriteFragmentData - Write the \arg F data to the output file.
 448 static void WriteFragmentData(const MCAssembler &Asm, const MCAsmLayout &Layout,
 449                               const MCFragment &F, MCObjectWriter *OW) {
 450   uint64_t Start = OW->getStream().tell();
 451   (void) Start;
 452
 453   ++stats::EmittedFragments;
 454
 455   // FIXME: Embed in fragments instead?
 456   uint64_t FragmentSize = Layout.getFragmentEffectiveSize(&F);
 457   switch (F.getKind()) {
 458   case MCFragment::FT_Align: {
 459     MCAlignFragment &AF = cast<MCAlignFragment>(F);
 460     uint64_t Count = FragmentSize / AF.getValueSize();
 461
 462     // FIXME: This error shouldn't actually occur (the front end should emit
 463     // multiple .align directives to enforce the semantics it wants), but is
 464     // severe enough that we want to report it. How to handle this?
 465     if (Count * AF.getValueSize() != FragmentSize)
 466       llvm_report_error("undefined .align directive, value size '" +
 467                         Twine(AF.getValueSize()) +
 468                         "' is not a divisor of padding size '" +
 469                         Twine(FragmentSize) + "'");
 470
 471     // See if we are aligning with nops, and if so do that first to try to fill
 472     // the Count bytes.  Then if that did not fill any bytes or there are any
 473     // bytes left to fill use the the Value and ValueSize to fill the rest.
 474     // If we are aligning with nops, ask that target to emit the right data.
 475     if (AF.getEmitNops()) {
 476       if (!Asm.getBackend().WriteNopData(Count, OW))
 477         llvm_report_error("unable to write nop sequence of " +
 478                           Twine(Count) + " bytes");
 479       break;
 480     }
 481
 482     // Otherwise, write out in multiples of the value size.
 483     for (uint64_t i = 0; i != Count; ++i) {
 484       switch (AF.getValueSize()) {
 485       default:
 486         assert(0 && "Invalid size!");
 487       case 1: OW->Write8 (uint8_t (AF.getValue())); break;
 488       case 2: OW->Write16(uint16_t(AF.getValue())); break;
 489       case 4: OW->Write32(uint32_t(AF.getValue())); break;
 490       case 8: OW->Write64(uint64_t(AF.getValue())); break;
 491       }
 492     }
 493     break;
 494   }
 495
 496   case MCFragment::FT_Data: {
 497     MCDataFragment &DF = cast<MCDataFragment>(F);
 498     assert(FragmentSize == DF.getContents().size() && "Invalid size!");
 499     OW->WriteBytes(DF.getContents().str());
 500     break;
 501   }
 502
 503   case MCFragment::FT_Fill: {
 504     MCFillFragment &FF = cast<MCFillFragment>(F);
 505     for (uint64_t i = 0, e = FF.getCount(); i != e; ++i) {
 506       switch (FF.getValueSize()) {
 507       default:
 508         assert(0 && "Invalid size!");
 509       case 1: OW->Write8 (uint8_t (FF.getValue())); break;
 510       case 2: OW->Write16(uint16_t(FF.getValue())); break;
 511       case 4: OW->Write32(uint32_t(FF.getValue())); break;
 512       case 8: OW->Write64(uint64_t(FF.getValue())); break;
 513       }
 514     }
 515     break;
 516   }
 517
 518   case MCFragment::FT_Inst:
 519     llvm_unreachable("unexpected inst fragment after lowering");
 520     break;
 521
 522   case MCFragment::FT_Org: {
 523     MCOrgFragment &OF = cast<MCOrgFragment>(F);
 524
 525     for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
 526       OW->Write8(uint8_t(OF.getValue()));
 527
 528     break;
 529   }
 530
 531   case MCFragment::FT_ZeroFill: {
 532     assert(0 && "Invalid zero fill fragment in concrete section!");
 533     break;
 534   }
 535   }
 536
 537   assert(OW->getStream().tell() - Start == FragmentSize);
 538 }
 539
 540 void MCAssembler::WriteSectionData(const MCSectionData *SD,
 541                                    const MCAsmLayout &Layout,
 542                                    MCObjectWriter *OW) const {
 543   uint64_t SectionSize = Layout.getSectionSize(SD);
 544   uint64_t SectionFileSize = Layout.getSectionFileSize(SD);
 545
 546   // Ignore virtual sections.
 547   if (getBackend().isVirtualSection(SD->getSection())) {
 548     assert(SectionFileSize == 0 && "Invalid size for section!");
 549     return;
 550   }
 551
 552   uint64_t Start = OW->getStream().tell();
 553   (void) Start;
 554
 555   for (MCSectionData::const_iterator it = SD->begin(),
 556          ie = SD->end(); it != ie; ++it)
 557     WriteFragmentData(*this, Layout, *it, OW);
 558
 559   // Add section padding.
 560   assert(SectionFileSize >= SectionSize && "Invalid section sizes!");
 561   OW->WriteZeros(SectionFileSize - SectionSize);
 562
 563   assert(OW->getStream().tell() - Start == SectionFileSize);
 564 }
 565
 566 void MCAssembler::Finish() {
 567   DEBUG_WITH_TYPE("mc-dump", {
 568       llvm::errs() << "assembler backend - pre-layout\n--\n";
 569       dump(); });
 570
 571   // Assign section and fragment ordinals, all subsequent backend code is
 572   // responsible for updating these in place.
 573   unsigned SectionIndex = 0;
 574   unsigned FragmentIndex = 0;
 575   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 576     it->setOrdinal(SectionIndex++);
 577
 578     for (MCSectionData::iterator it2 = it->begin(),
 579            ie2 = it->end(); it2 != ie2; ++it2)
 580       it2->setOrdinal(FragmentIndex++);
 581   }
 582
 583   // Layout until everything fits.
 584   MCAsmLayout Layout(*this);
 585   while (LayoutOnce(Layout))
 586     continue;
 587
 588   DEBUG_WITH_TYPE("mc-dump", {
 589       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 590       dump(); });
 591
 592   // Finalize the layout, including fragment lowering.
 593   FinishLayout(Layout);
 594
 595   DEBUG_WITH_TYPE("mc-dump", {
 596       llvm::errs() << "assembler backend - final-layout\n--\n";
 597       dump(); });
 598
 599   uint64_t StartOffset = OS.tell();
 600   llvm::OwningPtr<MCObjectWriter> Writer(getBackend().createObjectWriter(OS));
 601   if (!Writer)
 602     llvm_report_error("unable to create object writer!");
 603
 604   // Allow the object writer a chance to perform post-layout binding (for
 605   // example, to set the index fields in the symbol data).
 606   Writer->ExecutePostLayoutBinding(*this);
 607
 608   // Evaluate and apply the fixups, generating relocation entries as necessary.
 609   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 610     for (MCSectionData::iterator it2 = it->begin(),
 611            ie2 = it->end(); it2 != ie2; ++it2) {
 612       MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
 613       if (!DF)
 614         continue;
 615
 616       for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
 617              ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
 618         MCAsmFixup &Fixup = *it3;
 619
 620         // Evaluate the fixup.
 621         MCValue Target;
 622         uint64_t FixedValue;
 623         if (!EvaluateFixup(Layout, Fixup, DF, Target, FixedValue)) {
 624           // The fixup was unresolved, we need a relocation. Inform the object
 625           // writer of the relocation, and give it an opportunity to adjust the
 626           // fixup value if need be.
 627           Writer->RecordRelocation(*this, Layout, DF, Fixup, Target,FixedValue);
 628         }
 629
 630         getBackend().ApplyFixup(Fixup, *DF, FixedValue);
 631       }
 632     }
 633   }
 634
 635   // Write the object file.
 636   Writer->WriteObject(*this, Layout);
 637   OS.flush();
 638
 639   stats::ObjectBytes += OS.tell() - StartOffset;
 640 }
 641
 642 bool MCAssembler::FixupNeedsRelaxation(const MCAsmFixup &Fixup,
 643                                        const MCFragment *DF,
 644                                        const MCAsmLayout &Layout) const {
 645   // If we cannot resolve the fixup value, it requires relaxation.
 646   MCValue Target;
 647   uint64_t Value;
 648   if (!EvaluateFixup(Layout, Fixup, DF, Target, Value))
 649     return true;
 650
 651   // Otherwise, relax if the value is too big for a (signed) i8.
 652   return int64_t(Value) != int64_t(int8_t(Value));
 653 }
 654
 655 bool MCAssembler::FragmentNeedsRelaxation(const MCInstFragment *IF,
 656                                           const MCAsmLayout &Layout) const {
 657   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 658   // are intentionally pushing out inst fragments, or because we relaxed a
 659   // previous instruction to one that doesn't need relaxation.
 660   if (!getBackend().MayNeedRelaxation(IF->getInst(), IF->getFixups()))
 661     return false;
 662
 663   for (MCInstFragment::const_fixup_iterator it = IF->fixup_begin(),
 664          ie = IF->fixup_end(); it != ie; ++it)
 665     if (FixupNeedsRelaxation(*it, IF, Layout))
 666       return true;
 667
 668   return false;
 669 }
 670
 671 bool MCAssembler::LayoutOnce(MCAsmLayout &Layout) {
 672   ++stats::RelaxationSteps;
 673
 674   // Layout the concrete sections and fragments.
 675   uint64_t Address = 0;
 676   MCSectionData *Prev = 0;
 677   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 678     MCSectionData &SD = *it;
 679
 680     // Skip virtual sections.
 681     if (getBackend().isVirtualSection(SD.getSection()))
 682       continue;
 683
 684     // Align this section if necessary by adding padding bytes to the previous
 685     // section.
 686     if (uint64_t Pad = OffsetToAlignment(Address, it->getAlignment())) {
 687       assert(Prev && "Missing prev section!");
 688       Layout.setSectionFileSize(Prev, Layout.getSectionFileSize(Prev) + Pad);
 689       Address += Pad;
 690     }
 691
 692     // Layout the section fragments and its size.
 693     Layout.setSectionAddress(&SD, Address);
 694     LayoutSection(SD, Layout);
 695     Address += Layout.getSectionFileSize(&SD);
 696
 697     Prev = &SD;
 698   }
 699
 700   // Layout the virtual sections.
 701   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 702     MCSectionData &SD = *it;
 703
 704     if (!getBackend().isVirtualSection(SD.getSection()))
 705       continue;
 706
 707     // Align this section if necessary by adding padding bytes to the previous
 708     // section.
 709     if (uint64_t Pad = OffsetToAlignment(Address, it->getAlignment()))
 710       Address += Pad;
 711
 712     Layout.setSectionAddress(&SD, Address);
 713     LayoutSection(SD, Layout);
 714     Address += Layout.getSectionSize(&SD);
 715   }
 716
 717   // Scan for fragments that need relaxation.
 718   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 719     MCSectionData &SD = *it;
 720
 721     for (MCSectionData::iterator it2 = SD.begin(),
 722            ie2 = SD.end(); it2 != ie2; ++it2) {
 723       // Check if this is an instruction fragment that needs relaxation.
 724       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 725       if (!IF || !FragmentNeedsRelaxation(IF, Layout))
 726         continue;
 727
 728       ++stats::RelaxedInstructions;
 729
 730       // FIXME-PERF: We could immediately lower out instructions if we can tell
 731       // they are fully resolved, to avoid retesting on later passes.
 732
 733       // Relax the fragment.
 734
 735       MCInst Relaxed;
 736       getBackend().RelaxInstruction(IF, Relaxed);
 737
 738       // Encode the new instruction.
 739       //
 740       // FIXME-PERF: If it matters, we could let the target do this. It can
 741       // probably do so more efficiently in many cases.
 742       SmallVector<MCFixup, 4> Fixups;
 743       SmallString<256> Code;
 744       raw_svector_ostream VecOS(Code);
 745       getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups);
 746       VecOS.flush();
 747
 748       // Update the instruction fragment.
 749       IF->setInst(Relaxed);
 750       IF->getCode() = Code;
 751       IF->getFixups().clear();
 752       for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 753         MCFixup &F = Fixups[i];
 754         IF->getFixups().push_back(MCAsmFixup(F.getOffset(), *F.getValue(),
 755                                              F.getKind()));
 756       }
 757
 758       // Restart layout.
 759       //
 760       // FIXME-PERF: This is O(N^2), but will be eliminated once we have a
 761       // smart MCAsmLayout object.
 762       return true;
 763     }
 764   }
 765
 766   return false;
 767 }
 768
 769 void MCAssembler::FinishLayout(MCAsmLayout &Layout) {
 770   // Lower out any instruction fragments, to simplify the fixup application and
 771   // output.
 772   //
 773   // FIXME-PERF: We don't have to do this, but the assumption is that it is
 774   // cheap (we will mostly end up eliminating fragments and appending on to data
 775   // fragments), so the extra complexity downstream isn't worth it. Evaluate
 776   // this assumption.
 777   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 778     MCSectionData &SD = *it;
 779
 780     for (MCSectionData::iterator it2 = SD.begin(),
 781            ie2 = SD.end(); it2 != ie2; ++it2) {
 782       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 783       if (!IF)
 784         continue;
 785
 786       // Create a new data fragment for the instruction.
 787       //
 788       // FIXME-PERF: Reuse previous data fragment if possible.
 789       MCDataFragment *DF = new MCDataFragment();
 790       SD.getFragmentList().insert(it2, DF);
 791
 792       // Update the data fragments layout data.
 793       //
 794       // FIXME: Add MCAsmLayout utility for this.
 795       DF->setParent(IF->getParent());
 796       DF->setOrdinal(IF->getOrdinal());
 797       Layout.setFragmentOffset(DF, Layout.getFragmentOffset(IF));
 798       Layout.setFragmentEffectiveSize(DF, Layout.getFragmentEffectiveSize(IF));
 799
 800       // Copy in the data and the fixups.
 801       DF->getContents().append(IF->getCode().begin(), IF->getCode().end());
 802       for (unsigned i = 0, e = IF->getFixups().size(); i != e; ++i)
 803         DF->getFixups().push_back(IF->getFixups()[i]);
 804
 805       // Delete the instruction fragment and update the iterator.
 806       SD.getFragmentList().erase(IF);
 807       it2 = DF;
 808     }
 809   }
 810 }
 811
 812 // Debugging methods
 813
 814 namespace llvm {
 815
 816 raw_ostream &operator<<(raw_ostream &OS, const MCAsmFixup &AF) {
 817   OS << "<MCAsmFixup" << " Offset:" << AF.Offset << " Value:" << *AF.Value
 818      << " Kind:" << AF.Kind << ">";
 819   return OS;
 820 }
 821
 822 }
 823
 824 void MCFragment::dump() {
 825   raw_ostream &OS = llvm::errs();
 826
 827   OS << "<MCFragment " << (void*) this << " Offset:" << Offset
 828      << " EffectiveSize:" << EffectiveSize;
 829
 830   OS << ">";
 831 }
 832
 833 void MCAlignFragment::dump() {
 834   raw_ostream &OS = llvm::errs();
 835
 836   OS << "<MCAlignFragment ";
 837   this->MCFragment::dump();
 838   OS << "\n       ";
 839   OS << " Alignment:" << getAlignment()
 840      << " Value:" << getValue() << " ValueSize:" << getValueSize()
 841      << " MaxBytesToEmit:" << getMaxBytesToEmit() << ">";
 842 }
 843
 844 void MCDataFragment::dump() {
 845   raw_ostream &OS = llvm::errs();
 846
 847   OS << "<MCDataFragment ";
 848   this->MCFragment::dump();
 849   OS << "\n       ";
 850   OS << " Contents:[";
 851   for (unsigned i = 0, e = getContents().size(); i != e; ++i) {
 852     if (i) OS << ",";
 853     OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
 854   }
 855   OS << "] (" << getContents().size() << " bytes)";
 856
 857   if (!getFixups().empty()) {
 858     OS << ",\n       ";
 859     OS << " Fixups:[";
 860     for (fixup_iterator it = fixup_begin(), ie = fixup_end(); it != ie; ++it) {
 861       if (it != fixup_begin()) OS << ",\n                ";
 862       OS << *it;
 863     }
 864     OS << "]";
 865   }
 866
 867   OS << ">";
 868 }
 869
 870 void MCFillFragment::dump() {
 871   raw_ostream &OS = llvm::errs();
 872
 873   OS << "<MCFillFragment ";
 874   this->MCFragment::dump();
 875   OS << "\n       ";
 876   OS << " Value:" << getValue() << " ValueSize:" << getValueSize()
 877      << " Count:" << getCount() << ">";
 878 }
 879
 880 void MCInstFragment::dump() {
 881   raw_ostream &OS = llvm::errs();
 882
 883   OS << "<MCInstFragment ";
 884   this->MCFragment::dump();
 885   OS << "\n       ";
 886   OS << " Inst:";
 887   getInst().dump_pretty(OS);
 888   OS << ">";
 889 }
 890
 891 void MCOrgFragment::dump() {
 892   raw_ostream &OS = llvm::errs();
 893
 894   OS << "<MCOrgFragment ";
 895   this->MCFragment::dump();
 896   OS << "\n       ";
 897   OS << " Offset:" << getOffset() << " Value:" << getValue() << ">";
 898 }
 899
 900 void MCZeroFillFragment::dump() {
 901   raw_ostream &OS = llvm::errs();
 902
 903   OS << "<MCZeroFillFragment ";
 904   this->MCFragment::dump();
 905   OS << "\n       ";
 906   OS << " Size:" << getSize() << " Alignment:" << getAlignment() << ">";
 907 }
 908
 909 void MCSectionData::dump() {
 910   raw_ostream &OS = llvm::errs();
 911
 912   OS << "<MCSectionData";
 913   OS << " Alignment:" << getAlignment() << " Address:" << Address
 914      << " Size:" << Size << " FileSize:" << FileSize
 915      << " Fragments:[\n      ";
 916   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 917     if (it != begin()) OS << ",\n      ";
 918     it->dump();
 919   }
 920   OS << "]>";
 921 }
 922
 923 void MCSymbolData::dump() {
 924   raw_ostream &OS = llvm::errs();
 925
 926   OS << "<MCSymbolData Symbol:" << getSymbol()
 927      << " Fragment:" << getFragment() << " Offset:" << getOffset()
 928      << " Flags:" << getFlags() << " Index:" << getIndex();
 929   if (isCommon())
 930     OS << " (common, size:" << getCommonSize()
 931        << " align: " << getCommonAlignment() << ")";
 932   if (isExternal())
 933     OS << " (external)";
 934   if (isPrivateExtern())
 935     OS << " (private extern)";
 936   OS << ">";
 937 }
 938
 939 void MCAssembler::dump() {
 940   raw_ostream &OS = llvm::errs();
 941
 942   OS << "<MCAssembler\n";
 943   OS << "  Sections:[\n    ";
 944   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 945     if (it != begin()) OS << ",\n    ";
 946     it->dump();
 947   }
 948   OS << "],\n";
 949   OS << "  Symbols:[";
 950
 951   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
 952     if (it != symbol_begin()) OS << ",\n           ";
 953     it->dump();
 954   }
 955   OS << "]>\n";
 956 }