lib/librte_eal/common/include/generic/rte_cpuflags.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_CPUFLAGS_H_
  35 #define _RTE_CPUFLAGS_H_
  36
  37 /**
  38  * @file
  39  * Architecture specific API to determine available CPU features at runtime.
  40  */
  41
  42 #include <stdlib.h>
  43 #include <stdio.h>
  44 #include <errno.h>
  45 #include <stdint.h>
  46
  47 /**
  48  * Enumeration of all CPU features supported
  49  */
  50 enum rte_cpu_flag_t;
  51
  52 /**
  53  * Enumeration of CPU registers
  54  */
  55 #ifdef __DOXYGEN__
  56 enum cpu_register_t;
  57 #endif
  58
  59 typedef uint32_t cpuid_registers_t[4];
  60
  61 #define CPU_FLAG_NAME_MAX_LEN 64
  62
  63 /**
  64  * Struct to hold a processor feature entry
  65  */
  66 struct feature_entry {
  67         uint32_t leaf;                          /**< cpuid leaf */
  68         uint32_t subleaf;                       /**< cpuid subleaf */
  69         uint32_t reg;                           /**< cpuid register */
  70         uint32_t bit;                           /**< cpuid register bit */
  71         char name[CPU_FLAG_NAME_MAX_LEN];       /**< String for printing */
  72 };
  73
  74 #define FEAT_DEF(name, leaf, subleaf, reg, bit) \
  75         [RTE_CPUFLAG_##name] = {leaf, subleaf, reg, bit, #name },
  76
  77 /**
  78  * An array that holds feature entries
  79  *
  80  * Defined in arch-specific rte_cpuflags.h.
  81  */
  82 #ifdef __DOXYGEN__
  83 static const struct feature_entry cpu_feature_table[];
  84 #endif
  85
  86 /**
  87  * Execute CPUID instruction and get contents of a specific register
  88  *
  89  * This function, when compiled with GCC, will generate architecture-neutral
  90  * code, as per GCC manual.
  91  */
  92 static inline void
  93 rte_cpu_get_features(uint32_t leaf, uint32_t subleaf, cpuid_registers_t out);
  94
  95 /**
  96  * Get name of CPU flag
  97  *
  98  * @param feature
  99  *     CPU flag ID
 100  * @return
 101  *     flag name
 102  *     NULL if flag ID is invalid
 103  */
 104 const char *
 105 rte_cpu_get_flag_name(enum rte_cpu_flag_t feature);
 106
 107 /**
 108  * Function for checking a CPU flag availability
 109  *
 110  * @param feature
 111  *     CPU flag to query CPU for
 112  * @return
 113  *     1 if flag is available
 114  *     0 if flag is not available
 115  *     -ENOENT if flag is invalid
 116  */
 117 #ifdef __DOXYGEN__
 118 static inline int
 119 rte_cpu_get_flag_enabled(enum rte_cpu_flag_t feature);
 120 #endif
 121
 122 /**
 123  * This function checks that the currently used CPU supports the CPU features
 124  * that were specified at compile time. It is called automatically within the
 125  * EAL, so does not need to be used by applications.
 126  */
 127 void
 128 rte_cpu_check_supported(void);
 129
 130 #endif /* _RTE_CPUFLAGS_H_ */