1 //===- lib/MC/ARMELFStreamer.cpp - ELF Object Output for ARM --------------===//
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 // This file assembles .s files and emits ARM ELF .o object files. Different
11 // from generic ELF streamer in emitting mapping symbols ($a, $t and $d) to
12 // delimit regions of data and code.
14 //===----------------------------------------------------------------------===//
16 #include "ARMArchName.h"
17 #include "ARMFPUName.h"
18 #include "ARMRegisterInfo.h"
19 #include "ARMUnwindOpAsm.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/Twine.h"
22 #include "llvm/MC/MCAsmBackend.h"
23 #include "llvm/MC/MCAsmInfo.h"
24 #include "llvm/MC/MCAssembler.h"
25 #include "llvm/MC/MCCodeEmitter.h"
26 #include "llvm/MC/MCContext.h"
27 #include "llvm/MC/MCELF.h"
28 #include "llvm/MC/MCELFStreamer.h"
29 #include "llvm/MC/MCELFSymbolFlags.h"
30 #include "llvm/MC/MCExpr.h"
31 #include "llvm/MC/MCInst.h"
32 #include "llvm/MC/MCInstPrinter.h"
33 #include "llvm/MC/MCObjectFileInfo.h"
34 #include "llvm/MC/MCObjectStreamer.h"
35 #include "llvm/MC/MCRegisterInfo.h"
36 #include "llvm/MC/MCSection.h"
37 #include "llvm/MC/MCSectionELF.h"
38 #include "llvm/MC/MCStreamer.h"
39 #include "llvm/MC/MCSymbol.h"
40 #include "llvm/MC/MCValue.h"
41 #include "llvm/Support/ARMBuildAttributes.h"
42 #include "llvm/Support/ARMEHABI.h"
43 #include "llvm/Support/Debug.h"
44 #include "llvm/Support/ELF.h"
45 #include "llvm/Support/FormattedStream.h"
46 #include "llvm/Support/LEB128.h"
47 #include "llvm/Support/raw_ostream.h"
52 static std::string GetAEABIUnwindPersonalityName(unsigned Index) {
53 assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX &&
54 "Invalid personality index");
55 return (Twine("__aeabi_unwind_cpp_pr") + Twine(Index)).str();
58 static const char *GetFPUName(unsigned ID) {
61 llvm_unreachable("Unknown FPU kind");
63 #define ARM_FPU_NAME(NAME, ID) case ARM::ID: return NAME;
64 #include "ARMFPUName.def"
69 static const char *GetArchName(unsigned ID) {
72 llvm_unreachable("Unknown ARCH kind");
74 #define ARM_ARCH_NAME(NAME, ID, DEFAULT_CPU_NAME, DEFAULT_CPU_ARCH) \
75 case ARM::ID: return NAME;
76 #define ARM_ARCH_ALIAS(NAME, ID) /* empty */
77 #include "ARMArchName.def"
82 static const char *GetArchDefaultCPUName(unsigned ID) {
85 llvm_unreachable("Unknown ARCH kind");
87 #define ARM_ARCH_NAME(NAME, ID, DEFAULT_CPU_NAME, DEFAULT_CPU_ARCH) \
88 case ARM::ID: return DEFAULT_CPU_NAME;
89 #define ARM_ARCH_ALIAS(NAME, ID) /* empty */
90 #include "ARMArchName.def"
95 static unsigned GetArchDefaultCPUArch(unsigned ID) {
98 llvm_unreachable("Unknown ARCH kind");
100 #define ARM_ARCH_NAME(NAME, ID, DEFAULT_CPU_NAME, DEFAULT_CPU_ARCH) \
101 case ARM::ID: return ARMBuildAttrs::DEFAULT_CPU_ARCH;
102 #define ARM_ARCH_ALIAS(NAME, ID) /* empty */
103 #include "ARMArchName.def"
110 class ARMELFStreamer;
112 class ARMTargetAsmStreamer : public ARMTargetStreamer {
113 formatted_raw_ostream &OS;
114 MCInstPrinter &InstPrinter;
117 void emitFnStart() override;
118 void emitFnEnd() override;
119 void emitCantUnwind() override;
120 void emitPersonality(const MCSymbol *Personality) override;
121 void emitPersonalityIndex(unsigned Index) override;
122 void emitHandlerData() override;
123 void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
124 void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
125 void emitPad(int64_t Offset) override;
126 void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
127 bool isVector) override;
128 void emitUnwindRaw(int64_t Offset,
129 const SmallVectorImpl<uint8_t> &Opcodes) override;
131 void switchVendor(StringRef Vendor) override;
132 void emitAttribute(unsigned Attribute, unsigned Value) override;
133 void emitTextAttribute(unsigned Attribute, StringRef String) override;
134 void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
135 StringRef StrinValue) override;
136 void emitArch(unsigned Arch) override;
137 void emitObjectArch(unsigned Arch) override;
138 void emitFPU(unsigned FPU) override;
139 void emitInst(uint32_t Inst, char Suffix = '\0') override;
140 void finishAttributeSection() override;
142 void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
143 void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
146 ARMTargetAsmStreamer(MCStreamer &S, formatted_raw_ostream &OS,
147 MCInstPrinter &InstPrinter, bool VerboseAsm);
150 ARMTargetAsmStreamer::ARMTargetAsmStreamer(MCStreamer &S,
151 formatted_raw_ostream &OS,
152 MCInstPrinter &InstPrinter,
154 : ARMTargetStreamer(S), OS(OS), InstPrinter(InstPrinter),
155 IsVerboseAsm(VerboseAsm) {}
156 void ARMTargetAsmStreamer::emitFnStart() { OS << "\t.fnstart\n"; }
157 void ARMTargetAsmStreamer::emitFnEnd() { OS << "\t.fnend\n"; }
158 void ARMTargetAsmStreamer::emitCantUnwind() { OS << "\t.cantunwind\n"; }
159 void ARMTargetAsmStreamer::emitPersonality(const MCSymbol *Personality) {
160 OS << "\t.personality " << Personality->getName() << '\n';
162 void ARMTargetAsmStreamer::emitPersonalityIndex(unsigned Index) {
163 OS << "\t.personalityindex " << Index << '\n';
165 void ARMTargetAsmStreamer::emitHandlerData() { OS << "\t.handlerdata\n"; }
166 void ARMTargetAsmStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
169 InstPrinter.printRegName(OS, FpReg);
171 InstPrinter.printRegName(OS, SpReg);
173 OS << ", #" << Offset;
176 void ARMTargetAsmStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
177 assert((Reg != ARM::SP && Reg != ARM::PC) &&
178 "the operand of .movsp cannot be either sp or pc");
181 InstPrinter.printRegName(OS, Reg);
183 OS << ", #" << Offset;
186 void ARMTargetAsmStreamer::emitPad(int64_t Offset) {
187 OS << "\t.pad\t#" << Offset << '\n';
189 void ARMTargetAsmStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
191 assert(RegList.size() && "RegList should not be empty");
197 InstPrinter.printRegName(OS, RegList[0]);
199 for (unsigned i = 1, e = RegList.size(); i != e; ++i) {
201 InstPrinter.printRegName(OS, RegList[i]);
206 void ARMTargetAsmStreamer::switchVendor(StringRef Vendor) {
208 void ARMTargetAsmStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
209 OS << "\t.eabi_attribute\t" << Attribute << ", " << Twine(Value);
211 StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
213 OS << "\t@ " << Name;
217 void ARMTargetAsmStreamer::emitTextAttribute(unsigned Attribute,
220 case ARMBuildAttrs::CPU_name:
221 OS << "\t.cpu\t" << String.lower();
224 OS << "\t.eabi_attribute\t" << Attribute << ", \"" << String << "\"";
226 StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
228 OS << "\t@ " << Name;
234 void ARMTargetAsmStreamer::emitIntTextAttribute(unsigned Attribute,
236 StringRef StringValue) {
238 default: llvm_unreachable("unsupported multi-value attribute in asm mode");
239 case ARMBuildAttrs::compatibility:
240 OS << "\t.eabi_attribute\t" << Attribute << ", " << IntValue;
241 if (!StringValue.empty())
242 OS << ", \"" << StringValue << "\"";
244 OS << "\t@ " << ARMBuildAttrs::AttrTypeAsString(Attribute);
249 void ARMTargetAsmStreamer::emitArch(unsigned Arch) {
250 OS << "\t.arch\t" << GetArchName(Arch) << "\n";
252 void ARMTargetAsmStreamer::emitObjectArch(unsigned Arch) {
253 OS << "\t.object_arch\t" << GetArchName(Arch) << '\n';
255 void ARMTargetAsmStreamer::emitFPU(unsigned FPU) {
256 OS << "\t.fpu\t" << GetFPUName(FPU) << "\n";
258 void ARMTargetAsmStreamer::finishAttributeSection() {
261 ARMTargetAsmStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
262 OS << "\t.tlsdescseq\t" << S->getSymbol().getName();
265 void ARMTargetAsmStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
266 OS << "\t.thumb_set\t" << *Symbol << ", " << *Value << '\n';
269 void ARMTargetAsmStreamer::emitInst(uint32_t Inst, char Suffix) {
273 OS << "\t0x" << utohexstr(Inst) << "\n";
276 void ARMTargetAsmStreamer::emitUnwindRaw(int64_t Offset,
277 const SmallVectorImpl<uint8_t> &Opcodes) {
278 OS << "\t.unwind_raw " << Offset;
279 for (SmallVectorImpl<uint8_t>::const_iterator OCI = Opcodes.begin(),
282 OS << ", 0x" << utohexstr(*OCI);
286 class ARMTargetELFStreamer : public ARMTargetStreamer {
288 // This structure holds all attributes, accounting for
289 // their string/numeric value, so we can later emmit them
290 // in declaration order, keeping all in the same vector
291 struct AttributeItem {
296 NumericAndTextAttributes
300 StringRef StringValue;
302 static bool LessTag(const AttributeItem &LHS, const AttributeItem &RHS) {
303 return (LHS.Tag < RHS.Tag);
307 StringRef CurrentVendor;
310 unsigned EmittedArch;
311 SmallVector<AttributeItem, 64> Contents;
313 const MCSection *AttributeSection;
315 AttributeItem *getAttributeItem(unsigned Attribute) {
316 for (size_t i = 0; i < Contents.size(); ++i)
317 if (Contents[i].Tag == Attribute)
322 void setAttributeItem(unsigned Attribute, unsigned Value,
323 bool OverwriteExisting) {
324 // Look for existing attribute item
325 if (AttributeItem *Item = getAttributeItem(Attribute)) {
326 if (!OverwriteExisting)
328 Item->Type = AttributeItem::NumericAttribute;
329 Item->IntValue = Value;
333 // Create new attribute item
334 AttributeItem Item = {
335 AttributeItem::NumericAttribute,
340 Contents.push_back(Item);
343 void setAttributeItem(unsigned Attribute, StringRef Value,
344 bool OverwriteExisting) {
345 // Look for existing attribute item
346 if (AttributeItem *Item = getAttributeItem(Attribute)) {
347 if (!OverwriteExisting)
349 Item->Type = AttributeItem::TextAttribute;
350 Item->StringValue = Value;
354 // Create new attribute item
355 AttributeItem Item = {
356 AttributeItem::TextAttribute,
361 Contents.push_back(Item);
364 void setAttributeItems(unsigned Attribute, unsigned IntValue,
365 StringRef StringValue, bool OverwriteExisting) {
366 // Look for existing attribute item
367 if (AttributeItem *Item = getAttributeItem(Attribute)) {
368 if (!OverwriteExisting)
370 Item->Type = AttributeItem::NumericAndTextAttributes;
371 Item->IntValue = IntValue;
372 Item->StringValue = StringValue;
376 // Create new attribute item
377 AttributeItem Item = {
378 AttributeItem::NumericAndTextAttributes,
383 Contents.push_back(Item);
386 void emitArchDefaultAttributes();
387 void emitFPUDefaultAttributes();
389 ARMELFStreamer &getStreamer();
391 void emitFnStart() override;
392 void emitFnEnd() override;
393 void emitCantUnwind() override;
394 void emitPersonality(const MCSymbol *Personality) override;
395 void emitPersonalityIndex(unsigned Index) override;
396 void emitHandlerData() override;
397 void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
398 void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
399 void emitPad(int64_t Offset) override;
400 void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
401 bool isVector) override;
402 void emitUnwindRaw(int64_t Offset,
403 const SmallVectorImpl<uint8_t> &Opcodes) override;
405 void switchVendor(StringRef Vendor) override;
406 void emitAttribute(unsigned Attribute, unsigned Value) override;
407 void emitTextAttribute(unsigned Attribute, StringRef String) override;
408 void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
409 StringRef StringValue) override;
410 void emitArch(unsigned Arch) override;
411 void emitObjectArch(unsigned Arch) override;
412 void emitFPU(unsigned FPU) override;
413 void emitInst(uint32_t Inst, char Suffix = '\0') override;
414 void finishAttributeSection() override;
415 void emitLabel(MCSymbol *Symbol) override;
417 void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
418 void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
420 size_t calculateContentSize() const;
423 ARMTargetELFStreamer(MCStreamer &S)
424 : ARMTargetStreamer(S), CurrentVendor("aeabi"), FPU(ARM::INVALID_FPU),
425 Arch(ARM::INVALID_ARCH), EmittedArch(ARM::INVALID_ARCH),
426 AttributeSection(nullptr) {}
429 /// Extend the generic ELFStreamer class so that it can emit mapping symbols at
430 /// the appropriate points in the object files. These symbols are defined in the
431 /// ARM ELF ABI: infocenter.arm.com/help/topic/com.arm.../IHI0044D_aaelf.pdf.
433 /// In brief: $a, $t or $d should be emitted at the start of each contiguous
434 /// region of ARM code, Thumb code or data in a section. In practice, this
435 /// emission does not rely on explicit assembler directives but on inherent
436 /// properties of the directives doing the emission (e.g. ".byte" is data, "add
437 /// r0, r0, r0" an instruction).
439 /// As a result this system is orthogonal to the DataRegion infrastructure used
440 /// by MachO. Beware!
441 class ARMELFStreamer : public MCELFStreamer {
443 friend class ARMTargetELFStreamer;
445 ARMELFStreamer(MCContext &Context, MCAsmBackend &TAB, raw_ostream &OS,
446 MCCodeEmitter *Emitter, bool IsThumb)
447 : MCELFStreamer(Context, TAB, OS, Emitter), IsThumb(IsThumb),
448 MappingSymbolCounter(0), LastEMS(EMS_None) {
454 void FinishImpl() override;
456 // ARM exception handling directives
459 void emitCantUnwind();
460 void emitPersonality(const MCSymbol *Per);
461 void emitPersonalityIndex(unsigned index);
462 void emitHandlerData();
463 void emitSetFP(unsigned NewFpReg, unsigned NewSpReg, int64_t Offset = 0);
464 void emitMovSP(unsigned Reg, int64_t Offset = 0);
465 void emitPad(int64_t Offset);
466 void emitRegSave(const SmallVectorImpl<unsigned> &RegList, bool isVector);
467 void emitUnwindRaw(int64_t Offset, const SmallVectorImpl<uint8_t> &Opcodes);
469 void ChangeSection(const MCSection *Section,
470 const MCExpr *Subsection) override {
471 // We have to keep track of the mapping symbol state of any sections we
472 // use. Each one should start off as EMS_None, which is provided as the
473 // default constructor by DenseMap::lookup.
474 LastMappingSymbols[getPreviousSection().first] = LastEMS;
475 LastEMS = LastMappingSymbols.lookup(Section);
477 MCELFStreamer::ChangeSection(Section, Subsection);
480 /// This function is the one used to emit instruction data into the ELF
481 /// streamer. We override it to add the appropriate mapping symbol if
483 void EmitInstruction(const MCInst& Inst,
484 const MCSubtargetInfo &STI) override {
486 EmitThumbMappingSymbol();
488 EmitARMMappingSymbol();
490 MCELFStreamer::EmitInstruction(Inst, STI);
493 void emitInst(uint32_t Inst, char Suffix) {
496 const bool LittleEndian = getContext().getAsmInfo()->isLittleEndian();
503 EmitARMMappingSymbol();
504 for (unsigned II = 0, IE = Size; II != IE; II++) {
505 const unsigned I = LittleEndian ? (Size - II - 1) : II;
506 Buffer[Size - II - 1] = uint8_t(Inst >> I * CHAR_BIT);
512 Size = (Suffix == 'n' ? 2 : 4);
515 EmitThumbMappingSymbol();
516 for (unsigned II = 0, IE = Size; II != IE; II = II + 2) {
517 const unsigned I0 = LittleEndian ? II + 0 : (Size - II - 1);
518 const unsigned I1 = LittleEndian ? II + 1 : (Size - II - 2);
519 Buffer[Size - II - 2] = uint8_t(Inst >> I0 * CHAR_BIT);
520 Buffer[Size - II - 1] = uint8_t(Inst >> I1 * CHAR_BIT);
525 llvm_unreachable("Invalid Suffix");
528 MCELFStreamer::EmitBytes(StringRef(Buffer, Size));
531 /// This is one of the functions used to emit data into an ELF section, so the
532 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
534 void EmitBytes(StringRef Data) override {
535 EmitDataMappingSymbol();
536 MCELFStreamer::EmitBytes(Data);
539 /// This is one of the functions used to emit data into an ELF section, so the
540 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
542 void EmitValueImpl(const MCExpr *Value, unsigned Size,
543 const SMLoc &Loc) override {
544 EmitDataMappingSymbol();
545 MCELFStreamer::EmitValueImpl(Value, Size);
548 void EmitAssemblerFlag(MCAssemblerFlag Flag) override {
549 MCELFStreamer::EmitAssemblerFlag(Flag);
552 case MCAF_SyntaxUnified:
553 return; // no-op here.
556 return; // Change to Thumb mode
559 return; // Change to ARM mode
562 case MCAF_SubsectionsViaSymbols:
568 enum ElfMappingSymbol {
575 void EmitDataMappingSymbol() {
576 if (LastEMS == EMS_Data) return;
577 EmitMappingSymbol("$d");
581 void EmitThumbMappingSymbol() {
582 if (LastEMS == EMS_Thumb) return;
583 EmitMappingSymbol("$t");
587 void EmitARMMappingSymbol() {
588 if (LastEMS == EMS_ARM) return;
589 EmitMappingSymbol("$a");
593 void EmitMappingSymbol(StringRef Name) {
594 MCSymbol *Start = getContext().CreateTempSymbol();
598 getContext().GetOrCreateSymbol(Name + "." +
599 Twine(MappingSymbolCounter++));
601 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
602 MCELF::SetType(SD, ELF::STT_NOTYPE);
603 MCELF::SetBinding(SD, ELF::STB_LOCAL);
604 SD.setExternal(false);
605 AssignSection(Symbol, getCurrentSection().first);
607 const MCExpr *Value = MCSymbolRefExpr::Create(Start, getContext());
608 Symbol->setVariableValue(Value);
611 void EmitThumbFunc(MCSymbol *Func) override {
612 getAssembler().setIsThumbFunc(Func);
613 EmitSymbolAttribute(Func, MCSA_ELF_TypeFunction);
616 // Helper functions for ARM exception handling directives
619 void EmitPersonalityFixup(StringRef Name);
620 void FlushPendingOffset();
621 void FlushUnwindOpcodes(bool NoHandlerData);
623 void SwitchToEHSection(const char *Prefix, unsigned Type, unsigned Flags,
624 SectionKind Kind, const MCSymbol &Fn);
625 void SwitchToExTabSection(const MCSymbol &FnStart);
626 void SwitchToExIdxSection(const MCSymbol &FnStart);
628 void EmitFixup(const MCExpr *Expr, MCFixupKind Kind);
631 int64_t MappingSymbolCounter;
633 DenseMap<const MCSection *, ElfMappingSymbol> LastMappingSymbols;
634 ElfMappingSymbol LastEMS;
636 // ARM Exception Handling Frame Information
639 const MCSymbol *Personality;
640 unsigned PersonalityIndex;
641 unsigned FPReg; // Frame pointer register
642 int64_t FPOffset; // Offset: (final frame pointer) - (initial $sp)
643 int64_t SPOffset; // Offset: (final $sp) - (initial $sp)
644 int64_t PendingOffset; // Offset: (final $sp) - (emitted $sp)
647 SmallVector<uint8_t, 64> Opcodes;
648 UnwindOpcodeAssembler UnwindOpAsm;
650 } // end anonymous namespace
652 ARMELFStreamer &ARMTargetELFStreamer::getStreamer() {
653 return static_cast<ARMELFStreamer &>(Streamer);
656 void ARMTargetELFStreamer::emitFnStart() { getStreamer().emitFnStart(); }
657 void ARMTargetELFStreamer::emitFnEnd() { getStreamer().emitFnEnd(); }
658 void ARMTargetELFStreamer::emitCantUnwind() { getStreamer().emitCantUnwind(); }
659 void ARMTargetELFStreamer::emitPersonality(const MCSymbol *Personality) {
660 getStreamer().emitPersonality(Personality);
662 void ARMTargetELFStreamer::emitPersonalityIndex(unsigned Index) {
663 getStreamer().emitPersonalityIndex(Index);
665 void ARMTargetELFStreamer::emitHandlerData() {
666 getStreamer().emitHandlerData();
668 void ARMTargetELFStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
670 getStreamer().emitSetFP(FpReg, SpReg, Offset);
672 void ARMTargetELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
673 getStreamer().emitMovSP(Reg, Offset);
675 void ARMTargetELFStreamer::emitPad(int64_t Offset) {
676 getStreamer().emitPad(Offset);
678 void ARMTargetELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
680 getStreamer().emitRegSave(RegList, isVector);
682 void ARMTargetELFStreamer::emitUnwindRaw(int64_t Offset,
683 const SmallVectorImpl<uint8_t> &Opcodes) {
684 getStreamer().emitUnwindRaw(Offset, Opcodes);
686 void ARMTargetELFStreamer::switchVendor(StringRef Vendor) {
687 assert(!Vendor.empty() && "Vendor cannot be empty.");
689 if (CurrentVendor == Vendor)
692 if (!CurrentVendor.empty())
693 finishAttributeSection();
695 assert(Contents.empty() &&
696 ".ARM.attributes should be flushed before changing vendor");
697 CurrentVendor = Vendor;
700 void ARMTargetELFStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
701 setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
703 void ARMTargetELFStreamer::emitTextAttribute(unsigned Attribute,
705 setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
707 void ARMTargetELFStreamer::emitIntTextAttribute(unsigned Attribute,
709 StringRef StringValue) {
710 setAttributeItems(Attribute, IntValue, StringValue,
711 /* OverwriteExisting= */ true);
713 void ARMTargetELFStreamer::emitArch(unsigned Value) {
716 void ARMTargetELFStreamer::emitObjectArch(unsigned Value) {
719 void ARMTargetELFStreamer::emitArchDefaultAttributes() {
720 using namespace ARMBuildAttrs;
722 setAttributeItem(CPU_name, GetArchDefaultCPUName(Arch), false);
723 if (EmittedArch == ARM::INVALID_ARCH)
724 setAttributeItem(CPU_arch, GetArchDefaultCPUArch(Arch), false);
726 setAttributeItem(CPU_arch, GetArchDefaultCPUArch(EmittedArch), false);
735 setAttributeItem(ARM_ISA_use, Allowed, false);
743 setAttributeItem(ARM_ISA_use, Allowed, false);
744 setAttributeItem(THUMB_ISA_use, Allowed, false);
748 setAttributeItem(ARM_ISA_use, Allowed, false);
749 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
754 setAttributeItem(ARM_ISA_use, Allowed, false);
755 setAttributeItem(THUMB_ISA_use, Allowed, false);
756 setAttributeItem(Virtualization_use, AllowTZ, false);
760 setAttributeItem(THUMB_ISA_use, Allowed, false);
764 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
768 setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
769 setAttributeItem(ARM_ISA_use, Allowed, false);
770 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
774 setAttributeItem(CPU_arch_profile, RealTimeProfile, false);
775 setAttributeItem(ARM_ISA_use, Allowed, false);
776 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
780 setAttributeItem(CPU_arch_profile, MicroControllerProfile, false);
781 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
785 setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
786 setAttributeItem(ARM_ISA_use, Allowed, false);
787 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
788 setAttributeItem(MPextension_use, Allowed, false);
789 setAttributeItem(Virtualization_use, AllowTZVirtualization, false);
793 setAttributeItem(ARM_ISA_use, Allowed, false);
794 setAttributeItem(THUMB_ISA_use, Allowed, false);
795 setAttributeItem(WMMX_arch, AllowWMMXv1, false);
799 setAttributeItem(ARM_ISA_use, Allowed, false);
800 setAttributeItem(THUMB_ISA_use, Allowed, false);
801 setAttributeItem(WMMX_arch, AllowWMMXv2, false);
805 report_fatal_error("Unknown Arch: " + Twine(Arch));
809 void ARMTargetELFStreamer::emitFPU(unsigned Value) {
812 void ARMTargetELFStreamer::emitFPUDefaultAttributes() {
816 setAttributeItem(ARMBuildAttrs::FP_arch,
817 ARMBuildAttrs::AllowFPv2,
818 /* OverwriteExisting= */ false);
822 setAttributeItem(ARMBuildAttrs::FP_arch,
823 ARMBuildAttrs::AllowFPv3A,
824 /* OverwriteExisting= */ false);
828 setAttributeItem(ARMBuildAttrs::FP_arch,
829 ARMBuildAttrs::AllowFPv3B,
830 /* OverwriteExisting= */ false);
834 setAttributeItem(ARMBuildAttrs::FP_arch,
835 ARMBuildAttrs::AllowFPv4A,
836 /* OverwriteExisting= */ false);
840 setAttributeItem(ARMBuildAttrs::FP_arch,
841 ARMBuildAttrs::AllowFPv4B,
842 /* OverwriteExisting= */ false);
846 setAttributeItem(ARMBuildAttrs::FP_arch,
847 ARMBuildAttrs::AllowFPARMv8A,
848 /* OverwriteExisting= */ false);
852 setAttributeItem(ARMBuildAttrs::FP_arch,
853 ARMBuildAttrs::AllowFPv3A,
854 /* OverwriteExisting= */ false);
855 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
856 ARMBuildAttrs::AllowNeon,
857 /* OverwriteExisting= */ false);
860 case ARM::NEON_VFPV4:
861 setAttributeItem(ARMBuildAttrs::FP_arch,
862 ARMBuildAttrs::AllowFPv4A,
863 /* OverwriteExisting= */ false);
864 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
865 ARMBuildAttrs::AllowNeon2,
866 /* OverwriteExisting= */ false);
869 case ARM::NEON_FP_ARMV8:
870 case ARM::CRYPTO_NEON_FP_ARMV8:
871 setAttributeItem(ARMBuildAttrs::FP_arch,
872 ARMBuildAttrs::AllowFPARMv8A,
873 /* OverwriteExisting= */ false);
874 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
875 ARMBuildAttrs::AllowNeonARMv8,
876 /* OverwriteExisting= */ false);
883 report_fatal_error("Unknown FPU: " + Twine(FPU));
887 size_t ARMTargetELFStreamer::calculateContentSize() const {
889 for (size_t i = 0; i < Contents.size(); ++i) {
890 AttributeItem item = Contents[i];
892 case AttributeItem::HiddenAttribute:
894 case AttributeItem::NumericAttribute:
895 Result += getULEB128Size(item.Tag);
896 Result += getULEB128Size(item.IntValue);
898 case AttributeItem::TextAttribute:
899 Result += getULEB128Size(item.Tag);
900 Result += item.StringValue.size() + 1; // string + '\0'
902 case AttributeItem::NumericAndTextAttributes:
903 Result += getULEB128Size(item.Tag);
904 Result += getULEB128Size(item.IntValue);
905 Result += item.StringValue.size() + 1; // string + '\0';
911 void ARMTargetELFStreamer::finishAttributeSection() {
913 // [ <section-length> "vendor-name"
914 // [ <file-tag> <size> <attribute>*
915 // | <section-tag> <size> <section-number>* 0 <attribute>*
916 // | <symbol-tag> <size> <symbol-number>* 0 <attribute>*
920 if (FPU != ARM::INVALID_FPU)
921 emitFPUDefaultAttributes();
923 if (Arch != ARM::INVALID_ARCH)
924 emitArchDefaultAttributes();
926 if (Contents.empty())
929 std::sort(Contents.begin(), Contents.end(), AttributeItem::LessTag);
931 ARMELFStreamer &Streamer = getStreamer();
933 // Switch to .ARM.attributes section
934 if (AttributeSection) {
935 Streamer.SwitchSection(AttributeSection);
938 Streamer.getContext().getELFSection(".ARM.attributes",
939 ELF::SHT_ARM_ATTRIBUTES,
941 SectionKind::getMetadata());
942 Streamer.SwitchSection(AttributeSection);
945 Streamer.EmitIntValue(0x41, 1);
948 // Vendor size + Vendor name + '\0'
949 const size_t VendorHeaderSize = 4 + CurrentVendor.size() + 1;
952 const size_t TagHeaderSize = 1 + 4;
954 const size_t ContentsSize = calculateContentSize();
956 Streamer.EmitIntValue(VendorHeaderSize + TagHeaderSize + ContentsSize, 4);
957 Streamer.EmitBytes(CurrentVendor);
958 Streamer.EmitIntValue(0, 1); // '\0'
960 Streamer.EmitIntValue(ARMBuildAttrs::File, 1);
961 Streamer.EmitIntValue(TagHeaderSize + ContentsSize, 4);
963 // Size should have been accounted for already, now
964 // emit each field as its type (ULEB or String)
965 for (size_t i = 0; i < Contents.size(); ++i) {
966 AttributeItem item = Contents[i];
967 Streamer.EmitULEB128IntValue(item.Tag);
969 default: llvm_unreachable("Invalid attribute type");
970 case AttributeItem::NumericAttribute:
971 Streamer.EmitULEB128IntValue(item.IntValue);
973 case AttributeItem::TextAttribute:
974 Streamer.EmitBytes(item.StringValue.upper());
975 Streamer.EmitIntValue(0, 1); // '\0'
977 case AttributeItem::NumericAndTextAttributes:
978 Streamer.EmitULEB128IntValue(item.IntValue);
979 Streamer.EmitBytes(item.StringValue.upper());
980 Streamer.EmitIntValue(0, 1); // '\0'
986 FPU = ARM::INVALID_FPU;
989 void ARMTargetELFStreamer::emitLabel(MCSymbol *Symbol) {
990 ARMELFStreamer &Streamer = getStreamer();
991 if (!Streamer.IsThumb)
994 const MCSymbolData &SD = Streamer.getOrCreateSymbolData(Symbol);
995 unsigned Type = MCELF::GetType(SD);
996 if (Type == ELF_STT_Func || Type == ELF_STT_GnuIFunc)
997 Streamer.EmitThumbFunc(Symbol);
1001 ARMTargetELFStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
1002 getStreamer().EmitFixup(S, FK_Data_4);
1005 void ARMTargetELFStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
1006 if (const MCSymbolRefExpr *SRE = dyn_cast<MCSymbolRefExpr>(Value)) {
1007 const MCSymbol &Sym = SRE->getSymbol();
1008 if (!Sym.isDefined()) {
1009 getStreamer().EmitAssignment(Symbol, Value);
1014 getStreamer().EmitThumbFunc(Symbol);
1015 getStreamer().EmitAssignment(Symbol, Value);
1018 void ARMTargetELFStreamer::emitInst(uint32_t Inst, char Suffix) {
1019 getStreamer().emitInst(Inst, Suffix);
1022 void ARMELFStreamer::FinishImpl() {
1023 MCTargetStreamer &TS = *getTargetStreamer();
1024 ARMTargetStreamer &ATS = static_cast<ARMTargetStreamer &>(TS);
1025 ATS.finishAttributeSection();
1027 MCELFStreamer::FinishImpl();
1030 inline void ARMELFStreamer::SwitchToEHSection(const char *Prefix,
1034 const MCSymbol &Fn) {
1035 const MCSectionELF &FnSection =
1036 static_cast<const MCSectionELF &>(Fn.getSection());
1038 // Create the name for new section
1039 StringRef FnSecName(FnSection.getSectionName());
1040 SmallString<128> EHSecName(Prefix);
1041 if (FnSecName != ".text") {
1042 EHSecName += FnSecName;
1045 // Get .ARM.extab or .ARM.exidx section
1046 const MCSectionELF *EHSection = nullptr;
1047 if (const MCSymbol *Group = FnSection.getGroup()) {
1048 EHSection = getContext().getELFSection(
1049 EHSecName, Type, Flags | ELF::SHF_GROUP, Kind,
1050 FnSection.getEntrySize(), Group->getName());
1052 EHSection = getContext().getELFSection(EHSecName, Type, Flags, Kind);
1054 assert(EHSection && "Failed to get the required EH section");
1056 // Switch to .ARM.extab or .ARM.exidx section
1057 SwitchSection(EHSection);
1058 EmitCodeAlignment(4);
1061 inline void ARMELFStreamer::SwitchToExTabSection(const MCSymbol &FnStart) {
1062 SwitchToEHSection(".ARM.extab",
1065 SectionKind::getDataRel(),
1069 inline void ARMELFStreamer::SwitchToExIdxSection(const MCSymbol &FnStart) {
1070 SwitchToEHSection(".ARM.exidx",
1072 ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER,
1073 SectionKind::getDataRel(),
1076 void ARMELFStreamer::EmitFixup(const MCExpr *Expr, MCFixupKind Kind) {
1077 MCDataFragment *Frag = getOrCreateDataFragment();
1078 Frag->getFixups().push_back(MCFixup::Create(Frag->getContents().size(), Expr,
1082 void ARMELFStreamer::Reset() {
1085 Personality = nullptr;
1086 PersonalityIndex = ARM::EHABI::NUM_PERSONALITY_INDEX;
1095 UnwindOpAsm.Reset();
1098 void ARMELFStreamer::emitFnStart() {
1099 assert(FnStart == nullptr);
1100 FnStart = getContext().CreateTempSymbol();
1104 void ARMELFStreamer::emitFnEnd() {
1105 assert(FnStart && ".fnstart must precedes .fnend");
1107 // Emit unwind opcodes if there is no .handlerdata directive
1108 if (!ExTab && !CantUnwind)
1109 FlushUnwindOpcodes(true);
1111 // Emit the exception index table entry
1112 SwitchToExIdxSection(*FnStart);
1114 if (PersonalityIndex < ARM::EHABI::NUM_PERSONALITY_INDEX)
1115 EmitPersonalityFixup(GetAEABIUnwindPersonalityName(PersonalityIndex));
1117 const MCSymbolRefExpr *FnStartRef =
1118 MCSymbolRefExpr::Create(FnStart,
1119 MCSymbolRefExpr::VK_ARM_PREL31,
1122 EmitValue(FnStartRef, 4);
1125 EmitIntValue(ARM::EHABI::EXIDX_CANTUNWIND, 4);
1127 // Emit a reference to the unwind opcodes in the ".ARM.extab" section.
1128 const MCSymbolRefExpr *ExTabEntryRef =
1129 MCSymbolRefExpr::Create(ExTab,
1130 MCSymbolRefExpr::VK_ARM_PREL31,
1132 EmitValue(ExTabEntryRef, 4);
1134 // For the __aeabi_unwind_cpp_pr0, we have to emit the unwind opcodes in
1135 // the second word of exception index table entry. The size of the unwind
1136 // opcodes should always be 4 bytes.
1137 assert(PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0 &&
1138 "Compact model must use __aeabi_unwind_cpp_pr0 as personality");
1139 assert(Opcodes.size() == 4u &&
1140 "Unwind opcode size for __aeabi_unwind_cpp_pr0 must be equal to 4");
1141 uint64_t Intval = Opcodes[0] |
1145 EmitIntValue(Intval, Opcodes.size());
1148 // Switch to the section containing FnStart
1149 SwitchSection(&FnStart->getSection());
1151 // Clean exception handling frame information
1155 void ARMELFStreamer::emitCantUnwind() { CantUnwind = true; }
1157 // Add the R_ARM_NONE fixup at the same position
1158 void ARMELFStreamer::EmitPersonalityFixup(StringRef Name) {
1159 const MCSymbol *PersonalitySym = getContext().GetOrCreateSymbol(Name);
1161 const MCSymbolRefExpr *PersonalityRef = MCSymbolRefExpr::Create(
1162 PersonalitySym, MCSymbolRefExpr::VK_ARM_NONE, getContext());
1164 visitUsedExpr(*PersonalityRef);
1165 MCDataFragment *DF = getOrCreateDataFragment();
1166 DF->getFixups().push_back(MCFixup::Create(DF->getContents().size(),
1168 MCFixup::getKindForSize(4, false)));
1171 void ARMELFStreamer::FlushPendingOffset() {
1172 if (PendingOffset != 0) {
1173 UnwindOpAsm.EmitSPOffset(-PendingOffset);
1178 void ARMELFStreamer::FlushUnwindOpcodes(bool NoHandlerData) {
1179 // Emit the unwind opcode to restore $sp.
1181 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1182 int64_t LastRegSaveSPOffset = SPOffset - PendingOffset;
1183 UnwindOpAsm.EmitSPOffset(LastRegSaveSPOffset - FPOffset);
1184 UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1186 FlushPendingOffset();
1189 // Finalize the unwind opcode sequence
1190 UnwindOpAsm.Finalize(PersonalityIndex, Opcodes);
1192 // For compact model 0, we have to emit the unwind opcodes in the .ARM.exidx
1193 // section. Thus, we don't have to create an entry in the .ARM.extab
1195 if (NoHandlerData && PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0)
1198 // Switch to .ARM.extab section.
1199 SwitchToExTabSection(*FnStart);
1201 // Create .ARM.extab label for offset in .ARM.exidx
1203 ExTab = getContext().CreateTempSymbol();
1208 const MCSymbolRefExpr *PersonalityRef =
1209 MCSymbolRefExpr::Create(Personality,
1210 MCSymbolRefExpr::VK_ARM_PREL31,
1213 EmitValue(PersonalityRef, 4);
1216 // Emit unwind opcodes
1217 assert((Opcodes.size() % 4) == 0 &&
1218 "Unwind opcode size for __aeabi_cpp_unwind_pr0 must be multiple of 4");
1219 for (unsigned I = 0; I != Opcodes.size(); I += 4) {
1220 uint64_t Intval = Opcodes[I] |
1221 Opcodes[I + 1] << 8 |
1222 Opcodes[I + 2] << 16 |
1223 Opcodes[I + 3] << 24;
1224 EmitIntValue(Intval, 4);
1227 // According to ARM EHABI section 9.2, if the __aeabi_unwind_cpp_pr1() or
1228 // __aeabi_unwind_cpp_pr2() is used, then the handler data must be emitted
1229 // after the unwind opcodes. The handler data consists of several 32-bit
1230 // words, and should be terminated by zero.
1232 // In case that the .handlerdata directive is not specified by the
1233 // programmer, we should emit zero to terminate the handler data.
1234 if (NoHandlerData && !Personality)
1238 void ARMELFStreamer::emitHandlerData() { FlushUnwindOpcodes(false); }
1240 void ARMELFStreamer::emitPersonality(const MCSymbol *Per) {
1242 UnwindOpAsm.setPersonality(Per);
1245 void ARMELFStreamer::emitPersonalityIndex(unsigned Index) {
1246 assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX && "invalid index");
1247 PersonalityIndex = Index;
1250 void ARMELFStreamer::emitSetFP(unsigned NewFPReg, unsigned NewSPReg,
1252 assert((NewSPReg == ARM::SP || NewSPReg == FPReg) &&
1253 "the operand of .setfp directive should be either $sp or $fp");
1258 if (NewSPReg == ARM::SP)
1259 FPOffset = SPOffset + Offset;
1264 void ARMELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
1265 assert((Reg != ARM::SP && Reg != ARM::PC) &&
1266 "the operand of .movsp cannot be either sp or pc");
1267 assert(FPReg == ARM::SP && "current FP must be SP");
1269 FlushPendingOffset();
1272 FPOffset = SPOffset + Offset;
1274 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1275 UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1278 void ARMELFStreamer::emitPad(int64_t Offset) {
1279 // Track the change of the $sp offset
1282 // To squash multiple .pad directives, we should delay the unwind opcode
1283 // until the .save, .vsave, .handlerdata, or .fnend directives.
1284 PendingOffset -= Offset;
1287 void ARMELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
1289 // Collect the registers in the register list
1292 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1293 for (size_t i = 0; i < RegList.size(); ++i) {
1294 unsigned Reg = MRI->getEncodingValue(RegList[i]);
1295 assert(Reg < (IsVector ? 32U : 16U) && "Register out of range");
1296 unsigned Bit = (1u << Reg);
1297 if ((Mask & Bit) == 0) {
1303 // Track the change the $sp offset: For the .save directive, the
1304 // corresponding push instruction will decrease the $sp by (4 * Count).
1305 // For the .vsave directive, the corresponding vpush instruction will
1306 // decrease $sp by (8 * Count).
1307 SPOffset -= Count * (IsVector ? 8 : 4);
1310 FlushPendingOffset();
1312 UnwindOpAsm.EmitVFPRegSave(Mask);
1314 UnwindOpAsm.EmitRegSave(Mask);
1317 void ARMELFStreamer::emitUnwindRaw(int64_t Offset,
1318 const SmallVectorImpl<uint8_t> &Opcodes) {
1319 FlushPendingOffset();
1320 SPOffset = SPOffset - Offset;
1321 UnwindOpAsm.EmitRaw(Opcodes);
1326 MCStreamer *createMCAsmStreamer(MCContext &Ctx, formatted_raw_ostream &OS,
1327 bool isVerboseAsm, bool useDwarfDirectory,
1328 MCInstPrinter *InstPrint, MCCodeEmitter *CE,
1329 MCAsmBackend *TAB, bool ShowInst) {
1330 MCStreamer *S = llvm::createAsmStreamer(
1331 Ctx, OS, isVerboseAsm, useDwarfDirectory, InstPrint, CE, TAB, ShowInst);
1332 new ARMTargetAsmStreamer(*S, OS, *InstPrint, isVerboseAsm);
1336 MCStreamer *createARMNullStreamer(MCContext &Ctx) {
1337 MCStreamer *S = llvm::createNullStreamer(Ctx);
1338 new ARMTargetStreamer(*S);
1342 MCELFStreamer* createARMELFStreamer(MCContext &Context, MCAsmBackend &TAB,
1343 raw_ostream &OS, MCCodeEmitter *Emitter,
1344 bool RelaxAll, bool NoExecStack,
1346 ARMELFStreamer *S = new ARMELFStreamer(Context, TAB, OS, Emitter, IsThumb);
1347 new ARMTargetELFStreamer(*S);
1348 // FIXME: This should eventually end up somewhere else where more
1349 // intelligent flag decisions can be made. For now we are just maintaining
1350 // the status quo for ARM and setting EF_ARM_EABI_VER5 as the default.
1351 S->getAssembler().setELFHeaderEFlags(ELF::EF_ARM_EABI_VER5);
1354 S->getAssembler().setRelaxAll(true);
1356 S->getAssembler().setNoExecStack(true);