1 //===-- MipsTargetStreamer.h - Mips 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_MIPS_MIPSTARGETSTREAMER_H 10 #define LLVM_LIB_TARGET_MIPS_MIPSTARGETSTREAMER_H 11 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" 19 20 namespace llvm { 21 22 struct MipsABIFlagsSection; 23 24 class MipsTargetStreamer : public MCTargetStreamer { 25 public: 26 MipsTargetStreamer(MCStreamer &S); 27 28 virtual void setPic(bool Value) {} 29 30 virtual void emitDirectiveSetMicroMips(); 31 virtual void emitDirectiveSetNoMicroMips(); 32 virtual void setUsesMicroMips(); 33 virtual void emitDirectiveSetMips16(); 34 virtual void emitDirectiveSetNoMips16(); 35 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); 54 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, 63 unsigned ReturnReg); 64 virtual void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff); 65 virtual void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff); 66 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(); 91 92 // PIC support 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); 102 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(); 118 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); 147 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. 150 /// 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 emitSCWithSymOffset(unsigned Opcode, unsigned SrcReg, unsigned BaseReg, 160 MCOperand &HiOperand, MCOperand &LoOperand, 161 unsigned ATReg, SMLoc IDLoc, 162 const MCSubtargetInfo *STI); 163 void emitLoadWithImmOffset(unsigned Opcode, unsigned DstReg, unsigned BaseReg, 164 int64_t Offset, unsigned TmpReg, SMLoc IDLoc, 165 const MCSubtargetInfo *STI); 166 void emitGPRestore(int Offset, SMLoc IDLoc, const MCSubtargetInfo *STI); 167 168 void forbidModuleDirective() { ModuleDirectiveAllowed = false; } 169 void reallowModuleDirective() { ModuleDirectiveAllowed = true; } 170 bool isModuleDirectiveAllowed() { return ModuleDirectiveAllowed; } 171 172 // This method enables template classes to set internal abi flags 173 // structure values. 174 template <class PredicateLibrary> 175 void updateABIInfo(const PredicateLibrary &P) { 176 ABI = P.getABI(); 177 ABIFlagsSection.setAllFromPredicates(P); 178 } 179 180 MipsABIFlagsSection &getABIFlagsSection() { return ABIFlagsSection; } 181 const MipsABIInfo &getABI() const { 182 assert(ABI.hasValue() && "ABI hasn't been set!"); 183 return *ABI; 184 } 185 186 protected: 187 llvm::Optional<MipsABIInfo> ABI; 188 MipsABIFlagsSection ABIFlagsSection; 189 190 bool GPRInfoSet; 191 unsigned GPRBitMask; 192 int GPROffset; 193 194 bool FPRInfoSet; 195 unsigned FPRBitMask; 196 int FPROffset; 197 198 bool FrameInfoSet; 199 int FrameOffset; 200 unsigned FrameReg; 201 unsigned GPReg; 202 unsigned ReturnReg; 203 204 private: 205 bool ModuleDirectiveAllowed; 206 }; 207 208 // This part is for ascii assembly output 209 class MipsTargetAsmStreamer : public MipsTargetStreamer { 210 formatted_raw_ostream &OS; 211 212 public: 213 MipsTargetAsmStreamer(MCStreamer &S, formatted_raw_ostream &OS); 214 void emitDirectiveSetMicroMips() override; 215 void emitDirectiveSetNoMicroMips() override; 216 void emitDirectiveSetMips16() override; 217 void emitDirectiveSetNoMips16() override; 218 219 void emitDirectiveSetReorder() override; 220 void emitDirectiveSetNoReorder() override; 221 void emitDirectiveSetMacro() override; 222 void emitDirectiveSetNoMacro() override; 223 void emitDirectiveSetMsa() override; 224 void emitDirectiveSetNoMsa() override; 225 void emitDirectiveSetMt() override; 226 void emitDirectiveSetNoMt() override; 227 void emitDirectiveSetCRC() override; 228 void emitDirectiveSetNoCRC() override; 229 void emitDirectiveSetVirt() override; 230 void emitDirectiveSetNoVirt() override; 231 void emitDirectiveSetGINV() override; 232 void emitDirectiveSetNoGINV() override; 233 void emitDirectiveSetAt() override; 234 void emitDirectiveSetAtWithArg(unsigned RegNo) override; 235 void emitDirectiveSetNoAt() override; 236 void emitDirectiveEnd(StringRef Name) override; 237 238 void emitDirectiveEnt(const MCSymbol &Symbol) override; 239 void emitDirectiveAbiCalls() override; 240 void emitDirectiveNaN2008() override; 241 void emitDirectiveNaNLegacy() override; 242 void emitDirectiveOptionPic0() override; 243 void emitDirectiveOptionPic2() override; 244 void emitDirectiveInsn() override; 245 void emitFrame(unsigned StackReg, unsigned StackSize, 246 unsigned ReturnReg) override; 247 void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff) override; 248 void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff) override; 249 250 void emitDirectiveSetArch(StringRef Arch) override; 251 void emitDirectiveSetMips0() override; 252 void emitDirectiveSetMips1() override; 253 void emitDirectiveSetMips2() override; 254 void emitDirectiveSetMips3() override; 255 void emitDirectiveSetMips4() override; 256 void emitDirectiveSetMips5() override; 257 void emitDirectiveSetMips32() override; 258 void emitDirectiveSetMips32R2() override; 259 void emitDirectiveSetMips32R3() override; 260 void emitDirectiveSetMips32R5() override; 261 void emitDirectiveSetMips32R6() override; 262 void emitDirectiveSetMips64() override; 263 void emitDirectiveSetMips64R2() override; 264 void emitDirectiveSetMips64R3() override; 265 void emitDirectiveSetMips64R5() override; 266 void emitDirectiveSetMips64R6() override; 267 void emitDirectiveSetDsp() override; 268 void emitDirectiveSetDspr2() override; 269 void emitDirectiveSetNoDsp() override; 270 void emitDirectiveSetPop() override; 271 void emitDirectiveSetPush() override; 272 void emitDirectiveSetSoftFloat() override; 273 void emitDirectiveSetHardFloat() override; 274 275 // PIC support 276 void emitDirectiveCpLoad(unsigned RegNo) override; 277 void emitDirectiveCpLocal(unsigned RegNo) override; 278 279 /// Emit a .cprestore directive. If the offset is out of range then it will 280 /// be synthesized using the assembler temporary. 281 /// 282 /// GetATReg() is a callback that can be used to obtain the current assembler 283 /// temporary and is only called when the assembler temporary is required. It 284 /// must handle the case where no assembler temporary is available (typically 285 /// by reporting an error). 286 bool emitDirectiveCpRestore(int Offset, function_ref<unsigned()> GetATReg, 287 SMLoc IDLoc, const MCSubtargetInfo *STI) override; 288 void emitDirectiveCpsetup(unsigned RegNo, int RegOrOffset, 289 const MCSymbol &Sym, bool IsReg) override; 290 void emitDirectiveCpreturn(unsigned SaveLocation, 291 bool SaveLocationIsRegister) override; 292 293 // FP abiflags directives 294 void emitDirectiveModuleFP() override; 295 void emitDirectiveModuleOddSPReg() override; 296 void emitDirectiveModuleSoftFloat() override; 297 void emitDirectiveModuleHardFloat() override; 298 void emitDirectiveModuleMT() override; 299 void emitDirectiveModuleCRC() override; 300 void emitDirectiveModuleNoCRC() override; 301 void emitDirectiveModuleVirt() override; 302 void emitDirectiveModuleNoVirt() override; 303 void emitDirectiveModuleGINV() override; 304 void emitDirectiveModuleNoGINV() override; 305 void emitDirectiveSetFp(MipsABIFlagsSection::FpABIKind Value) override; 306 void emitDirectiveSetOddSPReg() override; 307 void emitDirectiveSetNoOddSPReg() override; 308 }; 309 310 // This part is for ELF object output 311 class MipsTargetELFStreamer : public MipsTargetStreamer { 312 bool MicroMipsEnabled; 313 const MCSubtargetInfo &STI; 314 bool Pic; 315 316 public: 317 bool isMicroMipsEnabled() const { return MicroMipsEnabled; } 318 MCELFStreamer &getStreamer(); 319 MipsTargetELFStreamer(MCStreamer &S, const MCSubtargetInfo &STI); 320 321 void setPic(bool Value) override { Pic = Value; } 322 323 void emitLabel(MCSymbol *Symbol) override; 324 void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override; 325 void finish() override; 326 327 void emitDirectiveSetMicroMips() override; 328 void emitDirectiveSetNoMicroMips() override; 329 void setUsesMicroMips() override; 330 void emitDirectiveSetMips16() override; 331 332 void emitDirectiveSetNoReorder() override; 333 void emitDirectiveEnd(StringRef Name) override; 334 335 void emitDirectiveEnt(const MCSymbol &Symbol) override; 336 void emitDirectiveAbiCalls() override; 337 void emitDirectiveNaN2008() override; 338 void emitDirectiveNaNLegacy() override; 339 void emitDirectiveOptionPic0() override; 340 void emitDirectiveOptionPic2() override; 341 void emitDirectiveInsn() override; 342 void emitFrame(unsigned StackReg, unsigned StackSize, 343 unsigned ReturnReg) override; 344 void emitMask(unsigned CPUBitmask, int CPUTopSavedRegOff) override; 345 void emitFMask(unsigned FPUBitmask, int FPUTopSavedRegOff) override; 346 347 // PIC support 348 void emitDirectiveCpLoad(unsigned RegNo) override; 349 void emitDirectiveCpLocal(unsigned RegNo) override; 350 bool emitDirectiveCpRestore(int Offset, function_ref<unsigned()> GetATReg, 351 SMLoc IDLoc, const MCSubtargetInfo *STI) override; 352 void emitDirectiveCpsetup(unsigned RegNo, int RegOrOffset, 353 const MCSymbol &Sym, bool IsReg) override; 354 void emitDirectiveCpreturn(unsigned SaveLocation, 355 bool SaveLocationIsRegister) override; 356 357 void emitMipsAbiFlags(); 358 }; 359 } 360 #endif 361