1//===-- AArch64TargetStreamer.h - AArch64 Target Streamer ------*- C++ -*--===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_LIB_TARGET_AARCH64_MCTARGETDESC_AARCH64TARGETSTREAMER_H
10#define LLVM_LIB_TARGET_AARCH64_MCTARGETDESC_AARCH64TARGETSTREAMER_H
11
12#include "AArch64MCAsmInfo.h"
13#include "AArch64MCOptions.h"
14#include "llvm/ADT/StringRef.h"
15#include "llvm/IR/Instructions.h"
16#include "llvm/MC/MCELFStreamer.h"
17#include "llvm/MC/MCStreamer.h"
18#include "llvm/Support/AArch64BuildAttributes.h"
19#include <cstdint>
20
21namespace {
22class AArch64ELFStreamer;
23}
24
25namespace llvm {
26
27class AArch64TargetStreamer : public MCTargetStreamer {
28 const AArch64MCOptions &CLOpts;
29
30public:
31 AArch64TargetStreamer(MCStreamer &S);
32 ~AArch64TargetStreamer() override;
33
34 void finish() override;
35 void emitConstantPools() override;
36
37 /// Callback used to implement the ldr= pseudo.
38 /// Add a new entry to the constant pool for the current section and return an
39 /// MCExpr that can be used to refer to the constant pool location.
40 const MCExpr *addConstantPoolEntry(const MCExpr *, unsigned Size, SMLoc Loc);
41
42 /// Callback used to implement the .ltorg directive.
43 /// Emit contents of constant pool for the current section.
44 void emitCurrentConstantPool();
45
46 /// Callback used to implement the .note.gnu.property section.
47 void emitNoteSection(unsigned Flags, uint64_t PAuthABIPlatform = -1,
48 uint64_t PAuthABIVersion = -1);
49
50 /// Callback used to emit AUTH expressions (e.g. signed
51 /// personality function pointer).
52 void emitAuthValue(const MCExpr *Expr, uint16_t Discriminator,
53 AArch64PACKey::ID Key, bool HasAddressDiversity);
54
55 /// Callback used to implement the .inst directive.
56 virtual void emitInst(uint32_t Inst);
57
58 /// Callback used to implement the .variant_pcs directive.
59 virtual void emitDirectiveVariantPCS(MCSymbol *Symbol) {};
60
61 virtual void emitDirectiveArch(StringRef Name) {};
62 virtual void emitDirectiveArchExtension(StringRef Name) {};
63
64 virtual void emitARM64WinCFIAllocStack(unsigned Size) {}
65 virtual void emitARM64WinCFISaveR19R20X(int Offset) {}
66 virtual void emitARM64WinCFISaveFPLR(int Offset) {}
67 virtual void emitARM64WinCFISaveFPLRX(int Offset) {}
68 virtual void emitARM64WinCFISaveReg(unsigned Reg, int Offset) {}
69 virtual void emitARM64WinCFISaveRegX(unsigned Reg, int Offset) {}
70 virtual void emitARM64WinCFISaveRegP(unsigned Reg, int Offset) {}
71 virtual void emitARM64WinCFISaveRegPX(unsigned Reg, int Offset) {}
72 virtual void emitARM64WinCFISaveLRPair(unsigned Reg, int Offset) {}
73 virtual void emitARM64WinCFISaveFReg(unsigned Reg, int Offset) {}
74 virtual void emitARM64WinCFISaveFRegX(unsigned Reg, int Offset) {}
75 virtual void emitARM64WinCFISaveFRegP(unsigned Reg, int Offset) {}
76 virtual void emitARM64WinCFISaveFRegPX(unsigned Reg, int Offset) {}
77 virtual void emitARM64WinCFISetFP() {}
78 virtual void emitARM64WinCFIAddFP(unsigned Size) {}
79 virtual void emitARM64WinCFINop() {}
80 virtual void emitARM64WinCFISaveNext() {}
81 virtual void emitARM64WinCFIPrologEnd() {}
82 virtual void emitARM64WinCFIEndC() {}
83 virtual void emitARM64WinCFIEpilogStart() {}
84 virtual void emitARM64WinCFIEpilogEnd() {}
85 virtual void emitARM64WinCFITrapFrame() {}
86 virtual void emitARM64WinCFIMachineFrame() {}
87 virtual void emitARM64WinCFIContext() {}
88 virtual void emitARM64WinCFIECContext() {}
89 virtual void emitARM64WinCFIClearUnwoundToCall() {}
90 virtual void emitARM64WinCFIPACSignLR() {}
91 virtual void emitARM64WinCFISaveAnyRegI(unsigned Reg, int Offset) {}
92 virtual void emitARM64WinCFISaveAnyRegIP(unsigned Reg, int Offset) {}
93 virtual void emitARM64WinCFISaveAnyRegD(unsigned Reg, int Offset) {}
94 virtual void emitARM64WinCFISaveAnyRegDP(unsigned Reg, int Offset) {}
95 virtual void emitARM64WinCFISaveAnyRegQ(unsigned Reg, int Offset) {}
96 virtual void emitARM64WinCFISaveAnyRegQP(unsigned Reg, int Offset) {}
97 virtual void emitARM64WinCFISaveAnyRegIX(unsigned Reg, int Offset) {}
98 virtual void emitARM64WinCFISaveAnyRegIPX(unsigned Reg, int Offset) {}
99 virtual void emitARM64WinCFISaveAnyRegDX(unsigned Reg, int Offset) {}
100 virtual void emitARM64WinCFISaveAnyRegDPX(unsigned Reg, int Offset) {}
101 virtual void emitARM64WinCFISaveAnyRegQX(unsigned Reg, int Offset) {}
102 virtual void emitARM64WinCFISaveAnyRegQPX(unsigned Reg, int Offset) {}
103 virtual void emitARM64WinCFIAllocZ(int Offset) {}
104 virtual void emitARM64WinCFISaveZReg(unsigned Reg, int Offset) {}
105 virtual void emitARM64WinCFISavePReg(unsigned Reg, int Offset) {}
106
107 /// Build attributes implementation
108 virtual void
109 emitAttributesSubsection(StringRef VendorName,
110 AArch64BuildAttributes::SubsectionOptional IsOptional,
111 AArch64BuildAttributes::SubsectionType ParameterType);
112 virtual void emitAttribute(StringRef VendorName, unsigned Tag, unsigned Value,
113 std::string String);
114 void activateAttributesSubsection(StringRef VendorName);
115 std::unique_ptr<MCELFStreamer::AttributeSubSection>
116 getActiveAttributesSubsection();
117 std::unique_ptr<MCELFStreamer::AttributeSubSection>
118 getAttributesSubsectionByName(StringRef Name);
119
120 SmallVector<MCELFStreamer::AttributeSubSection, 64> AttributeSubSections;
121
122private:
123 std::unique_ptr<AssemblerConstantPools> ConstantPools;
124};
125
126class AArch64TargetELFStreamer : public AArch64TargetStreamer {
127private:
128 AArch64ELFStreamer &getStreamer();
129
130 MCSection *AttributeSection = nullptr;
131
132 /// Build attributes implementation
133 void emitAttributesSubsection(
134 StringRef VendorName,
135 AArch64BuildAttributes::SubsectionOptional IsOptional,
136 AArch64BuildAttributes::SubsectionType ParameterType) override;
137 void emitAttribute(StringRef VendorName, unsigned Tag, unsigned Value,
138 std::string String) override;
139 void emitInst(uint32_t Inst) override;
140 void emitDirectiveVariantPCS(MCSymbol *Symbol) override;
141 void finish() override;
142
143public:
144 AArch64TargetELFStreamer(MCStreamer &S) : AArch64TargetStreamer(S) {}
145};
146
147class AArch64TargetWinCOFFStreamer : public llvm::AArch64TargetStreamer {
148public:
149 AArch64TargetWinCOFFStreamer(llvm::MCStreamer &S)
150 : AArch64TargetStreamer(S) {}
151
152 // The unwind codes on ARM64 Windows are documented at
153 // https://docs.microsoft.com/en-us/cpp/build/arm64-exception-handling
154 void emitARM64WinCFIAllocStack(unsigned Size) override;
155 void emitARM64WinCFISaveR19R20X(int Offset) override;
156 void emitARM64WinCFISaveFPLR(int Offset) override;
157 void emitARM64WinCFISaveFPLRX(int Offset) override;
158 void emitARM64WinCFISaveReg(unsigned Reg, int Offset) override;
159 void emitARM64WinCFISaveRegX(unsigned Reg, int Offset) override;
160 void emitARM64WinCFISaveRegP(unsigned Reg, int Offset) override;
161 void emitARM64WinCFISaveRegPX(unsigned Reg, int Offset) override;
162 void emitARM64WinCFISaveLRPair(unsigned Reg, int Offset) override;
163 void emitARM64WinCFISaveFReg(unsigned Reg, int Offset) override;
164 void emitARM64WinCFISaveFRegX(unsigned Reg, int Offset) override;
165 void emitARM64WinCFISaveFRegP(unsigned Reg, int Offset) override;
166 void emitARM64WinCFISaveFRegPX(unsigned Reg, int Offset) override;
167 void emitARM64WinCFISetFP() override;
168 void emitARM64WinCFIAddFP(unsigned Size) override;
169 void emitARM64WinCFINop() override;
170 void emitARM64WinCFISaveNext() override;
171 void emitARM64WinCFIPrologEnd() override;
172 void emitARM64WinCFIEndC() override;
173 void emitARM64WinCFIEpilogStart() override;
174 void emitARM64WinCFIEpilogEnd() override;
175 void emitARM64WinCFITrapFrame() override;
176 void emitARM64WinCFIMachineFrame() override;
177 void emitARM64WinCFIContext() override;
178 void emitARM64WinCFIECContext() override;
179 void emitARM64WinCFIClearUnwoundToCall() override;
180 void emitARM64WinCFIPACSignLR() override;
181 void emitARM64WinCFISaveAnyRegI(unsigned Reg, int Offset) override;
182 void emitARM64WinCFISaveAnyRegIP(unsigned Reg, int Offset) override;
183 void emitARM64WinCFISaveAnyRegD(unsigned Reg, int Offset) override;
184 void emitARM64WinCFISaveAnyRegDP(unsigned Reg, int Offset) override;
185 void emitARM64WinCFISaveAnyRegQ(unsigned Reg, int Offset) override;
186 void emitARM64WinCFISaveAnyRegQP(unsigned Reg, int Offset) override;
187 void emitARM64WinCFISaveAnyRegIX(unsigned Reg, int Offset) override;
188 void emitARM64WinCFISaveAnyRegIPX(unsigned Reg, int Offset) override;
189 void emitARM64WinCFISaveAnyRegDX(unsigned Reg, int Offset) override;
190 void emitARM64WinCFISaveAnyRegDPX(unsigned Reg, int Offset) override;
191 void emitARM64WinCFISaveAnyRegQX(unsigned Reg, int Offset) override;
192 void emitARM64WinCFISaveAnyRegQPX(unsigned Reg, int Offset) override;
193 void emitARM64WinCFIAllocZ(int Offset) override;
194 void emitARM64WinCFISaveZReg(unsigned Reg, int Offset) override;
195 void emitARM64WinCFISavePReg(unsigned Reg, int Offset) override;
196
197private:
198 void emitARM64WinUnwindCode(unsigned UnwindCode, int Reg, int Offset);
199};
200
201MCTargetStreamer *
202createAArch64ObjectTargetStreamer(MCStreamer &S, const MCSubtargetInfo &STI);
203
204MCTargetStreamer *createAArch64NullTargetStreamer(MCStreamer &S);
205
206} // end namespace llvm
207
208#endif
209