diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,34 @@ + -*-outline-*- +* README file for cpuid binding + +This small Cabal package provides a Haskell binding to the "cpuid" +machine instruction on modern IA-32 processors. + +** Usage + +Use + + runghc Setup.hs configure + runghc Setup.hs build + runghc Setup.hs install + +for building and installing system-wide, or + + runghc Setup.hs configure --prefix=$HOME/haskell-modules + runghc Setup.hs build + runghc Setup.hs install --user + +for building and installing in directory $HOME/haskell-modules. + +Just import module "System.Cpuid" into your Haskell file and use + + ghc --make FILENAME + +to compile your program. + +The "tests" directory contains a small test program for the module and +demonstrates its usage. There is also a C version for this test +program, to test the overheads of Haskell's FFI. + +Happy Haskell hacking, + Martin diff --git a/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,4 @@ +#! /usr/bin/env runhaskell + +> import Distribution.Simple +> main = defaultMain diff --git a/System/Cpuid.hs b/System/Cpuid.hs new file mode 100644 --- /dev/null +++ b/System/Cpuid.hs @@ -0,0 +1,310 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +-------------------------------------------------------------------------- +-- | +-- Module: System.Cpuid +-- Copyright: (c) 2008 Martin Grabmueller +-- License: GPL +-- +-- Maintainer: magr@cs.tu-berlin.de +-- Stability: provisional +-- Portability: non-portable (requires IA-32 processor) +-- +-- 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 measure the overhead +-- of calling this function: +-- +-- > module Main(main) where +-- > +-- > import Text.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 +-- > vs <- vendorString +-- > printf "Vendor string: %s\n\n" vs +-- > vs <- brandString +-- > printf "Brand string: %s\n\n" vs +-- > printf "Cache information:\n" +-- > infos <- cacheInfo +-- > mapM_ (\ v -> putStrLn $ " " ++ show v) infos +-- > putStrLn "" +-- > ProcessorInfo{piFamily = fam, piModel = mod, piStepping = step, piType = typ} <- processorInfo +-- > printf "processor info: family: %d, model: %d, stepping: %d, processor type: %d\n" fam mod step typ +-------------------------------------------------------------------------- +module System.Cpuid + (-- * Data types + Associativity(..), + PageSize(..), + Ways(..), + Entries(..), + CacheSize(..), + CacheInfo(..), + LineSize(..), + MuOps(..), + BytesPerSector(..), + ProcessorInfo(..), + -- * Functions + cpuid, + processorInfo, + vendorString, + brandString, + cacheInfo) where + +import Foreign +import Foreign.C.String + +foreign import ccall unsafe "cpuid" _cpuid :: Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO () + +-- | 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. +cpuid :: Word32 -> IO (Word32, Word32, Word32, Word32) +cpuid val = + alloca (\ a -> + alloca (\ b -> + alloca (\ c -> + alloca (\ d -> do _cpuid val a b c d + aa <- peek a + bb <- peek b + cc <- peek c + dd <- peek d + return (aa, bb, cc, dd))))) + +-- | Execute the @cpuid@ instruction and return the vendor +-- string reported by that instruction. +vendorString :: IO String +vendorString = + do (_, b, c, d) <- cpuid 0 + allocaBytes 20 (\ str -> do let str' :: Ptr Word32 + str' = castPtr str + poke str' b + poke (str' `plusPtr` 4) d + poke (str' `plusPtr` 8) c + peekCStringLen (str, 12)) + +-- | Execute the @cpuid@ instruction and return the brand string +-- (processor name and maximum frequency) reported by that +-- instruction. +brandString :: IO String +brandString = + do allocaBytes 80 + (\ str -> + do let str' :: Ptr Word32 + str' = castPtr str + (a1, b1, c1, d1) <- cpuid 0x80000002 + poke str' a1 + poke (str' `plusPtr` 4) b1 + poke (str' `plusPtr` 8) c1 + poke (str' `plusPtr` 12) d1 + (a2, b2, c2, d2) <- cpuid 0x80000003 + poke (str' `plusPtr` 16) a2 + poke (str' `plusPtr` 20) b2 + poke (str' `plusPtr` 24) c2 + poke (str' `plusPtr` 28) d2 + (a3, b3, c3, d3) <- cpuid 0x80000004 + poke (str' `plusPtr` 32) a3 + poke (str' `plusPtr` 36) b3 + poke (str' `plusPtr` 40) c3 + poke (str' `plusPtr` 44) d3 + peekCStringLen (str, 16 * 3)) + +-- | Number of entries in a TLB. +data Entries = Entries Int + deriving (Show) + +-- | Associativity in a set-associative cache. +data Ways = Ways Int + deriving (Show) + +-- | MuOps in a processors trace cache. +data MuOps = MuOps Int + deriving (Show) + +-- | Page size. Some entries can have alternative page sizes, +-- therefore the complicated type. +data PageSize = PageSize Int + | PageSizeOr PageSize PageSize + deriving (Show) + +-- | Cache size. Some entries can have alternative cache sizes, +-- therefore the complicated type. +data CacheSize = CacheSize Int + | CacheSizeOr CacheSize CacheSize + deriving (Show) + +-- | Line size in a cache. +data LineSize = LineSize Int + deriving (Show) + +-- | Bytes per sector in a cache. +data BytesPerSector = BytesPerSector Int + deriving (Show) + +-- | Cache associativity. For some entries, this is not specified in +-- the manual. We report these as 'DirectMapped'. +data Associativity = SetAssociative Ways + | DirectMapped + deriving (Show) + +-- | Information for caches and TLBs. +data CacheInfo = 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. + deriving (Show) + +-- | Fetch all available cache information from the processor, using +-- the @cpuid@ instruction. The list is not ordered. +cacheInfo :: IO [CacheInfo] +cacheInfo = + do (a, b, c, d) <- cpuid 2 + collectCacheDescriptors (fromIntegral ((a .&. 0xff) - 1)) [] (a .&. complement 0xff) b c d + +-- | Call the @cpuid@ instruction as often as needed and merge the values. +collectCacheDescriptors :: Int -> [CacheInfo] -> Word32 -> Word32 -> Word32 -> Word32 -> IO [CacheInfo] +collectCacheDescriptors 0 infos a b c d = return $ postProcess $ updateCD infos [a, b, c, d] +collectCacheDescriptors n infos a b c d = + do let infos' = updateCD infos [a, b, c, d] + (a', b', c', d') <- cpuid 2 + collectCacheDescriptors (n - 1) infos' a' b' c' d' + +-- | Convert the strange 0x40 code to valie entries. +postProcess :: [CacheInfo] -> [CacheInfo] +postProcess infos = + let has2ndLevel = any (\ info -> case info of + SecondLevelCache{} -> True + _ -> False) infos + hasNo2ndOr3rd = any (\ info -> case info of + NoSecondOrThirdLevelCache{} -> True + _ -> False) infos + infos' = filter (\ info -> case info of + NoSecondOrThirdLevelCache{} -> False + _ -> True) infos + in if has2ndLevel + then if hasNo2ndOr3rd + then NoThirdLevelCache : infos' + else infos' + else NoSecondLevelCache : infos' + +-- | Convert the values from the registers to cache information +-- records. +updateCD :: [CacheInfo] -> [Word32] -> [CacheInfo] +updateCD infos wss = updateBytes infos (splitBytes wss) + where splitBytes :: [Word32] -> [Word8] + splitBytes [] = [] + splitBytes (w:ws) | w .&. 0x80000000 /= 0 = splitBytes ws + splitBytes (w:ws) = [fromIntegral $ w .&. 0xff, + fromIntegral $ (w `shiftR` 8) .&. 0xff, + fromIntegral $ (w `shiftR` 16) .&. 0xff, + fromIntegral $ (w `shiftR` 24) .&. 0xff] ++ splitBytes ws + updateBytes :: [CacheInfo] -> [Word8] -> [CacheInfo] + updateBytes infos' [] = infos' + updateBytes infos' (b:bs) = case lookup b cacheTable of + Nothing -> updateBytes infos' bs + Just info -> updateBytes (info : infos') bs + +-- | Convert kBytes to bytes. +kByte :: Int -> Int +kByte b = b * 1024 + +-- | Convert mBytes to bytes. +mByte :: Int -> Int +mByte b = b * 1024 * 1024 + +-- | Table of cache configuration. Information from the CPUID +-- documentation in the /IA-32 Intel Architecture Software Developer's +-- Manual Volumes 2A/. +cacheTable :: [(Word8, CacheInfo)] +cacheTable = + [ + (0x01, InstructionTLB Nothing (PageSize (kByte 4)) (SetAssociative (Ways 4)) (Entries 32)), + (0x02, InstructionTLB Nothing (PageSize (mByte 4)) (SetAssociative (Ways 4)) (Entries 2)), + (0x03, DataTLB Nothing (PageSize (kByte 4)) (SetAssociative (Ways 4)) (Entries 64)), + (0x04, DataTLB Nothing (PageSize (mByte 4)) (SetAssociative (Ways 4)) (Entries 8)), + (0x06, FirstLevelICache (CacheSize (kByte 4)) (SetAssociative (Ways 4)) (LineSize 32)), + (0x08, FirstLevelICache (CacheSize (kByte 16)) (SetAssociative (Ways 4)) (LineSize 32)), + (0x0a, FirstLevelDCache (CacheSize (kByte 8)) (SetAssociative (Ways 2)) (LineSize 32)), + (0x0c, FirstLevelDCache (CacheSize (kByte 16)) (SetAssociative (Ways 4)) (LineSize 32)), + (0x22, ThirdLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 4)) (LineSize 64) (Just (BytesPerSector 2))), + (0x23, ThirdLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x25, ThirdLevelCache (CacheSize (mByte 2)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x29, ThirdLevelCache (CacheSize (mByte 4)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x2c, FirstLevelDCache (CacheSize (kByte 32)) (SetAssociative (Ways 8)) (LineSize 64)), + (0x30, FirstLevelICache (CacheSize (kByte 32)) (SetAssociative (Ways 8)) (LineSize 64)), + (0x40, NoSecondOrThirdLevelCache), + (0x41, SecondLevelCache (CacheSize (kByte 128)) (SetAssociative (Ways 4)) (LineSize 32) Nothing), + (0x42, SecondLevelCache (CacheSize (kByte 256)) (SetAssociative (Ways 4)) (LineSize 32) Nothing), + (0x43, SecondLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 4)) (LineSize 32) Nothing), + (0x44, SecondLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 4)) (LineSize 32) Nothing), + (0x45, SecondLevelCache (CacheSize (mByte 2)) (SetAssociative (Ways 4)) (LineSize 32) Nothing), + (0x46, ThirdLevelCache (CacheSize (mByte 4)) (SetAssociative (Ways 4)) (LineSize 64) Nothing), + (0x47, ThirdLevelCache (CacheSize (mByte 8)) (SetAssociative (Ways 8)) (LineSize 64) Nothing), + (0x50, InstructionTLB (Just (CacheSize (kByte 4))) (PageSizeOr (PageSize (mByte 2)) (PageSize (mByte 4))) DirectMapped (Entries 64)), + (0x51, InstructionTLB (Just (CacheSize (kByte 4))) (PageSizeOr (PageSize (mByte 2)) (PageSize (mByte 4))) DirectMapped (Entries 128)), + (0x52, InstructionTLB (Just (CacheSize (kByte 4))) (PageSizeOr (PageSize (mByte 2)) (PageSize (mByte 4))) DirectMapped (Entries 256)), + (0x5b, DataTLB (Just (CacheSize (kByte 4))) (PageSize (mByte 4)) DirectMapped (Entries 64)), + (0x5c, DataTLB (Just (CacheSize (kByte 4))) (PageSize (mByte 4)) DirectMapped (Entries 128)), + (0x5d, DataTLB (Just (CacheSize (kByte 4))) (PageSize (mByte 4)) DirectMapped (Entries 256)), + (0x60, FirstLevelDCache (CacheSize (kByte 16)) (SetAssociative (Ways 8)) (LineSize 64)), + (0x66, FirstLevelDCache (CacheSize (kByte 8)) (SetAssociative (Ways 4)) (LineSize 64)), + (0x67, FirstLevelDCache (CacheSize (kByte 16)) (SetAssociative (Ways 4)) (LineSize 64)), + (0x68, FirstLevelDCache (CacheSize (kByte 32)) (SetAssociative (Ways 4)) (LineSize 64)), + (0x70, TraceCache (MuOps (kByte 12)) (SetAssociative (Ways 8))), + (0x71, TraceCache (MuOps (kByte 16)) (SetAssociative (Ways 8))), + (0x72, TraceCache (MuOps (kByte 32)) (SetAssociative (Ways 8))), + (0x78, SecondLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 4)) (LineSize 64) Nothing), + (0x79, SecondLevelCache (CacheSize (kByte 128)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x7a, SecondLevelCache (CacheSize (kByte 256)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x7b, SecondLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x7c, SecondLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 8)) (LineSize 64) (Just (BytesPerSector 2))), + (0x7d, SecondLevelCache (CacheSize (mByte 2)) (SetAssociative (Ways 8)) (LineSize 64) Nothing), + (0x7f, SecondLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 2)) (LineSize 64) Nothing), + (0x82, SecondLevelCache (CacheSize (kByte 256)) (SetAssociative (Ways 8)) (LineSize 32) Nothing), + (0x83, SecondLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 8)) (LineSize 32) Nothing), + (0x84, SecondLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 8)) (LineSize 32) Nothing), + (0x85, SecondLevelCache (CacheSize (mByte 2)) (SetAssociative (Ways 8)) (LineSize 32) Nothing), + (0x86, SecondLevelCache (CacheSize (kByte 512)) (SetAssociative (Ways 4)) (LineSize 64) Nothing), + (0x87, SecondLevelCache (CacheSize (mByte 1)) (SetAssociative (Ways 8)) (LineSize 64) Nothing), + (0xb0, InstructionTLB Nothing (PageSize (kByte 4)) (SetAssociative (Ways 4)) (Entries 128)), + (0xb3, DataTLB Nothing (PageSize (kByte 4)) (SetAssociative (Ways 4)) (Entries 128)), + (0xf0, Prefetching 64), + (0xf1, Prefetching 128) + ] + + +-- | Processor information. +data ProcessorInfo = ProcessorInfo{piFamily :: Int, -- ^ Processor family. + piModel :: Int, -- ^ Processor model. + piStepping :: Int, -- ^ Processor stepping. + piType :: Int -- ^ Processor type. + } + +-- | Retrieve basic processor information from the processor using the +-- @cpuid@ instruction. +processorInfo :: IO ProcessorInfo +processorInfo = + do (a, _, _, _) <- cpuid 1 + let stepping = a .&. 0xf + model = (a `shiftR` 4) .&. 0xf + family = (a `shiftR` 8) .&. 0x0f + extFamily = (a `shiftR` 20) .&. 0xff + typ = (a `shiftR` 12) .&. 0x3 + return (ProcessorInfo{piFamily = fromIntegral (if family /= 0xf + then family + else family + extFamily), + piModel = fromIntegral model, + piStepping = fromIntegral stepping, + piType = fromIntegral typ}) diff --git a/cbits/cpuid.c b/cbits/cpuid.c new file mode 100644 --- /dev/null +++ b/cbits/cpuid.c @@ -0,0 +1,12 @@ +/* #include "cpuid.h" */ + +void +cpuid(int in, int * aa, int * bb, int * cc, int * dd) +{ + int a, b, c, d; + asm("cpuid": "=a" (a), "=b" (b), "=c" (c), "=d" (d) : "a" (in)); + *aa = a; + *bb = b; + *cc = c; + *dd = d; +} diff --git a/cbits/cpuid.h b/cbits/cpuid.h new file mode 100644 --- /dev/null +++ b/cbits/cpuid.h @@ -0,0 +1,5 @@ +#define cpuid_asm(in,a,b,c,d)\ + asm("cpuid": "=a" (a), "=b" (b), "=c" (c), "=d" (d) : "a" (in)); + + +void cpuid(int in, int * aa, int * bb, int * cc, int * dd); diff --git a/cpuid.cabal b/cpuid.cabal new file mode 100644 --- /dev/null +++ b/cpuid.cabal @@ -0,0 +1,29 @@ +Cabal-version: >=1.2 +Name: cpuid +Version: 0.2 +License: GPL +License-file: COPYING +Author: Martin Grabmueller +Maintainer: magr@cs.tu-berlin.de +Homepage: http://uebb.cs.tu-berlin.de/~magr/projects/cpuid/doc/ +Category: Foreign binding +Synopsis: Binding for the cpuid machine instruction on x86 compatible + processors +Description: This module provides the function 'cpuid' for accessing + information about the currently running IA-32 processor. Both a function + for calling the 'cpuid' instruction directly, and some convenience functions + for common uses are provided. This package is only portable to IA-32 + machines. +Stability: Experimental +Build-type: Simple + +Extra-source-files: README + tests/TestCpuid.hs + +Library + Build-depends: base + Exposed-Modules: System.Cpuid + Extensions: ForeignFunctionInterface + C-sources: cbits/cpuid.c + Include-dirs: cbits + Install-includes: cpuid.h diff --git a/tests/TestCpuid.hs b/tests/TestCpuid.hs new file mode 100644 --- /dev/null +++ b/tests/TestCpuid.hs @@ -0,0 +1,20 @@ +module Main(main) where + +import Text.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 + vs <- vendorString + printf "Vendor string: %s\n\n" vs + vs <- brandString + printf "Brand string: %s\n\n" vs + printf "Cache information:\n" + infos <- cacheInfo + mapM_ (\ v -> putStrLn $ " " ++ show v) infos + putStrLn "" + ProcessorInfo{piFamily = fam, piModel = mod, piStepping = step, piType = typ} <- processorInfo + printf "processor info: family: %d, model: %d, stepping: %d, processor type: %d\n" fam mod step typ +