#include <ThreadPool.hh>

Classes
struct	Config

Public Types
template<typename KeyT, typename MappedT, typename HashT = KeyT>
using	uomap = std::unordered_map<KeyT, MappedT, std::hash<HashT>>

using	size_type = size_t

using	task_count_type = std::shared_ptr<std::atomic_uintmax_t>

using	atomic_int_type = std::shared_ptr<std::atomic_uintmax_t>

using	pool_state_type = std::shared_ptr<std::atomic_short>

using	atomic_bool_type = std::shared_ptr<std::atomic_bool>

using	task_type = VTask

using	lock_t = std::shared_ptr<Mutex>

using	condition_t = std::shared_ptr<Condition>

using	task_pointer = std::shared_ptr<task_type>

using	task_queue_t = VUserTaskQueue

using	thread_list_t = std::deque<ThreadId>

using	bool_list_t = std::vector<bool>

using	thread_id_map_t = std::map<ThreadId, uintmax_t>

using	thread_index_map_t = std::map<uintmax_t, ThreadId>

using	thread_vec_t = std::vector<Thread>

using	thread_data_t = std::vector<std::shared_ptr<ThreadData>>

using	initialize_func_t = std::function<void()>

using	finalize_func_t = std::function<void()>

using	affinity_func_t = std::function<intmax_t(intmax_t)>

Public Member Functions
	ThreadPool (const Config &)

	~ThreadPool ()

	ThreadPool (const ThreadPool &)=delete

	ThreadPool (ThreadPool &&)=default

ThreadPool &	operator= (const ThreadPool &)=delete

ThreadPool &	operator= (ThreadPool &&)=default

size_type	initialize_threadpool (size_type)

size_type	destroy_threadpool ()

size_type	stop_thread ()

template<typename FuncT>
void	execute_on_all_threads (FuncT &&_func)

template<typename FuncT>
void	execute_on_specific_threads (const std::set< std::thread::id > &_tid, FuncT &&_func)

task_queue_t *	get_queue () const

task_queue_t *&	get_valid_queue (task_queue_t *&) const

bool	is_tbb_threadpool () const

size_type	add_task (task_pointer &&task, int bin=-1)

template<typename ListT>
size_type	add_tasks (ListT &)

Thread *	get_thread (size_type _n) const

Thread *	get_thread (std::thread::id id) const

void	set_initialization (initialize_func_t f)

void	set_finalization (finalize_func_t f)

void	reset_initialization ()

void	reset_finalization ()

const pool_state_type &	state () const

size_type	size () const

void	resize (size_type _n)

bool	using_affinity () const

bool	is_alive ()

void	notify ()

void	notify_all ()

void	notify (size_type)

bool	is_initialized () const

int	get_active_threads_count () const

void	set_affinity (affinity_func_t f)

void	set_affinity (intmax_t i, Thread &) const

void	set_priority (int _prio, Thread &) const

void	set_verbose (int n)

int	get_verbose () const

bool	is_main () const

tbb_task_arena_t *	get_task_arena ()

Static Public Member Functions
static affinity_func_t &	affinity_functor ()

static initialize_func_t &	initialization_functor ()

static finalize_func_t &	finalization_functor ()

static void	set_default_size (size_type _v)
	set the default pool size

static size_type	get_default_size ()
	get the default pool size

static tbb_global_control_t *&	tbb_global_control ()

static const thread_id_map_t &	get_thread_ids ()

static uintmax_t	get_thread_id (ThreadId)

static uintmax_t	get_this_thread_id ()

static uintmax_t	add_thread_id (ThreadId=ThisThread::get_id())

Detailed Description

Definition at line 87 of file ThreadPool.hh.

Member Typedef Documentation

◆ affinity_func_t

using PTL::ThreadPool::affinity_func_t = std::function<intmax_t(intmax_t)>

Definition at line 115 of file ThreadPool.hh.

◆ atomic_bool_type

using PTL::ThreadPool::atomic_bool_type = std::shared_ptr<std::atomic_bool>

Definition at line 98 of file ThreadPool.hh.

◆ atomic_int_type

using PTL::ThreadPool::atomic_int_type = std::shared_ptr<std::atomic_uintmax_t>

Definition at line 96 of file ThreadPool.hh.

◆ bool_list_t

using PTL::ThreadPool::bool_list_t = std::vector<bool>

Definition at line 107 of file ThreadPool.hh.

◆ condition_t

using PTL::ThreadPool::condition_t = std::shared_ptr<Condition>

Definition at line 102 of file ThreadPool.hh.

◆ finalize_func_t

using PTL::ThreadPool::finalize_func_t = std::function<void()>

Definition at line 114 of file ThreadPool.hh.

◆ initialize_func_t

using PTL::ThreadPool::initialize_func_t = std::function<void()>

Definition at line 113 of file ThreadPool.hh.

◆ lock_t

using PTL::ThreadPool::lock_t = std::shared_ptr<Mutex>

Definition at line 101 of file ThreadPool.hh.

◆ pool_state_type

using PTL::ThreadPool::pool_state_type = std::shared_ptr<std::atomic_short>

Definition at line 97 of file ThreadPool.hh.

◆ size_type

using PTL::ThreadPool::size_type = size_t

Definition at line 94 of file ThreadPool.hh.

◆ task_count_type

using PTL::ThreadPool::task_count_type = std::shared_ptr<std::atomic_uintmax_t>

