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