src/xbt/parmap.cpp

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