Definition at line 95 of file ThreadPool.hh.

◆ task_pointer

using PTL::ThreadPool::task_pointer = std::shared_ptr<task_type>

Definition at line 103 of file ThreadPool.hh.

◆ task_queue_t

using PTL::ThreadPool::task_queue_t = VUserTaskQueue

Definition at line 104 of file ThreadPool.hh.

◆ task_type

using PTL::ThreadPool::task_type = VTask

Definition at line 100 of file ThreadPool.hh.

◆ thread_data_t

using PTL::ThreadPool::thread_data_t = std::vector<std::shared_ptr<ThreadData>>

Definition at line 111 of file ThreadPool.hh.

◆ thread_id_map_t

using PTL::ThreadPool::thread_id_map_t = std::map<ThreadId, uintmax_t>

Definition at line 108 of file ThreadPool.hh.

◆ thread_index_map_t

using PTL::ThreadPool::thread_index_map_t = std::map<uintmax_t, ThreadId>

Definition at line 109 of file ThreadPool.hh.

◆ thread_list_t

using PTL::ThreadPool::thread_list_t = std::deque<ThreadId>

Definition at line 106 of file ThreadPool.hh.

◆ thread_vec_t

using PTL::ThreadPool::thread_vec_t = std::vector<Thread>

Definition at line 110 of file ThreadPool.hh.

◆ uomap

template<typename KeyT, typename MappedT, typename HashT = KeyT>

using PTL::ThreadPool::uomap = std::unordered_map<KeyT, MappedT, std::hash<HashT>>

Definition at line 91 of file ThreadPool.hh.

Constructor & Destructor Documentation

◆ ThreadPool() [1/3]

PTL::ThreadPool::ThreadPool ( const Config & _cfg )

explicit

Definition at line 172 of file ThreadPool.cc.

: m_use_affinity{ _cfg.use_affinity }
, m_tbb_tp{ _cfg.use_tbb }
, m_verbose{ _cfg.verbose }
, m_priority{ _cfg.priority }
, m_pool_state{ std::make_shared<std::atomic_short>(thread_pool::state::NONINIT) }
, m_task_queue{ _cfg.task_queue }
, m_init_func{ _cfg.initializer }
, m_fini_func{ _cfg.finalizer }
, m_affinity_func{ _cfg.set_affinity }
{
    auto master_id = get_this_thread_id();
    if(master_id != 0 && m_verbose > 1)
    {
        AutoLock lock(TypeMutex<decltype(std::cerr)>());
        std::cerr << "[PTL::ThreadPool] ThreadPool created on worker thread" << std::endl;
    }
 
    thread_data() = new ThreadData(this);
 
    // initialize after get_this_thread_id so master is zero
    if(_cfg.init)
        this->initialize_threadpool(_cfg.pool_size);
}

Referenced by operator=(), operator=(), ThreadPool(), and ThreadPool().

◆ ~ThreadPool()

PTL::ThreadPool::~ThreadPool ( )

Definition at line 199 of file ThreadPool.cc.

{
    if(m_alive_flag->load())
    {
        std::cerr << "Warning! ThreadPool was not properly destroyed! Call "
                     "destroy_threadpool() before deleting the ThreadPool object to "
                     "eliminate this message."
                  << std::endl;
        m_pool_state->store(thread_pool::state::STOPPED);
        m_task_lock->lock();
        m_task_cond->notify_all();
        m_task_lock->unlock();
        for(auto& itr : m_threads)
            itr.join();
        m_threads.clear();
    }
 
    // delete owned resources
    if(m_delete_task_queue)
        delete m_task_queue;
 
    delete m_tbb_task_arena;
    delete m_tbb_task_group;
}

◆ ThreadPool() [2/3]

PTL::ThreadPool::ThreadPool ( const ThreadPool & )

delete

◆ ThreadPool() [3/3]

PTL::ThreadPool::ThreadPool ( ThreadPool && )

default

Member Function Documentation

◆ add_task()

ThreadPool::size_type PTL::ThreadPool::add_task	(	task_pointer &&	task,
		int	bin = -1 )

inline

Definition at line 411 of file ThreadPool.hh.

{
    // if not native (i.e. TBB) or we haven't built thread-pool, just execute
    if(m_tbb_tp || !task->is_native_task() || !m_alive_flag->load())
        return static_cast<size_type>(run_on_this(std::move(task)));
 
    return static_cast<size_type>(insert(std::move(task), bin));
}

◆ add_tasks()

template<typename ListT>

ThreadPool::size_type PTL::ThreadPool::add_tasks ( ListT & c )

inline

Definition at line 422 of file ThreadPool.hh.

{
    if(!m_alive_flag)  // if we haven't built thread-pool, just execute
    {
        for(auto& itr : c)
            run(itr);
        c.clear();
        return 0;
    }
 
    // TODO: put a limit on how many tasks can be added at most
    auto c_size = c.size();
    for(auto& itr : c)
    {
        if(!itr->is_native_task())
            --c_size;
        else
        {
            //++(m_task_queue);
            get_valid_queue(m_task_queue)->InsertTask(itr);
        }
    }
    c.clear();
 
    // notify sleeping threads
    notify(c_size);
 
    return c_size;
}

◆ add_thread_id()

uintmax_t PTL::ThreadPool::add_thread_id ( ThreadId _tid = ThisThread::get_id() )

