worker_pool.H

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
# ifndef WORKER_POOL_H
# define WORKER_POOL_H
 
# include <thread>
# include <mutex>
# include <condition_variable>
# include <memory>
 
# include <ah-errors.H>
# include <tpl_arrayQueue.H>
# include <iostream>
 
using namespace Aleph;
 
template <class WorkerFct>
class WorkersSet
{
private:
 
  WorkerFct worker_fct = nullptr;
  size_t num_threads = 0;
  std::mutex m;
  std::condition_variable cond;
 
  std::atomic<size_t> num_workers = 0;
 
  FixedQueue<void*> q;
  DynList<std::thread> threads;
  bool shut_down = false;
  bool job_done = false;
 
  std::condition_variable job_done_cond;
  std::mutex job_done_mutex;
 
  void worker_handler()
  {
    std::unique_lock<std::mutex> lock(m);
    while (true)
      {
        cond.wait(lock, [this] { return num_workers > 0 or shut_down; });
         if (shut_down)
          return;
 
         while (num_workers > 0)
           {
             cond.wait(lock, [this]
             {
               return (not q.is_empty()) or shut_down;
             });
             
             if (shut_down)
               return;
 
             if (not q.is_empty())
               {
                 void * pars_ptr = q.get();
 
                 if (not job_done)
                   {
                     lock.unlock();
                     try
                       {
                         job_done = (*worker_fct)(pars_ptr);
                       }
                    catch (std::exception & e)
                      {
                        std::cout << "Warning: workers exception "
                                  << e.what() << std::endl;
                       }
                     lock.lock();
                     free(pars_ptr);
                   }
                 --num_workers;
               }
           }
 
         assert(q.is_empty());
         job_done_cond.notify_one();
         continue;
      }
  }
  
public:
 
  WorkersSet(WorkerFct worker_fct,
             const size_t qsize, const size_t n = 16)
    : worker_fct(worker_fct), num_threads(n), q(qsize)
  {
    for (size_t i = 0; i < n; ++i)
      threads.append(std::thread(&WorkersSet::worker_handler, this));
  }
 
  void shutdown()
  {
    std::unique_lock<std::mutex> lock(m);
    shut_down = true;
    cond.notify_all();
  }
 
  ~WorkersSet()
  {
    shutdown();
    threads.mutable_for_each([] (std::thread & th) { th.join(); });
  }
 
  void prepare_num_workers(size_t n)
  {
    std::unique_lock<std::mutex> lock(m);
    num_workers = n;
  }
 
  void schedule_call(void * pars_ptr)
  {
    std::unique_lock<std::mutex> lock(m);
    q.put(pars_ptr);
    cond.notify_one();
  }
 
  bool is_jobs_done() const
  {
    std::unique_lock<std::mutex> lock(m);
    return job_done;
  }
 
  void wait_until_all_workers_finished_or_job_is_done()
  {
    std::unique_lock<std::mutex> lock(job_done_mutex);
    job_done_cond.wait(lock);
  }
};
 
 
# endif