System.Cpuid

This module provides the function cpuid for accessing the cpuid instruction on modern IA-32 processors. Additionally, some convenience functions are provided, which perform some of the (really complicated and obstruse) decoding.

As an example, you may use the following program to determine some characteristics of your machine:

module Main(main) where

import Text.Printf (printf, )
import System.Cpuid

main :: IO ()
main = do
   (a, b, c, d) <- cpuid 0
   _ <- printf "Basic CPUID usage: EAX=0: %8x %8x %8x %8x\n\n" a b c d
   _ <- printf "Vendor string: %s\n\n" =<< vendorString
   _ <- printf "Brand string: %s\n\n" =<< brandString
   putStrLn "Cache information:"
   putStrLn . unlines .
      map (\ v -> "  " ++ show v) =<< cacheInfo
   p <- processorInfo
   _ <- printf "Processor info: family: %d, model: %d, stepping: %d, processor type: %d\n"
      (piFamily p) (piModel p) (piStepping p) (piType p)
   return ()

Functions

cpuid :: Word32 -> IO (Word32, Word32, Word32, Word32)

Execute the cpuid instructions with the given argument in the EAX register. Return the values of the registers EAX, EBX, ECX and EDX in that order.

processorInfo :: IO ProcessorInfo

Retrieve basic processor information from the processor using the cpuid instruction.

vendorString :: IO String

Execute the cpuid instruction and return the vendor string reported by that instruction.

brandString :: IO String

Execute the cpuid instruction and return the brand string (processor name and maximum frequency) reported by that instruction.

cacheInfo :: IO [CacheInfo]

Fetch all available cache information from the processor, using the cpuid instruction. The list is not ordered.

Data types

data Associativity

Cache associativity. For some entries, this is not specified in the manual. We report these as DirectMapped.

Constructors

SetAssociative Ways

DirectMapped

Instances

Show Associativity

Defined in System.Cpuid

Methods

showsPrec :: Int -> Associativity -> ShowS

show :: Associativity -> String

showList :: [Associativity] -> ShowS

data PageSize

Page size. Some entries can have alternative page sizes, therefore the complicated type.

Constructors

PageSize Int

PageSizeOr PageSize PageSize

Instances

Show PageSize

Defined in System.Cpuid

Methods

showsPrec :: Int -> PageSize -> ShowS

show :: PageSize -> String

showList :: [PageSize] -> ShowS

newtype Ways

Associativity in a set-associative cache.

Constructors

Ways Int

Instances

Show Ways

Defined in System.Cpuid

Methods

showsPrec :: Int -> Ways -> ShowS

show :: Ways -> String

showList :: [Ways] -> ShowS

newtype Entries

Number of entries in a TLB.

Constructors

Entries Int

Instances

Show Entries

Defined in System.Cpuid

Methods

showsPrec :: Int -> Entries -> ShowS

show :: Entries -> String

showList :: [Entries] -> ShowS

data CacheSize

Cache size. Some entries can have alternative cache sizes, therefore the complicated type.

Constructors

CacheSize Int

CacheSizeOr CacheSize CacheSize

Instances

Show CacheSize

Defined in System.Cpuid

Methods

showsPrec :: Int -> CacheSize -> ShowS

show :: CacheSize -> String

showList :: [CacheSize] -> ShowS

data CacheInfo

Information for caches and TLBs.

Constructors

InstructionTLB (Maybe CacheSize) PageSize Associativity Entries

Configuration of code TLB.

DataTLB (Maybe CacheSize) PageSize Associativity Entries

Configuration of data TLB.

FirstLevelICache CacheSize Associativity LineSize

First-level code cache configuration.

FirstLevelDCache CacheSize Associativity LineSize

First-level code cache configuration.

NoSecondLevelCache

No second level support.

SecondLevelCache CacheSize Associativity LineSize (Maybe BytesPerSector)

Second-level cache configuration.

NoThirdLevelCache

No third level support.

NoSecondOrThirdLevelCache

Internal use only.

ThirdLevelCache CacheSize Associativity LineSize (Maybe BytesPerSector)

Second-level cache configuration.

TraceCache MuOps Associativity

Trace cache (1st-level code cache) configuration.

Prefetching Int

Prefetching information.

Instances

Show CacheInfo

Defined in System.Cpuid

Methods

showsPrec :: Int -> CacheInfo -> ShowS

show :: CacheInfo -> String

showList :: [CacheInfo] -> ShowS

newtype LineSize

Line size in a cache.

Constructors

LineSize Int

Instances

Show LineSize

Defined in System.Cpuid

Methods

showsPrec :: Int -> LineSize -> ShowS

show :: LineSize -> String

showList :: [LineSize] -> ShowS

newtype MuOps

MuOps in a processors trace cache.

Constructors

MuOps Int

Instances

Show MuOps

Defined in System.Cpuid

Methods

showsPrec :: Int -> MuOps -> ShowS

show :: MuOps -> String

showList :: [MuOps] -> ShowS

newtype BytesPerSector

Bytes per sector in a cache.

Constructors

BytesPerSector Int

Instances

Show BytesPerSector

Defined in System.Cpuid

Methods

showsPrec :: Int -> BytesPerSector -> ShowS

show :: BytesPerSector -> String

