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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
|
/**
* \file
* \brief StaticThread class header
*
* \author Copyright (C) 2014-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info
*
* \par License
* This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
* distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDE_DISTORTOS_STATICTHREAD_HPP_
#define INCLUDE_DISTORTOS_STATICTHREAD_HPP_
#include "distortos/StaticSignalsReceiver.hpp"
#include "distortos/UndetachableThread.hpp"
namespace distortos
{
namespace internal
{
/**
* \brief StaticThreadBase class is a templated common base for StaticThread
*
* \tparam Function is the function that will be executed in separate thread
* \tparam Args are the arguments for \a Function
*/
template<typename Function, typename... Args>
class StaticThreadBase : public UndetachableThread
{
public:
/// base of StaticThreadBase
using Base = UndetachableThread;
/**
* \brief StaticThreadBase's constructor
*
* \param [in] stackStorageUniquePointer is a rvalue reference to StackStorageUniquePointer with storage for stack
* (\a size bytes long) and appropriate deleter
* \param [in] size is the size of stack's storage, bytes
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicy is the scheduling policy of the thread
* \param [in] signalsReceiver is a pointer to SignalsReceiver object for this thread, nullptr to disable reception
* of signals for this thread
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*/
StaticThreadBase(StackStorageUniquePointer&& stackStorageUniquePointer, const size_t size, const uint8_t priority,
const SchedulingPolicy schedulingPolicy, SignalsReceiver* const signalsReceiver, Function&& function,
Args&&... args) :
Base{{std::move(stackStorageUniquePointer), size, *this, run, nullptr, terminationHook},
priority, schedulingPolicy, nullptr, signalsReceiver},
boundFunction_{std::bind(std::forward<Function>(function), std::forward<Args>(args)...)}
{
}
StaticThreadBase(const StaticThreadBase&) = delete;
StaticThreadBase(StaticThreadBase&&) = default;
const StaticThreadBase& operator=(const StaticThreadBase&) = delete;
StaticThreadBase& operator=(StaticThreadBase&&) = delete;
private:
/**
* \brief Thread's "run" function.
*
* Executes bound function object.
*
* \param [in] thread is a reference to Thread object, this must be StaticThreadBase!
*/
static void run(Thread& thread)
{
static_cast<StaticThreadBase&>(thread).boundFunction_();
}
/// bound function object
decltype(std::bind(std::declval<Function>(), std::declval<Args>()...)) boundFunction_;
};
} // namespace internal
/// \addtogroup threads
/// \{
/**
* \brief StaticThread class is a templated interface for thread that has automatic storage for stack.
*
* \tparam StackSize is the size of stack, bytes
* \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread
* \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable queuing of signals for this thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed in separate thread
* \tparam Args are the arguments for \a Function
*/
template<size_t StackSize, bool CanReceiveSignals, size_t QueuedSignals, size_t SignalActions, typename Function,
typename... Args>
class StaticThread : public internal::StaticThreadBase<Function, Args...>
{
public:
/// base of StaticThread
using Base = internal::StaticThreadBase<Function, Args...>;
/**
* \brief StaticThread's constructor
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicy is the scheduling policy of the thread
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*/
StaticThread(uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args);
/**
* \brief StaticThread's constructor
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*/
StaticThread(const uint8_t priority, Function&& function, Args&&... args) :
StaticThread{priority, SchedulingPolicy::roundRobin, std::forward<Function>(function),
std::forward<Args>(args)...}
{
}
StaticThread(const StaticThread&) = delete;
StaticThread(StaticThread&&) = default;
const StaticThread& operator=(const StaticThread&) = delete;
StaticThread& operator=(StaticThread&&) = delete;
private:
/// stack buffer
typename std::aligned_storage<StackSize>::type stack_;
};
/**
* \brief StaticThread class is a templated interface for thread that has automatic storage for stack and internal
* StaticSignalsReceiver object.
*
* Specialization for threads with enabled reception of signals (CanReceiveSignals == true)
*
* \tparam StackSize is the size of stack, bytes
* \tparam QueuedSignals is the max number of queued signals for this thread, 0 to disable queuing of signals for this
* thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed in separate thread
* \tparam Args are the arguments for \a Function
*/
template<size_t StackSize, size_t QueuedSignals, size_t SignalActions, typename Function, typename... Args>
class StaticThread<StackSize, true, QueuedSignals, SignalActions, Function, Args...> :
public internal::StaticThreadBase<Function, Args...>
{
public:
/// base of StaticThread
using Base = internal::StaticThreadBase<Function, Args...>;
/**
* \brief StaticThread's constructor
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicy is the scheduling policy of the thread
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*/
StaticThread(uint8_t priority, SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args);
/**
* \brief StaticThread's constructor
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*/
StaticThread(const uint8_t priority, Function&& function, Args&&... args) :
StaticThread{priority, SchedulingPolicy::roundRobin, std::forward<Function>(function),
std::forward<Args>(args)...}
{
}
StaticThread(const StaticThread&) = delete;
StaticThread(StaticThread&&) = default;
const StaticThread& operator=(const StaticThread&) = delete;
StaticThread& operator=(StaticThread&&) = delete;
private:
/// stack buffer
typename std::aligned_storage<StackSize>::type stack_;
/// internal StaticSignalsReceiver object
StaticSignalsReceiver<QueuedSignals, SignalActions> staticSignalsReceiver_;
};
/**
* \brief Helper factory function to make StaticThread object with partially deduced template arguments
*
* \tparam StackSize is the size of stack, bytes
* \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread
* \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable queuing of signals for this thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed
* \tparam Args are the arguments for \a Function
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicy is the scheduling policy of the thread
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*
* \return StaticThread object with partially deduced template arguments
*/
template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {},
typename Function, typename... Args>
StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>
makeStaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args)
{
return {priority, schedulingPolicy, std::forward<Function>(function), std::forward<Args>(args)...};
}
/**
* \brief Helper factory function to make StaticThread object with partially deduced template arguments
*
* \tparam StackSize is the size of stack, bytes
* \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread
* \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable queuing of signals for this thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed
* \tparam Args are the arguments for \a Function
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*
* \return StaticThread object with partially deduced template arguments
*/
template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {},
typename Function, typename... Args>
StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>
makeStaticThread(const uint8_t priority, Function&& function, Args&&... args)
{
return {priority, std::forward<Function>(function), std::forward<Args>(args)...};
}
/**
* \brief Helper factory function to make and start StaticThread object with partially deduced template arguments
*
* \tparam StackSize is the size of stack, bytes
* \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread
* \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable queuing of signals for this thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed
* \tparam Args are the arguments for \a Function
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicy is the scheduling policy of the thread
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*
* \return StaticThread object with partially deduced template arguments
*/
template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {},
typename Function, typename... Args>
StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>
makeAndStartStaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function,
Args&&... args)
{
auto thread = makeStaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions>(priority,
schedulingPolicy, std::forward<Function>(function), std::forward<Args>(args)...);
thread.start(); /// \todo make sure this never fails
return thread;
}
/**
* \brief Helper factory function to make and start StaticThread object with partially deduced template arguments
*
* \tparam StackSize is the size of stack, bytes
* \tparam CanReceiveSignals selects whether reception of signals is enabled (true) or disabled (false) for this thread
* \tparam QueuedSignals is the max number of queued signals for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable queuing of signals for this thread
* \tparam SignalActions is the max number of different SignalAction objects for this thread, relevant only if
* CanReceiveSignals == true, 0 to disable catching of signals for this thread
* \tparam Function is the function that will be executed
* \tparam Args are the arguments for \a Function
*
* \param [in] priority is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] function is a function that will be executed in separate thread
* \param [in] args are arguments for function
*
* \return StaticThread object with partially deduced template arguments
*/
template<size_t StackSize, bool CanReceiveSignals = {}, size_t QueuedSignals = {}, size_t SignalActions = {},
typename Function, typename... Args>
StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>
makeAndStartStaticThread(const uint8_t priority, Function&& function, Args&&... args)
{
auto thread = makeStaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions>(priority,
std::forward<Function>(function), std::forward<Args>(args)...);
thread.start(); /// \todo make sure this never fails
return thread;
}
/// \}
template<size_t StackSize, bool CanReceiveSignals, size_t QueuedSignals, size_t SignalActions, typename Function,
typename... Args>
StaticThread<StackSize, CanReceiveSignals, QueuedSignals, SignalActions, Function, Args...>::
StaticThread(const uint8_t priority, const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) :
Base{{&stack_, internal::dummyDeleter<decltype(stack_)>}, sizeof(stack_), priority, schedulingPolicy, nullptr,
std::forward<Function>(function), std::forward<Args>(args)...}
{
}
template<size_t StackSize, size_t QueuedSignals, size_t SignalActions, typename Function, typename... Args>
StaticThread<StackSize, true, QueuedSignals, SignalActions, Function, Args...>::StaticThread(const uint8_t priority,
const SchedulingPolicy schedulingPolicy, Function&& function, Args&&... args) :
Base{{&stack_, internal::dummyDeleter<decltype(stack_)>}, sizeof(stack_), priority, schedulingPolicy,
&static_cast<SignalsReceiver&>(staticSignalsReceiver_), std::forward<Function>(function),
std::forward<Args>(args)...},
staticSignalsReceiver_{}
{
}
} // namespace distortos
#endif // INCLUDE_DISTORTOS_STATICTHREAD_HPP_
|
