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/MCSymbol.h"
  17 #include "llvm/MC/MCValue.h"
  18 #include "llvm/ADT/OwningPtr.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/ADT/StringExtras.h"
  21 #include "llvm/ADT/Twine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/raw_ostream.h"
  25 #include "llvm/Target/TargetRegistry.h"
  26 #include "llvm/Target/TargetAsmBackend.h"
  27
  28 #include <vector>
  29 using namespace llvm;
  30
  31 namespace {
  32 namespace stats {
  33 STATISTIC(EmittedFragments, "Number of emitted assembler fragments");
  34 STATISTIC(EvaluateFixup, "Number of evaluated fixups");
  35 STATISTIC(FragmentLayouts, "Number of fragment layouts");
  36 STATISTIC(ObjectBytes, "Number of emitted object file bytes");
  37 STATISTIC(RelaxationSteps, "Number of assembler layout and relaxation steps");
  38 STATISTIC(RelaxedInstructions, "Number of relaxed instructions");
  39 STATISTIC(SectionLayouts, "Number of section layouts");
  40 }
  41 }
  42
  43 // FIXME FIXME FIXME: There are number of places in this file where we convert
  44 // what is a 64-bit assembler value used for computation into a value in the
  45 // object file, which may truncate it. We should detect that truncation where
  46 // invalid and report errors back.
  47
  48 /* *** */
  49
  50 MCAsmLayout::MCAsmLayout(MCAssembler &Asm) : Assembler(Asm) {
  51   // Compute the section layout order. Virtual sections must go last.
  52   for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
  53     if (!Asm.getBackend().isVirtualSection(it->getSection()))
  54       SectionOrder.push_back(&*it);
  55   for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
  56     if (Asm.getBackend().isVirtualSection(it->getSection()))
  57       SectionOrder.push_back(&*it);
  58 }
  59
  60 void MCAsmLayout::UpdateForSlide(MCFragment *F, int SlideAmount) {
  61   // We shouldn't have to do anything special to support negative slides, and it
  62   // is a perfectly valid thing to do as long as other parts of the system can
  63   // guarantee convergence.
  64   assert(SlideAmount >= 0 && "Negative slides not yet supported");
  65
  66   // Update the layout by simply recomputing the layout for the entire
  67   // file. This is trivially correct, but very slow.
  68   //
  69   // FIXME-PERF: This is O(N^2), but will be eliminated once we get smarter.
  70
  71   // Layout the sections in order.
  72   for (unsigned i = 0, e = getSectionOrder().size(); i != e; ++i)
  73     getAssembler().LayoutSection(*this, i);
  74 }
  75
  76 uint64_t MCAsmLayout::getFragmentAddress(const MCFragment *F) const {
  77   assert(F->getParent() && "Missing section()!");
  78   return getSectionAddress(F->getParent()) + getFragmentOffset(F);
  79 }
  80
  81 uint64_t MCAsmLayout::getFragmentEffectiveSize(const MCFragment *F) const {
  82   assert(F->EffectiveSize != ~UINT64_C(0) && "Address not set!");
  83   return F->EffectiveSize;
  84 }
  85
  86 void MCAsmLayout::setFragmentEffectiveSize(MCFragment *F, uint64_t Value) {
  87   F->EffectiveSize = Value;
  88 }
  89
  90 uint64_t MCAsmLayout::getFragmentOffset(const MCFragment *F) const {
  91   assert(F->Offset != ~UINT64_C(0) && "Address not set!");
  92   return F->Offset;
  93 }
  94
  95 void MCAsmLayout::setFragmentOffset(MCFragment *F, uint64_t Value) {
  96   F->Offset = Value;
  97 }
  98
  99 uint64_t MCAsmLayout::getSymbolAddress(const MCSymbolData *SD) const {
 100   assert(SD->getFragment() && "Invalid getAddress() on undefined symbol!");
 101   return getFragmentAddress(SD->getFragment()) + SD->getOffset();
 102 }
 103
 104 uint64_t MCAsmLayout::getSectionAddress(const MCSectionData *SD) const {
 105   assert(SD->Address != ~UINT64_C(0) && "Address not set!");
 106   return SD->Address;
 107 }
 108
 109 void MCAsmLayout::setSectionAddress(MCSectionData *SD, uint64_t Value) {
 110   SD->Address = Value;
 111 }
 112
 113 uint64_t MCAsmLayout::getSectionSize(const MCSectionData *SD) const {
 114   assert(SD->Size != ~UINT64_C(0) && "File size not set!");
 115   return SD->Size;
 116 }
 117 void MCAsmLayout::setSectionSize(MCSectionData *SD, uint64_t Value) {
 118   SD->Size = Value;
 119 }
 120
 121 uint64_t MCAsmLayout::getSectionFileSize(const MCSectionData *SD) const {
 122   assert(SD->FileSize != ~UINT64_C(0) && "File size not set!");
 123   return SD->FileSize;
 124 }
 125 void MCAsmLayout::setSectionFileSize(MCSectionData *SD, uint64_t Value) {
 126   SD->FileSize = Value;
 127 }
 128
 129 /* *** */
 130
 131 MCFragment::MCFragment() : Kind(FragmentType(~0)) {
 132 }
 133
 134 MCFragment::MCFragment(FragmentType _Kind, MCSectionData *_Parent)
 135   : Kind(_Kind), Parent(_Parent), Atom(0), EffectiveSize(~UINT64_C(0))
 136 {
 137   if (Parent)
 138     Parent->getFragmentList().push_back(this);
 139 }
 140
 141 MCFragment::~MCFragment() {
 142 }
 143
 144 /* *** */
 145
 146 MCSectionData::MCSectionData() : Section(0) {}
 147
 148 MCSectionData::MCSectionData(const MCSection &_Section, MCAssembler *A)
 149   : Section(&_Section),
 150     Alignment(1),
 151     Address(~UINT64_C(0)),
 152     Size(~UINT64_C(0)),
 153     FileSize(~UINT64_C(0)),
 154     HasInstructions(false)
 155 {
 156   if (A)
 157     A->getSectionList().push_back(this);
 158 }
 159
 160 /* *** */
 161
 162 MCSymbolData::MCSymbolData() : Symbol(0) {}
 163
 164 MCSymbolData::MCSymbolData(const MCSymbol &_Symbol, MCFragment *_Fragment,
 165                            uint64_t _Offset, MCAssembler *A)
 166   : Symbol(&_Symbol), Fragment(_Fragment), Offset(_Offset),
 167     IsExternal(false), IsPrivateExtern(false),
 168     CommonSize(0), CommonAlign(0), Flags(0), Index(0)
 169 {
 170   if (A)
 171     A->getSymbolList().push_back(this);
 172 }
 173
 174 /* *** */
 175
 176 MCAssembler::MCAssembler(MCContext &_Context, TargetAsmBackend &_Backend,
 177                          MCCodeEmitter &_Emitter, raw_ostream &_OS)
 178   : Context(_Context), Backend(_Backend), Emitter(_Emitter),
 179     OS(_OS), RelaxAll(false), SubsectionsViaSymbols(false)
 180 {
 181 }
 182
 183 MCAssembler::~MCAssembler() {
 184 }
 185
 186 static bool isScatteredFixupFullyResolvedSimple(const MCAssembler &Asm,
 187                                                 const MCAsmFixup &Fixup,
 188                                                 const MCValue Target,
 189                                                 const MCSection *BaseSection) {
 190   // The effective fixup address is
 191   //     addr(atom(A)) + offset(A)
 192   //   - addr(atom(B)) - offset(B)
 193   //   - addr(<base symbol>) + <fixup offset from base symbol>
 194   // and the offsets are not relocatable, so the fixup is fully resolved when
 195   //  addr(atom(A)) - addr(atom(B)) - addr(<base symbol>)) == 0.
 196   //
 197   // The simple (Darwin, except on x86_64) way of dealing with this was to
 198   // assume that any reference to a temporary symbol *must* be a temporary
 199   // symbol in the same atom, unless the sections differ. Therefore, any PCrel
 200   // relocation to a temporary symbol (in the same section) is fully
 201   // resolved. This also works in conjunction with absolutized .set, which
 202   // requires the compiler to use .set to absolutize the differences between
 203   // symbols which the compiler knows to be assembly time constants, so we don't
 204   // need to worry about considering symbol differences fully resolved.
 205
 206   // Non-relative fixups are only resolved if constant.
 207   if (!BaseSection)
 208     return Target.isAbsolute();
 209
 210   // Otherwise, relative fixups are only resolved if not a difference and the
 211   // target is a temporary in the same section.
 212   if (Target.isAbsolute() || Target.getSymB())
 213     return false;
 214
 215   const MCSymbol *A = &Target.getSymA()->getSymbol();
 216   if (!A->isTemporary() || !A->isInSection() ||
 217       &A->getSection() != BaseSection)
 218     return false;
 219
 220   return true;
 221 }
 222
 223 static bool isScatteredFixupFullyResolved(const MCAssembler &Asm,
 224                                           const MCAsmLayout &Layout,
 225                                           const MCAsmFixup &Fixup,
 226                                           const MCValue Target,
 227                                           const MCSymbolData *BaseSymbol) {
 228   // The effective fixup address is
 229   //     addr(atom(A)) + offset(A)
 230   //   - addr(atom(B)) - offset(B)
 231   //   - addr(BaseSymbol) + <fixup offset from base symbol>
 232   // and the offsets are not relocatable, so the fixup is fully resolved when
 233   //  addr(atom(A)) - addr(atom(B)) - addr(BaseSymbol) == 0.
 234   //
 235   // Note that "false" is almost always conservatively correct (it means we emit
 236   // a relocation which is unnecessary), except when it would force us to emit a
 237   // relocation which the target cannot encode.
 238
 239   const MCSymbolData *A_Base = 0, *B_Base = 0;
 240   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 241     // Modified symbol references cannot be resolved.
 242     if (A->getKind() != MCSymbolRefExpr::VK_None)
 243       return false;
 244
 245     A_Base = Asm.getAtom(Layout, &Asm.getSymbolData(A->getSymbol()));
 246     if (!A_Base)
 247       return false;
 248   }
 249
 250   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 251     // Modified symbol references cannot be resolved.
 252     if (B->getKind() != MCSymbolRefExpr::VK_None)
 253       return false;
 254
 255     B_Base = Asm.getAtom(Layout, &Asm.getSymbolData(B->getSymbol()));
 256     if (!B_Base)
 257       return false;
 258   }
 259
 260   // If there is no base, A and B have to be the same atom for this fixup to be
 261   // fully resolved.
 262   if (!BaseSymbol)
 263     return A_Base == B_Base;
 264
 265   // Otherwise, B must be missing and A must be the base.
 266   return !B_Base && BaseSymbol == A_Base;
 267 }
 268
 269 bool MCAssembler::isSymbolLinkerVisible(const MCSymbolData *SD) const {
 270   // Non-temporary labels should always be visible to the linker.
 271   if (!SD->getSymbol().isTemporary())
 272     return true;
 273
 274   // Absolute temporary labels are never visible.
 275   if (!SD->getFragment())
 276     return false;
 277
 278   // Otherwise, check if the section requires symbols even for temporary labels.
 279   return getBackend().doesSectionRequireSymbols(
 280     SD->getFragment()->getParent()->getSection());
 281 }
 282
 283 const MCSymbolData *MCAssembler::getAtom(const MCAsmLayout &Layout,
 284                                          const MCSymbolData *SD) const {
 285   // Linker visible symbols define atoms.
 286   if (isSymbolLinkerVisible(SD))
 287     return SD;
 288
 289   // Absolute and undefined symbols have no defining atom.
 290   if (!SD->getFragment())
 291     return 0;
 292
 293   // Non-linker visible symbols in sections which can't be atomized have no
 294   // defining atom.
 295   if (!getBackend().isSectionAtomizable(
 296         SD->getFragment()->getParent()->getSection()))
 297     return 0;
 298
 299   // Otherwise, return the atom for the containing fragment.
 300   return SD->getFragment()->getAtom();
 301 }
 302
 303 bool MCAssembler::EvaluateFixup(const MCAsmLayout &Layout,
 304                                 const MCAsmFixup &Fixup, const MCFragment *DF,
 305                                 MCValue &Target, uint64_t &Value) const {
 306   ++stats::EvaluateFixup;
 307
 308   if (!Fixup.Value->EvaluateAsRelocatable(Target, &Layout))
 309     report_fatal_error("expected relocatable expression");
 310
 311   // FIXME: How do non-scattered symbols work in ELF? I presume the linker
 312   // doesn't support small relocations, but then under what criteria does the
 313   // assembler allow symbol differences?
 314
 315   Value = Target.getConstant();
 316
 317   bool IsPCRel =
 318     Emitter.getFixupKindInfo(Fixup.Kind).Flags & MCFixupKindInfo::FKF_IsPCRel;
 319   bool IsResolved = true;
 320   if (const MCSymbolRefExpr *A = Target.getSymA()) {
 321     if (A->getSymbol().isDefined())
 322       Value += Layout.getSymbolAddress(&getSymbolData(A->getSymbol()));
 323     else
 324       IsResolved = false;
 325   }
 326   if (const MCSymbolRefExpr *B = Target.getSymB()) {
 327     if (B->getSymbol().isDefined())
 328       Value -= Layout.getSymbolAddress(&getSymbolData(B->getSymbol()));
 329     else
 330       IsResolved = false;
 331   }
 332
 333   // If we are using scattered symbols, determine whether this value is actually
 334   // resolved; scattering may cause atoms to move.
 335   if (IsResolved && getBackend().hasScatteredSymbols()) {
 336     if (getBackend().hasReliableSymbolDifference()) {
 337       // If this is a PCrel relocation, find the base atom (identified by its
 338       // symbol) that the fixup value is relative to.
 339       const MCSymbolData *BaseSymbol = 0;
 340       if (IsPCRel) {
 341         BaseSymbol = DF->getAtom();
 342         if (!BaseSymbol)
 343           IsResolved = false;
 344       }
 345
 346       if (IsResolved)
 347         IsResolved = isScatteredFixupFullyResolved(*this, Layout, Fixup, Target,
 348                                                    BaseSymbol);
 349     } else {
 350       const MCSection *BaseSection = 0;
 351       if (IsPCRel)
 352         BaseSection = &DF->getParent()->getSection();
 353
 354       IsResolved = isScatteredFixupFullyResolvedSimple(*this, Fixup, Target,
 355                                                        BaseSection);
 356     }
 357   }
 358
 359   if (IsPCRel)
 360     Value -= Layout.getFragmentAddress(DF) + Fixup.Offset;
 361
 362   return IsResolved;
 363 }
 364
 365 void MCAssembler::LayoutFragment(MCAsmLayout &Layout, MCFragment &F) {
 366   uint64_t StartAddress = Layout.getSectionAddress(F.getParent());
 367
 368   // Get the fragment start address.
 369   uint64_t Address = StartAddress;
 370   MCSectionData::iterator it = &F;
 371   if (MCFragment *Prev = F.getPrevNode())
 372     Address = (StartAddress + Layout.getFragmentOffset(Prev) +
 373                Layout.getFragmentEffectiveSize(Prev));
 374
 375   ++stats::FragmentLayouts;
 376
 377   uint64_t FragmentOffset = Address - StartAddress;
 378   Layout.setFragmentOffset(&F, FragmentOffset);
 379
 380   // Evaluate fragment size.
 381   uint64_t EffectiveSize = 0;
 382   switch (F.getKind()) {
 383   case MCFragment::FT_Align: {
 384     MCAlignFragment &AF = cast<MCAlignFragment>(F);
 385
 386     EffectiveSize = OffsetToAlignment(Address, AF.getAlignment());
 387     if (EffectiveSize > AF.getMaxBytesToEmit())
 388       EffectiveSize = 0;
 389     break;
 390   }
 391
 392   case MCFragment::FT_Data:
 393     EffectiveSize = cast<MCDataFragment>(F).getContents().size();
 394     break;
 395
 396   case MCFragment::FT_Fill: {
 397     MCFillFragment &FF = cast<MCFillFragment>(F);
 398     EffectiveSize = FF.getValueSize() * FF.getCount();
 399     break;
 400   }
 401
 402   case MCFragment::FT_Inst:
 403     EffectiveSize = cast<MCInstFragment>(F).getInstSize();
 404     break;
 405
 406   case MCFragment::FT_Org: {
 407     MCOrgFragment &OF = cast<MCOrgFragment>(F);
 408
 409     int64_t TargetLocation;
 410     if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
 411       report_fatal_error("expected assembly-time absolute expression");
 412
 413     // FIXME: We need a way to communicate this error.
 414     int64_t Offset = TargetLocation - FragmentOffset;
 415     if (Offset < 0)
 416       report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
 417                          "' (at offset '" + Twine(FragmentOffset) + "'");
 418
 419     EffectiveSize = Offset;
 420     break;
 421   }
 422
 423   case MCFragment::FT_ZeroFill: {
 424     MCZeroFillFragment &ZFF = cast<MCZeroFillFragment>(F);
 425
 426     // Align the fragment offset; it is safe to adjust the offset freely since
 427     // this is only in virtual sections.
 428     //
 429     // FIXME: We shouldn't be doing this here.
 430     Address = RoundUpToAlignment(Address, ZFF.getAlignment());
 431     Layout.setFragmentOffset(&F, Address - StartAddress);
 432
 433     EffectiveSize = ZFF.getSize();
 434     break;
 435   }
 436   }
 437
 438   Layout.setFragmentEffectiveSize(&F, EffectiveSize);
 439 }
 440
 441 void MCAssembler::LayoutSection(MCAsmLayout &Layout,
 442                                 unsigned SectionOrderIndex) {
 443   MCSectionData &SD = *Layout.getSectionOrder()[SectionOrderIndex];
 444   bool IsVirtual = getBackend().isVirtualSection(SD.getSection());
 445
 446   ++stats::SectionLayouts;
 447
 448   // Get the section start address.
 449   uint64_t StartAddress = 0;
 450   if (SectionOrderIndex) {
 451     MCSectionData *Prev = Layout.getSectionOrder()[SectionOrderIndex - 1];
 452     StartAddress = Layout.getSectionAddress(Prev) + Layout.getSectionSize(Prev);
 453   }
 454
 455   // Align this section if necessary by adding padding bytes to the previous
 456   // section. It is safe to adjust this out-of-band, because no symbol or
 457   // fragment is allowed to point past the end of the section at any time.
 458   if (uint64_t Pad = OffsetToAlignment(StartAddress, SD.getAlignment())) {
 459     // Unless this section is virtual (where we are allowed to adjust the offset
 460     // freely), the padding goes in the previous section.
 461     if (!IsVirtual) {
 462       // Find the previous non-virtual section.
 463       iterator it = &SD;
 464       assert(it != begin() && "Invalid initial section address!");
 465       for (--it; getBackend().isVirtualSection(it->getSection()); --it) ;
 466       Layout.setSectionFileSize(&*it, Layout.getSectionFileSize(&*it) + Pad);
 467     }
 468
 469     StartAddress += Pad;
 470   }
 471
 472   // Set the aligned section address.
 473   Layout.setSectionAddress(&SD, StartAddress);
 474
 475   for (MCSectionData::iterator it = SD.begin(), ie = SD.end(); it != ie; ++it)
 476     LayoutFragment(Layout, *it);
 477
 478   // Set the section sizes.
 479   uint64_t Size = 0;
 480   if (!SD.getFragmentList().empty()) {
 481     MCFragment *F = &SD.getFragmentList().back();
 482     Size = Layout.getFragmentOffset(F) + Layout.getFragmentEffectiveSize(F);
 483   }
 484   Layout.setSectionSize(&SD, Size);
 485   Layout.setSectionFileSize(&SD, IsVirtual ? 0 : Size);
 486 }
 487
 488 /// WriteFragmentData - Write the \arg F data to the output file.
 489 static void WriteFragmentData(const MCAssembler &Asm, const MCAsmLayout &Layout,
 490                               const MCFragment &F, MCObjectWriter *OW) {
 491   uint64_t Start = OW->getStream().tell();
 492   (void) Start;
 493
 494   ++stats::EmittedFragments;
 495
 496   // FIXME: Embed in fragments instead?
 497   uint64_t FragmentSize = Layout.getFragmentEffectiveSize(&F);
 498   switch (F.getKind()) {
 499   case MCFragment::FT_Align: {
 500     MCAlignFragment &AF = cast<MCAlignFragment>(F);
 501     uint64_t Count = FragmentSize / AF.getValueSize();
 502
 503     // FIXME: This error shouldn't actually occur (the front end should emit
 504     // multiple .align directives to enforce the semantics it wants), but is
 505     // severe enough that we want to report it. How to handle this?
 506     if (Count * AF.getValueSize() != FragmentSize)
 507       report_fatal_error("undefined .align directive, value size '" +
 508                         Twine(AF.getValueSize()) +
 509                         "' is not a divisor of padding size '" +
 510                         Twine(FragmentSize) + "'");
 511
 512     // See if we are aligning with nops, and if so do that first to try to fill
 513     // the Count bytes.  Then if that did not fill any bytes or there are any
 514     // bytes left to fill use the the Value and ValueSize to fill the rest.
 515     // If we are aligning with nops, ask that target to emit the right data.
 516     if (AF.getEmitNops()) {
 517       if (!Asm.getBackend().WriteNopData(Count, OW))
 518         report_fatal_error("unable to write nop sequence of " +
 519                           Twine(Count) + " bytes");
 520       break;
 521     }
 522
 523     // Otherwise, write out in multiples of the value size.
 524     for (uint64_t i = 0; i != Count; ++i) {
 525       switch (AF.getValueSize()) {
 526       default:
 527         assert(0 && "Invalid size!");
 528       case 1: OW->Write8 (uint8_t (AF.getValue())); break;
 529       case 2: OW->Write16(uint16_t(AF.getValue())); break;
 530       case 4: OW->Write32(uint32_t(AF.getValue())); break;
 531       case 8: OW->Write64(uint64_t(AF.getValue())); break;
 532       }
 533     }
 534     break;
 535   }
 536
 537   case MCFragment::FT_Data: {
 538     MCDataFragment &DF = cast<MCDataFragment>(F);
 539     assert(FragmentSize == DF.getContents().size() && "Invalid size!");
 540     OW->WriteBytes(DF.getContents().str());
 541     break;
 542   }
 543
 544   case MCFragment::FT_Fill: {
 545     MCFillFragment &FF = cast<MCFillFragment>(F);
 546     for (uint64_t i = 0, e = FF.getCount(); i != e; ++i) {
 547       switch (FF.getValueSize()) {
 548       default:
 549         assert(0 && "Invalid size!");
 550       case 1: OW->Write8 (uint8_t (FF.getValue())); break;
 551       case 2: OW->Write16(uint16_t(FF.getValue())); break;
 552       case 4: OW->Write32(uint32_t(FF.getValue())); break;
 553       case 8: OW->Write64(uint64_t(FF.getValue())); break;
 554       }
 555     }
 556     break;
 557   }
 558
 559   case MCFragment::FT_Inst:
 560     llvm_unreachable("unexpected inst fragment after lowering");
 561     break;
 562
 563   case MCFragment::FT_Org: {
 564     MCOrgFragment &OF = cast<MCOrgFragment>(F);
 565
 566     for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
 567       OW->Write8(uint8_t(OF.getValue()));
 568
 569     break;
 570   }
 571
 572   case MCFragment::FT_ZeroFill: {
 573     assert(0 && "Invalid zero fill fragment in concrete section!");
 574     break;
 575   }
 576   }
 577
 578   assert(OW->getStream().tell() - Start == FragmentSize);
 579 }
 580
 581 void MCAssembler::WriteSectionData(const MCSectionData *SD,
 582                                    const MCAsmLayout &Layout,
 583                                    MCObjectWriter *OW) const {
 584   uint64_t SectionSize = Layout.getSectionSize(SD);
 585   uint64_t SectionFileSize = Layout.getSectionFileSize(SD);
 586
 587   // Ignore virtual sections.
 588   if (getBackend().isVirtualSection(SD->getSection())) {
 589     assert(SectionFileSize == 0 && "Invalid size for section!");
 590     return;
 591   }
 592
 593   uint64_t Start = OW->getStream().tell();
 594   (void) Start;
 595
 596   for (MCSectionData::const_iterator it = SD->begin(),
 597          ie = SD->end(); it != ie; ++it)
 598     WriteFragmentData(*this, Layout, *it, OW);
 599
 600   // Add section padding.
 601   assert(SectionFileSize >= SectionSize && "Invalid section sizes!");
 602   OW->WriteZeros(SectionFileSize - SectionSize);
 603
 604   assert(OW->getStream().tell() - Start == SectionFileSize);
 605 }
 606
 607 void MCAssembler::Finish() {
 608   DEBUG_WITH_TYPE("mc-dump", {
 609       llvm::errs() << "assembler backend - pre-layout\n--\n";
 610       dump(); });
 611
 612   // Assign section and fragment ordinals, all subsequent backend code is
 613   // responsible for updating these in place.
 614   unsigned SectionIndex = 0;
 615   unsigned FragmentIndex = 0;
 616   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 617     it->setOrdinal(SectionIndex++);
 618
 619     for (MCSectionData::iterator it2 = it->begin(),
 620            ie2 = it->end(); it2 != ie2; ++it2)
 621       it2->setOrdinal(FragmentIndex++);
 622   }
 623
 624   // Layout until everything fits.
 625   MCAsmLayout Layout(*this);
 626   while (LayoutOnce(Layout))
 627     continue;
 628
 629   DEBUG_WITH_TYPE("mc-dump", {
 630       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 631       dump(); });
 632
 633   // Finalize the layout, including fragment lowering.
 634   FinishLayout(Layout);
 635
 636   DEBUG_WITH_TYPE("mc-dump", {
 637       llvm::errs() << "assembler backend - final-layout\n--\n";
 638       dump(); });
 639
 640   uint64_t StartOffset = OS.tell();
 641   llvm::OwningPtr<MCObjectWriter> Writer(getBackend().createObjectWriter(OS));
 642   if (!Writer)
 643     report_fatal_error("unable to create object writer!");
 644
 645   // Allow the object writer a chance to perform post-layout binding (for
 646   // example, to set the index fields in the symbol data).
 647   Writer->ExecutePostLayoutBinding(*this);
 648
 649   // Evaluate and apply the fixups, generating relocation entries as necessary.
 650   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 651     for (MCSectionData::iterator it2 = it->begin(),
 652            ie2 = it->end(); it2 != ie2; ++it2) {
 653       MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
 654       if (!DF)
 655         continue;
 656
 657       for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
 658              ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
 659         MCAsmFixup &Fixup = *it3;
 660
 661         // Evaluate the fixup.
 662         MCValue Target;
 663         uint64_t FixedValue;
 664         if (!EvaluateFixup(Layout, Fixup, DF, Target, FixedValue)) {
 665           // The fixup was unresolved, we need a relocation. Inform the object
 666           // writer of the relocation, and give it an opportunity to adjust the
 667           // fixup value if need be.
 668           Writer->RecordRelocation(*this, Layout, DF, Fixup, Target,FixedValue);
 669         }
 670
 671         getBackend().ApplyFixup(Fixup, *DF, FixedValue);
 672       }
 673     }
 674   }
 675
 676   // Write the object file.
 677   Writer->WriteObject(*this, Layout);
 678   OS.flush();
 679
 680   stats::ObjectBytes += OS.tell() - StartOffset;
 681 }
 682
 683 bool MCAssembler::FixupNeedsRelaxation(const MCAsmFixup &Fixup,
 684                                        const MCFragment *DF,
 685                                        const MCAsmLayout &Layout) const {
 686   if (getRelaxAll())
 687     return true;
 688
 689   // If we cannot resolve the fixup value, it requires relaxation.
 690   MCValue Target;
 691   uint64_t Value;
 692   if (!EvaluateFixup(Layout, Fixup, DF, Target, Value))
 693     return true;
 694
 695   // Otherwise, relax if the value is too big for a (signed) i8.
 696   //
 697   // FIXME: This is target dependent!
 698   return int64_t(Value) != int64_t(int8_t(Value));
 699 }
 700
 701 bool MCAssembler::FragmentNeedsRelaxation(const MCInstFragment *IF,
 702                                           const MCAsmLayout &Layout) const {
 703   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 704   // are intentionally pushing out inst fragments, or because we relaxed a
 705   // previous instruction to one that doesn't need relaxation.
 706   if (!getBackend().MayNeedRelaxation(IF->getInst(), IF->getFixups()))
 707     return false;
 708
 709   for (MCInstFragment::const_fixup_iterator it = IF->fixup_begin(),
 710          ie = IF->fixup_end(); it != ie; ++it)
 711     if (FixupNeedsRelaxation(*it, IF, Layout))
 712       return true;
 713
 714   return false;
 715 }
 716
 717 bool MCAssembler::LayoutOnce(MCAsmLayout &Layout) {
 718   ++stats::RelaxationSteps;
 719
 720   // Layout the sections in order.
 721   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i)
 722     LayoutSection(Layout, i);
 723
 724   // Scan for fragments that need relaxation.
 725   bool WasRelaxed = false;
 726   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 727     MCSectionData &SD = *it;
 728
 729     for (MCSectionData::iterator it2 = SD.begin(),
 730            ie2 = SD.end(); it2 != ie2; ++it2) {
 731       // Check if this is an instruction fragment that needs relaxation.
 732       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 733       if (!IF || !FragmentNeedsRelaxation(IF, Layout))
 734         continue;
 735
 736       ++stats::RelaxedInstructions;
 737
 738       // FIXME-PERF: We could immediately lower out instructions if we can tell
 739       // they are fully resolved, to avoid retesting on later passes.
 740
 741       // Relax the fragment.
 742
 743       MCInst Relaxed;
 744       getBackend().RelaxInstruction(IF, Relaxed);
 745
 746       // Encode the new instruction.
 747       //
 748       // FIXME-PERF: If it matters, we could let the target do this. It can
 749       // probably do so more efficiently in many cases.
 750       SmallVector<MCFixup, 4> Fixups;
 751       SmallString<256> Code;
 752       raw_svector_ostream VecOS(Code);
 753       getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups);
 754       VecOS.flush();
 755
 756       // Update the instruction fragment.
 757       int SlideAmount = Code.size() - IF->getInstSize();
 758       IF->setInst(Relaxed);
 759       IF->getCode() = Code;
 760       IF->getFixups().clear();
 761       for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 762         MCFixup &F = Fixups[i];
 763         IF->getFixups().push_back(MCAsmFixup(F.getOffset(), *F.getValue(),
 764                                              F.getKind()));
 765       }
 766
 767       // Update the layout, and remember that we relaxed. If we are relaxing
 768       // everything, we can skip this step since nothing will depend on updating
 769       // the values.
 770       if (!getRelaxAll())
 771         Layout.UpdateForSlide(IF, SlideAmount);
 772       WasRelaxed = true;
 773     }
 774   }
 775
 776   return WasRelaxed;
 777 }
 778
 779 void MCAssembler::FinishLayout(MCAsmLayout &Layout) {
 780   // Lower out any instruction fragments, to simplify the fixup application and
 781   // output.
 782   //
 783   // FIXME-PERF: We don't have to do this, but the assumption is that it is
 784   // cheap (we will mostly end up eliminating fragments and appending on to data
 785   // fragments), so the extra complexity downstream isn't worth it. Evaluate
 786   // this assumption.
 787   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 788     MCSectionData &SD = *it;
 789
 790     for (MCSectionData::iterator it2 = SD.begin(),
 791            ie2 = SD.end(); it2 != ie2; ++it2) {
 792       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 793       if (!IF)
 794         continue;
 795
 796       // Create a new data fragment for the instruction.
 797       //
 798       // FIXME-PERF: Reuse previous data fragment if possible.
 799       MCDataFragment *DF = new MCDataFragment();
 800       SD.getFragmentList().insert(it2, DF);
 801
 802       // Update the data fragments layout data.
 803       //
 804       // FIXME: Add MCAsmLayout utility for this.
 805       DF->setParent(IF->getParent());
 806       DF->setAtom(IF->getAtom());
 807       DF->setOrdinal(IF->getOrdinal());
 808       Layout.setFragmentOffset(DF, Layout.getFragmentOffset(IF));
 809       Layout.setFragmentEffectiveSize(DF, Layout.getFragmentEffectiveSize(IF));
 810
 811       // Copy in the data and the fixups.
 812       DF->getContents().append(IF->getCode().begin(), IF->getCode().end());
 813       for (unsigned i = 0, e = IF->getFixups().size(); i != e; ++i)
 814         DF->getFixups().push_back(IF->getFixups()[i]);
 815
 816       // Delete the instruction fragment and update the iterator.
 817       SD.getFragmentList().erase(IF);
 818       it2 = DF;
 819     }
 820   }
 821 }
 822
 823 // Debugging methods
 824
 825 namespace llvm {
 826
 827 raw_ostream &operator<<(raw_ostream &OS, const MCAsmFixup &AF) {
 828   OS << "<MCAsmFixup" << " Offset:" << AF.Offset << " Value:" << *AF.Value
 829      << " Kind:" << AF.Kind << ">";
 830   return OS;
 831 }
 832
 833 }
 834
 835 void MCFragment::dump() {
 836   raw_ostream &OS = llvm::errs();
 837
 838   OS << "<MCFragment " << (void*) this << " Offset:" << Offset
 839      << " EffectiveSize:" << EffectiveSize;
 840
 841   OS << ">";
 842 }
 843
 844 void MCAlignFragment::dump() {
 845   raw_ostream &OS = llvm::errs();
 846
 847   OS << "<MCAlignFragment ";
 848   this->MCFragment::dump();
 849   OS << "\n       ";
 850   OS << " Alignment:" << getAlignment()
 851      << " Value:" << getValue() << " ValueSize:" << getValueSize()
 852      << " MaxBytesToEmit:" << getMaxBytesToEmit() << ">";
 853 }
 854
 855 void MCDataFragment::dump() {
 856   raw_ostream &OS = llvm::errs();
 857
 858   OS << "<MCDataFragment ";
 859   this->MCFragment::dump();
 860   OS << "\n       ";
 861   OS << " Contents:[";
 862   for (unsigned i = 0, e = getContents().size(); i != e; ++i) {
 863     if (i) OS << ",";
 864     OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
 865   }
 866   OS << "] (" << getContents().size() << " bytes)";
 867
 868   if (!getFixups().empty()) {
 869     OS << ",\n       ";
 870     OS << " Fixups:[";
 871     for (fixup_iterator it = fixup_begin(), ie = fixup_end(); it != ie; ++it) {
 872       if (it != fixup_begin()) OS << ",\n                ";
 873       OS << *it;
 874     }
 875     OS << "]";
 876   }
 877
 878   OS << ">";
 879 }
 880
 881 void MCFillFragment::dump() {
 882   raw_ostream &OS = llvm::errs();
 883
 884   OS << "<MCFillFragment ";
 885   this->MCFragment::dump();
 886   OS << "\n       ";
 887   OS << " Value:" << getValue() << " ValueSize:" << getValueSize()
 888      << " Count:" << getCount() << ">";
 889 }
 890
 891 void MCInstFragment::dump() {
 892   raw_ostream &OS = llvm::errs();
 893
 894   OS << "<MCInstFragment ";
 895   this->MCFragment::dump();
 896   OS << "\n       ";
 897   OS << " Inst:";
 898   getInst().dump_pretty(OS);
 899   OS << ">";
 900 }
 901
 902 void MCOrgFragment::dump() {
 903   raw_ostream &OS = llvm::errs();
 904
 905   OS << "<MCOrgFragment ";
 906   this->MCFragment::dump();
 907   OS << "\n       ";
 908   OS << " Offset:" << getOffset() << " Value:" << getValue() << ">";
 909 }
 910
 911 void MCZeroFillFragment::dump() {
 912   raw_ostream &OS = llvm::errs();
 913
 914   OS << "<MCZeroFillFragment ";
 915   this->MCFragment::dump();
 916   OS << "\n       ";
 917   OS << " Size:" << getSize() << " Alignment:" << getAlignment() << ">";
 918 }
 919
 920 void MCSectionData::dump() {
 921   raw_ostream &OS = llvm::errs();
 922
 923   OS << "<MCSectionData";
 924   OS << " Alignment:" << getAlignment() << " Address:" << Address
 925      << " Size:" << Size << " FileSize:" << FileSize
 926      << " Fragments:[\n      ";
 927   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 928     if (it != begin()) OS << ",\n      ";
 929     it->dump();
 930   }
 931   OS << "]>";
 932 }
 933
 934 void MCSymbolData::dump() {
 935   raw_ostream &OS = llvm::errs();
 936
 937   OS << "<MCSymbolData Symbol:" << getSymbol()
 938      << " Fragment:" << getFragment() << " Offset:" << getOffset()
 939      << " Flags:" << getFlags() << " Index:" << getIndex();
 940   if (isCommon())
 941     OS << " (common, size:" << getCommonSize()
 942        << " align: " << getCommonAlignment() << ")";
 943   if (isExternal())
 944     OS << " (external)";
 945   if (isPrivateExtern())
 946     OS << " (private extern)";
 947   OS << ">";
 948 }
 949
 950 void MCAssembler::dump() {
 951   raw_ostream &OS = llvm::errs();
 952
 953   OS << "<MCAssembler\n";
 954   OS << "  Sections:[\n    ";
 955   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 956     if (it != begin()) OS << ",\n    ";
 957     it->dump();
 958   }
 959   OS << "],\n";
 960   OS << "  Symbols:[";
 961
 962   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
 963     if (it != symbol_begin()) OS << ",\n           ";
 964     it->dump();
 965   }
 966   OS << "]>\n";
 967 }