static

Definition at line 156 of file ThreadPool.cc.

{
    AutoLock lock(TypeMutex<ThreadPool>(), std::defer_lock);
    if(!lock.owns_lock())
        lock.lock();
    if(f_thread_ids().find(_tid) == f_thread_ids().end())
    {
        auto _idx            = f_thread_ids().size();
        f_thread_ids()[_tid] = _idx;
        SetThreadId((int)_idx);
    }
    return f_thread_ids().at(_tid);
}

Referenced by execute_on_all_threads(), and execute_on_specific_threads().

◆ affinity_functor()

static affinity_func_t & PTL::ThreadPool::affinity_functor ( )

inlinestatic

Definition at line 117 of file ThreadPool.hh.

    {
        static affinity_func_t _v = [](intmax_t) {
            static std::atomic<intmax_t> assigned;
            intmax_t                     _assign = assigned++;
            return _assign % Thread::hardware_concurrency();
        };
        return _v;
    }

◆ destroy_threadpool()

ThreadPool::size_type PTL::ThreadPool::destroy_threadpool ( )

Definition at line 468 of file ThreadPool.cc.

{
    // Note: this is not for synchronization, its for thread communication!
    // destroy_threadpool() will only be called from the main thread, yet
    // the modified m_pool_state may not show up to other threads until its
    // modified in a lock!
    //------------------------------------------------------------------------//
    m_pool_state->store(thread_pool::state::STOPPED);
 
    //--------------------------------------------------------------------//
    // handle tbb task scheduler
#if defined(PTL_USE_TBB)
    if(m_tbb_task_group)
    {
        execute_on_all_threads([this]() { m_fini_func(); });
        auto _func = [&]() { m_tbb_task_group->wait(); };
        if(m_tbb_task_arena)
            m_tbb_task_arena->execute(_func);
        else
            _func();
        delete m_tbb_task_group;
        m_tbb_task_group = nullptr;
    }
    if(m_tbb_task_arena)
    {
        delete m_tbb_task_arena;
        m_tbb_task_arena = nullptr;
    }
    if(m_tbb_tp && tbb_global_control())
    {
        tbb_global_control_t*& _global_control = tbb_global_control();
        delete _global_control;
        _global_control = nullptr;
        m_tbb_tp        = false;
        AutoLock lock(TypeMutex<decltype(std::cerr)>());
        if(m_verbose > 0)
        {
            std::cerr << "[PTL::ThreadPool] ThreadPool [TBB] destroyed" << std::endl;
        }
    }
#endif
 
    if(!m_alive_flag->load())
        return 0;
 
    //------------------------------------------------------------------------//
    // notify all threads we are shutting down
    m_task_lock->lock();
    m_task_cond->notify_all();
    m_task_lock->unlock();
    //------------------------------------------------------------------------//
 
    if(m_is_joined.size() != m_main_threads.size())
    {
        std::stringstream ss;
        ss << "   ThreadPool::destroy_thread_pool - boolean is_joined vector "
           << "is a different size than threads vector: " << m_is_joined.size() << " vs. "
           << m_main_threads.size() << " (tid: " << std::this_thread::get_id() << ")";
 
        throw std::runtime_error(ss.str());
    }
 
    for(size_type i = 0; i < m_is_joined.size(); i++)
    {
        //--------------------------------------------------------------------//
        //
        if(i < m_threads.size())
            m_threads.at(i).join();
 
        //--------------------------------------------------------------------//
        // if its joined already, nothing else needs to be done
        if(m_is_joined.at(i))
            continue;
 
        //--------------------------------------------------------------------//
        // join
        if(std::this_thread::get_id() == m_main_threads[i])
            continue;
 
        //--------------------------------------------------------------------//
        // thread id and index
        auto _tid = m_main_threads[i];
 
        //--------------------------------------------------------------------//
        // erase thread from thread ID list
        if(f_thread_ids().find(_tid) != f_thread_ids().end())
            f_thread_ids().erase(f_thread_ids().find(_tid));
 
        //--------------------------------------------------------------------//
        // it's joined
        m_is_joined.at(i) = true;
    }
 
    m_thread_data.clear();
    m_threads.clear();
    m_main_threads.clear();
    m_is_joined.clear();
 
    m_alive_flag->store(false);
 
    auto start   = std::chrono::steady_clock::now();
    auto elapsed = std::chrono::duration<double>{};
    // wait maximum of 30 seconds for threads to exit
    while(m_thread_active->load() > 0 && elapsed.count() < 30)
    {
        std::this_thread::sleep_for(std::chrono::milliseconds(50));
        elapsed = std::chrono::steady_clock::now() - start;
    }
 
    auto _active = m_thread_active->load();
 
    if(get_verbose() > 0)
    {
        if(_active == 0)
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] ThreadPool destroyed" << std::endl;
        }
        else
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] ThreadPool destroyed but " << _active
                      << " threads might still be active (and cause a termination error)"
                      << std::endl;
        }
    }
 
    if(m_delete_task_queue)
    {
        delete m_task_queue;
        m_task_queue = nullptr;
    }
 
    return 0;
}

◆ execute_on_all_threads()

template<typename FuncT>

void PTL::ThreadPool::execute_on_all_threads ( FuncT && _func )

inline

Definition at line 454 of file ThreadPool.hh.

