Gabriele Cosmo
276 lines
10 KiB
C++
276 lines
10 KiB
C++
//
|
|
// MIT License
|
|
// Copyright (c) 2020 Jonathan R. Madsen
|
|
// 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
|
|
// 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.
|
|
//
|
|
// ---------------------------------------------------------------
|
|
// Tasking class header file
|
|
//
|
|
// Class Description:
|
|
//
|
|
// This file creates a class for handling the wrapping of functions
|
|
// into task objects and submitting to thread pool
|
|
//
|
|
// ---------------------------------------------------------------
|
|
// Author: Jonathan Madsen (Feb 13th 2018)
|
|
// ---------------------------------------------------------------
|
|
|
|
#pragma once
|
|
|
|
#include "PTL/Macros.hh"
|
|
#include "PTL/Task.hh"
|
|
#include "PTL/TaskGroup.hh"
|
|
#include "PTL/ThreadPool.hh"
|
|
|
|
#include <iostream>
|
|
#include <memory>
|
|
#include <stdexcept>
|
|
#include <thread>
|
|
#include <utility>
|
|
|
|
namespace PTL
|
|
{
|
|
//======================================================================================//
|
|
|
|
class TaskManager
|
|
{
|
|
public:
|
|
using this_type = TaskManager;
|
|
using size_type = ThreadPool::size_type;
|
|
|
|
public:
|
|
// Constructor and Destructors
|
|
explicit TaskManager(ThreadPool*, bool _manage_pool = true);
|
|
virtual ~TaskManager() noexcept(false);
|
|
|
|
TaskManager(const TaskManager&) = delete;
|
|
TaskManager(TaskManager&&) = default;
|
|
TaskManager& operator=(const TaskManager&) = delete;
|
|
TaskManager& operator=(TaskManager&&) = default;
|
|
|
|
public:
|
|
/// get the singleton pointer
|
|
static TaskManager* GetInstance();
|
|
static TaskManager* GetInstanceIfExists();
|
|
static unsigned ncores() { return std::thread::hardware_concurrency(); }
|
|
|
|
public:
|
|
//------------------------------------------------------------------------//
|
|
// return the thread pool
|
|
inline ThreadPool* thread_pool() const { return m_pool; }
|
|
|
|
//------------------------------------------------------------------------//
|
|
// return the number of threads in the thread pool
|
|
inline size_type size() const { return (m_pool) ? m_pool->size() : 0; }
|
|
|
|
//------------------------------------------------------------------------//
|
|
// kill all the threads
|
|
inline void finalize()
|
|
{
|
|
if(m_is_finalized)
|
|
return;
|
|
m_is_finalized = true;
|
|
if(m_pool)
|
|
m_pool->destroy_threadpool();
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
|
|
public:
|
|
//------------------------------------------------------------------------//
|
|
// direct insertion of a task
|
|
//------------------------------------------------------------------------//
|
|
template <typename... Args>
|
|
void exec(Task<Args...>* _task)
|
|
{
|
|
if(!m_pool)
|
|
throw std::runtime_error("Nullptr to thread-pool");
|
|
m_pool->add_task(_task);
|
|
}
|
|
|
|
//------------------------------------------------------------------------//
|
|
// direct insertion of a packaged_task
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename FuncT, typename... Args>
|
|
std::shared_ptr<PackagedTask<RetT, Args...>> async(FuncT&& func, Args&&... args)
|
|
{
|
|
using task_type = PackagedTask<RetT, Args...>;
|
|
|
|
if(!m_pool)
|
|
throw std::runtime_error("Nullptr to thread-pool");
|
|
|
|
auto _ptask = std::make_shared<task_type>(std::forward<FuncT>(func),
|
|
std::forward<Args>(args)...);
|
|
m_pool->add_task(_ptask);
|
|
return _ptask;
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename FuncT>
|
|
std::shared_ptr<PackagedTask<RetT>> async(FuncT&& func)
|
|
{
|
|
using task_type = PackagedTask<RetT>;
|
|
|
|
if(!m_pool)
|
|
throw std::runtime_error("Nullptr to thread-pool");
|
|
|
|
auto _ptask = std::make_shared<task_type>(std::forward<FuncT>(func));
|
|
m_pool->add_task(_ptask);
|
|
return _ptask;
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename FuncT, typename... Args>
|
|
auto async(FuncT&& func, Args... args)
|
|
-> std::shared_ptr<PackagedTask<decay_t<decltype(func(args...))>, Args...>>
|
|
{
|
|
using RetT = decay_t<decltype(func(args...))>;
|
|
using task_type = PackagedTask<RetT, Args...>;
|
|
|
|
if(!m_pool)
|
|
throw std::runtime_error("Nullptr to thread-pool");
|
|
|
|
auto _ptask = std::make_shared<task_type>(std::forward<FuncT>(func),
|
|
std::forward<Args>(args)...);
|
|
m_pool->add_task(_ptask);
|
|
return _ptask;
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
|
|
public:
|
|
//------------------------------------------------------------------------//
|
|
// public wrap functions
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT, typename... Args>
|
|
std::shared_ptr<Task<RetT, ArgT, Args...>> wrap(TaskGroup<RetT, ArgT>& tg,
|
|
FuncT&& func, Args&&... args)
|
|
{
|
|
return tg.wrap(std::forward<FuncT>(func), std::forward<Args>(args)...);
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT>
|
|
std::shared_ptr<Task<RetT, ArgT>> wrap(TaskGroup<RetT, ArgT>& tg, FuncT&& func)
|
|
{
|
|
return tg.wrap(std::forward<FuncT>(func));
|
|
}
|
|
|
|
public:
|
|
//------------------------------------------------------------------------//
|
|
// public exec functions
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT, typename... Args>
|
|
void exec(TaskGroup<RetT, ArgT>& tg, FuncT&& func, Args&&... args)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func), std::forward<Args>(args)...);
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT>
|
|
void exec(TaskGroup<RetT, ArgT>& tg, FuncT&& func)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func));
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT, typename... Args>
|
|
void rexec(TaskGroup<RetT, ArgT>& tg, FuncT&& func, Args&&... args)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func), std::forward<Args>(args)...);
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename RetT, typename ArgT, typename FuncT>
|
|
void rexec(TaskGroup<RetT, ArgT>& tg, FuncT&& func)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func));
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
// public exec functions (void specializations)
|
|
//------------------------------------------------------------------------//
|
|
template <typename FuncT, typename... Args>
|
|
void rexec(TaskGroup<void, void>& tg, FuncT&& func, Args&&... args)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func), std::forward<Args>(args)...);
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
template <typename FuncT>
|
|
void rexec(TaskGroup<void, void>& tg, FuncT&& func)
|
|
{
|
|
tg.exec(std::forward<FuncT>(func));
|
|
}
|
|
//------------------------------------------------------------------------//
|
|
|
|
protected:
|
|
// Protected variables
|
|
ThreadPool* m_pool = nullptr;
|
|
bool m_is_finalized = false;
|
|
|
|
private:
|
|
static TaskManager*& fgInstance();
|
|
};
|
|
|
|
} // namespace PTL
|
|
//======================================================================================//
|
|
|
|
#include "TaskRunManager.hh"
|
|
|
|
//--------------------------------------------------------------------------------------//
|
|
|
|
inline PTL::TaskManager*&
|
|
PTL::TaskManager::fgInstance()
|
|
{
|
|
static thread_local TaskManager* _instance = nullptr;
|
|
return _instance;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------//
|
|
|
|
inline PTL::TaskManager*
|
|
PTL::TaskManager::GetInstance()
|
|
{
|
|
if(!fgInstance())
|
|
{
|
|
auto nthreads = std::thread::hardware_concurrency();
|
|
std::cout << "Allocating mad::TaskManager with " << nthreads << " thread(s)..."
|
|
<< std::endl;
|
|
new TaskManager(TaskRunManager::GetMasterRunManager()->GetThreadPool());
|
|
}
|
|
return fgInstance();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------//
|
|
|
|
inline PTL::TaskManager*
|
|
PTL::TaskManager::GetInstanceIfExists()
|
|
{
|
|
return fgInstance();
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------//
|
|
|
|
inline PTL::TaskManager::TaskManager(ThreadPool* _pool, bool _manage_pool)
|
|
: m_pool(_pool)
|
|
, m_is_finalized(!_manage_pool)
|
|
{
|
|
if(!fgInstance())
|
|
fgInstance() = this;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------//
|
|
|
|
inline PTL::TaskManager::~TaskManager() noexcept(false)
|
|
{
|
|
finalize();
|
|
if(fgInstance() == this)
|
|
fgInstance() = nullptr;
|
|
}
|
|
|
|
//======================================================================================//
|