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
   9 #ifndef _XBT_WIN32
  10 #include <sys/syscall.h>
  11 #endif
  12
  13 #ifdef HAVE_FUTEX_H
  14 #include <linux/futex.h>
  15 #endif
  16
  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   XBT_PARMAP_WORK = 0,
  29   XBT_PARMAP_DESTROY
  30 } e_xbt_parmap_flag_t;
  31
  32 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode);
  33 static void *xbt_parmap_worker_main(void *parmap);
  34
  35 static void xbt_parmap_posix_start(xbt_parmap_t parmap);
  36 static void xbt_parmap_posix_end(xbt_parmap_t parmap);
  37 static void xbt_parmap_posix_signal(xbt_parmap_t parmap);
  38 static void xbt_parmap_posix_wait(xbt_parmap_t parmap);
  39
  40 #ifdef HAVE_FUTEX_H
  41 static void xbt_parmap_futex_start(xbt_parmap_t parmap);
  42 static void xbt_parmap_futex_end(xbt_parmap_t parmap);
  43 static void xbt_parmap_futex_signal(xbt_parmap_t parmap);
  44 static void xbt_parmap_futex_wait(xbt_parmap_t parmap);
  45 static void futex_wait(int *uaddr, int val);
  46 static void futex_wake(int *uaddr, int val);
  47 #endif
  48
  49 static void xbt_parmap_busy_start(xbt_parmap_t parmap);
  50 static void xbt_parmap_busy_end(xbt_parmap_t parmap);
  51 static void xbt_parmap_busy_signal(xbt_parmap_t parmap);
  52 static void xbt_parmap_busy_wait(xbt_parmap_t parmap);
  53
  54
  55 /**
  56  * \brief Parallel map structure
  57  */
  58 typedef struct s_xbt_parmap {
  59   e_xbt_parmap_flag_t status;      /**< is the parmap active or being destroyed? */
  60   int work;                        /**< index of the current round (1 is the first) */
  61   int done;                        /**< number of rounds already done (futexes only) */
  62   unsigned int thread_counter;     /**< number of threads currently working */
  63   unsigned int num_workers;        /**< total number of worker threads including the controller */
  64   void_f_pvoid_t fun;              /**< function to run in parallel on each element of data */
  65   xbt_dynar_t data;                /**< parameters to pass to fun in parallel */
  66   unsigned int index;              /**< index of the next element of data to pick */
  67
  68   /* fields that depend on the synchronization mode */
  69   e_xbt_parmap_mode_t mode;        /**< synchronization mode */
  70   void (*start_f)(xbt_parmap_t);   /**< initializes the worker threads */
  71   void (*end_f)(xbt_parmap_t);     /**< finalizes the worker threads */
  72   void (*signal_f)(xbt_parmap_t);  /**< wakes the workers threads to process tasks */
  73   void (*wait_f)(xbt_parmap_t);    /**< waits for more work */
  74 } s_xbt_parmap_t;
  75
  76 /**
  77  * \brief Creates a parallel map object
  78  * \param num_workers number of worker threads to create
  79  * \param mode how to synchronize the worker threads
  80  * \return the parmap created
  81  */
  82 xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
  83 {
  84   unsigned int i;
  85   xbt_os_thread_t worker = NULL;
  86
  87   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
  88
  89   /* Initialize the thread pool data structure */
  90   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
  91
  92   parmap->num_workers = num_workers;
  93   parmap->status = XBT_PARMAP_WORK;
  94   xbt_parmap_set_mode(parmap, mode);
  95
  96   /* Create the pool of worker threads */
  97   for (i = 0; i < num_workers - 1; i++) {
  98     worker = xbt_os_thread_create(NULL, xbt_parmap_worker_main, parmap, NULL);
  99     xbt_os_thread_detach(worker);
 100   }
 101   parmap->start_f(parmap);
 102   return parmap;
 103 }
 104
 105 /**
 106  * \brief Destroys a parmap
 107  * \param parmap the parmap to destroy
 108  */
 109 void xbt_parmap_destroy(xbt_parmap_t parmap)
 110 {
 111   parmap->status = XBT_PARMAP_DESTROY;
 112   parmap->signal_f(parmap);
 113   xbt_free(parmap);
 114 }
 115
 116 /**
 117  * \brief Sets the synchronization mode of a parmap.
 118  * \param parmap a parallel map object
 119  * \param mode the synchronization mode
 120  */
 121 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
 122 {
 123   parmap->mode = mode;
 124
 125   switch (mode) {
 126
 127     case XBT_PARMAP_POSIX:
 128       parmap->start_f = xbt_parmap_posix_start;
 129       parmap->end_f = xbt_parmap_posix_end;
 130       parmap->signal_f = xbt_parmap_posix_signal;
 131       parmap->wait_f = xbt_parmap_posix_wait;
 132       break;
 133
 134     case XBT_PARMAP_FUTEX:
 135       parmap->start_f = xbt_parmap_futex_start;
 136       parmap->end_f = xbt_parmap_futex_end;
 137       parmap->signal_f = xbt_parmap_futex_signal;
 138       parmap->wait_f = xbt_parmap_futex_wait;
 139       break;
 140
 141     case XBT_PARMAP_BUSY_WAIT:
 142       parmap->start_f = xbt_parmap_busy_start;
 143       parmap->end_f = xbt_parmap_busy_end;
 144       parmap->signal_f = xbt_parmap_busy_signal;
 145       parmap->wait_f = xbt_parmap_busy_wait;
 146       break;
 147   }
 148 }
 149
 150 /**
 151  * \brief Applies a list of tasks in parallel.
 152  * \param parmap a parallel map object
 153  * \param fun the function to call in parallel
 154  * \param data each element of this dynar will be passed as an argument to fun
 155  */
 156 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
 157 {
 158   /* Assign resources to worker threads */
 159   parmap->fun = fun;
 160   parmap->data = data;
 161   parmap->index = 0;
 162   parmap->signal_f(parmap);
 163   XBT_DEBUG("Job done");
 164 }
 165
 166 /**
 167  * \brief Returns a next task to process.
 168  *
 169  * Worker threads call this function to get more work.
 170  *
 171  * \return the next task to process, or NULL if there is no more work
 172  */
 173 void* xbt_parmap_next(xbt_parmap_t parmap)
 174 {
 175   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
 176   if (index < xbt_dynar_length(parmap->data)) {
 177     return xbt_dynar_get_as(parmap->data, index, void*);
 178   }
 179   return NULL;
 180 }
 181
 182 /**
 183  * \brief Main function of a worker thread.
 184  * \param arg the parmap
 185  */
 186 static void *xbt_parmap_worker_main(void *arg)
 187 {
 188   xbt_parmap_t parmap = (xbt_parmap_t) arg;
 189
 190   XBT_DEBUG("New worker thread created");
 191
 192   /* Worker's main loop */
 193   while (1) {
 194     parmap->wait_f(parmap);
 195     if (parmap->status == XBT_PARMAP_WORK) {
 196
 197       XBT_DEBUG("Worker got a job");
 198
 199       void* work = xbt_parmap_next(parmap);
 200       while (work != NULL) {
 201         parmap->fun(work);
 202         work = xbt_parmap_next(parmap);
 203       }
 204
 205       XBT_DEBUG("Worker has finished");
 206
 207     /* We are destroying the parmap */
 208     } else {
 209       parmap->end_f(parmap);
 210       XBT_DEBUG("Shutting down worker");
 211       return NULL;
 212     }
 213   }
 214 }
 215
 216 #ifdef HAVE_FUTEX_H
 217 static void futex_wait(int *uaddr, int val)
 218 {
 219   XBT_VERB("Waiting on futex %p", uaddr);
 220   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 221 }
 222
 223 static void futex_wake(int *uaddr, int val)
 224 {
 225   XBT_VERB("Waking futex %p", uaddr);
 226   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 227 }
 228 #endif
 229
 230 static void xbt_parmap_posix_start(xbt_parmap_t parmap)
 231 {
 232   THROW_UNIMPLEMENTED;
 233 }
 234
 235 static void xbt_parmap_posix_end(xbt_parmap_t parmap)
 236 {
 237   THROW_UNIMPLEMENTED;
 238 }
 239
 240 static void xbt_parmap_posix_signal(xbt_parmap_t parmap)
 241 {
 242   THROW_UNIMPLEMENTED;
 243 }
 244
 245 static void xbt_parmap_posix_wait(xbt_parmap_t parmap)
 246 {
 247   THROW_UNIMPLEMENTED;
 248 }
 249
 250 #ifdef HAVE_FUTEX_H
 251 /**
 252  * \brief Starts the parmap: waits for all workers to be ready and returns.
 253  *
 254  * This function is called by the controller thread.
 255  *
 256  * \param parmap a parmap
 257  */
 258 static void xbt_parmap_futex_start(xbt_parmap_t parmap)
 259 {
 260   int myflag = parmap->done;
 261   __sync_fetch_and_add(&parmap->thread_counter, 1);
 262   if (parmap->thread_counter < parmap->num_workers) {
 263     /* wait for all workers to be ready */
 264     futex_wait(&parmap->done, myflag);
 265   }
 266 }
 267
 268 /**
 269  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 270  *
 271  * This function is called by all worker threads when they end (not including
 272  * the controller).
 273  *
 274  * \param parmap a parmap
 275  */
 276 static void xbt_parmap_futex_end(xbt_parmap_t parmap)
 277 {
 278   unsigned int mycount;
 279
 280   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 281   if (mycount == parmap->num_workers) {
 282     /* all workers have finished, wake the controller */
 283     parmap->done++;
 284     futex_wake(&parmap->done, 1);
 285   }
 286 }
 287
 288 /**
 289  * \brief Wakes all workers and waits for them to finish the tasks.
 290  *
 291  * This function is called by the controller thread.
 292  *
 293  * \param parmap a parmap
 294  */
 295 static void xbt_parmap_futex_signal(xbt_parmap_t parmap)
 296 {
 297   int myflag = parmap->done;
 298   parmap->thread_counter = 0;
 299   parmap->work++;
 300
 301   /* wake all workers */
 302   futex_wake(&parmap->work, parmap->num_workers);
 303
 304   if (parmap->status == XBT_PARMAP_WORK) {
 305     /* also work myself */
 306     void* work = xbt_parmap_next(parmap);
 307     while (work != NULL) {
 308       parmap->fun(work);
 309       work = xbt_parmap_next(parmap);
 310     }
 311   }
 312
 313   unsigned int mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 314   if (mycount < parmap->num_workers) {
 315     /* some workers have not finished yet */
 316     futex_wait(&parmap->done, myflag);
 317   }
 318 }
 319
 320 /**
 321  * \brief Waits for some work to process.
 322  *
 323  * This function is called by each worker thread (not including the controller)
 324  * when it has no more work to do.
 325  *
 326  * \param parmap a parmap
 327  */
 328 static void xbt_parmap_futex_wait(xbt_parmap_t parmap)
 329 {
 330   int myflag;
 331   unsigned int mycount;
 332
 333   myflag = parmap->work;
 334   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 335   if (mycount == parmap->num_workers) {
 336     /* all workers have finished, wake the controller */
 337     parmap->done++;
 338     futex_wake(&parmap->done, 1);
 339   }
 340
 341   /* wait for more work */
 342   futex_wait(&parmap->work, myflag);
 343 }
 344 #endif
 345
 346 /**
 347  * \brief Starts the parmap: waits for all workers to be ready and returns.
 348  *
 349  * This function is called by the controller thread.
 350  *
 351  * \param parmap a parmap
 352  */
 353 static void xbt_parmap_busy_start(xbt_parmap_t parmap)
 354 {
 355   __sync_fetch_and_add(&parmap->thread_counter, 1);
 356   while (parmap->thread_counter < parmap->num_workers) {
 357     xbt_os_thread_yield();
 358   }
 359 }
 360
 361 /**
 362  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 363  *
 364  * This function is called by all worker threads when they end.
 365  *
 366  * \param parmap a parmap
 367  */
 368 static void xbt_parmap_busy_end(xbt_parmap_t parmap)
 369 {
 370   __sync_add_and_fetch(&parmap->thread_counter, 1);
 371 }
 372
 373 /**
 374  * \brief Wakes all workers and waits for them to finish the tasks.
 375  *
 376  * This function is called by the controller thread.
 377  *
 378  * \param parmap a parmap
 379  */
 380 static void xbt_parmap_busy_signal(xbt_parmap_t parmap)
 381 {
 382   parmap->thread_counter = 0;
 383   parmap->work++;
 384
 385   if (parmap->status == XBT_PARMAP_WORK) {
 386     /* also work myself */
 387     void* work = xbt_parmap_next(parmap);
 388     while (work != NULL) {
 389       parmap->fun(work);
 390       work = xbt_parmap_next(parmap);
 391     }
 392   }
 393
 394   /* I have finished, wait for the others */
 395   __sync_add_and_fetch(&parmap->thread_counter, 1);
 396   while (parmap->thread_counter < parmap->num_workers) {
 397     xbt_os_thread_yield();
 398   }
 399 }
 400
 401 /**
 402  * \brief Waits for some work to process.
 403  *
 404  * This function is called by each worker thread (not including the controller)
 405  * when it has no more work to do.
 406  *
 407  * \param parmap a parmap
 408  */
 409 static void xbt_parmap_busy_wait(xbt_parmap_t parmap)
 410 {
 411   int work = parmap->work;
 412   __sync_add_and_fetch(&parmap->thread_counter, 1);
 413
 414   /* wait for more work */
 415   while (parmap->work == work) {
 416     xbt_os_thread_yield();
 417   }
 418 }
 419
 420 #ifdef SIMGRID_TEST
 421 #include "xbt.h"
 422 #include "xbt/ex.h"
 423
 424 XBT_TEST_SUITE("parmap", "Parallel Map");
 425 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 426
 427 xbt_parmap_t parmap;
 428
 429 void fun(void *arg);
 430
 431 void fun(void *arg)
 432 {
 433   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 434 }
 435
 436 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 437 {
 438   xbt_test_add("Create the parmap");
 439
 440   unsigned long i, j;
 441   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 442
 443   /* Create the parallel map */
 444   parmap = xbt_parmap_new(10, XBT_PARMAP_FUTEX);
 445
 446   for (j = 0; j < 100; j++) {
 447     xbt_dynar_push_as(data, void *, (void *)j);
 448   }
 449
 450   for (i = 0; i < 5; i++) {
 451     xbt_parmap_apply(parmap, fun, data);
 452   }
 453
 454   /* Destroy the parmap */
 455   xbt_parmap_destroy(parmap);
 456   xbt_dynar_free(&data);
 457 }
 458
 459 #endif /* SIMGRID_TEST */