src/include/xbt/parmap.hpp

   1 /* A thread pool (C++ version).                                             */
   2
   3 /* Copyright (c) 2004-2018 The SimGrid Team. All rights reserved.           */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef XBT_PARMAP_HPP
   9 #define XBT_PARMAP_HPP
  10
  11 #include "src/internal_config.h" // HAVE_FUTEX_H
  12 #include "src/kernel/context/Context.hpp"
  13 #include "xbt/xbt_os_thread.h"
  14
  15 #include <boost/optional.hpp>
  16 #include <condition_variable>
  17 #include <mutex>
  18 #include <thread>
  19
  20 #if HAVE_FUTEX_H
  21 #include <linux/futex.h>
  22 #include <sys/syscall.h>
  23 #endif
  24
  25 XBT_LOG_EXTERNAL_CATEGORY(xbt_parmap);
  26
  27 namespace simgrid {
  28 namespace xbt {
  29
  30 /** @addtogroup XBT_parmap
  31  * @ingroup XBT_misc
  32  * @brief Parallel map class
  33  * @{
  34  */
  35 template <typename T> class Parmap {
  36 public:
  37   Parmap(unsigned num_workers, e_xbt_parmap_mode_t mode);
  38   Parmap(const Parmap&) = delete;
  39   Parmap& operator=(const Parmap&) = delete;
  40   ~Parmap();
  41   void apply(void (*fun)(T), const std::vector<T>& data);
  42   boost::optional<T> next();
  43
  44 private:
  45   enum Flag { PARMAP_WORK, PARMAP_DESTROY };
  46
  47   /**
  48    * @brief Thread data transmission structure
  49    */
  50   class ThreadData {
  51   public:
  52     ThreadData(Parmap<T>& parmap, int id) : parmap(parmap), worker_id(id) {}
  53     Parmap<T>& parmap;
  54     int worker_id;
  55   };
  56
  57   /**
  58    * @brief Synchronization object (different specializations).
  59    */
  60   class Synchro {
  61   public:
  62     explicit Synchro(Parmap<T>& parmap) : parmap(parmap) {}
  63     virtual ~Synchro() = default;
  64     /**
  65      * @brief Wakes all workers and waits for them to finish the tasks.
  66      *
  67      * This function is called by the controller thread.
  68      */
  69     virtual void master_signal() = 0;
  70     /**
  71      * @brief Starts the parmap: waits for all workers to be ready and returns.
  72      *
  73      * This function is called by the controller thread.
  74      */
  75     virtual void master_wait() = 0;
  76     /**
  77      * @brief Ends the parmap: wakes the controller thread when all workers terminate.
  78      *
  79      * This function is called by all worker threads when they end (not including the controller).
  80      */
  81     virtual void worker_signal() = 0;
  82     /**
  83      * @brief Waits for some work to process.
  84      *
  85      * This function is called by each worker thread (not including the controller) when it has no more work to do.
  86      *
  87      * @param round  the expected round number
  88      */
  89     virtual void worker_wait(unsigned) = 0;
  90
  91     Parmap<T>& parmap;
  92   };
  93
  94   class PosixSynchro : public Synchro {
  95   public:
  96     explicit PosixSynchro(Parmap<T>& parmap);
  97     ~PosixSynchro();
  98     void master_signal();
  99     void master_wait();
 100     void worker_signal();
 101     void worker_wait(unsigned round);
 102
 103   private:
 104     std::condition_variable ready_cond;
 105     std::mutex ready_mutex;
 106     std::condition_variable done_cond;
 107     std::mutex done_mutex;
 108   };
 109
 110 #if HAVE_FUTEX_H
 111   class FutexSynchro : public Synchro {
 112   public:
 113     explicit FutexSynchro(Parmap<T>& parmap) : Synchro(parmap) {}
 114     void master_signal();
 115     void master_wait();
 116     void worker_signal();
 117     void worker_wait(unsigned);
 118
 119   private:
 120     static void futex_wait(unsigned* uaddr, unsigned val);
 121     static void futex_wake(unsigned* uaddr, unsigned val);
 122   };
 123 #endif
 124
 125   class BusyWaitSynchro : public Synchro {
 126   public:
 127     explicit BusyWaitSynchro(Parmap<T>& parmap) : Synchro(parmap) {}
 128     void master_signal();
 129     void master_wait();
 130     void worker_signal();
 131     void worker_wait(unsigned);
 132   };
 133
 134   static void* worker_main(void* arg);
 135   Synchro* new_synchro(e_xbt_parmap_mode_t mode);
 136   void work();
 137
 138   Flag status;              /**< is the parmap active or being destroyed? */
 139   unsigned work_round;      /**< index of the current round */
 140   xbt_os_thread_t* workers; /**< worker thread handlers */
 141   unsigned num_workers;     /**< total number of worker threads including the controller */
 142   Synchro* synchro;         /**< synchronization object */
 143
 144   unsigned thread_counter    = 0;       /**< number of workers that have done the work */
 145   void (*fun)(const T)       = nullptr; /**< function to run in parallel on each element of data */
 146   const std::vector<T>* data = nullptr; /**< parameters to pass to fun in parallel */
 147   std::atomic<unsigned> index;          /**< index of the next element of data to pick */
 148 };
 149
 150 /**
 151  * @brief Creates a parallel map object
 152  * @param num_workers number of worker threads to create
 153  * @param mode how to synchronize the worker threads
 154  */
 155 template <typename T> Parmap<T>::Parmap(unsigned num_workers, e_xbt_parmap_mode_t mode)
 156 {
 157   XBT_CDEBUG(xbt_parmap, "Create new parmap (%u workers)", num_workers);
 158
 159   /* Initialize the thread pool data structure */
 160   this->status      = PARMAP_WORK;
 161   this->work_round  = 0;
 162   this->workers     = new xbt_os_thread_t[num_workers];
 163   this->num_workers = num_workers;
 164   this->synchro     = new_synchro(mode);
 165
 166   /* Create the pool of worker threads */
 167   this->workers[0] = nullptr;
 168 #if HAVE_PTHREAD_SETAFFINITY
 169   int core_bind = 0;
 170 #endif
 171   for (unsigned i = 1; i < num_workers; i++) {
 172     ThreadData* data = new ThreadData(*this, i);
 173     this->workers[i] = xbt_os_thread_create(nullptr, worker_main, data, nullptr);
 174 #if HAVE_PTHREAD_SETAFFINITY
 175     xbt_os_thread_bind(this->workers[i], core_bind);
 176     if (core_bind != xbt_os_get_numcores() - 1)
 177       core_bind++;
 178     else
 179       core_bind = 0;
 180 #endif
 181   }
 182 }
 183
 184 /**
 185  * @brief Destroys a parmap
 186  */
 187 template <typename T> Parmap<T>::~Parmap()
 188 {
 189   status = PARMAP_DESTROY;
 190   synchro->master_signal();
 191
 192   for (unsigned i = 1; i < num_workers; i++)
 193     xbt_os_thread_join(workers[i], nullptr);
 194
 195   delete[] workers;
 196   delete synchro;
 197 }
 198
 199 /**
 200  * @brief Applies a list of tasks in parallel.
 201  * @param fun the function to call in parallel
 202  * @param data each element of this vector will be passed as an argument to fun
 203  */
 204 template <typename T> void Parmap<T>::apply(void (*fun)(T), const std::vector<T>& data)
 205 {
 206   /* Assign resources to worker threads (we are maestro here)*/
 207   this->fun   = fun;
 208   this->data  = &data;
 209   this->index = 0;
 210   this->synchro->master_signal(); // maestro runs futex_wake to wake all the minions (the working threads)
 211   this->work();                   // maestro works with its minions
 212   this->synchro->master_wait();   // When there is no more work to do, then maestro waits for the last minion to stop
 213   XBT_CDEBUG(xbt_parmap, "Job done"); //   ... and proceeds
 214 }
 215
 216 /**
 217  * @brief Returns a next task to process.
 218  *
 219  * Worker threads call this function to get more work.
 220  *
 221  * @return the next task to process, or throws a std::out_of_range exception if there is no more work
 222  */
 223 template <typename T> boost::optional<T> Parmap<T>::next()
 224 {
 225   unsigned index = this->index.fetch_add(1, std::memory_order_relaxed);
 226   if (index < this->data->size())
 227     return (*this->data)[index];
 228   else
 229     return boost::none;
 230 }
 231
 232 /**
 233  * @brief Main work loop: applies fun to elements in turn.
 234  */
 235 template <typename T> void Parmap<T>::work()
 236 {
 237   unsigned length = this->data->size();
 238   unsigned index  = this->index.fetch_add(1, std::memory_order_relaxed);
 239   while (index < length) {
 240     this->fun((*this->data)[index]);
 241     index = this->index.fetch_add(1, std::memory_order_relaxed);
 242   }
 243 }
 244
 245 /**
 246  * Get a synchronization object for given mode.
 247  * @param mode the synchronization mode
 248  */
 249 template <typename T> typename Parmap<T>::Synchro* Parmap<T>::new_synchro(e_xbt_parmap_mode_t mode)
 250 {
 251   if (mode == XBT_PARMAP_DEFAULT) {
 252 #if HAVE_FUTEX_H
 253     mode = XBT_PARMAP_FUTEX;
 254 #else
 255     mode = XBT_PARMAP_POSIX;
 256 #endif
 257   }
 258   Synchro* res;
 259   switch (mode) {
 260     case XBT_PARMAP_POSIX:
 261       res = new PosixSynchro(*this);
 262       break;
 263     case XBT_PARMAP_FUTEX:
 264 #if HAVE_FUTEX_H
 265       res = new FutexSynchro(*this);
 266 #else
 267       xbt_die("Futex is not available on this OS.");
 268 #endif
 269       break;
 270     case XBT_PARMAP_BUSY_WAIT:
 271       res = new BusyWaitSynchro(*this);
 272       break;
 273     default:
 274       THROW_IMPOSSIBLE;
 275   }
 276   return res;
 277 }
 278
 279 /**
 280  * @brief Main function of a worker thread.
 281  */
 282 template <typename T> void* Parmap<T>::worker_main(void* arg)
 283 {
 284   ThreadData* data      = static_cast<ThreadData*>(arg);
 285   Parmap<T>& parmap     = data->parmap;
 286   unsigned round        = 0;
 287   smx_context_t context = SIMIX_context_new(std::function<void()>(), nullptr, nullptr);
 288   SIMIX_context_set_current(context);
 289
 290   XBT_CDEBUG(xbt_parmap, "New worker thread created");
 291
 292   /* Worker's main loop */
 293   while (1) {
 294     round++;
 295     parmap.synchro->worker_wait(round);
 296     if (parmap.status == PARMAP_DESTROY)
 297       break;
 298
 299     XBT_CDEBUG(xbt_parmap, "Worker %d got a job", data->worker_id);
 300     parmap.work();
 301     parmap.synchro->worker_signal();
 302     XBT_CDEBUG(xbt_parmap, "Worker %d has finished", data->worker_id);
 303   }
 304   /* We are destroying the parmap */
 305   delete context;
 306   delete data;
 307   return nullptr;
 308 }
 309
 310 template <typename T> Parmap<T>::PosixSynchro::PosixSynchro(Parmap<T>& parmap) : Synchro(parmap)
 311 {
 312 }
 313
 314 template <typename T> Parmap<T>::PosixSynchro::~PosixSynchro()
 315 {
 316 }
 317
 318 template <typename T> void Parmap<T>::PosixSynchro::master_signal()
 319 {
 320   std::unique_lock<std::mutex> lk(ready_mutex);
 321   this->parmap.thread_counter = 1;
 322   this->parmap.work_round++;
 323   /* wake all workers */
 324   ready_cond.notify_all();
 325 }
 326
 327 template <typename T> void Parmap<T>::PosixSynchro::master_wait()
 328 {
 329   std::unique_lock<std::mutex> lk(done_mutex);
 330   while (this->parmap.thread_counter < this->parmap.num_workers) {
 331     /* wait for all workers to be ready */
 332     done_cond.wait(lk);
 333   }
 334 }
 335
 336 template <typename T> void Parmap<T>::PosixSynchro::worker_signal()
 337 {
 338   std::unique_lock<std::mutex> lk(done_mutex);
 339   this->parmap.thread_counter++;
 340   if (this->parmap.thread_counter == this->parmap.num_workers) {
 341     /* all workers have finished, wake the controller */
 342     done_cond.notify_one();
 343   }
 344 }
 345
 346 template <typename T> void Parmap<T>::PosixSynchro::worker_wait(unsigned round)
 347 {
 348   std::unique_lock<std::mutex> lk(ready_mutex);
 349   /* wait for more work */
 350   while (this->parmap.work_round != round) {
 351     ready_cond.wait(lk);
 352   }
 353 }
 354
 355 #if HAVE_FUTEX_H
 356 template <typename T> inline void Parmap<T>::FutexSynchro::futex_wait(unsigned* uaddr, unsigned val)
 357 {
 358   XBT_CVERB(xbt_parmap, "Waiting on futex %p", uaddr);
 359   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, nullptr, nullptr, 0);
 360 }
 361
 362 template <typename T> inline void Parmap<T>::FutexSynchro::futex_wake(unsigned* uaddr, unsigned val)
 363 {
 364   XBT_CVERB(xbt_parmap, "Waking futex %p", uaddr);
 365   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, nullptr, nullptr, 0);
 366 }
 367
 368 template <typename T> void Parmap<T>::FutexSynchro::master_signal()
 369 {
 370   __atomic_store_n(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 371   __atomic_add_fetch(&this->parmap.work_round, 1, __ATOMIC_SEQ_CST);
 372   /* wake all workers */
 373   futex_wake(&this->parmap.work_round, std::numeric_limits<int>::max());
 374 }
 375
 376 template <typename T> void Parmap<T>::FutexSynchro::master_wait()
 377 {
 378   unsigned count = __atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST);
 379   while (count < this->parmap.num_workers) {
 380     /* wait for all workers to be ready */
 381     futex_wait(&this->parmap.thread_counter, count);
 382     count = __atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST);
 383   }
 384 }
 385
 386 template <typename T> void Parmap<T>::FutexSynchro::worker_signal()
 387 {
 388   unsigned count = __atomic_add_fetch(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 389   if (count == this->parmap.num_workers) {
 390     /* all workers have finished, wake the controller */
 391     futex_wake(&this->parmap.thread_counter, std::numeric_limits<int>::max());
 392   }
 393 }
 394
 395 template <typename T> void Parmap<T>::FutexSynchro::worker_wait(unsigned round)
 396 {
 397   unsigned work_round = __atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST);
 398   /* wait for more work */
 399   while (work_round != round) {
 400     futex_wait(&this->parmap.work_round, work_round);
 401     work_round = __atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST);
 402   }
 403 }
 404 #endif
 405
 406 template <typename T> void Parmap<T>::BusyWaitSynchro::master_signal()
 407 {
 408   __atomic_store_n(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 409   __atomic_add_fetch(&this->parmap.work_round, 1, __ATOMIC_SEQ_CST);
 410 }
 411
 412 template <typename T> void Parmap<T>::BusyWaitSynchro::master_wait()
 413 {
 414   while (__atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST) < this->parmap.num_workers) {
 415     std::this_thread::yield();
 416   }
 417 }
 418
 419 template <typename T> void Parmap<T>::BusyWaitSynchro::worker_signal()
 420 {
 421   __atomic_add_fetch(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 422 }
 423
 424 template <typename T> void Parmap<T>::BusyWaitSynchro::worker_wait(unsigned round)
 425 {
 426   /* wait for more work */
 427   while (__atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST) != round) {
 428     std::this_thread::yield();
 429   }
 430 }
 431
 432 /** @} */
 433 }
 434 }
 435
 436 #endif