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