{
    if(m_tbb_tp && m_tbb_task_group)
    {
#if defined(PTL_USE_TBB)
        // TBB lazily activates threads to process tasks and the main thread
        // participates in processing the tasks so getting a specific
        // function to execute only on the worker threads requires some trickery
        //
        std::set<std::thread::id> _first{};
        Mutex                     _mutex{};
        // init function which executes function and returns 1 only once
        auto _init = [&]() {
            int _once = 0;
            _mutex.lock();
            if(_first.find(std::this_thread::get_id()) == _first.end())
            {
                // we need to reset this thread-local static for multiple invocations
                // of the same template instantiation
                _once = 1;
                _first.insert(std::this_thread::get_id());
            }
            _mutex.unlock();
            if(_once != 0)
            {
                _func();
                return 1;
            }
            return 0;
        };
        // this will collect the number of threads which have
        // executed the _init function above
        std::atomic<size_t> _total_init{ 0 };
        // max parallelism by TBB
        size_t _maxp = tbb_global_control()->active_value(
            tbb::global_control::max_allowed_parallelism);
        // create a task arean
        auto* _arena = get_task_arena();
        // size of the thread-pool
        size_t _sz = size();
        // number of cores
        size_t _ncore = GetNumberOfCores();
        // maximum depth for recursion
        size_t _dmax = std::max<size_t>(_ncore, 8);
        // how many threads we need to initialize
        size_t _num = std::min(_maxp, std::min(_sz, _ncore));
        // this is the task passed to the task-group
        std::function<void()> _init_task;
        _init_task = [&]() {
            add_thread_id();
            static thread_local size_type _depth = 0;
            int                           _ret   = 0;
            // don't let the main thread execute the function
            if(!is_main())
            {
                // execute the function
                _ret = _init();
                // add the result
                _total_init += _ret;
            }
            // if the function did not return anything, recursively execute
            // two more tasks
            ++_depth;
            if(_ret == 0 && _depth < _dmax && _total_init.load() < _num)
            {
                tbb::task_group tg{};
                tg.run([&]() { _init_task(); });
                tg.run([&]() { _init_task(); });
                ThisThread::sleep_for(std::chrono::milliseconds{ 1 });
                tg.wait();
            }
            --_depth;
        };
 
        // TBB won't oversubscribe so we need to limit by ncores - 1
        size_t nitr        = 0;
        auto   _fname      = __FUNCTION__;
        auto   _write_info = [&]() {
            std::cout << "[" << _fname << "]> Total initialized: " << _total_init
                      << ", expected: " << _num << ", max-parallel: " << _maxp
                      << ", size: " << _sz << ", ncore: " << _ncore << std::endl;
        };
        while(_total_init < _num)
        {
            auto _n = 2 * _num;
            while(--_n > 0)
            {
                _arena->execute(
                    [&]() { m_tbb_task_group->run([&]() { _init_task(); }); });
            }
            _arena->execute([&]() { m_tbb_task_group->wait(); });
            // don't loop infinitely but use a strict condition
            if(nitr++ > 2 * (_num + 1) && (_total_init - 1) == _num)
            {
                _write_info();
                break;
            }
            // at this point we need to exit
            if(nitr > 4 * (_ncore + 1))
            {
                _write_info();
                break;
            }
        }
        if(get_verbose() > 3)
            _write_info();
#endif
    }
    else if(get_queue())
    {
        get_queue()->ExecuteOnAllThreads(this, std::forward<FuncT>(_func));
    }
}

Referenced by destroy_threadpool(), and initialize_threadpool().

◆ execute_on_specific_threads()

template<typename FuncT>

void PTL::ThreadPool::execute_on_specific_threads	(	const std::set< std::thread::id > &	_tid,
		FuncT &&	_func )

inline

Definition at line 572 of file ThreadPool.hh.

