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