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 "internal_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 #include <limits.h>
  16 #endif
  17
  18 #include "xbt/parmap.h"
  19 #include "xbt/log.h"
  20 #include "xbt/function_types.h"
  21 #include "xbt/dynar.h"
  22 #include "xbt/xbt_os_thread.h"
  23 #include "xbt/sysdep.h"
  24 #include "simix/smx_private.h"
  25
  26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
  27 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
  28
  29 typedef enum {
  30   XBT_PARMAP_WORK,
  31   XBT_PARMAP_DESTROY
  32 } e_xbt_parmap_flag_t;
  33
  34 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode);
  35 static void *xbt_parmap_worker_main(void *parmap);
  36 static void xbt_parmap_work(xbt_parmap_t parmap);
  37
  38 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap);
  39 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap);
  40 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap);
  41 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round);
  42
  43 #ifdef HAVE_FUTEX_H
  44 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap);
  45 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap);
  46 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap);
  47 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round);
  48 static void futex_wait(unsigned *uaddr, unsigned val);
  49 static void futex_wake(unsigned *uaddr, unsigned val);
  50 #endif
  51
  52 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap);
  53 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap);
  54 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap);
  55 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round);
  56
  57
  58 /**
  59  * \brief Parallel map structure
  60  */
  61 typedef struct s_xbt_parmap {
  62   e_xbt_parmap_flag_t status;      /**< is the parmap active or being destroyed? */
  63   unsigned work;                   /**< index of the current round */
  64   unsigned thread_counter;         /**< number of workers that have done the work */
  65
  66   unsigned int num_workers;        /**< total number of worker threads including the controller */
  67   void_f_pvoid_t fun;              /**< function to run in parallel on each element of data */
  68   xbt_dynar_t data;                /**< parameters to pass to fun in parallel */
  69   unsigned int index;              /**< index of the next element of data to pick */
  70
  71   /* posix only */
  72   xbt_os_cond_t ready_cond;
  73   xbt_os_mutex_t ready_mutex;
  74   xbt_os_cond_t done_cond;
  75   xbt_os_mutex_t done_mutex;
  76
  77   /* fields that depend on the synchronization mode */
  78   e_xbt_parmap_mode_t mode;        /**< synchronization mode */
  79   void (*master_wait_f)(xbt_parmap_t);    /**< wait for the workers to have done the work */
  80   void (*worker_signal_f)(xbt_parmap_t);  /**< signal the master that a worker has done the work */
  81   void (*master_signal_f)(xbt_parmap_t);  /**< wakes the workers threads to process tasks */
  82   void (*worker_wait_f)(xbt_parmap_t, unsigned); /**< waits for more work */
  83 } s_xbt_parmap_t;
  84
  85 /**
  86  * \brief Thread data transmission structure
  87  */
  88 typedef struct s_xbt_parmap_thread_data{
  89   xbt_parmap_t parmap;
  90   int worker_id;
  91 } s_xbt_parmap_thread_data_t;
  92
  93 typedef s_xbt_parmap_thread_data_t *xbt_parmap_thread_data_t;
  94
  95 /**
  96  * \brief Creates a parallel map object
  97  * \param num_workers number of worker threads to create
  98  * \param mode how to synchronize the worker threads
  99  * \return the parmap created
 100  */
 101 xbt_parmap_t xbt_parmap_new(unsigned int num_workers, e_xbt_parmap_mode_t mode)
 102 {
 103   unsigned int i;
 104   xbt_os_thread_t worker = NULL;
 105
 106   XBT_DEBUG("Create new parmap (%u workers)", num_workers);
 107
 108   /* Initialize the thread pool data structure */
 109   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
 110
 111   parmap->num_workers = num_workers;
 112   parmap->status = XBT_PARMAP_WORK;
 113   xbt_parmap_set_mode(parmap, mode);
 114
 115   /* Create the pool of worker threads */
 116   xbt_parmap_thread_data_t data;
 117   for (i = 1; i < num_workers; i++) {
 118     data = xbt_new0(s_xbt_parmap_thread_data_t, 1);
 119     data->parmap = parmap;
 120     data->worker_id = i;
 121     worker = xbt_os_thread_create(NULL, xbt_parmap_worker_main, data, NULL);
 122     xbt_os_thread_detach(worker);
 123   }
 124   return parmap;
 125 }
 126
 127 /**
 128  * \brief Destroys a parmap
 129  * \param parmap the parmap to destroy
 130  */
 131 void xbt_parmap_destroy(xbt_parmap_t parmap)
 132 {
 133   if (!parmap) {
 134     return;
 135   }
 136
 137   parmap->status = XBT_PARMAP_DESTROY;
 138   parmap->master_signal_f(parmap);
 139   parmap->master_wait_f(parmap);
 140
 141   xbt_os_cond_destroy(parmap->ready_cond);
 142   xbt_os_mutex_destroy(parmap->ready_mutex);
 143   xbt_os_cond_destroy(parmap->done_cond);
 144   xbt_os_mutex_destroy(parmap->done_mutex);
 145
 146   xbt_free(parmap);
 147 }
 148
 149 /**
 150  * \brief Sets the synchronization mode of a parmap.
 151  * \param parmap a parallel map object
 152  * \param mode the synchronization mode
 153  */
 154 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
 155 {
 156   if (mode == XBT_PARMAP_DEFAULT) {
 157 #ifdef HAVE_FUTEX_H
 158     mode = XBT_PARMAP_FUTEX;
 159 #else
 160     mode = XBT_PARMAP_POSIX;
 161 #endif
 162   }
 163   parmap->mode = mode;
 164
 165   switch (mode) {
 166
 167     case XBT_PARMAP_POSIX:
 168       parmap->master_wait_f = xbt_parmap_posix_master_wait;
 169       parmap->worker_signal_f = xbt_parmap_posix_worker_signal;
 170       parmap->master_signal_f = xbt_parmap_posix_master_signal;
 171       parmap->worker_wait_f = xbt_parmap_posix_worker_wait;
 172
 173       parmap->ready_cond = xbt_os_cond_init();
 174       parmap->ready_mutex = xbt_os_mutex_init();
 175       parmap->done_cond = xbt_os_cond_init();
 176       parmap->done_mutex = xbt_os_mutex_init();
 177       break;
 178
 179
 180     case XBT_PARMAP_FUTEX:
 181 #ifdef HAVE_FUTEX_H
 182       parmap->master_wait_f = xbt_parmap_futex_master_wait;
 183       parmap->worker_signal_f = xbt_parmap_futex_worker_signal;
 184       parmap->master_signal_f = xbt_parmap_futex_master_signal;
 185       parmap->worker_wait_f = xbt_parmap_futex_worker_wait;
 186
 187       xbt_os_cond_destroy(parmap->ready_cond);
 188       xbt_os_mutex_destroy(parmap->ready_mutex);
 189       xbt_os_cond_destroy(parmap->done_cond);
 190       xbt_os_mutex_destroy(parmap->done_mutex);
 191       break;
 192 #else
 193       xbt_die("Futex is not available on this OS.");
 194 #endif
 195
 196     case XBT_PARMAP_BUSY_WAIT:
 197       parmap->master_wait_f = xbt_parmap_busy_master_wait;
 198       parmap->worker_signal_f = xbt_parmap_busy_worker_signal;
 199       parmap->master_signal_f = xbt_parmap_busy_master_signal;
 200       parmap->worker_wait_f = xbt_parmap_busy_worker_wait;
 201
 202       xbt_os_cond_destroy(parmap->ready_cond);
 203       xbt_os_mutex_destroy(parmap->ready_mutex);
 204       xbt_os_cond_destroy(parmap->done_cond);
 205       xbt_os_mutex_destroy(parmap->done_mutex);
 206       break;
 207
 208     case XBT_PARMAP_DEFAULT:
 209       THROW_IMPOSSIBLE;
 210       break;
 211   }
 212 }
 213
 214 /**
 215  * \brief Applies a list of tasks in parallel.
 216  * \param parmap a parallel map object
 217  * \param fun the function to call in parallel
 218  * \param data each element of this dynar will be passed as an argument to fun
 219  */
 220 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
 221 {
 222   /* Assign resources to worker threads */
 223   parmap->fun = fun;
 224   parmap->data = data;
 225   parmap->index = 0;
 226   parmap->master_signal_f(parmap);
 227   xbt_parmap_work(parmap);
 228   parmap->master_wait_f(parmap);
 229   XBT_DEBUG("Job done");
 230 }
 231
 232 /**
 233  * \brief Returns a next task to process.
 234  *
 235  * Worker threads call this function to get more work.
 236  *
 237  * \return the next task to process, or NULL if there is no more work
 238  */
 239 void* xbt_parmap_next(xbt_parmap_t parmap)
 240 {
 241   unsigned int index = __sync_fetch_and_add(&parmap->index, 1);
 242   if (index < xbt_dynar_length(parmap->data)) {
 243     return xbt_dynar_get_as(parmap->data, index, void*);
 244   }
 245   return NULL;
 246 }
 247
 248 static void xbt_parmap_work(xbt_parmap_t parmap)
 249 {
 250   unsigned index;
 251   while ((index = __sync_fetch_and_add(&parmap->index, 1))
 252          < xbt_dynar_length(parmap->data))
 253     parmap->fun(xbt_dynar_get_as(parmap->data, index, void*));
 254 }
 255
 256 /**
 257  * \brief Main function of a worker thread.
 258  * \param arg the parmap
 259  */
 260 static void *xbt_parmap_worker_main(void *arg)
 261 {
 262   xbt_parmap_thread_data_t data = (xbt_parmap_thread_data_t) arg;
 263   xbt_parmap_t parmap = data->parmap;
 264   unsigned round = 0;
 265   smx_context_t context = SIMIX_context_new(NULL, 0, NULL, NULL, NULL);
 266   SIMIX_context_set_current(context);
 267
 268   XBT_DEBUG("New worker thread created");
 269
 270   /* Worker's main loop */
 271   while (1) {
 272     parmap->worker_wait_f(parmap, ++round);
 273     if (parmap->status == XBT_PARMAP_WORK) {
 274
 275       XBT_DEBUG("Worker %d got a job", data->worker_id);
 276
 277       xbt_parmap_work(parmap);
 278       parmap->worker_signal_f(parmap);
 279
 280       XBT_DEBUG("Worker %d has finished", data->worker_id);
 281
 282     /* We are destroying the parmap */
 283     } else {
 284       xbt_free(data);
 285       parmap->worker_signal_f(parmap);
 286       return NULL;
 287     }
 288   }
 289 }
 290
 291 #ifdef HAVE_FUTEX_H
 292 static void futex_wait(unsigned *uaddr, unsigned val)
 293 {
 294   XBT_VERB("Waiting on futex %p", uaddr);
 295   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
 296 }
 297
 298 static void futex_wake(unsigned *uaddr, unsigned val)
 299 {
 300   XBT_VERB("Waking futex %p", uaddr);
 301   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
 302 }
 303 #endif
 304
 305 /**
 306  * \brief Starts the parmap: waits for all workers to be ready and returns.
 307  *
 308  * This function is called by the controller thread.
 309  *
 310  * \param parmap a parmap
 311  */
 312 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap)
 313 {
 314   xbt_os_mutex_acquire(parmap->done_mutex);
 315   if (parmap->thread_counter < parmap->num_workers) {
 316     /* wait for all workers to be ready */
 317     xbt_os_cond_wait(parmap->done_cond, parmap->done_mutex);
 318   }
 319   xbt_os_mutex_release(parmap->done_mutex);
 320 }
 321
 322 /**
 323  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 324  *
 325  * This function is called by all worker threads when they end (not including
 326  * the controller).
 327  *
 328  * \param parmap a parmap
 329  */
 330 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap)
 331 {
 332   xbt_os_mutex_acquire(parmap->done_mutex);
 333   if (++parmap->thread_counter == parmap->num_workers) {
 334     /* all workers have finished, wake the controller */
 335     xbt_os_cond_signal(parmap->done_cond);
 336   }
 337   xbt_os_mutex_release(parmap->done_mutex);
 338 }
 339
 340 /**
 341  * \brief Wakes all workers and waits for them to finish the tasks.
 342  *
 343  * This function is called by the controller thread.
 344  *
 345  * \param parmap a parmap
 346  */
 347 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap)
 348 {
 349   xbt_os_mutex_acquire(parmap->ready_mutex);
 350   parmap->thread_counter = 1;
 351   parmap->work++;
 352   /* wake all workers */
 353   xbt_os_cond_broadcast(parmap->ready_cond);
 354   xbt_os_mutex_release(parmap->ready_mutex);
 355 }
 356
 357 /**
 358  * \brief Waits for some work to process.
 359  *
 360  * This function is called by each worker thread (not including the controller)
 361  * when it has no more work to do.
 362  *
 363  * \param parmap a parmap
 364  * \param round  the expected round number
 365  */
 366 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round)
 367 {
 368   xbt_os_mutex_acquire(parmap->ready_mutex);
 369   /* wait for more work */
 370   if (parmap->work != round) {
 371     xbt_os_cond_wait(parmap->ready_cond, parmap->ready_mutex);
 372   }
 373   xbt_os_mutex_release(parmap->ready_mutex);
 374 }
 375
 376 #ifdef HAVE_FUTEX_H
 377 /**
 378  * \brief Starts the parmap: waits for all workers to be ready and returns.
 379  *
 380  * This function is called by the controller thread.
 381  *
 382  * \param parmap a parmap
 383  */
 384 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap)
 385 {
 386   unsigned count = parmap->thread_counter;
 387   while (count < parmap->num_workers) {
 388     /* wait for all workers to be ready */
 389     futex_wait(&parmap->thread_counter, count);
 390     count = parmap->thread_counter;
 391   }
 392 }
 393
 394 /**
 395  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 396  *
 397  * This function is called by all worker threads when they end (not including
 398  * the controller).
 399  *
 400  * \param parmap a parmap
 401  */
 402 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap)
 403 {
 404   unsigned count = __sync_add_and_fetch(&parmap->thread_counter, 1);
 405   if (count == parmap->num_workers) {
 406     /* all workers have finished, wake the controller */
 407     futex_wake(&parmap->thread_counter, INT_MAX);
 408   }
 409 }
 410
 411 /**
 412  * \brief Wakes all workers and waits for them to finish the tasks.
 413  *
 414  * This function is called by the controller thread.
 415  *
 416  * \param parmap a parmap
 417  */
 418 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap)
 419 {
 420   parmap->thread_counter = 1;
 421   __sync_add_and_fetch(&parmap->work, 1);
 422   /* wake all workers */
 423   futex_wake(&parmap->work, INT_MAX);
 424 }
 425
 426 /**
 427  * \brief Waits for some work to process.
 428  *
 429  * This function is called by each worker thread (not including the controller)
 430  * when it has no more work to do.
 431  *
 432  * \param parmap a parmap
 433  * \param round  the expected round number
 434  */
 435 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round)
 436 {
 437   unsigned work = parmap->work;
 438   /* wait for more work */
 439   while (work != round) {
 440     futex_wait(&parmap->work, work);
 441     work = parmap->work;
 442   }
 443 }
 444 #endif
 445
 446 /**
 447  * \brief Starts the parmap: waits for all workers to be ready and returns.
 448  *
 449  * This function is called by the controller thread.
 450  *
 451  * \param parmap a parmap
 452  */
 453 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap)
 454 {
 455   while (parmap->thread_counter < parmap->num_workers) {
 456     xbt_os_thread_yield();
 457   }
 458 }
 459
 460 /**
 461  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 462  *
 463  * This function is called by all worker threads when they end.
 464  *
 465  * \param parmap a parmap
 466  */
 467 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap)
 468 {
 469   __sync_add_and_fetch(&parmap->thread_counter, 1);
 470 }
 471
 472 /**
 473  * \brief Wakes all workers and waits for them to finish the tasks.
 474  *
 475  * This function is called by the controller thread.
 476  *
 477  * \param parmap a parmap
 478  */
 479 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap)
 480 {
 481   parmap->thread_counter = 1;
 482   __sync_add_and_fetch(&parmap->work, 1);
 483 }
 484
 485 /**
 486  * \brief Waits for some work to process.
 487  *
 488  * This function is called by each worker thread (not including the controller)
 489  * when it has no more work to do.
 490  *
 491  * \param parmap a parmap
 492  * \param round  the expected round number
 493  */
 494 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round)
 495 {
 496   /* wait for more work */
 497   while (parmap->work != round) {
 498     xbt_os_thread_yield();
 499   }
 500 }