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