1 //===- lib/MC/MCAssembler.cpp - Assembler Backend Implementation ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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"
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");
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.
50 MCAsmLayout::MCAsmLayout(MCAssembler &Asm) : Assembler(Asm) {
51 // Compute the section layout order. Virtual sections must go last.
52 for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
53 if (!Asm.getBackend().isVirtualSection(it->getSection()))
54 SectionOrder.push_back(&*it);
55 for (MCAssembler::iterator it = Asm.begin(), ie = Asm.end(); it != ie; ++it)
56 if (Asm.getBackend().isVirtualSection(it->getSection()))
57 SectionOrder.push_back(&*it);
60 void MCAsmLayout::UpdateForSlide(MCFragment *F, int SlideAmount) {
61 // We shouldn't have to do anything special to support negative slides, and it
62 // is a perfectly valid thing to do as long as other parts of the system can
63 // guarantee convergence.
64 assert(SlideAmount >= 0 && "Negative slides not yet supported");
66 // Update the layout by simply recomputing the layout for the entire
67 // file. This is trivially correct, but very slow.
69 // FIXME-PERF: This is O(N^2), but will be eliminated once we get smarter.
71 // Layout the sections in order.
72 for (unsigned i = 0, e = getSectionOrder().size(); i != e; ++i)
73 getAssembler().LayoutSection(*this, i);
76 uint64_t MCAsmLayout::getFragmentAddress(const MCFragment *F) const {
77 assert(F->getParent() && "Missing section()!");
78 return getSectionAddress(F->getParent()) + getFragmentOffset(F);
81 uint64_t MCAsmLayout::getFragmentEffectiveSize(const MCFragment *F) const {
82 assert(F->EffectiveSize != ~UINT64_C(0) && "Address not set!");
83 return F->EffectiveSize;
86 void MCAsmLayout::setFragmentEffectiveSize(MCFragment *F, uint64_t Value) {
87 F->EffectiveSize = Value;
90 uint64_t MCAsmLayout::getFragmentOffset(const MCFragment *F) const {
91 assert(F->Offset != ~UINT64_C(0) && "Address not set!");
95 void MCAsmLayout::setFragmentOffset(MCFragment *F, uint64_t Value) {
99 uint64_t MCAsmLayout::getSymbolAddress(const MCSymbolData *SD) const {
100 assert(SD->getFragment() && "Invalid getAddress() on undefined symbol!");
101 return getFragmentAddress(SD->getFragment()) + SD->getOffset();
104 uint64_t MCAsmLayout::getSectionAddress(const MCSectionData *SD) const {
105 assert(SD->Address != ~UINT64_C(0) && "Address not set!");
109 void MCAsmLayout::setSectionAddress(MCSectionData *SD, uint64_t Value) {
113 uint64_t MCAsmLayout::getSectionSize(const MCSectionData *SD) const {
114 assert(SD->Size != ~UINT64_C(0) && "File size not set!");
117 void MCAsmLayout::setSectionSize(MCSectionData *SD, uint64_t Value) {
121 uint64_t MCAsmLayout::getSectionFileSize(const MCSectionData *SD) const {
122 assert(SD->FileSize != ~UINT64_C(0) && "File size not set!");
125 void MCAsmLayout::setSectionFileSize(MCSectionData *SD, uint64_t Value) {
126 SD->FileSize = Value;
131 MCFragment::MCFragment() : Kind(FragmentType(~0)) {
134 MCFragment::MCFragment(FragmentType _Kind, MCSectionData *_Parent)
135 : Kind(_Kind), Parent(_Parent), Atom(0), EffectiveSize(~UINT64_C(0))
138 Parent->getFragmentList().push_back(this);
141 MCFragment::~MCFragment() {
146 MCSectionData::MCSectionData() : Section(0) {}
148 MCSectionData::MCSectionData(const MCSection &_Section, MCAssembler *A)
149 : Section(&_Section),
151 Address(~UINT64_C(0)),
153 FileSize(~UINT64_C(0)),
154 HasInstructions(false)
157 A->getSectionList().push_back(this);
162 MCSymbolData::MCSymbolData() : Symbol(0) {}
164 MCSymbolData::MCSymbolData(const MCSymbol &_Symbol, MCFragment *_Fragment,
165 uint64_t _Offset, MCAssembler *A)
166 : Symbol(&_Symbol), Fragment(_Fragment), Offset(_Offset),
167 IsExternal(false), IsPrivateExtern(false),
168 CommonSize(0), CommonAlign(0), Flags(0), Index(0)
171 A->getSymbolList().push_back(this);
176 MCAssembler::MCAssembler(MCContext &_Context, TargetAsmBackend &_Backend,
177 MCCodeEmitter &_Emitter, raw_ostream &_OS)
178 : Context(_Context), Backend(_Backend), Emitter(_Emitter),
179 OS(_OS), RelaxAll(false), SubsectionsViaSymbols(false)
183 MCAssembler::~MCAssembler() {
186 static bool isScatteredFixupFullyResolvedSimple(const MCAssembler &Asm,
187 const MCAsmFixup &Fixup,
188 const MCValue Target,
189 const MCSection *BaseSection) {
190 // The effective fixup address is
191 // addr(atom(A)) + offset(A)
192 // - addr(atom(B)) - offset(B)
193 // - addr(<base symbol>) + <fixup offset from base symbol>
194 // and the offsets are not relocatable, so the fixup is fully resolved when
195 // addr(atom(A)) - addr(atom(B)) - addr(<base symbol>)) == 0.
197 // The simple (Darwin, except on x86_64) way of dealing with this was to
198 // assume that any reference to a temporary symbol *must* be a temporary
199 // symbol in the same atom, unless the sections differ. Therefore, any PCrel
200 // relocation to a temporary symbol (in the same section) is fully
201 // resolved. This also works in conjunction with absolutized .set, which
202 // requires the compiler to use .set to absolutize the differences between
203 // symbols which the compiler knows to be assembly time constants, so we don't
204 // need to worry about considering symbol differences fully resolved.
206 // Non-relative fixups are only resolved if constant.
208 return Target.isAbsolute();
210 // Otherwise, relative fixups are only resolved if not a difference and the
211 // target is a temporary in the same section.
212 if (Target.isAbsolute() || Target.getSymB())
215 const MCSymbol *A = &Target.getSymA()->getSymbol();
216 if (!A->isTemporary() || !A->isInSection() ||
217 &A->getSection() != BaseSection)
223 static bool isScatteredFixupFullyResolved(const MCAssembler &Asm,
224 const MCAsmLayout &Layout,
225 const MCAsmFixup &Fixup,
226 const MCValue Target,
227 const MCSymbolData *BaseSymbol) {
228 // The effective fixup address is
229 // addr(atom(A)) + offset(A)
230 // - addr(atom(B)) - offset(B)
231 // - addr(BaseSymbol) + <fixup offset from base symbol>
232 // and the offsets are not relocatable, so the fixup is fully resolved when
233 // addr(atom(A)) - addr(atom(B)) - addr(BaseSymbol) == 0.
235 // Note that "false" is almost always conservatively correct (it means we emit
236 // a relocation which is unnecessary), except when it would force us to emit a
237 // relocation which the target cannot encode.
239 const MCSymbolData *A_Base = 0, *B_Base = 0;
240 if (const MCSymbolRefExpr *A = Target.getSymA()) {
241 // Modified symbol references cannot be resolved.
242 if (A->getKind() != MCSymbolRefExpr::VK_None)
245 A_Base = Asm.getAtom(Layout, &Asm.getSymbolData(A->getSymbol()));
250 if (const MCSymbolRefExpr *B = Target.getSymB()) {
251 // Modified symbol references cannot be resolved.
252 if (B->getKind() != MCSymbolRefExpr::VK_None)
255 B_Base = Asm.getAtom(Layout, &Asm.getSymbolData(B->getSymbol()));
260 // If there is no base, A and B have to be the same atom for this fixup to be
263 return A_Base == B_Base;
265 // Otherwise, B must be missing and A must be the base.
266 return !B_Base && BaseSymbol == A_Base;
269 bool MCAssembler::isSymbolLinkerVisible(const MCSymbolData *SD) const {
270 // Non-temporary labels should always be visible to the linker.
271 if (!SD->getSymbol().isTemporary())
274 // Absolute temporary labels are never visible.
275 if (!SD->getFragment())
278 // Otherwise, check if the section requires symbols even for temporary labels.
279 return getBackend().doesSectionRequireSymbols(
280 SD->getFragment()->getParent()->getSection());
283 const MCSymbolData *MCAssembler::getAtom(const MCAsmLayout &Layout,
284 const MCSymbolData *SD) const {
285 // Linker visible symbols define atoms.
286 if (isSymbolLinkerVisible(SD))
289 // Absolute and undefined symbols have no defining atom.
290 if (!SD->getFragment())
293 // Non-linker visible symbols in sections which can't be atomized have no
295 if (!getBackend().isSectionAtomizable(
296 SD->getFragment()->getParent()->getSection()))
299 // Otherwise, return the atom for the containing fragment.
300 return SD->getFragment()->getAtom();
303 bool MCAssembler::EvaluateFixup(const MCAsmLayout &Layout,
304 const MCAsmFixup &Fixup, const MCFragment *DF,
305 MCValue &Target, uint64_t &Value) const {
306 ++stats::EvaluateFixup;
308 if (!Fixup.Value->EvaluateAsRelocatable(Target, &Layout))
309 report_fatal_error("expected relocatable expression");
311 // FIXME: How do non-scattered symbols work in ELF? I presume the linker
312 // doesn't support small relocations, but then under what criteria does the
313 // assembler allow symbol differences?
315 Value = Target.getConstant();
318 Emitter.getFixupKindInfo(Fixup.Kind).Flags & MCFixupKindInfo::FKF_IsPCRel;
319 bool IsResolved = true;
320 if (const MCSymbolRefExpr *A = Target.getSymA()) {
321 if (A->getSymbol().isDefined())
322 Value += Layout.getSymbolAddress(&getSymbolData(A->getSymbol()));
326 if (const MCSymbolRefExpr *B = Target.getSymB()) {
327 if (B->getSymbol().isDefined())
328 Value -= Layout.getSymbolAddress(&getSymbolData(B->getSymbol()));
333 // If we are using scattered symbols, determine whether this value is actually
334 // resolved; scattering may cause atoms to move.
335 if (IsResolved && getBackend().hasScatteredSymbols()) {
336 if (getBackend().hasReliableSymbolDifference()) {
337 // If this is a PCrel relocation, find the base atom (identified by its
338 // symbol) that the fixup value is relative to.
339 const MCSymbolData *BaseSymbol = 0;
341 BaseSymbol = DF->getAtom();
347 IsResolved = isScatteredFixupFullyResolved(*this, Layout, Fixup, Target,
350 const MCSection *BaseSection = 0;
352 BaseSection = &DF->getParent()->getSection();
354 IsResolved = isScatteredFixupFullyResolvedSimple(*this, Fixup, Target,
360 Value -= Layout.getFragmentAddress(DF) + Fixup.Offset;
365 void MCAssembler::LayoutFragment(MCAsmLayout &Layout, MCFragment &F) {
366 uint64_t StartAddress = Layout.getSectionAddress(F.getParent());
368 // Get the fragment start address.
369 uint64_t Address = StartAddress;
370 MCSectionData::iterator it = &F;
371 if (MCFragment *Prev = F.getPrevNode())
372 Address = (StartAddress + Layout.getFragmentOffset(Prev) +
373 Layout.getFragmentEffectiveSize(Prev));
375 ++stats::FragmentLayouts;
377 uint64_t FragmentOffset = Address - StartAddress;
378 Layout.setFragmentOffset(&F, FragmentOffset);
380 // Evaluate fragment size.
381 uint64_t EffectiveSize = 0;
382 switch (F.getKind()) {
383 case MCFragment::FT_Align: {
384 MCAlignFragment &AF = cast<MCAlignFragment>(F);
386 EffectiveSize = OffsetToAlignment(Address, AF.getAlignment());
387 if (EffectiveSize > AF.getMaxBytesToEmit())
392 case MCFragment::FT_Data:
393 EffectiveSize = cast<MCDataFragment>(F).getContents().size();
396 case MCFragment::FT_Fill: {
397 EffectiveSize = cast<MCFillFragment>(F).getSize();
401 case MCFragment::FT_Inst:
402 EffectiveSize = cast<MCInstFragment>(F).getInstSize();
405 case MCFragment::FT_Org: {
406 MCOrgFragment &OF = cast<MCOrgFragment>(F);
408 int64_t TargetLocation;
409 if (!OF.getOffset().EvaluateAsAbsolute(TargetLocation, &Layout))
410 report_fatal_error("expected assembly-time absolute expression");
412 // FIXME: We need a way to communicate this error.
413 int64_t Offset = TargetLocation - FragmentOffset;
415 report_fatal_error("invalid .org offset '" + Twine(TargetLocation) +
416 "' (at offset '" + Twine(FragmentOffset) + "'");
418 EffectiveSize = Offset;
423 Layout.setFragmentEffectiveSize(&F, EffectiveSize);
426 void MCAssembler::LayoutSection(MCAsmLayout &Layout,
427 unsigned SectionOrderIndex) {
428 MCSectionData &SD = *Layout.getSectionOrder()[SectionOrderIndex];
429 bool IsVirtual = getBackend().isVirtualSection(SD.getSection());
431 ++stats::SectionLayouts;
433 // Get the section start address.
434 uint64_t StartAddress = 0;
435 if (SectionOrderIndex) {
436 MCSectionData *Prev = Layout.getSectionOrder()[SectionOrderIndex - 1];
437 StartAddress = Layout.getSectionAddress(Prev) + Layout.getSectionSize(Prev);
440 // Align this section if necessary by adding padding bytes to the previous
441 // section. It is safe to adjust this out-of-band, because no symbol or
442 // fragment is allowed to point past the end of the section at any time.
443 if (uint64_t Pad = OffsetToAlignment(StartAddress, SD.getAlignment())) {
444 // Unless this section is virtual (where we are allowed to adjust the offset
445 // freely), the padding goes in the previous section.
447 assert(SectionOrderIndex && "Invalid initial section address!");
448 MCSectionData *Prev = Layout.getSectionOrder()[SectionOrderIndex - 1];
449 Layout.setSectionFileSize(Prev, Layout.getSectionFileSize(Prev) + Pad);
455 // Set the aligned section address.
456 Layout.setSectionAddress(&SD, StartAddress);
458 for (MCSectionData::iterator it = SD.begin(), ie = SD.end(); it != ie; ++it)
459 LayoutFragment(Layout, *it);
461 // Set the section sizes.
463 if (!SD.getFragmentList().empty()) {
464 MCFragment *F = &SD.getFragmentList().back();
465 Size = Layout.getFragmentOffset(F) + Layout.getFragmentEffectiveSize(F);
467 Layout.setSectionSize(&SD, Size);
468 Layout.setSectionFileSize(&SD, IsVirtual ? 0 : Size);
471 /// WriteFragmentData - Write the \arg F data to the output file.
472 static void WriteFragmentData(const MCAssembler &Asm, const MCAsmLayout &Layout,
473 const MCFragment &F, MCObjectWriter *OW) {
474 uint64_t Start = OW->getStream().tell();
477 ++stats::EmittedFragments;
479 // FIXME: Embed in fragments instead?
480 uint64_t FragmentSize = Layout.getFragmentEffectiveSize(&F);
481 switch (F.getKind()) {
482 case MCFragment::FT_Align: {
483 MCAlignFragment &AF = cast<MCAlignFragment>(F);
484 uint64_t Count = FragmentSize / AF.getValueSize();
486 assert(AF.getValueSize() && "Invalid virtual align in concrete fragment!");
488 // FIXME: This error shouldn't actually occur (the front end should emit
489 // multiple .align directives to enforce the semantics it wants), but is
490 // severe enough that we want to report it. How to handle this?
491 if (Count * AF.getValueSize() != FragmentSize)
492 report_fatal_error("undefined .align directive, value size '" +
493 Twine(AF.getValueSize()) +
494 "' is not a divisor of padding size '" +
495 Twine(FragmentSize) + "'");
497 // See if we are aligning with nops, and if so do that first to try to fill
498 // the Count bytes. Then if that did not fill any bytes or there are any
499 // bytes left to fill use the the Value and ValueSize to fill the rest.
500 // If we are aligning with nops, ask that target to emit the right data.
501 if (AF.hasEmitNops()) {
502 if (!Asm.getBackend().WriteNopData(Count, OW))
503 report_fatal_error("unable to write nop sequence of " +
504 Twine(Count) + " bytes");
508 // Otherwise, write out in multiples of the value size.
509 for (uint64_t i = 0; i != Count; ++i) {
510 switch (AF.getValueSize()) {
512 assert(0 && "Invalid size!");
513 case 1: OW->Write8 (uint8_t (AF.getValue())); break;
514 case 2: OW->Write16(uint16_t(AF.getValue())); break;
515 case 4: OW->Write32(uint32_t(AF.getValue())); break;
516 case 8: OW->Write64(uint64_t(AF.getValue())); break;
522 case MCFragment::FT_Data: {
523 MCDataFragment &DF = cast<MCDataFragment>(F);
524 assert(FragmentSize == DF.getContents().size() && "Invalid size!");
525 OW->WriteBytes(DF.getContents().str());
529 case MCFragment::FT_Fill: {
530 MCFillFragment &FF = cast<MCFillFragment>(F);
532 assert(FF.getValueSize() && "Invalid virtual align in concrete fragment!");
534 for (uint64_t i = 0, e = FF.getSize() / FF.getValueSize(); i != e; ++i) {
535 switch (FF.getValueSize()) {
537 assert(0 && "Invalid size!");
538 case 1: OW->Write8 (uint8_t (FF.getValue())); break;
539 case 2: OW->Write16(uint16_t(FF.getValue())); break;
540 case 4: OW->Write32(uint32_t(FF.getValue())); break;
541 case 8: OW->Write64(uint64_t(FF.getValue())); break;
547 case MCFragment::FT_Inst:
548 llvm_unreachable("unexpected inst fragment after lowering");
551 case MCFragment::FT_Org: {
552 MCOrgFragment &OF = cast<MCOrgFragment>(F);
554 for (uint64_t i = 0, e = FragmentSize; i != e; ++i)
555 OW->Write8(uint8_t(OF.getValue()));
561 assert(OW->getStream().tell() - Start == FragmentSize);
564 void MCAssembler::WriteSectionData(const MCSectionData *SD,
565 const MCAsmLayout &Layout,
566 MCObjectWriter *OW) const {
567 uint64_t SectionSize = Layout.getSectionSize(SD);
568 uint64_t SectionFileSize = Layout.getSectionFileSize(SD);
570 // Ignore virtual sections.
571 if (getBackend().isVirtualSection(SD->getSection())) {
572 assert(SectionFileSize == 0 && "Invalid size for section!");
574 // Check that contents are only things legal inside a virtual section.
575 for (MCSectionData::const_iterator it = SD->begin(),
576 ie = SD->end(); it != ie; ++it) {
577 switch (it->getKind()) {
579 assert(0 && "Invalid fragment in virtual section!");
580 case MCFragment::FT_Align:
581 assert(!cast<MCAlignFragment>(it)->getValueSize() &&
582 "Invalid align in virtual section!");
584 case MCFragment::FT_Fill:
585 assert(!cast<MCFillFragment>(it)->getValueSize() &&
586 "Invalid fill in virtual section!");
594 uint64_t Start = OW->getStream().tell();
597 for (MCSectionData::const_iterator it = SD->begin(),
598 ie = SD->end(); it != ie; ++it)
599 WriteFragmentData(*this, Layout, *it, OW);
601 // Add section padding.
602 assert(SectionFileSize >= SectionSize && "Invalid section sizes!");
603 OW->WriteZeros(SectionFileSize - SectionSize);
605 assert(OW->getStream().tell() - Start == SectionFileSize);
608 void MCAssembler::Finish() {
609 DEBUG_WITH_TYPE("mc-dump", {
610 llvm::errs() << "assembler backend - pre-layout\n--\n";
613 // Assign section and fragment ordinals, all subsequent backend code is
614 // responsible for updating these in place.
615 unsigned SectionIndex = 0;
616 unsigned FragmentIndex = 0;
617 for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
618 it->setOrdinal(SectionIndex++);
620 for (MCSectionData::iterator it2 = it->begin(),
621 ie2 = it->end(); it2 != ie2; ++it2)
622 it2->setOrdinal(FragmentIndex++);
625 // Layout until everything fits.
626 MCAsmLayout Layout(*this);
627 while (LayoutOnce(Layout))
630 DEBUG_WITH_TYPE("mc-dump", {
631 llvm::errs() << "assembler backend - post-relaxation\n--\n";
634 // Finalize the layout, including fragment lowering.
635 FinishLayout(Layout);
637 DEBUG_WITH_TYPE("mc-dump", {
638 llvm::errs() << "assembler backend - final-layout\n--\n";
641 uint64_t StartOffset = OS.tell();
642 llvm::OwningPtr<MCObjectWriter> Writer(getBackend().createObjectWriter(OS));
644 report_fatal_error("unable to create object writer!");
646 // Allow the object writer a chance to perform post-layout binding (for
647 // example, to set the index fields in the symbol data).
648 Writer->ExecutePostLayoutBinding(*this);
650 // Evaluate and apply the fixups, generating relocation entries as necessary.
651 for (MCAssembler::iterator it = begin(), ie = end(); it != ie; ++it) {
652 for (MCSectionData::iterator it2 = it->begin(),
653 ie2 = it->end(); it2 != ie2; ++it2) {
654 MCDataFragment *DF = dyn_cast<MCDataFragment>(it2);
658 for (MCDataFragment::fixup_iterator it3 = DF->fixup_begin(),
659 ie3 = DF->fixup_end(); it3 != ie3; ++it3) {
660 MCAsmFixup &Fixup = *it3;
662 // Evaluate the fixup.
665 if (!EvaluateFixup(Layout, Fixup, DF, Target, FixedValue)) {
666 // The fixup was unresolved, we need a relocation. Inform the object
667 // writer of the relocation, and give it an opportunity to adjust the
668 // fixup value if need be.
669 Writer->RecordRelocation(*this, Layout, DF, Fixup, Target,FixedValue);
672 getBackend().ApplyFixup(Fixup, *DF, FixedValue);
677 // Write the object file.
678 Writer->WriteObject(*this, Layout);
681 stats::ObjectBytes += OS.tell() - StartOffset;
684 bool MCAssembler::FixupNeedsRelaxation(const MCAsmFixup &Fixup,
685 const MCFragment *DF,
686 const MCAsmLayout &Layout) const {
690 // If we cannot resolve the fixup value, it requires relaxation.
693 if (!EvaluateFixup(Layout, Fixup, DF, Target, Value))
696 // Otherwise, relax if the value is too big for a (signed) i8.
698 // FIXME: This is target dependent!
699 return int64_t(Value) != int64_t(int8_t(Value));
702 bool MCAssembler::FragmentNeedsRelaxation(const MCInstFragment *IF,
703 const MCAsmLayout &Layout) const {
704 // If this inst doesn't ever need relaxation, ignore it. This occurs when we
705 // are intentionally pushing out inst fragments, or because we relaxed a
706 // previous instruction to one that doesn't need relaxation.
707 if (!getBackend().MayNeedRelaxation(IF->getInst(), IF->getFixups()))
710 for (MCInstFragment::const_fixup_iterator it = IF->fixup_begin(),
711 ie = IF->fixup_end(); it != ie; ++it)
712 if (FixupNeedsRelaxation(*it, IF, Layout))
718 bool MCAssembler::LayoutOnce(MCAsmLayout &Layout) {
719 ++stats::RelaxationSteps;
721 // Layout the sections in order.
722 for (unsigned i = 0, e = Layout.getSectionOrder().size(); i != e; ++i)
723 LayoutSection(Layout, i);
725 // Scan for fragments that need relaxation.
726 bool WasRelaxed = false;
727 for (iterator it = begin(), ie = end(); it != ie; ++it) {
728 MCSectionData &SD = *it;
730 for (MCSectionData::iterator it2 = SD.begin(),
731 ie2 = SD.end(); it2 != ie2; ++it2) {
732 // Check if this is an instruction fragment that needs relaxation.
733 MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
734 if (!IF || !FragmentNeedsRelaxation(IF, Layout))
737 ++stats::RelaxedInstructions;
739 // FIXME-PERF: We could immediately lower out instructions if we can tell
740 // they are fully resolved, to avoid retesting on later passes.
742 // Relax the fragment.
745 getBackend().RelaxInstruction(IF, Relaxed);
747 // Encode the new instruction.
749 // FIXME-PERF: If it matters, we could let the target do this. It can
750 // probably do so more efficiently in many cases.
751 SmallVector<MCFixup, 4> Fixups;
752 SmallString<256> Code;
753 raw_svector_ostream VecOS(Code);
754 getEmitter().EncodeInstruction(Relaxed, VecOS, Fixups);
757 // Update the instruction fragment.
758 int SlideAmount = Code.size() - IF->getInstSize();
759 IF->setInst(Relaxed);
760 IF->getCode() = Code;
761 IF->getFixups().clear();
762 for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
763 MCFixup &F = Fixups[i];
764 IF->getFixups().push_back(MCAsmFixup(F.getOffset(), *F.getValue(),
768 // Update the layout, and remember that we relaxed. If we are relaxing
769 // everything, we can skip this step since nothing will depend on updating
772 Layout.UpdateForSlide(IF, SlideAmount);
780 void MCAssembler::FinishLayout(MCAsmLayout &Layout) {
781 // Lower out any instruction fragments, to simplify the fixup application and
784 // FIXME-PERF: We don't have to do this, but the assumption is that it is
785 // cheap (we will mostly end up eliminating fragments and appending on to data
786 // fragments), so the extra complexity downstream isn't worth it. Evaluate
788 for (iterator it = begin(), ie = end(); it != ie; ++it) {
789 MCSectionData &SD = *it;
791 for (MCSectionData::iterator it2 = SD.begin(),
792 ie2 = SD.end(); it2 != ie2; ++it2) {
793 MCInstFragment *IF = dyn_cast<MCInstFragment>(it2);
797 // Create a new data fragment for the instruction.
799 // FIXME-PERF: Reuse previous data fragment if possible.
800 MCDataFragment *DF = new MCDataFragment();
801 SD.getFragmentList().insert(it2, DF);
803 // Update the data fragments layout data.
805 // FIXME: Add MCAsmLayout utility for this.
806 DF->setParent(IF->getParent());
807 DF->setAtom(IF->getAtom());
808 DF->setOrdinal(IF->getOrdinal());
809 Layout.setFragmentOffset(DF, Layout.getFragmentOffset(IF));
810 Layout.setFragmentEffectiveSize(DF, Layout.getFragmentEffectiveSize(IF));
812 // Copy in the data and the fixups.
813 DF->getContents().append(IF->getCode().begin(), IF->getCode().end());
814 for (unsigned i = 0, e = IF->getFixups().size(); i != e; ++i)
815 DF->getFixups().push_back(IF->getFixups()[i]);
817 // Delete the instruction fragment and update the iterator.
818 SD.getFragmentList().erase(IF);
828 raw_ostream &operator<<(raw_ostream &OS, const MCAsmFixup &AF) {
829 OS << "<MCAsmFixup" << " Offset:" << AF.Offset << " Value:" << *AF.Value
830 << " Kind:" << AF.Kind << ">";
836 void MCFragment::dump() {
837 raw_ostream &OS = llvm::errs();
839 OS << "<MCFragment " << (void*) this << " Offset:" << Offset
840 << " EffectiveSize:" << EffectiveSize;
845 void MCAlignFragment::dump() {
846 raw_ostream &OS = llvm::errs();
848 OS << "<MCAlignFragment ";
849 this->MCFragment::dump();
851 OS << " Alignment:" << getAlignment()
852 << " Value:" << getValue() << " ValueSize:" << getValueSize()
853 << " MaxBytesToEmit:" << getMaxBytesToEmit() << ">";
856 void MCDataFragment::dump() {
857 raw_ostream &OS = llvm::errs();
859 OS << "<MCDataFragment ";
860 this->MCFragment::dump();
863 for (unsigned i = 0, e = getContents().size(); i != e; ++i) {
865 OS << hexdigit((Contents[i] >> 4) & 0xF) << hexdigit(Contents[i] & 0xF);
867 OS << "] (" << getContents().size() << " bytes)";
869 if (!getFixups().empty()) {
872 for (fixup_iterator it = fixup_begin(), ie = fixup_end(); it != ie; ++it) {
873 if (it != fixup_begin()) OS << ",\n ";
882 void MCFillFragment::dump() {
883 raw_ostream &OS = llvm::errs();
885 OS << "<MCFillFragment ";
886 this->MCFragment::dump();
888 OS << " Value:" << getValue() << " ValueSize:" << getValueSize()
889 << " Size:" << getSize() << ">";
892 void MCInstFragment::dump() {
893 raw_ostream &OS = llvm::errs();
895 OS << "<MCInstFragment ";
896 this->MCFragment::dump();
899 getInst().dump_pretty(OS);
903 void MCOrgFragment::dump() {
904 raw_ostream &OS = llvm::errs();
906 OS << "<MCOrgFragment ";
907 this->MCFragment::dump();
909 OS << " Offset:" << getOffset() << " Value:" << getValue() << ">";
912 void MCSectionData::dump() {
913 raw_ostream &OS = llvm::errs();
915 OS << "<MCSectionData";
916 OS << " Alignment:" << getAlignment() << " Address:" << Address
917 << " Size:" << Size << " FileSize:" << FileSize
918 << " Fragments:[\n ";
919 for (iterator it = begin(), ie = end(); it != ie; ++it) {
920 if (it != begin()) OS << ",\n ";
926 void MCSymbolData::dump() {
927 raw_ostream &OS = llvm::errs();
929 OS << "<MCSymbolData Symbol:" << getSymbol()
930 << " Fragment:" << getFragment() << " Offset:" << getOffset()
931 << " Flags:" << getFlags() << " Index:" << getIndex();
933 OS << " (common, size:" << getCommonSize()
934 << " align: " << getCommonAlignment() << ")";
937 if (isPrivateExtern())
938 OS << " (private extern)";
942 void MCAssembler::dump() {
943 raw_ostream &OS = llvm::errs();
945 OS << "<MCAssembler\n";
946 OS << " Sections:[\n ";
947 for (iterator it = begin(), ie = end(); it != ie; ++it) {
948 if (it != begin()) OS << ",\n ";
954 for (symbol_iterator it = symbol_begin(), ie = symbol_end(); it != ie; ++it) {
955 if (it != symbol_begin()) OS << ",\n ";