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 "Storage.h"
  19 #include "Schedule.h"
  20 #include "Hash.h"
  21 #include "Trace.h"
  22
  23 #if HAVE_SIGNAL_H
  24 #include <signal.h>
  25 #endif
  26
  27 // Task lists and global counters.
  28 // Locks required: sched_mutex.
  29 Task *all_tasks = NULL;
  30 static Task *task_free_list = NULL; // singly-linked
  31 static nat taskCount;
  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         initialized = 1;
  61 #if defined(THREADED_RTS)
  62         newThreadLocalKey(&currentTaskKey);
  63 #endif
  64     }
  65 }
  66
  67
  68 void
  69 stopTaskManager (void)
  70 {
  71     debugTrace(DEBUG_sched,
  72                "stopping task manager, %d tasks still running",
  73                tasksRunning);
  74     /* nothing to do */
  75 }
  76
  77
  78 void
  79 freeTaskManager (void)
  80 {
  81     Task *task, *next;
  82
  83     debugTrace(DEBUG_sched, "freeing task manager");
  84
  85     ACQUIRE_LOCK(&sched_mutex);
  86     for (task = all_tasks; task != NULL; task = next) {
  87         next = task->all_link;
  88         if (task->stopped) {
  89             // We only free resources if the Task is not in use.  A
  90             // Task may still be in use if we have a Haskell thread in
  91             // a foreign call while we are attempting to shut down the
  92             // RTS (see conc059).
  93 #if defined(THREADED_RTS)
  94             closeCondition(&task->cond);
  95             closeMutex(&task->lock);
  96 #endif
  97             stgFree(task);
  98         }
  99     }
 100     all_tasks = NULL;
 101     task_free_list = NULL;
 102 #if defined(THREADED_RTS)
 103     freeThreadLocalKey(&currentTaskKey);
 104 #endif
 105     RELEASE_LOCK(&sched_mutex);
 106 }
 107
 108
 109 static Task*
 110 newTask (void)
 111 {
 112 #if defined(THREADED_RTS)
 113     Ticks currentElapsedTime, currentUserTime;
 114 #endif
 115     Task *task;
 116
 117     task = stgMallocBytes(sizeof(Task), "newTask");
 118
 119     task->cap  = NULL;
 120     task->stopped = rtsFalse;
 121     task->suspended_tso = NULL;
 122     task->tso  = NULL;
 123     task->stat = NoStatus;
 124     task->ret  = NULL;
 125
 126 #if defined(THREADED_RTS)
 127     initCondition(&task->cond);
 128     initMutex(&task->lock);
 129     task->wakeup = rtsFalse;
 130 #endif
 131
 132 #if defined(THREADED_RTS)
 133     currentUserTime = getThreadCPUTime();
 134     currentElapsedTime = getProcessElapsedTime();
 135     task->mut_time = 0;
 136     task->mut_etime = 0;
 137     task->gc_time = 0;
 138     task->gc_etime = 0;
 139     task->muttimestart = currentUserTime;
 140     task->elapsedtimestart = currentElapsedTime;
 141 #endif
 142
 143     task->prev = NULL;
 144     task->next = NULL;
 145     task->return_link = NULL;
 146
 147     task->all_link = all_tasks;
 148     all_tasks = task;
 149
 150     taskCount++;
 151     workerCount++;
 152
 153     return task;
 154 }
 155
 156 Task *
 157 newBoundTask (void)
 158 {
 159     Task *task;
 160
 161     ASSERT_LOCK_HELD(&sched_mutex);
 162     if (task_free_list == NULL) {
 163         task = newTask();
 164     } else {
 165         task = task_free_list;
 166         task_free_list = task->next;
 167         task->next = NULL;
 168         task->prev = NULL;
 169         task->stopped = rtsFalse;
 170     }
 171 #if defined(THREADED_RTS)
 172     task->id = osThreadId();
 173 #endif
 174     ASSERT(task->cap == NULL);
 175
 176     tasksRunning++;
 177
 178     taskEnter(task);
 179
 180     debugTrace(DEBUG_sched, "new task (taskCount: %d)", taskCount);
 181     return task;
 182 }
 183
 184 void
 185 boundTaskExiting (Task *task)
 186 {
 187     task->stopped = rtsTrue;
 188     task->cap = NULL;
 189
 190 #if defined(THREADED_RTS)
 191     ASSERT(osThreadId() == task->id);
 192 #endif
 193     ASSERT(myTask() == task);
 194     setMyTask(task->prev_stack);
 195
 196     tasksRunning--;
 197
 198     // sadly, we need a lock around the free task list. Todo: eliminate.
 199     ACQUIRE_LOCK(&sched_mutex);
 200     task->next = task_free_list;
 201     task_free_list = task;
 202     RELEASE_LOCK(&sched_mutex);
 203
 204     debugTrace(DEBUG_sched, "task exiting");
 205 }
 206
 207 #ifdef THREADED_RTS
 208 #define TASK_ID(t) (t)->id
 209 #else
 210 #define TASK_ID(t) (t)
 211 #endif
 212
 213 void
 214 discardTask (Task *task)
 215 {
 216     ASSERT_LOCK_HELD(&sched_mutex);
 217     if (!task->stopped) {
 218         debugTrace(DEBUG_sched, "discarding task %ld", (long)TASK_ID(task));
 219         task->cap = NULL;
 220         task->tso = NULL;
 221         task->stopped = rtsTrue;
 222         tasksRunning--;
 223         task->next = task_free_list;
 224         task_free_list = task;
 225     }
 226 }
 227
 228 void
 229 taskTimeStamp (Task *task USED_IF_THREADS)
 230 {
 231 #if defined(THREADED_RTS)
 232     Ticks currentElapsedTime, currentUserTime, elapsedGCTime;
 233
 234     currentUserTime = getThreadCPUTime();
 235     currentElapsedTime = getProcessElapsedTime();
 236
 237     // XXX this is wrong; we want elapsed GC time since the
 238     // Task started.
 239     elapsedGCTime = stat_getElapsedGCTime();
 240
 241     task->mut_time =
 242         currentUserTime - task->muttimestart - task->gc_time;
 243     task->mut_etime =
 244         currentElapsedTime - task->elapsedtimestart - elapsedGCTime;
 245
 246     if (task->mut_time  < 0) { task->mut_time  = 0; }
 247     if (task->mut_etime < 0) { task->mut_etime = 0; }
 248 #endif
 249 }
 250
 251 void
 252 workerTaskStop (Task *task)
 253 {
 254 #if defined(THREADED_RTS)
 255     OSThreadId id;
 256     id = osThreadId();
 257     ASSERT(task->id == id);
 258     ASSERT(myTask() == task);
 259 #endif
 260
 261     task->cap = NULL;
 262     taskTimeStamp(task);
 263     task->stopped = rtsTrue;
 264     tasksRunning--;
 265
 266     ACQUIRE_LOCK(&sched_mutex);
 267     task->next = task_free_list;
 268     task_free_list = task;
 269     RELEASE_LOCK(&sched_mutex);
 270 }
 271
 272 void
 273 resetTaskManagerAfterFork (void)
 274 {
 275     // TODO!
 276     taskCount = 0;
 277 }
 278
 279 #if defined(THREADED_RTS)
 280
 281 void
 282 startWorkerTask (Capability *cap,
 283                  void OSThreadProcAttr (*taskStart)(Task *task))
 284 {
 285   int r;
 286   OSThreadId tid;
 287   Task *task;
 288
 289   workerCount++;
 290
 291   // A worker always gets a fresh Task structure.
 292   task = newTask();
 293
 294   tasksRunning++;
 295
 296   // The lock here is to synchronise with taskStart(), to make sure
 297   // that we have finished setting up the Task structure before the
 298   // worker thread reads it.
 299   ACQUIRE_LOCK(&task->lock);
 300
 301   task->cap = cap;
 302
 303   // Give the capability directly to the worker; we can't let anyone
 304   // else get in, because the new worker Task has nowhere to go to
 305   // sleep so that it could be woken up again.
 306   ASSERT_LOCK_HELD(&cap->lock);
 307   cap->running_task = task;
 308
 309   r = createOSThread(&tid, (OSThreadProc *)taskStart, task);
 310   if (r != 0) {
 311     sysErrorBelch("failed to create OS thread");
 312     stg_exit(EXIT_FAILURE);
 313   }
 314
 315   debugTrace(DEBUG_sched, "new worker task (taskCount: %d)", taskCount);
 316
 317   task->id = tid;
 318
 319   // ok, finished with the Task struct.
 320   RELEASE_LOCK(&task->lock);
 321 }
 322
 323 #endif /* THREADED_RTS */
 324
 325 #ifdef DEBUG
 326
 327 static void *taskId(Task *task)
 328 {
 329 #ifdef THREADED_RTS
 330     return (void *)task->id;
 331 #else
 332     return (void *)task;
 333 #endif
 334 }
 335
 336 void printAllTasks(void);
 337
 338 void
 339 printAllTasks(void)
 340 {
 341     Task *task;
 342     for (task = all_tasks; task != NULL; task = task->all_link) {
 343         debugBelch("task %p is %s, ", taskId(task), task->stopped ? "stopped" : "alive");
 344         if (!task->stopped) {
 345             if (task->cap) {
 346                 debugBelch("on capability %d, ", task->cap->no);
 347             }
 348             if (task->tso) {
 349               debugBelch("bound to thread %lu", (unsigned long)task->tso->id);
 350             } else {
 351                 debugBelch("worker");
 352             }
 353         }
 354         debugBelch("\n");
 355     }
 356 }
 357
 358 #endif
 359