Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
rte_cpuflags.h(3)		      DPDK		       rte_cpuflags.h(3)

NAME
     rte_cpuflags.h

SYNOPSIS
     #include 'rte_common.h'
     #include <errno.h>
     #include <rte_compat.h>

   Data Structures
     struct rte_cpu_intrinsics

   Functions
     void rte_cpu_get_intrinsics_support (struct rte_cpu_intrinsics *intrinsics)
     __extension__  const char * rte_cpu_get_flag_name (enum rte_cpu_flag_t fea-
	 ture)
     __extension__ int rte_cpu_get_flag_enabled (enum rte_cpu_flag_t feature)
     int rte_cpu_is_supported (void)
     unsigned long rte_cpu_getauxval (unsigned long type)
     int rte_cpu_strcmp_auxval (unsigned long type, const char *str)

Detailed Description
     Architecture specific API to determine available CPU features at runtime.

     Definition in file rte_cpuflags.h.

Function Documentation
   void rte_cpu_get_intrinsics_support (struct rte_cpu_intrinsics * intrinsics)
     Check CPU support for various intrinsics at runtime.

     Parameters
	 intrinsics Pointer to a structure to be filled.

   __extension__ const char * rte_cpu_get_flag_name  (enum  rte_cpu_flag_t  fea-
     ture)
     Get name of CPU flag

     Parameters
	 feature CPU flag ID

     Returns
	 flag name NULL if flag ID is invalid

   __extension__ int rte_cpu_get_flag_enabled (enum rte_cpu_flag_t feature)
     Function for checking a CPU flag availability

     Parameters
	 feature CPU flag to query CPU for

     Returns
	 1  if	flag  is available 0 if flag is not available -ENOENT if flag is
	 invalid

   int rte_cpu_is_supported (void)
     This function checks that the currently used CPU supports the CPU	features
     that  were specified at compile time. It is called automatically within the
     EAL, so does not need to be used by applications. This  version  returns  a
     result so that decisions may be made (for instance, graceful shutdowns).

   unsigned long rte_cpu_getauxval (unsigned long type)
     This function attempts to retrieve a value from the auxiliary vector. If it
     is unsuccessful, the result will be 0, and errno will be set.

     Returns
	 A  value from the auxiliary vector. When the value is 0, check errno to
	 determine if an error occurred.

   int rte_cpu_strcmp_auxval (unsigned long type, const char * str)
     This function retrieves a value from the auxiliary vector, and compares  it
     as a string against the value retrieved.

     Returns
	 The  result  of  calling  strcmp() against the value retrieved from the
	 auxiliary vector. When the value is 0 (meaning a match is found), check
	 errno to determine if an error occurred.

Author
     Generated automatically by Doxygen for DPDK from the source code.

Version 25.11.0 		 Thu Aug 27 2026	       rte_cpuflags.h(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rte_cpu_is_supported&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help