One more patch towards JIT support for Mips.
[oota-llvm.git] / lib / Target / Mips / MipsInstrInfo.h
1 //===- MipsInstrInfo.h - Mips Instruction Information -----------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the Mips implementation of the TargetInstrInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef MIPSINSTRUCTIONINFO_H
15 #define MIPSINSTRUCTIONINFO_H
16
17 #include "Mips.h"
18 #include "llvm/Support/ErrorHandling.h"
19 #include "llvm/Target/TargetInstrInfo.h"
20 #include "MipsRegisterInfo.h"
21
22 #define GET_INSTRINFO_HEADER
23 #include "MipsGenInstrInfo.inc"
24
25 namespace llvm {
26
27 namespace Mips {
28   /// GetOppositeBranchOpc - Return the inverse of the specified
29   /// opcode, e.g. turning BEQ to BNE.
30   unsigned GetOppositeBranchOpc(unsigned Opc);
31 }
32
33 /// MipsII - This namespace holds all of the target specific flags that
34 /// instruction info tracks.
35 ///
36 namespace MipsII {
37   /// Target Operand Flag enum.
38   enum TOF {
39     //===------------------------------------------------------------------===//
40     // Mips Specific MachineOperand flags.
41
42     MO_NO_FLAG,
43
44     /// MO_GOT - Represents the offset into the global offset table at which
45     /// the address the relocation entry symbol resides during execution.
46     MO_GOT,
47
48     /// MO_GOT_CALL - Represents the offset into the global offset table at
49     /// which the address of a call site relocation entry symbol resides
50     /// during execution. This is different from the above since this flag
51     /// can only be present in call instructions.
52     MO_GOT_CALL,
53
54     /// MO_GPREL - Represents the offset from the current gp value to be used
55     /// for the relocatable object file being produced.
56     MO_GPREL,
57
58     /// MO_ABS_HI/LO - Represents the hi or low part of an absolute symbol
59     /// address.
60     MO_ABS_HI,
61     MO_ABS_LO,
62
63     /// MO_TLSGD - Represents the offset into the global offset table at which
64     // the module ID and TSL block offset reside during execution (General
65     // Dynamic TLS).
66     MO_TLSGD,
67
68     /// MO_GOTTPREL - Represents the offset from the thread pointer (Initial
69     // Exec TLS).
70     MO_GOTTPREL,
71
72     /// MO_TPREL_HI/LO - Represents the hi and low part of the offset from
73     // the thread pointer (Local Exec TLS).
74     MO_TPREL_HI,
75     MO_TPREL_LO
76   };
77
78   enum {
79     //===------------------------------------------------------------------===//
80     // Instruction encodings.  These are the standard/most common forms for
81     // Mips instructions.
82     //
83
84     // Pseudo - This represents an instruction that is a pseudo instruction
85     // or one that has not been implemented yet.  It is illegal to code generate
86     // it, but tolerated for intermediate implementation stages.
87     Pseudo   = 0,
88
89     /// FrmR - This form is for instructions of the format R.
90     FrmR  = 1,
91     /// FrmI - This form is for instructions of the format I.
92     FrmI  = 2,
93     /// FrmJ - This form is for instructions of the format J.
94     FrmJ  = 3,
95     /// FrmFR - This form is for instructions of the format FR.
96     FrmFR = 4,
97     /// FrmFI - This form is for instructions of the format FI.
98     FrmFI = 5,
99     /// FrmOther - This form is for instructions that have no specific format.
100     FrmOther = 6,
101
102     FormMask = 15
103   };
104 }
105
106 class MipsInstrInfo : public MipsGenInstrInfo {
107   MipsTargetMachine &TM;
108   const MipsRegisterInfo RI;
109 public:
110   explicit MipsInstrInfo(MipsTargetMachine &TM);
111
112   /// getRegisterInfo - TargetInstrInfo is a superset of MRegister info.  As
113   /// such, whenever a client has an instance of instruction info, it should
114   /// always be able to get register info as well (through this method).
115   ///
116   virtual const MipsRegisterInfo &getRegisterInfo() const;
117
118   /// isLoadFromStackSlot - If the specified machine instruction is a direct
119   /// load from a stack slot, return the virtual or physical register number of
120   /// the destination along with the FrameIndex of the loaded stack slot.  If
121   /// not, return 0.  This predicate must return 0 if the instruction has
122   /// any side effects other than loading from the stack slot.
123   virtual unsigned isLoadFromStackSlot(const MachineInstr *MI,
124                                        int &FrameIndex) const;
125
126   /// isStoreToStackSlot - If the specified machine instruction is a direct
127   /// store to a stack slot, return the virtual or physical register number of
128   /// the source reg along with the FrameIndex of the loaded stack slot.  If
129   /// not, return 0.  This predicate must return 0 if the instruction has
130   /// any side effects other than storing to the stack slot.
131   virtual unsigned isStoreToStackSlot(const MachineInstr *MI,
132                                       int &FrameIndex) const;
133
134   /// Branch Analysis
135   virtual bool AnalyzeBranch(MachineBasicBlock &MBB, MachineBasicBlock *&TBB,
136                              MachineBasicBlock *&FBB,
137                              SmallVectorImpl<MachineOperand> &Cond,
138                              bool AllowModify) const;
139   virtual unsigned RemoveBranch(MachineBasicBlock &MBB) const;
140
141 private:
142   void BuildCondBr(MachineBasicBlock &MBB, MachineBasicBlock *TBB, DebugLoc DL,
143                    const SmallVectorImpl<MachineOperand>& Cond) const;
144
145 public:
146   virtual unsigned InsertBranch(MachineBasicBlock &MBB, MachineBasicBlock *TBB,
147                                 MachineBasicBlock *FBB,
148                                 const SmallVectorImpl<MachineOperand> &Cond,
149                                 DebugLoc DL) const;
150   virtual void copyPhysReg(MachineBasicBlock &MBB,
151                            MachineBasicBlock::iterator MI, DebugLoc DL,
152                            unsigned DestReg, unsigned SrcReg,
153                            bool KillSrc) const;
154   virtual void storeRegToStackSlot(MachineBasicBlock &MBB,
155                                    MachineBasicBlock::iterator MBBI,
156                                    unsigned SrcReg, bool isKill, int FrameIndex,
157                                    const TargetRegisterClass *RC,
158                                    const TargetRegisterInfo *TRI) const;
159
160   virtual void loadRegFromStackSlot(MachineBasicBlock &MBB,
161                                     MachineBasicBlock::iterator MBBI,
162                                     unsigned DestReg, int FrameIndex,
163                                     const TargetRegisterClass *RC,
164                                     const TargetRegisterInfo *TRI) const;
165
166   virtual MachineInstr* emitFrameIndexDebugValue(MachineFunction &MF,
167                                                  int FrameIx, uint64_t Offset,
168                                                  const MDNode *MDPtr,
169                                                  DebugLoc DL) const;
170
171   virtual
172   bool ReverseBranchCondition(SmallVectorImpl<MachineOperand> &Cond) const;
173
174   /// Insert nop instruction when hazard condition is found
175   virtual void insertNoop(MachineBasicBlock &MBB,
176                           MachineBasicBlock::iterator MI) const;
177
178   /// getGlobalBaseReg - Return a virtual register initialized with the
179   /// the global base register value. Output instructions required to
180   /// initialize the register in the function entry block, if necessary.
181   ///
182   unsigned getGlobalBaseReg(MachineFunction *MF) const;
183 };
184
185 }
186
187 #endif