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   parmap->workers[0] = nullptr;
 118 #if HAVE_PTHREAD_SETAFFINITY
 119   int core_bind = 0;
 120 #endif
 121   for (unsigned int i = 1; i < num_workers; i++) {
 122     xbt_parmap_thread_data_t data = xbt_new0(s_xbt_parmap_thread_data_t, 1);
 123     data->parmap = parmap;
 124     data->worker_id = i;
 125     parmap->workers[i] = xbt_os_thread_create(nullptr, xbt_parmap_worker_main, data, nullptr);
 126 #if HAVE_PTHREAD_SETAFFINITY
 127     xbt_os_thread_bind(parmap->workers[i], core_bind);
 128     if (core_bind != xbt_os_get_numcores() - 1)
 129       core_bind++;
 130     else
 131       core_bind = 0;
 132 #endif
 133   }
 134   return parmap;
 135 }
 136
 137 /**
 138  * \brief Destroys a parmap
 139  * \param parmap the parmap to destroy
 140  */
 141 void xbt_parmap_destroy(xbt_parmap_t parmap)
 142 {
 143   if (not parmap) {
 144     return;
 145   }
 146
 147   parmap->status = XBT_PARMAP_DESTROY;
 148   parmap->master_signal_f(parmap);
 149
 150   unsigned int i;
 151   for (i = 1; i < parmap->num_workers; i++)
 152     xbt_os_thread_join(parmap->workers[i], nullptr);
 153
 154   xbt_os_cond_destroy(parmap->ready_cond);
 155   xbt_os_mutex_destroy(parmap->ready_mutex);
 156   xbt_os_cond_destroy(parmap->done_cond);
 157   xbt_os_mutex_destroy(parmap->done_mutex);
 158
 159   xbt_free(parmap->workers);
 160   delete parmap;
 161 }
 162
 163 /**
 164  * \brief Sets the synchronization mode of a parmap.
 165  * \param parmap a parallel map object
 166  * \param mode the synchronization mode
 167  */
 168 static void xbt_parmap_set_mode(xbt_parmap_t parmap, e_xbt_parmap_mode_t mode)
 169 {
 170   if (mode == XBT_PARMAP_DEFAULT) {
 171 #if HAVE_FUTEX_H
 172     mode = XBT_PARMAP_FUTEX;
 173 #else
 174     mode = XBT_PARMAP_POSIX;
 175 #endif
 176   }
 177   parmap->mode = mode;
 178
 179   switch (mode) {
 180     case XBT_PARMAP_POSIX:
 181       parmap->master_wait_f   = &xbt_parmap_posix_master_wait;
 182       parmap->worker_signal_f = &xbt_parmap_posix_worker_signal;
 183       parmap->master_signal_f = &xbt_parmap_posix_master_signal;
 184       parmap->worker_wait_f   = &xbt_parmap_posix_worker_wait;
 185
 186       parmap->ready_cond = xbt_os_cond_init();
 187       parmap->ready_mutex = xbt_os_mutex_init();
 188       parmap->done_cond = xbt_os_cond_init();
 189       parmap->done_mutex = xbt_os_mutex_init();
 190       break;
 191     case XBT_PARMAP_FUTEX:
 192 #if HAVE_FUTEX_H
 193       parmap->master_wait_f   = &xbt_parmap_futex_master_wait;
 194       parmap->worker_signal_f = &xbt_parmap_futex_worker_signal;
 195       parmap->master_signal_f = &xbt_parmap_futex_master_signal;
 196       parmap->worker_wait_f   = &xbt_parmap_futex_worker_wait;
 197
 198       xbt_os_cond_destroy(parmap->ready_cond);
 199       xbt_os_mutex_destroy(parmap->ready_mutex);
 200       xbt_os_cond_destroy(parmap->done_cond);
 201       xbt_os_mutex_destroy(parmap->done_mutex);
 202       break;
 203 #else
 204       xbt_die("Futex is not available on this OS.");
 205 #endif
 206     case XBT_PARMAP_BUSY_WAIT:
 207       parmap->master_wait_f   = &xbt_parmap_busy_master_wait;
 208       parmap->worker_signal_f = &xbt_parmap_busy_worker_signal;
 209       parmap->master_signal_f = &xbt_parmap_busy_master_signal;
 210       parmap->worker_wait_f   = &xbt_parmap_busy_worker_wait;
 211
 212       xbt_os_cond_destroy(parmap->ready_cond);
 213       xbt_os_mutex_destroy(parmap->ready_mutex);
 214       xbt_os_cond_destroy(parmap->done_cond);
 215       xbt_os_mutex_destroy(parmap->done_mutex);
 216       break;
 217     case XBT_PARMAP_DEFAULT:
 218       THROW_IMPOSSIBLE;
 219       break;
 220     default:
 221       THROW_IMPOSSIBLE;
 222   }
 223 }
 224
 225 /**
 226  * \brief Applies a list of tasks in parallel.
 227  * \param parmap a parallel map object
 228  * \param fun the function to call in parallel
 229  * \param data each element of this dynar will be passed as an argument to fun
 230  */
 231 void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
 232 {
 233   /* Assign resources to worker threads (we are maestro here)*/
 234   parmap->fun = fun;
 235   parmap->data = data;
 236   parmap->index = 0;
 237   parmap->master_signal_f(parmap); // maestro runs futex_wait to wake all the minions (the working threads)
 238   xbt_parmap_work(parmap);         // maestro works with its minions
 239   parmap->master_wait_f(parmap);   // When there is no more work to do, then maestro waits for the last minion to stop
 240   XBT_DEBUG("Job done");           //   ... and proceeds
 241 }
 242
 243 /**
 244  * \brief Returns a next task to process.
 245  *
 246  * Worker threads call this function to get more work.
 247  *
 248  * \return the next task to process, or nullptr if there is no more work
 249  */
 250 void* xbt_parmap_next(xbt_parmap_t parmap)
 251 {
 252   unsigned int index = parmap->index++;
 253   if (index < xbt_dynar_length(parmap->data)) {
 254     return xbt_dynar_get_as(parmap->data, index, void*);
 255   }
 256   return nullptr;
 257 }
 258
 259 static void xbt_parmap_work(xbt_parmap_t parmap)
 260 {
 261   unsigned int index = parmap->index++;
 262   while (index < xbt_dynar_length(parmap->data)){
 263     parmap->fun(xbt_dynar_get_as(parmap->data, index, void*));
 264     index = parmap->index++;
 265   }
 266 }
 267
 268 /**
 269  * \brief Main function of a worker thread.
 270  * \param arg the parmap
 271  */
 272 static void *xbt_parmap_worker_main(void *arg)
 273 {
 274   xbt_parmap_thread_data_t data = static_cast<xbt_parmap_thread_data_t>(arg);
 275   xbt_parmap_t parmap = data->parmap;
 276   unsigned round = 0;
 277   smx_context_t context = SIMIX_context_new(std::function<void()>(), nullptr, nullptr);
 278   SIMIX_context_set_current(context);
 279
 280   XBT_DEBUG("New worker thread created");
 281
 282   /* Worker's main loop */
 283   while (1) {
 284     round++;
 285     parmap->worker_wait_f(parmap, round);
 286     if (parmap->status == XBT_PARMAP_WORK) {
 287       XBT_DEBUG("Worker %d got a job", data->worker_id);
 288
 289       xbt_parmap_work(parmap);
 290       parmap->worker_signal_f(parmap);
 291
 292       XBT_DEBUG("Worker %d has finished", data->worker_id);
 293     /* We are destroying the parmap */
 294     } else {
 295       delete context;
 296       xbt_free(data);
 297       return nullptr;
 298     }
 299   }
 300 }
 301
 302 #if HAVE_FUTEX_H
 303 static void futex_wait(unsigned *uaddr, unsigned val)
 304 {
 305   XBT_VERB("Waiting on futex %p", uaddr);
 306   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, nullptr, nullptr, 0);
 307 }
 308
 309 static void futex_wake(unsigned *uaddr, unsigned val)
 310 {
 311   XBT_VERB("Waking futex %p", uaddr);
 312   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, nullptr, nullptr, 0);
 313 }
 314 #endif
 315
 316 /**
 317  * \brief Starts the parmap: waits for all workers to be ready and returns.
 318  *
 319  * This function is called by the controller thread.
 320  *
 321  * \param parmap a parmap
 322  */
 323 static void xbt_parmap_posix_master_wait(xbt_parmap_t parmap)
 324 {
 325   xbt_os_mutex_acquire(parmap->done_mutex);
 326   if (parmap->thread_counter < parmap->num_workers) {
 327     /* wait for all workers to be ready */
 328     xbt_os_cond_wait(parmap->done_cond, parmap->done_mutex);
 329   }
 330   xbt_os_mutex_release(parmap->done_mutex);
 331 }
 332
 333 /**
 334  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 335  *
 336  * This function is called by all worker threads when they end (not including the controller).
 337  *
 338  * \param parmap a parmap
 339  */
 340 static void xbt_parmap_posix_worker_signal(xbt_parmap_t parmap)
 341 {
 342   xbt_os_mutex_acquire(parmap->done_mutex);
 343   parmap->thread_counter++;
 344   if (parmap->thread_counter == parmap->num_workers) {
 345     /* all workers have finished, wake the controller */
 346     xbt_os_cond_signal(parmap->done_cond);
 347   }
 348   xbt_os_mutex_release(parmap->done_mutex);
 349 }
 350
 351 /**
 352  * \brief Wakes all workers and waits for them to finish the tasks.
 353  *
 354  * This function is called by the controller thread.
 355  *
 356  * \param parmap a parmap
 357  */
 358 static void xbt_parmap_posix_master_signal(xbt_parmap_t parmap)
 359 {
 360   xbt_os_mutex_acquire(parmap->ready_mutex);
 361   parmap->thread_counter = 1;
 362   parmap->work++;
 363   /* wake all workers */
 364   xbt_os_cond_broadcast(parmap->ready_cond);
 365   xbt_os_mutex_release(parmap->ready_mutex);
 366 }
 367
 368 /**
 369  * \brief Waits for some work to process.
 370  *
 371  * This function is called by each worker thread (not including the controller) when it has no more work to do.
 372  *
 373  * \param parmap a parmap
 374  * \param round  the expected round number
 375  */
 376 static void xbt_parmap_posix_worker_wait(xbt_parmap_t parmap, unsigned round)
 377 {
 378   xbt_os_mutex_acquire(parmap->ready_mutex);
 379   /* wait for more work */
 380   if (parmap->work != round) {
 381     xbt_os_cond_wait(parmap->ready_cond, parmap->ready_mutex);
 382   }
 383   xbt_os_mutex_release(parmap->ready_mutex);
 384 }
 385
 386 #if HAVE_FUTEX_H
 387 /**
 388  * \brief Starts the parmap: waits for all workers to be ready and returns.
 389  *
 390  * This function is called by the controller thread.
 391  *
 392  * \param parmap a parmap
 393  */
 394 static void xbt_parmap_futex_master_wait(xbt_parmap_t parmap)
 395 {
 396   unsigned count = parmap->thread_counter;
 397   while (count < parmap->num_workers) {
 398     /* wait for all workers to be ready */
 399     futex_wait(&parmap->thread_counter, count);
 400     count = parmap->thread_counter;
 401   }
 402 }
 403
 404 /**
 405  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 406  *
 407  * This function is called by all worker threads when they end (not including the controller).
 408  *
 409  * \param parmap a parmap
 410  */
 411 static void xbt_parmap_futex_worker_signal(xbt_parmap_t parmap)
 412 {
 413   unsigned count = __sync_add_and_fetch(&parmap->thread_counter, 1);
 414   if (count == parmap->num_workers) {
 415     /* all workers have finished, wake the controller */
 416     futex_wake(&parmap->thread_counter, INT_MAX);
 417   }
 418 }
 419
 420 /**
 421  * \brief Wakes all workers and waits for them to finish the tasks.
 422  *
 423  * This function is called by the controller thread.
 424  *
 425  * \param parmap a parmap
 426  */
 427 static void xbt_parmap_futex_master_signal(xbt_parmap_t parmap)
 428 {
 429   parmap->thread_counter = 1;
 430   __sync_add_and_fetch(&parmap->work, 1);
 431   /* wake all workers */
 432   futex_wake(&parmap->work, INT_MAX);
 433 }
 434
 435 /**
 436  * \brief Waits for some work to process.
 437  *
 438  * This function is called by each worker thread (not including the controller) when it has no more work to do.
 439  *
 440  * \param parmap a parmap
 441  * \param round  the expected round number
 442  */
 443 static void xbt_parmap_futex_worker_wait(xbt_parmap_t parmap, unsigned round)
 444 {
 445   unsigned work = parmap->work;
 446   /* wait for more work */
 447   while (work != round) {
 448     futex_wait(&parmap->work, work);
 449     work = parmap->work;
 450   }
 451 }
 452 #endif
 453
 454 /**
 455  * \brief Starts the parmap: waits for all workers to be ready and returns.
 456  *
 457  * This function is called by the controller thread.
 458  *
 459  * \param parmap a parmap
 460  */
 461 static void xbt_parmap_busy_master_wait(xbt_parmap_t parmap)
 462 {
 463   while (parmap->thread_counter < parmap->num_workers) {
 464     xbt_os_thread_yield();
 465   }
 466 }
 467
 468 /**
 469  * \brief Ends the parmap: wakes the controller thread when all workers terminate.
 470  *
 471  * This function is called by all worker threads when they end.
 472  *
 473  * \param parmap a parmap
 474  */
 475 static void xbt_parmap_busy_worker_signal(xbt_parmap_t parmap)
 476 {
 477   __sync_add_and_fetch(&parmap->thread_counter, 1);
 478 }
 479
 480 /**
 481  * \brief Wakes all workers and waits for them to finish the tasks.
 482  *
 483  * This function is called by the controller thread.
 484  *
 485  * \param parmap a parmap
 486  */
 487 static void xbt_parmap_busy_master_signal(xbt_parmap_t parmap)
 488 {
 489   parmap->thread_counter = 1;
 490   __sync_add_and_fetch(&parmap->work, 1);
 491 }
 492
 493 /**
 494  * \brief Waits for some work to process.
 495  *
 496  * This function is called by each worker thread (not including the controller) when it has no more work to do.
 497  *
 498  * \param parmap a parmap
 499  * \param round  the expected round number
 500  */
 501 static void xbt_parmap_busy_worker_wait(xbt_parmap_t parmap, unsigned round)
 502 {
 503   /* wait for more work */
 504   while (parmap->work != round) {
 505     xbt_os_thread_yield();
 506   }
 507 }