icuid.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 - 2016, Kurt Cancemi ([email protected])
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef __LIBICUID_H__
#define __LIBICUID_H__

#include <icuid/icuid_err.h>
#include <icuid/icuid_limits.h>
#include <icuid/icuid_types.h>

#ifdef __cplusplus
extern "C" {
#endif

void cpuid(uint32_t eax, uint32_t *regs);

void cpuid_ext(uint32_t *regs);

int cpuid_is_supported(void);

uint64_t icuid_xgetbv(const uint32_t xcr);

typedef enum {
    /* cpuid 0x00000001, ecx */
    CPU_FEATURE_PNI = 0,       
    CPU_FEATURE_PCLMULDQ,      
    CPU_FEATURE_DTS64,         
    CPU_FEATURE_MONITOR,       
    CPU_FEATURE_DS_CPL,        
    CPU_FEATURE_VMX,           
    CPU_FEATURE_SMX,           
    CPU_FEATURE_EST,           
    CPU_FEATURE_TM2,           
    CPU_FEATURE_SSSE3,         
    CPU_FEATURE_CID,           
    CPU_FEATURE_SDBG,          
    CPU_FEATURE_FMA,           
    CPU_FEATURE_CX16,          
    CPU_FEATURE_XTPR,          
    CPU_FEATURE_PDCM,          
    /* 16 Reserved */
    CPU_FEATURE_PCID,          
    CPU_FEATURE_DCA,           
    CPU_FEATURE_SSE4_1,        
    CPU_FEATURE_SSE4_2,        
    CPU_FEATURE_X2APIC,        
    CPU_FEATURE_MOVBE,         
    CPU_FEATURE_POPCNT,        
    CPU_FEATURE_TSC_DEADLINE,  
    CPU_FEATURE_AES,           
    CPU_FEATURE_XSAVE,         
    CPU_FEATURE_OSXSAVE,       
    CPU_FEATURE_AVX,           
    CPU_FEATURE_F16C,          
    CPU_FEATURE_RDRAND,        
    CPU_FEATURE_HYPERVISOR,    
    /* cpuid 0x00000001, edx */
    CPU_FEATURE_FPU,           
    CPU_FEATURE_VME,           
    CPU_FEATURE_DE,            
    CPU_FEATURE_PSE,           
    CPU_FEATURE_TSC,           
    CPU_FEATURE_MSR,           
    CPU_FEATURE_PAE,           
    CPU_FEATURE_MCE,           
    CPU_FEATURE_CX8,           
    CPU_FEATURE_APIC,          
    /* 10 Reserved */
    CPU_FEATURE_SEP,           
    CPU_FEATURE_MTRR,          
    CPU_FEATURE_PGE,           
    CPU_FEATURE_MCA,           
    CPU_FEATURE_CMOV,          
    CPU_FEATURE_PAT,           
    CPU_FEATURE_PSE36,         
    CPU_FEATURE_PN,            
    CPU_FEATURE_CLFLUSH,       
    CPU_FEATURE_DTS,           
    CPU_FEATURE_ACPI,          
    CPU_FEATURE_MMX,           
    CPU_FEATURE_FXSR,          
    CPU_FEATURE_SSE,           
    CPU_FEATURE_SSE2,          
    CPU_FEATURE_SS,            
    CPU_FEATURE_HT,            
    CPU_FEATURE_TM,            
    CPU_FEATURE_IA64,          
    CPU_FEATURE_PBE,           
    /* cpuid 0x00000007, ebx */
    CPU_FEATURE_FSGSBASE,      
    CPU_FEATURE_TSC_ADJUST,    
    CPU_FEATURE_SGX,           
    CPU_FEATURE_BMI1,          
    CPU_FEATURE_HLE,           
    CPU_FEATURE_AVX2,          
    /* 6 Reserved */
    CPU_FEATURE_SMEP,          
    CPU_FEATURE_BMI2,          
    CPU_FEATURE_ERMS,          
    CPU_FEATURE_INVPCID,       
    CPU_FEATURE_RTM,           
    CPU_FEATURE_CQM,           
    /* 13 Reserved */
    CPU_FEATURE_MPX,           
    /* 15 Reserved */
    CPU_FEATURE_AVX512F,       
    CPU_FEATURE_AVX512DQ,      
    CPU_FEATURE_RDSEED,        
    CPU_FEATURE_ADX,           
    CPU_FEATURE_SMAP,          
    /* 21 Reserved */
    CPU_FEATURE_PCOMMIT,       
    CPU_FEATURE_CLFLUSHOPT,    
    CPU_FEATURE_CLWB,          
    CPU_FEATURE_AVX512PF,      
    CPU_FEATURE_AVX512ER,      
    CPU_FEATURE_AVX512CD,      
    CPU_FEATURE_SHA,           
    CPU_FEATURE_AVX512BW,      
    CPU_FEATURE_AVX512VL,      
    /* cpuid 0x80000001, ecx */
    CPU_FEATURE_LAHF_LM,       
    CPU_FEATURE_CMP_LEGACY,    
    CPU_FEATURE_SVM,           
    CPU_FEATURE_EXTAPIC,       
    CPU_FEATURE_CR8_LEGACY,    
    CPU_FEATURE_ABM,           
    CPU_FEATURE_SSE4A,         
    CPU_FEATURE_MISALIGNSSE,   
    CPU_FEATURE_3DNOWPREFETCH, 
    CPU_FEATURE_OSVW,          
    CPU_FEATURE_IBS,           
    CPU_FEATURE_XOP,           
    CPU_FEATURE_SKINIT,        
    CPU_FEATURE_WDT,           
    /* 14 Reserved */
    CPU_FEATURE_LWP,           
    CPU_FEATURE_FMA4,          
    CPU_FEATURE_TCE,           
    /* 18 Reserved */
    CPU_FEATURE_NODEID_MSR,    
    /* 20 Reserved */
    CPU_FEATURE_TBM,           
    CPU_FEATURE_TOPOEXT,       
    CPU_FEATURE_PERFCTR_CORE,  
    CPU_FEATURE_PERFCTR_NB,    
    /* 25 Reserved */
    CPU_FEATURE_BPEXT,         
    /* 27 Reserved */
    CPU_FEATURE_PERFCTR_L2,    
    CPU_FEATURE_MONITORX,      
    /* cpuid 0x80000001, edx */
    /* 0-10 Reserved */
    CPU_FEATURE_SYSCALL,       
    /* 12-19 Reserved */
    CPU_FEATURE_NX,            
    /* 21 Reserved */
    CPU_FEATURE_MMXEXT,        
    /* 23-24 Reserved */
    CPU_FEATURE_FXSR_OPT,      
    CPU_FEATURE_PDPE1GB,       
    CPU_FEATURE_RDTSCP,        
    /* 28 Reserved */
    CPU_FEATURE_LM,            
    CPU_FEATURE_3DNOWEXT,      
    CPU_FEATURE_3DNOW,         
    /* cpuid 0x80000007, edx */
    CPU_FEATURE_TS,            
    CPU_FEATURE_FID,           
    CPU_FEATURE_VID,           
    CPU_FEATURE_TTP,           
    CPU_FEATURE_TM_AMD,        
    CPU_FEATURE_STC,           
    CPU_FEATURE_100MHZSTEPS,   
    CPU_FEATURE_HWPSTATE,      
    CPU_FEATURE_CONSTANT_TSC,  
    CPU_FEATURE_CPB,           
    CPU_FEATURE_APERFMPERF,    
    CPU_FEATURE_PFI,           
    CPU_FEATURE_PA,            
    /* 13-31 Reserved */

    /* cpuid 0x80000008, ebx */
    CPU_FEATURE_CLZERO,        
    CPU_FEATURE_IRPERF,        
    /* 2-31 Reserved */

    /* cpuid 0x8000001F, eax */
    CPU_FEATURE_SME,           
    /* 1-31 Reserved */

    NUM_CPU_FEATURES,
} cpuid_feature_t;

typedef enum {
    VENDOR_UNKNOWN = 0, 
    VENDOR_INTEL,       
    VENDOR_AMD,         
    VENDOR_CYRIX,       
    VENDOR_NEXGEN,      
    VENDOR_TRANSMETA,   
    VENDOR_UMC,         
    VENDOR_CENTAUR,     
    VENDOR_RISE,        
    VENDOR_SIS,         
    VENDOR_NSC,         
    VENDOR_VIA,         
    VENDOR_HV_KVM,      
    VENDOR_HV_HYPERV,   
    VENDOR_HV_VMWARE,   
    VENDOR_HV_XEN,      
    NUM_CPU_VENDORS,
} cpu_vendor_t;

typedef enum {
    XFEATURE_FP = 0,    
    XFEATURE_SSE,       
    XFEATURE_AVX,       
    XFEATURE_BNDREGS,   
    XFEATURE_BNDCSR,    
    XFEATURE_OPMASK,    
    XFEATURE_ZMM_Hi256, 
    XFEATURE_Hi16_ZMM,  
    XFEATURE_IA32_XSS,  
    XFEATURE_PKRU,      
    NUM_XFEATURES,
} xfeature_t;

typedef struct {
    uint32_t cpuid[MAX_CPUID_LEVEL][4];

    uint32_t cpuid_ext[MAX_EXT_CPUID_LEVEL][4];

    uint32_t intel_dc[MAX_INTEL_DC_LEVEL][4];

    uint32_t intel_et[MAX_INTEL_ET_LEVEL][4];
} cpuid_raw_data_t;

typedef struct {
    char vendor_str[VENDOR_STR_MAX];
    char brand_str[BRAND_STR_MAX];

    cpu_vendor_t vendor;

    uint8_t family;
    uint8_t model;
    uint8_t stepping;
    uint8_t ext_family;
    uint8_t ext_model;
    uint8_t type;
    uint32_t signature;
    const char *codename;

    uint32_t cpuid_max_basic;
    uint32_t cpuid_max_ext;
    uint8_t flags[CPU_FLAGS_MAX];

    uint32_t cores;

    uint32_t logical_cpus;

    uint32_t l1_data_cache;

    uint32_t l1_instruction_cache;

    uint32_t l2_cache;

    uint32_t l3_cache;

    uint32_t l1_associativity;

    uint32_t l2_associativity;

    uint32_t l3_associativity;

    uint32_t l1_cacheline;

    uint32_t l2_cacheline;

    uint32_t l3_cacheline;

    uint32_t physical_address_bits;

    uint32_t virtual_address_bits;

    uint8_t xfeatures[XFEATURE_FLAGS_MAX];
} cpuid_data_t;

const char *cpu_feature_str(cpuid_feature_t feature);

int cpuid_get_raw_data(cpuid_raw_data_t *raw);

int cpuid_serialize_raw_data(cpuid_raw_data_t *raw, const char *file);

int cpuid_deserialize_raw_data(cpuid_raw_data_t *raw, const char *file);

int icuid_identify(cpuid_raw_data_t *raw, cpuid_data_t *data);

#ifdef __cplusplus
}
#endif

#endif /* __LIBICUID_H__ */