cne_cpuflags.h File Reference

#include <stdbool.h>
#include <errno.h>
#include "cne_common.h"

Go to the source code of this file.

Enumerations
enum	cne_cpu_flag_t {   CNE_CPUFLAG_SSE3 = 0 , CNE_CPUFLAG_PCLMULQDQ , CNE_CPUFLAG_DTES64 , CNE_CPUFLAG_MONITOR ,   CNE_CPUFLAG_DS_CPL , CNE_CPUFLAG_VMX , CNE_CPUFLAG_SMX , CNE_CPUFLAG_EIST ,   CNE_CPUFLAG_TM2 , CNE_CPUFLAG_SSSE3 , CNE_CPUFLAG_CNXT_ID , CNE_CPUFLAG_FMA ,   CNE_CPUFLAG_CMPXCHG16B , CNE_CPUFLAG_XTPR , CNE_CPUFLAG_PDCM , CNE_CPUFLAG_PCID ,   CNE_CPUFLAG_DCA , CNE_CPUFLAG_SSE4_1 , CNE_CPUFLAG_SSE4_2 , CNE_CPUFLAG_X2APIC ,   CNE_CPUFLAG_MOVBE , CNE_CPUFLAG_POPCNT , CNE_CPUFLAG_TSC_DEADLINE , CNE_CPUFLAG_AES ,   CNE_CPUFLAG_XSAVE , CNE_CPUFLAG_OSXSAVE , CNE_CPUFLAG_AVX , CNE_CPUFLAG_F16C ,   CNE_CPUFLAG_RDRAND , CNE_CPUFLAG_HYPERVISOR , CNE_CPUFLAG_FPU , CNE_CPUFLAG_VME ,   CNE_CPUFLAG_DE , CNE_CPUFLAG_PSE , CNE_CPUFLAG_TSC , CNE_CPUFLAG_MSR ,   CNE_CPUFLAG_PAE , CNE_CPUFLAG_MCE , CNE_CPUFLAG_CX8 , CNE_CPUFLAG_APIC ,   CNE_CPUFLAG_SEP , CNE_CPUFLAG_MTRR , CNE_CPUFLAG_PGE , CNE_CPUFLAG_MCA ,   CNE_CPUFLAG_CMOV , CNE_CPUFLAG_PAT , CNE_CPUFLAG_PSE36 , CNE_CPUFLAG_PSN ,   CNE_CPUFLAG_CLFSH , CNE_CPUFLAG_DS , CNE_CPUFLAG_ACPI , CNE_CPUFLAG_MMX ,   CNE_CPUFLAG_FXSR , CNE_CPUFLAG_SSE , CNE_CPUFLAG_SSE2 , CNE_CPUFLAG_SS ,   CNE_CPUFLAG_HTT , CNE_CPUFLAG_TM , CNE_CPUFLAG_PBE , CNE_CPUFLAG_DIGTEMP ,   CNE_CPUFLAG_TRBOBST , CNE_CPUFLAG_ARAT , CNE_CPUFLAG_PLN , CNE_CPUFLAG_ECMD ,   CNE_CPUFLAG_PTM , CNE_CPUFLAG_MPERF_APERF_MSR , CNE_CPUFLAG_ACNT2 , CNE_CPUFLAG_ENERGY_EFF ,   CNE_CPUFLAG_FSGSBASE , CNE_CPUFLAG_BMI1 , CNE_CPUFLAG_HLE , CNE_CPUFLAG_AVX2 ,   CNE_CPUFLAG_SMEP , CNE_CPUFLAG_BMI2 , CNE_CPUFLAG_ERMS , CNE_CPUFLAG_INVPCID ,   CNE_CPUFLAG_RTM , CNE_CPUFLAG_AVX512F , CNE_CPUFLAG_RDSEED , CNE_CPUFLAG_LAHF_SAHF ,   CNE_CPUFLAG_LZCNT , CNE_CPUFLAG_SYSCALL , CNE_CPUFLAG_XD , CNE_CPUFLAG_1GB_PG ,   CNE_CPUFLAG_RDTSCP , CNE_CPUFLAG_EM64T , CNE_CPUFLAG_INVTSC , CNE_CPUFLAG_AVX512DQ ,   CNE_CPUFLAG_AVX512IFMA , CNE_CPUFLAG_AVX512CD , CNE_CPUFLAG_AVX512BW , CNE_CPUFLAG_AVX512VL ,   CNE_CPUFLAG_AVX512VBMI , CNE_CPUFLAG_AVX512VBMI2 , CNE_CPUFLAG_GFNI , CNE_CPUFLAG_VAES ,   CNE_CPUFLAG_VPCLMULQDQ , CNE_CPUFLAG_AVX512VNNI , CNE_CPUFLAG_AVX512BITALG , CNE_CPUFLAG_AVX512VPOPCNTDQ ,   CNE_CPUFLAG_CLDEMOTE , CNE_CPUFLAG_MOVDIRI , CNE_CPUFLAG_MOVDIR64B , CNE_CPUFLAG_AVX512VP2INTERSECT ,   CNE_CPUFLAG_WAITPKG , CNE_CPUFLAG_NUMFLAGS }

