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::AddSectionToTheEnd(const MCObjectWriter &Writer,
 622                                      MCSectionData &SD, MCAsmLayout &Layout) {
 623   // Create dummy fragments and assign section ordinals.
 624   unsigned SectionIndex = size();
 625   SD.setOrdinal(SectionIndex);
 626
 627   // Assign layout order indices to sections and fragments.
 628   const MCFragment &Last = *Layout.getSectionOrder().back()->rbegin();
 629   unsigned FragmentIndex = Last.getLayoutOrder() + 1;
 630
 631   SD.setLayoutOrder(Layout.getSectionOrder().size());
 632   for (MCSectionData::iterator it2 = SD.begin(),
 633          ie2 = SD.end(); it2 != ie2; ++it2) {
 634     it2->setLayoutOrder(FragmentIndex++);
 635   }
 636   Layout.getSectionOrder().push_back(&SD);
 637
 638   Layout.LayoutSection(&SD);
 639 }
 640
 641 void MCAssembler::Finish(MCObjectWriter *Writer) {
 642   DEBUG_WITH_TYPE("mc-dump", {
 643       llvm::errs() << "assembler backend - pre-layout\n--\n";
 644       dump(); });
 645
 646   // Create the layout object.
 647   MCAsmLayout Layout(*this);
 648
 649   // Insert additional align fragments for concrete sections to explicitly pad
 650   // the previous section to match their alignment requirements. This is for
 651   // 'gas' compatibility, it shouldn't strictly be necessary.
 652   if (PadSectionToAlignment) {
 653     for (unsigned i = 1, e = Layout.getSectionOrder().size(); i < e; ++i) {
 654       MCSectionData *SD = Layout.getSectionOrder()[i];
 655
 656       // Ignore sections without alignment requirements.
 657       unsigned Align = SD->getAlignment();
 658       if (Align <= 1)
 659         continue;
 660
 661       // Ignore virtual sections, they don't cause file size modifications.
 662       if (SD->getSection().isVirtualSection())
 663         continue;
 664
 665       // Otherwise, create a new align fragment at the end of the previous
 666       // section.
 667       MCAlignFragment *AF = new MCAlignFragment(Align, 0, 1, Align,
 668                                                 Layout.getSectionOrder()[i - 1]);
 669       AF->setOnlyAlignAddress(true);
 670     }
 671   }
 672
 673   // Create dummy fragments and assign section ordinals.
 674   unsigned SectionIndex = 0;
 675   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 676     // Create dummy fragments to eliminate any empty sections, this simplifies
 677     // layout.
 678     if (it->getFragmentList().empty())
 679       new MCDataFragment(it);
 680
 681     it->setOrdinal(SectionIndex++);
 682   }
 683
 684   // Assign layout order indices to sections and fragments.
 685   unsigned FragmentIndex = 0;
 686   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i) {
 687     MCSectionData *SD = Layout.getSectionOrder()[i];
 688     SD->setLayoutOrder(i);
 689
 690     for (MCSectionData::iterator it2 = SD->begin(),
 691            ie2 = SD->end(); it2 != ie2; ++it2)
 692       it2->setLayoutOrder(FragmentIndex++);
 693   }
 694
 695   llvm::OwningPtr<MCObjectWriter> OwnWriter(0);
 696   if (Writer == 0) {
 697     //no custom Writer_ : create the default one life-managed by OwningPtr
 698     OwnWriter.reset(getBackend().createObjectWriter(OS));
 699     Writer = OwnWriter.get();
 700     if (!Writer)
 701       report_fatal_error("unable to create object writer!");
 702   }
 703
 704   // Layout until everything fits.
 705   while (LayoutOnce(*Writer, Layout))
 706     continue;
 707
 708   DEBUG_WITH_TYPE("mc-dump", {
 709       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 710       dump(); });
 711
 712   // Finalize the layout, including fragment lowering.
 713   FinishLayout(Layout);
 714
 715   DEBUG_WITH_TYPE("mc-dump", {
 716       llvm::errs() << "assembler backend - final-layout\n--\n";
 717       dump(); });
 718
 719   uint64_t StartOffset = OS.tell();
 720
 721   // Allow the object writer a chance to perform post-layout binding (for
 722   // example, to set the index fields in the symbol data).
 723   Writer->ExecutePostLayoutBinding(*this);
 724
 725   // Evaluate and apply the fixups, generating relocation entries as necessary.
 726   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 727     for (MCSectionData::iterator it2 = it->begin(),
 728            ie2 = it->end(); it2 != ie2; ++it2) {
 729       MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
 730       if (!DF)
 731         continue;
 732
 733       for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
 734              ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
 735         MCFixup &Fixup = *it3;
 736
 737         // Evaluate the fixup.
 738         MCValue Target;
 739         uint64_t FixedValue;
 740         if (!EvaluateFixup(*Writer, Layout, Fixup, DF, Target, FixedValue)) {
 741           // The fixup was unresolved, we need a relocation. Inform the object
 742           // writer of the relocation, and give it an opportunity to adjust the
 743           // fixup value if need be.
 744           Writer->RecordRelocation(*this, Layout, DF, Fixup, Target,FixedValue);
 745         }
 746
 747         getBackend().ApplyFixup(Fixup, *DF, FixedValue);
 748       }
 749     }
 750   }
 751
 752   // Write the object file.
 753   Writer->WriteObject(*this, Layout);
 754
 755   stats::ObjectBytes += OS.tell() - StartOffset;
 756 }
 757
 758 bool MCAssembler::FixupNeedsRelaxation(const MCObjectWriter &Writer,
 759                                        const MCFixup &Fixup,
 760                                        const MCFragment *DF,
 761                                        const MCAsmLayout &Layout) const {
 762   if (getRelaxAll())
 763     return true;
 764
 765   // If we cannot resolve the fixup value, it requires relaxation.
 766   MCValue Target;
 767   uint64_t Value;
 768   if (!EvaluateFixup(Writer, Layout, Fixup, DF, Target, Value))
 769     return true;
 770
 771   // Otherwise, relax if the value is too big for a (signed) i8.
 772   //
 773   // FIXME: This is target dependent!
 774   return int64_t(Value) != int64_t(int8_t(Value));
 775 }
 776
 777 bool MCAssembler::FragmentNeedsRelaxation(const MCObjectWriter &Writer,
 778                                           const MCInstFragment *IF,
 779                                           const MCAsmLayout &Layout) const {
 780   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 781   // are intentionally pushing out inst fragments, or because we relaxed a
 782   // previous instruction to one that doesn't need relaxation.
 783   if (!getBackend().MayNeedRelaxation(IF->getInst()))
 784     return false;
 785
 786   for (MCInstFragment::const_fixup_iterator it = IF->fixup_begin(),
 787          ie = IF->fixup_end(); it != ie; ++it)
 788     if (FixupNeedsRelaxation(Writer, *it, IF, Layout))
 789       return true;
 790
 791   return false;
 792 }
 793
 794 bool MCAssembler::RelaxInstruction(const MCObjectWriter &Writer,
 795                                    MCAsmLayout &Layout,
 796                                    MCInstFragment &IF) {
 797   if (!FragmentNeedsRelaxation(Writer, &IF, Layout))
 798     return false;
 799
 800   ++stats::RelaxedInstructions;
 801
 802   // FIXME-PERF: We could immediately lower out instructions if we can tell
 803   // they are fully resolved, to avoid retesting on later passes.
 804
 805   // Relax the fragment.
 806
 807   MCInst Relaxed;
 808   getBackend().RelaxInstruction(IF.getInst(), Relaxed);
 809
 810   // Encode the new instruction.
 811   //
 812   // FIXME-PERF: If it matters, we could let the target do this. It can
 813   // probably do so more efficiently in many cases.
 814   SmallVector<MCFixup, 4> Fixups;
 815   SmallString<256> Code;
 816   raw_svector_ostream VecOS(Code);
 817   getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups);
 818   VecOS.flush();
 819
 820   // Update the instruction fragment.
 821   IF.setInst(Relaxed);
 822   IF.getCode() = Code;
 823   IF.getFixups().clear();
 824   // FIXME: Eliminate copy.
 825   for (unsigned i = 0, e = Fixups.size(); i != e; ++i)
 826     IF.getFixups().push_back(Fixups[i]);
 827
 828   return true;
 829 }
 830
 831 bool MCAssembler::RelaxOrg(const MCObjectWriter &Writer,
 832                            MCAsmLayout &Layout,
 833                            MCOrgFragment &OF) {
 834   int64_t TargetLocation;
 835   if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
 836     report_fatal_error("expected assembly-time absolute expression");
 837
 838   // FIXME: We need a way to communicate this error.
 839   uint64_t FragmentOffset = Layout.getFragmentOffset(&OF);
 840   int64_t Offset = TargetLocation - FragmentOffset;
 841   if (Offset < 0 || Offset >= 0x40000000)
 842     report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
 843                        "' (at offset '" + Twine(FragmentOffset) + "')");
 844
 845   unsigned OldSize = OF.getSize();
 846   OF.setSize(Offset);
 847   return OldSize != OF.getSize();
 848 }
 849
 850 bool MCAssembler::RelaxLEB(const MCObjectWriter &Writer,
 851                            MCAsmLayout &Layout,
 852                            MCLEBFragment &LF) {
 853   int64_t Value;
 854   LF.getValue().EvaluateAsAbsolute(Value, &Layout);
 855   SmallString<32> Tmp;
 856   raw_svector_ostream OSE(Tmp);
 857   if (LF.isSigned())
 858     MCObjectWriter::EncodeSLEB128(Value, OSE);
 859   else
 860     MCObjectWriter::EncodeULEB128(Value, OSE);
 861   uint64_t OldSize = LF.getSize();
 862   LF.setSize(OSE.GetNumBytesInBuffer());
 863   return OldSize != LF.getSize();
 864 }
 865
 866 bool MCAssembler::RelaxDwarfLineAddr(const MCObjectWriter &Writer,
 867                                      MCAsmLayout &Layout,
 868                                      MCDwarfLineAddrFragment &DF) {
 869   int64_t AddrDelta;
 870   DF.getAddrDelta().EvaluateAsAbsolute(AddrDelta, &Layout);
 871   int64_t LineDelta;
 872   LineDelta = DF.getLineDelta();
 873   uint64_t OldSize = DF.getSize();
 874   DF.setSize(MCDwarfLineAddr::ComputeSize(LineDelta, AddrDelta));
 875   return OldSize != DF.getSize();
 876 }
 877
 878 bool MCAssembler::LayoutOnce(const MCObjectWriter &Writer,
 879                              MCAsmLayout &Layout) {
 880   ++stats::RelaxationSteps;
 881
 882   // Layout the sections in order.
 883   Layout.LayoutFile();
 884
 885   // Scan for fragments that need relaxation.
 886   bool WasRelaxed = false;
 887   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 888     MCSectionData &SD = *it;
 889
 890     for (MCSectionData::iterator it2 = SD.begin(),
 891            ie2 = SD.end(); it2 != ie2; ++it2) {
 892       // Check if this is an fragment that needs relaxation.
 893       bool relaxedFrag = false;
 894       switch(it2->getKind()) {
 895       default:
 896         break;
 897       case MCFragment::FT_Inst:
 898         relaxedFrag = RelaxInstruction(Writer, Layout,
 899                                        *cast<MCInstFragment>(it2));
 900         break;
 901       case MCFragment::FT_Org:
 902         relaxedFrag = RelaxOrg(Writer, Layout, *cast<MCOrgFragment>(it2));
 903         break;
 904       case MCFragment::FT_Dwarf:
 905         relaxedFrag = RelaxDwarfLineAddr(Writer, Layout,
 906                                          *cast<MCDwarfLineAddrFragment>(it2));
 907         break;
 908       case MCFragment::FT_LEB:
 909         relaxedFrag = RelaxLEB(Writer, Layout, *cast<MCLEBFragment>(it2));
 910         break;
 911       }
 912       // Update the layout, and remember that we relaxed.
 913       if (relaxedFrag)
 914         Layout.Invalidate(it2);
 915       WasRelaxed |= relaxedFrag;
 916     }
 917   }
 918
 919   return WasRelaxed;
 920 }
 921
 922 static void LowerInstFragment(MCInstFragment *IF,
 923                               MCDataFragment *DF) {
 924
 925   uint64_t DataOffset = DF->getContents().size();
 926
 927   // Copy in the data
 928   DF->getContents().append(IF->getCode().begin(), IF->getCode().end());
 929
 930   // Adjust the fixup offsets and add them to the data fragment.
 931   for (unsigned i = 0, e = IF->getFixups().size(); i != e; ++i) {
 932     MCFixup &F = IF->getFixups()[i];
 933     F.setOffset(DataOffset + F.getOffset());
 934     DF->getFixups().push_back(F);
 935   }
 936 }
 937
 938 void MCAssembler::FinishLayout(MCAsmLayout &Layout) {
 939   // Lower out any instruction fragments, to simplify the fixup application and
 940   // output.
 941   //
 942   // FIXME-PERF: We don't have to do this, but the assumption is that it is
 943   // cheap (we will mostly end up eliminating fragments and appending on to data
 944   // fragments), so the extra complexity downstream isn't worth it. Evaluate
 945   // this assumption.
 946   unsigned FragmentIndex = 0;
 947   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i) {
 948     MCSectionData &SD = *Layout.getSectionOrder()[i];
 949     MCDataFragment *CurDF = NULL;
 950
 951     for (MCSectionData::iterator it2 = SD.begin(),
 952            ie2 = SD.end(); it2 != ie2; ++it2) {
 953       switch (it2->getKind()) {
 954       default:
 955         CurDF = NULL;
 956         break;
 957       case MCFragment::FT_Data:
 958         CurDF = cast<MCDataFragment>(it2);
 959         break;
 960       case MCFragment::FT_Inst: {
 961         MCInstFragment *IF = cast<MCInstFragment>(it2);
 962         // Use the existing data fragment if possible.
 963         if (CurDF && CurDF->getAtom() == IF->getAtom()) {
 964           Layout.CoalesceFragments(IF, CurDF);
 965         } else {
 966           // Otherwise, create a new data fragment.
 967           CurDF = new MCDataFragment();
 968           Layout.ReplaceFragment(IF, CurDF);
 969         }
 970
 971         // Lower the Instruction Fragment
 972         LowerInstFragment(IF, CurDF);
 973
 974         // Delete the instruction fragment and update the iterator.
 975         delete IF;
 976         it2 = CurDF;
 977         break;
 978       }
 979       }
 980       // Since we may have merged fragments, fix the layout order.
 981       it2->setLayoutOrder(FragmentIndex++);
 982     }
 983   }
 984 }
 985
 986 // Debugging methods
 987
 988 namespace llvm {
 989
 990 raw_ostream &operator<<(raw_ostream &OS, const MCFixup &AF) {
 991   OS << "<MCFixup" << " Offset:" << AF.getOffset()
 992      << " Value:" << *AF.getValue()
 993      << " Kind:" << AF.getKind() << ">";
 994   return OS;
 995 }
 996
 997 }
 998
 999 void MCFragment::dump() {
1000   raw_ostream &OS = llvm::errs();
1001
1002   OS << "<";
1003   switch (getKind()) {
1004   case MCFragment::FT_Align: OS << "MCAlignFragment"; break;
1005   case MCFragment::FT_Data:  OS << "MCDataFragment"; break;
1006   case MCFragment::FT_Fill:  OS << "MCFillFragment"; break;
1007   case MCFragment::FT_Inst:  OS << "MCInstFragment"; break;
1008   case MCFragment::FT_Org:   OS << "MCOrgFragment"; break;
1009   case MCFragment::FT_Dwarf: OS << "MCDwarfFragment"; break;
1010   case MCFragment::FT_LEB:   OS << "MCLEBFragment"; break;
1011   }
1012
1013   OS << "<MCFragment " << (void*) this << " LayoutOrder:" << LayoutOrder
1014      << " Offset:" << Offset << " EffectiveSize:" << EffectiveSize << ">";
1015
1016   switch (getKind()) {
1017   case MCFragment::FT_Align: {
1018     const MCAlignFragment *AF = cast<MCAlignFragment>(this);
1019     if (AF->hasEmitNops())
1020       OS << " (emit nops)";
1021     if (AF->hasOnlyAlignAddress())
1022       OS << " (only align section)";
1023     OS << "\n       ";
1024     OS << " Alignment:" << AF->getAlignment()
1025        << " Value:" << AF->getValue() << " ValueSize:" << AF->getValueSize()
1026        << " MaxBytesToEmit:" << AF->getMaxBytesToEmit() << ">";
1027     break;
1028   }
1029   case MCFragment::FT_Data:  {
1030     const MCDataFragment *DF = cast<MCDataFragment>(this);
1031     OS << "\n       ";
1032     OS << " Contents:[";
1033     const SmallVectorImpl<char> &Contents = DF->getContents();
1034     for (unsigned i = 0, e = Contents.size(); i != e; ++i) {
1035       if (i) OS << ",";
1036       OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
1037     }
1038     OS << "] (" << Contents.size() << " bytes)";
1039
1040     if (!DF->getFixups().empty()) {
1041       OS << ",\n       ";
1042       OS << " Fixups:[";
1043       for (MCDataFragment::const_fixup_iterator it = DF->fixup_begin(),
1044              ie = DF->fixup_end(); it != ie; ++it) {
1045         if (it != DF->fixup_begin()) OS << ",\n                ";
1046         OS << *it;
1047       }
1048       OS << "]";
1049     }
1050     break;
1051   }
1052   case MCFragment::FT_Fill:  {
1053     const MCFillFragment *FF = cast<MCFillFragment>(this);
1054     OS << " Value:" << FF->getValue() << " ValueSize:" << FF->getValueSize()
1055        << " Size:" << FF->getSize();
1056     break;
1057   }
1058   case MCFragment::FT_Inst:  {
1059     const MCInstFragment *IF = cast<MCInstFragment>(this);
1060     OS << "\n       ";
1061     OS << " Inst:";
1062     IF->getInst().dump_pretty(OS);
1063     break;
1064   }
1065   case MCFragment::FT_Org:  {
1066     const MCOrgFragment *OF = cast<MCOrgFragment>(this);
1067     OS << "\n       ";
1068     OS << " Offset:" << OF->getOffset() << " Value:" << OF->getValue();
1069     break;
1070   }
1071   case MCFragment::FT_Dwarf:  {
1072     const MCDwarfLineAddrFragment *OF = cast<MCDwarfLineAddrFragment>(this);
1073     OS << "\n       ";
1074     OS << " AddrDelta:" << OF->getAddrDelta()
1075        << " LineDelta:" << OF->getLineDelta();
1076     break;
1077   }
1078   case MCFragment::FT_LEB: {
1079     const MCLEBFragment *LF = cast<MCLEBFragment>(this);
1080     OS << "\n       ";
1081     OS << " Value:" << LF->getValue() << " Signed:" << LF->isSigned();
1082     break;
1083   }
1084   }
1085   OS << ">";
1086 }
1087
1088 void MCSectionData::dump() {
1089   raw_ostream &OS = llvm::errs();
1090
1091   OS << "<MCSectionData";
1092   OS << " Alignment:" << getAlignment() << " Address:" << Address
1093      << " Fragments:[\n      ";
1094   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1095     if (it != begin()) OS << ",\n      ";
1096     it->dump();
1097   }
1098   OS << "]>";
1099 }
1100
1101 void MCSymbolData::dump() {
1102   raw_ostream &OS = llvm::errs();
1103
1104   OS << "<MCSymbolData Symbol:" << getSymbol()
1105      << " Fragment:" << getFragment() << " Offset:" << getOffset()
1106      << " Flags:" << getFlags() << " Index:" << getIndex();
1107   if (isCommon())
1108     OS << " (common, size:" << getCommonSize()
1109        << " align: " << getCommonAlignment() << ")";
1110   if (isExternal())
1111     OS << " (external)";
1112   if (isPrivateExtern())
1113     OS << " (private extern)";
1114   OS << ">";
1115 }
1116
1117 void MCAssembler::dump() {
1118   raw_ostream &OS = llvm::errs();
1119
1120   OS << "<MCAssembler\n";
1121   OS << "  Sections:[\n    ";
1122   for (iterator it = begin(), ie = end(); it != ie; ++it) {
1123     if (it != begin()) OS << ",\n    ";
1124     it->dump();
1125   }
1126   OS << "],\n";
1127   OS << "  Symbols:[";
1128
1129   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
1130     if (it != symbol_begin()) OS << ",\n           ";
1131     it->dump();
1132   }
1133   OS << "]>\n";
1134 }