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