Functions
CNDP_API const char *	cne_cpu_get_flag_name (enum cne_cpu_flag_t feature)
CNDP_API int	cne_cpu_get_flag_enabled (enum cne_cpu_flag_t feature)
CNDP_API int	cne_cpu_is_supported (void)
CNDP_API unsigned long	cne_cpu_getauxval (unsigned long type)
CNDP_API int	cne_cpu_strcmp_auxval (unsigned long type, const char *str)
CNDP_API bool	cne_cpu_rtm_is_supported (void)
CNDP_API bool	cne_cpu_waitpkg_is_supported (void)

Detailed Description

CPU Flags routine for x86 archs. Gather and provide APIs to detect x86 CPU flags.

Definition in file cne_cpuflags.h.

Enumeration Type Documentation

cne_cpu_flag_t

enum cne_cpu_flag_t

Set of flags or enums for each CPU flag ID

Enumerator
CNE_CPUFLAG_SSE3	Enumeration of CPU Flags SSE3
CNE_CPUFLAG_PCLMULQDQ	PCLMULQDQ
CNE_CPUFLAG_DTES64	DTES64
CNE_CPUFLAG_MONITOR	MONITOR
CNE_CPUFLAG_DS_CPL	DS_CPL
CNE_CPUFLAG_VMX	VMX
CNE_CPUFLAG_SMX	SMX
CNE_CPUFLAG_EIST	EIST
CNE_CPUFLAG_TM2	TM2
CNE_CPUFLAG_SSSE3	SSSE3
CNE_CPUFLAG_CNXT_ID	CNXT_ID
CNE_CPUFLAG_FMA	FMA
CNE_CPUFLAG_CMPXCHG16B	CMPXCHG16B
CNE_CPUFLAG_XTPR	XTPR
CNE_CPUFLAG_PDCM	PDCM
CNE_CPUFLAG_PCID	PCID
CNE_CPUFLAG_DCA	DCA
CNE_CPUFLAG_SSE4_1	SSE4_1
CNE_CPUFLAG_SSE4_2	SSE4_2
CNE_CPUFLAG_X2APIC	X2APIC
CNE_CPUFLAG_MOVBE	MOVBE
CNE_CPUFLAG_POPCNT	POPCNT
CNE_CPUFLAG_TSC_DEADLINE	TSC_DEADLINE
CNE_CPUFLAG_AES	AES
CNE_CPUFLAG_XSAVE	XSAVE
CNE_CPUFLAG_OSXSAVE	OSXSAVE
CNE_CPUFLAG_AVX	AVX
CNE_CPUFLAG_F16C	F16C
CNE_CPUFLAG_RDRAND	RDRAND
CNE_CPUFLAG_HYPERVISOR	Running in a VM
CNE_CPUFLAG_FPU	FPU
CNE_CPUFLAG_VME	VME
CNE_CPUFLAG_DE	DE
CNE_CPUFLAG_PSE	PSE
CNE_CPUFLAG_TSC	TSC
CNE_CPUFLAG_MSR	MSR
CNE_CPUFLAG_PAE	PAE
CNE_CPUFLAG_MCE	MCE
CNE_CPUFLAG_CX8	CX8
CNE_CPUFLAG_APIC	APIC
CNE_CPUFLAG_SEP	SEP
CNE_CPUFLAG_MTRR	MTRR
CNE_CPUFLAG_PGE	PGE
CNE_CPUFLAG_MCA	MCA
CNE_CPUFLAG_CMOV	CMOV
CNE_CPUFLAG_PAT	PAT
CNE_CPUFLAG_PSE36	PSE36
CNE_CPUFLAG_PSN	PSN
CNE_CPUFLAG_CLFSH	CLFSH
CNE_CPUFLAG_DS	DS
CNE_CPUFLAG_ACPI	ACPI
CNE_CPUFLAG_MMX	MMX
CNE_CPUFLAG_FXSR	FXSR
CNE_CPUFLAG_SSE	SSE
CNE_CPUFLAG_SSE2	SSE2
CNE_CPUFLAG_SS	SS
CNE_CPUFLAG_HTT	HTT
CNE_CPUFLAG_TM	TM
CNE_CPUFLAG_PBE	PBE
CNE_CPUFLAG_DIGTEMP	DIGTEMP
CNE_CPUFLAG_TRBOBST	TRBOBST
CNE_CPUFLAG_ARAT	ARAT
CNE_CPUFLAG_PLN	PLN
CNE_CPUFLAG_ECMD	ECMD
CNE_CPUFLAG_PTM	PTM
CNE_CPUFLAG_MPERF_APERF_MSR	MPERF_APERF_MSR
CNE_CPUFLAG_ACNT2	ACNT2
CNE_CPUFLAG_ENERGY_EFF	ENERGY_EFF
CNE_CPUFLAG_FSGSBASE	FSGSBASE
CNE_CPUFLAG_BMI1	BMI1
CNE_CPUFLAG_HLE	Hardware Lock elision
CNE_CPUFLAG_AVX2	AVX2
CNE_CPUFLAG_SMEP	SMEP
CNE_CPUFLAG_BMI2	BMI2
CNE_CPUFLAG_ERMS	ERMS
CNE_CPUFLAG_INVPCID	INVPCID
CNE_CPUFLAG_RTM	Transactional memory
CNE_CPUFLAG_AVX512F	AVX512F
CNE_CPUFLAG_RDSEED	RDSEED instruction
CNE_CPUFLAG_LAHF_SAHF	LAHF_SAHF
CNE_CPUFLAG_LZCNT	LZCNT
CNE_CPUFLAG_SYSCALL	SYSCALL
CNE_CPUFLAG_XD	XD
CNE_CPUFLAG_1GB_PG	1GB_PG
CNE_CPUFLAG_RDTSCP	RDTSCP
CNE_CPUFLAG_EM64T	EM64T
CNE_CPUFLAG_INVTSC	INVTSC
CNE_CPUFLAG_AVX512DQ	AVX512 Doubleword and Quadword
CNE_CPUFLAG_AVX512IFMA	AVX512 Integer Fused Multiply-Add
CNE_CPUFLAG_AVX512CD	AVX512 Conflict Detection
CNE_CPUFLAG_AVX512BW	AVX512 Byte and Word
CNE_CPUFLAG_AVX512VL	AVX512 Vector Length
CNE_CPUFLAG_AVX512VBMI	AVX512 Vector Bit Manipulation
CNE_CPUFLAG_AVX512VBMI2	AVX512 Vector Bit Manipulation 2
CNE_CPUFLAG_GFNI	Galois Field New Instructions
CNE_CPUFLAG_VAES	Vector AES
CNE_CPUFLAG_VPCLMULQDQ	Vector Carry-less Multiply
CNE_CPUFLAG_AVX512VNNI	AVX512 Vector Neural Network Instructions
CNE_CPUFLAG_AVX512BITALG	AVX512 Bit Algorithms
CNE_CPUFLAG_AVX512VPOPCNTDQ	AVX512 Vector Popcount
CNE_CPUFLAG_CLDEMOTE	Cache Line Demote
CNE_CPUFLAG_MOVDIRI	Direct Store Instructions
CNE_CPUFLAG_MOVDIR64B	Direct Store Instructions 64B
CNE_CPUFLAG_AVX512VP2INTERSECT	AVX512 Two Register Intersection
CNE_CPUFLAG_WAITPKG	umonitor/umwait/tpause
CNE_CPUFLAG_NUMFLAGS	This should always be the last!

