2017-03-18 00:05:10 +00:00
|
|
|
/* Concurrency module with custom scheduler support.
|
|
|
|
*
|
|
|
|
* This file is part of OctaSTD. See COPYING.md for futher information.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef OSTD_CONCURRENCY_HH
|
|
|
|
#define OSTD_CONCURRENCY_HH
|
|
|
|
|
|
|
|
#include <thread>
|
|
|
|
#include <utility>
|
2017-03-19 13:11:23 +00:00
|
|
|
#include <memory>
|
2017-03-18 00:05:10 +00:00
|
|
|
|
2017-03-19 13:11:23 +00:00
|
|
|
#include "ostd/coroutine.hh"
|
2017-03-18 00:05:10 +00:00
|
|
|
#include "ostd/channel.hh"
|
|
|
|
|
|
|
|
namespace ostd {
|
|
|
|
|
|
|
|
struct thread_scheduler {
|
2017-03-19 17:12:08 +00:00
|
|
|
template<typename T>
|
|
|
|
using channel_type = channel<T>;
|
|
|
|
|
2017-03-18 00:05:10 +00:00
|
|
|
~thread_scheduler() {
|
|
|
|
join_all();
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename F, typename ...A>
|
2017-03-18 19:04:22 +00:00
|
|
|
auto start(F &&func, A &&...args) -> std::result_of_t<F(A...)> {
|
|
|
|
return func(std::forward<A>(args)...);
|
2017-03-18 00:05:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
template<typename F, typename ...A>
|
|
|
|
void spawn(F &&func, A &&...args) {
|
2017-03-20 01:35:50 +00:00
|
|
|
std::lock_guard<std::mutex> l{p_lock};
|
2017-03-18 00:05:10 +00:00
|
|
|
p_threads.emplace_front();
|
|
|
|
auto it = p_threads.begin();
|
|
|
|
*it = std::thread{
|
|
|
|
[this, it](auto func, auto ...args) {
|
|
|
|
func(std::move(args)...);
|
2017-03-20 23:27:20 +00:00
|
|
|
remove_thread(it);
|
2017-03-18 00:05:10 +00:00
|
|
|
},
|
|
|
|
std::forward<F>(func), std::forward<A>(args)...
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
void yield() {
|
|
|
|
std::this_thread::yield();
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
2017-03-19 15:23:00 +00:00
|
|
|
channel<T> make_channel() {
|
|
|
|
return channel<T>{};
|
2017-03-18 00:05:10 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
void remove_thread(typename std::list<std::thread>::iterator it) {
|
2017-03-20 01:35:50 +00:00
|
|
|
std::lock_guard<std::mutex> l{p_lock};
|
2017-03-18 00:05:10 +00:00
|
|
|
std::thread t{std::exchange(p_dead, std::move(*it))};
|
|
|
|
if (t.joinable()) {
|
|
|
|
t.join();
|
|
|
|
}
|
|
|
|
p_threads.erase(it);
|
|
|
|
}
|
|
|
|
|
|
|
|
void join_all() {
|
|
|
|
/* wait for all threads to finish */
|
2017-03-20 01:35:50 +00:00
|
|
|
std::lock_guard<std::mutex> l{p_lock};
|
2017-03-18 00:05:10 +00:00
|
|
|
if (p_dead.joinable()) {
|
|
|
|
p_dead.join();
|
|
|
|
}
|
|
|
|
for (auto &t: p_threads) {
|
|
|
|
t.join();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
std::list<std::thread> p_threads;
|
|
|
|
std::thread p_dead;
|
|
|
|
std::mutex p_lock;
|
|
|
|
};
|
|
|
|
|
2017-03-19 19:00:55 +00:00
|
|
|
template<typename TR, bool Protected>
|
|
|
|
struct basic_simple_coroutine_scheduler {
|
2017-03-19 13:11:23 +00:00
|
|
|
private:
|
|
|
|
/* simple one just for channels */
|
|
|
|
struct coro_cond {
|
|
|
|
coro_cond() = delete;
|
|
|
|
coro_cond(coro_cond const &) = delete;
|
|
|
|
coro_cond(coro_cond &&) = delete;
|
|
|
|
coro_cond &operator=(coro_cond const &) = delete;
|
|
|
|
coro_cond &operator=(coro_cond &&) = delete;
|
|
|
|
|
2017-03-20 01:44:38 +00:00
|
|
|
coro_cond(basic_simple_coroutine_scheduler &s): p_sched(s) {}
|
2017-03-19 13:11:23 +00:00
|
|
|
|
|
|
|
template<typename L>
|
|
|
|
void wait(L &l) noexcept {
|
|
|
|
l.unlock();
|
|
|
|
while (!p_notified) {
|
|
|
|
p_sched.yield();
|
|
|
|
}
|
|
|
|
p_notified = false;
|
|
|
|
l.lock();
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_one() noexcept {
|
|
|
|
p_notified = true;
|
|
|
|
p_sched.yield();
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_all() noexcept {
|
|
|
|
p_notified = true;
|
|
|
|
p_sched.yield();
|
|
|
|
}
|
|
|
|
private:
|
2017-03-19 19:00:55 +00:00
|
|
|
basic_simple_coroutine_scheduler &p_sched;
|
2017-03-19 13:11:23 +00:00
|
|
|
bool p_notified = false;
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
2017-03-19 17:12:08 +00:00
|
|
|
template<typename T>
|
|
|
|
using channel_type = channel<T, coro_cond>;
|
|
|
|
|
2017-03-19 19:00:55 +00:00
|
|
|
basic_simple_coroutine_scheduler(
|
|
|
|
size_t ss = TR::default_size(),
|
|
|
|
size_t cs = basic_stack_pool<TR, Protected>::DEFAULT_CHUNK_SIZE
|
2017-03-19 22:35:56 +00:00
|
|
|
):
|
|
|
|
p_stacks(ss, cs),
|
|
|
|
p_dispatcher([this](auto yield_main) {
|
|
|
|
this->dispatch(yield_main);
|
|
|
|
}, p_stacks.get_allocator()),
|
|
|
|
p_coros()
|
|
|
|
{}
|
2017-03-19 19:00:55 +00:00
|
|
|
|
2017-03-19 13:11:23 +00:00
|
|
|
template<typename F, typename ...A>
|
|
|
|
auto start(F &&func, A &&...args) -> std::result_of_t<F(A...)> {
|
|
|
|
using R = std::result_of_t<F(A...)>;
|
|
|
|
if constexpr(std::is_same_v<R, void>) {
|
2017-03-19 22:35:56 +00:00
|
|
|
func(std::forward<A>(args)...);
|
|
|
|
finish();
|
2017-03-19 13:11:23 +00:00
|
|
|
} else {
|
2017-03-19 22:35:56 +00:00
|
|
|
auto ret = func(std::forward<A>(args)...);
|
|
|
|
finish();
|
2017-03-19 13:11:23 +00:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename F, typename ...A>
|
|
|
|
void spawn(F &&func, A &&...args) {
|
|
|
|
if constexpr(sizeof...(A) == 0) {
|
|
|
|
p_coros.emplace_back([lfunc = std::forward<F>(func)](auto) {
|
|
|
|
lfunc();
|
2017-03-19 19:00:55 +00:00
|
|
|
}, p_stacks.get_allocator());
|
2017-03-19 13:11:23 +00:00
|
|
|
} else {
|
|
|
|
p_coros.emplace_back([lfunc = std::bind(
|
|
|
|
std::forward<F>(func), std::forward<A>(args)...
|
2017-03-19 15:23:00 +00:00
|
|
|
)](auto) mutable {
|
2017-03-19 13:11:23 +00:00
|
|
|
lfunc();
|
2017-03-19 19:00:55 +00:00
|
|
|
}, p_stacks.get_allocator());
|
2017-03-19 13:11:23 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void yield() {
|
|
|
|
auto ctx = coroutine_context::current();
|
2017-03-19 22:35:56 +00:00
|
|
|
if (!ctx) {
|
|
|
|
/* yield from main means go to dispatcher and call first task */
|
|
|
|
p_idx = p_coros.begin();
|
|
|
|
p_dispatcher();
|
|
|
|
return;
|
|
|
|
}
|
2017-03-19 13:11:23 +00:00
|
|
|
coro *c = dynamic_cast<coro *>(ctx);
|
|
|
|
if (c) {
|
2017-03-19 19:00:55 +00:00
|
|
|
typename coro::yield_type{*c}();
|
2017-03-19 13:11:23 +00:00
|
|
|
return;
|
|
|
|
}
|
2017-03-19 22:35:56 +00:00
|
|
|
throw std::runtime_error{"attempt to yield outside coroutine"};
|
2017-03-19 13:11:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
2017-03-19 15:23:00 +00:00
|
|
|
channel<T, coro_cond> make_channel() {
|
2017-03-20 01:44:38 +00:00
|
|
|
return channel<T, coro_cond>{[this]() {
|
|
|
|
return coro_cond{*this};
|
2017-03-19 15:23:00 +00:00
|
|
|
}};
|
2017-03-19 13:11:23 +00:00
|
|
|
}
|
|
|
|
private:
|
|
|
|
struct coro: coroutine<void()> {
|
|
|
|
using coroutine<void()>::coroutine;
|
|
|
|
};
|
|
|
|
|
2017-03-19 22:35:56 +00:00
|
|
|
void dispatch(typename coro::yield_type &yield_main) {
|
2017-03-19 13:11:23 +00:00
|
|
|
while (!p_coros.empty()) {
|
|
|
|
if (p_idx == p_coros.end()) {
|
2017-03-19 22:35:56 +00:00
|
|
|
/* we're at the end; it's time to return to main and
|
|
|
|
* continue there (potential yield from main results
|
|
|
|
* in continuing from this point with the first task)
|
|
|
|
*/
|
|
|
|
yield_main();
|
|
|
|
continue;
|
2017-03-19 13:11:23 +00:00
|
|
|
}
|
|
|
|
(*p_idx)();
|
|
|
|
if (!*p_idx) {
|
|
|
|
p_idx = p_coros.erase(p_idx);
|
|
|
|
} else {
|
|
|
|
++p_idx;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-19 22:35:56 +00:00
|
|
|
void finish() {
|
|
|
|
/* main has finished, but there might be either suspended or never
|
|
|
|
* started tasks in the queue; dispatch until there are none left
|
|
|
|
*/
|
|
|
|
while (!p_coros.empty()) {
|
|
|
|
p_idx = p_coros.begin();
|
|
|
|
p_dispatcher();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-03-19 19:00:55 +00:00
|
|
|
basic_stack_pool<TR, Protected> p_stacks;
|
2017-03-19 22:35:56 +00:00
|
|
|
coro p_dispatcher;
|
|
|
|
std::list<coro> p_coros;
|
2017-03-19 13:11:23 +00:00
|
|
|
typename std::list<coro>::iterator p_idx = p_coros.end();
|
|
|
|
};
|
|
|
|
|
2017-03-19 19:00:55 +00:00
|
|
|
using simple_coroutine_scheduler =
|
|
|
|
basic_simple_coroutine_scheduler<stack_traits, false>;
|
|
|
|
|
|
|
|
using protected_simple_coroutine_scheduler =
|
|
|
|
basic_simple_coroutine_scheduler<stack_traits, true>;
|
|
|
|
|
2017-03-20 23:27:20 +00:00
|
|
|
template<typename TR, bool Protected>
|
|
|
|
struct basic_coroutine_scheduler {
|
|
|
|
private:
|
|
|
|
struct task_cond;
|
|
|
|
struct task;
|
|
|
|
|
|
|
|
using tlist = std::list<task>;
|
|
|
|
using titer = typename tlist::iterator;
|
|
|
|
|
|
|
|
struct task {
|
|
|
|
struct coro: coroutine<void()> {
|
|
|
|
using coroutine<void()>::coroutine;
|
|
|
|
task *tptr = nullptr;
|
|
|
|
};
|
|
|
|
|
|
|
|
coro func;
|
|
|
|
task_cond *waiting_on = nullptr;
|
|
|
|
task *next_waiting = nullptr;
|
|
|
|
titer pos;
|
|
|
|
|
|
|
|
task() = delete;
|
|
|
|
template<typename F, typename SA>
|
|
|
|
task(F &&f, SA &&alloc):
|
|
|
|
func(std::forward<F>(f), std::forward<SA>(alloc))
|
|
|
|
{
|
|
|
|
func.tptr = this;
|
|
|
|
}
|
|
|
|
|
|
|
|
void operator()() {
|
|
|
|
func();
|
|
|
|
}
|
|
|
|
|
|
|
|
void yield(basic_coroutine_scheduler &sched) {
|
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> l{sched.p_lock};
|
|
|
|
sched.p_available.splice(
|
|
|
|
sched.p_available.cend(), sched.p_running, pos
|
|
|
|
);
|
|
|
|
}
|
|
|
|
yield_raw();
|
|
|
|
}
|
|
|
|
|
|
|
|
void yield_raw() {
|
|
|
|
typename coro::yield_type{func}();
|
|
|
|
}
|
|
|
|
|
|
|
|
bool dead() const {
|
|
|
|
return !func;
|
|
|
|
}
|
|
|
|
|
|
|
|
static task *current() {
|
|
|
|
auto ctx = coroutine_context::current();
|
|
|
|
coro *c = dynamic_cast<coro *>(ctx);
|
|
|
|
if (!c) {
|
|
|
|
std::terminate();
|
|
|
|
}
|
|
|
|
return c->tptr;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
struct task_cond {
|
|
|
|
task_cond() = delete;
|
|
|
|
task_cond(task_cond const &) = delete;
|
|
|
|
task_cond(task_cond &&) = delete;
|
|
|
|
task_cond &operator=(task_cond const &) = delete;
|
|
|
|
task_cond &operator=(task_cond &&) = delete;
|
|
|
|
|
|
|
|
task_cond(basic_coroutine_scheduler &s): p_sched(s) {}
|
|
|
|
|
|
|
|
template<typename L>
|
|
|
|
void wait(L &l) noexcept {
|
|
|
|
l.unlock();
|
|
|
|
task *curr = task::current();
|
|
|
|
p_sched.wait(this, p_waiting, curr);
|
|
|
|
curr->yield_raw();
|
|
|
|
l.lock();
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_one() noexcept {
|
|
|
|
p_sched.notify_one(p_waiting);
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_all() noexcept {
|
|
|
|
p_sched.notify_all(p_waiting);
|
|
|
|
}
|
|
|
|
private:
|
|
|
|
basic_coroutine_scheduler &p_sched;
|
|
|
|
task *p_waiting = nullptr;
|
|
|
|
};
|
|
|
|
|
|
|
|
public:
|
|
|
|
template<typename T>
|
|
|
|
using channel_type = channel<T, task_cond>;
|
|
|
|
|
|
|
|
basic_coroutine_scheduler(
|
|
|
|
size_t ss = TR::default_size(),
|
|
|
|
size_t cs = basic_stack_pool<TR, Protected>::DEFAULT_CHUNK_SIZE
|
|
|
|
):
|
|
|
|
p_stacks(ss, cs)
|
|
|
|
{}
|
|
|
|
|
|
|
|
~basic_coroutine_scheduler() {}
|
|
|
|
|
|
|
|
template<typename F, typename ...A>
|
|
|
|
auto start(F &&func, A &&...args) -> std::result_of_t<F(A...)> {
|
|
|
|
/* start with one task in the queue, this way we can
|
|
|
|
* say we've finished when the task queue becomes empty
|
|
|
|
*/
|
|
|
|
using R = std::result_of_t<F(A...)>;
|
|
|
|
if constexpr(std::is_same_v<R, void>) {
|
|
|
|
spawn(std::forward<F>(func), std::forward<A>(args)...);
|
|
|
|
/* actually start the thread pool */
|
|
|
|
init();
|
|
|
|
destroy();
|
|
|
|
} else {
|
|
|
|
R ret;
|
|
|
|
spawn([&ret, func = std::forward<F>(func)](auto &&...args) {
|
|
|
|
ret = func(std::forward<A>(args)...);
|
|
|
|
}, std::forward<A>(args)...);
|
|
|
|
init();
|
|
|
|
destroy();
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename F, typename ...A>
|
|
|
|
void spawn(F &&func, A &&...args) {
|
|
|
|
{
|
|
|
|
std::lock_guard<std::mutex> l{p_lock};
|
|
|
|
task *t = nullptr;
|
|
|
|
if constexpr(sizeof...(A) == 0) {
|
|
|
|
t = &p_available.emplace_back(
|
|
|
|
[lfunc = std::forward<F>(func)](auto) {
|
|
|
|
lfunc();
|
|
|
|
},
|
|
|
|
p_stacks.get_allocator()
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
t = &p_available.emplace_back(
|
|
|
|
[lfunc = std::bind(
|
|
|
|
std::forward<F>(func), std::forward<A>(args)...
|
|
|
|
)](auto) mutable {
|
|
|
|
lfunc();
|
|
|
|
},
|
|
|
|
p_stacks.get_allocator()
|
|
|
|
);
|
|
|
|
}
|
|
|
|
t->pos = --p_available.end();
|
|
|
|
}
|
|
|
|
p_cond.notify_one();
|
|
|
|
}
|
|
|
|
|
|
|
|
void yield() {
|
|
|
|
task::current()->yield(*this);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
channel<T, task_cond> make_channel() {
|
|
|
|
return channel<T, task_cond>{[this]() {
|
|
|
|
return task_cond{*this};
|
|
|
|
}};
|
|
|
|
}
|
|
|
|
private:
|
|
|
|
void init() {
|
|
|
|
auto tf = [this]() {
|
|
|
|
thread_run();
|
|
|
|
};
|
|
|
|
size_t size = std::thread::hardware_concurrency();
|
|
|
|
for (size_t i = 0; i < size; ++i) {
|
|
|
|
std::thread tid{tf};
|
|
|
|
if (!tid.joinable()) {
|
|
|
|
throw std::runtime_error{"coroutine_scheduler worker failed"};
|
|
|
|
}
|
|
|
|
p_thrs.push_back(std::move(tid));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void destroy() {
|
|
|
|
p_cond.notify_all();
|
|
|
|
for (auto &tid: p_thrs) {
|
|
|
|
tid.join();
|
|
|
|
p_cond.notify_all();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void wait(task_cond *cond, task *&wt, task *t) {
|
|
|
|
std::lock_guard<std::mutex> l{p_lock};
|
|
|
|
p_waiting.splice(p_waiting.cbegin(), p_running, t->pos);
|
|
|
|
t->waiting_on = cond;
|
|
|
|
t->next_waiting = wt;
|
|
|
|
wt = t;
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_one(task *&wl) {
|
|
|
|
std::unique_lock<std::mutex> l{p_lock};
|
|
|
|
if (wl == nullptr) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
wl->waiting_on = nullptr;
|
|
|
|
p_available.splice(p_available.cbegin(), p_waiting, wl->pos);
|
|
|
|
wl = wl->next_waiting;
|
|
|
|
l.unlock();
|
|
|
|
p_cond.notify_one();
|
|
|
|
task::current()->yield(*this);
|
|
|
|
}
|
|
|
|
|
|
|
|
void notify_all(task *&wl) {
|
|
|
|
{
|
|
|
|
std::unique_lock<std::mutex> l{p_lock};
|
|
|
|
while (wl != nullptr) {
|
|
|
|
wl->waiting_on = nullptr;
|
|
|
|
p_available.splice(p_available.cbegin(), p_waiting, wl->pos);
|
|
|
|
wl = wl->next_waiting;
|
|
|
|
l.unlock();
|
|
|
|
p_cond.notify_one();
|
|
|
|
l.lock();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
task::current()->yield(*this);
|
|
|
|
}
|
|
|
|
|
|
|
|
void thread_run() {
|
|
|
|
for (;;) {
|
|
|
|
std::unique_lock<std::mutex> l{p_lock};
|
|
|
|
/* wait for an item to become available */
|
|
|
|
while (p_available.empty()) {
|
|
|
|
/* if all lists have become empty, we're done */
|
|
|
|
if (p_waiting.empty() && p_running.empty()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
p_cond.wait(l);
|
|
|
|
}
|
|
|
|
task_run(l);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void task_run(std::unique_lock<std::mutex> &l) {
|
|
|
|
auto it = p_available.begin();
|
|
|
|
p_running.splice(p_running.cend(), p_available, it);
|
|
|
|
task &c = *it;
|
|
|
|
l.unlock();
|
|
|
|
c();
|
|
|
|
l.lock();
|
|
|
|
if (c.dead()) {
|
|
|
|
p_running.erase(it);
|
|
|
|
}
|
|
|
|
l.unlock();
|
|
|
|
}
|
|
|
|
|
|
|
|
std::condition_variable p_cond;
|
|
|
|
std::mutex p_lock;
|
|
|
|
std::vector<std::thread> p_thrs;
|
|
|
|
basic_stack_pool<TR, Protected> p_stacks;
|
|
|
|
tlist p_available;
|
|
|
|
tlist p_waiting;
|
|
|
|
tlist p_running;
|
|
|
|
};
|
|
|
|
|
|
|
|
using coroutine_scheduler =
|
|
|
|
basic_coroutine_scheduler<stack_traits, false>;
|
|
|
|
|
|
|
|
using protected_coroutine_scheduler =
|
|
|
|
basic_coroutine_scheduler<stack_traits, true>;
|
|
|
|
|
2017-03-19 17:12:08 +00:00
|
|
|
template<typename S, typename F, typename ...A>
|
|
|
|
inline void spawn(S &sched, F &&func, A &&...args) {
|
|
|
|
sched.spawn(std::forward<F>(func), std::forward<A>(args)...);
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename S>
|
|
|
|
inline void yield(S &sched) {
|
|
|
|
sched.yield();
|
|
|
|
}
|
|
|
|
|
|
|
|
template<typename T, typename S>
|
|
|
|
inline auto make_channel(S &sched) -> typename S::template channel_type<T> {
|
|
|
|
return sched.template make_channel<T>();
|
|
|
|
}
|
|
|
|
|
2017-03-18 00:05:10 +00:00
|
|
|
} /* namespace ostd */
|
|
|
|
|
|
|
|
#endif
|