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