xref: /freebsd/contrib/llvm-project/llvm/lib/Target/AArch64/MCTargetDesc/AArch64TargetStreamer.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
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 "llvm/MC/MCStreamer.h"
13 
14 namespace {
15 class AArch64ELFStreamer;
16 }
17 
18 namespace llvm {
19 
20 class AArch64TargetStreamer : public MCTargetStreamer {
21 public:
22   AArch64TargetStreamer(MCStreamer &S);
23   ~AArch64TargetStreamer() override;
24 
25   void finish() override;
26   void emitConstantPools() override;
27 
28   /// Callback used to implement the ldr= pseudo.
29   /// Add a new entry to the constant pool for the current section and return an
30   /// MCExpr that can be used to refer to the constant pool location.
31   const MCExpr *addConstantPoolEntry(const MCExpr *, unsigned Size, SMLoc Loc);
32 
33   /// Callback used to implement the .ltorg directive.
34   /// Emit contents of constant pool for the current section.
35   void emitCurrentConstantPool();
36 
37   /// Callback used to implement the .note.gnu.property section.
38   void emitNoteSection(unsigned Flags, uint64_t PAuthABIPlatform = -1,
39                        uint64_t PAuthABIVersion = -1);
40 
41   /// Callback used to implement the .inst directive.
42   virtual void emitInst(uint32_t Inst);
43 
44   /// Callback used to implement the .variant_pcs directive.
emitDirectiveVariantPCS(MCSymbol * Symbol)45   virtual void emitDirectiveVariantPCS(MCSymbol *Symbol) {};
46 
emitARM64WinCFIAllocStack(unsigned Size)47   virtual void emitARM64WinCFIAllocStack(unsigned Size) {}
emitARM64WinCFISaveR19R20X(int Offset)48   virtual void emitARM64WinCFISaveR19R20X(int Offset) {}
emitARM64WinCFISaveFPLR(int Offset)49   virtual void emitARM64WinCFISaveFPLR(int Offset) {}
emitARM64WinCFISaveFPLRX(int Offset)50   virtual void emitARM64WinCFISaveFPLRX(int Offset) {}
emitARM64WinCFISaveReg(unsigned Reg,int Offset)51   virtual void emitARM64WinCFISaveReg(unsigned Reg, int Offset) {}
emitARM64WinCFISaveRegX(unsigned Reg,int Offset)52   virtual void emitARM64WinCFISaveRegX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveRegP(unsigned Reg,int Offset)53   virtual void emitARM64WinCFISaveRegP(unsigned Reg, int Offset) {}
emitARM64WinCFISaveRegPX(unsigned Reg,int Offset)54   virtual void emitARM64WinCFISaveRegPX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveLRPair(unsigned Reg,int Offset)55   virtual void emitARM64WinCFISaveLRPair(unsigned Reg, int Offset) {}
emitARM64WinCFISaveFReg(unsigned Reg,int Offset)56   virtual void emitARM64WinCFISaveFReg(unsigned Reg, int Offset) {}
emitARM64WinCFISaveFRegX(unsigned Reg,int Offset)57   virtual void emitARM64WinCFISaveFRegX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveFRegP(unsigned Reg,int Offset)58   virtual void emitARM64WinCFISaveFRegP(unsigned Reg, int Offset) {}
emitARM64WinCFISaveFRegPX(unsigned Reg,int Offset)59   virtual void emitARM64WinCFISaveFRegPX(unsigned Reg, int Offset) {}
emitARM64WinCFISetFP()60   virtual void emitARM64WinCFISetFP() {}
emitARM64WinCFIAddFP(unsigned Size)61   virtual void emitARM64WinCFIAddFP(unsigned Size) {}
emitARM64WinCFINop()62   virtual void emitARM64WinCFINop() {}
emitARM64WinCFISaveNext()63   virtual void emitARM64WinCFISaveNext() {}
emitARM64WinCFIPrologEnd()64   virtual void emitARM64WinCFIPrologEnd() {}
emitARM64WinCFIEpilogStart()65   virtual void emitARM64WinCFIEpilogStart() {}
emitARM64WinCFIEpilogEnd()66   virtual void emitARM64WinCFIEpilogEnd() {}
emitARM64WinCFITrapFrame()67   virtual void emitARM64WinCFITrapFrame() {}
emitARM64WinCFIMachineFrame()68   virtual void emitARM64WinCFIMachineFrame() {}
emitARM64WinCFIContext()69   virtual void emitARM64WinCFIContext() {}
emitARM64WinCFIECContext()70   virtual void emitARM64WinCFIECContext() {}
emitARM64WinCFIClearUnwoundToCall()71   virtual void emitARM64WinCFIClearUnwoundToCall() {}
emitARM64WinCFIPACSignLR()72   virtual void emitARM64WinCFIPACSignLR() {}
emitARM64WinCFISaveAnyRegI(unsigned Reg,int Offset)73   virtual void emitARM64WinCFISaveAnyRegI(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegIP(unsigned Reg,int Offset)74   virtual void emitARM64WinCFISaveAnyRegIP(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegD(unsigned Reg,int Offset)75   virtual void emitARM64WinCFISaveAnyRegD(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegDP(unsigned Reg,int Offset)76   virtual void emitARM64WinCFISaveAnyRegDP(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegQ(unsigned Reg,int Offset)77   virtual void emitARM64WinCFISaveAnyRegQ(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegQP(unsigned Reg,int Offset)78   virtual void emitARM64WinCFISaveAnyRegQP(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegIX(unsigned Reg,int Offset)79   virtual void emitARM64WinCFISaveAnyRegIX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegIPX(unsigned Reg,int Offset)80   virtual void emitARM64WinCFISaveAnyRegIPX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegDX(unsigned Reg,int Offset)81   virtual void emitARM64WinCFISaveAnyRegDX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegDPX(unsigned Reg,int Offset)82   virtual void emitARM64WinCFISaveAnyRegDPX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegQX(unsigned Reg,int Offset)83   virtual void emitARM64WinCFISaveAnyRegQX(unsigned Reg, int Offset) {}
emitARM64WinCFISaveAnyRegQPX(unsigned Reg,int Offset)84   virtual void emitARM64WinCFISaveAnyRegQPX(unsigned Reg, int Offset) {}
85 
86 private:
87   std::unique_ptr<AssemblerConstantPools> ConstantPools;
88 };
89 
90 class AArch64TargetELFStreamer : public AArch64TargetStreamer {
91 private:
92   AArch64ELFStreamer &getStreamer();
93 
94   void emitInst(uint32_t Inst) override;
95   void emitDirectiveVariantPCS(MCSymbol *Symbol) override;
96   void finish() override;
97 
98 public:
AArch64TargetELFStreamer(MCStreamer & S)99   AArch64TargetELFStreamer(MCStreamer &S) : AArch64TargetStreamer(S) {}
100 };
101 
102 class AArch64TargetWinCOFFStreamer : public llvm::AArch64TargetStreamer {
103 private:
104   // True if we are processing SEH directives in an epilogue.
105   bool InEpilogCFI = false;
106 
107   // Symbol of the current epilog for which we are processing SEH directives.
108   MCSymbol *CurrentEpilog = nullptr;
109 public:
AArch64TargetWinCOFFStreamer(llvm::MCStreamer & S)110   AArch64TargetWinCOFFStreamer(llvm::MCStreamer &S)
111     : AArch64TargetStreamer(S) {}
112 
113   // The unwind codes on ARM64 Windows are documented at
114   // https://docs.microsoft.com/en-us/cpp/build/arm64-exception-handling
115   void emitARM64WinCFIAllocStack(unsigned Size) override;
116   void emitARM64WinCFISaveR19R20X(int Offset) override;
117   void emitARM64WinCFISaveFPLR(int Offset) override;
118   void emitARM64WinCFISaveFPLRX(int Offset) override;
119   void emitARM64WinCFISaveReg(unsigned Reg, int Offset) override;
120   void emitARM64WinCFISaveRegX(unsigned Reg, int Offset) override;
121   void emitARM64WinCFISaveRegP(unsigned Reg, int Offset) override;
122   void emitARM64WinCFISaveRegPX(unsigned Reg, int Offset) override;
123   void emitARM64WinCFISaveLRPair(unsigned Reg, int Offset) override;
124   void emitARM64WinCFISaveFReg(unsigned Reg, int Offset) override;
125   void emitARM64WinCFISaveFRegX(unsigned Reg, int Offset) override;
126   void emitARM64WinCFISaveFRegP(unsigned Reg, int Offset) override;
127   void emitARM64WinCFISaveFRegPX(unsigned Reg, int Offset) override;
128   void emitARM64WinCFISetFP() override;
129   void emitARM64WinCFIAddFP(unsigned Size) override;
130   void emitARM64WinCFINop() override;
131   void emitARM64WinCFISaveNext() override;
132   void emitARM64WinCFIPrologEnd() override;
133   void emitARM64WinCFIEpilogStart() override;
134   void emitARM64WinCFIEpilogEnd() override;
135   void emitARM64WinCFITrapFrame() override;
136   void emitARM64WinCFIMachineFrame() override;
137   void emitARM64WinCFIContext() override;
138   void emitARM64WinCFIECContext() override;
139   void emitARM64WinCFIClearUnwoundToCall() override;
140   void emitARM64WinCFIPACSignLR() override;
141   void emitARM64WinCFISaveAnyRegI(unsigned Reg, int Offset) override;
142   void emitARM64WinCFISaveAnyRegIP(unsigned Reg, int Offset) override;
143   void emitARM64WinCFISaveAnyRegD(unsigned Reg, int Offset) override;
144   void emitARM64WinCFISaveAnyRegDP(unsigned Reg, int Offset) override;
145   void emitARM64WinCFISaveAnyRegQ(unsigned Reg, int Offset) override;
146   void emitARM64WinCFISaveAnyRegQP(unsigned Reg, int Offset) override;
147   void emitARM64WinCFISaveAnyRegIX(unsigned Reg, int Offset) override;
148   void emitARM64WinCFISaveAnyRegIPX(unsigned Reg, int Offset) override;
149   void emitARM64WinCFISaveAnyRegDX(unsigned Reg, int Offset) override;
150   void emitARM64WinCFISaveAnyRegDPX(unsigned Reg, int Offset) override;
151   void emitARM64WinCFISaveAnyRegQX(unsigned Reg, int Offset) override;
152   void emitARM64WinCFISaveAnyRegQPX(unsigned Reg, int Offset) override;
153 
154 private:
155   void emitARM64WinUnwindCode(unsigned UnwindCode, int Reg, int Offset);
156 };
157 
158 MCTargetStreamer *
159 createAArch64ObjectTargetStreamer(MCStreamer &S, const MCSubtargetInfo &STI);
160 
161 MCTargetStreamer *createAArch64NullTargetStreamer(MCStreamer &S);
162 
163 } // end namespace llvm
164 
165 #endif
166