LLVM 19.0.0git
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
23namespace llvm {
24
25namespace 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
55namespace 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
100namespace 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
114namespace 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///
160static 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///
174namespace ARMII {
175
176 /// ARM Index Modes
181 IndexModeUpd = 3
182 };
183
184 /// ARM Addressing Modes
185 enum AddrMode {
196 AddrModeT1_s = 10, // i8 * 4 for pc and sp relative data
198 AddrModeT2_i8 = 12, // +/- i8
199 AddrModeT2_i8pos = 13, // + i8
200 AddrModeT2_i8neg = 14, // - i8
202 AddrModeT2_pc = 16, // +/- i12 for pc relative data
203 AddrModeT2_i8s4 = 17, // i8 * 4
205 AddrMode5FP16 = 19, // i8 * 2
206 AddrModeT2_ldrex = 20, // i8 * 4, with unscaled offset in MCInst
207 AddrModeT2_i7s4 = 21, // i7 * 4
208 AddrModeT2_i7s2 = 22, // i7 * 2
209 AddrModeT2_i7 = 23, // i7 * 1
210 };
211
212 inline static const char *AddrModeToString(AddrMode addrmode) {
213 switch (addrmode) {
214 case AddrModeNone: return "AddrModeNone";
215 case AddrMode1: return "AddrMode1";
216 case AddrMode2: return "AddrMode2";
217 case AddrMode3: return "AddrMode3";
218 case AddrMode4: return "AddrMode4";
219 case AddrMode5: return "AddrMode5";
220 case AddrMode5FP16: return "AddrMode5FP16";
221 case AddrMode6: return "AddrMode6";
222 case AddrModeT1_1: return "AddrModeT1_1";
223 case AddrModeT1_2: return "AddrModeT1_2";
224 case AddrModeT1_4: return "AddrModeT1_4";
225 case AddrModeT1_s: return "AddrModeT1_s";
226 case AddrModeT2_i12: return "AddrModeT2_i12";
227 case AddrModeT2_i8: return "AddrModeT2_i8";
228 case AddrModeT2_i8pos: return "AddrModeT2_i8pos";
229 case AddrModeT2_i8neg: return "AddrModeT2_i8neg";
230 case AddrModeT2_so: return "AddrModeT2_so";
231 case AddrModeT2_pc: return "AddrModeT2_pc";
232 case AddrModeT2_i8s4: return "AddrModeT2_i8s4";
233 case AddrMode_i12: return "AddrMode_i12";
234 case AddrModeT2_ldrex:return "AddrModeT2_ldrex";
235 case AddrModeT2_i7s4: return "AddrModeT2_i7s4";
236 case AddrModeT2_i7s2: return "AddrModeT2_i7s2";
237 case AddrModeT2_i7: return "AddrModeT2_i7";
238 }
239 }
240
241 /// Target Operand Flag enum.
242 enum TOF {
243 //===------------------------------------------------------------------===//
244 // ARM Specific MachineOperand flags.
245
247
248 /// MO_LO16 - On a symbol operand, this represents a relocation containing
249 /// lower 16 bit of the address. Used only via movw instruction.
250 MO_LO16 = 0x1,
251
252 /// MO_HI16 - On a symbol operand, this represents a relocation containing
253 /// higher 16 bit of the address. Used only via movt instruction.
254 MO_HI16 = 0x2,
255
256 /// MO_OPTION_MASK - Most flags are mutually exclusive; this mask selects
257 /// just that part of the flag set.
259
260 /// MO_COFFSTUB - On a symbol operand "FOO", this indicates that the
261 /// reference is actually to the ".refptr.FOO" symbol. This is used for
262 /// stub symbols on windows.
264
265 /// MO_GOT - On a symbol operand, this represents a GOT relative relocation.
266 MO_GOT = 0x8,
267
268 /// MO_SBREL - On a symbol operand, this represents a static base relative
269 /// relocation. Used in movw and movt instructions.
270 MO_SBREL = 0x10,
271
272 /// MO_DLLIMPORT - On a symbol operand, this represents that the reference
273 /// to the symbol is for an import stub. This is used for DLL import
274 /// storage class indication on Windows.
276
277 /// MO_SECREL - On a symbol operand this indicates that the immediate is
278 /// the offset from beginning of section.
279 ///
280 /// This is the TLS offset for the COFF/Windows TLS mechanism.
281 MO_SECREL = 0x40,
282
283 /// MO_NONLAZY - This is an independent flag, on a symbol operand "FOO" it
284 /// represents a symbol which, if indirect, will get special Darwin mangling
285 /// as a non-lazy-ptr indirect symbol (i.e. "L_FOO$non_lazy_ptr"). Can be
286 /// combined with MO_LO16, MO_HI16 or MO_NO_FLAG (in a constant-pool, for
287 /// example).
289
290 /// MO_LO_0_7 - On a symbol operand, this represents a relocation containing
291 /// bits 0 through 7 of the address. Used only with Thumb1 MOV and ADD
292 // instructions.
293 MO_LO_0_7 = 0x100,
294
295 /// MO_LO_8_15 - On a symbol operand, this represents a relocation
296 /// containing
297 /// bits 8 through 15 of the address. Used only with Thumb1 MOV and ADD
298 // instructions.
299 MO_LO_8_15 = 0x200,
300
301 /// MO_HI_0_7 - On a symbol operand, this represents a relocation containing
302 /// bits 16 through 23 of the address. Used only with Thumb1 MOV and ADD
303 // instructions.
304 MO_HI_0_7 = 0x400,
305
306 /// MO_HI_8_15 - On a symbol operand, this represents a relocation
307 /// containing
308 /// bits 24 through 31 of the address. Used only with Thumb1 MOV and ADD
309 // instructions.
310 MO_HI_8_15 = 0x800
311 };
312
313 enum {
314 //===------------------------------------------------------------------===//
315 // Instruction Flags.
316
317 //===------------------------------------------------------------------===//
318 // This four-bit field describes the addressing mode used.
319 AddrModeMask = 0x1f, // The AddrMode enums are declared in ARMBaseInfo.h
320
321 // IndexMode - Unindex, pre-indexed, or post-indexed are valid for load
322 // and store ops only. Generic "updating" flag is used for ld/st multiple.
323 // The index mode enums are declared in ARMBaseInfo.h
326
327 //===------------------------------------------------------------------===//
328 // Instruction encoding formats.
329 //
332
333 // Pseudo instructions
335
336 // Multiply instructions
338
339 // Branch instructions
342
343 // Data Processing instructions
346
347 // Load and Store
353
355
356 // Miscellaneous arithmetic instructions
359
360 // Extend instructions
362
363 // VFP formats
374
375 // Thumb format
377
378 // Miscelleaneous format
380
381 // NEON formats
398
399 //===------------------------------------------------------------------===//
400 // Misc flags.
401
402 // UnaryDP - Indicates this is a unary data processing instruction, i.e.
403 // it doesn't have a Rn operand.
404 UnaryDP = 1 << 13,
405
406 // Xform16Bit - Indicates this Thumb2 instruction may be transformed into
407 // a 16-bit Thumb instruction if certain conditions are met.
408 Xform16Bit = 1 << 14,
409
410 // ThumbArithFlagSetting - The instruction is a 16-bit flag setting Thumb
411 // instruction. Used by the parser to determine whether to require the 'S'
412 // suffix on the mnemonic (when not in an IT block) or preclude it (when
413 // in an IT block).
415
416 // Whether an instruction can be included in an MVE tail-predicated loop,
417 // though extra validity checks may need to be performed too.
419
420 // Whether an instruction writes to the top/bottom half of a vector element
421 // and leaves the other half untouched.
423
424 // Whether the instruction produces a scalar result from vector operands.
426
427 // Whether this instruction produces a vector result that is larger than
428 // its input, typically reading from the top/bottom halves of the input(s).
430
431 // The vector element size for MVE instructions. 00 = i8, 01 = i16, 10 = i32
432 // and 11 = i64. This is the largest type if multiple are present, so a
433 // MVE_VMOVLs8bh is ize 01=i16, as it extends from a i8 to a i16. There are
434 // some caveats so cannot be used blindly, such as exchanging VMLADAVA's and
435 // complex instructions, which may use different input lanes.
438
439 //===------------------------------------------------------------------===//
440 // Code domain.
448
449 //===------------------------------------------------------------------===//
450 // Field shifts - such shifts are used to set field while generating
451 // machine instructions.
452 //
453 // FIXME: This list will need adjusting/fixing as the MC code emitter
454 // takes shape and the ARMCodeEmitter.cpp bits go away.
456
476 CondShift = 28
477 };
478
479} // end namespace ARMII
480
481} // end namespace llvm;
482
483#endif
unsigned Reg
#define R4(n)
#define R2(n)
#define R6(n)
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
static const char * AddrModeToString(AddrMode addrmode)
Definition: ARMBaseInfo.h:212
TOF
Target Operand Flag enum.
Definition: ARMBaseInfo.h:242
@ MO_OPTION_MASK
MO_OPTION_MASK - Most flags are mutually exclusive; this mask selects just that part of the flag set.
Definition: ARMBaseInfo.h:258
@ MO_LO16
MO_LO16 - On a symbol operand, this represents a relocation containing lower 16 bit of the address.
Definition: ARMBaseInfo.h:250
@ MO_LO_0_7
MO_LO_0_7 - On a symbol operand, this represents a relocation containing bits 0 through 7 of the addr...
Definition: ARMBaseInfo.h:293
@ MO_LO_8_15
MO_LO_8_15 - On a symbol operand, this represents a relocation containing bits 8 through 15 of the ad...
Definition: ARMBaseInfo.h:299
@ MO_NONLAZY
MO_NONLAZY - This is an independent flag, on a symbol operand "FOO" it represents a symbol which,...
Definition: ARMBaseInfo.h:288
@ MO_HI_8_15
MO_HI_8_15 - On a symbol operand, this represents a relocation containing bits 24 through 31 of the a...
Definition: ARMBaseInfo.h:310
@ MO_SBREL
MO_SBREL - On a symbol operand, this represents a static base relative relocation.
Definition: ARMBaseInfo.h:270
@ MO_HI16
MO_HI16 - On a symbol operand, this represents a relocation containing higher 16 bit of the address.
Definition: ARMBaseInfo.h:254
@ MO_DLLIMPORT
MO_DLLIMPORT - On a symbol operand, this represents that the reference to the symbol is for an import...
Definition: ARMBaseInfo.h:275
@ MO_SECREL
MO_SECREL - On a symbol operand this indicates that the immediate is the offset from beginning of sec...
Definition: ARMBaseInfo.h:281
@ MO_HI_0_7
MO_HI_0_7 - On a symbol operand, this represents a relocation containing bits 16 through 23 of the ad...
Definition: ARMBaseInfo.h:304
@ MO_GOT
MO_GOT - On a symbol operand, this represents a GOT relative relocation.
Definition: ARMBaseInfo.h:266
@ MO_COFFSTUB
MO_COFFSTUB - On a symbol operand "FOO", this indicates that the reference is actually to the "....
Definition: ARMBaseInfo.h:263
IndexMode
ARM Index Modes.
Definition: ARMBaseInfo.h:177
AddrMode
ARM Addressing Modes.
Definition: ARMBaseInfo.h:185
@ ThumbArithFlagSetting
Definition: ARMBaseInfo.h:414
@ ValidForTailPredication
Definition: ARMBaseInfo.h:418
@ HorizontalReduction
Definition: ARMBaseInfo.h:425
@ RetainsPreviousHalfElement
Definition: ARMBaseInfo.h:422
static const char * InstSyncBOptToString(unsigned val)
Definition: ARMBaseInfo.h:134
static const char * MemBOptToString(unsigned val, bool HasV8)
Definition: ARMBaseInfo.h:77
static const char * IModToString(unsigned val)
Definition: ARMBaseInfo.h:46
static const char * IFlagsToString(unsigned val)
Definition: ARMBaseInfo.h:37
static const char * TraceSyncBOptToString(unsigned val)
Definition: ARMBaseInfo.h:105
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
static bool isARMLowRegister(unsigned Reg)
isARMLowRegister - Returns true if the register is a low register (r0-r7).
Definition: ARMBaseInfo.h:160