src/include/xbt/parmap.hpp

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