lib/MC/MCAssembler.cpp

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