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 "rte_common.h"
  43 #include <errno.h>
  44
  45 /**
  46  * Enumeration of all CPU features supported
  47  */
  48 __extension__
  49 enum rte_cpu_flag_t;
  50
  51 /**
  52  * Get name of CPU flag
  53  *
  54  * @param feature
  55  *     CPU flag ID
  56  * @return
  57  *     flag name
  58  *     NULL if flag ID is invalid
  59  */
  60 __extension__
  61 const char *
  62 rte_cpu_get_flag_name(enum rte_cpu_flag_t feature);
  63
  64 /**
  65  * Function for checking a CPU flag availability
  66  *
  67  * @param feature
  68  *     CPU flag to query CPU for
  69  * @return
  70  *     1 if flag is available
  71  *     0 if flag is not available
  72  *     -ENOENT if flag is invalid
  73  */
  74 __extension__
  75 int
  76 rte_cpu_get_flag_enabled(enum rte_cpu_flag_t feature);
  77
  78 /**
  79  * This function checks that the currently used CPU supports the CPU features
  80  * that were specified at compile time. It is called automatically within the
  81  * EAL, so does not need to be used by applications.
  82  */
  83 __rte_deprecated
  84 void
  85 rte_cpu_check_supported(void);
  86
  87 /**
  88  * This function checks that the currently used CPU supports the CPU features
  89  * that were specified at compile time. It is called automatically within the
  90  * EAL, so does not need to be used by applications.  This version returns a
  91  * result so that decisions may be made (for instance, graceful shutdowns).
  92  */
  93 int
  94 rte_cpu_is_supported(void);
  95
  96 #endif /* _RTE_CPUFLAGS_H_ */