StateOS
Loading...
Searching...
No Matches
ossignal.h
1/******************************************************************************
2
3 @file StateOS: ossignal.h
4 @author Rajmund Szymanski
5 @date 18.11.2025
6 @brief This file contains definitions for StateOS.
7
8 ******************************************************************************
9
10 Copyright (c) 2018-2022 Rajmund Szymanski. All rights reserved.
11
12 Permission is hereby granted, free of charge, to any person obtaining a copy
13 of this software and associated documentation files (the "Software"), to
14 deal in the Software without restriction, including without limitation the
15 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
16 sell copies of the Software, and to permit persons to whom the Software is
17 furnished to do so, subject to the following conditions:
18
19 The above copyright notice and this permission notice shall be included
20 in all copies or substantial portions of the Software.
21
22 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
28 IN THE SOFTWARE.
29
30 ******************************************************************************/
31
32#ifndef __STATEOS_SIG_H
33#define __STATEOS_SIG_H
34
35#include "oskernel.h"
36#include "osclock.h"
37
43
44/* -------------------------------------------------------------------------- */
45
46#define SIG_LIMIT (sizeof(unsigned) * CHAR_BIT)
47
48#define SIGSET(signo) (((signo) < (SIG_LIMIT)) ? 1U << (signo) : 0U)
49#define sigAny ( 0U )
50#define sigAll ( 0U-1 )
51
55
56typedef struct __sig sig_t;
57
58struct __sig
59{
60 obj_t obj;
61
62 unsigned sigset;
63};
64
65typedef struct __sig sig_id [];
66
67/******************************************************************************
68 *
69 * Name : _SIG_INIT
70 *
71 * Description : create and initialize a signal object
72 *
73 * Parameters : none
74 *
75 * Return : signal object
76 *
77 * Note : for internal use
78 *
79 ******************************************************************************/
80
81#define _SIG_INIT() { _OBJ_INIT(), 0 }
82
89#define OS_SIG( sig ) \
90 sig_t sig[] = { _SIG_INIT() }
91
92/** static alias of OS_SIG() */
93#define static_SIG( sig ) \
94 static sig_t sig[] = { _SIG_INIT() }
95
103
104#ifndef __cplusplus
105#define SIG_INIT() \
106 _SIG_INIT()
107#endif
108
116
117#ifndef __cplusplus
118#define SIG_CREATE() \
119 { SIG_INIT () }
120/** alias of SIG_CREATE() */
121#define SIG_NEW \
122 SIG_CREATE
123#endif
124
125#ifdef __cplusplus
126extern "C" {
127#endif
128
137void sig_init( sig_t *sig );
138
148sig_t *sig_create( void );
149
151__STATIC_INLINE
152sig_t *sig_new( void ) { return sig_create(); }
153
162void sig_reset( sig_t *sig );
163
165__STATIC_INLINE
166void sig_kill( sig_t *sig ) { sig_reset(sig); }
167
176void sig_destroy( sig_t *sig );
177
179__STATIC_INLINE
180void sig_delete( sig_t *sig ) { sig_destroy(sig); }
181
197int sig_take( sig_t *sig, unsigned sigset, unsigned *signo );
198
200__STATIC_INLINE
201int sig_tryWait( sig_t *sig, unsigned sigset, unsigned *signo ) { return sig_take(sig, sigset, signo); }
202
204__STATIC_INLINE
205int sig_takeISR( sig_t *sig, unsigned sigset, unsigned *signo ) { return sig_take(sig, sigset, signo); }
206
226int sig_waitFor( sig_t *sig, unsigned sigset, unsigned *signo, cnt_t delay );
227
245int sig_waitUntil( sig_t *sig, unsigned sigset, unsigned *signo, cnt_t time );
246
261
262__STATIC_INLINE
263int sig_wait( sig_t *sig, unsigned sigset, unsigned *signo ) { return sig_waitFor(sig, sigset, signo, INFINITE); }
264
277void sig_give( sig_t *sig, unsigned signo );
278
280__STATIC_INLINE
281void sig_set( sig_t *sig, unsigned signo ) { sig_give(sig, signo); }
282
284__STATIC_INLINE
285void sig_giveISR( sig_t *sig, unsigned signo ) { sig_give(sig, signo); }
286
297void sig_clear( sig_t *sig, unsigned signo );
298
300__STATIC_INLINE
301void sig_clearISR( sig_t *sig, unsigned signo ) { sig_clear(sig, signo); }
302
303#ifdef __cplusplus
304}
305#endif
306
307/* -------------------------------------------------------------------------- */
308
309#if defined(__cplusplus) && (__cplusplus >= 201103L) && !defined(__STATEOS_STDCXX)
310namespace stateos {
311
316struct Signal : public __sig
317{
319 constexpr
320 Signal(): __sig _SIG_INIT() {}
321
322 ~Signal() { assert(__sig::obj.queue == nullptr); }
323
324 /// move constructor
325 Signal( Signal&& _src ): __sig(_src)
326 {
327 assert(_src.obj.queue == nullptr);
328 }
329
330 Signal( const Signal& ) = delete;
331 Signal& operator=( Signal&& ) = delete;
332 Signal& operator=( const Signal& ) = delete;
334 void reset () { sig_reset (this); }
335 void kill () { sig_kill (this); }
336 void destroy () { sig_destroy (this); }
337 int take ( unsigned _sigset, unsigned *_signo = nullptr ) { return sig_take (this, _sigset, _signo); }
338 int tryWait ( unsigned _sigset, unsigned *_signo = nullptr ) { return sig_tryWait (this, _sigset, _signo); }
339 int takeISR ( unsigned _sigset, unsigned *_signo = nullptr ) { return sig_takeISR (this, _sigset, _signo); }
340 template<typename T>
341 int waitFor ( unsigned _sigset, unsigned *_signo, const T& _delay ) { return sig_waitFor (this, _sigset, _signo, Clock::count(_delay)); }
342 template<typename T>
343 int waitUntil( unsigned _sigset, unsigned *_signo, const T& _time ) { return sig_waitUntil(this, _sigset, _signo, Clock::until(_time)); }
344 int wait ( unsigned _sigset, unsigned *_signo = nullptr ) { return sig_wait (this, _sigset, _signo); }
345 void give ( unsigned _signo ) { sig_give (this, _signo); }
346 void set ( unsigned _signo ) { sig_set (this, _signo); }
347 void giveISR ( unsigned _signo ) { sig_giveISR (this, _signo); }
348 void clear ( unsigned _signo ) { sig_clear (this, _signo); }
349 void clearISR ( unsigned _signo ) { sig_clearISR (this, _signo); }
350
351#if __cplusplus >= 201402L
352 using Ptr = std::unique_ptr<Signal>;
353#else
354 using Ptr = Signal *;
355#endif
356
364
365 static
366 Ptr Create()
367 {
368 auto sig = new (std::nothrow) Signal();
369 if (sig != nullptr)
370 sig->__sig::obj.res = sig;
371 return Ptr(sig);
372 }
373
374};
375
376} // namespace
377#endif//__cplusplus
378
379/* -------------------------------------------------------------------------- */
380
382
383#endif//__STATEOS_SIG_H
#define INFINITE
infinite waiting
Definition osbase.h:261
sig_t * sig_new(void)
alias of sig_create()
Definition ossignal.h:151
void sig_delete(sig_t *sig)
alias of sig_destroy()
Definition ossignal.h:179
int sig_tryWait(sig_t *sig, unsigned sigset, unsigned *signo)
alias of sig_take()
Definition ossignal.h:200
void sig_destroy(sig_t *sig)
reset the signal object, wake up all waiting tasks with 'E_DELETED' event value and free allocated re...
int sig_waitFor(sig_t *sig, unsigned sigset, unsigned *signo, cnt_t delay)
wait for a signal from the given set of signals for given duration of time and return the lowest one ...
void sig_clearISR(sig_t *sig, unsigned signo)
ISR alias of sig_clear().
Definition ossignal.h:300
void sig_clear(sig_t *sig, unsigned signo)
reset given signal in the signal object
int sig_wait(sig_t *sig, unsigned sigset, unsigned *signo)
wait indefinitely for a signal from the given set of signals and return the lowest one in the 'signo'...
Definition ossignal.h:262
void sig_init(sig_t *sig)
initialize a signal object
void sig_giveISR(sig_t *sig, unsigned signo)
ISR alias of sig_give().
Definition ossignal.h:284
void sig_kill(sig_t *sig)
alias of sig_reset()
Definition ossignal.h:165
int sig_takeISR(sig_t *sig, unsigned sigset, unsigned *signo)
ISR alias of sig_take().
Definition ossignal.h:204
sig_t * sig_create(void)
create and initialize a new signal object
void sig_reset(sig_t *sig)
reset the signal object and wake up all waiting tasks with 'E_STOPPED' event value
int sig_take(sig_t *sig, unsigned sigset, unsigned *signo)
check signal object for a given set of signals and return the lowest one in the 'signo' variable
void sig_give(sig_t *sig, unsigned signo)
set given signal in the signal object
void sig_set(sig_t *sig, unsigned signo)
alias of sig_give()
Definition ossignal.h:280
int sig_waitUntil(sig_t *sig, unsigned sigset, unsigned *signo, cnt_t time)
wait for a signal from the given set of signals until given timepoint and return the lowest one in th...
static constexpr rep count(const std::chrono::duration< _Rep, _Period > &_delay)
delay in ticks, rounded up to whole ticks; negative delay: IMMEDIATE, delay out of range: INFINITE
Definition osclock.h:109
static constexpr rep until(const std::chrono::time_point< Clock, _Duration > &_time)
time point in ticks, rounded up to whole ticks (only a time point of this clock)
Definition osclock.h:116
create and initialize a signal object
Definition ossignal.h:316
int wait(unsigned _sigset, unsigned *_signo=nullptr)
sig_wait()
Definition ossignal.h:343
void clear(unsigned _signo)
sig_clear()
Definition ossignal.h:347
void destroy()
sig_destroy()
Definition ossignal.h:335
void giveISR(unsigned _signo)
sig_giveISR()
Definition ossignal.h:346
constexpr Signal()
constructor, see the constructor parameters of the class
Definition ossignal.h:319
static Ptr Create()
create dynamic object with manageable resources
Definition ossignal.h:365
void reset()
sig_reset()
Definition ossignal.h:333
int waitUntil(unsigned _sigset, unsigned *_signo, const T &_time)
sig_waitUntil()
Definition ossignal.h:342
int tryWait(unsigned _sigset, unsigned *_signo=nullptr)
sig_tryWait()
Definition ossignal.h:337
std::unique_ptr< Signal > Ptr
result type of Create()
Definition ossignal.h:351
void kill()
sig_kill()
Definition ossignal.h:334
int take(unsigned _sigset, unsigned *_signo=nullptr)
sig_take()
Definition ossignal.h:336
void set(unsigned _signo)
sig_set()
Definition ossignal.h:345
int waitFor(unsigned _sigset, unsigned *_signo, const T &_delay)
sig_waitFor()
Definition ossignal.h:340
void clearISR(unsigned _signo)
sig_clearISR()
Definition ossignal.h:348
int takeISR(unsigned _sigset, unsigned *_signo=nullptr)
sig_takeISR()
Definition ossignal.h:338
void give(unsigned _signo)
sig_give()
Definition ossignal.h:344