[project @ 2004-02-12 02:04:59 by mthomas]
[ghc-hetmet.git] / ghc / rts / Itimer.c
index 4b3bd0b..2f769d3 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: Itimer.c,v 1.28 2001/11/27 01:51:23 sof Exp $
+ * $Id: Itimer.c,v 1.36 2003/12/22 16:27:10 simonmar Exp $
  *
  * (c) The GHC Team, 1995-1999
  *
  * Hence, we use the old-fashioned @setitimer@ that just about everyone seems
  * to support.  So much for standards.
  */
-
-/* This is not posix compliant. */
-/* #include "PosixSource.h" */
-
 #include "Rts.h"
 #include "RtsFlags.h"
+#include "Timer.h"
 #include "Itimer.h"
 #include "Proftimer.h"
 #include "Schedule.h"
 #  endif
 # endif
 
-#if HAVE_WINDOWS_H
-# include <windows.h>
-#endif
-lnat total_ticks = 0;
-
-/* ticks left before next pre-emptive context switch */
-int ticks_to_ctxt_switch = 0;
-
-/* -----------------------------------------------------------------------------
-   Tick handler
-
-   We use the ticker for time profiling.
-
-   SMP note: this signal could be delivered to *any* thread.  We have
-   to ensure that it doesn't matter which thread actually runs the
-   signal handler.
-   -------------------------------------------------------------------------- */
-
-static
-void
-#if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
-
-CALLBACK
-handle_tick(UINT uID STG_UNUSED, UINT uMsg STG_UNUSED, DWORD dwUser STG_UNUSED,
-           DWORD dw1 STG_UNUSED, DWORD d STG_UNUSED)
-#else
-handle_tick(int unused STG_UNUSED)
-#endif
-{
-  total_ticks++;
-
-#ifdef PROFILING
-  handleProfTick();
+#ifdef HAVE_SIGNAL_H
+# include <signal.h>
 #endif
 
-  if (RtsFlags.ConcFlags.ctxtSwitchTicks > 0) {
-      ticks_to_ctxt_switch--;
-      if (ticks_to_ctxt_switch <= 0) {
-         ticks_to_ctxt_switch = RtsFlags.ConcFlags.ctxtSwitchTicks;
-         context_switch = 1;   /* schedule a context switch */
-      }
-  }
-}
-
-
-/*
- * Handling timer events under cygwin32 is not done with signal/setitimer.
- * Instead of the two steps of first registering a signal handler to handle
- * \tr{SIGVTALRM} and then start generating them via @setitimer()@, we use
- * the Multimedia API (MM) and its @timeSetEvent@. (Internally, the MM API
- * creates a separate thread that will notify the main thread of timer
- * expiry). -- SOF 7/96
+/* Major bogosity:
+ * 
+ * In the threaded RTS, we can't set the virtual timer because the
+ * thread which has the virtual timer might be sitting waiting for a
+ * capability, and the virtual timer only ticks in CPU time.
  *
- * 11/98: if the cygwin DLL supports setitimer(), then use it instead.
+ * So, possible solutions:
+ *
+ * (1) tick in realtime.  Not very good, because this ticker is used for
+ *     profiling, and this will give us unreliable time profiling
+ *     results.  Furthermore, this requires picking a single OS thread
+ *     to be the timekeeper, which is a bad idea because the thread in
+ *     question might just be making a temporary call into Haskell land.
+ *
+ * (2) save/restore the virtual timer around excursions into STG land.
+ *     Sounds great, but I tried it and the resolution of the virtual timer
+ *     isn't good enough (on Linux) - most of our excursions fall
+ *     within the timer's resolution and we never make any progress.
+ *   
+ * (3) have a virtual timer in every OS thread.  Might be reasonable,
+ *     because most of the time there is only ever one of these
+ *     threads running, so it approximates a single virtual timer.
+ *     But still quite bogus (and I got crashes when I tried this).
+ *
+ * For now, we're using (1), but this needs a better solution. --SDM
  */
-
-#if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
-
-static LPTIMECALLBACK vtalrm_cback;
-static unsigned int vtalrm_id = 0;
-static unsigned int period = -1;
-
-int
-startVirtTimer(nat ms)
-{
-  /* On Win32 setups that don't have support for
-     setitimer(), we use the MultiMedia API's timer
-     support.
-     
-     The delivery of ticks isn't free; the performance hit should be checked.
-  */
-  unsigned int delay;
-  TIMECAPS tc;
-  
-  vtalrm_cback = handle_tick;
-  
-  if ( timeGetDevCaps(&tc, sizeof(TIMECAPS)) == TIMERR_NOERROR) {
-    period = tc.wPeriodMin;
-    delay = timeBeginPeriod(period);
-    if (delay == TIMERR_NOCANDO) { /* error of some sort. */
-      return -1;
-    }
-  } else {
-    return -1;
-  }
-    
-#ifdef PROFILING
-  initProfTimer();
+#ifdef RTS_SUPPORTS_THREADS
+#define ITIMER_FLAVOUR  ITIMER_REAL
+#define ITIMER_SIGNAL   SIGALRM
+#else
+#define ITIMER_FLAVOUR  ITIMER_VIRTUAL
+#define ITIMER_SIGNAL   SIGVTALRM
 #endif
 
-  vtalrm_id =
-    timeSetEvent(ms,      /* event every `delay' milliseconds. */
-                1,       /* precision is within 1 ms */
-                vtalrm_cback,
-                TIME_CALLBACK_FUNCTION,     /* ordinary callback */
-                TIME_PERIODIC);
-
-  return 0;
-}
-
-int
-stopVirtTimer()
-{
-    /* Shutdown the MM timer */
-  if ( vtalrm_id != 0 ) {
-    timeKillEvent(vtalrm_id);
-  }
-  if (period > 0) {
-    timeEndPeriod(period);
-  }
-  
-  return 0;
-}
-#else
 static
 int
