1//===-- MipsBaseInfo.h - Top level definitions for MIPS MC ------*- 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 contains small standalone helper functions and enum definitions for
10// the Mips target useful for the compiler back-end and the MC libraries.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_LIB_TARGET_MIPS_MCTARGETDESC_MIPSBASEINFO_H
14#define LLVM_LIB_TARGET_MIPS_MCTARGETDESC_MIPSBASEINFO_H
15
16#include "MipsFixupKinds.h"
17#include "MipsMCTargetDesc.h"
18#include "llvm/MC/MCExpr.h"
19#include "llvm/MC/MCInstrDesc.h"
20#include "llvm/Support/DataTypes.h"
21#include "llvm/Support/ErrorHandling.h"
22
23namespace llvm {
24
25/// MipsII - This namespace holds all of the target specific flags that
26/// instruction info tracks.
27///
28namespace MipsII {
29  /// Target Operand Flag enum.
30  enum TOF {
31    //===------------------------------------------------------------------===//
32    // Mips Specific MachineOperand flags.
33
34    MO_NO_FLAG,
35
36    /// MO_GOT - Represents the offset into the global offset table at which
37    /// the address the relocation entry symbol resides during execution.
38    MO_GOT,
39
40    /// MO_GOT_CALL - Represents the offset into the global offset table at
41    /// which the address of a call site relocation entry symbol resides
42    /// during execution. This is different from the above since this flag
43    /// can only be present in call instructions.
44    MO_GOT_CALL,
45
46    /// MO_GPREL - Represents the offset from the current gp value to be used
47    /// for the relocatable object file being produced.
48    MO_GPREL,
49
50    /// MO_ABS_HI/LO - Represents the hi or low part of an absolute symbol
51    /// address.
52    MO_ABS_HI,
53    MO_ABS_LO,
54
55    /// MO_TLSGD - Represents the offset into the global offset table at which
56    // the module ID and TSL block offset reside during execution (General
57    // Dynamic TLS).
58    MO_TLSGD,
59
60    /// MO_TLSLDM - Represents the offset into the global offset table at which
61    // the module ID and TSL block offset reside during execution (Local
62    // Dynamic TLS).
63    MO_TLSLDM,
64    MO_DTPREL_HI,
65    MO_DTPREL_LO,
66
67    /// MO_GOTTPREL - Represents the offset from the thread pointer (Initial
68    // Exec TLS).
69    MO_GOTTPREL,
70
71    /// MO_TPREL_HI/LO - Represents the hi and low part of the offset from
72    // the thread pointer (Local Exec TLS).
73    MO_TPREL_HI,
74    MO_TPREL_LO,
75
76    // N32/64 Flags.
77    MO_GPOFF_HI,
78    MO_GPOFF_LO,
79    MO_GOT_DISP,
80    MO_GOT_PAGE,
81    MO_GOT_OFST,
82
83    /// MO_HIGHER/HIGHEST - Represents the highest or higher half word of a
84    /// 64-bit symbol address.
85    MO_HIGHER,
86    MO_HIGHEST,
87
88    /// MO_GOT_HI16/LO16, MO_CALL_HI16/LO16 - Relocations used for large GOTs.
89    MO_GOT_HI16,
90    MO_GOT_LO16,
91    MO_CALL_HI16,
92    MO_CALL_LO16,
93
94    /// Helper operand used to generate R_MIPS_JALR
95    MO_JALR
96  };
97
98  enum {
99    //===------------------------------------------------------------------===//
100    // Instruction encodings.  These are the standard/most common forms for
101    // Mips instructions.
102    //
103
104    // Pseudo - This represents an instruction that is a pseudo instruction
105    // or one that has not been implemented yet.  It is illegal to code generate
106    // it, but tolerated for intermediate implementation stages.
107    Pseudo   = 0,
108
109    /// FrmR - This form is for instructions of the format R.
110    FrmR  = 1,
111    /// FrmI - This form is for instructions of the format I.
112    FrmI  = 2,
113    /// FrmJ - This form is for instructions of the format J.
114    FrmJ  = 3,
115    /// FrmFR - This form is for instructions of the format FR.
116    FrmFR = 4,
117    /// FrmFI - This form is for instructions of the format FI.
118    FrmFI = 5,
119    /// FrmOther - This form is for instructions that have no specific format.
120    FrmOther = 6,
121
122    FormMask = 15,
123    /// IsCTI - Instruction is a Control Transfer Instruction.
124    IsCTI = 1 << 4,
125    /// HasForbiddenSlot - Instruction has a forbidden slot.
126    HasForbiddenSlot = 1 << 5,
127    /// HasFCCRegOperand - Instruction uses an $fcc<x> register.
128    HasFCCRegOperand = 1 << 6
129
130  };
131
132  enum OperandType : unsigned {
133    OPERAND_FIRST_MIPS_MEM_IMM = MCOI::OPERAND_FIRST_TARGET,
134    OPERAND_MEM_SIMM9 = OPERAND_FIRST_MIPS_MEM_IMM,
135    OPERAND_LAST_MIPS_MEM_IMM = OPERAND_MEM_SIMM9
136  };
137}
138}
139
140#endif
141