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