aboutsummaryrefslogtreecommitdiffstats
path: root/vespalib/src/vespa/vespalib/util/simple_thread_bundle.cpp
blob: 99ab298864f72a0fe5cb527aa1c225819bff9689 (plain) (blame)
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "simple_thread_bundle.h"
#include "exceptions.h"
#include <cassert>

using namespace vespalib::fixed_thread_bundle;

namespace vespalib {

VESPA_THREAD_STACK_TAG(simple_thread_bundle_executor);

namespace {

struct SignalHook : Runnable {
    Signal &signal;
    SignalHook(Signal &s) : signal(s) {}
    void run() override { signal.send(); }
};

struct BroadcastHook : Runnable {
    Signal &signal;
    BroadcastHook(Signal &s) : signal(s) {}
    void run() override { signal.broadcast(); }
};

struct PartHook : Runnable {
    Part part;
    PartHook(const Part &p) : part(p) {}
    void run() override { part.perform(); }
};

struct HookPair : Runnable {
    Runnable::UP first;
    Runnable::UP second;
    HookPair(Runnable::UP f, Runnable::UP s) : first(std::move(f)), second(std::move(s)) {}
    void run() override {
        first->run();
        second->run();
    }
};

Runnable::UP wrap(Runnable *runnable) {
    return Runnable::UP(runnable);
}

Runnable::UP chain(Runnable::UP first, Runnable::UP second) {
    return std::make_unique<HookPair>(std::move(first), std::move(second));
}

} // namespace vespalib::<unnamed>

//-----------------------------------------------------------------------------

Signal::Signal() noexcept
    : valid(true),
      generation(0),
      monitor(std::make_unique<std::mutex>()),
      cond(std::make_unique<std::condition_variable>())
{}
Signal::~Signal() = default;

SimpleThreadBundle::Pool::Pool(size_t bundleSize, init_fun_t init_fun)
    : _lock(),
      _bundleSize(bundleSize),
      _init_fun(init_fun),
      _bundles()
{
}

SimpleThreadBundle::Pool::~Pool()
{
    while (!_bundles.empty()) {
        delete _bundles.back();
        _bundles.pop_back();
    }
}

SimpleThreadBundle::UP
SimpleThreadBundle::Pool::obtain()
{
    {
        std::lock_guard guard(_lock);
        if (!_bundles.empty()) {
            SimpleThreadBundle::UP ret(_bundles.back());
            _bundles.pop_back();
            return ret;
        }
    }
    return std::make_unique<SimpleThreadBundle>(_bundleSize, _init_fun);
}

void
SimpleThreadBundle::Pool::release(SimpleThreadBundle::UP bundle)
{
    std::lock_guard guard(_lock);
    _bundles.push_back(bundle.get());
    bundle.release();
}

//-----------------------------------------------------------------------------

SimpleThreadBundle::SimpleThreadBundle(size_t size_in, Runnable::init_fun_t init_fun, Strategy strategy)
    : _work(),
      _signals(),
      _workers(),
      _hook()
{
    if (size_in == 0) {
        throw IllegalArgumentException("size must be greater than 0");
    }
    if (strategy == USE_BROADCAST) {
        _signals.resize(1); // share single signal
    } else {
        _signals.resize(size_in - 1); // separate signal per worker
    }
    size_t next_unwired = 1;
    for (size_t i = 0; i < size_in; ++i) {
        Runnable::UP hook(new PartHook(Part(_work, i)));
        if (strategy == USE_SIGNAL_TREE) {
            for (size_t child = 0; child < 2 && next_unwired < size_in; ++child, ++next_unwired) {
                hook = chain(wrap(new SignalHook(_signals[next_unwired - 1])), std::move(hook));
            }
        } else if (i == 0) { // first thread should wake others
            if (strategy == USE_BROADCAST) {
                hook = chain(wrap(new BroadcastHook(_signals[0])), std::move(hook));
            } else {
                assert(strategy == USE_SIGNAL_LIST);
                for (; next_unwired < size_in; ++next_unwired) {
                    hook = chain(wrap(new SignalHook(_signals[next_unwired - 1])), std::move(hook));
                }
            }
        }
        if (i == 0) {
            _hook = std::move(hook);
        } else {
            size_t signal_idx = (strategy == USE_BROADCAST) ? 0 : (i - 1);
            _workers.push_back(std::make_unique<Worker>(_signals[signal_idx], init_fun, std::move(hook)));
        }
    }
}

SimpleThreadBundle::~SimpleThreadBundle()
{
    for (size_t i = 0; i < _signals.size(); ++i) {
        _signals[i].cancel();
    }
    for (size_t i = 0; i < _workers.size(); ++i) {
        _workers[i]->thread.join();
    }
}

size_t
SimpleThreadBundle::size() const
{
    return (_workers.size() + 1);
}

void
SimpleThreadBundle::run(const std::vector<Runnable*> &targets)
{
    if (targets.size() > size()) {
        throw IllegalArgumentException("too many targets");
    }
    if (targets.empty()) {
        return;
    }
    if (targets.size() == 1) {
        targets[0]->run();
        return;
    }
    CountDownLatch latch(size());
    _work.targets = &targets;
    _work.latch = &latch;
    _hook->run();
    latch.await();
}

SimpleThreadBundle::Worker::Worker(Signal &s, Runnable::init_fun_t init_fun, Runnable::UP h)
  : thread(*this, std::move(init_fun)),
    signal(s),
    hook(std::move(h))
{
    thread.start();
}

void
SimpleThreadBundle::Worker::run() {
    for (size_t gen = 0; signal.wait(gen) > 0; ) {
        hook->run();
    }
}

} // namespace vespalib