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::LayoutSection(MCAsmLayout &Layout,
 366                                 unsigned SectionOrderIndex) {
 367   MCSectionData &SD = *Layout.getSectionOrder()[SectionOrderIndex];
 368   bool IsVirtual = getBackend().isVirtualSection(SD.getSection());
 369
 370   ++stats::SectionLayouts;
 371
 372   // Get the section start address.
 373   uint64_t StartAddress = 0;
 374   if (SectionOrderIndex) {
 375     MCSectionData *Prev = Layout.getSectionOrder()[SectionOrderIndex - 1];
 376     StartAddress = Layout.getSectionAddress(Prev) + Layout.getSectionSize(Prev);
 377   }
 378
 379   // Align this section if necessary by adding padding bytes to the previous
 380   // section. It is safe to adjust this out-of-band, because no symbol or
 381   // fragment is allowed to point past the end of the section at any time.
 382   if (uint64_t Pad = OffsetToAlignment(StartAddress, SD.getAlignment())) {
 383     // Unless this section is virtual (where we are allowed to adjust the offset
 384     // freely), the padding goes in the previous section.
 385     if (!IsVirtual) {
 386       // Find the previous non-virtual section.
 387       iterator it = &SD;
 388       assert(it != begin() && "Invalid initial section address!");
 389       for (--it; getBackend().isVirtualSection(it->getSection()); --it) ;
 390       Layout.setSectionFileSize(&*it, Layout.getSectionFileSize(&*it) + Pad);
 391     }
 392
 393     StartAddress += Pad;
 394   }
 395
 396   // Set the aligned section address.
 397   Layout.setSectionAddress(&SD, StartAddress);
 398
 399   for (MCSectionData::iterator it = SD.begin(), ie = SD.end(); it != ie; ++it) {
 400     MCFragment &F = *it;
 401
 402     // Compute the fragment start address.
 403     uint64_t Address = StartAddress;
 404     if (MCFragment *Prev = F.getPrevNode())
 405       Address = (Layout.getFragmentAddress(Prev) +
 406                  Layout.getFragmentEffectiveSize(Prev));
 407
 408     ++stats::FragmentLayouts;
 409
 410     uint64_t FragmentOffset = Address - StartAddress;
 411     Layout.setFragmentOffset(&F, FragmentOffset);
 412
 413     // Evaluate fragment size.
 414     uint64_t EffectiveSize = 0;
 415     switch (F.getKind()) {
 416     case MCFragment::FT_Align: {
 417       MCAlignFragment &AF = cast<MCAlignFragment>(F);
 418
 419       EffectiveSize = OffsetToAlignment(Address, AF.getAlignment());
 420       if (EffectiveSize > AF.getMaxBytesToEmit())
 421         EffectiveSize = 0;
 422       break;
 423     }
 424
 425     case MCFragment::FT_Data:
 426       EffectiveSize = cast<MCDataFragment>(F).getContents().size();
 427       break;
 428
 429     case MCFragment::FT_Fill: {
 430       MCFillFragment &FF = cast<MCFillFragment>(F);
 431       EffectiveSize = FF.getValueSize() * FF.getCount();
 432       break;
 433     }
 434
 435     case MCFragment::FT_Inst:
 436       EffectiveSize = cast<MCInstFragment>(F).getInstSize();
 437       break;
 438
 439     case MCFragment::FT_Org: {
 440       MCOrgFragment &OF = cast<MCOrgFragment>(F);
 441
 442       int64_t TargetLocation;
 443       if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
 444         report_fatal_error("expected assembly-time absolute expression");
 445
 446       // FIXME: We need a way to communicate this error.
 447       int64_t Offset = TargetLocation - FragmentOffset;
 448       if (Offset < 0)
 449         report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
 450                           "' (at offset '" + Twine(FragmentOffset) + "'");
 451
 452       EffectiveSize = Offset;
 453       break;
 454     }
 455
 456     case MCFragment::FT_ZeroFill: {
 457       MCZeroFillFragment &ZFF = cast<MCZeroFillFragment>(F);
 458
 459       // Align the fragment offset; it is safe to adjust the offset freely since
 460       // this is only in virtual sections.
 461       //
 462       // FIXME: We shouldn't be doing this here.
 463       Address = RoundUpToAlignment(Address, ZFF.getAlignment());
 464       Layout.setFragmentOffset(&F, Address - StartAddress);
 465
 466       EffectiveSize = ZFF.getSize();
 467       break;
 468     }
 469     }
 470
 471     Layout.setFragmentEffectiveSize(&F, EffectiveSize);
 472   }
 473
 474   // Set the section sizes.
 475   uint64_t Size = 0;
 476   if (!SD.getFragmentList().empty()) {
 477     MCFragment *F = &SD.getFragmentList().back();
 478     Size = Layout.getFragmentOffset(F) + Layout.getFragmentEffectiveSize(F);
 479   }
 480   Layout.setSectionSize(&SD, Size);
 481   Layout.setSectionFileSize(&SD, IsVirtual ? 0 : Size);
 482 }
 483
 484 /// WriteFragmentData - Write the \arg F data to the output file.
 485 static void WriteFragmentData(const MCAssembler &Asm, const MCAsmLayout &Layout,
 486                               const MCFragment &F, MCObjectWriter *OW) {
 487   uint64_t Start = OW->getStream().tell();
 488   (void) Start;
 489
 490   ++stats::EmittedFragments;
 491
 492   // FIXME: Embed in fragments instead?
 493   uint64_t FragmentSize = Layout.getFragmentEffectiveSize(&F);
 494   switch (F.getKind()) {
 495   case MCFragment::FT_Align: {
 496     MCAlignFragment &AF = cast<MCAlignFragment>(F);
 497     uint64_t Count = FragmentSize / AF.getValueSize();
 498
 499     // FIXME: This error shouldn't actually occur (the front end should emit
 500     // multiple .align directives to enforce the semantics it wants), but is
 501     // severe enough that we want to report it. How to handle this?
 502     if (Count * AF.getValueSize() != FragmentSize)
 503       report_fatal_error("undefined .align directive, value size '" +
 504                         Twine(AF.getValueSize()) +
 505                         "' is not a divisor of padding size '" +
 506                         Twine(FragmentSize) + "'");
 507
 508     // See if we are aligning with nops, and if so do that first to try to fill
 509     // the Count bytes.  Then if that did not fill any bytes or there are any
 510     // bytes left to fill use the the Value and ValueSize to fill the rest.
 511     // If we are aligning with nops, ask that target to emit the right data.
 512     if (AF.getEmitNops()) {
 513       if (!Asm.getBackend().WriteNopData(Count, OW))
 514         report_fatal_error("unable to write nop sequence of " +
 515                           Twine(Count) + " bytes");
 516       break;
 517     }
 518
 519     // Otherwise, write out in multiples of the value size.
 520     for (uint64_t i = 0; i != Count; ++i) {
 521       switch (AF.getValueSize()) {
 522       default:
 523         assert(0 && "Invalid size!");
 524       case 1: OW->Write8 (uint8_t (AF.getValue())); break;
 525       case 2: OW->Write16(uint16_t(AF.getValue())); break;
 526       case 4: OW->Write32(uint32_t(AF.getValue())); break;
 527       case 8: OW->Write64(uint64_t(AF.getValue())); break;
 528       }
 529     }
 530     break;
 531   }
 532
 533   case MCFragment::FT_Data: {
 534     MCDataFragment &DF = cast<MCDataFragment>(F);
 535     assert(FragmentSize == DF.getContents().size() && "Invalid size!");
 536     OW->WriteBytes(DF.getContents().str());
 537     break;
 538   }
 539
 540   case MCFragment::FT_Fill: {
 541     MCFillFragment &FF = cast<MCFillFragment>(F);
 542     for (uint64_t i = 0, e = FF.getCount(); i != e; ++i) {
 543       switch (FF.getValueSize()) {
 544       default:
 545         assert(0 && "Invalid size!");
 546       case 1: OW->Write8 (uint8_t (FF.getValue())); break;
 547       case 2: OW->Write16(uint16_t(FF.getValue())); break;
 548       case 4: OW->Write32(uint32_t(FF.getValue())); break;
 549       case 8: OW->Write64(uint64_t(FF.getValue())); break;
 550       }
 551     }
 552     break;
 553   }
 554
 555   case MCFragment::FT_Inst:
 556     llvm_unreachable("unexpected inst fragment after lowering");
 557     break;
 558
 559   case MCFragment::FT_Org: {
 560     MCOrgFragment &OF = cast<MCOrgFragment>(F);
 561
 562     for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
 563       OW->Write8(uint8_t(OF.getValue()));
 564
 565     break;
 566   }
 567
 568   case MCFragment::FT_ZeroFill: {
 569     assert(0 && "Invalid zero fill fragment in concrete section!");
 570     break;
 571   }
 572   }
 573
 574   assert(OW->getStream().tell() - Start == FragmentSize);
 575 }
 576
 577 void MCAssembler::WriteSectionData(const MCSectionData *SD,
 578                                    const MCAsmLayout &Layout,
 579                                    MCObjectWriter *OW) const {
 580   uint64_t SectionSize = Layout.getSectionSize(SD);
 581   uint64_t SectionFileSize = Layout.getSectionFileSize(SD);
 582
 583   // Ignore virtual sections.
 584   if (getBackend().isVirtualSection(SD->getSection())) {
 585     assert(SectionFileSize == 0 && "Invalid size for section!");
 586     return;
 587   }
 588
 589   uint64_t Start = OW->getStream().tell();
 590   (void) Start;
 591
 592   for (MCSectionData::const_iterator it = SD->begin(),
 593          ie = SD->end(); it != ie; ++it)
 594     WriteFragmentData(*this, Layout, *it, OW);
 595
 596   // Add section padding.
 597   assert(SectionFileSize >= SectionSize && "Invalid section sizes!");
 598   OW->WriteZeros(SectionFileSize - SectionSize);
 599
 600   assert(OW->getStream().tell() - Start == SectionFileSize);
 601 }
 602
 603 void MCAssembler::Finish() {
 604   DEBUG_WITH_TYPE("mc-dump", {
 605       llvm::errs() << "assembler backend - pre-layout\n--\n";
 606       dump(); });
 607
 608   // Assign section and fragment ordinals, all subsequent backend code is
 609   // responsible for updating these in place.
 610   unsigned SectionIndex = 0;
 611   unsigned FragmentIndex = 0;
 612   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 613     it->setOrdinal(SectionIndex++);
 614
 615     for (MCSectionData::iterator it2 = it->begin(),
 616            ie2 = it->end(); it2 != ie2; ++it2)
 617       it2->setOrdinal(FragmentIndex++);
 618   }
 619
 620   // Layout until everything fits.
 621   MCAsmLayout Layout(*this);
 622   while (LayoutOnce(Layout))
 623     continue;
 624
 625   DEBUG_WITH_TYPE("mc-dump", {
 626       llvm::errs() << "assembler backend - post-relaxation\n--\n";
 627       dump(); });
 628
 629   // Finalize the layout, including fragment lowering.
 630   FinishLayout(Layout);
 631
 632   DEBUG_WITH_TYPE("mc-dump", {
 633       llvm::errs() << "assembler backend - final-layout\n--\n";
 634       dump(); });
 635
 636   uint64_t StartOffset = OS.tell();
 637   llvm::OwningPtr<MCObjectWriter> Writer(getBackend().createObjectWriter(OS));
 638   if (!Writer)
 639     report_fatal_error("unable to create object writer!");
 640
 641   // Allow the object writer a chance to perform post-layout binding (for
 642   // example, to set the index fields in the symbol data).
 643   Writer->ExecutePostLayoutBinding(*this);
 644
 645   // Evaluate and apply the fixups, generating relocation entries as necessary.
 646   for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
 647     for (MCSectionData::iterator it2 = it->begin(),
 648            ie2 = it->end(); it2 != ie2; ++it2) {
 649       MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
 650       if (!DF)
 651         continue;
 652
 653       for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
 654              ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
 655         MCAsmFixup &Fixup = *it3;
 656
 657         // Evaluate the fixup.
 658         MCValue Target;
 659         uint64_t FixedValue;
 660         if (!EvaluateFixup(Layout, Fixup, DF, Target, FixedValue)) {
 661           // The fixup was unresolved, we need a relocation. Inform the object
 662           // writer of the relocation, and give it an opportunity to adjust the
 663           // fixup value if need be.
 664           Writer->RecordRelocation(*this, Layout, DF, Fixup, Target,FixedValue);
 665         }
 666
 667         getBackend().ApplyFixup(Fixup, *DF, FixedValue);
 668       }
 669     }
 670   }
 671
 672   // Write the object file.
 673   Writer->WriteObject(*this, Layout);
 674   OS.flush();
 675
 676   stats::ObjectBytes += OS.tell() - StartOffset;
 677 }
 678
 679 bool MCAssembler::FixupNeedsRelaxation(const MCAsmFixup &Fixup,
 680                                        const MCFragment *DF,
 681                                        const MCAsmLayout &Layout) const {
 682   if (getRelaxAll())
 683     return true;
 684
 685   // If we cannot resolve the fixup value, it requires relaxation.
 686   MCValue Target;
 687   uint64_t Value;
 688   if (!EvaluateFixup(Layout, Fixup, DF, Target, Value))
 689     return true;
 690
 691   // Otherwise, relax if the value is too big for a (signed) i8.
 692   //
 693   // FIXME: This is target dependent!
 694   return int64_t(Value) != int64_t(int8_t(Value));
 695 }
 696
 697 bool MCAssembler::FragmentNeedsRelaxation(const MCInstFragment *IF,
 698                                           const MCAsmLayout &Layout) const {
 699   // If this inst doesn't ever need relaxation, ignore it. This occurs when we
 700   // are intentionally pushing out inst fragments, or because we relaxed a
 701   // previous instruction to one that doesn't need relaxation.
 702   if (!getBackend().MayNeedRelaxation(IF->getInst(), IF->getFixups()))
 703     return false;
 704
 705   for (MCInstFragment::const_fixup_iterator it = IF->fixup_begin(),
 706          ie = IF->fixup_end(); it != ie; ++it)
 707     if (FixupNeedsRelaxation(*it, IF, Layout))
 708       return true;
 709
 710   return false;
 711 }
 712
 713 bool MCAssembler::LayoutOnce(MCAsmLayout &Layout) {
 714   ++stats::RelaxationSteps;
 715
 716   // Layout the sections in order.
 717   for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i)
 718     LayoutSection(Layout, i);
 719
 720   // Scan for fragments that need relaxation.
 721   bool WasRelaxed = false;
 722   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 723     MCSectionData &SD = *it;
 724
 725     for (MCSectionData::iterator it2 = SD.begin(),
 726            ie2 = SD.end(); it2 != ie2; ++it2) {
 727       // Check if this is an instruction fragment that needs relaxation.
 728       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 729       if (!IF || !FragmentNeedsRelaxation(IF, Layout))
 730         continue;
 731
 732       ++stats::RelaxedInstructions;
 733
 734       // FIXME-PERF: We could immediately lower out instructions if we can tell
 735       // they are fully resolved, to avoid retesting on later passes.
 736
 737       // Relax the fragment.
 738
 739       MCInst Relaxed;
 740       getBackend().RelaxInstruction(IF, Relaxed);
 741
 742       // Encode the new instruction.
 743       //
 744       // FIXME-PERF: If it matters, we could let the target do this. It can
 745       // probably do so more efficiently in many cases.
 746       SmallVector<MCFixup, 4> Fixups;
 747       SmallString<256> Code;
 748       raw_svector_ostream VecOS(Code);
 749       getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups);
 750       VecOS.flush();
 751
 752       // Update the instruction fragment.
 753       int SlideAmount = Code.size() - IF->getInstSize();
 754       IF->setInst(Relaxed);
 755       IF->getCode() = Code;
 756       IF->getFixups().clear();
 757       for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 758         MCFixup &F = Fixups[i];
 759         IF->getFixups().push_back(MCAsmFixup(F.getOffset(), *F.getValue(),
 760                                              F.getKind()));
 761       }
 762
 763       // Update the layout, and remember that we relaxed. If we are relaxing
 764       // everything, we can skip this step since nothing will depend on updating
 765       // the values.
 766       if (!getRelaxAll())
 767         Layout.UpdateForSlide(IF, SlideAmount);
 768       WasRelaxed = true;
 769     }
 770   }
 771
 772   return WasRelaxed;
 773 }
 774
 775 void MCAssembler::FinishLayout(MCAsmLayout &Layout) {
 776   // Lower out any instruction fragments, to simplify the fixup application and
 777   // output.
 778   //
 779   // FIXME-PERF: We don't have to do this, but the assumption is that it is
 780   // cheap (we will mostly end up eliminating fragments and appending on to data
 781   // fragments), so the extra complexity downstream isn't worth it. Evaluate
 782   // this assumption.
 783   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 784     MCSectionData &SD = *it;
 785
 786     for (MCSectionData::iterator it2 = SD.begin(),
 787            ie2 = SD.end(); it2 != ie2; ++it2) {
 788       MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
 789       if (!IF)
 790         continue;
 791
 792       // Create a new data fragment for the instruction.
 793       //
 794       // FIXME-PERF: Reuse previous data fragment if possible.
 795       MCDataFragment *DF = new MCDataFragment();
 796       SD.getFragmentList().insert(it2, DF);
 797
 798       // Update the data fragments layout data.
 799       //
 800       // FIXME: Add MCAsmLayout utility for this.
 801       DF->setParent(IF->getParent());
 802       DF->setAtom(IF->getAtom());
 803       DF->setOrdinal(IF->getOrdinal());
 804       Layout.setFragmentOffset(DF, Layout.getFragmentOffset(IF));
 805       Layout.setFragmentEffectiveSize(DF, Layout.getFragmentEffectiveSize(IF));
 806
 807       // Copy in the data and the fixups.
 808       DF->getContents().append(IF->getCode().begin(), IF->getCode().end());
 809       for (unsigned i = 0, e = IF->getFixups().size(); i != e; ++i)
 810         DF->getFixups().push_back(IF->getFixups()[i]);
 811
 812       // Delete the instruction fragment and update the iterator.
 813       SD.getFragmentList().erase(IF);
 814       it2 = DF;
 815     }
 816   }
 817 }
 818
 819 // Debugging methods
 820
 821 namespace llvm {
 822
 823 raw_ostream &operator<<(raw_ostream &OS, const MCAsmFixup &AF) {
 824   OS << "<MCAsmFixup" << " Offset:" << AF.Offset << " Value:" << *AF.Value
 825      << " Kind:" << AF.Kind << ">";
 826   return OS;
 827 }
 828
 829 }
 830
 831 void MCFragment::dump() {
 832   raw_ostream &OS = llvm::errs();
 833
 834   OS << "<MCFragment " << (void*) this << " Offset:" << Offset
 835      << " EffectiveSize:" << EffectiveSize;
 836
 837   OS << ">";
 838 }
 839
 840 void MCAlignFragment::dump() {
 841   raw_ostream &OS = llvm::errs();
 842
 843   OS << "<MCAlignFragment ";
 844   this->MCFragment::dump();
 845   OS << "\n       ";
 846   OS << " Alignment:" << getAlignment()
 847      << " Value:" << getValue() << " ValueSize:" << getValueSize()
 848      << " MaxBytesToEmit:" << getMaxBytesToEmit() << ">";
 849 }
 850
 851 void MCDataFragment::dump() {
 852   raw_ostream &OS = llvm::errs();
 853
 854   OS << "<MCDataFragment ";
 855   this->MCFragment::dump();
 856   OS << "\n       ";
 857   OS << " Contents:[";
 858   for (unsigned i = 0, e = getContents().size(); i != e; ++i) {
 859     if (i) OS << ",";
 860     OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
 861   }
 862   OS << "] (" << getContents().size() << " bytes)";
 863
 864   if (!getFixups().empty()) {
 865     OS << ",\n       ";
 866     OS << " Fixups:[";
 867     for (fixup_iterator it = fixup_begin(), ie = fixup_end(); it != ie; ++it) {
 868       if (it != fixup_begin()) OS << ",\n                ";
 869       OS << *it;
 870     }
 871     OS << "]";
 872   }
 873
 874   OS << ">";
 875 }
 876
 877 void MCFillFragment::dump() {
 878   raw_ostream &OS = llvm::errs();
 879
 880   OS << "<MCFillFragment ";
 881   this->MCFragment::dump();
 882   OS << "\n       ";
 883   OS << " Value:" << getValue() << " ValueSize:" << getValueSize()
 884      << " Count:" << getCount() << ">";
 885 }
 886
 887 void MCInstFragment::dump() {
 888   raw_ostream &OS = llvm::errs();
 889
 890   OS << "<MCInstFragment ";
 891   this->MCFragment::dump();
 892   OS << "\n       ";
 893   OS << " Inst:";
 894   getInst().dump_pretty(OS);
 895   OS << ">";
 896 }
 897
 898 void MCOrgFragment::dump() {
 899   raw_ostream &OS = llvm::errs();
 900
 901   OS << "<MCOrgFragment ";
 902   this->MCFragment::dump();
 903   OS << "\n       ";
 904   OS << " Offset:" << getOffset() << " Value:" << getValue() << ">";
 905 }
 906
 907 void MCZeroFillFragment::dump() {
 908   raw_ostream &OS = llvm::errs();
 909
 910   OS << "<MCZeroFillFragment ";
 911   this->MCFragment::dump();
 912   OS << "\n       ";
 913   OS << " Size:" << getSize() << " Alignment:" << getAlignment() << ">";
 914 }
 915
 916 void MCSectionData::dump() {
 917   raw_ostream &OS = llvm::errs();
 918
 919   OS << "<MCSectionData";
 920   OS << " Alignment:" << getAlignment() << " Address:" << Address
 921      << " Size:" << Size << " FileSize:" << FileSize
 922      << " Fragments:[\n      ";
 923   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 924     if (it != begin()) OS << ",\n      ";
 925     it->dump();
 926   }
 927   OS << "]>";
 928 }
 929
 930 void MCSymbolData::dump() {
 931   raw_ostream &OS = llvm::errs();
 932
 933   OS << "<MCSymbolData Symbol:" << getSymbol()
 934      << " Fragment:" << getFragment() << " Offset:" << getOffset()
 935      << " Flags:" << getFlags() << " Index:" << getIndex();
 936   if (isCommon())
 937     OS << " (common, size:" << getCommonSize()
 938        << " align: " << getCommonAlignment() << ")";
 939   if (isExternal())
 940     OS << " (external)";
 941   if (isPrivateExtern())
 942     OS << " (private extern)";
 943   OS << ">";
 944 }
 945
 946 void MCAssembler::dump() {
 947   raw_ostream &OS = llvm::errs();
 948
 949   OS << "<MCAssembler\n";
 950   OS << "  Sections:[\n    ";
 951   for (iterator it = begin(), ie = end(); it != ie; ++it) {
 952     if (it != begin()) OS << ",\n    ";
 953     it->dump();
 954   }
 955   OS << "],\n";
 956   OS << "  Symbols:[";
 957
 958   for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
 959     if (it != symbol_begin()) OS << ",\n           ";
 960     it->dump();
 961   }
 962   OS << "]>\n";
 963 }