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