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