summaryrefslogtreecommitdiff
path: root/src/mbgl/util/thread_pool.hpp
blob: 7642f9b4cac6049ac6cf7505a3ba130bbbada793 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
#pragma once

#include <mbgl/actor/mailbox.hpp>
#include <mbgl/actor/scheduler.hpp>

#include <array>
#include <condition_variable>
#include <mutex>
#include <queue>
#include <thread>

namespace mbgl {

class ThreadedSchedulerBase : public Scheduler {
public:
    void schedule(std::function<void()>) override;

protected:
    ThreadedSchedulerBase() = default;
    ~ThreadedSchedulerBase() override;

    void terminate();
    std::thread makeSchedulerThread(size_t index);

    std::queue<std::function<void()>> queue;
    std::mutex mutex;
    std::condition_variable cv;
    bool terminated{false};
};

/**
 * @brief ThreadScheduler implements Scheduler interface using a lightweight event loop
 *
 * @tparam N number of threads
 *
 * Note: If N == 1 all scheduled tasks are guaranteed to execute consequently;
 * otherwise, some of the scheduled tasks might be executed in parallel.
 */
template <std::size_t N>
class ThreadedScheduler : public ThreadedSchedulerBase {
public:
    ThreadedScheduler() {
        for (std::size_t i = 0u; i < N; ++i) {
            threads[i] = makeSchedulerThread(i);
        }
    }

    ~ThreadedScheduler() override {
        terminate();
        for (auto& thread : threads) {
            thread.join();
        }
    }

    mapbox::base::WeakPtr<Scheduler> makeWeakPtr() override { return weakFactory.makeWeakPtr(); }

private:
    std::array<std::thread, N> threads;
    mapbox::base::WeakPtrFactory<Scheduler> weakFactory{this};
    static_assert(N > 0, "Thread count must be more than zero.");
};

using SequencedScheduler = ThreadedScheduler<1>;

template <std::size_t extra>
using ParallelScheduler = ThreadedScheduler<1 + extra>;

using ThreadPool = ParallelScheduler<3>;

} // namespace mbgl