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   unsigned int core_bind = 0;
 169   for (unsigned i = 1; i < num_workers; i++) {
 170     ThreadData* data = new ThreadData(*this, i);
 171     this->workers[i] = xbt_os_thread_create(worker_main, data);
 172     xbt_os_thread_bind(this->workers[i], core_bind);
 173     if (core_bind != std::thread::hardware_concurrency() - 1)
 174       core_bind++;
 175     else
 176       core_bind = 0;
 177   }
 178 }
 179
 180 /**
 181  * @brief Destroys a parmap
 182  */
 183 template <typename T> Parmap<T>::~Parmap()
 184 {
 185   status = PARMAP_DESTROY;
 186   synchro->master_signal();
 187
 188   for (unsigned i = 1; i < num_workers; i++)
 189     xbt_os_thread_join(workers[i], nullptr);
 190
 191   delete[] workers;
 192   delete synchro;
 193 }
 194
 195 /**
 196  * @brief Applies a list of tasks in parallel.
 197  * @param fun the function to call in parallel
 198  * @param data each element of this vector will be passed as an argument to fun
 199  */
 200 template <typename T> void Parmap<T>::apply(void (*fun)(T), const std::vector<T>& data)
 201 {
 202   /* Assign resources to worker threads (we are maestro here)*/
 203   this->fun   = fun;
 204   this->data  = &data;
 205   this->index = 0;
 206   this->synchro->master_signal(); // maestro runs futex_wake to wake all the minions (the working threads)
 207   this->work();                   // maestro works with its minions
 208   this->synchro->master_wait();   // When there is no more work to do, then maestro waits for the last minion to stop
 209   XBT_CDEBUG(xbt_parmap, "Job done"); //   ... and proceeds
 210 }
 211
 212 /**
 213  * @brief Returns a next task to process.
 214  *
 215  * Worker threads call this function to get more work.
 216  *
 217  * @return the next task to process, or throws a std::out_of_range exception if there is no more work
 218  */
 219 template <typename T> boost::optional<T> Parmap<T>::next()
 220 {
 221   unsigned index = this->index.fetch_add(1, std::memory_order_relaxed);
 222   if (index < this->data->size())
 223     return (*this->data)[index];
 224   else
 225     return boost::none;
 226 }
 227
 228 /**
 229  * @brief Main work loop: applies fun to elements in turn.
 230  */
 231 template <typename T> void Parmap<T>::work()
 232 {
 233   unsigned length = this->data->size();
 234   unsigned index  = this->index.fetch_add(1, std::memory_order_relaxed);
 235   while (index < length) {
 236     this->fun((*this->data)[index]);
 237     index = this->index.fetch_add(1, std::memory_order_relaxed);
 238   }
 239 }
 240
 241 /**
 242  * Get a synchronization object for given mode.
 243  * @param mode the synchronization mode
 244  */
 245 template <typename T> typename Parmap<T>::Synchro* Parmap<T>::new_synchro(e_xbt_parmap_mode_t mode)
 246 {
 247   if (mode == XBT_PARMAP_DEFAULT) {
 248 #if HAVE_FUTEX_H
 249     mode = XBT_PARMAP_FUTEX;
 250 #else
 251     mode = XBT_PARMAP_POSIX;
 252 #endif
 253   }
 254   Synchro* res;
 255   switch (mode) {
 256     case XBT_PARMAP_POSIX:
 257       res = new PosixSynchro(*this);
 258       break;
 259     case XBT_PARMAP_FUTEX:
 260 #if HAVE_FUTEX_H
 261       res = new FutexSynchro(*this);
 262 #else
 263       xbt_die("Futex is not available on this OS.");
 264 #endif
 265       break;
 266     case XBT_PARMAP_BUSY_WAIT:
 267       res = new BusyWaitSynchro(*this);
 268       break;
 269     default:
 270       THROW_IMPOSSIBLE;
 271   }
 272   return res;
 273 }
 274
 275 /** @brief Main function of a worker thread */
 276 template <typename T> void* Parmap<T>::worker_main(void* arg)
 277 {
 278   ThreadData* data      = static_cast<ThreadData*>(arg);
 279   Parmap<T>& parmap     = data->parmap;
 280   unsigned round        = 0;
 281   smx_context_t context = SIMIX_context_new(std::function<void()>(), nullptr, nullptr);
 282   kernel::context::Context::set_current(context);
 283
 284   XBT_CDEBUG(xbt_parmap, "New worker thread created");
 285
 286   /* Worker's main loop */
 287   while (1) {
 288     round++; // New scheduling round
 289     parmap.synchro->worker_wait(round);
 290     if (parmap.status == PARMAP_DESTROY)
 291       break;
 292
 293     XBT_CDEBUG(xbt_parmap, "Worker %d got a job", data->worker_id);
 294     parmap.work();
 295     parmap.synchro->worker_signal();
 296     XBT_CDEBUG(xbt_parmap, "Worker %d has finished", data->worker_id);
 297   }
 298   /* We are destroying the parmap */
 299   delete context;
 300   delete data;
 301   return nullptr;
 302 }
 303
 304 template <typename T> Parmap<T>::PosixSynchro::PosixSynchro(Parmap<T>& parmap) : Synchro(parmap)
 305 {
 306 }
 307
 308 template <typename T> Parmap<T>::PosixSynchro::~PosixSynchro()
 309 {
 310 }
 311
 312 template <typename T> void Parmap<T>::PosixSynchro::master_signal()
 313 {
 314   std::unique_lock<std::mutex> lk(ready_mutex);
 315   this->parmap.thread_counter = 1;
 316   this->parmap.work_round++;
 317   /* wake all workers */
 318   ready_cond.notify_all();
 319 }
 320
 321 template <typename T> void Parmap<T>::PosixSynchro::master_wait()
 322 {
 323   std::unique_lock<std::mutex> lk(done_mutex);
 324   while (this->parmap.thread_counter < this->parmap.num_workers) {
 325     /* wait for all workers to be ready */
 326     done_cond.wait(lk);
 327   }
 328 }
 329
 330 template <typename T> void Parmap<T>::PosixSynchro::worker_signal()
 331 {
 332   std::unique_lock<std::mutex> lk(done_mutex);
 333   this->parmap.thread_counter++;
 334   if (this->parmap.thread_counter == this->parmap.num_workers) {
 335     /* all workers have finished, wake the controller */
 336     done_cond.notify_one();
 337   }
 338 }
 339
 340 template <typename T> void Parmap<T>::PosixSynchro::worker_wait(unsigned round)
 341 {
 342   std::unique_lock<std::mutex> lk(ready_mutex);
 343   /* wait for more work */
 344   while (this->parmap.work_round != round) {
 345     ready_cond.wait(lk);
 346   }
 347 }
 348
 349 #if HAVE_FUTEX_H
 350 template <typename T> inline void Parmap<T>::FutexSynchro::futex_wait(unsigned* uaddr, unsigned val)
 351 {
 352   XBT_CVERB(xbt_parmap, "Waiting on futex %p", uaddr);
 353   syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, nullptr, nullptr, 0);
 354 }
 355
 356 template <typename T> inline void Parmap<T>::FutexSynchro::futex_wake(unsigned* uaddr, unsigned val)
 357 {
 358   XBT_CVERB(xbt_parmap, "Waking futex %p", uaddr);
 359   syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, nullptr, nullptr, 0);
 360 }
 361
 362 template <typename T> void Parmap<T>::FutexSynchro::master_signal()
 363 {
 364   __atomic_store_n(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 365   __atomic_add_fetch(&this->parmap.work_round, 1, __ATOMIC_SEQ_CST);
 366   /* wake all workers */
 367   futex_wake(&this->parmap.work_round, std::numeric_limits<int>::max());
 368 }
 369
 370 template <typename T> void Parmap<T>::FutexSynchro::master_wait()
 371 {
 372   unsigned count = __atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST);
 373   while (count < this->parmap.num_workers) {
 374     /* wait for all workers to be ready */
 375     futex_wait(&this->parmap.thread_counter, count);
 376     count = __atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST);
 377   }
 378 }
 379
 380 template <typename T> void Parmap<T>::FutexSynchro::worker_signal()
 381 {
 382   unsigned count = __atomic_add_fetch(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 383   if (count == this->parmap.num_workers) {
 384     /* all workers have finished, wake the controller */
 385     futex_wake(&this->parmap.thread_counter, std::numeric_limits<int>::max());
 386   }
 387 }
 388
 389 template <typename T> void Parmap<T>::FutexSynchro::worker_wait(unsigned round)
 390 {
 391   unsigned work_round = __atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST);
 392   /* wait for more work */
 393   while (work_round != round) {
 394     futex_wait(&this->parmap.work_round, work_round);
 395     work_round = __atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST);
 396   }
 397 }
 398 #endif
 399
 400 template <typename T> void Parmap<T>::BusyWaitSynchro::master_signal()
 401 {
 402   __atomic_store_n(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 403   __atomic_add_fetch(&this->parmap.work_round, 1, __ATOMIC_SEQ_CST);
 404 }
 405
 406 template <typename T> void Parmap<T>::BusyWaitSynchro::master_wait()
 407 {
 408   while (__atomic_load_n(&this->parmap.thread_counter, __ATOMIC_SEQ_CST) < this->parmap.num_workers) {
 409     std::this_thread::yield();
 410   }
 411 }
 412
 413 template <typename T> void Parmap<T>::BusyWaitSynchro::worker_signal()
 414 {
 415   __atomic_add_fetch(&this->parmap.thread_counter, 1, __ATOMIC_SEQ_CST);
 416 }
 417
 418 template <typename T> void Parmap<T>::BusyWaitSynchro::worker_wait(unsigned round)
 419 {
 420   /* wait for more work */
 421   while (__atomic_load_n(&this->parmap.work_round, __ATOMIC_SEQ_CST) != round) {
 422     std::this_thread::yield();
 423   }
 424 }
 425
 426 /** @} */
 427 }
 428 }
 429
 430 #endif