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