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