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