{
    if(m_tbb_tp && m_tbb_task_group)
    {
#if defined(PTL_USE_TBB)
        // TBB lazily activates threads to process tasks and the main thread
        // participates in processing the tasks so getting a specific
        // function to execute only on the worker threads requires some trickery
        //
        std::set<std::thread::id> _first{};
        Mutex                     _mutex{};
        // init function which executes function and returns 1 only once
        auto _exec = [&]() {
            int _once = 0;
            _mutex.lock();
            if(_first.find(std::this_thread::get_id()) == _first.end())
            {
                // we need to reset this thread-local static for multiple invocations
                // of the same template instantiation
                _once = 1;
                _first.insert(std::this_thread::get_id());
            }
            _mutex.unlock();
            if(_once != 0)
            {
                _func();
                return 1;
            }
            return 0;
        };
        // this will collect the number of threads which have
        // executed the _exec function above
        std::atomic<size_t> _total_exec{ 0 };
        // number of cores
        size_t _ncore = GetNumberOfCores();
        // maximum depth for recursion
        size_t _dmax = std::max<size_t>(_ncore, 8);
        // how many threads we need to initialize
        size_t _num = _tids.size();
        // create a task arena
        auto* _arena = get_task_arena();
        // this is the task passed to the task-group
        std::function<void()> _exec_task;
        _exec_task = [&]() {
            add_thread_id();
            static thread_local size_type _depth    = 0;
            int                           _ret      = 0;
            auto                          _this_tid = std::this_thread::get_id();
            // don't let the main thread execute the function
            if(_tids.count(_this_tid) > 0)
            {
                // execute the function
                _ret = _exec();
                // add the result
                _total_exec += _ret;
            }
            // if the function did not return anything, recursively execute
            // two more tasks
            ++_depth;
            if(_ret == 0 && _depth < _dmax && _total_exec.load() < _num)
            {
                tbb::task_group tg{};
                tg.run([&]() { _exec_task(); });
                tg.run([&]() { _exec_task(); });
                ThisThread::sleep_for(std::chrono::milliseconds{ 1 });
                tg.wait();
            }
            --_depth;
        };
 
        // TBB won't oversubscribe so we need to limit by ncores - 1
        size_t nitr        = 0;
        auto   _fname      = __FUNCTION__;
        auto   _write_info = [&]() {
            std::cout << "[" << _fname << "]> Total executed: " << _total_exec
                      << ", expected: " << _num << ", size: " << size() << std::endl;
        };
        while(_total_exec < _num)
        {
            auto _n = 2 * _num;
            while(--_n > 0)
            {
                _arena->execute(
                    [&]() { m_tbb_task_group->run([&]() { _exec_task(); }); });
            }
            _arena->execute([&]() { m_tbb_task_group->wait(); });
            // don't loop infinitely but use a strict condition
            if(nitr++ > 2 * (_num + 1) && (_total_exec - 1) == _num)
            {
                _write_info();
                break;
            }
            // at this point we need to exit
            if(nitr > 8 * (_num + 1))
            {
                _write_info();
                break;
            }
        }
        if(get_verbose() > 3)
            _write_info();
#endif
    }
    else if(get_queue())
    {
        get_queue()->ExecuteOnSpecificThreads(_tids, this, std::forward<FuncT>(_func));
    }
}

◆ finalization_functor()

static finalize_func_t & PTL::ThreadPool::finalization_functor ( )

inlinestatic

Definition at line 133 of file ThreadPool.hh.

    {
        static finalize_func_t _v = []() {};
        return _v;
    }

◆ get_active_threads_count()

int PTL::ThreadPool::get_active_threads_count ( ) const

inline

Definition at line 227 of file ThreadPool.hh.

227{ return (int)m_thread_awake->load(); }

◆ get_default_size()

static size_type PTL::ThreadPool::get_default_size ( )

inlinestatic

get the default pool size

Definition at line 185 of file ThreadPool.hh.

185{ return f_default_pool_size(); }

◆ get_queue()

task_queue_t * PTL::ThreadPool::get_queue ( ) const

inline

Definition at line 175 of file ThreadPool.hh.

175{ return m_task_queue; }

Referenced by execute_on_all_threads(), execute_on_specific_threads(), and PTL::TaskGroup< Tp, Arg, MaxDepth >::wait().

◆ get_task_arena()

tbb_task_arena_t * PTL::ThreadPool::get_task_arena ( )

inline

Definition at line 353 of file ThreadPool.hh.

{
#if defined(PTL_USE_TBB)
    // create a task arena
    if(!m_tbb_task_arena)
    {
        auto _sz = (tbb_global_control())
                       ? tbb_global_control()->active_value(
                             tbb::global_control::max_allowed_parallelism)
                       : size();
        m_tbb_task_arena = new tbb_task_arena_t(::tbb::task_arena::attach{});
        m_tbb_task_arena->initialize(_sz, 1);
    }
#else
    if(!m_tbb_task_arena)
        m_tbb_task_arena = new tbb_task_arena_t{};
#endif
    return m_tbb_task_arena;
}

Referenced by execute_on_all_threads(), and execute_on_specific_threads().

◆ get_this_thread_id()

uintmax_t PTL::ThreadPool::get_this_thread_id ( )

static

Definition at line 148 of file ThreadPool.cc.

{
    return get_thread_id(ThisThread::get_id());
}

Referenced by PTL::UserTaskQueue::GetThreadBin(), initialize_threadpool(), G4TaskRunManagerKernel::InitializeWorker(), and ThreadPool().

◆ get_thread() [1/2]

Thread * PTL::ThreadPool::get_thread ( size_type _n ) const

◆ get_thread() [2/2]

Thread * PTL::ThreadPool::get_thread ( std::thread::id id ) const

◆ get_thread_id()

uintmax_t PTL::ThreadPool::get_thread_id ( ThreadId _tid )

static

Definition at line 124 of file ThreadPool.cc.

{
    uintmax_t _idx = 0;
    {
        AutoLock lock(TypeMutex<ThreadPool>(), std::defer_lock);
        if(!lock.owns_lock())
            lock.lock();
        auto itr = f_thread_ids().find(_tid);
        if(itr == f_thread_ids().end())
        {
            _idx                 = f_thread_ids().size();
            f_thread_ids()[_tid] = _idx;
        }
        else
        {
            _idx = itr->second;
        }
    }
    return _idx;
}

Referenced by get_this_thread_id(), set_affinity(), and set_priority().

◆ get_thread_ids()

const ThreadPool::thread_id_map_t & PTL::ThreadPool::get_thread_ids ( )

static

Definition at line 116 of file ThreadPool.cc.

{
    return f_thread_ids();
}

◆ get_valid_queue()

ThreadPool::task_queue_t *& PTL::ThreadPool::get_valid_queue ( task_queue_t *& _queue ) const

Definition at line 655 of file ThreadPool.cc.

