src/xbt/parmap.c

   1 /* Copyright (c) 2004, 2005, 2007, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6 #include "gras_config.h"
   7 #include <unistd.h>
   8 #ifndef _XBT_WIN32
   9 #include <sys/syscall.h>
  10 #endif
  11
  12 #ifdef HAVE_FUTEX_H
  13         #include <linux/futex.h>
  14 #else
  15         #include "xbt/xbt_os_thread.h"
  16 #endif
  17 #include "xbt/parmap.h"
  18 #include "xbt/log.h"
  19 #include "xbt/function_types.h"
  20 #include "xbt/dynar.h"
  21 #include "xbt/xbt_os_thread.h"
  22 #include "xbt/sysdep.h"
  23
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
  25 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
  26
  27 typedef enum{
  28   PARMAP_WORK = 0,
  29   PARMAP_DESTROY
  30 } e_xbt_parmap_flag_t;
  31
  32 #ifdef HAVE_FUTEX_H
  33 typedef struct s_xbt_event{
  34   int work;
  35   int done;
  36   unsigned int thread_counter;
  37   unsigned int threads_to_wait;
  38 }s_xbt_event_t, *xbt_event_t;
  39
  40 void xbt_event_init(xbt_event_t event);
  41 void xbt_event_signal(xbt_event_t event);
  42 void xbt_event_wait(xbt_event_t event);
  43 void xbt_event_end(xbt_event_t event);
  44 #endif
  45
  46 typedef struct s_xbt_parmap {
  47   e_xbt_parmap_flag_t status;
  48 #ifdef HAVE_FUTEX_H
  49   xbt_event_t sync_event;
  50 #endif
  51   unsigned int num_workers;
  52   unsigned int workers_max_id;
  53   void_f_pvoid_t fun;
  54   xbt_dynar_t data;
  55   unsigned int index;
  56 } s_xbt_parmap_t;
  57
  58 static void *_xbt_parmap_worker_main(void *parmap);
  59 #ifdef HAVE_FUTEX_H
  60         static void futex_wait(int *uaddr, int val);
  61         static void futex_wake(int *uaddr, int val);
  62 #endif
  63 xbt_parmap_t xbt_parmap_new(unsigned int num_workers)
  64 {
  65   unsigned int i;
  66   xbt_os_thread_t worker = NULL;
  67
  68   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
  69
  70   /* Initialize the thread pool data structure */
  71   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
  72 #ifdef HAVE_FUTEX_H
  73   parmap->sync_event = xbt_new0(s_xbt_event_t, 1);
  74 #endif
  75   parmap->num_workers = num_workers;
  76   parmap->status = PARMAP_WORK;
  77 #ifdef HAVE_FUTEX_H
  78   parmap->sync_event->threads_to_wait = num_workers;
  79 #endif
  80   /* Create the pool of worker threads */
  81   for(i=0; i < num_workers; i++){
  82     worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL);
  83     xbt_os_thread_detach(worker);
  84   }
  85 #ifdef HAVE_FUTEX_H
  86   xbt_event_init(parmap->sync_event);
  87 #endif
  88   return parmap;
  89 }
  90
  91 void xbt_parmap_destroy(xbt_parmap_t parmap)
  92 {
  93   parmap->status = PARMAP_DESTROY;
  94 #ifdef HAVE_FUTEX_H
  95   xbt_event_signal(parmap->sync_event);
  96   xbt_free(parmap->sync_event);
  97 #endif
  98   xbt_free(parmap);
  99 }
 100
 101  void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
 102 {
 103   /* Assign resources to worker threads*/
 104   parmap->fun = fun;
 105   parmap->data = data;
 106   parmap->index = 0;
 107 #ifdef HAVE_FUTEX_H
 108   xbt_event_signal(parmap->sync_event);
 109 #endif
 110   XBT_DEBUG("Job done");
 111 }
 112
 113 void* xbt_parmap_next(xbt_parmap_t parmap) {
 114
 115   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
 116   if (index < xbt_dynar_length(parmap->data)) {
 117     return xbt_dynar_get_as(parmap->data, index, void*);
 118   }
 119   return NULL;
 120 }
 121
 122 unsigned long xbt_parmap_get_worker_id(xbt_parmap_t parmap) {
 123   return (unsigned long) xbt_os_thread_get_extra_data();
 124 }
 125
 126 static void *_xbt_parmap_worker_main(void *arg)
 127 {
 128   unsigned int worker_id;
 129   xbt_parmap_t parmap = (xbt_parmap_t) arg;
 130
 131   /* Fetch a worker id */
 132   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
 133   xbt_os_thread_set_extra_data((void*) (unsigned long) worker_id);
 134
 135   XBT_DEBUG("New worker thread created (%u)", worker_id);
 136
 137   /* Worker's main loop */
 138   while (1) {
 139 #ifdef HAVE_FUTEX_H
 140     xbt_event_wait(parmap->sync_event);
 141 #endif
 142     if (parmap->status == PARMAP_WORK) {
 143
 144       XBT_DEBUG("Worker %u got a job", worker_id);
 145
 146       void* work = xbt_parmap_next(parmap);
 147       if (work != NULL) {
 148         parmap->fun(work);
 149       }
 150
 151       XBT_DEBUG("Worker %u has finished", worker_id);
 152
 153     /* We are destroying the parmap */
 154     } else {
 155 #ifdef HAVE_FUTEX_H
 156       xbt_event_end(parmap->sync_event);
 157 #endif
 158       XBT_DEBUG("Shutting down worker %u", worker_id);
 159       return NULL;
 160     }
 161   }
 162 }
 163
 164 #ifdef HAVE_FUTEX_H
 165 static void futex_wait(int *uaddr, int val)
 166 {
 167   XBT_VERB("Waiting on futex %p", uaddr);
 168   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 169 }
 170
 171 static void futex_wake(int *uaddr, int val)
 172 {
 173   XBT_VERB("Waking futex %p", uaddr);
 174   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 175 }
 176
 177 void xbt_event_init(xbt_event_t event)
 178 {
 179   int myflag = event->done;
 180   if(event->thread_counter < event->threads_to_wait)
 181     futex_wait(&event->done, myflag);
 182 }
 183
 184 void xbt_event_signal(xbt_event_t event)
 185 {
 186   int myflag = event->done;
 187   event->thread_counter = 0;
 188   event->work++;
 189   futex_wake(&event->work, event->threads_to_wait);
 190   futex_wait(&event->done, myflag);
 191 }
 192
 193 void xbt_event_wait(xbt_event_t event)
 194 {
 195   int myflag;
 196   unsigned int mycount;
 197
 198   myflag = event->work;
 199   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 200   if(mycount == event->threads_to_wait){
 201     event->done++;
 202     futex_wake(&event->done, 1);
 203   }
 204
 205   futex_wait(&event->work, myflag);
 206 }
 207
 208 void xbt_event_end(xbt_event_t event)
 209 {
 210   unsigned int mycount;
 211
 212   mycount = __sync_add_and_fetch(&event->thread_counter, 1);
 213   if(mycount == event->threads_to_wait){
 214     event->done++;
 215     futex_wake(&event->done, 1);
 216   }
 217 }
 218 #endif
 219
 220 #ifdef SIMGRID_TEST
 221 #include "xbt.h"
 222 #include "xbt/ex.h"
 223
 224 XBT_TEST_SUITE("parmap", "Parallel Map");
 225 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 226
 227
 228
 229 xbt_parmap_t parmap;
 230
 231 void fun(void *arg);
 232
 233 void fun(void *arg)
 234 {
 235   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 236 }
 237
 238 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 239 {
 240   xbt_test_add("Create the parmap");
 241
 242   unsigned long i,j;
 243   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 244
 245   /* Create the parallel map */
 246   parmap = xbt_parmap_new(10);
 247
 248   for(j=0; j < 100; j++){
 249     xbt_dynar_push_as(data, void *, (void *)j);
 250   }
 251
 252   for(i=0; i < 5; i++)
 253     xbt_parmap_apply(parmap, fun, data);
 254
 255   /* Destroy the parmap */
 256   xbt_parmap_destroy(parmap);
 257   xbt_dynar_free(&data);
 258 }
 259
 260 #endif /* SIMGRID_TEST */