ghc/rts/Task.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team 2001-2005
   4  *
   5  * The task manager subsystem.  Tasks execute STG code, with this
   6  * module providing the API which the Scheduler uses to control their
   7  * creation and destruction.
   8  *
   9  * -------------------------------------------------------------------------*/
  10
  11 #include "Rts.h"
  12 #include "RtsUtils.h"
  13 #include "OSThreads.h"
  14 #include "Task.h"
  15 #include "Capability.h"
  16 #include "Stats.h"
  17 #include "RtsFlags.h"
  18 #include "Schedule.h"
  19 #include "Hash.h"
  20
  21 #if HAVE_SIGNAL_H
  22 #include <signal.h>
  23 #endif
  24
  25 // Task lists and global counters.
  26 // Locks required: sched_mutex.
  27 Task *all_tasks = NULL;
  28 static Task *task_free_list = NULL; // singly-linked
  29 static nat taskCount;
  30 #define DEFAULT_MAX_WORKERS 64
  31 static nat maxWorkers; // we won't create more workers than this
  32 static nat tasksRunning;
  33 static nat workerCount;
  34
  35 /* -----------------------------------------------------------------------------
  36  * Remembering the current thread's Task
  37  * -------------------------------------------------------------------------- */
  38
  39 // A thread-local-storage key that we can use to get access to the
  40 // current thread's Task structure.
  41 #if defined(THREADED_RTS)
  42 ThreadLocalKey currentTaskKey;
  43 #else
  44 Task *my_task;
  45 #endif
  46
  47 /* -----------------------------------------------------------------------------
  48  * Rest of the Task API
  49  * -------------------------------------------------------------------------- */
  50
  51 void
  52 initTaskManager (void)
  53 {
  54     static int initialized = 0;
  55
  56     if (!initialized) {
  57         taskCount = 0;
  58         workerCount = 0;
  59         tasksRunning = 0;
  60         maxWorkers = DEFAULT_MAX_WORKERS;
  61         initialized = 1;
  62 #if defined(THREADED_RTS)
  63         newThreadLocalKey(&currentTaskKey);
  64 #endif
  65     }
  66 }
  67
  68
  69 void
  70 stopTaskManager (void)
  71 {
  72     IF_DEBUG(scheduler, sched_belch("stopping task manager, %d tasks still running", tasksRunning));
  73 }
  74
  75
  76 static Task*
  77 newTask (void)
  78 {
  79 #if defined(THREADED_RTS)
  80     Ticks currentElapsedTime, currentUserTime;
  81 #endif
  82     Task *task;
  83
  84     task = stgMallocBytes(sizeof(Task), "newTask");
  85
  86     task->cap  = NULL;
  87     task->stopped = rtsFalse;
  88     task->suspended_tso = NULL;
  89     task->tso  = NULL;
  90     task->stat = NoStatus;
  91     task->ret  = NULL;
  92
  93 #if defined(THREADED_RTS)
  94     initCondition(&task->cond);
  95     initMutex(&task->lock);
  96     task->wakeup = rtsFalse;
  97 #endif
  98
  99 #if defined(THREADED_RTS)
 100     currentUserTime = getThreadCPUTime();
 101     currentElapsedTime = getProcessElapsedTime();
 102     task->mut_time = 0.0;
 103     task->mut_etime = 0.0;
 104     task->gc_time = 0.0;
 105     task->gc_etime = 0.0;
 106     task->muttimestart = currentUserTime;
 107     task->elapsedtimestart = currentElapsedTime;
 108 #endif
 109
 110     task->prev = NULL;
 111     task->next = NULL;
 112     task->return_link = NULL;
 113
 114     task->all_link = all_tasks;
 115     all_tasks = task;
 116
 117     taskCount++;
 118     workerCount++;
 119
 120     return task;
 121 }
 122
 123 Task *
 124 newBoundTask (void)
 125 {
 126     Task *task;
 127
 128     ASSERT_LOCK_HELD(&sched_mutex);
 129     if (task_free_list == NULL) {
 130         task = newTask();
 131     } else {
 132         task = task_free_list;
 133         task_free_list = task->next;
 134         task->next = NULL;
 135         task->prev = NULL;
 136         task->stopped = rtsFalse;
 137     }
 138 #if defined(THREADED_RTS)
 139     task->id = osThreadId();
 140 #endif
 141     ASSERT(task->cap == NULL);
 142
 143     tasksRunning++;
 144
 145     taskEnter(task);
 146
 147     IF_DEBUG(scheduler,sched_belch("new task (taskCount: %d)", taskCount););
 148     return task;
 149 }
 150
 151 void
 152 boundTaskExiting (Task *task)
 153 {
 154     task->stopped = rtsTrue;
 155     task->cap = NULL;
 156
 157 #if defined(THREADED_RTS)
 158     ASSERT(osThreadId() == task->id);
 159 #endif
 160     ASSERT(myTask() == task);
 161     setMyTask(task->prev_stack);
 162
 163     tasksRunning--;
 164
 165     // sadly, we need a lock around the free task list. Todo: eliminate.
 166     ACQUIRE_LOCK(&sched_mutex);
 167     task->next = task_free_list;
 168     task_free_list = task;
 169     RELEASE_LOCK(&sched_mutex);
 170
 171     IF_DEBUG(scheduler,sched_belch("task exiting"));
 172 }
 173
 174 void
 175 discardTask (Task *task)
 176 {
 177     ASSERT_LOCK_HELD(&sched_mutex);
 178     task->stopped = rtsTrue;
 179     task->cap = NULL;
 180     task->next = task_free_list;
 181     task_free_list = task;
 182 }
 183
 184 void
 185 taskStop (Task *task)
 186 {
 187 #if defined(THREADED_RTS)
 188     OSThreadId id;
 189     Ticks currentElapsedTime, currentUserTime, elapsedGCTime;
 190
 191     id = osThreadId();
 192     ASSERT(task->id == id);
 193     ASSERT(myTask() == task);
 194
 195     currentUserTime = getThreadCPUTime();
 196     currentElapsedTime = getProcessElapsedTime();
 197
 198     // XXX this is wrong; we want elapsed GC time since the
 199     // Task started.
 200     elapsedGCTime = stat_getElapsedGCTime();
 201
 202     task->mut_time =
 203         currentUserTime - task->muttimestart - task->gc_time;
 204     task->mut_etime =
 205         currentElapsedTime - task->elapsedtimestart - elapsedGCTime;
 206
 207     if (task->mut_time < 0.0)  { task->mut_time = 0.0;  }
 208     if (task->mut_etime < 0.0) { task->mut_etime = 0.0; }
 209 #endif
 210
 211     task->stopped = rtsTrue;
 212     tasksRunning--;
 213 }
 214
 215 void
 216 resetTaskManagerAfterFork (void)
 217 {
 218 #warning TODO!
 219     taskCount = 0;
 220 }
 221
 222 #if defined(THREADED_RTS)
 223
 224 void
 225 startWorkerTask (Capability *cap,
 226                  void OSThreadProcAttr (*taskStart)(Task *task))
 227 {
 228   int r;
 229   OSThreadId tid;
 230   Task *task;
 231
 232   if (workerCount >= maxWorkers) {
 233       barf("too many workers; runaway worker creation?");
 234   }
 235   workerCount++;
 236
 237   // A worker always gets a fresh Task structure.
 238   task = newTask();
 239
 240   tasksRunning++;
 241
 242   // The lock here is to synchronise with taskStart(), to make sure
 243   // that we have finished setting up the Task structure before the
 244   // worker thread reads it.
 245   ACQUIRE_LOCK(&task->lock);
 246
 247   task->cap = cap;
 248
 249   // Give the capability directly to the worker; we can't let anyone
 250   // else get in, because the new worker Task has nowhere to go to
 251   // sleep so that it could be woken up again.
 252   ASSERT_LOCK_HELD(&cap->lock);
 253   cap->running_task = task;
 254
 255   r = createOSThread(&tid, (OSThreadProc *)taskStart, task);
 256   if (r != 0) {
 257     barf("startTask: Can't create new task");
 258   }
 259
 260   IF_DEBUG(scheduler,sched_belch("new worker task (taskCount: %d)", taskCount););
 261
 262   task->id = tid;
 263
 264   // ok, finished with the Task struct.
 265   RELEASE_LOCK(&task->lock);
 266 }
 267
 268 #endif /* THREADED_RTS */
 269
 270 #ifdef DEBUG
 271
 272 static void *taskId(Task *task)
 273 {
 274 #ifdef THREADED_RTS
 275     return (void *)task->id;
 276 #else
 277     return (void *)task;
 278 #endif
 279 }
 280
 281 void printAllTasks(void);
 282
 283 void
 284 printAllTasks(void)
 285 {
 286     Task *task;
 287     for (task = all_tasks; task != NULL; task = task->all_link) {
 288         debugBelch("task %p is %s, ", taskId(task), task->stopped ? "stopped" : "alive");
 289         if (!task->stopped) {
 290             if (task->cap) {
 291                 debugBelch("on capability %d, ", task->cap->no);
 292             }
 293             if (task->tso) {
 294                 debugBelch("bound to thread %d", task->tso->id);
 295             } else {
 296                 debugBelch("worker");
 297             }
 298         }
 299         debugBelch("\n");
 300     }
 301 }
 302
 303 #endif
 304