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