src/xbt/parmap.cpp

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