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