showList :: [BytesPerSector] -> ShowS

data ProcessorInfo

Processor information.

Constructors

ProcessorInfo

Fields

• piFamily :: Int

  Processor family.

• piModel :: Int

  Processor model.

• piStepping :: Int

  Processor stepping.

• piType :: Int

Features

features :: IO (FlagSet Feature1C, FlagSet Feature1D)

type FlagSet = T Word32

testFlag :: Enum a => a -> FlagSet a -> Bool

data Feature1C

features as found in page 1, register C

Instances

Bounded Feature1C

Defined in System.Cpuid

Methods

minBound :: Feature1C

maxBound :: Feature1C

Enum Feature1C

Defined in System.Cpuid

Methods

succ :: Feature1C -> Feature1C

pred :: Feature1C -> Feature1C

toEnum :: Int -> Feature1C

fromEnum :: Feature1C -> Int

enumFrom :: Feature1C -> [Feature1C]

enumFromThen :: Feature1C -> Feature1C -> [Feature1C]

enumFromTo :: Feature1C -> Feature1C -> [Feature1C]

enumFromThenTo :: Feature1C -> Feature1C -> Feature1C -> [Feature1C]

Show Feature1C

Defined in System.Cpuid

Methods

showsPrec :: Int -> Feature1C -> ShowS

show :: Feature1C -> String

showList :: [Feature1C] -> ShowS

Eq Feature1C

Defined in System.Cpuid

Methods

(==) :: Feature1C -> Feature1C -> Bool

(/=) :: Feature1C -> Feature1C -> Bool

Ord Feature1C

Defined in System.Cpuid

Methods

compare :: Feature1C -> Feature1C -> Ordering

(<) :: Feature1C -> Feature1C -> Bool

(<=) :: Feature1C -> Feature1C -> Bool

(>) :: Feature1C -> Feature1C -> Bool

(>=) :: Feature1C -> Feature1C -> Bool

max :: Feature1C -> Feature1C -> Feature1C

min :: Feature1C -> Feature1C -> Feature1C

sse3 :: Feature1C

pclmulqdq :: Feature1C

dtes64 :: Feature1C

monitor :: Feature1C

dscpl :: Feature1C

vmx :: Feature1C

smx :: Feature1C

est :: Feature1C

tm2 :: Feature1C

ssse3 :: Feature1C

cnxtid :: Feature1C

fma :: Feature1C

cmpxchg16b :: Feature1C

xtpr :: Feature1C

pdcm :: Feature1C

pcid :: Feature1C

dca :: Feature1C

sse4_1 :: Feature1C

sse4_2 :: Feature1C

x2apic :: Feature1C

movbe :: Feature1C

popcnt :: Feature1C

deadline :: Feature1C

aes :: Feature1C

xsave :: Feature1C

osxsave :: Feature1C

avx :: Feature1C

f16c :: Feature1C

rdrand :: Feature1C

hypervisor :: Feature1C

data Feature1D

features as found in page 1, register D

Instances

Bounded Feature1D

Defined in System.Cpuid

Methods

minBound :: Feature1D

maxBound :: Feature1D

Enum Feature1D

Defined in System.Cpuid

Methods

succ :: Feature1D -> Feature1D

pred :: Feature1D -> Feature1D

toEnum :: Int -> Feature1D

fromEnum :: Feature1D -> Int

enumFrom :: Feature1D -> [Feature1D]

enumFromThen :: Feature1D -> Feature1D -> [Feature1D]

enumFromTo :: Feature1D -> Feature1D -> [Feature1D]

enumFromThenTo :: Feature1D -> Feature1D -> Feature1D -> [Feature1D]

Show Feature1D

Defined in System.Cpuid

Methods

showsPrec :: Int -> Feature1D -> ShowS

show :: Feature1D -> String

showList :: [Feature1D] -> ShowS

Eq Feature1D

Defined in System.Cpuid

Methods

(==) :: Feature1D -> Feature1D -> Bool

(/=) :: Feature1D -> Feature1D -> Bool

Ord Feature1D

Defined in System.Cpuid

Methods

compare :: Feature1D -> Feature1D -> Ordering

(<) :: Feature1D -> Feature1D -> Bool

(<=) :: Feature1D -> Feature1D -> Bool

(>) :: Feature1D -> Feature1D -> Bool

(>=) :: Feature1D -> Feature1D -> Bool

max :: Feature1D -> Feature1D -> Feature1D

min :: Feature1D -> Feature1D -> Feature1D

fpu :: Feature1D

vme :: Feature1D

de :: Feature1D

pse :: Feature1D

tsc :: Feature1D

msr :: Feature1D

pae :: Feature1D

mce :: Feature1D

cx8 :: Feature1D

apic :: Feature1D

sep :: Feature1D

mtrr :: Feature1D

pge :: Feature1D

mca :: Feature1D

cmov :: Feature1D

pat :: Feature1D

pse36 :: Feature1D

psn :: Feature1D

clfsh :: Feature1D

ds :: Feature1D

acpi :: Feature1D

mmx :: Feature1D

fxsr :: Feature1D

sse :: Feature1D

sse2 :: Feature1D

ss :: Feature1D

htt :: Feature1D

tm :: Feature1D

ia64 :: Feature1D

pbe :: Feature1D