src/vppinfra/cpu.h

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef included_clib_cpu_h
  17 #define included_clib_cpu_h
  18
  19 #include <sys/syscall.h>
  20 #include <vppinfra/format.h>
  21
  22 #if defined(__x86_64__)
  23 #define foreach_march_variant                                                 \
  24   _ (hsw, "Intel Haswell")                                                    \
  25   _ (trm, "Intel Tremont")                                                    \
  26   _ (skx, "Intel Skylake (server) / Cascade Lake")                            \
  27   _ (icl, "Intel Ice Lake")
  28 #elif defined(__aarch64__)
  29 #define foreach_march_variant                                                 \
  30   _ (octeontx2, "Marvell Octeon TX2")                                         \
  31   _ (thunderx2t99, "Marvell ThunderX2 T99")                                   \
  32   _ (qdf24xx, "Qualcomm CentriqTM 2400")                                      \
  33   _ (cortexa72, "ARM Cortex-A72")                                             \
  34   _ (neoversen1, "ARM Neoverse N1")
  35 #else
  36 #define foreach_march_variant
  37 #endif
  38
  39 typedef enum
  40 {
  41   CLIB_MARCH_VARIANT_TYPE = 0,
  42 #define _(s, n) CLIB_MARCH_VARIANT_TYPE_##s,
  43   foreach_march_variant
  44 #undef _
  45     CLIB_MARCH_TYPE_N_VARIANTS
  46 } clib_march_variant_type_t;
  47
  48 #ifdef CLIB_MARCH_VARIANT
  49 #define __CLIB_MULTIARCH_FN(a,b) a##_##b
  50 #define _CLIB_MULTIARCH_FN(a,b) __CLIB_MULTIARCH_FN(a,b)
  51 #define CLIB_MULTIARCH_FN(fn) _CLIB_MULTIARCH_FN(fn,CLIB_MARCH_VARIANT)
  52 #else
  53 #define CLIB_MULTIARCH_FN(fn) fn
  54 #endif
  55
  56 #define CLIB_MARCH_SFX CLIB_MULTIARCH_FN
  57
  58 typedef struct _clib_march_fn_registration
  59 {
  60   void *function;
  61   int priority;
  62   struct _clib_march_fn_registration *next;
  63   char *name;
  64 } clib_march_fn_registration;
  65
  66 static_always_inline void *
  67 clib_march_select_fn_ptr (clib_march_fn_registration * r)
  68 {
  69   void *rv = 0;
  70   int last_prio = -1;
  71
  72   while (r)
  73     {
  74       if (last_prio < r->priority)
  75         {
  76           last_prio = r->priority;
  77           rv = r->function;
  78         }
  79       r = r->next;
  80     }
  81   return rv;
  82 }
  83
  84 #define CLIB_MARCH_FN_POINTER(fn)                                             \
  85   (__typeof__ (fn) *) clib_march_select_fn_ptr (fn##_march_fn_registrations);
  86
  87 #define CLIB_MARCH_FN_VOID_POINTER(fn)                                        \
  88   clib_march_select_fn_ptr (fn##_march_fn_registrations);
  89
  90 #define _CLIB_MARCH_FN_REGISTRATION(fn) \
  91 static clib_march_fn_registration \
  92 CLIB_MARCH_SFX(fn##_march_fn_registration) = \
  93 { \
  94   .name = CLIB_MARCH_VARIANT_STR \
  95 }; \
  96 \
  97 static void __clib_constructor \
  98 fn##_march_register () \
  99 { \
 100   clib_march_fn_registration *r; \
 101   r = & CLIB_MARCH_SFX (fn##_march_fn_registration); \
 102   r->priority = CLIB_MARCH_FN_PRIORITY(); \
 103   r->next = fn##_march_fn_registrations; \
 104   r->function = CLIB_MARCH_SFX (fn); \
 105   fn##_march_fn_registrations = r; \
 106 }
 107
 108 #ifdef CLIB_MARCH_VARIANT
 109 #define CLIB_MARCH_FN_REGISTRATION(fn) \
 110 extern clib_march_fn_registration *fn##_march_fn_registrations; \
 111 _CLIB_MARCH_FN_REGISTRATION(fn)
 112 #else
 113 #define CLIB_MARCH_FN_REGISTRATION(fn) \
 114 clib_march_fn_registration *fn##_march_fn_registrations = 0; \
 115 _CLIB_MARCH_FN_REGISTRATION(fn)
 116 #endif
 117 #define foreach_x86_64_flags                                                  \
 118   _ (sse3, 1, ecx, 0)                                                         \
 119   _ (pclmulqdq, 1, ecx, 1)                                                    \
 120   _ (ssse3, 1, ecx, 9)                                                        \
 121   _ (sse41, 1, ecx, 19)                                                       \
 122   _ (sse42, 1, ecx, 20)                                                       \
 123   _ (avx, 1, ecx, 28)                                                         \
 124   _ (rdrand, 1, ecx, 30)                                                      \
 125   _ (avx2, 7, ebx, 5)                                                         \
 126   _ (rtm, 7, ebx, 11)                                                         \
 127   _ (pqm, 7, ebx, 12)                                                         \
 128   _ (pqe, 7, ebx, 15)                                                         \
 129   _ (avx512f, 7, ebx, 16)                                                     \
 130   _ (rdseed, 7, ebx, 18)                                                      \
 131   _ (x86_aes, 1, ecx, 25)                                                     \
 132   _ (sha, 7, ebx, 29)                                                         \
 133   _ (vaes, 7, ecx, 9)                                                         \
 134   _ (vpclmulqdq, 7, ecx, 10)                                                  \
 135   _ (avx512_vnni, 7, ecx, 11)                                                 \
 136   _ (avx512_bitalg, 7, ecx, 12)                                               \
 137   _ (avx512_vpopcntdq, 7, ecx, 14)                                            \
 138   _ (movdiri, 7, ecx, 27)                                                     \
 139   _ (movdir64b, 7, ecx, 28)                                                   \
 140   _ (avx512_fp16, 7, edx, 23)                                                 \
 141   _ (invariant_tsc, 0x80000007, edx, 8)
 142
 143 #define foreach_aarch64_flags \
 144 _ (fp,          0) \
 145 _ (asimd,       1) \
 146 _ (evtstrm,     2) \
 147 _ (aarch64_aes, 3) \
 148 _ (pmull,       4) \
 149 _ (sha1,        5) \
 150 _ (sha2,        6) \
 151 _ (crc32,       7) \
 152 _ (atomics,     8) \
 153 _ (fphp,        9) \
 154 _ (asimdhp,    10) \
 155 _ (cpuid,      11) \
 156 _ (asimdrdm,   12) \
 157 _ (jscvt,      13) \
 158 _ (fcma,       14) \
 159 _ (lrcpc,      15) \
 160 _ (dcpop,      16) \
 161 _ (sha3,       17) \
 162 _ (sm3,        18) \
 163 _ (sm4,        19) \
 164 _ (asimddp,    20) \
 165 _ (sha512,     21) \
 166 _ (sve,        22)
 167
 168 u32 clib_get_current_cpu_id ();
 169 u32 clib_get_current_numa_node ();
 170
 171 #if defined(__x86_64__)
 172 #include "cpuid.h"
 173
 174 static inline int
 175 clib_get_cpuid (const u32 lev, u32 * eax, u32 * ebx, u32 * ecx, u32 * edx)
 176 {
 177   if ((u32) __get_cpuid_max (0x80000000 & lev, 0) < lev)
 178     return 0;
 179   if (lev == 7)
 180     __cpuid_count (lev, 0, *eax, *ebx, *ecx, *edx);
 181   else
 182     __cpuid (lev, *eax, *ebx, *ecx, *edx);
 183   return 1;
 184 }
 185
 186 typedef int (*clib_cpu_supports_func_t) ();
 187
 188 #define _(flag, func, reg, bit) \
 189 static inline int                                                       \
 190 clib_cpu_supports_ ## flag()                                            \
 191 {                                                                       \
 192   u32 __attribute__((unused)) eax, ebx = 0, ecx = 0, edx  = 0;          \
 193   clib_get_cpuid (func, &eax, &ebx, &ecx, &edx);                        \
 194                                                                         \
 195   return ((reg & (1 << bit)) != 0);                                     \
 196 }
 197 foreach_x86_64_flags
 198 #undef _
 199 #else /* __x86_64__ */
 200
 201 #define _(flag, func, reg, bit) \
 202 static inline int clib_cpu_supports_ ## flag() { return 0; }
 203 foreach_x86_64_flags
 204 #undef _
 205 #endif /* __x86_64__ */
 206 #if defined(__aarch64__)
 207 #include <sys/auxv.h>
 208 #define _(flag, bit) \
 209 static inline int                                                       \
 210 clib_cpu_supports_ ## flag()                                            \
 211 {                                                                       \
 212   unsigned long hwcap = getauxval(AT_HWCAP);                            \
 213   return (hwcap & (1 << bit));                                          \
 214 }
 215   foreach_aarch64_flags
 216 #undef _
 217 #else /* ! __x86_64__ && !__aarch64__ */
 218 #define _(flag, bit) \
 219 static inline int clib_cpu_supports_ ## flag() { return 0; }
 220   foreach_aarch64_flags
 221 #undef _
 222 #endif /* __x86_64__, __aarch64__ */
 223 /*
 224  * aes is the only feature with the same name in both flag lists
 225  * handle this by prefixing it with the arch name, and handling it
 226  * with the custom function below
 227  */
 228   static inline int
 229 clib_cpu_supports_aes ()
 230 {
 231 #if defined(__x86_64__)
 232   return clib_cpu_supports_x86_aes ();
 233 #elif defined (__aarch64__)
 234   return clib_cpu_supports_aarch64_aes ();
 235 #else
 236   return 0;
 237 #endif
 238 }
 239
 240 static inline int
 241 clib_cpu_march_priority_icl ()
 242 {
 243   if (clib_cpu_supports_avx512_bitalg ())
 244     return 200;
 245   return -1;
 246 }
 247
 248 static inline int
 249 clib_cpu_march_priority_skx ()
 250 {
 251   if (clib_cpu_supports_avx512f ())
 252     return 100;
 253   return -1;
 254 }
 255
 256 static inline int
 257 clib_cpu_march_priority_trm ()
 258 {
 259   if (clib_cpu_supports_movdiri ())
 260     return 60;
 261   return -1;
 262 }
 263
 264 static inline int
 265 clib_cpu_march_priority_hsw ()
 266 {
 267   if (clib_cpu_supports_avx2 ())
 268     return 50;
 269   return -1;
 270 }
 271
 272 #define X86_CPU_ARCH_PERF_FUNC 0xA
 273
 274 static inline int
 275 clib_get_pmu_counter_count (u8 *fixed, u8 *general)
 276 {
 277 #if defined(__x86_64__)
 278   u32 __clib_unused eax = 0, ebx = 0, ecx = 0, edx = 0;
 279   clib_get_cpuid (X86_CPU_ARCH_PERF_FUNC, &eax, &ebx, &ecx, &edx);
 280
 281   *general = (eax & 0xFF00) >> 8;
 282   *fixed = (edx & 0xF);
 283
 284   return 1;
 285 #else
 286   return 0;
 287 #endif
 288 }
 289
 290 static inline u32
 291 clib_cpu_implementer ()
 292 {
 293   char buf[128];
 294   static u32 implementer = -1;
 295
 296   if (-1 != implementer)
 297     return implementer;
 298
 299   FILE *fp = fopen ("/proc/cpuinfo", "r");
 300   if (!fp)
 301     return implementer;
 302
 303   while (!feof (fp))
 304     {
 305       if (!fgets (buf, sizeof (buf), fp))
 306         break;
 307       buf[127] = '\0';
 308       if (strstr (buf, "CPU implementer"))
 309         implementer = (u32) strtol (memchr (buf, ':', 128) + 2, NULL, 0);
 310       if (-1 != implementer)
 311         break;
 312     }
 313   fclose (fp);
 314
 315   return implementer;
 316 }
 317
 318 static inline u32
 319 clib_cpu_part ()
 320 {
 321   char buf[128];
 322   static u32 part = -1;
 323
 324   if (-1 != part)
 325     return part;
 326
 327   FILE *fp = fopen ("/proc/cpuinfo", "r");
 328   if (!fp)
 329     return part;
 330
 331   while (!feof (fp))
 332     {
 333       if (!fgets (buf, sizeof (buf), fp))
 334         break;
 335       buf[127] = '\0';
 336       if (strstr (buf, "CPU part"))
 337         part = (u32) strtol (memchr (buf, ':', 128) + 2, NULL, 0);
 338       if (-1 != part)
 339         break;
 340     }
 341   fclose (fp);
 342
 343   return part;
 344 }
 345
 346 #define AARCH64_CPU_IMPLEMENTER_CAVIUM      0x43
 347 #define AARCH64_CPU_PART_THUNDERX2          0x0af
 348 #define AARCH64_CPU_PART_OCTEONTX2T96       0x0b2
 349 #define AARCH64_CPU_PART_OCTEONTX2T98       0x0b1
 350 #define AARCH64_CPU_IMPLEMENTER_QDF24XX     0x51
 351 #define AARCH64_CPU_PART_QDF24XX            0xc00
 352 #define AARCH64_CPU_IMPLEMENTER_CORTEXA72   0x41
 353 #define AARCH64_CPU_PART_CORTEXA72          0xd08
 354 #define AARCH64_CPU_IMPLEMENTER_NEOVERSEN1  0x41
 355 #define AARCH64_CPU_PART_NEOVERSEN1         0xd0c
 356
 357 static inline int
 358 clib_cpu_march_priority_octeontx2 ()
 359 {
 360   if ((AARCH64_CPU_IMPLEMENTER_CAVIUM == clib_cpu_implementer ()) &&
 361       ((AARCH64_CPU_PART_OCTEONTX2T96 == clib_cpu_part ())
 362        || AARCH64_CPU_PART_OCTEONTX2T98 == clib_cpu_part ()))
 363     return 20;
 364   return -1;
 365 }
 366
 367 static inline int
 368 clib_cpu_march_priority_thunderx2t99 ()
 369 {
 370   if ((AARCH64_CPU_IMPLEMENTER_CAVIUM == clib_cpu_implementer ()) &&
 371       (AARCH64_CPU_PART_THUNDERX2 == clib_cpu_part ()))
 372     return 20;
 373   return -1;
 374 }
 375
 376 static inline int
 377 clib_cpu_march_priority_qdf24xx ()
 378 {
 379   if ((AARCH64_CPU_IMPLEMENTER_QDF24XX == clib_cpu_implementer ()) &&
 380       (AARCH64_CPU_PART_QDF24XX == clib_cpu_part ()))
 381     return 20;
 382   return -1;
 383 }
 384
 385 static inline int
 386 clib_cpu_march_priority_cortexa72 ()
 387 {
 388   if ((AARCH64_CPU_IMPLEMENTER_CORTEXA72 == clib_cpu_implementer ()) &&
 389       (AARCH64_CPU_PART_CORTEXA72 == clib_cpu_part ()))
 390     return 10;
 391   return -1;
 392 }
 393
 394 static inline int
 395 clib_cpu_march_priority_neoversen1 ()
 396 {
 397   if ((AARCH64_CPU_IMPLEMENTER_NEOVERSEN1 == clib_cpu_implementer ()) &&
 398       (AARCH64_CPU_PART_NEOVERSEN1 == clib_cpu_part ()))
 399     return 10;
 400   return -1;
 401 }
 402
 403 #ifdef CLIB_MARCH_VARIANT
 404 #define CLIB_MARCH_FN_PRIORITY() CLIB_MARCH_SFX(clib_cpu_march_priority)()
 405 #else
 406 #define CLIB_MARCH_FN_PRIORITY() 0
 407 #endif
 408 #endif /* included_clib_cpu_h */
 409
 410 #define CLIB_MARCH_FN_CONSTRUCTOR(fn)                                   \
 411 static void __clib_constructor                                          \
 412 CLIB_MARCH_SFX(fn ## _march_constructor) (void)                         \
 413 {                                                                       \
 414   if (CLIB_MARCH_FN_PRIORITY() > fn ## _selected_priority)              \
 415     {                                                                   \
 416       fn ## _selected = & CLIB_MARCH_SFX (fn ## _ma);                   \
 417       fn ## _selected_priority = CLIB_MARCH_FN_PRIORITY();              \
 418     }                                                                   \
 419 }                                                                       \
 420
 421 #ifndef CLIB_MARCH_VARIANT
 422 #define CLIB_MARCH_FN(fn, rtype, _args...)                                    \
 423   static rtype CLIB_MARCH_SFX (fn##_ma) (_args);                              \
 424   rtype (*fn##_selected) (_args) = &CLIB_MARCH_SFX (fn##_ma);                 \
 425   int fn##_selected_priority = 0;                                             \
 426   static inline rtype CLIB_MARCH_SFX (fn##_ma) (_args)
 427 #else
 428 #define CLIB_MARCH_FN(fn, rtype, _args...)                                    \
 429   static rtype CLIB_MARCH_SFX (fn##_ma) (_args);                              \
 430   extern rtype (*fn##_selected) (_args);                                      \
 431   extern int fn##_selected_priority;                                          \
 432   CLIB_MARCH_FN_CONSTRUCTOR (fn)                                              \
 433   static rtype CLIB_MARCH_SFX (fn##_ma) (_args)
 434 #endif
 435
 436 #define CLIB_MARCH_FN_SELECT(fn) (* fn ## _selected)
 437
 438 format_function_t format_cpu_uarch;
 439 format_function_t format_cpu_model_name;
 440 format_function_t format_cpu_flags;
 441 format_function_t format_march_variant;
 442
 443 /*
 444  * fd.io coding-style-patch-verification: ON
 445  *
 446  * Local Variables:
 447  * eval: (c-set-style "gnu")
 448  * End:
 449  */