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