gcc/config/aarch64/aarch64-option-extensions.def

   1 /* Copyright (C) 2012-2024 Free Software Foundation, Inc.
   2    Contributed by ARM Ltd.
   3
   4    This file is part of GCC.
   5
   6    GCC is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3, or (at your option)
   9    any later version.
  10
  11    GCC is distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with GCC; see the file COPYING3.  If not see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 /* This is a list of ISA extensions in AArch64.
  21
  22    Before using #include to read this file, define one of the following
  23    macros:
  24
  25       AARCH64_OPT_EXTENSION(NAME, IDENT, REQUIRES, EXPLICIT_ON,
  26                             EXPLICIT_OFF, FEATURE_STRING)
  27
  28       AARCH64_FMV_FEATURE(NAME, FEAT_NAME, IDENT)
  29
  30    - NAME is the name of the extension, represented as a string constant.
  31
  32    - IDENT is the canonical internal name for this flag.
  33
  34    - FEAT_NAME is the unprefixed name used in the CPUFeatures enum.
  35
  36    - REQUIRES is a list of features that must be enabled whenever this
  37      feature is enabled.  The relationship is implicitly transitive:
  38      if A appears in B's REQUIRES and B appears in C's REQUIRES then
  39      A and B must be enabled whenever C is.  Thus, turning on C also
  40      turns on A and B, while turning off A or B also turns off C.
  41
  42    - EXPLICIT_ON is a list of features that are enabled by an explicit
  43      +NAME specification, in addition to those listed in REQUIRES.
  44      Usually this is an empty list; comments below explain the exceptions.
  45      The list is implicitly transitively closed wrt REQUIRES (but *not*
  46      to EXPLICIT_ON, since NAME is the only thing explicit in +NAME).
  47      Thus if A is in B's REQUIRES and B is in C's EXPLICIT_ON, +C will
  48      enable both B and A.  B's EXPLICIT_ON has no effect on +C.
  49
  50    - EXPLICIT_OFF is a list of features that are disabled by an explicit
  51      +noNAME specification, in addition to the features that are transitively
  52      dependent on NAME (according to REQUIRES).  As with EXPLICIT_ON,
  53      this is usually an empty list; comments below explain the exceptions.
  54      If a feature A appears in this list then the list implicitly includes
  55      any features that are transitively dependent on A (according to REQUIRES).
  56
  57    - FEATURE_STRING is a string containing the entries in the 'Features' field
  58      of /proc/cpuinfo on a GNU/Linux system that correspond to this
  59      architecture extension being available.  Sometimes multiple entries are
  60      needed to enable the extension (for example, the 'crypto' extension
  61      depends on four entries: aes, pmull, sha1, sha2 being present).  In that
  62      case this field should contain a space (" ") separated list of the strings
  63      in 'Features' that are required.  Their order is not important.  An empty
  64      string means do not detect this feature during auto detection.
  65
  66    - OPT_FLAGS is a list of feature IDENTS that should be enabled (along with
  67      their transitive dependencies) when the specified FMV feature is present.
  68
  69    Where a feature is present as both an extension and a function
  70    multiversioning feature, and IDENT matches the FEAT_NAME suffix, then these
  71    can be listed here simultaneously using the macro:
  72
  73       AARCH64_OPT_FMV_EXTENSION(NAME, IDENT, REQUIRES, EXPLICIT_ON,
  74                                 EXPLICIT_OFF, FEATURE_STRING)
  75
  76    The list of features extensions must follow topological order wrt REQUIRES
  77    and EXPLICIT_ON.  For example, if A is in B's REQUIRES list, A must come
  78    before B.  This is enforced by aarch64-feature-deps.h.
  79
  80    The list of multiversioning features must be ordered by increasing priority,
  81    as defined in https://github.com/ARM-software/acle/blob/main/main/acle.md
  82
  83    NOTE: Any changes to the AARCH64_OPT_EXTENSION macro need to be mirrored in
  84    config.gcc.  */
  85
  86 #ifndef AARCH64_OPT_EXTENSION
  87 #define AARCH64_OPT_EXTENSION(NAME, IDENT, REQUIRES, EXPLICIT_ON, \
  88                               EXPLICIT_OFF, FEATURE_STRING)
  89 #endif
  90
  91 #ifndef AARCH64_FMV_FEATURE
  92 #define AARCH64_FMV_FEATURE(NAME, FEAT_NAME, OPT_FLAGS)
  93 #endif
  94
  95 #define AARCH64_OPT_FMV_EXTENSION(NAME, IDENT, REQUIRES, EXPLICIT_ON,   \
  96                                   EXPLICIT_OFF, FEATURE_STRING)         \
  97 AARCH64_OPT_EXTENSION(NAME, IDENT, REQUIRES, EXPLICIT_ON, EXPLICIT_OFF, \
  98                       FEATURE_STRING)                                   \
  99 AARCH64_FMV_FEATURE(NAME, IDENT, (IDENT))
 100
 101
 102 AARCH64_OPT_FMV_EXTENSION("rng", RNG, (), (), (), "rng")
 103
 104 AARCH64_OPT_FMV_EXTENSION("flagm", FLAGM, (), (), (), "flagm")
 105
 106 AARCH64_OPT_FMV_EXTENSION("lse", LSE, (), (), (), "atomics")
 107
 108 AARCH64_OPT_FMV_EXTENSION("fp", FP, (), (), (), "fp")
 109
 110 AARCH64_OPT_FMV_EXTENSION("simd", SIMD, (FP), (), (), "asimd")
 111
 112 AARCH64_OPT_FMV_EXTENSION("dotprod", DOTPROD, (SIMD), (), (), "asimddp")
 113
 114 AARCH64_OPT_FMV_EXTENSION("sm4", SM4, (SIMD), (), (), "sm3 sm4")
 115
 116 /* An explicit +rdma implies +simd, but +rdma+nosimd still enables scalar
 117    RDMA instructions.  */
 118 AARCH64_OPT_FMV_EXTENSION("rdma", RDMA, (), (SIMD), (), "asimdrdm")
 119
 120 /* rdm is an alias for rdma.  */
 121 AARCH64_FMV_FEATURE("rdm", RDM, (RDMA))
 122
 123 AARCH64_OPT_FMV_EXTENSION("crc", CRC, (), (), (), "crc32")
 124
 125 AARCH64_OPT_FMV_EXTENSION("sha2", SHA2, (SIMD), (), (), "sha1 sha2")
 126
 127 AARCH64_FMV_FEATURE("sha3", SHA3, (SHA3))
 128
 129 AARCH64_OPT_FMV_EXTENSION("aes", AES, (SIMD), (), (), "aes")
 130
 131 /* +nocrypto disables AES, SHA2 and SM4, and anything that depends on them
 132    (such as SHA3 and the SVE2 crypto extensions).  */
 133 AARCH64_OPT_EXTENSION("crypto", CRYPTO, (AES, SHA2), (), (AES, SHA2, SM4),
 134                       "aes pmull sha1 sha2")
 135
 136 /* Listing sha3 after crypto means we pass "+aes+sha3" to the assembler
 137    instead of "+sha3+crypto".  */
 138 AARCH64_OPT_EXTENSION("sha3", SHA3, (SHA2), (), (), "sha3 sha512")
 139
 140 /* +nofp16 disables an implicit F16FML, even though an implicit F16FML
 141    does not imply F16.  See F16FML for more details.  */
 142 AARCH64_OPT_EXTENSION("fp16", F16, (FP), (), (F16FML), "fphp asimdhp")
 143
 144 AARCH64_FMV_FEATURE("fp16", FP16, (F16))
 145
 146 /* An explicit +fp16fml implies +fp16, but a dependence on it does not.
 147    Thus -march=armv8.4-a implies F16FML but not F16.  -march=armv8.4-a+fp16
 148    and -march=armv8.4-a+fp16fml are equivalent and enable both F16FML and F16.
 149    -march=armv8.4-a+nofp16+fp16 enables F16 but not F16FML.  */
 150 AARCH64_OPT_EXTENSION("fp16fml", F16FML, (), (F16), (), "asimdfhm")
 151
 152 AARCH64_FMV_FEATURE("fp16fml", FP16FML, (F16FML))
 153
 154 AARCH64_OPT_FMV_EXTENSION("rcpc", RCPC, (), (), (), "lrcpc")
 155
 156 AARCH64_OPT_FMV_EXTENSION("rcpc3", RCPC3, (RCPC), (), (), "lrcpc3")
 157
 158 AARCH64_OPT_FMV_EXTENSION("i8mm", I8MM, (SIMD), (), (), "i8mm")
 159
 160 /* An explicit +bf16 implies +simd, but +bf16+nosimd still enables scalar BF16
 161    instructions.  */
 162 AARCH64_OPT_FMV_EXTENSION("bf16", BF16, (FP), (SIMD), (), "bf16")
 163
 164 AARCH64_FMV_FEATURE("rpres", RPRES, ())
 165
 166 AARCH64_OPT_FMV_EXTENSION("sve", SVE, (SIMD, F16), (), (), "sve")
 167
 168 AARCH64_OPT_EXTENSION("f32mm", F32MM, (SVE), (), (), "f32mm")
 169
 170 AARCH64_FMV_FEATURE("f32mm", SVE_F32MM, (F32MM))
 171
 172 AARCH64_OPT_EXTENSION("f64mm", F64MM, (SVE), (), (), "f64mm")
 173
 174 AARCH64_FMV_FEATURE("f64mm", SVE_F64MM, (F64MM))
 175
 176 AARCH64_OPT_FMV_EXTENSION("sve2", SVE2, (SVE), (), (), "sve2")
 177
 178 AARCH64_OPT_EXTENSION("sve2-aes", SVE2_AES, (SVE2, AES), (), (), "sveaes")
 179
 180 AARCH64_FMV_FEATURE("sve2-aes", SVE_AES, (SVE2_AES))
 181
 182 AARCH64_OPT_EXTENSION("sve2-bitperm", SVE2_BITPERM, (SVE2), (), (),
 183                       "svebitperm")
 184
 185 AARCH64_FMV_FEATURE("sve2-bitperm", SVE_BITPERM, (SVE2_BITPERM))
 186
 187 AARCH64_OPT_EXTENSION("sve2-sha3", SVE2_SHA3, (SVE2, SHA3), (), (), "svesha3")
 188
 189 AARCH64_FMV_FEATURE("sve2-sha3", SVE_SHA3, (SVE2_SHA3))
 190
 191 AARCH64_OPT_EXTENSION("sve2-sm4", SVE2_SM4, (SVE2, SM4), (), (), "svesm4")
 192
 193 AARCH64_FMV_FEATURE("sve2-sm4", SVE_SM4, (SVE2_SM4))
 194
 195 AARCH64_OPT_FMV_EXTENSION("sme", SME, (BF16, SVE2), (), (), "sme")
 196
 197 AARCH64_OPT_EXTENSION("memtag", MEMTAG, (), (), (), "")
 198
 199 AARCH64_OPT_FMV_EXTENSION("sb", SB, (), (), (), "sb")
 200
 201 AARCH64_OPT_FMV_EXTENSION("predres", PREDRES, (), (), (), "")
 202
 203 AARCH64_OPT_EXTENSION("ssbs", SSBS, (), (), (), "ssbs")
 204
 205 AARCH64_OPT_EXTENSION("profile", PROFILE, (), (), (), "")
 206
 207 AARCH64_OPT_EXTENSION("tme", TME, (), (), (), "")
 208
 209 AARCH64_OPT_EXTENSION("pauth", PAUTH, (), (), (), "paca pacg")
 210
 211 AARCH64_OPT_EXTENSION("ls64", LS64, (), (), (), "")
 212
 213 AARCH64_OPT_EXTENSION("sme-f64f64", SME_F64F64, (SME), (), (), "")
 214
 215 AARCH64_FMV_FEATURE("sme-f64f64", SME_F64, (SME_F64F64))
 216
 217 AARCH64_OPT_EXTENSION("sme-i16i64", SME_I16I64, (SME), (), (), "")
 218
 219 AARCH64_FMV_FEATURE("sme-i16i64", SME_I64, (SME_I16I64))
 220
 221 AARCH64_OPT_FMV_EXTENSION("sme2", SME2, (SME), (), (), "sme2")
 222
 223 AARCH64_OPT_EXTENSION("mops", MOPS, (), (), (), "")
 224
 225 AARCH64_OPT_EXTENSION("cssc", CSSC, (), (), (), "cssc")
 226
 227 AARCH64_OPT_EXTENSION("lse128", LSE128, (LSE), (), (), "lse128")
 228
 229 AARCH64_OPT_EXTENSION("d128", D128, (LSE128), (), (), "d128")
 230
 231 AARCH64_OPT_EXTENSION("the", THE, (), (), (), "the")
 232
 233 AARCH64_OPT_EXTENSION("gcs", GCS, (), (), (), "gcs")
 234
 235 #undef AARCH64_OPT_FMV_EXTENSION
 236 #undef AARCH64_OPT_EXTENSION
 237 #undef AARCH64_FMV_FEATURE