1//===-- MipsMCTargetDesc.h - Mips Target Descriptions -----------*- 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// This file provides Mips specific target descriptions.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_MIPS_MCTARGETDESC_MIPSMCTARGETDESC_H
14#define LLVM_LIB_TARGET_MIPS_MCTARGETDESC_MIPSMCTARGETDESC_H
15
16#include "llvm/MC/MCRegister.h"
17#include "llvm/Support/DataTypes.h"
18
19#include <memory>
20
21namespace llvm {
22class MCAsmBackend;
23class MCCodeEmitter;
24class MCContext;
25class MCInstrInfo;
26class MCObjectTargetWriter;
27class MCObjectWriter;
28class MCRegister;
29class MCRegisterInfo;
30class MCStreamer;
31class MCSubtargetInfo;
32class MCTargetOptions;
33class StringRef;
34class Target;
35class Triple;
36
37MCCodeEmitter *createMipsMCCodeEmitterEB(const MCInstrInfo &MCII,
38 MCContext &Ctx);
39MCCodeEmitter *createMipsMCCodeEmitterEL(const MCInstrInfo &MCII,
40 MCContext &Ctx);
41
42MCAsmBackend *createMipsAsmBackend(const Target &T, const MCSubtargetInfo &STI,
43 const MCRegisterInfo &MRI,
44 const MCTargetOptions &Options);
45
46/// Construct an MIPS Windows COFF machine code streamer which will generate
47/// PE/COFF format object files.
48///
49/// Takes ownership of \p AB and \p CE.
50MCStreamer *createMipsWinCOFFStreamer(MCContext &C,
51 std::unique_ptr<MCAsmBackend> &&AB,
52 std::unique_ptr<MCObjectWriter> &&OW,
53 std::unique_ptr<MCCodeEmitter> &&CE);
54
55/// Construct a Mips ELF object writer.
56std::unique_ptr<MCObjectTargetWriter>
57createMipsELFObjectWriter(const Triple &TT, bool IsN32);
58/// Construct a Mips Win COFF object writer.
59std::unique_ptr<MCObjectTargetWriter> createMipsWinCOFFObjectWriter();
60
61namespace MIPS_MC {
62void initLLVMToCVRegMapping(MCRegisterInfo *MRI);
63
64/// COP0 hardware encodings reserve five bits each for REG and SEL.
65constexpr unsigned encodeCOP0Register(unsigned Reg, unsigned Sel) {
66 return (Reg << 5) | Sel;
67}
68constexpr unsigned getCOP0RegNum(unsigned Encoding) { return Encoding >> 5; }
69constexpr unsigned getCOP0Sel(unsigned Encoding) { return Encoding & 31; }
70MCRegister getCOP0Register(const MCRegisterInfo &MRI, unsigned Encoding);
71
72StringRef selectMipsCPU(const Triple &TT, StringRef CPU);
73
74/// Match a symbolic name in RegClassID, or return an invalid register.
75MCRegister matchRegisterName(StringRef Name, const MCRegisterInfo &MRI,
76 unsigned RegClassID, unsigned AltIdx);
77
78/// Return a GPR name's hardware index, or -1 if unknown.
79int getCPURegisterIndex(StringRef Name, const MCRegisterInfo &MRI,
80 unsigned AltIdx, bool *IsDeprecated = nullptr);
81}
82
83} // End llvm namespace
84
85// Defines symbolic names for Mips registers. This defines a mapping from
86// register name to register number.
87#define GET_REGINFO_ENUM
88#include "MipsGenRegisterInfo.inc"
89
90namespace llvm {
91namespace Mips {
92// Readable names for the GPRs with a dedicated role. Other GPRs use their R<n>
93// names, or the MipsABIInfo accessors when their role depends on the ABI.
94inline constexpr MCPhysReg GP = R28;
95inline constexpr MCPhysReg SP = R29;
96inline constexpr MCPhysReg FP = R30;
97inline constexpr MCPhysReg RA = R31;
98inline constexpr MCPhysReg GP_64 = R28_64;
99inline constexpr MCPhysReg SP_64 = R29_64;
100inline constexpr MCPhysReg FP_64 = R30_64;
101inline constexpr MCPhysReg RA_64 = R31_64;
102} // namespace Mips
103} // namespace llvm
104
105// Defines symbolic names for the Mips instructions.
106#define GET_INSTRINFO_ENUM
107#define GET_INSTRINFO_MC_HELPER_DECLS
108#include "MipsGenInstrInfo.inc"
109
110#define GET_SUBTARGETINFO_ENUM
111#include "MipsGenSubtargetInfo.inc"
112
113#endif
114