-install_vtalrm_handler(void)
+install_vtalrm_handler(TickProc handle_tick)
 {
     struct sigaction action;
 
@@ -166,11 +85,11 @@ install_vtalrm_handler(void)
     sigemptyset(&action.sa_mask);
     action.sa_flags = 0;
 
-    return sigaction(SIGVTALRM, &action, NULL);
+    return sigaction(ITIMER_SIGNAL, &action, NULL);
 }
 
 int
-startVirtTimer(nat ms)
+startTicker(nat ms, TickProc handle_tick)
 {
 # ifndef HAVE_SETITIMER
   /*    fprintf(stderr, "No virtual timer on this system\n"); */
@@ -178,23 +97,19 @@ startVirtTimer(nat ms)
 # else
     struct itimerval it;
 
-    install_vtalrm_handler(void)
+    install_vtalrm_handler(handle_tick);
 
     timestamp = getourtimeofday();
 
-#ifdef PROFILING
-    initProfTimer();
-#endif
-
     it.it_value.tv_sec = ms / 1000;
     it.it_value.tv_usec = 1000 * (ms - (1000 * it.it_value.tv_sec));
     it.it_interval = it.it_value;
-    return (setitimer(ITIMER_VIRTUAL, &it, NULL));
+    return (setitimer(ITIMER_FLAVOUR, &it, NULL));
 # endif
 }
 
 int
-stopVirtTimer()
+stopTicker()
 {
 # ifndef HAVE_SETITIMER
   /*    fprintf(stderr, "No virtual timer on this system\n"); */
@@ -205,16 +120,14 @@ stopVirtTimer()
     it.it_value.tv_sec = 0;
     it.it_value.tv_usec = 0;
     it.it_interval = it.it_value;
-    return (setitimer(ITIMER_VIRTUAL, &it, NULL));
+    return (setitimer(ITIMER_FLAVOUR, &it, NULL));
 # endif
 }
 
-#endif /* !{mingw,cygwin32}_TARGET_OS */
-
 # if 0
 /* This is a potential POSIX version */
 int
-startVirtTimer(nat ms)
+startTicker(nat ms)
 {
     struct sigevent se;
     struct itimerspec it;
@@ -222,13 +135,9 @@ startVirtTimer(nat ms)
 
     timestamp = getourtimeofday();
 
-#ifdef PROFILING
-    initProfTimer();
-#endif
-
     se.sigev_notify = SIGEV_SIGNAL;
-    se.sigev_signo = SIGVTALRM;
-    se.sigev_value.sival_int = SIGVTALRM;
+    se.sigev_signo = ITIMER_SIGNAL;
+    se.sigev_value.sival_int = ITIMER_SIGNAL;
     if (timer_create(CLOCK_VIRTUAL, &se, &tid)) {
        barf("can't create virtual timer");
     }
@@ -239,7 +148,7 @@ startVirtTimer(nat ms)
 }
 
 int
-stopVirtTimer()
+stopTicker()
 {
     struct sigevent se;
     struct itimerspec it;
@@ -248,8 +157,8 @@ stopVirtTimer()
     timestamp = getourtimeofday();
 
     se.sigev_notify = SIGEV_SIGNAL;
-    se.sigev_signo = SIGVTALRM;
-    se.sigev_value.sival_int = SIGVTALRM;
+    se.sigev_signo = ITIMER_SIGNAL;
+    se.sigev_value.sival_int = ITIMER_SIGNAL;
     if (timer_create(CLOCK_VIRTUAL, &se, &tid)) {
        barf("can't create virtual timer");
     }
@@ -258,18 +167,17 @@ stopVirtTimer()
     it.it_interval = it.it_value;
     return timer_settime(tid, TIMER_RELTIME, &it, NULL);
 }
-
 # endif
 
-#if defined(mingw32_TARGET_OS) || (defined(cygwin32_TARGET_OS) && !defined(HAVE_SETITIMER))
-#else
+#if 0
+/* Currently unused */
 void
 block_vtalrm_signal(void)
 {
     sigset_t signals;
     
     sigemptyset(&signals);
-    sigaddset(&signals, SIGVTALRM);
+    sigaddset(&signals, ITIMER_SIGNAL);
 
     (void) sigprocmask(SIG_BLOCK, &signals, NULL);
 }
@@ -280,7 +188,7 @@ unblock_vtalrm_signal(void)
     sigset_t signals;
     
     sigemptyset(&signals);
-    sigaddset(&signals, SIGVTALRM);
+    sigaddset(&signals, ITIMER_SIGNAL);
 
     (void) sigprocmask(SIG_UNBLOCK, &signals, NULL);
 }
@@ -289,7 +197,6 @@ unblock_vtalrm_signal(void)
 /* gettimeofday() takes around 1us on our 500MHz PIII.  Since we're
  * only calling it 50 times/s, it shouldn't have any great impact.
  */
-#if !defined(mingw32_TARGET_OS)
 unsigned int 
 getourtimeofday(void)
 {
@@ -298,10 +205,4 @@ getourtimeofday(void)
   return (tv.tv_sec * TICK_FREQUENCY +
          tv.tv_usec * TICK_FREQUENCY / 1000000);
 }
-#else
-unsigned int
-getourtimeofday(void)
-{
-  return ((unsigned int)GetTickCount() * TICK_FREQUENCY) / 1000;
-}
-#endif
+