1 //===-- MipsTargetStreamer.h - Mips Target Streamer ------------*- C++ -*--===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_LIB_TARGET_MIPS_MIPSTARGETSTREAMER_H
10 #define LLVM_LIB_TARGET_MIPS_MIPSTARGETSTREAMER_H
12 #include "MCTargetDesc/MipsABIFlagsSection.h"
13 #include "MCTargetDesc/MipsABIInfo.h"
14 #include "llvm/ADT/Optional.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/MC/MCELFStreamer.h"
17 #include "llvm/MC/MCRegisterInfo.h"
18 #include "llvm/MC/MCStreamer.h"
22 struct MipsABIFlagsSection;
24 class MipsTargetStreamer : public MCTargetStreamer {
26 MipsTargetStreamer(MCStreamer &S);
28 virtual void setPic(bool Value) {}
30 virtual void emitDirectiveSetMicroMips();
31 virtual void emitDirectiveSetNoMicroMips();
32 virtual void setUsesMicroMips();
33 virtual void emitDirectiveSetMips16();
34 virtual void emitDirectiveSetNoMips16();
36 virtual void emitDirectiveSetReorder();
37 virtual void emitDirectiveSetNoReorder();
38 virtual void emitDirectiveSetMacro();
39 virtual void emitDirectiveSetNoMacro();
40 virtual void emitDirectiveSetMsa();
41 virtual void emitDirectiveSetNoMsa();
42 virtual void emitDirectiveSetMt();
43 virtual void emitDirectiveSetNoMt();
44 virtual void emitDirectiveSetCRC();
45 virtual void emitDirectiveSetNoCRC();
46 virtual void emitDirectiveSetVirt();
47 virtual void emitDirectiveSetNoVirt();
48 virtual void emitDirectiveSetGINV();
49 virtual void emitDirectiveSetNoGINV();
50 virtual void emitDirectiveSetAt();
51 virtual void emitDirectiveSetAtWithArg(unsigned RegNo);
52 virtual void emitDirectiveSetNoAt();
53 virtual void emitDirectiveEnd(StringRef Name);
55 virtual void emitDirectiveEnt(const MCSymbol &Symbol);
56 virtual void emitDirectiveAbiCalls();
57 virtual void emitDirectiveNaN2008();
58 virtual void emitDirectiveNaNLegacy();
59 virtual void emitDirectiveOptionPic0();
60 virtual void emitDirectiveOptionPic2();
61 virtual void emitDirectiveInsn();
62 virtual void emitFrame(unsigned StackReg, unsigned StackSize,
64 virtual void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff);
65 virtual void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff);
67 virtual void emitDirectiveSetArch(StringRef Arch);
68 virtual void emitDirectiveSetMips0();
69 virtual void emitDirectiveSetMips1();
70 virtual void emitDirectiveSetMips2();
71 virtual void emitDirectiveSetMips3();
72 virtual void emitDirectiveSetMips4();
73 virtual void emitDirectiveSetMips5();
74 virtual void emitDirectiveSetMips32();
75 virtual void emitDirectiveSetMips32R2();
76 virtual void emitDirectiveSetMips32R3();
77 virtual void emitDirectiveSetMips32R5();
78 virtual void emitDirectiveSetMips32R6();
79 virtual void emitDirectiveSetMips64();
80 virtual void emitDirectiveSetMips64R2();
81 virtual void emitDirectiveSetMips64R3();
82 virtual void emitDirectiveSetMips64R5();
83 virtual void emitDirectiveSetMips64R6();
84 virtual void emitDirectiveSetDsp();
85 virtual void emitDirectiveSetDspr2();
86 virtual void emitDirectiveSetNoDsp();
87 virtual void emitDirectiveSetPop();
88 virtual void emitDirectiveSetPush();
89 virtual void emitDirectiveSetSoftFloat();
90 virtual void emitDirectiveSetHardFloat();
93 virtual void emitDirectiveCpLoad(unsigned RegNo);
94 virtual void emitDirectiveCpLocal(unsigned RegNo);
95 virtual bool emitDirectiveCpRestore(int Offset,
96 function_ref<unsigned()> GetATReg,
97 SMLoc IDLoc, const MCSubtargetInfo *STI);
98 virtual void emitDirectiveCpsetup(unsigned RegNo, int RegOrOffset,
99 const MCSymbol &Sym, bool IsReg);
100 virtual void emitDirectiveCpreturn(unsigned SaveLocation,
101 bool SaveLocationIsRegister);
103 // FP abiflags directives
104 virtual void emitDirectiveModuleFP();
105 virtual void emitDirectiveModuleOddSPReg();
106 virtual void emitDirectiveModuleSoftFloat();
107 virtual void emitDirectiveModuleHardFloat();
108 virtual void emitDirectiveModuleMT();
109 virtual void emitDirectiveSetFp(MipsABIFlagsSection::FpABIKind Value);
110 virtual void emitDirectiveSetOddSPReg();
111 virtual void emitDirectiveSetNoOddSPReg();
112 virtual void emitDirectiveModuleCRC();
113 virtual void emitDirectiveModuleNoCRC();
114 virtual void emitDirectiveModuleVirt();
115 virtual void emitDirectiveModuleNoVirt();
116 virtual void emitDirectiveModuleGINV();
117 virtual void emitDirectiveModuleNoGINV();
119 void emitR(unsigned Opcode, unsigned Reg0, SMLoc IDLoc,
120 const MCSubtargetInfo *STI);
121 void emitII(unsigned Opcode, int16_t Imm1, int16_t Imm2, SMLoc IDLoc,
122 const MCSubtargetInfo *STI);
123 void emitRX(unsigned Opcode, unsigned Reg0, MCOperand Op1, SMLoc IDLoc,
124 const MCSubtargetInfo *STI);
125 void emitRI(unsigned Opcode, unsigned Reg0, int32_t Imm, SMLoc IDLoc,
126 const MCSubtargetInfo *STI);
127 void emitRR(unsigned Opcode, unsigned Reg0, unsigned Reg1, SMLoc IDLoc,
128 const MCSubtargetInfo *STI);
129 void emitRRX(unsigned Opcode, unsigned Reg0, unsigned Reg1, MCOperand Op2,
130 SMLoc IDLoc, const MCSubtargetInfo *STI);
131 void emitRRR(unsigned Opcode, unsigned Reg0, unsigned Reg1, unsigned Reg2,
132 SMLoc IDLoc, const MCSubtargetInfo *STI);
133 void emitRRRX(unsigned Opcode, unsigned Reg0, unsigned Reg1, unsigned Reg2,
134 MCOperand Op3, SMLoc IDLoc, const MCSubtargetInfo *STI);
135 void emitRRI(unsigned Opcode, unsigned Reg0, unsigned Reg1, int16_t Imm,
136 SMLoc IDLoc, const MCSubtargetInfo *STI);
137 void emitRRIII(unsigned Opcode, unsigned Reg0, unsigned Reg1, int16_t Imm0,
138 int16_t Imm1, int16_t Imm2, SMLoc IDLoc,
139 const MCSubtargetInfo *STI);
140 void emitAddu(unsigned DstReg, unsigned SrcReg, unsigned TrgReg, bool Is64Bit,
141 const MCSubtargetInfo *STI);
142 void emitDSLL(unsigned DstReg, unsigned SrcReg, int16_t ShiftAmount,
143 SMLoc IDLoc, const MCSubtargetInfo *STI);
144 void emitEmptyDelaySlot(bool hasShortDelaySlot, SMLoc IDLoc,
145 const MCSubtargetInfo *STI);
146 void emitNop(SMLoc IDLoc, const MCSubtargetInfo *STI);
148 /// Emit a store instruction with an offset. If the offset is out of range
149 /// then it will be synthesized using the assembler temporary.
151 /// GetATReg() is a callback that can be used to obtain the current assembler
152 /// temporary and is only called when the assembler temporary is required. It
153 /// must handle the case where no assembler temporary is available (typically
154 /// by reporting an error).
155 void emitStoreWithImmOffset(unsigned Opcode, unsigned SrcReg,
156 unsigned BaseReg, int64_t Offset,
157 function_ref<unsigned()> GetATReg, SMLoc IDLoc,
158 const MCSubtargetInfo *STI);
159 void emitLoadWithImmOffset(unsigned Opcode, unsigned DstReg, unsigned BaseReg,
160 int64_t Offset, unsigned TmpReg, SMLoc IDLoc,
161 const MCSubtargetInfo *STI);
162 void emitGPRestore(int Offset, SMLoc IDLoc, const MCSubtargetInfo *STI);
164 void forbidModuleDirective() { ModuleDirectiveAllowed = false; }
165 void reallowModuleDirective() { ModuleDirectiveAllowed = true; }
166 bool isModuleDirectiveAllowed() { return ModuleDirectiveAllowed; }
168 // This method enables template classes to set internal abi flags
170 template <class PredicateLibrary>
171 void updateABIInfo(const PredicateLibrary &P) {
173 ABIFlagsSection.setAllFromPredicates(P);
176 MipsABIFlagsSection &getABIFlagsSection() { return ABIFlagsSection; }
177 const MipsABIInfo &getABI() const {
178 assert(ABI.hasValue() && "ABI hasn't been set!");
183 llvm::Optional<MipsABIInfo> ABI;
184 MipsABIFlagsSection ABIFlagsSection;
201 bool ModuleDirectiveAllowed;
204 // This part is for ascii assembly output
205 class MipsTargetAsmStreamer : public MipsTargetStreamer {
206 formatted_raw_ostream &OS;
209 MipsTargetAsmStreamer(MCStreamer &S, formatted_raw_ostream &OS);
210 void emitDirectiveSetMicroMips() override;
211 void emitDirectiveSetNoMicroMips() override;
212 void emitDirectiveSetMips16() override;
213 void emitDirectiveSetNoMips16() override;
215 void emitDirectiveSetReorder() override;
216 void emitDirectiveSetNoReorder() override;
217 void emitDirectiveSetMacro() override;
218 void emitDirectiveSetNoMacro() override;
219 void emitDirectiveSetMsa() override;
220 void emitDirectiveSetNoMsa() override;
221 void emitDirectiveSetMt() override;
222 void emitDirectiveSetNoMt() override;
223 void emitDirectiveSetCRC() override;
224 void emitDirectiveSetNoCRC() override;
225 void emitDirectiveSetVirt() override;
226 void emitDirectiveSetNoVirt() override;
227 void emitDirectiveSetGINV() override;
228 void emitDirectiveSetNoGINV() override;
229 void emitDirectiveSetAt() override;
230 void emitDirectiveSetAtWithArg(unsigned RegNo) override;
231 void emitDirectiveSetNoAt() override;
232 void emitDirectiveEnd(StringRef Name) override;
234 void emitDirectiveEnt(const MCSymbol &Symbol) override;
235 void emitDirectiveAbiCalls() override;
236 void emitDirectiveNaN2008() override;
237 void emitDirectiveNaNLegacy() override;
238 void emitDirectiveOptionPic0() override;
239 void emitDirectiveOptionPic2() override;
240 void emitDirectiveInsn() override;
241 void emitFrame(unsigned StackReg, unsigned StackSize,
242 unsigned ReturnReg) override;
243 void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff) override;
244 void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff) override;
246 void emitDirectiveSetArch(StringRef Arch) override;
247 void emitDirectiveSetMips0() override;
248 void emitDirectiveSetMips1() override;
249 void emitDirectiveSetMips2() override;
250 void emitDirectiveSetMips3() override;
251 void emitDirectiveSetMips4() override;
252 void emitDirectiveSetMips5() override;
253 void emitDirectiveSetMips32() override;
254 void emitDirectiveSetMips32R2() override;
255 void emitDirectiveSetMips32R3() override;
256 void emitDirectiveSetMips32R5() override;
257 void emitDirectiveSetMips32R6() override;
258 void emitDirectiveSetMips64() override;
259 void emitDirectiveSetMips64R2() override;
260 void emitDirectiveSetMips64R3() override;
261 void emitDirectiveSetMips64R5() override;
262 void emitDirectiveSetMips64R6() override;
263 void emitDirectiveSetDsp() override;
264 void emitDirectiveSetDspr2() override;
265 void emitDirectiveSetNoDsp() override;
266 void emitDirectiveSetPop() override;
267 void emitDirectiveSetPush() override;
268 void emitDirectiveSetSoftFloat() override;
269 void emitDirectiveSetHardFloat() override;
272 void emitDirectiveCpLoad(unsigned RegNo) override;
273 void emitDirectiveCpLocal(unsigned RegNo) override;
275 /// Emit a .cprestore directive. If the offset is out of range then it will
276 /// be synthesized using the assembler temporary.
278 /// GetATReg() is a callback that can be used to obtain the current assembler
279 /// temporary and is only called when the assembler temporary is required. It
280 /// must handle the case where no assembler temporary is available (typically
281 /// by reporting an error).
282 bool emitDirectiveCpRestore(int Offset, function_ref<unsigned()> GetATReg,
283 SMLoc IDLoc, const MCSubtargetInfo *STI) override;
284 void emitDirectiveCpsetup(unsigned RegNo, int RegOrOffset,
285 const MCSymbol &Sym, bool IsReg) override;
286 void emitDirectiveCpreturn(unsigned SaveLocation,
287 bool SaveLocationIsRegister) override;
289 // FP abiflags directives
290 void emitDirectiveModuleFP() override;
291 void emitDirectiveModuleOddSPReg() override;
292 void emitDirectiveModuleSoftFloat() override;
293 void emitDirectiveModuleHardFloat() override;
294 void emitDirectiveModuleMT() override;
295 void emitDirectiveModuleCRC() override;
296 void emitDirectiveModuleNoCRC() override;
297 void emitDirectiveModuleVirt() override;
298 void emitDirectiveModuleNoVirt() override;
299 void emitDirectiveModuleGINV() override;
300 void emitDirectiveModuleNoGINV() override;
301 void emitDirectiveSetFp(MipsABIFlagsSection::FpABIKind Value) override;
302 void emitDirectiveSetOddSPReg() override;
303 void emitDirectiveSetNoOddSPReg() override;
306 // This part is for ELF object output
307 class MipsTargetELFStreamer : public MipsTargetStreamer {
308 bool MicroMipsEnabled;
309 const MCSubtargetInfo &STI;
313 bool isMicroMipsEnabled() const { return MicroMipsEnabled; }
314 MCELFStreamer &getStreamer();
315 MipsTargetELFStreamer(MCStreamer &S, const MCSubtargetInfo &STI);
317 void setPic(bool Value) override { Pic = Value; }
319 void emitLabel(MCSymbol *Symbol) override;
320 void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
321 void finish() override;
323 void emitDirectiveSetMicroMips() override;
324 void emitDirectiveSetNoMicroMips() override;
325 void setUsesMicroMips() override;
326 void emitDirectiveSetMips16() override;
328 void emitDirectiveSetNoReorder() override;
329 void emitDirectiveEnd(StringRef Name) override;
331 void emitDirectiveEnt(const MCSymbol &Symbol) override;
332 void emitDirectiveAbiCalls() override;
333 void emitDirectiveNaN2008() override;
334 void emitDirectiveNaNLegacy() override;
335 void emitDirectiveOptionPic0() override;
336 void emitDirectiveOptionPic2() override;
337 void emitDirectiveInsn() override;
338 void emitFrame(unsigned StackReg, unsigned StackSize,
339 unsigned ReturnReg) override;
340 void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff) override;
341 void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff) override;
344 void emitDirectiveCpLoad(unsigned RegNo) override;
345 void emitDirectiveCpLocal(unsigned RegNo) override;
346 bool emitDirectiveCpRestore(int Offset, function_ref<unsigned()> GetATReg,
347 SMLoc IDLoc, const MCSubtargetInfo *STI) override;
348 void emitDirectiveCpsetup(unsigned RegNo, int RegOrOffset,
349 const MCSymbol &Sym, bool IsReg) override;
350 void emitDirectiveCpreturn(unsigned SaveLocation,
351 bool SaveLocationIsRegister) override;
353 void emitMipsAbiFlags();