1 /* -----------------------------------------------------------------------------
2 * $Id: Itimer.c,v 1.25 2001/11/21 20:55:10 sof Exp $
4 * (c) The GHC Team, 1995-1999
6 * Interval timer for profiling and pre-emptive scheduling.
8 * ---------------------------------------------------------------------------*/
11 * The interval timer is used for profiling and for context switching in the
12 * threaded build. Though POSIX 1003.1b includes a standard interface for
13 * such things, no one really seems to be implementing them yet. Even
14 * Solaris 2.3 only seems to provide support for @CLOCK_REAL@, whereas we're
15 * keen on getting access to @CLOCK_VIRTUAL@.
17 * Hence, we use the old-fashioned @setitimer@ that just about everyone seems
18 * to support. So much for standards.
21 /* This is not posix compliant. */
22 /* #include "PosixSource.h" */
27 #include "Proftimer.h"
30 /* As recommended in the autoconf manual */
31 # ifdef TIME_WITH_SYS_TIME
32 # include <sys/time.h>
35 # ifdef HAVE_SYS_TIME_H
36 # include <sys/time.h>
48 /* ticks left before next pre-emptive context switch */
49 int ticks_to_ctxt_switch = 0;
51 /* -----------------------------------------------------------------------------
54 We use the ticker for time profiling.
56 SMP note: this signal could be delivered to *any* thread. We have
57 to ensure that it doesn't matter which thread actually runs the
59 -------------------------------------------------------------------------- */
63 #if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
65 handle_tick(UINT uID STG_UNUSED, UINT uMsg STG_UNUSED, DWORD dwUser STG_UNUSED,
66 DWORD dw1 STG_UNUSED, DWORD d STG_UNUSED)
68 handle_tick(int unused STG_UNUSED)
77 if (RtsFlags.ConcFlags.ctxtSwitchTicks > 0) {
78 ticks_to_ctxt_switch--;
79 if (ticks_to_ctxt_switch <= 0) {
80 ticks_to_ctxt_switch = RtsFlags.ConcFlags.ctxtSwitchTicks;
81 context_switch = 1; /* schedule a context switch */
88 * Handling timer events under cygwin32 is not done with signal/setitimer.
89 * Instead of the two steps of first registering a signal handler to handle
90 * \tr{SIGVTALRM} and then start generating them via @setitimer()@, we use
91 * the Multimedia API (MM) and its @timeSetEvent@. (Internally, the MM API
92 * creates a separate thread that will notify the main thread of timer
93 * expiry). -- SOF 7/96
95 * 11/98: if the cygwin DLL supports setitimer(), then use it instead.
98 #if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
100 LPTIMECALLBACK vtalrm_cback;
103 initialize_virtual_timer(nat ms)
105 /* On Win32 setups that don't have support for
106 setitimer(), we use the MultiMedia API's timer
109 The delivery of ticks isn't free; the performance hit should be checked.
112 static unsigned int vtalrm_id = 0;
113 static unsigned int period = -1;
115 /* A zero argument value means shutdown. */
119 if ( timeGetDevCaps(&tc, sizeof(TIMECAPS)) == TIMERR_NOERROR) {
120 period = tc.wPeriodMin;
121 delay = timeBeginPeriod(period);
122 if (delay == TIMERR_NOCANDO) { /* error of some sort. */
130 timeSetEvent(ms, /* event every `delay' milliseconds. */
131 1, /* precision is within 1 ms */
133 TIME_CALLBACK_FUNCTION, /* ordinary callback */
136 /* Shutdown the MM timer */
137 if ( vtalrm_id != 0 ) {
138 timeKillEvent(vtalrm_id);
141 timeEndPeriod(period);
151 initialize_virtual_timer(nat ms)
153 # ifndef HAVE_SETITIMER
154 /* fprintf(stderr, "No virtual timer on this system\n"); */
159 timestamp = getourtimeofday();
161 it.it_value.tv_sec = ms / 1000;
162 it.it_value.tv_usec = 1000 * (ms - (1000 * it.it_value.tv_sec));
163 it.it_interval = it.it_value;
164 return (setitimer(ITIMER_VIRTUAL, &it, NULL));
168 #endif /* !{mingw,cygwin32}_TARGET_OS */
171 /* This is a potential POSIX version */
173 initialize_virtual_timer(nat ms)
176 struct itimerspec it;
179 timestamp = getourtimeofday();
181 se.sigev_notify = SIGEV_SIGNAL;
182 se.sigev_signo = SIGVTALRM;
183 se.sigev_value.sival_int = SIGVTALRM;
184 if (timer_create(CLOCK_VIRTUAL, &se, &tid)) {
185 barf("can't create virtual timer");
187 it.it_value.tv_sec = ms / 1000;
188 it.it_value.tv_nsec = 1000000 * (ms - 1000 * it.it_value.tv_sec);
189 it.it_interval = it.it_value;
190 return timer_settime(tid, TIMER_RELTIME, &it, NULL);
194 #if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
196 install_vtalrm_handler(void)
198 vtalrm_cback = handle_tick;
204 install_vtalrm_handler(void)
206 struct sigaction action;
208 action.sa_handler = handle_tick;
210 sigemptyset(&action.sa_mask);
213 return sigaction(SIGVTALRM, &action, NULL);
217 block_vtalrm_signal(void)
221 sigemptyset(&signals);
222 sigaddset(&signals, SIGVTALRM);
224 (void) sigprocmask(SIG_BLOCK, &signals, NULL);
228 unblock_vtalrm_signal(void)
232 sigemptyset(&signals);
233 sigaddset(&signals, SIGVTALRM);
235 (void) sigprocmask(SIG_UNBLOCK, &signals, NULL);
239 /* gettimeofday() takes around 1us on our 500MHz PIII. Since we're
240 * only calling it 50 times/s, it shouldn't have any great impact.
242 #if !defined(mingw32_TARGET_OS)
244 getourtimeofday(void)
247 gettimeofday(&tv, (struct timezone *) NULL);
248 return (tv.tv_sec * TICK_FREQUENCY +
249 tv.tv_usec * TICK_FREQUENCY / 1000000);
253 getourtimeofday(void)
255 return ((unsigned int)GetTickCount() * TICK_FREQUENCY) / 1000;