1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2010-2014 Intel Corporation 3 */ 4 5 #ifndef _RTE_CPUFLAGS_H_ 6 #define _RTE_CPUFLAGS_H_ 7 8 /** 9 * @file 10 * Architecture specific API to determine available CPU features at runtime. 11 */ 12 13 #include "rte_common.h" 14 #include <errno.h> 15 16 #include <rte_compat.h> 17 18 /** 19 * Structure used to describe platform-specific intrinsics that may or may not 20 * be supported at runtime. 21 */ 22 struct rte_cpu_intrinsics { 23 uint32_t power_monitor : 1; 24 /**< indicates support for rte_power_monitor function */ 25 uint32_t power_pause : 1; 26 /**< indicates support for rte_power_pause function */ 27 }; 28 29 /** 30 * @warning 31 * @b EXPERIMENTAL: this API may change without prior notice 32 * 33 * Check CPU support for various intrinsics at runtime. 34 * 35 * @param intrinsics 36 * Pointer to a structure to be filled. 37 */ 38 __rte_experimental 39 void 40 rte_cpu_get_intrinsics_support(struct rte_cpu_intrinsics *intrinsics); 41 42 /** 43 * Enumeration of all CPU features supported 44 */ 45 __extension__ 46 enum rte_cpu_flag_t; 47 48 /** 49 * Get name of CPU flag 50 * 51 * @param feature 52 * CPU flag ID 53 * @return 54 * flag name 55 * NULL if flag ID is invalid 56 */ 57 __extension__ 58 const char * 59 rte_cpu_get_flag_name(enum rte_cpu_flag_t feature); 60 61 /** 62 * Function for checking a CPU flag availability 63 * 64 * @param feature 65 * CPU flag to query CPU for 66 * @return 67 * 1 if flag is available 68 * 0 if flag is not available 69 * -ENOENT if flag is invalid 70 */ 71 __extension__ 72 int 73 rte_cpu_get_flag_enabled(enum rte_cpu_flag_t feature); 74 75 /** 76 * This function checks that the currently used CPU supports the CPU features 77 * that were specified at compile time. It is called automatically within the 78 * EAL, so does not need to be used by applications. This version returns a 79 * result so that decisions may be made (for instance, graceful shutdowns). 80 */ 81 int 82 rte_cpu_is_supported(void); 83 84 /** 85 * This function attempts to retrieve a value from the auxiliary vector. 86 * If it is unsuccessful, the result will be 0, and errno will be set. 87 * 88 * @return A value from the auxiliary vector. When the value is 0, check 89 * errno to determine if an error occurred. 90 */ 91 unsigned long 92 rte_cpu_getauxval(unsigned long type); 93 94 /** 95 * This function retrieves a value from the auxiliary vector, and compares it 96 * as a string against the value retrieved. 97 * 98 * @return The result of calling strcmp() against the value retrieved from 99 * the auxiliary vector. When the value is 0 (meaning a match is found), 100 * check errno to determine if an error occurred. 101 */ 102 int 103 rte_cpu_strcmp_auxval(unsigned long type, const char *str); 104 105 #endif /* _RTE_CPUFLAGS_H_ */ 106