]> git.ozlabs.org Git - ccan/blobdiff - ccan/cpuid/cpuid.h
cpuid: better parser for processor info
[ccan] / ccan / cpuid / cpuid.h
index 8c0b9b10487b5383b70c03e3c40855d12994a4a7..bf6c5113fb589a1de54071be8a7fa5b21a2e5c1e 100644 (file)
 #ifndef CCAN_CPUID_H
 #define CCAN_CPUID_H
 
+#include <stdbool.h>
+#include <stdint.h>
+
 /**
- * enum cpuid - stuff to get information on from the CPU.
+ * enum cpuid - stuff to get information about from the CPU.
  *
  * This is used as a parameter in cpuid().
  *
@@ -66,70 +69,33 @@ typedef enum cpuid {
 
        CPU_HIGHEST_EXTENDED_FUNCTION_SUPPORTED         = 0x80000000,
        CPU_EXTENDED_PROC_INFO_FEATURE_BITS             = 0x80000001,
-       CPU_PROC_BRAND_STRING                           = 0x80000002, 
+       CPU_PROC_BRAND_STRING                           = 0x80000002,
        CPU_L1_CACHE_AND_TLB_IDS                        = 0x80000005,
        CPU_EXTENDED_L2_CACHE_FEATURES                  = 0x80000006,
        CPU_ADV_POWER_MGT_INFO                          = 0x80000007,
        CPU_VIRT_PHYS_ADDR_SIZES                        = 0x80000008
 } cpuid_t;
 
-/**
- * enum cpufeature
- *
- * This is used by cpuid_has_feature().
- *
- * CF_MMX:
- *     Test for MMX support.
- *
- * CF_SSE*:
- *     Test for SSE* support.
- *
- * CF_AVX:
- *     Test for AVX support.
- *
- * CF_FMA:
- *     Test for FMA support.
- */
-
-typedef enum cpufeature {
-       CF_MMX          = 1 << 23,
-       CF_SSE          = 1 << 25,
-       CF_SSE2         = 1 << 26,
-       CF_SSE3         = 1 << 0,
+#define CF_MMX                 0
+#define CF_SSE                 1
+#define CF_SSE2        2
+#define CF_SSE3        3
+#define CF_FPU                 4
+#define CF_TSC                 5
+#define CF_MSR                 6
+#define CF_SSSE3       7
+#define CF_AVX                 8
+#define CF_FMA                 9
 
-       CF_SSSE3        = 1 << 9,
-       CF_SSE41        = 1 << 19,
-       CF_SSE42        = 1 << 20,
+#define CEF_x64        10
+#define CEF_FPU        11
+#define CEF_DE                 12
+#define CEF_SYSCALLRET         13
+#define CEF_CMOV       14
+#define CEF_SSE4a      15
+#define CEF_FMA4       16
+#define CEF_XOP        17
 
-       CF_AVX          = 1 << 28,
-       CF_FMA          = 1 << 12
-} cpufeature_t;
-
-/**
- * enum cpuextfeature - Test for an extended feature provided by the CPU
- *
- * This is used by cpuid_has_ext_feature()
- *
- * CEF_x64:
- *     Test for 64-bits.
- *
- * CEF_SSE4a:
- * CEF_FMA4:
- * CEF_XOP:
- *     Test for SSE4a/FMA4/XOP
- */
-typedef enum cpuextfeature {
-       CEF_x64         = 1 << 29,
-       CEF_SSE4a       = 1 << 6,
-       CEF_FMA4        = 1 << 16,
-       CEF_XOP         = 1 << 11
-} cpuextfeature_t;
-
-/**
- * enum cputype - CPU type
- *
- * Warning, do not change this order or odd stuff may happen.
- */
 typedef enum cputype {
        CT_NONE,
        CT_AMDK5,
@@ -148,33 +114,41 @@ typedef enum cputype {
        CT_KVM
 } cputype_t;
 
+#if defined(__i386__) || defined(__i386) || defined(__x86_64) \
+       || defined(_M_AMD64) || defined(__M_X64)
+
 /**
- * get_cpu_type - Get CPU Type
+ * cpuid_get_cpu_type - Get CPU Type
  *
  * Returns the CPU Type as cputype_t.
+ *
+ * See also: cpuid_get_cpu_type_string()
  */
-cputype_t get_cpu_type(void);
+#define is_intel_cpu()         cpuid_get_cpu_type() == CT_INTEL
+#define is_amd_cpu()   cpuid_get_cpu_type() == CT_AMDK5 || cpuid_get_cpu_type() == CT_AMD
+cputype_t cpuid_get_cpu_type(void);
 
 /**
- * get_cpu_type_string - Get CPU Type string
+ * cpuid_sprintf_cputype - Get CPU Type string
+ * @cputype: a char of atleast 12 bytes in it.
  *
- * Returns the CPU type string based off cputype_t.
+ * Returns true on success, false on failure
  */
-const char *get_cpu_type_string(const cputype_t cputype);
+bool cpuid_sprintf_cputype(const cputype_t cputype, char *buf);
 
 /**
  * cpuid_is_supported - test if the CPUID instruction is supported
  *
  * CPUID is not supported by old CPUS.
  *
- * Returns 1 if the cpuid instruction is supported, 0 otherwise.
+ * Returns true if the cpuid instruction is supported, false otherwise.
  *
  * See also: cpuid()
  */
-int cpuid_is_supported(void);
+bool cpuid_is_supported(void);
 
 /**
- * highest_ext_func_supported - Get the highest extended function supported
+ * cpuid_highest_ext_func_supported - Get the highest extended function supported
  *
  *
  * Returns the highest extended function supported.
@@ -187,7 +161,7 @@ int cpuid_is_supported(void);
  *
  * See also: cpuid()
  */
-int highest_ext_func_supported(void);
+uint32_t cpuid_highest_ext_func_supported(void);
 
 /**
  * cpuid - Get Some information from the CPU.
@@ -199,75 +173,106 @@ int highest_ext_func_supported(void);
  *     Returns a string into buf.
  *
  * For CPU_PROCINFO_AND_FEATUREBITS:
- *     buf[0]:
- *             - 3:0 - Stepping
- *             - 7:4 - Model
- *             - 11:8 - Family
- *             - 13:12 - Processor Type
- *             - 19:16 - Extended Model
- *             - 27:20 - Extended family
- *     buf[1] and buf[2]:
+ *     buf[0]: Stepping
+ *     buf[1]: Model
+ *     buf[2]: Family
+ *     buf[3]: Extended Model
+ *     buf[4]: Extended Family
+ *     buf[5] and buf[6]:
  *             Feature flags
- *     buf[3]:
+ *     buf[7]:
  *             Additional feature information.
  *
+ * For CPU_L1_CACHE_AND_TLB_IDS:
+ *     buf[0]: (eax):
+ *             - 7..0  Number of times to exec cpuid to get all descriptors.
+ *             - 15..8 Instruction TLB: 4K Pages, 4-way set associtive, 128 entries.
+ *             - 23..16 Data TLB: 4k Pages, 4-way set associtive, 128 entries.
+ *             - 24..31 Instruction TLB: 4K Pages, 4-way set associtive, 2 entries.
+ *     buf[1]: (ebx):
+ *             - 7..0 64-byte prefetching
+ *             - 8..31 Null descriptor
+ *     buf[2]: (ecx):
+ *             - 0..31 Null descriptor
+ *     buf[3]: (edx):
+ *             - 7..0 2nd-level cache, 2M, 8-way set associtive, 64-byte line size
+ *             - 15..8 1st-level instruction cache: 32K, 8-way set associtive, 64 byte line size
+ *             - 16..23 Data TLB: 4M Pages, 4-way set associtive, 8 entires.
+ *             - 24..31 1st-level data cache: 32K, 8-way set associtive, 64 byte line size
+ *
  * For CPU_HIGHEST_EXTENDED_FUNCTION_SUPPORTED:
  *     Returns the highest supported function in *buf (expects an integer ofc)
  *
  * For CPU_EXTENDED_PROC_INFO_FEATURE_BITS:
  *     Returns them in buf[0] and buf[1].
  *
+ * For CPU_EXTENDED_L2_CACHE_FEATURES:
+ *     buf[0]: Line size
+ *     buf[1]: Associativity
+ *     buf[2]: Cache size.
+ *
  * For CPU_VIRT_PHYS_ADDR_SIZES:
- *     Returns it as an integer in *buf.
+ *     buf[0]: Physical
+ *     buf[1]: Virtual
  *
  * For CPU_PROC_BRAND_STRING:
  *     Have a char array with at least 48 bytes assigned to it.
  *
+ * Here's a page which will help you parse the data provided by this function.
+ *     http://www.flounder.com/cpuid_explorer2.htm
+ *
  * If an invalid flag has been passed a 0xbaadf00d is returned in *buf.
  */
-void cpuid(cpuid_t info, void *buf);
+void cpuid(cpuid_t info, uint32_t *buf);
 
 /**
  * cpuid_test_feature - Test if @feature is available
  *
- * Returns 1 if feature is supported, 0 otherwise.
+ * Returns true if feature is supported, false otherwise.
  *
  * The feature parameter must be >= CPU_EXTENDED_PROC_INFO_FEATURE_BITS
  *  and <= CPU_VIRT_PHYS_ADDR_SIZES.
  */
-int cpuid_test_feature(cpuid_t feature);
+bool cpuid_test_feature(cpuid_t feature);
 
 /**
  * cpuid_has_feature - Test if @feature is supported
  *
- * Test if the CPU supports MMX/SSE* etc
+ * Test if the CPU supports MMX/SSE* etc.
+ * For the extended parameter, usually you want to pass it as
+ * false if you're not passing CEF_*.
  *
- * Returns 1 if the feature is available, 0 otherwise.
- */
-#define cpuid_has_mmx()        cpuid_has_feature(CF_MMX)
-#define cpuid_has_sse()        cpuid_has_feature(CF_SSE)
-#define cpuid_has_sse2()       cpuid_has_feature(CF_SSE2)
-#define cpuid_has_sse3()       cpuid_has_feature(CF_SSE3)
-#define cpuid_has_ssse3()      cpuid_has_feature(CF_SSSE3)
-#define cpuid_has_sse41()      cpuid_has_feature(CF_SSE41)
-#define cpuid_has_sse42()      cpuid_has_feature(CF_SSE42)
-#define cpuid_has_avx()        cpuid_has_feature(CF_AVX)
-#define cpuid_has_fma()        cpuid_has_feature(CF_FMA)
-int cpuid_has_feature(cpufeature_t feature);
-
-/**
- * cpuid_has_ext_feature - Test if @extfeature is an extended feature
- * that's supported by the CPU.
- *
- * Test if the CPU supports this extended feature.
+ * For more information about the CPU extended features, have a look
+ * at:
+ *     http://en.wikipedia.org/wiki/CPUID
  *
- * Returns 1 if available, 0 otherwise.
+ * Returns true if the feature is available, false otherwise.
  */
-#define cpuid_has_x64()        cpuid_has_ext_feature(CEF_x64)
-#define cpuid_has_sse4a()      cpuid_has_ext_feature(CEF_SSE4a)
-#define cpuid_has_fma4()       cpuid_has_ext_feature(CEF_FMA4)
-#define cpuid_has_xop()        cpuid_has_ext_feature(CEF_XOP)
-int cpuid_has_ext_feature(cpuextfeature_t extfeature);
+#define cpuid_has_mmx()        cpuid_has_feature(CF_MMX,       false)
+#define cpuid_has_sse()        cpuid_has_feature(CF_SSE,       false)
+#define cpuid_has_sse2()       cpuid_has_feature(CF_SSE2,      false)
+#define cpuid_has_sse3()       cpuid_has_feature(CF_SSE3,      false)
+#define cpuid_has_ssse3()      cpuid_has_feature(CF_SSSE3,     false)
+#define cpuid_has_avx()        cpuid_has_feature(CF_AVX,       false)
+#define cpuid_has_fma()        cpuid_has_feature(CF_FMA,       false)
+#define cpuid_has_x64()        cpuid_has_feature(CEF_x64,      true)
+#define cpuid_has_sse4a()      cpuid_has_feature(CEF_SSE4a,    true)
+#define cpuid_has_fma4()       cpuid_has_feature(CEF_FMA4,     true)
+#define cpuid_has_xop()        cpuid_has_feature(CEF_XOP,      true)
+bool cpuid_has_feature(int feature, bool extended);
 
-#endif
+#else
+#include <ccan/build_assert/build_assert.h>
+
+#define cpuid_get_cpu_type()                   BUILD_ASSERT_OR_ZERO(0)
+#define cpuid_get_cpu_type_string()            BUILD_ASSERT_OR_ZERO(0)
 
+#define cpuid_is_supported()                   BUILD_ASSERT_OR_ZERO(0)
+#define cpuid(info, buf)                       BUILD_ASSERT_OR_ZERO(0)
+
+#define cpuid_highest_ext_func_supported()     BUILD_ASSERT_OR_ZERO(0)
+#define cpuid_test_feature(feature)            BUILD_ASSERT_OR_ZERO(0)
+#define cpuid_has_feature(feature, ext)        BUILD_ASSERT_OR_ZERO(0)
+
+#endif
+#endif