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