LLVM  9.0.0svn
ARMBaseInfo.h
Go to the documentation of this file.
1 //===-- ARMBaseInfo.h - Top level definitions for ARM -------- --*- 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 ARM target useful for the compiler back-end and the MC libraries.
11 // As such, it deliberately does not include references to LLVM core
12 // code gen types, passes, etc..
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_LIB_TARGET_ARM_MCTARGETDESC_ARMBASEINFO_H
17 #define LLVM_LIB_TARGET_ARM_MCTARGETDESC_ARMBASEINFO_H
18 
19 #include "ARMMCTargetDesc.h"
21 #include "Utils/ARMBaseInfo.h"
22 
23 namespace llvm {
24 
25 namespace ARM_PROC {
26  enum IMod {
27  IE = 2,
28  ID = 3
29  };
30 
31  enum IFlags {
32  F = 1,
33  I = 2,
34  A = 4
35  };
36 
37  inline static const char *IFlagsToString(unsigned val) {
38  switch (val) {
39  default: llvm_unreachable("Unknown iflags operand");
40  case F: return "f";
41  case I: return "i";
42  case A: return "a";
43  }
44  }
45 
46  inline static const char *IModToString(unsigned val) {
47  switch (val) {
48  default: llvm_unreachable("Unknown imod operand");
49  case IE: return "ie";
50  case ID: return "id";
51  }
52  }
53 }
54 
55 namespace ARM_MB {
56  // The Memory Barrier Option constants map directly to the 4-bit encoding of
57  // the option field for memory barrier operations.
58  enum MemBOpt {
60  OSHLD = 1,
61  OSHST = 2,
62  OSH = 3,
64  NSHLD = 5,
65  NSHST = 6,
66  NSH = 7,
68  ISHLD = 9,
69  ISHST = 10,
70  ISH = 11,
72  LD = 13,
73  ST = 14,
74  SY = 15
75  };
76 
77  inline static const char *MemBOptToString(unsigned val, bool HasV8) {
78  switch (val) {
79  default: llvm_unreachable("Unknown memory operation");
80  case SY: return "sy";
81  case ST: return "st";
82  case LD: return HasV8 ? "ld" : "#0xd";
83  case RESERVED_12: return "#0xc";
84  case ISH: return "ish";
85  case ISHST: return "ishst";
86  case ISHLD: return HasV8 ? "ishld" : "#0x9";
87  case RESERVED_8: return "#0x8";
88  case NSH: return "nsh";
89  case NSHST: return "nshst";
90  case NSHLD: return HasV8 ? "nshld" : "#0x5";
91  case RESERVED_4: return "#0x4";
92  case OSH: return "osh";
93  case OSHST: return "oshst";
94  case OSHLD: return HasV8 ? "oshld" : "#0x1";
95  case RESERVED_0: return "#0x0";
96  }
97  }
98 } // namespace ARM_MB
99 
100 namespace ARM_TSB {
102  CSYNC = 0
103  };
104 
105  inline static const char *TraceSyncBOptToString(unsigned val) {
106  switch (val) {
107  default:
108  llvm_unreachable("Unknown trace synchronization barrier operation");
109  case CSYNC: return "csync";
110  }
111  }
112 } // namespace ARM_TSB
113 
114 namespace ARM_ISB {
131  SY = 15
132  };
133 
134  inline static const char *InstSyncBOptToString(unsigned val) {
135  switch (val) {
136  default:
137  llvm_unreachable("Unknown memory operation");
138  case RESERVED_0: return "#0x0";
139  case RESERVED_1: return "#0x1";
140  case RESERVED_2: return "#0x2";
141  case RESERVED_3: return "#0x3";
142  case RESERVED_4: return "#0x4";
143  case RESERVED_5: return "#0x5";
144  case RESERVED_6: return "#0x6";
145  case RESERVED_7: return "#0x7";
146  case RESERVED_8: return "#0x8";
147  case RESERVED_9: return "#0x9";
148  case RESERVED_10: return "#0xa";
149  case RESERVED_11: return "#0xb";
150  case RESERVED_12: return "#0xc";
151  case RESERVED_13: return "#0xd";
152  case RESERVED_14: return "#0xe";
153  case SY: return "sy";
154  }
155  }
156 } // namespace ARM_ISB
157 
158 /// isARMLowRegister - Returns true if the register is a low register (r0-r7).
159 ///
160 static inline bool isARMLowRegister(unsigned Reg) {
161  using namespace ARM;
162  switch (Reg) {
163  case R0: case R1: case R2: case R3:
164  case R4: case R5: case R6: case R7:
165  return true;
166  default:
167  return false;
168  }
169 }
170 
171 /// ARMII - This namespace holds all of the target specific flags that
172 /// instruction info tracks.
173 ///
174 namespace ARMII {
175 
176  /// ARM Index Modes
177  enum IndexMode {
182  };
183 
184  /// ARM Addressing Modes
185  enum AddrMode {
196  AddrModeT1_s = 10, // i8 * 4 for pc and sp relative data
200  AddrModeT2_pc = 14, // +/- i12 for pc relative data
201  AddrModeT2_i8s4 = 15, // i8 * 4
203  AddrMode5FP16 = 17, // i8 * 2
204  AddrModeT2_ldrex = 18, // i8 * 4, with unscaled offset in MCInst
205  };
206 
207  inline static const char *AddrModeToString(AddrMode addrmode) {
208  switch (addrmode) {
209  case AddrModeNone: return "AddrModeNone";
210  case AddrMode1: return "AddrMode1";
211  case AddrMode2: return "AddrMode2";
212  case AddrMode3: return "AddrMode3";
213  case AddrMode4: return "AddrMode4";
214  case AddrMode5: return "AddrMode5";
215  case AddrMode5FP16: return "AddrMode5FP16";
216  case AddrMode6: return "AddrMode6";
217  case AddrModeT1_1: return "AddrModeT1_1";
218  case AddrModeT1_2: return "AddrModeT1_2";
219  case AddrModeT1_4: return "AddrModeT1_4";
220  case AddrModeT1_s: return "AddrModeT1_s";
221  case AddrModeT2_i12: return "AddrModeT2_i12";
222  case AddrModeT2_i8: return "AddrModeT2_i8";
223  case AddrModeT2_so: return "AddrModeT2_so";
224  case AddrModeT2_pc: return "AddrModeT2_pc";
225  case AddrModeT2_i8s4: return "AddrModeT2_i8s4";
226  case AddrMode_i12: return "AddrMode_i12";
227  case AddrModeT2_ldrex:return "AddrModeT2_ldrex";
228  }
229  }
230 
231  /// Target Operand Flag enum.
232  enum TOF {
233  //===------------------------------------------------------------------===//
234  // ARM Specific MachineOperand flags.
235 
237 
238  /// MO_LO16 - On a symbol operand, this represents a relocation containing
239  /// lower 16 bit of the address. Used only via movw instruction.
240  MO_LO16 = 0x1,
241 
242  /// MO_HI16 - On a symbol operand, this represents a relocation containing
243  /// higher 16 bit of the address. Used only via movt instruction.
244  MO_HI16 = 0x2,
245 
246  /// MO_OPTION_MASK - Most flags are mutually exclusive; this mask selects
247  /// just that part of the flag set.
249 
250  /// MO_COFFSTUB - On a symbol operand "FOO", this indicates that the
251  /// reference is actually to the ".refptrp.FOO" symbol. This is used for
252  /// stub symbols on windows.
253  MO_COFFSTUB = 0x4,
254 
255  /// MO_GOT - On a symbol operand, this represents a GOT relative relocation.
256  MO_GOT = 0x8,
257 
258  /// MO_SBREL - On a symbol operand, this represents a static base relative
259  /// relocation. Used in movw and movt instructions.
260  MO_SBREL = 0x10,
261 
262  /// MO_DLLIMPORT - On a symbol operand, this represents that the reference
263  /// to the symbol is for an import stub. This is used for DLL import
264  /// storage class indication on Windows.
265  MO_DLLIMPORT = 0x20,
266 
267  /// MO_SECREL - On a symbol operand this indicates that the immediate is
268  /// the offset from beginning of section.
269  ///
270  /// This is the TLS offset for the COFF/Windows TLS mechanism.
271  MO_SECREL = 0x40,
272 
273  /// MO_NONLAZY - This is an independent flag, on a symbol operand "FOO" it
274  /// represents a symbol which, if indirect, will get special Darwin mangling
275  /// as a non-lazy-ptr indirect symbol (i.e. "L_FOO$non_lazy_ptr"). Can be
276  /// combined with MO_LO16, MO_HI16 or MO_NO_FLAG (in a constant-pool, for
277  /// example).
278  MO_NONLAZY = 0x80,
279 
280  // It's undefined behaviour if an enum overflows the range between its
281  // smallest and largest values, but since these are |ed together, it can
282  // happen. Put a sentinel in (values of this enum are stored as "unsigned
283  // char").
285  };
286 
287  enum {
288  //===------------------------------------------------------------------===//
289  // Instruction Flags.
290 
291  //===------------------------------------------------------------------===//
292  // This four-bit field describes the addressing mode used.
293  AddrModeMask = 0x1f, // The AddrMode enums are declared in ARMBaseInfo.h
294 
295  // IndexMode - Unindex, pre-indexed, or post-indexed are valid for load
296  // and store ops only. Generic "updating" flag is used for ld/st multiple.
297  // The index mode enums are declared in ARMBaseInfo.h
300 
301  //===------------------------------------------------------------------===//
302  // Instruction encoding formats.
303  //
305  FormMask = 0x3f << FormShift,
306 
307  // Pseudo instructions
308  Pseudo = 0 << FormShift,
309 
310  // Multiply instructions
312 
313  // Branch instructions
314  BrFrm = 2 << FormShift,
316 
317  // Data Processing instructions
318  DPFrm = 4 << FormShift,
320 
321  // Load and Store
322  LdFrm = 6 << FormShift,
323  StFrm = 7 << FormShift,
327 
329 
330  // Miscellaneous arithmetic instructions
332  SatFrm = 13 << FormShift,
333 
334  // Extend instructions
335  ExtFrm = 14 << FormShift,
336 
337  // VFP formats
348 
349  // Thumb format
351 
352  // Miscelleaneous format
354 
355  // NEON formats
372 
373  //===------------------------------------------------------------------===//
374  // Misc flags.
375 
376  // UnaryDP - Indicates this is a unary data processing instruction, i.e.
377  // it doesn't have a Rn operand.
378  UnaryDP = 1 << 13,
379 
380  // Xform16Bit - Indicates this Thumb2 instruction may be transformed into
381  // a 16-bit Thumb instruction if certain conditions are met.
382  Xform16Bit = 1 << 14,
383 
384  // ThumbArithFlagSetting - The instruction is a 16-bit flag setting Thumb
385  // instruction. Used by the parser to determine whether to require the 'S'
386  // suffix on the mnemonic (when not in an IT block) or preclude it (when
387  // in an IT block).
389 
390  //===------------------------------------------------------------------===//
391  // Code domain.
398 
399  //===------------------------------------------------------------------===//
400  // Field shifts - such shifts are used to set field while generating
401  // machine instructions.
402  //
403  // FIXME: This list will need adjusting/fixing as the MC code emitter
404  // takes shape and the ARMCodeEmitter.cpp bits go away.
406 
427  };
428 
429 } // end namespace ARMII
430 
431 } // end namespace llvm;
432 
433 #endif
MO_DLLIMPORT - On a symbol operand, this represents that the reference to the symbol is for an import...
Definition: ARMBaseInfo.h:265
#define R4(n)
This class represents lattice values for constants.
Definition: AllocatorList.h:23
TOF
Target Operand Flag enum.
Definition: ARMBaseInfo.h:232
IndexMode
ARM Index Modes.
Definition: ARMBaseInfo.h:177
unsigned Reg
MO_GOT - On a symbol operand, this represents a GOT relative relocation.
Definition: ARMBaseInfo.h:256
#define R2(n)
MO_COFFSTUB - On a symbol operand "FOO", this indicates that the reference is actually to the "...
Definition: ARMBaseInfo.h:253
MO_SBREL - On a symbol operand, this represents a static base relative relocation.
Definition: ARMBaseInfo.h:260
MO_SECREL - On a symbol operand this indicates that the immediate is the offset from beginning of sec...
Definition: ARMBaseInfo.h:271
static const char * InstSyncBOptToString(unsigned val)
Definition: ARMBaseInfo.h:134
static const char * TraceSyncBOptToString(unsigned val)
Definition: ARMBaseInfo.h:105
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
MO_LO16 - On a symbol operand, this represents a relocation containing lower 16 bit of the address...
Definition: ARMBaseInfo.h:240
static const char * IModToString(unsigned val)
Definition: ARMBaseInfo.h:46
#define R6(n)
static const char * MemBOptToString(unsigned val, bool HasV8)
Definition: ARMBaseInfo.h:77
AddrMode
ARM Addressing Modes.
Definition: ARMBaseInfo.h:185
static const char * IFlagsToString(unsigned val)
Definition: ARMBaseInfo.h:37
static bool isARMLowRegister(unsigned Reg)
isARMLowRegister - Returns true if the register is a low register (r0-r7).
Definition: ARMBaseInfo.h:160
MO_OPTION_MASK - Most flags are mutually exclusive; this mask selects just that part of the flag set...
Definition: ARMBaseInfo.h:248
MO_NONLAZY - This is an independent flag, on a symbol operand "FOO" it represents a symbol which...
Definition: ARMBaseInfo.h:278
static const char * AddrModeToString(AddrMode addrmode)
Definition: ARMBaseInfo.h:207
MO_HI16 - On a symbol operand, this represents a relocation containing higher 16 bit of the address...
Definition: ARMBaseInfo.h:244