Sort relocation entries before they are written out to a file. MIPS ABI
[oota-llvm.git] / lib / Target / Mips / MCTargetDesc / MipsBaseInfo.h
1 //===-- MipsBaseInfo.h - Top level definitions for MIPS MC ------*- 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 small standalone helper functions and enum definitions for
11 // the Mips target useful for the compiler back-end and the MC libraries.
12 //
13 //===----------------------------------------------------------------------===//
14 #ifndef MIPSBASEINFO_H
15 #define MIPSBASEINFO_H
16
17 #include "MipsFixupKinds.h"
18 #include "MipsMCTargetDesc.h"
19 #include "llvm/MC/MCExpr.h"
20 #include "llvm/Support/DataTypes.h"
21 #include "llvm/Support/ErrorHandling.h"
22
23 namespace llvm {
24
25 /// MipsII - This namespace holds all of the target specific flags that
26 /// instruction info tracks.
27 ///
28 namespace MipsII {
29   /// Target Operand Flag enum.
30   enum TOF {
31     //===------------------------------------------------------------------===//
32     // Mips Specific MachineOperand flags.
33
34     MO_NO_FLAG,
35
36     /// MO_GOT16 - Represents the offset into the global offset table at which
37     /// the address the relocation entry symbol resides during execution.
38     MO_GOT16,
39     MO_GOT,
40
41     /// MO_GOT_CALL - Represents the offset into the global offset table at
42     /// which the address of a call site relocation entry symbol resides
43     /// during execution. This is different from the above since this flag
44     /// can only be present in call instructions.
45     MO_GOT_CALL,
46
47     /// MO_GPREL - Represents the offset from the current gp value to be used
48     /// for the relocatable object file being produced.
49     MO_GPREL,
50
51     /// MO_ABS_HI/LO - Represents the hi or low part of an absolute symbol
52     /// address.
53     MO_ABS_HI,
54     MO_ABS_LO,
55
56     /// MO_TLSGD - Represents the offset into the global offset table at which
57     // the module ID and TSL block offset reside during execution (General
58     // Dynamic TLS).
59     MO_TLSGD,
60
61     /// MO_TLSLDM - Represents the offset into the global offset table at which
62     // the module ID and TSL block offset reside during execution (Local
63     // Dynamic TLS).
64     MO_TLSLDM,
65     MO_DTPREL_HI,
66     MO_DTPREL_LO,
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     // N32/64 Flags.
78     MO_GPOFF_HI,
79     MO_GPOFF_LO,
80     MO_GOT_DISP,
81     MO_GOT_PAGE,
82     MO_GOT_OFST
83   };
84
85   enum {
86     //===------------------------------------------------------------------===//
87     // Instruction encodings.  These are the standard/most common forms for
88     // Mips instructions.
89     //
90
91     // Pseudo - This represents an instruction that is a pseudo instruction
92     // or one that has not been implemented yet.  It is illegal to code generate
93     // it, but tolerated for intermediate implementation stages.
94     Pseudo   = 0,
95
96     /// FrmR - This form is for instructions of the format R.
97     FrmR  = 1,
98     /// FrmI - This form is for instructions of the format I.
99     FrmI  = 2,
100     /// FrmJ - This form is for instructions of the format J.
101     FrmJ  = 3,
102     /// FrmFR - This form is for instructions of the format FR.
103     FrmFR = 4,
104     /// FrmFI - This form is for instructions of the format FI.
105     FrmFI = 5,
106     /// FrmOther - This form is for instructions that have no specific format.
107     FrmOther = 6,
108
109     FormMask = 15
110   };
111 }
112
113
114 /// getMipsRegisterNumbering - Given the enum value for some register,
115 /// return the number that it corresponds to.
116 inline static unsigned getMipsRegisterNumbering(unsigned RegEnum)
117 {
118   switch (RegEnum) {
119   case Mips::ZERO: case Mips::ZERO_64: case Mips::F0: case Mips::D0_64:
120   case Mips::D0:
121     return 0;
122   case Mips::AT: case Mips::AT_64: case Mips::F1: case Mips::D1_64:
123     return 1;
124   case Mips::V0: case Mips::V0_64: case Mips::F2: case Mips::D2_64:
125   case Mips::D1:
126     return 2;
127   case Mips::V1: case Mips::V1_64: case Mips::F3: case Mips::D3_64:
128     return 3;
129   case Mips::A0: case Mips::A0_64: case Mips::F4: case Mips::D4_64:
130   case Mips::D2:
131     return 4;
132   case Mips::A1: case Mips::A1_64: case Mips::F5: case Mips::D5_64:
133     return 5;
134   case Mips::A2: case Mips::A2_64: case Mips::F6: case Mips::D6_64:
135   case Mips::D3:
136     return 6;
137   case Mips::A3: case Mips::A3_64: case Mips::F7: case Mips::D7_64:
138     return 7;
139   case Mips::T0: case Mips::T0_64: case Mips::F8: case Mips::D8_64:
140   case Mips::D4:
141     return 8;
142   case Mips::T1: case Mips::T1_64: case Mips::F9: case Mips::D9_64:
143     return 9;
144   case Mips::T2: case Mips::T2_64: case Mips::F10: case Mips::D10_64:
145   case Mips::D5:
146     return 10;
147   case Mips::T3: case Mips::T3_64: case Mips::F11: case Mips::D11_64:
148     return 11;
149   case Mips::T4: case Mips::T4_64: case Mips::F12: case Mips::D12_64:
150   case Mips::D6:
151     return 12;
152   case Mips::T5: case Mips::T5_64: case Mips::F13: case Mips::D13_64:
153     return 13;
154   case Mips::T6: case Mips::T6_64: case Mips::F14: case Mips::D14_64:
155   case Mips::D7:
156     return 14;
157   case Mips::T7: case Mips::T7_64: case Mips::F15: case Mips::D15_64:
158     return 15;
159   case Mips::S0: case Mips::S0_64: case Mips::F16: case Mips::D16_64:
160   case Mips::D8:
161     return 16;
162   case Mips::S1: case Mips::S1_64: case Mips::F17: case Mips::D17_64:
163     return 17;
164   case Mips::S2: case Mips::S2_64: case Mips::F18: case Mips::D18_64:
165   case Mips::D9:
166     return 18;
167   case Mips::S3: case Mips::S3_64: case Mips::F19: case Mips::D19_64:
168     return 19;
169   case Mips::S4: case Mips::S4_64: case Mips::F20: case Mips::D20_64:
170   case Mips::D10:
171     return 20;
172   case Mips::S5: case Mips::S5_64: case Mips::F21: case Mips::D21_64:
173     return 21;
174   case Mips::S6: case Mips::S6_64: case Mips::F22: case Mips::D22_64:
175   case Mips::D11:
176     return 22;
177   case Mips::S7: case Mips::S7_64: case Mips::F23: case Mips::D23_64:
178     return 23;
179   case Mips::T8: case Mips::T8_64: case Mips::F24: case Mips::D24_64:
180   case Mips::D12:
181     return 24;
182   case Mips::T9: case Mips::T9_64: case Mips::F25: case Mips::D25_64:
183     return 25;
184   case Mips::K0: case Mips::K0_64: case Mips::F26: case Mips::D26_64:
185   case Mips::D13:
186     return 26;
187   case Mips::K1: case Mips::K1_64: case Mips::F27: case Mips::D27_64:
188     return 27;
189   case Mips::GP: case Mips::GP_64: case Mips::F28: case Mips::D28_64:
190   case Mips::D14:
191     return 28;
192   case Mips::SP: case Mips::SP_64: case Mips::F29: case Mips::D29_64:
193   case Mips::HWR29:
194     return 29;
195   case Mips::FP: case Mips::FP_64: case Mips::F30: case Mips::D30_64:
196   case Mips::D15:
197     return 30;
198   case Mips::RA: case Mips::RA_64: case Mips::F31: case Mips::D31_64:
199     return 31;
200   default: llvm_unreachable("Unknown register number!");
201   }
202 }
203
204 inline static std::pair<const MCSymbolRefExpr*, int64_t>
205 MipsGetSymAndOffset(const MCFixup &Fixup) {
206   MCFixupKind FixupKind = Fixup.getKind();
207
208   if ((FixupKind < FirstTargetFixupKind) ||
209       (FixupKind >= MCFixupKind(Mips::LastTargetFixupKind)))
210     return std::make_pair((const MCSymbolRefExpr*)0, (int64_t)0);
211
212   const MCExpr *Expr = Fixup.getValue();
213   MCExpr::ExprKind Kind = Expr->getKind();
214
215   if (Kind == MCExpr::Binary) {
216     const MCBinaryExpr *BE = static_cast<const MCBinaryExpr*>(Expr);
217     const MCExpr *LHS = BE->getLHS();
218     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(BE->getRHS());
219
220     if ((LHS->getKind() != MCExpr::SymbolRef) || !CE)
221       return std::make_pair((const MCSymbolRefExpr*)0, (int64_t)0);
222
223     return std::make_pair(cast<MCSymbolRefExpr>(LHS), CE->getValue());
224   }
225
226   if (Kind != MCExpr::SymbolRef)
227     return std::make_pair((const MCSymbolRefExpr*)0, (int64_t)0);
228
229   return std::make_pair(cast<MCSymbolRefExpr>(Expr), 0);
230 }
231 }
232
233 #endif