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 "ARMUnwindOp.h"
18 #include "ARMUnwindOpAsm.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/MC/MCAsmBackend.h"
22 #include "llvm/MC/MCAssembler.h"
23 #include "llvm/MC/MCCodeEmitter.h"
24 #include "llvm/MC/MCContext.h"
25 #include "llvm/MC/MCELF.h"
26 #include "llvm/MC/MCELFStreamer.h"
27 #include "llvm/MC/MCELFSymbolFlags.h"
28 #include "llvm/MC/MCExpr.h"
29 #include "llvm/MC/MCInst.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/MCSymbol.h"
36 #include "llvm/MC/MCValue.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/ELF.h"
39 #include "llvm/Support/raw_ostream.h"
43 static std::string GetAEABIUnwindPersonalityName(unsigned Index) {
44 assert(Index < NUM_PERSONALITY_INDEX && "Invalid personality index");
45 return (Twine("__aeabi_unwind_cpp_pr") + Twine(Index)).str();
50 /// Extend the generic ELFStreamer class so that it can emit mapping symbols at
51 /// the appropriate points in the object files. These symbols are defined in the
52 /// ARM ELF ABI: infocenter.arm.com/help/topic/com.arm.../IHI0044D_aaelf.pdf.
54 /// In brief: $a, $t or $d should be emitted at the start of each contiguous
55 /// region of ARM code, Thumb code or data in a section. In practice, this
56 /// emission does not rely on explicit assembler directives but on inherent
57 /// properties of the directives doing the emission (e.g. ".byte" is data, "add
58 /// r0, r0, r0" an instruction).
60 /// As a result this system is orthogonal to the DataRegion infrastructure used
62 class ARMELFStreamer : public MCELFStreamer {
64 ARMELFStreamer(MCContext &Context, MCAsmBackend &TAB, raw_ostream &OS,
65 MCCodeEmitter *Emitter, bool IsThumb)
66 : MCELFStreamer(SK_ARMELFStreamer, Context, TAB, OS, Emitter),
67 IsThumb(IsThumb), MappingSymbolCounter(0), LastEMS(EMS_None) {
73 // ARM exception handling directives
74 virtual void EmitFnStart();
75 virtual void EmitFnEnd();
76 virtual void EmitCantUnwind();
77 virtual void EmitPersonality(const MCSymbol *Per);
78 virtual void EmitHandlerData();
79 virtual void EmitSetFP(unsigned NewFpReg,
82 virtual void EmitPad(int64_t Offset);
83 virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
86 virtual void ChangeSection(const MCSection *Section,
87 const MCExpr *Subsection) {
88 // We have to keep track of the mapping symbol state of any sections we
89 // use. Each one should start off as EMS_None, which is provided as the
90 // default constructor by DenseMap::lookup.
91 LastMappingSymbols[getPreviousSection().first] = LastEMS;
92 LastEMS = LastMappingSymbols.lookup(Section);
94 MCELFStreamer::ChangeSection(Section, Subsection);
97 /// This function is the one used to emit instruction data into the ELF
98 /// streamer. We override it to add the appropriate mapping symbol if
100 virtual void EmitInstruction(const MCInst& Inst) {
102 EmitThumbMappingSymbol();
104 EmitARMMappingSymbol();
106 MCELFStreamer::EmitInstruction(Inst);
109 /// This is one of the functions used to emit data into an ELF section, so the
110 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
112 virtual void EmitBytes(StringRef Data, unsigned AddrSpace) {
113 EmitDataMappingSymbol();
114 MCELFStreamer::EmitBytes(Data, AddrSpace);
117 /// This is one of the functions used to emit data into an ELF section, so the
118 /// ARM streamer overrides it to add the appropriate mapping symbol ($d) if
120 virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
121 unsigned AddrSpace) {
122 EmitDataMappingSymbol();
123 MCELFStreamer::EmitValueImpl(Value, Size, AddrSpace);
126 virtual void EmitAssemblerFlag(MCAssemblerFlag Flag) {
127 MCELFStreamer::EmitAssemblerFlag(Flag);
130 case MCAF_SyntaxUnified:
131 return; // no-op here.
134 return; // Change to Thumb mode
137 return; // Change to ARM mode
140 case MCAF_SubsectionsViaSymbols:
145 static bool classof(const MCStreamer *S) {
146 return S->getKind() == SK_ARMELFStreamer;
150 enum ElfMappingSymbol {
157 void EmitDataMappingSymbol() {
158 if (LastEMS == EMS_Data) return;
159 EmitMappingSymbol("$d");
163 void EmitThumbMappingSymbol() {
164 if (LastEMS == EMS_Thumb) return;
165 EmitMappingSymbol("$t");
169 void EmitARMMappingSymbol() {
170 if (LastEMS == EMS_ARM) return;
171 EmitMappingSymbol("$a");
175 void EmitMappingSymbol(StringRef Name) {
176 MCSymbol *Start = getContext().CreateTempSymbol();
180 getContext().GetOrCreateSymbol(Name + "." +
181 Twine(MappingSymbolCounter++));
183 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Symbol);
184 MCELF::SetType(SD, ELF::STT_NOTYPE);
185 MCELF::SetBinding(SD, ELF::STB_LOCAL);
186 SD.setExternal(false);
187 Symbol->setSection(*getCurrentSection().first);
189 const MCExpr *Value = MCSymbolRefExpr::Create(Start, getContext());
190 Symbol->setVariableValue(Value);
193 void EmitThumbFunc(MCSymbol *Func) {
194 // FIXME: Anything needed here to flag the function as thumb?
196 getAssembler().setIsThumbFunc(Func);
198 MCSymbolData &SD = getAssembler().getOrCreateSymbolData(*Func);
199 SD.setFlags(SD.getFlags() | ELF_Other_ThumbFunc);
202 // Helper functions for ARM exception handling directives
205 void EmitPersonalityFixup(StringRef Name);
206 void FlushPendingOffset();
207 void FlushUnwindOpcodes(bool NoHandlerData);
209 void SwitchToEHSection(const char *Prefix, unsigned Type, unsigned Flags,
210 SectionKind Kind, const MCSymbol &Fn);
211 void SwitchToExTabSection(const MCSymbol &FnStart);
212 void SwitchToExIdxSection(const MCSymbol &FnStart);
215 int64_t MappingSymbolCounter;
217 DenseMap<const MCSection *, ElfMappingSymbol> LastMappingSymbols;
218 ElfMappingSymbol LastEMS;
220 // ARM Exception Handling Frame Information
223 const MCSymbol *Personality;
224 unsigned PersonalityIndex;
225 unsigned FPReg; // Frame pointer register
226 int64_t FPOffset; // Offset: (final frame pointer) - (initial $sp)
227 int64_t SPOffset; // Offset: (final $sp) - (initial $sp)
228 int64_t PendingOffset; // Offset: (final $sp) - (emitted $sp)
231 SmallVector<uint8_t, 64> Opcodes;
232 UnwindOpcodeAssembler UnwindOpAsm;
234 } // end anonymous namespace
236 inline void ARMELFStreamer::SwitchToEHSection(const char *Prefix,
240 const MCSymbol &Fn) {
241 const MCSectionELF &FnSection =
242 static_cast<const MCSectionELF &>(Fn.getSection());
244 // Create the name for new section
245 StringRef FnSecName(FnSection.getSectionName());
246 SmallString<128> EHSecName(Prefix);
247 if (FnSecName != ".text") {
248 EHSecName += FnSecName;
251 // Get .ARM.extab or .ARM.exidx section
252 const MCSectionELF *EHSection = NULL;
253 if (const MCSymbol *Group = FnSection.getGroup()) {
254 EHSection = getContext().getELFSection(
255 EHSecName, Type, Flags | ELF::SHF_GROUP, Kind,
256 FnSection.getEntrySize(), Group->getName());
258 EHSection = getContext().getELFSection(EHSecName, Type, Flags, Kind);
260 assert(EHSection && "Failed to get the required EH section");
262 // Switch to .ARM.extab or .ARM.exidx section
263 SwitchSection(EHSection);
264 EmitCodeAlignment(4, 0);
267 inline void ARMELFStreamer::SwitchToExTabSection(const MCSymbol &FnStart) {
268 SwitchToEHSection(".ARM.extab",
271 SectionKind::getDataRel(),
275 inline void ARMELFStreamer::SwitchToExIdxSection(const MCSymbol &FnStart) {
276 SwitchToEHSection(".ARM.exidx",
278 ELF::SHF_ALLOC | ELF::SHF_LINK_ORDER,
279 SectionKind::getDataRel(),
283 void ARMELFStreamer::Reset() {
287 PersonalityIndex = NUM_PERSONALITY_INDEX;
299 // Add the R_ARM_NONE fixup at the same position
300 void ARMELFStreamer::EmitPersonalityFixup(StringRef Name) {
301 const MCSymbol *PersonalitySym = getContext().GetOrCreateSymbol(Name);
303 const MCSymbolRefExpr *PersonalityRef =
304 MCSymbolRefExpr::Create(PersonalitySym,
305 MCSymbolRefExpr::VK_ARM_NONE,
308 AddValueSymbols(PersonalityRef);
309 MCDataFragment *DF = getOrCreateDataFragment();
310 DF->getFixups().push_back(
311 MCFixup::Create(DF->getContents().size(), PersonalityRef,
312 MCFixup::getKindForSize(4, false)));
315 void ARMELFStreamer::EmitFnStart() {
316 assert(FnStart == 0);
317 FnStart = getContext().CreateTempSymbol();
321 void ARMELFStreamer::EmitFnEnd() {
322 assert(FnStart && ".fnstart must preceeds .fnend");
324 // Emit unwind opcodes if there is no .handlerdata directive
325 if (!ExTab && !CantUnwind)
326 FlushUnwindOpcodes(true);
328 // Emit the exception index table entry
329 SwitchToExIdxSection(*FnStart);
331 if (PersonalityIndex < NUM_PERSONALITY_INDEX)
332 EmitPersonalityFixup(GetAEABIUnwindPersonalityName(PersonalityIndex));
334 const MCSymbolRefExpr *FnStartRef =
335 MCSymbolRefExpr::Create(FnStart,
336 MCSymbolRefExpr::VK_ARM_PREL31,
339 EmitValue(FnStartRef, 4, 0);
342 EmitIntValue(EXIDX_CANTUNWIND, 4, 0);
344 // Emit a reference to the unwind opcodes in the ".ARM.extab" section.
345 const MCSymbolRefExpr *ExTabEntryRef =
346 MCSymbolRefExpr::Create(ExTab,
347 MCSymbolRefExpr::VK_ARM_PREL31,
349 EmitValue(ExTabEntryRef, 4, 0);
351 // For the __aeabi_unwind_cpp_pr0, we have to emit the unwind opcodes in
352 // the second word of exception index table entry. The size of the unwind
353 // opcodes should always be 4 bytes.
354 assert(PersonalityIndex == AEABI_UNWIND_CPP_PR0 &&
355 "Compact model must use __aeabi_cpp_unwind_pr0 as personality");
356 assert(Opcodes.size() == 4u &&
357 "Unwind opcode size for __aeabi_cpp_unwind_pr0 must be equal to 4");
358 EmitBytes(StringRef(reinterpret_cast<const char*>(Opcodes.data()),
362 // Switch to the section containing FnStart
363 SwitchSection(&FnStart->getSection());
365 // Clean exception handling frame information
369 void ARMELFStreamer::EmitCantUnwind() {
373 void ARMELFStreamer::FlushPendingOffset() {
374 if (PendingOffset != 0) {
375 UnwindOpAsm.EmitSPOffset(-PendingOffset);
380 void ARMELFStreamer::FlushUnwindOpcodes(bool NoHandlerData) {
381 // Emit the unwind opcode to restore $sp.
383 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
384 int64_t LastRegSaveSPOffset = SPOffset - PendingOffset;
385 UnwindOpAsm.EmitSPOffset(LastRegSaveSPOffset - FPOffset);
386 UnwindOpAsm.EmitSetSP(MRI->getEncodingValue(FPReg));
388 FlushPendingOffset();
391 // Finalize the unwind opcode sequence
392 UnwindOpAsm.Finalize(PersonalityIndex, Opcodes);
394 // For compact model 0, we have to emit the unwind opcodes in the .ARM.exidx
395 // section. Thus, we don't have to create an entry in the .ARM.extab
397 if (NoHandlerData && PersonalityIndex == AEABI_UNWIND_CPP_PR0)
400 // Switch to .ARM.extab section.
401 SwitchToExTabSection(*FnStart);
403 // Create .ARM.extab label for offset in .ARM.exidx
405 ExTab = getContext().CreateTempSymbol();
410 const MCSymbolRefExpr *PersonalityRef =
411 MCSymbolRefExpr::Create(Personality,
412 MCSymbolRefExpr::VK_ARM_PREL31,
415 EmitValue(PersonalityRef, 4, 0);
418 // Emit unwind opcodes
419 EmitBytes(StringRef(reinterpret_cast<const char *>(Opcodes.data()),
422 // According to ARM EHABI section 9.2, if the __aeabi_unwind_cpp_pr1() or
423 // __aeabi_unwind_cpp_pr2() is used, then the handler data must be emitted
424 // after the unwind opcodes. The handler data consists of several 32-bit
425 // words, and should be terminated by zero.
427 // In case that the .handlerdata directive is not specified by the
428 // programmer, we should emit zero to terminate the handler data.
429 if (NoHandlerData && !Personality)
433 void ARMELFStreamer::EmitHandlerData() {
434 FlushUnwindOpcodes(false);
437 void ARMELFStreamer::EmitPersonality(const MCSymbol *Per) {
439 UnwindOpAsm.setPersonality(Per);
442 void ARMELFStreamer::EmitSetFP(unsigned NewFPReg,
445 assert((NewSPReg == ARM::SP || NewSPReg == FPReg) &&
446 "the operand of .setfp directive should be either $sp or $fp");
451 if (NewSPReg == ARM::SP)
452 FPOffset = SPOffset + Offset;
457 void ARMELFStreamer::EmitPad(int64_t Offset) {
458 // Track the change of the $sp offset
461 // To squash multiple .pad directives, we should delay the unwind opcode
462 // until the .save, .vsave, .handlerdata, or .fnend directives.
463 PendingOffset -= Offset;
466 void ARMELFStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
468 // Collect the registers in the register list
471 const MCRegisterInfo *MRI = getContext().getRegisterInfo();
472 for (size_t i = 0; i < RegList.size(); ++i) {
473 unsigned Reg = MRI->getEncodingValue(RegList[i]);
474 assert(Reg < (IsVector ? 32U : 16U) && "Register out of range");
475 unsigned Bit = (1u << Reg);
476 if ((Mask & Bit) == 0) {
482 // Track the change the $sp offset: For the .save directive, the
483 // corresponding push instruction will decrease the $sp by (4 * Count).
484 // For the .vsave directive, the corresponding vpush instruction will
485 // decrease $sp by (8 * Count).
486 SPOffset -= Count * (IsVector ? 8 : 4);
489 FlushPendingOffset();
491 UnwindOpAsm.EmitVFPRegSave(Mask);
493 UnwindOpAsm.EmitRegSave(Mask);
497 MCELFStreamer* createARMELFStreamer(MCContext &Context, MCAsmBackend &TAB,
498 raw_ostream &OS, MCCodeEmitter *Emitter,
499 bool RelaxAll, bool NoExecStack,
501 ARMELFStreamer *S = new ARMELFStreamer(Context, TAB, OS, Emitter, IsThumb);
503 S->getAssembler().setRelaxAll(true);
505 S->getAssembler().setNoExecStack(true);