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