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
 135     case XBT_PARMAP_FUTEX:
 136 #ifdef HAVE_FUTEX_H
 137       parmap->start_f = xbt_parmap_futex_start;
 138       parmap->end_f = xbt_parmap_futex_end;
 139       parmap->signal_f = xbt_parmap_futex_signal;
 140       parmap->wait_f = xbt_parmap_futex_wait;
 141 #endif
 142       xbt_die("Impossible to use futex on Mac");
 143       break;
 144
 145     case XBT_PARMAP_BUSY_WAIT:
 146       parmap->start_f = xbt_parmap_busy_start;
 147       parmap->end_f = xbt_parmap_busy_end;
 148       parmap->signal_f = xbt_parmap_busy_signal;
 149       parmap->wait_f = xbt_parmap_busy_wait;
 150       break;
 151   }
 152 }
 153
 154 /**
 155  * \brief Applies a list of tasks in parallel.
 156  * \param parmap a parallel map object
 157  * \param fun the function to call in parallel
 158  * \param data each element of this dynar will be passed as an argument to fun
 159  */
 160 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
 161 {
 162   /* Assign resources to worker threads */
 163   parmap->fun = fun;
 164   parmap->data = data;
 165   parmap->index = 0;
 166   parmap->signal_f(parmap);
 167   XBT_DEBUG("Job done");
 168 }
 169
 170 /**
 171  * \brief Returns a next task to process.
 172  *
 173  * Worker threads call this function to get more work.
 174  *
 175  * \return the next task to process, or NULL if there is no more work
 176  */
 177 void* xbt_parmap_next(xbt_parmap_t parmap)
 178 {
 179   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
 180   if (index < xbt_dynar_length(parmap->data)) {
 181     return xbt_dynar_get_as(parmap->data, index, void*);
 182   }
 183   return NULL;
 184 }
 185
 186 /**
 187  * \brief Main function of a worker thread.
 188  * \param arg the parmap
 189  */
 190 static void *xbt_parmap_worker_main(void *arg)
 191 {
 192   xbt_parmap_t parmap = (xbt_parmap_t) arg;
 193
 194   XBT_DEBUG("New worker thread created");
 195
 196   /* Worker's main loop */
 197   while (1) {
 198     parmap->wait_f(parmap);
 199     if (parmap->status == XBT_PARMAP_WORK) {
 200
 201       XBT_DEBUG("Worker got a job");
 202
 203       void* work = xbt_parmap_next(parmap);
 204       while (work != NULL) {
 205         parmap->fun(work);
 206         work = xbt_parmap_next(parmap);
 207       }
 208
 209       XBT_DEBUG("Worker has finished");
 210
 211     /* We are destroying the parmap */
 212     } else {
 213       parmap->end_f(parmap);
 214       XBT_DEBUG("Shutting down worker");
 215       return NULL;
 216     }
 217   }
 218 }
 219
 220 #ifdef HAVE_FUTEX_H
 221 static void futex_wait(int *uaddr, int val)
 222 {
 223   XBT_VERB("Waiting on futex %p", uaddr);
 224   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 225 }
 226
 227 static void futex_wake(int *uaddr, int val)
 228 {
 229   XBT_VERB("Waking futex %p", uaddr);
 230   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 231 }
 232 #endif
 233
 234 static void xbt_parmap_posix_start(xbt_parmap_t parmap)
 235 {
 236   THROW_UNIMPLEMENTED;
 237 }
 238
 239 static void xbt_parmap_posix_end(xbt_parmap_t parmap)
 240 {
 241   THROW_UNIMPLEMENTED;
 242 }
 243
 244 static void xbt_parmap_posix_signal(xbt_parmap_t parmap)
 245 {
 246   THROW_UNIMPLEMENTED;
 247 }
 248
 249 static void xbt_parmap_posix_wait(xbt_parmap_t parmap)
 250 {
 251   THROW_UNIMPLEMENTED;
 252 }
 253
 254 #ifdef HAVE_FUTEX_H
 255 /**
 256  * \brief Starts the parmap: waits for all workers to be ready and returns.
 257  *
 258  * This function is called by the controller thread.
 259  *
 260  * \param parmap a parmap
 261  */
 262 static void xbt_parmap_futex_start(xbt_parmap_t parmap)
 263 {
 264   int myflag = parmap->done;
 265   __sync_fetch_and_add(&parmap->thread_counter, 1);
 266   if (parmap->thread_counter < parmap->num_workers) {
 267     /* wait for all workers to be ready */
 268     futex_wait(&parmap->done, myflag);
 269   }
 270 }
 271
 272 /**
 273  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 274  *
 275  * This function is called by all worker threads when they end (not including
 276  * the controller).
 277  *
 278  * \param parmap a parmap
 279  */
 280 static void xbt_parmap_futex_end(xbt_parmap_t parmap)
 281 {
 282   unsigned int mycount;
 283
 284   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 285   if (mycount == parmap->num_workers) {
 286     /* all workers have finished, wake the controller */
 287     parmap->done++;
 288     futex_wake(&parmap->done, 1);
 289   }
 290 }
 291
 292 /**
 293  * \brief Wakes all workers and waits for them to finish the tasks.
 294  *
 295  * This function is called by the controller thread.
 296  *
 297  * \param parmap a parmap
 298  */
 299 static void xbt_parmap_futex_signal(xbt_parmap_t parmap)
 300 {
 301   int myflag = parmap->done;
 302   parmap->thread_counter = 0;
 303   parmap->work++;
 304
 305   /* wake all workers */
 306   futex_wake(&parmap->work, parmap->num_workers);
 307
 308   if (parmap->status == XBT_PARMAP_WORK) {
 309     /* also work myself */
 310     void* work = xbt_parmap_next(parmap);
 311     while (work != NULL) {
 312       parmap->fun(work);
 313       work = xbt_parmap_next(parmap);
 314     }
 315   }
 316
 317   unsigned int mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 318   if (mycount < parmap->num_workers) {
 319     /* some workers have not finished yet */
 320     futex_wait(&parmap->done, myflag);
 321   }
 322 }
 323
 324 /**
 325  * \brief Waits for some work to process.
 326  *
 327  * This function is called by each worker thread (not including the controller)
 328  * when it has no more work to do.
 329  *
 330  * \param parmap a parmap
 331  */
 332 static void xbt_parmap_futex_wait(xbt_parmap_t parmap)
 333 {
 334   int myflag;
 335   unsigned int mycount;
 336
 337   myflag = parmap->work;
 338   mycount = __sync_add_and_fetch(&parmap->thread_counter, 1);
 339   if (mycount == parmap->num_workers) {
 340     /* all workers have finished, wake the controller */
 341     parmap->done++;
 342     futex_wake(&parmap->done, 1);
 343   }
 344
 345   /* wait for more work */
 346   futex_wait(&parmap->work, myflag);
 347 }
 348 #endif
 349
 350 /**
 351  * \brief Starts the parmap: waits for all workers to be ready and returns.
 352  *
 353  * This function is called by the controller thread.
 354  *
 355  * \param parmap a parmap
 356  */
 357 static void xbt_parmap_busy_start(xbt_parmap_t parmap)
 358 {
 359   __sync_fetch_and_add(&parmap->thread_counter, 1);
 360   while (parmap->thread_counter < parmap->num_workers) {
 361     xbt_os_thread_yield();
 362   }
 363 }
 364
 365 /**
 366  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 367  *
 368  * This function is called by all worker threads when they end.
 369  *
 370  * \param parmap a parmap
 371  */
 372 static void xbt_parmap_busy_end(xbt_parmap_t parmap)
 373 {
 374   __sync_add_and_fetch(&parmap->thread_counter, 1);
 375 }
 376
 377 /**
 378  * \brief Wakes all workers and waits for them to finish the tasks.
 379  *
 380  * This function is called by the controller thread.
 381  *
 382  * \param parmap a parmap
 383  */
 384 static void xbt_parmap_busy_signal(xbt_parmap_t parmap)
 385 {
 386   parmap->thread_counter = 0;
 387   parmap->work++;
 388
 389   if (parmap->status == XBT_PARMAP_WORK) {
 390     /* also work myself */
 391     void* work = xbt_parmap_next(parmap);
 392     while (work != NULL) {
 393       parmap->fun(work);
 394       work = xbt_parmap_next(parmap);
 395     }
 396   }
 397
 398   /* I have finished, wait for the others */
 399   __sync_add_and_fetch(&parmap->thread_counter, 1);
 400   while (parmap->thread_counter < parmap->num_workers) {
 401     xbt_os_thread_yield();
 402   }
 403 }
 404
 405 /**
 406  * \brief Waits for some work to process.
 407  *
 408  * This function is called by each worker thread (not including the controller)
 409  * when it has no more work to do.
 410  *
 411  * \param parmap a parmap
 412  */
 413 static void xbt_parmap_busy_wait(xbt_parmap_t parmap)
 414 {
 415   int work = parmap->work;
 416   __sync_add_and_fetch(&parmap->thread_counter, 1);
 417
 418   /* wait for more work */
 419   while (parmap->work == work) {
 420     xbt_os_thread_yield();
 421   }
 422 }
 423
 424 #ifdef SIMGRID_TEST
 425 #include "xbt.h"
 426 #include "xbt/ex.h"
 427
 428 XBT_TEST_SUITE("parmap", "Parallel Map");
 429 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
 430
 431 xbt_parmap_t parmap;
 432
 433 void fun(void *arg);
 434
 435 void fun(void *arg)
 436 {
 437   //XBT_INFO("I'm job %lu", (unsigned long)arg);
 438 }
 439
 440 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
 441 {
 442   xbt_test_add("Create the parmap");
 443
 444   unsigned long i, j;
 445   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
 446
 447   /* Create the parallel map */
 448 #ifdef HAVE_FUTEX_H
 449   parmap = xbt_parmap_new(10, XBT_PARMAP_FUTEX);
 450 #else
 451   parmap = xbt_parmap_new(10, XBT_PARMAP_BUSY_WAIT);
 452 #endif
 453   for (j = 0; j < 100; j++) {
 454     xbt_dynar_push_as(data, void *, (void *)j);
 455   }
 456
 457   for (i = 0; i < 5; i++) {
 458     xbt_parmap_apply(parmap, fun, data);
 459   }
 460
 461   /* Destroy the parmap */
 462   xbt_parmap_destroy(parmap);
 463   xbt_dynar_free(&data);
 464 }
 465
 466 #endif /* SIMGRID_TEST */