{
    if(!_queue)
        _queue = new UserTaskQueue{ static_cast<intmax_t>(m_pool_size) };
    return _queue;
}

Referenced by add_tasks().

◆ get_verbose()

int PTL::ThreadPool::get_verbose ( ) const

inline

Definition at line 234 of file ThreadPool.hh.

234{ return m_verbose; }

Referenced by destroy_threadpool(), execute_on_all_threads(), and execute_on_specific_threads().

◆ initialization_functor()

static initialize_func_t & PTL::ThreadPool::initialization_functor ( )

inlinestatic

Definition at line 127 of file ThreadPool.hh.

    {
        static initialize_func_t _v = []() {};
        return _v;
    }

◆ initialize_threadpool()

ThreadPool::size_type PTL::ThreadPool::initialize_threadpool ( size_type proposed_size )

Definition at line 298 of file ThreadPool.cc.

{
    //--------------------------------------------------------------------//
    // return before initializing
    if(proposed_size < 1)
        return 0;
 
    //--------------------------------------------------------------------//
    // store that has been started
    if(!m_alive_flag->load())
        m_pool_state->store(thread_pool::state::STARTED);
 
#if defined(PTL_USE_TBB)
    //--------------------------------------------------------------------//
    // handle tbb task scheduler
    if(m_tbb_tp)
    {
        m_tbb_tp                               = true;
        m_pool_size                            = proposed_size;
        tbb_global_control_t*& _global_control = tbb_global_control();
        // delete if wrong size
        if(m_pool_size != proposed_size)
        {
            delete _global_control;
            _global_control = nullptr;
        }
 
        if(!_global_control)
        {
            _global_control = new tbb_global_control_t(
                tbb::global_control::max_allowed_parallelism, proposed_size + 1);
            if(m_verbose > 0)
            {
                AutoLock lock(TypeMutex<decltype(std::cerr)>());
                std::cerr << "[PTL::ThreadPool] ThreadPool [TBB] initialized with "
                          << m_pool_size << " threads." << std::endl;
            }
        }
 
        // create task group (used for async)
        if(!m_tbb_task_group)
        {
            m_tbb_task_group = new tbb_task_group_t{};
            execute_on_all_threads([this]() { m_init_func(); });
        }
 
        return m_pool_size;
    }
#endif
 
    m_alive_flag->store(true);
 
    //--------------------------------------------------------------------//
    // if started, stop some thread if smaller or return if equal
    if(m_pool_state->load() == thread_pool::state::STARTED)
    {
        if(m_pool_size > proposed_size)
        {
            while(stop_thread() > proposed_size)
                ;
            if(m_verbose > 0)
            {
                AutoLock lock(TypeMutex<decltype(std::cerr)>());
                std::cerr << "[PTL::ThreadPool] ThreadPool initialized with "
                          << m_pool_size << " threads." << std::endl;
            }
            if(!m_task_queue)
            {
                m_delete_task_queue = true;
                m_task_queue        = new UserTaskQueue(m_pool_size);
            }
            else
            {
                m_task_queue->resize(m_pool_size);
            }
            return m_pool_size;
        }
        else if(m_pool_size == proposed_size)  // NOLINT
        {
            if(m_verbose > 0)
            {
                AutoLock lock(TypeMutex<decltype(std::cerr)>());
                std::cerr << "ThreadPool initialized with " << m_pool_size << " threads."
                          << std::endl;
            }
            if(!m_task_queue)
            {
                m_delete_task_queue = true;
                m_task_queue        = new UserTaskQueue(m_pool_size);
            }
            return m_pool_size;
        }
    }
 
    //--------------------------------------------------------------------//
    // reserve enough space to prevent realloc later
    {
        AutoLock _task_lock(*m_task_lock);
        m_is_joined.reserve(proposed_size);
    }
 
    if(!m_task_queue)
    {
        m_delete_task_queue = true;
        m_task_queue        = new UserTaskQueue(proposed_size);
    }
 
    auto this_tid = get_this_thread_id();
    for(size_type i = m_pool_size; i < proposed_size; ++i)
    {
        // add the threads
        try
        {
            // create thread
            Thread thr{ ThreadPool::start_thread, this, &m_thread_data,
                        this_tid + i + 1 };
            // only reaches here if successful creation of thread
            ++m_pool_size;
            // store thread
            m_main_threads.push_back(thr.get_id());
            // list of joined thread booleans
            m_is_joined.push_back(false);
            // set the affinity
            if(m_use_affinity)
                set_affinity(i, thr);
            set_priority(m_priority, thr);
            // store
            m_threads.emplace_back(std::move(thr));
        } catch(std::runtime_error& e)
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] " << e.what()
                      << std::endl;  // issue creating thread
            continue;
        } catch(std::bad_alloc& e)
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] " << e.what() << std::endl;
            continue;
        }
    }
    //------------------------------------------------------------------------//
 
    AutoLock _task_lock(*m_task_lock);
 
    // thread pool size doesn't match with join vector
    // this will screw up joining later
    if(m_is_joined.size() != m_main_threads.size())
    {
        std::stringstream ss;
        ss << "ThreadPool::initialize_threadpool - boolean is_joined vector "
           << "is a different size than threads vector: " << m_is_joined.size() << " vs. "
           << m_main_threads.size() << " (tid: " << std::this_thread::get_id() << ")";
 
        throw std::runtime_error(ss.str());
    }
 
    if(m_verbose > 0)
    {
        AutoLock lock(TypeMutex<decltype(std::cerr)>());
        std::cerr << "[PTL::ThreadPool] ThreadPool initialized with " << m_pool_size
                  << " threads." << std::endl;
    }
 
    return m_main_threads.size();
}

