1 //===-- ARMBuildAttributes.h - ARM Build Attributes -------------*- 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 enumerations and support routines for ARM build attributes
10 // as defined in ARM ABI addenda document (ABI release 2.08).
11 //
12 // ELF for the ARM Architecture r2.09 - November 30, 2012
13 //
14 // http://infocenter.arm.com/help/topic/com.arm.doc.ihi0044e/IHI0044E_aaelf.pdf
15 //
16 //===----------------------------------------------------------------------===//
17 
18 #ifndef LLVM_SUPPORT_ARMBUILDATTRIBUTES_H
19 #define LLVM_SUPPORT_ARMBUILDATTRIBUTES_H
20 
21 #include "llvm/Support/ELFAttributes.h"
22 
23 namespace llvm {
24 namespace ARMBuildAttrs {
25 
26 const TagNameMap &getARMAttributeTags();
27 
28 enum SpecialAttr {
29   // This is for the .cpu asm attr. It translates into one or more
30   // AttrType (below) entries in the .ARM.attributes section in the ELF.
31   SEL_CPU
32 };
33 
34 enum AttrType : unsigned {
35   // Rest correspond to ELF/.ARM.attributes
36   File = 1,
37   CPU_raw_name = 4,
38   CPU_name = 5,
39   CPU_arch = 6,
40   CPU_arch_profile = 7,
41   ARM_ISA_use = 8,
42   THUMB_ISA_use = 9,
43   FP_arch = 10,
44   WMMX_arch = 11,
45   Advanced_SIMD_arch = 12,
46   PCS_config = 13,
47   ABI_PCS_R9_use = 14,
48   ABI_PCS_RW_data = 15,
49   ABI_PCS_RO_data = 16,
50   ABI_PCS_GOT_use = 17,
51   ABI_PCS_wchar_t = 18,
52   ABI_FP_rounding = 19,
53   ABI_FP_denormal = 20,
54   ABI_FP_exceptions = 21,
55   ABI_FP_user_exceptions = 22,
56   ABI_FP_number_model = 23,
57   ABI_align_needed = 24,
58   ABI_align_preserved = 25,
59   ABI_enum_size = 26,
60   ABI_HardFP_use = 27,
61   ABI_VFP_args = 28,
62   ABI_WMMX_args = 29,
63   ABI_optimization_goals = 30,
64   ABI_FP_optimization_goals = 31,
65   compatibility = 32,
66   CPU_unaligned_access = 34,
67   FP_HP_extension = 36,
68   ABI_FP_16bit_format = 38,
69   MPextension_use = 42, // recoded from 70 (ABI r2.08)
70   DIV_use = 44,
71   DSP_extension = 46,
72   MVE_arch = 48,
73   also_compatible_with = 65,
74   conformance = 67,
75   Virtualization_use = 68,
76 
77   /// Legacy Tags
78   Section = 2,               // deprecated (ABI r2.09)
79   Symbol = 3,                // deprecated (ABI r2.09)
80   ABI_align8_needed = 24,    // renamed to ABI_align_needed (ABI r2.09)
81   ABI_align8_preserved = 25, // renamed to ABI_align_preserved (ABI r2.09)
82   nodefaults = 64,           // deprecated (ABI r2.09)
83   T2EE_use = 66,             // deprecated (ABI r2.09)
84   MPextension_use_old = 70   // recoded to MPextension_use (ABI r2.08)
85 };
86 
87 // Legal Values for CPU_arch, (=6), uleb128
88 enum CPUArch {
89   Pre_v4   = 0,
90   v4       = 1,   // e.g. SA110
91   v4T      = 2,   // e.g. ARM7TDMI
92   v5T      = 3,   // e.g. ARM9TDMI
93   v5TE     = 4,   // e.g. ARM946E_S
94   v5TEJ    = 5,   // e.g. ARM926EJ_S
95   v6       = 6,   // e.g. ARM1136J_S
96   v6KZ     = 7,   // e.g. ARM1176JZ_S
97   v6T2     = 8,   // e.g. ARM1156T2_S
98   v6K      = 9,   // e.g. ARM1176JZ_S
99   v7       = 10,  // e.g. Cortex A8, Cortex M3
100   v6_M     = 11,  // e.g. Cortex M1
101   v6S_M    = 12,  // v6_M with the System extensions
102   v7E_M    = 13,  // v7_M with DSP extensions
103   v8_A     = 14,  // v8_A AArch32
104   v8_R     = 15,  // e.g. Cortex R52
105   v8_M_Base= 16,  // v8_M_Base AArch32
106   v8_M_Main= 17,  // v8_M_Main AArch32
107   v8_1_M_Main=21, // v8_1_M_Main AArch32
108 };
109 
110 enum CPUArchProfile {               // (=7), uleb128
111   Not_Applicable          = 0,      // pre v7, or cross-profile code
112   ApplicationProfile      = (0x41), // 'A' (e.g. for Cortex A8)
113   RealTimeProfile         = (0x52), // 'R' (e.g. for Cortex R4)
114   MicroControllerProfile  = (0x4D), // 'M' (e.g. for Cortex M3)
115   SystemProfile           = (0x53)  // 'S' Application or real-time profile
116 };
117 
118 // The following have a lot of common use cases
119 enum {
120   Not_Allowed = 0,
121   Allowed = 1,
122 
123   // Tag_ARM_ISA_use (=8), uleb128
124 
125   // Tag_THUMB_ISA_use, (=9), uleb128
126   AllowThumb32 = 2, // 32-bit Thumb (implies 16-bit instructions)
127   AllowThumbDerived = 3, // Thumb allowed, derived from arch/profile
128 
129   // Tag_FP_arch (=10), uleb128 (formerly Tag_VFP_arch = 10)
130   AllowFPv2  = 2,     // v2 FP ISA permitted (implies use of the v1 FP ISA)
131   AllowFPv3A = 3,     // v3 FP ISA permitted (implies use of the v2 FP ISA)
132   AllowFPv3B = 4,     // v3 FP ISA permitted, but only D0-D15, S0-S31
133   AllowFPv4A = 5,     // v4 FP ISA permitted (implies use of v3 FP ISA)
134   AllowFPv4B = 6,     // v4 FP ISA was permitted, but only D0-D15, S0-S31
135   AllowFPARMv8A = 7,  // Use of the ARM v8-A FP ISA was permitted
136   AllowFPARMv8B = 8,  // Use of the ARM v8-A FP ISA was permitted, but only
137                       // D0-D15, S0-S31
138 
139   // Tag_WMMX_arch, (=11), uleb128
140   AllowWMMXv1 = 1,  // The user permitted this entity to use WMMX v1
141   AllowWMMXv2 = 2,  // The user permitted this entity to use WMMX v2
142 
143   // Tag_Advanced_SIMD_arch, (=12), uleb128
144   AllowNeon = 1,      // SIMDv1 was permitted
145   AllowNeon2 = 2,     // SIMDv2 was permitted (Half-precision FP, MAC operations)
146   AllowNeonARMv8 = 3, // ARM v8-A SIMD was permitted
147   AllowNeonARMv8_1a = 4,// ARM v8.1-A SIMD was permitted (RDMA)
148 
149   // Tag_MVE_arch, (=48), uleb128
150   AllowMVEInteger = 1, // integer-only MVE was permitted
151   AllowMVEIntegerAndFloat = 2, // both integer and floating point MVE were permitted
152 
153   // Tag_ABI_PCS_R9_use, (=14), uleb128
154   R9IsGPR = 0,        // R9 used as v6 (just another callee-saved register)
155   R9IsSB = 1,         // R9 used as a global static base rgister
156   R9IsTLSPointer = 2, // R9 used as a thread local storage pointer
157   R9Reserved = 3,     // R9 not used by code associated with attributed entity
158 
159   // Tag_ABI_PCS_RW_data, (=15), uleb128
160   AddressRWPCRel = 1, // Address RW static data PC-relative
161   AddressRWSBRel = 2, // Address RW static data SB-relative
162   AddressRWNone = 3, // No RW static data permitted
163 
164   // Tag_ABI_PCS_RO_data, (=14), uleb128
165   AddressROPCRel = 1, // Address RO static data PC-relative
166   AddressRONone = 2, // No RO static data permitted
167 
168   // Tag_ABI_PCS_GOT_use, (=17), uleb128
169   AddressDirect = 1, // Address imported data directly
170   AddressGOT = 2, // Address imported data indirectly (via GOT)
171 
172   // Tag_ABI_PCS_wchar_t, (=18), uleb128
173   WCharProhibited = 0,  // wchar_t is not used
174   WCharWidth2Bytes = 2, // sizeof(wchar_t) == 2
175   WCharWidth4Bytes = 4, // sizeof(wchar_t) == 4
176 
177   // Tag_ABI_align_needed, (=24), uleb128
178   Align8Byte = 1,
179   Align4Byte = 2,
180   AlignReserved = 3,
181 
182   // Tag_ABI_align_needed, (=25), uleb128
183   AlignNotPreserved = 0,
184   AlignPreserve8Byte = 1,
185   AlignPreserveAll = 2,
186 
187   // Tag_ABI_FP_denormal, (=20), uleb128
188   PositiveZero = 0,
189   IEEEDenormals = 1,
190   PreserveFPSign = 2, // sign when flushed-to-zero is preserved
191 
192   // Tag_ABI_FP_number_model, (=23), uleb128
193   AllowIEEENormal = 1,
194   AllowRTABI = 2,  // numbers, infinities, and one quiet NaN (see [RTABI])
195   AllowIEEE754 = 3, // this code to use all the IEEE 754-defined FP encodings
196 
197   // Tag_ABI_enum_size, (=26), uleb128
198   EnumProhibited = 0, // The user prohibited the use of enums when building
199                       // this entity.
200   EnumSmallest = 1,   // Enum is smallest container big enough to hold all
201                       // values.
202   Enum32Bit = 2,      // Enum is at least 32 bits.
203   Enum32BitABI = 3,   // Every enumeration visible across an ABI-complying
204                       // interface contains a value needing 32 bits to encode
205                       // it; other enums can be containerized.
206 
207   // Tag_ABI_HardFP_use, (=27), uleb128
208   HardFPImplied = 0,          // FP use should be implied by Tag_FP_arch
209   HardFPSinglePrecision = 1,  // Single-precision only
210 
211   // Tag_ABI_VFP_args, (=28), uleb128
212   BaseAAPCS = 0,
213   HardFPAAPCS = 1,
214   ToolChainFPPCS = 2,
215   CompatibleFPAAPCS = 3,
216 
217   // Tag_FP_HP_extension, (=36), uleb128
218   AllowHPFP = 1, // Allow use of Half Precision FP
219 
220   // Tag_FP_16bit_format, (=38), uleb128
221   FP16FormatIEEE = 1,
222   FP16VFP3 = 2,
223 
224   // Tag_MPextension_use, (=42), uleb128
225   AllowMP = 1, // Allow use of MP extensions
226 
227   // Tag_DIV_use, (=44), uleb128
228   // Note: AllowDIVExt must be emitted if and only if the permission to use
229   // hardware divide cannot be conveyed using AllowDIVIfExists or DisallowDIV
230   AllowDIVIfExists = 0, // Allow hardware divide if available in arch, or no
231                         // info exists.
232   DisallowDIV = 1,      // Hardware divide explicitly disallowed.
233   AllowDIVExt = 2,      // Allow hardware divide as optional architecture
234                         // extension above the base arch specified by
235                         // Tag_CPU_arch and Tag_CPU_arch_profile.
236 
237   // Tag_Virtualization_use, (=68), uleb128
238   AllowTZ = 1,
239   AllowVirtualization = 2,
240   AllowTZVirtualization = 3
241 };
242 
243 } // namespace ARMBuildAttrs
244 } // namespace llvm
245 
246 #endif
247