1 -----------------------------------------------------------------------------
3 -- Module : System.CPUTime
4 -- Copyright : (c) The University of Glasgow 2001
5 -- License : BSD-style (see the file libraries/base/LICENSE)
7 -- Maintainer : libraries@haskell.org
8 -- Stability : provisional
9 -- Portability : portable
11 -- The standard CPUTime library.
13 -----------------------------------------------------------------------------
17 getCPUTime, -- :: IO Integer
18 cpuTimePrecision -- :: Integer
26 import Hugs.Time ( getCPUTime, clockTicks )
30 import CPUTime ( getCPUTime, cpuTimePrecision )
33 #ifdef __GLASGOW_HASKELL__
37 #include "HsBaseConfig.h"
45 #if !defined(mingw32_HOST_OS) && !defined(irix_HOST_OS)
46 # if HAVE_SYS_RESOURCE_H
47 # include <sys/resource.h>
51 -- For FILETIME etc. on Windows
63 #include <sys/times.h>
68 #if !defined(mingw32_HOST_OS) && !defined(cygwin32_HOST_OS)
69 realToInteger :: Real a => a -> Integer
70 realToInteger ct = round (realToFrac ct :: Double)
71 -- CTime, CClock, CUShort etc are in Real but not Fractional,
72 -- so we must convert to Double before we can round it
75 #ifdef __GLASGOW_HASKELL__
76 -- -----------------------------------------------------------------------------
77 -- |Computation 'getCPUTime' returns the number of picoseconds CPU time
78 -- used by the current program. The precision of this result is
79 -- implementation-dependent.
81 getCPUTime :: IO Integer
84 #if !defined(mingw32_HOST_OS) && !defined(cygwin32_HOST_OS)
85 -- getrusage() is right royal pain to deal with when targetting multiple
86 -- versions of Solaris, since some versions supply it in libc (2.3 and 2.5),
87 -- while 2.4 has got it in libucb (I wouldn't be too surprised if it was back
88 -- again in libucb in 2.6..)
90 -- Avoid the problem by resorting to times() instead.
92 #if defined(HAVE_GETRUSAGE) && ! irix_HOST_OS && ! solaris2_HOST_OS
93 allocaBytes (#const sizeof(struct rusage)) $ \ p_rusage -> do
94 throwErrnoIfMinus1_ "getrusage" $ getrusage (#const RUSAGE_SELF) p_rusage
96 let ru_utime = (#ptr struct rusage, ru_utime) p_rusage
97 let ru_stime = (#ptr struct rusage, ru_stime) p_rusage
98 u_sec <- (#peek struct timeval,tv_sec) ru_utime :: IO CTime
99 u_usec <- (#peek struct timeval,tv_usec) ru_utime :: IO CTime
100 s_sec <- (#peek struct timeval,tv_sec) ru_stime :: IO CTime
101 s_usec <- (#peek struct timeval,tv_usec) ru_stime :: IO CTime
102 return ((realToInteger u_sec * 1000000 + realToInteger u_usec +
103 realToInteger s_sec * 1000000 + realToInteger s_usec)
107 foreign import ccall unsafe getrusage :: CInt -> Ptr CRUsage -> IO CInt
109 # if defined(HAVE_TIMES)
110 allocaBytes (#const sizeof(struct tms)) $ \ p_tms -> do
112 u_ticks <- (#peek struct tms,tms_utime) p_tms :: IO CClock
113 s_ticks <- (#peek struct tms,tms_stime) p_tms :: IO CClock
114 return (( (realToInteger u_ticks + realToInteger s_ticks) * 1000000000000)
115 `div` fromIntegral clockTicks)
118 foreign import ccall unsafe times :: Ptr CTms -> IO CClock
120 ioException (IOError Nothing UnsupportedOperation
128 -- NOTE: GetProcessTimes() is only supported on NT-based OSes.
129 -- The counts reported by GetProcessTimes() are in 100-ns (10^-7) units.
130 allocaBytes (#const sizeof(FILETIME)) $ \ p_creationTime -> do
131 allocaBytes (#const sizeof(FILETIME)) $ \ p_exitTime -> do
132 allocaBytes (#const sizeof(FILETIME)) $ \ p_kernelTime -> do
133 allocaBytes (#const sizeof(FILETIME)) $ \ p_userTime -> do
134 pid <- getCurrentProcess
135 ok <- getProcessTimes pid p_creationTime p_exitTime p_kernelTime p_userTime
137 ut <- ft2psecs p_userTime
138 kt <- ft2psecs p_kernelTime
142 ft2psecs :: Ptr FILETIME -> IO Integer
144 high <- (#peek FILETIME,dwHighDateTime) ft :: IO Word32
145 low <- (#peek FILETIME,dwLowDateTime) ft :: IO Word32
146 -- Convert 100-ns units to picosecs (10^-12)
147 -- => multiply by 10^5.
148 return (((fromIntegral high) * (2^(32::Int)) + (fromIntegral low)) * 100000)
150 -- ToDo: pin down elapsed times to just the OS thread(s) that
151 -- are evaluating/managing Haskell code.
155 -- need proper Haskell names (initial lower-case character)
156 foreign import stdcall unsafe "GetCurrentProcess" getCurrentProcess :: IO (Ptr HANDLE)
157 foreign import stdcall unsafe "GetProcessTimes" getProcessTimes :: Ptr HANDLE -> Ptr FILETIME -> Ptr FILETIME -> Ptr FILETIME -> Ptr FILETIME -> IO CInt
159 #endif /* not _WIN32 */
160 #endif /* __GLASGOW_HASKELL__ */
162 -- |The 'cpuTimePrecision' constant is the smallest measurable difference
163 -- in CPU time that the implementation can record, and is given as an
164 -- integral number of picoseconds.
167 cpuTimePrecision :: Integer
168 cpuTimePrecision = round ((1000000000000::Integer) % fromIntegral (clockTicks))
171 #ifdef __GLASGOW_HASKELL__
177 unsafePerformIO (sysconf (#const _SC_CLK_TCK) >>= return . fromIntegral)
178 foreign import ccall unsafe sysconf :: CInt -> IO CLong
180 #endif /* __GLASGOW_HASKELL__ */