Definition at line 27 of file cne_cpuflags.h.

Function Documentation

cne_cpu_get_flag_name()

CNDP_API const char* cne_cpu_get_flag_name

(

enum cne_cpu_flag_t

feature

)

Get name of CPU flag

Parameters

feature

CPU flag ID

Returns

flag name NULL if flag ID is invalid

cne_cpu_get_flag_enabled()

CNDP_API int cne_cpu_get_flag_enabled

(

enum cne_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

cne_cpu_is_supported()

CNDP_API int cne_cpu_is_supported

(

void

)

This function checks that the currently used CPU supports the CPU features that were specified at compile time. This version returns a result so that decisions may be made (for instance, graceful shutdowns).

cne_cpu_getauxval()

CNDP_API unsigned long cne_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.

Parameters

type	Type of aux value to retrieve

Returns

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

cne_cpu_strcmp_auxval()

CNDP_API int cne_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.

Parameters

type	Type of aux value to retrieve
str	The string pointer to compare

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.

cne_cpu_rtm_is_supported()

CNDP_API bool cne_cpu_rtm_is_supported

(

void

)

The following cne_cpu_*_is_supported() APIs are provided to quickly determine whether a cpu flag is set. They are faster than than parsing the feature flag by name. Determine if rtm cpu flag is set

When the rtm cpu flag is set, then transactional memory instructions can be executed.

Returns

true if rtm is set, otherwise false

cne_cpu_waitpkg_is_supported()

CNDP_API bool cne_cpu_waitpkg_is_supported

(

void

)

Determine if waitpkg cpu flag is set

When the waitpkg cpu flag is set, then umonitor, umwait, and tpause instructions can be executed.

Returns

true if waitpkg is set, otherwise false