Referenced by resize(), and ThreadPool().

◆ is_alive()

bool PTL::ThreadPool::is_alive ( )

inline

Definition at line 222 of file ThreadPool.hh.

222{ return m_alive_flag->load(); }

Referenced by PTL::TaskGroup< Tp, Arg, MaxDepth >::wait().

◆ is_initialized()

bool PTL::ThreadPool::is_initialized ( ) const

Definition at line 227 of file ThreadPool.cc.

{
    return !(m_pool_state->load() == thread_pool::state::NONINIT);
}

◆ is_main()

bool PTL::ThreadPool::is_main ( ) const

inline

Definition at line 235 of file ThreadPool.hh.

235{ return ThisThread::get_id() == m_main_tid; }

Referenced by execute_on_all_threads().

◆ is_tbb_threadpool()

bool PTL::ThreadPool::is_tbb_threadpool ( ) const

inline

Definition at line 178 of file ThreadPool.hh.

178{ return m_tbb_tp; }

◆ notify() [1/2]

void PTL::ThreadPool::notify ( )

inline

Definition at line 303 of file ThreadPool.hh.

{
    // wake up one thread that is waiting for a task to be available
    if(m_thread_awake->load() < m_pool_size)
    {
        AutoLock l(*m_task_lock);
        m_task_cond->notify_one();
    }
}

Referenced by add_tasks().

◆ notify() [2/2]

void PTL::ThreadPool::notify ( size_type ntasks )

inline

Definition at line 322 of file ThreadPool.hh.

{
    if(ntasks == 0)
        return;
 
    // wake up as many threads that tasks just added
    if(m_thread_awake->load() < m_pool_size)
    {
        AutoLock l(*m_task_lock);
        if(ntasks < this->size())
        {
            for(size_type i = 0; i < ntasks; ++i)
                m_task_cond->notify_one();
        }
        else
        {
            m_task_cond->notify_all();
        }
    }
}

◆ notify_all()

void PTL::ThreadPool::notify_all ( )

inline

Definition at line 314 of file ThreadPool.hh.

{
    // wake all threads
    AutoLock l(*m_task_lock);
    m_task_cond->notify_all();
}

◆ operator=() [1/2]

ThreadPool & PTL::ThreadPool::operator= ( const ThreadPool & )

delete

◆ operator=() [2/2]

ThreadPool & PTL::ThreadPool::operator= ( ThreadPool && )

default

◆ reset_finalization()

void PTL::ThreadPool::reset_finalization ( )

inline

Definition at line 208 of file ThreadPool.hh.

    {
        m_fini_func = []() {};
    }

◆ reset_initialization()

void PTL::ThreadPool::reset_initialization ( )

inline

Definition at line 204 of file ThreadPool.hh.

    {
        m_init_func = []() {};
    }

◆ resize()

void PTL::ThreadPool::resize ( size_type _n )

inline

Definition at line 374 of file ThreadPool.hh.

{
    initialize_threadpool(_n);
    if(m_task_queue)
        m_task_queue->resize(static_cast<intmax_t>(_n));
}

Referenced by G4TaskRunManager::SetNumberOfThreads().

◆ set_affinity() [1/2]

void PTL::ThreadPool::set_affinity ( affinity_func_t f )

inline

Definition at line 229 of file ThreadPool.hh.

229{ m_affinity_func = std::move(f); }

Referenced by initialize_threadpool(), and ThreadPool().

◆ set_affinity() [2/2]

void PTL::ThreadPool::set_affinity	(	intmax_t	i,
		Thread &	_thread ) const

Definition at line 251 of file ThreadPool.cc.

{
    try
    {
        NativeThread native_thread = _thread.native_handle();
        intmax_t     _pin          = m_affinity_func(i);
        if(m_verbose > 0)
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] Setting pin affinity for thread "
                      << get_thread_id(_thread.get_id()) << " to " << _pin << std::endl;
        }
        SetPinAffinity((int)_pin, native_thread);
    } catch(std::runtime_error& e)
    {
        std::cerr << "[PTL::ThreadPool] Error setting pin affinity: " << e.what()
                  << std::endl;
    }
}

◆ set_default_size()

static void PTL::ThreadPool::set_default_size ( size_type _v )

inlinestatic

set the default pool size

Definition at line 182 of file ThreadPool.hh.

182{ f_default_pool_size() = _v; }

◆ set_finalization()

void PTL::ThreadPool::set_finalization ( finalize_func_t f )

inline

Definition at line 202 of file ThreadPool.hh.

202{ m_fini_func = std::move(f); }

◆ set_initialization()

void PTL::ThreadPool::set_initialization ( initialize_func_t f )

inline

Definition at line 201 of file ThreadPool.hh.

201{ m_init_func = std::move(f); }

◆ set_priority()

void PTL::ThreadPool::set_priority	(	int	_prio,
		Thread &	_thread ) const

Definition at line 274 of file ThreadPool.cc.

