SafeHaskell: Added SafeHaskell to base
[ghc.git] / libraries / base / System / CPUTime.hsc
1 {-# LANGUAGE Trustworthy #-}
2 {-# LANGUAGE CPP, NondecreasingIndentation, ForeignFunctionInterface #-}
3
4 -----------------------------------------------------------------------------
5 -- |
6 -- Module      :  System.CPUTime
7 -- Copyright   :  (c) The University of Glasgow 2001
8 -- License     :  BSD-style (see the file libraries/base/LICENSE)
9 -- 
10 -- Maintainer  :  libraries@haskell.org
11 -- Stability   :  provisional
12 -- Portability :  portable
13 --
14 -- The standard CPUTime library.
15 --
16 -----------------------------------------------------------------------------
17
18 module System.CPUTime 
19         (
20          getCPUTime,       -- :: IO Integer
21          cpuTimePrecision  -- :: Integer
22         ) where
23
24 import Prelude
25
26 import Data.Ratio
27
28 #ifdef __HUGS__
29 import Hugs.Time ( getCPUTime, clockTicks )
30 #endif
31
32 #ifdef __NHC__
33 import CPUTime ( getCPUTime, cpuTimePrecision )
34 #endif
35
36 #ifdef __GLASGOW_HASKELL__
37 import Foreign.Safe
38 import Foreign.C
39 #if !defined(CLK_TCK)
40 import System.IO.Unsafe (unsafePerformIO)
41 #endif
42
43 #include "HsBaseConfig.h"
44
45 -- For _SC_CLK_TCK
46 #if HAVE_UNISTD_H
47 #include <unistd.h>
48 #endif
49
50 -- For struct rusage
51 #if !defined(mingw32_HOST_OS) && !defined(irix_HOST_OS)
52 # if HAVE_SYS_RESOURCE_H
53 #  include <sys/resource.h>
54 # endif
55 #endif
56
57 -- For FILETIME etc. on Windows
58 #if HAVE_WINDOWS_H
59 #include <windows.h>
60 #endif
61
62 -- for CLK_TCK
63 #if HAVE_TIME_H
64 #include <time.h>
65 #endif
66
67 -- for struct tms
68 #if HAVE_SYS_TIMES_H
69 #include <sys/times.h>
70 #endif
71
72 #endif
73
74 #if !defined(mingw32_HOST_OS) && !defined(cygwin32_HOST_OS)
75 realToInteger :: Real a => a -> Integer
76 realToInteger ct = round (realToFrac ct :: Double)
77   -- CTime, CClock, CUShort etc are in Real but not Fractional, 
78   -- so we must convert to Double before we can round it
79 #endif
80
81 #ifdef __GLASGOW_HASKELL__
82 -- -----------------------------------------------------------------------------
83 -- |Computation 'getCPUTime' returns the number of picoseconds CPU time
84 -- used by the current program.  The precision of this result is
85 -- implementation-dependent.
86
87 getCPUTime :: IO Integer
88 getCPUTime = do
89
90 #if !defined(mingw32_HOST_OS) && !defined(cygwin32_HOST_OS)
91 -- getrusage() is right royal pain to deal with when targetting multiple
92 -- versions of Solaris, since some versions supply it in libc (2.3 and 2.5),
93 -- while 2.4 has got it in libucb (I wouldn't be too surprised if it was back
94 -- again in libucb in 2.6..)
95 --
96 -- Avoid the problem by resorting to times() instead.
97 --
98 #if defined(HAVE_GETRUSAGE) && ! irix_HOST_OS && ! solaris2_HOST_OS
99     allocaBytes (#const sizeof(struct rusage)) $ \ p_rusage -> do
100     throwErrnoIfMinus1_ "getrusage" $ getrusage (#const RUSAGE_SELF) p_rusage
101
102     let ru_utime = (#ptr struct rusage, ru_utime) p_rusage
103     let ru_stime = (#ptr struct rusage, ru_stime) p_rusage
104     u_sec  <- (#peek struct timeval,tv_sec)  ru_utime :: IO CTime
105     u_usec <- (#peek struct timeval,tv_usec) ru_utime :: IO CSUSeconds
106     s_sec  <- (#peek struct timeval,tv_sec)  ru_stime :: IO CTime
107     s_usec <- (#peek struct timeval,tv_usec) ru_stime :: IO CSUSeconds
108     return ((realToInteger u_sec * 1000000 + realToInteger u_usec + 
109              realToInteger s_sec * 1000000 + realToInteger s_usec) 
110                 * 1000000)
111
112 type CRUsage = ()
113 foreign import ccall unsafe getrusage :: CInt -> Ptr CRUsage -> IO CInt
114 #else
115 # if defined(HAVE_TIMES)
116     allocaBytes (#const sizeof(struct tms)) $ \ p_tms -> do
117     _ <- times p_tms
118     u_ticks  <- (#peek struct tms,tms_utime) p_tms :: IO CClock
119     s_ticks  <- (#peek struct tms,tms_stime) p_tms :: IO CClock
120     return (( (realToInteger u_ticks + realToInteger s_ticks) * 1000000000000) 
121                         `div` fromIntegral clockTicks)
122
123 type CTms = ()
124 foreign import ccall unsafe times :: Ptr CTms -> IO CClock
125 # else
126     ioException (IOError Nothing UnsupportedOperation 
127                          "getCPUTime"
128                          "can't get CPU time"
129                          Nothing)
130 # endif
131 #endif
132
133 #else /* win32 */
134      -- NOTE: GetProcessTimes() is only supported on NT-based OSes.
135      -- The counts reported by GetProcessTimes() are in 100-ns (10^-7) units.
136     allocaBytes (#const sizeof(FILETIME)) $ \ p_creationTime -> do
137     allocaBytes (#const sizeof(FILETIME)) $ \ p_exitTime -> do
138     allocaBytes (#const sizeof(FILETIME)) $ \ p_kernelTime -> do
139     allocaBytes (#const sizeof(FILETIME)) $ \ p_userTime -> do
140     pid <- getCurrentProcess
141     ok <- getProcessTimes pid p_creationTime p_exitTime p_kernelTime p_userTime
142     if toBool ok then do
143       ut <- ft2psecs p_userTime
144       kt <- ft2psecs p_kernelTime
145       return (ut + kt)
146      else return 0
147   where 
148         ft2psecs :: Ptr FILETIME -> IO Integer
149         ft2psecs ft = do
150           high <- (#peek FILETIME,dwHighDateTime) ft :: IO Word32
151           low  <- (#peek FILETIME,dwLowDateTime)  ft :: IO Word32
152             -- Convert 100-ns units to picosecs (10^-12) 
153             -- => multiply by 10^5.
154           return (((fromIntegral high) * (2^(32::Int)) + (fromIntegral low)) * 100000)
155
156     -- ToDo: pin down elapsed times to just the OS thread(s) that
157     -- are evaluating/managing Haskell code.
158
159 type FILETIME = ()
160 type HANDLE = ()
161 -- need proper Haskell names (initial lower-case character)
162 foreign import stdcall unsafe "GetCurrentProcess" getCurrentProcess :: IO (Ptr HANDLE)
163 foreign import stdcall unsafe "GetProcessTimes" getProcessTimes :: Ptr HANDLE -> Ptr FILETIME -> Ptr FILETIME -> Ptr FILETIME -> Ptr FILETIME -> IO CInt
164
165 #endif /* not _WIN32 */
166 #endif /* __GLASGOW_HASKELL__ */
167
168 -- |The 'cpuTimePrecision' constant is the smallest measurable difference
169 -- in CPU time that the implementation can record, and is given as an
170 -- integral number of picoseconds.
171
172 #ifndef __NHC__
173 cpuTimePrecision :: Integer
174 cpuTimePrecision = round ((1000000000000::Integer) % fromIntegral (clockTicks))
175 #endif
176
177 #ifdef __GLASGOW_HASKELL__
178 clockTicks :: Int
179 clockTicks =
180 #if defined(CLK_TCK)
181     (#const CLK_TCK)
182 #else
183     unsafePerformIO (sysconf (#const _SC_CLK_TCK) >>= return . fromIntegral)
184 foreign import ccall unsafe sysconf :: CInt -> IO CLong
185 #endif
186 #endif /* __GLASGOW_HASKELL__ */