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