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 "ARMRegisterInfo.h"
17 #include "ARMUnwindOpAsm.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/Twine.h"
20 #include "llvm/MC/MCAsmBackend.h"
21 #include "llvm/MC/MCAsmInfo.h"
22 #include "llvm/MC/MCAssembler.h"
23 #include "llvm/MC/MCCodeEmitter.h"
24 #include "llvm/MC/MCContext.h"
25 #include "llvm/MC/MCELFStreamer.h"
26 #include "llvm/MC/MCExpr.h"
27 #include "llvm/MC/MCInst.h"
28 #include "llvm/MC/MCInstPrinter.h"
29 #include "llvm/MC/MCObjectFileInfo.h"
30 #include "llvm/MC/MCObjectStreamer.h"
31 #include "llvm/MC/MCRegisterInfo.h"
32 #include "llvm/MC/MCSection.h"
33 #include "llvm/MC/MCSectionELF.h"
34 #include "llvm/MC/MCStreamer.h"
35 #include "llvm/MC/MCSymbolELF.h"
36 #include "llvm/MC/MCValue.h"
37 #include "llvm/Support/ARMBuildAttributes.h"
38 #include "llvm/Support/ARMEHABI.h"
39 #include "llvm/Support/TargetParser.h"
40 #include "llvm/Support/Debug.h"
41 #include "llvm/Support/ELF.h"
42 #include "llvm/Support/FormattedStream.h"
43 #include "llvm/Support/LEB128.h"
44 #include "llvm/Support/raw_ostream.h"
49 static std::string GetAEABIUnwindPersonalityName(unsigned Index) {
50 assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX &&
51 "Invalid personality index");
52 return (Twine("__aeabi_unwind_cpp_pr") + Twine(Index)).str();
59 class ARMTargetAsmStreamer : public ARMTargetStreamer {
60 formatted_raw_ostream &OS;
61 MCInstPrinter &InstPrinter;
64 void emitFnStart() override;
65 void emitFnEnd() override;
66 void emitCantUnwind() override;
67 void emitPersonality(const MCSymbol *Personality) override;
68 void emitPersonalityIndex(unsigned Index) override;
69 void emitHandlerData() override;
70 void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
71 void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
72 void emitPad(int64_t Offset) override;
73 void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
74 bool isVector) override;
75 void emitUnwindRaw(int64_t Offset,
76 const SmallVectorImpl<uint8_t> &Opcodes) override;
78 void switchVendor(StringRef Vendor) override;
79 void emitAttribute(unsigned Attribute, unsigned Value) override;
80 void emitTextAttribute(unsigned Attribute, StringRef String) override;
81 void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
82 StringRef StrinValue) override;
83 void emitArch(unsigned Arch) override;
84 void emitArchExtension(unsigned ArchExt) override;
85 void emitObjectArch(unsigned Arch) override;
86 void emitFPU(unsigned FPU) override;
87 void emitInst(uint32_t Inst, char Suffix = '\0') override;
88 void finishAttributeSection() override;
90 void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
91 void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
94 ARMTargetAsmStreamer(MCStreamer &S, formatted_raw_ostream &OS,
95 MCInstPrinter &InstPrinter, bool VerboseAsm);
98 ARMTargetAsmStreamer::ARMTargetAsmStreamer(MCStreamer &S,
99 formatted_raw_ostream &OS,
100 MCInstPrinter &InstPrinter,
102 : ARMTargetStreamer(S), OS(OS), InstPrinter(InstPrinter),
103 IsVerboseAsm(VerboseAsm) {}
104 void ARMTargetAsmStreamer::emitFnStart() { OS << "\t.fnstart\n"; }
105 void ARMTargetAsmStreamer::emitFnEnd() { OS << "\t.fnend\n"; }
106 void ARMTargetAsmStreamer::emitCantUnwind() { OS << "\t.cantunwind\n"; }
107 void ARMTargetAsmStreamer::emitPersonality(const MCSymbol *Personality) {
108 OS << "\t.personality " << Personality->getName() << '\n';
110 void ARMTargetAsmStreamer::emitPersonalityIndex(unsigned Index) {
111 OS << "\t.personalityindex " << Index << '\n';
113 void ARMTargetAsmStreamer::emitHandlerData() { OS << "\t.handlerdata\n"; }
114 void ARMTargetAsmStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
117 InstPrinter.printRegName(OS, FpReg);
119 InstPrinter.printRegName(OS, SpReg);
121 OS << ", #" << Offset;
124 void ARMTargetAsmStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
125 assert((Reg != ARM::SP && Reg != ARM::PC) &&
126 "the operand of .movsp cannot be either sp or pc");
129 InstPrinter.printRegName(OS, Reg);
131 OS << ", #" << Offset;
134 void ARMTargetAsmStreamer::emitPad(int64_t Offset) {
135 OS << "\t.pad\t#" << Offset << '\n';
137 void ARMTargetAsmStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
139 assert(RegList.size() && "RegList should not be empty");
145 InstPrinter.printRegName(OS, RegList[0]);
147 for (unsigned i = 1, e = RegList.size(); i != e; ++i) {
149 InstPrinter.printRegName(OS, RegList[i]);
154 void ARMTargetAsmStreamer::switchVendor(StringRef Vendor) {
156 void ARMTargetAsmStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
157 OS << "\t.eabi_attribute\t" << Attribute << ", " << Twine(Value);
159 StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
161 OS << "\t@ " << Name;
165 void ARMTargetAsmStreamer::emitTextAttribute(unsigned Attribute,
168 case ARMBuildAttrs::CPU_name:
169 OS << "\t.cpu\t" << String.lower();
172 OS << "\t.eabi_attribute\t" << Attribute << ", \"" << String << "\"";
174 StringRef Name = ARMBuildAttrs::AttrTypeAsString(Attribute);
176 OS << "\t@ " << Name;
182 void ARMTargetAsmStreamer::emitIntTextAttribute(unsigned Attribute,
184 StringRef StringValue) {
186 default: llvm_unreachable("unsupported multi-value attribute in asm mode");
187 case ARMBuildAttrs::compatibility:
188 OS << "\t.eabi_attribute\t" << Attribute << ", " << IntValue;
189 if (!StringValue.empty())
190 OS << ", \"" << StringValue << "\"";
192 OS << "\t@ " << ARMBuildAttrs::AttrTypeAsString(Attribute);
197 void ARMTargetAsmStreamer::emitArch(unsigned Arch) {
198 OS << "\t.arch\t" << ARM::getArchName(Arch) << "\n";
200 void ARMTargetAsmStreamer::emitArchExtension(unsigned ArchExt) {
201 OS << "\t.arch_extension\t" << ARM::getArchExtName(ArchExt) << "\n";
203 void ARMTargetAsmStreamer::emitObjectArch(unsigned Arch) {
204 OS << "\t.object_arch\t" << ARM::getArchName(Arch) << '\n';
206 void ARMTargetAsmStreamer::emitFPU(unsigned FPU) {
207 OS << "\t.fpu\t" << ARM::getFPUName(FPU) << "\n";
209 void ARMTargetAsmStreamer::finishAttributeSection() {
212 ARMTargetAsmStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
213 OS << "\t.tlsdescseq\t" << S->getSymbol().getName();
216 void ARMTargetAsmStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
217 const MCAsmInfo *MAI = Streamer.getContext().getAsmInfo();
219 OS << "\t.thumb_set\t";
220 Symbol->print(OS, MAI);
222 Value->print(OS, MAI);
226 void ARMTargetAsmStreamer::emitInst(uint32_t Inst, char Suffix) {
230 OS << "\t0x" << Twine::utohexstr(Inst) << "\n";
233 void ARMTargetAsmStreamer::emitUnwindRaw(int64_t Offset,
234 const SmallVectorImpl<uint8_t> &Opcodes) {
235 OS << "\t.unwind_raw " << Offset;
236 for (SmallVectorImpl<uint8_t>::const_iterator OCI = Opcodes.begin(),
239 OS << ", 0x" << Twine::utohexstr(*OCI);
243 class ARMTargetELFStreamer : public ARMTargetStreamer {
245 // This structure holds all attributes, accounting for
246 // their string/numeric value, so we can later emmit them
247 // in declaration order, keeping all in the same vector
248 struct AttributeItem {
253 NumericAndTextAttributes
257 StringRef StringValue;
259 static bool LessTag(const AttributeItem &LHS, const AttributeItem &RHS) {
260 // The conformance tag must be emitted first when serialised
261 // into an object file. Specifically, the addenda to the ARM ABI
262 // states that (2.3.7.4):
264 // "To simplify recognition by consumers in the common case of
265 // claiming conformity for the whole file, this tag should be
266 // emitted first in a file-scope sub-subsection of the first
267 // public subsection of the attributes section."
269 // So it is special-cased in this comparison predicate when the
270 // attributes are sorted in finishAttributeSection().
271 return (RHS.Tag != ARMBuildAttrs::conformance) &&
272 ((LHS.Tag == ARMBuildAttrs::conformance) || (LHS.Tag < RHS.Tag));
276 StringRef CurrentVendor;
279 unsigned EmittedArch;
280 SmallVector<AttributeItem, 64> Contents;
282 MCSection *AttributeSection;
284 AttributeItem *getAttributeItem(unsigned Attribute) {
285 for (size_t i = 0; i < Contents.size(); ++i)
286 if (Contents[i].Tag == Attribute)
291 void setAttributeItem(unsigned Attribute, unsigned Value,
292 bool OverwriteExisting) {
293 // Look for existing attribute item
294 if (AttributeItem *Item = getAttributeItem(Attribute)) {
295 if (!OverwriteExisting)
297 Item->Type = AttributeItem::NumericAttribute;
298 Item->IntValue = Value;
302 // Create new attribute item
303 AttributeItem Item = {
304 AttributeItem::NumericAttribute,
309 Contents.push_back(Item);
312 void setAttributeItem(unsigned Attribute, StringRef Value,
313 bool OverwriteExisting) {
314 // Look for existing attribute item
315 if (AttributeItem *Item = getAttributeItem(Attribute)) {
316 if (!OverwriteExisting)
318 Item->Type = AttributeItem::TextAttribute;
319 Item->StringValue = Value;
323 // Create new attribute item
324 AttributeItem Item = {
325 AttributeItem::TextAttribute,
330 Contents.push_back(Item);
333 void setAttributeItems(unsigned Attribute, unsigned IntValue,
334 StringRef StringValue, bool OverwriteExisting) {
335 // Look for existing attribute item
336 if (AttributeItem *Item = getAttributeItem(Attribute)) {
337 if (!OverwriteExisting)
339 Item->Type = AttributeItem::NumericAndTextAttributes;
340 Item->IntValue = IntValue;
341 Item->StringValue = StringValue;
345 // Create new attribute item
346 AttributeItem Item = {
347 AttributeItem::NumericAndTextAttributes,
352 Contents.push_back(Item);
355 void emitArchDefaultAttributes();
356 void emitFPUDefaultAttributes();
358 ARMELFStreamer &getStreamer();
360 void emitFnStart() override;
361 void emitFnEnd() override;
362 void emitCantUnwind() override;
363 void emitPersonality(const MCSymbol *Personality) override;
364 void emitPersonalityIndex(unsigned Index) override;
365 void emitHandlerData() override;
366 void emitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0) override;
367 void emitMovSP(unsigned Reg, int64_t Offset = 0) override;
368 void emitPad(int64_t Offset) override;
369 void emitRegSave(const SmallVectorImpl<unsigned> &RegList,
370 bool isVector) override;
371 void emitUnwindRaw(int64_t Offset,
372 const SmallVectorImpl<uint8_t> &Opcodes) override;
374 void switchVendor(StringRef Vendor) override;
375 void emitAttribute(unsigned Attribute, unsigned Value) override;
376 void emitTextAttribute(unsigned Attribute, StringRef String) override;
377 void emitIntTextAttribute(unsigned Attribute, unsigned IntValue,
378 StringRef StringValue) override;
379 void emitArch(unsigned Arch) override;
380 void emitObjectArch(unsigned Arch) override;
381 void emitFPU(unsigned FPU) override;
382 void emitInst(uint32_t Inst, char Suffix = '\0') override;
383 void finishAttributeSection() override;
384 void emitLabel(MCSymbol *Symbol) override;
386 void AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *SRE) override;
387 void emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) override;
389 size_t calculateContentSize() const;
392 ARMTargetELFStreamer(MCStreamer &S)
393 : ARMTargetStreamer(S), CurrentVendor("aeabi"), FPU(ARM::FK_INVALID),
394 Arch(ARM::AK_INVALID), EmittedArch(ARM::AK_INVALID),
395 AttributeSection(nullptr) {}
398 /// Extend the generic ELFStreamer class so that it can emit mapping symbols at
399 /// the appropriate points in the object files. These symbols are defined in the
400 /// ARM ELF ABI: infocenter.arm.com/help/topic/com.arm.../IHI0044D_aaelf.pdf.
402 /// In brief: $a, $t or $d should be emitted at the start of each contiguous
403 /// region of ARM code, Thumb code or data in a section. In practice, this
404 /// emission does not rely on explicit assembler directives but on inherent
405 /// properties of the directives doing the emission (e.g. ".byte" is data, "add
406 /// r0, r0, r0" an instruction).
408 /// As a result this system is orthogonal to the DataRegion infrastructure used
409 /// by MachO. Beware!
410 class ARMELFStreamer : public MCELFStreamer {
412 friend class ARMTargetELFStreamer;
414 ARMELFStreamer(MCContext &Context, MCAsmBackend &TAB, raw_pwrite_stream &OS,
415 MCCodeEmitter *Emitter, bool IsThumb)
416 : MCELFStreamer(Context, TAB, OS, Emitter), IsThumb(IsThumb),
417 MappingSymbolCounter(0), LastEMS(EMS_None) {
423 void FinishImpl() override;
425 // ARM exception handling directives
428 void emitCantUnwind();
429 void emitPersonality(const MCSymbol *Per);
430 void emitPersonalityIndex(unsigned index);
431 void emitHandlerData();
432 void emitSetFP(unsigned NewFpReg, unsigned NewSpReg, int64_t Offset = 0);
433 void emitMovSP(unsigned Reg, int64_t Offset = 0);
434 void emitPad(int64_t Offset);
435 void emitRegSave(const SmallVectorImpl<unsigned> &RegList, bool isVector);
436 void emitUnwindRaw(int64_t Offset, const SmallVectorImpl<uint8_t> &Opcodes);
438 void ChangeSection(MCSection *Section, const MCExpr *Subsection) override {
439 // We have to keep track of the mapping symbol state of any sections we
440 // use. Each one should start off as EMS_None, which is provided as the
441 // default constructor by DenseMap::lookup.
442 LastMappingSymbols[getPreviousSection().first] = LastEMS;
443 LastEMS = LastMappingSymbols.lookup(Section);
445 MCELFStreamer::ChangeSection(Section, Subsection);
448 /// This function is the one used to emit instruction data into the ELF
449 /// streamer. We override it to add the appropriate mapping symbol if
451 void EmitInstruction(const MCInst& Inst,
452 const MCSubtargetInfo &STI) override {
454 EmitThumbMappingSymbol();
456 EmitARMMappingSymbol();
458 MCELFStreamer::EmitInstruction(Inst, STI);
461 void emitInst(uint32_t Inst, char Suffix) {
464 const bool LittleEndian = getContext().getAsmInfo()->isLittleEndian();
471 EmitARMMappingSymbol();
472 for (unsigned II = 0, IE = Size; II != IE; II++) {
473 const unsigned I = LittleEndian ? (Size - II - 1) : II;
474 Buffer[Size - II - 1] = uint8_t(Inst >> I * CHAR_BIT);
480 Size = (Suffix == 'n' ? 2 : 4);
483 EmitThumbMappingSymbol();
484 for (unsigned II = 0, IE = Size; II != IE; II = II + 2) {
485 const unsigned I0 = LittleEndian ? II + 0 : (Size - II - 1);
486 const unsigned I1 = LittleEndian ? II + 1 : (Size - II - 2);
487 Buffer[Size - II - 2] = uint8_t(Inst >> I0 * CHAR_BIT);
488 Buffer[Size - II - 1] = uint8_t(Inst >> I1 * CHAR_BIT);
493 llvm_unreachable("Invalid Suffix");
496 MCELFStreamer::EmitBytes(StringRef(Buffer, Size));
499 /// This is one of the functions used to emit data into an ELF section, so the
500 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
502 void EmitBytes(StringRef Data) override {
503 EmitDataMappingSymbol();
504 MCELFStreamer::EmitBytes(Data);
507 /// This is one of the functions used to emit data into an ELF section, so the
508 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
510 void EmitValueImpl(const MCExpr *Value, unsigned Size,
511 const SMLoc &Loc) override {
512 if (const MCSymbolRefExpr *SRE = dyn_cast_or_null<MCSymbolRefExpr>(Value))
513 if (SRE->getKind() == MCSymbolRefExpr::VK_ARM_SBREL && !(Size == 4))
514 getContext().reportFatalError(Loc, "relocated expression must be 32-bit");
516 EmitDataMappingSymbol();
517 MCELFStreamer::EmitValueImpl(Value, Size);
520 void EmitAssemblerFlag(MCAssemblerFlag Flag) override {
521 MCELFStreamer::EmitAssemblerFlag(Flag);
524 case MCAF_SyntaxUnified:
525 return; // no-op here.
528 return; // Change to Thumb mode
531 return; // Change to ARM mode
534 case MCAF_SubsectionsViaSymbols:
540 enum ElfMappingSymbol {
547 void EmitDataMappingSymbol() {
548 if (LastEMS == EMS_Data) return;
549 EmitMappingSymbol("$d");
553 void EmitThumbMappingSymbol() {
554 if (LastEMS == EMS_Thumb) return;
555 EmitMappingSymbol("$t");
559 void EmitARMMappingSymbol() {
560 if (LastEMS == EMS_ARM) return;
561 EmitMappingSymbol("$a");
565 void EmitMappingSymbol(StringRef Name) {
566 auto *Symbol = cast<MCSymbolELF>(getContext().getOrCreateSymbol(
567 Name + "." + Twine(MappingSymbolCounter++)));
570 Symbol->setType(ELF::STT_NOTYPE);
571 Symbol->setBinding(ELF::STB_LOCAL);
572 Symbol->setExternal(false);
575 void EmitThumbFunc(MCSymbol *Func) override {
576 getAssembler().setIsThumbFunc(Func);
577 EmitSymbolAttribute(Func, MCSA_ELF_TypeFunction);
580 // Helper functions for ARM exception handling directives
583 void EmitPersonalityFixup(StringRef Name);
584 void FlushPendingOffset();
585 void FlushUnwindOpcodes(bool NoHandlerData);
587 void SwitchToEHSection(const char *Prefix, unsigned Type, unsigned Flags,
588 SectionKind Kind, const MCSymbol &Fn);
589 void SwitchToExTabSection(const MCSymbol &FnStart);
590 void SwitchToExIdxSection(const MCSymbol &FnStart);
592 void EmitFixup(const MCExpr *Expr, MCFixupKind Kind);
595 int64_t MappingSymbolCounter;
597 DenseMap<const MCSection *, ElfMappingSymbol> LastMappingSymbols;
598 ElfMappingSymbol LastEMS;
600 // ARM Exception Handling Frame Information
603 const MCSymbol *Personality;
604 unsigned PersonalityIndex;
605 unsigned FPReg; // Frame pointer register
606 int64_t FPOffset; // Offset: (final frame pointer) - (initial $sp)
607 int64_t SPOffset; // Offset: (final $sp) - (initial $sp)
608 int64_t PendingOffset; // Offset: (final $sp) - (emitted $sp)
611 SmallVector<uint8_t, 64> Opcodes;
612 UnwindOpcodeAssembler UnwindOpAsm;
614 } // end anonymous namespace
616 ARMELFStreamer &ARMTargetELFStreamer::getStreamer() {
617 return static_cast<ARMELFStreamer &>(Streamer);
620 void ARMTargetELFStreamer::emitFnStart() { getStreamer().emitFnStart(); }
621 void ARMTargetELFStreamer::emitFnEnd() { getStreamer().emitFnEnd(); }
622 void ARMTargetELFStreamer::emitCantUnwind() { getStreamer().emitCantUnwind(); }
623 void ARMTargetELFStreamer::emitPersonality(const MCSymbol *Personality) {
624 getStreamer().emitPersonality(Personality);
626 void ARMTargetELFStreamer::emitPersonalityIndex(unsigned Index) {
627 getStreamer().emitPersonalityIndex(Index);
629 void ARMTargetELFStreamer::emitHandlerData() {
630 getStreamer().emitHandlerData();
632 void ARMTargetELFStreamer::emitSetFP(unsigned FpReg, unsigned SpReg,
634 getStreamer().emitSetFP(FpReg, SpReg, Offset);
636 void ARMTargetELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
637 getStreamer().emitMovSP(Reg, Offset);
639 void ARMTargetELFStreamer::emitPad(int64_t Offset) {
640 getStreamer().emitPad(Offset);
642 void ARMTargetELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
644 getStreamer().emitRegSave(RegList, isVector);
646 void ARMTargetELFStreamer::emitUnwindRaw(int64_t Offset,
647 const SmallVectorImpl<uint8_t> &Opcodes) {
648 getStreamer().emitUnwindRaw(Offset, Opcodes);
650 void ARMTargetELFStreamer::switchVendor(StringRef Vendor) {
651 assert(!Vendor.empty() && "Vendor cannot be empty.");
653 if (CurrentVendor == Vendor)
656 if (!CurrentVendor.empty())
657 finishAttributeSection();
659 assert(Contents.empty() &&
660 ".ARM.attributes should be flushed before changing vendor");
661 CurrentVendor = Vendor;
664 void ARMTargetELFStreamer::emitAttribute(unsigned Attribute, unsigned Value) {
665 setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
667 void ARMTargetELFStreamer::emitTextAttribute(unsigned Attribute,
669 setAttributeItem(Attribute, Value, /* OverwriteExisting= */ true);
671 void ARMTargetELFStreamer::emitIntTextAttribute(unsigned Attribute,
673 StringRef StringValue) {
674 setAttributeItems(Attribute, IntValue, StringValue,
675 /* OverwriteExisting= */ true);
677 void ARMTargetELFStreamer::emitArch(unsigned Value) {
680 void ARMTargetELFStreamer::emitObjectArch(unsigned Value) {
683 void ARMTargetELFStreamer::emitArchDefaultAttributes() {
684 using namespace ARMBuildAttrs;
686 setAttributeItem(CPU_name,
687 ARM::getCPUAttr(Arch),
690 if (EmittedArch == ARM::AK_INVALID)
691 setAttributeItem(CPU_arch,
692 ARM::getArchAttr(Arch),
695 setAttributeItem(CPU_arch,
696 ARM::getArchAttr(EmittedArch),
706 setAttributeItem(ARM_ISA_use, Allowed, false);
711 case ARM::AK_ARMV5TE:
714 setAttributeItem(ARM_ISA_use, Allowed, false);
715 setAttributeItem(THUMB_ISA_use, Allowed, false);
718 case ARM::AK_ARMV6T2:
719 setAttributeItem(ARM_ISA_use, Allowed, false);
720 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
725 case ARM::AK_ARMV6ZK:
726 setAttributeItem(ARM_ISA_use, Allowed, false);
727 setAttributeItem(THUMB_ISA_use, Allowed, false);
728 setAttributeItem(Virtualization_use, AllowTZ, false);
732 setAttributeItem(THUMB_ISA_use, Allowed, false);
736 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
740 setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
741 setAttributeItem(ARM_ISA_use, Allowed, false);
742 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
746 setAttributeItem(CPU_arch_profile, RealTimeProfile, false);
747 setAttributeItem(ARM_ISA_use, Allowed, false);
748 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
752 setAttributeItem(CPU_arch_profile, MicroControllerProfile, false);
753 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
757 case ARM::AK_ARMV8_1A:
758 setAttributeItem(CPU_arch_profile, ApplicationProfile, false);
759 setAttributeItem(ARM_ISA_use, Allowed, false);
760 setAttributeItem(THUMB_ISA_use, AllowThumb32, false);
761 setAttributeItem(MPextension_use, Allowed, false);
762 setAttributeItem(Virtualization_use, AllowTZVirtualization, false);
766 setAttributeItem(ARM_ISA_use, Allowed, false);
767 setAttributeItem(THUMB_ISA_use, Allowed, false);
768 setAttributeItem(WMMX_arch, AllowWMMXv1, false);
771 case ARM::AK_IWMMXT2:
772 setAttributeItem(ARM_ISA_use, Allowed, false);
773 setAttributeItem(THUMB_ISA_use, Allowed, false);
774 setAttributeItem(WMMX_arch, AllowWMMXv2, false);
778 report_fatal_error("Unknown Arch: " + Twine(Arch));
782 void ARMTargetELFStreamer::emitFPU(unsigned Value) {
785 void ARMTargetELFStreamer::emitFPUDefaultAttributes() {
789 setAttributeItem(ARMBuildAttrs::FP_arch,
790 ARMBuildAttrs::AllowFPv2,
791 /* OverwriteExisting= */ false);
795 setAttributeItem(ARMBuildAttrs::FP_arch,
796 ARMBuildAttrs::AllowFPv3A,
797 /* OverwriteExisting= */ false);
800 case ARM::FK_VFPV3_FP16:
801 setAttributeItem(ARMBuildAttrs::FP_arch,
802 ARMBuildAttrs::AllowFPv3A,
803 /* OverwriteExisting= */ false);
804 setAttributeItem(ARMBuildAttrs::FP_HP_extension,
805 ARMBuildAttrs::AllowHPFP,
806 /* OverwriteExisting= */ false);
809 case ARM::FK_VFPV3_D16:
810 setAttributeItem(ARMBuildAttrs::FP_arch,
811 ARMBuildAttrs::AllowFPv3B,
812 /* OverwriteExisting= */ false);
815 case ARM::FK_VFPV3_D16_FP16:
816 setAttributeItem(ARMBuildAttrs::FP_arch,
817 ARMBuildAttrs::AllowFPv3B,
818 /* OverwriteExisting= */ false);
819 setAttributeItem(ARMBuildAttrs::FP_HP_extension,
820 ARMBuildAttrs::AllowHPFP,
821 /* OverwriteExisting= */ false);
824 case ARM::FK_VFPV3XD:
825 setAttributeItem(ARMBuildAttrs::FP_arch,
826 ARMBuildAttrs::AllowFPv3B,
827 /* OverwriteExisting= */ false);
829 case ARM::FK_VFPV3XD_FP16:
830 setAttributeItem(ARMBuildAttrs::FP_arch,
831 ARMBuildAttrs::AllowFPv3B,
832 /* OverwriteExisting= */ false);
833 setAttributeItem(ARMBuildAttrs::FP_HP_extension,
834 ARMBuildAttrs::AllowHPFP,
835 /* OverwriteExisting= */ false);
839 setAttributeItem(ARMBuildAttrs::FP_arch,
840 ARMBuildAttrs::AllowFPv4A,
841 /* OverwriteExisting= */ false);
844 // ABI_HardFP_use is handled in ARMAsmPrinter, so _SP_D16 is treated the same
846 case ARM::FK_FPV4_SP_D16:
847 case ARM::FK_VFPV4_D16:
848 setAttributeItem(ARMBuildAttrs::FP_arch,
849 ARMBuildAttrs::AllowFPv4B,
850 /* OverwriteExisting= */ false);
853 case ARM::FK_FP_ARMV8:
854 setAttributeItem(ARMBuildAttrs::FP_arch,
855 ARMBuildAttrs::AllowFPARMv8A,
856 /* OverwriteExisting= */ false);
859 // FPV5_D16 is identical to FP_ARMV8 except for the number of D registers, so
860 // uses the FP_ARMV8_D16 build attribute.
861 case ARM::FK_FPV5_SP_D16:
862 case ARM::FK_FPV5_D16:
863 setAttributeItem(ARMBuildAttrs::FP_arch,
864 ARMBuildAttrs::AllowFPARMv8B,
865 /* OverwriteExisting= */ false);
869 setAttributeItem(ARMBuildAttrs::FP_arch,
870 ARMBuildAttrs::AllowFPv3A,
871 /* OverwriteExisting= */ false);
872 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
873 ARMBuildAttrs::AllowNeon,
874 /* OverwriteExisting= */ false);
877 case ARM::FK_NEON_FP16:
878 setAttributeItem(ARMBuildAttrs::FP_arch,
879 ARMBuildAttrs::AllowFPv3A,
880 /* OverwriteExisting= */ false);
881 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
882 ARMBuildAttrs::AllowNeon,
883 /* OverwriteExisting= */ false);
884 setAttributeItem(ARMBuildAttrs::FP_HP_extension,
885 ARMBuildAttrs::AllowHPFP,
886 /* OverwriteExisting= */ false);
889 case ARM::FK_NEON_VFPV4:
890 setAttributeItem(ARMBuildAttrs::FP_arch,
891 ARMBuildAttrs::AllowFPv4A,
892 /* OverwriteExisting= */ false);
893 setAttributeItem(ARMBuildAttrs::Advanced_SIMD_arch,
894 ARMBuildAttrs::AllowNeon2,
895 /* OverwriteExisting= */ false);
898 case ARM::FK_NEON_FP_ARMV8:
899 case ARM::FK_CRYPTO_NEON_FP_ARMV8:
900 setAttributeItem(ARMBuildAttrs::FP_arch,
901 ARMBuildAttrs::AllowFPARMv8A,
902 /* OverwriteExisting= */ false);
903 // 'Advanced_SIMD_arch' must be emitted not here, but within
904 // ARMAsmPrinter::emitAttributes(), depending on hasV8Ops() and hasV8_1a()
907 case ARM::FK_SOFTVFP:
912 report_fatal_error("Unknown FPU: " + Twine(FPU));
916 size_t ARMTargetELFStreamer::calculateContentSize() const {
918 for (size_t i = 0; i < Contents.size(); ++i) {
919 AttributeItem item = Contents[i];
921 case AttributeItem::HiddenAttribute:
923 case AttributeItem::NumericAttribute:
924 Result += getULEB128Size(item.Tag);
925 Result += getULEB128Size(item.IntValue);
927 case AttributeItem::TextAttribute:
928 Result += getULEB128Size(item.Tag);
929 Result += item.StringValue.size() + 1; // string + '\0'
931 case AttributeItem::NumericAndTextAttributes:
932 Result += getULEB128Size(item.Tag);
933 Result += getULEB128Size(item.IntValue);
934 Result += item.StringValue.size() + 1; // string + '\0';
940 void ARMTargetELFStreamer::finishAttributeSection() {
942 // [ <section-length> "vendor-name"
943 // [ <file-tag> <size> <attribute>*
944 // | <section-tag> <size> <section-number>* 0 <attribute>*
945 // | <symbol-tag> <size> <symbol-number>* 0 <attribute>*
949 if (FPU != ARM::FK_INVALID)
950 emitFPUDefaultAttributes();
952 if (Arch != ARM::AK_INVALID)
953 emitArchDefaultAttributes();
955 if (Contents.empty())
958 std::sort(Contents.begin(), Contents.end(), AttributeItem::LessTag);
960 ARMELFStreamer &Streamer = getStreamer();
962 // Switch to .ARM.attributes section
963 if (AttributeSection) {
964 Streamer.SwitchSection(AttributeSection);
966 AttributeSection = Streamer.getContext().getELFSection(
967 ".ARM.attributes", ELF::SHT_ARM_ATTRIBUTES, 0);
968 Streamer.SwitchSection(AttributeSection);
971 Streamer.EmitIntValue(0x41, 1);
974 // Vendor size + Vendor name + '\0'
975 const size_t VendorHeaderSize = 4 + CurrentVendor.size() + 1;
978 const size_t TagHeaderSize = 1 + 4;
980 const size_t ContentsSize = calculateContentSize();
982 Streamer.EmitIntValue(VendorHeaderSize + TagHeaderSize + ContentsSize, 4);
983 Streamer.EmitBytes(CurrentVendor);
984 Streamer.EmitIntValue(0, 1); // '\0'
986 Streamer.EmitIntValue(ARMBuildAttrs::File, 1);
987 Streamer.EmitIntValue(TagHeaderSize + ContentsSize, 4);
989 // Size should have been accounted for already, now
990 // emit each field as its type (ULEB or String)
991 for (size_t i = 0; i < Contents.size(); ++i) {
992 AttributeItem item = Contents[i];
993 Streamer.EmitULEB128IntValue(item.Tag);
995 default: llvm_unreachable("Invalid attribute type");
996 case AttributeItem::NumericAttribute:
997 Streamer.EmitULEB128IntValue(item.IntValue);
999 case AttributeItem::TextAttribute:
1000 Streamer.EmitBytes(item.StringValue);
1001 Streamer.EmitIntValue(0, 1); // '\0'
1003 case AttributeItem::NumericAndTextAttributes:
1004 Streamer.EmitULEB128IntValue(item.IntValue);
1005 Streamer.EmitBytes(item.StringValue);
1006 Streamer.EmitIntValue(0, 1); // '\0'
1012 FPU = ARM::FK_INVALID;
1015 void ARMTargetELFStreamer::emitLabel(MCSymbol *Symbol) {
1016 ARMELFStreamer &Streamer = getStreamer();
1017 if (!Streamer.IsThumb)
1020 Streamer.getAssembler().registerSymbol(*Symbol);
1021 unsigned Type = cast<MCSymbolELF>(Symbol)->getType();
1022 if (Type == ELF::STT_FUNC || Type == ELF::STT_GNU_IFUNC)
1023 Streamer.EmitThumbFunc(Symbol);
1027 ARMTargetELFStreamer::AnnotateTLSDescriptorSequence(const MCSymbolRefExpr *S) {
1028 getStreamer().EmitFixup(S, FK_Data_4);
1031 void ARMTargetELFStreamer::emitThumbSet(MCSymbol *Symbol, const MCExpr *Value) {
1032 if (const MCSymbolRefExpr *SRE = dyn_cast<MCSymbolRefExpr>(Value)) {
1033 const MCSymbol &Sym = SRE->getSymbol();
1034 if (!Sym.isDefined()) {
1035 getStreamer().EmitAssignment(Symbol, Value);
1040 getStreamer().EmitThumbFunc(Symbol);
1041 getStreamer().EmitAssignment(Symbol, Value);
1044 void ARMTargetELFStreamer::emitInst(uint32_t Inst, char Suffix) {
1045 getStreamer().emitInst(Inst, Suffix);
1048 void ARMELFStreamer::FinishImpl() {
1049 MCTargetStreamer &TS = *getTargetStreamer();
1050 ARMTargetStreamer &ATS = static_cast<ARMTargetStreamer &>(TS);
1051 ATS.finishAttributeSection();
1053 MCELFStreamer::FinishImpl();
1056 inline void ARMELFStreamer::SwitchToEHSection(const char *Prefix,
1060 const MCSymbol &Fn) {
1061 const MCSectionELF &FnSection =
1062 static_cast<const MCSectionELF &>(Fn.getSection());
1064 // Create the name for new section
1065 StringRef FnSecName(FnSection.getSectionName());
1066 SmallString<128> EHSecName(Prefix);
1067 if (FnSecName != ".text") {
1068 EHSecName += FnSecName;
1071 // Get .ARM.extab or .ARM.exidx section
1072 const MCSymbolELF *Group = FnSection.getGroup();
1074 Flags |= ELF::SHF_GROUP;
1075 MCSectionELF *EHSection =
1076 getContext().getELFSection(EHSecName, Type, Flags, 0, Group,
1077 FnSection.getUniqueID(), nullptr, &FnSection);
1079 assert(EHSection && "Failed to get the required EH section");
1081 // Switch to .ARM.extab or .ARM.exidx section
1082 SwitchSection(EHSection);
1083 EmitCodeAlignment(4);
1086 inline void ARMELFStreamer::SwitchToExTabSection(const MCSymbol &FnStart) {
1087 SwitchToEHSection(".ARM.extab",
1090 SectionKind::getDataRel(),
1094 inline void ARMELFStreamer::SwitchToExIdxSection(const MCSymbol &FnStart) {
1095 SwitchToEHSection(".ARM.exidx",
1097 ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER,
1098 SectionKind::getDataRel(),
1101 void ARMELFStreamer::EmitFixup(const MCExpr *Expr, MCFixupKind Kind) {
1102 MCDataFragment *Frag = getOrCreateDataFragment();
1103 Frag->getFixups().push_back(MCFixup::create(Frag->getContents().size(), Expr,
1107 void ARMELFStreamer::Reset() {
1110 Personality = nullptr;
1111 PersonalityIndex = ARM::EHABI::NUM_PERSONALITY_INDEX;
1120 UnwindOpAsm.Reset();
1123 void ARMELFStreamer::emitFnStart() {
1124 assert(FnStart == nullptr);
1125 FnStart = getContext().createTempSymbol();
1129 void ARMELFStreamer::emitFnEnd() {
1130 assert(FnStart && ".fnstart must precedes .fnend");
1132 // Emit unwind opcodes if there is no .handlerdata directive
1133 if (!ExTab && !CantUnwind)
1134 FlushUnwindOpcodes(true);
1136 // Emit the exception index table entry
1137 SwitchToExIdxSection(*FnStart);
1139 if (PersonalityIndex < ARM::EHABI::NUM_PERSONALITY_INDEX)
1140 EmitPersonalityFixup(GetAEABIUnwindPersonalityName(PersonalityIndex));
1142 const MCSymbolRefExpr *FnStartRef =
1143 MCSymbolRefExpr::create(FnStart,
1144 MCSymbolRefExpr::VK_ARM_PREL31,
1147 EmitValue(FnStartRef, 4);
1150 EmitIntValue(ARM::EHABI::EXIDX_CANTUNWIND, 4);
1152 // Emit a reference to the unwind opcodes in the ".ARM.extab" section.
1153 const MCSymbolRefExpr *ExTabEntryRef =
1154 MCSymbolRefExpr::create(ExTab,
1155 MCSymbolRefExpr::VK_ARM_PREL31,
1157 EmitValue(ExTabEntryRef, 4);
1159 // For the __aeabi_unwind_cpp_pr0, we have to emit the unwind opcodes in
1160 // the second word of exception index table entry. The size of the unwind
1161 // opcodes should always be 4 bytes.
1162 assert(PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0 &&
1163 "Compact model must use __aeabi_unwind_cpp_pr0 as personality");
1164 assert(Opcodes.size() == 4u &&
1165 "Unwind opcode size for __aeabi_unwind_cpp_pr0 must be equal to 4");
1166 uint64_t Intval = Opcodes[0] |
1170 EmitIntValue(Intval, Opcodes.size());
1173 // Switch to the section containing FnStart
1174 SwitchSection(&FnStart->getSection());
1176 // Clean exception handling frame information
1180 void ARMELFStreamer::emitCantUnwind() { CantUnwind = true; }
1182 // Add the R_ARM_NONE fixup at the same position
1183 void ARMELFStreamer::EmitPersonalityFixup(StringRef Name) {
1184 const MCSymbol *PersonalitySym = getContext().getOrCreateSymbol(Name);
1186 const MCSymbolRefExpr *PersonalityRef = MCSymbolRefExpr::create(
1187 PersonalitySym, MCSymbolRefExpr::VK_ARM_NONE, getContext());
1189 visitUsedExpr(*PersonalityRef);
1190 MCDataFragment *DF = getOrCreateDataFragment();
1191 DF->getFixups().push_back(MCFixup::create(DF->getContents().size(),
1193 MCFixup::getKindForSize(4, false)));
1196 void ARMELFStreamer::FlushPendingOffset() {
1197 if (PendingOffset != 0) {
1198 UnwindOpAsm.EmitSPOffset(-PendingOffset);
1203 void ARMELFStreamer::FlushUnwindOpcodes(bool NoHandlerData) {
1204 // Emit the unwind opcode to restore $sp.
1206 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1207 int64_t LastRegSaveSPOffset = SPOffset - PendingOffset;
1208 UnwindOpAsm.EmitSPOffset(LastRegSaveSPOffset - FPOffset);
1209 UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1211 FlushPendingOffset();
1214 // Finalize the unwind opcode sequence
1215 UnwindOpAsm.Finalize(PersonalityIndex, Opcodes);
1217 // For compact model 0, we have to emit the unwind opcodes in the .ARM.exidx
1218 // section. Thus, we don't have to create an entry in the .ARM.extab
1220 if (NoHandlerData && PersonalityIndex == ARM::EHABI::AEABI_UNWIND_CPP_PR0)
1223 // Switch to .ARM.extab section.
1224 SwitchToExTabSection(*FnStart);
1226 // Create .ARM.extab label for offset in .ARM.exidx
1228 ExTab = getContext().createTempSymbol();
1233 const MCSymbolRefExpr *PersonalityRef =
1234 MCSymbolRefExpr::create(Personality,
1235 MCSymbolRefExpr::VK_ARM_PREL31,
1238 EmitValue(PersonalityRef, 4);
1241 // Emit unwind opcodes
1242 assert((Opcodes.size() % 4) == 0 &&
1243 "Unwind opcode size for __aeabi_cpp_unwind_pr0 must be multiple of 4");
1244 for (unsigned I = 0; I != Opcodes.size(); I += 4) {
1245 uint64_t Intval = Opcodes[I] |
1246 Opcodes[I + 1] << 8 |
1247 Opcodes[I + 2] << 16 |
1248 Opcodes[I + 3] << 24;
1249 EmitIntValue(Intval, 4);
1252 // According to ARM EHABI section 9.2, if the __aeabi_unwind_cpp_pr1() or
1253 // __aeabi_unwind_cpp_pr2() is used, then the handler data must be emitted
1254 // after the unwind opcodes. The handler data consists of several 32-bit
1255 // words, and should be terminated by zero.
1257 // In case that the .handlerdata directive is not specified by the
1258 // programmer, we should emit zero to terminate the handler data.
1259 if (NoHandlerData && !Personality)
1263 void ARMELFStreamer::emitHandlerData() { FlushUnwindOpcodes(false); }
1265 void ARMELFStreamer::emitPersonality(const MCSymbol *Per) {
1267 UnwindOpAsm.setPersonality(Per);
1270 void ARMELFStreamer::emitPersonalityIndex(unsigned Index) {
1271 assert(Index < ARM::EHABI::NUM_PERSONALITY_INDEX && "invalid index");
1272 PersonalityIndex = Index;
1275 void ARMELFStreamer::emitSetFP(unsigned NewFPReg, unsigned NewSPReg,
1277 assert((NewSPReg == ARM::SP || NewSPReg == FPReg) &&
1278 "the operand of .setfp directive should be either $sp or $fp");
1283 if (NewSPReg == ARM::SP)
1284 FPOffset = SPOffset + Offset;
1289 void ARMELFStreamer::emitMovSP(unsigned Reg, int64_t Offset) {
1290 assert((Reg != ARM::SP && Reg != ARM::PC) &&
1291 "the operand of .movsp cannot be either sp or pc");
1292 assert(FPReg == ARM::SP && "current FP must be SP");
1294 FlushPendingOffset();
1297 FPOffset = SPOffset + Offset;
1299 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1300 UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
1303 void ARMELFStreamer::emitPad(int64_t Offset) {
1304 // Track the change of the $sp offset
1307 // To squash multiple .pad directives, we should delay the unwind opcode
1308 // until the .save, .vsave, .handlerdata, or .fnend directives.
1309 PendingOffset -= Offset;
1312 void ARMELFStreamer::emitRegSave(const SmallVectorImpl<unsigned> &RegList,
1314 // Collect the registers in the register list
1317 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1318 for (size_t i = 0; i < RegList.size(); ++i) {
1319 unsigned Reg = MRI->getEncodingValue(RegList[i]);
1320 assert(Reg < (IsVector ? 32U : 16U) && "Register out of range");
1321 unsigned Bit = (1u << Reg);
1322 if ((Mask & Bit) == 0) {
1328 // Track the change the $sp offset: For the .save directive, the
1329 // corresponding push instruction will decrease the $sp by (4 * Count).
1330 // For the .vsave directive, the corresponding vpush instruction will
1331 // decrease $sp by (8 * Count).
1332 SPOffset -= Count * (IsVector ? 8 : 4);
1335 FlushPendingOffset();
1337 UnwindOpAsm.EmitVFPRegSave(Mask);
1339 UnwindOpAsm.EmitRegSave(Mask);
1342 void ARMELFStreamer::emitUnwindRaw(int64_t Offset,
1343 const SmallVectorImpl<uint8_t> &Opcodes) {
1344 FlushPendingOffset();
1345 SPOffset = SPOffset - Offset;
1346 UnwindOpAsm.EmitRaw(Opcodes);
1351 MCTargetStreamer *createARMTargetAsmStreamer(MCStreamer &S,
1352 formatted_raw_ostream &OS,
1353 MCInstPrinter *InstPrint,
1354 bool isVerboseAsm) {
1355 return new ARMTargetAsmStreamer(S, OS, *InstPrint, isVerboseAsm);
1358 MCTargetStreamer *createARMNullTargetStreamer(MCStreamer &S) {
1359 return new ARMTargetStreamer(S);
1362 MCTargetStreamer *createARMObjectTargetStreamer(MCStreamer &S,
1363 const MCSubtargetInfo &STI) {
1364 const Triple &TT = STI.getTargetTriple();
1365 if (TT.isOSBinFormatELF())
1366 return new ARMTargetELFStreamer(S);
1367 return new ARMTargetStreamer(S);
1370 MCELFStreamer *createARMELFStreamer(MCContext &Context, MCAsmBackend &TAB,
1371 raw_pwrite_stream &OS,
1372 MCCodeEmitter *Emitter, bool RelaxAll,
1374 ARMELFStreamer *S = new ARMELFStreamer(Context, TAB, OS, Emitter, IsThumb);
1375 // FIXME: This should eventually end up somewhere else where more
1376 // intelligent flag decisions can be made. For now we are just maintaining
1377 // the status quo for ARM and setting EF_ARM_EABI_VER5 as the default.
1378 S->getAssembler().setELFHeaderEFlags(ELF::EF_ARM_EABI_VER5);
1381 S->getAssembler().setRelaxAll(true);