{
    try
    {
        NativeThread native_thread = _thread.native_handle();
        if(m_verbose > 0)
        {
            AutoLock lock(TypeMutex<decltype(std::cerr)>());
            std::cerr << "[PTL::ThreadPool] Setting thread "
                      << get_thread_id(_thread.get_id()) << " priority to " << _prio
                      << std::endl;
        }
        SetThreadPriority(_prio, native_thread);
    } catch(std::runtime_error& e)
    {
        AutoLock lock(TypeMutex<decltype(std::cerr)>());
        std::cerr << "[PTL::ThreadPool] Error setting thread priority: " << e.what()
                  << std::endl;
    }
}

Referenced by initialize_threadpool().

◆ set_verbose()

void PTL::ThreadPool::set_verbose ( int n )

inline

Definition at line 233 of file ThreadPool.hh.

233{ m_verbose = n; }

CLHEP::detail::n

n

Definition Ranlux64Engine.cc:90

◆ size()

size_type PTL::ThreadPool::size ( ) const

inline

Definition at line 217 of file ThreadPool.hh.

217{ return m_pool_size; }

Referenced by execute_on_all_threads(), execute_on_specific_threads(), get_task_arena(), G4TaskRunManagerKernel::InitializeWorker(), notify(), and PTL::TaskGroup< Tp, Arg, MaxDepth >::wait().

◆ state()

const pool_state_type & PTL::ThreadPool::state ( ) const

inline

Definition at line 215 of file ThreadPool.hh.

215{ return m_pool_state; }

Referenced by ThreadPool(), and PTL::TaskGroup< Tp, Arg, MaxDepth >::wait().

◆ stop_thread()

ThreadPool::size_type PTL::ThreadPool::stop_thread ( )

Definition at line 607 of file ThreadPool.cc.

{
    if(!m_alive_flag->load() || m_pool_size == 0)
        return 0;
 
    m_pool_state->store(thread_pool::state::PARTIAL);
 
    //------------------------------------------------------------------------//
    // notify all threads we are shutting down
    m_task_lock->lock();
    m_is_stopped.push_back(true);
    m_task_cond->notify_one();
    m_task_lock->unlock();
    //------------------------------------------------------------------------//
 
    while(!m_is_stopped.empty() && m_stop_threads.empty())
        ;
 
    // lock up the task queue
    AutoLock _task_lock(*m_task_lock);
 
    while(!m_stop_threads.empty())
    {
        auto tid = m_stop_threads.front();
        // remove from stopped
        m_stop_threads.pop_front();
        // remove from main
        for(auto itr = m_main_threads.begin(); itr != m_main_threads.end(); ++itr)
        {
            if(*itr == tid)
            {
                m_main_threads.erase(itr);
                break;
            }
        }
        // remove from join list
        m_is_joined.pop_back();
    }
 
    m_pool_state->store(thread_pool::state::STARTED);
 
    m_pool_size = m_main_threads.size();
    return m_main_threads.size();
}

Referenced by initialize_threadpool().

◆ tbb_global_control()

tbb_global_control_t *& PTL::ThreadPool::tbb_global_control ( )

inlinestatic

Definition at line 345 of file ThreadPool.hh.

{
    static thread_local tbb_global_control_t* _instance = nullptr;
    return _instance;
}

Referenced by destroy_threadpool(), execute_on_all_threads(), get_task_arena(), and initialize_threadpool().

◆ using_affinity()

bool PTL::ThreadPool::using_affinity ( ) const

inline

Definition at line 221 of file ThreadPool.hh.

221{ return m_use_affinity; }

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ affinity_func_t

◆ atomic_bool_type

◆ atomic_int_type

◆ bool_list_t

◆ condition_t

◆ finalize_func_t

◆ initialize_func_t

◆ lock_t

◆ pool_state_type

◆ size_type

◆ task_count_type

◆ task_pointer

◆ task_queue_t

◆ task_type

◆ thread_data_t

◆ thread_id_map_t

◆ thread_index_map_t

◆ thread_list_t

◆ thread_vec_t

◆ uomap

Constructor & Destructor Documentation

◆ ThreadPool() [1/3]

◆ ~ThreadPool()

◆ ThreadPool() [2/3]

◆ ThreadPool() [3/3]

Member Function Documentation

◆ add_task()

◆ add_tasks()

◆ add_thread_id()

◆ affinity_functor()

◆ destroy_threadpool()

◆ execute_on_all_threads()

◆ execute_on_specific_threads()

◆ finalization_functor()

◆ get_active_threads_count()

◆ get_default_size()

◆ get_queue()

◆ get_task_arena()

◆ get_this_thread_id()

◆ get_thread() [1/2]

◆ get_thread() [2/2]

◆ get_thread_id()

◆ get_thread_ids()

◆ get_valid_queue()

◆ get_verbose()

◆ initialization_functor()

◆ initialize_threadpool()

◆ is_alive()

◆ is_initialized()

◆ is_main()

◆ is_tbb_threadpool()

◆ notify() [1/2]

◆ notify() [2/2]

◆ notify_all()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ reset_finalization()

◆ reset_initialization()

◆ resize()

◆ set_affinity() [1/2]

◆ set_affinity() [2/2]

◆ set_default_size()

◆ set_finalization()

◆ set_initialization()

◆ set_priority()

◆ set_verbose()

◆ size()

◆ state()

◆ stop_thread()

◆ tbb_global_control()

◆ using_affinity()